Renamed users.delete to users.archive (deprecating old .delete function)

Author: rhodgkins

README.md

@@ -143,8 +143,8 @@ 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);
 ```
 
 ## Leads

lib/user.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) {

test/user.js

@@ -59,23 +59,47 @@ 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 => {