13.0.0 release

Author: David T. Sadler

.travis.yml

@@ -4,15 +4,23 @@ php:
   - 5.5
   - 5.6
   - 7.0
+  - 7.1
   - hhvm
 
-install:
-  - if test "$TRAVIS_PHP_VERSION" == "7.0"; then echo "xdebug.overload_var_dump = 0" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini; fi
+sudo: false
+
+env:
+  - COMPOSER_OPTS=""
+  - COMPOSER_OPTS="--prefer-lowest"
 
-before_script:
-  - travis_retry composer self-update
-  - travis_retry composer install --no-interaction --prefer-source
+matrix:
+  allow_failures:
+    - php: hhvm
+  fast_finish: true
+
+install:
+  - 'if [ $(phpenv version-name) != "hhvm" ]; then echo "xdebug.overload_var_dump = 0" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini; fi'
+  - travis_retry composer update $COMPOSER_OPTS --no-interaction --prefer-source
 
 script:
   - make test
-

CHANGELOG.md

@@ -1,8 +1,55 @@
 # CHANGELOG
 
+## 13.0.0 - 2017-06-23
+
+### Features
+
+* Support Feed API version v1_beta.0.0
+* Support Taxonomy API version v1_beta.0.0.
+* Added compressResponse configuration option.
+* Added affiliateCampaignId, affiliateReferenceId and contextualLocation configuration options.
+* Added Bulk Migrate Listings operation to the Inventory service.
+* Support Metadata API version 1.1.0.
+* Added Get Shipping Rate Tables operation to the Account service. Note that eBay have not officaly released this
+  operation so it may be subject to change.
+* Link to forum at https://forum.devbay.net/c/php-sdk
+* Add GalleryURL to Trading\Types\PictureDetailsType.
+  GalleryURL was removed from the Trading API version 997. However it has been seen in the API response. If your project
+  makes use of GalleryURL be aware that eBay may stop returning this information!
+
+### Breaking changes
+
+* Support Marketing API version 1.3.0.
+* Support Marketing API version 1.2.0.
+* Support Order API version v1_beta.6.0.
+* Support Trading API version 1019.
+* Support Trading API version 1007.
+* Support Shopping API version 1007.
+* Support Browse API version v1_beta.7.0.
+* Support Browse API version v1_beta.6.0.
+* Property subDomain changed to subdomain for the Metadata\Types\ErrorDetailV3 class.
+* Properties inputRefIds and outputRefIds are repeatable for the Metadata\Types\ErrorDetailV3 class.
+
+### Fixes
+
+* Added missing shippingServiceCode property to Fulfillment\Types\ShippingFulfillment.
+* Added missing paymentMode property to Fulfillment\Types\Payment.
+* Added missing lineItemFulfillmentInstructions property to Fulfillment\Types\LineItem.
+* Added missing refunds property to Fulfillment\Types\LineItem.
+* Added missing enums to Fulfillment\Enums\OrderPaymentStatusEnum.
+* Added missing enums to Fulfillment\Enums\PaymentMethodTypeEnum.
+* Added missing priceDiscount property to Fulfillment\Types\Pricingsummary.
+* Added missing enums to PostOrder\Enums\CancelReasonEnum.
+* Added missing properties to PostOrder\Types\Error.
+* Added missing properties to PostOrder\Types\CancelDetail.
+* Added missing properties to PostOrder\Types\CancelActivityHistory.
+* Added missing property lineItems to PostOrder\Types\CancelSummary.
+* Added missing properties itemTitle, cancelQuantity to PostOrder\Types\OrderCancelLineItem.
+* Added missing enum to Order\Enums\LineItemPaymentStatusEnum.
+
 ## 12.0.1 - 2017-06-15
 
-## Fixes
+### Fixes
 
 * SDK now ignores properties in the JSON response that would normally trigger an DTS\eBaySDK\Exceptions\UnknownPropertyException exception.
 
@@ -30,7 +77,7 @@
 
 * Support Trading API version 997.
 
-## Features
+### Features
 
 * Can now use SDK to handle generation of OAUTH tokens for the RESTFul services.
 
@@ -104,7 +151,7 @@
 
 ## 5.0.0 - 2016-06-04
 
-## Doc
+### Doc
 
 * Fixed issue with JMS seriallizer. Documentation was incorrectly using @returns instead of @return.
 

Makefile

@@ -99,6 +99,10 @@ sync_bus:
 	rsync -rtvu  --delete --exclude *BaseService.php ../ebay-api-sdk-php/dist/BusinessPoliciesManagement/src/BusinessPoliciesManagement/ src/BusinessPoliciesManagement/
 	rsync -rtvu --delete --exclude /Mocks/ --exclude /Services/ ../ebay-api-sdk-php/dist/BusinessPoliciesManagement/test/BusinessPoliciesManagement/ test/BusinessPoliciesManagement/
 
+sync_feed:
+	rsync -rtvu --delete --exclude *BaseService.php ../ebay-api-sdk-php/dist/Feed/src/Feed/ src/Feed/
+	rsync -rtvu --delete --exclude /Mocks/ --exclude /Services/ ../ebay-api-sdk-php/dist/Feed/test/Feed/ test/Feed/
+
 sync_feedback:
 	rsync -rtvu  --delete --exclude *BaseService.php ../ebay-api-sdk-php/dist/Feedback/src/Feedback/ src/Feedback/
 	rsync -rtvu --delete --exclude /Mocks/ --exclude /Services/ ../ebay-api-sdk-php/dist/Feedback/test/Feedback/ test/Feedback/
@@ -145,6 +149,10 @@ sync_order:
 	rsync -rtvu --delete --exclude *BaseService.php ../ebay-api-sdk-php/dist/Order/src/Order/ src/Order/
 	rsync -rtvu --delete --exclude /Mocks/ --exclude /Services/ ../ebay-api-sdk-php/dist/Order/test/Order/ test/Order/
 
+sync_taxonomy:
+	rsync -rtvu --delete --exclude *BaseService.php ../ebay-api-sdk-php/dist/Taxonomy/src/Taxonomy/ src/Taxonomy/
+	rsync -rtvu --delete --exclude /Mocks/ --exclude /Services/ ../ebay-api-sdk-php/dist/Taxonomy/test/Taxonomy/ test/Taxonomy/
+
 sync_post:
 	rsync -rtvu --delete --exclude *BaseService.php ../ebay-api-sdk-php/dist/PostOrder/src/PostOrder/ src/PostOrder/
 	rsync -rtvu --delete --exclude /Mocks/ --exclude /Services/ ../ebay-api-sdk-php/dist/PostOrder/test/PostOrder/ test/PostOrder/

README.md

@@ -16,7 +16,7 @@ This is a personal project that has been developed by me, [David T. Sadler](http
 
   - [User Guides](http://devbay.net/sdk/guides/) - Getting started guide and in-depth information.
   - [Examples](https://github.com/davidtsadler/ebay-sdk-examples) - Several examples of using the SDK.
-  - [Google Group](https://groups.google.com/forum/#!forum/ebay-sdk-php) - Join for support with the SDK.
+  - [Forum](https://forum.devbay.net/c/php-sdk) - Join for support with the SDK.
   - [@devbaydotnet](https://twitter.com/devbaydotnet) - Follow on Twitter for announcements of releases, important changes and so on.
 
 ## Requirements

docs/_templates/social.html

@@ -14,7 +14,7 @@ <h2>Community</h2>
       <a href="https://twitter.com/devbaydotnet" class="twitter-follow-button" data-show-count="false" data-lang="en">Follow @devbaydotnet</a>
       <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
       <br/>
-      <a href="https://groups.google.com/forum/#!forum/ebay-sdk-php">Google Group</a> - Join for support with the SDK.
+      <a href="https://forum.devbay.net/c/php-sdk">Forum</a> - Join for support with the SDK.
       <br/>
       <a title="Recent Posts (RSS)" href="http://devbay.net/blog/rss.xml">Recent Blog Posts</a>
     </div>

docs/guide/configuration.rst

@@ -24,6 +24,22 @@ Refer to the :doc:`basic usage guide </getting-started/basic-usage>` for informa
 
     Some configuration options are only applicable to certain services. Where this is the case the services will be noted in the documentation for the configuration option.
 
+affiliateCampaignId
+~~~~~~~~~~~~~~~~~~~
+
+:Type: ``string``
+:Services: ``Browse``
+
+Affiliate parameter for applications that have registered on the `eBay Partner Network <https://www.ebaypartnernetwork.com/>`_.
+
+affiliateReferenceId
+~~~~~~~~~~~~~~~~~~~~
+
+:Type: ``string``
+:Services: ``Browse``
+
+Affiliate parameter for applications that have registered on the `eBay Partner Network <https://www.ebaypartnernetwork.com/>`_.
+
 affiliateUserId
 ~~~~~~~~~~~~~~~
 
@@ -77,7 +93,7 @@ authorization
 ~~~~~~~~~~~~~
 
 :Type: ``string``
-:Services: ``Account``, ``Analytics``, ``Browse``, ``Fulfillment``, ``Inventory``, ``Marketing``, ``Metadata``, ``Order``, ``Trading``
+:Services: ``Account``, ``Analytics``, ``Browse``, ``Feed``, ``Fulfillment``, ``Inventory``, ``Marketing``, ``Metadata``, ``Order``, ``Trading``, ``Taxonomy``
 :Required: true, except for the Trading service.
 
 All eBay RESTful services use OAuth 2.0 access tokens for application authentication and user authorization. The token passed via ``authorization`` can be either an User or Application token. You must ensure that the token has the require scope for the operation that you are calling.
@@ -114,6 +130,29 @@ The Trading service is different to other services in that the  Auth'n'auth toke
     $request->RequesterCredentials = new Types\CustomSecurityHeaderType();
     $request->RequesterCredentials->eBayAuthToken = '<AUTH TOKEN>';
 
+compressResponse
+~~~~~~~~~~~~~~~~
+
+:Type: ``bool``
+
+Some API responses can return a very large payload. Pass ``true`` to submit all requests with the HTTP header ``Accept-Encoding: application/gzip``. Note that not all API operations will return a gzip response.
+
+contextualLocation
+~~~~~~~~~~~~~~~~~~
+
+:Type: ``string``
+:Services: ``Browse``
+
+Required by some operations in the Browse service. Increases the accuracy of the estimated delivery window information and is needed for the calculated shipping information. When using this header, you must include the country code and you also include the zip code if zip codes are used in that country.
+
+.. code-block:: php
+
+    use DTS\eBaySDK\Browse\Services\BrowseService;
+
+    $service = new BrowseService([
+      'contextualLocation' => 'country=US,zip=19406'
+    ]);
+
 credentials
 ~~~~~~~~~~~
 
@@ -402,7 +441,7 @@ marketplaceId
 ~~~~~~~~~~~~~
 
 :Type: ``string``
-:Services: ``Account``, ``Analytics``, ``Browse``, ``Fulfillment``, ``Inventory``, ``Marketing``, ``Metadata``, ``Order``
+:Services: ``Account``, ``Analytics``, ``Browse``, ``Feed``, ``Fulfillment``, ``Inventory``, ``Marketing``, ``Metadata``, ``Order``, ``Taxonomy``
 
 The string identifier for the eBay site your API requests are to be sent to. For example, you would pass the value ``EBAY-UK`` to specify the eBay UK site.
 
@@ -428,15 +467,15 @@ requestLanguage
 ~~~~~~~~~~~~~~~
 
 :Type: ``string``
-:Services: ``Account``, ``Analytics``, ``Browse``, ``Fulfillment``, ``Inventory``, ``Marketing``, ``Metadata``, ``Order``
+:Services: ``Account``, ``Analytics``, ``Browse``, ``Feed``, ``Fulfillment``, ``Inventory``, ``Marketing``, ``Metadata``, ``Order``, ``Taxonomy``
 
 This configuration option will set the ``Content-Language`` HTTP header for the request.
 
 responseLanguage
 ~~~~~~~~~~~~~~~~
 
 :Type: ``string``
-:Services: ``Account``, ``Analytics``, ``Browse``, ``Fulfillment``, ``Inventory``, ``Marketing``, ``Metadata``, ``Order``
+:Services: ``Account``, ``Analytics``, ``Browse``, ``Feed``, ``Fulfillment``, ``Inventory``, ``Marketing``, ``Metadata``, ``Order``, ``Taxonomy``
 
 This configuration option will set the ``Accept-Language`` HTTP header for the request.
 

docs/index.rst

@@ -13,7 +13,7 @@ The `eBay SDK for PHP <https://github.com/davidtsadler/ebay-sdk-php>`_ enables P
 External links: `API Docs <http://devbay.net/sdk/guides/api>`_
 | `GitHub <https://github.com/davidtsadler/ebay-sdk-php>`_
 | `Twitter <https://twitter.com/devbaydotnet>`_
-| `Support Group <https://groups.google.com/forum/#!forum/ebay-sdk-php>`_
+| `Forum <https://forum.devbay.net/c/php-sdk>`_
 | `Packagist <https://packagist.org/packages/dts/ebay-sdk-php>`_
 
 

src/Account/Services/AccountService.php

@@ -178,6 +178,16 @@ class AccountService extends \DTS\eBaySDK\Account\Services\AccountBaseService
             'params' => [
             ]
         ],
+        'GetShippingRateTables' => [
+            'method' => 'POST',
+            'resource' => 'rate_table',
+            'responseClass' => '\DTS\eBaySDK\Account\Types\GetShippingRateTablesRestResponse',
+            'params' => [
+                'country_code' => [
+                    'valid' => ['string']
+                ]
+            ]
+        ],
         'CreateAReturnPolicy' => [
             'method' => 'POST',
             'resource' => 'return_policy',
@@ -594,6 +604,24 @@ public function optOutOfProgramAsync(\DTS\eBaySDK\Account\Types\OptOutOfProgramR
         return $this->callOperationAsync('OptOutOfProgram', $request);
     }
 
+    /**
+     * @param \DTS\eBaySDK\Account\Types\GetShippingRateTablesRestRequest $request
+     * @return \DTS\eBaySDK\Account\Types\GetShippingRateTablesRestResponse
+     */
+    public function getShippingRateTables(\DTS\eBaySDK\Account\Types\GetShippingRateTablesRestRequest $request)
+    {
+        return $this->getShippingRateTablesAsync($request)->wait();
+    }
+
+    /**
+     * @param \DTS\eBaySDK\Account\Types\GetShippingRateTablesRestRequest $request
+     * @return \GuzzleHttp\Promise\PromiseInterface
+     */
+    public function getShippingRateTablesAsync(\DTS\eBaySDK\Account\Types\GetShippingRateTablesRestRequest $request)
+    {
+        return $this->callOperationAsync('GetShippingRateTables', $request);
+    }
+
     /**
      * @param \DTS\eBaySDK\Account\Types\CreateAReturnPolicyRestRequest $request
      * @return \DTS\eBaySDK\Account\Types\CreateAReturnPolicyRestResponse

src/Account/Types/GetShippingRateTablesRestRequest.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * DO NOT EDIT THIS FILE!
+ *
+ * This file was automatically generated from external sources.
+ *
+ * Any manual change here will be lost the next time the SDK
+ * is updated. You've been warned!
+ */
+
+namespace DTS\eBaySDK\Account\Types;
+
+/**
+ *
+ * @property string $country_code
+ */
+class GetShippingRateTablesRestRequest extends \DTS\eBaySDK\Types\BaseType
+{
+    /**
+     * @var array Properties belonging to objects of this class.
+     */
+    private static $propertyTypes = [
+        'country_code' => [
+            'type' => 'string',
+            'repeatable' => false,
+            'attribute' => false,
+            'elementName' => 'country_code'
+        ]
+    ];
+
+    /**
+     * @param array $values Optional properties and values to assign to the object.
+     */
+    public function __construct(array $values = [])
+    {
+        list($parentValues, $childValues) = self::getParentValues(self::$propertyTypes, $values);
+
+        parent::__construct($parentValues);
+
+        if (!array_key_exists(__CLASS__, self::$properties)) {
+            self::$properties[__CLASS__] = array_merge(self::$properties[get_parent_class()], self::$propertyTypes);
+        }
+
+        $this->setValues(__CLASS__, $childValues);
+    }
+}

src/Account/Types/GetShippingRateTablesRestResponse.php

@@ -0,0 +1,65 @@
+<?php
+/**
+ * DO NOT EDIT THIS FILE!
+ *
+ * This file was automatically generated from external sources.
+ *
+ * Any manual change here will be lost the next time the SDK
+ * is updated. You've been warned!
+ */
+
+namespace DTS\eBaySDK\Account\Types;
+
+use DTS\eBaySDK\StatusCodeTrait;
+use DTS\eBaySDK\HttpHeadersTrait;
+
+/**
+ *
+ * @property \DTS\eBaySDK\Account\Types\ErrorDetailV3[] $errors
+ * @property \DTS\eBaySDK\Account\Types\ErrorDetailV3[] $warnings
+ */
+class GetShippingRateTablesRestResponse extends \DTS\eBaySDK\Account\Types\RateTableResponse
+{
+    use StatusCodeTrait;
+    use HttpHeadersTrait;
+
+    /**
+     * @var array Properties belonging to objects of this class.
+     */
+    private static $propertyTypes = [
+        'errors' => [
+            'type' => 'DTS\eBaySDK\Account\Types\ErrorDetailV3',
+            'repeatable' => true,
+            'attribute' => false,
+            'elementName' => 'errors'
+        ],
+        'warnings' => [
+            'type' => 'DTS\eBaySDK\Account\Types\ErrorDetailV3',
+            'repeatable' => true,
+            'attribute' => false,
+            'elementName' => 'warnings'
+        ]
+    ];
+
+    /**
+     * @param array $values Optional properties and values to assign to the object.
+     * @param int $statusCode Status code
+     * @param array $headers HTTP Response headers.
+     */
+    public function __construct(array $values = [], $statusCode = 200, array $headers = [])
+    {
+        list($parentValues, $childValues) = self::getParentValues(self::$propertyTypes, $values);
+
+        parent::__construct($parentValues);
+
+        if (!array_key_exists(__CLASS__, self::$properties)) {
+            self::$properties[__CLASS__] = array_merge(self::$properties[get_parent_class()], self::$propertyTypes);
+        }
+
+        $this->setValues(__CLASS__, $childValues);
+
+        $this->statusCode = (int)$statusCode;
+
+        $this->setHeaders($headers);
+    }
+}