Class: Telnyx::Models::InboundMessage

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

Defined Under Namespace

Modules: Direction, RecordType, Status Classes: Bcc, Cc, From, ReplyTo, To

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(email:, name: nil) ⇒ Object

Parameters:

  • email (String)
  • name (String) (defaults to: nil) 



# File 'lib/telnyx/models/inbound_message.rb', line 220

Instance Attribute Details

#attachments ⇒ Array<Hash{Symbol=>Object}>

Parameters:

  • value (::Array[::Hash[Symbol, top]])

Returns:

  • (Array<Hash{Symbol=>Object}>) 


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

required :attachments,
Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]

#bcc ⇒ Array<Telnyx::Models::InboundMessage::Bcc>

Parameters:

  • value (::Array[Telnyx::InboundMessage::Bcc])

Returns:



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

required :bcc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage::Bcc] }

#cc ⇒ Array<Telnyx::Models::InboundMessage::Cc>

Parameters:

  • value (::Array[Telnyx::InboundMessage::Cc])

Returns:



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

required :cc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage::Cc] }

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :created_at, Time

#direction ⇒ Symbol, Telnyx::Models::InboundMessage::Direction

Parameters:

  • value (Telnyx::Models::InboundMessage::direction)

Returns:



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

required :direction, enum: -> { Telnyx::InboundMessage::Direction }

#from ⇒ Telnyx::Models::InboundMessage::From

Parameters:

  • value (Telnyx::InboundMessage::From)

Returns:



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

required :from, -> { Telnyx::InboundMessage::From }

#has_quoted_text ⇒ Boolean

Whether conservative plain-text extraction detected a quoted tail. False does not prove that the source contains no quoted content.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


47
 
# File 'lib/telnyx/models/inbound_message.rb', line 47

required :has_quoted_text, Telnyx::Internal::Type::Boolean

#headers ⇒ Hash{Symbol=>Object}

Parameters:

  • value (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}) 


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

required :headers, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#html_body_url ⇒ String?

URL for an offloaded HTML body. Null means the body is not offloaded to a URL; an inline HTML body may still exist but is not returned on list reads. reply_text and has_quoted_text are computed from the inline plain-text body when present.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


61
 
# File 'lib/telnyx/models/inbound_message.rb', line 61

required :html_body_url, String, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


9
 
# File 'lib/telnyx/models/inbound_message.rb', line 9

required :id, String

#in_reply_to ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


66
 
# File 'lib/telnyx/models/inbound_message.rb', line 66

required :in_reply_to, String, nil?: true

#inbox_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


71
 
# File 'lib/telnyx/models/inbound_message.rb', line 71

required :inbox_id, String

#inline_files ⇒ Array<Hash{Symbol=>Object}>

Parameters:

  • value (::Array[::Hash[Symbol, top]])

Returns:

  • (Array<Hash{Symbol=>Object}>) 


76
77
 
# File 'lib/telnyx/models/inbound_message.rb', line 76

required :inline_files,
Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]

#message_id ⇒ String

RFC Message-ID header.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :message_id, String

#read_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


88
 
# File 'lib/telnyx/models/inbound_message.rb', line 88

required :read_at, Time, nil?: true

#received_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


93
 
# File 'lib/telnyx/models/inbound_message.rb', line 93

required :received_at, Time

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

Parameters:

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

Returns:



98
 
# File 'lib/telnyx/models/inbound_message.rb', line 98

required :record_type, enum: -> { Telnyx::InboundMessage::RecordType }

#references ⇒ Array<String>

Ordered RFC Message-ID values from the References header.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


104
 
# File 'lib/telnyx/models/inbound_message.rb', line 104

required :references, Telnyx::Internal::Type::ArrayOf[String]

#reply_text ⇒ String?

Conservatively extracted new-reply content from the available plain-text body. Null means no plain-text body was available because it was absent or offloaded; HTML bodies are not parsed.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


112
 
# File 'lib/telnyx/models/inbound_message.rb', line 112

required :reply_text, String, nil?: true

#reply_to ⇒ Array<Telnyx::Models::InboundMessage::ReplyTo>

Parameters:

  • value (::Array[Telnyx::InboundMessage::ReplyTo])

Returns:



117
 
# File 'lib/telnyx/models/inbound_message.rb', line 117

required :reply_to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage::ReplyTo] }

#status ⇒ Symbol, Telnyx::Models::InboundMessage::Status

Parameters:

  • value (Telnyx::Models::InboundMessage::status)

Returns:



122
 
# File 'lib/telnyx/models/inbound_message.rb', line 122

required :status, enum: -> { Telnyx::InboundMessage::Status }

#subject ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


127
 
# File 'lib/telnyx/models/inbound_message.rb', line 127

required :subject, String, nil?: true

#text_body_url ⇒ String?

URL for an offloaded plain-text body. Null means the body is not offloaded to a URL; an inline plain-text body may still exist but is not returned on list reads. reply_text and has_quoted_text are computed from the inline plain-text body when present.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


136
 
# File 'lib/telnyx/models/inbound_message.rb', line 136

required :text_body_url, String, nil?: true

#thread_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


141
 
# File 'lib/telnyx/models/inbound_message.rb', line 141

required :thread_id, String

#to ⇒ Array<Telnyx::Models::InboundMessage::To>

Parameters:

  • value (::Array[Telnyx::InboundMessage::To])

Returns:



146
 
# File 'lib/telnyx/models/inbound_message.rb', line 146

required :to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::InboundMessage::To] }

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


151
 
# File 'lib/telnyx/models/inbound_message.rb', line 151

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/inbound_message.rb', line 247

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


115
 
# File 'sig/telnyx/models/inbound_message.rbs', line 115

def to_hash: -> {