retell-sdk 1.15.15 → 1.15.17

package/README.md

@@ -2,8 +2,20 @@
 
 <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
 
@@ -613,589 +625,6 @@ run();
 ```
 <!-- End Authentication [security] -->
 
-
-
-<!-- Start SDK Installation -->
-## SDK Installation
-
-### NPM
-
-```bash
-npm add retell-sdk
-```
-
-### Yarn
-
-```bash
-yarn add retell-sdk
-```
-<!-- End SDK Installation -->
-
-
-
-## SDK Example Usage
-<!-- Start SDK Example Usage -->
-### Create a new voice AI agent
-
-Create a new agent
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-
-    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: "elevenlabs-xxcrwXReTKMHWjqi7Q27",
-    });
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-### Create an outbound phone call
-
-Initiate an outbound phone call.
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-
-    const res = await sdk.createPhoneCall({
-        agentPromptParams: [
-            {
-                name: "username",
-                value: "Adam",
-            },
-        ],
-        phoneNumber: {
-            from: "+14159095857",
-            to: "+14159095858",
-        },
-    });
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-### Create a new phone number
-
-Create a new phone number
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-
-    const res = await sdk.createPhoneNumber({
-        agentId: "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
-        areaCode: 415,
-    });
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-### Delete an existing agent
-
-Delete an existing agent
-
-```typescript
-import { RetellClient } from "retell-sdk";
-import { DeleteAgentRequest } from "retell-sdk/dist/models/operations";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-    const agentId: string = "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD";
-
-    const res = await sdk.deleteAgent(agentId);
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-### Delete a specific phone number
-
-Delete a specific phone number
-
-```typescript
-import { RetellClient } from "retell-sdk";
-import { DeletePhoneNumberRequest } from "retell-sdk/dist/models/operations";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-    const phoneNumber: string = "string";
-
-    const res = await sdk.deletePhoneNumber(phoneNumber);
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-### Retrieve details of an agent
-
-Retrieve details of a specific agent
-
-```typescript
-import { RetellClient } from "retell-sdk";
-import { GetAgentRequest } from "retell-sdk/dist/models/operations";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-    const agentId: string = "16b980523634a6dc504898cda492e939";
-
-    const res = await sdk.getAgent(agentId);
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-### Retrieve a on-going or finished call
-
-Retrieve details of a specific call
-
-```typescript
-import { RetellClient } from "retell-sdk";
-import { GetCallRequest } from "retell-sdk/dist/models/operations";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-    const callId: string = "119c3f8e47135a29e65947eeb34cf12d";
-
-    const res = await sdk.getCall(callId);
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-### Retrieve info about a specific number
-
-Retrieve info about a specific number
-
-```typescript
-import { RetellClient } from "retell-sdk";
-import { GetPhoneNumberRequest } from "retell-sdk/dist/models/operations";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-    const phoneNumber: string = "+14159095857";
-
-    const res = await sdk.getPhoneNumber(phoneNumber);
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-### List all agents
-
-List all agents
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-
-    const res = await sdk.listAgents();
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-### List all web or phone calls
-
-Retrieve call details
-
-```typescript
-import { RetellClient } from "retell-sdk";
-import {
-    CallType,
-    FilterCriteria,
-    ListCallsRequest,
-    SortOrder,
-} from "retell-sdk/dist/models/operations";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-    const filterCriteria: FilterCriteria = {
-        afterEndTimestamp: 1703302428800,
-        afterStartTimestamp: 1703302407300,
-        agentId: ["oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD"],
-        beforeEndTimestamp: 1703302428899,
-        beforeStartTimestamp: 1703302407399,
-        callType: [CallType.InboundPhoneCall, CallType.OutboundPhoneCall],
-    };
-    const limit: number = 666195;
-    const sortOrder: SortOrder = SortOrder.Descending;
-
-    const res = await sdk.listCalls(filterCriteria, limit, sortOrder);
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-### List all purchased and active phone numbers
-
-List all purchased and active phone numbers
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-
-    const res = await sdk.listPhoneNumbers();
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-### Update an existing agent
-
-Update an existing agent
-
-```typescript
-import { RetellClient } from "retell-sdk";
-import { AgentNoDefaultNoRequired } from "retell-sdk/dist/models/components";
-import { UpdateAgentRequest } from "retell-sdk/dist/models/operations";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-    const agentNoDefaultNoRequired: 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: "elevenlabs-xxcrwXReTKMHWjqi7Q27",
-    };
-    const agentId: string = "16b980523634a6dc504898cda492e939";
-
-    const res = await sdk.updateAgent(agentNoDefaultNoRequired, agentId);
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-### Update an existing phone number
-
-Update an existing phone number
-
-```typescript
-import { RetellClient } from "retell-sdk";
-import {
-    UpdatePhoneAgentRequest,
-    UpdatePhoneAgentRequestBody,
-} from "retell-sdk/dist/models/operations";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-    const requestBody: UpdatePhoneAgentRequestBody = {
-        agentId: "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
-    };
-    const phoneNumber: string = "+14159095857";
-
-    const res = await sdk.updatePhoneAgent(requestBody, phoneNumber);
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-<!-- End SDK Example Usage -->
-
-
-
-<!-- Start SDK Available Operations -->
-## Available Resources and Operations
-
-### [RetellClient SDK](docs/sdks/retellclient/README.md)
-
-* [createAgent](docs/sdks/retellclient/README.md#createagent) - Create a new agent
-* [createPhoneCall](docs/sdks/retellclient/README.md#createphonecall) - Initiate an outbound phone call.
-* [createPhoneNumber](docs/sdks/retellclient/README.md#createphonenumber) - Create a new phone number
-* [deleteAgent](docs/sdks/retellclient/README.md#deleteagent) - Delete an existing agent
-* [deletePhoneNumber](docs/sdks/retellclient/README.md#deletephonenumber) - Delete a specific phone number
-* [getAgent](docs/sdks/retellclient/README.md#getagent) - Retrieve details of a specific agent
-* [getCall](docs/sdks/retellclient/README.md#getcall) - Retrieve details of a specific call
-* [getPhoneNumber](docs/sdks/retellclient/README.md#getphonenumber) - Retrieve info about a specific number
-* [listAgents](docs/sdks/retellclient/README.md#listagents) - List all agents
-* [listCalls](docs/sdks/retellclient/README.md#listcalls) - Retrieve call details
-* [listPhoneNumbers](docs/sdks/retellclient/README.md#listphonenumbers) - List all purchased and active phone numbers
-* [updateAgent](docs/sdks/retellclient/README.md#updateagent) - Update an existing agent
-* [updatePhoneAgent](docs/sdks/retellclient/README.md#updatephoneagent) - Update an existing phone number
-<!-- End SDK Available Operations -->
-
-
-
-<!-- Start Error Handling -->
-## 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.CreateAgentResponseBody            | 400                                       | application/json                          |
-| errors.CreateAgentResponseResponseBody    | 401                                       | application/json                          |
-| errors.CreateAgentResponse422ResponseBody | 422                                       | application/json                          |
-| errors.CreateAgentResponse500ResponseBody | 500                                       | application/json                          |
-| errors.SDKError                           | 400-600                                   | */*                                       |
-
-Example
-
-```typescript
-import { RetellClient } from "retell-sdk";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-
-    let res;
-    try {
-        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: "elevenlabs-xxcrwXReTKMHWjqi7Q27",
-        });
-    } catch (e) {
-        if (e instanceof errors.CreateAgentResponseBody) {
-            console.error(e); // handle exception
-        } else if (e instanceof errors.CreateAgentResponseResponseBody) {
-            console.error(e); // handle exception
-        } else if (e instanceof errors.CreateAgentResponse422ResponseBody) {
-            console.error(e); // handle exception
-        } else if (e instanceof errors.CreateAgentResponse500ResponseBody) {
-            console.error(e); // handle exception
-        } else if (e instanceof errors.SDKError) {
-            console.error(e); // handle exception
-        }
-    }
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-<!-- End Error Handling -->
-
-
-
-<!-- Start Server Selection -->
-## 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";
-
-(async () => {
-    const sdk = new RetellClient({
-        serverIdx: 0,
-        apiKey: "",
-    });
-
-    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: "elevenlabs-xxcrwXReTKMHWjqi7Q27",
-    });
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-
-
-### 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";
-
-(async () => {
-    const sdk = new RetellClient({
-        serverURL: "https://api.re-tell.ai",
-        apiKey: "",
-    });
-
-    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: "elevenlabs-xxcrwXReTKMHWjqi7Q27",
-    });
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-<!-- End Server Selection -->
-
-
-
-<!-- Start Custom 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
-from retell-sdk import RetellClient;
-import axios;
-
-const httpClient = axios.create({
-    headers: {'x-custom-header': 'someValue'}
-})
-
-const sdk = new RetellClient({defaultClient: httpClient});
-```
-<!-- End Custom HTTP Client -->
-
-
-
-<!-- Start Authentication -->
-## 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";
-
-(async () => {
-    const sdk = new RetellClient({
-        apiKey: "",
-    });
-
-    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: "elevenlabs-xxcrwXReTKMHWjqi7Q27",
-    });
-
-    if (res.statusCode == 200) {
-        // handle response
-    }
-})();
-
-```
-<!-- End Authentication -->
-
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 # Development

package/dist/sdk/sdk.d.ts

@@ -1,7 +1,10 @@
+/// <reference types="node" />
+import { WebSocket } from "undici-types";
 import * as utils from "../internal/utils";
 import * as components from "../models/components";
 import * as operations from "../models/operations";
 import { AxiosInstance, AxiosRequestConfig } from "axios";
+import { EventEmitter } from "events";
 /**
  * Contains the list of servers available to the SDK
  */
@@ -37,10 +40,22 @@ export declare class SDKConfiguration {
     openapiDocVersion: string;
     sdkVersion: string;
     genVersion: string;
-    userAgent: string;
     retryConfig?: utils.RetryConfig;
     constructor(init?: Partial<SDKConfiguration>);
 }
+interface PromptParam {
+    name: string;
+    value: string;
+}
+export declare class LiveClient extends EventEmitter {
+    ws: WebSocket;
+    constructor(apiKey: string, agentId: string, sampleRate: number, agentPromptParams: PromptParam[], baseEndpoint: string);
+    waitForReady(): Promise<void>;
+    send(audio: Uint8Array): void;
+    close(): void;
+}
+export declare function convertPCM16ToFloat32(array: Uint8Array): Float32Array;
+export declare function convertFloat32ToPCM16(array: Float32Array): Uint8Array;
 export declare class RetellClient {
     private sdkConfiguration;
     constructor(props?: SDKProps);
@@ -97,3 +112,4 @@ export declare class RetellClient {
      */
     updatePhoneAgent(requestBody: operations.UpdatePhoneAgentRequestBody, phoneNumber: string, config?: AxiosRequestConfig): Promise<operations.UpdatePhoneAgentResponse>;
 }
+export {};