Merge pull request #759 from mollie/v3-without-dedicated-payloads-and…

…-queries V3 without dedicated payloads and queries
mollie · Feb 5, 2025 · e32e1a2 · e32e1a2
2 parents 4065ae1 + dc8b59c
commit e32e1a2
Show file tree

Hide file tree

Showing 358 changed files with 6,671 additions and 4,426 deletions.
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -160,7 +160,7 @@ $client->payments->page();
 Two new collection methods were added which can be used to simplify interacting with collection resources.
 
 - `contains(callable $callback): bool`
-- `filter(callable $callback): static`
+- `filter(callable $callback): self`
 
 ### Testmode is automatically removed..
 ..If an API key is used as authentication.

diff --git a/examples/captures/create-capture.php b/examples/captures/create-capture.php
@@ -4,7 +4,6 @@
  * How to prepare a new payment with the Mollie API.
  */
 
-use Mollie\Api\Http\Data\CreatePaymentCapturePayload;
 use Mollie\Api\Http\Data\Money;
 use Mollie\Api\Http\Requests\CreatePaymentCaptureRequest;
 
@@ -22,10 +21,11 @@
      *   description   Description of the capture.
      *   metadata      Custom metadata that is stored with the payment.
      */
-    $response = $mollie->send(new CreatePaymentCaptureRequest('tr_WDqYK6vllg', new CreatePaymentCapturePayload(
+    $response = $mollie->send(new CreatePaymentCaptureRequest(
+        'tr_WDqYK6vllg',
         'Order #12345',
         new Money('EUR', '5.00')
-    )));
+    ));
 
     $capture = $response->toResource();
 

diff --git a/examples/client-links/create-client-link.php b/examples/client-links/create-client-link.php
@@ -3,8 +3,6 @@
 /*
  * How to create a new client link in the Mollie API.
  */
-
-use Mollie\Api\Http\Data\CreateClientLinkPayload;
 use Mollie\Api\Http\Data\Owner;
 use Mollie\Api\Http\Data\OwnerAddress;
 use Mollie\Api\Http\Requests\CreateClientLinkRequest;
@@ -29,13 +27,13 @@
      */
     $response = $mollie
         ->send(
-            new CreateClientLinkRequest(new CreateClientLinkPayload(
+            new CreateClientLinkRequest(
                 new Owner('[email protected]', 'foo', 'bar', 'nl_NL'),
                 'Foo Company',
                 new OwnerAddress('NL', 'Keizersgracht 313', '1016 EE', 'Amsterdam'),
                 '30204462',
                 'NL123456789B01',
-            ))
+            )
         );
 
     $clientLink = $response->toResource();

diff --git a/examples/customers/create-customer-first-payment.php b/examples/customers/create-customer-first-payment.php
@@ -4,12 +4,10 @@
  * How to create a first payment to allow recurring payments later.
  */
 
-use Mollie\Api\Factories\CreatePaymentPayloadFactory;
 use Mollie\Api\Http\Data\Metadata;
 use Mollie\Api\Http\Data\Money;
 use Mollie\Api\Http\Requests\CreateCustomerPaymentRequest;
 use Mollie\Api\Http\Requests\GetPaginatedCustomerRequest;
-use Mollie\Api\Types\SequenceType;
 
 try {
     /*
@@ -40,19 +38,17 @@
      *
      * @See: https://docs.mollie.com/reference/v2/customers-api/create-customer-payment
      */
-    $payload = CreatePaymentPayloadFactory::new([
-        'description' => "First payment - Order #{$orderId}",
-        'amount' => new Money('EUR', '10.00'),
-        'redirectUrl' => "{$protocol}://{$hostname}/payments/return.php?order_id={$orderId}",
-        'webhookUrl' => "{$protocol}://{$hostname}/payments/webhook.php",
-        'metadata' => new Metadata([
-            'order_id' => $orderId,
-        ]),
-        'sequenceType' => SequenceType::FIRST,
-    ])->create();
-
     $payment = $mollie->send(
-        new CreateCustomerPaymentRequest($customer->id, $payload)
+        new CreateCustomerPaymentRequest(
+            $customer->id,
+            "First payment - Order #{$orderId}",
+            new Money('EUR', '10.00'),
+            "{$protocol}://{$hostname}/payments/return.php?order_id={$orderId}",
+            "{$protocol}://{$hostname}/payments/webhook.php",
+            new Metadata([
+                'order_id' => $orderId,
+            ])
+        )
     );
 
     /*

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -273,7 +273,13 @@ parameters:
 		-
 			message: '#^Unsafe usage of new static\(\)\.$#'
 			identifier: new.static
-			count: 4
+			count: 1
+			path: src/Factories/Factory.php
+
+		-
+			message: '#^Unsafe usage of new static\(\)\.$#'
+			identifier: new.static
+			count: 5
 			path: src/Http/Data/DataCollection.php
 
 		-

diff --git a/phpunit.xml b/phpunit.xml
@@ -1,21 +1,26 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit
-        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-        colors="true"
-        bootstrap="./vendor/autoload.php"
-        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
-        convertDeprecationsToExceptions="true"
->
-  <coverage processUncoveredFiles="true">
-    <include>
-      <directory suffix=".php">src/</directory>
-    </include>
-  </coverage>
-  <php>
-    <ini name="display_errors" value="stderr"/>
-    <ini name="error_log" value="/dev/null"/>
-  </php>
-  <testsuite name="Unit tests">
-    <directory>tests/</directory>
-  </testsuite>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="Mollie API Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage>
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+        <exclude>
+            <directory>vendor</directory>
+            <directory>tests</directory>
+        </exclude>
+    </coverage>
+    <php>
+        <ini name="error_reporting" value="-1"/>
+        <ini name="display_errors" value="On"/>
+        <ini name="display_startup_errors" value="On"/>
+    </php>
 </phpunit>
diff --git a/src/CompatibilityChecker.php b/src/CompatibilityChecker.php
@@ -25,7 +25,7 @@ public function checkCompatibility()
     {
         if (! $this->satisfiesPhpVersion()) {
             throw new IncompatiblePlatformException(
-                'The client requires PHP version >= ' . self::MIN_PHP_VERSION . ', you have ' . PHP_VERSION . '.',
+                'The client requires PHP version >= '.self::MIN_PHP_VERSION.', you have '.PHP_VERSION.'.',
                 IncompatiblePlatformException::INCOMPATIBLE_PHP_VERSION
             );
         }

diff --git a/src/Contracts/Connector.php b/src/Contracts/Connector.php
@@ -7,7 +7,10 @@
 
 interface Connector extends Authenticatable, IdempotencyContract, SupportsDebuggingContract, Testable
 {
-    public function send(Request $request): ?object;
+    /**
+     * @return mixed
+     */
+    public function send(Request $request);
 
     public function resolveBaseUrl(): string;
 

diff --git a/src/Contracts/Factory.php b/src/Contracts/Factory.php
diff --git a/src/Contracts/Repository.php b/src/Contracts/Repository.php
@@ -7,16 +7,15 @@ interface Repository
     /**
      * Set the entire repository data
      *
-     * @param mixed $data Array for array repositories, mixed for payload repositories
+     * @param  mixed  $data  Array for array repositories, mixed for payload repositories
      * @return static
      */
     public function set($data);
 
     /**
      * Get a value by key
      *
-     * @param string $key
-     * @param mixed $default
+     * @param  mixed  $default
      * @return mixed
      */
     public function get(string $key, $default = null);
@@ -29,16 +28,14 @@ public function has(string $key): bool;
     /**
      * Add a value to the repository
      *
-     * @param string $key
-     * @param mixed $value
+     * @param  mixed  $value
      * @return static
      */
     public function add(string $key, $value);
 
     /**
      * Merge data into the repository
      *
-     * @param array ...$data
      * @return static
      */
     public function merge(array ...$data);

diff --git a/src/Contracts/SupportsTestmodeInPayload.php b/src/Contracts/SupportsTestmodeInPayload.php
@@ -2,7 +2,7 @@
 
 namespace Mollie\Api\Contracts;
 
-interface SupportsTestmodeInPayload extends SupportsTestmode, HasPayload
+interface SupportsTestmodeInPayload extends HasPayload, SupportsTestmode
 {
     //
 }
diff --git a/src/EndpointCollection/BalanceEndpointCollection.php b/src/EndpointCollection/BalanceEndpointCollection.php
@@ -2,8 +2,8 @@
 
 namespace Mollie\Api\EndpointCollection;
 
-use Mollie\Api\Exceptions\ApiException;
-use Mollie\Api\Factories\GetPaginatedBalanceQueryFactory;
+use Mollie\Api\Exceptions\RequestException;
+use Mollie\Api\Factories\SortablePaginatedQueryFactory;
 use Mollie\Api\Http\Requests\GetBalanceRequest;
 use Mollie\Api\Http\Requests\GetPaginatedBalanceRequest;
 use Mollie\Api\Resources\Balance;
@@ -20,13 +20,12 @@ class BalanceEndpointCollection extends EndpointCollection
      *
      * @param  bool|array  $testmode
      *
-     * @throws ApiException
+     * @throws RequestException
      */
     public function get(string $id, $testmode = false): Balance
     {
         $testmode = Utility::extractBool($testmode, 'testmode', false);
 
-        /** @var Balance */
         return $this->send((new GetBalanceRequest($id))->test($testmode));
     }
 
@@ -37,7 +36,7 @@ public function get(string $id, $testmode = false): Balance
      *
      * @param  bool|array  $testmode
      *
-     * @throws ApiException
+     * @throws RequestException
      */
     public function primary($testmode = false): Balance
     {
@@ -52,13 +51,19 @@ public function page(?string $from = null, ?int $limit = null, array $filters =
     {
         $testmode = Utility::extractBool($filters, 'testmode', false);
 
-        $query = GetPaginatedBalanceQueryFactory::new([
-            'from' => $from,
-            'limit' => $limit,
-            'filters' => $filters,
-        ])->create();
+        $query = SortablePaginatedQueryFactory::new()
+            ->withQuery([
+                'from' => $from,
+                'limit' => $limit,
+                'filters' => $filters,
+            ])
+            ->create();
 
-        return $this->send((new GetPaginatedBalanceRequest($query))->test($testmode));
+        return $this->send((new GetPaginatedBalanceRequest(
+            $query->from,
+            $query->limit,
+            $query->sort,
+        ))->test($testmode));
     }
 
     /**
@@ -71,14 +76,20 @@ public function iterator(?string $from = null, ?int $limit = null, array $filter
     {
         $testmode = Utility::extractBool($filters, 'testmode', false);
 
-        $query = GetPaginatedBalanceQueryFactory::new([
-            'from' => $from,
-            'limit' => $limit,
-            'filters' => $filters,
-        ])->create();
+        $query = SortablePaginatedQueryFactory::new()
+            ->withQuery([
+                'from' => $from,
+                'limit' => $limit,
+                'filters' => $filters,
+            ])
+            ->create();
 
         return $this->send(
-            (new GetPaginatedBalanceRequest($query))
+            (new GetPaginatedBalanceRequest(
+                $query->from,
+                $query->limit,
+                $query->sort,
+            ))
                 ->useIterator()
                 ->setIterationDirection($iterateBackwards)
                 ->test($testmode)

diff --git a/src/EndpointCollection/BalanceReportEndpointCollection.php b/src/EndpointCollection/BalanceReportEndpointCollection.php
@@ -2,9 +2,7 @@
 
 namespace Mollie\Api\EndpointCollection;
 
-use Mollie\Api\Factories\GetBalanceReportQueryFactory;
-use Mollie\Api\Http\Data\GetBalanceReportQuery;
-use Mollie\Api\Http\Requests\GetBalanceReportRequest;
+use Mollie\Api\Factories\GetBalanceReportRequestFactory;
 use Mollie\Api\Resources\Balance;
 use Mollie\Api\Resources\BalanceReport;
 use Mollie\Api\Utils\Utility;
@@ -14,41 +12,38 @@ class BalanceReportEndpointCollection extends EndpointCollection
     /**
      * Retrieve a balance report for the provided balance id and parameters.
      *
-     * @param  array|GetBalanceReportQuery  $query
-     *
-     * @throws \Mollie\Api\Exceptions\ApiException
+     * @throws \Mollie\Api\Exceptions\RequestException
      */
-    public function getForId(string $balanceId, $query = []): ?BalanceReport
+    public function getForId(string $balanceId, array $query = []): ?BalanceReport
     {
         $testmode = Utility::extractBool($query, 'testmode', false);
 
-        $query = GetBalanceReportQueryFactory::new($query)
+        $request = GetBalanceReportRequestFactory::new($balanceId)
+            ->withQuery($query)
             ->create();
 
         /** @var BalanceReport */
-        return $this->send((new GetBalanceReportRequest($balanceId, $query))->test($testmode));
+        return $this->send($request->test($testmode));
     }
 
     /**
      * Retrieve the primary balance.
      * This is the balance of your account’s primary currency, where all payments are settled to by default.
      *
-     * @param  array|GetBalanceReportQuery  $query
-     *
-     * @throws \Mollie\Api\Exceptions\ApiException
+     * @throws \Mollie\Api\Exceptions\RequestException
      */
-    public function getForPrimary($query = []): BalanceReport
+    public function getForPrimary(array $query = []): ?BalanceReport
     {
         return $this->getForId('primary', $query);
     }
 
     /**
      * Retrieve a balance report for the provided balance resource and parameters.
      *
-     * @throws \Mollie\Api\Exceptions\ApiException
+     * @throws \Mollie\Api\Exceptions\RequestException
      */
-    public function getFor(Balance $balance, array $parameters = []): BalanceReport
+    public function getFor(Balance $balance, array $query = []): ?BalanceReport
     {
-        return $this->getForId($balance->id, $parameters);
+        return $this->getForId($balance->id, $query);
     }
 }