Class: KoronaClient::InventoriesKORONARetailApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InventoriesKORONARetailApi

Returns a new instance of InventoriesKORONARetailApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/korona_client/api/inventories_korona_retail_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 —

    the account id

  • body —

    a array of new inventories

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

    the optional parameters

Returns:



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

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

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

adds a batch of new inventories

Parameters:

  • korona_account_id —

    the account id

  • body —

    a array of new inventories

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

    the optional parameters

Returns:

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

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



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
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 40

def add_inventories_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InventoriesKORONARetailApi.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 InventoriesKORONARetailApi.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 InventoriesKORONARetailApi.add_inventories"
  end
  # resource path
  local_var_path = "/accounts/{koronaAccountId}/inventories".sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#add_inventories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_inventory_inventory_list_items(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, body, opts = {}) ⇒ Array<AddOrUpdateResult>

adds inventory list items

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • body —

    data to update

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

    the optional parameters

Returns:



92
93
94
95
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 92

def add_inventory_inventory_list_items(, inventory_id_or_number, inventory_list_id_or_number, body, opts = {})
  data, _status_code, _headers = add_inventory_inventory_list_items_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, body, opts)
  return data
end

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

adds inventory list items

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • body —

    data to update

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

    the optional parameters

Returns:

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

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 105

def add_inventory_inventory_list_items_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InventoriesKORONARetailApi.add_inventory_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 InventoriesKORONARetailApi.add_inventory_inventory_list_items"
  end
  # verify the required parameter 'inventory_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id_or_number' when calling InventoriesKORONARetailApi.add_inventory_inventory_list_items"
  end
  # verify the required parameter 'inventory_list_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_list_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id_or_number' when calling InventoriesKORONARetailApi.add_inventory_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 InventoriesKORONARetailApi.add_inventory_inventory_list_items"
  end
  # resource path
  local_var_path = "/accounts/{koronaAccountId}/inventories/{inventoryIdOrNumber}/inventoryLists/{inventoryListIdOrNumber}/items".sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'inventoryIdOrNumber' + '}', inventory_id_or_number.to_s).sub('{' + 'inventoryListIdOrNumber' + '}', inventory_list_id_or_number.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#add_inventory_inventory_list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

deletes the inventory; only possible if hasBookedReceipts=false

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

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

    the optional parameters

Returns:

  • (nil) 


163
164
165
166
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 163

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

#delete_inventory_inventory_list_item(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, opts = {}) ⇒ nil

deletes the inventory list item

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • product_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

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

    the optional parameters

Returns:

  • (nil) 


225
226
227
228
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 225

def delete_inventory_inventory_list_item(, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, opts = {})
  delete_inventory_inventory_list_item_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, opts)
  return nil
end

#delete_inventory_inventory_list_item_with_http_info(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

deletes the inventory list item

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • product_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 238

def delete_inventory_inventory_list_item_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InventoriesKORONARetailApi.delete_inventory_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 InventoriesKORONARetailApi.delete_inventory_inventory_list_item"
  end
  # verify the required parameter 'inventory_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id_or_number' when calling InventoriesKORONARetailApi.delete_inventory_inventory_list_item"
  end
  # verify the required parameter 'inventory_list_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_list_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id_or_number' when calling InventoriesKORONARetailApi.delete_inventory_inventory_list_item"
  end
  # verify the required parameter 'product_id_or_number' is set
  if @api_client.config.client_side_validation && product_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'product_id_or_number' when calling InventoriesKORONARetailApi.delete_inventory_inventory_list_item"
  end
  # resource path
  local_var_path = "/accounts/{koronaAccountId}/inventories/{inventoryIdOrNumber}/inventoryLists/{inventoryListIdOrNumber}/items/{productIdOrNumber}".sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'inventoryIdOrNumber' + '}', inventory_id_or_number.to_s).sub('{' + 'inventoryListIdOrNumber' + '}', inventory_list_id_or_number.to_s).sub('{' + 'productIdOrNumber' + '}', product_id_or_number.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#delete_inventory_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_or_number, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

deletes the inventory; only possible if hasBookedReceipts&#x3D;false

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 174

def delete_inventory_with_http_info(, inventory_id_or_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InventoriesKORONARetailApi.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 InventoriesKORONARetailApi.delete_inventory"
  end
  # verify the required parameter 'inventory_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id_or_number' when calling InventoriesKORONARetailApi.delete_inventory"
  end
  # resource path
  local_var_path = "/accounts/{koronaAccountId}/inventories/{inventoryIdOrNumber}".sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'inventoryIdOrNumber' + '}', inventory_id_or_number.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#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 —

    the account id

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

Returns:



299
300
301
302
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 299

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

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

lists all inventories

Parameters:

  • korona_account_id —

    the account id

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

Returns:

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

    ResultListInventory data, response status code and response headers



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 314

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

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResultListInventory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#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_or_number, opts = {}) ⇒ Inventory

lists the inventory

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

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

    the optional parameters

Returns:



365
366
367
368
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 365

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

#get_inventory_inventory_list(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, opts = {}) ⇒ InventoryList

lists the inventory list

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

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

    the optional parameters

Returns:



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

def get_inventory_inventory_list(, inventory_id_or_number, inventory_list_id_or_number, opts = {})
  data, _status_code, _headers = get_inventory_inventory_list_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, opts)
  return data
end

#get_inventory_inventory_list_item(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, opts = {}) ⇒ InventoryListItem

lists the inventory list item with the specified product

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • product_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

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

    the optional parameters

Returns:



495
496
497
498
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 495

def get_inventory_inventory_list_item(, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, opts = {})
  data, _status_code, _headers = get_inventory_inventory_list_item_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, opts)
  return data
end

#get_inventory_inventory_list_item_with_http_info(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, opts = {}) ⇒ Array<(InventoryListItem, Fixnum, Hash)>

lists the inventory list item with the specified product

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • product_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

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

    the optional parameters

Returns:

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

    InventoryListItem data, response status code and response headers



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
551
552
553
554
555
556
557
558
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 508

def get_inventory_inventory_list_item_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InventoriesKORONARetailApi.get_inventory_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 InventoriesKORONARetailApi.get_inventory_inventory_list_item"
  end
  # verify the required parameter 'inventory_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id_or_number' when calling InventoriesKORONARetailApi.get_inventory_inventory_list_item"
  end
  # verify the required parameter 'inventory_list_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_list_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id_or_number' when calling InventoriesKORONARetailApi.get_inventory_inventory_list_item"
  end
  # verify the required parameter 'product_id_or_number' is set
  if @api_client.config.client_side_validation && product_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'product_id_or_number' when calling InventoriesKORONARetailApi.get_inventory_inventory_list_item"
  end
  # resource path
  local_var_path = "/accounts/{koronaAccountId}/inventories/{inventoryIdOrNumber}/inventoryLists/{inventoryListIdOrNumber}/items/{productIdOrNumber}".sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'inventoryIdOrNumber' + '}', inventory_id_or_number.to_s).sub('{' + 'inventoryListIdOrNumber' + '}', inventory_list_id_or_number.to_s).sub('{' + 'productIdOrNumber' + '}', product_id_or_number.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InventoryListItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#get_inventory_inventory_list_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inventory_inventory_list_items(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, opts = {}) ⇒ ResultListInventoryListItem

lists all inventory list items

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

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



571
572
573
574
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 571

def get_inventory_inventory_list_items(, inventory_id_or_number, inventory_list_id_or_number, opts = {})
  data, _status_code, _headers = get_inventory_inventory_list_items_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, opts)
  return data
end

#get_inventory_inventory_list_items_with_http_info(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, opts = {}) ⇒ Array<(ResultListInventoryListItem, Fixnum, Hash)>

lists all inventory list items

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

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



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
634
635
636
637
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 587

def get_inventory_inventory_list_items_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InventoriesKORONARetailApi.get_inventory_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 InventoriesKORONARetailApi.get_inventory_inventory_list_items"
  end
  # verify the required parameter 'inventory_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id_or_number' when calling InventoriesKORONARetailApi.get_inventory_inventory_list_items"
  end
  # verify the required parameter 'inventory_list_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_list_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id_or_number' when calling InventoriesKORONARetailApi.get_inventory_inventory_list_items"
  end
  # resource path
  local_var_path = "/accounts/{koronaAccountId}/inventories/{inventoryIdOrNumber}/inventoryLists/{inventoryListIdOrNumber}/items".sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'inventoryIdOrNumber' + '}', inventory_id_or_number.to_s).sub('{' + 'inventoryListIdOrNumber' + '}', inventory_list_id_or_number.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResultListInventoryListItem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#get_inventory_inventory_list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inventory_inventory_list_with_http_info(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, opts = {}) ⇒ Array<(InventoryList, Fixnum, Hash)>

lists the inventory list

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

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

    the optional parameters

Returns:

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

    InventoryList data, response status code and response headers



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

def get_inventory_inventory_list_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InventoriesKORONARetailApi.get_inventory_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 InventoriesKORONARetailApi.get_inventory_inventory_list"
  end
  # verify the required parameter 'inventory_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id_or_number' when calling InventoriesKORONARetailApi.get_inventory_inventory_list"
  end
  # verify the required parameter 'inventory_list_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_list_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id_or_number' when calling InventoriesKORONARetailApi.get_inventory_inventory_list"
  end
  # resource path
  local_var_path = "/accounts/{koronaAccountId}/inventories/{inventoryIdOrNumber}/inventoryLists/{inventoryListIdOrNumber}".sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'inventoryIdOrNumber' + '}', inventory_id_or_number.to_s).sub('{' + 'inventoryListIdOrNumber' + '}', inventory_list_id_or_number.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InventoryList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#get_inventory_inventory_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inventory_inventory_lists(korona_account_id, inventory_id_or_number, opts = {}) ⇒ ResultListInventoryList

lists all inventory lists

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • 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 (DateTime) —

    min (inclusive) create time of the receipt (ISO 8601; date, time and timezone)

  • :max_create_time (DateTime) —

    max (inclusive) create time of the receipt (ISO 8601; date, time and timezone)

  • :min_booking_time (DateTime) —

    min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)

  • :max_booking_time (DateTime) —

    max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)

  • :booking_status (String) —

    booking status (possible values: BOOKED, IN_PROGRESS)

Returns:



655
656
657
658
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 655

def get_inventory_inventory_lists(, inventory_id_or_number, opts = {})
  data, _status_code, _headers = get_inventory_inventory_lists_with_http_info(, inventory_id_or_number, opts)
  return data
end

#get_inventory_inventory_lists_with_http_info(korona_account_id, inventory_id_or_number, opts = {}) ⇒ Array<(ResultListInventoryList, Fixnum, Hash)>

lists all inventory lists

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • 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 (DateTime) —

    min (inclusive) create time of the receipt (ISO 8601; date, time and timezone)

  • :max_create_time (DateTime) —

    max (inclusive) create time of the receipt (ISO 8601; date, time and timezone)

  • :min_booking_time (DateTime) —

    min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)

  • :max_booking_time (DateTime) —

    max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)

  • :booking_status (String) —

    booking status (possible values: BOOKED, IN_PROGRESS)

Returns:

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

    ResultListInventoryList data, response status code and response headers



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
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 676

def get_inventory_inventory_lists_with_http_info(, inventory_id_or_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InventoriesKORONARetailApi.get_inventory_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 InventoriesKORONARetailApi.get_inventory_inventory_lists"
  end
  # verify the required parameter 'inventory_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id_or_number' when calling InventoriesKORONARetailApi.get_inventory_inventory_lists"
  end
  if @api_client.config.client_side_validation && opts[:'booking_status'] && !['BOOKED', 'IN_PROGRESS'].include?(opts[:'booking_status'])
    fail ArgumentError, 'invalid value for "booking_status", must be one of BOOKED, IN_PROGRESS'
  end
  # resource path
  local_var_path = "/accounts/{koronaAccountId}/inventories/{inventoryIdOrNumber}/inventoryLists".sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'inventoryIdOrNumber' + '}', inventory_id_or_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
  query_params[:'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?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResultListInventoryList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#get_inventory_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_or_number, opts = {}) ⇒ Array<(Inventory, Fixnum, Hash)>

lists the inventory

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

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

    the optional parameters

Returns:

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

    Inventory data, response status code and response headers



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Inventory')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#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_or_number, body, opts = {}) ⇒ nil

changes the inventory

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • body —

    the properties to update of the inventory

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

    the optional parameters

Returns:

  • (nil) 


740
741
742
743
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 740

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

#update_inventory_inventory_list(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, body, opts = {}) ⇒ nil

updates the inventory list

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • body —

    data to update

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

    the optional parameters

Returns:

  • (nil) 


807
808
809
810
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 807

def update_inventory_inventory_list(, inventory_id_or_number, inventory_list_id_or_number, body, opts = {})
  update_inventory_inventory_list_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, body, opts)
  return nil
end

#update_inventory_inventory_list_item(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, body, opts = {}) ⇒ nil

updates the inventory list item

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • product_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • body —

    data to update

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

    the optional parameters

Returns:

  • (nil) 


880
881
882
883
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 880

def update_inventory_inventory_list_item(, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, body, opts = {})
  update_inventory_inventory_list_item_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, body, opts)
  return nil
end

#update_inventory_inventory_list_item_with_http_info(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

updates the inventory list item

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • product_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • body —

    data to update

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



894
895
896
897
898
899
900
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
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 894

def update_inventory_inventory_list_item_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, product_id_or_number, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InventoriesKORONARetailApi.update_inventory_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 InventoriesKORONARetailApi.update_inventory_inventory_list_item"
  end
  # verify the required parameter 'inventory_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id_or_number' when calling InventoriesKORONARetailApi.update_inventory_inventory_list_item"
  end
  # verify the required parameter 'inventory_list_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_list_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id_or_number' when calling InventoriesKORONARetailApi.update_inventory_inventory_list_item"
  end
  # verify the required parameter 'product_id_or_number' is set
  if @api_client.config.client_side_validation && product_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'product_id_or_number' when calling InventoriesKORONARetailApi.update_inventory_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 InventoriesKORONARetailApi.update_inventory_inventory_list_item"
  end
  # resource path
  local_var_path = "/accounts/{koronaAccountId}/inventories/{inventoryIdOrNumber}/inventoryLists/{inventoryListIdOrNumber}/items/{productIdOrNumber}".sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'inventoryIdOrNumber' + '}', inventory_id_or_number.to_s).sub('{' + 'inventoryListIdOrNumber' + '}', inventory_list_id_or_number.to_s).sub('{' + 'productIdOrNumber' + '}', product_id_or_number.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#update_inventory_inventory_list_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_inventory_inventory_list_items(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, body, opts = {}) ⇒ Array<AddOrUpdateResult>

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

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • body —

    a array of inventory list items to update

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

    the optional parameters

Returns:



957
958
959
960
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 957

def update_inventory_inventory_list_items(, inventory_id_or_number, inventory_list_id_or_number, body, opts = {})
  data, _status_code, _headers = update_inventory_inventory_list_items_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, body, opts)
  return data
end

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

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

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • body —

    a array of inventory list items to update

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

    the optional parameters

Returns:

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

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



970
971
972
973
974
975
976
977
978
979
980
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
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 970

def update_inventory_inventory_list_items_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InventoriesKORONARetailApi.update_inventory_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 InventoriesKORONARetailApi.update_inventory_inventory_list_items"
  end
  # verify the required parameter 'inventory_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id_or_number' when calling InventoriesKORONARetailApi.update_inventory_inventory_list_items"
  end
  # verify the required parameter 'inventory_list_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_list_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id_or_number' when calling InventoriesKORONARetailApi.update_inventory_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 InventoriesKORONARetailApi.update_inventory_inventory_list_items"
  end
  # resource path
  local_var_path = "/accounts/{koronaAccountId}/inventories/{inventoryIdOrNumber}/inventoryLists/{inventoryListIdOrNumber}/items".sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'inventoryIdOrNumber' + '}', inventory_id_or_number.to_s).sub('{' + 'inventoryListIdOrNumber' + '}', inventory_list_id_or_number.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#update_inventory_inventory_list_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_inventory_inventory_list_with_http_info(korona_account_id, inventory_id_or_number, inventory_list_id_or_number, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

updates the inventory list

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • inventory_list_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • body —

    data to update

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 820

def update_inventory_inventory_list_with_http_info(, inventory_id_or_number, inventory_list_id_or_number, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InventoriesKORONARetailApi.update_inventory_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 InventoriesKORONARetailApi.update_inventory_inventory_list"
  end
  # verify the required parameter 'inventory_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id_or_number' when calling InventoriesKORONARetailApi.update_inventory_inventory_list"
  end
  # verify the required parameter 'inventory_list_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_list_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_list_id_or_number' when calling InventoriesKORONARetailApi.update_inventory_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 InventoriesKORONARetailApi.update_inventory_inventory_list"
  end
  # resource path
  local_var_path = "/accounts/{koronaAccountId}/inventories/{inventoryIdOrNumber}/inventoryLists/{inventoryListIdOrNumber}".sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'inventoryIdOrNumber' + '}', inventory_id_or_number.to_s).sub('{' + 'inventoryListIdOrNumber' + '}', inventory_list_id_or_number.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#update_inventory_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_or_number, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

changes the inventory

Parameters:

  • korona_account_id —

    the account id

  • inventory_id_or_number —

    id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)

  • body —

    the properties to update of the inventory

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
 
# File 'lib/korona_client/api/inventories_korona_retail_api.rb', line 752

def update_inventory_with_http_info(, inventory_id_or_number, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InventoriesKORONARetailApi.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 InventoriesKORONARetailApi.update_inventory"
  end
  # verify the required parameter 'inventory_id_or_number' is set
  if @api_client.config.client_side_validation && inventory_id_or_number.nil?
    fail ArgumentError, "Missing the required parameter 'inventory_id_or_number' when calling InventoriesKORONARetailApi.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 InventoriesKORONARetailApi.update_inventory"
  end
  # resource path
  local_var_path = "/accounts/{koronaAccountId}/inventories/{inventoryIdOrNumber}".sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'inventoryIdOrNumber' + '}', inventory_id_or_number.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InventoriesKORONARetailApi#update_inventory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end