Class: KoronaClient::CustomerOrdersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomerOrdersApi

Returns a new instance of CustomerOrdersApi.



19
20
21
 
# File 'lib/korona_client/api/customer_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_client/api/customer_orders_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

adds a batch of new customer orders

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of new customer orders

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/korona_client/api/customer_orders_api.rb', line 28

def add_customer_orders(, body, opts = {})
  data, _status_code, _headers = add_customer_orders_with_http_info(, body, opts)
  data
end

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

adds a batch of new customer orders

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of new customer orders

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

    the optional parameters

Returns:

  • (Array<(Array<AddOrUpdateResult>, Fixnum, 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
 
# File 'lib/korona_client/api/customer_orders_api.rb', line 39

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

#delete_customer_order(korona_account_id, customer_order_id, opts = {}) ⇒ nil

deletes the single customer order

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • customer_order_id —

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

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

    the optional parameters

Options Hash (opts):

  • :number (String) —

    number of the related object

Returns:

  • (nil) 


89
90
91
92
 
# File 'lib/korona_client/api/customer_orders_api.rb', line 89

def delete_customer_order(, customer_order_id, opts = {})
  delete_customer_order_with_http_info(, customer_order_id, opts)
  nil
end

#delete_customer_order_with_http_info(korona_account_id, customer_order_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

deletes the single customer order

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • customer_order_id —

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

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

    the optional parameters

Options Hash (opts):

  • :number (String) —

    number of the related object

Returns:

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

    nil, response status code and response headers



101
102
103
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
 
# File 'lib/korona_client/api/customer_orders_api.rb', line 101

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

  # query parameters
  query_params = {}
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].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(: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: CustomerOrdersApi#delete_customer_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer_order(korona_account_id, customer_order_id, opts = {}) ⇒ CustomerOrder

returns the single customer order

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • customer_order_id —

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

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

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/korona_client/api/customer_orders_api.rb', line 150

def get_customer_order(, customer_order_id, opts = {})
  data, _status_code, _headers = get_customer_order_with_http_info(, customer_order_id, opts)
  data
end

#get_customer_order_with_http_info(korona_account_id, customer_order_id, opts = {}) ⇒ Array<(CustomerOrder, Fixnum, Hash)>

returns the single customer order

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • customer_order_id —

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

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

    the optional parameters

Returns:

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

    CustomerOrder data, response status code and response headers



161
162
163
164
165
166
167
168
169
170
171
172
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
 
# File 'lib/korona_client/api/customer_orders_api.rb', line 161

def get_customer_order_with_http_info(, customer_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerOrdersApi.get_customer_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 CustomerOrdersApi.get_customer_order"
  end
  # verify the required parameter 'customer_order_id' is set
  if @api_client.config.client_side_validation && customer_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_order_id' when calling CustomerOrdersApi.get_customer_order"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/customerOrders/{customerOrderId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'customerOrderId' + '}', customer_order_id.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 => 'CustomerOrder')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerOrdersApi#get_customer_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer_orders(korona_account_id, opts = {}) ⇒ ResultListCustomerOrder

lists all customer orders

Parameters:

  • korona_account_id —

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

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

  • :max_pick_up_time (DateTime) —

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

  • :number (String) —

    number of the related object

Returns:



219
220
221
222
 
# File 'lib/korona_client/api/customer_orders_api.rb', line 219

def get_customer_orders(, opts = {})
  data, _status_code, _headers = get_customer_orders_with_http_info(, opts)
  data
end

#get_customer_orders_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListCustomerOrder, Fixnum, Hash)>

lists all customer orders

Parameters:

  • korona_account_id —

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

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

  • :max_pick_up_time (DateTime) —

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

  • :number (String) —

    number of the related object

Returns:

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

    ResultListCustomerOrder data, response status code and response headers



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/customer_orders_api.rb', line 239

def get_customer_orders_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerOrdersApi.get_customer_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 CustomerOrdersApi.get_customer_orders"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/customerOrders'.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?
  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[:'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 = {}
  # 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 => 'ResultListCustomerOrder')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerOrdersApi#get_customer_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_customer_order(korona_account_id, customer_order_id, body, opts = {}) ⇒ nil

updates the single customer order

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • customer_order_id —

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

  • body —

    the properties to update of the customer order

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

    the optional parameters

Returns:

  • (nil) 


295
296
297
298
 
# File 'lib/korona_client/api/customer_orders_api.rb', line 295

def update_customer_order(, customer_order_id, body, opts = {})
  update_customer_order_with_http_info(, customer_order_id, body, opts)
  nil
end

#update_customer_order_with_http_info(korona_account_id, customer_order_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

updates the single customer order

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • customer_order_id —

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

  • body —

    the properties to update of the customer order

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



307
308
309
310
311
312
313
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
 
# File 'lib/korona_client/api/customer_orders_api.rb', line 307

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

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

updates a batch of customer orders

number

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

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    an array of existing customer orders

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

    the optional parameters

Returns:



359
360
361
362
 
# File 'lib/korona_client/api/customer_orders_api.rb', line 359

def update_customer_orders(, body, opts = {})
  data, _status_code, _headers = update_customer_orders_with_http_info(, body, opts)
  data
end

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

updates a batch of customer orders

number

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

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    an array of existing customer orders

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

    the optional parameters

Returns:

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

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



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

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