Class: Bfwd::PaymentmethodsApi

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

def api_client
  @api_client
end

Instance Method Details

#create_payment_method(payment_method, opts = {}) ⇒ PaymentMethodPagedMetadata

Create a payment-method. a new payment method","request":"createPaymentMethodRequest.html","response":"createPaymentMethodResponse.html"

Parameters:

  • payment_method —

    The payment-method object to be updated.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 28

def create_payment_method(payment_method, opts = {})
  data, _status_code, _headers = create_payment_method_with_http_info(payment_method, opts)
  return data
end

#create_payment_method_with_http_info(payment_method, opts = {}) ⇒ Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>

Create a payment-method. a new payment method&quot;,&quot;request&quot;:&quot;createPaymentMethodRequest.html&quot;,&quot;response&quot;:&quot;createPaymentMethodResponse.html&quot;

Parameters:

  • payment_method —

    The payment-method object to be updated.

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

    the optional parameters

Returns:

  • (Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>) —

    PaymentMethodPagedMetadata data, response status code and response headers



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
76
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 38

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(payment_method)
  auth_names = []
  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 => 'PaymentMethodPagedMetadata')
  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

#delete_payment_method(payment_method_id, opts = {}) ⇒ PaymentMethodPagedMetadata

Deletes the payment-method specified by the payment-method-ID parameter. payment method","response":"deletePaymentMethod.html"

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



84
85
86
87
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 84

def delete_payment_method(payment_method_id, opts = {})
  data, _status_code, _headers = delete_payment_method_with_http_info(payment_method_id, opts)
  return data
end

#delete_payment_method_with_http_info(payment_method_id, opts = {}) ⇒ Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>

Deletes the payment-method specified by the payment-method-ID parameter. payment method&quot;,&quot;response&quot;:&quot;deletePaymentMethod.html&quot;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

  • (Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>) —

    PaymentMethodPagedMetadata data, response status code and response headers



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
130
131
132
133
134
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 95

def delete_payment_method_with_http_info(payment_method_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentmethodsApi.delete_payment_method ..."
  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_payment_method"
  end
  # resource path
  local_var_path = "/payment-methods/{payment-method-ID}".sub('{' + 'payment-method-ID' + '}', payment_method_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PaymentMethodPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentmethodsApi#delete_payment_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_payment_methods(opts = {}) ⇒ PaymentMethodPagedMetadata

Returns a collection of all payment-methods. By default 10 values are returned. Records are returned in natural order. all payment methods","response":"getPaymentMethodAll.html"

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first payment-method to return. (default to 0)

  • :records (Integer) —

    The maximum number of payment-methods to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to true)

Returns:



146
147
148
149
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 146

def get_all_payment_methods(opts = {})
  data, _status_code, _headers = get_all_payment_methods_with_http_info(opts)
  return data
end

#get_all_payment_methods_with_http_info(opts = {}) ⇒ Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>

Returns a collection of all payment-methods. By default 10 values are returned. Records are returned in natural order. all payment methods&quot;,&quot;response&quot;:&quot;getPaymentMethodAll.html&quot;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first payment-method to return.

  • :records (Integer) —

    The maximum number of payment-methods to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:

  • (Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>) —

    PaymentMethodPagedMetadata data, response status code and response headers



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
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 161

def get_all_payment_methods_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentmethodsApi.get_all_payment_methods ..."
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/payment-methods"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'PaymentMethodPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentmethodsApi#get_all_payment_methods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_method_by_account_id(account_id, opts = {}) ⇒ PaymentMethodPagedMetadata

Returns a collection of payment-methods, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. by account","response":"getPaymentMethodByAccount.html"

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first payment-method to return. (default to 0)

  • :records (Integer) —

    The maximum number of payment-methods to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to id)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to true)

  • :default_only (BOOLEAN) —

    Whether only the defualt payment method should be returned. (default to false)

Returns:



216
217
218
219
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 216

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

#get_payment_method_by_account_id_with_http_info(account_id, opts = {}) ⇒ Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>

Returns a collection of payment-methods, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. by account&quot;,&quot;response&quot;:&quot;getPaymentMethodByAccount.html&quot;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first payment-method to return.

  • :records (Integer) —

    The maximum number of payment-methods to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

  • :default_only (BOOLEAN) —

    Whether only the defualt payment method should be returned.

Returns:

  • (Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>) —

    PaymentMethodPagedMetadata data, response status code and response headers



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
277
278
279
280
281
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 233

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentmethodsApi.get_payment_method_by_account_id ..."
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling PaymentmethodsApi.get_payment_method_by_account_id"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/payment-methods/account/{account-ID}".sub('{' + 'account-ID' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
  query_params[:'default_only'] = opts[:'default_only'] if !opts[:'default_only'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'PaymentMethodPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentmethodsApi#get_payment_method_by_account_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_method_by_id(payment_method_id, opts = {}) ⇒ PaymentMethodPagedMetadata

Returns a single payment-method, specified by the payment-method-ID parameter. existing payment method","response":"getPaymentMethodByID.html"

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



289
290
291
292
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 289

def get_payment_method_by_id(payment_method_id, opts = {})
  data, _status_code, _headers = get_payment_method_by_id_with_http_info(payment_method_id, opts)
  return data
end

#get_payment_method_by_id_with_http_info(payment_method_id, opts = {}) ⇒ Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>

Returns a single payment-method, specified by the payment-method-ID parameter. existing payment method&quot;,&quot;response&quot;:&quot;getPaymentMethodByID.html&quot;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

  • (Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>) —

    PaymentMethodPagedMetadata data, response status code and response headers



300
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
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 300

def get_payment_method_by_id_with_http_info(payment_method_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentmethodsApi.get_payment_method_by_id ..."
  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.get_payment_method_by_id"
  end
  # resource path
  local_var_path = "/payment-methods/{payment-method-ID}".sub('{' + 'payment-method-ID' + '}', payment_method_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'PaymentMethodPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentmethodsApi#get_payment_method_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_method_by_link_id(link_id, opts = {}) ⇒ PaymentMethodPagedMetadata

Returns a single payment-method, specified by the linkID parameter. by subscription link","response":"getPaymentMethodByLinkID.html"

Parameters:

  • link_id —

    The link-id of the payment-method.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



347
348
349
350
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 347

def get_payment_method_by_link_id(link_id, opts = {})
  data, _status_code, _headers = get_payment_method_by_link_id_with_http_info(link_id, opts)
  return data
end

#get_payment_method_by_link_id_with_http_info(link_id, opts = {}) ⇒ Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>

Returns a single payment-method, specified by the linkID parameter. by subscription link&quot;,&quot;response&quot;:&quot;getPaymentMethodByLinkID.html&quot;

Parameters:

  • link_id —

    The link-id of the payment-method.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

  • (Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>) —

    PaymentMethodPagedMetadata data, response status code and response headers



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 358

def get_payment_method_by_link_id_with_http_info(link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentmethodsApi.get_payment_method_by_link_id ..."
  end
  # verify the required parameter 'link_id' is set
  if @api_client.config.client_side_validation && link_id.nil?
    fail ArgumentError, "Missing the required parameter 'link_id' when calling PaymentmethodsApi.get_payment_method_by_link_id"
  end
  # resource path
  local_var_path = "/payment-methods/link-id/{linkID}".sub('{' + 'linkID' + '}', link_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'PaymentMethodPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentmethodsApi#get_payment_method_by_link_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_method_by_payment_gateway(gateway, opts = {}) ⇒ PaymentMethodPagedMetadata

Returns a collection of payment-methods, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. by gateway","response":"getPaymentMethodByGateway.html"

Parameters:

  • gateway —

    The payment-method gateway which generated the payment-method.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first payment-method to return. (default to 0)

  • :records (Integer) —

    The maximum number of payment-methods to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to id)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned. (default to true)

Returns:



410
411
412
413
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 410

def get_payment_method_by_payment_gateway(gateway, opts = {})
  data, _status_code, _headers = get_payment_method_by_payment_gateway_with_http_info(gateway, opts)
  return data
end

#get_payment_method_by_payment_gateway_with_http_info(gateway, opts = {}) ⇒ Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>

Returns a collection of payment-methods, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. by gateway&quot;,&quot;response&quot;:&quot;getPaymentMethodByGateway.html&quot;

Parameters:

  • gateway —

    The payment-method gateway which generated the payment-method.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first payment-method to return.

  • :records (Integer) —

    The maximum number of payment-methods to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

  • :include_retired (BOOLEAN) —

    Whether retired products should be returned.

Returns:

  • (Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>) —

    PaymentMethodPagedMetadata data, response status code and response headers



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 426

def get_payment_method_by_payment_gateway_with_http_info(gateway, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentmethodsApi.get_payment_method_by_payment_gateway ..."
  end
  # verify the required parameter 'gateway' is set
  if @api_client.config.client_side_validation && gateway.nil?
    fail ArgumentError, "Missing the required parameter 'gateway' when calling PaymentmethodsApi.get_payment_method_by_payment_gateway"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['cybersource_token', 'card_vault', 'paypal_simple', 'locustworld', 'free', 'coupon', 'credit_note', 'stripe', 'braintree', 'balanced', 'paypal', 'billforward_test', 'offline', 'trial', 'stripeACH', 'authorizeNet', 'spreedly', 'sagePay', 'trustCommerce', 'payvision', 'kash'].include?(gateway)
    fail ArgumentError, "invalid value for 'gateway', must be one of cybersource_token, card_vault, paypal_simple, locustworld, free, coupon, credit_note, stripe, braintree, balanced, paypal, billforward_test, offline, trial, stripeACH, authorizeNet, spreedly, sagePay, trustCommerce, payvision, kash"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/payment-methods/gateway/{gateway}".sub('{' + 'gateway' + '}', gateway.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'PaymentMethodPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentmethodsApi#get_payment_method_by_payment_gateway\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_payment_method(payment_method, opts = {}) ⇒ PaymentMethodPagedMetadata

Update a payment-method. a payment-method","request":"updatePaymentMethodRequest.html","response":"updatePaymentMethodResponse.html"

Parameters:

  • payment_method —

    The payment-method object to be updated.

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

    the optional parameters

Returns:



482
483
484
485
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 482

def update_payment_method(payment_method, opts = {})
  data, _status_code, _headers = update_payment_method_with_http_info(payment_method, opts)
  return data
end

#update_payment_method_with_http_info(payment_method, opts = {}) ⇒ Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>

Update a payment-method. a payment-method&quot;,&quot;request&quot;:&quot;updatePaymentMethodRequest.html&quot;,&quot;response&quot;:&quot;updatePaymentMethodResponse.html&quot;

Parameters:

  • payment_method —

    The payment-method object to be updated.

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

    the optional parameters

Returns:

  • (Array<(PaymentMethodPagedMetadata, Fixnum, Hash)>) —

    PaymentMethodPagedMetadata data, response status code and response headers



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/bf_ruby2/api/paymentmethods_api.rb', line 492

def update_payment_method_with_http_info(payment_method, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentmethodsApi.update_payment_method ..."
  end
  # verify the required parameter 'payment_method' is set
  if @api_client.config.client_side_validation && payment_method.nil?
    fail ArgumentError, "Missing the required parameter 'payment_method' when calling PaymentmethodsApi.update_payment_method"
  end
  # resource path
  local_var_path = "/payment-methods"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(payment_method)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PaymentMethodPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentmethodsApi#update_payment_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end