recombee-api-client 4.1.0 → 4.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/api-client.js +2 -2
- package/lib/index.d.ts +3202 -0
- package/lib/requests/add-bookmark.js +2 -2
- package/lib/requests/add-cart-addition.js +2 -2
- package/lib/requests/add-detail-view.js +2 -2
- package/lib/requests/add-purchase.js +2 -2
- package/lib/requests/add-rating.js +2 -2
- package/lib/requests/delete-more-items.js +1 -1
- package/lib/requests/recommend-item-segments-to-item-segment.js +2 -2
- package/lib/requests/recommend-item-segments-to-item.js +2 -2
- package/lib/requests/recommend-item-segments-to-user.js +2 -2
- package/lib/requests/recommend-items-to-item.js +2 -2
- package/lib/requests/recommend-items-to-user.js +2 -2
- package/lib/requests/recommend-users-to-item.js +2 -2
- package/lib/requests/recommend-users-to-user.js +2 -2
- package/lib/requests/request.js +0 -1
- package/lib/requests/search-item-segments.js +2 -2
- package/lib/requests/search-items.js +2 -2
- package/lib/requests/set-user-values.js +0 -1
- package/lib/requests/set-view-portion.js +2 -2
- package/lib/requests/update-more-items.js +2 -2
- package/package.json +2 -1
- package/doc/AddBookmark.html +0 -506
- package/doc/AddCartAddition.html +0 -512
- package/doc/AddDetailView.html +0 -509
- package/doc/AddGroup.html +0 -447
- package/doc/AddItem.html +0 -448
- package/doc/AddItemProperty.html +0 -478
- package/doc/AddPurchase.html +0 -515
- package/doc/AddRating.html +0 -529
- package/doc/AddSearchSynonym.html +0 -501
- package/doc/AddSeries.html +0 -447
- package/doc/AddUser.html +0 -447
- package/doc/AddUserProperty.html +0 -476
- package/doc/ApiClient.html +0 -433
- package/doc/ApiError.html +0 -170
- package/doc/Batch.html +0 -476
- package/doc/DeleteAllSearchSynonyms.html +0 -398
- package/doc/DeleteBookmark.html +0 -497
- package/doc/DeleteCartAddition.html +0 -497
- package/doc/DeleteDetailView.html +0 -497
- package/doc/DeleteGroup.html +0 -448
- package/doc/DeleteItem.html +0 -449
- package/doc/DeleteItemProperty.html +0 -447
- package/doc/DeleteMoreItems.html +0 -448
- package/doc/DeletePurchase.html +0 -497
- package/doc/DeleteRating.html +0 -497
- package/doc/DeleteSearchSynonym.html +0 -447
- package/doc/DeleteSeries.html +0 -448
- package/doc/DeleteUser.html +0 -448
- package/doc/DeleteUserProperty.html +0 -447
- package/doc/DeleteViewPortion.html +0 -497
- package/doc/GetItemPropertyInfo.html +0 -447
- package/doc/GetItemValues.html +0 -447
- package/doc/GetUserPropertyInfo.html +0 -447
- package/doc/GetUserValues.html +0 -447
- package/doc/InsertToGroup.html +0 -520
- package/doc/InsertToSeries.html +0 -543
- package/doc/ListGroupItems.html +0 -447
- package/doc/ListGroups.html +0 -398
- package/doc/ListItemBookmarks.html +0 -447
- package/doc/ListItemCartAdditions.html +0 -447
- package/doc/ListItemDetailViews.html +0 -447
- package/doc/ListItemProperties.html +0 -398
- package/doc/ListItemPurchases.html +0 -447
- package/doc/ListItemRatings.html +0 -447
- package/doc/ListItemViewPortions.html +0 -447
- package/doc/ListItems.html +0 -497
- package/doc/ListSearchSynonyms.html +0 -454
- package/doc/ListSeries.html +0 -398
- package/doc/ListSeriesItems.html +0 -447
- package/doc/ListUserBookmarks.html +0 -447
- package/doc/ListUserCartAdditions.html +0 -447
- package/doc/ListUserDetailViews.html +0 -447
- package/doc/ListUserProperties.html +0 -398
- package/doc/ListUserPurchases.html +0 -447
- package/doc/ListUserRatings.html +0 -447
- package/doc/ListUserViewPortions.html +0 -447
- package/doc/ListUsers.html +0 -491
- package/doc/MergeUsers.html +0 -498
- package/doc/RecommendItemsToItem.html +0 -635
- package/doc/RecommendItemsToUser.html +0 -598
- package/doc/RecommendNextItems.html +0 -480
- package/doc/RecommendUsersToItem.html +0 -579
- package/doc/RecommendUsersToUser.html +0 -588
- package/doc/RemoveFromGroup.html +0 -493
- package/doc/RemoveFromSeries.html +0 -516
- package/doc/Request.html +0 -292
- package/doc/ResetDatabase.html +0 -398
- package/doc/ResponseError.html +0 -269
- package/doc/SearchItems.html +0 -610
- package/doc/SetItemValues.html +0 -279
- package/doc/SetUserValues.html +0 -277
- package/doc/SetValues.html +0 -480
- package/doc/SetViewPortion.html +0 -533
- package/doc/TimeoutError.html +0 -246
- package/doc/UpdateMoreItems.html +0 -472
- package/doc/api-client.js.html +0 -248
- package/doc/errors_api-error.js.html +0 -71
- package/doc/errors_response-error.js.html +0 -72
- package/doc/errors_timeout-error.js.html +0 -71
- package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
- package/doc/fonts/OpenSans-Bold-webfont.svg +0 -1830
- package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
- package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
- package/doc/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
- package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
- package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
- package/doc/fonts/OpenSans-Italic-webfont.svg +0 -1830
- package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
- package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
- package/doc/fonts/OpenSans-Light-webfont.svg +0 -1831
- package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
- package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
- package/doc/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
- package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
- package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
- package/doc/fonts/OpenSans-Regular-webfont.svg +0 -1831
- package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
- package/doc/index.html +0 -65
- package/doc/requests_add-bookmark.js.html +0 -128
- package/doc/requests_add-cart-addition.js.html +0 -142
- package/doc/requests_add-detail-view.js.html +0 -135
- package/doc/requests_add-group.js.html +0 -93
- package/doc/requests_add-item-property.js.html +0 -104
- package/doc/requests_add-item.js.html +0 -94
- package/doc/requests_add-purchase.js.html +0 -149
- package/doc/requests_add-rating.js.html +0 -131
- package/doc/requests_add-search-synonym.js.html +0 -111
- package/doc/requests_add-series.js.html +0 -93
- package/doc/requests_add-user-property.js.html +0 -102
- package/doc/requests_add-user.js.html +0 -93
- package/doc/requests_batch.js.html +0 -121
- package/doc/requests_delete-all-search-synonyms.js.html +0 -91
- package/doc/requests_delete-bookmark.js.html +0 -106
- package/doc/requests_delete-cart-addition.js.html +0 -106
- package/doc/requests_delete-detail-view.js.html +0 -106
- package/doc/requests_delete-group.js.html +0 -94
- package/doc/requests_delete-item-property.js.html +0 -93
- package/doc/requests_delete-item.js.html +0 -95
- package/doc/requests_delete-more-items.js.html +0 -95
- package/doc/requests_delete-purchase.js.html +0 -106
- package/doc/requests_delete-rating.js.html +0 -106
- package/doc/requests_delete-search-synonym.js.html +0 -93
- package/doc/requests_delete-series.js.html +0 -94
- package/doc/requests_delete-user-property.js.html +0 -93
- package/doc/requests_delete-user.js.html +0 -94
- package/doc/requests_delete-view-portion.js.html +0 -106
- package/doc/requests_get-item-property-info.js.html +0 -93
- package/doc/requests_get-item-values.js.html +0 -93
- package/doc/requests_get-user-property-info.js.html +0 -93
- package/doc/requests_get-user-values.js.html +0 -93
- package/doc/requests_insert-to-group.js.html +0 -109
- package/doc/requests_insert-to-series.js.html +0 -112
- package/doc/requests_list-group-items.js.html +0 -93
- package/doc/requests_list-groups.js.html +0 -91
- package/doc/requests_list-item-bookmarks.js.html +0 -93
- package/doc/requests_list-item-cart-additions.js.html +0 -93
- package/doc/requests_list-item-detail-views.js.html +0 -93
- package/doc/requests_list-item-properties.js.html +0 -91
- package/doc/requests_list-item-purchases.js.html +0 -93
- package/doc/requests_list-item-ratings.js.html +0 -93
- package/doc/requests_list-item-view-portions.js.html +0 -93
- package/doc/requests_list-items.js.html +0 -158
- package/doc/requests_list-search-synonyms.js.html +0 -106
- package/doc/requests_list-series-items.js.html +0 -93
- package/doc/requests_list-series.js.html +0 -91
- package/doc/requests_list-user-bookmarks.js.html +0 -93
- package/doc/requests_list-user-cart-additions.js.html +0 -93
- package/doc/requests_list-user-detail-views.js.html +0 -93
- package/doc/requests_list-user-properties.js.html +0 -91
- package/doc/requests_list-user-purchases.js.html +0 -93
- package/doc/requests_list-user-ratings.js.html +0 -93
- package/doc/requests_list-user-view-portions.js.html +0 -93
- package/doc/requests_list-users.js.html +0 -152
- package/doc/requests_merge-users.js.html +0 -105
- package/doc/requests_recommend-items-to-item.js.html +0 -276
- package/doc/requests_recommend-items-to-user.js.html +0 -255
- package/doc/requests_recommend-next-items.js.html +0 -106
- package/doc/requests_recommend-users-to-item.js.html +0 -224
- package/doc/requests_recommend-users-to-user.js.html +0 -245
- package/doc/requests_remove-from-group.js.html +0 -99
- package/doc/requests_remove-from-series.js.html +0 -102
- package/doc/requests_request.js.html +0 -73
- package/doc/requests_reset-database.js.html +0 -91
- package/doc/requests_search-items.js.html +0 -231
- package/doc/requests_set-item-values.js.html +0 -80
- package/doc/requests_set-user-values.js.html +0 -79
- package/doc/requests_set-values.js.html +0 -102
- package/doc/requests_set-view-portion.js.html +0 -139
- package/doc/requests_update-more-items.js.html +0 -104
- package/doc/scripts/linenumber.js +0 -25
- package/doc/scripts/prettify/Apache-License-2.0.txt +0 -202
- package/doc/scripts/prettify/lang-css.js +0 -2
- package/doc/scripts/prettify/prettify.js +0 -28
- package/doc/styles/jsdoc-default.css +0 -358
- package/doc/styles/prettify-jsdoc.css +0 -111
- package/doc/styles/prettify-tomorrow.css +0 -132
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8">
|
|
5
|
-
<title>JSDoc: Source: requests/add-series.js</title>
|
|
6
|
-
|
|
7
|
-
<script src="scripts/prettify/prettify.js"> </script>
|
|
8
|
-
<script src="scripts/prettify/lang-css.js"> </script>
|
|
9
|
-
<!--[if lt IE 9]>
|
|
10
|
-
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
11
|
-
<![endif]-->
|
|
12
|
-
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
13
|
-
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
14
|
-
</head>
|
|
15
|
-
|
|
16
|
-
<body>
|
|
17
|
-
|
|
18
|
-
<div id="main">
|
|
19
|
-
|
|
20
|
-
<h1 class="page-title">Source: requests/add-series.js</h1>
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
<section>
|
|
28
|
-
<article>
|
|
29
|
-
<pre class="prettyprint source linenums"><code>/*
|
|
30
|
-
This file is auto-generated, do not edit
|
|
31
|
-
*/
|
|
32
|
-
|
|
33
|
-
'use strict';
|
|
34
|
-
const rqs = require("./request");
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* Creates new series in the database.
|
|
38
|
-
*/
|
|
39
|
-
class AddSeries extends rqs.Request {
|
|
40
|
-
|
|
41
|
-
/**
|
|
42
|
-
* Construct the request
|
|
43
|
-
* @param {string} seriesId - ID of the series to be created.
|
|
44
|
-
*/
|
|
45
|
-
constructor(seriesId) {
|
|
46
|
-
super('PUT', `/series/${seriesId}`, 1000, false);
|
|
47
|
-
this.seriesId = seriesId;
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
/**
|
|
51
|
-
* Get body parameters
|
|
52
|
-
* @return {Object} The values of body parameters (name of parameter: value of the parameter)
|
|
53
|
-
*/
|
|
54
|
-
bodyParameters() {
|
|
55
|
-
let params = {};
|
|
56
|
-
|
|
57
|
-
return params;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
/**
|
|
61
|
-
* Get query parameters
|
|
62
|
-
* @return {Object} The values of query parameters (name of parameter: value of the parameter)
|
|
63
|
-
*/
|
|
64
|
-
queryParameters() {
|
|
65
|
-
let params = {};
|
|
66
|
-
return params;
|
|
67
|
-
}
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
exports.AddSeries = AddSeries
|
|
71
|
-
</code></pre>
|
|
72
|
-
</article>
|
|
73
|
-
</section>
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
</div>
|
|
79
|
-
|
|
80
|
-
<nav>
|
|
81
|
-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookmark.html">AddBookmark</a></li><li><a href="AddCartAddition.html">AddCartAddition</a></li><li><a href="AddDetailView.html">AddDetailView</a></li><li><a href="AddGroup.html">AddGroup</a></li><li><a href="AddItem.html">AddItem</a></li><li><a href="AddItemProperty.html">AddItemProperty</a></li><li><a href="AddPurchase.html">AddPurchase</a></li><li><a href="AddRating.html">AddRating</a></li><li><a href="AddSearchSynonym.html">AddSearchSynonym</a></li><li><a href="AddSeries.html">AddSeries</a></li><li><a href="AddUser.html">AddUser</a></li><li><a href="AddUserProperty.html">AddUserProperty</a></li><li><a href="ApiClient.html">ApiClient</a></li><li><a href="ApiError.html">ApiError</a></li><li><a href="Batch.html">Batch</a></li><li><a href="DeleteAllSearchSynonyms.html">DeleteAllSearchSynonyms</a></li><li><a href="DeleteBookmark.html">DeleteBookmark</a></li><li><a href="DeleteCartAddition.html">DeleteCartAddition</a></li><li><a href="DeleteDetailView.html">DeleteDetailView</a></li><li><a href="DeleteGroup.html">DeleteGroup</a></li><li><a href="DeleteItem.html">DeleteItem</a></li><li><a href="DeleteItemProperty.html">DeleteItemProperty</a></li><li><a href="DeleteMoreItems.html">DeleteMoreItems</a></li><li><a href="DeletePurchase.html">DeletePurchase</a></li><li><a href="DeleteRating.html">DeleteRating</a></li><li><a href="DeleteSearchSynonym.html">DeleteSearchSynonym</a></li><li><a href="DeleteSeries.html">DeleteSeries</a></li><li><a href="DeleteUser.html">DeleteUser</a></li><li><a href="DeleteUserProperty.html">DeleteUserProperty</a></li><li><a href="DeleteViewPortion.html">DeleteViewPortion</a></li><li><a href="GetItemPropertyInfo.html">GetItemPropertyInfo</a></li><li><a href="GetItemValues.html">GetItemValues</a></li><li><a href="GetUserPropertyInfo.html">GetUserPropertyInfo</a></li><li><a href="GetUserValues.html">GetUserValues</a></li><li><a href="InsertToGroup.html">InsertToGroup</a></li><li><a href="InsertToSeries.html">InsertToSeries</a></li><li><a href="ListGroupItems.html">ListGroupItems</a></li><li><a href="ListGroups.html">ListGroups</a></li><li><a href="ListItemBookmarks.html">ListItemBookmarks</a></li><li><a href="ListItemCartAdditions.html">ListItemCartAdditions</a></li><li><a href="ListItemDetailViews.html">ListItemDetailViews</a></li><li><a href="ListItemProperties.html">ListItemProperties</a></li><li><a href="ListItemPurchases.html">ListItemPurchases</a></li><li><a href="ListItemRatings.html">ListItemRatings</a></li><li><a href="ListItems.html">ListItems</a></li><li><a href="ListItemViewPortions.html">ListItemViewPortions</a></li><li><a href="ListSearchSynonyms.html">ListSearchSynonyms</a></li><li><a href="ListSeries.html">ListSeries</a></li><li><a href="ListSeriesItems.html">ListSeriesItems</a></li><li><a href="ListUserBookmarks.html">ListUserBookmarks</a></li><li><a href="ListUserCartAdditions.html">ListUserCartAdditions</a></li><li><a href="ListUserDetailViews.html">ListUserDetailViews</a></li><li><a href="ListUserProperties.html">ListUserProperties</a></li><li><a href="ListUserPurchases.html">ListUserPurchases</a></li><li><a href="ListUserRatings.html">ListUserRatings</a></li><li><a href="ListUsers.html">ListUsers</a></li><li><a href="ListUserViewPortions.html">ListUserViewPortions</a></li><li><a href="MergeUsers.html">MergeUsers</a></li><li><a href="RecommendItemsToItem.html">RecommendItemsToItem</a></li><li><a href="RecommendItemsToUser.html">RecommendItemsToUser</a></li><li><a href="RecommendNextItems.html">RecommendNextItems</a></li><li><a href="RecommendUsersToItem.html">RecommendUsersToItem</a></li><li><a href="RecommendUsersToUser.html">RecommendUsersToUser</a></li><li><a href="RemoveFromGroup.html">RemoveFromGroup</a></li><li><a href="RemoveFromSeries.html">RemoveFromSeries</a></li><li><a href="Request.html">Request</a></li><li><a href="ResetDatabase.html">ResetDatabase</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="SearchItems.html">SearchItems</a></li><li><a href="SetItemValues.html">SetItemValues</a></li><li><a href="SetUserValues.html">SetUserValues</a></li><li><a href="SetValues.html">SetValues</a></li><li><a href="SetViewPortion.html">SetViewPortion</a></li><li><a href="TimeoutError.html">TimeoutError</a></li><li><a href="UpdateMoreItems.html">UpdateMoreItems</a></li></ul>
|
|
82
|
-
</nav>
|
|
83
|
-
|
|
84
|
-
<br class="clear">
|
|
85
|
-
|
|
86
|
-
<footer>
|
|
87
|
-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Mon Apr 25 2022 16:02:57 GMT+0200 (Central European Summer Time)
|
|
88
|
-
</footer>
|
|
89
|
-
|
|
90
|
-
<script> prettyPrint(); </script>
|
|
91
|
-
<script src="scripts/linenumber.js"> </script>
|
|
92
|
-
</body>
|
|
93
|
-
</html>
|
|
@@ -1,102 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8">
|
|
5
|
-
<title>JSDoc: Source: requests/add-user-property.js</title>
|
|
6
|
-
|
|
7
|
-
<script src="scripts/prettify/prettify.js"> </script>
|
|
8
|
-
<script src="scripts/prettify/lang-css.js"> </script>
|
|
9
|
-
<!--[if lt IE 9]>
|
|
10
|
-
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
11
|
-
<![endif]-->
|
|
12
|
-
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
13
|
-
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
14
|
-
</head>
|
|
15
|
-
|
|
16
|
-
<body>
|
|
17
|
-
|
|
18
|
-
<div id="main">
|
|
19
|
-
|
|
20
|
-
<h1 class="page-title">Source: requests/add-user-property.js</h1>
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
<section>
|
|
28
|
-
<article>
|
|
29
|
-
<pre class="prettyprint source linenums"><code>/*
|
|
30
|
-
This file is auto-generated, do not edit
|
|
31
|
-
*/
|
|
32
|
-
|
|
33
|
-
'use strict';
|
|
34
|
-
const rqs = require("./request");
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* 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.
|
|
38
|
-
*/
|
|
39
|
-
class AddUserProperty extends rqs.Request {
|
|
40
|
-
|
|
41
|
-
/**
|
|
42
|
-
* Construct the request
|
|
43
|
-
* @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.
|
|
44
|
-
* @param {string} type - Value type of the user property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`.
|
|
45
|
-
* * `int` - Signed integer number.
|
|
46
|
-
* * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
|
|
47
|
-
* * `string` - UTF-8 string.
|
|
48
|
-
* * `boolean` - *true* / *false*
|
|
49
|
-
* * `timestamp` - Value representing date and time.
|
|
50
|
-
* * `set` - Set of strings.
|
|
51
|
-
*/
|
|
52
|
-
constructor(propertyName, type) {
|
|
53
|
-
super('PUT', `/users/properties/${propertyName}`, 100000, false);
|
|
54
|
-
this.propertyName = propertyName;
|
|
55
|
-
this.type = type;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
/**
|
|
59
|
-
* Get body parameters
|
|
60
|
-
* @return {Object} The values of body parameters (name of parameter: value of the parameter)
|
|
61
|
-
*/
|
|
62
|
-
bodyParameters() {
|
|
63
|
-
let params = {};
|
|
64
|
-
|
|
65
|
-
return params;
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* Get query parameters
|
|
70
|
-
* @return {Object} The values of query parameters (name of parameter: value of the parameter)
|
|
71
|
-
*/
|
|
72
|
-
queryParameters() {
|
|
73
|
-
let params = {};
|
|
74
|
-
params.type = this.type;
|
|
75
|
-
return params;
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
exports.AddUserProperty = AddUserProperty
|
|
80
|
-
</code></pre>
|
|
81
|
-
</article>
|
|
82
|
-
</section>
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
</div>
|
|
88
|
-
|
|
89
|
-
<nav>
|
|
90
|
-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookmark.html">AddBookmark</a></li><li><a href="AddCartAddition.html">AddCartAddition</a></li><li><a href="AddDetailView.html">AddDetailView</a></li><li><a href="AddGroup.html">AddGroup</a></li><li><a href="AddItem.html">AddItem</a></li><li><a href="AddItemProperty.html">AddItemProperty</a></li><li><a href="AddPurchase.html">AddPurchase</a></li><li><a href="AddRating.html">AddRating</a></li><li><a href="AddSearchSynonym.html">AddSearchSynonym</a></li><li><a href="AddSeries.html">AddSeries</a></li><li><a href="AddUser.html">AddUser</a></li><li><a href="AddUserProperty.html">AddUserProperty</a></li><li><a href="ApiClient.html">ApiClient</a></li><li><a href="ApiError.html">ApiError</a></li><li><a href="Batch.html">Batch</a></li><li><a href="DeleteAllSearchSynonyms.html">DeleteAllSearchSynonyms</a></li><li><a href="DeleteBookmark.html">DeleteBookmark</a></li><li><a href="DeleteCartAddition.html">DeleteCartAddition</a></li><li><a href="DeleteDetailView.html">DeleteDetailView</a></li><li><a href="DeleteGroup.html">DeleteGroup</a></li><li><a href="DeleteItem.html">DeleteItem</a></li><li><a href="DeleteItemProperty.html">DeleteItemProperty</a></li><li><a href="DeleteMoreItems.html">DeleteMoreItems</a></li><li><a href="DeletePurchase.html">DeletePurchase</a></li><li><a href="DeleteRating.html">DeleteRating</a></li><li><a href="DeleteSearchSynonym.html">DeleteSearchSynonym</a></li><li><a href="DeleteSeries.html">DeleteSeries</a></li><li><a href="DeleteUser.html">DeleteUser</a></li><li><a href="DeleteUserProperty.html">DeleteUserProperty</a></li><li><a href="DeleteViewPortion.html">DeleteViewPortion</a></li><li><a href="GetItemPropertyInfo.html">GetItemPropertyInfo</a></li><li><a href="GetItemValues.html">GetItemValues</a></li><li><a href="GetUserPropertyInfo.html">GetUserPropertyInfo</a></li><li><a href="GetUserValues.html">GetUserValues</a></li><li><a href="InsertToGroup.html">InsertToGroup</a></li><li><a href="InsertToSeries.html">InsertToSeries</a></li><li><a href="ListGroupItems.html">ListGroupItems</a></li><li><a href="ListGroups.html">ListGroups</a></li><li><a href="ListItemBookmarks.html">ListItemBookmarks</a></li><li><a href="ListItemCartAdditions.html">ListItemCartAdditions</a></li><li><a href="ListItemDetailViews.html">ListItemDetailViews</a></li><li><a href="ListItemProperties.html">ListItemProperties</a></li><li><a href="ListItemPurchases.html">ListItemPurchases</a></li><li><a href="ListItemRatings.html">ListItemRatings</a></li><li><a href="ListItems.html">ListItems</a></li><li><a href="ListItemViewPortions.html">ListItemViewPortions</a></li><li><a href="ListSearchSynonyms.html">ListSearchSynonyms</a></li><li><a href="ListSeries.html">ListSeries</a></li><li><a href="ListSeriesItems.html">ListSeriesItems</a></li><li><a href="ListUserBookmarks.html">ListUserBookmarks</a></li><li><a href="ListUserCartAdditions.html">ListUserCartAdditions</a></li><li><a href="ListUserDetailViews.html">ListUserDetailViews</a></li><li><a href="ListUserProperties.html">ListUserProperties</a></li><li><a href="ListUserPurchases.html">ListUserPurchases</a></li><li><a href="ListUserRatings.html">ListUserRatings</a></li><li><a href="ListUsers.html">ListUsers</a></li><li><a href="ListUserViewPortions.html">ListUserViewPortions</a></li><li><a href="MergeUsers.html">MergeUsers</a></li><li><a href="RecommendItemsToItem.html">RecommendItemsToItem</a></li><li><a href="RecommendItemsToUser.html">RecommendItemsToUser</a></li><li><a href="RecommendNextItems.html">RecommendNextItems</a></li><li><a href="RecommendUsersToItem.html">RecommendUsersToItem</a></li><li><a href="RecommendUsersToUser.html">RecommendUsersToUser</a></li><li><a href="RemoveFromGroup.html">RemoveFromGroup</a></li><li><a href="RemoveFromSeries.html">RemoveFromSeries</a></li><li><a href="Request.html">Request</a></li><li><a href="ResetDatabase.html">ResetDatabase</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="SearchItems.html">SearchItems</a></li><li><a href="SetItemValues.html">SetItemValues</a></li><li><a href="SetUserValues.html">SetUserValues</a></li><li><a href="SetValues.html">SetValues</a></li><li><a href="SetViewPortion.html">SetViewPortion</a></li><li><a href="TimeoutError.html">TimeoutError</a></li><li><a href="UpdateMoreItems.html">UpdateMoreItems</a></li></ul>
|
|
91
|
-
</nav>
|
|
92
|
-
|
|
93
|
-
<br class="clear">
|
|
94
|
-
|
|
95
|
-
<footer>
|
|
96
|
-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Mon Apr 25 2022 16:02:57 GMT+0200 (Central European Summer Time)
|
|
97
|
-
</footer>
|
|
98
|
-
|
|
99
|
-
<script> prettyPrint(); </script>
|
|
100
|
-
<script src="scripts/linenumber.js"> </script>
|
|
101
|
-
</body>
|
|
102
|
-
</html>
|
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8">
|
|
5
|
-
<title>JSDoc: Source: requests/add-user.js</title>
|
|
6
|
-
|
|
7
|
-
<script src="scripts/prettify/prettify.js"> </script>
|
|
8
|
-
<script src="scripts/prettify/lang-css.js"> </script>
|
|
9
|
-
<!--[if lt IE 9]>
|
|
10
|
-
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
11
|
-
<![endif]-->
|
|
12
|
-
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
13
|
-
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
14
|
-
</head>
|
|
15
|
-
|
|
16
|
-
<body>
|
|
17
|
-
|
|
18
|
-
<div id="main">
|
|
19
|
-
|
|
20
|
-
<h1 class="page-title">Source: requests/add-user.js</h1>
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
<section>
|
|
28
|
-
<article>
|
|
29
|
-
<pre class="prettyprint source linenums"><code>/*
|
|
30
|
-
This file is auto-generated, do not edit
|
|
31
|
-
*/
|
|
32
|
-
|
|
33
|
-
'use strict';
|
|
34
|
-
const rqs = require("./request");
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* Adds a new user to the database.
|
|
38
|
-
*/
|
|
39
|
-
class AddUser extends rqs.Request {
|
|
40
|
-
|
|
41
|
-
/**
|
|
42
|
-
* Construct the request
|
|
43
|
-
* @param {string} userId - ID of the user to be added.
|
|
44
|
-
*/
|
|
45
|
-
constructor(userId) {
|
|
46
|
-
super('PUT', `/users/${userId}`, 1000, false);
|
|
47
|
-
this.userId = userId;
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
/**
|
|
51
|
-
* Get body parameters
|
|
52
|
-
* @return {Object} The values of body parameters (name of parameter: value of the parameter)
|
|
53
|
-
*/
|
|
54
|
-
bodyParameters() {
|
|
55
|
-
let params = {};
|
|
56
|
-
|
|
57
|
-
return params;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
/**
|
|
61
|
-
* Get query parameters
|
|
62
|
-
* @return {Object} The values of query parameters (name of parameter: value of the parameter)
|
|
63
|
-
*/
|
|
64
|
-
queryParameters() {
|
|
65
|
-
let params = {};
|
|
66
|
-
return params;
|
|
67
|
-
}
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
exports.AddUser = AddUser
|
|
71
|
-
</code></pre>
|
|
72
|
-
</article>
|
|
73
|
-
</section>
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
</div>
|
|
79
|
-
|
|
80
|
-
<nav>
|
|
81
|
-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookmark.html">AddBookmark</a></li><li><a href="AddCartAddition.html">AddCartAddition</a></li><li><a href="AddDetailView.html">AddDetailView</a></li><li><a href="AddGroup.html">AddGroup</a></li><li><a href="AddItem.html">AddItem</a></li><li><a href="AddItemProperty.html">AddItemProperty</a></li><li><a href="AddPurchase.html">AddPurchase</a></li><li><a href="AddRating.html">AddRating</a></li><li><a href="AddSearchSynonym.html">AddSearchSynonym</a></li><li><a href="AddSeries.html">AddSeries</a></li><li><a href="AddUser.html">AddUser</a></li><li><a href="AddUserProperty.html">AddUserProperty</a></li><li><a href="ApiClient.html">ApiClient</a></li><li><a href="ApiError.html">ApiError</a></li><li><a href="Batch.html">Batch</a></li><li><a href="DeleteAllSearchSynonyms.html">DeleteAllSearchSynonyms</a></li><li><a href="DeleteBookmark.html">DeleteBookmark</a></li><li><a href="DeleteCartAddition.html">DeleteCartAddition</a></li><li><a href="DeleteDetailView.html">DeleteDetailView</a></li><li><a href="DeleteGroup.html">DeleteGroup</a></li><li><a href="DeleteItem.html">DeleteItem</a></li><li><a href="DeleteItemProperty.html">DeleteItemProperty</a></li><li><a href="DeleteMoreItems.html">DeleteMoreItems</a></li><li><a href="DeletePurchase.html">DeletePurchase</a></li><li><a href="DeleteRating.html">DeleteRating</a></li><li><a href="DeleteSearchSynonym.html">DeleteSearchSynonym</a></li><li><a href="DeleteSeries.html">DeleteSeries</a></li><li><a href="DeleteUser.html">DeleteUser</a></li><li><a href="DeleteUserProperty.html">DeleteUserProperty</a></li><li><a href="DeleteViewPortion.html">DeleteViewPortion</a></li><li><a href="GetItemPropertyInfo.html">GetItemPropertyInfo</a></li><li><a href="GetItemValues.html">GetItemValues</a></li><li><a href="GetUserPropertyInfo.html">GetUserPropertyInfo</a></li><li><a href="GetUserValues.html">GetUserValues</a></li><li><a href="InsertToGroup.html">InsertToGroup</a></li><li><a href="InsertToSeries.html">InsertToSeries</a></li><li><a href="ListGroupItems.html">ListGroupItems</a></li><li><a href="ListGroups.html">ListGroups</a></li><li><a href="ListItemBookmarks.html">ListItemBookmarks</a></li><li><a href="ListItemCartAdditions.html">ListItemCartAdditions</a></li><li><a href="ListItemDetailViews.html">ListItemDetailViews</a></li><li><a href="ListItemProperties.html">ListItemProperties</a></li><li><a href="ListItemPurchases.html">ListItemPurchases</a></li><li><a href="ListItemRatings.html">ListItemRatings</a></li><li><a href="ListItems.html">ListItems</a></li><li><a href="ListItemViewPortions.html">ListItemViewPortions</a></li><li><a href="ListSearchSynonyms.html">ListSearchSynonyms</a></li><li><a href="ListSeries.html">ListSeries</a></li><li><a href="ListSeriesItems.html">ListSeriesItems</a></li><li><a href="ListUserBookmarks.html">ListUserBookmarks</a></li><li><a href="ListUserCartAdditions.html">ListUserCartAdditions</a></li><li><a href="ListUserDetailViews.html">ListUserDetailViews</a></li><li><a href="ListUserProperties.html">ListUserProperties</a></li><li><a href="ListUserPurchases.html">ListUserPurchases</a></li><li><a href="ListUserRatings.html">ListUserRatings</a></li><li><a href="ListUsers.html">ListUsers</a></li><li><a href="ListUserViewPortions.html">ListUserViewPortions</a></li><li><a href="MergeUsers.html">MergeUsers</a></li><li><a href="RecommendItemsToItem.html">RecommendItemsToItem</a></li><li><a href="RecommendItemsToUser.html">RecommendItemsToUser</a></li><li><a href="RecommendNextItems.html">RecommendNextItems</a></li><li><a href="RecommendUsersToItem.html">RecommendUsersToItem</a></li><li><a href="RecommendUsersToUser.html">RecommendUsersToUser</a></li><li><a href="RemoveFromGroup.html">RemoveFromGroup</a></li><li><a href="RemoveFromSeries.html">RemoveFromSeries</a></li><li><a href="Request.html">Request</a></li><li><a href="ResetDatabase.html">ResetDatabase</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="SearchItems.html">SearchItems</a></li><li><a href="SetItemValues.html">SetItemValues</a></li><li><a href="SetUserValues.html">SetUserValues</a></li><li><a href="SetValues.html">SetValues</a></li><li><a href="SetViewPortion.html">SetViewPortion</a></li><li><a href="TimeoutError.html">TimeoutError</a></li><li><a href="UpdateMoreItems.html">UpdateMoreItems</a></li></ul>
|
|
82
|
-
</nav>
|
|
83
|
-
|
|
84
|
-
<br class="clear">
|
|
85
|
-
|
|
86
|
-
<footer>
|
|
87
|
-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Mon Apr 25 2022 16:02:57 GMT+0200 (Central European Summer Time)
|
|
88
|
-
</footer>
|
|
89
|
-
|
|
90
|
-
<script> prettyPrint(); </script>
|
|
91
|
-
<script src="scripts/linenumber.js"> </script>
|
|
92
|
-
</body>
|
|
93
|
-
</html>
|
|
@@ -1,121 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8">
|
|
5
|
-
<title>JSDoc: Source: requests/batch.js</title>
|
|
6
|
-
|
|
7
|
-
<script src="scripts/prettify/prettify.js"> </script>
|
|
8
|
-
<script src="scripts/prettify/lang-css.js"> </script>
|
|
9
|
-
<!--[if lt IE 9]>
|
|
10
|
-
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
11
|
-
<![endif]-->
|
|
12
|
-
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
13
|
-
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
14
|
-
</head>
|
|
15
|
-
|
|
16
|
-
<body>
|
|
17
|
-
|
|
18
|
-
<div id="main">
|
|
19
|
-
|
|
20
|
-
<h1 class="page-title">Source: requests/batch.js</h1>
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
<section>
|
|
28
|
-
<article>
|
|
29
|
-
<pre class="prettyprint source linenums"><code>'use strict';
|
|
30
|
-
const rqs = require("./request");
|
|
31
|
-
|
|
32
|
-
var sum_timeouts = ((requests) => {
|
|
33
|
-
return requests.map((r) => r.timeout).reduce((a, b) => a + b, 0);
|
|
34
|
-
});
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* In many cases, it may be desirable to execute multiple requests at once. For example, when synchronizing the catalog of items in a periodical manner, you would have to execute a sequence of thousands of separate POST requests, which is very ineffective and may take a very long time to complete. Most notably, network latencies can make execution of such sequence very slow and even if executed in multiple parallel threads, there will still be unreasonable overhead caused by the HTTP(s). To avoid the mentioned problems, batch processing may be used, encapsulating a sequence of requests into a single HTTPS request.
|
|
38
|
-
* Batch processing allows you to submit arbitrary sequence of requests and the batch may combine different types of requests arbitrarily as well.
|
|
39
|
-
* Note that the status code of the batch request itself is 200 even if the individual requests result in error – you have to inspect the code values in the resulting array.
|
|
40
|
-
*/
|
|
41
|
-
class Batch extends rqs.Request {
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* Construct the request
|
|
45
|
-
* @param {Request[]} requests - Array containing the requests.
|
|
46
|
-
* @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
|
|
47
|
-
* - Allowed parameters:
|
|
48
|
-
* - *distinctRecomms*
|
|
49
|
-
* - Type: boolean
|
|
50
|
-
* - Description: Makes all the recommended items for a certain user distinct among multiple recommendation requests in the batch.
|
|
51
|
-
*/
|
|
52
|
-
constructor(requests, optional) {
|
|
53
|
-
super('POST', '/batch/', sum_timeouts(requests), true);
|
|
54
|
-
this.requests = requests;
|
|
55
|
-
optional = optional || {};
|
|
56
|
-
this.distinctRecomms = optional.distinctRecomms;
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
/**
|
|
60
|
-
* Get body parameters
|
|
61
|
-
* @return {Object} The values of body parameters (name of parameter: value of the parameter)
|
|
62
|
-
*/
|
|
63
|
-
bodyParameters() {
|
|
64
|
-
let reqs = this.requests.map((r) => this._request_to_batch_object(r));
|
|
65
|
-
let result = {requests: reqs};
|
|
66
|
-
|
|
67
|
-
if(this.distinctRecomms !== undefined)
|
|
68
|
-
result.distinctRecomms = this.distinctRecomms;
|
|
69
|
-
|
|
70
|
-
return result;
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
_request_to_batch_object(req) {
|
|
74
|
-
let bo = {
|
|
75
|
-
method: req.method,
|
|
76
|
-
path: req.path
|
|
77
|
-
};
|
|
78
|
-
|
|
79
|
-
let params = req.queryParameters();
|
|
80
|
-
let bodyParams = req.bodyParameters();
|
|
81
|
-
for (var attrname in bodyParams) { params[attrname] = bodyParams[attrname]; }
|
|
82
|
-
|
|
83
|
-
if(Object.keys(params).length > 0)
|
|
84
|
-
bo.params = params;
|
|
85
|
-
|
|
86
|
-
return bo;
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
/**
|
|
90
|
-
* Get query parameters
|
|
91
|
-
* @return {Object} The values of query parameters (name of parameter: value of the parameter)
|
|
92
|
-
*/
|
|
93
|
-
queryParameters() {
|
|
94
|
-
return {};
|
|
95
|
-
}
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
exports.Batch = Batch
|
|
99
|
-
</code></pre>
|
|
100
|
-
</article>
|
|
101
|
-
</section>
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
</div>
|
|
107
|
-
|
|
108
|
-
<nav>
|
|
109
|
-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookmark.html">AddBookmark</a></li><li><a href="AddCartAddition.html">AddCartAddition</a></li><li><a href="AddDetailView.html">AddDetailView</a></li><li><a href="AddGroup.html">AddGroup</a></li><li><a href="AddItem.html">AddItem</a></li><li><a href="AddItemProperty.html">AddItemProperty</a></li><li><a href="AddPurchase.html">AddPurchase</a></li><li><a href="AddRating.html">AddRating</a></li><li><a href="AddSearchSynonym.html">AddSearchSynonym</a></li><li><a href="AddSeries.html">AddSeries</a></li><li><a href="AddUser.html">AddUser</a></li><li><a href="AddUserProperty.html">AddUserProperty</a></li><li><a href="ApiClient.html">ApiClient</a></li><li><a href="ApiError.html">ApiError</a></li><li><a href="Batch.html">Batch</a></li><li><a href="DeleteAllSearchSynonyms.html">DeleteAllSearchSynonyms</a></li><li><a href="DeleteBookmark.html">DeleteBookmark</a></li><li><a href="DeleteCartAddition.html">DeleteCartAddition</a></li><li><a href="DeleteDetailView.html">DeleteDetailView</a></li><li><a href="DeleteGroup.html">DeleteGroup</a></li><li><a href="DeleteItem.html">DeleteItem</a></li><li><a href="DeleteItemProperty.html">DeleteItemProperty</a></li><li><a href="DeleteMoreItems.html">DeleteMoreItems</a></li><li><a href="DeletePurchase.html">DeletePurchase</a></li><li><a href="DeleteRating.html">DeleteRating</a></li><li><a href="DeleteSearchSynonym.html">DeleteSearchSynonym</a></li><li><a href="DeleteSeries.html">DeleteSeries</a></li><li><a href="DeleteUser.html">DeleteUser</a></li><li><a href="DeleteUserProperty.html">DeleteUserProperty</a></li><li><a href="DeleteViewPortion.html">DeleteViewPortion</a></li><li><a href="GetItemPropertyInfo.html">GetItemPropertyInfo</a></li><li><a href="GetItemValues.html">GetItemValues</a></li><li><a href="GetUserPropertyInfo.html">GetUserPropertyInfo</a></li><li><a href="GetUserValues.html">GetUserValues</a></li><li><a href="InsertToGroup.html">InsertToGroup</a></li><li><a href="InsertToSeries.html">InsertToSeries</a></li><li><a href="ListGroupItems.html">ListGroupItems</a></li><li><a href="ListGroups.html">ListGroups</a></li><li><a href="ListItemBookmarks.html">ListItemBookmarks</a></li><li><a href="ListItemCartAdditions.html">ListItemCartAdditions</a></li><li><a href="ListItemDetailViews.html">ListItemDetailViews</a></li><li><a href="ListItemProperties.html">ListItemProperties</a></li><li><a href="ListItemPurchases.html">ListItemPurchases</a></li><li><a href="ListItemRatings.html">ListItemRatings</a></li><li><a href="ListItems.html">ListItems</a></li><li><a href="ListItemViewPortions.html">ListItemViewPortions</a></li><li><a href="ListSearchSynonyms.html">ListSearchSynonyms</a></li><li><a href="ListSeries.html">ListSeries</a></li><li><a href="ListSeriesItems.html">ListSeriesItems</a></li><li><a href="ListUserBookmarks.html">ListUserBookmarks</a></li><li><a href="ListUserCartAdditions.html">ListUserCartAdditions</a></li><li><a href="ListUserDetailViews.html">ListUserDetailViews</a></li><li><a href="ListUserProperties.html">ListUserProperties</a></li><li><a href="ListUserPurchases.html">ListUserPurchases</a></li><li><a href="ListUserRatings.html">ListUserRatings</a></li><li><a href="ListUsers.html">ListUsers</a></li><li><a href="ListUserViewPortions.html">ListUserViewPortions</a></li><li><a href="MergeUsers.html">MergeUsers</a></li><li><a href="RecommendItemsToItem.html">RecommendItemsToItem</a></li><li><a href="RecommendItemsToUser.html">RecommendItemsToUser</a></li><li><a href="RecommendNextItems.html">RecommendNextItems</a></li><li><a href="RecommendUsersToItem.html">RecommendUsersToItem</a></li><li><a href="RecommendUsersToUser.html">RecommendUsersToUser</a></li><li><a href="RemoveFromGroup.html">RemoveFromGroup</a></li><li><a href="RemoveFromSeries.html">RemoveFromSeries</a></li><li><a href="Request.html">Request</a></li><li><a href="ResetDatabase.html">ResetDatabase</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="SearchItems.html">SearchItems</a></li><li><a href="SetItemValues.html">SetItemValues</a></li><li><a href="SetUserValues.html">SetUserValues</a></li><li><a href="SetValues.html">SetValues</a></li><li><a href="SetViewPortion.html">SetViewPortion</a></li><li><a href="TimeoutError.html">TimeoutError</a></li><li><a href="UpdateMoreItems.html">UpdateMoreItems</a></li></ul>
|
|
110
|
-
</nav>
|
|
111
|
-
|
|
112
|
-
<br class="clear">
|
|
113
|
-
|
|
114
|
-
<footer>
|
|
115
|
-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Mon Apr 25 2022 16:02:57 GMT+0200 (Central European Summer Time)
|
|
116
|
-
</footer>
|
|
117
|
-
|
|
118
|
-
<script> prettyPrint(); </script>
|
|
119
|
-
<script src="scripts/linenumber.js"> </script>
|
|
120
|
-
</body>
|
|
121
|
-
</html>
|
|
@@ -1,91 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="utf-8">
|
|
5
|
-
<title>JSDoc: Source: requests/delete-all-search-synonyms.js</title>
|
|
6
|
-
|
|
7
|
-
<script src="scripts/prettify/prettify.js"> </script>
|
|
8
|
-
<script src="scripts/prettify/lang-css.js"> </script>
|
|
9
|
-
<!--[if lt IE 9]>
|
|
10
|
-
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
11
|
-
<![endif]-->
|
|
12
|
-
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
13
|
-
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
14
|
-
</head>
|
|
15
|
-
|
|
16
|
-
<body>
|
|
17
|
-
|
|
18
|
-
<div id="main">
|
|
19
|
-
|
|
20
|
-
<h1 class="page-title">Source: requests/delete-all-search-synonyms.js</h1>
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
<section>
|
|
28
|
-
<article>
|
|
29
|
-
<pre class="prettyprint source linenums"><code>/*
|
|
30
|
-
This file is auto-generated, do not edit
|
|
31
|
-
*/
|
|
32
|
-
|
|
33
|
-
'use strict';
|
|
34
|
-
const rqs = require("./request");
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* Deletes all synonyms defined in the database.
|
|
38
|
-
*/
|
|
39
|
-
class DeleteAllSearchSynonyms extends rqs.Request {
|
|
40
|
-
|
|
41
|
-
/**
|
|
42
|
-
* Construct the request
|
|
43
|
-
*/
|
|
44
|
-
constructor() {
|
|
45
|
-
super('DELETE', '/synonyms/items/', 10000, false);
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
/**
|
|
49
|
-
* Get body parameters
|
|
50
|
-
* @return {Object} The values of body parameters (name of parameter: value of the parameter)
|
|
51
|
-
*/
|
|
52
|
-
bodyParameters() {
|
|
53
|
-
let params = {};
|
|
54
|
-
|
|
55
|
-
return params;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
/**
|
|
59
|
-
* Get query parameters
|
|
60
|
-
* @return {Object} The values of query parameters (name of parameter: value of the parameter)
|
|
61
|
-
*/
|
|
62
|
-
queryParameters() {
|
|
63
|
-
let params = {};
|
|
64
|
-
return params;
|
|
65
|
-
}
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
exports.DeleteAllSearchSynonyms = DeleteAllSearchSynonyms
|
|
69
|
-
</code></pre>
|
|
70
|
-
</article>
|
|
71
|
-
</section>
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
</div>
|
|
77
|
-
|
|
78
|
-
<nav>
|
|
79
|
-
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddBookmark.html">AddBookmark</a></li><li><a href="AddCartAddition.html">AddCartAddition</a></li><li><a href="AddDetailView.html">AddDetailView</a></li><li><a href="AddGroup.html">AddGroup</a></li><li><a href="AddItem.html">AddItem</a></li><li><a href="AddItemProperty.html">AddItemProperty</a></li><li><a href="AddPurchase.html">AddPurchase</a></li><li><a href="AddRating.html">AddRating</a></li><li><a href="AddSearchSynonym.html">AddSearchSynonym</a></li><li><a href="AddSeries.html">AddSeries</a></li><li><a href="AddUser.html">AddUser</a></li><li><a href="AddUserProperty.html">AddUserProperty</a></li><li><a href="ApiClient.html">ApiClient</a></li><li><a href="ApiError.html">ApiError</a></li><li><a href="Batch.html">Batch</a></li><li><a href="DeleteAllSearchSynonyms.html">DeleteAllSearchSynonyms</a></li><li><a href="DeleteBookmark.html">DeleteBookmark</a></li><li><a href="DeleteCartAddition.html">DeleteCartAddition</a></li><li><a href="DeleteDetailView.html">DeleteDetailView</a></li><li><a href="DeleteGroup.html">DeleteGroup</a></li><li><a href="DeleteItem.html">DeleteItem</a></li><li><a href="DeleteItemProperty.html">DeleteItemProperty</a></li><li><a href="DeleteMoreItems.html">DeleteMoreItems</a></li><li><a href="DeletePurchase.html">DeletePurchase</a></li><li><a href="DeleteRating.html">DeleteRating</a></li><li><a href="DeleteSearchSynonym.html">DeleteSearchSynonym</a></li><li><a href="DeleteSeries.html">DeleteSeries</a></li><li><a href="DeleteUser.html">DeleteUser</a></li><li><a href="DeleteUserProperty.html">DeleteUserProperty</a></li><li><a href="DeleteViewPortion.html">DeleteViewPortion</a></li><li><a href="GetItemPropertyInfo.html">GetItemPropertyInfo</a></li><li><a href="GetItemValues.html">GetItemValues</a></li><li><a href="GetUserPropertyInfo.html">GetUserPropertyInfo</a></li><li><a href="GetUserValues.html">GetUserValues</a></li><li><a href="InsertToGroup.html">InsertToGroup</a></li><li><a href="InsertToSeries.html">InsertToSeries</a></li><li><a href="ListGroupItems.html">ListGroupItems</a></li><li><a href="ListGroups.html">ListGroups</a></li><li><a href="ListItemBookmarks.html">ListItemBookmarks</a></li><li><a href="ListItemCartAdditions.html">ListItemCartAdditions</a></li><li><a href="ListItemDetailViews.html">ListItemDetailViews</a></li><li><a href="ListItemProperties.html">ListItemProperties</a></li><li><a href="ListItemPurchases.html">ListItemPurchases</a></li><li><a href="ListItemRatings.html">ListItemRatings</a></li><li><a href="ListItems.html">ListItems</a></li><li><a href="ListItemViewPortions.html">ListItemViewPortions</a></li><li><a href="ListSearchSynonyms.html">ListSearchSynonyms</a></li><li><a href="ListSeries.html">ListSeries</a></li><li><a href="ListSeriesItems.html">ListSeriesItems</a></li><li><a href="ListUserBookmarks.html">ListUserBookmarks</a></li><li><a href="ListUserCartAdditions.html">ListUserCartAdditions</a></li><li><a href="ListUserDetailViews.html">ListUserDetailViews</a></li><li><a href="ListUserProperties.html">ListUserProperties</a></li><li><a href="ListUserPurchases.html">ListUserPurchases</a></li><li><a href="ListUserRatings.html">ListUserRatings</a></li><li><a href="ListUsers.html">ListUsers</a></li><li><a href="ListUserViewPortions.html">ListUserViewPortions</a></li><li><a href="MergeUsers.html">MergeUsers</a></li><li><a href="RecommendItemsToItem.html">RecommendItemsToItem</a></li><li><a href="RecommendItemsToUser.html">RecommendItemsToUser</a></li><li><a href="RecommendNextItems.html">RecommendNextItems</a></li><li><a href="RecommendUsersToItem.html">RecommendUsersToItem</a></li><li><a href="RecommendUsersToUser.html">RecommendUsersToUser</a></li><li><a href="RemoveFromGroup.html">RemoveFromGroup</a></li><li><a href="RemoveFromSeries.html">RemoveFromSeries</a></li><li><a href="Request.html">Request</a></li><li><a href="ResetDatabase.html">ResetDatabase</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="SearchItems.html">SearchItems</a></li><li><a href="SetItemValues.html">SetItemValues</a></li><li><a href="SetUserValues.html">SetUserValues</a></li><li><a href="SetValues.html">SetValues</a></li><li><a href="SetViewPortion.html">SetViewPortion</a></li><li><a href="TimeoutError.html">TimeoutError</a></li><li><a href="UpdateMoreItems.html">UpdateMoreItems</a></li></ul>
|
|
80
|
-
</nav>
|
|
81
|
-
|
|
82
|
-
<br class="clear">
|
|
83
|
-
|
|
84
|
-
<footer>
|
|
85
|
-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Mon Apr 25 2022 16:02:57 GMT+0200 (Central European Summer Time)
|
|
86
|
-
</footer>
|
|
87
|
-
|
|
88
|
-
<script> prettyPrint(); </script>
|
|
89
|
-
<script src="scripts/linenumber.js"> </script>
|
|
90
|
-
</body>
|
|
91
|
-
</html>
|