Skip to content

Commit 38654ee

Browse files
committed
Support ListScenarios endpoint
1 parent 6d590af commit 38654ee

34 files changed

+410
-189
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017 Recombee
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

lib/api-client.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ class ApiClient {
4343
method: request.method,
4444
headers: {'Accept': 'application/json',
4545
'Content-Type': 'application/json',
46-
'User-Agent': 'recombee-node-api-client/5.0.2'},
46+
'User-Agent': 'recombee-node-api-client/5.1.0'},
4747
timeout: request.timeout,
4848
agent: this.options.agent
4949
};

lib/index.d.ts

Lines changed: 136 additions & 78 deletions
Large diffs are not rendered by default.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const rqs = require("./request");
77

88
/**
99
* Adds a new Segment into a Manual ReQL Segmentation.
10-
* 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.
10+
* The new Segment is defined by a [ReQL](https://docs.recombee.com/reql) filter that returns `true` for an item in case that this item belongs to the segment.
1111
*/
1212
class AddManualReqlSegment extends rqs.Request {
1313

lib/requests/add-search-synonym.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
const rqs = require("./request");
77

88
/**
9-
* Adds a new synonym for the [Search items](https://docs.recombee.com/api.html#search-items).
9+
* Adds a new synonym for the [Search items](https://docs.recombee.com/api#search-items).
1010
* When the `term` is used in the search query, the `synonym` is also used for the full-text search.
1111
* Unless `oneWay=true`, it works also in the opposite way (`synonym` -> `term`).
1212
* An example of a synonym can be `science fiction` for the term `sci-fi`.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
const rqs = require("./request");
77

88
/**
9-
* Segment the items using a [ReQL](https://docs.recombee.com/reql.html) expression.
9+
* Segment the items using a [ReQL](https://docs.recombee.com/reql) expression.
1010
* For each item, the expression should return a set that contains IDs of segments to which the item belongs to.
1111
*/
1212
class CreateAutoReqlSegmentation extends rqs.Request {

lib/requests/create-manual-reql-segmentation.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
const rqs = require("./request");
77

88
/**
9-
* Segment the items using multiple [ReQL](https://docs.recombee.com/reql.html) filters.
9+
* Segment the items using multiple [ReQL](https://docs.recombee.com/reql) filters.
1010
* Use the Add Manual ReQL Items Segment endpoint to create the individual segments.
1111
*/
1212
class CreateManualReqlSegmentation extends rqs.Request {

lib/requests/delete-item.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const rqs = require("./request");
88
/**
99
* Deletes an item of the given `itemId` from the catalog.
1010
* If there are any *purchases*, *ratings*, *bookmarks*, *cart additions*, or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
11-
* If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
11+
* If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.
1212
*/
1313
class DeleteItem extends rqs.Request {
1414

lib/requests/delete-more-items.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ const rqs = require("./request");
77

88
/**
99
* Deletes all the items that pass the filter.
10-
* If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
10+
* If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.
1111
*/
1212
class DeleteMoreItems extends rqs.Request {
1313

1414
/**
1515
* Construct the request
16-
* @param {string} filter - A [ReQL](https://docs.recombee.com/reql.html) expression, which returns `true` for the items that shall be updated.
16+
* @param {string} filter - A [ReQL](https://docs.recombee.com/reql) expression, which returns `true` for the items that shall be updated.
1717
*/
1818
constructor(filter) {
1919
super('DELETE', '/more-items/', 100000, false);

lib/requests/delete-search-synonym.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
const rqs = require("./request");
77

88
/**
9-
* Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
9+
* Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api#search-items).
1010
*/
1111
class DeleteSearchSynonym extends rqs.Request {
1212

0 commit comments

Comments
 (0)