telnyx 5.126.0 → 5.128.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/instruction_enhance_params.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        # @see Telnyx::Resources::AI::Assistants::Instructions#enhance
+        class InstructionEnhanceParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute assistant_id
+          #
+          #   @return [String]
+          required :assistant_id, String
+
+          # @!attribute enhancement_prompt
+          #   Optional guidance describing how the instructions should be enhanced. When
+          #   provided, the LLM applies these requested changes in addition to fixing any
+          #   identified issues.
+          #
+          #   @return [String, nil]
+          optional :enhancement_prompt, String, nil?: true
+
+          # @!attribute instructions
+          #   The instructions to enhance. When omitted, the assistant's existing instructions
+          #   are used.
+          #
+          #   @return [String, nil]
+          optional :instructions, String, nil?: true
+
+          # @!method initialize(assistant_id:, enhancement_prompt: nil, instructions: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::Assistants::InstructionEnhanceParams} for more details.
+          #
+          #   @param assistant_id [String]
+          #
+          #   @param enhancement_prompt [String, nil] Optional guidance describing how the instructions should be enhanced. When provi
+          #
+          #   @param instructions [String, nil] The instructions to enhance. When omitted, the assistant's existing instructions
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        InstructionEnhanceResponse = String
+      end
+    end
+  end
+end

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

@@ -37,6 +37,14 @@ module Telnyx
           #   @return [String]
           required :telnyx_end_user_target, String
 
+          # @!attribute call_settings
+          #   Per-call telephony overrides applied when a scheduled phone-call event
+          #   dispatches. Phone-call events only. New per-call dispatch options should be
+          #   added here rather than as top-level event fields.
+          #
+          #   @return [Telnyx::Models::AI::Assistants::ScheduledEventCreateParams::CallSettings, nil]
+          optional :call_settings, -> { Telnyx::AI::Assistants::ScheduledEventCreateParams::CallSettings }
+
           # @!attribute conversation_metadata
           #   Metadata associated with the conversation. Telnyx provides several pieces of
           #   metadata, but customers can also add their own.
@@ -70,7 +78,7 @@ module Telnyx
           #   @return [String, nil]
           optional :text, String
 
-          # @!method initialize(assistant_id:, scheduled_at_fixed_datetime:, telnyx_agent_target:, telnyx_conversation_channel:, telnyx_end_user_target:, conversation_metadata: nil, dynamic_variables: nil, max_retries_client_errors: nil, retry_interval_secs: nil, text: nil, request_options: {})
+          # @!method initialize(assistant_id:, scheduled_at_fixed_datetime:, telnyx_agent_target:, telnyx_conversation_channel:, telnyx_end_user_target:, call_settings: nil, conversation_metadata: nil, dynamic_variables: nil, max_retries_client_errors: nil, retry_interval_secs: nil, text: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Telnyx::Models::AI::Assistants::ScheduledEventCreateParams} for more details.
           #
@@ -84,6 +92,8 @@ module Telnyx
           #
           #   @param telnyx_end_user_target [String] The phone number, SIP URI, to schedule the call or text to.
           #
+          #   @param call_settings [Telnyx::Models::AI::Assistants::ScheduledEventCreateParams::CallSettings] Per-call telephony overrides applied when a scheduled phone-call event
+          #
           #   @param conversation_metadata [Hash{Symbol=>String, Integer, Boolean}] Metadata associated with the conversation. Telnyx provides several pieces of met
           #
           #   @param dynamic_variables [Hash{Symbol=>String}] A map of dynamic variable names to values. These variables can be referenced in
@@ -96,6 +106,46 @@ module Telnyx
           #
           #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
+          class CallSettings < Telnyx::Internal::Type::BaseModel
+            # @!attribute sip_region
+            #   SIP region passed to Telnyx when initiating an outbound call. Values match the
+            #   Telnyx TeXML `SipRegion` parameter exactly. Telnyx defaults to `US` when
+            #   omitted.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::Assistants::ScheduledEventCreateParams::CallSettings::SipRegion, nil]
+            optional :sip_region,
+                     enum: -> { Telnyx::AI::Assistants::ScheduledEventCreateParams::CallSettings::SipRegion }
+
+            # @!method initialize(sip_region: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Assistants::ScheduledEventCreateParams::CallSettings} for
+            #   more details.
+            #
+            #   Per-call telephony overrides applied when a scheduled phone-call event
+            #   dispatches. Phone-call events only. New per-call dispatch options should be
+            #   added here rather than as top-level event fields.
+            #
+            #   @param sip_region [Symbol, Telnyx::Models::AI::Assistants::ScheduledEventCreateParams::CallSettings::SipRegion] SIP region passed to Telnyx when initiating an outbound call. Values
+
+            # SIP region passed to Telnyx when initiating an outbound call. Values match the
+            # Telnyx TeXML `SipRegion` parameter exactly. Telnyx defaults to `US` when
+            # omitted.
+            #
+            # @see Telnyx::Models::AI::Assistants::ScheduledEventCreateParams::CallSettings#sip_region
+            module SipRegion
+              extend Telnyx::Internal::Type::Enum
+
+              US = :US
+              EUROPE = :Europe
+              CANADA = :Canada
+              AUSTRALIA = :Australia
+              MIDDLE_EAST = :"Middle East"
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
           module ConversationMetadata
             extend Telnyx::Internal::Type::Union
 

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

@@ -15,11 +15,13 @@ module Telnyx
           required :assistant_id, String
 
           # @!attribute conversation_channel
+          #   Filter results by conversation channel.
           #
           #   @return [Symbol, Telnyx::Models::AI::Assistants::ConversationChannelType, nil]
           optional :conversation_channel, enum: -> { Telnyx::AI::Assistants::ConversationChannelType }
 
           # @!attribute from_date
+          #   Start of the date range filter (inclusive, ISO 8601).
           #
           #   @return [Time, nil]
           optional :from_date, Time
@@ -35,17 +37,24 @@ module Telnyx
           optional :page_size, Integer
 
           # @!attribute to_date
+          #   End of the date range filter (inclusive, ISO 8601).
           #
           #   @return [Time, nil]
           optional :to_date, Time
 
           # @!method initialize(assistant_id:, conversation_channel: nil, from_date: nil, page_number: nil, page_size: nil, to_date: nil, request_options: {})
           #   @param assistant_id [String]
-          #   @param conversation_channel [Symbol, Telnyx::Models::AI::Assistants::ConversationChannelType]
-          #   @param from_date [Time]
+          #
+          #   @param conversation_channel [Symbol, Telnyx::Models::AI::Assistants::ConversationChannelType] Filter results by conversation channel.
+          #
+          #   @param from_date [Time] Start of the date range filter (inclusive, ISO 8601).
+          #
           #   @param page_number [Integer]
+          #
           #   @param page_size [Integer]
-          #   @param to_date [Time]
+          #
+          #   @param to_date [Time] End of the date range filter (inclusive, ISO 8601).
+          #
           #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
         end
       end

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

@@ -42,6 +42,14 @@ module Telnyx
           #   @return [Integer, nil]
           optional :call_duration, Integer
 
+          # @!attribute call_settings
+          #   Per-call telephony overrides applied when a scheduled phone-call event
+          #   dispatches. Phone-call events only. New per-call dispatch options should be
+          #   added here rather than as top-level event fields.
+          #
+          #   @return [Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse::CallSettings, nil]
+          optional :call_settings, -> { Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::CallSettings }
+
           # @!attribute call_status
           #   Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
           #
@@ -114,7 +122,7 @@ module Telnyx
           #   @return [Symbol, Telnyx::Models::AI::Assistants::EventStatus, nil]
           optional :status, enum: -> { Telnyx::AI::Assistants::EventStatus }
 
-          # @!method initialize(assistant_id:, scheduled_at_fixed_datetime:, telnyx_agent_target:, telnyx_conversation_channel:, telnyx_end_user_target:, call_attempts: nil, call_duration: nil, call_status: nil, conversation_id: nil, conversation_metadata: nil, created_at: nil, dispatched_at: nil, dynamic_variables: nil, errors: nil, max_retries_client_errors: nil, retry_attempts: nil, retry_count: nil, retry_interval_secs: nil, scheduled_event_id: nil, status: nil)
+          # @!method initialize(assistant_id:, scheduled_at_fixed_datetime:, telnyx_agent_target:, telnyx_conversation_channel:, telnyx_end_user_target:, call_attempts: nil, call_duration: nil, call_settings: nil, call_status: nil, conversation_id: nil, conversation_metadata: nil, created_at: nil, dispatched_at: nil, dynamic_variables: nil, errors: nil, max_retries_client_errors: nil, retry_attempts: nil, retry_count: nil, retry_interval_secs: nil, scheduled_event_id: nil, status: nil)
           #   Some parameter documentations has been truncated, see
           #   {Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse} for more
           #   details.
@@ -133,6 +141,8 @@ module Telnyx
           #
           #   @param call_duration [Integer] Duration of the call in seconds
           #
+          #   @param call_settings [Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse::CallSettings] Per-call telephony overrides applied when a scheduled phone-call event
+          #
           #   @param call_status [String] Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
           #
           #   @param conversation_id [String]
@@ -201,6 +211,47 @@ module Telnyx
             #   @param telnyx_call_control_id [String]
           end
 
+          # @see Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse#call_settings
+          class CallSettings < Telnyx::Internal::Type::BaseModel
+            # @!attribute sip_region
+            #   SIP region passed to Telnyx when initiating an outbound call. Values match the
+            #   Telnyx TeXML `SipRegion` parameter exactly. Telnyx defaults to `US` when
+            #   omitted.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse::CallSettings::SipRegion, nil]
+            optional :sip_region,
+                     enum: -> { Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::CallSettings::SipRegion }
+
+            # @!method initialize(sip_region: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse::CallSettings}
+            #   for more details.
+            #
+            #   Per-call telephony overrides applied when a scheduled phone-call event
+            #   dispatches. Phone-call events only. New per-call dispatch options should be
+            #   added here rather than as top-level event fields.
+            #
+            #   @param sip_region [Symbol, Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse::CallSettings::SipRegion] SIP region passed to Telnyx when initiating an outbound call. Values
+
+            # SIP region passed to Telnyx when initiating an outbound call. Values match the
+            # Telnyx TeXML `SipRegion` parameter exactly. Telnyx defaults to `US` when
+            # omitted.
+            #
+            # @see Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse::CallSettings#sip_region
+            module SipRegion
+              extend Telnyx::Internal::Type::Enum
+
+              US = :US
+              EUROPE = :Europe
+              CANADA = :Canada
+              AUSTRALIA = :Australia
+              MIDDLE_EAST = :"Middle East"
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
           module ConversationMetadata
             extend Telnyx::Internal::Type::Union