Class: Telnyx::Models::DomainsTrackingSettings

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

Instance Attribute 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(click_tracking: nil, open_tracking: nil, unsubscribe_tracking: nil) ⇒ Object

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

Parameters:

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

    Rewrite HTML links through a tracking redirect to record click events.

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

    Inject a tracking pixel into HTML messages to record open events.

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

    Add RFC 8058 List-Unsubscribe headers with a signed one-click unsubscribe URL. E




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

Instance Attribute Details

#click_tracking ⇒ Boolean?

Rewrite HTML links through a tracking redirect to record click events.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :click_tracking, Telnyx::Internal::Type::Boolean

#open_tracking ⇒ Boolean?

Inject a tracking pixel into HTML messages to record open events.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :open_tracking, Telnyx::Internal::Type::Boolean

#unsubscribe_tracking ⇒ Boolean?

Add RFC 8058 List-Unsubscribe headers with a signed one-click unsubscribe URL. Enabled by default; Gmail/Yahoo bulk-sender rules require one-click unsubscribe support.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


24
 
# File 'lib/telnyx/models/domains_tracking_settings.rb', line 24

optional :unsubscribe_tracking, Telnyx::Internal::Type::Boolean

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


25
 
# File 'sig/telnyx/models/domains_tracking_settings.rbs', line 25

def to_hash: -> {