telnyx 5.70.0 → 5.72.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ac9a07c8a853ece2ee38dc9271bc8aede4cdc909f634b11f547d24a01906726
-  data.tar.gz: 6ad873c682fd93b981dbca7a48f83bef3c1b43e29a6722c2e72bf46f6b20b79a
+  metadata.gz: d4b500a4bc4109025ba78f82c49404d3013e7503c76f1d9c8634b3acafbab842
+  data.tar.gz: 10cf9319219e298027dc388a87825bd3edd259ffdeead4f22296ed2a69c6a0e2
 SHA512:
-  metadata.gz: 7cd372e02874a4654b037003c200e382104128701fb6e521882853e81a7671d6faa00e51e8dc28f9d58f69a38a2edcbcb1c473642e1ddcf979d6cf9718aaf3c9
-  data.tar.gz: 71b0c0af94329048ed0920882d23d0cd41c8e5d231e7004de41196dc05f08c1231ce8ec3a4e6f8f4f4cae7a223a5c93a756acd68bcc4ea406844ac62b7c41f82
+  metadata.gz: b9f7f8f34ba648a1ec8309a25a958b2cfccb5e8f4f78753110353ba7795b5d82191d2939ce8bc7890f91b174875349ca89d7161cf11bc8171311c75c282e0724
+  data.tar.gz: 1ce14a74710071dabcf31b1c5046172211879613dfe534cadf77783cf66e696bf557a15ade2928eaf5de7f3aa6637c93d4b83b22c0f78bb738c2d36f842559c3

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## 5.72.0 (2026-04-11)
+
+Full Changelog: [v5.71.0...v5.72.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.71.0...v5.72.0)
+
+### Features
+
+* **lib:** make ED25519 the default webhook verification ([c281219](https://github.com/team-telnyx/telnyx-ruby/commit/c2812192677e731ddf6b6702590f7e55d2f3ef68))
+
+
+### Bug Fixes
+
+* **lib:** move ED25519 auto-require to lib.rb entry point to survive codegen ([7f38f2c](https://github.com/team-telnyx/telnyx-ruby/commit/7f38f2cf33fb3c8391ce7d8f86c88513d7edc907))
+* **lib:** update webhook tests for ED25519 default unwrap ([30ac4c7](https://github.com/team-telnyx/telnyx-ruby/commit/30ac4c7d1fc66732ba5dc55824d3876b4dd120f0))
+
+## 5.71.0 (2026-04-11)
+
+Full Changelog: [v5.70.0...v5.71.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.70.0...v5.71.0)
+
+### Features
+
+* add shared CallAssistantRequest schema for call-control assistant object ([67a2157](https://github.com/team-telnyx/telnyx-ruby/commit/67a2157455d5a6e5138f89e54479977f108605a7))
+* **api:** manual updates ([0000b53](https://github.com/team-telnyx/telnyx-ruby/commit/0000b5378d0f1dfeb46f1b5670933819fa935d5a))
+* **api:** Merge pull request [#46](https://github.com/team-telnyx/telnyx-ruby/issues/46) from stainless-sdks/FixModelRecommendation ([4b3ea59](https://github.com/team-telnyx/telnyx-ruby/commit/4b3ea599a86f9279f139cbb7868da79079685846))
+* MSG-6846: add GET /profile/photo docs for whatsapp API ([d06a131](https://github.com/team-telnyx/telnyx-ruby/commit/d06a131d943549a7a744a3968e116480d986fc8e))
+
+
+### Bug Fixes
+
+* correct Provider constant reference in VoiceCloneCreateFromDesignParams RBI/RBS ([6c66dd2](https://github.com/team-telnyx/telnyx-ruby/commit/6c66dd2ebf03c26eeeadadb0a93f5828134d0492))
+
+
+### Reverts
+
+* restore stainless.yml to pre-6a6df5b state ([d7e3266](https://github.com/team-telnyx/telnyx-ruby/commit/d7e3266c5593d4163184b2cdcff260aa281843d7))
+
+
+### Documentation
+
+* improve examples ([ecc0d15](https://github.com/team-telnyx/telnyx-ruby/commit/ecc0d1599570e1bbeb73c2db47b05a3a9c0e7a00))
+
 ## 5.70.0 (2026-04-08)
 
 Full Changelog: [v5.69.0...v5.70.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.69.0...v5.70.0)

data/README.md

@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "telnyx", "~> 5.70.0"
+gem "telnyx", "~> 5.72.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/telnyx/lib/webhook_verification.rb

@@ -150,7 +150,20 @@ module Telnyx
         # The raw 32-byte key needs to be wrapped in X.509 SubjectPublicKeyInfo format
         # ED25519 OID: 1.3.101.112 = 06 03 2b 65 70
         # X.509 SPKI header for ED25519: 30 2a 30 05 06 03 2b 65 70 03 21 00
-        ed25519_spki_header = [0x30, 0x2a, 0x30, 0x05, 0x06, 0x03, 0x2b, 0x65, 0x70, 0x03, 0x21, 0x00].pack("C*")
+        ed25519_spki_header = [
+          0x30,
+          0x2a,
+          0x30,
+          0x05,
+          0x06,
+          0x03,
+          0x2b,
+          0x65,
+          0x70,
+          0x03,
+          0x21,
+          0x00
+        ].pack("C*")
         der_key = ed25519_spki_header + public_key_bytes
 
         begin

data/lib/telnyx/lib/webhooks_ed25519.rb

@@ -3,48 +3,61 @@
 require_relative "webhook_verification"
 require_relative "webhook_verification_error"
 
-module Telnyx
-  module Resources
-    # Extends the generated Webhooks class with ED25519 signature verification.
-    #
-    # This reopens the Webhooks class to include the WebhookVerification module,
-    # which adds ED25519 signature verification matching Python, Node, Go, and Java SDKs.
-    #
-    # Usage:
-    #
-    #   require "telnyx"
-    #   require "telnyx/lib/webhooks_ed25519"
-    #
-    #   client = Telnyx::Client.new(
-    #     api_key: ENV["TELNYX_API_KEY"],
-    #     public_key: ENV["TELNYX_PUBLIC_KEY"]  # Base64 from Mission Control
-    #   )
-    #
-    #   # Verify signature only (raises WebhookVerificationError on failure)
-    #   client.webhooks.verify!(payload, headers)
-    #
-    #   # Verify and parse (ED25519 verification, then parse)
-    #   event = client.webhooks.unwrap(payload, headers: headers)
-    #
-    class Webhooks
-      include Telnyx::Lib::WebhookVerification
-
-      # Override unwrap to use ED25519 verification instead of StandardWebhooks.
+# Only apply the ED25519 override if the generated Webhooks class exists.
+# This file is loaded after lib/telnyx/resources/webhooks.rb in the gem
+# load order (see lib/telnyx.rb), so the class should always be defined.
+if defined?(Telnyx::Resources::Webhooks)
+  module Telnyx
+    module Resources
+      # Extends the generated Webhooks class with ED25519 signature verification.
+      #
+      # This reopens the Webhooks class to include the WebhookVerification module,
+      # which adds ED25519 signature verification matching Python, Node, Go, and Java SDKs.
+      #
+      # Usage:
+      #
+      #   require "telnyx"
+      #   # ED25519 verification is now loaded by default — no extra require needed
       #
-      # @param payload [String] The raw webhook payload as a string
-      # @param headers [Hash{String=>String}] The raw HTTP headers
-      # @param key [String, nil] Optional public key override (base64-encoded ED25519)
+      #   client = Telnyx::Client.new(
+      #     api_key: ENV["TELNYX_API_KEY"],
+      #     public_key: ENV["TELNYX_PUBLIC_KEY"]  # Base64 from Mission Control
+      #   )
       #
-      # @return [Telnyx::Models::UnwrapWebhookEvent]
-      # @raise [Telnyx::Errors::WebhookVerificationError] If verification fails
-      def unwrap(payload, headers:, key: nil)
-        # Use ED25519 verification
-        do_verify_signature(payload, headers, key || @client.public_key)
+      #   # Verify signature only (raises WebhookVerificationError on failure)
+      #   client.webhooks.verify!(payload, headers)
+      #
+      #   # Verify and parse (ED25519 verification, then parse)
+      #   event = client.webhooks.unwrap(payload, headers: headers)
+      #
+      class Webhooks
+        include Telnyx::Lib::WebhookVerification
+
+        # Override unwrap to use ED25519 verification instead of StandardWebhooks.
+        #
+        # @param payload [String] The raw webhook payload as a string
+        # @param headers [Hash{String=>String}] The raw HTTP headers
+        # @param key [String, nil] Optional public key override (base64-encoded ED25519)
+        #
+        # @return [Telnyx::Models::UnwrapWebhookEvent]
+        # @raise [Telnyx::Errors::WebhookVerificationError] If verification fails
+        def unwrap(payload, headers:, key: nil)
+          # Use ED25519 verification
+          do_verify_signature(payload, headers, key || @client.public_key)
 
-        # Parse the payload
-        parsed = JSON.parse(payload, symbolize_names: true)
-        Telnyx::Internal::Type::Converter.coerce(Telnyx::Models::UnwrapWebhookEvent, parsed)
+          # Parse the payload
+          parsed = JSON.parse(payload, symbolize_names: true)
+          Telnyx::Internal::Type::Converter.coerce(Telnyx::Models::UnwrapWebhookEvent, parsed)
+        end
       end
     end
   end
+else
+  # If the generated Webhooks class isn't loaded yet, the ED25519 override
+  # can't be applied. This shouldn't happen in normal gem usage since
+  # lib/telnyx.rb loads resources before lib/. If you see this warning,
+  # ensure lib/telnyx.rb requires lib/telnyx/lib after the resources.
+  warn "[telnyx] ED25519 webhook verification not loaded: " \
+       "Telnyx::Resources::Webhooks is not defined. " \
+       "Check that lib/telnyx.rb loads resources before lib/telnyx/lib."
 end

data/lib/telnyx/lib.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Custom lib entry point — preserved across Stainless codegen.
+#
+# This file requires all custom modules in lib/telnyx/lib/.
+# It is loaded from lib/telnyx.rb (the gem entry point).
+#
+# If Stainless regenerates lib/telnyx.rb, the require_relative line
+# pointing to this file must be re-added. All other custom code
+# lives here and in lib/telnyx/lib/ — safe from codegen.
+#
+# Add new custom modules below:
+
+require_relative "lib/webhooks_ed25519"

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

@@ -29,7 +29,7 @@ module Telnyx
         # @!attribute tools
         #   The tools that the voice assistant can use.
         #
-        #   @return [Array<Telnyx::Models::AI::Assistant::Tool::BookAppointment, Telnyx::Models::AI::Assistant::Tool::CheckAvailability, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::Assistant::Tool::Retrieval>, nil]
+        #   @return [Array<Telnyx::Models::BookAppointmentTool, Telnyx::Models::CheckAvailabilityTool, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::CallControlRetrievalTool>, nil]
         optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::Assistant::Tool] }
 
         # @!method initialize(instructions: nil, model: nil, openai_api_key_ref: nil, tools: nil)
@@ -44,16 +44,16 @@ module Telnyx
         #
         #   @param openai_api_key_ref [String] This is necessary only if the model selected is from OpenAI. You would pass the
         #
-        #   @param tools [Array<Telnyx::Models::AI::Assistant::Tool::BookAppointment, Telnyx::Models::AI::Assistant::Tool::CheckAvailability, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::Assistant::Tool::Retrieval>] The tools that the voice assistant can use.
+        #   @param tools [Array<Telnyx::Models::BookAppointmentTool, Telnyx::Models::CheckAvailabilityTool, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::CallControlRetrievalTool>] The tools that the voice assistant can use.
 
         module Tool
           extend Telnyx::Internal::Type::Union
 
           discriminator :type
 
-          variant :book_appointment, -> { Telnyx::AI::Assistant::Tool::BookAppointment }
+          variant :book_appointment, -> { Telnyx::BookAppointmentTool }
 
-          variant :check_availability, -> { Telnyx::AI::Assistant::Tool::CheckAvailability }
+          variant :check_availability, -> { Telnyx::CheckAvailabilityTool }
 
           variant :webhook, -> { Telnyx::AI::WebhookTool }
 
@@ -61,153 +61,10 @@ module Telnyx
 
           variant :transfer, -> { Telnyx::AI::TransferTool }
 
-          variant :retrieval, -> { Telnyx::AI::Assistant::Tool::Retrieval }
-
-          class BookAppointment < Telnyx::Internal::Type::BaseModel
-            # @!attribute book_appointment
-            #
-            #   @return [Telnyx::Models::AI::Assistant::Tool::BookAppointment::BookAppointment]
-            required :book_appointment, -> { Telnyx::AI::Assistant::Tool::BookAppointment::BookAppointment }
-
-            # @!attribute type
-            #
-            #   @return [Symbol, :book_appointment]
-            required :type, const: :book_appointment
-
-            # @!method initialize(book_appointment:, type: :book_appointment)
-            #   @param book_appointment [Telnyx::Models::AI::Assistant::Tool::BookAppointment::BookAppointment]
-            #   @param type [Symbol, :book_appointment]
-
-            # @see Telnyx::Models::AI::Assistant::Tool::BookAppointment#book_appointment
-            class BookAppointment < Telnyx::Internal::Type::BaseModel
-              # @!attribute api_key_ref
-              #   Reference to an integration secret that contains your Cal.com API key. You would
-              #   pass the `identifier` for an integration secret
-              #   [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
-              #   that refers to your Cal.com API key.
-              #
-              #   @return [String]
-              required :api_key_ref, String
-
-              # @!attribute event_type_id
-              #   Event Type ID for which slots are being fetched.
-              #   [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-event-type-id)
-              #
-              #   @return [Integer]
-              required :event_type_id, Integer
-
-              # @!attribute attendee_name
-              #   The name of the attendee
-              #   [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-attendee-name).
-              #   If not provided, the assistant will ask for the attendee's name.
-              #
-              #   @return [String, nil]
-              optional :attendee_name, String
-
-              # @!attribute attendee_timezone
-              #   The timezone of the attendee
-              #   [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-attendee-timezone).
-              #   If not provided, the assistant will ask for the attendee's timezone.
-              #
-              #   @return [String, nil]
-              optional :attendee_timezone, String
-
-              # @!method initialize(api_key_ref:, event_type_id:, attendee_name: nil, attendee_timezone: nil)
-              #   Some parameter documentations has been truncated, see
-              #   {Telnyx::Models::AI::Assistant::Tool::BookAppointment::BookAppointment} for more
-              #   details.
-              #
-              #   @param api_key_ref [String] Reference to an integration secret that contains your Cal.com API key. You would
-              #
-              #   @param event_type_id [Integer] Event Type ID for which slots are being fetched. [cal.com](https://cal.com/docs/
-              #
-              #   @param attendee_name [String] The name of the attendee [cal.com](https://cal.com/docs/api-reference/v2/booking
-              #
-              #   @param attendee_timezone [String] The timezone of the attendee [cal.com](https://cal.com/docs/api-reference/v2/boo
-            end
-          end
-
-          class CheckAvailability < Telnyx::Internal::Type::BaseModel
-            # @!attribute check_availability
-            #
-            #   @return [Telnyx::Models::AI::Assistant::Tool::CheckAvailability::CheckAvailability]
-            required :check_availability, -> { Telnyx::AI::Assistant::Tool::CheckAvailability::CheckAvailability }
-
-            # @!attribute type
-            #
-            #   @return [Symbol, :check_availability]
-            required :type, const: :check_availability
-
-            # @!method initialize(check_availability:, type: :check_availability)
-            #   @param check_availability [Telnyx::Models::AI::Assistant::Tool::CheckAvailability::CheckAvailability]
-            #   @param type [Symbol, :check_availability]
-
-            # @see Telnyx::Models::AI::Assistant::Tool::CheckAvailability#check_availability
-            class CheckAvailability < Telnyx::Internal::Type::BaseModel
-              # @!attribute api_key_ref
-              #   Reference to an integration secret that contains your Cal.com API key. You would
-              #   pass the `identifier` for an integration secret
-              #   [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
-              #   that refers to your Cal.com API key.
-              #
-              #   @return [String]
-              required :api_key_ref, String
-
-              # @!attribute event_type_id
-              #   Event Type ID for which slots are being fetched.
-              #   [cal.com](https://cal.com/docs/api-reference/v2/slots/get-available-slots#parameter-event-type-id)
-              #
-              #   @return [Integer]
-              required :event_type_id, Integer
-
-              # @!method initialize(api_key_ref:, event_type_id:)
-              #   Some parameter documentations has been truncated, see
-              #   {Telnyx::Models::AI::Assistant::Tool::CheckAvailability::CheckAvailability} for
-              #   more details.
-              #
-              #   @param api_key_ref [String] Reference to an integration secret that contains your Cal.com API key. You would
-              #
-              #   @param event_type_id [Integer] Event Type ID for which slots are being fetched. [cal.com](https://cal.com/docs/
-            end
-          end
-
-          class Retrieval < Telnyx::Internal::Type::BaseModel
-            # @!attribute retrieval
-            #
-            #   @return [Telnyx::Models::AI::Assistant::Tool::Retrieval::Retrieval]
-            required :retrieval, -> { Telnyx::AI::Assistant::Tool::Retrieval::Retrieval }
-
-            # @!attribute type
-            #
-            #   @return [Symbol, :retrieval]
-            required :type, const: :retrieval
-
-            # @!method initialize(retrieval:, type: :retrieval)
-            #   @param retrieval [Telnyx::Models::AI::Assistant::Tool::Retrieval::Retrieval]
-            #   @param type [Symbol, :retrieval]
-
-            # @see Telnyx::Models::AI::Assistant::Tool::Retrieval#retrieval
-            class Retrieval < Telnyx::Internal::Type::BaseModel
-              # @!attribute bucket_ids
-              #
-              #   @return [Array<String>]
-              required :bucket_ids, Telnyx::Internal::Type::ArrayOf[String]
-
-              # @!attribute max_num_results
-              #   The maximum number of results to retrieve as context for the language model.
-              #
-              #   @return [Integer, nil]
-              optional :max_num_results, Integer
-
-              # @!method initialize(bucket_ids:, max_num_results: nil)
-              #   @param bucket_ids [Array<String>]
-              #
-              #   @param max_num_results [Integer] The maximum number of results to retrieve as context for the language model.
-            end
-          end
+          variant :retrieval, -> { Telnyx::CallControlRetrievalTool }
 
           # @!method self.variants
-          #   @return [Array(Telnyx::Models::AI::Assistant::Tool::BookAppointment, Telnyx::Models::AI::Assistant::Tool::CheckAvailability, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::Assistant::Tool::Retrieval)]
+          #   @return [Array(Telnyx::Models::BookAppointmentTool, Telnyx::Models::CheckAvailabilityTool, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::CallControlRetrievalTool)]
         end
       end
     end

data/lib/telnyx/models/book_appointment_tool.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class BookAppointmentTool < Telnyx::Internal::Type::BaseModel
+      # @!attribute book_appointment
+      #
+      #   @return [Telnyx::Models::BookAppointmentToolParams]
+      required :book_appointment, -> { Telnyx::BookAppointmentToolParams }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Telnyx::Models::BookAppointmentTool::Type]
+      required :type, enum: -> { Telnyx::BookAppointmentTool::Type }
+
+      # @!method initialize(book_appointment:, type:)
+      #   @param book_appointment [Telnyx::Models::BookAppointmentToolParams]
+      #   @param type [Symbol, Telnyx::Models::BookAppointmentTool::Type]
+
+      # @see Telnyx::Models::BookAppointmentTool#type
+      module Type
+        extend Telnyx::Internal::Type::Enum
+
+        BOOK_APPOINTMENT = :book_appointment
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/book_appointment_tool_params.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class BookAppointmentToolParams < Telnyx::Internal::Type::BaseModel
+      # @!attribute api_key_ref
+      #   Reference to an integration secret that contains your Cal.com API key. You would
+      #   pass the `identifier` for an integration secret
+      #   [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+      #   that refers to your Cal.com API key.
+      #
+      #   @return [String]
+      required :api_key_ref, String
+
+      # @!attribute event_type_id
+      #   Event Type ID for which slots are being fetched.
+      #   [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-event-type-id)
+      #
+      #   @return [Integer]
+      required :event_type_id, Integer
+
+      # @!attribute attendee_name
+      #   The name of the attendee
+      #   [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-attendee-name).
+      #   If not provided, the assistant will ask for the attendee's name.
+      #
+      #   @return [String, nil]
+      optional :attendee_name, String
+
+      # @!attribute attendee_timezone
+      #   The timezone of the attendee
+      #   [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-attendee-timezone).
+      #   If not provided, the assistant will ask for the attendee's timezone.
+      #
+      #   @return [String, nil]
+      optional :attendee_timezone, String
+
+      # @!method initialize(api_key_ref:, event_type_id:, attendee_name: nil, attendee_timezone: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::BookAppointmentToolParams} for more details.
+      #
+      #   @param api_key_ref [String] Reference to an integration secret that contains your Cal.com API key. You would
+      #
+      #   @param event_type_id [Integer] Event Type ID for which slots are being fetched. [cal.com](https://cal.com/docs/
+      #
+      #   @param attendee_name [String] The name of the attendee [cal.com](https://cal.com/docs/api-reference/v2/booking
+      #
+      #   @param attendee_timezone [String] The timezone of the attendee [cal.com](https://cal.com/docs/api-reference/v2/boo
+    end
+  end
+end

data/lib/telnyx/models/call_assistant_request.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class CallAssistantRequest < Telnyx::Internal::Type::BaseModel
+      # @!attribute id
+      #   The identifier of the AI assistant to use.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute dynamic_variables
+      #   Map of dynamic variables and their default values. Dynamic variables can be
+      #   referenced in instructions, greeting, and tool definitions using the
+      #   `{{variable_name}}` syntax. Call-control-agent automatically merges in
+      #   `telnyx_call_*` variables (telnyx_call_to, telnyx_call_from,
+      #   telnyx_conversation_channel, telnyx_agent_target, telnyx_end_user_target,
+      #   telnyx_call_caller_id_name) and custom header variables.
+      #
+      #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
+      optional :dynamic_variables,
+               -> { Telnyx::Internal::Type::HashOf[union: Telnyx::CallAssistantRequest::DynamicVariable] }
+
+      # @!attribute external_llm
+      #   External LLM configuration for bringing your own LLM endpoint.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :external_llm, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!attribute fallback_config
+      #   Fallback LLM configuration used when the primary LLM provider is unavailable.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :fallback_config, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!attribute greeting
+      #   Initial greeting text spoken when the assistant starts. Can be plain text for
+      #   any voice or SSML for `AWS.Polly.<voice_id>` voices. There is a 3,000 character
+      #   limit.
+      #
+      #   @return [String, nil]
+      optional :greeting, String
+
+      # @!attribute instructions
+      #   System instructions for the voice assistant. Can be templated with
+      #   [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
+      #   This will overwrite the instructions set in the assistant configuration.
+      #
+      #   @return [String, nil]
+      optional :instructions, String
+
+      # @!attribute llm_api_key_ref
+      #   Integration secret identifier for the LLM provider API key. Use this field to
+      #   reference an
+      #   [integration secret](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+      #   containing your LLM provider API key. Supports any LLM provider (OpenAI,
+      #   Anthropic, etc.).
+      #
+      #   @return [String, nil]
+      optional :llm_api_key_ref, String
+
+      # @!attribute mcp_servers
+      #   MCP (Model Context Protocol) server configurations for extending the assistant's
+      #   capabilities with external tools and data sources.
+      #
+      #   @return [Array<Hash{Symbol=>Object}>, nil]
+      optional :mcp_servers,
+               Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
+
+      # @!attribute model
+      #   LLM model override for this call. If omitted, the assistant's configured model
+      #   is used.
+      #
+      #   @return [String, nil]
+      optional :model, String
+
+      # @!attribute name
+      #   Assistant name override for this call.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute observability_settings
+      #   Observability configuration for the assistant session, including Langfuse
+      #   integration for tracing and monitoring.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :observability_settings, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!attribute openai_api_key_ref
+      #   @deprecated This field is deprecated and will be removed soon
+      #
+      #   Deprecated — use `llm_api_key_ref` instead. Integration secret identifier for
+      #   the OpenAI API key. This field is maintained for backward compatibility;
+      #   `llm_api_key_ref` is the canonical field name and supports all LLM providers.
+      #
+      #   @return [String, nil]
+      optional :openai_api_key_ref, String
+
+      # @!attribute tools
+      #   Inline tool definitions available to the assistant (webhook, retrieval,
+      #   transfer, hangup, etc.). Overrides the assistant's stored tools if provided.
+      #
+      #   @return [Array<Telnyx::Models::BookAppointmentTool, Telnyx::Models::CheckAvailabilityTool, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::CallControlRetrievalTool>, nil]
+      optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::CallAssistantRequest::Tool] }
+
+      # @!method initialize(id:, dynamic_variables: nil, external_llm: nil, fallback_config: nil, greeting: nil, instructions: nil, llm_api_key_ref: nil, mcp_servers: nil, model: nil, name: nil, observability_settings: nil, openai_api_key_ref: nil, tools: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::CallAssistantRequest} for more details.
+      #
+      #   AI Assistant configuration. All fields except `id` are optional — the
+      #   assistant's stored configuration will be used as fallback for any omitted
+      #   fields.
+      #
+      #   @param id [String] The identifier of the AI assistant to use.
+      #
+      #   @param dynamic_variables [Hash{Symbol=>String, Float, Boolean}] Map of dynamic variables and their default values. Dynamic variables can be refe
+      #
+      #   @param external_llm [Hash{Symbol=>Object}] External LLM configuration for bringing your own LLM endpoint.
+      #
+      #   @param fallback_config [Hash{Symbol=>Object}] Fallback LLM configuration used when the primary LLM provider is unavailable.
+      #
+      #   @param greeting [String] Initial greeting text spoken when the assistant starts. Can be plain text for an
+      #
+      #   @param instructions [String] System instructions for the voice assistant. Can be templated with [dynamic vari
+      #
+      #   @param llm_api_key_ref [String] Integration secret identifier for the LLM provider API key. Use this field to re
+      #
+      #   @param mcp_servers [Array<Hash{Symbol=>Object}>] MCP (Model Context Protocol) server configurations for extending the assistant's
+      #
+      #   @param model [String] LLM model override for this call. If omitted, the assistant's configured model i
+      #
+      #   @param name [String] Assistant name override for this call.
+      #
+      #   @param observability_settings [Hash{Symbol=>Object}] Observability configuration for the assistant session, including Langfuse integr
+      #
+      #   @param openai_api_key_ref [String] Deprecated — use `llm_api_key_ref` instead. Integration secret identifier for th
+      #
+      #   @param tools [Array<Telnyx::Models::BookAppointmentTool, Telnyx::Models::CheckAvailabilityTool, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::CallControlRetrievalTool>] Inline tool definitions available to the assistant (webhook, retrieval, transfer
+
+      module DynamicVariable
+        extend Telnyx::Internal::Type::Union
+
+        variant String
+
+        variant Float
+
+        variant Telnyx::Internal::Type::Boolean
+
+        # @!method self.variants
+        #   @return [Array(String, Float, Boolean)]
+      end
+
+      module Tool
+        extend Telnyx::Internal::Type::Union
+
+        discriminator :type
+
+        variant :book_appointment, -> { Telnyx::BookAppointmentTool }
+
+        variant :check_availability, -> { Telnyx::CheckAvailabilityTool }
+
+        variant :webhook, -> { Telnyx::AI::WebhookTool }
+
+        variant :hangup, -> { Telnyx::AI::HangupTool }
+
+        variant :transfer, -> { Telnyx::AI::TransferTool }
+
+        variant :retrieval, -> { Telnyx::CallControlRetrievalTool }
+
+        # @!method self.variants
+        #   @return [Array(Telnyx::Models::BookAppointmentTool, Telnyx::Models::CheckAvailabilityTool, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::CallControlRetrievalTool)]
+      end
+    end
+  end
+end