assemblyai 3.0.1 → 3.1.1

package/src/types/services/abstractions.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>;
 }
 
 /**

package/src/types/services/index.ts

@@ -3,5 +3,5 @@ type BaseServiceParams = {
   baseUrl?: string;
 };
 
-export type * from "./abstractions";
+export * from "./abstractions";
 export type { BaseServiceParams };

package/src/types/transcripts/index.ts

@@ -1,5 +1,46 @@
-export type CreateTranscriptOptions = {
-  poll?: boolean;
+import { FileUploadParams } from "../files";
+import { TranscriptParams } from "../openapi.generated";
+
+export type PollingOptions = {
+  /**
+   * The amount of time to wait between polling requests.
+   * @default 3000 or every 3 seconds
+   */
   pollingInterval?: number;
+  /**
+   * The maximum amount of time to wait for the transcript to be ready.
+   * @default -1 which means wait forever
+   */
   pollingTimeout?: number;
 };
+
+export type CreateTranscriptOptions = {
+  /**
+   * Whether to poll the transcript until it is ready.
+   * @default true
+   */
+  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;