webflow-api 3.1.4 → 3.2.1

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

@@ -7,7 +7,11 @@ import * as Webflow from "../../../index";
 export declare namespace Assets {
     interface Options {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
-        accessToken: core.Supplier<core.BearerToken>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -17,7 +21,7 @@ export declare namespace Assets {
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 }
 /**
@@ -25,13 +29,14 @@ export declare namespace Assets {
  */
 export declare class Assets {
     protected readonly _options: Assets.Options;
-    constructor(_options: Assets.Options);
+    constructor(_options?: Assets.Options);
     /**
      * List of assets uploaded to a site
      *
      * Required scope | `assets:read`
      *
      * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.AssetsListRequest} request
      * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Webflow.BadRequestError}
@@ -41,9 +46,13 @@ export declare class Assets {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.assets.list("580e63e98c9a982ac9b8b741")
+     *     await client.assets.list("580e63e98c9a982ac9b8b741", {
+     *         offset: 1.1,
+     *         limit: 1.1
+     *     })
      */
-    list(siteId: string, requestOptions?: Assets.RequestOptions): Promise<Webflow.Assets>;
+    list(siteId: string, request?: Webflow.AssetsListRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<Webflow.Assets>;
+    private __list;
     /**
      * The first step in uploading an asset to a site.
      *
@@ -74,7 +83,8 @@ export declare class Assets {
      *         fileHash: "3c7d87c9575702bc3b1e991f4d3c638e"
      *     })
      */
-    create(siteId: string, request: Webflow.AssetsCreateRequest, requestOptions?: Assets.RequestOptions): Promise<Webflow.AssetUpload>;
+    create(siteId: string, request: Webflow.AssetsCreateRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<Webflow.AssetUpload>;
+    private __create;
     /**
      * Get details about an asset
      *
@@ -92,7 +102,8 @@ export declare class Assets {
      * @example
      *     await client.assets.get("580e63fc8c9a982ac9b8b745")
      */
-    get(assetId: string, requestOptions?: Assets.RequestOptions): Promise<Webflow.Asset>;
+    get(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<Webflow.Asset>;
+    private __get;
     /**
      * Delete an Asset
      *
@@ -110,7 +121,8 @@ export declare class Assets {
      * @example
      *     await client.assets.delete("580e63fc8c9a982ac9b8b745")
      */
-    delete(assetId: string, requestOptions?: Assets.RequestOptions): Promise<void>;
+    delete(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
     /**
      * Update details of an Asset.
      *
@@ -129,7 +141,8 @@ export declare class Assets {
      * @example
      *     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): core.HttpResponsePromise<Webflow.Asset>;
+    private __update;
     /**
      * List Asset Folders within a given site
      *
@@ -147,7 +160,8 @@ export declare class Assets {
      * @example
      *     await client.assets.listFolders("580e63e98c9a982ac9b8b741")
      */
-    listFolders(siteId: string, requestOptions?: Assets.RequestOptions): Promise<Webflow.AssetFolderList>;
+    listFolders(siteId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<Webflow.AssetFolderList>;
+    private __listFolders;
     /**
      * Create an Asset Folder within a given site
      *
@@ -168,7 +182,8 @@ export declare class Assets {
      *         displayName: "my asset folder"
      *     })
      */
-    createFolder(siteId: string, request: Webflow.AssetsCreateFolderRequest, requestOptions?: Assets.RequestOptions): Promise<Webflow.AssetFolder>;
+    createFolder(siteId: string, request: Webflow.AssetsCreateFolderRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<Webflow.AssetFolder>;
+    private __createFolder;
     /**
      * Get details about a specific Asset Folder
      *
@@ -186,6 +201,7 @@ export declare class Assets {
      * @example
      *     await client.assets.getFolder("6390c49774a71f0e3c1a08ee")
      */
-    getFolder(assetFolderId: string, requestOptions?: Assets.RequestOptions): Promise<Webflow.AssetFolder>;
-    protected _getAuthorizationHeader(): Promise<string>;
+    getFolder(assetFolderId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<Webflow.AssetFolder>;
+    private __getFolder;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }