Class: KoronaCloudClient::InventoriesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona-cloud-client/api/inventories_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InventoriesApi

Returns a new instance of InventoriesApi.



19
20
21
 
# File 'lib/korona-cloud-client/api/inventories_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/inventories_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

adds a batch of new inventories

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<Inventory>) —

    an array of new inventories

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 27

def add_inventories(, body, opts = {})
  data, _status_code, _headers = add_inventories_with_http_info(, body, opts)
  data
end

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

adds a batch of new inventories

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<Inventory>) —

    an array of new inventories

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

    the optional parameters

Returns:

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

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



37
38
39
40
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
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 37

def add_inventories_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.add_inventories ...'
  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 InventoriesApi.add_inventories"
  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 InventoriesApi.add_inventories"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories'.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 => :"InventoriesApi.add_inventories",
    :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: InventoriesApi#add_inventories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_inventory_list_items(korona_account_id, inventory_id, inventory_list_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

adds inventory list items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

  • body (Array<InventoryListItem>) —

    data to update

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

    the optional parameters

Returns:



101
102
103
104
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 101

def add_inventory_list_items(, inventory_id, inventory_list_id, body, opts = {})
  data, _status_code, _headers = add_inventory_list_items_with_http_info(, inventory_id, inventory_list_id, body, opts)
  data
end

#add_inventory_list_items_with_http_info(korona_account_id, inventory_id, inventory_list_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

adds inventory list items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

  • body (Array<InventoryListItem>) —

    data to update

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

    the optional parameters

Returns:

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

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



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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 113

def add_inventory_list_items_with_http_info(, inventory_id, inventory_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.add_inventory_list_items ...'
  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 InventoriesApi.add_inventory_list_items"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.add_inventory_list_items"
  end
  # verify the required parameter 'inventory_list_id' is set
  if @api_client.config.client_side_validation && inventory_list_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id' when calling InventoriesApi.add_inventory_list_items"
  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 InventoriesApi.add_inventory_list_items"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/items'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_id.to_s)).sub('{' + 'inventoryListId' + '}', CGI.escape(inventory_list_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'])
  # 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 => :"InventoriesApi.add_inventory_list_items",
    :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: InventoriesApi#add_inventory_list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#book_inventory_list(korona_account_id, inventory_id, inventory_list_id, opts = {}) ⇒ nil

book the single inventory list

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


184
185
186
187
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 184

def book_inventory_list(, inventory_id, inventory_list_id, opts = {})
  book_inventory_list_with_http_info(, inventory_id, inventory_list_id, opts)
  nil
end

#book_inventory_list_with_http_info(korona_account_id, inventory_id, inventory_list_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

book the single inventory list

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

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



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
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 195

def book_inventory_list_with_http_info(, inventory_id, inventory_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.book_inventory_list ...'
  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 InventoriesApi.book_inventory_list"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.book_inventory_list"
  end
  # verify the required parameter 'inventory_list_id' is set
  if @api_client.config.client_side_validation && inventory_list_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id' when calling InventoriesApi.book_inventory_list"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/book'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_id.to_s)).sub('{' + 'inventoryListId' + '}', CGI.escape(inventory_list_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 => :"InventoriesApi.book_inventory_list",
    :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: InventoriesApi#book_inventory_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_inventory(korona_account_id, inventory_id, opts = {}) ⇒ nil

deletes the single inventory (only allowed if hasBookedReceipts=false)

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


256
257
258
259
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 256

def delete_inventory(, inventory_id, opts = {})
  delete_inventory_with_http_info(, inventory_id, opts)
  nil
end

#delete_inventory_list_item(korona_account_id, inventory_id, inventory_list_id, product_id, opts = {}) ⇒ nil

deletes the single inventory list item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

  • product_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


325
326
327
328
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 325

def delete_inventory_list_item(, inventory_id, inventory_list_id, product_id, opts = {})
  delete_inventory_list_item_with_http_info(, inventory_id, inventory_list_id, product_id, opts)
  nil
end

#delete_inventory_list_item_with_http_info(korona_account_id, inventory_id, inventory_list_id, product_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

deletes the single inventory list item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

  • 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



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
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 337

def delete_inventory_list_item_with_http_info(, inventory_id, inventory_list_id, product_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.delete_inventory_list_item ...'
  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 InventoriesApi.delete_inventory_list_item"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.delete_inventory_list_item"
  end
  # verify the required parameter 'inventory_list_id' is set
  if @api_client.config.client_side_validation && inventory_list_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id' when calling InventoriesApi.delete_inventory_list_item"
  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 InventoriesApi.delete_inventory_list_item"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/items/{productId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_id.to_s)).sub('{' + 'inventoryListId' + '}', CGI.escape(inventory_list_id.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 => :"InventoriesApi.delete_inventory_list_item",
    :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: InventoriesApi#delete_inventory_list_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_inventory_with_http_info(korona_account_id, inventory_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

deletes the single inventory (only allowed if hasBookedReceipts&#x3D;false)

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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



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
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 266

def delete_inventory_with_http_info(, inventory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.delete_inventory ...'
  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 InventoriesApi.delete_inventory"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.delete_inventory"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_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 => :"InventoriesApi.delete_inventory",
    :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: InventoriesApi#delete_inventory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inventories(korona_account_id, opts = {}) ⇒ ResultListInventory

lists all inventories

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)

  • :number (String) —

    number of the related object

Returns:



407
408
409
410
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 407

def get_inventories(, opts = {})
  data, _status_code, _headers = get_inventories_with_http_info(, opts)
  data
end

#get_inventories_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListInventory, Integer, Hash)>

lists all inventories

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)

  • :number (String) —

    number of the related object

Returns:

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

    ResultListInventory data, response status code and response headers



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
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 422

def get_inventories_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.get_inventories ...'
  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 InventoriesApi.get_inventories"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories'.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[:'number'] = opts[:'number'] if !opts[:'number'].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] || 'ResultListInventory'

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

  new_options = opts.merge(
    :operation => :"InventoriesApi.get_inventories",
    :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: InventoriesApi#get_inventories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inventory(korona_account_id, inventory_id, opts = {}) ⇒ Inventory

returns the single inventory

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

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

    the optional parameters

Returns:



481
482
483
484
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 481

def get_inventory(, inventory_id, opts = {})
  data, _status_code, _headers = get_inventory_with_http_info(, inventory_id, opts)
  data
end

#get_inventory_list(korona_account_id, inventory_id, inventory_list_id, opts = {}) ⇒ InventoryList

returns the single inventory list

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

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

    the optional parameters

Returns:



549
550
551
552
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 549

def get_inventory_list(, inventory_id, inventory_list_id, opts = {})
  data, _status_code, _headers = get_inventory_list_with_http_info(, inventory_id, inventory_list_id, opts)
  data
end

#get_inventory_list_item(korona_account_id, inventory_id, inventory_list_id, product_id, opts = {}) ⇒ InventoryListItem

returns the single inventory list item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

  • product_id (String) —

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

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

    the optional parameters

Returns:



623
624
625
626
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 623

def get_inventory_list_item(, inventory_id, inventory_list_id, product_id, opts = {})
  data, _status_code, _headers = get_inventory_list_item_with_http_info(, inventory_id, inventory_list_id, product_id, opts)
  data
end

#get_inventory_list_item_with_http_info(korona_account_id, inventory_id, inventory_list_id, product_id, opts = {}) ⇒ Array<(InventoryListItem, Integer, Hash)>

returns the single inventory list item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

  • product_id (String) —

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

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

    the optional parameters

Returns:

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

    InventoryListItem data, response status code and response headers



635
636
637
638
639
640
641
642
643
644
645
646
647
648
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
691
692
693
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 635

def get_inventory_list_item_with_http_info(, inventory_id, inventory_list_id, product_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.get_inventory_list_item ...'
  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 InventoriesApi.get_inventory_list_item"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.get_inventory_list_item"
  end
  # verify the required parameter 'inventory_list_id' is set
  if @api_client.config.client_side_validation && inventory_list_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id' when calling InventoriesApi.get_inventory_list_item"
  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 InventoriesApi.get_inventory_list_item"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/items/{productId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_id.to_s)).sub('{' + 'inventoryListId' + '}', CGI.escape(inventory_list_id.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] || 'InventoryListItem'

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

  new_options = opts.merge(
    :operation => :"InventoriesApi.get_inventory_list_item",
    :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: InventoriesApi#get_inventory_list_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inventory_list_items(korona_account_id, inventory_id, inventory_list_id, opts = {}) ⇒ ResultListInventoryListItem

lists all inventory list items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_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:



705
706
707
708
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 705

def get_inventory_list_items(, inventory_id, inventory_list_id, opts = {})
  data, _status_code, _headers = get_inventory_list_items_with_http_info(, inventory_id, inventory_list_id, opts)
  data
end

#get_inventory_list_items_with_http_info(korona_account_id, inventory_id, inventory_list_id, opts = {}) ⇒ Array<(ResultListInventoryListItem, Integer, Hash)>

lists all inventory list items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_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<(ResultListInventoryListItem, Integer, Hash)>) —

    ResultListInventoryListItem data, response status code and response headers



720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 720

def get_inventory_list_items_with_http_info(, inventory_id, inventory_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.get_inventory_list_items ...'
  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 InventoriesApi.get_inventory_list_items"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.get_inventory_list_items"
  end
  # verify the required parameter 'inventory_list_id' is set
  if @api_client.config.client_side_validation && inventory_list_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id' when calling InventoriesApi.get_inventory_list_items"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/items'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_id.to_s)).sub('{' + 'inventoryListId' + '}', CGI.escape(inventory_list_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] || 'ResultListInventoryListItem'

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

  new_options = opts.merge(
    :operation => :"InventoriesApi.get_inventory_list_items",
    :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: InventoriesApi#get_inventory_list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inventory_list_with_http_info(korona_account_id, inventory_id, inventory_list_id, opts = {}) ⇒ Array<(InventoryList, Integer, Hash)>

returns the single inventory list

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

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

    the optional parameters

Returns:

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

    InventoryList data, response status code and response headers



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
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
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 560

def get_inventory_list_with_http_info(, inventory_id, inventory_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.get_inventory_list ...'
  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 InventoriesApi.get_inventory_list"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.get_inventory_list"
  end
  # verify the required parameter 'inventory_list_id' is set
  if @api_client.config.client_side_validation && inventory_list_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id' when calling InventoriesApi.get_inventory_list"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_id.to_s)).sub('{' + 'inventoryListId' + '}', CGI.escape(inventory_list_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] || 'InventoryList'

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

  new_options = opts.merge(
    :operation => :"InventoriesApi.get_inventory_list",
    :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: InventoriesApi#get_inventory_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inventory_lists(korona_account_id, inventory_id, opts = {}) ⇒ ResultListInventoryList

lists all inventory lists

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

  • :include_deleted (Boolean) —

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

  • :min_create_time (Time) —

    min (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :max_create_time (Time) —

    max (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :min_booking_time (Time) —

    min (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :max_booking_time (Time) —

    max (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :booking_status (String) —

    booking status (possible values: BOOKED, IN_PROGRESS)

  • :number (String) —

    number of the related object

Returns:



796
797
798
799
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 796

def get_inventory_lists(, inventory_id, opts = {})
  data, _status_code, _headers = get_inventory_lists_with_http_info(, inventory_id, opts)
  data
end

#get_inventory_lists_with_http_info(korona_account_id, inventory_id, opts = {}) ⇒ Array<(ResultListInventoryList, Integer, Hash)>

lists all inventory lists

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

  • :include_deleted (Boolean) —

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

  • :min_create_time (Time) —

    min (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :max_create_time (Time) —

    max (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :min_booking_time (Time) —

    min (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :max_booking_time (Time) —

    max (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :booking_status (String) —

    booking status (possible values: BOOKED, IN_PROGRESS)

  • :number (String) —

    number of the related object

Returns:

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

    ResultListInventoryList data, response status code and response headers



817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 817

def get_inventory_lists_with_http_info(, inventory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.get_inventory_lists ...'
  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 InventoriesApi.get_inventory_lists"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.get_inventory_lists"
  end
  allowable_values = ["BOOKED", "IN_PROGRESS"]
  if @api_client.config.client_side_validation && opts[:'booking_status'] && !allowable_values.include?(opts[:'booking_status'])
    fail ArgumentError, "invalid value for \"booking_status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_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?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
  query_params[:'minCreateTime'] = opts[:'min_create_time'] if !opts[:'min_create_time'].nil?
  query_params[:'maxCreateTime'] = opts[:'max_create_time'] if !opts[:'max_create_time'].nil?
  query_params[:'minBookingTime'] = opts[:'min_booking_time'] if !opts[:'min_booking_time'].nil?
  query_params[:'maxBookingTime'] = opts[:'max_booking_time'] if !opts[:'max_booking_time'].nil?
  query_params[:'bookingStatus'] = opts[:'booking_status'] if !opts[:'booking_status'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].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] || 'ResultListInventoryList'

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

  new_options = opts.merge(
    :operation => :"InventoriesApi.get_inventory_lists",
    :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: InventoriesApi#get_inventory_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inventory_with_http_info(korona_account_id, inventory_id, opts = {}) ⇒ Array<(Inventory, Integer, Hash)>

returns the single inventory

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

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

    the optional parameters

Returns:

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

    Inventory data, response status code and response headers



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 491

def get_inventory_with_http_info(, inventory_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.get_inventory ...'
  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 InventoriesApi.get_inventory"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.get_inventory"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_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] || 'Inventory'

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

  new_options = opts.merge(
    :operation => :"InventoriesApi.get_inventory",
    :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: InventoriesApi#get_inventory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_inventory(korona_account_id, inventory_id, body, opts = {}) ⇒ nil

updates the single inventory

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • body (Inventory) —

    the properties to update of the inventory

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

    the optional parameters

Returns:

  • (nil) 


890
891
892
893
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 890

def update_inventory(, inventory_id, body, opts = {})
  update_inventory_with_http_info(, inventory_id, body, opts)
  nil
end

#update_inventory_list(korona_account_id, inventory_id, inventory_list_id, body, opts = {}) ⇒ nil

updates the single inventory list

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

  • body (InventoryList) —

    data to update

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

    the optional parameters

Returns:

  • (nil) 


969
970
971
972
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 969

def update_inventory_list(, inventory_id, inventory_list_id, body, opts = {})
  update_inventory_list_with_http_info(, inventory_id, inventory_list_id, body, opts)
  nil
end

#update_inventory_list_item(korona_account_id, inventory_id, inventory_list_id, product_id, body, opts = {}) ⇒ nil

updates the single inventory list item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

  • product_id (String) —

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

  • body (InventoryListItem) —

    data to update

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

    the optional parameters

Returns:

  • (nil) 


1054
1055
1056
1057
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 1054

def update_inventory_list_item(, inventory_id, inventory_list_id, product_id, body, opts = {})
  update_inventory_list_item_with_http_info(, inventory_id, inventory_list_id, product_id, body, opts)
  nil
end

#update_inventory_list_item_with_http_info(korona_account_id, inventory_id, inventory_list_id, product_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates the single inventory list item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

  • product_id (String) —

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

  • body (InventoryListItem) —

    data to update

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 1067

def update_inventory_list_item_with_http_info(, inventory_id, inventory_list_id, product_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.update_inventory_list_item ...'
  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 InventoriesApi.update_inventory_list_item"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.update_inventory_list_item"
  end
  # verify the required parameter 'inventory_list_id' is set
  if @api_client.config.client_side_validation && inventory_list_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id' when calling InventoriesApi.update_inventory_list_item"
  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 InventoriesApi.update_inventory_list_item"
  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 InventoriesApi.update_inventory_list_item"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/items/{productId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_id.to_s)).sub('{' + 'inventoryListId' + '}', CGI.escape(inventory_list_id.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'])
  # 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 => :"InventoriesApi.update_inventory_list_item",
    :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: InventoriesApi#update_inventory_list_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_inventory_list_items(korona_account_id, inventory_id, inventory_list_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

updates inventory list items (property [product] required))

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

  • body (Array<InventoryListItem>) —

    an array of inventory list items to update

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

    the optional parameters

Returns:



1143
1144
1145
1146
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 1143

def update_inventory_list_items(, inventory_id, inventory_list_id, body, opts = {})
  data, _status_code, _headers = update_inventory_list_items_with_http_info(, inventory_id, inventory_list_id, body, opts)
  data
end

#update_inventory_list_items_with_http_info(korona_account_id, inventory_id, inventory_list_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

updates inventory list items (property [product] required))

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

  • body (Array<InventoryListItem>) —

    an array of inventory list items to update

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

    the optional parameters

Returns:

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

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



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 1155

def update_inventory_list_items_with_http_info(, inventory_id, inventory_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.update_inventory_list_items ...'
  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 InventoriesApi.update_inventory_list_items"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.update_inventory_list_items"
  end
  # verify the required parameter 'inventory_list_id' is set
  if @api_client.config.client_side_validation && inventory_list_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id' when calling InventoriesApi.update_inventory_list_items"
  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 InventoriesApi.update_inventory_list_items"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/items'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_id.to_s)).sub('{' + 'inventoryListId' + '}', CGI.escape(inventory_list_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'])
  # 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 => :"InventoriesApi.update_inventory_list_items",
    :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: InventoriesApi#update_inventory_list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_inventory_list_with_http_info(korona_account_id, inventory_id, inventory_list_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates the single inventory list

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • inventory_list_id (String) —

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

  • body (InventoryList) —

    data to update

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 981

def update_inventory_list_with_http_info(, inventory_id, inventory_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.update_inventory_list ...'
  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 InventoriesApi.update_inventory_list"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.update_inventory_list"
  end
  # verify the required parameter 'inventory_list_id' is set
  if @api_client.config.client_side_validation && inventory_list_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id' when calling InventoriesApi.update_inventory_list"
  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 InventoriesApi.update_inventory_list"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_id.to_s)).sub('{' + 'inventoryListId' + '}', CGI.escape(inventory_list_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'])
  # 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 => :"InventoriesApi.update_inventory_list",
    :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: InventoriesApi#update_inventory_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_inventory_with_http_info(korona_account_id, inventory_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates the single inventory

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • inventory_id (String) —

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

  • body (Inventory) —

    the properties to update of the inventory

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'lib/korona-cloud-client/api/inventories_api.rb', line 901

def update_inventory_with_http_info(, inventory_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InventoriesApi.update_inventory ...'
  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 InventoriesApi.update_inventory"
  end
  # verify the required parameter 'inventory_id' is set
  if @api_client.config.client_side_validation && inventory_id.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id' when calling InventoriesApi.update_inventory"
  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 InventoriesApi.update_inventory"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/inventories/{inventoryId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'inventoryId' + '}', CGI.escape(inventory_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'])
  # 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 => :"InventoriesApi.update_inventory",
    :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: InventoriesApi#update_inventory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end