retell-sdk 1.12.1 → 1.15.6

package/USAGE.md

@@ -0,0 +1,370 @@
+<!-- Start SDK Example Usage [usage] -->
+### Create an outbound phone call
+
+Initiate an outbound phone call.
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+
+    const res = await sdk.createPhoneCall({
+        phoneNumber: {
+            from: "+14159095857",
+            to: "+14159095858",
+        },
+        agentPromptParams: [
+            {
+                name: "username",
+                value: "Adam",
+            },
+        ],
+    });
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+### Retrieve a on-going or finished call
+
+Retrieve details of a specific call
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+import { GetCallRequest } from "retell-sdk-test/dist/sdk/models/operations";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+    const callId: string = "119c3f8e47135a29e65947eeb34cf12d";
+
+    const res = await sdk.getCall(callId);
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+### List all web or phone calls
+
+Retrieve call details
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+import {
+    CallType,
+    FilterCriteria,
+    ListCallsRequest,
+    SortOrder,
+} from "retell-sdk-test/dist/sdk/models/operations";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+    const filterCriteria: FilterCriteria = {
+        agentId: ["oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD"],
+        callType: [CallType.InboundPhoneCall, CallType.OutboundPhoneCall],
+        beforeStartTimestamp: 1703302407399,
+        afterStartTimestamp: 1703302407300,
+        beforeEndTimestamp: 1703302428899,
+        afterEndTimestamp: 1703302428800,
+    };
+    const sortOrder: SortOrder = SortOrder.Descending;
+    const limit: number = 850344;
+
+    const res = await sdk.listCalls(filterCriteria, sortOrder, limit);
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+### Create a new voice AI agent
+
+Create a new agent
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+
+    const res = await sdk.createAgent({
+        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: "elevenlabs-xxcrwXReTKMHWjqi7Q27",
+        agentName: "Jarvis",
+        enableBeginMessage: true,
+        beginMessage: "Hello there, how can I help you?",
+        enableEndCall: true,
+        enableEndMessage: false,
+        endMessage: "Hope you have a good day, goodbye.",
+    });
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+### Retrieve details of an agent
+
+Retrieve details of a specific agent
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+import { GetAgentRequest } from "retell-sdk-test/dist/sdk/models/operations";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+    const agentId: string = "16b980523634a6dc504898cda492e939";
+
+    const res = await sdk.getAgent(agentId);
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+### List all agents
+
+List all agents
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+
+    const res = await sdk.listAgents();
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+### Update an existing agent
+
+Update an existing agent
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+import { UpdateAgentRequest } from "retell-sdk-test/dist/sdk/models/operations";
+import { AgentNoDefaultNoRequired } from "retell-sdk-test/dist/sdk/models/shared";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+    const agentId: string = "16b980523634a6dc504898cda492e939";
+    const agentNoDefaultNoRequired: AgentNoDefaultNoRequired = {
+        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: "elevenlabs-xxcrwXReTKMHWjqi7Q27",
+        agentName: "Jarvis",
+        enableBeginMessage: true,
+        beginMessage: "Hello there, how can I help you.",
+        enableEndCall: true,
+        enableEndMessage: false,
+        endMessage: "Hope you have a good day, goodbye.",
+    };
+
+    const res = await sdk.updateAgent(agentId, agentNoDefaultNoRequired);
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+### Delete an existing agent
+
+Delete an existing agent
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+import { DeleteAgentRequest } from "retell-sdk-test/dist/sdk/models/operations";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+    const agentId: string = "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD";
+
+    const res = await sdk.deleteAgent(agentId);
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+### Create a new phone number
+
+Create a new phone number
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+
+    const res = await sdk.createPhoneNumber({
+        agentId: "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
+        areaCode: 415,
+    });
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+### Retrieve info about a specific number
+
+Retrieve info about a specific number
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+import { GetPhoneNumberRequest } from "retell-sdk-test/dist/sdk/models/operations";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+    const phoneNumber: string = "+14159095857";
+
+    const res = await sdk.getPhoneNumber(phoneNumber);
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+### List all purchased and active phone numbers
+
+List all purchased and active phone numbers
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+
+    const res = await sdk.listPhoneNumbers();
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+### Update an existing phone number
+
+Update an existing phone number
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+import {
+    UpdatePhoneAgentRequest,
+    UpdatePhoneAgentRequestBody,
+} from "retell-sdk-test/dist/sdk/models/operations";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+    const phoneNumber: string = "+14159095857";
+    const requestBody: UpdatePhoneAgentRequestBody = {
+        agentId: "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
+    };
+
+    const res = await sdk.updatePhoneAgent(phoneNumber, requestBody);
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+### Delete a specific phone number
+
+Delete a specific phone number
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+import { DeletePhoneNumberRequest } from "retell-sdk-test/dist/sdk/models/operations";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+    const phoneNumber: string = "string";
+
+    const res = await sdk.deletePhoneNumber(phoneNumber);
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+<!-- End SDK Example Usage [usage] -->

package/files.gen

@@ -0,0 +1,151 @@
+src/sdk/sdk.ts
+.eslintrc.yml
+jest.config.js
+package-lock.json
+package.json
+src/index.ts
+src/internal/utils/contenttype.ts
+src/internal/utils/headers.ts
+src/internal/utils/index.ts
+src/internal/utils/pathparams.ts
+src/internal/utils/queryparams.ts
+src/internal/utils/requestbody.ts
+src/internal/utils/retries.ts
+src/internal/utils/security.ts
+src/internal/utils/utils.ts
+src/sdk/index.ts
+src/sdk/models/errors/sdkerror.ts
+src/sdk/types/index.ts
+src/sdk/types/rfcdate.ts
+tsconfig.json
+src/sdk/models/operations/createphonecall.ts
+src/sdk/models/operations/getcall.ts
+src/sdk/models/operations/listcalls.ts
+src/sdk/models/operations/createagent.ts
+src/sdk/models/operations/getagent.ts
+src/sdk/models/operations/listagents.ts
+src/sdk/models/operations/updateagent.ts
+src/sdk/models/operations/deleteagent.ts
+src/sdk/models/operations/createphonenumber.ts
+src/sdk/models/operations/getphonenumber.ts
+src/sdk/models/operations/listphonenumbers.ts
+src/sdk/models/operations/updatephoneagent.ts
+src/sdk/models/operations/deletephonenumber.ts
+src/sdk/models/shared/agentpromptparams.ts
+src/sdk/models/shared/callphonenumber.ts
+src/sdk/models/shared/calldetail.ts
+src/sdk/models/shared/agent.ts
+src/sdk/models/shared/agentnodefaultnorequired.ts
+src/sdk/models/shared/phonenumber.ts
+src/sdk/models/shared/security.ts
+src/sdk/models/errors/createphonecall.ts
+src/sdk/models/errors/getcall.ts
+src/sdk/models/errors/listcalls.ts
+src/sdk/models/errors/createagent.ts
+src/sdk/models/errors/getagent.ts
+src/sdk/models/errors/listagents.ts
+src/sdk/models/errors/updateagent.ts
+src/sdk/models/errors/deleteagent.ts
+src/sdk/models/errors/createphonenumber.ts
+src/sdk/models/errors/getphonenumber.ts
+src/sdk/models/errors/listphonenumbers.ts
+src/sdk/models/errors/updatephoneagent.ts
+src/sdk/models/errors/deletephonenumber.ts
+src/sdk/models/errors/index.ts
+src/sdk/models/operations/index.ts
+src/sdk/models/shared/index.ts
+docs/sdk/models/operations/phonenumber.md
+docs/sdk/models/operations/createphonecallrequestbody.md
+docs/sdk/models/operations/createphonecallcalltype.md
+docs/sdk/models/operations/callstatus.md
+docs/sdk/models/operations/createphonecallresponsebody.md
+docs/sdk/models/operations/createphonecallresponse.md
+docs/sdk/models/operations/getcallrequest.md
+docs/sdk/models/operations/getcallresponse.md
+docs/sdk/models/operations/calltype.md
+docs/sdk/models/operations/filtercriteria.md
+docs/sdk/models/operations/sortorder.md
+docs/sdk/models/operations/listcallsrequest.md
+docs/sdk/models/operations/listcallsresponse.md
+docs/sdk/models/operations/createagentrequestbody.md
+docs/sdk/models/operations/createagentresponse.md
+docs/sdk/models/operations/getagentrequest.md
+docs/sdk/models/operations/getagentresponse.md
+docs/sdk/models/operations/listagentsresponse.md
+docs/sdk/models/operations/updateagentrequest.md
+docs/sdk/models/operations/updateagentresponse.md
+docs/sdk/models/operations/deleteagentrequest.md
+docs/sdk/models/operations/deleteagentresponse.md
+docs/sdk/models/operations/createphonenumberrequestbody.md
+docs/sdk/models/operations/createphonenumberresponse.md
+docs/sdk/models/operations/getphonenumberrequest.md
+docs/sdk/models/operations/getphonenumberresponse.md
+docs/sdk/models/operations/listphonenumbersresponse.md
+docs/sdk/models/operations/updatephoneagentrequestbody.md
+docs/sdk/models/operations/updatephoneagentrequest.md
+docs/sdk/models/operations/updatephoneagentresponse.md
+docs/sdk/models/operations/deletephonenumberrequest.md
+docs/sdk/models/operations/deletephonenumberresponse.md
+docs/sdk/models/shared/agentpromptparams.md
+docs/sdk/models/shared/callphonenumber.md
+docs/sdk/models/shared/calltype.md
+docs/sdk/models/shared/callstatus.md
+docs/sdk/models/shared/calldetail.md
+docs/sdk/models/shared/agent.md
+docs/sdk/models/shared/agentnodefaultnorequired.md
+docs/sdk/models/shared/phonenumber.md
+docs/sdk/models/shared/security.md
+docs/sdk/models/errors/createphonecallresponse500responsebody.md
+docs/sdk/models/errors/createphonecallresponse429responsebody.md
+docs/sdk/models/errors/createphonecallresponse422responsebody.md
+docs/sdk/models/errors/createphonecallresponse402responsebody.md
+docs/sdk/models/errors/createphonecallresponseresponsebody.md
+docs/sdk/models/errors/createphonecallresponsebody.md
+docs/sdk/models/errors/getcallresponse500responsebody.md
+docs/sdk/models/errors/getcallresponse422responsebody.md
+docs/sdk/models/errors/getcallresponseresponsebody.md
+docs/sdk/models/errors/getcallresponsebody.md
+docs/sdk/models/errors/listcallsresponse500responsebody.md
+docs/sdk/models/errors/listcallsresponseresponsebody.md
+docs/sdk/models/errors/listcallsresponsebody.md
+docs/sdk/models/errors/createagentresponse500responsebody.md
+docs/sdk/models/errors/createagentresponse422responsebody.md
+docs/sdk/models/errors/createagentresponseresponsebody.md
+docs/sdk/models/errors/createagentresponsebody.md
+docs/sdk/models/errors/getagentresponse500responsebody.md
+docs/sdk/models/errors/getagentresponse422responsebody.md
+docs/sdk/models/errors/getagentresponseresponsebody.md
+docs/sdk/models/errors/getagentresponsebody.md
+docs/sdk/models/errors/listagentsresponseresponsebody.md
+docs/sdk/models/errors/listagentsresponsebody.md
+docs/sdk/models/errors/updateagentresponse500responsebody.md
+docs/sdk/models/errors/updateagentresponse422responsebody.md
+docs/sdk/models/errors/updateagentresponseresponsebody.md
+docs/sdk/models/errors/updateagentresponsebody.md
+docs/sdk/models/errors/deleteagentresponse500responsebody.md
+docs/sdk/models/errors/deleteagentresponse422responsebody.md
+docs/sdk/models/errors/deleteagentresponseresponsebody.md
+docs/sdk/models/errors/deleteagentresponsebody.md
+docs/sdk/models/errors/createphonenumberresponse500responsebody.md
+docs/sdk/models/errors/createphonenumberresponse422responsebody.md
+docs/sdk/models/errors/createphonenumberresponse402responsebody.md
+docs/sdk/models/errors/createphonenumberresponseresponsebody.md
+docs/sdk/models/errors/createphonenumberresponsebody.md
+docs/sdk/models/errors/getphonenumberresponse500responsebody.md
+docs/sdk/models/errors/getphonenumberresponse422responsebody.md
+docs/sdk/models/errors/getphonenumberresponseresponsebody.md
+docs/sdk/models/errors/getphonenumberresponsebody.md
+docs/sdk/models/errors/listphonenumbersresponse500responsebody.md
+docs/sdk/models/errors/listphonenumbersresponseresponsebody.md
+docs/sdk/models/errors/listphonenumbersresponsebody.md
+docs/sdk/models/errors/updatephoneagentresponse500responsebody.md
+docs/sdk/models/errors/updatephoneagentresponse422responsebody.md
+docs/sdk/models/errors/updatephoneagentresponseresponsebody.md
+docs/sdk/models/errors/updatephoneagentresponsebody.md
+docs/sdk/models/errors/deletephonenumberresponse500responsebody.md
+docs/sdk/models/errors/deletephonenumberresponse422responsebody.md
+docs/sdk/models/errors/deletephonenumberresponseresponsebody.md
+docs/sdk/models/errors/deletephonenumberresponsebody.md
+docs/sdks/retellclient/README.md
+USAGE.md
+.gitattributes

package/jest.config 2.js

@@ -0,0 +1,8 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testPathIgnorePatterns: [
+    "<rootDir>/__tests__/helpers.ts",
+    "<rootDir>/__tests__/common_helpers.ts",
+  ],
+};

package/jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testPathIgnorePatterns: [
+    "<rootDir>/__tests__/helpers.ts",
+    "<rootDir>/__tests__/common_helpers.ts",
+  ],
+};

package/package 2.json

@@ -0,0 +1,36 @@
+{
+  "name": "retell-sdk-test",
+  "version": "1.12.1",
+  "author": "Retell",
+  "scripts": {
+    "prepare": "tsc --build",
+    "check:tsc": "tsc --noEmit --skipLibCheck",
+    "check:eslint": "eslint --max-warnings=0 src",
+    "check": "npm run check:tsc && npm run check:eslint"
+  },
+  "dependencies": {
+    "axios": "^1.1.3",
+    "jsonpath": "^1.1.1",
+    "class-transformer": "^0.5.1",
+    "form-data": "^4.0.0",
+    "reflect-metadata": "^0.1.13"
+  },
+  "devDependencies": {
+    "@types/jsonpath": "^0.2.0",
+    "@types/node": "^18.11.5",
+    "typescript": "^4.8.4",
+    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/parser": "^5.56.0",
+    "eslint": "^8.36.0"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist",
+    "docs",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "speakeasy-sdks/retell-typescript/"
+  }
+}