recombee-api-client 3.0.0 → 4.0.0

package/README.md

@@ -44,7 +44,7 @@ client.send(new AddDetailView,
 var recombee = require('recombee-api-client');
 var rqs = recombee.requests;
 
-var client = new recombee.ApiClient('--my-database-id--', '--db-private-token--');
+var client = new recombee.ApiClient('--my-database-id--', '--db-private-token--', {region: 'us-west'});
 
 // Prepare some userIDs and itemIDs
 const NUM = 100;
@@ -71,17 +71,23 @@ userIds.forEach((userId) => {
 
 // Send the data to Recombee, use Batch for faster processing of larger data
 client.send(new rqs.Batch(purchases))
-  .then(() => {
-    //Get 5 recommended items for user 'user-25'
-    client.send(new rqs.RecommendItemsToUser('user-25', 5))
-      .then((recommended) => {
-        console.log("Recommended items for user-25: %j", recommended);
-      });
-  })
-  .catch((error) => {
-    console.error(error);
-    // Use fallback
-  });
+.then(() => {
+  //Get 5 recommended items for user 'user-25'
+  return client.send(new rqs.RecommendItemsToUser('user-25', 5));
+})
+.then((response) => {
+  console.log("Recommended items for user-25: %j", response.recomms);
+
+  // User scrolled down - get next 3 recommended items
+  return client.send(new rqs.RecommendNextItems(response.recommId, 3));
+})
+.then((response) => {
+  console.log("Next recommended items for user-25: %j", response.recomms);
+})
+.catch((error) => {
+  console.error(error);
+  // Use fallback
+});
 ```
 
 ### Using property values
@@ -90,7 +96,7 @@ client.send(new rqs.Batch(purchases))
 var recombee = require('recombee-api-client');
 var rqs = recombee.requests;
 
-var client = new recombee.ApiClient('--my-database-id--', '--db-private-token--');
+var client = new recombee.ApiClient('--my-database-id--', '--db-private-token--', {region: 'ap-se'});
 const NUM = 100;
 
 // We will use computers as items in this example
@@ -180,7 +186,7 @@ client.send(new rqs.Batch([
   })
   .then((recommended) => {
     // Perform personalized full-text search with a user's search query (e.g. "computers")
-    return client.send(new rqs.SearchItems('user-42', 'computers', 5));
+    return client.send(new rqs.SearchItems('user-42', 'computers', 5, {'scenario': "search_top"}));
   })
   .then((matched) => {
     console.log("Matched items: %j", matched)

package/lib/api-client.js

@@ -1,8 +1,7 @@
 'use strict';
 
 const jsSHA = require("jssha");
-const rp = require('request-promise');
-const rp_errors = require('request-promise/errors');
+const got = require('got');
 
 const api_errors = require('./errors');
 const requests = require('./requests');
@@ -17,15 +16,17 @@ class ApiClient {
    * Construct the client
    * @param {string} databaseId - ID of your database
    * @param {string} secretToken - Corresponding secret token
-   * @param {boolean} alwaysUseHttps - If true, all requests are sent using HTTPS (default: true)
    * @param {Object} options - Other custom options
    */
-  constructor (databaseId, token, alwaysUseHttps, options) {
+  constructor (databaseId, token, options) {
       this.databaseId = databaseId;
       this.token = token;
-      this.alwaysUseHttps = (alwaysUseHttps === undefined) ? true : alwaysUseHttps;
       this.options = options || {};
-      this.baseUri = process.env.RAPI_URI || this.options.baseUri || 'rapi.recombee.com';
+
+      if (Object.getPrototypeOf(this.options) !== Object.prototype) throw new Error(`options must be given as an Object (${this.options} given instead)`);
+
+      this.protocol = this.options.protocol || 'https';
+      this.baseUri = this._getBaseUri()
   }
 
   /**
@@ -41,50 +42,69 @@ class ApiClient {
     let url = this._buildRequestUrl(request);
     let options = {
         method: request.method,
-        uri: url,
+        url: url,
         headers: {'Accept': 'application/json',
                   'Content-Type': 'application/json',
-                  'User-Agent': 'recombee-node-api-client/3.0.0'},
-        timeout: request.timeout,
-        resolveWithFullResponse: true,
-        json: true
+                  'User-Agent': 'recombee-node-api-client/4.0.0'},
+        timeout: request.timeout
     };
 
-    if (this.options.proxy)
-      options.proxy = this.options.proxy;
-
-    if (request.bodyParameters()) 
-      options.body = request.bodyParameters();
+    if (Object.entries(request.bodyParameters()).length > 0)
+      options.json = request.bodyParameters();
 
-    return rp(options)
-           .then(this._parseResponse)
+    return got(options)
+           .json()
            .then((response)=> {
               return new Promise( (resolve) => {
                 if (callback) { return callback(null, response); }
                 return resolve(response);
               });
             })
-            .catch(rp_errors.StatusCodeError,((error) => {
-                throw new api_errors.ResponseError(request, error.statusCode, error.message);
+            .catch((error) => {
+              if (error instanceof got.HTTPError) {
+                error = new api_errors.ResponseError(request, error.response.statusCode, error.response.body);
               }
-            ))
-            .catch(rp_errors.RequestError,((error) => {
-                if(error.cause.code === 'ETIMEDOUT' || error.cause.code === 'ESOCKETTIMEDOUT')
-                  throw new api_errors.TimeoutError(request, error);
-                throw error;
+              else if (error instanceof got.RequestError) {
+                if(error.code === 'ETIMEDOUT' || error.code === 'ESOCKETTIMEDOUT') {
+                  error = new api_errors.TimeoutError(request, error);
+                }
               }
-            ))
-            .catch((error) => {
               if (callback) {return callback(error)};
               throw error;
             });
   }
 
+  _getRegionalBaseUri(region) {
+    const uri = {
+      'ap-se': 'rapi-ap-se.recombee.com',
+      'ca-east': 'rapi-ca-east.recombee.com',
+      'eu-west': 'rapi-eu-west.recombee.com',
+      'us-west': 'rapi-us-west.recombee.com'
+    }[region.toLowerCase()];
+
+    if (uri === undefined) {
+      throw new Error(`Region "${region}" is unknown. You may need to update the version of the SDK.`)
+    }
+
+    return uri;
+  }
+
+  _getBaseUri() {
+    let baseUri = process.env.RAPI_URI || this.options.baseUri;
+    if (this.options.region) {
+      if (baseUri) {
+        throw new Error('baseUri and region cannot be specified at the same time');
+      }
+      baseUri = this._getRegionalBaseUri(this.options.region);
+    }
+    return baseUri || 'rapi.recombee.com';
+  }
+
   _buildRequestUrl(request) {
-    let protocol = (request.ensureHttps || this.alwaysUseHttps) ? 'https' : 'http';
+    let usedProtocol = (request.ensureHttps) ? 'https' : this.protocol;
     let reqUrl = request.path + this._encodeRequestQueryParams(request);
     let signedUrl = this._signUrl(reqUrl);
-    return protocol + '://' + this.baseUri + signedUrl;
+    return usedProtocol + '://' + this.baseUri + signedUrl;
   }
 
   _encodeRequestQueryParams(request) {
@@ -161,14 +181,6 @@ class ApiClient {
       });
   }
 
-  _parseResponse(response) {
-    return new Promise(
-      function (resolve, reject) {
-        resolve(response.body);
-      }
-    );
-  }
-
   _signUrl (req_part) {
     let url = '/' + this.databaseId + req_part;
     url += (req_part.indexOf("?") == -1 ? "?" : "&" ) + "hmac_timestamp=" + parseInt(new Date().getTime() / 1000);

package/lib/errors/response-error.js

@@ -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) {

package/lib/requests/add-search-synonym.js

@@ -0,0 +1,60 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Adds a new synonym for the [Search items](https://docs.recombee.com/api.html#search-items).
+ * When the `term` is used in the search query, the `synonym` is also used for the full-text search.
+ * Unless `oneWay=true`, it works also in the opposite way (`synonym` -> `term`).
+ * An example of a synonym can be `science fiction` for the term `sci-fi`.
+ */
+class AddSearchSynonym extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} term - A word to which the `synonym` is specified.
+   * @param {string} synonym - A word that should be considered equal to the `term` by the full-text search engine.
+   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
+   * - Allowed parameters:
+   *     - *oneWay*
+   *         - Type: boolean
+   *         - Description: If set to `true`, only `term` -> `synonym` is considered. If set to `false`, also `synonym` -> `term` works.
+   * Default: `false`.
+   */
+  constructor(term, synonym, optional) {
+    super('POST', '/synonyms/items/', 10000, false);
+    this.term = term;
+    this.synonym = synonym;
+    optional = optional || {};
+    this.oneWay = optional.oneWay;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+    params.term = this.term;
+    params.synonym = this.synonym;
+
+    if(this.oneWay !== undefined)
+      params.oneWay = this.oneWay;
+
+    return params;
+  }
+
+  /**
+   * Get query parameters
+   * @return {Object} The values of query parameters (name of parameter: value of the parameter)
+   */
+  queryParameters() {
+    let params = {};
+    return params;
+  }
+}
+
+exports.AddSearchSynonym = AddSearchSynonym

package/lib/requests/delete-all-search-synonyms.js

@@ -0,0 +1,40 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Deletes all synonyms defined in the database.
+ */
+class DeleteAllSearchSynonyms extends rqs.Request {
+
+  /**
+   * Construct the request
+   */
+  constructor() {
+    super('DELETE', '/synonyms/items/', 10000, false);
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+
+    return params;
+  }
+
+  /**
+   * Get query parameters
+   * @return {Object} The values of query parameters (name of parameter: value of the parameter)
+   */
+  queryParameters() {
+    let params = {};
+    return params;
+  }
+}
+
+exports.DeleteAllSearchSynonyms = DeleteAllSearchSynonyms

package/lib/requests/delete-item.js

@@ -8,7 +8,7 @@ const rqs = require("./request");
 /**
  * Deletes an item of given `itemId` from the catalog.
  * If there are any *purchases*, *ratings*, *bookmarks*, *cart additions* or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
- * If an item becomes obsolete/no longer available, it is often meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and only exclude the item from recommendations. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
+ * If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
  */
 class DeleteItem extends rqs.Request {
 

package/lib/requests/delete-more-items.js

@@ -0,0 +1,44 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Delete all the items that pass the filter.
+ * If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
+ */
+class DeleteMoreItems extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} filter - A [ReQL](https://docs.recombee.com/reql.html) expression, which return `true` for the items that shall be updated.
+   */
+  constructor(filter) {
+    super('DELETE', '/more-items/', 1000, false);
+    this.filter = filter;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+    params.filter = this.filter;
+
+    return params;
+  }
+
+  /**
+   * Get query parameters
+   * @return {Object} The values of query parameters (name of parameter: value of the parameter)
+   */
+  queryParameters() {
+    let params = {};
+    return params;
+  }
+}
+
+exports.DeleteMoreItems = DeleteMoreItems

package/lib/requests/delete-search-synonym.js

@@ -0,0 +1,42 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Deletes synonym of given `id` and this synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
+ */
+class DeleteSearchSynonym extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} id - ID of the synonym that should be deleted.
+   */
+  constructor(id) {
+    super('DELETE', `/synonyms/items/${id}`, 10000, false);
+    this.id = id;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+
+    return params;
+  }
+
+  /**
+   * Get query parameters
+   * @return {Object} The values of query parameters (name of parameter: value of the parameter)
+   */
+  queryParameters() {
+    let params = {};
+    return params;
+  }
+}
+
+exports.DeleteSearchSynonym = DeleteSearchSynonym

package/lib/requests/delete-user.js

@@ -13,7 +13,7 @@ class DeleteUser extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} userId - ID of the user to be added.
+   * @param {string} userId - ID of the user to be deleted.
    */
   constructor(userId) {
     super('DELETE', `/users/${userId}`, 1000, false);

package/lib/requests/index.js

@@ -12,6 +12,8 @@ exports.AddItemProperty = require("./add-item-property").AddItemProperty;
 exports.DeleteItemProperty = require("./delete-item-property").DeleteItemProperty;
 exports.GetItemPropertyInfo = require("./get-item-property-info").GetItemPropertyInfo;
 exports.ListItemProperties = require("./list-item-properties").ListItemProperties;
+exports.UpdateMoreItems = require("./update-more-items").UpdateMoreItems;
+exports.DeleteMoreItems = require("./delete-more-items").DeleteMoreItems;
 exports.AddSeries = require("./add-series").AddSeries;
 exports.DeleteSeries = require("./delete-series").DeleteSeries;
 exports.ListSeries = require("./list-series").ListSeries;
@@ -59,11 +61,14 @@ exports.DeleteViewPortion = require("./delete-view-portion").DeleteViewPortion;
 exports.ListItemViewPortions = require("./list-item-view-portions").ListItemViewPortions;
 exports.ListUserViewPortions = require("./list-user-view-portions").ListUserViewPortions;
 exports.RecommendItemsToUser = require("./recommend-items-to-user").RecommendItemsToUser;
-exports.RecommendUsersToUser = require("./recommend-users-to-user").RecommendUsersToUser;
 exports.RecommendItemsToItem = require("./recommend-items-to-item").RecommendItemsToItem;
+exports.RecommendNextItems = require("./recommend-next-items").RecommendNextItems;
+exports.RecommendUsersToUser = require("./recommend-users-to-user").RecommendUsersToUser;
 exports.RecommendUsersToItem = require("./recommend-users-to-item").RecommendUsersToItem;
 exports.SearchItems = require("./search-items").SearchItems;
-exports.UserBasedRecommendation = require("./user-based-recommendation").UserBasedRecommendation;
-exports.ItemBasedRecommendation = require("./item-based-recommendation").ItemBasedRecommendation;
+exports.AddSearchSynonym = require("./add-search-synonym").AddSearchSynonym;
+exports.ListSearchSynonyms = require("./list-search-synonyms").ListSearchSynonyms;
+exports.DeleteAllSearchSynonyms = require("./delete-all-search-synonyms").DeleteAllSearchSynonyms;
+exports.DeleteSearchSynonym = require("./delete-search-synonym").DeleteSearchSynonym;
 exports.ResetDatabase = require("./reset-database").ResetDatabase;
 exports.Batch = require("./batch").Batch;

package/lib/requests/list-search-synonyms.js

@@ -0,0 +1,55 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Gives the list of synonyms defined in the database.
+ */
+class ListSearchSynonyms extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
+   * - Allowed parameters:
+   *     - *count*
+   *         - Type: number
+   *         - Description: The number of synonyms to be listed.
+   *     - *offset*
+   *         - Type: number
+   *         - Description: Specifies the number of synonyms to skip (ordered by `term`).
+   */
+  constructor(optional) {
+    super('GET', '/synonyms/items/', 100000, false);
+    optional = optional || {};
+    this.count = optional.count;
+    this.offset = optional.offset;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+
+    return params;
+  }
+
+  /**
+   * Get query parameters
+   * @return {Object} The values of query parameters (name of parameter: value of the parameter)
+   */
+  queryParameters() {
+    let params = {};
+    if (this.count !== undefined)
+      params.count = this.count;
+    if (this.offset !== undefined)
+      params.offset = this.offset;
+    return params;
+  }
+}
+
+exports.ListSearchSynonyms = ListSearchSynonyms

package/lib/requests/recommend-items-to-item.js

@@ -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.
+ * 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.
- * The returned items are sorted by relevancy (first item being the most relevant).
  */
 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*
@@ -117,7 +122,7 @@ class RecommendItemsToItem extends rqs.Request {
    *         - Description: **Expert option** Real number from [0.0, 1.0] which determines how much mutually dissimilar should the recommended items be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
    *     - *minRelevance*
    *         - Type: string
-   *         - Description: **Expert option** If the *targetUserId* is provided:  Specifies the threshold of how much relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of items equal to *count* at any cost. If there are not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested relevancy, and may return less than *count* items when there is not enough data to fulfill it.
+   *         - Description: **Expert option** If the *targetUserId* is provided:  Specifies the threshold of how much relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of items equal to *count* at any cost. If there are not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested relevance, and may return less than *count* items when there is not enough data to fulfill it.
    *     - *rotationRate*
    *         - Type: number
    *         - Description: **Expert option** If the *targetUserId* is provided: If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items.

package/lib/requests/recommend-items-to-user.js

@@ -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.
+ * 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.
- * The returned items are sorted by relevancy (first item being the most relevant).
  */
 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*
@@ -102,10 +107,10 @@ class RecommendItemsToUser extends rqs.Request {
    *         - Description: **Expert option** Real number from [0.0, 1.0] which determines how much mutually dissimilar should the recommended items be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
    *     - *minRelevance*
    *         - Type: string
-   *         - Description: **Expert option** Specifies the threshold of how much relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of items equal to *count* at any cost. If there are not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested relevancy, and may return less than *count* items when there is not enough data to fulfill it.
+   *         - Description: **Expert option** Specifies the threshold of how much relevant must the recommended items be to the user. Possible values one of: "low", "medium", "high". The default value is "low", meaning that the system attempts to recommend number of items equal to *count* at any cost. If there are not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations to be appended to reach the full *count*. This behavior may be suppressed by using "medium" or "high" values. In such case, the system only recommends items of at least the requested relevance, and may return less than *count* items when there is not enough data to fulfill it.
    *     - *rotationRate*
    *         - Type: number
-   *         - Description: **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items. Default: `0.1`.
+   *         - Description: **Expert option** If your users browse the system in real-time, it may easily happen that you wish to offer them recommendations multiple times. Here comes the question: how much should the recommendations change? Should they remain the same, or should they rotate? Recombee API allows you to control this per-request in backward fashion. You may penalize an item for being recommended in the near past. For the specific user, `rotationRate=1` means maximal rotation, `rotationRate=0` means absolutely no rotation. You may also use, for example `rotationRate=0.2` for only slight rotation of recommended items. Default: `0`.
    *     - *rotationTime*
    *         - Type: number
    *         - Description: **Expert option** Taking *rotationRate* into account, specifies how long time it takes to an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.

package/lib/requests/recommend-next-items.js

@@ -0,0 +1,55 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Returns 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.
+ * It accepts `recommId` of a base recommendation request (e.g. request from the first page) and number of items that shall be returned (`count`).
+ * The base request can be one of:
+ *   - [Recommend items to item](https://docs.recombee.com/api.html#recommend-items-to-item)
+ *   - [Recommend items to user](https://docs.recombee.com/api.html#recommend-items-to-user)
+ *   - [Search items](https://docs.recombee.com/api.html#search-items)
+ * All the other parameters are inherited from the base request.
+ * *Recommend next items* can be called many times for a single `recommId` and each call returns different (previously not recommended) items.
+ * The number of *Recommend next items* calls performed so far is returned in the `numberNextRecommsCalls` field.
+ * *Recommend next items* can be requested up to 30 minutes after the base request or a previous *Recommend next items* call.
+ * For billing purposes, each call to *Recommend next items* is counted as a separate recommendation request.
+ */
+class RecommendNextItems extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} recommId - ID of the base recommendation request for which next recommendations should be returned
+   * @param {number} count - Number of items to be recommended
+   */
+  constructor(recommId, count) {
+    super('POST', `/recomms/next/items/${recommId}`, 3000, false);
+    this.recommId = recommId;
+    this.count = count;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+    params.count = this.count;
+
+    return params;
+  }
+
+  /**
+   * Get query parameters
+   * @return {Object} The values of query parameters (name of parameter: value of the parameter)
+   */
+  queryParameters() {
+    let params = {};
+    return params;
+  }
+}
+
+exports.RecommendNextItems = RecommendNextItems