telnyx 5.98.0 → 5.99.0

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

@@ -45,13 +45,13 @@ module Telnyx
 
           # @!attribute external_llm
           #
-          #   @return [Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm, nil]
-          optional :external_llm, -> { Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm }
+          #   @return [Telnyx::Models::AI::ExternalLlmReq, nil]
+          optional :external_llm, -> { Telnyx::AI::ExternalLlmReq }
 
           # @!attribute fallback_config
           #
-          #   @return [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig, nil]
-          optional :fallback_config, -> { Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig }
+          #   @return [Telnyx::Models::AI::FallbackConfigReq, nil]
+          optional :fallback_config, -> { Telnyx::AI::FallbackConfigReq }
 
           # @!attribute greeting
           #   Text that the assistant will use to start the conversation. This may be
@@ -149,9 +149,8 @@ module Telnyx
           #   Telephony-control tools (e.g. hangup, transfer) are unavailable
           #   post-conversation. Beta feature.
           #
-          #   @return [Telnyx::Models::AI::Assistants::UpdateAssistant::PostConversationSettings, nil]
-          optional :post_conversation_settings,
-                   -> { Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings }
+          #   @return [Telnyx::Models::AI::PostConversationSettingsReq, nil]
+          optional :post_conversation_settings, -> { Telnyx::AI::PostConversationSettingsReq }
 
           # @!attribute privacy_settings
           #
@@ -221,9 +220,9 @@ module Telnyx
           #
           #   @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
           #
-          #   @param external_llm [Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm]
+          #   @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
           #
-          #   @param fallback_config [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig]
+          #   @param fallback_config [Telnyx::Models::AI::FallbackConfigReq]
           #
           #   @param greeting [String] Text that the assistant will use to start the conversation. This may be template
           #
@@ -247,7 +246,7 @@ module Telnyx
           #
           #   @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
           #
-          #   @param post_conversation_settings [Telnyx::Models::AI::Assistants::UpdateAssistant::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
+          #   @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Configuration for post-conversation processing. When enabled, the assistant rece
           #
           #   @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
           #
@@ -267,207 +266,6 @@ module Telnyx
           #
           #   @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
 
-          # @see Telnyx::Models::AI::Assistants::UpdateAssistant#external_llm
-          class ExternalLlm < Telnyx::Internal::Type::BaseModel
-            # @!attribute base_url
-            #   Base URL for the external LLM endpoint.
-            #
-            #   @return [String]
-            required :base_url, String
-
-            # @!attribute model
-            #   Model identifier to use with the external LLM endpoint.
-            #
-            #   @return [String]
-            required :model, String
-
-            # @!attribute authentication_method
-            #   Authentication method used when connecting to the external LLM endpoint.
-            #
-            #   @return [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod, nil]
-            optional :authentication_method,
-                     enum: -> { Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod }
-
-            # @!attribute certificate_ref
-            #   Integration secret identifier for the client certificate used with certificate
-            #   authentication.
-            #
-            #   @return [String, nil]
-            optional :certificate_ref, String
-
-            # @!attribute forward_metadata
-            #   When `true`, Telnyx forwards the assistant's dynamic variables to the external
-            #   LLM endpoint as a top-level `extra_metadata` object on the chat completion
-            #   request body. Defaults to `false`. Example payload sent to the external
-            #   endpoint:
-            #   `{"extra_metadata": {"customer_name": "Jane", "account_id": "acct_789", "telnyx_agent_target": "+13125550100", "telnyx_end_user_target": "+13125550123"}}`.
-            #   Distinct from OpenAI's native `metadata` field, which has its own size and type
-            #   limits.
-            #
-            #   @return [Boolean, nil]
-            optional :forward_metadata, Telnyx::Internal::Type::Boolean
-
-            # @!attribute llm_api_key_ref
-            #   Integration secret identifier for the external LLM API key.
-            #
-            #   @return [String, nil]
-            optional :llm_api_key_ref, String
-
-            # @!attribute token_retrieval_url
-            #   URL used to retrieve an access token when certificate authentication is enabled.
-            #
-            #   @return [String, nil]
-            optional :token_retrieval_url, String
-
-            # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm} for more details.
-            #
-            #   @param base_url [String] Base URL for the external LLM endpoint.
-            #
-            #   @param model [String] Model identifier to use with the external LLM endpoint.
-            #
-            #   @param authentication_method [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
-            #
-            #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
-            #
-            #   @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
-            #
-            #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
-            #
-            #   @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
-
-            # Authentication method used when connecting to the external LLM endpoint.
-            #
-            # @see Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm#authentication_method
-            module AuthenticationMethod
-              extend Telnyx::Internal::Type::Enum
-
-              TOKEN = :token
-              CERTIFICATE = :certificate
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-          end
-
-          # @see Telnyx::Models::AI::Assistants::UpdateAssistant#fallback_config
-          class FallbackConfig < Telnyx::Internal::Type::BaseModel
-            # @!attribute external_llm
-            #
-            #   @return [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm, nil]
-            optional :external_llm, -> { Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm }
-
-            # @!attribute llm_api_key_ref
-            #   Integration secret identifier for the fallback model API key.
-            #
-            #   @return [String, nil]
-            optional :llm_api_key_ref, String
-
-            # @!attribute model
-            #   Fallback Telnyx-hosted model to use when the primary LLM provider is
-            #   unavailable.
-            #
-            #   @return [String, nil]
-            optional :model, String
-
-            # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig} for more
-            #   details.
-            #
-            #   @param external_llm [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm]
-            #
-            #   @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
-            #
-            #   @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
-
-            # @see Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig#external_llm
-            class ExternalLlm < Telnyx::Internal::Type::BaseModel
-              # @!attribute base_url
-              #   Base URL for the external LLM endpoint.
-              #
-              #   @return [String]
-              required :base_url, String
-
-              # @!attribute model
-              #   Model identifier to use with the external LLM endpoint.
-              #
-              #   @return [String]
-              required :model, String
-
-              # @!attribute authentication_method
-              #   Authentication method used when connecting to the external LLM endpoint.
-              #
-              #   @return [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod, nil]
-              optional :authentication_method,
-                       enum: -> { Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod }
-
-              # @!attribute certificate_ref
-              #   Integration secret identifier for the client certificate used with certificate
-              #   authentication.
-              #
-              #   @return [String, nil]
-              optional :certificate_ref, String
-
-              # @!attribute forward_metadata
-              #   When `true`, Telnyx forwards the assistant's dynamic variables to the external
-              #   LLM endpoint as a top-level `extra_metadata` object on the chat completion
-              #   request body. Defaults to `false`. Example payload sent to the external
-              #   endpoint:
-              #   `{"extra_metadata": {"customer_name": "Jane", "account_id": "acct_789", "telnyx_agent_target": "+13125550100", "telnyx_end_user_target": "+13125550123"}}`.
-              #   Distinct from OpenAI's native `metadata` field, which has its own size and type
-              #   limits.
-              #
-              #   @return [Boolean, nil]
-              optional :forward_metadata, Telnyx::Internal::Type::Boolean
-
-              # @!attribute llm_api_key_ref
-              #   Integration secret identifier for the external LLM API key.
-              #
-              #   @return [String, nil]
-              optional :llm_api_key_ref, String
-
-              # @!attribute token_retrieval_url
-              #   URL used to retrieve an access token when certificate authentication is enabled.
-              #
-              #   @return [String, nil]
-              optional :token_retrieval_url, String
-
-              # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
-              #   Some parameter documentations has been truncated, see
-              #   {Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm}
-              #   for more details.
-              #
-              #   @param base_url [String] Base URL for the external LLM endpoint.
-              #
-              #   @param model [String] Model identifier to use with the external LLM endpoint.
-              #
-              #   @param authentication_method [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
-              #
-              #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
-              #
-              #   @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
-              #
-              #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
-              #
-              #   @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
-
-              # Authentication method used when connecting to the external LLM endpoint.
-              #
-              # @see Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm#authentication_method
-              module AuthenticationMethod
-                extend Telnyx::Internal::Type::Enum
-
-                TOKEN = :token
-                CERTIFICATE = :certificate
-
-                # @!method self.values
-                #   @return [Array<Symbol>]
-              end
-            end
-          end
-
           class Integration < Telnyx::Internal::Type::BaseModel
             # @!attribute integration_id
             #   Catalog integration ID to attach. This is the `id` from the integrations catalog
@@ -627,31 +425,6 @@ module Telnyx
             #
             #   @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
           end
-
-          # @see Telnyx::Models::AI::Assistants::UpdateAssistant#post_conversation_settings
-          class PostConversationSettings < Telnyx::Internal::Type::BaseModel
-            # @!attribute enabled
-            #   Whether post-conversation processing is enabled. When true, the assistant will
-            #   be invoked after the conversation ends to perform any final tool calls. Defaults
-            #   to false.
-            #
-            #   @return [Boolean, nil]
-            optional :enabled, Telnyx::Internal::Type::Boolean
-
-            # @!method initialize(enabled: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Telnyx::Models::AI::Assistants::UpdateAssistant::PostConversationSettings} for
-            #   more details.
-            #
-            #   Configuration for post-conversation processing. When enabled, the assistant
-            #   receives one additional LLM turn after the conversation ends, allowing it to
-            #   execute tool calls such as logging to a CRM or sending a summary. The assistant
-            #   can execute multiple parallel or sequential tools during this phase.
-            #   Telephony-control tools (e.g. hangup, transfer) are unavailable
-            #   post-conversation. Beta feature.
-            #
-            #   @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
-          end
         end
       end
 

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class ExternalLlm < Telnyx::Internal::Type::BaseModel
+        # @!attribute base_url
+        #   Base URL for the external LLM endpoint.
+        #
+        #   @return [String]
+        required :base_url, String
+
+        # @!attribute model
+        #   Model identifier to use with the external LLM endpoint.
+        #
+        #   @return [String]
+        required :model, String
+
+        # @!attribute authentication_method
+        #   Authentication method used when connecting to the external LLM endpoint.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::ExternalLlm::AuthenticationMethod, nil]
+        optional :authentication_method, enum: -> { Telnyx::AI::ExternalLlm::AuthenticationMethod }
+
+        # @!attribute certificate_ref
+        #   Integration secret identifier for the client certificate used with certificate
+        #   authentication.
+        #
+        #   @return [String, nil]
+        optional :certificate_ref, String
+
+        # @!attribute forward_metadata
+        #   When `true`, Telnyx forwards the assistant's dynamic variables to the external
+        #   LLM endpoint as a top-level `extra_metadata` object on the chat completion
+        #   request body. Defaults to `false`. Example payload sent to the external
+        #   endpoint:
+        #   `{"extra_metadata": {"customer_name": "Jane", "account_id": "acct_789", "telnyx_agent_target": "+13125550100", "telnyx_end_user_target": "+13125550123"}}`.
+        #   Distinct from OpenAI's native `metadata` field, which has its own size and type
+        #   limits.
+        #
+        #   @return [Boolean, nil]
+        optional :forward_metadata, Telnyx::Internal::Type::Boolean
+
+        # @!attribute llm_api_key_ref
+        #   Integration secret identifier for the external LLM API key.
+        #
+        #   @return [String, nil]
+        optional :llm_api_key_ref, String
+
+        # @!attribute token_retrieval_url
+        #   URL used to retrieve an access token when certificate authentication is enabled.
+        #
+        #   @return [String, nil]
+        optional :token_retrieval_url, String
+
+        # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::ExternalLlm} for more details.
+        #
+        #   @param base_url [String] Base URL for the external LLM endpoint.
+        #
+        #   @param model [String] Model identifier to use with the external LLM endpoint.
+        #
+        #   @param authentication_method [Symbol, Telnyx::Models::AI::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
+        #
+        #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
+        #
+        #   @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
+        #
+        #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
+        #
+        #   @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
+
+        # Authentication method used when connecting to the external LLM endpoint.
+        #
+        # @see Telnyx::Models::AI::ExternalLlm#authentication_method
+        module AuthenticationMethod
+          extend Telnyx::Internal::Type::Enum
+
+          TOKEN = :token
+          CERTIFICATE = :certificate
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class ExternalLlmReq < Telnyx::Internal::Type::BaseModel
+        # @!attribute base_url
+        #   Base URL for the external LLM endpoint.
+        #
+        #   @return [String]
+        required :base_url, String
+
+        # @!attribute model
+        #   Model identifier to use with the external LLM endpoint.
+        #
+        #   @return [String]
+        required :model, String
+
+        # @!attribute authentication_method
+        #   Authentication method used when connecting to the external LLM endpoint.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::ExternalLlmReq::AuthenticationMethod, nil]
+        optional :authentication_method, enum: -> { Telnyx::AI::ExternalLlmReq::AuthenticationMethod }
+
+        # @!attribute certificate_ref
+        #   Integration secret identifier for the client certificate used with certificate
+        #   authentication.
+        #
+        #   @return [String, nil]
+        optional :certificate_ref, String
+
+        # @!attribute forward_metadata
+        #   When `true`, Telnyx forwards the assistant's dynamic variables to the external
+        #   LLM endpoint as a top-level `extra_metadata` object on the chat completion
+        #   request body. Defaults to `false`. Example payload sent to the external
+        #   endpoint:
+        #   `{"extra_metadata": {"customer_name": "Jane", "account_id": "acct_789", "telnyx_agent_target": "+13125550100", "telnyx_end_user_target": "+13125550123"}}`.
+        #   Distinct from OpenAI's native `metadata` field, which has its own size and type
+        #   limits.
+        #
+        #   @return [Boolean, nil]
+        optional :forward_metadata, Telnyx::Internal::Type::Boolean
+
+        # @!attribute llm_api_key_ref
+        #   Integration secret identifier for the external LLM API key.
+        #
+        #   @return [String, nil]
+        optional :llm_api_key_ref, String
+
+        # @!attribute token_retrieval_url
+        #   URL used to retrieve an access token when certificate authentication is enabled.
+        #
+        #   @return [String, nil]
+        optional :token_retrieval_url, String
+
+        # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::ExternalLlmReq} for more details.
+        #
+        #   @param base_url [String] Base URL for the external LLM endpoint.
+        #
+        #   @param model [String] Model identifier to use with the external LLM endpoint.
+        #
+        #   @param authentication_method [Symbol, Telnyx::Models::AI::ExternalLlmReq::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
+        #
+        #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
+        #
+        #   @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
+        #
+        #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
+        #
+        #   @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
+
+        # Authentication method used when connecting to the external LLM endpoint.
+        #
+        # @see Telnyx::Models::AI::ExternalLlmReq#authentication_method
+        module AuthenticationMethod
+          extend Telnyx::Internal::Type::Enum
+
+          TOKEN = :token
+          CERTIFICATE = :certificate
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class FallbackConfig < Telnyx::Internal::Type::BaseModel
+        # @!attribute external_llm
+        #
+        #   @return [Telnyx::Models::AI::ExternalLlm, nil]
+        optional :external_llm, -> { Telnyx::AI::ExternalLlm }
+
+        # @!attribute llm_api_key_ref
+        #   Integration secret identifier for the fallback model API key.
+        #
+        #   @return [String, nil]
+        optional :llm_api_key_ref, String
+
+        # @!attribute model
+        #   Fallback Telnyx-hosted model to use when the primary LLM provider is
+        #   unavailable.
+        #
+        #   @return [String, nil]
+        optional :model, String
+
+        # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::FallbackConfig} for more details.
+        #
+        #   @param external_llm [Telnyx::Models::AI::ExternalLlm]
+        #
+        #   @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
+        #
+        #   @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class FallbackConfigReq < Telnyx::Internal::Type::BaseModel
+        # @!attribute external_llm
+        #
+        #   @return [Telnyx::Models::AI::ExternalLlmReq, nil]
+        optional :external_llm, -> { Telnyx::AI::ExternalLlmReq }
+
+        # @!attribute llm_api_key_ref
+        #   Integration secret identifier for the fallback model API key.
+        #
+        #   @return [String, nil]
+        optional :llm_api_key_ref, String
+
+        # @!attribute model
+        #   Fallback Telnyx-hosted model to use when the primary LLM provider is
+        #   unavailable.
+        #
+        #   @return [String, nil]
+        optional :model, String
+
+        # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::FallbackConfigReq} for more details.
+        #
+        #   @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
+        #
+        #   @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
+        #
+        #   @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
+      end
+    end
+  end
+end