recombee-api-client 4.0.0 → 4.1.1

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

@@ -6,7 +6,7 @@
 const rqs = require("./request");
 
 /**
- * Update (some) property values of all the items that pass the filter.
+ * Updates (some) property values of all the items that pass the filter.
  * Example: *Setting all the items that are older than a week as unavailable*
  *   ```
  *     {
@@ -19,11 +19,11 @@ 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.
+   * @param {string} filter - A [ReQL](https://docs.recombee.com/reql.html) expression, which returns `true` for the items 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/lib/requests/update-property-based-segmentation.js

@@ -0,0 +1,66 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict';
+const rqs = require("./request");
+
+/**
+ * Updates a Property Based Segmentation
+ */
+class UpdatePropertyBasedSegmentation extends rqs.Request {
+
+  /**
+   * Construct the request
+   * @param {string} segmentationId - ID of the updated Segmentation
+   * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
+   * - Allowed parameters:
+   *     - *propertyName*
+   *         - Type: string
+   *         - Description: Name of the property on which the Segmentation should be based
+   *     - *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, optional) {
+    super('POST', `/segmentations/property-based/${segmentationId}`, 10000, false);
+    this.segmentationId = segmentationId;
+    optional = optional || {};
+    this.propertyName = optional.propertyName;
+    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 = {};
+
+    if(this.propertyName !== undefined)
+      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.UpdatePropertyBasedSegmentation = UpdatePropertyBasedSegmentation

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "recombee-api-client",
-  "version": "4.0.0",
+  "version": "4.1.1",
   "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"
   },

package/test/add-manual-reql-segment-batch_test.js

@@ -0,0 +1,40 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('AddManualReqlSegment', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  it ('works in batch', (done) => {
+    env.client.send(new rqs.CreateManualReqlSegmentation('seg1','items',{'title': 'Test Segmentation','description': 'For test purposes'}),((err,res) => {
+      if(err) {
+        chai.fail();
+      }
+      else {
+        let requests = [
+          new rqs.AddManualReqlSegment('seg1','first-segment','\'str_property\' != null',{'title': 'First Segment'})
+          ];
+        
+        env.client.send(new rqs.Batch(requests))
+        .then((responses) => {
+            chai.equal(responses[0].code, 201);
+          done();
+        });
+      }
+    }));
+  });
+});

package/test/add-manual-reql-segment-callback_test.js

@@ -0,0 +1,43 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('AddManualReqlSegment', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  
+  it ('adds manual ReQL segment', (done) => {
+    let req, req2, resp;
+    req2 = new rqs.CreateManualReqlSegmentation('seg1','items',{'title': 'Test Segmentation','description': 'For test purposes'});
+    env.client.send(req2,((err,res) => {
+      if(err) {
+        chai.fail();
+      }
+      else {
+        req = new rqs.AddManualReqlSegment('seg1','first-segment','\'str_property\' != null',{'title': 'First Segment'});
+        env.client.send(req,((err,res) => {
+          if(err) {
+            chai.fail();
+          }
+          else {
+            done();
+          }
+        }));
+      }
+    }));
+  });
+});

package/test/add-manual-reql-segment-test.js

@@ -0,0 +1,35 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('AddManualReqlSegment', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  
+  it ('adds manual ReQL segment', (done) => {
+    let req, req2, resp;
+    req2 = new rqs.CreateManualReqlSegmentation('seg1','items',{'title': 'Test Segmentation','description': 'For test purposes'});
+    env.client.send(req2)
+    .then((res) => {
+      req = new rqs.AddManualReqlSegment('seg1','first-segment','\'str_property\' != null',{'title': 'First Segment'});
+      env.client.send(req)
+      .then((res) => {
+        done();
+      });
+    });
+  });
+});

package/test/create-auto-reql-segmentation-batch_test.js

@@ -0,0 +1,35 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('CreateAutoReqlSegmentation', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  it ('works in batch', (done) => {
+    let requests = [
+      new rqs.CreateAutoReqlSegmentation('seg1','items','{\'str_property\'}',{'title': 'Test Segmentation','description': 'For test purposes'}),
+      new rqs.CreateAutoReqlSegmentation('seg1','items','{\'str_property\'}',{'title': 'Test Segmentation','description': 'For test purposes'})
+      ];
+    
+    env.client.send(new rqs.Batch(requests))
+    .then((responses) => {
+        chai.equal(responses[0].code, 201);
+        chai.equal(responses[1].code, 409);
+      done();
+    });
+  });
+});

package/test/create-auto-reql-segmentation-callback_test.js

@@ -0,0 +1,45 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('CreateAutoReqlSegmentation', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  
+  it ('creates auto ReQL segmentation', (done) => {
+    let req, req2, resp;
+    req = new rqs.CreateAutoReqlSegmentation('seg1','items','{\'str_property\'}',{'title': 'Test Segmentation','description': 'For test purposes'});
+    env.client.send(req,((err,res) => {
+      if(err) {
+        chai.fail();
+      }
+      else {
+        req = new rqs.CreateAutoReqlSegmentation('seg1','items','{\'str_property\'}',{'title': 'Test Segmentation','description': 'For test purposes'});
+        env.client.send(req,((err,res) => {
+          if(err) {
+            chai.equal(err.name, 'ResponseError');
+            chai.equal(err.statusCode, 409);
+            done();
+          }
+          else {
+            chai.fail();
+          }
+        }));
+      }
+    }));
+  });
+});

package/test/create-auto-reql-segmentation-test.js

@@ -0,0 +1,43 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('CreateAutoReqlSegmentation', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  
+  it ('creates auto ReQL segmentation', (done) => {
+    let req, req2, resp;
+    req = new rqs.CreateAutoReqlSegmentation('seg1','items','{\'str_property\'}',{'title': 'Test Segmentation','description': 'For test purposes'});
+    env.client.send(req)
+    .then((res) => {
+      req = new rqs.CreateAutoReqlSegmentation('seg1','items','{\'str_property\'}',{'title': 'Test Segmentation','description': 'For test purposes'});
+      env.client.send(req)
+      .then((res) => {
+        chai.fail();
+        done();
+      })
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
+      });
+    });
+  });
+});

package/test/create-manual-reql-segmentation-batch_test.js

@@ -0,0 +1,35 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('CreateManualReqlSegmentation', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  it ('works in batch', (done) => {
+    let requests = [
+      new rqs.CreateManualReqlSegmentation('seg1','items',{'title': 'Test Segmentation','description': 'For test purposes'}),
+      new rqs.CreateManualReqlSegmentation('seg1','items',{'title': 'Test Segmentation','description': 'For test purposes'})
+      ];
+    
+    env.client.send(new rqs.Batch(requests))
+    .then((responses) => {
+        chai.equal(responses[0].code, 201);
+        chai.equal(responses[1].code, 409);
+      done();
+    });
+  });
+});

package/test/create-manual-reql-segmentation-callback_test.js

@@ -0,0 +1,45 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('CreateManualReqlSegmentation', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  
+  it ('creates manual ReQL segmentation', (done) => {
+    let req, req2, resp;
+    req = new rqs.CreateManualReqlSegmentation('seg1','items',{'title': 'Test Segmentation','description': 'For test purposes'});
+    env.client.send(req,((err,res) => {
+      if(err) {
+        chai.fail();
+      }
+      else {
+        req = new rqs.CreateManualReqlSegmentation('seg1','items',{'title': 'Test Segmentation','description': 'For test purposes'});
+        env.client.send(req,((err,res) => {
+          if(err) {
+            chai.equal(err.name, 'ResponseError');
+            chai.equal(err.statusCode, 409);
+            done();
+          }
+          else {
+            chai.fail();
+          }
+        }));
+      }
+    }));
+  });
+});

package/test/create-manual-reql-segmentation-test.js

@@ -0,0 +1,43 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('CreateManualReqlSegmentation', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  
+  it ('creates manual ReQL segmentation', (done) => {
+    let req, req2, resp;
+    req = new rqs.CreateManualReqlSegmentation('seg1','items',{'title': 'Test Segmentation','description': 'For test purposes'});
+    env.client.send(req)
+    .then((res) => {
+      req = new rqs.CreateManualReqlSegmentation('seg1','items',{'title': 'Test Segmentation','description': 'For test purposes'});
+      env.client.send(req)
+      .then((res) => {
+        chai.fail();
+        done();
+      })
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
+      });
+    });
+  });
+});

package/test/create-property-based-segmentation-batch_test.js

@@ -0,0 +1,35 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('CreatePropertyBasedSegmentation', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  it ('works in batch', (done) => {
+    let requests = [
+      new rqs.CreatePropertyBasedSegmentation('seg1','items','str_property',{'title': 'Test Segmentation','description': 'For test purposes'}),
+      new rqs.CreatePropertyBasedSegmentation('seg1','items','str_property',{'title': 'Test Segmentation','description': 'For test purposes'})
+      ];
+    
+    env.client.send(new rqs.Batch(requests))
+    .then((responses) => {
+        chai.equal(responses[0].code, 201);
+        chai.equal(responses[1].code, 409);
+      done();
+    });
+  });
+});

package/test/create-property-based-segmentation-callback_test.js

@@ -0,0 +1,45 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('CreatePropertyBasedSegmentation', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  
+  it ('creates property based segmentation', (done) => {
+    let req, req2, resp;
+    req = new rqs.CreatePropertyBasedSegmentation('seg1','items','str_property',{'title': 'Test Segmentation','description': 'For test purposes'});
+    env.client.send(req,((err,res) => {
+      if(err) {
+        chai.fail();
+      }
+      else {
+        req = new rqs.CreatePropertyBasedSegmentation('seg1','items','str_property',{'title': 'Test Segmentation','description': 'For test purposes'});
+        env.client.send(req,((err,res) => {
+          if(err) {
+            chai.equal(err.name, 'ResponseError');
+            chai.equal(err.statusCode, 409);
+            done();
+          }
+          else {
+            chai.fail();
+          }
+        }));
+      }
+    }));
+  });
+});

package/test/create-property-based-segmentation-test.js

@@ -0,0 +1,43 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('CreatePropertyBasedSegmentation', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  
+  it ('creates property based segmentation', (done) => {
+    let req, req2, resp;
+    req = new rqs.CreatePropertyBasedSegmentation('seg1','items','str_property',{'title': 'Test Segmentation','description': 'For test purposes'});
+    env.client.send(req)
+    .then((res) => {
+      req = new rqs.CreatePropertyBasedSegmentation('seg1','items','str_property',{'title': 'Test Segmentation','description': 'For test purposes'});
+      env.client.send(req)
+      .then((res) => {
+        chai.fail();
+        done();
+      })
+      .catch((err) => {
+        if (err instanceof recombee.errors.ResponseError) {
+          chai.equal(err.statusCode, 409);
+          done();
+        }
+        throw err;
+      });
+    });
+  });
+});

package/test/delete-manual-reql-segment-batch_test.js

@@ -0,0 +1,47 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+'use strict'
+var chai = require('chai').assert;
+var recombee = require('./../index.js');
+var rqs = recombee.requests;
+
+var env = require('./set-environment.js');
+
+describe('DeleteManualReqlSegment', function(){
+  this.timeout(150000);
+
+  before(function(done){
+
+    env.setEnvironment()
+    .then(()=> {
+      done();
+     });
+  });
+  it ('works in batch', (done) => {
+    env.client.send(new rqs.CreateManualReqlSegmentation('seg1','items',{'title': 'Test Segmentation','description': 'For test purposes'}),((err,res) => {
+      if(err) {
+        chai.fail();
+      }
+      else {
+        env.client.send(new rqs.AddManualReqlSegment('seg1','first-segment','\'str_property\' != null',{'title': 'First Segment'}),((err,res) => {
+          if(err) {
+            chai.fail();
+          }
+          else {
+            let requests = [
+              new rqs.DeleteManualReqlSegment('seg1','first-segment')
+              ];
+            
+            env.client.send(new rqs.Batch(requests))
+            .then((responses) => {
+                chai.equal(responses[0].code, 200);
+              done();
+            });
+          }
+        }));
+      }
+    }));
+  });
+});