Class: Bfwd::PaymentsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/api/payments_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentsApi

Returns a new instance of PaymentsApi.



19
20
21
 
# File 'lib/bf_ruby2/api/payments_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/payments_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_payment(payment, opts = {}) ⇒ PaymentPagedMetadata

Create a payment. a new payment","request":"createPaymentRequest.html","response":"createPaymentResponse.html"

Parameters:

  • payment —

    The payment object to be updated.

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

    the optional parameters

Returns:



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

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

#create_payment_with_http_info(payment, opts = {}) ⇒ Array<(PaymentPagedMetadata, Fixnum, Hash)>

Create a payment. a new payment&quot;,&quot;request&quot;:&quot;createPaymentRequest.html&quot;,&quot;response&quot;:&quot;createPaymentResponse.html&quot;

Parameters:

  • payment —

    The payment object to be updated.

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

    the optional parameters

Returns:

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

    PaymentPagedMetadata 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/payments_api.rb', line 38

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

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

#get_all_payments(opts = {}) ⇒ PaymentPagedMetadata

Returns a collection of all payments. By default 10 values are returned. Records are returned in natural order. all payments","response":"getPaymentAll.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 to return. (default to 0)

  • :records (Integer) —

    The maximum number of payments 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:



88
89
90
91
 
# File 'lib/bf_ruby2/api/payments_api.rb', line 88

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

#get_all_payments_with_http_info(opts = {}) ⇒ Array<(PaymentPagedMetadata, Fixnum, Hash)>

Returns a collection of all payments. By default 10 values are returned. Records are returned in natural order. all payments&quot;,&quot;response&quot;:&quot;getPaymentAll.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 to return.

  • :records (Integer) —

    The maximum number of payments 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<(PaymentPagedMetadata, Fixnum, Hash)>) —

    PaymentPagedMetadata data, response status code and response headers



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
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/bf_ruby2/api/payments_api.rb', line 103

def get_all_payments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentsApi.get_all_payments ..."
  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 = "/payments"

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

#get_payment_as_csv(received_start, received_end, opts = {}) ⇒ PaymentPagedMetadata

Retrieves payments in CSV format. { "nickname":"Payments CSV","response":"payments.csv"}

Parameters:

  • received_start —

    The UTC DateTime specifying the start of the interval within which payments were received.

  • received_end —

    The UTC DateTime specifying the end of the interval within which payments were received.

  • 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 to return.

  • :records (Integer) —

    The maximum number of payments to return.

  • :order_by (String) —

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

  • :order (String) —

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

Returns:



157
158
159
160
 
# File 'lib/bf_ruby2/api/payments_api.rb', line 157

def get_payment_as_csv(received_start, received_end, opts = {})
  data, _status_code, _headers = get_payment_as_csv_with_http_info(received_start, received_end, opts)
  return data
end

#get_payment_as_csv_with_http_info(received_start, received_end, opts = {}) ⇒ Array<(PaymentPagedMetadata, Fixnum, Hash)>

Retrieves payments in CSV format. { &quot;nickname&quot;:&quot;Payments CSV&quot;,&quot;response&quot;:&quot;payments.csv&quot;}

Parameters:

  • received_start —

    The UTC DateTime specifying the start of the interval within which payments were received.

  • received_end —

    The UTC DateTime specifying the end of the interval within which payments were received.

  • 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 to return.

  • :records (Integer) —

    The maximum number of payments to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    The direction of any ordering, either ASC or DESC.

Returns:

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

    PaymentPagedMetadata data, response status code and response headers



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/bf_ruby2/api/payments_api.rb', line 173

def get_payment_as_csv_with_http_info(received_start, received_end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentsApi.get_payment_as_csv ..."
  end
  # verify the required parameter 'received_start' is set
  if @api_client.config.client_side_validation && received_start.nil?
    fail ArgumentError, "Missing the required parameter 'received_start' when calling PaymentsApi.get_payment_as_csv"
  end
  # verify the required parameter 'received_end' is set
  if @api_client.config.client_side_validation && received_end.nil?
    fail ArgumentError, "Missing the required parameter 'received_end' when calling PaymentsApi.get_payment_as_csv"
  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 = "/payments/csv"

  # query parameters
  query_params = {}
  query_params[:'received_start'] = received_start
  query_params[:'received_end'] = received_end
  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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv'])

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

#get_payment_by_id(payment_id, opts = {}) ⇒ PaymentPagedMetadata

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

Parameters:

  • payment_id —

    The unique string-ID of the payment.

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



231
232
233
234
 
# File 'lib/bf_ruby2/api/payments_api.rb', line 231

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

#get_payment_by_id_with_http_info(payment_id, opts = {}) ⇒ Array<(PaymentPagedMetadata, Fixnum, Hash)>

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

Parameters:

  • payment_id —

    The unique string-ID of the payment.

  • 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<(PaymentPagedMetadata, Fixnum, Hash)>) —

    PaymentPagedMetadata data, response status code and response headers



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/payments_api.rb', line 242

def get_payment_by_id_with_http_info(payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentsApi.get_payment_by_id ..."
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling PaymentsApi.get_payment_by_id"
  end
  # resource path
  local_var_path = "/payments/{payment-ID}".sub('{' + 'payment-ID' + '}', payment_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 => 'PaymentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentsApi#get_payment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_by_invoice_id(invoice_id, opts = {}) ⇒ PaymentPagedMetadata

Returns a collection of payments, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. for invoice","response":"getPaymentByInvoice.html"

Parameters:

  • invoice_id —

    The string ID of the account

  • 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 to return. (default to 0)

  • :records (Integer) —

    The maximum number of payments 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:



294
295
296
297
 
# File 'lib/bf_ruby2/api/payments_api.rb', line 294

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

#get_payment_by_invoice_id_with_http_info(invoice_id, opts = {}) ⇒ Array<(PaymentPagedMetadata, Fixnum, Hash)>

Returns a collection of payments, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. for invoice&quot;,&quot;response&quot;:&quot;getPaymentByInvoice.html&quot;

Parameters:

  • invoice_id —

    The string ID of the account

  • 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 to return.

  • :records (Integer) —

    The maximum number of payments 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<(PaymentPagedMetadata, Fixnum, Hash)>) —

    PaymentPagedMetadata data, response status code and response headers



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

def get_payment_by_invoice_id_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentsApi.get_payment_by_invoice_id ..."
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling PaymentsApi.get_payment_by_invoice_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 = "/payments/invoice/{invoice-ID}".sub('{' + 'invoice-ID' + '}', invoice_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?

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

#get_payment_by_payment_gateway(gateway, opts = {}) ⇒ PaymentPagedMetadata

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

Parameters:

  • gateway —

    The payment gateway which generated the payment.

  • 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 to return. (default to 0)

  • :records (Integer) —

    The maximum number of payments 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:



370
371
372
373
 
# File 'lib/bf_ruby2/api/payments_api.rb', line 370

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

#get_payment_by_payment_gateway_with_http_info(gateway, opts = {}) ⇒ Array<(PaymentPagedMetadata, Fixnum, Hash)>

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

Parameters:

  • gateway —

    The payment gateway which generated the payment.

  • 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 to return.

  • :records (Integer) —

    The maximum number of payments 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<(PaymentPagedMetadata, Fixnum, Hash)>) —

    PaymentPagedMetadata data, response status code and response headers



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/bf_ruby2/api/payments_api.rb', line 386

def get_payment_by_payment_gateway_with_http_info(gateway, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentsApi.get_payment_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 PaymentsApi.get_payment_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 = "/payments/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 => 'PaymentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentsApi#get_payment_by_payment_gateway\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_by_payment_method_id(payment_method_id, opts = {}) ⇒ PaymentPagedMetadata

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

Parameters:

  • payment_method_id —

    ID of the PaymentMethod

  • 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 to return. (default to 0)

  • :records (Integer) —

    The maximum number of payments 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:



448
449
450
451
 
# File 'lib/bf_ruby2/api/payments_api.rb', line 448

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

#get_payment_by_payment_method_id_with_http_info(payment_method_id, opts = {}) ⇒ Array<(PaymentPagedMetadata, Fixnum, Hash)>

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

Parameters:

  • payment_method_id —

    ID of the PaymentMethod

  • 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 to return.

  • :records (Integer) —

    The maximum number of payments 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<(PaymentPagedMetadata, Fixnum, Hash)>) —

    PaymentPagedMetadata data, response status code and response headers



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/bf_ruby2/api/payments_api.rb', line 464

def get_payment_by_payment_method_id_with_http_info(payment_method_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PaymentsApi.get_payment_by_payment_method_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 PaymentsApi.get_payment_by_payment_method_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 = "/payments/payment-method/{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?
  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'])
  # 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 => 'PaymentPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentsApi#get_payment_by_payment_method_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_payment(payment, opts = {}) ⇒ PaymentPagedMetadata

Update a payment. a payment","request":"updatePaymentRequest.html","response":"updatePaymentResponse.html"

Parameters:

  • payment —

    The payment object to be updated.

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

    the optional parameters

Returns:



518
519
520
521
 
# File 'lib/bf_ruby2/api/payments_api.rb', line 518

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

#update_payment_with_http_info(payment, opts = {}) ⇒ Array<(PaymentPagedMetadata, Fixnum, Hash)>

Update a payment. a payment&quot;,&quot;request&quot;:&quot;updatePaymentRequest.html&quot;,&quot;response&quot;:&quot;updatePaymentResponse.html&quot;

Parameters:

  • payment —

    The payment object to be updated.

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

    the optional parameters

Returns:

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

    PaymentPagedMetadata data, response status code and response headers



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/bf_ruby2/api/payments_api.rb', line 528

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

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