Class: Hubspot::Crm::Extensions::Accounting::UserAccountsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/extensions/accounting/api/user_accounts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserAccountsApi

Returns a new instance of UserAccountsApi.



22
23
24
 
# 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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/user_accounts_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#archive(account_id, opts = {}) ⇒ nil

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.

Parameters:

  • account_id (String) —

    The ID of the user account to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


30
31
32
33
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/user_accounts_api.rb', line 30

def archive(, opts = {})
  archive_with_http_info(, opts)
  nil
end

#archive_with_http_info(account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

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.

Parameters:

  • account_id (String) —

    The ID of the user account to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/user_accounts_api.rb', line 40

def archive_with_http_info(, 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 && .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(.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 = {}) ⇒ nil

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.

Parameters:

  • create_user_account_request_external (CreateUserAccountRequestExternal) —

    The external accounting system user account information.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


92
93
94
95
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/user_accounts_api.rb', line 92

def replace(, opts = {})
  replace_with_http_info(, opts)
  nil
end

#replace_with_http_info(create_user_account_request_external, opts = {}) ⇒ Array<(nil, Integer, Hash)>

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.

Parameters:

  • create_user_account_request_external (CreateUserAccountRequestExternal) —

    The external accounting system user account information.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/user_accounts_api.rb', line 102

def replace_with_http_info(, 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 && .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() 

  # 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