frameio 0.1.0

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

@@ -0,0 +1,278 @@
+import * as environments from "../../../../environments.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 | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+    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>;
+    }
+}
+/**
+ * Manage Files and related operations.
+ */
+export declare class Files {
+    protected readonly _options: Files.Options;
+    constructor(_options?: Files.Options);
+    /**
+     * List files in a given folder. <br><br>Rate Limits: 5 calls per 1 second(s) per account
+     *
+     * @param {Frameio.Uuid} accountId -
+     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.FilesListRequest} request
+     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "media_links",
+     *         after: "<opaque_cursor>",
+     *         page_size: 10,
+     *         include_total_count: false
+     *     })
+     */
+    list(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.FilesListRequest, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.AssetsWithIncludesResponse>;
+    private __list;
+    /**
+     * Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br><br>Rate Limits: 5 calls per 1 second(s) per account
+     *
+     * @param {Frameio.Uuid} accountId -
+     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.FileCreateParams} request
+     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.files.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         data: {
+     *             file_size: 1137444,
+     *             media_type: "image/png",
+     *             name: "asset.png"
+     *         }
+     *     })
+     */
+    create(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileCreateParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
+    private __create;
+    /**
+     * Show file details.
+     * <br><br>
+     * Use the `include` query parameter to selectively include additional properties in the response.
+     * <br><br>
+     * Note: if you include `media_links.original` and the user does not have permission to download the file
+     * then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
+     * watermarking is required for this user and isn't supported by the requested media_links, then the request will
+     * succeed but the unsupported media links will be set to null.
+     * Similarly, if a requested transcode link does not exist for a particular file (e.g. including
+     * `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
+     * (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
+     * the response payload. In short, the client must handle null media links gracefully.
+     * <br><br>Rate Limits: 5 calls per 1 second(s) per account
+     *
+     * @param {Frameio.Uuid} accountId -
+     * @param {Frameio.Uuid} fileId -
+     * @param {Frameio.FilesShowRequest} request
+     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "media_links"
+     *     })
+     */
+    show(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request?: Frameio.FilesShowRequest, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileWithIncludesResponse>;
+    private __show;
+    /**
+     * Delete file by ID. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+     *
+     * @param {Frameio.Uuid} accountId -
+     * @param {Frameio.Uuid} fileId -
+     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @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>;
+    private __delete;
+    /**
+     * Update file details. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+     *
+     * @param {Frameio.Uuid} accountId -
+     * @param {Frameio.Uuid} fileId -
+     * @param {Frameio.FileUpdateParams} request
+     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.files.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         data: {
+     *             name: "asset.png"
+     *         }
+     *     })
+     */
+    update(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request: Frameio.FileUpdateParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
+    private __update;
+    /**
+     * Copy file. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+     *
+     * @param {Frameio.Uuid} accountId -
+     * @param {Frameio.Uuid} fileId -
+     * @param {Frameio.FileCopyParams} request
+     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         data: {
+     *             parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
+     *         }
+     *     })
+     */
+    copy(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request?: Frameio.FileCopyParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileCopyResponse>;
+    private __copy;
+    /**
+     * Create new file under parent folder through remote upload. <br><br>Rate Limits: 5 calls per 1 second(s) per account
+     *
+     * @param {Frameio.Uuid} accountId -
+     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.FileCreateRemoteUploadParams} request
+     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.files.createRemoteUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         data: {
+     *             name: "asset.png",
+     *             source_url: "https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png"
+     *         }
+     *     })
+     */
+    createRemoteUpload(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileCreateRemoteUploadParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileRemoteUploadResponse>;
+    private __createRemoteUpload;
+    /**
+     * Move file to a folder or version_stack. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+     *
+     * @param {Frameio.Uuid} accountId -
+     * @param {Frameio.Uuid} fileId -
+     * @param {Frameio.FileMoveParams} request
+     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.files.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         data: {
+     *             parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
+     *         }
+     *     })
+     */
+    move(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request: Frameio.FileMoveParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
+    private __move;
+    /**
+     * Create new file under parent folder through local upload. <br><br>Rate Limits: 5 calls per 1 second(s) per account
+     *
+     * @param {Frameio.Uuid} accountId -
+     * @param {Frameio.Uuid} folderId -
+     * @param {Frameio.FileCreateLocalUploadParams} request
+     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.files.createLocalUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         data: {
+     *             file_size: 1137444,
+     *             name: "asset.png"
+     *         }
+     *     })
+     */
+    createLocalUpload(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileCreateLocalUploadParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
+    private __createLocalUpload;
+    /**
+     * Show file upload status details. <br><br>Rate Limits: 5 calls per 1 second(s) per account
+     *
+     * @param {Frameio.Uuid} accountId -
+     * @param {Frameio.Uuid} fileId -
+     * @param {Files.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @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>;
+    private __showFileUploadStatus;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}