Class: KoronaCloudClient::ProductsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona-cloud-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-cloud-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-cloud-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 (String) —

    account id of the KORONA.cloud account

  • body (Array<Product>) —

    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

  • :merge_list_items (Boolean) —

    if set to true, merges lists instead of replacing them

Returns:



29
30
31
32
 
# File 'lib/korona-cloud-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>, Integer, Hash)>

adds a batch of new products

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<Product>) —

    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

  • :merge_list_items (Boolean) —

    if set to true, merges lists instead of replacing them

Returns:

  • (Array<(Array<AddOrUpdateResult>, Integer, 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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/korona-cloud-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' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ProductsApi.add_products",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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 (String) —

    account id of the KORONA.cloud account

  • product_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


105
106
107
108
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 105

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, Integer, Hash)>

deletes the single product

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • product_id (String) —

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

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 115

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' + '}', CGI.escape(.to_s)).sub('{' + 'productId' + '}', CGI.escape(product_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ProductsApi.delete_product",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  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 (String) —

    account id of the KORONA.cloud account

  • body (Array<Product>) —

    array of existing products (id or number required)

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

    the optional parameters

Returns:



172
173
174
175
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 172

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>, Integer, Hash)>

deletes a batch of products

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<Product>) —

    array of existing products (id or number required)

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

    the optional parameters

Returns:

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

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



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
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 182

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' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ProductsApi.delete_products",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  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 (String) —

    account id of the KORONA.cloud account

  • product_id (String) —

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

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

    the optional parameters

Returns:



244
245
246
247
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 244

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 (String) —

    account id of the KORONA.cloud account

  • product_id (String) —

    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:



315
316
317
318
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 315

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, Integer, Hash)>

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

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • product_id (String) —

    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, Integer, Hash)>) —

    ResultListProductStock data, response status code and response headers



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 329

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' + '}', CGI.escape(.to_s)).sub('{' + 'productId' + '}', CGI.escape(product_id.to_s))

  # query parameters
  query_params = opts[: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 = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ResultListProductStock'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ProductsApi.get_product_stocks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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, Integer, Hash)>

returns the single product

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • product_id (String) —

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

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

    the optional parameters

Returns:

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

    Product data, response status code and response headers



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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 254

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' + '}', CGI.escape(.to_s)).sub('{' + 'productId' + '}', CGI.escape(product_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Product'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ProductsApi.get_product",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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 (String) —

    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

  • :name (String) —

    name of the related object

Returns:



400
401
402
403
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 400

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, Integer, Hash)>

lists all products

Parameters:

  • korona_account_id (String) —

    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

  • :name (String) —

    name of the related object

Returns:

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

    ResultListProduct data, response status code and response headers



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 420

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' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[: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?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ResultListProduct'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ProductsApi.get_products",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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

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

removes the tag from the product

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • product_id (String) —

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

  • tag_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


485
486
487
488
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 485

def remove_tag_from_product(, product_id, tag_id, opts = {})
  remove_tag_from_product_with_http_info(, product_id, tag_id, opts)
  nil
end

#remove_tag_from_product_with_http_info(korona_account_id, product_id, tag_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

removes the tag from the product

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • product_id (String) —

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

  • tag_id (String) —

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

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
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
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 496

def remove_tag_from_product_with_http_info(, product_id, tag_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.remove_tag_from_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.remove_tag_from_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.remove_tag_from_product"
  end
  # verify the required parameter 'tag_id' is set
  if @api_client.config.client_side_validation && tag_id.nil?
    fail ArgumentError, "Missing the required parameter 'tag_id' when calling ProductsApi.remove_tag_from_product"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/products/{productId}/tags/{tagId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'productId' + '}', CGI.escape(product_id.to_s)).sub('{' + 'tagId' + '}', CGI.escape(tag_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ProductsApi.remove_tag_from_product",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#remove_tag_from_product\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 (String) —

    account id of the KORONA.cloud account

  • product_id (String) —

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

  • body (Product) —

    the properties to update of the product

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

    the optional parameters

Options Hash (opts):

  • :merge_list_items (Boolean) —

    if set to true, merges lists instead of replacing them

Returns:

  • (nil) 


560
561
562
563
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 560

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, Integer, 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 (String) —

    account id of the KORONA.cloud account

  • product_id (String) —

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

  • body (Product) —

    the properties to update of the product

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

    the optional parameters

Options Hash (opts):

  • :merge_list_items (Boolean) —

    if set to true, merges lists instead of replacing them

Returns:

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

    nil, response status code and response headers



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 573

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' + '}', CGI.escape(.to_s)).sub('{' + 'productId' + '}', CGI.escape(product_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ProductsApi.update_product",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  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 (String) —

    account id of the KORONA.cloud account

  • body (Array<Product>) —

    an array of existing products

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

    the optional parameters

Options Hash (opts):

  • :merge_list_items (Boolean) —

    if set to true, merges lists instead of replacing them

Returns:



642
643
644
645
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 642

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>, Integer, Hash)>

updates a batch of products

number

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

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<Product>) —

    an array of existing products

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

    the optional parameters

Options Hash (opts):

  • :merge_list_items (Boolean) —

    if set to true, merges lists instead of replacing them

Returns:

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

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



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
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/korona-cloud-client/api/products_api.rb', line 654

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' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ProductsApi.update_products",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  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