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
@@ -1,248 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: api-client.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: api-client.js</h1>
21
-
22
-
23
-
24
-
25
-
26
-
27
- <section>
28
- <article>
29
- <pre class="prettyprint source linenums"><code>'use strict';
30
-
31
- const jsSHA = require("jssha");
32
- const got = require('got');
33
-
34
- const api_errors = require('./errors');
35
- const requests = require('./requests');
36
-
37
- const BATCH_MAX_SIZE = 10000;
38
- /**
39
- * Client for sending requests to Recombee and getting replies
40
- */
41
- class ApiClient {
42
-
43
- /**
44
- * Construct the client
45
- * @param {string} databaseId - ID of your database
46
- * @param {string} secretToken - Corresponding secret token
47
- * @param {Object} options - Other custom options
48
- */
49
- constructor (databaseId, token, options) {
50
- this.databaseId = databaseId;
51
- this.token = token;
52
- this.options = options || {};
53
-
54
- if (Object.getPrototypeOf(this.options) !== Object.prototype) throw new Error(`options must be given as an Object (${this.options} given instead)`);
55
-
56
- this.protocol = this.options.protocol || 'https';
57
- this.baseUri = this._getBaseUri()
58
- }
59
-
60
- /**
61
- * Send the request to Recombee
62
- * @param {Request} request - Request to be sent
63
- * @param {Object} callback - Optional callback (send returns Promise if omitted)
64
- */
65
- send(request, callback) {
66
-
67
- if (request instanceof requests.Batch &amp;&amp; request.requests.length > BATCH_MAX_SIZE)
68
- return this._send_multipart_batch(request);
69
-
70
- let url = this._buildRequestUrl(request);
71
- let options = {
72
- method: request.method,
73
- url: url,
74
- headers: {'Accept': 'application/json',
75
- 'Content-Type': 'application/json',
76
- 'User-Agent': 'recombee-node-api-client/4.0.0'},
77
- timeout: request.timeout
78
- };
79
-
80
- if (Object.entries(request.bodyParameters()).length > 0)
81
- options.json = request.bodyParameters();
82
-
83
- return got(options)
84
- .json()
85
- .then((response)=> {
86
- return new Promise( (resolve) => {
87
- if (callback) { return callback(null, response); }
88
- return resolve(response);
89
- });
90
- })
91
- .catch((error) => {
92
- if (error instanceof got.HTTPError) {
93
- error = new api_errors.ResponseError(request, error.response.statusCode, error.response.body);
94
- }
95
- else if (error instanceof got.RequestError) {
96
- if(error.code === 'ETIMEDOUT' || error.code === 'ESOCKETTIMEDOUT') {
97
- error = new api_errors.TimeoutError(request, error);
98
- }
99
- }
100
- if (callback) {return callback(error)};
101
- throw error;
102
- });
103
- }
104
-
105
- _getRegionalBaseUri(region) {
106
- const uri = {
107
- 'ap-se': 'rapi-ap-se.recombee.com',
108
- 'ca-east': 'rapi-ca-east.recombee.com',
109
- 'eu-west': 'rapi-eu-west.recombee.com',
110
- 'us-west': 'rapi-us-west.recombee.com'
111
- }[region.toLowerCase()];
112
-
113
- if (uri === undefined) {
114
- throw new Error(`Region "${region}" is unknown. You may need to update the version of the SDK.`)
115
- }
116
-
117
- return uri;
118
- }
119
-
120
- _getBaseUri() {
121
- let baseUri = process.env.RAPI_URI || this.options.baseUri;
122
- if (this.options.region) {
123
- if (baseUri) {
124
- throw new Error('baseUri and region cannot be specified at the same time');
125
- }
126
- baseUri = this._getRegionalBaseUri(this.options.region);
127
- }
128
- return baseUri || 'rapi.recombee.com';
129
- }
130
-
131
- _buildRequestUrl(request) {
132
- let usedProtocol = (request.ensureHttps) ? 'https' : this.protocol;
133
- let reqUrl = request.path + this._encodeRequestQueryParams(request);
134
- let signedUrl = this._signUrl(reqUrl);
135
- return usedProtocol + '://' + this.baseUri + signedUrl;
136
- }
137
-
138
- _encodeRequestQueryParams(request) {
139
- let res = ''
140
- let queryParams = request.queryParameters();
141
- let paramPairs = [];
142
- for (let d in queryParams)
143
- paramPairs.push(this._rfc3986EncodeURIComponent(d) + '=' + this._formatQueryParameterValue(queryParams[d]));
144
- res += paramPairs.join('&amp;');
145
- if (res.length > 0) {
146
- res = '?' + res;
147
- }
148
- return res;
149
- }
150
-
151
- //https://stackoverflow.com/questions/18251399/why-doesnt-encodeuricomponent-encode-single-quotes-apostrophes
152
- _rfc3986EncodeURIComponent (str) {
153
- return encodeURIComponent(str).replace(/[!'()*]/g, escape);
154
- }
155
-
156
- _formatQueryParameterValue(value) {
157
- if (value instanceof Array) {
158
- return value.map((v) => this._rfc3986EncodeURIComponent(v.toString())).join(',');
159
- }
160
- return this._rfc3986EncodeURIComponent(value.toString());
161
- }
162
-
163
- _split_requests(requests, chunk_size) {
164
- //http://stackoverflow.com/questions/8495687/split-array-into-chunks
165
- let result = [];
166
- let i,j;
167
- for (i=0,j=requests.length; i&lt;j; i+=chunk_size) {
168
- result.push(requests.slice(i,i+chunk_size));
169
- }
170
- return result;
171
- }
172
-
173
- _concat_multipart_results(responses) {
174
- return new Promise(
175
- function (resolve, reject) {
176
- let result = [].concat.apply([], responses);
177
- resolve(result);
178
- }
179
- );
180
- }
181
-
182
- _send_batch_part_rec(requests, results) {
183
- if (requests.length == 0)
184
- return new Promise((resolve) => {resolve(results)});
185
- let request = requests.shift();
186
- return this.send(request)
187
- .then((result) => {
188
- results.push(result);
189
- return this._send_batch_part_rec(requests, results);
190
- });
191
- }
192
-
193
- _send_multipart_batch(batch, callback) {
194
- let chunks = this._split_requests(batch.requests, BATCH_MAX_SIZE);
195
- let rqs = chunks.map((rqs) => new requests.Batch(rqs));
196
-
197
- return this._send_batch_part_rec(rqs, [])
198
- .then(this._concat_multipart_results)
199
- .then((response)=> {
200
-
201
- return new Promise( (resolve) => {
202
- if (callback) { return callback(null, response); }
203
- return resolve(response);
204
- });
205
- })
206
- .catch((error) => {
207
- if (callback) {return callback(error)};
208
- throw error;
209
- });
210
- }
211
-
212
- _signUrl (req_part) {
213
- let url = '/' + this.databaseId + req_part;
214
- url += (req_part.indexOf("?") == -1 ? "?" : "&amp;" ) + "hmac_timestamp=" + parseInt(new Date().getTime() / 1000);
215
-
216
- let shaObj = new jsSHA("SHA-1", "TEXT");
217
- shaObj.setHMACKey(this.token, "TEXT");
218
- shaObj.update(url);
219
-
220
- url += "&amp;hmac_sign=" + shaObj.getHMAC("HEX");
221
- return url;
222
- }
223
- }
224
-
225
- exports.ApiClient = ApiClient
226
- </code></pre>
227
- </article>
228
- </section>
229
-
230
-
231
-
232
-
233
- </div>
234
-
235
- <nav>
236
- <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>
237
- </nav>
238
-
239
- <br class="clear">
240
-
241
- <footer>
242
- 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)
243
- </footer>
244
-
245
- <script> prettyPrint(); </script>
246
- <script src="scripts/linenumber.js"> </script>
247
- </body>
248
- </html>
@@ -1,71 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: errors/api-error.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: errors/api-error.js</h1>
21
-
22
-
23
-
24
-
25
-
26
-
27
- <section>
28
- <article>
29
- <pre class="prettyprint source linenums"><code>'use strict';
30
-
31
- //http://stackoverflow.com/questions/31089801/extending-error-in-javascript-with-es6-syntax
32
-
33
- /**
34
- * Base class for errors that occur because of errors in requests reported by API or because of a timeout
35
- */
36
- class ApiError extends Error {
37
- constructor(message) {
38
- super(message);
39
- this.name = this.constructor.name;
40
- if (typeof Error.captureStackTrace === 'function') {
41
- Error.captureStackTrace(this, this.constructor);
42
- } else {
43
- this.stack = (new Error(message)).stack;
44
- }
45
- }
46
- }
47
-
48
- exports.ApiError = ApiError
49
- </code></pre>
50
- </article>
51
- </section>
52
-
53
-
54
-
55
-
56
- </div>
57
-
58
- <nav>
59
- <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>
60
- </nav>
61
-
62
- <br class="clear">
63
-
64
- <footer>
65
- 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)
66
- </footer>
67
-
68
- <script> prettyPrint(); </script>
69
- <script src="scripts/linenumber.js"> </script>
70
- </body>
71
- </html>
@@ -1,72 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: errors/response-error.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: errors/response-error.js</h1>
21
-
22
-
23
-
24
-
25
-
26
-
27
- <section>
28
- <article>
29
- <pre class="prettyprint source linenums"><code>'use strict';
30
- const ae = require("./api-error");
31
-
32
- /**
33
- * Error thrown when a request did not succeed (did not return 200 or 201)
34
- */
35
- class ResponseError extends ae.ApiError {
36
- /**
37
- * Create the exception
38
- * @param {Request} request - Request which caused the exception
39
- * @param {number} statusCode - The returned status code
40
- * @param {string} message - Error message from the API
41
- */
42
- constructor(request, statusCode, message) {
43
- super(message);
44
- this.request = request;
45
- this.statusCode = statusCode;
46
- }
47
- }
48
-
49
- exports.ResponseError = ResponseError
50
- </code></pre>
51
- </article>
52
- </section>
53
-
54
-
55
-
56
-
57
- </div>
58
-
59
- <nav>
60
- <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>
61
- </nav>
62
-
63
- <br class="clear">
64
-
65
- <footer>
66
- 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)
67
- </footer>
68
-
69
- <script> prettyPrint(); </script>
70
- <script src="scripts/linenumber.js"> </script>
71
- </body>
72
- </html>
@@ -1,71 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <title>JSDoc: Source: errors/timeout-error.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: errors/timeout-error.js</h1>
21
-
22
-
23
-
24
-
25
-
26
-
27
- <section>
28
- <article>
29
- <pre class="prettyprint source linenums"><code>'use strict';
30
- const ae = require("./api-error");
31
-
32
- /**
33
- * Error thrown when a request is not processed within the timeout
34
- */
35
- class TimeoutError extends ae.ApiError {
36
- /**
37
- * Create the exception
38
- * @param {Request} request - Request which caused the exception
39
- * @param {Object} innerException - Exception from underlying HTTP library
40
- */
41
- constructor(request, innerException) {
42
- super(`Client did not get response within ${request.timeout} ms`);
43
- this.request = request;
44
- this.innerException = innerException;
45
- }
46
- }
47
-
48
- exports.TimeoutError = TimeoutError
49
- </code></pre>
50
- </article>
51
- </section>
52
-
53
-
54
-
55
-
56
- </div>
57
-
58
- <nav>
59
- <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>
60
- </nav>
61
-
62
- <br class="clear">
63
-
64
- <footer>
65
- 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)
66
- </footer>
67
-
68
- <script> prettyPrint(); </script>
69
- <script src="scripts/linenumber.js"> </script>
70
- </body>
71
- </html>
Binary file