telnyx 5.169.0 → 5.171.0

data/rbi/telnyx/models/calls/action_pay_params.rbi

@@ -92,6 +92,17 @@ module Telnyx
         sig { params(metadata: T::Hash[Symbol, T.anything]).void }
         attr_writer :metadata
 
+        # Minimum number of digits the caller must enter when collecting a credit-card
+        # billing postal code. Applies only when `postal_code` is `true` or `"true"` and
+        # no `payment_token` is supplied. The default is 1. The maximum number of digits
+        # collected is the greater of 10 and this value. This does not validate the length
+        # of a postal code supplied directly in `postal_code`.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :min_postal_code_length
+
+        sig { params(min_postal_code_length: Integer).void }
+        attr_writer :min_postal_code_length
+
         # Additional parameters forwarded to the Pay connector.
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :parameters
@@ -122,6 +133,28 @@ module Telnyx
         sig { params(payment_token: String).void }
         attr_writer :payment_token
 
+        # Controls billing postal code collection for credit-card payments when no
+        # `payment_token` is supplied. Set to `true` or the string `"true"` (the default)
+        # to prompt the caller for a postal code. Set to `false` or the string `"false"`
+        # to skip the postal code prompt without supplying a postal code to the payment
+        # connector. Supply any other non-empty string, such as `"90210"`, to use that
+        # postal code without prompting. Empty or whitespace-only strings are rejected.
+        # This option does not affect ACH debit payments or payments using an existing
+        # token.
+        sig do
+          returns(
+            T.nilable(Telnyx::Calls::ActionPayParams::PostalCode::Variants)
+          )
+        end
+        attr_reader :postal_code
+
+        sig do
+          params(
+            postal_code: Telnyx::Calls::ActionPayParams::PostalCode::Variants
+          ).void
+        end
+        attr_writer :postal_code
+
         # Custom text-to-speech prompts keyed by payment collection step.
         sig { returns(T.nilable(Telnyx::Calls::ActionPayParams::Prompts)) }
         attr_reader :prompts
@@ -206,10 +239,12 @@ module Telnyx
             language: String,
             max_attempts: Integer,
             metadata: T::Hash[Symbol, T.anything],
+            min_postal_code_length: Integer,
             parameters: T::Hash[Symbol, T.anything],
             payment_method:
               Telnyx::Calls::ActionPayParams::PaymentMethod::OrSymbol,
             payment_token: String,
+            postal_code: Telnyx::Calls::ActionPayParams::PostalCode::Variants,
             prompts: Telnyx::Calls::ActionPayParams::Prompts::OrHash,
             service_level: String,
             timeout_millis: Integer,
@@ -244,12 +279,27 @@ module Telnyx
           max_attempts: nil,
           # Metadata forwarded to the Pay connector.
           metadata: nil,
+          # Minimum number of digits the caller must enter when collecting a credit-card
+          # billing postal code. Applies only when `postal_code` is `true` or `"true"` and
+          # no `payment_token` is supplied. The default is 1. The maximum number of digits
+          # collected is the greater of 10 and this value. This does not validate the length
+          # of a postal code supplied directly in `postal_code`.
+          min_postal_code_length: nil,
           # Additional parameters forwarded to the Pay connector.
           parameters: nil,
           # Payment method to collect.
           payment_method: nil,
           # Existing payment token. When supplied, payment-detail collection is skipped.
           payment_token: nil,
+          # Controls billing postal code collection for credit-card payments when no
+          # `payment_token` is supplied. Set to `true` or the string `"true"` (the default)
+          # to prompt the caller for a postal code. Set to `false` or the string `"false"`
+          # to skip the postal code prompt without supplying a postal code to the payment
+          # connector. Supply any other non-empty string, such as `"90210"`, to use that
+          # postal code without prompting. Empty or whitespace-only strings are rejected.
+          # This option does not affect ACH debit payments or payments using an existing
+          # token.
+          postal_code: nil,
           # Custom text-to-speech prompts keyed by payment collection step.
           prompts: nil,
           # Speech synthesis service level used for payment prompts. Pay defaults to
@@ -287,10 +337,12 @@ module Telnyx
               language: String,
               max_attempts: Integer,
               metadata: T::Hash[Symbol, T.anything],
+              min_postal_code_length: Integer,
               parameters: T::Hash[Symbol, T.anything],
               payment_method:
                 Telnyx::Calls::ActionPayParams::PaymentMethod::OrSymbol,
               payment_token: String,
+              postal_code: Telnyx::Calls::ActionPayParams::PostalCode::Variants,
               prompts: Telnyx::Calls::ActionPayParams::Prompts,
               service_level: String,
               timeout_millis: Integer,
@@ -364,6 +416,28 @@ module Telnyx
           end
         end
 
+        # Controls billing postal code collection for credit-card payments when no
+        # `payment_token` is supplied. Set to `true` or the string `"true"` (the default)
+        # to prompt the caller for a postal code. Set to `false` or the string `"false"`
+        # to skip the postal code prompt without supplying a postal code to the payment
+        # connector. Supply any other non-empty string, such as `"90210"`, to use that
+        # postal code without prompting. Empty or whitespace-only strings are rejected.
+        # This option does not affect ACH debit payments or payments using an existing
+        # token.
+        module PostalCode
+          extend Telnyx::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, T::Boolean) }
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::Calls::ActionPayParams::PostalCode::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+
         class Prompts < Telnyx::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/telnyx/models/calls/action_reject_params.rbi

@@ -15,7 +15,10 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :call_control_id
 
-        # Cause for call rejection.
+        # Cause for call rejection. The cause sets the SIP response the caller receives:
+        # `USER_BUSY` sends 486 User Busy, `CALL_REJECTED` sends 603 Decline, `NOT_FOUND`
+        # sends 404 Not Found, and `TEMPORARILY_UNAVAILABLE` sends 480 Temporarily
+        # Unavailable.
         sig { returns(Telnyx::Calls::ActionRejectParams::Cause::OrSymbol) }
         attr_accessor :cause
 
@@ -46,7 +49,10 @@ module Telnyx
         end
         def self.new(
           call_control_id:,
-          # Cause for call rejection.
+          # Cause for call rejection. The cause sets the SIP response the caller receives:
+          # `USER_BUSY` sends 486 User Busy, `CALL_REJECTED` sends 603 Decline, `NOT_FOUND`
+          # sends 404 Not Found, and `TEMPORARILY_UNAVAILABLE` sends 480 Temporarily
+          # Unavailable.
           cause:,
           # Use this field to add state to every subsequent webhook. It must be a valid
           # Base-64 encoded string.
@@ -72,7 +78,10 @@ module Telnyx
         def to_hash
         end
 
-        # Cause for call rejection.
+        # Cause for call rejection. The cause sets the SIP response the caller receives:
+        # `USER_BUSY` sends 486 User Busy, `CALL_REJECTED` sends 603 Decline, `NOT_FOUND`
+        # sends 404 Not Found, and `TEMPORARILY_UNAVAILABLE` sends 480 Temporarily
+        # Unavailable.
         module Cause
           extend Telnyx::Internal::Type::Enum
 
@@ -87,6 +96,16 @@ module Telnyx
               :CALL_REJECTED,
               Telnyx::Calls::ActionRejectParams::Cause::TaggedSymbol
             )
+          NOT_FOUND =
+            T.let(
+              :NOT_FOUND,
+              Telnyx::Calls::ActionRejectParams::Cause::TaggedSymbol
+            )
+          TEMPORARILY_UNAVAILABLE =
+            T.let(
+              :TEMPORARILY_UNAVAILABLE,
+              Telnyx::Calls::ActionRejectParams::Cause::TaggedSymbol
+            )
           USER_BUSY =
             T.let(
               :USER_BUSY,

data/rbi/telnyx/models/calls/action_speak_params.rbi

@@ -63,6 +63,12 @@ module Telnyx
         # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
         #   `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
         #   `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+        # - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+        #   Supported model: `tts-rt-v2`. Browse the catalog via the
+        #   [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+        #   Every voice speaks all supported languages; set `language` to the two-letter
+        #   ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+        #   `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
         # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
         #   `ara`, `rex`, `sal`, `leo`.
         # - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -186,7 +192,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings,
                 Telnyx::ResembleVoiceSettings,
                 Telnyx::InworldVoiceSettings,
-                Telnyx::XaiVoiceSettings
+                Telnyx::XaiVoiceSettings,
+                Telnyx::Calls::SonioxVoiceSettings
               )
             )
           )
@@ -204,7 +211,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings::OrHash,
                 Telnyx::ResembleVoiceSettings::OrHash,
                 Telnyx::InworldVoiceSettings::OrHash,
-                Telnyx::XaiVoiceSettings::OrHash
+                Telnyx::XaiVoiceSettings::OrHash,
+                Telnyx::Calls::SonioxVoiceSettings::OrHash
               )
           ).void
         end
@@ -234,7 +242,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings::OrHash,
                 Telnyx::ResembleVoiceSettings::OrHash,
                 Telnyx::InworldVoiceSettings::OrHash,
-                Telnyx::XaiVoiceSettings::OrHash
+                Telnyx::XaiVoiceSettings::OrHash,
+                Telnyx::Calls::SonioxVoiceSettings::OrHash
               ),
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -287,6 +296,12 @@ module Telnyx
           # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
           #   `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
           #   `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+          # - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+          #   Supported model: `tts-rt-v2`. Browse the catalog via the
+          #   [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+          #   Every voice speaks all supported languages; set `language` to the two-letter
+          #   ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+          #   `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
           # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
           #   `ara`, `rex`, `sal`, `leo`.
           # - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -354,7 +369,8 @@ module Telnyx
                   Telnyx::AzureVoiceSettings,
                   Telnyx::ResembleVoiceSettings,
                   Telnyx::InworldVoiceSettings,
-                  Telnyx::XaiVoiceSettings
+                  Telnyx::XaiVoiceSettings,
+                  Telnyx::Calls::SonioxVoiceSettings
                 ),
               request_options: Telnyx::RequestOptions
             }
@@ -646,7 +662,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings,
                 Telnyx::ResembleVoiceSettings,
                 Telnyx::InworldVoiceSettings,
-                Telnyx::XaiVoiceSettings
+                Telnyx::XaiVoiceSettings,
+                Telnyx::Calls::SonioxVoiceSettings
               )
             end
 

data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi

@@ -18,9 +18,11 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :call_control_id
 
-        # 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 { returns(T.nilable(Telnyx::CallAssistantRequest)) }
         attr_reader :assistant
 
@@ -163,9 +165,11 @@ module Telnyx
         end
         def self.new(
           call_control_id:,
-          # 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.
           assistant: nil,
           # Use this field to add state to every subsequent webhook. It must be a valid
           # Base-64 encoded string.

data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi

@@ -229,12 +229,22 @@ module Telnyx
         # Engine-specific transcription settings for Conversation Relay. This accepts the
         # same provider-specific options used by the Call Transcription Start command,
         # such as `transcription_model`, without requiring the engine discriminator to be
-        # repeated inside this object.
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        # repeated inside this object. With Deepgram Flux (`deepgram/flux`),
+        # `interim_results`, `eot_threshold` and `eager_eot_threshold` control the interim
+        # prompts and the `eagerEndOfTurn` and `turnResumed` frames sent to your WebSocket
+        # server.
+        sig do
+          returns(
+            T.nilable(Telnyx::Calls::ConversationRelayTranscriptionEngineConfig)
+          )
+        end
         attr_reader :transcription_engine_config
 
         sig do
-          params(transcription_engine_config: T::Hash[Symbol, T.anything]).void
+          params(
+            transcription_engine_config:
+              Telnyx::Calls::ConversationRelayTranscriptionEngineConfig::OrHash
+          ).void
         end
         attr_writer :transcription_engine_config
 
@@ -264,10 +274,10 @@ module Telnyx
         #   the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
         #   [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
         #   for compatibility.
-        # - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
-        #   Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
-        #   Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
-        #   [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
+        # - **Azure:** Use `Azure.<VoiceId>` (e.g., `Azure.en-CA-ClaraNeural`,
+        #   `Azure.en-CA-LiamNeural`, `Azure.en-US-BrianMultilingualNeural`,
+        #   `Azure.en-US-Ava:DragonHDLatestNeural`). For a complete list of voices, go to
+        #   [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).
         # - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
         #   `ElevenLabs.BaseModel.John`). The `ModelId` part is optional. To use
         #   ElevenLabs, you must provide your ElevenLabs API key as an integration secret
@@ -282,6 +292,12 @@ module Telnyx
         # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
         #   `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
         #   `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+        # - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+        #   Supported model: `tts-rt-v2`. Browse the catalog via the
+        #   [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+        #   Every voice speaks all supported languages; set `language` to the two-letter
+        #   ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+        #   `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
         # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
         #   `ara`, `rex`, `sal`, `leo`.
         # - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -306,7 +322,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings,
                 Telnyx::ResembleVoiceSettings,
                 Telnyx::InworldVoiceSettings,
-                Telnyx::XaiVoiceSettings
+                Telnyx::XaiVoiceSettings,
+                Telnyx::Calls::SonioxVoiceSettings
               )
             )
           )
@@ -324,7 +341,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings::OrHash,
                 Telnyx::ResembleVoiceSettings::OrHash,
                 Telnyx::InworldVoiceSettings::OrHash,
-                Telnyx::XaiVoiceSettings::OrHash
+                Telnyx::XaiVoiceSettings::OrHash,
+                Telnyx::Calls::SonioxVoiceSettings::OrHash
               )
           ).void
         end
@@ -357,7 +375,8 @@ module Telnyx
             transcription: T::Hash[Symbol, T.anything],
             transcription_engine:
               Telnyx::Calls::ActionStartConversationRelayParams::TranscriptionEngine::OrSymbol,
-            transcription_engine_config: T::Hash[Symbol, T.anything],
+            transcription_engine_config:
+              Telnyx::Calls::ConversationRelayTranscriptionEngineConfig::OrHash,
             tts_provider: String,
             url: String,
             voice: String,
@@ -370,7 +389,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings::OrHash,
                 Telnyx::ResembleVoiceSettings::OrHash,
                 Telnyx::InworldVoiceSettings::OrHash,
-                Telnyx::XaiVoiceSettings::OrHash
+                Telnyx::XaiVoiceSettings::OrHash,
+                Telnyx::Calls::SonioxVoiceSettings::OrHash
               ),
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -436,7 +456,10 @@ module Telnyx
           # Engine-specific transcription settings for Conversation Relay. This accepts the
           # same provider-specific options used by the Call Transcription Start command,
           # such as `transcription_model`, without requiring the engine discriminator to be
-          # repeated inside this object.
+          # repeated inside this object. With Deepgram Flux (`deepgram/flux`),
+          # `interim_results`, `eot_threshold` and `eager_eot_threshold` control the interim
+          # prompts and the `eagerEndOfTurn` and `turnResumed` frames sent to your WebSocket
+          # server.
           transcription_engine_config: nil,
           # Text-to-speech provider. If omitted, Telnyx derives it from `voice` or
           # `provider`.
@@ -454,10 +477,10 @@ module Telnyx
           #   the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
           #   [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
           #   for compatibility.
-          # - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
-          #   Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
-          #   Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
-          #   [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
+          # - **Azure:** Use `Azure.<VoiceId>` (e.g., `Azure.en-CA-ClaraNeural`,
+          #   `Azure.en-CA-LiamNeural`, `Azure.en-US-BrianMultilingualNeural`,
+          #   `Azure.en-US-Ava:DragonHDLatestNeural`). For a complete list of voices, go to
+          #   [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).
           # - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
           #   `ElevenLabs.BaseModel.John`). The `ModelId` part is optional. To use
           #   ElevenLabs, you must provide your ElevenLabs API key as an integration secret
@@ -472,6 +495,12 @@ module Telnyx
           # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
           #   `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
           #   `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+          # - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+          #   Supported model: `tts-rt-v2`. Browse the catalog via the
+          #   [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+          #   Every voice speaks all supported languages; set `language` to the two-letter
+          #   ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+          #   `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
           # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
           #   `ara`, `rex`, `sal`, `leo`.
           # - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -513,7 +542,8 @@ module Telnyx
               transcription: T::Hash[Symbol, T.anything],
               transcription_engine:
                 Telnyx::Calls::ActionStartConversationRelayParams::TranscriptionEngine::OrSymbol,
-              transcription_engine_config: T::Hash[Symbol, T.anything],
+              transcription_engine_config:
+                Telnyx::Calls::ConversationRelayTranscriptionEngineConfig,
               tts_provider: String,
               url: String,
               voice: String,
@@ -526,7 +556,8 @@ module Telnyx
                   Telnyx::AzureVoiceSettings,
                   Telnyx::ResembleVoiceSettings,
                   Telnyx::InworldVoiceSettings,
-                  Telnyx::XaiVoiceSettings
+                  Telnyx::XaiVoiceSettings,
+                  Telnyx::Calls::SonioxVoiceSettings
                 ),
               request_options: Telnyx::RequestOptions
             }
@@ -783,7 +814,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings,
                 Telnyx::ResembleVoiceSettings,
                 Telnyx::InworldVoiceSettings,
-                Telnyx::XaiVoiceSettings
+                Telnyx::XaiVoiceSettings,
+                Telnyx::Calls::SonioxVoiceSettings
               )
             end
 

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

@@ -36,7 +36,16 @@ module Telnyx
         # 'greeting_end' or 'detect_words' is used and a 'machine' is detected, you will
         # receive another 'call.machine.greeting.ended' webhook when the answering machine
         # greeting ends with a beep or silence. If `detect_beep` is used, you will only
-        # receive 'call.machine.greeting.ended' if a beep is detected.
+        # receive 'call.machine.greeting.ended' if a beep is detected. If
+        # `answering_machine_detection` is set to `premium_ios_call_screening_detection`,
+        # Premium AMD runs with iOS Call Screening support: after an initial `machine`
+        # result, Telnyx listens for the iOS call-screening prompt to end or for an Apple
+        # Call Screening tone, sends `call.machine.premium.greeting.ended` with
+        # `result=prompt_ended` or `call.machine.premium.call_screening.detected` with
+        # `result=screening` respectively. When the Apple Call Screening tone is detected,
+        # Premium AMD is restarted on the screened call and a
+        # `call.machine.premium.detection.ended` webhook with the post-screening
+        # classification follows.
         sig do
           returns(
             T.nilable(
@@ -57,7 +66,8 @@ module Telnyx
         # Optional configuration parameters to modify 'answering_machine_detection'
         # performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
         # parameters are applicable when `premium` is selected as
-        # answering_machine_detection.
+        # answering_machine_detection. `prompt_end_timeout_millis` is additionally
+        # applicable when `premium_ios_call_screening_detection` is selected.
         sig do
           returns(
             T.nilable(
@@ -628,12 +638,22 @@ module Telnyx
           # 'greeting_end' or 'detect_words' is used and a 'machine' is detected, you will
           # receive another 'call.machine.greeting.ended' webhook when the answering machine
           # greeting ends with a beep or silence. If `detect_beep` is used, you will only
-          # receive 'call.machine.greeting.ended' if a beep is detected.
+          # receive 'call.machine.greeting.ended' if a beep is detected. If
+          # `answering_machine_detection` is set to `premium_ios_call_screening_detection`,
+          # Premium AMD runs with iOS Call Screening support: after an initial `machine`
+          # result, Telnyx listens for the iOS call-screening prompt to end or for an Apple
+          # Call Screening tone, sends `call.machine.premium.greeting.ended` with
+          # `result=prompt_ended` or `call.machine.premium.call_screening.detected` with
+          # `result=screening` respectively. When the Apple Call Screening tone is detected,
+          # Premium AMD is restarted on the screened call and a
+          # `call.machine.premium.detection.ended` webhook with the post-screening
+          # classification follows.
           answering_machine_detection: nil,
           # Optional configuration parameters to modify 'answering_machine_detection'
           # performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
           # parameters are applicable when `premium` is selected as
-          # answering_machine_detection.
+          # answering_machine_detection. `prompt_end_timeout_millis` is additionally
+          # applicable when `premium_ios_call_screening_detection` is selected.
           answering_machine_detection_config: nil,
           # The URL of a file to be played back when the transfer destination answers before
           # bridging the call. The URL can point to either a WAV or MP3 file. media_name and
@@ -857,7 +877,16 @@ module Telnyx
         # 'greeting_end' or 'detect_words' is used and a 'machine' is detected, you will
         # receive another 'call.machine.greeting.ended' webhook when the answering machine
         # greeting ends with a beep or silence. If `detect_beep` is used, you will only
-        # receive 'call.machine.greeting.ended' if a beep is detected.
+        # receive 'call.machine.greeting.ended' if a beep is detected. If
+        # `answering_machine_detection` is set to `premium_ios_call_screening_detection`,
+        # Premium AMD runs with iOS Call Screening support: after an initial `machine`
+        # result, Telnyx listens for the iOS call-screening prompt to end or for an Apple
+        # Call Screening tone, sends `call.machine.premium.greeting.ended` with
+        # `result=prompt_ended` or `call.machine.premium.call_screening.detected` with
+        # `result=screening` respectively. When the Apple Call Screening tone is detected,
+        # Premium AMD is restarted on the screened call and a
+        # `call.machine.premium.detection.ended` webhook with the post-screening
+        # classification follows.
         module AnsweringMachineDetection
           extend Telnyx::Internal::Type::Enum
 
@@ -875,6 +904,11 @@ module Telnyx
               :premium,
               Telnyx::Calls::ActionTransferParams::AnsweringMachineDetection::TaggedSymbol
             )
+          PREMIUM_IOS_CALL_SCREENING_DETECTION =
+            T.let(
+              :premium_ios_call_screening_detection,
+              Telnyx::Calls::ActionTransferParams::AnsweringMachineDetection::TaggedSymbol
+            )
           DETECT =
             T.let(
               :detect,
@@ -1061,6 +1095,16 @@ module Telnyx
           sig { params(maximum_word_length_millis: Integer).void }
           attr_writer :maximum_word_length_millis
 
+          # Maximum time Telnyx waits, in milliseconds, for the iOS call-screening prompt to
+          # end after Premium AMD initially detects a `machine`. Used when
+          # `answering_machine_detection` is `premium_ios_call_screening_detection`.
+          # Defaults to 5000 milliseconds.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :prompt_end_timeout_millis
+
+          sig { params(prompt_end_timeout_millis: Integer).void }
+          attr_writer :prompt_end_timeout_millis
+
           # Minimum noise threshold for any analysis.
           sig { returns(T.nilable(Integer)) }
           attr_reader :silence_threshold
@@ -1078,7 +1122,8 @@ module Telnyx
           # Optional configuration parameters to modify 'answering_machine_detection'
           # performance. Only `total_analysis_time_millis` and `greeting_duration_millis`
           # parameters are applicable when `premium` is selected as
-          # answering_machine_detection.
+          # answering_machine_detection. `prompt_end_timeout_millis` is additionally
+          # applicable when `premium_ios_call_screening_detection` is selected.
           sig do
             params(
               after_greeting_silence_millis: Integer,
@@ -1098,6 +1143,7 @@ module Telnyx
               initial_silence_millis: Integer,
               maximum_number_of_words: Integer,
               maximum_word_length_millis: Integer,
+              prompt_end_timeout_millis: Integer,
               silence_threshold: Integer,
               total_analysis_time_millis: Integer
             ).returns(T.attached_class)
@@ -1152,6 +1198,11 @@ module Telnyx
             maximum_number_of_words: nil,
             # If a single word lasts longer than this threshold, consider it a machine.
             maximum_word_length_millis: nil,
+            # Maximum time Telnyx waits, in milliseconds, for the iOS call-screening prompt to
+            # end after Premium AMD initially detects a `machine`. Used when
+            # `answering_machine_detection` is `premium_ios_call_screening_detection`.
+            # Defaults to 5000 milliseconds.
+            prompt_end_timeout_millis: nil,
             # Minimum noise threshold for any analysis.
             silence_threshold: nil,
             # Maximum timeout threshold for overall detection.
@@ -1179,6 +1230,7 @@ module Telnyx
                 initial_silence_millis: Integer,
                 maximum_number_of_words: Integer,
                 maximum_word_length_millis: Integer,
+                prompt_end_timeout_millis: Integer,
                 silence_threshold: Integer,
                 total_analysis_time_millis: Integer
               }

data/rbi/telnyx/models/calls/conversation_relay_transcription_engine_config.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Calls
+      class ConversationRelayTranscriptionEngineConfig < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Calls::ConversationRelayTranscriptionEngineConfig,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Deepgram Flux: confidence at which an `eagerEndOfTurn` frame is sent before the
+        # final prompt, followed by `turnResumed` if the caller keeps talking. When
+        # omitted, these frames are not sent.
+        sig { returns(T.nilable(Float)) }
+        attr_reader :eager_eot_threshold
+
+        sig { params(eager_eot_threshold: Float).void }
+        attr_writer :eager_eot_threshold
+
+        # Deepgram Flux: confidence required to end the caller's turn.
+        sig { returns(T.nilable(Float)) }
+        attr_reader :eot_threshold
+
+        sig { params(eot_threshold: Float).void }
+        attr_writer :eot_threshold
+
+        # Deepgram Flux: send interim transcripts as `prompt` frames with `last: false`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :interim_results
+
+        sig { params(interim_results: T::Boolean).void }
+        attr_writer :interim_results
+
+        # Engine-specific transcription settings for Conversation Relay. This accepts the
+        # same provider-specific options used by the Call Transcription Start command,
+        # such as `transcription_model`, without requiring the engine discriminator to be
+        # repeated inside this object. With Deepgram Flux (`deepgram/flux`),
+        # `interim_results`, `eot_threshold` and `eager_eot_threshold` control the interim
+        # prompts and the `eagerEndOfTurn` and `turnResumed` frames sent to your WebSocket
+        # server.
+        sig do
+          params(
+            eager_eot_threshold: Float,
+            eot_threshold: Float,
+            interim_results: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Deepgram Flux: confidence at which an `eagerEndOfTurn` frame is sent before the
+          # final prompt, followed by `turnResumed` if the caller keeps talking. When
+          # omitted, these frames are not sent.
+          eager_eot_threshold: nil,
+          # Deepgram Flux: confidence required to end the caller's turn.
+          eot_threshold: nil,
+          # Deepgram Flux: send interim transcripts as `prompt` frames with `last: false`.
+          interim_results: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              eager_eot_threshold: Float,
+              eot_threshold: Float,
+              interim_results: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end