Class: KoronaClient::PointsOfSaleApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona_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_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_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 —

    account id of the KORONA.cloud account

  • point_of_sale_id —

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

  • coupling_id —

    the coupling-id of the device

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

    the optional parameters

Options Hash (opts):

Returns:



30
31
32
33
 
# File 'lib/korona_client/api/points_of_sale_api.rb', line 30

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>, Fixnum, Hash)>

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

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • point_of_sale_id —

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

  • coupling_id —

    the coupling-id of the device

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

    the optional parameters

Options Hash (opts):

Returns:

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

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



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

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' + '}', .to_s).sub('{' + 'pointOfSaleId' + '}', point_of_sale_id.to_s)

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

  # 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(opts[:'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: 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 —

    account id of the KORONA.cloud account

  • point_of_sale_id —

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

  • coupling_id —

    the coupling-id of the device

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Receipt>) —

    the receipts to add

Returns:



99
100
101
102
 
# File 'lib/korona_client/api/points_of_sale_api.rb', line 99

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>, Fixnum, Hash)>

adds a batch of point of sale-related receipts

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • point_of_sale_id —

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

  • coupling_id —

    the coupling-id of the device

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Receipt>) —

    the receipts to add

Returns:

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

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



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

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' + '}', .to_s).sub('{' + 'pointOfSaleId' + '}', point_of_sale_id.to_s)

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

  # 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(opts[:'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: PointsOfSaleApi#add_point_of_sale_receipts\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 —

    account id of the KORONA.cloud account

  • point_of_sale_id —

    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:



167
168
169
170
 
# File 'lib/korona_client/api/points_of_sale_api.rb', line 167

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_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 —

    account id of the KORONA.cloud account

  • point_of_sale_id —

    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

Returns:



234
235
236
237
 
# File 'lib/korona_client/api/points_of_sale_api.rb', line 234

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, Fixnum, Hash)>

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

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • point_of_sale_id —

    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

Returns:



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

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' + '}', .to_s).sub('{' + 'pointOfSaleId' + '}', point_of_sale_id.to_s)

  # query parameters
  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?

  # 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 => 'ResultListEndOfDayStatement')
  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 —

    account id of the KORONA.cloud account

  • point_of_sale_id —

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

  • receipt_id —

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

Returns:



306
307
308
309
 
# File 'lib/korona_client/api/points_of_sale_api.rb', line 306

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, Fixnum, Hash)>

returns the single point of sale-related receipt

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • point_of_sale_id —

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

  • receipt_id —

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

Returns:

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

    Receipt data, response status code and response headers



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/korona_client/api/points_of_sale_api.rb', line 319

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' + '}', .to_s).sub('{' + 'pointOfSaleId' + '}', point_of_sale_id.to_s).sub('{' + 'receiptId' + '}', receipt_id.to_s)

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

    account id of the KORONA.cloud account

  • point_of_sale_id —

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

  • :number (String) —

    number of the related object

  • :min_booking_time (DateTime) —

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

  • :max_booking_time (DateTime) —

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

Returns:



384
385
386
387
 
# File 'lib/korona_client/api/points_of_sale_api.rb', line 384

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, Fixnum, Hash)>

lists all point of sale-related receipts

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • point_of_sale_id —

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

  • :number (String) —

    number of the related object

  • :min_booking_time (DateTime) —

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

  • :max_booking_time (DateTime) —

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

Returns:

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

    ResultListReceipt data, response status code and response headers



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

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' + '}', .to_s).sub('{' + 'pointOfSaleId' + '}', point_of_sale_id.to_s)

  # query parameters
  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?

  # 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 => 'ResultListReceipt')
  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, Fixnum, Hash)>

returns the single point of sale

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • point_of_sale_id —

    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, Fixnum, Hash)>) —

    Pos data, response status code and response headers



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

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' + '}', .to_s).sub('{' + 'pointOfSaleId' + '}', point_of_sale_id.to_s)

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

    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:



473
474
475
476
 
# File 'lib/korona_client/api/points_of_sale_api.rb', line 473

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, Fixnum, Hash)>

lists all points of sale

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)

  • :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, Fixnum, Hash)>) —

    ResultListPos data, response status code and response headers



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/korona_client/api/points_of_sale_api.rb', line 491

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' + '}', .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[:'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 = {}
  # 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 => 'ResultListPos')
  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 a point of sale (works only for coupling (attribute ‘couplingId’) or updating device information (attribute ‘deviceInformation’))

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • point_of_sale_id —

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

  • body —

    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) 


547
548
549
550
 
# File 'lib/korona_client/api/points_of_sale_api.rb', line 547

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, Fixnum, Hash)>

updates a point of sale (works only for coupling (attribute &#39;couplingId&#39;) or updating device information (attribute &#39;deviceInformation&#39;))

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • point_of_sale_id —

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

  • body —

    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, Fixnum, Hash)>) —

    nil, response status code and response headers



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/korona_client/api/points_of_sale_api.rb', line 561

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' + '}', .to_s).sub('{' + 'pointOfSaleId' + '}', point_of_sale_id.to_s)

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