feat(ShippingInfoImportDraft): add ShippingInfoImportDraft representation

closes #449

Author: nikossvnk

src/Core/Model/Cart/ShippingInfo.php

@@ -5,18 +5,19 @@
 
 namespace Commercetools\Core\Model\Cart;
 
-use Commercetools\Core\Model\Common\JsonObject;
 use Commercetools\Core\Model\Common\Money;
 use Commercetools\Core\Model\Order\DeliveryCollection;
+use Commercetools\Core\Model\Order\ShippingInfoImportDraft;
 use Commercetools\Core\Model\ShippingMethod\ShippingMethodReference;
 use Commercetools\Core\Model\ShippingMethod\ShippingRate;
-use Commercetools\Core\Model\TaxCategory\TaxCategory;
 use Commercetools\Core\Model\TaxCategory\TaxRate;
 use Commercetools\Core\Model\Common\TaxedItemPrice;
+use Commercetools\Core\Model\TaxCategory\TaxCategoryReference;
 
 /**
  * @package Commercetools\Core\Model\Cart
  * @link https://docs.commercetools.com/http-api-projects-carts.html#shippinginfo
+ *
  * @method string getShippingMethodName()
  * @method ShippingInfo setShippingMethodName(string $shippingMethodName = null)
  * @method Money getPrice()
@@ -25,37 +26,26 @@
  * @method ShippingInfo setShippingRate(ShippingRate $shippingRate = null)
  * @method TaxRate getTaxRate()
  * @method ShippingInfo setTaxRate(TaxRate $taxRate = null)
- * @method TaxCategory getTaxCategory()
- * @method ShippingInfo setTaxCategory(TaxCategory $taxCategory = null)
+ * @method TaxCategoryReference getTaxCategory()
+ * @method ShippingInfo setTaxCategory(TaxCategoryReference $taxCategory = null)
  * @method ShippingMethodReference getShippingMethod()
  * @method ShippingInfo setShippingMethod(ShippingMethodReference $shippingMethod = null)
  * @method DeliveryCollection getDeliveries()
  * @method ShippingInfo setDeliveries(DeliveryCollection $deliveries = null)
- * @method TaxedItemPrice getTaxedPrice()
- * @method ShippingInfo setTaxedPrice(TaxedItemPrice $taxedPrice = null)
  * @method DiscountedLineItemPrice getDiscountedPrice()
  * @method ShippingInfo setDiscountedPrice(DiscountedLineItemPrice $discountedPrice = null)
  * @method string getShippingMethodState()
  * @method ShippingInfo setShippingMethodState(string $shippingMethodState = null)
+ * @method TaxedItemPrice getTaxedPrice()
+ * @method ShippingInfo setTaxedPrice(TaxedItemPrice $taxedPrice = null)
  */
-class ShippingInfo extends JsonObject
+class ShippingInfo extends ShippingInfoImportDraft
 {
-    const SHIPPING_METHOD_MATCH = 'MatchesCart';
-    const SHIPPING_METHOD_DONT_MATCH = 'DoesNotMatchCart';
-
     public function fieldDefinitions()
     {
-        return [
-            'shippingMethodName' => [static::TYPE => 'string'],
-            'price' => [static::TYPE => Money::class],
-            'shippingRate' => [static::TYPE => ShippingRate::class],
-            'taxedPrice' => [static::TYPE => TaxedItemPrice::class],
-            'taxRate' => [static::TYPE => TaxRate::class],
-            'taxCategory' => [static::TYPE => TaxCategory::class],
-            'shippingMethod' => [static::TYPE => ShippingMethodReference::class],
-            'deliveries' => [static::TYPE => DeliveryCollection::class],
-            'discountedPrice' => [static::TYPE => DiscountedLineItemPrice::class],
-            'shippingMethodState' => [static::TYPE => 'string']
-        ];
+        $fields = parent::fieldDefinitions();
+        $fields['taxedPrice'] = [static::TYPE => TaxedItemPrice::class];
+
+        return $fields;
     }
 }

src/Core/Model/Order/ImportOrder.php

@@ -49,8 +49,8 @@
  * @method ImportOrder setShipmentState(string $shipmentState = null)
  * @method string getPaymentState()
  * @method ImportOrder setPaymentState(string $paymentState = null)
- * @method ShippingInfo getShippingInfo()
- * @method ImportOrder setShippingInfo(ShippingInfo $shippingInfo = null)
+ * @method ShippingInfoImportDraft getShippingInfo()
+ * @method ImportOrder setShippingInfo(ShippingInfoImportDraft $shippingInfo = null)
  * @method DateTimeDecorator getCompletedAt()
  * @method ImportOrder setCompletedAt(DateTime $completedAt = null)
  * @method CustomFieldObjectDraft getCustom()
@@ -85,7 +85,7 @@ public function fieldDefinitions()
             'orderState' => [static::TYPE => 'string'],
             'shipmentState' => [static::TYPE => 'string'],
             'paymentState' => [static::TYPE => 'string'],
-            'shippingInfo' => [static::TYPE => ShippingInfo::class],
+            'shippingInfo' => [static::TYPE => ShippingInfoImportDraft::class],
             'completedAt' => [
                 static::TYPE => DateTime::class,
                 static::DECORATOR => DateTimeDecorator::class

src/Core/Model/Order/ShippingInfoImportDraft.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Model\Order;
+
+use Commercetools\Core\Model\Cart\DiscountedLineItemPrice;
+use Commercetools\Core\Model\Common\JsonObject;
+use Commercetools\Core\Model\Common\Money;
+use Commercetools\Core\Model\ShippingMethod\ShippingMethodReference;
+use Commercetools\Core\Model\ShippingMethod\ShippingRate;
+use Commercetools\Core\Model\TaxCategory\TaxCategoryReference;
+use Commercetools\Core\Model\TaxCategory\TaxRate;
+
+/**
+ * @package Commercetools\Core\Model\Order
+ * @link https://docs.commercetools.com/http-api-projects-orders-import.html#shippinginfoimportdraft
+ *
+ * @method string getShippingMethodName()
+ * @method ShippingInfoImportDraft setShippingMethodName(string $shippingMethodName = null)
+ * @method Money getPrice()
+ * @method ShippingInfoImportDraft setPrice(Money $price = null)
+ * @method ShippingRate getShippingRate()
+ * @method ShippingInfoImportDraft setShippingRate(ShippingRate $shippingRate = null)
+ * @method TaxRate getTaxRate()
+ * @method ShippingInfoImportDraft setTaxRate(TaxRate $taxRate = null)
+ * @method TaxCategoryReference getTaxCategory()
+ * @method ShippingInfoImportDraft setTaxCategory(TaxCategoryReference $taxCategory = null)
+ * @method ShippingMethodReference getShippingMethod()
+ * @method ShippingInfoImportDraft setShippingMethod(ShippingMethodReference $shippingMethod = null)
+ * @method DeliveryCollection getDeliveries()
+ * @method ShippingInfoImportDraft setDeliveries(DeliveryCollection $deliveries = null)
+ * @method DiscountedLineItemPrice getDiscountedPrice()
+ * @method ShippingInfoImportDraft setDiscountedPrice(DiscountedLineItemPrice $discountedPrice = null)
+ * @method string getShippingMethodState()
+ * @method ShippingInfoImportDraft setShippingMethodState(string $shippingMethodState = null)
+ */
+class ShippingInfoImportDraft extends JsonObject
+{
+    const SHIPPING_METHOD_MATCH = 'MatchesCart';
+    const SHIPPING_METHOD_DONT_MATCH = 'DoesNotMatchCart';
+
+    public function fieldDefinitions()
+    {
+        return [
+            'shippingMethodName' => [static::TYPE => 'string'],
+            'price' => [static::TYPE => Money::class],
+            'shippingRate' => [static::TYPE => ShippingRate::class],
+            'taxRate' => [static::TYPE => TaxRate::class],
+            'taxCategory' => [static::TYPE => TaxCategoryReference::class],
+            'shippingMethod' => [static::TYPE => ShippingMethodReference::class],
+            'deliveries' => [static::TYPE => DeliveryCollection::class],
+            'discountedPrice' => [static::TYPE => DiscountedLineItemPrice::class],
+            'shippingMethodState' => [static::TYPE => 'string'],
+        ];
+    }
+}

src/Core/Model/ShippingMethod/ShippingMethodReference.php

@@ -35,4 +35,14 @@ public static function ofId($id, $context = null)
     {
         return static::ofTypeAndId(static::TYPE_SHIPPING_METHOD, $id, $context);
     }
+
+    /**
+     * @param $key
+     * @param Context|callable $context
+     * @return ShippingMethodReference
+     */
+    public static function ofKey($key, $context = null)
+    {
+        return static::ofTypeAndKey(static::TYPE_SHIPPING_METHOD, $key, $context);
+    }
 }

src/Core/Model/TaxCategory/TaxCategoryReference.php

@@ -36,4 +36,14 @@ public static function ofId($id, $context = null)
     {
         return static::ofTypeAndId(static::TYPE_TAX_CATEGORY, $id, $context);
     }
+
+    /**
+     * @param $key
+     * @param Context|callable $context
+     * @return TaxCategoryReference
+     */
+    public static function ofKey($key, $context = null)
+    {
+        return static::ofTypeAndKey(static::TYPE_TAX_CATEGORY, $key, $context);
+    }
 }