MergeUsers (allowed for a db on request)

Author: OndraFiedler

README.md

@@ -15,7 +15,7 @@ The library is [UMD](https://github.com/umdjs/umd) compatible.
 You can download [recombee-api-client.min.js](./dist/recombee-api-client.min.js) and host it at your site, or use a CDN such as [jsDelivr](https://www.jsdelivr.com/) CDN:
 
 ```js
-<script src="https://cdn.jsdelivr.net/gh/recombee/[email protected].0/dist/recombee-api-client.min.js"></script>
+<script src="https://cdn.jsdelivr.net/gh/recombee/[email protected].1/dist/recombee-api-client.min.js"></script>
 ```
 
 ### npm
@@ -147,7 +147,7 @@ Let's assume we want to show recommendations at product page of pants `product-2
         </div>
     </div>
 
-    <script src="https://cdn.jsdelivr.net/gh/recombee/[email protected].0/dist/recombee-api-client.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/gh/recombee/[email protected].1/dist/recombee-api-client.min.js"></script>
 
     <script type="text/javascript">
 

dist/recombee-api-client.js

@@ -1,6 +1,6 @@
 {
   "name": "recombee-js-api-client",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "Client-side js library for easy use of the Recombee recommendation API",
   "browser": "./src/index.js",
   "repository": {

dist/recombee-api-client.js.map

@@ -7,6 +7,7 @@ exports.ApiClient = require("./api-client").ApiClient;
 exports.ApiError = require("./errors/api-error").ApiError;
 exports.ResponseError = require("./errors/response-error").ResponseError;
 exports.TimeoutError = require("./errors/timeout-error").TimeoutError;
+exports.MergeUsers = require("./requests/merge-users").MergeUsers;
 exports.AddDetailView = require("./requests/add-detail-view").AddDetailView;
 exports.AddPurchase = require("./requests/add-purchase").AddPurchase;
 exports.AddRating = require("./requests/add-rating").AddRating;

dist/recombee-api-client.min.js

@@ -0,0 +1,45 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable.
+ * Merging happens between two users referred to as the *target* and the *source*. After the merge, all the interactions of the source user are attributed to the target user, and the source user is **deleted**.
+ */
+class MergeUsers extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} targetUserId - ID of the targer user.
+   * @param {string} sourceUserId - ID of the source user.
+   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
+   * - Allowed parameters:
+   *     - *cascadeCreate*
+   *         - Type: boolean
+   *         - Description: Sets whether the user *targetUserId* should be created if not present in the database.
+   */
+  constructor(targetUserId, sourceUserId, optional) {
+    super('PUT', `/users/${encodeURIComponent(targetUserId)}/merge/${encodeURIComponent(sourceUserId)}`, 30000, false);
+    this.targetUserId = targetUserId;
+    this.sourceUserId = sourceUserId;
+    optional = optional || {};
+    this.cascadeCreate = optional.cascadeCreate;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+
+    params.cascadeCreate = (this.cascadeCreate !== undefined) ? this.cascadeCreate : true;
+    return params;
+  }
+
+}
+
+exports.MergeUsers = MergeUsers

dist/recombee-api-client.min.js.map

@@ -8,6 +8,7 @@ const rqs = require("./request");
 /**
  * Recommends set of items that are somehow related to one given item, *X*. Typical scenario  is when user *A* is viewing *X*. Then you may display items to the user that he might be also interested in. Recommend items to item request gives you Top-N such items, optionally taking the target user *A* into account.
  * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
+ * The returned items are sorted by relevancy (first item being the most relevant).
  */
 class RecommendItemsToItem extends rqs.Request {
 

package.json

@@ -8,6 +8,7 @@ const rqs = require("./request");
 /**
  * Based on user's past interactions (purchases, ratings, etc.) with the items, recommends top-N items that are most likely to be of high value for a given user.
  * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
+ * The returned items are sorted by relevancy (first item being the most relevant).
  */
 class RecommendItemsToUser extends rqs.Request {