@deepgram/sdk 5.0.0-beta.4 → 5.1.0

package/dist/cjs/api/resources/speak/resources/v1/client/Client.d.ts

@@ -1,15 +1,19 @@
 import type { BaseClientOptions } from "../../../../../../BaseClient.js";
 import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.js";
+import type * as Deepgram from "../../../../../index.js";
 import { AudioClient } from "../resources/audio/client/Client.js";
 import { V1Socket } from "./Socket.js";
 export declare namespace V1Client {
     type Options = BaseClientOptions;
     interface ConnectArgs {
-        encoding?: string;
-        mip_opt_out?: string;
-        model?: string;
-        sample_rate?: string;
+        encoding?: Deepgram.SpeakV1Encoding;
+        mip_opt_out?: Deepgram.SpeakV1MipOptOut | undefined;
+        model?: Deepgram.SpeakV1Model;
+        sample_rate?: Deepgram.SpeakV1SampleRate;
+        speed?: Deepgram.SpeakV1Speed;
         Authorization: string;
+        /** WebSocket subprotocols to use for the connection. */
+        protocols?: string | string[];
         /** Additional query parameters to send with the websocket connect request. */
         queryParams?: Record<string, unknown>;
         /** Arbitrary headers to send with the websocket connect request. */
@@ -18,6 +22,10 @@ export declare namespace V1Client {
         debug?: boolean;
         /** Number of reconnect attempts. Defaults to 30. */
         reconnectAttempts?: number;
+        /** The timeout for establishing the WebSocket connection in seconds. */
+        connectionTimeoutInSeconds?: number;
+        /** A signal to abort the WebSocket connection. */
+        abortSignal?: AbortSignal;
     }
 }
 export declare class V1Client {

package/dist/cjs/api/resources/speak/resources/v1/client/Client.js

@@ -47,6 +47,7 @@ exports.V1Client = void 0;
 const BaseClient_js_1 = require("../../../../../../BaseClient.js");
 const headers_js_1 = require("../../../../../../core/headers.js");
 const core = __importStar(require("../../../../../../core/index.js"));
+const json_js_1 = require("../../../../../../core/json.js");
 const environments = __importStar(require("../../../../../../environments.js"));
 const Client_js_1 = require("../resources/audio/client/Client.js");
 const Socket_js_1 = require("./Socket.js");
@@ -60,21 +61,27 @@ class V1Client {
     }
     connect(args) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const { encoding, mip_opt_out: mipOptOut, model, sample_rate: sampleRate, queryParams, headers, debug, reconnectAttempts, } = args;
+            var _a, _b, _c;
+            const { encoding, mip_opt_out: mipOptOut, model, sample_rate: sampleRate, speed, protocols, queryParams, headers, debug, reconnectAttempts, connectionTimeoutInSeconds, abortSignal, } = args;
             const _queryParams = {
-                encoding,
-                mip_opt_out: mipOptOut,
-                model,
-                sample_rate: sampleRate,
+                encoding: encoding != null ? encoding : undefined,
+                mip_opt_out: mipOptOut != null ? (typeof mipOptOut === "string" ? mipOptOut : (0, json_js_1.toJson)(mipOptOut)) : undefined,
+                model: model != null ? model : undefined,
+                sample_rate: sampleRate != null ? sampleRate : undefined,
+                speed,
             };
-            const _headers = (0, headers_js_1.mergeHeaders)((0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: args.Authorization }), headers);
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: args.Authorization }), headers);
             const socket = new core.ReconnectingWebSocket({
-                url: core.url.join((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.DeepgramEnvironment.Production).production, "/v1/speak"),
-                protocols: [],
+                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.DeepgramEnvironment.Production).production, "/v1/speak"),
+                protocols: protocols !== null && protocols !== void 0 ? protocols : [],
                 queryParameters: Object.assign(Object.assign({}, _queryParams), queryParams),
                 headers: _headers,
-                options: { debug: debug !== null && debug !== void 0 ? debug : false, maxRetries: reconnectAttempts !== null && reconnectAttempts !== void 0 ? reconnectAttempts : 30 },
+                options: {
+                    debug: debug !== null && debug !== void 0 ? debug : false,
+                    maxRetries: reconnectAttempts !== null && reconnectAttempts !== void 0 ? reconnectAttempts : 30,
+                    connectionTimeout: connectionTimeoutInSeconds != null ? connectionTimeoutInSeconds * 1000 : undefined,
+                },
+                abortSignal: abortSignal,
             });
             return new Socket_js_1.V1Socket({ socket });
         });

package/dist/cjs/api/resources/speak/resources/v1/client/Socket.d.ts

@@ -21,7 +21,7 @@ export declare class V1Socket {
     private handleError;
     constructor(args: V1Socket.Args);
     /** The current state of the connection; this is one of the readyState constants. */
-    get readyState(): number;
+    get readyState(): core.ReconnectingWebSocket.ReadyState;
     /**
      * @param event - The event to attach to.
      * @param callback - The callback to run when the event is triggered.
@@ -46,7 +46,7 @@ export declare class V1Socket {
     /** Asserts that the websocket is open. */
     private assertSocketIsOpen;
     /** Send a binary payload to the websocket. */
-    protected sendBinary(payload: ArrayBufferLike | Blob | ArrayBufferView): void;
+    protected sendBinary(payload: ArrayBuffer | Blob | ArrayBufferView): void;
     /** Send a JSON payload to the websocket. */
     protected sendJson(payload: Deepgram.speak.SpeakV1Text | Deepgram.speak.SpeakV1Flush | Deepgram.speak.SpeakV1Clear | Deepgram.speak.SpeakV1Close): void;
 }

package/dist/cjs/api/resources/speak/resources/v1/client/Socket.js

@@ -127,7 +127,7 @@ class V1Socket {
     /** Returns a promise that resolves when the websocket is open. */
     waitForOpen() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.socket.readyState === core.ReconnectingWebSocket.OPEN) {
+            if (this.socket.readyState === core.ReconnectingWebSocket.ReadyState.OPEN) {
                 return this.socket;
             }
             return new Promise((resolve, reject) => {
@@ -145,7 +145,7 @@ class V1Socket {
         if (!this.socket) {
             throw new Error("Socket is not connected.");
         }
-        if (this.socket.readyState !== core.ReconnectingWebSocket.OPEN) {
+        if (this.socket.readyState !== core.ReconnectingWebSocket.ReadyState.OPEN) {
             throw new Error("Socket is not open.");
         }
     }

package/dist/cjs/api/resources/speak/resources/v1/exports.d.ts

@@ -0,0 +1,4 @@
+export { V1Client } from "./client/Client.js";
+export * from "./client/index.js";
+export { V1Socket } from "./client/Socket.js";
+export * from "./resources/index.js";

package/dist/cjs/api/resources/speak/resources/v1/exports.js

@@ -0,0 +1,24 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.V1Socket = exports.V1Client = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "V1Client", { enumerable: true, get: function () { return Client_js_1.V1Client; } });
+__exportStar(require("./client/index.js"), exports);
+var Socket_js_1 = require("./client/Socket.js");
+Object.defineProperty(exports, "V1Socket", { enumerable: true, get: function () { return Socket_js_1.V1Socket; } });
+__exportStar(require("./resources/index.js"), exports);

package/dist/cjs/api/resources/speak/resources/v1/resources/audio/client/Client.d.ts

@@ -12,6 +12,7 @@ export declare class AudioClient {
     constructor(options?: AudioClient.Options);
     /**
      * Convert text into natural-sounding speech using Deepgram's TTS REST API
+     *
      * @throws {@link Deepgram.BadRequestError}
      */
     generate(request: Deepgram.speak.v1.SpeakV1Request, requestOptions?: AudioClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;

package/dist/cjs/api/resources/speak/resources/v1/resources/audio/client/Client.js

@@ -68,6 +68,7 @@ class AudioClient {
     }
     /**
      * Convert text into natural-sounding speech using Deepgram's TTS REST API
+     *
      * @throws {@link Deepgram.BadRequestError}
      */
     generate(request, requestOptions) {
@@ -76,7 +77,7 @@ class AudioClient {
     __generate(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const { callback, callback_method: callbackMethod, mip_opt_out: mipOptOut, tag, bit_rate: bitRate, container, encoding, model, sample_rate: sampleRate } = request, _body = __rest(request, ["callback", "callback_method", "mip_opt_out", "tag", "bit_rate", "container", "encoding", "model", "sample_rate"]);
+            const { callback, callback_method: callbackMethod, mip_opt_out: mipOptOut, tag, bit_rate: bitRate, container, encoding, model, sample_rate: sampleRate, speed } = request, _body = __rest(request, ["callback", "callback_method", "mip_opt_out", "tag", "bit_rate", "container", "encoding", "model", "sample_rate", "speed"]);
             const _queryParams = {
                 callback,
                 callback_method: callbackMethod != null ? callbackMethod : undefined,
@@ -87,6 +88,7 @@ class AudioClient {
                 encoding: encoding != null ? encoding : undefined,
                 model: model != null ? model : undefined,
                 sample_rate: sampleRate,
+                speed,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
             const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
@@ -95,7 +97,11 @@ class AudioClient {
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
                 requestType: "json",
                 body: _body,
                 responseType: "binary-response",

package/dist/cjs/api/resources/speak/resources/v1/resources/audio/client/requests/SpeakV1Request.d.ts

@@ -24,6 +24,8 @@ export interface SpeakV1Request {
     model?: Deepgram.speak.v1.AudioGenerateRequestModel;
     /** Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable */
     sample_rate?: number;
+    /** Speaking rate multiplier that adjusts the pace of generated speech while preserving natural prosody and voice quality. Not yet supported in all languages. */
+    speed?: number;
     /** The text content to be converted to speech */
     text: string;
 }

package/dist/cjs/api/resources/speak/resources/v1/resources/audio/exports.d.ts

@@ -0,0 +1,2 @@
+export { AudioClient } from "./client/Client.js";
+export * from "./client/index.js";

package/dist/cjs/api/resources/speak/resources/v1/resources/audio/exports.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AudioClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "AudioClient", { enumerable: true, get: function () { return Client_js_1.AudioClient; } });
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/voiceAgent/client/Client.d.ts

@@ -0,0 +1,15 @@
+import type { BaseClientOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import { ConfigurationsClient } from "../resources/configurations/client/Client.js";
+import { VariablesClient } from "../resources/variables/client/Client.js";
+export declare namespace VoiceAgentClient {
+    type Options = BaseClientOptions;
+}
+export declare class VoiceAgentClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<VoiceAgentClient.Options>;
+    protected _configurations: ConfigurationsClient | undefined;
+    protected _variables: VariablesClient | undefined;
+    constructor(options?: VoiceAgentClient.Options);
+    get configurations(): ConfigurationsClient;
+    get variables(): VariablesClient;
+}

package/dist/cjs/api/resources/voiceAgent/client/Client.js

@@ -0,0 +1,21 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VoiceAgentClient = void 0;
+const BaseClient_js_1 = require("../../../../BaseClient.js");
+const Client_js_1 = require("../resources/configurations/client/Client.js");
+const Client_js_2 = require("../resources/variables/client/Client.js");
+class VoiceAgentClient {
+    constructor(options = {}) {
+        this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
+    }
+    get configurations() {
+        var _a;
+        return ((_a = this._configurations) !== null && _a !== void 0 ? _a : (this._configurations = new Client_js_1.ConfigurationsClient(this._options)));
+    }
+    get variables() {
+        var _a;
+        return ((_a = this._variables) !== null && _a !== void 0 ? _a : (this._variables = new Client_js_2.VariablesClient(this._options)));
+    }
+}
+exports.VoiceAgentClient = VoiceAgentClient;

package/dist/cjs/api/resources/voiceAgent/exports.d.ts

@@ -0,0 +1,3 @@
+export { VoiceAgentClient } from "./client/Client.js";
+export * from "./client/index.js";
+export * from "./resources/index.js";

package/dist/cjs/api/resources/voiceAgent/exports.js

@@ -0,0 +1,22 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VoiceAgentClient = void 0;
+var Client_js_1 = require("./client/Client.js");
+Object.defineProperty(exports, "VoiceAgentClient", { enumerable: true, get: function () { return Client_js_1.VoiceAgentClient; } });
+__exportStar(require("./client/index.js"), exports);
+__exportStar(require("./resources/index.js"), exports);

package/dist/cjs/api/resources/voiceAgent/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client/index.js";
+export * from "./resources/index.js";

package/dist/cjs/api/resources/voiceAgent/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);
+__exportStar(require("./resources/index.js"), exports);

package/dist/cjs/api/resources/voiceAgent/resources/configurations/client/Client.d.ts

@@ -0,0 +1,89 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.js";
+import * as core from "../../../../../../core/index.js";
+import * as Deepgram from "../../../../../index.js";
+export declare namespace ConfigurationsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class ConfigurationsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ConfigurationsClient.Options>;
+    constructor(options?: ConfigurationsClient.Options);
+    /**
+     * Returns all agent configurations for the specified project. Configurations are returned in their uninterpolated form—template variable placeholders appear as-is rather than with their substituted values.
+     *
+     * @param {string} project_id - The unique identifier of the project
+     * @param {ConfigurationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Deepgram.BadRequestError}
+     *
+     * @example
+     *     await client.voiceAgent.configurations.list("123456-7890-1234-5678-901234")
+     */
+    list(project_id: string, requestOptions?: ConfigurationsClient.RequestOptions): core.HttpResponsePromise<Deepgram.ListAgentConfigurationsV1Response>;
+    private __list;
+    /**
+     * Creates a new reusable agent configuration. The `config` field must be a valid JSON string representing the `agent` block of a Settings message. The returned `agent_id` can be passed in place of the full `agent` object in future Settings messages.
+     *
+     * @param {string} project_id - The unique identifier of the project
+     * @param {Deepgram.voiceAgent.CreateAgentConfigurationV1Request} request
+     * @param {ConfigurationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Deepgram.BadRequestError}
+     *
+     * @example
+     *     await client.voiceAgent.configurations.create("123456-7890-1234-5678-901234", {
+     *         config: "config"
+     *     })
+     */
+    create(project_id: string, request: Deepgram.voiceAgent.CreateAgentConfigurationV1Request, requestOptions?: ConfigurationsClient.RequestOptions): core.HttpResponsePromise<Deepgram.CreateAgentConfigurationV1Response>;
+    private __create;
+    /**
+     * Returns the specified agent configuration in its uninterpolated form
+     *
+     * @param {string} project_id - The unique identifier of the project
+     * @param {string} agent_id - The unique identifier of the agent configuration
+     * @param {ConfigurationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Deepgram.BadRequestError}
+     *
+     * @example
+     *     await client.voiceAgent.configurations.get("123456-7890-1234-5678-901234", "a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+     */
+    get(project_id: string, agent_id: string, requestOptions?: ConfigurationsClient.RequestOptions): core.HttpResponsePromise<Deepgram.AgentConfigurationV1>;
+    private __get;
+    /**
+     * Updates the metadata associated with an agent configuration. The config itself is immutable—to change the configuration, delete the existing agent and create a new one.
+     *
+     * @param {string} project_id - The unique identifier of the project
+     * @param {string} agent_id - The unique identifier of the agent configuration
+     * @param {Deepgram.voiceAgent.UpdateAgentMetadataV1Request} request
+     * @param {ConfigurationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Deepgram.BadRequestError}
+     *
+     * @example
+     *     await client.voiceAgent.configurations.update("123456-7890-1234-5678-901234", "a1b2c3d4-e5f6-7890-abcd-ef1234567890", {
+     *         metadata: {
+     *             "key": "value"
+     *         }
+     *     })
+     */
+    update(project_id: string, agent_id: string, request: Deepgram.voiceAgent.UpdateAgentMetadataV1Request, requestOptions?: ConfigurationsClient.RequestOptions): core.HttpResponsePromise<Deepgram.AgentConfigurationV1>;
+    private __update;
+    /**
+     * Deletes the specified agent configuration. Deleting an agent configuration can cause a production outage if your service references this agent UUID. Migrate all active sessions to a new configuration before deleting.
+     *
+     * @param {string} project_id - The unique identifier of the project
+     * @param {string} agent_id - The unique identifier of the agent configuration
+     * @param {ConfigurationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Deepgram.BadRequestError}
+     *
+     * @example
+     *     await client.voiceAgent.configurations.delete("123456-7890-1234-5678-901234", "a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+     */
+    delete(project_id: string, agent_id: string, requestOptions?: ConfigurationsClient.RequestOptions): core.HttpResponsePromise<Deepgram.DeleteAgentConfigurationV1Response>;
+    private __delete;
+}