Class: OrderCloud::CategoryApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CategoryApi

Returns a new instance of CategoryApi.



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

def api_client
  @api_client
end

Instance Method Details

#create(catalog_id, category, opts = {}) ⇒ Category

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:



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

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

#create_with_http_info(catalog_id, category, opts = {}) ⇒ Array<(Category, Fixnum, Hash)>

Returns Category data, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:

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

    Category 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/category_api.rb', line 51

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

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

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_id —

    ID of the category.

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

    the optional parameters

Returns:

  • (nil) 


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

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

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

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_id —

    ID of the category.

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

Returns:

  • (nil) 


164
165
166
167
 
# File 'lib/order_cloud/api/category_api.rb', line 164

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

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

Returns nil, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_id —

    ID of the category.

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Options Hash (opts):

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

Returns:

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

    nil, response status code and response headers



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
218
219
220
221
222
223
224
 
# File 'lib/order_cloud/api/category_api.rb', line 178

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

  # query parameters
  query_params = {}
  query_params[:'buyerID'] = buyer_id
  query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_id'].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(: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: CategoryApi#delete_assignment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_id —

    ID of the category.

  • product_id —

    ID of the product.

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

    the optional parameters

Returns:

  • (nil) 


233
234
235
236
 
# File 'lib/order_cloud/api/category_api.rb', line 233

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

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

Returns nil, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_id —

    ID of the category.

  • 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



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
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/order_cloud/api/category_api.rb', line 245

def delete_product_assignment_with_http_info(catalog_id, category_id, product_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CategoryApi.delete_product_assignment ..."
  end
  # verify the required parameter 'catalog_id' is set
  fail ArgumentError, "Missing the required parameter 'catalog_id' when calling CategoryApi.delete_product_assignment" if catalog_id.nil?
  # verify the required parameter 'category_id' is set
  fail ArgumentError, "Missing the required parameter 'category_id' when calling CategoryApi.delete_product_assignment" if category_id.nil?
  # verify the required parameter 'product_id' is set
  fail ArgumentError, "Missing the required parameter 'product_id' when calling CategoryApi.delete_product_assignment" if product_id.nil?
  # resource path
  local_var_path = "/catalogs/{catalogID}/categories/{categoryID}/productassignments/{productID}".sub('{format}','json').sub('{' + 'catalogID' + '}', catalog_id.to_s).sub('{' + 'categoryID' + '}', category_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: CategoryApi#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, category_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_id —

    ID of the category.

  • 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/category_api.rb', line 112

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

#get(catalog_id, category_id, opts = {}) ⇒ Category

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_id —

    ID of the category.

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

    the optional parameters

Returns:



296
297
298
299
 
# File 'lib/order_cloud/api/category_api.rb', line 296

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

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

Returns Category data, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_id —

    ID of the category.

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

    the optional parameters

Returns:

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

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

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

#list(catalog_id, opts = {}) ⇒ ListCategory

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Options Hash (opts):

  • :depth (String) —

    Depth of the category.

  • :search (String) —

    Search of the category.

  • :search_on (Array<String>) —

    Search on of the category.

  • :sort_by (Array<String>) —

    Sort by of the category.

  • :page (Integer) —

    Page of the category.

  • :page_size (Integer) —

    Page size of the category.

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

    Filters of the category.

Returns:



363
364
365
366
 
# File 'lib/order_cloud/api/category_api.rb', line 363

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

#list_assignments(catalog_id, opts = {}) ⇒ ListCategoryAssignment

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Options Hash (opts):

  • :category_id (String) —

    ID of the category.

  • :buyer_id (String) —

    ID of the buyer.

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

  • :level (String) —

    Level of the category.

  • :page (Integer) —

    Page of the category.

  • :page_size (Integer) —

    Page size of the category.

Returns:



441
442
443
444
 
# File 'lib/order_cloud/api/category_api.rb', line 441

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

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

Returns ListCategoryAssignment data, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Options Hash (opts):

  • :category_id (String) —

    ID of the category.

  • :buyer_id (String) —

    ID of the buyer.

  • :user_id (String) —

    ID of the user.

  • :user_group_id (String) —

    ID of the user group.

  • :level (String) —

    Level of the category.

  • :page (Integer) —

    Page of the category.

  • :page_size (Integer) —

    Page size of the category.

Returns:

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

    ListCategoryAssignment data, response status code and response headers



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
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/order_cloud/api/category_api.rb', line 458

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

  # query parameters
  query_params = {}
  query_params[:'categoryID'] = opts[:'category_id'] if !opts[:'category_id'].nil?
  query_params[:'buyerID'] = opts[:'buyer_id'] if !opts[:'buyer_id'].nil?
  query_params[:'userID'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'userGroupID'] = opts[:'user_group_id'] if !opts[:'user_group_id'].nil?
  query_params[:'level'] = opts[:'level'] if !opts[:'level'].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 => 'ListCategoryAssignment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CategoryApi#list_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_product_assignments(catalog_id, opts = {}) ⇒ ListCategoryProductAssignment

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Options Hash (opts):

  • :category_id (String) —

    ID of the category.

  • :product_id (String) —

    ID of the product.

  • :page (Integer) —

    Page of the category.

  • :page_size (Integer) —

    Page size of the category.

Returns:



516
517
518
519
 
# File 'lib/order_cloud/api/category_api.rb', line 516

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

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

Returns ListCategoryProductAssignment data, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Options Hash (opts):

  • :category_id (String) —

    ID of the category.

  • :product_id (String) —

    ID of the product.

  • :page (Integer) —

    Page of the category.

  • :page_size (Integer) —

    Page size of the category.

Returns:



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

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

  # query parameters
  query_params = {}
  query_params[:'categoryID'] = opts[:'category_id'] if !opts[:'category_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 => 'ListCategoryProductAssignment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CategoryApi#list_product_assignments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns ListCategory data, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Options Hash (opts):

  • :depth (String) —

    Depth of the category.

  • :search (String) —

    Search of the category.

  • :search_on (Array<String>) —

    Search on of the category.

  • :sort_by (Array<String>) —

    Sort by of the category.

  • :page (Integer) —

    Page of the category.

  • :page_size (Integer) —

    Page size of the category.

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

    Filters of the category.

Returns:

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

    ListCategory data, response status code and response headers



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
423
424
425
426
427
 
# File 'lib/order_cloud/api/category_api.rb', line 380

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

  # query parameters
  query_params = {}
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?
  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 => 'ListCategory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CategoryApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch(catalog_id, category_id, category, opts = {}) ⇒ Category

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_id —

    ID of the category.

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

    the optional parameters

Returns:



583
584
585
586
 
# File 'lib/order_cloud/api/category_api.rb', line 583

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

#patch_with_http_info(catalog_id, category_id, category, opts = {}) ⇒ Array<(Category, Fixnum, Hash)>

Returns Category data, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_id —

    ID of the category.

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

    the optional parameters

Returns:

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

    Category data, response status code and response headers



595
596
597
598
599
600
601
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
 
# File 'lib/order_cloud/api/category_api.rb', line 595

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

#save_assignment(catalog_id, category_assignment, opts = {}) ⇒ nil

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:

  • (nil) 


647
648
649
650
 
# File 'lib/order_cloud/api/category_api.rb', line 647

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

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

Returns nil, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_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
698
699
 
# File 'lib/order_cloud/api/category_api.rb', line 658

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

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

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:

  • (nil) 


707
708
709
710
 
# File 'lib/order_cloud/api/category_api.rb', line 707

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

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

Returns nil, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
759
 
# File 'lib/order_cloud/api/category_api.rb', line 718

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

#update(catalog_id, category_id, category, opts = {}) ⇒ Category

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_id —

    ID of the category.

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

    the optional parameters

Returns:



768
769
770
771
 
# File 'lib/order_cloud/api/category_api.rb', line 768

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

#update_with_http_info(catalog_id, category_id, category, opts = {}) ⇒ Array<(Category, Fixnum, Hash)>

Returns Category data, response status code and response headers.

Parameters:

  • catalog_id —

    ID of the catalog.

  • category_id —

    ID of the category.

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

    the optional parameters

Returns:

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

    Category data, response status code and response headers



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/order_cloud/api/category_api.rb', line 780

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