telnyx 5.162.0 → 5.164.0

data/rbi/telnyx/models/ai/assistant_tool.rbi

@@ -566,6 +566,34 @@ module Telnyx
             sig { returns(T.nilable(Integer)) }
             attr_accessor :warm_message_delay_ms
 
+            # Requires the transfer destination to accept the call before the caller is
+            # bridged. When enabled, the assistant speaks privately with the destination after
+            # they answer — delivering the warm transfer message and asking whether they take
+            # the call — while the caller keeps hearing ringback. The assistant then finalizes
+            # the transfer with the built-in `complete_transfer` tool: an accept bridges the
+            # calls, a decline hangs up the destination and returns the assistant to the
+            # caller with the reason the destination gave. Requires either
+            # `warm_transfer_instructions` or a `message` on every target, otherwise the
+            # assistant fails to save. Only available for calls started with
+            # `ai_assistant_start`; single-caller conversations only (a conference or
+            # additional invited participants fall back to a regular warm transfer).
+            sig do
+              returns(
+                T.nilable(
+                  Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance
+                )
+              )
+            end
+            attr_reader :warm_transfer_acceptance
+
+            sig do
+              params(
+                warm_transfer_acceptance:
+                  Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::OrHash
+              ).void
+            end
+            attr_writer :warm_transfer_acceptance
+
             # Natural language instructions for your agent for how to provide context for the
             # transfer recipient.
             sig { returns(T.nilable(String)) }
@@ -587,6 +615,8 @@ module Telnyx
                 voicemail_detection:
                   Telnyx::AI::AssistantTool::Transfer::Transfer::VoicemailDetection::OrHash,
                 warm_message_delay_ms: T.nilable(Integer),
+                warm_transfer_acceptance:
+                  Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::OrHash,
                 warm_transfer_instructions: String
               ).returns(T.attached_class)
             end
@@ -615,6 +645,18 @@ module Telnyx
               # dial command; instead, playback starts after the specified delay. When not set,
               # existing behavior (audio_url in dial) is preserved.
               warm_message_delay_ms: nil,
+              # Requires the transfer destination to accept the call before the caller is
+              # bridged. When enabled, the assistant speaks privately with the destination after
+              # they answer — delivering the warm transfer message and asking whether they take
+              # the call — while the caller keeps hearing ringback. The assistant then finalizes
+              # the transfer with the built-in `complete_transfer` tool: an accept bridges the
+              # calls, a decline hangs up the destination and returns the assistant to the
+              # caller with the reason the destination gave. Requires either
+              # `warm_transfer_instructions` or a `message` on every target, otherwise the
+              # assistant fails to save. Only available for calls started with
+              # `ai_assistant_start`; single-caller conversations only (a conference or
+              # additional invited participants fall back to a regular warm transfer).
+              warm_transfer_acceptance: nil,
               # Natural language instructions for your agent for how to provide context for the
               # transfer recipient.
               warm_transfer_instructions: nil
@@ -635,6 +677,8 @@ module Telnyx
                   voicemail_detection:
                     Telnyx::AI::AssistantTool::Transfer::Transfer::VoicemailDetection,
                   warm_message_delay_ms: T.nilable(Integer),
+                  warm_transfer_acceptance:
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance,
                   warm_transfer_instructions: String
                 }
               )
@@ -672,6 +716,15 @@ module Telnyx
                 sig { returns(String) }
                 attr_accessor :to
 
+                # The warm transfer message to deliver to this specific target. When set, it takes
+                # precedence over the message the assistant composes from
+                # `warm_transfer_instructions`.
+                sig { returns(T.nilable(String)) }
+                attr_reader :message
+
+                sig { params(message: String).void }
+                attr_writer :message
+
                 # The name of the target.
                 sig { returns(T.nilable(String)) }
                 attr_reader :name
@@ -680,17 +733,27 @@ module Telnyx
                 attr_writer :name
 
                 sig do
-                  params(to: String, name: String).returns(T.attached_class)
+                  params(to: String, message: String, name: String).returns(
+                    T.attached_class
+                  )
                 end
                 def self.new(
                   # The destination number or SIP URI of the call.
                   to:,
+                  # The warm transfer message to deliver to this specific target. When set, it takes
+                  # precedence over the message the assistant composes from
+                  # `warm_transfer_instructions`.
+                  message: nil,
                   # The name of the target.
                   name: nil
                 )
                 end
 
-                sig { override.returns({ to: String, name: String }) }
+                sig do
+                  override.returns(
+                    { to: String, message: String, name: String }
+                  )
+                end
                 def to_hash
                 end
               end
@@ -1272,6 +1335,126 @@ module Telnyx
                 end
               end
             end
+
+            class WarmTransferAcceptance < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Whether the destination must accept the transfer before the calls are bridged.
+              sig { returns(T.nilable(T::Boolean)) }
+              attr_reader :enabled
+
+              sig { params(enabled: T::Boolean).void }
+              attr_writer :enabled
+
+              # Controls whether the private exchange between the assistant and the transfer
+              # destination is kept out of the conversation. With `private` (default) the
+              # exchange never reaches the conversation history, AI conversations, webhooks or
+              # insights, and the transfer tool result is rewritten with the outcome only. With
+              # `shared` the exchange stays in the conversation like any other messages.
+              sig do
+                returns(
+                  T.nilable(
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode::OrSymbol
+                  )
+                )
+              end
+              attr_reader :end_user_target_context_mode
+
+              sig do
+                params(
+                  end_user_target_context_mode:
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode::OrSymbol
+                ).void
+              end
+              attr_writer :end_user_target_context_mode
+
+              # Requires the transfer destination to accept the call before the caller is
+              # bridged. When enabled, the assistant speaks privately with the destination after
+              # they answer — delivering the warm transfer message and asking whether they take
+              # the call — while the caller keeps hearing ringback. The assistant then finalizes
+              # the transfer with the built-in `complete_transfer` tool: an accept bridges the
+              # calls, a decline hangs up the destination and returns the assistant to the
+              # caller with the reason the destination gave. Requires either
+              # `warm_transfer_instructions` or a `message` on every target, otherwise the
+              # assistant fails to save. Only available for calls started with
+              # `ai_assistant_start`; single-caller conversations only (a conference or
+              # additional invited participants fall back to a regular warm transfer).
+              sig do
+                params(
+                  enabled: T::Boolean,
+                  end_user_target_context_mode:
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode::OrSymbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Whether the destination must accept the transfer before the calls are bridged.
+                enabled: nil,
+                # Controls whether the private exchange between the assistant and the transfer
+                # destination is kept out of the conversation. With `private` (default) the
+                # exchange never reaches the conversation history, AI conversations, webhooks or
+                # insights, and the transfer tool result is rewritten with the outcome only. With
+                # `shared` the exchange stays in the conversation like any other messages.
+                end_user_target_context_mode: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    enabled: T::Boolean,
+                    end_user_target_context_mode:
+                      Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode::OrSymbol
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # Controls whether the private exchange between the assistant and the transfer
+              # destination is kept out of the conversation. With `private` (default) the
+              # exchange never reaches the conversation history, AI conversations, webhooks or
+              # insights, and the transfer tool result is rewritten with the outcome only. With
+              # `shared` the exchange stays in the conversation like any other messages.
+              module EndUserTargetContextMode
+                extend Telnyx::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                PRIVATE =
+                  T.let(
+                    :private,
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode::TaggedSymbol
+                  )
+                SHARED =
+                  T.let(
+                    :shared,
+                    Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      Telnyx::AI::AssistantTool::Transfer::Transfer::WarmTransferAcceptance::EndUserTargetContextMode::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
           end
         end
 

data/rbi/telnyx/models/ai/assistants/canary_deploy_create_params.rbi

@@ -19,18 +19,29 @@ module Telnyx
           sig { returns(String) }
           attr_accessor :assistant_id
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :idempotency_key
+
+          sig { params(idempotency_key: String).void }
+          attr_writer :idempotency_key
+
           sig do
             params(
               assistant_id: String,
+              idempotency_key: String,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
-          def self.new(assistant_id:, request_options: {})
+          def self.new(assistant_id:, idempotency_key: nil, request_options: {})
           end
 
           sig do
             override.returns(
-              { assistant_id: String, request_options: Telnyx::RequestOptions }
+              {
+                assistant_id: String,
+                idempotency_key: String,
+                request_options: Telnyx::RequestOptions
+              }
             )
           end
           def to_hash

data/rbi/telnyx/models/ai/assistants/scheduled_event_create_params.rbi

@@ -106,6 +106,12 @@ module Telnyx
           sig { params(text: String).void }
           attr_writer :text
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :idempotency_key
+
+          sig { params(idempotency_key: String).void }
+          attr_writer :idempotency_key
+
           sig do
             params(
               assistant_id: String,
@@ -125,6 +131,7 @@ module Telnyx
               max_retries_client_errors: Integer,
               retry_interval_secs: Integer,
               text: String,
+              idempotency_key: String,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
@@ -153,6 +160,7 @@ module Telnyx
             retry_interval_secs: nil,
             # Required for sms scheduled events. The text to be sent to the end user.
             text: nil,
+            idempotency_key: nil,
             request_options: {}
           )
           end
@@ -176,6 +184,7 @@ module Telnyx
                 max_retries_client_errors: Integer,
                 retry_interval_secs: Integer,
                 text: String,
+                idempotency_key: String,
                 request_options: Telnyx::RequestOptions
               }
             )

data/rbi/telnyx/models/ai/assistants/test_create_params.rbi

@@ -81,6 +81,12 @@ module Telnyx
           sig { params(test_suite: String).void }
           attr_writer :test_suite
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :idempotency_key
+
+          sig { params(idempotency_key: String).void }
+          attr_writer :idempotency_key
+
           sig do
             params(
               destination: String,
@@ -95,6 +101,7 @@ module Telnyx
               telnyx_conversation_channel:
                 Telnyx::AI::Assistants::TelnyxConversationChannel::OrSymbol,
               test_suite: String,
+              idempotency_key: String,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
@@ -123,6 +130,7 @@ module Telnyx
             # Optional test suite name to group related tests together. Useful for organizing
             # tests by feature, team, or release cycle.
             test_suite: nil,
+            idempotency_key: nil,
             request_options: {}
           )
           end
@@ -140,6 +148,7 @@ module Telnyx
                 telnyx_conversation_channel:
                   Telnyx::AI::Assistants::TelnyxConversationChannel::OrSymbol,
                 test_suite: String,
+                idempotency_key: String,
                 request_options: Telnyx::RequestOptions
               }
             )

data/rbi/telnyx/models/ai/assistants/tests/run_trigger_params.rbi

@@ -29,10 +29,17 @@ module Telnyx
             sig { params(destination_version_id: String).void }
             attr_writer :destination_version_id
 
+            sig { returns(T.nilable(String)) }
+            attr_reader :idempotency_key
+
+            sig { params(idempotency_key: String).void }
+            attr_writer :idempotency_key
+
             sig do
               params(
                 test_id: String,
                 destination_version_id: String,
+                idempotency_key: String,
                 request_options: Telnyx::RequestOptions::OrHash
               ).returns(T.attached_class)
             end
@@ -42,6 +49,7 @@ module Telnyx
               # must exist or a 400 error will be returned. If not provided, test will run on
               # main version
               destination_version_id: nil,
+              idempotency_key: nil,
               request_options: {}
             )
             end
@@ -51,6 +59,7 @@ module Telnyx
                 {
                   test_id: String,
                   destination_version_id: String,
+                  idempotency_key: String,
                   request_options: Telnyx::RequestOptions
                 }
               )

data/rbi/telnyx/models/ai/assistants/tests/test_suites/run_trigger_params.rbi

@@ -30,10 +30,17 @@ module Telnyx
               sig { params(destination_version_id: String).void }
               attr_writer :destination_version_id
 
+              sig { returns(T.nilable(String)) }
+              attr_reader :idempotency_key
+
+              sig { params(idempotency_key: String).void }
+              attr_writer :idempotency_key
+
               sig do
                 params(
                   suite_name: String,
                   destination_version_id: String,
+                  idempotency_key: String,
                   request_options: Telnyx::RequestOptions::OrHash
                 ).returns(T.attached_class)
               end
@@ -43,6 +50,7 @@ module Telnyx
                 # provided, the version must exist or a 400 error will be returned. If not
                 # provided, test will run on main version
                 destination_version_id: nil,
+                idempotency_key: nil,
                 request_options: {}
               )
               end
@@ -52,6 +60,7 @@ module Telnyx
                   {
                     suite_name: String,
                     destination_version_id: String,
+                    idempotency_key: String,
                     request_options: Telnyx::RequestOptions
                   }
                 )

data/rbi/telnyx/models/ai/chat_completion_request.rbi

@@ -131,6 +131,28 @@ module Telnyx
         sig { params(presence_penalty: Float).void }
         attr_writer :presence_penalty
 
+        # Controls the reasoning effort for models that support it. When set, the model
+        # spends more or less compute on internal reasoning before generating its
+        # response. Supported values: none, minimal, low, medium, high, xhigh, max. Not
+        # all models support all values; unsupported values are rejected with a 400 error.
+        # When omitted, reasoning models use their default effort level.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::AI::ChatCompletionRequest::ReasoningEffort::OrSymbol
+            )
+          )
+        end
+        attr_reader :reasoning_effort
+
+        sig do
+          params(
+            reasoning_effort:
+              Telnyx::AI::ChatCompletionRequest::ReasoningEffort::OrSymbol
+          ).void
+        end
+        attr_writer :reasoning_effort
+
         # Use this is you want to guarantee a JSON output without defining a schema. For
         # control over the schema, use `guided_json`.
         sig do
@@ -283,6 +305,8 @@ module Telnyx
             model: String,
             n: Float,
             presence_penalty: Float,
+            reasoning_effort:
+              Telnyx::AI::ChatCompletionRequest::ReasoningEffort::OrSymbol,
             response_format:
               Telnyx::AI::ChatCompletionRequest::ResponseFormat::OrHash,
             seed: Integer,
@@ -350,6 +374,12 @@ module Telnyx
           n: nil,
           # Higher values will penalize the model from repeating the same output tokens.
           presence_penalty: nil,
+          # Controls the reasoning effort for models that support it. When set, the model
+          # spends more or less compute on internal reasoning before generating its
+          # response. Supported values: none, minimal, low, medium, high, xhigh, max. Not
+          # all models support all values; unsupported values are rejected with a 400 error.
+          # When omitted, reasoning models use their default effort level.
+          reasoning_effort: nil,
           # Use this is you want to guarantee a JSON output without defining a schema. For
           # control over the schema, use `guided_json`.
           response_format: nil,
@@ -410,6 +440,8 @@ module Telnyx
               model: String,
               n: Float,
               presence_penalty: Float,
+              reasoning_effort:
+                Telnyx::AI::ChatCompletionRequest::ReasoningEffort::OrSymbol,
               response_format:
                 Telnyx::AI::ChatCompletionRequest::ResponseFormat,
               seed: Integer,
@@ -639,6 +671,67 @@ module Telnyx
           end
         end
 
+        # Controls the reasoning effort for models that support it. When set, the model
+        # spends more or less compute on internal reasoning before generating its
+        # response. Supported values: none, minimal, low, medium, high, xhigh, max. Not
+        # all models support all values; unsupported values are rejected with a 400 error.
+        # When omitted, reasoning models use their default effort level.
+        module ReasoningEffort
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::ChatCompletionRequest::ReasoningEffort)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          NONE =
+            T.let(
+              :none,
+              Telnyx::AI::ChatCompletionRequest::ReasoningEffort::TaggedSymbol
+            )
+          MINIMAL =
+            T.let(
+              :minimal,
+              Telnyx::AI::ChatCompletionRequest::ReasoningEffort::TaggedSymbol
+            )
+          LOW =
+            T.let(
+              :low,
+              Telnyx::AI::ChatCompletionRequest::ReasoningEffort::TaggedSymbol
+            )
+          MEDIUM =
+            T.let(
+              :medium,
+              Telnyx::AI::ChatCompletionRequest::ReasoningEffort::TaggedSymbol
+            )
+          HIGH =
+            T.let(
+              :high,
+              Telnyx::AI::ChatCompletionRequest::ReasoningEffort::TaggedSymbol
+            )
+          XHIGH =
+            T.let(
+              :xhigh,
+              Telnyx::AI::ChatCompletionRequest::ReasoningEffort::TaggedSymbol
+            )
+          MAX =
+            T.let(
+              :max,
+              Telnyx::AI::ChatCompletionRequest::ReasoningEffort::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AI::ChatCompletionRequest::ReasoningEffort::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         class ResponseFormat < Telnyx::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/telnyx/models/ai/collections/retrieval_settings.rbi

@@ -15,6 +15,9 @@ module Telnyx
 
           # Retrieval strategy. `vector` runs semantic similarity search; `hybrid` combines
           # vector similarity with keyword matching; `keyword` runs lexical (BM25) matching.
+          # `keyword` is not accepted yet: setting it returns 422
+          # `unsupported_retrieval_type`. A collection set to `hybrid` is accepted here but
+          # cannot be searched until hybrid execution ships.
           sig do
             returns(
               T.nilable(
@@ -50,6 +53,9 @@ module Telnyx
           def self.new(
             # Retrieval strategy. `vector` runs semantic similarity search; `hybrid` combines
             # vector similarity with keyword matching; `keyword` runs lexical (BM25) matching.
+            # `keyword` is not accepted yet: setting it returns 422
+            # `unsupported_retrieval_type`. A collection set to `hybrid` is accepted here but
+            # cannot be searched until hybrid execution ships.
             retrieval_type: nil,
             # Number of top results to retrieve (1–50).
             top_k: nil
@@ -70,6 +76,9 @@ module Telnyx
 
           # Retrieval strategy. `vector` runs semantic similarity search; `hybrid` combines
           # vector similarity with keyword matching; `keyword` runs lexical (BM25) matching.
+          # `keyword` is not accepted yet: setting it returns 422
+          # `unsupported_retrieval_type`. A collection set to `hybrid` is accepted here but
+          # cannot be searched until hybrid execution ships.
           module RetrievalType
             extend Telnyx::Internal::Type::Enum
 
@@ -92,11 +101,6 @@ module Telnyx
                 :hybrid,
                 Telnyx::AI::Collections::RetrievalSettings::RetrievalType::TaggedSymbol
               )
-            KEYWORD =
-              T.let(
-                :keyword,
-                Telnyx::AI::Collections::RetrievalSettings::RetrievalType::TaggedSymbol
-              )
 
             sig do
               override.returns(

data/rbi/telnyx/models/ai/conversation_add_message_params.rbi

@@ -92,6 +92,12 @@ module Telnyx
         end
         attr_writer :tool_choice
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
         sig do
           params(
             conversation_id: String,
@@ -108,6 +114,7 @@ module Telnyx
             tool_calls: T::Array[T::Hash[Symbol, T.anything]],
             tool_choice:
               Telnyx::AI::ConversationAddMessageParams::ToolChoice::Variants,
+            idempotency_key: String,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -122,6 +129,7 @@ module Telnyx
           tool_call_id: nil,
           tool_calls: nil,
           tool_choice: nil,
+          idempotency_key: nil,
           request_options: {}
         )
         end
@@ -143,6 +151,7 @@ module Telnyx
               tool_calls: T::Array[T::Hash[Symbol, T.anything]],
               tool_choice:
                 Telnyx::AI::ConversationAddMessageParams::ToolChoice::Variants,
+              idempotency_key: String,
               request_options: Telnyx::RequestOptions
             }
           )

data/rbi/telnyx/models/ai/conversation_create_params.rbi

@@ -29,10 +29,17 @@ module Telnyx
         sig { params(name: String).void }
         attr_writer :name
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
         sig do
           params(
             metadata: T::Hash[Symbol, String],
             name: String,
+            idempotency_key: String,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -41,6 +48,7 @@ module Telnyx
           # the conversation with AI message responses disabled.
           metadata: nil,
           name: nil,
+          idempotency_key: nil,
           request_options: {}
         )
         end
@@ -50,6 +58,7 @@ module Telnyx
             {
               metadata: T::Hash[Symbol, String],
               name: String,
+              idempotency_key: String,
               request_options: Telnyx::RequestOptions
             }
           )