Exception: ComplyanceSDK::Exceptions::APIError

Inherits:

SDKException

• Object
• StandardError
• SDKException
• ComplyanceSDK::Exceptions::APIError

Defined in:

lib/complyance_sdk/exceptions/sdk_exception.rb

Overview

Exception raised when an API error occurs

Instance Attribute Summary

• #status_code ⇒ Object readonly

  HTTP status code.

Attributes inherited from SDKException

#code, #context, #suggestion

Instance Method Summary

• #error_detail ⇒ Hash

  Get error detail (alias for context).

• #initialize(message = "API error", status_code: nil, **kwargs) ⇒ APIError constructor

  Initialize a new API error.

• #to_h ⇒ Hash

  Convert the exception to a hash.

Constructor Details

#initialize(message = "API error", status_code: nil, **kwargs) ⇒ APIError

Initialize a new API error

Parameters:

• message (String) (defaults to: "API error") —

  Error message

• status_code (Integer) (defaults to: nil) —

  HTTP status code

• kwargs (Hash) —

  Additional arguments

# File 'lib/complyance_sdk/exceptions/sdk_exception.rb', line 73

def initialize(message = "API error", status_code: nil, **kwargs)
  super(message, code: :api_error, **kwargs)
  @status_code = status_code
end

Instance Attribute Details

#status_code ⇒ Object (readonly)

HTTP status code

# File 'lib/complyance_sdk/exceptions/sdk_exception.rb', line 66

def status_code
  @status_code
end

Instance Method Details

#error_detail ⇒ Hash

Get error detail (alias for context)

Returns:

• (Hash) —

  Error detail hash

# File 'lib/complyance_sdk/exceptions/sdk_exception.rb', line 81

def error_detail
  @context
end

#to_h ⇒ Hash

Convert the exception to a hash

Returns:

• (Hash) —

  The exception as a hash

# File 'lib/complyance_sdk/exceptions/sdk_exception.rb', line 88

def to_h
  super.merge(status_code: @status_code)
end