Class: Bfwd::ReceiptsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReceiptsApi

Returns a new instance of ReceiptsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_receipt(receipt, opts = {}) ⇒ ReceiptPagedMetadata

Create a receipt. a new receipt","request":"createReceiptRequest.html","response":"createReceiptResponse.html"

Parameters:

  • receipt —

    The receipt object to be created.

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

    the optional parameters

Returns:



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

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

#create_receipt_with_http_info(receipt, opts = {}) ⇒ Array<(ReceiptPagedMetadata, Fixnum, Hash)>

Create a receipt. a new receipt&quot;,&quot;request&quot;:&quot;createReceiptRequest.html&quot;,&quot;response&quot;:&quot;createReceiptResponse.html&quot;

Parameters:

  • receipt —

    The receipt object to be created.

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

    the optional parameters

Returns:

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

    ReceiptPagedMetadata 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/receipts_api.rb', line 38

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

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

#get_all_receipts(opts = {}) ⇒ ReceiptPagedMetadata

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

  • :records (Integer) —

    The maximum number of receipts 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)

  • :account_id (Array<String>)
  • :invoice_id (Array<String>)
  • :payment_method_id (Array<String>)
  • :type (String)
  • :gateway (String)
  • :decision (String)

Returns:



93
94
95
96
 
# File 'lib/bf_ruby2/api/receipts_api.rb', line 93

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

#get_all_receipts_with_http_info(opts = {}) ⇒ Array<(ReceiptPagedMetadata, Fixnum, Hash)>

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

  • :records (Integer) —

    The maximum number of receipts 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.

  • :account_id (Array<String>)
  • :invoice_id (Array<String>)
  • :payment_method_id (Array<String>)
  • :type (String)
  • :gateway (String)
  • :decision (String)

Returns:

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

    ReceiptPagedMetadata data, response status code and response headers



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/bf_ruby2/api/receipts_api.rb', line 113

def get_all_receipts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ReceiptsApi.get_all_receipts ..."
  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
  if @api_client.config.client_side_validation && opts[:'type'] && !['credit', 'debit'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of credit, debit'
  end
  if @api_client.config.client_side_validation && opts[:'gateway'] && !['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?(opts[:'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[:'decision'] && !['Accept', 'Reject', 'Error'].include?(opts[:'decision'])
    fail ArgumentError, 'invalid value for "decision", must be one of Accept, Reject, Error'
  end
  # resource path
  local_var_path = "/receipts"

  # 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[:'account_id'] = @api_client.build_collection_param(opts[:'account_id'], :multi) if !opts[:'account_id'].nil?
  query_params[:'invoice_id'] = @api_client.build_collection_param(opts[:'invoice_id'], :multi) if !opts[:'invoice_id'].nil?
  query_params[:'payment_method_id'] = @api_client.build_collection_param(opts[:'payment_method_id'], :multi) if !opts[:'payment_method_id'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'gateway'] = opts[:'gateway'] if !opts[:'gateway'].nil?
  query_params[:'decision'] = opts[:'decision'] if !opts[:'decision'].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 => 'ReceiptPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReceiptsApi#get_all_receipts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_receipt_by_id(receipt_id, opts = {}) ⇒ ReceiptPagedMetadata

Returns a single receipt, specified by the ID parameter. an existing receipt","response":"getreceiptByID.html"

Parameters:

  • receipt_id —

    ID of the receipt.

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



176
177
178
179
 
# File 'lib/bf_ruby2/api/receipts_api.rb', line 176

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

#get_receipt_by_id_with_http_info(receipt_id, opts = {}) ⇒ Array<(ReceiptPagedMetadata, Fixnum, Hash)>

Returns a single receipt, specified by the ID parameter. an existing receipt&quot;,&quot;response&quot;:&quot;getreceiptByID.html&quot;

Parameters:

  • receipt_id —

    ID of the receipt.

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

    ReceiptPagedMetadata data, response status code and response headers



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
224
225
226
 
# File 'lib/bf_ruby2/api/receipts_api.rb', line 187

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

#get_receipts_by_invoice(invoice_id, opts = {}) ⇒ ReceiptPagedMetadata

Returns a receipt for the receipt payment. by invoice","response":"getreceiptsByInvoice.html"

Parameters:

  • invoice_id —

    ID of the Invoice.

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

  • :records (Integer) —

    The maximum number of receipts 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)

Returns:



238
239
240
241
 
# File 'lib/bf_ruby2/api/receipts_api.rb', line 238

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

#get_receipts_by_invoice_with_http_info(invoice_id, opts = {}) ⇒ Array<(ReceiptPagedMetadata, Fixnum, Hash)>

Returns a receipt for the receipt payment. by invoice&quot;,&quot;response&quot;:&quot;getreceiptsByInvoice.html&quot;

Parameters:

  • invoice_id —

    ID of the Invoice.

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

  • :records (Integer) —

    The maximum number of receipts 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.

Returns:

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

    ReceiptPagedMetadata data, response status code and response headers



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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/bf_ruby2/api/receipts_api.rb', line 253

def get_receipts_by_invoice_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ReceiptsApi.get_receipts_by_invoice ..."
  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 ReceiptsApi.get_receipts_by_invoice"
  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 = "/receipts/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?

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

#get_receipts_by_payment(payment_id, opts = {}) ⇒ ReceiptPagedMetadata

Returns a collection of receipts for the payment. by payment","response":"getreceiptsByPayment.html"

Parameters:

  • payment_id —

    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.

  • :offset (Integer) —

    The offset from the first receipt to return. (default to 0)

  • :records (Integer) —

    The maximum number of receipts 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)

Returns:



311
312
313
314
 
# File 'lib/bf_ruby2/api/receipts_api.rb', line 311

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

#get_receipts_by_payment_with_http_info(payment_id, opts = {}) ⇒ Array<(ReceiptPagedMetadata, Fixnum, Hash)>

Returns a collection of receipts for the payment. by payment&quot;,&quot;response&quot;:&quot;getreceiptsByPayment.html&quot;

Parameters:

  • payment_id —

    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.

  • :offset (Integer) —

    The offset from the first receipt to return.

  • :records (Integer) —

    The maximum number of receipts 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.

Returns:

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

    ReceiptPagedMetadata data, response status code and response headers



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
367
368
369
370
371
372
 
# File 'lib/bf_ruby2/api/receipts_api.rb', line 326

def get_receipts_by_payment_with_http_info(payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ReceiptsApi.get_receipts_by_payment ..."
  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 ReceiptsApi.get_receipts_by_payment"
  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 = "/receipts/payment/{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?
  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(['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 => 'ReceiptPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReceiptsApi#get_receipts_by_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_receipts_for_debit_payments_as_csv(opts = {}) ⇒ ReceiptPagedMetadata

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

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.

  • :received_start (String) —

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

  • :received_end (String) —

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

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

  • :gateway (Array<String>) —

    A list of payment gateways to include in the account. If none are specified, all gateways will be included.

Returns:



386
387
388
389
 
# File 'lib/bf_ruby2/api/receipts_api.rb', line 386

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

#get_receipts_for_debit_payments_as_csv_with_http_info(opts = {}) ⇒ Array<(ReceiptPagedMetadata, Fixnum, Hash)>

Retrieves debit payments in CSV format. { &quot;nickname&quot;:&quot;Debit payments CSV&quot;,&quot;response&quot;:&quot;Debit payments.csv&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.

  • :received_start (String) —

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

  • :received_end (String) —

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

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

  • :gateway (Array<String>) —

    A list of payment gateways to include in the account. If none are specified, all gateways will be included.

Returns:

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

    ReceiptPagedMetadata data, response status code and response headers



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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/bf_ruby2/api/receipts_api.rb', line 403

def get_receipts_for_debit_payments_as_csv_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ReceiptsApi.get_receipts_for_debit_payments_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
  if @api_client.config.client_side_validation && opts[:'gateway'] && !opts[:'gateway'].all?{|item| ['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?(item)}
    fail ArgumentError, 'invalid value for "gateway", must include 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
  # resource path
  local_var_path = "/receipts/debits.csv"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'received_start'] = opts[:'received_start'] if !opts[:'received_start'].nil?
  query_params[:'received_end'] = opts[:'received_end'] if !opts[:'received_end'].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[:'gateway'] = @api_client.build_collection_param(opts[:'gateway'], :multi) if !opts[:'gateway'].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 => 'ReceiptPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReceiptsApi#get_receipts_for_debit_payments_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_receipts_for_refund_payments_as_csv(opts = {}) ⇒ ReceiptPagedMetadata

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

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.

  • :completed_start (String) —

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

  • :completed_end (String) —

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

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



462
463
464
465
 
# File 'lib/bf_ruby2/api/receipts_api.rb', line 462

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

#get_receipts_for_refund_payments_as_csv_with_http_info(opts = {}) ⇒ Array<(ReceiptPagedMetadata, Fixnum, Hash)>

Retrieves refunded payments in CSV format. { &quot;nickname&quot;:&quot;Refunded payments CSV&quot;,&quot;response&quot;:&quot;Refunded payments.csv&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.

  • :completed_start (String) —

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

  • :completed_end (String) —

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

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

    ReceiptPagedMetadata data, response status code and response headers



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
512
513
514
515
516
517
518
519
520
 
# File 'lib/bf_ruby2/api/receipts_api.rb', line 478

def get_receipts_for_refund_payments_as_csv_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ReceiptsApi.get_receipts_for_refund_payments_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 = "/receipts/refunds.csv"

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'completed_start'] = opts[:'completed_start'] if !opts[:'completed_start'].nil?
  query_params[:'completed_end'] = opts[:'completed_end'] if !opts[:'completed_end'].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 => 'ReceiptPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReceiptsApi#get_receipts_for_refund_payments_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end