Class: Telnyx::Models::EmailBlockRetrieveEventsResponse

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

Overview

See Also:

  • Telnyx::Resources::EmailBlocks#retrieve_events

Defined Under Namespace

Modules: EventType, RecordType

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:, actor:, event_type:, occurred_at:, reason:, record_type:, source:, meta: nil) ⇒ Object

Parameters:




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

Instance Attribute Details

#actor ⇒ String

Free-text (user_id/org_id/api_key/dev_bypass/system/manual).

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :actor, String

#event_type ⇒ Symbol, Telnyx::Models::EmailBlockRetrieveEventsResponse::EventType

Parameters:

  • value (Telnyx::Models::EmailBlockRetrieveEventsResponse::event_type)

Returns:



21
 
# File 'lib/telnyx/models/email_block_retrieve_events_response.rb', line 21

required :event_type, enum: -> { Telnyx::Models::EmailBlockRetrieveEventsResponse::EventType }

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#meta ⇒ Hash{Symbol=>Object}?

null when the schema field is nil (the context usually sets it to {}).

Parameters:

  • value (::Hash[Symbol, top], nil)

Returns:

  • (Hash{Symbol=>Object}, nil) 


50
 
# File 'lib/telnyx/models/email_block_retrieve_events_response.rb', line 50

optional :meta, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown], nil?: true

#occurred_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :occurred_at, Time

#reason ⇒ String

Free-text snapshot of the block's reason at event time.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :reason, String

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

View-only.

Parameters:

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

Returns:



38
 
# File 'lib/telnyx/models/email_block_retrieve_events_response.rb', line 38

required :record_type, enum: -> { Telnyx::Models::EmailBlockRetrieveEventsResponse::RecordType }

#source ⇒ String

Free-text snapshot of the block's source at event time.

Parameters:

  • value (String)

Returns:

  • (String) 


44
 
# File 'lib/telnyx/models/email_block_retrieve_events_response.rb', line 44

required :source, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


43
 
# File 'sig/telnyx/models/email_block_retrieve_events_response.rbs', line 43

def to_hash: -> {