recombee-api-client 4.1.5 → 5.0.1

package/lib/requests/delete-cart-addition.js

@@ -21,7 +21,7 @@ class DeleteCartAddition extends rqs.Request {
    *         - Description: Unix timestamp of the cart addition. If the `timestamp` is omitted, then all the cart additions with the given `userId` and `itemId` are deleted.
    */
   constructor(userId, itemId, optional) {
-    super('DELETE', '/cartadditions/', 1000, false);
+    super('DELETE', '/cartadditions/', 3000, false);
     this.userId = userId;
     this.itemId = itemId;
     optional = optional || {};

package/lib/requests/delete-detail-view.js

@@ -21,7 +21,7 @@ class DeleteDetailView extends rqs.Request {
    *         - Description: Unix timestamp of the detail view. If the `timestamp` is omitted, then all the detail views with the given `userId` and `itemId` are deleted.
    */
   constructor(userId, itemId, optional) {
-    super('DELETE', '/detailviews/', 1000, false);
+    super('DELETE', '/detailviews/', 3000, false);
     this.userId = userId;
     this.itemId = itemId;
     optional = optional || {};

package/lib/requests/delete-item.js

@@ -17,7 +17,7 @@ class DeleteItem extends rqs.Request {
    * @param {string} itemId - ID of the item to be deleted.
    */
   constructor(itemId) {
-    super('DELETE', `/items/${itemId}`, 1000, false);
+    super('DELETE', `/items/${itemId}`, 3000, false);
     this.itemId = itemId;
   }
 

package/lib/requests/delete-purchase.js

@@ -21,7 +21,7 @@ class DeletePurchase extends rqs.Request {
    *         - Description: Unix timestamp of the purchase. If the `timestamp` is omitted, then all the purchases with the given `userId` and `itemId` are deleted.
    */
   constructor(userId, itemId, optional) {
-    super('DELETE', '/purchases/', 1000, false);
+    super('DELETE', '/purchases/', 3000, false);
     this.userId = userId;
     this.itemId = itemId;
     optional = optional || {};

package/lib/requests/delete-rating.js

@@ -21,7 +21,7 @@ class DeleteRating extends rqs.Request {
    *         - Description: Unix timestamp of the rating. If the `timestamp` is omitted, then all the ratings with the given `userId` and `itemId` are deleted.
    */
   constructor(userId, itemId, optional) {
-    super('DELETE', '/ratings/', 1000, false);
+    super('DELETE', '/ratings/', 3000, false);
     this.userId = userId;
     this.itemId = itemId;
     optional = optional || {};

package/lib/requests/delete-series.js

@@ -14,10 +14,17 @@ class DeleteSeries extends rqs.Request {
   /**
    * Construct the request
    * @param {string} seriesId - ID of the series to be deleted.
+   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
+   * - Allowed parameters:
+   *     - *cascadeDelete*
+   *         - Type: boolean
+   *         - Description: If set to `true`, item with the same ID as seriesId will be also deleted. Default is `false`.
    */
-  constructor(seriesId) {
-    super('DELETE', `/series/${seriesId}`, 1000, false);
+  constructor(seriesId, optional) {
+    super('DELETE', `/series/${seriesId}`, 3000, false);
     this.seriesId = seriesId;
+    optional = optional || {};
+    this.cascadeDelete = optional.cascadeDelete;
   }
 
   /**
@@ -27,6 +34,9 @@ class DeleteSeries extends rqs.Request {
   bodyParameters() {
     let params = {};
 
+    if(this.cascadeDelete !== undefined)
+      params.cascadeDelete = this.cascadeDelete;
+
     return params;
   }
 

package/lib/requests/delete-user.js

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

package/lib/requests/delete-view-portion.js

@@ -21,7 +21,7 @@ class DeleteViewPortion extends rqs.Request {
    *         - Description: Identifier of a session.
    */
   constructor(userId, itemId, optional) {
-    super('DELETE', '/viewportions/', 1000, false);
+    super('DELETE', '/viewportions/', 3000, false);
     this.userId = userId;
     this.itemId = itemId;
     optional = optional || {};

package/lib/requests/get-item-property-info.js

@@ -15,7 +15,7 @@ class GetItemPropertyInfo extends rqs.Request {
    * @param {string} propertyName - Name of the property about which the information is to be retrieved.
    */
   constructor(propertyName) {
-    super('GET', `/items/properties/${propertyName}`, 1000, false);
+    super('GET', `/items/properties/${propertyName}`, 3000, false);
     this.propertyName = propertyName;
   }
 

package/lib/requests/get-item-values.js

@@ -15,7 +15,7 @@ class GetItemValues extends rqs.Request {
    * @param {string} itemId - ID of the item whose properties are to be obtained.
    */
   constructor(itemId) {
-    super('GET', `/items/${itemId}`, 1000, false);
+    super('GET', `/items/${itemId}`, 3000, false);
     this.itemId = itemId;
   }
 

package/lib/requests/get-user-values.js

@@ -15,7 +15,7 @@ class GetUserValues extends rqs.Request {
    * @param {string} userId - ID of the user whose properties are to be obtained.
    */
   constructor(userId) {
-    super('GET', `/users/${userId}`, 1000, false);
+    super('GET', `/users/${userId}`, 3000, false);
     this.userId = userId;
   }
 

package/lib/requests/index.js

@@ -20,12 +20,6 @@ exports.ListSeries = require("./list-series").ListSeries;
 exports.ListSeriesItems = require("./list-series-items").ListSeriesItems;
 exports.InsertToSeries = require("./insert-to-series").InsertToSeries;
 exports.RemoveFromSeries = require("./remove-from-series").RemoveFromSeries;
-exports.AddGroup = require("./add-group").AddGroup;
-exports.DeleteGroup = require("./delete-group").DeleteGroup;
-exports.ListGroups = require("./list-groups").ListGroups;
-exports.ListGroupItems = require("./list-group-items").ListGroupItems;
-exports.InsertToGroup = require("./insert-to-group").InsertToGroup;
-exports.RemoveFromGroup = require("./remove-from-group").RemoveFromGroup;
 exports.AddUser = require("./add-user").AddUser;
 exports.DeleteUser = require("./delete-user").DeleteUser;
 exports.SetUserValues = require("./set-user-values").SetUserValues;
@@ -62,6 +56,7 @@ exports.ListItemViewPortions = require("./list-item-view-portions").ListItemView
 exports.ListUserViewPortions = require("./list-user-view-portions").ListUserViewPortions;
 exports.RecommendItemsToUser = require("./recommend-items-to-user").RecommendItemsToUser;
 exports.RecommendItemsToItem = require("./recommend-items-to-item").RecommendItemsToItem;
+exports.RecommendItemsToItemSegment = require("./recommend-items-to-item-segment").RecommendItemsToItemSegment;
 exports.RecommendNextItems = require("./recommend-next-items").RecommendNextItems;
 exports.RecommendUsersToUser = require("./recommend-users-to-user").RecommendUsersToUser;
 exports.RecommendUsersToItem = require("./recommend-users-to-item").RecommendUsersToItem;

package/lib/requests/insert-to-series.js

@@ -20,10 +20,10 @@ class InsertToSeries extends rqs.Request {
    * - Allowed parameters:
    *     - *cascadeCreate*
    *         - Type: boolean
-   *         - Description: Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. Either item or series may be created if not present in the database.
+   *         - Description: Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. In case of `item`, an item is created, in case of `series` a series + corresponding item with the same ID is created.
    */
   constructor(seriesId, itemType, itemId, time, optional) {
-    super('POST', `/series/${seriesId}/items/`, 1000, false);
+    super('POST', `/series/${seriesId}/items/`, 3000, false);
     this.seriesId = seriesId;
     this.itemType = itemType;
     this.itemId = itemId;

package/lib/requests/list-items.js

@@ -27,7 +27,7 @@ class ListItems extends rqs.Request {
    *         - Type: boolean
    *         - Description: With `returnProperties=true`, property values of the listed items are returned along with their IDs in a JSON dictionary. 
    * Example response:
-   * ```
+   * ```json
    *   [
    *     {
    *       "itemId": "tv-178",
@@ -49,7 +49,7 @@ class ListItems extends rqs.Request {
    *         - Type: string[]
    *         - Description: Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
    * Example response for `includedProperties=description,price`:
-   * ```
+   * ```json
    *   [
    *     {
    *       "itemId": "tv-178",

package/lib/requests/list-users.js

@@ -27,7 +27,7 @@ class ListUsers extends rqs.Request {
    *         - Type: boolean
    *         - Description: With `returnProperties=true`, property values of the listed users are returned along with their IDs in a JSON dictionary. 
    * Example response:
-   * ```
+   * ```json
    *   [
    *     {
    *       "userId": "user-81",
@@ -45,7 +45,7 @@ class ListUsers extends rqs.Request {
    *         - Type: string[]
    *         - Description: Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
    * Example response for `includedProperties=country`:
-   * ```
+   * ```json
    *   [
    *     {
    *       "userId": "user-81",

package/lib/requests/recommend-item-segments-to-item-segment.js

@@ -6,12 +6,12 @@
 const rqs = require("./request");
 
 /**
- * Recommends Segments from a result Segmentation that are the most relevant to a particular Segment from a context Segmentation.
+ * Recommends Segments from a result [Segmentation](https://docs.recombee.com/segmentations.html) that are the most relevant to a particular Segment from a context Segmentation.
  * Based on the used Segmentations, this endpoint can be used for example for:
  *   - Recommending the related brands to particular brand
  *   - Recommending the related brands to particular category
  *   - Recommending the related artists to a particular genre (assuming songs are the Items)
- * You need to set the used context and result Segmentation the Admin UI in the Scenario settings prior to using this endpoint.
+ * You need to set the used context and result Segmentation the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.
  * The returned segments are sorted by relevance (first segment being the most relevant).
  * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
  */

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

@@ -6,13 +6,13 @@
 const rqs = require("./request");
 
 /**
- * Recommends Segments from a Segmentation that are the most relevant to a particular item.
+ * Recommends Segments from a [Segmentation](https://docs.recombee.com/segmentations.html) that are the most relevant to a particular item.
  * Based on the used Segmentation, this endpoint can be used for example for:
  *   - Recommending the related categories
  *   - Recommending the related genres
  *   - Recommending the related brands
  *   - Recommending the related artists
- * You need to set the used Segmentation the Admin UI in the Scenario settings prior to using this endpoint.
+ * You need to set the used Segmentation the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.
  * The returned segments are sorted by relevance (first segment being the most relevant).
  * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
  */

package/lib/requests/recommend-item-segments-to-user.js

@@ -6,13 +6,13 @@
 const rqs = require("./request");
 
 /**
- * Recommends the top Segments from a Segmentation for a particular user, based on the user's past interactions.
+ * Recommends the top Segments from a [Segmentation](https://docs.recombee.com/segmentations.html) for a particular user, based on the user's past interactions.
  * Based on the used Segmentation, this endpoint can be used for example for:
  *   - Recommending the top categories for the user
  *   - Recommending the top genres for the user
  *   - Recommending the top brands for the user
  *   - Recommending the top artists for the user
- * You need to set the used Segmentation the Admin UI in the Scenario settings prior to using this endpoint.
+ * You need to set the used Segmentation the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.
  * The returned segments are sorted by relevance (first segment being the most relevant).
  * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
  */

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

@@ -0,0 +1,214 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Recommends Items that are the most relevant to a particular Segment from a context [Segmentation](https://docs.recombee.com/segmentations.html).
+ * Based on the used Segmentation, this endpoint can be used for example for:
+ * - Recommending articles related to a particular topic
+ * - Recommending songs belonging to a particular genre
+ * - Recommending products produced by a particular brand
+ * You need to set the used context Segmentation in the Admin UI in the [Scenario settings](https://docs.recombee.com/scenarios) prior to using this endpoint.
+ * The returned items are sorted by relevance (the first item being the most relevant).
+ * It is also possible to use the POST HTTP method (for example, in the case of a very long ReQL filter) — query parameters then become body parameters.
+ */
+class RecommendItemsToItemSegment extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} contextSegmentId - ID of the segment from `contextSegmentationId` for which the recommendations are to be generated.
+   * @param {string} targetUserId - ID of the user who will see the recommendations.
+   * Specifying the *targetUserId* is beneficial because:
+   * * It makes the recommendations personalized
+   * * Allows the calculation of Actions and Conversions
+   *   in the graphical user interface,
+   *   as Recombee can pair the user who got recommendations
+   *   and who afterward viewed/purchased an item.
+   * If you insist on not specifying the user, pass `null`
+   * (`None`, `nil`, `NULL` etc., depending on the language) to *targetUserId*.
+   * Do not create some special dummy user for getting recommendations,
+   * as it could mislead the recommendation models,
+   * and result in wrong recommendations.
+   * For anonymous/unregistered users, it is possible to use, for example, their session ID.
+   * @param {number} count - Number of items to be recommended (N for the top-N recommendation).
+   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
+   * - Allowed parameters:
+   *     - *scenario*
+   *         - Type: string
+   *         - Description: Scenario defines a particular application of recommendations. It can be, for example, "homepage", "cart", or "emailing".
+   * You can set various settings to the [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com). You can also see the performance of each scenario in the Admin UI separately, so you can check how well each application performs.
+   * The AI that optimizes models to get the best results may optimize different scenarios separately or even use different models in each of the scenarios.
+   *     - *cascadeCreate*
+   *         - Type: boolean
+   *         - Description: If an item of the given *itemId* or user of the given *targetUserId* doesn't exist in the database, it creates the missing entity/entities and returns some (non-personalized) recommendations. This allows, for example, rotations in the following recommendations for the user of the given *targetUserId*, as the user will be already known to the system.
+   *     - *returnProperties*
+   *         - Type: boolean
+   *         - Description: With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user. 
+   * Example response:
+   * ```json
+   *   {
+   *     "recommId": "0c6189e7-dc1a-429a-b613-192696309361",
+   *     "recomms":
+   *       [
+   *         {
+   *           "id": "tv-178",
+   *           "values": {
+   *             "description": "4K TV with 3D feature",
+   *             "categories":   ["Electronics", "Televisions"],
+   *             "price": 342,
+   *             "url": "myshop.com/tv-178"
+   *           }
+   *         },
+   *         {
+   *           "id": "mixer-42",
+   *           "values": {
+   *             "description": "Stainless Steel Mixer",
+   *             "categories":   ["Home & Kitchen"],
+   *             "price": 39,
+   *             "url": "myshop.com/mixer-42"
+   *           }
+   *         }
+   *       ],
+   *     "numberNextRecommsCalls": 0
+   *   }
+   * ```
+   *     - *includedProperties*
+   *         - Type: string[]
+   *         - Description: Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
+   * Example response for `includedProperties=description,price`:
+   * ```json
+   *   {
+   *     "recommId": "6842c725-a79f-4537-a02c-f34d668a3f80",
+   *     "recomms": 
+   *       [
+   *         {
+   *           "id": "tv-178",
+   *           "values": {
+   *             "description": "4K TV with 3D feature",
+   *             "price": 342
+   *           }
+   *         },
+   *         {
+   *           "id": "mixer-42",
+   *           "values": {
+   *             "description": "Stainless Steel Mixer",
+   *             "price": 39
+   *           }
+   *         }
+   *       ],
+   *     "numberNextRecommsCalls": 0
+   *   }
+   * ```
+   *     - *filter*
+   *         - Type: string
+   *         - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter recommended items based on the values of their attributes.
+   * Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+   *     - *booster*
+   *         - Type: string
+   *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
+   * Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+   *     - *logic*
+   *         - Type: string | object
+   *         - Description: Logic specifies the particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
+   * See [this section](https://docs.recombee.com/recommendation_logics.html) for a list of available logics and other details.
+   * The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
+   * Logic can also be set to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+   *     - *minRelevance*
+   *         - Type: string
+   *         - Description: **Expert option** If the *targetUserId* is provided:  Specifies the threshold of how 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 a number of items equal to *count* at any cost. If there is not enough data (such as interactions or item properties), this may even lead to bestseller-based recommendations being 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 a 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.
+   *     - *rotationTime*
+   *         - Type: number
+   *         - Description: **Expert option** If the *targetUserId* is provided: Taking *rotationRate* into account, specifies how long it takes for an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized.
+   *     - *expertSettings*
+   *         - Type: object
+   *         - Description: Dictionary of custom options.
+   *     - *returnAbGroup*
+   *         - Type: boolean
+   *         - Description: If there is a custom AB-testing running, return the name of the group to which the request belongs.
+   */
+  constructor(contextSegmentId, targetUserId, count, optional) {
+    super('POST', '/recomms/item-segments/items/', 3000, false);
+    this.contextSegmentId = contextSegmentId;
+    this.targetUserId = targetUserId;
+    this.count = count;
+    optional = optional || {};
+    this.scenario = optional.scenario;
+    this.cascadeCreate = optional.cascadeCreate;
+    this.returnProperties = optional.returnProperties;
+    this.includedProperties = optional.includedProperties;
+    this.filter = optional.filter;
+    this.booster = optional.booster;
+    this.logic = optional.logic;
+    this.minRelevance = optional.minRelevance;
+    this.rotationRate = optional.rotationRate;
+    this.rotationTime = optional.rotationTime;
+    this.expertSettings = optional.expertSettings;
+    this.returnAbGroup = optional.returnAbGroup;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+    params.contextSegmentId = this.contextSegmentId;
+    params.targetUserId = this.targetUserId;
+    params.count = this.count;
+
+    if(this.scenario !== undefined)
+      params.scenario = this.scenario;
+
+    if(this.cascadeCreate !== undefined)
+      params.cascadeCreate = this.cascadeCreate;
+
+    if(this.returnProperties !== undefined)
+      params.returnProperties = this.returnProperties;
+
+    if(this.includedProperties !== undefined)
+      params.includedProperties = this.includedProperties;
+
+    if(this.filter !== undefined)
+      params.filter = this.filter;
+
+    if(this.booster !== undefined)
+      params.booster = this.booster;
+
+    if(this.logic !== undefined)
+      params.logic = this.logic;
+
+    if(this.minRelevance !== undefined)
+      params.minRelevance = this.minRelevance;
+
+    if(this.rotationRate !== undefined)
+      params.rotationRate = this.rotationRate;
+
+    if(this.rotationTime !== undefined)
+      params.rotationTime = this.rotationTime;
+
+    if(this.expertSettings !== undefined)
+      params.expertSettings = this.expertSettings;
+
+    if(this.returnAbGroup !== undefined)
+      params.returnAbGroup = this.returnAbGroup;
+
+    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.RecommendItemsToItemSegment = RecommendItemsToItemSegment

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

@@ -46,7 +46,7 @@ class RecommendItemsToItem extends rqs.Request {
    *         - Type: boolean
    *         - Description: With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user. 
    * Example response:
-   * ```
+   * ```json
    *   {
    *     "recommId": "0c6189e7-dc1a-429a-b613-192696309361",
    *     "recomms":
@@ -77,7 +77,7 @@ class RecommendItemsToItem extends rqs.Request {
    *         - Type: string[]
    *         - Description: Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
    * Example response for `includedProperties=description,price`:
-   * ```
+   * ```json
    *   {
    *     "recommId": "6842c725-a79f-4537-a02c-f34d668a3f80",
    *     "recomms": 

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

@@ -34,7 +34,7 @@ class RecommendItemsToUser extends rqs.Request {
    *         - Type: boolean
    *         - Description: With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user. 
    * Example response:
-   * ```
+   * ```json
    *   {
    *     "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
    *     "recomms": 
@@ -65,7 +65,7 @@ class RecommendItemsToUser extends rqs.Request {
    *         - Type: string[]
    *         - Description: Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
    * Example response for `includedProperties=description,price`:
-   * ```
+   * ```json
    *   {
    *     "recommId": "a86ee8d5-cd8e-46d1-886c-8b3771d0520b",
    *     "recomms":

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

@@ -9,9 +9,10 @@ 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 the next page.
  * It accepts `recommId` of a base recommendation request (e.g., request from the first page) and the 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)
+ *   - [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)
+ *   - [Recommend Items to Item Segment](https://docs.recombee.com/api.html#recommend-items-to-item-segment)
+ *   - [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.

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

@@ -30,7 +30,7 @@ class RecommendUsersToItem extends rqs.Request {
    *         - Type: boolean
    *         - Description: With `returnProperties=true`, property values of the recommended users are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended users. 
    * Example response:
-   * ```
+   * ```json
    *   {
    *     "recommId": "039b71dc-b9cc-4645-a84f-62b841eecfce",
    *     "recomms":
@@ -57,7 +57,7 @@ class RecommendUsersToItem extends rqs.Request {
    *         - Type: string[]
    *         - Description: Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
    * Example response for `includedProperties=country`:
-   * ```
+   * ```json
    *   {
    *     "recommId": "b2b355dd-972a-4728-9c6b-2dc229db0678",
    *     "recomms":

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

@@ -30,7 +30,7 @@ class RecommendUsersToUser extends rqs.Request {
    *         - Type: boolean
    *         - Description: With `returnProperties=true`, property values of the recommended users are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended users. 
    * Example response:
-   * ```
+   * ```json
    *   {
    *     "recommId": "9cb9c55d-50ba-4478-84fd-ab456136156e",
    *     "recomms": 
@@ -57,7 +57,7 @@ class RecommendUsersToUser extends rqs.Request {
    *         - Type: string[]
    *         - Description: Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
    * Example response for `includedProperties=country`:
-   * ```
+   * ```json
    *   {
    *     "recommId": "b326d82d-5d57-4b45-b362-c9d6f0895855",
    *     "recomms":

package/lib/requests/remove-from-series.js

@@ -15,14 +15,12 @@ class RemoveFromSeries extends rqs.Request {
    * @param {string} seriesId - ID of the series from which a series item is to be removed.
    * @param {string} itemType - Type of the item to be removed.
    * @param {string} itemId - ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.
-   * @param {number} time - Time index of the item to be removed.
    */
-  constructor(seriesId, itemType, itemId, time) {
-    super('DELETE', `/series/${seriesId}/items/`, 1000, false);
+  constructor(seriesId, itemType, itemId) {
+    super('DELETE', `/series/${seriesId}/items/`, 3000, false);
     this.seriesId = seriesId;
     this.itemType = itemType;
     this.itemId = itemId;
-    this.time = time;
   }
 
   /**
@@ -31,6 +29,8 @@ class RemoveFromSeries extends rqs.Request {
    */
   bodyParameters() {
     let params = {};
+    params.itemType = this.itemType;
+    params.itemId = this.itemId;
 
     return params;
   }
@@ -41,9 +41,6 @@ class RemoveFromSeries extends rqs.Request {
    */
   queryParameters() {
     let params = {};
-    params.itemType = this.itemType;
-    params.itemId = this.itemId;
-    params.time = this.time;
     return params;
   }
 }

package/lib/requests/request.js

@@ -19,4 +19,4 @@ class Request {
   }
 }
 
-exports.Request = Request
+exports.Request = Request

package/lib/requests/search-items.js

@@ -36,7 +36,7 @@ class SearchItems extends rqs.Request {
    *         - Type: boolean
    *         - Description: With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used to easily display the recommended items to the user. 
    * Example response:
-   * ```
+   * ```json
    *   {
    *     "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
    *     "recomms": 
@@ -67,7 +67,7 @@ class SearchItems extends rqs.Request {
    *         - Type: string[]
    *         - Description: Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
    * Example response for `includedProperties=description,price`:
-   * ```
+   * ```json
    *   {
    *     "recommId": "a86ee8d5-cd8e-46d1-886c-8b3771d0520b",
    *     "recomms":

package/lib/requests/set-view-portion.js

@@ -35,7 +35,7 @@ class SetViewPortion extends rqs.Request {
    *         - Description: A dictionary of additional data for the interaction.
    */
   constructor(userId, itemId, portion, optional) {
-    super('POST', '/viewportions/', 1000, false);
+    super('POST', '/viewportions/', 3000, false);
     this.userId = userId;
     this.itemId = itemId;
     this.portion = portion;