Add support for listing users of a company (Fixes: #285) (#287)

* Add support for listing users of a company

* Remove unneeded method and add to readme

* Remove unneeded test

Author: Timothy Lim

README.md

@@ -304,6 +304,13 @@ $client->companies->getCompanies([]);
 
 /** Get a company by ID */
 $client->companies->getCompany("531ee472cce572a6ec000006");
+
+/** List users belonging to a company by ID */
+$client->companies->getCompanyUsers("531ee472cce572a6ec000006");
+
+/** List users belonging to a company by company_id */
+$client->companies->getCompanies(["type" => "user", "company_id" => "3"]);
+
 ```
 
 ## Admins

src/IntercomCompanies.php

@@ -77,6 +77,22 @@ public function getCompany($id, $options = [])
         return $this->client->get($path, $options);
     }
 
+
+    /**
+     * Returns a list of Users belonging to a single Company based on the Intercom ID.
+     *
+     * @see    https://developers.intercom.com/reference#list-company-users
+     * @param  string $id
+     * @param  array  $options
+     * @return stdClass
+     * @throws Exception
+     */
+    public function getCompanyUsers($id, $options = [])
+    {
+        $path = $this->companyUsersPath($id);
+        return $this->client->get($path, $options);
+    }
+
     /**
      * @param string $id
      * @return string
@@ -85,4 +101,13 @@ public function companyPath($id)
     {
         return 'companies/' . $id;
     }
+
+    /**
+     * @param string $id
+     * @return string
+     */
+    public function companyUsersPath($id)
+    {
+        return 'companies/' . $id . '/users';
+    }
 }

test/IntercomCompaniesTest.php

@@ -49,4 +49,20 @@ public function testCompanyGetById()
         $users = new IntercomCompanies($stub);
         $this->assertEquals('foo', $users->getCompany("foo"));
     }
+
+    public function testCompanyGetUsers()
+    {
+        $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
+        $stub->method('get')->willReturn('foo');
+
+        $companies = new IntercomCompanies($stub);
+        $this->assertEquals('foo', $companies->getCompanyUsers("foo"));
+    }
+
+    public function testCompanyUsersPath()
+    {
+        $stub = $this->getMockBuilder('Intercom\IntercomClient')->disableOriginalConstructor()->getMock();
+        $users = new IntercomCompanies($stub);
+        $this->assertEquals('companies/foo/users', $users->companyUsersPath("foo"));
+    }
 }