telnyx 5.159.0 → 5.160.0

data/lib/telnyx/models.rb

@@ -858,6 +858,8 @@ module Telnyx
 
   FqdnConnectionRetrieveParams = Telnyx::Models::FqdnConnectionRetrieveParams
 
+  FqdnConnections = Telnyx::Models::FqdnConnections
+
   FqdnConnectionUpdateParams = Telnyx::Models::FqdnConnectionUpdateParams
 
   FqdnCreateParams = Telnyx::Models::FqdnCreateParams
@@ -1072,6 +1074,8 @@ module Telnyx
 
   MessageTemplate = Telnyx::Models::MessageTemplate
 
+  MessageWhatsappParams = Telnyx::Models::MessageWhatsappParams
+
   Messaging = Telnyx::Models::Messaging
 
   Messaging10dlc = Telnyx::Models::Messaging10dlc
@@ -1080,6 +1084,8 @@ module Telnyx
 
   MessagingError = Telnyx::Models::MessagingError
 
+  MessagingError0b38e7044b = Telnyx::Models::MessagingError0b38e7044b
+
   MessagingFeatureSet = Telnyx::Models::MessagingFeatureSet
 
   MessagingHostedNumberDeleteParams = Telnyx::Models::MessagingHostedNumberDeleteParams
@@ -1119,8 +1125,12 @@ 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
@@ -1194,6 +1204,8 @@ module Telnyx
 
   NetappsLocation = Telnyx::Models::NetappsLocation
 
+  NetappsLocation17904fcfbc = Telnyx::Models::NetappsLocation17904fcfbc
+
   Network = Telnyx::Models::Network
 
   NetworkCoverageListParams = Telnyx::Models::NetworkCoverageListParams
@@ -1286,6 +1298,8 @@ module Telnyx
 
   NumberOrderStatusUpdate = Telnyx::Models::NumberOrderStatusUpdate
 
+  NumberOrderStatusUpdateWebhookEvent = Telnyx::Models::NumberOrderStatusUpdateWebhookEvent
+
   NumberOrderUpdateParams = Telnyx::Models::NumberOrderUpdateParams
 
   NumberOrderWithPhoneNumbers = Telnyx::Models::NumberOrderWithPhoneNumbers
@@ -1306,6 +1320,8 @@ module Telnyx
 
   NumbersFeatureCreateParams = Telnyx::Models::NumbersFeatureCreateParams
 
+  NumbersPhoneNumberDetailed = Telnyx::Models::NumbersPhoneNumberDetailed
+
   OAuthClient = Telnyx::Models::OAuthClient
 
   OAuthClientCreateParams = Telnyx::Models::OAuthClientCreateParams
@@ -1330,6 +1346,8 @@ module Telnyx
 
   OAuthIntrospectParams = Telnyx::Models::OAuthIntrospectParams
 
+  OAuthOAuthPaginationMeta = Telnyx::Models::OAuthOAuthPaginationMeta
+
   OAuthRegisterParams = Telnyx::Models::OAuthRegisterParams
 
   OAuthRetrieveAuthorizeParams = Telnyx::Models::OAuthRetrieveAuthorizeParams
@@ -1555,12 +1573,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
@@ -1950,6 +1966,8 @@ module Telnyx
 
   UserAddressCreateParams = Telnyx::Models::UserAddressCreateParams
 
+  UserAddressesUserAddress = Telnyx::Models::UserAddressesUserAddress
+
   UserAddressListParams = Telnyx::Models::UserAddressListParams
 
   UserAddressRetrieveParams = Telnyx::Models::UserAddressRetrieveParams

data/lib/telnyx/resources/access_ip_address.rb

@@ -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.
       #
       # @overload create(ip_address:, description: nil, request_options: {})
       #
@@ -26,7 +26,7 @@ module Telnyx
         )
       end
 
-      # Retrieve an access IP address
+      # Retrieve the details of a specific access IP address.
       #
       # @overload retrieve(access_ip_address_id, request_options: {})
       #
@@ -49,7 +49,7 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::AccessIPAddressListParams} for more details.
       #
-      # List all Access IP Addresses
+      # Retrieve a paginated list of access IP addresses configured on your account.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
       #
@@ -77,7 +77,7 @@ module Telnyx
         )
       end
 
-      # Delete access IP address
+      # Delete an access IP address entry from your account.
       #
       # @overload delete(access_ip_address_id, request_options: {})
       #

data/lib/telnyx/resources/access_ip_ranges.rb

@@ -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.
       #
       # @overload create(cidr_block:, description: nil, request_options: {})
       #
@@ -29,7 +29,7 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::AccessIPRangeListParams} for more details.
       #
-      # List all Access IP Ranges
+      # Retrieve a paginated list of access IP ranges configured on your account.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
       #
@@ -57,7 +57,7 @@ module Telnyx
         )
       end
 
-      # Delete access IP ranges
+      # Delete an access IP range from your account.
       #
       # @overload delete(access_ip_range_id, request_options: {})
       #

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

@@ -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.
         #
         # @overload accept_suggestions(address_uuid, id: nil, request_options: {})
         #

data/lib/telnyx/resources/advanced_orders.rb

@@ -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.
       #
       # @overload create(area_code: nil, comments: nil, country_code: nil, customer_reference: nil, features: nil, phone_number_type: nil, quantity: nil, requirement_group_id: nil, request_options: {})
       #
@@ -39,7 +40,8 @@ module Telnyx
         )
       end
 
-      # Get Advanced Order
+      # Returns the advanced number order identified by `order_id`, including its
+      # configuration and current state.
       #
       # @overload retrieve(order_id, request_options: {})
       #
@@ -59,7 +61,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.
       #
       # @overload list(request_options: {})
       #
@@ -77,7 +80,8 @@ module Telnyx
         )
       end
 
-      # Update Advanced Order
+      # Updates the requirement-group configuration for the specified advanced number
+      # order. The response contains the updated advanced order.
       #
       # @overload update_requirement_group(advanced_order_id, area_code: nil, comments: nil, country_code: nil, customer_reference: nil, features: nil, phone_number_type: nil, quantity: nil, requirement_group_id: nil, request_options: {})
       #

data/lib/telnyx/resources/ai/assistants/tags.rb

@@ -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.
           #
           # @overload list(request_options: {})
           #
@@ -24,7 +24,7 @@ module Telnyx
             )
           end
 
-          # Add Assistant Tag
+          # Add a tag to an AI assistant. Tags help you organize and filter your assistants.
           #
           # @overload add(assistant_id, tag:, request_options: {})
           #
@@ -48,7 +48,7 @@ module Telnyx
             )
           end
 
-          # Remove Assistant Tag
+          # Remove a tag from an AI assistant.
           #
           # @overload remove(tag, assistant_id:, request_options: {})
           #

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

@@ -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.
           #
           # @overload add(tool_id, assistant_id:, request_options: {})
           #
@@ -33,7 +33,7 @@ module Telnyx
             )
           end
 
-          # Remove Assistant Tool
+          # Detach a tool from an AI assistant.
           #
           # @overload remove(tool_id, assistant_id:, request_options: {})
           #

data/lib/telnyx/resources/ai/assistants/versions.rb

@@ -97,7 +97,7 @@ module Telnyx
           #
           # @param tool_ids [Array<String>] Body param: IDs of shared tools to attach to the assistant. New integrations sho
           #
-          # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Body param: Deprecated for new integrations. Inline tool definitions available t
+          # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Body param: Deprecated for new integrations. Inline tool definitions available t
           #
           # @param transcription [Telnyx::Models::AI::TranscriptionSettings] Body param
           #

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

@@ -88,7 +88,7 @@ module Telnyx
         #
         # @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
         #
-        # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Deprecated for new integrations. Inline tool definitions available to the assist
+        # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Deprecated for new integrations. Inline tool definitions available to the assist
         #
         # @param transcription [Telnyx::Models::AI::TranscriptionSettings]
         #
@@ -202,7 +202,7 @@ module Telnyx
         #
         # @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
         #
-        # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay>] Deprecated for new integrations. Inline tool definitions available to the assist
+        # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Deprecated for new integrations. Inline tool definitions available to the assist
         #
         # @param transcription [Telnyx::Models::AI::TranscriptionSettings]
         #

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

@@ -8,7 +8,7 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::AI::ClusterRetrieveParams} for more details.
         #
-        # Fetch a cluster
+        # Fetch the results of a clustering task, including the discovered clusters.
         #
         # @overload retrieve(task_id, show_subclusters: nil, top_n_nodes: nil, request_options: {})
         #
@@ -35,7 +35,7 @@ module Telnyx
           )
         end
 
-        # List all clusters
+        # Retrieve a paginated list of clustering tasks and their statuses.
         #
         # @overload list(page_number: nil, page_size: nil, request_options: {})
         #
@@ -59,7 +59,7 @@ module Telnyx
           )
         end
 
-        # Delete a cluster
+        # Delete a clustering task and its computed results.
         #
         # @overload delete(task_id, request_options: {})
         #
@@ -114,7 +114,7 @@ module Telnyx
           )
         end
 
-        # Fetch a cluster visualization
+        # Fetch a visualization image of the clusters computed by a clustering task.
         #
         # @overload fetch_graph(task_id, cluster_id: nil, request_options: {})
         #

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+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.
+          #
+          # @overload create(uuid, retrieval: nil, request_options: {})
+          #
+          # @param uuid [String] The collection's unique identifier.
+          #
+          # @param retrieval [Telnyx::Models::AI::Collections::RetrievalSettings] How documents are retrieved when searching the collection.
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::AI::Collections::SettingsEnvelope]
+          #
+          # @see Telnyx::Models::AI::Collections::SettingCreateParams
+          def create(uuid, params = {})
+            parsed, options = Telnyx::AI::Collections::SettingCreateParams.dump_request(params)
+            @client.request(
+              method: :put,
+              path: ["ai/collections/%1$s/settings", uuid],
+              body: parsed,
+              model: Telnyx::AI::Collections::SettingsEnvelope,
+              options: options
+            )
+          end
+
+          # Returns the retrieval settings for a collection.
+          #
+          # @overload list(uuid, request_options: {})
+          #
+          # @param uuid [String] The collection's unique identifier.
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::AI::Collections::SettingsEnvelope]
+          #
+          # @see Telnyx::Models::AI::Collections::SettingListParams
+          def list(uuid, params = {})
+            @client.request(
+              method: :get,
+              path: ["ai/collections/%1$s/settings", uuid],
+              model: Telnyx::AI::Collections::SettingsEnvelope,
+              options: params[:request_options]
+            )
+          end
+
+          # Partially updates the collection's retrieval settings.
+          #
+          # @overload patch_all(uuid, retrieval: nil, request_options: {})
+          #
+          # @param uuid [String] The collection's unique identifier.
+          #
+          # @param retrieval [Telnyx::Models::AI::Collections::RetrievalSettings] How documents are retrieved when searching the collection.
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::AI::Collections::SettingsEnvelope]
+          #
+          # @see Telnyx::Models::AI::Collections::SettingPatchAllParams
+          def patch_all(uuid, params = {})
+            parsed, options = Telnyx::AI::Collections::SettingPatchAllParams.dump_request(params)
+            @client.request(
+              method: :patch,
+              path: ["ai/collections/%1$s/settings", uuid],
+              body: parsed,
+              model: Telnyx::AI::Collections::SettingsEnvelope,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Telnyx::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+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
+          # Some parameter documentations has been truncated, see
+          # {Telnyx::Models::AI::Collections::SourceCreateParams} for more details.
+          #
+          # Attaches a new source to a collection.
+          #
+          # @overload create(uuid, source_type:, bucket_id: nil, request_options: {})
+          #
+          # @param uuid [String] The collection's unique identifier.
+          #
+          # @param source_type [Symbol, Telnyx::Models::AI::Collections::SourceType] The type of Telnyx data attached as a source. `bucket` requires an additional `b
+          #
+          # @param bucket_id [String] The Telnyx Storage bucket name. Required when `source_type` is `bucket`; ignored
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::AI::Collections::SourceCreateResponse]
+          #
+          # @see Telnyx::Models::AI::Collections::SourceCreateParams
+          def create(uuid, params)
+            parsed, options = Telnyx::AI::Collections::SourceCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["ai/collections/%1$s/sources", uuid],
+              body: parsed,
+              model: Telnyx::Models::AI::Collections::SourceCreateResponse,
+              options: options
+            )
+          end
+
+          # Returns the sources attached to a collection.
+          #
+          # @overload list(uuid, request_options: {})
+          #
+          # @param uuid [String] The collection's unique identifier.
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::AI::Collections::SourceListResponse]
+          #
+          # @see Telnyx::Models::AI::Collections::SourceListParams
+          def list(uuid, params = {})
+            @client.request(
+              method: :get,
+              path: ["ai/collections/%1$s/sources", uuid],
+              model: Telnyx::Models::AI::Collections::SourceListResponse,
+              options: params[:request_options]
+            )
+          end
+
+          # Removes a single source from a collection.
+          #
+          # @overload delete(source_id, uuid:, request_options: {})
+          #
+          # @param source_id [String] The identifier of the source to remove.
+          #
+          # @param uuid [String] The collection's unique identifier.
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see Telnyx::Models::AI::Collections::SourceDeleteParams
+          def delete(source_id, params)
+            parsed, options = Telnyx::AI::Collections::SourceDeleteParams.dump_request(params)
+            uuid =
+              parsed.delete(:uuid) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :delete,
+              path: ["ai/collections/%1$s/sources/%2$s", uuid, source_id],
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # Replaces the collection's entire source set. The response `meta` reports which
+          # sources were added, retained, and removed.
+          #
+          # @overload replace(uuid, sources:, request_options: {})
+          #
+          # @param uuid [String] The collection's unique identifier.
+          #
+          # @param sources [Array<Telnyx::Models::AI::Collections::SourceRequest>]
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::AI::Collections::SourceReplaceResponse]
+          #
+          # @see Telnyx::Models::AI::Collections::SourceReplaceParams
+          def replace(uuid, params)
+            parsed, options = Telnyx::AI::Collections::SourceReplaceParams.dump_request(params)
+            @client.request(
+              method: :put,
+              path: ["ai/collections/%1$s/sources", uuid],
+              body: parsed,
+              model: Telnyx::Models::AI::Collections::SourceReplaceResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Telnyx::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end