telnyx 5.159.0 → 5.160.0

data/rbi/telnyx/resources/rooms.rbi

@@ -43,7 +43,9 @@ module Telnyx
       )
       end
 
-      # View a room.
+      # Returns the room identified by `room_id`, including its participant limit,
+      # recording and webhook configuration, and active session identifier. Use
+      # `include_sessions` to include its sessions.
       sig do
         params(
           room_id: String,
@@ -95,7 +97,8 @@ module Telnyx
       )
       end
 
-      # View a list of rooms.
+      # Returns a paginated list of rooms. Filter the results by creation or update date
+      # and unique name, and use `include_sessions` to include each room’s sessions.
       sig do
         params(
           filter: Telnyx::RoomListParams::Filter::OrHash,

data/rbi/telnyx/resources/short_codes.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Short codes
     class ShortCodes
-      # Retrieve a short code
+      # Returns the messaging configuration and assignment details for the specified
+      # short code.
       sig do
         params(
           id: String,
@@ -40,7 +41,8 @@ module Telnyx
       )
       end
 
-      # List short codes
+      # Returns short codes owned by the authenticated account. Apply the documented
+      # filters and pagination parameters to narrow the result set.
       sig do
         params(
           filter: Telnyx::ShortCodeListParams::Filter::OrHash,

data/rbi/telnyx/resources/sim_cards/actions.rbi

@@ -29,7 +29,7 @@ module Telnyx
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(
             Telnyx::Internal::DefaultFlatPagination[
-              Telnyx::SimCards::SimCardAction
+              Telnyx::SimCards::WirelessSimCardAction
             ]
           )
         end

data/rbi/telnyx/resources/sip_registration_status.rbi

@@ -4,9 +4,21 @@ module Telnyx
   module Resources
     # UAC connection operations
     class SipRegistrationStatus
-      # 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.
       sig do
         params(
           credential_type:
@@ -18,13 +30,14 @@ module Telnyx
       end
       def retrieve(
         # The kind of credential to look up. `uac_external_credential` is keyed by
-        # `connection_id`; `telephony_credential` is keyed by `username`.
+        # `connection_id`; `telephony_credential` and `sip_credential_connection` are
+        # keyed by `username`.
         credential_type:,
         # Identifier of the UAC connection to look up. Required when `credential_type` is
         # `uac_external_credential`.
         connection_id: nil,
-        # SIP username of the telephony credential to look up. Required when
-        # `credential_type` is `telephony_credential`.
+        # SIP username to look up. Required when `credential_type` is
+        # `telephony_credential` or `sip_credential_connection`.
         username: nil,
         request_options: {}
       )

data/rbi/telnyx/resources/storage/migration_sources.rbi

@@ -31,7 +31,7 @@ module Telnyx
         )
         end
 
-        # Get a Migration Source
+        # Retrieve the details of a specific migration source.
         sig do
           params(
             id: String,
@@ -45,7 +45,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.
         sig do
           params(request_options: Telnyx::RequestOptions::OrHash).returns(
             Telnyx::Models::Storage::MigrationSourceListResponse
@@ -54,7 +56,7 @@ module Telnyx
         def list(request_options: {})
         end
 
-        # Delete a Migration Source
+        # Delete a migration source configuration.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/storage/migrations/actions.rbi

@@ -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.
           sig do
             params(
               id: String,

data/rbi/telnyx/resources/storage/migrations.rbi

@@ -35,7 +35,7 @@ module Telnyx
         )
         end
 
-        # Get a Migration
+        # Retrieve the details and status of a specific storage migration.
         sig do
           params(
             id: String,
@@ -49,7 +49,7 @@ module Telnyx
         )
         end
 
-        # List all Migrations
+        # Retrieve a list of the storage migrations on your account.
         sig do
           params(request_options: Telnyx::RequestOptions::OrHash).returns(
             Telnyx::Models::Storage::MigrationListResponse

data/rbi/telnyx/resources/storage.rbi

@@ -25,7 +25,7 @@ module Telnyx
       sig { returns(Telnyx::Resources::Storage::Cloudfs) }
       attr_reader :cloudfs
 
-      # List Migration Source coverage
+      # List the external storage providers and regions supported as migration sources.
       sig do
         params(request_options: Telnyx::RequestOptions::OrHash).returns(
           Telnyx::Models::StorageListMigrationSourceCoverageResponse

data/rbi/telnyx/resources/sub_number_orders.rbi

@@ -68,7 +68,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.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/user_addresses.rbi

@@ -98,7 +98,11 @@ module Telnyx
           page_size: Integer,
           sort: Telnyx::UserAddressListParams::Sort::OrSymbol,
           request_options: Telnyx::RequestOptions::OrHash
-        ).returns(Telnyx::Internal::DefaultFlatPagination[Telnyx::UserAddress])
+        ).returns(
+          Telnyx::Internal::DefaultFlatPagination[
+            Telnyx::UserAddressesUserAddress
+          ]
+        )
       end
       def list(
         # Consolidated filter parameter (deepObject style). Originally:

data/rbi/telnyx/resources/verifications/actions.rbi

@@ -5,7 +5,9 @@ module Telnyx
     class Verifications
       # Two factor authentication API
       class Actions
-        # 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.
         sig do
           params(
             verification_id: String,

data/rbi/telnyx/resources/verifications/by_phone_number/actions.rbi

@@ -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.
           sig do
             params(
               phone_number: String,

data/rbi/telnyx/resources/verifications/by_phone_number.rbi

@@ -11,7 +11,8 @@ module Telnyx
         end
         attr_reader :actions
 
-        # List verifications by phone number
+        # Returns a paginated list of verifications associated with the specified phone
+        # number.
         sig do
           params(
             phone_number: String,

data/rbi/telnyx/resources/verifications.rbi

@@ -12,7 +12,8 @@ module Telnyx
       sig { returns(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.
       sig do
         params(
           verification_id: String,
@@ -26,7 +27,9 @@ module Telnyx
       )
       end
 
-      # 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.
       sig do
         params(
           phone_number: String,
@@ -53,7 +56,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.
       sig do
         params(
           phone_number: String,
@@ -73,7 +78,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.
       sig do
         params(
           phone_number: String,
@@ -96,7 +102,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.
       sig do
         params(
           phone_number: String,

data/rbi/telnyx/resources/verified_numbers/actions.rbi

@@ -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.
         sig do
           params(
             phone_number: String,

data/rbi/telnyx/resources/verified_numbers.rbi

@@ -33,7 +33,7 @@ module Telnyx
       )
       end
 
-      # Retrieve a verified number
+      # Retrieve the details of a verified number on your account.
       sig do
         params(
           phone_number: String,
@@ -60,7 +60,7 @@ module Telnyx
       def list(page_number: nil, page_size: nil, request_options: {})
       end
 
-      # Delete a verified number
+      # Remove a verified number from your account.
       sig do
         params(
           phone_number: String,

data/rbi/telnyx/resources/verify_profiles.rbi

@@ -51,7 +51,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.
       sig do
         params(
           verify_profile_id: String,
@@ -105,7 +106,7 @@ module Telnyx
       )
       end
 
-      # Delete Verify profile
+      # Deletes the specified Verify profile and returns the deleted profile record.
       sig do
         params(
           verify_profile_id: String,

data/rbi/telnyx/resources/webhooks.rbi

@@ -71,7 +71,7 @@ module Telnyx
             Telnyx::FaxSendingStarted,
             Telnyx::HostedNumberOrderEventWebhookEvent,
             Telnyx::InboundMessageWebhookEvent,
-            Telnyx::NumberOrderStatusUpdate,
+            Telnyx::NumberOrderStatusUpdateWebhookEvent,
             Telnyx::ReplacedLinkClickWebhookEvent,
             Telnyx::TranscriptionWebhookEvent
           )
@@ -155,7 +155,7 @@ module Telnyx
             Telnyx::FaxSendingStarted,
             Telnyx::HostedNumberOrderEventWebhookEvent,
             Telnyx::InboundMessageWebhookEvent,
-            Telnyx::NumberOrderStatusUpdate,
+            Telnyx::NumberOrderStatusUpdateWebhookEvent,
             Telnyx::ReplacedLinkClickWebhookEvent,
             Telnyx::TranscriptionWebhookEvent
           )

data/rbi/telnyx/resources/whatsapp/business_accounts/phone_numbers.rbi

@@ -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.
           sig do
             params(
               id: String,
@@ -27,7 +27,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.
           sig do
             params(
               id: String,

data/rbi/telnyx/resources/whatsapp/business_accounts/settings.rbi

@@ -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.
           sig do
             params(
               id: String,
@@ -22,7 +22,8 @@ module Telnyx
           )
           end
 
-          # Update WABA settings
+          # Updates the supplied account-level settings for the specified WhatsApp Business
+          # Account.
           sig do
             params(
               id: String,

data/rbi/telnyx/resources/whatsapp/business_accounts.rbi

@@ -14,7 +14,7 @@ module Telnyx
         sig { returns(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.
         sig do
           params(
             id: String,
@@ -28,7 +28,7 @@ module Telnyx
         )
         end
 
-        # List Whatsapp Business Accounts
+        # Returns WhatsApp Business Accounts linked to the authenticated Telnyx account.
         sig do
           params(
             page_number: Integer,
@@ -43,7 +43,8 @@ module Telnyx
         def list(page_number: nil, page_size: nil, request_options: {})
         end
 
-        # Delete a Whatsapp Business Account
+        # Unlinks and deletes the specified WhatsApp Business Account resource from
+        # Telnyx.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/whatsapp/phone_numbers/calling_settings.rbi

@@ -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.
           sig do
             params(
               phone_number: String,
@@ -22,7 +22,7 @@ module Telnyx
           )
           end
 
-          # Enable or disable Whatsapp calling for a phone number
+          # Enables or disables WhatsApp calling for the specified phone number.
           sig do
             params(
               phone_number: String,

data/rbi/telnyx/resources/whatsapp/phone_numbers/conversational_components.rbi

@@ -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.
           sig do
             params(
               phone_number: String,
@@ -22,7 +23,8 @@ module Telnyx
           )
           end
 
-          # Update phone number conversational components
+          # Updates the conversational components configured for the specified WhatsApp
+          # phone number.
           sig do
             params(
               phone_number: String,

data/rbi/telnyx/resources/whatsapp/phone_numbers/profile/photo.rbi

@@ -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.
             sig do
               params(
                 phone_number: String,
@@ -23,7 +24,7 @@ module Telnyx
             )
             end
 
-            # Delete Whatsapp profile photo
+            # Removes the business-profile photo from the specified WhatsApp phone number.
             sig do
               params(
                 phone_number: String,
@@ -37,7 +38,8 @@ module Telnyx
             )
             end
 
-            # Upload Whatsapp profile photo
+            # Uploads and assigns a business-profile photo to the specified WhatsApp phone
+            # number.
             sig do
               params(
                 phone_number: String,

data/rbi/telnyx/resources/whatsapp/phone_numbers/profile.rbi

@@ -12,7 +12,7 @@ module Telnyx
           end
           attr_reader :photo
 
-          # Get phone number business profile
+          # Returns the business profile displayed for the specified WhatsApp phone number.
           sig do
             params(
               phone_number: String,
@@ -28,7 +28,8 @@ module Telnyx
           )
           end
 
-          # Update phone number business profile
+          # Updates the supplied business-profile fields for the specified WhatsApp phone
+          # number.
           sig do
             params(
               phone_number: String,

data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi

@@ -23,7 +23,7 @@ module Telnyx
         end
         attr_reader :conversational_components
 
-        # List Whatsapp phone numbers
+        # Returns WhatsApp phone numbers linked to the authenticated Telnyx account.
         sig do
           params(
             page_number: Integer,
@@ -38,7 +38,7 @@ module Telnyx
         def list(page_number: nil, page_size: nil, request_options: {})
         end
 
-        # Delete a Whatsapp phone number
+        # Removes the specified phone number from Telnyx WhatsApp management.
         sig do
           params(
             phone_number: String,
@@ -52,7 +52,18 @@ module Telnyx
         )
         end
 
-        # Resend verification code
+        # Retrieve a list of the phone numbers registered for WhatsApp on your account.
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::Whatsapp::PhoneNumberGetResponse)
+        end
+        def get(page_number: nil, page_size: nil, request_options: {})
+        end
+
+        # Requests a new verification code for the specified WhatsApp phone number.
         sig do
           params(
             phone_number: String,
@@ -90,7 +101,7 @@ module Telnyx
         )
         end
 
-        # Submit verification code for a phone number
+        # Submits the verification code received for the specified WhatsApp phone number.
         sig do
           params(
             phone_number: String,

data/rbi/telnyx/resources/whatsapp/templates.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class Whatsapp
       # Manage Whatsapp message templates
       class Templates
-        # Create a Whatsapp message template
+        # Creates a WhatsApp message template for review and subsequent use in template
+        # messages.
         sig do
           params(
             category:
@@ -43,7 +44,8 @@ module Telnyx
         )
         end
 
-        # List Whatsapp message templates
+        # Returns WhatsApp message templates owned by the authenticated account, including
+        # their current review state.
         sig do
           params(
             filter_category:

data/rbi/telnyx/resources/whatsapp/user_data.rbi

@@ -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.
         sig do
           params(request_options: Telnyx::RequestOptions::OrHash).returns(
             Telnyx::Models::Whatsapp::UserDataRetrieveResponse
@@ -14,7 +15,8 @@ module Telnyx
         def retrieve(request_options: {})
         end
 
-        # Update Whatsapp user data
+        # Updates the supplied WhatsApp user-data settings for the authenticated Telnyx
+        # account.
         sig do
           params(
             webhook_failover_url: String,

data/rbi/telnyx/resources/whatsapp_message_templates.rbi

@@ -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.
       sig do
         params(
           id: String,
@@ -18,7 +19,7 @@ module Telnyx
       )
       end
 
-      # Update a Whatsapp message template
+      # Updates the editable fields of the specified WhatsApp message template.
       sig do
         params(
           id: String,
@@ -47,7 +48,7 @@ module Telnyx
       )
       end
 
-      # Delete a Whatsapp message template
+      # Deletes the specified WhatsApp message template.
       sig do
         params(id: String, request_options: Telnyx::RequestOptions::OrHash).void
       end

data/sig/telnyx/client.rbs

@@ -220,7 +220,7 @@ module Telnyx
 
     attr_reader queues: Telnyx::Resources::Queues
 
-    attr_reader rcs_agents: Telnyx::Resources::RcsAgents
+    attr_reader rcs: Telnyx::Resources::Rcs
 
     attr_reader recording_transcriptions: Telnyx::Resources::RecordingTranscriptions