telnyx 5.169.0 → 5.171.0

data/lib/telnyx/models/ai/transcription_settings.rb

@@ -11,6 +11,28 @@ module Telnyx
         #   @return [String, nil]
         optional :api_key_ref, String
 
+        # @!attribute challenger
+        #   A second speech-to-text model that transcribes alongside `transcription.model`,
+        #   and the rule that decides which transcript the assistant uses.
+        #
+        #   @return [Telnyx::Models::AI::TranscriptionSettings::Challenger, nil]
+        optional :challenger, -> { Telnyx::AI::TranscriptionSettings::Challenger }, nil?: true
+
+        # @!attribute fallback_models
+        #   Up to 3 streaming models that take over transcription, in this order, when the
+        #   model in use fails, at the start of a call or mid-call. `model` must be a
+        #   streaming model too, and must support `language` alongside other models. On
+        #   update, a list replaces the stored one: omit the field to keep the stored list,
+        #   or send `null` or `[]` to remove it. When an update changes `model` or
+        #   `language`, stored fallbacks that no longer fit are removed without an error.
+        #   Can't be combined with `challenger`, the language booster; to replace a stored
+        #   language booster, send `challenger: null` in the same request.
+        #
+        #   @return [Array<Telnyx::Models::AI::TranscriptionSettings::FallbackModel>, nil]
+        optional :fallback_models,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::TranscriptionSettings::FallbackModel] },
+                 nil?: true
+
         # @!attribute language
         #   The language of the audio to be transcribed. If not set, or if set to `auto`,
         #   supported models will automatically detect the language. For `deepgram/flux`,
@@ -57,6 +79,7 @@ module Telnyx
         #   - `reson8/turns` is a turn-based streaming model covering 10 European languages
         #     with automatic language detection.
         #   - `cohere/ar-stt` is a non-streaming Arabic and English transcription model.
+        #   - `telnyx/basira` is a non-streaming Arabic transcription model.
         #
         #   @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model, nil]
         optional :model, enum: -> { Telnyx::AI::TranscriptionSettings::Model }
@@ -73,12 +96,16 @@ module Telnyx
         #   @return [Telnyx::Models::AI::TranscriptionSettingsConfig, nil]
         optional :settings, -> { Telnyx::AI::TranscriptionSettingsConfig }
 
-        # @!method initialize(api_key_ref: nil, language: nil, model: nil, region: nil, settings: nil)
+        # @!method initialize(api_key_ref: nil, challenger: nil, fallback_models: nil, language: nil, model: nil, region: nil, settings: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::TranscriptionSettings} for more details.
         #
         #   @param api_key_ref [String] Integration secret identifier for the transcription provider API key. Currently
         #
+        #   @param challenger [Telnyx::Models::AI::TranscriptionSettings::Challenger, nil] A second speech-to-text model that transcribes alongside `transcription.model`,
+        #
+        #   @param fallback_models [Array<Telnyx::Models::AI::TranscriptionSettings::FallbackModel>, nil] Up to 3 streaming models that take over transcription, in this order, when the m
+        #
         #   @param language [String] The language of the audio to be transcribed. If not set, or if set to `auto`, su
         #
         #   @param model [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model] The speech to text model to be used by the voice assistant. All Deepgram models
@@ -87,6 +114,215 @@ module Telnyx
         #
         #   @param settings [Telnyx::Models::AI::TranscriptionSettingsConfig]
 
+        # @see Telnyx::Models::AI::TranscriptionSettings#challenger
+        class Challenger < Telnyx::Internal::Type::BaseModel
+          # @!attribute model
+          #   The language booster's model. It must be the same kind of model as
+          #   `transcription.model`: both streaming (`deepgram/flux`, `deepgram/nova-3`,
+          #   `deepgram/nova-2`, `assemblyai/universal-3-5-pro` or its legacy alias
+          #   `assemblyai/universal-streaming`, `xai/grok-stt`, `soniox/stt-rt-v4`,
+          #   `soniox/stt-rt-v5`, `humain/realtime`, `reson8/turns`) or both non-streaming
+          #   (`azure/fast`, `nvidia/parakeet-v3`, `omi-health/omi-med-stt-v1`,
+          #   `cohere/ar-stt`, `distil-whisper/distil-large-v2`,
+          #   `openai/whisper-large-v3-turbo`, `telnyx/basira`). It can be the same model as
+          #   `transcription.model` on a different `language`.
+          #
+          #   @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::Challenger::Model]
+          required :model, enum: -> { Telnyx::AI::TranscriptionSettings::Challenger::Model }
+
+          # @!attribute language
+          #   The language this model transcribes. Omit it or set it to `null` to use the
+          #   language of `transcription.model`. The request is rejected when this model
+          #   doesn't support the language it would run. It is also rejected when it would run
+          #   the same model on the same language as `transcription.model`.
+          #
+          #   @return [String, nil]
+          optional :language, String, nil?: true
+
+          # @!attribute rule
+          #   How the assistant picks the transcript it uses. The models are compared on how
+          #   complete and confident their transcripts are, not on language, so the rules work
+          #   best when both models understand the callers' language.
+          #
+          #   - `best_turn` (default): both models transcribe the whole call. Each turn uses
+          #     the language booster's transcript only when it scores higher than the
+          #     transcript of `transcription.model` (clearly higher with non-streaming
+          #     models). With streaming models, `transcription.model` also decides when each
+          #     turn ends. Available for every pair.
+          #   - `best_engine`: both models transcribe the first turns, then the call continues
+          #     alone on the model whose transcripts scored higher. If neither clearly leads,
+          #     `transcription.model` continues. Streaming models only.
+          #   - `merge_words`: both models transcribe each utterance and their words are
+          #     merged, keeping Arabic and English spoken in the same sentence. Available only
+          #     for `telnyx/basira` with `cohere/ar-stt`, in either order. The pair runs on
+          #     the language that applies to `telnyx/basira` (its own, or that of
+          #     `transcription.model`), which must be Arabic (`ar` or an `ar-` locale),
+          #     `multi`, or `auto`.
+          #
+          #   @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::Challenger::Rule, nil]
+          optional :rule, enum: -> { Telnyx::AI::TranscriptionSettings::Challenger::Rule }
+
+          # @!attribute settings
+          #   Settings for the language booster, with the same fields and limits as
+          #   `transcription.settings`. Fields that don't apply to this model's provider are
+          #   dropped, and the provider's defaults fill in the rest. Omit it or set it to
+          #   `null` to use the settings of `transcription.model` where they apply to this
+          #   model.
+          #
+          #   @return [Telnyx::Models::AI::TranscriptionSettingsConfig, nil]
+          optional :settings, -> { Telnyx::AI::TranscriptionSettingsConfig }, nil?: true
+
+          # @!method initialize(model:, language: nil, rule: nil, settings: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::TranscriptionSettings::Challenger} for more details.
+          #
+          #   A second speech-to-text model that transcribes alongside `transcription.model`,
+          #   and the rule that decides which transcript the assistant uses.
+          #
+          #   @param model [Symbol, Telnyx::Models::AI::TranscriptionSettings::Challenger::Model] The language booster's model. It must be the same kind of model as `transcriptio
+          #
+          #   @param language [String, nil] The language this model transcribes. Omit it or set it to `null` to use the lang
+          #
+          #   @param rule [Symbol, Telnyx::Models::AI::TranscriptionSettings::Challenger::Rule] How the assistant picks the transcript it uses. The models are compared on how c
+          #
+          #   @param settings [Telnyx::Models::AI::TranscriptionSettingsConfig, nil] Settings for the language booster, with the same fields and limits as `transcrip
+
+          # The language booster's model. It must be the same kind of model as
+          # `transcription.model`: both streaming (`deepgram/flux`, `deepgram/nova-3`,
+          # `deepgram/nova-2`, `assemblyai/universal-3-5-pro` or its legacy alias
+          # `assemblyai/universal-streaming`, `xai/grok-stt`, `soniox/stt-rt-v4`,
+          # `soniox/stt-rt-v5`, `humain/realtime`, `reson8/turns`) or both non-streaming
+          # (`azure/fast`, `nvidia/parakeet-v3`, `omi-health/omi-med-stt-v1`,
+          # `cohere/ar-stt`, `distil-whisper/distil-large-v2`,
+          # `openai/whisper-large-v3-turbo`, `telnyx/basira`). It can be the same model as
+          # `transcription.model` on a different `language`.
+          #
+          # @see Telnyx::Models::AI::TranscriptionSettings::Challenger#model
+          module Model
+            extend Telnyx::Internal::Type::Enum
+
+            DEEPGRAM_FLUX = :"deepgram/flux"
+            DEEPGRAM_NOVA_3 = :"deepgram/nova-3"
+            DEEPGRAM_NOVA_2 = :"deepgram/nova-2"
+            AZURE_FAST = :"azure/fast"
+            ASSEMBLYAI_UNIVERSAL_3_5_PRO = :"assemblyai/universal-3-5-pro"
+            ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
+            XAI_GROK_STT = :"xai/grok-stt"
+            SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
+            SONIOX_STT_RT_V5 = :"soniox/stt-rt-v5"
+            NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
+            OMI_HEALTH_OMI_MED_STT_V1 = :"omi-health/omi-med-stt-v1"
+            HUMAIN_REALTIME = :"humain/realtime"
+            RESON8_TURNS = :"reson8/turns"
+            COHERE_AR_STT = :"cohere/ar-stt"
+            TELNYX_BASIRA = :"telnyx/basira"
+            DISTIL_WHISPER_DISTIL_LARGE_V2 = :"distil-whisper/distil-large-v2"
+            OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # How the assistant picks the transcript it uses. The models are compared on how
+          # complete and confident their transcripts are, not on language, so the rules work
+          # best when both models understand the callers' language.
+          #
+          # - `best_turn` (default): both models transcribe the whole call. Each turn uses
+          #   the language booster's transcript only when it scores higher than the
+          #   transcript of `transcription.model` (clearly higher with non-streaming
+          #   models). With streaming models, `transcription.model` also decides when each
+          #   turn ends. Available for every pair.
+          # - `best_engine`: both models transcribe the first turns, then the call continues
+          #   alone on the model whose transcripts scored higher. If neither clearly leads,
+          #   `transcription.model` continues. Streaming models only.
+          # - `merge_words`: both models transcribe each utterance and their words are
+          #   merged, keeping Arabic and English spoken in the same sentence. Available only
+          #   for `telnyx/basira` with `cohere/ar-stt`, in either order. The pair runs on
+          #   the language that applies to `telnyx/basira` (its own, or that of
+          #   `transcription.model`), which must be Arabic (`ar` or an `ar-` locale),
+          #   `multi`, or `auto`.
+          #
+          # @see Telnyx::Models::AI::TranscriptionSettings::Challenger#rule
+          module Rule
+            extend Telnyx::Internal::Type::Enum
+
+            BEST_TURN = :best_turn
+            BEST_ENGINE = :best_engine
+            MERGE_WORDS = :merge_words
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class FallbackModel < Telnyx::Internal::Type::BaseModel
+          # @!attribute model
+          #   The fallback model. It must be a streaming model other than
+          #   `transcription.model` and the other fallbacks: `deepgram/flux`,
+          #   `deepgram/nova-3`, `deepgram/nova-2`, `assemblyai/universal-3-5-pro` (or its
+          #   legacy alias `assemblyai/universal-streaming`), `xai/grok-stt`,
+          #   `soniox/stt-rt-v4`, `soniox/stt-rt-v5`, `humain/realtime`, or `reson8/turns`.
+          #
+          #   @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::FallbackModel::Model]
+          required :model, enum: -> { Telnyx::AI::TranscriptionSettings::FallbackModel::Model }
+
+          # @!attribute language
+          #   The language the fallback transcribes. Omit it or set it to `null` to use the
+          #   language of `transcription.model`. The request is rejected when the fallback
+          #   model doesn't support the language it would run.
+          #
+          #   @return [String, nil]
+          optional :language, String, nil?: true
+
+          # @!attribute settings
+          #   Settings for the fallback, with the same fields and limits as
+          #   `transcription.settings`. Fields that don't apply to this model's provider are
+          #   dropped, and the provider's defaults fill in the rest. Omit it or set it to
+          #   `null` to use the settings of `transcription.model` where they apply to this
+          #   model.
+          #
+          #   @return [Telnyx::Models::AI::TranscriptionSettingsConfig, nil]
+          optional :settings, -> { Telnyx::AI::TranscriptionSettingsConfig }, nil?: true
+
+          # @!method initialize(model:, language: nil, settings: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::TranscriptionSettings::FallbackModel} for more details.
+          #
+          #   A streaming speech-to-text model that takes over transcription when the model in
+          #   use fails.
+          #
+          #   @param model [Symbol, Telnyx::Models::AI::TranscriptionSettings::FallbackModel::Model] The fallback model. It must be a streaming model other than `transcription.model
+          #
+          #   @param language [String, nil] The language the fallback transcribes. Omit it or set it to `null` to use the la
+          #
+          #   @param settings [Telnyx::Models::AI::TranscriptionSettingsConfig, nil] Settings for the fallback, with the same fields and limits as `transcription.set
+
+          # The fallback model. It must be a streaming model other than
+          # `transcription.model` and the other fallbacks: `deepgram/flux`,
+          # `deepgram/nova-3`, `deepgram/nova-2`, `assemblyai/universal-3-5-pro` (or its
+          # legacy alias `assemblyai/universal-streaming`), `xai/grok-stt`,
+          # `soniox/stt-rt-v4`, `soniox/stt-rt-v5`, `humain/realtime`, or `reson8/turns`.
+          #
+          # @see Telnyx::Models::AI::TranscriptionSettings::FallbackModel#model
+          module Model
+            extend Telnyx::Internal::Type::Enum
+
+            DEEPGRAM_FLUX = :"deepgram/flux"
+            DEEPGRAM_NOVA_3 = :"deepgram/nova-3"
+            DEEPGRAM_NOVA_2 = :"deepgram/nova-2"
+            ASSEMBLYAI_UNIVERSAL_3_5_PRO = :"assemblyai/universal-3-5-pro"
+            ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
+            XAI_GROK_STT = :"xai/grok-stt"
+            SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
+            SONIOX_STT_RT_V5 = :"soniox/stt-rt-v5"
+            HUMAIN_REALTIME = :"humain/realtime"
+            RESON8_TURNS = :"reson8/turns"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # The speech to text model to be used by the voice assistant. All Deepgram models
         # are run on-premise.
         #
@@ -110,6 +346,7 @@ module Telnyx
         # - `reson8/turns` is a turn-based streaming model covering 10 European languages
         #   with automatic language detection.
         # - `cohere/ar-stt` is a non-streaming Arabic and English transcription model.
+        # - `telnyx/basira` is a non-streaming Arabic transcription model.
         #
         # @see Telnyx::Models::AI::TranscriptionSettings#model
         module Model
@@ -129,6 +366,7 @@ module Telnyx
           HUMAIN_REALTIME = :"humain/realtime"
           RESON8_TURNS = :"reson8/turns"
           COHERE_AR_STT = :"cohere/ar-stt"
+          TELNYX_BASIRA = :"telnyx/basira"
           DISTIL_WHISPER_DISTIL_LARGE_V2 = :"distil-whisper/distil-large-v2"
           OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
 

data/lib/telnyx/models/ai/typesafe/v1_systemone_params.rb

@@ -22,11 +22,25 @@ module Telnyx
           #   @return [String, Hash{Symbol=>Object}, Array<Object>]
           required :state, union: -> { Telnyx::AI::Typesafe::V1SystemoneParams::State }
 
-          # @!method initialize(questions:, state:, request_options: {})
+          # @!attribute model
+          #   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.
+          #
+          #   @return [Symbol, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Model, nil]
+          optional :model, enum: -> { Telnyx::AI::Typesafe::V1SystemoneParams::Model }
+
+          # @!method initialize(questions:, state:, model: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::Typesafe::V1SystemoneParams} for more details.
+          #
           #   @param questions [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score}] Between 1 and 64 named questions. Each key identifies the corresponding answer.
           #
           #   @param state [String, Hash{Symbol=>Object}, Array<Object>] Shared context evaluated by every question.
           #
+          #   @param model [Symbol, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Model] Public model alias. telnyx/decision-flash offers the lowest cost and latency; te
+          #
           #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
           # A choice, yes/no, or ordered-score question.
@@ -261,6 +275,20 @@ module Telnyx
             # @type [Telnyx::Internal::Type::Converter]
             UnionMember2Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
           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
+
+            TELNYX_DECISION_FLASH = :"telnyx/decision-flash"
+            TELNYX_DECISION_PRO = :"telnyx/decision-pro"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
       end
     end

data/lib/telnyx/models/ai/typesafe/v1_systemone_response.rb

@@ -22,12 +22,11 @@ module Telnyx
 
           response_only do
             # @!attribute model
-            #   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.
             #
-            #   @return [String]
-            required :model, String
+            #   @return [Symbol, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model]
+            required :model, enum: -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model }
           end
 
           # @!method initialize(answers:, model:, usage:)
@@ -39,7 +38,7 @@ module Telnyx
           #
           #   @param answers [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score}] Answers keyed by exactly the question IDs in the request. Each answer type match
           #
-          #   @param model [String] Opaque Telnyx-controlled identifier retained for TypeSafe SDK response compatibi
+          #   @param model [Symbol, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model] Public model alias used to evaluate the request. Returns telnyx/decision-flash w
           #
           #   @param usage [Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage] Token usage for the completed evaluation.
 
@@ -190,6 +189,20 @@ module Telnyx
             #   @return [Array(Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score)]
           end
 
+          # Public model alias used to evaluate the request. Returns telnyx/decision-flash
+          # when model was omitted. The underlying model is managed by Telnyx.
+          #
+          # @see Telnyx::Models::AI::Typesafe::V1SystemoneResponse#model
+          module Model
+            extend Telnyx::Internal::Type::Enum
+
+            TELNYX_DECISION_FLASH = :"telnyx/decision-flash"
+            TELNYX_DECISION_PRO = :"telnyx/decision-pro"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # @see Telnyx::Models::AI::Typesafe::V1SystemoneResponse#usage
           class Usage < Telnyx::Internal::Type::BaseModel
             # @!attribute input_tokens

data/lib/telnyx/models/ai/voice_settings.rb

@@ -91,9 +91,9 @@ module Telnyx
         optional :use_speaker_boost, Telnyx::Internal::Type::Boolean
 
         # @!attribute voice_speed
-        #   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.
         #
         #   @return [Float, nil]
         optional :voice_speed, Float
@@ -122,7 +122,7 @@ module Telnyx
         #
         #   @param use_speaker_boost [Boolean] Amplifies similarity to the original speaker voice. Increases computational load
         #
-        #   @param voice_speed [Float] The speed of the voice in the range [0.25, 2.0]. 1.0 is deafult speed. Larger nu
+        #   @param voice_speed [Float] The speed of the voice in the range [0.6, 1.5]. 1.0 is the default speed. Larger
 
         # Optional background audio to play on the call. Use a predefined media bed, or
         # supply a looped MP3 URL. If a media URL is chosen in the portal, customers can

data/lib/telnyx/models/ai/webhook_tool.rb

@@ -14,9 +14,24 @@ module Telnyx
         #   @return [Telnyx::Models::AI::WebhookTool::Webhook]
         required :webhook, -> { Telnyx::AI::WebhookTool::Webhook }
 
-        # @!method initialize(type:, webhook:)
+        # @!attribute timeout_ms
+        #   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.
+        #
+        #   @return [Integer, nil]
+        optional :timeout_ms, Integer
+
+        # @!method initialize(type:, webhook:, timeout_ms: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::WebhookTool} for more details.
+        #
         #   @param type [Symbol, Telnyx::Models::AI::WebhookTool::Type]
+        #
         #   @param webhook [Telnyx::Models::AI::WebhookTool::Webhook]
+        #
+        #   @param timeout_ms [Integer] The maximum number of milliseconds to wait for the webhook to respond before the
 
         # @see Telnyx::Models::AI::WebhookTool#type
         module Type

data/lib/telnyx/models/ai/websocket_settings.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class WebsocketSettings < Telnyx::Internal::Type::BaseModel
+        # @!attribute auth_ref
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :auth_ref, String
+
+        # @!attribute enabled
+        #   Whether Telnyx opens a WebSocket to `url` for each of this assistant's
+        #   conversations. Defaults to `false`.
+        #
+        #   @return [Boolean, nil]
+        optional :enabled, Telnyx::Internal::Type::Boolean
+
+        # @!attribute url
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!method initialize(auth_ref: nil, enabled: nil, url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::WebsocketSettings} for more details.
+        #
+        #   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.
+        #
+        #   @param auth_ref [String] Integration secret identifier whose value Telnyx sends as an `Authorization: Bea
+        #
+        #   @param enabled [Boolean] Whether Telnyx opens a WebSocket to `url` for each of this assistant's conversat
+        #
+        #   @param url [String] The `ws://` or `wss://` endpoint Telnyx connects to. Required when `enabled` is
+      end
+    end
+  end
+end

data/lib/telnyx/models/artifact_completed_webhook_event.rb

@@ -64,6 +64,13 @@ module Telnyx
         #   @return [Telnyx::Models::ArtifactCompletedWebhookEvent::Data::ModelProvenance]
         required :model_provenance, -> { Telnyx::ArtifactCompletedWebhookEvent::Data::ModelProvenance }
 
+        # @!attribute prompt
+        #   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`.
+        #
+        #   @return [String, nil]
+        required :prompt, String, nil?: true
+
         # @!attribute session_id
         #   The meeting session this event belongs to.
         #
@@ -76,7 +83,10 @@ module Telnyx
         #   @return [Symbol, Telnyx::Models::ArtifactCompletedWebhookEvent::Data::Type]
         required :type, enum: -> { Telnyx::ArtifactCompletedWebhookEvent::Data::Type }
 
-        # @!method initialize(artifact_id:, content:, model_provenance:, session_id:, type:)
+        # @!method initialize(artifact_id:, content:, model_provenance:, prompt:, session_id:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::ArtifactCompletedWebhookEvent::Data} for more details.
+        #
         #   Completed artifact, including its generated content.
         #
         #   @param artifact_id [String] Id of the completed artifact.
@@ -85,6 +95,8 @@ module Telnyx
         #
         #   @param model_provenance [Telnyx::Models::ArtifactCompletedWebhookEvent::Data::ModelProvenance] Model that generated the artifact.
         #
+        #   @param prompt [String, nil] The prompt that produced this artifact, or null for a named type. Non-null only
+        #
         #   @param session_id [String] The meeting session this event belongs to.
         #
         #   @param type [Symbol, Telnyx::Models::ArtifactCompletedWebhookEvent::Data::Type] Type of the completed artifact.
@@ -130,6 +142,10 @@ module Telnyx
 
           SUMMARY = :summary
           ACTION_ITEMS = :action_items
+          DECISIONS = :decisions
+          TOPICS = :topics
+          OPEN_QUESTIONS = :open_questions
+          CUSTOM = :custom
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/telnyx/models/artifact_failed_webhook_event.rb

@@ -81,6 +81,10 @@ module Telnyx
 
           SUMMARY = :summary
           ACTION_ITEMS = :action_items
+          DECISIONS = :decisions
+          TOPICS = :topics
+          OPEN_QUESTIONS = :open_questions
+          CUSTOM = :custom
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/telnyx/models/billing_contact.rb

@@ -4,34 +4,44 @@ module Telnyx
   module Models
     class BillingContact < Telnyx::Internal::Type::BaseModel
       # @!attribute email
+      #   The email address of the person Telnyx should contact about billing for this
+      #   account.
       #
       #   @return [String]
       required :email, String
 
       # @!attribute first_name
+      #   The first name of the person Telnyx should contact about billing for this
+      #   account.
       #
       #   @return [String]
       required :first_name, String
 
       # @!attribute last_name
+      #   The last name of the person Telnyx should contact about billing for this
+      #   account.
       #
       #   @return [String]
       required :last_name, String
 
       # @!attribute phone_number
-      #   E.164 format with leading `+`.
+      #   The phone number of the billing contact, in E.164 format, for example
+      #   +12125551234.
       #
       #   @return [String]
       required :phone_number, String
 
       # @!method initialize(email:, first_name:, last_name:, phone_number:)
-      #   @param email [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::BillingContact} for more details.
       #
-      #   @param first_name [String]
+      #   @param email [String] The email address of the person Telnyx should contact about billing for this acc
       #
-      #   @param last_name [String]
+      #   @param first_name [String] The first name of the person Telnyx should contact about billing for this accoun
       #
-      #   @param phone_number [String] E.164 format with leading `+`.
+      #   @param last_name [String] The last name of the person Telnyx should contact about billing for this account
+      #
+      #   @param phone_number [String] The phone number of the billing contact, in E.164 format, for example +121255512
     end
   end
 end

data/lib/telnyx/models/bpo_authorization_input.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class BpoAuthorizationInput < Telnyx::Internal::Type::BaseModel
+      # @!attribute bpo_enterprise_id
+      #   Enterprise id of an approved BPO (Business Process Outsourcer) account on your
+      #   organization to authorize for this DIR.
+      #
+      #   @return [String]
+      required :bpo_enterprise_id, String
+
+      # @!attribute loa_document_id
+      #   Id of the signed Letter of Authorization document (uploaded via the Telnyx
+      #   Documents API) in which the Brand Owner authorizes this BPO.
+      #
+      #   @return [String]
+      required :loa_document_id, String
+
+      # @!method initialize(bpo_enterprise_id:, loa_document_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::BpoAuthorizationInput} for more details.
+      #
+      #   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.
+      #
+      #   @param bpo_enterprise_id [String] Enterprise id of an approved BPO (Business Process Outsourcer) account on your o
+      #
+      #   @param loa_document_id [String] Id of the signed Letter of Authorization document (uploaded via the Telnyx Docum
+    end
+  end
+end