Class: CyberSource::VoidApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VoidApi

Returns a new instance of VoidApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_void(id, opts = {}) ⇒ InlineResponse2015

Retrieve A Void Include the void ID in the GET request to retrieve the void details.

Parameters:

  • id —

    The void ID returned from a previous void request.

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

    the optional parameters

Returns:



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

def get_void(id, opts = {})
  data, _status_code, _headers = get_void_with_http_info(id, opts)
  return data, _status_code, _headers
end

#get_void_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2015, Fixnum, Hash)>

Retrieve A Void Include the void ID in the GET request to retrieve the void details.

Parameters:

  • id —

    The void ID returned from a previous void request.

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

    the optional parameters

Returns:

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

    InlineResponse2015 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/void_api.rb', line 37

def get_void_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VoidApi.get_void ...'
  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 VoidApi.get_void"
  end
  # resource path
  local_var_path = 'pts/v2/voids/{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 => 'InlineResponse2015')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoidApi#get_void\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#void_capture(void_capture_request, id, opts = {}) ⇒ InlineResponse2015

Void a Capture Include the capture ID in the POST request to cancel the capture.

Parameters:

  • void_capture_request
  • id —

    The capture ID returned from a previous capture request.

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

    the optional parameters

Returns:



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

def void_capture(void_capture_request, id, opts = {})
  data, _status_code, _headers = void_capture_with_http_info(void_capture_request, id, opts)
  return data, _status_code, _headers
end

#void_capture_with_http_info(void_capture_request, id, opts = {}) ⇒ Array<(InlineResponse2015, Fixnum, Hash)>

Void a Capture Include the capture ID in the POST request to cancel the capture.

Parameters:

  • void_capture_request
  • id —

    The capture ID returned from a previous capture request.

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

    the optional parameters

Returns:

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

    InlineResponse2015 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/void_api.rb', line 91

def void_capture_with_http_info(void_capture_request, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VoidApi.void_capture ...'
  end
  # verify the required parameter 'void_capture_request' is set
  if @api_client.config.client_side_validation && void_capture_request.nil?
    fail ArgumentError, "Missing the required parameter 'void_capture_request' when calling VoidApi.void_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 VoidApi.void_capture"
  end
  # resource path
  local_var_path = 'pts/v2/captures/{id}/voids'.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(void_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 => 'InlineResponse2015')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoidApi#void_capture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#void_credit(void_credit_request, id, opts = {}) ⇒ InlineResponse2015

Void a Credit Include the credit ID in the POST request to cancel the credit.

Parameters:

  • void_credit_request
  • id —

    The credit ID returned from a previous credit request.

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

    the optional parameters

Returns:



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

def void_credit(void_credit_request, id, opts = {})
  data, _status_code, _headers = void_credit_with_http_info(void_credit_request, id, opts)
  return data, _status_code, _headers
end

#void_credit_with_http_info(void_credit_request, id, opts = {}) ⇒ Array<(InlineResponse2015, Fixnum, Hash)>

Void a Credit Include the credit ID in the POST request to cancel the credit.

Parameters:

  • void_credit_request
  • id —

    The credit ID returned from a previous credit request.

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

    the optional parameters

Returns:

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

    InlineResponse2015 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/void_api.rb', line 149

def void_credit_with_http_info(void_credit_request, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VoidApi.void_credit ...'
  end
  # verify the required parameter 'void_credit_request' is set
  if @api_client.config.client_side_validation && void_credit_request.nil?
    fail ArgumentError, "Missing the required parameter 'void_credit_request' when calling VoidApi.void_credit"
  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 VoidApi.void_credit"
  end
  # resource path
  local_var_path = 'pts/v2/credits/{id}/voids'.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(void_credit_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 => 'InlineResponse2015')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoidApi#void_credit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#void_payment(void_payment_request, id, opts = {}) ⇒ InlineResponse2015

Void a Payment Include the payment ID in the POST request to cancel the payment.

Parameters:

  • void_payment_request
  • id —

    The payment ID returned from a previous payment request.

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

    the optional parameters

Returns:



196
197
198
199
 
# File 'lib/cyberSource_client/api/void_api.rb', line 196

def void_payment(void_payment_request, id, opts = {})
  data, _status_code, _headers = void_payment_with_http_info(void_payment_request, id, opts)
  return data, _status_code, _headers
end

#void_payment_with_http_info(void_payment_request, id, opts = {}) ⇒ Array<(InlineResponse2015, Fixnum, Hash)>

Void a Payment Include the payment ID in the POST request to cancel the payment.

Parameters:

  • void_payment_request
  • id —

    The payment ID returned from a previous payment request.

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

    the optional parameters

Returns:

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

    InlineResponse2015 data, response status code and response headers



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

def void_payment_with_http_info(void_payment_request, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VoidApi.void_payment ...'
  end
  # verify the required parameter 'void_payment_request' is set
  if @api_client.config.client_side_validation && void_payment_request.nil?
    fail ArgumentError, "Missing the required parameter 'void_payment_request' when calling VoidApi.void_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 VoidApi.void_payment"
  end
  # resource path
  local_var_path = 'pts/v2/payments/{id}/voids'.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(void_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 => 'InlineResponse2015')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoidApi#void_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#void_refund(void_refund_request, id, opts = {}) ⇒ InlineResponse2015

Void a Refund Include the refund ID in the POST request to cancel the refund.

Parameters:

  • void_refund_request
  • id —

    The refund ID returned from a previous refund request.

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

    the optional parameters

Returns:



254
255
256
257
 
# File 'lib/cyberSource_client/api/void_api.rb', line 254

def void_refund(void_refund_request, id, opts = {})
  data, _status_code, _headers = void_refund_with_http_info(void_refund_request, id, opts)
  return data, _status_code, _headers
end

#void_refund_with_http_info(void_refund_request, id, opts = {}) ⇒ Array<(InlineResponse2015, Fixnum, Hash)>

Void a Refund Include the refund ID in the POST request to cancel the refund.

Parameters:

  • void_refund_request
  • id —

    The refund ID returned from a previous refund request.

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

    the optional parameters

Returns:

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

    InlineResponse2015 data, response status code and response headers



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
300
301
302
303
304
305
 
# File 'lib/cyberSource_client/api/void_api.rb', line 265

def void_refund_with_http_info(void_refund_request, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VoidApi.void_refund ...'
  end
  # verify the required parameter 'void_refund_request' is set
  if @api_client.config.client_side_validation && void_refund_request.nil?
    fail ArgumentError, "Missing the required parameter 'void_refund_request' when calling VoidApi.void_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 VoidApi.void_refund"
  end
  # resource path
  local_var_path = 'pts/v2/refunds/{id}/voids'.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(void_refund_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 => 'InlineResponse2015')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoidApi#void_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end