telnyx 5.162.0 → 5.164.0

data/lib/telnyx/resources/ip_connections.rb

@@ -7,7 +7,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::IPConnectionCreateParams} for more details.
       #
-      # Creates an IP connection.
+      # Creates a new IP-based SIP connection, which authenticates traffic by source IP
+      # address.
       #
       # @overload create(active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #
@@ -169,7 +170,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::IPConnectionListParams} for more details.
       #
-      # Returns a list of your IP connections.
+      # Returns a paginated list of your IP-based SIP connections, with support for
+      # filtering and sorting.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
       #
@@ -200,7 +202,7 @@ module Telnyx
         )
       end
 
-      # Deletes an existing IP connection.
+      # Permanently deletes the specified IP connection from your account.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/ips.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # IP operations
     class IPs
-      # Create a new IP object.
+      # Creates a new IP record for use with IP-based connections, associating an IP
+      # address with the specified connection.
       #
       # @overload create(ip_address:, connection_id: nil, port: nil, request_options: {})
       #
@@ -50,7 +51,7 @@ module Telnyx
         )
       end
 
-      # Update the details of a specific IP.
+      # Updates the details of the specified IP record and returns the updated IP.
       #
       # @overload update(id, ip_address:, connection_id: nil, port: nil, request_options: {})
       #
@@ -110,7 +111,7 @@ module Telnyx
         )
       end
 
-      # Delete an IP.
+      # Permanently deletes the specified IP record from its connection.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/legacy/reporting/usage_reports/messaging.rb

@@ -40,7 +40,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.
             #
             # @overload retrieve(id, request_options: {})
             #

data/lib/telnyx/resources/legacy/reporting/usage_reports/number_lookup.rb

@@ -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.
             #
             # @overload create(aggregation_type: nil, end_date: nil, managed_accounts: nil, start_date: nil, request_options: {})
             #

data/lib/telnyx/resources/legacy/reporting/usage_reports/voice.rb

@@ -46,7 +46,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.
             #
             # @overload retrieve(id, request_options: {})
             #

data/lib/telnyx/resources/managed_accounts.rb

@@ -65,7 +65,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::ManagedAccountUpdateParams} for more details.
       #
-      # Update a single managed account.
+      # Updates the specified managed account's attributes and returns the updated
+      # account.
       #
       # @overload update(id, managed_account_allow_custom_pricing: nil, request_options: {})
       #

data/lib/telnyx/resources/media.rb

@@ -27,7 +27,7 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::MediaUpdateParams} for more details.
       #
-      # Updates a stored media file.
+      # Updates the specified stored media file and returns the updated resource.
       #
       # @overload update(media_name, media_url: nil, ttl_secs: nil, request_options: {})
       #
@@ -56,7 +56,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::MediaListParams} for more details.
       #
-      # Returns a list of stored media files.
+      # Returns a list of the media files stored on your account, with support for
+      # filtering.
       #
       # @overload list(filter: nil, request_options: {})
       #
@@ -79,7 +80,7 @@ module Telnyx
         )
       end
 
-      # Deletes a stored media file.
+      # Permanently deletes the specified media file from storage.
       #
       # @overload delete(media_name, request_options: {})
       #
@@ -99,7 +100,7 @@ module Telnyx
         )
       end
 
-      # Downloads a stored media file.
+      # Downloads the raw content of the specified stored media file.
       #
       # @overload download(media_name, request_options: {})
       #

data/lib/telnyx/resources/messaging_10dlc/brand.rb

@@ -83,7 +83,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.
         #
         # @overload retrieve(brand_id, request_options: {})
         #

data/lib/telnyx/resources/messaging_10dlc.rb

@@ -35,7 +35,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Array<String>, Array<Hash{Symbol=>Object}>, Hash{Symbol=>String}, Hash{Symbol=>Object}, Telnyx::Models::Messaging10dlcGetEnumResponse::EnumPaginatedResponse]
+      # @return [Array<String>, Array<Hash{Symbol=>Object}>, Hash{Symbol=>String}, Hash{Symbol=>Hash{Symbol=>Object}}, Telnyx::Models::Messaging10dlcGetEnumResponse::EnumPaginatedResponse]
       #
       # @see Telnyx::Models::Messaging10dlcGetEnumParams
       def get_enum(endpoint, params = {})

data/lib/telnyx/resources/messaging_optouts.rb

@@ -7,7 +7,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::MessagingOptoutListParams} for more details.
       #
-      # 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.
       #
       # @overload list(created_at: nil, filter: nil, page_number: nil, page_size: nil, redaction_enabled: nil, request_options: {})
       #

data/lib/telnyx/resources/mobile_push_credentials.rb

@@ -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.
       #
       # @overload create(create_mobile_push_credential_request:, request_options: {})
       #
@@ -48,7 +49,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::MobilePushCredentialListParams} for more details.
       #
-      # List mobile push credentials
+      # Returns a paginated list of the mobile push credentials on your account, with
+      # support for filtering.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
       #

data/lib/telnyx/resources/mobile_voice_connections.rb

@@ -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.
       #
       # @overload create(active: nil, connection_name: nil, inbound: nil, outbound: nil, tags: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #

data/lib/telnyx/resources/networks/default_gateway.rb

@@ -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.
         #
         # @overload create(network_identifier, wireguard_peer_id: nil, request_options: {})
         #
@@ -29,7 +30,7 @@ module Telnyx
           )
         end
 
-        # Get Default Gateway status.
+        # Returns the status of the default gateway configured on the specified network.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -49,7 +50,7 @@ module Telnyx
           )
         end
 
-        # Delete Default Gateway.
+        # Removes the default gateway from the specified network.
         #
         # @overload delete(id, request_options: {})
         #

data/lib/telnyx/resources/networks.rb

@@ -8,7 +8,8 @@ module Telnyx
       # @return [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.
       #
       # @overload create(network_create:, request_options: {})
       #
@@ -29,7 +30,7 @@ module Telnyx
         )
       end
 
-      # Retrieve a Network.
+      # Returns the details of a single network by its identifier.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -49,7 +50,7 @@ module Telnyx
         )
       end
 
-      # Update a Network.
+      # Updates the specified network's attributes and returns the updated network.
       #
       # @overload update(network_id, network_create:, request_options: {})
       #
@@ -73,7 +74,8 @@ module Telnyx
         )
       end
 
-      # List all Networks.
+      # Returns a paginated list of the private networks on your account, with support
+      # for filtering.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
       #
@@ -101,7 +103,7 @@ module Telnyx
         )
       end
 
-      # Delete a Network.
+      # Permanently deletes the specified network from your account.
       #
       # @overload delete(id, request_options: {})
       #
@@ -124,7 +126,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::NetworkListInterfacesParams} for more details.
       #
-      # List all Interfaces for a Network.
+      # Returns a paginated list of the interfaces attached to the specified network,
+      # with support for filtering.
       #
       # @overload list_interfaces(id, filter: nil, page_number: nil, page_size: nil, request_options: {})
       #

data/lib/telnyx/resources/notification_channels.rb

@@ -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.
       #
       # @overload create(channel_destination: nil, channel_type_id: nil, notification_profile_id: nil, request_options: {})
       #
@@ -30,7 +31,7 @@ module Telnyx
         )
       end
 
-      # Get a notification channel.
+      # Returns the details of a single notification channel by its identifier.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -50,7 +51,7 @@ module Telnyx
         )
       end
 
-      # Update a notification channel.
+      # Updates the specified notification channel and returns the updated channel.
       #
       # @overload update(notification_channel_id, channel_destination: nil, channel_type_id: nil, notification_profile_id: nil, request_options: {})
       #
@@ -81,7 +82,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::NotificationChannelListParams} for more details.
       #
-      # List notification channels.
+      # Returns a paginated list of your notification channels, the destinations that
+      # receive notifications.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
       #
@@ -110,7 +112,8 @@ module Telnyx
         )
       end
 
-      # Delete a notification channel.
+      # Deletes the specified notification channel so notifications are no longer
+      # delivered to it.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/notification_profiles.rb

@@ -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.
       #
       # @overload create(name: nil, request_options: {})
       #
@@ -26,7 +27,7 @@ module Telnyx
         )
       end
 
-      # Get a notification profile.
+      # Returns the details of a single notification profile by its identifier.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -46,7 +47,7 @@ module Telnyx
         )
       end
 
-      # Update a notification profile.
+      # Updates the specified notification profile and returns the updated profile.
       #
       # @overload update(notification_profile_id, name: nil, request_options: {})
       #
@@ -94,7 +95,7 @@ module Telnyx
         )
       end
 
-      # Delete a notification profile.
+      # Deletes the specified notification profile from your account.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/notification_settings.rb

@@ -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.
       #
       # @overload create(notification_channel_id: nil, notification_event_condition_id: nil, notification_profile_id: nil, parameters: nil, request_options: {})
       #
@@ -32,7 +33,7 @@ module Telnyx
         )
       end
 
-      # Get a notification setting.
+      # Returns the details of a single notification setting by its identifier.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -55,7 +56,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::NotificationSettingListParams} for more details.
       #
-      # List notification settings.
+      # Returns a paginated list of your notification settings, which map notification
+      # event types to profiles and channels.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
       #
@@ -84,7 +86,8 @@ module Telnyx
         )
       end
 
-      # Delete a notification setting.
+      # Deletes the specified notification setting, disabling that notification
+      # delivery.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/number_block_orders.rb

@@ -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.
       #
       # @overload create(range:, starting_number:, connection_id: nil, customer_reference: nil, messaging_profile_id: nil, request_options: {})
       #

data/lib/telnyx/resources/number_orders.rb

@@ -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.
       #
       # @overload create(billing_group_id: nil, connection_id: nil, customer_reference: nil, messaging_profile_id: nil, phone_numbers: nil, request_options: {})
       #
@@ -34,7 +35,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.
       #
       # @overload retrieve(number_order_id, request_options: {})
       #
@@ -54,7 +56,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.
       #
       # @overload update(number_order_id, customer_reference: nil, regulatory_requirements: nil, request_options: {})
       #
@@ -83,7 +86,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::NumberOrderListParams} for more details.
       #
-      # Get a paginated list of number orders.
+      # Returns a paginated list of your phone number orders, with support for
+      # filtering.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
       #

data/lib/telnyx/resources/number_reservations.rb

@@ -32,7 +32,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.
       #
       # @overload retrieve(number_reservation_id, request_options: {})
       #

data/lib/telnyx/resources/oauth.rb

@@ -23,7 +23,8 @@ module Telnyx
         )
       end
 
-      # Create an OAuth authorization grant
+      # Creates an OAuth authorization grant and returns the grant response for
+      # completing the authorization flow.
       #
       # @overload grants(allowed:, consent_token:, request_options: {})
       #
@@ -128,7 +129,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [nil]
+      # @return [String]
       #
       # @see Telnyx::Models::OAuthRetrieveAuthorizeParams
       def retrieve_authorize(params)
@@ -138,7 +139,8 @@ module Telnyx
           method: :get,
           path: "oauth/authorize",
           query: query,
-          model: NilClass,
+          headers: {"accept" => "text/html"},
+          model: String,
           options: options
         )
       end

data/lib/telnyx/resources/oauth_clients.rb

@@ -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.
       #
       # @overload create(allowed_grant_types:, allowed_scopes:, client_type:, name:, logo_uri: nil, policy_uri: nil, redirect_uris: nil, require_pkce: nil, tos_uri: nil, request_options: {})
       #
@@ -41,7 +42,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.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -61,7 +62,8 @@ module Telnyx
         )
       end
 
-      # Update an existing OAuth client
+      # Updates the specified OAuth client's configuration and returns the updated
+      # client.
       #
       # @overload update(id, allowed_grant_types: nil, allowed_scopes: nil, logo_uri: nil, name: nil, policy_uri: nil, redirect_uris: nil, require_pkce: nil, tos_uri: nil, request_options: {})
       #
@@ -146,7 +148,7 @@ module Telnyx
         )
       end
 
-      # Delete an OAuth client
+      # Permanently deletes the specified OAuth client from your account.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/oauth_grants.rb

@@ -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.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -49,7 +49,8 @@ module Telnyx
         )
       end
 
-      # Revoke an OAuth grant
+      # Revokes the specified OAuth grant, withdrawing the access previously granted to
+      # the client.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/organizations/users/actions.rb

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

data/lib/telnyx/resources/organizations/users.rb

@@ -12,7 +12,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Organizations::UserRetrieveParams} for more details.
         #
-        # Returns a user in your organization.
+        # Returns the details of a user in your organization, optionally including the
+        # groups the user belongs to.
         #
         # @overload retrieve(id, include_groups: nil, request_options: {})
         #

data/lib/telnyx/resources/outbound_voice_profiles.rb

@@ -7,7 +7,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::OutboundVoiceProfileCreateParams} for more details.
       #
-      # 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.
       #
       # @overload create(name:, billing_group_id: nil, call_recording: nil, calling_window: nil, concurrent_call_limit: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, max_destination_rate: nil, service_plan: nil, tags: nil, traffic_type: nil, usage_payment_method: nil, whitelisted_destinations: nil, request_options: {})
       #

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

@@ -29,12 +29,14 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::PhoneNumbers::JobListParams} for more details.
         #
-        # 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.
         #
         # @overload list(filter: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
         #
-        # @param filter [Telnyx::Models::PhoneNumbers::JobListParams::Filter] Consolidated filter parameter (deepObject style). Originally: filter[type]
+        # @param filter [Telnyx::Models::PhoneNumbers::JobListParams::Filter] Consolidated filter parameter (deepObject style). Originally: filter[type], filt
         #
         # @param page_number [Integer]
         #

data/lib/telnyx/resources/porting/events.rb

@@ -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.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -28,7 +28,9 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Porting::EventListParams} for more details.
         #
-        # 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.
         #
         # @overload list(filter: nil, page_number: nil, page_size: nil, request_options: {})
         #
@@ -56,7 +58,8 @@ module Telnyx
           )
         end
 
-        # Republish a specific porting event.
+        # Republishes the specified porting event, triggering re-delivery of the
+        # corresponding webhook to your account.
         #
         # @overload republish(id, request_options: {})
         #