@deepgram/sdk 5.0.0-beta.4 → 5.1.0

package/dist/cjs/api/types/CreateProjectDistributionCredentialsV1Response.d.ts

@@ -15,7 +15,7 @@ export declare namespace CreateProjectDistributionCredentialsV1Response {
         /** The provider of the distribution service */
         provider: string;
         /** Optional comment about the credentials */
-        comment?: string;
+        comment?: string | undefined;
         /** List of permission scopes for the credentials */
         scopes: string[];
         /** Timestamp when the credentials were created */

package/dist/cjs/api/types/CreateProjectInviteV1Response.d.ts

@@ -1,4 +1,4 @@
 export interface CreateProjectInviteV1Response {
     /** confirmation message */
-    message?: string;
+    message?: string | undefined;
 }

package/dist/cjs/api/types/Deepgram.d.ts

@@ -1,9 +1,11 @@
 export interface Deepgram {
     type: "deepgram";
     /** The REST API version for the Deepgram text-to-speech API */
-    version?: "v1";
+    version?: "v1" | undefined;
     /** Deepgram TTS model */
     model: Deepgram.Model;
+    /** 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 | undefined;
 }
 export declare namespace Deepgram {
     /** Deepgram TTS model */

package/dist/cjs/api/types/DeleteAgentConfigurationV1Response.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Confirmation that the agent configuration was deleted
+ */
+export type DeleteAgentConfigurationV1Response = Record<string, unknown>;

package/dist/cjs/api/types/DeleteAgentConfigurationV1Response.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/DeleteAgentVariableV1Response.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Confirmation that the agent variable was deleted
+ */
+export type DeleteAgentVariableV1Response = Record<string, unknown>;

package/dist/cjs/api/types/DeleteAgentVariableV1Response.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/DeleteProjectInviteV1Response.d.ts

@@ -1,4 +1,4 @@
 export interface DeleteProjectInviteV1Response {
     /** confirmation message */
-    message?: string;
+    message?: string | undefined;
 }

package/dist/cjs/api/types/DeleteProjectKeyV1Response.d.ts

@@ -1,3 +1,3 @@
 export interface DeleteProjectKeyV1Response {
-    message?: string;
+    message?: string | undefined;
 }

package/dist/cjs/api/types/DeleteProjectMemberV1Response.d.ts

@@ -1,4 +1,4 @@
 export interface DeleteProjectMemberV1Response {
     /** confirmation message */
-    message?: string;
+    message?: string | undefined;
 }

package/dist/cjs/api/types/DeleteProjectV1Response.d.ts

@@ -1,4 +1,4 @@
 export interface DeleteProjectV1Response {
     /** Confirmation message */
-    message?: string;
+    message?: string | undefined;
 }

package/dist/cjs/api/types/ElevenLabsSpeakProvider.d.ts

@@ -1,13 +1,13 @@
 export interface ElevenLabsSpeakProvider {
     type: "eleven_labs";
     /** The REST API version for the ElevenLabs text-to-speech API */
-    version?: "v1";
+    version?: "v1" | undefined;
     /** Eleven Labs model ID */
     model_id: ElevenLabsSpeakProvider.ModelId;
     /** Optional language to use, e.g. 'en-US'. Corresponds to the `language_code` parameter in the ElevenLabs API */
-    language?: string;
+    language?: string | undefined;
     /** Use the `language` field instead. */
-    language_code?: string;
+    language_code?: string | undefined;
 }
 export declare namespace ElevenLabsSpeakProvider {
     /** Eleven Labs model ID */

package/dist/cjs/api/types/ErrorResponseLegacyError.d.ts

@@ -1,8 +1,8 @@
 export interface ErrorResponseLegacyError {
     /** The error code */
-    err_code?: string;
+    err_code?: string | undefined;
     /** The error message */
-    err_msg?: string;
+    err_msg?: string | undefined;
     /** The request ID */
-    request_id?: string;
+    request_id?: string | undefined;
 }

package/dist/cjs/api/types/ErrorResponseModernError.d.ts

@@ -1,10 +1,10 @@
 export interface ErrorResponseModernError {
     /** The category of the error */
-    category?: string;
+    category?: string | undefined;
     /** A message about the error */
-    message?: string;
+    message?: string | undefined;
     /** A description of the error */
-    details?: string;
+    details?: string | undefined;
     /** The unique identifier of the request */
-    request_id?: string;
+    request_id?: string | undefined;
 }

package/dist/cjs/api/types/GetProjectBalanceV1Response.d.ts

@@ -1,10 +1,10 @@
 export interface GetProjectBalanceV1Response {
     /** The unique identifier of the balance */
-    balance_id?: string;
+    balance_id?: string | undefined;
     /** The amount of the balance */
-    amount?: number;
+    amount?: number | undefined;
     /** The units of the balance, such as "USD" */
-    units?: string;
+    units?: string | undefined;
     /** Description or reference of the purchase */
-    purchase_order_id?: string;
+    purchase_order_id?: string | undefined;
 }

package/dist/cjs/api/types/GetProjectDistributionCredentialsV1Response.d.ts

@@ -15,7 +15,7 @@ export declare namespace GetProjectDistributionCredentialsV1Response {
         /** The provider of the distribution service */
         provider: string;
         /** Optional comment about the credentials */
-        comment?: string;
+        comment?: string | undefined;
         /** List of permission scopes for the credentials */
         scopes: string[];
         /** Timestamp when the credentials were created */

package/dist/cjs/api/types/GetProjectKeyV1Response.d.ts

@@ -1,26 +1,26 @@
 export interface GetProjectKeyV1Response {
-    item?: GetProjectKeyV1Response.Item;
+    item?: GetProjectKeyV1Response.Item | undefined;
 }
 export declare namespace GetProjectKeyV1Response {
     interface Item {
-        member?: Item.Member;
+        member?: Item.Member | undefined;
     }
     namespace Item {
         interface Member {
-            member_id?: string;
-            email?: string;
-            first_name?: string;
-            last_name?: string;
-            api_key?: Member.ApiKey;
+            member_id?: string | undefined;
+            email?: string | undefined;
+            first_name?: string | undefined;
+            last_name?: string | undefined;
+            api_key?: Member.ApiKey | undefined;
         }
         namespace Member {
             interface ApiKey {
-                api_key_id?: string;
-                comment?: string;
-                scopes?: string[];
-                tags?: string[];
-                expiration_date?: string;
-                created?: string;
+                api_key_id?: string | undefined;
+                comment?: string | undefined;
+                scopes?: string[] | undefined;
+                tags?: string[] | undefined;
+                expiration_date?: string | undefined;
+                created?: string | undefined;
             }
         }
     }

package/dist/cjs/api/types/GetProjectRequestV1Response.d.ts

@@ -1,4 +1,4 @@
 import type * as Deepgram from "../index.js";
 export interface GetProjectRequestV1Response {
-    request?: Deepgram.ProjectRequestResponse;
+    request?: Deepgram.ProjectRequestResponse | undefined;
 }

package/dist/cjs/api/types/GetProjectV1Response.d.ts

@@ -1,8 +1,8 @@
 export interface GetProjectV1Response {
     /** The unique identifier of the project */
-    project_id?: string;
+    project_id?: string | undefined;
     /** Model Improvement Program opt-out */
-    mip_opt_out?: boolean;
+    mip_opt_out?: boolean | undefined;
     /** The name of the project */
-    name?: string;
+    name?: string | undefined;
 }

package/dist/cjs/api/types/Google.d.ts

@@ -1,11 +1,11 @@
 export interface Google {
     type: "google";
     /** The REST API version for the Google generative language API */
-    version?: "v1beta";
+    version?: "v1beta" | undefined;
     /** Google model to use */
     model: Google.Model;
     /** Google temperature (0-2) */
-    temperature?: number;
+    temperature?: number | undefined;
 }
 export declare namespace Google {
     /** Google model to use */

package/dist/cjs/api/types/GrantV1Response.d.ts

@@ -2,5 +2,5 @@ export interface GrantV1Response {
     /** JSON Web Token (JWT) */
     access_token: string;
     /** Time in seconds until the JWT expires */
-    expires_in?: number;
+    expires_in?: number | undefined;
 }

package/dist/cjs/api/types/Groq.d.ts

@@ -1,9 +1,9 @@
 export interface Groq {
     type: "groq";
     /** The REST API version for the Groq's chat completions API (mostly OpenAI-compatible) */
-    version?: "v1";
+    version?: "v1" | undefined;
     /** Groq model to use */
     model: "openai/gpt-oss-20b";
     /** Groq temperature (0-2) */
-    temperature?: number;
+    temperature?: number | undefined;
 }

package/dist/cjs/api/types/LeaveProjectV1Response.d.ts

@@ -1,4 +1,4 @@
 export interface LeaveProjectV1Response {
     /** confirmation message */
-    message?: string;
+    message?: string | undefined;
 }

package/dist/cjs/api/types/ListAgentConfigurationsV1Response.d.ts

@@ -0,0 +1,5 @@
+import type * as Deepgram from "../index.js";
+export interface ListAgentConfigurationsV1Response {
+    /** A list of agent configurations for the project */
+    agents?: Deepgram.AgentConfigurationV1[] | undefined;
+}

package/dist/cjs/api/types/ListAgentConfigurationsV1Response.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ListAgentVariablesV1Response.d.ts

@@ -0,0 +1,5 @@
+import type * as Deepgram from "../index.js";
+export interface ListAgentVariablesV1Response {
+    /** A list of agent variables for the project */
+    variables?: Deepgram.AgentVariableV1[] | undefined;
+}

package/dist/cjs/api/types/ListAgentVariablesV1Response.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ListBillingFieldsV1Response.d.ts

@@ -1,12 +1,12 @@
 export interface ListBillingFieldsV1Response {
     /** List of accessor UUIDs for the time period */
-    accessors?: string[];
+    accessors?: string[] | undefined;
     /** List of deployment types for the time period */
-    deployments?: ListBillingFieldsV1Response.Deployments.Item[];
+    deployments?: ListBillingFieldsV1Response.Deployments.Item[] | undefined;
     /** List of tags for the time period */
-    tags?: string[];
+    tags?: string[] | undefined;
     /** Map of line item names to human-readable descriptions for the time period */
-    line_items?: Record<string, string>;
+    line_items?: Record<string, string> | undefined;
 }
 export declare namespace ListBillingFieldsV1Response {
     type Deployments = Deployments.Item[];

package/dist/cjs/api/types/ListModelsV1Response.d.ts

@@ -1,5 +1,5 @@
 import type * as Deepgram from "../index.js";
 export interface ListModelsV1Response {
-    stt?: Deepgram.ListModelsV1ResponseSttModels[];
-    tts?: Deepgram.ListModelsV1ResponseTtsModels[];
+    stt?: Deepgram.ListModelsV1ResponseSttModels[] | undefined;
+    tts?: Deepgram.ListModelsV1ResponseTtsModels[] | undefined;
 }

package/dist/cjs/api/types/ListModelsV1ResponseSttModels.d.ts

@@ -1,11 +1,11 @@
 export interface ListModelsV1ResponseSttModels {
-    name?: string;
-    canonical_name?: string;
-    architecture?: string;
-    languages?: string[];
-    version?: string;
-    uuid?: string;
-    batch?: boolean;
-    streaming?: boolean;
-    formatted_output?: boolean;
+    name?: string | undefined;
+    canonical_name?: string | undefined;
+    architecture?: string | undefined;
+    languages?: string[] | undefined;
+    version?: string | undefined;
+    uuid?: string | undefined;
+    batch?: boolean | undefined;
+    streaming?: boolean | undefined;
+    formatted_output?: boolean | undefined;
 }

package/dist/cjs/api/types/ListModelsV1ResponseTtsModels.d.ts

@@ -1,20 +1,20 @@
 export interface ListModelsV1ResponseTtsModels {
-    name?: string;
-    canonical_name?: string;
-    architecture?: string;
-    languages?: string[];
-    version?: string;
-    uuid?: string;
-    metadata?: ListModelsV1ResponseTtsModels.Metadata;
+    name?: string | undefined;
+    canonical_name?: string | undefined;
+    architecture?: string | undefined;
+    languages?: string[] | undefined;
+    version?: string | undefined;
+    uuid?: string | undefined;
+    metadata?: ListModelsV1ResponseTtsModels.Metadata | undefined;
 }
 export declare namespace ListModelsV1ResponseTtsModels {
     interface Metadata {
-        accent?: string;
-        age?: string;
-        color?: string;
-        image?: string;
-        sample?: string;
-        tags?: string[];
-        use_cases?: string[];
+        accent?: string | undefined;
+        age?: string | undefined;
+        color?: string | undefined;
+        image?: string | undefined;
+        sample?: string | undefined;
+        tags?: string[] | undefined;
+        use_cases?: string[] | undefined;
     }
 }

package/dist/cjs/api/types/ListProjectBalancesV1Response.d.ts

@@ -1,18 +1,18 @@
 export interface ListProjectBalancesV1Response {
-    balances?: ListProjectBalancesV1Response.Balances.Item[];
+    balances?: ListProjectBalancesV1Response.Balances.Item[] | undefined;
 }
 export declare namespace ListProjectBalancesV1Response {
     type Balances = Balances.Item[];
     namespace Balances {
         interface Item {
             /** The unique identifier of the balance */
-            balance_id?: string;
+            balance_id?: string | undefined;
             /** The amount of the balance */
-            amount?: number;
+            amount?: number | undefined;
             /** The units of the balance, such as "USD" */
-            units?: string;
+            units?: string | undefined;
             /** Description or reference of the purchase */
-            purchase_order_id?: string;
+            purchase_order_id?: string | undefined;
         }
     }
 }

package/dist/cjs/api/types/ListProjectDistributionCredentialsV1Response.d.ts

@@ -1,6 +1,6 @@
 export interface ListProjectDistributionCredentialsV1Response {
     /** Array of distribution credentials with associated member information */
-    distribution_credentials?: ListProjectDistributionCredentialsV1Response.DistributionCredentials.Item[];
+    distribution_credentials?: ListProjectDistributionCredentialsV1Response.DistributionCredentials.Item[] | undefined;
 }
 export declare namespace ListProjectDistributionCredentialsV1Response {
     type DistributionCredentials = DistributionCredentials.Item[];
@@ -22,7 +22,7 @@ export declare namespace ListProjectDistributionCredentialsV1Response {
                 /** The provider of the distribution service */
                 provider: string;
                 /** Optional comment about the credentials */
-                comment?: string;
+                comment?: string | undefined;
                 /** List of permission scopes for the credentials */
                 scopes: string[];
                 /** Timestamp when the credentials were created */

package/dist/cjs/api/types/ListProjectInvitesV1Response.d.ts

@@ -1,14 +1,14 @@
 export interface ListProjectInvitesV1Response {
-    invites?: ListProjectInvitesV1Response.Invites.Item[];
+    invites?: ListProjectInvitesV1Response.Invites.Item[] | undefined;
 }
 export declare namespace ListProjectInvitesV1Response {
     type Invites = Invites.Item[];
     namespace Invites {
         interface Item {
             /** The email address of the invitee */
-            email?: string;
+            email?: string | undefined;
             /** The scope of the invitee */
-            scope?: string;
+            scope?: string | undefined;
         }
     }
 }

package/dist/cjs/api/types/ListProjectKeysV1Response.d.ts

@@ -1,23 +1,23 @@
 export interface ListProjectKeysV1Response {
-    api_keys?: ListProjectKeysV1Response.ApiKeys.Item[];
+    api_keys?: ListProjectKeysV1Response.ApiKeys.Item[] | undefined;
 }
 export declare namespace ListProjectKeysV1Response {
     type ApiKeys = ApiKeys.Item[];
     namespace ApiKeys {
         interface Item {
-            member?: Item.Member;
-            api_key?: Item.ApiKey;
+            member?: Item.Member | undefined;
+            api_key?: Item.ApiKey | undefined;
         }
         namespace Item {
             interface Member {
-                member_id?: string;
-                email?: string;
+                member_id?: string | undefined;
+                email?: string | undefined;
             }
             interface ApiKey {
-                api_key_id?: string;
-                comment?: string;
-                scopes?: string[];
-                created?: string;
+                api_key_id?: string | undefined;
+                comment?: string | undefined;
+                scopes?: string[] | undefined;
+                created?: string | undefined;
             }
         }
     }

package/dist/cjs/api/types/ListProjectMemberScopesV1Response.d.ts

@@ -1,4 +1,4 @@
 export interface ListProjectMemberScopesV1Response {
     /** The API scopes of the member */
-    scopes?: string[];
+    scopes?: string[] | undefined;
 }

package/dist/cjs/api/types/ListProjectMembersV1Response.d.ts

@@ -1,13 +1,13 @@
 export interface ListProjectMembersV1Response {
-    members?: ListProjectMembersV1Response.Members.Item[];
+    members?: ListProjectMembersV1Response.Members.Item[] | undefined;
 }
 export declare namespace ListProjectMembersV1Response {
     type Members = Members.Item[];
     namespace Members {
         interface Item {
             /** The unique identifier of the member */
-            member_id?: string;
-            email?: string;
+            member_id?: string | undefined;
+            email?: string | undefined;
         }
     }
 }

package/dist/cjs/api/types/ListProjectPurchasesV1Response.d.ts

@@ -1,16 +1,16 @@
 export interface ListProjectPurchasesV1Response {
-    orders?: ListProjectPurchasesV1Response.Orders.Item[];
+    orders?: ListProjectPurchasesV1Response.Orders.Item[] | undefined;
 }
 export declare namespace ListProjectPurchasesV1Response {
     type Orders = Orders.Item[];
     namespace Orders {
         interface Item {
-            order_id?: string;
-            expiration?: string;
-            created?: string;
-            amount?: number;
-            units?: string;
-            order_type?: string;
+            order_id?: string | undefined;
+            expiration?: string | undefined;
+            created?: string | undefined;
+            amount?: number | undefined;
+            units?: string | undefined;
+            order_type?: string | undefined;
         }
     }
 }

package/dist/cjs/api/types/ListProjectRequestsV1Response.d.ts

@@ -1,8 +1,8 @@
 import type * as Deepgram from "../index.js";
 export interface ListProjectRequestsV1Response {
     /** The page number of the paginated response */
-    page?: number;
+    page?: number | undefined;
     /** The number of results per page */
-    limit?: number;
-    requests?: Deepgram.ProjectRequestResponse[];
+    limit?: number | undefined;
+    requests?: Deepgram.ProjectRequestResponse[] | undefined;
 }

package/dist/cjs/api/types/ListProjectsV1Response.d.ts

@@ -1,14 +1,14 @@
 export interface ListProjectsV1Response {
-    projects?: ListProjectsV1Response.Projects.Item[];
+    projects?: ListProjectsV1Response.Projects.Item[] | undefined;
 }
 export declare namespace ListProjectsV1Response {
     type Projects = Projects.Item[];
     namespace Projects {
         interface Item {
             /** The unique identifier of the project */
-            project_id?: string;
+            project_id?: string | undefined;
             /** The name of the project */
-            name?: string;
+            name?: string | undefined;
         }
     }
 }

package/dist/cjs/api/types/ListenV1Callback.d.ts

@@ -1 +1,4 @@
+/**
+ * URL to which we'll make the callback request
+ */
 export type ListenV1Callback = unknown;

package/dist/cjs/api/types/ListenV1Channels.d.ts

@@ -1 +1,4 @@
+/**
+ * The number of channels in the submitted audio
+ */
 export type ListenV1Channels = unknown;

package/dist/cjs/api/types/ListenV1Endpointing.d.ts

@@ -1 +1,4 @@
+/**
+ * Indicates how long Deepgram will wait to detect whether a speaker has finished speaking or pauses for a significant period of time. When set to a value, the streaming endpoint immediately finalizes the transcription for the processed time range and returns the transcript with a speech_final parameter set to true. Can also be set to false to disable endpointing
+ */
 export type ListenV1Endpointing = unknown;

package/dist/cjs/api/types/ListenV1Extra.d.ts

@@ -1 +1,4 @@
+/**
+ * Arbitrary key-value pairs that are attached to the API response for usage in downstream processing
+ */
 export type ListenV1Extra = unknown;

package/dist/cjs/api/types/ListenV1Keyterm.d.ts

@@ -1 +1,4 @@
+/**
+ * Key term prompting can boost specialized terminology and brands. Only compatible with Nova-3
+ */
 export type ListenV1Keyterm = unknown;

package/dist/cjs/api/types/ListenV1Keywords.d.ts

@@ -1 +1,4 @@
+/**
+ * Keywords can boost or suppress specialized terminology and brands
+ */
 export type ListenV1Keywords = unknown;

package/dist/cjs/api/types/ListenV1Language.d.ts

@@ -1 +1,4 @@
+/**
+ * The [BCP-47 language tag](https://tools.ietf.org/html/bcp47) that hints at the primary spoken language. Depending on the Model you choose only certain languages are available
+ */
 export type ListenV1Language = unknown;

package/dist/cjs/api/types/ListenV1MipOptOut.d.ts

@@ -1 +1,4 @@
+/**
+ * Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip
+ */
 export type ListenV1MipOptOut = unknown;

package/dist/cjs/api/types/ListenV1Replace.d.ts

@@ -1 +1,4 @@
+/**
+ * Search for terms or phrases in submitted audio and replaces them
+ */
 export type ListenV1Replace = unknown;