telnyx 5.159.0 → 5.160.0

data/rbi/telnyx/resources/access_ip_ranges.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # IP Range Operations
     class AccessIPRanges
-      # Create new Access IP Range
+      # Create a new access IP range on your account.
       sig do
         params(
           cidr_block: String,
@@ -15,7 +15,7 @@ module Telnyx
       def create(cidr_block:, description: nil, request_options: {})
       end
 
-      # List all Access IP Ranges
+      # Retrieve a paginated list of access IP ranges configured on your account.
       sig do
         params(
           filter: Telnyx::AccessIPRangeListParams::Filter::OrHash,
@@ -38,7 +38,7 @@ module Telnyx
       )
       end
 
-      # Delete access IP ranges
+      # Delete an access IP range from your account.
       sig do
         params(
           access_ip_range_id: String,

data/rbi/telnyx/resources/addresses/actions.rbi

@@ -15,8 +15,9 @@ module Telnyx
       # immutable and cannot be altered once created. If you realize you need to alter
       # an address, a new record must be created with the differing address.
       class Actions
-        # Accepts this address suggestion as a new emergency address for Operator Connect
-        # and finishes the uploads of the numbers associated with it to Microsoft.
+        # Accept the validated address suggestion for this address, replacing the original
+        # values, and finish uploading the numbers associated with it to Microsoft for
+        # Operator Connect.
         sig do
           params(
             address_uuid: String,

data/rbi/telnyx/resources/advanced_orders.rbi

@@ -3,7 +3,8 @@
 module Telnyx
   module Resources
     class AdvancedOrders
-      # Create Advanced Order
+      # Creates an advanced number order from the requested order configuration. The
+      # response contains the resulting advanced order and its initial state.
       sig do
         params(
           area_code: String,
@@ -32,7 +33,8 @@ module Telnyx
       )
       end
 
-      # Get Advanced Order
+      # Returns the advanced number order identified by `order_id`, including its
+      # configuration and current state.
       sig do
         params(
           order_id: String,
@@ -46,7 +48,8 @@ module Telnyx
       )
       end
 
-      # List Advanced Orders
+      # Returns the advanced number orders associated with the account. Each result
+      # includes the order configuration and its current state.
       sig do
         params(request_options: Telnyx::RequestOptions::OrHash).returns(
           Telnyx::Models::AdvancedOrderListResponse
@@ -55,7 +58,8 @@ module Telnyx
       def list(request_options: {})
       end
 
-      # Update Advanced Order
+      # Updates the requirement-group configuration for the specified advanced number
+      # order. The response contains the updated advanced order.
       sig do
         params(
           advanced_order_id: String,

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

@@ -6,7 +6,7 @@ module Telnyx
       class Assistants
         # Configure AI assistant specifications
         class Tags
-          # Get All Tags
+          # Retrieve all tags that have been applied to your AI assistants.
           sig do
             params(request_options: Telnyx::RequestOptions::OrHash).returns(
               Telnyx::AI::Assistants::TagsResponse
@@ -15,7 +15,7 @@ module Telnyx
           def list(request_options: {})
           end
 
-          # Add Assistant Tag
+          # Add a tag to an AI assistant. Tags help you organize and filter your assistants.
           sig do
             params(
               assistant_id: String,
@@ -31,7 +31,7 @@ module Telnyx
           )
           end
 
-          # Remove Assistant Tag
+          # Remove a tag from an AI assistant.
           sig do
             params(
               tag: String,

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

@@ -6,7 +6,7 @@ module Telnyx
       class Assistants
         # Configure AI assistant specifications
         class Tools
-          # Add Assistant Tool
+          # Attach an existing tool to an AI assistant.
           sig do
             params(
               tool_id: String,
@@ -23,7 +23,7 @@ module Telnyx
           )
           end
 
-          # Remove Assistant Tool
+          # Detach a tool from an AI assistant.
           sig do
             params(
               tool_id: String,

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

@@ -72,7 +72,8 @@ module Telnyx
                     Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                     Telnyx::AI::AssistantTool::SendMessage::OrHash,
                     Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                    Telnyx::AI::AssistantTool::Pay::OrHash
+                    Telnyx::AI::AssistantTool::Pay::OrHash,
+                    Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                   )
                 ],
               transcription: Telnyx::AI::TranscriptionSettings::OrHash,

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

@@ -76,7 +76,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                  Telnyx::AI::AssistantTool::Pay::OrHash
+                  Telnyx::AI::AssistantTool::Pay::OrHash,
+                  Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
               ],
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
@@ -252,7 +253,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                  Telnyx::AI::AssistantTool::Pay::OrHash
+                  Telnyx::AI::AssistantTool::Pay::OrHash,
+                  Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
               ],
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,

data/rbi/telnyx/resources/ai/clusters.rbi

@@ -5,7 +5,7 @@ module Telnyx
     class AI
       # Identify common themes and patterns in your embedded documents
       class Clusters
-        # Fetch a cluster
+        # Fetch the results of a clustering task, including the discovered clusters.
         sig do
           params(
             task_id: String,
@@ -26,7 +26,7 @@ module Telnyx
         )
         end
 
-        # List all clusters
+        # Retrieve a paginated list of clustering tasks and their statuses.
         sig do
           params(
             page_number: Integer,
@@ -41,7 +41,7 @@ module Telnyx
         def list(page_number: nil, page_size: nil, request_options: {})
         end
 
-        # Delete a cluster
+        # Delete a clustering task and its computed results.
         sig do
           params(
             task_id: String,
@@ -87,7 +87,7 @@ module Telnyx
         )
         end
 
-        # Fetch a cluster visualization
+        # Fetch a visualization image of the clusters computed by a clustering task.
         sig do
           params(
             task_id: String,

data/rbi/telnyx/resources/ai/collections/settings.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Collections
+        # Create and manage logical collections of your Telnyx data, tune retrieval
+        # settings, manage sources, and run collection-scoped semantic search.
+        class Settings
+          # Replaces the collection's retrieval settings.
+          sig do
+            params(
+              uuid: String,
+              retrieval: Telnyx::AI::Collections::RetrievalSettings::OrHash,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(Telnyx::AI::Collections::SettingsEnvelope)
+          end
+          def create(
+            # The collection's unique identifier.
+            uuid,
+            # How documents are retrieved when searching the collection.
+            retrieval: nil,
+            request_options: {}
+          )
+          end
+
+          # Returns the retrieval settings for a collection.
+          sig do
+            params(
+              uuid: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(Telnyx::AI::Collections::SettingsEnvelope)
+          end
+          def list(
+            # The collection's unique identifier.
+            uuid,
+            request_options: {}
+          )
+          end
+
+          # Partially updates the collection's retrieval settings.
+          sig do
+            params(
+              uuid: String,
+              retrieval: Telnyx::AI::Collections::RetrievalSettings::OrHash,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(Telnyx::AI::Collections::SettingsEnvelope)
+          end
+          def patch_all(
+            # The collection's unique identifier.
+            uuid,
+            # How documents are retrieved when searching the collection.
+            retrieval: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Telnyx::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/collections/sources.rbi

@@ -0,0 +1,89 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Collections
+        # Create and manage logical collections of your Telnyx data, tune retrieval
+        # settings, manage sources, and run collection-scoped semantic search.
+        class Sources
+          # Attaches a new source to a collection.
+          sig do
+            params(
+              uuid: String,
+              source_type: Telnyx::AI::Collections::SourceType::OrSymbol,
+              bucket_id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(Telnyx::Models::AI::Collections::SourceCreateResponse)
+          end
+          def create(
+            # The collection's unique identifier.
+            uuid,
+            # The type of Telnyx data attached as a source. `bucket` requires an additional
+            # `bucket_id`. Only `voice` is searchable today; `meeting_bot`, `message`, and
+            # `bucket` attach but are not yet searchable (Coming soon).
+            source_type:,
+            # The Telnyx Storage bucket name. Required when `source_type` is `bucket`; ignored
+            # otherwise.
+            bucket_id: nil,
+            request_options: {}
+          )
+          end
+
+          # Returns the sources attached to a collection.
+          sig do
+            params(
+              uuid: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(Telnyx::Models::AI::Collections::SourceListResponse)
+          end
+          def list(
+            # The collection's unique identifier.
+            uuid,
+            request_options: {}
+          )
+          end
+
+          # Removes a single source from a collection.
+          sig do
+            params(
+              source_id: String,
+              uuid: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).void
+          end
+          def delete(
+            # The identifier of the source to remove.
+            source_id,
+            # The collection's unique identifier.
+            uuid:,
+            request_options: {}
+          )
+          end
+
+          # Replaces the collection's entire source set. The response `meta` reports which
+          # sources were added, retained, and removed.
+          sig do
+            params(
+              uuid: String,
+              sources: T::Array[Telnyx::AI::Collections::SourceRequest::OrHash],
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(Telnyx::Models::AI::Collections::SourceReplaceResponse)
+          end
+          def replace(
+            # The collection's unique identifier.
+            uuid,
+            sources:,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Telnyx::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/collections.rbi

@@ -0,0 +1,208 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      # Create and manage logical collections of your Telnyx data, tune retrieval
+      # settings, manage sources, and run collection-scoped semantic search.
+      class Collections
+        # Create and manage logical collections of your Telnyx data, tune retrieval
+        # settings, manage sources, and run collection-scoped semantic search.
+        sig { returns(Telnyx::Resources::AI::Collections::Settings) }
+        attr_reader :settings
+
+        # Create and manage logical collections of your Telnyx data, tune retrieval
+        # settings, manage sources, and run collection-scoped semantic search.
+        sig { returns(Telnyx::Resources::AI::Collections::Sources) }
+        attr_reader :sources
+
+        # Creates a new collection scoped to your organization. Optionally attach sources
+        # and retrieval settings at creation time. If `slug` is omitted, one is derived
+        # from `name` and must be unique within your organization.
+        sig do
+          params(
+            name: String,
+            description: String,
+            settings: Telnyx::AI::Collections::RetrievalSettingsWrapper::OrHash,
+            slug: String,
+            sources: T::Array[Telnyx::AI::Collections::SourceRequest::OrHash],
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AI::CollectionEnvelope)
+        end
+        def create(
+          # Human-readable collection name.
+          name:,
+          # Optional description.
+          description: nil,
+          # Optional retrieval settings.
+          settings: nil,
+          # Optional slug (unique per organization). Derived from `name` when omitted.
+          slug: nil,
+          # Optional sources to attach at creation time.
+          sources: nil,
+          request_options: {}
+        )
+        end
+
+        # Fetches a single collection by its `slug`.
+        sig do
+          params(
+            slug: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AI::CollectionEnvelope)
+        end
+        def retrieve(
+          # The collection's slug (unique within your organization).
+          slug,
+          request_options: {}
+        )
+        end
+
+        # Updates a collection's metadata (`name` and/or `description`). Sources and
+        # settings are managed through their own sub-resources.
+        sig do
+          params(
+            uuid: String,
+            description: String,
+            name: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AI::CollectionEnvelope)
+        end
+        def update(
+          # The collection's unique identifier.
+          uuid,
+          description: nil,
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        # Returns a paginated list of collections in your organization.
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Internal::DefaultFlatPagination[Telnyx::AI::Collection]
+          )
+        end
+        def list(
+          # Page number to return (1-based). Defaults to 1.
+          page_number: nil,
+          # Number of results per page. Defaults to 20.
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        # Soft-deletes a collection. Its `slug` is freed and may be reused by a new
+        # collection.
+        sig do
+          params(
+            uuid: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # The collection's unique identifier.
+          uuid,
+          request_options: {}
+        )
+        end
+
+        # Fetches a single collection by its `uuid`.
+        sig do
+          params(
+            uuid: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AI::CollectionEnvelope)
+        end
+        def retrieve_by_id(
+          # The collection's unique identifier.
+          uuid,
+          request_options: {}
+        )
+        end
+
+        # Runs search over the documents in a collection, ranked by relevance to `query`.
+        # The collection's `retrieval_type` setting selects the strategy: `vector`
+        # (semantic similarity), `hybrid` (vector similarity fused with keyword matching),
+        # or `keyword` (lexical BM25 matching). When `query` is omitted, returns a plain
+        # catalog listing of the collection's documents.
+        #
+        # **How it works:**
+        #
+        # 1. For `vector` and `hybrid`, the `query` text is embedded into a
+        #    1024-dimensional vector using the multilingual-e5-large model.
+        # 2. For `vector`, the embedding is compared against the collection's indexed
+        #    document chunks using semantic similarity; for `hybrid`, those similarity
+        #    scores are fused with keyword-match scores; for `keyword`, only lexical BM25
+        #    matching is applied.
+        # 3. Results are ranked by `score` (descending) and paginated via `page[number]` /
+        #    `page[size]`.
+        #
+        # **Authentication:** Requires a Telnyx API key via `Authorization: Bearer <key>`.
+        # Results are automatically scoped to your organization and cannot be overridden.
+        #
+        # **Filtering:** Use `filter[field][operator]=value` query parameters to narrow
+        # results before search. Supported operators: `eq` (default), `in`, `gte`, `gt`,
+        # `lte`, `lt`, `contains`. Metadata fields resolve to `metadata.<field>`.
+        #
+        # **Examples:**
+        #
+        # - `GET /v2/ai/collections/my-collection/documents?query=billing+issue&top_k=10`
+        # - `GET /v2/ai/collections/my-collection/documents?query=refund&sources=voice,message`
+        # - `GET /v2/ai/collections/my-collection/documents?query=outage&filter[record_created_at][gte]=2026-01-01T00:00:00Z`
+        sig do
+          params(
+            slug: String,
+            filter: T::Hash[Symbol, T.anything],
+            page_number: Integer,
+            page_size: Integer,
+            query: String,
+            retrieval_type:
+              Telnyx::AI::CollectionRetrieveDocumentsParams::RetrievalType::OrSymbol,
+            sources: String,
+            top_k: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::AI::CollectionRetrieveDocumentsResponse)
+        end
+        def retrieve_documents(
+          # The collection's slug (unique within your organization).
+          slug,
+          # Field filters applied before ranking, using `filter[field][operator]=value`.
+          # Supported operators: `eq` (default), `in`, `gte`, `gt`, `lte`, `lt`, `contains`.
+          # Known fields: `record_type`, `record_id`, `user_id`, `record_created_at`,
+          # `ingested_at`; any other name resolves to a `metadata.<field>` filter. Example:
+          # `filter[record_id][eq]=rec_123`.
+          filter: nil,
+          # Page number to return (1-based). Defaults to 1.
+          page_number: nil,
+          # Number of results per page. Defaults to 20.
+          page_size: nil,
+          # Natural-language search query. When provided, the text is matched against the
+          # collection's document chunks using the collection's `retrieval_type` (vector or
+          # hybrid). When omitted, documents are returned as a plain catalog listing.
+          query: nil,
+          # Override the collection's configured retrieval strategy for this request. Echoed
+          # back in `meta.retrieval_type`.
+          retrieval_type: nil,
+          # Comma-separated list of source types to restrict the search to. When omitted,
+          # all of the collection's sources are searched.
+          sources: nil,
+          # Maximum number of ranked results to consider. When omitted, the collection's
+          # configured `top_k` setting is used.
+          top_k: nil,
+          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/tools.rbi

@@ -5,7 +5,7 @@ module Telnyx
     class AI
       # Configure AI assistant specifications
       class Tools
-        # Create Tool
+        # Create a new custom AI tool that can be attached to AI assistants.
         sig do
           params(
             display_name: String,
@@ -17,6 +17,8 @@ module Telnyx
             pay: Telnyx::AI::PayToolParams::OrHash,
             retrieval: T::Hash[Symbol, T.anything],
             timeout_ms: Integer,
+            update_dynamic_variables:
+              Telnyx::AI::UpdateDynamicVariablesToolParams::OrHash,
             webhook: T::Hash[Symbol, T.anything],
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::AI::SharedToolResponse)
@@ -31,12 +33,14 @@ module Telnyx
           pay: nil,
           retrieval: nil,
           timeout_ms: nil,
+          # Configuration for an update_dynamic_variables tool.
+          update_dynamic_variables: nil,
           webhook: nil,
           request_options: {}
         )
         end
 
-        # Get Tool
+        # Retrieve the details of a specific AI tool.
         sig do
           params(
             tool_id: String,
@@ -50,7 +54,7 @@ module Telnyx
         )
         end
 
-        # Update Tool
+        # Update the configuration of an existing AI tool.
         sig do
           params(
             tool_id: String,
@@ -63,6 +67,8 @@ module Telnyx
             retrieval: T::Hash[Symbol, T.anything],
             timeout_ms: Integer,
             type: String,
+            update_dynamic_variables:
+              Telnyx::AI::UpdateDynamicVariablesToolParams::OrHash,
             webhook: T::Hash[Symbol, T.anything],
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::AI::SharedToolResponse)
@@ -79,12 +85,14 @@ module Telnyx
           retrieval: nil,
           timeout_ms: nil,
           type: nil,
+          # Configuration for an update_dynamic_variables tool.
+          update_dynamic_variables: nil,
           webhook: nil,
           request_options: {}
         )
         end
 
-        # List Tools
+        # Retrieve a list of the custom AI tools configured on your account.
         sig do
           params(
             filter_name: String,
@@ -111,7 +119,7 @@ module Telnyx
         )
         end
 
-        # Delete Tool
+        # Delete a custom AI tool.
         sig do
           params(
             tool_id: String,

data/rbi/telnyx/resources/ai.rbi

@@ -17,6 +17,11 @@ module Telnyx
       sig { returns(Telnyx::Resources::AI::Clusters) }
       attr_reader :clusters
 
+      # Create and manage logical collections of your Telnyx data, tune retrieval
+      # settings, manage sources, and run collection-scoped semantic search.
+      sig { returns(Telnyx::Resources::AI::Collections) }
+      attr_reader :collections
+
       # Manage historical AI assistant conversations
       sig { returns(Telnyx::Resources::AI::Conversations) }
       attr_reader :conversations
@@ -91,13 +96,11 @@ module Telnyx
       #
       # **Examples:**
       #
-      # ```
-      # GET /v2/ai/conversation_histories?q=billing+issue&page[size]=10
-      # GET /v2/ai/conversation_histories?q=setup+guide&region=USA&min_score=0.5
-      # GET /v2/ai/conversation_histories?q=refund&filter[record_created_at][gte]=2026-01-01T00:00:00Z
-      # GET /v2/ai/conversation_histories?q=outage&filter[region][in]=USA,DEU
-      # GET /v2/ai/conversation_histories?q=hold+time&filter[language]=en
-      # ```
+      # - `GET /v2/ai/conversation_histories?q=billing+issue&page[size]=10`
+      # - `GET /v2/ai/conversation_histories?q=setup+guide&region=USA&min_score=0.5`
+      # - `GET /v2/ai/conversation_histories?q=refund&filter[record_created_at][gte]=2026-01-01T00:00:00Z`
+      # - `GET /v2/ai/conversation_histories?q=outage&filter[region][in]=USA,DEU`
+      # - `GET /v2/ai/conversation_histories?q=hold+time&filter[language]=en`
       sig do
         params(
           q: String,

data/rbi/telnyx/resources/available_phone_number_blocks.rbi

@@ -4,7 +4,9 @@ module Telnyx
   module Resources
     # Number search
     class AvailablePhoneNumberBlocks
-      # List available phone number blocks
+      # Searches the Telnyx inventory for available contiguous phone-number blocks.
+      # Results can be filtered by locality, country, national destination code, and
+      # number type.
       sig do
         params(
           filter: Telnyx::AvailablePhoneNumberBlockListParams::Filter::OrHash,