telnyx 5.174.0 → 5.175.0

data/rbi/telnyx/models/ai/privacy_settings.rbi

@@ -21,18 +21,32 @@ module Telnyx
         sig { params(data_retention: T::Boolean).void }
         attr_writer :data_retention
 
-        # Requires every model call made for a web chat turn to be received and served
-        # inside your organization's data-locality region, rather than only stored there.
-        # Applies to web chat only — voice and messaging assistants are unaffected.
-        # Enabling it requires a data-locality region with in-region inference (USA, EU,
-        # AUS, UAE; see
-        # [Inference regions](https://developers.telnyx.com/docs/inference/models/regions))
-        # and Telnyx-hosted models for the assistant, its fallback, and any
-        # conversation-flow node that overrides the model; the request is rejected
-        # otherwise. Once enabled, send chat requests to your region's API hostname: a
-        # request entering the platform in another region is rejected rather than
+        # Requires this assistant's conversations to be processed inside your
+        # organization's data-locality region, rather than only stored there, on every
+        # channel: for web chat, every model call of a turn; for voice, the call's model
+        # calls and the Telnyx-hosted speech services it uses; for SMS and WhatsApp, the
+        # model calls of each turn (how messages travel through carriers is not covered).
+        # Covered processing that cannot be handled in region fails rather than being
+        # served elsewhere. Enabling it requires a data-locality region with in-region
+        # inference (USA, EU, AUS, UAE; see
+        # [Inference regions](https://developers.telnyx.com/docs/inference/models/regions)),
+        # models for the assistant, its fallback, and any conversation-flow node that
+        # overrides the model that are either Telnyx-hosted or a customer-provided
+        # `external_llm` endpoint (third-party model providers are refused), and, when
+        # `insight_settings.model` is set, an insight model available in that region; the
+        # request is rejected otherwise. A voice call fails when it starts if its STT
+        # model or TTS voice is not self-hosted by Telnyx, if the assistant uses a
+        # speech-to-speech model, or if the call's media is anchored outside the region.
+        # URLs Telnyx is configured to call — an `external_llm` endpoint, webhook tools,
+        # Voice API callbacks, or a recording storage destination — are followed as-is:
+        # Telnyx cannot verify where a customer-supplied URL processes requests, and
+        # keeping those steps in your region is your responsibility. Once enabled, send
+        # web chat requests and WebSocket or WebRTC conversations to your region's API
+        # hostname: one entering the platform in another region is refused rather than
         # forwarded, because forwarding it would already have moved the content across the
-        # border. Defaults to false.
+        # border. See
+        # [Data residency](https://developers.telnyx.com/docs/inference/data-residency#in-region-processing-for-ai-assistants).
+        # Defaults to false.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :in_transit_data_locality
 
@@ -92,18 +106,32 @@ module Telnyx
           # account, number, or application level. All such external settings remain in
           # force regardless of your selection here.
           data_retention: nil,
-          # Requires every model call made for a web chat turn to be received and served
-          # inside your organization's data-locality region, rather than only stored there.
-          # Applies to web chat only — voice and messaging assistants are unaffected.
-          # Enabling it requires a data-locality region with in-region inference (USA, EU,
-          # AUS, UAE; see
-          # [Inference regions](https://developers.telnyx.com/docs/inference/models/regions))
-          # and Telnyx-hosted models for the assistant, its fallback, and any
-          # conversation-flow node that overrides the model; the request is rejected
-          # otherwise. Once enabled, send chat requests to your region's API hostname: a
-          # request entering the platform in another region is rejected rather than
+          # Requires this assistant's conversations to be processed inside your
+          # organization's data-locality region, rather than only stored there, on every
+          # channel: for web chat, every model call of a turn; for voice, the call's model
+          # calls and the Telnyx-hosted speech services it uses; for SMS and WhatsApp, the
+          # model calls of each turn (how messages travel through carriers is not covered).
+          # Covered processing that cannot be handled in region fails rather than being
+          # served elsewhere. Enabling it requires a data-locality region with in-region
+          # inference (USA, EU, AUS, UAE; see
+          # [Inference regions](https://developers.telnyx.com/docs/inference/models/regions)),
+          # models for the assistant, its fallback, and any conversation-flow node that
+          # overrides the model that are either Telnyx-hosted or a customer-provided
+          # `external_llm` endpoint (third-party model providers are refused), and, when
+          # `insight_settings.model` is set, an insight model available in that region; the
+          # request is rejected otherwise. A voice call fails when it starts if its STT
+          # model or TTS voice is not self-hosted by Telnyx, if the assistant uses a
+          # speech-to-speech model, or if the call's media is anchored outside the region.
+          # URLs Telnyx is configured to call — an `external_llm` endpoint, webhook tools,
+          # Voice API callbacks, or a recording storage destination — are followed as-is:
+          # Telnyx cannot verify where a customer-supplied URL processes requests, and
+          # keeping those steps in your region is your responsibility. Once enabled, send
+          # web chat requests and WebSocket or WebRTC conversations to your region's API
+          # hostname: one entering the platform in another region is refused rather than
           # forwarded, because forwarding it would already have moved the content across the
-          # border. Defaults to false.
+          # border. See
+          # [Data residency](https://developers.telnyx.com/docs/inference/data-residency#in-region-processing-for-ai-assistants).
+          # Defaults to false.
           in_transit_data_locality: nil,
           # Controls redaction of personally identifiable information (PII) from the
           # conversation history that is stored for this assistant. `disabled` (default)

data/rbi/telnyx/models/ai/start_speaking_plan.rbi

@@ -12,19 +12,26 @@ module Telnyx
         # Endpointing thresholds used to decide when the user has finished speaking.
         # Applies to non turn-taking transcription models. For `deepgram/flux`, use
         # `transcription.settings.eot_threshold` / `eot_timeout_ms` /
-        # `eager_eot_threshold`.
+        # `eager_eot_threshold`. Evaluated per turn, on each caller transcript, only while
+        # `start_speaking_plan` is present: the tier whose suffix matches the transcript
+        # tail is applied (a transcript with no terminal punctuation or number falls
+        # through to `on_no_punctuation_seconds`); with no tiers configured (or a null
+        # nested plan), the per-turn wait stays on `start_speaking_plan.wait_seconds`.
         sig { returns(T.nilable(Telnyx::AI::TranscriptionEndpointingPlan)) }
         attr_reader :transcription_endpointing_plan
 
         sig do
           params(
             transcription_endpointing_plan:
-              Telnyx::AI::TranscriptionEndpointingPlan::OrHash
+              T.nilable(Telnyx::AI::TranscriptionEndpointingPlan::OrHash)
           ).void
         end
         attr_writer :transcription_endpointing_plan
 
-        # Minimum seconds to wait before the assistant starts speaking.
+        # Wait used when per-turn endpointing does not select a tier. While the plan is
+        # present this applies on every turn without a matching tier (including when
+        # `transcription_endpointing_plan` is unset); a matching tier replaces it for that
+        # turn, and a tier may be shorter or longer than this value.
         sig { returns(T.nilable(Float)) }
         attr_reader :wait_seconds
 
@@ -35,10 +42,22 @@ module Telnyx
         # thresholds primarily apply to non turn-taking transcription models. For
         # turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
         # transcription end-of-turn settings under `transcription.settings` instead.
+        #
+        # Sending any `start_speaking_plan` object — an empty `{}` included (the stored
+        # config fills in field defaults) — engages per-turn transcript matching: on each
+        # turn the transcript tail is evaluated against the configured
+        # `transcription_endpointing_plan` tiers, and the wait is set to the matching
+        # tier's seconds. When the transcript ends without terminal punctuation or a
+        # number and `transcription_endpointing_plan` is set, its
+        # `on_no_punctuation_seconds` tier applies. Only when no tier matches
+        # (`transcription_endpointing_plan` unset or null) does the wait stay on
+        # `wait_seconds`. Setting `start_speaking_plan` to `null` (or omitting it) turns
+        # per-turn matching off entirely, and the assistant starts speaking as soon as
+        # silence is detected.
         sig do
           params(
             transcription_endpointing_plan:
-              Telnyx::AI::TranscriptionEndpointingPlan::OrHash,
+              T.nilable(Telnyx::AI::TranscriptionEndpointingPlan::OrHash),
             wait_seconds: Float
           ).returns(T.attached_class)
         end
@@ -46,9 +65,16 @@ module Telnyx
           # Endpointing thresholds used to decide when the user has finished speaking.
           # Applies to non turn-taking transcription models. For `deepgram/flux`, use
           # `transcription.settings.eot_threshold` / `eot_timeout_ms` /
-          # `eager_eot_threshold`.
+          # `eager_eot_threshold`. Evaluated per turn, on each caller transcript, only while
+          # `start_speaking_plan` is present: the tier whose suffix matches the transcript
+          # tail is applied (a transcript with no terminal punctuation or number falls
+          # through to `on_no_punctuation_seconds`); with no tiers configured (or a null
+          # nested plan), the per-turn wait stays on `start_speaking_plan.wait_seconds`.
           transcription_endpointing_plan: nil,
-          # Minimum seconds to wait before the assistant starts speaking.
+          # Wait used when per-turn endpointing does not select a tier. While the plan is
+          # present this applies on every turn without a matching tier (including when
+          # `transcription_endpointing_plan` is unset); a matching tier replaces it for that
+          # turn, and a tier may be shorter or longer than this value.
           wait_seconds: nil
         )
         end
@@ -57,7 +83,7 @@ module Telnyx
           override.returns(
             {
               transcription_endpointing_plan:
-                Telnyx::AI::TranscriptionEndpointingPlan,
+                T.nilable(Telnyx::AI::TranscriptionEndpointingPlan),
               wait_seconds: Float
             }
           )

data/rbi/telnyx/models/ai/telephony_settings.rbi

@@ -51,6 +51,14 @@ module Telnyx
         sig { params(fallback_destination: String).void }
         attr_writer :fallback_destination
 
+        # Milliseconds to wait after an inbound call is answered before the assistant
+        # starts and speaks its greeting. Increase it if the beginning of the greeting is
+        # cut off on some connections (for example, WebRTC calls). When unset (`null`),
+        # the platform default of 250 ms is used. Set to `0` to start without a delay.
+        # Maximum 2000.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :greeting_delay_ms
+
         # The noise suppression engine to use. 'aicoustics' is STT-optimized and
         # recommended for AI assistants (configure through noise_suppression_config). Use
         # 'disabled' to turn off noise suppression.
@@ -193,6 +201,7 @@ module Telnyx
             default_texml_app_id: String,
             disable_dtmf: T::Boolean,
             fallback_destination: String,
+            greeting_delay_ms: T.nilable(Integer),
             noise_suppression:
               Telnyx::AI::TelephonySettings::NoiseSuppression::OrSymbol,
             noise_suppression_config:
@@ -231,6 +240,12 @@ module Telnyx
           # detected), and it does not fire when the assistant already transferred or
           # bridged the call.
           fallback_destination: nil,
+          # Milliseconds to wait after an inbound call is answered before the assistant
+          # starts and speaks its greeting. Increase it if the beginning of the greeting is
+          # cut off on some connections (for example, WebRTC calls). When unset (`null`),
+          # the platform default of 250 ms is used. Set to `0` to start without a delay.
+          # Maximum 2000.
+          greeting_delay_ms: nil,
           # The noise suppression engine to use. 'aicoustics' is STT-optimized and
           # recommended for AI assistants (configure through noise_suppression_config). Use
           # 'disabled' to turn off noise suppression.
@@ -300,6 +315,7 @@ module Telnyx
               default_texml_app_id: String,
               disable_dtmf: T::Boolean,
               fallback_destination: String,
+              greeting_delay_ms: T.nilable(Integer),
               noise_suppression:
                 Telnyx::AI::TelephonySettings::NoiseSuppression::OrSymbol,
               noise_suppression_config:

data/rbi/telnyx/models/ai/tests/test_framework/v1_retrieve_personalities_response.rbi

@@ -51,7 +51,7 @@ module Telnyx
             sig { returns(T.nilable(Integer)) }
             attr_accessor :forked_from
 
-            sig { returns(T.nilable(T.anything)) }
+            sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
             attr_accessor :generation_config
 
             # How aggressively the personality interrupts the assistant.
@@ -59,10 +59,10 @@ module Telnyx
             attr_accessor :interruption_level
 
             # Idle-timeout plan for messages during a call.
-            sig { returns(T.nilable(T.anything)) }
+            sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
             attr_accessor :message_plan
 
-            sig { returns(T.nilable(T.anything)) }
+            sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
             attr_accessor :network_simulation
 
             sig { returns(T.nilable(Integer)) }
@@ -89,7 +89,7 @@ module Telnyx
             end
             attr_accessor :start_speaking_plan
 
-            sig { returns(T.nilable(T.anything)) }
+            sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
             attr_accessor :stop_speaking_plan
 
             sig { returns(T.nilable(Float)) }
@@ -107,10 +107,10 @@ module Telnyx
                 background_sound_volume: T.nilable(Float),
                 effective_voice_volume: T.nilable(Float),
                 forked_from: T.nilable(Integer),
-                generation_config: T.nilable(T.anything),
+                generation_config: T.nilable(T::Hash[Symbol, T.anything]),
                 interruption_level: T.nilable(String),
-                message_plan: T.nilable(T.anything),
-                network_simulation: T.nilable(T.anything),
+                message_plan: T.nilable(T::Hash[Symbol, T.anything]),
+                network_simulation: T.nilable(T::Hash[Symbol, T.anything]),
                 organization: T.nilable(Integer),
                 project: T.nilable(Integer),
                 speed:
@@ -121,7 +121,7 @@ module Telnyx
                   T.nilable(
                     Telnyx::Models::AI::Tests::TestFramework::V1RetrievePersonalitiesResponseItem::StartSpeakingPlan::Variants
                   ),
-                stop_speaking_plan: T.nilable(T.anything),
+                stop_speaking_plan: T.nilable(T::Hash[Symbol, T.anything]),
                 voice_volume: T.nilable(Float)
               ).returns(T.attached_class)
             end
@@ -168,10 +168,10 @@ module Telnyx
                   background_sound_volume: T.nilable(Float),
                   effective_voice_volume: T.nilable(Float),
                   forked_from: T.nilable(Integer),
-                  generation_config: T.nilable(T.anything),
+                  generation_config: T.nilable(T::Hash[Symbol, T.anything]),
                   interruption_level: T.nilable(String),
-                  message_plan: T.nilable(T.anything),
-                  network_simulation: T.nilable(T.anything),
+                  message_plan: T.nilable(T::Hash[Symbol, T.anything]),
+                  network_simulation: T.nilable(T::Hash[Symbol, T.anything]),
                   organization: T.nilable(Integer),
                   project: T.nilable(Integer),
                   speed:
@@ -182,7 +182,7 @@ module Telnyx
                     T.nilable(
                       Telnyx::Models::AI::Tests::TestFramework::V1RetrievePersonalitiesResponseItem::StartSpeakingPlan::Variants
                     ),
-                  stop_speaking_plan: T.nilable(T.anything),
+                  stop_speaking_plan: T.nilable(T::Hash[Symbol, T.anything]),
                   voice_volume: T.nilable(Float)
                 }
               )
@@ -209,7 +209,8 @@ module Telnyx
             module StartSpeakingPlan
               extend Telnyx::Internal::Type::Union
 
-              Variants = T.type_alias { T.any(Float, T.anything) }
+              Variants =
+                T.type_alias { T.any(Float, T::Hash[Symbol, T.anything]) }
 
               sig do
                 override.returns(
@@ -220,6 +221,14 @@ module Telnyx
               end
               def self.variants
               end
+
+              StartSpeakingPlanObjectMap =
+                T.let(
+                  Telnyx::Internal::Type::HashOf[
+                    Telnyx::Internal::Type::Unknown
+                  ],
+                  Telnyx::Internal::Type::Converter
+                )
             end
           end
 

data/rbi/telnyx/models/ai/transcription_endpointing_plan.rbi

@@ -36,7 +36,11 @@ module Telnyx
         # Endpointing thresholds used to decide when the user has finished speaking.
         # Applies to non turn-taking transcription models. For `deepgram/flux`, use
         # `transcription.settings.eot_threshold` / `eot_timeout_ms` /
-        # `eager_eot_threshold`.
+        # `eager_eot_threshold`. Evaluated per turn, on each caller transcript, only while
+        # `start_speaking_plan` is present: the tier whose suffix matches the transcript
+        # tail is applied (a transcript with no terminal punctuation or number falls
+        # through to `on_no_punctuation_seconds`); with no tiers configured (or a null
+        # nested plan), the per-turn wait stays on `start_speaking_plan.wait_seconds`.
         sig do
           params(
             on_no_punctuation_seconds: Float,

data/rbi/telnyx/models/browser_session_create_params.rbi

@@ -37,10 +37,10 @@ module Telnyx
       attr_writer :limits
 
       # Arbitrary key-value metadata.
-      sig { returns(T.nilable(T.anything)) }
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_reader :metadata
 
-      sig { params(metadata: T.anything).void }
+      sig { params(metadata: T::Hash[Symbol, T.anything]).void }
       attr_writer :metadata
 
       sig do
@@ -48,7 +48,7 @@ module Telnyx
           policy: Telnyx::BrowserSessionCreateParams::Policy::OrHash,
           idempotency_key: String,
           limits: Telnyx::BrowserSessionCreateParams::Limits::OrHash,
-          metadata: T.anything,
+          metadata: T::Hash[Symbol, T.anything],
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -71,7 +71,7 @@ module Telnyx
             policy: Telnyx::BrowserSessionCreateParams::Policy,
             idempotency_key: String,
             limits: Telnyx::BrowserSessionCreateParams::Limits,
-            metadata: T.anything,
+            metadata: T::Hash[Symbol, T.anything],
             request_options: Telnyx::RequestOptions
           }
         )

data/rbi/telnyx/models/browser_sessions/action_response.rbi

@@ -43,7 +43,7 @@ module Telnyx
 
         # Normalized request metadata; defaults may be materialized and fill values are
         # redacted as {redacted: true, length: number}, including inside batch actions.
-        sig { returns(T.anything) }
+        sig { returns(T::Hash[Symbol, T.anything]) }
         attr_accessor :request
 
         sig do
@@ -87,7 +87,7 @@ module Telnyx
             created_at: Time,
             error:
               T.nilable(Telnyx::BrowserSessions::ActionResponse::Error::OrHash),
-            request: T.anything,
+            request: T::Hash[Symbol, T.anything],
             result:
               T.nilable(
                 Telnyx::BrowserSessions::ActionResponse::Result::OrHash
@@ -134,7 +134,7 @@ module Telnyx
               completed_at: T.nilable(Time),
               created_at: Time,
               error: T.nilable(Telnyx::BrowserSessions::ActionResponse::Error),
-              request: T.anything,
+              request: T::Hash[Symbol, T.anything],
               result:
                 T.nilable(Telnyx::BrowserSessions::ActionResponse::Result),
               seq: Integer,
@@ -232,10 +232,10 @@ module Telnyx
           attr_writer :observation
 
           # Present only for batch actions.
-          sig { returns(T.nilable(T::Array[T.anything])) }
+          sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) }
           attr_reader :results
 
-          sig { params(results: T::Array[T.anything]).void }
+          sig { params(results: T::Array[T::Hash[Symbol, T.anything]]).void }
           attr_writer :results
 
           sig { returns(T.nilable(String)) }
@@ -256,7 +256,7 @@ module Telnyx
                 Telnyx::BrowserSessions::ActionResponse::Result::Artifact::OrHash,
               observation:
                 Telnyx::BrowserSessions::ActionResponse::Result::Observation::OrHash,
-              results: T::Array[T.anything],
+              results: T::Array[T::Hash[Symbol, T.anything]],
               title: String,
               url: String
             ).returns(T.attached_class)
@@ -282,7 +282,7 @@ module Telnyx
                   Telnyx::BrowserSessions::ActionResponse::Result::Artifact,
                 observation:
                   Telnyx::BrowserSessions::ActionResponse::Result::Observation,
-                results: T::Array[T.anything],
+                results: T::Array[T::Hash[Symbol, T.anything]],
                 title: String,
                 url: String
               }
@@ -364,10 +364,10 @@ module Telnyx
             sig { params(ref_count: Integer).void }
             attr_writer :ref_count
 
-            sig { returns(T.nilable(T.anything)) }
+            sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
             attr_reader :refs
 
-            sig { params(refs: T.anything).void }
+            sig { params(refs: T::Hash[Symbol, T.anything]).void }
             attr_writer :refs
 
             sig { returns(T.nilable(String)) }
@@ -402,7 +402,7 @@ module Telnyx
               params(
                 observation_id: String,
                 ref_count: Integer,
-                refs: T.anything,
+                refs: T::Hash[Symbol, T.anything],
                 title: String,
                 tree: String,
                 truncated: T::Boolean,
@@ -427,7 +427,7 @@ module Telnyx
                 {
                   observation_id: String,
                   ref_count: Integer,
-                  refs: T.anything,
+                  refs: T::Hash[Symbol, T.anything],
                   title: String,
                   tree: String,
                   truncated: T::Boolean,

data/rbi/telnyx/models/browser_sessions/wait_for_action.rbi

@@ -18,7 +18,7 @@ module Telnyx
               Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember0,
               Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember1,
               Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember2,
-              Telnyx::BrowserSessions::WaitForAction::Condition::Kind
+              Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember3
             )
           )
         end
@@ -53,7 +53,7 @@ module Telnyx
                 Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember0::OrHash,
                 Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember1::OrHash,
                 Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember2::OrHash,
-                Telnyx::BrowserSessions::WaitForAction::Condition::Kind::OrHash
+                Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember3::OrHash
               ),
             idempotency_key: String,
             include_observation: T::Boolean,
@@ -78,7 +78,7 @@ module Telnyx
                   Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember0,
                   Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember1,
                   Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember2,
-                  Telnyx::BrowserSessions::WaitForAction::Condition::Kind
+                  Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember3
                 ),
               type: Symbol,
               idempotency_key: String,
@@ -99,7 +99,7 @@ module Telnyx
                 Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember0,
                 Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember1,
                 Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember2,
-                Telnyx::BrowserSessions::WaitForAction::Condition::Kind
+                Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember3
               )
             end
 
@@ -188,11 +188,11 @@ module Telnyx
             end
           end
 
-          class Kind < Telnyx::Internal::Type::BaseModel
+          class UnionMember3 < Telnyx::Internal::Type::BaseModel
             OrHash =
               T.type_alias do
                 T.any(
-                  Telnyx::BrowserSessions::WaitForAction::Condition::Kind,
+                  Telnyx::BrowserSessions::WaitForAction::Condition::UnionMember3,
                   Telnyx::Internal::AnyHash
                 )
               end