Class: WalleeRubySdk::HumanUsersService

Inherits:
Object
  • Object
show all
Defined in:
lib/wallee-ruby-sdk/service/human_users_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ HumanUsersService

Returns a new instance of HumanUsersService.



28
29
30
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 28

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



25
26
27
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 25

def api_client
  @api_client
end

Instance Method Details

#delete_human_users_id(id, opts = {}) ⇒ nil

Delete a human user Permanently deletes a human user. It cannot be undone.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


36
37
38
39
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 36

def delete_human_users_id(id, opts = {})
  delete_human_users_id_with_http_info(id, opts)
  nil
end

#delete_human_users_id_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
88
89
90
91
92
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 47

def delete_human_users_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HumanUsersService.delete_human_users_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling HumanUsersService.delete_human_users_id"
  end
  # resource path
  local_var_path = '/human-users/{id}'.sub('{' + 'id' + '}', CGI.escape(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(['application/json']) unless header_params['Accept']

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

  # return_type
  return_type = opts[:debug_return_type]

  new_options = opts.merge(
    :operation => :"HumanUsersService.delete_human_users_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUsersService#delete_human_users_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_human_users(opts = {}) ⇒ HumanUserListResponse

List all human users

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :after (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately after the named object.

  • :before (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately before the named object.

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :order (SortingOrder) —

    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.

Returns:



103
104
105
106
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 103

def get_human_users(opts = {})
  data, _status_code, _headers = get_human_users_with_http_info(opts)
  data
end

#get_human_users_export(opts = {}) ⇒ File

Export human users Export human users into a CSV file.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    The fields to be included in the export.

  • :limit (Integer) —

    A limit on the number of objects to be returned. Default is 2,000.

  • :offset (Integer) —

    A cursor for pagination, specifies the number of objects to skip.

  • :order (String) —

    The fields and order to sort the objects by.

  • :query (String) —

    The search query to filter the objects by.

Returns:

  • (File) 


191
192
193
194
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 191

def get_human_users_export(opts = {})
  data, _status_code, _headers = get_human_users_export_with_http_info(opts)
  data
end

#get_human_users_export_with_http_info(opts = {}) ⇒ Array<(File, Integer, Hash)>

Export human users Export human users into a CSV file. Timeout for this request is: 60 seconds.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    The fields to be included in the export.

  • :limit (Integer) —

    A limit on the number of objects to be returned. Default is 2,000.

  • :offset (Integer) —

    A cursor for pagination, specifies the number of objects to skip.

  • :order (String) —

    The fields and order to sort the objects by.

  • :query (String) —

    The search query to filter the objects by.

Returns:

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

    File data, response status code and response headers



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
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
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 206

def get_human_users_export_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HumanUsersService.get_human_users_export ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling HumanUsersService.get_human_users_export, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] > 100000
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling HumanUsersService.get_human_users_export, must be smaller than or equal to 100000.'
  end

  # resource path
  local_var_path = '/human-users/export'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) unless opts[:'fields'].nil?
  query_params[:'limit'] = opts[:'limit'] unless opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] unless opts[:'offset'].nil?
  query_params[:'order'] = opts[:'order'] unless opts[:'order'].nil?
  query_params[:'query'] = opts[:'query'] unless opts[:'query'].nil?

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

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

  # connection timeout
  connection_timeout = 60

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

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  new_options = opts.merge(
    :operation => :"HumanUsersService.get_human_users_export",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUsersService#get_human_users_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_human_users_id(id, opts = {}) ⇒ HumanUser

Retrieve a human user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



268
269
270
271
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 268

def get_human_users_id(id, opts = {})
  data, _status_code, _headers = get_human_users_id_with_http_info(id, opts)
  data
end

#get_human_users_id_with_http_info(id, opts = {}) ⇒ Array<(HumanUser, Integer, Hash)>

Returns HumanUser data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

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

    HumanUser data, response status code and response headers



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
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
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 279

def get_human_users_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HumanUsersService.get_human_users_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling HumanUsersService.get_human_users_id"
  end
  # resource path
  local_var_path = '/human-users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

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

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

  # return_type
  return_type = opts[:debug_return_type] || 'HumanUser'

  new_options = opts.merge(
    :operation => :"HumanUsersService.get_human_users_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUsersService#get_human_users_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_human_users_search(opts = {}) ⇒ HumanUserSearchResponse

Search human users

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :offset (Integer) —

    A cursor for pagination, specifies the number of objects to skip.

  • :order (String) —

    The fields and order to sort the objects by.

  • :query (String) —

    The search query to filter the objects by.

Returns:



336
337
338
339
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 336

def get_human_users_search(opts = {})
  data, _status_code, _headers = get_human_users_search_with_http_info(opts)
  data
end

#get_human_users_search_with_http_info(opts = {}) ⇒ Array<(HumanUserSearchResponse, Integer, Hash)>

Returns HumanUserSearchResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :offset (Integer) —

    A cursor for pagination, specifies the number of objects to skip.

  • :order (String) —

    The fields and order to sort the objects by.

  • :query (String) —

    The search query to filter the objects by.

Returns:

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

    HumanUserSearchResponse data, response status code and response headers



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 350

def get_human_users_search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HumanUsersService.get_human_users_search ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling HumanUsersService.get_human_users_search, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling HumanUsersService.get_human_users_search, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling HumanUsersService.get_human_users_search, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = '/human-users/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?
  query_params[:'limit'] = opts[:'limit'] unless opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] unless opts[:'offset'].nil?
  query_params[:'order'] = opts[:'order'] unless opts[:'order'].nil?
  query_params[:'query'] = opts[:'query'] unless opts[:'query'].nil?

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

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

  # return_type
  return_type = opts[:debug_return_type] || 'HumanUserSearchResponse'

  new_options = opts.merge(
    :operation => :"HumanUsersService.get_human_users_search",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUsersService#get_human_users_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_human_users_with_http_info(opts = {}) ⇒ Array<(HumanUserListResponse, Integer, Hash)>

Returns HumanUserListResponse data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :after (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately after the named object.

  • :before (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately before the named object.

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :order (SortingOrder) —

    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.

Returns:

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

    HumanUserListResponse data, response status code and response headers



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 117

def get_human_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HumanUsersService.get_human_users ...'
  end
  if @api_client.config.client_side_validation && !opts[:'after'].nil? && opts[:'after'] < 1
    fail ArgumentError, 'invalid value for "opts[:"after"]" when calling HumanUsersService.get_human_users, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'before'].nil? && opts[:'before'] < 1
    fail ArgumentError, 'invalid value for "opts[:"before"]" when calling HumanUsersService.get_human_users, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling HumanUsersService.get_human_users, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling HumanUsersService.get_human_users, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/human-users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'after'] = opts[:'after'] unless opts[:'after'].nil?
  query_params[:'before'] = opts[:'before'] unless opts[:'before'].nil?
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?
  query_params[:'limit'] = opts[:'limit'] unless opts[:'limit'].nil?
  query_params[:'order'] = opts[:'order'] unless opts[:'order'].nil?

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

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

  # return_type
  return_type = opts[:debug_return_type] || 'HumanUserListResponse'

  new_options = opts.merge(
    :operation => :"HumanUsersService.get_human_users",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUsersService#get_human_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#patch_human_users_id(id, human_user_update, opts = {}) ⇒ HumanUser

Update a human user

Parameters:

  • id (Integer)
  • human_user_update (HumanUserUpdate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



417
418
419
420
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 417

def patch_human_users_id(id, human_user_update, opts = {})
  data, _status_code, _headers = patch_human_users_id_with_http_info(id, human_user_update, opts)
  data
end

#patch_human_users_id_with_http_info(id, human_user_update, opts = {}) ⇒ Array<(HumanUser, Integer, Hash)>

Returns HumanUser data, response status code and response headers.

Parameters:

  • id (Integer)
  • human_user_update (HumanUserUpdate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

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

    HumanUser data, response status code and response headers



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 429

def patch_human_users_id_with_http_info(id, human_user_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HumanUsersService.patch_human_users_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling HumanUsersService.patch_human_users_id"
  end
  # verify the required parameter 'human_user_update' is set
  if @api_client.config.client_side_validation && human_user_update.nil?
    fail ArgumentError, "Missing the required parameter 'human_user_update' when calling HumanUsersService.patch_human_users_id"
  end
  # resource path
  local_var_path = '/human-users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

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

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

  # return_type
  return_type = opts[:debug_return_type] || 'HumanUser'

  new_options = opts.merge(
    :operation => :"HumanUsersService.patch_human_users_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUsersService#patch_human_users_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_human_users(human_user_create, opts = {}) ⇒ HumanUser

Create a human user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



492
493
494
495
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 492

def post_human_users(human_user_create, opts = {})
  data, _status_code, _headers = post_human_users_with_http_info(human_user_create, opts)
  data
end

#post_human_users_with_http_info(human_user_create, opts = {}) ⇒ Array<(HumanUser, Integer, Hash)>

Returns HumanUser data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

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

    HumanUser data, response status code and response headers



503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/wallee-ruby-sdk/service/human_users_service.rb', line 503

def post_human_users_with_http_info(human_user_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HumanUsersService.post_human_users ...'
  end
  # verify the required parameter 'human_user_create' is set
  if @api_client.config.client_side_validation && human_user_create.nil?
    fail ArgumentError, "Missing the required parameter 'human_user_create' when calling HumanUsersService.post_human_users"
  end
  # resource path
  local_var_path = '/human-users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

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

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

  # return_type
  return_type = opts[:debug_return_type] || 'HumanUser'

  new_options = opts.merge(
    :operation => :"HumanUsersService.post_human_users",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUsersService#post_human_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end