webflow-api 3.2.0 → 3.2.2

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

@@ -9,7 +9,7 @@ export declare namespace Assets {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        accessToken: core.Supplier<core.BearerToken>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -29,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}
@@ -45,9 +46,12 @@ export declare class Assets {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.assets.list("580e63e98c9a982ac9b8b741")
+     *     await client.assets.list("580e63e98c9a982ac9b8b741", {
+     *         offset: 1,
+     *         limit: 1
+     *     })
      */
-    list(siteId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<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.
@@ -199,5 +203,5 @@ export declare class Assets {
      */
     getFolder(assetFolderId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<Webflow.AssetFolder>;
     private __getFolder;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/api/resources/assets/client/Client.js

@@ -60,7 +60,7 @@ const errors = __importStar(require("../../../../errors/index"));
  * Assets are files that are uploaded to your Webflow account.
  */
 class Assets {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -69,6 +69,7 @@ class Assets {
      * 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}
@@ -78,19 +79,31 @@ class Assets {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.assets.list("580e63e98c9a982ac9b8b741")
+     *     await client.assets.list("580e63e98c9a982ac9b8b741", {
+     *         offset: 1,
+     *         limit: 1
+     *     })
      */
-    list(siteId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__list(siteId, requestOptions));
+    list(siteId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__list(siteId, request, requestOptions));
     }
-    __list(siteId, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    __list(siteId_1) {
+        return __awaiter(this, arguments, void 0, function* (siteId, request = {}, requestOptions) {
             var _a, _b, _c;
+            const { offset, limit } = request;
+            const _queryParams = {};
+            if (offset != null) {
+                _queryParams["offset"] = offset.toString();
+            }
+            if (limit != null) {
+                _queryParams["limit"] = limit.toString();
+            }
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.WebflowEnvironment.DataApi)
                     .base, `sites/${encodeURIComponent(siteId)}/assets`),
                 method: "GET",
                 headers: (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -934,7 +947,11 @@ class Assets {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.accessToken)}`;
+            const bearer = yield core.Supplier.get(this._options.accessToken);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

package/api/resources/assets/client/requests/AssetsListRequest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         offset: 1,
+ *         limit: 1
+ *     }
+ */
+export interface AssetsListRequest {
+    /**
+     * Offset used for pagination if the results have more than limit records
+     */
+    offset?: number;
+    /**
+     * Maximum number of records to be returned (max limit: 100)
+     */
+    limit?: number;
+}

package/api/resources/assets/client/requests/index.d.ts

@@ -1,3 +1,4 @@
+export { type AssetsListRequest } from "./AssetsListRequest";
 export { type AssetsCreateRequest } from "./AssetsCreateRequest";
 export { type AssetsUpdateRequest } from "./AssetsUpdateRequest";
 export { type AssetsCreateFolderRequest } from "./AssetsCreateFolderRequest";

package/api/resources/collections/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare namespace Collections {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        accessToken: core.Supplier<core.BearerToken>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -33,7 +33,7 @@ export declare class Collections {
     protected readonly _options: Collections.Options;
     protected _fields: Fields | undefined;
     protected _items: Items | undefined;
-    constructor(_options: Collections.Options);
+    constructor(_options?: Collections.Options);
     get fields(): Fields;
     get items(): Items;
     /**
@@ -139,5 +139,5 @@ export declare class Collections {
      */
     delete(collectionId: string, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/api/resources/collections/client/Client.js

@@ -62,7 +62,7 @@ const Client_2 = require("../resources/items/client/Client");
  * Collections are CMS collections of items.
  */
 class Collections {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     get fields() {
@@ -522,7 +522,11 @@ class Collections {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.accessToken)}`;
+            const bearer = yield core.Supplier.get(this._options.accessToken);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

package/api/resources/collections/resources/fields/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Fields {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        accessToken: core.Supplier<core.BearerToken>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -26,7 +26,7 @@ export declare namespace Fields {
 }
 export declare class Fields {
     protected readonly _options: Fields.Options;
-    constructor(_options: Fields.Options);
+    constructor(_options?: Fields.Options);
     /**
      * Create a custom field in a collection.
      *
@@ -136,5 +136,5 @@ export declare class Fields {
      */
     update(collectionId: string, fieldId: string, request?: Webflow.collections.FieldUpdate, requestOptions?: Fields.RequestOptions): core.HttpResponsePromise<Webflow.Field>;
     private __update;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/api/resources/collections/resources/fields/client/Client.js

@@ -57,7 +57,7 @@ const serializers = __importStar(require("../../../../../../serialization/index"
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../../../errors/index"));
 class Fields {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -436,7 +436,11 @@ class Fields {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            return `Bearer ${yield core.Supplier.get(this._options.accessToken)}`;
+            const bearer = yield core.Supplier.get(this._options.accessToken);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
         });
     }
 }

package/api/resources/collections/resources/items/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Items {
         environment?: core.Supplier<environments.WebflowEnvironment | environments.WebflowEnvironmentUrls>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        accessToken: core.Supplier<core.BearerToken>;
+        accessToken?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -26,7 +26,7 @@ export declare namespace Items {
 }
 export declare class Items {
     protected readonly _options: Items.Options;
-    constructor(_options: Items.Options);
+    constructor(_options?: Items.Options);
     /**
      * List of all Items within a Collection.
      *
@@ -43,7 +43,15 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.collections.items.listItems("580e63fc8c9a982ac9b8b745")
+     *     await client.collections.items.listItems("580e63fc8c9a982ac9b8b745", {
+     *         cmsLocaleId: "cmsLocaleId",
+     *         offset: 1,
+     *         limit: 1,
+     *         name: "name",
+     *         slug: "slug",
+     *         sortBy: "lastPublished",
+     *         sortOrder: "asc"
+     *     })
      */
     listItems(collectionId: string, request?: Webflow.collections.ItemsListItemsRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItemList>;
     private __listItems;
@@ -67,18 +75,20 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
+     *         skipInvalidFiles: true,
      *         body: {
      *             isArchived: false,
      *             isDraft: false,
      *             fieldData: {
-     *                 name: "Pan Galactic Gargle Blaster Recipe",
-     *                 slug: "pan-galactic-gargle-blaster"
+     *                 name: "The Hitchhiker's Guide to the Galaxy",
+     *                 slug: "hitchhikers-guide-to-the-galaxy"
      *             }
      *         }
      *     })
      *
      * @example
      *     await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
+     *         skipInvalidFiles: true,
      *         body: {
      *             items: [{
      *                     isArchived: false,
@@ -148,6 +158,7 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
+     *         skipInvalidFiles: true,
      *         items: [{
      *                 id: "66f6ed9576ddacf3149d5ea6",
      *                 cmsLocaleId: "66f6e966c9e1dc700a857ca5",
@@ -181,6 +192,7 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
+     *         skipInvalidFiles: true,
      *         items: [{
      *                 id: "580e64008c9a982ac9b8b754",
      *                 isArchived: false,
@@ -205,10 +217,9 @@ export declare class Items {
     /**
      * List all published items in a collection.
      *
-     * <Note title="Serve data with the Content Delivery API">
-     *   To serve content to your other frontends applications, enterprise sites have access to a dedicated [content delivery API](/data/docs/cms-content-delivery), available at api-cdn.webflow.com.
-     *
-     * </Note>
+     * <Tip title="Serve data with the Content Delivery API">
+     *   Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
+     * </Tip>
      *
      * Required scope | `CMS:read`
      *
@@ -223,7 +234,15 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745")
+     *     await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745", {
+     *         cmsLocaleId: "cmsLocaleId",
+     *         offset: 1,
+     *         limit: 1,
+     *         name: "name",
+     *         slug: "slug",
+     *         sortBy: "lastPublished",
+     *         sortOrder: "asc"
+     *     })
      */
     listItemsLive(collectionId: string, request?: Webflow.collections.ItemsListItemsLiveRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItemList>;
     private __listItemsLive;
@@ -248,18 +267,20 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
+     *         skipInvalidFiles: true,
      *         body: {
      *             isArchived: false,
      *             isDraft: false,
      *             fieldData: {
-     *                 name: "Pan Galactic Gargle Blaster Recipe",
-     *                 slug: "pan-galactic-gargle-blaster"
+     *                 name: "The Hitchhiker's Guide to the Galaxy",
+     *                 slug: "hitchhikers-guide-to-the-galaxy"
      *             }
      *         }
      *     })
      *
      * @example
      *     await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
+     *         skipInvalidFiles: true,
      *         body: {
      *             items: [{
      *                     isArchived: false,
@@ -327,6 +348,7 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.updateItemsLive("580e63fc8c9a982ac9b8b745", {
+     *         skipInvalidFiles: true,
      *         items: [{
      *                 id: "66f6ed9576ddacf3149d5ea6",
      *                 cmsLocaleId: "66f6e966c9e1dc700a857ca5",
@@ -360,6 +382,7 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.updateItemsLive("580e63fc8c9a982ac9b8b745", {
+     *         skipInvalidFiles: true,
      *         items: [{
      *                 id: "580e64008c9a982ac9b8b754",
      *                 isArchived: false,
@@ -403,6 +426,7 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.createItems("580e63fc8c9a982ac9b8b745", {
+     *         skipInvalidFiles: true,
      *         cmsLocaleIds: ["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4", "66f6e966c9e1dc700a857ca5"],
      *         isArchived: false,
      *         isDraft: false,
@@ -414,6 +438,7 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.createItems("580e63fc8c9a982ac9b8b745", {
+     *         skipInvalidFiles: true,
      *         cmsLocaleIds: ["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4"],
      *         isArchived: false,
      *         isDraft: false,
@@ -445,7 +470,9 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754")
+     *     await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
+     *         cmsLocaleId: "cmsLocaleId"
+     *     })
      */
     getItem(collectionId: string, itemId: string, request?: Webflow.collections.ItemsGetItemRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItem>;
     private __getItem;
@@ -466,7 +493,9 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754")
+     *     await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
+     *         cmsLocaleId: "cmsLocaleId"
+     *     })
      */
     deleteItem(collectionId: string, itemId: string, request?: Webflow.collections.ItemsDeleteItemRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteItem;
@@ -488,12 +517,13 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.updateItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
+     *         skipInvalidFiles: true,
      *         body: {
      *             isArchived: false,
      *             isDraft: false,
      *             fieldData: {
-     *                 name: "Pan Galactic Gargle Blaster Recipe",
-     *                 slug: "pan-galactic-gargle-blaster"
+     *                 name: "The Hitchhiker's Guide to the Galaxy",
+     *                 slug: "hitchhikers-guide-to-the-galaxy"
      *             }
      *         }
      *     })
@@ -503,10 +533,9 @@ export declare class Items {
     /**
      * Get details of a selected Collection live Item.
      *
-     * <Note title="Serve data with the Content Delivery API">
-     *   To serve content to your other frontends applications, enterprise sites have access to a dedicated [content delivery API](/data/docs/cms-content-delivery), available at api-cdn.webflow.com.
-     *
-     * </Note>
+     * <Tip title="Serve data with the Content Delivery API">
+     *   Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
+     * </Tip>
      *
      * Required scope | `CMS:read`
      *
@@ -522,7 +551,9 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754")
+     *     await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
+     *         cmsLocaleId: "cmsLocaleId"
+     *     })
      */
     getItemLive(collectionId: string, itemId: string, request?: Webflow.collections.ItemsGetItemLiveRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItem>;
     private __getItemLive;
@@ -545,7 +576,9 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754")
+     *     await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
+     *         cmsLocaleId: "cmsLocaleId"
+     *     })
      */
     deleteItemLive(collectionId: string, itemId: string, request?: Webflow.collections.ItemsDeleteItemLiveRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteItemLive;
@@ -568,12 +601,13 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.updateItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
+     *         skipInvalidFiles: true,
      *         body: {
      *             isArchived: false,
      *             isDraft: false,
      *             fieldData: {
-     *                 name: "Pan Galactic Gargle Blaster Recipe",
-     *                 slug: "pan-galactic-gargle-blaster"
+     *                 name: "The Hitchhiker's Guide to the Galaxy",
+     *                 slug: "hitchhikers-guide-to-the-galaxy"
      *             }
      *         }
      *     })
@@ -625,5 +659,5 @@ export declare class Items {
      */
     publishItem(collectionId: string, request: Webflow.collections.ItemsPublishItemRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.collections.ItemsPublishItemResponse>;
     private __publishItem;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }