Add paginated voucher list (#49)

* Add paginated voucher list

* Fix PHPStan

* Fix PHPStan

Author: Diego Relyveld

src/Mappers/BasePaginatedMapper.php

@@ -0,0 +1,108 @@
+<?php
+
+namespace Piggy\Api\Mappers;
+
+abstract class BasePaginatedMapper
+{
+    /**
+     * @var mixed[]
+     */
+    public $data;
+
+    /**
+     * @var mixed[]
+     */
+    public $meta;
+
+    /**
+     * @param  mixed[]  $data
+     * @param  mixed[]  $meta
+     */
+    public function __construct(array $data, array $meta)
+    {
+        $this->data = $data;
+        $this->meta = $meta;
+    }
+
+    /**
+     * Get the mapped data
+     *
+     * @return mixed[]
+     */
+    abstract public function getData(): array;
+
+    /**
+     * @return mixed[]
+     */
+    public function getMeta(): array
+    {
+        return $this->meta;
+    }
+
+    /**
+     * Get the current page
+     */
+    public function getCurrentPage(): int
+    {
+        return $this->getMeta()['current_page'];
+    }
+
+
+    /**
+     * Get the starting item number
+     */
+    public function getFrom(): int
+    {
+        return $this->getMeta()['from'];
+    }
+
+    /**
+     * Get the last page
+     */
+    public function getLastPage(): int
+    {
+        return $this->getMeta()['last_page'];
+    }
+
+    /**
+     * Get the pagination links
+     *
+     * @return mixed[]
+     */
+    public function getLinks(): array
+    {
+        return $this->getMeta()['links'];
+    }
+
+    /**
+     * Get the current path
+     */
+    public function getPath(): string
+    {
+        return $this->getMeta()['path'];
+    }
+
+    /**
+     * Get the items per page count
+     */
+    public function getPerPage(): int
+    {
+        return $this->getMeta()['per_page'];
+    }
+
+    /**
+     * Get the ending item number
+     */
+    public function getTo(): int
+    {
+        return $this->getMeta()['to'];
+    }
+
+    /**
+     * Get the total count
+     */
+    public function getTotal(): int
+    {
+        return $this->getMeta()['total'];
+    }
+}

src/Mappers/Vouchers/PaginatedVouchersMapper.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Piggy\Api\Mappers\Vouchers;
+
+use Piggy\Api\Mappers\BasePaginatedMapper;
+use Piggy\Api\Models\Vouchers\Voucher;
+
+class PaginatedVouchersMapper extends BasePaginatedMapper
+{
+    /**
+     * Get the mapped vouchers
+     *
+     * @return Voucher[]
+     */
+    public function getData(): array
+    {
+        $mapper = new VoucherMapper();
+        $vouchers = [];
+
+        foreach ($this->data as $item) {
+            $vouchers[] = $mapper->map($item);
+        }
+
+        return $vouchers;
+    }
+}

src/Models/Vouchers/Voucher.php

@@ -8,6 +8,7 @@
 use Piggy\Api\Exceptions\MaintenanceModeException;
 use Piggy\Api\Exceptions\PiggyRequestException;
 use Piggy\Api\Models\Contacts\Contact;
+use Piggy\Api\Mappers\Vouchers\PaginatedVouchersMapper;
 use Piggy\Api\StaticMappers\Vouchers\VoucherLockMapper;
 use Piggy\Api\StaticMappers\Vouchers\VoucherMapper;
 use Piggy\Api\StaticMappers\Vouchers\VouchersMapper;
@@ -213,6 +214,24 @@ public static function list(array $params = []): array
         return VouchersMapper::map((array) $response->getData());
     }
 
+    /**
+     * @param  mixed[]  $params
+     *
+     * @throws MaintenanceModeException|GuzzleException|PiggyRequestException
+     */
+    public static function paginatedList(int $page = 1, int $limit = 30, array $params = []): PaginatedVouchersMapper
+    {
+        $response = ApiClient::get(
+            self::resourceUri,
+            array_merge($params, ['page' => $page, 'limit' => $limit])
+        );
+
+        return new PaginatedVouchersMapper(
+            (array) $response->getData(),
+            (array) $response->getMeta()
+        );
+    }
+
     /**
      * @param  mixed[]  $params
      *

src/Resources/Shared/Vouchers/BaseVouchersResource.php

@@ -4,6 +4,7 @@
 
 use DateTime;
 use Piggy\Api\Exceptions\PiggyRequestException;
+use Piggy\Api\Mappers\Vouchers\PaginatedVouchersMapper;
 use Piggy\Api\Mappers\Vouchers\VoucherLockMapper;
 use Piggy\Api\Mappers\Vouchers\VoucherMapper;
 use Piggy\Api\Mappers\Vouchers\VouchersMapper;
@@ -51,6 +52,25 @@ public function list(int $page = 1, int $limit = 30, ?string $promotionUuid = nu
         return $mapper->map((array) $response->getData());
     }
 
+    /**
+     * @throws PiggyRequestException
+     */
+    public function paginatedList(int $page = 1, int $limit = 30, ?string $promotionUuid = null, ?string $contactUuid = null, ?string $status = null): PaginatedVouchersMapper
+    {
+        $response = $this->client->get($this->resourceUri, [
+            'page' => $page,
+            'limit' => $limit,
+            'promotion_uuid' => $promotionUuid,
+            'contact_uuid' => $contactUuid,
+            'status' => $status,
+        ]);
+
+        return new PaginatedVouchersMapper(
+            (array) $response->getData(),
+            (array) $response->getMeta()
+        );
+    }
+
     /**
      * @throws PiggyRequestException
      */