Class: PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt

Defined in:

lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb,
sig/prelude_sdk/models/verification/phone/history_retrieve_response.rbs

Overview

See Also:

• PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event#attempt

Defined Under Namespace

Modules: Channel, DeliveryStatus, PreferredChannel, Status, Trigger Classes: DeliveryEvent

Instance Attribute Summary

• #carrier ⇒ PreludeSDK::Models::Verification::Phone::PhoneVerificationCarrier^?

  The end user's mobile network.

• #channel ⇒ Symbol, ...
• #content ⇒ String^?

  Message body.

• #cost ⇒ PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney^?
• #created_at ⇒ Time
• #delivery_events ⇒ Array<PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent>^?
• #delivery_status ⇒ Symbol, ...
• #id ⇒ String
• #preferred_channel ⇒ Symbol, ...

  Channel you asked for, when it differs from the one used.

• #status ⇒ Symbol, ...
• #trigger ⇒ Symbol, ...

  What caused the attempt.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, created_at:, carrier: nil, channel: nil, content: nil, cost: nil, delivery_events: nil, delivery_status: nil, preferred_channel: nil, status: nil, trigger: nil) ⇒ Object constructor

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

• #to_hash ⇒ {

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(id:, created_at:, carrier: nil, channel: nil, content: nil, cost: nil, delivery_events: nil, delivery_status: nil, preferred_channel: nil, status: nil, trigger: nil) ⇒ Object

Some parameter documentations has been truncated, see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt for more details.

One message sent for this verification.

Parameters:

• id (String)
• created_at (Time)
• carrier (PreludeSDK::Models::Verification::Phone::PhoneVerificationCarrier) (defaults to: nil) —

  The end user's mobile network.

• channel (Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel) (defaults to: nil)
• content (String) (defaults to: nil) —

  Message body. While the verification can still be completed, the code inside it

• cost (PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney) (defaults to: nil)
• delivery_events (Array<PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent>) (defaults to: nil)
• delivery_status (Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus) (defaults to: nil)
• preferred_channel (Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel) (defaults to: nil) —

  Channel you asked for, when it differs from the one used.

• status (Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status) (defaults to: nil)
• trigger (Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger) (defaults to: nil) —

  What caused the attempt.

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 470

Instance Attribute Details

#carrier ⇒ PreludeSDK::Models::Verification::Phone::PhoneVerificationCarrier^?

The end user's mobile network.

Returns:

• (PreludeSDK::Models::Verification::Phone::PhoneVerificationCarrier, nil)

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 418

optional :carrier, -> { PreludeSDK::Verification::Phone::PhoneVerificationCarrier }

#channel ⇒ Symbol, ...

Returns:

• (Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel, nil)

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 423

optional :channel,
enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel }

#content ⇒ String^?

Message body. While the verification can still be completed, the code inside it is masked rather than removed.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 431

optional :content, String

#cost ⇒ PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney^?

Returns:

• (PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney, nil)

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 436

optional :cost, -> { PreludeSDK::Verification::Phone::PhoneVerificationMoney }

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 412

required :created_at, Time

#delivery_events ⇒ Array<PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent>^?

Returns:

• (Array<PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent>, nil)

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 441

optional :delivery_events,
-> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent] }

#delivery_status ⇒ Symbol, ...

Returns:

• (Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus, nil)

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 447

optional :delivery_status,
enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus }

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 407

required :id, String

#preferred_channel ⇒ Symbol, ...

Channel you asked for, when it differs from the one used.

Returns:

• (Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel, nil)

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 454

optional :preferred_channel,
enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel }

#status ⇒ Symbol, ...

Returns:

• (Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status, nil)

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 460

optional :status,
enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status }

#trigger ⇒ Symbol, ...

What caused the attempt.

Returns:

• (Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger, nil)

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 467

optional :trigger,
enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 512

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/prelude_sdk/models/verification/phone/history_retrieve_response.rbs', line 432

def to_hash: -> {