@elevenlabs/elevenlabs-js 2.4.1 → 2.6.0

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@elevenlabs/elevenlabs-js",
-    "version": "v2.4.1",
+    "version": "v2.6.0",
     "private": false,
-    "repository": "https://github.com/elevenlabs/elevenlabs-js",
+    "repository": "github:elevenlabs/elevenlabs-js",
     "license": "MIT",
     "main": "./index.js",
     "types": "./index.d.ts",
@@ -10,42 +10,41 @@
         "format": "prettier . --write --ignore-unknown",
         "build": "tsc",
         "prepack": "cp -rv dist/. .",
-        "test": "jest tests/unit --passWithNoTests",
-        "test:wire": "jest tests/wire --passWithNoTests",
-        "wire:test": "yarn test:wire"
+        "test": "jest --config jest.config.mjs",
+        "test:unit": "jest --selectProjects unit",
+        "test:browser": "jest --selectProjects browser",
+        "test:wire": "jest --selectProjects wire"
     },
     "dependencies": {
-        "url-join": "4.0.1",
-        "form-data": "^4.0.0",
-        "formdata-node": "^6.0.3",
-        "node-fetch": "^2.7.0",
-        "qs": "^6.13.1",
-        "form-data-encoder": "^4.0.2",
-        "command-exists": "^1.2.9"
+        "command-exists": "^1.2.9",
+        "node-fetch": "^2.7.0"
     },
     "devDependencies": {
-        "@types/url-join": "4.0.1",
-        "@types/qs": "^6.9.17",
-        "@types/node-fetch": "^2.6.12",
-        "webpack": "^5.97.1",
-        "ts-loader": "^9.5.1",
-        "jest": "^29.7.0",
         "@jest/globals": "^29.7.0",
+        "@types/command-exists": "^1.2.3",
         "@types/jest": "^29.5.5",
-        "ts-jest": "^29.1.1",
+        "@types/node": "^18.19.70",
+        "@types/node-fetch": "^2.6.12",
+        "@types/ws": "^8.18.1",
+        "jest": "^29.7.0",
         "jest-environment-jsdom": "^29.7.0",
         "msw": "^2.8.4",
-        "@types/node": "^18.19.70",
         "prettier": "^3.4.2",
+        "ts-jest": "^29.1.1",
+        "ts-loader": "^9.5.1",
         "typescript": "~5.7.2",
-        "@types/command-exists": "^1.2.3"
+        "webpack": "^5.97.1"
     },
     "browser": {
         "fs": false,
         "os": false,
         "path": false,
-        "command-exists": false,
-        "execa": false
+        "stream": false,
+        "command-exists": false
+    },
+    "packageManager": "yarn@1.22.22",
+    "engines": {
+        "node": ">=18.0.0"
     },
-    "packageManager": "yarn@1.22.22"
+    "sideEffects": false
 }

package/reference.md

@@ -1204,7 +1204,7 @@ await client.textToVoice.design({
 </dl>
 </details>
 
-## User
+## user
 
 <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">get</a>() -> ElevenLabs.User</code></summary>
 <dl>
@@ -2334,7 +2334,7 @@ await client.audioNative.update("21m00Tcm4TlvDq8ikWAM", {});
 </dl>
 </details>
 
-## Usage
+## usage
 
 <details><summary><code>client.usage.<a href="/src/api/resources/usage/client/Client.ts">get</a>({ ...params }) -> ElevenLabs.UsageCharactersResponseModel</code></summary>
 <dl>
@@ -2667,248 +2667,6 @@ await client.pronunciationDictionaries.list();
 </dl>
 </details>
 
-## Workspace
-
-<details><summary><code>client.workspace.<a href="/src/api/resources/workspace/client/Client.ts">updateUserAutoProvisioning</a>({ ...params }) -> unknown</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Update user auto provisioning settings for the workspace.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.workspace.updateUserAutoProvisioning({
-    enabled: true,
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `ElevenLabs.BodyUpdateUserAutoProvisioningV1WorkspaceUserAutoProvisioningPost`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Workspace.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.workspace.<a href="/src/api/resources/workspace/client/Client.ts">getDefaultSharingPreferences</a>() -> ElevenLabs.DefaultSharingPreferencesResponseModel</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Get the user's default sharing preferences.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.workspace.getDefaultSharingPreferences();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**requestOptions:** `Workspace.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.workspace.<a href="/src/api/resources/workspace/client/Client.ts">updateDefaultSharingPreferences</a>({ ...params }) -> unknown</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Update the user's default sharing preferences.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.workspace.updateDefaultSharingPreferences({
-    defaultSharingGroups: ["default_sharing_groups"],
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `ElevenLabs.BodyUpdateDefaultSharingPreferencesV1WorkspaceDefaultSharingPreferencesPost`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Workspace.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.workspace.<a href="/src/api/resources/workspace/client/Client.ts">getShareOptions</a>() -> ElevenLabs.ShareOptionResponseModel[]</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Get the share options for a workspace.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.workspace.getShareOptions();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**requestOptions:** `Workspace.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## Webhooks
 
 <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>({ ...params }) -> ElevenLabs.WorkspaceWebhookListResponseModel</code></summary>
@@ -4193,7 +3951,7 @@ Run a conversation between the agent and a simulated user.
 await client.conversationalAi.agents.simulateConversation("21m00Tcm4TlvDq8ikWAM", {
     simulationSpecification: {
         simulatedUserConfig: {
-            firstMessage: "Hello, how can I help you today?",
+            first_message: "Hello, how can I help you today?",
             language: "en",
         },
     },
@@ -4271,7 +4029,7 @@ Run a conversation between the agent and a simulated user and stream back the re
 await client.conversationalAi.agents.simulateConversationStream("21m00Tcm4TlvDq8ikWAM", {
     simulationSpecification: {
         simulatedUserConfig: {
-            firstMessage: "Hello, how can I help you today?",
+            first_message: "Hello, how can I help you today?",
             language: "en",
         },
     },
@@ -4320,7 +4078,7 @@ await client.conversationalAi.agents.simulateConversationStream("21m00Tcm4TlvDq8
 
 ## ConversationalAi PhoneNumbers
 
-<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.CreatePhoneNumberResponseModel</code></summary>
+<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">list</a>() -> ElevenLabs.PhoneNumbersListResponseItem[]</code></summary>
 <dl>
 <dd>
 
@@ -4332,7 +4090,7 @@ await client.conversationalAi.agents.simulateConversationStream("21m00Tcm4TlvDq8
 <dl>
 <dd>
 
-Import Phone Number from provider configuration (Twilio or SIP trunk)
+Retrieve all Phone Numbers
 
 </dd>
 </dl>
@@ -4348,13 +4106,7 @@ Import Phone Number from provider configuration (Twilio or SIP trunk)
 <dd>
 
 ```typescript
-await client.conversationalAi.phoneNumbers.create({
-    provider: "twilio",
-    phoneNumber: "phone_number",
-    label: "label",
-    sid: "sid",
-    token: "token",
-});
+await client.conversationalAi.phoneNumbers.list();
 ```
 
 </dd>
@@ -4370,14 +4122,6 @@ await client.conversationalAi.phoneNumbers.create({
 <dl>
 <dd>
 
-**request:** `ElevenLabs.PhoneNumbersCreateRequestBody`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
 **requestOptions:** `PhoneNumbers.RequestOptions`
 
 </dd>
@@ -4389,7 +4133,7 @@ await client.conversationalAi.phoneNumbers.create({
 </dl>
 </details>
 
-<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">get</a>(phoneNumberId) -> ElevenLabs.PhoneNumbersGetResponse</code></summary>
+<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">create</a>({ ...params }) -> ElevenLabs.CreatePhoneNumberResponseModel</code></summary>
 <dl>
 <dd>
 
@@ -4401,7 +4145,7 @@ await client.conversationalAi.phoneNumbers.create({
 <dl>
 <dd>
 
-Retrieve Phone Number details by ID
+Import Phone Number from provider configuration (Twilio or SIP trunk)
 
 </dd>
 </dl>
@@ -4417,7 +4161,13 @@ Retrieve Phone Number details by ID
 <dd>
 
 ```typescript
-await client.conversationalAi.phoneNumbers.get("TeaqRRdTcIfIu2i7BYfT");
+await client.conversationalAi.phoneNumbers.create({
+    provider: "twilio",
+    phoneNumber: "phone_number",
+    label: "label",
+    sid: "sid",
+    token: "token",
+});
 ```
 
 </dd>
@@ -4433,7 +4183,7 @@ await client.conversationalAi.phoneNumbers.get("TeaqRRdTcIfIu2i7BYfT");
 <dl>
 <dd>
 
-**phoneNumberId:** `string` — The id of an agent. This is returned on agent creation.
+**request:** `ElevenLabs.PhoneNumbersCreateRequestBody`
 
 </dd>
 </dl>
@@ -4452,7 +4202,7 @@ await client.conversationalAi.phoneNumbers.get("TeaqRRdTcIfIu2i7BYfT");
 </dl>
 </details>
 
-<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">delete</a>(phoneNumberId) -> unknown</code></summary>
+<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">get</a>(phoneNumberId) -> ElevenLabs.PhoneNumbersGetResponse</code></summary>
 <dl>
 <dd>
 
@@ -4464,7 +4214,7 @@ await client.conversationalAi.phoneNumbers.get("TeaqRRdTcIfIu2i7BYfT");
 <dl>
 <dd>
 
-Delete Phone Number by ID
+Retrieve Phone Number details by ID
 
 </dd>
 </dl>
@@ -4480,7 +4230,7 @@ Delete Phone Number by ID
 <dd>
 
 ```typescript
-await client.conversationalAi.phoneNumbers.delete("TeaqRRdTcIfIu2i7BYfT");
+await client.conversationalAi.phoneNumbers.get("TeaqRRdTcIfIu2i7BYfT");
 ```
 
 </dd>
@@ -4515,7 +4265,7 @@ await client.conversationalAi.phoneNumbers.delete("TeaqRRdTcIfIu2i7BYfT");
 </dl>
 </details>
 
-<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">update</a>(phoneNumberId, { ...params }) -> ElevenLabs.PhoneNumbersUpdateResponse</code></summary>
+<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">delete</a>(phoneNumberId) -> unknown</code></summary>
 <dl>
 <dd>
 
@@ -4527,7 +4277,7 @@ await client.conversationalAi.phoneNumbers.delete("TeaqRRdTcIfIu2i7BYfT");
 <dl>
 <dd>
 
-Update Phone Number details by ID
+Delete Phone Number by ID
 
 </dd>
 </dl>
@@ -4543,7 +4293,7 @@ Update Phone Number details by ID
 <dd>
 
 ```typescript
-await client.conversationalAi.phoneNumbers.update("TeaqRRdTcIfIu2i7BYfT");
+await client.conversationalAi.phoneNumbers.delete("TeaqRRdTcIfIu2i7BYfT");
 ```
 
 </dd>
@@ -4567,14 +4317,6 @@ await client.conversationalAi.phoneNumbers.update("TeaqRRdTcIfIu2i7BYfT");
 <dl>
 <dd>
 
-**request:** `ElevenLabs.conversationalAi.UpdatePhoneNumberRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
 **requestOptions:** `PhoneNumbers.RequestOptions`
 
 </dd>
@@ -4586,7 +4328,7 @@ await client.conversationalAi.phoneNumbers.update("TeaqRRdTcIfIu2i7BYfT");
 </dl>
 </details>
 
-<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">list</a>() -> ElevenLabs.PhoneNumbersListResponseItem[]</code></summary>
+<details><summary><code>client.conversationalAi.phoneNumbers.<a href="/src/api/resources/conversationalAi/resources/phoneNumbers/client/Client.ts">update</a>(phoneNumberId, { ...params }) -> ElevenLabs.PhoneNumbersUpdateResponse</code></summary>
 <dl>
 <dd>
 
@@ -4598,7 +4340,7 @@ await client.conversationalAi.phoneNumbers.update("TeaqRRdTcIfIu2i7BYfT");
 <dl>
 <dd>
 
-Retrieve all Phone Numbers
+Update Phone Number details by ID
 
 </dd>
 </dl>
@@ -4614,7 +4356,7 @@ Retrieve all Phone Numbers
 <dd>
 
 ```typescript
-await client.conversationalAi.phoneNumbers.list();
+await client.conversationalAi.phoneNumbers.update("TeaqRRdTcIfIu2i7BYfT");
 ```
 
 </dd>
@@ -4630,6 +4372,22 @@ await client.conversationalAi.phoneNumbers.list();
 <dl>
 <dd>
 
+**phoneNumberId:** `string` — The id of an agent. This is returned on agent creation.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `ElevenLabs.conversationalAi.UpdatePhoneNumberRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `PhoneNumbers.RequestOptions`
 
 </dd>
@@ -5758,7 +5516,7 @@ await client.conversationalAi.batchCalls.cancel("batch_id");
 <dl>
 <dd>
 
-Retry a batch call by setting completed recipients back to pending status.
+Retry a batch call, calling failed and no-response recipients again.
 
 </dd>
 </dl>
@@ -6811,7 +6569,7 @@ await client.conversationalAi.knowledgeBase.documents.createFromText({
 </dl>
 </details>
 
-<details><summary><code>client.conversationalAi.knowledgeBase.documents.<a href="/src/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/Client.ts">get</a>(documentationId) -> ElevenLabs.DocumentsGetResponse</code></summary>
+<details><summary><code>client.conversationalAi.knowledgeBase.documents.<a href="/src/api/resources/conversationalAi/resources/knowledgeBase/resources/documents/client/Client.ts">get</a>(documentationId, { ...params }) -> ElevenLabs.DocumentsGetResponse</code></summary>
 <dl>
 <dd>
 
@@ -6863,6 +6621,14 @@ await client.conversationalAi.knowledgeBase.documents.get("21m00Tcm4TlvDq8ikWAM"
 <dl>
 <dd>
 
+**request:** `ElevenLabs.conversationalAi.knowledgeBase.DocumentsGetRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `Documents.RequestOptions`
 
 </dd>
@@ -9921,6 +9687,8 @@ await client.studio.projects.chapters.snapshots.get(
 </dl>
 </details>
 
+## TextToVoice Preview
+
 ## User Subscription
 
 <details><summary><code>client.user.subscription.<a href="/src/api/resources/user/resources/subscription/client/Client.ts">get</a>() -> ElevenLabs.Subscription</code></summary>
@@ -10755,7 +10523,7 @@ await client.voices.pvc.verification.request("21m00Tcm4TlvDq8ikWAM", {
 
 ## Voices Pvc Samples Audio
 
-<details><summary><code>client.voices.pvc.samples.audio.<a href="/src/api/resources/voices/resources/pvc/resources/samples/resources/audio/client/Client.ts">get</a>(voiceId, sampleId) -> ElevenLabs.VoiceSamplePreviewResponseModel</code></summary>
+<details><summary><code>client.voices.pvc.samples.audio.<a href="/src/api/resources/voices/resources/pvc/resources/samples/resources/audio/client/Client.ts">get</a>(voiceId, sampleId, { ...params }) -> ElevenLabs.VoiceSamplePreviewResponseModel</code></summary>
 <dl>
 <dd>
 
@@ -10783,7 +10551,9 @@ Retrieve the first 30 seconds of voice sample audio with or without noise remova
 <dd>
 
 ```typescript
-await client.voices.pvc.samples.audio.get("21m00Tcm4TlvDq8ikWAM", "VW7YKqPnjY4h39yTbx2L");
+await client.voices.pvc.samples.audio.get("21m00Tcm4TlvDq8ikWAM", "VW7YKqPnjY4h39yTbx2L", {
+    removeBackgroundNoise: true,
+});
 ```
 
 </dd>
@@ -10815,6 +10585,14 @@ await client.voices.pvc.samples.audio.get("21m00Tcm4TlvDq8ikWAM", "VW7YKqPnjY4h3
 <dl>
 <dd>
 
+**request:** `ElevenLabs.voices.pvc.samples.AudioGetRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `Audio.RequestOptions`
 
 </dd>

package/serialization/resources/conversationalAi/resources/phoneNumbers/types/index.d.ts

@@ -1,4 +1,4 @@
+export * from "./PhoneNumbersListResponseItem";
 export * from "./PhoneNumbersCreateRequestBody";
 export * from "./PhoneNumbersGetResponse";
 export * from "./PhoneNumbersUpdateResponse";
-export * from "./PhoneNumbersListResponseItem";

package/serialization/resources/conversationalAi/resources/phoneNumbers/types/index.js

@@ -14,7 +14,7 @@ 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("./PhoneNumbersListResponseItem"), exports);
 __exportStar(require("./PhoneNumbersCreateRequestBody"), exports);
 __exportStar(require("./PhoneNumbersGetResponse"), exports);
 __exportStar(require("./PhoneNumbersUpdateResponse"), exports);
-__exportStar(require("./PhoneNumbersListResponseItem"), exports);

package/serialization/resources/index.d.ts

@@ -36,5 +36,4 @@ export * from "./textToVoice/client/requests";
 export * from "./voices/client/requests";
 export * from "./studio/client/requests";
 export * from "./pronunciationDictionaries/client/requests";
-export * from "./workspace/client/requests";
 export * from "./conversationalAi/client/requests";

package/serialization/resources/index.js

@@ -75,5 +75,4 @@ __exportStar(require("./textToVoice/client/requests"), exports);
 __exportStar(require("./voices/client/requests"), exports);
 __exportStar(require("./studio/client/requests"), exports);
 __exportStar(require("./pronunciationDictionaries/client/requests"), exports);
-__exportStar(require("./workspace/client/requests"), exports);
 __exportStar(require("./conversationalAi/client/requests"), exports);

package/serialization/resources/studio/client/requests/BodyCreatePodcastV1StudioPodcastsPost.d.ts

@@ -17,6 +17,9 @@ export declare namespace BodyCreatePodcastV1StudioPodcastsPost {
         quality_preset?: BodyCreatePodcastV1StudioPodcastsPostQualityPreset.Raw | null;
         duration_scale?: BodyCreatePodcastV1StudioPodcastsPostDurationScale.Raw | null;
         language?: string | null;
+        intro?: string | null;
+        outro?: string | null;
+        instructions_prompt?: string | null;
         highlights?: string[] | null;
         callback_url?: string | null;
     }

package/serialization/resources/studio/client/requests/BodyCreatePodcastV1StudioPodcastsPost.js

@@ -49,6 +49,9 @@ exports.BodyCreatePodcastV1StudioPodcastsPost = core.serialization.object({
     qualityPreset: core.serialization.property("quality_preset", BodyCreatePodcastV1StudioPodcastsPostQualityPreset_1.BodyCreatePodcastV1StudioPodcastsPostQualityPreset.optional()),
     durationScale: core.serialization.property("duration_scale", BodyCreatePodcastV1StudioPodcastsPostDurationScale_1.BodyCreatePodcastV1StudioPodcastsPostDurationScale.optional()),
     language: core.serialization.string().optional(),
+    intro: core.serialization.string().optional(),
+    outro: core.serialization.string().optional(),
+    instructionsPrompt: core.serialization.property("instructions_prompt", core.serialization.string().optional()),
     highlights: core.serialization.list(core.serialization.string()).optional(),
     callbackUrl: core.serialization.property("callback_url", core.serialization.string().optional()),
 });