assemblyai 3.1.0 → 3.1.2

package/dist/types/openapi.generated.d.ts

@@ -86,113 +86,10 @@ export type ContentSafetyLabelsResult = {
         [key: string]: number;
     };
 };
-export type CreateRealtimeTemporaryTokenParameters = {
+export type CreateRealtimeTemporaryTokenParams = {
     /** @description The amount of time until the token expires in seconds */
     expires_in: number;
 };
-/** @description The parameters for creating a transcript */
-export type CreateTranscriptOptionalParameters = {
-    /** @description The point in time, in milliseconds, to stop transcribing in your media file */
-    audio_end_at?: number;
-    /** @description The point in time, in milliseconds, to begin transcribing in your media file */
-    audio_start_from?: number;
-    /** @description Enable [Auto Chapters](https://www.assemblyai.com/docs/Models/auto_chapters), can be true or false */
-    auto_chapters?: boolean;
-    /** @description Whether Key Phrases is enabled, either true or false */
-    auto_highlights?: boolean;
-    /** @description The word boost parameter value */
-    boost_param?: TranscriptBoostParam;
-    /** @description Enable [Content Moderation](https://www.assemblyai.com/docs/Models/content_moderation), can be true or false */
-    content_safety?: boolean;
-    /** @description Customize how words are spelled and formatted using to and from values */
-    custom_spelling?: TranscriptCustomSpelling[];
-    /** @description Whether custom topics is enabled, either true or false */
-    custom_topics?: boolean;
-    /** @description Transcribe Filler Words, like "umm", in your media file; can be true or false */
-    disfluencies?: boolean;
-    /** @description Enable [Dual Channel](https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription) transcription, can be true or false */
-    dual_channel?: boolean;
-    /** @description Enable [Entity Detection](https://www.assemblyai.com/docs/Models/entity_detection), can be true or false */
-    entity_detection?: boolean;
-    /** @description Filter profanity from the transcribed text, can be true or false */
-    filter_profanity?: boolean;
-    /** @description Enable Text Formatting, can be true or false */
-    format_text?: boolean;
-    /** @description Enable [Topic Detection](https://www.assemblyai.com/docs/Models/iab_classification), can be true or false */
-    iab_categories?: boolean;
-    /**
-     * @description The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/Concepts/supported_languages).
-     * The default value is 'en_us'.
-     */
-    language_code?: TranscriptLanguageCode | null;
-    /** @description Whether [Automatic language detection](https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection) is enabled, either true or false */
-    language_detection?: boolean;
-    /** @description Enable Automatic Punctuation, can be true or false */
-    punctuate?: boolean;
-    /** @description Redact PII from the transcribed text using the Redact PII model, can be true or false */
-    redact_pii?: boolean;
-    /** @description Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/Models/pii_redaction) for more details. */
-    redact_pii_audio?: boolean;
-    /**
-     * @description Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/Models/pii_redaction) for more details.
-     * @default mp3
-     */
-    redact_pii_audio_quality?: string;
-    /** @description The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/Models/pii_redaction) for more details. */
-    redact_pii_policies?: PiiPolicy[];
-    /** @description The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/Models/pii_redaction) for more details. */
-    redact_pii_sub?: SubstitutionPolicy | null;
-    /** @description Enable [Sentiment Analysis](https://www.assemblyai.com/docs/Models/sentiment_analysis), can be true or false */
-    sentiment_analysis?: boolean;
-    /** @description Enable [Speaker diarization](https://www.assemblyai.com/docs/Models/speaker_diarization), can be true or false */
-    speaker_labels?: boolean;
-    /**
-     * @description Tell the speaker label model how many speakers it should attempt to identify, up to 10. See [Speaker diarization](https://www.assemblyai.com/docs/Models/speaker_diarization) for more details.
-     * @default null
-     */
-    speakers_expected?: number | null;
-    /**
-     * Format: float
-     * @description Reject audio files that contain less than this fraction of speech.
-     * Valid values are in the range [0, 1] inclusive.
-     *
-     * @default null
-     */
-    speech_threshold?: number | null;
-    /** @description Enable [Summarization](https://www.assemblyai.com/docs/Models/summarization), can be true or false */
-    summarization?: boolean;
-    /**
-     * @description The model to summarize the transcript
-     * @default informative
-     */
-    summary_model?: SummaryModel;
-    /**
-     * @description The type of summary
-     * @default bullets
-     */
-    summary_type?: SummaryType;
-    /** @description The list of custom topics provided, if custom topics is enabled */
-    topics?: string[];
-    /**
-     * @description The header name which should be sent back with webhook calls
-     * @default null
-     */
-    webhook_auth_header_name?: string | null;
-    /**
-     * @description Specify a header name and value to send back with a webhook call for added security
-     * @default null
-     */
-    webhook_auth_header_value?: string | null;
-    /** @description The URL to which AssemblyAI send webhooks upon trancription completion */
-    webhook_url?: string;
-    /** @description The list of custom vocabulary to boost transcription probability for */
-    word_boost?: string[];
-};
-/** @description The parameters for creating a transcript */
-export type CreateTranscriptParameters = CreateTranscriptOptionalParameters & {
-    /** @description The URL of the audio or video file to transcribe. */
-    audio_url: string;
-};
 /** @description A detected entity */
 export type Entity = {
     /** @description The ending time, in milliseconds, for the detected entity in the audio file */
@@ -215,12 +112,12 @@ export type Error = {
     /** @constant */
     status?: "error";
 };
-export type LemurActionItemsParameters = LemurBaseParameters;
+export type LemurActionItemsParams = LemurBaseParams;
 export type LemurActionItemsResponse = LemurBaseResponse & {
     /** @description The response generated by LeMUR */
     response: string;
 };
-export type LemurBaseParameters = {
+export type LemurBaseParams = {
     /** @description Context to provide the model. This can be a string or a free-form JSON value. */
     context?: OneOf<[
         string,
@@ -281,7 +178,7 @@ export type LemurQuestionAnswer = {
     /** @description The question for LeMUR to answer */
     question: string;
 };
-export type LemurQuestionAnswerParameters = LemurBaseParameters & {
+export type LemurQuestionAnswerParams = LemurBaseParams & {
     /** @description A list of questions to ask */
     questions: LemurQuestion[];
 };
@@ -289,7 +186,7 @@ export type LemurQuestionAnswerResponse = LemurBaseResponse & {
     /** @description The answers generated by LeMUR and their questions */
     response: LemurQuestionAnswer[];
 };
-export type LemurSummaryParameters = LemurBaseParameters & {
+export type LemurSummaryParams = LemurBaseParams & {
     /** @description How you want the summary to be returned. This can be any text. Examples: "TLDR", "bullet points" */
     answer_format?: string;
 };
@@ -297,7 +194,7 @@ export type LemurSummaryResponse = LemurBaseResponse & {
     /** @description The response generated by LeMUR */
     response: string;
 };
-export type LemurTaskParameters = LemurBaseParameters & {
+export type LemurTaskParams = LemurBaseParams & {
     /** @description Your text to prompt the model to produce a desired output, including any context you want to pass into the model. */
     prompt: string;
 };
@@ -305,6 +202,27 @@ export type LemurTaskResponse = LemurBaseResponse & {
     /** @description The response generated by LeMUR */
     response: string;
 };
+export type ListTranscriptParams = {
+    /** @description Get transcripts that were created after this transcript ID */
+    after_id?: string;
+    /** @description Get transcripts that were created before this transcript ID */
+    before_id?: string;
+    /**
+     * Format: date
+     * @description Only get transcripts created on this date
+     */
+    created_on?: string;
+    /**
+     * Format: int64
+     * @description Maximum amount of transcripts to retrieve
+     * @default 10
+     */
+    limit?: number;
+    /** @description Filter by transcript status */
+    status?: TranscriptStatus;
+    /** @description Only get throttled transcripts, overrides the status filter */
+    throttled_only?: boolean;
+};
 export type PageDetails = {
     current_url: string;
     limit: number;
@@ -638,26 +556,103 @@ export type TranscriptListItem = {
     resource_url: string;
     status: TranscriptStatus;
 };
-export type TranscriptListParameters = {
-    /** @description Get transcripts that were created after this transcript ID */
-    after_id?: string;
-    /** @description Get transcripts that were created before this transcript ID */
-    before_id?: string;
+/** @description The parameters for creating a transcript */
+export type TranscriptOptionalParams = {
+    /** @description The point in time, in milliseconds, to stop transcribing in your media file */
+    audio_end_at?: number;
+    /** @description The point in time, in milliseconds, to begin transcribing in your media file */
+    audio_start_from?: number;
+    /** @description Enable [Auto Chapters](https://www.assemblyai.com/docs/Models/auto_chapters), can be true or false */
+    auto_chapters?: boolean;
+    /** @description Whether Key Phrases is enabled, either true or false */
+    auto_highlights?: boolean;
+    /** @description The word boost parameter value */
+    boost_param?: TranscriptBoostParam;
+    /** @description Enable [Content Moderation](https://www.assemblyai.com/docs/Models/content_moderation), can be true or false */
+    content_safety?: boolean;
+    /** @description Customize how words are spelled and formatted using to and from values */
+    custom_spelling?: TranscriptCustomSpelling[];
+    /** @description Whether custom topics is enabled, either true or false */
+    custom_topics?: boolean;
+    /** @description Transcribe Filler Words, like "umm", in your media file; can be true or false */
+    disfluencies?: boolean;
+    /** @description Enable [Dual Channel](https://assemblyai.com/docs/Models/speech_recognition#dual-channel-transcription) transcription, can be true or false */
+    dual_channel?: boolean;
+    /** @description Enable [Entity Detection](https://www.assemblyai.com/docs/Models/entity_detection), can be true or false */
+    entity_detection?: boolean;
+    /** @description Filter profanity from the transcribed text, can be true or false */
+    filter_profanity?: boolean;
+    /** @description Enable Text Formatting, can be true or false */
+    format_text?: boolean;
+    /** @description Enable [Topic Detection](https://www.assemblyai.com/docs/Models/iab_classification), can be true or false */
+    iab_categories?: boolean;
     /**
-     * Format: date
-     * @description Only get transcripts created on this date
+     * @description The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/Concepts/supported_languages).
+     * The default value is 'en_us'.
      */
-    created_on?: string;
+    language_code?: TranscriptLanguageCode | null;
+    /** @description Whether [Automatic language detection](https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection) is enabled, either true or false */
+    language_detection?: boolean;
+    /** @description Enable Automatic Punctuation, can be true or false */
+    punctuate?: boolean;
+    /** @description Redact PII from the transcribed text using the Redact PII model, can be true or false */
+    redact_pii?: boolean;
+    /** @description Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/Models/pii_redaction) for more details. */
+    redact_pii_audio?: boolean;
     /**
-     * Format: int64
-     * @description Maximum amount of transcripts to retrieve
-     * @default 10
+     * @description Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/Models/pii_redaction) for more details.
+     * @default mp3
      */
-    limit?: number;
-    /** @description Filter by transcript status */
-    status?: TranscriptStatus;
-    /** @description Only get throttled transcripts, overrides the status filter */
-    throttled_only?: boolean;
+    redact_pii_audio_quality?: string;
+    /** @description The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/Models/pii_redaction) for more details. */
+    redact_pii_policies?: PiiPolicy[];
+    /** @description The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/Models/pii_redaction) for more details. */
+    redact_pii_sub?: SubstitutionPolicy | null;
+    /** @description Enable [Sentiment Analysis](https://www.assemblyai.com/docs/Models/sentiment_analysis), can be true or false */
+    sentiment_analysis?: boolean;
+    /** @description Enable [Speaker diarization](https://www.assemblyai.com/docs/Models/speaker_diarization), can be true or false */
+    speaker_labels?: boolean;
+    /**
+     * @description Tell the speaker label model how many speakers it should attempt to identify, up to 10. See [Speaker diarization](https://www.assemblyai.com/docs/Models/speaker_diarization) for more details.
+     * @default null
+     */
+    speakers_expected?: number | null;
+    /**
+     * Format: float
+     * @description Reject audio files that contain less than this fraction of speech.
+     * Valid values are in the range [0, 1] inclusive.
+     *
+     * @default null
+     */
+    speech_threshold?: number | null;
+    /** @description Enable [Summarization](https://www.assemblyai.com/docs/Models/summarization), can be true or false */
+    summarization?: boolean;
+    /**
+     * @description The model to summarize the transcript
+     * @default informative
+     */
+    summary_model?: SummaryModel;
+    /**
+     * @description The type of summary
+     * @default bullets
+     */
+    summary_type?: SummaryType;
+    /** @description The list of custom topics provided, if custom topics is enabled */
+    topics?: string[];
+    /**
+     * @description The header name which should be sent back with webhook calls
+     * @default null
+     */
+    webhook_auth_header_name?: string | null;
+    /**
+     * @description Specify a header name and value to send back with a webhook call for added security
+     * @default null
+     */
+    webhook_auth_header_value?: string | null;
+    /** @description The URL to which AssemblyAI send webhooks upon trancription completion */
+    webhook_url?: string;
+    /** @description The list of custom vocabulary to boost transcription probability for */
+    word_boost?: string[];
 };
 export type TranscriptParagraph = {
     /** Format: double */
@@ -667,6 +662,11 @@ export type TranscriptParagraph = {
     text: string;
     words: TranscriptWord[];
 };
+/** @description The parameters for creating a transcript */
+export type TranscriptParams = TranscriptOptionalParams & {
+    /** @description The URL of the audio or video file to transcribe. */
+    audio_url: string;
+};
 export type TranscriptSentence = {
     /** Format: double */
     confidence: number;

package/dist/types/services/abstractions.d.ts

@@ -1,16 +1,16 @@
 /**
  * Interface for classes that can create resources.
  * @template T The type of the resource.
- * @template Parameters The type of the parameters required to create the resource.
+ * @template Params The type of the parameters required to create the resource.
  */
-interface Createable<T, Parameters, Options = Record<string, unknown>> {
+interface Createable<T, Params, Options = Record<string, unknown>> {
     /**
      * Create a new resource.
      * @param params The parameters of the new resource.
      * @param options The options used for creating the new resource.
      * @return A promise that resolves to the newly created resource.
      */
-    create(params: Parameters, options?: Options): Promise<T>;
+    create(params: Params, options?: Options): Promise<T>;
 }
 /**
  * Interface for classes that can retrieve resources.

package/dist/types/transcripts/index.d.ts

@@ -1,3 +1,5 @@
+import { FileUploadParams } from "../files";
+import { TranscriptParams } from "../openapi.generated";
 export type PollingOptions = {
     /**
      * The amount of time to wait between polling requests.
@@ -17,3 +19,21 @@ export type CreateTranscriptOptions = {
      */
     poll?: boolean;
 } & PollingOptions;
+/**
+ * The audio to transcribe. This can be a public URL, a local file path, a readable file stream, or a file buffer.
+ */
+export type AudioToTranscribe = FileUploadParams;
+/**
+ * The parameters to transcribe an audio file.
+ */
+export type TranscribeParams = {
+    audio: AudioToTranscribe;
+} & Omit<TranscriptParams, "audio_url">;
+/**
+ * The parameters to start the transcription of an audio file.
+ */
+export type SubmitParams = TranscribeParams;
+/**
+ * The options to transcribe an audio file, including polling options.
+ */
+export type TranscribeOptions = PollingOptions;

package/package.json

@@ -1,11 +1,17 @@
 {
   "name": "assemblyai",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "description": "The AssemblyAI Node.js SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async and real-time transcription, as well as the latest LeMUR models.",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "typings": "dist/index.d.ts",
+  "exports": {
+    "require": "./dist/index.js",
+    "import": "./dist/index.esm.js",
+    "node": "./dist/index.js",
+    "default": "./dist/index.js"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AssemblyAI/assemblyai-node-sdk.git"
@@ -18,10 +24,10 @@
   "scripts": {
     "build": "pnpm clean && pnpm rollup -c",
     "clean": "rimraf dist",
-    "lint": "eslint -c .eslintrc.json 'src/**/*'",
+    "lint": "eslint -c .eslintrc.json '{src,tests}/**/*.{js,ts}'",
     "test": "pnpm lint && pnpm test:unit",
     "test:unit": "jest --config jest.config.rollup.ts",
-    "format": "prettier --write 'src/**/*.ts'",
+    "format": "prettier '**/*' --write",
     "generate-types": "tsx ./scripts/generate-types.ts && pnpm format",
     "copybara:dry-run": "./copybara.sh dry_run --init-history",
     "copybara:pr": "./copybara.sh sync_out --init-history"
@@ -38,8 +44,7 @@
   "homepage": "https://www.assemblyai.com/docs",
   "files": [
     "dist",
-    "src",
-    "types"
+    "src"
   ],
   "devDependencies": {
     "@types/jest": "^29.5.5",

package/src/services/files/index.ts

@@ -2,7 +2,7 @@
 // to keep the assemblyai module more compatible. Some fs polyfills don't include `createReadStream`.
 import fs from "fs";
 import { BaseService } from "../base";
-import { UploadedFile, FileUploadParameters, FileUploadData } from "../..";
+import { UploadedFile, FileUploadParams, FileUploadData } from "../..";
 
 export class FileService extends BaseService {
   /**
@@ -10,7 +10,7 @@ export class FileService extends BaseService {
    * @param input The local file path to upload, or a stream or buffer of the file to upload.
    * @return A promise that resolves to the uploaded file URL.
    */
-  async upload(input: FileUploadParameters): Promise<string> {
+  async upload(input: FileUploadParams): Promise<string> {
     let fileData: FileUploadData;
     if (typeof input === "string") fileData = fs.createReadStream(input);
     else fileData = input;

package/src/services/lemur/index.ts

@@ -1,8 +1,8 @@
 import {
-  LemurSummaryParameters,
-  LemurActionItemsParameters,
-  LemurQuestionAnswerParameters,
-  LemurTaskParameters,
+  LemurSummaryParams,
+  LemurActionItemsParams,
+  LemurQuestionAnswerParams,
+  LemurTaskParams,
   LemurSummaryResponse,
   LemurQuestionAnswerResponse,
   LemurActionItemsResponse,
@@ -12,7 +12,7 @@ import {
 import { BaseService } from "../base";
 
 export class LemurService extends BaseService {
-  summary(params: LemurSummaryParameters): Promise<LemurSummaryResponse> {
+  summary(params: LemurSummaryParams): Promise<LemurSummaryResponse> {
     return this.fetchJson<LemurSummaryResponse>("/lemur/v3/generate/summary", {
       method: "POST",
       body: JSON.stringify(params),
@@ -20,7 +20,7 @@ export class LemurService extends BaseService {
   }
 
   questionAnswer(
-    params: LemurQuestionAnswerParameters
+    params: LemurQuestionAnswerParams
   ): Promise<LemurQuestionAnswerResponse> {
     return this.fetchJson<LemurQuestionAnswerResponse>(
       "/lemur/v3/generate/question-answer",
@@ -32,7 +32,7 @@ export class LemurService extends BaseService {
   }
 
   actionItems(
-    params: LemurActionItemsParameters
+    params: LemurActionItemsParams
   ): Promise<LemurActionItemsResponse> {
     return this.fetchJson<LemurActionItemsResponse>(
       "/lemur/v3/generate/action-items",
@@ -43,7 +43,7 @@ export class LemurService extends BaseService {
     );
   }
 
-  task(params: LemurTaskParameters): Promise<LemurTaskResponse> {
+  task(params: LemurTaskParams): Promise<LemurTaskResponse> {
     return this.fetchJson<LemurTaskResponse>("/lemur/v3/generate/task", {
       method: "POST",
       body: JSON.stringify(params),

package/src/services/transcripts/index.ts

@@ -4,7 +4,7 @@ import {
   SentencesResponse,
   Transcript,
   TranscriptList,
-  CreateTranscriptParameters,
+  TranscriptParams,
   CreateTranscriptOptions,
   Createable,
   Deletable,
@@ -12,17 +12,20 @@ import {
   Retrieveable,
   SubtitleFormat,
   RedactedAudioResponse,
-  TranscriptListParameters,
+  ListTranscriptParams,
   WordSearchResponse,
   BaseServiceParams,
   PollingOptions,
+  TranscribeParams,
+  TranscribeOptions,
+  SubmitParams,
 } from "../..";
 import { FileService } from "../files";
 
 export class TranscriptService
   extends BaseService
   implements
-    Createable<Transcript, CreateTranscriptParameters, CreateTranscriptOptions>,
+    Createable<Transcript, TranscriptParams, CreateTranscriptOptions>,
     Retrieveable<Transcript>,
     Deletable<Transcript>,
     Listable<TranscriptList>
@@ -31,14 +34,58 @@ export class TranscriptService
     super(params);
   }
 
+  /**
+   * Transcribe an audio file. This will create a transcript and wait until the transcript status is "completed" or "error".
+   * @param params The parameters to transcribe an audio file.
+   * @param options The options to transcribe an audio file.
+   * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
+   */
+  async transcribe(
+    params: TranscribeParams,
+    options?: TranscribeOptions
+  ): Promise<Transcript> {
+    const transcript = await this.submit(params);
+    return await this.waitUntilReady(transcript.id, options);
+  }
+
+  /**
+   * Submits a transcription job for an audio file. This will not wait until the transcript status is "completed" or "error".
+   * @param params The parameters to start the transcription of an audio file.
+   * @returns A promise that resolves to the queued transcript.
+   */
+  async submit(params: SubmitParams): Promise<Transcript> {
+    const { audio, ...createParams } = params;
+    let audioUrl;
+    if (typeof audio === "string") {
+      const path = getPath(audio);
+      if (path !== null) {
+        // audio is local path, upload local file
+        audioUrl = await this.files.upload(path);
+      } else {
+        // audio is not a local path, assume it's a URL
+        audioUrl = audio;
+      }
+    } else {
+      // audio is of uploadable type
+      audioUrl = await this.files.upload(audio);
+    }
+
+    const data = await this.fetchJson<Transcript>("/v2/transcript", {
+      method: "POST",
+      body: JSON.stringify({ ...createParams, audio_url: audioUrl }),
+    });
+    return data;
+  }
+
   /**
    * Create a transcript.
    * @param params The parameters to create a transcript.
    * @param options The options used for creating the new transcript.
-   * @returns A promise that resolves to the newly created transcript.
+   * @returns A promise that resolves to the transcript.
+   * @deprecated Use `transcribe` instead to transcribe a audio file that includes polling, or `submit` to transcribe a audio file without polling.
    */
   async create(
-    params: CreateTranscriptParameters,
+    params: TranscriptParams,
     options?: CreateTranscriptOptions
   ): Promise<Transcript> {
     const path = getPath(params.audio_url);
@@ -59,6 +106,12 @@ export class TranscriptService
     return data;
   }
 
+  /**
+   * Wait until the transcript ready, either the status is "completed" or "error".
+   * @param transcriptId The ID of the transcript.
+   * @param options The options to wait until the transcript is ready.
+   * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
+   */
   async waitUntilReady(
     transcriptId: string,
     options?: PollingOptions
@@ -96,7 +149,7 @@ export class TranscriptService
    * @param parameters The parameters to filter the transcript list by, or the URL to retrieve the transcript list from.
    */
   async list(
-    parameters?: TranscriptListParameters | string
+    parameters?: ListTranscriptParams | string
   ): Promise<TranscriptList> {
     let url = "/v2/transcript";
     if (typeof parameters === "string") {
@@ -105,7 +158,7 @@ export class TranscriptService
       url = `${url}?${new URLSearchParams(
         Object.keys(parameters).map((key) => [
           key,
-          parameters[key as keyof TranscriptListParameters]?.toString() || "",
+          parameters[key as keyof ListTranscriptParams]?.toString() || "",
         ])
       )}`;
     }

package/src/types/deprecated.ts

@@ -0,0 +1,78 @@
+import { FileUploadParams } from "./files";
+import {
+  CreateRealtimeTemporaryTokenParams,
+  LemurActionItemsParams,
+  LemurBaseParams,
+  LemurQuestionAnswerParams,
+  LemurSummaryParams,
+  LemurTaskParams,
+  ListTranscriptParams,
+  TranscriptOptionalParams,
+  TranscriptParams,
+} from "./openapi.generated";
+import { SubmitParams, TranscribeParams } from "./transcripts";
+
+/**
+ * @deprecated
+ * Use`FileUploadParams` instead.
+ */
+export type FileUploadParameters = FileUploadParams;
+
+/**
+ * @deprecated
+ * Use`TranscribeParams` instead.
+ */
+export type TranscribeParameters = TranscribeParams;
+
+/**
+ * @deprecated
+ * Use`SubmitParams` instead.
+ */
+export type SubmitParameters = SubmitParams;
+
+/**
+ * @deprecated
+ * Use`CreateRealtimeTemporaryTokenParams` instead.
+ */
+export type CreateRealtimeTemporaryTokenParameters =
+  CreateRealtimeTemporaryTokenParams;
+/**
+ * @deprecated
+ * Use`LemurActionItemsParams` instead.
+ */
+export type LemurActionItemsParameters = LemurActionItemsParams;
+/**
+ * @deprecated
+ * Use`LemurBaseParams` instead.
+ */
+export type LemurBaseParameters = LemurBaseParams;
+/**
+ * @deprecated
+ * Use`LemurQuestionAnswerParams` instead.
+ */
+export type LemurQuestionAnswerParameters = LemurQuestionAnswerParams;
+/**
+ * @deprecated
+ * Use`LemurSummaryParams` instead.
+ */
+export type LemurSummaryParameters = LemurSummaryParams;
+/**
+ * @deprecated
+ * Use`LemurTaskParams` instead.
+ */
+export type LemurTaskParameters = LemurTaskParams;
+/**
+ * @deprecated
+ * Use`ListTranscriptParams` instead.
+ */
+export type TranscriptListParameters = ListTranscriptParams;
+/**
+ * @deprecated
+ * Use`TranscriptOptionalParams` instead.
+ */
+export type CreateTranscriptOptionalParameters = TranscriptOptionalParams;
+/**
+ * @deprecated
+ * Use`TranscriptParams` instead.
+ */
+export type CreateTranscriptParameters = TranscriptParams;