Class: OrderCloud::CatalogApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CatalogApi

Returns a new instance of CatalogApi.



30
31
32
 
# File 'lib/order_cloud/api/catalog_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/catalog_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#create(catalog, opts = {}) ⇒ Catalog

Parameters:

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

    the optional parameters

Returns:



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

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

#create_with_http_info(catalog, opts = {}) ⇒ Array<(Catalog, Fixnum, Hash)>

Returns Catalog data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    Catalog data, response status code and response headers



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/catalog_api.rb', line 49

def create_with_http_info(catalog, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogApi.create ..."
  end
  # verify the required parameter 'catalog' is set
  fail ArgumentError, "Missing the required parameter 'catalog' when calling CatalogApi.create" if catalog.nil?
  # resource path
  local_var_path = "/catalogs".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(catalog)
  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 => 'Catalog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CatalogApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:

  • (nil) 


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

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

#delete_assignment(catalog_id, buyer_id, opts = {}) ⇒ nil

Parameters:

  • catalog_id —

    ID of the catalog.

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_assignment(catalog_id, buyer_id, opts = {})
  delete_assignment_with_http_info(catalog_id, buyer_id, opts)
  return nil
end

#delete_assignment_with_http_info(catalog_id, buyer_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
206
 
# File 'lib/order_cloud/api/catalog_api.rb', line 164

def delete_assignment_with_http_info(catalog_id, buyer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogApi.delete_assignment ..."
  end
  # verify the required parameter 'catalog_id' is set
  fail ArgumentError, "Missing the required parameter 'catalog_id' when calling CatalogApi.delete_assignment" if catalog_id.nil?
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling CatalogApi.delete_assignment" if buyer_id.nil?
  # resource path
  local_var_path = "/catalogs/{catalogID}/assignments".sub('{format}','json').sub('{' + 'catalogID' + '}', catalog_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'buyerID'] = buyer_id

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

#delete_product_assignment(catalog_id, product_id, opts = {}) ⇒ nil

Parameters:

  • catalog_id —

    ID of the catalog.

  • product_id —

    ID of the product.

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

    the optional parameters

Returns:

  • (nil) 


214
215
216
217
 
# File 'lib/order_cloud/api/catalog_api.rb', line 214

def delete_product_assignment(catalog_id, product_id, opts = {})
  delete_product_assignment_with_http_info(catalog_id, product_id, opts)
  return nil
end

#delete_product_assignment_with_http_info(catalog_id, product_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

  • product_id —

    ID of the product.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
263
264
265
266
 
# File 'lib/order_cloud/api/catalog_api.rb', line 225

def delete_product_assignment_with_http_info(catalog_id, product_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogApi.delete_product_assignment ..."
  end
  # verify the required parameter 'catalog_id' is set
  fail ArgumentError, "Missing the required parameter 'catalog_id' when calling CatalogApi.delete_product_assignment" if catalog_id.nil?
  # verify the required parameter 'product_id' is set
  fail ArgumentError, "Missing the required parameter 'product_id' when calling CatalogApi.delete_product_assignment" if product_id.nil?
  # resource path
  local_var_path = "/catalogs/{catalogID}/productassignments/{productID}".sub('{format}','json').sub('{' + 'catalogID' + '}', catalog_id.to_s).sub('{' + 'productID' + '}', product_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: CatalogApi#delete_product_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns nil, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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/catalog_api.rb', line 106

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

#get(catalog_id, opts = {}) ⇒ Catalog

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:



273
274
275
276
 
# File 'lib/order_cloud/api/catalog_api.rb', line 273

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

#get_with_http_info(catalog_id, opts = {}) ⇒ Array<(Catalog, Fixnum, Hash)>

Returns Catalog data, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:

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

    Catalog data, response status code and response headers



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

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

#list(opts = {}) ⇒ ListCatalog

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the catalog.

  • :search_on (Array<String>) —

    Search on of the catalog.

  • :sort_by (Array<String>) —

    Sort by of the catalog.

  • :page (Integer) —

    Page of the catalog.

  • :page_size (Integer) —

    Page size of the catalog.

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

    Filters of the catalog.

Returns:



335
336
337
338
 
# File 'lib/order_cloud/api/catalog_api.rb', line 335

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

#list_assignments(opts = {}) ⇒ ListCatalogAssignment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :catalog_id (String) —

    ID of the catalog.

  • :buyer_id (String) —

    ID of the buyer.

  • :page (Integer) —

    Page of the catalog.

  • :page_size (Integer) —

    Page size of the catalog.

Returns:



404
405
406
407
 
# File 'lib/order_cloud/api/catalog_api.rb', line 404

def list_assignments(opts = {})
  data, _status_code, _headers = list_assignments_with_http_info(opts)
  return data
end

#list_assignments_with_http_info(opts = {}) ⇒ Array<(ListCatalogAssignment, Fixnum, Hash)>

Returns ListCatalogAssignment data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :catalog_id (String) —

    ID of the catalog.

  • :buyer_id (String) —

    ID of the buyer.

  • :page (Integer) —

    Page of the catalog.

  • :page_size (Integer) —

    Page size of the catalog.

Returns:

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

    ListCatalogAssignment data, response status code and response headers



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/catalog_api.rb', line 417

def list_assignments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogApi.list_assignments ..."
  end
  # resource path
  local_var_path = "/catalogs/assignments".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'catalogID'] = opts[:'catalog_id'] if !opts[:'catalog_id'].nil?
  query_params[:'buyerID'] = opts[:'buyer_id'] if !opts[:'buyer_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 => 'ListCatalogAssignment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CatalogApi#list_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_product_assignments(opts = {}) ⇒ ListProductCatalogAssignment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :catalog_id (String) —

    ID of the catalog.

  • :product_id (String) —

    ID of the product.

  • :page (Integer) —

    Page of the catalog.

  • :page_size (Integer) —

    Page size of the catalog.

Returns:



469
470
471
472
 
# File 'lib/order_cloud/api/catalog_api.rb', line 469

def list_product_assignments(opts = {})
  data, _status_code, _headers = list_product_assignments_with_http_info(opts)
  return data
end

#list_product_assignments_with_http_info(opts = {}) ⇒ Array<(ListProductCatalogAssignment, Fixnum, Hash)>

Returns ListProductCatalogAssignment data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :catalog_id (String) —

    ID of the catalog.

  • :product_id (String) —

    ID of the product.

  • :page (Integer) —

    Page of the catalog.

  • :page_size (Integer) —

    Page size of the catalog.

Returns:



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
516
517
518
519
520
521
522
523
524
 
# File 'lib/order_cloud/api/catalog_api.rb', line 482

def list_product_assignments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogApi.list_product_assignments ..."
  end
  # resource path
  local_var_path = "/catalogs/productassignments".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'catalogID'] = opts[:'catalog_id'] if !opts[:'catalog_id'].nil?
  query_params[:'productID'] = opts[:'product_id'] if !opts[:'product_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 => 'ListProductCatalogAssignment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CatalogApi#list_product_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns ListCatalog data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Search of the catalog.

  • :search_on (Array<String>) —

    Search on of the catalog.

  • :sort_by (Array<String>) —

    Sort by of the catalog.

  • :page (Integer) —

    Page of the catalog.

  • :page_size (Integer) —

    Page size of the catalog.

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

    Filters of the catalog.

Returns:

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

    ListCatalog 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
 
# File 'lib/order_cloud/api/catalog_api.rb', line 350

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogApi.list ..."
  end
  # resource path
  local_var_path = "/catalogs".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 => 'ListCatalog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CatalogApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch(catalog_id, partial_catalog, opts = {}) ⇒ Catalog

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:



532
533
534
535
 
# File 'lib/order_cloud/api/catalog_api.rb', line 532

def patch(catalog_id, partial_catalog, opts = {})
  data, _status_code, _headers = patch_with_http_info(catalog_id, partial_catalog, opts)
  return data
end

#patch_with_http_info(catalog_id, partial_catalog, opts = {}) ⇒ Array<(Catalog, Fixnum, Hash)>

Returns Catalog data, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:

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

    Catalog data, response status code and response headers



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
577
578
579
580
581
582
583
584
585
 
# File 'lib/order_cloud/api/catalog_api.rb', line 543

def patch_with_http_info(catalog_id, partial_catalog, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogApi.patch ..."
  end
  # verify the required parameter 'catalog_id' is set
  fail ArgumentError, "Missing the required parameter 'catalog_id' when calling CatalogApi.patch" if catalog_id.nil?
  # verify the required parameter 'partial_catalog' is set
  fail ArgumentError, "Missing the required parameter 'partial_catalog' when calling CatalogApi.patch" if partial_catalog.nil?
  # resource path
  local_var_path = "/catalogs/{catalogID}".sub('{format}','json').sub('{' + 'catalogID' + '}', catalog_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(partial_catalog)
  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 => 'Catalog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CatalogApi#patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#save_assignment(assignment, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


592
593
594
595
 
# File 'lib/order_cloud/api/catalog_api.rb', line 592

def save_assignment(assignment, opts = {})
  save_assignment_with_http_info(assignment, opts)
  return nil
end

#save_assignment_with_http_info(assignment, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/order_cloud/api/catalog_api.rb', line 602

def save_assignment_with_http_info(assignment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogApi.save_assignment ..."
  end
  # verify the required parameter 'assignment' is set
  fail ArgumentError, "Missing the required parameter 'assignment' when calling CatalogApi.save_assignment" if assignment.nil?
  # resource path
  local_var_path = "/catalogs/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(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: CatalogApi#save_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#save_product_assignment(product_assignment, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


648
649
650
651
 
# File 'lib/order_cloud/api/catalog_api.rb', line 648

def save_product_assignment(product_assignment, opts = {})
  save_product_assignment_with_http_info(product_assignment, opts)
  return nil
end

#save_product_assignment_with_http_info(product_assignment, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/order_cloud/api/catalog_api.rb', line 658

def save_product_assignment_with_http_info(product_assignment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogApi.save_product_assignment ..."
  end
  # verify the required parameter 'product_assignment' is set
  fail ArgumentError, "Missing the required parameter 'product_assignment' when calling CatalogApi.save_product_assignment" if product_assignment.nil?
  # resource path
  local_var_path = "/catalogs/productassignments".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(product_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: CatalogApi#save_product_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(catalog_id, catalog, opts = {}) ⇒ Catalog

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:



705
706
707
708
 
# File 'lib/order_cloud/api/catalog_api.rb', line 705

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

#update_with_http_info(catalog_id, catalog, opts = {}) ⇒ Array<(Catalog, Fixnum, Hash)>

Returns Catalog data, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:

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

    Catalog data, response status code and response headers



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
 
# File 'lib/order_cloud/api/catalog_api.rb', line 716

def update_with_http_info(catalog_id, catalog, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CatalogApi.update ..."
  end
  # verify the required parameter 'catalog_id' is set
  fail ArgumentError, "Missing the required parameter 'catalog_id' when calling CatalogApi.update" if catalog_id.nil?
  # verify the required parameter 'catalog' is set
  fail ArgumentError, "Missing the required parameter 'catalog' when calling CatalogApi.update" if catalog.nil?
  # resource path
  local_var_path = "/catalogs/{catalogID}".sub('{format}','json').sub('{' + 'catalogID' + '}', catalog_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(catalog)
  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 => 'Catalog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CatalogApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end