Class: Telnyx::Models::EmailInboxes::EmailDraftRequest

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::EmailInboxes::EmailDraftRequest

Defined in:

lib/telnyx/models/email_inboxes/email_draft_request.rb,
sig/telnyx/models/email_inboxes/email_draft_request.rbs

Direct Known Subclasses

DraftCreateParams, DraftPatchParams, DraftUpdateParams, MessageDraftsParams

Instance Attribute Summary

• #attachments ⇒ Array<Hash{Symbol=>Object}>^?
• #bcc ⇒ Array<String, Telnyx::Models::EmailInboxes::EmailAddress>^?
• #cc ⇒ Array<String, Telnyx::Models::EmailInboxes::EmailAddress>^?
• #from_email ⇒ String^?
• #from_name ⇒ String^?
• #headers ⇒ Hash{Symbol=>String}^?
• #html ⇒ String^?

  Alias for html_body, matching the send endpoint.

• #html_body ⇒ String^?
• #labels ⇒ Array<String>^?
• #metadata ⇒ Hash{Symbol=>Object}^?
• #reply_to ⇒ String^?
• #subject ⇒ String^?
• #tags ⇒ Array<String>^?
• #text ⇒ String^?

  Alias for text_body, matching the send endpoint.

• #text_body ⇒ String^?
• #to ⇒ Array<String, Telnyx::Models::EmailInboxes::EmailAddress>^?

Instance Method Summary

• #initialize(attachments: nil, bcc: nil, cc: nil, from_email: nil, from_name: nil, headers: nil, html: nil, html_body: nil, labels: nil, metadata: nil, reply_to: nil, subject: nil, tags: nil, text: nil, text_body: nil, to: nil) ⇒ Object constructor

  All fields are optional — a draft may be saved incomplete.

• #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(attachments: nil, bcc: nil, cc: nil, from_email: nil, from_name: nil, headers: nil, html: nil, html_body: nil, labels: nil, metadata: nil, reply_to: nil, subject: nil, tags: nil, text: nil, text_body: nil, to: nil) ⇒ Object

All fields are optional — a draft may be saved incomplete. account_id, inbox_id, status, sent_at, sent_message_id, reply_to_message_id and thread_id are server-owned and ignored if supplied.

Parameters:

• attachments (Array<Hash{Symbol=>Object}>) (defaults to: nil)
• bcc (Array<String, Telnyx::Models::EmailInboxes::EmailAddress>) (defaults to: nil)
• cc (Array<String, Telnyx::Models::EmailInboxes::EmailAddress>) (defaults to: nil)
• from_email (String) (defaults to: nil)
• from_name (String) (defaults to: nil)
• headers (Hash{Symbol=>String}) (defaults to: nil)
• html (String) (defaults to: nil) —

  Alias for html_body, matching the send endpoint.

• html_body (String) (defaults to: nil)
• labels (Array<String>) (defaults to: nil)
• metadata (Hash{Symbol=>Object}) (defaults to: nil)
• reply_to (String) (defaults to: nil)
• subject (String) (defaults to: nil)
• tags (Array<String>) (defaults to: nil)
• text (String) (defaults to: nil) —

  Alias for text_body, matching the send endpoint.

• text_body (String) (defaults to: nil)
• to (Array<String, Telnyx::Models::EmailInboxes::EmailAddress>) (defaults to: nil)

# File 'lib/telnyx/models/email_inboxes/email_draft_request.rb', line 90

Instance Attribute Details

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

Returns:

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

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

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

#bcc ⇒ Array<String, Telnyx::Models::EmailInboxes::EmailAddress>^?

Returns:

• (Array<String, Telnyx::Models::EmailInboxes::EmailAddress>, nil)

# File 'lib/telnyx/models/email_inboxes/email_draft_request.rb', line 16

optional :bcc, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::EmailAddressInput] }

#cc ⇒ Array<String, Telnyx::Models::EmailInboxes::EmailAddress>^?

Returns:

• (Array<String, Telnyx::Models::EmailInboxes::EmailAddress>, nil)

# File 'lib/telnyx/models/email_inboxes/email_draft_request.rb', line 21

optional :cc, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::EmailAddressInput] }

#from_email ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_inboxes/email_draft_request.rb', line 26

optional :from_email, String

#from_name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_inboxes/email_draft_request.rb', line 31

optional :from_name, String

#headers ⇒ Hash{Symbol=>String}^?

Parameters:

• (::Hash[Symbol, String])

Returns:

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

# File 'lib/telnyx/models/email_inboxes/email_draft_request.rb', line 36

optional :headers, Telnyx::Internal::Type::HashOf[String]

#html ⇒ String^?

Alias for html_body, matching the send endpoint.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :html, String

#html_body ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :html_body, String

#labels ⇒ Array<String>^?

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

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

optional :labels, Telnyx::Internal::Type::ArrayOf[String]

#metadata ⇒ Hash{Symbol=>Object}^?

Parameters:

• (::Hash[Symbol, top])

Returns:

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

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

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

#reply_to ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_inboxes/email_draft_request.rb', line 62

optional :reply_to, String

#subject ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_inboxes/email_draft_request.rb', line 67

optional :subject, String

#tags ⇒ Array<String>^?

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/telnyx/models/email_inboxes/email_draft_request.rb', line 72

optional :tags, Telnyx::Internal::Type::ArrayOf[String]

#text ⇒ String^?

Alias for text_body, matching the send endpoint.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_inboxes/email_draft_request.rb', line 78

optional :text, String

#text_body ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :text_body, String

#to ⇒ Array<String, Telnyx::Models::EmailInboxes::EmailAddress>^?

Returns:

• (Array<String, Telnyx::Models::EmailInboxes::EmailAddress>, nil)

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

optional :to, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::EmailAddressInput] }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/email_inboxes/email_draft_request.rbs', line 116

def to_hash: -> {