Merge pull request #73 from unzerdev/UMCS-419/update_basket

Umcs 419/update basket

Author: Ryouzanpaku

CHANGELOG.md

@@ -3,7 +3,9 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [1.1.5,0](https://github.com/unzerdev/php-sdk/compare/1.1.4.2..1.1.5.0)
+## [1.1.5.0](https://github.com/unzerdev/php-sdk/compare/1.1.4.2..1.1.5.0)
+### Added
+*   Add Support for basket `v2` resource.
 ### Changed
 * Add support for payment state `create` which can occur when using payment pages.
 * Several minor improvements.

src/Constants/ApiResponseCodes.php

@@ -62,6 +62,7 @@ class ApiResponseCodes
     public const API_ERROR_RECURRING_PAYMENT_NOT_SUPPORTED             = 'API.500.550.004';
     public const API_ERROR_WEBHOOK_EVENT_ALREADY_REGISTERED            = 'API.510.310.009';
     public const API_ERROR_WEBHOOK_CAN_NOT_BE_FOUND                    = 'API.510.310.008';
+    public const API_ERROR_BASKET_NOT_FOUND                            = 'API.600.410.024';
     public const API_ERROR_BASKET_ITEM_IMAGE_INVALID_URL               = 'API.600.630.004';
     public const API_ERROR_RECURRING_ALREADY_ACTIVE                    = 'API.640.550.006';
     public const API_ERROR_INVALID_KEY                                 = 'API.710.000.002';

src/Interfaces/ResourceServiceInterface.php

@@ -146,7 +146,11 @@ public function fetchMetadata($metadata): Metadata;
     public function createBasket(Basket $basket): Basket;
 
     /**
-     * Fetches and returns the given Basket (by object or id).
+     * Fetches and returns the given Basket (by object or id). Since the PAPI provides 2 basket versions, this method performs up to two request.
+     * Firstly the basket gets fetched from the "v2" endpoint.
+     * Only If PAPI returns a specific "basket not found" error the function tries to fetch from the "v1" basket endpoint.
+     *
+     * @see \UnzerSDK\Constants\ApiResponseCodes::API_ERROR_BASKET_NOT_FOUND
      *
      * @param Basket|string $basket Basket object or id of basket to be fetched.
      *

src/Resources/AbstractUnzerResource.php

@@ -160,6 +160,16 @@ public function setSpecialParams(array $specialParams): self
         return $this;
     }
 
+    /**
+     * Returns the API version for this resource.
+     *
+     * @return string
+     */
+    public function getApiVersion(): string
+    {
+        return Unzer::API_VERSION;
+    }
+
     /**
      * @param array $additionalAttributes
      *

src/Resources/Basket.php

@@ -31,15 +31,30 @@
 
 class Basket extends AbstractUnzerResource
 {
-    /** @var float $amountTotalGross */
+    /**
+     * @var float $amountTotalGross
+     *
+     * @deprecated since 1.1.5.0 @see $totalValueGross.
+     */
     protected $amountTotalGross = 0.0;
 
-    /** @var float $amountTotalDiscount */
+    /**
+     * @var float $amountTotalDiscount
+     *
+     * @deprecated since 1.1.5.0 @see Please set $amountDiscountPerUnitGross for each element of $basketItems instead.
+     */
     protected $amountTotalDiscount = 0.0;
 
-    /** @var float $amountTotalVat */
+    /**
+     * @var float $amountTotalVat
+     *
+     * @deprecated since 1.1.5.0  Please set the $vat in percent for each element of $basketItems instead, if not already happened. The actual amount is not required anymore.
+     */
     protected $amountTotalVat = 0.0;
 
+    /** @var float $totalValueGross */
+    protected $totalValueGross = 0.0;
+
     /** @var string $currencyCode */
     protected $currencyCode;
 
@@ -55,6 +70,8 @@ class Basket extends AbstractUnzerResource
     /**
      * Basket constructor.
      *
+     * @deprecated since 1.1.5.0 Please call constructor without parameters and use setter functions instead.
+     *
      * @param float  $amountTotalGross
      * @param string $currencyCode
      * @param string $orderId
@@ -76,6 +93,8 @@ public function __construct(
 
     /**
      * @return float
+     *
+     * @deprecated since 1.1.5.0 @see $getTotalValueGross.
      */
     public function getAmountTotalGross(): float
     {
@@ -85,6 +104,8 @@ public function getAmountTotalGross(): float
     /**
      * @param float $amountTotalGross
      *
+     * @deprecated since 1.1.5.0 @see $getTotalValueGross.
+     *
      * @return Basket
      */
     public function setAmountTotalGross(float $amountTotalGross): Basket
@@ -96,6 +117,27 @@ public function setAmountTotalGross(float $amountTotalGross): Basket
     /**
      * @return float
      */
+    public function getTotalValueGross(): float
+    {
+        return $this->totalValueGross;
+    }
+
+    /**
+     * @param float $totalValueGross
+     *
+     * @return Basket
+     */
+    public function setTotalValueGross(float $totalValueGross): Basket
+    {
+        $this->totalValueGross = $totalValueGross;
+        return $this;
+    }
+
+    /**
+     * @return float
+     *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
+     */
     public function getAmountTotalDiscount(): float
     {
         return $this->amountTotalDiscount;
@@ -104,6 +146,8 @@ public function getAmountTotalDiscount(): float
     /**
      * @param float $amountTotalDiscount
      *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
+     *
      * @return Basket
      */
     public function setAmountTotalDiscount(float $amountTotalDiscount): Basket
@@ -114,6 +158,8 @@ public function setAmountTotalDiscount(float $amountTotalDiscount): Basket
 
     /**
      * @return float
+     *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     public function getAmountTotalVat(): float
     {
@@ -123,6 +169,8 @@ public function getAmountTotalVat(): float
     /**
      * @param float $amountTotalVat
      *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
+     *
      * @return Basket
      */
     public function setAmountTotalVat(float $amountTotalVat): Basket
@@ -269,6 +317,17 @@ public function expose(): array
         return $returnArray;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function getApiVersion(): string
+    {
+        if (!empty($this->getTotalValueGross())) {
+            return 'v2';
+        }
+        return parent::getApiVersion();
+    }
+
     /**
      * Returns the key of the last BasketItem in the Array.
      *

src/Resources/EmbeddedResources/BasketItem.php

@@ -37,19 +37,45 @@ class BasketItem extends AbstractUnzerResource
     /** @var float $vat */
     protected $vat = 0.0;
 
-    /** @var float $amountDiscount */
+    /**
+     * @var float $amountDiscount
+     *
+     * @deprecated since 1.1.5.0 @see $amountDiscountPerUnitGross.
+     */
     protected $amountDiscount = 0.0;
 
-    /** @var float $amountGross */
+    /** @var float $amountDiscountPerUnitGross */
+    protected $amountDiscountPerUnitGross = 0.0;
+
+    /**
+     * @var float $amountGross
+     *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
+     */
     protected $amountGross = 0.0;
 
-    /** @var float $amountVat */
+    /**
+     * @var float $amountVat
+     *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
+     */
     protected $amountVat = 0.0;
 
-    /** @var float $amountPerUnit */
+    /**
+     * @var float $amountPerUnit
+     *
+     * @deprecated since 1.1.5.0 @see amountPerUnitGross
+     */
     protected $amountPerUnit = 0.0;
 
-    /** @var float $amountNet */
+    /** @var float $amountPerUnitGross */
+    protected $amountPerUnitGross = 0.0;
+
+    /**
+     * @var float $amountNet
+     *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
+     */
     protected $amountNet = 0.0;
 
     /** @var string $unit */
@@ -70,6 +96,8 @@ class BasketItem extends AbstractUnzerResource
     /**
      * BasketItem constructor.
      *
+     * @deprecated since 1.1.5.0 Please call constructor without parameters and use setter functions instead.
+     *
      * @param string $title
      * @param float  $amountNet
      * @param float  $amountPerUnit
@@ -148,6 +176,8 @@ public function setVat(float $vat): BasketItem
 
     /**
      * @return float
+     *
+     * @deprecated since 1.1.5.0  @see $getAmountDiscountPerUnitGross.
      */
     public function getAmountDiscount(): float
     {
@@ -157,6 +187,8 @@ public function getAmountDiscount(): float
     /**
      * @param float $amountDiscount
      *
+     * @deprecated since 1.1.5.0  @see $setAmountDiscountPerUnitGross.
+     *
      * @return BasketItem
      */
     public function setAmountDiscount(float $amountDiscount): BasketItem
@@ -167,6 +199,8 @@ public function setAmountDiscount(float $amountDiscount): BasketItem
 
     /**
      * @return float
+     *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     public function getAmountGross(): float
     {
@@ -176,6 +210,8 @@ public function getAmountGross(): float
     /**
      * @param float $amountGross
      *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
+     *
      * @return BasketItem
      */
     public function setAmountGross(float $amountGross): BasketItem
@@ -187,6 +223,46 @@ public function setAmountGross(float $amountGross): BasketItem
     /**
      * @return float
      */
+    public function getAmountDiscountPerUnitGross(): float
+    {
+        return $this->amountDiscountPerUnitGross;
+    }
+
+    /**
+     * @param float $amountDiscountPerUnitGross
+     *
+     * @return BasketItem
+     */
+    public function setAmountDiscountPerUnitGross(float $amountDiscountPerUnitGross): BasketItem
+    {
+        $this->amountDiscountPerUnitGross = $amountDiscountPerUnitGross;
+        return $this;
+    }
+
+    /**
+     * @return float
+     */
+    public function getAmountPerUnitGross(): float
+    {
+        return $this->amountPerUnitGross;
+    }
+
+    /**
+     * @param float $amountPerUnitGross
+     *
+     * @return BasketItem
+     */
+    public function setAmountPerUnitGross(float $amountPerUnitGross): BasketItem
+    {
+        $this->amountPerUnitGross = $amountPerUnitGross;
+        return $this;
+    }
+
+    /**
+     * @return float
+     *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
+     */
     public function getAmountVat(): float
     {
         return $this->amountVat;
@@ -195,6 +271,8 @@ public function getAmountVat(): float
     /**
      * @param float $amountVat
      *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
+     *
      * @return BasketItem
      */
     public function setAmountVat(float $amountVat): BasketItem
@@ -205,6 +283,8 @@ public function setAmountVat(float $amountVat): BasketItem
 
     /**
      * @return float
+     *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     public function getAmountPerUnit(): float
     {
@@ -214,6 +294,8 @@ public function getAmountPerUnit(): float
     /**
      * @param float $amountPerUnit
      *
+     * @deprecated since 1.1.5.0 @see setAmountPerUnitGross
+     *
      * @return BasketItem
      */
     public function setAmountPerUnit(float $amountPerUnit): BasketItem
@@ -224,6 +306,8 @@ public function setAmountPerUnit(float $amountPerUnit): BasketItem
 
     /**
      * @return float
+     *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
      */
     public function getAmountNet(): float
     {
@@ -233,6 +317,8 @@ public function getAmountNet(): float
     /**
      * @param float $amountNet
      *
+     * @deprecated since 1.1.5.0 Property is redundant and is no longer needed.
+     *
      * @return BasketItem
      */
     public function setAmountNet(float $amountNet): BasketItem