Class: Telnyx::Models::PortingOrder

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/telnyx/models/porting_order.rb,
sig/telnyx/models/porting_order.rbs

Overview

See Also:

• Telnyx::Resources::PortingOrders#list

Defined Under Namespace

Modules: AdditionalStep, PhoneNumberType

Constant Summary

Telnyx =

Returns:

• (:PortingOrderActivationSettings)

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.

• #created_at ⇒ Time^? readonly

  Returns the value of attribute created_at.

• #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.

• #description ⇒ String^? readonly

  Returns the value of attribute description.

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

  Can be specified directly or via the requirement_group_id parameter.

• #end_user ⇒ Telnyx::Models::PortingOrderEndUser^?
• #id ⇒ String^? readonly

  Returns the value of attribute id.

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

  Information about messaging porting process.

• #misc ⇒ Telnyx::Models::PortingOrderMisc^?
• #old_service_provider_ocn ⇒ String^? readonly

  Returns the value of attribute old_service_provider_ocn.

• #parent_support_key ⇒ String^?

  Returns the value of attribute parent_support_key.

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

  The type of the phone number.

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

  List of phone numbers associated with this porting order.

• #porting_phone_numbers_count ⇒ Integer^? readonly

  Returns the value of attribute porting_phone_numbers_count.

• #record_type ⇒ String^? readonly

  Returns the value of attribute record_type.

• #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.

• #support_key ⇒ String^?

  Returns the value of attribute support_key.

• #updated_at ⇒ Time^? readonly

  Returns the value of attribute updated_at.

• #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>

Instance Method Summary

• #created_at ⇒ Time readonly
• #description ⇒ String readonly
• #id ⇒ String readonly
• #initialize ⇒ Object constructor
• #old_service_provider_ocn ⇒ String readonly
• #porting_phone_numbers_count ⇒ Integer readonly
• #record_type ⇒ String readonly
• #to_hash ⇒ {
• #updated_at ⇒ Time readonly

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 ⇒ Object

# File 'sig/telnyx/models/porting_order.rbs', line 146

def initialize: (

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] }

#created_at ⇒ Time^? (readonly)

Returns the value of attribute created_at.

Returns:

• (Time, nil)

# File 'sig/telnyx/models/porting_order.rbs', line 118

def created_at
  @created_at
end

#customer_group_reference ⇒ String^?

A customer-specified group reference for customer bookkeeping purposes

Parameters:

• value (String, nil)

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :customer_reference, String, nil?: true

#description ⇒ String^? (readonly)

Returns the value of attribute description.

Returns:

• (String, nil)

# File 'sig/telnyx/models/porting_order.rbs', line 122

def description
  @description
end

#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 }

#id ⇒ String^? (readonly)

Returns the value of attribute id.

Returns:

• (String, nil)

# File 'sig/telnyx/models/porting_order.rbs', line 114

def id
  @id
end

#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^?

Parameters:

• value (Telnyx::PortingOrderMisc, nil)

Returns:

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

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

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

#old_service_provider_ocn ⇒ String^? (readonly)

Returns the value of attribute old_service_provider_ocn.

Returns:

• (String, nil)

# File 'sig/telnyx/models/porting_order.rbs', line 126

def old_service_provider_ocn
  @old_service_provider_ocn
end

#parent_support_key ⇒ String^?

Returns the value of attribute parent_support_key.

Returns:

• (String, nil)

# File 'sig/telnyx/models/porting_order.rbs', line 130

def parent_support_key
  @parent_support_key
end

#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::PortingPhoneNumber>^?

List of phone numbers associated with this porting order

Returns:

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

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

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

#porting_phone_numbers_count ⇒ Integer^? (readonly)

Returns the value of attribute porting_phone_numbers_count.

Returns:

• (Integer, nil)

# File 'sig/telnyx/models/porting_order.rbs', line 132

def porting_phone_numbers_count
  @porting_phone_numbers_count
end

#record_type ⇒ String^? (readonly)

Returns the value of attribute record_type.

Returns:

• (String, nil)

# File 'sig/telnyx/models/porting_order.rbs', line 136

def record_type
  @record_type
end

#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

Parameters:

• (Boolean)

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

Parameters:

• (Telnyx::PortingOrderStatus)

Returns:

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

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

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

#support_key ⇒ String^?

Returns the value of attribute support_key.

Returns:

• (String, nil)

# File 'sig/telnyx/models/porting_order.rbs', line 140

def support_key
  @support_key
end

#updated_at ⇒ Time^? (readonly)

Returns the value of attribute updated_at.

Returns:

• (Time, nil)

# File 'sig/telnyx/models/porting_order.rbs', line 142

def updated_at
  @updated_at
end

#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

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :user_id, String

#webhook_url ⇒ String^?

Parameters:

• value (String, nil)

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

Instance Method Details

#created_at= ⇒ Time (readonly)

Parameters:

• (Time)

Returns:

• (Time)

# File 'sig/telnyx/models/porting_order.rbs', line 120

def created_at=: (Time) -> Time

#description= ⇒ String (readonly)

Parameters:

• (String)

Returns:

• (String)

# File 'sig/telnyx/models/porting_order.rbs', line 124

def description=: (String) -> String

#id= ⇒ String (readonly)

Parameters:

• (String)

Returns:

• (String)

# File 'sig/telnyx/models/porting_order.rbs', line 116

def id=: (String) -> String

#old_service_provider_ocn= ⇒ String (readonly)

Parameters:

• (String)

Returns:

• (String)

# File 'sig/telnyx/models/porting_order.rbs', line 128

def old_service_provider_ocn=: (String) -> String

#porting_phone_numbers_count= ⇒ Integer (readonly)

Parameters:

• (Integer)

Returns:

• (Integer)

# File 'sig/telnyx/models/porting_order.rbs', line 134

def porting_phone_numbers_count=: (Integer) -> Integer

#record_type= ⇒ String (readonly)

Parameters:

• (String)

Returns:

• (String)

# File 'sig/telnyx/models/porting_order.rbs', line 138

def record_type=: (String) -> String

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/porting_order.rbs', line 175

def to_hash: -> {

#updated_at= ⇒ Time (readonly)

Parameters:

• (Time)

Returns:

• (Time)

# File 'sig/telnyx/models/porting_order.rbs', line 144

def updated_at=: (Time) -> Time