telnyx 7.13.0 → 7.15.0

package/src/resources/phone-numbers/voicemail.ts

@@ -25,7 +25,10 @@ export class Voicemail extends APIResource {
   }
 
   /**
-   * Update voicemail settings for a phone number
+   * Update voicemail settings for a phone number. You can also configure a custom
+   * greeting by setting the `greeting` object: use `mode` `custom_greeting` together
+   * with a `media_name` that points to an audio file uploaded through the Media
+   * Storage API, or `mode` `default` to use the standard system greeting.
    *
    * @example
    * ```ts
@@ -44,7 +47,10 @@ export class Voicemail extends APIResource {
   }
 
   /**
-   * Create voicemail settings for a phone number
+   * Create voicemail settings for a phone number. You can also configure a custom
+   * greeting by setting the `greeting` object: use `mode` `custom_greeting` together
+   * with a `media_name` that points to an audio file uploaded through the Media
+   * Storage API, or `mode` `default` to use the standard system greeting.
    *
    * @example
    * ```ts
@@ -69,24 +75,92 @@ export interface VoicemailPrefResponse {
    */
   enabled?: boolean;
 
+  /**
+   * Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+   * `default` to play the standard system greeting, or to `custom_greeting` to play
+   * your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+   * must reference an audio file already uploaded to your account through the Media
+   * Storage API.
+   */
+  greeting?: VoicemailPrefResponse.Greeting;
+
   /**
    * The pin used for the voicemail.
    */
   pin?: string;
 }
 
+export namespace VoicemailPrefResponse {
+  /**
+   * Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+   * `default` to play the standard system greeting, or to `custom_greeting` to play
+   * your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+   * must reference an audio file already uploaded to your account through the Media
+   * Storage API.
+   */
+  export interface Greeting {
+    /**
+     * The name of the media file to play as the greeting. Required when `mode` is
+     * `custom_greeting`; ignored when `mode` is `default`. The value must match the
+     * `media_name` of a file you previously uploaded with the Media Storage API
+     * (`POST /v2/media`).
+     */
+    media_name?: string | null;
+
+    /**
+     * The greeting mode. `default` plays the standard system greeting.
+     * `custom_greeting` plays the audio referenced by `media_name`.
+     */
+    mode?: 'default' | 'custom_greeting';
+  }
+}
+
 export interface VoicemailRequest {
   /**
    * Whether voicemail is enabled.
    */
   enabled?: boolean;
 
+  /**
+   * Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+   * `default` to play the standard system greeting, or to `custom_greeting` to play
+   * your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+   * must reference an audio file already uploaded to your account through the Media
+   * Storage API.
+   */
+  greeting?: VoicemailRequest.Greeting;
+
   /**
    * The pin used for voicemail
    */
   pin?: string;
 }
 
+export namespace VoicemailRequest {
+  /**
+   * Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+   * `default` to play the standard system greeting, or to `custom_greeting` to play
+   * your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+   * must reference an audio file already uploaded to your account through the Media
+   * Storage API.
+   */
+  export interface Greeting {
+    /**
+     * The name of the media file to play as the greeting. Required when `mode` is
+     * `custom_greeting`; ignored when `mode` is `default`. The value must match the
+     * `media_name` of a file you previously uploaded with the Media Storage API
+     * (`POST /v2/media`).
+     */
+    media_name?: string | null;
+
+    /**
+     * The greeting mode. `default` plays the standard system greeting.
+     * `custom_greeting` plays the audio referenced by `media_name`.
+     */
+    mode?: 'default' | 'custom_greeting';
+  }
+}
+
 export interface VoicemailCreateResponse {
   data?: VoicemailPrefResponse;
 }
@@ -105,24 +179,92 @@ export interface VoicemailUpdateParams {
    */
   enabled?: boolean;
 
+  /**
+   * Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+   * `default` to play the standard system greeting, or to `custom_greeting` to play
+   * your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+   * must reference an audio file already uploaded to your account through the Media
+   * Storage API.
+   */
+  greeting?: VoicemailUpdateParams.Greeting;
+
   /**
    * The pin used for voicemail
    */
   pin?: string;
 }
 
+export namespace VoicemailUpdateParams {
+  /**
+   * Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+   * `default` to play the standard system greeting, or to `custom_greeting` to play
+   * your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+   * must reference an audio file already uploaded to your account through the Media
+   * Storage API.
+   */
+  export interface Greeting {
+    /**
+     * The name of the media file to play as the greeting. Required when `mode` is
+     * `custom_greeting`; ignored when `mode` is `default`. The value must match the
+     * `media_name` of a file you previously uploaded with the Media Storage API
+     * (`POST /v2/media`).
+     */
+    media_name?: string | null;
+
+    /**
+     * The greeting mode. `default` plays the standard system greeting.
+     * `custom_greeting` plays the audio referenced by `media_name`.
+     */
+    mode?: 'default' | 'custom_greeting';
+  }
+}
+
 export interface VoicemailCreateParams {
   /**
    * Whether voicemail is enabled.
    */
   enabled?: boolean;
 
+  /**
+   * Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+   * `default` to play the standard system greeting, or to `custom_greeting` to play
+   * your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+   * must reference an audio file already uploaded to your account through the Media
+   * Storage API.
+   */
+  greeting?: VoicemailCreateParams.Greeting;
+
   /**
    * The pin used for voicemail
    */
   pin?: string;
 }
 
+export namespace VoicemailCreateParams {
+  /**
+   * Controls the greeting a caller hears before leaving a voicemail. Set `mode` to
+   * `default` to play the standard system greeting, or to `custom_greeting` to play
+   * your own audio. When `mode` is `custom_greeting`, `media_name` is required and
+   * must reference an audio file already uploaded to your account through the Media
+   * Storage API.
+   */
+  export interface Greeting {
+    /**
+     * The name of the media file to play as the greeting. Required when `mode` is
+     * `custom_greeting`; ignored when `mode` is `default`. The value must match the
+     * `media_name` of a file you previously uploaded with the Media Storage API
+     * (`POST /v2/media`).
+     */
+    media_name?: string | null;
+
+    /**
+     * The greeting mode. `default` plays the standard system greeting.
+     * `custom_greeting` plays the audio referenced by `media_name`.
+     */
+    mode?: 'default' | 'custom_greeting';
+  }
+}
+
 export declare namespace Voicemail {
   export {
     type VoicemailPrefResponse as VoicemailPrefResponse,

package/src/resources/phone-numbers-regulatory-requirements.ts

@@ -10,7 +10,9 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class PhoneNumbersRegulatoryRequirements extends APIResource {
   /**
-   * Retrieve regulatory requirements for a list of phone numbers
+   * Returns the regulatory requirements that apply to the supplied comma-separated
+   * phone numbers. The response includes the matching requirement records and
+   * pagination metadata.
    */
   retrieve(
     query: PhoneNumbersRegulatoryRequirementRetrieveParams | null | undefined = {},

package/src/resources/portouts/comments.ts

@@ -31,6 +31,7 @@ export class Comments extends APIResource {
    * ```ts
    * const comment = await client.portouts.comments.create(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { body: 'string' },
    * );
    * ```
    */

package/src/resources/pricing/index.ts

@@ -9,5 +9,5 @@ export {
   type ProductListResponse,
   type ProductListParams,
   type ProductRetrieveParams,
-  type ProductListResponsesDefaultFlatPaginationForInexplicitNumberOrders,
+  type ProductListResponsesDefaultFlatPagination,
 } from './products';

package/src/resources/pricing/pricing.ts

@@ -7,7 +7,7 @@ import {
   PricingTier,
   ProductListParams,
   ProductListResponse,
-  ProductListResponsesDefaultFlatPaginationForInexplicitNumberOrders,
+  ProductListResponsesDefaultFlatPagination,
   ProductRetrieveParams,
   ProductRetrieveResponse,
   Products,
@@ -26,7 +26,7 @@ export declare namespace Pricing {
     type PricingTier as PricingTier,
     type ProductRetrieveResponse as ProductRetrieveResponse,
     type ProductListResponse as ProductListResponse,
-    type ProductListResponsesDefaultFlatPaginationForInexplicitNumberOrders as ProductListResponsesDefaultFlatPaginationForInexplicitNumberOrders,
+    type ProductListResponsesDefaultFlatPagination as ProductListResponsesDefaultFlatPagination,
     type ProductListParams as ProductListParams,
     type ProductRetrieveParams as ProductRetrieveParams,
   };

package/src/resources/pricing/products.ts

@@ -3,11 +3,7 @@
 import { APIResource } from '../../core/resource';
 import * as ProductsAPI from './products';
 import { APIPromise } from '../../core/api-promise';
-import {
-  DefaultFlatPaginationForInexplicitNumberOrders,
-  type DefaultFlatPaginationForInexplicitNumberOrdersParams,
-  PagePromise,
-} from '../../core/pagination';
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
@@ -23,12 +19,11 @@ export class Products extends APIResource {
   list(
     query: ProductListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<ProductListResponsesDefaultFlatPaginationForInexplicitNumberOrders, ProductListResponse> {
-    return this._client.getAPIList(
-      '/pricing/products',
-      DefaultFlatPaginationForInexplicitNumberOrders<ProductListResponse>,
-      { query, ...options },
-    );
+  ): PagePromise<ProductListResponsesDefaultFlatPagination, ProductListResponse> {
+    return this._client.getAPIList('/pricing/products', DefaultFlatPagination<ProductListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -47,8 +42,7 @@ export class Products extends APIResource {
   }
 }
 
-export type ProductListResponsesDefaultFlatPaginationForInexplicitNumberOrders =
-  DefaultFlatPaginationForInexplicitNumberOrders<ProductListResponse>;
+export type ProductListResponsesDefaultFlatPagination = DefaultFlatPagination<ProductListResponse>;
 
 export interface PricingPaginationMeta {
   page_number: number;
@@ -199,18 +193,20 @@ export interface ProductListResponse {
   slug: string;
 }
 
-export interface ProductListParams extends DefaultFlatPaginationForInexplicitNumberOrdersParams {}
+export interface ProductListParams extends DefaultFlatPaginationParams {}
 
 export interface ProductRetrieveParams {
+  'filter[country_iso]'?: string | null;
+
   /**
    * Page number (1-based).
    */
-  page_number?: number;
+  'page[number]'?: number;
 
   /**
    * Number of items per page (max 100).
    */
-  page_size?: number;
+  'page[size]'?: number;
 }
 
 export declare namespace Products {
@@ -219,7 +215,7 @@ export declare namespace Products {
     type PricingTier as PricingTier,
     type ProductRetrieveResponse as ProductRetrieveResponse,
     type ProductListResponse as ProductListResponse,
-    type ProductListResponsesDefaultFlatPaginationForInexplicitNumberOrders as ProductListResponsesDefaultFlatPaginationForInexplicitNumberOrders,
+    type ProductListResponsesDefaultFlatPagination as ProductListResponsesDefaultFlatPagination,
     type ProductListParams as ProductListParams,
     type ProductRetrieveParams as ProductRetrieveParams,
   };

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

@@ -141,7 +141,7 @@ export interface PrivateWirelessGateway {
 export interface PrivateWirelessGatewayStatus {
   /**
    * This attribute is an
-   * [error code](https://developers.telnyx.com/development/api-fundamentals/api-errors)
+   * [error code](https://developers.telnyx.com/docs/development/api-fundamentals/api-errors)
    * related to the failure reason.
    */
   error_code?: string | null;