webflow-api 1.0.3 → 1.1.1

package/README.md

@@ -19,7 +19,6 @@ The constructor takes in a few optional parameters to initialize the API client
 * `token` - the access token to use
 * `headers` - additional headers to add to the request
 * `version` - the version of the API you wish to use
-* `mode` - the [sec-fetch-mode](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-Fetch-Mode) to use
 
 ``` javascript
 const Webflow = require("webflow-api");
@@ -31,7 +30,6 @@ const webflow = new Webflow({ token: "[ACCESS TOKEN]" });
 const webflow = new Webflow({
   token: "[ACCESS TOKEN]",
   version: "1.0.0",
-  mode: "cors",
   headers: {
     "User-Agent": "My Webflow App / 1.0"
   }
@@ -85,6 +83,9 @@ const webflow = new Webflow();
 
 // set token
 webflow.token = "[ACCESS TOKEN]";
+
+// remove the token
+webflow.clearToken();
 ```
 ### Calling APIs Directly
 All Webflow API endpoints can be called directly using the `get`, `post`, `put`, and `delete` methods.
@@ -146,9 +147,7 @@ const result = await webflow.revokeToken({
 });
 
 // ensure it went through
-if (result.didRevoke) {
-  // should equal true
-}
+result.didRevoke === true
 ```
 
 ## Examples

package/dist/api/collection.d.ts

@@ -0,0 +1,51 @@
+import { Client, QueryString } from "../core";
+/**************************************************************
+ * Types
+ **************************************************************/
+export declare type CollectionFieldType = "Bool" | "Color" | "Date" | "ExtFileRef" | "Set" | "ImageRef" | "Set" | "ItemRef" | "ItemRefSet" | "Link" | "Number" | "Option" | "PlainText" | "RichText" | "Video" | "User" | string;
+export declare type CollectionField = {
+    id: string;
+    type: CollectionFieldType;
+    slug: string;
+    name: string;
+    required: boolean;
+    editable: boolean;
+    validations?: any;
+};
+/**************************************************************
+ * Interfaces
+ **************************************************************/
+export interface ICollection {
+    _id: string;
+    lastUpdated: string;
+    createdOn: string;
+    name: string;
+    slug: string;
+    singularName: string;
+    fields: CollectionField[];
+}
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * Get a list of Collections
+ * @param client The Webflow client
+ * @param params1 The params for the request
+ * @param params1.siteId The site ID
+ * @param params The query string parameters (optional)
+ * @returns A list of Collections
+ */
+export declare function list(client: Client, { siteId }: {
+    siteId: string;
+}, params?: QueryString): Promise<import("axios").AxiosResponse<ICollection[], any>>;
+/**
+ * Get a single Collection
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The collection ID
+ * @param params.params The query string parameters (optional)
+ * @returns A single Collection
+ */
+export declare function getOne(client: Client, { collectionId }: {
+    collectionId: string;
+}, params?: QueryString): Promise<import("axios").AxiosResponse<ICollection, any>>;

package/dist/api/collection.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOne = exports.list = void 0;
+const core_1 = require("../core");
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * Get a list of Collections
+ * @param client The Webflow client
+ * @param params1 The params for the request
+ * @param params1.siteId The site ID
+ * @param params The query string parameters (optional)
+ * @returns A list of Collections
+ */
+function list(client, { siteId }, params) {
+    (0, core_1.requireArgs)({ siteId });
+    const path = `/sites/${siteId}/collections`;
+    return client.get(path, { params });
+}
+exports.list = list;
+/**
+ * Get a single Collection
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The collection ID
+ * @param params.params The query string parameters (optional)
+ * @returns A single Collection
+ */
+function getOne(client, { collectionId }, params) {
+    (0, core_1.requireArgs)({ collectionId });
+    const path = `/collections/${collectionId}`;
+    return client.get(path, { params });
+}
+exports.getOne = getOne;

package/dist/api/index.d.ts

@@ -0,0 +1,7 @@
+export * as Membership from "./membership";
+export * as Collection from "./collection";
+export * as Webhook from "./webhook";
+export * as OAuth from "./oauth";
+export * as Item from "./item";
+export * as Site from "./site";
+export * as Meta from "./meta";

package/dist/api/index.js

@@ -0,0 +1,33 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Meta = exports.Site = exports.Item = exports.OAuth = exports.Webhook = exports.Collection = exports.Membership = void 0;
+exports.Membership = __importStar(require("./membership"));
+exports.Collection = __importStar(require("./collection"));
+exports.Webhook = __importStar(require("./webhook"));
+exports.OAuth = __importStar(require("./oauth"));
+exports.Item = __importStar(require("./item"));
+exports.Site = __importStar(require("./site"));
+exports.Meta = __importStar(require("./meta"));

package/dist/api/item.d.ts

@@ -0,0 +1,143 @@
+import { Client, PaginatedData } from "../core";
+/**************************************************************
+ * Interfaces
+ **************************************************************/
+export interface IItem {
+    _archived: boolean;
+    _draft: boolean;
+    _id: string;
+    _cid: string;
+    name: string;
+    slug: string;
+    "updated-on": string;
+    "created-on": string;
+    "updated-by": string;
+    "created-by": string;
+    "published-on"?: string | null;
+    "published-by"?: string | null;
+}
+export interface IItemDelete {
+    deleted: number;
+}
+export interface IPublishItems {
+    publishedItemIds: string[];
+    errors: string[];
+}
+export interface IDeletedItems {
+    deletedItemIds: string[];
+    errors: string[];
+}
+/**************************************************************
+ * Types
+ **************************************************************/
+export declare type PageinatedItems = PaginatedData & {
+    items: IItem[];
+};
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * Get a single Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.itemId The Item ID
+ * @returns A single Item
+ */
+export declare function getOne(client: Client, { collectionId, itemId }: {
+    collectionId: string;
+    itemId: string;
+}): Promise<import("axios").AxiosResponse<PageinatedItems, any>>;
+/**
+ * Get a list of Items
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.limit The number of items to return (optional)
+ * @param params.offset The number of items to skip (optional)
+ * @returns A list of Items
+ */
+export declare function list(client: Client, { collectionId, limit, offset, }: {
+    collectionId: string;
+    limit?: number;
+    offset?: number;
+}): Promise<import("axios").AxiosResponse<PageinatedItems, any>>;
+/**
+ * Create a new Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.fields The Item fields to create
+ * @returns The created Item
+ */
+export declare function create(client: Client, { collectionId, fields }: {
+    fields: any;
+    collectionId: string;
+}): Promise<import("axios").AxiosResponse<IItem, any>>;
+/**
+ * Update a single Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.itemId The Item ID
+ * @param params.fields The fields to update
+ * @returns The updated Item
+ */
+export declare function update(client: Client, { collectionId, itemId, fields, }: {
+    fields: any;
+    itemId: string;
+    collectionId: string;
+}): Promise<import("axios").AxiosResponse<IItem, any>>;
+/**
+ * Patch a single Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.itemId The Item ID
+ * @param params.fields The fields to patch
+ * @returns The patched Item
+ */
+export declare function patch(client: Client, { collectionId, itemId, fields, }: {
+    fields: any;
+    itemId: string;
+    collectionId: string;
+}): Promise<import("axios").AxiosResponse<IItem, any>>;
+/**
+ * Remove a single Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.itemId The Item ID
+ * @returns The result from the removal
+ */
+export declare function remove(client: Client, { collectionId, itemId, }: {
+    itemId: string;
+    collectionId: string;
+}): Promise<import("axios").AxiosResponse<IItemDelete, any>>;
+/**
+ * Unpublishes a list of Items
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.live Unpublish from the live site
+ * @returns The result of the unpublish
+ */
+export declare function unpublish(client: Client, { collectionId, itemIds, live, }: {
+    live?: boolean;
+    itemIds: string[];
+    collectionId: string;
+}): Promise<import("axios").AxiosResponse<IDeletedItems, any>>;
+/**
+ * Publishes a list of Items
+ * @param client The Webflow client
+ * @param params The request parameters
+ * @param params.collectionId The Collection ID
+ * @param params.itemIds The list of Item IDs to publish
+ * @param params.live Publish to live site
+ * @returns The result of the publish
+ */
+export declare function publish(client: Client, { itemIds, live, collectionId, }: {
+    live?: boolean;
+    itemIds: string[];
+    collectionId: string;
+}): Promise<import("axios").AxiosResponse<IPublishItems, any>>;

package/dist/api/item.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.publish = exports.unpublish = exports.remove = exports.patch = exports.update = exports.create = exports.list = exports.getOne = void 0;
+const core_1 = require("../core");
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * Get a single Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.itemId The Item ID
+ * @returns A single Item
+ */
+function getOne(client, { collectionId, itemId }) {
+    (0, core_1.requireArgs)({ collectionId, itemId });
+    const path = `/collections/${collectionId}/items/${itemId}`;
+    // The API returns a paginated list with one record :(
+    return client.get(path);
+}
+exports.getOne = getOne;
+/**
+ * Get a list of Items
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.limit The number of items to return (optional)
+ * @param params.offset The number of items to skip (optional)
+ * @returns A list of Items
+ */
+function list(client, { collectionId, limit, offset, }) {
+    (0, core_1.requireArgs)({ collectionId });
+    const params = { limit, offset };
+    const path = `/collections/${collectionId}/items`;
+    return client.get(path, { params });
+}
+exports.list = list;
+/**
+ * Create a new Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.fields The Item fields to create
+ * @returns The created Item
+ */
+function create(client, { collectionId, fields }) {
+    (0, core_1.requireArgs)({ collectionId });
+    const path = `/collections/${collectionId}/items`;
+    return client.post(path, { fields });
+}
+exports.create = create;
+/**
+ * Update a single Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.itemId The Item ID
+ * @param params.fields The fields to update
+ * @returns The updated Item
+ */
+function update(client, { collectionId, itemId, fields, }) {
+    (0, core_1.requireArgs)({ collectionId, itemId });
+    const path = `/collections/${collectionId}/items/${itemId}`;
+    return client.put(path, { fields });
+}
+exports.update = update;
+/**
+ * Patch a single Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.itemId The Item ID
+ * @param params.fields The fields to patch
+ * @returns The patched Item
+ */
+function patch(client, { collectionId, itemId, fields, }) {
+    (0, core_1.requireArgs)({ collectionId, itemId });
+    const path = `/collections/${collectionId}/items/${itemId}`;
+    return client.patch(path, { fields });
+}
+exports.patch = patch;
+/**
+ * Remove a single Item
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.itemId The Item ID
+ * @returns The result from the removal
+ */
+function remove(client, { collectionId, itemId, }) {
+    (0, core_1.requireArgs)({ collectionId, itemId });
+    const path = `/collections/${collectionId}/items/${itemId}`;
+    return client.delete(path);
+}
+exports.remove = remove;
+/**
+ * Unpublishes a list of Items
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.collectionId The Collection ID
+ * @param params.live Unpublish from the live site
+ * @returns The result of the unpublish
+ */
+function unpublish(client, { collectionId, itemIds, live = false, }) {
+    (0, core_1.requireArgs)({ collectionId, itemIds });
+    const params = { live };
+    const data = { itemIds };
+    const url = `/collections/${collectionId}/items`;
+    const _params = { method: "DELETE", url, data, params };
+    // DELETE spec doesn't support body in delete
+    // RFC-9110 https://tools.ietf.org/html/rfc9110
+    return client.request(_params);
+}
+exports.unpublish = unpublish;
+/**
+ * Publishes a list of Items
+ * @param client The Webflow client
+ * @param params The request parameters
+ * @param params.collectionId The Collection ID
+ * @param params.itemIds The list of Item IDs to publish
+ * @param params.live Publish to live site
+ * @returns The result of the publish
+ */
+function publish(client, { itemIds, live = false, collectionId, }) {
+    (0, core_1.requireArgs)({ collectionId, itemIds });
+    const params = { live };
+    const path = `/collections/${collectionId}/items/publish`;
+    return client.put(path, { itemIds }, { params });
+}
+exports.publish = publish;

package/dist/api/membership.d.ts

@@ -0,0 +1,91 @@
+import { Client, PaginatedData } from "../core";
+/**************************************************************
+ * Interfaces
+ **************************************************************/
+export interface IUser {
+    emailVerified: boolean;
+    lastUpdated?: string;
+    createdOn: string;
+    _id: string;
+    data: any;
+}
+export interface IUserDelete {
+    deleted: number;
+}
+/**************************************************************
+ * Types
+ **************************************************************/
+export declare type PaginatedUsers = PaginatedData & {
+    users: IUser[];
+};
+export declare type UserIdParam = {
+    siteId: string;
+    userId: string;
+};
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * Get a list of Users
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.limit The number of items to return (optional)
+ * @param params.offset The number of items to skip (optional)
+ * @returns A list of Users
+ */
+export declare function list(client: Client, { siteId, limit, offset }: {
+    siteId: string;
+    limit?: number;
+    offset?: number;
+}): Promise<import("axios").AxiosResponse<PaginatedUsers, any>>;
+/**
+ * Get a single User
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.userId The user ID
+ * @returns A single User
+ */
+export declare function getOne(client: Client, { siteId, userId }: {
+    siteId: string;
+    userId: string;
+}): Promise<import("axios").AxiosResponse<IUser, any>>;
+/**
+ * Update a User
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.userId The user ID
+ * @param params.data The data to update
+ * @returns The updated User
+ */
+export declare function update(client: Client, { siteId, userId, data, }: {
+    data: object;
+    siteId: string;
+    userId: string;
+}): Promise<import("axios").AxiosResponse<IUser, any>>;
+/**
+ * Invite a User to a site
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.email The email address of the user to invite
+ * @returns The newly created User
+ */
+export declare function invite(client: Client, { siteId, email }: {
+    siteId: string;
+    email: string;
+}): Promise<import("axios").AxiosResponse<IUser, any>>;
+/**
+ * Remove a User
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.userId The user ID
+ * @returns The result of the remove
+ */
+export declare function remove(client: Client, { siteId, userId }: {
+    siteId: string;
+    userId: string;
+}): Promise<import("axios").AxiosResponse<IUserDelete, any>>;

package/dist/api/membership.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.remove = exports.invite = exports.update = exports.getOne = exports.list = void 0;
+const core_1 = require("../core");
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * Get a list of Users
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.limit The number of items to return (optional)
+ * @param params.offset The number of items to skip (optional)
+ * @returns A list of Users
+ */
+function list(client, { siteId, limit, offset }) {
+    (0, core_1.requireArgs)({ siteId });
+    const params = { limit, offset };
+    const path = `/sites/${siteId}/users`;
+    return client.get(path, { params });
+}
+exports.list = list;
+/**
+ * Get a single User
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.userId The user ID
+ * @returns A single User
+ */
+function getOne(client, { siteId, userId }) {
+    (0, core_1.requireArgs)({ siteId, userId });
+    const path = `/sites/${siteId}/users/${userId}`;
+    return client.get(path);
+}
+exports.getOne = getOne;
+/**
+ * Update a User
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.userId The user ID
+ * @param params.data The data to update
+ * @returns The updated User
+ */
+function update(client, { siteId, userId, data, }) {
+    (0, core_1.requireArgs)({ siteId, userId });
+    const path = `/sites/${siteId}/users/${userId}`;
+    return client.patch(path, data);
+}
+exports.update = update;
+/**
+ * Invite a User to a site
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.email The email address of the user to invite
+ * @returns The newly created User
+ */
+async function invite(client, { siteId, email }) {
+    (0, core_1.requireArgs)({ siteId, email });
+    const path = `/sites/${siteId}/users/invite`;
+    return client.post(path, { email });
+}
+exports.invite = invite;
+/**
+ * Remove a User
+ * @param client The Webflow client
+ * @param params The params for the request
+ * @param params.siteId The site ID
+ * @param params.userId The user ID
+ * @returns The result of the remove
+ */
+function remove(client, { siteId, userId }) {
+    (0, core_1.requireArgs)({ siteId, userId });
+    const path = `/sites/${siteId}/users/${userId}`;
+    return client.delete(path);
+}
+exports.remove = remove;

package/dist/api/meta.d.ts

@@ -0,0 +1,51 @@
+import { Client } from "../core";
+/**************************************************************
+ * Types
+ **************************************************************/
+export declare type InfoApplication = {
+    description: string;
+    ownerType: string;
+    homepage: string;
+    owner: string;
+    name: string;
+    _id: string;
+};
+/**************************************************************
+ * Interfaces
+ **************************************************************/
+export interface IAuthenticatedUser {
+    user: {
+        firstName: string;
+        lastName: string;
+        email: string;
+        _id: string;
+    };
+}
+export interface IAuthentiationInfo {
+    application: InfoApplication;
+    workspaces: string[];
+    rateLimit: number;
+    createdOn: string;
+    grantType: string;
+    lastUsed: string;
+    sites: string[];
+    users: string[];
+    orgs: string[];
+    status: string;
+    _id: string;
+}
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * Get the authentication info for the current token
+ * @param client The Webflow client
+ * @returns The authentication info
+ */
+export declare function info(client: Client): Promise<import("axios").AxiosResponse<IAuthentiationInfo, any>>;
+/**
+ * Get the authenticated user
+ * @param client The Webflow client
+ * @returns The authenticated user
+ */
+export declare function user(client: Client): Promise<import("axios").AxiosResponse<IAuthenticatedUser, any>>;

package/dist/api/meta.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.user = exports.info = void 0;
+/**************************************************************
+ * Functions
+ **************************************************************/
+/**
+ * Get the authentication info for the current token
+ * @param client The Webflow client
+ * @returns The authentication info
+ */
+function info(client) {
+    return client.get("/info");
+}
+exports.info = info;
+/**
+ * Get the authenticated user
+ * @param client The Webflow client
+ * @returns The authenticated user
+ */
+function user(client) {
+    return client.get("/user");
+}
+exports.user = user;