telnyx 5.162.0 → 5.164.0

data/rbi/telnyx/resources/legacy/reporting/usage_reports/messaging.rbi

@@ -35,7 +35,8 @@ module Telnyx
             )
             end
 
-            # Fetch single MDR usage report by id.
+            # Returns a single MDR (Message Detail Record) usage report by its identifier,
+            # including its parameters and current status.
             sig do
               params(
                 id: String,

data/rbi/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rbi

@@ -7,7 +7,8 @@ module Telnyx
         class UsageReports
           # Number lookup usage reports
           class NumberLookup
-            # Submit a new telco data usage report
+            # Submits a new telco data (number lookup) usage report request. The report is
+            # generated asynchronously; retrieve it by its identifier once ready.
             sig do
               params(
                 aggregation_type:

data/rbi/telnyx/resources/legacy/reporting/usage_reports/voice.rbi

@@ -42,7 +42,8 @@ module Telnyx
             )
             end
 
-            # Fetch single cdr usage report by id.
+            # Returns a single CDR (Call Detail Record) usage report by its identifier,
+            # including its parameters and current status.
             sig do
               params(
                 id: String,

data/rbi/telnyx/resources/managed_accounts.rbi

@@ -61,7 +61,8 @@ module Telnyx
       )
       end
 
-      # Update a single managed account.
+      # Updates the specified managed account's attributes and returns the updated
+      # account.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/media.rbi

@@ -18,7 +18,7 @@ module Telnyx
       )
       end
 
-      # Updates a stored media file.
+      # Updates the specified stored media file and returns the updated resource.
       sig do
         params(
           media_name: String,
@@ -40,7 +40,8 @@ module Telnyx
       )
       end
 
-      # Returns a list of stored media files.
+      # Returns a list of the media files stored on your account, with support for
+      # filtering.
       sig do
         params(
           filter: Telnyx::MediaListParams::Filter::OrHash,
@@ -55,7 +56,7 @@ module Telnyx
       )
       end
 
-      # Deletes a stored media file.
+      # Permanently deletes the specified media file from storage.
       sig do
         params(
           media_name: String,
@@ -69,7 +70,7 @@ module Telnyx
       )
       end
 
-      # Downloads a stored media file.
+      # Downloads the raw content of the specified stored media file.
       sig do
         params(
           media_name: String,

data/rbi/telnyx/resources/messaging_10dlc/brand.rbi

@@ -100,7 +100,8 @@ module Telnyx
         )
         end
 
-        # Retrieve a brand by `brandId`.
+        # Returns the details of a 10DLC brand by its brandId, including the count of
+        # campaigns associated with the brand.
         sig do
           params(
             brand_id: String,

data/rbi/telnyx/resources/messaging_optouts.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Opt-Out Management
     class MessagingOptouts
-      # Retrieve a list of opt-out blocks.
+      # Returns a paginated list of opt-out blocks created when message recipients opt
+      # out. Supports filtering and optional redaction of recipient numbers.
       sig do
         params(
           created_at: Telnyx::MessagingOptoutListParams::CreatedAt::OrHash,

data/rbi/telnyx/resources/mobile_push_credentials.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Mobile push credential management
     class MobilePushCredentials
-      # Creates a new mobile push credential
+      # Creates a new mobile push credential for delivering push notifications to iOS or
+      # Android apps, and returns the created credential.
       sig do
         params(
           create_mobile_push_credential_request:
@@ -32,7 +33,8 @@ module Telnyx
       )
       end
 
-      # List mobile push credentials
+      # Returns a paginated list of the mobile push credentials on your account, with
+      # support for filtering.
       sig do
         params(
           filter: Telnyx::MobilePushCredentialListParams::Filter::OrHash,

data/rbi/telnyx/resources/mobile_voice_connections.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Mobile voice connection operations
     class MobileVoiceConnections
-      # Create a new mobile voice connection.
+      # Creates a new mobile voice connection with the provided configuration and
+      # returns the created connection.
       sig do
         params(
           active: T::Boolean,

data/rbi/telnyx/resources/networks/default_gateway.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class Networks
       # Network operations
       class DefaultGateway
-        # Create Default Gateway.
+        # Creates a default gateway on the specified network, directing the network's
+        # outbound traffic through the chosen gateway.
         sig do
           params(
             network_identifier: String,
@@ -22,7 +23,7 @@ module Telnyx
         )
         end
 
-        # Get Default Gateway status.
+        # Returns the status of the default gateway configured on the specified network.
         sig do
           params(
             id: String,
@@ -36,7 +37,7 @@ module Telnyx
         )
         end
 
-        # Delete Default Gateway.
+        # Removes the default gateway from the specified network.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/networks.rbi

@@ -8,7 +8,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::Networks::DefaultGateway) }
       attr_reader :default_gateway
 
-      # Create a new Network.
+      # Creates a new private network, the container that links your WireGuard
+      # interfaces, gateways, and cross connects.
       sig do
         params(
           network_create: Telnyx::NetworkCreate::OrHash,
@@ -18,7 +19,7 @@ module Telnyx
       def create(network_create:, request_options: {})
       end
 
-      # Retrieve a Network.
+      # Returns the details of a single network by its identifier.
       sig do
         params(
           id: String,
@@ -32,7 +33,7 @@ module Telnyx
       )
       end
 
-      # Update a Network.
+      # Updates the specified network's attributes and returns the updated network.
       sig do
         params(
           network_id: String,
@@ -48,7 +49,8 @@ module Telnyx
       )
       end
 
-      # List all Networks.
+      # Returns a paginated list of the private networks on your account, with support
+      # for filtering.
       sig do
         params(
           filter: Telnyx::NetworkListParams::Filter::OrHash,
@@ -66,7 +68,7 @@ module Telnyx
       )
       end
 
-      # Delete a Network.
+      # Permanently deletes the specified network from your account.
       sig do
         params(
           id: String,
@@ -80,7 +82,8 @@ module Telnyx
       )
       end
 
-      # List all Interfaces for a Network.
+      # Returns a paginated list of the interfaces attached to the specified network,
+      # with support for filtering.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/notification_channels.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Notification settings operations
     class NotificationChannels
-      # Create a notification channel.
+      # Creates a new notification channel defining where notifications are delivered,
+      # and returns the created channel.
       sig do
         params(
           channel_destination: String,
@@ -24,7 +25,7 @@ module Telnyx
       )
       end
 
-      # Get a notification channel.
+      # Returns the details of a single notification channel by its identifier.
       sig do
         params(
           id: String,
@@ -38,7 +39,7 @@ module Telnyx
       )
       end
 
-      # Update a notification channel.
+      # Updates the specified notification channel and returns the updated channel.
       sig do
         params(
           notification_channel_id: String,
@@ -61,7 +62,8 @@ module Telnyx
       )
       end
 
-      # List notification channels.
+      # Returns a paginated list of your notification channels, the destinations that
+      # receive notifications.
       sig do
         params(
           filter: Telnyx::NotificationChannelListParams::Filter::OrHash,
@@ -84,7 +86,8 @@ module Telnyx
       )
       end
 
-      # Delete a notification channel.
+      # Deletes the specified notification channel so notifications are no longer
+      # delivered to it.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/notification_profiles.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Notification settings operations
     class NotificationProfiles
-      # Create a notification profile.
+      # Creates a new notification profile, a named grouping used to organize
+      # notification settings, and returns it.
       sig do
         params(
           name: String,
@@ -18,7 +19,7 @@ module Telnyx
       )
       end
 
-      # Get a notification profile.
+      # Returns the details of a single notification profile by its identifier.
       sig do
         params(
           id: String,
@@ -32,7 +33,7 @@ module Telnyx
       )
       end
 
-      # Update a notification profile.
+      # Updates the specified notification profile and returns the updated profile.
       sig do
         params(
           notification_profile_id: String,
@@ -62,7 +63,7 @@ module Telnyx
       def list(page_number: nil, page_size: nil, request_options: {})
       end
 
-      # Delete a notification profile.
+      # Deletes the specified notification profile from your account.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/notification_settings.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Notification settings operations
     class NotificationSettings
-      # Add a notification setting.
+      # Adds a notification setting that enables delivery of a notification event type
+      # to a notification profile.
       sig do
         params(
           notification_channel_id: String,
@@ -26,7 +27,7 @@ module Telnyx
       )
       end
 
-      # Get a notification setting.
+      # Returns the details of a single notification setting by its identifier.
       sig do
         params(
           id: String,
@@ -40,7 +41,8 @@ module Telnyx
       )
       end
 
-      # List notification settings.
+      # Returns a paginated list of your notification settings, which map notification
+      # event types to profiles and channels.
       sig do
         params(
           filter: Telnyx::NotificationSettingListParams::Filter::OrHash,
@@ -63,7 +65,8 @@ module Telnyx
       )
       end
 
-      # Delete a notification setting.
+      # Deletes the specified notification setting, disabling that notification
+      # delivery.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/number_block_orders.rbi

@@ -3,7 +3,8 @@
 module Telnyx
   module Resources
     class NumberBlockOrders
-      # Creates a phone number block order.
+      # Creates an order for a block of consecutive phone numbers and returns the
+      # created order. Track fulfillment through the order's status.
       sig do
         params(
           range: Integer,

data/rbi/telnyx/resources/number_orders.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Number orders
     class NumberOrders
-      # Creates a phone number order.
+      # Creates an order to purchase the specified phone numbers and returns the created
+      # order. Track fulfillment through the order's status.
       sig do
         params(
           billing_group_id: String,
@@ -30,7 +31,8 @@ module Telnyx
       )
       end
 
-      # Get an existing phone number order.
+      # Returns the details of an existing phone number order, including its status and
+      # the numbers included.
       sig do
         params(
           number_order_id: String,
@@ -44,7 +46,8 @@ module Telnyx
       )
       end
 
-      # Updates a phone number order.
+      # Updates an existing phone number order, for example to satisfy regulatory
+      # requirements attached to the order, and returns the updated order.
       sig do
         params(
           number_order_id: String,
@@ -64,7 +67,8 @@ module Telnyx
       )
       end
 
-      # Get a paginated list of number orders.
+      # Returns a paginated list of your phone number orders, with support for
+      # filtering.
       sig do
         params(
           filter: Telnyx::NumberOrderListParams::Filter::OrHash,

data/rbi/telnyx/resources/number_reservations.rbi

@@ -24,7 +24,8 @@ module Telnyx
       )
       end
 
-      # Gets a single phone number reservation.
+      # Returns the details of a single phone number reservation, including its status
+      # and the reserved numbers.
       sig do
         params(
           number_reservation_id: String,

data/rbi/telnyx/resources/oauth.rbi

@@ -17,7 +17,8 @@ module Telnyx
       )
       end
 
-      # Create an OAuth authorization grant
+      # Creates an OAuth authorization grant and returns the grant response for
+      # completing the authorization flow.
       sig do
         params(
           allowed: T::Boolean,
@@ -101,7 +102,7 @@ module Telnyx
           scope: String,
           state: String,
           request_options: Telnyx::RequestOptions::OrHash
-        ).void
+        ).returns(String)
       end
       def retrieve_authorize(
         # OAuth client identifier

data/rbi/telnyx/resources/oauth_clients.rbi

@@ -3,7 +3,8 @@
 module Telnyx
   module Resources
     class OAuthClients
-      # Create a new OAuth client
+      # Creates a new OAuth client on your account for authenticating third-party
+      # integrations, and returns the created client.
       sig do
         params(
           allowed_grant_types:
@@ -44,7 +45,7 @@ module Telnyx
       )
       end
 
-      # Retrieve a single OAuth client by ID
+      # Returns the details of a single OAuth client on your account by its ID.
       sig do
         params(
           id: String,
@@ -58,7 +59,8 @@ module Telnyx
       )
       end
 
-      # Update an existing OAuth client
+      # Updates the specified OAuth client's configuration and returns the updated
+      # client.
       sig do
         params(
           id: String,
@@ -136,7 +138,7 @@ module Telnyx
       )
       end
 
-      # Delete an OAuth client
+      # Permanently deletes the specified OAuth client from your account.
       sig do
         params(id: String, request_options: Telnyx::RequestOptions::OrHash).void
       end

data/rbi/telnyx/resources/oauth_grants.rbi

@@ -3,7 +3,7 @@
 module Telnyx
   module Resources
     class OAuthGrants
-      # Retrieve a single OAuth grant by ID
+      # Returns the details of a single OAuth grant on your account by its ID.
       sig do
         params(
           id: String,
@@ -34,7 +34,8 @@ module Telnyx
       )
       end
 
-      # Revoke an OAuth grant
+      # Revokes the specified OAuth grant, withdrawing the access previously granted to
+      # the client.
       sig do
         params(
           id: String,

data/rbi/telnyx/resources/organizations/users/actions.rbi

@@ -6,7 +6,8 @@ module Telnyx
       class Users
         # Operations related to users in your organization
         class Actions
-          # Deletes a user in your organization.
+          # Removes the specified user from your organization and returns the result of the
+          # removal.
           sig do
             params(
               id: String,

data/rbi/telnyx/resources/organizations/users.rbi

@@ -9,7 +9,8 @@ module Telnyx
         sig { returns(Telnyx::Resources::Organizations::Users::Actions) }
         attr_reader :actions
 
-        # Returns a user in your organization.
+        # Returns the details of a user in your organization, optionally including the
+        # groups the user belongs to.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/outbound_voice_profiles.rbi

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Outbound voice profiles operations
     class OutboundVoiceProfiles
-      # Create an outbound voice profile.
+      # Creates a new outbound voice profile defining calling permissions, destinations,
+      # and limits for outbound calls, and returns the created profile.
       sig do
         params(
           name: String,

data/rbi/telnyx/resources/phone_numbers/jobs.rbi

@@ -20,8 +20,10 @@ module Telnyx
         )
         end
 
-        # Returns background jobs that operate on phone numbers. Results can be filtered
-        # by job type and sorted by creation time, and include pagination metadata.
+        # Returns background jobs that operate on phone numbers. Filter by job type,
+        # target phone numbers, or job status, and sort by creation time. Multiple
+        # phone-number or status values use OR semantics within that filter; different
+        # filter categories use AND semantics. Results include pagination metadata.
         sig do
           params(
             filter: Telnyx::PhoneNumbers::JobListParams::Filter::OrHash,
@@ -36,7 +38,8 @@ module Telnyx
           )
         end
         def list(
-          # Consolidated filter parameter (deepObject style). Originally: filter[type]
+          # Consolidated filter parameter (deepObject style). Originally: filter[type],
+          # filter[phone_number], filter[phone_number][], filter[status][]
           filter: nil,
           page_number: nil,
           page_size: nil,

data/rbi/telnyx/resources/porting/events.rbi

@@ -5,7 +5,7 @@ module Telnyx
     class Porting
       # Endpoints related to porting orders management.
       class Events
-        # Show a specific porting event.
+        # Returns the details of a single porting event, including its type and payload.
         sig do
           params(
             id: String,
@@ -19,7 +19,9 @@ module Telnyx
         )
         end
 
-        # Returns a list of all porting events.
+        # Returns a paginated list of porting-related events on your account, such as
+        # status changes on porting orders. Supports filtering and is useful for auditing
+        # or reconciling webhook deliveries.
         sig do
           params(
             filter: Telnyx::Porting::EventListParams::Filter::OrHash,
@@ -42,7 +44,8 @@ module Telnyx
         )
         end
 
-        # Republish a specific porting event.
+        # Republishes the specified porting event, triggering re-delivery of the
+        # corresponding webhook to your account.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/porting/loa_configurations.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class Porting
       # Endpoints related to porting orders management.
       class LoaConfigurations
-        # Create a LOA configuration.
+        # Creates a new LOA configuration with your company details and branding for use
+        # when generating LOA documents for porting orders.
         sig do
           params(
             address:
@@ -33,7 +34,8 @@ module Telnyx
         )
         end
 
-        # Retrieve a specific LOA configuration.
+        # Returns the details of a single LOA (Letter of Authorization) configuration by
+        # its identifier.
         sig do
           params(
             id: String,
@@ -47,7 +49,8 @@ module Telnyx
         )
         end
 
-        # Update a specific LOA configuration.
+        # Updates the specified LOA configuration with the provided fields and returns the
+        # updated configuration.
         sig do
           params(
             id: String,
@@ -78,7 +81,9 @@ module Telnyx
         )
         end
 
-        # List the LOA configurations.
+        # Returns a paginated list of your LOA (Letter of Authorization) configurations.
+        # LOA configurations customize the company details and branding used on generated
+        # LOA documents.
         sig do
           params(
             page_number: Integer,
@@ -93,7 +98,8 @@ module Telnyx
         def list(page_number: nil, page_size: nil, request_options: {})
         end
 
-        # Delete a specific LOA configuration.
+        # Permanently deletes the specified LOA configuration so it can no longer be used
+        # when generating LOA documents.
         sig do
           params(
             id: String,
@@ -165,7 +171,8 @@ module Telnyx
         )
         end
 
-        # Preview a specific LOA configuration.
+        # Renders a preview of the LOA document produced by this configuration so you can
+        # verify company details and branding before using it on porting orders.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/porting/reports.rbi

@@ -23,7 +23,8 @@ module Telnyx
         )
         end
 
-        # Retrieve a specific report generated.
+        # Returns the details of a previously requested porting report, including its
+        # status and parameters.
         sig do
           params(
             id: String,

data/rbi/telnyx/resources/porting.rbi

@@ -16,7 +16,8 @@ module Telnyx
       sig { returns(Telnyx::Resources::Porting::LoaConfigurations) }
       attr_reader :loa_configurations
 
-      # List available carriers in the UK.
+      # Returns the list of UK carriers available for porting, for use when preparing
+      # porting orders for UK numbers.
       sig do
         params(request_options: Telnyx::RequestOptions::OrHash).returns(
           Telnyx::Models::PortingListUkCarriersResponse

data/rbi/telnyx/resources/porting_orders/actions.rbi

@@ -20,7 +20,7 @@ module Telnyx
         )
         end
 
-        # Cancel a porting order
+        # Requests cancellation of the porting order and returns the updated order.
         sig do
           params(
             id: String,
@@ -34,7 +34,8 @@ module Telnyx
         )
         end
 
-        # Confirm and submit your porting order.
+        # Confirms the porting order and submits it for processing. Make sure all required
+        # information and documents are attached before confirming.
         sig do
           params(
             id: String,