webflow-api 1.3.1 → 2.0.0

package/api/types/OrderList.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * Results from order list
+ */
+export interface OrderList {
+    /** List of orders */
+    items?: Webflow.Order[];
+    pagination?: Webflow.Pagination;
+}

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

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface OrderMetadata {
+    isBuyNow?: boolean;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface OrderPrice {
+    /** The three-letter ISO currency code */
+    unit?: string;
+    /** The numeric value in the base unit of the currency */
+    value?: string;
+    /** The user-facing string representation of the amount */
+    string?: string;
+}

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

@@ -0,0 +1,36 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * An Item that was purchased
+ */
+export interface OrderPurchasedItem {
+    /** Number of Item purchased. */
+    count?: number;
+    /** The total for the row */
+    rowTotal?: Webflow.OrderPrice;
+    /** The unique identifier for the Product */
+    productId?: string;
+    /** User-facing name of the Product */
+    productName?: string;
+    /** Slug for the Product */
+    productSlug?: string;
+    /** Identifier for the Product Variant (SKU) */
+    variantId?: string;
+    /** User-facing name of the Product Variant (SKU) */
+    variantName?: string;
+    /** Slug for the Product Variant (SKU) */
+    variantSlug?: string;
+    variantImage?: Webflow.OrderPurchasedItemVariantImage;
+    /** The price corresponding to the variant */
+    variantPrice?: Webflow.OrderPrice;
+    /** The physical weight of the variant if provided, or null */
+    weight?: number;
+    /** The physical width of the variant if provided, or null */
+    width?: number;
+    /** The physical height of the variant if provided, or null */
+    height?: number;
+    /** The physical length of the variant if provided, or null */
+    length?: number;
+}

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

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

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export interface OrderPurchasedItemVariantImageFile {
+    /** The image size in bytes */
+    size?: number;
+    /** the original name of the image */
+    originalFileName?: string;
+    /** The creation timestamp of the image */
+    createdOn?: Date;
+    /** The MIME type of the image */
+    contentType?: string;
+    /** The image width in pixels */
+    width?: number;
+    /** The image height in pixels */
+    height?: number;
+    /** Variants of the supplied image */
+    variants?: Webflow.OrderPurchasedItemVariantImageFileVariantsItem[];
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface OrderPurchasedItemVariantImageFileVariantsItem {
+    /** The hosted location for the Variant's image */
+    url?: string;
+    originalFileName?: string;
+    /** The image size in bytes */
+    size?: number;
+    /** The image width in pixels */
+    width?: number;
+    /** The image height in pixels */
+    height?: number;
+}

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The status of the Order
+ */
+export declare type OrderStatus = "pending" | "unfulfilled" | "fulfilled" | "disputed" | "dispute-lost" | "refunded";
+export declare const OrderStatus: {
+    readonly Pending: "pending";
+    readonly Unfulfilled: "unfulfilled";
+    readonly Fulfilled: "fulfilled";
+    readonly Disputed: "disputed";
+    readonly DisputeLost: "dispute-lost";
+    readonly Refunded: "refunded";
+};

package/api/types/OrderStatus.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.OrderStatus = void 0;
+exports.OrderStatus = {
+    Pending: "pending",
+    Unfulfilled: "unfulfilled",
+    Fulfilled: "fulfilled",
+    Disputed: "disputed",
+    DisputeLost: "dispute-lost",
+    Refunded: "refunded",
+};

package/api/types/OrderTotals.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * An object describing various pricing totals
+ */
+export interface OrderTotals {
+    /** The subtotal price */
+    subtotal?: Webflow.OrderPrice;
+    /** An array of extra items, includes discounts, shipping, and taxes. */
+    extras?: Webflow.OrderTotalsExtrasItem[];
+    /** The total price */
+    total?: Webflow.OrderPrice;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * Extra order items, includes discounts, shipping, and taxes.
+ */
+export interface OrderTotalsExtrasItem {
+    /** The type of extra item this is. */
+    type?: Webflow.OrderTotalsExtrasItemType;
+    /** A human-readable (but English) name for this extra charge. */
+    name?: string;
+    /** A human-readable (but English) description of this extra charge. */
+    description?: string;
+    /** The price for the item */
+    price?: Webflow.OrderPrice;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of extra item this is.
+ */
+export declare type OrderTotalsExtrasItemType = "discount" | "discount-shipping" | "shipping" | "tax";
+export declare const OrderTotalsExtrasItemType: {
+    readonly Discount: "discount";
+    readonly DiscountShipping: "discount-shipping";
+    readonly Shipping: "shipping";
+    readonly Tax: "tax";
+};

package/api/types/OrderTotalsExtrasItemType.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderTotalsExtrasItemType = void 0;
+exports.OrderTotalsExtrasItemType = {
+    Discount: "discount",
+    DiscountShipping: "discount-shipping",
+    Shipping: "shipping",
+    Tax: "tax",
+};

package/api/types/Page.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * The Page object
+ */
+export interface Page {
+    /** 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.PageSeo;
+    /** Open Graph fields for the Page */
+    openGraph?: Webflow.PageOpenGraph;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The Webhook payload for when a Page is created
+ */
+export interface PageCreatedWebhook {
+    siteId?: string;
+    pageId?: string;
+    pageTitle?: string;
+    createdAt?: Date;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The Webhook payload for when a Page is deleted
+ */
+export interface PageDeletedWebhook {
+    siteId?: string;
+    pageId?: string;
+    pageTitle?: string;
+    deletedAt?: Date;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * The Page object
+ */
+export interface PageList {
+    pages?: Webflow.Page[];
+    pagination?: Webflow.Pagination;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The Webhook payload for when a Page's metadata is updated
+ */
+export interface PageMetadataUpdatedWebhook {
+    siteId?: string;
+    pageId?: string;
+    pageTitle?: string;
+    lastUpdated?: Date;
+}

package/api/types/PageMetadataUpdatedWebhook.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/PageOpenGraph.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 PageOpenGraph {
+    /** 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/api/types/PageOpenGraph.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/PageSeo.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 PageSeo {
+    /** The Page title shown in search engine results */
+    title?: string;
+    /** The Page description shown in search engine results */
+    description?: string;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * The SEO and/or OpenGraph information to include in the page's details
+ */
+export interface PageSeoGraphData {
+    seo?: Webflow.PageSeoGraphDataSeo;
+    openGraph?: Webflow.PageSeoGraphDataOpenGraph;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PageSeoGraphDataOpenGraph {
+    title?: string;
+    description?: string;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PageSeoGraphDataSeo {
+    title?: string;
+    description?: string;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Pagination object
+ */
+export interface Pagination {
+    /** The limit used for pagination */
+    limit?: number;
+    /** The offset used for pagination */
+    offset?: number;
+    /** The total number of records */
+    total?: number;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PaypalDetails {
+    /** PayPal order identifier */
+    orderId?: string;
+    /** PayPal payer identifier */
+    payerId?: string;
+    /** PayPal capture identifier */
+    captureId?: string;
+    /** PayPal refund identifier */
+    refundId?: string;
+    /** PayPal-issued reason for the refund */
+    refundReason?: string;
+    /** PayPal dispute identifier */
+    disputeId?: string;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * The Product object
+ */
+export interface Product {
+    /** Unique identifier for the Product */
+    id?: string;
+    /** The date the Product was last published */
+    lastPublished?: Date;
+    /** The date the Product was last updated */
+    lastUpdated?: Date;
+    /** The date the Product was created */
+    createdOn?: Date;
+    /** Boolean determining if the Product is set to archived */
+    isArchived?: boolean;
+    /** Boolean determining if the Product is set to draft */
+    isDraft?: boolean;
+    fieldData?: Webflow.ProductFieldData;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * A product and its SKUs.
+ */
+export interface ProductAndSkUs {
+    product?: Webflow.Product;
+    skus?: Webflow.Sku[];
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * Results from product list
+ */
+export interface ProductAndSkUsList {
+    /** List of Item objects within the Collection. Contains product and skus keys for each Item */
+    items?: Webflow.ProductAndSkUs[];
+    pagination?: Webflow.Pagination;
+}

package/api/types/ProductAndSkUsList.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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export interface ProductFieldData {
+    /** Name of the Product */
+    name?: string;
+    /** URL structure of the Product in your site. */
+    slug?: string;
+    /** Variant/Options types to include in SKUs */
+    skuProperties?: Webflow.SkuPropertyList[];
+}

package/api/types/ProductFieldData.js

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