Class: WhiteLabelMachineName::PaymentTerminalTillService

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentTerminalTillService

Returns a new instance of PaymentTerminalTillService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_till_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_till_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#perform_transaction(space_id, transaction_id, terminal_id, opts = {}) ⇒ Transaction

Perform Payment Terminal Transaction Starts a payment terminal transaction and waits for its completion. If the call returns with a long polling timeout status, you may try again. The processing of the transaction will be picked up where it was left off.

Parameters:

  • space_id
  • transaction_id —

    The ID of the transaction which is used to process with the terminal.

  • terminal_id —

    The ID of the terminal which should be used to process the transaction.

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

    the optional parameters

Options Hash (opts):

  • :language (String) —

    The language in which the messages should be rendered in.

Returns:



36
37
38
39
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_till_service_api.rb', line 36

def perform_transaction(space_id, transaction_id, terminal_id, opts = {})
  data, _status_code, _headers = perform_transaction_with_http_info(space_id, transaction_id, terminal_id, opts)
  return data
end

#perform_transaction_by_identifier(space_id, transaction_id, terminal_identifier, opts = {}) ⇒ Transaction

Perform Payment Terminal Transaction (using TID) Starts a payment terminal transaction and waits for its completion. If the call returns with a long polling timeout status, you may try again. The processing of the transaction will be picked up where it was left off.

Parameters:

  • space_id
  • transaction_id —

    The ID of the transaction which is used to process with the terminal.

  • terminal_identifier —

    The identifier (aka TID) of the terminal which should be used to process the transaction.

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

    the optional parameters

Options Hash (opts):

  • :language (String) —

    The language in which the messages should be rendered in.

Returns:



107
108
109
110
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_till_service_api.rb', line 107

def perform_transaction_by_identifier(space_id, transaction_id, terminal_identifier, opts = {})
  data, _status_code, _headers = perform_transaction_by_identifier_with_http_info(space_id, transaction_id, terminal_identifier, opts)
  return data
end

#perform_transaction_by_identifier_with_http_info(space_id, transaction_id, terminal_identifier, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Perform Payment Terminal Transaction (using TID) Starts a payment terminal transaction and waits for its completion. If the call returns with a long polling timeout status, you may try again. The processing of the transaction will be picked up where it was left off.

Parameters:

  • space_id
  • transaction_id —

    The ID of the transaction which is used to process with the terminal.

  • terminal_identifier —

    The identifier (aka TID) of the terminal which should be used to process the transaction.

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

    the optional parameters

Options Hash (opts):

  • :language (String) —

    The language in which the messages should be rendered in.

Returns:

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

    Transaction data, response status code and response headers



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
164
165
166
167
168
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/payment_terminal_till_service_api.rb', line 120

def perform_transaction_by_identifier_with_http_info(space_id, transaction_id, terminal_identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentTerminalTillService.perform_transaction_by_identifier ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling PaymentTerminalTillService.perform_transaction_by_identifier" if space_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PaymentTerminalTillService.perform_transaction_by_identifier" if transaction_id.nil?
  # verify the required parameter 'terminal_identifier' is set
  fail ArgumentError, "Missing the required parameter 'terminal_identifier' when calling PaymentTerminalTillService.perform_transaction_by_identifier" if terminal_identifier.nil?
  # resource path
  local_var_path = "/payment-terminal-till/perform-transaction-by-identifier".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'transactionId'] = transaction_id
  query_params[:'terminalIdentifier'] = terminal_identifier
  query_params[:'language'] = opts[:'language'] if !opts[:'language'].nil?

  # 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 => 'Transaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentTerminalTillService#perform_transaction_by_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#perform_transaction_with_http_info(space_id, transaction_id, terminal_id, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Perform Payment Terminal Transaction Starts a payment terminal transaction and waits for its completion. If the call returns with a long polling timeout status, you may try again. The processing of the transaction will be picked up where it was left off.

Parameters:

  • space_id
  • transaction_id —

    The ID of the transaction which is used to process with the terminal.

  • terminal_id —

    The ID of the terminal which should be used to process the transaction.

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

    the optional parameters

Options Hash (opts):

  • :language (String) —

    The language in which the messages should be rendered in.

Returns:

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

    Transaction data, response status code and response headers



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

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

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'transactionId'] = transaction_id
  query_params[:'terminalId'] = terminal_id
  query_params[:'language'] = opts[:'language'] if !opts[:'language'].nil?

  # 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 => 'Transaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentTerminalTillService#perform_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end