Contents

module Tide
  module API
    # An error resulting from an API call
    class Error < Dry::Struct::Value
      # A code that uniquely identifies the error
      #
      # @return [Integer]
      #
      attribute :code, Types::Strict::Integer

      # A human readable description of the code
      #
      # @return [String]
      #
      attribute :message, Types::Strict::String

      # A long description of the error. Unfortunately, it is null most of the time.
      #
      # @return [String|nil]
      #
      attribute :details, Types::Strict::String.optional
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
tide-api-0.4.0	lib/tide/api/error.rb
tide-api-0.3.0	lib/tide/api/error.rb
tide-api-0.2.0	lib/tide/api/error.rb