@algolia/client-query-suggestions 5.55.2 → 5.57.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/browser.d.ts +138 -3
- package/dist/builds/browser.js +273 -1
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +5 -5
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +7 -7
- package/dist/builds/fetch.js +273 -1
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +273 -1
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +273 -1
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +273 -1
- package/dist/builds/worker.js.map +1 -1
- package/dist/fetch.d.ts +138 -3
- package/dist/node.d.cts +138 -3
- package/dist/node.d.ts +138 -3
- package/dist/src/querySuggestionsClient.cjs +273 -1
- package/dist/src/querySuggestionsClient.cjs.map +1 -1
- package/dist/src/querySuggestionsClient.js +273 -1
- package/dist/src/querySuggestionsClient.js.map +1 -1
- package/dist/worker.d.ts +138 -3
- package/package.json +10 -10
package/dist/fetch.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as _algolia_client_common from '@algolia/client-common';
|
|
2
|
-
import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
|
|
2
|
+
import { CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
|
|
3
3
|
|
|
4
4
|
type BaseResponse = {
|
|
5
5
|
/**
|
|
@@ -268,14 +268,14 @@ type UpdateConfigProps = {
|
|
|
268
268
|
configuration: Configuration;
|
|
269
269
|
};
|
|
270
270
|
|
|
271
|
-
declare const apiClientVersion = "5.
|
|
271
|
+
declare const apiClientVersion = "5.57.0";
|
|
272
272
|
declare const REGIONS: readonly ["eu", "us"];
|
|
273
273
|
type Region = (typeof REGIONS)[number];
|
|
274
274
|
type RegionOptions = {
|
|
275
275
|
region: Region;
|
|
276
276
|
};
|
|
277
277
|
declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
|
|
278
|
-
transporter: _algolia_client_common.
|
|
278
|
+
transporter: _algolia_client_common.TransporterWithHttpInfo;
|
|
279
279
|
/**
|
|
280
280
|
* The `appId` currently in use.
|
|
281
281
|
*/
|
|
@@ -317,6 +317,18 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
317
317
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
318
318
|
*/
|
|
319
319
|
createConfig(configurationWithIndex: ConfigurationWithIndex, requestOptions?: RequestOptions): Promise<BaseResponse>;
|
|
320
|
+
/**
|
|
321
|
+
* Creates a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.
|
|
322
|
+
*
|
|
323
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
324
|
+
*
|
|
325
|
+
* Required API Key ACLs:
|
|
326
|
+
* - editSettings
|
|
327
|
+
* @param configurationWithIndex - The configurationWithIndex object.
|
|
328
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
329
|
+
* @see createConfig for the plain version.
|
|
330
|
+
*/
|
|
331
|
+
createConfigWithHTTPInfo(configurationWithIndex: ConfigurationWithIndex, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<BaseResponse>>;
|
|
320
332
|
/**
|
|
321
333
|
* This method lets you send requests to the Algolia REST API.
|
|
322
334
|
* @param customDelete - The customDelete object.
|
|
@@ -325,6 +337,17 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
325
337
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
326
338
|
*/
|
|
327
339
|
customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
340
|
+
/**
|
|
341
|
+
* This method lets you send requests to the Algolia REST API.
|
|
342
|
+
*
|
|
343
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
344
|
+
* @param customDelete - The customDelete object.
|
|
345
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
346
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
347
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
348
|
+
* @see customDelete for the plain version.
|
|
349
|
+
*/
|
|
350
|
+
customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
328
351
|
/**
|
|
329
352
|
* This method lets you send requests to the Algolia REST API.
|
|
330
353
|
* @param customGet - The customGet object.
|
|
@@ -333,6 +356,17 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
333
356
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
334
357
|
*/
|
|
335
358
|
customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
359
|
+
/**
|
|
360
|
+
* This method lets you send requests to the Algolia REST API.
|
|
361
|
+
*
|
|
362
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
363
|
+
* @param customGet - The customGet object.
|
|
364
|
+
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
365
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
366
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
367
|
+
* @see customGet for the plain version.
|
|
368
|
+
*/
|
|
369
|
+
customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
336
370
|
/**
|
|
337
371
|
* This method lets you send requests to the Algolia REST API.
|
|
338
372
|
* @param customPost - The customPost object.
|
|
@@ -342,6 +376,18 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
342
376
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
343
377
|
*/
|
|
344
378
|
customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
379
|
+
/**
|
|
380
|
+
* This method lets you send requests to the Algolia REST API.
|
|
381
|
+
*
|
|
382
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
383
|
+
* @param customPost - The customPost object.
|
|
384
|
+
* @param customPost.path - Path of the endpoint, for example `1/newFeature`.
|
|
385
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
386
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
387
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
388
|
+
* @see customPost for the plain version.
|
|
389
|
+
*/
|
|
390
|
+
customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
345
391
|
/**
|
|
346
392
|
* This method lets you send requests to the Algolia REST API.
|
|
347
393
|
* @param customPut - The customPut object.
|
|
@@ -351,6 +397,18 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
351
397
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
352
398
|
*/
|
|
353
399
|
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
400
|
+
/**
|
|
401
|
+
* This method lets you send requests to the Algolia REST API.
|
|
402
|
+
*
|
|
403
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
404
|
+
* @param customPut - The customPut object.
|
|
405
|
+
* @param customPut.path - Path of the endpoint, for example `1/newFeature`.
|
|
406
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
407
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
408
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
409
|
+
* @see customPut for the plain version.
|
|
410
|
+
*/
|
|
411
|
+
customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
354
412
|
/**
|
|
355
413
|
* Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation.
|
|
356
414
|
*
|
|
@@ -361,6 +419,19 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
361
419
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
362
420
|
*/
|
|
363
421
|
deleteConfig({ indexName }: DeleteConfigProps, requestOptions?: RequestOptions): Promise<BaseResponse>;
|
|
422
|
+
/**
|
|
423
|
+
* Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation.
|
|
424
|
+
*
|
|
425
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
426
|
+
*
|
|
427
|
+
* Required API Key ACLs:
|
|
428
|
+
* - editSettings
|
|
429
|
+
* @param deleteConfig - The deleteConfig object.
|
|
430
|
+
* @param deleteConfig.indexName - Query Suggestions index name.
|
|
431
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
432
|
+
* @see deleteConfig for the plain version.
|
|
433
|
+
*/
|
|
434
|
+
deleteConfigWithHTTPInfo({ indexName }: DeleteConfigProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<BaseResponse>>;
|
|
364
435
|
/**
|
|
365
436
|
* Retrieves all Query Suggestions configurations of your Algolia application.
|
|
366
437
|
*
|
|
@@ -369,6 +440,17 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
369
440
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
370
441
|
*/
|
|
371
442
|
getAllConfigs(requestOptions?: RequestOptions | undefined): Promise<Array<ConfigurationResponse>>;
|
|
443
|
+
/**
|
|
444
|
+
* Retrieves all Query Suggestions configurations of your Algolia application.
|
|
445
|
+
*
|
|
446
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
447
|
+
*
|
|
448
|
+
* Required API Key ACLs:
|
|
449
|
+
* - settings
|
|
450
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
451
|
+
* @see getAllConfigs for the plain version.
|
|
452
|
+
*/
|
|
453
|
+
getAllConfigsWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<Array<ConfigurationResponse>>>;
|
|
372
454
|
/**
|
|
373
455
|
* Retrieves a single Query Suggestions configuration by its index name.
|
|
374
456
|
*
|
|
@@ -379,6 +461,19 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
379
461
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
380
462
|
*/
|
|
381
463
|
getConfig({ indexName }: GetConfigProps, requestOptions?: RequestOptions): Promise<ConfigurationResponse>;
|
|
464
|
+
/**
|
|
465
|
+
* Retrieves a single Query Suggestions configuration by its index name.
|
|
466
|
+
*
|
|
467
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
468
|
+
*
|
|
469
|
+
* Required API Key ACLs:
|
|
470
|
+
* - settings
|
|
471
|
+
* @param getConfig - The getConfig object.
|
|
472
|
+
* @param getConfig.indexName - Query Suggestions index name.
|
|
473
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
474
|
+
* @see getConfig for the plain version.
|
|
475
|
+
*/
|
|
476
|
+
getConfigWithHTTPInfo({ indexName }: GetConfigProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ConfigurationResponse>>;
|
|
382
477
|
/**
|
|
383
478
|
* Reports the status of a Query Suggestions index.
|
|
384
479
|
*
|
|
@@ -389,6 +484,19 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
389
484
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
390
485
|
*/
|
|
391
486
|
getConfigStatus({ indexName }: GetConfigStatusProps, requestOptions?: RequestOptions): Promise<ConfigStatus>;
|
|
487
|
+
/**
|
|
488
|
+
* Reports the status of a Query Suggestions index.
|
|
489
|
+
*
|
|
490
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
491
|
+
*
|
|
492
|
+
* Required API Key ACLs:
|
|
493
|
+
* - settings
|
|
494
|
+
* @param getConfigStatus - The getConfigStatus object.
|
|
495
|
+
* @param getConfigStatus.indexName - Query Suggestions index name.
|
|
496
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
497
|
+
* @see getConfigStatus for the plain version.
|
|
498
|
+
*/
|
|
499
|
+
getConfigStatusWithHTTPInfo({ indexName }: GetConfigStatusProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ConfigStatus>>;
|
|
392
500
|
/**
|
|
393
501
|
* Retrieves the logs for a single Query Suggestions index.
|
|
394
502
|
*
|
|
@@ -399,6 +507,19 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
399
507
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
400
508
|
*/
|
|
401
509
|
getLogFile({ indexName }: GetLogFileProps, requestOptions?: RequestOptions): Promise<LogFile>;
|
|
510
|
+
/**
|
|
511
|
+
* Retrieves the logs for a single Query Suggestions index.
|
|
512
|
+
*
|
|
513
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
514
|
+
*
|
|
515
|
+
* Required API Key ACLs:
|
|
516
|
+
* - settings
|
|
517
|
+
* @param getLogFile - The getLogFile object.
|
|
518
|
+
* @param getLogFile.indexName - Query Suggestions index name.
|
|
519
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
520
|
+
* @see getLogFile for the plain version.
|
|
521
|
+
*/
|
|
522
|
+
getLogFileWithHTTPInfo({ indexName }: GetLogFileProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<LogFile>>;
|
|
402
523
|
/**
|
|
403
524
|
* Updates a QuerySuggestions configuration.
|
|
404
525
|
*
|
|
@@ -410,6 +531,20 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
410
531
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
411
532
|
*/
|
|
412
533
|
updateConfig({ indexName, configuration }: UpdateConfigProps, requestOptions?: RequestOptions): Promise<BaseResponse>;
|
|
534
|
+
/**
|
|
535
|
+
* Updates a QuerySuggestions configuration.
|
|
536
|
+
*
|
|
537
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
538
|
+
*
|
|
539
|
+
* Required API Key ACLs:
|
|
540
|
+
* - editSettings
|
|
541
|
+
* @param updateConfig - The updateConfig object.
|
|
542
|
+
* @param updateConfig.indexName - Query Suggestions index name.
|
|
543
|
+
* @param updateConfig.configuration - The configuration object.
|
|
544
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
545
|
+
* @see updateConfig for the plain version.
|
|
546
|
+
*/
|
|
547
|
+
updateConfigWithHTTPInfo({ indexName, configuration }: UpdateConfigProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<BaseResponse>>;
|
|
413
548
|
};
|
|
414
549
|
|
|
415
550
|
/**
|
package/dist/node.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as _algolia_client_common from '@algolia/client-common';
|
|
2
|
-
import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
|
|
2
|
+
import { CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
|
|
3
3
|
|
|
4
4
|
type BaseResponse = {
|
|
5
5
|
/**
|
|
@@ -268,14 +268,14 @@ type UpdateConfigProps = {
|
|
|
268
268
|
configuration: Configuration;
|
|
269
269
|
};
|
|
270
270
|
|
|
271
|
-
declare const apiClientVersion = "5.
|
|
271
|
+
declare const apiClientVersion = "5.57.0";
|
|
272
272
|
declare const REGIONS: readonly ["eu", "us"];
|
|
273
273
|
type Region = (typeof REGIONS)[number];
|
|
274
274
|
type RegionOptions = {
|
|
275
275
|
region: Region;
|
|
276
276
|
};
|
|
277
277
|
declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
|
|
278
|
-
transporter: _algolia_client_common.
|
|
278
|
+
transporter: _algolia_client_common.TransporterWithHttpInfo;
|
|
279
279
|
/**
|
|
280
280
|
* The `appId` currently in use.
|
|
281
281
|
*/
|
|
@@ -317,6 +317,18 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
317
317
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
318
318
|
*/
|
|
319
319
|
createConfig(configurationWithIndex: ConfigurationWithIndex, requestOptions?: RequestOptions): Promise<BaseResponse>;
|
|
320
|
+
/**
|
|
321
|
+
* Creates a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.
|
|
322
|
+
*
|
|
323
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
324
|
+
*
|
|
325
|
+
* Required API Key ACLs:
|
|
326
|
+
* - editSettings
|
|
327
|
+
* @param configurationWithIndex - The configurationWithIndex object.
|
|
328
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
329
|
+
* @see createConfig for the plain version.
|
|
330
|
+
*/
|
|
331
|
+
createConfigWithHTTPInfo(configurationWithIndex: ConfigurationWithIndex, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<BaseResponse>>;
|
|
320
332
|
/**
|
|
321
333
|
* This method lets you send requests to the Algolia REST API.
|
|
322
334
|
* @param customDelete - The customDelete object.
|
|
@@ -325,6 +337,17 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
325
337
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
326
338
|
*/
|
|
327
339
|
customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
340
|
+
/**
|
|
341
|
+
* This method lets you send requests to the Algolia REST API.
|
|
342
|
+
*
|
|
343
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
344
|
+
* @param customDelete - The customDelete object.
|
|
345
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
346
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
347
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
348
|
+
* @see customDelete for the plain version.
|
|
349
|
+
*/
|
|
350
|
+
customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
328
351
|
/**
|
|
329
352
|
* This method lets you send requests to the Algolia REST API.
|
|
330
353
|
* @param customGet - The customGet object.
|
|
@@ -333,6 +356,17 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
333
356
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
334
357
|
*/
|
|
335
358
|
customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
359
|
+
/**
|
|
360
|
+
* This method lets you send requests to the Algolia REST API.
|
|
361
|
+
*
|
|
362
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
363
|
+
* @param customGet - The customGet object.
|
|
364
|
+
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
365
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
366
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
367
|
+
* @see customGet for the plain version.
|
|
368
|
+
*/
|
|
369
|
+
customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
336
370
|
/**
|
|
337
371
|
* This method lets you send requests to the Algolia REST API.
|
|
338
372
|
* @param customPost - The customPost object.
|
|
@@ -342,6 +376,18 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
342
376
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
343
377
|
*/
|
|
344
378
|
customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
379
|
+
/**
|
|
380
|
+
* This method lets you send requests to the Algolia REST API.
|
|
381
|
+
*
|
|
382
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
383
|
+
* @param customPost - The customPost object.
|
|
384
|
+
* @param customPost.path - Path of the endpoint, for example `1/newFeature`.
|
|
385
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
386
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
387
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
388
|
+
* @see customPost for the plain version.
|
|
389
|
+
*/
|
|
390
|
+
customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
345
391
|
/**
|
|
346
392
|
* This method lets you send requests to the Algolia REST API.
|
|
347
393
|
* @param customPut - The customPut object.
|
|
@@ -351,6 +397,18 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
351
397
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
352
398
|
*/
|
|
353
399
|
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
400
|
+
/**
|
|
401
|
+
* This method lets you send requests to the Algolia REST API.
|
|
402
|
+
*
|
|
403
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
404
|
+
* @param customPut - The customPut object.
|
|
405
|
+
* @param customPut.path - Path of the endpoint, for example `1/newFeature`.
|
|
406
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
407
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
408
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
409
|
+
* @see customPut for the plain version.
|
|
410
|
+
*/
|
|
411
|
+
customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
|
|
354
412
|
/**
|
|
355
413
|
* Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation.
|
|
356
414
|
*
|
|
@@ -361,6 +419,19 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
361
419
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
362
420
|
*/
|
|
363
421
|
deleteConfig({ indexName }: DeleteConfigProps, requestOptions?: RequestOptions): Promise<BaseResponse>;
|
|
422
|
+
/**
|
|
423
|
+
* Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation.
|
|
424
|
+
*
|
|
425
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
426
|
+
*
|
|
427
|
+
* Required API Key ACLs:
|
|
428
|
+
* - editSettings
|
|
429
|
+
* @param deleteConfig - The deleteConfig object.
|
|
430
|
+
* @param deleteConfig.indexName - Query Suggestions index name.
|
|
431
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
432
|
+
* @see deleteConfig for the plain version.
|
|
433
|
+
*/
|
|
434
|
+
deleteConfigWithHTTPInfo({ indexName }: DeleteConfigProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<BaseResponse>>;
|
|
364
435
|
/**
|
|
365
436
|
* Retrieves all Query Suggestions configurations of your Algolia application.
|
|
366
437
|
*
|
|
@@ -369,6 +440,17 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
369
440
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
370
441
|
*/
|
|
371
442
|
getAllConfigs(requestOptions?: RequestOptions | undefined): Promise<Array<ConfigurationResponse>>;
|
|
443
|
+
/**
|
|
444
|
+
* Retrieves all Query Suggestions configurations of your Algolia application.
|
|
445
|
+
*
|
|
446
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
447
|
+
*
|
|
448
|
+
* Required API Key ACLs:
|
|
449
|
+
* - settings
|
|
450
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
451
|
+
* @see getAllConfigs for the plain version.
|
|
452
|
+
*/
|
|
453
|
+
getAllConfigsWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<Array<ConfigurationResponse>>>;
|
|
372
454
|
/**
|
|
373
455
|
* Retrieves a single Query Suggestions configuration by its index name.
|
|
374
456
|
*
|
|
@@ -379,6 +461,19 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
379
461
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
380
462
|
*/
|
|
381
463
|
getConfig({ indexName }: GetConfigProps, requestOptions?: RequestOptions): Promise<ConfigurationResponse>;
|
|
464
|
+
/**
|
|
465
|
+
* Retrieves a single Query Suggestions configuration by its index name.
|
|
466
|
+
*
|
|
467
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
468
|
+
*
|
|
469
|
+
* Required API Key ACLs:
|
|
470
|
+
* - settings
|
|
471
|
+
* @param getConfig - The getConfig object.
|
|
472
|
+
* @param getConfig.indexName - Query Suggestions index name.
|
|
473
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
474
|
+
* @see getConfig for the plain version.
|
|
475
|
+
*/
|
|
476
|
+
getConfigWithHTTPInfo({ indexName }: GetConfigProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ConfigurationResponse>>;
|
|
382
477
|
/**
|
|
383
478
|
* Reports the status of a Query Suggestions index.
|
|
384
479
|
*
|
|
@@ -389,6 +484,19 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
389
484
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
390
485
|
*/
|
|
391
486
|
getConfigStatus({ indexName }: GetConfigStatusProps, requestOptions?: RequestOptions): Promise<ConfigStatus>;
|
|
487
|
+
/**
|
|
488
|
+
* Reports the status of a Query Suggestions index.
|
|
489
|
+
*
|
|
490
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
491
|
+
*
|
|
492
|
+
* Required API Key ACLs:
|
|
493
|
+
* - settings
|
|
494
|
+
* @param getConfigStatus - The getConfigStatus object.
|
|
495
|
+
* @param getConfigStatus.indexName - Query Suggestions index name.
|
|
496
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
497
|
+
* @see getConfigStatus for the plain version.
|
|
498
|
+
*/
|
|
499
|
+
getConfigStatusWithHTTPInfo({ indexName }: GetConfigStatusProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ConfigStatus>>;
|
|
392
500
|
/**
|
|
393
501
|
* Retrieves the logs for a single Query Suggestions index.
|
|
394
502
|
*
|
|
@@ -399,6 +507,19 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
399
507
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
400
508
|
*/
|
|
401
509
|
getLogFile({ indexName }: GetLogFileProps, requestOptions?: RequestOptions): Promise<LogFile>;
|
|
510
|
+
/**
|
|
511
|
+
* Retrieves the logs for a single Query Suggestions index.
|
|
512
|
+
*
|
|
513
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
514
|
+
*
|
|
515
|
+
* Required API Key ACLs:
|
|
516
|
+
* - settings
|
|
517
|
+
* @param getLogFile - The getLogFile object.
|
|
518
|
+
* @param getLogFile.indexName - Query Suggestions index name.
|
|
519
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
520
|
+
* @see getLogFile for the plain version.
|
|
521
|
+
*/
|
|
522
|
+
getLogFileWithHTTPInfo({ indexName }: GetLogFileProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<LogFile>>;
|
|
402
523
|
/**
|
|
403
524
|
* Updates a QuerySuggestions configuration.
|
|
404
525
|
*
|
|
@@ -410,6 +531,20 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
|
|
|
410
531
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
411
532
|
*/
|
|
412
533
|
updateConfig({ indexName, configuration }: UpdateConfigProps, requestOptions?: RequestOptions): Promise<BaseResponse>;
|
|
534
|
+
/**
|
|
535
|
+
* Updates a QuerySuggestions configuration.
|
|
536
|
+
*
|
|
537
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
538
|
+
*
|
|
539
|
+
* Required API Key ACLs:
|
|
540
|
+
* - editSettings
|
|
541
|
+
* @param updateConfig - The updateConfig object.
|
|
542
|
+
* @param updateConfig.indexName - Query Suggestions index name.
|
|
543
|
+
* @param updateConfig.configuration - The configuration object.
|
|
544
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
545
|
+
* @see updateConfig for the plain version.
|
|
546
|
+
*/
|
|
547
|
+
updateConfigWithHTTPInfo({ indexName, configuration }: UpdateConfigProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<BaseResponse>>;
|
|
413
548
|
};
|
|
414
549
|
|
|
415
550
|
/**
|