feat(Order): add update actions to set the delivery in the custom fields for order and order edit

Author: Barbara Palumbo

src/Core/Builder/Update/OrdersActionBuilder.php

@@ -31,6 +31,8 @@
 use Commercetools\Core\Request\Orders\Command\OrderSetDeliveryAddressAction;
 use Commercetools\Core\Request\Orders\Command\OrderSetDeliveryAddressCustomFieldAction;
 use Commercetools\Core\Request\Orders\Command\OrderSetDeliveryAddressCustomTypeAction;
+use Commercetools\Core\Request\Orders\Command\OrderSetDeliveryCustomFieldAction;
+use Commercetools\Core\Request\Orders\Command\OrderSetDeliveryCustomTypeAction;
 use Commercetools\Core\Request\Orders\Command\OrderSetDeliveryItemsAction;
 use Commercetools\Core\Request\Orders\Command\OrderSetItemShippingAddressCustomFieldAction;
 use Commercetools\Core\Request\Orders\Command\OrderSetItemShippingAddressCustomTypeAction;
@@ -360,6 +362,28 @@ public function setDeliveryAddressCustomType($action = null)
         return $this;
     }
 
+    /**
+     *
+     * @param OrderSetDeliveryCustomFieldAction|callable $action
+     * @return $this
+     */
+    public function setDeliveryCustomField($action = null)
+    {
+        $this->addAction($this->resolveAction(OrderSetDeliveryCustomFieldAction::class, $action));
+        return $this;
+    }
+
+    /**
+     *
+     * @param OrderSetDeliveryCustomTypeAction|callable $action
+     * @return $this
+     */
+    public function setDeliveryCustomType($action = null)
+    {
+        $this->addAction($this->resolveAction(OrderSetDeliveryCustomTypeAction::class, $action));
+        return $this;
+    }
+
     /**
      * @link https://docs.commercetools.com/http-api-projects-orders.html#set-delivery-items
      * @param OrderSetDeliveryItemsAction|callable $action

src/Core/Builder/Update/StagedOrderActionBuilder.php

@@ -49,6 +49,8 @@
 use Commercetools\Core\Request\OrderEdits\StagedOrder\Command\StagedOrderSetDeliveryAddressAction;
 use Commercetools\Core\Request\OrderEdits\StagedOrder\Command\StagedOrderSetDeliveryAddressCustomFieldAction;
 use Commercetools\Core\Request\OrderEdits\StagedOrder\Command\StagedOrderSetDeliveryAddressCustomTypeAction;
+use Commercetools\Core\Request\OrderEdits\StagedOrder\Command\StagedOrderSetDeliveryCustomFieldAction;
+use Commercetools\Core\Request\OrderEdits\StagedOrder\Command\StagedOrderSetDeliveryCustomTypeAction;
 use Commercetools\Core\Request\OrderEdits\StagedOrder\Command\StagedOrderSetDeliveryItemsAction;
 use Commercetools\Core\Request\OrderEdits\StagedOrder\Command\StagedOrderSetItemShippingAddressCustomFieldAction;
 use Commercetools\Core\Request\OrderEdits\StagedOrder\Command\StagedOrderSetItemShippingAddressCustomTypeAction;
@@ -589,6 +591,28 @@ public function setDeliveryAddressCustomType($action = null)
         return $this;
     }
 
+    /**
+     *
+     * @param StagedOrderSetDeliveryCustomFieldAction|callable $action
+     * @return $this
+     */
+    public function setDeliveryCustomField($action = null)
+    {
+        $this->addAction($this->resolveAction(StagedOrderSetDeliveryCustomFieldAction::class, $action));
+        return $this;
+    }
+
+    /**
+     *
+     * @param StagedOrderSetDeliveryCustomTypeAction|callable $action
+     * @return $this
+     */
+    public function setDeliveryCustomType($action = null)
+    {
+        $this->addAction($this->resolveAction(StagedOrderSetDeliveryCustomTypeAction::class, $action));
+        return $this;
+    }
+
     /**
      *
      * @param StagedOrderSetDeliveryItemsAction|callable $action

src/Core/Model/Order/Delivery.php

@@ -8,6 +8,7 @@
 use Commercetools\Core\Model\Common\Address;
 use Commercetools\Core\Model\Common\JsonObject;
 use Commercetools\Core\Model\Common\DateTimeDecorator;
+use Commercetools\Core\Model\CustomField\CustomFieldObject;
 use DateTime;
 
 /**
@@ -23,6 +24,8 @@
  * @method Delivery setParcels(ParcelCollection $parcels = null)
  * @method Address getAddress()
  * @method Delivery setAddress(Address $address = null)
+ * @method CustomFieldObject getCustom()
+ * @method Delivery setCustom(CustomFieldObject $custom = null)
  */
 class Delivery extends JsonObject
 {
@@ -36,7 +39,8 @@ public function fieldDefinitions()
             ],
             'items' => [static::TYPE => DeliveryItemCollection::class],
             'parcels' => [static::TYPE => ParcelCollection::class],
-            'address' => [static::TYPE => Address::class]
+            'address' => [static::TYPE => Address::class],
+            'custom' => [static::TYPE => CustomFieldObject::class],
         ];
     }
 }

src/Core/Request/OrderEdits/StagedOrder/Command/StagedOrderAddDeliveryAction.php

@@ -9,6 +9,7 @@
 use Commercetools\Core\Model\Order\DeliveryItemCollection;
 use Commercetools\Core\Model\Order\ParcelCollection;
 use Commercetools\Core\Model\Common\Address;
+use Commercetools\Core\Model\CustomField\CustomFieldObject;
 
 /**
  * @package Commercetools\Core\Request\OrderEdits\StagedOrder\Command
@@ -21,6 +22,8 @@
  * @method StagedOrderAddDeliveryAction setParcels(ParcelCollection $parcels = null)
  * @method Address getAddress()
  * @method StagedOrderAddDeliveryAction setAddress(Address $address = null)
+ * @method CustomFieldObject getCustom()
+ * @method StagedOrderAddDeliveryAction setCustom(CustomFieldObject $custom = null)
  */
 class StagedOrderAddDeliveryAction extends OrderAddDeliveryAction implements StagedOrderUpdateAction
 {

src/Core/Request/OrderEdits/StagedOrder/Command/StagedOrderSetDeliveryCustomFieldAction.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Commercetools\Core\Request\OrderEdits\StagedOrder\Command;
+
+use Commercetools\Core\Request\Orders\Command\OrderSetDeliveryCustomFieldAction;
+
+/**
+ * @package Commercetools\Core\Request\OrderEdits\StagedOrder\Command
+ *
+ * @method string getAction()
+ * @method StagedOrderSetDeliveryCustomFieldAction setAction(string $action = null)
+ * @method string getName()
+ * @method StagedOrderSetDeliveryCustomFieldAction setName(string $name = null)
+ * @method mixed getValue()
+ * @method StagedOrderSetDeliveryCustomFieldAction setValue($value = null)
+ */
+// phpcs:ignore
+class StagedOrderSetDeliveryCustomFieldAction extends OrderSetDeliveryCustomFieldAction implements StagedOrderUpdateAction
+{
+}

src/Core/Request/OrderEdits/StagedOrder/Command/StagedOrderSetDeliveryCustomTypeAction.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Commercetools\Core\Request\OrderEdits\StagedOrder\Command;
+
+use Commercetools\Core\Request\Orders\Command\OrderSetDeliveryCustomTypeAction;
+use Commercetools\Core\Model\Type\TypeReference;
+use Commercetools\Core\Model\CustomField\FieldContainer;
+
+/**
+ * @package Commercetools\Core\Request\OrderEdits\StagedOrder\Command
+ *
+ * @method string getAction()
+ * @method StagedOrderSetDeliveryCustomTypeAction setAction(string $action = null)
+ * @method TypeReference getType()
+ * @method StagedOrderSetDeliveryCustomTypeAction setType(TypeReference $type = null)
+ * @method FieldContainer getFields()
+ * @method StagedOrderSetDeliveryCustomTypeAction setFields(FieldContainer $fields = null)
+ */
+class StagedOrderSetDeliveryCustomTypeAction extends OrderSetDeliveryCustomTypeAction implements StagedOrderUpdateAction
+{
+}

src/Core/Request/Orders/Command/OrderAddDeliveryAction.php

@@ -7,6 +7,7 @@
 
 use Commercetools\Core\Model\Common\Address;
 use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Model\CustomField\CustomFieldObject;
 use Commercetools\Core\Model\Order\DeliveryItemCollection;
 use Commercetools\Core\Model\Order\ParcelCollection;
 use Commercetools\Core\Model\Order\ParcelMeasurements;
@@ -24,6 +25,8 @@
  * @method OrderAddDeliveryAction setParcels(ParcelCollection $parcels = null)
  * @method Address getAddress()
  * @method OrderAddDeliveryAction setAddress(Address $address = null)
+ * @method CustomFieldObject getCustom()
+ * @method OrderAddDeliveryAction setCustom(CustomFieldObject $custom = null)
  */
 class OrderAddDeliveryAction extends AbstractAction
 {
@@ -34,6 +37,7 @@ public function fieldDefinitions()
             'items' => [static::TYPE => DeliveryItemCollection::class],
             'parcels' => [static::TYPE => ParcelCollection::class],
             'address' => [static::TYPE => Address::class],
+            'custom' => [static::TYPE =>CustomFieldObject::class],
         ];
     }
 

src/Core/Request/Orders/Command/OrderSetDeliveryCustomFieldAction.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Commercetools\Core\Request\Orders\Command;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Request\CustomField\Command\SetCustomFieldAction;
+
+/**
+ * @package Commercetools\Core\Request\Orders\Command
+ *
+ *
+ * @method string getAction()
+ * @method OrderSetDeliveryCustomFieldAction setAction(string $action = null)
+ * @method string getName()
+ * @method OrderSetDeliveryCustomFieldAction setName(string $name = null)
+ * @method mixed getValue()
+ * @method OrderSetDeliveryCustomFieldAction setValue($value = null)
+ */
+class OrderSetDeliveryCustomFieldAction extends SetCustomFieldAction
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'action' => [static::TYPE => 'string'],
+            'name' => [static::TYPE => 'string'],
+            'value' => [static::TYPE => null],
+        ];
+    }
+
+    /**
+     * @param array $data
+     * @param Context|callable $context
+     */
+    public function __construct(array $data = [], $context = null)
+    {
+        parent::__construct($data, $context);
+        $this->setAction('setDeliveryCustomField');
+    }
+
+    public static function ofName($name, $context = null)
+    {
+        return static::of($context)->setName($name);
+    }
+}

src/Core/Request/Orders/Command/OrderSetDeliveryCustomTypeAction.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Commercetools\Core\Request\Orders\Command;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Model\CustomField\FieldContainer;
+use Commercetools\Core\Model\Type\TypeReference;
+use Commercetools\Core\Request\CustomField\Command\SetCustomTypeAction;
+
+/**
+ * @package Commercetools\Core\Request\Orders\Command
+ *
+ * @method string getAction()
+ * @method OrderSetDeliveryCustomTypeAction setAction(string $action = null)
+ * @method TypeReference getType()
+ * @method OrderSetDeliveryCustomTypeAction setType(TypeReference $type = null)
+ * @method FieldContainer getFields()
+ * @method OrderSetDeliveryCustomTypeAction setFields(FieldContainer $fields = null)
+ */
+class OrderSetDeliveryCustomTypeAction extends SetCustomTypeAction
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'action' => [static::TYPE => 'string'],
+            'type' => [static::TYPE => TypeReference::class],
+            'fields' => [static::TYPE => FieldContainer::class],
+        ];
+    }
+
+    /**
+     * @param array $data
+     * @param Context|callable $context
+     */
+    public function __construct(array $data = [], $context = null)
+    {
+        parent::__construct($data, $context);
+        $this->setAction('setDeliveryCustomType');
+    }
+
+    public static function ofTypeKey($typeKey, $context = null)
+    {
+        return static::of($context)->setType(TypeReference::ofKey($typeKey));
+    }
+}

tests/integration/Order/OrderUpdateRequestTest.php

@@ -1799,7 +1799,6 @@ function (Order $order) use ($client, $type) {
         );
     }
 
-
     public function testSetParcelCustom()
     {
         $client = $this->getApiClient();