recombee-api-client 5.0.2 → 5.1.1

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

@@ -21,7 +21,7 @@ class RecommendUsersToUser extends rqs.Request {
    *     - *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.
+   * You can set various settings to the [scenario](https://docs.recombee.com/scenarios) 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
@@ -80,30 +80,30 @@ class RecommendUsersToUser 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 also be 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) expression, which allows you to filter recommended users based on the values of their attributes.
+   * Filters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) 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).
+   *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql) expression, which allows you to boost the recommendation rate of some users based on the values of their attributes.
+   * Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios) 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.
+   * See [this section](https://docs.recombee.com/recommendation_logics) 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).
+   * Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
    *     - *diversity*
    *         - Type: number
-   *         - Description: **Expert option** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended users should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
+   *         - Description: **Expert option:** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended users should 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 relevant must the recommended users be. Possible values one of: "low", "medium", "high".
+   *         - Description: **Expert option:** Specifies the threshold of how relevant must the recommended users be. Possible values one of: "low", "medium", "high".
    *     - *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 a backward fashion. You may penalize a user 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 users.
+   *         - 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 a backward fashion. You may penalize a user 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 users.
    *     - *rotationTime*
    *         - Type: number
-   *         - Description: **Expert option** Taking *rotationRate* into account, specifies how long it takes for a user to recover from the penalization. For example, `rotationTime=7200.0` means that users recommended less than 2 hours ago are penalized.
+   *         - Description: **Expert option:** Taking *rotationRate* into account, specifies how long it takes for a user to recover from the penalization. For example, `rotationTime=7200.0` means that users recommended less than 2 hours ago are penalized.
    *     - *expertSettings*
    *         - Type: object
    *         - Description: Dictionary of custom options.

package/lib/requests/search-item-segments.js

@@ -27,23 +27,23 @@ class SearchItemSegments extends rqs.Request {
    *     - *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.
+   * You can set various settings to the [scenario](https://docs.recombee.com/scenarios) 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 the user does not exist in the database, returns a list of non-personalized recommendations 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.
    *     - *filter*
    *         - Type: string
-   *         - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended segments based on the `segmentationId`.
+   *         - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to filter recommended segments based on the `segmentationId`.
    *     - *booster*
    *         - Type: string
-   *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
+   *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql) expression which allows you to boost recommendation rate of some segments based on the `segmentationId`.
    *     - *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.
+   * See [this section](https://docs.recombee.com/recommendation_logics) 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).
+   * Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
    *     - *expertSettings*
    *         - Type: object
    *         - Description: Dictionary of custom options.

package/lib/requests/search-items.js

@@ -11,8 +11,8 @@ const rqs = require("./request");
  * 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).
- * - 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).
+ * - 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#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#recommend-next-items).
  * 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,7 +27,7 @@ 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 the performance of each scenario in the Admin UI separately, so you can check how well each field performs.
+   * You can set various settings to the [scenario](https://docs.recombee.com/scenarios) 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
@@ -92,18 +92,18 @@ 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 also be 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) 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) 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).
+   *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql) 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) 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.
+   * See [this section](https://docs.recombee.com/recommendation_logics) 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).
+   * Logic can also be set to a [scenario](https://docs.recombee.com/scenarios) in the [Admin UI](https://admin.recombee.com).
    *     - *expertSettings*
    *         - Type: object
    *         - Description: Dictionary of custom options.

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

@@ -2,7 +2,7 @@
 const svr = require("./set-values");
 
 /**
- * Set/update (some) property values of a given item. The properties (columns) must be previously created by [Add item property](https://docs.recombee.com/api.html#add-item-property).
+ * Set/update (some) property values of a given item. The properties (columns) must be previously created by [Add item property](https://docs.recombee.com/api#add-item-property).
  */
 class SetItemValues extends svr.SetValues {
 

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

@@ -2,7 +2,7 @@
 const svr = require("./set-values");
 
 /**
- * Set/update (some) property values of a given user. The properties (columns) must be previously created by [Add user property](https://docs.recombee.com/api.html#add-user-property).
+ * Set/update (some) property values of a given user. The properties (columns) must be previously created by [Add user property](https://docs.recombee.com/api#add-user-property).
  */
 class SetUserValues extends svr.SetValues {
   /**

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

@@ -23,7 +23,7 @@ class SetViewPortion extends rqs.Request {
    *         - 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.
+   *         - Description: UTC timestamp of the view portion as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
    *     - *cascadeCreate*
    *         - Type: boolean
    *         - Description: Sets whether the given user/item should be created if not present in the database.

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

@@ -19,7 +19,7 @@ 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 {string} filter - A [ReQL](https://docs.recombee.com/reql) expression, which returns `true` for the items that shall be updated.
    * @param {object} changes - A dictionary where the keys are properties that shall be updated.
    */
   constructor(filter, changes) {

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "recombee-api-client",
-  "version": "5.0.2",
+  "version": "5.1.1",
   "description": "Node.js client (SDK) for easy use of the Recombee recommendation API",
   "main": "index.js",
   "types": "lib/index.d.ts",
+  "packageManager": "pnpm@8.12.0",
   "scripts": {
     "test": "mocha test"
   },
@@ -21,7 +22,7 @@
     "SDK"
   ],
   "engines": {
-    "node": ">=13.2.0"
+    "node": ">=18"
   },
   "author": "Ondrej Fiedler <ondrej.fiedler@recombee.com> (https://www.recombee.com/)",
   "license": "MIT",
@@ -30,12 +31,12 @@
   },
   "homepage": "https://github.com/Recombee/node-api-client#readme",
   "dependencies": {
-    "jssha": "^2.3.0",
-    "ky": "^1.7.2"
+    "jssha": "2.4.2",
+    "ky": "1.7.5"
   },
   "devDependencies": {
-    "chai": "^3.5.0",
-    "mocha": "~10.2.0",
-    "typescript": "~5.3.3"
+    "chai": "3.5.0",
+    "mocha": "10.2.0",
+    "typescript": "5.3.3"
   }
 }

package/test/list-scenarios-batch_test.js

@@ -0,0 +1,33 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('ListScenarios', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      setTimeout(done, 20000);
+     });
+  });
+  it ('works in batch', (done) => {
+    let requests = [
+      new rqs.ListScenarios()
+      ];
+    
+    env.client.send(new rqs.Batch(requests))
+    .then((responses) => {
+        chai.equal(responses[0].code, 200);
+      done();
+    });
+  });
+});

package/test/list-scenarios-callback_test.js

@@ -0,0 +1,35 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('ListScenarios', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      setTimeout(done, 20000);
+     });
+  });
+  
+  it ('lists scenarios', (done) => {
+    let req, req2, resp;
+    req = new rqs.ListScenarios();
+    env.client.send(req,((err,res) => {
+      if(err) {
+        chai.fail();
+      }
+      else {
+        done();
+      }
+    }));
+  });
+});

package/test/list-scenarios-test.js

@@ -0,0 +1,31 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('ListScenarios', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      setTimeout(done, 20000);
+     });
+  });
+  
+  it ('lists scenarios', (done) => {
+    let req, req2, resp;
+    req = new rqs.ListScenarios();
+    env.client.send(req)
+    .then((res) => {
+      done();
+    });
+  });
+});