Class: Telnyx::Models::ExternalConnections::UploadCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::ExternalConnections::UploadCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/external_connections/upload_create_params.rb

Overview

See Also:

• Resources::ExternalConnections::Uploads#create

Defined Under Namespace

Modules: AdditionalUsage, Usage

Instance Attribute Summary

• #additional_usages ⇒ Array<Symbol, Telnyx::Models::ExternalConnections::UploadCreateParams::AdditionalUsage>^?
• #civic_address_id ⇒ String^?

  Identifies the civic address to assign all phone numbers to.

• #id ⇒ String
• #location_id ⇒ String^?

  Identifies the location to assign all phone numbers to.

• #number_ids ⇒ Array<String>
• #usage ⇒ Symbol, ...

  The use case of the upload request.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, number_ids:, additional_usages: nil, civic_address_id: nil, location_id: nil, usage: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see UploadCreateParams for more details.

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(id:, number_ids:, additional_usages: nil, civic_address_id: nil, location_id: nil, usage: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::ExternalConnections::UploadCreateParams for more details.

Parameters:

• id (String)
• number_ids (Array<String>)
• additional_usages (Array<Symbol, Telnyx::Models::ExternalConnections::UploadCreateParams::AdditionalUsage>) (defaults to: nil)
• civic_address_id (String) (defaults to: nil) —

  Identifies the civic address to assign all phone numbers to.

• location_id (String) (defaults to: nil) —

  Identifies the location to assign all phone numbers to.

• usage (Symbol, Telnyx::Models::ExternalConnections::UploadCreateParams::Usage) (defaults to: nil) —

  The use case of the upload request. NOTE: ‘calling_user_assignment` is not suppo

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

# File 'lib/telnyx/models/external_connections/upload_create_params.rb', line 46

Instance Attribute Details

#additional_usages ⇒ Array<Symbol, Telnyx::Models::ExternalConnections::UploadCreateParams::AdditionalUsage>^?

Returns:

• (Array<Symbol, Telnyx::Models::ExternalConnections::UploadCreateParams::AdditionalUsage>, nil)

# File 'lib/telnyx/models/external_connections/upload_create_params.rb', line 24

optional :additional_usages,
-> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::ExternalConnections::UploadCreateParams::AdditionalUsage] }

#civic_address_id ⇒ String^?

Identifies the civic address to assign all phone numbers to.

Returns:

• (String, nil)

# File 'lib/telnyx/models/external_connections/upload_create_params.rb', line 31

optional :civic_address_id, String

#id ⇒ String

Returns:

• (String)

# File 'lib/telnyx/models/external_connections/upload_create_params.rb', line 14

required :id, String

#location_id ⇒ String^?

Identifies the location to assign all phone numbers to.

Returns:

• (String, nil)

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

optional :location_id, String

#number_ids ⇒ Array<String>

Returns:

• (Array<String>)

# File 'lib/telnyx/models/external_connections/upload_create_params.rb', line 19

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

#usage ⇒ Symbol, ...

The use case of the upload request. NOTE: ‘calling_user_assignment` is not supported for toll free numbers.

Returns:

• (Symbol, Telnyx::Models::ExternalConnections::UploadCreateParams::Usage, nil)

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

optional :usage, enum: -> { Telnyx::ExternalConnections::UploadCreateParams::Usage }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/external_connections/upload_create_params.rb', line 72