Class: Orb::Models::EventIngestResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/event_ingest_response.rb,
sig/orb/models/event_ingest_response.rbs

Overview

See Also:

  • Orb::Resources::Events#ingest

Defined Under Namespace

Classes: Debug, ValidationFailed

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(idempotency_key:, validation_errors:) ⇒ Object

Some parameter documentations has been truncated, see ValidationFailed for more details.

Parameters:

  • idempotency_key (String) —

    The passed idempotency_key corresponding to the validation_errors

  • validation_errors (Array<String>) —

    An array of strings corresponding to validation failures for this idempotency_ke




# File 'lib/orb/models/event_ingest_response.rb', line 44

Instance Attribute Details

#debug ⇒ Orb::Models::EventIngestResponse::Debug?

Optional debug information (only present when debug=true is passed to the endpoint). Contains ingested and duplicate event idempotency keys.

Parameters:

Returns:



20
 
# File 'lib/orb/models/event_ingest_response.rb', line 20

optional :debug, -> { Orb::Models::EventIngestResponse::Debug }, nil?: true

#validation_failed ⇒ Array<Orb::Models::EventIngestResponse::ValidationFailed>

Contains all failing validation events. In the case of a 200, this array will always be empty. This field will always be present.

Parameters:

Returns:



12
13
 
# File 'lib/orb/models/event_ingest_response.rb', line 12

required :validation_failed,
-> { Orb::Internal::Type::ArrayOf[Orb::Models::EventIngestResponse::ValidationFailed] }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


19
 
# File 'sig/orb/models/event_ingest_response.rbs', line 19

def to_hash: -> {