recombee-api-client 4.1.0 → 4.1.2

package/lib/requests/add-bookmark.js

@@ -17,7 +17,7 @@ class AddBookmark extends rqs.Request {
    * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
    * - Allowed parameters:
    *     - *timestamp*
-   *         - Type: string|number
+   *         - Type: string | number
    *         - Description: UTC timestamp of the bookmark as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
    *     - *cascadeCreate*
    *         - Type: boolean
@@ -26,7 +26,7 @@ class AddBookmark extends rqs.Request {
    *         - Type: string
    *         - Description: If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
    *     - *additionalData*
-   *         - Type: 
+   *         - Type: object
    *         - Description: A dictionary of additional data for the interaction.
    */
   constructor(userId, itemId, optional) {

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

@@ -17,7 +17,7 @@ class AddCartAddition extends rqs.Request {
    * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
    * - Allowed parameters:
    *     - *timestamp*
-   *         - Type: string|number
+   *         - Type: string | number
    *         - Description: UTC timestamp of the cart addition as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
    *     - *cascadeCreate*
    *         - Type: boolean
@@ -32,7 +32,7 @@ class AddCartAddition extends rqs.Request {
    *         - Type: string
    *         - Description: If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.
    *     - *additionalData*
-   *         - Type: 
+   *         - Type: object
    *         - Description: A dictionary of additional data for the interaction.
    */
   constructor(userId, itemId, optional) {

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

@@ -17,7 +17,7 @@ class AddDetailView extends rqs.Request {
    * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
    * - Allowed parameters:
    *     - *timestamp*
-   *         - Type: string|number
+   *         - Type: string | number
    *         - Description: UTC timestamp of the view as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
    *     - *duration*
    *         - Type: number
@@ -29,7 +29,7 @@ class AddDetailView extends rqs.Request {
    *         - Type: string
    *         - Description: If this detail view is based on a recommendation request, `recommId` is the id of the clicked recommendation.
    *     - *additionalData*
-   *         - Type: 
+   *         - Type: object
    *         - Description: A dictionary of additional data for the interaction.
    */
   constructor(userId, itemId, optional) {

package/lib/requests/add-purchase.js

@@ -17,7 +17,7 @@ class AddPurchase extends rqs.Request {
    * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
    * - Allowed parameters:
    *     - *timestamp*
-   *         - Type: string|number
+   *         - Type: string | number
    *         - Description: UTC timestamp of the purchase as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
    *     - *cascadeCreate*
    *         - Type: boolean
@@ -35,7 +35,7 @@ class AddPurchase extends rqs.Request {
    *         - Type: string
    *         - Description: If this purchase is based on a recommendation request, `recommId` is the id of the clicked recommendation.
    *     - *additionalData*
-   *         - Type: 
+   *         - Type: object
    *         - Description: A dictionary of additional data for the interaction.
    */
   constructor(userId, itemId, optional) {

package/lib/requests/add-rating.js

@@ -18,7 +18,7 @@ class AddRating extends rqs.Request {
    * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
    * - Allowed parameters:
    *     - *timestamp*
-   *         - Type: string|number
+   *         - Type: string | number
    *         - Description: UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
    *     - *cascadeCreate*
    *         - Type: boolean
@@ -27,7 +27,7 @@ class AddRating extends rqs.Request {
    *         - Type: string
    *         - Description: If this rating is based on a recommendation request, `recommId` is the id of the clicked recommendation.
    *     - *additionalData*
-   *         - Type: 
+   *         - Type: object
    *         - Description: A dictionary of additional data for the interaction.
    */
   constructor(userId, itemId, rating, optional) {

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

@@ -16,7 +16,7 @@ class DeleteMoreItems extends rqs.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);
+    super('DELETE', '/more-items/', 100000, false);
     this.filter = filter;
   }
 

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

@@ -51,13 +51,13 @@ class RecommendItemSegmentsToItemSegment extends rqs.Request {
    *         - 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|
+   *         - 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.
    * 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: 
+   *         - Type: object
    *         - Description: Dictionary of custom options.
    *     - *returnAbGroup*
    *         - Type: boolean

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

@@ -52,13 +52,13 @@ class RecommendItemSegmentsToItem extends rqs.Request {
    *         - 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|
+   *         - 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.
    * 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: 
+   *         - Type: object
    *         - Description: Dictionary of custom options.
    *     - *returnAbGroup*
    *         - Type: boolean

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

@@ -39,13 +39,13 @@ class RecommendItemSegmentsToUser extends rqs.Request {
    *         - 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|
+   *         - 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.
    * 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: 
+   *         - Type: object
    *         - Description: Dictionary of custom options.
    *     - *returnAbGroup*
    *         - Type: boolean

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

@@ -109,7 +109,7 @@ class RecommendItemsToItem extends rqs.Request {
    *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
    * Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
    *     - *logic*
-   *         - Type: string|
+   *         - 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.
    * The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
@@ -130,7 +130,7 @@ class RecommendItemsToItem extends rqs.Request {
    *         - Type: number
    *         - Description: **Expert option** If the *targetUserId* is provided: Taking *rotationRate* into account, specifies how long it takes for an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized.
    *     - *expertSettings*
-   *         - Type: 
+   *         - Type: object
    *         - Description: Dictionary of custom options.
    *     - *returnAbGroup*
    *         - Type: boolean

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

@@ -97,7 +97,7 @@ class RecommendItemsToUser extends rqs.Request {
    *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
    * Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
    *     - *logic*
-   *         - Type: string|
+   *         - 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.
    * The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
@@ -115,7 +115,7 @@ class RecommendItemsToUser extends rqs.Request {
    *         - Type: number
    *         - Description: **Expert option** Taking *rotationRate* into account, specifies how long it takes for an item to recover from the penalization. For example, `rotationTime=7200.0` means that items recommended less than 2 hours ago are penalized. Default: `7200.0`.
    *     - *expertSettings*
-   *         - Type: 
+   *         - Type: object
    *         - Description: Dictionary of custom options.
    *     - *returnAbGroup*
    *         - Type: boolean

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

@@ -87,7 +87,7 @@ class RecommendUsersToItem extends rqs.Request {
    *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
    * Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
    *     - *logic*
-   *         - Type: string|
+   *         - 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.
    * The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
@@ -96,7 +96,7 @@ class RecommendUsersToItem extends rqs.Request {
    *         - Type: number
    *         - Description: **Expert option** Real number from [0.0, 1.0], which determines how mutually dissimilar the recommended items should be. The default value is 0.0, i.e., no diversification. Value 1.0 means maximal diversification.
    *     - *expertSettings*
-   *         - Type: 
+   *         - Type: object
    *         - Description: Dictionary of custom options.
    *     - *returnAbGroup*
    *         - Type: boolean

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

@@ -87,7 +87,7 @@ class RecommendUsersToUser extends rqs.Request {
    *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
    * Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
    *     - *logic*
-   *         - Type: string|
+   *         - 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.
    * The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
@@ -105,7 +105,7 @@ class RecommendUsersToUser extends rqs.Request {
    *         - 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.
    *     - *expertSettings*
-   *         - Type: 
+   *         - Type: object
    *         - Description: Dictionary of custom options.
    *     - *returnAbGroup*
    *         - Type: boolean

package/lib/requests/request.js

@@ -4,7 +4,6 @@
  * Base class for all the requests
  */
 class Request {
-  
   /**
    * Construct the basis of request
    * @param {string} method - GET/PUT/POST/DELETE

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

@@ -39,13 +39,13 @@ class SearchItemSegments extends rqs.Request {
    *         - 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|
+   *         - 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.
    * 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: 
+   *         - Type: object
    *         - Description: Dictionary of custom options.
    *     - *returnAbGroup*
    *         - Type: boolean

package/lib/requests/search-items.js

@@ -99,13 +99,13 @@ class SearchItems extends rqs.Request {
    *         - Description: Number-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to boost the recommendation rate of some items based on the values of their attributes.
    * Boosters can also be assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
    *     - *logic*
-   *         - Type: string|
+   *         - 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.
    * 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: 
+   *         - Type: object
    *         - Description: Dictionary of custom options.
    *     - *returnAbGroup*
    *         - Type: boolean

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

@@ -5,7 +5,6 @@ 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).
  */
 class SetUserValues extends svr.SetValues {
-
   /**
    * Construct the request
    * @param {string} userId - ID of the user which will be modified.

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

@@ -22,7 +22,7 @@ class SetViewPortion extends rqs.Request {
    *         - Type: string
    *         - 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
+   *         - Type: string | number
    *         - Description: UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
    *     - *cascadeCreate*
    *         - Type: boolean
@@ -31,7 +31,7 @@ class SetViewPortion extends rqs.Request {
    *         - Type: string
    *         - Description: If this view portion is based on a recommendation request, `recommId` is the id of the clicked recommendation.
    *     - *additionalData*
-   *         - Type: 
+   *         - Type: object
    *         - Description: A dictionary of additional data for the interaction.
    */
   constructor(userId, itemId, portion, optional) {

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

@@ -20,10 +20,10 @@ class UpdateMoreItems extends rqs.Request {
   /**
    * Construct the request
    * @param {string} filter - A [ReQL](https://docs.recombee.com/reql.html) expression, which returns `true` for the items that shall be updated.
-   * @param {} changes - A dictionary where the keys are properties that shall be updated.
+   * @param {object} changes - A dictionary where the keys are properties that shall be updated.
    */
   constructor(filter, changes) {
-    super('POST', '/more-items/', 1000, false);
+    super('POST', '/more-items/', 100000, false);
     this.filter = filter;
     this.changes = changes;
   }

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "recombee-api-client",
-  "version": "4.1.0",
+  "version": "4.1.2",
   "description": "Node.js client (SDK) for easy use of the Recombee recommendation API",
   "main": "index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
     "test": "mocha test"
   },