retell-sdk 1.1.0 → 1.12.1

package/README.md

@@ -0,0 +1,659 @@
+# retell-sdk-test
+
+<div align="left">
+    <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
+    <a href="https://opensource.org/licenses/MIT">
+        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
+    </a>
+</div>
+
+
+## 🏗 **Welcome to your new SDK!** 🏗
+
+It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
+- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)
+- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
+- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)
+- [ ] ✨ When ready to productionize, delete this section from the README
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+### NPM
+
+```bash
+npm add <UNSET>
+```
+
+### Yarn
+
+```bash
+yarn add <UNSET>
+```
+<!-- End SDK Installation [installation] -->
+
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example 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] -->
+
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+### [RetellClient SDK](docs/sdks/retellclient/README.md)
+
+* [createPhoneCall](docs/sdks/retellclient/README.md#createphonecall) - Initiate an outbound phone call.
+* [getCall](docs/sdks/retellclient/README.md#getcall) - Retrieve details of a specific call
+* [listCalls](docs/sdks/retellclient/README.md#listcalls) - Retrieve call details
+* [createAgent](docs/sdks/retellclient/README.md#createagent) - Create a new agent
+* [getAgent](docs/sdks/retellclient/README.md#getagent) - Retrieve details of a specific agent
+* [listAgents](docs/sdks/retellclient/README.md#listagents) - List all agents
+* [updateAgent](docs/sdks/retellclient/README.md#updateagent) - Update an existing agent
+* [deleteAgent](docs/sdks/retellclient/README.md#deleteagent) - Delete an existing agent
+* [createPhoneNumber](docs/sdks/retellclient/README.md#createphonenumber) - Create a new phone number
+* [getPhoneNumber](docs/sdks/retellclient/README.md#getphonenumber) - Retrieve info about a specific number
+* [listPhoneNumbers](docs/sdks/retellclient/README.md#listphonenumbers) - List all purchased and active phone numbers
+* [updatePhoneAgent](docs/sdks/retellclient/README.md#updatephoneagent) - Update an existing phone number
+* [deletePhoneNumber](docs/sdks/retellclient/README.md#deletephonenumber) - Delete a specific phone number
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Error Handling [errors] -->
+## Error Handling
+
+Handling errors in this SDK should largely match your expectations.  All operations return a response object or throw an error.  If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
+
+| Error Object                                  | Status Code                                   | Content Type                                  |
+| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
+| errors.CreatePhoneCallResponseBody            | 400                                           | application/json                              |
+| errors.CreatePhoneCallResponseResponseBody    | 401                                           | application/json                              |
+| errors.CreatePhoneCallResponse402ResponseBody | 402                                           | application/json                              |
+| errors.CreatePhoneCallResponse422ResponseBody | 422                                           | application/json                              |
+| errors.CreatePhoneCallResponse429ResponseBody | 429                                           | application/json                              |
+| errors.CreatePhoneCallResponse500ResponseBody | 500                                           | application/json                              |
+| errors.SDKError                               | 4xx-5xx                                       | */*                                           |
+
+Example
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+
+async function run() {
+    const sdk = new RetellClient({
+        apiKey: "<YOUR_BEARER_TOKEN_HERE>",
+    });
+
+    let res;
+    try {
+        res = await sdk.createPhoneCall({
+            phoneNumber: {
+                from: "+14159095857",
+                to: "+14159095858",
+            },
+            agentPromptParams: [
+                {
+                    name: "username",
+                    value: "Adam",
+                },
+            ],
+        });
+    } catch (err) {
+        if (err instanceof errors.CreatePhoneCallResponseBody) {
+            console.error(err); // handle exception
+            throw err;
+        } else if (err instanceof errors.CreatePhoneCallResponseResponseBody) {
+            console.error(err); // handle exception
+            throw err;
+        } else if (err instanceof errors.CreatePhoneCallResponse402ResponseBody) {
+            console.error(err); // handle exception
+            throw err;
+        } else if (err instanceof errors.CreatePhoneCallResponse422ResponseBody) {
+            console.error(err); // handle exception
+            throw err;
+        } else if (err instanceof errors.CreatePhoneCallResponse429ResponseBody) {
+            console.error(err); // handle exception
+            throw err;
+        } else if (err instanceof errors.CreatePhoneCallResponse500ResponseBody) {
+            console.error(err); // handle exception
+            throw err;
+        } else if (err instanceof errors.SDKError) {
+            console.error(err); // handle exception
+            throw err;
+        }
+    }
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+<!-- End Error Handling [errors] -->
+
+<!-- Start Server Selection [server] -->
+## Server Selection
+
+### Select Server by Index
+
+You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
+
+| # | Server | Variables |
+| - | ------ | --------- |
+| 0 | `https://api.re-tell.ai` | None |
+
+#### Example
+
+```typescript
+import { RetellClient } from "retell-sdk-test";
+
+async function run() {
+    const sdk = new RetellClient({
+        serverIdx: 0,
+        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();
+
+```
+
+
+### Override Server URL Per-Client
+
+The default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example:
+```typescript
+import { RetellClient } from "retell-sdk-test";
+
+async function run() {
+    const sdk = new RetellClient({
+        serverURL: "https://api.re-tell.ai",
+        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();
+
+```
+<!-- End Server Selection [server] -->
+
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
+
+The Typescript SDK makes API calls using the [axios](https://axios-http.com/docs/intro) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `AxiosInstance` object.
+
+For example, you could specify a header for every request that your sdk makes as follows:
+
+```typescript
+import { retell-sdk-test } from "RetellClient";
+import axios from "axios";
+
+const httpClient = axios.create({
+    headers: {'x-custom-header': 'someValue'}
+})
+
+const sdk = new RetellClient({defaultClient: httpClient});
+```
+<!-- End Custom HTTP Client [http-client] -->
+
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name        | Type        | Scheme      |
+| ----------- | ----------- | ----------- |
+| `apiKey`    | http        | HTTP Bearer |
+
+To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
+```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();
+
+```
+<!-- End Authentication [security] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# Development
+
+## Maturity
+
+This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
+to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
+looking for the latest version.
+
+## Contributions
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
+
+### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

package/dist/index.d.ts

@@ -1,9 +1 @@
-export default class Retell {
-    private apiKey;
-    private ip;
-    constructor(apiKey: string, ip?: string);
-    NewConversation: (options: any) => Promise<any>;
-    CreatAgent: (options: any) => Promise<any>;
-    ListAgents: (options: any) => Promise<void>;
-    ListConversations: (options: any) => Promise<void>;
-}
+export * from "./sdk";