Merge pull request #38 from klingac/feature/fair_price_and_promotions

Feature/fair price and promotions
mallgroup · Oct 4, 2022 · 504d2a2 · 504d2a2
2 parents a5f5841 + 3689c45
commit 504d2a2
Show file tree

Hide file tree

Showing 16 changed files with 100 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,18 @@ 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).
 
+## 4.4.0 - 2022-10-03
+
+### Changed
+
+- `promotions` attribute is deprecated
+
+## 4.3.0 - 2022-10-03
+
+### Added
+
+- `fairPrice` attribute to `Article entity`
+
 ## 4.2.0 - 2022-08-04
 
 ### Added

diff --git a/example/Article.php b/example/Article.php
@@ -60,6 +60,7 @@
         echo 'In stock: ' . $product->getInStock() . PHP_EOL;
         echo 'Rrp: ' . $product->getRrp() . PHP_EOL;
         echo 'Price: ' . $product->getPrice() . PHP_EOL;
+        echo 'Fair price: ' . $product->getFairPrice() . PHP_EOL;
         echo 'Purchase price: ' . $product->getPurchasePrice() . PHP_EOL;
         echo 'Variants count: ' . $product->getVariantsCount() . PHP_EOL;
         echo PHP_EOL;
@@ -218,6 +219,7 @@
     echo 'Rrp: ' . $productPricing->getRrp() . PHP_EOL;
     echo 'Price: ' . $productPricing->getPrice() . PHP_EOL;
     echo 'Purchase price: ' . $productPricing->getPurchasePrice() . PHP_EOL;
+    echo 'Fair price: ' . $productPricing->getFairPrice() . PHP_EOL;
     echo PHP_EOL;
 } catch (MpApiException $e) {
     echo 'Unexpected error occurred while loading product pricing: ' . $e->getMessage();
@@ -259,6 +261,7 @@
         echo 'In stock: ' . $variant->getInStock() . PHP_EOL;
         echo 'Rrp: ' . $variant->getRrp() . PHP_EOL;
         echo 'Price: ' . $variant->getPrice() . PHP_EOL;
+        echo 'Fair price: ' . $variant->getFairPrice() . PHP_EOL;
         echo 'Purchase price: ' . $variant->getPurchasePrice() . PHP_EOL;
         echo PHP_EOL;
     }
@@ -417,6 +420,7 @@
     echo 'Rrp: ' . $variantPricing->getRrp() . PHP_EOL;
     echo 'Price: ' . $variantPricing->getPrice() . PHP_EOL;
     echo 'Purchase price: ' . $variantPricing->getPurchasePrice() . PHP_EOL;
+    echo 'Fair price: ' . $variantPricing->getFairPrice() . PHP_EOL;
     echo PHP_EOL;
 } catch (MpApiException $e) {
     echo 'Unexpected error occurred while loading variant pricing: ' . $e->getMessage();

diff --git a/psalm.xml b/psalm.xml
@@ -12,4 +12,20 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+
+    <issueHandlers>
+        <DeprecatedClass>
+            <errorLevel type="suppress">
+                <file name="src/Article/Entity/Common/PromotionIterator.php"/>
+                <file name="src/Article/Entity/Common/AbstractArticle.php"/>
+                <file name="src/Article/DTO/AbstractArticleRequest.php"/>
+            </errorLevel>
+        </DeprecatedClass>
+        <DeprecatedProperty>
+            <errorLevel type="suppress">
+                <file name="src/Article/Entity/Common/AbstractArticle.php"/>
+                <file name="src/Article/DTO/AbstractArticleRequest.php"/>
+            </errorLevel>
+        </DeprecatedProperty>
+    </issueHandlers>
 </psalm>
diff --git a/src/Article/DTO/AbstractArticleRequest.php b/src/Article/DTO/AbstractArticleRequest.php
@@ -26,6 +26,7 @@ abstract class AbstractArticleRequest implements JsonSerializable
     protected ?float            $purchasePrice = null;
     protected ?float            $rrp           = null;
     protected MediaIterator     $media;
+    /** @deprecated */
     protected PromotionIterator $promotions;
     protected ParameterIterator $parameters;
     protected LabelIterator     $labels;
@@ -146,11 +147,17 @@ public function setMedia(MediaIterator $media): void
         $this->media = $media;
     }
 
+    /**
+     * @deprecated
+     */
     public function getPromotions(): PromotionIterator
     {
         return $this->promotions;
     }
 
+    /**
+     * @deprecated
+     */
     public function setPromotions(PromotionIterator $promotions): void
     {
         $this->promotions = $promotions;

diff --git a/src/Article/DTO/ProductRequest.php b/src/Article/DTO/ProductRequest.php
@@ -50,6 +50,7 @@ public static function createFromProduct(Product $product): self
         $self->setPurchasePrice($product->getPurchasePrice());
         $self->setRrp($product->getRrp());
         $self->setMedia($product->getMedia());
+        /** @psalm-suppress DeprecatedMethod */
         $self->setPromotions($product->getPromotions());
         $self->setParameters($product->getParameters());
         $self->setDimensions($product->getDimensions());
@@ -78,6 +79,7 @@ public static function createFromProduct(Product $product): self
      */
     public function getArrayForApi(): array
     {
+        /** @psalm-suppress DeprecatedMethod */
         $mandatory = [
             'id'                  => $this->getId(),
             'title'               => $this->getTitle(),

diff --git a/src/Article/DTO/VariantRequest.php b/src/Article/DTO/VariantRequest.php
@@ -43,6 +43,7 @@ public static function createFromVariant(Variant $variant): self
         $self->setBarcode($variant->getBarcode());
         $self->setPurchasePrice($variant->getPurchasePrice());
         $self->setRrp($variant->getRrp());
+        /** @psalm-suppress DeprecatedMethod */
         $self->setPromotions($variant->getPromotions());
         $self->setDimensions($variant->getDimensions());
         $self->setAvailability($variant->getAvailability());
@@ -61,6 +62,7 @@ public static function createFromVariant(Variant $variant): self
      */
     public function getArrayForApi(): array
     {
+        /** @psalm-suppress DeprecatedMethod */
         $mandatory = [
             'id'         => $this->getId(),
             'title'      => $this->getTitle(),

diff --git a/src/Article/Entity/BasicProduct.php b/src/Article/Entity/BasicProduct.php
@@ -20,6 +20,7 @@ final class BasicProduct implements JsonSerializable
     private int              $inStock;
     private string           $categoryId;
     private float            $price;
+    private ?float           $fairPrice;
     private float            $purchasePrice;
     private float            $rrp;
     private int              $variantsCount;
@@ -34,6 +35,7 @@ private function __construct(
         int $inStock,
         string $categoryId,
         float $price,
+        ?float $fairPrice,
         float $purchasePrice,
         float $rrp,
         int $variantsCount,
@@ -47,6 +49,7 @@ private function __construct(
         $this->inStock       = $inStock;
         $this->categoryId    = $categoryId;
         $this->price         = $price;
+        $this->fairPrice     = $fairPrice;
         $this->purchasePrice = $purchasePrice;
         $this->rrp           = $rrp;
         $this->variantsCount = $variantsCount;
@@ -70,6 +73,7 @@ public static function createFromApi(array $data): self
             (int) $data['in_stock'],
             (string) $data['category_id'],
             (float) $data['price'],
+            isset($data['fair_price']) ? (float) $data['fair_price'] : null,
             (float) $data['purchase_price'],
             (float) $data['rrp'],
             (int) $data['variants_count'],
@@ -117,6 +121,11 @@ public function getPrice(): float
         return $this->price;
     }
 
+    public function getFairPrice(): ?float
+    {
+        return $this->fairPrice;
+    }
+
     public function getPurchasePrice(): float
     {
         return $this->purchasePrice;

diff --git a/src/Article/Entity/BasicVariant.php b/src/Article/Entity/BasicVariant.php
@@ -19,6 +19,7 @@ final class BasicVariant implements JsonSerializable
     private StatusEnum $status;
     private int        $inStock;
     private float      $price;
+    private ?float     $fairPrice;
     private float      $purchasePrice;
     private float      $rrp;
 
@@ -30,6 +31,7 @@ private function __construct(
         StatusEnum $status,
         int $inStock,
         float $price,
+        ?float $fairPrice,
         float $purchasePrice,
         float $rrp
     ) {
@@ -40,6 +42,7 @@ private function __construct(
         $this->status        = $status;
         $this->inStock       = $inStock;
         $this->price         = $price;
+        $this->fairPrice     = $fairPrice;
         $this->purchasePrice = $purchasePrice;
         $this->rrp           = $rrp;
     }
@@ -60,6 +63,7 @@ public static function createFromApi(array $data): self
             new StatusEnum((string) $data[StatusEnum::KEY_NAME]),
             (int) $data['in_stock'],
             (float) $data['price'],
+            isset($data['fair_price']) ? (float) $data['fair_price'] : null,
             (float) $data['purchase_price'],
             (float) $data['rrp'],
         );
@@ -100,6 +104,11 @@ public function getPrice(): float
         return $this->price;
     }
 
+    public function getFairPrice(): ?float
+    {
+        return $this->fairPrice;
+    }
+
     public function getPurchasePrice(): float
     {
         return $this->purchasePrice;

diff --git a/src/Article/Entity/Common/AbstractArticle.php b/src/Article/Entity/Common/AbstractArticle.php
@@ -19,9 +19,13 @@ abstract class AbstractArticle implements JsonSerializable
     protected int               $priority;
     protected ?string           $barcode;
     protected float             $price;
+    protected ?float            $fairPrice;
     protected float             $purchasePrice;
     protected float             $rrp;
     protected MediaIterator     $media;
+    /**
+     * @deprecated
+     */
     protected PromotionIterator $promotions;
     protected ParameterIterator $parameters;
     protected Dimensions        $dimensions;
@@ -47,6 +51,7 @@ abstract class AbstractArticle implements JsonSerializable
      * @param int               $priority
      * @param string|null       $barcode
      * @param float             $price
+     * @param ?float            $fairPrice
      * @param float             $purchasePrice
      * @param float             $rrp
      * @param MediaIterator     $media
@@ -72,6 +77,7 @@ protected function __construct(
         int $priority,
         ?string $barcode,
         float $price,
+        ?float $fairPrice,
         float $purchasePrice,
         float $rrp,
         MediaIterator $media,
@@ -96,6 +102,7 @@ protected function __construct(
         $this->priority       = $priority;
         $this->barcode        = $barcode;
         $this->price          = $price;
+        $this->fairPrice      = $fairPrice;
         $this->purchasePrice  = $purchasePrice;
         $this->rrp            = $rrp;
         $this->media          = $media;
@@ -164,6 +171,11 @@ public function getPrice(): float
         return $this->price;
     }
 
+    public function getFairPrice(): ?float
+    {
+        return $this->fairPrice;
+    }
+
     public function getPurchasePrice(): float
     {
         return $this->purchasePrice;
@@ -179,6 +191,9 @@ public function getMedia(): MediaIterator
         return $this->media;
     }
 
+    /**
+     * @deprecated
+     */
     public function getPromotions(): PromotionIterator
     {
         return $this->promotions;

diff --git a/src/Article/Entity/Common/Pricing.php b/src/Article/Entity/Common/Pricing.php
@@ -13,12 +13,14 @@ final class Pricing implements JsonSerializable
     private float $price;
     private float $rrp;
     private float $purchasePrice;
+    private ?float $fairPrice;
 
-    public function __construct(float $price, float $rrp, float $purchasePrice)
+    public function __construct(float $price, float $rrp, float $purchasePrice, ?float $fairPrice = null)
     {
         $this->price         = $price;
         $this->rrp           = $rrp;
         $this->purchasePrice = $purchasePrice;
+        $this->fairPrice     = $fairPrice;
     }
 
     /**
@@ -32,6 +34,7 @@ public static function createFromApi(array $data): self
             (float) $data['price'],
             (float) $data['rrp'],
             (float) $data['purchase_price'],
+            isset($data['fair_price']) ? (float) $data['fair_price'] : null
         );
     }
 
@@ -44,6 +47,7 @@ public function getArrayForApi(): array
             'price'          => $this->getPrice(),
             'rrp'            => $this->getRrp(),
             'purchase_price' => $this->getPurchasePrice(),
+            'fair_price'     => $this->getFairPrice(),
         ];
     }
 
@@ -62,4 +66,9 @@ public function getPurchasePrice(): float
         return $this->purchasePrice;
     }
 
+    public function getFairPrice(): ?float
+    {
+        return $this->fairPrice;
+    }
+
 }
diff --git a/src/Article/Entity/Common/Promotion.php b/src/Article/Entity/Common/Promotion.php
@@ -9,6 +9,7 @@
 use MpApiClient\Common\Util\InputDataUtil;
 use MpApiClient\Common\Util\JsonSerializeEntityTrait;
 
+/** @deprecated  */
 final class Promotion implements JsonSerializable
 {
 

diff --git a/src/Article/Entity/Common/PromotionIterator.php b/src/Article/Entity/Common/PromotionIterator.php
@@ -8,6 +8,7 @@
 /**
  * @extends AbstractIntKeyIterator<Promotion>
  * @property Promotion[] $data
+ * @deprecated
  */
 final class PromotionIterator extends AbstractIntKeyIterator
 {

diff --git a/src/Article/Entity/Product.php b/src/Article/Entity/Product.php
@@ -30,6 +30,7 @@ final class Product extends AbstractArticle
     protected ?float  $weeeFee;
 
     /**
+     * @psalm-suppress DeprecatedClass
      * @param string            $id
      * @param int               $articleId
      * @param ProductStageEnum  $stage
@@ -41,6 +42,7 @@ final class Product extends AbstractArticle
      * @param int               $priority
      * @param string|null       $barcode
      * @param float             $price
+     * @param ?float            $fairPrice
      * @param float             $purchasePrice
      * @param int               $vat
      * @param float             $rrp
@@ -74,6 +76,7 @@ private function __construct(
         int $priority,
         ?string $barcode,
         float $price,
+        ?float $fairPrice,
         float $purchasePrice,
         int $vat,
         float $rrp,
@@ -105,6 +108,7 @@ private function __construct(
             $priority,
             $barcode,
             $price,
+            $fairPrice,
             $purchasePrice,
             $rrp,
             $media,
@@ -138,6 +142,7 @@ private function __construct(
      */
     public static function createFromApi(array $data): self
     {
+        /** @psalm-suppress DeprecatedClass */
         return new self(
             (string) $data['id'],
             (int) $data['article_id'],
@@ -150,6 +155,7 @@ public static function createFromApi(array $data): self
             (int) $data['priority'],
             InputDataUtil::getNullableString($data, 'barcode'),
             (float) $data['price'],
+            isset($data['fair_price']) ? (float)$data['fair_price'] : null,
             (float) $data['purchase_price'],
             (int) $data['vat'],
             (float) $data['rrp'],

diff --git a/src/Article/Entity/Variant.php b/src/Article/Entity/Variant.php
@@ -25,6 +25,7 @@ final class Variant extends AbstractArticle
      */
     public static function createFromApi(array $data): self
     {
+        /** @psalm-suppress DeprecatedClass */
         return new self(
             (string) $data['id'],
             (int) $data['article_id'],
@@ -35,6 +36,7 @@ public static function createFromApi(array $data): self
             (int) $data['priority'],
             InputDataUtil::getNullableString($data, 'barcode'),
             (float) $data['price'],
+            isset($data['fair_price']) ? (float) $data['fair_price'] : null,
             (float) $data['purchase_price'],
             (float) $data['rrp'],
             MediaIterator::createFromApi($data['media']),