telnyx 5.0.0 → 5.1.0

data/lib/telnyx/models/ai/assistant_tool.rb

@@ -11,7 +11,7 @@ module Telnyx
 
         discriminator :type
 
-        variant :webhook, -> { Telnyx::AI::WebhookTool }
+        variant :webhook, -> { Telnyx::AI::AssistantTool::Webhook }
 
         variant :retrieval, -> { Telnyx::AI::RetrievalTool }
 
@@ -20,7 +20,7 @@ module Telnyx
 
         variant :hangup, -> { Telnyx::AI::HangupTool }
 
-        variant :transfer, -> { Telnyx::AI::TransferTool }
+        variant :transfer, -> { Telnyx::AI::AssistantTool::Transfer }
 
         variant :refer, -> { Telnyx::AI::AssistantTool::Refer }
 
@@ -29,6 +29,300 @@ module Telnyx
         # The send_message tool allows the assistant to send SMS or MMS messages to the end user. The 'to' and 'from' addresses are automatically determined from the conversation context, and the message text is generated by the assistant.
         variant :send_message, -> { Telnyx::AI::AssistantTool::SendMessage }
 
+        class Webhook < Telnyx::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :webhook]
+          required :type, const: :webhook
+
+          # @!attribute webhook
+          #
+          #   @return [Telnyx::Models::AI::AssistantTool::Webhook::Webhook]
+          required :webhook, -> { Telnyx::AI::AssistantTool::Webhook::Webhook }
+
+          # @!method initialize(webhook:, type: :webhook)
+          #   @param webhook [Telnyx::Models::AI::AssistantTool::Webhook::Webhook]
+          #   @param type [Symbol, :webhook]
+
+          # @see Telnyx::Models::AI::AssistantTool::Webhook#webhook
+          class Webhook < Telnyx::Internal::Type::BaseModel
+            # @!attribute description
+            #   The description of the tool.
+            #
+            #   @return [String]
+            required :description, String
+
+            # @!attribute name
+            #   The name of the tool.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute url
+            #   The URL of the external tool to be called. This URL is going to be used by the
+            #   assistant. The URL can be templated like: `https://example.com/api/v1/{id}`,
+            #   where `{id}` is a placeholder for a value that will be provided by the assistant
+            #   if `path_parameters` are provided with the `id` attribute.
+            #
+            #   @return [String]
+            required :url, String
+
+            # @!attribute async
+            #   If async, the assistant will move forward without waiting for your server to
+            #   respond.
+            #
+            #   @return [Boolean, nil]
+            optional :async, Telnyx::Internal::Type::Boolean
+
+            # @!attribute body_parameters
+            #   The body parameters the webhook tool accepts, described as a JSON Schema object.
+            #   These parameters will be passed to the webhook as the body of the request. See
+            #   the [JSON Schema reference](https://json-schema.org/understanding-json-schema)
+            #   for documentation about the format
+            #
+            #   @return [Telnyx::Models::AI::AssistantTool::Webhook::Webhook::BodyParameters, nil]
+            optional :body_parameters, -> { Telnyx::AI::AssistantTool::Webhook::Webhook::BodyParameters }
+
+            # @!attribute headers
+            #   The headers to be sent to the external tool.
+            #
+            #   @return [Array<Telnyx::Models::AI::AssistantTool::Webhook::Webhook::Header>, nil]
+            optional :headers,
+                     -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantTool::Webhook::Webhook::Header] }
+
+            # @!attribute method_
+            #   The HTTP method to be used when calling the external tool.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::AssistantTool::Webhook::Webhook::Method, nil]
+            optional :method_,
+                     enum: -> {
+                       Telnyx::AI::AssistantTool::Webhook::Webhook::Method
+                     },
+                     api_name: :method
+
+            # @!attribute path_parameters
+            #   The path parameters the webhook tool accepts, described as a JSON Schema object.
+            #   These parameters will be passed to the webhook as the path of the request if the
+            #   URL contains a placeholder for a value. See the
+            #   [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
+            #   documentation about the format
+            #
+            #   @return [Telnyx::Models::AI::AssistantTool::Webhook::Webhook::PathParameters, nil]
+            optional :path_parameters, -> { Telnyx::AI::AssistantTool::Webhook::Webhook::PathParameters }
+
+            # @!attribute query_parameters
+            #   The query parameters the webhook tool accepts, described as a JSON Schema
+            #   object. These parameters will be passed to the webhook as the query of the
+            #   request. See the
+            #   [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
+            #   documentation about the format
+            #
+            #   @return [Telnyx::Models::AI::AssistantTool::Webhook::Webhook::QueryParameters, nil]
+            optional :query_parameters, -> { Telnyx::AI::AssistantTool::Webhook::Webhook::QueryParameters }
+
+            # @!attribute timeout_ms
+            #   The maximum number of milliseconds to wait for the webhook to respond. Only
+            #   applicable when async is false.
+            #
+            #   @return [Integer, nil]
+            optional :timeout_ms, Integer
+
+            # @!method initialize(description:, name:, url:, async: nil, body_parameters: nil, headers: nil, method_: nil, path_parameters: nil, query_parameters: nil, timeout_ms: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::AssistantTool::Webhook::Webhook} for more details.
+            #
+            #   @param description [String] The description of the tool.
+            #
+            #   @param name [String] The name of the tool.
+            #
+            #   @param url [String] The URL of the external tool to be called. This URL is going to be used by the a
+            #
+            #   @param async [Boolean] If async, the assistant will move forward without waiting for your server to res
+            #
+            #   @param body_parameters [Telnyx::Models::AI::AssistantTool::Webhook::Webhook::BodyParameters] The body parameters the webhook tool accepts, described as a JSON Schema object.
+            #
+            #   @param headers [Array<Telnyx::Models::AI::AssistantTool::Webhook::Webhook::Header>] The headers to be sent to the external tool.
+            #
+            #   @param method_ [Symbol, Telnyx::Models::AI::AssistantTool::Webhook::Webhook::Method] The HTTP method to be used when calling the external tool.
+            #
+            #   @param path_parameters [Telnyx::Models::AI::AssistantTool::Webhook::Webhook::PathParameters] The path parameters the webhook tool accepts, described as a JSON Schema object.
+            #
+            #   @param query_parameters [Telnyx::Models::AI::AssistantTool::Webhook::Webhook::QueryParameters] The query parameters the webhook tool accepts, described as a JSON Schema object
+            #
+            #   @param timeout_ms [Integer] The maximum number of milliseconds to wait for the webhook to respond. Only appl
+
+            # @see Telnyx::Models::AI::AssistantTool::Webhook::Webhook#body_parameters
+            class BodyParameters < Telnyx::Internal::Type::BaseModel
+              # @!attribute properties
+              #   The properties of the body parameters.
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              optional :properties, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+              # @!attribute required
+              #   The required properties of the body parameters.
+              #
+              #   @return [Array<String>, nil]
+              optional :required, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!attribute type
+              #
+              #   @return [Symbol, Telnyx::Models::AI::AssistantTool::Webhook::Webhook::BodyParameters::Type, nil]
+              optional :type, enum: -> { Telnyx::AI::AssistantTool::Webhook::Webhook::BodyParameters::Type }
+
+              # @!method initialize(properties: nil, required: nil, type: nil)
+              #   The body parameters the webhook tool accepts, described as a JSON Schema object.
+              #   These parameters will be passed to the webhook as the body of the request. See
+              #   the [JSON Schema reference](https://json-schema.org/understanding-json-schema)
+              #   for documentation about the format
+              #
+              #   @param properties [Hash{Symbol=>Object}] The properties of the body parameters.
+              #
+              #   @param required [Array<String>] The required properties of the body parameters.
+              #
+              #   @param type [Symbol, Telnyx::Models::AI::AssistantTool::Webhook::Webhook::BodyParameters::Type]
+
+              # @see Telnyx::Models::AI::AssistantTool::Webhook::Webhook::BodyParameters#type
+              module Type
+                extend Telnyx::Internal::Type::Enum
+
+                OBJECT = :object
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            class Header < Telnyx::Internal::Type::BaseModel
+              # @!attribute name
+              #
+              #   @return [String, nil]
+              optional :name, String
+
+              # @!attribute value
+              #   The value of the header. Note that we support mustache templating for the value.
+              #   For example you can use
+              #   `Bearer {{#integration_secret}}test-secret{{/integration_secret}}` to pass the
+              #   value of the integration secret as the bearer token.
+              #   [Telnyx signature headers](https://developers.telnyx.com/docs/voice/programmable-voice/voice-api-webhooks)
+              #   will be automatically added to the request.
+              #
+              #   @return [String, nil]
+              optional :value, String
+
+              # @!method initialize(name: nil, value: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::AssistantTool::Webhook::Webhook::Header} for more details.
+              #
+              #   @param name [String]
+              #
+              #   @param value [String] The value of the header. Note that we support mustache templating for the value.
+            end
+
+            # The HTTP method to be used when calling the external tool.
+            #
+            # @see Telnyx::Models::AI::AssistantTool::Webhook::Webhook#method_
+            module Method
+              extend Telnyx::Internal::Type::Enum
+
+              GET = :GET
+              POST = :POST
+              PUT = :PUT
+              DELETE = :DELETE
+              PATCH = :PATCH
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see Telnyx::Models::AI::AssistantTool::Webhook::Webhook#path_parameters
+            class PathParameters < Telnyx::Internal::Type::BaseModel
+              # @!attribute properties
+              #   The properties of the path parameters.
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              optional :properties, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+              # @!attribute required
+              #   The required properties of the path parameters.
+              #
+              #   @return [Array<String>, nil]
+              optional :required, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!attribute type
+              #
+              #   @return [Symbol, Telnyx::Models::AI::AssistantTool::Webhook::Webhook::PathParameters::Type, nil]
+              optional :type, enum: -> { Telnyx::AI::AssistantTool::Webhook::Webhook::PathParameters::Type }
+
+              # @!method initialize(properties: nil, required: nil, type: nil)
+              #   The path parameters the webhook tool accepts, described as a JSON Schema object.
+              #   These parameters will be passed to the webhook as the path of the request if the
+              #   URL contains a placeholder for a value. See the
+              #   [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
+              #   documentation about the format
+              #
+              #   @param properties [Hash{Symbol=>Object}] The properties of the path parameters.
+              #
+              #   @param required [Array<String>] The required properties of the path parameters.
+              #
+              #   @param type [Symbol, Telnyx::Models::AI::AssistantTool::Webhook::Webhook::PathParameters::Type]
+
+              # @see Telnyx::Models::AI::AssistantTool::Webhook::Webhook::PathParameters#type
+              module Type
+                extend Telnyx::Internal::Type::Enum
+
+                OBJECT = :object
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            # @see Telnyx::Models::AI::AssistantTool::Webhook::Webhook#query_parameters
+            class QueryParameters < Telnyx::Internal::Type::BaseModel
+              # @!attribute properties
+              #   The properties of the query parameters.
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              optional :properties, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+              # @!attribute required
+              #   The required properties of the query parameters.
+              #
+              #   @return [Array<String>, nil]
+              optional :required, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!attribute type
+              #
+              #   @return [Symbol, Telnyx::Models::AI::AssistantTool::Webhook::Webhook::QueryParameters::Type, nil]
+              optional :type, enum: -> { Telnyx::AI::AssistantTool::Webhook::Webhook::QueryParameters::Type }
+
+              # @!method initialize(properties: nil, required: nil, type: nil)
+              #   The query parameters the webhook tool accepts, described as a JSON Schema
+              #   object. These parameters will be passed to the webhook as the query of the
+              #   request. See the
+              #   [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
+              #   documentation about the format
+              #
+              #   @param properties [Hash{Symbol=>Object}] The properties of the query parameters.
+              #
+              #   @param required [Array<String>] The required properties of the query parameters.
+              #
+              #   @param type [Symbol, Telnyx::Models::AI::AssistantTool::Webhook::Webhook::QueryParameters::Type]
+
+              # @see Telnyx::Models::AI::AssistantTool::Webhook::Webhook::QueryParameters#type
+              module Type
+                extend Telnyx::Internal::Type::Enum
+
+                OBJECT = :object
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
+
         class Handoff < Telnyx::Internal::Type::BaseModel
           # @!attribute handoff
           #
@@ -111,6 +405,109 @@ module Telnyx
           end
         end
 
+        class Transfer < Telnyx::Internal::Type::BaseModel
+          # @!attribute transfer
+          #
+          #   @return [Telnyx::Models::AI::AssistantTool::Transfer::Transfer]
+          required :transfer, -> { Telnyx::AI::AssistantTool::Transfer::Transfer }
+
+          # @!attribute type
+          #
+          #   @return [Symbol, :transfer]
+          required :type, const: :transfer
+
+          # @!method initialize(transfer:, type: :transfer)
+          #   @param transfer [Telnyx::Models::AI::AssistantTool::Transfer::Transfer]
+          #   @param type [Symbol, :transfer]
+
+          # @see Telnyx::Models::AI::AssistantTool::Transfer#transfer
+          class Transfer < Telnyx::Internal::Type::BaseModel
+            # @!attribute from
+            #   Number or SIP URI placing the call.
+            #
+            #   @return [String]
+            required :from, String
+
+            # @!attribute targets
+            #   The different possible targets of the transfer. The assistant will be able to
+            #   choose one of the targets to transfer the call to.
+            #
+            #   @return [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Target>]
+            required :targets,
+                     -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantTool::Transfer::Transfer::Target] }
+
+            # @!attribute custom_headers
+            #   Custom headers to be added to the SIP INVITE for the transfer command.
+            #
+            #   @return [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::CustomHeader>, nil]
+            optional :custom_headers,
+                     -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantTool::Transfer::Transfer::CustomHeader] }
+
+            # @!attribute warm_transfer_instructions
+            #   Natural language instructions for your agent for how to provide context for the
+            #   transfer recipient.
+            #
+            #   @return [String, nil]
+            optional :warm_transfer_instructions, String
+
+            # @!method initialize(from:, targets:, custom_headers: nil, warm_transfer_instructions: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::AssistantTool::Transfer::Transfer} for more details.
+            #
+            #   @param from [String] Number or SIP URI placing the call.
+            #
+            #   @param targets [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Target>] The different possible targets of the transfer. The assistant will be able to ch
+            #
+            #   @param custom_headers [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::CustomHeader>] Custom headers to be added to the SIP INVITE for the transfer command.
+            #
+            #   @param warm_transfer_instructions [String] Natural language instructions for your agent for how to provide context for the
+
+            class Target < Telnyx::Internal::Type::BaseModel
+              # @!attribute name
+              #   The name of the target.
+              #
+              #   @return [String, nil]
+              optional :name, String
+
+              # @!attribute to
+              #   The destination number or SIP URI of the call.
+              #
+              #   @return [String, nil]
+              optional :to, String
+
+              # @!method initialize(name: nil, to: nil)
+              #   @param name [String] The name of the target.
+              #
+              #   @param to [String] The destination number or SIP URI of the call.
+            end
+
+            class CustomHeader < Telnyx::Internal::Type::BaseModel
+              # @!attribute name
+              #
+              #   @return [String, nil]
+              optional :name, String
+
+              # @!attribute value
+              #   The value of the header. Note that we support mustache templating for the value.
+              #   For example you can use
+              #   `{{#integration_secret}}test-secret{{/integration_secret}}` to pass the value of
+              #   the integration secret.
+              #
+              #   @return [String, nil]
+              optional :value, String
+
+              # @!method initialize(name: nil, value: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::AssistantTool::Transfer::Transfer::CustomHeader} for more
+              #   details.
+              #
+              #   @param name [String]
+              #
+              #   @param value [String] The value of the header. Note that we support mustache templating for the value.
+            end
+          end
+        end
+
         class Refer < Telnyx::Internal::Type::BaseModel
           # @!attribute refer
           #
@@ -294,7 +691,7 @@ module Telnyx
         end
 
         # @!method self.variants
-        #   @return [Array(Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage)]
+        #   @return [Array(Telnyx::Models::AI::AssistantTool::Webhook, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage)]
       end
     end
   end

data/lib/telnyx/models/ai/assistant_update_params.rb

@@ -36,7 +36,10 @@ module Telnyx
         # @!attribute greeting
         #   Text that the assistant will use to start the conversation. This may be
         #   templated with
-        #   [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
+        #   [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
+        #   Use an empty string to have the assistant wait for the user to speak first. Use
+        #   the special value `<assistant-speaks-first-with-model-generated-message>` to
+        #   have the assistant generate the greeting based on the system instructions.
         #
         #   @return [String, nil]
         optional :greeting, String
@@ -56,7 +59,7 @@ module Telnyx
         # @!attribute llm_api_key_ref
         #   This is only needed when using third-party inference providers. The `identifier`
         #   for an integration secret
-        #   [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+        #   [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
         #   that refers to your LLM provider's API key. Warning: Free plans are unlikely to
         #   work with this integration.
         #
@@ -70,7 +73,7 @@ module Telnyx
 
         # @!attribute model
         #   ID of the model to use. You can use the
-        #   [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
+        #   [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
         #   to see all of your available models,
         #
         #   @return [String, nil]
@@ -102,7 +105,7 @@ module Telnyx
         #   The tools that the assistant can use. These may be templated with
         #   [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
         #
-        #   @return [Array<Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>, nil]
+        #   @return [Array<Telnyx::Models::AI::AssistantTool::Webhook, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>, nil]
         optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
 
         # @!attribute transcription
@@ -115,7 +118,13 @@ module Telnyx
         #   @return [Telnyx::Models::AI::VoiceSettings, nil]
         optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
 
-        # @!method initialize(description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, privacy_settings: nil, promote_to_main: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, request_options: {})
+        # @!attribute widget_settings
+        #   Configuration settings for the assistant's web widget.
+        #
+        #   @return [Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings, nil]
+        optional :widget_settings, -> { Telnyx::AI::AssistantUpdateParams::WidgetSettings }
+
+        # @!method initialize(description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, privacy_settings: nil, promote_to_main: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::AssistantUpdateParams} for more details.
         #
@@ -147,13 +156,185 @@ module Telnyx
         #
         #   @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
         #
-        #   @param tools [Array<Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>] The tools that the assistant can use. These may be templated with [dynamic varia
+        #   @param tools [Array<Telnyx::Models::AI::AssistantTool::Webhook, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>] The tools that the assistant can use. These may be templated with [dynamic varia
         #
         #   @param transcription [Telnyx::Models::AI::TranscriptionSettings]
         #
         #   @param voice_settings [Telnyx::Models::AI::VoiceSettings]
         #
+        #   @param widget_settings [Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings] Configuration settings for the assistant's web widget.
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        class WidgetSettings < Telnyx::Internal::Type::BaseModel
+          # @!attribute agent_thinking_text
+          #   Text displayed while the agent is processing.
+          #
+          #   @return [String, nil]
+          optional :agent_thinking_text, String
+
+          # @!attribute audio_visualizer_config
+          #
+          #   @return [Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig, nil]
+          optional :audio_visualizer_config,
+                   -> { Telnyx::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig }
+
+          # @!attribute default_state
+          #   The default state of the widget.
+          #
+          #   @return [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::DefaultState, nil]
+          optional :default_state, enum: -> { Telnyx::AI::AssistantUpdateParams::WidgetSettings::DefaultState }
+
+          # @!attribute give_feedback_url
+          #   URL for users to give feedback.
+          #
+          #   @return [String, nil]
+          optional :give_feedback_url, String, nil?: true
+
+          # @!attribute logo_icon_url
+          #   URL to a custom logo icon for the widget.
+          #
+          #   @return [String, nil]
+          optional :logo_icon_url, String, nil?: true
+
+          # @!attribute position
+          #   The positioning style for the widget.
+          #
+          #   @return [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::Position, nil]
+          optional :position, enum: -> { Telnyx::AI::AssistantUpdateParams::WidgetSettings::Position }
+
+          # @!attribute report_issue_url
+          #   URL for users to report issues.
+          #
+          #   @return [String, nil]
+          optional :report_issue_url, String, nil?: true
+
+          # @!attribute speak_to_interrupt_text
+          #   Text prompting users to speak to interrupt.
+          #
+          #   @return [String, nil]
+          optional :speak_to_interrupt_text, String
+
+          # @!attribute start_call_text
+          #   Custom text displayed on the start call button.
+          #
+          #   @return [String, nil]
+          optional :start_call_text, String
+
+          # @!attribute theme
+          #   The visual theme for the widget.
+          #
+          #   @return [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::Theme, nil]
+          optional :theme, enum: -> { Telnyx::AI::AssistantUpdateParams::WidgetSettings::Theme }
+
+          # @!attribute view_history_url
+          #   URL to view conversation history.
+          #
+          #   @return [String, nil]
+          optional :view_history_url, String, nil?: true
+
+          # @!method initialize(agent_thinking_text: nil, audio_visualizer_config: nil, default_state: nil, give_feedback_url: nil, logo_icon_url: nil, position: nil, report_issue_url: nil, speak_to_interrupt_text: nil, start_call_text: nil, theme: nil, view_history_url: nil)
+          #   Configuration settings for the assistant's web widget.
+          #
+          #   @param agent_thinking_text [String] Text displayed while the agent is processing.
+          #
+          #   @param audio_visualizer_config [Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig]
+          #
+          #   @param default_state [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::DefaultState] The default state of the widget.
+          #
+          #   @param give_feedback_url [String, nil] URL for users to give feedback.
+          #
+          #   @param logo_icon_url [String, nil] URL to a custom logo icon for the widget.
+          #
+          #   @param position [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::Position] The positioning style for the widget.
+          #
+          #   @param report_issue_url [String, nil] URL for users to report issues.
+          #
+          #   @param speak_to_interrupt_text [String] Text prompting users to speak to interrupt.
+          #
+          #   @param start_call_text [String] Custom text displayed on the start call button.
+          #
+          #   @param theme [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::Theme] The visual theme for the widget.
+          #
+          #   @param view_history_url [String, nil] URL to view conversation history.
+
+          # @see Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings#audio_visualizer_config
+          class AudioVisualizerConfig < Telnyx::Internal::Type::BaseModel
+            # @!attribute color
+            #   The color theme for the audio visualizer.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig::Color, nil]
+            optional :color,
+                     enum: -> { Telnyx::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig::Color }
+
+            # @!attribute preset
+            #   The preset style for the audio visualizer.
+            #
+            #   @return [String, nil]
+            optional :preset, String
+
+            # @!method initialize(color: nil, preset: nil)
+            #   @param color [Symbol, Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig::Color] The color theme for the audio visualizer.
+            #
+            #   @param preset [String] The preset style for the audio visualizer.
+
+            # The color theme for the audio visualizer.
+            #
+            # @see Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings::AudioVisualizerConfig#color
+            module Color
+              extend Telnyx::Internal::Type::Enum
+
+              VERDANT = :verdant
+              TWILIGHT = :twilight
+              BLOOM = :bloom
+              MYSTIC = :mystic
+              FLARE = :flare
+              GLACIER = :glacier
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # The default state of the widget.
+          #
+          # @see Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings#default_state
+          module DefaultState
+            extend Telnyx::Internal::Type::Enum
+
+            EXPANDED = :expanded
+            COLLAPSED = :collapsed
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The positioning style for the widget.
+          #
+          # @see Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings#position
+          module Position
+            extend Telnyx::Internal::Type::Enum
+
+            FIXED = :fixed
+            STATIC = :static
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The visual theme for the widget.
+          #
+          # @see Telnyx::Models::AI::AssistantUpdateParams::WidgetSettings#theme
+          module Theme
+            extend Telnyx::Internal::Type::Enum
+
+            LIGHT = :light
+            DARK = :dark
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
       end
     end
   end