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/index.html ADDED
@@ -0,0 +1,65 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Home</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">Home</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+
28
+
29
+ <h3> </h3>
30
+
31
+
32
+
33
+
34
+
35
+
36
+
37
+
38
+
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+
47
+
48
+
49
+
50
+ </div>
51
+
52
+ <nav>
53
+ <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>
54
+ </nav>
55
+
56
+ <br class="clear">
57
+
58
+ <footer>
59
+ 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)
60
+ </footer>
61
+
62
+ <script> prettyPrint(); </script>
63
+ <script src="scripts/linenumber.js"> </script>
64
+ </body>
65
+ </html>
package/doc/requests_add-bookmark.js.html ADDED
@@ -0,0 +1,128 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Source: requests/add-bookmark.js</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"> </script>
8
+ <script src="scripts/prettify/lang-css.js"> </script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ </head>
15
+
16
+ <body>
17
+
18
+ <div id="main">
19
+
20
+ <h1 class="page-title">Source: requests/add-bookmark.js</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+ <article>
29
+ <pre class="prettyprint source linenums"><code>/*
30
+ This file is auto-generated, do not edit
31
+ */
32
+
33
+ 'use strict';
34
+ const rqs = require("./request");
35
+
36
+ /**
37
+ * Adds a bookmark of a given item made by a given user.
38
+ */
39
+ class AddBookmark extends rqs.Request {
40
+
41
+ /**
42
+ * Construct the request
43
+ * @param {string} userId - User who bookmarked the item
44
+ * @param {string} itemId - Bookmarked item
45
+ * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
46
+ * - Allowed parameters:
47
+ * - *timestamp*
48
+ * - Type: string|number
49
+ * - Description: UTC timestamp of the bookmark as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
50
+ * - *cascadeCreate*
51
+ * - Type: boolean
52
+ * - Description: Sets whether the given user/item should be created if not present in the database.
53
+ * - *recommId*
54
+ * - Type: string
55
+ * - Description: If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
56
+ * - *additionalData*
57
+ * - Type:
58
+ * - Description: A dictionary of additional data for the interaction.
59
+ */
60
+ constructor(userId, itemId, optional) {
61
+ super('POST', '/bookmarks/', 1000, false);
62
+ this.userId = userId;
63
+ this.itemId = itemId;
64
+ optional = optional || {};
65
+ this.timestamp = optional.timestamp;
66
+ this.cascadeCreate = optional.cascadeCreate;
67
+ this.recommId = optional.recommId;
68
+ this.additionalData = optional.additionalData;
69
+ }
70
+
71
+ /**
72
+ * Get body parameters
73
+ * @return {Object} The values of body parameters (name of parameter: value of the parameter)
74
+ */
75
+ bodyParameters() {
76
+ let params = {};
77
+ params.userId = this.userId;
78
+ params.itemId = this.itemId;
79
+
80
+ if(this.timestamp !== undefined)
81
+ params.timestamp = this.timestamp;
82
+
83
+ if(this.cascadeCreate !== undefined)
84
+ params.cascadeCreate = this.cascadeCreate;
85
+
86
+ if(this.recommId !== undefined)
87
+ params.recommId = this.recommId;
88
+
89
+ if(this.additionalData !== undefined)
90
+ params.additionalData = this.additionalData;
91
+
92
+ return params;
93
+ }
94
+
95
+ /**
96
+ * Get query parameters
97
+ * @return {Object} The values of query parameters (name of parameter: value of the parameter)
98
+ */
99
+ queryParameters() {
100
+ let params = {};
101
+ return params;
102
+ }
103
+ }
104
+
105
+ exports.AddBookmark = AddBookmark
106
+ </code></pre>
107
+ </article>
108
+ </section>
109
+
110
+
111
+
112
+
113
+ </div>
114
+
115
+ <nav>
116
+ <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>
117
+ </nav>
118
+
119
+ <br class="clear">
120
+
121
+ <footer>
122
+ 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)
123
+ </footer>
124
+
125
+ <script> prettyPrint(); </script>
126
+ <script src="scripts/linenumber.js"> </script>
127
+ </body>
128
+ </html>
package/doc/requests_add-cart-addition.js.html ADDED
@@ -0,0 +1,142 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Source: requests/add-cart-addition.js</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"> </script>
8
+ <script src="scripts/prettify/lang-css.js"> </script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ </head>
15
+
16
+ <body>
17
+
18
+ <div id="main">
19
+
20
+ <h1 class="page-title">Source: requests/add-cart-addition.js</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+ <article>
29
+ <pre class="prettyprint source linenums"><code>/*
30
+ This file is auto-generated, do not edit
31
+ */
32
+
33
+ 'use strict';
34
+ const rqs = require("./request");
35
+
36
+ /**
37
+ * Adds a cart addition of a given item made by a given user.
38
+ */
39
+ class AddCartAddition extends rqs.Request {
40
+
41
+ /**
42
+ * Construct the request
43
+ * @param {string} userId - User who added the item to the cart
44
+ * @param {string} itemId - Item added to the cart
45
+ * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
46
+ * - Allowed parameters:
47
+ * - *timestamp*
48
+ * - Type: string|number
49
+ * - Description: UTC timestamp of the cart addition as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
50
+ * - *cascadeCreate*
51
+ * - Type: boolean
52
+ * - Description: Sets whether the given user/item should be created if not present in the database.
53
+ * - *amount*
54
+ * - Type: number
55
+ * - Description: Amount (number) added to cart. The default is 1. For example if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal to 2.
56
+ * - *price*
57
+ * - Type: number
58
+ * - Description: Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.
59
+ * - *recommId*
60
+ * - Type: string
61
+ * - Description: If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.
62
+ * - *additionalData*
63
+ * - Type:
64
+ * - Description: A dictionary of additional data for the interaction.
65
+ */
66
+ constructor(userId, itemId, optional) {
67
+ super('POST', '/cartadditions/', 1000, false);
68
+ this.userId = userId;
69
+ this.itemId = itemId;
70
+ optional = optional || {};
71
+ this.timestamp = optional.timestamp;
72
+ this.cascadeCreate = optional.cascadeCreate;
73
+ this.amount = optional.amount;
74
+ this.price = optional.price;
75
+ this.recommId = optional.recommId;
76
+ this.additionalData = optional.additionalData;
77
+ }
78
+
79
+ /**
80
+ * Get body parameters
81
+ * @return {Object} The values of body parameters (name of parameter: value of the parameter)
82
+ */
83
+ bodyParameters() {
84
+ let params = {};
85
+ params.userId = this.userId;
86
+ params.itemId = this.itemId;
87
+
88
+ if(this.timestamp !== undefined)
89
+ params.timestamp = this.timestamp;
90
+
91
+ if(this.cascadeCreate !== undefined)
92
+ params.cascadeCreate = this.cascadeCreate;
93
+
94
+ if(this.amount !== undefined)
95
+ params.amount = this.amount;
96
+
97
+ if(this.price !== undefined)
98
+ params.price = this.price;
99
+
100
+ if(this.recommId !== undefined)
101
+ params.recommId = this.recommId;
102
+
103
+ if(this.additionalData !== undefined)
104
+ params.additionalData = this.additionalData;
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
+ return params;
116
+ }
117
+ }
118
+
119
+ exports.AddCartAddition = AddCartAddition
120
+ </code></pre>
121
+ </article>
122
+ </section>
123
+
124
+
125
+
126
+
127
+ </div>
128
+
129
+ <nav>
130
+ <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>
131
+ </nav>
132
+
133
+ <br class="clear">
134
+
135
+ <footer>
136
+ 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)
137
+ </footer>
138
+
139
+ <script> prettyPrint(); </script>
140
+ <script src="scripts/linenumber.js"> </script>
141
+ </body>
142
+ </html>
package/doc/requests_add-detail-view.js.html ADDED
@@ -0,0 +1,135 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Source: requests/add-detail-view.js</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"> </script>
8
+ <script src="scripts/prettify/lang-css.js"> </script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ </head>
15
+
16
+ <body>
17
+
18
+ <div id="main">
19
+
20
+ <h1 class="page-title">Source: requests/add-detail-view.js</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+ <article>
29
+ <pre class="prettyprint source linenums"><code>/*
30
+ This file is auto-generated, do not edit
31
+ */
32
+
33
+ 'use strict';
34
+ const rqs = require("./request");
35
+
36
+ /**
37
+ * Adds a detail view of a given item made by a given user.
38
+ */
39
+ class AddDetailView extends rqs.Request {
40
+
41
+ /**
42
+ * Construct the request
43
+ * @param {string} userId - User who viewed the item
44
+ * @param {string} itemId - Viewed item
45
+ * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
46
+ * - Allowed parameters:
47
+ * - *timestamp*
48
+ * - Type: string|number
49
+ * - Description: UTC timestamp of the view as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
50
+ * - *duration*
51
+ * - Type: number
52
+ * - Description: Duration of the view
53
+ * - *cascadeCreate*
54
+ * - Type: boolean
55
+ * - Description: Sets whether the given user/item should be created if not present in the database.
56
+ * - *recommId*
57
+ * - Type: string
58
+ * - Description: If this detail view is based on a recommendation request, `recommId` is the id of the clicked recommendation.
59
+ * - *additionalData*
60
+ * - Type:
61
+ * - Description: A dictionary of additional data for the interaction.
62
+ */
63
+ constructor(userId, itemId, optional) {
64
+ super('POST', '/detailviews/', 1000, false);
65
+ this.userId = userId;
66
+ this.itemId = itemId;
67
+ optional = optional || {};
68
+ this.timestamp = optional.timestamp;
69
+ this.duration = optional.duration;
70
+ this.cascadeCreate = optional.cascadeCreate;
71
+ this.recommId = optional.recommId;
72
+ this.additionalData = optional.additionalData;
73
+ }
74
+
75
+ /**
76
+ * Get body parameters
77
+ * @return {Object} The values of body parameters (name of parameter: value of the parameter)
78
+ */
79
+ bodyParameters() {
80
+ let params = {};
81
+ params.userId = this.userId;
82
+ params.itemId = this.itemId;
83
+
84
+ if(this.timestamp !== undefined)
85
+ params.timestamp = this.timestamp;
86
+
87
+ if(this.duration !== undefined)
88
+ params.duration = this.duration;
89
+
90
+ if(this.cascadeCreate !== undefined)
91
+ params.cascadeCreate = this.cascadeCreate;
92
+
93
+ if(this.recommId !== undefined)
94
+ params.recommId = this.recommId;
95
+
96
+ if(this.additionalData !== undefined)
97
+ params.additionalData = this.additionalData;
98
+
99
+ return params;
100
+ }
101
+
102
+ /**
103
+ * Get query parameters
104
+ * @return {Object} The values of query parameters (name of parameter: value of the parameter)
105
+ */
106
+ queryParameters() {
107
+ let params = {};
108
+ return params;
109
+ }
110
+ }
111
+
112
+ exports.AddDetailView = AddDetailView
113
+ </code></pre>
114
+ </article>
115
+ </section>
116
+
117
+
118
+
119
+
120
+ </div>
121
+
122
+ <nav>
123
+ <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>
124
+ </nav>
125
+
126
+ <br class="clear">
127
+
128
+ <footer>
129
+ 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)
130
+ </footer>
131
+
132
+ <script> prettyPrint(); </script>
133
+ <script src="scripts/linenumber.js"> </script>
134
+ </body>
135
+ </html>
package/doc/requests_add-group.js.html ADDED
@@ -0,0 +1,93 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Source: requests/add-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/add-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
+ * Creates new group in the database.
38
+ */
39
+ class AddGroup extends rqs.Request {
40
+
41
+ /**
42
+ * Construct the request
43
+ * @param {string} groupId - ID of the group to be created.
44
+ */
45
+ constructor(groupId) {
46
+ super('PUT', `/groups/${groupId}`, 1000, false);
47
+ this.groupId = groupId;
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.AddGroup = AddGroup
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>