telnyx 7.15.0 → 7.17.0

package/src/resources/networks/default-gateway.ts

@@ -13,7 +13,7 @@ import { path } from '../../internal/utils/path';
  */
 export class DefaultGatewayResource extends APIResource {
   /**
-   * Delete Default Gateway.
+   * Removes the default gateway from the specified network.
    *
    * @example
    * ```ts
@@ -28,7 +28,7 @@ export class DefaultGatewayResource extends APIResource {
   }
 
   /**
-   * Get Default Gateway status.
+   * Returns the status of the default gateway configured on the specified network.
    *
    * @example
    * ```ts
@@ -43,7 +43,8 @@ export class DefaultGatewayResource extends APIResource {
   }
 
   /**
-   * Create Default Gateway.
+   * Creates a default gateway on the specified network, directing the network's
+   * outbound traffic through the chosen gateway.
    *
    * @example
    * ```ts

package/src/resources/networks/networks.ts

@@ -25,7 +25,8 @@ export class Networks extends APIResource {
   );
 
   /**
-   * List all Networks.
+   * Returns a paginated list of the private networks on your account, with support
+   * for filtering.
    *
    * @example
    * ```ts
@@ -43,7 +44,8 @@ export class Networks extends APIResource {
   }
 
   /**
-   * Create a new Network.
+   * Creates a new private network, the container that links your WireGuard
+   * interfaces, gateways, and cross connects.
    *
    * @example
    * ```ts
@@ -58,7 +60,7 @@ export class Networks extends APIResource {
   }
 
   /**
-   * Delete a Network.
+   * Permanently deletes the specified network from your account.
    *
    * @example
    * ```ts
@@ -72,7 +74,7 @@ export class Networks extends APIResource {
   }
 
   /**
-   * Retrieve a Network.
+   * Returns the details of a single network by its identifier.
    *
    * @example
    * ```ts
@@ -86,7 +88,7 @@ export class Networks extends APIResource {
   }
 
   /**
-   * Update a Network.
+   * Updates the specified network's attributes and returns the updated network.
    *
    * @example
    * ```ts
@@ -106,7 +108,8 @@ export class Networks extends APIResource {
   }
 
   /**
-   * List all Interfaces for a Network.
+   * Returns a paginated list of the interfaces attached to the specified network,
+   * with support for filtering.
    *
    * @example
    * ```ts

package/src/resources/notification-channels.ts

@@ -11,7 +11,8 @@ import { path } from '../internal/utils/path';
  */
 export class NotificationChannels extends APIResource {
   /**
-   * List notification channels.
+   * Returns a paginated list of your notification channels, the destinations that
+   * receive notifications.
    *
    * @example
    * ```ts
@@ -32,7 +33,8 @@ export class NotificationChannels extends APIResource {
   }
 
   /**
-   * Create a notification channel.
+   * Creates a new notification channel defining where notifications are delivered,
+   * and returns the created channel.
    *
    * @example
    * ```ts
@@ -48,7 +50,8 @@ export class NotificationChannels extends APIResource {
   }
 
   /**
-   * Delete a notification channel.
+   * Deletes the specified notification channel so notifications are no longer
+   * delivered to it.
    *
    * @example
    * ```ts
@@ -63,7 +66,7 @@ export class NotificationChannels extends APIResource {
   }
 
   /**
-   * Get a notification channel.
+   * Returns the details of a single notification channel by its identifier.
    *
    * @example
    * ```ts
@@ -78,7 +81,7 @@ export class NotificationChannels extends APIResource {
   }
 
   /**
-   * Update a notification channel.
+   * Updates the specified notification channel and returns the updated channel.
    *
    * @example
    * ```ts

package/src/resources/notification-profiles.ts

@@ -24,7 +24,8 @@ export class NotificationProfiles extends APIResource {
   }
 
   /**
-   * Create a notification profile.
+   * Creates a new notification profile, a named grouping used to organize
+   * notification settings, and returns it.
    */
   create(
     body: NotificationProfileCreateParams | null | undefined = {},
@@ -34,21 +35,21 @@ export class NotificationProfiles extends APIResource {
   }
 
   /**
-   * Delete a notification profile.
+   * Deletes the specified notification profile from your account.
    */
   delete(id: string, options?: RequestOptions): APIPromise<NotificationProfileDeleteResponse> {
     return this._client.delete(path`/notification_profiles/${id}`, options);
   }
 
   /**
-   * Get a notification profile.
+   * Returns the details of a single notification profile by its identifier.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<NotificationProfileRetrieveResponse> {
     return this._client.get(path`/notification_profiles/${id}`, options);
   }
 
   /**
-   * Update a notification profile.
+   * Updates the specified notification profile and returns the updated profile.
    */
   update(
     notificationProfileID: string,

package/src/resources/notification-settings.ts

@@ -11,7 +11,8 @@ import { path } from '../internal/utils/path';
  */
 export class NotificationSettings extends APIResource {
   /**
-   * List notification settings.
+   * Returns a paginated list of your notification settings, which map notification
+   * event types to profiles and channels.
    *
    * @example
    * ```ts
@@ -32,7 +33,8 @@ export class NotificationSettings extends APIResource {
   }
 
   /**
-   * Add a notification setting.
+   * Adds a notification setting that enables delivery of a notification event type
+   * to a notification profile.
    *
    * @example
    * ```ts
@@ -48,7 +50,8 @@ export class NotificationSettings extends APIResource {
   }
 
   /**
-   * Delete a notification setting.
+   * Deletes the specified notification setting, disabling that notification
+   * delivery.
    *
    * @example
    * ```ts
@@ -63,7 +66,7 @@ export class NotificationSettings extends APIResource {
   }
 
   /**
-   * Get a notification setting.
+   * Returns the details of a single notification setting by its identifier.
    *
    * @example
    * ```ts

package/src/resources/number-block-orders.ts

@@ -29,7 +29,8 @@ export class NumberBlockOrders extends APIResource {
   }
 
   /**
-   * 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.
    *
    * @example
    * ```ts

package/src/resources/number-orders.ts

@@ -13,7 +13,8 @@ import { path } from '../internal/utils/path';
  */
 export class NumberOrders extends APIResource {
   /**
-   * Get a paginated list of number orders.
+   * Returns a paginated list of your phone number orders, with support for
+   * filtering.
    *
    * @example
    * ```ts
@@ -34,7 +35,8 @@ export class NumberOrders extends APIResource {
   }
 
   /**
-   * 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.
    *
    * @example
    * ```ts
@@ -46,7 +48,8 @@ export class NumberOrders extends APIResource {
   }
 
   /**
-   * Get an existing phone number order.
+   * Returns the details of an existing phone number order, including its status and
+   * the numbers included.
    *
    * @example
    * ```ts
@@ -60,7 +63,8 @@ export class NumberOrders extends APIResource {
   }
 
   /**
-   * 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.
    *
    * @example
    * ```ts

package/src/resources/number-reservations/number-reservations.ts

@@ -52,7 +52,8 @@ export class NumberReservations extends APIResource {
   }
 
   /**
-   * Gets a single phone number reservation.
+   * Returns the details of a single phone number reservation, including its status
+   * and the reserved numbers.
    *
    * @example
    * ```ts

package/src/resources/oauth-clients.ts

@@ -30,7 +30,8 @@ export class OAuthClients extends APIResource {
   }
 
   /**
-   * Create a new OAuth client
+   * Creates a new OAuth client on your account for authenticating third-party
+   * integrations, and returns the created client.
    *
    * @example
    * ```ts
@@ -47,7 +48,7 @@ export class OAuthClients extends APIResource {
   }
 
   /**
-   * Delete an OAuth client
+   * Permanently deletes the specified OAuth client from your account.
    *
    * @example
    * ```ts
@@ -64,7 +65,7 @@ export class OAuthClients extends APIResource {
   }
 
   /**
-   * Retrieve a single OAuth client by ID
+   * Returns the details of a single OAuth client on your account by its ID.
    *
    * @example
    * ```ts
@@ -78,7 +79,8 @@ export class OAuthClients extends APIResource {
   }
 
   /**
-   * Update an existing OAuth client
+   * Updates the specified OAuth client's configuration and returns the updated
+   * client.
    *
    * @example
    * ```ts

package/src/resources/oauth-grants.ts

@@ -18,14 +18,15 @@ export class OAuthGrants extends APIResource {
   }
 
   /**
-   * Revoke an OAuth grant
+   * Revokes the specified OAuth grant, withdrawing the access previously granted to
+   * the client.
    */
   delete(id: string, options?: RequestOptions): APIPromise<OAuthGrantDeleteResponse> {
     return this._client.delete(path`/oauth_grants/${id}`, options);
   }
 
   /**
-   * Retrieve a single OAuth grant by ID
+   * Returns the details of a single OAuth grant on your account by its ID.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<OAuthGrantRetrieveResponse> {
     return this._client.get(path`/oauth_grants/${id}`, options);

package/src/resources/oauth.ts

@@ -12,18 +12,18 @@ export class OAuth extends APIResource {
    *
    * @example
    * ```ts
-   * await client.oauth.retrieveAuthorize({
+   * const response = await client.oauth.retrieveAuthorize({
    *   client_id: 'client_id',
    *   redirect_uri: 'https://example.com',
    *   response_type: 'code',
    * });
    * ```
    */
-  retrieveAuthorize(query: OAuthRetrieveAuthorizeParams, options?: RequestOptions): APIPromise<void> {
+  retrieveAuthorize(query: OAuthRetrieveAuthorizeParams, options?: RequestOptions): APIPromise<string> {
     return this._client.get('/oauth/authorize', {
       query,
       ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+      headers: buildHeaders([{ Accept: 'text/html' }, options?.headers]),
     });
   }
 
@@ -40,7 +40,8 @@ export class OAuth extends APIResource {
   }
 
   /**
-   * Create an OAuth authorization grant
+   * Creates an OAuth authorization grant and returns the grant response for
+   * completing the authorization flow.
    *
    * @example
    * ```ts
@@ -286,6 +287,8 @@ export interface OAuthRegisterResponse {
   tos_uri?: string;
 }
 
+export type OAuthRetrieveAuthorizeResponse = string;
+
 export interface OAuthRetrieveJwksResponse {
   keys?: Array<OAuthRetrieveJwksResponse.Key>;
 }
@@ -492,6 +495,7 @@ export declare namespace OAuth {
     type OAuthGrantsResponse as OAuthGrantsResponse,
     type OAuthIntrospectResponse as OAuthIntrospectResponse,
     type OAuthRegisterResponse as OAuthRegisterResponse,
+    type OAuthRetrieveAuthorizeResponse as OAuthRetrieveAuthorizeResponse,
     type OAuthRetrieveJwksResponse as OAuthRetrieveJwksResponse,
     type OAuthTokenResponse as OAuthTokenResponse,
     type OAuthRetrieveAuthorizeParams as OAuthRetrieveAuthorizeParams,

package/src/resources/organizations/users/actions.ts

@@ -11,7 +11,8 @@ import { path } from '../../../internal/utils/path';
  */
 export class Actions extends APIResource {
   /**
-   * Deletes a user in your organization.
+   * Removes the specified user from your organization and returns the result of the
+   * removal.
    */
   remove(id: string, options?: RequestOptions): APIPromise<ActionRemoveResponse> {
     return this._client.post(path`/organizations/users/${id}/actions/remove`, options);

package/src/resources/organizations/users/users.ts

@@ -54,7 +54,8 @@ export class Users extends APIResource {
   }
 
   /**
-   * Returns a user in your organization.
+   * Returns the details of a user in your organization, optionally including the
+   * groups the user belongs to.
    */
   retrieve(
     id: string,

package/src/resources/outbound-voice-profiles.ts

@@ -33,7 +33,8 @@ export class OutboundVoiceProfiles extends APIResource {
   }
 
   /**
-   * 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.
    *
    * @example
    * ```ts

package/src/resources/porting/events.ts

@@ -13,7 +13,9 @@ import { path } from '../../internal/utils/path';
  */
 export class Events extends APIResource {
   /**
-   * 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.
    *
    * @example
    * ```ts
@@ -34,7 +36,7 @@ export class Events extends APIResource {
   }
 
   /**
-   * Show a specific porting event.
+   * Returns the details of a single porting event, including its type and payload.
    *
    * @example
    * ```ts
@@ -48,7 +50,8 @@ export class Events extends APIResource {
   }
 
   /**
-   * Republish a specific porting event.
+   * Republishes the specified porting event, triggering re-delivery of the
+   * corresponding webhook to your account.
    *
    * @example
    * ```ts

package/src/resources/porting/loa-configurations.ts

@@ -51,7 +51,8 @@ export class LoaConfigurations extends APIResource {
   }
 
   /**
-   * 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.
    *
    * @example
    * ```ts
@@ -73,7 +74,9 @@ export class LoaConfigurations extends APIResource {
   }
 
   /**
-   * 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.
    *
    * @example
    * ```ts
@@ -95,7 +98,8 @@ export class LoaConfigurations extends APIResource {
   }
 
   /**
-   * Create a LOA configuration.
+   * Creates a new LOA configuration with your company details and branding for use
+   * when generating LOA documents for porting orders.
    *
    * @example
    * ```ts
@@ -128,7 +132,8 @@ export class LoaConfigurations extends APIResource {
   }
 
   /**
-   * Delete a specific LOA configuration.
+   * Permanently deletes the specified LOA configuration so it can no longer be used
+   * when generating LOA documents.
    *
    * @example
    * ```ts
@@ -145,7 +150,8 @@ export class LoaConfigurations extends APIResource {
   }
 
   /**
-   * Retrieve a specific LOA configuration.
+   * Returns the details of a single LOA (Letter of Authorization) configuration by
+   * its identifier.
    *
    * @example
    * ```ts
@@ -160,7 +166,8 @@ export class LoaConfigurations extends APIResource {
   }
 
   /**
-   * Update a specific LOA configuration.
+   * Updates the specified LOA configuration with the provided fields and returns the
+   * updated configuration.
    *
    * @example
    * ```ts

package/src/resources/porting/porting.ts

@@ -54,7 +54,8 @@ export class Porting extends APIResource {
   );
 
   /**
-   * List available carriers in the UK.
+   * Returns the list of UK carriers available for porting, for use when preparing
+   * porting orders for UK numbers.
    *
    * @example
    * ```ts

package/src/resources/porting/reports.ts

@@ -47,7 +47,8 @@ export class Reports extends APIResource {
   }
 
   /**
-   * Retrieve a specific report generated.
+   * Returns the details of a previously requested porting report, including its
+   * status and parameters.
    *
    * @example
    * ```ts

package/src/resources/porting-orders/actions.ts

@@ -27,7 +27,7 @@ export class Actions extends APIResource {
   }
 
   /**
-   * Cancel a porting order
+   * Requests cancellation of the porting order and returns the updated order.
    *
    * @example
    * ```ts
@@ -41,7 +41,8 @@ export class Actions extends APIResource {
   }
 
   /**
-   * 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.
    *
    * @example
    * ```ts

package/src/resources/porting-orders/activation-jobs.ts

@@ -41,7 +41,8 @@ export class ActivationJobs extends APIResource {
   }
 
   /**
-   * Returns a porting activation job.
+   * Returns the details of a single activation job for the porting order, including
+   * its current status.
    *
    * @example
    * ```ts

package/src/resources/porting-orders/phone-number-blocks.ts

@@ -37,7 +37,8 @@ export class PhoneNumberBlocks extends APIResource {
   }
 
   /**
-   * Creates a new phone number block.
+   * Creates a phone number block on the porting order, representing a contiguous
+   * range of phone numbers to be ported together.
    *
    * @example
    * ```ts
@@ -71,7 +72,7 @@ export class PhoneNumberBlocks extends APIResource {
   }
 
   /**
-   * Deletes a phone number block.
+   * Deletes the specified phone number block from the porting order.
    *
    * @example
    * ```ts

package/src/resources/porting-orders/phone-number-extensions.ts

@@ -36,7 +36,8 @@ export class PhoneNumberExtensions extends APIResource {
   }
 
   /**
-   * Creates a new phone number extension.
+   * Creates a phone number extension on the porting order, mapping extension ranges
+   * to one of the order's phone numbers.
    *
    * @example
    * ```ts
@@ -64,7 +65,7 @@ export class PhoneNumberExtensions extends APIResource {
   }
 
   /**
-   * Deletes a phone number extension.
+   * Deletes the specified phone number extension from the porting order.
    *
    * @example
    * ```ts

package/src/resources/porting-orders/porting-orders.ts

@@ -135,7 +135,8 @@ export class PortingOrders extends APIResource {
     new PhoneNumberExtensionsAPI.PhoneNumberExtensions(this._client);
 
   /**
-   * Returns a list of your porting order.
+   * Returns a paginated list of your porting orders. Supports filtering and sorting,
+   * and can optionally include the phone numbers attached to each order.
    *
    * @example
    * ```ts
@@ -156,7 +157,9 @@ export class PortingOrders extends APIResource {
   }
 
   /**
-   * Creates a new porting order object.
+   * Creates a new porting order to bring phone numbers from another carrier to
+   * Telnyx. Complete the order's requirements and then confirm it to submit the
+   * port.
    *
    * @example
    * ```ts
@@ -267,7 +270,8 @@ export class PortingOrders extends APIResource {
   }
 
   /**
-   * Download a porting order loa template
+   * Downloads the Letter of Authorization (LOA) template document for this porting
+   * order, optionally rendered with a specific LOA configuration.
    *
    * @example
    * ```ts

package/src/resources/portouts/comments.ts

@@ -25,7 +25,8 @@ export class Comments extends APIResource {
   }
 
   /**
-   * Creates a comment on a portout request.
+   * Creates a comment on the specified port-out request and returns the created
+   * comment.
    *
    * @example
    * ```ts

package/src/resources/portouts/events.ts

@@ -12,7 +12,8 @@ import { path } from '../../internal/utils/path';
  */
 export class Events extends APIResource {
   /**
-   * Returns a list of all port-out events.
+   * Returns a paginated list of port-out events on your account, such as status
+   * changes on port-out requests, with support for filtering.
    *
    * @example
    * ```ts
@@ -33,7 +34,7 @@ export class Events extends APIResource {
   }
 
   /**
-   * Show a specific port-out event.
+   * Returns the details of a single port-out event, including its type and payload.
    *
    * @example
    * ```ts
@@ -47,7 +48,8 @@ export class Events extends APIResource {
   }
 
   /**
-   * Republish a specific port-out event.
+   * Republishes the specified port-out event, triggering re-delivery of the
+   * corresponding webhook to your account.
    *
    * @example
    * ```ts

package/src/resources/portouts/portouts.ts

@@ -105,7 +105,8 @@ export class Portouts extends APIResource {
   }
 
   /**
-   * Authorize or reject portout request
+   * Updates the status of the specified port-out request, using the status path
+   * segment to authorize or reject the port-out.
    *
    * @example
    * ```ts