telnyx 5.169.0 → 5.171.0

data/rbi/telnyx/models/ai/assistant_create_params.rbi

@@ -38,6 +38,19 @@ module Telnyx
         end
         attr_writer :a2a_agents
 
+        # **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+        # catalog supports six avatars and office, studio, or reception backgrounds.
+        sig { returns(T.nilable(Telnyx::AI::AvatarSettingsRequest)) }
+        attr_reader :avatar_settings
+
+        sig do
+          params(
+            avatar_settings:
+              T.nilable(Telnyx::AI::AvatarSettingsRequest::OrHash)
+          ).void
+        end
+        attr_writer :avatar_settings
+
         # Conversation flow as supplied by API clients (create / update).
         #
         # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
@@ -53,6 +66,23 @@ module Telnyx
         end
         attr_writer :conversation_flow
 
+        # Splits the conversation between a frontend model that talks to the caller and a
+        # backend model that does the work. On the GPT-Live route the frontend model
+        # cannot call tools at all — when it needs something done it raises a delegation
+        # and waits. On the chat completion route the frontend keeps a single `delegate`
+        # tool that returns immediately, so the conversation carries on while the backend
+        # works. Either way the backend's answer is spoken as commentary or kept as silent
+        # context, depending on `speak_results`. Beta feature.
+        sig { returns(T.nilable(Telnyx::AI::DelegationSettings)) }
+        attr_reader :delegation_settings
+
+        sig do
+          params(
+            delegation_settings: Telnyx::AI::DelegationSettings::OrHash
+          ).void
+        end
+        attr_writer :delegation_settings
+
         sig { returns(T.nilable(String)) }
         attr_reader :description
 
@@ -333,12 +363,29 @@ module Telnyx
         end
         attr_writer :transcription
 
-        sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
+        sig { returns(T.nilable(Telnyx::AI::InferenceEmbeddingVoiceSettings)) }
         attr_reader :voice_settings
 
-        sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
+        sig do
+          params(
+            voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash
+          ).void
+        end
         attr_writer :voice_settings
 
+        # Streams conversation and telephony events to a WebSocket server you host, and
+        # accepts messages injected back into the conversation. Telnyx opens the
+        # connection as a client, once per conversation. Delivery is best effort
+        # throughout: while the connection is down events are dropped rather than queued,
+        # and no socket failure is ever allowed to affect the call. Beta feature.
+        sig { returns(T.nilable(Telnyx::AI::WebsocketSettings)) }
+        attr_reader :websocket_settings
+
+        sig do
+          params(websocket_settings: Telnyx::AI::WebsocketSettings::OrHash).void
+        end
+        attr_writer :websocket_settings
+
         # Configuration settings for the assistant's web widget.
         sig { returns(T.nilable(Telnyx::AI::WidgetSettings)) }
         attr_reader :widget_settings
@@ -357,7 +404,10 @@ module Telnyx
             instructions: String,
             name: String,
             a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent::OrHash],
+            avatar_settings:
+              T.nilable(Telnyx::AI::AvatarSettingsRequest::OrHash),
             conversation_flow: Telnyx::AI::ConversationFlowReq::OrHash,
+            delegation_settings: Telnyx::AI::DelegationSettings::OrHash,
             description: String,
             dynamic_variables: T::Hash[Symbol, T.anything],
             dynamic_variables_webhook_timeout_ms: Integer,
@@ -401,7 +451,8 @@ module Telnyx
                 )
               ],
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
-            voice_settings: Telnyx::AI::VoiceSettings::OrHash,
+            voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash,
+            websocket_settings: Telnyx::AI::WebsocketSettings::OrHash,
             widget_settings: Telnyx::AI::WidgetSettings::OrHash,
             idempotency_key: String,
             request_options: Telnyx::RequestOptions::OrHash
@@ -421,12 +472,23 @@ module Telnyx
           # fetches combined. An agent whose card cannot be fetched costs the assistant that
           # capability for the conversation; it does not fail the call.
           a2a_agents: nil,
+          # **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+          # catalog supports six avatars and office, studio, or reception backgrounds.
+          avatar_settings: nil,
           # Conversation flow as supplied by API clients (create / update).
           #
           # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
           # unique node/edge IDs, that `start_node_id` references a real node, and that
           # every edge's endpoints reference real nodes.
           conversation_flow: nil,
+          # Splits the conversation between a frontend model that talks to the caller and a
+          # backend model that does the work. On the GPT-Live route the frontend model
+          # cannot call tools at all — when it needs something done it raises a delegation
+          # and waits. On the chat completion route the frontend keeps a single `delegate`
+          # tool that returns immediately, so the conversation carries on while the backend
+          # works. Either way the backend's answer is spoken as commentary or kept as silent
+          # context, depending on `speak_results`. Beta feature.
+          delegation_settings: nil,
           description: nil,
           # Map of dynamic variables and their default values
           dynamic_variables: nil,
@@ -506,6 +568,12 @@ module Telnyx
           tools: nil,
           transcription: nil,
           voice_settings: nil,
+          # Streams conversation and telephony events to a WebSocket server you host, and
+          # accepts messages injected back into the conversation. Telnyx opens the
+          # connection as a client, once per conversation. Delivery is best effort
+          # throughout: while the connection is down events are dropped rather than queued,
+          # and no socket failure is ever allowed to affect the call. Beta feature.
+          websocket_settings: nil,
           # Configuration settings for the assistant's web widget.
           widget_settings: nil,
           idempotency_key: nil,
@@ -519,7 +587,9 @@ module Telnyx
               instructions: String,
               name: String,
               a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent],
+              avatar_settings: T.nilable(Telnyx::AI::AvatarSettingsRequest),
               conversation_flow: Telnyx::AI::ConversationFlowReq,
+              delegation_settings: Telnyx::AI::DelegationSettings,
               description: String,
               dynamic_variables: T::Hash[Symbol, T.anything],
               dynamic_variables_webhook_timeout_ms: Integer,
@@ -563,7 +633,8 @@ module Telnyx
                   )
                 ],
               transcription: Telnyx::AI::TranscriptionSettings,
-              voice_settings: Telnyx::AI::VoiceSettings,
+              voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings,
+              websocket_settings: Telnyx::AI::WebsocketSettings,
               widget_settings: Telnyx::AI::WidgetSettings,
               idempotency_key: String,
               request_options: Telnyx::RequestOptions

data/rbi/telnyx/models/ai/assistant_delete_params.rbi

@@ -15,18 +15,37 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :assistant_id
 
+        # Permanently delete the assistant immediately instead of soft-deleting it to the
+        # Recently Deleted list, where it stays restorable for 30 days.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :hard_delete
+
+        sig { params(hard_delete: T::Boolean).void }
+        attr_writer :hard_delete
+
         sig do
           params(
             assistant_id: String,
+            hard_delete: T::Boolean,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(assistant_id:, request_options: {})
+        def self.new(
+          assistant_id:,
+          # Permanently delete the assistant immediately instead of soft-deleting it to the
+          # Recently Deleted list, where it stays restorable for 30 days.
+          hard_delete: nil,
+          request_options: {}
+        )
         end
 
         sig do
           override.returns(
-            { assistant_id: String, request_options: Telnyx::RequestOptions }
+            {
+              assistant_id: String,
+              hard_delete: T::Boolean,
+              request_options: Telnyx::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/telnyx/models/ai/assistant_restore_params.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class AssistantRestoreParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::AssistantRestoreParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :assistant_id
+
+        sig do
+          params(
+            assistant_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(assistant_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { assistant_id: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -950,6 +950,17 @@ module Telnyx
                 sig { returns(String) }
                 attr_accessor :to
 
+                # DTMF digits to send automatically after the transfer destination answers. Useful
+                # for reaching an extension behind an IVR (e.g. `"200"` to dial extension 200 once
+                # the called party picks up). Allowed characters: `0-9`, `A-D`, `w` (0.5s pause),
+                # `W` (1s pause), `*`, `#`. Maximum 64 characters. When omitted, no automatic DTMF
+                # is sent.
+                sig { returns(T.nilable(String)) }
+                attr_reader :extension
+
+                sig { params(extension: String).void }
+                attr_writer :extension
+
                 # 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`.
@@ -966,26 +977,66 @@ module Telnyx
                 sig { params(name: String).void }
                 attr_writer :name
 
+                # SIP Authentication password used for SIP challenges. Applies when `to` is a SIP
+                # URI.
+                sig { returns(T.nilable(String)) }
+                attr_reader :sip_auth_password
+
+                sig { params(sip_auth_password: String).void }
+                attr_writer :sip_auth_password
+
+                # SIP Authentication username used for SIP challenges. Applies when `to` is a SIP
+                # URI.
+                sig { returns(T.nilable(String)) }
+                attr_reader :sip_auth_username
+
+                sig { params(sip_auth_username: String).void }
+                attr_writer :sip_auth_username
+
                 sig do
-                  params(to: String, message: String, name: String).returns(
-                    T.attached_class
-                  )
+                  params(
+                    to: String,
+                    extension: String,
+                    message: String,
+                    name: String,
+                    sip_auth_password: String,
+                    sip_auth_username: String
+                  ).returns(T.attached_class)
                 end
                 def self.new(
                   # The destination number or SIP URI of the call.
                   to:,
+                  # DTMF digits to send automatically after the transfer destination answers. Useful
+                  # for reaching an extension behind an IVR (e.g. `"200"` to dial extension 200 once
+                  # the called party picks up). Allowed characters: `0-9`, `A-D`, `w` (0.5s pause),
+                  # `W` (1s pause), `*`, `#`. Maximum 64 characters. When omitted, no automatic DTMF
+                  # is sent.
+                  extension: nil,
                   # 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
+                  name: nil,
+                  # SIP Authentication password used for SIP challenges. Applies when `to` is a SIP
+                  # URI.
+                  sip_auth_password: nil,
+                  # SIP Authentication username used for SIP challenges. Applies when `to` is a SIP
+                  # URI.
+                  sip_auth_username: nil
                 )
                 end
 
                 sig do
                   override.returns(
-                    { to: String, message: String, name: String }
+                    {
+                      to: String,
+                      extension: String,
+                      message: String,
+                      name: String,
+                      sip_auth_password: String,
+                      sip_auth_username: String
+                    }
                   )
                 end
                 def to_hash

data/rbi/telnyx/models/ai/assistant_update_params.rbi

@@ -34,6 +34,19 @@ module Telnyx
         end
         attr_writer :a2a_agents
 
+        # **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+        # catalog supports six avatars and office, studio, or reception backgrounds.
+        sig { returns(T.nilable(Telnyx::AI::AvatarSettingsRequest)) }
+        attr_reader :avatar_settings
+
+        sig do
+          params(
+            avatar_settings:
+              T.nilable(Telnyx::AI::AvatarSettingsRequest::OrHash)
+          ).void
+        end
+        attr_writer :avatar_settings
+
         # Conversation flow as supplied by API clients (create / update).
         #
         # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
@@ -49,6 +62,23 @@ module Telnyx
         end
         attr_writer :conversation_flow
 
+        # Splits the conversation between a frontend model that talks to the caller and a
+        # backend model that does the work. On the GPT-Live route the frontend model
+        # cannot call tools at all — when it needs something done it raises a delegation
+        # and waits. On the chat completion route the frontend keeps a single `delegate`
+        # tool that returns immediately, so the conversation carries on while the backend
+        # works. Either way the backend's answer is spoken as commentary or kept as silent
+        # context, depending on `speak_results`. Beta feature.
+        sig { returns(T.nilable(Telnyx::AI::DelegationSettings)) }
+        attr_reader :delegation_settings
+
+        sig do
+          params(
+            delegation_settings: Telnyx::AI::DelegationSettings::OrHash
+          ).void
+        end
+        attr_writer :delegation_settings
+
         sig { returns(T.nilable(String)) }
         attr_reader :description
 
@@ -369,12 +399,29 @@ module Telnyx
         sig { params(version_name: String).void }
         attr_writer :version_name
 
-        sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
+        sig { returns(T.nilable(Telnyx::AI::InferenceEmbeddingVoiceSettings)) }
         attr_reader :voice_settings
 
-        sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
+        sig do
+          params(
+            voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash
+          ).void
+        end
         attr_writer :voice_settings
 
+        # Streams conversation and telephony events to a WebSocket server you host, and
+        # accepts messages injected back into the conversation. Telnyx opens the
+        # connection as a client, once per conversation. Delivery is best effort
+        # throughout: while the connection is down events are dropped rather than queued,
+        # and no socket failure is ever allowed to affect the call. Beta feature.
+        sig { returns(T.nilable(Telnyx::AI::WebsocketSettings)) }
+        attr_reader :websocket_settings
+
+        sig do
+          params(websocket_settings: Telnyx::AI::WebsocketSettings::OrHash).void
+        end
+        attr_writer :websocket_settings
+
         # Configuration settings for the assistant's web widget.
         sig { returns(T.nilable(Telnyx::AI::WidgetSettings)) }
         attr_reader :widget_settings
@@ -386,7 +433,10 @@ module Telnyx
           params(
             assistant_id: String,
             a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent::OrHash],
+            avatar_settings:
+              T.nilable(Telnyx::AI::AvatarSettingsRequest::OrHash),
             conversation_flow: Telnyx::AI::ConversationFlowReq::OrHash,
+            delegation_settings: Telnyx::AI::DelegationSettings::OrHash,
             description: String,
             dynamic_variables: T::Hash[Symbol, T.anything],
             dynamic_variables_webhook_timeout_ms: Integer,
@@ -434,7 +484,8 @@ module Telnyx
               ],
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
             version_name: String,
-            voice_settings: Telnyx::AI::VoiceSettings::OrHash,
+            voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash,
+            websocket_settings: Telnyx::AI::WebsocketSettings::OrHash,
             widget_settings: Telnyx::AI::WidgetSettings::OrHash,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
@@ -451,12 +502,23 @@ module Telnyx
           # capability for the conversation; it does not fail the call. Omit this field to
           # leave the assistant's agents unchanged; send an empty array to remove them all.
           a2a_agents: nil,
+          # **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+          # catalog supports six avatars and office, studio, or reception backgrounds.
+          avatar_settings: nil,
           # Conversation flow as supplied by API clients (create / update).
           #
           # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
           # unique node/edge IDs, that `start_node_id` references a real node, and that
           # every edge's endpoints reference real nodes.
           conversation_flow: nil,
+          # Splits the conversation between a frontend model that talks to the caller and a
+          # backend model that does the work. On the GPT-Live route the frontend model
+          # cannot call tools at all — when it needs something done it raises a delegation
+          # and waits. On the chat completion route the frontend keeps a single `delegate`
+          # tool that returns immediately, so the conversation carries on while the backend
+          # works. Either way the backend's answer is spoken as commentary or kept as silent
+          # context, depending on `speak_results`. Beta feature.
+          delegation_settings: nil,
           description: nil,
           # Map of dynamic variables and their default values
           dynamic_variables: nil,
@@ -556,6 +618,12 @@ module Telnyx
           # Human-readable name for the assistant version.
           version_name: nil,
           voice_settings: nil,
+          # Streams conversation and telephony events to a WebSocket server you host, and
+          # accepts messages injected back into the conversation. Telnyx opens the
+          # connection as a client, once per conversation. Delivery is best effort
+          # throughout: while the connection is down events are dropped rather than queued,
+          # and no socket failure is ever allowed to affect the call. Beta feature.
+          websocket_settings: nil,
           # Configuration settings for the assistant's web widget.
           widget_settings: nil,
           request_options: {}
@@ -567,7 +635,9 @@ module Telnyx
             {
               assistant_id: String,
               a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent],
+              avatar_settings: T.nilable(Telnyx::AI::AvatarSettingsRequest),
               conversation_flow: Telnyx::AI::ConversationFlowReq,
+              delegation_settings: Telnyx::AI::DelegationSettings,
               description: String,
               dynamic_variables: T::Hash[Symbol, T.anything],
               dynamic_variables_webhook_timeout_ms: Integer,
@@ -615,7 +685,8 @@ module Telnyx
                 ],
               transcription: Telnyx::AI::TranscriptionSettings,
               version_name: String,
-              voice_settings: Telnyx::AI::VoiceSettings,
+              voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings,
+              websocket_settings: Telnyx::AI::WebsocketSettings,
               widget_settings: Telnyx::AI::WidgetSettings,
               request_options: Telnyx::RequestOptions
             }

data/rbi/telnyx/models/ai/assistant_whatsapp_params.rbi

@@ -0,0 +1,139 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class AssistantWhatsappParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AI::AssistantWhatsappParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :assistant_id
+
+        # Instruction for the assistant, including the values for the template variables,
+        # e.g. `Send the login verification code 482913 to the customer.`
+        sig { returns(String) }
+        attr_accessor :content
+
+        # WhatsApp number on your account to send from, in E.164 format. Its messaging
+        # profile must have this assistant configured.
+        sig { returns(String) }
+        attr_accessor :from
+
+        # Customer to message, as an E.164 phone number or a WhatsApp business-scoped user
+        # ID (BSUID).
+        sig { returns(String) }
+        attr_accessor :to
+
+        # Metadata stored on the conversation. Keys starting with `telnyx_` and the
+        # `assistant_id` key are reserved.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Telnyx::AI::AssistantWhatsappParams::ConversationMetadata::Variants
+              ]
+            )
+          )
+        end
+        attr_reader :conversation_metadata
+
+        sig do
+          params(
+            conversation_metadata:
+              T::Hash[
+                Symbol,
+                Telnyx::AI::AssistantWhatsappParams::ConversationMetadata::Variants
+              ]
+          ).void
+        end
+        attr_writer :conversation_metadata
+
+        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,
+            content: String,
+            from: String,
+            to: String,
+            conversation_metadata:
+              T::Hash[
+                Symbol,
+                Telnyx::AI::AssistantWhatsappParams::ConversationMetadata::Variants
+              ],
+            idempotency_key: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          assistant_id:,
+          # Instruction for the assistant, including the values for the template variables,
+          # e.g. `Send the login verification code 482913 to the customer.`
+          content:,
+          # WhatsApp number on your account to send from, in E.164 format. Its messaging
+          # profile must have this assistant configured.
+          from:,
+          # Customer to message, as an E.164 phone number or a WhatsApp business-scoped user
+          # ID (BSUID).
+          to:,
+          # Metadata stored on the conversation. Keys starting with `telnyx_` and the
+          # `assistant_id` key are reserved.
+          conversation_metadata: nil,
+          idempotency_key: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              assistant_id: String,
+              content: String,
+              from: String,
+              to: String,
+              conversation_metadata:
+                T::Hash[
+                  Symbol,
+                  Telnyx::AI::AssistantWhatsappParams::ConversationMetadata::Variants
+                ],
+              idempotency_key: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module ConversationMetadata
+          extend Telnyx::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, Integer, T::Boolean) }
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AI::AssistantWhatsappParams::ConversationMetadata::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/assistant_whatsapp_response.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class AssistantWhatsappResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::AI::AssistantWhatsappResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # ID of the conversation created for this WhatsApp chat.
+        sig { returns(String) }
+        attr_accessor :conversation_id
+
+        # ID of the WhatsApp template message that was sent.
+        sig { returns(String) }
+        attr_accessor :message_id
+
+        sig do
+          params(conversation_id: String, message_id: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # ID of the conversation created for this WhatsApp chat.
+          conversation_id:,
+          # ID of the WhatsApp template message that was sent.
+          message_id:
+        )
+        end
+
+        sig do
+          override.returns({ conversation_id: String, message_id: String })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end