Class: Telnyx::Models::PortingOrder

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::PortingOrder

Defined in:

lib/telnyx/models/porting_order.rb

Overview

See Also:

• Resources::PortingOrders#list

Defined Under Namespace

Modules: AdditionalStep, PhoneNumberType Classes: PhoneNumber

Instance Attribute Summary

• #activation_settings ⇒ Telnyx::Models::PortingOrderActivationSettings^?
• #additional_steps ⇒ Array<Symbol, Telnyx::Models::PortingOrder::AdditionalStep>^?

  For specific porting orders, we may require additional steps to be taken before submitting the porting order.

• #customer_group_reference ⇒ String^?

  A customer-specified group reference for customer bookkeeping purposes.

• #customer_reference ⇒ String^?

  A customer-specified reference number for customer bookkeeping purposes.

• #documents ⇒ Telnyx::Models::PortingOrderDocuments^?

  Can be specified directly or via the ‘requirement_group_id` parameter.

• #end_user ⇒ Telnyx::Models::PortingOrderEndUser^?
• #messaging ⇒ Telnyx::Models::PortingOrderMessaging^?

  Information about messaging porting process.

• #misc ⇒ Telnyx::Models::PortingOrderMisc^?
• #phone_number_configuration ⇒ Telnyx::Models::PortingOrderPhoneNumberConfiguration^?
• #phone_number_type ⇒ Symbol, ...

  The type of the phone number.

• #phone_numbers ⇒ Array<Telnyx::Models::PortingOrder::PhoneNumber>^?

  List of phone numbers associated with this porting order.

• #requirements ⇒ Array<Telnyx::Models::PortingOrderRequirement>^?

  List of documentation requirements for porting numbers.

• #requirements_met ⇒ Boolean^?

  Is true when the required documentation is met.

• #status ⇒ Telnyx::Models::PortingOrderStatus^?

  Porting order status.

• #user_feedback ⇒ Telnyx::Models::PortingOrderUserFeedback^?
• #user_id ⇒ String^?

  Identifies the user (or organization) who requested the porting order.

• #webhook_url ⇒ String^?

Class Method Summary

• .values ⇒ Array<Symbol>

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

#activation_settings ⇒ Telnyx::Models::PortingOrderActivationSettings^?

Returns:

• (Telnyx::Models::PortingOrderActivationSettings, nil)

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

optional :activation_settings, -> { Telnyx::PortingOrderActivationSettings }

#additional_steps ⇒ Array<Symbol, Telnyx::Models::PortingOrder::AdditionalStep>^?

For specific porting orders, we may require additional steps to be taken before submitting the porting order.

Returns:

• (Array<Symbol, Telnyx::Models::PortingOrder::AdditionalStep>, nil)

# File 'lib/telnyx/models/porting_order.rb', line 17

optional :additional_steps,
-> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::PortingOrder::AdditionalStep] }

#customer_group_reference ⇒ String^?

A customer-specified group reference for customer bookkeeping purposes

Returns:

• (String, nil)

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

optional :customer_group_reference, String, nil?: true

#customer_reference ⇒ String^?

A customer-specified reference number for customer bookkeeping purposes

Returns:

• (String, nil)

# File 'lib/telnyx/models/porting_order.rb', line 30

optional :customer_reference, String, nil?: true

#documents ⇒ Telnyx::Models::PortingOrderDocuments^?

Can be specified directly or via the ‘requirement_group_id` parameter.

Returns:

• (Telnyx::Models::PortingOrderDocuments, nil)

# File 'lib/telnyx/models/porting_order.rb', line 36

optional :documents, -> { Telnyx::PortingOrderDocuments }

#end_user ⇒ Telnyx::Models::PortingOrderEndUser^?

Returns:

• (Telnyx::Models::PortingOrderEndUser, nil)

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

optional :end_user, -> { Telnyx::PortingOrderEndUser }

#messaging ⇒ Telnyx::Models::PortingOrderMessaging^?

Information about messaging porting process.

Returns:

• (Telnyx::Models::PortingOrderMessaging, nil)

# File 'lib/telnyx/models/porting_order.rb', line 47

optional :messaging, -> { Telnyx::PortingOrderMessaging }

#misc ⇒ Telnyx::Models::PortingOrderMisc^?

Returns:

• (Telnyx::Models::PortingOrderMisc, nil)

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

optional :misc, -> { Telnyx::PortingOrderMisc }, nil?: true

#phone_number_configuration ⇒ Telnyx::Models::PortingOrderPhoneNumberConfiguration^?

Returns:

• (Telnyx::Models::PortingOrderPhoneNumberConfiguration, nil)

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

optional :phone_number_configuration, -> { Telnyx::PortingOrderPhoneNumberConfiguration }

#phone_number_type ⇒ Symbol, ...

The type of the phone number

Returns:

• (Symbol, Telnyx::Models::PortingOrder::PhoneNumberType, nil)

# File 'lib/telnyx/models/porting_order.rb', line 63

optional :phone_number_type, enum: -> { Telnyx::PortingOrder::PhoneNumberType }

#phone_numbers ⇒ Array<Telnyx::Models::PortingOrder::PhoneNumber>^?

List of phone numbers associated with this porting order

Returns:

• (Array<Telnyx::Models::PortingOrder::PhoneNumber>, nil)

# File 'lib/telnyx/models/porting_order.rb', line 69

optional :phone_numbers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::PortingOrder::PhoneNumber] }

#requirements ⇒ Array<Telnyx::Models::PortingOrderRequirement>^?

List of documentation requirements for porting numbers. Can be set directly or via the ‘requirement_group_id` parameter.

Returns:

• (Array<Telnyx::Models::PortingOrderRequirement>, nil)

# File 'lib/telnyx/models/porting_order.rb', line 76

optional :requirements, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::PortingOrderRequirement] }

#requirements_met ⇒ Boolean^?

Is true when the required documentation is met

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/porting_order.rb', line 82

optional :requirements_met, Telnyx::Internal::Type::Boolean

#status ⇒ Telnyx::Models::PortingOrderStatus^?

Porting order status

Returns:

• (Telnyx::Models::PortingOrderStatus, nil)

# File 'lib/telnyx/models/porting_order.rb', line 88

optional :status, -> { Telnyx::PortingOrderStatus }

#user_feedback ⇒ Telnyx::Models::PortingOrderUserFeedback^?

Returns:

• (Telnyx::Models::PortingOrderUserFeedback, nil)

# File 'lib/telnyx/models/porting_order.rb', line 93

optional :user_feedback, -> { Telnyx::PortingOrderUserFeedback }

#user_id ⇒ String^?

Identifies the user (or organization) who requested the porting order

Returns:

• (String, nil)

# File 'lib/telnyx/models/porting_order.rb', line 99

optional :user_id, String

#webhook_url ⇒ String^?

Returns:

• (String, nil)

# File 'lib/telnyx/models/porting_order.rb', line 104

optional :webhook_url, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/porting_order.rb', line 226