recombee-api-client 3.2.0 → 4.1.0

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

@@ -0,0 +1,63 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Segment the items using multiple [ReQL](https://docs.recombee.com/reql.html) filters.
+ * Use the Add Manual ReQL Items Segment endpoint to create the individual segments.
+ */
+class CreateManualReqlSegmentation extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} segmentationId - ID of the newly created Segmentation
+   * @param {string} sourceType - What type of data should be segmented. Currently only `items` are supported.
+   * @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, sourceType, optional) {
+    super('PUT', `/segmentations/manual-reql/${segmentationId}`, 10000, false);
+    this.segmentationId = segmentationId;
+    this.sourceType = sourceType;
+    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 = {};
+    params.sourceType = this.sourceType;
+
+    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.CreateManualReqlSegmentation = CreateManualReqlSegmentation

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

@@ -0,0 +1,67 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Creates a Segmentation that splits the items into segments based on values of a particular item property.
+ * A segment is created for each unique value of the property.
+ * In case of `set` properties, a segment is created for each value in the set. Item belongs to all these segments.
+ */
+class CreatePropertyBasedSegmentation extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} segmentationId - ID of the newly created Segmentation
+   * @param {string} sourceType - What type of data should be segmented. Currently only `items` are supported.
+   * @param {string} propertyName - Name of the property on which the Segmentation should be based
+   * @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, sourceType, propertyName, optional) {
+    super('PUT', `/segmentations/property-based/${segmentationId}`, 10000, false);
+    this.segmentationId = segmentationId;
+    this.sourceType = sourceType;
+    this.propertyName = propertyName;
+    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 = {};
+    params.sourceType = this.sourceType;
+    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.CreatePropertyBasedSegmentation = CreatePropertyBasedSegmentation

package/lib/requests/delete-bookmark.js

@@ -6,19 +6,19 @@
 const rqs = require("./request");
 
 /**
- * Deletes a bookmark uniquely specified by `userId`, `itemId`, and `timestamp` or all the bookmarks with given `userId` and `itemId` if `timestamp` is omitted.
+ * Deletes a bookmark uniquely specified by `userId`, `itemId`, and `timestamp` or all the bookmarks with the given `userId` and `itemId` if `timestamp` is omitted.
  */
 class DeleteBookmark extends rqs.Request {
 
   /**
    * Construct the request
    * @param {string} userId - ID of the user who made the bookmark.
-   * @param {string} itemId - ID of the item of which was bookmarked.
+   * @param {string} itemId - ID of the item which was bookmarked.
    * @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 bookmark. If the `timestamp` is omitted, then all the bookmarks with given `userId` and `itemId` are deleted.
+   *         - Description: Unix timestamp of the bookmark. If the `timestamp` is omitted, then all the bookmarks with the given `userId` and `itemId` are deleted.
    */
   constructor(userId, itemId, optional) {
     super('DELETE', '/bookmarks/', 1000, false);

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

@@ -6,19 +6,19 @@
 const rqs = require("./request");
 
 /**
- * Deletes an existing cart addition uniquely specified by `userId`, `itemId`, and `timestamp` or all the cart additions with given `userId` and `itemId` if `timestamp` is omitted.
+ * Deletes an existing cart addition uniquely specified by `userId`, `itemId`, and `timestamp` or all the cart additions with the given `userId` and `itemId` if `timestamp` is omitted.
  */
 class DeleteCartAddition extends rqs.Request {
 
   /**
    * Construct the request
    * @param {string} userId - ID of the user who made the cart addition.
-   * @param {string} itemId - ID of the item of which was added to cart.
+   * @param {string} itemId - ID of the item which was added to the cart.
    * @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 cart addition. If the `timestamp` is omitted, then all the cart additions with given `userId` and `itemId` are deleted.
+   *         - Description: Unix timestamp of the cart addition. If the `timestamp` is omitted, then all the cart additions with the given `userId` and `itemId` are deleted.
    */
   constructor(userId, itemId, optional) {
     super('DELETE', '/cartadditions/', 1000, false);

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

@@ -6,19 +6,19 @@
 const rqs = require("./request");
 
 /**
- * Deletes an existing detail view uniquely specified by (`userId`, `itemId`, and `timestamp`) or all the detail views with given `userId` and `itemId` if `timestamp` is omitted.
+ * Deletes an existing detail view uniquely specified by (`userId`, `itemId`, and `timestamp`) or all the detail views with the given `userId` and `itemId` if `timestamp` is omitted.
  */
 class DeleteDetailView extends rqs.Request {
 
   /**
    * Construct the request
    * @param {string} userId - ID of the user who made the detail view.
-   * @param {string} itemId - ID of the item of which the details were viewed.
+   * @param {string} itemId - ID of the item whose details were viewed.
    * @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 detail view. If the `timestamp` is omitted, then all the detail views with given `userId` and `itemId` are deleted.
+   *         - Description: Unix timestamp of the detail view. If the `timestamp` is omitted, then all the detail views with the given `userId` and `itemId` are deleted.
    */
   constructor(userId, itemId, optional) {
     super('DELETE', '/detailviews/', 1000, false);

package/lib/requests/delete-group.js

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

package/lib/requests/delete-item.js

@@ -6,9 +6,9 @@
 const rqs = require("./request");
 
 /**
- * Deletes an item of given `itemId` from the catalog.
- * If there are any *purchases*, *ratings*, *bookmarks*, *cart additions* or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
- * If an item becomes obsolete/no longer available, it is often meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and only exclude the item from recommendations. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
+ * Deletes an item of the given `itemId` from the catalog.
+ * If there are any *purchases*, *ratings*, *bookmarks*, *cart additions*, or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
+ * If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
  */
 class DeleteItem extends rqs.Request {
 

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

@@ -0,0 +1,44 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Delete a Segment from a Manual ReQL Segmentation.
+ */
+class DeleteManualReqlSegment extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} segmentationId - ID of the Segmentation from which the Segment should be deleted
+   * @param {string} segmentId - ID of the Segment that should be deleted
+   */
+  constructor(segmentationId, segmentId) {
+    super('DELETE', `/segmentations/manual-reql/${segmentationId}/segments/${segmentId}`, 10000, false);
+    this.segmentationId = segmentationId;
+    this.segmentId = segmentId;
+  }
+
+  /**
+   * 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.DeleteManualReqlSegment = DeleteManualReqlSegment

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

@@ -0,0 +1,44 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Deletes all the items that pass the filter.
+ * If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
+ */
+class DeleteMoreItems 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.
+   */
+  constructor(filter) {
+    super('DELETE', '/more-items/', 1000, false);
+    this.filter = filter;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+    params.filter = this.filter;
+
+    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.DeleteMoreItems = DeleteMoreItems

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,14 +6,14 @@
 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 {
 
   /**
    * Construct the request
-   * @param {string} userId - ID of the user to be added.
+   * @param {string} userId - ID of the user to be deleted.
    */
   constructor(userId) {
     super('DELETE', `/users/${userId}`, 1000, false);

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

@@ -12,6 +12,8 @@ exports.AddItemProperty = require("./add-item-property").AddItemProperty;
 exports.DeleteItemProperty = require("./delete-item-property").DeleteItemProperty;
 exports.GetItemPropertyInfo = require("./get-item-property-info").GetItemPropertyInfo;
 exports.ListItemProperties = require("./list-item-properties").ListItemProperties;
+exports.UpdateMoreItems = require("./update-more-items").UpdateMoreItems;
+exports.DeleteMoreItems = require("./delete-more-items").DeleteMoreItems;
 exports.AddSeries = require("./add-series").AddSeries;
 exports.DeleteSeries = require("./delete-series").DeleteSeries;
 exports.ListSeries = require("./list-series").ListSeries;
@@ -63,12 +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.UserBasedRecommendation = require("./user-based-recommendation").UserBasedRecommendation;
-exports.ItemBasedRecommendation = require("./item-based-recommendation").ItemBasedRecommendation;
+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);