Class: Telnyx::Models::EmailInboxes::EmailMessageResponse::Suppressed

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



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/telnyx/models/email_inboxes/email_message_response.rb', line 29

class Suppressed < Telnyx::Internal::Type::BaseModel
  # @!attribute override_allowed
  #   Whether an authorized send may override this suppression.
  #
  #   @return [Boolean]
  required :override_allowed, Telnyx::Internal::Type::Boolean

  # @!attribute reason
  #   Suppression reason returned by the recipient suppression service.
  #
  #   @return [String]
  required :reason, String

  # @!attribute scope
  #   Scope at which the suppression applies.
  #
  #   @return [String]
  required :scope, String

  # @!attribute to
  #   Suppressed recipient email address.
  #
  #   @return [String]
  required :to, String

  # @!method initialize(override_allowed:, reason:, scope:, to:)
  #   @param override_allowed [Boolean] Whether an authorized send may override this suppression.
  #
  #   @param reason [String] Suppression reason returned by the recipient suppression service.
  #
  #   @param scope [String] Scope at which the suppression applies.
  #
  #   @param to [String] Suppressed recipient email address.
end

Instance Attribute Details

#override_allowed ⇒ Boolean

Whether an authorized send may override this suppression.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


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

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

#reason ⇒ String

Suppression reason returned by the recipient suppression service.

Parameters:

  • value (String)

Returns:

  • (String) 


40
 
# File 'lib/telnyx/models/email_inboxes/email_message_response.rb', line 40

required :reason, String

#scope ⇒ String

Scope at which the suppression applies.

Parameters:

  • value (String)

Returns:

  • (String) 


46
 
# File 'lib/telnyx/models/email_inboxes/email_message_response.rb', line 46

required :scope, String

#to ⇒ String

Suppressed recipient email address.

Parameters:

  • value (String)

Returns:

  • (String) 


52
 
# File 'lib/telnyx/models/email_inboxes/email_message_response.rb', line 52

required :to, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


48
 
# File 'sig/telnyx/models/email_inboxes/email_message_response.rbs', line 48

def to_hash: -> {