telnyx 5.102.1 → 5.103.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/scheduled_event_create_params.rb

@@ -52,13 +52,25 @@ module Telnyx
           #   @return [Hash{Symbol=>String}, nil]
           optional :dynamic_variables, Telnyx::Internal::Type::HashOf[String]
 
+          # @!attribute max_retries_client_errors
+          #   Configure number of retries on client errors: busy, no-answer, failed, canceled
+          #   (caller hung up before the callee answered)
+          #
+          #   @return [Integer, nil]
+          optional :max_retries_client_errors, Integer
+
+          # @!attribute retry_interval_secs
+          #
+          #   @return [Integer, nil]
+          optional :retry_interval_secs, Integer
+
           # @!attribute text
           #   Required for sms scheduled events. The text to be sent to the end user.
           #
           #   @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, text: nil, request_options: {})
+          # @!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: {})
           #   Some parameter documentations has been truncated, see
           #   {Telnyx::Models::AI::Assistants::ScheduledEventCreateParams} for more details.
           #
@@ -76,6 +88,10 @@ module Telnyx
           #
           #   @param dynamic_variables [Hash{Symbol=>String}] A map of dynamic variable names to values. These variables can be referenced in
           #
+          #   @param max_retries_client_errors [Integer] Configure number of retries on client errors: busy, no-answer, failed, canceled
+          #
+          #   @param retry_interval_secs [Integer]
+          #
           #   @param text [String] Required for sms scheduled events. The text to be sent to the end user.
           #
           #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]

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

@@ -30,6 +30,24 @@ module Telnyx
           #   @return [String]
           required :telnyx_end_user_target, String
 
+          # @!attribute call_attempts
+          #
+          #   @return [Array<Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse::CallAttempt>, nil]
+          optional :call_attempts,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::ScheduledPhoneCallEventResponse::CallAttempt] }
+
+          # @!attribute call_duration
+          #   Duration of the call in seconds
+          #
+          #   @return [Integer, nil]
+          optional :call_duration, Integer
+
+          # @!attribute call_status
+          #   Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
+          #
+          #   @return [String, nil]
+          optional :call_status, String
+
           # @!attribute conversation_id
           #
           #   @return [String, nil]
@@ -46,6 +64,12 @@ module Telnyx
           #   @return [Time, nil]
           optional :created_at, Time
 
+          # @!attribute dispatched_at
+          #   Date time at which call was sent
+          #
+          #   @return [Time, nil]
+          optional :dispatched_at, Time
+
           # @!attribute dynamic_variables
           #   A map of dynamic variable names to values. These variables can be referenced in
           #   the assistant's instructions and messages using {{variable_name}} syntax.
@@ -58,6 +82,13 @@ module Telnyx
           #   @return [Array<String>, nil]
           optional :errors, Telnyx::Internal::Type::ArrayOf[String]
 
+          # @!attribute max_retries_client_errors
+          #   Configure number of retries on client errors: busy, no-answer, failed, canceled
+          #   (caller hung up before the callee answered)
+          #
+          #   @return [Integer, nil]
+          optional :max_retries_client_errors, Integer
+
           # @!attribute retry_attempts
           #
           #   @return [Integer, nil]
@@ -68,6 +99,11 @@ module Telnyx
           #   @return [Integer, nil]
           optional :retry_count, Integer
 
+          # @!attribute retry_interval_secs
+          #
+          #   @return [Integer, nil]
+          optional :retry_interval_secs, Integer
+
           # @!attribute scheduled_event_id
           #
           #   @return [String, nil]
@@ -78,7 +114,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:, conversation_id: nil, conversation_metadata: nil, created_at: nil, dynamic_variables: nil, errors: nil, retry_attempts: nil, retry_count: 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_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.
@@ -93,24 +129,78 @@ module Telnyx
           #
           #   @param telnyx_end_user_target [String]
           #
+          #   @param call_attempts [Array<Telnyx::Models::AI::Assistants::ScheduledPhoneCallEventResponse::CallAttempt>]
+          #
+          #   @param call_duration [Integer] Duration of the call in seconds
+          #
+          #   @param call_status [String] Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
+          #
           #   @param conversation_id [String]
           #
           #   @param conversation_metadata [Hash{Symbol=>String, Integer, Boolean}]
           #
           #   @param created_at [Time]
           #
+          #   @param dispatched_at [Time] Date time at which call was sent
+          #
           #   @param dynamic_variables [Hash{Symbol=>String}] A map of dynamic variable names to values. These variables can be referenced in
           #
           #   @param errors [Array<String>]
           #
+          #   @param max_retries_client_errors [Integer] Configure number of retries on client errors: busy, no-answer, failed, canceled
+          #
           #   @param retry_attempts [Integer]
           #
           #   @param retry_count [Integer]
           #
+          #   @param retry_interval_secs [Integer]
+          #
           #   @param scheduled_event_id [String]
           #
           #   @param status [Symbol, Telnyx::Models::AI::Assistants::EventStatus]
 
+          class CallAttempt < Telnyx::Internal::Type::BaseModel
+            # @!attribute attempt_number
+            #
+            #   @return [Integer]
+            required :attempt_number, Integer
+
+            # @!attribute attempted_at
+            #
+            #   @return [Time]
+            required :attempted_at, Time
+
+            # @!attribute call_status
+            #   Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
+            #
+            #   @return [String]
+            required :call_status, String
+
+            # @!attribute call_duration
+            #   Duration of the call in seconds
+            #
+            #   @return [Integer, nil]
+            optional :call_duration, Integer
+
+            # @!attribute telnyx_call_control_id
+            #
+            #   @return [String, nil]
+            optional :telnyx_call_control_id, String
+
+            # @!method initialize(attempt_number:, attempted_at:, call_status:, call_duration: nil, telnyx_call_control_id: nil)
+            #   One row in `call_attempts` — captures the terminal outcome of a single dispatch.
+            #
+            #   @param attempt_number [Integer]
+            #
+            #   @param attempted_at [Time]
+            #
+            #   @param call_status [String] Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
+            #
+            #   @param call_duration [Integer] Duration of the call in seconds
+            #
+            #   @param telnyx_call_control_id [String]
+          end
+
           module ConversationMetadata
             extend Telnyx::Internal::Type::Union