webflow-api 3.0.1 → 3.1.1

package/api/types/Dom.d.ts

@@ -3,11 +3,13 @@
  */
 import * as Webflow from "../index";
 /**
- * The DOM (Document Object Model) schema represents the content structure of a web page. It captures various content nodes, such as text and images, along with their associated attributes. Each node has a unique identifier and can be of different types like text or image. The schema also provides pagination details for scenarios where the content nodes are too many to be fetched in a single request.
+ * The DOM (Document Object Model) schema represents the content structure of a web page or component. It captures various content nodes along with their associated attributes. Each node has a unique identifier and can be of different types like text, image or component-instance. The schema also provides pagination details for scenarios where the content nodes are too many to be fetched in a single request.
  */
 export interface Dom {
     /** Page ID */
     pageId?: string;
     nodes?: Webflow.Node[];
     pagination?: Webflow.Pagination;
+    /** The date the page dom was most recently updated */
+    lastUpdated?: Date;
 }

package/api/types/Domain.d.ts

@@ -6,4 +6,6 @@ export interface Domain {
     id: string;
     /** The registered Domain name */
     url?: string;
+    /** The date the custom domain was last published to */
+    lastPublished?: Date;
 }

package/api/types/Error_.d.ts

@@ -10,5 +10,5 @@ export interface Error_ {
     /** Link to more information */
     externalReference?: string;
     /** Array of errors */
-    details?: Webflow.ErrorDetailsItem[];
+    details?: unknown[];
 }

package/api/types/FieldCreate.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../index";
+/**
+ * Details about the field of a collection
+ */
+export declare type FieldCreate = Webflow.StaticField | Webflow.OptionField | Webflow.ReferenceField;

package/api/types/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/api/types/FieldType.d.ts

@@ -4,19 +4,21 @@
 /**
  * Choose these appropriate field type for your collection data
  */
-export declare type FieldType = "PlainText" | "RichText" | "Image" | "MultiImage" | "Video" | "Link" | "Email" | "Phone" | "Number" | "DateTime" | "Switch" | "Color" | "ExtFileRef";
+export declare type FieldType = "Color" | "DateTime" | "Email" | "ExtFileRef" | "Image" | "Link" | "MultiImage" | "MultiReference" | "Number" | "Phone" | "PlainText" | "Reference" | "RichText" | "Switch" | "Video";
 export declare const FieldType: {
-    readonly PlainText: "PlainText";
-    readonly RichText: "RichText";
+    readonly Color: "Color";
+    readonly DateTime: "DateTime";
+    readonly Email: "Email";
+    readonly ExtFileRef: "ExtFileRef";
     readonly Image: "Image";
-    readonly MultiImage: "MultiImage";
-    readonly Video: "Video";
     readonly Link: "Link";
-    readonly Email: "Email";
-    readonly Phone: "Phone";
+    readonly MultiImage: "MultiImage";
+    readonly MultiReference: "MultiReference";
     readonly Number: "Number";
-    readonly DateTime: "DateTime";
+    readonly Phone: "Phone";
+    readonly PlainText: "PlainText";
+    readonly Reference: "Reference";
+    readonly RichText: "RichText";
     readonly Switch: "Switch";
-    readonly Color: "Color";
-    readonly ExtFileRef: "ExtFileRef";
+    readonly Video: "Video";
 };

package/api/types/FieldType.js

@@ -5,17 +5,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FieldType = void 0;
 exports.FieldType = {
-    PlainText: "PlainText",
-    RichText: "RichText",
+    Color: "Color",
+    DateTime: "DateTime",
+    Email: "Email",
+    ExtFileRef: "ExtFileRef",
     Image: "Image",
-    MultiImage: "MultiImage",
-    Video: "Video",
     Link: "Link",
-    Email: "Email",
-    Phone: "Phone",
+    MultiImage: "MultiImage",
+    MultiReference: "MultiReference",
     Number: "Number",
-    DateTime: "DateTime",
+    Phone: "Phone",
+    PlainText: "PlainText",
+    Reference: "Reference",
+    RichText: "RichText",
     Switch: "Switch",
-    Color: "Color",
-    ExtFileRef: "ExtFileRef",
+    Video: "Video",
 };

package/api/types/ImageNode.d.ts

@@ -1,10 +1,15 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Webflow from "../index";
 /**
  * Represents an image within the DOM. It contains details about the image, such as its alternative text (alt) for accessibility and an asset identifier for fetching the actual image resource. Additional attributes can be associated with the image for styling or other purposes.
  */
 export interface ImageNode {
-    alt?: string;
-    assetId?: string;
+    /** Node UUID */
+    id?: string;
+    /** The image details of the node */
+    image?: Webflow.ImageNodeImage;
+    /** The custom attributes of the node */
+    attributes?: Record<string, string>;
 }

package/api/types/ImageNodeImage.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The image details of the node
+ */
+export interface ImageNodeImage {
+    alt?: string;
+    assetId?: string;
+}

package/api/types/ImageNodeImage.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/api/types/Metadata.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../index";
+/**
+ * The metadata for the Option field.
+ */
+export interface Metadata {
+    /** The option values for the Option field. */
+    options: Webflow.MetadataOptionsItem[];
+}

package/api/types/Metadata.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/api/types/MetadataOptionsItem.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A single option value for the Option field.
+ */
+export interface MetadataOptionsItem {
+    /** The name of the option */
+    name: string;
+    /** The unique identifier of the option */
+    id?: string;
+}

package/api/types/MetadataOptionsItem.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/api/types/Node.d.ts

@@ -5,12 +5,15 @@ import * as Webflow from "../index";
 /**
  * A generic representation of a content element within the Document Object Model (DOM). Each node has a unique identifier and a specific type that determines its content structure and attributes.
  */
-export interface Node {
-    /** Node UUID */
-    id?: string;
-    type?: Webflow.NodeType;
-    text?: Webflow.TextNode;
-    image?: Webflow.ImageNode;
-    /** The custom attributes of the node */
-    attributes?: Record<string, string>;
+export declare type Node = Webflow.Node.Text | Webflow.Node.Image | Webflow.Node.ComponentInstance;
+export declare namespace Node {
+    interface Text extends Webflow.TextNode {
+        type: "text";
+    }
+    interface Image extends Webflow.ImageNode {
+        type: "image";
+    }
+    interface ComponentInstance extends Webflow.ComponentNode {
+        type: "component-instance";
+    }
 }

package/api/types/{ErrorDetailsItem.d.ts → NotEnterprisePlanWorkspace.d.ts}

@@ -1,4 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type ErrorDetailsItem = string | Record<string, unknown>;
+export declare type NotEnterprisePlanWorkspace = unknown;

package/api/types/NotEnterprisePlanWorkspace.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/api/types/OAuthScope.d.ts

@@ -11,6 +11,12 @@ export declare type OauthScope =
 /**
  * write assets on a site */
  | "assets:write"
+/**
+ * read comments on the site */
+ | "comments:read"
+/**
+ * read comments on the site */
+ | "comments:write"
 /**
  * read collections and items for a site */
  | "cms:read"
@@ -72,6 +78,8 @@ export declare const OauthScope: {
     readonly AuthorizedUserRead: "authorized_user:read";
     readonly AssetsRead: "assets:read";
     readonly AssetsWrite: "assets:write";
+    readonly CommentsRead: "comments:read";
+    readonly CommentsWrite: "comments:write";
     readonly CmsRead: "cms:read";
     readonly CmsWrite: "cms:write";
     readonly CustomCodeRead: "custom_code:read";

package/api/types/OAuthScope.js

@@ -8,6 +8,8 @@ exports.OauthScope = {
     AuthorizedUserRead: "authorized_user:read",
     AssetsRead: "assets:read",
     AssetsWrite: "assets:write",
+    CommentsRead: "comments:read",
+    CommentsWrite: "comments:write",
     CmsRead: "cms:read",
     CmsWrite: "cms:write",
     CustomCodeRead: "custom_code:read",

package/api/types/OptionField.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../index";
+export interface OptionField {
+    /** Unique identifier for a Field */
+    id?: string;
+    /** Define whether the field is editable */
+    isEditable?: boolean;
+    /** define whether a field is required in a collection */
+    isRequired?: boolean;
+    /** The [Option field type](/data/reference/field-types-item-values#option) */
+    type: "Option";
+    /** The name of a field */
+    displayName: string;
+    /** Additional text to help anyone filling out this field */
+    helpText?: string;
+    metadata: Webflow.Metadata;
+}

package/api/types/OptionField.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/api/types/ProductFieldData.d.ts

@@ -3,7 +3,7 @@
  */
 import * as Webflow from "../index";
 /**
- * Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.
+ * Contains content-specific details for a product, covering both standard (e.g., title, description)  and custom fields tailored to the product setup.
  */
 export interface ProductFieldData {
     /** Name of the Product */

package/api/types/Redirect.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A single redirection rule, specifying a source URL and a destination URL.
+ */
+export interface Redirect {
+    /** The ID of the specific redirect rule */
+    id?: string;
+    /** The source URL path that will be redirected. */
+    fromUrl?: string;
+    /** The target URL path where the user or client will be redirected. */
+    toUrl?: string;
+}

package/api/types/Redirect.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/api/types/Redirects.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../index";
+/**
+ * Site redirects response
+ */
+export interface Redirects {
+    /** List of redirects for a given site */
+    redirects?: Webflow.Redirect[];
+    pagination?: Webflow.Pagination;
+}

package/api/types/Redirects.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/api/types/ReferenceField.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../index";
+export interface ReferenceField {
+    /** Unique identifier for a Field */
+    id?: string;
+    /** Define whether the field is editable */
+    isEditable?: boolean;
+    /** define whether a field is required in a collection */
+    isRequired?: boolean;
+    /** Choose these appropriate field type for your collection data */
+    type: Webflow.ReferenceFieldType;
+    /** The name of a field */
+    displayName: string;
+    /** Additional text to help anyone filling out this field */
+    helpText?: string;
+    /** The collectionId for the referenced collection. Only applicable for Reference and MultiReference fields. */
+    metadata: Webflow.ReferenceFieldMetadata;
+}

package/api/types/ReferenceField.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/api/types/ReferenceFieldMetadata.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The collectionId for the referenced collection. Only applicable for Reference and MultiReference fields.
+ */
+export interface ReferenceFieldMetadata {
+    /** The unique identifier of the collection */
+    collectionId: string;
+}

package/api/types/ReferenceFieldMetadata.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/api/types/ReferenceFieldType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Choose these appropriate field type for your collection data
+ */
+export declare type ReferenceFieldType = "MultiReference" | "Reference";
+export declare const ReferenceFieldType: {
+    readonly MultiReference: "MultiReference";
+    readonly Reference: "Reference";
+};

package/api/types/{NodeType.js → ReferenceFieldType.js}

@@ -3,8 +3,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NodeType = void 0;
-exports.NodeType = {
-    Text: "text",
-    Image: "image",
+exports.ReferenceFieldType = void 0;
+exports.ReferenceFieldType = {
+    MultiReference: "MultiReference",
+    Reference: "Reference",
 };

package/api/types/Robots.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../index";
+/**
+ * The robots.txt file for a given site
+ */
+export interface Robots {
+    /** List of rules for user agents. */
+    rules?: Webflow.RobotsRulesItem[];
+    /** URL to the sitemap. */
+    sitemap?: string;
+}

package/api/types/Robots.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/api/types/RobotsRulesItem.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RobotsRulesItem {
+    /** The user agent the rules apply to. */
+    userAgent: string;
+    /** List of paths allowed for this user agent. */
+    allows?: string[];
+    /** List of paths disallowed for this user agent. */
+    disallows?: string[];
+}

package/api/types/RobotsRulesItem.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/api/types/ScriptApply.d.ts

@@ -7,7 +7,7 @@ export interface ScriptApply {
     id: string;
     /** Location of the script, either in the header or footer of the published site */
     location: Webflow.ScriptApplyLocation;
-    /** Semantic Version String for the registered script _e.g. 0.0.1_ */
+    /** Semantic Version String for the registered script *e.g. 0.0.1* */
     version: string;
     /** Developer-specified key/value pairs to be applied as attributes to the script */
     attributes?: Record<string, unknown>;

package/api/types/SitePlan.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../index";
+export interface SitePlan {
+    /** ID of the hosting plan. */
+    id?: Webflow.SitePlanId;
+    /** Name of the hosting plan. */
+    name?: Webflow.SitePlanName;
+    /** URL for more information about Webflow hosting plan pricing. */
+    pricingInfo?: string;
+}

package/api/types/SitePlan.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/api/types/SitePlanId.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * ID of the hosting plan.
+ */
+export declare type SitePlanId = "hosting-basic-v3" | "hosting-cms-v3" | "hosting-business-v3" | "hosting-ecommerce-standard-v2" | "hosting-ecommerce-plus-v2" | "hosting-ecommerce-advanced-v2" | "hosting-basic-v4" | "hosting-cms-v4" | "hosting-business-v4" | "hosting-ecommerce-standard-v3" | "hosting-ecommerce-plus-v3" | "hosting-ecommerce-advanced-v3";
+export declare const SitePlanId: {
+    readonly HostingBasicV3: "hosting-basic-v3";
+    readonly HostingCmsV3: "hosting-cms-v3";
+    readonly HostingBusinessV3: "hosting-business-v3";
+    readonly HostingEcommerceStandardV2: "hosting-ecommerce-standard-v2";
+    readonly HostingEcommercePlusV2: "hosting-ecommerce-plus-v2";
+    readonly HostingEcommerceAdvancedV2: "hosting-ecommerce-advanced-v2";
+    readonly HostingBasicV4: "hosting-basic-v4";
+    readonly HostingCmsV4: "hosting-cms-v4";
+    readonly HostingBusinessV4: "hosting-business-v4";
+    readonly HostingEcommerceStandardV3: "hosting-ecommerce-standard-v3";
+    readonly HostingEcommercePlusV3: "hosting-ecommerce-plus-v3";
+    readonly HostingEcommerceAdvancedV3: "hosting-ecommerce-advanced-v3";
+};

package/api/types/SitePlanId.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitePlanId = void 0;
+exports.SitePlanId = {
+    HostingBasicV3: "hosting-basic-v3",
+    HostingCmsV3: "hosting-cms-v3",
+    HostingBusinessV3: "hosting-business-v3",
+    HostingEcommerceStandardV2: "hosting-ecommerce-standard-v2",
+    HostingEcommercePlusV2: "hosting-ecommerce-plus-v2",
+    HostingEcommerceAdvancedV2: "hosting-ecommerce-advanced-v2",
+    HostingBasicV4: "hosting-basic-v4",
+    HostingCmsV4: "hosting-cms-v4",
+    HostingBusinessV4: "hosting-business-v4",
+    HostingEcommerceStandardV3: "hosting-ecommerce-standard-v3",
+    HostingEcommercePlusV3: "hosting-ecommerce-plus-v3",
+    HostingEcommerceAdvancedV3: "hosting-ecommerce-advanced-v3",
+};

package/api/types/SitePlanName.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Name of the hosting plan.
+ */
+export declare type SitePlanName = "Basic Hosting" | "CMS Hosting" | "Business Hosting" | "ECommerce Standard Hosting" | "ECommerce Plus Hosting" | "ECommerce Advanced Hosting";
+export declare const SitePlanName: {
+    readonly BasicHosting: "Basic Hosting";
+    readonly CmsHosting: "CMS Hosting";
+    readonly BusinessHosting: "Business Hosting";
+    readonly ECommerceStandardHosting: "ECommerce Standard Hosting";
+    readonly ECommercePlusHosting: "ECommerce Plus Hosting";
+    readonly ECommerceAdvancedHosting: "ECommerce Advanced Hosting";
+};

package/api/types/SitePlanName.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitePlanName = void 0;
+exports.SitePlanName = {
+    BasicHosting: "Basic Hosting",
+    CmsHosting: "CMS Hosting",
+    BusinessHosting: "Business Hosting",
+    ECommerceStandardHosting: "ECommerce Standard Hosting",
+    ECommercePlusHosting: "ECommerce Plus Hosting",
+    ECommerceAdvancedHosting: "ECommerce Advanced Hosting",
+};

package/api/types/SkuFieldData.d.ts

@@ -15,7 +15,9 @@ export interface SkuFieldData {
     price: Webflow.SkuFieldDataPrice;
     /** comparison price of SKU */
     compareAtPrice?: Webflow.SkuFieldDataCompareAtPrice;
+    /** [Billing method](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#billing-methods)for the SKU */
     ecSkuBillingMethod?: Webflow.SkuFieldDataEcSkuBillingMethod;
+    /** [Subscription plan](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#subscription) for the SKU */
     ecSkuSubscriptionPlan?: Webflow.SkuFieldDataEcSkuSubscriptionPlan;
     /** A boolean indicating whether inventory for this product should be tracked. */
     trackInventory?: boolean;

package/api/types/SkuFieldDataEcSkuBillingMethod.d.ts

@@ -1,6 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * [Billing method](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#billing-methods)for the SKU
+ */
 export declare type SkuFieldDataEcSkuBillingMethod = "one-time" | "subscription";
 export declare const SkuFieldDataEcSkuBillingMethod: {
     readonly OneTime: "one-time";

package/api/types/SkuFieldDataEcSkuSubscriptionPlan.d.ts

@@ -2,6 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Webflow from "../index";
+/**
+ * [Subscription plan](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#subscription) for the SKU
+ */
 export interface SkuFieldDataEcSkuSubscriptionPlan {
     /** Interval of subscription renewal */
     interval?: Webflow.SkuFieldDataEcSkuSubscriptionPlanInterval;

package/api/{resources/collections/resources/fields/client/requests/FieldCreate.d.ts → types/StaticField.d.ts}

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

package/api/types/StaticField.js

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