Class: Telnyx::Models::EmailDomainUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::EmailDomainUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/email_domain_update_params.rb,
sig/telnyx/models/email_domain_update_params.rbs

Overview

See Also:

• Telnyx::Resources::EmailDomains#update

Constant Summary

Telnyx =

Returns:

• (:DomainsTrackingSettings)

Instance Attribute Summary

• #dmarc_policy ⇒ Telnyx::Models::EmailDmarcPolicy^?

  DMARC policy for a sending domain.

• #id ⇒ String
• #inbound_enabled ⇒ Boolean^?

  Enable or disable inbound routing for this domain.

• #tracking ⇒ Telnyx::Models::DomainsTrackingSettings^?

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id:, dmarc_policy: nil, inbound_enabled: nil, tracking: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see EmailDomainUpdateParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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:, dmarc_policy: nil, inbound_enabled: nil, tracking: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::EmailDomainUpdateParams for more details.

re

Parameters:

• id (String)
• dmarc_policy (Telnyx::Models::EmailDmarcPolicy, nil) (defaults to: nil) —

  DMARC policy for a sending domain. Drives the recommended _dmarc. TXT

• inbound_enabled (Boolean) (defaults to: nil) —

  Enable or disable inbound routing for this domain

• tracking (Telnyx::Models::DomainsTrackingSettings) (defaults to: nil)
• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

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

Instance Attribute Details

#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:

• value (Telnyx::EmailDmarcPolicy, nil)

Returns:

• (Telnyx::Models::EmailDmarcPolicy, nil)

# File 'lib/telnyx/models/email_domain_update_params.rb', line 22

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

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/email_domain_update_params.rb', line 13

required :id, String

#inbound_enabled ⇒ Boolean^?

Enable or disable inbound routing for this domain

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

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

optional :inbound_enabled, Telnyx::Internal::Type::Boolean

#tracking ⇒ Telnyx::Models::DomainsTrackingSettings^?

Returns:

• (Telnyx::Models::DomainsTrackingSettings, nil)

# File 'lib/telnyx/models/email_domain_update_params.rb', line 33

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/email_domain_update_params.rbs', line 38

def to_hash: -> {