telnyx 5.164.0 → 5.166.0

data/rbi/telnyx/models/calls/action_transfer_params.rbi

@@ -109,6 +109,17 @@ module Telnyx
         end
         attr_writer :custom_headers
 
+        # The number the inbound call being transferred was originally received on, in
+        # +E164 format. Supplying it lets an unverified non-Telnyx `from` be used as the
+        # caller id, provided that number is still on an active inbound call to this
+        # `diversion` number for your account. The `diversion` number itself must be one
+        # you own or have verified.
+        sig { returns(T.nilable(String)) }
+        attr_reader :diversion
+
+        sig { params(diversion: String).void }
+        attr_writer :diversion
+
         # If set to false, early media will not be passed to the originating leg.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :early_media
@@ -548,6 +559,7 @@ module Telnyx
             client_state: String,
             command_id: String,
             custom_headers: T::Array[Telnyx::CustomSipHeader::OrHash],
+            diversion: String,
             early_media: T::Boolean,
             from: String,
             from_display_name: String,
@@ -634,6 +646,12 @@ module Telnyx
           command_id: nil,
           # Custom headers to be added to the SIP INVITE.
           custom_headers: nil,
+          # The number the inbound call being transferred was originally received on, in
+          # +E164 format. Supplying it lets an unverified non-Telnyx `from` be used as the
+          # caller id, provided that number is still on an active inbound call to this
+          # `diversion` number for your account. The `diversion` number itself must be one
+          # you own or have verified.
+          diversion: nil,
           # If set to false, early media will not be passed to the originating leg.
           early_media: nil,
           # The `from` number to be used as the caller id presented to the destination (`to`
@@ -776,6 +794,7 @@ module Telnyx
               client_state: String,
               command_id: String,
               custom_headers: T::Array[Telnyx::CustomSipHeader],
+              diversion: String,
               early_media: T::Boolean,
               from: String,
               from_display_name: String,

data/rbi/telnyx/models/connection_rtcp_settings.rbi

@@ -8,8 +8,8 @@ module Telnyx
           T.any(Telnyx::ConnectionRtcpSettings, Telnyx::Internal::AnyHash)
         end
 
-      # BETA - Enable the capture and storage of RTCP messages to create QoS reports on
-      # the Telnyx Mission Control Portal.
+      # Enable the capture and storage of RTCP messages to create QoS reports on the
+      # Telnyx Mission Control Portal.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :capture_enabled
 
@@ -39,8 +39,8 @@ module Telnyx
         ).returns(T.attached_class)
       end
       def self.new(
-        # BETA - Enable the capture and storage of RTCP messages to create QoS reports on
-        # the Telnyx Mission Control Portal.
+        # Enable the capture and storage of RTCP messages to create QoS reports on the
+        # Telnyx Mission Control Portal.
         capture_enabled: nil,
         # RTCP port by default is rtp+1, it can also be set to rtcp-mux
         port: nil,

data/rbi/telnyx/models/credential_connections/action_check_registration_status_response.rbi

@@ -60,24 +60,15 @@ module Telnyx
 
           # The ip used during the SIP connection
           sig { returns(T.nilable(String)) }
-          attr_reader :ip_address
-
-          sig { params(ip_address: String).void }
-          attr_writer :ip_address
+          attr_accessor :ip_address
 
           # ISO 8601 formatted date indicating when the resource was last updated.
           sig { returns(T.nilable(String)) }
-          attr_reader :last_registration
-
-          sig { params(last_registration: String).void }
-          attr_writer :last_registration
+          attr_accessor :last_registration
 
           # The port of the SIP connection
           sig { returns(T.nilable(Integer)) }
-          attr_reader :port
-
-          sig { params(port: Integer).void }
-          attr_writer :port
+          attr_accessor :port
 
           # Identifies the type of the resource.
           sig { returns(T.nilable(String)) }
@@ -88,10 +79,7 @@ module Telnyx
 
           # The user name of the SIP connection
           sig { returns(T.nilable(String)) }
-          attr_reader :sip_username
-
-          sig { params(sip_username: String).void }
-          attr_writer :sip_username
+          attr_accessor :sip_username
 
           # The current registration status of your SIP connection
           sig do
@@ -113,29 +101,23 @@ module Telnyx
 
           # The protocol of the SIP connection
           sig { returns(T.nilable(String)) }
-          attr_reader :transport
-
-          sig { params(transport: String).void }
-          attr_writer :transport
+          attr_accessor :transport
 
           # The user agent of the SIP connection
           sig { returns(T.nilable(String)) }
-          attr_reader :user_agent
-
-          sig { params(user_agent: String).void }
-          attr_writer :user_agent
+          attr_accessor :user_agent
 
           sig do
             params(
-              ip_address: String,
-              last_registration: String,
-              port: Integer,
+              ip_address: T.nilable(String),
+              last_registration: T.nilable(String),
+              port: T.nilable(Integer),
               record_type: String,
-              sip_username: String,
+              sip_username: T.nilable(String),
               status:
                 Telnyx::Models::CredentialConnections::ActionCheckRegistrationStatusResponse::Data::Status::OrSymbol,
-              transport: String,
-              user_agent: String
+              transport: T.nilable(String),
+              user_agent: T.nilable(String)
             ).returns(T.attached_class)
           end
           def self.new(
@@ -161,15 +143,15 @@ module Telnyx
           sig do
             override.returns(
               {
-                ip_address: String,
-                last_registration: String,
-                port: Integer,
+                ip_address: T.nilable(String),
+                last_registration: T.nilable(String),
+                port: T.nilable(Integer),
                 record_type: String,
-                sip_username: String,
+                sip_username: T.nilable(String),
                 status:
                   Telnyx::Models::CredentialConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol,
-                transport: String,
-                user_agent: String
+                transport: T.nilable(String),
+                user_agent: T.nilable(String)
               }
             )
           end

data/rbi/telnyx/models/external_requirements/sub_number_order_retrieve_params.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module ExternalRequirements
+      class SubNumberOrderRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::ExternalRequirements::SubNumberOrderRetrieveParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :regulatory_requirement_id
+
+        sig { returns(String) }
+        attr_accessor :sub_number_order_id
+
+        sig do
+          params(
+            regulatory_requirement_id: String,
+            sub_number_order_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          regulatory_requirement_id:,
+          sub_number_order_id:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              regulatory_requirement_id: String,
+              sub_number_order_id: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/external_requirements/sub_number_order_retrieve_response.rbi

@@ -0,0 +1,248 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module ExternalRequirements
+      class SubNumberOrderRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data
+            )
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The fields the end user must provide to fulfill this requirement.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::FieldsRequired
+                ]
+              )
+            )
+          end
+          attr_reader :fields_required
+
+          sig do
+            params(
+              fields_required:
+                T::Array[
+                  Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::FieldsRequired::OrHash
+                ]
+            ).void
+          end
+          attr_writer :fields_required
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :regulatory_requirement_id
+
+          sig { params(regulatory_requirement_id: String).void }
+          attr_writer :regulatory_requirement_id
+
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::RequirementAction
+              )
+            )
+          end
+          attr_reader :requirement_action
+
+          sig do
+            params(
+              requirement_action:
+                Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::RequirementAction::OrHash
+            ).void
+          end
+          attr_writer :requirement_action
+
+          sig do
+            params(
+              fields_required:
+                T::Array[
+                  Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::FieldsRequired::OrHash
+                ],
+              regulatory_requirement_id: String,
+              requirement_action:
+                Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::RequirementAction::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The fields the end user must provide to fulfill this requirement.
+            fields_required: nil,
+            regulatory_requirement_id: nil,
+            requirement_action: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                fields_required:
+                  T::Array[
+                    Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::FieldsRequired
+                  ],
+                regulatory_requirement_id: String,
+                requirement_action:
+                  Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::RequirementAction
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class FieldsRequired < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::FieldsRequired,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :description
+
+            sig { params(description: String).void }
+            attr_writer :description
+
+            # The field name to send inside the `requirement` object on the POST.
+            sig { returns(T.nilable(String)) }
+            attr_reader :name
+
+            sig { params(name: String).void }
+            attr_writer :name
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :type
+
+            sig { params(type: String).void }
+            attr_writer :type
+
+            # The value already stored for this field, or null if not yet provided.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :value
+
+            sig do
+              params(
+                description: String,
+                name: String,
+                type: String,
+                value: T.nilable(String)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              description: nil,
+              # The field name to send inside the `requirement` object on the POST.
+              name: nil,
+              type: nil,
+              # The value already stored for this field, or null if not yet provided.
+              value: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  description: String,
+                  name: String,
+                  type: String,
+                  value: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class RequirementAction < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse::Data::RequirementAction,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # The type of action the end user must complete.
+            sig { returns(T.nilable(String)) }
+            attr_reader :type
+
+            sig { params(type: String).void }
+            attr_writer :type
+
+            # The action value. For ID verification this is the verification link URL, or null
+            # until it has been generated.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :value
+
+            sig do
+              params(type: String, value: T.nilable(String)).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # The type of action the end user must complete.
+              type: nil,
+              # The action value. For ID verification this is the verification link URL, or null
+              # until it has been generated.
+              value: nil
+            )
+            end
+
+            sig { override.returns({ type: String, value: T.nilable(String) }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/external_requirements/sub_number_order_update_params.rbi

@@ -0,0 +1,119 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module ExternalRequirements
+      class SubNumberOrderUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::ExternalRequirements::SubNumberOrderUpdateParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :regulatory_requirement_id
+
+        sig { returns(String) }
+        attr_accessor :sub_number_order_id
+
+        # The end user's identity details for the action requirement. Australia mobile ID
+        # verification is currently the only action requirement. It requires `first_name`
+        # and `last_name`, the same fields the corresponding GET lists in
+        # `fields_required`.
+        sig do
+          returns(
+            Telnyx::ExternalRequirements::SubNumberOrderUpdateParams::Requirement
+          )
+        end
+        attr_reader :requirement
+
+        sig do
+          params(
+            requirement:
+              Telnyx::ExternalRequirements::SubNumberOrderUpdateParams::Requirement::OrHash
+          ).void
+        end
+        attr_writer :requirement
+
+        sig do
+          params(
+            regulatory_requirement_id: String,
+            sub_number_order_id: String,
+            requirement:
+              Telnyx::ExternalRequirements::SubNumberOrderUpdateParams::Requirement::OrHash,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          regulatory_requirement_id:,
+          sub_number_order_id:,
+          # The end user's identity details for the action requirement. Australia mobile ID
+          # verification is currently the only action requirement. It requires `first_name`
+          # and `last_name`, the same fields the corresponding GET lists in
+          # `fields_required`.
+          requirement:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              regulatory_requirement_id: String,
+              sub_number_order_id: String,
+              requirement:
+                Telnyx::ExternalRequirements::SubNumberOrderUpdateParams::Requirement,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Requirement < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::ExternalRequirements::SubNumberOrderUpdateParams::Requirement,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The end user's first name.
+          sig { returns(String) }
+          attr_accessor :first_name
+
+          # The end user's last name.
+          sig { returns(String) }
+          attr_accessor :last_name
+
+          # The end user's identity details for the action requirement. Australia mobile ID
+          # verification is currently the only action requirement. It requires `first_name`
+          # and `last_name`, the same fields the corresponding GET lists in
+          # `fields_required`.
+          sig do
+            params(first_name: String, last_name: String).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The end user's first name.
+            first_name:,
+            # The end user's last name.
+            last_name:
+          )
+          end
+
+          sig { override.returns({ first_name: String, last_name: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end