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
@@ -6,19 +6,19 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Deletes an existing cart addition uniquely specified by `userId`, `itemId`, and `timestamp` or all the cart additions with given `userId` and `itemId` if `timestamp` is omitted.
9
+ * Deletes an existing cart addition uniquely specified by `userId`, `itemId`, and `timestamp` or all the cart additions with the given `userId` and `itemId` if `timestamp` is omitted.
10
10
  */
11
11
  class DeleteCartAddition extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
15
  * @param {string} userId - ID of the user who made the cart addition.
16
- * @param {string} itemId - ID of the item of which was added to cart.
16
+ * @param {string} itemId - ID of the item which was added to the cart.
17
17
  * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
18
18
  * - Allowed parameters:
19
19
  * - *timestamp*
20
20
  * - Type: number
21
- * - Description: Unix timestamp of the cart addition. If the `timestamp` is omitted, then all the cart additions with given `userId` and `itemId` are deleted.
21
+ * - Description: Unix timestamp of the cart addition. If the `timestamp` is omitted, then all the cart additions with the given `userId` and `itemId` are deleted.
22
22
  */
23
23
  constructor(userId, itemId, optional) {
24
24
  super('DELETE', '/cartadditions/', 1000, false);
@@ -6,19 +6,19 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Deletes an existing detail view uniquely specified by (`userId`, `itemId`, and `timestamp`) or all the detail views with given `userId` and `itemId` if `timestamp` is omitted.
9
+ * Deletes an existing detail view uniquely specified by (`userId`, `itemId`, and `timestamp`) or all the detail views with the given `userId` and `itemId` if `timestamp` is omitted.
10
10
  */
11
11
  class DeleteDetailView extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
15
  * @param {string} userId - ID of the user who made the detail view.
16
- * @param {string} itemId - ID of the item of which the details were viewed.
16
+ * @param {string} itemId - ID of the item whose details were viewed.
17
17
  * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
18
18
  * - Allowed parameters:
19
19
  * - *timestamp*
20
20
  * - Type: number
21
- * - Description: Unix timestamp of the detail view. If the `timestamp` is omitted, then all the detail views with given `userId` and `itemId` are deleted.
21
+ * - Description: Unix timestamp of the detail view. If the `timestamp` is omitted, then all the detail views with the given `userId` and `itemId` are deleted.
22
22
  */
23
23
  constructor(userId, itemId, optional) {
24
24
  super('DELETE', '/detailviews/', 1000, false);
@@ -6,8 +6,8 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Deletes the group of given `groupId` from the database.
10
- * Deleting a group will only delete assignment of items to it, not the items themselves!
9
+ * Deletes the group of the given `groupId` from the database.
10
+ * Deleting a group will only delete the assignment of items to it, not the items themselves!
11
11
  */
12
12
  class DeleteGroup extends rqs.Request {
13
13
 
@@ -6,8 +6,8 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Deletes an item of given `itemId` from the catalog.
10
- * If there are any *purchases*, *ratings*, *bookmarks*, *cart additions* or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
9
+ * Deletes an item of the given `itemId` from the catalog.
10
+ * If there are any *purchases*, *ratings*, *bookmarks*, *cart additions*, or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
11
11
  * If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
12
12
  */
13
13
  class DeleteItem extends rqs.Request {
@@ -0,0 +1,44 @@
1
+ /*
2
+ This file is auto-generated, do not edit
3
+ */
4
+
5
+ 'use strict';
6
+ const rqs = require("./request");
7
+
8
+ /**
9
+ * Delete a Segment from a Manual ReQL Segmentation.
10
+ */
11
+ class DeleteManualReqlSegment extends rqs.Request {
12
+
13
+ /**
14
+ * Construct the request
15
+ * @param {string} segmentationId - ID of the Segmentation from which the Segment should be deleted
16
+ * @param {string} segmentId - ID of the Segment that should be deleted
17
+ */
18
+ constructor(segmentationId, segmentId) {
19
+ super('DELETE', `/segmentations/manual-reql/${segmentationId}/segments/${segmentId}`, 10000, false);
20
+ this.segmentationId = segmentationId;
21
+ this.segmentId = segmentId;
22
+ }
23
+
24
+ /**
25
+ * Get body parameters
26
+ * @return {Object} The values of body parameters (name of parameter: value of the parameter)
27
+ */
28
+ bodyParameters() {
29
+ let params = {};
30
+
31
+ return params;
32
+ }
33
+
34
+ /**
35
+ * Get query parameters
36
+ * @return {Object} The values of query parameters (name of parameter: value of the parameter)
37
+ */
38
+ queryParameters() {
39
+ let params = {};
40
+ return params;
41
+ }
42
+ }
43
+
44
+ exports.DeleteManualReqlSegment = DeleteManualReqlSegment
@@ -6,14 +6,14 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Delete all the items that pass the filter.
10
- * If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
9
+ * Deletes all the items that pass the filter.
10
+ * If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql.html) instead of deleting the item completely.
11
11
  */
12
12
  class DeleteMoreItems extends rqs.Request {
13
13
 
14
14
  /**
15
15
  * Construct the request
16
- * @param {string} filter - A [ReQL](https://docs.recombee.com/reql.html) expression, which return `true` for the items that shall be updated.
16
+ * @param {string} filter - A [ReQL](https://docs.recombee.com/reql.html) expression, which returns `true` for the items that shall be updated.
17
17
  */
18
18
  constructor(filter) {
19
19
  super('DELETE', '/more-items/', 1000, false);
@@ -6,19 +6,19 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Deletes an existing purchase uniquely specified by `userId`, `itemId`, and `timestamp` or all the purchases with given `userId` and `itemId` if `timestamp` is omitted.
9
+ * Deletes an existing purchase uniquely specified by `userId`, `itemId`, and `timestamp` or all the purchases with the given `userId` and `itemId` if `timestamp` is omitted.
10
10
  */
11
11
  class DeletePurchase extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
15
  * @param {string} userId - ID of the user who made the purchase.
16
- * @param {string} itemId - ID of the item of which was purchased.
16
+ * @param {string} itemId - ID of the item which was purchased.
17
17
  * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
18
18
  * - Allowed parameters:
19
19
  * - *timestamp*
20
20
  * - Type: number
21
- * - Description: Unix timestamp of the purchase. If the `timestamp` is omitted, then all the purchases with given `userId` and `itemId` are deleted.
21
+ * - Description: Unix timestamp of the purchase. If the `timestamp` is omitted, then all the purchases with the given `userId` and `itemId` are deleted.
22
22
  */
23
23
  constructor(userId, itemId, optional) {
24
24
  super('DELETE', '/purchases/', 1000, false);
@@ -6,7 +6,7 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Deletes an existing rating specified by (`userId`, `itemId`, `timestamp`) from the database or all the ratings with given `userId` and `itemId` if `timestamp` is omitted.
9
+ * Deletes an existing rating specified by (`userId`, `itemId`, `timestamp`) from the database or all the ratings with the given `userId` and `itemId` if `timestamp` is omitted.
10
10
  */
11
11
  class DeleteRating extends rqs.Request {
12
12
 
@@ -18,7 +18,7 @@ class DeleteRating extends rqs.Request {
18
18
  * - Allowed parameters:
19
19
  * - *timestamp*
20
20
  * - Type: number
21
- * - Description: Unix timestamp of the rating. If the `timestamp` is omitted, then all the ratings with given `userId` and `itemId` are deleted.
21
+ * - Description: Unix timestamp of the rating. If the `timestamp` is omitted, then all the ratings with the given `userId` and `itemId` are deleted.
22
22
  */
23
23
  constructor(userId, itemId, optional) {
24
24
  super('DELETE', '/ratings/', 1000, false);
@@ -6,7 +6,7 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Deletes synonym of given `id` and this synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
9
+ * Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
10
10
  */
11
11
  class DeleteSearchSynonym extends rqs.Request {
12
12
 
@@ -0,0 +1,42 @@
1
+ /*
2
+ This file is auto-generated, do not edit
3
+ */
4
+
5
+ 'use strict';
6
+ const rqs = require("./request");
7
+
8
+ /**
9
+ * Delete existing Segmentation.
10
+ */
11
+ class DeleteSegmentation extends rqs.Request {
12
+
13
+ /**
14
+ * Construct the request
15
+ * @param {string} segmentationId - ID of the Segmentation that should be deleted
16
+ */
17
+ constructor(segmentationId) {
18
+ super('DELETE', `/segmentations/${segmentationId}`, 10000, false);
19
+ this.segmentationId = segmentationId;
20
+ }
21
+
22
+ /**
23
+ * Get body parameters
24
+ * @return {Object} The values of body parameters (name of parameter: value of the parameter)
25
+ */
26
+ bodyParameters() {
27
+ let params = {};
28
+
29
+ return params;
30
+ }
31
+
32
+ /**
33
+ * Get query parameters
34
+ * @return {Object} The values of query parameters (name of parameter: value of the parameter)
35
+ */
36
+ queryParameters() {
37
+ let params = {};
38
+ return params;
39
+ }
40
+ }
41
+
42
+ exports.DeleteSegmentation = DeleteSegmentation
@@ -6,7 +6,7 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Deletes the series of given `seriesId` from the database.
9
+ * Deletes the series of the given `seriesId` from the database.
10
10
  * Deleting a series will only delete assignment of items to it, not the items themselves!
11
11
  */
12
12
  class DeleteSeries extends rqs.Request {
@@ -6,7 +6,7 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Deleting an user property is roughly equivalent to removing a column from the table of users.
9
+ * Deleting a user property is roughly equivalent to removing a column from the table of users.
10
10
  */
11
11
  class DeleteUserProperty extends rqs.Request {
12
12
 
@@ -6,7 +6,7 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Deletes a user of given *userId* from the database.
9
+ * Deletes a user of the given *userId* from the database.
10
10
  * If there are any purchases, ratings, bookmarks, cart additions or detail views made by the user present in the database, they will be deleted in cascade as well.
11
11
  */
12
12
  class DeleteUser extends rqs.Request {
@@ -6,13 +6,13 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Get all the current property values of a given item.
9
+ * Gets all the current property values of the given item.
10
10
  */
11
11
  class GetItemValues extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
- * @param {string} itemId - ID of the item properties of which are to be obtained.
15
+ * @param {string} itemId - ID of the item whose properties are to be obtained.
16
16
  */
17
17
  constructor(itemId) {
18
18
  super('GET', `/items/${itemId}`, 1000, false);
@@ -0,0 +1,42 @@
1
+ /*
2
+ This file is auto-generated, do not edit
3
+ */
4
+
5
+ 'use strict';
6
+ const rqs = require("./request");
7
+
8
+ /**
9
+ * Get existing Segmentation.
10
+ */
11
+ class GetSegmentation extends rqs.Request {
12
+
13
+ /**
14
+ * Construct the request
15
+ * @param {string} segmentationId - ID of the Segmentation that should be returned
16
+ */
17
+ constructor(segmentationId) {
18
+ super('GET', `/segmentations/list/${segmentationId}`, 10000, false);
19
+ this.segmentationId = segmentationId;
20
+ }
21
+
22
+ /**
23
+ * Get body parameters
24
+ * @return {Object} The values of body parameters (name of parameter: value of the parameter)
25
+ */
26
+ bodyParameters() {
27
+ let params = {};
28
+
29
+ return params;
30
+ }
31
+
32
+ /**
33
+ * Get query parameters
34
+ * @return {Object} The values of query parameters (name of parameter: value of the parameter)
35
+ */
36
+ queryParameters() {
37
+ let params = {};
38
+ return params;
39
+ }
40
+ }
41
+
42
+ exports.GetSegmentation = GetSegmentation
@@ -6,13 +6,13 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Get all the current property values of a given user.
9
+ * Gets all the current property values of the given user.
10
10
  */
11
11
  class GetUserValues extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
- * @param {string} userId - ID of the user properties of which are to be obtained.
15
+ * @param {string} userId - ID of the user whose properties are to be obtained.
16
16
  */
17
17
  constructor(userId) {
18
18
  super('GET', `/users/${userId}`, 1000, false);
@@ -65,10 +65,26 @@ exports.RecommendItemsToItem = require("./recommend-items-to-item").RecommendIte
65
65
  exports.RecommendNextItems = require("./recommend-next-items").RecommendNextItems;
66
66
  exports.RecommendUsersToUser = require("./recommend-users-to-user").RecommendUsersToUser;
67
67
  exports.RecommendUsersToItem = require("./recommend-users-to-item").RecommendUsersToItem;
68
+ exports.RecommendItemSegmentsToUser = require("./recommend-item-segments-to-user").RecommendItemSegmentsToUser;
69
+ exports.RecommendItemSegmentsToItem = require("./recommend-item-segments-to-item").RecommendItemSegmentsToItem;
70
+ exports.RecommendItemSegmentsToItemSegment = require("./recommend-item-segments-to-item-segment").RecommendItemSegmentsToItemSegment;
68
71
  exports.SearchItems = require("./search-items").SearchItems;
72
+ exports.SearchItemSegments = require("./search-item-segments").SearchItemSegments;
69
73
  exports.AddSearchSynonym = require("./add-search-synonym").AddSearchSynonym;
70
74
  exports.ListSearchSynonyms = require("./list-search-synonyms").ListSearchSynonyms;
71
75
  exports.DeleteAllSearchSynonyms = require("./delete-all-search-synonyms").DeleteAllSearchSynonyms;
72
76
  exports.DeleteSearchSynonym = require("./delete-search-synonym").DeleteSearchSynonym;
77
+ exports.CreatePropertyBasedSegmentation = require("./create-property-based-segmentation").CreatePropertyBasedSegmentation;
78
+ exports.UpdatePropertyBasedSegmentation = require("./update-property-based-segmentation").UpdatePropertyBasedSegmentation;
79
+ exports.CreateAutoReqlSegmentation = require("./create-auto-reql-segmentation").CreateAutoReqlSegmentation;
80
+ exports.UpdateAutoReqlSegmentation = require("./update-auto-reql-segmentation").UpdateAutoReqlSegmentation;
81
+ exports.CreateManualReqlSegmentation = require("./create-manual-reql-segmentation").CreateManualReqlSegmentation;
82
+ exports.UpdateManualReqlSegmentation = require("./update-manual-reql-segmentation").UpdateManualReqlSegmentation;
83
+ exports.AddManualReqlSegment = require("./add-manual-reql-segment").AddManualReqlSegment;
84
+ exports.UpdateManualReqlSegment = require("./update-manual-reql-segment").UpdateManualReqlSegment;
85
+ exports.DeleteManualReqlSegment = require("./delete-manual-reql-segment").DeleteManualReqlSegment;
86
+ exports.ListSegmentations = require("./list-segmentations").ListSegmentations;
87
+ exports.GetSegmentation = require("./get-segmentation").GetSegmentation;
88
+ exports.DeleteSegmentation = require("./delete-segmentation").DeleteSegmentation;
73
89
  exports.ResetDatabase = require("./reset-database").ResetDatabase;
74
90
  exports.Batch = require("./batch").Batch;
@@ -6,7 +6,7 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Inserts an existing item/group into group of given `groupId`.
9
+ * Inserts an existing item/group into a group of the given `groupId`.
10
10
  */
11
11
  class InsertToGroup extends rqs.Request {
12
12
 
@@ -19,7 +19,7 @@ class InsertToGroup extends rqs.Request {
19
19
  * - Allowed parameters:
20
20
  * - *cascadeCreate*
21
21
  * - Type: boolean
22
- * - Description: Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `groupId` and the `groupId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either items or group may be created if not present in the database.
22
+ * - Description: Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `groupId` and the `groupId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. Either items or group may be created if not present in the database.
23
23
  */
24
24
  constructor(groupId, itemType, itemId, optional) {
25
25
  super('POST', `/groups/${groupId}/items/`, 1000, false);
@@ -6,7 +6,7 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Inserts an existing item/series into series of given seriesId at position determined by time.
9
+ * Inserts an existing item/series into a series of the given seriesId at a position determined by time.
10
10
  */
11
11
  class InsertToSeries extends rqs.Request {
12
12
 
@@ -20,7 +20,7 @@ class InsertToSeries extends rqs.Request {
20
20
  * - Allowed parameters:
21
21
  * - *cascadeCreate*
22
22
  * - Type: boolean
23
- * - Description: Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either item or series may be created if not present in the database.
23
+ * - Description: Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. Either item or series may be created if not present in the database.
24
24
  */
25
25
  constructor(seriesId, itemType, itemId, time, optional) {
26
26
  super('POST', `/series/${seriesId}/items/`, 1000, false);
@@ -12,7 +12,7 @@ class ListGroupItems extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
- * @param {string} groupId - ID of the group items of which are to be listed.
15
+ * @param {string} groupId - ID of the group whose items are to be listed.
16
16
  */
17
17
  constructor(groupId) {
18
18
  super('GET', `/groups/${groupId}/items/`, 100000, false);
@@ -6,13 +6,13 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * List all the ever-made bookmarks of a given item.
9
+ * Lists all the ever-made bookmarks of the given item.
10
10
  */
11
11
  class ListItemBookmarks extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
- * @param {string} itemId - ID of the item of which the bookmarks are to be listed.
15
+ * @param {string} itemId - ID of the item whose bookmarks are to be listed.
16
16
  */
17
17
  constructor(itemId) {
18
18
  super('GET', `/items/${itemId}/bookmarks/`, 100000, false);
@@ -6,13 +6,13 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * List all the ever-made cart addition of a given item.
9
+ * Lists all the ever-made cart additions of the given item.
10
10
  */
11
11
  class ListItemCartAdditions extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
- * @param {string} itemId - ID of the item of which the cart addition are to be listed.
15
+ * @param {string} itemId - ID of the item whose cart additions are to be listed.
16
16
  */
17
17
  constructor(itemId) {
18
18
  super('GET', `/items/${itemId}/cartadditions/`, 100000, false);
@@ -6,13 +6,13 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * List all the detail views of a given item ever made by different users.
9
+ * Lists all the detail views of the given item ever made by different users.
10
10
  */
11
11
  class ListItemDetailViews extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
- * @param {string} itemId - ID of the item of which the detail views are to be listed.
15
+ * @param {string} itemId - ID of the item whose detail views are to be listed.
16
16
  */
17
17
  constructor(itemId) {
18
18
  super('GET', `/items/${itemId}/detailviews/`, 100000, false);
@@ -6,13 +6,13 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * List all the ever-made purchases of a given item.
9
+ * Lists all the ever-made purchases of the given item.
10
10
  */
11
11
  class ListItemPurchases extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
- * @param {string} itemId - ID of the item of which the pucrhases are to be listed.
15
+ * @param {string} itemId - ID of the item whose purchases are to be listed.
16
16
  */
17
17
  constructor(itemId) {
18
18
  super('GET', `/items/${itemId}/purchases/`, 100000, false);
@@ -6,13 +6,13 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * List all the ratings of an item ever submitted by different users.
9
+ * Lists all the ratings of an item ever submitted by different users.
10
10
  */
11
11
  class ListItemRatings extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
- * @param {string} itemId - ID of the item of which the ratings are to be listed.
15
+ * @param {string} itemId - ID of the item whose ratings are to be listed.
16
16
  */
17
17
  constructor(itemId) {
18
18
  super('GET', `/items/${itemId}/ratings/`, 100000, false);
@@ -6,13 +6,13 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * List all the view portions of an item ever submitted by different users.
9
+ * Lists all the view portions of an item ever submitted by different users.
10
10
  */
11
11
  class ListItemViewPortions extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
- * @param {string} itemId - ID of the item of which the view portions are to be listed.
15
+ * @param {string} itemId - ID of the item whose view portions are to be listed.
16
16
  */
17
17
  constructor(itemId) {
18
18
  super('GET', `/items/${itemId}/viewportions/`, 100000, false);
@@ -47,7 +47,7 @@ class ListItems extends rqs.Request {
47
47
  * ```
48
48
  * - *includedProperties*
49
49
  * - Type: string[]
50
- * - Description: Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
50
+ * - Description: Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
51
51
  * Example response for `includedProperties=description,price`:
52
52
  * ```
53
53
  * [
@@ -0,0 +1,43 @@
1
+ /*
2
+ This file is auto-generated, do not edit
3
+ */
4
+
5
+ 'use strict';
6
+ const rqs = require("./request");
7
+
8
+ /**
9
+ * Return all existing items Segmentations.
10
+ */
11
+ class ListSegmentations extends rqs.Request {
12
+
13
+ /**
14
+ * Construct the request
15
+ * @param {string} sourceType - List Segmentations based on a particular type of data. Currently only `items` are supported.
16
+ */
17
+ constructor(sourceType) {
18
+ super('GET', '/segmentations/list/', 10000, false);
19
+ this.sourceType = sourceType;
20
+ }
21
+
22
+ /**
23
+ * Get body parameters
24
+ * @return {Object} The values of body parameters (name of parameter: value of the parameter)
25
+ */
26
+ bodyParameters() {
27
+ let params = {};
28
+
29
+ return params;
30
+ }
31
+
32
+ /**
33
+ * Get query parameters
34
+ * @return {Object} The values of query parameters (name of parameter: value of the parameter)
35
+ */
36
+ queryParameters() {
37
+ let params = {};
38
+ params.sourceType = this.sourceType;
39
+ return params;
40
+ }
41
+ }
42
+
43
+ exports.ListSegmentations = ListSegmentations
@@ -6,13 +6,13 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * List all the items present in the given series, sorted according to their time index values.
9
+ * Lists all the items present in the given series, sorted according to their time index values.
10
10
  */
11
11
  class ListSeriesItems extends rqs.Request {
12
12
 
13
13
  /**
14
14
  * Construct the request
15
- * @param {string} seriesId - ID of the series items of which are to be listed.
15
+ * @param {string} seriesId - ID of the series whose items are to be listed.
16
16
  */
17
17
  constructor(seriesId) {
18
18
  super('GET', `/series/${seriesId}/items/`, 100000, false);
@@ -6,7 +6,7 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * List all the bookmarks ever made by a given user.
9
+ * Lists all the bookmarks ever made by the given user.
10
10
  */
11
11
  class ListUserBookmarks extends rqs.Request {
12
12
 
@@ -6,7 +6,7 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * List all the cart additions ever made by a given user.
9
+ * Lists all the cart additions ever made by the given user.
10
10
  */
11
11
  class ListUserCartAdditions extends rqs.Request {
12
12
 
@@ -6,7 +6,7 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * Lists all the detail views of different items ever made by a given user.
9
+ * Lists all the detail views of different items ever made by the given user.
10
10
  */
11
11
  class ListUserDetailViews extends rqs.Request {
12
12
 
@@ -6,7 +6,7 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * List all the purchases ever made by a given user.
9
+ * Lists all the purchases ever made by the given user.
10
10
  */
11
11
  class ListUserPurchases extends rqs.Request {
12
12
 
@@ -6,7 +6,7 @@
6
6
  const rqs = require("./request");
7
7
 
8
8
  /**
9
- * List all the ratings ever submitted by a given user.
9
+ * Lists all the ratings ever submitted by the given user.
10
10
  */
11
11
  class ListUserRatings extends rqs.Request {
12
12