telnyx 5.159.0 → 5.161.0

data/lib/telnyx/resources/verifications/by_phone_number.rb

@@ -9,7 +9,8 @@ module Telnyx
         # @return [Telnyx::Resources::Verifications::ByPhoneNumber::Actions]
         attr_reader :actions
 
-        # List verifications by phone number
+        # Returns a paginated list of verifications associated with the specified phone
+        # number.
         #
         # @overload list(phone_number, request_options: {})
         #

data/lib/telnyx/resources/verifications.rb

@@ -12,7 +12,8 @@ module Telnyx
       # @return [Telnyx::Resources::Verifications::Actions]
       attr_reader :actions
 
-      # Retrieve verification
+      # Returns the verification identified by ID, including its channel, phone number,
+      # Verify profile, timeout, and current status.
       #
       # @overload retrieve(verification_id, request_options: {})
       #
@@ -35,7 +36,9 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::VerificationTriggerCallParams} for more details.
       #
-      # Trigger Call verification
+      # Starts a verification for the specified phone number and delivers its code in a
+      # voice call using the selected Verify profile. Returns the pending verification
+      # record.
       #
       # @overload trigger_call(phone_number:, verify_profile_id:, custom_code: nil, extension: nil, timeout_secs: nil, request_options: {})
       #
@@ -65,7 +68,9 @@ module Telnyx
         )
       end
 
-      # Trigger Flash call verification
+      # Starts a verification for the specified phone number and places a brief call
+      # with the code embedded in the caller ID. Returns the pending verification
+      # record.
       #
       # @overload trigger_flashcall(phone_number:, verify_profile_id:, timeout_secs: nil, request_options: {})
       #
@@ -91,7 +96,8 @@ module Telnyx
         )
       end
 
-      # Trigger SMS verification
+      # Starts a verification for the specified phone number and sends its code by SMS
+      # using the selected Verify profile. Returns the pending verification record.
       #
       # @overload trigger_sms(phone_number:, verify_profile_id:, custom_code: nil, timeout_secs: nil, request_options: {})
       #
@@ -119,7 +125,9 @@ module Telnyx
         )
       end
 
-      # Trigger WhatsApp verification
+      # Starts a verification for the specified phone number and sends its code over
+      # WhatsApp using the selected Verify profile. Returns the pending verification
+      # record.
       #
       # @overload trigger_whatsapp_verification(phone_number:, verify_profile_id:, custom_code: nil, timeout_secs: nil, request_options: {})
       #

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

@@ -5,7 +5,8 @@ module Telnyx
     class VerifiedNumbers
       # Verified Numbers operations
       class Actions
-        # Submit verification code
+        # Submit the verification code received via the selected verification method to
+        # verify a phone number.
         #
         # @overload submit_verification_code(phone_number, verification_code:, request_options: {})
         #

data/lib/telnyx/resources/verified_numbers.rb

@@ -38,7 +38,7 @@ module Telnyx
         )
       end
 
-      # Retrieve a verified number
+      # Retrieve the details of a verified number on your account.
       #
       # @overload retrieve(phone_number, request_options: {})
       #
@@ -82,7 +82,7 @@ module Telnyx
         )
       end
 
-      # Delete a verified number
+      # Remove a verified number from your account.
       #
       # @overload delete(phone_number, request_options: {})
       #

data/lib/telnyx/resources/verify_profiles.rb

@@ -64,7 +64,8 @@ module Telnyx
         )
       end
 
-      # Update Verify profile
+      # Updates the specified Verify profile's name, webhook destinations, language,
+      # daily spend limits, or channel-specific settings. Returns the updated profile.
       #
       # @overload update(verify_profile_id, call: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, language: nil, name: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, whatsapp: nil, request_options: {})
       #
@@ -132,7 +133,7 @@ module Telnyx
         )
       end
 
-      # Delete Verify profile
+      # Deletes the specified Verify profile and returns the deleted profile record.
       #
       # @overload delete(verify_profile_id, request_options: {})
       #

data/lib/telnyx/resources/web_search/research.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class WebSearch
+      # Deep research with citations and async task polling.
+      class Research
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::WebSearch::ResearchCreateParams} for more details.
+        #
+        # Starts a deep research task that runs multiple searches, reads sources, and
+        # synthesizes an answer with citations.
+        #
+        # ## Synchronous mode (default)
+        #
+        # When `background` is `false` or omitted, the request blocks until the research
+        # completes and returns the answer with citations. This can take up to 120 seconds
+        # depending on `research_effort`.
+        #
+        # ## Asynchronous mode
+        #
+        # When `background` is `true`, the request returns immediately with a `task_id`
+        # and `status: pending`. Poll `GET /web_search/research/{task_id}` to check when
+        # the research completes and retrieve the answer.
+        #
+        # @overload create(query:, background: nil, max_sources: nil, research_effort: nil, request_options: {})
+        #
+        # @param query [String] The research question or topic.
+        #
+        # @param background [Boolean] When `true`, the research runs asynchronously. The response returns a `task_id`
+        #
+        # @param max_sources [Integer] Maximum number of sources to use.
+        #
+        # @param research_effort [Symbol, Telnyx::Models::WebSearch::ResearchCreateParams::ResearchEffort] Research depth level. `lite` is fastest, `deep` is most thorough.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::WebSearch::ResearchCreateResponse]
+        #
+        # @see Telnyx::Models::WebSearch::ResearchCreateParams
+        def create(params)
+          parsed, options = Telnyx::WebSearch::ResearchCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "web_search/research",
+            body: parsed,
+            model: Telnyx::Models::WebSearch::ResearchCreateResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::WebSearch::ResearchRetrieveParams} for more details.
+        #
+        # Polls the status of a previously started asynchronous research task. When the
+        # status is `completed`, the response includes the answer and citations. When the
+        # status is `failed`, the response includes an error message.
+        #
+        # @overload retrieve(task_id, request_options: {})
+        #
+        # @param task_id [String] The research task ID returned by `POST /web_search/research` with `background: t
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::WebSearch::ResearchRetrieveResponse]
+        #
+        # @see Telnyx::Models::WebSearch::ResearchRetrieveParams
+        def retrieve(task_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["web_search/research/%1$s", task_id],
+            model: Telnyx::Models::WebSearch::ResearchRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/web_search.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class WebSearch
+      # Deep research with citations and async task polling.
+      # @return [Telnyx::Resources::WebSearch::Research]
+      attr_reader :research
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::WebSearchCreateParams} for more details.
+      #
+      # Performs a real-time web search and returns structured, LLM-ready JSON results
+      # with titles, URLs, descriptions, and snippets. Supports filtering by domain,
+      # country, safe search, freshness, and live crawl.
+      #
+      # **Note:** `include_domains` and `exclude_domains` cannot be used in the same
+      # request. Use one or the other.
+      #
+      # @overload create(query:, count: nil, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, livecrawl: nil, safesearch: nil, request_options: {})
+      #
+      # @param query [String] The search query text.
+      #
+      # @param count [Integer] Number of results to return (1-100).
+      #
+      # @param country [String] Two-letter country code (ISO 3166-1 alpha-2) to bias results.
+      #
+      # @param exclude_domains [Array<String>] Exclude results from these domains (bare hostnames, e.g. `pinterest.com`).
+      #
+      # @param freshness [String] Time-based filter for results. Common values: `day`, `week`, `month`, `year`.
+      #
+      # @param include_domains [Array<String>] Restrict results to these domains (bare hostnames, e.g. `arxiv.org`).
+      #
+      # @param livecrawl [Boolean] When true, the provider crawls pages in real-time for fresh content. The boolean
+      #
+      # @param safesearch [Symbol, Telnyx::Models::WebSearchCreateParams::Safesearch] Safe search filter level.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::WebSearchCreateResponse]
+      #
+      # @see Telnyx::Models::WebSearchCreateParams
+      def create(params)
+        parsed, options = Telnyx::WebSearchCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "web_search",
+          body: parsed,
+          model: Telnyx::Models::WebSearchCreateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::WebSearchContentsParams} for more details.
+      #
+      # Retrieves clean HTML or Markdown content from a list of URLs. Supports up to 20
+      # URLs per request (public API limit). Specify which formats to return: `html`,
+      # `markdown`, `metadata`.
+      #
+      # @overload contents(urls:, crawl_timeout: nil, formats: nil, max_age: nil, request_options: {})
+      #
+      # @param urls [Array<String>] List of URLs to retrieve content from (max 20 for public API).
+      #
+      # @param crawl_timeout [Integer] Timeout for crawling each URL, in seconds (1-60).
+      #
+      # @param formats [Array<Symbol, Telnyx::Models::WebSearchContentsParams::Format>] Content formats to return. If omitted, `html` and `metadata` are returned by def
+      #
+      # @param max_age [Integer, nil] Maximum age of cached content in seconds. `null` means no limit.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::WebSearchContentsResponse]
+      #
+      # @see Telnyx::Models::WebSearchContentsParams
+      def contents(params)
+        parsed, options = Telnyx::WebSearchContentsParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "web_search/contents",
+          body: parsed,
+          model: Telnyx::Models::WebSearchContentsResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+        @research = Telnyx::Resources::WebSearch::Research.new(client: client)
+      end
+    end
+  end
+end

data/lib/telnyx/resources/webhooks.rb

@@ -5,7 +5,7 @@ module Telnyx
     class Webhooks
       # @param payload [String] The raw webhook payload as a string
       #
-      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
+      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
       def unsafe_unwrap(payload)
         parsed = JSON.parse(payload, symbolize_names: true)
         Telnyx::Internal::Type::Converter.coerce(Telnyx::Models::UnsafeUnwrapWebhookEvent, parsed)
@@ -17,7 +17,7 @@ module Telnyx
       #
       # @param key [String, nil] The webhook signing key
       #
-      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
+      # @return [Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent]
       def unwrap(payload, headers:, key: @client.public_key)
         if key.nil?
           raise ArgumentError.new("Cannot verify a webhook without a key on either the client's public_key or passed in as an argument")

data/lib/telnyx/resources/whatsapp/business_accounts/phone_numbers.rb

@@ -5,7 +5,7 @@ module Telnyx
     class Whatsapp
       class BusinessAccounts
         class PhoneNumbers
-          # List phone numbers for a WABA
+          # Returns phone numbers registered under the specified WhatsApp Business Account.
           #
           # @overload list(id, page_number: nil, page_size: nil, request_options: {})
           #
@@ -33,7 +33,8 @@ module Telnyx
             )
           end
 
-          # Initialize Whatsapp phone number verification
+          # Starts verification of a phone number for the specified WhatsApp Business
+          # Account using the requested verification method.
           #
           # @overload initialize_verification(id, display_name:, phone_number:, language: nil, verification_method: nil, request_options: {})
           #

data/lib/telnyx/resources/whatsapp/business_accounts/settings.rb

@@ -6,7 +6,7 @@ module Telnyx
       class BusinessAccounts
         # Manage Whatsapp business accounts
         class Settings
-          # Get WABA settings
+          # Returns account-level settings for the specified WhatsApp Business Account.
           #
           # @overload retrieve(id, request_options: {})
           #
@@ -26,7 +26,8 @@ module Telnyx
             )
           end
 
-          # Update WABA settings
+          # Updates the supplied account-level settings for the specified WhatsApp Business
+          # Account.
           #
           # @overload update(id, name: nil, timezone: nil, webhook_enabled: nil, webhook_events: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
           #

data/lib/telnyx/resources/whatsapp/business_accounts.rb

@@ -12,7 +12,7 @@ module Telnyx
         # @return [Telnyx::Resources::Whatsapp::BusinessAccounts::Settings]
         attr_reader :settings
 
-        # Get a single Whatsapp Business Account
+        # Returns the configuration and status of the specified WhatsApp Business Account.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -32,7 +32,7 @@ module Telnyx
           )
         end
 
-        # List Whatsapp Business Accounts
+        # Returns WhatsApp Business Accounts linked to the authenticated Telnyx account.
         #
         # @overload list(page_number: nil, page_size: nil, request_options: {})
         #
@@ -56,7 +56,8 @@ module Telnyx
           )
         end
 
-        # Delete a Whatsapp Business Account
+        # Unlinks and deletes the specified WhatsApp Business Account resource from
+        # Telnyx.
         #
         # @overload delete(id, request_options: {})
         #

data/lib/telnyx/resources/whatsapp/phone_numbers/calling_settings.rb

@@ -6,7 +6,7 @@ module Telnyx
       class PhoneNumbers
         # Manage Whatsapp phone numbers
         class CallingSettings
-          # Get calling settings for a phone number
+          # Returns the WhatsApp calling configuration for the specified phone number.
           #
           # @overload retrieve(phone_number, request_options: {})
           #
@@ -26,7 +26,7 @@ module Telnyx
             )
           end
 
-          # Enable or disable Whatsapp calling for a phone number
+          # Enables or disables WhatsApp calling for the specified phone number.
           #
           # @overload update(phone_number, enabled:, request_options: {})
           #

data/lib/telnyx/resources/whatsapp/phone_numbers/conversational_components.rb

@@ -6,7 +6,8 @@ module Telnyx
       class PhoneNumbers
         # Manage Whatsapp phone numbers
         class ConversationalComponents
-          # Get phone number conversational components
+          # Returns the conversational components configured for the specified WhatsApp
+          # phone number.
           #
           # @overload list(phone_number, request_options: {})
           #
@@ -26,7 +27,8 @@ module Telnyx
             )
           end
 
-          # Update phone number conversational components
+          # Updates the conversational components configured for the specified WhatsApp
+          # phone number.
           #
           # @overload patch_all(phone_number, commands: nil, ice_breakers: nil, request_options: {})
           #

data/lib/telnyx/resources/whatsapp/phone_numbers/profile/photo.rb

@@ -7,7 +7,8 @@ module Telnyx
         class Profile
           # Manage Whatsapp phone numbers
           class Photo
-            # Get Whatsapp profile photo
+            # Returns the current business-profile photo for the specified WhatsApp phone
+            # number.
             #
             # @overload retrieve(phone_number, request_options: {})
             #
@@ -27,7 +28,7 @@ module Telnyx
               )
             end
 
-            # Delete Whatsapp profile photo
+            # Removes the business-profile photo from the specified WhatsApp phone number.
             #
             # @overload delete(phone_number, request_options: {})
             #
@@ -47,7 +48,8 @@ module Telnyx
               )
             end
 
-            # Upload Whatsapp profile photo
+            # Uploads and assigns a business-profile photo to the specified WhatsApp phone
+            # number.
             #
             # @overload upload(phone_number, file:, request_options: {})
             #

data/lib/telnyx/resources/whatsapp/phone_numbers/profile.rb

@@ -10,7 +10,7 @@ module Telnyx
           # @return [Telnyx::Resources::Whatsapp::PhoneNumbers::Profile::Photo]
           attr_reader :photo
 
-          # Get phone number business profile
+          # Returns the business profile displayed for the specified WhatsApp phone number.
           #
           # @overload retrieve(phone_number, request_options: {})
           #
@@ -30,7 +30,8 @@ module Telnyx
             )
           end
 
-          # Update phone number business profile
+          # Updates the supplied business-profile fields for the specified WhatsApp phone
+          # number.
           #
           # @overload update(phone_number, about: nil, address: nil, category: nil, description: nil, display_name: nil, email: nil, profile_id: nil, website: nil, request_options: {})
           #

data/lib/telnyx/resources/whatsapp/phone_numbers.rb

@@ -17,7 +17,7 @@ module Telnyx
         # @return [Telnyx::Resources::Whatsapp::PhoneNumbers::ConversationalComponents]
         attr_reader :conversational_components
 
-        # List Whatsapp phone numbers
+        # Returns WhatsApp phone numbers linked to the authenticated Telnyx account.
         #
         # @overload list(page_number: nil, page_size: nil, request_options: {})
         #
@@ -41,7 +41,7 @@ module Telnyx
           )
         end
 
-        # Delete a Whatsapp phone number
+        # Removes the specified phone number from Telnyx WhatsApp management.
         #
         # @overload delete(phone_number, request_options: {})
         #
@@ -61,7 +61,30 @@ module Telnyx
           )
         end
 
-        # Resend verification code
+        # Retrieve a list of the phone numbers registered for WhatsApp on your account.
+        #
+        # @overload get(page_number: nil, page_size: nil, request_options: {})
+        #
+        # @param page_number [Integer]
+        # @param page_size [Integer]
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Whatsapp::PhoneNumberGetResponse]
+        #
+        # @see Telnyx::Models::Whatsapp::PhoneNumberGetParams
+        def get(params = {})
+          parsed, options = Telnyx::Whatsapp::PhoneNumberGetParams.dump_request(params)
+          query = Telnyx::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "whatsapp/phone_numbers",
+            query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
+            model: Telnyx::Models::Whatsapp::PhoneNumberGetResponse,
+            options: options
+          )
+        end
+
+        # Requests a new verification code for the specified WhatsApp phone number.
         #
         # @overload resend_verification(phone_number, verification_method: nil, request_options: {})
         #
@@ -112,7 +135,7 @@ module Telnyx
           )
         end
 
-        # Submit verification code for a phone number
+        # Submits the verification code received for the specified WhatsApp phone number.
         #
         # @overload verify(phone_number, code:, request_options: {})
         #

data/lib/telnyx/resources/whatsapp/templates.rb

@@ -8,7 +8,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Whatsapp::TemplateCreateParams} for more details.
         #
-        # Create a Whatsapp message template
+        # Creates a WhatsApp message template for review and subsequent use in template
+        # messages.
         #
         # @overload create(category:, components:, language:, name:, waba_id:, request_options: {})
         #
@@ -38,7 +39,8 @@ module Telnyx
           )
         end
 
-        # List Whatsapp message templates
+        # Returns WhatsApp message templates owned by the authenticated account, including
+        # their current review state.
         #
         # @overload list(filter_category: nil, filter_search: nil, filter_status: nil, filter_waba_id: nil, page_number: nil, page_size: nil, request_options: {})
         #

data/lib/telnyx/resources/whatsapp/user_data.rb

@@ -5,7 +5,8 @@ module Telnyx
     class Whatsapp
       # Manage Whatsapp business accounts
       class UserData
-        # Fetch Whatsapp user data
+        # Returns the WhatsApp user-data settings associated with the authenticated Telnyx
+        # account.
         #
         # @overload retrieve(request_options: {})
         #
@@ -23,7 +24,8 @@ module Telnyx
           )
         end
 
-        # Update Whatsapp user data
+        # Updates the supplied WhatsApp user-data settings for the authenticated Telnyx
+        # account.
         #
         # @overload update(webhook_failover_url: nil, webhook_url: nil, request_options: {})
         #

data/lib/telnyx/resources/whatsapp_message_templates.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Manage Whatsapp message templates
     class WhatsappMessageTemplates
-      # Get a Whatsapp message template by ID
+      # Returns the content, components, language, and current review state of the
+      # specified WhatsApp message template.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -24,7 +25,7 @@ module Telnyx
         )
       end
 
-      # Update a Whatsapp message template
+      # Updates the editable fields of the specified WhatsApp message template.
       #
       # @overload update(id, category: nil, components: nil, request_options: {})
       #
@@ -50,7 +51,7 @@ module Telnyx
         )
       end
 
-      # Delete a Whatsapp message template
+      # Deletes the specified WhatsApp message template.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "5.159.0"
+  VERSION = "5.161.0"
 end