Class: Bfwd::RefundsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RefundsApi

Returns a new instance of RefundsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_refund(refund, opts = {}) ⇒ RefundPagedMetadata

<p>When creating a refund either the invoice, or invoice payment must be specified.</p><p>Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.</p><p>Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.</p><p>Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.</p> a new refund","request":"createRefundRequest.html","response":"createRefundResponse.html"

Parameters:

  • refund —

    The refund object to be created.

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

    the optional parameters

Returns:



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

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

#create_refund_with_http_info(refund, opts = {}) ⇒ Array<(RefundPagedMetadata, Fixnum, Hash)>

&lt;p&gt;When creating a refund either the invoice, or invoice payment must be specified.&lt;/p&gt;&lt;p&gt;Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.&lt;/p&gt;&lt;p&gt;Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.&lt;/p&gt;&lt;p&gt;Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.&lt;/p&gt; a new refund&quot;,&quot;request&quot;:&quot;createRefundRequest.html&quot;,&quot;response&quot;:&quot;createRefundResponse.html&quot;

Parameters:

  • refund —

    The refund object to be created.

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

    the optional parameters

Returns:

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

    RefundPagedMetadata 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/refunds_api.rb', line 38

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

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

#get_all_refunds(opts = {}) ⇒ RefundPagedMetadata

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

  • :records (Integer) —

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



87
88
89
90
 
# File 'lib/bf_ruby2/api/refunds_api.rb', line 87

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

#get_all_refunds_with_http_info(opts = {}) ⇒ Array<(RefundPagedMetadata, Fixnum, Hash)>

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

  • :records (Integer) —

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

    RefundPagedMetadata data, response status code and response headers



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
135
136
137
138
139
140
141
 
# File 'lib/bf_ruby2/api/refunds_api.rb', line 101

def get_all_refunds_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RefundsApi.get_all_refunds ..."
  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 = "/refunds"

  # 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'])

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

#get_refund_by_id(refund_id, opts = {}) ⇒ RefundPagedMetadata

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

Parameters:

  • refund_id —

    ID of the Refund.

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



149
150
151
152
 
# File 'lib/bf_ruby2/api/refunds_api.rb', line 149

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

#get_refund_by_id_with_http_info(refund_id, opts = {}) ⇒ Array<(RefundPagedMetadata, Fixnum, Hash)>

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

Parameters:

  • refund_id —

    ID of the Refund.

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

    RefundPagedMetadata data, response status code and response headers



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

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

#get_refund_for_original_payment(payment_id, opts = {}) ⇒ RefundPagedMetadata

Returns a refund for the original payment. by originating payment","response":"getRefundsByPayment.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.

Returns:



207
208
209
210
 
# File 'lib/bf_ruby2/api/refunds_api.rb', line 207

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

#get_refund_for_original_payment_with_http_info(payment_id, opts = {}) ⇒ Array<(RefundPagedMetadata, Fixnum, Hash)>

Returns a refund for the original payment. by originating payment&quot;,&quot;response&quot;:&quot;getRefundsByPayment.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.

Returns:

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

    RefundPagedMetadata data, response status code and response headers



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/bf_ruby2/api/refunds_api.rb', line 218

def get_refund_for_original_payment_with_http_info(payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RefundsApi.get_refund_for_original_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 RefundsApi.get_refund_for_original_payment"
  end
  # resource path
  local_var_path = "/refunds/original-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?

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

#get_refund_for_refund_payment(payment_id, opts = {}) ⇒ RefundPagedMetadata

Returns a refund for the refund payment. by refund payment","response":"getRefundsByPayment.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.

Returns:



265
266
267
268
 
# File 'lib/bf_ruby2/api/refunds_api.rb', line 265

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

#get_refund_for_refund_payment_with_http_info(payment_id, opts = {}) ⇒ Array<(RefundPagedMetadata, Fixnum, Hash)>

Returns a refund for the refund payment. by refund payment&quot;,&quot;response&quot;:&quot;getRefundsByPayment.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.

Returns:

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

    RefundPagedMetadata data, response status code and response headers



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/bf_ruby2/api/refunds_api.rb', line 276

def get_refund_for_refund_payment_with_http_info(payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RefundsApi.get_refund_for_refund_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 RefundsApi.get_refund_for_refund_payment"
  end
  # resource path
  local_var_path = "/refunds/refund-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?

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

#get_refund_for_refunded_invoice(invoice_id, opts = {}) ⇒ RefundPagedMetadata

Returns a refund for the refund payment. by invoice","response":"getRefundsByInvoice.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.

Returns:



323
324
325
326
 
# File 'lib/bf_ruby2/api/refunds_api.rb', line 323

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

#get_refund_for_refunded_invoice_with_http_info(invoice_id, opts = {}) ⇒ Array<(RefundPagedMetadata, Fixnum, Hash)>

Returns a refund for the refund payment. by invoice&quot;,&quot;response&quot;:&quot;getRefundsByInvoice.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.

Returns:

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

    RefundPagedMetadata data, response status code and response headers



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
373
 
# File 'lib/bf_ruby2/api/refunds_api.rb', line 334

def get_refund_for_refunded_invoice_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RefundsApi.get_refund_for_refunded_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 RefundsApi.get_refund_for_refunded_invoice"
  end
  # resource path
  local_var_path = "/refunds/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?

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

#get_refunds_as_csv(completed_start, completed_end, opts = {}) ⇒ RefundPagedMetadata

Retrieves refunds in CSV format. { "nickname":"Refunds CSV","response":"refunds.csv"}

Parameters:

  • completed_start —

    The UTC DateTime specifying the start of the interval within which refunds were completed.

  • completed_end —

    The UTC DateTime specifying the end of the interval within which refunds were completed.

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

  • :records (Integer) —

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



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

def get_refunds_as_csv(completed_start, completed_end, opts = {})
  data, _status_code, _headers = get_refunds_as_csv_with_http_info(completed_start, completed_end, opts)
  return data
end

#get_refunds_as_csv_with_http_info(completed_start, completed_end, opts = {}) ⇒ Array<(RefundPagedMetadata, Fixnum, Hash)>

Retrieves refunds in CSV format. { &quot;nickname&quot;:&quot;Refunds CSV&quot;,&quot;response&quot;:&quot;refunds.csv&quot;}

Parameters:

  • completed_start —

    The UTC DateTime specifying the start of the interval within which refunds were completed.

  • completed_end —

    The UTC DateTime specifying the end of the interval within which refunds were completed.

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

  • :records (Integer) —

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

    RefundPagedMetadata data, response status code and response headers



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

def get_refunds_as_csv_with_http_info(completed_start, completed_end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RefundsApi.get_refunds_as_csv ..."
  end
  # verify the required parameter 'completed_start' is set
  if @api_client.config.client_side_validation && completed_start.nil?
    fail ArgumentError, "Missing the required parameter 'completed_start' when calling RefundsApi.get_refunds_as_csv"
  end
  # verify the required parameter 'completed_end' is set
  if @api_client.config.client_side_validation && completed_end.nil?
    fail ArgumentError, "Missing the required parameter 'completed_end' when calling RefundsApi.get_refunds_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 = "/refunds/csv"

  # query parameters
  query_params = {}
  query_params[:'completed_start'] = completed_start
  query_params[:'completed_end'] = completed_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 => 'RefundPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundsApi#get_refunds_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_refund(refund, opts = {}) ⇒ RefundPagedMetadata

Update a refund a refund","request":"updateRefundRequest.html","response":"updateRefundResponse.html"

Parameters:

  • refund —

    The refund object to be update.

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

    the optional parameters

Returns:



459
460
461
462
 
# File 'lib/bf_ruby2/api/refunds_api.rb', line 459

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

#update_refund_with_http_info(refund, opts = {}) ⇒ Array<(RefundPagedMetadata, Fixnum, Hash)>

Update a refund a refund&quot;,&quot;request&quot;:&quot;updateRefundRequest.html&quot;,&quot;response&quot;:&quot;updateRefundResponse.html&quot;

Parameters:

  • refund —

    The refund object to be update.

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

    the optional parameters

Returns:

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

    RefundPagedMetadata data, response status code and response headers



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

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

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