Add stock endpoint

Author: loevgaard

src/Client/Client.php

@@ -19,6 +19,8 @@
 use Setono\PeakWMS\Client\Endpoint\ProductEndpointInterface;
 use Setono\PeakWMS\Client\Endpoint\SalesOrderEndpoint;
 use Setono\PeakWMS\Client\Endpoint\SalesOrderEndpointInterface;
+use Setono\PeakWMS\Client\Endpoint\StockEndpoint;
+use Setono\PeakWMS\Client\Endpoint\StockEndpointInterface;
 use Setono\PeakWMS\Client\Endpoint\WebhookEndpoint;
 use Setono\PeakWMS\Client\Endpoint\WebhookEndpointInterface;
 use Setono\PeakWMS\Exception\InternalServerErrorException;
@@ -39,6 +41,8 @@ final class Client implements ClientInterface, LoggerAwareInterface
 
     private ?SalesOrderEndpointInterface $salesOrderEndpoint = null;
 
+    private ?StockEndpointInterface $stockEndpoint = null;
+
     private ?WebhookEndpointInterface $webhookEndpoint = null;
 
     private ?HttpClientInterface $httpClient = null;
@@ -164,6 +168,16 @@ public function salesOrder(): SalesOrderEndpointInterface
         return $this->salesOrderEndpoint;
     }
 
+    public function stock(): StockEndpointInterface
+    {
+        if (null === $this->stockEndpoint) {
+            $this->stockEndpoint = new StockEndpoint($this, $this->getMapperBuilder(), 'stock');
+            $this->stockEndpoint->setLogger($this->logger);
+        }
+
+        return $this->stockEndpoint;
+    }
+
     public function webhook(): WebhookEndpointInterface
     {
         if (null === $this->webhookEndpoint) {

src/Client/ClientInterface.php

@@ -9,6 +9,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Setono\PeakWMS\Client\Endpoint\ProductEndpointInterface;
 use Setono\PeakWMS\Client\Endpoint\SalesOrderEndpointInterface;
+use Setono\PeakWMS\Client\Endpoint\StockEndpointInterface;
 use Setono\PeakWMS\Client\Endpoint\WebhookEndpointInterface;
 use Setono\PeakWMS\Exception\InternalServerErrorException;
 use Setono\PeakWMS\Exception\NotFoundException;
@@ -60,5 +61,7 @@ public function product(): ProductEndpointInterface;
 
     public function salesOrder(): SalesOrderEndpointInterface;
 
+    public function stock(): StockEndpointInterface;
+
     public function webhook(): WebhookEndpointInterface;
 }

src/Client/Endpoint/Endpoint.php

@@ -15,7 +15,6 @@
 
 /**
  * @template T of AbstractDataTransferObject
- *
  * @implements EndpointInterface<T>
  */
 abstract class Endpoint implements EndpointInterface, LoggerAwareInterface

src/Client/Endpoint/StockEndpoint.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\PeakWMS\Client\Endpoint;
+
+use Setono\PeakWMS\DataTransferObject\PaginatedCollection;
+use Setono\PeakWMS\DataTransferObject\Stock\Stock;
+use Setono\PeakWMS\Request\Query\KeySetPageQuery;
+
+/**
+ * @extends Endpoint<Stock>
+ */
+final class StockEndpoint extends Endpoint implements StockEndpointInterface
+{
+    /**
+     * @return PaginatedCollection<Stock>
+     */
+    public function getPage(KeySetPageQuery $query = null): PaginatedCollection
+    {
+        $query ??= KeySetPageQuery::create();
+
+        /** @var class-string<PaginatedCollection<Stock>> $signature */
+        $signature = sprintf('%s<%s>', PaginatedCollection::class, self::getDataClass());
+
+        return $this
+            ->mapperBuilder
+            ->mapper()
+            ->map(
+                $signature,
+                $this->createSource(
+                    $this->client->get(sprintf('%s/keySet', $this->endpoint), $query),
+                )->map(['data' => 'items']),
+            );
+    }
+
+    /**
+     * @return \Generator<Stock>
+     */
+    public function iterate(KeySetPageQuery $query = null): \Generator
+    {
+        $query ??= KeySetPageQuery::create();
+
+        do {
+            $collection = $this->getPage($query);
+
+            $lastId = null;
+
+            foreach ($collection as $item) {
+                yield $item;
+                $lastId = $item->id;
+            }
+
+            if (null !== $lastId) {
+                $query->setLastId($lastId);
+            }
+        } while (!$collection->empty());
+    }
+
+    protected static function getDataClass(): string
+    {
+        return Stock::class;
+    }
+}

src/Client/Endpoint/StockEndpointInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\PeakWMS\Client\Endpoint;
+
+use Setono\PeakWMS\DataTransferObject\PaginatedCollection;
+use Setono\PeakWMS\DataTransferObject\Stock\Stock;
+use Setono\PeakWMS\Request\Query\KeySetPageQuery;
+
+/**
+ * @extends EndpointInterface<Stock>
+ */
+interface StockEndpointInterface extends EndpointInterface
+{
+    /**
+     * @return PaginatedCollection<Stock>
+     */
+    public function getPage(KeySetPageQuery $query = null): PaginatedCollection;
+
+    /**
+     * @return iterable<Stock>
+     */
+    public function iterate(KeySetPageQuery $query = null): iterable;
+}

src/DataTransferObject/Collection.php

@@ -6,7 +6,6 @@
 
 /**
  * @template T of AbstractDataTransferObject
- *
  * @implements \IteratorAggregate<int, T>
  * @implements \ArrayAccess<int, T>
  */

src/DataTransferObject/PaginatedCollection.php

@@ -6,7 +6,6 @@
 
 /**
  * @template T of AbstractDataTransferObject
- *
  * @extends Collection<T>
  */
 final class PaginatedCollection extends Collection

src/DataTransferObject/Stock/Stock.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\PeakWMS\DataTransferObject\Stock;
+
+use Setono\PeakWMS\DataTransferObject\AbstractDataTransferObject;
+
+final class Stock extends AbstractDataTransferObject
+{
+    public function __construct(
+        public readonly ?int $id = null,
+        public readonly ?string $productId = null,
+        public readonly ?string $variantId = null,
+        public readonly ?string $itemNumber = null,
+        public readonly ?int $quantity = null,
+        public readonly ?int $reservedQuantity = null,
+    ) {
+    }
+}

src/Request/Query/KeySetPageQuery.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\PeakWMS\Request\Query;
+
+final class KeySetPageQuery extends Query
+{
+    /**
+     * @param int|null $lastId The last id from the previous page
+     * @param int $pageSize The maximum page size is 250
+     */
+    public static function create(int $lastId = null, int $pageSize = 250): self
+    {
+        return new self(array_filter([
+            'LastId' => $lastId,
+            'PageSize' => $pageSize,
+        ]));
+    }
+
+    public function setLastId(int $lastId): self
+    {
+        $this->parameters['LastId'] = $lastId;
+
+        return $this;
+    }
+}