telnyx 5.64.0 → 5.65.0

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/tool_create_params.rbs

@@ -0,0 +1,75 @@
+module Telnyx
+  module Models
+    module AI
+      type tool_create_params =
+        {
+          display_name: String,
+          type: String,
+          function: ::Hash[Symbol, top],
+          handoff: ::Hash[Symbol, top],
+          invite: ::Hash[Symbol, top],
+          retrieval: ::Hash[Symbol, top],
+          timeout_ms: Integer,
+          webhook: ::Hash[Symbol, top]
+        }
+        & Telnyx::Internal::Type::request_parameters
+
+      class ToolCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor display_name: String
+
+        attr_accessor type: String
+
+        attr_reader function: ::Hash[Symbol, top]?
+
+        def function=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader handoff: ::Hash[Symbol, top]?
+
+        def handoff=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader invite: ::Hash[Symbol, top]?
+
+        def invite=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader retrieval: ::Hash[Symbol, top]?
+
+        def retrieval=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader timeout_ms: Integer?
+
+        def timeout_ms=: (Integer) -> Integer
+
+        attr_reader webhook: ::Hash[Symbol, top]?
+
+        def webhook=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        def initialize: (
+          display_name: String,
+          type: String,
+          ?function: ::Hash[Symbol, top],
+          ?handoff: ::Hash[Symbol, top],
+          ?invite: ::Hash[Symbol, top],
+          ?retrieval: ::Hash[Symbol, top],
+          ?timeout_ms: Integer,
+          ?webhook: ::Hash[Symbol, top],
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          display_name: String,
+          type: String,
+          function: ::Hash[Symbol, top],
+          handoff: ::Hash[Symbol, top],
+          invite: ::Hash[Symbol, top],
+          retrieval: ::Hash[Symbol, top],
+          timeout_ms: Integer,
+          webhook: ::Hash[Symbol, top],
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module Telnyx
+  module Models
+    module AI
+      type tool_create_response =
+        {
+          id: String,
+          tool_definition: ::Hash[Symbol, top],
+          type: String,
+          created_at: String,
+          display_name: String,
+          timeout_ms: Integer
+        }
+
+      class ToolCreateResponse < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor tool_definition: ::Hash[Symbol, top]
+
+        attr_accessor type: String
+
+        attr_reader created_at: String?
+
+        def created_at=: (String) -> String
+
+        attr_reader display_name: String?
+
+        def display_name=: (String) -> String
+
+        attr_reader timeout_ms: Integer?
+
+        def timeout_ms=: (Integer) -> Integer
+
+        def initialize: (
+          id: String,
+          tool_definition: ::Hash[Symbol, top],
+          type: String,
+          ?created_at: String,
+          ?display_name: String,
+          ?timeout_ms: Integer
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          tool_definition: ::Hash[Symbol, top],
+          type: String,
+          created_at: String,
+          display_name: String,
+          timeout_ms: Integer
+        }
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,7 @@
+module Telnyx
+  module Models
+    module AI
+      ToolDeleteResponse: Telnyx::Internal::Type::Converter
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Telnyx
+  module Models
+    module AI
+      type tool_list_params =
+        {
+          filter_name: String,
+          filter_type: String,
+          page_number: Integer,
+          page_size: Integer
+        }
+        & Telnyx::Internal::Type::request_parameters
+
+      class ToolListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_reader filter_name: String?
+
+        def filter_name=: (String) -> String
+
+        attr_reader filter_type: String?
+
+        def filter_type=: (String) -> String
+
+        attr_reader page_number: Integer?
+
+        def page_number=: (Integer) -> Integer
+
+        attr_reader page_size: Integer?
+
+        def page_size=: (Integer) -> Integer
+
+        def initialize: (
+          ?filter_name: String,
+          ?filter_type: String,
+          ?page_number: Integer,
+          ?page_size: Integer,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          filter_name: String,
+          filter_type: String,
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module Telnyx
+  module Models
+    module AI
+      type tool_list_response =
+        {
+          id: String,
+          tool_definition: ::Hash[Symbol, top],
+          type: String,
+          created_at: String,
+          display_name: String,
+          timeout_ms: Integer
+        }
+
+      class ToolListResponse < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor tool_definition: ::Hash[Symbol, top]
+
+        attr_accessor type: String
+
+        attr_reader created_at: String?
+
+        def created_at=: (String) -> String
+
+        attr_reader display_name: String?
+
+        def display_name=: (String) -> String
+
+        attr_reader timeout_ms: Integer?
+
+        def timeout_ms=: (Integer) -> Integer
+
+        def initialize: (
+          id: String,
+          tool_definition: ::Hash[Symbol, top],
+          type: String,
+          ?created_at: String,
+          ?display_name: String,
+          ?timeout_ms: Integer
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          tool_definition: ::Hash[Symbol, top],
+          type: String,
+          created_at: String,
+          display_name: String,
+          timeout_ms: Integer
+        }
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,53 @@
+module Telnyx
+  module Models
+    module AI
+      type tool_retrieve_response =
+        {
+          id: String,
+          tool_definition: ::Hash[Symbol, top],
+          type: String,
+          created_at: String,
+          display_name: String,
+          timeout_ms: Integer
+        }
+
+      class ToolRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor tool_definition: ::Hash[Symbol, top]
+
+        attr_accessor type: String
+
+        attr_reader created_at: String?
+
+        def created_at=: (String) -> String
+
+        attr_reader display_name: String?
+
+        def display_name=: (String) -> String
+
+        attr_reader timeout_ms: Integer?
+
+        def timeout_ms=: (Integer) -> Integer
+
+        def initialize: (
+          id: String,
+          tool_definition: ::Hash[Symbol, top],
+          type: String,
+          ?created_at: String,
+          ?display_name: String,
+          ?timeout_ms: Integer
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          tool_definition: ::Hash[Symbol, top],
+          type: String,
+          created_at: String,
+          display_name: String,
+          timeout_ms: Integer
+        }
+      end
+    end
+  end
+end