Class: KoronaCloudClient::ReceiptsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReceiptsApi

Returns a new instance of ReceiptsApi.



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

def api_client
  @api_client
end

Instance Method Details

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

returns the single receipt

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • receipt_id (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :voided_items (Boolean) —

    when set to true, voided items will included in response

Returns:



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

def get_receipt(, receipt_id, opts = {})
  data, _status_code, _headers = get_receipt_with_http_info(, receipt_id, opts)
  data
end

#get_receipt_item(korona_account_id, receipt_id, receipt_item_id, opts = {}) ⇒ ReceiptItem

returns the single receipt item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • receipt_id (String) —

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

  • receipt_item_id (String) —

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

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

    the optional parameters

Returns:



98
99
100
101
 
# File 'lib/korona-cloud-client/api/receipts_api.rb', line 98

def get_receipt_item(, receipt_id, receipt_item_id, opts = {})
  data, _status_code, _headers = get_receipt_item_with_http_info(, receipt_id, receipt_item_id, opts)
  data
end

#get_receipt_item_with_http_info(korona_account_id, receipt_id, receipt_item_id, opts = {}) ⇒ Array<(ReceiptItem, Integer, Hash)>

returns the single receipt item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • receipt_id (String) —

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

  • receipt_item_id (String) —

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

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

    the optional parameters

Returns:

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

    ReceiptItem data, response status code and response headers



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

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

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"ReceiptsApi.get_receipt_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReceiptsApi#get_receipt_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

returns the single receipt

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • receipt_id (String) —

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

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

    the optional parameters

Options Hash (opts):

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



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

def get_receipt_with_http_info(, receipt_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceiptsApi.get_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 ReceiptsApi.get_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 ReceiptsApi.get_receipt"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/receipts/{receiptId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'receiptId' + '}', CGI.escape(receipt_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  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 => :"ReceiptsApi.get_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: ReceiptsApi#get_receipt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_receipts(korona_account_id, opts = {}) ⇒ ResultListReceipt

lists all receipts

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

  • :point_of_sale (String) —

    point of sale

  • :organizational_unit (String) —

    organizational unit

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



183
184
185
186
 
# File 'lib/korona-cloud-client/api/receipts_api.rb', line 183

def get_receipts(, opts = {})
  data, _status_code, _headers = get_receipts_with_http_info(, opts)
  data
end

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

lists all receipts

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

  • :point_of_sale (String) —

    point of sale

  • :organizational_unit (String) —

    organizational unit

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



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
261
262
263
264
265
266
 
# File 'lib/korona-cloud-client/api/receipts_api.rb', line 206

def get_receipts_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReceiptsApi.get_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 ReceiptsApi.get_receipts"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/receipts'.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[:'pointOfSale'] = opts[:'point_of_sale'] if !opts[:'point_of_sale'].nil?
  query_params[:'organizationalUnit'] = opts[:'organizational_unit'] if !opts[:'organizational_unit'].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 => :"ReceiptsApi.get_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: ReceiptsApi#get_receipts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end