Fix PHP 8.2 and Other Related Issues

.gitattributes

@@ -8,4 +8,4 @@
 Makefile export-ignore
 /php_env export-ignore
 phpunit.xml export-ignore
-.php_cs export-ignore
+.php-cs-fixer.php export-ignore

.github/workflows/build.yaml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: ["7.3", "7.4", "8.0"]
+        php-version: ["7.3", "7.4", "8.0", "8.1", "8.2"]
         os: [ubuntu-latest]
         experimental: [false]
         composer-options: ['']

.gitignore

@@ -11,6 +11,6 @@ composer.lock
 
 .*
 !.github
-!.php_cs
+!.php-cs-fixer.php
 !.gitignore
 !.gitattributes

.php_cs → .php-cs-fixer.php

@@ -1,17 +1,18 @@
 <?php
 
-$finder = PhpCsFixer\Finder::create()
+$finder = (new PhpCsFixer\Finder())
     ->in(__DIR__.'/MangoPay')
     ->in(__DIR__.'/tests')
 ;
 
-$config = new PhpCsFixer\Config();
-
-return $config->setRules([
+return (new PhpCsFixer\Config())
+    ->setRules([
         '@PSR12' => true,
         'fully_qualified_strict_types' => true,
         'array_syntax' => ['syntax' => 'short'],
-        'visibility_required' => ['property', 'method'],// 'const' is removed for old PHP compat
+        'visibility_required' => [
+            'elements' => ['property', 'method'], // 'const' is removed for old PHP compat
+        ],
     ])
     ->setFinder($finder)
 ;

Makefile

@@ -36,3 +36,21 @@ docker-test-php-80: ## Test on PHP 8.0
 	--user $(shell id -u):$(shell id -g) \
 	php-test-env:8.0 \
 	/bin/bash -c "composer update -no --no-progress --no-suggest --ignore-platform-reqs && vendor/bin/phpunit tests"
+
+.PHONY: docker-test-php-81
+docker-test-php-81: ## Test on PHP 8.1
+	docker build -t php-test-env:8.1 php_env/PHP_8.1
+	docker run -it -v "${PWD}":/usr/src/mangopay2-php-sdk \
+	-w /usr/src/mangopay2-php-sdk \
+	--user $(shell id -u):$(shell id -g) \
+	php-test-env:8.1 \
+	/bin/bash -c "composer update -no --no-progress --no-suggest --ignore-platform-reqs && vendor/bin/phpunit tests"
+
+.PHONY: docker-test-php-82
+docker-test-php-82: ## Test on PHP 8.2
+	docker build -t php-test-env:8.2 php_env/PHP_8.2
+	docker run -it -v "${PWD}":/usr/src/mangopay2-php-sdk \
+	-w /usr/src/mangopay2-php-sdk \
+	--user $(shell id -u):$(shell id -g) \
+	php-test-env:8.2 \
+	/bin/bash -c "composer update -no --no-progress --no-suggest --ignore-platform-reqs && vendor/bin/phpunit tests"

MangoPay/ApiUboDeclarations.php

@@ -10,23 +10,32 @@ class ApiUboDeclarations extends Libraries\ApiBase
     /**
      * Creates a new UBO Declaration for an user.
      * @param string $userId The ID of the user
-     * @return \MangoPay\UboDeclaration UBO Declaration object returned from API
+     * @return \MangoPay\UboDeclaration|array|object UBO Declaration object returned from API
      */
     public function Create($userId)
     {
         return $this->CreateObject('ubo_declaration_create', null, '\MangoPay\UboDeclaration', $userId);
     }
 
+    /**
+     * Gets all UBO Declarations for an user.
+     * @param string $userId The ID of the user
+     * @param \MangoPay\Pagination $pagination Pagination object
+     * @param \MangoPay\Sorting $sorting Sorting object
+     * @return \MangoPay\UboDeclaration[]|array List of UBO Declarations returned from API
+     * @throws \MangoPay\Libraries\Exception
+     */
     public function GetAll($userId, $pagination = null, $sorting = null)
     {
         return $this->GetList("ubo_declaration_all", $pagination, '\MangoPay\UboDeclaration', $userId, null, $sorting);
     }
 
     /**
      * Gets an UBO Declaration.
-     * @param string $userId
-     * @param string $uboDeclarationId
-     * @return UboDeclaration UBO Declaration object returned from API
+     * @param string $userId The ID of the user
+     * @param string $uboDeclarationId UBO Declaration identifier
+     * @return UboDeclaration|array|object UBO Declaration object returned from API
+     * @throws \MangoPay\Libraries\Exception
      */
     public function Get($userId, $uboDeclarationId)
     {
@@ -35,8 +44,8 @@ public function Get($userId, $uboDeclarationId)
 
     /**
      * Gets an UBO Declaration directly by Id.
-     * @param string $uboDeclarationId
-     * @return UboDeclaration UBO Declaration object returned from API
+     * @param string $uboDeclarationId UBO Declaration identifier
+     * @return UboDeclaration|array|object UBO Declaration object returned from API
      */
     public function GetById($uboDeclarationId)
     {
@@ -45,10 +54,11 @@ public function GetById($uboDeclarationId)
 
     /**
      * Creates a new UBO for the specified arguments
-     * @param string $userId int
-     * @param string $uboDeclarationId int
-     * @param Ubo $ubo
-     * @return Ubo UBO object returned from API
+     * @param string $userId The ID of the user
+     * @param string $uboDeclarationId The ID of the UBO declaration
+     * @param Ubo $ubo The UBO object to be created
+     * @return Ubo|array|object UBO object returned from API
+     * @throws \MangoPay\Libraries\ResponseException
      */
     public function CreateUbo($userId, $uboDeclarationId, $ubo)
     {
@@ -60,10 +70,10 @@ public function CreateUbo($userId, $uboDeclarationId, $ubo)
 
     /**
      * Updates an UBO
-     * @param string $userId
-     * @param string $uboDeclarationId
-     * @param Ubo $ubo
-     * @return Ubo UBO object returned from API
+     * @param string $userId The ID of the user
+     * @param string $uboDeclarationId The ID of the UBO declaration
+     * @param Ubo $ubo The UBO object to be updated
+     * @return Ubo|array|object UBO object returned from API
      */
     public function UpdateUbo($userId, $uboDeclarationId, $ubo)
     {
@@ -72,10 +82,11 @@ public function UpdateUbo($userId, $uboDeclarationId, $ubo)
 
     /**
      * Gets an UBO
-     * @param string $userId
-     * @param string $uboDeclarationId
-     * @param string $uboId
-     * @return Ubo UBO object returned from API
+     * @param string $userId The ID of the user
+     * @param string $uboDeclarationId The ID of the UBO declaration
+     * @param string $uboId The ID of the UBO
+     * @return \MangoPay\Ubo|array|object UBO object returned from API
+     * @throws \MangoPay\Libraries\Exception
      */
     public function GetUbo($userId, $uboDeclarationId, $uboId)
     {
@@ -84,9 +95,9 @@ public function GetUbo($userId, $uboDeclarationId, $uboId)
 
     /**
      * Updates an UBO Declaration with the status <code>VALIDATION_ASKED</code>.
-     * @param string $userId
-     * @param string $uboDeclarationId
-     * @return UboDeclaration
+     * @param string $userId The ID of the user
+     * @param string $uboDeclarationId The ID of the UBO declaration
+     * @return \MangoPay\UboDeclaration|array|object
      */
     public function SubmitForValidation($userId, $uboDeclarationId)
     {
@@ -98,8 +109,10 @@ public function SubmitForValidation($userId, $uboDeclarationId)
 
     /**
      * Gets an UBO Declaration.
-     * @param string $uboDeclarationId
-     * @return UboDeclaration UBO Declaration object returned from API
+     * @param string $uboDeclarationId UBO Declaration identifier
+     * @return \MangoPay\UboDeclaration|array|object UBO Declaration object returned from API
+     * @throws \MangoPay\Libraries\Exception
+     * @throws \Exception
      */
     public function GetUboDeclarationById($uboDeclarationId)
     {

MangoPay/KycDocument.php

@@ -3,30 +3,59 @@
 namespace MangoPay;
 
 /**
- * KYC document entity
+ * KYC document entity.
  */
 class KycDocument extends Libraries\Document
 {
     /**
+     * The type of the document for the user verification.
+     *
      * @var string
+     *
      * @see \MangoPay\KycDocumentType
+     * @see https://mangopay.com/docs/endpoints/kyc-documents#kyc-document-object
      */
     public $Type;
 
     /**
+     * The label of KYC document type.
+     *
      * @var string
-     * @see \MangoPay\KycDocumentStatus
+     * @phpstan-var \MangoPay\KycDocumentStatus::*
+     */
+    public $TypeLabel;
+
+    /**
+     * The status of the KYC document.
+     *
+     * @var string
+     *
+     * @see KycDocumentStatus
      */
     public $Status;
 
     /**
+     * The label of KYC document status.
+     *
+     * @var string
+     */
+    public $StatusLabel;
+
+    /**
+     * The unique identifier of the user.
+     *
      * @var string
      */
     public $UserId;
 
     /**
-     * More information regarding why the document has been rejected.
+     * The series of codes providing more precision regarding the reason why the identity proof document was refused.
+     * You can review the explanations for each code in the Flags list.
+     *
      * @var array
+     *
+     * @see KycDocumentRefusedReasonType
+     * @see https://mangopay.com/docs/concepts/users/verification/document-process#flags-list
      */
     public $Flags;
 }

MangoPay/Libraries/ApiBase.php

@@ -274,7 +274,7 @@ protected function GetRequestType($key)
     /**
      * Create object in API
      * @param string $methodKey Key with request data
-     * @param object $entity Entity object
+     * @param object|null $entity Entity object
      * @param object $responseClassName Name of entity class from response
      * @param string $entityId Entity identifier
      * @return object Response data
@@ -310,7 +310,8 @@ protected function CreateObject($methodKey, $entity, $responseClassName = null,
     /**
      * Get entity object from API
      * @param string $methodKey Key with request data
-     * @param object $responseClassName Name of entity class from response
+     * @param string $responseClassName Name of entity class from response
+     * @param array $params path variable in urls
      * @return object Response data
      * @throws Exception
      */

MangoPay/PayIn.php

@@ -13,6 +13,23 @@ class PayIn extends Transaction
      */
     public $CreditedWalletId;
 
+    /**
+     * The mode applied for the 3DS protocol for CB, Visa, and Mastercard.
+     * Default values: DEFAULT. Allowed values: DEFAULT, FORCE, NO_CHOICE
+     *
+     * @var string
+     */
+    public $SecureMode;
+
+    /**
+     * The 3DS protocol version to be applied to the transaction. Allowing values: V1, V2_1
+     *
+     * @see https://mangopay.com/docs/concepts/payments/payment-methods/card/3ds
+     * @see https://mangopay.com/docs/endpoints/direct-card-payins#direct-card-payin-object
+     * @var string
+     */
+    public $Requested3DSVersion;
+
     /**
      * PaymentType {CARD, BANK_WIRE, DIRECT_DEBIT, PAYPAL, PAYCONIQ }
      * @var string
@@ -43,6 +60,32 @@ class PayIn extends Transaction
      */
     public $RecurringPayinRegistrationId;
 
+    /**
+     * The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.
+     * @var string
+     */
+    public $IpAddress;
+
+    /**
+     * Information about the browser used by the end user (author) to perform the payment.
+     * @var BrowserInfo
+     */
+    public $BrowserInfo;
+
+    /**
+     * Information about the end user billing address. If left empty, the default values will be automatically taken into account.
+     * Default values: FirstName, LastName, and Address information of the Shipping object if any, otherwise the user (author).
+     * @var Billing
+     */
+    public $Billing;
+
+    /**
+     * Information about the end user’s shipping address. If left empty, the default values will be automatically taken into account.
+     * Default values: FirstName, LastName, and Address information of the Billing object, if supplied, otherwise of the user (author).
+     * @var Shipping
+     */
+    public $Shipping;
+
     /**
      * Allowed values: ECommerce (default), TelephoneOrder
      *

MangoPay/PayOut.php

@@ -7,6 +7,20 @@
  */
 class PayOut extends Transaction
 {
+    /**
+     * The unique identifier of the bank account.
+     *
+     * @var string
+     */
+    public $BankAccountId;
+
+    /**
+     * Custom description to appear on the user’s bank statement along with the platform name.
+     * The recommended length is 12 characters – strings longer than this may be truncated depending on the bank.
+     * @var string
+     */
+    public $BankWireRef;
+
     /**
      * Debited wallet Id
      * @var string
@@ -19,12 +33,24 @@ class PayOut extends Transaction
      */
     public $PaymentType;
 
+    /**
+     * One of PayOutPaymentDetails implementations, depending on $PaymentType
+     * @var object
+     */
+    public $PayoutPaymentDetails;
+
     /**
      * One of PayOutPaymentDetails implementations, depending on $PaymentType
      * @var object
      */
     public $MeanOfPaymentDetails;
 
+    /**
+     * Payout mode requested, default is 'STANDARD', Allowed values are
+     * 'STANDARD', 'INSTANT_PAYMENT', 'INSTANT_PAYMENT_ONLY'
+     * @var string
+     */
+    public $PayoutModeRequested;
 
     /**
      * Get array with mapping which property depends on other property

MangoPay/Refund.php

@@ -37,6 +37,12 @@ class Refund extends Transaction
      */
     public $RefundReason;
 
+    /**
+     * Message related to the refund
+     * @var string
+     */
+    public $RefundReasonMessage;
+
     /**
      * @var string
      */