Merge pull request #31 from keepacom/feature/api_catchup

- catchup with java 1.71

Author: keepacom

.gitignore

@@ -2,6 +2,6 @@
 composer.phar
 /vendor/
 .phpunit*
-# Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
+*.log
+*.phar
+*.txt

.travis.yml

@@ -19,4 +19,4 @@ script:
 - phpunit -c phpunit.xml
 env:
   global:
-  - secure: mcVBUZ4dyDjB2PmDgfUoyiIc3WH1NbpVVRTP+xoezbNnxGmOCKoMUqwAx87+pawJd/zLoyCCHsbCnZIKvSCgkBaBj8hMv3dkT645x/4prDRbrUftx4xfg/iU80VvwfrNIzpYs20ujyTbXM5cLTDat5CkR15Ey1WeOCXjscEfjWZrmFfYxg6gmDxDVfUS/E3M9b2rfiSUQ5mErNRoD2+olpXGBVCFfZVtUeWMcd7k8gmyBDws5gxueJcOmgP39AtmJBr/s3PKLvNbuEfKNnccieL0dgGVCWKgAYSBwQMHPN9j2My6E0kY99lvvAz8Z6ymD4PP7pLIYCk9xcNkDwmtKx68MMXxPhx9i9TygOJ82bw3w+Be6gA1l+ZHNwF7xM3U4ZGXiXTMFI41UBtYcvGxMQvrP2LZeHtB94+xl7nxxXMFnQusv7o0NBnpOAp8UY4L6kVwtVmcLXLdUGxEiKBtPhPE1dwhvm6G0uoyM9kNsi0brJgenOOmhVYbRLMX3DgZeRs9FBe5hRGQ+3Vqlzwsk11U7sMNeZoXcxLlrslUQfhW2861D0Hjf1o0y0hHwuDGldaaRFn1cMO/4RPj00+arFSU1PJooCHdUeqAj95Yr1/7iABidZeyX0cnyLgZflyBgihYOOlIib7NRTdYbF4HaHke32w9xkivVm3KBywsYsY=
+  - secure: LGXc3k+Iy8nJbA+xllNk6FbGdb6i4tINU/gCfFlVIamVTQW4IGCfPajPBj5ulsr75YKPoeeya21zwr9nnq3nmBwCppVQHiWBBZDCnaFp8BTTyd6K3q8pJyjWikHJah2UvBUB+XbpzDv7a426tKha2rZWwnBnSnjxrRg0FRNkKvBbm6TvFPHrxNc6RPXpjk3AbRfKgWhFsPJodt4hEU2Pl01HC7eBSs9SgaP6cq5dnx078y4kJVGL10o4N0fGpMPrm7T+NKBukz0FxvqYW7U/Jxmzh+qBRNdx7KymRPBEPNi9ULW5tFFNMwICcmpVIoeoYPV04jNFT+X6A6cgc5jHivAnhKeDsldiGMKuCq24a43P3LmLpLaTs+CxYI/bw9izoSPPQuui2pBDuUwPlvJfqDRTDRGYGFdpEcTofjYkvz1D5tcNx3HkoTOBnXsdsV1pHKYgmlglnx30gBJLIw+sSd1T6Bpuub3qhw0932wfZf7MYwJBiJnS6kESWwmstCTVhZE5aaw/NCyXuS4PVvomxBkbJoh8jNpIKf47mLGPmB++/hGQhNjM9scMO/4EWcu+gqDgcSF8Erh3HyVcQ5WuCwukEZyq8FyaAcJLQucArOFb2IbCH02xIh/pJLQupr4WbJZdx3CqF9F4SMa8BxHlz3zlL598/6emLT6+Onx5Q20=

src/API/Request.php

@@ -264,6 +264,57 @@ public static function getProductRequest($domainID, $offers, $statsStartDate, $s
     }
 
 
+    /**
+     * Retrieves the product for the specified ASIN and domain.
+     * If our last update is older than 1 hour it will be automatically refreshed before delivered to you to ensure you get near to real-time pricing data.
+     *
+     * @param $domainID int Amazon locale of the product {@link AmazonLocale}
+     * @param $offers int If specified (= not null) Determines the number of marketplace offers to retrieve. <b>Not available for Amazon China.</b>
+     * @param $statsStartDate string Must ISO8601 coded date (with or without time in UTC). Example: 2015-12-31 or 2015-12-31T14:51Z. If specified (= not null) the product object will have a stats field with quick access to current prices, min/max prices and the weighted mean values in the interval specified statsStartDate to statsEndDate. .
+     * @param $statsEndDate string the end of the stats interval. See statsStartDate.
+     * @param $buybox bool If specified and true the product and statistics object will include all available buy box related data
+     * @param $update int If the product's last refresh is older than <i>update</i>-hours force a refresh. Use this to speed up requests if up-to-date data is not required. Might cost an extra token if 0 (= live data). Default 1.
+     * @param $history bool Whether or not to include the product's history data (csv field). If you do not evaluate the csv field set to false to speed up the request and reduce traffic.
+     * @param $rental bool If true the rental price will be collected when available. <b>Can only be used in conjunction with the offers parameter.  Not available for Amazon China.
+     * @param $rating bool If true the product object will include our existing RATING and COUNT_REVIEWS history of the csv field, regardless if the offers parameter is used <b>Not available for Amazon China.
+     * @param $fbafees bool If true fbaFees will be retrieved. <b>Can only be used in conjunction with the offers parameter. Not available for Amazon China, India and Brazil.
+     * @param $onlyLiveOffers bool
+     * @param $days int If specified and has positive value X the product object will limit all historical data to the recent X days.
+     * @param $asins string[] ASINs to request, must contain between 1 and 100 ASINs - or max 20 ASINs if the offers parameter is used.
+     * @param array $params Array of additional request parameters
+     * @return Request ready to send request.
+     */
+    public static function getDetailedProductRequest($domainID, $offers, $statsStartDate, $statsEndDate, $buybox, $update, $history, $rental, $rating, $fbafees, $onlyLiveOffers, $days, array $asins, $params = null)
+    {
+        $r = new Request();
+        $r->path = "product";
+
+        if (!empty($asins))
+            $r->parameter["asin"] = implode(",", $asins);
+
+        $r->parameter["domain"] = $domainID;
+        $r->parameter["buybox"] = $buybox ? "1" : "0";
+        $r->parameter["update"] = $update;
+        $r->parameter["rental"] = $rental ? "1" : "0";
+        $r->parameter["rating"] = $rating ? "1" : "0";
+        $r->parameter["fbafees"] = $fbafees ? "1" : "0";
+        $r->parameter["only-live-offers"] = $onlyLiveOffers ? "1" : "0";
+        $r->parameter["history"] = $history ? "1" : "0";
+
+        if ($statsStartDate != null && $statsEndDate != null)
+            $r->parameter["stats"] = $statsStartDate . "," . $statsEndDate;
+
+        if ($offers != null && $offers > 0)
+            $r->parameter["offers"] = $offers;
+
+        if ($params) {
+            foreach ($params as $key => $val) {
+                $r->parameter[$key] = $val;
+            }
+        }
+        return $r;
+    }
+
     /**
      * Add tracking to your list.
      *

src/KeepaAPI.php

@@ -17,7 +17,7 @@ class KeepaAPI
     private $userAgent = null;
     private $serializer = null;
     private $httpClient = null;
-    private static $VERSION = "2.0.0";
+    private static $VERSION = "2.0.1";
 
     public function __construct($accessKey)
     {

src/helper/AvailabilityType.php

@@ -9,9 +9,18 @@ class AvailabilityType
 {
     const NO_OFFER = -1;
     const NOW = 0;
-    const FUTURE = 1;
+    const PREORDERABLE = 1;
     const UNKNOWN = 2;
-    const OTHER = 3;
+
+    /**
+     * Amazon offer is currently not in stock but will be in the future - back-order
+     */
+    const BACKORDERABLE = 3;
+
+    /**
+     * Amazon offer availability is delay. Check availabilityAmazonDelay field for details.
+     */
+    const DELAYED = 4;
 
     public function __construct($i, $price, $deal, $shipping, $extra)
     {

src/helper/HazardousMaterialType.php

@@ -0,0 +1,28 @@
+<?php
+namespace Keepa\helper;
+
+/**
+ * Contains Rental information.
+ */
+class RentalObject
+{
+    /**
+     * @var int
+     */
+    public $initialPrice = -1;
+
+    /**
+     * @var int
+     */
+    public $shortExtnPrice = -1;
+
+    /**
+     * @var int
+     */
+    public $longExtnPrice = -1;
+
+    /**
+     * @var int
+     */
+    public $fullPrice = -1;
+}

src/helper/RentalObject.php

@@ -13,11 +13,9 @@ class AmazonLocale
     const FR = 4;
     const JP = 5;
     const CA = 6;
-    const CN = 7;
+    const RESERVED2 = 7;
     const IT = 8;
     const ES = 9;
     const IN = 10;
     const MX = 11;
-    const BR = 12;
-    const AU = 13;
 }

src/objects/AmazonLocale.php

@@ -315,8 +315,7 @@ class Product
     public $lastEbayUpdate = 0;
 
     /**
-     * Availability of the Amazon offer {@link Product.AvailabilityType}. If Amazon offer exists but does not hold the buy box the value will be 2 (unknown).
-     * To request the Amazon availability in such cases the offers parameter is required.
+     * Availability of the Amazon offer {@link Product.AvailabilityType}.
      * @var int
      */
     public $availabilityAmazon = -1;
@@ -339,6 +338,43 @@ class Product
      */
     public $salesRankReferenceHistory = null;
 
+    /**
+     * If the product is listed in the launchpad
+     * @var boolean|null
+     */
+    public $launchpad = false;
+
+    /**
+     * Rental details
+     * @var string|null
+     */
+    public $rentalDetails = false;
+
+    /**
+     * Rental details
+     * @var \Keepa\helper\RentalObject|null
+     */
+    public $rentalPrices = false;
+
+    /**
+     * Rental seller id
+     * @var string|null
+     */
+    public $rentalSellerId = null;
+
+    /**
+     * Amazon offer shipping delay. Integer array with 2 entries, indicating min and max shipping delay in hours.
+     * @var int[]|null
+     */
+    public $availabilityAmazonDelay = null;
+
+    /**
+     * Audience rating. The rating suggests the age for which the media is appropriate.
+     * Example: PG-13 (Parents Strongly Cautioned)
+     * @var string|null
+     */
+    public $audienceRating = null;
+
     /**
      * States the last time we have updated the product rating and review count, in Keepa Time minutes.<br>
      * Use {@link KeepaTime#keepaMinuteToUnixInMillis(int)} (long)} to get an uncompressed timestamp (Unix epoch time).

src/objects/Product.php

@@ -250,12 +250,18 @@ class Stats
      */
 	public $buyBoxMaxOrderQuantity = null;
 
-	/**
+    /**
      * The availability message of the buy box. null if not available.
      * Example: “In Stock.”
      * @var string|null
      */
-	public $buyBoxAvailabilityMessage = null;
+    public $buyBoxAvailabilityMessage = null;
+
+    /**
+     * The seller id of the buy box offer, if existent. Otherwise "-2" or null
+     * @var string|null
+     */
+    public $buyBoxSellerId = null;
 
 	/**
      * The default shipping country of the buy box seller. null if not available. Example: “US”
@@ -329,4 +335,10 @@ class Stats
      * @var int|null
      */
     public $salesRankDrops180 = -1;
+
+    /**
+     * The count of sales rank drops (from high value to low value) within the last 365 days which are considered to indicate sales.
+     * @var int|null
+     */
+    public $salesRankDrops360 = -1;
 }