Class: KoronaCloudClient::StockOrdersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StockOrdersApi

Returns a new instance of StockOrdersApi.



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

def api_client
  @api_client
end

Instance Method Details

#book_stock_order(korona_account_id, stock_order_id, opts = {}) ⇒ nil

book the single stock order

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • stock_order_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


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

def book_stock_order(, stock_order_id, opts = {})
  book_stock_order_with_http_info(, stock_order_id, opts)
  nil
end

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

book the single stock order

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/korona-cloud-client/api/stock_orders_api.rb', line 37

def book_stock_order_with_http_info(, stock_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StockOrdersApi.book_stock_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 StockOrdersApi.book_stock_order"
  end
  # verify the required parameter 'stock_order_id' is set
  if @api_client.config.client_side_validation && stock_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'stock_order_id' when calling StockOrdersApi.book_stock_order"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/stockOrders/{stockOrderId}/book'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'stockOrderId' + '}', CGI.escape(stock_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]

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

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

#finalize_stock_order(korona_account_id, stock_order_id, opts = {}) ⇒ nil

finalize the single stock order

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • stock_order_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


94
95
96
97
 
# File 'lib/korona-cloud-client/api/stock_orders_api.rb', line 94

def finalize_stock_order(, stock_order_id, opts = {})
  finalize_stock_order_with_http_info(, stock_order_id, opts)
  nil
end

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

finalize the single stock order

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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



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

def finalize_stock_order_with_http_info(, stock_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StockOrdersApi.finalize_stock_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 StockOrdersApi.finalize_stock_order"
  end
  # verify the required parameter 'stock_order_id' is set
  if @api_client.config.client_side_validation && stock_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'stock_order_id' when calling StockOrdersApi.finalize_stock_order"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/stockOrders/{stockOrderId}/finalize'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'stockOrderId' + '}', CGI.escape(stock_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]

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

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

#get_stock_order(korona_account_id, stock_order_id, opts = {}) ⇒ StockOrder

returns a single stock order

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

  • :include_items (Boolean) —

    include items of receipt (default: true; setting to false improves performance)

Returns:



162
163
164
165
 
# File 'lib/korona-cloud-client/api/stock_orders_api.rb', line 162

def get_stock_order(, stock_order_id, opts = {})
  data, _status_code, _headers = get_stock_order_with_http_info(, stock_order_id, opts)
  data
end

#get_stock_order_items(korona_account_id, stock_order_id, opts = {}) ⇒ ResultListStockOrderItem

lists all stock order items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

  • :revision (Integer) —

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

Returns:



235
236
237
238
 
# File 'lib/korona-cloud-client/api/stock_orders_api.rb', line 235

def get_stock_order_items(, stock_order_id, opts = {})
  data, _status_code, _headers = get_stock_order_items_with_http_info(, stock_order_id, opts)
  data
end

#get_stock_order_items_with_http_info(korona_account_id, stock_order_id, opts = {}) ⇒ Array<(ResultListStockOrderItem, Integer, Hash)>

lists all stock order items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

  • :revision (Integer) —

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

Returns:

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

    ResultListStockOrderItem data, response status code and response headers



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

def get_stock_order_items_with_http_info(, stock_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StockOrdersApi.get_stock_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 StockOrdersApi.get_stock_order_items"
  end
  # verify the required parameter 'stock_order_id' is set
  if @api_client.config.client_side_validation && stock_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'stock_order_id' when calling StockOrdersApi.get_stock_order_items"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/stockOrders/{stockOrderId}/items'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'stockOrderId' + '}', CGI.escape(stock_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?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?

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

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

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

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

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

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

#get_stock_order_with_http_info(korona_account_id, stock_order_id, opts = {}) ⇒ Array<(StockOrder, Integer, Hash)>

returns a single stock order

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

  • :include_items (Boolean) —

    include items of receipt (default: true; setting to false improves performance)

Returns:

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

    StockOrder data, response status code and response headers



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/korona-cloud-client/api/stock_orders_api.rb', line 173

def get_stock_order_with_http_info(, stock_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StockOrdersApi.get_stock_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 StockOrdersApi.get_stock_order"
  end
  # verify the required parameter 'stock_order_id' is set
  if @api_client.config.client_side_validation && stock_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'stock_order_id' when calling StockOrdersApi.get_stock_order"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/stockOrders/{stockOrderId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'stockOrderId' + '}', CGI.escape(stock_order_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'includeItems'] = opts[:'include_items'] if !opts[:'include_items'].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] || 'StockOrder'

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

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

#get_stock_orders(korona_account_id, opts = {}) ⇒ ResultListStockOrder

lists all stock 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)

  • :min_booking_time (Time) —

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

  • :max_booking_time (Time) —

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

  • :organizational_unit (String) —

    organizational unit

  • :source_organizational_unit (String) —

    source organizational unit

  • :booking_status (String) —

    booking status (possible values: BOOKED, IN_PROGRESS)

  • :number (String) —

    number of the related object

  • :finalized (Boolean) —

    load only objects with this finalized status

  • :include_items (Boolean) —

    include items of receipt (default: true; setting to false improves performance)

Returns:



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

def get_stock_orders(, opts = {})
  data, _status_code, _headers = get_stock_orders_with_http_info(, opts)
  data
end

#get_stock_orders_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListStockOrder, Integer, Hash)>

lists all stock 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)

  • :min_booking_time (Time) —

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

  • :max_booking_time (Time) —

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

  • :organizational_unit (String) —

    organizational unit

  • :source_organizational_unit (String) —

    source organizational unit

  • :booking_status (String) —

    booking status (possible values: BOOKED, IN_PROGRESS)

  • :number (String) —

    number of the related object

  • :finalized (Boolean) —

    load only objects with this finalized status

  • :include_items (Boolean) —

    include items of receipt (default: true; setting to false improves performance)

Returns:

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

    ResultListStockOrder data, response status code and response headers



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/korona-cloud-client/api/stock_orders_api.rb', line 348

def get_stock_orders_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StockOrdersApi.get_stock_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 StockOrdersApi.get_stock_orders"
  end
  allowable_values = ["BOOKED", "IN_PROGRESS"]
  if @api_client.config.client_side_validation && opts[:'booking_status'] && !allowable_values.include?(opts[:'booking_status'])
    fail ArgumentError, "invalid value for \"booking_status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/stockOrders'.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[:'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[:'organizationalUnit'] = opts[:'organizational_unit'] if !opts[:'organizational_unit'].nil?
  query_params[:'sourceOrganizationalUnit'] = opts[:'source_organizational_unit'] if !opts[:'source_organizational_unit'].nil?
  query_params[:'bookingStatus'] = opts[:'booking_status'] if !opts[:'booking_status'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?
  query_params[:'finalized'] = opts[:'finalized'] if !opts[:'finalized'].nil?
  query_params[:'includeItems'] = opts[:'include_items'] if !opts[:'include_items'].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] || 'ResultListStockOrder'

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

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