telnyx 5.169.0 → 5.171.0

data/rbi/telnyx/models/ai/typesafe/v1_systemone_params.rbi

@@ -37,6 +37,26 @@ module Telnyx
           end
           attr_accessor :state
 
+          # Public model alias. telnyx/decision-flash offers the lowest cost and latency;
+          # telnyx/decision-pro supports decisions that require long context, including
+          # inputs beyond Jev’s 32k per-decision limit. Applies to every question in the
+          # request. Other values are rejected.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::AI::Typesafe::V1SystemoneParams::Model::OrSymbol
+              )
+            )
+          end
+          attr_reader :model
+
+          sig do
+            params(
+              model: Telnyx::AI::Typesafe::V1SystemoneParams::Model::OrSymbol
+            ).void
+          end
+          attr_writer :model
+
           sig do
             params(
               questions:
@@ -49,6 +69,7 @@ module Telnyx
                   )
                 ],
               state: Telnyx::AI::Typesafe::V1SystemoneParams::State::Variants,
+              model: Telnyx::AI::Typesafe::V1SystemoneParams::Model::OrSymbol,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
@@ -57,6 +78,11 @@ module Telnyx
             questions:,
             # Shared context evaluated by every question.
             state:,
+            # Public model alias. telnyx/decision-flash offers the lowest cost and latency;
+            # telnyx/decision-pro supports decisions that require long context, including
+            # inputs beyond Jev’s 32k per-decision limit. Applies to every question in the
+            # request. Other values are rejected.
+            model: nil,
             request_options: {}
           )
           end
@@ -74,6 +100,7 @@ module Telnyx
                     )
                   ],
                 state: Telnyx::AI::Typesafe::V1SystemoneParams::State::Variants,
+                model: Telnyx::AI::Typesafe::V1SystemoneParams::Model::OrSymbol,
                 request_options: Telnyx::RequestOptions
               }
             )
@@ -497,6 +524,41 @@ module Telnyx
                 Telnyx::Internal::Type::Converter
               )
           end
+
+          # Public model alias. telnyx/decision-flash offers the lowest cost and latency;
+          # telnyx/decision-pro supports decisions that require long context, including
+          # inputs beyond Jev’s 32k per-decision limit. Applies to every question in the
+          # request. Other values are rejected.
+          module Model
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, Telnyx::AI::Typesafe::V1SystemoneParams::Model)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            TELNYX_DECISION_FLASH =
+              T.let(
+                :"telnyx/decision-flash",
+                Telnyx::AI::Typesafe::V1SystemoneParams::Model::TaggedSymbol
+              )
+            TELNYX_DECISION_PRO =
+              T.let(
+                :"telnyx/decision-pro",
+                Telnyx::AI::Typesafe::V1SystemoneParams::Model::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::AI::Typesafe::V1SystemoneParams::Model::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
       end
     end

data/rbi/telnyx/models/ai/typesafe/v1_systemone_response.rbi

@@ -39,10 +39,13 @@ module Telnyx
           end
           attr_writer :usage
 
-          # Opaque Telnyx-controlled identifier retained for TypeSafe SDK response
-          # compatibility. It is not a selectable model name or a guarantee of a particular
-          # underlying model.
-          sig { returns(String) }
+          # Public model alias used to evaluate the request. Returns telnyx/decision-flash
+          # when model was omitted. The underlying model is managed by Telnyx.
+          sig do
+            returns(
+              Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model::TaggedSymbol
+            )
+          end
           attr_accessor :model
 
           # A complete synchronous evaluation. Answers are returned directly without a data
@@ -58,7 +61,8 @@ module Telnyx
                     Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score::OrHash
                   )
                 ],
-              model: String,
+              model:
+                Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model::OrSymbol,
               usage:
                 Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage::OrHash
             ).returns(T.attached_class)
@@ -67,9 +71,8 @@ module Telnyx
             # Answers keyed by exactly the question IDs in the request. Each answer type
             # matches its question.
             answers:,
-            # Opaque Telnyx-controlled identifier retained for TypeSafe SDK response
-            # compatibility. It is not a selectable model name or a guarantee of a particular
-            # underlying model.
+            # Public model alias used to evaluate the request. Returns telnyx/decision-flash
+            # when model was omitted. The underlying model is managed by Telnyx.
             model:,
             # Token usage for the completed evaluation.
             usage:
@@ -84,7 +87,8 @@ module Telnyx
                     Symbol,
                     Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Variants
                   ],
-                model: String,
+                model:
+                  Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model::TaggedSymbol,
                 usage: Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage
               }
             )
@@ -300,6 +304,42 @@ module Telnyx
             end
           end
 
+          # Public model alias used to evaluate the request. Returns telnyx/decision-flash
+          # when model was omitted. The underlying model is managed by Telnyx.
+          module Model
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            TELNYX_DECISION_FLASH =
+              T.let(
+                :"telnyx/decision-flash",
+                Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model::TaggedSymbol
+              )
+            TELNYX_DECISION_PRO =
+              T.let(
+                :"telnyx/decision-pro",
+                Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           class Usage < Telnyx::Internal::Type::BaseModel
             OrHash =
               T.type_alias do

data/rbi/telnyx/models/ai/voice_settings.rbi

@@ -120,9 +120,9 @@ module Telnyx
         sig { params(use_speaker_boost: T::Boolean).void }
         attr_writer :use_speaker_boost
 
-        # The speed of the voice in the range [0.25, 2.0]. 1.0 is deafult speed. Larger
-        # numbers make the voice faster, smaller numbers make it slower. This is only
-        # applicable for Telnyx Natural voices.
+        # The speed of the voice in the range [0.6, 1.5]. 1.0 is the default speed. Larger
+        # numbers make the voice faster, smaller numbers make it slower. Applies to Telnyx
+        # `Ultra` voices; values outside this range are rejected by the synthesis engine.
         sig { returns(T.nilable(Float)) }
         attr_reader :voice_speed
 
@@ -197,9 +197,9 @@ module Telnyx
           # Amplifies similarity to the original speaker voice. Increases computational load
           # and latency slightly. Only applicable when using ElevenLabs.
           use_speaker_boost: nil,
-          # The speed of the voice in the range [0.25, 2.0]. 1.0 is deafult speed. Larger
-          # numbers make the voice faster, smaller numbers make it slower. This is only
-          # applicable for Telnyx Natural voices.
+          # The speed of the voice in the range [0.6, 1.5]. 1.0 is the default speed. Larger
+          # numbers make the voice faster, smaller numbers make it slower. Applies to Telnyx
+          # `Ultra` voices; values outside this range are rejected by the synthesis engine.
           voice_speed: nil
         )
         end

data/rbi/telnyx/models/ai/webhook_tool.rbi

@@ -18,20 +18,40 @@ module Telnyx
         sig { params(webhook: Telnyx::AI::WebhookTool::Webhook::OrHash).void }
         attr_writer :webhook
 
+        # The maximum number of milliseconds to wait for the webhook to respond before the
+        # tool call is aborted. Set this at the tool level, as a sibling of `type` — a
+        # `timeout_ms` nested inside the `webhook` object is not applied, and the tool
+        # runs at this default instead.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :timeout_ms
+
+        sig { params(timeout_ms: Integer).void }
+        attr_writer :timeout_ms
+
         sig do
           params(
             type: Telnyx::AI::WebhookTool::Type::OrSymbol,
-            webhook: Telnyx::AI::WebhookTool::Webhook::OrHash
+            webhook: Telnyx::AI::WebhookTool::Webhook::OrHash,
+            timeout_ms: Integer
           ).returns(T.attached_class)
         end
-        def self.new(type:, webhook:)
+        def self.new(
+          type:,
+          webhook:,
+          # The maximum number of milliseconds to wait for the webhook to respond before the
+          # tool call is aborted. Set this at the tool level, as a sibling of `type` — a
+          # `timeout_ms` nested inside the `webhook` object is not applied, and the tool
+          # runs at this default instead.
+          timeout_ms: nil
+        )
         end
 
         sig do
           override.returns(
             {
               type: Telnyx::AI::WebhookTool::Type::OrSymbol,
-              webhook: Telnyx::AI::WebhookTool::Webhook
+              webhook: Telnyx::AI::WebhookTool::Webhook,
+              timeout_ms: Integer
             }
           )
         end

data/rbi/telnyx/models/ai/websocket_settings.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class WebsocketSettings < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::WebsocketSettings, Telnyx::Internal::AnyHash)
+          end
+
+        # Integration secret identifier whose value Telnyx sends as an
+        # `Authorization: Bearer <value>` header on the upgrade request. Resolved on every
+        # connection attempt, so a rotated secret is picked up by the next reconnect.
+        sig { returns(T.nilable(String)) }
+        attr_reader :auth_ref
+
+        sig { params(auth_ref: String).void }
+        attr_writer :auth_ref
+
+        # Whether Telnyx opens a WebSocket to `url` for each of this assistant's
+        # conversations. Defaults to `false`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :enabled
+
+        sig { params(enabled: T::Boolean).void }
+        attr_writer :enabled
+
+        # The `ws://` or `wss://` endpoint Telnyx connects to. Required when `enabled` is
+        # `true`. Must be externally reachable — localhost, private IP ranges and `.local`
+        # domains are rejected.
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+
+        sig { params(url: String).void }
+        attr_writer :url
+
+        # Streams conversation and telephony events to a WebSocket server you host, and
+        # accepts messages injected back into the conversation. Telnyx opens the
+        # connection as a client, once per conversation. Delivery is best effort
+        # throughout: while the connection is down events are dropped rather than queued,
+        # and no socket failure is ever allowed to affect the call. Beta feature.
+        sig do
+          params(auth_ref: String, enabled: T::Boolean, url: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Integration secret identifier whose value Telnyx sends as an
+          # `Authorization: Bearer <value>` header on the upgrade request. Resolved on every
+          # connection attempt, so a rotated secret is picked up by the next reconnect.
+          auth_ref: nil,
+          # Whether Telnyx opens a WebSocket to `url` for each of this assistant's
+          # conversations. Defaults to `false`.
+          enabled: nil,
+          # The `ws://` or `wss://` endpoint Telnyx connects to. Required when `enabled` is
+          # `true`. Must be externally reachable — localhost, private IP ranges and `.local`
+          # domains are rejected.
+          url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { auth_ref: String, enabled: T::Boolean, url: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/artifact_completed_webhook_event.rbi

@@ -114,6 +114,11 @@ module Telnyx
         end
         attr_writer :model_provenance
 
+        # The prompt that produced this artifact, or null for a named type. Non-null only
+        # when `type` is `custom`; the five named types always return `null`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :prompt
+
         # The meeting session this event belongs to.
         sig { returns(String) }
         attr_accessor :session_id
@@ -134,6 +139,7 @@ module Telnyx
               Telnyx::ArtifactCompletedWebhookEvent::Data::Content::OrHash,
             model_provenance:
               Telnyx::ArtifactCompletedWebhookEvent::Data::ModelProvenance::OrHash,
+            prompt: T.nilable(String),
             session_id: String,
             type: Telnyx::ArtifactCompletedWebhookEvent::Data::Type::OrSymbol
           ).returns(T.attached_class)
@@ -145,6 +151,9 @@ module Telnyx
           content:,
           # Model that generated the artifact.
           model_provenance:,
+          # The prompt that produced this artifact, or null for a named type. Non-null only
+          # when `type` is `custom`; the five named types always return `null`.
+          prompt:,
           # The meeting session this event belongs to.
           session_id:,
           # Type of the completed artifact.
@@ -159,6 +168,7 @@ module Telnyx
               content: Telnyx::ArtifactCompletedWebhookEvent::Data::Content,
               model_provenance:
                 Telnyx::ArtifactCompletedWebhookEvent::Data::ModelProvenance,
+              prompt: T.nilable(String),
               session_id: String,
               type:
                 Telnyx::ArtifactCompletedWebhookEvent::Data::Type::TaggedSymbol
@@ -241,6 +251,26 @@ module Telnyx
               :action_items,
               Telnyx::ArtifactCompletedWebhookEvent::Data::Type::TaggedSymbol
             )
+          DECISIONS =
+            T.let(
+              :decisions,
+              Telnyx::ArtifactCompletedWebhookEvent::Data::Type::TaggedSymbol
+            )
+          TOPICS =
+            T.let(
+              :topics,
+              Telnyx::ArtifactCompletedWebhookEvent::Data::Type::TaggedSymbol
+            )
+          OPEN_QUESTIONS =
+            T.let(
+              :open_questions,
+              Telnyx::ArtifactCompletedWebhookEvent::Data::Type::TaggedSymbol
+            )
+          CUSTOM =
+            T.let(
+              :custom,
+              Telnyx::ArtifactCompletedWebhookEvent::Data::Type::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/telnyx/models/artifact_failed_webhook_event.rbi

@@ -143,6 +143,26 @@ module Telnyx
               :action_items,
               Telnyx::ArtifactFailedWebhookEvent::Data::Type::TaggedSymbol
             )
+          DECISIONS =
+            T.let(
+              :decisions,
+              Telnyx::ArtifactFailedWebhookEvent::Data::Type::TaggedSymbol
+            )
+          TOPICS =
+            T.let(
+              :topics,
+              Telnyx::ArtifactFailedWebhookEvent::Data::Type::TaggedSymbol
+            )
+          OPEN_QUESTIONS =
+            T.let(
+              :open_questions,
+              Telnyx::ArtifactFailedWebhookEvent::Data::Type::TaggedSymbol
+            )
+          CUSTOM =
+            T.let(
+              :custom,
+              Telnyx::ArtifactFailedWebhookEvent::Data::Type::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/telnyx/models/billing_contact.rbi

@@ -8,16 +8,23 @@ module Telnyx
           T.any(Telnyx::BillingContact, Telnyx::Internal::AnyHash)
         end
 
+      # The email address of the person Telnyx should contact about billing for this
+      # account.
       sig { returns(String) }
       attr_accessor :email
 
+      # The first name of the person Telnyx should contact about billing for this
+      # account.
       sig { returns(String) }
       attr_accessor :first_name
 
+      # The last name of the person Telnyx should contact about billing for this
+      # account.
       sig { returns(String) }
       attr_accessor :last_name
 
-      # E.164 format with leading `+`.
+      # The phone number of the billing contact, in E.164 format, for example
+      # +12125551234.
       sig { returns(String) }
       attr_accessor :phone_number
 
@@ -30,10 +37,17 @@ module Telnyx
         ).returns(T.attached_class)
       end
       def self.new(
+        # The email address of the person Telnyx should contact about billing for this
+        # account.
         email:,
+        # The first name of the person Telnyx should contact about billing for this
+        # account.
         first_name:,
+        # The last name of the person Telnyx should contact about billing for this
+        # account.
         last_name:,
-        # E.164 format with leading `+`.
+        # The phone number of the billing contact, in E.164 format, for example
+        # +12125551234.
         phone_number:
       )
       end

data/rbi/telnyx/models/bpo_authorization_input.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class BpoAuthorizationInput < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::BpoAuthorizationInput, Telnyx::Internal::AnyHash)
+        end
+
+      # Enterprise id of an approved BPO (Business Process Outsourcer) account on your
+      # organization to authorize for this DIR.
+      sig { returns(String) }
+      attr_accessor :bpo_enterprise_id
+
+      # Id of the signed Letter of Authorization document (uploaded via the Telnyx
+      # Documents API) in which the Brand Owner authorizes this BPO.
+      sig { returns(String) }
+      attr_accessor :loa_document_id
+
+      # One authorization to include when creating or updating a DIR: an approved BPO
+      # (Business Process Outsourcer) account plus the signed Letter of Authorization
+      # the Brand Owner granted it.
+      sig do
+        params(bpo_enterprise_id: String, loa_document_id: String).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # Enterprise id of an approved BPO (Business Process Outsourcer) account on your
+        # organization to authorize for this DIR.
+        bpo_enterprise_id:,
+        # Id of the signed Letter of Authorization document (uploaded via the Telnyx
+        # Documents API) in which the Brand Owner authorizes this BPO.
+        loa_document_id:
+      )
+      end
+
+      sig do
+        override.returns({ bpo_enterprise_id: String, loa_document_id: String })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/call_assistant_request.rbi

@@ -169,15 +169,32 @@ module Telnyx
       end
       attr_writer :tools
 
+      # Per-call speech-to-text configuration for the assistant. If omitted, the stored
+      # assistant transcription configuration is used. If supplied, this object replaces
+      # the stored transcription settings. This is separate from the top-level
+      # `transcription` boolean on answer and dial commands.
+      sig { returns(T.nilable(Telnyx::Calls::TranscriptionConfig)) }
+      attr_reader :transcription
+
+      sig do
+        params(transcription: Telnyx::Calls::TranscriptionConfig::OrHash).void
+      end
+      attr_writer :transcription
+
+      # Per-call voice configuration. Set the voice identifier in
+      # `voice_settings.voice`, not in `assistant.voice`. If supplied, this object
+      # replaces the stored voice settings.
       sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
       attr_reader :voice_settings
 
       sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
       attr_writer :voice_settings
 
-      # AI Assistant configuration. All fields except `id` are optional — the
-      # assistant's stored configuration will be used as fallback for any omitted
-      # fields.
+      # AI Assistant configuration and per-call overrides. All fields except `id` are
+      # optional. Omitted assistant fields use the stored configuration. Supplied
+      # `voice_settings` and `transcription` objects replace their stored objects rather
+      # than merging individual settings; include every setting you want to retain.
+      # `dynamic_variables` are merged, with request values taking precedence.
       sig do
         params(
           id: String,
@@ -207,6 +224,7 @@ module Telnyx
                 Telnyx::CallControlRetrievalTool::OrHash
               )
             ],
+          transcription: Telnyx::Calls::TranscriptionConfig::OrHash,
           voice_settings: Telnyx::AI::VoiceSettings::OrHash
         ).returns(T.attached_class)
       end
@@ -256,6 +274,14 @@ module Telnyx
         # Inline tool definitions available to the assistant (webhook, retrieval,
         # transfer, hangup, etc.). Overrides the assistant's stored tools if provided.
         tools: nil,
+        # Per-call speech-to-text configuration for the assistant. If omitted, the stored
+        # assistant transcription configuration is used. If supplied, this object replaces
+        # the stored transcription settings. This is separate from the top-level
+        # `transcription` boolean on answer and dial commands.
+        transcription: nil,
+        # Per-call voice configuration. Set the voice identifier in
+        # `voice_settings.voice`, not in `assistant.voice`. If supplied, this object
+        # replaces the stored voice settings.
         voice_settings: nil
       )
       end
@@ -290,6 +316,7 @@ module Telnyx
                   Telnyx::CallControlRetrievalTool
                 )
               ],
+            transcription: Telnyx::Calls::TranscriptionConfig,
             voice_settings: Telnyx::AI::VoiceSettings
           }
         )