telnyx 5.159.0 → 5.161.0

data/rbi/telnyx/models.rbi

@@ -71,6 +71,10 @@ module Telnyx
 
   APIError = Telnyx::Models::APIError
 
+  ArtifactCompletedWebhookEvent = Telnyx::Models::ArtifactCompletedWebhookEvent
+
+  ArtifactFailedWebhookEvent = Telnyx::Models::ArtifactFailedWebhookEvent
+
   AttachmentRequest = Telnyx::Models::AttachmentRequest
 
   Attempt = Telnyx::Models::Attempt
@@ -928,6 +932,8 @@ module Telnyx
 
   FqdnConnectionRetrieveParams = Telnyx::Models::FqdnConnectionRetrieveParams
 
+  FqdnConnections = Telnyx::Models::FqdnConnections
+
   FqdnConnectionUpdateParams = Telnyx::Models::FqdnConnectionUpdateParams
 
   FqdnCreateParams = Telnyx::Models::FqdnCreateParams
@@ -1134,6 +1140,34 @@ module Telnyx
 
   MediaUploadParams = Telnyx::Models::MediaUploadParams
 
+  MeetingSession = Telnyx::Models::MeetingSession
+
+  MeetingSessionCreateParams = Telnyx::Models::MeetingSessionCreateParams
+
+  MeetingSessionDeleteParams = Telnyx::Models::MeetingSessionDeleteParams
+
+  MeetingSessionDeleteRecordingMediaParams =
+    Telnyx::Models::MeetingSessionDeleteRecordingMediaParams
+
+  MeetingSessionListParams = Telnyx::Models::MeetingSessionListParams
+
+  MeetingSessionResponse = Telnyx::Models::MeetingSessionResponse
+
+  MeetingSessionRetrieveEventsParams =
+    Telnyx::Models::MeetingSessionRetrieveEventsParams
+
+  MeetingSessionRetrieveParams = Telnyx::Models::MeetingSessionRetrieveParams
+
+  MeetingSessionRetrieveRecordingsParams =
+    Telnyx::Models::MeetingSessionRetrieveRecordingsParams
+
+  MeetingSessionRetrieveTranscriptParams =
+    Telnyx::Models::MeetingSessionRetrieveTranscriptParams
+
+  MeetingSessions = Telnyx::Models::MeetingSessions
+
+  MeetingSessionUpdateParams = Telnyx::Models::MeetingSessionUpdateParams
+
   MessageCancelScheduledParams = Telnyx::Models::MessageCancelScheduledParams
 
   MessageEvent = Telnyx::Models::MessageEvent
@@ -1162,6 +1196,8 @@ module Telnyx
 
   MessageTemplate = Telnyx::Models::MessageTemplate
 
+  MessageWhatsappParams = Telnyx::Models::MessageWhatsappParams
+
   Messaging = Telnyx::Models::Messaging
 
   Messaging10dlc = Telnyx::Models::Messaging10dlc
@@ -1170,6 +1206,8 @@ module Telnyx
 
   MessagingError = Telnyx::Models::MessagingError
 
+  MessagingError0b38e7044b = Telnyx::Models::MessagingError0b38e7044b
+
   MessagingFeatureSet = Telnyx::Models::MessagingFeatureSet
 
   MessagingHostedNumberDeleteParams =
@@ -1219,8 +1257,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
@@ -1310,6 +1354,8 @@ module Telnyx
 
   NetappsLocation = Telnyx::Models::NetappsLocation
 
+  NetappsLocation17904fcfbc = Telnyx::Models::NetappsLocation17904fcfbc
+
   Network = Telnyx::Models::Network
 
   NetworkCoverageListParams = Telnyx::Models::NetworkCoverageListParams
@@ -1417,6 +1463,9 @@ module Telnyx
 
   NumberOrderStatusUpdate = Telnyx::Models::NumberOrderStatusUpdate
 
+  NumberOrderStatusUpdateWebhookEvent =
+    Telnyx::Models::NumberOrderStatusUpdateWebhookEvent
+
   NumberOrderUpdateParams = Telnyx::Models::NumberOrderUpdateParams
 
   NumberOrderWithPhoneNumbers = Telnyx::Models::NumberOrderWithPhoneNumbers
@@ -1439,6 +1488,8 @@ module Telnyx
 
   NumbersFeatureCreateParams = Telnyx::Models::NumbersFeatureCreateParams
 
+  NumbersPhoneNumberDetailed = Telnyx::Models::NumbersPhoneNumberDetailed
+
   OAuthClient = Telnyx::Models::OAuthClient
 
   OAuthClientCreateParams = Telnyx::Models::OAuthClientCreateParams
@@ -1463,6 +1514,8 @@ module Telnyx
 
   OAuthIntrospectParams = Telnyx::Models::OAuthIntrospectParams
 
+  OAuthOAuthPaginationMeta = Telnyx::Models::OAuthOAuthPaginationMeta
+
   OAuthRegisterParams = Telnyx::Models::OAuthRegisterParams
 
   OAuthRetrieveAuthorizeParams = Telnyx::Models::OAuthRetrieveAuthorizeParams
@@ -1713,12 +1766,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
@@ -1729,6 +1780,9 @@ module Telnyx
 
   Record = Telnyx::Models::Record
 
+  RecordingAvailableWebhookEvent =
+    Telnyx::Models::RecordingAvailableWebhookEvent
+
   RecordingDeleteParams = Telnyx::Models::RecordingDeleteParams
 
   RecordingListParams = Telnyx::Models::RecordingListParams
@@ -1855,6 +1909,9 @@ module Telnyx
 
   SessionAnalysisRetrieveParams = Telnyx::Models::SessionAnalysisRetrieveParams
 
+  SessionStatusChangedWebhookEvent =
+    Telnyx::Models::SessionStatusChangedWebhookEvent
+
   SetiRetrieveBlackBoxTestResultsParams =
     Telnyx::Models::SetiRetrieveBlackBoxTestResultsParams
 
@@ -2093,6 +2150,9 @@ module Telnyx
 
   TrafficType = Telnyx::Models::TrafficType
 
+  TranscriptCompletedWebhookEvent =
+    Telnyx::Models::TranscriptCompletedWebhookEvent
+
   Transcription = Telnyx::Models::Transcription
 
   TranscriptionWebhookEvent = Telnyx::Models::TranscriptionWebhookEvent
@@ -2150,6 +2210,8 @@ module Telnyx
 
   UserAddressCreateParams = Telnyx::Models::UserAddressCreateParams
 
+  UserAddressesUserAddress = Telnyx::Models::UserAddressesUserAddress
+
   UserAddressListParams = Telnyx::Models::UserAddressListParams
 
   UserAddressRetrieveParams = Telnyx::Models::UserAddressRetrieveParams
@@ -2302,6 +2364,14 @@ module Telnyx
 
   WebhookUnwrapParams = Telnyx::Models::WebhookUnwrapParams
 
+  WebSearch = Telnyx::Models::WebSearch
+
+  WebSearchContentsParams = Telnyx::Models::WebSearchContentsParams
+
+  WebSearchCreateParams = Telnyx::Models::WebSearchCreateParams
+
+  WebSearchResult = Telnyx::Models::WebSearchResult
+
   WellKnownRetrieveAuthorizationServerMetadataParams =
     Telnyx::Models::WellKnownRetrieveAuthorizationServerMetadataParams
 

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/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