@cartesia/cartesia-js 2.2.8 → 3.0.0-b3

package/src/resources/voices.ts

@@ -0,0 +1,325 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from '../core/pagination';
+import { type Uploadable } from '../core/uploads';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { multipartFormRequestOptions } from '../internal/uploads';
+import { path } from '../internal/utils/path';
+
+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.
+   */
+  update(id: string, body: VoiceUpdateParams, options?: RequestOptions): APIPromise<Voice> {
+    return this._client.patch(path`/voices/${id}`, { body, ...options });
+  }
+
+  /**
+   * List Voices
+   */
+  list(
+    query: VoiceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<VoicesCursorIDPage, Voice> {
+    return this._client.getAPIList('/voices/', CursorIDPage<Voice>, { query, ...options });
+  }
+
+  /**
+   * Delete Voice
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/voices/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * 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.
+   */
+  clone(body: VoiceCloneParams, options?: RequestOptions): APIPromise<VoiceMetadata> {
+    return this._client.post(
+      '/voices/clone',
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+
+  /**
+   * Get Voice
+   */
+  get(id: string, options?: RequestOptions): APIPromise<Voice> {
+    return this._client.get(path`/voices/${id}`, options);
+  }
+
+  /**
+   * Create a new voice from an existing voice localized to a new language and
+   * dialect.
+   */
+  localize(body: VoiceLocalizeParams, options?: RequestOptions): APIPromise<VoiceMetadata> {
+    return this._client.post('/voices/localize', { body, ...options });
+  }
+}
+
+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).
+ */
+export type SupportedLanguage =
+  | 'en'
+  | 'fr'
+  | 'de'
+  | 'es'
+  | 'pt'
+  | 'zh'
+  | 'ja'
+  | 'hi'
+  | 'it'
+  | 'ko'
+  | 'nl'
+  | 'pl'
+  | 'ru'
+  | 'sv'
+  | 'tr';
+
+export interface Voice {
+  /**
+   * The ID of the voice.
+   */
+  id: string;
+
+  /**
+   * The date and time the voice was created.
+   */
+  created_at: string;
+
+  /**
+   * The description of the voice.
+   */
+  description: string;
+
+  /**
+   * Whether the current user is the owner of the voice.
+   */
+  is_owner: boolean;
+
+  /**
+   * Whether the voice is publicly accessible.
+   */
+  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).
+   */
+  language: SupportedLanguage;
+
+  /**
+   * The name of the voice.
+   */
+  name: string;
+
+  /**
+   * The gender of the voice, if specified.
+   */
+  gender?: GenderPresentation | null;
+
+  /**
+   * Whether the current user has starred the voice. Only included when `expand`
+   * includes `is_starred`.
+   */
+  is_starred?: boolean | null;
+}
+
+export interface VoiceMetadata {
+  /**
+   * The ID of the voice.
+   */
+  id: string;
+
+  /**
+   * The date and time the voice was created.
+   */
+  created_at: string;
+
+  /**
+   * The description of the voice.
+   */
+  description: string;
+
+  /**
+   * Whether the voice is publicly accessible.
+   */
+  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).
+   */
+  language: SupportedLanguage;
+
+  /**
+   * The name of the voice.
+   */
+  name: string;
+
+  /**
+   * The ID of the user who owns the voice.
+   */
+  user_id: string;
+}
+
+export interface VoiceUpdateParams {
+  /**
+   * The description of the voice.
+   */
+  description: string;
+
+  /**
+   * The name of the voice.
+   */
+  name: string;
+
+  gender?: GenderPresentation | null;
+}
+
+export interface VoiceListParams extends CursorIDPageParams {
+  /**
+   * Additional fields to include in the response.
+   */
+  expand?: Array<'is_starred'> | null;
+
+  /**
+   * The gender presentation of the voices to return.
+   */
+  gender?: GenderPresentation | null;
+
+  /**
+   * Whether to only return voices owned by the current user.
+   */
+  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;
+}
+
+export interface VoiceCloneParams {
+  /**
+   * Optional base voice ID that the cloned voice is derived from.
+   */
+  base_voice_id?: string | null;
+
+  clip?: Uploadable;
+
+  /**
+   * 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.
+   */
+  language?: SupportedLanguage;
+
+  /**
+   * The name of the voice.
+   */
+  name?: string;
+}
+
+export interface VoiceLocalizeParams {
+  /**
+   * The description of the new localized voice.
+   */
+  description: string;
+
+  /**
+   * Target language to localize the voice to.
+   *
+   * Options: English (en), German (de), Spanish (es), French (fr), Japanese (ja),
+   * Portuguese (pt), Chinese (zh), Hindi (hi), Italian (it), Korean (ko), Dutch
+   * (nl), Polish (pl), Russian (ru), Swedish (sv), Turkish (tr).
+   */
+  language:
+    | 'en'
+    | 'de'
+    | 'es'
+    | 'fr'
+    | 'ja'
+    | 'pt'
+    | 'zh'
+    | 'hi'
+    | 'it'
+    | 'ko'
+    | 'nl'
+    | 'pl'
+    | 'ru'
+    | 'sv'
+    | 'tr';
+
+  /**
+   * The name of the new localized voice.
+   */
+  name: string;
+
+  original_speaker_gender: 'male' | 'female';
+
+  /**
+   * The ID of the voice to localize.
+   */
+  voice_id: string;
+
+  /**
+   * The dialect to localize to. Only supported for English (`en`), Spanish (`es`),
+   * Portuguese (`pt`), and French (`fr`).
+   */
+  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,
+  };
+}

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

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

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/version.d.mts

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

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,aAAa,CAAC"}

package/version.d.ts

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

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,aAAa,CAAC"}

package/version.js

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

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,UAAU,CAAC,CAAC,2BAA2B"}

package/version.mjs

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

package/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,2BAA2B"}

package/Client.d.ts

@@ -1,53 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "./environments";
-import * as core from "./core";
-import { ApiStatus } from "./api/resources/apiStatus/client/Client";
-import { Auth } from "./api/resources/auth/client/Client";
-import { Infill } from "./api/resources/infill/client/Client";
-import { Stt } from "./api/resources/stt/client/Client";
-import { Tts } from "./api/resources/tts/client/Client";
-import { VoiceChanger } from "./api/resources/voiceChanger/client/Client";
-import { Voices } from "./api/resources/voices/client/Client";
-export declare namespace CartesiaClient {
-    interface Options {
-        environment?: core.Supplier<environments.CartesiaEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        apiKey?: core.Supplier<string | undefined>;
-        /** Override the Cartesia-Version header */
-        cartesiaVersion?: "2024-06-10";
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Override the Cartesia-Version header */
-        cartesiaVersion?: "2024-06-10";
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
-    }
-}
-export declare class CartesiaClient {
-    protected readonly _options: CartesiaClient.Options;
-    protected _apiStatus: ApiStatus | undefined;
-    protected _auth: Auth | undefined;
-    protected _infill: Infill | undefined;
-    protected _stt: Stt | undefined;
-    protected _tts: Tts | undefined;
-    protected _voiceChanger: VoiceChanger | undefined;
-    protected _voices: Voices | undefined;
-    constructor(_options?: CartesiaClient.Options);
-    get apiStatus(): ApiStatus;
-    get auth(): Auth;
-    get infill(): Infill;
-    get stt(): Stt;
-    get tts(): Tts;
-    get voiceChanger(): VoiceChanger;
-    get voices(): Voices;
-}

package/Client.js

@@ -1,47 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CartesiaClient = void 0;
-const Client_1 = require("./api/resources/apiStatus/client/Client");
-const Client_2 = require("./api/resources/auth/client/Client");
-const Client_3 = require("./api/resources/infill/client/Client");
-const Client_4 = require("./api/resources/stt/client/Client");
-const Client_5 = require("./api/resources/tts/client/Client");
-const Client_6 = require("./api/resources/voiceChanger/client/Client");
-const Client_7 = require("./api/resources/voices/client/Client");
-class CartesiaClient {
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    get apiStatus() {
-        var _a;
-        return ((_a = this._apiStatus) !== null && _a !== void 0 ? _a : (this._apiStatus = new Client_1.ApiStatus(this._options)));
-    }
-    get auth() {
-        var _a;
-        return ((_a = this._auth) !== null && _a !== void 0 ? _a : (this._auth = new Client_2.Auth(this._options)));
-    }
-    get infill() {
-        var _a;
-        return ((_a = this._infill) !== null && _a !== void 0 ? _a : (this._infill = new Client_3.Infill(this._options)));
-    }
-    get stt() {
-        var _a;
-        return ((_a = this._stt) !== null && _a !== void 0 ? _a : (this._stt = new Client_4.Stt(this._options)));
-    }
-    get tts() {
-        var _a;
-        return ((_a = this._tts) !== null && _a !== void 0 ? _a : (this._tts = new Client_5.Tts(this._options)));
-    }
-    get voiceChanger() {
-        var _a;
-        return ((_a = this._voiceChanger) !== null && _a !== void 0 ? _a : (this._voiceChanger = new Client_6.VoiceChanger(this._options)));
-    }
-    get voices() {
-        var _a;
-        return ((_a = this._voices) !== null && _a !== void 0 ? _a : (this._voices = new Client_7.Voices(this._options)));
-    }
-}
-exports.CartesiaClient = CartesiaClient;

package/api/index.d.ts

@@ -1 +0,0 @@
-export * from "./resources";

package/api/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./resources"), exports);

package/api/resources/apiStatus/client/Client.d.ts

@@ -1,43 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments";
-import * as core from "../../../../core";
-import * as Cartesia from "../../../index";
-export declare namespace ApiStatus {
-    interface Options {
-        environment?: core.Supplier<environments.CartesiaEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        apiKey?: core.Supplier<string | undefined>;
-        /** Override the Cartesia-Version header */
-        cartesiaVersion?: "2024-06-10";
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Override the Cartesia-Version header */
-        cartesiaVersion?: "2024-06-10";
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
-    }
-}
-export declare class ApiStatus {
-    protected readonly _options: ApiStatus.Options;
-    constructor(_options?: ApiStatus.Options);
-    /**
-     * @param {ApiStatus.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.apiStatus.get()
-     */
-    get(requestOptions?: ApiStatus.RequestOptions): Promise<Cartesia.ApiInfo>;
-    protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-API-Key": string | undefined;
-    }>;
-}