@algolia/client-query-suggestions 5.55.2 → 5.56.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 CHANGED
@@ -40,11 +40,11 @@ All of our clients comes with type definition, and are available for both browse
40
40
  ### With a package manager
41
41
 
42
42
  ```bash
43
- yarn add @algolia/client-query-suggestions@5.55.2
43
+ yarn add @algolia/client-query-suggestions@5.56.0
44
44
  # or
45
- npm install @algolia/client-query-suggestions@5.55.2
45
+ npm install @algolia/client-query-suggestions@5.56.0
46
46
  # or
47
- pnpm add @algolia/client-query-suggestions@5.55.2
47
+ pnpm add @algolia/client-query-suggestions@5.56.0
48
48
  ```
49
49
 
50
50
  ### Without a package manager
@@ -52,7 +52,7 @@ pnpm add @algolia/client-query-suggestions@5.55.2
52
52
  Add the following JavaScript snippet to the <head> of your website:
53
53
 
54
54
  ```html
55
- <script src="https://cdn.jsdelivr.net/npm/@algolia/client-query-suggestions@5.55.2/dist/builds/browser.umd.js"></script>
55
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/client-query-suggestions@5.56.0/dist/builds/browser.umd.js"></script>
56
56
  ```
57
57
 
58
58
  ### Usage
package/dist/browser.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.55.2";
271
+ declare const apiClientVersion = "5.56.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.Transporter;
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
  /**
@@ -9,7 +9,7 @@ import { createXhrRequester } from "@algolia/requester-browser-xhr";
9
9
 
10
10
  // src/querySuggestionsClient.ts
11
11
  import { createAuth, createTransporter, getAlgoliaAgent, validateRequired } from "@algolia/client-common";
12
- var apiClientVersion = "5.55.2";
12
+ var apiClientVersion = "5.56.0";
13
13
  var REGIONS = ["eu", "us"];
14
14
  function getDefaultHosts(region) {
15
15
  const url = "query-suggestions.{region}.algolia.com".replace("{region}", region);
@@ -108,6 +108,31 @@ function createQuerySuggestionsClient({
108
108
  };
109
109
  return transporter.request(request, requestOptions);
110
110
  },
111
+ /**
112
+ * Creates a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.
113
+ *
114
+ * 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.
115
+ *
116
+ * Required API Key ACLs:
117
+ * - editSettings
118
+ * @param configurationWithIndex - The configurationWithIndex object.
119
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
120
+ * @see createConfig for the plain version.
121
+ */
122
+ createConfigWithHTTPInfo(configurationWithIndex, requestOptions) {
123
+ validateRequired("configurationWithIndex", "createConfigWithHTTPInfo", configurationWithIndex);
124
+ const requestPath = "/1/configs";
125
+ const headers = {};
126
+ const queryParameters = {};
127
+ const request = {
128
+ method: "POST",
129
+ path: requestPath,
130
+ queryParameters,
131
+ headers,
132
+ data: configurationWithIndex
133
+ };
134
+ return transporter.requestWithHttpInfo(request, requestOptions);
135
+ },
111
136
  /**
112
137
  * This method lets you send requests to the Algolia REST API.
113
138
  * @param customDelete - The customDelete object.
@@ -128,6 +153,29 @@ function createQuerySuggestionsClient({
128
153
  };
129
154
  return transporter.request(request, requestOptions);
130
155
  },
156
+ /**
157
+ * This method lets you send requests to the Algolia REST API.
158
+ *
159
+ * 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.
160
+ * @param customDelete - The customDelete object.
161
+ * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
162
+ * @param customDelete.parameters - Query parameters to apply to the current query.
163
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
164
+ * @see customDelete for the plain version.
165
+ */
166
+ customDeleteWithHTTPInfo({ path, parameters }, requestOptions) {
167
+ validateRequired("path", "customDeleteWithHTTPInfo", path);
168
+ const requestPath = "/{path}".replace("{path}", path);
169
+ const headers = {};
170
+ const queryParameters = parameters ? parameters : {};
171
+ const request = {
172
+ method: "DELETE",
173
+ path: requestPath,
174
+ queryParameters,
175
+ headers
176
+ };
177
+ return transporter.requestWithHttpInfo(request, requestOptions);
178
+ },
131
179
  /**
132
180
  * This method lets you send requests to the Algolia REST API.
133
181
  * @param customGet - The customGet object.
@@ -148,6 +196,29 @@ function createQuerySuggestionsClient({
148
196
  };
149
197
  return transporter.request(request, requestOptions);
150
198
  },
199
+ /**
200
+ * This method lets you send requests to the Algolia REST API.
201
+ *
202
+ * 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.
203
+ * @param customGet - The customGet object.
204
+ * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
205
+ * @param customGet.parameters - Query parameters to apply to the current query.
206
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
207
+ * @see customGet for the plain version.
208
+ */
209
+ customGetWithHTTPInfo({ path, parameters }, requestOptions) {
210
+ validateRequired("path", "customGetWithHTTPInfo", path);
211
+ const requestPath = "/{path}".replace("{path}", path);
212
+ const headers = {};
213
+ const queryParameters = parameters ? parameters : {};
214
+ const request = {
215
+ method: "GET",
216
+ path: requestPath,
217
+ queryParameters,
218
+ headers
219
+ };
220
+ return transporter.requestWithHttpInfo(request, requestOptions);
221
+ },
151
222
  /**
152
223
  * This method lets you send requests to the Algolia REST API.
153
224
  * @param customPost - The customPost object.
@@ -170,6 +241,31 @@ function createQuerySuggestionsClient({
170
241
  };
171
242
  return transporter.request(request, requestOptions);
172
243
  },
244
+ /**
245
+ * This method lets you send requests to the Algolia REST API.
246
+ *
247
+ * 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.
248
+ * @param customPost - The customPost object.
249
+ * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
250
+ * @param customPost.parameters - Query parameters to apply to the current query.
251
+ * @param customPost.body - Parameters to send with the custom request.
252
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
253
+ * @see customPost for the plain version.
254
+ */
255
+ customPostWithHTTPInfo({ path, parameters, body }, requestOptions) {
256
+ validateRequired("path", "customPostWithHTTPInfo", path);
257
+ const requestPath = "/{path}".replace("{path}", path);
258
+ const headers = {};
259
+ const queryParameters = parameters ? parameters : {};
260
+ const request = {
261
+ method: "POST",
262
+ path: requestPath,
263
+ queryParameters,
264
+ headers,
265
+ data: body ? body : {}
266
+ };
267
+ return transporter.requestWithHttpInfo(request, requestOptions);
268
+ },
173
269
  /**
174
270
  * This method lets you send requests to the Algolia REST API.
175
271
  * @param customPut - The customPut object.
@@ -192,6 +288,31 @@ function createQuerySuggestionsClient({
192
288
  };
193
289
  return transporter.request(request, requestOptions);
194
290
  },
291
+ /**
292
+ * This method lets you send requests to the Algolia REST API.
293
+ *
294
+ * 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.
295
+ * @param customPut - The customPut object.
296
+ * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
297
+ * @param customPut.parameters - Query parameters to apply to the current query.
298
+ * @param customPut.body - Parameters to send with the custom request.
299
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
300
+ * @see customPut for the plain version.
301
+ */
302
+ customPutWithHTTPInfo({ path, parameters, body }, requestOptions) {
303
+ validateRequired("path", "customPutWithHTTPInfo", path);
304
+ const requestPath = "/{path}".replace("{path}", path);
305
+ const headers = {};
306
+ const queryParameters = parameters ? parameters : {};
307
+ const request = {
308
+ method: "PUT",
309
+ path: requestPath,
310
+ queryParameters,
311
+ headers,
312
+ data: body ? body : {}
313
+ };
314
+ return transporter.requestWithHttpInfo(request, requestOptions);
315
+ },
195
316
  /**
196
317
  * 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.
197
318
  *
@@ -214,6 +335,31 @@ function createQuerySuggestionsClient({
214
335
  };
215
336
  return transporter.request(request, requestOptions);
216
337
  },
338
+ /**
339
+ * 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.
340
+ *
341
+ * 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.
342
+ *
343
+ * Required API Key ACLs:
344
+ * - editSettings
345
+ * @param deleteConfig - The deleteConfig object.
346
+ * @param deleteConfig.indexName - Query Suggestions index name.
347
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
348
+ * @see deleteConfig for the plain version.
349
+ */
350
+ deleteConfigWithHTTPInfo({ indexName }, requestOptions) {
351
+ validateRequired("indexName", "deleteConfigWithHTTPInfo", indexName);
352
+ const requestPath = "/1/configs/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
353
+ const headers = {};
354
+ const queryParameters = {};
355
+ const request = {
356
+ method: "DELETE",
357
+ path: requestPath,
358
+ queryParameters,
359
+ headers
360
+ };
361
+ return transporter.requestWithHttpInfo(request, requestOptions);
362
+ },
217
363
  /**
218
364
  * Retrieves all Query Suggestions configurations of your Algolia application.
219
365
  *
@@ -233,6 +379,28 @@ function createQuerySuggestionsClient({
233
379
  };
234
380
  return transporter.request(request, requestOptions);
235
381
  },
382
+ /**
383
+ * Retrieves all Query Suggestions configurations of your Algolia application.
384
+ *
385
+ * 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.
386
+ *
387
+ * Required API Key ACLs:
388
+ * - settings
389
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
390
+ * @see getAllConfigs for the plain version.
391
+ */
392
+ getAllConfigsWithHTTPInfo(requestOptions) {
393
+ const requestPath = "/1/configs";
394
+ const headers = {};
395
+ const queryParameters = {};
396
+ const request = {
397
+ method: "GET",
398
+ path: requestPath,
399
+ queryParameters,
400
+ headers
401
+ };
402
+ return transporter.requestWithHttpInfo(request, requestOptions);
403
+ },
236
404
  /**
237
405
  * Retrieves a single Query Suggestions configuration by its index name.
238
406
  *
@@ -255,6 +423,31 @@ function createQuerySuggestionsClient({
255
423
  };
256
424
  return transporter.request(request, requestOptions);
257
425
  },
426
+ /**
427
+ * Retrieves a single Query Suggestions configuration by its index name.
428
+ *
429
+ * 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.
430
+ *
431
+ * Required API Key ACLs:
432
+ * - settings
433
+ * @param getConfig - The getConfig object.
434
+ * @param getConfig.indexName - Query Suggestions index name.
435
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
436
+ * @see getConfig for the plain version.
437
+ */
438
+ getConfigWithHTTPInfo({ indexName }, requestOptions) {
439
+ validateRequired("indexName", "getConfigWithHTTPInfo", indexName);
440
+ const requestPath = "/1/configs/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
441
+ const headers = {};
442
+ const queryParameters = {};
443
+ const request = {
444
+ method: "GET",
445
+ path: requestPath,
446
+ queryParameters,
447
+ headers
448
+ };
449
+ return transporter.requestWithHttpInfo(request, requestOptions);
450
+ },
258
451
  /**
259
452
  * Reports the status of a Query Suggestions index.
260
453
  *
@@ -277,6 +470,31 @@ function createQuerySuggestionsClient({
277
470
  };
278
471
  return transporter.request(request, requestOptions);
279
472
  },
473
+ /**
474
+ * Reports the status of a Query Suggestions index.
475
+ *
476
+ * 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.
477
+ *
478
+ * Required API Key ACLs:
479
+ * - settings
480
+ * @param getConfigStatus - The getConfigStatus object.
481
+ * @param getConfigStatus.indexName - Query Suggestions index name.
482
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
483
+ * @see getConfigStatus for the plain version.
484
+ */
485
+ getConfigStatusWithHTTPInfo({ indexName }, requestOptions) {
486
+ validateRequired("indexName", "getConfigStatusWithHTTPInfo", indexName);
487
+ const requestPath = "/1/configs/{indexName}/status".replace("{indexName}", encodeURIComponent(indexName));
488
+ const headers = {};
489
+ const queryParameters = {};
490
+ const request = {
491
+ method: "GET",
492
+ path: requestPath,
493
+ queryParameters,
494
+ headers
495
+ };
496
+ return transporter.requestWithHttpInfo(request, requestOptions);
497
+ },
280
498
  /**
281
499
  * Retrieves the logs for a single Query Suggestions index.
282
500
  *
@@ -299,6 +517,31 @@ function createQuerySuggestionsClient({
299
517
  };
300
518
  return transporter.request(request, requestOptions);
301
519
  },
520
+ /**
521
+ * Retrieves the logs for a single Query Suggestions index.
522
+ *
523
+ * 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.
524
+ *
525
+ * Required API Key ACLs:
526
+ * - settings
527
+ * @param getLogFile - The getLogFile object.
528
+ * @param getLogFile.indexName - Query Suggestions index name.
529
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
530
+ * @see getLogFile for the plain version.
531
+ */
532
+ getLogFileWithHTTPInfo({ indexName }, requestOptions) {
533
+ validateRequired("indexName", "getLogFileWithHTTPInfo", indexName);
534
+ const requestPath = "/1/logs/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
535
+ const headers = {};
536
+ const queryParameters = {};
537
+ const request = {
538
+ method: "GET",
539
+ path: requestPath,
540
+ queryParameters,
541
+ headers
542
+ };
543
+ return transporter.requestWithHttpInfo(request, requestOptions);
544
+ },
302
545
  /**
303
546
  * Updates a QuerySuggestions configuration.
304
547
  *
@@ -324,6 +567,35 @@ function createQuerySuggestionsClient({
324
567
  data: configuration
325
568
  };
326
569
  return transporter.request(request, requestOptions);
570
+ },
571
+ /**
572
+ * Updates a QuerySuggestions configuration.
573
+ *
574
+ * 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.
575
+ *
576
+ * Required API Key ACLs:
577
+ * - editSettings
578
+ * @param updateConfig - The updateConfig object.
579
+ * @param updateConfig.indexName - Query Suggestions index name.
580
+ * @param updateConfig.configuration - The configuration object.
581
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
582
+ * @see updateConfig for the plain version.
583
+ */
584
+ updateConfigWithHTTPInfo({ indexName, configuration }, requestOptions) {
585
+ validateRequired("indexName", "updateConfigWithHTTPInfo", indexName);
586
+ validateRequired("configuration", "updateConfigWithHTTPInfo", configuration);
587
+ validateRequired("configuration.sourceIndices", "updateConfigWithHTTPInfo", configuration.sourceIndices);
588
+ const requestPath = "/1/configs/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
589
+ const headers = {};
590
+ const queryParameters = {};
591
+ const request = {
592
+ method: "PUT",
593
+ path: requestPath,
594
+ queryParameters,
595
+ headers,
596
+ data: configuration
597
+ };
598
+ return transporter.requestWithHttpInfo(request, requestOptions);
327
599
  }
328
600
  };
329
601
  }