telnyx 5.111.0 → 5.112.0

data/lib/telnyx/models/ai/assistants/canary_deploy.rb

@@ -7,15 +7,135 @@ module Telnyx
         class CanaryDeploy < Telnyx::Internal::Type::BaseModel
           # @!attribute rules
           #
-          #   @return [Array<Telnyx::Models::AI::Assistants::RuleInput>, nil]
-          optional :rules, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::RuleInput] }
+          #   @return [Array<Telnyx::Models::AI::Assistants::CanaryDeploy::Rule>, nil]
+          optional :rules, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::CanaryDeploy::Rule] }
 
           # @!method initialize(rules: nil)
           #   Create/update request body. Accepts:
           #
           #   - `rules` — canonical ordered list of routing rules
           #
-          #   @param rules [Array<Telnyx::Models::AI::Assistants::RuleInput>]
+          #   @param rules [Array<Telnyx::Models::AI::Assistants::CanaryDeploy::Rule>]
+
+          class Rule < Telnyx::Internal::Type::BaseModel
+            # @!attribute serve
+            #   What a rule serves when matched.
+            #
+            #   Exactly one of:
+            #
+            #   - `version_id` — serve a specific version
+            #   - `rollout` — weighted random across versions; weights must sum to less than
+            #     100, with the leftover routing to the main version
+            #
+            #   @return [Telnyx::Models::AI::Assistants::CanaryDeploy::Rule::Serve]
+            required :serve, -> { Telnyx::AI::Assistants::CanaryDeploy::Rule::Serve }
+
+            # @!attribute match
+            #
+            #   @return [Array<Telnyx::Models::AI::Assistants::CanaryDeploy::Rule::Match>, nil]
+            optional :match, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::CanaryDeploy::Rule::Match] }
+
+            # @!method initialize(serve:, match: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Assistants::CanaryDeploy::Rule} for more details.
+            #
+            #   A targeting rule: `match` clauses (AND) gate `serve`.
+            #
+            #   An empty `match` is a catch-all (always fires).
+            #
+            #   @param serve [Telnyx::Models::AI::Assistants::CanaryDeploy::Rule::Serve] What a rule serves when matched.
+            #
+            #   @param match [Array<Telnyx::Models::AI::Assistants::CanaryDeploy::Rule::Match>]
+
+            # @see Telnyx::Models::AI::Assistants::CanaryDeploy::Rule#serve
+            class Serve < Telnyx::Internal::Type::BaseModel
+              # @!attribute rollout
+              #
+              #   @return [Array<Telnyx::Models::AI::Assistants::CanaryDeploy::Rule::Serve::Rollout>, nil]
+              optional :rollout,
+                       -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::CanaryDeploy::Rule::Serve::Rollout] }
+
+              # @!attribute version_id
+              #
+              #   @return [String, nil]
+              optional :version_id, String
+
+              # @!method initialize(rollout: nil, version_id: nil)
+              #   What a rule serves when matched.
+              #
+              #   Exactly one of:
+              #
+              #   - `version_id` — serve a specific version
+              #   - `rollout` — weighted random across versions; weights must sum to less than
+              #     100, with the leftover routing to the main version
+              #
+              #   @param rollout [Array<Telnyx::Models::AI::Assistants::CanaryDeploy::Rule::Serve::Rollout>]
+              #   @param version_id [String]
+
+              class Rollout < Telnyx::Internal::Type::BaseModel
+                # @!attribute version_id
+                #
+                #   @return [String]
+                required :version_id, String
+
+                # @!attribute weight
+                #
+                #   @return [Float]
+                required :weight, Float
+
+                # @!method initialize(version_id:, weight:)
+                #   One slot in a percentage rollout.
+                #
+                #   @param version_id [String]
+                #   @param weight [Float]
+              end
+            end
+
+            class Match < Telnyx::Internal::Type::BaseModel
+              # @!attribute attribute
+              #   Attribute name from the routing context
+              #
+              #   @return [String]
+              required :attribute, String
+
+              # @!attribute operator
+              #   Match operator
+              #
+              #   @return [Symbol, Telnyx::Models::AI::Assistants::CanaryDeploy::Rule::Match::Operator]
+              required :operator, enum: -> { Telnyx::AI::Assistants::CanaryDeploy::Rule::Match::Operator }
+
+              # @!attribute values
+              #
+              #   @return [Array<String>]
+              required :values, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!method initialize(attribute:, operator:, values:)
+              #   A single attribute/operator/values check.
+              #
+              #   A clause matches when the routing context's value for `attribute` satisfies
+              #   `operator` against any of `values`.
+              #
+              #   @param attribute [String] Attribute name from the routing context
+              #
+              #   @param operator [Symbol, Telnyx::Models::AI::Assistants::CanaryDeploy::Rule::Match::Operator] Match operator
+              #
+              #   @param values [Array<String>]
+
+              # Match operator
+              #
+              # @see Telnyx::Models::AI::Assistants::CanaryDeploy::Rule::Match#operator
+              module Operator
+                extend Telnyx::Internal::Type::Enum
+
+                IN = :in
+                NOT_IN = :not_in
+                STARTS_WITH = :starts_with
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
         end
       end
     end

data/lib/telnyx/models/ai/assistants/canary_deploy_response.rb

@@ -18,8 +18,9 @@ module Telnyx
 
           # @!attribute rules
           #
-          #   @return [Array<Telnyx::Models::AI::Assistants::RuleOutput>]
-          required :rules, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::RuleOutput] }
+          #   @return [Array<Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule>]
+          required :rules,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::CanaryDeployResponse::Rule] }
 
           # @!attribute updated_at
           #
@@ -33,8 +34,129 @@ module Telnyx
           #
           #   @param assistant_id [String]
           #   @param created_at [Time]
-          #   @param rules [Array<Telnyx::Models::AI::Assistants::RuleOutput>]
+          #   @param rules [Array<Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule>]
           #   @param updated_at [Time]
+
+          class Rule < Telnyx::Internal::Type::BaseModel
+            # @!attribute serve
+            #   What a rule serves when matched.
+            #
+            #   Exactly one of:
+            #
+            #   - `version_id` — serve a specific version
+            #   - `rollout` — weighted random across versions; weights must sum to less than
+            #     100, with the leftover routing to the main version
+            #
+            #   @return [Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule::Serve]
+            required :serve, -> { Telnyx::AI::Assistants::CanaryDeployResponse::Rule::Serve }
+
+            # @!attribute match
+            #
+            #   @return [Array<Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule::Match>, nil]
+            optional :match,
+                     -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::CanaryDeployResponse::Rule::Match] }
+
+            # @!method initialize(serve:, match: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule} for more details.
+            #
+            #   A targeting rule: `match` clauses (AND) gate `serve`.
+            #
+            #   An empty `match` is a catch-all (always fires).
+            #
+            #   @param serve [Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule::Serve] What a rule serves when matched.
+            #
+            #   @param match [Array<Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule::Match>]
+
+            # @see Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule#serve
+            class Serve < Telnyx::Internal::Type::BaseModel
+              # @!attribute rollout
+              #
+              #   @return [Array<Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule::Serve::Rollout>, nil]
+              optional :rollout,
+                       -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::CanaryDeployResponse::Rule::Serve::Rollout] }
+
+              # @!attribute version_id
+              #
+              #   @return [String, nil]
+              optional :version_id, String
+
+              # @!method initialize(rollout: nil, version_id: nil)
+              #   What a rule serves when matched.
+              #
+              #   Exactly one of:
+              #
+              #   - `version_id` — serve a specific version
+              #   - `rollout` — weighted random across versions; weights must sum to less than
+              #     100, with the leftover routing to the main version
+              #
+              #   @param rollout [Array<Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule::Serve::Rollout>]
+              #   @param version_id [String]
+
+              class Rollout < Telnyx::Internal::Type::BaseModel
+                # @!attribute version_id
+                #
+                #   @return [String]
+                required :version_id, String
+
+                # @!attribute weight
+                #
+                #   @return [Float]
+                required :weight, Float
+
+                # @!method initialize(version_id:, weight:)
+                #   One slot in a percentage rollout.
+                #
+                #   @param version_id [String]
+                #   @param weight [Float]
+              end
+            end
+
+            class Match < Telnyx::Internal::Type::BaseModel
+              # @!attribute attribute
+              #   Attribute name from the routing context
+              #
+              #   @return [String]
+              required :attribute, String
+
+              # @!attribute operator
+              #   Match operator
+              #
+              #   @return [Symbol, Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule::Match::Operator]
+              required :operator, enum: -> { Telnyx::AI::Assistants::CanaryDeployResponse::Rule::Match::Operator }
+
+              # @!attribute values
+              #
+              #   @return [Array<String>]
+              required :values, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!method initialize(attribute:, operator:, values:)
+              #   A single attribute/operator/values check.
+              #
+              #   A clause matches when the routing context's value for `attribute` satisfies
+              #   `operator` against any of `values`.
+              #
+              #   @param attribute [String] Attribute name from the routing context
+              #
+              #   @param operator [Symbol, Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule::Match::Operator] Match operator
+              #
+              #   @param values [Array<String>]
+
+              # Match operator
+              #
+              # @see Telnyx::Models::AI::Assistants::CanaryDeployResponse::Rule::Match#operator
+              module Operator
+                extend Telnyx::Internal::Type::Enum
+
+                IN = :in
+                NOT_IN = :not_in
+                STARTS_WITH = :starts_with
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
         end
       end
     end

data/lib/telnyx/models/ai/assistants/update_assistant.rb

@@ -82,8 +82,9 @@ module Telnyx
           #   `/ai/integrations/connections`. Each item references a catalog integration by
           #   `integration_id`.
           #
-          #   @return [Array<Telnyx::Models::AI::AssistantIntegration>, nil]
-          optional :integrations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantIntegration] }
+          #   @return [Array<Telnyx::Models::AI::Assistants::UpdateAssistant::Integration>, nil]
+          optional :integrations,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::UpdateAssistant::Integration] }
 
           # @!attribute interruption_settings
           #   Settings for interruptions and how the assistant decides the user has finished
@@ -93,8 +94,8 @@ module Telnyx
           #   `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
           #   `eager_eot_threshold`).
           #
-          #   @return [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings, nil]
-          optional :interruption_settings, -> { Telnyx::AI::InferenceEmbeddingInterruptionSettings }
+          #   @return [Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings, nil]
+          optional :interruption_settings, -> { Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings }
 
           # @!attribute llm_api_key_ref
           #   This is only needed when using third-party inference providers selected by
@@ -111,8 +112,9 @@ module Telnyx
           #   MCP servers attached to the assistant. Create MCP servers with
           #   `/ai/mcp_servers`, then reference them by `id` here.
           #
-          #   @return [Array<Telnyx::Models::AI::AssistantMcpServer>, nil]
-          optional :mcp_servers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantMcpServer] }
+          #   @return [Array<Telnyx::Models::AI::Assistants::UpdateAssistant::McpServer>, nil]
+          optional :mcp_servers,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::UpdateAssistant::McpServer] }
 
           # @!attribute messaging_settings
           #
@@ -228,13 +230,13 @@ module Telnyx
           #
           #   @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
           #
-          #   @param integrations [Array<Telnyx::Models::AI::AssistantIntegration>] Connected integrations attached to the assistant. The catalog of available integ
+          #   @param integrations [Array<Telnyx::Models::AI::Assistants::UpdateAssistant::Integration>] Connected integrations attached to the assistant. The catalog of available integ
           #
-          #   @param interruption_settings [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
+          #   @param interruption_settings [Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
           #
           #   @param llm_api_key_ref [String] This is only needed when using third-party inference providers selected by `mode
           #
-          #   @param mcp_servers [Array<Telnyx::Models::AI::AssistantMcpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
+          #   @param mcp_servers [Array<Telnyx::Models::AI::Assistants::UpdateAssistant::McpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
           #
           #   @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
           #
@@ -263,6 +265,174 @@ module Telnyx
           #   @param voice_settings [Telnyx::Models::AI::VoiceSettings]
           #
           #   @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
+
+          class Integration < Telnyx::Internal::Type::BaseModel
+            # @!attribute integration_id
+            #   Catalog integration ID to attach. This is the `id` from the integrations catalog
+            #   at `/ai/integrations` (the same value also appears as `integration_id` on
+            #   entries returned by `/ai/integrations/connections`). It is **not** the
+            #   connection-level `id` from `/ai/integrations/connections`.
+            #
+            #   @return [String]
+            required :integration_id, String
+
+            # @!attribute allowed_list
+            #   Optional per-assistant allowlist of integration tool names. When omitted or
+            #   empty, all tools allowed by the connected integration are available to the
+            #   assistant.
+            #
+            #   @return [Array<String>, nil]
+            optional :allowed_list, Telnyx::Internal::Type::ArrayOf[String]
+
+            # @!method initialize(integration_id:, allowed_list: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Assistants::UpdateAssistant::Integration} for more details.
+            #
+            #   Reference to a connected integration attached to an assistant. Discover
+            #   available integrations with `/ai/integrations` and connected integrations with
+            #   `/ai/integrations/connections`.
+            #
+            #   @param integration_id [String] Catalog integration ID to attach. This is the `id` from the integrations catalog
+            #
+            #   @param allowed_list [Array<String>] Optional per-assistant allowlist of integration tool names. When omitted or empt
+          end
+
+          # @see Telnyx::Models::AI::Assistants::UpdateAssistant#interruption_settings
+          class InterruptionSettings < Telnyx::Internal::Type::BaseModel
+            # @!attribute disable_greeting_interruption
+            #   When true, disables user interruptions while the assistant greeting is playing.
+            #
+            #   @return [Boolean, nil]
+            optional :disable_greeting_interruption, Telnyx::Internal::Type::Boolean
+
+            # @!attribute enable
+            #   Whether users can interrupt the assistant while it is speaking.
+            #
+            #   @return [Boolean, nil]
+            optional :enable, Telnyx::Internal::Type::Boolean
+
+            # @!attribute start_speaking_plan
+            #   Controls when the assistant starts speaking after the user stops. These
+            #   thresholds primarily apply to non turn-taking transcription models. For
+            #   turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
+            #   transcription end-of-turn settings under `transcription.settings` instead.
+            #
+            #   @return [Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan, nil]
+            optional :start_speaking_plan,
+                     -> { Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan }
+
+            # @!method initialize(disable_greeting_interruption: nil, enable: nil, start_speaking_plan: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings} for more
+            #   details.
+            #
+            #   Settings for interruptions and how the assistant decides the user has finished
+            #   speaking. These timings are most relevant when using non turn-taking
+            #   transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
+            #   behavior is controlled by the transcription end-of-turn settings under
+            #   `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
+            #   `eager_eot_threshold`).
+            #
+            #   @param disable_greeting_interruption [Boolean] When true, disables user interruptions while the assistant greeting is playing.
+            #
+            #   @param enable [Boolean] Whether users can interrupt the assistant while it is speaking.
+            #
+            #   @param start_speaking_plan [Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan] Controls when the assistant starts speaking after the user stops. These threshol
+
+            # @see Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings#start_speaking_plan
+            class StartSpeakingPlan < Telnyx::Internal::Type::BaseModel
+              # @!attribute transcription_endpointing_plan
+              #   Endpointing thresholds used to decide when the user has finished speaking.
+              #   Applies to non turn-taking transcription models. For `deepgram/flux`, use
+              #   `transcription.settings.eot_threshold` / `eot_timeout_ms` /
+              #   `eager_eot_threshold`.
+              #
+              #   @return [Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan, nil]
+              optional :transcription_endpointing_plan,
+                       -> { Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan }
+
+              # @!attribute wait_seconds
+              #   Minimum seconds to wait before the assistant starts speaking.
+              #
+              #   @return [Float, nil]
+              optional :wait_seconds, Float
+
+              # @!method initialize(transcription_endpointing_plan: nil, wait_seconds: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan}
+              #   for more details.
+              #
+              #   Controls when the assistant starts speaking after the user stops. These
+              #   thresholds primarily apply to non turn-taking transcription models. For
+              #   turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
+              #   transcription end-of-turn settings under `transcription.settings` instead.
+              #
+              #   @param transcription_endpointing_plan [Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan] Endpointing thresholds used to decide when the user has finished speaking. Appli
+              #
+              #   @param wait_seconds [Float] Minimum seconds to wait before the assistant starts speaking.
+
+              # @see Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan#transcription_endpointing_plan
+              class TranscriptionEndpointingPlan < Telnyx::Internal::Type::BaseModel
+                # @!attribute on_no_punctuation_seconds
+                #   Seconds to wait after the transcript ends without punctuation.
+                #
+                #   @return [Float, nil]
+                optional :on_no_punctuation_seconds, Float
+
+                # @!attribute on_number_seconds
+                #   Seconds to wait after the transcript ends with a number.
+                #
+                #   @return [Float, nil]
+                optional :on_number_seconds, Float
+
+                # @!attribute on_punctuation_seconds
+                #   Seconds to wait after the transcript ends with punctuation.
+                #
+                #   @return [Float, nil]
+                optional :on_punctuation_seconds, Float
+
+                # @!method initialize(on_no_punctuation_seconds: nil, on_number_seconds: nil, on_punctuation_seconds: nil)
+                #   Endpointing thresholds used to decide when the user has finished speaking.
+                #   Applies to non turn-taking transcription models. For `deepgram/flux`, use
+                #   `transcription.settings.eot_threshold` / `eot_timeout_ms` /
+                #   `eager_eot_threshold`.
+                #
+                #   @param on_no_punctuation_seconds [Float] Seconds to wait after the transcript ends without punctuation.
+                #
+                #   @param on_number_seconds [Float] Seconds to wait after the transcript ends with a number.
+                #
+                #   @param on_punctuation_seconds [Float] Seconds to wait after the transcript ends with punctuation.
+              end
+            end
+          end
+
+          class McpServer < Telnyx::Internal::Type::BaseModel
+            # @!attribute id
+            #   ID of the MCP server to attach. This must be the `id` of an MCP server returned
+            #   by the `/ai/mcp_servers` endpoints.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute allowed_tools
+            #   Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
+            #   uses the MCP server's configured `allowed_tools`.
+            #
+            #   @return [Array<String>, nil]
+            optional :allowed_tools, Telnyx::Internal::Type::ArrayOf[String]
+
+            # @!method initialize(id:, allowed_tools: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Assistants::UpdateAssistant::McpServer} for more details.
+            #
+            #   Reference to an MCP server attached to an assistant. Create and manage MCP
+            #   servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
+            #   ID.
+            #
+            #   @param id [String] ID of the MCP server to attach. This must be the `id` of an MCP server returned
+            #
+            #   @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
+          end
         end
       end