webflow-api 2.4.2 → 3.0.0

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

@@ -16,13 +16,17 @@ export declare namespace Items {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Items {
     protected readonly _options: Items.Options;
     constructor(_options: Items.Options);
     /**
-     * List of all Items within a Collection. </br></br> Required scope | `CMS:read`
+     * List of all Items within a Collection.
+     *
+     * Required scope | `CMS:read`
      *
      * @param {string} collectionId - Unique identifier for a Collection
      * @param {Webflow.collections.ItemsListItemsRequest} request
@@ -39,10 +43,14 @@ export declare class Items {
      */
     listItems(collectionId: string, request?: Webflow.collections.ItemsListItemsRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItemList>;
     /**
-     * <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>
+     * Create Item(s) in a Collection.
+     *
+     * To create items across multiple locales, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/bulk-items/create-items)
+     *
+     * Required scope | `CMS:write`
      *
      * @param {string} collectionId - Unique identifier for a Collection
-     * @param {Webflow.CollectionItem} request
+     * @param {Webflow.collections.ItemsCreateItemRequest} request
      * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Webflow.BadRequestError}
@@ -53,11 +61,6 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
-     *         id: "42b720ef280c7a7a3be8cabe",
-     *         cmsLocaleId: "653ad57de882f528b32e810e",
-     *         lastPublished: "2022-11-29T16:22:43.159Z",
-     *         lastUpdated: "2022-11-17T17:19:43.282Z",
-     *         createdOn: "2022-11-17T17:11:57.148Z",
      *         isArchived: false,
      *         isDraft: false,
      *         fieldData: {
@@ -65,10 +68,124 @@ export declare class Items {
      *             slug: "pan-galactic-gargle-blaster"
      *         }
      *     })
+     *
+     * @example
+     *     await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
+     *         items: [{
+     *                 isArchived: false,
+     *                 isDraft: false,
+     *                 fieldData: {
+     *                     name: "Senior Data Analyst",
+     *                     slug: "senior-data-analyst"
+     *                 }
+     *             }, {
+     *                 isArchived: false,
+     *                 isDraft: false,
+     *                 fieldData: {
+     *                     name: "Product Manager",
+     *                     slug: "product-manager"
+     *                 }
+     *             }]
+     *     })
      */
-    createItem(collectionId: string, request: Webflow.CollectionItem, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    createItem(collectionId: string, request: Webflow.collections.ItemsCreateItemRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
     /**
-     * List of all live Items within a Collection. </br></br> Required scope | `CMS:read`
+     * Delete Items from a Collection.
+     *
+     * **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be deleted only in the primary locale.
+     *
+     * Required scope | `CMS:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.collections.ItemsDeleteItemsRequest} 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.deleteItems("580e63fc8c9a982ac9b8b745")
+     */
+    deleteItems(collectionId: string, request?: Webflow.collections.ItemsDeleteItemsRequest, requestOptions?: Items.RequestOptions): Promise<void>;
+    /**
+     * Update a single item or multiple items (up to 100) in a Collection.
+     *
+     * **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale.
+     *
+     * Required scope | `CMS:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.collections.ItemsUpdateItemsRequest} 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.updateItems("580e63fc8c9a982ac9b8b745", {
+     *         items: [{
+     *                 id: "66f6ed9576ddacf3149d5ea6",
+     *                 cmsLocaleId: "66f6e966c9e1dc700a857ca5",
+     *                 fieldData: {
+     *                     name: "Ne Paniquez Pas",
+     *                     slug: "ne-paniquez-pas"
+     *                 }
+     *             }, {
+     *                 id: "66f6ed9576ddacf3149d5ea6",
+     *                 cmsLocaleId: "66f6e966c9e1dc700a857ca4",
+     *                 fieldData: {
+     *                     name: "No Entrar en P\u00E1nico",
+     *                     slug: "no-entrar-en-panico"
+     *                 }
+     *             }, {
+     *                 id: "66f6ed9576ddacf3149d5eaa",
+     *                 cmsLocaleId: "66f6e966c9e1dc700a857ca5",
+     *                 fieldData: {
+     *                     name: "Au Revoir et Merci pour Tous les Poissons",
+     *                     slug: "au-revoir-et-merci"
+     *                 }
+     *             }, {
+     *                 id: "66f6ed9576ddacf3149d5eaa",
+     *                 cmsLocaleId: "66f6e966c9e1dc700a857ca4",
+     *                 fieldData: {
+     *                     name: "Hasta Luego y Gracias por Todo el Pescado",
+     *                     slug: "hasta-luego-y-gracias"
+     *                 }
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
+     *         items: [{
+     *                 id: "580e64008c9a982ac9b8b754",
+     *                 isArchived: false,
+     *                 isDraft: false,
+     *                 fieldData: {
+     *                     name: "Senior Data Analyst",
+     *                     slug: "senior-data-analyst"
+     *                 }
+     *             }, {
+     *                 id: "580e64008c9a982ac9b8b754",
+     *                 isArchived: false,
+     *                 isDraft: false,
+     *                 fieldData: {
+     *                     name: "Product Manager",
+     *                     slug: "product-manager"
+     *                 }
+     *             }]
+     *     })
+     */
+    updateItems(collectionId: string, request?: Webflow.collections.ItemsUpdateItemsRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    /**
+     * List of all live Items within a Collection.
+     *
+     * Required scope | `CMS:read`
      *
      * @param {string} collectionId - Unique identifier for a Collection
      * @param {Webflow.collections.ItemsListItemsLiveRequest} request
@@ -85,10 +202,14 @@ export declare class Items {
      */
     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`
+     * Create live Item(s) in a Collection. The Item(s) will be published to the live site.
+     *
+     * To create items across multiple locales, [please use this endpoint.](/v2.0.0/data/reference/cms/collection-items/bulk-items/create-items)
+     *
+     * Required scope | `CMS:write`
      *
      * @param {string} collectionId - Unique identifier for a Collection
-     * @param {Webflow.CollectionItem} request
+     * @param {Webflow.collections.ItemsCreateItemLiveRequest} request
      * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Webflow.BadRequestError}
@@ -99,11 +220,6 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
-     *         id: "42b720ef280c7a7a3be8cabe",
-     *         cmsLocaleId: "653ad57de882f528b32e810e",
-     *         lastPublished: "2022-11-29T16:22:43.159Z",
-     *         lastUpdated: "2022-11-17T17:19:43.282Z",
-     *         createdOn: "2022-11-17T17:11:57.148Z",
      *         isArchived: false,
      *         isDraft: false,
      *         fieldData: {
@@ -111,13 +227,36 @@ export declare class Items {
      *             slug: "pan-galactic-gargle-blaster"
      *         }
      *     })
+     *
+     * @example
+     *     await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
+     *         items: [{
+     *                 isArchived: false,
+     *                 isDraft: false,
+     *                 fieldData: {
+     *                     name: "Senior Data Analyst",
+     *                     slug: "senior-data-analyst"
+     *                 }
+     *             }, {
+     *                 isArchived: false,
+     *                 isDraft: false,
+     *                 fieldData: {
+     *                     name: "Product Manager",
+     *                     slug: "product-manager"
+     *                 }
+     *             }]
+     *     })
      */
-    createItemLive(collectionId: string, request: Webflow.CollectionItem, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    createItemLive(collectionId: string, request: Webflow.collections.ItemsCreateItemLiveRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
     /**
-     * Create single Item in a Collection with multiple corresponding locales. </br></br> Required scope | `CMS:write`
+     * Remove an item or multiple items (up to 100 items) from the live site. Deleting published items will unpublish the items from the live site and set them to draft.
+     *
+     * **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be unpublished only in the primary locale.
+     *
+     * Required scope | `CMS:write`
      *
      * @param {string} collectionId - Unique identifier for a Collection
-     * @param {Webflow.BulkCollectionItem} request
+     * @param {Webflow.collections.ItemsDeleteItemsLiveRequest} request
      * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Webflow.BadRequestError}
@@ -127,13 +266,131 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await client.collections.items.createItemForMultipleLocales("580e63fc8c9a982ac9b8b745", {
-     *         id: "580e64008c9a982ac9b8b754"
+     *     await client.collections.items.deleteItemsLive("580e63fc8c9a982ac9b8b745")
+     */
+    deleteItemsLive(collectionId: string, request?: Webflow.collections.ItemsDeleteItemsLiveRequest, requestOptions?: Items.RequestOptions): Promise<void>;
+    /**
+     * Update a single live item or multiple live items (up to 100) in a Collection
+     *
+     * **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale.
+     *
+     * Required scope | `CMS:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.collections.ItemsUpdateItemsLiveRequest} 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.updateItemsLive("580e63fc8c9a982ac9b8b745", {
+     *         items: [{
+     *                 id: "66f6ed9576ddacf3149d5ea6",
+     *                 cmsLocaleId: "66f6e966c9e1dc700a857ca5",
+     *                 fieldData: {
+     *                     name: "Ne Paniquez Pas",
+     *                     slug: "ne-paniquez-pas"
+     *                 }
+     *             }, {
+     *                 id: "66f6ed9576ddacf3149d5ea6",
+     *                 cmsLocaleId: "66f6e966c9e1dc700a857ca4",
+     *                 fieldData: {
+     *                     name: "No Entrar en P\u00E1nico",
+     *                     slug: "no-entrar-en-panico"
+     *                 }
+     *             }, {
+     *                 id: "66f6ed9576ddacf3149d5eaa",
+     *                 cmsLocaleId: "66f6e966c9e1dc700a857ca5",
+     *                 fieldData: {
+     *                     name: "Au Revoir et Merci pour Tous les Poissons",
+     *                     slug: "au-revoir-et-merci"
+     *                 }
+     *             }, {
+     *                 id: "66f6ed9576ddacf3149d5eaa",
+     *                 cmsLocaleId: "66f6e966c9e1dc700a857ca4",
+     *                 fieldData: {
+     *                     name: "Hasta Luego y Gracias por Todo el Pescado",
+     *                     slug: "hasta-luego-y-gracias"
+     *                 }
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.collections.items.updateItemsLive("580e63fc8c9a982ac9b8b745", {
+     *         items: [{
+     *                 id: "580e64008c9a982ac9b8b754",
+     *                 isArchived: false,
+     *                 isDraft: false,
+     *                 fieldData: {
+     *                     name: "Senior Data Analyst",
+     *                     slug: "senior-data-analyst"
+     *                 }
+     *             }, {
+     *                 id: "580e64008c9a982ac9b8b754",
+     *                 isArchived: false,
+     *                 isDraft: false,
+     *                 fieldData: {
+     *                     name: "Product Manager",
+     *                     slug: "product-manager"
+     *                 }
+     *             }]
      *     })
      */
-    createItemForMultipleLocales(collectionId: string, request: Webflow.BulkCollectionItem, requestOptions?: Items.RequestOptions): Promise<Webflow.BulkCollectionItem>;
+    updateItemsLive(collectionId: string, request?: Webflow.collections.ItemsUpdateItemsLiveRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItemListNoPagination>;
     /**
-     * Get details of a selected Collection Item. </br></br> Required scope | `CMS:read`
+     * Create an item or multiple items in a CMS Collection across multiple corresponding locales.
+     *
+     * **Notes:**
+     *
+     * - This endpoint can create up to 100 items in a request.
+     * - If the `cmsLocaleIds` parameter is undefined or empty and localization is enabled, items will only be created in the primary locale.
+     *
+     * Required scope | `CMS:write`
+     *
+     * @param {string} collectionId - Unique identifier for a Collection
+     * @param {Webflow.collections.CreateBulkCollectionItemRequestBody} 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.createItems("580e63fc8c9a982ac9b8b745", {
+     *         cmsLocaleIds: ["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4", "66f6e966c9e1dc700a857ca5"],
+     *         isArchived: false,
+     *         isDraft: false,
+     *         fieldData: {
+     *             name: "Don\u2019t Panic",
+     *             slug: "dont-panic"
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.collections.items.createItems("580e63fc8c9a982ac9b8b745", {
+     *         cmsLocaleIds: ["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4"],
+     *         isArchived: false,
+     *         isDraft: false,
+     *         fieldData: [{
+     *                 name: "Don\u2019t Panic",
+     *                 slug: "dont-panic"
+     *             }, {
+     *                 name: "So Long and Thanks for All the Fish",
+     *                 slug: "so-long-and-thanks"
+     *             }]
+     *     })
+     */
+    createItems(collectionId: string, request?: Webflow.collections.CreateBulkCollectionItemRequestBody, requestOptions?: Items.RequestOptions): Promise<Webflow.BulkCollectionItem>;
+    /**
+     * Get details of a selected Collection Item.
+     *
+     * Required scope | `CMS:read`
      *
      * @param {string} collectionId - Unique identifier for a Collection
      * @param {string} itemId - Unique identifier for an Item
@@ -151,7 +408,9 @@ export declare class Items {
      */
     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`
+     * Delete an Item from a Collection. This endpoint does not currently support bulk deletion.
+     *
+     * Required scope | `CMS:write`
      *
      * @param {string} collectionId - Unique identifier for a Collection
      * @param {string} itemId - Unique identifier for an Item
@@ -169,7 +428,9 @@ export declare class Items {
      */
     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`
+     * Update a selected Item in a Collection.
+     *
+     * Required scope | `CMS:write`
      *
      * @param {string} collectionId - Unique identifier for a Collection
      * @param {string} itemId - Unique identifier for an Item
@@ -199,7 +460,9 @@ export declare class Items {
      */
     updateItem(collectionId: string, itemId: string, request: Webflow.CollectionItem, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
     /**
-     * Get details of a selected Collection live Item. </br></br> Required scope | `CMS:read`
+     * Get details of a selected Collection live Item.
+     *
+     * Required scope | `CMS:read`
      *
      * @param {string} collectionId - Unique identifier for a Collection
      * @param {string} itemId - Unique identifier for an Item
@@ -217,7 +480,11 @@ export declare class Items {
      */
     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`
+     * 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.
+     *
+     * Required scope | `CMS:write`
      *
      * @param {string} collectionId - Unique identifier for a Collection
      * @param {string} itemId - Unique identifier for an Item
@@ -235,7 +502,9 @@ export declare class Items {
      */
     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`
+     * Update a selected live Item in a Collection. The updates for this Item will be published to the live site.
+     *
+     * Required scope | `CMS:write`
      *
      * @param {string} collectionId - Unique identifier for a Collection
      * @param {string} itemId - Unique identifier for an Item
@@ -265,7 +534,9 @@ 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`
+     * Publish an item or multiple items.
+     *
+     * Required scope | `cms:write`
      *
      * @param {string} collectionId - Unique identifier for a Collection
      * @param {Webflow.collections.ItemsPublishItemRequest} request
@@ -274,6 +545,7 @@ export declare class Items {
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.ConflictError}
      * @throws {@link Webflow.TooManyRequestsError}
      * @throws {@link Webflow.InternalServerError}
      *