retell-sdk 2.2.1 → 2.2.3

package/README.md

@@ -6,442 +6,12 @@
     </a>
 </div>
 
-<!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-### NPM
-
 ```bash
-npm i retell-sdk
-```
-
-<!-- End SDK Installation [installation] -->
-
-<!-- Start SDK Example Usage [usage] -->
-## SDK Example Usage
-
-### Create a new voice AI agent
-
-Create a new agent
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const res = await sdk.createAgent({
-        agentName: "Jarvis",
-        beginMessage: "Hello there, how can I help you?",
-        enableBeginMessage: true,
-        enableEndCall: true,
-        enableEndMessage: false,
-        endMessage: "Hope you have a good day, goodbye.",
-        prompt: "You are a marketing assistant. You help come up with creative content ideas and content like marketing emails, blog posts, tweets, ad copy and product descriptions. You respond concisely, with filler words in it.",
-        voiceId: "11labs-Ryan",
-    });
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
-```
-
-### Create an outbound phone call
-
-Initiate an outbound phone call.
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const res = await sdk.createPhoneCall({
-        agentPromptParams: [
-            {
-                name: "username",
-                value: "Adam",
-            },
-        ],
-        phoneNumber: {
-            from: "+14159095857",
-            to: "+14159095858",
-        },
-    });
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
-```
-
-### Create a web call
-
-Initiate a web call.
-
-```typescript
-import { RetellClient } from "retell-sdk";
-// Import websocket if not running in browser
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const liveClient = await sdk.createWebCall({
-        agentId: "YOUR_AGENT_ID",
-        sampleRate: 24000,
-        agentPromptParams: [
-            {
-                name: "username",
-                value: "Adam",
-            },
-        ],
-    });
-
-    liveClient.on("audio", (audio: Uint8Array) => {
-        // Handle audio here
-    });
-    liveClient.on("close", (event) => {
-        // Handle close here
-        console.log(event.code);
-    });
-}
-
-run();
-
-```
-
-### Create a new phone number
-
-Create a new phone number
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const res = await sdk.createPhoneNumber({
-        agentId: "YOUR_AGENT_ID",
-        areaCode: 415,
-    });
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
-```
-
-### Delete an existing agent
-
-Delete an existing agent
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const agentId = "YOUR_AGENT_ID";
-
-    const res = await sdk.deleteAgent(agentId);
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
-```
-
-### Delete a specific phone number
-
-Delete a specific phone number
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const phoneNumber = "string";
-
-    const res = await sdk.deletePhoneNumber(phoneNumber);
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
-```
-
-### Retrieve details of an agent
-
-Retrieve details of a specific agent
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const agentId = "16b980523634a6dc504898cda492e939";
-
-    const res = await sdk.getAgent(agentId);
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
-```
-
-### Retrieve a on-going or finished call
-
-Retrieve details of a specific call
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const callId = "119c3f8e47135a29e65947eeb34cf12d";
-
-    const res = await sdk.getCall(callId);
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
-```
-
-### Retrieve info about a specific number
-
-Retrieve info about a specific number
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const phoneNumber = "+14159095857";
-
-    const res = await sdk.getPhoneNumber(phoneNumber);
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
-```
-
-### List all agents
-
-List all agents
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const res = await sdk.listAgents();
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
-```
-
-### List all web or phone calls
-
-Retrieve call details
-
-```typescript
-import { RetellClient } from "retell-sdk";
-import {} from "retell-sdk/models";
-import { SortOrder } from "retell-sdk/models/operations";
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const filterCriteria = {
-        afterEndTimestamp: 1703302428800,
-        afterStartTimestamp: 1703302407300,
-        agentId: ["YOUR_AGENT_ID"],
-        beforeEndTimestamp: 1703302428899,
-        beforeStartTimestamp: 1703302407399,
-        callType: [CallType.InboundPhoneCall, CallType.OutboundPhoneCall],
-    };
-    const limit = 666195;
-    const sortOrder = SortOrder.Descending;
-
-    const res = await sdk.listCalls(filterCriteria, limit, sortOrder);
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
+npm install retell-sdk
 ```
 
-### List all purchased and active phone numbers
-
-List all purchased and active phone numbers
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const res = await sdk.listPhoneNumbers();
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
-```
-
-### Update an existing agent
-
-Update an existing agent
-
-```typescript
-import { RetellClient } from "retell-sdk";
+## Use SDK
 
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const agentNoDefaultNoRequired = {
-        agentName: "Jarvis",
-        beginMessage: "Hello there, how can I help you.",
-        enableBeginMessage: true,
-        enableEndCall: true,
-        enableEndMessage: false,
-        endMessage: "Hope you have a good day, goodbye.",
-        prompt: "You are a marketing assistant. You help come up with creative content ideas and content like marketing emails, blog posts, tweets, ad copy and product descriptions. You respond concisely, with filler words in it.",
-        voiceId: "11labs-Ryan",
-    };
-    const agentId = "16b980523634a6dc504898cda492e939";
-
-    const res = await sdk.updateAgent(agentNoDefaultNoRequired, agentId);
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
-```
-
-### Update an existing phone number
-
-Update an existing phone number
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-async function run() {
-    const sdk = new RetellClient({
-        apiKey: "YOUR_API_KEY",
-    });
-
-    const requestBody = {
-        agentId: "YOUR_AGENT_ID",
-    };
-    const phoneNumber = "+14159095857";
-
-    const res = await sdk.updatePhoneAgent(requestBody, phoneNumber);
-
-    if (res?.statusCode !== 200) {
-        throw new Error("Unexpected status code: " + res?.statusCode || "-");
-    }
-
-    // handle response
-}
-
-run();
-
-```
-<!-- End SDK Example Usage [usage] -->
+Check out [Retell AI API Documentation](https://docs.re-tell.ai/guide/sdk) for using this SDK.

package/example.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=example.d.ts.map

package/example.d.ts.map

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

package/example.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_1 = require("./sdk");
+// import { CallType } from "./models/components";
+// import { CallType, SortOrder } from "./models/operations";
+const retell = new sdk_1.RetellClient({
+    // Find the key in dashboard
+    apiKey: "765a6620-affa-4137-a3dc-cae97cfc65cd",
+    serverURL: "http://localhost:3002"
+});
+async function main() {
+    // const res = await retell.createAgent({
+    //     agentName: "testfunction",
+    //     llmSetting: {
+    //         provider: "retell",
+    //         prompt: "test prompt",
+    //     },
+    //     voiceId: "11labs-Ryan",
+    //     interactionSetting: {
+    //         enableBeginMessage: true,
+    //         beginMessage: "Hello there, how can I help you?",
+    //         enableEndCall: true,
+    //         enableEndMessage: false,
+    //         endMessage: "Hope you have a good day, goodbye.",
+    //     },
+    //     functions: [{
+    //       url: "http://localhost:3002/get-weather",
+    //       description: "Get the current weather in a given location.",
+    //       name: "get_current_weather",
+    //       parameters: {
+    //         type: "object",
+    //         properties: {
+    //           location: {
+    //             type: "string",
+    //             description: "The city and state, e.g. San Francisco, CA"
+    //           },
+    //           unit: {
+    //             type: "string",
+    //             enum: ["celsius", "fahrenheit"]
+    //           }
+    //         },
+    //         required: ["location"]
+    //       }
+    //     }]
+    // });
+    // console.log(res.agent);
+    const res = await retell.getAgent("e2c8d51a88b935f3ca09170d9c248e8e");
+    console.log(res.agent);
+    // const res = await retell.listAgents();
+    // console.log(res.agents);
+    // const agent = await retell.updateAgent({
+    //     agentName: "new name",
+    //     interactionSetting: {
+    //         enableEndCall: true,
+    //         endMessage: "bye"
+    //       },
+    // }, '5790c196cd6b7728de819c3de444d3b5');
+    // console.log(agent.agent);
+    // const res = await retell.deleteAgent('5790c196cd6b7728de819c3de444d3b5');
+    // console.log(res.statusCode)
+    // const res = await retell.createPhoneNumber({
+    //     agentId: "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
+    //     areaCode: 415,
+    // });
+    // res.phoneNumber
+    // const res = await retell.deletePhoneNumber("+14159095857");
+    // console.log(res.statusCode)
+    // const res = await retell.getCall("e208e53fe334b42a21bdf065f5b121e1");
+    // console.log(res.callDetail);
+    // const newPhoneNumber = await retell.createPhoneNumber({
+    //     agentId: "5790c196cd6b7728de819c3de444d3b5", // Required
+    //     // areaCode: 415, // Optional, default is 213
+    //   });
+    //   console.log("phone number: ", newPhoneNumber);
+    // const ongoingCall = await retell.createPhoneCall({
+    //     phoneNumber: {
+    //       from: "+12138954697", // Phone number you created
+    //       to: "+12137134981",
+    //     },
+    //   });
+    //   console.log("phone call: ", ongoingCall);
+    // const filterCriteria = {
+    //     // afterEndTimestamp: 1703302428800,
+    //     // afterStartTimestamp: 1703302407300,
+    //     // agentId: ["oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD"],
+    //     // beforeEndTimestamp: 1703302428899,
+    //     // beforeStartTimestamp: 1703302407399,
+    //     callType: [CallType.InboundPhoneCall, CallType.OutboundPhoneCall],
+    // };
+    // const limit = 1;
+    // const sortOrder = SortOrder.Descending;
+    // const res = await retell.listCalls(filterCriteria, limit, sortOrder);
+    // console.log(res)
+}
+main();
+//# sourceMappingURL=example.js.map

package/example.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"example.js","sourceRoot":"","sources":["src/example.ts"],"names":[],"mappings":";;AAAA,+BAAqC;AACrC,kDAAkD;AAClD,6DAA6D;AAE7D,MAAM,MAAM,GAAG,IAAI,kBAAY,CAAC;IAC5B,4BAA4B;IAC5B,MAAM,EAAE,sCAAsC;IAC9C,SAAS,EAAE,uBAAuB;CACnC,CAAC,CAAC;AAEL,KAAK,UAAU,IAAI;IACf,yCAAyC;IACzC,iCAAiC;IACjC,oBAAoB;IACpB,8BAA8B;IAC9B,iCAAiC;IACjC,SAAS;IACT,8BAA8B;IAC9B,4BAA4B;IAC5B,oCAAoC;IACpC,4DAA4D;IAC5D,+BAA+B;IAC/B,mCAAmC;IACnC,4DAA4D;IAC5D,SAAS;IACT,oBAAoB;IACpB,kDAAkD;IAClD,qEAAqE;IACrE,qCAAqC;IACrC,sBAAsB;IACtB,0BAA0B;IAC1B,wBAAwB;IACxB,wBAAwB;IACxB,8BAA8B;IAC9B,wEAAwE;IACxE,eAAe;IACf,oBAAoB;IACpB,8BAA8B;IAC9B,8CAA8C;IAC9C,cAAc;IACd,aAAa;IACb,iCAAiC;IACjC,UAAU;IACV,SAAS;IACT,MAAM;IACN,0BAA0B;IAE1B,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,kCAAkC,CAAC,CAAC;IACtE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACvB,yCAAyC;IACzC,2BAA2B;IAC3B,2CAA2C;IAC3C,6BAA6B;IAC7B,4BAA4B;IAC5B,+BAA+B;IAC/B,4BAA4B;IAC5B,WAAW;IACX,0CAA0C;IAC1C,4BAA4B;IAC5B,4EAA4E;IAC5E,8BAA8B;IAC9B,+CAA+C;IAC/C,mDAAmD;IACnD,qBAAqB;IACrB,MAAM;IACN,kBAAkB;IAClB,8DAA8D;IAC9D,8BAA8B;IAE9B,wEAAwE;IAExE,+BAA+B;IAE/B,0DAA0D;IAC1D,+DAA+D;IAC/D,oDAAoD;IACpD,QAAQ;IACR,mDAAmD;IAEnD,qDAAqD;IACrD,qBAAqB;IACrB,0DAA0D;IAC1D,4BAA4B;IAC5B,SAAS;IACT,QAAQ;IACR,8CAA8C;IAC9C,2BAA2B;IAC3B,2CAA2C;IAC3C,6CAA6C;IAC7C,wDAAwD;IACxD,4CAA4C;IAC5C,8CAA8C;IAC9C,yEAAyE;IACzE,KAAK;IACL,mBAAmB;IACnB,0CAA0C;IAE1C,wEAAwE;IACxE,mBAAmB;AACvB,CAAC;AAED,IAAI,EAAE,CAAA"}