Merge pull request #197 from zendesk/jsmale/external_id

Whitelist external_id as an accepted query param
zendesk · Sep 4, 2015 · 04e31fb · 04e31fb
2 parents 6915c78 + 5a317ae
commit 04e31fb
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/src/Zendesk/API/Http.php b/src/Zendesk/API/Http.php
@@ -35,7 +35,7 @@ public static function prepareQueryParams(array $sideload = null, array $iterato
         // Next look for special collection iterators
         if (is_array($iterators)) {
             foreach ($iterators as $k => $v) {
-                if (in_array($k, ['per_page', 'page', 'sort_order', 'sort_by'])) {
+                if (in_array($k, ['per_page', 'page', 'sort_order', 'sort_by', 'external_id'])) {
                     $addParams[$k] = $v;
                 }
             }

diff --git a/tests/Zendesk/API/UnitTests/Core/UsersTest.php b/tests/Zendesk/API/UnitTests/Core/UsersTest.php
@@ -77,6 +77,17 @@ public function testSearch()
         }, 'users/search.json', 'GET', ['queryParams' => $queryParams]);
     }
 
+    /**
+     * Tests if the search enpoint can be called by the client and is passed the correct external_id
+     */
+    public function testSearchByExternalId()
+    {
+        $queryParams = ['external_id' => 'ext-1'];
+        $this->assertEndpointCalled(function () use ($queryParams) {
+            $this->client->users()->search($queryParams);
+        }, 'users/search.json', 'GET', ['queryParams' => $queryParams]);
+    }
+
     /*
      * Needs an existed User with specified query 'name' keyword to run this function
      */