Class: Telnyx::Models::EmailEventListResponse

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

Overview

See Also:

  • Telnyx::Resources::EmailEvents#list

Defined Under Namespace

Modules: RecordType Classes: Email

Instance Attribute Summary collapse

Class Method 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(id:, email_id:, occurred_at:, record_type:, type:, email: nil, payload: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::EmailEventListResponse for more details.

Parameters:




# File 'lib/telnyx/models/email_event_list_response.rb', line 44

Instance Attribute Details

#email ⇒ Telnyx::Models::EmailEventListResponse::Email?

Summary of the associated email message. Present when the email_message preload is available.

Returns:



37
 
# File 'lib/telnyx/models/email_event_list_response.rb', line 37

optional :email, -> { Telnyx::Models::EmailEventListResponse::Email }

#email_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/telnyx/models/email_event_list_response.rb', line 15

required :email_id, String

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/telnyx/models/email_event_list_response.rb', line 10

required :id, String

#occurred_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


20
 
# File 'lib/telnyx/models/email_event_list_response.rb', line 20

required :occurred_at, Time

#payload ⇒ Hash{Symbol=>Object}?

Parameters:

  • (::Hash[Symbol, top])

Returns:

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


42
 
# File 'lib/telnyx/models/email_event_list_response.rb', line 42

optional :payload, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#record_type ⇒ Symbol, Telnyx::Models::EmailEventListResponse::RecordType

Parameters:

  • value (Telnyx::Models::EmailEventListResponse::record_type)

Returns:



25
 
# File 'lib/telnyx/models/email_event_list_response.rb', line 25

required :record_type, enum: -> { Telnyx::Models::EmailEventListResponse::RecordType }

#type ⇒ Symbol, Telnyx::Models::EmailEventType

Parameters:

  • value (Telnyx::Models::email_event_type)

Returns:



30
 
# File 'lib/telnyx/models/email_event_list_response.rb', line 30

required :type, enum: -> { Telnyx::EmailEventType }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/email_event_list_response.rb', line 68

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


45
 
# File 'sig/telnyx/models/email_event_list_response.rbs', line 45

def to_hash: -> {