Class: OrderCloud::SupplierUserGroupApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SupplierUserGroupApi

Returns a new instance of SupplierUserGroupApi.



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

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

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

Parameters:

  • supplier_id

    ID of the supplier.

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

    the optional parameters

Returns:



40
41
42
43
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 40

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

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

Returns UserGroup data, response status code and response headers.

Parameters:

  • supplier_id

    ID of the supplier.

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

    the optional parameters

Returns:

  • (Array<(UserGroup, Fixnum, Hash)>)

    UserGroup data, response status code and response headers



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
93
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 51

def create_with_http_info(supplier_id, group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SupplierUserGroupApi.create ..."
  end
  # verify the required parameter 'supplier_id' is set
  fail ArgumentError, "Missing the required parameter 'supplier_id' when calling SupplierUserGroupApi.create" if supplier_id.nil?
  # verify the required parameter 'group' is set
  fail ArgumentError, "Missing the required parameter 'group' when calling SupplierUserGroupApi.create" if group.nil?
  # resource path
  local_var_path = "/suppliers/{supplierID}/usergroups".sub('{format}','json').sub('{' + 'supplierID' + '}', supplier_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(: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: SupplierUserGroupApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Parameters:

  • supplier_id

    ID of the supplier.

  • user_group_id

    ID of the user group.

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

    the optional parameters

Returns:

  • (nil)


101
102
103
104
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 101

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

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

Parameters:

  • supplier_id

    ID of the supplier.

  • user_group_id

    ID of the user group.

  • user_id

    ID of the user.

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

    the optional parameters

Returns:

  • (nil)


162
163
164
165
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 162

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

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

Returns nil, response status code and response headers.

Parameters:

  • supplier_id

    ID of the supplier.

  • user_group_id

    ID of the user group.

  • user_id

    ID of the user.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
217
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 174

def delete_user_assignment_with_http_info(supplier_id, user_group_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SupplierUserGroupApi.delete_user_assignment ..."
  end
  # verify the required parameter 'supplier_id' is set
  fail ArgumentError, "Missing the required parameter 'supplier_id' when calling SupplierUserGroupApi.delete_user_assignment" if supplier_id.nil?
  # verify the required parameter 'user_group_id' is set
  fail ArgumentError, "Missing the required parameter 'user_group_id' when calling SupplierUserGroupApi.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 SupplierUserGroupApi.delete_user_assignment" if user_id.nil?
  # resource path
  local_var_path = "/suppliers/{supplierID}/usergroups/{userGroupID}/assignments/{userID}".sub('{format}','json').sub('{' + 'supplierID' + '}', supplier_id.to_s).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: SupplierUserGroupApi#delete_user_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns nil, response status code and response headers.

Parameters:

  • supplier_id

    ID of the supplier.

  • user_group_id

    ID of the user group.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
152
153
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 112

def delete_with_http_info(supplier_id, user_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SupplierUserGroupApi.delete ..."
  end
  # verify the required parameter 'supplier_id' is set
  fail ArgumentError, "Missing the required parameter 'supplier_id' when calling SupplierUserGroupApi.delete" if supplier_id.nil?
  # verify the required parameter 'user_group_id' is set
  fail ArgumentError, "Missing the required parameter 'user_group_id' when calling SupplierUserGroupApi.delete" if user_group_id.nil?
  # resource path
  local_var_path = "/suppliers/{supplierID}/usergroups/{userGroupID}".sub('{format}','json').sub('{' + 'supplierID' + '}', supplier_id.to_s).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: SupplierUserGroupApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Parameters:

  • supplier_id

    ID of the supplier.

  • user_group_id

    ID of the user group.

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

    the optional parameters

Returns:



225
226
227
228
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 225

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

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

Returns UserGroup data, response status code and response headers.

Parameters:

  • supplier_id

    ID of the supplier.

  • user_group_id

    ID of the user group.

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

    the optional parameters

Returns:

  • (Array<(UserGroup, Fixnum, Hash)>)

    UserGroup data, response status code and response headers



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/order_cloud/api/supplier_user_group_api.rb', line 236

def get_with_http_info(supplier_id, user_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SupplierUserGroupApi.get ..."
  end
  # verify the required parameter 'supplier_id' is set
  fail ArgumentError, "Missing the required parameter 'supplier_id' when calling SupplierUserGroupApi.get" if supplier_id.nil?
  # verify the required parameter 'user_group_id' is set
  fail ArgumentError, "Missing the required parameter 'user_group_id' when calling SupplierUserGroupApi.get" if user_group_id.nil?
  # resource path
  local_var_path = "/suppliers/{supplierID}/usergroups/{userGroupID}".sub('{format}','json').sub('{' + 'supplierID' + '}', supplier_id.to_s).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: SupplierUserGroupApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(supplier_id, opts = {}) ⇒ ListUserGroup

Parameters:

  • supplier_id

    ID of the supplier.

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

    the optional parameters

Options Hash (opts):

  • :search (String)

    Search of the supplier user group.

  • :search_on (Array<String>)

    Search on of the supplier user group.

  • :sort_by (Array<String>)

    Sort by of the supplier user group.

  • :page (Integer)

    Page of the supplier user group.

  • :page_size (Integer)

    Page size of the supplier user group.

  • :filters (Hash<String, String>)

    Filters of the supplier user group.

Returns:



291
292
293
294
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 291

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

#list_user_assignments(supplier_id, opts = {}) ⇒ ListUserGroupAssignment

Parameters:

  • supplier_id

    ID of the supplier.

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

    the optional parameters

Options Hash (opts):

  • :user_group_id (String)

    ID of the user group.

  • :user_id (String)

    ID of the user.

  • :page (Integer)

    Page of the supplier user group.

  • :page_size (Integer)

    Page size of the supplier user group.

Returns:



364
365
366
367
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 364

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

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

Returns ListUserGroupAssignment data, response status code and response headers.

Parameters:

  • supplier_id

    ID of the supplier.

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

    the optional parameters

Options Hash (opts):

  • :user_group_id (String)

    ID of the user group.

  • :user_id (String)

    ID of the user.

  • :page (Integer)

    Page of the supplier user group.

  • :page_size (Integer)

    Page size of the supplier user group.

Returns:

  • (Array<(ListUserGroupAssignment, Fixnum, Hash)>)

    ListUserGroupAssignment data, response status code and response headers



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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 378

def list_user_assignments_with_http_info(supplier_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SupplierUserGroupApi.list_user_assignments ..."
  end
  # verify the required parameter 'supplier_id' is set
  fail ArgumentError, "Missing the required parameter 'supplier_id' when calling SupplierUserGroupApi.list_user_assignments" if supplier_id.nil?
  # resource path
  local_var_path = "/suppliers/{supplierID}/usergroups/assignments".sub('{format}','json').sub('{' + 'supplierID' + '}', supplier_id.to_s)

  # 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: SupplierUserGroupApi#list_user_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns ListUserGroup data, response status code and response headers.

Parameters:

  • supplier_id

    ID of the supplier.

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

    the optional parameters

Options Hash (opts):

  • :search (String)

    Search of the supplier user group.

  • :search_on (Array<String>)

    Search on of the supplier user group.

  • :sort_by (Array<String>)

    Sort by of the supplier user group.

  • :page (Integer)

    Page of the supplier user group.

  • :page_size (Integer)

    Page size of the supplier user group.

  • :filters (Hash<String, String>)

    Filters of the supplier user group.

Returns:

  • (Array<(ListUserGroup, Fixnum, Hash)>)

    ListUserGroup data, response status code and response headers



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
352
353
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 307

def list_with_http_info(supplier_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SupplierUserGroupApi.list ..."
  end
  # verify the required parameter 'supplier_id' is set
  fail ArgumentError, "Missing the required parameter 'supplier_id' when calling SupplierUserGroupApi.list" if supplier_id.nil?
  # resource path
  local_var_path = "/suppliers/{supplierID}/usergroups".sub('{format}','json').sub('{' + 'supplierID' + '}', supplier_id.to_s)

  # 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: SupplierUserGroupApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Parameters:

  • supplier_id

    ID of the supplier.

  • user_group_id

    ID of the user group.

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

    the optional parameters

Returns:



431
432
433
434
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 431

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

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

Returns UserGroup data, response status code and response headers.

Parameters:

  • supplier_id

    ID of the supplier.

  • user_group_id

    ID of the user group.

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

    the optional parameters

Returns:

  • (Array<(UserGroup, Fixnum, Hash)>)

    UserGroup data, response status code and response headers



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
485
486
487
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 443

def patch_with_http_info(supplier_id, user_group_id, group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SupplierUserGroupApi.patch ..."
  end
  # verify the required parameter 'supplier_id' is set
  fail ArgumentError, "Missing the required parameter 'supplier_id' when calling SupplierUserGroupApi.patch" if supplier_id.nil?
  # verify the required parameter 'user_group_id' is set
  fail ArgumentError, "Missing the required parameter 'user_group_id' when calling SupplierUserGroupApi.patch" if user_group_id.nil?
  # verify the required parameter 'group' is set
  fail ArgumentError, "Missing the required parameter 'group' when calling SupplierUserGroupApi.patch" if group.nil?
  # resource path
  local_var_path = "/suppliers/{supplierID}/usergroups/{userGroupID}".sub('{format}','json').sub('{' + 'supplierID' + '}', supplier_id.to_s).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: SupplierUserGroupApi#patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Parameters:

  • supplier_id

    ID of the supplier.

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

    the optional parameters

Returns:

  • (nil)


495
496
497
498
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 495

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

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

Returns nil, response status code and response headers.

Parameters:

  • supplier_id

    ID of the supplier.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def save_user_assignment_with_http_info(supplier_id, user_group_assignment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SupplierUserGroupApi.save_user_assignment ..."
  end
  # verify the required parameter 'supplier_id' is set
  fail ArgumentError, "Missing the required parameter 'supplier_id' when calling SupplierUserGroupApi.save_user_assignment" if supplier_id.nil?
  # verify the required parameter 'user_group_assignment' is set
  fail ArgumentError, "Missing the required parameter 'user_group_assignment' when calling SupplierUserGroupApi.save_user_assignment" if user_group_assignment.nil?
  # resource path
  local_var_path = "/suppliers/{supplierID}/usergroups/assignments".sub('{format}','json').sub('{' + 'supplierID' + '}', supplier_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(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: SupplierUserGroupApi#save_user_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Parameters:

  • supplier_id

    ID of the supplier.

  • user_group_id

    ID of the user group.

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

    the optional parameters

Returns:



556
557
558
559
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 556

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

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

Returns UserGroup data, response status code and response headers.

Parameters:

  • supplier_id

    ID of the supplier.

  • user_group_id

    ID of the user group.

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

    the optional parameters

Returns:

  • (Array<(UserGroup, Fixnum, Hash)>)

    UserGroup data, response status code and response headers



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
# File 'lib/order_cloud/api/supplier_user_group_api.rb', line 568

def update_with_http_info(supplier_id, user_group_id, group, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SupplierUserGroupApi.update ..."
  end
  # verify the required parameter 'supplier_id' is set
  fail ArgumentError, "Missing the required parameter 'supplier_id' when calling SupplierUserGroupApi.update" if supplier_id.nil?
  # verify the required parameter 'user_group_id' is set
  fail ArgumentError, "Missing the required parameter 'user_group_id' when calling SupplierUserGroupApi.update" if user_group_id.nil?
  # verify the required parameter 'group' is set
  fail ArgumentError, "Missing the required parameter 'group' when calling SupplierUserGroupApi.update" if group.nil?
  # resource path
  local_var_path = "/suppliers/{supplierID}/usergroups/{userGroupID}".sub('{format}','json').sub('{' + 'supplierID' + '}', supplier_id.to_s).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: SupplierUserGroupApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end