telnyx 5.63.0 → 5.65.0

data/rbi/telnyx/models/ai/tool_update_params.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class ToolUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::ToolUpdateParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :tool_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :display_name
+
+        sig { params(display_name: String).void }
+        attr_writer :display_name
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :function
+
+        sig { params(function: T::Hash[Symbol, T.anything]).void }
+        attr_writer :function
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :handoff
+
+        sig { params(handoff: T::Hash[Symbol, T.anything]).void }
+        attr_writer :handoff
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :invite
+
+        sig { params(invite: T::Hash[Symbol, T.anything]).void }
+        attr_writer :invite
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :retrieval
+
+        sig { params(retrieval: T::Hash[Symbol, T.anything]).void }
+        attr_writer :retrieval
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :timeout_ms
+
+        sig { params(timeout_ms: Integer).void }
+        attr_writer :timeout_ms
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :type
+
+        sig { params(type: String).void }
+        attr_writer :type
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :webhook
+
+        sig { params(webhook: T::Hash[Symbol, T.anything]).void }
+        attr_writer :webhook
+
+        sig do
+          params(
+            tool_id: String,
+            display_name: String,
+            function: T::Hash[Symbol, T.anything],
+            handoff: T::Hash[Symbol, T.anything],
+            invite: T::Hash[Symbol, T.anything],
+            retrieval: T::Hash[Symbol, T.anything],
+            timeout_ms: Integer,
+            type: String,
+            webhook: T::Hash[Symbol, T.anything],
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          tool_id:,
+          display_name: nil,
+          function: nil,
+          handoff: nil,
+          invite: nil,
+          retrieval: nil,
+          timeout_ms: nil,
+          type: nil,
+          webhook: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              tool_id: String,
+              display_name: String,
+              function: T::Hash[Symbol, T.anything],
+              handoff: T::Hash[Symbol, T.anything],
+              invite: T::Hash[Symbol, T.anything],
+              retrieval: T::Hash[Symbol, T.anything],
+              timeout_ms: Integer,
+              type: String,
+              webhook: T::Hash[Symbol, T.anything],
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tool_update_response.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class ToolUpdateResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::AI::ToolUpdateResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_accessor :tool_definition
+
+        sig { returns(String) }
+        attr_accessor :type
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_at
+
+        sig { params(created_at: String).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :display_name
+
+        sig { params(display_name: String).void }
+        attr_writer :display_name
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :timeout_ms
+
+        sig { params(timeout_ms: Integer).void }
+        attr_writer :timeout_ms
+
+        sig do
+          params(
+            id: String,
+            tool_definition: T::Hash[Symbol, T.anything],
+            type: String,
+            created_at: String,
+            display_name: String,
+            timeout_ms: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          tool_definition:,
+          type:,
+          created_at: nil,
+          display_name: nil,
+          timeout_ms: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              tool_definition: T::Hash[Symbol, T.anything],
+              type: String,
+              created_at: String,
+              display_name: String,
+              timeout_ms: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/assistants/tools.rbi

@@ -6,6 +6,28 @@ module Telnyx
       class Assistants
         # Configure AI assistant specifications
         class Tools
+          # Add Assistant Tool
+          sig do
+            params(
+              tool_id: String,
+              assistant_id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.anything)
+          end
+          def add(tool_id, assistant_id:, request_options: {})
+          end
+
+          # Remove Assistant Tool
+          sig do
+            params(
+              tool_id: String,
+              assistant_id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.anything)
+          end
+          def remove(tool_id, assistant_id:, request_options: {})
+          end
+
           # Test a webhook tool for an assistant
           sig do
             params(

data/rbi/telnyx/resources/ai/assistants/versions.rbi

@@ -45,6 +45,7 @@ module Telnyx
               name: String,
               privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
               telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
+              tool_ids: T::Array[String],
               tools:
                 T::Array[
                   T.any(
@@ -112,6 +113,8 @@ module Telnyx
             privacy_settings: nil,
             # Body param
             telephony_settings: nil,
+            # Body param
+            tool_ids: nil,
             # Body param: The tools that the assistant can use. These may be templated with
             # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
             tools: nil,

data/rbi/telnyx/resources/ai/assistants.rbi

@@ -45,6 +45,7 @@ module Telnyx
             messaging_settings: Telnyx::AI::MessagingSettings::OrHash,
             privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
             telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
+            tool_ids: T::Array[String],
             tools:
               T::Array[
                 T.any(
@@ -101,6 +102,7 @@ module Telnyx
           messaging_settings: nil,
           privacy_settings: nil,
           telephony_settings: nil,
+          tool_ids: nil,
           # The tools that the assistant can use. These may be templated with
           # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
           tools: nil,
@@ -151,6 +153,7 @@ module Telnyx
             privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
             promote_to_main: T::Boolean,
             telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
+            tool_ids: T::Array[String],
             tools:
               T::Array[
                 T.any(
@@ -211,6 +214,7 @@ module Telnyx
           # to true.
           promote_to_main: nil,
           telephony_settings: nil,
+          tool_ids: nil,
           # The tools that the assistant can use. These may be templated with
           # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
           tools: nil,

data/rbi/telnyx/resources/ai/tools.rbi

@@ -0,0 +1,114 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      # Configure AI assistant specifications
+      class Tools
+        # Create Tool
+        sig do
+          params(
+            display_name: String,
+            type: String,
+            function: T::Hash[Symbol, T.anything],
+            handoff: T::Hash[Symbol, T.anything],
+            invite: T::Hash[Symbol, T.anything],
+            retrieval: T::Hash[Symbol, T.anything],
+            timeout_ms: Integer,
+            webhook: T::Hash[Symbol, T.anything],
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::AI::ToolCreateResponse)
+        end
+        def create(
+          display_name:,
+          type:,
+          function: nil,
+          handoff: nil,
+          invite: nil,
+          retrieval: nil,
+          timeout_ms: nil,
+          webhook: nil,
+          request_options: {}
+        )
+        end
+
+        # Get Tool
+        sig do
+          params(
+            tool_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::AI::ToolRetrieveResponse)
+        end
+        def retrieve(tool_id, request_options: {})
+        end
+
+        # Update Tool
+        sig do
+          params(
+            tool_id: String,
+            display_name: String,
+            function: T::Hash[Symbol, T.anything],
+            handoff: T::Hash[Symbol, T.anything],
+            invite: T::Hash[Symbol, T.anything],
+            retrieval: T::Hash[Symbol, T.anything],
+            timeout_ms: Integer,
+            type: String,
+            webhook: T::Hash[Symbol, T.anything],
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::AI::ToolUpdateResponse)
+        end
+        def update(
+          tool_id,
+          display_name: nil,
+          function: nil,
+          handoff: nil,
+          invite: nil,
+          retrieval: nil,
+          timeout_ms: nil,
+          type: nil,
+          webhook: nil,
+          request_options: {}
+        )
+        end
+
+        # List Tools
+        sig do
+          params(
+            filter_name: String,
+            filter_type: String,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Internal::DefaultFlatPagination[
+              Telnyx::Models::AI::ToolListResponse
+            ]
+          )
+        end
+        def list(
+          filter_name: nil,
+          filter_type: nil,
+          page_number: nil,
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        # Delete Tool
+        sig do
+          params(
+            tool_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.anything)
+        end
+        def delete(tool_id, request_options: {})
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai.rbi

@@ -42,6 +42,10 @@ module Telnyx
       sig { returns(Telnyx::Resources::AI::OpenAI) }
       attr_reader :openai
 
+      # Configure AI assistant specifications
+      sig { returns(Telnyx::Resources::AI::Tools) }
+      attr_reader :tools
+
       # This endpoint returns a list of Open Source and OpenAI models that are available
       # for use. <br /><br /> **Note**: Model `id`'s will be in the form
       # `{source}/{model_name}`. For example `openai/gpt-4` or

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

@@ -16,6 +16,7 @@ module Telnyx
           messaging_settings: Telnyx::AI::MessagingSettings,
           privacy_settings: Telnyx::AI::PrivacySettings,
           telephony_settings: Telnyx::AI::TelephonySettings,
+          tool_ids: ::Array[String],
           tools: ::Array[Telnyx::Models::AI::assistant_tool],
           transcription: Telnyx::AI::TranscriptionSettings,
           voice_settings: Telnyx::AI::VoiceSettings,
@@ -83,6 +84,10 @@ module Telnyx
           Telnyx::AI::TelephonySettings
         ) -> Telnyx::AI::TelephonySettings
 
+        attr_reader tool_ids: ::Array[String]?
+
+        def tool_ids=: (::Array[String]) -> ::Array[String]
+
         attr_reader tools: ::Array[Telnyx::Models::AI::assistant_tool]?
 
         def tools=: (
@@ -121,6 +126,7 @@ module Telnyx
           ?messaging_settings: Telnyx::AI::MessagingSettings,
           ?privacy_settings: Telnyx::AI::PrivacySettings,
           ?telephony_settings: Telnyx::AI::TelephonySettings,
+          ?tool_ids: ::Array[String],
           ?tools: ::Array[Telnyx::Models::AI::assistant_tool],
           ?transcription: Telnyx::AI::TranscriptionSettings,
           ?voice_settings: Telnyx::AI::VoiceSettings,
@@ -142,6 +148,7 @@ module Telnyx
           messaging_settings: Telnyx::AI::MessagingSettings,
           privacy_settings: Telnyx::AI::PrivacySettings,
           telephony_settings: Telnyx::AI::TelephonySettings,
+          tool_ids: ::Array[String],
           tools: ::Array[Telnyx::Models::AI::assistant_tool],
           transcription: Telnyx::AI::TranscriptionSettings,
           voice_settings: Telnyx::AI::VoiceSettings,

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

@@ -18,6 +18,7 @@ module Telnyx
           privacy_settings: Telnyx::AI::PrivacySettings,
           promote_to_main: bool,
           telephony_settings: Telnyx::AI::TelephonySettings,
+          tool_ids: ::Array[String],
           tools: ::Array[Telnyx::Models::AI::assistant_tool],
           transcription: Telnyx::AI::TranscriptionSettings,
           voice_settings: Telnyx::AI::VoiceSettings,
@@ -97,6 +98,10 @@ module Telnyx
           Telnyx::AI::TelephonySettings
         ) -> Telnyx::AI::TelephonySettings
 
+        attr_reader tool_ids: ::Array[String]?
+
+        def tool_ids=: (::Array[String]) -> ::Array[String]
+
         attr_reader tools: ::Array[Telnyx::Models::AI::assistant_tool]?
 
         def tools=: (
@@ -137,6 +142,7 @@ module Telnyx
           ?privacy_settings: Telnyx::AI::PrivacySettings,
           ?promote_to_main: bool,
           ?telephony_settings: Telnyx::AI::TelephonySettings,
+          ?tool_ids: ::Array[String],
           ?tools: ::Array[Telnyx::Models::AI::assistant_tool],
           ?transcription: Telnyx::AI::TranscriptionSettings,
           ?voice_settings: Telnyx::AI::VoiceSettings,
@@ -160,6 +166,7 @@ module Telnyx
           privacy_settings: Telnyx::AI::PrivacySettings,
           promote_to_main: bool,
           telephony_settings: Telnyx::AI::TelephonySettings,
+          tool_ids: ::Array[String],
           tools: ::Array[Telnyx::Models::AI::assistant_tool],
           transcription: Telnyx::AI::TranscriptionSettings,
           voice_settings: Telnyx::AI::VoiceSettings,

data/sig/telnyx/models/ai/assistants/tool_add_params.rbs

@@ -0,0 +1,32 @@
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        type tool_add_params =
+          { assistant_id: String, tool_id: String }
+          & Telnyx::Internal::Type::request_parameters
+
+        class ToolAddParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          attr_accessor assistant_id: String
+
+          attr_accessor tool_id: String
+
+          def initialize: (
+            assistant_id: String,
+            tool_id: String,
+            ?request_options: Telnyx::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            assistant_id: String,
+            tool_id: String,
+            request_options: Telnyx::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/ai/assistants/tool_add_response.rbs

@@ -0,0 +1,9 @@
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        ToolAddResponse: Telnyx::Internal::Type::Converter
+      end
+    end
+  end
+end

data/sig/telnyx/models/ai/assistants/tool_remove_params.rbs

@@ -0,0 +1,32 @@
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        type tool_remove_params =
+          { assistant_id: String, tool_id: String }
+          & Telnyx::Internal::Type::request_parameters
+
+        class ToolRemoveParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          attr_accessor assistant_id: String
+
+          attr_accessor tool_id: String
+
+          def initialize: (
+            assistant_id: String,
+            tool_id: String,
+            ?request_options: Telnyx::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            assistant_id: String,
+            tool_id: String,
+            request_options: Telnyx::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/ai/assistants/tool_remove_response.rbs

@@ -0,0 +1,9 @@
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        ToolRemoveResponse: Telnyx::Internal::Type::Converter
+      end
+    end
+  end
+end

data/sig/telnyx/models/ai/assistants/update_assistant.rbs

@@ -19,6 +19,7 @@ module Telnyx
             name: String,
             privacy_settings: Telnyx::AI::PrivacySettings,
             telephony_settings: Telnyx::AI::TelephonySettings,
+            tool_ids: ::Array[String],
             tools: ::Array[Telnyx::Models::AI::assistant_tool],
             transcription: Telnyx::AI::TranscriptionSettings,
             voice_settings: Telnyx::AI::VoiceSettings,
@@ -88,6 +89,10 @@ module Telnyx
             Telnyx::AI::TelephonySettings
           ) -> Telnyx::AI::TelephonySettings
 
+          attr_reader tool_ids: ::Array[String]?
+
+          def tool_ids=: (::Array[String]) -> ::Array[String]
+
           attr_reader tools: ::Array[Telnyx::Models::AI::assistant_tool]?
 
           def tools=: (
@@ -126,6 +131,7 @@ module Telnyx
             ?name: String,
             ?privacy_settings: Telnyx::AI::PrivacySettings,
             ?telephony_settings: Telnyx::AI::TelephonySettings,
+            ?tool_ids: ::Array[String],
             ?tools: ::Array[Telnyx::Models::AI::assistant_tool],
             ?transcription: Telnyx::AI::TranscriptionSettings,
             ?voice_settings: Telnyx::AI::VoiceSettings,
@@ -146,6 +152,7 @@ module Telnyx
             name: String,
             privacy_settings: Telnyx::AI::PrivacySettings,
             telephony_settings: Telnyx::AI::TelephonySettings,
+            tool_ids: ::Array[String],
             tools: ::Array[Telnyx::Models::AI::assistant_tool],
             transcription: Telnyx::AI::TranscriptionSettings,
             voice_settings: Telnyx::AI::VoiceSettings,

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

@@ -43,6 +43,7 @@ module Telnyx
             http_method: Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook::method_,
             path_parameters: Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::PathParameters,
             query_parameters: Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::QueryParameters,
+            store_fields_as_variables: ::Array[Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable],
             timeout_ms: Integer
           }
 
@@ -87,6 +88,12 @@ module Telnyx
             Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::QueryParameters
           ) -> Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::QueryParameters
 
+          attr_reader store_fields_as_variables: ::Array[Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable]?
+
+          def store_fields_as_variables=: (
+            ::Array[Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable]
+          ) -> ::Array[Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable]
+
           attr_reader timeout_ms: Integer?
 
           def timeout_ms=: (Integer) -> Integer
@@ -101,6 +108,7 @@ module Telnyx
             ?http_method: Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook::method_,
             ?path_parameters: Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::PathParameters,
             ?query_parameters: Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::QueryParameters,
+            ?store_fields_as_variables: ::Array[Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable],
             ?timeout_ms: Integer
           ) -> void
 
@@ -114,6 +122,7 @@ module Telnyx
             http_method: Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook::method_,
             path_parameters: Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::PathParameters,
             query_parameters: Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::QueryParameters,
+            store_fields_as_variables: ::Array[Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable],
             timeout_ms: Integer
           }
 
@@ -281,6 +290,18 @@ module Telnyx
               def self?.values: -> ::Array[Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook::QueryParameters::type_]
             end
           end
+
+          type store_fields_as_variable = { name: String, value_path: String }
+
+          class StoreFieldsAsVariable < Telnyx::Internal::Type::BaseModel
+            attr_accessor name: String
+
+            attr_accessor value_path: String
+
+            def initialize: (name: String, value_path: String) -> void
+
+            def to_hash: -> { name: String, value_path: String }
+          end
         end
       end
     end