telnyx 6.8.2 → 6.9.0

package/resources/voice-designs.d.mts

@@ -0,0 +1,361 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Create and manage AI-generated voice designs using natural language prompts.
+ */
+export declare class VoiceDesigns extends APIResource {
+    /**
+     * Creates a new voice design (version 1) when `voice_design_id` is omitted. When
+     * `voice_design_id` is provided, adds a new version to the existing design
+     * instead. A design can have at most 50 versions.
+     *
+     * @example
+     * ```ts
+     * const voiceDesign = await client.voiceDesigns.create({
+     *   prompt: 'Speak in a warm, friendly tone',
+     *   text: 'Hello, welcome to our service.',
+     * });
+     * ```
+     */
+    create(body: VoiceDesignCreateParams, options?: RequestOptions): APIPromise<VoiceDesignCreateResponse>;
+    /**
+     * Returns the latest version of a voice design, or a specific version when
+     * `?version=N` is provided. The `id` parameter accepts either a UUID or the design
+     * name.
+     *
+     * @example
+     * ```ts
+     * const voiceDesign = await client.voiceDesigns.retrieve(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieve(id: string, query?: VoiceDesignRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<VoiceDesignRetrieveResponse>;
+    /**
+     * Returns a paginated list of voice designs belonging to the authenticated
+     * account.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const voiceDesignListResponse of client.voiceDesigns.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: VoiceDesignListParams | null | undefined, options?: RequestOptions): PagePromise<VoiceDesignListResponsesDefaultFlatPagination, VoiceDesignListResponse>;
+    /**
+     * Permanently deletes a voice design and all of its versions. This action cannot
+     * be undone.
+     *
+     * @example
+     * ```ts
+     * await client.voiceDesigns.delete('id');
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Permanently deletes a specific version of a voice design. The version number
+     * must be a positive integer.
+     *
+     * @example
+     * ```ts
+     * await client.voiceDesigns.deleteVersion(1, { id: 'id' });
+     * ```
+     */
+    deleteVersion(version: number, params: VoiceDesignDeleteVersionParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Downloads the WAV audio sample for the voice design. Returns the latest
+     * version's sample by default, or a specific version when `?version=N` is
+     * provided. The `id` parameter accepts either a UUID or the design name.
+     *
+     * @example
+     * ```ts
+     * const response = await client.voiceDesigns.downloadSample(
+     *   'id',
+     * );
+     *
+     * const content = await response.blob();
+     * console.log(content);
+     * ```
+     */
+    downloadSample(id: string, query?: VoiceDesignDownloadSampleParams | null | undefined, options?: RequestOptions): APIPromise<Response>;
+    /**
+     * Updates the name of a voice design. All versions retain their other properties.
+     *
+     * @example
+     * ```ts
+     * const response = await client.voiceDesigns.rename('id', {
+     *   name: 'updated-narrator',
+     * });
+     * ```
+     */
+    rename(id: string, body: VoiceDesignRenameParams, options?: RequestOptions): APIPromise<VoiceDesignRenameResponse>;
+}
+export type VoiceDesignListResponsesDefaultFlatPagination = DefaultFlatPagination<VoiceDesignListResponse>;
+/**
+ * Response envelope for a single voice design with full version detail.
+ */
+export interface VoiceDesignCreateResponse {
+    /**
+     * A voice design object with full version detail.
+     */
+    data?: VoiceDesignCreateResponse.Data;
+}
+export declare namespace VoiceDesignCreateResponse {
+    /**
+     * A voice design object with full version detail.
+     */
+    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;
+        /**
+         * Natural language prompt used to define the voice style for this version.
+         */
+        prompt?: string;
+        /**
+         * Identifies the resource type.
+         */
+        record_type?: 'voice_design';
+        /**
+         * Sample text used to synthesize this version.
+         */
+        text?: string;
+        /**
+         * Timestamp when the voice design was last updated.
+         */
+        updated_at?: string;
+        /**
+         * Version number of this voice design.
+         */
+        version?: number;
+        /**
+         * Timestamp when this specific version was created.
+         */
+        version_created_at?: string;
+        /**
+         * Size of the voice sample audio in bytes.
+         */
+        voice_sample_size?: number;
+    }
+}
+/**
+ * Response envelope for a single voice design with full version detail.
+ */
+export interface VoiceDesignRetrieveResponse {
+    /**
+     * A voice design object with full version detail.
+     */
+    data?: VoiceDesignRetrieveResponse.Data;
+}
+export declare namespace VoiceDesignRetrieveResponse {
+    /**
+     * A voice design object with full version detail.
+     */
+    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;
+        /**
+         * Natural language prompt used to define the voice style for this version.
+         */
+        prompt?: string;
+        /**
+         * Identifies the resource type.
+         */
+        record_type?: 'voice_design';
+        /**
+         * Sample text used to synthesize this version.
+         */
+        text?: string;
+        /**
+         * Timestamp when the voice design was last updated.
+         */
+        updated_at?: string;
+        /**
+         * Version number of this voice design.
+         */
+        version?: number;
+        /**
+         * Timestamp when this specific version was created.
+         */
+        version_created_at?: string;
+        /**
+         * Size of the voice sample audio in bytes.
+         */
+        voice_sample_size?: number;
+    }
+}
+/**
+ * A summarized voice design object (without version-specific fields).
+ */
+export interface VoiceDesignListResponse {
+    /**
+     * 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;
+    /**
+     * Identifies the resource type.
+     */
+    record_type?: 'voice_design';
+    /**
+     * Timestamp when the voice design was last updated.
+     */
+    updated_at?: string;
+}
+/**
+ * Response envelope for a voice design after a rename operation (no
+ * version-specific fields).
+ */
+export interface VoiceDesignRenameResponse {
+    /**
+     * A summarized voice design object (without version-specific fields).
+     */
+    data?: VoiceDesignRenameResponse.Data;
+}
+export declare namespace VoiceDesignRenameResponse {
+    /**
+     * A summarized voice design object (without version-specific fields).
+     */
+    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;
+        /**
+         * Identifies the resource type.
+         */
+        record_type?: 'voice_design';
+        /**
+         * Timestamp when the voice design was last updated.
+         */
+        updated_at?: string;
+    }
+}
+export interface VoiceDesignCreateParams {
+    /**
+     * Natural language description of the voice style, e.g. 'Speak in a warm, friendly
+     * tone with a slight British accent'.
+     */
+    prompt: string;
+    /**
+     * Sample text to synthesize for this voice design.
+     */
+    text: string;
+    /**
+     * Language for synthesis. Supported values: Auto, Chinese, English, Japanese,
+     * Korean, German, French, Russian, Portuguese, Spanish, Italian. Defaults to Auto.
+     */
+    language?: string;
+    /**
+     * Maximum number of tokens to generate. Default: 2048.
+     */
+    max_new_tokens?: number;
+    /**
+     * Name for the voice design. Required when creating a new design
+     * (`voice_design_id` is not provided); ignored when adding a version. Cannot be a
+     * UUID.
+     */
+    name?: string;
+    /**
+     * Repetition penalty to reduce repeated patterns in generated audio. Default:
+     * 1.05.
+     */
+    repetition_penalty?: number;
+    /**
+     * Sampling temperature controlling randomness. Higher values produce more varied
+     * output. Default: 0.9.
+     */
+    temperature?: number;
+    /**
+     * Top-k sampling parameter — limits the token vocabulary considered at each step.
+     * Default: 50.
+     */
+    top_k?: number;
+    /**
+     * Top-p (nucleus) sampling parameter — cumulative probability cutoff for token
+     * selection. Default: 1.0.
+     */
+    top_p?: number;
+    /**
+     * ID of an existing voice design to add a new version to. When provided, a new
+     * version is created instead of a new design.
+     */
+    voice_design_id?: string;
+}
+export interface VoiceDesignRetrieveParams {
+    /**
+     * Specific version number to retrieve. Defaults to the latest version.
+     */
+    version?: number;
+}
+export interface VoiceDesignListParams extends DefaultFlatPaginationParams {
+    /**
+     * Case-insensitive substring filter on the name field.
+     */
+    'filter[name]'?: string;
+    /**
+     * Sort order. Prefix with `-` for descending. Defaults to `-created_at`.
+     */
+    sort?: 'name' | '-name' | 'created_at' | '-created_at';
+}
+export interface VoiceDesignDeleteVersionParams {
+    /**
+     * The voice design UUID or name.
+     */
+    id: string;
+}
+export interface VoiceDesignDownloadSampleParams {
+    /**
+     * Specific version number to download the sample for. Defaults to the latest
+     * version.
+     */
+    version?: number;
+}
+export interface VoiceDesignRenameParams {
+    /**
+     * New name for the voice design.
+     */
+    name: string;
+}
+export declare namespace VoiceDesigns {
+    export { type VoiceDesignCreateResponse as VoiceDesignCreateResponse, type VoiceDesignRetrieveResponse as VoiceDesignRetrieveResponse, type VoiceDesignListResponse as VoiceDesignListResponse, type VoiceDesignRenameResponse as VoiceDesignRenameResponse, type VoiceDesignListResponsesDefaultFlatPagination as VoiceDesignListResponsesDefaultFlatPagination, type VoiceDesignCreateParams as VoiceDesignCreateParams, type VoiceDesignRetrieveParams as VoiceDesignRetrieveParams, type VoiceDesignListParams as VoiceDesignListParams, type VoiceDesignDeleteVersionParams as VoiceDesignDeleteVersionParams, type VoiceDesignDownloadSampleParams as VoiceDesignDownloadSampleParams, type VoiceDesignRenameParams as VoiceDesignRenameParams, };
+}
+//# sourceMappingURL=voice-designs.d.mts.map

package/resources/voice-designs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"voice-designs.d.mts","sourceRoot":"","sources":["../src/resources/voice-designs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE;OAExE,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAItG;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6CAA6C,EAAE,uBAAuB,CAAC;IAOtF;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;OAQG;IACH,aAAa,CACX,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAQnB;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC;IASvB;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAGzC;AAED,MAAM,MAAM,6CAA6C,GAAG,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;AAE3G;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,cAAc,CAAC;QAE7B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,CAAC,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACzC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,cAAc,CAAC;QAE7B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACvC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,CAAC,EAAE,cAAc,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,qBAAsB,SAAQ,2BAA2B;IACxE;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,aAAa,CAAC;CACxD;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}