telnyx 5.98.0 → 5.99.0

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

@@ -82,27 +82,16 @@ module Telnyx
         end
         attr_writer :enabled_features
 
-        sig { returns(T.nilable(Telnyx::AI::InferenceEmbedding::ExternalLlm)) }
+        sig { returns(T.nilable(Telnyx::AI::ExternalLlm)) }
         attr_reader :external_llm
 
-        sig do
-          params(
-            external_llm: Telnyx::AI::InferenceEmbedding::ExternalLlm::OrHash
-          ).void
-        end
+        sig { params(external_llm: Telnyx::AI::ExternalLlm::OrHash).void }
         attr_writer :external_llm
 
-        sig do
-          returns(T.nilable(Telnyx::AI::InferenceEmbedding::FallbackConfig))
-        end
+        sig { returns(T.nilable(Telnyx::AI::FallbackConfig)) }
         attr_reader :fallback_config
 
-        sig do
-          params(
-            fallback_config:
-              Telnyx::AI::InferenceEmbedding::FallbackConfig::OrHash
-          ).void
-        end
+        sig { params(fallback_config: Telnyx::AI::FallbackConfig::OrHash).void }
         attr_writer :fallback_config
 
         # Text that the assistant will use to start the conversation. This may be
@@ -222,17 +211,13 @@ module Telnyx
         # can execute multiple parallel or sequential tools during this phase.
         # Telephony-control tools (e.g. hangup, transfer) are unavailable
         # post-conversation. Beta feature.
-        sig do
-          returns(
-            T.nilable(Telnyx::AI::InferenceEmbedding::PostConversationSettings)
-          )
-        end
+        sig { returns(T.nilable(Telnyx::AI::PostConversationSettings)) }
         attr_reader :post_conversation_settings
 
         sig do
           params(
             post_conversation_settings:
-              Telnyx::AI::InferenceEmbedding::PostConversationSettings::OrHash
+              Telnyx::AI::PostConversationSettings::OrHash
           ).void
         end
         attr_writer :post_conversation_settings
@@ -352,9 +337,8 @@ module Telnyx
             dynamic_variables_webhook_timeout_ms: Integer,
             dynamic_variables_webhook_url: String,
             enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol],
-            external_llm: Telnyx::AI::InferenceEmbedding::ExternalLlm::OrHash,
-            fallback_config:
-              Telnyx::AI::InferenceEmbedding::FallbackConfig::OrHash,
+            external_llm: Telnyx::AI::ExternalLlm::OrHash,
+            fallback_config: Telnyx::AI::FallbackConfig::OrHash,
             greeting: String,
             import_metadata: Telnyx::AI::ImportMetadata::OrHash,
             insight_settings: Telnyx::AI::InsightSettings::OrHash,
@@ -368,7 +352,7 @@ module Telnyx
             messaging_settings: Telnyx::AI::MessagingSettings::OrHash,
             observability_settings: Telnyx::AI::Observability::OrHash,
             post_conversation_settings:
-              Telnyx::AI::InferenceEmbedding::PostConversationSettings::OrHash,
+              Telnyx::AI::PostConversationSettings::OrHash,
             privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
             related_mission_ids: T::Array[String],
             tags: T::Array[String],
@@ -508,8 +492,8 @@ module Telnyx
               dynamic_variables_webhook_url: String,
               enabled_features:
                 T::Array[Telnyx::AI::EnabledFeatures::TaggedSymbol],
-              external_llm: Telnyx::AI::InferenceEmbedding::ExternalLlm,
-              fallback_config: Telnyx::AI::InferenceEmbedding::FallbackConfig,
+              external_llm: Telnyx::AI::ExternalLlm,
+              fallback_config: Telnyx::AI::FallbackConfig,
               greeting: String,
               import_metadata: Telnyx::AI::ImportMetadata,
               insight_settings: Telnyx::AI::InsightSettings,
@@ -521,8 +505,7 @@ module Telnyx
               mcp_servers: T::Array[Telnyx::AI::InferenceEmbedding::McpServer],
               messaging_settings: Telnyx::AI::MessagingSettings,
               observability_settings: Telnyx::AI::Observability,
-              post_conversation_settings:
-                Telnyx::AI::InferenceEmbedding::PostConversationSettings,
+              post_conversation_settings: Telnyx::AI::PostConversationSettings,
               privacy_settings: Telnyx::AI::PrivacySettings,
               related_mission_ids: T::Array[String],
               tags: T::Array[String],
@@ -540,399 +523,6 @@ module Telnyx
         def to_hash
         end
 
-        class ExternalLlm < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::AI::InferenceEmbedding::ExternalLlm,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          # Base URL for the external LLM endpoint.
-          sig { returns(String) }
-          attr_accessor :base_url
-
-          # Model identifier to use with the external LLM endpoint.
-          sig { returns(String) }
-          attr_accessor :model
-
-          # Authentication method used when connecting to the external LLM endpoint.
-          sig do
-            returns(
-              T.nilable(
-                Telnyx::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod::TaggedSymbol
-              )
-            )
-          end
-          attr_reader :authentication_method
-
-          sig do
-            params(
-              authentication_method:
-                Telnyx::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod::OrSymbol
-            ).void
-          end
-          attr_writer :authentication_method
-
-          # Integration secret identifier for the client certificate used with certificate
-          # authentication.
-          sig { returns(T.nilable(String)) }
-          attr_reader :certificate_ref
-
-          sig { params(certificate_ref: String).void }
-          attr_writer :certificate_ref
-
-          # 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.
-          sig { returns(T.nilable(T::Boolean)) }
-          attr_reader :forward_metadata
-
-          sig { params(forward_metadata: T::Boolean).void }
-          attr_writer :forward_metadata
-
-          # Integration secret identifier for the external LLM API key.
-          sig { returns(T.nilable(String)) }
-          attr_reader :llm_api_key_ref
-
-          sig { params(llm_api_key_ref: String).void }
-          attr_writer :llm_api_key_ref
-
-          # URL used to retrieve an access token when certificate authentication is enabled.
-          sig { returns(T.nilable(String)) }
-          attr_reader :token_retrieval_url
-
-          sig { params(token_retrieval_url: String).void }
-          attr_writer :token_retrieval_url
-
-          sig do
-            params(
-              base_url: String,
-              model: String,
-              authentication_method:
-                Telnyx::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod::OrSymbol,
-              certificate_ref: String,
-              forward_metadata: T::Boolean,
-              llm_api_key_ref: String,
-              token_retrieval_url: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Base URL for the external LLM endpoint.
-            base_url:,
-            # Model identifier to use with the external LLM endpoint.
-            model:,
-            # Authentication method used when connecting to the external LLM endpoint.
-            authentication_method: nil,
-            # Integration secret identifier for the client certificate used with certificate
-            # authentication.
-            certificate_ref: nil,
-            # 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.
-            forward_metadata: nil,
-            # Integration secret identifier for the external LLM API key.
-            llm_api_key_ref: nil,
-            # URL used to retrieve an access token when certificate authentication is enabled.
-            token_retrieval_url: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                base_url: String,
-                model: String,
-                authentication_method:
-                  Telnyx::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod::TaggedSymbol,
-                certificate_ref: String,
-                forward_metadata: T::Boolean,
-                llm_api_key_ref: String,
-                token_retrieval_url: String
-              }
-            )
-          end
-          def to_hash
-          end
-
-          # Authentication method used when connecting to the external LLM endpoint.
-          module AuthenticationMethod
-            extend Telnyx::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  Telnyx::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            TOKEN =
-              T.let(
-                :token,
-                Telnyx::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod::TaggedSymbol
-              )
-            CERTIFICATE =
-              T.let(
-                :certificate,
-                Telnyx::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  Telnyx::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-
-        class FallbackConfig < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::AI::InferenceEmbedding::FallbackConfig,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          sig do
-            returns(
-              T.nilable(
-                Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm
-              )
-            )
-          end
-          attr_reader :external_llm
-
-          sig do
-            params(
-              external_llm:
-                Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::OrHash
-            ).void
-          end
-          attr_writer :external_llm
-
-          # Integration secret identifier for the fallback model API key.
-          sig { returns(T.nilable(String)) }
-          attr_reader :llm_api_key_ref
-
-          sig { params(llm_api_key_ref: String).void }
-          attr_writer :llm_api_key_ref
-
-          # Fallback Telnyx-hosted model to use when the primary LLM provider is
-          # unavailable.
-          sig { returns(T.nilable(String)) }
-          attr_reader :model
-
-          sig { params(model: String).void }
-          attr_writer :model
-
-          sig do
-            params(
-              external_llm:
-                Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::OrHash,
-              llm_api_key_ref: String,
-              model: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            external_llm: nil,
-            # Integration secret identifier for the fallback model API key.
-            llm_api_key_ref: nil,
-            # Fallback Telnyx-hosted model to use when the primary LLM provider is
-            # unavailable.
-            model: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                external_llm:
-                  Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm,
-                llm_api_key_ref: String,
-                model: String
-              }
-            )
-          end
-          def to_hash
-          end
-
-          class ExternalLlm < Telnyx::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm,
-                  Telnyx::Internal::AnyHash
-                )
-              end
-
-            # Base URL for the external LLM endpoint.
-            sig { returns(String) }
-            attr_accessor :base_url
-
-            # Model identifier to use with the external LLM endpoint.
-            sig { returns(String) }
-            attr_accessor :model
-
-            # Authentication method used when connecting to the external LLM endpoint.
-            sig do
-              returns(
-                T.nilable(
-                  Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod::TaggedSymbol
-                )
-              )
-            end
-            attr_reader :authentication_method
-
-            sig do
-              params(
-                authentication_method:
-                  Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod::OrSymbol
-              ).void
-            end
-            attr_writer :authentication_method
-
-            # Integration secret identifier for the client certificate used with certificate
-            # authentication.
-            sig { returns(T.nilable(String)) }
-            attr_reader :certificate_ref
-
-            sig { params(certificate_ref: String).void }
-            attr_writer :certificate_ref
-
-            # 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.
-            sig { returns(T.nilable(T::Boolean)) }
-            attr_reader :forward_metadata
-
-            sig { params(forward_metadata: T::Boolean).void }
-            attr_writer :forward_metadata
-
-            # Integration secret identifier for the external LLM API key.
-            sig { returns(T.nilable(String)) }
-            attr_reader :llm_api_key_ref
-
-            sig { params(llm_api_key_ref: String).void }
-            attr_writer :llm_api_key_ref
-
-            # URL used to retrieve an access token when certificate authentication is enabled.
-            sig { returns(T.nilable(String)) }
-            attr_reader :token_retrieval_url
-
-            sig { params(token_retrieval_url: String).void }
-            attr_writer :token_retrieval_url
-
-            sig do
-              params(
-                base_url: String,
-                model: String,
-                authentication_method:
-                  Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod::OrSymbol,
-                certificate_ref: String,
-                forward_metadata: T::Boolean,
-                llm_api_key_ref: String,
-                token_retrieval_url: String
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              # Base URL for the external LLM endpoint.
-              base_url:,
-              # Model identifier to use with the external LLM endpoint.
-              model:,
-              # Authentication method used when connecting to the external LLM endpoint.
-              authentication_method: nil,
-              # Integration secret identifier for the client certificate used with certificate
-              # authentication.
-              certificate_ref: nil,
-              # 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.
-              forward_metadata: nil,
-              # Integration secret identifier for the external LLM API key.
-              llm_api_key_ref: nil,
-              # URL used to retrieve an access token when certificate authentication is enabled.
-              token_retrieval_url: nil
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  base_url: String,
-                  model: String,
-                  authentication_method:
-                    Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod::TaggedSymbol,
-                  certificate_ref: String,
-                  forward_metadata: T::Boolean,
-                  llm_api_key_ref: String,
-                  token_retrieval_url: String
-                }
-              )
-            end
-            def to_hash
-            end
-
-            # Authentication method used when connecting to the external LLM endpoint.
-            module AuthenticationMethod
-              extend Telnyx::Internal::Type::Enum
-
-              TaggedSymbol =
-                T.type_alias do
-                  T.all(
-                    Symbol,
-                    Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod
-                  )
-                end
-              OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-              TOKEN =
-                T.let(
-                  :token,
-                  Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod::TaggedSymbol
-                )
-              CERTIFICATE =
-                T.let(
-                  :certificate,
-                  Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod::TaggedSymbol
-                )
-
-              sig do
-                override.returns(
-                  T::Array[
-                    Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod::TaggedSymbol
-                  ]
-                )
-              end
-              def self.values
-              end
-            end
-          end
-        end
-
         class Integration < Telnyx::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -1245,44 +835,6 @@ module Telnyx
           def to_hash
           end
         end
-
-        class PostConversationSettings < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::AI::InferenceEmbedding::PostConversationSettings,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          # 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.
-          sig { returns(T.nilable(T::Boolean)) }
-          attr_reader :enabled
-
-          sig { params(enabled: T::Boolean).void }
-          attr_writer :enabled
-
-          # 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.
-          sig { params(enabled: T::Boolean).returns(T.attached_class) }
-          def self.new(
-            # 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.
-            enabled: nil
-          )
-          end
-
-          sig { override.returns({ enabled: T::Boolean }) }
-          def to_hash
-          end
-        end
       end
     end
   end

data/rbi/telnyx/models/ai/post_conversation_settings.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class PostConversationSettings < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AI::PostConversationSettings,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # 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.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :enabled
+
+        sig { params(enabled: T::Boolean).void }
+        attr_writer :enabled
+
+        # 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.
+        sig { params(enabled: T::Boolean).returns(T.attached_class) }
+        def self.new(
+          # 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.
+          enabled: nil
+        )
+        end
+
+        sig { override.returns({ enabled: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class PostConversationSettingsReq < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AI::PostConversationSettingsReq,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # 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.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :enabled
+
+        sig { params(enabled: T::Boolean).void }
+        attr_writer :enabled
+
+        # 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.
+        sig { params(enabled: T::Boolean).returns(T.attached_class) }
+        def self.new(
+          # 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.
+          enabled: nil
+        )
+        end
+
+        sig { override.returns({ enabled: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end