class PostFinanceCheckout::TransactionVoidService

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/postfinancecheckout-ruby-sdk/api/transaction_void_service_api.rb, line 24
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

count(space_id, opts = {}) click to toggle source

Count Counts the number of items in the database as restricted by the given filter. @param space_id @param [Hash] opts the optional parameters @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count. @return [Integer]

# File lib/postfinancecheckout-ruby-sdk/api/transaction_void_service_api.rb, line 34
def count(space_id, opts = {})
  data, _status_code, _headers = count_with_http_info(space_id, opts)
  return data
end
count_with_http_info(space_id, opts = {}) click to toggle source

Count Counts the number of items in the database as restricted by the given filter. @param space_id @param [Hash] opts the optional parameters @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count. @return [Array<(Integer, Fixnum, Hash)>] Integer data, response status code and response headers

# File lib/postfinancecheckout-ruby-sdk/api/transaction_void_service_api.rb, line 45
def count_with_http_info(space_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionVoidService.count ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TransactionVoidService.count" if space_id.nil?
  # resource path
  local_var_path = "/transaction-void/count".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'filter'])
  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 => 'Integer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionVoidService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
read(space_id, id, opts = {}) click to toggle source

Read Reads the entity with the given 'id' and returns it. @param space_id @param id The id of the transaction voids which should be returned. @param [Hash] opts the optional parameters @return [TransactionVoid]

# File lib/postfinancecheckout-ruby-sdk/api/transaction_void_service_api.rb, line 94
def read(space_id, id, opts = {})
  data, _status_code, _headers = read_with_http_info(space_id, id, opts)
  return data
end
read_with_http_info(space_id, id, opts = {}) click to toggle source

Read Reads the entity with the given &#39;id&#39; and returns it. @param space_id @param id The id of the transaction voids which should be returned. @param [Hash] opts the optional parameters @return [Array<(TransactionVoid, Fixnum, Hash)>] TransactionVoid data, response status code and response headers

# File lib/postfinancecheckout-ruby-sdk/api/transaction_void_service_api.rb, line 105
def read_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionVoidService.read ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TransactionVoidService.read" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling TransactionVoidService.read" if id.nil?
  # resource path
  local_var_path = "/transaction-void/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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 => 'TransactionVoid')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionVoidService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
search_with_http_info(space_id, query, opts = {}) click to toggle source

Search Searches for the entities as specified by the given query. @param space_id @param query The query restricts the transaction voids which are returned by the search. @param [Hash] opts the optional parameters @return [Array<(Array<TransactionVoid>, Fixnum, Hash)>] Array<TransactionVoid> data, response status code and response headers

# File lib/postfinancecheckout-ruby-sdk/api/transaction_void_service_api.rb, line 168
def search_with_http_info(space_id, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionVoidService.search ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TransactionVoidService.search" if space_id.nil?
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling TransactionVoidService.search" if query.nil?
  # resource path
  local_var_path = "/transaction-void/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  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 => 'Array<TransactionVoid>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionVoidService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
void_offline(space_id, id, opts = {}) click to toggle source

voidOffline This operation voids the transaction offline. The void is not forwarded to the processor. This implies the processor does not do anything. This method is only here to fix manually the transaction state. @param space_id @param id The id of the transaction which should be voided. @param [Hash] opts the optional parameters @return [TransactionVoid]

# File lib/postfinancecheckout-ruby-sdk/api/transaction_void_service_api.rb, line 219
def void_offline(space_id, id, opts = {})
  data, _status_code, _headers = void_offline_with_http_info(space_id, id, opts)
  return data
end
void_offline_with_http_info(space_id, id, opts = {}) click to toggle source

voidOffline This operation voids the transaction offline. The void is not forwarded to the processor. This implies the processor does not do anything. This method is only here to fix manually the transaction state. @param space_id @param id The id of the transaction which should be voided. @param [Hash] opts the optional parameters @return [Array<(TransactionVoid, Fixnum, Hash)>] TransactionVoid data, response status code and response headers

# File lib/postfinancecheckout-ruby-sdk/api/transaction_void_service_api.rb, line 230
def void_offline_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionVoidService.void_offline ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TransactionVoidService.void_offline" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling TransactionVoidService.void_offline" if id.nil?
  # resource path
  local_var_path = "/transaction-void/voidOffline".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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 => 'TransactionVoid')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionVoidService#void_offline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
void_online(space_id, id, opts = {}) click to toggle source

voidOnline This operation voids the transaction online. The void is forwarded to the processor. This implies that the processor may take some actions based on the void. @param space_id @param id The id of the transaction which should be voided. @param [Hash] opts the optional parameters @return [TransactionVoid]

# File lib/postfinancecheckout-ruby-sdk/api/transaction_void_service_api.rb, line 282
def void_online(space_id, id, opts = {})
  data, _status_code, _headers = void_online_with_http_info(space_id, id, opts)
  return data
end
void_online_with_http_info(space_id, id, opts = {}) click to toggle source

voidOnline This operation voids the transaction online. The void is forwarded to the processor. This implies that the processor may take some actions based on the void. @param space_id @param id The id of the transaction which should be voided. @param [Hash] opts the optional parameters @return [Array<(TransactionVoid, Fixnum, Hash)>] TransactionVoid data, response status code and response headers

# File lib/postfinancecheckout-ruby-sdk/api/transaction_void_service_api.rb, line 293
def void_online_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionVoidService.void_online ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling TransactionVoidService.void_online" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling TransactionVoidService.void_online" if id.nil?
  # resource path
  local_var_path = "/transaction-void/voidOnline".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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