Class: Conekta::TransactionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/conekta/api/transactions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransactionsApi

Returns a new instance of TransactionsApi.



19
20
21
 
# File 'lib/conekta/api/transactions_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/conekta/api/transactions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_transaction(id, opts = {}) ⇒ TransactionResponse

Get transaction Get the details of a transaction

Parameters:

  • id (String) —

    Identifier of the resource

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String) —

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:



29
30
31
32
 
# File 'lib/conekta/api/transactions_api.rb', line 29

def get_transaction(id, opts = {})
  data, _status_code, _headers = get_transaction_with_http_info(id, opts)
  data
end

#get_transaction_with_http_info(id, opts = {}) ⇒ Array<(TransactionResponse, Integer, Hash)>

Get transaction Get the details of a transaction

Parameters:

  • id (String) —

    Identifier of the resource

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String) —

    In the case of a holding company, the company id of the child company to which will process the request.

Returns:

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

    TransactionResponse 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
 
# File 'lib/conekta/api/transactions_api.rb', line 41

def get_transaction_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsApi.get_transaction ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling TransactionsApi.get_transaction"
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/transactions/{id}'.sub('{' + 'id' + '}', CGI.escape(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/vnd.conekta-v2.1.0+json'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil?

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

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

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

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

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

#get_transactions(opts = {}) ⇒ GetTransactionsResponse

Get List transactions Get transaction details in the form of a list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String) —

    In the case of a holding company, the company id of the child company to which will process the request.

  • :limit (Integer) —

    The numbers of items to return, the maximum value is 250 (default to 20)

  • :_next (String) —

    next page

  • :previous (String) —

    previous page

  • :id (String) —

    id of the object to be retrieved

  • :charge_id (String) —

    id of the charge used for filtering

  • :type (String) —

    type of the object to be retrieved

  • :currency (String) —

    currency of the object to be retrieved

Returns:



108
109
110
111
 
# File 'lib/conekta/api/transactions_api.rb', line 108

def get_transactions(opts = {})
  data, _status_code, _headers = get_transactions_with_http_info(opts)
  data
end

#get_transactions_with_http_info(opts = {}) ⇒ Array<(GetTransactionsResponse, Integer, Hash)>

Get List transactions Get transaction details in the form of a list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Use for knowing which language to use (default to ‘es’)

  • :x_child_company_id (String) —

    In the case of a holding company, the company id of the child company to which will process the request.

  • :limit (Integer) —

    The numbers of items to return, the maximum value is 250 (default to 20)

  • :_next (String) —

    next page

  • :previous (String) —

    previous page

  • :id (String) —

    id of the object to be retrieved

  • :charge_id (String) —

    id of the charge used for filtering

  • :type (String) —

    type of the object to be retrieved

  • :currency (String) —

    currency of the object to be retrieved

Returns:

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

    GetTransactionsResponse data, response status code and response headers



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
186
187
188
189
 
# File 'lib/conekta/api/transactions_api.rb', line 126

def get_transactions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransactionsApi.get_transactions ...'
  end
  allowable_values = ["es", "en"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionsApi.get_transactions, must be smaller than or equal to 250.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionsApi.get_transactions, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/transactions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
  query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'charge_id'] = opts[:'charge_id'] if !opts[:'charge_id'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'currency'] = opts[:'currency'] if !opts[:'currency'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.conekta-v2.1.0+json'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil?

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

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

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

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

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