Class: Tide::API::Error

Inherits:

Dry::Struct::Value

• Object
• Dry::Struct::Value
• Tide::API::Error

Defined in:

lib/tide/api/error.rb

Overview

An error resulting from an API call

Instance Method Summary

• #code ⇒ Integer

  A code that uniquely identifies the error.

• #details ⇒ String|nil

  A long description of the error.

• #message ⇒ String

  A human readable description of the code.

Instance Method Details

#code ⇒ Integer

A code that uniquely identifies the error

Returns:

• (Integer)

# File 'lib/tide/api/error.rb', line 9

attribute :code, Types::Strict::Integer

#details ⇒ String|nil

A long description of the error. Unfortunately, it is null most of the time.

Returns:

• (String|nil)

# File 'lib/tide/api/error.rb', line 21

attribute :details, Types::Strict::String.optional

#message ⇒ String

A human readable description of the code

Returns:

• (String)

# File 'lib/tide/api/error.rb', line 15

attribute :message, Types::Strict::String