recombee-api-client 3.2.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

@@ -1,8 +1,7 @@
 'use strict';
 
 const jsSHA = require("jssha");
-const rp = require('request-promise');
-const rp_errors = require('request-promise/errors');
+const got = require('got');
 
 const api_errors = require('./errors');
 const requests = require('./requests');
@@ -17,15 +16,17 @@ class ApiClient {
    * Construct the client
    * @param {string} databaseId - ID of your database
    * @param {string} secretToken - Corresponding secret token
-   * @param {boolean} alwaysUseHttps - If true, all requests are sent using HTTPS (default: true)
    * @param {Object} options - Other custom options
    */
-  constructor (databaseId, token, alwaysUseHttps, options) {
+  constructor (databaseId, token, options) {
       this.databaseId = databaseId;
       this.token = token;
-      this.alwaysUseHttps = (alwaysUseHttps === undefined) ? true : alwaysUseHttps;
       this.options = options || {};
-      this.baseUri = process.env.RAPI_URI || this.options.baseUri || 'rapi.recombee.com';
+
+      if (Object.getPrototypeOf(this.options) !== Object.prototype) throw new Error(`options must be given as an Object (${this.options} given instead)`);
+
+      this.protocol = this.options.protocol || 'https';
+      this.baseUri = this._getBaseUri()
   }
 
   /**
@@ -41,50 +42,70 @@ class ApiClient {
     let url = this._buildRequestUrl(request);
     let options = {
         method: request.method,
-        uri: url,
+        url: url,
         headers: {'Accept': 'application/json',
                   'Content-Type': 'application/json',
-                  'User-Agent': 'recombee-node-api-client/3.2.0'},
+                  'User-Agent': 'recombee-node-api-client/4.1.0'},
         timeout: request.timeout,
-        resolveWithFullResponse: true,
-        json: true
+        agent: this.options.agent
     };
 
-    if (this.options.proxy)
-      options.proxy = this.options.proxy;
-
-    if (request.bodyParameters()) 
-      options.body = request.bodyParameters();
+    if (Object.entries(request.bodyParameters()).length > 0)
+      options.json = request.bodyParameters();
 
-    return rp(options)
-           .then(this._parseResponse)
+    return got(options)
+           .json()
            .then((response)=> {
               return new Promise( (resolve) => {
                 if (callback) { return callback(null, response); }
                 return resolve(response);
               });
             })
-            .catch(rp_errors.StatusCodeError,((error) => {
-                throw new api_errors.ResponseError(request, error.statusCode, error.message);
+            .catch((error) => {
+              if (error instanceof got.HTTPError) {
+                error = new api_errors.ResponseError(request, error.response.statusCode, error.response.body);
               }
-            ))
-            .catch(rp_errors.RequestError,((error) => {
-                if(error.cause.code === 'ETIMEDOUT' || error.cause.code === 'ESOCKETTIMEDOUT')
-                  throw new api_errors.TimeoutError(request, error);
-                throw error;
+              else if (error instanceof got.RequestError) {
+                if(error.code === 'ETIMEDOUT' || error.code === 'ESOCKETTIMEDOUT') {
+                  error = new api_errors.TimeoutError(request, error);
+                }
               }
-            ))
-            .catch((error) => {
               if (callback) {return callback(error)};
               throw error;
             });
   }
 
+  _getRegionalBaseUri(region) {
+    const uri = {
+      'ap-se': 'rapi-ap-se.recombee.com',
+      'ca-east': 'rapi-ca-east.recombee.com',
+      'eu-west': 'rapi-eu-west.recombee.com',
+      'us-west': 'rapi-us-west.recombee.com'
+    }[region.toLowerCase()];
+
+    if (uri === undefined) {
+      throw new Error(`Region "${region}" is unknown. You may need to update the version of the SDK.`)
+    }
+
+    return uri;
+  }
+
+  _getBaseUri() {
+    let baseUri = process.env.RAPI_URI || this.options.baseUri;
+    if (this.options.region) {
+      if (baseUri) {
+        throw new Error('baseUri and region cannot be specified at the same time');
+      }
+      baseUri = this._getRegionalBaseUri(this.options.region);
+    }
+    return baseUri || 'rapi.recombee.com';
+  }
+
   _buildRequestUrl(request) {
-    let protocol = (request.ensureHttps || this.alwaysUseHttps) ? 'https' : 'http';
+    let usedProtocol = (request.ensureHttps) ? 'https' : this.protocol;
     let reqUrl = request.path + this._encodeRequestQueryParams(request);
     let signedUrl = this._signUrl(reqUrl);
-    return protocol + '://' + this.baseUri + signedUrl;
+    return usedProtocol + '://' + this.baseUri + signedUrl;
   }
 
   _encodeRequestQueryParams(request) {
@@ -161,14 +182,6 @@ class ApiClient {
       });
   }
 
-  _parseResponse(response) {
-    return new Promise(
-      function (resolve, reject) {
-        resolve(response.body);
-      }
-    );
-  }
-
   _signUrl (req_part) {
     let url = '/' + this.databaseId + req_part;
     url += (req_part.indexOf("?") == -1 ? "?" : "&" ) + "hmac_timestamp=" + parseInt(new Date().getTime() / 1000);

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