telnyx 5.161.0 → 5.163.0

data/rbi/telnyx/models/ai/conversations/insight_create_params.rbi

@@ -46,6 +46,12 @@ module Telnyx
           sig { params(webhook: String).void }
           attr_writer :webhook
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :idempotency_key
+
+          sig { params(idempotency_key: String).void }
+          attr_writer :idempotency_key
+
           sig do
             params(
               instructions: String,
@@ -53,6 +59,7 @@ module Telnyx
               json_schema:
                 Telnyx::AI::Conversations::InsightCreateParams::JsonSchema::Variants,
               webhook: String,
+              idempotency_key: String,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
@@ -62,6 +69,7 @@ module Telnyx
             # If specified, the output will follow the JSON schema.
             json_schema: nil,
             webhook: nil,
+            idempotency_key: nil,
             request_options: {}
           )
           end
@@ -74,6 +82,7 @@ module Telnyx
                 json_schema:
                   Telnyx::AI::Conversations::InsightCreateParams::JsonSchema::Variants,
                 webhook: String,
+                idempotency_key: String,
                 request_options: Telnyx::RequestOptions
               }
             )

data/rbi/telnyx/models/ai/conversations/insight_group_insight_groups_params.rbi

@@ -31,11 +31,18 @@ module Telnyx
           sig { params(webhook: String).void }
           attr_writer :webhook
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :idempotency_key
+
+          sig { params(idempotency_key: String).void }
+          attr_writer :idempotency_key
+
           sig do
             params(
               name: String,
               description: String,
               webhook: String,
+              idempotency_key: String,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
@@ -43,6 +50,7 @@ module Telnyx
             name:,
             description: nil,
             webhook: nil,
+            idempotency_key: nil,
             request_options: {}
           )
           end
@@ -53,6 +61,7 @@ module Telnyx
                 name: String,
                 description: String,
                 webhook: String,
+                idempotency_key: String,
                 request_options: Telnyx::RequestOptions
               }
             )

data/rbi/telnyx/models/ai/conversations/message_list_response.rbi

@@ -34,6 +34,29 @@ module Telnyx
           sig { params(created_at: Time).void }
           attr_writer :created_at
 
+          sig do
+            returns(
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  Telnyx::Models::AI::Conversations::MessageListResponse::Metadata::Variants
+                ]
+              )
+            )
+          end
+          attr_reader :metadata
+
+          sig do
+            params(
+              metadata:
+                T::Hash[
+                  Symbol,
+                  Telnyx::Models::AI::Conversations::MessageListResponse::Metadata::Variants
+                ]
+            ).void
+          end
+          attr_writer :metadata
+
           # The datetime the message was sent to the end user.
           sig { returns(T.nilable(Time)) }
           attr_reader :sent_at
@@ -69,6 +92,11 @@ module Telnyx
                 Telnyx::Models::AI::Conversations::MessageListResponse::Role::OrSymbol,
               text: String,
               created_at: Time,
+              metadata:
+                T::Hash[
+                  Symbol,
+                  Telnyx::Models::AI::Conversations::MessageListResponse::Metadata::Variants
+                ],
               sent_at: Time,
               tool_calls:
                 T::Array[
@@ -85,6 +113,7 @@ module Telnyx
             # necesarily correspond to the time the message was sent. The best field to use to
             # determine the time the end user experienced the message is `sent_at`.
             created_at: nil,
+            metadata: nil,
             # The datetime the message was sent to the end user.
             sent_at: nil,
             # Optional tool calls made by the assistant.
@@ -99,6 +128,11 @@ module Telnyx
                   Telnyx::Models::AI::Conversations::MessageListResponse::Role::TaggedSymbol,
                 text: String,
                 created_at: Time,
+                metadata:
+                  T::Hash[
+                    Symbol,
+                    Telnyx::Models::AI::Conversations::MessageListResponse::Metadata::Variants
+                  ],
                 sent_at: Time,
                 tool_calls:
                   T::Array[
@@ -150,6 +184,57 @@ module Telnyx
             end
           end
 
+          module Metadata
+            extend Telnyx::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  String,
+                  Integer,
+                  T::Boolean,
+                  T::Array[
+                    Telnyx::Models::AI::Conversations::MessageListResponse::Metadata::ConversationMetadataListValue::Variants
+                  ]
+                )
+              end
+
+            module ConversationMetadataListValue
+              extend Telnyx::Internal::Type::Union
+
+              Variants = T.type_alias { T.any(String, Integer, T::Boolean) }
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Telnyx::Models::AI::Conversations::MessageListResponse::Metadata::ConversationMetadataListValue::Variants
+                  ]
+                )
+              end
+              def self.variants
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::AI::Conversations::MessageListResponse::Metadata::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+
+            ConversationMetadataListValueArray =
+              T.let(
+                Telnyx::Internal::Type::ArrayOf[
+                  union:
+                    Telnyx::Models::AI::Conversations::MessageListResponse::Metadata::ConversationMetadataListValue
+                ],
+                Telnyx::Internal::Type::Converter
+              )
+          end
+
           class ToolCall < Telnyx::Internal::Type::BaseModel
             OrHash =
               T.type_alias do

data/rbi/telnyx/models/ai/embedding_create_params.rbi

@@ -60,6 +60,12 @@ module Telnyx
         end
         attr_writer :loader
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
         sig do
           params(
             bucket_name: String,
@@ -68,6 +74,7 @@ module Telnyx
             embedding_model:
               Telnyx::AI::EmbeddingCreateParams::EmbeddingModel::OrSymbol,
             loader: Telnyx::AI::EmbeddingCreateParams::Loader::OrSymbol,
+            idempotency_key: String,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -79,6 +86,7 @@ module Telnyx
           embedding_model: nil,
           # Supported types of custom document loaders for embeddings.
           loader: nil,
+          idempotency_key: nil,
           request_options: {}
         )
         end
@@ -92,6 +100,7 @@ module Telnyx
               embedding_model:
                 Telnyx::AI::EmbeddingCreateParams::EmbeddingModel::OrSymbol,
               loader: Telnyx::AI::EmbeddingCreateParams::Loader::OrSymbol,
+              idempotency_key: String,
               request_options: Telnyx::RequestOptions
             }
           )

data/rbi/telnyx/models/ai/embedding_url_params.rbi

@@ -20,10 +20,17 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :url
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
         sig do
           params(
             bucket_name: String,
             url: String,
+            idempotency_key: String,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -32,6 +39,7 @@ module Telnyx
           bucket_name:,
           # The URL of the webpage to embed
           url:,
+          idempotency_key: nil,
           request_options: {}
         )
         end
@@ -41,6 +49,7 @@ module Telnyx
             {
               bucket_name: String,
               url: String,
+              idempotency_key: String,
               request_options: Telnyx::RequestOptions
             }
           )

data/rbi/telnyx/models/ai/flow_edge.rbi

@@ -20,7 +20,7 @@ module Telnyx
             T.any(
               Telnyx::AI::FlowEdge::Condition::Llm,
               Telnyx::AI::FlowEdge::Condition::Expression,
-              Telnyx::AI::FlowEdge::Condition::Default
+              Telnyx::AI::FlowEdge::Condition::DefaultCondition
             )
           )
         end
@@ -55,7 +55,7 @@ module Telnyx
               T.any(
                 Telnyx::AI::FlowEdge::Condition::Llm::OrHash,
                 Telnyx::AI::FlowEdge::Condition::Expression::OrHash,
-                Telnyx::AI::FlowEdge::Condition::Default::OrHash
+                Telnyx::AI::FlowEdge::Condition::DefaultCondition::OrHash
               ),
             start_node_id: String,
             target:
@@ -87,7 +87,7 @@ module Telnyx
                 T.any(
                   Telnyx::AI::FlowEdge::Condition::Llm,
                   Telnyx::AI::FlowEdge::Condition::Expression,
-                  Telnyx::AI::FlowEdge::Condition::Default
+                  Telnyx::AI::FlowEdge::Condition::DefaultCondition
                 ),
               start_node_id: String,
               target:
@@ -111,7 +111,7 @@ module Telnyx
               T.any(
                 Telnyx::AI::FlowEdge::Condition::Llm,
                 Telnyx::AI::FlowEdge::Condition::Expression,
-                Telnyx::AI::FlowEdge::Condition::Default
+                Telnyx::AI::FlowEdge::Condition::DefaultCondition
               )
             end
 
@@ -193,11 +193,11 @@ module Telnyx
             end
           end
 
-          class Default < Telnyx::Internal::Type::BaseModel
+          class DefaultCondition < Telnyx::Internal::Type::BaseModel
             OrHash =
               T.type_alias do
                 T.any(
-                  Telnyx::AI::FlowEdge::Condition::Default,
+                  Telnyx::AI::FlowEdge::Condition::DefaultCondition,
                   Telnyx::Internal::AnyHash
                 )
               end

data/rbi/telnyx/models/ai/flow_node.rbi

@@ -0,0 +1,348 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class FlowNode < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::FlowNode, Telnyx::Internal::AnyHash)
+          end
+
+        # Caller-supplied unique identifier for this node within the flow.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Prompt that drives the LLM while this node is active. Required.
+        sig { returns(String) }
+        attr_accessor :instructions
+
+        # Override for `Assistant.external_llm` while this node is active. Use this to
+        # route a node's turns to a different external LLM (different `model`, `base_url`,
+        # credentials). Part of the LLM bundle — see `model` for cascade semantics.
+        # Mutually exclusive with `model` on the node (a single LLM identity per node).
+        sig { returns(T.nilable(Telnyx::AI::ExternalLlm)) }
+        attr_reader :external_llm
+
+        sig { params(external_llm: Telnyx::AI::ExternalLlm::OrHash).void }
+        attr_writer :external_llm
+
+        # How `instructions` combine with the assistant-level instructions. `replace`
+        # (default): the node's instructions are used alone. `append`: the node's
+        # instructions are concatenated after the assistant's instructions.
+        sig do
+          returns(
+            T.nilable(Telnyx::AI::FlowNode::InstructionsMode::TaggedSymbol)
+          )
+        end
+        attr_reader :instructions_mode
+
+        sig do
+          params(
+            instructions_mode: Telnyx::AI::FlowNode::InstructionsMode::OrSymbol
+          ).void
+        end
+        attr_writer :instructions_mode
+
+        # Override for `Assistant.llm_api_key_ref` while this node is active. Part of the
+        # LLM bundle — see `model` for cascade semantics.
+        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
+
+        # Override for `Assistant.model` while this node is active. Part of the LLM bundle
+        # (`model` + `llm_api_key_ref` + `external_llm`): when any of the three is set on
+        # the node, all three are taken from the node and the assistant-level LLM identity
+        # is not consulted. When none of the three is set, the assistant's bundle cascades
+        # unchanged.
+        sig { returns(T.nilable(String)) }
+        attr_reader :model
+
+        sig { params(model: String).void }
+        attr_writer :model
+
+        # Optional human-readable label, displayed in authoring UIs.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
+        # by the runtime; round-trips so frontends can persist graph layout across
+        # reloads.
+        sig { returns(T.nilable(Telnyx::AI::NodePosition)) }
+        attr_reader :position
+
+        sig { params(position: Telnyx::AI::NodePosition::OrHash).void }
+        attr_writer :position
+
+        # IDs of shared (org-level) tools available at this node. Knowledge bases are
+        # attached the same way — via a shared retrieval tool. Tools not listed here are
+        # not callable while this node is active.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :shared_tool_ids
+
+        sig { params(shared_tool_ids: T::Array[String]).void }
+        attr_writer :shared_tool_ids
+
+        # Full tool definitions for this node, resolved from `shared_tool_ids`
+        # server-side. Populated on responses so clients can render the flow without a
+        # follow-up fetch per shared tool. Ignored on input — set `shared_tool_ids` to
+        # configure a node's tools.
+        sig do
+          returns(
+            T.nilable(T::Array[T::Array[Telnyx::AI::AssistantTool::Variants]])
+          )
+        end
+        attr_reader :tools
+
+        sig do
+          params(
+            tools:
+              T::Array[
+                T::Array[
+                  T.any(
+                    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::Transfer::OrHash,
+                    Telnyx::AI::AssistantTool::Invite::OrHash,
+                    Telnyx::AI::AssistantTool::Refer::OrHash,
+                    Telnyx::AI::AssistantTool::SendDtmf::OrHash,
+                    Telnyx::AI::AssistantTool::SendMessage::OrHash,
+                    Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                    Telnyx::AI::AssistantTool::Pay::OrHash,
+                    Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
+                  )
+                ]
+              ]
+          ).void
+        end
+        attr_writer :tools
+
+        # How `shared_tool_ids` combine with the assistant-level tool set. `replace`
+        # (default): only the node's tools are callable. `append`: the node's tools are
+        # added to the assistant's tools. Ignored when `shared_tool_ids` is null.
+        sig do
+          returns(T.nilable(Telnyx::AI::FlowNode::ToolsMode::TaggedSymbol))
+        end
+        attr_reader :tools_mode
+
+        sig do
+          params(tools_mode: Telnyx::AI::FlowNode::ToolsMode::OrSymbol).void
+        end
+        attr_writer :tools_mode
+
+        # Per-node transcription override (response form).
+        sig { returns(T.nilable(Telnyx::AI::TranscriptionSettings)) }
+        attr_reader :transcription
+
+        sig do
+          params(transcription: Telnyx::AI::TranscriptionSettings::OrHash).void
+        end
+        attr_writer :transcription
+
+        # Node kind discriminator. `prompt` is an LLM-driven step.
+        sig { returns(T.nilable(Telnyx::AI::FlowNode::Type::TaggedSymbol)) }
+        attr_reader :type
+
+        sig { params(type: Telnyx::AI::FlowNode::Type::OrSymbol).void }
+        attr_writer :type
+
+        # Per-node voice override (response form).
+        sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
+        attr_reader :voice_settings
+
+        sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
+        attr_writer :voice_settings
+
+        # One step in a conversation flow, as returned by the API.
+        sig do
+          params(
+            id: String,
+            instructions: String,
+            external_llm: Telnyx::AI::ExternalLlm::OrHash,
+            instructions_mode: Telnyx::AI::FlowNode::InstructionsMode::OrSymbol,
+            llm_api_key_ref: String,
+            model: String,
+            name: String,
+            position: Telnyx::AI::NodePosition::OrHash,
+            shared_tool_ids: T::Array[String],
+            tools:
+              T::Array[
+                T::Array[
+                  T.any(
+                    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::Transfer::OrHash,
+                    Telnyx::AI::AssistantTool::Invite::OrHash,
+                    Telnyx::AI::AssistantTool::Refer::OrHash,
+                    Telnyx::AI::AssistantTool::SendDtmf::OrHash,
+                    Telnyx::AI::AssistantTool::SendMessage::OrHash,
+                    Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                    Telnyx::AI::AssistantTool::Pay::OrHash,
+                    Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
+                  )
+                ]
+              ],
+            tools_mode: Telnyx::AI::FlowNode::ToolsMode::OrSymbol,
+            transcription: Telnyx::AI::TranscriptionSettings::OrHash,
+            type: Telnyx::AI::FlowNode::Type::OrSymbol,
+            voice_settings: Telnyx::AI::VoiceSettings::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Caller-supplied unique identifier for this node within the flow.
+          id:,
+          # Prompt that drives the LLM while this node is active. Required.
+          instructions:,
+          # Override for `Assistant.external_llm` while this node is active. Use this to
+          # route a node's turns to a different external LLM (different `model`, `base_url`,
+          # credentials). Part of the LLM bundle — see `model` for cascade semantics.
+          # Mutually exclusive with `model` on the node (a single LLM identity per node).
+          external_llm: nil,
+          # How `instructions` combine with the assistant-level instructions. `replace`
+          # (default): the node's instructions are used alone. `append`: the node's
+          # instructions are concatenated after the assistant's instructions.
+          instructions_mode: nil,
+          # Override for `Assistant.llm_api_key_ref` while this node is active. Part of the
+          # LLM bundle — see `model` for cascade semantics.
+          llm_api_key_ref: nil,
+          # Override for `Assistant.model` while this node is active. Part of the LLM bundle
+          # (`model` + `llm_api_key_ref` + `external_llm`): when any of the three is set on
+          # the node, all three are taken from the node and the assistant-level LLM identity
+          # is not consulted. When none of the three is set, the assistant's bundle cascades
+          # unchanged.
+          model: nil,
+          # Optional human-readable label, displayed in authoring UIs.
+          name: nil,
+          # Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
+          # by the runtime; round-trips so frontends can persist graph layout across
+          # reloads.
+          position: nil,
+          # IDs of shared (org-level) tools available at this node. Knowledge bases are
+          # attached the same way — via a shared retrieval tool. Tools not listed here are
+          # not callable while this node is active.
+          shared_tool_ids: nil,
+          # Full tool definitions for this node, resolved from `shared_tool_ids`
+          # server-side. Populated on responses so clients can render the flow without a
+          # follow-up fetch per shared tool. Ignored on input — set `shared_tool_ids` to
+          # configure a node's tools.
+          tools: nil,
+          # How `shared_tool_ids` combine with the assistant-level tool set. `replace`
+          # (default): only the node's tools are callable. `append`: the node's tools are
+          # added to the assistant's tools. Ignored when `shared_tool_ids` is null.
+          tools_mode: nil,
+          # Per-node transcription override (response form).
+          transcription: nil,
+          # Node kind discriminator. `prompt` is an LLM-driven step.
+          type: nil,
+          # Per-node voice override (response form).
+          voice_settings: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              instructions: String,
+              external_llm: Telnyx::AI::ExternalLlm,
+              instructions_mode:
+                Telnyx::AI::FlowNode::InstructionsMode::TaggedSymbol,
+              llm_api_key_ref: String,
+              model: String,
+              name: String,
+              position: Telnyx::AI::NodePosition,
+              shared_tool_ids: T::Array[String],
+              tools: T::Array[T::Array[Telnyx::AI::AssistantTool::Variants]],
+              tools_mode: Telnyx::AI::FlowNode::ToolsMode::TaggedSymbol,
+              transcription: Telnyx::AI::TranscriptionSettings,
+              type: Telnyx::AI::FlowNode::Type::TaggedSymbol,
+              voice_settings: Telnyx::AI::VoiceSettings
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # How `instructions` combine with the assistant-level instructions. `replace`
+        # (default): the node's instructions are used alone. `append`: the node's
+        # instructions are concatenated after the assistant's instructions.
+        module InstructionsMode
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::FlowNode::InstructionsMode)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REPLACE =
+            T.let(
+              :replace,
+              Telnyx::AI::FlowNode::InstructionsMode::TaggedSymbol
+            )
+          APPEND =
+            T.let(:append, Telnyx::AI::FlowNode::InstructionsMode::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::FlowNode::InstructionsMode::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # How `shared_tool_ids` combine with the assistant-level tool set. `replace`
+        # (default): only the node's tools are callable. `append`: the node's tools are
+        # added to the assistant's tools. Ignored when `shared_tool_ids` is null.
+        module ToolsMode
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Telnyx::AI::FlowNode::ToolsMode) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REPLACE =
+            T.let(:replace, Telnyx::AI::FlowNode::ToolsMode::TaggedSymbol)
+          APPEND = T.let(:append, Telnyx::AI::FlowNode::ToolsMode::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::FlowNode::ToolsMode::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Node kind discriminator. `prompt` is an LLM-driven step.
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Telnyx::AI::FlowNode::Type) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PROMPT = T.let(:prompt, Telnyx::AI::FlowNode::Type::TaggedSymbol)
+
+          sig do
+            override.returns(T::Array[Telnyx::AI::FlowNode::Type::TaggedSymbol])
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end