telnyx 5.131.0 → 5.148.0

data/lib/telnyx/models/ai/conversation_flow_req.rb

@@ -0,0 +1,400 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class ConversationFlowReq < Telnyx::Internal::Type::BaseModel
+        # @!attribute nodes
+        #   All nodes in the flow. Must contain `start_node_id`. Each node is a prompt node
+        #   (`type: prompt`) or a tool node (`type: tool`).
+        #
+        #   @return [Array<Telnyx::Models::AI::ConversationFlowReq::Node::Prompt, Telnyx::Models::AI::ConversationFlowReq::Node::Tool, Telnyx::Models::AI::ConversationFlowReq::Node::Speak>]
+        required :nodes, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::ConversationFlowReq::Node] }
+
+        # @!attribute start_node_id
+        #   ID of the node where the conversation begins.
+        #
+        #   @return [String]
+        required :start_node_id, String
+
+        # @!attribute edges
+        #   Directed transitions between nodes. May be empty for a single-node flow.
+        #
+        #   @return [Array<Telnyx::Models::AI::FlowEdge>, nil]
+        optional :edges, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::FlowEdge] }
+
+        # @!method initialize(nodes:, start_node_id:, edges: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::ConversationFlowReq} for more details.
+        #
+        #   Conversation flow as supplied by API clients (create / update).
+        #
+        #   A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
+        #   unique node/edge IDs, that `start_node_id` references a real node, and that
+        #   every edge's endpoints reference real nodes.
+        #
+        #   @param nodes [Array<Telnyx::Models::AI::ConversationFlowReq::Node::Prompt, Telnyx::Models::AI::ConversationFlowReq::Node::Tool, Telnyx::Models::AI::ConversationFlowReq::Node::Speak>] All nodes in the flow. Must contain `start_node_id`. Each node is a prompt node
+        #
+        #   @param start_node_id [String] ID of the node where the conversation begins.
+        #
+        #   @param edges [Array<Telnyx::Models::AI::FlowEdge>] Directed transitions between nodes. May be empty for a single-node flow.
+
+        # One step in a conversation flow, as supplied by API clients.
+        #
+        # Each node carries the prompt, tool scope, and optional overrides for
+        # model/voice/transcription. Unset overrides cascade from the assistant.
+        module Node
+          extend Telnyx::Internal::Type::Union
+
+          discriminator :type
+
+          # One step in a conversation flow, as supplied by API clients.
+          #
+          # Each node carries the prompt, tool scope, and optional overrides for
+          # model/voice/transcription. Unset overrides cascade from the assistant.
+          variant :prompt, -> { Telnyx::AI::ConversationFlowReq::Node::Prompt }
+
+          # A standalone tool step in a conversation flow, as supplied by clients.
+          #
+          # Unlike a prompt node, a tool node has no instructions or model — it
+          # isn't an LLM turn. Reaching it deterministically runs one shared tool
+          # (arguments filled from matching dynamic variables by name), then routes
+          # on the result via outgoing `tool_result` edges.
+          variant :tool, -> { Telnyx::AI::ConversationFlowReq::Node::Tool }
+
+          # A standalone scripted-message step in a flow, as supplied by clients.
+          #
+          # Unlike a prompt node, a speak node has no instructions or model — it isn't
+          # an LLM turn. Reaching it delivers `message` to the user verbatim (with
+          # `{{variable}}` interpolation), then routes via outgoing `llm` /
+          # `expression` edges.
+          variant :speak, -> { Telnyx::AI::ConversationFlowReq::Node::Speak }
+
+          class Prompt < Telnyx::Internal::Type::BaseModel
+            # @!attribute id
+            #   Caller-supplied unique identifier for this node within the flow.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute instructions
+            #   Prompt that drives the LLM while this node is active. Required.
+            #
+            #   @return [String]
+            required :instructions, String
+
+            # @!attribute external_llm
+            #   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).
+            #
+            #   @return [Telnyx::Models::AI::ExternalLlmReq, nil]
+            optional :external_llm, -> { Telnyx::AI::ExternalLlmReq }
+
+            # @!attribute instructions_mode
+            #   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.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::ConversationFlowReq::Node::Prompt::InstructionsMode, nil]
+            optional :instructions_mode, enum: -> { Telnyx::AI::ConversationFlowReq::Node::Prompt::InstructionsMode }
+
+            # @!attribute llm_api_key_ref
+            #   Override for `Assistant.llm_api_key_ref` while this node is active. Part of the
+            #   LLM bundle — see `model` for cascade semantics.
+            #
+            #   @return [String, nil]
+            optional :llm_api_key_ref, String
+
+            # @!attribute model
+            #   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.
+            #
+            #   @return [String, nil]
+            optional :model, String
+
+            # @!attribute name
+            #   Optional human-readable label, displayed in authoring UIs.
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!attribute position
+            #   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.
+            #
+            #   @return [Telnyx::Models::AI::NodePosition, nil]
+            optional :position, -> { Telnyx::AI::NodePosition }
+
+            # @!attribute shared_tool_ids
+            #   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.
+            #
+            #   @return [Array<String>, nil]
+            optional :shared_tool_ids, Telnyx::Internal::Type::ArrayOf[String]
+
+            # @!attribute tools_mode
+            #   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.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::ConversationFlowReq::Node::Prompt::ToolsMode, nil]
+            optional :tools_mode, enum: -> { Telnyx::AI::ConversationFlowReq::Node::Prompt::ToolsMode }
+
+            # @!attribute transcription
+            #   Per-node transcription override (model/language/region). Unset fields cascade
+            #   from the assistant-level transcription.
+            #
+            #   @return [Telnyx::Models::AI::TranscriptionSettings, nil]
+            optional :transcription, -> { Telnyx::AI::TranscriptionSettings }
+
+            # @!attribute type
+            #   Node kind discriminator. `prompt` (default) is an LLM-driven step; `tool` is a
+            #   standalone tool execution (see `ToolNodeReq`).
+            #
+            #   @return [Symbol, Telnyx::Models::AI::ConversationFlowReq::Node::Prompt::Type, nil]
+            optional :type, enum: -> { Telnyx::AI::ConversationFlowReq::Node::Prompt::Type }
+
+            # @!attribute voice_settings
+            #   Per-node voice override. Only fields set here override the assistant-level voice
+            #   settings; unset fields cascade.
+            #
+            #   @return [Telnyx::Models::AI::VoiceSettings, nil]
+            optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
+
+            # @!method initialize(id:, instructions:, external_llm: nil, instructions_mode: nil, llm_api_key_ref: nil, model: nil, name: nil, position: nil, shared_tool_ids: nil, tools_mode: nil, transcription: nil, type: nil, voice_settings: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::ConversationFlowReq::Node::Prompt} for more details.
+            #
+            #   One step in a conversation flow, as supplied by API clients.
+            #
+            #   Each node carries the prompt, tool scope, and optional overrides for
+            #   model/voice/transcription. Unset overrides cascade from the assistant.
+            #
+            #   @param id [String] Caller-supplied unique identifier for this node within the flow.
+            #
+            #   @param instructions [String] Prompt that drives the LLM while this node is active. Required.
+            #
+            #   @param external_llm [Telnyx::Models::AI::ExternalLlmReq] Override for `Assistant.external_llm` while this node is active. Use this to rou
+            #
+            #   @param instructions_mode [Symbol, Telnyx::Models::AI::ConversationFlowReq::Node::Prompt::InstructionsMode] How `instructions` combine with the assistant-level instructions. `replace` (def
+            #
+            #   @param llm_api_key_ref [String] Override for `Assistant.llm_api_key_ref` while this node is active. Part of the
+            #
+            #   @param model [String] Override for `Assistant.model` while this node is active. Part of the LLM bundle
+            #
+            #   @param name [String] Optional human-readable label, displayed in authoring UIs.
+            #
+            #   @param position [Telnyx::Models::AI::NodePosition] Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
+            #
+            #   @param shared_tool_ids [Array<String>] IDs of shared (org-level) tools available at this node. Knowledge bases are atta
+            #
+            #   @param tools_mode [Symbol, Telnyx::Models::AI::ConversationFlowReq::Node::Prompt::ToolsMode] How `shared_tool_ids` combine with the assistant-level tool set. `replace` (defa
+            #
+            #   @param transcription [Telnyx::Models::AI::TranscriptionSettings] Per-node transcription override (model/language/region). Unset fields cascade fr
+            #
+            #   @param type [Symbol, Telnyx::Models::AI::ConversationFlowReq::Node::Prompt::Type] Node kind discriminator. `prompt` (default) is an LLM-driven step; `tool` is a s
+            #
+            #   @param voice_settings [Telnyx::Models::AI::VoiceSettings] Per-node voice override. Only fields set here override the assistant-level voice
+
+            # 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.
+            #
+            # @see Telnyx::Models::AI::ConversationFlowReq::Node::Prompt#instructions_mode
+            module InstructionsMode
+              extend Telnyx::Internal::Type::Enum
+
+              REPLACE = :replace
+              APPEND = :append
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            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.
+            #
+            # @see Telnyx::Models::AI::ConversationFlowReq::Node::Prompt#tools_mode
+            module ToolsMode
+              extend Telnyx::Internal::Type::Enum
+
+              REPLACE = :replace
+              APPEND = :append
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # Node kind discriminator. `prompt` (default) is an LLM-driven step; `tool` is a
+            # standalone tool execution (see `ToolNodeReq`).
+            #
+            # @see Telnyx::Models::AI::ConversationFlowReq::Node::Prompt#type
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              PROMPT = :prompt
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class Tool < Telnyx::Internal::Type::BaseModel
+            # @!attribute id
+            #   Caller-supplied unique identifier for this node within the flow.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute shared_tool_id
+            #   ID of the single shared (org-level) tool this node executes. When the flow
+            #   reaches this node the tool runs as a deliberate step (no LLM turn); its outgoing
+            #   `tool_result` edges then route on the outcome. Arguments are filled from the
+            #   conversation's dynamic variables by name — a dynamic variable whose name matches
+            #   one of the tool's parameters supplies that argument. Cross-validated against the
+            #   org's shared tools on write.
+            #
+            #   @return [String]
+            required :shared_tool_id, String
+
+            # @!attribute name
+            #   Optional human-readable label, displayed in authoring UIs.
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!attribute position
+            #   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.
+            #
+            #   @return [Telnyx::Models::AI::NodePosition, nil]
+            optional :position, -> { Telnyx::AI::NodePosition }
+
+            # @!attribute type
+            #   Node kind discriminator. Always `tool` for a tool node.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::ConversationFlowReq::Node::Tool::Type, nil]
+            optional :type, enum: -> { Telnyx::AI::ConversationFlowReq::Node::Tool::Type }
+
+            # @!method initialize(id:, shared_tool_id:, name: nil, position: nil, type: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::ConversationFlowReq::Node::Tool} for more details.
+            #
+            #   A standalone tool step in a conversation flow, as supplied by clients.
+            #
+            #   Unlike a prompt node, a tool node has no instructions or model — it isn't an LLM
+            #   turn. Reaching it deterministically runs one shared tool (arguments filled from
+            #   matching dynamic variables by name), then routes on the result via outgoing
+            #   `tool_result` edges.
+            #
+            #   @param id [String] Caller-supplied unique identifier for this node within the flow.
+            #
+            #   @param shared_tool_id [String] ID of the single shared (org-level) tool this node executes. When the flow reach
+            #
+            #   @param name [String] Optional human-readable label, displayed in authoring UIs.
+            #
+            #   @param position [Telnyx::Models::AI::NodePosition] Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
+            #
+            #   @param type [Symbol, Telnyx::Models::AI::ConversationFlowReq::Node::Tool::Type] Node kind discriminator. Always `tool` for a tool node.
+
+            # Node kind discriminator. Always `tool` for a tool node.
+            #
+            # @see Telnyx::Models::AI::ConversationFlowReq::Node::Tool#type
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              TOOL = :tool
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class Speak < Telnyx::Internal::Type::BaseModel
+            # @!attribute id
+            #   Caller-supplied unique identifier for this node within the flow.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute message
+            #   Message delivered to the user verbatim when the flow reaches this node. No LLM
+            #   turn — the text is spoken/sent exactly as written. `{{variable}}` placeholders
+            #   are interpolated from the conversation's dynamic variables; an unresolved
+            #   placeholder renders as an empty string. After delivering, the flow routes via
+            #   the node's outgoing `llm` / `expression` edges (commonly a single unconditional
+            #   edge).
+            #
+            #   @return [String]
+            required :message, String
+
+            # @!attribute name
+            #   Optional human-readable label, displayed in authoring UIs.
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!attribute position
+            #   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.
+            #
+            #   @return [Telnyx::Models::AI::NodePosition, nil]
+            optional :position, -> { Telnyx::AI::NodePosition }
+
+            # @!attribute type
+            #   Node kind discriminator. Always `speak` for a speak node.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::ConversationFlowReq::Node::Speak::Type, nil]
+            optional :type, enum: -> { Telnyx::AI::ConversationFlowReq::Node::Speak::Type }
+
+            # @!method initialize(id:, message:, name: nil, position: nil, type: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::ConversationFlowReq::Node::Speak} for more details.
+            #
+            #   A standalone scripted-message step in a flow, as supplied by clients.
+            #
+            #   Unlike a prompt node, a speak node has no instructions or model — it isn't an
+            #   LLM turn. Reaching it delivers `message` to the user verbatim (with
+            #   `{{variable}}` interpolation), then routes via outgoing `llm` / `expression`
+            #   edges.
+            #
+            #   @param id [String] Caller-supplied unique identifier for this node within the flow.
+            #
+            #   @param message [String] Message delivered to the user verbatim when the flow reaches this node. No LLM t
+            #
+            #   @param name [String] Optional human-readable label, displayed in authoring UIs.
+            #
+            #   @param position [Telnyx::Models::AI::NodePosition] Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
+            #
+            #   @param type [Symbol, Telnyx::Models::AI::ConversationFlowReq::Node::Speak::Type] Node kind discriminator. Always `speak` for a speak node.
+
+            # Node kind discriminator. Always `speak` for a speak node.
+            #
+            # @see Telnyx::Models::AI::ConversationFlowReq::Node::Speak#type
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              SPEAK = :speak
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(Telnyx::Models::AI::ConversationFlowReq::Node::Prompt, Telnyx::Models::AI::ConversationFlowReq::Node::Tool, Telnyx::Models::AI::ConversationFlowReq::Node::Speak)]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/events_list_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class EventsListResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::AI::Missions::Runs::EventData>]
+        required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Missions::Runs::EventData] }
+
+        # @!attribute meta
+        #
+        #   @return [Telnyx::Models::AI::Assistants::Tests::TestSuites::Meta]
+        required :meta, -> { Telnyx::AI::Assistants::Tests::TestSuites::Meta }
+
+        # @!method initialize(data:, meta:)
+        #   @param data [Array<Telnyx::Models::AI::Missions::Runs::EventData>]
+        #   @param meta [Telnyx::Models::AI::Assistants::Tests::TestSuites::Meta]
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/execution_mode.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module ExecutionMode
+        extend Telnyx::Internal::Type::Enum
+
+        EXTERNAL = :external
+        MANAGED = :managed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/expression.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # A node in a deterministic expression AST. Exactly one variant is selected by the
+      # `type` discriminator. Terminal variants (`number_literal`, `string_literal`,
+      # `bool_literal`, `variable`) bottom out the recursion; `arithmetic`, `bool_op`,
+      # and `comparison` nest further sub-expressions.
+      #
+      # Extracted into a single named schema so the recursive union is defined once (was
+      # previously inlined at every operand site).
+      module Expression
+        extend Telnyx::Internal::Type::Union
+
+        discriminator :type
+
+        # Compare two sub-expressions with a relational or membership operator.
+        #
+        # Evaluates to a boolean. Used in edge conditions to gate transitions on
+        # runtime values, e.g. `user_age >= 18` or `tier == "gold"`.
+        variant :comparison, -> { Telnyx::AI::ComparisonExpression }
+
+        # Combine sub-expressions with a logical operator (`and` / `or` / `not`).
+        #
+        # `and` and `or` accept two or more operands; `not` accepts exactly one.
+        variant :bool_op, -> { Telnyx::AI::BooleanOpExpression }
+
+        # Numeric expression: applies an arithmetic operator to two sub-expressions.
+        #
+        # Useful for derived numeric checks, e.g. `cart_total + shipping > 50`.
+        # Both operands should resolve to numbers at runtime.
+        variant :arithmetic, -> { Telnyx::AI::ArithmeticExpression }
+
+        # Reference a dynamic variable by name.
+        #
+        # Resolved at runtime from the assistant's dynamic-variables context (see
+        # `Assistant.dynamic_variables` and the dynamic-variables webhook).
+        variant :variable, -> { Telnyx::AI::Expression::Variable }
+
+        # Constant string value.
+        variant :string_literal, -> { Telnyx::AI::Expression::StringLiteral }
+
+        # Constant numeric value (float; integers are accepted and stored as float).
+        variant :number_literal, -> { Telnyx::AI::Expression::NumberLiteral }
+
+        # Constant boolean value. Useful for unconditional ('always') edges.
+        variant :bool_literal, -> { Telnyx::AI::Expression::BoolLiteral }
+
+        class Variable < Telnyx::Internal::Type::BaseModel
+          # @!attribute name
+          #   Variable name to look up in the runtime context.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :variable]
+          required :type, const: :variable
+
+          # @!method initialize(name:, type: :variable)
+          #   Reference a dynamic variable by name.
+          #
+          #   Resolved at runtime from the assistant's dynamic-variables context (see
+          #   `Assistant.dynamic_variables` and the dynamic-variables webhook).
+          #
+          #   @param name [String] Variable name to look up in the runtime context.
+          #
+          #   @param type [Symbol, :variable]
+        end
+
+        class StringLiteral < Telnyx::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :string_literal]
+          required :type, const: :string_literal
+
+          # @!attribute value
+          #   Literal string value.
+          #
+          #   @return [String]
+          required :value, String
+
+          # @!method initialize(value:, type: :string_literal)
+          #   Constant string value.
+          #
+          #   @param value [String] Literal string value.
+          #
+          #   @param type [Symbol, :string_literal]
+        end
+
+        class NumberLiteral < Telnyx::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :number_literal]
+          required :type, const: :number_literal
+
+          # @!attribute value
+          #   Literal numeric value.
+          #
+          #   @return [Float]
+          required :value, Float
+
+          # @!method initialize(value:, type: :number_literal)
+          #   Constant numeric value (float; integers are accepted and stored as float).
+          #
+          #   @param value [Float] Literal numeric value.
+          #
+          #   @param type [Symbol, :number_literal]
+        end
+
+        class BoolLiteral < Telnyx::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :bool_literal]
+          required :type, const: :bool_literal
+
+          # @!attribute value
+          #   Literal boolean value.
+          #
+          #   @return [Boolean]
+          required :value, Telnyx::Internal::Type::Boolean
+
+          # @!method initialize(value:, type: :bool_literal)
+          #   Constant boolean value. Useful for unconditional ('always') edges.
+          #
+          #   @param value [Boolean] Literal boolean value.
+          #
+          #   @param type [Symbol, :bool_literal]
+        end
+
+        # @!method self.variants
+        #   @return [Array(Telnyx::Models::AI::ComparisonExpression, Telnyx::Models::AI::BooleanOpExpression, Telnyx::Models::AI::ArithmeticExpression, Telnyx::Models::AI::Expression::Variable, Telnyx::Models::AI::Expression::StringLiteral, Telnyx::Models::AI::Expression::NumberLiteral, Telnyx::Models::AI::Expression::BoolLiteral)]
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/external_llm.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class ExternalLlm < Telnyx::Internal::Type::BaseModel
+        # @!attribute base_url
+        #   Base URL for the external LLM endpoint.
+        #
+        #   @return [String]
+        required :base_url, String
+
+        # @!attribute model
+        #   Model identifier to use with the external LLM endpoint.
+        #
+        #   @return [String]
+        required :model, String
+
+        # @!attribute authentication_method
+        #   Authentication method used when connecting to the external LLM endpoint.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::AuthenticationMethod, nil]
+        optional :authentication_method, enum: -> { Telnyx::AI::AuthenticationMethod }
+
+        # @!attribute certificate_ref
+        #   Integration secret identifier for the client certificate used with certificate
+        #   authentication.
+        #
+        #   @return [String, nil]
+        optional :certificate_ref, String
+
+        # @!attribute forward_metadata
+        #   When `true`, Telnyx forwards the assistant's dynamic variables to the external
+        #   LLM endpoint as a top-level `extra_metadata` object on the chat completion
+        #   request body. Defaults to `false`. Example payload sent to the external
+        #   endpoint:
+        #   `{"extra_metadata": {"customer_name": "Jane", "account_id": "acct_789", "telnyx_agent_target": "+13125550100", "telnyx_end_user_target": "+13125550123"}}`.
+        #   Distinct from OpenAI's native `metadata` field, which has its own size and type
+        #   limits.
+        #
+        #   @return [Boolean, nil]
+        optional :forward_metadata, Telnyx::Internal::Type::Boolean
+
+        # @!attribute llm_api_key_ref
+        #   Integration secret identifier for the external LLM API key.
+        #
+        #   @return [String, nil]
+        optional :llm_api_key_ref, String
+
+        # @!attribute token_retrieval_url
+        #   URL used to retrieve an access token when certificate authentication is enabled.
+        #
+        #   @return [String, nil]
+        optional :token_retrieval_url, String
+
+        # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::ExternalLlm} for more details.
+        #
+        #   @param base_url [String] Base URL for the external LLM endpoint.
+        #
+        #   @param model [String] Model identifier to use with the external LLM endpoint.
+        #
+        #   @param authentication_method [Symbol, Telnyx::Models::AI::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
+        #
+        #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
+        #
+        #   @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
+        #
+        #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
+        #
+        #   @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
+      end
+    end
+  end
+end