webflow-api 1.3.1 → 2.0.0

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

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export interface Form {
+    /** The unique id for the Form */
+    id?: string;
+    /** The Form name displayed on the site */
+    displayName?: string;
+    /** The unique id of the Site the Form belongs to */
+    siteId?: string;
+    /** The unique id corresponding to the site's Domain name */
+    siteDomainId?: string;
+    /** The unique id for the Page on which the Form is placed */
+    pageId?: string;
+    /** The user-visible name of the Page where the Form is placed */
+    pageName?: string;
+    /** The unique id of the Workspace the Site belongs to */
+    workspaceId?: string;
+    /** Date that the Form was created on */
+    createdOn?: Date;
+    /** Date that the Form was last updated on */
+    lastUpdated?: Date;
+    fields?: Webflow.FormField[];
+    responseSettings?: Webflow.FormResponseSettings;
+}

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

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export declare type FormField = Record<string, Webflow.FormFieldValue>;

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export interface FormFieldValue {
+    /** The field name displayed on the site */
+    displayName?: string;
+    /** The field type */
+    type?: Webflow.FormFieldValueType;
+    /** The placeholder text for the field */
+    placeholder?: string;
+    /** Whether the field is visible to the user */
+    userVisible?: boolean;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The field type
+ */
+export declare type FormFieldValueType = "Plain" | "Email" | "Password" | "Phone" | "Number";
+export declare const FormFieldValueType: {
+    readonly Plain: "Plain";
+    readonly Email: "Email";
+    readonly Password: "Password";
+    readonly Phone: "Phone";
+    readonly Number: "Number";
+};

package/dist/api/types/FormFieldValueType.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormFieldValueType = void 0;
+exports.FormFieldValueType = {
+    Plain: "Plain",
+    Email: "Email",
+    Password: "Password",
+    Phone: "Phone",
+    Number: "Number",
+};

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export interface FormList {
+    forms?: Webflow.Form[];
+    pagination?: Webflow.Pagination;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface FormResponseSettings {
+    /** Whether to send an email confirmation to the user */
+    sendEmailConfirmation?: boolean;
+    /** The url or path to redirect the user to after form submission */
+    redirectUrl?: string;
+    /** The HTTP request method to use for the redirectUrl (eg. POST or GET) */
+    redirectMethod?: string;
+    /** The action to take after form submission */
+    redirectAction?: string;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface FormSubmission {
+    /** The unique id of the Form submission */
+    id?: string;
+    /** The Form name displayed on the site */
+    displayName?: string;
+    /** The unique id of the Site the Form belongs to */
+    siteId?: string;
+    /** The unique id of the Workspace the Site belongs to */
+    workspaceId?: string;
+    /** Date that the Form was submitted on */
+    dateSubmitted?: Date;
+    /** The data submitted in the Form */
+    formResponse?: Record<string, unknown>;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export interface FormSubmissionList {
+    submissions?: Webflow.FormSubmission[];
+    pagination?: Webflow.Pagination;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export interface FormSubmissionTrigger {
+    /** The type of event that triggered the request */
+    triggerType?: string;
+    /** The payload of data sent from Webflow */
+    payload?: Webflow.FormSubmissionTriggerPayload;
+}

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The payload of data sent from Webflow
+ */
+export interface FormSubmissionTriggerPayload {
+    /** The name of the form */
+    name?: string;
+    /** The id of the site that the form was submitted from */
+    siteId?: string;
+    /** The data submitted in the form */
+    data?: Record<string, unknown>;
+    /** The timestamp the form was submitted */
+    submittedAt?: string;
+    /** The id of the form submission */
+    formId?: string;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type InvalidDomain = unknown;

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * The availabile inventory for an item
+ */
+export interface InventoryItem {
+    /** Unique identifier for a SKU item */
+    id?: string;
+    /** Total quantity of items remaining in inventory (if inventoryType is finite) */
+    quantity?: number;
+    /** infinite or finite */
+    inventoryType?: Webflow.InventoryItemInventoryType;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * infinite or finite
+ */
+export declare type InventoryItemInventoryType = "infinite" | "finite";
+export declare const InventoryItemInventoryType: {
+    readonly Infinite: "infinite";
+    readonly Finite: "finite";
+};

package/dist/api/types/InventoryItemInventoryType.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InventoryItemInventoryType = void 0;
+exports.InventoryItemInventoryType = {
+    Infinite: "infinite",
+    Finite: "finite",
+};

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * Custom Code Blocks corresponding to where scripts were applied
+ */
+export interface ListCustomCodeBlocks {
+    blocks?: Webflow.CustomCodeBlock[];
+    pagination?: Webflow.Pagination;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * 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[];
+}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type NoDomains = unknown;

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

@@ -0,0 +1,50 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type OauthScope = 
+/**
+ * read details about the authorized user */
+"authorized_user:read"
+/**
+ * read pages on the site */
+ | "read:pages"
+/**
+ * read sites on the site */
+ | "sites:read"
+/**
+ * modify pages on the site */
+ | "sites:write"
+/**
+ * read custom code on the site */
+ | "custom_code:read"
+/**
+ * modify custom code on the site */
+ | "custom_code:write"
+/**
+ * delete custom code on the site */
+ | "custom_code:delete"
+/**
+ * read users on the site */
+ | "users:read"
+/**
+ * modify users on the site */
+ | "users:write"
+/**
+ * read ecommerce data */
+ | "ecommerce:read"
+/**
+ * edit ecommerce data */
+ | "ecommerce:write";
+export declare const OauthScope: {
+    readonly AuthorizedUserRead: "authorized_user:read";
+    readonly ReadPages: "read:pages";
+    readonly SitesRead: "sites:read";
+    readonly SitesWrite: "sites:write";
+    readonly CustomCodeRead: "custom_code:read";
+    readonly CustomCodeWrite: "custom_code:write";
+    readonly CustomCodeDelete: "custom_code:delete";
+    readonly UsersRead: "users:read";
+    readonly UsersWrite: "users:write";
+    readonly EcommerceRead: "ecommerce:read";
+    readonly EcommerceWrite: "ecommerce:write";
+};

package/dist/api/types/OauthScope.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OauthScope = void 0;
+exports.OauthScope = {
+    AuthorizedUserRead: "authorized_user:read",
+    ReadPages: "read:pages",
+    SitesRead: "sites:read",
+    SitesWrite: "sites:write",
+    CustomCodeRead: "custom_code:read",
+    CustomCodeWrite: "custom_code:write",
+    CustomCodeDelete: "custom_code:delete",
+    UsersRead: "users:read",
+    UsersWrite: "users:write",
+    EcommerceRead: "ecommerce:read",
+    EcommerceWrite: "ecommerce:write",
+};

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

@@ -0,0 +1,67 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+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;
+    /** The status of the Order */
+    status?: Webflow.OrderStatus;
+    /** A comment string for this Order editable by API user (not used by Webflow). */
+    comment?: string;
+    /** A comment that the customer left when making their Order */
+    orderComment?: string;
+    /** The ISO8601 timestamp that an Order was placed. */
+    acceptedOn?: Date;
+    /** If an Order was marked as 'fulfilled', then this is the ISO8601 timestamp when that happened. */
+    fulfilledOn?: Date;
+    /** If an Order was refunded, this is the ISO8601 of when that happened. */
+    refundedOn?: Date;
+    /** If an Order was disputed by the customer, then this key will be set with the ISO8601 timestamp that Stripe notifies Webflow. Null if not disputed. */
+    disputedOn?: Date;
+    /** If an Order was disputed by the customer, then this key will be set with the ISO8601 timestamp of the last time that we got an update. Null if not disputed. */
+    disputeUpdatedOn?: Date;
+    /** If an order was disputed by the customer, then this key will be set with the [dispute's status](https://stripe.com/docs/api#dispute_object-status). */
+    disputeLastStatus?: Webflow.OrderDisputeLastStatus;
+    /** The total paid by the customer */
+    customerPaid?: Webflow.OrderPrice;
+    /** The net amount after application fees */
+    netAmount?: Webflow.OrderPrice;
+    /** The application fee assessed by the platform */
+    applicationFee?: Webflow.OrderPrice;
+    /** All addresses provided by the customer during the ordering flow. */
+    allAddresses?: Webflow.OrderAddress[];
+    /** The shipping address */
+    shippingAddress?: Webflow.OrderAddress;
+    /** The billing address */
+    billingAddress?: Webflow.OrderAddress;
+    /** A string editable by the API user to note the shipping provider used (not used by Webflow). */
+    shippingProvider?: string;
+    /** A string editable by the API user to note the shipping tracking number for the order (not used by Webflow). */
+    shippingTracking?: string;
+    shippingTrackingUrl?: string;
+    /** An object with the keys `fullName` and `email`. */
+    customerInfo?: Webflow.OrderCustomerInfo;
+    /** An array of all things that the Customer purchased. */
+    purchasedItems?: Webflow.OrderPurchasedItem[];
+    /** The sum of all 'count' fields in 'purchasedItems'. */
+    purchasedItemsCount?: number;
+    stripeDetails?: Webflow.StripeDetails;
+    stripeCard?: Webflow.StripeCard;
+    paypalDetails?: Webflow.PaypalDetails;
+    /** An array of additional inputs for custom order data gathering. Each object in the array represents an input with a name, and a textInput, textArea, or checkbox value. */
+    customData?: Record<string, unknown>[];
+    metadata?: Webflow.OrderMetadata;
+    /** A boolean indicating whether the customer has been deleted from the site. */
+    isCustomerDeleted?: boolean;
+    /** A boolean indicating whether the order contains one or more purchased items that require shipping. */
+    isShippingRequired?: boolean;
+    /** A boolean indicating whether the order contains one or more purchased items that are downloadable. */
+    hasDownloads?: boolean;
+    /** A string indicating the payment processor used for this order. */
+    paymentProcessor?: string;
+    /** An object describing various pricing totals */
+    totals?: Webflow.OrderTotals;
+    /** An array of downloadable file objects. */
+    downloadFiles?: Webflow.OrderDownloadFilesItem[];
+}

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

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * A customer address
+ */
+export interface OrderAddress {
+    /** The type of the order address (billing or shipping) */
+    type?: Webflow.OrderAddressType;
+    /** Japan-only address format */
+    japanType?: Webflow.OrderAddressJapanType;
+    /** Display name on the address */
+    addressee?: string;
+    /** The first line of the address */
+    line1?: string;
+    /** The second line of the address */
+    line2?: string;
+    /** The city of the address. */
+    city?: string;
+    /** The state or province of the address */
+    state?: string;
+    /** The country of the address */
+    country?: string;
+    /** The postal code of the address */
+    postalCode?: string;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Japan-only address format
+ */
+export declare type OrderAddressJapanType = "kana" | "kanji";
+export declare const OrderAddressJapanType: {
+    readonly Kana: "kana";
+    readonly Kanji: "kanji";
+};

package/dist/api/types/OrderAddressJapanType.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderAddressJapanType = void 0;
+exports.OrderAddressJapanType = {
+    Kana: "kana",
+    Kanji: "kanji",
+};

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of the order address (billing or shipping)
+ */
+export declare type OrderAddressType = "shipping" | "billing";
+export declare const OrderAddressType: {
+    readonly Shipping: "shipping";
+    readonly Billing: "billing";
+};

package/dist/api/types/OrderAddressType.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderAddressType = void 0;
+exports.OrderAddressType = {
+    Shipping: "shipping",
+    Billing: "billing",
+};

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * An object with the keys `fullName` and `email`.
+ */
+export interface OrderCustomerInfo {
+    /** The full name of the Customer */
+    fullName?: string;
+    /** The Customer's email address */
+    email?: string;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * If an order was disputed by the customer, then this key will be set with the [dispute's status](https://stripe.com/docs/api#dispute_object-status).
+ */
+export declare type OrderDisputeLastStatus = "warning_needs_response" | "warning_under_review" | "warning_closed" | "needs_response" | "under_review" | "charge_refunded" | "won" | "lost";
+export declare const OrderDisputeLastStatus: {
+    readonly WarningNeedsResponse: "warning_needs_response";
+    readonly WarningUnderReview: "warning_under_review";
+    readonly WarningClosed: "warning_closed";
+    readonly NeedsResponse: "needs_response";
+    readonly UnderReview: "under_review";
+    readonly ChargeRefunded: "charge_refunded";
+    readonly Won: "won";
+    readonly Lost: "lost";
+};

package/dist/api/types/OrderDisputeLastStatus.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderDisputeLastStatus = void 0;
+exports.OrderDisputeLastStatus = {
+    WarningNeedsResponse: "warning_needs_response",
+    WarningUnderReview: "warning_under_review",
+    WarningClosed: "warning_closed",
+    NeedsResponse: "needs_response",
+    UnderReview: "under_review",
+    ChargeRefunded: "charge_refunded",
+    Won: "won",
+    Lost: "lost",
+};

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface OrderDownloadFilesItem {
+    /** The unique identifier for the downloadable file */
+    id?: string;
+    /** The user-facing name for the downloadable file */
+    name?: string;
+    /** The hosted location for the downloadable file */
+    url?: string;
+}

package/dist/api/types/OrderDownloadFilesItem.js

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