Class: CyberSource::RefundApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cyberSource_client/api/refund_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RefundApi

Returns a new instance of RefundApi.



19
20
21
 
# File 'lib/cyberSource_client/api/refund_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/cyberSource_client/api/refund_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_refund(id, opts = {}) ⇒ InlineResponse2005

Retrieve a Refund Include the refund ID in the GET request to to retrieve the refund details.

Parameters:

  • id —

    The refund ID. This ID is returned from a previous refund request.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cyberSource_client/api/refund_api.rb', line 27

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

#get_refund_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

Retrieve a Refund Include the refund ID in the GET request to to retrieve the refund details.

Parameters:

  • id —

    The refund ID. This ID is returned from a previous refund request.

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

    the optional parameters

Returns:

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

    InlineResponse2005 data, response status code and response headers



37
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
 
# File 'lib/cyberSource_client/api/refund_api.rb', line 37

def get_refund_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RefundApi.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 RefundApi.get_refund"
  end
  # resource path
  local_var_path = 'pts/v2/refunds/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])

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

#refund_capture(refund_capture_request, id, opts = {}) ⇒ InlineResponse2013

Refund a Capture Include the capture ID in the POST request to refund the captured amount.

Parameters:

  • refund_capture_request
  • id —

    The capture ID. This ID is returned from a previous capture request.

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/cyberSource_client/api/refund_api.rb', line 80

def refund_capture(refund_capture_request, id, opts = {})
  data, _status_code, _headers = refund_capture_with_http_info(refund_capture_request, id, opts)
  return data, _status_code, _headers
end

#refund_capture_with_http_info(refund_capture_request, id, opts = {}) ⇒ Array<(InlineResponse2013, Fixnum, Hash)>

Refund a Capture Include the capture ID in the POST request to refund the captured amount.

Parameters:

  • refund_capture_request
  • id —

    The capture ID. This ID is returned from a previous capture request.

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

    the optional parameters

Returns:

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

    InlineResponse2013 data, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/cyberSource_client/api/refund_api.rb', line 91

def refund_capture_with_http_info(refund_capture_request, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RefundApi.refund_capture ...'
  end
  # verify the required parameter 'refund_capture_request' is set
  if @api_client.config.client_side_validation && refund_capture_request.nil?
    fail ArgumentError, "Missing the required parameter 'refund_capture_request' when calling RefundApi.refund_capture"
  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 RefundApi.refund_capture"
  end
  # resource path
  local_var_path = 'pts/v2/captures/{id}/refunds'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(refund_capture_request)
  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 => 'InlineResponse2013')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundApi#refund_capture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#refund_payment(refund_payment_request, id, opts = {}) ⇒ InlineResponse2013

Refund a Payment Include the payment ID in the POST request to refund the payment amount.

Parameters:

  • refund_payment_request
  • id —

    The payment ID. This ID is returned from a previous payment request.

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

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/cyberSource_client/api/refund_api.rb', line 138

def refund_payment(refund_payment_request, id, opts = {})
  data, _status_code, _headers = refund_payment_with_http_info(refund_payment_request, id, opts)
  return data, _status_code, _headers
end

#refund_payment_with_http_info(refund_payment_request, id, opts = {}) ⇒ Array<(InlineResponse2013, Fixnum, Hash)>

Refund a Payment Include the payment ID in the POST request to refund the payment amount.

Parameters:

  • refund_payment_request
  • id —

    The payment ID. This ID is returned from a previous payment request.

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

    the optional parameters

Returns:

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

    InlineResponse2013 data, response status code and response headers



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
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/cyberSource_client/api/refund_api.rb', line 149

def refund_payment_with_http_info(refund_payment_request, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RefundApi.refund_payment ...'
  end
  # verify the required parameter 'refund_payment_request' is set
  if @api_client.config.client_side_validation && refund_payment_request.nil?
    fail ArgumentError, "Missing the required parameter 'refund_payment_request' when calling RefundApi.refund_payment"
  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 RefundApi.refund_payment"
  end
  # resource path
  local_var_path = 'pts/v2/payments/{id}/refunds'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(refund_payment_request)
  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 => 'InlineResponse2013')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundApi#refund_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end