Exception: Smartsheet::ApiError
- Inherits:
-
HttpResponseError
- Object
- StandardError
- Error
- HttpResponseError
- Smartsheet::ApiError
- Extended by:
- Forwardable
- Defined in:
- lib/smartsheet/error.rb
Overview
Errors for Smartsheet API error objects
Instance Attribute Summary collapse
-
#detail ⇒ Hash, ...
readonly
Optional details for some error scenarios.
-
#error_code ⇒ Fixnum
readonly
Smartsheet error code.
-
#message ⇒ String
readonly
Smartsheet error message.
-
#ref_id ⇒ String
readonly
Smartsheet error reference ID.
Attributes inherited from HttpResponseError
#headers, #reason_phrase, #status_code
Instance Method Summary collapse
-
#initialize(error_response) ⇒ ApiError
constructor
A new instance of ApiError.
Constructor Details
#initialize(error_response) ⇒ ApiError
Returns a new instance of ApiError.
54 55 56 57 58 59 60 61 62 |
# File 'lib/smartsheet/error.rb', line 54 def initialize(error_response) super( status_code: error_response.status_code, reason_phrase: error_response.reason_phrase, headers: error_response.headers, message: error_response. ) @error_response = error_response end |
Instance Attribute Details
#detail ⇒ Hash, ... (readonly)
Returns optional details for some error scenarios.
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/smartsheet/error.rb', line 51 class ApiError < HttpResponseError extend Forwardable def initialize(error_response) super( status_code: error_response.status_code, reason_phrase: error_response.reason_phrase, headers: error_response.headers, message: error_response. ) @error_response = error_response end def_delegators :error_response, :error_code, :message, :ref_id, :detail private attr_reader :error_response end |
#error_code ⇒ Fixnum (readonly)
Returns Smartsheet error code.
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/smartsheet/error.rb', line 51 class ApiError < HttpResponseError extend Forwardable def initialize(error_response) super( status_code: error_response.status_code, reason_phrase: error_response.reason_phrase, headers: error_response.headers, message: error_response. ) @error_response = error_response end def_delegators :error_response, :error_code, :message, :ref_id, :detail private attr_reader :error_response end |
#message ⇒ String (readonly)
Returns Smartsheet error message.
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/smartsheet/error.rb', line 51 class ApiError < HttpResponseError extend Forwardable def initialize(error_response) super( status_code: error_response.status_code, reason_phrase: error_response.reason_phrase, headers: error_response.headers, message: error_response. ) @error_response = error_response end def_delegators :error_response, :error_code, :message, :ref_id, :detail private attr_reader :error_response end |
#ref_id ⇒ String (readonly)
Returns Smartsheet error reference ID.
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/smartsheet/error.rb', line 51 class ApiError < HttpResponseError extend Forwardable def initialize(error_response) super( status_code: error_response.status_code, reason_phrase: error_response.reason_phrase, headers: error_response.headers, message: error_response. ) @error_response = error_response end def_delegators :error_response, :error_code, :message, :ref_id, :detail private attr_reader :error_response end |