telnyx 5.168.0 → 5.170.0

data/rbi/telnyx/models/ai/memory/namespaces/setting_list_params.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class SettingListParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Memory::Namespaces::SettingListParams,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # The namespace. `default` exists for every organization.
+            sig { returns(String) }
+            attr_accessor :namespace
+
+            sig do
+              params(
+                namespace: String,
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The namespace. `default` exists for every organization.
+              namespace:,
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                { namespace: String, request_options: Telnyx::RequestOptions }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class SettingPatchAllParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Memory::Namespaces::SettingPatchAllParams,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # The namespace. `default` exists for every organization.
+            sig { returns(String) }
+            attr_accessor :namespace
+
+            # A partial update to a namespace's summary settings.
+            #
+            # Only the fields present in the request are changed; the rest are left as they
+            # are. Sending `instructions: null` (or empty) clears the instructions.
+            sig do
+              returns(
+                T.nilable(
+                  Telnyx::AI::Memory::Namespaces::SettingPatchAllParams::Summary
+                )
+              )
+            end
+            attr_reader :summary
+
+            sig do
+              params(
+                summary:
+                  T.nilable(
+                    Telnyx::AI::Memory::Namespaces::SettingPatchAllParams::Summary::OrHash
+                  )
+              ).void
+            end
+            attr_writer :summary
+
+            sig do
+              params(
+                namespace: String,
+                summary:
+                  T.nilable(
+                    Telnyx::AI::Memory::Namespaces::SettingPatchAllParams::Summary::OrHash
+                  ),
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The namespace. `default` exists for every organization.
+              namespace:,
+              # A partial update to a namespace's summary settings.
+              #
+              # Only the fields present in the request are changed; the rest are left as they
+              # are. Sending `instructions: null` (or empty) clears the instructions.
+              summary: nil,
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  namespace: String,
+                  summary:
+                    T.nilable(
+                      Telnyx::AI::Memory::Namespaces::SettingPatchAllParams::Summary
+                    ),
+                  request_options: Telnyx::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Summary < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Memory::Namespaces::SettingPatchAllParams::Summary,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Replace the namespace's summary instructions. Null or empty clears them and
+              # returns to the neutral default. Omit the field to leave the current instructions
+              # unchanged.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :instructions
+
+              # A partial update to a namespace's summary settings.
+              #
+              # Only the fields present in the request are changed; the rest are left as they
+              # are. Sending `instructions: null` (or empty) clears the instructions.
+              sig do
+                params(instructions: T.nilable(String)).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # Replace the namespace's summary instructions. Null or empty clears them and
+                # returns to the neutral default. Omit the field to leave the current instructions
+                # unchanged.
+                instructions: nil
+              )
+              end
+
+              sig { override.returns({ instructions: T.nilable(String) }) }
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/openai/function_definition.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module OpenAI
+        class FunctionDefinition < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::OpenAI::FunctionDefinition,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :name
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :description
+
+          sig { params(description: String).void }
+          attr_writer :description
+
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_reader :parameters
+
+          sig { params(parameters: T::Hash[Symbol, T.anything]).void }
+          attr_writer :parameters
+
+          sig do
+            params(
+              name: String,
+              description: String,
+              parameters: T::Hash[Symbol, T.anything]
+            ).returns(T.attached_class)
+          end
+          def self.new(name:, description: nil, parameters: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                name: String,
+                description: String,
+                parameters: T::Hash[Symbol, T.anything]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/post_conversation_settings.rbi

@@ -23,10 +23,10 @@ module Telnyx
 
         # Configuration for post-conversation processing. When enabled, the assistant
         # receives one additional LLM turn after the conversation ends, allowing it to
-        # execute tool calls such as logging to a CRM or sending a summary. The assistant
-        # can execute multiple parallel or sequential tools during this phase.
-        # Telephony-control tools (e.g. hangup, transfer) are unavailable
-        # post-conversation. Beta feature.
+        # execute final tool calls such as sending a summary or updating a record via
+        # webhook or function tools. Integration and MCP server tools are not available
+        # post-conversation; call-control tools (e.g. hangup, transfer) are also
+        # unavailable. Beta feature.
         sig { params(enabled: T::Boolean).returns(T.attached_class) }
         def self.new(
           # Whether post-conversation processing is enabled. When true, the assistant will

data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi

@@ -23,10 +23,10 @@ module Telnyx
 
         # Configuration for post-conversation processing. When enabled, the assistant
         # receives one additional LLM turn after the conversation ends, allowing it to
-        # execute tool calls such as logging to a CRM or sending a summary. The assistant
-        # can execute multiple parallel or sequential tools during this phase.
-        # Telephony-control tools (e.g. hangup, transfer) are unavailable
-        # post-conversation. Beta feature.
+        # execute final tool calls such as sending a summary or updating a record via
+        # webhook or function tools. Integration and MCP server tools are not available
+        # post-conversation; call-control tools (e.g. hangup, transfer) are also
+        # unavailable. Beta feature.
         sig { params(enabled: T::Boolean).returns(T.attached_class) }
         def self.new(
           # Whether post-conversation processing is enabled. When true, the assistant will

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

@@ -21,7 +21,30 @@ module Telnyx
         sig { params(data_retention: T::Boolean).void }
         attr_writer :data_retention
 
-        sig { params(data_retention: T::Boolean).returns(T.attached_class) }
+        # 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
+        # forwarded, because forwarding it would already have moved the content across the
+        # border. Defaults to false.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :in_transit_data_locality
+
+        sig { params(in_transit_data_locality: T::Boolean).void }
+        attr_writer :in_transit_data_locality
+
+        sig do
+          params(
+            data_retention: T::Boolean,
+            in_transit_data_locality: T::Boolean
+          ).returns(T.attached_class)
+        end
         def self.new(
           # If true, conversation history and insights will be stored. If false, they will
           # not be stored. This in‑tool toggle governs solely the retention of conversation
@@ -29,11 +52,28 @@ module Telnyx
           # recording, transcription, or storage configuration that you have set at the
           # account, number, or application level. All such external settings remain in
           # force regardless of your selection here.
-          data_retention: nil
+          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
+          # forwarded, because forwarding it would already have moved the content across the
+          # border. Defaults to false.
+          in_transit_data_locality: nil
         )
         end
 
-        sig { override.returns({ data_retention: T::Boolean }) }
+        sig do
+          override.returns(
+            { data_retention: T::Boolean, in_transit_data_locality: T::Boolean }
+          )
+        end
         def to_hash
         end
       end

data/rbi/telnyx/models/ai/retrieval_tool.rbi

@@ -18,20 +18,46 @@ module Telnyx
         sig { returns(Telnyx::AI::RetrievalTool::Type::OrSymbol) }
         attr_accessor :type
 
+        # Whether this tool comes from the shared Tools Library. Responses merge shared
+        # tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+        # Read-only: set by the server, not accepted in requests. When updating an
+        # assistant, omit `shared: true` tools from the request `tools` array and manage
+        # them through `tool_ids` instead — re-sending their definitions creates an inline
+        # duplicate (rejected with error code 10015 when the type allows only one instance
+        # per assistant).
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :shared
+
+        sig { params(shared: T::Boolean).void }
+        attr_writer :shared
+
         sig do
           params(
             retrieval: Telnyx::AI::BucketIDs::OrHash,
-            type: Telnyx::AI::RetrievalTool::Type::OrSymbol
+            type: Telnyx::AI::RetrievalTool::Type::OrSymbol,
+            shared: T::Boolean
           ).returns(T.attached_class)
         end
-        def self.new(retrieval:, type:)
+        def self.new(
+          retrieval:,
+          type:,
+          # Whether this tool comes from the shared Tools Library. Responses merge shared
+          # tools into `tools` with `shared: true`; inline tools carry `shared: false`.
+          # Read-only: set by the server, not accepted in requests. When updating an
+          # assistant, omit `shared: true` tools from the request `tools` array and manage
+          # them through `tool_ids` instead — re-sending their definitions creates an inline
+          # duplicate (rejected with error code 10015 when the type allows only one instance
+          # per assistant).
+          shared: nil
+        )
         end
 
         sig do
           override.returns(
             {
               retrieval: Telnyx::AI::BucketIDs,
-              type: Telnyx::AI::RetrievalTool::Type::OrSymbol
+              type: Telnyx::AI::RetrievalTool::Type::OrSymbol,
+              shared: T::Boolean
             }
           )
         end

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

@@ -39,8 +39,9 @@ module Telnyx
         sig { params(fallback_destination: String).void }
         attr_writer :fallback_destination
 
-        # The noise suppression engine to use. Use 'disabled' to turn off noise
-        # suppression.
+        # 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.
         sig do
           returns(
             T.nilable(Telnyx::AI::TelephonySettings::NoiseSuppression::OrSymbol)
@@ -56,8 +57,10 @@ module Telnyx
         end
         attr_writer :noise_suppression
 
-        # Configuration for noise suppression. Only applicable when noise_suppression is
-        # 'deepfilternet'.
+        # Configuration for noise suppression. Applicable fields depend on the engine:
+        # 'attenuation_limit' and 'mode' only when noise_suppression is 'deepfilternet';
+        # 'family', 'size' and 'enhancement_level' only when noise_suppression is
+        # 'aicoustics'.
         sig do
           returns(
             T.nilable(Telnyx::AI::TelephonySettings::NoiseSuppressionConfig)
@@ -194,11 +197,14 @@ module Telnyx
           # detected), and it does not fire when the assistant already transferred or
           # bridged the call.
           fallback_destination: nil,
-          # The noise suppression engine to use. Use 'disabled' to turn off noise
-          # suppression.
+          # 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.
           noise_suppression: nil,
-          # Configuration for noise suppression. Only applicable when noise_suppression is
-          # 'deepfilternet'.
+          # Configuration for noise suppression. Applicable fields depend on the engine:
+          # 'attenuation_limit' and 'mode' only when noise_suppression is 'deepfilternet';
+          # 'family', 'size' and 'enhancement_level' only when noise_suppression is
+          # 'aicoustics'.
           noise_suppression_config: nil,
           # Configuration for call recording format and channel settings.
           recording_settings: nil,
@@ -264,8 +270,9 @@ module Telnyx
         def to_hash
         end
 
-        # The noise suppression engine to use. Use 'disabled' to turn off noise
-        # suppression.
+        # 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.
         module NoiseSuppression
           extend Telnyx::Internal::Type::Enum
 
@@ -275,6 +282,11 @@ module Telnyx
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+          AICOUSTICS =
+            T.let(
+              :aicoustics,
+              Telnyx::AI::TelephonySettings::NoiseSuppression::TaggedSymbol
+            )
           KRISP =
             T.let(
               :krisp,
@@ -311,14 +323,43 @@ module Telnyx
               )
             end
 
-          # Attenuation limit for noise suppression. Range: 0-100.
+          # Attenuation limit for noise suppression. Range: 0-100. Only applicable when
+          # noise_suppression is 'deepfilternet'.
           sig { returns(T.nilable(Integer)) }
           attr_reader :attenuation_limit
 
           sig { params(attenuation_limit: Integer).void }
           attr_writer :attenuation_limit
 
-          # Mode for noise suppression configuration.
+          # AiCoustics enhancement intensity. Range: 0-1. Only applicable when
+          # noise_suppression is 'aicoustics'.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :enhancement_level
+
+          sig { params(enhancement_level: Float).void }
+          attr_writer :enhancement_level
+
+          # AiCoustics model family optimized for Voice AI and STT. Only applicable when
+          # noise_suppression is 'aicoustics'.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Family::OrSymbol
+              )
+            )
+          end
+          attr_reader :family
+
+          sig do
+            params(
+              family:
+                Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Family::OrSymbol
+            ).void
+          end
+          attr_writer :family
+
+          # Mode for noise suppression configuration. Only applicable when noise_suppression
+          # is 'deepfilternet'.
           sig do
             returns(
               T.nilable(
@@ -336,20 +377,59 @@ module Telnyx
           end
           attr_writer :mode
 
-          # Configuration for noise suppression. Only applicable when noise_suppression is
-          # 'deepfilternet'.
+          # AiCoustics model size. 'vf' tracks the latest model release; 'vf_2_0_l' is
+          # pinned to version 2.0 for consistent, predictable behavior. Only applicable when
+          # noise_suppression is 'aicoustics'.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Size::OrSymbol
+              )
+            )
+          end
+          attr_reader :size
+
+          sig do
+            params(
+              size:
+                Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Size::OrSymbol
+            ).void
+          end
+          attr_writer :size
+
+          # Configuration for noise suppression. Applicable fields depend on the engine:
+          # 'attenuation_limit' and 'mode' only when noise_suppression is 'deepfilternet';
+          # 'family', 'size' and 'enhancement_level' only when noise_suppression is
+          # 'aicoustics'.
           sig do
             params(
               attenuation_limit: Integer,
+              enhancement_level: Float,
+              family:
+                Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Family::OrSymbol,
               mode:
-                Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Mode::OrSymbol
+                Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Mode::OrSymbol,
+              size:
+                Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Size::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
-            # Attenuation limit for noise suppression. Range: 0-100.
+            # Attenuation limit for noise suppression. Range: 0-100. Only applicable when
+            # noise_suppression is 'deepfilternet'.
             attenuation_limit: nil,
-            # Mode for noise suppression configuration.
-            mode: nil
+            # AiCoustics enhancement intensity. Range: 0-1. Only applicable when
+            # noise_suppression is 'aicoustics'.
+            enhancement_level: nil,
+            # AiCoustics model family optimized for Voice AI and STT. Only applicable when
+            # noise_suppression is 'aicoustics'.
+            family: nil,
+            # Mode for noise suppression configuration. Only applicable when noise_suppression
+            # is 'deepfilternet'.
+            mode: nil,
+            # AiCoustics model size. 'vf' tracks the latest model release; 'vf_2_0_l' is
+            # pinned to version 2.0 for consistent, predictable behavior. Only applicable when
+            # noise_suppression is 'aicoustics'.
+            size: nil
           )
           end
 
@@ -357,15 +437,52 @@ module Telnyx
             override.returns(
               {
                 attenuation_limit: Integer,
+                enhancement_level: Float,
+                family:
+                  Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Family::OrSymbol,
                 mode:
-                  Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Mode::OrSymbol
+                  Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Mode::OrSymbol,
+                size:
+                  Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Size::OrSymbol
               }
             )
           end
           def to_hash
           end
 
-          # Mode for noise suppression configuration.
+          # AiCoustics model family optimized for Voice AI and STT. Only applicable when
+          # noise_suppression is 'aicoustics'.
+          module Family
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Family
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            QUAIL =
+              T.let(
+                :quail,
+                Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Family::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Family::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Mode for noise suppression configuration. Only applicable when noise_suppression
+          # is 'deepfilternet'.
           module Mode
             extend Telnyx::Internal::Type::Enum
 
@@ -394,6 +511,43 @@ module Telnyx
             def self.values
             end
           end
+
+          # AiCoustics model size. 'vf' tracks the latest model release; 'vf_2_0_l' is
+          # pinned to version 2.0 for consistent, predictable behavior. Only applicable when
+          # noise_suppression is 'aicoustics'.
+          module Size
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Size
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            VF =
+              T.let(
+                :vf,
+                Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Size::TaggedSymbol
+              )
+            VF_2_0_L =
+              T.let(
+                :vf_2_0_l,
+                Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Size::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::AI::TelephonySettings::NoiseSuppressionConfig::Size::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
 
         class RecordingSettings < Telnyx::Internal::Type::BaseModel

data/rbi/telnyx/models/ai/tool_node.rbi

@@ -51,11 +51,12 @@ module Telnyx
             tool:
               T::Array[
                 T.any(
+                  Telnyx::AI::AssistantTool::Function::OrHash,
                   Telnyx::AI::InferenceEmbeddingWebhookToolParams::OrHash,
                   Telnyx::AI::AssistantTool::ClientSideTool::OrHash,
                   Telnyx::AI::RetrievalTool::OrHash,
                   Telnyx::AI::AssistantTool::Handoff::OrHash,
-                  Telnyx::AI::HangupTool::OrHash,
+                  Telnyx::AI::AssistantTool::Hangup::OrHash,
                   Telnyx::AI::AssistantTool::Transfer::OrHash,
                   Telnyx::AI::AssistantTool::Invite::OrHash,
                   Telnyx::AI::AssistantTool::Refer::OrHash,
@@ -87,11 +88,12 @@ module Telnyx
             tool:
               T::Array[
                 T.any(
+                  Telnyx::AI::AssistantTool::Function::OrHash,
                   Telnyx::AI::InferenceEmbeddingWebhookToolParams::OrHash,
                   Telnyx::AI::AssistantTool::ClientSideTool::OrHash,
                   Telnyx::AI::RetrievalTool::OrHash,
                   Telnyx::AI::AssistantTool::Handoff::OrHash,
-                  Telnyx::AI::HangupTool::OrHash,
+                  Telnyx::AI::AssistantTool::Hangup::OrHash,
                   Telnyx::AI::AssistantTool::Transfer::OrHash,
                   Telnyx::AI::AssistantTool::Invite::OrHash,
                   Telnyx::AI::AssistantTool::Refer::OrHash,