Class: KoronaCloudClient::PointsOfSaleApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PointsOfSaleApi

Returns a new instance of PointsOfSaleApi.



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

def api_client
  @api_client
end

Instance Method Details

#add_point_of_sale_end_of_day_statements(korona_account_id, point_of_sale_id, coupling_id, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of point of sale-related end-of-day-statements

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

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

  • coupling_id (String) —

    the coupling-id of the device

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

    the optional parameters

Options Hash (opts):

Returns:



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

def add_point_of_sale_end_of_day_statements(, point_of_sale_id, coupling_id, opts = {})
  data, _status_code, _headers = add_point_of_sale_end_of_day_statements_with_http_info(, point_of_sale_id, coupling_id, opts)
  data
end

#add_point_of_sale_end_of_day_statements_with_http_info(korona_account_id, point_of_sale_id, coupling_id, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

adds a batch of point of sale-related end-of-day-statements

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

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

  • coupling_id (String) —

    the coupling-id of the device

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

    the optional parameters

Options Hash (opts):

Returns:

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

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



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
99
100
101
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 41

def add_point_of_sale_end_of_day_statements_with_http_info(, point_of_sale_id, coupling_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PointsOfSaleApi.add_point_of_sale_end_of_day_statements ...'
  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 PointsOfSaleApi.add_point_of_sale_end_of_day_statements"
  end
  # verify the required parameter 'point_of_sale_id' is set
  if @api_client.config.client_side_validation && point_of_sale_id.nil?
    fail ArgumentError, "Missing the required parameter 'point_of_sale_id' when calling PointsOfSaleApi.add_point_of_sale_end_of_day_statements"
  end
  # verify the required parameter 'coupling_id' is set
  if @api_client.config.client_side_validation && coupling_id.nil?
    fail ArgumentError, "Missing the required parameter 'coupling_id' when calling PointsOfSaleApi.add_point_of_sale_end_of_day_statements"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/pointsOfSale/{pointOfSaleId}/endOfDayStatements'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'pointOfSaleId' + '}', CGI.escape(point_of_sale_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'couplingId'] = coupling_id

  # 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(opts[:'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 => :"PointsOfSaleApi.add_point_of_sale_end_of_day_statements",
    :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: PointsOfSaleApi#add_point_of_sale_end_of_day_statements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_point_of_sale_receipts(korona_account_id, point_of_sale_id, coupling_id, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of point of sale-related receipts

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

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

  • coupling_id (String) —

    the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).

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

    the optional parameters

Options Hash (opts):

  • :disable_receipt_number_prefix (Boolean) —

    prevents setting a prefix at the receipt number

  • :body (Array<Receipt>) —

    the receipts to add

Returns:



111
112
113
114
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 111

def add_point_of_sale_receipts(, point_of_sale_id, coupling_id, opts = {})
  data, _status_code, _headers = add_point_of_sale_receipts_with_http_info(, point_of_sale_id, coupling_id, opts)
  data
end

#add_point_of_sale_receipts_with_http_info(korona_account_id, point_of_sale_id, coupling_id, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

adds a batch of point of sale-related receipts

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

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

  • coupling_id (String) —

    the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).

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

    the optional parameters

Options Hash (opts):

  • :disable_receipt_number_prefix (Boolean) —

    prevents setting a prefix at the receipt number

  • :body (Array<Receipt>) —

    the receipts to add

Returns:

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

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 124

def add_point_of_sale_receipts_with_http_info(, point_of_sale_id, coupling_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PointsOfSaleApi.add_point_of_sale_receipts ...'
  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 PointsOfSaleApi.add_point_of_sale_receipts"
  end
  # verify the required parameter 'point_of_sale_id' is set
  if @api_client.config.client_side_validation && point_of_sale_id.nil?
    fail ArgumentError, "Missing the required parameter 'point_of_sale_id' when calling PointsOfSaleApi.add_point_of_sale_receipts"
  end
  # verify the required parameter 'coupling_id' is set
  if @api_client.config.client_side_validation && coupling_id.nil?
    fail ArgumentError, "Missing the required parameter 'coupling_id' when calling PointsOfSaleApi.add_point_of_sale_receipts"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/pointsOfSale/{pointOfSaleId}/receipts'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'pointOfSaleId' + '}', CGI.escape(point_of_sale_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'couplingId'] = coupling_id
  query_params[:'disableReceiptNumberPrefix'] = opts[:'disable_receipt_number_prefix'] if !opts[:'disable_receipt_number_prefix'].nil?

  # 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(opts[:'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 => :"PointsOfSaleApi.add_point_of_sale_receipts",
    :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: PointsOfSaleApi#add_point_of_sale_receipts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

adds a batch of new points of sale

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<Pos>) —

    array of new points of sale

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

    the optional parameters

Options Hash (opts):

  • :upsert (Boolean) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:



193
194
195
196
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 193

def add_points_of_sale(, body, opts = {})
  data, _status_code, _headers = add_points_of_sale_with_http_info(, body, opts)
  data
end

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

adds a batch of new points of sale

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<Pos>) —

    array of new points of sale

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

    the optional parameters

Options Hash (opts):

  • :upsert (Boolean) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:

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

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 204

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].nil?

  # 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 => :"PointsOfSaleApi.add_points_of_sale",
    :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: PointsOfSaleApi#add_points_of_sale\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_point_of_sale(korona_account_id, point_of_sale_id, opts = {}) ⇒ Pos

returns the single point of sale

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

    the number of the point of sale

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

    the optional parameters

Options Hash (opts):

  • :coupling_id (String) —

    the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).

Returns:



268
269
270
271
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 268

def get_point_of_sale(, point_of_sale_id, opts = {})
  data, _status_code, _headers = get_point_of_sale_with_http_info(, point_of_sale_id, opts)
  data
end

#get_point_of_sale_balances(korona_account_id, point_of_sale_id, opts = {}) ⇒ ResultListPosBalance

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

    point of sale

  • 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

  • :z_count (Integer) —

    z-count of the pos balance

  • :cashier (String) —

    cashier id to filter by

Returns:



342
343
344
345
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 342

def get_point_of_sale_balances(, point_of_sale_id, opts = {})
  data, _status_code, _headers = get_point_of_sale_balances_with_http_info(, point_of_sale_id, opts)
  data
end

#get_point_of_sale_balances_with_http_info(korona_account_id, point_of_sale_id, opts = {}) ⇒ Array<(ResultListPosBalance, Integer, Hash)>

Returns ResultListPosBalance data, response status code and response headers.

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

    point of sale

  • 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

  • :z_count (Integer) —

    z-count of the pos balance

  • :cashier (String) —

    cashier id to filter by

Returns:

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

    ResultListPosBalance data, response status code and response headers



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/points_of_sale_api.rb', line 357

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

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

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

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

#get_point_of_sale_end_of_day_statements(korona_account_id, point_of_sale_id, opts = {}) ⇒ ResultListEndOfDayStatement

lists all point of sale-related end-of-day-statements

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :coupling_id (String) —

    the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).

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

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

  • :z_count (Integer) —

    zCount

  • :revision (Integer) —

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

Returns:



428
429
430
431
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 428

def get_point_of_sale_end_of_day_statements(, point_of_sale_id, opts = {})
  data, _status_code, _headers = get_point_of_sale_end_of_day_statements_with_http_info(, point_of_sale_id, opts)
  data
end

#get_point_of_sale_end_of_day_statements_with_http_info(korona_account_id, point_of_sale_id, opts = {}) ⇒ Array<(ResultListEndOfDayStatement, Integer, Hash)>

lists all point of sale-related end-of-day-statements

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :coupling_id (String) —

    the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).

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

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

  • :z_count (Integer) —

    zCount

  • :revision (Integer) —

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

Returns:

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

    ResultListEndOfDayStatement data, response status code and response headers



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 446

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'couplingId'] = opts[:'coupling_id'] if !opts[:'coupling_id'].nil?
  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[:'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[:'zCount'] = opts[:'z_count'] if !opts[:'z_count'].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] || 'ResultListEndOfDayStatement'

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

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

#get_point_of_sale_receipt(korona_account_id, point_of_sale_id, receipt_id, opts = {}) ⇒ Receipt

returns the single point of sale-related receipt

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

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

  • receipt_id (String) —

    the id of the receipt

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

    the optional parameters

Options Hash (opts):

  • :coupling_id (String) —

    the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).

  • :voided_items (Boolean) —

    when set to true, voided items will included in response

Returns:



514
515
516
517
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 514

def get_point_of_sale_receipt(, point_of_sale_id, receipt_id, opts = {})
  data, _status_code, _headers = get_point_of_sale_receipt_with_http_info(, point_of_sale_id, receipt_id, opts)
  data
end

#get_point_of_sale_receipt_with_http_info(korona_account_id, point_of_sale_id, receipt_id, opts = {}) ⇒ Array<(Receipt, Integer, Hash)>

returns the single point of sale-related receipt

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

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

  • receipt_id (String) —

    the id of the receipt

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

    the optional parameters

Options Hash (opts):

  • :coupling_id (String) —

    the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).

  • :voided_items (Boolean) —

    when set to true, voided items will included in response

Returns:

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

    Receipt data, response status code and response headers



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

def get_point_of_sale_receipt_with_http_info(, point_of_sale_id, receipt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PointsOfSaleApi.get_point_of_sale_receipt ...'
  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 PointsOfSaleApi.get_point_of_sale_receipt"
  end
  # verify the required parameter 'point_of_sale_id' is set
  if @api_client.config.client_side_validation && point_of_sale_id.nil?
    fail ArgumentError, "Missing the required parameter 'point_of_sale_id' when calling PointsOfSaleApi.get_point_of_sale_receipt"
  end
  # verify the required parameter 'receipt_id' is set
  if @api_client.config.client_side_validation && receipt_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_id' when calling PointsOfSaleApi.get_point_of_sale_receipt"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/pointsOfSale/{pointOfSaleId}/receipts/{receiptId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'pointOfSaleId' + '}', CGI.escape(point_of_sale_id.to_s)).sub('{' + 'receiptId' + '}', CGI.escape(receipt_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'couplingId'] = opts[:'coupling_id'] if !opts[:'coupling_id'].nil?
  query_params[:'voidedItems'] = opts[:'voided_items'] if !opts[:'voided_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] || 'Receipt'

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

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

#get_point_of_sale_receipts(korona_account_id, point_of_sale_id, opts = {}) ⇒ ResultListReceipt

lists all point of sale-related receipts

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :coupling_id (String) —

    the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).

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

  • :z_count (Integer) —

    z-count of the receipt

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

  • :number (String) —

    number of the related object

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

  • :voided_items (Boolean) —

    when set to true, voided items will included in response

  • :order_number (String) —

    order number

Returns:



603
604
605
606
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 603

def get_point_of_sale_receipts(, point_of_sale_id, opts = {})
  data, _status_code, _headers = get_point_of_sale_receipts_with_http_info(, point_of_sale_id, opts)
  data
end

#get_point_of_sale_receipts_with_http_info(korona_account_id, point_of_sale_id, opts = {}) ⇒ Array<(ResultListReceipt, Integer, Hash)>

lists all point of sale-related receipts

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :coupling_id (String) —

    the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).

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

  • :z_count (Integer) —

    z-count of the receipt

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

  • :number (String) —

    number of the related object

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

  • :voided_items (Boolean) —

    when set to true, voided items will included in response

  • :order_number (String) —

    order number

Returns:

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

    ResultListReceipt data, response status code and response headers



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 626

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'couplingId'] = opts[:'coupling_id'] if !opts[:'coupling_id'].nil?
  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[:'zCount'] = opts[:'z_count'] if !opts[:'z_count'].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[:'number'] = opts[:'number'] if !opts[:'number'].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[:'voidedItems'] = opts[:'voided_items'] if !opts[:'voided_items'].nil?
  query_params[:'orderNumber'] = opts[:'order_number'] if !opts[:'order_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] || 'ResultListReceipt'

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

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

#get_point_of_sale_with_http_info(korona_account_id, point_of_sale_id, opts = {}) ⇒ Array<(Pos, Integer, Hash)>

returns the single point of sale

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

    the number of the point of sale

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

    the optional parameters

Options Hash (opts):

  • :coupling_id (String) —

    the coupling-id of the device. It can be set to check whether your coupling-id is correct or not (works only, if point of sale is external).

Returns:

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

    Pos data, response status code and response headers



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 279

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'couplingId'] = opts[:'coupling_id'] if !opts[:'coupling_id'].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] || 'Pos'

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

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

#get_points_of_sale(korona_account_id, opts = {}) ⇒ ResultListPos

lists all points of sale

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

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

  • :include_deleted (Boolean) —

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

  • :number (String) —

    number of the related object

  • :external (Boolean) —

    indicates external/internal devices should be loaded (default: null (load all))

  • :coupled (Boolean) —

    indicates coupled/not coupled devices should be loaded (default: null (load all))

Returns:



703
704
705
706
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 703

def get_points_of_sale(, opts = {})
  data, _status_code, _headers = get_points_of_sale_with_http_info(, opts)
  data
end

#get_points_of_sale_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListPos, Integer, Hash)>

lists all points of sale

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

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

  • :include_deleted (Boolean) —

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

  • :number (String) —

    number of the related object

  • :external (Boolean) —

    indicates external/internal devices should be loaded (default: null (load all))

  • :coupled (Boolean) —

    indicates coupled/not coupled devices should be loaded (default: null (load all))

Returns:

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

    ResultListPos data, response status code and response headers



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

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

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

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

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

#update_point_of_sale(korona_account_id, point_of_sale_id, body, opts = {}) ⇒ nil

updates the point of sale

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

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

  • body (Pos) —

    the properties to update of the point of sale (&#39;couplingId&#39; only)

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

    the optional parameters

Options Hash (opts):

  • :coupling_id (String) —

    the coupling-id of the device (required if already coupled)

  • :decouple (Boolean) —

    executes uncoupling, if set to true, device will be uncoupled if point of sale is already coupled

Returns:

  • (nil) 


784
785
786
787
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 784

def update_point_of_sale(, point_of_sale_id, body, opts = {})
  update_point_of_sale_with_http_info(, point_of_sale_id, body, opts)
  nil
end

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

updates the point of sale

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • point_of_sale_id (String) —

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

  • body (Pos) —

    the properties to update of the point of sale (&#39;couplingId&#39; only)

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

    the optional parameters

Options Hash (opts):

  • :coupling_id (String) —

    the coupling-id of the device (required if already coupled)

  • :decouple (Boolean) —

    executes uncoupling, if set to true, device will be uncoupled if point of sale is already coupled

Returns:

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

    nil, response status code and response headers



797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 797

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'couplingId'] = opts[:'coupling_id'] if !opts[:'coupling_id'].nil?
  query_params[:'decouple'] = opts[:'decouple'] if !opts[:'decouple'].nil?

  # 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 => :"PointsOfSaleApi.update_point_of_sale",
    :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: PointsOfSaleApi#update_point_of_sale\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

updates a batch of points of sale

number

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

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<Pos>) —

    an array of existing points of sale

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

    the optional parameters

Returns:



866
867
868
869
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 866

def update_points_of_sale(, body, opts = {})
  data, _status_code, _headers = update_points_of_sale_with_http_info(, body, opts)
  data
end

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

updates a batch of points of sale

number

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

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<Pos>) —

    an array of existing points of sale

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

    the optional parameters

Returns:

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

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



877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
 
# File 'lib/korona-cloud-client/api/points_of_sale_api.rb', line 877

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