webflow-api 1.3.1 → 2.0.0-beta

package/api/types/Asset.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export interface Asset {
+    /** Unique identifier for this asset */
+    id?: string;
+    /** File format type */
+    contentType?: string;
+    /** size in bytes */
+    size?: number;
+    /** Unique identifier for the site that hosts this asset */
+    siteId?: string;
+    /** Link to the asset */
+    hostedUrl?: string;
+    /** Original file name at the time of upload */
+    originalFileName?: string;
+    /** Display name of the asset */
+    displayName?: string;
+    /** Date the asset metadata was last updated */
+    lastUpdated?: Date;
+    /** Date the asset metadata was created */
+    createdOn?: Date;
+    variants?: Webflow.AssetVariant[];
+}

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AssetFolder {
+    /** User visible name for the Asset Folder */
+    displayName?: string;
+    /** Unique identifier for the Asset Folder */
+    id?: string;
+    /** Pointer to parent Asset Folder (or null if root) */
+    parentFolder?: string;
+    /** Array of Asset instances in the folder */
+    assets?: string[];
+    /** The unique id of the site the Asset Folder belongs to */
+    siteId?: string;
+    /** Date that the Asset Folder was created on */
+    createdOn?: Date;
+    /** Date that the Asset Folder was last updated on */
+    lastUpdated?: Date;
+}

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

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

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export interface AssetUpload {
+    /** Metadata for uploading the asset binary */
+    uploadDetails?: Webflow.AssetUploadUploadDetails;
+    id?: string;
+    contentType?: string;
+    /** Parent folder for the asset */
+    parentFolder?: string;
+    /** Represents the link to the asset */
+    hostedUrl?: string;
+    uploadUrl?: string;
+    /** S3 link to the asset */
+    assetUrl?: string;
+    /** Original file name when uploaded. If not specified at time of upload, it may be extracted from the raw file name */
+    originalFileName?: string;
+    /** Date the asset metadata was last updated */
+    lastUpdated?: Date;
+    /** Date the asset metadata was created */
+    createdOn?: Date;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Metadata for uploading the asset binary
+ */
+export interface AssetUploadUploadDetails {
+    acl?: string;
+    bucket?: string;
+    key?: string;
+    policy?: string;
+    xAmzAlgorithm?: string;
+    xAmzCredential?: string;
+    xAmzDate?: string;
+    /** (optional) Temporary security token obtained when authenticated through AWS STS */
+    xAmzSecurityToken?: string;
+    xAmzSignature?: string;
+    successActionStatus?: string;
+    contentType?: string;
+    cacheControl?: string;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AssetVariant {
+    hostedUrl?: string;
+    originalFileName?: string;
+    displayName?: string;
+    format?: string;
+    /** Width in pixels */
+    width?: number;
+    /** Height in pixels */
+    height?: number;
+    /** Value between 0 and 100 representing the image quality */
+    quality?: number;
+    /** Any associated validation errors */
+    error?: string;
+}

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export interface Authorization {
+    /** The Authorization object */
+    authorization?: Webflow.AuthorizationAuthorization;
+    application?: Webflow.Application;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * The Authorization object
+ */
+export interface AuthorizationAuthorization {
+    /** The unique id of the Authorization instance */
+    id?: string;
+    /** The date the Authorization was created */
+    createdOn?: Date;
+    /** The date the Authorization was last used */
+    lastUsed?: Date;
+    /** The grant type of the Authorization */
+    grantType?: string;
+    /** The default rate limit for the Authorization (requests/min) */
+    rateLimit?: number;
+    /** Comma separted list of OAuth scopes corresponding to the Authorization */
+    scope?: string;
+    authorizedTo?: Webflow.AuthorizationAuthorizationAuthorizedTo;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AuthorizationAuthorizationAuthorizedTo {
+    /** Array of Sites this app is authorized to */
+    siteIds?: unknown[];
+    /** Array of Workspaces this app is authorized to */
+    workspaceIds?: unknown[];
+    /** Array of Users this app is authorized to */
+    userIds?: unknown[];
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AuthorizedUser {
+    /** The unique id of the user */
+    id?: string;
+    /** The user's email address */
+    email?: string;
+    /** The user's first name */
+    firstName?: string;
+    /** The user's last name */
+    lastName?: string;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A collection object
+ */
+export interface Collection {
+    /** Unique identifier for a Collection */
+    id: string;
+    /** Name given to the Collection */
+    displayName?: string;
+    /** The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”) */
+    singularName?: string;
+    /** Slug of Collection in Site URL structure */
+    slug?: string;
+    /** The date the collection was created */
+    createdOn?: Date;
+    /** The date the collection was last updated */
+    lastUpdated?: Date;
+    /** The list of fields in the Collection */
+    fields: Record<string, unknown>;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * 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
+ */
+export interface CollectionItem {
+    /** Unique identifier for the Item */
+    id: string;
+    /** The date the item was last published */
+    lastPublished?: string;
+    /** The date the item was last updated */
+    lastUpdated?: string;
+    /** The date the item was created */
+    createdOn?: string;
+    /** Boolean determining if the Item is set to archived */
+    isArchived?: boolean;
+    /** Boolean determining if the Item is set to draft */
+    isDraft?: boolean;
+    fieldData?: Webflow.CollectionItemFieldData;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CollectionItemFieldData {
+    /** Name of the Item */
+    name?: string;
+    /** URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug. */
+    slug?: string;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * Results from collection items list
+ */
+export interface CollectionItemList {
+    /** List of Items within the collection */
+    items?: Webflow.CollectionItem[];
+    pagination?: Webflow.CollectionItemListPagination;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CollectionItemListPagination {
+    /** The limit specified in the request */
+    limit?: number;
+    /** The offset specified for pagination */
+    offset?: number;
+    /** Total number of items in the collection */
+    total?: number;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CollectionItemRemoved {
+    /** The number of items deleted */
+    deleted?: number;
+    /** The id of the collection item that was deleted */
+    itemId?: string;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export interface CollectionList {
+    /** An array of Collections */
+    collections?: Webflow.CollectionListArrayItem[];
+}

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A collection object
+ */
+export interface CollectionListArrayItem {
+    /** Unique identifier for a Collection */
+    id: string;
+    /** Name given to the Collection */
+    displayName?: string;
+    /** The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”) */
+    singularName?: string;
+    /** Slug of Collection in Site URL structure */
+    slug?: string;
+    /** The date the collection was created */
+    createdOn?: Date;
+    /** The date the collection was last updated */
+    lastUpdated?: Date;
+}

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+/**
+ * A specific instance of Custom Code applied to a Site or Page
+ */
+export interface CustomCodeBlock {
+    /** The Site id where the custom code was applied */
+    siteId?: string;
+    /** The Page id (if applied at Page-level) */
+    pageId?: string;
+    /** Whether the Custom Code script is applied at the Site-level or Page-level */
+    type?: Webflow.CustomCodeBlockType;
+    scripts?: Webflow.ScriptApply[];
+    /** The date the Block was created */
+    createdOn?: Date;
+    /** The date the Block was most recently updated */
+    lastUpdated?: Date;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Whether the Custom Code script is applied at the Site-level or Page-level
+ */
+export declare type CustomCodeBlockType = "page" | "site";
+export declare const CustomCodeBlockType: {
+    readonly Page: "page";
+    readonly Site: "site";
+};

package/api/types/CustomCodeBlockType.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.CustomCodeBlockType = void 0;
+exports.CustomCodeBlockType = {
+    Page: "page",
+    Site: "site",
+};

package/api/types/CustomCodeResponse.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Registered custom code for application
+ */
+export interface CustomCodeResponse {
+    /** Human readable id, derived from the user-specified display name */
+    id?: string;
+    /** Timestamp when the script version was created */
+    createdOn?: string;
+    /** Timestamp when the script version was last updated */
+    lastUpdated?: string;
+    /** URI for an externally hosted script location */
+    hostedLocation?: string;
+    /** Sub-Resource Integrity Hash. Only required for externally hosted scripts (passed via hostedLocation) */
+    integrityHash?: string;
+    /** Define whether the script can be copied on site duplication and transfer */
+    canCopy?: boolean;
+    /** A Semantic Version (SemVer) string, denoting the version of the script */
+    version?: string;
+    /** User-facing name for the script */
+    displayName?: string;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Domain {
+    /** Unique identifier for the Domain */
+    id: string;
+    /** The registered Domain name */
+    url?: string;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Webflow from "..";
+export interface DuplicateUserEmail {
+    code?: "duplicate_user_email";
+    /** Error message */
+    message?: string;
+    /** Link to more information */
+    externalReference?: string;
+    /** Array of errors */
+    details?: Webflow.ErrorDetailsItem[];
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Ecommerce settings for a Webflow Site
+ */
+export interface EcommerceSettings {
+    /** The identifier of the Site */
+    siteId?: string;
+    /** Date that the Site was created on */
+    createdOn?: Date;
+    /** The three-letter ISO currency code for the Site */
+    defaultCurrency?: string;
+}

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

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

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

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

package/api/types/Error_.js

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