assemblyai 4.3.1 → 4.3.3

package/src/types/services/index.ts

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

package/src/types/transcripts/index.ts

@@ -1,23 +1,29 @@
 import { FileUploadParams } from "../files";
 import { TranscriptParams } from "../openapi.generated";
 
+/**
+ * Options for polling.
+ */
 export type PollingOptions = {
   /**
    * The amount of time to wait between polling requests.
-   * @default 3000 or every 3 seconds
+   * @defaultValue 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
+   * @defaultValue -1 which means wait forever
    */
   pollingTimeout?: number;
 };
 
+/**
+ * @deprecated Use `TranscriptService.transcribe` with `TranscribeOptions`.
+ */
 export type CreateTranscriptOptions = {
   /**
    * Whether to poll the transcript until it is ready.
-   * @default true
+   * @defaultValue true
    */
   poll?: boolean;
 } & PollingOptions;
@@ -30,10 +36,14 @@ export type AudioToTranscribe = FileUploadParams;
 /**
  * The parameters to transcribe an audio file.
  */
-export type TranscribeParams = { audio: AudioToTranscribe } & Omit<
-  TranscriptParams,
-  "audio_url"
->;
+export type TranscribeParams =
+  | ({
+      /**
+       * The audio to transcribe. This can be a public URL, a local file path, a readable file stream, or a file buffer.
+       */
+      audio: AudioToTranscribe;
+    } & Omit<TranscriptParams, "audio_url">)
+  | TranscriptParams;
 
 /**
  * The parameters to start the transcription of an audio file.

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

@@ -1,52 +0,0 @@
-/**
- * Interface for classes that can create resources.
- * @template T The type of the resource.
- * @template Params The type of the parameters required to create the resource.
- */
-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: Params, options?: Options): Promise<T>;
-}
-/**
- * Interface for classes that can retrieve resources.
- * @template T The type of the resource.
- * @template Id The type of the resource's identifier. Defaults to string.
- */
-interface Retrieveable<T, Id = string> {
-    /**
-     * Get a resource.
-     * @param id The identifier of the resource to retrieve.
-     * @return A promise that resolves to the retrieved resource.
-     */
-    get(id: Id): Promise<T>;
-}
-/**
- * Interface for classes that can delete resources.
- * @template T The type of the resource.
- * @template Id The type of the resource's identifier. Defaults to string.
- */
-interface Deletable<T, Id = string> {
-    /**
-     * Delete a resource.
-     * @param id The identifier of the resource to delete.
-     * @return A promise that resolves to a boolean indicating whether the deletion was successful.
-     */
-    delete(id: Id): Promise<T>;
-}
-/**
- * Interface for classes that can list resources.
- * @template T The type of the resource.
- */
-interface Listable<T, Page = string> {
-    /**
-     * List all resources.
-     * @return A promise that resolves to an array of resources.
-     */
-    list(page?: Page): Promise<T>;
-}
-export type { Createable, Retrieveable, Deletable, Listable };

package/src/types/services/abstractions.ts

@@ -1,56 +0,0 @@
-/**
- * Interface for classes that can create resources.
- * @template T The type of the resource.
- * @template Params The type of the parameters required to create the resource.
- */
-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: Params, options?: Options): Promise<T>;
-}
-
-/**
- * Interface for classes that can retrieve resources.
- * @template T The type of the resource.
- * @template Id The type of the resource's identifier. Defaults to string.
- */
-interface Retrieveable<T, Id = string> {
-  /**
-   * Get a resource.
-   * @param id The identifier of the resource to retrieve.
-   * @return A promise that resolves to the retrieved resource.
-   */
-  get(id: Id): Promise<T>;
-}
-
-/**
- * Interface for classes that can delete resources.
- * @template T The type of the resource.
- * @template Id The type of the resource's identifier. Defaults to string.
- */
-interface Deletable<T, Id = string> {
-  /**
-   * Delete a resource.
-   * @param id The identifier of the resource to delete.
-   * @return A promise that resolves to a boolean indicating whether the deletion was successful.
-   */
-  delete(id: Id): Promise<T>;
-}
-
-/**
- * Interface for classes that can list resources.
- * @template T The type of the resource.
- */
-interface Listable<T, Page = string> {
-  /**
-   * List all resources.
-   * @return A promise that resolves to an array of resources.
-   */
-  list(page?: Page): Promise<T>;
-}
-
-export type { Createable, Retrieveable, Deletable, Listable };