Class: SubfiPay::RefundsApi

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

def api_client
  @api_client
end

Instance Method Details

#cancel_refund(x_api_version, x_account_id, id, opts = {}) ⇒ RefundResponse

Cancel a refund

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • id (String) —

    The ID of the refund to cancel.

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

    the optional parameters

Returns:



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

def cancel_refund(x_api_version, , id, opts = {})
  data, _status_code, _headers = cancel_refund_with_http_info(x_api_version, , id, opts)
  data
end

#cancel_refund_with_http_info(x_api_version, x_account_id, id, opts = {}) ⇒ Array<(RefundResponse, Integer, Hash)>

Cancel a refund

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • id (String) —

    The ID of the refund to cancel.

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

    the optional parameters

Returns:

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

    RefundResponse data, response status code and response headers



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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/subfi_pay/api/refunds_api.rb', line 39

def cancel_refund_with_http_info(x_api_version, , id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RefundsApi.cancel_refund ...'
  end
  # verify the required parameter 'x_api_version' is set
  if @api_client.config.client_side_validation && x_api_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_api_version' when calling RefundsApi.cancel_refund"
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling RefundsApi.cancel_refund"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RefundsApi.cancel_refund"
  end
  # resource path
  local_var_path = '/refunds/{id}/cancel'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Api-Version'] = x_api_version
  header_params[:'X-Account-Id'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"RefundsApi.cancel_refund",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundsApi#cancel_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_refund(x_api_version, x_account_id, refund_attributes, opts = {}) ⇒ RefundResponse

Create a refund

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • refund_attributes (RefundAttributes)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_idempotency_key (String)

Returns:



104
105
106
107
 
# File 'lib/subfi_pay/api/refunds_api.rb', line 104

def create_refund(x_api_version, , refund_attributes, opts = {})
  data, _status_code, _headers = create_refund_with_http_info(x_api_version, , refund_attributes, opts)
  data
end

#create_refund_with_http_info(x_api_version, x_account_id, refund_attributes, opts = {}) ⇒ Array<(RefundResponse, Integer, Hash)>

Create a refund

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • refund_attributes (RefundAttributes)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_idempotency_key (String)

Returns:

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

    RefundResponse data, response status code and response headers



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
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/subfi_pay/api/refunds_api.rb', line 116

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

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'X-Api-Version'] = x_api_version
  header_params[:'X-Account-Id'] = 
  header_params[:'X-Idempotency-Key'] = opts[:'x_idempotency_key'] if !opts[:'x_idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(refund_attributes)

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

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

  new_options = opts.merge(
    :operation => :"RefundsApi.create_refund",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundsApi#create_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_refund(x_api_version, x_account_id, id, opts = {}) ⇒ RefundResponse

Get a refund by ID

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • id (String) —

    The ID of the refund to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :connected_account_id (String) —

    Filter results by sub_merchant ID.

Returns:



187
188
189
190
 
# File 'lib/subfi_pay/api/refunds_api.rb', line 187

def get_refund(x_api_version, , id, opts = {})
  data, _status_code, _headers = get_refund_with_http_info(x_api_version, , id, opts)
  data
end

#get_refund_with_http_info(x_api_version, x_account_id, id, opts = {}) ⇒ Array<(RefundResponse, Integer, Hash)>

Get a refund by ID

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • id (String) —

    The ID of the refund to retrieve.

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

    the optional parameters

Options Hash (opts):

  • :connected_account_id (String) —

    Filter results by sub_merchant ID.

Returns:

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

    RefundResponse data, response status code and response headers



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

def get_refund_with_http_info(x_api_version, , id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RefundsApi.get_refund ...'
  end
  # verify the required parameter 'x_api_version' is set
  if @api_client.config.client_side_validation && x_api_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_api_version' when calling RefundsApi.get_refund"
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling RefundsApi.get_refund"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RefundsApi.get_refund"
  end
  # resource path
  local_var_path = '/refunds/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'connected_account_id'] = opts[:'connected_account_id'] if !opts[:'connected_account_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Api-Version'] = x_api_version
  header_params[:'X-Account-Id'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"RefundsApi.get_refund",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundsApi#get_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_refunds(x_api_version, x_account_id, charge_id, opts = {}) ⇒ ListRefundsResponse

List refunds for a Charge

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • charge_id (String) —

    The ID of the charge to which this refund belongs.

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

    the optional parameters

Returns:



264
265
266
267
 
# File 'lib/subfi_pay/api/refunds_api.rb', line 264

def list_refunds(x_api_version, , charge_id, opts = {})
  data, _status_code, _headers = list_refunds_with_http_info(x_api_version, , charge_id, opts)
  data
end

#list_refunds_with_http_info(x_api_version, x_account_id, charge_id, opts = {}) ⇒ Array<(ListRefundsResponse, Integer, Hash)>

List refunds for a Charge

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • charge_id (String) —

    The ID of the charge to which this refund belongs.

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

    the optional parameters

Returns:

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

    ListRefundsResponse data, response status code and response headers



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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/subfi_pay/api/refunds_api.rb', line 275

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'charge_id'] = charge_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Api-Version'] = x_api_version
  header_params[:'X-Account-Id'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"RefundsApi.list_refunds",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundsApi#list_refunds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end