class Ingenico::Direct::SDK::ApiException

Base class for many exceptions raised by the SDK. It is raised when an error response is received from the Ingenico ePayments platform. It contains data about the returned response.

@attr_reader [Integer] status_code HTTP status code of the returned response. @attr_reader [String] response_body Message body of the returned response. @attr_reader [String] error_id An error id corresponding to the error that occurred, if available. @attr_reader [Array<Ingenico::Direct::SDK::Domain::APIError>] errors A list of errors received from the Ingenico ePayments platform;

may be empty but never _nil_

Attributes

error_id[R]
errors[R]
response_body[R]
status_code[R]

Public Class Methods

new(status_code, response_body, error_id, errors, message = 'the Ingenico ePayments platform returned an error response') click to toggle source

Creates a new ApiException that reports an error response from the Ingenico ePayments platform.

@param status_code (Integer) HTTP status code the response @param response_body (String) HTTP response body @param error_id (String) error id of the error, may be nil @param errors (Array<Ingenico::Direct::SDK::Domain::APIError>) a list of errors that occurred, may be empty @param message (String) error message to include

Calls superclass method 
# File lib/ingenico/direct/sdk/api_exception.rb, line 21
def initialize(status_code, response_body, error_id, errors,
               message = 'the Ingenico ePayments platform returned an error response')
  super(message)
  @status_code = status_code
  @response_body = response_body
  @error_id = error_id
  @errors = errors || [].freeze
end

Public Instance Methods

to_s() click to toggle source
Calls superclass method 
# File lib/ingenico/direct/sdk/api_exception.rb, line 35
def to_s
  str = super.to_s
  str += "; status_code=#{@status_code}" if @status_code.positive?
  str += "; response_body='#{@response_body}'" if @response_body&.length&.positive?
  str.to_s
end