telnyx 5.169.0 → 5.171.0

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

@@ -0,0 +1,110 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      CollectionsSource = Collections::CollectionsSource
+
+      module Collections
+        class CollectionsSource < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::Collections::CollectionsSource,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :id
+
+          sig { params(id: String).void }
+          attr_writer :id
+
+          # The Telnyx Storage bucket name. Present only for `bucket` sources.
+          sig { returns(T.nilable(String)) }
+          attr_reader :bucket_id
+
+          sig { params(bucket_id: String).void }
+          attr_writer :bucket_id
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :collection_id
+
+          sig { params(collection_id: String).void }
+          attr_writer :collection_id
+
+          # Identifies the record type. Always `ai_collection_source`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :record_type
+
+          sig { params(record_type: String).void }
+          attr_writer :record_type
+
+          # 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).
+          sig do
+            returns(
+              T.nilable(Telnyx::AI::Collections::SourceType::TaggedSymbol)
+            )
+          end
+          attr_reader :source_type
+
+          sig do
+            params(
+              source_type: Telnyx::AI::Collections::SourceType::OrSymbol
+            ).void
+          end
+          attr_writer :source_type
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :status
+
+          sig { params(status: String).void }
+          attr_writer :status
+
+          sig do
+            params(
+              id: String,
+              bucket_id: String,
+              collection_id: String,
+              record_type: String,
+              source_type: Telnyx::AI::Collections::SourceType::OrSymbol,
+              status: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id: nil,
+            # The Telnyx Storage bucket name. Present only for `bucket` sources.
+            bucket_id: nil,
+            collection_id: nil,
+            # Identifies the record type. Always `ai_collection_source`.
+            record_type: nil,
+            # 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).
+            source_type: nil,
+            status: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                bucket_id: String,
+                collection_id: String,
+                record_type: String,
+                source_type: Telnyx::AI::Collections::SourceType::TaggedSymbol,
+                status: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -10,77 +10,52 @@ module Telnyx
               T.any(Telnyx::AI::Collections::Source, Telnyx::Internal::AnyHash)
             end
 
-          sig { returns(T.nilable(String)) }
-          attr_reader :id
+          # Identifies one source within its profile: an ingested session, or one remembered
+          # fact. Returned by `ingest` and `remember` when the write is accepted.
+          # Re-ingesting a session keeps its source id.
+          sig { returns(String) }
+          attr_accessor :id
 
-          sig { params(id: String).void }
-          attr_writer :id
+          # Memories extracted from this source. A memory derived from several sources is
+          # not counted here.
+          sig { returns(Integer) }
+          attr_accessor :memory_count
 
-          # The Telnyx Storage bucket name. Present only for `bucket` sources.
+          # The session this source was ingested as. Null for a remembered fact.
           sig { returns(T.nilable(String)) }
-          attr_reader :bucket_id
-
-          sig { params(bucket_id: String).void }
-          attr_writer :bucket_id
+          attr_accessor :session_id
 
+          # When the source was first stored.
           sig { returns(T.nilable(String)) }
-          attr_reader :collection_id
+          attr_accessor :created_at
 
-          sig { params(collection_id: String).void }
-          attr_writer :collection_id
-
-          # Identifies the record type. Always `ai_collection_source`.
+          # When the source was last written; re-ingesting moves it.
           sig { returns(T.nilable(String)) }
-          attr_reader :record_type
-
-          sig { params(record_type: String).void }
-          attr_writer :record_type
-
-          # 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).
-          sig do
-            returns(
-              T.nilable(Telnyx::AI::Collections::SourceType::TaggedSymbol)
-            )
-          end
-          attr_reader :source_type
-
-          sig do
-            params(
-              source_type: Telnyx::AI::Collections::SourceType::OrSymbol
-            ).void
-          end
-          attr_writer :source_type
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :status
-
-          sig { params(status: String).void }
-          attr_writer :status
+          attr_accessor :updated_at
 
           sig do
             params(
               id: String,
-              bucket_id: String,
-              collection_id: String,
-              record_type: String,
-              source_type: Telnyx::AI::Collections::SourceType::OrSymbol,
-              status: String
+              memory_count: Integer,
+              session_id: T.nilable(String),
+              created_at: T.nilable(String),
+              updated_at: T.nilable(String)
             ).returns(T.attached_class)
           end
           def self.new(
-            id: nil,
-            # The Telnyx Storage bucket name. Present only for `bucket` sources.
-            bucket_id: nil,
-            collection_id: nil,
-            # Identifies the record type. Always `ai_collection_source`.
-            record_type: nil,
-            # 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).
-            source_type: nil,
-            status: nil
+            # Identifies one source within its profile: an ingested session, or one remembered
+            # fact. Returned by `ingest` and `remember` when the write is accepted.
+            # Re-ingesting a session keeps its source id.
+            id:,
+            # Memories extracted from this source. A memory derived from several sources is
+            # not counted here.
+            memory_count:,
+            # The session this source was ingested as. Null for a remembered fact.
+            session_id:,
+            # When the source was first stored.
+            created_at: nil,
+            # When the source was last written; re-ingesting moves it.
+            updated_at: nil
           )
           end
 
@@ -88,11 +63,10 @@ module Telnyx
             override.returns(
               {
                 id: String,
-                bucket_id: String,
-                collection_id: String,
-                record_type: String,
-                source_type: Telnyx::AI::Collections::SourceType::TaggedSymbol,
-                status: String
+                memory_count: Integer,
+                session_id: T.nilable(String),
+                created_at: T.nilable(String),
+                updated_at: T.nilable(String)
               }
             )
           end

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

@@ -13,22 +13,30 @@ module Telnyx
               )
             end
 
-          sig { returns(T.nilable(Telnyx::AI::Collections::Source)) }
+          sig { returns(T.nilable(Telnyx::AI::Collections::CollectionsSource)) }
           attr_reader :data
 
-          sig { params(data: Telnyx::AI::Collections::Source::OrHash).void }
+          sig do
+            params(
+              data: Telnyx::AI::Collections::CollectionsSource::OrHash
+            ).void
+          end
           attr_writer :data
 
           # Envelope containing a single collection source.
           sig do
-            params(data: Telnyx::AI::Collections::Source::OrHash).returns(
-              T.attached_class
-            )
+            params(
+              data: Telnyx::AI::Collections::CollectionsSource::OrHash
+            ).returns(T.attached_class)
           end
           def self.new(data: nil)
           end
 
-          sig { override.returns({ data: Telnyx::AI::Collections::Source }) }
+          sig do
+            override.returns(
+              { data: Telnyx::AI::Collections::CollectionsSource }
+            )
+          end
           def to_hash
           end
         end

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

@@ -13,17 +13,23 @@ module Telnyx
               )
             end
 
-          sig { returns(T.nilable(T::Array[Telnyx::AI::Collections::Source])) }
+          sig do
+            returns(
+              T.nilable(T::Array[Telnyx::AI::Collections::CollectionsSource])
+            )
+          end
           attr_reader :data
 
           sig do
-            params(data: T::Array[Telnyx::AI::Collections::Source::OrHash]).void
+            params(
+              data: T::Array[Telnyx::AI::Collections::CollectionsSource::OrHash]
+            ).void
           end
           attr_writer :data
 
           sig do
             params(
-              data: T::Array[Telnyx::AI::Collections::Source::OrHash]
+              data: T::Array[Telnyx::AI::Collections::CollectionsSource::OrHash]
             ).returns(T.attached_class)
           end
           def self.new(data: nil)
@@ -31,7 +37,7 @@ module Telnyx
 
           sig do
             override.returns(
-              { data: T::Array[Telnyx::AI::Collections::Source] }
+              { data: T::Array[Telnyx::AI::Collections::CollectionsSource] }
             )
           end
           def to_hash

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

@@ -13,11 +13,17 @@ module Telnyx
               )
             end
 
-          sig { returns(T.nilable(T::Array[Telnyx::AI::Collections::Source])) }
+          sig do
+            returns(
+              T.nilable(T::Array[Telnyx::AI::Collections::CollectionsSource])
+            )
+          end
           attr_reader :data
 
           sig do
-            params(data: T::Array[Telnyx::AI::Collections::Source::OrHash]).void
+            params(
+              data: T::Array[Telnyx::AI::Collections::CollectionsSource::OrHash]
+            ).void
           end
           attr_writer :data
 
@@ -42,7 +48,8 @@ module Telnyx
 
           sig do
             params(
-              data: T::Array[Telnyx::AI::Collections::Source::OrHash],
+              data:
+                T::Array[Telnyx::AI::Collections::CollectionsSource::OrHash],
               meta:
                 Telnyx::Models::AI::Collections::SourceReplaceResponse::Meta::OrHash
             ).returns(T.attached_class)
@@ -58,7 +65,7 @@ module Telnyx
           sig do
             override.returns(
               {
-                data: T::Array[Telnyx::AI::Collections::Source],
+                data: T::Array[Telnyx::AI::Collections::CollectionsSource],
                 meta:
                   Telnyx::Models::AI::Collections::SourceReplaceResponse::Meta
               }

data/rbi/telnyx/models/ai/conversation_flow_req.rbi

@@ -10,7 +10,7 @@ module Telnyx
           end
 
         # All nodes in the flow. Must contain `start_node_id`. Each node is a prompt node
-        # (`type: prompt`) or a tool node (`type: tool`).
+        # (`type: prompt`), a tool node (`type: tool`), or a speak node (`type: speak`).
         sig do
           returns(
             T::Array[
@@ -56,7 +56,7 @@ module Telnyx
         end
         def self.new(
           # All nodes in the flow. Must contain `start_node_id`. Each node is a prompt node
-          # (`type: prompt`) or a tool node (`type: tool`).
+          # (`type: prompt`), a tool node (`type: tool`), or a speak node (`type: speak`).
           nodes:,
           # ID of the node where the conversation begins.
           start_node_id:,

data/rbi/telnyx/models/ai/conversation_list_params.rbi

@@ -47,6 +47,17 @@ module Telnyx
         sig { params(metadata_assistant_id: String).void }
         attr_writer :metadata_assistant_id
 
+        # Filter by assistant version ID (e.g.,
+        # `metadata->assistant_version_id=eq.20250812T114318034399`). The version that
+        # handled the conversation is stored in metadata when the conversation starts;
+        # conversations created before this field was tracked, or that never resolved a
+        # version, have no `assistant_version_id` and do not match this filter.
+        sig { returns(T.nilable(String)) }
+        attr_reader :metadata_assistant_version_id
+
+        sig { params(metadata_assistant_version_id: String).void }
+        attr_writer :metadata_assistant_version_id
+
         # Filter by call control ID (e.g., `metadata->call_control_id=eq.v3:123`)
         sig { returns(T.nilable(String)) }
         attr_reader :metadata_call_control_id
@@ -108,6 +119,7 @@ module Telnyx
             last_message_at: String,
             limit: Integer,
             metadata_assistant_id: String,
+            metadata_assistant_version_id: String,
             metadata_call_control_id: String,
             metadata_telnyx_agent_target: String,
             metadata_telnyx_conversation_channel: String,
@@ -129,6 +141,12 @@ module Telnyx
           limit: nil,
           # Filter by assistant ID (e.g., `metadata->assistant_id=eq.assistant-123`)
           metadata_assistant_id: nil,
+          # Filter by assistant version ID (e.g.,
+          # `metadata->assistant_version_id=eq.20250812T114318034399`). The version that
+          # handled the conversation is stored in metadata when the conversation starts;
+          # conversations created before this field was tracked, or that never resolved a
+          # version, have no `assistant_version_id` and do not match this filter.
+          metadata_assistant_version_id: nil,
           # Filter by call control ID (e.g., `metadata->call_control_id=eq.v3:123`)
           metadata_call_control_id: nil,
           # Filter by the phone number, SIP URI, or other identifier for the agent (e.g.,
@@ -160,6 +178,7 @@ module Telnyx
               last_message_at: String,
               limit: Integer,
               metadata_assistant_id: String,
+              metadata_assistant_version_id: String,
               metadata_call_control_id: String,
               metadata_telnyx_agent_target: String,
               metadata_telnyx_conversation_channel: String,

data/rbi/telnyx/models/ai/delegation_settings.rbi

@@ -0,0 +1,190 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class DelegationSettings < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::DelegationSettings, Telnyx::Internal::AnyHash)
+          end
+
+        # Whether the assistant delegates work to a backend model. Defaults to `true`: a
+        # GPT-Live assistant with delegation disabled can hold a conversation but can
+        # never look anything up or run a tool.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :enabled
+
+        sig { params(enabled: T::Boolean).void }
+        attr_writer :enabled
+
+        # Run the backend on your own OpenAI-compatible endpoint instead of a
+        # Telnyx-hosted model. As above, a raw `api_key` here is rejected — reference an
+        # integration secret with `external_llm.llm_api_key_ref` instead.
+        sig { returns(T.nilable(Telnyx::AI::ExternalLlm)) }
+        attr_reader :external_llm
+
+        sig { params(external_llm: Telnyx::AI::ExternalLlm::OrHash).void }
+        attr_writer :external_llm
+
+        # Extra instructions for the backend model, in addition to the assistant's own.
+        # Use this for the business rules the backend needs and the talking model does
+        # not.
+        sig { returns(T.nilable(String)) }
+        attr_reader :instructions
+
+        sig { params(instructions: String).void }
+        attr_writer :instructions
+
+        # Integration secret identifier for the backend model's API key. Required for
+        # models from providers other than Telnyx, OpenAI and Anthropic. A raw `api_key`
+        # is rejected rather than ignored, so that no plaintext credential is stored on
+        # the assistant.
+        sig { returns(T.nilable(String)) }
+        attr_reader :llm_api_key_ref
+
+        sig { params(llm_api_key_ref: String).void }
+        attr_writer :llm_api_key_ref
+
+        # Who answers a delegation. `telnyx` runs the backend model on Telnyx with the
+        # assistant's own tools, MCP servers and observability. `client` relays the
+        # delegation to a server you host over the WebSocket configured in
+        # `websocket_settings`: Telnyx sends a `session.delegation.created` frame and
+        # waits for your `session.delegation.completed` answer. That answer is text only,
+        # since the socket offers no tool vocabulary. If no socket is connected the
+        # delegation is refused and the assistant tells the caller it cannot look things
+        # up right now. Defaults to `telnyx`.
+        sig do
+          returns(T.nilable(Telnyx::AI::DelegationSettings::Mode::OrSymbol))
+        end
+        attr_reader :mode
+
+        sig do
+          params(mode: Telnyx::AI::DelegationSettings::Mode::OrSymbol).void
+        end
+        attr_writer :mode
+
+        # The backend model that answers delegations. Must be a model available for AI
+        # Assistants. When enabling `telnyx` delegation, explicitly set this field or
+        # `external_llm.model`; a configuration without either backend model is rejected.
+        # Only applies when `mode` is `telnyx`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :model
+
+        sig { params(model: String).void }
+        attr_writer :model
+
+        # Whether the backend's answer is spoken to the caller. When `true` the result is
+        # appended as commentary and paraphrased aloud; when `false` it is kept as silent
+        # context that informs later answers without being read out. Defaults to `true`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :speak_results
+
+        sig { params(speak_results: T::Boolean).void }
+        attr_writer :speak_results
+
+        # Splits the conversation between a frontend model that talks to the caller and a
+        # backend model that does the work. On the GPT-Live route the frontend model
+        # cannot call tools at all — when it needs something done it raises a delegation
+        # and waits. On the chat completion route the frontend keeps a single `delegate`
+        # tool that returns immediately, so the conversation carries on while the backend
+        # works. Either way the backend's answer is spoken as commentary or kept as silent
+        # context, depending on `speak_results`. Beta feature.
+        sig do
+          params(
+            enabled: T::Boolean,
+            external_llm: Telnyx::AI::ExternalLlm::OrHash,
+            instructions: String,
+            llm_api_key_ref: String,
+            mode: Telnyx::AI::DelegationSettings::Mode::OrSymbol,
+            model: String,
+            speak_results: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Whether the assistant delegates work to a backend model. Defaults to `true`: a
+          # GPT-Live assistant with delegation disabled can hold a conversation but can
+          # never look anything up or run a tool.
+          enabled: nil,
+          # Run the backend on your own OpenAI-compatible endpoint instead of a
+          # Telnyx-hosted model. As above, a raw `api_key` here is rejected — reference an
+          # integration secret with `external_llm.llm_api_key_ref` instead.
+          external_llm: nil,
+          # Extra instructions for the backend model, in addition to the assistant's own.
+          # Use this for the business rules the backend needs and the talking model does
+          # not.
+          instructions: nil,
+          # Integration secret identifier for the backend model's API key. Required for
+          # models from providers other than Telnyx, OpenAI and Anthropic. A raw `api_key`
+          # is rejected rather than ignored, so that no plaintext credential is stored on
+          # the assistant.
+          llm_api_key_ref: nil,
+          # Who answers a delegation. `telnyx` runs the backend model on Telnyx with the
+          # assistant's own tools, MCP servers and observability. `client` relays the
+          # delegation to a server you host over the WebSocket configured in
+          # `websocket_settings`: Telnyx sends a `session.delegation.created` frame and
+          # waits for your `session.delegation.completed` answer. That answer is text only,
+          # since the socket offers no tool vocabulary. If no socket is connected the
+          # delegation is refused and the assistant tells the caller it cannot look things
+          # up right now. Defaults to `telnyx`.
+          mode: nil,
+          # The backend model that answers delegations. Must be a model available for AI
+          # Assistants. When enabling `telnyx` delegation, explicitly set this field or
+          # `external_llm.model`; a configuration without either backend model is rejected.
+          # Only applies when `mode` is `telnyx`.
+          model: nil,
+          # Whether the backend's answer is spoken to the caller. When `true` the result is
+          # appended as commentary and paraphrased aloud; when `false` it is kept as silent
+          # context that informs later answers without being read out. Defaults to `true`.
+          speak_results: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              enabled: T::Boolean,
+              external_llm: Telnyx::AI::ExternalLlm,
+              instructions: String,
+              llm_api_key_ref: String,
+              mode: Telnyx::AI::DelegationSettings::Mode::OrSymbol,
+              model: String,
+              speak_results: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Who answers a delegation. `telnyx` runs the backend model on Telnyx with the
+        # assistant's own tools, MCP servers and observability. `client` relays the
+        # delegation to a server you host over the WebSocket configured in
+        # `websocket_settings`: Telnyx sends a `session.delegation.created` frame and
+        # waits for your `session.delegation.completed` answer. That answer is text only,
+        # since the socket offers no tool vocabulary. If no socket is connected the
+        # delegation is refused and the assistant tells the caller it cannot look things
+        # up right now. Defaults to `telnyx`.
+        module Mode
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Telnyx::AI::DelegationSettings::Mode) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TELNYX =
+            T.let(:telnyx, Telnyx::AI::DelegationSettings::Mode::TaggedSymbol)
+          CLIENT =
+            T.let(:client, Telnyx::AI::DelegationSettings::Mode::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::DelegationSettings::Mode::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/external_llm.rbi

@@ -18,9 +18,7 @@ module Telnyx
         attr_accessor :model
 
         # Authentication method used when connecting to the external LLM endpoint.
-        sig do
-          returns(T.nilable(Telnyx::AI::AuthenticationMethod::TaggedSymbol))
-        end
+        sig { returns(T.nilable(Telnyx::AI::AuthenticationMethod::OrSymbol)) }
         attr_reader :authentication_method
 
         sig do
@@ -106,8 +104,7 @@ module Telnyx
             {
               base_url: String,
               model: String,
-              authentication_method:
-                Telnyx::AI::AuthenticationMethod::TaggedSymbol,
+              authentication_method: Telnyx::AI::AuthenticationMethod::OrSymbol,
               certificate_ref: String,
               forward_metadata: T::Boolean,
               llm_api_key_ref: String,