Class: Telnyx::Models::EmailBlock

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

Overview

See Also:

  • Telnyx::Resources::EmailBlocks#list

Defined Under Namespace

Modules: Reason, RecordType, Scope, Source, Status

Instance Attribute Summary collapse

Class Method 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(id:, created_at:, reason:, record_type:, scope:, source:, status:, to:, updated_at:, domain_id: nil, expires_at: nil, from: nil, group_id: nil) ⇒ Object

Suppression record. Schema fields hidden by the view: account_id, bounce_category, dsn_code, meta.

Parameters:




# File 'lib/telnyx/models/email_block.rb', line 78

Instance Attribute Details

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


15
 
# File 'lib/telnyx/models/email_block.rb', line 15

required :created_at, Time

#domain_id ⇒ String?

null ⇒ account scope. Stored on the row; exposed here.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


59
 
# File 'lib/telnyx/models/email_block.rb', line 59

optional :domain_id, String, nil?: true

#expires_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


64
 
# File 'lib/telnyx/models/email_block.rb', line 64

optional :expires_at, Time, nil?: true

#from ⇒ String?

null ⇒ not address-scope. (schema: from_address)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


70
 
# File 'lib/telnyx/models/email_block.rb', line 70

optional :from, String, nil?: true

#group_id ⇒ String?

null ⇒ global; set ⇒ group-scoped opt-out.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


76
 
# File 'lib/telnyx/models/email_block.rb', line 76

optional :group_id, String, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#reason ⇒ Symbol, Telnyx::Models::EmailBlock::Reason

Parameters:

  • value (Telnyx::Models::EmailBlock::reason)

Returns:



20
 
# File 'lib/telnyx/models/email_block.rb', line 20

required :reason, enum: -> { Telnyx::EmailBlock::Reason }

#record_type ⇒ Symbol, Telnyx::Models::EmailBlock::RecordType

View-only discriminator.

Parameters:

  • value (Telnyx::Models::EmailBlock::record_type)

Returns:



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

required :record_type, enum: -> { Telnyx::EmailBlock::RecordType }

#scope ⇒ Symbol, Telnyx::Models::EmailBlock::Scope

Derived server-side from domain_id/from; never trusted from the caller.

Parameters:

  • value (Telnyx::Models::EmailBlock::scope)

Returns:



32
 
# File 'lib/telnyx/models/email_block.rb', line 32

required :scope, enum: -> { Telnyx::EmailBlock::Scope }

#source ⇒ Symbol, Telnyx::Models::EmailBlock::Source

Parameters:

  • value (Telnyx::Models::EmailBlock::source)

Returns:



37
 
# File 'lib/telnyx/models/email_block.rb', line 37

required :source, enum: -> { Telnyx::EmailBlock::Source }

#status ⇒ Symbol, Telnyx::Models::EmailBlock::Status

Parameters:

  • value (Telnyx::Models::EmailBlock::status)

Returns:



42
 
# File 'lib/telnyx/models/email_block.rb', line 42

required :status, enum: -> { Telnyx::EmailBlock::Status }

#to ⇒ String

Normalized recipient. (schema: to_address)

Parameters:

  • value (String)

Returns:

  • (String) 


48
 
# File 'lib/telnyx/models/email_block.rb', line 48

required :to, String

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


53
 
# File 'lib/telnyx/models/email_block.rb', line 53

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/email_block.rb', line 118

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


63
 
# File 'sig/telnyx/models/email_block.rbs', line 63

def to_hash: -> {