@deepgram/sdk 5.0.0-beta.4 → 5.0.0

package/dist/esm/api/types/GrantV1Response.d.mts

@@ -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/esm/api/types/Groq.d.mts

@@ -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/esm/api/types/LeaveProjectV1Response.d.mts

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

package/dist/esm/api/types/ListBillingFieldsV1Response.d.mts

@@ -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/esm/api/types/ListModelsV1Response.d.mts

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

package/dist/esm/api/types/ListModelsV1ResponseSttModels.d.mts

@@ -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/esm/api/types/ListModelsV1ResponseTtsModels.d.mts

@@ -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/esm/api/types/ListProjectBalancesV1Response.d.mts

@@ -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/esm/api/types/ListProjectDistributionCredentialsV1Response.d.mts

@@ -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/esm/api/types/ListProjectInvitesV1Response.d.mts

@@ -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/esm/api/types/ListProjectKeysV1Response.d.mts

@@ -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/esm/api/types/ListProjectMemberScopesV1Response.d.mts

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

package/dist/esm/api/types/ListProjectMembersV1Response.d.mts

@@ -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/esm/api/types/ListProjectPurchasesV1Response.d.mts

@@ -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/esm/api/types/ListProjectRequestsV1Response.d.mts

@@ -1,8 +1,8 @@
 import type * as Deepgram from "../index.mjs";
 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/esm/api/types/ListProjectsV1Response.d.mts

@@ -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/esm/api/types/ListenV1ResponseMetadata.d.mts

@@ -1,5 +1,5 @@
 export interface ListenV1ResponseMetadata {
-    transaction_key?: string;
+    transaction_key?: string | undefined;
     request_id: string;
     sha256: string;
     created: string;
@@ -7,31 +7,31 @@ export interface ListenV1ResponseMetadata {
     channels: number;
     models: string[];
     model_info: Record<string, unknown>;
-    summary_info?: ListenV1ResponseMetadata.SummaryInfo;
-    sentiment_info?: ListenV1ResponseMetadata.SentimentInfo;
-    topics_info?: ListenV1ResponseMetadata.TopicsInfo;
-    intents_info?: ListenV1ResponseMetadata.IntentsInfo;
-    tags?: string[];
+    summary_info?: ListenV1ResponseMetadata.SummaryInfo | undefined;
+    sentiment_info?: ListenV1ResponseMetadata.SentimentInfo | undefined;
+    topics_info?: ListenV1ResponseMetadata.TopicsInfo | undefined;
+    intents_info?: ListenV1ResponseMetadata.IntentsInfo | undefined;
+    tags?: string[] | undefined;
 }
 export declare namespace ListenV1ResponseMetadata {
     interface SummaryInfo {
-        model_uuid?: string;
-        input_tokens?: number;
-        output_tokens?: number;
+        model_uuid?: string | undefined;
+        input_tokens?: number | undefined;
+        output_tokens?: number | undefined;
     }
     interface SentimentInfo {
-        model_uuid?: string;
-        input_tokens?: number;
-        output_tokens?: number;
+        model_uuid?: string | undefined;
+        input_tokens?: number | undefined;
+        output_tokens?: number | undefined;
     }
     interface TopicsInfo {
-        model_uuid?: string;
-        input_tokens?: number;
-        output_tokens?: number;
+        model_uuid?: string | undefined;
+        input_tokens?: number | undefined;
+        output_tokens?: number | undefined;
     }
     interface IntentsInfo {
-        model_uuid?: string;
-        input_tokens?: number;
-        output_tokens?: number;
+        model_uuid?: string | undefined;
+        input_tokens?: number | undefined;
+        output_tokens?: number | undefined;
     }
 }

package/dist/esm/api/types/ListenV1ResponseResults.d.mts

@@ -1,9 +1,9 @@
 import type * as Deepgram from "../index.mjs";
 export interface ListenV1ResponseResults {
     channels: Deepgram.ListenV1ResponseResultsChannels;
-    utterances?: Deepgram.ListenV1ResponseResultsUtterances;
-    summary?: Deepgram.ListenV1ResponseResultsSummary;
-    topics?: Deepgram.SharedTopics;
-    intents?: Deepgram.SharedIntents;
-    sentiments?: Deepgram.SharedSentiments;
+    utterances?: Deepgram.ListenV1ResponseResultsUtterances | undefined;
+    summary?: Deepgram.ListenV1ResponseResultsSummary | undefined;
+    topics?: Deepgram.SharedTopics | undefined;
+    intents?: Deepgram.SharedIntents | undefined;
+    sentiments?: Deepgram.SharedSentiments | undefined;
 }

package/dist/esm/api/types/ListenV1ResponseResultsChannelsItem.d.mts

@@ -1,23 +1,23 @@
 export interface ListenV1ResponseResultsChannelsItem {
-    search?: ListenV1ResponseResultsChannelsItem.Search.Item[];
-    alternatives?: ListenV1ResponseResultsChannelsItem.Alternatives.Item[];
-    detected_language?: string;
+    search?: ListenV1ResponseResultsChannelsItem.Search.Item[] | undefined;
+    alternatives?: ListenV1ResponseResultsChannelsItem.Alternatives.Item[] | undefined;
+    detected_language?: string | undefined;
 }
 export declare namespace ListenV1ResponseResultsChannelsItem {
     type Search = Search.Item[];
     namespace Search {
         interface Item {
-            query?: string;
-            hits?: Item.Hits.Item[];
+            query?: string | undefined;
+            hits?: Item.Hits.Item[] | undefined;
         }
         namespace Item {
             type Hits = Hits.Item[];
             namespace Hits {
                 interface Item {
-                    confidence?: number;
-                    start?: number;
-                    end?: number;
-                    snippet?: string;
+                    confidence?: number | undefined;
+                    start?: number | undefined;
+                    end?: number | undefined;
+                    snippet?: string | undefined;
                 }
             }
         }
@@ -25,45 +25,45 @@ export declare namespace ListenV1ResponseResultsChannelsItem {
     type Alternatives = Alternatives.Item[];
     namespace Alternatives {
         interface Item {
-            transcript?: string;
-            confidence?: number;
-            words?: Item.Words.Item[];
-            paragraphs?: Item.Paragraphs;
-            entities?: Item.Entities.Item[];
-            summaries?: Item.Summaries.Item[];
-            topics?: Item.Topics.Item[];
+            transcript?: string | undefined;
+            confidence?: number | undefined;
+            words?: Item.Words.Item[] | undefined;
+            paragraphs?: Item.Paragraphs | undefined;
+            entities?: Item.Entities.Item[] | undefined;
+            summaries?: Item.Summaries.Item[] | undefined;
+            topics?: Item.Topics.Item[] | undefined;
         }
         namespace Item {
             type Words = Words.Item[];
             namespace Words {
                 interface Item {
-                    word?: string;
-                    start?: number;
-                    end?: number;
-                    confidence?: number;
+                    word?: string | undefined;
+                    start?: number | undefined;
+                    end?: number | undefined;
+                    confidence?: number | undefined;
                 }
             }
             interface Paragraphs {
-                transcript?: string;
-                paragraphs?: Paragraphs.Paragraphs.Item[];
+                transcript?: string | undefined;
+                paragraphs?: Paragraphs.Paragraphs.Item[] | undefined;
             }
             namespace Paragraphs {
                 type Paragraphs = Paragraphs.Item[];
                 namespace Paragraphs {
                     interface Item {
-                        sentences?: Item.Sentences.Item[];
-                        speaker?: number;
-                        num_words?: number;
-                        start?: number;
-                        end?: number;
+                        sentences?: Item.Sentences.Item[] | undefined;
+                        speaker?: number | undefined;
+                        num_words?: number | undefined;
+                        start?: number | undefined;
+                        end?: number | undefined;
                     }
                     namespace Item {
                         type Sentences = Sentences.Item[];
                         namespace Sentences {
                             interface Item {
-                                text?: string;
-                                start?: number;
-                                end?: number;
+                                text?: string | undefined;
+                                start?: number | undefined;
+                                end?: number | undefined;
                             }
                         }
                     }
@@ -72,29 +72,29 @@ export declare namespace ListenV1ResponseResultsChannelsItem {
             type Entities = Entities.Item[];
             namespace Entities {
                 interface Item {
-                    label?: string;
-                    value?: string;
-                    raw_value?: string;
-                    confidence?: number;
-                    start_word?: number;
-                    end_word?: number;
+                    label?: string | undefined;
+                    value?: string | undefined;
+                    raw_value?: string | undefined;
+                    confidence?: number | undefined;
+                    start_word?: number | undefined;
+                    end_word?: number | undefined;
                 }
             }
             type Summaries = Summaries.Item[];
             namespace Summaries {
                 interface Item {
-                    summary?: string;
-                    start_word?: number;
-                    end_word?: number;
+                    summary?: string | undefined;
+                    start_word?: number | undefined;
+                    end_word?: number | undefined;
                 }
             }
             type Topics = Topics.Item[];
             namespace Topics {
                 interface Item {
-                    text?: string;
-                    start_word?: number;
-                    end_word?: number;
-                    topics?: string[];
+                    text?: string | undefined;
+                    start_word?: number | undefined;
+                    end_word?: number | undefined;
+                    topics?: string[] | undefined;
                 }
             }
         }

package/dist/esm/api/types/ListenV1ResponseResultsSummary.d.mts

@@ -1,4 +1,4 @@
 export interface ListenV1ResponseResultsSummary {
-    result?: string;
-    short?: string;
+    result?: string | undefined;
+    short?: string | undefined;
 }

package/dist/esm/api/types/ListenV1ResponseResultsUtterancesItem.d.mts

@@ -1,24 +1,24 @@
 export interface ListenV1ResponseResultsUtterancesItem {
-    start?: number;
-    end?: number;
-    confidence?: number;
-    channel?: number;
-    transcript?: string;
-    words?: ListenV1ResponseResultsUtterancesItem.Words.Item[];
-    speaker?: number;
-    id?: string;
+    start?: number | undefined;
+    end?: number | undefined;
+    confidence?: number | undefined;
+    channel?: number | undefined;
+    transcript?: string | undefined;
+    words?: ListenV1ResponseResultsUtterancesItem.Words.Item[] | undefined;
+    speaker?: number | undefined;
+    id?: string | undefined;
 }
 export declare namespace ListenV1ResponseResultsUtterancesItem {
     type Words = Words.Item[];
     namespace Words {
         interface Item {
-            word?: string;
-            start?: number;
-            end?: number;
-            confidence?: number;
-            speaker?: number;
-            speaker_confidence?: number;
-            punctuated_word?: string;
+            word?: string | undefined;
+            start?: number | undefined;
+            end?: number | undefined;
+            confidence?: number | undefined;
+            speaker?: number | undefined;
+            speaker_confidence?: number | undefined;
+            punctuated_word?: string | undefined;
         }
     }
 }

package/dist/esm/api/types/OpenAiSpeakProvider.d.mts

@@ -1,7 +1,7 @@
 export interface OpenAiSpeakProvider {
     type: "open_ai";
     /** The REST API version for the OpenAI text-to-speech API */
-    version?: "v1";
+    version?: "v1" | undefined;
     /** OpenAI TTS model */
     model: OpenAiSpeakProvider.Model;
     /** OpenAI voice */

package/dist/esm/api/types/OpenAiThinkProvider.d.mts

@@ -1,11 +1,11 @@
 export interface OpenAiThinkProvider {
     type: "open_ai";
     /** The REST API version for the OpenAI chat completions API */
-    version?: "v1";
+    version?: "v1" | undefined;
     /** OpenAI model to use */
     model: OpenAiThinkProvider.Model;
     /** OpenAI temperature (0-2) */
-    temperature?: number;
+    temperature?: number | undefined;
 }
 export declare namespace OpenAiThinkProvider {
     /** OpenAI model to use */

package/dist/esm/api/types/ProjectRequestResponse.d.mts

@@ -3,21 +3,21 @@
  */
 export interface ProjectRequestResponse {
     /** The unique identifier of the request */
-    request_id?: string;
+    request_id?: string | undefined;
     /** The unique identifier of the project */
-    project_uuid?: string;
+    project_uuid?: string | undefined;
     /** The date and time the request was created */
-    created?: string;
+    created?: string | undefined;
     /** The API path of the request */
-    path?: string;
+    path?: string | undefined;
     /** The unique identifier of the API key */
-    api_key_id?: string;
+    api_key_id?: string | undefined;
     /** The response of the request */
-    response?: Record<string, unknown>;
+    response?: Record<string, unknown> | undefined;
     /** The response code of the request */
-    code?: number;
+    code?: number | undefined;
     /** The deployment type */
-    deployment?: string;
+    deployment?: string | undefined;
     /** The callback URL for the request */
-    callback?: string;
+    callback?: string | undefined;
 }