Class: Telnyx::Models::EmailDomain

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

Overview

See Also:

  • Telnyx::Resources::EmailDomains#list

Defined Under Namespace

Modules: RecordType Classes: Dkim, Inbound, Reputation

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(catch_all:, enabled:, mx_required:) ⇒ Object

Parameters:

  • catch_all (Boolean)
  • enabled (Boolean)
  • mx_required (Boolean) 



# File 'lib/telnyx/models/email_domain.rb', line 101

Instance Attribute Details

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :created_at, Time

#dkim ⇒ Telnyx::Models::EmailDomain::Dkim

Parameters:

  • value (Telnyx::EmailDomain::Dkim)

Returns:



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

required :dkim, -> { Telnyx::EmailDomain::Dkim }

#dmarc_policy ⇒ Telnyx::Models::EmailDmarcPolicy?

DMARC policy for a sending domain. Drives the recommended _dmarc. TXT record. DMARC is advisory and never blocks sending. When omitted or null, the domain uses the advisory default (v=DMARC1; p=none; rua=mailto:dmarc@telnyx.com).

Parameters:

Returns:



29
 
# File 'lib/telnyx/models/email_domain.rb', line 29

required :dmarc_policy, -> { Telnyx::EmailDmarcPolicy }, nil?: true

#dns_records ⇒ Array<Telnyx::Models::DNSRecord>

Parameters:

Returns:



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

required :dns_records, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::DNSRecord] }

#domain ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :domain, String

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#inbound ⇒ Telnyx::Models::EmailDomain::Inbound

Parameters:

  • value (Telnyx::EmailDomain::Inbound)

Returns:



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

required :inbound, -> { Telnyx::EmailDomain::Inbound }

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

Parameters:

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

Returns:



49
 
# File 'lib/telnyx/models/email_domain.rb', line 49

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

#reputation ⇒ Telnyx::Models::EmailDomain::Reputation?

Sender reputation for this domain (present on all domain responses).

Returns:



94
 
# File 'lib/telnyx/models/email_domain.rb', line 94

optional :reputation, -> { Telnyx::EmailDomain::Reputation }

#status ⇒ Symbol, Telnyx::Models::EmailDomainStatus

Parameters:

  • value (Telnyx::Models::email_domain_status)

Returns:



54
 
# File 'lib/telnyx/models/email_domain.rb', line 54

required :status, enum: -> { Telnyx::EmailDomainStatus }

#tracking ⇒ Telnyx::Models::DomainsTrackingSettings

Parameters:

Returns:



59
 
# File 'lib/telnyx/models/email_domain.rb', line 59

required :tracking, -> { Telnyx::DomainsTrackingSettings }

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

Domain type. custom domains are account-owned (BYOD). shared domains are Telnyx-managed, visible to and usable by ALL accounts for sending, but read-only: only the owning (system) account may modify, verify, or delete them; other accounts receive 403 (code 10008).

Parameters:

  • value (Telnyx::Models::email_domain_type)

Returns:



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

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

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


73
 
# File 'lib/telnyx/models/email_domain.rb', line 73

required :updated_at, Time

#usable_for_inbound ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


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

required :usable_for_inbound, Telnyx::Internal::Type::Boolean

#usable_for_sending ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


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

required :usable_for_sending, Telnyx::Internal::Type::Boolean

#verification ⇒ Telnyx::Models::EmailDomainVerification

Parameters:

Returns:



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

required :verification, -> { Telnyx::EmailDomainVerification }

#verified_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


99
 
# File 'lib/telnyx/models/email_domain.rb', line 99

optional :verified_at, Time, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/email_domain.rb', line 190

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


83
 
# File 'sig/telnyx/models/email_domain.rbs', line 83

def to_hash: -> {