@deepgram/sdk 5.0.0-beta.3 → 5.0.0

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

@@ -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/cjs/api/types/ListenV1ResponseResultsSummary.d.ts

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

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

@@ -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/cjs/api/types/OpenAiSpeakProvider.d.ts

@@ -0,0 +1,27 @@
+export interface OpenAiSpeakProvider {
+    type: "open_ai";
+    /** The REST API version for the OpenAI text-to-speech API */
+    version?: "v1" | undefined;
+    /** OpenAI TTS model */
+    model: OpenAiSpeakProvider.Model;
+    /** OpenAI voice */
+    voice: OpenAiSpeakProvider.Voice;
+}
+export declare namespace OpenAiSpeakProvider {
+    /** OpenAI TTS model */
+    const Model: {
+        readonly Tts1: "tts-1";
+        readonly Tts1Hd: "tts-1-hd";
+    };
+    type Model = (typeof Model)[keyof typeof Model] | string;
+    /** OpenAI voice */
+    const Voice: {
+        readonly Alloy: "alloy";
+        readonly Echo: "echo";
+        readonly Fable: "fable";
+        readonly Onyx: "onyx";
+        readonly Nova: "nova";
+        readonly Shimmer: "shimmer";
+    };
+    type Voice = (typeof Voice)[keyof typeof Voice] | string;
+}

package/dist/cjs/api/types/OpenAiSpeakProvider.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.OpenAiSpeakProvider = void 0;
+var OpenAiSpeakProvider;
+(function (OpenAiSpeakProvider) {
+    /** OpenAI TTS model */
+    OpenAiSpeakProvider.Model = {
+        Tts1: "tts-1",
+        Tts1Hd: "tts-1-hd",
+    };
+    /** OpenAI voice */
+    OpenAiSpeakProvider.Voice = {
+        Alloy: "alloy",
+        Echo: "echo",
+        Fable: "fable",
+        Onyx: "onyx",
+        Nova: "nova",
+        Shimmer: "shimmer",
+    };
+})(OpenAiSpeakProvider || (exports.OpenAiSpeakProvider = OpenAiSpeakProvider = {}));

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

@@ -0,0 +1,23 @@
+export interface OpenAiThinkProvider {
+    type: "open_ai";
+    /** The REST API version for the OpenAI chat completions API */
+    version?: "v1" | undefined;
+    /** OpenAI model to use */
+    model: OpenAiThinkProvider.Model;
+    /** OpenAI temperature (0-2) */
+    temperature?: number | undefined;
+}
+export declare namespace OpenAiThinkProvider {
+    /** OpenAI model to use */
+    const Model: {
+        readonly Gpt5: "gpt-5";
+        readonly Gpt5Mini: "gpt-5-mini";
+        readonly Gpt5Nano: "gpt-5-nano";
+        readonly Gpt41: "gpt-4.1";
+        readonly Gpt41Mini: "gpt-4.1-mini";
+        readonly Gpt41Nano: "gpt-4.1-nano";
+        readonly Gpt4O: "gpt-4o";
+        readonly Gpt4OMini: "gpt-4o-mini";
+    };
+    type Model = (typeof Model)[keyof typeof Model] | string;
+}

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

@@ -0,0 +1,18 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAiThinkProvider = void 0;
+var OpenAiThinkProvider;
+(function (OpenAiThinkProvider) {
+    /** OpenAI model to use */
+    OpenAiThinkProvider.Model = {
+        Gpt5: "gpt-5",
+        Gpt5Mini: "gpt-5-mini",
+        Gpt5Nano: "gpt-5-nano",
+        Gpt41: "gpt-4.1",
+        Gpt41Mini: "gpt-4.1-mini",
+        Gpt41Nano: "gpt-4.1-nano",
+        Gpt4O: "gpt-4o",
+        Gpt4OMini: "gpt-4o-mini",
+    };
+})(OpenAiThinkProvider || (exports.OpenAiThinkProvider = OpenAiThinkProvider = {}));

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

@@ -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;
 }

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

@@ -1,36 +1,36 @@
 export interface ReadV1ResponseMetadata {
-    metadata?: ReadV1ResponseMetadata.Metadata;
+    metadata?: ReadV1ResponseMetadata.Metadata | undefined;
 }
 export declare namespace ReadV1ResponseMetadata {
     interface Metadata {
-        request_id?: string;
-        created?: string;
-        language?: string;
-        summary_info?: Metadata.SummaryInfo;
-        sentiment_info?: Metadata.SentimentInfo;
-        topics_info?: Metadata.TopicsInfo;
-        intents_info?: Metadata.IntentsInfo;
+        request_id?: string | undefined;
+        created?: string | undefined;
+        language?: string | undefined;
+        summary_info?: Metadata.SummaryInfo | undefined;
+        sentiment_info?: Metadata.SentimentInfo | undefined;
+        topics_info?: Metadata.TopicsInfo | undefined;
+        intents_info?: Metadata.IntentsInfo | undefined;
     }
     namespace Metadata {
         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/cjs/api/types/ReadV1ResponseResults.d.ts

@@ -1,7 +1,7 @@
 import type * as Deepgram from "../index.js";
 export interface ReadV1ResponseResults {
-    summary?: Deepgram.ReadV1ResponseResultsSummary;
-    topics?: Deepgram.SharedTopics;
-    intents?: Deepgram.SharedIntents;
-    sentiments?: Deepgram.SharedSentiments;
+    summary?: Deepgram.ReadV1ResponseResultsSummary | undefined;
+    topics?: Deepgram.SharedTopics | undefined;
+    intents?: Deepgram.SharedIntents | undefined;
+    sentiments?: Deepgram.SharedSentiments | undefined;
 }

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

@@ -2,15 +2,15 @@
  * Output whenever `summary=true` is used
  */
 export interface ReadV1ResponseResultsSummary {
-    results?: ReadV1ResponseResultsSummary.Results;
+    results?: ReadV1ResponseResultsSummary.Results | undefined;
 }
 export declare namespace ReadV1ResponseResultsSummary {
     interface Results {
-        summary?: Results.Summary;
+        summary?: Results.Summary | undefined;
     }
     namespace Results {
         interface Summary {
-            text?: string;
+            text?: string | undefined;
         }
     }
 }

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

@@ -2,31 +2,31 @@
  * Output whenever `intents=true` is used
  */
 export interface SharedIntents {
-    results?: SharedIntents.Results;
+    results?: SharedIntents.Results | undefined;
 }
 export declare namespace SharedIntents {
     interface Results {
-        intents?: Results.Intents;
+        intents?: Results.Intents | undefined;
     }
     namespace Results {
         interface Intents {
-            segments?: Intents.Segments.Item[];
+            segments?: Intents.Segments.Item[] | undefined;
         }
         namespace Intents {
             type Segments = Segments.Item[];
             namespace Segments {
                 interface Item {
-                    text?: string;
-                    start_word?: number;
-                    end_word?: number;
-                    intents?: Item.Intents.Item[];
+                    text?: string | undefined;
+                    start_word?: number | undefined;
+                    end_word?: number | undefined;
+                    intents?: Item.Intents.Item[] | undefined;
                 }
                 namespace Item {
                     type Intents = Intents.Item[];
                     namespace Intents {
                         interface Item {
-                            intent?: string;
-                            confidence_score?: number;
+                            intent?: string | undefined;
+                            confidence_score?: number | undefined;
                         }
                     }
                 }

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

@@ -2,22 +2,22 @@
  * Output whenever `sentiment=true` is used
  */
 export interface SharedSentiments {
-    segments?: SharedSentiments.Segments.Item[];
-    average?: SharedSentiments.Average;
+    segments?: SharedSentiments.Segments.Item[] | undefined;
+    average?: SharedSentiments.Average | undefined;
 }
 export declare namespace SharedSentiments {
     type Segments = Segments.Item[];
     namespace Segments {
         interface Item {
-            text?: string;
-            start_word?: number;
-            end_word?: number;
-            sentiment?: string;
-            sentiment_score?: number;
+            text?: string | undefined;
+            start_word?: number | undefined;
+            end_word?: number | undefined;
+            sentiment?: string | undefined;
+            sentiment_score?: number | undefined;
         }
     }
     interface Average {
-        sentiment?: string;
-        sentiment_score?: number;
+        sentiment?: string | undefined;
+        sentiment_score?: number | undefined;
     }
 }

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

@@ -2,31 +2,31 @@
  * Output whenever `topics=true` is used
  */
 export interface SharedTopics {
-    results?: SharedTopics.Results;
+    results?: SharedTopics.Results | undefined;
 }
 export declare namespace SharedTopics {
     interface Results {
-        topics?: Results.Topics;
+        topics?: Results.Topics | undefined;
     }
     namespace Results {
         interface Topics {
-            segments?: Topics.Segments.Item[];
+            segments?: Topics.Segments.Item[] | undefined;
         }
         namespace Topics {
             type Segments = Segments.Item[];
             namespace Segments {
                 interface Item {
-                    text?: string;
-                    start_word?: number;
-                    end_word?: number;
-                    topics?: Item.Topics.Item[];
+                    text?: string | undefined;
+                    start_word?: number | undefined;
+                    end_word?: number | undefined;
+                    topics?: Item.Topics.Item[] | undefined;
                 }
                 namespace Item {
                     type Topics = Topics.Item[];
                     namespace Topics {
                         interface Item {
-                            topic?: string;
-                            confidence_score?: number;
+                            topic?: string | undefined;
+                            confidence_score?: number | undefined;
                         }
                     }
                 }

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

@@ -5,7 +5,7 @@ export interface SpeakSettingsV1 {
      * Optional if provider is Deepgram. Required for non-Deepgram TTS providers.
      * When present, must include url field and headers object. Valid schemes are https and wss with wss only supported for Eleven Labs.
      */
-    endpoint?: SpeakSettingsV1.Endpoint;
+    endpoint?: SpeakSettingsV1.Endpoint | undefined;
 }
 export declare namespace SpeakSettingsV1 {
     /**
@@ -14,7 +14,7 @@ export declare namespace SpeakSettingsV1 {
      */
     interface Endpoint {
         /** Custom TTS endpoint URL. Cannot contain `output_format` or `model_id` query parameters when the provider is Eleven Labs. */
-        url?: string;
-        headers?: Record<string, string>;
+        url?: string | undefined;
+        headers?: Record<string, string> | undefined;
     }
 }

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

@@ -10,7 +10,7 @@ export declare namespace SpeakSettingsV1Provider {
     interface Cartesia extends Deepgram.Cartesia {
         type: "cartesia";
     }
-    interface OpenAi extends Deepgram.OpenAi {
+    interface OpenAi extends Deepgram.OpenAiSpeakProvider {
         type: "open_ai";
     }
     interface AwsPolly extends Deepgram.AwsPollySpeakProvider {

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

@@ -1,12 +1,12 @@
+import type * as Deepgram from "../index.js";
 export interface ThinkSettingsV1 {
-    /** Think provider configuration (OpenAI, AWS Bedrock, Anthropic, Google, or Groq) */
-    provider: Record<string, unknown>;
+    provider: Deepgram.ThinkSettingsV1Provider;
     /** Optional for non-Deepgram LLM providers. When present, must include url field and headers object */
-    endpoint?: ThinkSettingsV1.Endpoint;
-    functions?: ThinkSettingsV1.Functions.Item[];
-    prompt?: string;
+    endpoint?: ThinkSettingsV1.Endpoint | undefined;
+    functions?: ThinkSettingsV1.Functions.Item[] | undefined;
+    prompt?: string | undefined;
     /** Specifies the number of characters retained in context between user messages, agent responses, and function calls. This setting is only configurable when a custom think endpoint is used */
-    context_length?: ThinkSettingsV1.ContextLength;
+    context_length?: ThinkSettingsV1.ContextLength | undefined;
 }
 export declare namespace ThinkSettingsV1 {
     /**
@@ -14,21 +14,21 @@ export declare namespace ThinkSettingsV1 {
      */
     interface Endpoint {
         /** Custom LLM endpoint URL */
-        url?: string;
+        url?: string | undefined;
         /** Custom headers for the endpoint */
-        headers?: Record<string, string>;
+        headers?: Record<string, string> | undefined;
     }
     type Functions = Functions.Item[];
     namespace Functions {
         interface Item {
             /** Function name */
-            name?: string;
+            name?: string | undefined;
             /** Function description */
-            description?: string;
+            description?: string | undefined;
             /** Function parameters */
-            parameters?: Record<string, unknown>;
+            parameters?: Record<string, unknown> | undefined;
             /** The Function endpoint to call. if not passed, function is called client-side */
-            endpoint?: Item.Endpoint;
+            endpoint?: Item.Endpoint | undefined;
         }
         namespace Item {
             /**
@@ -36,10 +36,10 @@ export declare namespace ThinkSettingsV1 {
              */
             interface Endpoint {
                 /** Endpoint URL */
-                url?: string;
+                url?: string | undefined;
                 /** HTTP method */
-                method?: string;
-                headers?: Record<string, string>;
+                method?: string | undefined;
+                headers?: Record<string, string> | undefined;
             }
         }
     }

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

@@ -0,0 +1,19 @@
+import type * as Deepgram from "../index.js";
+export type ThinkSettingsV1Provider = Deepgram.ThinkSettingsV1Provider.OpenAi | Deepgram.ThinkSettingsV1Provider.AwsBedrock | Deepgram.ThinkSettingsV1Provider.Anthropic | Deepgram.ThinkSettingsV1Provider.Google | Deepgram.ThinkSettingsV1Provider.Groq;
+export declare namespace ThinkSettingsV1Provider {
+    interface OpenAi extends Deepgram.OpenAiThinkProvider {
+        type: "open_ai";
+    }
+    interface AwsBedrock extends Deepgram.AwsBedrockThinkProvider {
+        type: "aws_bedrock";
+    }
+    interface Anthropic extends Deepgram.Anthropic {
+        type: "anthropic";
+    }
+    interface Google extends Deepgram.Google {
+        type: "google";
+    }
+    interface Groq extends Deepgram.Groq {
+        type: "groq";
+    }
+}

package/dist/cjs/api/types/ThinkSettingsV1Provider.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/UpdateProjectMemberScopesV1Response.d.ts

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

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

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