webflow-api 2.3.2 → 2.3.6

package/dist/api/resources/collections/resources/fields/client/requests/index.d.ts

@@ -1,2 +1,2 @@
-export { FieldCreate } from "./FieldCreate";
-export { FieldUpdate } from "./FieldUpdate";
+export { type FieldCreate } from "./FieldCreate";
+export { type FieldUpdate } from "./FieldUpdate";

package/dist/api/resources/collections/resources/fields/types/FieldCreateType.d.ts

@@ -4,7 +4,7 @@
 /**
  * Choose these appropriate field type for your collection data
  */
-export declare type FieldCreateType = "PlainText" | "RichText" | "Image" | "MultiImage" | "Video" | "Link" | "Email" | "Phone" | "Number" | "DateTime" | "Boolean" | "Color" | "File";
+export declare type FieldCreateType = "PlainText" | "RichText" | "Image" | "MultiImage" | "Video" | "Link" | "Email" | "Phone" | "Number" | "DateTime" | "Switch" | "Color" | "File";
 export declare const FieldCreateType: {
     readonly PlainText: "PlainText";
     readonly RichText: "RichText";
@@ -16,7 +16,7 @@ export declare const FieldCreateType: {
     readonly Phone: "Phone";
     readonly Number: "Number";
     readonly DateTime: "DateTime";
-    readonly Boolean: "Boolean";
+    readonly Switch: "Switch";
     readonly Color: "Color";
     readonly File: "File";
 };

package/dist/api/resources/collections/resources/fields/types/FieldCreateType.js

@@ -15,7 +15,7 @@ exports.FieldCreateType = {
     Phone: "Phone",
     Number: "Number",
     DateTime: "DateTime",
-    Boolean: "Boolean",
+    Switch: "Switch",
     Color: "Color",
     File: "File",
 };

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

@@ -3,15 +3,19 @@
  */
 import * as environments from "../../../../../../environments";
 import * as core from "../../../../../../core";
-import * as Webflow from "../../../../..";
+import * as Webflow from "../../../../../index";
 export declare namespace Items {
     interface Options {
         environment?: core.Supplier<environments.WebflowEnvironment | string>;
         accessToken: core.Supplier<core.BearerToken>;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
     }
 }
 export declare class Items {
@@ -19,6 +23,11 @@ export declare class Items {
     constructor(_options: Items.Options);
     /**
      * List of all Items within a Collection. </br></br> Required scope | `CMS:read`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.collections.ItemsListItemsRequest} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -26,11 +35,16 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.listItems("collection_id", {})
+     *     await client.collections.items.listItems("collection_id")
      */
     listItems(collectionId: string, request?: Webflow.collections.ItemsListItemsRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItemList>;
     /**
-     * Create Item in a Collection.</br></br> To create items across multiple locales, <a href="https://developers.webflow.com/data/reference/create-item-for-multiple-locales"> please use this endpoint.</a> </br></br> Required scope | `CMS:write`
+     * <style>.rm-Markdown.markdown-body a{color: #146EF5 !important;}</style> Create Item in a Collection.</br></br> To create items across multiple locales, <a href="https://developers.webflow.com/data/reference/create-item-for-multiple-locales"> please use the bulk item endpoint.</a> </br></br> Required scope | <code>CMS:write</code>
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.CollectionItem} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -38,7 +52,7 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.createItem("collection_id", {
+     *     await client.collections.items.createItem("collection_id", {
      *         id: "42b720ef280c7a7a3be8cabe",
      *         cmsLocaleId: "653ad57de882f528b32e810e",
      *         lastPublished: "2022-11-29T16:22:43.159Z",
@@ -55,6 +69,11 @@ export declare class Items {
     createItem(collectionId: string, request: Webflow.CollectionItem, requestOptions?: Items.RequestOptions): Promise<void>;
     /**
      * List of all live Items within a Collection. </br></br> Required scope | `CMS:read`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.collections.ItemsListItemsLiveRequest} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -62,11 +81,16 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.listItemsLive("collection_id", {})
+     *     await client.collections.items.listItemsLive("collection_id")
      */
     listItemsLive(collectionId: string, request?: Webflow.collections.ItemsListItemsLiveRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItemList>;
     /**
      * Create live Item in a Collection. This Item will be published to the live site. </br></br> To create items across multiple locales, <a href="https://developers.webflow.com/data/reference/create-item-for-multiple-locales"> please use this endpoint.</a> </br></br> Required scope | `CMS:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.CollectionItem} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -74,7 +98,7 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.createItemLive("collection_id", {
+     *     await client.collections.items.createItemLive("collection_id", {
      *         id: "42b720ef280c7a7a3be8cabe",
      *         cmsLocaleId: "653ad57de882f528b32e810e",
      *         lastPublished: "2022-11-29T16:22:43.159Z",
@@ -91,6 +115,11 @@ export declare class Items {
     createItemLive(collectionId: string, request: Webflow.CollectionItem, requestOptions?: Items.RequestOptions): Promise<void>;
     /**
      * Create single Item in a Collection with multiple corresponding locales. </br></br> Required scope | `CMS:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.collections.BulkCollectionItem} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -98,19 +127,19 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.createItemForMultipleLocales("collection_id", {
-     *         id: "580e64008c9a982ac9b8b754",
-     *         lastUpdated: "2023-03-17T18:47:35.560Z",
-     *         createdOn: "2023-03-17T18:47:35.560Z",
-     *         fieldData: {
-     *             name: "My new item",
-     *             slug: "my-new-item"
-     *         }
+     *     await client.collections.items.createItemForMultipleLocales("collection_id", {
+     *         id: "580e64008c9a982ac9b8b754"
      *     })
      */
     createItemForMultipleLocales(collectionId: string, request: Webflow.collections.BulkCollectionItem, requestOptions?: Items.RequestOptions): Promise<void>;
     /**
      * Get details of a selected Collection Item. </br></br> Required scope | `CMS:read`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} itemId - Unique identifier for an Item
+     * @param {Webflow.collections.ItemsGetItemRequest} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -118,11 +147,17 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.getItem("collection_id", "item_id", {})
+     *     await client.collections.items.getItem("collection_id", "item_id")
      */
     getItem(collectionId: string, itemId: string, request?: Webflow.collections.ItemsGetItemRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
     /**
      * Delete an Item from a Collection. This endpoint does not currently support bulk deletion. </br></br> Required scope | `CMS:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} itemId - Unique identifier for an Item
+     * @param {Webflow.collections.ItemsDeleteItemRequest} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -130,11 +165,17 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.deleteItem("collection_id", "item_id", {})
+     *     await client.collections.items.deleteItem("collection_id", "item_id")
      */
     deleteItem(collectionId: string, itemId: string, request?: Webflow.collections.ItemsDeleteItemRequest, requestOptions?: Items.RequestOptions): Promise<void>;
     /**
      * Update a selected Item in a Collection. </br></br> Required scope | `CMS:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} itemId - Unique identifier for an Item
+     * @param {Webflow.CollectionItem} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -142,7 +183,7 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.updateItem("collection_id", "item_id", {
+     *     await client.collections.items.updateItem("collection_id", "item_id", {
      *         id: "42b720ef280c7a7a3be8cabe",
      *         cmsLocaleId: "653ad57de882f528b32e810e",
      *         lastPublished: "2022-11-29T16:22:43.159Z",
@@ -158,7 +199,13 @@ export declare class Items {
      */
     updateItem(collectionId: string, itemId: string, request: Webflow.CollectionItem, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
     /**
-     * Delete a live Item from a Collection. The Item will be unpublished from the live site. This endpoint does not currently support bulk deletion. </br></br> Required scope | `CMS:write`
+     * Get details of a selected Collection live Item. </br></br> Required scope | `CMS:read`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} itemId - Unique identifier for an Item
+     * @param {Webflow.collections.ItemsGetItemLiveRequest} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -166,11 +213,35 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.deleteItemLive("collection_id", "item_id")
+     *     await client.collections.items.getItemLive("collection_id", "item_id")
      */
-    deleteItemLive(collectionId: string, itemId: string, requestOptions?: Items.RequestOptions): Promise<void>;
+    getItemLive(collectionId: string, itemId: string, request?: Webflow.collections.ItemsGetItemLiveRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    /**
+     * Remove a live item from the site. Removing a published item will unpublish the item from the live site and set it to draft. This endpoint does not currently support bulk deletion.</br></br> Required scope | `CMS:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} itemId - Unique identifier for an Item
+     * @param {Webflow.collections.ItemsDeleteItemLiveRequest} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await client.collections.items.deleteItemLive("collection_id", "item_id")
+     */
+    deleteItemLive(collectionId: string, itemId: string, request?: Webflow.collections.ItemsDeleteItemLiveRequest, requestOptions?: Items.RequestOptions): Promise<void>;
     /**
      * Update a selected live Item in a Collection. The updates for this Item will be published to the live site. </br></br> Required scope | `CMS:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {string} itemId - Unique identifier for an Item
+     * @param {Webflow.CollectionItem} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -178,7 +249,7 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.updateItemLive("collection_id", "item_id", {
+     *     await client.collections.items.updateItemLive("collection_id", "item_id", {
      *         id: "42b720ef280c7a7a3be8cabe",
      *         cmsLocaleId: "653ad57de882f528b32e810e",
      *         lastPublished: "2022-11-29T16:22:43.159Z",
@@ -195,6 +266,11 @@ export declare class Items {
     updateItemLive(collectionId: string, itemId: string, request: Webflow.CollectionItem, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
     /**
      * Publish an item or multiple items. </br></br> Required scope | `cms:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.collections.ItemsPublishItemRequest} request
+     * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -202,7 +278,7 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.publishItem("collection_id", {
+     *     await client.collections.items.publishItem("collection_id", {
      *         itemIds: ["itemIds"]
      *     })
      */