telnyx 5.159.0 → 5.160.0

data/rbi/telnyx/models/ai/collections/source_type.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Collections
+        # The type of Telnyx data attached as a source. `bucket` requires an additional
+        # `bucket_id`. Only `voice` is searchable today; `meeting_bot`, `message`, and
+        # `bucket` attach but are not yet searchable (Coming soon).
+        module SourceType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Telnyx::AI::Collections::SourceType) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          VOICE =
+            T.let(:voice, Telnyx::AI::Collections::SourceType::TaggedSymbol)
+          MEETING_BOT =
+            T.let(
+              :meeting_bot,
+              Telnyx::AI::Collections::SourceType::TaggedSymbol
+            )
+          MESSAGE =
+            T.let(:message, Telnyx::AI::Collections::SourceType::TaggedSymbol)
+          BUCKET =
+            T.let(:bucket, Telnyx::AI::Collections::SourceType::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::Collections::SourceType::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/inference_embedding.rbi

@@ -279,7 +279,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                  Telnyx::AI::AssistantTool::Pay::OrHash
+                  Telnyx::AI::AssistantTool::Pay::OrHash,
+                  Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
               ]
           ).void
@@ -375,7 +376,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                  Telnyx::AI::AssistantTool::Pay::OrHash
+                  Telnyx::AI::AssistantTool::Pay::OrHash,
+                  Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
               ],
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
@@ -736,7 +738,8 @@ module Telnyx
                           Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                           Telnyx::AI::AssistantTool::SendMessage::OrHash,
                           Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                          Telnyx::AI::AssistantTool::Pay::OrHash
+                          Telnyx::AI::AssistantTool::Pay::OrHash,
+                          Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                         )
                       ]
                     ]
@@ -830,7 +833,8 @@ module Telnyx
                           Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                           Telnyx::AI::AssistantTool::SendMessage::OrHash,
                           Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                          Telnyx::AI::AssistantTool::Pay::OrHash
+                          Telnyx::AI::AssistantTool::Pay::OrHash,
+                          Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                         )
                       ]
                     ],
@@ -1089,7 +1093,8 @@ module Telnyx
                         Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                         Telnyx::AI::AssistantTool::SendMessage::OrHash,
                         Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                        Telnyx::AI::AssistantTool::Pay::OrHash
+                        Telnyx::AI::AssistantTool::Pay::OrHash,
+                        Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                       )
                     ]
                 ).void
@@ -1135,7 +1140,8 @@ module Telnyx
                         Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                         Telnyx::AI::AssistantTool::SendMessage::OrHash,
                         Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                        Telnyx::AI::AssistantTool::Pay::OrHash
+                        Telnyx::AI::AssistantTool::Pay::OrHash,
+                        Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                       )
                     ],
                   type:

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

@@ -17,6 +17,15 @@ module Telnyx
         sig { params(default_texml_app_id: String).void }
         attr_writer :default_texml_app_id
 
+        # Disable inbound DTMF for the entire call. Must be set to true if a 'pay' tool is
+        # configured anywhere on the assistant — on the main tool array or on any workflow
+        # node — enforced at write time.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :disable_dtmf
+
+        sig { params(disable_dtmf: T::Boolean).void }
+        attr_writer :disable_dtmf
+
         # The noise suppression engine to use. Use 'disabled' to turn off noise
         # suppression.
         sig do
@@ -125,6 +134,7 @@ module Telnyx
         sig do
           params(
             default_texml_app_id: String,
+            disable_dtmf: T::Boolean,
             noise_suppression:
               Telnyx::AI::TelephonySettings::NoiseSuppression::OrSymbol,
             noise_suppression_config:
@@ -143,6 +153,10 @@ module Telnyx
           # Default Texml App used for voice calls with your assistant. This will be created
           # automatically on assistant creation.
           default_texml_app_id: nil,
+          # Disable inbound DTMF for the entire call. Must be set to true if a 'pay' tool is
+          # configured anywhere on the assistant — on the main tool array or on any workflow
+          # node — enforced at write time.
+          disable_dtmf: nil,
           # The noise suppression engine to use. Use 'disabled' to turn off noise
           # suppression.
           noise_suppression: nil,
@@ -183,6 +197,7 @@ module Telnyx
           override.returns(
             {
               default_texml_app_id: String,
+              disable_dtmf: T::Boolean,
               noise_suppression:
                 Telnyx::AI::TelephonySettings::NoiseSuppression::OrSymbol,
               noise_suppression_config:

data/rbi/telnyx/models/ai/tool_create_params.rbi

@@ -60,6 +60,18 @@ module Telnyx
         sig { params(timeout_ms: Integer).void }
         attr_writer :timeout_ms
 
+        # Configuration for an update_dynamic_variables tool.
+        sig { returns(T.nilable(Telnyx::AI::UpdateDynamicVariablesToolParams)) }
+        attr_reader :update_dynamic_variables
+
+        sig do
+          params(
+            update_dynamic_variables:
+              Telnyx::AI::UpdateDynamicVariablesToolParams::OrHash
+          ).void
+        end
+        attr_writer :update_dynamic_variables
+
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :webhook
 
@@ -77,6 +89,8 @@ module Telnyx
             pay: Telnyx::AI::PayToolParams::OrHash,
             retrieval: T::Hash[Symbol, T.anything],
             timeout_ms: Integer,
+            update_dynamic_variables:
+              Telnyx::AI::UpdateDynamicVariablesToolParams::OrHash,
             webhook: T::Hash[Symbol, T.anything],
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -91,6 +105,8 @@ module Telnyx
           pay: nil,
           retrieval: nil,
           timeout_ms: nil,
+          # Configuration for an update_dynamic_variables tool.
+          update_dynamic_variables: nil,
           webhook: nil,
           request_options: {}
         )
@@ -108,6 +124,8 @@ module Telnyx
               pay: Telnyx::AI::PayToolParams,
               retrieval: T::Hash[Symbol, T.anything],
               timeout_ms: Integer,
+              update_dynamic_variables:
+                Telnyx::AI::UpdateDynamicVariablesToolParams,
               webhook: T::Hash[Symbol, T.anything],
               request_options: Telnyx::RequestOptions
             }

data/rbi/telnyx/models/ai/tool_update_params.rbi

@@ -69,6 +69,18 @@ module Telnyx
         sig { params(type: String).void }
         attr_writer :type
 
+        # Configuration for an update_dynamic_variables tool.
+        sig { returns(T.nilable(Telnyx::AI::UpdateDynamicVariablesToolParams)) }
+        attr_reader :update_dynamic_variables
+
+        sig do
+          params(
+            update_dynamic_variables:
+              Telnyx::AI::UpdateDynamicVariablesToolParams::OrHash
+          ).void
+        end
+        attr_writer :update_dynamic_variables
+
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :webhook
 
@@ -87,6 +99,8 @@ module Telnyx
             retrieval: T::Hash[Symbol, T.anything],
             timeout_ms: Integer,
             type: String,
+            update_dynamic_variables:
+              Telnyx::AI::UpdateDynamicVariablesToolParams::OrHash,
             webhook: T::Hash[Symbol, T.anything],
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -102,6 +116,8 @@ module Telnyx
           retrieval: nil,
           timeout_ms: nil,
           type: nil,
+          # Configuration for an update_dynamic_variables tool.
+          update_dynamic_variables: nil,
           webhook: nil,
           request_options: {}
         )
@@ -120,6 +136,8 @@ module Telnyx
               retrieval: T::Hash[Symbol, T.anything],
               timeout_ms: Integer,
               type: String,
+              update_dynamic_variables:
+                Telnyx::AI::UpdateDynamicVariablesToolParams,
               webhook: T::Hash[Symbol, T.anything],
               request_options: Telnyx::RequestOptions
             }

data/rbi/telnyx/models/ai/update_dynamic_variables_tool_params.rbi

@@ -0,0 +1,136 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class UpdateDynamicVariablesToolParams < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AI::UpdateDynamicVariablesToolParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Description of the tool passed to the assistant, guiding when to call it and
+        # which variables to update.
+        sig { returns(String) }
+        attr_accessor :description
+
+        # The function name surfaced to the LLM. Must match the OpenAI function-name
+        # pattern `^[a-zA-Z0-9_-]+$` and be unique across the assistant's function,
+        # webhook, and client_side tools.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The dynamic variables the assistant is allowed to write. At least one is
+        # required.
+        sig do
+          returns(
+            T::Array[
+              Telnyx::AI::UpdateDynamicVariablesToolParams::UpdatableVariable
+            ]
+          )
+        end
+        attr_accessor :updatable_variables
+
+        # Configuration for an update_dynamic_variables tool.
+        sig do
+          params(
+            description: String,
+            name: String,
+            updatable_variables:
+              T::Array[
+                Telnyx::AI::UpdateDynamicVariablesToolParams::UpdatableVariable::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Description of the tool passed to the assistant, guiding when to call it and
+          # which variables to update.
+          description:,
+          # The function name surfaced to the LLM. Must match the OpenAI function-name
+          # pattern `^[a-zA-Z0-9_-]+$` and be unique across the assistant's function,
+          # webhook, and client_side tools.
+          name:,
+          # The dynamic variables the assistant is allowed to write. At least one is
+          # required.
+          updatable_variables:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              description: String,
+              name: String,
+              updatable_variables:
+                T::Array[
+                  Telnyx::AI::UpdateDynamicVariablesToolParams::UpdatableVariable
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class UpdatableVariable < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::UpdateDynamicVariablesToolParams::UpdatableVariable,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The dynamic-variable key to update. Must match `^[a-zA-Z0-9._-]+$` and may not
+          # start with the reserved `telnyx_` prefix (reserved for system variables). The
+          # `pattern` encodes both rules via a negative lookahead.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # Optional description of the variable, guiding the assistant on what value to
+          # capture.
+          sig { returns(T.nilable(String)) }
+          attr_reader :description
+
+          sig { params(description: String).void }
+          attr_writer :description
+
+          # Optional hint for the variable's value type (e.g. `string`).
+          sig { returns(T.nilable(String)) }
+          attr_reader :type
+
+          sig { params(type: String).void }
+          attr_writer :type
+
+          sig do
+            params(name: String, description: String, type: String).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The dynamic-variable key to update. Must match `^[a-zA-Z0-9._-]+$` and may not
+            # start with the reserved `telnyx_` prefix (reserved for system variables). The
+            # `pattern` encodes both rules via a negative lookahead.
+            name:,
+            # Optional description of the variable, guiding the assistant on what value to
+            # capture.
+            description: nil,
+            # Optional hint for the variable's value type (e.g. `string`).
+            type: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { name: String, description: String, type: String }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/credential_connection.rbi

@@ -50,6 +50,15 @@ module Telnyx
       sig { params(connection_name: String).void }
       attr_writer :connection_name
 
+      # Whether conversation persistence is enabled for this connection. When enabled,
+      # calls handled by the connection are transcribed, stored, and indexed. Defaults
+      # to false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :conversation_persistence
+
+      sig { params(conversation_persistence: T::Boolean).void }
+      attr_writer :conversation_persistence
+
       # ISO-8601 formatted date indicating when the resource was created.
       sig { returns(T.nilable(String)) }
       attr_reader :created_at
@@ -263,6 +272,7 @@ module Telnyx
           android_push_credential_id: T.nilable(String),
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
+          conversation_persistence: T::Boolean,
           created_at: String,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
@@ -305,6 +315,10 @@ module Telnyx
         # Specifies if call cost webhooks should be sent for this connection.
         call_cost_in_webhooks: nil,
         connection_name: nil,
+        # Whether conversation persistence is enabled for this connection. When enabled,
+        # calls handled by the connection are transcribed, stored, and indexed. Defaults
+        # to false.
+        conversation_persistence: nil,
         # ISO-8601 formatted date indicating when the resource was created.
         created_at: nil,
         # When enabled, Telnyx will generate comfort noise when you place the call on
@@ -386,6 +400,7 @@ module Telnyx
             android_push_credential_id: T.nilable(String),
             call_cost_in_webhooks: T::Boolean,
             connection_name: String,
+            conversation_persistence: T::Boolean,
             created_at: String,
             default_on_hold_comfort_noise_enabled: T::Boolean,
             dtmf_type: Telnyx::DtmfType::TaggedSymbol,

data/rbi/telnyx/models/credential_connection_update_params.rbi

@@ -53,6 +53,15 @@ module Telnyx
       sig { params(connection_name: String).void }
       attr_writer :connection_name
 
+      # Whether conversation persistence is enabled for this connection. When enabled,
+      # calls handled by the connection are transcribed, stored, and indexed. Defaults
+      # to false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :conversation_persistence
+
+      sig { params(conversation_persistence: T::Boolean).void }
+      attr_writer :conversation_persistence
+
       # When enabled, Telnyx will generate comfort noise when you place the call on
       # hold. If disabled, you will need to generate comfort noise or on hold music to
       # avoid RTP timeout.
@@ -242,6 +251,7 @@ module Telnyx
           android_push_credential_id: T.nilable(String),
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
+          conversation_persistence: T::Boolean,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
           encode_contact_header_enabled: T::Boolean,
@@ -282,6 +292,10 @@ module Telnyx
         call_cost_in_webhooks: nil,
         # A user-assigned name to help manage the connection.
         connection_name: nil,
+        # Whether conversation persistence is enabled for this connection. When enabled,
+        # calls handled by the connection are transcribed, stored, and indexed. Defaults
+        # to false.
+        conversation_persistence: nil,
         # When enabled, Telnyx will generate comfort noise when you place the call on
         # hold. If disabled, you will need to generate comfort noise or on hold music to
         # avoid RTP timeout.
@@ -357,6 +371,7 @@ module Telnyx
             android_push_credential_id: T.nilable(String),
             call_cost_in_webhooks: T::Boolean,
             connection_name: String,
+            conversation_persistence: T::Boolean,
             default_on_hold_comfort_noise_enabled: T::Boolean,
             dtmf_type: Telnyx::DtmfType::OrSymbol,
             encode_contact_header_enabled: T::Boolean,

data/rbi/telnyx/models/fqdn_connection.rbi

@@ -62,6 +62,15 @@ module Telnyx
       sig { params(call_cost_in_webhooks: T::Boolean).void }
       attr_writer :call_cost_in_webhooks
 
+      # Whether conversation persistence is enabled for this connection. When enabled,
+      # calls handled by the connection are transcribed, stored, and indexed. Defaults
+      # to false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :conversation_persistence
+
+      sig { params(conversation_persistence: T::Boolean).void }
+      attr_writer :conversation_persistence
+
       # ISO 8601 formatted date indicating when the resource was created.
       sig { returns(T.nilable(String)) }
       attr_reader :created_at
@@ -316,6 +325,7 @@ module Telnyx
           android_push_credential_id: T.nilable(String),
           call_cost_enabled: T::Boolean,
           call_cost_in_webhooks: T::Boolean,
+          conversation_persistence: T::Boolean,
           created_at: String,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
@@ -370,6 +380,10 @@ module Telnyx
         call_cost_enabled: nil,
         # Specifies if call cost webhooks should be sent for this connection.
         call_cost_in_webhooks: nil,
+        # Whether conversation persistence is enabled for this connection. When enabled,
+        # calls handled by the connection are transcribed, stored, and indexed. Defaults
+        # to false.
+        conversation_persistence: nil,
         # ISO 8601 formatted date indicating when the resource was created.
         created_at: nil,
         # When enabled, Telnyx will generate comfort noise when you place the call on
@@ -465,6 +479,7 @@ module Telnyx
             android_push_credential_id: T.nilable(String),
             call_cost_enabled: T::Boolean,
             call_cost_in_webhooks: T::Boolean,
+            conversation_persistence: T::Boolean,
             created_at: String,
             default_on_hold_comfort_noise_enabled: T::Boolean,
             dtmf_type: Telnyx::DtmfType::TaggedSymbol,

data/rbi/telnyx/models/fqdn_connection_update_params.rbi

@@ -50,6 +50,15 @@ module Telnyx
       sig { params(connection_name: String).void }
       attr_writer :connection_name
 
+      # Whether conversation persistence is enabled for this connection. When enabled,
+      # calls handled by the connection are transcribed, stored, and indexed. Defaults
+      # to false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :conversation_persistence
+
+      sig { params(conversation_persistence: T::Boolean).void }
+      attr_writer :conversation_persistence
+
       # When enabled, Telnyx will generate comfort noise when you place the call on
       # hold. If disabled, you will need to generate comfort noise or on hold music to
       # avoid RTP timeout.
@@ -202,6 +211,7 @@ module Telnyx
           android_push_credential_id: T.nilable(String),
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
+          conversation_persistence: T::Boolean,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
           encode_contact_header_enabled: T::Boolean,
@@ -238,6 +248,10 @@ module Telnyx
         call_cost_in_webhooks: nil,
         # A user-assigned name to help manage the connection.
         connection_name: nil,
+        # Whether conversation persistence is enabled for this connection. When enabled,
+        # calls handled by the connection are transcribed, stored, and indexed. Defaults
+        # to false.
+        conversation_persistence: nil,
         # When enabled, Telnyx will generate comfort noise when you place the call on
         # hold. If disabled, you will need to generate comfort noise or on hold music to
         # avoid RTP timeout.
@@ -304,6 +318,7 @@ module Telnyx
             android_push_credential_id: T.nilable(String),
             call_cost_in_webhooks: T::Boolean,
             connection_name: String,
+            conversation_persistence: T::Boolean,
             default_on_hold_comfort_noise_enabled: T::Boolean,
             dtmf_type: Telnyx::DtmfType::OrSymbol,
             encode_contact_header_enabled: T::Boolean,