telnyx 6.74.2 → 7.1.0

package/src/resources/voice-clones.ts

@@ -19,8 +19,8 @@ export class VoiceClones extends APIResource {
    *
    * @example
    * ```ts
-   * const voiceClone = await client.voiceClones.create({
-   *   params: {
+   * const voiceCloneResponse = await client.voiceClones.create({
+   *   voice_clone_request: {
    *     gender: 'male',
    *     language: 'en',
    *     name: 'clone-narrator',
@@ -30,9 +30,9 @@ export class VoiceClones extends APIResource {
    * });
    * ```
    */
-  create(args: VoiceCloneCreateParams, options?: RequestOptions): APIPromise<VoiceCloneCreateResponse> {
-    const { params } = args;
-    return this._client.post('/voice_clones', { body: params, ...options });
+  create(params: VoiceCloneCreateParams, options?: RequestOptions): APIPromise<VoiceCloneResponse> {
+    const { voice_clone_request } = params;
+    return this._client.post('/voice_clones', { body: voice_clone_request, ...options });
   }
 
   /**
@@ -40,17 +40,13 @@ export class VoiceClones extends APIResource {
    *
    * @example
    * ```ts
-   * const voiceClone = await client.voiceClones.update(
+   * const voiceCloneResponse = await client.voiceClones.update(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *   { name: 'updated-clone' },
    * );
    * ```
    */
-  update(
-    id: string,
-    body: VoiceCloneUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<VoiceCloneUpdateResponse> {
+  update(id: string, body: VoiceCloneUpdateParams, options?: RequestOptions): APIPromise<VoiceCloneResponse> {
     return this._client.patch(path`/voice_clones/${id}`, { body, ...options });
   }
 
@@ -99,25 +95,26 @@ export class VoiceClones extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.voiceClones.createFromUpload({
-   *   params: {
-   *     audio_file: fs.createReadStream('path/to/file'),
-   *     gender: 'male',
-   *     language: 'lkf-Lz1vLbBu-9uDh-9AHaOS2D-Cbf',
-   *     name: 'name',
-   *     provider: 'telnyx',
-   *   },
-   * });
+   * const voiceCloneResponse =
+   *   await client.voiceClones.createFromUpload({
+   *     voice_clone_upload_request: {
+   *       audio_file: fs.createReadStream('path/to/file'),
+   *       gender: 'male',
+   *       language: 'lkf-Lz1vLbBu-9uDh-9AHaOS2D-Cbf',
+   *       name: 'name',
+   *       provider: 'telnyx',
+   *     },
+   *   });
    * ```
    */
   createFromUpload(
-    args: VoiceCloneCreateFromUploadParams,
+    params: VoiceCloneCreateFromUploadParams,
     options?: RequestOptions,
-  ): APIPromise<VoiceCloneCreateFromUploadResponse> {
-    const { params } = args;
+  ): APIPromise<VoiceCloneResponse> {
+    const { voice_clone_upload_request } = params;
     return this._client.post(
       '/voice_clones/from_upload',
-      multipartFormRequestOptions({ body: params, ...options }, this._client),
+      multipartFormRequestOptions({ body: voice_clone_upload_request, ...options }, this._client),
     );
   }
 
@@ -231,7 +228,7 @@ export interface VoiceCloneData {
 /**
  * Response envelope for a single voice clone.
  */
-export interface VoiceCloneCreateResponse {
+export interface VoiceCloneResponse {
   /**
    * A voice clone object.
    */
@@ -239,30 +236,35 @@ export interface VoiceCloneCreateResponse {
 }
 
 /**
- * Response envelope for a single voice clone.
+ * Pagination metadata returned with list responses.
  */
-export interface VoiceCloneUpdateResponse {
+export interface VoiceDesignsPaginationMeta {
   /**
-   * A voice clone object.
+   * Current page number (1-based).
    */
-  data?: VoiceCloneData;
-}
+  page_number?: number;
 
-/**
- * Response envelope for a single voice clone.
- */
-export interface VoiceCloneCreateFromUploadResponse {
   /**
-   * A voice clone object.
+   * Number of results per page.
    */
-  data?: VoiceCloneData;
+  page_size?: number;
+
+  /**
+   * Total number of pages.
+   */
+  total_pages?: number;
+
+  /**
+   * Total number of results across all pages.
+   */
+  total_results?: number;
 }
 
 export interface VoiceCloneCreateParams {
   /**
    * Request body for creating a voice clone from an existing voice design.
    */
-  params: VoiceCloneCreateParams.TelnyxDesignClone | VoiceCloneCreateParams.MinimaxDesignClone;
+  voice_clone_request: VoiceCloneCreateParams.TelnyxDesignClone | VoiceCloneCreateParams.MinimaxDesignClone;
 }
 
 export namespace VoiceCloneCreateParams {
@@ -367,7 +369,7 @@ export interface VoiceCloneCreateFromUploadParams {
    * Multipart form data for creating a voice clone from a direct audio upload.
    * Maximum file size: 5MB for Telnyx, 20MB for Minimax.
    */
-  params:
+  voice_clone_upload_request:
     | VoiceCloneCreateFromUploadParams.TelnyxQwen3TtsClone
     | VoiceCloneCreateFromUploadParams.TelnyxUltraClone
     | VoiceCloneCreateFromUploadParams.MinimaxClone;
@@ -519,9 +521,8 @@ export namespace VoiceCloneCreateFromUploadParams {
 export declare namespace VoiceClones {
   export {
     type VoiceCloneData as VoiceCloneData,
-    type VoiceCloneCreateResponse as VoiceCloneCreateResponse,
-    type VoiceCloneUpdateResponse as VoiceCloneUpdateResponse,
-    type VoiceCloneCreateFromUploadResponse as VoiceCloneCreateFromUploadResponse,
+    type VoiceCloneResponse as VoiceCloneResponse,
+    type VoiceDesignsPaginationMeta as VoiceDesignsPaginationMeta,
     type VoiceCloneDataDefaultFlatPagination as VoiceCloneDataDefaultFlatPagination,
     type VoiceCloneCreateParams as VoiceCloneCreateParams,
     type VoiceCloneUpdateParams as VoiceCloneUpdateParams,

package/src/resources/voice-designs.ts

@@ -18,13 +18,14 @@ export class VoiceDesigns extends APIResource {
    *
    * @example
    * ```ts
-   * const voiceDesign = await client.voiceDesigns.create({
-   *   prompt: 'Speak in a warm, friendly tone',
-   *   text: 'Hello, welcome to our service.',
-   * });
+   * const voiceDesignResponse =
+   *   await client.voiceDesigns.create({
+   *     prompt: 'Speak in a warm, friendly tone',
+   *     text: 'Hello, welcome to our service.',
+   *   });
    * ```
    */
-  create(body: VoiceDesignCreateParams, options?: RequestOptions): APIPromise<VoiceDesignCreateResponse> {
+  create(body: VoiceDesignCreateParams, options?: RequestOptions): APIPromise<VoiceDesignResponse> {
     return this._client.post('/voice_designs', { body, ...options });
   }
 
@@ -35,16 +36,15 @@ export class VoiceDesigns extends APIResource {
    *
    * @example
    * ```ts
-   * const voiceDesign = await client.voiceDesigns.retrieve(
-   *   'id',
-   * );
+   * const voiceDesignResponse =
+   *   await client.voiceDesigns.retrieve('id');
    * ```
    */
   retrieve(
     id: string,
     query: VoiceDesignRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<VoiceDesignRetrieveResponse> {
+  ): APIPromise<VoiceDesignResponse> {
     return this._client.get(path`/voice_designs/${id}`, { query, ...options });
   }
 
@@ -55,7 +55,7 @@ export class VoiceDesigns extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const voiceDesignListResponse of client.voiceDesigns.list()) {
+   * for await (const voiceDesignSummaryData of client.voiceDesigns.list()) {
    *   // ...
    * }
    * ```
@@ -63,8 +63,8 @@ export class VoiceDesigns extends APIResource {
   list(
     query: VoiceDesignListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<VoiceDesignListResponsesDefaultFlatPagination, VoiceDesignListResponse> {
-    return this._client.getAPIList('/voice_designs', DefaultFlatPagination<VoiceDesignListResponse>, {
+  ): PagePromise<VoiceDesignSummaryDataDefaultFlatPagination, VoiceDesignSummaryData> {
+    return this._client.getAPIList('/voice_designs', DefaultFlatPagination<VoiceDesignSummaryData>, {
       query,
       ...options,
     });
@@ -154,7 +154,7 @@ export class VoiceDesigns extends APIResource {
   }
 }
 
-export type VoiceDesignListResponsesDefaultFlatPagination = DefaultFlatPagination<VoiceDesignListResponse>;
+export type VoiceDesignSummaryDataDefaultFlatPagination = DefaultFlatPagination<VoiceDesignSummaryData>;
 
 /**
  * A voice design object with full version detail.
@@ -231,17 +231,7 @@ export interface VoiceDesignData {
 /**
  * Response envelope for a single voice design with full version detail.
  */
-export interface VoiceDesignCreateResponse {
-  /**
-   * A voice design object with full version detail.
-   */
-  data?: VoiceDesignData;
-}
-
-/**
- * Response envelope for a single voice design with full version detail.
- */
-export interface VoiceDesignRetrieveResponse {
+export interface VoiceDesignResponse {
   /**
    * A voice design object with full version detail.
    */
@@ -251,7 +241,7 @@ export interface VoiceDesignRetrieveResponse {
 /**
  * A summarized voice design object (without version-specific fields).
  */
-export interface VoiceDesignListResponse {
+export interface VoiceDesignSummaryData {
   /**
    * Unique identifier for the voice design.
    */
@@ -296,49 +286,7 @@ export interface VoiceDesignRenameResponse {
   /**
    * A summarized voice design object (without version-specific fields).
    */
-  data?: VoiceDesignRenameResponse.Data;
-}
-
-export namespace VoiceDesignRenameResponse {
-  /**
-   * A summarized voice design object (without version-specific fields).
-   */
-  export interface Data {
-    /**
-     * Unique identifier for the voice design.
-     */
-    id?: string;
-
-    /**
-     * Timestamp when the voice design was first created.
-     */
-    created_at?: string;
-
-    /**
-     * Name of the voice design.
-     */
-    name?: string;
-
-    /**
-     * Voice synthesis provider used for this design.
-     */
-    provider?: 'telnyx' | 'minimax' | null;
-
-    /**
-     * List of TTS model identifiers supported by this design's provider.
-     */
-    provider_supported_models?: Array<string>;
-
-    /**
-     * Identifies the resource type.
-     */
-    record_type?: 'voice_design';
-
-    /**
-     * Timestamp when the voice design was last updated.
-     */
-    updated_at?: string;
-  }
+  data?: VoiceDesignSummaryData;
 }
 
 export interface VoiceDesignCreateParams {
@@ -452,11 +400,10 @@ export interface VoiceDesignRenameParams {
 export declare namespace VoiceDesigns {
   export {
     type VoiceDesignData as VoiceDesignData,
-    type VoiceDesignCreateResponse as VoiceDesignCreateResponse,
-    type VoiceDesignRetrieveResponse as VoiceDesignRetrieveResponse,
-    type VoiceDesignListResponse as VoiceDesignListResponse,
+    type VoiceDesignResponse as VoiceDesignResponse,
+    type VoiceDesignSummaryData as VoiceDesignSummaryData,
     type VoiceDesignRenameResponse as VoiceDesignRenameResponse,
-    type VoiceDesignListResponsesDefaultFlatPagination as VoiceDesignListResponsesDefaultFlatPagination,
+    type VoiceDesignSummaryDataDefaultFlatPagination as VoiceDesignSummaryDataDefaultFlatPagination,
     type VoiceDesignCreateParams as VoiceDesignCreateParams,
     type VoiceDesignRetrieveParams as VoiceDesignRetrieveParams,
     type VoiceDesignListParams as VoiceDesignListParams,

package/src/resources/voice-sdk-call-reports.ts

@@ -28,219 +28,21 @@ export class VoiceSDKCallReports extends APIResource {
   list(
     query: VoiceSDKCallReportListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<VoiceSDKCallReportListResponsesDefaultFlatPagination, VoiceSDKCallReportListResponse> {
-    return this._client.getAPIList(
-      '/voice_sdk_call_reports',
-      DefaultFlatPagination<VoiceSDKCallReportListResponse>,
-      { query, ...options },
-    );
+  ): PagePromise<VoiceSDKCallReportsDefaultFlatPagination, VoiceSDKCallReport> {
+    return this._client.getAPIList('/voice_sdk_call_reports', DefaultFlatPagination<VoiceSDKCallReport>, {
+      query,
+      ...options,
+    });
   }
 }
 
-export type VoiceSDKCallReportListResponsesDefaultFlatPagination =
-  DefaultFlatPagination<VoiceSDKCallReportListResponse>;
-
-/**
- * A raw Voice SDK log entry. Additional SDK-specific fields may be present.
- */
-export interface VoiceSDKCallReportLogEntry {
-  /**
-   * Raw structured context attached to the log entry.
-   */
-  context?: { [key: string]: unknown };
-
-  /**
-   * Log level emitted by the SDK.
-   */
-  level?: 'debug' | 'info' | 'warn' | 'error';
-
-  /**
-   * Log message.
-   */
-  message?: string;
-
-  /**
-   * Time when the log entry was emitted.
-   */
-  timestamp?: string;
-
-  [k: string]: unknown;
-}
-
-/**
- * Raw Voice SDK call report stats payloads as stored by voice-sdk-debug.
- */
-export type VoiceSDKCallReportRetrieveResponse =
-  Array<VoiceSDKCallReportRetrieveResponse.VoiceSDKCallReportRetrieveResponseItem>;
-
-export namespace VoiceSDKCallReportRetrieveResponse {
-  /**
-   * A raw call report stats JSON payload. The schema is intentionally permissive
-   * because Voice SDK clients can add fields over time.
-   */
-  export interface VoiceSDKCallReportRetrieveResponseItem {
-    /**
-     * Unique call identifier.
-     */
-    call_id?: string;
-
-    /**
-     * User-scoped storage grouping identifier derived from the authenticated user.
-     * This is not a unique per-call report identifier and may be shared by multiple
-     * calls for the same user.
-     */
-    call_report_id?: string;
-
-    /**
-     * Creation timestamp when present.
-     */
-    created_at?: string;
-
-    /**
-     * Reason the SDK flushed this stats report segment, for example an intermediate
-     * socket-close flush.
-     */
-    flushReason?: { [key: string]: unknown };
-
-    /**
-     * Raw logs payload emitted by the Voice SDK and stored without normalization. Live
-     * responses commonly return an array of log entries, but object-shaped log
-     * payloads are also allowed for compatibility.
-     */
-    logs?:
-      | Array<VoiceSDKCallReportsAPI.VoiceSDKCallReportLogEntry>
-      | VoiceSDKCallReportRetrieveResponseItem.Entries;
-
-    /**
-     * Organization associated with the stored call report when provided by the Voice
-     * SDK reporting path.
-     */
-    organization_id?: string;
-
-    /**
-     * Zero-based stats segment index when the SDK sends segmented or intermediate
-     * reports.
-     */
-    segment?: number;
-
-    /**
-     * Raw stats payload emitted by the Voice SDK and stored without normalization. The
-     * exact shape can vary by SDK platform and version. Live responses commonly return
-     * an array of interval snapshots, but object-shaped stats payloads are also
-     * allowed for compatibility.
-     */
-    stats?: Array<{ [key: string]: unknown }> | VoiceSDKCallReportRetrieveResponseItem.UnionMember1;
-
-    /**
-     * Time when the call report was stored.
-     */
-    stored_at?: string;
-
-    /**
-     * High-level call metadata.
-     */
-    summary?: { [key: string]: unknown };
-
-    /**
-     * Telnyx call leg identifier for correlating the report with call-control, SIP,
-     * and media troubleshooting data.
-     */
-    telnyx_leg_id?: string;
-
-    /**
-     * Telnyx RTC session identifier for correlating the report with Voice SDK
-     * signaling and media-session logs.
-     */
-    telnyx_session_id?: string;
-
-    /**
-     * Voice SDK user agent string reported by the client. This is the preferred
-     * SDK/platform/version dimension when present.
-     */
-    user_agent?: string;
-
-    /**
-     * Authenticated user that owns the call report.
-     */
-    user_id?: string;
-
-    /**
-     * Legacy SDK version value when the client reports one separately from the user
-     * agent.
-     */
-    version?: string;
-
-    /**
-     * Voice SDK instance identifier.
-     */
-    voice_sdk_id?: string;
-
-    /**
-     * Decoded Voice SDK identifier metadata emitted by voice-sdk-proxy when available.
-     */
-    voice_sdk_id_decoded?: { [key: string]: unknown };
-
-    /**
-     * Voice SDK session correlation identifier used to group stats segments for the
-     * same SDK session.
-     */
-    voice_sdk_session_id?: string;
-
-    [k: string]: unknown;
-  }
-
-  export namespace VoiceSDKCallReportRetrieveResponseItem {
-    /**
-     * Raw logs object emitted by the Voice SDK when logs are grouped under an entries
-     * field.
-     */
-    export interface Entries {
-      /**
-       * Raw log entries when the SDK groups logs under an entries field.
-       */
-      entries?: Array<VoiceSDKCallReportsAPI.VoiceSDKCallReportLogEntry>;
-
-      [k: string]: unknown;
-    }
-
-    /**
-     * Raw stats object emitted by the Voice SDK.
-     */
-    export interface UnionMember1 {
-      /**
-       * Raw audio stats such as inbound/outbound packet, byte, jitter, packet-loss,
-       * bitrate, and audio-level metrics.
-       */
-      audio?: { [key: string]: unknown };
-
-      /**
-       * Raw connection stats such as round-trip time, packets, and bytes sent or
-       * received.
-       */
-      connection?: { [key: string]: unknown };
-
-      /**
-       * Raw ICE candidate-pair information, including selected pair, local/remote
-       * candidates, state, and nomination data when provided by the SDK.
-       */
-      ice?: { [key: string]: unknown };
-
-      /**
-       * Raw transport stats such as ICE state, DTLS state, SRTP cipher, TLS version, and
-       * selected-candidate-pair changes.
-       */
-      transport?: { [key: string]: unknown };
-
-      [k: string]: unknown;
-    }
-  }
-}
+export type VoiceSDKCallReportsDefaultFlatPagination = DefaultFlatPagination<VoiceSDKCallReport>;
 
 /**
  * A raw call report stats JSON payload. The schema is intentionally permissive
  * because Voice SDK clients can add fields over time.
  */
-export interface VoiceSDKCallReportListResponse {
+export interface VoiceSDKCallReport {
   /**
    * Unique call identifier.
    */
@@ -269,7 +71,7 @@ export interface VoiceSDKCallReportListResponse {
    * responses commonly return an array of log entries, but object-shaped log
    * payloads are also allowed for compatibility.
    */
-  logs?: Array<VoiceSDKCallReportLogEntry> | VoiceSDKCallReportListResponse.Entries;
+  logs?: Array<VoiceSDKCallReportLogEntry> | VoiceSDKCallReport.Entries;
 
   /**
    * Organization associated with the stored call report when provided by the Voice
@@ -289,7 +91,7 @@ export interface VoiceSDKCallReportListResponse {
    * an array of interval snapshots, but object-shaped stats payloads are also
    * allowed for compatibility.
    */
-  stats?: Array<{ [key: string]: unknown }> | VoiceSDKCallReportListResponse.UnionMember1;
+  stats?: Array<{ [key: string]: unknown }> | VoiceSDKCallReport.UnionMember1;
 
   /**
    * Time when the call report was stored.
@@ -349,7 +151,7 @@ export interface VoiceSDKCallReportListResponse {
   [k: string]: unknown;
 }
 
-export namespace VoiceSDKCallReportListResponse {
+export namespace VoiceSDKCallReport {
   /**
    * Raw logs object emitted by the Voice SDK when logs are grouped under an entries
    * field.
@@ -395,6 +197,38 @@ export namespace VoiceSDKCallReportListResponse {
   }
 }
 
+/**
+ * A raw Voice SDK log entry. Additional SDK-specific fields may be present.
+ */
+export interface VoiceSDKCallReportLogEntry {
+  /**
+   * Raw structured context attached to the log entry.
+   */
+  context?: { [key: string]: unknown };
+
+  /**
+   * Log level emitted by the SDK.
+   */
+  level?: 'debug' | 'info' | 'warn' | 'error';
+
+  /**
+   * Log message.
+   */
+  message?: string;
+
+  /**
+   * Time when the log entry was emitted.
+   */
+  timestamp?: string;
+
+  [k: string]: unknown;
+}
+
+/**
+ * Raw Voice SDK call report stats payloads as stored by voice-sdk-debug.
+ */
+export type VoiceSDKCallReportRetrieveResponse = Array<VoiceSDKCallReport>;
+
 export interface VoiceSDKCallReportListParams extends DefaultFlatPaginationParams {
   /**
    * Set the order of the results by creation date. `asc` and `created_at` sort
@@ -406,10 +240,10 @@ export interface VoiceSDKCallReportListParams extends DefaultFlatPaginationParam
 
 export declare namespace VoiceSDKCallReports {
   export {
+    type VoiceSDKCallReport as VoiceSDKCallReport,
     type VoiceSDKCallReportLogEntry as VoiceSDKCallReportLogEntry,
     type VoiceSDKCallReportRetrieveResponse as VoiceSDKCallReportRetrieveResponse,
-    type VoiceSDKCallReportListResponse as VoiceSDKCallReportListResponse,
-    type VoiceSDKCallReportListResponsesDefaultFlatPagination as VoiceSDKCallReportListResponsesDefaultFlatPagination,
+    type VoiceSDKCallReportsDefaultFlatPagination as VoiceSDKCallReportsDefaultFlatPagination,
     type VoiceSDKCallReportListParams as VoiceSDKCallReportListParams,
   };
 }