telnyx 7.16.0 → 7.17.0

package/src/resources/portouts/reports.ts

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

package/src/resources/pricing/index.ts

@@ -10,4 +10,5 @@ export {
   type ProductListParams,
   type ProductRetrieveParams,
   type ProductListResponsesDefaultFlatPagination,
+  type ProductRetrieveResponsesDefaultFlatPagination,
 } from './products';

package/src/resources/pricing/pricing.ts

@@ -10,6 +10,7 @@ import {
   ProductListResponsesDefaultFlatPagination,
   ProductRetrieveParams,
   ProductRetrieveResponse,
+  ProductRetrieveResponsesDefaultFlatPagination,
   Products,
 } from './products';
 
@@ -27,6 +28,7 @@ export declare namespace Pricing {
     type ProductRetrieveResponse as ProductRetrieveResponse,
     type ProductListResponse as ProductListResponse,
     type ProductListResponsesDefaultFlatPagination as ProductListResponsesDefaultFlatPagination,
+    type ProductRetrieveResponsesDefaultFlatPagination as ProductRetrieveResponsesDefaultFlatPagination,
     type ProductListParams as ProductListParams,
     type ProductRetrieveParams as ProductRetrieveParams,
   };

package/src/resources/pricing/products.ts

@@ -1,8 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as ProductsAPI from './products';
-import { APIPromise } from '../../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -37,13 +35,19 @@ export class Products extends APIResource {
     slug: string,
     query: ProductRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ProductRetrieveResponse> {
-    return this._client.get(path`/pricing/products/${slug}`, { query, ...options });
+  ): PagePromise<ProductRetrieveResponsesDefaultFlatPagination, ProductRetrieveResponse> {
+    return this._client.getAPIList(
+      path`/pricing/products/${slug}`,
+      DefaultFlatPagination<ProductRetrieveResponse>,
+      { query, ...options },
+    );
   }
 }
 
 export type ProductListResponsesDefaultFlatPagination = DefaultFlatPagination<ProductListResponse>;
 
+export type ProductRetrieveResponsesDefaultFlatPagination = DefaultFlatPagination<ProductRetrieveResponse>;
+
 export interface PricingPaginationMeta {
   page_number: number;
 
@@ -72,108 +76,100 @@ export interface PricingTier {
   rate: number | string;
 }
 
+/**
+ * A single pricing entry. Standard products include rate, unit, currency, type,
+ * country_iso, direction, and tiers. Inference products include model, input_rate,
+ * output_rate, cached_input_rate, and their respective tier arrays. Rate-deck
+ * products include pricing_type and note fields with null rate and empty tiers.
+ */
 export interface ProductRetrieveResponse {
-  data: Array<ProductRetrieveResponse.Data>;
+  /**
+   * Cached input token rate. Present only on inference product entries.
+   */
+  cached_input_rate?: string;
 
-  meta: PricingPaginationMeta;
-}
+  /**
+   * Cached input token tiered pricing. Present only on inference product entries.
+   */
+  cached_input_tiers?: Array<PricingTier>;
 
-export namespace ProductRetrieveResponse {
-  /**
-   * A single pricing entry. Standard products include rate, unit, currency, type,
-   * country_iso, direction, and tiers. Inference products include model, input_rate,
-   * output_rate, cached_input_rate, and their respective tier arrays. Rate-deck
-   * products include pricing_type and note fields with null rate and empty tiers.
-   */
-  export interface Data {
-    /**
-     * Cached input token rate. Present only on inference product entries.
-     */
-    cached_input_rate?: string;
-
-    /**
-     * Cached input token tiered pricing. Present only on inference product entries.
-     */
-    cached_input_tiers?: Array<ProductsAPI.PricingTier>;
-
-    /**
-     * ISO country code. Null for non-geographic products.
-     */
-    country_iso?: string | null;
-
-    /**
-     * ISO currency code (e.g., USD).
-     */
-    currency?: string;
-
-    /**
-     * Direction (e.g., termination). Null for non-directional products.
-     */
-    direction?: string | null;
-
-    /**
-     * Input token rate. Present only on inference product entries.
-     */
-    input_rate?: string;
-
-    /**
-     * Input token tiered pricing. Present only on inference product entries.
-     */
-    input_tiers?: Array<ProductsAPI.PricingTier>;
-
-    /**
-     * Model identifier. Present only on inference product entries.
-     */
-    model?: string;
-
-    /**
-     * Human-readable name describing the pricing entry.
-     */
-    name?: string;
-
-    /**
-     * Additional note for rate-deck products (e.g., "Pricing is determined by the
-     * WhatsApp rate deck.").
-     */
-    note?: string | null;
-
-    /**
-     * Output token rate. Present only on inference product entries.
-     */
-    output_rate?: string;
-
-    /**
-     * Output token tiered pricing. Present only on inference product entries.
-     */
-    output_tiers?: Array<ProductsAPI.PricingTier>;
-
-    /**
-     * Pricing type for non-standard products (e.g., rate_deck). Absent on standard
-     * products.
-     */
-    pricing_type?: string | null;
-
-    /**
-     * Per-unit rate. Numeric for standard products, string for inference products.
-     * Null for rate-deck products.
-     */
-    rate?: number | string | null;
-
-    /**
-     * Volume-based tiered pricing. Empty for rate-deck products.
-     */
-    tiers?: Array<ProductsAPI.PricingTier>;
-
-    /**
-     * Pricing type (e.g., usage).
-     */
-    type?: string;
-
-    /**
-     * Unit of measurement (e.g., part, message, GB, per_1k_tokens).
-     */
-    unit?: string;
-  }
+  /**
+   * ISO country code. Null for non-geographic products.
+   */
+  country_iso?: string | null;
+
+  /**
+   * ISO currency code (e.g., USD).
+   */
+  currency?: string;
+
+  /**
+   * Direction (e.g., termination). Null for non-directional products.
+   */
+  direction?: string | null;
+
+  /**
+   * Input token rate. Present only on inference product entries.
+   */
+  input_rate?: string;
+
+  /**
+   * Input token tiered pricing. Present only on inference product entries.
+   */
+  input_tiers?: Array<PricingTier>;
+
+  /**
+   * Model identifier. Present only on inference product entries.
+   */
+  model?: string;
+
+  /**
+   * Human-readable name describing the pricing entry.
+   */
+  name?: string;
+
+  /**
+   * Additional note for rate-deck products (e.g., "Pricing is determined by the
+   * WhatsApp rate deck.").
+   */
+  note?: string | null;
+
+  /**
+   * Output token rate. Present only on inference product entries.
+   */
+  output_rate?: string;
+
+  /**
+   * Output token tiered pricing. Present only on inference product entries.
+   */
+  output_tiers?: Array<PricingTier>;
+
+  /**
+   * Pricing type for non-standard products (e.g., rate_deck). Absent on standard
+   * products.
+   */
+  pricing_type?: string | null;
+
+  /**
+   * Per-unit rate. Numeric for standard products, string for inference products.
+   * Null for rate-deck products.
+   */
+  rate?: number | string | null;
+
+  /**
+   * Volume-based tiered pricing. Empty for rate-deck products.
+   */
+  tiers?: Array<PricingTier>;
+
+  /**
+   * Pricing type (e.g., usage).
+   */
+  type?: string;
+
+  /**
+   * Unit of measurement (e.g., part, message, GB, per_1k_tokens).
+   */
+  unit?: string;
 }
 
 export interface ProductListResponse {
@@ -195,18 +191,12 @@ export interface ProductListResponse {
 
 export interface ProductListParams extends DefaultFlatPaginationParams {}
 
-export interface ProductRetrieveParams {
-  'filter[country_iso]'?: string | null;
-
+export interface ProductRetrieveParams extends DefaultFlatPaginationParams {
   /**
-   * Page number (1-based).
+   * Two-letter ISO 3166-1 alpha-2 country code (uppercase, e.g. US) to filter
+   * pricing to a single country.
    */
-  'page[number]'?: number;
-
-  /**
-   * Number of items per page (max 100).
-   */
-  'page[size]'?: number;
+  'filter[country_iso]'?: string | null;
 }
 
 export declare namespace Products {
@@ -216,6 +206,7 @@ export declare namespace Products {
     type ProductRetrieveResponse as ProductRetrieveResponse,
     type ProductListResponse as ProductListResponse,
     type ProductListResponsesDefaultFlatPagination as ProductListResponsesDefaultFlatPagination,
+    type ProductRetrieveResponsesDefaultFlatPagination as ProductRetrieveResponsesDefaultFlatPagination,
     type ProductListParams as ProductListParams,
     type ProductRetrieveParams as ProductRetrieveParams,
   };

package/src/resources/private-wireless-gateways.ts

@@ -54,7 +54,7 @@ export class PrivateWirelessGateways extends APIResource {
   }
 
   /**
-   * Deletes the Private Wireless Gateway.
+   * Permanently deletes the specified Private Wireless Gateway from your account.
    *
    * @example
    * ```ts

package/src/resources/public-internet-gateways.ts

@@ -14,7 +14,8 @@ import { path } from '../internal/utils/path';
  */
 export class PublicInternetGateways extends APIResource {
   /**
-   * List all Public Internet Gateways.
+   * Returns a paginated list of the public internet gateways on your account, with
+   * support for filtering.
    */
   list(
     query: PublicInternetGatewayListParams | null | undefined = {},
@@ -28,7 +29,9 @@ export class PublicInternetGateways extends APIResource {
   }
 
   /**
-   * Create a new Public Internet Gateway.
+   * Requests creation of a public internet gateway on the specified network, giving
+   * the network internet egress. Creation is asynchronous, so the request is
+   * accepted and completes in the background.
    */
   create(
     params: PublicInternetGatewayCreateParams,
@@ -39,14 +42,15 @@ export class PublicInternetGateways extends APIResource {
   }
 
   /**
-   * Delete a Public Internet Gateway.
+   * Deletes the specified public internet gateway, removing internet egress through
+   * it.
    */
   delete(id: string, options?: RequestOptions): APIPromise<PublicInternetGatewayDeleteResponse> {
     return this._client.delete(path`/public_internet_gateways/${id}`, options);
   }
 
   /**
-   * Retrieve a Public Internet Gateway.
+   * Returns the details of a single public internet gateway by its identifier.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<PublicInternetGatewayRetrieveResponse> {
     return this._client.get(path`/public_internet_gateways/${id}`, options);

package/src/resources/queues/queues.ts

@@ -25,7 +25,8 @@ export class Queues extends APIResource {
   calls: CallsAPI.Calls = new CallsAPI.Calls(this._client);
 
   /**
-   * Retrieve an existing call queue
+   * Returns the details of an existing call queue, including its current
+   * configuration.
    *
    * @example
    * ```ts
@@ -55,7 +56,8 @@ export class Queues extends APIResource {
   }
 
   /**
-   * Create a new call queue.
+   * Creates a new call queue with the provided configuration and returns the created
+   * queue.
    *
    * @example
    * ```ts
@@ -69,7 +71,7 @@ export class Queues extends APIResource {
   }
 
   /**
-   * Delete an existing call queue.
+   * Permanently deletes the specified call queue from your account.
    *
    * @example
    * ```ts

package/src/resources/rcs/agents/agents.ts

@@ -190,7 +190,10 @@ export interface AgentConfiguration {
    * Basic agent identity and contact information. At least one complete phone,
    * website, or email contact is required.
    */
-  basics: AgentConfiguration.UnionMember0 | AgentConfiguration.UnionMember1 | AgentConfiguration.UnionMember2;
+  basics:
+    | AgentConfiguration.AgentPhoneContactRequirement
+    | AgentConfiguration.AgentWebhookContactRequirement
+    | AgentConfiguration.AgentProfileContactRequirement;
 
   campaign?: AgentCampaignConfiguration | null;
 
@@ -198,7 +201,7 @@ export interface AgentConfiguration {
 }
 
 export namespace AgentConfiguration {
-  export interface UnionMember0 {
+  export interface AgentPhoneContactRequirement {
     phone_number: AgentsAPI.AgentPhoneContact;
 
     brand_color?: string;
@@ -218,7 +221,7 @@ export namespace AgentConfiguration {
     website?: AgentsAPI.AgentWebsiteContact | null;
   }
 
-  export interface UnionMember1 {
+  export interface AgentWebhookContactRequirement {
     website: AgentsAPI.AgentWebsiteContact;
 
     brand_color?: string;
@@ -238,7 +241,7 @@ export namespace AgentConfiguration {
     terms_and_conditions_url?: string;
   }
 
-  export interface UnionMember2 {
+  export interface AgentProfileContactRequirement {
     email: AgentsAPI.AgentEmailContact;
 
     brand_color?: string;

package/src/resources/rcs/brands.ts

@@ -109,6 +109,23 @@ export class Brands extends APIResource {
   }
 }
 
+export interface BrandAddress {
+  administrative_area: string;
+
+  city: string;
+
+  /**
+   * The two-letter ISO 3166-1 country code.
+   */
+  country_code: string;
+
+  line_1: string;
+
+  postal_code: string;
+
+  line_2?: string | null;
+}
+
 export interface BrandContact {
   contact_type: 'BRAND' | 'PRIMARY' | 'OFFICER' | 'AGENT' | 'RESPONSIBLE_PARTY' | 'BILLING' | 'UNKNOWN';
 
@@ -123,6 +140,8 @@ export interface BrandContact {
   title?: string | null;
 }
 
+export type BrandIdentifier = EinBrandIdentifier | StockSymbolBrandIdentifier;
+
 export type BrandLegalEntityType =
   | 'LIMITED_LIABILITY_COMPANY'
   | 'SOLE_PROPRIETORSHIP'
@@ -138,7 +157,7 @@ export type BrandOrganizationType =
   | 'UNKNOWN';
 
 export interface BrandResponse {
-  addresses: { [key: string]: BrandResponse.Addresses };
+  addresses: { [key: string]: BrandAddress };
 
   brand_id: string;
 
@@ -148,7 +167,7 @@ export interface BrandResponse {
 
   display_name: string;
 
-  identifiers: { [key: string]: EinBrandIdentifier | StockSymbolBrandIdentifier };
+  identifiers: { [key: string]: BrandIdentifier };
 
   legal_entity_type: string;
 
@@ -171,25 +190,6 @@ export interface BrandResponse {
   website_url: string;
 }
 
-export namespace BrandResponse {
-  export interface Addresses {
-    administrative_area: string;
-
-    city: string;
-
-    /**
-     * The two-letter ISO 3166-1 country code.
-     */
-    country_code: string;
-
-    line_1: string;
-
-    postal_code: string;
-
-    line_2?: string | null;
-  }
-}
-
 export interface EinBrandIdentifier {
   identifier_type: 'EIN';
 
@@ -211,7 +211,7 @@ export interface StockSymbolBrandIdentifier {
 export type BrandListResponse = Array<BrandResponse>;
 
 export interface BrandCreateParams {
-  addresses: { [key: string]: BrandCreateParams.Addresses };
+  addresses: { [key: string]: BrandAddress };
 
   /**
    * Named business contacts. Use the `brand` key for the required BRAND contact.
@@ -242,23 +242,6 @@ export interface BrandCreateParams {
 }
 
 export namespace BrandCreateParams {
-  export interface Addresses {
-    administrative_area: string;
-
-    city: string;
-
-    /**
-     * The two-letter ISO 3166-1 country code.
-     */
-    country_code: string;
-
-    line_1: string;
-
-    postal_code: string;
-
-    line_2?: string | null;
-  }
-
   /**
    * Named business contacts. Use the `brand` key for the required BRAND contact.
    */
@@ -284,8 +267,7 @@ export namespace BrandCreateParams {
     stock_symbol?: BrandsAPI.StockSymbolBrandIdentifier;
 
     [k: string]:
-      | BrandsAPI.EinBrandIdentifier
-      | BrandsAPI.StockSymbolBrandIdentifier
+      | BrandsAPI.BrandIdentifier
       | BrandsAPI.EinBrandIdentifier
       | BrandsAPI.StockSymbolBrandIdentifier
       | undefined;
@@ -293,7 +275,7 @@ export namespace BrandCreateParams {
 }
 
 export interface BrandUpdateParams {
-  addresses?: { [key: string]: BrandUpdateParams.Addresses };
+  addresses?: { [key: string]: BrandAddress };
 
   /**
    * Named business contacts. Use the `brand` key for the required BRAND contact.
@@ -320,23 +302,6 @@ export interface BrandUpdateParams {
 }
 
 export namespace BrandUpdateParams {
-  export interface Addresses {
-    administrative_area: string;
-
-    city: string;
-
-    /**
-     * The two-letter ISO 3166-1 country code.
-     */
-    country_code: string;
-
-    line_1: string;
-
-    postal_code: string;
-
-    line_2?: string | null;
-  }
-
   /**
    * Named business contacts. Use the `brand` key for the required BRAND contact.
    */
@@ -362,8 +327,7 @@ export namespace BrandUpdateParams {
     stock_symbol?: BrandsAPI.StockSymbolBrandIdentifier;
 
     [k: string]:
-      | BrandsAPI.EinBrandIdentifier
-      | BrandsAPI.StockSymbolBrandIdentifier
+      | BrandsAPI.BrandIdentifier
       | BrandsAPI.EinBrandIdentifier
       | BrandsAPI.StockSymbolBrandIdentifier
       | undefined;
@@ -372,7 +336,9 @@ export namespace BrandUpdateParams {
 
 export declare namespace Brands {
   export {
+    type BrandAddress as BrandAddress,
     type BrandContact as BrandContact,
+    type BrandIdentifier as BrandIdentifier,
     type BrandLegalEntityType as BrandLegalEntityType,
     type BrandOrganizationType as BrandOrganizationType,
     type BrandResponse as BrandResponse,

package/src/resources/rcs/index.ts

@@ -27,7 +27,9 @@ export {
 } from './agents/index';
 export {
   Brands,
+  type BrandAddress,
   type BrandContact,
+  type BrandIdentifier,
   type BrandLegalEntityType,
   type BrandOrganizationType,
   type BrandResponse,

package/src/resources/rcs/rcs.ts

@@ -3,8 +3,10 @@
 import { APIResource } from '../../core/resource';
 import * as BrandsAPI from './brands';
 import {
+  BrandAddress,
   BrandContact,
   BrandCreateParams,
+  BrandIdentifier,
   BrandLegalEntityType,
   BrandListResponse,
   BrandOrganizationType,
@@ -76,7 +78,9 @@ export declare namespace Rcs {
 
   export {
     Brands as Brands,
+    type BrandAddress as BrandAddress,
     type BrandContact as BrandContact,
+    type BrandIdentifier as BrandIdentifier,
     type BrandLegalEntityType as BrandLegalEntityType,
     type BrandOrganizationType as BrandOrganizationType,
     type BrandResponse as BrandResponse,

package/src/resources/recordings/recordings.ts

@@ -15,7 +15,8 @@ export class Recordings extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
   /**
-   * Returns a list of your call recordings.
+   * Returns a paginated list of your call recordings, with support for filtering to
+   * locate specific recordings.
    *
    * @example
    * ```ts
@@ -36,7 +37,8 @@ export class Recordings extends APIResource {
   }
 
   /**
-   * Permanently deletes a call recording.
+   * Permanently deletes the specified call recording and returns the deleted
+   * recording resource. The media is removed and can no longer be downloaded.
    *
    * @example
    * ```ts

package/src/resources/reports/mdr-usage-reports.ts

@@ -79,7 +79,7 @@ export class MdrUsageReports extends APIResource {
   }
 
   /**
-   * Delete messaging usage report by id
+   * Permanently deletes the specified messaging usage report by its identifier.
    *
    * @example
    * ```ts

package/src/resources/reports/reports.ts

@@ -31,7 +31,8 @@ export class Reports extends APIResource {
   mdrUsageReports: MdrUsageReportsAPI.MdrUsageReports = new MdrUsageReportsAPI.MdrUsageReports(this._client);
 
   /**
-   * Fetch all Mdr records
+   * Returns message detail records (MDRs) matching the provided criteria, such as
+   * date range, direction, status, and message type.
    *
    * @example
    * ```ts
@@ -46,7 +47,8 @@ export class Reports extends APIResource {
   }
 
   /**
-   * Fetch all Wdr records
+   * Returns wireless detail records (WDRs) matching the provided criteria, such as
+   * date range, SIM card, IMSI, or phone number, with pagination and sorting.
    *
    * @example
    * ```ts

package/src/resources/requirement-types.ts

@@ -28,7 +28,8 @@ export class RequirementTypes extends APIResource {
   }
 
   /**
-   * Retrieve a requirement type by id
+   * Returns the details of a single requirement type by its identifier, describing a
+   * kind of documentation needed for regulatory purposes.
    *
    * @example
    * ```ts