class CyberSource::VoidApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/cyberSource_client/api/void_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_void(id, opts = {}) click to toggle source

Retrieve A Void Include the void ID in the GET request to retrieve the void details. @param id The void ID returned from a previous void request. @param [Hash] opts the optional parameters @return [InlineResponse2015]

# 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 = {}) click to toggle source

Retrieve A Void Include the void ID in the GET request to retrieve the void details. @param id The void ID returned from a previous void request. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2015, Fixnum, Hash)>] InlineResponse2015 data, response status code and response headers

# 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 = {}) click to toggle source

Void a Capture Include the capture ID in the POST request to cancel the capture. @param void_capture_request @param id The capture ID returned from a previous capture request. @param [Hash] opts the optional parameters @return [InlineResponse2015]

# 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 = {}) click to toggle source

Void a Capture Include the capture ID in the POST request to cancel the capture. @param void_capture_request @param id The capture ID returned from a previous capture request. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2015, Fixnum, Hash)>] InlineResponse2015 data, response status code and response headers

# 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 = {}) click to toggle source

Void a Credit Include the credit ID in the POST request to cancel the credit. @param void_credit_request @param id The credit ID returned from a previous credit request. @param [Hash] opts the optional parameters @return [InlineResponse2015]

# 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 = {}) click to toggle source

Void a Credit Include the credit ID in the POST request to cancel the credit. @param void_credit_request @param id The credit ID returned from a previous credit request. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2015, Fixnum, Hash)>] InlineResponse2015 data, response status code and response headers

# 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 = {}) click to toggle source

Void a Payment Include the payment ID in the POST request to cancel the payment. @param void_payment_request @param id The payment ID returned from a previous payment request. @param [Hash] opts the optional parameters @return [InlineResponse2015]

# 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 = {}) click to toggle source

Void a Payment Include the payment ID in the POST request to cancel the payment. @param void_payment_request @param id The payment ID returned from a previous payment request. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2015, Fixnum, Hash)>] InlineResponse2015 data, response status code and response headers

# 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 = {}) click to toggle source

Void a Refund Include the refund ID in the POST request to cancel the refund. @param void_refund_request @param id The refund ID returned from a previous refund request. @param [Hash] opts the optional parameters @return [InlineResponse2015]

# 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 = {}) click to toggle source

Void a Refund Include the refund ID in the POST request to cancel the refund. @param void_refund_request @param id The refund ID returned from a previous refund request. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2015, Fixnum, Hash)>] InlineResponse2015 data, response status code and response headers

# 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