feat(Cart): support multiple shipping addresses

Author: nikossvnk

src/Core/Builder/Update/CartsActionBuilder.php

@@ -6,9 +6,12 @@
 use Commercetools\Core\Request\AbstractAction;
 use Commercetools\Core\Request\Carts\Command\CartAddCustomLineItemAction;
 use Commercetools\Core\Request\Carts\Command\CartAddDiscountCodeAction;
+use Commercetools\Core\Request\Carts\Command\CartAddItemShippingAddressAction;
 use Commercetools\Core\Request\Carts\Command\CartAddLineItemAction;
 use Commercetools\Core\Request\Carts\Command\CartAddPaymentAction;
 use Commercetools\Core\Request\Carts\Command\CartAddShoppingListAction;
+use Commercetools\Core\Request\Carts\Command\CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction;
+use Commercetools\Core\Request\Carts\Command\CartApplyDeltaToLineItemShippingDetailsTargetsAction;
 use Commercetools\Core\Request\Carts\Command\CartChangeCustomLineItemMoneyAction;
 use Commercetools\Core\Request\Carts\Command\CartChangeCustomLineItemQuantityAction;
 use Commercetools\Core\Request\Carts\Command\CartChangeLineItemQuantityAction;
@@ -18,6 +21,7 @@
 use Commercetools\Core\Request\Carts\Command\CartRecalculateAction;
 use Commercetools\Core\Request\Carts\Command\CartRemoveCustomLineItemAction;
 use Commercetools\Core\Request\Carts\Command\CartRemoveDiscountCodeAction;
+use Commercetools\Core\Request\Carts\Command\CartRemoveItemShippingAddressAction;
 use Commercetools\Core\Request\Carts\Command\CartRemoveLineItemAction;
 use Commercetools\Core\Request\Carts\Command\CartRemovePaymentAction;
 use Commercetools\Core\Request\Carts\Command\CartSetAnonymousIdAction;
@@ -27,6 +31,7 @@
 use Commercetools\Core\Request\Carts\Command\CartSetCustomFieldAction;
 use Commercetools\Core\Request\Carts\Command\CartSetCustomLineItemCustomFieldAction;
 use Commercetools\Core\Request\Carts\Command\CartSetCustomLineItemCustomTypeAction;
+use Commercetools\Core\Request\Carts\Command\CartSetCustomLineItemShippingDetailsAction;
 use Commercetools\Core\Request\Carts\Command\CartSetCustomLineItemTaxAmountAction;
 use Commercetools\Core\Request\Carts\Command\CartSetCustomLineItemTaxRateAction;
 use Commercetools\Core\Request\Carts\Command\CartSetCustomShippingMethodAction;
@@ -38,6 +43,7 @@
 use Commercetools\Core\Request\Carts\Command\CartSetLineItemCustomFieldAction;
 use Commercetools\Core\Request\Carts\Command\CartSetLineItemCustomTypeAction;
 use Commercetools\Core\Request\Carts\Command\CartSetLineItemPriceAction;
+use Commercetools\Core\Request\Carts\Command\CartSetLineItemShippingDetailsAction;
 use Commercetools\Core\Request\Carts\Command\CartSetLineItemTaxAmountAction;
 use Commercetools\Core\Request\Carts\Command\CartSetLineItemTaxRateAction;
 use Commercetools\Core\Request\Carts\Command\CartSetLineItemTotalPriceAction;
@@ -47,6 +53,7 @@
 use Commercetools\Core\Request\Carts\Command\CartSetShippingMethodTaxAmountAction;
 use Commercetools\Core\Request\Carts\Command\CartSetShippingMethodTaxRateAction;
 use Commercetools\Core\Request\Carts\Command\CartSetShippingRateInputAction;
+use Commercetools\Core\Request\Carts\Command\CartUpdateItemShippingAddressAction;
 
 class CartsActionBuilder
 {
@@ -74,6 +81,17 @@ public function addDiscountCode($action = null)
         return $this;
     }
 
+    /**
+     *
+     * @param CartAddItemShippingAddressAction|callable $action
+     * @return $this
+     */
+    public function addItemShippingAddress($action = null)
+    {
+        $this->addAction($this->resolveAction(CartAddItemShippingAddressAction::class, $action));
+        return $this;
+    }
+
     /**
      * @link https://docs.commercetools.com/http-api-projects-carts.html#add-lineitem
      * @param CartAddLineItemAction|callable $action
@@ -107,6 +125,29 @@ public function addShoppingList($action = null)
         return $this;
     }
 
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-carts.html#apply-deltatocustomlineitemshippingdetailstargets
+     * @param CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction|callable $action
+     * @return $this
+     */
+    public function applyDeltaToCustomLineItemShippingDetailsTargets($action = null)
+    {
+        // @codingStandardsIgnoreLine
+        $this->addAction($this->resolveAction(CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction::class, $action));
+        return $this;
+    }
+
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-carts.html#apply-deltatolineitemshippingdetailstargets
+     * @param CartApplyDeltaToLineItemShippingDetailsTargetsAction|callable $action
+     * @return $this
+     */
+    public function applyDeltaToLineItemShippingDetailsTargets($action = null)
+    {
+        $this->addAction($this->resolveAction(CartApplyDeltaToLineItemShippingDetailsTargetsAction::class, $action));
+        return $this;
+    }
+
     /**
      * @link https://docs.commercetools.com/http-api-projects-carts.html#change-customlineitem-money
      * @param CartChangeCustomLineItemMoneyAction|callable $action
@@ -206,6 +247,17 @@ public function removeDiscountCode($action = null)
         return $this;
     }
 
+    /**
+     *
+     * @param CartRemoveItemShippingAddressAction|callable $action
+     * @return $this
+     */
+    public function removeItemShippingAddress($action = null)
+    {
+        $this->addAction($this->resolveAction(CartRemoveItemShippingAddressAction::class, $action));
+        return $this;
+    }
+
     /**
      * @link https://docs.commercetools.com/http-api-projects-carts.html#remove-lineitem
      * @param CartRemoveLineItemAction|callable $action
@@ -305,6 +357,17 @@ public function setCustomLineItemCustomType($action = null)
         return $this;
     }
 
+    /**
+     *
+     * @param CartSetCustomLineItemShippingDetailsAction|callable $action
+     * @return $this
+     */
+    public function setCustomLineItemShippingDetails($action = null)
+    {
+        $this->addAction($this->resolveAction(CartSetCustomLineItemShippingDetailsAction::class, $action));
+        return $this;
+    }
+
     /**
      * @link https://docs.commercetools.com/http-api-projects-carts.html#set-customlineitem-taxamount
      * @param CartSetCustomLineItemTaxAmountAction|callable $action
@@ -426,6 +489,17 @@ public function setLineItemPrice($action = null)
         return $this;
     }
 
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-carts.html#set-lineitem-totalprice
+     * @param CartSetLineItemShippingDetailsAction|callable $action
+     * @return $this
+     */
+    public function setLineItemShippingDetails($action = null)
+    {
+        $this->addAction($this->resolveAction(CartSetLineItemShippingDetailsAction::class, $action));
+        return $this;
+    }
+
     /**
      * @link https://docs.commercetools.com/http-api-projects-carts.html#set-lineitem-taxamount
      * @param CartSetLineItemTaxAmountAction|callable $action
@@ -526,6 +600,17 @@ public function setShippingRateInput($action = null)
         return $this;
     }
 
+    /**
+     *
+     * @param CartUpdateItemShippingAddressAction|callable $action
+     * @return $this
+     */
+    public function updateItemShippingAddress($action = null)
+    {
+        $this->addAction($this->resolveAction(CartUpdateItemShippingAddressAction::class, $action));
+        return $this;
+    }
+
     /**
      * @return CartsActionBuilder
      */

src/Core/Error/InvalidItemShippingDetailsError.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Error;
+
+/**
+ * @package Commercetools\Core\Error
+ *
+ * @method string getCode()
+ * @method InvalidItemShippingDetailsError setCode(string $code = null)
+ * @method string getMessage()
+ * @method InvalidItemShippingDetailsError setMessage(string $message = null)
+ * @method string getSubject()
+ * @method InvalidItemShippingDetailsError setSubject(string $subject = null)
+ * @method string getItemId()
+ * @method InvalidItemShippingDetailsError setItemId(string $itemId = null)
+ */
+class InvalidItemShippingDetailsError extends ApiError
+{
+    const CODE = 'InvalidItemShippingDetails';
+
+    public function fieldDefinitions()
+    {
+        $definitions = parent::fieldDefinitions();
+        $definitions['subject'] = [static::TYPE => 'string'];
+        $definitions['itemId'] = [static::TYPE => 'string'];
+
+        return $definitions;
+    }
+}

src/Core/Helper/Annotate/AnnotationGenerator.php

@@ -209,7 +209,7 @@ function ($link) {
             $actionShortName = $updateClass->getShortName();
             $action = new $update();
             $actionName = $action->getAction();
-
+            $csIgnore = strlen($actionShortName) > 55 ? '// @codingStandardsIgnoreLine' . PHP_EOL . '        ' : '';
             $method = <<<METHOD
     /**
      *$docLinks
@@ -218,7 +218,7 @@ function ($link) {
      */
     public function $actionName(\$action = null)
     {
-        \$this->addAction(\$this->resolveAction($actionShortName::class, \$action));
+        $csIgnore\$this->addAction(\$this->resolveAction($actionShortName::class, \$action));
         return \$this;
     }
 METHOD;

src/Core/Model/Cart/Cart.php

@@ -7,6 +7,7 @@
 
 use Commercetools\Core\Model\CartDiscount\CartDiscountReferenceCollection;
 use Commercetools\Core\Model\Common\Address;
+use Commercetools\Core\Model\Common\AddressCollection;
 use Commercetools\Core\Model\Common\LocaleTrait;
 use Commercetools\Core\Model\Common\Resource;
 use Commercetools\Core\Model\Common\Money;
@@ -77,6 +78,8 @@
  * @method Cart setTaxCalculationMode(string $taxCalculationMode = null)
  * @method ShippingRateInput getShippingRateInput()
  * @method Cart setShippingRateInput(ShippingRateInput $shippingRateInput = null)
+ * @method AddressCollection getItemShippingAddresses()
+ * @method Cart setItemShippingAddresses(AddressCollection $itemShippingAddresses = null)
  * @method CartReference getReference()
  */
 class Cart extends Resource
@@ -134,7 +137,8 @@ public function fieldDefinitions()
             'refusedGifts' => [static::TYPE => CartDiscountReferenceCollection::class],
             'origin' => [static::TYPE => 'string'],
             'taxCalculationMode' => [static::TYPE => 'string'],
-            'shippingRateInput' => [static::TYPE => ShippingRateInput::class]
+            'shippingRateInput' => [static::TYPE => ShippingRateInput::class],
+            'itemShippingAddresses' => [static::TYPE => AddressCollection::class],
         ];
     }
 

src/Core/Model/Cart/CartDraft.php

@@ -5,6 +5,7 @@
 
 namespace Commercetools\Core\Model\Cart;
 
+use Commercetools\Core\Model\Common\AddressCollection;
 use Commercetools\Core\Model\Common\Context;
 use Commercetools\Core\Model\Common\JsonObject;
 use Commercetools\Core\Model\Common\LocaleTrait;
@@ -58,6 +59,8 @@
  * @method CartDraft setExternalTaxRateForShippingMethod(ExternalTaxRateDraft $externalTaxRateForShippingMethod = null)
  * @method ShippingRateInputDraft getShippingRateInput()
  * @method CartDraft setShippingRateInput(ShippingRateInputDraft $shippingRateInput = null)
+ * @method AddressCollection getItemShippingAddresses()
+ * @method CartDraft setItemShippingAddresses(AddressCollection $itemShippingAddresses = null)
  */
 class CartDraft extends JsonObject
 {
@@ -87,6 +90,7 @@ public function fieldDefinitions()
             'taxCalculationMode' => [static::TYPE => 'string'],
             'externalTaxRateForShippingMethod' => [static::TYPE => ExternalTaxRateDraft::class],
             'shippingRateInput' => [static::TYPE => ShippingRateInputDraft::class],
+            'itemShippingAddresses' => [static::TYPE => AddressCollection::class],
         ];
     }
 

src/Core/Model/Cart/CustomLineItem.php

@@ -40,6 +40,8 @@
  * @method DiscountedPricePerQuantityCollection getDiscountedPricePerQuantity()
  * @method TaxedItemPrice getTaxedPrice()
  * @method CustomLineItem setTaxedPrice(TaxedItemPrice $taxedPrice = null)
+ * @method ItemShippingDetails getShippingDetails()
+ * @method CustomLineItem setShippingDetails(ItemShippingDetails $shippingDetails = null)
  */
 class CustomLineItem extends JsonObject
 {
@@ -60,6 +62,7 @@ public function fieldDefinitions()
             'discountedPricePerQuantity' => [
                 static::TYPE => DiscountedPricePerQuantityCollection::class
             ],
+            'shippingDetails' => [static::TYPE => ItemShippingDetails::class],
         ];
     }
 

src/Core/Model/Cart/CustomLineItemDraft.php

@@ -5,12 +5,11 @@
 
 namespace Commercetools\Core\Model\Cart;
 
+use Commercetools\Core\Model\Common\AddressCollection;
 use Commercetools\Core\Model\Common\JsonObject;
 use Commercetools\Core\Model\Common\LocalizedString;
 use Commercetools\Core\Model\Common\Money;
-use Commercetools\Core\Model\Order\ItemState;
 use Commercetools\Core\Model\TaxCategory\TaxCategoryReference;
-use Commercetools\Core\Model\TaxCategory\TaxRate;
 use Commercetools\Core\Model\CustomField\CustomFieldObject;
 use Commercetools\Core\Model\TaxCategory\ExternalTaxRateDraft;
 
@@ -31,6 +30,10 @@
  * @method CustomLineItemDraft setCustom(CustomFieldObject $custom = null)
  * @method ExternalTaxRateDraft getExternalTaxRate()
  * @method CustomLineItemDraft setExternalTaxRate(ExternalTaxRateDraft $externalTaxRate = null)
+ * @method AddressCollection getItemShippingAddresses()
+ * @method CustomLineItemDraft setItemShippingAddresses(AddressCollection $itemShippingAddresses = null)
+ * @method ItemShippingDetailsDraft getShippingDetails()
+ * @method CustomLineItemDraft setShippingDetails(ItemShippingDetailsDraft $shippingDetails = null)
  */
 class CustomLineItemDraft extends JsonObject
 {
@@ -44,6 +47,7 @@ public function fieldDefinitions()
             'taxCategory' => [static::TYPE => TaxCategoryReference::class],
             'externalTaxRate' => [static::TYPE => ExternalTaxRateDraft::class],
             'custom' => [static::TYPE => CustomFieldObject::class],
+            'shippingDetails' => [static::TYPE => ItemShippingDetailsDraft::class],
         ];
     }
 }

src/Core/Model/Cart/ItemShippingDetails.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ *
+ */
+
+namespace Commercetools\Core\Model\Cart;
+
+use Commercetools\Core\Model\Common\JsonObject;
+
+/**
+ * @package Commercetools\Core\Model\Cart
+ *
+ * @method ItemShippingTargetCollection getTargets()
+ * @method ItemShippingDetails setTargets(ItemShippingTargetCollection $targets = null)
+ * @method bool getValid()
+ * @method ItemShippingDetails setValid(bool $valid = null)
+ */
+class ItemShippingDetails extends JsonObject
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'targets' => [static::TYPE => ItemShippingTargetCollection::class],
+            'valid' => [static::TYPE => 'bool'],
+        ];
+    }
+}

src/Core/Model/Cart/ItemShippingDetailsDraft.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ *
+ */
+
+namespace Commercetools\Core\Model\Cart;
+
+use Commercetools\Core\Model\Common\JsonObject;
+
+/**
+ * @package Commercetools\Core\Model\Cart
+ *
+ * @method ItemShippingTargetCollection getTargets()
+ * @method ItemShippingDetailsDraft setTargets(ItemShippingTargetCollection $targets = null)
+ */
+class ItemShippingDetailsDraft extends JsonObject
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'targets' => [static::TYPE => ItemShippingTargetCollection::class],
+        ];
+    }
+}

src/Core/Model/Cart/ItemShippingTarget.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ *
+ */
+
+namespace Commercetools\Core\Model\Cart;
+
+use Commercetools\Core\Model\Common\JsonObject;
+
+/**
+ * @package Commercetools\Core\Model\Cart
+ *
+ * @method string getAddressKey()
+ * @method ItemShippingTarget setAddressKey(string $addressKey = null)
+ * @method int getQuantity()
+ * @method ItemShippingTarget setQuantity(int $quantity = null)
+ */
+class ItemShippingTarget extends JsonObject
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'addressKey' => [static::TYPE => 'string'],
+            'quantity' => [static::TYPE => 'int'],
+        ];
+    }
+}