Merge pull request #59 from webflow/users-api

Adding Methods for Users API
webflow · Jun 23, 2022 · 2305de2 · 2305de2
2 parents 3446ca5 + 2d6b8de
commit 2305de2
Show file tree

Hide file tree

Showing 9 changed files with 237 additions and 96 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,2 @@
+[*]
+max_line_length = 80
diff --git a/.eslintrc b/.eslintrc
@@ -1,7 +1,9 @@
 {
-  "extends": "airbnb-base",
+  "extends": ["airbnb-base", "prettier"],
+  "plugins": ["prettier"],
   "rules": {
     "no-underscore-dangle": 0,
-    "class-methods-use-this": 0
+    "class-methods-use-this": 0,
+    "prettier/prettier": ["error"]
   }
 }
diff --git a/index.d.ts b/index.d.ts
@@ -72,6 +72,37 @@ declare class Webflow {
     query?: Webflow.WebflowQueryArg
   ): Promise<Webflow.WebflowApiModel.Collection>;
 
+  // Users
+  users(
+    data: {
+      siteId: string;
+    },
+    query?: Webflow.WebflowQueryArg
+  ): Promise<Webflow.WebflowApiModel.User[]>;
+
+  user(
+    data: {
+      siteId: string;
+      userId: string;
+    },
+    query?: Webflow.WebflowQueryArg
+  ): Promise<Webflow.WebflowApiModel.User>;
+
+  updateUser(
+    data: { siteId: string; userId: string } & Record<string, any>,
+    query?: Webflow.WebflowQueryArg
+  ): Promise<Webflow.WebflowApiModel.User>;
+
+  removeUser(
+    data: { siteId: string; userId: string },
+    query?: Webflow.WebflowQueryArg
+  ): Promise<{ deleted: number }>;
+
+  inviteUser(
+    data: { siteId: string; email: string },
+    query?: Webflow.WebflowQueryArg
+  ): Promise<Webflow.WebflowApiModel.User>;
+
   // Items
 
   items(
@@ -213,6 +244,14 @@ declare namespace Webflow {
       name: string;
     }
 
+    interface User {
+      _id: string;
+      lastUpdated: string;
+      createdOn: string;
+      emailVerified: boolean;
+      data: object;
+    }
+
     /**
      * https://developers.webflow.com/?javascript#collections
      */
@@ -301,7 +340,7 @@ declare namespace Webflow {
       rateLimit: {
         limit: number;
         remaining: number;
-      }
+      };
     }
 
     interface ItemsResponse {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "webflow-api",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "description": "SDK for the Webflow CMS API",
   "main": "dist/index.js",
   "jsnext:main": "src/index.js",
@@ -34,13 +34,14 @@
     "ava": "^4.1.0",
     "eslint": "^8.12.0",
     "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.25.2",
     "nock": "^13.0.7",
     "nyc": "^15.1.0"
   },
   "dependencies": {
-    "isomorphic-fetch": "^3.0.0",
     "es6-error": "^4.0.0",
+    "isomorphic-fetch": "^3.0.0",
     "qs": "^6.3.0"
   },
   "ava": {

diff --git a/src/ResponseWrapper.js b/src/ResponseWrapper.js
@@ -37,16 +37,28 @@ export default class ResponseWrapper {
 
       items: this.api.items.bind(this.api, { collectionId: collection._id }),
       item(first, ...rest) {
-        return this.api.item({ ...first, collectionId: collection._id }, ...rest);
+        return this.api.item(
+          { ...first, collectionId: collection._id },
+          ...rest
+        );
       },
       createItem(first, ...rest) {
-        return this.api.createItem({ ...first, collectionId: collection._id }, ...rest);
+        return this.api.createItem(
+          { ...first, collectionId: collection._id },
+          ...rest
+        );
       },
       updateItem(first, ...rest) {
-        return this.api.updateItem({ ...first, collectionId: collection._id }, ...rest);
+        return this.api.updateItem(
+          { ...first, collectionId: collection._id },
+          ...rest
+        );
       },
       removeItem(first, ...rest) {
-        return this.api.removeItem({ ...first, collectionId: collection._id }, ...rest);
+        return this.api.removeItem(
+          { ...first, collectionId: collection._id },
+          ...rest
+        );
       },
     };
   }
@@ -56,17 +68,39 @@ export default class ResponseWrapper {
       ...item,
 
       update(first, ...rest) {
-        return this.api.updateItem({ ...first, collectionId, itemId: item._id }, ...rest);
+        return this.api.updateItem(
+          { ...first, collectionId, itemId: item._id },
+          ...rest
+        );
+      },
+      remove: this.api.updateItem.bind(this.api, {
+        collectionId,
+        itemId: item._id,
+      }),
+    };
+  }
+
+  user(user, siteId) {
+    return {
+      ...user,
+
+      update(first, ...rest) {
+        return this.api.updateUser({ ...first, siteId }, ...rest);
+      },
+      remove(first, ...rest) {
+        return this.api.removeUser({ ...first, siteId }, ...rest);
       },
-      remove: this.api.updateItem.bind(this.api, { collectionId, itemId: item._id }),
     };
   }
 
   webhook(webhook, siteId) {
     return {
       ...webhook,
 
-      remove: this.api.removeWebhook.bind(this.api, { siteId, webhookId: webhook._id }),
+      remove: this.api.removeWebhook.bind(this.api, {
+        siteId,
+        webhookId: webhook._id,
+      }),
     };
   }
 }