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(buyer_id, category, opts = {}) ⇒ Category

Parameters:

  • buyer_id —

    ID of the buyer.

  • 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(buyer_id, category, opts = {})
  data, _status_code, _headers = create_with_http_info(buyer_id, category, opts)
  return data
end

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

Returns Category data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • 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(buyer_id, category, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CategoryApi.create ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling CategoryApi.create" if buyer_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 = "/buyers/{buyerID}/categories".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_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(buyer_id, category_id, opts = {}) ⇒ nil

Parameters:

  • buyer_id —

    ID of the buyer.

  • 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(buyer_id, category_id, opts = {})
  delete_with_http_info(buyer_id, category_id, opts)
  return nil
end

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

Parameters:

  • buyer_id —

    ID of the buyer.

  • category_id —

    ID of the category.

  • 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) 


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

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

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

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • category_id —

    ID of the category.

  • 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



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

def delete_assignment_with_http_info(buyer_id, category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CategoryApi.delete_assignment ..."
  end
  # 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?
  # 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?
  # resource path
  local_var_path = "/buyers/{buyerID}/categories/{categoryID}/assignments".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_id.to_s).sub('{' + 'categoryID' + '}', category_id.to_s)

  # query parameters
  query_params = {}
  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(buyer_id, category_id, product_id, opts = {}) ⇒ nil

Parameters:

  • buyer_id —

    ID of the buyer.

  • category_id —

    ID of the category.

  • product_id —

    ID of the product.

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

    the optional parameters

Returns:

  • (nil) 


228
229
230
231
 
# File 'lib/order_cloud/api/category_api.rb', line 228

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

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

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • 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



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
279
280
281
282
283
 
# File 'lib/order_cloud/api/category_api.rb', line 240

def delete_product_assignment_with_http_info(buyer_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 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling CategoryApi.delete_product_assignment" if buyer_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 = "/buyers/{buyerID}/categories/{categoryID}/productassignments/{productID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_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(buyer_id, category_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • 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(buyer_id, category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CategoryApi.delete ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling CategoryApi.delete" if buyer_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 = "/buyers/{buyerID}/categories/{categoryID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_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(buyer_id, category_id, opts = {}) ⇒ Category

Parameters:

  • buyer_id —

    ID of the buyer.

  • category_id —

    ID of the category.

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

    the optional parameters

Returns:



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

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

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

Returns Category data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • 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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/order_cloud/api/category_api.rb', line 302

def get_with_http_info(buyer_id, category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CategoryApi.get ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling CategoryApi.get" if buyer_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 = "/buyers/{buyerID}/categories/{categoryID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_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(buyer_id, opts = {}) ⇒ ListCategory

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Options Hash (opts):

  • :depth (String) —

    Depth of the category.

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

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

    Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39;

Returns:



358
359
360
361
 
# File 'lib/order_cloud/api/category_api.rb', line 358

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

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

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Options Hash (opts):

  • :category_id (String) —

    ID of the category.

  • :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 results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

Returns:



435
436
437
438
 
# File 'lib/order_cloud/api/category_api.rb', line 435

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

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

Returns ListCategoryAssignment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Options Hash (opts):

  • :category_id (String) —

    ID of the category.

  • :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 results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

Returns:

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

    ListCategoryAssignment data, response status code and response headers



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
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/order_cloud/api/category_api.rb', line 451

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

  # query parameters
  query_params = {}
  query_params[:'categoryID'] = opts[:'category_id'] if !opts[:'category_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(buyer_id, opts = {}) ⇒ ListCategoryProductAssignment

Parameters:

  • buyer_id —

    ID of the buyer.

  • 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 results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

Returns:



508
509
510
511
 
# File 'lib/order_cloud/api/category_api.rb', line 508

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

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

Returns ListCategoryProductAssignment data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • 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 results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

Returns:



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
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/order_cloud/api/category_api.rb', line 522

def list_product_assignments_with_http_info(buyer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CategoryApi.list_product_assignments ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling CategoryApi.list_product_assignments" if buyer_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/categories/productassignments".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_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(buyer_id, opts = {}) ⇒ Array<(ListCategory, Fixnum, Hash)>

Returns ListCategory data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Options Hash (opts):

  • :depth (String) —

    Depth of the category.

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

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

    Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39;

Returns:

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

    ListCategory data, response status code and response headers



375
376
377
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/category_api.rb', line 375

def list_with_http_info(buyer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CategoryApi.list ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling CategoryApi.list" if buyer_id.nil?
  # resource path
  local_var_path = "/buyers/{buyerID}/categories".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_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'] = opts[:'search_on'] if !opts[:'search_on'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] 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(buyer_id, category_id, category, opts = {}) ⇒ nil

Parameters:

  • buyer_id —

    ID of the buyer.

  • category_id —

    ID of the category.

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

    the optional parameters

Returns:

  • (nil) 


575
576
577
578
 
# File 'lib/order_cloud/api/category_api.rb', line 575

def patch(buyer_id, category_id, category, opts = {})
  patch_with_http_info(buyer_id, category_id, category, opts)
  return nil
end

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

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • category_id —

    ID of the category.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/order_cloud/api/category_api.rb', line 587

def patch_with_http_info(buyer_id, category_id, category, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CategoryApi.patch ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling CategoryApi.patch" if buyer_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 = "/buyers/{buyerID}/categories/{categoryID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_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)
  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(buyer_id, category_assignment, opts = {}) ⇒ nil

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

  • (nil) 


638
639
640
641
 
# File 'lib/order_cloud/api/category_api.rb', line 638

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

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

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



649
650
651
652
653
654
655
656
657
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
 
# File 'lib/order_cloud/api/category_api.rb', line 649

def save_assignment_with_http_info(buyer_id, category_assignment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CategoryApi.save_assignment ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling CategoryApi.save_assignment" if buyer_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 = "/buyers/{buyerID}/categories/assignments".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_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(buyer_id, product_assignment, opts = {}) ⇒ nil

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

  • (nil) 


698
699
700
701
 
# File 'lib/order_cloud/api/category_api.rb', line 698

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

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

Returns nil, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



709
710
711
712
713
714
715
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
 
# File 'lib/order_cloud/api/category_api.rb', line 709

def save_product_assignment_with_http_info(buyer_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 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling CategoryApi.save_product_assignment" if buyer_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 = "/buyers/{buyerID}/categories/productassignments".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_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(buyer_id, category_id, category, opts = {}) ⇒ Category

Parameters:

  • buyer_id —

    ID of the buyer.

  • category_id —

    ID of the category.

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

    the optional parameters

Returns:



759
760
761
762
 
# File 'lib/order_cloud/api/category_api.rb', line 759

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

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

Returns Category data, response status code and response headers.

Parameters:

  • buyer_id —

    ID of the buyer.

  • 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



771
772
773
774
775
776
777
778
779
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
 
# File 'lib/order_cloud/api/category_api.rb', line 771

def update_with_http_info(buyer_id, category_id, category, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CategoryApi.update ..."
  end
  # verify the required parameter 'buyer_id' is set
  fail ArgumentError, "Missing the required parameter 'buyer_id' when calling CategoryApi.update" if buyer_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 = "/buyers/{buyerID}/categories/{categoryID}".sub('{format}','json').sub('{' + 'buyerID' + '}', buyer_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