12.0.0 release

CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 12.0.0 - 2017-05-23
+
+### Fixes
+
+* Renamed state to cancelState and status to cancelStatus.
+  This matches the properties returned by the API.
+* Changed type from integer to string for ItemEligibilityResult::itemId and ItemEligibilityResult::transactionId
+* Added missing subdomain property to PostOrder\Error.
+* Added missing discountAmount property to Fulfillment\DeliveryCost.
+
 ## 11.0.0 - 2017-03-20
 
 ### Breaking changes

docs/guide/migration.rst

@@ -193,7 +193,7 @@ The pre-version 1 SDK would throw a ``DTS\eBaySDK\Exceptions\UnknownConfiguratio
         'non-existent' => true
     ]);
 
-HttpClient paramter and method has been removed
+HttpClient parameter and method have been removed
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Version 1 introduced the new :ref:`httpHandler <httpHandler>` configuration option which replaced both the ``httpClient`` parameter and method.

src/Fulfillment/Types/DeliveryCost.php

@@ -15,6 +15,7 @@
  * @property \DTS\eBaySDK\Fulfillment\Types\Amount $importCharges
  * @property \DTS\eBaySDK\Fulfillment\Types\Amount $shippingCost
  * @property \DTS\eBaySDK\Fulfillment\Types\Amount $shippingIntermediationFee
+ * @property \DTS\eBaySDK\Fulfillment\Types\Amount $discountAmount
  */
 class DeliveryCost extends \DTS\eBaySDK\Types\BaseType
 {
@@ -39,7 +40,13 @@ class DeliveryCost extends \DTS\eBaySDK\Types\BaseType
             'repeatable' => false,
             'attribute' => false,
             'elementName' => 'shippingIntermediationFee'
-        ]
+        ],
+        'discountAmount' => [
+            'type' => 'DTS\eBaySDK\Fulfillment\Types\Amount',
+            'repeatable' => false,
+            'attribute' => false,
+            'elementName' => 'discountAmount'
+        ],
     ];
 
     /**

src/PostOrder/Types/CancelSummary.php

@@ -25,8 +25,8 @@
  * @property \DTS\eBaySDK\PostOrder\Types\Amount $requestRefundAmount
  * @property \DTS\eBaySDK\PostOrder\Types\DateTime $sellerResponseDueDate
  * @property \DTS\eBaySDK\PostOrder\Types\DateTime $shipmentDate
- * @property string $state
- * @property string $status
+ * @property string $cancelState
+ * @property string $cancelStatus
  */
 class CancelSummary extends \DTS\eBaySDK\Types\BaseType
 {
@@ -112,17 +112,17 @@ class CancelSummary extends \DTS\eBaySDK\Types\BaseType
             'attribute' => false,
             'elementName' => 'shipmentDate'
         ],
-        'state' => [
+        'cancelState' => [
             'type' => 'string',
             'repeatable' => false,
             'attribute' => false,
-            'elementName' => 'state'
+            'elementName' => 'cancelState'
         ],
-        'status' => [
+        'cancelStatus' => [
             'type' => 'string',
             'repeatable' => false,
             'attribute' => false,
-            'elementName' => 'status'
+            'elementName' => 'cancelStatus'
         ]
     ];
 

src/PostOrder/Types/Error.php

@@ -14,6 +14,7 @@
  *
  * @property integer $errorId
  * @property string $domain
+ * @property string $subdomain
  * @property string $severity
  * @property string $category
  * @property string $message
@@ -39,6 +40,12 @@ class Error extends \DTS\eBaySDK\Types\BaseType
             'attribute' => false,
             'elementName' => 'domain'
         ],
+        'subdomain' => [
+            'type' => 'string',
+            'repeatable' => false,
+            'attribute' => false,
+            'elementName' => 'subdomain'
+        ],
         'severity' => [
             'type' => 'string',
             'repeatable' => false,

src/PostOrder/Types/ItemEligibilityResult.php

@@ -14,8 +14,8 @@
  *
  * @property boolean $eligible
  * @property \DTS\eBaySDK\PostOrder\Enums\EligibilityFailureReasonEnum[] $failureReason
- * @property integer $itemId
- * @property integer $transactionId
+ * @property string $itemId
+ * @property string $transactionId
  */
 class ItemEligibilityResult extends \DTS\eBaySDK\Types\BaseType
 {
@@ -36,13 +36,13 @@ class ItemEligibilityResult extends \DTS\eBaySDK\Types\BaseType
             'elementName' => 'failureReason'
         ],
         'itemId' => [
-            'type' => 'integer',
+            'type' => 'string',
             'repeatable' => false,
             'attribute' => false,
             'elementName' => 'itemId'
         ],
         'transactionId' => [
-            'type' => 'integer',
+            'type' => 'string',
             'repeatable' => false,
             'attribute' => false,
             'elementName' => 'transactionId'

src/Sdk.php

@@ -30,7 +30,7 @@
  */
 class Sdk
 {
-    const VERSION = '11.0.0';
+    const VERSION = '12.0.0';
 
     /**
      * @var bool Controls if the SDK should enforce strict types

test/property_fixes/PropertyFixesTest.php

@@ -0,0 +1,55 @@
+<?php
+namespace DTS\eBaySDK\Types\Test;
+
+use DTS\eBaySDK as Sdk;
+/**
+ * These tests are to cover where we have corrected
+ * the property names of various classes.
+ * These names have been incorrectly named in the documentation.
+ * The names used for the properties are now taken from the actual response from the API.
+ */
+class PropertyFixesTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * Incorrect documentation https://developer.ebay.com/Devzone/post-order/types/CancelSummary.html
+     * Example of correct property names returned in the API https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation_search__get.html#Output
+     */
+    public function testCancelSummary()
+    {
+        $obj = new Sdk\PostOrder\Types\CancelSummary();
+
+        $this->assertEquals(null, $obj->cancelState);
+        $this->assertEquals(null, $obj->cancelStatus);
+    }
+
+    /**
+     * Incorrect documentation https://developer.ebay.com/Devzone/post-order/types/ItemEligibilityResult.html
+     * Example of correct property names returned in the API https://developer.ebay.com/Devzone/post-order/post-order_v2_cancellation__post.html#Samples
+     */
+    public function testItemEligibilityResult()
+    {
+        $obj = new Sdk\PostOrder\Types\ItemEligibilityResult();
+
+        $obj->itemId = '123';
+        $this->assertInternalType('string', $obj->itemId);
+
+        $obj->transactionId = '123';
+        $this->assertInternalType('string', $obj->transactionId);
+    }
+
+    public function testError()
+    {
+        $obj = new Sdk\PostOrder\Types\Error();
+
+        $obj->subdomain = '123';
+        $this->assertInternalType('string', $obj->subdomain);
+    }
+
+    public function testDeliveryCost()
+    {
+        $obj = new Sdk\Fulfillment\Types\DeliveryCost();
+
+        $obj->discountAmount = new Sdk\Fulfillment\Types\Amount();
+        $this->assertInstanceOf('\DTS\eBaySDK\Fulfillment\Types\Amount', $obj->discountAmount);
+    }
+}