telnyx 5.162.0 → 5.164.0

data/sig/telnyx/models/ai/knowledge/collection_retrieve_documents_params.rbs

@@ -0,0 +1,93 @@
+module Telnyx
+  module Models
+    module AI
+      module Knowledge
+        type collection_retrieve_documents_params =
+          {
+            slug: String,
+            filter: ::Hash[Symbol, top],
+            page_number: Integer,
+            page_size: Integer,
+            query: String,
+            retrieval_type: Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams::retrieval_type,
+            sources: String,
+            top_k: Integer
+          }
+          & Telnyx::Internal::Type::request_parameters
+
+        class CollectionRetrieveDocumentsParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          attr_accessor slug: String
+
+          attr_reader filter: ::Hash[Symbol, top]?
+
+          def filter=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+          attr_reader page_number: Integer?
+
+          def page_number=: (Integer) -> Integer
+
+          attr_reader page_size: Integer?
+
+          def page_size=: (Integer) -> Integer
+
+          attr_reader query: String?
+
+          def query=: (String) -> String
+
+          attr_reader retrieval_type: Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams::retrieval_type?
+
+          def retrieval_type=: (
+            Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams::retrieval_type
+          ) -> Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams::retrieval_type
+
+          attr_reader sources: String?
+
+          def sources=: (String) -> String
+
+          attr_reader top_k: Integer?
+
+          def top_k=: (Integer) -> Integer
+
+          def initialize: (
+            slug: String,
+            ?filter: ::Hash[Symbol, top],
+            ?page_number: Integer,
+            ?page_size: Integer,
+            ?query: String,
+            ?retrieval_type: Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams::retrieval_type,
+            ?sources: String,
+            ?top_k: Integer,
+            ?request_options: Telnyx::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            slug: String,
+            filter: ::Hash[Symbol, top],
+            page_number: Integer,
+            page_size: Integer,
+            query: String,
+            retrieval_type: Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams::retrieval_type,
+            sources: String,
+            top_k: Integer,
+            request_options: Telnyx::RequestOptions
+          }
+
+          type retrieval_type = :vector | :hybrid | :keyword
+
+          module RetrievalType
+            extend Telnyx::Internal::Type::Enum
+
+            VECTOR: :vector
+            HYBRID: :hybrid
+            KEYWORD: :keyword
+
+            def self?.values: -> ::Array[Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsParams::retrieval_type]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/ai/knowledge/collection_retrieve_documents_response.rbs

@@ -0,0 +1,208 @@
+module Telnyx
+  module Models
+    module AI
+      module Knowledge
+        type collection_retrieve_documents_response =
+          {
+            data: ::Array[Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data],
+            meta: Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta
+          }
+
+        class CollectionRetrieveDocumentsResponse < Telnyx::Internal::Type::BaseModel
+          attr_reader data: ::Array[Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data]?
+
+          def data=: (
+            ::Array[Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data]
+          ) -> ::Array[Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data]
+
+          attr_reader meta: Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta?
+
+          def meta=: (
+            Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta
+          ) -> Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta
+
+          def initialize: (
+            ?data: ::Array[Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data],
+            ?meta: Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta
+          ) -> void
+
+          def to_hash: -> {
+            data: ::Array[Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data],
+            meta: Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta
+          }
+
+          type data =
+            {
+              id: String,
+              chunk_index: Integer,
+              chunk_total: Integer,
+              ingested_at: Time,
+              metadata: ::Hash[Symbol, top],
+              organization_id: String,
+              record_created_at: Time,
+              record_id: String,
+              record_type: String,
+              region: String,
+              score: Float,
+              text: String,
+              user_id: String
+            }
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            attr_reader id: String?
+
+            def id=: (String) -> String
+
+            attr_reader chunk_index: Integer?
+
+            def chunk_index=: (Integer) -> Integer
+
+            attr_reader chunk_total: Integer?
+
+            def chunk_total=: (Integer) -> Integer
+
+            attr_reader ingested_at: Time?
+
+            def ingested_at=: (Time) -> Time
+
+            attr_reader metadata: ::Hash[Symbol, top]?
+
+            def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+            attr_reader organization_id: String?
+
+            def organization_id=: (String) -> String
+
+            attr_reader record_created_at: Time?
+
+            def record_created_at=: (Time) -> Time
+
+            attr_reader record_id: String?
+
+            def record_id=: (String) -> String
+
+            attr_reader record_type: String?
+
+            def record_type=: (String) -> String
+
+            attr_reader region: String?
+
+            def region=: (String) -> String
+
+            attr_reader score: Float?
+
+            def score=: (Float) -> Float
+
+            attr_reader text: String?
+
+            def text=: (String) -> String
+
+            attr_reader user_id: String?
+
+            def user_id=: (String) -> String
+
+            def initialize: (
+              ?id: String,
+              ?chunk_index: Integer,
+              ?chunk_total: Integer,
+              ?ingested_at: Time,
+              ?metadata: ::Hash[Symbol, top],
+              ?organization_id: String,
+              ?record_created_at: Time,
+              ?record_id: String,
+              ?record_type: String,
+              ?region: String,
+              ?score: Float,
+              ?text: String,
+              ?user_id: String
+            ) -> void
+
+            def to_hash: -> {
+              id: String,
+              chunk_index: Integer,
+              chunk_total: Integer,
+              ingested_at: Time,
+              metadata: ::Hash[Symbol, top],
+              organization_id: String,
+              record_created_at: Time,
+              record_id: String,
+              record_type: String,
+              region: String,
+              score: Float,
+              text: String,
+              user_id: String
+            }
+          end
+
+          type meta =
+            {
+              collection_slug: String,
+              page_number: Integer,
+              page_size: Integer,
+              retrieval_type: String,
+              searched_sources: ::Array[String],
+              top_k: Integer,
+              total_pages: Integer,
+              total_results: Integer
+            }
+
+          class Meta < Telnyx::Internal::Type::BaseModel
+            attr_reader collection_slug: String?
+
+            def collection_slug=: (String) -> String
+
+            attr_reader page_number: Integer?
+
+            def page_number=: (Integer) -> Integer
+
+            attr_reader page_size: Integer?
+
+            def page_size=: (Integer) -> Integer
+
+            attr_reader retrieval_type: String?
+
+            def retrieval_type=: (String) -> String
+
+            attr_reader searched_sources: ::Array[String]?
+
+            def searched_sources=: (::Array[String]) -> ::Array[String]
+
+            attr_reader top_k: Integer?
+
+            def top_k=: (Integer) -> Integer
+
+            attr_reader total_pages: Integer?
+
+            def total_pages=: (Integer) -> Integer
+
+            attr_reader total_results: Integer?
+
+            def total_results=: (Integer) -> Integer
+
+            def initialize: (
+              ?collection_slug: String,
+              ?page_number: Integer,
+              ?page_size: Integer,
+              ?retrieval_type: String,
+              ?searched_sources: ::Array[String],
+              ?top_k: Integer,
+              ?total_pages: Integer,
+              ?total_results: Integer
+            ) -> void
+
+            def to_hash: -> {
+              collection_slug: String,
+              page_number: Integer,
+              page_size: Integer,
+              retrieval_type: String,
+              searched_sources: ::Array[String],
+              top_k: Integer,
+              total_pages: Integer,
+              total_results: Integer
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,8 @@ module Telnyx
           type: String,
           url: String,
           allowed_tools: ::Array[String]?,
-          api_key_ref: String?
+          api_key_ref: String?,
+          idempotency_key: String
         }
         & Telnyx::Internal::Type::request_parameters
 
@@ -25,12 +26,17 @@ module Telnyx
 
         attr_accessor api_key_ref: String?
 
+        attr_reader idempotency_key: String?
+
+        def idempotency_key=: (String) -> String
+
         def initialize: (
           name: String,
           type: String,
           url: String,
           ?allowed_tools: ::Array[String]?,
           ?api_key_ref: String?,
+          ?idempotency_key: String,
           ?request_options: Telnyx::request_opts
         ) -> void
 
@@ -40,6 +46,7 @@ module Telnyx
           url: String,
           allowed_tools: ::Array[String]?,
           api_key_ref: String?,
+          idempotency_key: String,
           request_options: Telnyx::RequestOptions
         }
       end

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

@@ -7,6 +7,7 @@ module Telnyx
           input: ::Hash[Symbol, top],
           instructions: String,
           model: String,
+          reasoning: Telnyx::AI::OpenAICreateResponseParams::Reasoning,
           service_tier: String,
           stream: bool
         }
@@ -32,6 +33,12 @@ module Telnyx
 
         def model=: (String) -> String
 
+        attr_reader reasoning: Telnyx::AI::OpenAICreateResponseParams::Reasoning?
+
+        def reasoning=: (
+          Telnyx::AI::OpenAICreateResponseParams::Reasoning
+        ) -> Telnyx::AI::OpenAICreateResponseParams::Reasoning
+
         attr_reader service_tier: String?
 
         def service_tier=: (String) -> String
@@ -45,6 +52,7 @@ module Telnyx
           ?input: ::Hash[Symbol, top],
           ?instructions: String,
           ?model: String,
+          ?reasoning: Telnyx::AI::OpenAICreateResponseParams::Reasoning,
           ?service_tier: String,
           ?stream: bool,
           ?request_options: Telnyx::request_opts
@@ -55,10 +63,49 @@ module Telnyx
           input: ::Hash[Symbol, top],
           instructions: String,
           model: String,
+          reasoning: Telnyx::AI::OpenAICreateResponseParams::Reasoning,
           service_tier: String,
           stream: bool,
           request_options: Telnyx::RequestOptions
         }
+
+        type reasoning =
+          {
+            effort: Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning::effort
+          }
+
+        class Reasoning < Telnyx::Internal::Type::BaseModel
+          attr_reader effort: Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning::effort?
+
+          def effort=: (
+            Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning::effort
+          ) -> Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning::effort
+
+          def initialize: (
+            ?effort: Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning::effort
+          ) -> void
+
+          def to_hash: -> {
+            effort: Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning::effort
+          }
+
+          type effort =
+            :none | :minimal | :low | :medium | :high | :xhigh | :max
+
+          module Effort
+            extend Telnyx::Internal::Type::Enum
+
+            NONE: :none
+            MINIMAL: :minimal
+            LOW: :low
+            MEDIUM: :medium
+            HIGH: :high
+            XHIGH: :xhigh
+            MAX: :max
+
+            def self?.values: -> ::Array[Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning::effort]
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,60 @@
+module Telnyx
+  module Models
+    module AI
+      type speak_node =
+        {
+          id: String,
+          message: String,
+          name: String,
+          position: Telnyx::AI::NodePosition,
+          type: Telnyx::Models::AI::SpeakNode::type_
+        }
+
+      class SpeakNode < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor message: String
+
+        attr_reader name: String?
+
+        def name=: (String) -> String
+
+        attr_reader position: Telnyx::AI::NodePosition?
+
+        def position=: (Telnyx::AI::NodePosition) -> Telnyx::AI::NodePosition
+
+        attr_reader type: Telnyx::Models::AI::SpeakNode::type_?
+
+        def type=: (
+          Telnyx::Models::AI::SpeakNode::type_
+        ) -> Telnyx::Models::AI::SpeakNode::type_
+
+        def initialize: (
+          id: String,
+          message: String,
+          ?name: String,
+          ?position: Telnyx::AI::NodePosition,
+          ?type: Telnyx::Models::AI::SpeakNode::type_
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          message: String,
+          name: String,
+          position: Telnyx::AI::NodePosition,
+          type: Telnyx::Models::AI::SpeakNode::type_
+        }
+
+        type type_ = :speak
+
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          SPEAK: :speak
+
+          def self?.values: -> ::Array[Telnyx::Models::AI::SpeakNode::type_]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+module Telnyx
+  module Models
+    module AI
+      type speak_node_req =
+        {
+          id: String,
+          message: String,
+          name: String,
+          position: Telnyx::AI::NodePosition,
+          type: Telnyx::Models::AI::SpeakNodeReq::type_
+        }
+
+      class SpeakNodeReq < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor message: String
+
+        attr_reader name: String?
+
+        def name=: (String) -> String
+
+        attr_reader position: Telnyx::AI::NodePosition?
+
+        def position=: (Telnyx::AI::NodePosition) -> Telnyx::AI::NodePosition
+
+        attr_reader type: Telnyx::Models::AI::SpeakNodeReq::type_?
+
+        def type=: (
+          Telnyx::Models::AI::SpeakNodeReq::type_
+        ) -> Telnyx::Models::AI::SpeakNodeReq::type_
+
+        def initialize: (
+          id: String,
+          message: String,
+          ?name: String,
+          ?position: Telnyx::AI::NodePosition,
+          ?type: Telnyx::Models::AI::SpeakNodeReq::type_
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          message: String,
+          name: String,
+          position: Telnyx::AI::NodePosition,
+          type: Telnyx::Models::AI::SpeakNodeReq::type_
+        }
+
+        type type_ = :speak
+
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          SPEAK: :speak
+
+          def self?.values: -> ::Array[Telnyx::Models::AI::SpeakNodeReq::type_]
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ module Telnyx
           noise_suppression: Telnyx::Models::AI::TelephonySettings::noise_suppression,
           noise_suppression_config: Telnyx::AI::TelephonySettings::NoiseSuppressionConfig,
           recording_settings: Telnyx::AI::TelephonySettings::RecordingSettings,
+          send_message_history_updates: bool,
           supports_unauthenticated_web_calls: bool,
           time_limit_secs: Integer,
           user_idle_reply_secs: Integer,
@@ -42,6 +43,10 @@ module Telnyx
           Telnyx::AI::TelephonySettings::RecordingSettings
         ) -> Telnyx::AI::TelephonySettings::RecordingSettings
 
+        attr_reader send_message_history_updates: bool?
+
+        def send_message_history_updates=: (bool) -> bool
+
         attr_reader supports_unauthenticated_web_calls: bool?
 
         def supports_unauthenticated_web_calls=: (bool) -> bool
@@ -70,6 +75,7 @@ module Telnyx
           ?noise_suppression: Telnyx::Models::AI::TelephonySettings::noise_suppression,
           ?noise_suppression_config: Telnyx::AI::TelephonySettings::NoiseSuppressionConfig,
           ?recording_settings: Telnyx::AI::TelephonySettings::RecordingSettings,
+          ?send_message_history_updates: bool,
           ?supports_unauthenticated_web_calls: bool,
           ?time_limit_secs: Integer,
           ?user_idle_reply_secs: Integer,
@@ -83,6 +89,7 @@ module Telnyx
           noise_suppression: Telnyx::Models::AI::TelephonySettings::noise_suppression,
           noise_suppression_config: Telnyx::AI::TelephonySettings::NoiseSuppressionConfig,
           recording_settings: Telnyx::AI::TelephonySettings::RecordingSettings,
+          send_message_history_updates: bool,
           supports_unauthenticated_web_calls: bool,
           time_limit_secs: Integer,
           user_idle_reply_secs: Integer,

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

@@ -13,7 +13,8 @@ module Telnyx
           retrieval: ::Hash[Symbol, top],
           timeout_ms: Integer,
           update_dynamic_variables: Telnyx::AI::UpdateDynamicVariablesToolParams,
-          webhook: ::Hash[Symbol, top]
+          webhook: ::Hash[Symbol, top],
+          idempotency_key: String
         }
         & Telnyx::Internal::Type::request_parameters
 
@@ -63,6 +64,10 @@ module Telnyx
 
         def webhook=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
 
+        attr_reader idempotency_key: String?
+
+        def idempotency_key=: (String) -> String
+
         def initialize: (
           display_name: String,
           type: String,
@@ -75,6 +80,7 @@ module Telnyx
           ?timeout_ms: Integer,
           ?update_dynamic_variables: Telnyx::AI::UpdateDynamicVariablesToolParams,
           ?webhook: ::Hash[Symbol, top],
+          ?idempotency_key: String,
           ?request_options: Telnyx::request_opts
         ) -> void
 
@@ -90,6 +96,7 @@ module Telnyx
           timeout_ms: Integer,
           update_dynamic_variables: Telnyx::AI::UpdateDynamicVariablesToolParams,
           webhook: ::Hash[Symbol, top],
+          idempotency_key: String,
           request_options: Telnyx::RequestOptions
         }
       end

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

@@ -0,0 +1,69 @@
+module Telnyx
+  module Models
+    module AI
+      type tool_node =
+        {
+          id: String,
+          shared_tool_id: String,
+          name: String,
+          position: Telnyx::AI::NodePosition,
+          tool: ::Array[Telnyx::Models::AI::assistant_tool],
+          type: Telnyx::Models::AI::ToolNode::type_
+        }
+
+      class ToolNode < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor shared_tool_id: String
+
+        attr_reader name: String?
+
+        def name=: (String) -> String
+
+        attr_reader position: Telnyx::AI::NodePosition?
+
+        def position=: (Telnyx::AI::NodePosition) -> Telnyx::AI::NodePosition
+
+        attr_reader tool: ::Array[Telnyx::Models::AI::assistant_tool]?
+
+        def tool=: (
+          ::Array[Telnyx::Models::AI::assistant_tool]
+        ) -> ::Array[Telnyx::Models::AI::assistant_tool]
+
+        attr_reader type: Telnyx::Models::AI::ToolNode::type_?
+
+        def type=: (
+          Telnyx::Models::AI::ToolNode::type_
+        ) -> Telnyx::Models::AI::ToolNode::type_
+
+        def initialize: (
+          id: String,
+          shared_tool_id: String,
+          ?name: String,
+          ?position: Telnyx::AI::NodePosition,
+          ?tool: ::Array[Telnyx::Models::AI::assistant_tool],
+          ?type: Telnyx::Models::AI::ToolNode::type_
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          shared_tool_id: String,
+          name: String,
+          position: Telnyx::AI::NodePosition,
+          tool: ::Array[Telnyx::Models::AI::assistant_tool],
+          type: Telnyx::Models::AI::ToolNode::type_
+        }
+
+        type type_ = :tool
+
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          TOOL: :tool
+
+          def self?.values: -> ::Array[Telnyx::Models::AI::ToolNode::type_]
+        end
+      end
+    end
+  end
+end