Class: Telnyx::Models::SuppressedRecipient

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/suppressed_recipient.rb,
sig/telnyx/models/suppressed_recipient.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(override_allowed:, reason:, scope:, to:) ⇒ Object

Parameters:

  • override_allowed (Boolean) —

    Whether an authorized send may override this suppression.

  • reason (String) —

    Suppression reason returned by the recipient suppression service.

  • scope (String) —

    Scope at which the suppression applies.

  • to (String) —

    Suppressed recipient email address.




# File 'lib/telnyx/models/suppressed_recipient.rb', line 30

Instance Attribute Details

#override_allowed ⇒ Boolean

Whether an authorized send may override this suppression.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


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

required :override_allowed, Telnyx::Internal::Type::Boolean

#reason ⇒ String

Suppression reason returned by the recipient suppression service.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :reason, String

#scope ⇒ String

Scope at which the suppression applies.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :scope, String

#to ⇒ String

Suppressed recipient email address.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :to, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


22
 
# File 'sig/telnyx/models/suppressed_recipient.rbs', line 22

def to_hash: -> {