Class: KoronaCloudClient::StoreOrdersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StoreOrdersApi

Returns a new instance of StoreOrdersApi.



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

def api_client
  @api_client
end

Instance Method Details

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

adds store order items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • store_order_id (String) —

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

  • body (Array<StoreOrderItem>) —

    data to add

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

    the optional parameters

Returns:



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

def add_store_order_items(, store_order_id, body, opts = {})
  data, _status_code, _headers = add_store_order_items_with_http_info(, store_order_id, body, opts)
  data
end

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

adds store order items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • store_order_id (String) —

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

  • body (Array<StoreOrderItem>) —

    data to add

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

    the optional parameters

Returns:

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

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



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
93
94
95
96
97
98
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 39

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

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

adds store orders

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<StoreOrder>) —

    data to add

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

    the optional parameters

Returns:



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

def add_store_orders(, body, opts = {})
  data, _status_code, _headers = add_store_orders_with_http_info(, body, opts)
  data
end

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

adds store orders

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<StoreOrder>) —

    data to add

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

    the optional parameters

Returns:

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

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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 115

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

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

deletes the single store order item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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


178
179
180
181
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 178

def delete_store_order_item(, store_order_id, product_id, opts = {})
  delete_store_order_item_with_http_info(, store_order_id, product_id, opts)
  nil
end

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

deletes the single store order item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 189

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

#get_store_order(korona_account_id, store_order_id, opts = {}) ⇒ StoreOrder

returns a single store order

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • store_order_id (String) —

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

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

    the optional parameters

Returns:



250
251
252
253
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 250

def get_store_order(, store_order_id, opts = {})
  data, _status_code, _headers = get_store_order_with_http_info(, store_order_id, opts)
  data
end

#get_store_order_item(korona_account_id, store_order_id, product_id, opts = {}) ⇒ StoreOrderItem

returns the single store order item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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



318
319
320
321
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 318

def get_store_order_item(, store_order_id, product_id, opts = {})
  data, _status_code, _headers = get_store_order_item_with_http_info(, store_order_id, product_id, opts)
  data
end

#get_store_order_item_with_http_info(korona_account_id, store_order_id, product_id, opts = {}) ⇒ Array<(StoreOrderItem, Integer, Hash)>

returns the single store order item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • store_order_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<(StoreOrderItem, Integer, Hash)>) —

    StoreOrderItem data, response status code and response headers



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

def get_store_order_item_with_http_info(, store_order_id, product_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StoreOrdersApi.get_store_order_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 StoreOrdersApi.get_store_order_item"
  end
  # verify the required parameter 'store_order_id' is set
  if @api_client.config.client_side_validation && store_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_order_id' when calling StoreOrdersApi.get_store_order_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 StoreOrdersApi.get_store_order_item"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/storeOrders/{storeOrderId}/items/{productId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'storeOrderId' + '}', CGI.escape(store_order_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] || 'StoreOrderItem'

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

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

#get_store_order_items(korona_account_id, store_order_id, opts = {}) ⇒ ResultListStoreOrderItem

lists all store order items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

Returns:



393
394
395
396
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 393

def get_store_order_items(, store_order_id, opts = {})
  data, _status_code, _headers = get_store_order_items_with_http_info(, store_order_id, opts)
  data
end

#get_store_order_items_with_http_info(korona_account_id, store_order_id, opts = {}) ⇒ Array<(ResultListStoreOrderItem, Integer, Hash)>

lists all store order items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

Returns:

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

    ResultListStoreOrderItem data, response status code and response headers



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 406

def get_store_order_items_with_http_info(, store_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StoreOrdersApi.get_store_order_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 StoreOrdersApi.get_store_order_items"
  end
  # verify the required parameter 'store_order_id' is set
  if @api_client.config.client_side_validation && store_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_order_id' when calling StoreOrdersApi.get_store_order_items"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/storeOrders/{storeOrderId}/items'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'storeOrderId' + '}', CGI.escape(store_order_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?

  # 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] || 'ResultListStoreOrderItem'

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

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

#get_store_order_with_http_info(korona_account_id, store_order_id, opts = {}) ⇒ Array<(StoreOrder, Integer, Hash)>

returns a single store order

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • store_order_id (String) —

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

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

    the optional parameters

Returns:

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

    StoreOrder data, response status code and response headers



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 260

def get_store_order_with_http_info(, store_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StoreOrdersApi.get_store_order ...'
  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 StoreOrdersApi.get_store_order"
  end
  # verify the required parameter 'store_order_id' is set
  if @api_client.config.client_side_validation && store_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_order_id' when calling StoreOrdersApi.get_store_order"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/storeOrders/{storeOrderId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'storeOrderId' + '}', CGI.escape(store_order_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] || 'StoreOrder'

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

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

#get_store_orders(korona_account_id, opts = {}) ⇒ ResultListStoreOrder

lists all store orders

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)

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

  • :target_organizational_unit (String) —

    target organizational unit

  • :min_finish_time (Time) —

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

  • :max_finish_time (Time) —

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

  • :min_pick_up_time (Time) —

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

  • :max_pick_up_time (Time) —

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

  • :number (String) —

    number of the related object

Returns:



478
479
480
481
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 478

def get_store_orders(, opts = {})
  data, _status_code, _headers = get_store_orders_with_http_info(, opts)
  data
end

#get_store_orders_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListStoreOrder, Integer, Hash)>

lists all store orders

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)

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

  • :target_organizational_unit (String) —

    target organizational unit

  • :min_finish_time (Time) —

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

  • :max_finish_time (Time) —

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

  • :min_pick_up_time (Time) —

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

  • :max_pick_up_time (Time) —

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

  • :number (String) —

    number of the related object

Returns:

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

    ResultListStoreOrder data, response status code and response headers



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 500

def get_store_orders_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StoreOrdersApi.get_store_orders ...'
  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 StoreOrdersApi.get_store_orders"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/storeOrders'.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[:'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[:'targetOrganizationalUnit'] = opts[:'target_organizational_unit'] if !opts[:'target_organizational_unit'].nil?
  query_params[:'minFinishTime'] = opts[:'min_finish_time'] if !opts[:'min_finish_time'].nil?
  query_params[:'maxFinishTime'] = opts[:'max_finish_time'] if !opts[:'max_finish_time'].nil?
  query_params[:'minPickUpTime'] = opts[:'min_pick_up_time'] if !opts[:'min_pick_up_time'].nil?
  query_params[:'maxPickUpTime'] = opts[:'max_pick_up_time'] if !opts[:'max_pick_up_time'].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] || 'ResultListStoreOrder'

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

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

#order_store_order(korona_account_id, store_order_id, order_action, opts = {}) ⇒ nil

orders and finalizes the store order

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • store_order_id (String) —

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

  • order_action (String) —

    type of order finalization. according to items speficiations (either each item must have a source, or those without are ignored and deleted) or regardless of items specifications (joint supplier or warehouse)

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

    the optional parameters

Options Hash (opts):

  • :warehouse (String) —

    warehouse (&#x3D; organizational unit having warehouse flag)

  • :supplier (String) —

    supplier

Returns:

  • (nil) 


569
570
571
572
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 569

def order_store_order(, store_order_id, order_action, opts = {})
  order_store_order_with_http_info(, store_order_id, order_action, opts)
  nil
end

#order_store_order_with_http_info(korona_account_id, store_order_id, order_action, opts = {}) ⇒ Array<(nil, Integer, Hash)>

orders and finalizes the store order

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • store_order_id (String) —

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

  • order_action (String) —

    type of order finalization. according to items speficiations (either each item must have a source, or those without are ignored and deleted) or regardless of items specifications (joint supplier or warehouse)

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

    the optional parameters

Options Hash (opts):

  • :warehouse (String) —

    warehouse (&#x3D; organizational unit having warehouse flag)

  • :supplier (String) —

    supplier

Returns:

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

    nil, response status code and response headers



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 582

def order_store_order_with_http_info(, store_order_id, order_action, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StoreOrdersApi.order_store_order ...'
  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 StoreOrdersApi.order_store_order"
  end
  # verify the required parameter 'store_order_id' is set
  if @api_client.config.client_side_validation && store_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_order_id' when calling StoreOrdersApi.order_store_order"
  end
  # verify the required parameter 'order_action' is set
  if @api_client.config.client_side_validation && order_action.nil?
    fail ArgumentError, "Missing the required parameter 'order_action' when calling StoreOrdersApi.order_store_order"
  end
  # verify enum value
  allowable_values = ["ACCORDING_TO_SPECIFICATIONS", "ACCORDING_TO_SPECIFICATIONS_IGNORE_AND_DELETE", "REGARDLESS_OF_SPECIFICATIONS_AT_JOINT_FROM_SUPPLIER", "REGARDLESS_OF_SPECIFICATIONS_AT_JOINT_FROM_WAREHOUSE"]
  if @api_client.config.client_side_validation && !allowable_values.include?(order_action)
    fail ArgumentError, "invalid value for \"order_action\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/storeOrders/{storeOrderId}/order'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'storeOrderId' + '}', CGI.escape(store_order_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'orderAction'] = order_action
  query_params[:'warehouse'] = opts[:'warehouse'] if !opts[:'warehouse'].nil?
  query_params[:'supplier'] = opts[:'supplier'] if !opts[:'supplier'].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]

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

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

#update_store_order(korona_account_id, store_order_id, body, opts = {}) ⇒ nil

updates the single store order

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • store_order_id (String) —

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

  • body (StoreOrder) —

    data to update

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

    the optional parameters

Returns:

  • (nil) 


652
653
654
655
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 652

def update_store_order(, store_order_id, body, opts = {})
  update_store_order_with_http_info(, store_order_id, body, opts)
  nil
end

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

updates the single store order item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

    data to update

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

    the optional parameters

Returns:

  • (nil) 


731
732
733
734
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 731

def update_store_order_item(, store_order_id, product_id, body, opts = {})
  update_store_order_item_with_http_info(, store_order_id, product_id, body, opts)
  nil
end

#update_store_order_item_with_http_info(korona_account_id, store_order_id, product_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates the single store order item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

    data to update

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 743

def update_store_order_item_with_http_info(, store_order_id, product_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StoreOrdersApi.update_store_order_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 StoreOrdersApi.update_store_order_item"
  end
  # verify the required parameter 'store_order_id' is set
  if @api_client.config.client_side_validation && store_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_order_id' when calling StoreOrdersApi.update_store_order_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 StoreOrdersApi.update_store_order_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 StoreOrdersApi.update_store_order_item"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/storeOrders/{storeOrderId}/items/{productId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'storeOrderId' + '}', CGI.escape(store_order_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 => :"StoreOrdersApi.update_store_order_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: StoreOrdersApi#update_store_order_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

updates store order items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • store_order_id (String) —

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

  • body (Array<StoreOrderItem>) —

    data to update

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

    the optional parameters

Returns:



814
815
816
817
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 814

def update_store_order_items(, store_order_id, body, opts = {})
  data, _status_code, _headers = update_store_order_items_with_http_info(, store_order_id, body, opts)
  data
end

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

updates store order items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • store_order_id (String) —

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

  • body (Array<StoreOrderItem>) —

    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



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
883
884
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 825

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

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

updates the single store order

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • store_order_id (String) —

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

  • body (StoreOrder) —

    data to update

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
 
# File 'lib/korona-cloud-client/api/store_orders_api.rb', line 663

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