Merge branch 'master' into patch-1

Author: choran

.circleci/config.yml

@@ -0,0 +1,29 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/node:8-browsers
+
+    working_directory: ~/intercom-node
+
+    environment:
+      - YARN_VERSION: 1.7.0
+
+    steps:
+      - checkout
+      - run: export PATH="${PATH}:/home/circleci/.yarn/bin"
+      - run:
+          name: Install Yarn
+          command: |
+            if [[ ! -e ~/.yarn/bin/yarn || $(yarn --version) != "${YARN_VERSION}"  ]]; then
+              echo "Download and install Yarn."
+              curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version $YARN_VERSION
+            else
+              echo "The correct version of Yarn is already installed."
+            fi
+      - run: yarn
+      - run: yarn test
+
+notify:
+  webhooks:
+    - url: https://muster.intercom.io/circle_webhooks

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+#### Why?
+Why are you making this change?
+
+#### How?
+Technical details on your change

.travis.yml

@@ -1,7 +1,7 @@
 # intercom-node
 > Official Node bindings to the Intercom API
 
-[![Build Status](https://travis-ci.org/intercom/intercom-node.svg?branch=master)](https://travis-ci.org/intercom/intercom-node)
+[![Circle CI](https://circleci.com/gh/intercom/intercom-node.png?style=badge)](https://circleci.com/gh/intercom/intercom-node)
 
 [![npm version](https://badge.fury.io/js/intercom-client.svg)](http://badge.fury.io/js/intercom-client)
 
@@ -143,8 +143,14 @@ client.users.find({ email: '[email protected]' }, callback);
 ```
 
 ```node
-// Delete user by id
-client.users.delete({ id: '1234' }, callback);
+// Archive user by id (https://developers.intercom.com/v2.0/reference#archive-a-user)
+client.users.archive({ id: '1234' }, callback);
+```
+
+```node
+// Permanently delete a user user by id (https://developers.intercom.com/v2.0/reference#delete-users)
+const intercomUserId = '123'
+client.users.requestPermanentDeletion(intercomUserId, callback);
 ```
 
 ## Leads

README.md

@@ -145,7 +145,7 @@ export default class Client {
     if (f.length >= 2) {
       if (res && res.body && res.body.type === 'error.list') {
         let message = null;
-        if (Array.isArray(res.body.errors) && res.body.errors[0] && 'message' in res.body.errors) {
+        if (Array.isArray(res.body.errors) && res.body.errors[0] && 'message' in res.body.errors[0]) {
           // Try to use the first errors message
           message = res.body.errors[0].message;
         }

lib/client.js

@@ -1,10 +1,14 @@
 import Bulk from './bulk';
 import Scroll from './scroll';
+import { deprecate } from 'util';
 
 export default class User {
   constructor(client) {
     this.client = client;
     this.scroll = new Scroll(this.client, 'user');
+
+    // Keep this API around but mark it deprecated
+    this.delete = deprecate(this.archive.bind(this), 'intercom-client - user.delete: Use user.archive instead');
   }
   create(data, f) {
     return this.client.post('/users', data, f);
@@ -27,7 +31,7 @@ export default class User {
       return this.client.get(`/users`, { email: params.email }, f);
     }
   }
-  delete(params, f) {
+  archive(params, f) {
     if (params.id) {
       return this.client.delete(`/users/${params.id}`, {}, f);
     } else if (params.user_id) {
@@ -39,4 +43,7 @@ export default class User {
   bulk(params, f) {
     return (new Bulk(this.client, 'user').bulk(params, f));
   }
+  requestPermanentDeletion(intercom_user_id, f) {
+    return this.client.post('/user_delete_requests', { intercom_user_id }, f);
+  }
 }

lib/user.js

@@ -1,6 +1,6 @@
 {
   "name": "intercom-client",
-  "version": "2.9.3",
+  "version": "2.10.2",
   "description": "Official Node bindings to the Intercom API",
   "homepage": "https://github.com/intercom/intercom-node",
   "bugs:": "https://github.com/intercom/intercom-node/issues",
@@ -20,8 +20,7 @@
   "dependencies": {
     "bluebird": "^3.3.4",
     "htmlencode": "^0.0.4",
-    "request": "^2.83.0",
-    "sinon": "^4.1.3"
+    "request": "^2.83.0"
   },
   "devDependencies": {
     "babel-core": "^6.7.4",
@@ -36,7 +35,8 @@
     "gulp-mocha": "^2.0.0",
     "gulp-nsp": "^2.4.2",
     "gulp-plumber": "^1.1.0",
-    "nock": "7.5.0"
+    "nock": "7.5.0",
+    "sinon": "^6.1.4"
   },
   "scripts": {
     "prepublish": "gulp prepublish",

package.json

@@ -45,6 +45,7 @@ describe('errors', () => {
         assert.strictEqual(err.statusCode, 401);
         assert.strictEqual(err.body.request_id, 'b2i3ri5909msvfqskol0');
         assert.deepStrictEqual(err.body.errors, [{ code: 'token_unauthorized', message: 'Not authorized to access resource' }]);
+        assert.deepStrictEqual(err.message, 'Not authorized to access resource');
         assert.strictEqual(err.headers['x-request-id'], 'b2i3ri5909msvfqskol0');
       });
     });
@@ -76,6 +77,7 @@ describe('errors', () => {
         assert.strictEqual(err.statusCode, 429);
         assert.strictEqual(err.body.request_id, 'b2i3mhcboc6pcbe33q80');
         assert.deepStrictEqual(err.body.errors, [{ code: 'rate_limit_exceeded', message: 'Exceeded rate limit of 83 in 10_seconds' }]);
+        assert.deepStrictEqual(err.message, 'Exceeded rate limit of 83 in 10_seconds');
         assert.strictEqual(err.headers['x-request-id'], 'b2i3mhcboc6pcbe33q80');
         assert.strictEqual(err.headers['x-ratelimit-reset'], '1522849880');
       });
@@ -204,6 +206,7 @@ describe('errors', () => {
           assert.strictEqual(err.statusCode, 401);
           assert.strictEqual(err.body.request_id, 'b2i3ri5909msvfqskol0');
           assert.deepStrictEqual(err.body.errors, [{ code: 'token_unauthorized', message: 'Not authorized to access resource' }]);
+          assert.deepStrictEqual(err.message, 'Not authorized to access resource');
           assert.strictEqual(err.headers['x-request-id'], 'b2i3ri5909msvfqskol0');
 
           done();
@@ -237,6 +240,7 @@ describe('errors', () => {
           assert.strictEqual(err.statusCode, 429);
           assert.strictEqual(err.body.request_id, 'b2i3mhcboc6pcbe33q80');
           assert.deepStrictEqual(err.body.errors, [{ code: 'rate_limit_exceeded', message: 'Exceeded rate limit of 83 in 10_seconds' }]);
+          assert.deepStrictEqual(err.message, 'Exceeded rate limit of 83 in 10_seconds');
           assert.strictEqual(err.headers['x-request-id'], 'b2i3mhcboc6pcbe33q80');
           assert.strictEqual(err.headers['x-ratelimit-reset'], '1522849880');
 

test/errors.js

@@ -59,28 +59,61 @@ describe('users', () => {
       done();
     });
   });
-  it('should delete users by id', done => {
+  it('should archive users by id', done => {
+    nock('https://api.intercom.io').delete('/users/baz').reply(200, {});
+    const client = new Client('foo', 'bar').usePromises();
+    client.users.archive({ id: 'baz' }).then(r => {
+      assert.equal(200, r.statusCode);
+      done();
+    });
+  });
+  it('should archive users by user_id', done => {
+    nock('https://api.intercom.io').delete('/users').query({ user_id: 'foo' }).reply(200, {});
+    const client = new Client('foo', 'bar').usePromises();
+    client.users.archive({ user_id: 'foo' }).then(r => {
+      assert.equal(200, r.statusCode);
+      done();
+    });
+  });
+  it('should archive users by email', done => {
+    nock('https://api.intercom.io').delete('/users').query({ email: 'foo' }).reply(200, {});
+    const client = new Client('foo', 'bar').usePromises();
+    client.users.archive({ email: 'foo' }).then(r => {
+      assert.equal(200, r.statusCode);
+      done();
+    });
+  });
+  it('should archive (using old delete function) users by id', done => {
     nock('https://api.intercom.io').delete('/users/baz').reply(200, {});
     const client = new Client('foo', 'bar').usePromises();
     client.users.delete({ id: 'baz' }).then(r => {
       assert.equal(200, r.statusCode);
       done();
     });
   });
-  it('should delete users by user_id', done => {
+  it('should archive (using old delete function) users by user_id', done => {
     nock('https://api.intercom.io').delete('/users').query({ user_id: 'foo' }).reply(200, {});
     const client = new Client('foo', 'bar').usePromises();
     client.users.delete({ user_id: 'foo' }).then(r => {
       assert.equal(200, r.statusCode);
       done();
     });
   });
-  it('should delete users by email', done => {
+  it('should archive (using old delete function) users by email', done => {
     nock('https://api.intercom.io').delete('/users').query({ email: 'foo' }).reply(200, {});
     const client = new Client('foo', 'bar').usePromises();
     client.users.delete({ email: 'foo' }).then(r => {
       assert.equal(200, r.statusCode);
       done();
     });
   });
+  it('should permanently delete users by intercom user ID', done => {
+    nock('https://api.intercom.io').post('/user_delete_requests', { intercom_user_id: 'foo' }).reply(200, { id: 10 });
+    const client = new Client('foo', 'bar').usePromises();
+    client.users.requestPermanentDeletion('foo').then(r => {
+      assert.equal(200, r.statusCode);
+      assert.deepStrictEqual({ id: 10 }, r.body);
+      done();
+    });
+  });
 });