Class: UnivapayClientSdk::ApiErrorException

Inherits:

APIException

Object
CoreLibrary::ApiException
APIException
UnivapayClientSdk::ApiErrorException

show all

Defined in:: lib/univapay_client_sdk/exceptions/api_error_exception.rb

Overview

Standard API error response payload.

Instance Attribute Summary collapse

#code ⇒ String
API Request Error Codes.
#errors ⇒ Array[ApiErrorDetail]
List of detailed API errors.
#status ⇒ String readonly
Always returns 'error'.

Instance Method Summary collapse

#initialize(reason, response) ⇒ ApiErrorException constructor
The constructor.
#inspect ⇒ Object
Provides a debugging-friendly string with detailed object information.
#to_s ⇒ Object
Provides a human-readable string representation of the object.
#unbox(hash) ⇒ Object
Populates this object by extracting properties from a hash.

Constructor Details

#initialize(reason, response) ⇒ `ApiErrorException`

The constructor.

Parameters:

reason (String) —
The reason for raising an exception.
response (HttpResponse) —
The HttpReponse of the API call.

# File 'lib/univapay_client_sdk/exceptions/api_error_exception.rb', line 161

def initialize(reason, response)
  super(reason, response)
  hash = APIHelper.json_deserialize(@response.raw_body)
  unbox(hash)
end

Instance Attribute Details

#code ⇒ `String`

API Request Error Codes.

HTTP	Error Code	Description
400	ALREADY_CAPTURED	The target charge is already captured or
authorization is incomplete.
400	AUTH_NOT_SUPPORTED	The configured gateway does not support
authorization.
400	CANCEL_NOT_ALLOWED	This payment method does not support
cancellation, or the charge status cannot be canceled.
400	CANNOT_CHANGE_CANCELED_SUBSCRIPTION	A canceled subscription
cannot be modified.
400	CANNOT_CHANGE_TOKEN	The transaction token for a subscription in
this state cannot be changed.
400	CANNOT_REFUND_UNSUCCESSFUL_CHARGE	Charges in a state other than
'successful' cannot be refunded.
400	CAPTURE_AMOUNT_TOO_LARGE	The capture amount exceeds the
authorized amount.
400	CARD_BRAND_NOT_SUPPORTED	The configured gateway does not support
the specified card brand.
400	CARD_COUNTRY_NOT_SUPPORTED	The configured gateway does not
support the specified card issuing country.
400	CARD_PROCESSING_DISABLED	Card processing is disabled for this
payment method.
400	CHARGE_TOO_QUICK	Attempted to create multiple charges with the
same amount within 30 seconds for the same card or recurring token.
400	CONVENIENCE_PROCESSING_DISABLED	Konbini processing is disabled
for this payment method.
400	CURRENCY_MUST_MATCH_CHARGE	The refund currency must match the
original charge currency.
400	CVV_REQUIRED	CVV is required.
400	CVV_AUTHORIZATION_NOT_COMPLETED	CVV authorization failed.
400	FILE_INVALID_TYPE	The uploaded file has an incorrect MIME type.

Returns:

(String)



152
153
154

# File 'lib/univapay_client_sdk/exceptions/api_error_exception.rb', line 152

def code
  @code
end

#errors ⇒ `Array[ApiErrorDetail]`

List of detailed API errors.

Returns:

(Array[ApiErrorDetail])



156
157
158

# File 'lib/univapay_client_sdk/exceptions/api_error_exception.rb', line 156

def errors
  @errors
end

#status ⇒ `String` (readonly)

Always returns 'error'.

Returns:

(String)



14
15
16

# File 'lib/univapay_client_sdk/exceptions/api_error_exception.rb', line 14

def status
  @status
end

Instance Method Details

#inspect ⇒ `Object`

Provides a debugging-friendly string with detailed object information.

# File 'lib/univapay_client_sdk/exceptions/api_error_exception.rb', line 193

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} status: #{@status.inspect}, code: #{@code.inspect}, errors:"\
  " #{@errors.inspect}>"
end

#to_s ⇒ `Object`

Provides a human-readable string representation of the object.

# File 'lib/univapay_client_sdk/exceptions/api_error_exception.rb', line 187

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} status: #{@status}, code: #{@code}, errors: #{@errors}>"
end

#unbox(hash) ⇒ `Object`

Populates this object by extracting properties from a hash. response body.

Parameters:

hash (Hash) —
The deserialized response sent by the server in the

# File 'lib/univapay_client_sdk/exceptions/api_error_exception.rb', line 170

def unbox(hash)
  return nil unless hash

  @code = hash.key?('code') ? hash['code'] : nil
  # Parameter is an array, so we need to iterate through it
  @errors = nil
  unless hash['errors'].nil?
    @errors = []
    hash['errors'].each do |structure|
      @errors << (ApiErrorDetail.from_hash(structure) if structure)
    end
  end

  @errors = SKIP unless hash.key?('errors')
end

Class: UnivapayClientSdk::ApiErrorException

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(reason, response) ⇒ ApiErrorException

Instance Attribute Details

#code ⇒ String

#errors ⇒ Array[ApiErrorDetail]

#status ⇒ String (readonly)

Instance Method Details

#inspect ⇒ Object

#to_s ⇒ Object

#unbox(hash) ⇒ Object

#initialize(reason, response) ⇒ `ApiErrorException`

#code ⇒ `String`

#errors ⇒ `Array[ApiErrorDetail]`

#status ⇒ `String` (readonly)

#inspect ⇒ `Object`

#to_s ⇒ `Object`

#unbox(hash) ⇒ `Object`