Class: WhiteLabelMachineName::HumanUserService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ HumanUserService

Returns a new instance of HumanUserService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 24

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#count(opts = {}) ⇒ Integer

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

  • (Integer) 


33
34
35
36
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 33

def count(opts = {})
  data, _status_code, _headers = count_with_http_info(opts)
  return data
end

#count_with_http_info(opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

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

    Integer data, response status code and response headers



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 43

def count_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.count ..."
  end
  # resource path
  local_var_path = "/human-user/count".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'filter'])
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Integer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(entity, opts = {}) ⇒ HumanUser

Create Creates the entity with the given properties.

Parameters:

  • entity —

    The human user object with the properties which should be created.

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 88

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

#create_with_http_info(entity, opts = {}) ⇒ Array<(HumanUser, Fixnum, Hash)>

Create Creates the entity with the given properties.

Parameters:

  • entity —

    The human user object with the properties which should be created.

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

    the optional parameters

Returns:

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

    HumanUser data, response status code and response headers



98
99
100
101
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 98

def create_with_http_info(entity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.create ..."
  end
  # verify the required parameter 'entity' is set
  fail ArgumentError, "Missing the required parameter 'entity' when calling HumanUserService.create" if entity.nil?
  # resource path
  local_var_path = "/human-user/create".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(entity)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HumanUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Deletes the entity with the given id.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


145
146
147
148
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 145

def delete(id, opts = {})
  delete_with_http_info(id, opts)
  return nil
end

#delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Deletes the entity with the given id.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 155

def delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.delete ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling HumanUserService.delete" if id.nil?
  # resource path
  local_var_path = "/human-user/delete".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(id)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export(request, opts = {}) ⇒ String

Export Exports the human users into a CSV file. The file will contain the properties defined in the request.

Parameters:

  • request —

    The request controls the entries which are exported.

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

    the optional parameters

Returns:

  • (String) 


201
202
203
204
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 201

def export(request, opts = {})
  data, _status_code, _headers = export_with_http_info(request, opts)
  return data
end

#export_with_http_info(request, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Export Exports the human users into a CSV file. The file will contain the properties defined in the request.

Parameters:

  • request —

    The request controls the entries which are exported.

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 211

def export_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.export ..."
  end
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling HumanUserService.export" if request.nil?
  # resource path
  local_var_path = "/human-user/export".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8', 'text/csv']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Read Reads the entity with the given ‘id’ and returns it.

Parameters:

  • id —

    The id of the human user which should be returned.

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

    the optional parameters

Returns:



258
259
260
261
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 258

def read(id, opts = {})
  data, _status_code, _headers = read_with_http_info(id, opts)
  return data
end

#read_with_http_info(id, opts = {}) ⇒ Array<(HumanUser, Fixnum, Hash)>

Read Reads the entity with the given &#39;id&#39; and returns it.

Parameters:

  • id —

    The id of the human user which should be returned.

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

    the optional parameters

Returns:

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

    HumanUser data, response status code and response headers



268
269
270
271
272
273
274
275
276
277
278
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 268

def read_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.read ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling HumanUserService.read" if id.nil?
  # resource path
  local_var_path = "/human-user/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HumanUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(query, opts = {}) ⇒ Array<HumanUser>

Search Searches for the entities as specified by the given query.

Parameters:

  • query —

    The query restricts the human users which are returned by the search.

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

    the optional parameters

Returns:



316
317
318
319
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 316

def search(query, opts = {})
  data, _status_code, _headers = search_with_http_info(query, opts)
  return data
end

#search_with_http_info(query, opts = {}) ⇒ Array<(Array<HumanUser>, Fixnum, Hash)>

Search Searches for the entities as specified by the given query.

Parameters:

  • query —

    The query restricts the human users which are returned by the search.

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

    the optional parameters

Returns:

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

    Array<HumanUser> data, response status code and response headers



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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 326

def search_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.search ..."
  end
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling HumanUserService.search" if query.nil?
  # resource path
  local_var_path = "/human-user/search".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<HumanUser>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(entity, opts = {}) ⇒ HumanUser

Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The ‘id’ and ‘version’ are required to identify the entity.

Parameters:

  • entity —

    The object with all the properties which should be updated. The id and the version are required properties.

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

    the optional parameters

Returns:



373
374
375
376
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 373

def update(entity, opts = {})
  data, _status_code, _headers = update_with_http_info(entity, opts)
  return data
end

#update_with_http_info(entity, opts = {}) ⇒ Array<(HumanUser, Fixnum, Hash)>

Update This updates the entity with the given properties. Only those properties which should be updated can be provided. The &#39;id&#39; and &#39;version&#39; are required to identify the entity.

Parameters:

  • entity —

    The object with all the properties which should be updated. The id and the version are required properties.

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

    the optional parameters

Returns:

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

    HumanUser data, response status code and response headers



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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/human_user_service_api.rb', line 383

def update_with_http_info(entity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: HumanUserService.update ..."
  end
  # verify the required parameter 'entity' is set
  fail ArgumentError, "Missing the required parameter 'entity' when calling HumanUserService.update" if entity.nil?
  # resource path
  local_var_path = "/human-user/update".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(entity)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HumanUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HumanUserService#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end