class Hubspot::Crm::Extensions::Accounting::UserAccountsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/hubspot/codegen/crm/extensions/accounting/api/user_accounts_api.rb, line 22
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

archive(account_id, opts = {}) click to toggle source

Delete user account Deletes a user account from HubSpot, meaning that HubSpot will no longer send requests to the external accounting system for this user. @param account_id [String] The ID of the user account to delete. @param [Hash] opts the optional parameters @return [nil]

# File lib/hubspot/codegen/crm/extensions/accounting/api/user_accounts_api.rb, line 30
def archive(account_id, opts = {})
  archive_with_http_info(account_id, opts)
  nil
end
archive_with_http_info(account_id, opts = {}) click to toggle source

Delete user account Deletes a user account from HubSpot, meaning that HubSpot will no longer send requests to the external accounting system for this user. @param account_id [String] The ID of the user account to delete. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/hubspot/codegen/crm/extensions/accounting/api/user_accounts_api.rb, line 40
def archive_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountsApi.archive ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling UserAccountsApi.archive"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/accounting/user-accounts/{accountId}'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserAccountsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
replace(create_user_account_request_external, opts = {}) click to toggle source

Create a user account Creates an account which contains the information about the account in the external accounting system. This must be called after a user connects their HubSpot account to the external accounting system, as there is no other way for HubSpot to obtain the external account details. @param create_user_account_request_external [CreateUserAccountRequestExternal] The external accounting system user account information. @param [Hash] opts the optional parameters @return [nil]

# File lib/hubspot/codegen/crm/extensions/accounting/api/user_accounts_api.rb, line 92
def replace(create_user_account_request_external, opts = {})
  replace_with_http_info(create_user_account_request_external, opts)
  nil
end
replace_with_http_info(create_user_account_request_external, opts = {}) click to toggle source

Create a user account Creates an account which contains the information about the account in the external accounting system. This must be called after a user connects their HubSpot account to the external accounting system, as there is no other way for HubSpot to obtain the external account details. @param create_user_account_request_external [CreateUserAccountRequestExternal] The external accounting system user account information. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/hubspot/codegen/crm/extensions/accounting/api/user_accounts_api.rb, line 102
def replace_with_http_info(create_user_account_request_external, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountsApi.replace ...'
  end
  # verify the required parameter 'create_user_account_request_external' is set
  if @api_client.config.client_side_validation && create_user_account_request_external.nil?
    fail ArgumentError, "Missing the required parameter 'create_user_account_request_external' when calling UserAccountsApi.replace"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/accounting/user-accounts'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(create_user_account_request_external) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserAccountsApi#replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end