recombee-api-client 3.0.0 → 4.0.0

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

@@ -49,7 +49,8 @@ class RecommendUsersToItem extends rqs.Request {
    *             "sex": "M"
    *           }
    *         }
-   *       ]
+   *       ],
+   *     "numberNextRecommsCalls": 0
    *   }
    * ```
    *     - *includedProperties*
@@ -73,7 +74,8 @@ class RecommendUsersToItem extends rqs.Request {
    *             "country": "CAN"
    *           }
    *         }
-   *       ]
+   *       ],
+   *     "numberNextRecommsCalls": 0
    *   }
    * ```
    *     - *filter*

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

@@ -49,8 +49,9 @@ class RecommendUsersToUser extends rqs.Request {
    *             "sex": "M"
    *           }
    *         }
-   *       ]
-   *     }
+   *       ],
+   *     "numberNextRecommsCalls": 0
+   *   }
    * ```
    *     - *includedProperties*
    *         - Type: string[]
@@ -73,7 +74,8 @@ class RecommendUsersToUser extends rqs.Request {
    *             "country": "CAN"
    *           }
    *         }
-   *       ]
+   *       ],
+   *     "numberNextRecommsCalls": 0
    *   }
    * ```
    *     - *filter*

package/lib/requests/search-items.js

@@ -9,8 +9,11 @@ const rqs = require("./request");
  * Full-text personalized search. The results are based on the provided `searchQuery` and also on the user's past interactions (purchases, ratings, etc.) with the items (items more suitable for the user are preferred in the results).
  * All the string and set item properties are indexed by the search engine.
  * This endpoint should be used in a search box at your website/app. It can be called multiple times as the user is typing the query in order to get the most viable suggestions based on current state of the query, or once after submitting the whole query. 
+ * The returned items are sorted by relevance (first item being the most relevant).
+ * Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
+ * - Let Recombee know that this search was successful (e.g. user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui.html#reported-metrics).
+ * - Get subsequent search results when the user scrolls down or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api.html#recommend-next-items).
  * 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 SearchItems extends rqs.Request {
 
@@ -56,7 +59,8 @@ class SearchItems extends rqs.Request {
    *             "url": "myshop.com/mixer-42"
    *           }
    *         }
-   *       ]
+   *       ],
+   *     "numberNextRecommsCalls": 0
    *   }
    * ```
    *     - *includedProperties*
@@ -82,7 +86,8 @@ class SearchItems extends rqs.Request {
    *             "price": 39
    *           }
    *         }
-   *       ]
+   *       ],
+   *     "numberNextRecommsCalls": 0
    *   }
    * ```
    *     - *filter*

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

@@ -0,0 +1,53 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Update (some) property values of all the items that pass the filter.
+ * Example: *Setting all the items that are older than a week as unavailable*
+ *   ```
+ *     {
+ *       "filter": "'releaseDate' < now() - 7*24*3600",
+ *       "changes": {"available": false}
+ *     }
+ *   ```
+ */
+class UpdateMoreItems extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} filter - A [ReQL](https://docs.recombee.com/reql.html) expression, which return `true` for the items that shall be updated.
+   * @param {} changes - A dictionary where the keys are properties which shall be updated.
+   */
+  constructor(filter, changes) {
+    super('POST', '/more-items/', 1000, false);
+    this.filter = filter;
+    this.changes = changes;
+  }
+
+  /**
+   * Get body parameters
+   * @return {Object} The values of body parameters (name of parameter: value of the parameter)
+   */
+  bodyParameters() {
+    let params = {};
+    params.filter = this.filter;
+    params.changes = this.changes;
+
+    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.UpdateMoreItems = UpdateMoreItems

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "recombee-api-client",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Node.js client (SDK) for easy use of the Recombee recommendation API",
   "main": "index.js",
   "scripts": {
@@ -26,8 +26,7 @@
   },
   "homepage": "https://github.com/Recombee/node-api-client#readme",
   "dependencies": {
-    "request-promise": "^4.2.5",
-    "request": "^2.88.0",
+    "got": "^11.8.2",
     "jssha": "^2.3.0"
   },
   "devDependencies": {

package/test/add-bookmark-batch_test.js

@@ -29,19 +29,19 @@ describe('AddBookmark', function(){
       new rqs.AddBookmark('entity_id','entity_id',{'timestamp': -15}),
       new rqs.AddBookmark('u_id2','i_id2',{'cascadeCreate': true,'timestamp': 5}),
       new rqs.AddBookmark('u_id2','i_id2',{'cascadeCreate': true,'timestamp': 5})
-    ];
-
+      ];
+    
     env.client.send(new rqs.Batch(requests))
     .then((responses) => {
-      chai.equal(responses[0].code, 200);
-      chai.equal(responses[1].code, 200);
-      chai.equal(responses[2].code, 200);
-      chai.equal(responses[3].code, 404);
-      chai.equal(responses[4].code, 404);
-      chai.equal(responses[5].code, 400);
-      chai.equal(responses[6].code, 200);
-      chai.equal(responses[7].code, 409);
+        chai.equal(responses[0].code, 200);
+        chai.equal(responses[1].code, 200);
+        chai.equal(responses[2].code, 200);
+        chai.equal(responses[3].code, 404);
+        chai.equal(responses[4].code, 404);
+        chai.equal(responses[5].code, 400);
+        chai.equal(responses[6].code, 200);
+        chai.equal(responses[7].code, 409);
       done();
     });
   });
-});
+});

package/test/add-bookmark-test.js

@@ -55,9 +55,12 @@ describe('AddBookmark', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -69,9 +72,12 @@ describe('AddBookmark', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -83,9 +89,12 @@ describe('AddBookmark', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -99,9 +108,12 @@ describe('AddBookmark', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-cart-addition-batch_test.js

@@ -29,19 +29,19 @@ describe('AddCartAddition', function(){
       new rqs.AddCartAddition('entity_id','entity_id',{'timestamp': -15}),
       new rqs.AddCartAddition('u_id2','i_id2',{'cascadeCreate': true,'timestamp': 5}),
       new rqs.AddCartAddition('u_id2','i_id2',{'cascadeCreate': true,'timestamp': 5})
-    ];
-
+      ];
+    
     env.client.send(new rqs.Batch(requests))
     .then((responses) => {
-      chai.equal(responses[0].code, 200);
-      chai.equal(responses[1].code, 200);
-      chai.equal(responses[2].code, 200);
-      chai.equal(responses[3].code, 404);
-      chai.equal(responses[4].code, 404);
-      chai.equal(responses[5].code, 400);
-      chai.equal(responses[6].code, 200);
-      chai.equal(responses[7].code, 409);
+        chai.equal(responses[0].code, 200);
+        chai.equal(responses[1].code, 200);
+        chai.equal(responses[2].code, 200);
+        chai.equal(responses[3].code, 404);
+        chai.equal(responses[4].code, 404);
+        chai.equal(responses[5].code, 400);
+        chai.equal(responses[6].code, 200);
+        chai.equal(responses[7].code, 409);
       done();
     });
   });
-});
+});

package/test/add-cart-addition-test.js

@@ -55,9 +55,12 @@ describe('AddCartAddition', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -69,9 +72,12 @@ describe('AddCartAddition', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -83,9 +89,12 @@ describe('AddCartAddition', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -99,9 +108,12 @@ describe('AddCartAddition', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-detail-view-batch_test.js

@@ -29,19 +29,19 @@ describe('AddDetailView', function(){
       new rqs.AddDetailView('entity_id','entity_id',{'timestamp': -15}),
       new rqs.AddDetailView('u_id2','i_id2',{'cascadeCreate': true,'timestamp': 5}),
       new rqs.AddDetailView('u_id2','i_id2',{'cascadeCreate': true,'timestamp': 5})
-    ];
-
+      ];
+    
     env.client.send(new rqs.Batch(requests))
     .then((responses) => {
-      chai.equal(responses[0].code, 200);
-      chai.equal(responses[1].code, 200);
-      chai.equal(responses[2].code, 200);
-      chai.equal(responses[3].code, 404);
-      chai.equal(responses[4].code, 404);
-      chai.equal(responses[5].code, 400);
-      chai.equal(responses[6].code, 200);
-      chai.equal(responses[7].code, 409);
+        chai.equal(responses[0].code, 200);
+        chai.equal(responses[1].code, 200);
+        chai.equal(responses[2].code, 200);
+        chai.equal(responses[3].code, 404);
+        chai.equal(responses[4].code, 404);
+        chai.equal(responses[5].code, 400);
+        chai.equal(responses[6].code, 200);
+        chai.equal(responses[7].code, 409);
       done();
     });
   });
-});
+});

package/test/add-detail-view-test.js

@@ -55,9 +55,12 @@ describe('AddDetailView', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -69,9 +72,12 @@ describe('AddDetailView', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 404);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 404);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -83,9 +89,12 @@ describe('AddDetailView', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -99,9 +108,12 @@ describe('AddDetailView', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-group-batch_test.js

@@ -22,18 +22,18 @@ describe('AddGroup', function(){
   it ('works in batch', (done) => {
     let requests = [
       new rqs.AddGroup('valid_id'),
-      new rqs.AddGroup('$$$not_valid$$$'),
+      new rqs.AddGroup('***not_valid$$$'),
       new rqs.AddGroup('valid_id2'),
       new rqs.AddGroup('valid_id2')
-    ];
-
+      ];
+    
     env.client.send(new rqs.Batch(requests))
     .then((responses) => {
-      chai.equal(responses[0].code, 201);
-      chai.equal(responses[1].code, 400);
-      chai.equal(responses[2].code, 201);
-      chai.equal(responses[3].code, 409);
+        chai.equal(responses[0].code, 201);
+        chai.equal(responses[1].code, 400);
+        chai.equal(responses[2].code, 201);
+        chai.equal(responses[3].code, 409);
       done();
     });
   });
-});
+});

package/test/add-group-callback_test.js

@@ -35,7 +35,7 @@ describe('AddGroup', function(){
   
   it ('fails with invalid entity id', (done) => {
     let req, req2, resp;
-    req = new rqs.AddGroup('$$$not_valid$$$');
+    req = new rqs.AddGroup('***not_valid$$$');
     env.client.send(req,((err,res) => {
       if(err) {
         chai.equal(err.name, 'ResponseError');

package/test/add-group-test.js

@@ -31,15 +31,18 @@ describe('AddGroup', function(){
   
   it ('fails with invalid entity id', (done) => {
     let req, req2, resp;
-    req = new rqs.AddGroup('$$$not_valid$$$');
+    req = new rqs.AddGroup('***not_valid$$$');
     env.client.send(req)
     .then((res) => {
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -53,9 +56,12 @@ describe('AddGroup', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-item-batch_test.js

@@ -22,18 +22,18 @@ describe('AddItem', function(){
   it ('works in batch', (done) => {
     let requests = [
       new rqs.AddItem('valid_id'),
-      new rqs.AddItem('$$$not_valid$$$'),
+      new rqs.AddItem('***not_valid$$$'),
       new rqs.AddItem('valid_id2'),
       new rqs.AddItem('valid_id2')
-    ];
-
+      ];
+    
     env.client.send(new rqs.Batch(requests))
     .then((responses) => {
-      chai.equal(responses[0].code, 201);
-      chai.equal(responses[1].code, 400);
-      chai.equal(responses[2].code, 201);
-      chai.equal(responses[3].code, 409);
+        chai.equal(responses[0].code, 201);
+        chai.equal(responses[1].code, 400);
+        chai.equal(responses[2].code, 201);
+        chai.equal(responses[3].code, 409);
       done();
     });
   });
-});
+});

package/test/add-item-callback_test.js

@@ -35,7 +35,7 @@ describe('AddItem', function(){
   
   it ('fails with invalid entity id', (done) => {
     let req, req2, resp;
-    req = new rqs.AddItem('$$$not_valid$$$');
+    req = new rqs.AddItem('***not_valid$$$');
     env.client.send(req,((err,res) => {
       if(err) {
         chai.equal(err.name, 'ResponseError');

package/test/add-item-property-batch_test.js

@@ -26,16 +26,16 @@ describe('AddItemProperty', function(){
       new rqs.AddItemProperty('prop','integer'),
       new rqs.AddItemProperty('number2','int'),
       new rqs.AddItemProperty('number2','int')
-    ];
-
+      ];
+    
     env.client.send(new rqs.Batch(requests))
     .then((responses) => {
-      chai.equal(responses[0].code, 201);
-      chai.equal(responses[1].code, 201);
-      chai.equal(responses[2].code, 400);
-      chai.equal(responses[3].code, 201);
-      chai.equal(responses[4].code, 409);
+        chai.equal(responses[0].code, 201);
+        chai.equal(responses[1].code, 201);
+        chai.equal(responses[2].code, 400);
+        chai.equal(responses[3].code, 201);
+        chai.equal(responses[4].code, 409);
       done();
     });
   });
-});
+});

package/test/add-item-property-test.js

@@ -41,9 +41,12 @@ describe('AddItemProperty', function(){
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -57,9 +60,12 @@ describe('AddItemProperty', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });

package/test/add-item-test.js

@@ -31,15 +31,18 @@ describe('AddItem', function(){
   
   it ('fails with invalid entity id', (done) => {
     let req, req2, resp;
-    req = new rqs.AddItem('$$$not_valid$$$');
+    req = new rqs.AddItem('***not_valid$$$');
     env.client.send(req)
     .then((res) => {
       chai.fail();
       done();
     })
-    .catch(recombee.errors.ResponseError,(err) => {
-      chai.equal(err.statusCode, 400);
-      done();
+    .catch((err) => {
+      if (err instanceof recombee.errors.ResponseError) {
+        chai.equal(err.statusCode, 400);
+        done();
+      }
+      throw err;
     });
   });
   
@@ -53,9 +56,12 @@ describe('AddItem', function(){
         chai.fail();
         done();
       })
-      .catch(recombee.errors.ResponseError,(err) => {
-        chai.equal(err.statusCode, 409);
-        done();
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
       });
     });
   });