recombee-api-client 3.2.0 → 4.1.0

package/lib/requests/list-item-detail-views.js

@@ -6,13 +6,13 @@
 const rqs = require("./request");
 
 /**
- * List all the detail views of a given item ever made by different users.
+ * Lists all the detail views of the given item ever made by different users.
  */
 class ListItemDetailViews extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} itemId - ID of the item of which the detail views are to be listed.
+   * @param {string} itemId - ID of the item whose detail views are to be listed.
    */
   constructor(itemId) {
     super('GET', `/items/${itemId}/detailviews/`, 100000, false);

package/lib/requests/list-item-purchases.js

@@ -6,13 +6,13 @@
 const rqs = require("./request");
 
 /**
- * List all the ever-made purchases of a given item.
+ * Lists all the ever-made purchases of the given item.
  */
 class ListItemPurchases extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} itemId - ID of the item of which the pucrhases are to be listed.
+   * @param {string} itemId - ID of the item whose purchases are to be listed.
    */
   constructor(itemId) {
     super('GET', `/items/${itemId}/purchases/`, 100000, false);

package/lib/requests/list-item-ratings.js

@@ -6,13 +6,13 @@
 const rqs = require("./request");
 
 /**
- * List all the ratings of an item ever submitted by different users.
+ * Lists all the ratings of an item ever submitted by different users.
  */
 class ListItemRatings extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} itemId - ID of the item of which the ratings are to be listed.
+   * @param {string} itemId - ID of the item whose ratings are to be listed.
    */
   constructor(itemId) {
     super('GET', `/items/${itemId}/ratings/`, 100000, false);

package/lib/requests/list-item-view-portions.js

@@ -6,13 +6,13 @@
 const rqs = require("./request");
 
 /**
- * List all the view portions of an item ever submitted by different users.
+ * Lists all the view portions of an item ever submitted by different users.
  */
 class ListItemViewPortions extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} itemId - ID of the item of which the view portions are to be listed.
+   * @param {string} itemId - ID of the item whose view portions are to be listed.
    */
   constructor(itemId) {
     super('GET', `/items/${itemId}/viewportions/`, 100000, false);

package/lib/requests/list-items.js

@@ -47,7 +47,7 @@ class ListItems 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`:
    * ```
    *   [

package/lib/requests/list-segmentations.js

@@ -0,0 +1,43 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Return all existing items Segmentations.
+ */
+class ListSegmentations extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} sourceType - List Segmentations based on a particular type of data. Currently only `items` are supported.
+   */
+  constructor(sourceType) {
+    super('GET', '/segmentations/list/', 10000, false);
+    this.sourceType = sourceType;
+  }
+
+  /**
+   * 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 = {};
+    params.sourceType = this.sourceType;
+    return params;
+  }
+}
+
+exports.ListSegmentations = ListSegmentations

package/lib/requests/list-series-items.js

@@ -6,13 +6,13 @@
 const rqs = require("./request");
 
 /**
- * List all the items present in the given series, sorted according to their time index values.
+ * Lists all the items present in the given series, sorted according to their time index values.
  */
 class ListSeriesItems extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} seriesId - ID of the series items of which are to be listed.
+   * @param {string} seriesId - ID of the series whose items are to be listed.
    */
   constructor(seriesId) {
     super('GET', `/series/${seriesId}/items/`, 100000, false);

package/lib/requests/list-user-bookmarks.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * List all the bookmarks ever made by a given user.
+ * Lists all the bookmarks ever made by the given user.
  */
 class ListUserBookmarks extends rqs.Request {
 

package/lib/requests/list-user-cart-additions.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * List all the cart additions ever made by a given user.
+ * Lists all the cart additions ever made by the given user.
  */
 class ListUserCartAdditions extends rqs.Request {
 

package/lib/requests/list-user-detail-views.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Lists all the detail views of different items ever made by a given user.
+ * Lists all the detail views of different items ever made by the given user.
  */
 class ListUserDetailViews extends rqs.Request {
 

package/lib/requests/list-user-purchases.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * List all the purchases ever made by a given user.
+ * Lists all the purchases ever made by the given user.
  */
 class ListUserPurchases extends rqs.Request {
 

package/lib/requests/list-user-ratings.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * List all the ratings ever submitted by a given user.
+ * Lists all the ratings ever submitted by the given user.
  */
 class ListUserRatings extends rqs.Request {
 

package/lib/requests/list-user-view-portions.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * List all the view portions ever submitted by a given user.
+ * Lists all the view portions ever submitted by the given user.
  */
 class ListUserViewPortions extends rqs.Request {
 

package/lib/requests/list-users.js

@@ -43,7 +43,7 @@ class ListUsers 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=country`:
    * ```
    *   [

package/lib/requests/merge-users.js

@@ -6,14 +6,14 @@
 const rqs = require("./request");
 
 /**
- * Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable.
+ * Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two becomes desirable.
  * Merging happens between two users referred to as the *target* and the *source*. After the merge, all the interactions of the source user are attributed to the target user, and the source user is **deleted**.
  */
 class MergeUsers extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} targetUserId - ID of the targer user.
+   * @param {string} targetUserId - ID of the target user.
    * @param {string} sourceUserId - ID of the source user.
    * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
    * - Allowed parameters:

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

@@ -0,0 +1,125 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Recommends Segments from a result Segmentation 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.
+ * 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.
+ */
+class RecommendItemSegmentsToItemSegment 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 item segments 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 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`.
+   *     - *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`.
+   *     - *logic*
+   *         - Type: string|
+   *         - 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).
+   *     - *expertSettings*
+   *         - Type: 
+   *         - 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/item-segments/', 3000, false);
+    this.contextSegmentId = contextSegmentId;
+    this.targetUserId = targetUserId;
+    this.count = count;
+    optional = optional || {};
+    this.scenario = optional.scenario;
+    this.cascadeCreate = optional.cascadeCreate;
+    this.filter = optional.filter;
+    this.booster = optional.booster;
+    this.logic = optional.logic;
+    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.filter !== undefined)
+      params.filter = this.filter;
+
+    if(this.booster !== undefined)
+      params.booster = this.booster;
+
+    if(this.logic !== undefined)
+      params.logic = this.logic;
+
+    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.RecommendItemSegmentsToItemSegment = RecommendItemSegmentsToItemSegment

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

@@ -0,0 +1,125 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Recommends Segments from a Segmentation 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.
+ * 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.
+ */
+class RecommendItemSegmentsToItem extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} itemId - ID of the item 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 item segments 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 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`.
+   *     - *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`.
+   *     - *logic*
+   *         - Type: string|
+   *         - 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).
+   *     - *expertSettings*
+   *         - Type: 
+   *         - 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(itemId, targetUserId, count, optional) {
+    super('POST', `/recomms/items/${itemId}/item-segments/`, 3000, false);
+    this.itemId = itemId;
+    this.targetUserId = targetUserId;
+    this.count = count;
+    optional = optional || {};
+    this.scenario = optional.scenario;
+    this.cascadeCreate = optional.cascadeCreate;
+    this.filter = optional.filter;
+    this.booster = optional.booster;
+    this.logic = optional.logic;
+    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.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.filter !== undefined)
+      params.filter = this.filter;
+
+    if(this.booster !== undefined)
+      params.booster = this.booster;
+
+    if(this.logic !== undefined)
+      params.logic = this.logic;
+
+    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.RecommendItemSegmentsToItem = RecommendItemSegmentsToItem

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

@@ -0,0 +1,110 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Recommends the top Segments from a Segmentation 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.
+ * 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.
+ */
+class RecommendItemSegmentsToUser extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} userId - ID of the user for whom personalized recommendations are to be generated.
+   * @param {number} count - Number of item segments 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 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`.
+   *     - *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`.
+   *     - *logic*
+   *         - Type: string|
+   *         - 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).
+   *     - *expertSettings*
+   *         - Type: 
+   *         - 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(userId, count, optional) {
+    super('POST', `/recomms/users/${userId}/item-segments/`, 3000, false);
+    this.userId = userId;
+    this.count = count;
+    optional = optional || {};
+    this.scenario = optional.scenario;
+    this.cascadeCreate = optional.cascadeCreate;
+    this.filter = optional.filter;
+    this.booster = optional.booster;
+    this.logic = optional.logic;
+    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.count = this.count;
+
+    if(this.scenario !== undefined)
+      params.scenario = this.scenario;
+
+    if(this.cascadeCreate !== undefined)
+      params.cascadeCreate = this.cascadeCreate;
+
+    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.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.RecommendItemSegmentsToUser = RecommendItemSegmentsToUser