Class: Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data

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

Overview

See Also:

  • Telnyx::Models::EmailValidations::BatchRetrieveResponse#data

Defined Under Namespace

Modules: RecordType Classes: Result

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:, record_type:, status:, total:, completed_at: nil, results: nil, webhook_url: nil) ⇒ Object

Shape returned by the GET endpoint. Does not include duplicates_removed.

Parameters:




# File 'lib/telnyx/models/email_validations/batch_retrieve_response.rb', line 57

Instance Attribute Details

#completed_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


43
 
# File 'lib/telnyx/models/email_validations/batch_retrieve_response.rb', line 43

optional :completed_at, Time

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#record_type ⇒ Symbol, Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::RecordType

Parameters:

  • value (Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::record_type)

Returns:



27
28
 
# File 'lib/telnyx/models/email_validations/batch_retrieve_response.rb', line 27

required :record_type,
enum: -> { Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::RecordType }

#results ⇒ Hash{Symbol=>Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result}?

Map keyed by original email address. Present only when the batch is completed.

Returns:



49
50
 
# File 'lib/telnyx/models/email_validations/batch_retrieve_response.rb', line 49

optional :results,
-> { Telnyx::Internal::Type::HashOf[Telnyx::Models::EmailValidations::BatchRetrieveResponse::Data::Result] }

#status ⇒ Symbol, Telnyx::Models::EmailValidations::EmailValidationBatchStatus

Parameters:

  • value (Telnyx::Models::EmailValidations::email_validation_batch_status)

Returns:



33
 
# File 'lib/telnyx/models/email_validations/batch_retrieve_response.rb', line 33

required :status, enum: -> { Telnyx::EmailValidations::EmailValidationBatchStatus }

#total ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :total, Integer

#webhook_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


55
 
# File 'lib/telnyx/models/email_validations/batch_retrieve_response.rb', line 55

optional :webhook_url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/email_validations/batch_retrieve_response.rb', line 80

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


62
 
# File 'sig/telnyx/models/email_validations/batch_retrieve_response.rbs', line 62

def to_hash: -> {