webflow-api 1.2.0 → 1.2.1

package/README.md

@@ -9,18 +9,20 @@ $ npm install webflow-api
 ```
 
 using yarn
+
 ```
 $ yarn add webflow-api
 ```
 
 ## Usage
+
 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
+- `token` - the access token to use
+- `headers` - additional headers to add to the request
+- `version` - the version of the API you wish to use
 
-``` javascript
+```javascript
 const Webflow = require("webflow-api");
 
 // initialize the client with the access token
@@ -31,12 +33,15 @@ const webflow = new Webflow({
   token: "[ACCESS TOKEN]",
   version: "1.0.0",
   headers: {
-    "User-Agent": "My Webflow App / 1.0"
-  }
+    "User-Agent": "My Webflow App / 1.0",
+  },
 });
 ```
+
 ## Basic Usage
+
 ### Chaining Calls
+
 You can retrieve child resources by chaining calls on the parent object.
 
 ```javascript
@@ -54,6 +59,7 @@ const item = await collection.items({ itemId: "[ITEM ID]" });
 ```
 
 ### Pagination
+
 To paginate results, pass in the `limit` and `offset` options.
 
 ```javascript
@@ -65,6 +71,7 @@ const page2 = await collection.items({ limit: 20, offset: 20 });
 ```
 
 ### Rate Limit
+
 Check rate limit status on each call by checking the `_meta` property.
 
 ```javascript
@@ -74,7 +81,9 @@ const site = await webflow.site({ siteId: "[SITE ID]" });
 // check rate limit
 const { rateLimit } = site._meta; // { limit: 60, remaining: 56 }
 ```
+
 ### Update Token
+
 If you need to update the access token, you can set the `token` property at any time.
 
 ```javascript
@@ -87,7 +96,9 @@ 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.
 
 ```javascript
@@ -96,14 +107,16 @@ const sites = await webflow.get("/sites");
 
 // post to an endpoint directly
 const result = await webflow.post("/sites/[SITE ID]/publish", {
-  domains: ["hello-webflow.com"]
+  domains: ["hello-webflow.com"],
 });
 ```
 
 ## OAuth
+
 To implement OAuth, you'll need a Webflow App registered and a webserver running, that is publicly facing.
 
 ### Authorize
+
 The first step in OAuth is to generate an authorization url to redirect the user to.
 
 ```javascript
@@ -111,7 +124,7 @@ The first step in OAuth is to generate an authorization url to redirect the user
 const url = webflow.authorizeUrl({
   client_id: "[CLIENT ID]",
   state: "1234567890", // optional
-  redirect_uri: "https://my.server.com/oauth/callback" // optional
+  redirect_uri: "https://my.server.com/oauth/callback", // optional
 });
 
 // redirect user from your server route
@@ -119,6 +132,7 @@ res.redirect(url);
 ```
 
 ### Access Token
+
 Once a user has authorized their Webflow resource(s), Webflow will redirect back to your server with a `code`. Use this to get an access token.
 
 ```javascript
@@ -126,7 +140,7 @@ const auth = await webflow.accessToken({
   client_id,
   client_secret,
   code,
-  redirect_uri // optional - required if used in the authorize step
+  redirect_uri, // optional - required if used in the authorize step
 });
 
 // you now have the user's access token to make API requests with
@@ -137,21 +151,24 @@ const authenticatedUser = await userWF.authenticatedUser();
 ```
 
 ### Revoke Token
+
 If the user decides to disconnect from your server, you should call revoke token to remove the authorization.
 
 ```javascript
 const result = await webflow.revokeToken({
   client_id,
   client_secret,
-  access_token
+  access_token,
 });
 
 // ensure it went through
-result.didRevoke === true
+result.didRevoke === true;
 ```
 
 ## Examples
+
 ### Sites
+
 Get all sites available or lookup by site id.
 
 ```javascript
@@ -163,7 +180,9 @@ const site = await webflow.sites({ siteId: "[SITE ID]" });
 ```
 
 ### Collections
+
 Get all collections available for a site or lookup by collection id.
+
 ```javascript
 // Get a site's collection from the site
 const collections = await site.collections();
@@ -176,7 +195,9 @@ const collection = await webflow.collection({ collectionId: "[COLLECTION ID]" })
 ```
 
 ### Collection Items
+
 Get all collection items available for a collection or lookup by item id.
+
 ```javascript
 // Get the items from a collection
 const items = await collection.items();
@@ -187,7 +208,9 @@ const items = await collection.items({ limit: 10, offset: 2 });
 // Get a single item
 const item = await webflow.item({ collectionId: "[COLLECTION ID]", itemId: "[ITEM ID]" });
 ```
+
 ### Update an Item
+
 ```javascript
 // Set the fields to update
 const fields = {
@@ -206,19 +229,20 @@ const updatedItem = await webflow.updateItem({
 ```
 
 ### Memberships
+
 ```javascript
 // 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]"
+  siteId: "[SITE ID]",
 });
 
 // Get a single user
 const user = await site.user({
   siteId: "[SITE ID]",
-  userId: "[USER ID]"
+  userId: "[USER ID]",
 });
 
 // Get a site's access groups
@@ -226,11 +250,12 @@ const accessGroups = await site.accessGroups();
 
 // Get a site's access groups with a site id
 const accessGroups = await webflow.accessGroups({
-  siteId: "[SITE ID]"
+  siteId: "[SITE ID]",
 });
 ```
 
 ### Webhooks
+
 ```javascript
 // get webhooks for a site
 const webhooks = await site.webhooks();
@@ -238,18 +263,17 @@ const webhooks = await site.webhooks();
 // create a webhook
 const webhook = await site.createWebhook({
   triggerType: "form_submission",
-  url: "https://webhook.site"
+  url: "https://webhook.site",
 });
-
 ```
 
 ### Authenticated User
+
 ```javascript
 // pull information for the authenticated user
 const authenticatedUser = await webflow.authenticatedUser();
 ```
 
-
 ## Contributing
 
 Contributions are welcome - feel free to open an issue or pull request.

package/dist/api/collection.d.ts

@@ -12,7 +12,7 @@ export declare type CollectionField = {
     name: string;
     required: boolean;
     editable: boolean;
-    validations?: any;
+    validations?: Record<string, string | number | boolean | object>;
 };
 /**************************************************************
  * Interfaces
@@ -97,7 +97,7 @@ export declare class Collection extends WebflowRecord<ICollection> implements IC
      * @param fields The Item fields to create
      * @returns The created Item
      */
-    createItem(fields: any): Promise<Item>;
+    createItem(fields: object): Promise<Item>;
     /**
      * Update a single Item
      * @param params The params for the request
@@ -107,6 +107,6 @@ export declare class Collection extends WebflowRecord<ICollection> implements IC
      */
     updateItem({ itemId, fields }: {
         itemId: string;
-        fields: any;
+        fields: object;
     }): Promise<Item>;
 }

package/dist/api/item.d.ts

@@ -153,7 +153,7 @@ export declare class Item extends WebflowRecord<IItem> implements IItem {
      * @param client The Axios client instance
      * @returns The result of the publish
      */
-    static publish({ itemIds, live, collectionId }: {
+    static publish({ itemIds, live, collectionId, }: {
         live?: boolean;
         itemIds: string[];
         collectionId: string;

package/dist/api/item.js

@@ -119,7 +119,7 @@ class Item extends core_1.WebflowRecord {
      * @param client The Axios client instance
      * @returns The result of the publish
      */
-    static publish({ itemIds, live = false, collectionId }, client) {
+    static publish({ itemIds, live = false, collectionId, }, client) {
         (0, core_1.requireArgs)({ collectionId, itemIds });
         const params = { live };
         const path = `/collections/${collectionId}/items/publish`;

package/dist/api/oauth.d.ts

@@ -55,7 +55,7 @@ export declare class OAuth {
      * @param client The Axios client instance
      * @returns An access token
      */
-    static accessToken({ grant_type, client_secret, redirect_uri, client_id, code }: IAccessTokenParams, client: AxiosInstance): Promise<import("axios").AxiosResponse<IAccessToken, any>>;
+    static accessToken({ grant_type, client_secret, redirect_uri, client_id, code, }: IAccessTokenParams, client: AxiosInstance): Promise<import("axios").AxiosResponse<IAccessToken, any>>;
     /**
      * Revoke an access token
      * @param params The params for the request

package/dist/api/oauth.js

@@ -40,7 +40,7 @@ class OAuth {
      * @param client The Axios client instance
      * @returns An access token
      */
-    static accessToken({ grant_type = "authorization_code", client_secret, redirect_uri, client_id, code }, client) {
+    static accessToken({ grant_type = "authorization_code", client_secret, redirect_uri, client_id, code, }, client) {
         (0, core_1.requireArgs)({ client_id, client_secret, code });
         const path = "/oauth/access_token";
         const data = { client_secret, redirect_uri, grant_type, client_id, code };

package/dist/api/user.d.ts

@@ -10,6 +10,13 @@ export interface IUser {
     _id: string;
     data: any;
 }
+export interface IAcessGroup {
+    _id: string;
+    name: string;
+    shortId: string;
+    slug: string;
+    createdOn: string;
+}
 export interface IUserDelete {
     deleted: number;
 }
@@ -19,6 +26,9 @@ export interface IUserDelete {
 export declare type PaginatedUsers = PaginatedData & {
     users: IUser[];
 };
+export declare type PaginatedAccessGroups = PaginatedData & {
+    accessGroups: IAcessGroup[];
+};
 export declare type UserIdParam = {
     siteId: string;
     userId: string;
@@ -100,6 +110,22 @@ export declare class User extends WebflowRecord<IUser> implements IUser {
         siteId: string;
         userId: string;
     }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUserDelete, any>>;
+    /**
+     * Get a list of User Access Groups
+     * @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)
+     * @param params.sort The sort order of the groups (optional)
+     * @param client The Axios client instance
+     * @returns A list of Access Groups
+     */
+    static accessGroups({ siteId, limit, offset, sort, }: {
+        siteId: string;
+        limit?: number;
+        offset?: number;
+        sort?: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<PaginatedAccessGroups, any>>;
     /**************************************************************
      * Instance Methods
      **************************************************************/

package/dist/api/user.js

@@ -77,6 +77,22 @@ class User extends core_1.WebflowRecord {
         const path = `/sites/${siteId}/users/${userId}`;
         return client.delete(path);
     }
+    /**
+     * Get a list of User Access Groups
+     * @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)
+     * @param params.sort The sort order of the groups (optional)
+     * @param client The Axios client instance
+     * @returns A list of Access Groups
+     */
+    static accessGroups({ siteId, limit, offset, sort, }, client) {
+        (0, core_1.requireArgs)({ siteId });
+        const params = { limit, offset, sort };
+        const path = `/sites/${siteId}/accessgroups`;
+        return client.get(path, { params });
+    }
     /**************************************************************
      * Instance Methods
      **************************************************************/

package/dist/core/error.d.ts

@@ -18,4 +18,4 @@ export declare class ArgumentError extends Error {
     constructor(name: string);
 }
 export declare function requireArgs(args: object): void;
-export declare function ErrorInterceptor(res: AxiosResponse): AxiosResponse<any, any>;
+export declare function ErrorInterceptor(res: AxiosResponse<IRequestError>): AxiosResponse<IRequestError, any>;

package/dist/core/webflow.d.ts

@@ -243,7 +243,7 @@ export declare class Webflow {
      * @param params.live Update the live version
      * @returns The unpublished Collection Item result
      */
-    deleteItems({ collectionId, itemIds, live }: {
+    deleteItems({ collectionId, itemIds, live, }: {
         collectionId: string;
         itemIds: string[];
         live?: boolean;
@@ -256,7 +256,7 @@ export declare class Webflow {
      * @param params.live Update the live version
      * @returns The Published Collection Item result
      */
-    publishItems({ collectionId, itemIds, live }: {
+    publishItems({ collectionId, itemIds, live, }: {
         collectionId: string;
         itemIds: string[];
         live?: boolean;
@@ -319,6 +319,21 @@ export declare class Webflow {
         siteId: string;
         userId: string;
     }): Promise<import("../api").IUserDelete>;
+    /**
+     * Get a list of User Access Groups
+     * @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)
+     * @param params.sort The sort order of the groups (optional)
+     * @returns A list of Access Groups
+     */
+    accessGroups({ siteId, limit, offset, sort, }: {
+        siteId: string;
+        limit?: number;
+        offset?: number;
+        sort?: string;
+    }): Promise<import("../api").PaginatedAccessGroups>;
     /**************************************************************
      * Webhook Endpoints
      **************************************************************/

package/dist/core/webflow.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Webflow = exports.USER_AGENT = exports.DEFAULT_HOST = void 0;
 const axios_1 = __importDefault(require("axios"));
+const core_1 = require("../core");
 const api_1 = require("../api");
 exports.DEFAULT_HOST = "webflow.com";
 exports.USER_AGENT = "Webflow Javascript SDK / 1.0";
@@ -15,6 +16,7 @@ class Webflow {
     constructor(options = {}) {
         this.options = options;
         this.client = axios_1.default.create(this.config);
+        this.client.interceptors.response.use(core_1.ErrorInterceptor);
     }
     // Set the Authentication token
     set token(value) {
@@ -301,7 +303,7 @@ class Webflow {
      * @param params.live Update the live version
      * @returns The unpublished Collection Item result
      */
-    async deleteItems({ collectionId, itemIds, live }) {
+    async deleteItems({ collectionId, itemIds, live, }) {
         const res = await api_1.Item.unpublish({ collectionId, itemIds, live }, this.client);
         return res.data;
     }
@@ -313,7 +315,7 @@ class Webflow {
      * @param params.live Update the live version
      * @returns The Published Collection Item result
      */
-    async publishItems({ collectionId, itemIds, live }) {
+    async publishItems({ collectionId, itemIds, live, }) {
         const res = await api_1.Item.publish({ collectionId, itemIds, live }, this.client);
         return res.data;
     }
@@ -376,6 +378,20 @@ class Webflow {
         const res = await api_1.User.remove({ siteId, userId }, this.client);
         return res.data;
     }
+    /**
+     * Get a list of User Access Groups
+     * @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)
+     * @param params.sort The sort order of the groups (optional)
+     * @returns A list of Access Groups
+     */
+    async accessGroups({ siteId, limit, offset, sort, }) {
+        const params = { siteId, limit, offset, sort };
+        const res = await api_1.User.accessGroups(params, this.client);
+        return res.data;
+    }
     /**************************************************************
      * Webhook Endpoints
      **************************************************************/

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "webflow-api",
   "description": "Webflow's official Node.js SDK for Data APIs",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "contributors": [
@@ -19,15 +19,21 @@
     "yarn.lock"
   ],
   "scripts": {
-    "build": "yarn clean && tsc -p ./",
-    "lint": "eslint . --ext .ts",
+    "test": "yarn build && jest",
+    "build": "yarn clean && tsc",
+    "lint": "eslint src --ext .ts",
+    "test:snapshot": "yarn test --updateSnapshot",
+    "test:coverage": "yarn test --collectCoverage",
+    "test:ci": "yarn test --ci --coverage --forceExit",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
     "prepublish": "yarn build",
-    "watch": "tsc -watch -p ./",
+    "watch": "tsc --watch",
     "clean": "rm -rf dist",
-    "test": "jest"
+    "typecheck": "tsc --noEmit"
   },
   "devDependencies": {
-    "@types/jest": "^29.2.1",
+    "@types/jest": "^29.2.3",
     "@types/node": "^18.11.9",
     "@typescript-eslint/eslint-plugin": "^5.42.0",
     "@typescript-eslint/parser": "^5.42.0",

package/src/api/collection.ts

@@ -32,7 +32,7 @@ export type CollectionField = {
   required: boolean;
   editable: boolean;
   // TODO: add a better type
-  validations?: any;
+  validations?: Record<string, string | number | boolean | object>;
 };
 
 /**************************************************************
@@ -134,7 +134,7 @@ export class Collection extends WebflowRecord<ICollection> implements ICollectio
    * @param fields The Item fields to create
    * @returns The created Item
    */
-  async createItem(fields: any) {
+  async createItem(fields: object) {
     const res = await Item.create({ collectionId: this._id, fields }, this.client);
     return new Item(this.client, res);
   }
@@ -146,7 +146,7 @@ export class Collection extends WebflowRecord<ICollection> implements ICollectio
    * @param params.fields The fields to update
    * @returns The updated Item
    */
-  async updateItem({ itemId, fields }: { itemId: string; fields: any }) {
+  async updateItem({ itemId, fields }: { itemId: string; fields: object }) {
     const params = { itemId, collectionId: this._id, fields };
     const res = await Item.update(params, this.client);
     return new Item(this.client, res);

package/src/api/item.ts

@@ -70,7 +70,10 @@ export class Item extends WebflowRecord<IItem> implements IItem {
    * @param client The Axios client instance
    * @returns A single Item
    */
-  static getOne({ collectionId, itemId }: { collectionId: string; itemId: string }, client: AxiosInstance) {
+  static getOne(
+    { collectionId, itemId }: { collectionId: string; itemId: string },
+    client: AxiosInstance,
+  ) {
     requireArgs({ collectionId, itemId });
     const path = `/collections/${collectionId}/items/${itemId}`;
     // The API returns a paginated list with one record :(
@@ -88,7 +91,7 @@ export class Item extends WebflowRecord<IItem> implements IItem {
    */
   static list(
     { collectionId, limit, offset }: { collectionId: string; limit?: number; offset?: number },
-    client: AxiosInstance
+    client: AxiosInstance,
   ) {
     requireArgs({ collectionId });
     const params = { limit, offset };
@@ -104,7 +107,10 @@ export class Item extends WebflowRecord<IItem> implements IItem {
    * @param client The Axios client instance
    * @returns The created Item
    */
-  static create({ collectionId, fields }: { fields: any; collectionId: string }, client: AxiosInstance) {
+  static create(
+    { collectionId, fields }: { fields: any; collectionId: string },
+    client: AxiosInstance,
+  ) {
     requireArgs({ collectionId });
     const path = `/collections/${collectionId}/items`;
     return client.post<IItem>(path, { fields });
@@ -129,7 +135,7 @@ export class Item extends WebflowRecord<IItem> implements IItem {
       itemId: string;
       collectionId: string;
     },
-    client: AxiosInstance
+    client: AxiosInstance,
   ) {
     requireArgs({ collectionId, itemId });
     const path = `/collections/${collectionId}/items/${itemId}`;
@@ -155,7 +161,7 @@ export class Item extends WebflowRecord<IItem> implements IItem {
       itemId: string;
       collectionId: string;
     },
-    client: AxiosInstance
+    client: AxiosInstance,
   ) {
     requireArgs({ collectionId, itemId });
     const path = `/collections/${collectionId}/items/${itemId}`;
@@ -178,7 +184,7 @@ export class Item extends WebflowRecord<IItem> implements IItem {
       itemId: string;
       collectionId: string;
     },
-    client: AxiosInstance
+    client: AxiosInstance,
   ) {
     requireArgs({ collectionId, itemId });
     const path = `/collections/${collectionId}/items/${itemId}`;
@@ -203,7 +209,7 @@ export class Item extends WebflowRecord<IItem> implements IItem {
       itemIds: string[];
       collectionId: string;
     },
-    client: AxiosInstance
+    client: AxiosInstance,
   ) {
     requireArgs({ collectionId, itemIds });
     const params = { live };
@@ -226,8 +232,12 @@ export class Item extends WebflowRecord<IItem> implements IItem {
    * @returns The result of the publish
    */
   static publish(
-    { itemIds, live = false, collectionId }: { live?: boolean; itemIds: string[]; collectionId: string },
-    client: AxiosInstance
+    {
+      itemIds,
+      live = false,
+      collectionId,
+    }: { live?: boolean; itemIds: string[]; collectionId: string },
+    client: AxiosInstance,
   ) {
     requireArgs({ collectionId, itemIds });
     const params = { live };

package/src/api/oauth.ts

@@ -53,7 +53,7 @@ export class OAuth {
    */
   static authorizeUrl(
     { response_type = "code", redirect_uri, client_id, state, scope }: IAuthorizeUrlParams,
-    client: AxiosInstance
+    client: AxiosInstance,
   ) {
     requireArgs({ client_id });
 
@@ -78,8 +78,14 @@ export class OAuth {
    * @returns An access token
    */
   static accessToken(
-    { grant_type = "authorization_code", client_secret, redirect_uri, client_id, code }: IAccessTokenParams,
-    client: AxiosInstance
+    {
+      grant_type = "authorization_code",
+      client_secret,
+      redirect_uri,
+      client_id,
+      code,
+    }: IAccessTokenParams,
+    client: AxiosInstance,
   ) {
     requireArgs({ client_id, client_secret, code });
 
@@ -97,7 +103,10 @@ export class OAuth {
    * @param client The Axios client instance
    * @returns The result of the revoke
    */
-  static revokeToken({ client_secret, access_token, client_id }: IRevokeTokenParams, client: AxiosInstance) {
+  static revokeToken(
+    { client_secret, access_token, client_id }: IRevokeTokenParams,
+    client: AxiosInstance,
+  ) {
     requireArgs({ client_id, client_secret, access_token });
 
     const path = "/oauth/revoke_authorization";

package/src/api/site.ts

@@ -71,7 +71,10 @@ export class Site extends WebflowRecord<ISite> implements ISite {
    * @param client The Axios client instance
    * @returns The publish result
    */
-  static publish({ siteId, domains }: { siteId: string; domains: string[] }, client: AxiosInstance) {
+  static publish(
+    { siteId, domains }: { siteId: string; domains: string[] },
+    client: AxiosInstance,
+  ) {
     requireArgs({ siteId, domains });
     const path = `/sites/${siteId}/publish`;
     return client.post<IPublishSite>(path, { domains });

package/src/api/user.ts

@@ -12,6 +12,14 @@ export interface IUser {
   data: any;
 }
 
+export interface IAcessGroup {
+  _id: string;
+  name: string;
+  shortId: string;
+  slug: string;
+  createdOn: string;
+}
+
 export interface IUserDelete {
   deleted: number;
 }
@@ -23,6 +31,10 @@ export type PaginatedUsers = PaginatedData & {
   users: IUser[];
 };
 
+export type PaginatedAccessGroups = PaginatedData & {
+  accessGroups: IAcessGroup[];
+};
+
 export type UserIdParam = { siteId: string; userId: string };
 
 /**************************************************************
@@ -50,7 +62,10 @@ export class User extends WebflowRecord<IUser> implements IUser {
    * @param client The Axios client instance
    * @returns A list of Users
    */
-  static list({ siteId, limit, offset }: { siteId: string; limit?: number; offset?: number }, client: AxiosInstance) {
+  static list(
+    { siteId, limit, offset }: { siteId: string; limit?: number; offset?: number },
+    client: AxiosInstance,
+  ) {
     requireArgs({ siteId });
     const params = { limit, offset };
     const path = `/sites/${siteId}/users`;
@@ -90,7 +105,7 @@ export class User extends WebflowRecord<IUser> implements IUser {
       siteId: string;
       userId: string;
     },
-    client: AxiosInstance
+    client: AxiosInstance,
   ) {
     requireArgs({ siteId, userId });
     const path = `/sites/${siteId}/users/${userId}`;
@@ -125,6 +140,31 @@ export class User extends WebflowRecord<IUser> implements IUser {
     return client.delete<IUserDelete>(path);
   }
 
+  /**
+   * Get a list of User Access Groups
+   * @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)
+   * @param params.sort The sort order of the groups (optional)
+   * @param client The Axios client instance
+   * @returns A list of Access Groups
+   */
+  static accessGroups(
+    {
+      siteId,
+      limit,
+      offset,
+      sort,
+    }: { siteId: string; limit?: number; offset?: number; sort?: string },
+    client: AxiosInstance,
+  ) {
+    requireArgs({ siteId });
+    const params = { limit, offset, sort };
+    const path = `/sites/${siteId}/accessgroups`;
+    return client.get<PaginatedAccessGroups>(path, { params });
+  }
+
   /**************************************************************
    * Instance Methods
    **************************************************************/

package/src/api/webhook.ts

@@ -75,7 +75,10 @@ export class Webhook extends WebflowRecord<IWebhook> implements IWebhook {
    * @param client The Axios client instance
    * @returns A single Webhook
    */
-  static getOne({ siteId, webhookId }: { siteId: string; webhookId: string }, client: AxiosInstance) {
+  static getOne(
+    { siteId, webhookId }: { siteId: string; webhookId: string },
+    client: AxiosInstance,
+  ) {
     requireArgs({ siteId, webhookId });
     const path = `/sites/${siteId}/webhooks/${webhookId}`;
     return client.get<IWebhook>(path);
@@ -104,7 +107,7 @@ export class Webhook extends WebflowRecord<IWebhook> implements IWebhook {
       filter?: WebhookFilter;
       triggerType: TriggerType;
     },
-    client: AxiosInstance
+    client: AxiosInstance,
   ) {
     requireArgs({ siteId, triggerType, url });
     const path = `/sites/${siteId}/webhooks`;
@@ -120,7 +123,10 @@ export class Webhook extends WebflowRecord<IWebhook> implements IWebhook {
    * @param client The Axios client instance
    * @returns The result of the removal
    */
-  static remove({ siteId, webhookId }: { siteId: string; webhookId: string }, client: AxiosInstance) {
+  static remove(
+    { siteId, webhookId }: { siteId: string; webhookId: string },
+    client: AxiosInstance,
+  ) {
     requireArgs({ siteId, webhookId });
     const path = `/sites/${siteId}/webhooks/${webhookId}`;
     return client.delete<IRemoveResult>(path);

package/src/core/error.ts

@@ -34,7 +34,7 @@ export function requireArgs(args: object) {
 }
 
 // throw an error if Webflow error
-export function ErrorInterceptor(res: AxiosResponse) {
+export function ErrorInterceptor(res: AxiosResponse<IRequestError>) {
   if (res.data.err) throw new RequestError(res.data);
   return res;
 }

package/src/core/webflow.ts

@@ -1,5 +1,5 @@
 import axios, { AxiosInstance, AxiosRequestConfig } from "axios";
-import { PaginationFilter } from "../core";
+import { PaginationFilter, ErrorInterceptor } from "../core";
 import {
   Collection,
   IAccessTokenParams,
@@ -31,6 +31,7 @@ export class Webflow {
   private client: AxiosInstance;
   constructor(public options: Options = {}) {
     this.client = axios.create(this.config);
+    this.client.interceptors.response.use(ErrorInterceptor);
   }
 
   // Set the Authentication token
@@ -334,7 +335,15 @@ export class Webflow {
    * @param params.live Update the live version
    * @returns The unpublished Collection Item result
    */
-  async deleteItems({ collectionId, itemIds, live }: { collectionId: string; itemIds: string[]; live?: boolean }) {
+  async deleteItems({
+    collectionId,
+    itemIds,
+    live,
+  }: {
+    collectionId: string;
+    itemIds: string[];
+    live?: boolean;
+  }) {
     const res = await Item.unpublish({ collectionId, itemIds, live }, this.client);
     return res.data;
   }
@@ -346,7 +355,15 @@ export class Webflow {
    * @param params.live Update the live version
    * @returns The Published Collection Item result
    */
-  async publishItems({ collectionId, itemIds, live }: { collectionId: string; itemIds: string[]; live?: boolean }) {
+  async publishItems({
+    collectionId,
+    itemIds,
+    live,
+  }: {
+    collectionId: string;
+    itemIds: string[];
+    live?: boolean;
+  }) {
     const res = await Item.publish({ collectionId, itemIds, live }, this.client);
     return res.data;
   }
@@ -416,6 +433,31 @@ export class Webflow {
     return res.data;
   }
 
+  /**
+   * Get a list of User Access Groups
+   * @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)
+   * @param params.sort The sort order of the groups (optional)
+   * @returns A list of Access Groups
+   */
+  async accessGroups({
+    siteId,
+    limit,
+    offset,
+    sort,
+  }: {
+    siteId: string;
+    limit?: number;
+    offset?: number;
+    sort?: string;
+  }) {
+    const params = { siteId, limit, offset, sort };
+    const res = await User.accessGroups(params, this.client);
+    return res.data;
+  }
+
   /**************************************************************
    * Webhook Endpoints
    **************************************************************/

package/yarn.lock

@@ -673,10 +673,10 @@
   dependencies:
     "@types/istanbul-lib-report" "*"
 
-"@types/jest@^29.2.1":
-  "integrity" "sha512-nKixEdnGDqFOZkMTF74avFNr3yRqB1ZJ6sRZv5/28D5x2oLN14KApv7F9mfDT/vUic0L3tRCsh3XWpWjtJisUQ=="
-  "resolved" "https://registry.npmjs.org/@types/jest/-/jest-29.2.1.tgz"
-  "version" "29.2.1"
+"@types/jest@^29.2.3":
+  "integrity" "sha512-6XwoEbmatfyoCjWRX7z0fKMmgYKe9+/HrviJ5k0X/tjJWHGAezZOfYaxqQKuzG/TvQyr+ktjm4jgbk0s4/oF2w=="
+  "resolved" "https://registry.npmjs.org/@types/jest/-/jest-29.2.3.tgz"
+  "version" "29.2.3"
   dependencies:
     "expect" "^29.0.0"
     "pretty-format" "^29.0.0"