Class: WhiteLabelMachineName::PaymentTerminalService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentTerminalService

Returns a new instance of PaymentTerminalService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 24

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#count(space_id, opts = {}) ⇒ Integer

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

  • (Integer) 


34
35
36
37
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 34

def count(space_id, opts = {})
  data, _status_code, _headers = count_with_http_info(space_id, opts)
  return data
end

#count_with_http_info(space_id, opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

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

    Integer data, response status code and response headers



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 45

def count_with_http_info(space_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentTerminalService.count ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalService.count" if space_id.nil?
  # resource path
  local_var_path = "/payment-terminal/count".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'filter'])
  auth_names = []
  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 => 'Integer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentTerminalService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#link(space_id, terminal_id, serial_number, opts = {}) ⇒ nil

Link Device With Terminal Links the device with given serial number with terminal.

Parameters:

  • space_id
  • terminal_id
  • serial_number
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 95

def link(space_id, terminal_id, serial_number, opts = {})
  link_with_http_info(space_id, terminal_id, serial_number, opts)
  return nil
end

#link_with_http_info(space_id, terminal_id, serial_number, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Link Device With Terminal Links the device with given serial number with terminal.

Parameters:

  • space_id
  • terminal_id
  • serial_number
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def link_with_http_info(space_id, terminal_id, serial_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentTerminalService.link ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalService.link" if space_id.nil?
  # verify the required parameter 'terminal_id' is set
  fail ArgumentError, "Missing the required parameter 'terminal_id' when calling PaymentTerminalService.link" if terminal_id.nil?
  # verify the required parameter 'serial_number' is set
  fail ArgumentError, "Missing the required parameter 'serial_number' when calling PaymentTerminalService.link" if serial_number.nil?
  # resource path
  local_var_path = "/payment-terminal/link".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'terminalId'] = terminal_id
  query_params[:'serialNumber'] = serial_number

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentTerminalService#link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(space_id, id, opts = {}) ⇒ PaymentTerminal

Read Reads the entity with the given ‘id’ and returns it.

Parameters:

  • space_id
  • id —

    The id of the payment terminal which should be returned.

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

    the optional parameters

Returns:



161
162
163
164
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 161

def read(space_id, id, opts = {})
  data, _status_code, _headers = read_with_http_info(space_id, id, opts)
  return data
end

#read_with_http_info(space_id, id, opts = {}) ⇒ Array<(PaymentTerminal, Fixnum, Hash)>

Read Reads the entity with the given &#39;id&#39; and returns it.

Parameters:

  • space_id
  • id —

    The id of the payment terminal which should be returned.

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

    the optional parameters

Returns:

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

    PaymentTerminal data, response status code and response headers



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 172

def read_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentTerminalService.read ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalService.read" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling PaymentTerminalService.read" if id.nil?
  # resource path
  local_var_path = "/payment-terminal/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'PaymentTerminal')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentTerminalService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(space_id, query, opts = {}) ⇒ Array<PaymentTerminal>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the payment terminals which are returned by the search.

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

    the optional parameters

Returns:



224
225
226
227
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 224

def search(space_id, query, opts = {})
  data, _status_code, _headers = search_with_http_info(space_id, query, opts)
  return data
end

#search_with_http_info(space_id, query, opts = {}) ⇒ Array<(Array<PaymentTerminal>, Fixnum, Hash)>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the payment terminals which are returned by the search.

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

    the optional parameters

Returns:

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

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



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
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 235

def search_with_http_info(space_id, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentTerminalService.search ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalService.search" if space_id.nil?
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling PaymentTerminalService.search" if query.nil?
  # resource path
  local_var_path = "/payment-terminal/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  auth_names = []
  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<PaymentTerminal>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentTerminalService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#trigger_final_balance(space_id, terminal_id, opts = {}) ⇒ nil

Remotely Trigger Final Balance Remotely triggers the final balance receipt on the terminal.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


286
287
288
289
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 286

def trigger_final_balance(space_id, terminal_id, opts = {})
  trigger_final_balance_with_http_info(space_id, terminal_id, opts)
  return nil
end

#trigger_final_balance_by_identifier(space_id, terminal_identifier, opts = {}) ⇒ nil

Remotely Trigger Final Balance By Identifier Remotely triggers the final balance receipt on the terminal by terminal identifier.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


348
349
350
351
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 348

def trigger_final_balance_by_identifier(space_id, terminal_identifier, opts = {})
  trigger_final_balance_by_identifier_with_http_info(space_id, terminal_identifier, opts)
  return nil
end

#trigger_final_balance_by_identifier_with_http_info(space_id, terminal_identifier, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Remotely Trigger Final Balance By Identifier Remotely triggers the final balance receipt on the terminal by terminal identifier.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 359

def trigger_final_balance_by_identifier_with_http_info(space_id, terminal_identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentTerminalService.trigger_final_balance_by_identifier ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalService.trigger_final_balance_by_identifier" if space_id.nil?
  # verify the required parameter 'terminal_identifier' is set
  fail ArgumentError, "Missing the required parameter 'terminal_identifier' when calling PaymentTerminalService.trigger_final_balance_by_identifier" if terminal_identifier.nil?
  # resource path
  local_var_path = "/payment-terminal/trigger-final-balance-by-identifier".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'terminalIdentifier'] = terminal_identifier

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentTerminalService#trigger_final_balance_by_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#trigger_final_balance_with_http_info(space_id, terminal_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Remotely Trigger Final Balance Remotely triggers the final balance receipt on the terminal.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 297

def trigger_final_balance_with_http_info(space_id, terminal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentTerminalService.trigger_final_balance ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalService.trigger_final_balance" if space_id.nil?
  # verify the required parameter 'terminal_id' is set
  fail ArgumentError, "Missing the required parameter 'terminal_id' when calling PaymentTerminalService.trigger_final_balance" if terminal_id.nil?
  # resource path
  local_var_path = "/payment-terminal/trigger-final-balance".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'terminalId'] = terminal_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentTerminalService#trigger_final_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unlink(space_id, terminal_id, opts = {}) ⇒ nil

Unlink Device With Terminal Unlinks the device from terminal.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


410
411
412
413
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 410

def unlink(space_id, terminal_id, opts = {})
  unlink_with_http_info(space_id, terminal_id, opts)
  return nil
end

#unlink_with_http_info(space_id, terminal_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Unlink Device With Terminal Unlinks the device from terminal.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
460
461
462
463
464
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_service_api.rb', line 421

def unlink_with_http_info(space_id, terminal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentTerminalService.unlink ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalService.unlink" if space_id.nil?
  # verify the required parameter 'terminal_id' is set
  fail ArgumentError, "Missing the required parameter 'terminal_id' when calling PaymentTerminalService.unlink" if terminal_id.nil?
  # resource path
  local_var_path = "/payment-terminal/unlink".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'terminalId'] = terminal_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = []
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentTerminalService#unlink\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end