recombee-api-client 4.0.0 → 4.1.0

package/doc/styles/prettify-jsdoc.css

@@ -0,0 +1,111 @@
+/* JSDoc prettify.js theme */
+
+/* plain text */
+.pln {
+  color: #000000;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* string content */
+.str {
+  color: #006400;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* a keyword */
+.kwd {
+  color: #000000;
+  font-weight: bold;
+  font-style: normal;
+}
+
+/* a comment */
+.com {
+  font-weight: normal;
+  font-style: italic;
+}
+
+/* a type name */
+.typ {
+  color: #000000;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* a literal value */
+.lit {
+  color: #006400;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* punctuation */
+.pun {
+  color: #000000;
+  font-weight: bold;
+  font-style: normal;
+}
+
+/* lisp open bracket */
+.opn {
+  color: #000000;
+  font-weight: bold;
+  font-style: normal;
+}
+
+/* lisp close bracket */
+.clo {
+  color: #000000;
+  font-weight: bold;
+  font-style: normal;
+}
+
+/* a markup tag name */
+.tag {
+  color: #006400;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* a markup attribute name */
+.atn {
+  color: #006400;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* a markup attribute value */
+.atv {
+  color: #006400;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* a declaration */
+.dec {
+  color: #000000;
+  font-weight: bold;
+  font-style: normal;
+}
+
+/* a variable name */
+.var {
+  color: #000000;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* a function name */
+.fun {
+  color: #000000;
+  font-weight: bold;
+  font-style: normal;
+}
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+  margin-top: 0;
+  margin-bottom: 0;
+}

package/doc/styles/prettify-tomorrow.css

@@ -0,0 +1,132 @@
+/* Tomorrow Theme */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* Pretty printing styles. Used with prettify.js. */
+/* SPAN elements with the classes below are added by prettyprint. */
+/* plain text */
+.pln {
+  color: #4d4d4c; }
+
+@media screen {
+  /* string content */
+  .str {
+    color: #718c00; }
+
+  /* a keyword */
+  .kwd {
+    color: #8959a8; }
+
+  /* a comment */
+  .com {
+    color: #8e908c; }
+
+  /* a type name */
+  .typ {
+    color: #4271ae; }
+
+  /* a literal value */
+  .lit {
+    color: #f5871f; }
+
+  /* punctuation */
+  .pun {
+    color: #4d4d4c; }
+
+  /* lisp open bracket */
+  .opn {
+    color: #4d4d4c; }
+
+  /* lisp close bracket */
+  .clo {
+    color: #4d4d4c; }
+
+  /* a markup tag name */
+  .tag {
+    color: #c82829; }
+
+  /* a markup attribute name */
+  .atn {
+    color: #f5871f; }
+
+  /* a markup attribute value */
+  .atv {
+    color: #3e999f; }
+
+  /* a declaration */
+  .dec {
+    color: #f5871f; }
+
+  /* a variable name */
+  .var {
+    color: #c82829; }
+
+  /* a function name */
+  .fun {
+    color: #4271ae; } }
+/* Use higher contrast and text-weight for printable form. */
+@media print, projection {
+  .str {
+    color: #060; }
+
+  .kwd {
+    color: #006;
+    font-weight: bold; }
+
+  .com {
+    color: #600;
+    font-style: italic; }
+
+  .typ {
+    color: #404;
+    font-weight: bold; }
+
+  .lit {
+    color: #044; }
+
+  .pun, .opn, .clo {
+    color: #440; }
+
+  .tag {
+    color: #006;
+    font-weight: bold; }
+
+  .atn {
+    color: #404; }
+
+  .atv {
+    color: #060; } }
+/* Style */
+/*
+pre.prettyprint {
+  background: white;
+  font-family: Consolas, Monaco, 'Andale Mono', monospace;
+  font-size: 12px;
+  line-height: 1.5;
+  border: 1px solid #ccc;
+  padding: 10px; }
+*/
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+  margin-top: 0;
+  margin-bottom: 0; }
+
+/* IE indents via margin-left */
+li.L0,
+li.L1,
+li.L2,
+li.L3,
+li.L4,
+li.L5,
+li.L6,
+li.L7,
+li.L8,
+li.L9 {
+  /* */ }
+
+/* Alternate shading for lines */
+li.L1,
+li.L3,
+li.L5,
+li.L7,
+li.L9 {
+  /* */ }

package/lib/api-client.js

@@ -45,8 +45,9 @@ class ApiClient {
         url: url,
         headers: {'Accept': 'application/json',
                   'Content-Type': 'application/json',
-                  'User-Agent': 'recombee-node-api-client/4.0.0'},
-        timeout: request.timeout
+                  'User-Agent': 'recombee-node-api-client/4.1.0'},
+        timeout: request.timeout,
+        agent: this.options.agent
     };
 
     if (Object.entries(request.bodyParameters()).length > 0)

package/lib/requests/add-bookmark.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Adds a bookmark of a given item made by a given user.
+ * Adds a bookmark of the given item made by the given user.
  */
 class AddBookmark extends rqs.Request {
 

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

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Adds a cart addition of a given item made by a given user.
+ * Adds a cart addition of the given item made by the given user.
  */
 class AddCartAddition extends rqs.Request {
 
@@ -24,10 +24,10 @@ class AddCartAddition extends rqs.Request {
    *         - Description: Sets whether the given user/item should be created if not present in the database.
    *     - *amount*
    *         - Type: number
-   *         - Description: Amount (number) added to cart. The default is 1. For example if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal to 2.
+   *         - Description: Amount (number) added to cart. The default is 1. For example, if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal 2.
    *     - *price*
    *         - Type: number
-   *         - Description: Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.
+   *         - Description: Price of the added item. If `amount` is greater than 1, the sum of prices of all the items should be given.
    *     - *recommId*
    *         - Type: string
    *         - Description: If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.

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

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Adds a detail view of a given item made by a given user.
+ * Adds a detail view of the given item made by the given user.
  */
 class AddDetailView extends rqs.Request {
 

package/lib/requests/add-group.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Creates new group in the database.
+ * Creates a new group in the database.
  */
 class AddGroup extends rqs.Request {
 

package/lib/requests/add-item-property.js

@@ -12,7 +12,7 @@ class AddItemProperty extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} propertyName - Name of the item property to be created. Currently, the following names are reserved:`id`, `itemid`, case insensitively. Also, the length of the property name must not exceed 63 characters.
+   * @param {string} propertyName - Name of the item property to be created. Currently, the following names are reserved: `id`, `itemid`, case-insensitively. Also, the length of the property name must not exceed 63 characters.
    * @param {string} type - Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.
    * * `int`- Signed integer number.
    * * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).

package/lib/requests/add-item.js

@@ -6,8 +6,8 @@
 const rqs = require("./request");
 
 /**
- * Adds new item of given `itemId` to the items catalog.
- * All the item properties for the newly created items are set null.
+ * Adds new item of the given `itemId` to the items catalog.
+ * All the item properties for the newly created items are set to null.
  */
 class AddItem extends rqs.Request {
 

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

@@ -0,0 +1,58 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Adds a new Segment into a Manual ReQL Segmentation.
+ * The new Segment is defined by a [ReQL](https://docs.recombee.com/reql.html) filter that returns `true` for an item in case that this item belongs to the segment.
+ */
+class AddManualReqlSegment extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} segmentationId - ID of the Segmentation to which the new Segment should be added
+   * @param {string} segmentId - ID of the newly created Segment
+   * @param {string} filter - ReQL filter that returns `true` for items that belong to this Segment. Otherwise returns `false`.
+   * @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 of the Segment that is shown in the Recombee Admin UI.
+   */
+  constructor(segmentationId, segmentId, filter, optional) {
+    super('PUT', `/segmentations/manual-reql/${segmentationId}/segments/${segmentId}`, 10000, false);
+    this.segmentationId = segmentationId;
+    this.segmentId = segmentId;
+    this.filter = filter;
+    optional = optional || {};
+    this.title = optional.title;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+    params.filter = this.filter;
+
+    if(this.title !== undefined)
+      params.title = this.title;
+
+    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.AddManualReqlSegment = AddManualReqlSegment

package/lib/requests/add-purchase.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Adds a purchase of a given item made by a given user.
+ * Adds a purchase of the given item made by the given user.
  */
 class AddPurchase extends rqs.Request {
 
@@ -24,13 +24,13 @@ class AddPurchase extends rqs.Request {
    *         - Description: Sets whether the given user/item should be created if not present in the database.
    *     - *amount*
    *         - Type: number
-   *         - Description: Amount (number) of purchased items. The default is 1. For example if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal to 2.
+   *         - Description: Amount (number) of purchased items. The default is 1. For example, if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal 2.
    *     - *price*
    *         - Type: number
-   *         - Description: Price paid by the user for the item. If `amount` is greater than 1, sum of prices of all the items should be given.
+   *         - Description: Price paid by the user for the item. If `amount` is greater than 1, the sum of prices of all the items should be given.
    *     - *profit*
    *         - Type: number
-   *         - Description: Your profit from the purchased item. The profit is natural in e-commerce domain (for example if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30), but is applicable also in other domains (for example at a news company it may be income from displayed advertisement on article page). If `amount` is greater than 1, sum of profit of all the items should be given.
+   *         - Description: Your profit from the purchased item. The profit is natural in the e-commerce domain (for example, if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30) but is also applicable in other domains (for example, at a news company it may be income from a displayed advertisement on article page). If `amount` is greater than 1, the sum of profit of all the items should be given.
    *     - *recommId*
    *         - Type: string
    *         - Description: If this purchase is based on a recommendation request, `recommId` is the id of the clicked recommendation.

package/lib/requests/add-rating.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Adds a rating of given item made by a given user.
+ * Adds a rating of the given item made by the given user.
  */
 class AddRating extends rqs.Request {
 

package/lib/requests/add-series.js

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Creates new series in the database.
+ * Creates a new series in the database.
  */
 class AddSeries extends rqs.Request {
 

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

@@ -6,13 +6,13 @@
 const rqs = require("./request");
 
 /**
- * Adding an user property is somehow equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
+ * Adding a user property is somehow equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
  */
 class AddUserProperty extends rqs.Request {
 
   /**
    * Construct the request
-   * @param {string} propertyName - Name of the user property to be created. Currently, the following names are reserved:`id`, `userid`, case insensitively. Also, the length of the property name must not exceed 63 characters.
+   * @param {string} propertyName - Name of the user property to be created. Currently, the following names are reserved: `id`, `userid`, case-insensitively. Also, the length of the property name must not exceed 63 characters.
    * @param {string} type - Value type of the user property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`.
    * * `int` - Signed integer number.
    * * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).

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

@@ -0,0 +1,66 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Segment the items using a [ReQL](https://docs.recombee.com/reql.html) expression.
+ * For each item, the expression should return a set that contains IDs of segments to which the item belongs to.
+ */
+class CreateAutoReqlSegmentation 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} expression - ReQL expression that returns for each item a set with IDs of segments to which the item belongs
+   * @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, expression, optional) {
+    super('PUT', `/segmentations/auto-reql/${segmentationId}`, 10000, false);
+    this.segmentationId = segmentationId;
+    this.sourceType = sourceType;
+    this.expression = expression;
+    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.expression = this.expression;
+
+    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.CreateAutoReqlSegmentation = CreateAutoReqlSegmentation

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);