Class: Sentdm::Models::ErrorDetail

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/sentdm/models/error_detail.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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(code: nil, details: nil, doc_url: nil, message: nil) ⇒ Object

Error information

Parameters:

  • code (String) (defaults to: nil) —

    Machine-readable error code (e.g., “RESOURCE_001”)

  • details (Hash{Symbol=>Array<String>}, nil) (defaults to: nil) —

    Additional validation error details (field-level errors)

  • doc_url (String, nil) (defaults to: nil) —

    URL to documentation about this error

  • message (String) (defaults to: nil) —

    Human-readable error message




# File 'lib/sentdm/models/error_detail.rb', line 30

Instance Attribute Details

#code ⇒ String?

Machine-readable error code (e.g., “RESOURCE_001”)

Returns:

  • (String, nil) 


10
 
# File 'lib/sentdm/models/error_detail.rb', line 10

optional :code, String

#details ⇒ Hash{Symbol=>Array<String>}?

Additional validation error details (field-level errors)

Returns:

  • (Hash{Symbol=>Array<String>}, nil) 


16
 
# File 'lib/sentdm/models/error_detail.rb', line 16

optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true

#doc_url ⇒ String?

URL to documentation about this error

Returns:

  • (String, nil) 


22
 
# File 'lib/sentdm/models/error_detail.rb', line 22

optional :doc_url, String, nil?: true

#message ⇒ String?

Human-readable error message

Returns:

  • (String, nil) 


28
 
# File 'lib/sentdm/models/error_detail.rb', line 28

optional :message, String