add type declarations to all endpoints

src/Endpoints/BalanceEndpoint.php

@@ -8,7 +8,7 @@
 use Mollie\Api\Resources\BaseCollection;
 use Mollie\Api\Resources\LazyCollection;
 
-class BalanceEndpoint extends CollectionEndpointAbstract
+class BalanceEndpoint extends CollectionRestEndpoint
 {
     const string RESOURCE_ID_PREFIX = 'bal_';
 

src/Endpoints/BalanceReportEndpoint.php

@@ -8,7 +8,7 @@
 use Mollie\Api\Resources\BalanceReport;
 use Mollie\Api\Resources\ResourceFactory;
 
-class BalanceReportEndpoint extends EndpointAbstract
+class BalanceReportEndpoint extends RestEndpoint
 {
     protected string $resourcePath = "balances_report";
 

src/Endpoints/BalanceTransactionEndpoint.php

@@ -9,7 +9,7 @@
 use Mollie\Api\Resources\BalanceTransactionCollection;
 use Mollie\Api\Resources\LazyCollection;
 
-class BalanceTransactionEndpoint extends CollectionEndpointAbstract
+class BalanceTransactionEndpoint extends CollectionRestEndpoint
 {
     const string RESOURCE_ID_PREFIX = 'baltr_';
 

src/Endpoints/BaseEndpoint.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace Mollie\Api\Endpoints;
+
+use Mollie\Api\Contracts\SingleResourceEndpoint;
+use Mollie\Api\Exceptions\ApiException;
+use Mollie\Api\MollieApiClient;
+
+abstract class BaseEndpoint
+{
+    public const REST_CREATE = MollieApiClient::HTTP_POST;
+    public const REST_UPDATE = MollieApiClient::HTTP_PATCH;
+    public const REST_READ = MollieApiClient::HTTP_GET;
+    public const REST_LIST = MollieApiClient::HTTP_GET;
+    public const REST_DELETE = MollieApiClient::HTTP_DELETE;
+
+    protected MollieApiClient $client;
+
+    protected string $resourcePath;
+
+    protected ?string $parentId;
+
+    public function __construct(MollieApiClient $api)
+    {
+        $this->client = $api;
+    }
+
+    /**
+     * @param array $filters
+     * @return string
+     */
+    protected function buildQueryString(array $filters): string
+    {
+        if (empty($filters)) {
+            return "";
+        }
+
+        foreach ($filters as $key => $value) {
+            if ($value === true) {
+                $filters[$key] = "true";
+            }
+
+            if ($value === false) {
+                $filters[$key] = "false";
+            }
+        }
+
+        return "?" . http_build_query($filters, "", "&");
+    }
+
+    /**
+     * @return string
+     * @throws ApiException
+     */
+    public function getResourcePath(): string
+    {
+        if (strpos($this->resourcePath, "_") !== false) {
+            [$parentResource, $childResource] = explode("_", $this->resourcePath, 2);
+
+            if (empty($this->parentId)) {
+                throw new ApiException("Subresource '{$this->resourcePath}' used without parent '$parentResource' ID.");
+            }
+
+            return "$parentResource/{$this->parentId}/$childResource";
+        }
+
+        return $this->resourcePath;
+    }
+
+    protected function getPathToSingleResource(string $id): string
+    {
+        if ($this instanceof SingleResourceEndpoint) {
+            return $this->getResourcePath();
+        }
+
+        return "{$this->getResourcePath()}/{$id}";
+    }
+
+    /**
+     * @param array $body
+     * @return null|string
+     */
+    protected function parseRequestBody(array $body): ?string
+    {
+        if (empty($body)) {
+            return null;
+        }
+
+        return @json_encode($body);
+    }
+}

src/Endpoints/ChargebackEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\ChargebackCollection;
 use Mollie\Api\Resources\LazyCollection;
 
-class ChargebackEndpoint extends CollectionEndpointAbstract
+class ChargebackEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "chargebacks";
 

src/Endpoints/ClientEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\ClientCollection;
 use Mollie\Api\Resources\LazyCollection;
 
-class ClientEndpoint extends CollectionEndpointAbstract
+class ClientEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "clients";
 

src/Endpoints/ClientLinkEndpoint.php

@@ -5,7 +5,7 @@
 use Mollie\Api\Exceptions\ApiException;
 use Mollie\Api\Resources\ClientLink;
 
-class ClientLinkEndpoint extends EndpointAbstract
+class ClientLinkEndpoint extends RestEndpoint
 {
     protected string $resourcePath = "client-links";
 

src/Endpoints/CollectionEndpointAbstract.php

@@ -8,7 +8,7 @@
 use Mollie\Api\Resources\LazyCollection;
 use Mollie\Api\Resources\ResourceFactory;
 
-abstract class CollectionEndpointAbstract extends EndpointAbstract
+abstract class CollectionRestEndpoint extends RestEndpoint
 {
     /**
      * Get a collection of objects from the REST API.
@@ -22,20 +22,16 @@ abstract class CollectionEndpointAbstract extends EndpointAbstract
      */
     protected function rest_list(?string $from = null, ?int $limit = null, array $filters = []): BaseCollection
     {
-        $filters = array_merge(["from" => $from, "limit" => $limit], $filters);
+        $apiPath = $this->getResourcePath() . $this->buildQueryString(
+            $this->getMergedFilters($filters, $from, $limit)
+        );
 
-        $apiPath = $this->getResourcePath() . $this->buildQueryString($filters);
+        $result = $this->client->performHttpCall(
+            self::REST_LIST,
+            $apiPath
+        );
 
-        $result = $this->client->performHttpCall(self::REST_LIST, $apiPath);
-
-        /** @var BaseCollection $collection */
-        $collection = $this->getResourceCollectionObject($result->count, $result->_links);
-
-        foreach ($result->_embedded->{$collection->getCollectionResourceName()} as $dataResult) {
-            $collection[] = ResourceFactory::createFromApiResult($dataResult, $this->getResourceObject());
-        }
-
-        return $collection;
+        return $this->createCollectionFromResult($result);
     }
 
     /**
@@ -59,6 +55,23 @@ protected function rest_iterator(?string $from = null, ?int $limit = null, array
         return $page->getAutoIterator($iterateBackwards);
     }
 
+    protected function getMergedFilters(array $filters = [], ?string $from = null, ?int $limit = null): array
+    {
+        return array_merge(["from" => $from, "limit" => $limit], $filters);
+    }
+
+    protected function createCollectionFromResult(object $result): BaseCollection
+    {
+        /** @var BaseCollection $collection */
+        $collection = $this->getResourceCollectionObject($result->count, $result->_links);
+
+        foreach ($result->_embedded->{$collection->getCollectionResourceName()} as $dataResult) {
+            $collection[] = ResourceFactory::createFromApiResult($dataResult, $this->getResourceObject());
+        }
+
+        return $collection;
+    }
+
     /**
      * Get the collection object that is used by this API endpoint. Every API endpoint uses one type of collection object.
      *

src/Endpoints/CustomerEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\CustomerCollection;
 use Mollie\Api\Resources\LazyCollection;
 
-class CustomerEndpoint extends CollectionEndpointAbstract
+class CustomerEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "customers";
 

src/Endpoints/CustomerPaymentsEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\Payment;
 use Mollie\Api\Resources\PaymentCollection;
 
-class CustomerPaymentsEndpoint extends CollectionEndpointAbstract
+class CustomerPaymentsEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "customers_payments";
 

src/Endpoints/InvoiceEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\InvoiceCollection;
 use Mollie\Api\Resources\LazyCollection;
 
-class InvoiceEndpoint extends CollectionEndpointAbstract
+class InvoiceEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "invoices";
 

src/Endpoints/MandateEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\Mandate;
 use Mollie\Api\Resources\MandateCollection;
 
-class MandateEndpoint extends CollectionEndpointAbstract
+class MandateEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "customers_mandates";
 
@@ -92,7 +92,7 @@ public function getForId(string $customerId, $mandateId, array $parameters = [])
      * @return MandateCollection
      * @throws \Mollie\Api\Exceptions\ApiException
      */
-    public function listFor(Customer $customer, $from = null, $limit = null, array $parameters = []): MandateCollection
+    public function listFor(Customer $customer, ?string $from = null, ?int $limit = null, array $parameters = []): MandateCollection
     {
         return $this->listForId($customer->id, $from, $limit, $parameters);
     }
@@ -127,7 +127,7 @@ public function iteratorFor(
      * @return MandateCollection
      * @throws \Mollie\Api\Exceptions\ApiException
      */
-    public function listForId(string $customerId, string $from = null, int $limit = null, array $parameters = []): MandateCollection
+    public function listForId(string $customerId, ?string $from = null, ?int $limit = null, array $parameters = []): MandateCollection
     {
         $this->parentId = $customerId;
 

src/Endpoints/MethodEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\MethodCollection;
 use Mollie\Api\Resources\ResourceFactory;
 
-class MethodEndpoint extends CollectionEndpointAbstract
+class MethodEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "methods";
 

src/Endpoints/OnboardingEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Exceptions\ApiException;
 use Mollie\Api\Resources\Onboarding;
 
-class OnboardingEndpoint extends EndpointAbstract implements SingleResourceEndpoint
+class OnboardingEndpoint extends RestEndpoint implements SingleResourceEndpoint
 {
     protected string $resourcePath = "onboarding/me";
 

src/Endpoints/OrderEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\Order;
 use Mollie\Api\Resources\OrderCollection;
 
-class OrderEndpoint extends CollectionEndpointAbstract
+class OrderEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "orders";
 

src/Endpoints/OrderLineEndpoint.php

@@ -8,7 +8,7 @@
 use Mollie\Api\Resources\OrderLineCollection;
 use Mollie\Api\Resources\ResourceFactory;
 
-class OrderLineEndpoint extends CollectionEndpointAbstract
+class OrderLineEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "orders_lines";
 

src/Endpoints/OrderPaymentEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Payment;
 use Mollie\Api\Resources\PaymentCollection;
 
-class OrderPaymentEndpoint extends CollectionEndpointAbstract
+class OrderPaymentEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "orders_payments";
 

src/Endpoints/OrderRefundEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Resources\Refund;
 use Mollie\Api\Resources\RefundCollection;
 
-class OrderRefundEndpoint extends CollectionEndpointAbstract
+class OrderRefundEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "orders_refunds";
 

src/Endpoints/OrganizationEndpoint.php

@@ -5,7 +5,7 @@
 use Mollie\Api\Exceptions\ApiException;
 use Mollie\Api\Resources\Organization;
 
-class OrganizationEndpoint extends EndpointAbstract
+class OrganizationEndpoint extends RestEndpoint
 {
     protected string $resourcePath = "organizations";
 

src/Endpoints/OrganizationPartnerEndpoint.php

@@ -6,7 +6,7 @@
 use Mollie\Api\Exceptions\ApiException;
 use Mollie\Api\Resources\Partner;
 
-class OrganizationPartnerEndpoint extends EndpointAbstract implements SingleResourceEndpoint
+class OrganizationPartnerEndpoint extends RestEndpoint implements SingleResourceEndpoint
 {
     protected string $resourcePath = "organizations/me/partner";
 

src/Endpoints/PaymentCaptureEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\LazyCollection;
 use Mollie\Api\Resources\Payment;
 
-class PaymentCaptureEndpoint extends CollectionEndpointAbstract
+class PaymentCaptureEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "payments_captures";
 

src/Endpoints/PaymentChargebackEndpoint.php

@@ -7,7 +7,7 @@
 use Mollie\Api\Resources\LazyCollection;
 use Mollie\Api\Resources\Payment;
 
-class PaymentChargebackEndpoint extends CollectionEndpointAbstract
+class PaymentChargebackEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "payments_chargebacks";
 

src/Endpoints/PaymentEndpoint.php

@@ -7,9 +7,8 @@
 use Mollie\Api\Resources\Payment;
 use Mollie\Api\Resources\PaymentCollection;
 use Mollie\Api\Resources\Refund;
-use Mollie\Api\Resources\ResourceFactory;
 
-class PaymentEndpoint extends CollectionEndpointAbstract
+class PaymentEndpoint extends CollectionRestEndpoint
 {
     protected string $resourcePath = "payments";
 
@@ -160,19 +159,10 @@ public function iterator(?string $from = null, ?int $limit = null, array $parame
      *
      * @return Refund
      * @throws ApiException
-     * @todo: Refactor
      */
     public function refund(Payment $payment, $data = []): Refund
     {
-        $resource = "{$this->getResourcePath()}/" . urlencode($payment->id) . "/refunds";
-
-        $body = null;
-        if (($data === null ? 0 : count($data)) > 0) {
-            $body = json_encode($data);
-        }
-
-        $result = $this->client->performHttpCall(self::REST_CREATE, $resource, $body);
-
-        return ResourceFactory::createFromApiResult($result, new Refund($this->client));
+        return (new PaymentRefundEndpoint($this->client))
+            ->createFor($payment, $data);
     }
 }