Class: Telnyx::Models::PortingOrderUpdateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• Telnyx::Resources::PortingOrders#update

Defined Under Namespace

Classes: ActivationSettings, Messaging, Requirement

Constant Summary

Telnyx =

Returns:

• (:PortingOrderDocuments)

Instance Attribute Summary

• #activation_settings ⇒ Telnyx::Models::PortingOrderUpdateParams::ActivationSettings^?
• #customer_group_reference ⇒ String^?
• #customer_reference ⇒ String^?
• #documents ⇒ Telnyx::Models::PortingOrderDocuments^?

  Can be specified directly or via the requirement_group_id parameter.

• #end_user ⇒ Telnyx::Models::PortingOrderEndUser^?
• #id ⇒ String
• #messaging ⇒ Telnyx::Models::PortingOrderUpdateParams::Messaging^?
• #misc ⇒ Telnyx::Models::PortingOrderMisc^?
• #phone_number_configuration ⇒ Telnyx::Models::PortingOrderPhoneNumberConfiguration^?
• #requirement_group_id ⇒ String^?

  If present, we will read the current values from the specified Requirement Group into the Documents and Requirements for this Porting Order.

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

  List of requirements for porting numbers.

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

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(enable_messaging: nil) ⇒ Object constructor

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

• #to_hash ⇒ {

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(enable_messaging: nil) ⇒ Object

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

Parameters:

• enable_messaging (Boolean) (defaults to: nil) —

  Indicates whether Telnyx will port messaging capabilities from the losing carrie

# File 'lib/telnyx/models/porting_order_update_params.rb', line 122

Instance Attribute Details

#activation_settings ⇒ Telnyx::Models::PortingOrderUpdateParams::ActivationSettings^?

Returns:

• (Telnyx::Models::PortingOrderUpdateParams::ActivationSettings, nil)

# File 'lib/telnyx/models/porting_order_update_params.rb', line 18

optional :activation_settings, -> { Telnyx::PortingOrderUpdateParams::ActivationSettings }

#customer_group_reference ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/porting_order_update_params.rb', line 23

optional :customer_group_reference, String

#customer_reference ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :customer_reference, String

#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_update_params.rb', line 34

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

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

Returns:

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

# File 'lib/telnyx/models/porting_order_update_params.rb', line 39

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

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/porting_order_update_params.rb', line 13

required :id, String

#messaging ⇒ Telnyx::Models::PortingOrderUpdateParams::Messaging^?

Returns:

• (Telnyx::Models::PortingOrderUpdateParams::Messaging, nil)

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

optional :messaging, -> { Telnyx::PortingOrderUpdateParams::Messaging }

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

Parameters:

• value (Telnyx::PortingOrderMisc, nil)

Returns:

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

# File 'lib/telnyx/models/porting_order_update_params.rb', line 49

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

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

Returns:

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

# File 'lib/telnyx/models/porting_order_update_params.rb', line 54

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

#requirement_group_id ⇒ String^?

If present, we will read the current values from the specified Requirement Group into the Documents and Requirements for this Porting Order. Note that any future changes in the Requirement Group would have no impact on this Porting Order. We will return an error if a specified Requirement Group conflicts with documents or requirements in the same request.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/porting_order_update_params.rb', line 64

optional :requirement_group_id, String

#requirements ⇒ Array<Telnyx::Models::PortingOrderUpdateParams::Requirement>^?

List of requirements for porting numbers.

Returns:

• (Array<Telnyx::Models::PortingOrderUpdateParams::Requirement>, nil)

# File 'lib/telnyx/models/porting_order_update_params.rb', line 70

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

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

Returns:

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

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

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

#webhook_url ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/porting_order_update_params.rb', line 81

optional :webhook_url, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/porting_order_update_params.rbs', line 104

def to_hash: -> {