Class: ProtonApi::CardsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/api/cards_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CardsApi

Returns a new instance of CardsApi.



19
20
21
 
# File 'lib/proton_api/api/cards_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/proton_api/api/cards_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#card_analysis(card_analysis_request, opts = {}) ⇒ Hash<String, Object>

Card Analysis Analyze cardholder activity over time

Parameters:

  • card_analysis_request —

    Request payload for Card Analysis

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


27
28
29
30
 
# File 'lib/proton_api/api/cards_api.rb', line 27

def card_analysis(card_analysis_request, opts = {})
  data, _status_code, _headers = card_analysis_with_http_info(card_analysis_request, opts)
  data
end

#card_analysis_with_http_info(card_analysis_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Card Analysis Analyze cardholder activity over time

Parameters:

  • card_analysis_request —

    Request payload for Card Analysis

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> 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/proton_api/api/cards_api.rb', line 37

def card_analysis_with_http_info(card_analysis_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.card_analysis ...'
  end
  # verify the required parameter 'card_analysis_request' is set
  if @api_client.config.client_side_validation && card_analysis_request.nil?
    fail ArgumentError, "Missing the required parameter 'card_analysis_request' when calling CardsApi.card_analysis"
  end
  # resource path
  local_var_path = '/card_analysis'

  # 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 = @api_client.object_to_http_body(card_analysis_request)
  auth_names = ['oauth2']
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#card_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#card_limit_check(card_limit_check_request, opts = {}) ⇒ Hash<String, Object>

Card Limit Check Evaluate card transaction history against spending controls

Parameters:

  • card_limit_check_request —

    Request payload for Card Limit Check

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


81
82
83
84
 
# File 'lib/proton_api/api/cards_api.rb', line 81

def card_limit_check(card_limit_check_request, opts = {})
  data, _status_code, _headers = card_limit_check_with_http_info(card_limit_check_request, opts)
  data
end

#card_limit_check_with_http_info(card_limit_check_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Card Limit Check Evaluate card transaction history against spending controls

Parameters:

  • card_limit_check_request —

    Request payload for Card Limit Check

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/proton_api/api/cards_api.rb', line 91

def card_limit_check_with_http_info(card_limit_check_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.card_limit_check ...'
  end
  # verify the required parameter 'card_limit_check_request' is set
  if @api_client.config.client_side_validation && card_limit_check_request.nil?
    fail ArgumentError, "Missing the required parameter 'card_limit_check_request' when calling CardsApi.card_limit_check"
  end
  # resource path
  local_var_path = '/card_limit_check'

  # 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 = @api_client.object_to_http_body(card_limit_check_request)
  auth_names = ['oauth2']
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#card_limit_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#card_transaction_authorization(card_transaction_authorization_request, opts = {}) ⇒ Hash<String, Object>

Card Transaction Authorization Approve or reject a card transaction based on applicable conditions

Parameters:

  • card_transaction_authorization_request —

    Request payload for Card Transaction Authorization

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


135
136
137
138
 
# File 'lib/proton_api/api/cards_api.rb', line 135

def card_transaction_authorization(card_transaction_authorization_request, opts = {})
  data, _status_code, _headers = card_transaction_authorization_with_http_info(card_transaction_authorization_request, opts)
  data
end

#card_transaction_authorization_with_http_info(card_transaction_authorization_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Card Transaction Authorization Approve or reject a card transaction based on applicable conditions

Parameters:

  • card_transaction_authorization_request —

    Request payload for Card Transaction Authorization

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
 
# File 'lib/proton_api/api/cards_api.rb', line 145

def card_transaction_authorization_with_http_info(card_transaction_authorization_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.card_transaction_authorization ...'
  end
  # verify the required parameter 'card_transaction_authorization_request' is set
  if @api_client.config.client_side_validation && card_transaction_authorization_request.nil?
    fail ArgumentError, "Missing the required parameter 'card_transaction_authorization_request' when calling CardsApi.card_transaction_authorization"
  end
  # resource path
  local_var_path = '/card_authorization'

  # 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 = @api_client.object_to_http_body(card_transaction_authorization_request)
  auth_names = ['oauth2']
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardsApi#card_transaction_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end