recombee-api-client 4.1.0 → 4.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (198) hide show
  1. package/lib/api-client.js +2 -2
  2. package/lib/index.d.ts +3207 -0
  3. package/lib/requests/add-bookmark.js +2 -2
  4. package/lib/requests/add-cart-addition.js +2 -2
  5. package/lib/requests/add-detail-view.js +2 -2
  6. package/lib/requests/add-purchase.js +2 -2
  7. package/lib/requests/add-rating.js +2 -2
  8. package/lib/requests/delete-more-items.js +1 -1
  9. package/lib/requests/recommend-item-segments-to-item-segment.js +2 -2
  10. package/lib/requests/recommend-item-segments-to-item.js +2 -2
  11. package/lib/requests/recommend-item-segments-to-user.js +2 -2
  12. package/lib/requests/recommend-items-to-item.js +2 -2
  13. package/lib/requests/recommend-items-to-user.js +2 -2
  14. package/lib/requests/recommend-users-to-item.js +2 -2
  15. package/lib/requests/recommend-users-to-user.js +2 -2
  16. package/lib/requests/request.js +0 -1
  17. package/lib/requests/search-item-segments.js +2 -2
  18. package/lib/requests/search-items.js +2 -2
  19. package/lib/requests/set-user-values.js +0 -1
  20. package/lib/requests/set-view-portion.js +2 -2
  21. package/lib/requests/update-more-items.js +2 -2
  22. package/package.json +2 -1
  23. package/doc/AddBookmark.html +0 -506
  24. package/doc/AddCartAddition.html +0 -512
  25. package/doc/AddDetailView.html +0 -509
  26. package/doc/AddGroup.html +0 -447
  27. package/doc/AddItem.html +0 -448
  28. package/doc/AddItemProperty.html +0 -478
  29. package/doc/AddPurchase.html +0 -515
  30. package/doc/AddRating.html +0 -529
  31. package/doc/AddSearchSynonym.html +0 -501
  32. package/doc/AddSeries.html +0 -447
  33. package/doc/AddUser.html +0 -447
  34. package/doc/AddUserProperty.html +0 -476
  35. package/doc/ApiClient.html +0 -433
  36. package/doc/ApiError.html +0 -170
  37. package/doc/Batch.html +0 -476
  38. package/doc/DeleteAllSearchSynonyms.html +0 -398
  39. package/doc/DeleteBookmark.html +0 -497
  40. package/doc/DeleteCartAddition.html +0 -497
  41. package/doc/DeleteDetailView.html +0 -497
  42. package/doc/DeleteGroup.html +0 -448
  43. package/doc/DeleteItem.html +0 -449
  44. package/doc/DeleteItemProperty.html +0 -447
  45. package/doc/DeleteMoreItems.html +0 -448
  46. package/doc/DeletePurchase.html +0 -497
  47. package/doc/DeleteRating.html +0 -497
  48. package/doc/DeleteSearchSynonym.html +0 -447
  49. package/doc/DeleteSeries.html +0 -448
  50. package/doc/DeleteUser.html +0 -448
  51. package/doc/DeleteUserProperty.html +0 -447
  52. package/doc/DeleteViewPortion.html +0 -497
  53. package/doc/GetItemPropertyInfo.html +0 -447
  54. package/doc/GetItemValues.html +0 -447
  55. package/doc/GetUserPropertyInfo.html +0 -447
  56. package/doc/GetUserValues.html +0 -447
  57. package/doc/InsertToGroup.html +0 -520
  58. package/doc/InsertToSeries.html +0 -543
  59. package/doc/ListGroupItems.html +0 -447
  60. package/doc/ListGroups.html +0 -398
  61. package/doc/ListItemBookmarks.html +0 -447
  62. package/doc/ListItemCartAdditions.html +0 -447
  63. package/doc/ListItemDetailViews.html +0 -447
  64. package/doc/ListItemProperties.html +0 -398
  65. package/doc/ListItemPurchases.html +0 -447
  66. package/doc/ListItemRatings.html +0 -447
  67. package/doc/ListItemViewPortions.html +0 -447
  68. package/doc/ListItems.html +0 -497
  69. package/doc/ListSearchSynonyms.html +0 -454
  70. package/doc/ListSeries.html +0 -398
  71. package/doc/ListSeriesItems.html +0 -447
  72. package/doc/ListUserBookmarks.html +0 -447
  73. package/doc/ListUserCartAdditions.html +0 -447
  74. package/doc/ListUserDetailViews.html +0 -447
  75. package/doc/ListUserProperties.html +0 -398
  76. package/doc/ListUserPurchases.html +0 -447
  77. package/doc/ListUserRatings.html +0 -447
  78. package/doc/ListUserViewPortions.html +0 -447
  79. package/doc/ListUsers.html +0 -491
  80. package/doc/MergeUsers.html +0 -498
  81. package/doc/RecommendItemsToItem.html +0 -635
  82. package/doc/RecommendItemsToUser.html +0 -598
  83. package/doc/RecommendNextItems.html +0 -480
  84. package/doc/RecommendUsersToItem.html +0 -579
  85. package/doc/RecommendUsersToUser.html +0 -588
  86. package/doc/RemoveFromGroup.html +0 -493
  87. package/doc/RemoveFromSeries.html +0 -516
  88. package/doc/Request.html +0 -292
  89. package/doc/ResetDatabase.html +0 -398
  90. package/doc/ResponseError.html +0 -269
  91. package/doc/SearchItems.html +0 -610
  92. package/doc/SetItemValues.html +0 -279
  93. package/doc/SetUserValues.html +0 -277
  94. package/doc/SetValues.html +0 -480
  95. package/doc/SetViewPortion.html +0 -533
  96. package/doc/TimeoutError.html +0 -246
  97. package/doc/UpdateMoreItems.html +0 -472
  98. package/doc/api-client.js.html +0 -248
  99. package/doc/errors_api-error.js.html +0 -71
  100. package/doc/errors_response-error.js.html +0 -72
  101. package/doc/errors_timeout-error.js.html +0 -71
  102. package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
  103. package/doc/fonts/OpenSans-Bold-webfont.svg +0 -1830
  104. package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
  105. package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  106. package/doc/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
  107. package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  108. package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
  109. package/doc/fonts/OpenSans-Italic-webfont.svg +0 -1830
  110. package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
  111. package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
  112. package/doc/fonts/OpenSans-Light-webfont.svg +0 -1831
  113. package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
  114. package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  115. package/doc/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
  116. package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  117. package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
  118. package/doc/fonts/OpenSans-Regular-webfont.svg +0 -1831
  119. package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
  120. package/doc/index.html +0 -65
  121. package/doc/requests_add-bookmark.js.html +0 -128
  122. package/doc/requests_add-cart-addition.js.html +0 -142
  123. package/doc/requests_add-detail-view.js.html +0 -135
  124. package/doc/requests_add-group.js.html +0 -93
  125. package/doc/requests_add-item-property.js.html +0 -104
  126. package/doc/requests_add-item.js.html +0 -94
  127. package/doc/requests_add-purchase.js.html +0 -149
  128. package/doc/requests_add-rating.js.html +0 -131
  129. package/doc/requests_add-search-synonym.js.html +0 -111
  130. package/doc/requests_add-series.js.html +0 -93
  131. package/doc/requests_add-user-property.js.html +0 -102
  132. package/doc/requests_add-user.js.html +0 -93
  133. package/doc/requests_batch.js.html +0 -121
  134. package/doc/requests_delete-all-search-synonyms.js.html +0 -91
  135. package/doc/requests_delete-bookmark.js.html +0 -106
  136. package/doc/requests_delete-cart-addition.js.html +0 -106
  137. package/doc/requests_delete-detail-view.js.html +0 -106
  138. package/doc/requests_delete-group.js.html +0 -94
  139. package/doc/requests_delete-item-property.js.html +0 -93
  140. package/doc/requests_delete-item.js.html +0 -95
  141. package/doc/requests_delete-more-items.js.html +0 -95
  142. package/doc/requests_delete-purchase.js.html +0 -106
  143. package/doc/requests_delete-rating.js.html +0 -106
  144. package/doc/requests_delete-search-synonym.js.html +0 -93
  145. package/doc/requests_delete-series.js.html +0 -94
  146. package/doc/requests_delete-user-property.js.html +0 -93
  147. package/doc/requests_delete-user.js.html +0 -94
  148. package/doc/requests_delete-view-portion.js.html +0 -106
  149. package/doc/requests_get-item-property-info.js.html +0 -93
  150. package/doc/requests_get-item-values.js.html +0 -93
  151. package/doc/requests_get-user-property-info.js.html +0 -93
  152. package/doc/requests_get-user-values.js.html +0 -93
  153. package/doc/requests_insert-to-group.js.html +0 -109
  154. package/doc/requests_insert-to-series.js.html +0 -112
  155. package/doc/requests_list-group-items.js.html +0 -93
  156. package/doc/requests_list-groups.js.html +0 -91
  157. package/doc/requests_list-item-bookmarks.js.html +0 -93
  158. package/doc/requests_list-item-cart-additions.js.html +0 -93
  159. package/doc/requests_list-item-detail-views.js.html +0 -93
  160. package/doc/requests_list-item-properties.js.html +0 -91
  161. package/doc/requests_list-item-purchases.js.html +0 -93
  162. package/doc/requests_list-item-ratings.js.html +0 -93
  163. package/doc/requests_list-item-view-portions.js.html +0 -93
  164. package/doc/requests_list-items.js.html +0 -158
  165. package/doc/requests_list-search-synonyms.js.html +0 -106
  166. package/doc/requests_list-series-items.js.html +0 -93
  167. package/doc/requests_list-series.js.html +0 -91
  168. package/doc/requests_list-user-bookmarks.js.html +0 -93
  169. package/doc/requests_list-user-cart-additions.js.html +0 -93
  170. package/doc/requests_list-user-detail-views.js.html +0 -93
  171. package/doc/requests_list-user-properties.js.html +0 -91
  172. package/doc/requests_list-user-purchases.js.html +0 -93
  173. package/doc/requests_list-user-ratings.js.html +0 -93
  174. package/doc/requests_list-user-view-portions.js.html +0 -93
  175. package/doc/requests_list-users.js.html +0 -152
  176. package/doc/requests_merge-users.js.html +0 -105
  177. package/doc/requests_recommend-items-to-item.js.html +0 -276
  178. package/doc/requests_recommend-items-to-user.js.html +0 -255
  179. package/doc/requests_recommend-next-items.js.html +0 -106
  180. package/doc/requests_recommend-users-to-item.js.html +0 -224
  181. package/doc/requests_recommend-users-to-user.js.html +0 -245
  182. package/doc/requests_remove-from-group.js.html +0 -99
  183. package/doc/requests_remove-from-series.js.html +0 -102
  184. package/doc/requests_request.js.html +0 -73
  185. package/doc/requests_reset-database.js.html +0 -91
  186. package/doc/requests_search-items.js.html +0 -231
  187. package/doc/requests_set-item-values.js.html +0 -80
  188. package/doc/requests_set-user-values.js.html +0 -79
  189. package/doc/requests_set-values.js.html +0 -102
  190. package/doc/requests_set-view-portion.js.html +0 -139
  191. package/doc/requests_update-more-items.js.html +0 -104
  192. package/doc/scripts/linenumber.js +0 -25
  193. package/doc/scripts/prettify/Apache-License-2.0.txt +0 -202
  194. package/doc/scripts/prettify/lang-css.js +0 -2
  195. package/doc/scripts/prettify/prettify.js +0 -28
  196. package/doc/styles/jsdoc-default.css +0 -358
  197. package/doc/styles/prettify-jsdoc.css +0 -111
  198. package/doc/styles/prettify-tomorrow.css +0 -132
package/doc/requests_add-item-property.js.html DELETED
@@ -1,104 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: requests/add-item-property.js</title>
6
-
7
- <script src="scripts/prettify/prettify.js"> </script>
8
- <script src="scripts/prettify/lang-css.js"> </script>
9
- <!--[if lt IE 9]>
10
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
- <![endif]-->
12
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
- </head>
15
-
16
- <body>
17
-
18
- <div id="main">
19
-
20
- <h1 class="page-title">Source: requests/add-item-property.js</h1>
21
-
22
-
23
-
24
-
25
-
26
-
27
- <section>
28
- <article>
29
- <pre class="prettyprint source linenums"><code>/*
30
- This file is auto-generated, do not edit
31
- */
32
-
33
- 'use strict';
34
- const rqs = require("./request");
35
-
36
- /**
37
- * Adding an item property is somehow equivalent to adding a column to the table of items. The items may be characterized by various properties of different types.
38
- */
39
- class AddItemProperty extends rqs.Request {
40
-
41
- /**
42
- * Construct the request
43
- * @param {string} propertyName - Name of the item property to be created. Currently, the following names are reserved:`id`, `itemid`, case insensitively. Also, the length of the property name must not exceed 63 characters.
44
- * @param {string} type - Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.
45
- * * `int`- Signed integer number.
46
- * * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
47
- * * `string` - UTF-8 string.
48
- * * `boolean` - *true* / *false*
49
- * * `timestamp` - Value representing date and time.
50
- * * `set` - Set of strings.
51
- * * `image` - URL of an image (`jpeg`, `png` or `gif`).
52
- * * `imageList` - List of URLs that refer to images.
53
- */
54
- constructor(propertyName, type) {
55
- super('PUT', `/items/properties/${propertyName}`, 100000, false);
56
- this.propertyName = propertyName;
57
- this.type = type;
58
- }
59
-
60
- /**
61
- * Get body parameters
62
- * @return {Object} The values of body parameters (name of parameter: value of the parameter)
63
- */
64
- bodyParameters() {
65
- let params = {};
66
-
67
- return params;
68
- }
69
-
70
- /**
71
- * Get query parameters
72
- * @return {Object} The values of query parameters (name of parameter: value of the parameter)
73
- */
74
- queryParameters() {
75
- let params = {};
76
- params.type = this.type;
77
- return params;
78
- }
79
- }
80
-
81
- exports.AddItemProperty = AddItemProperty
82
- </code></pre>
83
- </article>
84
- </section>
85
-
86
-
87
-
88
-
89
- </div>
90
-
91
- <nav>
92
- <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>
93
- </nav>
94
-
95
- <br class="clear">
96
-
97
- <footer>
98
- 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)
99
- </footer>
100
-
101
- <script> prettyPrint(); </script>
102
- <script src="scripts/linenumber.js"> </script>
103
- </body>
104
- </html>
package/doc/requests_add-item.js.html DELETED
@@ -1,94 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: requests/add-item.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-item.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 new item of given `itemId` to the items catalog.
38
- * All the item properties for the newly created items are set null.
39
- */
40
- class AddItem extends rqs.Request {
41
-
42
- /**
43
- * Construct the request
44
- * @param {string} itemId - ID of the item to be created.
45
- */
46
- constructor(itemId) {
47
- super('PUT', `/items/${itemId}`, 1000, false);
48
- this.itemId = itemId;
49
- }
50
-
51
- /**
52
- * Get body parameters
53
- * @return {Object} The values of body parameters (name of parameter: value of the parameter)
54
- */
55
- bodyParameters() {
56
- let params = {};
57
-
58
- return params;
59
- }
60
-
61
- /**
62
- * Get query parameters
63
- * @return {Object} The values of query parameters (name of parameter: value of the parameter)
64
- */
65
- queryParameters() {
66
- let params = {};
67
- return params;
68
- }
69
- }
70
-
71
- exports.AddItem = AddItem
72
- </code></pre>
73
- </article>
74
- </section>
75
-
76
-
77
-
78
-
79
- </div>
80
-
81
- <nav>
82
- <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>
83
- </nav>
84
-
85
- <br class="clear">
86
-
87
- <footer>
88
- 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)
89
- </footer>
90
-
91
- <script> prettyPrint(); </script>
92
- <script src="scripts/linenumber.js"> </script>
93
- </body>
94
- </html>
package/doc/requests_add-purchase.js.html DELETED
@@ -1,149 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: requests/add-purchase.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-purchase.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 purchase of a given item made by a given user.
38
- */
39
- class AddPurchase extends rqs.Request {
40
-
41
- /**
42
- * Construct the request
43
- * @param {string} userId - User who purchased the item
44
- * @param {string} itemId - Purchased 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 purchase 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) of purchased items. The default is 1. For example if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal to 2.
56
- * - *price*
57
- * - Type: number
58
- * - Description: Price paid by the user for the item. If `amount` is greater than 1, sum of prices of all the items should be given.
59
- * - *profit*
60
- * - Type: number
61
- * - Description: Your profit from the purchased item. The profit is natural in e-commerce domain (for example if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30), but is applicable also in other domains (for example at a news company it may be income from displayed advertisement on article page). If `amount` is greater than 1, sum of profit of all the items should be given.
62
- * - *recommId*
63
- * - Type: string
64
- * - Description: If this purchase is based on a recommendation request, `recommId` is the id of the clicked recommendation.
65
- * - *additionalData*
66
- * - Type:
67
- * - Description: A dictionary of additional data for the interaction.
68
- */
69
- constructor(userId, itemId, optional) {
70
- super('POST', '/purchases/', 1000, false);
71
- this.userId = userId;
72
- this.itemId = itemId;
73
- optional = optional || {};
74
- this.timestamp = optional.timestamp;
75
- this.cascadeCreate = optional.cascadeCreate;
76
- this.amount = optional.amount;
77
- this.price = optional.price;
78
- this.profit = optional.profit;
79
- this.recommId = optional.recommId;
80
- this.additionalData = optional.additionalData;
81
- }
82
-
83
- /**
84
- * Get body parameters
85
- * @return {Object} The values of body parameters (name of parameter: value of the parameter)
86
- */
87
- bodyParameters() {
88
- let params = {};
89
- params.userId = this.userId;
90
- params.itemId = this.itemId;
91
-
92
- if(this.timestamp !== undefined)
93
- params.timestamp = this.timestamp;
94
-
95
- if(this.cascadeCreate !== undefined)
96
- params.cascadeCreate = this.cascadeCreate;
97
-
98
- if(this.amount !== undefined)
99
- params.amount = this.amount;
100
-
101
- if(this.price !== undefined)
102
- params.price = this.price;
103
-
104
- if(this.profit !== undefined)
105
- params.profit = this.profit;
106
-
107
- if(this.recommId !== undefined)
108
- params.recommId = this.recommId;
109
-
110
- if(this.additionalData !== undefined)
111
- params.additionalData = this.additionalData;
112
-
113
- return params;
114
- }
115
-
116
- /**
117
- * Get query parameters
118
- * @return {Object} The values of query parameters (name of parameter: value of the parameter)
119
- */
120
- queryParameters() {
121
- let params = {};
122
- return params;
123
- }
124
- }
125
-
126
- exports.AddPurchase = AddPurchase
127
- </code></pre>
128
- </article>
129
- </section>
130
-
131
-
132
-
133
-
134
- </div>
135
-
136
- <nav>
137
- <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>
138
- </nav>
139
-
140
- <br class="clear">
141
-
142
- <footer>
143
- 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)
144
- </footer>
145
-
146
- <script> prettyPrint(); </script>
147
- <script src="scripts/linenumber.js"> </script>
148
- </body>
149
- </html>
package/doc/requests_add-rating.js.html DELETED
@@ -1,131 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: requests/add-rating.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-rating.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 rating of given item made by a given user.
38
- */
39
- class AddRating extends rqs.Request {
40
-
41
- /**
42
- * Construct the request
43
- * @param {string} userId - User who submitted the rating
44
- * @param {string} itemId - Rated item
45
- * @param {number} rating - Rating rescaled to interval [-1.0,1.0], where -1.0 means the worst rating possible, 0.0 means neutral, and 1.0 means absolutely positive rating. For example, in the case of 5-star evaluations, rating = (numStars-3)/2 formula may be used for the conversion.
46
- * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
47
- * - Allowed parameters:
48
- * - *timestamp*
49
- * - Type: string|number
50
- * - Description: UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
51
- * - *cascadeCreate*
52
- * - Type: boolean
53
- * - Description: Sets whether the given user/item should be created if not present in the database.
54
- * - *recommId*
55
- * - Type: string
56
- * - Description: If this rating is based on a recommendation request, `recommId` is the id of the clicked recommendation.
57
- * - *additionalData*
58
- * - Type:
59
- * - Description: A dictionary of additional data for the interaction.
60
- */
61
- constructor(userId, itemId, rating, optional) {
62
- super('POST', '/ratings/', 1000, false);
63
- this.userId = userId;
64
- this.itemId = itemId;
65
- this.rating = rating;
66
- optional = optional || {};
67
- this.timestamp = optional.timestamp;
68
- this.cascadeCreate = optional.cascadeCreate;
69
- this.recommId = optional.recommId;
70
- this.additionalData = optional.additionalData;
71
- }
72
-
73
- /**
74
- * Get body parameters
75
- * @return {Object} The values of body parameters (name of parameter: value of the parameter)
76
- */
77
- bodyParameters() {
78
- let params = {};
79
- params.userId = this.userId;
80
- params.itemId = this.itemId;
81
- params.rating = this.rating;
82
-
83
- if(this.timestamp !== undefined)
84
- params.timestamp = this.timestamp;
85
-
86
- if(this.cascadeCreate !== undefined)
87
- params.cascadeCreate = this.cascadeCreate;
88
-
89
- if(this.recommId !== undefined)
90
- params.recommId = this.recommId;
91
-
92
- if(this.additionalData !== undefined)
93
- params.additionalData = this.additionalData;
94
-
95
- return params;
96
- }
97
-
98
- /**
99
- * Get query parameters
100
- * @return {Object} The values of query parameters (name of parameter: value of the parameter)
101
- */
102
- queryParameters() {
103
- let params = {};
104
- return params;
105
- }
106
- }
107
-
108
- exports.AddRating = AddRating
109
- </code></pre>
110
- </article>
111
- </section>
112
-
113
-
114
-
115
-
116
- </div>
117
-
118
- <nav>
119
- <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>
120
- </nav>
121
-
122
- <br class="clear">
123
-
124
- <footer>
125
- 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)
126
- </footer>
127
-
128
- <script> prettyPrint(); </script>
129
- <script src="scripts/linenumber.js"> </script>
130
- </body>
131
- </html>
package/doc/requests_add-search-synonym.js.html DELETED
@@ -1,111 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: requests/add-search-synonym.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-search-synonym.js</h1>
21
-
22
-
23
-
24
-
25
-
26
-
27
- <section>
28
- <article>
29
- <pre class="prettyprint source linenums"><code>/*
30
- This file is auto-generated, do not edit
31
- */
32
-
33
- 'use strict';
34
- const rqs = require("./request");
35
-
36
- /**
37
- * Adds a new synonym for the [Search items](https://docs.recombee.com/api.html#search-items).
38
- * When the `term` is used in the search query, the `synonym` is also used for the full-text search.
39
- * Unless `oneWay=true`, it works also in the opposite way (`synonym` -> `term`).
40
- * An example of a synonym can be `science fiction` for the term `sci-fi`.
41
- */
42
- class AddSearchSynonym extends rqs.Request {
43
-
44
- /**
45
- * Construct the request
46
- * @param {string} term - A word to which the `synonym` is specified.
47
- * @param {string} synonym - A word that should be considered equal to the `term` by the full-text search engine.
48
- * @param {Object} optional - Optional parameters given as an object with structure name of the parameter: value
49
- * - Allowed parameters:
50
- * - *oneWay*
51
- * - Type: boolean
52
- * - Description: If set to `true`, only `term` -> `synonym` is considered. If set to `false`, also `synonym` -> `term` works.
53
- * Default: `false`.
54
- */
55
- constructor(term, synonym, optional) {
56
- super('POST', '/synonyms/items/', 10000, false);
57
- this.term = term;
58
- this.synonym = synonym;
59
- optional = optional || {};
60
- this.oneWay = optional.oneWay;
61
- }
62
-
63
- /**
64
- * Get body parameters
65
- * @return {Object} The values of body parameters (name of parameter: value of the parameter)
66
- */
67
- bodyParameters() {
68
- let params = {};
69
- params.term = this.term;
70
- params.synonym = this.synonym;
71
-
72
- if(this.oneWay !== undefined)
73
- params.oneWay = this.oneWay;
74
-
75
- return params;
76
- }
77
-
78
- /**
79
- * Get query parameters
80
- * @return {Object} The values of query parameters (name of parameter: value of the parameter)
81
- */
82
- queryParameters() {
83
- let params = {};
84
- return params;
85
- }
86
- }
87
-
88
- exports.AddSearchSynonym = AddSearchSynonym
89
- </code></pre>
90
- </article>
91
- </section>
92
-
93
-
94
-
95
-
96
- </div>
97
-
98
- <nav>
99
- <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>
100
- </nav>
101
-
102
- <br class="clear">
103
-
104
- <footer>
105
- 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)
106
- </footer>
107
-
108
- <script> prettyPrint(); </script>
109
- <script src="scripts/linenumber.js"> </script>
110
- </body>
111
- </html>