telnyx 5.159.0 → 5.160.0

data/lib/telnyx/resources/ai/collections.rb

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+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.
+        # @return [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.
+        # @return [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.
+        #
+        # @overload create(name:, description: nil, settings: nil, slug: nil, sources: nil, request_options: {})
+        #
+        # @param name [String] Human-readable collection name.
+        #
+        # @param description [String] Optional description.
+        #
+        # @param settings [Telnyx::Models::AI::Collections::RetrievalSettingsWrapper] Optional retrieval settings.
+        #
+        # @param slug [String] Optional slug (unique per organization). Derived from `name` when omitted.
+        #
+        # @param sources [Array<Telnyx::Models::AI::Collections::SourceRequest>] Optional sources to attach at creation time.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::AI::CollectionEnvelope]
+        #
+        # @see Telnyx::Models::AI::CollectionCreateParams
+        def create(params)
+          parsed, options = Telnyx::AI::CollectionCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "ai/collections",
+            body: parsed,
+            model: Telnyx::AI::CollectionEnvelope,
+            options: options
+          )
+        end
+
+        # Fetches a single collection by its `slug`.
+        #
+        # @overload retrieve(slug, request_options: {})
+        #
+        # @param slug [String] The collection's slug (unique within your organization).
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::AI::CollectionEnvelope]
+        #
+        # @see Telnyx::Models::AI::CollectionRetrieveParams
+        def retrieve(slug, params = {})
+          @client.request(
+            method: :get,
+            path: ["ai/collections/slug/%1$s", slug],
+            model: Telnyx::AI::CollectionEnvelope,
+            options: params[:request_options]
+          )
+        end
+
+        # Updates a collection's metadata (`name` and/or `description`). Sources and
+        # settings are managed through their own sub-resources.
+        #
+        # @overload update(uuid, description: nil, name: nil, request_options: {})
+        #
+        # @param uuid [String] The collection's unique identifier.
+        #
+        # @param description [String]
+        #
+        # @param name [String]
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::AI::CollectionEnvelope]
+        #
+        # @see Telnyx::Models::AI::CollectionUpdateParams
+        def update(uuid, params = {})
+          parsed, options = Telnyx::AI::CollectionUpdateParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: ["ai/collections/%1$s", uuid],
+            body: parsed,
+            model: Telnyx::AI::CollectionEnvelope,
+            options: options
+          )
+        end
+
+        # Returns a paginated list of collections in your organization.
+        #
+        # @overload list(page_number: nil, page_size: nil, request_options: {})
+        #
+        # @param page_number [Integer] Page number to return (1-based). Defaults to 1.
+        #
+        # @param page_size [Integer] Number of results per page. Defaults to 20.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AI::Collection>]
+        #
+        # @see Telnyx::Models::AI::CollectionListParams
+        def list(params = {})
+          parsed, options = Telnyx::AI::CollectionListParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "ai/collections",
+            query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+            page: Telnyx::Internal::DefaultFlatPagination,
+            model: Telnyx::AI::Collection,
+            options: options
+          )
+        end
+
+        # Soft-deletes a collection. Its `slug` is freed and may be reused by a new
+        # collection.
+        #
+        # @overload delete(uuid, request_options: {})
+        #
+        # @param uuid [String] The collection's unique identifier.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Telnyx::Models::AI::CollectionDeleteParams
+        def delete(uuid, params = {})
+          @client.request(
+            method: :delete,
+            path: ["ai/collections/%1$s", uuid],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # Fetches a single collection by its `uuid`.
+        #
+        # @overload retrieve_by_id(uuid, request_options: {})
+        #
+        # @param uuid [String] The collection's unique identifier.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::AI::CollectionEnvelope]
+        #
+        # @see Telnyx::Models::AI::CollectionRetrieveByIDParams
+        def retrieve_by_id(uuid, params = {})
+          @client.request(
+            method: :get,
+            path: ["ai/collections/%1$s", uuid],
+            model: Telnyx::AI::CollectionEnvelope,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::AI::CollectionRetrieveDocumentsParams} for more details.
+        #
+        # 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`
+        #
+        # @overload retrieve_documents(slug, filter: nil, page_number: nil, page_size: nil, query: nil, retrieval_type: nil, sources: nil, top_k: nil, request_options: {})
+        #
+        # @param slug [String] The collection's slug (unique within your organization).
+        #
+        # @param filter [Hash{Symbol=>Object}] Field filters applied before ranking, using `filter[field][operator]=value`. Sup
+        #
+        # @param page_number [Integer] Page number to return (1-based). Defaults to 1.
+        #
+        # @param page_size [Integer] Number of results per page. Defaults to 20.
+        #
+        # @param query [String] Natural-language search query. When provided, the text is matched against the co
+        #
+        # @param retrieval_type [Symbol, Telnyx::Models::AI::CollectionRetrieveDocumentsParams::RetrievalType] Override the collection's configured retrieval strategy for this request. Echoed
+        #
+        # @param sources [String] Comma-separated list of source types to restrict the search to. When omitted, al
+        #
+        # @param top_k [Integer] Maximum number of ranked results to consider. When omitted, the collection's con
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::AI::CollectionRetrieveDocumentsResponse]
+        #
+        # @see Telnyx::Models::AI::CollectionRetrieveDocumentsParams
+        def retrieve_documents(slug, params = {})
+          parsed, options = Telnyx::AI::CollectionRetrieveDocumentsParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["ai/collections/%1$s/documents", slug],
+            query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+            model: Telnyx::Models::AI::CollectionRetrieveDocumentsResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+          @settings = Telnyx::Resources::AI::Collections::Settings.new(client: client)
+          @sources = Telnyx::Resources::AI::Collections::Sources.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/ai/tools.rb

@@ -5,20 +5,32 @@ 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.
         #
-        # @overload create(display_name:, type:, client_side_tool: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, webhook: nil, request_options: {})
+        # @overload create(display_name:, type:, client_side_tool: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, update_dynamic_variables: nil, webhook: nil, request_options: {})
         #
         # @param display_name [String]
+        #
         # @param type [String]
+        #
         # @param client_side_tool [Hash{Symbol=>Object}]
+        #
         # @param function [Hash{Symbol=>Object}]
+        #
         # @param handoff [Hash{Symbol=>Object}]
+        #
         # @param invite [Hash{Symbol=>Object}]
+        #
         # @param pay [Telnyx::Models::AI::PayToolParams]
+        #
         # @param retrieval [Hash{Symbol=>Object}]
+        #
         # @param timeout_ms [Integer]
+        #
+        # @param update_dynamic_variables [Telnyx::Models::AI::UpdateDynamicVariablesToolParams] Configuration for an update_dynamic_variables tool.
+        #
         # @param webhook [Hash{Symbol=>Object}]
+        #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Telnyx::Models::AI::SharedToolResponse]
@@ -35,7 +47,7 @@ module Telnyx
           )
         end
 
-        # Get Tool
+        # Retrieve the details of a specific AI tool.
         #
         # @overload retrieve(tool_id, request_options: {})
         #
@@ -55,9 +67,9 @@ module Telnyx
           )
         end
 
-        # Update Tool
+        # Update the configuration of an existing AI tool.
         #
-        # @overload update(tool_id, client_side_tool: nil, display_name: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, type: nil, webhook: nil, request_options: {})
+        # @overload update(tool_id, client_side_tool: nil, display_name: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, type: nil, update_dynamic_variables: nil, webhook: nil, request_options: {})
         #
         # @param tool_id [String] Unique identifier of the tool.
         #
@@ -79,6 +91,8 @@ module Telnyx
         #
         # @param type [String]
         #
+        # @param update_dynamic_variables [Telnyx::Models::AI::UpdateDynamicVariablesToolParams] Configuration for an update_dynamic_variables tool.
+        #
         # @param webhook [Hash{Symbol=>Object}]
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -97,7 +111,7 @@ module Telnyx
           )
         end
 
-        # List Tools
+        # Retrieve a list of the custom AI tools configured on your account.
         #
         # @overload list(filter_name: nil, filter_type: nil, page_number: nil, page_size: nil, request_options: {})
         #
@@ -132,7 +146,7 @@ module Telnyx
           )
         end
 
-        # Delete Tool
+        # Delete a custom AI tool.
         #
         # @overload delete(tool_id, request_options: {})
         #

data/lib/telnyx/resources/ai.rb

@@ -17,6 +17,11 @@ module Telnyx
       # @return [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.
+      # @return [Telnyx::Resources::AI::Collections]
+      attr_reader :collections
+
       # Manage historical AI assistant conversations
       # @return [Telnyx::Resources::AI::Conversations]
       attr_reader :conversations
@@ -94,13 +99,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`
       #
       # @overload retrieve_conversation_histories(q:, filter_ingested_at_gte: nil, filter_ingested_at_lte: nil, filter_record_created_at_gte: nil, filter_record_created_at_lte: nil, filter_record_id: nil, filter_region_in: nil, filter_retention: nil, filter_user_id: nil, min_score: nil, page_number: nil, page_size: nil, region: nil, request_options: {})
       #
@@ -203,6 +206,7 @@ module Telnyx
         @audio = Telnyx::Resources::AI::Audio.new(client: client)
         @chat = Telnyx::Resources::AI::Chat.new(client: client)
         @clusters = Telnyx::Resources::AI::Clusters.new(client: client)
+        @collections = Telnyx::Resources::AI::Collections.new(client: client)
         @conversations = Telnyx::Resources::AI::Conversations.new(client: client)
         @embeddings = Telnyx::Resources::AI::Embeddings.new(client: client)
         @fine_tuning = Telnyx::Resources::AI::FineTuning.new(client: client)

data/lib/telnyx/resources/available_phone_number_blocks.rb

@@ -7,7 +7,9 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::AvailablePhoneNumberBlockListParams} for more details.
       #
-      # 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.
       #
       # @overload list(filter: nil, request_options: {})
       #

data/lib/telnyx/resources/available_phone_numbers.rb

@@ -7,7 +7,10 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::AvailablePhoneNumberListParams} for more details.
       #
-      # List available phone numbers
+      # Searches the Telnyx inventory for available phone numbers. Filters support
+      # number patterns, location, number type, features, reservability, and other
+      # inventory constraints; the response includes matching numbers and search
+      # metadata.
       #
       # @overload list(filter: nil, request_options: {})
       #

data/lib/telnyx/resources/balance.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Billing operations
     class Balance
-      # Get user balance details
+      # Retrieve the current balance, available credit, and credit limit for your
+      # account.
       #
       # @overload retrieve(request_options: {})
       #

data/lib/telnyx/resources/billing_groups.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Billing groups operations
     class BillingGroups
-      # Create a billing group
+      # Create a new billing group, which can be used to organize resources for billing
+      # purposes.
       #
       # @overload create(name: nil, request_options: {})
       #
@@ -26,7 +27,7 @@ module Telnyx
         )
       end
 
-      # Get a billing group
+      # Retrieve the details of a specific billing group.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -46,7 +47,7 @@ module Telnyx
         )
       end
 
-      # Update a billing group
+      # Update the properties of an existing billing group.
       #
       # @overload update(id, name: nil, request_options: {})
       #
@@ -70,7 +71,7 @@ module Telnyx
         )
       end
 
-      # List all billing groups
+      # Retrieve a paginated list of billing groups on your account.
       #
       # @overload list(page_number: nil, page_size: nil, request_options: {})
       #
@@ -94,7 +95,7 @@ module Telnyx
         )
       end
 
-      # Delete a billing group
+      # Delete a billing group from your account.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/calls/actions.rb

@@ -1137,7 +1137,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionStartNoiseSuppressionParams} for more details.
         #
-        # Noise Suppression Start (BETA)
+        # Start noise suppression on an active call to reduce background noise. This
+        # feature is currently in beta.
         #
         # @overload start_noise_suppression(call_control_id, client_state: nil, command_id: nil, direction: nil, noise_suppression_engine: nil, noise_suppression_engine_config: nil, request_options: {})
         #
@@ -1565,7 +1566,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionStopNoiseSuppressionParams} for more details.
         #
-        # Noise Suppression Stop (BETA)
+        # Stop noise suppression previously started on an active call. This feature is
+        # currently in beta.
         #
         # @overload stop_noise_suppression(call_control_id, client_state: nil, command_id: nil, request_options: {})
         #

data/lib/telnyx/resources/comments.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Number orders
     class Comments
-      # Create a comment
+      # Creates a comment associated with a supported number-order record. The response
+      # contains the created comment.
       #
       # @overload create(body: nil, comment_record_id: nil, comment_record_type: nil, request_options: {})
       #
@@ -27,7 +28,8 @@ module Telnyx
         )
       end
 
-      # Retrieve a comment
+      # Returns the comment identified by `id`, including its associated record and
+      # comment metadata.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -50,7 +52,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::CommentListParams} for more details.
       #
-      # Retrieve all comments
+      # Returns comments associated with number-order records. Results can be filtered
+      # by record type and record ID and include pagination metadata.
       #
       # @overload list(filter: nil, request_options: {})
       #
@@ -73,7 +76,8 @@ module Telnyx
         )
       end
 
-      # Mark a comment as read
+      # Marks the specified comment as read. The response contains the updated read
+      # state for the comment.
       #
       # @overload mark_as_read(id, request_options: {})
       #

data/lib/telnyx/resources/credential_connections.rb

@@ -106,7 +106,7 @@ module Telnyx
       #
       # Updates settings of an existing credential connection.
       #
-      # @overload update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
+      # @overload update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #
       # @param id [String] Identifies the resource.
       #
@@ -120,6 +120,8 @@ module Telnyx
       #
       # @param connection_name [String] A user-assigned name to help manage the connection.
       #
+      # @param conversation_persistence [Boolean] Whether conversation persistence is enabled for this connection. When enabled, c
+      #
       # @param default_on_hold_comfort_noise_enabled [Boolean] When enabled, Telnyx will generate comfort noise when you place the call on hold
       #
       # @param dtmf_type [Symbol, Telnyx::Models::DtmfType] Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF

data/lib/telnyx/resources/email_blocks.rb

@@ -45,7 +45,8 @@ module Telnyx
         )
       end
 
-      # Retrieve a suppression
+      # Returns the account-owned suppression identified by ID. Cross-account lookups
+      # and malformed IDs return `404` without exposing another account’s data.
       #
       # @overload retrieve(id, request_options: {})
       #

data/lib/telnyx/resources/email_domains/webhooks.rb

@@ -33,7 +33,8 @@ module Telnyx
           )
         end
 
-        # Retrieve a webhook
+        # Returns the webhook subscription identified by ID within the specified email
+        # domain.
         #
         # @overload retrieve(id, domain_id:, request_options: {})
         #
@@ -93,7 +94,8 @@ module Telnyx
           )
         end
 
-        # List webhooks for an email domain
+        # Returns a paginated list of webhook subscriptions scoped to the email domain.
+        # Results can be sorted by creation time.
         #
         # @overload list(domain_id, page_number: nil, page_size: nil, sort: nil, request_options: {})
         #
@@ -123,7 +125,8 @@ module Telnyx
           )
         end
 
-        # Delete a webhook
+        # Deletes the webhook subscription identified by ID within the specified email
+        # domain and returns the deleted subscription.
         #
         # @overload delete(id, domain_id:, request_options: {})
         #

data/lib/telnyx/resources/email_domains.rb

@@ -10,7 +10,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::EmailDomainCreateParams} for more details.
       #
-      # Create an email domain
+      # Registers a domain for email sending and optional inbound delivery. The response
+      # includes the domain configuration and current verification state.
       #
       # @overload create(domain:, dmarc_policy: nil, inbound_enabled: nil, tracking: nil, request_options: {})
       #
@@ -63,7 +64,9 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::EmailDomainUpdateParams} for more details.
       #
-      # Update an email domain
+      # Updates mutable settings for an existing email domain, including inbound
+      # delivery and tracking configuration. Shared domains are read-only for non-owner
+      # accounts.
       #
       # @overload update(id, dmarc_policy: nil, inbound_enabled: nil, tracking: nil, request_options: {})
       #
@@ -148,7 +151,8 @@ module Telnyx
         )
       end
 
-      # Delete an email domain
+      # Deletes an email domain configuration. Verified domains require `force=true`,
+      # and shared domains are read-only for non-owner accounts.
       #
       # @overload delete(id, force: nil, request_options: {})
       #
@@ -173,7 +177,8 @@ module Telnyx
         )
       end
 
-      # List DNS records for an email domain
+      # Returns the DNS records Telnyx generated for domain ownership and DKIM
+      # verification, plus MX records when inbound delivery is enabled.
       #
       # @overload retrieve_dns_records(domain_id, request_options: {})
       #
@@ -213,7 +218,8 @@ module Telnyx
         )
       end
 
-      # Verify DNS records for an email domain
+      # Checks the published DNS records against the records required for the email
+      # domain and returns the latest verification results.
       #
       # @overload verify(domain_id, request_options: {})
       #

data/lib/telnyx/resources/email_templates.rb

@@ -41,7 +41,8 @@ module Telnyx
         )
       end
 
-      # Get an email template
+      # Returns the account-owned template identified by ID, including its Liquid
+      # subject and bodies, declared variables, and timestamps.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -121,7 +122,8 @@ module Telnyx
         )
       end
 
-      # Delete an email template
+      # Deletes the account-owned template. The operation returns `204` with no body and
+      # prevents future sends or renders from using the deleted template ID.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/email_unsubscribe_groups.rb

@@ -8,7 +8,8 @@ module Telnyx
       # @return [Telnyx::Resources::EmailUnsubscribeGroups::Suppressions]
       attr_reader :suppressions
 
-      # Create an unsubscribe group
+      # Creates an account-owned unsubscribe group for associating email categories with
+      # separate recipient suppression lists.
       #
       # @overload create(name:, description: nil, request_options: {})
       #
@@ -30,7 +31,7 @@ module Telnyx
         )
       end
 
-      # Retrieve an unsubscribe group
+      # Returns the account-owned unsubscribe group identified by ID.
       #
       # @overload retrieve(id, request_options: {})
       #

data/lib/telnyx/resources/external_connections.rb

@@ -184,7 +184,8 @@ module Telnyx
         )
       end
 
-      # Update a location's static emergency address
+      # Update the static emergency address assigned to a specific location of an
+      # external connection.
       #
       # @overload update_location(location_id, id:, static_emergency_address_id:, request_options: {})
       #