recombee-api-client 4.0.0 → 4.1.0

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 (295) hide show
  1. package/doc/AddBookmark.html +506 -0
  2. package/doc/AddCartAddition.html +512 -0
  3. package/doc/AddDetailView.html +509 -0
  4. package/doc/AddGroup.html +447 -0
  5. package/doc/AddItem.html +448 -0
  6. package/doc/AddItemProperty.html +478 -0
  7. package/doc/AddPurchase.html +515 -0
  8. package/doc/AddRating.html +529 -0
  9. package/doc/AddSearchSynonym.html +501 -0
  10. package/doc/AddSeries.html +447 -0
  11. package/doc/AddUser.html +447 -0
  12. package/doc/AddUserProperty.html +476 -0
  13. package/doc/ApiClient.html +433 -0
  14. package/doc/ApiError.html +170 -0
  15. package/doc/Batch.html +476 -0
  16. package/doc/DeleteAllSearchSynonyms.html +398 -0
  17. package/doc/DeleteBookmark.html +497 -0
  18. package/doc/DeleteCartAddition.html +497 -0
  19. package/doc/DeleteDetailView.html +497 -0
  20. package/doc/DeleteGroup.html +448 -0
  21. package/doc/DeleteItem.html +449 -0
  22. package/doc/DeleteItemProperty.html +447 -0
  23. package/doc/DeleteMoreItems.html +448 -0
  24. package/doc/DeletePurchase.html +497 -0
  25. package/doc/DeleteRating.html +497 -0
  26. package/doc/DeleteSearchSynonym.html +447 -0
  27. package/doc/DeleteSeries.html +448 -0
  28. package/doc/DeleteUser.html +448 -0
  29. package/doc/DeleteUserProperty.html +447 -0
  30. package/doc/DeleteViewPortion.html +497 -0
  31. package/doc/GetItemPropertyInfo.html +447 -0
  32. package/doc/GetItemValues.html +447 -0
  33. package/doc/GetUserPropertyInfo.html +447 -0
  34. package/doc/GetUserValues.html +447 -0
  35. package/doc/InsertToGroup.html +520 -0
  36. package/doc/InsertToSeries.html +543 -0
  37. package/doc/ListGroupItems.html +447 -0
  38. package/doc/ListGroups.html +398 -0
  39. package/doc/ListItemBookmarks.html +447 -0
  40. package/doc/ListItemCartAdditions.html +447 -0
  41. package/doc/ListItemDetailViews.html +447 -0
  42. package/doc/ListItemProperties.html +398 -0
  43. package/doc/ListItemPurchases.html +447 -0
  44. package/doc/ListItemRatings.html +447 -0
  45. package/doc/ListItemViewPortions.html +447 -0
  46. package/doc/ListItems.html +497 -0
  47. package/doc/ListSearchSynonyms.html +454 -0
  48. package/doc/ListSeries.html +398 -0
  49. package/doc/ListSeriesItems.html +447 -0
  50. package/doc/ListUserBookmarks.html +447 -0
  51. package/doc/ListUserCartAdditions.html +447 -0
  52. package/doc/ListUserDetailViews.html +447 -0
  53. package/doc/ListUserProperties.html +398 -0
  54. package/doc/ListUserPurchases.html +447 -0
  55. package/doc/ListUserRatings.html +447 -0
  56. package/doc/ListUserViewPortions.html +447 -0
  57. package/doc/ListUsers.html +491 -0
  58. package/doc/MergeUsers.html +498 -0
  59. package/doc/RecommendItemsToItem.html +635 -0
  60. package/doc/RecommendItemsToUser.html +598 -0
  61. package/doc/RecommendNextItems.html +480 -0
  62. package/doc/RecommendUsersToItem.html +579 -0
  63. package/doc/RecommendUsersToUser.html +588 -0
  64. package/doc/RemoveFromGroup.html +493 -0
  65. package/doc/RemoveFromSeries.html +516 -0
  66. package/doc/Request.html +292 -0
  67. package/doc/ResetDatabase.html +398 -0
  68. package/doc/ResponseError.html +269 -0
  69. package/doc/SearchItems.html +610 -0
  70. package/doc/SetItemValues.html +279 -0
  71. package/doc/SetUserValues.html +277 -0
  72. package/doc/SetValues.html +480 -0
  73. package/doc/SetViewPortion.html +533 -0
  74. package/doc/TimeoutError.html +246 -0
  75. package/doc/UpdateMoreItems.html +472 -0
  76. package/doc/api-client.js.html +248 -0
  77. package/doc/errors_api-error.js.html +71 -0
  78. package/doc/errors_response-error.js.html +72 -0
  79. package/doc/errors_timeout-error.js.html +71 -0
  80. package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
  81. package/doc/fonts/OpenSans-Bold-webfont.svg +1830 -0
  82. package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
  83. package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  84. package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
  85. package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  86. package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
  87. package/doc/fonts/OpenSans-Italic-webfont.svg +1830 -0
  88. package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
  89. package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
  90. package/doc/fonts/OpenSans-Light-webfont.svg +1831 -0
  91. package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
  92. package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  93. package/doc/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
  94. package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  95. package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
  96. package/doc/fonts/OpenSans-Regular-webfont.svg +1831 -0
  97. package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
  98. package/doc/index.html +65 -0
  99. package/doc/requests_add-bookmark.js.html +128 -0
  100. package/doc/requests_add-cart-addition.js.html +142 -0
  101. package/doc/requests_add-detail-view.js.html +135 -0
  102. package/doc/requests_add-group.js.html +93 -0
  103. package/doc/requests_add-item-property.js.html +104 -0
  104. package/doc/requests_add-item.js.html +94 -0
  105. package/doc/requests_add-purchase.js.html +149 -0
  106. package/doc/requests_add-rating.js.html +131 -0
  107. package/doc/requests_add-search-synonym.js.html +111 -0
  108. package/doc/requests_add-series.js.html +93 -0
  109. package/doc/requests_add-user-property.js.html +102 -0
  110. package/doc/requests_add-user.js.html +93 -0
  111. package/doc/requests_batch.js.html +121 -0
  112. package/doc/requests_delete-all-search-synonyms.js.html +91 -0
  113. package/doc/requests_delete-bookmark.js.html +106 -0
  114. package/doc/requests_delete-cart-addition.js.html +106 -0
  115. package/doc/requests_delete-detail-view.js.html +106 -0
  116. package/doc/requests_delete-group.js.html +94 -0
  117. package/doc/requests_delete-item-property.js.html +93 -0
  118. package/doc/requests_delete-item.js.html +95 -0
  119. package/doc/requests_delete-more-items.js.html +95 -0
  120. package/doc/requests_delete-purchase.js.html +106 -0
  121. package/doc/requests_delete-rating.js.html +106 -0
  122. package/doc/requests_delete-search-synonym.js.html +93 -0
  123. package/doc/requests_delete-series.js.html +94 -0
  124. package/doc/requests_delete-user-property.js.html +93 -0
  125. package/doc/requests_delete-user.js.html +94 -0
  126. package/doc/requests_delete-view-portion.js.html +106 -0
  127. package/doc/requests_get-item-property-info.js.html +93 -0
  128. package/doc/requests_get-item-values.js.html +93 -0
  129. package/doc/requests_get-user-property-info.js.html +93 -0
  130. package/doc/requests_get-user-values.js.html +93 -0
  131. package/doc/requests_insert-to-group.js.html +109 -0
  132. package/doc/requests_insert-to-series.js.html +112 -0
  133. package/doc/requests_list-group-items.js.html +93 -0
  134. package/doc/requests_list-groups.js.html +91 -0
  135. package/doc/requests_list-item-bookmarks.js.html +93 -0
  136. package/doc/requests_list-item-cart-additions.js.html +93 -0
  137. package/doc/requests_list-item-detail-views.js.html +93 -0
  138. package/doc/requests_list-item-properties.js.html +91 -0
  139. package/doc/requests_list-item-purchases.js.html +93 -0
  140. package/doc/requests_list-item-ratings.js.html +93 -0
  141. package/doc/requests_list-item-view-portions.js.html +93 -0
  142. package/doc/requests_list-items.js.html +158 -0
  143. package/doc/requests_list-search-synonyms.js.html +106 -0
  144. package/doc/requests_list-series-items.js.html +93 -0
  145. package/doc/requests_list-series.js.html +91 -0
  146. package/doc/requests_list-user-bookmarks.js.html +93 -0
  147. package/doc/requests_list-user-cart-additions.js.html +93 -0
  148. package/doc/requests_list-user-detail-views.js.html +93 -0
  149. package/doc/requests_list-user-properties.js.html +91 -0
  150. package/doc/requests_list-user-purchases.js.html +93 -0
  151. package/doc/requests_list-user-ratings.js.html +93 -0
  152. package/doc/requests_list-user-view-portions.js.html +93 -0
  153. package/doc/requests_list-users.js.html +152 -0
  154. package/doc/requests_merge-users.js.html +105 -0
  155. package/doc/requests_recommend-items-to-item.js.html +276 -0
  156. package/doc/requests_recommend-items-to-user.js.html +255 -0
  157. package/doc/requests_recommend-next-items.js.html +106 -0
  158. package/doc/requests_recommend-users-to-item.js.html +224 -0
  159. package/doc/requests_recommend-users-to-user.js.html +245 -0
  160. package/doc/requests_remove-from-group.js.html +99 -0
  161. package/doc/requests_remove-from-series.js.html +102 -0
  162. package/doc/requests_request.js.html +73 -0
  163. package/doc/requests_reset-database.js.html +91 -0
  164. package/doc/requests_search-items.js.html +231 -0
  165. package/doc/requests_set-item-values.js.html +80 -0
  166. package/doc/requests_set-user-values.js.html +79 -0
  167. package/doc/requests_set-values.js.html +102 -0
  168. package/doc/requests_set-view-portion.js.html +139 -0
  169. package/doc/requests_update-more-items.js.html +104 -0
  170. package/doc/scripts/linenumber.js +25 -0
  171. package/doc/scripts/prettify/Apache-License-2.0.txt +202 -0
  172. package/doc/scripts/prettify/lang-css.js +2 -0
  173. package/doc/scripts/prettify/prettify.js +28 -0
  174. package/doc/styles/jsdoc-default.css +358 -0
  175. package/doc/styles/prettify-jsdoc.css +111 -0
  176. package/doc/styles/prettify-tomorrow.css +132 -0
  177. package/lib/api-client.js +3 -2
  178. package/lib/requests/add-bookmark.js +1 -1
  179. package/lib/requests/add-cart-addition.js +3 -3
  180. package/lib/requests/add-detail-view.js +1 -1
  181. package/lib/requests/add-group.js +1 -1
  182. package/lib/requests/add-item-property.js +1 -1
  183. package/lib/requests/add-item.js +2 -2
  184. package/lib/requests/add-manual-reql-segment.js +58 -0
  185. package/lib/requests/add-purchase.js +4 -4
  186. package/lib/requests/add-rating.js +1 -1
  187. package/lib/requests/add-series.js +1 -1
  188. package/lib/requests/add-user-property.js +2 -2
  189. package/lib/requests/create-auto-reql-segmentation.js +66 -0
  190. package/lib/requests/create-manual-reql-segmentation.js +63 -0
  191. package/lib/requests/create-property-based-segmentation.js +67 -0
  192. package/lib/requests/delete-bookmark.js +3 -3
  193. package/lib/requests/delete-cart-addition.js +3 -3
  194. package/lib/requests/delete-detail-view.js +3 -3
  195. package/lib/requests/delete-group.js +2 -2
  196. package/lib/requests/delete-item.js +2 -2
  197. package/lib/requests/delete-manual-reql-segment.js +44 -0
  198. package/lib/requests/delete-more-items.js +3 -3
  199. package/lib/requests/delete-purchase.js +3 -3
  200. package/lib/requests/delete-rating.js +2 -2
  201. package/lib/requests/delete-search-synonym.js +1 -1
  202. package/lib/requests/delete-segmentation.js +42 -0
  203. package/lib/requests/delete-series.js +1 -1
  204. package/lib/requests/delete-user-property.js +1 -1
  205. package/lib/requests/delete-user.js +1 -1
  206. package/lib/requests/get-item-values.js +2 -2
  207. package/lib/requests/get-segmentation.js +42 -0
  208. package/lib/requests/get-user-values.js +2 -2
  209. package/lib/requests/index.js +16 -0
  210. package/lib/requests/insert-to-group.js +2 -2
  211. package/lib/requests/insert-to-series.js +2 -2
  212. package/lib/requests/list-group-items.js +1 -1
  213. package/lib/requests/list-item-bookmarks.js +2 -2
  214. package/lib/requests/list-item-cart-additions.js +2 -2
  215. package/lib/requests/list-item-detail-views.js +2 -2
  216. package/lib/requests/list-item-purchases.js +2 -2
  217. package/lib/requests/list-item-ratings.js +2 -2
  218. package/lib/requests/list-item-view-portions.js +2 -2
  219. package/lib/requests/list-items.js +1 -1
  220. package/lib/requests/list-segmentations.js +43 -0
  221. package/lib/requests/list-series-items.js +2 -2
  222. package/lib/requests/list-user-bookmarks.js +1 -1
  223. package/lib/requests/list-user-cart-additions.js +1 -1
  224. package/lib/requests/list-user-detail-views.js +1 -1
  225. package/lib/requests/list-user-purchases.js +1 -1
  226. package/lib/requests/list-user-ratings.js +1 -1
  227. package/lib/requests/list-user-view-portions.js +1 -1
  228. package/lib/requests/list-users.js +1 -1
  229. package/lib/requests/merge-users.js +2 -2
  230. package/lib/requests/recommend-item-segments-to-item-segment.js +125 -0
  231. package/lib/requests/recommend-item-segments-to-item.js +125 -0
  232. package/lib/requests/recommend-item-segments-to-user.js +110 -0
  233. package/lib/requests/recommend-items-to-item.js +26 -26
  234. package/lib/requests/recommend-items-to-user.js +23 -23
  235. package/lib/requests/recommend-next-items.js +2 -2
  236. package/lib/requests/recommend-users-to-item.js +18 -18
  237. package/lib/requests/recommend-users-to-user.js +21 -21
  238. package/lib/requests/reset-database.js +1 -1
  239. package/lib/requests/search-item-segments.js +112 -0
  240. package/lib/requests/search-items.js +17 -17
  241. package/lib/requests/set-view-portion.js +3 -3
  242. package/lib/requests/update-auto-reql-segmentation.js +66 -0
  243. package/lib/requests/update-manual-reql-segment.js +57 -0
  244. package/lib/requests/update-manual-reql-segmentation.js +59 -0
  245. package/lib/requests/update-more-items.js +3 -3
  246. package/lib/requests/update-property-based-segmentation.js +66 -0
  247. package/package.json +1 -1
  248. package/test/add-manual-reql-segment-batch_test.js +40 -0
  249. package/test/add-manual-reql-segment-callback_test.js +43 -0
  250. package/test/add-manual-reql-segment-test.js +35 -0
  251. package/test/create-auto-reql-segmentation-batch_test.js +35 -0
  252. package/test/create-auto-reql-segmentation-callback_test.js +45 -0
  253. package/test/create-auto-reql-segmentation-test.js +43 -0
  254. package/test/create-manual-reql-segmentation-batch_test.js +35 -0
  255. package/test/create-manual-reql-segmentation-callback_test.js +45 -0
  256. package/test/create-manual-reql-segmentation-test.js +43 -0
  257. package/test/create-property-based-segmentation-batch_test.js +35 -0
  258. package/test/create-property-based-segmentation-callback_test.js +45 -0
  259. package/test/create-property-based-segmentation-test.js +43 -0
  260. package/test/delete-manual-reql-segment-batch_test.js +47 -0
  261. package/test/delete-manual-reql-segment-callback_test.js +51 -0
  262. package/test/delete-manual-reql-segment-test.js +39 -0
  263. package/test/delete-segmentation-batch_test.js +42 -0
  264. package/test/delete-segmentation-callback_test.js +53 -0
  265. package/test/delete-segmentation-test.js +47 -0
  266. package/test/get-segmentation-batch_test.js +41 -0
  267. package/test/get-segmentation-callback_test.js +44 -0
  268. package/test/get-segmentation-test.js +36 -0
  269. package/test/list-segmentations-batch_test.js +41 -0
  270. package/test/list-segmentations-callback_test.js +44 -0
  271. package/test/list-segmentations-test.js +36 -0
  272. package/test/recommend-item-segments-to-item-batch_test.js +33 -0
  273. package/test/recommend-item-segments-to-item-callback_test.js +37 -0
  274. package/test/recommend-item-segments-to-item-segment-batch_test.js +33 -0
  275. package/test/recommend-item-segments-to-item-segment-callback_test.js +37 -0
  276. package/test/recommend-item-segments-to-item-segment-test.js +39 -0
  277. package/test/recommend-item-segments-to-item-test.js +39 -0
  278. package/test/recommend-item-segments-to-user-batch_test.js +33 -0
  279. package/test/recommend-item-segments-to-user-callback_test.js +37 -0
  280. package/test/recommend-item-segments-to-user-test.js +39 -0
  281. package/test/search-item-segments-batch_test.js +33 -0
  282. package/test/search-item-segments-callback_test.js +37 -0
  283. package/test/search-item-segments-test.js +39 -0
  284. package/test/update-auto-reql-segmentation-batch_test.js +40 -0
  285. package/test/update-auto-reql-segmentation-callback_test.js +43 -0
  286. package/test/update-auto-reql-segmentation-test.js +35 -0
  287. package/test/update-manual-reql-segment-batch_test.js +47 -0
  288. package/test/update-manual-reql-segment-callback_test.js +51 -0
  289. package/test/update-manual-reql-segment-test.js +39 -0
  290. package/test/update-manual-reql-segmentation-batch_test.js +40 -0
  291. package/test/update-manual-reql-segmentation-callback_test.js +43 -0
  292. package/test/update-manual-reql-segmentation-test.js +35 -0
  293. package/test/update-property-based-segmentation-batch_test.js +40 -0
  294. package/test/update-property-based-segmentation-callback_test.js +43 -0
  295. package/test/update-property-based-segmentation-test.js +35 -0
package/doc/requests_remove-from-group.js.html ADDED
@@ -0,0 +1,99 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Source: requests/remove-from-group.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/remove-from-group.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
+ * Removes an existing group item from the group.
38
+ */
39
+ class RemoveFromGroup extends rqs.Request {
40
+
41
+ /**
42
+ * Construct the request
43
+ * @param {string} groupId - ID of the group from which a group item is to be removed.
44
+ * @param {string} itemType - Type of the item to be removed.
45
+ * @param {string} itemId - ID of the item iff `itemType` is `item`. ID of the group iff `itemType` is `group`.
46
+ */
47
+ constructor(groupId, itemType, itemId) {
48
+ super('DELETE', `/groups/${groupId}/items/`, 1000, false);
49
+ this.groupId = groupId;
50
+ this.itemType = itemType;
51
+ this.itemId = itemId;
52
+ }
53
+
54
+ /**
55
+ * Get body parameters
56
+ * @return {Object} The values of body parameters (name of parameter: value of the parameter)
57
+ */
58
+ bodyParameters() {
59
+ let params = {};
60
+
61
+ return params;
62
+ }
63
+
64
+ /**
65
+ * Get query parameters
66
+ * @return {Object} The values of query parameters (name of parameter: value of the parameter)
67
+ */
68
+ queryParameters() {
69
+ let params = {};
70
+ params.itemType = this.itemType;
71
+ params.itemId = this.itemId;
72
+ return params;
73
+ }
74
+ }
75
+
76
+ exports.RemoveFromGroup = RemoveFromGroup
77
+ </code></pre>
78
+ </article>
79
+ </section>
80
+
81
+
82
+
83
+
84
+ </div>
85
+
86
+ <nav>
87
+ <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>
88
+ </nav>
89
+
90
+ <br class="clear">
91
+
92
+ <footer>
93
+ 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)
94
+ </footer>
95
+
96
+ <script> prettyPrint(); </script>
97
+ <script src="scripts/linenumber.js"> </script>
98
+ </body>
99
+ </html>
package/doc/requests_remove-from-series.js.html ADDED
@@ -0,0 +1,102 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Source: requests/remove-from-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/remove-from-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
+ * Removes an existing series item from the series.
38
+ */
39
+ class RemoveFromSeries extends rqs.Request {
40
+
41
+ /**
42
+ * Construct the request
43
+ * @param {string} seriesId - ID of the series from which a series item is to be removed.
44
+ * @param {string} itemType - Type of the item to be removed.
45
+ * @param {string} itemId - ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.
46
+ * @param {number} time - Time index of the item to be removed.
47
+ */
48
+ constructor(seriesId, itemType, itemId, time) {
49
+ super('DELETE', `/series/${seriesId}/items/`, 1000, false);
50
+ this.seriesId = seriesId;
51
+ this.itemType = itemType;
52
+ this.itemId = itemId;
53
+ this.time = time;
54
+ }
55
+
56
+ /**
57
+ * Get body parameters
58
+ * @return {Object} The values of body parameters (name of parameter: value of the parameter)
59
+ */
60
+ bodyParameters() {
61
+ let params = {};
62
+
63
+ return params;
64
+ }
65
+
66
+ /**
67
+ * Get query parameters
68
+ * @return {Object} The values of query parameters (name of parameter: value of the parameter)
69
+ */
70
+ queryParameters() {
71
+ let params = {};
72
+ params.itemType = this.itemType;
73
+ params.itemId = this.itemId;
74
+ params.time = this.time;
75
+ return params;
76
+ }
77
+ }
78
+
79
+ exports.RemoveFromSeries = RemoveFromSeries
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>
package/doc/requests_request.js.html ADDED
@@ -0,0 +1,73 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Source: requests/request.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/request.js</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+ <article>
29
+ <pre class="prettyprint source linenums"><code>'use strict';
30
+
31
+ /**
32
+ * Base class for all the requests
33
+ */
34
+ class Request {
35
+
36
+ /**
37
+ * Construct the basis of request
38
+ * @param {string} method - GET/PUT/POST/DELETE
39
+ * @param {string} path - Path to the endpoint
40
+ * @param {number} timeout - Timeout in milliseconds
41
+ * @param {boolean} ensureHttps - If true, always use HTTPS
42
+ */
43
+ constructor(method, path, timeout, ensureHttps) {
44
+ this.method = method;
45
+ this.path = path;
46
+ this.timeout = timeout;
47
+ this.ensureHttps = ensureHttps;
48
+ }
49
+ }
50
+
51
+ exports.Request = Request</code></pre>
52
+ </article>
53
+ </section>
54
+
55
+
56
+
57
+
58
+ </div>
59
+
60
+ <nav>
61
+ <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>
62
+ </nav>
63
+
64
+ <br class="clear">
65
+
66
+ <footer>
67
+ 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)
68
+ </footer>
69
+
70
+ <script> prettyPrint(); </script>
71
+ <script src="scripts/linenumber.js"> </script>
72
+ </body>
73
+ </html>
package/doc/requests_reset-database.js.html ADDED
@@ -0,0 +1,91 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Source: requests/reset-database.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/reset-database.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
+ * Completely erases all your data, including items, item properties, series, user database, purchases, ratings, detail views, and bookmarks. Make sure the request to be never executed in production environment! Resetting your database is irreversible.
38
+ */
39
+ class ResetDatabase extends rqs.Request {
40
+
41
+ /**
42
+ * Construct the request
43
+ */
44
+ constructor() {
45
+ super('DELETE', '/', 100000, 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.ResetDatabase = ResetDatabase
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>
package/doc/requests_search-items.js.html ADDED
@@ -0,0 +1,231 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Source: requests/search-items.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/search-items.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
+ * Full-text personalized search. The results are based on the provided `searchQuery` and also on the user's past interactions (purchases, ratings, etc.) with the items (items more suitable for the user are preferred in the results).
38
+ * All the string and set item properties are indexed by the search engine.
39
+ * This endpoint should be used in a search box at your website/app. It can be called multiple times as the user is typing the query in order to get the most viable suggestions based on current state of the query, or once after submitting the whole query.
40
+ * The returned items are sorted by relevance (first item being the most relevant).
41
+ * Besides the recommended items, also a unique `recommId` is returned in the response. It can be used to:
42
+ * - Let Recombee know that this search was successful (e.g. user clicked one of the recommended items). See [Reported metrics](https://docs.recombee.com/admin_ui.html#reported-metrics).
43
+ * - Get subsequent search results when the user scrolls down or goes to the next page. See [Recommend Next Items](https://docs.recombee.com/api.html#recommend-next-items).
44
+ * It is also possible to use POST HTTP method (for example in case of very long ReQL filter) - query parameters then become body parameters.
45
+ */
46
+ class SearchItems extends rqs.Request {
47
+
48
+ /**
49
+ * Construct the request
50
+ * @param {string} userId - ID of the user for whom personalized search will be performed.
51
+ * @param {string} searchQuery - Search query provided by the user. It is used for the full-text search.
52
+ * @param {number} count - Number of items to be returned (N for the top-N results).
53
+ * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
54
+ * - Allowed parameters:
55
+ * - *scenario*
56
+ * - Type: string
57
+ * - Description: Scenario defines a particular search field in your user interface.
58
+ * You can set various settings to the [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com). You can also see performance of each scenario in the Admin UI separately, so you can check how well each field performs.
59
+ * The AI which optimizes models in order to get the best results may optimize different scenarios separately, or even use different models in each of the scenarios.
60
+ * - *cascadeCreate*
61
+ * - Type: boolean
62
+ * - Description: If the user does not exist in the database, returns a list of non-personalized search results and creates the user in the database. This allows for example rotations in the following recommendations for that user, as the user will be already known to the system.
63
+ * - *returnProperties*
64
+ * - Type: boolean
65
+ * - Description: With `returnProperties=true`, property values of the recommended items are returned along with their IDs in a JSON dictionary. The acquired property values can be used for easy displaying of the recommended items to the user.
66
+ * Example response:
67
+ * ```
68
+ * {
69
+ * "recommId": "ce52ada4-e4d9-4885-943c-407db2dee837",
70
+ * "recomms":
71
+ * [
72
+ * {
73
+ * "id": "tv-178",
74
+ * "values": {
75
+ * "description": "4K TV with 3D feature",
76
+ * "categories": ["Electronics", "Televisions"],
77
+ * "price": 342,
78
+ * "url": "myshop.com/tv-178"
79
+ * }
80
+ * },
81
+ * {
82
+ * "id": "mixer-42",
83
+ * "values": {
84
+ * "description": "Stainless Steel Mixer",
85
+ * "categories": ["Home &amp; Kitchen"],
86
+ * "price": 39,
87
+ * "url": "myshop.com/mixer-42"
88
+ * }
89
+ * }
90
+ * ],
91
+ * "numberNextRecommsCalls": 0
92
+ * }
93
+ * ```
94
+ * - *includedProperties*
95
+ * - Type: string[]
96
+ * - Description: Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
97
+ * Example response for `includedProperties=description,price`:
98
+ * ```
99
+ * {
100
+ * "recommId": "a86ee8d5-cd8e-46d1-886c-8b3771d0520b",
101
+ * "recomms":
102
+ * [
103
+ * {
104
+ * "id": "tv-178",
105
+ * "values": {
106
+ * "description": "4K TV with 3D feature",
107
+ * "price": 342
108
+ * }
109
+ * },
110
+ * {
111
+ * "id": "mixer-42",
112
+ * "values": {
113
+ * "description": "Stainless Steel Mixer",
114
+ * "price": 39
115
+ * }
116
+ * }
117
+ * ],
118
+ * "numberNextRecommsCalls": 0
119
+ * }
120
+ * ```
121
+ * - *filter*
122
+ * - Type: string
123
+ * - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to filter recommended items based on the values of their attributes.
124
+ * Filters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
125
+ * - *booster*
126
+ * - Type: string
127
+ * - Description: Number-returning [ReQL](https://docs.recombee.com/reql.html) expression which allows you to boost recommendation rate of some items based on the values of their attributes.
128
+ * Boosters can be also assigned to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
129
+ * - *logic*
130
+ * - Type: string|
131
+ * - Description: Logic specifies particular behavior of the recommendation models. You can pick tailored logic for your domain and use case.
132
+ * See [this section](https://docs.recombee.com/recommendation_logics.html) for list of available logics and other details.
133
+ * The difference between `logic` and `scenario` is that `logic` specifies mainly behavior, while `scenario` specifies the place where recommendations are shown to the users.
134
+ * Logic can be also set to a [scenario](https://docs.recombee.com/scenarios.html) in the [Admin UI](https://admin.recombee.com).
135
+ * - *expertSettings*
136
+ * - Type:
137
+ * - Description: Dictionary of custom options.
138
+ * - *returnAbGroup*
139
+ * - Type: boolean
140
+ * - Description: If there is a custom AB-testing running, return name of group to which the request belongs.
141
+ */
142
+ constructor(userId, searchQuery, count, optional) {
143
+ super('POST', `/search/users/${userId}/items/`, 3000, false);
144
+ this.userId = userId;
145
+ this.searchQuery = searchQuery;
146
+ this.count = count;
147
+ optional = optional || {};
148
+ this.scenario = optional.scenario;
149
+ this.cascadeCreate = optional.cascadeCreate;
150
+ this.returnProperties = optional.returnProperties;
151
+ this.includedProperties = optional.includedProperties;
152
+ this.filter = optional.filter;
153
+ this.booster = optional.booster;
154
+ this.logic = optional.logic;
155
+ this.expertSettings = optional.expertSettings;
156
+ this.returnAbGroup = optional.returnAbGroup;
157
+ }
158
+
159
+ /**
160
+ * Get body parameters
161
+ * @return {Object} The values of body parameters (name of parameter: value of the parameter)
162
+ */
163
+ bodyParameters() {
164
+ let params = {};
165
+ params.searchQuery = this.searchQuery;
166
+ params.count = this.count;
167
+
168
+ if(this.scenario !== undefined)
169
+ params.scenario = this.scenario;
170
+
171
+ if(this.cascadeCreate !== undefined)
172
+ params.cascadeCreate = this.cascadeCreate;
173
+
174
+ if(this.returnProperties !== undefined)
175
+ params.returnProperties = this.returnProperties;
176
+
177
+ if(this.includedProperties !== undefined)
178
+ params.includedProperties = this.includedProperties;
179
+
180
+ if(this.filter !== undefined)
181
+ params.filter = this.filter;
182
+
183
+ if(this.booster !== undefined)
184
+ params.booster = this.booster;
185
+
186
+ if(this.logic !== undefined)
187
+ params.logic = this.logic;
188
+
189
+ if(this.expertSettings !== undefined)
190
+ params.expertSettings = this.expertSettings;
191
+
192
+ if(this.returnAbGroup !== undefined)
193
+ params.returnAbGroup = this.returnAbGroup;
194
+
195
+ return params;
196
+ }
197
+
198
+ /**
199
+ * Get query parameters
200
+ * @return {Object} The values of query parameters (name of parameter: value of the parameter)
201
+ */
202
+ queryParameters() {
203
+ let params = {};
204
+ return params;
205
+ }
206
+ }
207
+
208
+ exports.SearchItems = SearchItems
209
+ </code></pre>
210
+ </article>
211
+ </section>
212
+
213
+
214
+
215
+
216
+ </div>
217
+
218
+ <nav>
219
+ <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>
220
+ </nav>
221
+
222
+ <br class="clear">
223
+
224
+ <footer>
225
+ 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)
226
+ </footer>
227
+
228
+ <script> prettyPrint(); </script>
229
+ <script src="scripts/linenumber.js"> </script>
230
+ </body>
231
+ </html>