Exception: MaxApiClient::ApiError

Inherits:
Error
  • Object
show all
Defined in:
lib/max_api_client/error.rb,
sig/max_api_client.rbs

Overview

Error raised for non-successful API responses.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(status, response = {}) ⇒ ApiError

Returns a new instance of ApiError.



11
12
13
14
15
 
# File 'lib/max_api_client/error.rb', line 11

def initialize(status, response = {})
  @status = status
  @response = response || {}
  super("#{status}: #{description}")
end

Instance Attribute Details

#response ⇒ Object (readonly)

Returns the value of attribute response.

Returns:

  • (Object) 


9
10
11
 
# File 'lib/max_api_client/error.rb', line 9

def response
  @response
end

#status ⇒ Integer (readonly)

Returns the value of attribute status.

Returns:

  • (Integer) 


9
10
11
 
# File 'lib/max_api_client/error.rb', line 9

def status
  @status
end

Instance Method Details

#code ⇒ Object

Returns:

  • (Object) 


17
18
19
 
# File 'lib/max_api_client/error.rb', line 17

def code
  response["code"] || response[:code]
end

#description ⇒ String

Returns:

  • (String) 


21
22
23
 
# File 'lib/max_api_client/error.rb', line 21

def description
  response["message"] || response[:message] || "Unknown API error"
end