webflow-api 2.3.2 → 2.3.6

package/dist/api/types/InventoryItem.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * The availabile inventory for an item
  */

package/dist/api/types/ListCustomCodeBlocks.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * Custom Code Blocks corresponding to where scripts were applied
  */

package/dist/api/types/Locales.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface Locales {
     /** The primary locale for the site or application. */
     primary?: Webflow.Locale;

package/dist/api/types/MissingScopes.d.ts

@@ -1,14 +1,5 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
-export interface MissingScopes {
-    code?: "missing_scopes";
-    type?: string;
-    /** Error message */
-    message?: string;
-    /** Link to more information */
-    externalReference?: string;
-    /** Array of errors */
-    details?: Webflow.ErrorDetailsItem[];
-}
+import * as Webflow from "../index";
+export declare type MissingScopes = Webflow.Error_;

package/dist/api/types/Node.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+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.
  */

package/dist/api/types/NotEnterprisePlanSite.d.ts

@@ -1,14 +1,5 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
-export interface NotEnterprisePlanSite {
-    code?: "missing_scopes";
-    type?: string;
-    /** Error message */
-    message?: string;
-    /** Link to more information */
-    externalReference?: string;
-    /** Array of errors */
-    details?: Webflow.ErrorDetailsItem[];
-}
+import * as Webflow from "../index";
+export declare type NotEnterprisePlanSite = Webflow.Error_;

package/dist/api/types/OauthScope.d.ts

@@ -61,7 +61,13 @@ export declare type OauthScope =
  | "workspace:read"
 /**
  * write workspace resource data */
- | "workspace:write";
+ | "workspace:write"
+/**
+ * read site configuration data */
+ | "site_config:read"
+/**
+ * write site configuration data */
+ | "site_config:write";
 export declare const OauthScope: {
     readonly AuthorizedUserRead: "authorized_user:read";
     readonly AssetsRead: "assets:read";
@@ -83,4 +89,6 @@ export declare const OauthScope: {
     readonly UsersWrite: "users:write";
     readonly WorkspaceRead: "workspace:read";
     readonly WorkspaceWrite: "workspace:write";
+    readonly SiteConfigRead: "site_config:read";
+    readonly SiteConfigWrite: "site_config:write";
 };

package/dist/api/types/OauthScope.js

@@ -25,4 +25,6 @@ exports.OauthScope = {
     UsersWrite: "users:write",
     WorkspaceRead: "workspace:read",
     WorkspaceWrite: "workspace:write",
+    SiteConfigRead: "site_config:read",
+    SiteConfigWrite: "site_config:write",
 };

package/dist/api/types/Order.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface Order {
     /** The order id. Will usually be 6 hex characters, but can also be 9 hex characters if the site has a very large number of Orders. Randomly assigned. */
     orderId?: string;

package/dist/api/types/OrderAddress.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * A customer address
  */

package/dist/api/types/OrderList.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * Results from order list
  */

package/dist/api/types/OrderPurchasedItem.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * An Item that was purchased
  */

package/dist/api/types/OrderPurchasedItemVariantImage.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface OrderPurchasedItemVariantImage {
     /** The hosted location for the Variant's image */
     url?: string;

package/dist/api/types/OrderPurchasedItemVariantImageFile.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface OrderPurchasedItemVariantImageFile {
     /** The image size in bytes */
     size?: number;

package/dist/api/types/OrderTotals.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * An object describing various pricing totals
  */

package/dist/api/types/OrderTotalsExtrasItem.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * Extra order items, includes discounts, shipping, and taxes.
  */

package/dist/api/types/Page.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * The Page object
  */

package/dist/api/types/PageDetails.d.ts

@@ -0,0 +1,41 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "../index";
+/**
+ * The Page object
+ */
+export interface PageDetails {
+    /** Unique identifier for the Page */
+    id?: string;
+    /** Unique identifier for the Site */
+    siteId?: string;
+    /** Title of the Page */
+    title?: string;
+    /** slug of the Page (derived from title) */
+    slug?: string;
+    /** Identifier of the parent folder */
+    parentId?: string;
+    /** Unique identifier for a linked Collection, value will be null if the Page is not part of a Collection. */
+    collectionId?: string;
+    /** The date the Page was created */
+    createdOn?: Date;
+    /** The date the Page was most recently updated */
+    lastUpdated?: Date;
+    /** Whether the Page has been archived */
+    archived?: boolean;
+    /** Whether the Page is a draft */
+    draft?: boolean;
+    /** Indicates whether the Page supports [Page Branching](https://university.webflow.com/lesson/page-branching) */
+    canBranch?: boolean;
+    /** Indicates whether the Page is restricted by [Memberships Controls](https://university.webflow.com/lesson/webflow-memberships-overview#how-to-manage-page-restrictions) */
+    isMembersOnly?: boolean;
+    /** SEO-related fields for the Page */
+    seo?: Webflow.PageDetailsSeo;
+    /** Open Graph fields for the Page */
+    openGraph?: Webflow.PageDetailsOpenGraph;
+    /** Unique ID of the page locale */
+    localeId?: string;
+    /** Relative path of the published page URL */
+    publishedPath?: string;
+}

package/dist/api/types/PageDetails.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/types/PageDetailsOpenGraph.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Open Graph fields for the Page
+ */
+export interface PageDetailsOpenGraph {
+    /** The title supplied to Open Graph annotations */
+    title?: string;
+    /** Indicates the Open Graph title was copied from the SEO title */
+    titleCopied?: boolean;
+    /** The description supplied to Open Graph annotations */
+    description?: string;
+    /** Indicates the Open Graph description was copied from the SEO description */
+    descriptionCopied?: boolean;
+}

package/dist/api/types/PageDetailsOpenGraph.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/types/PageDetailsSeo.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * SEO-related fields for the Page
+ */
+export interface PageDetailsSeo {
+    /** The Page title shown in search engine results */
+    title?: string;
+    /** The Page description shown in search engine results */
+    description?: string;
+}

package/dist/api/types/PageDetailsSeo.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/types/PageList.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * The Page object
  */

package/dist/api/types/Product.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * The Product object
  */

package/dist/api/types/ProductAndSkUs.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * A product and its SKUs.
  */

package/dist/api/types/ProductAndSkUsList.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * Results from product list
  */

package/dist/api/types/ProductFieldData.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+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.
  */

package/dist/api/types/RegisteredScriptList.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * A list of scripts registered to the site
  */

package/dist/api/types/ScriptApply.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface ScriptApply {
     /** ID of the registered custom code script */
     id: string;

package/dist/api/types/ScriptApplyList.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface ScriptApplyList {
     /** A list of scripts applied to a Site or a Page */
     scripts?: Webflow.ScriptApply[];

package/dist/api/types/Scripts.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * A list of scripts applied to a Site or a Page
  */

package/dist/api/types/Site.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface Site {
     /** Unique identifier for the Site */
     id: string;

package/dist/api/types/SiteActivityLogItem.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface SiteActivityLogItem {
     id?: string;
     createdOn?: Date;

package/dist/api/types/SiteActivityLogResponse.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface SiteActivityLogResponse {
     items?: Webflow.SiteActivityLogItem[];
     pagination?: Webflow.Pagination;

package/dist/api/types/Sites.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface Sites {
     sites?: Webflow.Site[];
 }

package/dist/api/types/Sku.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * The SKU object
  */

package/dist/api/types/SkuFieldData.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * Standard and Custom fields for a SKU
  */

package/dist/api/types/SkuFieldDataEcSkuSubscriptionPlan.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface SkuFieldDataEcSkuSubscriptionPlan {
     /** Interval of subscription renewal */
     interval?: Webflow.SkuFieldDataEcSkuSubscriptionPlanInterval;

package/dist/api/types/SkuFieldDataEcSkuSubscriptionPlanPlansItem.d.ts

@@ -1,8 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface SkuFieldDataEcSkuSubscriptionPlanPlansItem {
+    /** The platform of the subscription plan */
     platform?: "stripe";
     /** The unique identifier of the plan */
     id?: string;

package/dist/api/types/SkuPropertyList.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * A variant/option type for a SKU
  */

package/dist/api/types/StripeCard.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * Details on the card used to fulfill this order, if this order was finalized with Stripe.
  */

package/dist/api/types/TooManyRequestsErrorBody.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TooManyRequestsErrorBody {
+    message?: string;
+    code?: string;
+    externalReference?: string;
+    details?: unknown[];
+}

package/dist/api/types/TooManyRequestsErrorBody.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/types/User.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items
  */

package/dist/api/types/UserAccessGroupsItem.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * Access group slugs and types
  */

package/dist/api/types/UserData.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * An object containing the User's basic info and custom fields
  */

package/dist/api/types/UserLimitReached.d.ts

@@ -1,14 +1,5 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
-export interface UserLimitReached {
-    /** Error code */
-    code?: string;
-    /** Error message */
-    message?: string;
-    /** Link to more information */
-    externalReference?: string;
-    /** Array of errors */
-    details?: Webflow.ErrorDetailsItem[];
-}
+import * as Webflow from "../index";
+export declare type UserLimitReached = Webflow.Error_;

package/dist/api/types/UserList.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 /**
  * The list users results
  */

package/dist/api/types/UsersNotEnabled.d.ts

@@ -1,14 +1,5 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
-export interface UsersNotEnabled {
-    /** Error code */
-    code?: string;
-    /** Error message */
-    message?: string;
-    /** Link to more information */
-    externalReference?: string;
-    /** Array of errors */
-    details?: Webflow.ErrorDetailsItem[];
-}
+import * as Webflow from "../index";
+export declare type UsersNotEnabled = Webflow.Error_;

package/dist/api/types/Webhook.d.ts

@@ -1,21 +1,21 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface Webhook {
     /** Unique identifier for the Webhook registration */
     id?: string;
+    triggerType?: Webflow.TriggerType;
+    /** URL to send the Webhook payload to */
+    url?: string;
     /** Unique identifier for the Workspace the Webhook is registered in */
     workspaceId?: string;
     /** Unique identifier for the Site the Webhook is registered in */
     siteId?: string;
-    triggerType?: Webflow.TriggerType;
-    /** Filter for selecting which events you want Webhooks to be sent for. Only supported for form_submission trigger types. */
-    filter?: Record<string, unknown>;
+    /** Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. */
+    filter?: Webflow.WebhookFilter;
     /** Date the Webhook instance was last triggered */
     lastTriggered?: Date;
     /** Date the Webhook registration was created */
     createdOn?: Date;
-    /** URL to send the Webhook payload to */
-    url?: string;
 }

package/dist/api/types/WebhookFilter.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for.
+ */
+export interface WebhookFilter {
+    /** The name of the form you'd like to recieve notifications for. */
+    name?: string;
+}

package/dist/api/types/WebhookFilter.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/types/WebhookList.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Webflow from "..";
+import * as Webflow from "../index";
 export interface WebhookList {
     pagination?: Webflow.Pagination;
     webhooks?: Webflow.Webhook[];