@cartesia/cartesia-js 3.0.0-b3 → 3.0.0-b5

package/resources/voices.d.ts

@@ -8,42 +8,81 @@ export declare class Voices extends APIResource {
      * Update the name, description, and gender of a voice. To set the gender back to
      * the default, set the gender to `null`. If gender is not specified, the gender
      * will not be updated.
+     *
+     * @example
+     * ```ts
+     * const voice = await client.voices.update('id', {
+     *   description: 'description',
+     *   name: 'name',
+     * });
+     * ```
      */
     update(id: string, body: VoiceUpdateParams, options?: RequestOptions): APIPromise<Voice>;
     /**
      * List Voices
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const voice of client.voices.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: VoiceListParams | null | undefined, options?: RequestOptions): PagePromise<VoicesCursorIDPage, Voice>;
     /**
      * Delete Voice
+     *
+     * @example
+     * ```ts
+     * await client.voices.delete('id');
+     * ```
      */
     delete(id: string, options?: RequestOptions): APIPromise<void>;
     /**
      * Clone a high similarity voice from an audio clip. Clones are more similar to the
      * source clip, but may reproduce background noise. For these, use an audio clip
      * about 5 seconds long.
+     *
+     * @example
+     * ```ts
+     * const voiceMetadata = await client.voices.clone();
+     * ```
      */
     clone(body: VoiceCloneParams, options?: RequestOptions): APIPromise<VoiceMetadata>;
     /**
      * Get Voice
+     *
+     * @example
+     * ```ts
+     * const voice = await client.voices.get('id');
+     * ```
      */
-    get(id: string, options?: RequestOptions): APIPromise<Voice>;
+    get(id: string, query?: VoiceGetParams | null | undefined, options?: RequestOptions): APIPromise<Voice>;
     /**
      * Create a new voice from an existing voice localized to a new language and
      * dialect.
+     *
+     * @example
+     * ```ts
+     * const voiceMetadata = await client.voices.localize({
+     *   description: 'description',
+     *   language: 'en',
+     *   name: 'name',
+     *   original_speaker_gender: 'male',
+     *   voice_id: 'voice_id',
+     * });
+     * ```
      */
     localize(body: VoiceLocalizeParams, options?: RequestOptions): APIPromise<VoiceMetadata>;
 }
 export type VoicesCursorIDPage = CursorIDPage<Voice>;
 export type GenderPresentation = 'masculine' | 'feminine' | 'gender_neutral';
 /**
- * The language that the given voice should speak the transcript in.
- *
- * Options: English (en), French (fr), German (de), Spanish (es), Portuguese (pt),
- * Chinese (zh), Japanese (ja), Hindi (hi), Italian (it), Korean (ko), Dutch (nl),
- * Polish (pl), Russian (ru), Swedish (sv), Turkish (tr).
+ * The language that the given voice should speak the transcript in. For valid
+ * options, see [Models](/build-with-cartesia/tts-models).
  */
-export type SupportedLanguage = 'en' | 'fr' | 'de' | 'es' | 'pt' | 'zh' | 'ja' | 'hi' | 'it' | 'ko' | 'nl' | 'pl' | 'ru' | 'sv' | 'tr';
+export type SupportedLanguage = 'en' | 'fr' | 'de' | 'es' | 'pt' | 'zh' | 'ja' | 'hi' | 'it' | 'ko' | 'nl' | 'pl' | 'ru' | 'sv' | 'tr' | 'tl' | 'bg' | 'ro' | 'ar' | 'cs' | 'el' | 'fi' | 'hr' | 'ms' | 'sk' | 'da' | 'ta' | 'uk' | 'hu' | 'no' | 'vi' | 'bn' | 'th' | 'he' | 'ka' | 'id' | 'te' | 'gu' | 'kn' | 'ml' | 'mr' | 'pa';
 export interface Voice {
     /**
      * The ID of the voice.
@@ -58,7 +97,7 @@ export interface Voice {
      */
     description: string;
     /**
-     * Whether the current user is the owner of the voice.
+     * Whether your organization owns the voice.
      */
     is_owner: boolean;
     /**
@@ -66,11 +105,8 @@ export interface Voice {
      */
     is_public: boolean;
     /**
-     * The language that the given voice should speak the transcript in.
-     *
-     * Options: English (en), French (fr), German (de), Spanish (es), Portuguese (pt),
-     * Chinese (zh), Japanese (ja), Hindi (hi), Italian (it), Korean (ko), Dutch (nl),
-     * Polish (pl), Russian (ru), Swedish (sv), Turkish (tr).
+     * The language that the given voice should speak the transcript in. For valid
+     * options, see [Models](/build-with-cartesia/tts-models).
      */
     language: SupportedLanguage;
     /**
@@ -82,10 +118,13 @@ export interface Voice {
      */
     gender?: GenderPresentation | null;
     /**
-     * Whether the current user has starred the voice. Only included when `expand`
-     * includes `is_starred`.
+     * A URL to download a preview audio file for this voice. Useful to avoid consuming
+     * credits when looking for the right voice. The URL requires the same
+     * Authorization header. Voice previews may be changed, moved, or deleted so you
+     * should avoid storing the URL permanently. This property will be null if there's
+     * no preview available. Only included when `expand[]` includes `preview_file_url`.
      */
-    is_starred?: boolean | null;
+    preview_file_url?: string | null;
 }
 export interface VoiceMetadata {
     /**
@@ -105,11 +144,8 @@ export interface VoiceMetadata {
      */
     is_public: boolean;
     /**
-     * The language that the given voice should speak the transcript in.
-     *
-     * Options: English (en), French (fr), German (de), Spanish (es), Portuguese (pt),
-     * Chinese (zh), Japanese (ja), Hindi (hi), Italian (it), Korean (ko), Dutch (nl),
-     * Polish (pl), Russian (ru), Swedish (sv), Turkish (tr).
+     * The language that the given voice should speak the transcript in. For valid
+     * options, see [Models](/build-with-cartesia/tts-models).
      */
     language: SupportedLanguage;
     /**
@@ -136,24 +172,23 @@ export interface VoiceListParams extends CursorIDPageParams {
     /**
      * Additional fields to include in the response.
      */
-    expand?: Array<'is_starred'> | null;
+    expand?: Array<'preview_file_url'> | null;
     /**
      * The gender presentation of the voices to return.
      */
     gender?: GenderPresentation | null;
     /**
-     * Whether to only return voices owned by the current user.
+     * Whether to only return voices owned your organization.
      */
     is_owner?: boolean | null;
-    /**
-     * Whether to only return starred voices.
-     */
-    is_starred?: boolean | null;
-    language?: string;
     /**
      * The number of Voices to return per page, ranging between 1 and 100.
      */
     limit?: number | null;
+    /**
+     * Query string to search for voices by name, description, or Voice ID.
+     */
+    q?: string | null;
 }
 export interface VoiceCloneParams {
     /**
@@ -165,11 +200,6 @@ export interface VoiceCloneParams {
      * A description for the voice.
      */
     description?: string | null;
-    /**
-     * Whether to apply AI enhancements to the clip to reduce background noise. This is
-     * not recommended unless the source clip is extremely low quality.
-     */
-    enhance?: boolean | null;
     /**
      * The language of the voice.
      */
@@ -179,6 +209,12 @@ export interface VoiceCloneParams {
      */
     name?: string;
 }
+export interface VoiceGetParams {
+    /**
+     * Additional fields to include in the response.
+     */
+    expand?: Array<'preview_file_url'> | null;
+}
 export interface VoiceLocalizeParams {
     /**
      * The description of the new localized voice.
@@ -208,6 +244,6 @@ export interface VoiceLocalizeParams {
     dialect?: 'au' | 'in' | 'so' | 'uk' | 'us' | 'mx' | 'pe' | 'br' | 'eu' | 'ca' | null;
 }
 export declare namespace Voices {
-    export { type GenderPresentation as GenderPresentation, type SupportedLanguage as SupportedLanguage, type Voice as Voice, type VoiceMetadata as VoiceMetadata, type VoicesCursorIDPage as VoicesCursorIDPage, type VoiceUpdateParams as VoiceUpdateParams, type VoiceListParams as VoiceListParams, type VoiceCloneParams as VoiceCloneParams, type VoiceLocalizeParams as VoiceLocalizeParams, };
+    export { type GenderPresentation as GenderPresentation, type SupportedLanguage as SupportedLanguage, type Voice as Voice, type VoiceMetadata as VoiceMetadata, type VoicesCursorIDPage as VoicesCursorIDPage, type VoiceUpdateParams as VoiceUpdateParams, type VoiceListParams as VoiceListParams, type VoiceCloneParams as VoiceCloneParams, type VoiceGetParams as VoiceGetParams, type VoiceLocalizeParams as VoiceLocalizeParams, };
 }
 //# sourceMappingURL=voices.d.ts.map

package/resources/voices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"voices.d.ts","sourceRoot":"","sources":["../src/resources/voices.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,KAAK,UAAU,EAAE;OAEnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIxF;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kBAAkB,EAAE,KAAK,CAAC;IAIzC;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;OAIG;IACH,KAAK,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAOlF;;OAEG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI5D;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;CAGzF;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAErD,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAE7E;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GACzB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;AAET,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;;OAMG;IACH,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;;OAMG;IACH,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACzD;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,QAAQ,EACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,uBAAuB,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE3C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"voices.d.ts","sourceRoot":"","sources":["../src/resources/voices.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,KAAK,UAAU,EAAE;OAEnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIxF;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kBAAkB,EAAE,KAAK,CAAC;IAIzC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAOlF;;;;;;;OAOG;IACH,GAAG,CACD,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;CAGzF;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAErD,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAE7E;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GACzB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;AAET,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEnC;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACzD;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,QAAQ,EACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;IAET;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,uBAAuB,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE3C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;CACtF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/voices.js

@@ -12,18 +12,39 @@ class Voices extends resource_1.APIResource {
      * Update the name, description, and gender of a voice. To set the gender back to
      * the default, set the gender to `null`. If gender is not specified, the gender
      * will not be updated.
+     *
+     * @example
+     * ```ts
+     * const voice = await client.voices.update('id', {
+     *   description: 'description',
+     *   name: 'name',
+     * });
+     * ```
      */
     update(id, body, options) {
         return this._client.patch((0, path_1.path) `/voices/${id}`, { body, ...options });
     }
     /**
      * List Voices
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const voice of client.voices.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
-        return this._client.getAPIList('/voices/', (pagination_1.CursorIDPage), { query, ...options });
+        return this._client.getAPIList('/voices', (pagination_1.CursorIDPage), { query, ...options });
     }
     /**
      * Delete Voice
+     *
+     * @example
+     * ```ts
+     * await client.voices.delete('id');
+     * ```
      */
     delete(id, options) {
         return this._client.delete((0, path_1.path) `/voices/${id}`, {
@@ -35,19 +56,40 @@ class Voices extends resource_1.APIResource {
      * Clone a high similarity voice from an audio clip. Clones are more similar to the
      * source clip, but may reproduce background noise. For these, use an audio clip
      * about 5 seconds long.
+     *
+     * @example
+     * ```ts
+     * const voiceMetadata = await client.voices.clone();
+     * ```
      */
     clone(body, options) {
         return this._client.post('/voices/clone', (0, uploads_1.multipartFormRequestOptions)({ body, ...options }, this._client));
     }
     /**
      * Get Voice
+     *
+     * @example
+     * ```ts
+     * const voice = await client.voices.get('id');
+     * ```
      */
-    get(id, options) {
-        return this._client.get((0, path_1.path) `/voices/${id}`, options);
+    get(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/voices/${id}`, { query, ...options });
     }
     /**
      * Create a new voice from an existing voice localized to a new language and
      * dialect.
+     *
+     * @example
+     * ```ts
+     * const voiceMetadata = await client.voices.localize({
+     *   description: 'description',
+     *   language: 'en',
+     *   name: 'name',
+     *   original_speaker_gender: 'male',
+     *   voice_id: 'voice_id',
+     * });
+     * ```
      */
     localize(body, options) {
         return this._client.post('/voices/localize', { body, ...options });

package/resources/voices.js.map

@@ -1 +1 @@
-{"version":3,"file":"voices.js","sourceRoot":"","sources":["../src/resources/voices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAwF;AAExF,oDAAmD;AAEnD,oDAAkE;AAClE,oDAA8C;AAE9C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;OAIG;IACH,MAAM,CAAC,EAAU,EAAE,IAAuB,EAAE,OAAwB;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA,yBAAmB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,WAAW,EAAE,EAAE,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAsB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,eAAe,EACf,IAAA,qCAA2B,EAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF;AAxDD,wBAwDC"}
+{"version":3,"file":"voices.js","sourceRoot":"","sources":["../src/resources/voices.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAwF;AAExF,oDAAmD;AAEnD,oDAAkE;AAClE,oDAA8C;AAE9C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,IAAuB,EAAE,OAAwB;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,yBAAmB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,WAAW,EAAE,EAAE,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAsB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,eAAe,EACf,IAAA,qCAA2B,EAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CACD,EAAU,EACV,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF;AAtGD,wBAsGC"}

package/resources/voices.mjs

@@ -9,18 +9,39 @@ export class Voices extends APIResource {
      * Update the name, description, and gender of a voice. To set the gender back to
      * the default, set the gender to `null`. If gender is not specified, the gender
      * will not be updated.
+     *
+     * @example
+     * ```ts
+     * const voice = await client.voices.update('id', {
+     *   description: 'description',
+     *   name: 'name',
+     * });
+     * ```
      */
     update(id, body, options) {
         return this._client.patch(path `/voices/${id}`, { body, ...options });
     }
     /**
      * List Voices
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const voice of client.voices.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
-        return this._client.getAPIList('/voices/', (CursorIDPage), { query, ...options });
+        return this._client.getAPIList('/voices', (CursorIDPage), { query, ...options });
     }
     /**
      * Delete Voice
+     *
+     * @example
+     * ```ts
+     * await client.voices.delete('id');
+     * ```
      */
     delete(id, options) {
         return this._client.delete(path `/voices/${id}`, {
@@ -32,19 +53,40 @@ export class Voices extends APIResource {
      * Clone a high similarity voice from an audio clip. Clones are more similar to the
      * source clip, but may reproduce background noise. For these, use an audio clip
      * about 5 seconds long.
+     *
+     * @example
+     * ```ts
+     * const voiceMetadata = await client.voices.clone();
+     * ```
      */
     clone(body, options) {
         return this._client.post('/voices/clone', multipartFormRequestOptions({ body, ...options }, this._client));
     }
     /**
      * Get Voice
+     *
+     * @example
+     * ```ts
+     * const voice = await client.voices.get('id');
+     * ```
      */
-    get(id, options) {
-        return this._client.get(path `/voices/${id}`, options);
+    get(id, query = {}, options) {
+        return this._client.get(path `/voices/${id}`, { query, ...options });
     }
     /**
      * Create a new voice from an existing voice localized to a new language and
      * dialect.
+     *
+     * @example
+     * ```ts
+     * const voiceMetadata = await client.voices.localize({
+     *   description: 'description',
+     *   language: 'en',
+     *   name: 'name',
+     *   original_speaker_gender: 'male',
+     *   voice_id: 'voice_id',
+     * });
+     * ```
      */
     localize(body, options) {
         return this._client.post('/voices/localize', { body, ...options });

package/resources/voices.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"voices.mjs","sourceRoot":"","sources":["../src/resources/voices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAwC;OAEtD,EAAE,YAAY,EAAE;OAEhB,EAAE,2BAA2B,EAAE;OAC/B,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;OAIG;IACH,MAAM,CAAC,EAAU,EAAE,IAAuB,EAAE,OAAwB;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA,YAAmB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,EAAE,EAAE,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAsB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,eAAe,EACf,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF"}
+{"version":3,"file":"voices.mjs","sourceRoot":"","sources":["../src/resources/voices.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAwC;OAEtD,EAAE,YAAY,EAAE;OAEhB,EAAE,2BAA2B,EAAE;OAC/B,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,IAAuB,EAAE,OAAwB;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA,YAAmB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,EAAE,EAAE,EAAE;YAC9C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAsB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,eAAe,EACf,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CACD,EAAU,EACV,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF"}