RubyGems - telnyx - Versions diffs - 5.88.0 → 5.89.0 - Mend

telnyx 5.88.0 → 5.89.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +8 -0
data/README.md +1 -1
data/lib/telnyx/models/ai/assistant_create_params.rb +12 -12
data/lib/telnyx/models/ai/assistant_update_params.rb +12 -12
data/lib/telnyx/models/ai/assistants/update_assistant.rb +12 -12
data/lib/telnyx/models/ai/inference_embedding.rb +12 -12
data/lib/telnyx/models/call_assistant_request.rb +12 -12
data/lib/telnyx/version.rb +1 -1
data/rbi/telnyx/models/ai/assistant_create_params.rbi +20 -20
data/rbi/telnyx/models/ai/assistant_update_params.rbi +20 -20
data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +20 -20
data/rbi/telnyx/models/ai/inference_embedding.rbi +20 -20
data/rbi/telnyx/models/call_assistant_request.rbi +20 -20
metadata +1 -1

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8aa2bce90cfd6f5d0bf6a8c94ac119be05760fc219960f369d5b7f928530a69
-  data.tar.gz: b9b7a489e52443c9362ae674bc482cdd0c62e54a16d2c209c1b1ef2aa08efc17
+  metadata.gz: 880ba6753b019017a82fe4cb747e2f772bf86fd4012300f1fc963d94b404867f
+  data.tar.gz: 47247ce35fef31fbaf3e27fac9802ea0d9e0a9a5860e534014601272e97763a1
 SHA512:
-  metadata.gz: b4e19f28a9b7795a1e5c1755af50a6607fc89575ec58aa1b8d5e50b37af7c143cb541f336413361b87005adbd1201e38a67f105f2dcd592405f32367987d6cc1
-  data.tar.gz: a3f92c589ffcaae6209038921fabee803070633e37b219f135322467612af448ed2bcbae5daa8397c2b5aed8fad20432441b59589dfc4f6a0a387f546e1593b5
+  metadata.gz: 8450fe4745d0dda28b9326eed7f5b56883988305b8eb0c08320ec2b08d0a3e1dd061f426f185c9ae0a916f4838ebe5508aedd0e7f4286f72c01ebb51fb0ec16f
+  data.tar.gz: 9a1e6be33c9100b2010372a27db2e1a614e0404e03f48979920a4c473fa5eae9965c3bf07708acd5b414980af8bc1541c18b9b7838743e66541bd0c1f4ed6a30

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,13 @@
 # Changelog
+## 5.89.0 (2026-04-28)
+Full Changelog: [v5.88.0...v5.89.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.88.0...v5.89.0)
+### Features
+* Correct external LLM forwarded metadata docs ([c9b69a1](https://github.com/team-telnyx/telnyx-ruby/commit/c9b69a1078a5c7c21caa37286c967692081c8aa8))
 ## 5.88.0 (2026-04-28)
 Full Changelog: [v5.87.0...v5.88.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.87.0...v5.88.0)

data/README.md CHANGED Viewed

@@ -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.88.0"
+gem "telnyx", "~> 5.89.0"
 ```
 <!-- x-release-please-end -->

data/lib/telnyx/models/ai/assistant_create_params.rb CHANGED Viewed

@@ -226,11 +226,11 @@ module Telnyx
           optional :certificate_ref, String
           # @!attribute forward_metadata
-          #   When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-          #   external LLM endpoint. Defaults to false. The external endpoint receives the
-          #   standard chat completions payload with top-level `metadata` and
-          #   `dynamic_variables` objects when values are available. For example:
-          #   `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+          #   When enabled, Telnyx forwards the assistant's dynamic variables to the external
+          #   LLM endpoint. Defaults to false. The chat completion request includes a
+          #   top-level `extra_metadata` object when dynamic variables are available. For
+          #   example:
+          #   `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
           #
           #   @return [Boolean, nil]
           optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -259,7 +259,7 @@ module Telnyx
           #
           #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
           #
-          #   @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
+          #   @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
           #
           #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
           #
@@ -337,11 +337,11 @@ module Telnyx
             optional :certificate_ref, String
             # @!attribute forward_metadata
-            #   When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-            #   external LLM endpoint. Defaults to false. The external endpoint receives the
-            #   standard chat completions payload with top-level `metadata` and
-            #   `dynamic_variables` objects when values are available. For example:
-            #   `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+            #   When enabled, Telnyx forwards the assistant's dynamic variables to the external
+            #   LLM endpoint. Defaults to false. The chat completion request includes a
+            #   top-level `extra_metadata` object when dynamic variables are available. For
+            #   example:
+            #   `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
             #
             #   @return [Boolean, nil]
             optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -371,7 +371,7 @@ module Telnyx
             #
             #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
             #
-            #   @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
+            #   @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
             #
             #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
             #

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

@@ -242,11 +242,11 @@ module Telnyx
           optional :certificate_ref, String
           # @!attribute forward_metadata
-          #   When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-          #   external LLM endpoint. Defaults to false. The external endpoint receives the
-          #   standard chat completions payload with top-level `metadata` and
-          #   `dynamic_variables` objects when values are available. For example:
-          #   `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+          #   When enabled, Telnyx forwards the assistant's dynamic variables to the external
+          #   LLM endpoint. Defaults to false. The chat completion request includes a
+          #   top-level `extra_metadata` object when dynamic variables are available. For
+          #   example:
+          #   `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
           #
           #   @return [Boolean, nil]
           optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -275,7 +275,7 @@ module Telnyx
           #
           #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
           #
-          #   @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
+          #   @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
           #
           #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
           #
@@ -353,11 +353,11 @@ module Telnyx
             optional :certificate_ref, String
             # @!attribute forward_metadata
-            #   When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-            #   external LLM endpoint. Defaults to false. The external endpoint receives the
-            #   standard chat completions payload with top-level `metadata` and
-            #   `dynamic_variables` objects when values are available. For example:
-            #   `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+            #   When enabled, Telnyx forwards the assistant's dynamic variables to the external
+            #   LLM endpoint. Defaults to false. The chat completion request includes a
+            #   top-level `extra_metadata` object when dynamic variables are available. For
+            #   example:
+            #   `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
             #
             #   @return [Boolean, nil]
             optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -387,7 +387,7 @@ module Telnyx
             #
             #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
             #
-            #   @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
+            #   @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
             #
             #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
             #

data/lib/telnyx/models/ai/assistants/update_assistant.rb CHANGED Viewed

@@ -223,11 +223,11 @@ module Telnyx
             optional :certificate_ref, String
             # @!attribute forward_metadata
-            #   When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-            #   external LLM endpoint. Defaults to false. The external endpoint receives the
-            #   standard chat completions payload with top-level `metadata` and
-            #   `dynamic_variables` objects when values are available. For example:
-            #   `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+            #   When enabled, Telnyx forwards the assistant's dynamic variables to the external
+            #   LLM endpoint. Defaults to false. The chat completion request includes a
+            #   top-level `extra_metadata` object when dynamic variables are available. For
+            #   example:
+            #   `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
             #
             #   @return [Boolean, nil]
             optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -256,7 +256,7 @@ module Telnyx
             #
             #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
             #
-            #   @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
+            #   @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
             #
             #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
             #
@@ -336,11 +336,11 @@ module Telnyx
               optional :certificate_ref, String
               # @!attribute forward_metadata
-              #   When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-              #   external LLM endpoint. Defaults to false. The external endpoint receives the
-              #   standard chat completions payload with top-level `metadata` and
-              #   `dynamic_variables` objects when values are available. For example:
-              #   `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+              #   When enabled, Telnyx forwards the assistant's dynamic variables to the external
+              #   LLM endpoint. Defaults to false. The chat completion request includes a
+              #   top-level `extra_metadata` object when dynamic variables are available. For
+              #   example:
+              #   `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
               #
               #   @return [Boolean, nil]
               optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -370,7 +370,7 @@ module Telnyx
               #
               #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
               #
-              #   @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
+              #   @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
               #
               #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
               #

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

@@ -236,11 +236,11 @@ module Telnyx
           optional :certificate_ref, String
           # @!attribute forward_metadata
-          #   When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-          #   external LLM endpoint. Defaults to false. The external endpoint receives the
-          #   standard chat completions payload with top-level `metadata` and
-          #   `dynamic_variables` objects when values are available. For example:
-          #   `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+          #   When enabled, Telnyx forwards the assistant's dynamic variables to the external
+          #   LLM endpoint. Defaults to false. The chat completion request includes a
+          #   top-level `extra_metadata` object when dynamic variables are available. For
+          #   example:
+          #   `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
           #
           #   @return [Boolean, nil]
           optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -269,7 +269,7 @@ module Telnyx
           #
           #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
           #
-          #   @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
+          #   @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
           #
           #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
           #
@@ -348,11 +348,11 @@ module Telnyx
             optional :certificate_ref, String
             # @!attribute forward_metadata
-            #   When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-            #   external LLM endpoint. Defaults to false. The external endpoint receives the
-            #   standard chat completions payload with top-level `metadata` and
-            #   `dynamic_variables` objects when values are available. For example:
-            #   `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+            #   When enabled, Telnyx forwards the assistant's dynamic variables to the external
+            #   LLM endpoint. Defaults to false. The chat completion request includes a
+            #   top-level `extra_metadata` object when dynamic variables are available. For
+            #   example:
+            #   `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
             #
             #   @return [Boolean, nil]
             optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -382,7 +382,7 @@ module Telnyx
             #
             #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
             #
-            #   @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
+            #   @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
             #
             #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
             #

data/lib/telnyx/models/call_assistant_request.rb CHANGED Viewed

@@ -174,11 +174,11 @@ module Telnyx
         optional :certificate_ref, String
         # @!attribute forward_metadata
-        #   When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-        #   external LLM endpoint. Defaults to false. The external endpoint receives the
-        #   standard chat completions payload with top-level `metadata` and
-        #   `dynamic_variables` objects when values are available. For example:
-        #   `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+        #   When enabled, Telnyx forwards the assistant's dynamic variables to the external
+        #   LLM endpoint. Defaults to false. The chat completion request includes a
+        #   top-level `extra_metadata` object when dynamic variables are available. For
+        #   example:
+        #   `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
         #
         #   @return [Boolean, nil]
         optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -213,7 +213,7 @@ module Telnyx
         #
         #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
         #
-        #   @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
+        #   @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
         #
         #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
         #
@@ -291,11 +291,11 @@ module Telnyx
           optional :certificate_ref, String
           # @!attribute forward_metadata
-          #   When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-          #   external LLM endpoint. Defaults to false. The external endpoint receives the
-          #   standard chat completions payload with top-level `metadata` and
-          #   `dynamic_variables` objects when values are available. For example:
-          #   `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+          #   When enabled, Telnyx forwards the assistant's dynamic variables to the external
+          #   LLM endpoint. Defaults to false. The chat completion request includes a
+          #   top-level `extra_metadata` object when dynamic variables are available. For
+          #   example:
+          #   `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
           #
           #   @return [Boolean, nil]
           optional :forward_metadata, Telnyx::Internal::Type::Boolean
@@ -331,7 +331,7 @@ module Telnyx
           #
           #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
           #
-          #   @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
+          #   @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
           #
           #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
           #

data/lib/telnyx/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Telnyx
-  VERSION = "5.88.0"
+  VERSION = "5.89.0"
 end

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

@@ -438,11 +438,11 @@ module Telnyx
           sig { params(certificate_ref: String).void }
           attr_writer :certificate_ref
-          # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-          # external LLM endpoint. Defaults to false. The external endpoint receives the
-          # standard chat completions payload with top-level `metadata` and
-          # `dynamic_variables` objects when values are available. For example:
-          # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+          # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+          # LLM endpoint. Defaults to false. The chat completion request includes a
+          # top-level `extra_metadata` object when dynamic variables are available. For
+          # example:
+          # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :forward_metadata
@@ -485,11 +485,11 @@ module Telnyx
             # Integration secret identifier for the client certificate used with certificate
             # authentication.
             certificate_ref: nil,
-            # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-            # external LLM endpoint. Defaults to false. The external endpoint receives the
-            # standard chat completions payload with top-level `metadata` and
-            # `dynamic_variables` objects when values are available. For example:
-            # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+            # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+            # LLM endpoint. Defaults to false. The chat completion request includes a
+            # top-level `extra_metadata` object when dynamic variables are available. For
+            # example:
+            # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
             forward_metadata: nil,
             # Integration secret identifier for the external LLM API key.
             llm_api_key_ref: nil,
@@ -666,11 +666,11 @@ module Telnyx
             sig { params(certificate_ref: String).void }
             attr_writer :certificate_ref
-            # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-            # external LLM endpoint. Defaults to false. The external endpoint receives the
-            # standard chat completions payload with top-level `metadata` and
-            # `dynamic_variables` objects when values are available. For example:
-            # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+            # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+            # LLM endpoint. Defaults to false. The chat completion request includes a
+            # top-level `extra_metadata` object when dynamic variables are available. For
+            # example:
+            # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
             sig { returns(T.nilable(T::Boolean)) }
             attr_reader :forward_metadata
@@ -713,11 +713,11 @@ module Telnyx
               # Integration secret identifier for the client certificate used with certificate
               # authentication.
               certificate_ref: nil,
-              # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-              # external LLM endpoint. Defaults to false. The external endpoint receives the
-              # standard chat completions payload with top-level `metadata` and
-              # `dynamic_variables` objects when values are available. For example:
-              # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+              # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+              # LLM endpoint. Defaults to false. The chat completion request includes a
+              # top-level `extra_metadata` object when dynamic variables are available. For
+              # example:
+              # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
               forward_metadata: nil,
               # Integration secret identifier for the external LLM API key.
               llm_api_key_ref: nil,

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

@@ -466,11 +466,11 @@ module Telnyx
           sig { params(certificate_ref: String).void }
           attr_writer :certificate_ref
-          # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-          # external LLM endpoint. Defaults to false. The external endpoint receives the
-          # standard chat completions payload with top-level `metadata` and
-          # `dynamic_variables` objects when values are available. For example:
-          # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+          # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+          # LLM endpoint. Defaults to false. The chat completion request includes a
+          # top-level `extra_metadata` object when dynamic variables are available. For
+          # example:
+          # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :forward_metadata
@@ -513,11 +513,11 @@ module Telnyx
             # Integration secret identifier for the client certificate used with certificate
             # authentication.
             certificate_ref: nil,
-            # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-            # external LLM endpoint. Defaults to false. The external endpoint receives the
-            # standard chat completions payload with top-level `metadata` and
-            # `dynamic_variables` objects when values are available. For example:
-            # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+            # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+            # LLM endpoint. Defaults to false. The chat completion request includes a
+            # top-level `extra_metadata` object when dynamic variables are available. For
+            # example:
+            # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
             forward_metadata: nil,
             # Integration secret identifier for the external LLM API key.
             llm_api_key_ref: nil,
@@ -694,11 +694,11 @@ module Telnyx
             sig { params(certificate_ref: String).void }
             attr_writer :certificate_ref
-            # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-            # external LLM endpoint. Defaults to false. The external endpoint receives the
-            # standard chat completions payload with top-level `metadata` and
-            # `dynamic_variables` objects when values are available. For example:
-            # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+            # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+            # LLM endpoint. Defaults to false. The chat completion request includes a
+            # top-level `extra_metadata` object when dynamic variables are available. For
+            # example:
+            # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
             sig { returns(T.nilable(T::Boolean)) }
             attr_reader :forward_metadata
@@ -741,11 +741,11 @@ module Telnyx
               # Integration secret identifier for the client certificate used with certificate
               # authentication.
               certificate_ref: nil,
-              # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-              # external LLM endpoint. Defaults to false. The external endpoint receives the
-              # standard chat completions payload with top-level `metadata` and
-              # `dynamic_variables` objects when values are available. For example:
-              # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+              # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+              # LLM endpoint. Defaults to false. The chat completion request includes a
+              # top-level `extra_metadata` object when dynamic variables are available. For
+              # example:
+              # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
               forward_metadata: nil,
               # Integration secret identifier for the external LLM API key.
               llm_api_key_ref: nil,

data/rbi/telnyx/models/ai/assistants/update_assistant.rbi CHANGED Viewed

@@ -462,11 +462,11 @@ module Telnyx
             sig { params(certificate_ref: String).void }
             attr_writer :certificate_ref
-            # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-            # external LLM endpoint. Defaults to false. The external endpoint receives the
-            # standard chat completions payload with top-level `metadata` and
-            # `dynamic_variables` objects when values are available. For example:
-            # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+            # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+            # LLM endpoint. Defaults to false. The chat completion request includes a
+            # top-level `extra_metadata` object when dynamic variables are available. For
+            # example:
+            # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
             sig { returns(T.nilable(T::Boolean)) }
             attr_reader :forward_metadata
@@ -509,11 +509,11 @@ module Telnyx
               # Integration secret identifier for the client certificate used with certificate
               # authentication.
               certificate_ref: nil,
-              # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-              # external LLM endpoint. Defaults to false. The external endpoint receives the
-              # standard chat completions payload with top-level `metadata` and
-              # `dynamic_variables` objects when values are available. For example:
-              # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+              # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+              # LLM endpoint. Defaults to false. The chat completion request includes a
+              # top-level `extra_metadata` object when dynamic variables are available. For
+              # example:
+              # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
               forward_metadata: nil,
               # Integration secret identifier for the external LLM API key.
               llm_api_key_ref: nil,
@@ -690,11 +690,11 @@ module Telnyx
               sig { params(certificate_ref: String).void }
               attr_writer :certificate_ref
-              # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-              # external LLM endpoint. Defaults to false. The external endpoint receives the
-              # standard chat completions payload with top-level `metadata` and
-              # `dynamic_variables` objects when values are available. For example:
-              # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+              # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+              # LLM endpoint. Defaults to false. The chat completion request includes a
+              # top-level `extra_metadata` object when dynamic variables are available. For
+              # example:
+              # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
               sig { returns(T.nilable(T::Boolean)) }
               attr_reader :forward_metadata
@@ -737,11 +737,11 @@ module Telnyx
                 # Integration secret identifier for the client certificate used with certificate
                 # authentication.
                 certificate_ref: nil,
-                # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-                # external LLM endpoint. Defaults to false. The external endpoint receives the
-                # standard chat completions payload with top-level `metadata` and
-                # `dynamic_variables` objects when values are available. For example:
-                # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+                # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+                # LLM endpoint. Defaults to false. The chat completion request includes a
+                # top-level `extra_metadata` object when dynamic variables are available. For
+                # example:
+                # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
                 forward_metadata: nil,
                 # Integration secret identifier for the external LLM API key.
                 llm_api_key_ref: nil,

data/rbi/telnyx/models/ai/inference_embedding.rbi CHANGED Viewed

@@ -408,11 +408,11 @@ module Telnyx
           sig { params(certificate_ref: String).void }
           attr_writer :certificate_ref
-          # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-          # external LLM endpoint. Defaults to false. The external endpoint receives the
-          # standard chat completions payload with top-level `metadata` and
-          # `dynamic_variables` objects when values are available. For example:
-          # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+          # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+          # LLM endpoint. Defaults to false. The chat completion request includes a
+          # top-level `extra_metadata` object when dynamic variables are available. For
+          # example:
+          # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :forward_metadata
@@ -455,11 +455,11 @@ module Telnyx
             # Integration secret identifier for the client certificate used with certificate
             # authentication.
             certificate_ref: nil,
-            # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-            # external LLM endpoint. Defaults to false. The external endpoint receives the
-            # standard chat completions payload with top-level `metadata` and
-            # `dynamic_variables` objects when values are available. For example:
-            # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+            # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+            # LLM endpoint. Defaults to false. The chat completion request includes a
+            # top-level `extra_metadata` object when dynamic variables are available. For
+            # example:
+            # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
             forward_metadata: nil,
             # Integration secret identifier for the external LLM API key.
             llm_api_key_ref: nil,
@@ -636,11 +636,11 @@ module Telnyx
             sig { params(certificate_ref: String).void }
             attr_writer :certificate_ref
-            # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-            # external LLM endpoint. Defaults to false. The external endpoint receives the
-            # standard chat completions payload with top-level `metadata` and
-            # `dynamic_variables` objects when values are available. For example:
-            # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+            # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+            # LLM endpoint. Defaults to false. The chat completion request includes a
+            # top-level `extra_metadata` object when dynamic variables are available. For
+            # example:
+            # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
             sig { returns(T.nilable(T::Boolean)) }
             attr_reader :forward_metadata
@@ -683,11 +683,11 @@ module Telnyx
               # Integration secret identifier for the client certificate used with certificate
               # authentication.
               certificate_ref: nil,
-              # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-              # external LLM endpoint. Defaults to false. The external endpoint receives the
-              # standard chat completions payload with top-level `metadata` and
-              # `dynamic_variables` objects when values are available. For example:
-              # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+              # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+              # LLM endpoint. Defaults to false. The chat completion request includes a
+              # top-level `extra_metadata` object when dynamic variables are available. For
+              # example:
+              # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
               forward_metadata: nil,
               # Integration secret identifier for the external LLM API key.
               llm_api_key_ref: nil,

data/rbi/telnyx/models/call_assistant_request.rbi CHANGED Viewed

@@ -344,11 +344,11 @@ module Telnyx
         sig { params(certificate_ref: String).void }
         attr_writer :certificate_ref
-        # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-        # external LLM endpoint. Defaults to false. The external endpoint receives the
-        # standard chat completions payload with top-level `metadata` and
-        # `dynamic_variables` objects when values are available. For example:
-        # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+        # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+        # LLM endpoint. Defaults to false. The chat completion request includes a
+        # top-level `extra_metadata` object when dynamic variables are available. For
+        # example:
+        # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :forward_metadata
@@ -397,11 +397,11 @@ module Telnyx
           # Integration secret identifier for the client certificate used with certificate
           # authentication.
           certificate_ref: nil,
-          # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-          # external LLM endpoint. Defaults to false. The external endpoint receives the
-          # standard chat completions payload with top-level `metadata` and
-          # `dynamic_variables` objects when values are available. For example:
-          # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+          # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+          # LLM endpoint. Defaults to false. The chat completion request includes a
+          # top-level `extra_metadata` object when dynamic variables are available. For
+          # example:
+          # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
           forward_metadata: nil,
           # Integration secret identifier for the external LLM API key.
           llm_api_key_ref: nil,
@@ -580,11 +580,11 @@ module Telnyx
           sig { params(certificate_ref: String).void }
           attr_writer :certificate_ref
-          # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-          # external LLM endpoint. Defaults to false. The external endpoint receives the
-          # standard chat completions payload with top-level `metadata` and
-          # `dynamic_variables` objects when values are available. For example:
-          # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+          # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+          # LLM endpoint. Defaults to false. The chat completion request includes a
+          # top-level `extra_metadata` object when dynamic variables are available. For
+          # example:
+          # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :forward_metadata
@@ -633,11 +633,11 @@ module Telnyx
             # Integration secret identifier for the client certificate used with certificate
             # authentication.
             certificate_ref: nil,
-            # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
-            # external LLM endpoint. Defaults to false. The external endpoint receives the
-            # standard chat completions payload with top-level `metadata` and
-            # `dynamic_variables` objects when values are available. For example:
-            # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+            # When enabled, Telnyx forwards the assistant's dynamic variables to the external
+            # LLM endpoint. Defaults to false. The chat completion request includes a
+            # top-level `extra_metadata` object when dynamic variables are available. For
+            # example:
+            # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
             forward_metadata: nil,
             # Integration secret identifier for the external LLM API key.
             llm_api_key_ref: nil,

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telnyx
 version: !ruby/object:Gem::Version
-  version: 5.88.0
+  version: 5.89.0
 platform: ruby
 authors:
 - Telnyx