- catch up with 1.46 java-framework

Author: saschaarthur

src/API/Request.php

@@ -35,6 +35,27 @@ public static function getDealsRequest(DealRequest $dealRequest)
         return $r;
     }
 
+    /**
+     * This request provides access to all current and upcoming lightning deals.
+     * You can request a specific lightning deal by specifying an ASIN or get the complete list.
+     * Our lightning deals information is updated every 10 minutes.
+     *
+     *
+     * @param int domainId Amazon locale of the product {@link AmazonLocale}
+     * @param string asin The ASIN to retrieve the lightning deal for or null to retrieve all lightning deals
+     * @return Request
+     */
+    public static function getLightningDealRequest($domainId, $asin = null)
+    {
+        $r = new Request();
+        $r->path = "lightningdeal";
+        $r->parameter["domain"] = $domainId;
+        if ($asin != null)
+            $r->parameter["asin"] = $asin;
+
+        return $r;
+    }
+
     /**
      * Retrieve category objects using their node ids and (optional) their parent tree.
      *

src/API/Response.php

@@ -1,5 +1,4 @@
-<?php
-namespace Keepa\API;
+<?php namespace Keepa\API;
 
 /**
  * Common Keepa API Response
@@ -140,6 +139,12 @@ class Response
      */
     public $totalResults = null;
 
+    /**
+     * A list of lightning deals.
+     * @var \Keepa\objects\LightningDeal[]|null
+     */
+    public $lightningDeals = null;
+
     function __construct(Request $request)
     {
         $this->request = $request;

src/objects/AmazonLocale.php

@@ -20,6 +20,4 @@ class AmazonLocale
     const MX = 11;
     const BR = 12;
     const AU = 13;
-    const NL = 14;
-    const TR = 15;
 }

src/objects/LightningDeal.php

@@ -0,0 +1,146 @@
+<?php
+
+namespace Keepa\objects;
+
+/**
+ * About:
+ * A best sellers ASIN list of a specific category.
+ * <p>
+ * Returned by:
+ * Request Best Sellers
+ */
+class LightningDeal
+{
+
+    /**
+     * The domainId of the products Amazon locale <br>
+     * {@link AmazonLocale}
+     * @var int
+     */
+    public $domainId;
+
+    /**
+     * The ASIN of the product
+     * @var int
+     */
+    public $lastUpdate;
+
+    /**
+     * The ASIN of the product
+     * @var string
+     */
+    public $asin;
+
+    /**
+     * Title of the product. Caution: may contain HTML markup in rare cases.
+     * @var string
+     */
+    public $title;
+
+    /**
+     * The name of seller offering this deal.
+     * @var string|null
+     */
+    public $sellerName;
+
+    /**
+     * The seller id of the merchant offering this deal.
+     * @var string|null
+     */
+    public $sellerId;
+
+    /**
+     *  A unique ID for this deal.
+     * @var string
+     */
+    public $dealId;
+
+    /**
+     * The discounted price of this deal. Available once the deal has started. -1 if the deal’s state is upcoming. The price is an integer of the respective Amazon locale’s smallest currency unit (e.g. euro cents or yen).
+     * @var int
+     */
+    public $dealPrice;
+
+    /**
+     * The regular price of this product. Available once the deal has started. -1 if the deal’s state is upcoming. The price is an integer of the respective Amazon locale’s smallest currency unit (e.g. euro cents or yen).
+     * @var int
+     */
+    public $currentPrice;
+
+
+    /**
+     * The name of the primary image of the product. null if not available.
+     * @var string|null
+     */
+    public $image;
+
+    /**
+     * Whether or not the deal is Prime eligible.
+     * @var boolean
+     */
+    public $isPrimeEligible;
+
+    /**
+     * Whether or not the deal is fulfilled by Amazon.
+     * @var boolean
+     */
+    public $isFulfilledByAmazon;
+
+    /**
+     * Whether or not the price is restricted by MAP (Minimum Advertised Price).
+     * @var boolean
+     */
+    public $isMAP;
+
+    /**
+     * The rating of the product. A rating is an integer from 0 to 50 (e.g. 45 = 4.5 stars).
+     * @var int
+     */
+    public $rating;
+
+    /**
+     * The product’s review count.
+     * @var int
+     */
+    public $totalReviews;
+
+    /**
+     * The state of the deal.
+     * @var string
+     */
+    public $dealState;
+
+    /**
+     * The start time of this lighting deal, in Keepa Time minutes. Note that due to the delay in our data collection the deal price might not be available immediately once the deal has started on Amazon.<br>
+     * Use {@link KeepaTime#keepaMinuteToUnixInMillis(int)} (long)} to get an uncompressed timestamp (Unix epoch time).
+     * @var int
+     */
+    public $startTime;
+
+    /**
+     * The end time of this lighting deal, in Keepa Time minutes.<br>
+     * Use {@link KeepaTime#keepaMinuteToUnixInMillis(int)} (long)} to get an uncompressed timestamp (Unix epoch time).
+     * @var int
+     */
+    public $endTime;
+
+    /**
+     * The percentage claimed of the lighting deal. Since lightning deals have limited stock, this number may change fast on Amazon, but due to the delay of our data collection the provided value may be outdated.
+     * @var int
+     */
+    public $percentClaimed;
+
+    /**
+     * The provided discount of this deal, according to Amazon. May be in reference to the list price, not the current price.
+     * @var int
+     */
+    public $percentOff;
+
+    /**
+     * The provided discount of this deal, according to Amazon. May be in reference to the list price, not the current price.
+     * @var \Keepa\helper\VariationAttributeObject[]|null
+     */
+    public $variation;
+
+
+}

src/objects/MerchantBrandStatistics.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Keepa\objects;
+
+/**
+ * About:
+ * A best sellers ASIN list of a specific category.
+ * <p>
+ * Returned by:
+ * Request Best Sellers
+ */
+class MerchantBrandStatistics
+{
+
+    /**
+     * the brand (in all lower-case)
+     * @var string
+     */
+    public $brand;
+
+    /**
+     * the number of products this merchant sells with this brand
+     * @var int
+     */
+    public $productCount;
+
+    /**
+     * the 30 day average sales rank of these products
+     * @var int
+     */
+    public $avg30SalesRank;
+
+    /**
+     * how many of these products have an Amazon offer
+     * @var string
+     */
+    public $productCountWithAmazonOffer;
+
+}

src/objects/MerchantCategoryStatistics.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Keepa\objects;
+
+/**
+ * About:
+ * A best sellers ASIN list of a specific category.
+ * <p>
+ * Returned by:
+ * Request Best Sellers
+ */
+class MerchantCategoryStatistics
+{
+
+    /**
+     * the category id
+     * @var int
+     */
+    public $catId;
+
+    /**
+     * the number of products this merchant sells with this category
+     * @var int
+     */
+    public $productCount;
+
+    /**
+     * the 30 day average sales rank of these products
+     * @var int
+     */
+    public $avg30SalesRank;
+
+    /**
+     * how many of these products have an Amazon offer
+     * @var string
+     */
+    public $productCountWithAmazonOffer;
+
+}

src/objects/Offer.php

@@ -130,6 +130,12 @@ class Offer
      */
     public $isScam = null;
 
+    /**
+     * Indicating whether or not the offer ships from China.
+     * @var bool|null
+     */
+    public $shipsFromChina;
+
     /**
      * True if the seller is Amazon (e.g. "Amazon.com").
      * <p>

src/objects/Seller.php

@@ -63,6 +63,12 @@ class Seller
      */
     public $isScammer = null;
 
+    /**
+     * Indicating whether or not the offer ships from China.
+     * @var bool|null
+     */
+    public $shipsFromChina = null;
+
     /**
      * Boolean value indicating whether or not the seller currently has FBA listings.<br>
      * This value is usually correct, but could be set to false even if the seller has FBA listings, since we are not always aware of all<br>
@@ -103,4 +109,37 @@ class Seller
      * @var int[]|null
      */
     public $totalStorefrontAsins = null;
+
+
+    /**
+     * Statistics about the primary categories of this seller. Based on our often incomplete and outdated product offers data.
+     * @var MerchantCategoryStatistics[]|null
+     */
+    public $sellerCategoryStatistics = null;
+
+    /**
+     * Statistics about the primary brands of this seller. Based on our often incomplete and outdated product offers data.
+     * @var MerchantBrandStatistics[]|null
+     */
+    public $sellerBrandStatistics = null;
+
+
+    /**
+     *
+     * @var int
+     */
+    public $currentRating = null;
+
+    /**
+     *
+     * @var int
+     */
+    public $currentRatingCount = null;
+
+    /**
+     *
+     * @var int
+     */
+    public $ratingsLast30Days = null;
+
 }

src/tests/LightingDealTest.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Keepa\tests;
+
+use Keepa\API\Request;
+use Keepa\objects\AmazonLocale;
+
+class LightingDealTest extends abstractTest
+{
+    public function testRun()
+    {
+        $request = Request::getLightningDealRequest(AmazonLocale::DE);
+        $response = $this->api->sendRequestWithRetry($request);
+
+        self::assertEquals($response->status, "OK");
+        self::assertNotNull($response->lightningDeals);
+        self::assertGreaterThan(0, count($response->lightningDeals));
+    }
+
+}

src/tests/SellerRequestTest.php

@@ -59,5 +59,6 @@ public function testStoreFrontAsins()
         self::assertNotNull($response->sellers);
         self::assertEquals(1, count($response->sellers));
         self::assertGreaterThan(0, count($response->sellers['A2L77EE7U53NWQ']->totalStorefrontAsins));
+        self::assertNotNull($response->sellers['A2L77EE7U53NWQ']->shipsFromChina);
     }
 }