webflow-api 2.0.0 → 2.1.2

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../../../../../..";
+/**
+ * @example
+ *     {
+ *         isRequired: false,
+ *         type: Webflow.collections.FieldCreateType.RichText,
+ *         displayName: "Post Body",
+ *         helpText: "Add the body of your post here"
+ *     }
+ */
+export interface FieldCreate {
+    /** define whether a field is required in a collection */
+    isRequired?: boolean;
+    /** Choose these appropriate field type for your collection data */
+    type: Webflow.collections.FieldCreateType;
+    /** The name of a field */
+    displayName: string;
+    /** Additional text to help anyone filling out this field */
+    helpText?: string;
+}

package/dist/api/resources/collections/resources/fields/client/requests/FieldCreate.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -3,7 +3,11 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         isRequired: false,
+ *         displayName: "Post Body",
+ *         helpText: "Add the body of your post here"
+ *     }
  */
 export interface FieldUpdate {
     /** Define whether a field is required in a collection */

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

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

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

@@ -1 +1,2 @@
+export * from "./types";
 export * from "./client";

package/dist/api/resources/collections/resources/fields/index.js

@@ -14,4 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
 __exportStar(require("./client"), exports);

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * 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 const FieldCreateType: {
+    readonly PlainText: "PlainText";
+    readonly RichText: "RichText";
+    readonly Image: "Image";
+    readonly MultiImage: "MultiImage";
+    readonly Video: "Video";
+    readonly Link: "Link";
+    readonly Email: "Email";
+    readonly Phone: "Phone";
+    readonly Number: "Number";
+    readonly DateTime: "DateTime";
+    readonly Boolean: "Boolean";
+    readonly Color: "Color";
+    readonly File: "File";
+};

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

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldCreateType = void 0;
+exports.FieldCreateType = {
+    PlainText: "PlainText",
+    RichText: "RichText",
+    Image: "Image",
+    MultiImage: "MultiImage",
+    Video: "Video",
+    Link: "Link",
+    Email: "Email",
+    Phone: "Phone",
+    Number: "Number",
+    DateTime: "DateTime",
+    Boolean: "Boolean",
+    Color: "Color",
+    File: "File",
+};

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

@@ -0,0 +1 @@
+export * from "./FieldCreateType";

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

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./FieldCreateType"), exports);

package/dist/api/resources/collections/resources/index.d.ts

@@ -1,5 +1,6 @@
+export * as fields from "./fields";
+export * from "./fields/types";
 export * as items from "./items";
 export * from "./items/types";
-export * as fields from "./fields";
 export * from "./fields/client/requests";
 export * from "./items/client/requests";

package/dist/api/resources/collections/resources/index.js

@@ -26,9 +26,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fields = exports.items = void 0;
+exports.items = exports.fields = void 0;
+exports.fields = __importStar(require("./fields"));
+__exportStar(require("./fields/types"), exports);
 exports.items = __importStar(require("./items"));
 __exportStar(require("./items/types"), exports);
-exports.fields = __importStar(require("./fields"));
 __exportStar(require("./fields/client/requests"), exports);
 __exportStar(require("./items/client/requests"), exports);

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

@@ -18,7 +18,7 @@ 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. </br></br> Required scope | `CMS:read`
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -26,11 +26,11 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.listItems("string", {})
+     *     await webflow.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> Required scope | `cms:write`
+     * 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`
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -38,17 +38,21 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.createItem("string", {
+     *     await webflow.collections.items.createItem("collection_id", {
      *         id: "580e64008c9a982ac9b8b754",
+     *         cmsLocaleId: "653ad57de882f528b32e810e",
      *         lastPublished: "2023-03-17T18:47:35.560Z",
      *         lastUpdated: "2023-03-17T18:47:35.560Z",
      *         createdOn: "2023-03-17T18:47:35.560Z",
-     *         fieldData: {}
+     *         fieldData: {
+     *             name: "My new item",
+     *             slug: "my-new-item"
+     *         }
      *     })
      */
     createItem(collectionId: string, request: Webflow.CollectionItem, requestOptions?: Items.RequestOptions): Promise<void>;
     /**
-     * Get details of a selected Collection Item. </br></br> Required scope | `cms:read`
+     * 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`
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -56,11 +60,42 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.getItem("string", "string")
+     *     await webflow.collections.items.createItemLive("collection_id", {
+     *         id: "580e64008c9a982ac9b8b754",
+     *         cmsLocaleId: "653ad57de882f528b32e810e",
+     *         lastPublished: "2023-03-17T18:47:35.560Z",
+     *         lastUpdated: "2023-03-17T18:47:35.560Z",
+     *         createdOn: "2023-03-17T18:47:35.560Z",
+     *         fieldData: {
+     *             name: "My new item",
+     *             slug: "my-new-item"
+     *         }
+     *     })
+     */
+    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`
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await webflow.collections.items.createItemForMultipleLocales("collection_id", {
+     *         id: "580e64008c9a982ac9b8b754",
+     *         lastPublished: "2023-03-17T18:47:35.560Z",
+     *         lastUpdated: "2023-03-17T18:47:35.560Z",
+     *         createdOn: "2023-03-17T18:47:35.560Z",
+     *         fieldData: {
+     *             name: "My new item",
+     *             slug: "my-new-item"
+     *         }
+     *     })
      */
-    getItem(collectionId: string, itemId: string, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
+    createItemForMultipleLocales(collectionId: string, request: Webflow.collections.BulkCollectionItem, requestOptions?: Items.RequestOptions): Promise<void>;
     /**
-     * Delete an Item from a Collection. This endpoint does not currently support bulk deletion. </br></br> Required scope | `cms:write`
+     * Get details of a selected Collection Item. </br></br> Required scope | `CMS:read`
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -68,11 +103,11 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.deleteItem("string", "string")
+     *     await webflow.collections.items.getItem("collection_id", "item_id", {})
      */
-    deleteItem(collectionId: string, itemId: string, requestOptions?: Items.RequestOptions): Promise<void>;
+    getItem(collectionId: string, itemId: string, request?: Webflow.collections.ItemsGetItemRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
     /**
-     * Update a selected Item in a Collection. </br></br> Required scope | `cms:write`
+     * Delete an Item from a Collection. This endpoint does not currently support bulk deletion. </br></br> Required scope | `CMS:write`
      * @throws {@link Webflow.BadRequestError}
      * @throws {@link Webflow.UnauthorizedError}
      * @throws {@link Webflow.NotFoundError}
@@ -80,15 +115,65 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.updateItem("string", "string", {
+     *     await webflow.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`
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await webflow.collections.items.updateItem("collection_id", "item_id", {
      *         id: "580e64008c9a982ac9b8b754",
+     *         cmsLocaleId: "653ad57de882f528b32e810e",
      *         lastPublished: "2023-03-17T18:47:35.560Z",
      *         lastUpdated: "2023-03-17T18:47:35.560Z",
      *         createdOn: "2023-03-17T18:47:35.560Z",
-     *         fieldData: {}
+     *         fieldData: {
+     *             name: "My new item",
+     *             slug: "my-new-item"
+     *         }
      *     })
      */
     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`
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await webflow.collections.items.deleteItemLive("collection_id", "item_id")
+     */
+    deleteItemLive(collectionId: string, itemId: string, 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`
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await webflow.collections.items.updateItemLive("collection_id", "item_id", {
+     *         id: "580e64008c9a982ac9b8b754",
+     *         cmsLocaleId: "653ad57de882f528b32e810e",
+     *         lastPublished: "2023-03-17T18:47:35.560Z",
+     *         lastUpdated: "2023-03-17T18:47:35.560Z",
+     *         createdOn: "2023-03-17T18:47:35.560Z",
+     *         fieldData: {
+     *             name: "My new item",
+     *             slug: "my-new-item"
+     *         }
+     *     })
+     */
+    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`
      * @throws {@link Webflow.BadRequestError}
@@ -98,8 +183,8 @@ export declare class Items {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.collections.items.publishItem("string", {
-     *         itemIds: []
+     *     await webflow.collections.items.publishItem("collection_id", {
+     *         itemIds: ["itemIds"]
      *     })
      */
     publishItem(collectionId: string, request: Webflow.collections.ItemsPublishItemRequest, requestOptions?: Items.RequestOptions): Promise<Webflow.collections.ItemsPublishItemResponse>;