[ACL-80] Signup Plus

.gitignore

@@ -1,4 +1,5 @@
 .idea
+.phpunit.cache
 .phpunit.result.cache
 .php-cs-fixer.cache
 vendor/

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.0.2] - 2025-02-27
+
+### Added
+
+- Support for SignUp Plus authentication link creation
+- Support for SignUp Plus user data retrieval
+
 ## [3.0.1] - 2025-01-09
 
 ### Changed

README.md

@@ -34,10 +34,11 @@
 10. [Payouts](#payouts)
 11. [Merchant accounts](#merchant-accounts)
 12. [Account identifiers](#account-identifiers)
-13. [Receiving webhook notifications](#webhooks)
-14. [Custom idempotency keys](#idempotency)
-15. [Custom API calls](#custom-api-calls)
-16. [Error Handling](#error-handling)
+13. [SignUp Plus](#signup-plus)
+14. [Receiving webhook notifications](#webhooks)
+15. [Custom idempotency keys](#idempotency)
+16. [Custom API calls](#custom-api-calls)
+17. [Error Handling](#error-handling)
 
 <a name="why"></a>
 
@@ -1011,6 +1012,29 @@ foreach ($merchantAccount->getAccountIdentifiers() as $accountIdentifier) {
 }
 ```
 
+<a name="signup-plus"></a>
+
+# SignUp Plus
+
+Generating a SignUp Plus authentication link:
+
+```php
+$client->signupPlus()
+    ->authUri()
+    ->paymentId('some_payment_id')
+    ->state('some_state')
+    ->create();
+```
+
+Retrieving user data:
+
+```php
+$response = $client->signupPlus()
+        ->userData()
+        ->paymentId('fake_payment_id')
+        ->retrieve(); // SignupPlusUserDataRetrievedInterface
+```
+
 <a name="webhooks"></a>
 
 # Receiving webhook notifications

config/bindings.php

@@ -9,6 +9,7 @@
     Interfaces\HppInterface::class => 'makeHpp',
 
     Interfaces\AddressInterface::class => Entities\Address::class,
+    Interfaces\AddressRetrievedInterface::class => Entities\AddressRetrieved::class,
     Interfaces\UserInterface::class => Entities\User::class,
 
     Interfaces\Payment\Beneficiary\BeneficiaryBuilderInterface::class => Entities\Payment\Beneficiary\BeneficiaryBuilder::class,
@@ -109,5 +110,12 @@
     Interfaces\Webhook\Beneficiary\ExternalAccountBeneficiaryInterface::class => Entities\Webhook\Beneficiary\ExternalAccountBeneficiary::class,
     Interfaces\Webhook\Beneficiary\BeneficiaryInterface::class => Entities\Webhook\Beneficiary\Beneficiary::class,
 
+    Interfaces\SignupPlus\SignupPlusBuilderInterface::class => Entities\SignupPlus\SignupPlusBuilder::class,
+    Interfaces\SignupPlus\SignupPlusAuthUriRequestInterface::class => Entities\SignupPlus\SignupPlusAuthUriRequest::class,
+    Interfaces\SignupPlus\SignupPlusAuthUriCreatedInterface::class => Entities\SignupPlus\SignupPlusAuthUriCreated::class,
+    Interfaces\SignupPlus\SignupPlusAccountDetailsInterface::class => Entities\SignupPlus\SignupPlusAccountDetails::class,
+    Interfaces\SignupPlus\SignupPlusUserDataRequestInterface::class => Entities\SignupPlus\SignupPlusUserDataRequest::class,
+    Interfaces\SignupPlus\SignupPlusUserDataRetrievedInterface::class => Entities\SignupPlus\SignupPlusUserDataRetrieved::class,
+
     Interfaces\RequestOptionsInterface::class => Entities\RequestOptions::class,
 ];

src/Constants/Endpoints.php

@@ -35,4 +35,7 @@ class Endpoints
 
     public const PAYOUTS_CREATE = '/v3/payouts';
     public const PAYOUTS_RETRIEVE = '/v3/payouts/{id}';
+    public const SIGNUP_PLUS_AUTH = '/signup-plus/authuri';
+    public const SIGNUP_PLUS_PAYMENTS = '/signup-plus/payments?payment_id={id}';
+    public const SIGNUP_PLUS_MANDATES = '/signup-plus/mandates?mandate_id={id}';
 }

src/Entities/Address.php

@@ -6,58 +6,8 @@
 
 use TrueLayer\Interfaces\AddressInterface;
 
-class Address extends Entity implements AddressInterface
+class Address extends AddressRetrieved implements AddressInterface
 {
-    /**
-     * @var string
-     */
-    protected string $addressLine1;
-
-    /**
-     * @var string
-     */
-    protected string $addressLine2;
-
-    /**
-     * @var string
-     */
-    protected string $city;
-
-    /**
-     * @var string
-     */
-    protected string $state;
-
-    /**
-     * @var string
-     */
-    protected string $zip;
-
-    /**
-     * @var string
-     */
-    protected string $countryCode;
-
-    /**
-     * @var string[]
-     */
-    protected array $arrayFields = [
-        'address_line1',
-        'address_line2',
-        'city',
-        'state',
-        'zip',
-        'country_code',
-    ];
-
-    /**
-     * @return string|null
-     */
-    public function getAddressLine1(): ?string
-    {
-        return $this->addressLine1 ?? null;
-    }
-
     /**
      * @param string $addressLine1
      *
@@ -70,14 +20,6 @@ public function addressLine1(string $addressLine1): AddressInterface
         return $this;
     }
 
-    /**
-     * @return string|null
-     */
-    public function getAddressLine2(): ?string
-    {
-        return $this->addressLine2 ?? null;
-    }
-
     /**
      * @param string $addressLine2
      *
@@ -90,14 +32,6 @@ public function addressLine2(string $addressLine2): AddressInterface
         return $this;
     }
 
-    /**
-     * @return string|null
-     */
-    public function getCity(): ?string
-    {
-        return $this->city ?? null;
-    }
-
     /**
      * @param string $city
      *
@@ -110,14 +44,6 @@ public function city(string $city): AddressInterface
         return $this;
     }
 
-    /**
-     * @return string|null
-     */
-    public function getState(): ?string
-    {
-        return $this->state ?? null;
-    }
-
     /**
      * @param string $state
      *
@@ -130,14 +56,6 @@ public function state(string $state): AddressInterface
         return $this;
     }
 
-    /**
-     * @return string|null
-     */
-    public function getZip(): ?string
-    {
-        return $this->zip ?? null;
-    }
-
     /**
      * @param string $zip
      *
@@ -150,14 +68,6 @@ public function zip(string $zip): AddressInterface
         return $this;
     }
 
-    /**
-     * @return string|null
-     */
-    public function getCountryCode(): ?string
-    {
-        return $this->countryCode ?? null;
-    }
-
     /**
      * @param string $countryCode
      *

src/Entities/AddressRetrieved.php

@@ -0,0 +1,100 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TrueLayer\Entities;
+
+use TrueLayer\Interfaces\AddressRetrievedInterface;
+
+class AddressRetrieved extends Entity implements AddressRetrievedInterface
+{
+    /**
+     * @var string
+     */
+    protected string $addressLine1;
+
+    /**
+     * @var string
+     */
+    protected string $addressLine2;
+
+    /**
+     * @var string
+     */
+    protected string $city;
+
+    /**
+     * @var string
+     */
+    protected string $state;
+
+    /**
+     * @var string
+     */
+    protected string $zip;
+
+    /**
+     * @var string
+     */
+    protected string $countryCode;
+
+    /**
+     * @var string[]
+     */
+    protected array $arrayFields = [
+        'address_line1',
+        'address_line2',
+        'city',
+        'state',
+        'zip',
+        'country_code',
+    ];
+
+    /**
+     * @return string|null
+     */
+    public function getAddressLine1(): ?string
+    {
+        return $this->addressLine1 ?? null;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getAddressLine2(): ?string
+    {
+        return $this->addressLine2 ?? null;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getCity(): ?string
+    {
+        return $this->city ?? null;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getState(): ?string
+    {
+        return $this->state ?? null;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getZip(): ?string
+    {
+        return $this->zip ?? null;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getCountryCode(): ?string
+    {
+        return $this->countryCode ?? null;
+    }
+}