recombee-api-client 3.2.0 → 4.1.0

package/lib/requests/search-items.js

@@ -8,12 +8,12 @@ const rqs = require("./request");
 /**
  * Full-text personalized search. The results are based on the provided `searchQuery` and also on the user's past interactions (purchases, ratings, etc.) with the items (items more suitable for the user are preferred in the results).
  * All the string and set item properties are indexed by the search engine.
- * This endpoint should be used in a search box at your website/app. It can be called multiple times as the user is typing the query in order to get the most viable suggestions based on current state of the query, or once after submitting the whole query. 
- * The returned items are sorted by relevance (first item being the most relevant).
+ * This endpoint should be used in a search box on your website/app. It can be called multiple times as the user is typing the query in order to get the most viable suggestions based on the current state of the query, or once after submitting the whole query. 
+ * The returned items are sorted by relevance (the 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 search was successful (e.g. user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui.html#reported-metrics).
+ * - Let Recombee know that this search 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 search results when the user scrolls down 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.
+ * It is also possible to use POST HTTP method (for example in the case of a very long ReQL filter) - query parameters then become body parameters.
  */
 class SearchItems extends rqs.Request {
 
@@ -27,14 +27,14 @@ class SearchItems extends rqs.Request {
    *     - *scenario*
    *         - Type: string
    *         - Description: Scenario defines a particular search field in your user interface.
-   * 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 performance of each scenario in the Admin UI separately, so you can check how well each field performs.
-   * The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
+   * 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 field 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 the user does not exist in the database, returns a list of non-personalized search results and creates the user in the database. This allows for example rotations in the following recommendations for that user, as the user will be already known to the system.
+   *         - Description: If the user does not exist in the database, returns a list of non-personalized search results and creates the user in the database. This allows, for example, rotations in the following recommendations for that user, 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 for easy displaying of the recommended items to the user. 
+   *         - 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:
    * ```
    *   {
@@ -65,7 +65,7 @@ class SearchItems extends rqs.Request {
    * ```
    *     - *includedProperties*
    *         - Type: string[]
-   *         - Description: Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
+   *         - 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`:
    * ```
    *   {
@@ -92,24 +92,24 @@ class SearchItems extends rqs.Request {
    * ```
    *     - *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 be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+   *         - 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 recommendation rate of some items based on the values of their attributes.
-   * Boosters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+   *         - 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|
-   *         - Description: Logic specifies 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 list of available logics and other details.
+   *         - 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 be also set to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
+   * Logic can also be set to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
    *     - *expertSettings*
    *         - Type: 
    *         - Description: Dictionary of custom options.
    *     - *returnAbGroup*
    *         - Type: boolean
-   *         - Description: If there is a custom AB-testing running, return name of group to which the request belongs.
+   *         - Description: If there is a custom AB-testing running, return the name of the group to which the request belongs.
    */
   constructor(userId, searchQuery, count, optional) {
     super('POST', `/search/users/${userId}/items/`, 3000, false);

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

@@ -7,7 +7,7 @@ const rqs = require("./request");
 
 /**
  * Sets viewed portion of an item (for example a video or article) by a user (at a session).
- * If you send new request with the same (`userId`, `itemId`, `sessionId`), the portion gets updated.
+ * If you send a new request with the same (`userId`, `itemId`, `sessionId`), the portion gets updated.
  */
 class SetViewPortion extends rqs.Request {
 
@@ -15,12 +15,12 @@ class SetViewPortion extends rqs.Request {
    * Construct the request
    * @param {string} userId - User who viewed a portion of the item
    * @param {string} itemId - Viewed item
-   * @param {number} portion - Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ). It should be the really viewed part of the item, no matter seeking, so for example if the user seeked immediately to half of the item and then viewed 10% of the item, the `portion` should still be `0.1`.
+   * @param {number} portion - Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ). It should be the actual viewed part of the item, no matter the seeking. For example, if the user seeked immediately to half of the item and then viewed 10% of the item, the `portion` should still be `0.1`.
    * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
    * - Allowed parameters:
    *     - *sessionId*
    *         - Type: string
-   *         - Description: ID of session in which the user viewed the item. Default is `null` (`None`, `nil`, `NULL` etc. depending on language).
+   *         - Description: ID of the session in which the user viewed the item. Default is `null` (`None`, `nil`, `NULL` etc., depending on the language).
    *     - *timestamp*
    *         - Type: string|number
    *         - Description: UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

package/lib/requests/update-auto-reql-segmentation.js

@@ -0,0 +1,66 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Update an existing Segmentation.
+ */
+class UpdateAutoReqlSegmentation extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} segmentationId - ID of the updated Segmentation
+   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
+   * - Allowed parameters:
+   *     - *expression*
+   *         - Type: string
+   *         - Description: ReQL expression that returns for each item a set with IDs of segments to which the item belongs
+   *     - *title*
+   *         - Type: string
+   *         - Description: Human-readable name that is shown in the Recombee Admin UI.
+   *     - *description*
+   *         - Type: string
+   *         - Description: Description that is shown in the Recombee Admin UI.
+   */
+  constructor(segmentationId, optional) {
+    super('POST', `/segmentations/auto-reql/${segmentationId}`, 10000, false);
+    this.segmentationId = segmentationId;
+    optional = optional || {};
+    this.expression = optional.expression;
+    this.title = optional.title;
+    this.description = optional.description;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+
+    if(this.expression !== undefined)
+      params.expression = this.expression;
+
+    if(this.title !== undefined)
+      params.title = this.title;
+
+    if(this.description !== undefined)
+      params.description = this.description;
+
+    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.UpdateAutoReqlSegmentation = UpdateAutoReqlSegmentation

package/lib/requests/update-manual-reql-segment.js

@@ -0,0 +1,57 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Update definition of the Segment.
+ */
+class UpdateManualReqlSegment extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} segmentationId - ID of the Segmentation to which the updated Segment belongs
+   * @param {string} segmentId - ID of the Segment that will be updated
+   * @param {string} filter - ReQL filter that returns `true` for items that belong to this Segment. Otherwise returns `false`.
+   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
+   * - Allowed parameters:
+   *     - *title*
+   *         - Type: string
+   *         - Description: Human-readable name of the Segment that is shown in the Recombee Admin UI.
+   */
+  constructor(segmentationId, segmentId, filter, optional) {
+    super('POST', `/segmentations/manual-reql/${segmentationId}/segments/${segmentId}`, 10000, false);
+    this.segmentationId = segmentationId;
+    this.segmentId = segmentId;
+    this.filter = filter;
+    optional = optional || {};
+    this.title = optional.title;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+    params.filter = this.filter;
+
+    if(this.title !== undefined)
+      params.title = this.title;
+
+    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.UpdateManualReqlSegment = UpdateManualReqlSegment

package/lib/requests/update-manual-reql-segmentation.js

@@ -0,0 +1,59 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Update an existing Segmentation.
+ */
+class UpdateManualReqlSegmentation extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} segmentationId - ID of the updated Segmentation
+   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
+   * - Allowed parameters:
+   *     - *title*
+   *         - Type: string
+   *         - Description: Human-readable name that is shown in the Recombee Admin UI.
+   *     - *description*
+   *         - Type: string
+   *         - Description: Description that is shown in the Recombee Admin UI.
+   */
+  constructor(segmentationId, optional) {
+    super('POST', `/segmentations/manual-reql/${segmentationId}`, 10000, false);
+    this.segmentationId = segmentationId;
+    optional = optional || {};
+    this.title = optional.title;
+    this.description = optional.description;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+
+    if(this.title !== undefined)
+      params.title = this.title;
+
+    if(this.description !== undefined)
+      params.description = this.description;
+
+    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.UpdateManualReqlSegmentation = UpdateManualReqlSegmentation

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

@@ -0,0 +1,53 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Updates (some) property values of all the items that pass the filter.
+ * Example: *Setting all the items that are older than a week as unavailable*
+ *   ```
+ *     {
+ *       "filter": "'releaseDate' < now() - 7*24*3600",
+ *       "changes": {"available": false}
+ *     }
+ *   ```
+ */
+class UpdateMoreItems extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} filter - A [ReQL](https://docs.recombee.com/reql.html) expression, which returns `true` for the items that shall be updated.
+   * @param {} changes - A dictionary where the keys are properties that shall be updated.
+   */
+  constructor(filter, changes) {
+    super('POST', '/more-items/', 1000, false);
+    this.filter = filter;
+    this.changes = changes;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+    params.filter = this.filter;
+    params.changes = this.changes;
+
+    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.UpdateMoreItems = UpdateMoreItems

package/lib/requests/update-property-based-segmentation.js

@@ -0,0 +1,66 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Updates a Property Based Segmentation
+ */
+class UpdatePropertyBasedSegmentation extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} segmentationId - ID of the updated Segmentation
+   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
+   * - Allowed parameters:
+   *     - *propertyName*
+   *         - Type: string
+   *         - Description: Name of the property on which the Segmentation should be based
+   *     - *title*
+   *         - Type: string
+   *         - Description: Human-readable name that is shown in the Recombee Admin UI.
+   *     - *description*
+   *         - Type: string
+   *         - Description: Description that is shown in the Recombee Admin UI.
+   */
+  constructor(segmentationId, optional) {
+    super('POST', `/segmentations/property-based/${segmentationId}`, 10000, false);
+    this.segmentationId = segmentationId;
+    optional = optional || {};
+    this.propertyName = optional.propertyName;
+    this.title = optional.title;
+    this.description = optional.description;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+
+    if(this.propertyName !== undefined)
+      params.propertyName = this.propertyName;
+
+    if(this.title !== undefined)
+      params.title = this.title;
+
+    if(this.description !== undefined)
+      params.description = this.description;
+
+    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.UpdatePropertyBasedSegmentation = UpdatePropertyBasedSegmentation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "recombee-api-client",
-  "version": "3.2.0",
+  "version": "4.1.0",
   "description": "Node.js client (SDK) for easy use of the Recombee recommendation API",
   "main": "index.js",
   "scripts": {
@@ -26,8 +26,7 @@
   },
   "homepage": "https://github.com/Recombee/node-api-client#readme",
   "dependencies": {
-    "request-promise": "^4.2.5",
-    "request": "^2.88.0",
+    "got": "^11.8.2",
     "jssha": "^2.3.0"
   },
   "devDependencies": {

package/test/add-bookmark-test.js

@@ -55,9 +55,12 @@ describe('AddBookmark', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -69,9 +72,12 @@ describe('AddBookmark', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -83,9 +89,12 @@ describe('AddBookmark', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -99,9 +108,12 @@ describe('AddBookmark', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-cart-addition-test.js

@@ -55,9 +55,12 @@ describe('AddCartAddition', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -69,9 +72,12 @@ describe('AddCartAddition', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -83,9 +89,12 @@ describe('AddCartAddition', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -99,9 +108,12 @@ describe('AddCartAddition', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-detail-view-test.js

@@ -55,9 +55,12 @@ describe('AddDetailView', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -69,9 +72,12 @@ describe('AddDetailView', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -83,9 +89,12 @@ describe('AddDetailView', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -99,9 +108,12 @@ describe('AddDetailView', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-group-test.js

@@ -37,9 +37,12 @@ describe('AddGroup', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -53,9 +56,12 @@ describe('AddGroup', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });