webflow-api 1.1.1 → 1.2.0

package/README.md

@@ -207,7 +207,10 @@ const updatedItem = await webflow.updateItem({
 
 ### Memberships
 ```javascript
-// Get the all users for a site
+// Get a site's users from the site
+const users = await site.users();
+
+// Get a site's users with a site id
 const users = await webflow.users({
   siteId: "[SITE ID]"
 });
@@ -217,6 +220,14 @@ const user = await site.user({
   siteId: "[SITE ID]",
   userId: "[USER ID]"
 });
+
+// Get a site's access groups
+const accessGroups = await site.accessGroups();
+
+// Get a site's access groups with a site id
+const accessGroups = await webflow.accessGroups({
+  siteId: "[SITE ID]"
+});
 ```
 
 ### Webhooks

package/dist/api/collection.d.ts

@@ -1,4 +1,6 @@
-import { Client, QueryString } from "../core";
+import { AxiosInstance } from "axios";
+import { WebflowRecord } from "../core";
+import { Item } from ".";
 /**************************************************************
  * Types
  **************************************************************/
@@ -25,27 +27,86 @@ export interface ICollection {
     fields: CollectionField[];
 }
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * 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>>;
+export declare class Collection extends WebflowRecord<ICollection> implements ICollection {
+    fields: CollectionField[];
+    singularName: string;
+    lastUpdated: string;
+    createdOn: string;
+    _id: string;
+    name: string;
+    slug: string;
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a list of Collections
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param client The Axios client instance
+     * @returns A list of Collections
+     */
+    static list({ siteId }: {
+        siteId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<ICollection[], any>>;
+    /**
+     * Get a single Collection
+     * @param params The params for the request
+     * @param params.collectionId The collection ID
+     * @param client The Axios client instance
+     * @returns A single Collection
+     */
+    static getOne({ collectionId }: {
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<ICollection, any>>;
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Get a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @returns A single Item
+     */
+    item({ itemId }: {
+        itemId: string;
+    }): Promise<Item>;
+    /**
+     * Get a list of Items
+     * @param params The params for the request
+     * @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
+     */
+    items({ limit, offset }?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<Item[]>;
+    /**
+     * Remove a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @returns The result from the removal
+     */
+    removeItem({ itemId }: {
+        itemId: string;
+    }): Promise<import("./item").IItemDelete>;
+    /**
+     * Create a new Item
+     * @param fields The Item fields to create
+     * @returns The created Item
+     */
+    createItem(fields: any): Promise<Item>;
+    /**
+     * Update a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @param params.fields The fields to update
+     * @returns The updated Item
+     */
+    updateItem({ itemId, fields }: {
+        itemId: string;
+        fields: any;
+    }): Promise<Item>;
+}

package/dist/api/collection.js

@@ -1,35 +1,94 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOne = exports.list = void 0;
+exports.Collection = void 0;
 const core_1 = require("../core");
+const _1 = require(".");
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * 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 });
+class Collection extends core_1.WebflowRecord {
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a list of Collections
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param client The Axios client instance
+     * @returns A list of Collections
+     */
+    static list({ siteId }, client) {
+        (0, core_1.requireArgs)({ siteId });
+        const path = `/sites/${siteId}/collections`;
+        return client.get(path);
+    }
+    /**
+     * Get a single Collection
+     * @param params The params for the request
+     * @param params.collectionId The collection ID
+     * @param client The Axios client instance
+     * @returns A single Collection
+     */
+    static getOne({ collectionId }, client) {
+        (0, core_1.requireArgs)({ collectionId });
+        const path = `/collections/${collectionId}`;
+        return client.get(path);
+    }
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Get a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @returns A single Item
+     */
+    async item({ itemId }) {
+        const res = await _1.Item.getOne({ itemId, collectionId: this._id }, this.client);
+        const [item] = res.data.items.map((data) => new _1.Item(this.client, { ...res, data }));
+        return item;
+    }
+    /**
+     * Get a list of Items
+     * @param params The params for the request
+     * @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
+     */
+    async items({ limit, offset } = {}) {
+        const res = await _1.Item.list({ collectionId: this._id, limit, offset }, this.client);
+        return res.data.items.map((data) => new _1.Item(this.client, { ...res, data }));
+    }
+    /**
+     * Remove a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @returns The result from the removal
+     */
+    async removeItem({ itemId }) {
+        const res = await _1.Item.remove({ itemId, collectionId: this._id }, this.client);
+        return res.data;
+    }
+    /**
+     * Create a new Item
+     * @param fields The Item fields to create
+     * @returns The created Item
+     */
+    async createItem(fields) {
+        const res = await _1.Item.create({ collectionId: this._id, fields }, this.client);
+        return new _1.Item(this.client, res);
+    }
+    /**
+     * Update a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @param params.fields The fields to update
+     * @returns The updated Item
+     */
+    async updateItem({ itemId, fields }) {
+        const params = { itemId, collectionId: this._id, fields };
+        const res = await _1.Item.update(params, this.client);
+        return new _1.Item(this.client, res);
+    }
 }
-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;
+exports.Collection = Collection;

package/dist/api/index.d.ts

@@ -1,7 +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";
+export * from "./collection";
+export * from "./user";
+export * from "./webhook";
+export * from "./item";
+export * from "./site";
+export * from "./oauth";
+export * from "./meta";

package/dist/api/index.js

@@ -10,24 +10,14 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     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;
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 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"));
+__exportStar(require("./collection"), exports);
+__exportStar(require("./user"), exports);
+__exportStar(require("./webhook"), exports);
+__exportStar(require("./item"), exports);
+__exportStar(require("./site"), exports);
+__exportStar(require("./oauth"), exports);
+__exportStar(require("./meta"), exports);

package/dist/api/item.d.ts

@@ -1,4 +1,5 @@
-import { Client, PaginatedData } from "../core";
+import { AxiosInstance } from "axios";
+import { PaginatedData, WebflowRecord } from "../core";
 /**************************************************************
  * Interfaces
  **************************************************************/
@@ -34,110 +35,143 @@ export declare type PageinatedItems = PaginatedData & {
     items: IItem[];
 };
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * 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>>;
+export declare class Item extends WebflowRecord<IItem> implements IItem {
+    "published-on"?: string | null;
+    "published-by"?: string | null;
+    "updated-on": string;
+    "created-on": string;
+    "updated-by": string;
+    "created-by": string;
+    _archived: boolean;
+    _draft: boolean;
+    _cid: string;
+    name: string;
+    slug: string;
+    _id: string;
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a single Item
+     * @param params The params for the request
+     * @param params.collectionId The Collection ID
+     * @param params.itemId The Item ID
+     * @param client The Axios client instance
+     * @returns A single Item
+     */
+    static getOne({ collectionId, itemId }: {
+        collectionId: string;
+        itemId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<PageinatedItems, any>>;
+    /**
+     * Get a list of Items
+     * @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)
+     * @param client The Axios client instance
+     * @returns A list of Items
+     */
+    static list({ collectionId, limit, offset }: {
+        collectionId: string;
+        limit?: number;
+        offset?: number;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<PageinatedItems, any>>;
+    /**
+     * Create a new Item
+     * @param params The params for the request
+     * @param params.collectionId The Collection ID
+     * @param params.fields The Item fields to create
+     * @param client The Axios client instance
+     * @returns The created Item
+     */
+    static create({ collectionId, fields }: {
+        fields: any;
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IItem, any>>;
+    /**
+     * Update a single Item
+     * @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
+     * @param client The Axios client instance
+     * @returns The updated Item
+     */
+    static update({ collectionId, itemId, fields, }: {
+        fields: any;
+        itemId: string;
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IItem, any>>;
+    /**
+     * Patch a single Item
+     * @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
+     * @param client The Axios client instance
+     * @returns The patched Item
+     */
+    static patch({ collectionId, itemId, fields, }: {
+        fields: any;
+        itemId: string;
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IItem, any>>;
+    /**
+     * Remove a single Item
+     * @param params The params for the request
+     * @param params.collectionId The Collection ID
+     * @param params.itemId The Item ID
+     * @param client The Axios client instance
+     * @returns The result from the removal
+     */
+    static remove({ collectionId, itemId, }: {
+        itemId: string;
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IItemDelete, any>>;
+    /**
+     * Unpublishes a list of Items
+     * @param params The params for the request
+     * @param params.collectionId The Collection ID
+     * @param params.live Unpublish from the live site
+     * @param client The Axios client instance
+     * @returns The result of the unpublish
+     */
+    static unpublish({ collectionId, itemIds, live, }: {
+        live?: boolean;
+        itemIds: string[];
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IDeletedItems, any>>;
+    /**
+     * Publishes a list of Items
+     * @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
+     * @param client The Axios client instance
+     * @returns The result of the publish
+     */
+    static publish({ itemIds, live, collectionId }: {
+        live?: boolean;
+        itemIds: string[];
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IPublishItems, any>>;
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Update a single Item
+     * @param fields The fields to update
+     * @returns The updated Item
+     */
+    update({ ...fields }: {
+        [x: string]: any;
+    }): Promise<Item>;
+    /**
+     * Remove a single Item
+     * @returns The result from the removal
+     */
+    remove(): Promise<IItemDelete>;
+}