Support RecommendNextItems endpoint

Author: OndraFiedler

README.md

@@ -15,7 +15,7 @@ The library is [UMD](https://github.com/umdjs/umd) compatible.
 You can download [recombee-api-client.min.js](./dist/recombee-api-client.min.js) and host it at your site, or use a CDN such as [jsDelivr](https://www.jsdelivr.com/) CDN:
 
 ```js
-<script src="https://cdn.jsdelivr.net/gh/recombee/js-api-client@3.0.1/dist/recombee-api-client.min.js"></script>
+<script src="https://cdn.jsdelivr.net/gh/recombee/js-api-client@3.1.0/dist/recombee-api-client.min.js"></script>
 ```
 
 ### npm
@@ -86,7 +86,7 @@ client.send(new recombee.RecommendItemsToUser('user-13434', 5), callback);
 #### Promise
 
 ```javascript
-// Get 5 recommendations related to 'item-365'  viewed by 'user-13434'
+// Get 5 recommendations related to 'item-365' viewed by 'user-13434'
 client.send(new recombee.RecommendItemsToItem('item-356', 'user-13434', 5))
 .then(function(res) {
   console.log(res.recomms);
@@ -122,19 +122,38 @@ client.send(new recombee.SearchItems('user-13434', searchQuery, 5))
 });
 ```
 
-#### Optional parameters
+### Recommend Next Items
+
+Recombee can return items that shall be shown to a user as next recommendations when the user e.g. scrolls the page down (infinite scroll) or goes to a next page. See [Recommend next items](https://docs.recombee.com/api.html#recommend-next-items) for more info.
+
+
+```javascript
+client.send(new recombee.RecommendItemsToUser('user-13434', 5))
+.then(function(res) {
+  console.log(res.recomms);
+
+  // Get next 3 recommended items as user-13434 is scrolling the page down
+  client.send(new recombee.RecommendNextItems(res.recommId, 3))
+  .then(function(res) {
+    console.log(res.recomms);
+  })
+});
+```
+
+### Optional parameters
 Recommendation requests accept various optional parameters (see [the docs](https://docs.recombee.com/api.html#recommendations)). Following example shows some of them:
 
 ```javascript
 client.send(new recombee.RecommendItemsToUser('user-13434', 5,
   {
+    scenario: 'homepage', // Label particular usage. You can assign various settings
+                          // for each scenario in the Admin UI (https://admin.recombee.com/).
     returnProperties: true, // Return properties of the recommended items
     includedProperties: ['title', 'img_url', 'url', 'price'], // Use these properties to show
                                                               // the recommended items to user
-    filter: "'title' != null AND 'availability' == \"in stock\"",
+    filter: "'title' != null AND 'availability' == \"in stock\""
                                                      // Recommend only items with filled title 
                                                      // which are in stock
-    scenario: 'homepage' // Label particular usage
   }
 ), callback);
 
@@ -170,7 +189,7 @@ Let's assume we want to show recommendations at product page of pants `product-2
         </div>
     </div>
 
-    <script src="https://cdn.jsdelivr.net/gh/recombee/js-api-client@3.0.1/dist/recombee-api-client.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/gh/recombee/js-api-client@3.1.0/dist/recombee-api-client.min.js"></script>
 
     <script type="text/javascript">
 

dist/recombee-api-client.js

@@ -1,6 +1,6 @@
 {
   "name": "recombee-js-api-client",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Client-side js library for easy use of the Recombee recommendation API",
   "browser": "./src/index.js",
   "repository": {

dist/recombee-api-client.js.map

@@ -7,8 +7,8 @@ const ae = require("./api-error");
 class ResponseError extends ae.ApiError {
   /**
    * Create the exception
-   * @param {Request} request - ID of the item which will be modified
-   * @param {number} statusCode - The values for the individual properties
+   * @param {Request} request - Request which caused the exception
+   * @param {number} statusCode - The returned status code
    * @param {string} message - Error message from the API
    */
   constructor(request, statusCode, message) {

dist/recombee-api-client.min.js

@@ -16,4 +16,5 @@ exports.AddBookmark = require("./requests/add-bookmark").AddBookmark;
 exports.SetViewPortion = require("./requests/set-view-portion").SetViewPortion;
 exports.RecommendItemsToUser = require("./requests/recommend-items-to-user").RecommendItemsToUser;
 exports.RecommendItemsToItem = require("./requests/recommend-items-to-item").RecommendItemsToItem;
+exports.RecommendNextItems = require("./requests/recommend-next-items").RecommendNextItems;
 exports.SearchItems = require("./requests/search-items").SearchItems;

dist/recombee-api-client.min.js.map

@@ -7,8 +7,11 @@ const rqs = require("./request");
 
 /**
  * Recommends set of items that are somehow related to one given item, *X*. Typical scenario  is when user *A* is viewing *X*. Then you may display items to the user that he might be also interested in. Recommend items to item request gives you Top-N such items, optionally taking the target user *A* into account.
- * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
  * The returned items are sorted by relevance (first item being the most relevant).
+ * Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
+ * - Let Recombee know that this recommendation was successful (e.g. user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui.html#reported-metrics).
+ * - Get subsequent recommended items when the user scrolls down (*infinite scroll*) or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api.html#recommend-next-items).
+ * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
  */
 class RecommendItemsToItem extends rqs.Request {
 
@@ -66,7 +69,8 @@ class RecommendItemsToItem extends rqs.Request {
    *             "url": "myshop.com/mixer-42"
    *           }
    *         }
-   *       ]
+   *       ],
+   *     "numberNextRecommsCalls": 0
    *   }
    * ```
    *     - *includedProperties*
@@ -92,7 +96,8 @@ class RecommendItemsToItem extends rqs.Request {
    *             "price": 39
    *           }
    *         }
-   *       ]
+   *       ],
+   *     "numberNextRecommsCalls": 0
    *   }
    * ```
    *     - *filter*

package.json

@@ -8,8 +8,11 @@ const rqs = require("./request");
 /**
  * Based on user's past interactions (purchases, ratings, etc.) with the items, recommends top-N items that are most likely to be of high value for a given user.
  * The most typical use cases are recommendations at homepage, in some "Picked just for you" section or in email.
- * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
  * The returned items are sorted by relevance (first item being the most relevant).
+ * Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
+ * - Let Recombee know that this recommendation was successful (e.g. user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui.html#reported-metrics).
+ * - Get subsequent recommended items when the user scrolls down (*infinite scroll*) or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api.html#recommend-next-items).
+ * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
  */
 class RecommendItemsToUser extends rqs.Request {
 
@@ -54,7 +57,8 @@ class RecommendItemsToUser extends rqs.Request {
    *             "url": "myshop.com/mixer-42"
    *           }
    *         }
-   *       ]
+   *       ],
+   *      "numberNextRecommsCalls": 0
    *   }
    * ```
    *     - *includedProperties*
@@ -80,7 +84,8 @@ class RecommendItemsToUser extends rqs.Request {
    *             "price": 39
    *           }
    *         }
-   *       ]
+   *       ],
+   *     "numberNextRecommsCalls": 0
    *   }
    * ```
    *     - *filter*