telnyx 5.0.0 → 5.2.0

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

@@ -140,7 +140,7 @@ module Telnyx
         #   The `function` tool type follows the same schema as the
         #   [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat).
         #   The `retrieval` tool type is unique to Telnyx. You may pass a list of
-        #   [embedded storage buckets](https://developers.telnyx.com/api/inference/inference-embedding/post-embedding)
+        #   [embedded storage buckets](https://developers.telnyx.com/api-reference/embeddings/embed-documents)
         #   for retrieval-augmented generation.
         #
         #   @return [Array<Telnyx::Models::AI::ChatCreateCompletionParams::Tool::Function, Telnyx::Models::AI::ChatCreateCompletionParams::Tool::Retrieval>, nil]
@@ -389,8 +389,8 @@ module Telnyx
           class Retrieval < Telnyx::Internal::Type::BaseModel
             # @!attribute retrieval
             #
-            #   @return [Telnyx::Models::AI::InferenceEmbeddingBucketIDs]
-            required :retrieval, -> { Telnyx::AI::InferenceEmbeddingBucketIDs }
+            #   @return [Telnyx::Models::AI::BucketIDs]
+            required :retrieval, -> { Telnyx::AI::BucketIDs }
 
             # @!attribute type
             #
@@ -398,7 +398,7 @@ module Telnyx
             required :type, const: :retrieval
 
             # @!method initialize(retrieval:, type: :retrieval)
-            #   @param retrieval [Telnyx::Models::AI::InferenceEmbeddingBucketIDs]
+            #   @param retrieval [Telnyx::Models::AI::BucketIDs]
             #   @param type [Symbol, :retrieval]
           end
 

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

@@ -24,7 +24,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]
@@ -63,7 +63,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
@@ -81,7 +84,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.
         #
@@ -107,7 +110,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
@@ -120,7 +123,13 @@ module Telnyx
         #   @return [Telnyx::Models::AI::VoiceSettings, nil]
         optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
 
-        # @!method initialize(id:, created_at:, instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, import_metadata: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil)
+        # @!attribute widget_settings
+        #   Configuration settings for the assistant's web widget.
+        #
+        #   @return [Telnyx::Models::AI::WidgetSettings, nil]
+        optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
+
+        # @!method initialize(id:, created_at:, instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, import_metadata: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::InferenceEmbedding} for more details.
         #
@@ -156,11 +165,13 @@ 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::WidgetSettings] Configuration settings for the assistant's web widget.
       end
     end
   end

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

@@ -4,6 +4,13 @@ module Telnyx
   module Models
     module AI
       class MessagingSettings < Telnyx::Internal::Type::BaseModel
+        # @!attribute conversation_inactivity_minutes
+        #   If more than this many minutes have passed since the last message, the assistant
+        #   will start a new conversation instead of continuing the existing one.
+        #
+        #   @return [Integer, nil]
+        optional :conversation_inactivity_minutes, Integer
+
         # @!attribute default_messaging_profile_id
         #   Default Messaging Profile used for messaging exchanges with your assistant. This
         #   will be created automatically on assistant creation.
@@ -18,10 +25,12 @@ module Telnyx
         #   @return [String, nil]
         optional :delivery_status_webhook_url, String
 
-        # @!method initialize(default_messaging_profile_id: nil, delivery_status_webhook_url: nil)
+        # @!method initialize(conversation_inactivity_minutes: nil, default_messaging_profile_id: nil, delivery_status_webhook_url: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::MessagingSettings} for more details.
         #
+        #   @param conversation_inactivity_minutes [Integer] If more than this many minutes have passed since the last message, the assistant
+        #
         #   @param default_messaging_profile_id [String] Default Messaging Profile used for messaging exchanges with your assistant. This
         #
         #   @param delivery_status_webhook_url [String] The URL where webhooks related to delivery statused for assistant messages will

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

@@ -6,8 +6,8 @@ module Telnyx
       class RetrievalTool < Telnyx::Internal::Type::BaseModel
         # @!attribute retrieval
         #
-        #   @return [Telnyx::Models::AI::InferenceEmbeddingBucketIDs]
-        required :retrieval, -> { Telnyx::AI::InferenceEmbeddingBucketIDs }
+        #   @return [Telnyx::Models::AI::BucketIDs]
+        required :retrieval, -> { Telnyx::AI::BucketIDs }
 
         # @!attribute type
         #
@@ -15,7 +15,7 @@ module Telnyx
         required :type, enum: -> { Telnyx::AI::RetrievalTool::Type }
 
         # @!method initialize(retrieval:, type:)
-        #   @param retrieval [Telnyx::Models::AI::InferenceEmbeddingBucketIDs]
+        #   @param retrieval [Telnyx::Models::AI::BucketIDs]
         #   @param type [Symbol, Telnyx::Models::AI::RetrievalTool::Type]
 
         # @see Telnyx::Models::AI::RetrievalTool#type

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

@@ -42,7 +42,27 @@ module Telnyx
         #   @return [Integer, nil]
         optional :time_limit_secs, Integer
 
-        # @!method initialize(default_texml_app_id: nil, noise_suppression: nil, noise_suppression_config: nil, supports_unauthenticated_web_calls: nil, time_limit_secs: nil)
+        # @!attribute user_idle_timeout_secs
+        #   Maximum duration in seconds of end user silence on the call. When this limit is
+        #   reached the assistant will be stopped. This limit does not apply to portions of
+        #   a call without an active assistant (for instance, a call transferred to a human
+        #   representative).
+        #
+        #   @return [Integer, nil]
+        optional :user_idle_timeout_secs, Integer
+
+        # @!attribute voicemail_detection
+        #   Configuration for voicemail detection (AMD - Answering Machine Detection) on
+        #   outgoing calls. These settings only apply if AMD is enabled on the Dial command.
+        #   See
+        #   [TeXML Dial documentation](https://developers.telnyx.com/api-reference/texml-rest-commands/initiate-an-outbound-call)
+        #   for enabling AMD. Recommended settings: MachineDetection=Enable, AsyncAmd=true,
+        #   DetectionMode=Premium.
+        #
+        #   @return [Telnyx::Models::AI::TelephonySettings::VoicemailDetection, nil]
+        optional :voicemail_detection, -> { Telnyx::AI::TelephonySettings::VoicemailDetection }
+
+        # @!method initialize(default_texml_app_id: nil, noise_suppression: nil, noise_suppression_config: nil, supports_unauthenticated_web_calls: nil, time_limit_secs: nil, user_idle_timeout_secs: nil, voicemail_detection: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::TelephonySettings} for more details.
         #
@@ -55,6 +75,10 @@ module Telnyx
         #   @param supports_unauthenticated_web_calls [Boolean] When enabled, allows users to interact with your AI assistant directly from your
         #
         #   @param time_limit_secs [Integer] Maximum duration in seconds for the AI assistant to participate on the call. Whe
+        #
+        #   @param user_idle_timeout_secs [Integer] Maximum duration in seconds of end user silence on the call. When this limit is
+        #
+        #   @param voicemail_detection [Telnyx::Models::AI::TelephonySettings::VoicemailDetection] Configuration for voicemail detection (AMD - Answering Machine Detection) on out
 
         # The noise suppression engine to use. Use 'disabled' to turn off noise
         # suppression.
@@ -63,6 +87,7 @@ module Telnyx
         module NoiseSuppression
           extend Telnyx::Internal::Type::Enum
 
+          KRISP = :krisp
           DEEPFILTERNET = :deepfilternet
           DISABLED = :disabled
 
@@ -104,6 +129,122 @@ module Telnyx
             #   @return [Array<Symbol>]
           end
         end
+
+        # @see Telnyx::Models::AI::TelephonySettings#voicemail_detection
+        class VoicemailDetection < Telnyx::Internal::Type::BaseModel
+          # @!attribute on_voicemail_detected
+          #   Action to take when voicemail is detected.
+          #
+          #   @return [Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected, nil]
+          optional :on_voicemail_detected,
+                   -> { Telnyx::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected }
+
+          # @!method initialize(on_voicemail_detected: nil)
+          #   Configuration for voicemail detection (AMD - Answering Machine Detection) on
+          #   outgoing calls. These settings only apply if AMD is enabled on the Dial command.
+          #   See
+          #   [TeXML Dial documentation](https://developers.telnyx.com/api-reference/texml-rest-commands/initiate-an-outbound-call)
+          #   for enabling AMD. Recommended settings: MachineDetection=Enable, AsyncAmd=true,
+          #   DetectionMode=Premium.
+          #
+          #   @param on_voicemail_detected [Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected] Action to take when voicemail is detected.
+
+          # @see Telnyx::Models::AI::TelephonySettings::VoicemailDetection#on_voicemail_detected
+          class OnVoicemailDetected < Telnyx::Internal::Type::BaseModel
+            # @!attribute action
+            #   The action to take when voicemail is detected.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected::Action, nil]
+            optional :action,
+                     enum: -> { Telnyx::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected::Action }
+
+            # @!attribute voicemail_message
+            #   Configuration for the voicemail message to leave. Only applicable when action is
+            #   'leave_message_and_stop_assistant'.
+            #
+            #   @return [Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected::VoicemailMessage, nil]
+            optional :voicemail_message,
+                     -> { Telnyx::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected::VoicemailMessage }
+
+            # @!method initialize(action: nil, voicemail_message: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected}
+            #   for more details.
+            #
+            #   Action to take when voicemail is detected.
+            #
+            #   @param action [Symbol, Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected::Action] The action to take when voicemail is detected.
+            #
+            #   @param voicemail_message [Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected::VoicemailMessage] Configuration for the voicemail message to leave. Only applicable when action is
+
+            # The action to take when voicemail is detected.
+            #
+            # @see Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected#action
+            module Action
+              extend Telnyx::Internal::Type::Enum
+
+              STOP_ASSISTANT = :stop_assistant
+              LEAVE_MESSAGE_AND_STOP_ASSISTANT = :leave_message_and_stop_assistant
+              CONTINUE_ASSISTANT = :continue_assistant
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected#voicemail_message
+            class VoicemailMessage < Telnyx::Internal::Type::BaseModel
+              # @!attribute message
+              #   The specific message to leave as voicemail. Only applicable when type is
+              #   'message'.
+              #
+              #   @return [String, nil]
+              optional :message, String
+
+              # @!attribute prompt
+              #   The prompt to use for generating the voicemail message. Only applicable when
+              #   type is 'prompt'.
+              #
+              #   @return [String, nil]
+              optional :prompt, String
+
+              # @!attribute type
+              #   The type of voicemail message. Use 'prompt' to have the assistant generate a
+              #   message based on a prompt, or 'message' to leave a specific message.
+              #
+              #   @return [Symbol, Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected::VoicemailMessage::Type, nil]
+              optional :type,
+                       enum: -> { Telnyx::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected::VoicemailMessage::Type }
+
+              # @!method initialize(message: nil, prompt: nil, type: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected::VoicemailMessage}
+              #   for more details.
+              #
+              #   Configuration for the voicemail message to leave. Only applicable when action is
+              #   'leave_message_and_stop_assistant'.
+              #
+              #   @param message [String] The specific message to leave as voicemail. Only applicable when type is 'messag
+              #
+              #   @param prompt [String] The prompt to use for generating the voicemail message. Only applicable when typ
+              #
+              #   @param type [Symbol, Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected::VoicemailMessage::Type] The type of voicemail message. Use 'prompt' to have the assistant generate a mes
+
+              # The type of voicemail message. Use 'prompt' to have the assistant generate a
+              # message based on a prompt, or 'message' to leave a specific message.
+              #
+              # @see Telnyx::Models::AI::TelephonySettings::VoicemailDetection::OnVoicemailDetected::VoicemailMessage#type
+              module Type
+                extend Telnyx::Internal::Type::Enum
+
+                PROMPT = :prompt
+                MESSAGE = :message
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
       end
     end
   end

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

@@ -6,8 +6,8 @@ module Telnyx
       class TransferTool < Telnyx::Internal::Type::BaseModel
         # @!attribute transfer
         #
-        #   @return [Telnyx::Models::AI::InferenceEmbeddingTransferToolParams]
-        required :transfer, -> { Telnyx::AI::InferenceEmbeddingTransferToolParams }
+        #   @return [Telnyx::Models::AI::TransferTool::Transfer]
+        required :transfer, -> { Telnyx::AI::TransferTool::Transfer }
 
         # @!attribute type
         #
@@ -15,9 +15,52 @@ module Telnyx
         required :type, enum: -> { Telnyx::AI::TransferTool::Type }
 
         # @!method initialize(transfer:, type:)
-        #   @param transfer [Telnyx::Models::AI::InferenceEmbeddingTransferToolParams]
+        #   @param transfer [Telnyx::Models::AI::TransferTool::Transfer]
         #   @param type [Symbol, Telnyx::Models::AI::TransferTool::Type]
 
+        # @see Telnyx::Models::AI::TransferTool#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::TransferTool::Transfer::Target>]
+          required :targets, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::TransferTool::Transfer::Target] }
+
+          # @!method initialize(from:, targets:)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::TransferTool::Transfer} for more details.
+          #
+          #   @param from [String] Number or SIP URI placing the call.
+          #
+          #   @param targets [Array<Telnyx::Models::AI::TransferTool::Transfer::Target>] The different possible targets of the transfer. The assistant will be able to ch
+
+          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
+        end
+
         # @see Telnyx::Models::AI::TransferTool#type
         module Type
           extend Telnyx::Internal::Type::Enum

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

@@ -9,7 +9,7 @@ module Telnyx
         #   [available voices](https://developers.telnyx.com/api/call-control/list-text-to-speech-voices)
         #   via our voices API. To use ElevenLabs, you must reference your ElevenLabs API
         #   key as an integration secret under the `api_key_ref` field. See
-        #   [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+        #   [integration secrets documentation](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
         #   for details. For Telnyx voices, use `Telnyx.<model_id>.<voice_id>` (e.g.
         #   Telnyx.KokoroTTS.af_heart)
         #

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

@@ -11,12 +11,12 @@ module Telnyx
 
         # @!attribute webhook
         #
-        #   @return [Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams]
-        required :webhook, -> { Telnyx::AI::InferenceEmbeddingWebhookToolParams }
+        #   @return [Telnyx::Models::AI::WebhookTool::Webhook]
+        required :webhook, -> { Telnyx::AI::WebhookTool::Webhook }
 
         # @!method initialize(type:, webhook:)
         #   @param type [Symbol, Telnyx::Models::AI::WebhookTool::Type]
-        #   @param webhook [Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams]
+        #   @param webhook [Telnyx::Models::AI::WebhookTool::Webhook]
 
         # @see Telnyx::Models::AI::WebhookTool#type
         module Type
@@ -27,6 +27,259 @@ module Telnyx
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        # @see Telnyx::Models::AI::WebhookTool#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 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::WebhookTool::Webhook::BodyParameters, nil]
+          optional :body_parameters, -> { Telnyx::AI::WebhookTool::Webhook::BodyParameters }
+
+          # @!attribute headers
+          #   The headers to be sent to the external tool.
+          #
+          #   @return [Array<Telnyx::Models::AI::WebhookTool::Webhook::Header>, nil]
+          optional :headers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::WebhookTool::Webhook::Header] }
+
+          # @!attribute method_
+          #   The HTTP method to be used when calling the external tool.
+          #
+          #   @return [Symbol, Telnyx::Models::AI::WebhookTool::Webhook::Method, nil]
+          optional :method_, enum: -> { Telnyx::AI::WebhookTool::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::WebhookTool::Webhook::PathParameters, nil]
+          optional :path_parameters, -> { Telnyx::AI::WebhookTool::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::WebhookTool::Webhook::QueryParameters, nil]
+          optional :query_parameters, -> { Telnyx::AI::WebhookTool::Webhook::QueryParameters }
+
+          # @!method initialize(description:, name:, url:, body_parameters: nil, headers: nil, method_: nil, path_parameters: nil, query_parameters: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::WebhookTool::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 body_parameters [Telnyx::Models::AI::WebhookTool::Webhook::BodyParameters] The body parameters the webhook tool accepts, described as a JSON Schema object.
+          #
+          #   @param headers [Array<Telnyx::Models::AI::WebhookTool::Webhook::Header>] The headers to be sent to the external tool.
+          #
+          #   @param method_ [Symbol, Telnyx::Models::AI::WebhookTool::Webhook::Method] The HTTP method to be used when calling the external tool.
+          #
+          #   @param path_parameters [Telnyx::Models::AI::WebhookTool::Webhook::PathParameters] The path parameters the webhook tool accepts, described as a JSON Schema object.
+          #
+          #   @param query_parameters [Telnyx::Models::AI::WebhookTool::Webhook::QueryParameters] The query parameters the webhook tool accepts, described as a JSON Schema object
+
+          # @see Telnyx::Models::AI::WebhookTool::Webhook#body_parameters
+          class BodyParameters < Telnyx::Internal::Type::BaseModel
+            # @!attribute properties
+            #   The properties of the body parameters.
+            #
+            #   @return [Object, nil]
+            optional :properties, 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::WebhookTool::Webhook::BodyParameters::Type, nil]
+            optional :type, enum: -> { Telnyx::AI::WebhookTool::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 [Object] The properties of the body parameters.
+            #
+            #   @param required [Array<String>] The required properties of the body parameters.
+            #
+            #   @param type [Symbol, Telnyx::Models::AI::WebhookTool::Webhook::BodyParameters::Type]
+
+            # @see Telnyx::Models::AI::WebhookTool::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.
+            #
+            #   @return [String, nil]
+            optional :value, String
+
+            # @!method initialize(name: nil, value: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::WebhookTool::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::WebhookTool::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::WebhookTool::Webhook#path_parameters
+          class PathParameters < Telnyx::Internal::Type::BaseModel
+            # @!attribute properties
+            #   The properties of the path parameters.
+            #
+            #   @return [Object, nil]
+            optional :properties, 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::WebhookTool::Webhook::PathParameters::Type, nil]
+            optional :type, enum: -> { Telnyx::AI::WebhookTool::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 [Object] The properties of the path parameters.
+            #
+            #   @param required [Array<String>] The required properties of the path parameters.
+            #
+            #   @param type [Symbol, Telnyx::Models::AI::WebhookTool::Webhook::PathParameters::Type]
+
+            # @see Telnyx::Models::AI::WebhookTool::Webhook::PathParameters#type
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              OBJECT = :object
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @see Telnyx::Models::AI::WebhookTool::Webhook#query_parameters
+          class QueryParameters < Telnyx::Internal::Type::BaseModel
+            # @!attribute properties
+            #   The properties of the query parameters.
+            #
+            #   @return [Object, nil]
+            optional :properties, 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::WebhookTool::Webhook::QueryParameters::Type, nil]
+            optional :type, enum: -> { Telnyx::AI::WebhookTool::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 [Object] The properties of the query parameters.
+            #
+            #   @param required [Array<String>] The required properties of the query parameters.
+            #
+            #   @param type [Symbol, Telnyx::Models::AI::WebhookTool::Webhook::QueryParameters::Type]
+
+            # @see Telnyx::Models::AI::WebhookTool::Webhook::QueryParameters#type
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              OBJECT = :object
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
       end
     end
   end