pagination client can be sorted (expect contact)

Author: Sysix

README.md

@@ -55,22 +55,18 @@ $api = new \Sysix\LexOffice\Api($apiKey, $httpClient);
 ### Contact Endpoint
 ```php
 
-// get a page
 /** @var \Sysix\LexOffice\Api $api */
 $client = $api->contact();
 
 // filters
 $client->size = 100;
-$client->sortDirection = 'ASC';
-$client->sortProperty = 'name';
 $client->number = 123456;
 $client->customer = true;
 $client->vendor = false;
 
 // get a page
 $response = $client->getPage(0);    
 
-
 // other methods
 $response = $client->get($entityId);
 $response = $client->create($data);
@@ -162,16 +158,18 @@ $response = $api->profile()->get();
 ### Recurring Templates Endpoint
 ```php
 
-// get single entitiy
-$response = $api->recurringTemplate()->get($entityId);
-
-// use pagination
 $client = $api->recurringTemplate();
-$client->size = 100;
 
+// filters
+$client->size = 100;
+$client->sortDirection = 'DESC';
+$client->sortColumn = 'updatedDate';
 
 // get a page
 $response = $client->getPage(0);
+
+// other methods
+$response = $api->recurringTemplate()->get($entityId);
 ```
 
 

src/Clients/Contact.php

@@ -15,9 +15,6 @@ class Contact extends PaginationClient
 
     protected string $resource = 'contacts';
 
-    public string $sortDirection = 'ASC';
-
-    public string $sortProperty = 'name';
 
     public ?int $number = null;
 
@@ -27,8 +24,6 @@ class Contact extends PaginationClient
 
     protected function buildQueryParams(array $params): string
     {
-        $params['direction'] = $this->sortDirection;
-        $params['property'] = $this->sortProperty;
         $params['number'] = $this->number;
         $params['customer'] = $this->customer;
         $params['vendor'] = $this->vendor;

src/Clients/RecurringTemplate.php

@@ -10,4 +10,6 @@ class RecurringTemplate extends PaginationClient
     use GetTrait;
 
     protected string $resource = 'recurring-templates';
+
+    public string $sortColumn = 'updatedDate';
 }

src/Clients/Traits/DocumentClientTrait.php

@@ -11,7 +11,8 @@ trait DocumentClientTrait
 {
     public function document(string $id, bool $asContent = false): ResponseInterface
     {
-        $response = $this->api->newRequest('GET', $this->resource . '/' . rawurlencode($id) . '/document')
+        $response = $this->api
+            ->newRequest('GET', $this->resource . '/' . rawurlencode($id) . '/document')
             ->getResponse();
 
         if ($asContent === false) {

src/Clients/VoucherList.php

@@ -10,13 +10,12 @@ class VoucherList extends PaginationClient
     protected string $resource = 'voucherlist';
 
     public string $sortColumn = 'voucherNumber';
-    public string $sortDirection = 'DESC';
 
     /** @var string[] $types */
-    public array $types = [];
+    public array $types;
 
     /** @var string[] $statuses */
-    public array $statuses = [];
+    public array $statuses;
 
     public ?bool $archived = null;
 
@@ -71,7 +70,6 @@ protected function buildQueryParams(array $params): string
     {
         $dateFormat = DateTimeInterface::ATOM;
 
-        $params['sort'] = $this->sortColumn . ',' . $this->sortDirection;
         $params['voucherType'] = implode(',', $this->types);
         $params['voucherStatus'] = implode(',', $this->statuses);
         $params['archived'] = $this->archived;

src/PaginationClient.php

@@ -9,6 +9,10 @@ abstract class PaginationClient extends BaseClient
 {
     public int $size = 100;
 
+    public string $sortColumn;
+    
+    public string $sortDirection = 'DESC';
+
     protected function generatePageUrl(int $page): string
     {
         return $this->resource . '?' . $this->buildQueryParams([
@@ -23,6 +27,11 @@ protected function buildQueryParams(array $params): string
     {
         $params['size'] = $this->size;
 
+        // contact endpoint can't be sorted but is a Pagination client
+        if (isset($this->sortColumn)) {
+            $params['sort'] = $this->sortColumn . ',' . $this->sortDirection;
+        }
+
         return http_build_query($params);
     }
 

tests/Clients/ContactTest.php

@@ -18,7 +18,7 @@ public function testGetPage(): void
 
         $this->assertEquals('GET', $api->request->getMethod());
         $this->assertEquals(
-            $api->apiUrl . '/v1/contacts?page=0&direction=ASC&property=name&size=100',
+            $api->apiUrl . '/v1/contacts?page=0&size=100',
             $api->request->getUri()->__toString()
         );
     }
@@ -34,7 +34,7 @@ public function testGetPageWithFilters(): void
         $client->getPage(0);
 
         $this->assertEquals(
-            $api->apiUrl . '/v1/contacts?page=0&direction=ASC&property=name&number=12345&customer=1&vendor=0&size=100',
+            $api->apiUrl . '/v1/contacts?page=0&number=12345&customer=1&vendor=0&size=100',
             $api->request->getUri()->__toString()
         );
     }

tests/Clients/RecurringTemplateTest.php

@@ -31,7 +31,7 @@ public function testGetPage(): void
 
         $this->assertEquals('GET', $api->request->getMethod());
         $this->assertEquals(
-            $api->apiUrl . '/v1/recurring-templates?page=0&size=100',
+            $api->apiUrl . '/v1/recurring-templates?page=0&size=100&sort=updatedDate%2CDESC',
             $api->request->getUri()->__toString()
         );
     }

tests/Clients/VoucherListTest.php

@@ -24,7 +24,7 @@ public function testGetPage(): void
 
         $this->assertEquals('GET', $api->request->getMethod());
         $this->assertEquals(
-            $api->apiUrl . '/v1/voucherlist?page=0&sort=voucherNumber%2CDESC&voucherType=invoice&voucherStatus=open&archived=1&size=100',
+            $api->apiUrl . '/v1/voucherlist?page=0&voucherType=invoice&voucherStatus=open&archived=1&size=100&sort=voucherNumber%2CDESC',
             $api->request->getUri()->__toString()
         );
     }
@@ -48,7 +48,7 @@ public function testGetAll(): void
 
         $this->assertEquals('GET', $api->request->getMethod());
         $this->assertEquals(
-            $api->apiUrl . '/v1/voucherlist?page=0&sort=voucherNumber%2CDESC&voucherType=invoice&voucherStatus=open&archived=1&size=100',
+            $api->apiUrl . '/v1/voucherlist?page=0&voucherType=invoice&voucherStatus=open&archived=1&size=100&sort=voucherNumber%2CDESC',
             $api->request->getUri()->__toString()
         );
     }