algoliasearch 5.0.0-alpha.91 → 5.0.0-alpha.98
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.
- package/builds/browser.ts +3 -9
- package/builds/models.ts +11 -5
- package/builds/node.ts +3 -9
- package/dist/algoliasearch/builds/browser.d.ts +10 -10
- package/dist/algoliasearch/builds/browser.d.ts.map +1 -1
- package/dist/algoliasearch/builds/models.d.ts +2 -2
- package/dist/algoliasearch/builds/models.d.ts.map +1 -1
- package/dist/algoliasearch/builds/node.d.ts +10 -10
- package/dist/algoliasearch/builds/node.d.ts.map +1 -1
- package/dist/algoliasearch.cjs +319 -327
- package/dist/algoliasearch.esm.browser.js +362 -346
- package/dist/algoliasearch.esm.node.js +319 -327
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/client-abtesting/model/clientMethodProps.d.ts +42 -42
- package/dist/client-abtesting/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-abtesting/model/variant.d.ts +4 -0
- package/dist/client-abtesting/model/variant.d.ts.map +1 -1
- package/dist/client-abtesting/src/abtestingClient.d.ts +37 -37
- package/dist/client-abtesting/src/abtestingClient.d.ts.map +1 -1
- package/dist/client-analytics/model/clientMethodProps.d.ts +38 -38
- package/dist/client-analytics/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-analytics/src/analyticsClient.d.ts +32 -32
- package/dist/client-analytics/src/analyticsClient.d.ts.map +1 -1
- package/dist/client-personalization/model/clientMethodProps.d.ts +26 -26
- package/dist/client-personalization/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-personalization/src/personalizationClient.d.ts +37 -37
- package/dist/client-personalization/src/personalizationClient.d.ts.map +1 -1
- package/dist/client-search/model/clientMethodProps.d.ts +59 -72
- package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-search/model/highlightResult.d.ts +1 -1
- package/dist/client-search/model/highlightResult.d.ts.map +1 -1
- package/dist/client-search/model/searchForFacetValuesResponse.d.ts +8 -0
- package/dist/client-search/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/client-search/model/searchResponses.d.ts +2 -2
- package/dist/client-search/model/searchResponses.d.ts.map +1 -1
- package/dist/client-search/model/searchResult.d.ts +1 -1
- package/dist/client-search/model/searchResult.d.ts.map +1 -1
- package/dist/client-search/model/searchSynonymsParams.d.ts +10 -0
- package/dist/client-search/model/searchSynonymsParams.d.ts.map +1 -1
- package/dist/client-search/model/snippetResult.d.ts +1 -1
- package/dist/client-search/model/snippetResult.d.ts.map +1 -1
- package/dist/client-search/model/userHighlightResult.d.ts +2 -8
- package/dist/client-search/model/userHighlightResult.d.ts.map +1 -1
- package/dist/client-search/src/searchClient.d.ts +53 -55
- package/dist/client-search/src/searchClient.d.ts.map +1 -1
- package/dist/lite/lite.cjs +7 -7
- package/dist/lite/lite.esm.browser.js +50 -26
- package/dist/lite/lite.esm.node.js +7 -7
- package/dist/lite/lite.umd.js +2 -2
- package/dist/lite/model/clientMethodProps.d.ts +2 -2
- package/dist/lite/model/clientMethodProps.d.ts.map +1 -1
- package/dist/lite/model/highlightResult.d.ts +1 -1
- package/dist/lite/model/highlightResult.d.ts.map +1 -1
- package/dist/lite/model/searchForFacetValuesResponse.d.ts +8 -0
- package/dist/lite/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/lite/model/searchResponses.d.ts +2 -2
- package/dist/lite/model/searchResponses.d.ts.map +1 -1
- package/dist/lite/model/searchResult.d.ts +1 -1
- package/dist/lite/model/searchResult.d.ts.map +1 -1
- package/dist/lite/model/snippetResult.d.ts +1 -1
- package/dist/lite/model/snippetResult.d.ts.map +1 -1
- package/dist/lite/src/liteClient.d.ts +8 -8
- package/dist/lite/src/liteClient.d.ts.map +1 -1
- package/lite/model/clientMethodProps.ts +2 -2
- package/lite/model/highlightResult.ts +3 -1
- package/lite/model/searchForFacetValuesResponse.ts +10 -0
- package/lite/model/searchResponses.ts +2 -2
- package/lite/model/searchResult.ts +3 -1
- package/lite/model/snippetResult.ts +3 -1
- package/lite/src/liteClient.ts +13 -11
- package/package.json +13 -13
|
@@ -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.
|
|
5
|
+
const apiClientVersion$4 = '5.0.0-alpha.98';
|
|
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
|
|
101
|
-
* @param
|
|
102
|
-
* @param
|
|
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
|
-
|
|
105
|
+
customDelete({ path, parameters }, requestOptions) {
|
|
106
106
|
if (!path) {
|
|
107
|
-
throw new Error('Parameter `path` is required when calling `
|
|
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
|
-
*
|
|
121
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
122
122
|
*
|
|
123
|
-
* @summary
|
|
124
|
-
* @param
|
|
125
|
-
* @param
|
|
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
|
-
|
|
129
|
-
if (!
|
|
130
|
-
throw new Error('Parameter `
|
|
129
|
+
customGet({ path, parameters }, requestOptions) {
|
|
130
|
+
if (!path) {
|
|
131
|
+
throw new Error('Parameter `path` is required when calling `customGet`.');
|
|
131
132
|
}
|
|
132
|
-
const requestPath = '/
|
|
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: '
|
|
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
|
|
148
|
-
* @param
|
|
149
|
-
* @param
|
|
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
|
-
|
|
154
|
+
customPost({ path, parameters, body }, requestOptions) {
|
|
153
155
|
if (!path) {
|
|
154
|
-
throw new Error('Parameter `path` is required when calling `
|
|
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: '
|
|
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.
|
|
304
|
+
const apiClientVersion$3 = '5.0.0-alpha.98';
|
|
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
|
|
368
|
-
* @param
|
|
369
|
-
* @param
|
|
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
|
-
|
|
372
|
+
customDelete({ path, parameters }, requestOptions) {
|
|
373
373
|
if (!path) {
|
|
374
|
-
throw new Error('Parameter `path` is required when calling `
|
|
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
|
|
392
|
-
* @param
|
|
393
|
-
* @param
|
|
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
|
-
|
|
396
|
+
customGet({ path, parameters }, requestOptions) {
|
|
397
397
|
if (!path) {
|
|
398
|
-
throw new Error('Parameter `path` is required when calling `
|
|
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.
|
|
1201
|
+
const apiClientVersion$2 = '5.0.0-alpha.98';
|
|
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
|
|
1263
|
-
* @param
|
|
1264
|
-
* @param
|
|
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
|
-
|
|
1267
|
+
customDelete({ path, parameters }, requestOptions) {
|
|
1268
1268
|
if (!path) {
|
|
1269
|
-
throw new Error('Parameter `path` is required when calling `
|
|
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
|
-
*
|
|
1283
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
1284
1284
|
*
|
|
1285
|
-
* @summary
|
|
1286
|
-
* @param
|
|
1287
|
-
* @param
|
|
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
|
-
|
|
1291
|
-
if (!
|
|
1292
|
-
throw new Error('Parameter `
|
|
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
|
|
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: '
|
|
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
|
|
1310
|
-
* @param
|
|
1311
|
-
* @param
|
|
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
|
-
|
|
1316
|
+
customPost({ path, parameters, body }, requestOptions) {
|
|
1315
1317
|
if (!path) {
|
|
1316
|
-
throw new Error('Parameter `path` is required when calling `
|
|
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: '
|
|
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
|
-
*
|
|
1333
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
1331
1334
|
*
|
|
1332
|
-
* @summary
|
|
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
|
-
|
|
1336
|
-
|
|
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: '
|
|
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
|
-
*
|
|
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
|
|
1351
|
-
* @param
|
|
1352
|
-
* @param
|
|
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
|
-
|
|
1366
|
+
deleteUserProfile({ userToken }, requestOptions) {
|
|
1356
1367
|
if (!userToken) {
|
|
1357
|
-
throw new Error('Parameter `userToken` is required when calling `
|
|
1368
|
+
throw new Error('Parameter `userToken` is required when calling `deleteUserProfile`.');
|
|
1358
1369
|
}
|
|
1359
|
-
const requestPath = '/1/profiles/
|
|
1370
|
+
const requestPath = '/1/profiles/{userToken}'.replace('{userToken}', encodeURIComponent(userToken));
|
|
1360
1371
|
const headers = {};
|
|
1361
1372
|
const queryParameters = {};
|
|
1362
1373
|
const request = {
|
|
1363
|
-
method: '
|
|
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
|
-
*
|
|
1382
|
+
* The strategy contains information on the events and facets that impact user profiles and personalized search results.
|
|
1372
1383
|
*
|
|
1373
|
-
* @summary
|
|
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
|
-
|
|
1381
|
-
|
|
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 =
|
|
1390
|
+
const queryParameters = {};
|
|
1387
1391
|
const request = {
|
|
1388
|
-
method: '
|
|
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
|
-
*
|
|
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
|
|
1400
|
-
* @param
|
|
1401
|
-
* @param
|
|
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
|
-
|
|
1407
|
-
if (!
|
|
1408
|
-
throw new Error('Parameter `
|
|
1407
|
+
getUserTokenProfile({ userToken }, requestOptions) {
|
|
1408
|
+
if (!userToken) {
|
|
1409
|
+
throw new Error('Parameter `userToken` is required when calling `getUserTokenProfile`.');
|
|
1409
1410
|
}
|
|
1410
|
-
const requestPath = '/1{
|
|
1411
|
+
const requestPath = '/1/profiles/personalization/{userToken}'.replace('{userToken}', encodeURIComponent(userToken));
|
|
1411
1412
|
const headers = {};
|
|
1412
|
-
const queryParameters =
|
|
1413
|
+
const queryParameters = {};
|
|
1413
1414
|
const request = {
|
|
1414
|
-
method: '
|
|
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.
|
|
1458
|
+
const apiClientVersion$1 = '5.0.0-alpha.98';
|
|
1459
1459
|
function getDefaultHosts(appId) {
|
|
1460
1460
|
return [
|
|
1461
1461
|
{
|
|
@@ -1680,21 +1680,25 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1680
1680
|
* @param browseObjects.indexName - The index in which to perform the request.
|
|
1681
1681
|
* @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is less hits returned than the number of maximum hits (1000).
|
|
1682
1682
|
* @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
|
|
1683
|
+
* @param browseObjects.searchSynonymsParams - The `searchSynonyms` method parameters.
|
|
1683
1684
|
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchSynonyms` method and merged with the transporter requestOptions.
|
|
1684
1685
|
*/
|
|
1685
|
-
browseSynonyms({ indexName,
|
|
1686
|
+
browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }, requestOptions) {
|
|
1686
1687
|
const params = {
|
|
1688
|
+
page: 0,
|
|
1689
|
+
...searchSynonymsParams,
|
|
1687
1690
|
hitsPerPage: 1000,
|
|
1688
|
-
...browseSynonymsOptions,
|
|
1689
1691
|
};
|
|
1690
1692
|
return createIterablePromise({
|
|
1691
1693
|
func: (previousResponse) => {
|
|
1692
1694
|
return this.searchSynonyms({
|
|
1693
|
-
...params,
|
|
1694
1695
|
indexName,
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
:
|
|
1696
|
+
searchSynonymsParams: {
|
|
1697
|
+
...params,
|
|
1698
|
+
page: previousResponse
|
|
1699
|
+
? previousResponse.page + 1
|
|
1700
|
+
: params.page,
|
|
1701
|
+
},
|
|
1698
1702
|
}, requestOptions);
|
|
1699
1703
|
},
|
|
1700
1704
|
validate: (response) => response.nbHits < params.hitsPerPage,
|
|
@@ -1968,24 +1972,20 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1968
1972
|
return transporter.request(request, requestOptions);
|
|
1969
1973
|
},
|
|
1970
1974
|
/**
|
|
1971
|
-
* Delete
|
|
1975
|
+
* Delete the records but leave settings and index-specific API keys untouched.
|
|
1972
1976
|
*
|
|
1973
|
-
* @summary Delete all
|
|
1974
|
-
* @param
|
|
1975
|
-
* @param
|
|
1976
|
-
* @param clearAllSynonyms.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
|
|
1977
|
+
* @summary Delete all records from an index.
|
|
1978
|
+
* @param clearObjects - The clearObjects object.
|
|
1979
|
+
* @param clearObjects.indexName - Index on which to perform the request.
|
|
1977
1980
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1978
1981
|
*/
|
|
1979
|
-
|
|
1982
|
+
clearObjects({ indexName }, requestOptions) {
|
|
1980
1983
|
if (!indexName) {
|
|
1981
|
-
throw new Error('Parameter `indexName` is required when calling `
|
|
1984
|
+
throw new Error('Parameter `indexName` is required when calling `clearObjects`.');
|
|
1982
1985
|
}
|
|
1983
|
-
const requestPath = '/1/indexes/{indexName}/
|
|
1986
|
+
const requestPath = '/1/indexes/{indexName}/clear'.replace('{indexName}', encodeURIComponent(indexName));
|
|
1984
1987
|
const headers = {};
|
|
1985
1988
|
const queryParameters = {};
|
|
1986
|
-
if (forwardToReplicas !== undefined) {
|
|
1987
|
-
queryParameters.forwardToReplicas = forwardToReplicas.toString();
|
|
1988
|
-
}
|
|
1989
1989
|
const request = {
|
|
1990
1990
|
method: 'POST',
|
|
1991
1991
|
path: requestPath,
|
|
@@ -1995,20 +1995,24 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1995
1995
|
return transporter.request(request, requestOptions);
|
|
1996
1996
|
},
|
|
1997
1997
|
/**
|
|
1998
|
-
* Delete
|
|
1998
|
+
* Delete all rules in the index.
|
|
1999
1999
|
*
|
|
2000
|
-
* @summary Delete all
|
|
2001
|
-
* @param
|
|
2002
|
-
* @param
|
|
2000
|
+
* @summary Delete all rules.
|
|
2001
|
+
* @param clearRules - The clearRules object.
|
|
2002
|
+
* @param clearRules.indexName - Index on which to perform the request.
|
|
2003
|
+
* @param clearRules.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
|
|
2003
2004
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2004
2005
|
*/
|
|
2005
|
-
|
|
2006
|
+
clearRules({ indexName, forwardToReplicas }, requestOptions) {
|
|
2006
2007
|
if (!indexName) {
|
|
2007
|
-
throw new Error('Parameter `indexName` is required when calling `
|
|
2008
|
+
throw new Error('Parameter `indexName` is required when calling `clearRules`.');
|
|
2008
2009
|
}
|
|
2009
|
-
const requestPath = '/1/indexes/{indexName}/clear'.replace('{indexName}', encodeURIComponent(indexName));
|
|
2010
|
+
const requestPath = '/1/indexes/{indexName}/rules/clear'.replace('{indexName}', encodeURIComponent(indexName));
|
|
2010
2011
|
const headers = {};
|
|
2011
2012
|
const queryParameters = {};
|
|
2013
|
+
if (forwardToReplicas !== undefined) {
|
|
2014
|
+
queryParameters.forwardToReplicas = forwardToReplicas.toString();
|
|
2015
|
+
}
|
|
2012
2016
|
const request = {
|
|
2013
2017
|
method: 'POST',
|
|
2014
2018
|
path: requestPath,
|
|
@@ -2018,19 +2022,19 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2018
2022
|
return transporter.request(request, requestOptions);
|
|
2019
2023
|
},
|
|
2020
2024
|
/**
|
|
2021
|
-
* Delete all
|
|
2025
|
+
* Delete all synonyms in the index.
|
|
2022
2026
|
*
|
|
2023
|
-
* @summary Delete all
|
|
2024
|
-
* @param
|
|
2025
|
-
* @param
|
|
2026
|
-
* @param
|
|
2027
|
+
* @summary Delete all synonyms.
|
|
2028
|
+
* @param clearSynonyms - The clearSynonyms object.
|
|
2029
|
+
* @param clearSynonyms.indexName - Index on which to perform the request.
|
|
2030
|
+
* @param clearSynonyms.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
|
|
2027
2031
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2028
2032
|
*/
|
|
2029
|
-
|
|
2033
|
+
clearSynonyms({ indexName, forwardToReplicas }, requestOptions) {
|
|
2030
2034
|
if (!indexName) {
|
|
2031
|
-
throw new Error('Parameter `indexName` is required when calling `
|
|
2035
|
+
throw new Error('Parameter `indexName` is required when calling `clearSynonyms`.');
|
|
2032
2036
|
}
|
|
2033
|
-
const requestPath = '/1/indexes/{indexName}/
|
|
2037
|
+
const requestPath = '/1/indexes/{indexName}/synonyms/clear'.replace('{indexName}', encodeURIComponent(indexName));
|
|
2034
2038
|
const headers = {};
|
|
2035
2039
|
const queryParameters = {};
|
|
2036
2040
|
if (forwardToReplicas !== undefined) {
|
|
@@ -2048,14 +2052,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2048
2052
|
* This method allow you to send requests to the Algolia REST API.
|
|
2049
2053
|
*
|
|
2050
2054
|
* @summary Send requests to the Algolia REST API.
|
|
2051
|
-
* @param
|
|
2052
|
-
* @param
|
|
2053
|
-
* @param
|
|
2055
|
+
* @param customDelete - The customDelete object.
|
|
2056
|
+
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
2057
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
2054
2058
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2055
2059
|
*/
|
|
2056
|
-
|
|
2060
|
+
customDelete({ path, parameters }, requestOptions) {
|
|
2057
2061
|
if (!path) {
|
|
2058
|
-
throw new Error('Parameter `path` is required when calling `
|
|
2062
|
+
throw new Error('Parameter `path` is required when calling `customDelete`.');
|
|
2059
2063
|
}
|
|
2060
2064
|
const requestPath = '/1{path}'.replace('{path}', path);
|
|
2061
2065
|
const headers = {};
|
|
@@ -2068,6 +2072,82 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2068
2072
|
};
|
|
2069
2073
|
return transporter.request(request, requestOptions);
|
|
2070
2074
|
},
|
|
2075
|
+
/**
|
|
2076
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
2077
|
+
*
|
|
2078
|
+
* @summary Send requests to the Algolia REST API.
|
|
2079
|
+
* @param customGet - The customGet object.
|
|
2080
|
+
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
2081
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
2082
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2083
|
+
*/
|
|
2084
|
+
customGet({ path, parameters }, requestOptions) {
|
|
2085
|
+
if (!path) {
|
|
2086
|
+
throw new Error('Parameter `path` is required when calling `customGet`.');
|
|
2087
|
+
}
|
|
2088
|
+
const requestPath = '/1{path}'.replace('{path}', path);
|
|
2089
|
+
const headers = {};
|
|
2090
|
+
const queryParameters = parameters ? parameters : {};
|
|
2091
|
+
const request = {
|
|
2092
|
+
method: 'GET',
|
|
2093
|
+
path: requestPath,
|
|
2094
|
+
queryParameters,
|
|
2095
|
+
headers,
|
|
2096
|
+
};
|
|
2097
|
+
return transporter.request(request, requestOptions);
|
|
2098
|
+
},
|
|
2099
|
+
/**
|
|
2100
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
2101
|
+
*
|
|
2102
|
+
* @summary Send requests to the Algolia REST API.
|
|
2103
|
+
* @param customPost - The customPost object.
|
|
2104
|
+
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
2105
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
2106
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
2107
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2108
|
+
*/
|
|
2109
|
+
customPost({ path, parameters, body }, requestOptions) {
|
|
2110
|
+
if (!path) {
|
|
2111
|
+
throw new Error('Parameter `path` is required when calling `customPost`.');
|
|
2112
|
+
}
|
|
2113
|
+
const requestPath = '/1{path}'.replace('{path}', path);
|
|
2114
|
+
const headers = {};
|
|
2115
|
+
const queryParameters = parameters ? parameters : {};
|
|
2116
|
+
const request = {
|
|
2117
|
+
method: 'POST',
|
|
2118
|
+
path: requestPath,
|
|
2119
|
+
queryParameters,
|
|
2120
|
+
headers,
|
|
2121
|
+
data: body ? body : {},
|
|
2122
|
+
};
|
|
2123
|
+
return transporter.request(request, requestOptions);
|
|
2124
|
+
},
|
|
2125
|
+
/**
|
|
2126
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
2127
|
+
*
|
|
2128
|
+
* @summary Send requests to the Algolia REST API.
|
|
2129
|
+
* @param customPut - The customPut object.
|
|
2130
|
+
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
2131
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
2132
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
2133
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2134
|
+
*/
|
|
2135
|
+
customPut({ path, parameters, body }, requestOptions) {
|
|
2136
|
+
if (!path) {
|
|
2137
|
+
throw new Error('Parameter `path` is required when calling `customPut`.');
|
|
2138
|
+
}
|
|
2139
|
+
const requestPath = '/1{path}'.replace('{path}', path);
|
|
2140
|
+
const headers = {};
|
|
2141
|
+
const queryParameters = parameters ? parameters : {};
|
|
2142
|
+
const request = {
|
|
2143
|
+
method: 'PUT',
|
|
2144
|
+
path: requestPath,
|
|
2145
|
+
queryParameters,
|
|
2146
|
+
headers,
|
|
2147
|
+
data: body ? body : {},
|
|
2148
|
+
};
|
|
2149
|
+
return transporter.request(request, requestOptions);
|
|
2150
|
+
},
|
|
2071
2151
|
/**
|
|
2072
2152
|
* Delete an existing API key. The request must be authenticated with the admin API key.
|
|
2073
2153
|
*
|
|
@@ -2260,30 +2340,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2260
2340
|
};
|
|
2261
2341
|
return transporter.request(request, requestOptions);
|
|
2262
2342
|
},
|
|
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
2343
|
/**
|
|
2288
2344
|
* 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
2345
|
*
|
|
@@ -2819,58 +2875,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2819
2875
|
};
|
|
2820
2876
|
return transporter.request(request, requestOptions);
|
|
2821
2877
|
},
|
|
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
2878
|
/**
|
|
2875
2879
|
* Remove a userID and its associated data from the multi-clusters.
|
|
2876
2880
|
*
|
|
@@ -3303,28 +3307,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3303
3307
|
* @summary Search for synonyms.
|
|
3304
3308
|
* @param searchSynonyms - The searchSynonyms object.
|
|
3305
3309
|
* @param searchSynonyms.indexName - Index on which to perform the request.
|
|
3306
|
-
* @param searchSynonyms.type - Search for specific [types of synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms).
|
|
3307
|
-
* @param searchSynonyms.page - Returns the requested page number (the first page is 0). Page size is set by `hitsPerPage`. When null, there\'s no pagination.
|
|
3308
|
-
* @param searchSynonyms.hitsPerPage - Maximum number of hits per page.
|
|
3309
3310
|
* @param searchSynonyms.searchSynonymsParams - Body of the `searchSynonyms` operation.
|
|
3310
3311
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3311
3312
|
*/
|
|
3312
|
-
searchSynonyms({ indexName,
|
|
3313
|
+
searchSynonyms({ indexName, searchSynonymsParams }, requestOptions) {
|
|
3313
3314
|
if (!indexName) {
|
|
3314
3315
|
throw new Error('Parameter `indexName` is required when calling `searchSynonyms`.');
|
|
3315
3316
|
}
|
|
3316
3317
|
const requestPath = '/1/indexes/{indexName}/synonyms/search'.replace('{indexName}', encodeURIComponent(indexName));
|
|
3317
3318
|
const headers = {};
|
|
3318
3319
|
const queryParameters = {};
|
|
3319
|
-
if (type !== undefined) {
|
|
3320
|
-
queryParameters.type = type.toString();
|
|
3321
|
-
}
|
|
3322
|
-
if (page !== undefined) {
|
|
3323
|
-
queryParameters.page = page.toString();
|
|
3324
|
-
}
|
|
3325
|
-
if (hitsPerPage !== undefined) {
|
|
3326
|
-
queryParameters.hitsPerPage = hitsPerPage.toString();
|
|
3327
|
-
}
|
|
3328
3320
|
const request = {
|
|
3329
3321
|
method: 'POST',
|
|
3330
3322
|
path: requestPath,
|