telnyx 5.164.0 → 5.166.0

data/rbi/telnyx/models/external_requirements/sub_number_order_update_response.rbi

@@ -0,0 +1,159 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module ExternalRequirements
+      class SubNumberOrderUpdateResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data
+            )
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          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::SubNumberOrderUpdateResponse::Data::RequirementAction
+              )
+            )
+          end
+          attr_reader :requirement_action
+
+          sig do
+            params(
+              requirement_action:
+                Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data::RequirementAction::OrHash
+            ).void
+          end
+          attr_writer :requirement_action
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :sub_order_id
+
+          sig { params(sub_order_id: String).void }
+          attr_writer :sub_order_id
+
+          sig do
+            params(
+              regulatory_requirement_id: String,
+              requirement_action:
+                Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data::RequirementAction::OrHash,
+              sub_order_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            regulatory_requirement_id: nil,
+            requirement_action: nil,
+            sub_order_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                regulatory_requirement_id: String,
+                requirement_action:
+                  Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data::RequirementAction,
+                sub_order_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class RequirementAction < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse::Data::RequirementAction,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :type
+
+            sig { params(type: String).void }
+            attr_writer :type
+
+            # For Australia mobile ID verification, the unique Onfido verification link to
+            # share with the end user.
+            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(
+              type: nil,
+              # For Australia mobile ID verification, the unique Onfido verification link to
+              # share with the end user.
+              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/outbound_voice_profile.rbi

@@ -30,8 +30,8 @@ module Telnyx
       sig { params(call_recording: Telnyx::OutboundCallRecording::OrHash).void }
       attr_writer :call_recording
 
-      # (BETA) Specifies the time window and call limits for calls made using this
-      # outbound voice profile. Note that all times are UTC in 24-hour clock time.
+      # Specifies the time window and call limits for calls made using this outbound
+      # voice profile. Note that all times are UTC in 24-hour clock time.
       sig { returns(T.nilable(Telnyx::OutboundVoiceProfile::CallingWindow)) }
       attr_reader :calling_window
 
@@ -175,8 +175,8 @@ module Telnyx
         # null (for no group assigned).
         billing_group_id: nil,
         call_recording: nil,
-        # (BETA) Specifies the time window and call limits for calls made using this
-        # outbound voice profile. Note that all times are UTC in 24-hour clock time.
+        # Specifies the time window and call limits for calls made using this outbound
+        # voice profile. Note that all times are UTC in 24-hour clock time.
         calling_window: nil,
         # Must be no more than your global concurrent call limit. Null means no limit.
         concurrent_call_limit: nil,
@@ -250,32 +250,32 @@ module Telnyx
             )
           end
 
-        # (BETA) The maximum number of calls that can be initiated to a single called
-        # party (CLD) within the calling window. A null value means no limit.
+        # The maximum number of calls that can be initiated to a single called party (CLD)
+        # within the calling window. A null value means no limit.
         sig { returns(T.nilable(Integer)) }
         attr_reader :calls_per_cld
 
         sig { params(calls_per_cld: Integer).void }
         attr_writer :calls_per_cld
 
-        # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
-        # longer allowed to start.
+        # The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
+        # allowed to start.
         sig { returns(T.nilable(String)) }
         attr_reader :end_time
 
         sig { params(end_time: String).void }
         attr_writer :end_time
 
-        # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
-        # allowed to start.
+        # The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
+        # start.
         sig { returns(T.nilable(String)) }
         attr_reader :start_time
 
         sig { params(start_time: String).void }
         attr_writer :start_time
 
-        # (BETA) Specifies the time window and call limits for calls made using this
-        # outbound voice profile. Note that all times are UTC in 24-hour clock time.
+        # Specifies the time window and call limits for calls made using this outbound
+        # voice profile. Note that all times are UTC in 24-hour clock time.
         sig do
           params(
             calls_per_cld: Integer,
@@ -284,14 +284,14 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
-          # (BETA) The maximum number of calls that can be initiated to a single called
-          # party (CLD) within the calling window. A null value means no limit.
+          # The maximum number of calls that can be initiated to a single called party (CLD)
+          # within the calling window. A null value means no limit.
           calls_per_cld: nil,
-          # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
-          # longer allowed to start.
-          end_time: nil,
-          # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
+          # The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
           # allowed to start.
+          end_time: nil,
+          # The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
+          # start.
           start_time: nil
         )
         end

data/rbi/telnyx/models/outbound_voice_profile_create_params.rbi

@@ -29,8 +29,8 @@ module Telnyx
       sig { params(call_recording: Telnyx::OutboundCallRecording::OrHash).void }
       attr_writer :call_recording
 
-      # (BETA) Specifies the time window and call limits for calls made using this
-      # outbound voice profile. Note that all times are UTC in 24-hour clock time.
+      # Specifies the time window and call limits for calls made using this outbound
+      # voice profile. Note that all times are UTC in 24-hour clock time.
       sig do
         returns(
           T.nilable(Telnyx::OutboundVoiceProfileCreateParams::CallingWindow)
@@ -146,8 +146,8 @@ module Telnyx
         # null (for no group assigned).
         billing_group_id: nil,
         call_recording: nil,
-        # (BETA) Specifies the time window and call limits for calls made using this
-        # outbound voice profile. Note that all times are UTC in 24-hour clock time.
+        # Specifies the time window and call limits for calls made using this outbound
+        # voice profile. Note that all times are UTC in 24-hour clock time.
         calling_window: nil,
         # Must be no more than your global concurrent call limit. Null means no limit.
         concurrent_call_limit: nil,
@@ -211,32 +211,32 @@ module Telnyx
             )
           end
 
-        # (BETA) The maximum number of calls that can be initiated to a single called
-        # party (CLD) within the calling window. A null value means no limit.
+        # The maximum number of calls that can be initiated to a single called party (CLD)
+        # within the calling window. A null value means no limit.
         sig { returns(T.nilable(Integer)) }
         attr_reader :calls_per_cld
 
         sig { params(calls_per_cld: Integer).void }
         attr_writer :calls_per_cld
 
-        # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
-        # longer allowed to start.
+        # The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
+        # allowed to start.
         sig { returns(T.nilable(Time)) }
         attr_reader :end_time
 
         sig { params(end_time: Time).void }
         attr_writer :end_time
 
-        # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
-        # allowed to start.
+        # The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
+        # start.
         sig { returns(T.nilable(Time)) }
         attr_reader :start_time
 
         sig { params(start_time: Time).void }
         attr_writer :start_time
 
-        # (BETA) Specifies the time window and call limits for calls made using this
-        # outbound voice profile. Note that all times are UTC in 24-hour clock time.
+        # Specifies the time window and call limits for calls made using this outbound
+        # voice profile. Note that all times are UTC in 24-hour clock time.
         sig do
           params(
             calls_per_cld: Integer,
@@ -245,14 +245,14 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
-          # (BETA) The maximum number of calls that can be initiated to a single called
-          # party (CLD) within the calling window. A null value means no limit.
+          # The maximum number of calls that can be initiated to a single called party (CLD)
+          # within the calling window. A null value means no limit.
           calls_per_cld: nil,
-          # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
-          # longer allowed to start.
-          end_time: nil,
-          # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
+          # The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
           # allowed to start.
+          end_time: nil,
+          # The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
+          # start.
           start_time: nil
         )
         end

data/rbi/telnyx/models/outbound_voice_profile_update_params.rbi

@@ -32,8 +32,8 @@ module Telnyx
       sig { params(call_recording: Telnyx::OutboundCallRecording::OrHash).void }
       attr_writer :call_recording
 
-      # (BETA) Specifies the time window and call limits for calls made using this
-      # outbound voice profile.
+      # Specifies the time window and call limits for calls made using this outbound
+      # voice profile.
       sig do
         returns(
           T.nilable(Telnyx::OutboundVoiceProfileUpdateParams::CallingWindow)
@@ -151,8 +151,8 @@ module Telnyx
         # null (for no group assigned).
         billing_group_id: nil,
         call_recording: nil,
-        # (BETA) Specifies the time window and call limits for calls made using this
-        # outbound voice profile.
+        # Specifies the time window and call limits for calls made using this outbound
+        # voice profile.
         calling_window: nil,
         # Must be no more than your global concurrent call limit. Null means no limit.
         concurrent_call_limit: nil,
@@ -217,32 +217,32 @@ module Telnyx
             )
           end
 
-        # (BETA) The maximum number of calls that can be initiated to a single called
-        # party (CLD) within the calling window. A null value means no limit.
+        # The maximum number of calls that can be initiated to a single called party (CLD)
+        # within the calling window. A null value means no limit.
         sig { returns(T.nilable(Integer)) }
         attr_reader :calls_per_cld
 
         sig { params(calls_per_cld: Integer).void }
         attr_writer :calls_per_cld
 
-        # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
-        # longer allowed to start.
+        # The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
+        # allowed to start.
         sig { returns(T.nilable(Time)) }
         attr_reader :end_time
 
         sig { params(end_time: Time).void }
         attr_writer :end_time
 
-        # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
-        # allowed to start.
+        # The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
+        # start.
         sig { returns(T.nilable(Time)) }
         attr_reader :start_time
 
         sig { params(start_time: Time).void }
         attr_writer :start_time
 
-        # (BETA) Specifies the time window and call limits for calls made using this
-        # outbound voice profile.
+        # Specifies the time window and call limits for calls made using this outbound
+        # voice profile.
         sig do
           params(
             calls_per_cld: Integer,
@@ -251,14 +251,14 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
-          # (BETA) The maximum number of calls that can be initiated to a single called
-          # party (CLD) within the calling window. A null value means no limit.
+          # The maximum number of calls that can be initiated to a single called party (CLD)
+          # within the calling window. A null value means no limit.
           calls_per_cld: nil,
-          # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are no
-          # longer allowed to start.
-          end_time: nil,
-          # (BETA) The UTC time of day (in HH:MM format, 24-hour clock) when calls are
+          # The UTC time of day (in HH:MM format, 24-hour clock) when calls are no longer
           # allowed to start.
+          end_time: nil,
+          # The UTC time of day (in HH:MM format, 24-hour clock) when calls are allowed to
+          # start.
           start_time: nil
         )
         end

data/rbi/telnyx/models/uac_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::UacConnections::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::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol,
-                transport: String,
-                user_agent: String
+                transport: T.nilable(String),
+                user_agent: T.nilable(String)
               }
             )
           end

data/rbi/telnyx/models.rbi

@@ -881,6 +881,8 @@ module Telnyx
   ExternalConnectionUpdateParams =
     Telnyx::Models::ExternalConnectionUpdateParams
 
+  ExternalRequirements = Telnyx::Models::ExternalRequirements
+
   ExternalVoiceIntegrationsPaginationMeta =
     Telnyx::Models::ExternalVoiceIntegrationsPaginationMeta
 
@@ -2014,9 +2016,6 @@ module Telnyx
 
   SiprecConnectorUpdateParams = Telnyx::Models::SiprecConnectorUpdateParams
 
-  SipRegistrationStatusRetrieveParams =
-    Telnyx::Models::SipRegistrationStatusRetrieveParams
-
   SoundModifications = Telnyx::Models::SoundModifications
 
   SpeechToTextListProvidersParams =

data/rbi/telnyx/resources/calls/actions.rbi

@@ -2286,6 +2286,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,
@@ -2373,6 +2374,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`

data/rbi/telnyx/resources/calls.rbi

@@ -53,6 +53,7 @@ module Telnyx
           custom_headers: T::Array[Telnyx::CustomSipHeader::OrHash],
           deepfake_detection: Telnyx::CallDialParams::DeepfakeDetection::OrHash,
           dialogflow_config: Telnyx::DialogflowConfig::OrHash,
+          diversion: String,
           enable_dialogflow: T::Boolean,
           from_display_name: String,
           link_to: String,
@@ -197,6 +198,12 @@ module Telnyx
         # webhook.
         deepfake_detection: nil,
         dialogflow_config: 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,
         # Enables Dialogflow for the current call. The default value is false.
         enable_dialogflow: nil,
         # The `from_display_name` string to be used as the caller id name (SIP From

data/rbi/telnyx/resources/credential_connections/actions.rbi

@@ -5,9 +5,9 @@ module Telnyx
     class CredentialConnections
       # Credential connection operations
       class Actions
-        # Checks the registration_status for a credential connection,
-        # (`registration_status`) as well as the timestamp for the last SIP registration
-        # event (`registration_status_updated_at`)
+        # Returns the live SIP registration status for a credential connection. Reports
+        # whether the endpoint is currently registered (`status`) and the timestamp of the
+        # last SIP registration event (`last_registration`).
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/external_requirements/sub_number_orders.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class ExternalRequirements
+      # Requirement Groups
+      class SubNumberOrders
+        # Returns the input fields an action requirement needs and the current requirement
+        # action for a sub number order. Action requirements are fulfilled by an external
+        # step rather than by uploading documents. Australia mobile ID verification is
+        # currently the only action requirement. Once a verification link has been
+        # generated, it is returned in `requirement_action.value`.
+        sig do
+          params(
+            sub_number_order_id: String,
+            regulatory_requirement_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::ExternalRequirements::SubNumberOrderRetrieveResponse
+          )
+        end
+        def retrieve(
+          # The ID of the sub number order the requirement belongs to.
+          sub_number_order_id,
+          # The ID of the regulatory (action) requirement. For Australia mobile ID
+          # verification this is `b7c72fb8-fa08-4529-aaf6-b9117d3f3698`.
+          regulatory_requirement_id:,
+          request_options: {}
+        )
+        end
+
+        # Submits the end user's details to the external verification provider and returns
+        # the requirement action. Australia mobile ID verification is currently the only
+        # action requirement. It generates a unique Onfido verification link, returned in
+        # `requirement_action.value`, which you share with the end user. The end user's
+        # `first_name` and `last_name` must be nested inside a `requirement` object;
+        # sending them at the top level is rejected.
+        sig do
+          params(
+            sub_number_order_id: String,
+            regulatory_requirement_id: String,
+            requirement:
+              Telnyx::ExternalRequirements::SubNumberOrderUpdateParams::Requirement::OrHash,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::ExternalRequirements::SubNumberOrderUpdateResponse
+          )
+        end
+        def update(
+          # Path param: The ID of the sub number order the requirement belongs to.
+          sub_number_order_id,
+          # Path param: The ID of the regulatory (action) requirement. For Australia mobile
+          # ID verification this is `b7c72fb8-fa08-4529-aaf6-b9117d3f3698`.
+          regulatory_requirement_id:,
+          # Body param: 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
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/external_requirements.rbi

@@ -0,0 +1,16 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class ExternalRequirements
+      # Requirement Groups
+      sig { returns(Telnyx::Resources::ExternalRequirements::SubNumberOrders) }
+      attr_reader :sub_number_orders
+
+      # @api private
+      sig { params(client: Telnyx::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end