Exception: Smartsheet::ApiError

Inherits:
HttpResponseError show all
Extended by:
Forwardable
Defined in:
lib/smartsheet/error.rb

Overview

Errors for Smartsheet API error objects

See Also:

Instance Attribute Summary collapse

Attributes inherited from HttpResponseError

#headers, #reason_phrase, #status_code

Instance Method Summary collapse

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.message
  )
  @error_response = error_response
end

Instance Attribute Details

#detail ⇒ Hash, ... (readonly)

Returns optional details for some error scenarios.

Returns:

  • (Hash, Array, nil) —

    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.message
    )
    @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.

Returns:

  • (Fixnum) —

    Smartsheet error code

See Also:



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.message
    )
    @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.

Returns:

  • (String) —

    Smartsheet error message

See Also:



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.message
    )
    @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.

Returns:

  • (String) —

    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.message
    )
    @error_response = error_response
  end

  def_delegators :error_response, :error_code, :message, :ref_id, :detail

  private

  attr_reader :error_response
end