Class: Telnyx::Models::EmailEventListResponse::Data

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

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::Data for more details.

Parameters:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/telnyx/models/email_event_list_response.rb', line 21

class Data < Telnyx::Internal::Type::BaseModel
  # @!attribute id
  #
  #   @return [String]
  required :id, String

  # @!attribute email_id
  #
  #   @return [String]
  required :email_id, String

  # @!attribute occurred_at
  #
  #   @return [Time]
  required :occurred_at, Time

  # @!attribute record_type
  #
  #   @return [Symbol, Telnyx::Models::EmailEventListResponse::Data::RecordType]
  required :record_type, enum: -> { Telnyx::Models::EmailEventListResponse::Data::RecordType }

  # @!attribute type
  #
  #   @return [Symbol, Telnyx::Models::EmailEventType]
  required :type, enum: -> { Telnyx::EmailEventType }

  # @!attribute email
  #   Summary of the associated email message. Present when the email_message preload
  #   is available.
  #
  #   @return [Telnyx::Models::EmailEventListResponse::Data::Email, nil]
  optional :email, -> { Telnyx::Models::EmailEventListResponse::Data::Email }

  # @!attribute payload
  #
  #   @return [Hash{Symbol=>Object}, nil]
  optional :payload, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

  # @!method initialize(id:, email_id:, occurred_at:, record_type:, type:, email: nil, payload: nil)
  #   Some parameter documentations has been truncated, see
  #   {Telnyx::Models::EmailEventListResponse::Data} for more details.
  #
  #   @param id [String]
  #
  #   @param email_id [String]
  #
  #   @param occurred_at [Time]
  #
  #   @param record_type [Symbol, Telnyx::Models::EmailEventListResponse::Data::RecordType]
  #
  #   @param type [Symbol, Telnyx::Models::EmailEventType]
  #
  #   @param email [Telnyx::Models::EmailEventListResponse::Data::Email] Summary of the associated email message. Present when the email_message preload
  #
  #   @param payload [Hash{Symbol=>Object}]

  # @see Telnyx::Models::EmailEventListResponse::Data#record_type
  module RecordType
    extend Telnyx::Internal::Type::Enum

    EMAIL_EVENT = :email_event

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Telnyx::Models::EmailEventListResponse::Data#email
  class Email < Telnyx::Internal::Type::BaseModel
    # @!attribute cc
    #
    #   @return [Array<Telnyx::Models::EmailInboxes::EmailAddress>]
    required :cc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailAddress] }

    # @!attribute from
    #
    #   @return [Telnyx::Models::EmailInboxes::EmailAddress]
    required :from, -> { Telnyx::EmailInboxes::EmailAddress }

    # @!attribute subject
    #
    #   @return [String]
    required :subject, String

    # @!attribute to
    #
    #   @return [Array<Telnyx::Models::EmailInboxes::EmailAddress>]
    required :to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailAddress] }

    # @!method initialize(cc:, from:, subject:, to:)
    #   Summary of the associated email message. Present when the email_message preload
    #   is available.
    #
    #   @param cc [Array<Telnyx::Models::EmailInboxes::EmailAddress>]
    #   @param from [Telnyx::Models::EmailInboxes::EmailAddress]
    #   @param subject [String]
    #   @param to [Array<Telnyx::Models::EmailInboxes::EmailAddress>]
  end
end

Instance Attribute Details

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

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

Returns:



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

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

#email_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :email_id, String

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#occurred_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :occurred_at, Time

#payload ⇒ Hash{Symbol=>Object}?

Parameters:

  • (::Hash[Symbol, top])

Returns:

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


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

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

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

Parameters:

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

Returns:



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

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

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

Parameters:

  • value (Telnyx::Models::email_event_type)

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {