frameio 2.0.3 → 3.0.0

package/dist/esm/api/resources/comments/index.mjs

@@ -1,2 +1,2 @@
-export * from "./types/index.mjs";
 export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/comments/types/index.d.mts

@@ -1,2 +1,2 @@
-export * from "./CommentsShowRequestInclude.mjs";
 export * from "./CommentsIndexRequestInclude.mjs";
+export * from "./CommentsShowRequestInclude.mjs";

package/dist/esm/api/resources/comments/types/index.mjs

@@ -1,2 +1,2 @@
-export * from "./CommentsShowRequestInclude.mjs";
 export * from "./CommentsIndexRequestInclude.mjs";
+export * from "./CommentsShowRequestInclude.mjs";

package/dist/esm/api/resources/files/client/Client.d.mts

@@ -1,42 +1,25 @@
-import * as environments from "../../../../environments.mjs";
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as Frameio from "../../../index.mjs";
-export declare namespace Files {
-    interface Options {
-        environment?: core.Supplier<environments.FrameioEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        token: core.Supplier<core.BearerToken>;
-        /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Additional query string parameters to include in the request. */
-        queryParams?: Record<string, unknown>;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+export declare namespace FilesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
     }
 }
 /**
  * Manage Files and related operations.
  */
-export declare class Files {
-    protected readonly _options: Files.Options;
-    constructor(_options: Files.Options);
+export declare class FilesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<FilesClient.Options>;
+    constructor(options: FilesClient.Options);
     /**
      * List files in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
      * @param {Frameio.FilesListRequest} request
-     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -55,15 +38,17 @@ export declare class Files {
      *         include_total_count: false
      *     })
      */
-    list(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.FilesListRequest, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileAssetsWithIncludesResponse>;
+    list(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, request?: Frameio.FilesListRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileAssetsWithIncludesResponse>;
     private __list;
     /**
+     * @deprecated
+     *
      * Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
      * @param {Frameio.FileCreateParams} request
-     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -82,7 +67,7 @@ export declare class Files {
      *         }
      *     })
      */
-    create(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileCreateParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
+    create(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, request: Frameio.FileCreateParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
     private __create;
     /**
      * Show file details.
@@ -99,10 +84,10 @@ export declare class Files {
      * the response payload. In short, the client must handle null media links gracefully.
      * <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} fileId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} file_id
      * @param {Frameio.FilesShowRequest} request
-     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -117,14 +102,14 @@ export declare class Files {
      *         include: "media_links.original"
      *     })
      */
-    show(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request?: Frameio.FilesShowRequest, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileWithIncludesResponse>;
+    show(account_id: Frameio.Uuid, file_id: Frameio.Uuid, request?: Frameio.FilesShowRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileWithIncludesResponse>;
     private __show;
     /**
      * Delete file by ID. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} fileId -
-     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} file_id
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -137,15 +122,15 @@ export declare class Files {
      * @example
      *     await client.files.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
      */
-    delete(accountId: Frameio.Uuid, fileId: Frameio.Uuid, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<void>;
+    delete(account_id: Frameio.Uuid, file_id: Frameio.Uuid, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
      * Update file details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} fileId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} file_id
      * @param {Frameio.FileUpdateParams} request
-     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -162,15 +147,15 @@ export declare class Files {
      *         }
      *     })
      */
-    update(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request: Frameio.FileUpdateParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
+    update(account_id: Frameio.Uuid, file_id: Frameio.Uuid, request: Frameio.FileUpdateParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
     private __update;
     /**
      * Copy file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} fileId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} file_id
      * @param {Frameio.FileCopyParams} request
-     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -189,15 +174,15 @@ export declare class Files {
      *         }
      *     })
      */
-    copy(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request?: Frameio.FileCopyParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileCopyResponse>;
+    copy(account_id: Frameio.Uuid, file_id: Frameio.Uuid, request?: Frameio.FileCopyParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileCopyResponse>;
     private __copy;
     /**
      * Create new file under parent folder through remote upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
      * @param {Frameio.FileCreateRemoteUploadParams} request
-     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -215,15 +200,15 @@ export declare class Files {
      *         }
      *     })
      */
-    createRemoteUpload(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileCreateRemoteUploadParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileRemoteUploadResponse>;
+    createRemoteUpload(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, request: Frameio.FileCreateRemoteUploadParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileRemoteUploadResponse>;
     private __createRemoteUpload;
     /**
      * Move file to a folder or version_stack. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} fileId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} file_id
      * @param {Frameio.FileMoveParams} request
-     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -240,15 +225,15 @@ export declare class Files {
      *         }
      *     })
      */
-    move(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request: Frameio.FileMoveParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
+    move(account_id: Frameio.Uuid, file_id: Frameio.Uuid, request: Frameio.FileMoveParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
     private __move;
     /**
      * Create new file under parent folder through local upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
      * @param {Frameio.FileCreateLocalUploadParams} request
-     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -266,15 +251,15 @@ export declare class Files {
      *         }
      *     })
      */
-    createLocalUpload(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileCreateLocalUploadParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
+    createLocalUpload(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, request: Frameio.FileCreateLocalUploadParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
     private __createLocalUpload;
     /**
      * Import a file from a storage location configured on the account. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} folder_id
      * @param {Frameio.FileImportParams} request
-     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -293,14 +278,14 @@ export declare class Files {
      *         }
      *     })
      */
-    importFile(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileImportParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
+    importFile(account_id: Frameio.Uuid, folder_id: Frameio.Uuid, request: Frameio.FileImportParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
     private __importFile;
     /**
      * Show file upload status details. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
-     * @param {Frameio.Uuid} accountId -
-     * @param {Frameio.Uuid} fileId -
-     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} file_id
+     * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
      * @throws {@link Frameio.UnauthorizedError}
@@ -313,7 +298,6 @@ export declare class Files {
      * @example
      *     await client.files.showFileUploadStatus("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
      */
-    showFileUploadStatus(accountId: Frameio.Uuid, fileId: Frameio.Uuid, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileUploadStatusResponse>;
+    showFileUploadStatus(account_id: Frameio.Uuid, file_id: Frameio.Uuid, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileUploadStatusResponse>;
     private __showFileUploadStatus;
-    protected _getAuthorizationHeader(): Promise<string>;
 }