Class: Hubspot::Settings::Users::UsersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/settings/users/api/users_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersApi

Returns a new instance of UsersApi.



21
22
23
 
# File 'lib/hubspot/codegen/settings/users/api/users_api.rb', line 21

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



19
20
21
 
# File 'lib/hubspot/codegen/settings/users/api/users_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

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

Removes a user Removes a user identified by ‘userId`. `userId` refers to the user’s ID by default, or optionally email as specified by the ‘IdProperty` query param.

Parameters:

  • user_id (String) —

    Identifier of user to delete

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

    the optional parameters

Options Hash (opts):

  • :id_property (String) —

    The name of a property with unique user values. Valid values are `USER_ID`(default) or `EMAIL`

Returns:

  • (nil) 


30
31
32
33
 
# File 'lib/hubspot/codegen/settings/users/api/users_api.rb', line 30

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

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

Removes a user Removes a user identified by &#x60;userId&#x60;. &#x60;userId&#x60; refers to the user&#39;s ID by default, or optionally email as specified by the &#x60;IdProperty&#x60; query param.

Parameters:

  • user_id (String) —

    Identifier of user to delete

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

    the optional parameters

Options Hash (opts):

  • :id_property (String) —

    The name of a property with unique user values. Valid values are &#x60;USER_ID&#x60;(default) or &#x60;EMAIL&#x60;

Returns:

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

    nil, response status code and response headers



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
86
87
 
# File 'lib/hubspot/codegen/settings/users/api/users_api.rb', line 41

def archive_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.archive ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.archive"
  end
  # resource path
  local_var_path = '/settings/v3/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].nil?

  # 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] || ['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: UsersApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(user_provision_request, opts = {}) ⇒ PublicUser

Adds a user New users will only have minimal permissions, which is contacts-base. A welcome email will prompt them to set a password and log in to HubSpot.

Parameters:

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/hubspot/codegen/settings/users/api/users_api.rb', line 94

def create(user_provision_request, opts = {})
  data, _status_code, _headers = create_with_http_info(user_provision_request, opts)
  data
end

#create_with_http_info(user_provision_request, opts = {}) ⇒ Array<(PublicUser, Integer, Hash)>

Adds a user New users will only have minimal permissions, which is contacts-base. A welcome email will prompt them to set a password and log in to HubSpot.

Parameters:

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

    the optional parameters

Returns:

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

    PublicUser data, response status code and response headers



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
150
151
 
# File 'lib/hubspot/codegen/settings/users/api/users_api.rb', line 104

def create_with_http_info(user_provision_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.create ...'
  end
  # verify the required parameter 'user_provision_request' is set
  if @api_client.config.client_side_validation && user_provision_request.nil?
    fail ArgumentError, "Missing the required parameter 'user_provision_request' when calling UsersApi.create"
  end
  # resource path
  local_var_path = '/settings/v3/users/'

  # 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(['application/json', '*/*'])
  # 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(user_provision_request) 

  # return_type
  return_type = opts[:return_type] || 'PublicUser' 

  # auth_names
  auth_names = opts[:auth_names] || ['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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_by_id(user_id, opts = {}) ⇒ PublicUser

Retrieves a user Retrieves a user identified by ‘userId`. `userId` refers to the user’s ID by default, or optionally email as specified by the ‘IdProperty` query param.

Parameters:

  • user_id (String) —

    Identifier of user to retrieve

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

    the optional parameters

Options Hash (opts):

  • :id_property (String) —

    The name of a property with unique user values. Valid values are &#x60;USER_ID&#x60;(default) or &#x60;EMAIL&#x60;

Returns:



159
160
161
162
 
# File 'lib/hubspot/codegen/settings/users/api/users_api.rb', line 159

def get_by_id(user_id, opts = {})
  data, _status_code, _headers = get_by_id_with_http_info(user_id, opts)
  data
end

#get_by_id_with_http_info(user_id, opts = {}) ⇒ Array<(PublicUser, Integer, Hash)>

Retrieves a user Retrieves a user identified by &#x60;userId&#x60;. &#x60;userId&#x60; refers to the user&#39;s ID by default, or optionally email as specified by the &#x60;IdProperty&#x60; query param.

Parameters:

  • user_id (String) —

    Identifier of user to retrieve

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

    the optional parameters

Options Hash (opts):

  • :id_property (String) —

    The name of a property with unique user values. Valid values are &#x60;USER_ID&#x60;(default) or &#x60;EMAIL&#x60;

Returns:

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

    PublicUser data, response status code and response headers



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/hubspot/codegen/settings/users/api/users_api.rb', line 170

def get_by_id_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.get_by_id ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_by_id"
  end
  # resource path
  local_var_path = '/settings/v3/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'PublicUser' 

  # auth_names
  auth_names = opts[:auth_names] || ['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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page(opts = {}) ⇒ CollectionResponsePublicUserForwardPaging

Retrieves a list of users from an account Retrieves a list of users from an account

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of users to retrieve

  • :after (String) —

    Results will display maximum 100 users per page. Additional results will be on the next page.

Returns:



224
225
226
227
 
# File 'lib/hubspot/codegen/settings/users/api/users_api.rb', line 224

def get_page(opts = {})
  data, _status_code, _headers = get_page_with_http_info(opts)
  data
end

#get_page_with_http_info(opts = {}) ⇒ Array<(CollectionResponsePublicUserForwardPaging, Integer, Hash)>

Retrieves a list of users from an account Retrieves a list of users from an account

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of users to retrieve

  • :after (String) —

    Results will display maximum 100 users per page. Additional results will be on the next page.

Returns:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/hubspot/codegen/settings/users/api/users_api.rb', line 235

def get_page_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.get_page ...'
  end
  # resource path
  local_var_path = '/settings/v3/users/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'CollectionResponsePublicUserForwardPaging' 

  # auth_names
  auth_names = opts[:auth_names] || ['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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace(user_id, public_user_update, opts = {}) ⇒ PublicUser

Modifies a user Modifies a user identified by ‘userId`. `userId` refers to the user’s ID by default, or optionally email as specified by the ‘IdProperty` query param.

Parameters:

  • user_id (String) —

    Identifier of user to retrieve

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

    the optional parameters

Options Hash (opts):

  • :id_property (String) —

    The name of a property with unique user values. Valid values are &#x60;USER_ID&#x60;(default) or &#x60;EMAIL&#x60;

Returns:



287
288
289
290
 
# File 'lib/hubspot/codegen/settings/users/api/users_api.rb', line 287

def replace(user_id, public_user_update, opts = {})
  data, _status_code, _headers = replace_with_http_info(user_id, public_user_update, opts)
  data
end

#replace_with_http_info(user_id, public_user_update, opts = {}) ⇒ Array<(PublicUser, Integer, Hash)>

Modifies a user Modifies a user identified by &#x60;userId&#x60;. &#x60;userId&#x60; refers to the user&#39;s ID by default, or optionally email as specified by the &#x60;IdProperty&#x60; query param.

Parameters:

  • user_id (String) —

    Identifier of user to retrieve

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

    the optional parameters

Options Hash (opts):

  • :id_property (String) —

    The name of a property with unique user values. Valid values are &#x60;USER_ID&#x60;(default) or &#x60;EMAIL&#x60;

Returns:

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

    PublicUser data, response status code and response headers



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/hubspot/codegen/settings/users/api/users_api.rb', line 299

def replace_with_http_info(user_id, public_user_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.replace ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.replace"
  end
  # verify the required parameter 'public_user_update' is set
  if @api_client.config.client_side_validation && public_user_update.nil?
    fail ArgumentError, "Missing the required parameter 'public_user_update' when calling UsersApi.replace"
  end
  # resource path
  local_var_path = '/settings/v3/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
  # 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(public_user_update) 

  # return_type
  return_type = opts[:return_type] || 'PublicUser' 

  # auth_names
  auth_names = opts[:auth_names] || ['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: UsersApi#replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end