Introduces the ability to permanently delete a user (#251)

This change introduces a new `archiveUser` method, and updates the
`deleteUser` method to alias it.

Additionally the change introduces a new `permanentlyDeleteUser`
that leverages a `POST` to `user_delete_requests` to initiate
a permanent delete from the intercom api.

Addresses: #249

Author: Jaspaul

src/IntercomUsers.php

@@ -90,18 +90,47 @@ public function scrollUsers($options = [])
     /**
      * Deletes a single User based on the Intercom ID.
      *
-     * @see    https://developers.intercom.com/reference#delete-a-user
+     * @see    https://developers.intercom.com/reference#archive-a-user
      * @param  string $id
      * @param  array  $options
      * @return mixed
      * @throws \GuzzleHttp\Exception\GuzzleException
      */
-    public function deleteUser($id, $options = [])
+    public function archiveUser($id, $options = [])
     {
         $path = $this->userPath($id);
         return $this->client->delete($path, $options);
     }
 
+    /**
+     * Deletes a single User based on the Intercom ID.
+     *
+     * @see    https://developers.intercom.com/reference#archive-a-user
+     * @param  string $id
+     * @param  array  $options
+     * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     */
+    public function deleteUser($id, $options = [])
+    {
+        return $this->archiveUser($id, $options);
+    }
+
+    /**
+     * Permanently deletes a single User based on the Intercom ID.
+     *
+     * @see   https://developers.intercom.com/reference#delete-users
+     * @param string $id
+     * @return mixed
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     */
+    public function permanentlyDeleteUser($id)
+    {
+        return $this->client->post('user_delete_requests', [
+            'intercom_user_id' => $id
+        ]);
+    }
+
     /**
      * @param string $id
      * @return string

test/IntercomUsersTest.php

@@ -36,4 +36,31 @@ public function testUserGet()
         $users = new IntercomUsers($stub);
         $this->assertEquals('foo', $users->getUsers([]));
     }
+
+    public function testArchiveUser()
+    {
+        $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
+        $stub->method('delete')->willReturn('foo');
+
+        $users = new IntercomUsers($stub);
+        $this->assertEquals('foo', $users->archiveUser(''));
+    }
+
+    public function testDeleteUser()
+    {
+        $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
+        $stub->method('delete')->willReturn('foo');
+
+        $users = new IntercomUsers($stub);
+        $this->assertEquals('foo', $users->deleteUser(''));
+    }
+
+    public function testPermanentlyDeleteUser()
+    {
+        $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
+        $stub->method('post')->willReturn('foo');
+
+        $users = new IntercomUsers($stub);
+        $this->assertEquals('foo', $users->permanentlyDeleteUser(''));
+    }
 }