/
querySuggestionsClient.ts
499 lines (441 loc) · 15.8 KB
/
querySuggestionsClient.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
// 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.
import {
createAuth,
createTransporter,
getAlgoliaAgent,
} from '@algolia/client-common';
import type {
CreateClientOptions,
Headers,
Host,
Request,
RequestOptions,
QueryParameters,
} from '@algolia/client-common';
import type { BaseResponse } from '../model/baseResponse';
import type {
CustomDeleteProps,
CustomGetProps,
CustomPostProps,
CustomPutProps,
DeleteConfigProps,
GetConfigProps,
GetConfigStatusProps,
GetLogFileProps,
UpdateConfigProps,
} from '../model/clientMethodProps';
import type { GetConfigStatus200Response } from '../model/getConfigStatus200Response';
import type { GetLogFile200Response } from '../model/getLogFile200Response';
import type { QuerySuggestionsConfigurationResponse } from '../model/querySuggestionsConfigurationResponse';
import type { QuerySuggestionsConfigurationWithIndex } from '../model/querySuggestionsConfigurationWithIndex';
export const apiClientVersion = '5.0.0-alpha.96';
export const REGIONS = ['eu', 'us'] as const;
export type Region = (typeof REGIONS)[number];
function getDefaultHosts(region: Region): Host[] {
const url = 'query-suggestions.{region}.algolia.com'.replace(
'{region}',
region
);
return [{ url, accept: 'readWrite', protocol: 'https' }];
}
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
export function createQuerySuggestionsClient({
appId: appIdOption,
apiKey: apiKeyOption,
authMode,
algoliaAgents,
region: regionOption,
...options
}: CreateClientOptions & { region: Region }) {
const auth = createAuth(appIdOption, apiKeyOption, authMode);
const transporter = createTransporter({
hosts: getDefaultHosts(regionOption),
...options,
algoliaAgent: getAlgoliaAgent({
algoliaAgents,
client: 'QuerySuggestions',
version: apiClientVersion,
}),
baseHeaders: {
'content-type': 'text/plain',
...auth.headers(),
...options.baseHeaders,
},
baseQueryParameters: {
...auth.queryParameters(),
...options.baseQueryParameters,
},
});
return {
transporter,
/**
* The `appId` currently in use.
*/
appId: appIdOption,
/**
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
*/
clearCache(): Promise<void> {
return Promise.all([
transporter.requestsCache.clear(),
transporter.responsesCache.clear(),
]).then(() => undefined);
},
/**
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
*/
get _ua(): string {
return transporter.algoliaAgent.value;
},
/**
* Adds a `segment` to the `x-algolia-agent` sent with every requests.
*
* @param segment - The algolia agent (user-agent) segment to add.
* @param version - The version of the agent.
*/
addAlgoliaAgent(segment: string, version?: string): void {
transporter.algoliaAgent.add({ segment, version });
},
/**
* Create a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.
*
* @summary Create a configuration.
* @param querySuggestionsConfigurationWithIndex - The querySuggestionsConfigurationWithIndex object.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
createConfig(
querySuggestionsConfigurationWithIndex: QuerySuggestionsConfigurationWithIndex,
requestOptions?: RequestOptions
): Promise<BaseResponse> {
if (!querySuggestionsConfigurationWithIndex) {
throw new Error(
'Parameter `querySuggestionsConfigurationWithIndex` is required when calling `createConfig`.'
);
}
const requestPath = '/1/configs';
const headers: Headers = {};
const queryParameters: QueryParameters = {};
const request: Request = {
method: 'POST',
path: requestPath,
queryParameters,
headers,
data: querySuggestionsConfigurationWithIndex,
};
return transporter.request(request, requestOptions);
},
/**
* This method allow you to send requests to the Algolia REST API.
*
* @summary Send requests to the Algolia REST API.
* @param customDelete - The customDelete object.
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
* @param customDelete.parameters - Query parameters to apply to the current query.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
customDelete(
{ path, parameters }: CustomDeleteProps,
requestOptions?: RequestOptions
): Promise<Record<string, any>> {
if (!path) {
throw new Error(
'Parameter `path` is required when calling `customDelete`.'
);
}
const requestPath = '/1{path}'.replace('{path}', path);
const headers: Headers = {};
const queryParameters: QueryParameters = parameters ? parameters : {};
const request: Request = {
method: 'DELETE',
path: requestPath,
queryParameters,
headers,
};
return transporter.request(request, requestOptions);
},
/**
* This method allow you to send requests to the Algolia REST API.
*
* @summary Send requests to the Algolia REST API.
* @param customGet - The customGet object.
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
* @param customGet.parameters - Query parameters to apply to the current query.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
customGet(
{ path, parameters }: CustomGetProps,
requestOptions?: RequestOptions
): Promise<Record<string, any>> {
if (!path) {
throw new Error(
'Parameter `path` is required when calling `customGet`.'
);
}
const requestPath = '/1{path}'.replace('{path}', path);
const headers: Headers = {};
const queryParameters: QueryParameters = parameters ? parameters : {};
const request: Request = {
method: 'GET',
path: requestPath,
queryParameters,
headers,
};
return transporter.request(request, requestOptions);
},
/**
* This method allow you to send requests to the Algolia REST API.
*
* @summary Send requests to the Algolia REST API.
* @param customPost - The customPost object.
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
* @param customPost.parameters - Query parameters to apply to the current query.
* @param customPost.body - Parameters to send with the custom request.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
customPost(
{ path, parameters, body }: CustomPostProps,
requestOptions?: RequestOptions
): Promise<Record<string, any>> {
if (!path) {
throw new Error(
'Parameter `path` is required when calling `customPost`.'
);
}
const requestPath = '/1{path}'.replace('{path}', path);
const headers: Headers = {};
const queryParameters: QueryParameters = parameters ? parameters : {};
const request: Request = {
method: 'POST',
path: requestPath,
queryParameters,
headers,
data: body ? body : {},
};
return transporter.request(request, requestOptions);
},
/**
* This method allow you to send requests to the Algolia REST API.
*
* @summary Send requests to the Algolia REST API.
* @param customPut - The customPut object.
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
* @param customPut.parameters - Query parameters to apply to the current query.
* @param customPut.body - Parameters to send with the custom request.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
customPut(
{ path, parameters, body }: CustomPutProps,
requestOptions?: RequestOptions
): Promise<Record<string, any>> {
if (!path) {
throw new Error(
'Parameter `path` is required when calling `customPut`.'
);
}
const requestPath = '/1{path}'.replace('{path}', path);
const headers: Headers = {};
const queryParameters: QueryParameters = parameters ? parameters : {};
const request: Request = {
method: 'PUT',
path: requestPath,
queryParameters,
headers,
data: body ? body : {},
};
return transporter.request(request, requestOptions);
},
/**
* Delete a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.
*
* @summary Delete a configuration.
* @param deleteConfig - The deleteConfig object.
* @param deleteConfig.indexName - Query Suggestions index name.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
deleteConfig(
{ indexName }: DeleteConfigProps,
requestOptions?: RequestOptions
): Promise<BaseResponse> {
if (!indexName) {
throw new Error(
'Parameter `indexName` is required when calling `deleteConfig`.'
);
}
const requestPath = '/1/configs/{indexName}'.replace(
'{indexName}',
encodeURIComponent(indexName)
);
const headers: Headers = {};
const queryParameters: QueryParameters = {};
const request: Request = {
method: 'DELETE',
path: requestPath,
queryParameters,
headers,
};
return transporter.request(request, requestOptions);
},
/**
* List all Query Suggestions configurations of your Algolia application.
*
* @summary List configurations.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
getAllConfigs(
requestOptions?: RequestOptions
): Promise<QuerySuggestionsConfigurationResponse[]> {
const requestPath = '/1/configs';
const headers: Headers = {};
const queryParameters: QueryParameters = {};
const request: Request = {
method: 'GET',
path: requestPath,
queryParameters,
headers,
};
return transporter.request(request, requestOptions);
},
/**
* Get a single Query Suggestions configuration.
*
* @summary Get a configuration.
* @param getConfig - The getConfig object.
* @param getConfig.indexName - Query Suggestions index name.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
getConfig(
{ indexName }: GetConfigProps,
requestOptions?: RequestOptions
): Promise<QuerySuggestionsConfigurationResponse> {
if (!indexName) {
throw new Error(
'Parameter `indexName` is required when calling `getConfig`.'
);
}
const requestPath = '/1/configs/{indexName}'.replace(
'{indexName}',
encodeURIComponent(indexName)
);
const headers: Headers = {};
const queryParameters: QueryParameters = {};
const request: Request = {
method: 'GET',
path: requestPath,
queryParameters,
headers,
};
return transporter.request(request, requestOptions);
},
/**
* Report the status of a Query Suggestions index.
*
* @summary Get configuration status.
* @param getConfigStatus - The getConfigStatus object.
* @param getConfigStatus.indexName - Query Suggestions index name.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
getConfigStatus(
{ indexName }: GetConfigStatusProps,
requestOptions?: RequestOptions
): Promise<GetConfigStatus200Response> {
if (!indexName) {
throw new Error(
'Parameter `indexName` is required when calling `getConfigStatus`.'
);
}
const requestPath = '/1/configs/{indexName}/status'.replace(
'{indexName}',
encodeURIComponent(indexName)
);
const headers: Headers = {};
const queryParameters: QueryParameters = {};
const request: Request = {
method: 'GET',
path: requestPath,
queryParameters,
headers,
};
return transporter.request(request, requestOptions);
},
/**
* Get the logs for a single Query Suggestions index.
*
* @summary Get logs.
* @param getLogFile - The getLogFile object.
* @param getLogFile.indexName - Query Suggestions index name.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
getLogFile(
{ indexName }: GetLogFileProps,
requestOptions?: RequestOptions
): Promise<GetLogFile200Response> {
if (!indexName) {
throw new Error(
'Parameter `indexName` is required when calling `getLogFile`.'
);
}
const requestPath = '/1/logs/{indexName}'.replace(
'{indexName}',
encodeURIComponent(indexName)
);
const headers: Headers = {};
const queryParameters: QueryParameters = {};
const request: Request = {
method: 'GET',
path: requestPath,
queryParameters,
headers,
};
return transporter.request(request, requestOptions);
},
/**
* Update a QuerySuggestions configuration.
*
* @summary Update a configuration.
* @param updateConfig - The updateConfig object.
* @param updateConfig.indexName - Query Suggestions index name.
* @param updateConfig.querySuggestionsConfiguration - The querySuggestionsConfiguration object.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
updateConfig(
{ indexName, querySuggestionsConfiguration }: UpdateConfigProps,
requestOptions?: RequestOptions
): Promise<BaseResponse> {
if (!indexName) {
throw new Error(
'Parameter `indexName` is required when calling `updateConfig`.'
);
}
if (!querySuggestionsConfiguration) {
throw new Error(
'Parameter `querySuggestionsConfiguration` is required when calling `updateConfig`.'
);
}
if (!querySuggestionsConfiguration.sourceIndices) {
throw new Error(
'Parameter `querySuggestionsConfiguration.sourceIndices` is required when calling `updateConfig`.'
);
}
const requestPath = '/1/configs/{indexName}'.replace(
'{indexName}',
encodeURIComponent(indexName)
);
const headers: Headers = {};
const queryParameters: QueryParameters = {};
const request: Request = {
method: 'PUT',
path: requestPath,
queryParameters,
headers,
data: querySuggestionsConfiguration,
};
return transporter.request(request, requestOptions);
},
};
}
/**
* The client type.
*/
export type QuerySuggestionsClient = ReturnType<
typeof createQuerySuggestionsClient
>;