algoliasearch 5.0.0-alpha.90 → 5.0.0-alpha.97

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 (67) hide show
  1. package/builds/browser.ts +3 -9
  2. package/builds/models.ts +11 -5
  3. package/builds/node.ts +3 -9
  4. package/dist/algoliasearch/builds/browser.d.ts +7 -7
  5. package/dist/algoliasearch/builds/browser.d.ts.map +1 -1
  6. package/dist/algoliasearch/builds/models.d.ts +2 -2
  7. package/dist/algoliasearch/builds/models.d.ts.map +1 -1
  8. package/dist/algoliasearch/builds/node.d.ts +7 -7
  9. package/dist/algoliasearch/builds/node.d.ts.map +1 -1
  10. package/dist/algoliasearch.cjs +282 -282
  11. package/dist/algoliasearch.esm.browser.js +325 -301
  12. package/dist/algoliasearch.esm.node.js +282 -282
  13. package/dist/algoliasearch.umd.js +2 -2
  14. package/dist/client-abtesting/model/clientMethodProps.d.ts +42 -42
  15. package/dist/client-abtesting/model/clientMethodProps.d.ts.map +1 -1
  16. package/dist/client-abtesting/src/abtestingClient.d.ts +37 -37
  17. package/dist/client-abtesting/src/abtestingClient.d.ts.map +1 -1
  18. package/dist/client-analytics/model/clientMethodProps.d.ts +38 -38
  19. package/dist/client-analytics/model/clientMethodProps.d.ts.map +1 -1
  20. package/dist/client-analytics/src/analyticsClient.d.ts +32 -32
  21. package/dist/client-analytics/src/analyticsClient.d.ts.map +1 -1
  22. package/dist/client-personalization/model/clientMethodProps.d.ts +26 -26
  23. package/dist/client-personalization/model/clientMethodProps.d.ts.map +1 -1
  24. package/dist/client-personalization/src/personalizationClient.d.ts +37 -37
  25. package/dist/client-personalization/src/personalizationClient.d.ts.map +1 -1
  26. package/dist/client-search/model/clientMethodProps.d.ts +49 -49
  27. package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
  28. package/dist/client-search/model/highlightResult.d.ts +1 -1
  29. package/dist/client-search/model/highlightResult.d.ts.map +1 -1
  30. package/dist/client-search/model/searchForFacetValuesResponse.d.ts +8 -0
  31. package/dist/client-search/model/searchForFacetValuesResponse.d.ts.map +1 -1
  32. package/dist/client-search/model/searchResponses.d.ts +2 -2
  33. package/dist/client-search/model/searchResponses.d.ts.map +1 -1
  34. package/dist/client-search/model/searchResult.d.ts +1 -1
  35. package/dist/client-search/model/searchResult.d.ts.map +1 -1
  36. package/dist/client-search/model/snippetResult.d.ts +1 -1
  37. package/dist/client-search/model/snippetResult.d.ts.map +1 -1
  38. package/dist/client-search/model/userHighlightResult.d.ts +2 -8
  39. package/dist/client-search/model/userHighlightResult.d.ts.map +1 -1
  40. package/dist/client-search/src/searchClient.d.ts +40 -40
  41. package/dist/client-search/src/searchClient.d.ts.map +1 -1
  42. package/dist/lite/lite.cjs +7 -7
  43. package/dist/lite/lite.esm.browser.js +50 -26
  44. package/dist/lite/lite.esm.node.js +7 -7
  45. package/dist/lite/lite.umd.js +2 -2
  46. package/dist/lite/model/clientMethodProps.d.ts +2 -2
  47. package/dist/lite/model/clientMethodProps.d.ts.map +1 -1
  48. package/dist/lite/model/highlightResult.d.ts +1 -1
  49. package/dist/lite/model/highlightResult.d.ts.map +1 -1
  50. package/dist/lite/model/searchForFacetValuesResponse.d.ts +8 -0
  51. package/dist/lite/model/searchForFacetValuesResponse.d.ts.map +1 -1
  52. package/dist/lite/model/searchResponses.d.ts +2 -2
  53. package/dist/lite/model/searchResponses.d.ts.map +1 -1
  54. package/dist/lite/model/searchResult.d.ts +1 -1
  55. package/dist/lite/model/searchResult.d.ts.map +1 -1
  56. package/dist/lite/model/snippetResult.d.ts +1 -1
  57. package/dist/lite/model/snippetResult.d.ts.map +1 -1
  58. package/dist/lite/src/liteClient.d.ts +8 -8
  59. package/dist/lite/src/liteClient.d.ts.map +1 -1
  60. package/lite/model/clientMethodProps.ts +2 -2
  61. package/lite/model/highlightResult.ts +3 -1
  62. package/lite/model/searchForFacetValuesResponse.ts +10 -0
  63. package/lite/model/searchResponses.ts +2 -2
  64. package/lite/model/searchResult.ts +3 -1
  65. package/lite/model/snippetResult.ts +3 -1
  66. package/lite/src/liteClient.ts +13 -11
  67. package/package.json +14 -14
@@ -2,7 +2,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, createIterablePromise,
2
2
  import { createHttpRequester } from '@algolia/requester-node-http';
3
3
 
4
4
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
5
- const apiClientVersion$4 = '5.0.0-alpha.90';
5
+ const apiClientVersion$4 = '5.0.0-alpha.97';
6
6
  const REGIONS$2 = ['de', 'us'];
7
7
  function getDefaultHosts$3(region) {
8
8
  const url = !region
@@ -97,14 +97,14 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
97
97
  * This method allow you to send requests to the Algolia REST API.
98
98
  *
99
99
  * @summary Send requests to the Algolia REST API.
100
- * @param del - The del object.
101
- * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
102
- * @param del.parameters - Query parameters to apply to the current query.
100
+ * @param customDelete - The customDelete object.
101
+ * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
102
+ * @param customDelete.parameters - Query parameters to apply to the current query.
103
103
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
104
104
  */
105
- del({ path, parameters }, requestOptions) {
105
+ customDelete({ path, parameters }, requestOptions) {
106
106
  if (!path) {
107
- throw new Error('Parameter `path` is required when calling `del`.');
107
+ throw new Error('Parameter `path` is required when calling `customDelete`.');
108
108
  }
109
109
  const requestPath = '/1{path}'.replace('{path}', path);
110
110
  const headers = {};
@@ -118,22 +118,23 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
118
118
  return transporter.request(request, requestOptions);
119
119
  },
120
120
  /**
121
- * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
121
+ * This method allow you to send requests to the Algolia REST API.
122
122
  *
123
- * @summary Delete an A/B test.
124
- * @param deleteABTest - The deleteABTest object.
125
- * @param deleteABTest.id - Unique A/B test ID.
123
+ * @summary Send requests to the Algolia REST API.
124
+ * @param customGet - The customGet object.
125
+ * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
126
+ * @param customGet.parameters - Query parameters to apply to the current query.
126
127
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
127
128
  */
128
- deleteABTest({ id }, requestOptions) {
129
- if (!id) {
130
- throw new Error('Parameter `id` is required when calling `deleteABTest`.');
129
+ customGet({ path, parameters }, requestOptions) {
130
+ if (!path) {
131
+ throw new Error('Parameter `path` is required when calling `customGet`.');
131
132
  }
132
- const requestPath = '/2/abtests/{id}'.replace('{id}', encodeURIComponent(id));
133
+ const requestPath = '/1{path}'.replace('{path}', path);
133
134
  const headers = {};
134
- const queryParameters = {};
135
+ const queryParameters = parameters ? parameters : {};
135
136
  const request = {
136
- method: 'DELETE',
137
+ method: 'GET',
137
138
  path: requestPath,
138
139
  queryParameters,
139
140
  headers,
@@ -144,20 +145,71 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
144
145
  * This method allow you to send requests to the Algolia REST API.
145
146
  *
146
147
  * @summary Send requests to the Algolia REST API.
147
- * @param get - The get object.
148
- * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
149
- * @param get.parameters - Query parameters to apply to the current query.
148
+ * @param customPost - The customPost object.
149
+ * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
150
+ * @param customPost.parameters - Query parameters to apply to the current query.
151
+ * @param customPost.body - Parameters to send with the custom request.
150
152
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
151
153
  */
152
- get({ path, parameters }, requestOptions) {
154
+ customPost({ path, parameters, body }, requestOptions) {
153
155
  if (!path) {
154
- throw new Error('Parameter `path` is required when calling `get`.');
156
+ throw new Error('Parameter `path` is required when calling `customPost`.');
155
157
  }
156
158
  const requestPath = '/1{path}'.replace('{path}', path);
157
159
  const headers = {};
158
160
  const queryParameters = parameters ? parameters : {};
159
161
  const request = {
160
- method: 'GET',
162
+ method: 'POST',
163
+ path: requestPath,
164
+ queryParameters,
165
+ headers,
166
+ data: body ? body : {},
167
+ };
168
+ return transporter.request(request, requestOptions);
169
+ },
170
+ /**
171
+ * This method allow you to send requests to the Algolia REST API.
172
+ *
173
+ * @summary Send requests to the Algolia REST API.
174
+ * @param customPut - The customPut object.
175
+ * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
176
+ * @param customPut.parameters - Query parameters to apply to the current query.
177
+ * @param customPut.body - Parameters to send with the custom request.
178
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
179
+ */
180
+ customPut({ path, parameters, body }, requestOptions) {
181
+ if (!path) {
182
+ throw new Error('Parameter `path` is required when calling `customPut`.');
183
+ }
184
+ const requestPath = '/1{path}'.replace('{path}', path);
185
+ const headers = {};
186
+ const queryParameters = parameters ? parameters : {};
187
+ const request = {
188
+ method: 'PUT',
189
+ path: requestPath,
190
+ queryParameters,
191
+ headers,
192
+ data: body ? body : {},
193
+ };
194
+ return transporter.request(request, requestOptions);
195
+ },
196
+ /**
197
+ * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
198
+ *
199
+ * @summary Delete an A/B test.
200
+ * @param deleteABTest - The deleteABTest object.
201
+ * @param deleteABTest.id - Unique A/B test ID.
202
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
203
+ */
204
+ deleteABTest({ id }, requestOptions) {
205
+ if (!id) {
206
+ throw new Error('Parameter `id` is required when calling `deleteABTest`.');
207
+ }
208
+ const requestPath = '/2/abtests/{id}'.replace('{id}', encodeURIComponent(id));
209
+ const headers = {};
210
+ const queryParameters = {};
211
+ const request = {
212
+ method: 'DELETE',
161
213
  path: requestPath,
162
214
  queryParameters,
163
215
  headers,
@@ -222,58 +274,6 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
222
274
  };
223
275
  return transporter.request(request, requestOptions);
224
276
  },
225
- /**
226
- * This method allow you to send requests to the Algolia REST API.
227
- *
228
- * @summary Send requests to the Algolia REST API.
229
- * @param post - The post object.
230
- * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
231
- * @param post.parameters - Query parameters to apply to the current query.
232
- * @param post.body - Parameters to send with the custom request.
233
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
234
- */
235
- post({ path, parameters, body }, requestOptions) {
236
- if (!path) {
237
- throw new Error('Parameter `path` is required when calling `post`.');
238
- }
239
- const requestPath = '/1{path}'.replace('{path}', path);
240
- const headers = {};
241
- const queryParameters = parameters ? parameters : {};
242
- const request = {
243
- method: 'POST',
244
- path: requestPath,
245
- queryParameters,
246
- headers,
247
- data: body ? body : {},
248
- };
249
- return transporter.request(request, requestOptions);
250
- },
251
- /**
252
- * This method allow you to send requests to the Algolia REST API.
253
- *
254
- * @summary Send requests to the Algolia REST API.
255
- * @param put - The put object.
256
- * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
257
- * @param put.parameters - Query parameters to apply to the current query.
258
- * @param put.body - Parameters to send with the custom request.
259
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
260
- */
261
- put({ path, parameters, body }, requestOptions) {
262
- if (!path) {
263
- throw new Error('Parameter `path` is required when calling `put`.');
264
- }
265
- const requestPath = '/1{path}'.replace('{path}', path);
266
- const headers = {};
267
- const queryParameters = parameters ? parameters : {};
268
- const request = {
269
- method: 'PUT',
270
- path: requestPath,
271
- queryParameters,
272
- headers,
273
- data: body ? body : {},
274
- };
275
- return transporter.request(request, requestOptions);
276
- },
277
277
  /**
278
278
  * If stopped, the test is over and can\'t be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
279
279
  *
@@ -301,7 +301,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
301
301
  }
302
302
 
303
303
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
304
- const apiClientVersion$3 = '5.0.0-alpha.90';
304
+ const apiClientVersion$3 = '5.0.0-alpha.97';
305
305
  const REGIONS$1 = ['de', 'us'];
306
306
  function getDefaultHosts$2(region) {
307
307
  const url = !region
@@ -364,14 +364,14 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
364
364
  * This method allow you to send requests to the Algolia REST API.
365
365
  *
366
366
  * @summary Send requests to the Algolia REST API.
367
- * @param del - The del object.
368
- * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
369
- * @param del.parameters - Query parameters to apply to the current query.
367
+ * @param customDelete - The customDelete object.
368
+ * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
369
+ * @param customDelete.parameters - Query parameters to apply to the current query.
370
370
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
371
371
  */
372
- del({ path, parameters }, requestOptions) {
372
+ customDelete({ path, parameters }, requestOptions) {
373
373
  if (!path) {
374
- throw new Error('Parameter `path` is required when calling `del`.');
374
+ throw new Error('Parameter `path` is required when calling `customDelete`.');
375
375
  }
376
376
  const requestPath = '/1{path}'.replace('{path}', path);
377
377
  const headers = {};
@@ -388,14 +388,14 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
388
388
  * This method allow you to send requests to the Algolia REST API.
389
389
  *
390
390
  * @summary Send requests to the Algolia REST API.
391
- * @param get - The get object.
392
- * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
393
- * @param get.parameters - Query parameters to apply to the current query.
391
+ * @param customGet - The customGet object.
392
+ * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
393
+ * @param customGet.parameters - Query parameters to apply to the current query.
394
394
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
395
395
  */
396
- get({ path, parameters }, requestOptions) {
396
+ customGet({ path, parameters }, requestOptions) {
397
397
  if (!path) {
398
- throw new Error('Parameter `path` is required when calling `get`.');
398
+ throw new Error('Parameter `path` is required when calling `customGet`.');
399
399
  }
400
400
  const requestPath = '/1{path}'.replace('{path}', path);
401
401
  const headers = {};
@@ -408,6 +408,58 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
408
408
  };
409
409
  return transporter.request(request, requestOptions);
410
410
  },
411
+ /**
412
+ * This method allow you to send requests to the Algolia REST API.
413
+ *
414
+ * @summary Send requests to the Algolia REST API.
415
+ * @param customPost - The customPost object.
416
+ * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
417
+ * @param customPost.parameters - Query parameters to apply to the current query.
418
+ * @param customPost.body - Parameters to send with the custom request.
419
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
420
+ */
421
+ customPost({ path, parameters, body }, requestOptions) {
422
+ if (!path) {
423
+ throw new Error('Parameter `path` is required when calling `customPost`.');
424
+ }
425
+ const requestPath = '/1{path}'.replace('{path}', path);
426
+ const headers = {};
427
+ const queryParameters = parameters ? parameters : {};
428
+ const request = {
429
+ method: 'POST',
430
+ path: requestPath,
431
+ queryParameters,
432
+ headers,
433
+ data: body ? body : {},
434
+ };
435
+ return transporter.request(request, requestOptions);
436
+ },
437
+ /**
438
+ * This method allow you to send requests to the Algolia REST API.
439
+ *
440
+ * @summary Send requests to the Algolia REST API.
441
+ * @param customPut - The customPut object.
442
+ * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
443
+ * @param customPut.parameters - Query parameters to apply to the current query.
444
+ * @param customPut.body - Parameters to send with the custom request.
445
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
446
+ */
447
+ customPut({ path, parameters, body }, requestOptions) {
448
+ if (!path) {
449
+ throw new Error('Parameter `path` is required when calling `customPut`.');
450
+ }
451
+ const requestPath = '/1{path}'.replace('{path}', path);
452
+ const headers = {};
453
+ const queryParameters = parameters ? parameters : {};
454
+ const request = {
455
+ method: 'PUT',
456
+ path: requestPath,
457
+ queryParameters,
458
+ headers,
459
+ data: body ? body : {},
460
+ };
461
+ return transporter.request(request, requestOptions);
462
+ },
411
463
  /**
412
464
  * Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn\'t receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
413
465
  *
@@ -1142,63 +1194,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1142
1194
  };
1143
1195
  return transporter.request(request, requestOptions);
1144
1196
  },
1145
- /**
1146
- * This method allow you to send requests to the Algolia REST API.
1147
- *
1148
- * @summary Send requests to the Algolia REST API.
1149
- * @param post - The post object.
1150
- * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
1151
- * @param post.parameters - Query parameters to apply to the current query.
1152
- * @param post.body - Parameters to send with the custom request.
1153
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1154
- */
1155
- post({ path, parameters, body }, requestOptions) {
1156
- if (!path) {
1157
- throw new Error('Parameter `path` is required when calling `post`.');
1158
- }
1159
- const requestPath = '/1{path}'.replace('{path}', path);
1160
- const headers = {};
1161
- const queryParameters = parameters ? parameters : {};
1162
- const request = {
1163
- method: 'POST',
1164
- path: requestPath,
1165
- queryParameters,
1166
- headers,
1167
- data: body ? body : {},
1168
- };
1169
- return transporter.request(request, requestOptions);
1170
- },
1171
- /**
1172
- * This method allow you to send requests to the Algolia REST API.
1173
- *
1174
- * @summary Send requests to the Algolia REST API.
1175
- * @param put - The put object.
1176
- * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
1177
- * @param put.parameters - Query parameters to apply to the current query.
1178
- * @param put.body - Parameters to send with the custom request.
1179
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1180
- */
1181
- put({ path, parameters, body }, requestOptions) {
1182
- if (!path) {
1183
- throw new Error('Parameter `path` is required when calling `put`.');
1184
- }
1185
- const requestPath = '/1{path}'.replace('{path}', path);
1186
- const headers = {};
1187
- const queryParameters = parameters ? parameters : {};
1188
- const request = {
1189
- method: 'PUT',
1190
- path: requestPath,
1191
- queryParameters,
1192
- headers,
1193
- data: body ? body : {},
1194
- };
1195
- return transporter.request(request, requestOptions);
1196
- },
1197
1197
  };
1198
1198
  }
1199
1199
 
1200
1200
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
1201
- const apiClientVersion$2 = '5.0.0-alpha.90';
1201
+ const apiClientVersion$2 = '5.0.0-alpha.97';
1202
1202
  const REGIONS = ['eu', 'us'];
1203
1203
  function getDefaultHosts$1(region) {
1204
1204
  const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -1259,14 +1259,14 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
1259
1259
  * This method allow you to send requests to the Algolia REST API.
1260
1260
  *
1261
1261
  * @summary Send requests to the Algolia REST API.
1262
- * @param del - The del object.
1263
- * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
1264
- * @param del.parameters - Query parameters to apply to the current query.
1262
+ * @param customDelete - The customDelete object.
1263
+ * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
1264
+ * @param customDelete.parameters - Query parameters to apply to the current query.
1265
1265
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1266
1266
  */
1267
- del({ path, parameters }, requestOptions) {
1267
+ customDelete({ path, parameters }, requestOptions) {
1268
1268
  if (!path) {
1269
- throw new Error('Parameter `path` is required when calling `del`.');
1269
+ throw new Error('Parameter `path` is required when calling `customDelete`.');
1270
1270
  }
1271
1271
  const requestPath = '/1{path}'.replace('{path}', path);
1272
1272
  const headers = {};
@@ -1280,22 +1280,23 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
1280
1280
  return transporter.request(request, requestOptions);
1281
1281
  },
1282
1282
  /**
1283
- * Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed.
1283
+ * This method allow you to send requests to the Algolia REST API.
1284
1284
  *
1285
- * @summary Delete a user profile.
1286
- * @param deleteUserProfile - The deleteUserProfile object.
1287
- * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
1285
+ * @summary Send requests to the Algolia REST API.
1286
+ * @param customGet - The customGet object.
1287
+ * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
1288
+ * @param customGet.parameters - Query parameters to apply to the current query.
1288
1289
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1289
1290
  */
1290
- deleteUserProfile({ userToken }, requestOptions) {
1291
- if (!userToken) {
1292
- throw new Error('Parameter `userToken` is required when calling `deleteUserProfile`.');
1291
+ customGet({ path, parameters }, requestOptions) {
1292
+ if (!path) {
1293
+ throw new Error('Parameter `path` is required when calling `customGet`.');
1293
1294
  }
1294
- const requestPath = '/1/profiles/{userToken}'.replace('{userToken}', encodeURIComponent(userToken));
1295
+ const requestPath = '/1{path}'.replace('{path}', path);
1295
1296
  const headers = {};
1296
- const queryParameters = {};
1297
+ const queryParameters = parameters ? parameters : {};
1297
1298
  const request = {
1298
- method: 'DELETE',
1299
+ method: 'GET',
1299
1300
  path: requestPath,
1300
1301
  queryParameters,
1301
1302
  headers,
@@ -1306,61 +1307,71 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
1306
1307
  * This method allow you to send requests to the Algolia REST API.
1307
1308
  *
1308
1309
  * @summary Send requests to the Algolia REST API.
1309
- * @param get - The get object.
1310
- * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
1311
- * @param get.parameters - Query parameters to apply to the current query.
1310
+ * @param customPost - The customPost object.
1311
+ * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
1312
+ * @param customPost.parameters - Query parameters to apply to the current query.
1313
+ * @param customPost.body - Parameters to send with the custom request.
1312
1314
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1313
1315
  */
1314
- get({ path, parameters }, requestOptions) {
1316
+ customPost({ path, parameters, body }, requestOptions) {
1315
1317
  if (!path) {
1316
- throw new Error('Parameter `path` is required when calling `get`.');
1318
+ throw new Error('Parameter `path` is required when calling `customPost`.');
1317
1319
  }
1318
1320
  const requestPath = '/1{path}'.replace('{path}', path);
1319
1321
  const headers = {};
1320
1322
  const queryParameters = parameters ? parameters : {};
1321
1323
  const request = {
1322
- method: 'GET',
1324
+ method: 'POST',
1323
1325
  path: requestPath,
1324
1326
  queryParameters,
1325
1327
  headers,
1328
+ data: body ? body : {},
1326
1329
  };
1327
1330
  return transporter.request(request, requestOptions);
1328
1331
  },
1329
1332
  /**
1330
- * The strategy contains information on the events and facets that impact user profiles and personalized search results.
1333
+ * This method allow you to send requests to the Algolia REST API.
1331
1334
  *
1332
- * @summary Get the current strategy.
1335
+ * @summary Send requests to the Algolia REST API.
1336
+ * @param customPut - The customPut object.
1337
+ * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
1338
+ * @param customPut.parameters - Query parameters to apply to the current query.
1339
+ * @param customPut.body - Parameters to send with the custom request.
1333
1340
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1334
1341
  */
1335
- getPersonalizationStrategy(requestOptions) {
1336
- const requestPath = '/1/strategies/personalization';
1342
+ customPut({ path, parameters, body }, requestOptions) {
1343
+ if (!path) {
1344
+ throw new Error('Parameter `path` is required when calling `customPut`.');
1345
+ }
1346
+ const requestPath = '/1{path}'.replace('{path}', path);
1337
1347
  const headers = {};
1338
- const queryParameters = {};
1348
+ const queryParameters = parameters ? parameters : {};
1339
1349
  const request = {
1340
- method: 'GET',
1350
+ method: 'PUT',
1341
1351
  path: requestPath,
1342
1352
  queryParameters,
1343
1353
  headers,
1354
+ data: body ? body : {},
1344
1355
  };
1345
1356
  return transporter.request(request, requestOptions);
1346
1357
  },
1347
1358
  /**
1348
- * Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
1359
+ * Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed.
1349
1360
  *
1350
- * @summary Get a user profile.
1351
- * @param getUserTokenProfile - The getUserTokenProfile object.
1352
- * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
1361
+ * @summary Delete a user profile.
1362
+ * @param deleteUserProfile - The deleteUserProfile object.
1363
+ * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
1353
1364
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1354
1365
  */
1355
- getUserTokenProfile({ userToken }, requestOptions) {
1366
+ deleteUserProfile({ userToken }, requestOptions) {
1356
1367
  if (!userToken) {
1357
- throw new Error('Parameter `userToken` is required when calling `getUserTokenProfile`.');
1368
+ throw new Error('Parameter `userToken` is required when calling `deleteUserProfile`.');
1358
1369
  }
1359
- const requestPath = '/1/profiles/personalization/{userToken}'.replace('{userToken}', encodeURIComponent(userToken));
1370
+ const requestPath = '/1/profiles/{userToken}'.replace('{userToken}', encodeURIComponent(userToken));
1360
1371
  const headers = {};
1361
1372
  const queryParameters = {};
1362
1373
  const request = {
1363
- method: 'GET',
1374
+ method: 'DELETE',
1364
1375
  path: requestPath,
1365
1376
  queryParameters,
1366
1377
  headers,
@@ -1368,54 +1379,43 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
1368
1379
  return transporter.request(request, requestOptions);
1369
1380
  },
1370
1381
  /**
1371
- * This method allow you to send requests to the Algolia REST API.
1382
+ * The strategy contains information on the events and facets that impact user profiles and personalized search results.
1372
1383
  *
1373
- * @summary Send requests to the Algolia REST API.
1374
- * @param post - The post object.
1375
- * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
1376
- * @param post.parameters - Query parameters to apply to the current query.
1377
- * @param post.body - Parameters to send with the custom request.
1384
+ * @summary Get the current strategy.
1378
1385
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1379
1386
  */
1380
- post({ path, parameters, body }, requestOptions) {
1381
- if (!path) {
1382
- throw new Error('Parameter `path` is required when calling `post`.');
1383
- }
1384
- const requestPath = '/1{path}'.replace('{path}', path);
1387
+ getPersonalizationStrategy(requestOptions) {
1388
+ const requestPath = '/1/strategies/personalization';
1385
1389
  const headers = {};
1386
- const queryParameters = parameters ? parameters : {};
1390
+ const queryParameters = {};
1387
1391
  const request = {
1388
- method: 'POST',
1392
+ method: 'GET',
1389
1393
  path: requestPath,
1390
1394
  queryParameters,
1391
1395
  headers,
1392
- data: body ? body : {},
1393
1396
  };
1394
1397
  return transporter.request(request, requestOptions);
1395
1398
  },
1396
1399
  /**
1397
- * This method allow you to send requests to the Algolia REST API.
1400
+ * Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
1398
1401
  *
1399
- * @summary Send requests to the Algolia REST API.
1400
- * @param put - The put object.
1401
- * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
1402
- * @param put.parameters - Query parameters to apply to the current query.
1403
- * @param put.body - Parameters to send with the custom request.
1402
+ * @summary Get a user profile.
1403
+ * @param getUserTokenProfile - The getUserTokenProfile object.
1404
+ * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
1404
1405
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1405
1406
  */
1406
- put({ path, parameters, body }, requestOptions) {
1407
- if (!path) {
1408
- throw new Error('Parameter `path` is required when calling `put`.');
1407
+ getUserTokenProfile({ userToken }, requestOptions) {
1408
+ if (!userToken) {
1409
+ throw new Error('Parameter `userToken` is required when calling `getUserTokenProfile`.');
1409
1410
  }
1410
- const requestPath = '/1{path}'.replace('{path}', path);
1411
+ const requestPath = '/1/profiles/personalization/{userToken}'.replace('{userToken}', encodeURIComponent(userToken));
1411
1412
  const headers = {};
1412
- const queryParameters = parameters ? parameters : {};
1413
+ const queryParameters = {};
1413
1414
  const request = {
1414
- method: 'PUT',
1415
+ method: 'GET',
1415
1416
  path: requestPath,
1416
1417
  queryParameters,
1417
1418
  headers,
1418
- data: body ? body : {},
1419
1419
  };
1420
1420
  return transporter.request(request, requestOptions);
1421
1421
  },
@@ -1455,7 +1455,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
1455
1455
  }
1456
1456
 
1457
1457
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
1458
- const apiClientVersion$1 = '5.0.0-alpha.90';
1458
+ const apiClientVersion$1 = '5.0.0-alpha.97';
1459
1459
  function getDefaultHosts(appId) {
1460
1460
  return [
1461
1461
  {
@@ -2048,14 +2048,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
2048
2048
  * This method allow you to send requests to the Algolia REST API.
2049
2049
  *
2050
2050
  * @summary Send requests to the Algolia REST API.
2051
- * @param del - The del object.
2052
- * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
2053
- * @param del.parameters - Query parameters to apply to the current query.
2051
+ * @param customDelete - The customDelete object.
2052
+ * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
2053
+ * @param customDelete.parameters - Query parameters to apply to the current query.
2054
2054
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2055
2055
  */
2056
- del({ path, parameters }, requestOptions) {
2056
+ customDelete({ path, parameters }, requestOptions) {
2057
2057
  if (!path) {
2058
- throw new Error('Parameter `path` is required when calling `del`.');
2058
+ throw new Error('Parameter `path` is required when calling `customDelete`.');
2059
2059
  }
2060
2060
  const requestPath = '/1{path}'.replace('{path}', path);
2061
2061
  const headers = {};
@@ -2068,6 +2068,82 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
2068
2068
  };
2069
2069
  return transporter.request(request, requestOptions);
2070
2070
  },
2071
+ /**
2072
+ * This method allow you to send requests to the Algolia REST API.
2073
+ *
2074
+ * @summary Send requests to the Algolia REST API.
2075
+ * @param customGet - The customGet object.
2076
+ * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
2077
+ * @param customGet.parameters - Query parameters to apply to the current query.
2078
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2079
+ */
2080
+ customGet({ path, parameters }, requestOptions) {
2081
+ if (!path) {
2082
+ throw new Error('Parameter `path` is required when calling `customGet`.');
2083
+ }
2084
+ const requestPath = '/1{path}'.replace('{path}', path);
2085
+ const headers = {};
2086
+ const queryParameters = parameters ? parameters : {};
2087
+ const request = {
2088
+ method: 'GET',
2089
+ path: requestPath,
2090
+ queryParameters,
2091
+ headers,
2092
+ };
2093
+ return transporter.request(request, requestOptions);
2094
+ },
2095
+ /**
2096
+ * This method allow you to send requests to the Algolia REST API.
2097
+ *
2098
+ * @summary Send requests to the Algolia REST API.
2099
+ * @param customPost - The customPost object.
2100
+ * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
2101
+ * @param customPost.parameters - Query parameters to apply to the current query.
2102
+ * @param customPost.body - Parameters to send with the custom request.
2103
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2104
+ */
2105
+ customPost({ path, parameters, body }, requestOptions) {
2106
+ if (!path) {
2107
+ throw new Error('Parameter `path` is required when calling `customPost`.');
2108
+ }
2109
+ const requestPath = '/1{path}'.replace('{path}', path);
2110
+ const headers = {};
2111
+ const queryParameters = parameters ? parameters : {};
2112
+ const request = {
2113
+ method: 'POST',
2114
+ path: requestPath,
2115
+ queryParameters,
2116
+ headers,
2117
+ data: body ? body : {},
2118
+ };
2119
+ return transporter.request(request, requestOptions);
2120
+ },
2121
+ /**
2122
+ * This method allow you to send requests to the Algolia REST API.
2123
+ *
2124
+ * @summary Send requests to the Algolia REST API.
2125
+ * @param customPut - The customPut object.
2126
+ * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
2127
+ * @param customPut.parameters - Query parameters to apply to the current query.
2128
+ * @param customPut.body - Parameters to send with the custom request.
2129
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2130
+ */
2131
+ customPut({ path, parameters, body }, requestOptions) {
2132
+ if (!path) {
2133
+ throw new Error('Parameter `path` is required when calling `customPut`.');
2134
+ }
2135
+ const requestPath = '/1{path}'.replace('{path}', path);
2136
+ const headers = {};
2137
+ const queryParameters = parameters ? parameters : {};
2138
+ const request = {
2139
+ method: 'PUT',
2140
+ path: requestPath,
2141
+ queryParameters,
2142
+ headers,
2143
+ data: body ? body : {},
2144
+ };
2145
+ return transporter.request(request, requestOptions);
2146
+ },
2071
2147
  /**
2072
2148
  * Delete an existing API key. The request must be authenticated with the admin API key.
2073
2149
  *
@@ -2260,30 +2336,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
2260
2336
  };
2261
2337
  return transporter.request(request, requestOptions);
2262
2338
  },
2263
- /**
2264
- * This method allow you to send requests to the Algolia REST API.
2265
- *
2266
- * @summary Send requests to the Algolia REST API.
2267
- * @param get - The get object.
2268
- * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
2269
- * @param get.parameters - Query parameters to apply to the current query.
2270
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2271
- */
2272
- get({ path, parameters }, requestOptions) {
2273
- if (!path) {
2274
- throw new Error('Parameter `path` is required when calling `get`.');
2275
- }
2276
- const requestPath = '/1{path}'.replace('{path}', path);
2277
- const headers = {};
2278
- const queryParameters = parameters ? parameters : {};
2279
- const request = {
2280
- method: 'GET',
2281
- path: requestPath,
2282
- queryParameters,
2283
- headers,
2284
- };
2285
- return transporter.request(request, requestOptions);
2286
- },
2287
2339
  /**
2288
2340
  * Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key.
2289
2341
  *
@@ -2819,58 +2871,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
2819
2871
  };
2820
2872
  return transporter.request(request, requestOptions);
2821
2873
  },
2822
- /**
2823
- * This method allow you to send requests to the Algolia REST API.
2824
- *
2825
- * @summary Send requests to the Algolia REST API.
2826
- * @param post - The post object.
2827
- * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
2828
- * @param post.parameters - Query parameters to apply to the current query.
2829
- * @param post.body - Parameters to send with the custom request.
2830
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2831
- */
2832
- post({ path, parameters, body }, requestOptions) {
2833
- if (!path) {
2834
- throw new Error('Parameter `path` is required when calling `post`.');
2835
- }
2836
- const requestPath = '/1{path}'.replace('{path}', path);
2837
- const headers = {};
2838
- const queryParameters = parameters ? parameters : {};
2839
- const request = {
2840
- method: 'POST',
2841
- path: requestPath,
2842
- queryParameters,
2843
- headers,
2844
- data: body ? body : {},
2845
- };
2846
- return transporter.request(request, requestOptions);
2847
- },
2848
- /**
2849
- * This method allow you to send requests to the Algolia REST API.
2850
- *
2851
- * @summary Send requests to the Algolia REST API.
2852
- * @param put - The put object.
2853
- * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
2854
- * @param put.parameters - Query parameters to apply to the current query.
2855
- * @param put.body - Parameters to send with the custom request.
2856
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2857
- */
2858
- put({ path, parameters, body }, requestOptions) {
2859
- if (!path) {
2860
- throw new Error('Parameter `path` is required when calling `put`.');
2861
- }
2862
- const requestPath = '/1{path}'.replace('{path}', path);
2863
- const headers = {};
2864
- const queryParameters = parameters ? parameters : {};
2865
- const request = {
2866
- method: 'PUT',
2867
- path: requestPath,
2868
- queryParameters,
2869
- headers,
2870
- data: body ? body : {},
2871
- };
2872
- return transporter.request(request, requestOptions);
2873
- },
2874
2874
  /**
2875
2875
  * Remove a userID and its associated data from the multi-clusters.
2876
2876
  *