@algolia/client-search 5.0.0-alpha.99 → 5.0.0-beta.2
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 +86 -3
- package/dist/builds/browser.d.ts.map +1 -1
- package/dist/builds/node.d.ts +104 -3
- package/dist/builds/node.d.ts.map +1 -1
- package/dist/client-search.cjs +419 -219
- package/dist/client-search.esm.browser.js +376 -212
- package/dist/client-search.esm.node.js +420 -220
- package/dist/client-search.umd.js +2 -2
- package/dist/model/acl.d.ts +1 -1
- package/dist/model/action.d.ts +1 -1
- package/dist/model/addApiKeyResponse.d.ts +1 -1
- package/dist/model/anchoring.d.ts +1 -1
- package/dist/model/apiKey.d.ts +8 -8
- package/dist/model/apiKeyOperation.d.ts +2 -0
- package/dist/model/apiKeyOperation.d.ts.map +1 -0
- package/dist/model/aroundPrecision.d.ts +1 -1
- package/dist/model/aroundPrecisionFromValueInner.d.ts +9 -0
- package/dist/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
- package/dist/model/aroundRadius.d.ts +1 -1
- package/dist/model/aroundRadiusAll.d.ts +3 -0
- package/dist/model/aroundRadiusAll.d.ts.map +1 -1
- package/dist/model/automaticFacetFilter.d.ts +4 -4
- package/dist/model/automaticFacetFilters.d.ts +1 -1
- package/dist/model/baseGetApiKeyResponse.d.ts +1 -1
- package/dist/model/baseIndexSettings.d.ts +22 -17
- package/dist/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/model/baseSearchParamsWithoutQuery.d.ts +26 -29
- package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/model/baseSearchResponse.d.ts +10 -6
- package/dist/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/model/batchDictionaryEntriesParams.d.ts +3 -3
- package/dist/model/batchResponse.d.ts +2 -2
- package/dist/model/builtInOperation.d.ts +2 -2
- package/dist/model/builtInOperationType.d.ts +1 -1
- package/dist/model/clientMethodProps.d.ts +124 -65
- package/dist/model/clientMethodProps.d.ts.map +1 -1
- package/dist/model/condition.d.ts +7 -3
- package/dist/model/condition.d.ts.map +1 -1
- package/dist/model/consequence.d.ts +5 -5
- package/dist/model/consequenceHide.d.ts +2 -2
- package/dist/model/consequenceQuery.d.ts +1 -1
- package/dist/model/consequenceQueryObject.d.ts +2 -2
- package/dist/model/createdAtResponse.d.ts +1 -1
- package/dist/model/cursor.d.ts +1 -1
- package/dist/model/deleteApiKeyResponse.d.ts +1 -1
- package/dist/model/deleteByParams.d.ts +4 -4
- package/dist/model/deleteSourceResponse.d.ts +1 -1
- package/dist/model/deletedAtResponse.d.ts +2 -2
- package/dist/model/dictionaryEntry.d.ts +6 -8
- package/dist/model/dictionaryEntry.d.ts.map +1 -1
- package/dist/model/dictionaryEntryState.d.ts +1 -1
- package/dist/model/dictionaryLanguage.d.ts +2 -2
- package/dist/model/dictionarySettingsParams.d.ts +1 -1
- package/dist/model/distinct.d.ts +1 -1
- package/dist/model/edit.d.ts +1 -1
- package/dist/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/model/facetFilters.d.ts +2 -3
- package/dist/model/facetFilters.d.ts.map +1 -1
- package/dist/model/facetHits.d.ts +2 -2
- package/dist/model/facetOrdering.d.ts +2 -2
- package/dist/model/facets.d.ts +2 -2
- package/dist/model/fetchedIndex.d.ts +1 -1
- package/dist/model/getObjectsRequest.d.ts +3 -3
- package/dist/model/getObjectsResponse.d.ts +1 -1
- package/dist/model/hasPendingMappingsResponse.d.ts +1 -1
- package/dist/model/highlightResult.d.ts +1 -1
- package/dist/model/highlightResult.d.ts.map +1 -1
- package/dist/model/highlightResultOption.d.ts +3 -3
- package/dist/model/hit.d.ts +4 -4
- package/dist/model/ignorePlurals.d.ts +3 -2
- package/dist/model/ignorePlurals.d.ts.map +1 -1
- package/dist/model/index.d.ts +4 -1
- package/dist/model/index.d.ts.map +1 -1
- package/dist/model/indexSettings.d.ts +1 -1
- package/dist/model/indexSettingsAsSearchParams.d.ts +32 -35
- package/dist/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/model/log.d.ts +11 -11
- package/dist/model/logQuery.d.ts +1 -1
- package/dist/model/matchLevel.d.ts +1 -1
- package/dist/model/mode.d.ts +1 -1
- package/dist/model/multipleBatchRequest.d.ts +1 -1
- package/dist/model/multipleBatchResponse.d.ts +2 -2
- package/dist/model/numericFilters.d.ts +2 -3
- package/dist/model/numericFilters.d.ts.map +1 -1
- package/dist/model/operationIndexParams.d.ts +2 -2
- package/dist/model/operationType.d.ts +1 -1
- package/dist/model/optionalFilters.d.ts +2 -3
- package/dist/model/optionalFilters.d.ts.map +1 -1
- package/dist/model/params.d.ts +1 -1
- package/dist/model/promoteObjectID.d.ts +2 -2
- package/dist/model/promoteObjectIDs.d.ts +2 -2
- package/dist/model/queryType.d.ts +1 -1
- package/dist/model/rankingInfo.d.ts +10 -7
- package/dist/model/rankingInfo.d.ts.map +1 -1
- package/dist/model/reRankingApplyFilter.d.ts +2 -3
- package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
- package/dist/model/removeStopWords.d.ts +3 -2
- package/dist/model/removeStopWords.d.ts.map +1 -1
- package/dist/model/removeUserIdResponse.d.ts +1 -1
- package/dist/model/removeWordsIfNoResults.d.ts +1 -1
- package/dist/model/renderingContent.d.ts +1 -1
- package/dist/model/replaceSourceResponse.d.ts +1 -1
- package/dist/model/rule.d.ts +5 -5
- package/dist/model/saveObjectResponse.d.ts +3 -3
- package/dist/model/saveSynonymResponse.d.ts +2 -2
- package/dist/model/searchDictionaryEntriesParams.d.ts +5 -7
- package/dist/model/searchDictionaryEntriesParams.d.ts.map +1 -1
- package/dist/model/searchDictionaryEntriesResponse.d.ts +20 -0
- package/dist/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
- package/dist/model/searchForFacetValuesRequest.d.ts +1 -1
- package/dist/model/searchForFacetValuesResponse.d.ts +4 -1
- package/dist/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/model/searchForFacetsOptions.d.ts +2 -2
- package/dist/model/searchForHitsOptions.d.ts +1 -1
- package/dist/model/searchHits.d.ts +6 -3
- package/dist/model/searchHits.d.ts.map +1 -1
- package/dist/model/searchParamsObject.d.ts +3 -0
- package/dist/model/searchParamsObject.d.ts.map +1 -1
- package/dist/model/searchParamsQuery.d.ts +1 -1
- package/dist/model/searchRulesParams.d.ts +4 -8
- package/dist/model/searchRulesParams.d.ts.map +1 -1
- package/dist/model/searchRulesResponse.d.ts +2 -2
- package/dist/model/searchStrategy.d.ts +1 -1
- package/dist/model/searchSynonymsParams.d.ts +2 -2
- package/dist/model/searchSynonymsResponse.d.ts +2 -2
- package/dist/model/searchUserIdsParams.d.ts +1 -1
- package/dist/model/searchUserIdsResponse.d.ts +3 -3
- package/dist/model/securedAPIKeyRestrictions.d.ts +25 -0
- package/dist/model/securedAPIKeyRestrictions.d.ts.map +1 -0
- package/dist/model/semanticSearch.d.ts +2 -2
- package/dist/model/snippetResult.d.ts +1 -1
- package/dist/model/snippetResult.d.ts.map +1 -1
- package/dist/model/snippetResultOption.d.ts +2 -2
- package/dist/model/sortRemainingBy.d.ts +1 -1
- package/dist/model/supportedLanguage.d.ts +5 -0
- package/dist/model/supportedLanguage.d.ts.map +1 -0
- package/dist/model/tagFilters.d.ts +2 -3
- package/dist/model/tagFilters.d.ts.map +1 -1
- package/dist/model/taskStatus.d.ts +1 -1
- package/dist/model/timeRange.d.ts +2 -2
- package/dist/model/typoTolerance.d.ts +1 -1
- package/dist/model/typoToleranceEnum.d.ts +3 -0
- package/dist/model/typoToleranceEnum.d.ts.map +1 -1
- package/dist/model/updateApiKeyResponse.d.ts +1 -1
- package/dist/model/updatedAtResponse.d.ts +2 -2
- package/dist/model/updatedAtWithObjectIdResponse.d.ts +3 -3
- package/dist/model/updatedRuleResponse.d.ts +3 -3
- package/dist/model/userHit.d.ts +1 -1
- package/dist/model/userId.d.ts +1 -1
- package/dist/model/value.d.ts +1 -1
- package/dist/src/searchClient.d.ts +324 -202
- package/dist/src/searchClient.d.ts.map +1 -1
- package/model/acl.ts +1 -1
- package/model/action.ts +1 -1
- package/model/addApiKeyResponse.ts +1 -1
- package/model/anchoring.ts +1 -1
- package/model/apiKey.ts +8 -8
- package/model/{mixedSearchFilters.ts → apiKeyOperation.ts} +1 -1
- package/model/aroundPrecision.ts +1 -1
- package/model/aroundPrecisionFromValueInner.ts +9 -0
- package/model/aroundRadius.ts +1 -1
- package/model/aroundRadiusAll.ts +3 -0
- package/model/automaticFacetFilter.ts +4 -4
- package/model/automaticFacetFilters.ts +1 -1
- package/model/baseGetApiKeyResponse.ts +1 -1
- package/model/baseIndexSettings.ts +24 -17
- package/model/baseSearchParamsWithoutQuery.ts +26 -30
- package/model/baseSearchResponse.ts +11 -6
- package/model/batchDictionaryEntriesParams.ts +3 -3
- package/model/batchResponse.ts +2 -2
- package/model/builtInOperation.ts +2 -2
- package/model/builtInOperationType.ts +1 -1
- package/model/clientMethodProps.ts +135 -65
- package/model/condition.ts +8 -3
- package/model/consequence.ts +5 -5
- package/model/consequenceHide.ts +2 -2
- package/model/consequenceQuery.ts +1 -1
- package/model/consequenceQueryObject.ts +2 -2
- package/model/createdAtResponse.ts +1 -1
- package/model/cursor.ts +1 -1
- package/model/deleteApiKeyResponse.ts +1 -1
- package/model/deleteByParams.ts +4 -4
- package/model/deleteSourceResponse.ts +1 -1
- package/model/deletedAtResponse.ts +2 -2
- package/model/dictionaryEntry.ts +6 -8
- package/model/dictionaryEntryState.ts +1 -1
- package/model/dictionaryLanguage.ts +2 -2
- package/model/dictionarySettingsParams.ts +1 -1
- package/model/distinct.ts +1 -1
- package/model/edit.ts +1 -1
- package/model/exactOnSingleWordQuery.ts +1 -1
- package/model/facetFilters.ts +2 -4
- package/model/facetHits.ts +2 -2
- package/model/facetOrdering.ts +2 -2
- package/model/facets.ts +2 -2
- package/model/fetchedIndex.ts +1 -1
- package/model/getObjectsRequest.ts +3 -3
- package/model/getObjectsResponse.ts +1 -1
- package/model/hasPendingMappingsResponse.ts +1 -1
- package/model/highlightResult.ts +1 -0
- package/model/highlightResultOption.ts +3 -3
- package/model/hit.ts +4 -4
- package/model/ignorePlurals.ts +4 -2
- package/model/index.ts +4 -1
- package/model/indexSettings.ts +1 -1
- package/model/indexSettingsAsSearchParams.ts +32 -36
- package/model/log.ts +11 -11
- package/model/logQuery.ts +1 -1
- package/model/matchLevel.ts +1 -1
- package/model/mode.ts +1 -1
- package/model/multipleBatchRequest.ts +1 -1
- package/model/multipleBatchResponse.ts +2 -2
- package/model/numericFilters.ts +2 -4
- package/model/operationIndexParams.ts +2 -2
- package/model/operationType.ts +1 -1
- package/model/optionalFilters.ts +2 -4
- package/model/params.ts +1 -1
- package/model/promoteObjectID.ts +2 -2
- package/model/promoteObjectIDs.ts +2 -2
- package/model/queryType.ts +1 -1
- package/model/rankingInfo.ts +10 -7
- package/model/reRankingApplyFilter.ts +2 -4
- package/model/removeStopWords.ts +4 -2
- package/model/removeUserIdResponse.ts +1 -1
- package/model/removeWordsIfNoResults.ts +1 -1
- package/model/renderingContent.ts +1 -1
- package/model/replaceSourceResponse.ts +1 -1
- package/model/rule.ts +5 -5
- package/model/saveObjectResponse.ts +3 -3
- package/model/saveSynonymResponse.ts +2 -2
- package/model/searchDictionaryEntriesParams.ts +6 -7
- package/model/searchDictionaryEntriesResponse.ts +25 -0
- package/model/searchForFacetValuesRequest.ts +1 -1
- package/model/searchForFacetValuesResponse.ts +4 -1
- package/model/searchForFacetsOptions.ts +2 -2
- package/model/searchForHitsOptions.ts +1 -1
- package/model/searchHits.ts +6 -3
- package/model/searchParamsObject.ts +3 -0
- package/model/searchParamsQuery.ts +1 -1
- package/model/searchRulesParams.ts +4 -9
- package/model/searchRulesResponse.ts +2 -2
- package/model/searchStrategy.ts +1 -1
- package/model/searchSynonymsParams.ts +2 -2
- package/model/searchSynonymsResponse.ts +2 -2
- package/model/searchUserIdsParams.ts +1 -1
- package/model/searchUserIdsResponse.ts +3 -3
- package/model/securedAPIKeyRestrictions.ts +32 -0
- package/model/semanticSearch.ts +2 -2
- package/model/snippetResult.ts +2 -1
- package/model/snippetResultOption.ts +2 -2
- package/model/sortRemainingBy.ts +1 -1
- package/model/supportedLanguage.ts +74 -0
- package/model/tagFilters.ts +2 -4
- package/model/taskStatus.ts +1 -1
- package/model/timeRange.ts +2 -2
- package/model/typoTolerance.ts +1 -1
- package/model/typoToleranceEnum.ts +3 -0
- package/model/updateApiKeyResponse.ts +1 -1
- package/model/updatedAtResponse.ts +2 -2
- package/model/updatedAtWithObjectIdResponse.ts +3 -3
- package/model/updatedRuleResponse.ts +3 -3
- package/model/userHit.ts +1 -1
- package/model/userId.ts +1 -1
- package/model/value.ts +1 -1
- package/package.json +7 -7
- package/dist/model/mixedSearchFilters.d.ts +0 -2
- package/dist/model/mixedSearchFilters.d.ts.map +0 -1
package/dist/builds/browser.d.ts
CHANGED
|
@@ -1,6 +1,89 @@
|
|
|
1
1
|
import type { ClientOptions } from '@algolia/client-common';
|
|
2
|
-
|
|
3
|
-
export { apiClientVersion, SearchClient } from '../src/searchClient';
|
|
2
|
+
export { apiClientVersion } from '../src/searchClient';
|
|
4
3
|
export * from '../model';
|
|
5
|
-
|
|
4
|
+
/**
|
|
5
|
+
* The client type.
|
|
6
|
+
*/
|
|
7
|
+
export type SearchClient = ReturnType<typeof searchClient>;
|
|
8
|
+
export declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): {
|
|
9
|
+
transporter: import("@algolia/client-common").Transporter;
|
|
10
|
+
appId: string;
|
|
11
|
+
clearCache(): Promise<void>;
|
|
12
|
+
readonly _ua: string;
|
|
13
|
+
addAlgoliaAgent(segment: string, version?: string | undefined): void;
|
|
14
|
+
waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
|
|
15
|
+
waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-common").ApiError | import("../model").GetApiKeyResponse>;
|
|
16
|
+
browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "aggregator">> & import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T>>;
|
|
17
|
+
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "aggregator">> & import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
|
|
18
|
+
browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "aggregator">> & import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
|
|
19
|
+
searchForHits<T_1>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
|
|
20
|
+
results: import("../model").SearchResponse<T_1>[];
|
|
21
|
+
}>;
|
|
22
|
+
searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
|
|
23
|
+
results: import("../model").SearchForFacetValuesResponse[];
|
|
24
|
+
}>;
|
|
25
|
+
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse[]>;
|
|
26
|
+
replaceAllObjects({ indexName, objects, batchSize }: import("../model").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceAllObjectsResponse>;
|
|
27
|
+
addApiKey(apiKey: import("../model").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
|
|
28
|
+
addOrUpdateObject({ indexName, objectID, body }: import("../model").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
|
|
29
|
+
appendSource(source: import("../model").Source, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
|
|
30
|
+
assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("../model").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
|
|
31
|
+
batch({ indexName, batchWriteParams }: import("../model").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse>;
|
|
32
|
+
batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("../model").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
|
|
33
|
+
batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("../model").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
34
|
+
browse<T_2>({ indexName, browseParams }: import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T_2>>;
|
|
35
|
+
clearObjects({ indexName }: import("../model").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
36
|
+
clearRules({ indexName, forwardToReplicas }: import("../model").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
37
|
+
clearSynonyms({ indexName, forwardToReplicas }: import("../model").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
38
|
+
customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
|
|
39
|
+
customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
|
|
40
|
+
customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
|
|
41
|
+
customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
|
|
42
|
+
deleteApiKey({ key }: import("../model").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteApiKeyResponse>;
|
|
43
|
+
deleteBy({ indexName, deleteByParams }: import("../model").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
|
|
44
|
+
deleteIndex({ indexName }: import("../model").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
|
|
45
|
+
deleteObject({ indexName, objectID }: import("../model").DeleteObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
|
|
46
|
+
deleteRule({ indexName, objectID, forwardToReplicas }: import("../model").DeleteRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
47
|
+
deleteSource({ source }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteSourceResponse>;
|
|
48
|
+
deleteSynonym({ indexName, objectID, forwardToReplicas }: import("../model").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
|
|
49
|
+
getApiKey({ key }: import("../model").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetApiKeyResponse>;
|
|
50
|
+
getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, import("../model").Languages>>;
|
|
51
|
+
getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetDictionarySettingsResponse>;
|
|
52
|
+
getLogs({ offset, length, indexName, type }?: import("../model").GetLogsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetLogsResponse>;
|
|
53
|
+
getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, string>>;
|
|
54
|
+
getObjects<T_3>(getObjectsParams: import("../model").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetObjectsResponse<T_3>>;
|
|
55
|
+
getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Rule>;
|
|
56
|
+
getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").IndexSettings>;
|
|
57
|
+
getSources(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Source[]>;
|
|
58
|
+
getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SynonymHit>;
|
|
59
|
+
getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
|
|
60
|
+
getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTopUserIdsResponse>;
|
|
61
|
+
getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UserId>;
|
|
62
|
+
hasPendingMappings({ getClusters }?: import("../model").HasPendingMappingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").HasPendingMappingsResponse>;
|
|
63
|
+
listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListApiKeysResponse>;
|
|
64
|
+
listClusters(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListClustersResponse>;
|
|
65
|
+
listIndices({ page, hitsPerPage }?: import("../model").ListIndicesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListIndicesResponse>;
|
|
66
|
+
listUserIds({ page, hitsPerPage }?: import("../model").ListUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListUserIdsResponse>;
|
|
67
|
+
multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").MultipleBatchResponse>;
|
|
68
|
+
operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
69
|
+
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
|
|
70
|
+
removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RemoveUserIdResponse>;
|
|
71
|
+
replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceSourceResponse>;
|
|
72
|
+
restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
|
|
73
|
+
saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveObjectResponse>;
|
|
74
|
+
saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedRuleResponse>;
|
|
75
|
+
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
76
|
+
saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveSynonymResponse>;
|
|
77
|
+
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
78
|
+
search<T_4>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponses<T_4>>;
|
|
79
|
+
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchDictionaryEntriesResponse>;
|
|
80
|
+
searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchForFacetValuesResponse>;
|
|
81
|
+
searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
|
|
82
|
+
searchSingleIndex<T_5>({ indexName, searchParams }: import("../model").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponse<T_5>>;
|
|
83
|
+
searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
|
|
84
|
+
searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchUserIdsResponse>;
|
|
85
|
+
setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
86
|
+
setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
87
|
+
updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdateApiKeyResponse>;
|
|
88
|
+
};
|
|
6
89
|
//# sourceMappingURL=browser.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAa5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+BxB"}
|
package/dist/builds/node.d.ts
CHANGED
|
@@ -1,6 +1,107 @@
|
|
|
1
1
|
import type { ClientOptions } from '@algolia/client-common';
|
|
2
|
-
import type {
|
|
3
|
-
export { apiClientVersion
|
|
2
|
+
import type { GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from '../model';
|
|
3
|
+
export { apiClientVersion } from '../src/searchClient';
|
|
4
4
|
export * from '../model';
|
|
5
|
-
|
|
5
|
+
/**
|
|
6
|
+
* The client type.
|
|
7
|
+
*/
|
|
8
|
+
export type SearchClient = ReturnType<typeof searchClient>;
|
|
9
|
+
export declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): {
|
|
10
|
+
/**
|
|
11
|
+
* Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
|
|
12
|
+
*
|
|
13
|
+
* @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
|
|
14
|
+
* @param generateSecuredApiKey - The `generateSecuredApiKey` object.
|
|
15
|
+
* @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
|
|
16
|
+
* @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
|
|
17
|
+
*/
|
|
18
|
+
generateSecuredApiKey({ parentApiKey, restrictions, }: GenerateSecuredApiKeyOptions): string;
|
|
19
|
+
/**
|
|
20
|
+
* Helper: Retrieves the remaining validity of the previous generated `securedApiKey`, the `ValidUntil` parameter must have been provided.
|
|
21
|
+
*
|
|
22
|
+
* @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
|
|
23
|
+
* @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
|
|
24
|
+
* @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
|
|
25
|
+
*/
|
|
26
|
+
getSecuredApiKeyRemainingValidity({ securedApiKey, }: GetSecuredApiKeyRemainingValidityOptions): number;
|
|
27
|
+
transporter: import("@algolia/client-common").Transporter;
|
|
28
|
+
appId: string;
|
|
29
|
+
clearCache(): Promise<void>;
|
|
30
|
+
_ua: string;
|
|
31
|
+
addAlgoliaAgent(segment: string, version?: string | undefined): void;
|
|
32
|
+
waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
|
|
33
|
+
waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-common").ApiError | import("../model").GetApiKeyResponse>;
|
|
34
|
+
browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "aggregator">> & import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T>>;
|
|
35
|
+
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "aggregator">> & import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
|
|
36
|
+
browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "aggregator">> & import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
|
|
37
|
+
searchForHits<T_1>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
|
|
38
|
+
results: import("../model").SearchResponse<T_1>[];
|
|
39
|
+
}>;
|
|
40
|
+
searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
|
|
41
|
+
results: import("../model").SearchForFacetValuesResponse[];
|
|
42
|
+
}>;
|
|
43
|
+
chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse[]>;
|
|
44
|
+
replaceAllObjects({ indexName, objects, batchSize }: import("../model").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceAllObjectsResponse>;
|
|
45
|
+
addApiKey(apiKey: import("../model").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
|
|
46
|
+
addOrUpdateObject({ indexName, objectID, body }: import("../model").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
|
|
47
|
+
appendSource(source: import("../model").Source, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
|
|
48
|
+
assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("../model").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
|
|
49
|
+
batch({ indexName, batchWriteParams }: import("../model").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse>;
|
|
50
|
+
batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("../model").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
|
|
51
|
+
batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("../model").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
52
|
+
browse<T_2>({ indexName, browseParams }: import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T_2>>;
|
|
53
|
+
clearObjects({ indexName }: import("../model").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
54
|
+
clearRules({ indexName, forwardToReplicas }: import("../model").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
55
|
+
clearSynonyms({ indexName, forwardToReplicas }: import("../model").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
56
|
+
customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
|
|
57
|
+
customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
|
|
58
|
+
customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
|
|
59
|
+
customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
|
|
60
|
+
deleteApiKey({ key }: import("../model").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteApiKeyResponse>;
|
|
61
|
+
deleteBy({ indexName, deleteByParams }: import("../model").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
|
|
62
|
+
deleteIndex({ indexName }: import("../model").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
|
|
63
|
+
deleteObject({ indexName, objectID }: import("../model").DeleteObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
|
|
64
|
+
deleteRule({ indexName, objectID, forwardToReplicas }: import("../model").DeleteRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
65
|
+
deleteSource({ source }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteSourceResponse>;
|
|
66
|
+
deleteSynonym({ indexName, objectID, forwardToReplicas }: import("../model").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
|
|
67
|
+
getApiKey({ key }: import("../model").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetApiKeyResponse>;
|
|
68
|
+
getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, import("../model").Languages>>;
|
|
69
|
+
getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetDictionarySettingsResponse>;
|
|
70
|
+
getLogs({ offset, length, indexName, type }?: import("../model").GetLogsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetLogsResponse>;
|
|
71
|
+
getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, string>>;
|
|
72
|
+
getObjects<T_3>(getObjectsParams: import("../model").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetObjectsResponse<T_3>>;
|
|
73
|
+
getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Rule>;
|
|
74
|
+
getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").IndexSettings>;
|
|
75
|
+
getSources(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Source[]>;
|
|
76
|
+
getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SynonymHit>;
|
|
77
|
+
getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
|
|
78
|
+
getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTopUserIdsResponse>;
|
|
79
|
+
getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UserId>;
|
|
80
|
+
hasPendingMappings({ getClusters }?: import("../model").HasPendingMappingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").HasPendingMappingsResponse>;
|
|
81
|
+
listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListApiKeysResponse>;
|
|
82
|
+
listClusters(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListClustersResponse>;
|
|
83
|
+
listIndices({ page, hitsPerPage }?: import("../model").ListIndicesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListIndicesResponse>;
|
|
84
|
+
listUserIds({ page, hitsPerPage }?: import("../model").ListUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListUserIdsResponse>;
|
|
85
|
+
multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").MultipleBatchResponse>;
|
|
86
|
+
operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
87
|
+
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
|
|
88
|
+
removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RemoveUserIdResponse>;
|
|
89
|
+
replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceSourceResponse>;
|
|
90
|
+
restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
|
|
91
|
+
saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveObjectResponse>;
|
|
92
|
+
saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedRuleResponse>;
|
|
93
|
+
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
94
|
+
saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveSynonymResponse>;
|
|
95
|
+
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
96
|
+
search<T_4>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponses<T_4>>;
|
|
97
|
+
searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchDictionaryEntriesResponse>;
|
|
98
|
+
searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchForFacetValuesResponse>;
|
|
99
|
+
searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
|
|
100
|
+
searchSingleIndex<T_5>({ indexName, searchParams }: import("../model").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponse<T_5>>;
|
|
101
|
+
searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
|
|
102
|
+
searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchUserIdsResponse>;
|
|
103
|
+
setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
104
|
+
setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
|
|
105
|
+
updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdateApiKeyResponse>;
|
|
106
|
+
};
|
|
6
107
|
//# sourceMappingURL=node.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EACV,4BAA4B,EAC5B,wCAAwC,EACzC,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;IA2BrB;;;;;;;OAOG;2DAIA,4BAA4B,GAAG,MAAM;IASxC;;;;;;OAMG;0DAGA,wCAAwC,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcvD"}
|