Exception: CLX::CLXAPIException

Inherits:
Exception
  • Object
show all
Defined in:
lib/clx_api/exceptions/clx_api_exception.rb

Overview

CLX Exception Class for API request errors

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(clx_error_message = nil, clx_error_code = nil) ⇒ CLXAPIException

Initialize CLX Exception

Examples:

response = http_adapter.get('operator/99999999') #results in error from api
raise CLXException(response.error.message, response.error.body), ""

Parameters:

  • clx_error_message (String) (defaults to: nil)
  • clx_error_code (Integer) (defaults to: nil) 


18
19
20
21
 
# File 'lib/clx_api/exceptions/clx_api_exception.rb', line 18

def initialize(clx_error_message = nil, clx_error_code = nil)
  @clx_error_message = clx_error_message
  @clx_error_code = clx_error_code
end

Instance Attribute Details

#clx_error_code ⇒ Object (readonly)

Returns the value of attribute clx_error_code.



7
8
9
 
# File 'lib/clx_api/exceptions/clx_api_exception.rb', line 7

def clx_error_code
  @clx_error_code
end

#clx_error_message ⇒ Object (readonly)

Returns the value of attribute clx_error_message.



10
11
12
 
# File 'lib/clx_api/exceptions/clx_api_exception.rb', line 10

def clx_error_message
  @clx_error_message
end