Exception: Hanko::ApiError

Inherits:

Error

• Object
• StandardError
• Error
• Hanko::ApiError

Defined in:

lib/hanko/errors.rb

Overview

Raised when the Hanko API returns an HTTP 4xx or 5xx response.

Direct Known Subclasses

AuthenticationError, NotFoundError, RateLimitError

Instance Attribute Summary

• #body ⇒ Hash^? readonly

  The parsed response body.

• #status ⇒ Integer^? readonly

  The HTTP status code.

Instance Method Summary

• #initialize(message = nil, status: nil, body: nil) ⇒ ApiError constructor

  A new instance of ApiError.

Constructor Details

#initialize(message = nil, status: nil, body: nil) ⇒ ApiError

Returns a new instance of ApiError.

Parameters:

• message (String, nil) (defaults to: nil) —

  the error message

• status (Integer, nil) (defaults to: nil) —

  the HTTP status code

• body (Hash, nil) (defaults to: nil) —

  the parsed response body

# File 'lib/hanko/errors.rb', line 33

def initialize(message = nil, status: nil, body: nil)
  @status = status
  @body = body
  super(message)
end

Instance Attribute Details

#body ⇒ Hash^? (readonly)

Returns the parsed response body.

Returns:

• (Hash, nil) —

  the parsed response body

# File 'lib/hanko/errors.rb', line 28

def body
  @body
end

#status ⇒ Integer^? (readonly)

Returns the HTTP status code.

Returns:

• (Integer, nil) —

  the HTTP status code

# File 'lib/hanko/errors.rb', line 25

def status
  @status
end