webflow-api 3.1.3 → 3.2.0

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

@@ -7,7 +7,11 @@ import * as Webflow from "../../../../../index";
 export declare namespace Items {
     interface Options {
         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>;
+        /** 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 Items {
         /** 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>;
     }
 }
 export declare class Items {
@@ -41,12 +45,13 @@ export declare class Items {
      * @example
      *     await client.collections.items.listItems("580e63fc8c9a982ac9b8b745")
      */
-    listItems(collectionId: string, request?: Webflow.collections.ItemsListItemsRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItemList>;
+    listItems(collectionId: string, request?: Webflow.collections.ItemsListItemsRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItemList>;
+    private __listItems;
     /**
      * Create Item(s) in a Collection.
      *
      *
-     * To create items across multiple locales, please use [this endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items)
+     * To create items across multiple locales, please use [this endpoint.](/data/reference/cms/collection-items/staged-items/create-items)
      *
      * Required scope | `CMS:write`
      *
@@ -62,34 +67,39 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
-     *         isArchived: false,
-     *         isDraft: false,
-     *         fieldData: {
-     *             name: "Pan Galactic Gargle Blaster Recipe",
-     *             slug: "pan-galactic-gargle-blaster"
+     *         body: {
+     *             isArchived: false,
+     *             isDraft: false,
+     *             fieldData: {
+     *                 name: "Pan Galactic Gargle Blaster Recipe",
+     *                 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"
-     *                 }
-     *             }]
+     *         body: {
+     *             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.collections.ItemsCreateItemRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    createItem(collectionId: string, request: Webflow.collections.ItemsCreateItemRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItem>;
+    private __createItem;
     /**
      * Delete Items from a Collection.
      *
@@ -115,7 +125,8 @@ export declare class Items {
      *             }]
      *     })
      */
-    deleteItems(collectionId: string, request: Webflow.collections.ItemsDeleteItemsRequest, requestOptions?: Items.RequestOptions): Promise<void>;
+    deleteItems(collectionId: string, request: Webflow.collections.ItemsDeleteItemsRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteItems;
     /**
      * Update a single item or multiple items in a Collection.
      *
@@ -189,7 +200,8 @@ export declare class Items {
      *             }]
      *     })
      */
-    updateItems(collectionId: string, request?: Webflow.collections.ItemsUpdateItemsRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    updateItems(collectionId: string, request?: Webflow.collections.ItemsUpdateItemsRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.collections.ItemsUpdateItemsResponse>;
+    private __updateItems;
     /**
      * List all published items in a collection.
      *
@@ -213,12 +225,13 @@ export declare class Items {
      * @example
      *     await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745")
      */
-    listItemsLive(collectionId: string, request?: Webflow.collections.ItemsListItemsLiveRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItemList>;
+    listItemsLive(collectionId: string, request?: Webflow.collections.ItemsListItemsLiveRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItemList>;
+    private __listItemsLive;
     /**
      * Create item(s) in a collection that will be immediately published to the live site.
      *
      *
-     * To create items across multiple locales, [please use this endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items)
+     * To create items across multiple locales, [please use this endpoint.](/data/reference/cms/collection-items/staged-items/create-items)
      *
      *
      * Required scope | `CMS:write`
@@ -235,38 +248,41 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
-     *         isArchived: false,
-     *         isDraft: false,
-     *         fieldData: {
-     *             name: "Pan Galactic Gargle Blaster Recipe",
-     *             slug: "pan-galactic-gargle-blaster"
+     *         body: {
+     *             isArchived: false,
+     *             isDraft: false,
+     *             fieldData: {
+     *                 name: "Pan Galactic Gargle Blaster Recipe",
+     *                 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"
-     *                 }
-     *             }]
+     *         body: {
+     *             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.collections.ItemsCreateItemLiveRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    createItemLive(collectionId: string, request: Webflow.collections.ItemsCreateItemLiveRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItem>;
+    private __createItemLive;
     /**
-     * Remove an item or multiple items (up to 100 items) from the live site.
-     *
-     * Using this endpoint to delete published item(s) will unpublish the item(s) from the live site and set the item(s) `isDraft` property to `true`.
+     * Unpublish up to 100 items from the live site and set the `isDraft` property to `true`.
      *
      * <Tip title="Localization Tip">Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request.</Tip>
      *
@@ -289,7 +305,8 @@ export declare class Items {
      *             }]
      *     })
      */
-    deleteItemsLive(collectionId: string, request: Webflow.collections.ItemsDeleteItemsLiveRequest, requestOptions?: Items.RequestOptions): Promise<void>;
+    deleteItemsLive(collectionId: string, request: Webflow.collections.ItemsDeleteItemsLiveRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteItemsLive;
     /**
      * Update a single published item or multiple published items (up to 100) in a Collection
      *
@@ -362,7 +379,8 @@ export declare class Items {
      *             }]
      *     })
      */
-    updateItemsLive(collectionId: string, request?: Webflow.collections.ItemsUpdateItemsLiveRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItemListNoPagination>;
+    updateItemsLive(collectionId: string, request?: Webflow.collections.ItemsUpdateItemsLiveRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItemListNoPagination>;
+    private __updateItemsLive;
     /**
      * Create an item or multiple items in a CMS Collection across multiple corresponding locales.
      *
@@ -408,7 +426,8 @@ export declare class Items {
      *             }]
      *     })
      */
-    createItems(collectionId: string, request: Webflow.collections.CreateBulkCollectionItemRequestBody, requestOptions?: Items.RequestOptions): Promise<Webflow.BulkCollectionItem>;
+    createItems(collectionId: string, request: Webflow.collections.CreateBulkCollectionItemRequestBody, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.BulkCollectionItem>;
+    private __createItems;
     /**
      * Get details of a selected Collection Item.
      *
@@ -428,7 +447,8 @@ export declare class Items {
      * @example
      *     await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754")
      */
-    getItem(collectionId: string, itemId: string, request?: Webflow.collections.ItemsGetItemRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    getItem(collectionId: string, itemId: string, request?: Webflow.collections.ItemsGetItemRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItem>;
+    private __getItem;
     /**
      * Delete an item from a collection.
      *
@@ -448,7 +468,8 @@ export declare class Items {
      * @example
      *     await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754")
      */
-    deleteItem(collectionId: string, itemId: string, request?: Webflow.collections.ItemsDeleteItemRequest, requestOptions?: Items.RequestOptions): Promise<void>;
+    deleteItem(collectionId: string, itemId: string, request?: Webflow.collections.ItemsDeleteItemRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteItem;
     /**
      * Update a selected Item in a Collection.
      *
@@ -456,7 +477,7 @@ export declare class Items {
      *
      * @param {string} collectionId - Unique identifier for a Collection
      * @param {string} itemId - Unique identifier for an Item
-     * @param {Webflow.CollectionItemPatchSingle} request
+     * @param {Webflow.collections.ItemsUpdateItemRequest} request
      * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Webflow.BadRequestError}
@@ -467,15 +488,18 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.updateItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
-     *         isArchived: false,
-     *         isDraft: false,
-     *         fieldData: {
-     *             name: "Pan Galactic Gargle Blaster Recipe",
-     *             slug: "pan-galactic-gargle-blaster"
+     *         body: {
+     *             isArchived: false,
+     *             isDraft: false,
+     *             fieldData: {
+     *                 name: "Pan Galactic Gargle Blaster Recipe",
+     *                 slug: "pan-galactic-gargle-blaster"
+     *             }
      *         }
      *     })
      */
-    updateItem(collectionId: string, itemId: string, request: Webflow.CollectionItemPatchSingle, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    updateItem(collectionId: string, itemId: string, request: Webflow.collections.ItemsUpdateItemRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItem>;
+    private __updateItem;
     /**
      * Get details of a selected Collection live Item.
      *
@@ -500,11 +524,12 @@ export declare class Items {
      * @example
      *     await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754")
      */
-    getItemLive(collectionId: string, itemId: string, request?: Webflow.collections.ItemsGetItemLiveRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    getItemLive(collectionId: string, itemId: string, request?: Webflow.collections.ItemsGetItemLiveRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItem>;
+    private __getItemLive;
     /**
-     * Remove a live item from the site. Removing a published item will unpublish the item from the live site and set it to draft.
+     * Unpublish a live item from the site and set the `isDraft` property to `true`.
      *
-     * This endpoint does not currently support bulk deletion.
+     * For bulk unpublishing, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/live-items/delete-items-live)
      *
      * Required scope | `CMS:write`
      *
@@ -522,7 +547,8 @@ export declare class Items {
      * @example
      *     await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754")
      */
-    deleteItemLive(collectionId: string, itemId: string, request?: Webflow.collections.ItemsDeleteItemLiveRequest, requestOptions?: Items.RequestOptions): Promise<void>;
+    deleteItemLive(collectionId: string, itemId: string, request?: Webflow.collections.ItemsDeleteItemLiveRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteItemLive;
     /**
      * Update a selected live Item in a Collection. The updates for this Item will be published to the live site.
      *
@@ -530,7 +556,7 @@ export declare class Items {
      *
      * @param {string} collectionId - Unique identifier for a Collection
      * @param {string} itemId - Unique identifier for an Item
-     * @param {Webflow.CollectionItemPatchSingle} request
+     * @param {Webflow.collections.ItemsUpdateItemLiveRequest} request
      * @param {Items.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Webflow.BadRequestError}
@@ -542,15 +568,18 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.updateItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
-     *         isArchived: false,
-     *         isDraft: false,
-     *         fieldData: {
-     *             name: "Pan Galactic Gargle Blaster Recipe",
-     *             slug: "pan-galactic-gargle-blaster"
+     *         body: {
+     *             isArchived: false,
+     *             isDraft: false,
+     *             fieldData: {
+     *                 name: "Pan Galactic Gargle Blaster Recipe",
+     *                 slug: "pan-galactic-gargle-blaster"
+     *             }
      *         }
      *     })
      */
-    updateItemLive(collectionId: string, itemId: string, request: Webflow.CollectionItemPatchSingle, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    updateItemLive(collectionId: string, itemId: string, request: Webflow.collections.ItemsUpdateItemLiveRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.CollectionItem>;
+    private __updateItemLive;
     /**
      * Publish an item or multiple items.
      *
@@ -569,9 +598,32 @@ export declare class Items {
      *
      * @example
      *     await client.collections.items.publishItem("580e63fc8c9a982ac9b8b745", {
-     *         itemIds: ["itemIds"]
+     *         itemIds: ["643fd856d66b6528195ee2ca", "643fd856d66b6528195ee2cb", "643fd856d66b6528195ee2cc"]
+     *     })
+     *
+     * @example
+     *     await client.collections.items.publishItem("580e63fc8c9a982ac9b8b745", {
+     *         items: [{
+     *                 id: "643fd856d66b6528195ee2ca",
+     *                 cmsLocaleIds: ["653ad57de882f528b32e810e"]
+     *             }, {
+     *                 id: "643fd856d66b6528195ee2cb",
+     *                 cmsLocaleIds: ["653ad57de882f528b32e810e"]
+     *             }, {
+     *                 id: "643fd856d66b6528195ee2cc",
+     *                 cmsLocaleIds: ["653ad57de882f528b32e810e"]
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.collections.items.publishItem("580e63fc8c9a982ac9b8b745", {
+     *         items: [{
+     *                 id: "643fd856d66b6528195ee2ca",
+     *                 cmsLocaleIds: ["653ad57de882f528b32e810e", "6514390aea353fc691d69827", "65143930ea353fc691d69cd8"]
+     *             }]
      *     })
      */
-    publishItem(collectionId: string, request: Webflow.collections.ItemsPublishItemRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.collections.ItemsPublishItemResponse>;
+    publishItem(collectionId: string, request: Webflow.collections.ItemsPublishItemRequest, requestOptions?: Items.RequestOptions): core.HttpResponsePromise<Webflow.collections.ItemsPublishItemResponse>;
+    private __publishItem;
     protected _getAuthorizationHeader(): Promise<string>;
 }