Class: Telnyx::Models::EmailMessages::EmailRecipient

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

Defined Under Namespace

Modules: Kind, RecordType, Status

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:, address:, billable:, kind:, message_id:, record_type:, status:, delivered_at: nil, failed_at: nil, sent_at: nil, smtp_code: nil, smtp_response: nil) ⇒ Object

Parameters:

  • id (String) —

    Recipient UUID.

  • address (String, nil) —

    Recipient email address. Null for BCC recipients (redacted for privacy).

  • billable (Boolean) —

    Whether this recipient's delivery is billable (set on queue acceptance).

  • kind (Symbol, Telnyx::Models::EmailMessages::EmailRecipient::Kind)
  • message_id (String) —

    Parent email message UUID.

  • record_type (Symbol, Telnyx::Models::EmailMessages::EmailRecipient::RecordType)
  • status (Symbol, Telnyx::Models::EmailMessages::EmailRecipient::Status) —

    Current per-recipient delivery status.

  • delivered_at (Time, nil) (defaults to: nil)
  • failed_at (Time, nil) (defaults to: nil)
  • sent_at (Time, nil) (defaults to: nil)
  • smtp_code (Integer, nil) (defaults to: nil) —

    SMTP response code when available (e.g. 550 for bounces).

  • smtp_response (String, nil) (defaults to: nil) —

    SMTP response message when available.




# File 'lib/telnyx/models/email_messages/email_recipient.rb', line 74

Instance Attribute Details

#address ⇒ String?

Recipient email address. Null for BCC recipients (redacted for privacy).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


17
 
# File 'lib/telnyx/models/email_messages/email_recipient.rb', line 17

required :address, String, nil?: true

#billable ⇒ Boolean

Whether this recipient's delivery is billable (set on queue acceptance).

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


23
 
# File 'lib/telnyx/models/email_messages/email_recipient.rb', line 23

required :billable, Telnyx::Internal::Type::Boolean

#delivered_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


50
 
# File 'lib/telnyx/models/email_messages/email_recipient.rb', line 50

optional :delivered_at, Time, nil?: true

#failed_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


55
 
# File 'lib/telnyx/models/email_messages/email_recipient.rb', line 55

optional :failed_at, Time, nil?: true

#id ⇒ String

Recipient UUID.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/telnyx/models/email_messages/email_recipient.rb', line 11

required :id, String

#kind ⇒ Symbol, Telnyx::Models::EmailMessages::EmailRecipient::Kind

Parameters:

  • value (Telnyx::Models::EmailMessages::EmailRecipient::kind)

Returns:



28
 
# File 'lib/telnyx/models/email_messages/email_recipient.rb', line 28

required :kind, enum: -> { Telnyx::EmailMessages::EmailRecipient::Kind }

#message_id ⇒ String

Parent email message UUID.

Parameters:

  • value (String)

Returns:

  • (String) 


34
 
# File 'lib/telnyx/models/email_messages/email_recipient.rb', line 34

required :message_id, String

#record_type ⇒ Symbol, Telnyx::Models::EmailMessages::EmailRecipient::RecordType

Parameters:

  • value (Telnyx::Models::EmailMessages::EmailRecipient::record_type)

Returns:



39
 
# File 'lib/telnyx/models/email_messages/email_recipient.rb', line 39

required :record_type, enum: -> { Telnyx::EmailMessages::EmailRecipient::RecordType }

#sent_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


60
 
# File 'lib/telnyx/models/email_messages/email_recipient.rb', line 60

optional :sent_at, Time, nil?: true

#smtp_code ⇒ Integer?

SMTP response code when available (e.g. 550 for bounces).

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


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

optional :smtp_code, Integer, nil?: true

#smtp_response ⇒ String?

SMTP response message when available.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


72
 
# File 'lib/telnyx/models/email_messages/email_recipient.rb', line 72

optional :smtp_response, String, nil?: true

#status ⇒ Symbol, Telnyx::Models::EmailMessages::EmailRecipient::Status

Current per-recipient delivery status.

Parameters:

  • value (Telnyx::Models::EmailMessages::EmailRecipient::status)

Returns:



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

required :status, enum: -> { Telnyx::EmailMessages::EmailRecipient::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/email_messages/email_recipient.rb', line 107

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


60
 
# File 'sig/telnyx/models/email_messages/email_recipient.rbs', line 60

def to_hash: -> {