Class: Telnyx::Models::Dir::PhoneNumberCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/dir/phone_number_create_params.rb

Overview

See Also:

  • Resources::Dir::PhoneNumbers#create

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(dir_id:, documents:, phone_numbers:, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Dir::PhoneNumberCreateParams for more details.

Parameters:

  • dir_id (String)
  • documents (Array<Telnyx::Models::Document>) —

    Supporting documents covering this batch. At least one entry with ‘document_type

  • phone_numbers (Array<String>) —

    1–15 phone numbers in E.164 format. 10-digit US numbers are auto-prefixed with ‘

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/telnyx/models/dir/phone_number_create_params.rb', line 33

Instance Attribute Details

#dir_id ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/telnyx/models/dir/phone_number_create_params.rb', line 14

required :dir_id, String

#documents ⇒ Array<Telnyx::Models::Document>

Supporting documents covering this batch. At least one entry with ‘document_type: letter_of_authorization` is required - the LOA authorises Telnyx to register these numbers under the DIR. Each `document_id` must come from the Telnyx Documents API. Additional document types (e.g. business registration) may be included alongside the LOA.

Returns:



24
 
# File 'lib/telnyx/models/dir/phone_number_create_params.rb', line 24

required :documents, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Document] }

#phone_numbers ⇒ Array<String>

1–15 phone numbers in E.164 format. 10-digit US numbers are auto-prefixed with ‘1`.

Returns:

  • (Array<String>) 


31
 
# File 'lib/telnyx/models/dir/phone_number_create_params.rb', line 31

required :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]