webflow-api 2.4.2 → 2.5.0

package/dist/api/resources/assets/client/Client.d.ts

@@ -16,13 +16,17 @@ export declare namespace Assets {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Assets {
     protected readonly _options: Assets.Options;
     constructor(_options: Assets.Options);
     /**
-     * List assets for a given site </br></br> Required scope | `assets:read`
+     * List assets for a given site
+     *
+     * Required scope | `assets:read`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
@@ -38,7 +42,13 @@ export declare class Assets {
      */
     list(siteId: string, requestOptions?: Assets.RequestOptions): Promise<Webflow.Assets>;
     /**
-     * Create a new asset entry. </br></br> This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`. You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) request to the `uploadUrl` with the `uploadDetails` object as your header information in the request. </br></br> Required scope | `assets:write`
+     * Create a new asset entry.
+     *
+     * This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`.
+     * You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html)
+     * request to the `uploadUrl` with the `uploadDetails` object as your header information in the request.
+     *
+     * Required scope | `assets:write`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Webflow.AssetsCreateRequest} request
@@ -58,7 +68,9 @@ export declare class Assets {
      */
     create(siteId: string, request: Webflow.AssetsCreateRequest, requestOptions?: Assets.RequestOptions): Promise<Webflow.AssetUpload>;
     /**
-     * Get an Asset </br></br> Required scope | `assets:read`
+     * Get an Asset
+     *
+     * Required scope | `assets:read`
      *
      * @param {string} assetId - Unique identifier for an Asset on a site
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
@@ -76,6 +88,8 @@ export declare class Assets {
     /**
      * Delete an Asset
      *
+     * Required Scope: `assets: write`
+     *
      * @param {string} assetId - Unique identifier for an Asset on a site
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -90,7 +104,9 @@ export declare class Assets {
      */
     delete(assetId: string, requestOptions?: Assets.RequestOptions): Promise<void>;
     /**
-     * Update an Asset </br></br> Required scope | `assets:write`
+     * Update an Asset
+     *
+     * Required scope | `assets:write`
      *
      * @param {string} assetId - Unique identifier for an Asset on a site
      * @param {Webflow.AssetsUpdateRequest} request
@@ -103,13 +119,13 @@ export declare class Assets {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.assets.update("580e63fc8c9a982ac9b8b745", {
-     *         displayName: "bulldoze.png"
-     *     })
+     *     await client.assets.update("580e63fc8c9a982ac9b8b745")
      */
-    update(assetId: string, request: Webflow.AssetsUpdateRequest, requestOptions?: Assets.RequestOptions): Promise<Webflow.Asset>;
+    update(assetId: string, request?: Webflow.AssetsUpdateRequest, requestOptions?: Assets.RequestOptions): Promise<Webflow.Asset>;
     /**
-     * List Asset Folders within a given site <br><br> Required scope | `assets:read`
+     * List Asset Folders within a given site
+     *
+     * Required scope | `assets:read`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
@@ -125,7 +141,9 @@ export declare class Assets {
      */
     listFolders(siteId: string, requestOptions?: Assets.RequestOptions): Promise<Webflow.AssetFolderList>;
     /**
-     * Create an Asset Folder within a given site <br><br> Required scope | `assets:write`
+     * Create an Asset Folder within a given site
+     *
+     * Required scope | `assets:write`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Webflow.AssetsCreateFolderRequest} request
@@ -144,7 +162,9 @@ export declare class Assets {
      */
     createFolder(siteId: string, request: Webflow.AssetsCreateFolderRequest, requestOptions?: Assets.RequestOptions): Promise<Webflow.AssetFolder>;
     /**
-     * Get details about a specific Asset Folder <br><br> Required scope | `assets:read`
+     * Get details about a specific Asset Folder
+     *
+     * Required scope | `assets:read`
      *
      * @param {string} assetFolderId - Unique identifier for an Asset Folder
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.