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

package/src/resources/voices.ts

@@ -14,6 +14,14 @@ 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: string, body: VoiceUpdateParams, options?: RequestOptions): APIPromise<Voice> {
     return this._client.patch(path`/voices/${id}`, { body, ...options });
@@ -21,16 +29,29 @@ export class Voices extends APIResource {
 
   /**
    * 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> {
-    return this._client.getAPIList('/voices/', CursorIDPage<Voice>, { query, ...options });
+    return this._client.getAPIList('/voices', CursorIDPage<Voice>, { query, ...options });
   }
 
   /**
    * Delete Voice
+   *
+   * @example
+   * ```ts
+   * await client.voices.delete('id');
+   * ```
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/voices/${id}`, {
@@ -43,6 +64,11 @@ 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: VoiceCloneParams, options?: RequestOptions): APIPromise<VoiceMetadata> {
     return this._client.post(
@@ -53,14 +79,34 @@ export class Voices extends APIResource {
 
   /**
    * Get Voice
-   */
-  get(id: string, options?: RequestOptions): APIPromise<Voice> {
-    return this._client.get(path`/voices/${id}`, options);
+   *
+   * @example
+   * ```ts
+   * const voice = await client.voices.get('id');
+   * ```
+   */
+  get(
+    id: string,
+    query: VoiceGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Voice> {
+    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: VoiceLocalizeParams, options?: RequestOptions): APIPromise<VoiceMetadata> {
     return this._client.post('/voices/localize', { body, ...options });
@@ -72,11 +118,8 @@ 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'
@@ -93,7 +136,34 @@ export type SupportedLanguage =
   | 'pl'
   | 'ru'
   | 'sv'
-  | 'tr';
+  | '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 {
   /**
@@ -112,7 +182,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;
 
@@ -122,11 +192,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;
 
@@ -141,10 +208,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 {
@@ -169,11 +239,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;
 
@@ -206,7 +273,7 @@ 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.
@@ -214,21 +281,19 @@ export interface VoiceListParams extends CursorIDPageParams {
   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.
+   * The number of Voices to return per page, ranging between 1 and 100.
    */
-  is_starred?: boolean | null;
-
-  language?: string;
+  limit?: number | null;
 
   /**
-   * The number of Voices to return per page, ranging between 1 and 100.
+   * Query string to search for voices by name, description, or Voice ID.
    */
-  limit?: number | null;
+  q?: string | null;
 }
 
 export interface VoiceCloneParams {
@@ -244,12 +309,6 @@ export interface VoiceCloneParams {
    */
   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.
    */
@@ -261,6 +320,13 @@ 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.
@@ -320,6 +386,7 @@ export declare namespace Voices {
     type VoiceUpdateParams as VoiceUpdateParams,
     type VoiceListParams as VoiceListParams,
     type VoiceCloneParams as VoiceCloneParams,
+    type VoiceGetParams as VoiceGetParams,
     type VoiceLocalizeParams as VoiceLocalizeParams,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.0.0-b3'; // x-release-please-version
+export const VERSION = '3.0.0-b4'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.0.0-b3";
+export declare const VERSION = "3.0.0-b4";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.0.0-b3";
+export declare const VERSION = "3.0.0-b4";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '3.0.0-b3'; // x-release-please-version
+exports.VERSION = '3.0.0-b4'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '3.0.0-b3'; // x-release-please-version
+export const VERSION = '3.0.0-b4'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map