Class: OrderCloud::AdminUserGroupApi

Inherits:
Object
  • Object
show all
Defined in:
lib/order_cloud/api/admin_user_group_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AdminUserGroupApi 



30
31
32
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#create(group, opts = {}) ⇒ UserGroup 



39
40
41
42
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 39

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

#create_with_http_info(group, opts = {}) ⇒ Array<(UserGroup, Fixnum, Hash)> 



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
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 49

def create_with_http_info(group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AdminUserGroupApi.create ..."
  end
  # verify the required parameter 'group' is set

  fail ArgumentError, "Missing the required parameter 'group' when calling AdminUserGroupApi.create" if group.nil?
  # resource path

  local_var_path = "/usergroups".sub('{format}','json')

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}

  # HTTP header 'Accept' (if needed)

  local_header_accept = ['application/json']
  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', 'text/plain; 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(group)
  auth_names = ['oauth2']
  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 => 'UserGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminUserGroupApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



96
97
98
99
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 96

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

#delete_user_assignment(user_group_id, user_id, opts = {}) ⇒ nil 



153
154
155
156
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 153

def delete_user_assignment(user_group_id, user_id, opts = {})
  delete_user_assignment_with_http_info(user_group_id, user_id, opts)
  return nil
end

#delete_user_assignment_with_http_info(user_group_id, user_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)> 



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
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 164

def delete_user_assignment_with_http_info(user_group_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AdminUserGroupApi.delete_user_assignment ..."
  end
  # verify the required parameter 'user_group_id' is set

  fail ArgumentError, "Missing the required parameter 'user_group_id' when calling AdminUserGroupApi.delete_user_assignment" if user_group_id.nil?
  # verify the required parameter 'user_id' is set

  fail ArgumentError, "Missing the required parameter 'user_id' when calling AdminUserGroupApi.delete_user_assignment" if user_id.nil?
  # resource path

  local_var_path = "/usergroups/{userGroupID}/assignments/{userID}".sub('{format}','json').sub('{' + 'userGroupID' + '}', user_group_id.to_s).sub('{' + 'userID' + '}', user_id.to_s)

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}

  # HTTP header 'Accept' (if needed)

  local_header_accept = ['application/json']
  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', 'text/plain; 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 = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: AdminUserGroupApi#delete_user_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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



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
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 106

def delete_with_http_info(user_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AdminUserGroupApi.delete ..."
  end
  # verify the required parameter 'user_group_id' is set

  fail ArgumentError, "Missing the required parameter 'user_group_id' when calling AdminUserGroupApi.delete" if user_group_id.nil?
  # resource path

  local_var_path = "/usergroups/{userGroupID}".sub('{format}','json').sub('{' + 'userGroupID' + '}', user_group_id.to_s)

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}

  # HTTP header 'Accept' (if needed)

  local_header_accept = ['application/json']
  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', 'text/plain; 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 = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: AdminUserGroupApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(user_group_id, opts = {}) ⇒ UserGroup 



212
213
214
215
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 212

def get(user_group_id, opts = {})
  data, _status_code, _headers = get_with_http_info(user_group_id, opts)
  return data
end

#get_with_http_info(user_group_id, opts = {}) ⇒ Array<(UserGroup, Fixnum, Hash)> 



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
261
262
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 222

def get_with_http_info(user_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AdminUserGroupApi.get ..."
  end
  # verify the required parameter 'user_group_id' is set

  fail ArgumentError, "Missing the required parameter 'user_group_id' when calling AdminUserGroupApi.get" if user_group_id.nil?
  # resource path

  local_var_path = "/usergroups/{userGroupID}".sub('{format}','json').sub('{' + 'userGroupID' + '}', user_group_id.to_s)

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}

  # HTTP header 'Accept' (if needed)

  local_header_accept = ['application/json']
  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', 'text/plain; 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 = nil
  auth_names = ['oauth2']
  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 => 'UserGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminUserGroupApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ ListUserGroup

Options Hash (opts):

  • :search (String) —

    Search of the admin user group.

  • :search_on (Array<String>) —

    Search on of the admin user group.

  • :sort_by (Array<String>) —

    Sort by of the admin user group.

  • :page (Integer) —

    Page of the admin user group.

  • :page_size (Integer) —

    Page size of the admin user group.

  • :filters (Hash<String, String>) —

    Filters of the admin user group.



274
275
276
277
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 274

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  return data
end

#list_user_assignments(opts = {}) ⇒ ListUserGroupAssignment

Options Hash (opts):

  • :user_group_id (String) —

    ID of the user group.

  • :user_id (String) —

    ID of the user.

  • :page (Integer) —

    Page of the admin user group.

  • :page_size (Integer) —

    Page size of the admin user group.



343
344
345
346
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 343

def list_user_assignments(opts = {})
  data, _status_code, _headers = list_user_assignments_with_http_info(opts)
  return data
end

#list_user_assignments_with_http_info(opts = {}) ⇒ Array<(ListUserGroupAssignment, Fixnum, Hash)>

Returns ListUserGroupAssignment data, response status code and response headers.

Options Hash (opts):

  • :user_group_id (String) —

    ID of the user group.

  • :user_id (String) —

    ID of the user.

  • :page (Integer) —

    Page of the admin user group.

  • :page_size (Integer) —

    Page size of the admin user group.



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
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 356

def list_user_assignments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AdminUserGroupApi.list_user_assignments ..."
  end
  # resource path

  local_var_path = "/usergroups/assignments".sub('{format}','json')

  # query parameters

  query_params = {}
  query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_id'].nil?
  query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters

  header_params = {}

  # HTTP header 'Accept' (if needed)

  local_header_accept = ['application/json']
  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', 'text/plain; 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 = nil
  auth_names = ['oauth2']
  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 => 'ListUserGroupAssignment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminUserGroupApi#list_user_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_with_http_info(opts = {}) ⇒ Array<(ListUserGroup, Fixnum, Hash)>

Returns ListUserGroup data, response status code and response headers.

Options Hash (opts):

  • :search (String) —

    Search of the admin user group.

  • :search_on (Array<String>) —

    Search on of the admin user group.

  • :sort_by (Array<String>) —

    Sort by of the admin user group.

  • :page (Integer) —

    Page of the admin user group.

  • :page_size (Integer) —

    Page size of the admin user group.

  • :filters (Hash<String, String>) —

    Filters of the admin user group.



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
326
327
328
329
330
331
332
333
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 289

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AdminUserGroupApi.list ..."
  end
  # resource path

  local_var_path = "/usergroups".sub('{format}','json')

  # query parameters

  query_params = {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'searchOn'] = @api_client.build_collection_param(opts[:'search_on'], :csv) if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = @api_client.build_collection_param(opts[:'sort_by'], :csv) if !opts[:'sort_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?

  # header parameters

  header_params = {}

  # HTTP header 'Accept' (if needed)

  local_header_accept = ['application/json']
  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', 'text/plain; 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 = nil
  auth_names = ['oauth2']
  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 => 'ListUserGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminUserGroupApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch(user_group_id, group, opts = {}) ⇒ UserGroup 



406
407
408
409
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 406

def patch(user_group_id, group, opts = {})
  data, _status_code, _headers = patch_with_http_info(user_group_id, group, opts)
  return data
end

#patch_with_http_info(user_group_id, group, opts = {}) ⇒ Array<(UserGroup, Fixnum, Hash)> 



417
418
419
420
421
422
423
424
425
426
427
428
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
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 417

def patch_with_http_info(user_group_id, group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AdminUserGroupApi.patch ..."
  end
  # verify the required parameter 'user_group_id' is set

  fail ArgumentError, "Missing the required parameter 'user_group_id' when calling AdminUserGroupApi.patch" if user_group_id.nil?
  # verify the required parameter 'group' is set

  fail ArgumentError, "Missing the required parameter 'group' when calling AdminUserGroupApi.patch" if group.nil?
  # resource path

  local_var_path = "/usergroups/{userGroupID}".sub('{format}','json').sub('{' + 'userGroupID' + '}', user_group_id.to_s)

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}

  # HTTP header 'Accept' (if needed)

  local_header_accept = ['application/json']
  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', 'text/plain; 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(group)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminUserGroupApi#patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#save_user_assignment(user_group_assignment, opts = {}) ⇒ nil 



466
467
468
469
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 466

def save_user_assignment(user_group_assignment, opts = {})
  save_user_assignment_with_http_info(user_group_assignment, opts)
  return nil
end

#save_user_assignment_with_http_info(user_group_assignment, opts = {}) ⇒ Array<(nil, Fixnum, Hash)> 



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 476

def save_user_assignment_with_http_info(user_group_assignment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AdminUserGroupApi.save_user_assignment ..."
  end
  # verify the required parameter 'user_group_assignment' is set

  fail ArgumentError, "Missing the required parameter 'user_group_assignment' when calling AdminUserGroupApi.save_user_assignment" if user_group_assignment.nil?
  # resource path

  local_var_path = "/usergroups/assignments".sub('{format}','json')

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}

  # HTTP header 'Accept' (if needed)

  local_header_accept = ['application/json']
  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', 'text/plain; 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(user_group_assignment)
  auth_names = ['oauth2']
  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: AdminUserGroupApi#save_user_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(user_group_id, group, opts = {}) ⇒ UserGroup 



523
524
525
526
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 523

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

#update_with_http_info(user_group_id, group, opts = {}) ⇒ Array<(UserGroup, Fixnum, Hash)> 



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/order_cloud/api/admin_user_group_api.rb', line 534

def update_with_http_info(user_group_id, group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AdminUserGroupApi.update ..."
  end
  # verify the required parameter 'user_group_id' is set

  fail ArgumentError, "Missing the required parameter 'user_group_id' when calling AdminUserGroupApi.update" if user_group_id.nil?
  # verify the required parameter 'group' is set

  fail ArgumentError, "Missing the required parameter 'group' when calling AdminUserGroupApi.update" if group.nil?
  # resource path

  local_var_path = "/usergroups/{userGroupID}".sub('{format}','json').sub('{' + 'userGroupID' + '}', user_group_id.to_s)

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}

  # HTTP header 'Accept' (if needed)

  local_header_accept = ['application/json']
  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', 'text/plain; 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(group)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminUserGroupApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end