frameio 4.2.2 → 4.2.3

package/dist/cjs/api/resources/files/client/Client.d.ts

@@ -14,11 +14,11 @@ 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
+     * Create new file under parent folder through remote upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
      * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.FrameOrAdobeId} folder_id
-     * @param {Frameio.FilesListRequest} request
+     * @param {Frameio.FileCreateRemoteUploadParams} request
      * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -30,24 +30,21 @@ export declare class FilesClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-     *         include: "media_links.original",
-     *         sort: "name_asc",
-     *         after: "<opaque_cursor>",
-     *         page_size: 10,
-     *         include_total_count: false
+     *     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"
+     *         }
      *     })
      */
-    list(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request?: Frameio.FilesListRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileAssetsWithIncludesResponse>;
-    private __list;
+    createRemoteUpload(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request: Frameio.FileCreateRemoteUploadParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileRemoteUploadResponse>;
+    private __createRemoteUpload;
     /**
-     * @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
+     * Create new file under parent folder through local upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
      * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.FrameOrAdobeId} folder_id
-     * @param {Frameio.FileCreateParams} request
+     * @param {Frameio.FileCreateLocalUploadParams} request
      * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -59,34 +56,20 @@ export declare class FilesClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.files.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *     await client.files.createLocalUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         data: {
      *             file_size: 1137444,
-     *             media_type: "image/png",
      *             name: "asset.png"
      *         }
      *     })
      */
-    create(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request: Frameio.FileCreateParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
-    private __create;
+    createLocalUpload(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request: Frameio.FileCreateLocalUploadParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
+    private __createLocalUpload;
     /**
-     * Show file details.
-     * <br/>
-     * Use the `include` query parameter to selectively include additional properties in the response.
-     * <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/>Rate Limits: 10 calls per 1 second(s) per account_user
+     * Show file upload status details. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
      * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.FrameOrAdobeId} file_id
-     * @param {Frameio.FilesShowRequest} request
      * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -98,17 +81,16 @@ export declare class FilesClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-     *         include: "media_links.original"
-     *     })
+     *     await client.files.showFileUploadStatus("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
      */
-    show(account_id: Frameio.FrameOrAdobeId, file_id: Frameio.FrameOrAdobeId, request?: Frameio.FilesShowRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileWithIncludesResponse>;
-    private __show;
+    showFileUploadStatus(account_id: Frameio.FrameOrAdobeId, file_id: Frameio.FrameOrAdobeId, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileUploadStatusResponse>;
+    private __showFileUploadStatus;
     /**
-     * Delete file by ID. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     * Move file to a folder or version_stack. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.FrameOrAdobeId} file_id
+     * @param {Frameio.FileMoveParams} request
      * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -120,16 +102,20 @@ export declare class FilesClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.files.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
+     *     await client.files.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         data: {
+     *             parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
+     *         }
+     *     })
      */
-    delete(account_id: Frameio.FrameOrAdobeId, file_id: Frameio.FrameOrAdobeId, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<void>;
-    private __delete;
+    move(account_id: Frameio.FrameOrAdobeId, file_id: Frameio.FrameOrAdobeId, request: Frameio.FileMoveParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
+    private __move;
     /**
-     * Update file details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     * 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.FrameOrAdobeId} account_id
-     * @param {Frameio.FrameOrAdobeId} file_id
-     * @param {Frameio.FileUpdateParams} request
+     * @param {Frameio.FrameOrAdobeId} folder_id
+     * @param {Frameio.FileImportParams} request
      * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -141,20 +127,34 @@ export declare class FilesClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.files.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *     await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         data: {
-     *             name: "asset.png"
+     *             key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
+     *             name: "asset.png",
+     *             storage_location: "123e4567-e89b-12d3-a456-426614174000"
      *         }
      *     })
      */
-    update(account_id: Frameio.FrameOrAdobeId, file_id: Frameio.FrameOrAdobeId, request: Frameio.FileUpdateParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
-    private __update;
+    importFile(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request: Frameio.FileImportParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
+    private __importFile;
     /**
-     * Copy file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     * Show file details.
+     * <br/>
+     * Use the `include` query parameter to selectively include additional properties in the response.
+     * <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/>Rate Limits: 10 calls per 1 second(s) per account_user
      *
      * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.FrameOrAdobeId} file_id
-     * @param {Frameio.FileCopyParams} request
+     * @param {Frameio.FilesShowRequest} request
      * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -166,22 +166,17 @@ export declare class FilesClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-     *         copy_metadata: true,
-     *         copy_comments: "none",
-     *         data: {
-     *             parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
-     *         }
+     *     await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "media_links.original"
      *     })
      */
-    copy(account_id: Frameio.FrameOrAdobeId, file_id: Frameio.FrameOrAdobeId, request?: Frameio.FileCopyParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileCopyResponse>;
-    private __copy;
+    show(account_id: Frameio.FrameOrAdobeId, file_id: Frameio.FrameOrAdobeId, request?: Frameio.FilesShowRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileWithIncludesResponse>;
+    private __show;
     /**
-     * Create new file under parent folder through remote upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
+     * Delete file by ID. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.FrameOrAdobeId} account_id
-     * @param {Frameio.FrameOrAdobeId} folder_id
-     * @param {Frameio.FileCreateRemoteUploadParams} request
+     * @param {Frameio.FrameOrAdobeId} file_id
      * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -193,21 +188,16 @@ export declare class FilesClient {
      * @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"
-     *         }
-     *     })
+     *     await client.files.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
      */
-    createRemoteUpload(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request: Frameio.FileCreateRemoteUploadParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileRemoteUploadResponse>;
-    private __createRemoteUpload;
+    delete(account_id: Frameio.FrameOrAdobeId, file_id: Frameio.FrameOrAdobeId, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
     /**
-     * Move file to a folder or version_stack. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     * Update file details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.FrameOrAdobeId} file_id
-     * @param {Frameio.FileMoveParams} request
+     * @param {Frameio.FileUpdateParams} request
      * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -219,20 +209,20 @@ export declare class FilesClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.files.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *     await client.files.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         data: {
-     *             parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
+     *             name: "asset.png"
      *         }
      *     })
      */
-    move(account_id: Frameio.FrameOrAdobeId, file_id: Frameio.FrameOrAdobeId, request: Frameio.FileMoveParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
-    private __move;
+    update(account_id: Frameio.FrameOrAdobeId, file_id: Frameio.FrameOrAdobeId, request: Frameio.FileUpdateParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
+    private __update;
     /**
-     * Create new file under parent folder through local upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
+     * List files in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
      * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.FrameOrAdobeId} folder_id
-     * @param {Frameio.FileCreateLocalUploadParams} request
+     * @param {Frameio.FilesListRequest} request
      * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -244,21 +234,24 @@ export declare class FilesClient {
      * @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"
-     *         }
+     *     await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "media_links.original",
+     *         sort: "name_asc",
+     *         after: "<opaque_cursor>",
+     *         page_size: 10,
+     *         include_total_count: false
      *     })
      */
-    createLocalUpload(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request: Frameio.FileCreateLocalUploadParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
-    private __createLocalUpload;
+    list(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request?: Frameio.FilesListRequest, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileAssetsWithIncludesResponse>;
+    private __list;
     /**
-     * Import a file from a storage location configured on the account. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
+     * @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.FrameOrAdobeId} account_id
      * @param {Frameio.FrameOrAdobeId} folder_id
-     * @param {Frameio.FileImportParams} request
+     * @param {Frameio.FileCreateParams} request
      * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -270,21 +263,22 @@ export declare class FilesClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *     await client.files.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         data: {
-     *             key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
-     *             name: "asset.png",
-     *             storage_location: "123e4567-e89b-12d3-a456-426614174000"
+     *             file_size: 1137444,
+     *             media_type: "image/png",
+     *             name: "asset.png"
      *         }
      *     })
      */
-    importFile(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request: Frameio.FileImportParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
-    private __importFile;
+    create(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request: Frameio.FileCreateParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
+    private __create;
     /**
-     * Show file upload status details. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
+     * Copy file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.FrameOrAdobeId} file_id
+     * @param {Frameio.FileCopyParams} request
      * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -296,8 +290,14 @@ export declare class FilesClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.files.showFileUploadStatus("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
+     *     await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         copy_metadata: true,
+     *         copy_comments: "none",
+     *         data: {
+     *             parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
+     *         }
+     *     })
      */
-    showFileUploadStatus(account_id: Frameio.FrameOrAdobeId, file_id: Frameio.FrameOrAdobeId, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileUploadStatusResponse>;
-    private __showFileUploadStatus;
+    copy(account_id: Frameio.FrameOrAdobeId, file_id: Frameio.FrameOrAdobeId, request?: Frameio.FileCopyParams, requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise<Frameio.FileCopyResponse>;
+    private __copy;
 }