Class: SurgeAPI::Models::Error

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• SurgeAPI::Models::Error

Defined in:

lib/surge_api/models/error.rb

Instance Attribute Summary

• #detail ⇒ Hash{Symbol=>Object}^?

  Additional details about the error.

• #message ⇒ String

  A human-readable error message.

• #type ⇒ String

  A unique error code.

Instance Method Summary

• #initialize(message:, type:, detail: nil) ⇒ Object constructor

  An error response.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(message:, type:, detail: nil) ⇒ Object

An error response

Parameters:

• message (String) —

  A human-readable error message.

• type (String) —

  A unique error code.

• detail (Hash{Symbol=>Object}) (defaults to: nil) —

  Additional details about the error.

# File 'lib/surge_api/models/error.rb', line 24

Instance Attribute Details

#detail ⇒ Hash{Symbol=>Object}^?

Additional details about the error.

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/surge_api/models/error.rb', line 22

optional :detail, SurgeAPI::Internal::Type::HashOf[SurgeAPI::Internal::Type::Unknown]

#message ⇒ String

A human-readable error message.

Returns:

• (String)

# File 'lib/surge_api/models/error.rb', line 10

required :message, String

#type ⇒ String

A unique error code.

Returns:

• (String)

# File 'lib/surge_api/models/error.rb', line 16

required :type, String