frameio 4.2.2 → 4.2.3

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

@@ -14,23 +14,11 @@ export declare class VersionStacksClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<VersionStacksClient.Options>;
     constructor(options: VersionStacksClient.Options);
     /**
-     * List the children (files) in a given version stack.
-     * <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 files
-     * in the corresponding project, 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 finished
-     * (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
-     * null in the response payload. In short, the client must handle null media links gracefully.
-     * <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     * Move version stack to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.FrameOrAdobeId} version_stack_id
-     * @param {Frameio.VersionStacksIndexRequest} request
+     * @param {Frameio.VersionStackMoveParams} request
      * @param {VersionStacksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -42,21 +30,20 @@ export declare class VersionStacksClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-     *         include: "media_links.original",
-     *         after: "<opaque_cursor>",
-     *         page_size: 10,
-     *         include_total_count: false
+     *     await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         data: {
+     *             parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
+     *         }
      *     })
      */
-    index(account_id: Frameio.FrameOrAdobeId, version_stack_id: Frameio.FrameOrAdobeId, request?: Frameio.VersionStacksIndexRequest, requestOptions?: VersionStacksClient.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackAssetsWithIncludesResponse>;
-    private __index;
+    move(account_id: Frameio.FrameOrAdobeId, version_stack_id: Frameio.FrameOrAdobeId, request: Frameio.VersionStackMoveParams, requestOptions?: VersionStacksClient.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackResponse>;
+    private __move;
     /**
-     * Show version stack details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+     * List version stacks in a given folder.  <br/>Rate Limits: 5 calls per 1 second(s) per account_user
      *
      * @param {Frameio.FrameOrAdobeId} account_id
-     * @param {Frameio.FrameOrAdobeId} version_stack_id
-     * @param {Frameio.VersionStacksShowRequest} request
+     * @param {Frameio.FrameOrAdobeId} folder_id
+     * @param {Frameio.VersionStacksListRequest} request
      * @param {VersionStacksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -68,22 +55,21 @@ export declare class VersionStacksClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-     *         include: "media_links.original"
+     *     await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "media_links.original",
+     *         after: "<opaque_cursor>",
+     *         page_size: 10,
+     *         include_total_count: false
      *     })
      */
-    show(account_id: Frameio.FrameOrAdobeId, version_stack_id: Frameio.FrameOrAdobeId, request?: Frameio.VersionStacksShowRequest, requestOptions?: VersionStacksClient.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackWithIncludesResponse>;
-    private __show;
+    list(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request?: Frameio.VersionStacksListRequest, requestOptions?: VersionStacksClient.RequestOptions): core.HttpResponsePromise<Frameio.VersionStacksWithIncludesResponse>;
+    private __list;
     /**
-     * Copy version stack. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user<br><br>
-     *
-     * Currently, copying version stacks between Adobe storage backed projects is not supported. Copying individual
-     * files within a version stack and then restacking them is currently the supported method for copying version
-     * stacks for these projects.
+     * Create a new Version Stack under the parent folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.FrameOrAdobeId} account_id
-     * @param {Frameio.FrameOrAdobeId} version_stack_id
-     * @param {Frameio.VersionStackCopyParams} request
+     * @param {Frameio.FrameOrAdobeId} folder_id
+     * @param {Frameio.VersionStackCreateParams} request
      * @param {VersionStacksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -95,21 +81,20 @@ export declare class VersionStacksClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-     *         copy_metadata: true,
+     *     await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         data: {
-     *             parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
+     *             file_ids: ["74849eb1-eb41-4ad9-98f5-bc91b59db044", "07edec4a-c8bb-479b-8dba-10f921b60746"]
      *         }
      *     })
      */
-    copy(account_id: Frameio.FrameOrAdobeId, version_stack_id: Frameio.FrameOrAdobeId, request?: Frameio.VersionStackCopyParams, requestOptions?: VersionStacksClient.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackCopyResponse>;
-    private __copy;
+    create(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request: Frameio.VersionStackCreateParams, requestOptions?: VersionStacksClient.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackWithIncludesResponse>;
+    private __create;
     /**
-     * List version stacks in a given folder.  <br/>Rate Limits: 5 calls per 1 second(s) per account_user
+     * Show version stack details. <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.VersionStacksListRequest} request
+     * @param {Frameio.FrameOrAdobeId} version_stack_id
+     * @param {Frameio.VersionStacksShowRequest} request
      * @param {VersionStacksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -121,21 +106,30 @@ export declare class VersionStacksClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-     *         include: "media_links.original",
-     *         after: "<opaque_cursor>",
-     *         page_size: 10,
-     *         include_total_count: false
+     *     await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "media_links.original"
      *     })
      */
-    list(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request?: Frameio.VersionStacksListRequest, requestOptions?: VersionStacksClient.RequestOptions): core.HttpResponsePromise<Frameio.VersionStacksWithIncludesResponse>;
-    private __list;
+    show(account_id: Frameio.FrameOrAdobeId, version_stack_id: Frameio.FrameOrAdobeId, request?: Frameio.VersionStacksShowRequest, requestOptions?: VersionStacksClient.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackWithIncludesResponse>;
+    private __show;
     /**
-     * Create a new Version Stack under the parent folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+     * List the children (files) in a given version stack.
+     * <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 files
+     * in the corresponding project, 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 finished
+     * (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
+     * null in the response payload. In short, the client must handle null media links gracefully.
+     * <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.VersionStackCreateParams} request
+     * @param {Frameio.FrameOrAdobeId} version_stack_id
+     * @param {Frameio.VersionStacksIndexRequest} request
      * @param {VersionStacksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -147,20 +141,25 @@ export declare class VersionStacksClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-     *         data: {
-     *             file_ids: ["55d3fe55-a296-440b-ad38-4aab4db352a4", "d643846f-b4b1-4958-83e2-e762e4b112ec"]
-     *         }
+     *     await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         include: "media_links.original",
+     *         after: "<opaque_cursor>",
+     *         page_size: 10,
+     *         include_total_count: false
      *     })
      */
-    create(account_id: Frameio.FrameOrAdobeId, folder_id: Frameio.FrameOrAdobeId, request: Frameio.VersionStackCreateParams, requestOptions?: VersionStacksClient.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackWithIncludesResponse>;
-    private __create;
+    index(account_id: Frameio.FrameOrAdobeId, version_stack_id: Frameio.FrameOrAdobeId, request?: Frameio.VersionStacksIndexRequest, requestOptions?: VersionStacksClient.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackAssetsWithIncludesResponse>;
+    private __index;
     /**
-     * Move version stack to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+     * Copy version stack. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user<br><br>
+     *
+     * Currently, copying version stacks between Adobe storage backed projects is not supported. Copying individual
+     * files within a version stack and then restacking them is currently the supported method for copying version
+     * stacks for these projects.
      *
      * @param {Frameio.FrameOrAdobeId} account_id
      * @param {Frameio.FrameOrAdobeId} version_stack_id
-     * @param {Frameio.VersionStackMoveParams} request
+     * @param {Frameio.VersionStackCopyParams} request
      * @param {VersionStacksClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Frameio.BadRequestError}
@@ -172,12 +171,13 @@ export declare class VersionStacksClient {
      * @throws {@link Frameio.TooManyRequestsError}
      *
      * @example
-     *     await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *     await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         copy_metadata: true,
      *         data: {
      *             parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
      *         }
      *     })
      */
-    move(account_id: Frameio.FrameOrAdobeId, version_stack_id: Frameio.FrameOrAdobeId, request: Frameio.VersionStackMoveParams, requestOptions?: VersionStacksClient.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackResponse>;
-    private __move;
+    copy(account_id: Frameio.FrameOrAdobeId, version_stack_id: Frameio.FrameOrAdobeId, request?: Frameio.VersionStackCopyParams, requestOptions?: VersionStacksClient.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackCopyResponse>;
+    private __copy;
 }