Class: KoronaClient::ProductsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona_client/api/products_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProductsApi

Returns a new instance of ProductsApi.



19
20
21
 
# File 'lib/korona_client/api/products_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/korona_client/api/products_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_products(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of new products

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of new products

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

    the optional parameters

Options Hash (opts):

  • :upsert (BOOLEAN) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:



29
30
31
32
 
# File 'lib/korona_client/api/products_api.rb', line 29

def add_products(, body, opts = {})
  data, _status_code, _headers = add_products_with_http_info(, body, opts)
  data
end

#add_products_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

adds a batch of new products

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of new products

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

    the optional parameters

Options Hash (opts):

  • :upsert (BOOLEAN) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:

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

    Array<AddOrUpdateResult> data, response status code and response headers



41
42
43
44
45
46
47
48
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
 
# File 'lib/korona_client/api/products_api.rb', line 41

def add_products_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.add_products ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ProductsApi.add_products"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ProductsApi.add_products"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/products'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  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 => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#add_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_product(korona_account_id, product_id, opts = {}) ⇒ nil

deletes the single product

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • product_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

  • (nil) 


91
92
93
94
 
# File 'lib/korona_client/api/products_api.rb', line 91

def delete_product(, product_id, opts = {})
  delete_product_with_http_info(, product_id, opts)
  nil
end

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

deletes the single product

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • product_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



102
103
104
105
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
 
# File 'lib/korona_client/api/products_api.rb', line 102

def delete_product_with_http_info(, product_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.delete_product ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ProductsApi.delete_product"
  end
  # verify the required parameter 'product_id' is set
  if @api_client.config.client_side_validation && product_id.nil?
    fail ArgumentError, "Missing the required parameter 'product_id' when calling ProductsApi.delete_product"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/products/{productId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'productId' + '}', product_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  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: ProductsApi#delete_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_products(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

deletes a batch of products

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of existing products (id or number required)

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

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/korona_client/api/products_api.rb', line 150

def delete_products(, body, opts = {})
  data, _status_code, _headers = delete_products_with_http_info(, body, opts)
  data
end

#delete_products_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

deletes a batch of products

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of existing products (id or number required)

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

    the optional parameters

Returns:

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

    Array<AddOrUpdateResult> data, response status code and response headers



161
162
163
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
 
# File 'lib/korona_client/api/products_api.rb', line 161

def delete_products_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.delete_products ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ProductsApi.delete_products"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ProductsApi.delete_products"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/products'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  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,
    :return_type => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#delete_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_product(korona_account_id, product_id, opts = {}) ⇒ Product

returns the single product

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • product_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:



210
211
212
213
 
# File 'lib/korona_client/api/products_api.rb', line 210

def get_product(, product_id, opts = {})
  data, _status_code, _headers = get_product_with_http_info(, product_id, opts)
  data
end

#get_product_stocks(korona_account_id, product_id, opts = {}) ⇒ ResultListProductStock

lists the product stocks in different warehouses (KORONA.retail required)

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • product_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

Returns:



274
275
276
277
 
# File 'lib/korona_client/api/products_api.rb', line 274

def get_product_stocks(, product_id, opts = {})
  data, _status_code, _headers = get_product_stocks_with_http_info(, product_id, opts)
  data
end

#get_product_stocks_with_http_info(korona_account_id, product_id, opts = {}) ⇒ Array<(ResultListProductStock, Fixnum, Hash)>

lists the product stocks in different warehouses (KORONA.retail required)

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • product_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

Returns:

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

    ResultListProductStock data, response status code and response headers



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/korona_client/api/products_api.rb', line 289

def get_product_stocks_with_http_info(, product_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.get_product_stocks ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ProductsApi.get_product_stocks"
  end
  # verify the required parameter 'product_id' is set
  if @api_client.config.client_side_validation && product_id.nil?
    fail ArgumentError, "Missing the required parameter 'product_id' when calling ProductsApi.get_product_stocks"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/products/{productId}/stocks'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'productId' + '}', product_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  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 => 'ResultListProductStock')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#get_product_stocks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_product_with_http_info(korona_account_id, product_id, opts = {}) ⇒ Array<(Product, Fixnum, Hash)>

returns the single product

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • product_id —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

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

    Product data, response status code and response headers



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/korona_client/api/products_api.rb', line 221

def get_product_with_http_info(, product_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.get_product ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ProductsApi.get_product"
  end
  # verify the required parameter 'product_id' is set
  if @api_client.config.client_side_validation && product_id.nil?
    fail ArgumentError, "Missing the required parameter 'product_id' when calling ProductsApi.get_product"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/products/{productId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'productId' + '}', product_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  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 => 'Product')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#get_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_products(korona_account_id, opts = {}) ⇒ ResultListProduct

lists all products

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

  • :product_codes (String) —

    at least one product code to filter by (multiple separated by comma; max. 10)

  • :commodity_group (String) —

    commodity group id to filter by

  • :assortment (String) —

    assortment id to filter by

  • :tag (String) —

    tag id to filter by

  • :number (String) —

    number of the related object

Returns:



351
352
353
354
 
# File 'lib/korona_client/api/products_api.rb', line 351

def get_products(, opts = {})
  data, _status_code, _headers = get_products_with_http_info(, opts)
  data
end

#get_products_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListProduct, Fixnum, Hash)>

lists all products

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

  • :product_codes (String) —

    at least one product code to filter by (multiple separated by comma; max. 10)

  • :commodity_group (String) —

    commodity group id to filter by

  • :assortment (String) —

    assortment id to filter by

  • :tag (String) —

    tag id to filter by

  • :number (String) —

    number of the related object

Returns:

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

    ResultListProduct data, response status code and response headers



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/korona_client/api/products_api.rb', line 371

def get_products_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.get_products ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ProductsApi.get_products"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/products'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
  query_params[:'productCodes'] = opts[:'product_codes'] if !opts[:'product_codes'].nil?
  query_params[:'commodityGroup'] = opts[:'commodity_group'] if !opts[:'commodity_group'].nil?
  query_params[:'assortment'] = opts[:'assortment'] if !opts[:'assortment'].nil?
  query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  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 => 'ResultListProduct')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#get_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_product(korona_account_id, product_id, body, opts = {}) ⇒ nil

updates the single product if [number] is set, the number of the object will change and the resource location as well

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • product_id —

    id of the related object (important: id should match the uuid-format)

  • body —

    the properties to update of the product

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

    the optional parameters

Returns:

  • (nil) 


427
428
429
430
 
# File 'lib/korona_client/api/products_api.rb', line 427

def update_product(, product_id, body, opts = {})
  update_product_with_http_info(, product_id, body, opts)
  nil
end

#update_product_with_http_info(korona_account_id, product_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

updates the single product if [number] is set, the number of the object will change and the resource location as well

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • product_id —

    id of the related object (important: id should match the uuid-format)

  • body —

    the properties to update of the product

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/korona_client/api/products_api.rb', line 439

def update_product_with_http_info(, product_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.update_product ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ProductsApi.update_product"
  end
  # verify the required parameter 'product_id' is set
  if @api_client.config.client_side_validation && product_id.nil?
    fail ArgumentError, "Missing the required parameter 'product_id' when calling ProductsApi.update_product"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ProductsApi.update_product"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/products/{productId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'productId' + '}', product_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  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: ProductsApi#update_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_products(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

updates a batch of products

number

must be set in the objects, otherwise the object cannot be updated

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    an array of existing products

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

    the optional parameters

Returns:



491
492
493
494
 
# File 'lib/korona_client/api/products_api.rb', line 491

def update_products(, body, opts = {})
  data, _status_code, _headers = update_products_with_http_info(, body, opts)
  data
end

#update_products_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

updates a batch of products

number

must be set in the objects, otherwise the object cannot be updated

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    an array of existing products

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

    the optional parameters

Returns:

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

    Array<AddOrUpdateResult> data, response status code and response headers



502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/korona_client/api/products_api.rb', line 502

def update_products_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.update_products ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ProductsApi.update_products"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ProductsApi.update_products"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/products'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  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 => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#update_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end