Class: DigitalFemsa::PaymentMethodsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/digital_femsa/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/digital_femsa/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/digital_femsa/api/payment_methods_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_customer_payment_methods(id, create_customer_payment_methods_request, opts = {}) ⇒ CreateCustomerPaymentMethodsResponse

Create Payment Method Create a payment method for a customer.

Parameters:

  • id (String) —

    Identifier of the resource

  • create_customer_payment_methods_request (CreateCustomerPaymentMethodsRequest) —

    requested field for customer payment methods

  • 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:



30
31
32
33
 
# File 'lib/digital_femsa/api/payment_methods_api.rb', line 30

def create_customer_payment_methods(id, create_customer_payment_methods_request, opts = {})
  data, _status_code, _headers = create_customer_payment_methods_with_http_info(id, create_customer_payment_methods_request, opts)
  data
end

#create_customer_payment_methods_with_http_info(id, create_customer_payment_methods_request, opts = {}) ⇒ Array<(CreateCustomerPaymentMethodsResponse, Integer, Hash)>

Create Payment Method Create a payment method for a customer.

Parameters:

  • id (String) —

    Identifier of the resource

  • create_customer_payment_methods_request (CreateCustomerPaymentMethodsRequest) —

    requested field for customer payment methods

  • 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:



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
104
 
# File 'lib/digital_femsa/api/payment_methods_api.rb', line 43

def create_customer_payment_methods_with_http_info(id, create_customer_payment_methods_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.create_customer_payment_methods ...'
  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.create_customer_payment_methods"
  end
  # verify the required parameter 'create_customer_payment_methods_request' is set
  if @api_client.config.client_side_validation && create_customer_payment_methods_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_customer_payment_methods_request' when calling PaymentMethodsApi.create_customer_payment_methods"
  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 = '/customers/{id}/payment_sources'.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.app-v2.1.0+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[:'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] || @api_client.object_to_http_body(create_customer_payment_methods_request)

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

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

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

#delete_customer_payment_methods(id, payment_method_id, opts = {}) ⇒ UpdateCustomerPaymentMethodsResponse

Delete Payment Method Delete an existing payment method

Parameters:

  • id (String) —

    Identifier of the resource

  • payment_method_id (String) —

    Identifier of the payment method

  • 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:



114
115
116
117
 
# File 'lib/digital_femsa/api/payment_methods_api.rb', line 114

def delete_customer_payment_methods(id, payment_method_id, opts = {})
  data, _status_code, _headers = delete_customer_payment_methods_with_http_info(id, payment_method_id, opts)
  data
end

#delete_customer_payment_methods_with_http_info(id, payment_method_id, opts = {}) ⇒ Array<(UpdateCustomerPaymentMethodsResponse, Integer, Hash)>

Delete Payment Method Delete an existing payment method

Parameters:

  • id (String) —

    Identifier of the resource

  • payment_method_id (String) —

    Identifier of the payment method

  • 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:



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
 
# File 'lib/digital_femsa/api/payment_methods_api.rb', line 127

def delete_customer_payment_methods_with_http_info(id, payment_method_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.delete_customer_payment_methods ...'
  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.delete_customer_payment_methods"
  end
  # verify the required parameter 'payment_method_id' is set
  if @api_client.config.client_side_validation && payment_method_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_method_id' when calling PaymentMethodsApi.delete_customer_payment_methods"
  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 = '/customers/{id}/payment_sources/{payment_method_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'payment_method_id' + '}', CGI.escape(payment_method_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.app-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] || 'UpdateCustomerPaymentMethodsResponse'

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

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

#get_customer_payment_methods(id, opts = {}) ⇒ GetPaymentMethodResponse

Get Payment Methods Get a list of Payment Methods

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.

  • :limit (Integer) —

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

  • :_next (String) —

    next page

  • :previous (String) —

    previous page

  • :search (String) —

    General order search, e.g. by mail, reference etc.

Returns:



196
197
198
199
 
# File 'lib/digital_femsa/api/payment_methods_api.rb', line 196

def get_customer_payment_methods(id, opts = {})
  data, _status_code, _headers = get_customer_payment_methods_with_http_info(id, opts)
  data
end

#get_customer_payment_methods_with_http_info(id, opts = {}) ⇒ Array<(GetPaymentMethodResponse, Integer, Hash)>

Get Payment Methods Get a list of Payment Methods

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.

  • :limit (Integer) —

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

  • :_next (String) —

    next page

  • :previous (String) —

    previous page

  • :search (String) —

    General order search, e.g. by mail, reference etc.

Returns:

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

    GetPaymentMethodResponse data, response status code and response headers



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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/digital_femsa/api/payment_methods_api.rb', line 212

def get_customer_payment_methods_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.get_customer_payment_methods ...'
  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_customer_payment_methods"
  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 PaymentMethodsApi.get_customer_payment_methods, 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 PaymentMethodsApi.get_customer_payment_methods, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/customers/{id}/payment_sources'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # 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[:'search'] = opts[:'search'] if !opts[:'search'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.app-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] || 'GetPaymentMethodResponse'

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

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

#update_customer_payment_methods(id, payment_method_id, update_payment_methods, opts = {}) ⇒ UpdateCustomerPaymentMethodsResponse

Update Payment Method Gets a payment Method that corresponds to a customer ID.

Parameters:

  • id (String) —

    Identifier of the resource

  • payment_method_id (String) —

    Identifier of the payment method

  • update_payment_methods (UpdatePaymentMethods) —

    requested field for customer payment methods

  • 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:



287
288
289
290
 
# File 'lib/digital_femsa/api/payment_methods_api.rb', line 287

def update_customer_payment_methods(id, payment_method_id, update_payment_methods, opts = {})
  data, _status_code, _headers = update_customer_payment_methods_with_http_info(id, payment_method_id, update_payment_methods, opts)
  data
end

#update_customer_payment_methods_with_http_info(id, payment_method_id, update_payment_methods, opts = {}) ⇒ Array<(UpdateCustomerPaymentMethodsResponse, Integer, Hash)>

Update Payment Method Gets a payment Method that corresponds to a customer ID.

Parameters:

  • id (String) —

    Identifier of the resource

  • payment_method_id (String) —

    Identifier of the payment method

  • update_payment_methods (UpdatePaymentMethods) —

    requested field for customer payment methods

  • 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:



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/digital_femsa/api/payment_methods_api.rb', line 301

def update_customer_payment_methods_with_http_info(id, payment_method_id, update_payment_methods, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.update_customer_payment_methods ...'
  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.update_customer_payment_methods"
  end
  # verify the required parameter 'payment_method_id' is set
  if @api_client.config.client_side_validation && payment_method_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_method_id' when calling PaymentMethodsApi.update_customer_payment_methods"
  end
  # verify the required parameter 'update_payment_methods' is set
  if @api_client.config.client_side_validation && update_payment_methods.nil?
    fail ArgumentError, "Missing the required parameter 'update_payment_methods' when calling PaymentMethodsApi.update_customer_payment_methods"
  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 = '/customers/{id}/payment_sources/{payment_method_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'payment_method_id' + '}', CGI.escape(payment_method_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.app-v2.1.0+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[:'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] || @api_client.object_to_http_body(update_payment_methods)

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

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

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