AUT-2569: add limit and offset params to contactlist fetching endpoint

emartech · Mar 6, 2024 · 462405e · 462405e
1 parent b8d6f21
commit 462405e
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 4 deletions.
diff --git a/src/Suite/Api/ContactList.php b/src/Suite/Api/ContactList.php
@@ -119,10 +119,10 @@ public function getContactsOfList(int $customerId, int $contactListId, int $limi
         }
     }
 
-    public function getContactIdsInList(int $customerId, int $contactListId)
+    public function getContactIdsInList(int $customerId, int $contactListId, int $limit = null, int $offset = null)
     {
         try {
-            $response = $this->apiClient->get($this->endPoints->contactIdsInList($customerId, $contactListId));
+            $response = $this->apiClient->get($this->endPoints->contactIdsInList($customerId, $contactListId, $limit, $offset));
             return $response['data'] ?? [];
         } catch (Error $error) {
             throw new RequestFailed('Could not fetch contact ids: ' . $error->getMessage(), $error->getCode(), $error);

diff --git a/src/Suite/Api/ContactListEndPoints.php b/src/Suite/Api/ContactListEndPoints.php
@@ -44,9 +44,13 @@ public function contactsOfList(int $customerId, int $contactListId, int $limit,
         return $this->baseUrl($customerId) . "/{$contactListId}/contacts/?limit={$limit}&offset={$offset}";
     }
 
-    public function contactIdsInList(int $customerId, int $contactListId)
+    public function contactIdsInList(int $customerId, int $contactListId, int $limit = null, int $offset = null)
     {
-        return $this->baseUrl($customerId) . "/{$contactListId}/contactIds";
+        $result = $this->baseUrl($customerId) . "/{$contactListId}/contactIds";
+        if (null !== $limit && null !== $offset) {
+            $result .= "?\$top={$limit}&\$skiptoken={$offset}";
+        }
+        return $result;
     }
 
     public function deleteContactsFromList(int $customerId, int $contactListId): string

diff --git a/test/unit/Suite/Api/ContactListTest.php b/test/unit/Suite/Api/ContactListTest.php
@@ -254,6 +254,21 @@ public function getContactIdsInList_CalledWithProperUrl_ApiResponseConverted():
         $this->assertEquals($response, $result);
     }
 
+    /**
+     * @test
+     */
+    public function getContactIdsInList_CalledWithProperUrlAndParams_ApiResponseConverted(): void
+    {
+        $response = ['value' => [1, 2, 3], 'next' => null];
+        $this->apiClient
+            ->method('get')
+            ->with("api_base_url/$this->customerId/contactlist/$this->contactListId/contactIds?\$top=1&\$skiptoken=1")
+            ->willReturn($this->apiSuccess($response));
+
+        $result = $this->listService->getContactIdsInList($this->customerId, $this->contactListId, 1, 1);
+        $this->assertEquals($response, $result);
+    }
+
     /**
      * @test
      */