recombee-api-client 4.0.0 → 4.1.1

package/lib/requests/delete-purchase.js

@@ -6,19 +6,19 @@
 const rqs = require("./request");
 
 /**
- * Deletes an existing purchase uniquely specified by `userId`, `itemId`, and `timestamp` or all the purchases with given `userId` and `itemId` if `timestamp` is omitted.
+ * Deletes an existing purchase uniquely specified by `userId`, `itemId`, and `timestamp` or all the purchases with the given `userId` and `itemId` if `timestamp` is omitted.
  */
 class DeletePurchase extends rqs.Request {
 
   /**
    * Construct the request
    * @param {string} userId - ID of the user who made the purchase.
-   * @param {string} itemId - ID of the item of which was purchased.
+   * @param {string} itemId - ID of the item which was purchased.
    * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
    * - Allowed parameters:
    *     - *timestamp*
    *         - Type: number
-   *         - Description: Unix timestamp of the purchase. If the `timestamp` is omitted, then all the purchases with given `userId` and `itemId` are deleted.
+   *         - 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);

package/lib/requests/delete-rating.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Deletes an existing rating specified by (`userId`, `itemId`, `timestamp`) from the database or all the ratings with given `userId` and `itemId` if `timestamp` is omitted.
+ * Deletes an existing rating specified by (`userId`, `itemId`, `timestamp`) from the database or all the ratings with the given `userId` and `itemId` if `timestamp` is omitted.
  */
 class DeleteRating extends rqs.Request {
 
@@ -18,7 +18,7 @@ class DeleteRating extends rqs.Request {
    * - Allowed parameters:
    *     - *timestamp*
    *         - Type: number
-   *         - Description: Unix timestamp of the rating. If the `timestamp` is omitted, then all the ratings with given `userId` and `itemId` are deleted.
+   *         - 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);

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

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Deletes synonym of given `id` and this synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
+ * Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
  */
 class DeleteSearchSynonym extends rqs.Request {
 

package/lib/requests/delete-segmentation.js

@@ -0,0 +1,42 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Delete existing Segmentation.
+ */
+class DeleteSegmentation extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} segmentationId - ID of the Segmentation that should be deleted
+   */
+  constructor(segmentationId) {
+    super('DELETE', `/segmentations/${segmentationId}`, 10000, false);
+    this.segmentationId = segmentationId;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+
+    return params;
+  }
+
+  /**
+   * Get query parameters
+   * @return {Object} The values of query parameters (name of parameter: value of the parameter)
+   */
+  queryParameters() {
+    let params = {};
+    return params;
+  }
+}
+
+exports.DeleteSegmentation = DeleteSegmentation

package/lib/requests/delete-series.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Deletes the series of given `seriesId` from the database.
+ * Deletes the series of the given `seriesId` from the database.
  * Deleting a series will only delete assignment of items to it, not the items themselves!
  */
 class DeleteSeries extends rqs.Request {

package/lib/requests/delete-user-property.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Deleting an user property is roughly equivalent to removing a column from the table of users.
+ * Deleting a user property is roughly equivalent to removing a column from the table of users.
  */
 class DeleteUserProperty extends rqs.Request {
 

package/lib/requests/delete-user.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Deletes a user of given *userId* from the database.
+ * Deletes a user of the given *userId* from the database.
  * If there are any purchases, ratings, bookmarks, cart additions or detail views made by the user present in the database, they will be deleted in cascade as well.
  */
 class DeleteUser extends rqs.Request {

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

@@ -6,13 +6,13 @@
 const rqs = require("./request");
 
 /**
- * Get all the current property values of a given item.
+ * Gets all the current property values of the given item.
  */
 class GetItemValues extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} itemId - ID of the item properties of which are to be obtained.
+   * @param {string} itemId - ID of the item whose properties are to be obtained.
    */
   constructor(itemId) {
     super('GET', `/items/${itemId}`, 1000, false);

package/lib/requests/get-segmentation.js

@@ -0,0 +1,42 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Get existing Segmentation.
+ */
+class GetSegmentation extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} segmentationId - ID of the Segmentation that should be returned
+   */
+  constructor(segmentationId) {
+    super('GET', `/segmentations/list/${segmentationId}`, 10000, false);
+    this.segmentationId = segmentationId;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+
+    return params;
+  }
+
+  /**
+   * Get query parameters
+   * @return {Object} The values of query parameters (name of parameter: value of the parameter)
+   */
+  queryParameters() {
+    let params = {};
+    return params;
+  }
+}
+
+exports.GetSegmentation = GetSegmentation

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

@@ -6,13 +6,13 @@
 const rqs = require("./request");
 
 /**
- * Get all the current property values of a given user.
+ * Gets all the current property values of the given user.
  */
 class GetUserValues extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} userId - ID of the user properties of which are to be obtained.
+   * @param {string} userId - ID of the user whose properties are to be obtained.
    */
   constructor(userId) {
     super('GET', `/users/${userId}`, 1000, false);

package/lib/requests/index.js

@@ -65,10 +65,26 @@ exports.RecommendItemsToItem = require("./recommend-items-to-item").RecommendIte
 exports.RecommendNextItems = require("./recommend-next-items").RecommendNextItems;
 exports.RecommendUsersToUser = require("./recommend-users-to-user").RecommendUsersToUser;
 exports.RecommendUsersToItem = require("./recommend-users-to-item").RecommendUsersToItem;
+exports.RecommendItemSegmentsToUser = require("./recommend-item-segments-to-user").RecommendItemSegmentsToUser;
+exports.RecommendItemSegmentsToItem = require("./recommend-item-segments-to-item").RecommendItemSegmentsToItem;
+exports.RecommendItemSegmentsToItemSegment = require("./recommend-item-segments-to-item-segment").RecommendItemSegmentsToItemSegment;
 exports.SearchItems = require("./search-items").SearchItems;
+exports.SearchItemSegments = require("./search-item-segments").SearchItemSegments;
 exports.AddSearchSynonym = require("./add-search-synonym").AddSearchSynonym;
 exports.ListSearchSynonyms = require("./list-search-synonyms").ListSearchSynonyms;
 exports.DeleteAllSearchSynonyms = require("./delete-all-search-synonyms").DeleteAllSearchSynonyms;
 exports.DeleteSearchSynonym = require("./delete-search-synonym").DeleteSearchSynonym;
+exports.CreatePropertyBasedSegmentation = require("./create-property-based-segmentation").CreatePropertyBasedSegmentation;
+exports.UpdatePropertyBasedSegmentation = require("./update-property-based-segmentation").UpdatePropertyBasedSegmentation;
+exports.CreateAutoReqlSegmentation = require("./create-auto-reql-segmentation").CreateAutoReqlSegmentation;
+exports.UpdateAutoReqlSegmentation = require("./update-auto-reql-segmentation").UpdateAutoReqlSegmentation;
+exports.CreateManualReqlSegmentation = require("./create-manual-reql-segmentation").CreateManualReqlSegmentation;
+exports.UpdateManualReqlSegmentation = require("./update-manual-reql-segmentation").UpdateManualReqlSegmentation;
+exports.AddManualReqlSegment = require("./add-manual-reql-segment").AddManualReqlSegment;
+exports.UpdateManualReqlSegment = require("./update-manual-reql-segment").UpdateManualReqlSegment;
+exports.DeleteManualReqlSegment = require("./delete-manual-reql-segment").DeleteManualReqlSegment;
+exports.ListSegmentations = require("./list-segmentations").ListSegmentations;
+exports.GetSegmentation = require("./get-segmentation").GetSegmentation;
+exports.DeleteSegmentation = require("./delete-segmentation").DeleteSegmentation;
 exports.ResetDatabase = require("./reset-database").ResetDatabase;
 exports.Batch = require("./batch").Batch;

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

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Inserts an existing item/group into group of given `groupId`.
+ * Inserts an existing item/group into a group of the given `groupId`.
  */
 class InsertToGroup extends rqs.Request {
 
@@ -19,7 +19,7 @@ class InsertToGroup extends rqs.Request {
    * - Allowed parameters:
    *     - *cascadeCreate*
    *         - Type: boolean
-   *         - Description: Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `groupId` and the `groupId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either items or group 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 `groupId` and the `groupId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. Either items or group may be created if not present in the database.
    */
   constructor(groupId, itemType, itemId, optional) {
     super('POST', `/groups/${groupId}/items/`, 1000, false);

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

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Inserts an existing item/series into series of given seriesId at position determined by time.
+ * Inserts an existing item/series into a series of the given seriesId at a position determined by time.
  */
 class InsertToSeries extends rqs.Request {
 
@@ -20,7 +20,7 @@ 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 is corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set 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`. Either item or series may be created if not present in the database.
    */
   constructor(seriesId, itemType, itemId, time, optional) {
     super('POST', `/series/${seriesId}/items/`, 1000, false);

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

@@ -12,7 +12,7 @@ class ListGroupItems extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} groupId - ID of the group items of which are to be listed.
+   * @param {string} groupId - ID of the group whose items are to be listed.
    */
   constructor(groupId) {
     super('GET', `/groups/${groupId}/items/`, 100000, false);

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

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

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

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

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: