telnyx 5.159.0 → 5.160.0

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

@@ -41,7 +41,7 @@ module Telnyx
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::SimCards::SimCardAction>]
+        # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::SimCards::WirelessSimCardAction>]
         #
         # @see Telnyx::Models::SimCards::ActionListParams
         def list(params = {})
@@ -52,7 +52,7 @@ module Telnyx
             path: "sim_card_actions",
             query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
             page: Telnyx::Internal::DefaultFlatPagination,
-            model: Telnyx::SimCards::SimCardAction,
+            model: Telnyx::SimCards::WirelessSimCardAction,
             options: options
           )
         end

data/lib/telnyx/resources/sip_registration_status.rb

@@ -7,9 +7,21 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::SipRegistrationStatusRetrieveParams} for more details.
       #
-      # Returns the live SIP registration state of a UAC connection: whether it is
-      # currently registered, when it last registered, and the last response Telnyx
-      # received from the registrar. Only `uac_external_credential` is supported today.
+      # Returns the live SIP registration status for a Telnyx endpoint: whether it is
+      # currently registered, when the current registration expires, and the last
+      # response Telnyx received from the registrar.
+      #
+      # The endpoint supports three credential types, selected with the
+      # `credential_type` query parameter. Each type is keyed by a different identifier:
+      #
+      # | `credential_type`           | Keyed by        | Use case                                                                   |
+      # | --------------------------- | --------------- | -------------------------------------------------------------------------- |
+      # | `uac_external_credential`   | `connection_id` | A UAC (SIP attach) connection that registers to an external PBX.           |
+      # | `telephony_credential`      | `username`      | An ephemeral, one-time-use telephony credential.                           |
+      # | `sip_credential_connection` | `username`      | A traditional SIP credential connection that registers directly to Telnyx. |
+      #
+      # The authenticated account is taken from your API key; you can only read the
+      # registration status of connections and credentials your account owns.
       #
       # @overload retrieve(credential_type:, connection_id: nil, username: nil, request_options: {})
       #
@@ -17,7 +29,7 @@ module Telnyx
       #
       # @param connection_id [String] Identifier of the UAC connection to look up. Required when `credential_type` is
       #
-      # @param username [String] SIP username of the telephony credential to look up. Required when `credential_t
+      # @param username [String] SIP username to look up. Required when `credential_type` is `telephony_credentia
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/telnyx/resources/storage/migration_sources.rb

@@ -36,7 +36,7 @@ module Telnyx
           )
         end
 
-        # Get a Migration Source
+        # Retrieve the details of a specific migration source.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -56,7 +56,9 @@ module Telnyx
           )
         end
 
-        # List all Migration Sources
+        # List the migration sources configured on your account. A migration source is an
+        # external storage bucket from which data can be migrated into Telnyx Cloud
+        # Storage.
         #
         # @overload list(request_options: {})
         #
@@ -74,7 +76,7 @@ module Telnyx
           )
         end
 
-        # Delete a Migration Source
+        # Delete a migration source configuration.
         #
         # @overload delete(id, request_options: {})
         #

data/lib/telnyx/resources/storage/migrations/actions.rb

@@ -6,7 +6,7 @@ module Telnyx
       class Migrations
         # Migrate data from an external provider into Telnyx Cloud Storage
         class Actions
-          # Stop a Migration
+          # Stop an in-progress storage migration.
           #
           # @overload stop(id, request_options: {})
           #

data/lib/telnyx/resources/storage/migrations.rb

@@ -41,7 +41,7 @@ module Telnyx
           )
         end
 
-        # Get a Migration
+        # Retrieve the details and status of a specific storage migration.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -61,7 +61,7 @@ module Telnyx
           )
         end
 
-        # List all Migrations
+        # Retrieve a list of the storage migrations on your account.
         #
         # @overload list(request_options: {})
         #

data/lib/telnyx/resources/storage.rb

@@ -25,7 +25,7 @@ module Telnyx
       # @return [Telnyx::Resources::Storage::Cloudfs]
       attr_reader :cloudfs
 
-      # List Migration Source coverage
+      # List the external storage providers and regions supported as migration sources.
       #
       # @overload list_migration_source_coverage(request_options: {})
       #

data/lib/telnyx/resources/sub_number_orders.rb

@@ -101,7 +101,9 @@ module Telnyx
         )
       end
 
-      # Update requirement group for a sub number order
+      # Associates an existing requirement group with the specified sub number order.
+      # The response contains the updated sub number order requirement-group
+      # relationship.
       #
       # @overload update_requirement_group(id, requirement_group_id:, request_options: {})
       #

data/lib/telnyx/resources/user_addresses.rb

@@ -96,7 +96,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::UserAddress>]
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::UserAddressesUserAddress>]
       #
       # @see Telnyx::Models::UserAddressListParams
       def list(params = {})
@@ -107,7 +107,7 @@ module Telnyx
           path: "user_addresses",
           query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
           page: Telnyx::Internal::DefaultFlatPagination,
-          model: Telnyx::UserAddress,
+          model: Telnyx::UserAddressesUserAddress,
           options: options
         )
       end

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

@@ -8,7 +8,9 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Verifications::ActionVerifyParams} for more details.
         #
-        # Verify verification code by ID
+        # Checks the supplied code, or the supplied status for a custom-code verification,
+        # against the verification identified by ID. The response indicates whether the
+        # verification was accepted or rejected.
         #
         # @overload verify(verification_id, code: nil, status: nil, request_options: {})
         #

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

@@ -6,7 +6,8 @@ module Telnyx
       class ByPhoneNumber
         # Two factor authentication API
         class Actions
-          # Verify verification code by phone number
+          # Submits a verification code for the specified phone number and Verify profile.
+          # The response indicates whether the code was accepted or rejected.
           #
           # @overload verify(phone_number, code:, verify_profile_id:, request_options: {})
           #

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/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::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::ReplacedLinkClickWebhookEvent, 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::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::ReplacedLinkClickWebhookEvent, 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.160.0"
 end