Exception: Hellio::Error

Inherits:
StandardError
  • Object
show all
Defined in:
lib/hellio/errors.rb

Overview

Base error for every failure returned by the Hellio Messaging API. Carries the HTTP status code and the parsed response body so callers can inspect the details (for 422, read #errors for field-level messages).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message = nil, status_code: nil, response: nil) ⇒ Error

Returns a new instance of Error.



10
11
12
13
14
# File 'lib/hellio/errors.rb', line 10

def initialize(message = nil, status_code: nil, response: nil)
  super(message)
  @status_code = status_code
  @response = response
end

Instance Attribute Details

#responseObject (readonly)

Returns the value of attribute response.



8
9
10
# File 'lib/hellio/errors.rb', line 8

def response
  @response
end

#status_codeObject (readonly)

Returns the value of attribute status_code.



8
9
10
# File 'lib/hellio/errors.rb', line 8

def status_code
  @status_code
end

Instance Method Details

#errorsObject

Field-level validation details, present on 422 responses.



17
18
19
20
21
# File 'lib/hellio/errors.rb', line 17

def errors
  return nil unless response.is_a?(Hash)

  response["errors"]
end