Class: TreezorClient::CardtransactionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/treezor_client/api/cardtransaction_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CardtransactionApi

Returns a new instance of CardtransactionApi.


19
20
21
# File 'lib/treezor_client/api/cardtransaction_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.


17
18
19
# File 'lib/treezor_client/api/cardtransaction_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_cardtransaction(id, opts = {}) ⇒ InlineResponse20010

get a card transaction get a card transaction

Parameters:

  • id

    Card transactions's internal id.

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

    the optional parameters

Returns:


27
28
29
30
# File 'lib/treezor_client/api/cardtransaction_api.rb', line 27

def get_cardtransaction(id, opts = {})
  data, _status_code, _headers = get_cardtransaction_with_http_info(id, opts)
  data
end

#get_cardtransaction_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse20010, Fixnum, Hash)>

get a card transaction get a card transaction

Parameters:

  • id

    Card transactions&#39;s internal id.

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20010, Fixnum, Hash)>)

    InlineResponse20010 data, response status code and response headers


37
38
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
# File 'lib/treezor_client/api/cardtransaction_api.rb', line 37

def get_cardtransaction_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardtransactionApi.get_cardtransaction ...'
  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 CardtransactionApi.get_cardtransaction"
  end
  # resource path
  local_var_path = '/cardtransactions/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

#read_card_transaction(opts = {}) ⇒ InlineResponse2009

search for card transactions Search for documents. The request must contain at least one of those inputs - cardId, paymentId, publicToken, walletId

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :access_signature (String)

    Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](agent.treezor.com/security-authentication).

  • :access_tag (String)

    Access tag is used for idem potency query. More info [here](agent.treezor.com/basics).

  • :access_user_id (Integer)

    Access user&#39;s id is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :access_user_ip (String)

    Access user&#39;s ip is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :cardtransaction_id (Integer)

    Card transaction&#39;s Id

  • :card_id (Integer)

    Card&#39;s Id

  • :wallet_id (Integer)

    Card&#39;s wallet Id

  • :merchant_id (Integer)

    Merchant&#39;s Id

  • :public_token (String)

    Card&#39;s public token

  • :payment_id (Integer)

    Payment&#39;s Id

  • :page_number (Integer)

    Pagination page number. More info [here](agent.treezor.com/lists).

  • :page_count (Integer)

    The number of items per page. More info [here](agent.treezor.com/lists).

  • :sort_by (String)

    The transaction element you want to sort the list with. Default value : createdDate. More info [here](agent.treezor.com/lists). required: false

Returns:


93
94
95
96
# File 'lib/treezor_client/api/cardtransaction_api.rb', line 93

def read_card_transaction(opts = {})
  data, _status_code, _headers = read_card_transaction_with_http_info(opts)
  data
end

#read_card_transaction_with_http_info(opts = {}) ⇒ Array<(InlineResponse2009, Fixnum, Hash)>

search for card transactions Search for documents. The request must contain at least one of those inputs - cardId, paymentId, publicToken, walletId

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :access_signature (String)

    Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](agent.treezor.com/security-authentication).

  • :access_tag (String)

    Access tag is used for idem potency query. More info [here](agent.treezor.com/basics).

  • :access_user_id (Integer)

    Access user&#39;s id is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :access_user_ip (String)

    Access user&#39;s ip is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :cardtransaction_id (Integer)

    Card transaction&#39;s Id

  • :card_id (Integer)

    Card&#39;s Id

  • :wallet_id (Integer)

    Card&#39;s wallet Id

  • :merchant_id (Integer)

    Merchant&#39;s Id

  • :public_token (String)

    Card&#39;s public token

  • :payment_id (Integer)

    Payment&#39;s Id

  • :page_number (Integer)

    Pagination page number. More info [here](agent.treezor.com/lists).

  • :page_count (Integer)

    The number of items per page. More info [here](agent.treezor.com/lists).

  • :sort_by (String)

    The transaction element you want to sort the list with. Default value : createdDate. More info [here](agent.treezor.com/lists). required: false

Returns:

  • (Array<(InlineResponse2009, Fixnum, Hash)>)

    InlineResponse2009 data, response status code and response headers


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
# File 'lib/treezor_client/api/cardtransaction_api.rb', line 115

def read_card_transaction_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardtransactionApi.read_card_transaction ...'
  end
  # resource path
  local_var_path = '/cardtransactions'

  # query parameters
  query_params = {}
  query_params[:'accessSignature'] = opts[:'access_signature'] if !opts[:'access_signature'].nil?
  query_params[:'accessTag'] = opts[:'access_tag'] if !opts[:'access_tag'].nil?
  query_params[:'accessUserId'] = opts[:'access_user_id'] if !opts[:'access_user_id'].nil?
  query_params[:'accessUserIp'] = opts[:'access_user_ip'] if !opts[:'access_user_ip'].nil?
  query_params[:'cardtransactionId'] = opts[:'cardtransaction_id'] if !opts[:'cardtransaction_id'].nil?
  query_params[:'cardId'] = opts[:'card_id'] if !opts[:'card_id'].nil?
  query_params[:'walletId'] = opts[:'wallet_id'] if !opts[:'wallet_id'].nil?
  query_params[:'merchantId'] = opts[:'merchant_id'] if !opts[:'merchant_id'].nil?
  query_params[:'publicToken'] = opts[:'public_token'] if !opts[:'public_token'].nil?
  query_params[:'paymentId'] = opts[:'payment_id'] if !opts[:'payment_id'].nil?
  query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'pageCount'] = opts[:'page_count'] if !opts[:'page_count'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].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 = ['api_key']
  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 => 'InlineResponse2009')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardtransactionApi#read_card_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end