Class: SubfiPay::PaymentMethodsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subfi_pay/api/payment_methods_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentMethodsApi

Returns a new instance of PaymentMethodsApi.



19
20
21
 
# File 'lib/subfi_pay/api/payment_methods_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/subfi_pay/api/payment_methods_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_payment_method(x_api_version, x_account_id, payment_method_attributes, opts = {}) ⇒ PaymentMethodResponse

Create a payment method

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • payment_method_attributes (PaymentMethodAttributes)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_idempotency_key (String)

Returns:



29
30
31
32
 
# File 'lib/subfi_pay/api/payment_methods_api.rb', line 29

def create_payment_method(x_api_version, , payment_method_attributes, opts = {})
  data, _status_code, _headers = create_payment_method_with_http_info(x_api_version, , payment_method_attributes, opts)
  data
end

#create_payment_method_with_http_info(x_api_version, x_account_id, payment_method_attributes, opts = {}) ⇒ Array<(PaymentMethodResponse, Integer, Hash)>

Create a payment method

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • payment_method_attributes (PaymentMethodAttributes)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_idempotency_key (String)

Returns:

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

    PaymentMethodResponse 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
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/subfi_pay/api/payment_methods_api.rb', line 41

def create_payment_method_with_http_info(x_api_version, , payment_method_attributes, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.create_payment_method ...'
  end
  # verify the required parameter 'x_api_version' is set
  if @api_client.config.client_side_validation && x_api_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_api_version' when calling PaymentMethodsApi.create_payment_method"
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling PaymentMethodsApi.create_payment_method"
  end
  # verify the required parameter 'payment_method_attributes' is set
  if @api_client.config.client_side_validation && payment_method_attributes.nil?
    fail ArgumentError, "Missing the required parameter 'payment_method_attributes' when calling PaymentMethodsApi.create_payment_method"
  end
  # resource path
  local_var_path = '/payment_methods'

  # 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/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'X-Api-Version'] = x_api_version
  header_params[:'X-Account-Id'] = 
  header_params[:'X-Idempotency-Key'] = opts[:'x_idempotency_key'] if !opts[:'x_idempotency_key'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_method_attributes)

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

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

  new_options = opts.merge(
    :operation => :"PaymentMethodsApi.create_payment_method",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentMethodsApi#create_payment_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_method(x_api_version, x_account_id, id, opts = {}) ⇒ PaymentMethodResponse

Retrieve a payment method

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



111
112
113
114
 
# File 'lib/subfi_pay/api/payment_methods_api.rb', line 111

def get_payment_method(x_api_version, , id, opts = {})
  data, _status_code, _headers = get_payment_method_with_http_info(x_api_version, , id, opts)
  data
end

#get_payment_method_with_http_info(x_api_version, x_account_id, id, opts = {}) ⇒ Array<(PaymentMethodResponse, Integer, Hash)>

Retrieve a payment method

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    PaymentMethodResponse data, response status code and response headers



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
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/subfi_pay/api/payment_methods_api.rb', line 122

def get_payment_method_with_http_info(x_api_version, , id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.get_payment_method ...'
  end
  # verify the required parameter 'x_api_version' is set
  if @api_client.config.client_side_validation && x_api_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_api_version' when calling PaymentMethodsApi.get_payment_method"
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling PaymentMethodsApi.get_payment_method"
  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 PaymentMethodsApi.get_payment_method"
  end
  # resource path
  local_var_path = '/payment_methods/{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/json'])
  header_params[:'X-Api-Version'] = x_api_version
  header_params[:'X-Account-Id'] = 

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

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

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

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

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

#list_payment_methods(x_api_version, x_account_id, customer_id, opts = {}) ⇒ ListPaymentMethodsResponse

List all payment methods

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • customer_id (String) —

    The ID of the customer to filter payment methods by.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of results to retrieve.

  • :per_page (Integer) —

    Number of results per page.

Returns:



188
189
190
191
 
# File 'lib/subfi_pay/api/payment_methods_api.rb', line 188

def list_payment_methods(x_api_version, , customer_id, opts = {})
  data, _status_code, _headers = list_payment_methods_with_http_info(x_api_version, , customer_id, opts)
  data
end

#list_payment_methods_with_http_info(x_api_version, x_account_id, customer_id, opts = {}) ⇒ Array<(ListPaymentMethodsResponse, Integer, Hash)>

List all payment methods

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • customer_id (String) —

    The ID of the customer to filter payment methods by.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of results to retrieve.

  • :per_page (Integer) —

    Number of results per page.

Returns:

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

    ListPaymentMethodsResponse data, response status code and response headers



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
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
 
# File 'lib/subfi_pay/api/payment_methods_api.rb', line 201

def list_payment_methods_with_http_info(x_api_version, , customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.list_payment_methods ...'
  end
  # verify the required parameter 'x_api_version' is set
  if @api_client.config.client_side_validation && x_api_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_api_version' when calling PaymentMethodsApi.list_payment_methods"
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling PaymentMethodsApi.list_payment_methods"
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling PaymentMethodsApi.list_payment_methods"
  end
  # resource path
  local_var_path = '/payment_methods'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'customer_id'] = customer_id
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Api-Version'] = x_api_version
  header_params[:'X-Account-Id'] = 

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

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

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

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

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