telnyx 5.98.0 → 5.100.0

data/rbi/telnyx/models/uac_connections/action_check_registration_status_params.rbi

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

data/rbi/telnyx/models/uac_connections/action_check_registration_status_response.rbi

@@ -0,0 +1,237 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module UacConnections
+      class ActionCheckRegistrationStatusResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data
+            )
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # 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
+
+          # 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
+
+          # The port of the SIP connection
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :port
+
+          sig { params(port: Integer).void }
+          attr_writer :port
+
+          # Identifies the type of the resource.
+          sig { returns(T.nilable(String)) }
+          attr_reader :record_type
+
+          sig { params(record_type: String).void }
+          attr_writer :record_type
+
+          # 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
+
+          # The current registration status of your SIP connection
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :status
+
+          sig do
+            params(
+              status:
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::OrSymbol
+            ).void
+          end
+          attr_writer :status
+
+          # The protocol of the SIP connection
+          sig { returns(T.nilable(String)) }
+          attr_reader :transport
+
+          sig { params(transport: String).void }
+          attr_writer :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
+
+          sig do
+            params(
+              ip_address: String,
+              last_registration: String,
+              port: Integer,
+              record_type: String,
+              sip_username: String,
+              status:
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::OrSymbol,
+              transport: String,
+              user_agent: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ip used during the SIP connection
+            ip_address: nil,
+            # ISO 8601 formatted date indicating when the resource was last updated.
+            last_registration: nil,
+            # The port of the SIP connection
+            port: nil,
+            # Identifies the type of the resource.
+            record_type: nil,
+            # The user name of the SIP connection
+            sip_username: nil,
+            # The current registration status of your SIP connection
+            status: nil,
+            # The protocol of the SIP connection
+            transport: nil,
+            # The user agent of the SIP connection
+            user_agent: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                ip_address: String,
+                last_registration: String,
+                port: Integer,
+                record_type: String,
+                sip_username: String,
+                status:
+                  Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol,
+                transport: String,
+                user_agent: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The current registration status of your SIP connection
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NOT_APPLICABLE =
+              T.let(
+                :"Not Applicable",
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+            NOT_REGISTERED =
+              T.let(
+                :"Not Registered",
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :Failed,
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+            EXPIRED =
+              T.let(
+                :Expired,
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+            REGISTERED =
+              T.let(
+                :Registered,
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+            UNREGISTERED =
+              T.let(
+                :Unregistered,
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models.rbi

@@ -1798,6 +1798,18 @@ module Telnyx
 
   TransportProtocol = Telnyx::Models::TransportProtocol
 
+  UacConnectionCreateParams = Telnyx::Models::UacConnectionCreateParams
+
+  UacConnectionDeleteParams = Telnyx::Models::UacConnectionDeleteParams
+
+  UacConnectionListParams = Telnyx::Models::UacConnectionListParams
+
+  UacConnectionRetrieveParams = Telnyx::Models::UacConnectionRetrieveParams
+
+  UacConnections = Telnyx::Models::UacConnections
+
+  UacConnectionUpdateParams = Telnyx::Models::UacConnectionUpdateParams
+
   UnsafeUnwrapWebhookEvent = Telnyx::Models::UnsafeUnwrapWebhookEvent
 
   UnwrapWebhookEvent = Telnyx::Models::UnwrapWebhookEvent

data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi

@@ -13,16 +13,12 @@ module Telnyx
           sig do
             params(
               assistant_id: String,
-              versions: T::Array[Telnyx::AI::Assistants::VersionConfig::OrHash],
+              rules:
+                T::Array[Telnyx::AI::Assistants::CanaryDeploy::Rule::OrHash],
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(Telnyx::AI::Assistants::CanaryDeployResponse)
           end
-          def create(
-            assistant_id,
-            # List of version configurations
-            versions:,
-            request_options: {}
-          )
+          def create(assistant_id, rules: nil, request_options: {})
           end
 
           # Endpoint to get a canary deploy configuration for an assistant.
@@ -46,16 +42,12 @@ module Telnyx
           sig do
             params(
               assistant_id: String,
-              versions: T::Array[Telnyx::AI::Assistants::VersionConfig::OrHash],
+              rules:
+                T::Array[Telnyx::AI::Assistants::CanaryDeploy::Rule::OrHash],
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(Telnyx::AI::Assistants::CanaryDeployResponse)
           end
-          def update(
-            assistant_id,
-            # List of version configurations
-            versions:,
-            request_options: {}
-          )
+          def update(assistant_id, rules: nil, request_options: {})
           end
 
           # Endpoint to delete a canary deploy configuration for an assistant.

data/rbi/telnyx/resources/ai/assistants/versions.rbi

@@ -37,10 +37,8 @@ module Telnyx
               dynamic_variables_webhook_timeout_ms: Integer,
               dynamic_variables_webhook_url: String,
               enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol],
-              external_llm:
-                Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm::OrHash,
-              fallback_config:
-                Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::OrHash,
+              external_llm: Telnyx::AI::ExternalLlmReq::OrHash,
+              fallback_config: Telnyx::AI::FallbackConfigReq::OrHash,
               greeting: String,
               insight_settings: Telnyx::AI::InsightSettings::OrHash,
               instructions: String,
@@ -60,7 +58,7 @@ module Telnyx
               name: String,
               observability_settings: Telnyx::AI::ObservabilityReq::OrHash,
               post_conversation_settings:
-                Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings::OrHash,
+                Telnyx::AI::PostConversationSettingsReq::OrHash,
               privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
               tags: T::Array[String],
               telephony_settings: Telnyx::AI::TelephonySettings::OrHash,

data/rbi/telnyx/resources/ai/assistants.rbi

@@ -39,10 +39,8 @@ module Telnyx
             dynamic_variables_webhook_timeout_ms: Integer,
             dynamic_variables_webhook_url: String,
             enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol],
-            external_llm:
-              Telnyx::AI::AssistantCreateParams::ExternalLlm::OrHash,
-            fallback_config:
-              Telnyx::AI::AssistantCreateParams::FallbackConfig::OrHash,
+            external_llm: Telnyx::AI::ExternalLlmReq::OrHash,
+            fallback_config: Telnyx::AI::FallbackConfigReq::OrHash,
             greeting: String,
             insight_settings: Telnyx::AI::InsightSettings::OrHash,
             integrations:
@@ -56,7 +54,7 @@ module Telnyx
             model: String,
             observability_settings: Telnyx::AI::ObservabilityReq::OrHash,
             post_conversation_settings:
-              Telnyx::AI::AssistantCreateParams::PostConversationSettings::OrHash,
+              Telnyx::AI::PostConversationSettingsReq::OrHash,
             privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
             tags: T::Array[String],
             telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
@@ -202,10 +200,8 @@ module Telnyx
             dynamic_variables_webhook_timeout_ms: Integer,
             dynamic_variables_webhook_url: String,
             enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol],
-            external_llm:
-              Telnyx::AI::AssistantUpdateParams::ExternalLlm::OrHash,
-            fallback_config:
-              Telnyx::AI::AssistantUpdateParams::FallbackConfig::OrHash,
+            external_llm: Telnyx::AI::ExternalLlmReq::OrHash,
+            fallback_config: Telnyx::AI::FallbackConfigReq::OrHash,
             greeting: String,
             insight_settings: Telnyx::AI::InsightSettings::OrHash,
             instructions: String,
@@ -221,7 +217,7 @@ module Telnyx
             name: String,
             observability_settings: Telnyx::AI::ObservabilityReq::OrHash,
             post_conversation_settings:
-              Telnyx::AI::AssistantUpdateParams::PostConversationSettings::OrHash,
+              Telnyx::AI::PostConversationSettingsReq::OrHash,
             privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
             promote_to_main: T::Boolean,
             tags: T::Array[String],

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

@@ -450,7 +450,8 @@ module Telnyx
                 Telnyx::Calls::AwsVoiceSettings::OrHash,
                 Telnyx::AzureVoiceSettings::OrHash,
                 Telnyx::RimeVoiceSettings::OrHash,
-                Telnyx::ResembleVoiceSettings::OrHash
+                Telnyx::ResembleVoiceSettings::OrHash,
+                Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings::Xai::OrHash
               ),
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::Calls::ActionGatherUsingAIResponse)
@@ -526,6 +527,8 @@ module Telnyx
           # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`
           # - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
           #   `Inworld.Max.Oliver`). Supported models: `Mini`, `Max`.
+          # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
+          #   `ara`, `rex`, `sal`, `leo`.
           voice: nil,
           # The settings associated with the voice selected
           voice_settings: nil,
@@ -658,7 +661,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings::OrHash,
                 Telnyx::RimeVoiceSettings::OrHash,
                 Telnyx::ResembleVoiceSettings::OrHash,
-                Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld::OrHash
+                Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld::OrHash,
+                Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Xai::OrHash
               ),
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::Calls::ActionGatherUsingSpeakResponse)
@@ -707,6 +711,8 @@ module Telnyx
           #   `voice_settings` to configure precision, sample_rate, and format.
           # - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
           #   `Inworld.Max.Oliver`). Supported models: `Mini`, `Max`.
+          # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
+          #   `ara`, `rex`, `sal`, `leo`.
           #
           # For service_level basic, you may define the gender of the speaker (male or
           # female).
@@ -1068,7 +1074,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings::OrHash,
                 Telnyx::RimeVoiceSettings::OrHash,
                 Telnyx::ResembleVoiceSettings::OrHash,
-                Telnyx::Calls::ActionSpeakParams::VoiceSettings::Inworld::OrHash
+                Telnyx::Calls::ActionSpeakParams::VoiceSettings::Inworld::OrHash,
+                Telnyx::Calls::ActionSpeakParams::VoiceSettings::Xai::OrHash
               ),
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::Calls::ActionSpeakResponse)
@@ -1117,6 +1124,8 @@ module Telnyx
           #   `voice_settings` to configure precision, sample_rate, and format.
           # - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
           #   `Inworld.Max.Oliver`). Supported models: `Mini`, `Max`.
+          # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
+          #   `ara`, `rex`, `sal`, `leo`.
           #
           # For service_level basic, you may define the gender of the speaker (male or
           # female).
@@ -1190,7 +1199,8 @@ module Telnyx
                 Telnyx::Calls::AwsVoiceSettings::OrHash,
                 Telnyx::AzureVoiceSettings::OrHash,
                 Telnyx::RimeVoiceSettings::OrHash,
-                Telnyx::ResembleVoiceSettings::OrHash
+                Telnyx::ResembleVoiceSettings::OrHash,
+                Telnyx::Calls::ActionStartAIAssistantParams::VoiceSettings::Xai::OrHash
               ),
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::Calls::ActionStartAIAssistantResponse)
@@ -1251,6 +1261,8 @@ module Telnyx
           # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`
           # - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
           #   `Inworld.Max.Oliver`). Supported models: `Mini`, `Max`.
+          # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
+          #   `ara`, `rex`, `sal`, `leo`.
           voice: nil,
           # The settings associated with the voice selected
           voice_settings: nil,

data/rbi/telnyx/resources/conferences/actions.rbi

@@ -534,7 +534,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings::OrHash,
                 Telnyx::RimeVoiceSettings::OrHash,
                 Telnyx::ResembleVoiceSettings::OrHash,
-                Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Inworld::OrHash
+                Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Inworld::OrHash,
+                Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Xai::OrHash
               ),
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::Conferences::ActionSpeakResponse)
@@ -583,6 +584,8 @@ module Telnyx
           #   `voice_settings` to configure precision, sample_rate, and format.
           # - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
           #   `Inworld.Max.Oliver`). Supported models: `Mini`, `Max`.
+          # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
+          #   `ara`, `rex`, `sal`, `leo`.
           #
           # For service_level basic, you may define the gender of the speaker (male or
           # female).

data/rbi/telnyx/resources/uac_connections/actions.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class UacConnections
+      # UAC connection operations
+      class Actions
+        # Checks the registration status for a UAC connection (`registration_status`) as
+        # well as the timestamp for the last SIP registration event
+        # (`registration_status_updated_at`).
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse
+          )
+        end
+        def check_registration_status(
+          # Identifies the resource.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end