From fdc94628290553094b33b6fb60be5f88162cee12 Mon Sep 17 00:00:00 2001
From: Oliver Vollborn <oliver.vollborn@dreid.de>
Date: Mon, 16 Sep 2024 14:38:15 +0200
Subject: [PATCH] Add query warehouses & storage locations

---
 src/Enums/Permission.php                      |  6 +++
 .../StorageLocationDto.php                    | 35 ++++++++++++++
 .../DataTransferObjects/WarehouseDto.php      | 33 +++++++++++++
 .../Requests/QueryStorageLocationsRequest.php | 12 +++++
 .../Requests/QueryWarehousesRequest.php       | 12 +++++
 .../QueryStorageLocationsResponse.php         | 17 +++++++
 .../Responses/QueryWarehousesResponse.php     | 17 +++++++
 .../Warehouse/StorageLocationRepository.php   | 46 ++++++++++++++++++
 src/Modules/Warehouse/WarehouseRepository.php | 47 +++++++++++++++++++
 src/Services/DataTransferObjectService.php    |  2 +-
 10 files changed, 226 insertions(+), 1 deletion(-)
 create mode 100644 src/Modules/Warehouse/DataTransferObjects/StorageLocationDto.php
 create mode 100644 src/Modules/Warehouse/DataTransferObjects/WarehouseDto.php
 create mode 100644 src/Modules/Warehouse/Requests/QueryStorageLocationsRequest.php
 create mode 100644 src/Modules/Warehouse/Requests/QueryWarehousesRequest.php
 create mode 100644 src/Modules/Warehouse/Responses/QueryStorageLocationsResponse.php
 create mode 100644 src/Modules/Warehouse/Responses/QueryWarehousesResponse.php
 create mode 100644 src/Modules/Warehouse/StorageLocationRepository.php
 create mode 100644 src/Modules/Warehouse/WarehouseRepository.php

diff --git a/src/Enums/Permission.php b/src/Enums/Permission.php
index dcd9c42..dce2943 100644
--- a/src/Enums/Permission.php
+++ b/src/Enums/Permission.php
@@ -14,6 +14,12 @@ enum Permission: string
     // Shipping Methods
     case QueryShippingMethods = 'shippingmethod.queryshippingmethods';
 
+    // Warehouses
+    case QueryWarehouses = 'warehouse.querywarehouses';
+
+    // Storage Locations
+    case QueryStorageLocations = 'warehouse.querystoragelocations';
+
     // Suppliers
     case QuerySuppliers = 'supplier.querysuppliers';
 
diff --git a/src/Modules/Warehouse/DataTransferObjects/StorageLocationDto.php b/src/Modules/Warehouse/DataTransferObjects/StorageLocationDto.php
new file mode 100644
index 0000000..4f0d39f
--- /dev/null
+++ b/src/Modules/Warehouse/DataTransferObjects/StorageLocationDto.php
@@ -0,0 +1,35 @@
+<?php
+
+namespace DREID\LaravelJtlApi\Modules\Warehouse\DataTransferObjects;
+
+use DREID\LaravelJtlApi\Services\DataTransferObjectService;
+
+readonly class StorageLocationDto
+{
+    public function __construct(
+        public int $id,
+        public int $warehouseId,
+        public string $name,
+        public ?int $sortNumber,
+        public ?int $priority,
+        public bool $lockForShipment,
+        public bool $lockForAvailability,
+        public ?string $comment,
+    ) {}
+
+    public static function fromResponse(array $data): static
+    {
+        $service = app(DataTransferObjectService::class);
+
+        return new self(
+            $data['Id'],
+            $data['WarehouseId'],
+            $data['Name'],
+            $service->getArrayValue($data, 'SortNumber'),
+            $service->getArrayValue($data, 'Priority'),
+            $service->getArrayValue($data, 'LockForShipment'),
+            $service->getArrayValue($data, 'LockForAvailability'),
+            $service->getArrayValue($data, 'Comment'),
+        );
+    }
+}
diff --git a/src/Modules/Warehouse/DataTransferObjects/WarehouseDto.php b/src/Modules/Warehouse/DataTransferObjects/WarehouseDto.php
new file mode 100644
index 0000000..7cb8efa
--- /dev/null
+++ b/src/Modules/Warehouse/DataTransferObjects/WarehouseDto.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace DREID\LaravelJtlApi\Modules\Warehouse\DataTransferObjects;
+
+readonly class WarehouseDto
+{
+    public function __construct(
+        public int $id,
+        public string $name,
+        public ?string $code,
+        public ?string $description,
+        public ?int $priority,
+        public ?int $companyId,
+        public bool $lockForShipment,
+        public bool $lockForAvailability,
+        public bool $isActive,
+    ) {}
+
+    public static function fromResponse(array $data): static
+    {
+        return new self(
+            $data['Id'],
+            $data['Name'],
+            $data['Code'] ?? null,
+            $data['Description'] ?? null,
+            $data['Priority'] ?? null,
+            $data['CompanyId'] ?? null,
+            $data['LockForShipment'],
+            $data['LockForAvailability'],
+            $data['IsActive'],
+        );
+    }
+}
diff --git a/src/Modules/Warehouse/Requests/QueryStorageLocationsRequest.php b/src/Modules/Warehouse/Requests/QueryStorageLocationsRequest.php
new file mode 100644
index 0000000..a0e3055
--- /dev/null
+++ b/src/Modules/Warehouse/Requests/QueryStorageLocationsRequest.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace DREID\LaravelJtlApi\Modules\Warehouse\Requests;
+
+readonly class QueryStorageLocationsRequest
+{
+    public function __construct(
+        public int $warehouseId,
+        public ?int $pageNumber = null,
+        public ?int $pageSize = null,
+    ) {}
+}
diff --git a/src/Modules/Warehouse/Requests/QueryWarehousesRequest.php b/src/Modules/Warehouse/Requests/QueryWarehousesRequest.php
new file mode 100644
index 0000000..13fed7e
--- /dev/null
+++ b/src/Modules/Warehouse/Requests/QueryWarehousesRequest.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace DREID\LaravelJtlApi\Modules\Warehouse\Requests;
+
+readonly class QueryWarehousesRequest
+{
+    public function __construct(
+        public ?int $pageNumber = null,
+        public ?int $pageSize = null,
+        public ?bool $isActive = null,
+    ) {}
+}
diff --git a/src/Modules/Warehouse/Responses/QueryStorageLocationsResponse.php b/src/Modules/Warehouse/Responses/QueryStorageLocationsResponse.php
new file mode 100644
index 0000000..455b389
--- /dev/null
+++ b/src/Modules/Warehouse/Responses/QueryStorageLocationsResponse.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace DREID\LaravelJtlApi\Modules\Warehouse\Responses;
+
+use DREID\LaravelJtlApi\ApiResponse;
+use DREID\LaravelJtlApi\Modules\Warehouse\DataTransferObjects\StorageLocationDto;
+use DREID\LaravelJtlApi\PaginatedResponse;
+
+readonly class QueryStorageLocationsResponse extends PaginatedResponse
+{
+    public function __construct(ApiResponse $response)
+    {
+        parent::__construct($response, array_map(static function ($item) {
+            return StorageLocationDto::fromResponse($item);
+        }, $response->json['Items']));
+    }
+}
diff --git a/src/Modules/Warehouse/Responses/QueryWarehousesResponse.php b/src/Modules/Warehouse/Responses/QueryWarehousesResponse.php
new file mode 100644
index 0000000..c38e6a5
--- /dev/null
+++ b/src/Modules/Warehouse/Responses/QueryWarehousesResponse.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace DREID\LaravelJtlApi\Modules\Warehouse\Responses;
+
+use DREID\LaravelJtlApi\ApiResponse;
+use DREID\LaravelJtlApi\Modules\Warehouse\DataTransferObjects\WarehouseDto;
+use DREID\LaravelJtlApi\PaginatedResponse;
+
+readonly class QueryWarehousesResponse extends PaginatedResponse
+{
+    public function __construct(ApiResponse $response)
+    {
+        parent::__construct($response, array_map(static function ($item) {
+            return WarehouseDto::fromResponse($item);
+        }, $response->json['Items']));
+    }
+}
diff --git a/src/Modules/Warehouse/StorageLocationRepository.php b/src/Modules/Warehouse/StorageLocationRepository.php
new file mode 100644
index 0000000..6000762
--- /dev/null
+++ b/src/Modules/Warehouse/StorageLocationRepository.php
@@ -0,0 +1,46 @@
+<?php
+
+namespace DREID\LaravelJtlApi\Modules\Warehouse;
+
+use DREID\LaravelJtlApi\Enums\Permission;
+use DREID\LaravelJtlApi\Exceptions\ConnectionException;
+use DREID\LaravelJtlApi\Exceptions\MissingApiKeyException;
+use DREID\LaravelJtlApi\Exceptions\MissingLicenseException;
+use DREID\LaravelJtlApi\Exceptions\MissingPermissionException;
+use DREID\LaravelJtlApi\Exceptions\UnauthorizedException;
+use DREID\LaravelJtlApi\Exceptions\UnhandledResponseException;
+use DREID\LaravelJtlApi\Modules\Warehouse\Requests\QueryStorageLocationsRequest;
+use DREID\LaravelJtlApi\Modules\Warehouse\Responses\QueryStorageLocationsResponse;
+use DREID\LaravelJtlApi\Repository;
+
+class StorageLocationRepository extends Repository
+{
+    /**
+     * @throws MissingApiKeyException
+     * @throws MissingLicenseException
+     * @throws MissingPermissionException
+     * @throws UnauthorizedException
+     * @throws UnhandledResponseException
+     * @throws ConnectionException
+     */
+    public function queryStorageLocations(QueryStorageLocationsRequest $request): QueryStorageLocationsResponse
+    {
+        $permissions = [Permission::AllRead, Permission::QueryStorageLocations];
+
+        if (!Permission::allowsOneOf($permissions)) {
+            throw MissingPermissionException::oneOf($permissions);
+        }
+
+        $response = $this->get('/v1/warehouses/' . $request->warehouseId . '/storagelocations', [
+            'pageNumber' => $request->pageNumber,
+            'pageSize'   => $request->pageSize,
+        ]);
+
+        if ($response->wasSuccessful) {
+            return new QueryStorageLocationsResponse($response);
+        }
+
+        $this->throwExceptionsIfPossible($response);
+        throw new UnhandledResponseException($response);
+    }
+}
diff --git a/src/Modules/Warehouse/WarehouseRepository.php b/src/Modules/Warehouse/WarehouseRepository.php
new file mode 100644
index 0000000..c5ff8dc
--- /dev/null
+++ b/src/Modules/Warehouse/WarehouseRepository.php
@@ -0,0 +1,47 @@
+<?php
+
+namespace DREID\LaravelJtlApi\Modules\Warehouse;
+
+use DREID\LaravelJtlApi\Enums\Permission;
+use DREID\LaravelJtlApi\Exceptions\ConnectionException;
+use DREID\LaravelJtlApi\Exceptions\MissingApiKeyException;
+use DREID\LaravelJtlApi\Exceptions\MissingLicenseException;
+use DREID\LaravelJtlApi\Exceptions\MissingPermissionException;
+use DREID\LaravelJtlApi\Exceptions\UnauthorizedException;
+use DREID\LaravelJtlApi\Exceptions\UnhandledResponseException;
+use DREID\LaravelJtlApi\Modules\Warehouse\Requests\QueryWarehousesRequest;
+use DREID\LaravelJtlApi\Modules\Warehouse\Responses\QueryWarehousesResponse;
+use DREID\LaravelJtlApi\Repository;
+
+class WarehouseRepository extends Repository
+{
+    /**
+     * @throws MissingApiKeyException
+     * @throws MissingLicenseException
+     * @throws MissingPermissionException
+     * @throws UnauthorizedException
+     * @throws UnhandledResponseException
+     * @throws ConnectionException
+     */
+    public function queryWarehouses(QueryWarehousesRequest $request): QueryWarehousesResponse
+    {
+        $permissions = [Permission::AllRead, Permission::QueryWarehouses];
+
+        if (!Permission::allowsOneOf($permissions)) {
+            throw MissingPermissionException::oneOf($permissions);
+        }
+
+        $response = $this->get('/v1/warehouses', [
+            'isActive'   => $request->isActive,
+            'pageNumber' => $request->pageNumber,
+            'pageSize'   => $request->pageSize,
+        ]);
+
+        if ($response->wasSuccessful) {
+            return new QueryWarehousesResponse($response);
+        }
+
+        $this->throwExceptionsIfPossible($response);
+        throw new UnhandledResponseException($response);
+    }
+}
diff --git a/src/Services/DataTransferObjectService.php b/src/Services/DataTransferObjectService.php
index 100387d..8f45b37 100644
--- a/src/Services/DataTransferObjectService.php
+++ b/src/Services/DataTransferObjectService.php
@@ -12,7 +12,7 @@ public function getArrayValue(array $array, string $key): mixed
 
         $value = $array[$key];
 
-        if (is_array($value)) {
+        if (is_array($value) || is_bool($value)) {
             return $value;
         }