recombee-api-client 4.1.0 → 4.1.2

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.
Files changed (198) hide show
  1. package/lib/api-client.js +2 -2
  2. package/lib/index.d.ts +3207 -0
  3. package/lib/requests/add-bookmark.js +2 -2
  4. package/lib/requests/add-cart-addition.js +2 -2
  5. package/lib/requests/add-detail-view.js +2 -2
  6. package/lib/requests/add-purchase.js +2 -2
  7. package/lib/requests/add-rating.js +2 -2
  8. package/lib/requests/delete-more-items.js +1 -1
  9. package/lib/requests/recommend-item-segments-to-item-segment.js +2 -2
  10. package/lib/requests/recommend-item-segments-to-item.js +2 -2
  11. package/lib/requests/recommend-item-segments-to-user.js +2 -2
  12. package/lib/requests/recommend-items-to-item.js +2 -2
  13. package/lib/requests/recommend-items-to-user.js +2 -2
  14. package/lib/requests/recommend-users-to-item.js +2 -2
  15. package/lib/requests/recommend-users-to-user.js +2 -2
  16. package/lib/requests/request.js +0 -1
  17. package/lib/requests/search-item-segments.js +2 -2
  18. package/lib/requests/search-items.js +2 -2
  19. package/lib/requests/set-user-values.js +0 -1
  20. package/lib/requests/set-view-portion.js +2 -2
  21. package/lib/requests/update-more-items.js +2 -2
  22. package/package.json +2 -1
  23. package/doc/AddBookmark.html +0 -506
  24. package/doc/AddCartAddition.html +0 -512
  25. package/doc/AddDetailView.html +0 -509
  26. package/doc/AddGroup.html +0 -447
  27. package/doc/AddItem.html +0 -448
  28. package/doc/AddItemProperty.html +0 -478
  29. package/doc/AddPurchase.html +0 -515
  30. package/doc/AddRating.html +0 -529
  31. package/doc/AddSearchSynonym.html +0 -501
  32. package/doc/AddSeries.html +0 -447
  33. package/doc/AddUser.html +0 -447
  34. package/doc/AddUserProperty.html +0 -476
  35. package/doc/ApiClient.html +0 -433
  36. package/doc/ApiError.html +0 -170
  37. package/doc/Batch.html +0 -476
  38. package/doc/DeleteAllSearchSynonyms.html +0 -398
  39. package/doc/DeleteBookmark.html +0 -497
  40. package/doc/DeleteCartAddition.html +0 -497
  41. package/doc/DeleteDetailView.html +0 -497
  42. package/doc/DeleteGroup.html +0 -448
  43. package/doc/DeleteItem.html +0 -449
  44. package/doc/DeleteItemProperty.html +0 -447
  45. package/doc/DeleteMoreItems.html +0 -448
  46. package/doc/DeletePurchase.html +0 -497
  47. package/doc/DeleteRating.html +0 -497
  48. package/doc/DeleteSearchSynonym.html +0 -447
  49. package/doc/DeleteSeries.html +0 -448
  50. package/doc/DeleteUser.html +0 -448
  51. package/doc/DeleteUserProperty.html +0 -447
  52. package/doc/DeleteViewPortion.html +0 -497
  53. package/doc/GetItemPropertyInfo.html +0 -447
  54. package/doc/GetItemValues.html +0 -447
  55. package/doc/GetUserPropertyInfo.html +0 -447
  56. package/doc/GetUserValues.html +0 -447
  57. package/doc/InsertToGroup.html +0 -520
  58. package/doc/InsertToSeries.html +0 -543
  59. package/doc/ListGroupItems.html +0 -447
  60. package/doc/ListGroups.html +0 -398
  61. package/doc/ListItemBookmarks.html +0 -447
  62. package/doc/ListItemCartAdditions.html +0 -447
  63. package/doc/ListItemDetailViews.html +0 -447
  64. package/doc/ListItemProperties.html +0 -398
  65. package/doc/ListItemPurchases.html +0 -447
  66. package/doc/ListItemRatings.html +0 -447
  67. package/doc/ListItemViewPortions.html +0 -447
  68. package/doc/ListItems.html +0 -497
  69. package/doc/ListSearchSynonyms.html +0 -454
  70. package/doc/ListSeries.html +0 -398
  71. package/doc/ListSeriesItems.html +0 -447
  72. package/doc/ListUserBookmarks.html +0 -447
  73. package/doc/ListUserCartAdditions.html +0 -447
  74. package/doc/ListUserDetailViews.html +0 -447
  75. package/doc/ListUserProperties.html +0 -398
  76. package/doc/ListUserPurchases.html +0 -447
  77. package/doc/ListUserRatings.html +0 -447
  78. package/doc/ListUserViewPortions.html +0 -447
  79. package/doc/ListUsers.html +0 -491
  80. package/doc/MergeUsers.html +0 -498
  81. package/doc/RecommendItemsToItem.html +0 -635
  82. package/doc/RecommendItemsToUser.html +0 -598
  83. package/doc/RecommendNextItems.html +0 -480
  84. package/doc/RecommendUsersToItem.html +0 -579
  85. package/doc/RecommendUsersToUser.html +0 -588
  86. package/doc/RemoveFromGroup.html +0 -493
  87. package/doc/RemoveFromSeries.html +0 -516
  88. package/doc/Request.html +0 -292
  89. package/doc/ResetDatabase.html +0 -398
  90. package/doc/ResponseError.html +0 -269
  91. package/doc/SearchItems.html +0 -610
  92. package/doc/SetItemValues.html +0 -279
  93. package/doc/SetUserValues.html +0 -277
  94. package/doc/SetValues.html +0 -480
  95. package/doc/SetViewPortion.html +0 -533
  96. package/doc/TimeoutError.html +0 -246
  97. package/doc/UpdateMoreItems.html +0 -472
  98. package/doc/api-client.js.html +0 -248
  99. package/doc/errors_api-error.js.html +0 -71
  100. package/doc/errors_response-error.js.html +0 -72
  101. package/doc/errors_timeout-error.js.html +0 -71
  102. package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
  103. package/doc/fonts/OpenSans-Bold-webfont.svg +0 -1830
  104. package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
  105. package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  106. package/doc/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
  107. package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  108. package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
  109. package/doc/fonts/OpenSans-Italic-webfont.svg +0 -1830
  110. package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
  111. package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
  112. package/doc/fonts/OpenSans-Light-webfont.svg +0 -1831
  113. package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
  114. package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  115. package/doc/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
  116. package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  117. package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
  118. package/doc/fonts/OpenSans-Regular-webfont.svg +0 -1831
  119. package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
  120. package/doc/index.html +0 -65
  121. package/doc/requests_add-bookmark.js.html +0 -128
  122. package/doc/requests_add-cart-addition.js.html +0 -142
  123. package/doc/requests_add-detail-view.js.html +0 -135
  124. package/doc/requests_add-group.js.html +0 -93
  125. package/doc/requests_add-item-property.js.html +0 -104
  126. package/doc/requests_add-item.js.html +0 -94
  127. package/doc/requests_add-purchase.js.html +0 -149
  128. package/doc/requests_add-rating.js.html +0 -131
  129. package/doc/requests_add-search-synonym.js.html +0 -111
  130. package/doc/requests_add-series.js.html +0 -93
  131. package/doc/requests_add-user-property.js.html +0 -102
  132. package/doc/requests_add-user.js.html +0 -93
  133. package/doc/requests_batch.js.html +0 -121
  134. package/doc/requests_delete-all-search-synonyms.js.html +0 -91
  135. package/doc/requests_delete-bookmark.js.html +0 -106
  136. package/doc/requests_delete-cart-addition.js.html +0 -106
  137. package/doc/requests_delete-detail-view.js.html +0 -106
  138. package/doc/requests_delete-group.js.html +0 -94
  139. package/doc/requests_delete-item-property.js.html +0 -93
  140. package/doc/requests_delete-item.js.html +0 -95
  141. package/doc/requests_delete-more-items.js.html +0 -95
  142. package/doc/requests_delete-purchase.js.html +0 -106
  143. package/doc/requests_delete-rating.js.html +0 -106
  144. package/doc/requests_delete-search-synonym.js.html +0 -93
  145. package/doc/requests_delete-series.js.html +0 -94
  146. package/doc/requests_delete-user-property.js.html +0 -93
  147. package/doc/requests_delete-user.js.html +0 -94
  148. package/doc/requests_delete-view-portion.js.html +0 -106
  149. package/doc/requests_get-item-property-info.js.html +0 -93
  150. package/doc/requests_get-item-values.js.html +0 -93
  151. package/doc/requests_get-user-property-info.js.html +0 -93
  152. package/doc/requests_get-user-values.js.html +0 -93
  153. package/doc/requests_insert-to-group.js.html +0 -109
  154. package/doc/requests_insert-to-series.js.html +0 -112
  155. package/doc/requests_list-group-items.js.html +0 -93
  156. package/doc/requests_list-groups.js.html +0 -91
  157. package/doc/requests_list-item-bookmarks.js.html +0 -93
  158. package/doc/requests_list-item-cart-additions.js.html +0 -93
  159. package/doc/requests_list-item-detail-views.js.html +0 -93
  160. package/doc/requests_list-item-properties.js.html +0 -91
  161. package/doc/requests_list-item-purchases.js.html +0 -93
  162. package/doc/requests_list-item-ratings.js.html +0 -93
  163. package/doc/requests_list-item-view-portions.js.html +0 -93
  164. package/doc/requests_list-items.js.html +0 -158
  165. package/doc/requests_list-search-synonyms.js.html +0 -106
  166. package/doc/requests_list-series-items.js.html +0 -93
  167. package/doc/requests_list-series.js.html +0 -91
  168. package/doc/requests_list-user-bookmarks.js.html +0 -93
  169. package/doc/requests_list-user-cart-additions.js.html +0 -93
  170. package/doc/requests_list-user-detail-views.js.html +0 -93
  171. package/doc/requests_list-user-properties.js.html +0 -91
  172. package/doc/requests_list-user-purchases.js.html +0 -93
  173. package/doc/requests_list-user-ratings.js.html +0 -93
  174. package/doc/requests_list-user-view-portions.js.html +0 -93
  175. package/doc/requests_list-users.js.html +0 -152
  176. package/doc/requests_merge-users.js.html +0 -105
  177. package/doc/requests_recommend-items-to-item.js.html +0 -276
  178. package/doc/requests_recommend-items-to-user.js.html +0 -255
  179. package/doc/requests_recommend-next-items.js.html +0 -106
  180. package/doc/requests_recommend-users-to-item.js.html +0 -224
  181. package/doc/requests_recommend-users-to-user.js.html +0 -245
  182. package/doc/requests_remove-from-group.js.html +0 -99
  183. package/doc/requests_remove-from-series.js.html +0 -102
  184. package/doc/requests_request.js.html +0 -73
  185. package/doc/requests_reset-database.js.html +0 -91
  186. package/doc/requests_search-items.js.html +0 -231
  187. package/doc/requests_set-item-values.js.html +0 -80
  188. package/doc/requests_set-user-values.js.html +0 -79
  189. package/doc/requests_set-values.js.html +0 -102
  190. package/doc/requests_set-view-portion.js.html +0 -139
  191. package/doc/requests_update-more-items.js.html +0 -104
  192. package/doc/scripts/linenumber.js +0 -25
  193. package/doc/scripts/prettify/Apache-License-2.0.txt +0 -202
  194. package/doc/scripts/prettify/lang-css.js +0 -2
  195. package/doc/scripts/prettify/prettify.js +0 -28
  196. package/doc/styles/jsdoc-default.css +0 -358
  197. package/doc/styles/prettify-jsdoc.css +0 -111
  198. package/doc/styles/prettify-tomorrow.css +0 -132
package/doc/requests_list-user-ratings.js.html DELETED
@@ -1,93 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: requests/list-user-ratings.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/list-user-ratings.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
- * List all the ratings ever submitted by a given user.
38
- */
39
- class ListUserRatings extends rqs.Request {
40
-
41
- /**
42
- * Construct the request
43
- * @param {string} userId - ID of the user whose ratings are to be listed.
44
- */
45
- constructor(userId) {
46
- super('GET', `/users/${userId}/ratings/`, 100000, 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.ListUserRatings = ListUserRatings
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>
package/doc/requests_list-user-view-portions.js.html DELETED
@@ -1,93 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: requests/list-user-view-portions.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/list-user-view-portions.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
- * List all the view portions ever submitted by a given user.
38
- */
39
- class ListUserViewPortions extends rqs.Request {
40
-
41
- /**
42
- * Construct the request
43
- * @param {string} userId - ID of the user whose view portions are to be listed.
44
- */
45
- constructor(userId) {
46
- super('GET', `/users/${userId}/viewportions/`, 100000, 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.ListUserViewPortions = ListUserViewPortions
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>
package/doc/requests_list-users.js.html DELETED
@@ -1,152 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: requests/list-users.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/list-users.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
- * Gets a list of IDs of users currently present in the catalog.
38
- */
39
- class ListUsers extends rqs.Request {
40
-
41
- /**
42
- * Construct the request
43
- * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
44
- * - Allowed parameters:
45
- * - *filter*
46
- * - Type: string
47
- * - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter users to be listed. Only the users for which the expression is *true* will be returned.
48
- * - *count*
49
- * - Type: number
50
- * - Description: The number of users to be listed.
51
- * - *offset*
52
- * - Type: number
53
- * - Description: Specifies the number of users to skip (ordered by `userId`).
54
- * - *returnProperties*
55
- * - Type: boolean
56
- * - Description: With `returnProperties=true`, property values of the listed users are returned along with their IDs in a JSON dictionary.
57
- * Example response:
58
- * ```
59
- * [
60
- * {
61
- * "userId": "user-81",
62
- * "country": "US",
63
- * "sex": "M"
64
- * },
65
- * {
66
- * "userId": "user-314",
67
- * "country": "CAN",
68
- * "sex": "F"
69
- * }
70
- * ]
71
- * ```
72
- * - *includedProperties*
73
- * - Type: string[]
74
- * - Description: Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
75
- * Example response for `includedProperties=country`:
76
- * ```
77
- * [
78
- * {
79
- * "userId": "user-81",
80
- * "country": "US"
81
- * },
82
- * {
83
- * "userId": "user-314",
84
- * "country": "CAN"
85
- * }
86
- * ]
87
- * ```
88
- */
89
- constructor(optional) {
90
- super('GET', '/users/list/', 100000, false);
91
- optional = optional || {};
92
- this.filter = optional.filter;
93
- this.count = optional.count;
94
- this.offset = optional.offset;
95
- this.returnProperties = optional.returnProperties;
96
- this.includedProperties = optional.includedProperties;
97
- }
98
-
99
- /**
100
- * Get body parameters
101
- * @return {Object} The values of body parameters (name of parameter: value of the parameter)
102
- */
103
- bodyParameters() {
104
- let params = {};
105
-
106
- return params;
107
- }
108
-
109
- /**
110
- * Get query parameters
111
- * @return {Object} The values of query parameters (name of parameter: value of the parameter)
112
- */
113
- queryParameters() {
114
- let params = {};
115
- if (this.filter !== undefined)
116
- params.filter = this.filter;
117
- if (this.count !== undefined)
118
- params.count = this.count;
119
- if (this.offset !== undefined)
120
- params.offset = this.offset;
121
- if (this.returnProperties !== undefined)
122
- params.returnProperties = this.returnProperties;
123
- if (this.includedProperties !== undefined)
124
- params.includedProperties = this.includedProperties;
125
- return params;
126
- }
127
- }
128
-
129
- exports.ListUsers = ListUsers
130
- </code></pre>
131
- </article>
132
- </section>
133
-
134
-
135
-
136
-
137
- </div>
138
-
139
- <nav>
140
- <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>
141
- </nav>
142
-
143
- <br class="clear">
144
-
145
- <footer>
146
- 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)
147
- </footer>
148
-
149
- <script> prettyPrint(); </script>
150
- <script src="scripts/linenumber.js"> </script>
151
- </body>
152
- </html>
package/doc/requests_merge-users.js.html DELETED
@@ -1,105 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: requests/merge-users.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/merge-users.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
- * Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable.
38
- * Merging happens between two users referred to as the *target* and the *source*. After the merge, all the interactions of the source user are attributed to the target user, and the source user is **deleted**.
39
- */
40
- class MergeUsers extends rqs.Request {
41
-
42
- /**
43
- * Construct the request
44
- * @param {string} targetUserId - ID of the targer user.
45
- * @param {string} sourceUserId - ID of the source user.
46
- * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
47
- * - Allowed parameters:
48
- * - *cascadeCreate*
49
- * - Type: boolean
50
- * - Description: Sets whether the user *targetUserId* should be created if not present in the database.
51
- */
52
- constructor(targetUserId, sourceUserId, optional) {
53
- super('PUT', `/users/${targetUserId}/merge/${sourceUserId}`, 10000, false);
54
- this.targetUserId = targetUserId;
55
- this.sourceUserId = sourceUserId;
56
- optional = optional || {};
57
- this.cascadeCreate = optional.cascadeCreate;
58
- }
59
-
60
- /**
61
- * Get body parameters
62
- * @return {Object} The values of body parameters (name of parameter: value of the parameter)
63
- */
64
- bodyParameters() {
65
- let params = {};
66
-
67
- return params;
68
- }
69
-
70
- /**
71
- * Get query parameters
72
- * @return {Object} The values of query parameters (name of parameter: value of the parameter)
73
- */
74
- queryParameters() {
75
- let params = {};
76
- if (this.cascadeCreate !== undefined)
77
- params.cascadeCreate = this.cascadeCreate;
78
- return params;
79
- }
80
- }
81
-
82
- exports.MergeUsers = MergeUsers
83
- </code></pre>
84
- </article>
85
- </section>
86
-
87
-
88
-
89
-
90
- </div>
91
-
92
- <nav>
93
- <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>
94
- </nav>
95
-
96
- <br class="clear">
97
-
98
- <footer>
99
- 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)
100
- </footer>
101
-
102
- <script> prettyPrint(); </script>
103
- <script src="scripts/linenumber.js"> </script>
104
- </body>
105
- </html>