telnyx 5.158.0 → 5.160.0

data/rbi/telnyx/models.rbi

@@ -71,6 +71,8 @@ module Telnyx
 
   APIError = Telnyx::Models::APIError
 
+  AttachmentRequest = Telnyx::Models::AttachmentRequest
+
   Attempt = Telnyx::Models::Attempt
 
   AuditEventListParams = Telnyx::Models::AuditEventListParams
@@ -272,6 +274,12 @@ module Telnyx
   CallMachinePremiumGreetingEndedWebhookEvent =
     Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent
 
+  CallPaymentCompletedWebhookEvent =
+    Telnyx::Models::CallPaymentCompletedWebhookEvent
+
+  CallPaymentProgressWebhookEvent =
+    Telnyx::Models::CallPaymentProgressWebhookEvent
+
   CallPlaybackEnded = Telnyx::Models::CallPlaybackEnded
 
   CallPlaybackEndedWebhookEvent = Telnyx::Models::CallPlaybackEndedWebhookEvent
@@ -623,6 +631,8 @@ module Telnyx
 
   DirWrapped = Telnyx::Models::DirWrapped
 
+  DNSRecord = Telnyx::Models::DNSRecord
+
   DocReqsRequirement = Telnyx::Models::DocReqsRequirement
 
   DocReqsRequirementType = Telnyx::Models::DocReqsRequirementType
@@ -652,6 +662,8 @@ module Telnyx
 
   DocumentUploadParams = Telnyx::Models::DocumentUploadParams
 
+  DomainsTrackingSettings = Telnyx::Models::DomainsTrackingSettings
+
   DtmfType = Telnyx::Models::DtmfType
 
   DynamicEmergencyAddress = Telnyx::Models::DynamicEmergencyAddress
@@ -682,6 +694,145 @@ module Telnyx
   DynamicEmergencyEndpointRetrieveParams =
     Telnyx::Models::DynamicEmergencyEndpointRetrieveParams
 
+  EmailAddressInput = Telnyx::Models::EmailAddressInput
+
+  EmailBlock = Telnyx::Models::EmailBlock
+
+  EmailBlockCreateParams = Telnyx::Models::EmailBlockCreateParams
+
+  EmailBlockDeleteParams = Telnyx::Models::EmailBlockDeleteParams
+
+  EmailBlockListParams = Telnyx::Models::EmailBlockListParams
+
+  EmailBlockResponse = Telnyx::Models::EmailBlockResponse
+
+  EmailBlockRetrieveEventsParams =
+    Telnyx::Models::EmailBlockRetrieveEventsParams
+
+  EmailBlockRetrieveExportParams =
+    Telnyx::Models::EmailBlockRetrieveExportParams
+
+  EmailBlockRetrieveParams = Telnyx::Models::EmailBlockRetrieveParams
+
+  EmailBlocks = Telnyx::Models::EmailBlocks
+
+  EmailDmarcPolicy = Telnyx::Models::EmailDmarcPolicy
+
+  EmailDomain = Telnyx::Models::EmailDomain
+
+  EmailDomainCreateParams = Telnyx::Models::EmailDomainCreateParams
+
+  EmailDomainDeleteParams = Telnyx::Models::EmailDomainDeleteParams
+
+  EmailDomainListParams = Telnyx::Models::EmailDomainListParams
+
+  EmailDomainResponse = Telnyx::Models::EmailDomainResponse
+
+  EmailDomainRetrieveDNSRecordsParams =
+    Telnyx::Models::EmailDomainRetrieveDNSRecordsParams
+
+  EmailDomainRetrieveHealthParams =
+    Telnyx::Models::EmailDomainRetrieveHealthParams
+
+  EmailDomainRetrieveParams = Telnyx::Models::EmailDomainRetrieveParams
+
+  EmailDomains = Telnyx::Models::EmailDomains
+
+  EmailDomainStatus = Telnyx::Models::EmailDomainStatus
+
+  EmailDomainType = Telnyx::Models::EmailDomainType
+
+  EmailDomainUpdateParams = Telnyx::Models::EmailDomainUpdateParams
+
+  EmailDomainVerification = Telnyx::Models::EmailDomainVerification
+
+  EmailDomainVerifyParams = Telnyx::Models::EmailDomainVerifyParams
+
+  EmailEventListParams = Telnyx::Models::EmailEventListParams
+
+  EmailEventRetrieveStatsParams = Telnyx::Models::EmailEventRetrieveStatsParams
+
+  EmailEventType = Telnyx::Models::EmailEventType
+
+  EmailInbox = Telnyx::Models::EmailInbox
+
+  EmailInboxCreateParams = Telnyx::Models::EmailInboxCreateParams
+
+  EmailInboxDeleteParams = Telnyx::Models::EmailInboxDeleteParams
+
+  EmailInboxes = Telnyx::Models::EmailInboxes
+
+  EmailInboxListParams = Telnyx::Models::EmailInboxListParams
+
+  EmailInboxResponse = Telnyx::Models::EmailInboxResponse
+
+  EmailInboxRetrieveParams = Telnyx::Models::EmailInboxRetrieveParams
+
+  EmailMessageBatchParams = Telnyx::Models::EmailMessageBatchParams
+
+  EmailMessageCreateParams = Telnyx::Models::EmailMessageCreateParams
+
+  EmailMessageDeleteAllParams = Telnyx::Models::EmailMessageDeleteAllParams
+
+  EmailMessageDeleteParams = Telnyx::Models::EmailMessageDeleteParams
+
+  EmailMessageDeleteScheduleParams =
+    Telnyx::Models::EmailMessageDeleteScheduleParams
+
+  EmailMessageListParams = Telnyx::Models::EmailMessageListParams
+
+  EmailMessageRetrieveEventsParams =
+    Telnyx::Models::EmailMessageRetrieveEventsParams
+
+  EmailMessageRetrieveParams = Telnyx::Models::EmailMessageRetrieveParams
+
+  EmailMessages = Telnyx::Models::EmailMessages
+
+  EmailTemplate = Telnyx::Models::EmailTemplate
+
+  EmailTemplateCreateParams = Telnyx::Models::EmailTemplateCreateParams
+
+  EmailTemplateDeleteParams = Telnyx::Models::EmailTemplateDeleteParams
+
+  EmailTemplateListParams = Telnyx::Models::EmailTemplateListParams
+
+  EmailTemplateRenderParams = Telnyx::Models::EmailTemplateRenderParams
+
+  EmailTemplateReplaceParams = Telnyx::Models::EmailTemplateReplaceParams
+
+  EmailTemplateResponse = Telnyx::Models::EmailTemplateResponse
+
+  EmailTemplateRetrieveParams = Telnyx::Models::EmailTemplateRetrieveParams
+
+  EmailTemplateUpdateParams = Telnyx::Models::EmailTemplateUpdateParams
+
+  EmailThreadListParams = Telnyx::Models::EmailThreadListParams
+
+  EmailThreadRetrieveParams = Telnyx::Models::EmailThreadRetrieveParams
+
+  EmailUnsubscribeGroupCreateParams =
+    Telnyx::Models::EmailUnsubscribeGroupCreateParams
+
+  EmailUnsubscribeGroupDeleteParams =
+    Telnyx::Models::EmailUnsubscribeGroupDeleteParams
+
+  EmailUnsubscribeGroupListParams =
+    Telnyx::Models::EmailUnsubscribeGroupListParams
+
+  EmailUnsubscribeGroupRetrieveParams =
+    Telnyx::Models::EmailUnsubscribeGroupRetrieveParams
+
+  EmailUnsubscribeGroups = Telnyx::Models::EmailUnsubscribeGroups
+
+  EmailUnsubscribeGroupUpdateParams =
+    Telnyx::Models::EmailUnsubscribeGroupUpdateParams
+
+  EmailValidationCheck = Telnyx::Models::EmailValidationCheck
+
+  EmailValidationCreateParams = Telnyx::Models::EmailValidationCreateParams
+
+  EmailValidations = Telnyx::Models::EmailValidations
+
   EncryptedMedia = Telnyx::Models::EncryptedMedia
 
   EnterpriseBrandedCallingParams =
@@ -777,6 +928,8 @@ module Telnyx
 
   FqdnConnectionRetrieveParams = Telnyx::Models::FqdnConnectionRetrieveParams
 
+  FqdnConnections = Telnyx::Models::FqdnConnections
+
   FqdnConnectionUpdateParams = Telnyx::Models::FqdnConnectionUpdateParams
 
   FqdnCreateParams = Telnyx::Models::FqdnCreateParams
@@ -849,6 +1002,8 @@ module Telnyx
 
   GlobalIPUsageRetrieveParams = Telnyx::Models::GlobalIPUsageRetrieveParams
 
+  GroupListMeta = Telnyx::Models::GroupListMeta
+
   HostedNumber = Telnyx::Models::HostedNumber
 
   HostedNumberOrderEventWebhookEvent =
@@ -983,6 +1138,8 @@ module Telnyx
 
   MessageCancelScheduledParams = Telnyx::Models::MessageCancelScheduledParams
 
+  MessageEvent = Telnyx::Models::MessageEvent
+
   MessageRetrieveGroupMessagesParams =
     Telnyx::Models::MessageRetrieveGroupMessagesParams
 
@@ -1007,6 +1164,8 @@ module Telnyx
 
   MessageTemplate = Telnyx::Models::MessageTemplate
 
+  MessageWhatsappParams = Telnyx::Models::MessageWhatsappParams
+
   Messaging = Telnyx::Models::Messaging
 
   Messaging10dlc = Telnyx::Models::Messaging10dlc
@@ -1015,6 +1174,8 @@ module Telnyx
 
   MessagingError = Telnyx::Models::MessagingError
 
+  MessagingError0b38e7044b = Telnyx::Models::MessagingError0b38e7044b
+
   MessagingFeatureSet = Telnyx::Models::MessagingFeatureSet
 
   MessagingHostedNumberDeleteParams =
@@ -1064,8 +1225,14 @@ module Telnyx
 
   MessagingOptoutListParams = Telnyx::Models::MessagingOptoutListParams
 
+  MessagingOutboundMessagePayload =
+    Telnyx::Models::MessagingOutboundMessagePayload
+
   MessagingPaginationMeta = Telnyx::Models::MessagingPaginationMeta
 
+  MessagingPaginationMeta0b38e7044b =
+    Telnyx::Models::MessagingPaginationMeta0b38e7044b
+
   MessagingProfile = Telnyx::Models::MessagingProfile
 
   MessagingProfileCreateParams = Telnyx::Models::MessagingProfileCreateParams
@@ -1155,6 +1322,8 @@ module Telnyx
 
   NetappsLocation = Telnyx::Models::NetappsLocation
 
+  NetappsLocation17904fcfbc = Telnyx::Models::NetappsLocation17904fcfbc
+
   Network = Telnyx::Models::Network
 
   NetworkCoverageListParams = Telnyx::Models::NetworkCoverageListParams
@@ -1262,6 +1431,9 @@ module Telnyx
 
   NumberOrderStatusUpdate = Telnyx::Models::NumberOrderStatusUpdate
 
+  NumberOrderStatusUpdateWebhookEvent =
+    Telnyx::Models::NumberOrderStatusUpdateWebhookEvent
+
   NumberOrderUpdateParams = Telnyx::Models::NumberOrderUpdateParams
 
   NumberOrderWithPhoneNumbers = Telnyx::Models::NumberOrderWithPhoneNumbers
@@ -1284,6 +1456,8 @@ module Telnyx
 
   NumbersFeatureCreateParams = Telnyx::Models::NumbersFeatureCreateParams
 
+  NumbersPhoneNumberDetailed = Telnyx::Models::NumbersPhoneNumberDetailed
+
   OAuthClient = Telnyx::Models::OAuthClient
 
   OAuthClientCreateParams = Telnyx::Models::OAuthClientCreateParams
@@ -1308,6 +1482,8 @@ module Telnyx
 
   OAuthIntrospectParams = Telnyx::Models::OAuthIntrospectParams
 
+  OAuthOAuthPaginationMeta = Telnyx::Models::OAuthOAuthPaginationMeta
+
   OAuthRegisterParams = Telnyx::Models::OAuthRegisterParams
 
   OAuthRetrieveAuthorizeParams = Telnyx::Models::OAuthRetrieveAuthorizeParams
@@ -1318,6 +1494,8 @@ module Telnyx
 
   OAuthTokenParams = Telnyx::Models::OAuthTokenParams
 
+  OffsetMeta = Telnyx::Models::OffsetMeta
+
   OperatorConnect = Telnyx::Models::OperatorConnect
 
   OrganizationContact = Telnyx::Models::OrganizationContact
@@ -1479,6 +1657,8 @@ module Telnyx
 
   PortoutUpdateStatusParams = Telnyx::Models::PortoutUpdateStatusParams
 
+  Pricing = Telnyx::Models::Pricing
+
   PrivateWirelessGateway = Telnyx::Models::PrivateWirelessGateway
 
   PrivateWirelessGatewayCreateParams =
@@ -1554,12 +1734,10 @@ module Telnyx
 
   QueueUpdateParams = Telnyx::Models::QueueUpdateParams
 
-  RcsAgent = Telnyx::Models::RcsAgent
+  Rcs = Telnyx::Models::Rcs
 
   RcsAgentMessage = Telnyx::Models::RcsAgentMessage
 
-  RcsAgentResponse = Telnyx::Models::RcsAgentResponse
-
   RcsCardContent = Telnyx::Models::RcsCardContent
 
   RcsContentInfo = Telnyx::Models::RcsContentInfo
@@ -1908,6 +2086,10 @@ module Telnyx
 
   TextToSpeechStreamParams = Telnyx::Models::TextToSpeechStreamParams
 
+  TimeRange = Telnyx::Models::TimeRange
+
+  TrackingSettings = Telnyx::Models::TrackingSettings
+
   TrafficPolicyProfile = Telnyx::Models::TrafficPolicyProfile
 
   TrafficPolicyProfileCreateParams =
@@ -1962,8 +2144,14 @@ module Telnyx
 
   UnsafeUnwrapWebhookEvent = Telnyx::Models::UnsafeUnwrapWebhookEvent
 
+  UnsubscribeGroup = Telnyx::Models::UnsubscribeGroup
+
+  UnsubscribeGroupResponse = Telnyx::Models::UnsubscribeGroupResponse
+
   UnwrapWebhookEvent = Telnyx::Models::UnwrapWebhookEvent
 
+  UpdateEmailTemplateRequest = Telnyx::Models::UpdateEmailTemplateRequest
+
   UpdatePhoneNumberMessagingSettingsRequest =
     Telnyx::Models::UpdatePhoneNumberMessagingSettingsRequest
 
@@ -1981,6 +2169,8 @@ module Telnyx
 
   UserAddressCreateParams = Telnyx::Models::UserAddressCreateParams
 
+  UserAddressesUserAddress = Telnyx::Models::UserAddressesUserAddress
+
   UserAddressListParams = Telnyx::Models::UserAddressListParams
 
   UserAddressRetrieveParams = Telnyx::Models::UserAddressRetrieveParams

data/rbi/telnyx/resources/access_ip_address.rbi

@@ -4,7 +4,7 @@ module Telnyx
   module Resources
     # IP Address Operations
     class AccessIPAddress
-      # Create new Access IP Address
+      # Create a new access IP address entry on your account.
       sig do
         params(
           ip_address: String,
@@ -15,7 +15,7 @@ module Telnyx
       def create(ip_address:, description: nil, request_options: {})
       end
 
-      # Retrieve an access IP address
+      # Retrieve the details of a specific access IP address.
       sig do
         params(
           access_ip_address_id: String,
@@ -29,7 +29,7 @@ module Telnyx
       )
       end
 
-      # List all Access IP Addresses
+      # Retrieve a paginated list of access IP addresses configured on your account.
       sig do
         params(
           filter: Telnyx::AccessIPAddressListParams::Filter::OrHash,
@@ -53,7 +53,7 @@ module Telnyx
       )
       end
 
-      # Delete access IP address
+      # Delete an access IP address entry from your account.
       sig do
         params(
           access_ip_address_id: String,

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/anthropic/v1.rbi

@@ -66,7 +66,9 @@ module Telnyx
             mcp_servers: nil,
             # An object describing metadata about the request.
             metadata: nil,
-            # Service tier for the request.
+            # The service tier to use for this request. Supported values vary by model; use
+            # the Telnyx models endpoint and inspect the model's `service_tiers` field. If
+            # omitted, Telnyx-hosted models use `default`.
             service_tier: nil,
             # Custom sequences that will cause the model to stop generating.
             stop_sequences: nil,

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,
@@ -402,6 +404,7 @@ module Telnyx
             content: String,
             conversation_id: String,
             name: String,
+            stream: T::Boolean,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(Telnyx::Models::AI::AssistantChatResponse)
         end
@@ -414,6 +417,12 @@ module Telnyx
           conversation_id:,
           # The optional display name of the user sending the message
           name: nil,
+          # When true, the response is streamed as Server-Sent Events (`text/event-stream`):
+          # `delta` events carry content fragments as they are generated, a final `done`
+          # event carries the full content plus `whatsapp_template`, and a terminal `error`
+          # event reports failures that happen after streaming started. When false
+          # (default), the response is a single JSON object.
+          stream: nil,
           request_options: {}
         )
         end

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