@deepgram/sdk 3.3.5 → 3.4.0

package/dist/module/packages/AbstractRestClient.d.ts

@@ -0,0 +1,105 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Readable } from "stream";
+import type { Fetch, FetchOptions, RequestMethodType } from "../lib/types/Fetch";
+import { AbstractClient } from "./AbstractClient";
+import { DeepgramClientOptions } from "../lib/types";
+/**
+ * An abstract class that extends `AbstractClient` and provides a base implementation for a REST-based API client.
+ * This class handles authentication, error handling, and other common functionality for REST API clients.
+ */
+export declare abstract class AbstractRestClient extends AbstractClient {
+    protected fetch: Fetch;
+    /**
+     * Constructs a new instance of the `AbstractRestClient` class with the provided options.
+     *
+     * @param options - The client options to use for this instance.
+     * @throws {DeepgramError} If the client is being used in a browser and no proxy is provided.
+     */
+    constructor(options: DeepgramClientOptions);
+    /**
+     * Constructs an error message from the provided error object.
+     *
+     * @param err - The error object to extract the error message from.
+     * @returns The constructed error message.
+     */
+    protected _getErrorMessage(err: any): string;
+    /**
+     * Handles an error that occurred during a request.
+     *
+     * @param error - The error that occurred during the request.
+     * @param reject - The rejection function to call with the error.
+     * @returns A Promise that resolves when the error has been handled.
+     */
+    protected _handleError(error: unknown, reject: (reason?: any) => void): Promise<void>;
+    /**
+     * Constructs the options object to be used for a fetch request.
+     *
+     * @param method - The HTTP method to use for the request, such as "GET", "POST", "PUT", "PATCH", or "DELETE".
+     * @param bodyOrOptions - For "POST", "PUT", and "PATCH" requests, the request body as a string, Buffer, or Readable stream. For "GET" and "DELETE" requests, the fetch options to use.
+     * @param options - Additional fetch options to use for the request.
+     * @returns The constructed fetch options object.
+     */
+    protected _getRequestOptions(method: RequestMethodType, bodyOrOptions?: string | Buffer | Readable | FetchOptions, options?: FetchOptions): FetchOptions;
+    /**
+     * Handles an HTTP request using the provided method, URL, and optional request body and options.
+     *
+     * @param method - The HTTP method to use for the request, such as "GET", "POST", "PUT", "PATCH", or "DELETE".
+     * @param url - The URL to send the request to.
+     * @param bodyOrOptions - For "POST", "PUT", and "PATCH" requests, the request body as a string, Buffer, or Readable stream. For "GET" and "DELETE" requests, the fetch options to use.
+     * @param options - Additional fetch options to use for the request.
+     * @returns A Promise that resolves to the Response object for the request.
+     */
+    protected _handleRequest(method: "GET" | "DELETE", url: URL, options?: FetchOptions): Promise<Response>;
+    protected _handleRequest(method: "POST" | "PUT" | "PATCH", url: URL, body: string | Buffer | Readable, options?: FetchOptions): Promise<Response>;
+    /**
+     * Handles an HTTP GET request using the provided URL and optional request options.
+     *
+     * @param url - The URL to send the GET request to.
+     * @param options - Additional fetch options to use for the GET request.
+     * @returns A Promise that resolves to the Response object for the GET request.
+     */
+    protected get(url: URL, options?: FetchOptions): Promise<any>;
+    /**
+     * Handles an HTTP POST request using the provided URL, request body, and optional request options.
+     *
+     * @param url - The URL to send the POST request to.
+     * @param body - The request body as a string, Buffer, or Readable stream.
+     * @param options - Additional fetch options to use for the POST request.
+     * @returns A Promise that resolves to the Response object for the POST request.
+     */
+    protected post(url: URL, body: string | Buffer | Readable, options?: FetchOptions): Promise<any>;
+    /**
+     * Handles an HTTP PUT request using the provided URL, request body, and optional request options.
+     *
+     * @param url - The URL to send the PUT request to.
+     * @param body - The request body as a string, Buffer, or Readable stream.
+     * @param options - Additional fetch options to use for the PUT request.
+     * @returns A Promise that resolves to the Response object for the PUT request.
+     */
+    protected put(url: URL, body: string | Buffer | Readable, options?: FetchOptions): Promise<any>;
+    /**
+     * Handles an HTTP PATCH request using the provided URL, request body, and optional request options.
+     *
+     * @param url - The URL to send the PATCH request to.
+     * @param body - The request body as a string, Buffer, or Readable stream.
+     * @param options - Additional fetch options to use for the PATCH request.
+     * @returns A Promise that resolves to the Response object for the PATCH request.
+     */
+    protected patch(url: URL, body: string | Buffer | Readable, options?: FetchOptions): Promise<any>;
+    /**
+     * Handles an HTTP DELETE request using the provided URL and optional request options.
+     *
+     * @param url - The URL to send the DELETE request to.
+     * @param options - Additional fetch options to use for the DELETE request.
+     * @returns A Promise that resolves to the Response object for the DELETE request.
+     */
+    protected delete(url: URL, options?: FetchOptions): Promise<any>;
+    /**
+     * Determines whether the current instance should proxy requests.
+     * @returns {boolean} true if the current instance should proxy requests; otherwise, false
+     */
+    get proxy(): boolean;
+}
+export { AbstractRestClient as AbstractRestfulClient };
+//# sourceMappingURL=AbstractRestClient.d.ts.map

package/dist/module/packages/AbstractRestClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractRestClient.d.ts","sourceRoot":"","sources":["../../../src/packages/AbstractRestClient.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAIrD;;;GAGG;AACH,8BAAsB,kBAAmB,SAAQ,cAAc;IAC7D,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC;IAEvB;;;;;OAKG;gBACS,OAAO,EAAE,qBAAqB;IAkB1C;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM;IAI5C;;;;;;OAMG;cACa,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI;IAiB3E;;;;;;;OAOG;IACH,SAAS,CAAC,kBAAkB,CAC1B,MAAM,EAAE,iBAAiB,EACzB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,EACzD,OAAO,CAAC,EAAE,YAAY,GACrB,YAAY;IAiBf;;;;;;;;OAQG;cACa,cAAc,CAC5B,MAAM,EAAE,KAAK,GAAG,QAAQ,EACxB,GAAG,EAAE,GAAG,EACR,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,QAAQ,CAAC;cACJ,cAAc,CAC5B,MAAM,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,EAChC,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EAChC,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,QAAQ,CAAC;IAmBpB;;;;;;OAMG;cACa,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;IAInE;;;;;;;OAOG;cACa,IAAI,CAClB,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EAChC,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,GAAG,CAAC;IAIf;;;;;;;OAOG;cACa,GAAG,CACjB,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EAChC,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,GAAG,CAAC;IAIf;;;;;;;OAOG;cACa,KAAK,CACnB,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,EAChC,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,GAAG,CAAC;IAIf;;;;;;OAMG;cACa,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;IAItE;;;OAGG;IACH,IAAI,KAAK,IAAI,OAAO,CAEnB;CACF;AAED,OAAO,EAAE,kBAAkB,IAAI,qBAAqB,EAAE,CAAC"}

package/dist/module/packages/AbstractRestClient.js

@@ -0,0 +1,178 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { DeepgramApiError, DeepgramError, DeepgramUnknownError } from "../lib/errors";
+import { fetchWithAuth, resolveResponse } from "../lib/fetch";
+import { AbstractClient } from "./AbstractClient";
+import { isBrowser } from "../lib/helpers";
+import merge from "deepmerge";
+/**
+ * An abstract class that extends `AbstractClient` and provides a base implementation for a REST-based API client.
+ * This class handles authentication, error handling, and other common functionality for REST API clients.
+ */
+export class AbstractRestClient extends AbstractClient {
+    /**
+     * Constructs a new instance of the `AbstractRestClient` class with the provided options.
+     *
+     * @param options - The client options to use for this instance.
+     * @throws {DeepgramError} If the client is being used in a browser and no proxy is provided.
+     */
+    constructor(options) {
+        super(options);
+        if (isBrowser() && !this.proxy) {
+            throw new DeepgramError("Due to CORS we are unable to support REST-based API calls to our API from the browser. Please consider using a proxy: https://dpgr.am/js-proxy for more information.");
+        }
+        this.fetch = fetchWithAuth(this.key, this.namespaceOptions.fetch.client);
+        if (this.proxy) {
+            this.baseUrl = this.namespaceOptions.fetch.options.proxy.url;
+        }
+        else {
+            this.baseUrl = this.namespaceOptions.fetch.options.url;
+        }
+    }
+    /**
+     * Constructs an error message from the provided error object.
+     *
+     * @param err - The error object to extract the error message from.
+     * @returns The constructed error message.
+     */
+    _getErrorMessage(err) {
+        return err.msg || err.message || err.error_description || err.error || JSON.stringify(err);
+    }
+    /**
+     * Handles an error that occurred during a request.
+     *
+     * @param error - The error that occurred during the request.
+     * @param reject - The rejection function to call with the error.
+     * @returns A Promise that resolves when the error has been handled.
+     */
+    _handleError(error, reject) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const Res = yield resolveResponse();
+            if (error instanceof Res) {
+                error
+                    .json()
+                    .then((err) => {
+                    reject(new DeepgramApiError(this._getErrorMessage(err), error.status || 500));
+                })
+                    .catch((err) => {
+                    reject(new DeepgramUnknownError(this._getErrorMessage(err), err));
+                });
+            }
+            else {
+                reject(new DeepgramUnknownError(this._getErrorMessage(error), error));
+            }
+        });
+    }
+    /**
+     * Constructs the options object to be used for a fetch request.
+     *
+     * @param method - The HTTP method to use for the request, such as "GET", "POST", "PUT", "PATCH", or "DELETE".
+     * @param bodyOrOptions - For "POST", "PUT", and "PATCH" requests, the request body as a string, Buffer, or Readable stream. For "GET" and "DELETE" requests, the fetch options to use.
+     * @param options - Additional fetch options to use for the request.
+     * @returns The constructed fetch options object.
+     */
+    _getRequestOptions(method, bodyOrOptions, options) {
+        let reqOptions = { method };
+        if (method === "GET" || method === "DELETE") {
+            reqOptions = Object.assign(Object.assign({}, reqOptions), bodyOrOptions);
+        }
+        else {
+            reqOptions = Object.assign(Object.assign({ duplex: "half", body: bodyOrOptions }, reqOptions), options);
+        }
+        return merge(this.namespaceOptions.fetch.options, reqOptions, { clone: false });
+    }
+    _handleRequest(method, url, bodyOrOptions, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const fetcher = this.fetch;
+                fetcher(url, this._getRequestOptions(method, bodyOrOptions, options))
+                    .then((result) => {
+                    if (!result.ok)
+                        throw result;
+                    resolve(result);
+                })
+                    .catch((error) => this._handleError(error, reject));
+            });
+        });
+    }
+    /**
+     * Handles an HTTP GET request using the provided URL and optional request options.
+     *
+     * @param url - The URL to send the GET request to.
+     * @param options - Additional fetch options to use for the GET request.
+     * @returns A Promise that resolves to the Response object for the GET request.
+     */
+    get(url, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this._handleRequest("GET", url, options);
+        });
+    }
+    /**
+     * Handles an HTTP POST request using the provided URL, request body, and optional request options.
+     *
+     * @param url - The URL to send the POST request to.
+     * @param body - The request body as a string, Buffer, or Readable stream.
+     * @param options - Additional fetch options to use for the POST request.
+     * @returns A Promise that resolves to the Response object for the POST request.
+     */
+    post(url, body, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this._handleRequest("POST", url, body, options);
+        });
+    }
+    /**
+     * Handles an HTTP PUT request using the provided URL, request body, and optional request options.
+     *
+     * @param url - The URL to send the PUT request to.
+     * @param body - The request body as a string, Buffer, or Readable stream.
+     * @param options - Additional fetch options to use for the PUT request.
+     * @returns A Promise that resolves to the Response object for the PUT request.
+     */
+    put(url, body, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this._handleRequest("PUT", url, body, options);
+        });
+    }
+    /**
+     * Handles an HTTP PATCH request using the provided URL, request body, and optional request options.
+     *
+     * @param url - The URL to send the PATCH request to.
+     * @param body - The request body as a string, Buffer, or Readable stream.
+     * @param options - Additional fetch options to use for the PATCH request.
+     * @returns A Promise that resolves to the Response object for the PATCH request.
+     */
+    patch(url, body, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this._handleRequest("PATCH", url, body, options);
+        });
+    }
+    /**
+     * Handles an HTTP DELETE request using the provided URL and optional request options.
+     *
+     * @param url - The URL to send the DELETE request to.
+     * @param options - Additional fetch options to use for the DELETE request.
+     * @returns A Promise that resolves to the Response object for the DELETE request.
+     */
+    delete(url, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this._handleRequest("DELETE", url, options);
+        });
+    }
+    /**
+     * Determines whether the current instance should proxy requests.
+     * @returns {boolean} true if the current instance should proxy requests; otherwise, false
+     */
+    get proxy() {
+        var _a;
+        return this.key === "proxy" && !!((_a = this.namespaceOptions.fetch.options.proxy) === null || _a === void 0 ? void 0 : _a.url);
+    }
+}
+export { AbstractRestClient as AbstractRestfulClient };
+//# sourceMappingURL=AbstractRestClient.js.map

package/dist/module/packages/AbstractRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractRestClient.js","sourceRoot":"","sources":["../../../src/packages/AbstractRestClient.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAEtF,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE9D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,MAAM,WAAW,CAAC;AAE9B;;;GAGG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,cAAc;IAG7D;;;;;OAKG;IACH,YAAY,OAA8B;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YAC9B,MAAM,IAAI,aAAa,CACrB,sKAAsK,CACvK,CAAC;SACH;QAED,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzE,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,KAAM,CAAC,GAAG,CAAC;SAC/D;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;SACxD;IACH,CAAC;IAED;;;;;OAKG;IACO,gBAAgB,CAAC,GAAQ;QACjC,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,iBAAiB,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;OAMG;IACa,YAAY,CAAC,KAAc,EAAE,MAA8B;;YACzE,MAAM,GAAG,GAAG,MAAM,eAAe,EAAE,CAAC;YAEpC,IAAI,KAAK,YAAY,GAAG,EAAE;gBACxB,KAAK;qBACF,IAAI,EAAE;qBACN,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;oBACZ,MAAM,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC;gBAChF,CAAC,CAAC;qBACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;oBACb,MAAM,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;gBACpE,CAAC,CAAC,CAAC;aACN;iBAAM;gBACL,MAAM,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;aACvE;QACH,CAAC;KAAA;IAED;;;;;;;OAOG;IACO,kBAAkB,CAC1B,MAAyB,EACzB,aAAyD,EACzD,OAAsB;QAEtB,IAAI,UAAU,GAAiB,EAAE,MAAM,EAAE,CAAC;QAE1C,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,QAAQ,EAAE;YAC3C,UAAU,mCAAQ,UAAU,GAAM,aAA8B,CAAE,CAAC;SACpE;aAAM;YACL,UAAU,iCACR,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,aAAyB,IAC5B,UAAU,GACV,OAAO,CACX,CAAC;SACH;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAClF,CAAC;IAsBe,cAAc,CAC5B,MAAyB,EACzB,GAAQ,EACR,aAAyD,EACzD,OAAsB;;YAEtB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC;gBAE3B,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;qBAClE,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;oBACf,IAAI,CAAC,MAAM,CAAC,EAAE;wBAAE,MAAM,MAAM,CAAC;oBAC7B,OAAO,CAAC,MAAM,CAAC,CAAC;gBAClB,CAAC,CAAC;qBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;YACxD,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;;OAMG;IACa,GAAG,CAAC,GAAQ,EAAE,OAAsB;;YAClD,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;KAAA;IAED;;;;;;;OAOG;IACa,IAAI,CAClB,GAAQ,EACR,IAAgC,EAChC,OAAsB;;YAEtB,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACzD,CAAC;KAAA;IAED;;;;;;;OAOG;IACa,GAAG,CACjB,GAAQ,EACR,IAAgC,EAChC,OAAsB;;YAEtB,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACxD,CAAC;KAAA;IAED;;;;;;;OAOG;IACa,KAAK,CACnB,GAAQ,EACR,IAAgC,EAChC,OAAsB;;YAEtB,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC1D,CAAC;KAAA;IAED;;;;;;OAMG;IACa,MAAM,CAAC,GAAQ,EAAE,OAAsB;;YACrD,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;QACrD,CAAC;KAAA;IAED;;;OAGG;IACH,IAAI,KAAK;;QACP,OAAO,IAAI,CAAC,GAAG,KAAK,OAAO,IAAI,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,0CAAE,GAAG,CAAA,CAAC;IAClF,CAAC;CACF;AAED,OAAO,EAAE,kBAAkB,IAAI,qBAAqB,EAAE,CAAC"}

package/dist/module/packages/ListenClient.d.ts

@@ -1,9 +1,26 @@
 import { AbstractClient } from "./AbstractClient";
-import { LiveClient } from "./LiveClient";
+import { ListenLiveClient } from "./ListenLiveClient";
+import { ListenRestClient } from "./ListenRestClient";
 import { LiveSchema } from "../lib/types";
-import { PrerecordedClient } from "./PrerecordedClient";
+/**
+ * The `ListenClient` class extends the `AbstractClient` class and provides access to the "listen" namespace.
+ * It exposes two methods:
+ *
+ * 1. `prerecorded()`: Returns a `ListenRestClient` instance for interacting with the prerecorded listen API.
+ * 2. `live(transcriptionOptions: LiveSchema = {}, endpoint = ":version/listen")`: Returns a `ListenLiveClient` instance for interacting with the live listen API, with the provided transcription options and endpoint.
+ */
 export declare class ListenClient extends AbstractClient {
-    get prerecorded(): PrerecordedClient;
-    live(transcriptionOptions: LiveSchema, endpoint?: string): LiveClient;
+    namespace: string;
+    /**
+     * Returns a `ListenRestClient` instance for interacting with the prerecorded listen API.
+     */
+    get prerecorded(): ListenRestClient;
+    /**
+     * Returns a `ListenLiveClient` instance for interacting with the live listen API, with the provided transcription options and endpoint.
+     * @param {LiveSchema} [transcriptionOptions={}] - The transcription options to use for the live listen API.
+     * @param {string} [endpoint=":version/listen"] - The endpoint to use for the live listen API.
+     * @returns {ListenLiveClient} - A `ListenLiveClient` instance for interacting with the live listen API.
+     */
+    live(transcriptionOptions?: LiveSchema, endpoint?: string): ListenLiveClient;
 }
 //# sourceMappingURL=ListenClient.d.ts.map

package/dist/module/packages/ListenClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ListenClient.d.ts","sourceRoot":"","sources":["../../../src/packages/ListenClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,qBAAa,YAAa,SAAQ,cAAc;IAC9C,IAAI,WAAW,sBAEd;IAEM,IAAI,CAAC,oBAAoB,EAAE,UAAU,EAAE,QAAQ,SAAc;CAGrE"}
+{"version":3,"file":"ListenClient.d.ts","sourceRoot":"","sources":["../../../src/packages/ListenClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,cAAc;IACvC,SAAS,EAAE,MAAM,CAAY;IAEpC;;OAEG;IACH,IAAI,WAAW,qBAEd;IAED;;;;;OAKG;IACI,IAAI,CACT,oBAAoB,GAAE,UAAe,EACrC,QAAQ,GAAE,MAA0B,GACnC,gBAAgB;CAGpB"}

package/dist/module/packages/ListenClient.js

@@ -1,12 +1,32 @@
 import { AbstractClient } from "./AbstractClient";
-import { LiveClient } from "./LiveClient";
-import { PrerecordedClient } from "./PrerecordedClient";
+import { ListenLiveClient } from "./ListenLiveClient";
+import { ListenRestClient } from "./ListenRestClient";
+/**
+ * The `ListenClient` class extends the `AbstractClient` class and provides access to the "listen" namespace.
+ * It exposes two methods:
+ *
+ * 1. `prerecorded()`: Returns a `ListenRestClient` instance for interacting with the prerecorded listen API.
+ * 2. `live(transcriptionOptions: LiveSchema = {}, endpoint = ":version/listen")`: Returns a `ListenLiveClient` instance for interacting with the live listen API, with the provided transcription options and endpoint.
+ */
 export class ListenClient extends AbstractClient {
+    constructor() {
+        super(...arguments);
+        this.namespace = "listen";
+    }
+    /**
+     * Returns a `ListenRestClient` instance for interacting with the prerecorded listen API.
+     */
     get prerecorded() {
-        return new PrerecordedClient(this.key, this.options);
+        return new ListenRestClient(this.options);
     }
-    live(transcriptionOptions, endpoint = "v1/listen") {
-        return new LiveClient(this.key, this.options, transcriptionOptions, endpoint);
+    /**
+     * Returns a `ListenLiveClient` instance for interacting with the live listen API, with the provided transcription options and endpoint.
+     * @param {LiveSchema} [transcriptionOptions={}] - The transcription options to use for the live listen API.
+     * @param {string} [endpoint=":version/listen"] - The endpoint to use for the live listen API.
+     * @returns {ListenLiveClient} - A `ListenLiveClient` instance for interacting with the live listen API.
+     */
+    live(transcriptionOptions = {}, endpoint = ":version/listen") {
+        return new ListenLiveClient(this.options, transcriptionOptions, endpoint);
     }
 }
 //# sourceMappingURL=ListenClient.js.map

package/dist/module/packages/ListenClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"ListenClient.js","sourceRoot":"","sources":["../../../src/packages/ListenClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,MAAM,OAAO,YAAa,SAAQ,cAAc;IAC9C,IAAI,WAAW;QACb,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAEM,IAAI,CAAC,oBAAgC,EAAE,QAAQ,GAAG,WAAW;QAClE,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,oBAAoB,EAAE,QAAQ,CAAC,CAAC;IAChF,CAAC;CACF"}
+{"version":3,"file":"ListenClient.js","sourceRoot":"","sources":["../../../src/packages/ListenClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAGtD;;;;;;GAMG;AACH,MAAM,OAAO,YAAa,SAAQ,cAAc;IAAhD;;QACS,cAAS,GAAW,QAAQ,CAAC;IAqBtC,CAAC;IAnBC;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACI,IAAI,CACT,uBAAmC,EAAE,EACrC,WAAmB,iBAAiB;QAEpC,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,oBAAoB,EAAE,QAAQ,CAAC,CAAC;IAC5E,CAAC;CACF"}

package/dist/module/packages/ListenLiveClient.d.ts

@@ -0,0 +1,58 @@
+import { AbstractLiveClient } from "./AbstractLiveClient";
+import type { LiveSchema, LiveConfigOptions, DeepgramClientOptions } from "../lib/types";
+/**
+ * The `ListenLiveClient` class extends the `AbstractLiveClient` class and provides functionality for setting up and managing a WebSocket connection for live transcription.
+ *
+ * The constructor takes in `DeepgramClientOptions` and an optional `LiveSchema` object, as well as an optional `endpoint` string. It then calls the `connect` method of the parent `AbstractLiveClient` class to establish the WebSocket connection.
+ *
+ * The `setupConnection` method is responsible for handling the various events that can occur on the WebSocket connection, such as opening, closing, and receiving messages. It sets up event handlers for these events and emits the appropriate events based on the message type.
+ *
+ * The `configure` method allows you to send additional configuration options to the connected session, such as enabling numerals.
+ *
+ * The `keepAlive` method sends a "KeepAlive" message to the server to maintain the connection.
+ *
+ * The `requestClose` method requests the server to close the connection.
+ *
+ * The `finish` method is deprecated as of version 3.4 and will be removed in version 4.0. Use `requestClose` instead.
+ */
+export declare class ListenLiveClient extends AbstractLiveClient {
+    namespace: string;
+    /**
+     * Constructs a new `ListenLiveClient` instance with the provided options.
+     *
+     * @param options - The `DeepgramClientOptions` to use for the client connection.
+     * @param transcriptionOptions - An optional `LiveSchema` object containing additional configuration options for the live transcription.
+     * @param endpoint - An optional string representing the WebSocket endpoint to connect to. Defaults to `:version/listen`.
+     */
+    constructor(options: DeepgramClientOptions, transcriptionOptions?: LiveSchema, endpoint?: string);
+    /**
+     * Sets up the connection event handlers.
+     * This method is responsible for handling the various events that can occur on the WebSocket connection, such as opening, closing, and receiving messages.
+     * - When the connection is opened, it emits the `LiveTranscriptionEvents.Open` event.
+     * - When the connection is closed, it emits the `LiveTranscriptionEvents.Close` event.
+     * - When an error occurs on the connection, it emits the `LiveTranscriptionEvents.Error` event.
+     * - When a message is received, it parses the message and emits the appropriate event based on the message type, such as `LiveTranscriptionEvents.Metadata`, `LiveTranscriptionEvents.Transcript`, `LiveTranscriptionEvents.UtteranceEnd`, and `LiveTranscriptionEvents.SpeechStarted`.
+     */
+    setupConnection(): void;
+    /**
+     * Sends additional config to the connected session.
+     *
+     * @param config - The configuration options to apply to the LiveClient.
+     * @param config.numerals - We currently only support numerals.
+     */
+    configure(config: LiveConfigOptions): void;
+    /**
+     * Sends a "KeepAlive" message to the server to maintain the connection.
+     */
+    keepAlive(): void;
+    /**
+     * @deprecated Since version 3.4. Will be removed in version 4.0. Use `close` instead.
+     */
+    finish(): void;
+    /**
+     * Requests the server close the connection.
+     */
+    requestClose(): void;
+}
+export { ListenLiveClient as Liveclient };
+//# sourceMappingURL=ListenLiveClient.d.ts.map

package/dist/module/packages/ListenLiveClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListenLiveClient.d.ts","sourceRoot":"","sources":["../../../src/packages/ListenLiveClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAEzF;;;;;;;;;;;;;;GAcG;AACH,qBAAa,gBAAiB,SAAQ,kBAAkB;IAC/C,SAAS,EAAE,MAAM,CAAY;IAEpC;;;;;;OAMG;gBAED,OAAO,EAAE,qBAAqB,EAC9B,oBAAoB,GAAE,UAAe,EACrC,QAAQ,GAAE,MAA0B;IAOtC;;;;;;;OAOG;IACI,eAAe,IAAI,IAAI;IAwC9B;;;;;OAKG;IACI,SAAS,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IASjD;;OAEG;IACI,SAAS,IAAI,IAAI;IAQxB;;OAEG;IACI,MAAM,IAAI,IAAI;IAIrB;;OAEG;IACI,YAAY,IAAI,IAAI;CAO5B;AAED,OAAO,EAAE,gBAAgB,IAAI,UAAU,EAAE,CAAC"}

package/dist/module/packages/ListenLiveClient.js

@@ -0,0 +1,115 @@
+import { AbstractLiveClient } from "./AbstractLiveClient";
+import { LiveTranscriptionEvents } from "../lib/enums";
+/**
+ * The `ListenLiveClient` class extends the `AbstractLiveClient` class and provides functionality for setting up and managing a WebSocket connection for live transcription.
+ *
+ * The constructor takes in `DeepgramClientOptions` and an optional `LiveSchema` object, as well as an optional `endpoint` string. It then calls the `connect` method of the parent `AbstractLiveClient` class to establish the WebSocket connection.
+ *
+ * The `setupConnection` method is responsible for handling the various events that can occur on the WebSocket connection, such as opening, closing, and receiving messages. It sets up event handlers for these events and emits the appropriate events based on the message type.
+ *
+ * The `configure` method allows you to send additional configuration options to the connected session, such as enabling numerals.
+ *
+ * The `keepAlive` method sends a "KeepAlive" message to the server to maintain the connection.
+ *
+ * The `requestClose` method requests the server to close the connection.
+ *
+ * The `finish` method is deprecated as of version 3.4 and will be removed in version 4.0. Use `requestClose` instead.
+ */
+export class ListenLiveClient extends AbstractLiveClient {
+    /**
+     * Constructs a new `ListenLiveClient` instance with the provided options.
+     *
+     * @param options - The `DeepgramClientOptions` to use for the client connection.
+     * @param transcriptionOptions - An optional `LiveSchema` object containing additional configuration options for the live transcription.
+     * @param endpoint - An optional string representing the WebSocket endpoint to connect to. Defaults to `:version/listen`.
+     */
+    constructor(options, transcriptionOptions = {}, endpoint = ":version/listen") {
+        super(options);
+        this.namespace = "listen";
+        this.connect(transcriptionOptions, endpoint);
+    }
+    /**
+     * Sets up the connection event handlers.
+     * This method is responsible for handling the various events that can occur on the WebSocket connection, such as opening, closing, and receiving messages.
+     * - When the connection is opened, it emits the `LiveTranscriptionEvents.Open` event.
+     * - When the connection is closed, it emits the `LiveTranscriptionEvents.Close` event.
+     * - When an error occurs on the connection, it emits the `LiveTranscriptionEvents.Error` event.
+     * - When a message is received, it parses the message and emits the appropriate event based on the message type, such as `LiveTranscriptionEvents.Metadata`, `LiveTranscriptionEvents.Transcript`, `LiveTranscriptionEvents.UtteranceEnd`, and `LiveTranscriptionEvents.SpeechStarted`.
+     */
+    setupConnection() {
+        if (this.conn) {
+            this.conn.onopen = () => {
+                this.emit(LiveTranscriptionEvents.Open, this);
+            };
+            this.conn.onclose = (event) => {
+                this.emit(LiveTranscriptionEvents.Close, event);
+            };
+            this.conn.onerror = (event) => {
+                this.emit(LiveTranscriptionEvents.Error, event);
+            };
+            this.conn.onmessage = (event) => {
+                try {
+                    const data = JSON.parse(event.data.toString());
+                    if (data.type === LiveTranscriptionEvents.Metadata) {
+                        this.emit(LiveTranscriptionEvents.Metadata, data);
+                    }
+                    else if (data.type === LiveTranscriptionEvents.Transcript) {
+                        this.emit(LiveTranscriptionEvents.Transcript, data);
+                    }
+                    else if (data.type === LiveTranscriptionEvents.UtteranceEnd) {
+                        this.emit(LiveTranscriptionEvents.UtteranceEnd, data);
+                    }
+                    else if (data.type === LiveTranscriptionEvents.SpeechStarted) {
+                        this.emit(LiveTranscriptionEvents.SpeechStarted, data);
+                    }
+                    else {
+                        this.emit(LiveTranscriptionEvents.Unhandled, data);
+                    }
+                }
+                catch (error) {
+                    this.emit(LiveTranscriptionEvents.Error, {
+                        event,
+                        message: "Unable to parse `data` as JSON.",
+                        error,
+                    });
+                }
+            };
+        }
+    }
+    /**
+     * Sends additional config to the connected session.
+     *
+     * @param config - The configuration options to apply to the LiveClient.
+     * @param config.numerals - We currently only support numerals.
+     */
+    configure(config) {
+        this.send(JSON.stringify({
+            type: "Configure",
+            processors: config,
+        }));
+    }
+    /**
+     * Sends a "KeepAlive" message to the server to maintain the connection.
+     */
+    keepAlive() {
+        this.send(JSON.stringify({
+            type: "KeepAlive",
+        }));
+    }
+    /**
+     * @deprecated Since version 3.4. Will be removed in version 4.0. Use `close` instead.
+     */
+    finish() {
+        this.requestClose();
+    }
+    /**
+     * Requests the server close the connection.
+     */
+    requestClose() {
+        this.send(JSON.stringify({
+            type: "CloseStream",
+        }));
+    }
+}
+export { ListenLiveClient as Liveclient };
+//# sourceMappingURL=ListenLiveClient.js.map

package/dist/module/packages/ListenLiveClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListenLiveClient.js","sourceRoot":"","sources":["../../../src/packages/ListenLiveClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAGvD;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,gBAAiB,SAAQ,kBAAkB;IAGtD;;;;;;OAMG;IACH,YACE,OAA8B,EAC9B,uBAAmC,EAAE,EACrC,WAAmB,iBAAiB;QAEpC,KAAK,CAAC,OAAO,CAAC,CAAC;QAdV,cAAS,GAAW,QAAQ,CAAC;QAgBlC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACI,eAAe;QACpB,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE;gBACtB,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAChD,CAAC,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,KAAU,EAAE,EAAE;gBACjC,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAClD,CAAC,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,KAAiB,EAAE,EAAE;gBACxC,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAClD,CAAC,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,KAAmB,EAAE,EAAE;gBAC5C,IAAI;oBACF,MAAM,IAAI,GAAQ,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;oBAEpD,IAAI,IAAI,CAAC,IAAI,KAAK,uBAAuB,CAAC,QAAQ,EAAE;wBAClD,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;qBACnD;yBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,uBAAuB,CAAC,UAAU,EAAE;wBAC3D,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;qBACrD;yBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,uBAAuB,CAAC,YAAY,EAAE;wBAC7D,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;qBACvD;yBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,uBAAuB,CAAC,aAAa,EAAE;wBAC9D,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;qBACxD;yBAAM;wBACL,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;qBACpD;iBACF;gBAAC,OAAO,KAAK,EAAE;oBACd,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE;wBACvC,KAAK;wBACL,OAAO,EAAE,iCAAiC;wBAC1C,KAAK;qBACN,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC;SACH;IACH,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,MAAyB;QACxC,IAAI,CAAC,IAAI,CACP,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,WAAW;YACjB,UAAU,EAAE,MAAM;SACnB,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,SAAS;QACd,IAAI,CAAC,IAAI,CACP,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,WAAW;SAClB,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,MAAM;QACX,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,IAAI,CAAC,IAAI,CACP,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,aAAa;SACpB,CAAC,CACH,CAAC;IACJ,CAAC;CACF;AAED,OAAO,EAAE,gBAAgB,IAAI,UAAU,EAAE,CAAC"}

package/dist/module/packages/ListenRestClient.d.ts

@@ -0,0 +1,57 @@
+import { CallbackUrl } from "../lib/helpers";
+import type { AsyncPrerecordedResponse, DeepgramResponse, FileSource, PrerecordedSchema, SyncPrerecordedResponse, UrlSource } from "../lib/types";
+import { AbstractRestClient } from "./AbstractRestClient";
+/**
+ * The `ListenRestClient` class extends the `AbstractRestClient` class and provides methods for transcribing audio from URLs or files using the Deepgram API.
+ *
+ * The `transcribeUrl` method is used to transcribe audio from a URL synchronously. It takes a `UrlSource` object as the source, an optional `PrerecordedSchema` object as options, and an optional endpoint string. It returns a `DeepgramResponse` object containing the transcription result or an error.
+ *
+ * The `transcribeFile` method is used to transcribe audio from a file synchronously. It takes a `FileSource` object as the source, an optional `PrerecordedSchema` object as options, and an optional endpoint string. It returns a `DeepgramResponse` object containing the transcription result or an error.
+ *
+ * The `transcribeUrlCallback` method is used to transcribe audio from a URL asynchronously. It takes a `UrlSource` object as the source, a `CallbackUrl` object as the callback, an optional `PrerecordedSchema` object as options, and an optional endpoint string. It returns a `DeepgramResponse` object containing the transcription result or an error.
+ *
+ * The `transcribeFileCallback` method is used to transcribe audio from a file asynchronously. It takes a `FileSource` object as the source, a `CallbackUrl` object as the callback, an optional `PrerecordedSchema` object as options, and an optional endpoint string. It returns a `DeepgramResponse` object containing the transcription result or an error.
+ */
+export declare class ListenRestClient extends AbstractRestClient {
+    namespace: string;
+    /**
+     * Transcribes audio from a URL synchronously.
+     *
+     * @param source - The URL source object containing the audio URL to transcribe.
+     * @param options - An optional `PrerecordedSchema` object containing additional options for the transcription.
+     * @param endpoint - An optional endpoint string to use for the transcription request.
+     * @returns A `DeepgramResponse` object containing the transcription result or an error.
+     */
+    transcribeUrl(source: UrlSource, options?: PrerecordedSchema, endpoint?: string): Promise<DeepgramResponse<SyncPrerecordedResponse>>;
+    /**
+     * Transcribes audio from a file asynchronously.
+     *
+     * @param source - The file source object containing the audio file to transcribe.
+     * @param options - An optional `PrerecordedSchema` object containing additional options for the transcription.
+     * @param endpoint - An optional endpoint string to use for the transcription request.
+     * @returns A `DeepgramResponse` object containing the transcription result or an error.
+     */
+    transcribeFile(source: FileSource, options?: PrerecordedSchema, endpoint?: string): Promise<DeepgramResponse<SyncPrerecordedResponse>>;
+    /**
+     * Transcribes audio from a URL asynchronously.
+     *
+     * @param source - The URL source object containing the audio file to transcribe.
+     * @param callback - The callback URL to receive the transcription result.
+     * @param options - An optional `PrerecordedSchema` object containing additional options for the transcription.
+     * @param endpoint - An optional endpoint string to use for the transcription request.
+     * @returns A `DeepgramResponse` object containing the transcription result or an error.
+     */
+    transcribeUrlCallback(source: UrlSource, callback: CallbackUrl, options?: PrerecordedSchema, endpoint?: string): Promise<DeepgramResponse<AsyncPrerecordedResponse>>;
+    /**
+     * Transcribes audio from a file asynchronously.
+     *
+     * @param source - The file source object containing the audio file to transcribe.
+     * @param callback - The callback URL to receive the transcription result.
+     * @param options - An optional `PrerecordedSchema` object containing additional options for the transcription.
+     * @param endpoint - An optional endpoint string to use for the transcription request.
+     * @returns A `DeepgramResponse` object containing the transcription result or an error.
+     */
+    transcribeFileCallback(source: FileSource, callback: CallbackUrl, options?: PrerecordedSchema, endpoint?: string): Promise<DeepgramResponse<AsyncPrerecordedResponse>>;
+}
+export { ListenRestClient as PrerecordedClient };
+//# sourceMappingURL=ListenRestClient.d.ts.map

package/dist/module/packages/ListenRestClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ListenRestClient.d.ts","sourceRoot":"","sources":["../../../src/packages/ListenRestClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAA6B,MAAM,gBAAgB,CAAC;AAExE,OAAO,KAAK,EACV,wBAAwB,EACxB,gBAAgB,EAEhB,UAAU,EACV,iBAAiB,EACjB,uBAAuB,EACvB,SAAS,EACV,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;;;;;;;;;GAUG;AACH,qBAAa,gBAAiB,SAAQ,kBAAkB;IAC/C,SAAS,EAAE,MAAM,CAAY;IAEpC;;;;;;;OAOG;IACG,aAAa,CACjB,MAAM,EAAE,SAAS,EACjB,OAAO,CAAC,EAAE,iBAAiB,EAC3B,QAAQ,SAAoB,GAC3B,OAAO,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;IA+BrD;;;;;;;OAOG;IACG,cAAc,CAClB,MAAM,EAAE,UAAU,EAClB,OAAO,CAAC,EAAE,iBAAiB,EAC3B,QAAQ,SAAoB,GAC3B,OAAO,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;IA+BrD;;;;;;;;OAQG;IACG,qBAAqB,CACzB,MAAM,EAAE,SAAS,EACjB,QAAQ,EAAE,WAAW,EACrB,OAAO,CAAC,EAAE,iBAAiB,EAC3B,QAAQ,SAAoB,GAC3B,OAAO,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;IA6BtD;;;;;;;;OAQG;IACG,sBAAsB,CAC1B,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,WAAW,EACrB,OAAO,CAAC,EAAE,iBAAiB,EAC3B,QAAQ,SAAoB,GAC3B,OAAO,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;CA4BvD;AAED,OAAO,EAAE,gBAAgB,IAAI,iBAAiB,EAAE,CAAC"}