Class: Telnyx::Models::Dir::PhoneNumberBatchRetrieveResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/dir/phone_number_batch_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Status Classes: Document, PhoneNumber

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Telnyx::Internal::Type::BaseModel

Instance Attribute Details

#dir_idString?

Returns:

  • (String, nil)


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

optional :dir_id, String

#documentsArray<Telnyx::Models::Dir::PhoneNumberBatchRetrieveResponse::Data::Document>?

Documents attached to this batch (e.g. a Letter of Authorization). Empty when none were supplied at add time.



35
36
# File 'lib/telnyx/models/dir/phone_number_batch_retrieve_response.rb', line 35

optional :documents,
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Dir::PhoneNumberBatchRetrieveResponse::Data::Document] }

#enterprise_idString?

Returns:

  • (String, nil)


41
# File 'lib/telnyx/models/dir/phone_number_batch_retrieve_response.rb', line 41

optional :enterprise_id, String

#phone_numbersArray<Telnyx::Models::Dir::PhoneNumberBatchRetrieveResponse::Data::PhoneNumber>?

All phone numbers in this batch, with per-number status.



47
48
# File 'lib/telnyx/models/dir/phone_number_batch_retrieve_response.rb', line 47

optional :phone_numbers,
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::Dir::PhoneNumberBatchRetrieveResponse::Data::PhoneNumber] }

#statusSymbol, ...

Aggregate batch status. Mirrors the values used on individual phone numbers (‘submitted`, `in_review`, `verified`, `unsuccessful`, `permanently_rejected`, etc.).



56
# File 'lib/telnyx/models/dir/phone_number_batch_retrieve_response.rb', line 56

optional :status, enum: -> { Telnyx::Models::Dir::PhoneNumberBatchRetrieveResponse::Data::Status }

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/telnyx/models/dir/phone_number_batch_retrieve_response.rb', line 165