telnyx 5.91.0 → 5.93.0

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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module AI
-      class PostConversationSettingsReq < 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::PostConversationSettingsReq} 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
-end

data/rbi/telnyx/models/ai/external_llm.rbi

@@ -1,157 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module AI
-      class ExternalLlm < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Telnyx::AI::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::ExternalLlm::AuthenticationMethod::TaggedSymbol
-            )
-          )
-        end
-        attr_reader :authentication_method
-
-        sig do
-          params(
-            authentication_method:
-              Telnyx::AI::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 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
-
-        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::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 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,
-          # 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::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::ExternalLlm::AuthenticationMethod)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          TOKEN =
-            T.let(
-              :token,
-              Telnyx::AI::ExternalLlm::AuthenticationMethod::TaggedSymbol
-            )
-          CERTIFICATE =
-            T.let(
-              :certificate,
-              Telnyx::AI::ExternalLlm::AuthenticationMethod::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Telnyx::AI::ExternalLlm::AuthenticationMethod::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/telnyx/models/ai/external_llm_req.rbi

@@ -1,157 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module AI
-      class ExternalLlmReq < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Telnyx::AI::ExternalLlmReq, 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::ExternalLlmReq::AuthenticationMethod::OrSymbol
-            )
-          )
-        end
-        attr_reader :authentication_method
-
-        sig do
-          params(
-            authentication_method:
-              Telnyx::AI::ExternalLlmReq::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 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
-
-        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::ExternalLlmReq::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 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,
-          # 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::ExternalLlmReq::AuthenticationMethod::OrSymbol,
-              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::ExternalLlmReq::AuthenticationMethod)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          TOKEN =
-            T.let(
-              :token,
-              Telnyx::AI::ExternalLlmReq::AuthenticationMethod::TaggedSymbol
-            )
-          CERTIFICATE =
-            T.let(
-              :certificate,
-              Telnyx::AI::ExternalLlmReq::AuthenticationMethod::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Telnyx::AI::ExternalLlmReq::AuthenticationMethod::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/telnyx/models/ai/fallback_config.rbi

@@ -1,64 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module AI
-      class FallbackConfig < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Telnyx::AI::FallbackConfig, Telnyx::Internal::AnyHash)
-          end
-
-        sig { returns(T.nilable(Telnyx::AI::ExternalLlm)) }
-        attr_reader :external_llm
-
-        sig { params(external_llm: Telnyx::AI::ExternalLlm::OrHash).void }
-        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::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::ExternalLlm,
-              llm_api_key_ref: String,
-              model: String
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/telnyx/models/ai/fallback_config_req.rbi

@@ -1,64 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module AI
-      class FallbackConfigReq < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Telnyx::AI::FallbackConfigReq, Telnyx::Internal::AnyHash)
-          end
-
-        sig { returns(T.nilable(Telnyx::AI::ExternalLlmReq)) }
-        attr_reader :external_llm
-
-        sig { params(external_llm: Telnyx::AI::ExternalLlmReq::OrHash).void }
-        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::ExternalLlmReq::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::ExternalLlmReq,
-              llm_api_key_ref: String,
-              model: String
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

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

@@ -1,45 +0,0 @@
-# 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

@@ -1,45 +0,0 @@
-# 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

data/sig/telnyx/models/ai/external_llm.rbs

@@ -1,75 +0,0 @@
-module Telnyx
-  module Models
-    module AI
-      type external_llm =
-        {
-          base_url: String,
-          model: String,
-          authentication_method: Telnyx::Models::AI::ExternalLlm::authentication_method,
-          certificate_ref: String,
-          forward_metadata: bool,
-          llm_api_key_ref: String,
-          token_retrieval_url: String
-        }
-
-      class ExternalLlm < Telnyx::Internal::Type::BaseModel
-        attr_accessor base_url: String
-
-        attr_accessor model: String
-
-        attr_reader authentication_method: Telnyx::Models::AI::ExternalLlm::authentication_method?
-
-        def authentication_method=: (
-          Telnyx::Models::AI::ExternalLlm::authentication_method
-        ) -> Telnyx::Models::AI::ExternalLlm::authentication_method
-
-        attr_reader certificate_ref: String?
-
-        def certificate_ref=: (String) -> String
-
-        attr_reader forward_metadata: bool?
-
-        def forward_metadata=: (bool) -> bool
-
-        attr_reader llm_api_key_ref: String?
-
-        def llm_api_key_ref=: (String) -> String
-
-        attr_reader token_retrieval_url: String?
-
-        def token_retrieval_url=: (String) -> String
-
-        def initialize: (
-          base_url: String,
-          model: String,
-          ?authentication_method: Telnyx::Models::AI::ExternalLlm::authentication_method,
-          ?certificate_ref: String,
-          ?forward_metadata: bool,
-          ?llm_api_key_ref: String,
-          ?token_retrieval_url: String
-        ) -> void
-
-        def to_hash: -> {
-          base_url: String,
-          model: String,
-          authentication_method: Telnyx::Models::AI::ExternalLlm::authentication_method,
-          certificate_ref: String,
-          forward_metadata: bool,
-          llm_api_key_ref: String,
-          token_retrieval_url: String
-        }
-
-        type authentication_method = :token | :certificate
-
-        module AuthenticationMethod
-          extend Telnyx::Internal::Type::Enum
-
-          TOKEN: :token
-          CERTIFICATE: :certificate
-
-          def self?.values: -> ::Array[Telnyx::Models::AI::ExternalLlm::authentication_method]
-        end
-      end
-    end
-  end
-end