Class: Telnyx::Models::TrackingSettings

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/tracking_settings.rb,
sig/telnyx/models/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) ⇒ TrackingSettings

Per-send open and click tracking overrides. Omitted properties inherit the sender domain's tracking settings.

Parameters:

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

    Whether to rewrite links for click tracking in this message.

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

    Whether to inject an open-tracking pixel for this message.

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



# File 'lib/telnyx/models/tracking_settings.rb', line 18

Instance Attribute Details

#click_tracking ⇒ Boolean?

Whether to rewrite links for click tracking in this message.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

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

#open_tracking ⇒ Boolean?

Whether to inject an open-tracking pixel for this message.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

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

Instance Method Details

#to_hash ⇒ { click_tracking: bool, open_tracking: bool }

Returns:

  • ({ click_tracking: bool, open_tracking: bool }) 


16
 
# File 'sig/telnyx/models/tracking_settings.rbs', line 16

def to_hash: -> { click_tracking: bool, open_tracking: bool }