@algolia/client-query-suggestions 5.0.0-alpha.7 → 5.0.0-alpha.71
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/dist/builds/browser.d.ts +5 -5
- package/dist/builds/browser.d.ts.map +1 -1
- package/dist/builds/node.d.ts +5 -5
- package/dist/builds/node.d.ts.map +1 -1
- package/dist/client-query-suggestions.cjs.js +351 -353
- package/dist/client-query-suggestions.esm.browser.js +534 -584
- package/dist/client-query-suggestions.esm.node.js +351 -353
- package/dist/client-query-suggestions.umd.js +2 -2
- package/dist/model/clientMethodProps.d.ts +107 -107
- package/dist/model/clientMethodProps.d.ts.map +1 -1
- package/dist/model/errorBase.d.ts +6 -6
- package/dist/model/errorBase.d.ts.map +1 -1
- package/dist/model/index.d.ts +13 -13
- package/dist/model/index.d.ts.map +1 -1
- package/dist/model/indexName.d.ts +6 -6
- package/dist/model/indexName.d.ts.map +1 -1
- package/dist/model/logFile.d.ts +16 -16
- package/dist/model/logFile.d.ts.map +1 -1
- package/dist/model/logLevel.d.ts +4 -4
- package/dist/model/logLevel.d.ts.map +1 -1
- package/dist/model/querySuggestionsIndex.d.ts +19 -19
- package/dist/model/querySuggestionsIndex.d.ts.map +1 -1
- package/dist/model/querySuggestionsIndexParam.d.ts +15 -15
- package/dist/model/querySuggestionsIndexParam.d.ts.map +1 -1
- package/dist/model/querySuggestionsIndexWithIndexParam.d.ts +3 -3
- package/dist/model/querySuggestionsIndexWithIndexParam.d.ts.map +1 -1
- package/dist/model/sourceIndex.d.ts +31 -31
- package/dist/model/sourceIndex.d.ts.map +1 -1
- package/dist/model/sourceIndexExternal.d.ts +10 -10
- package/dist/model/sourceIndexExternal.d.ts.map +1 -1
- package/dist/model/sourceIndexWithReplicas.d.ts +38 -38
- package/dist/model/sourceIndexWithReplicas.d.ts.map +1 -1
- package/dist/model/status.d.ts +14 -14
- package/dist/model/status.d.ts.map +1 -1
- package/dist/model/successResponse.d.ts +10 -10
- package/dist/model/successResponse.d.ts.map +1 -1
- package/dist/src/querySuggestionsClient.d.ts +141 -141
- package/dist/src/querySuggestionsClient.d.ts.map +1 -1
- package/model/clientMethodProps.ts +1 -1
- package/model/errorBase.ts +1 -1
- package/model/index.ts +1 -1
- package/model/indexName.ts +1 -1
- package/model/logFile.ts +1 -1
- package/model/logLevel.ts +1 -1
- package/model/querySuggestionsIndex.ts +1 -1
- package/model/querySuggestionsIndexParam.ts +1 -1
- package/model/querySuggestionsIndexWithIndexParam.ts +1 -1
- package/model/sourceIndex.ts +1 -1
- package/model/sourceIndexExternal.ts +1 -1
- package/model/sourceIndexWithReplicas.ts +1 -1
- package/model/status.ts +1 -1
- package/model/successResponse.ts +1 -1
- package/package.json +31 -13
|
@@ -1,39 +1,39 @@
|
|
|
1
|
-
import type { SourceIndexExternal } from './sourceIndexExternal';
|
|
2
|
-
/**
|
|
3
|
-
* Source index with replicas used to generate a Query Suggestions index.
|
|
4
|
-
*/
|
|
5
|
-
export
|
|
6
|
-
/**
|
|
7
|
-
* True if the Query Suggestions index is a replicas.
|
|
8
|
-
*/
|
|
9
|
-
replicas: boolean;
|
|
10
|
-
/**
|
|
11
|
-
* Source index name.
|
|
12
|
-
*/
|
|
13
|
-
indexName: string;
|
|
14
|
-
/**
|
|
15
|
-
* List of analytics tags to filter the popular searches per tag.
|
|
16
|
-
*/
|
|
17
|
-
analyticsTags: string[];
|
|
18
|
-
/**
|
|
19
|
-
* List of facets to define as categories for the query suggestions.
|
|
20
|
-
*/
|
|
21
|
-
facets: Array<Record<string, any>>;
|
|
22
|
-
/**
|
|
23
|
-
* Minimum number of hits (e.g., matching records in the source index) to generate a suggestions.
|
|
24
|
-
*/
|
|
25
|
-
minHits: number;
|
|
26
|
-
/**
|
|
27
|
-
* Minimum number of required letters for a suggestion to remain.
|
|
28
|
-
*/
|
|
29
|
-
minLetters: number;
|
|
30
|
-
/**
|
|
31
|
-
* List of facet attributes used to generate Query Suggestions. The resulting suggestions are every combination of the facets in the nested list (e.g., (facetA and facetB) and facetC).
|
|
32
|
-
*/
|
|
33
|
-
generate: string[][];
|
|
34
|
-
/**
|
|
35
|
-
* List of external indices to use to generate custom Query Suggestions.
|
|
36
|
-
*/
|
|
37
|
-
external: SourceIndexExternal[];
|
|
38
|
-
};
|
|
1
|
+
import type { SourceIndexExternal } from './sourceIndexExternal';
|
|
2
|
+
/**
|
|
3
|
+
* Source index with replicas used to generate a Query Suggestions index.
|
|
4
|
+
*/
|
|
5
|
+
export type SourceIndexWithReplicas = {
|
|
6
|
+
/**
|
|
7
|
+
* True if the Query Suggestions index is a replicas.
|
|
8
|
+
*/
|
|
9
|
+
replicas: boolean;
|
|
10
|
+
/**
|
|
11
|
+
* Source index name.
|
|
12
|
+
*/
|
|
13
|
+
indexName: string;
|
|
14
|
+
/**
|
|
15
|
+
* List of analytics tags to filter the popular searches per tag.
|
|
16
|
+
*/
|
|
17
|
+
analyticsTags: string[];
|
|
18
|
+
/**
|
|
19
|
+
* List of facets to define as categories for the query suggestions.
|
|
20
|
+
*/
|
|
21
|
+
facets: Array<Record<string, any>>;
|
|
22
|
+
/**
|
|
23
|
+
* Minimum number of hits (e.g., matching records in the source index) to generate a suggestions.
|
|
24
|
+
*/
|
|
25
|
+
minHits: number;
|
|
26
|
+
/**
|
|
27
|
+
* Minimum number of required letters for a suggestion to remain.
|
|
28
|
+
*/
|
|
29
|
+
minLetters: number;
|
|
30
|
+
/**
|
|
31
|
+
* List of facet attributes used to generate Query Suggestions. The resulting suggestions are every combination of the facets in the nested list (e.g., (facetA and facetB) and facetC).
|
|
32
|
+
*/
|
|
33
|
+
generate: string[][];
|
|
34
|
+
/**
|
|
35
|
+
* List of external indices to use to generate custom Query Suggestions.
|
|
36
|
+
*/
|
|
37
|
+
external: SourceIndexExternal[];
|
|
38
|
+
};
|
|
39
39
|
//# sourceMappingURL=sourceIndexWithReplicas.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sourceIndexWithReplicas.d.ts","sourceRoot":"","sources":["
|
|
1
|
+
{"version":3,"file":"sourceIndexWithReplicas.d.ts","sourceRoot":"","sources":["../../model/sourceIndexWithReplicas.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IAEnC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,mBAAmB,EAAE,CAAC;CACjC,CAAC"}
|
package/dist/model/status.d.ts
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
export
|
|
2
|
-
/**
|
|
3
|
-
* The targeted index name.
|
|
4
|
-
*/
|
|
5
|
-
indexName: string;
|
|
6
|
-
/**
|
|
7
|
-
* True if the Query Suggestions index is running.
|
|
8
|
-
*/
|
|
9
|
-
isRunning: boolean;
|
|
10
|
-
/**
|
|
11
|
-
* Date and time of the last build.
|
|
12
|
-
*/
|
|
13
|
-
lastBuiltAt: string;
|
|
14
|
-
};
|
|
1
|
+
export type Status = {
|
|
2
|
+
/**
|
|
3
|
+
* The targeted index name.
|
|
4
|
+
*/
|
|
5
|
+
indexName: string;
|
|
6
|
+
/**
|
|
7
|
+
* True if the Query Suggestions index is running.
|
|
8
|
+
*/
|
|
9
|
+
isRunning: boolean;
|
|
10
|
+
/**
|
|
11
|
+
* Date and time of the last build.
|
|
12
|
+
*/
|
|
13
|
+
lastBuiltAt: string;
|
|
14
|
+
};
|
|
15
15
|
//# sourceMappingURL=status.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"status.d.ts","sourceRoot":"","sources":["
|
|
1
|
+
{"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../model/status.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC"}
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
export
|
|
2
|
-
/**
|
|
3
|
-
* The status code.
|
|
4
|
-
*/
|
|
5
|
-
status: number;
|
|
6
|
-
/**
|
|
7
|
-
* Message of the response.
|
|
8
|
-
*/
|
|
9
|
-
message: string;
|
|
10
|
-
};
|
|
1
|
+
export type SuccessResponse = {
|
|
2
|
+
/**
|
|
3
|
+
* The status code.
|
|
4
|
+
*/
|
|
5
|
+
status: number;
|
|
6
|
+
/**
|
|
7
|
+
* Message of the response.
|
|
8
|
+
*/
|
|
9
|
+
message: string;
|
|
10
|
+
};
|
|
11
11
|
//# sourceMappingURL=successResponse.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"successResponse.d.ts","sourceRoot":"","sources":["
|
|
1
|
+
{"version":3,"file":"successResponse.d.ts","sourceRoot":"","sources":["../../model/successResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}
|
|
@@ -1,142 +1,142 @@
|
|
|
1
|
-
import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
|
|
2
|
-
import type { DelProps, DeleteConfigProps, GetProps, GetConfigProps, GetConfigStatusProps, GetLogFileProps, PostProps, PutProps, UpdateConfigProps } from '../model/clientMethodProps';
|
|
3
|
-
import type { LogFile } from '../model/logFile';
|
|
4
|
-
import type { QuerySuggestionsIndex } from '../model/querySuggestionsIndex';
|
|
5
|
-
import type { QuerySuggestionsIndexWithIndexParam } from '../model/querySuggestionsIndexWithIndexParam';
|
|
6
|
-
import type { Status } from '../model/status';
|
|
7
|
-
import type { SuccessResponse } from '../model/successResponse';
|
|
8
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
9
|
-
export declare const REGIONS: readonly ["eu", "us"];
|
|
10
|
-
export
|
|
11
|
-
export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
|
|
12
|
-
region: Region;
|
|
13
|
-
}): {
|
|
14
|
-
transporter: import("@algolia/client-common").Transporter;
|
|
15
|
-
/**
|
|
16
|
-
* The `appId` currently in use.
|
|
17
|
-
*/
|
|
18
|
-
appId: string;
|
|
19
|
-
/**
|
|
20
|
-
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
|
|
21
|
-
*/
|
|
22
|
-
clearCache(): Promise<void>;
|
|
23
|
-
/**
|
|
24
|
-
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
|
|
25
|
-
*/
|
|
26
|
-
readonly _ua: string;
|
|
27
|
-
/**
|
|
28
|
-
* Adds a `segment` to the `x-algolia-agent` sent with every requests.
|
|
29
|
-
*
|
|
30
|
-
* @param segment - The algolia agent (user-agent) segment to add.
|
|
31
|
-
* @param version - The version of the agent.
|
|
32
|
-
*/
|
|
33
|
-
addAlgoliaAgent(segment: string, version?: string): void;
|
|
34
|
-
/**
|
|
35
|
-
* Create a configuration of a Query Suggestions index. There\'s a limit of 100 configurations per application.
|
|
36
|
-
*
|
|
37
|
-
* @summary Create a configuration.
|
|
38
|
-
* @param querySuggestionsIndexWithIndexParam - The querySuggestionsIndexWithIndexParam object.
|
|
39
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
40
|
-
*/
|
|
41
|
-
createConfig(querySuggestionsIndexWithIndexParam: QuerySuggestionsIndexWithIndexParam, requestOptions?: RequestOptions): Promise<SuccessResponse>;
|
|
42
|
-
/**
|
|
43
|
-
* This method allow you to send requests to the Algolia REST API.
|
|
44
|
-
*
|
|
45
|
-
* @summary Send requests to the Algolia REST API.
|
|
46
|
-
* @param del - The del object.
|
|
47
|
-
* @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
|
|
48
|
-
* @param del.parameters - Query parameters to be applied to the current query.
|
|
49
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
50
|
-
*/
|
|
51
|
-
del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
52
|
-
/**
|
|
53
|
-
* Delete a configuration of a Query Suggestion\'s index. By deleting a configuration, you stop all updates to the underlying query suggestion index. Note that when doing this, the underlying index does not change - existing suggestions remain untouched.
|
|
54
|
-
*
|
|
55
|
-
* @summary Delete a configuration.
|
|
56
|
-
* @param deleteConfig - The deleteConfig object.
|
|
57
|
-
* @param deleteConfig.indexName - The index in which to perform the request.
|
|
58
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
59
|
-
*/
|
|
60
|
-
deleteConfig({ indexName }: DeleteConfigProps, requestOptions?: RequestOptions): Promise<SuccessResponse>;
|
|
61
|
-
/**
|
|
62
|
-
* This method allow you to send requests to the Algolia REST API.
|
|
63
|
-
*
|
|
64
|
-
* @summary Send requests to the Algolia REST API.
|
|
65
|
-
* @param get - The get object.
|
|
66
|
-
* @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
|
|
67
|
-
* @param get.parameters - Query parameters to be applied to the current query.
|
|
68
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
69
|
-
*/
|
|
70
|
-
get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
71
|
-
/**
|
|
72
|
-
* Get all the configurations of Query Suggestions. For each index, you get a block of JSON with a list of its configuration settings.
|
|
73
|
-
*
|
|
74
|
-
* @summary List configurations.
|
|
75
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
76
|
-
*/
|
|
77
|
-
getAllConfigs(requestOptions?: RequestOptions): Promise<QuerySuggestionsIndex[]>;
|
|
78
|
-
/**
|
|
79
|
-
* Get the configuration of a single Query Suggestions index.
|
|
80
|
-
*
|
|
81
|
-
* @summary Get a single configuration.
|
|
82
|
-
* @param getConfig - The getConfig object.
|
|
83
|
-
* @param getConfig.indexName - The index in which to perform the request.
|
|
84
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
85
|
-
*/
|
|
86
|
-
getConfig({ indexName }: GetConfigProps, requestOptions?: RequestOptions): Promise<QuerySuggestionsIndex>;
|
|
87
|
-
/**
|
|
88
|
-
* Get the status of a Query Suggestion\'s index. The status includes whether the Query Suggestions index is currently in the process of being built, and the last build time.
|
|
89
|
-
*
|
|
90
|
-
* @summary Get configuration status.
|
|
91
|
-
* @param getConfigStatus - The getConfigStatus object.
|
|
92
|
-
* @param getConfigStatus.indexName - The index in which to perform the request.
|
|
93
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
94
|
-
*/
|
|
95
|
-
getConfigStatus({ indexName }: GetConfigStatusProps, requestOptions?: RequestOptions): Promise<Status>;
|
|
96
|
-
/**
|
|
97
|
-
* Get the log file of the last build of a single Query Suggestion index.
|
|
98
|
-
*
|
|
99
|
-
* @summary Get a log file.
|
|
100
|
-
* @param getLogFile - The getLogFile object.
|
|
101
|
-
* @param getLogFile.indexName - The index in which to perform the request.
|
|
102
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
103
|
-
*/
|
|
104
|
-
getLogFile({ indexName }: GetLogFileProps, requestOptions?: RequestOptions): Promise<LogFile[]>;
|
|
105
|
-
/**
|
|
106
|
-
* This method allow you to send requests to the Algolia REST API.
|
|
107
|
-
*
|
|
108
|
-
* @summary Send requests to the Algolia REST API.
|
|
109
|
-
* @param post - The post object.
|
|
110
|
-
* @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
|
|
111
|
-
* @param post.parameters - Query parameters to be applied to the current query.
|
|
112
|
-
* @param post.body - The parameters to send with the custom request.
|
|
113
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
114
|
-
*/
|
|
115
|
-
post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
116
|
-
/**
|
|
117
|
-
* This method allow you to send requests to the Algolia REST API.
|
|
118
|
-
*
|
|
119
|
-
* @summary Send requests to the Algolia REST API.
|
|
120
|
-
* @param put - The put object.
|
|
121
|
-
* @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
|
|
122
|
-
* @param put.parameters - Query parameters to be applied to the current query.
|
|
123
|
-
* @param put.body - The parameters to send with the custom request.
|
|
124
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
125
|
-
*/
|
|
126
|
-
put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
127
|
-
/**
|
|
128
|
-
* Update the configuration of a Query Suggestions index.
|
|
129
|
-
*
|
|
130
|
-
* @summary Update a configuration.
|
|
131
|
-
* @param updateConfig - The updateConfig object.
|
|
132
|
-
* @param updateConfig.indexName - The index in which to perform the request.
|
|
133
|
-
* @param updateConfig.querySuggestionsIndexParam - The querySuggestionsIndexParam object.
|
|
134
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
135
|
-
*/
|
|
136
|
-
updateConfig({ indexName, querySuggestionsIndexParam }: UpdateConfigProps, requestOptions?: RequestOptions): Promise<SuccessResponse>;
|
|
137
|
-
};
|
|
138
|
-
/**
|
|
139
|
-
* The client type.
|
|
140
|
-
*/
|
|
141
|
-
export
|
|
1
|
+
import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
|
|
2
|
+
import type { DelProps, DeleteConfigProps, GetProps, GetConfigProps, GetConfigStatusProps, GetLogFileProps, PostProps, PutProps, UpdateConfigProps } from '../model/clientMethodProps';
|
|
3
|
+
import type { LogFile } from '../model/logFile';
|
|
4
|
+
import type { QuerySuggestionsIndex } from '../model/querySuggestionsIndex';
|
|
5
|
+
import type { QuerySuggestionsIndexWithIndexParam } from '../model/querySuggestionsIndexWithIndexParam';
|
|
6
|
+
import type { Status } from '../model/status';
|
|
7
|
+
import type { SuccessResponse } from '../model/successResponse';
|
|
8
|
+
export declare const apiClientVersion = "5.0.0-alpha.71";
|
|
9
|
+
export declare const REGIONS: readonly ["eu", "us"];
|
|
10
|
+
export type Region = (typeof REGIONS)[number];
|
|
11
|
+
export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
|
|
12
|
+
region: Region;
|
|
13
|
+
}): {
|
|
14
|
+
transporter: import("@algolia/client-common").Transporter;
|
|
15
|
+
/**
|
|
16
|
+
* The `appId` currently in use.
|
|
17
|
+
*/
|
|
18
|
+
appId: string;
|
|
19
|
+
/**
|
|
20
|
+
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
|
|
21
|
+
*/
|
|
22
|
+
clearCache(): Promise<void>;
|
|
23
|
+
/**
|
|
24
|
+
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
|
|
25
|
+
*/
|
|
26
|
+
readonly _ua: string;
|
|
27
|
+
/**
|
|
28
|
+
* Adds a `segment` to the `x-algolia-agent` sent with every requests.
|
|
29
|
+
*
|
|
30
|
+
* @param segment - The algolia agent (user-agent) segment to add.
|
|
31
|
+
* @param version - The version of the agent.
|
|
32
|
+
*/
|
|
33
|
+
addAlgoliaAgent(segment: string, version?: string): void;
|
|
34
|
+
/**
|
|
35
|
+
* Create a configuration of a Query Suggestions index. There\'s a limit of 100 configurations per application.
|
|
36
|
+
*
|
|
37
|
+
* @summary Create a configuration.
|
|
38
|
+
* @param querySuggestionsIndexWithIndexParam - The querySuggestionsIndexWithIndexParam object.
|
|
39
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
40
|
+
*/
|
|
41
|
+
createConfig(querySuggestionsIndexWithIndexParam: QuerySuggestionsIndexWithIndexParam, requestOptions?: RequestOptions): Promise<SuccessResponse>;
|
|
42
|
+
/**
|
|
43
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
44
|
+
*
|
|
45
|
+
* @summary Send requests to the Algolia REST API.
|
|
46
|
+
* @param del - The del object.
|
|
47
|
+
* @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
|
|
48
|
+
* @param del.parameters - Query parameters to be applied to the current query.
|
|
49
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
50
|
+
*/
|
|
51
|
+
del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
52
|
+
/**
|
|
53
|
+
* Delete a configuration of a Query Suggestion\'s index. By deleting a configuration, you stop all updates to the underlying query suggestion index. Note that when doing this, the underlying index does not change - existing suggestions remain untouched.
|
|
54
|
+
*
|
|
55
|
+
* @summary Delete a configuration.
|
|
56
|
+
* @param deleteConfig - The deleteConfig object.
|
|
57
|
+
* @param deleteConfig.indexName - The index in which to perform the request.
|
|
58
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
59
|
+
*/
|
|
60
|
+
deleteConfig({ indexName }: DeleteConfigProps, requestOptions?: RequestOptions): Promise<SuccessResponse>;
|
|
61
|
+
/**
|
|
62
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
63
|
+
*
|
|
64
|
+
* @summary Send requests to the Algolia REST API.
|
|
65
|
+
* @param get - The get object.
|
|
66
|
+
* @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
|
|
67
|
+
* @param get.parameters - Query parameters to be applied to the current query.
|
|
68
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
69
|
+
*/
|
|
70
|
+
get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
71
|
+
/**
|
|
72
|
+
* Get all the configurations of Query Suggestions. For each index, you get a block of JSON with a list of its configuration settings.
|
|
73
|
+
*
|
|
74
|
+
* @summary List configurations.
|
|
75
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
76
|
+
*/
|
|
77
|
+
getAllConfigs(requestOptions?: RequestOptions): Promise<QuerySuggestionsIndex[]>;
|
|
78
|
+
/**
|
|
79
|
+
* Get the configuration of a single Query Suggestions index.
|
|
80
|
+
*
|
|
81
|
+
* @summary Get a single configuration.
|
|
82
|
+
* @param getConfig - The getConfig object.
|
|
83
|
+
* @param getConfig.indexName - The index in which to perform the request.
|
|
84
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
85
|
+
*/
|
|
86
|
+
getConfig({ indexName }: GetConfigProps, requestOptions?: RequestOptions): Promise<QuerySuggestionsIndex>;
|
|
87
|
+
/**
|
|
88
|
+
* Get the status of a Query Suggestion\'s index. The status includes whether the Query Suggestions index is currently in the process of being built, and the last build time.
|
|
89
|
+
*
|
|
90
|
+
* @summary Get configuration status.
|
|
91
|
+
* @param getConfigStatus - The getConfigStatus object.
|
|
92
|
+
* @param getConfigStatus.indexName - The index in which to perform the request.
|
|
93
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
94
|
+
*/
|
|
95
|
+
getConfigStatus({ indexName }: GetConfigStatusProps, requestOptions?: RequestOptions): Promise<Status>;
|
|
96
|
+
/**
|
|
97
|
+
* Get the log file of the last build of a single Query Suggestion index.
|
|
98
|
+
*
|
|
99
|
+
* @summary Get a log file.
|
|
100
|
+
* @param getLogFile - The getLogFile object.
|
|
101
|
+
* @param getLogFile.indexName - The index in which to perform the request.
|
|
102
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
103
|
+
*/
|
|
104
|
+
getLogFile({ indexName }: GetLogFileProps, requestOptions?: RequestOptions): Promise<LogFile[]>;
|
|
105
|
+
/**
|
|
106
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
107
|
+
*
|
|
108
|
+
* @summary Send requests to the Algolia REST API.
|
|
109
|
+
* @param post - The post object.
|
|
110
|
+
* @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
|
|
111
|
+
* @param post.parameters - Query parameters to be applied to the current query.
|
|
112
|
+
* @param post.body - The parameters to send with the custom request.
|
|
113
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
114
|
+
*/
|
|
115
|
+
post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
116
|
+
/**
|
|
117
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
118
|
+
*
|
|
119
|
+
* @summary Send requests to the Algolia REST API.
|
|
120
|
+
* @param put - The put object.
|
|
121
|
+
* @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
|
|
122
|
+
* @param put.parameters - Query parameters to be applied to the current query.
|
|
123
|
+
* @param put.body - The parameters to send with the custom request.
|
|
124
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
125
|
+
*/
|
|
126
|
+
put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
127
|
+
/**
|
|
128
|
+
* Update the configuration of a Query Suggestions index.
|
|
129
|
+
*
|
|
130
|
+
* @summary Update a configuration.
|
|
131
|
+
* @param updateConfig - The updateConfig object.
|
|
132
|
+
* @param updateConfig.indexName - The index in which to perform the request.
|
|
133
|
+
* @param updateConfig.querySuggestionsIndexParam - The querySuggestionsIndexParam object.
|
|
134
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
135
|
+
*/
|
|
136
|
+
updateConfig({ indexName, querySuggestionsIndexParam }: UpdateConfigProps, requestOptions?: RequestOptions): Promise<SuccessResponse>;
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* The client type.
|
|
140
|
+
*/
|
|
141
|
+
export type QuerySuggestionsClient = ReturnType<typeof createQuerySuggestionsClient>;
|
|
142
142
|
//# sourceMappingURL=querySuggestionsClient.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"querySuggestionsClient.d.ts","sourceRoot":"","sources":["
|
|
1
|
+
{"version":3,"file":"querySuggestionsClient.d.ts","sourceRoot":"","sources":["../../src/querySuggestionsClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,SAAS,EACT,QAAQ,EACR,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,8CAA8C,CAAC;AACxG,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAEhE,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAY9C,wBAAgB,4BAA4B,CAAC,EAC3C,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAwBvC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;OAMG;sDAEoC,mCAAmC,mBACvD,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAsB3B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAwB3B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;OAKG;mCAEgB,cAAc,GAC9B,QAAQ,qBAAqB,EAAE,CAAC;IAenC;;;;;;;OAOG;6BAEc,cAAc,mBACZ,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAwBjC;;;;;;;OAOG;mCAEc,oBAAoB,mBAClB,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAwBlB;;;;;;;OAOG;8BAEc,eAAe,mBACb,cAAc,GAC9B,QAAQ,OAAO,EAAE,CAAC;IAwBrB;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;OAQG;4DAE0C,iBAAiB,mBAC3C,cAAc,GAC9B,QAAQ,eAAe,CAAC;EAqC9B;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAC7C,OAAO,4BAA4B,CACpC,CAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
import type { QuerySuggestionsIndexParam } from './querySuggestionsIndexParam';
|
|
4
4
|
|
package/model/errorBase.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Error.
|
package/model/index.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
export * from './errorBase';
|
|
4
4
|
export * from './indexName';
|
package/model/indexName.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
export type IndexName = {
|
|
4
4
|
/**
|
package/model/logFile.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
import type { LogLevel } from './logLevel';
|
|
4
4
|
|
package/model/logLevel.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Type of the record, can be one of three values (INFO, SKIP or ERROR).
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
import type { SourceIndexWithReplicas } from './sourceIndexWithReplicas';
|
|
4
4
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
import type { SourceIndex } from './sourceIndex';
|
|
4
4
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
import type { IndexName } from './indexName';
|
|
4
4
|
import type { QuerySuggestionsIndexParam } from './querySuggestionsIndexParam';
|
package/model/sourceIndex.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
import type { SourceIndexExternal } from './sourceIndexExternal';
|
|
4
4
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
export type SourceIndexExternal = {
|
|
4
4
|
/**
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
import type { SourceIndexExternal } from './sourceIndexExternal';
|
|
4
4
|
|
package/model/status.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
export type Status = {
|
|
4
4
|
/**
|
package/model/successResponse.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//
|
|
1
|
+
// 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.
|
|
2
2
|
|
|
3
3
|
export type SuccessResponse = {
|
|
4
4
|
/**
|
package/package.json
CHANGED
|
@@ -1,16 +1,32 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@algolia/client-query-suggestions",
|
|
3
|
-
"version": "5.0.0-alpha.
|
|
3
|
+
"version": "5.0.0-alpha.71",
|
|
4
4
|
"description": "JavaScript client for client-query-suggestions",
|
|
5
5
|
"repository": "algolia/algoliasearch-client-javascript",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"author": "Algolia",
|
|
8
|
-
"
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"node": {
|
|
11
|
+
"import": "./dist/client-query-suggestions.esm.node.js",
|
|
12
|
+
"module": "./dist/client-query-suggestions.esm.node.js",
|
|
13
|
+
"require": "./dist/client-query-suggestions.cjs.js",
|
|
14
|
+
"default": "./dist/client-query-suggestions.cjs.js"
|
|
15
|
+
},
|
|
16
|
+
"default": {
|
|
17
|
+
"umd": "./dist/client-query-suggestions.umd.js",
|
|
18
|
+
"module": "./dist/client-query-suggestions.esm.browser.js",
|
|
19
|
+
"import": "./dist/client-query-suggestions.esm.browser.js",
|
|
20
|
+
"default": "./dist/client-query-suggestions.umd.js"
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
"./src/*": "./src/*.ts",
|
|
24
|
+
"./model": "./model/index.ts"
|
|
25
|
+
},
|
|
26
|
+
"jsdelivr": "./dist/client-query-suggestions.umd.js",
|
|
27
|
+
"unpkg": "./dist/client-query-suggestions.umd.js",
|
|
28
|
+
"browser": "./dist/client-query-suggestions.umd.js",
|
|
29
|
+
"types": "./index.d.ts",
|
|
14
30
|
"files": [
|
|
15
31
|
"dist",
|
|
16
32
|
"model",
|
|
@@ -18,16 +34,18 @@
|
|
|
18
34
|
"index.d.ts"
|
|
19
35
|
],
|
|
20
36
|
"scripts": {
|
|
21
|
-
"
|
|
37
|
+
"build": "yarn clean && rollup --config",
|
|
38
|
+
"clean": "rm -rf ./dist || true"
|
|
22
39
|
},
|
|
23
40
|
"dependencies": {
|
|
24
|
-
"@algolia/client-common": "5.0.0-alpha.
|
|
25
|
-
"@algolia/requester-browser-xhr": "5.0.0-alpha.
|
|
26
|
-
"@algolia/requester-node-http": "5.0.0-alpha.
|
|
41
|
+
"@algolia/client-common": "5.0.0-alpha.71",
|
|
42
|
+
"@algolia/requester-browser-xhr": "5.0.0-alpha.71",
|
|
43
|
+
"@algolia/requester-node-http": "5.0.0-alpha.71"
|
|
27
44
|
},
|
|
28
45
|
"devDependencies": {
|
|
29
|
-
"@types/node": "16.
|
|
30
|
-
"
|
|
46
|
+
"@types/node": "18.16.18",
|
|
47
|
+
"rollup": "2.79.1",
|
|
48
|
+
"typescript": "5.0.4"
|
|
31
49
|
},
|
|
32
50
|
"engines": {
|
|
33
51
|
"node": ">= 14.0.0"
|