@algolia/client-search 5.0.0-alpha.1 → 5.0.0-alpha.4
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 +2 -2
- package/dist/builds/browser.d.ts.map +1 -1
- package/dist/builds/node.d.ts +2 -2
- package/dist/builds/node.d.ts.map +1 -1
- package/dist/client-search.cjs.js +144 -25
- package/dist/client-search.esm.browser.js +172 -53
- package/dist/client-search.esm.node.js +145 -26
- package/dist/client-search.umd.js +2 -2
- package/dist/model/acl.d.ts +3 -0
- package/dist/model/acl.d.ts.map +1 -1
- package/dist/model/addApiKeyResponse.d.ts +1 -1
- package/dist/model/addApiKeyResponse.d.ts.map +1 -1
- package/dist/model/apiKey.d.ts.map +1 -1
- package/dist/model/attributeToUpdate.d.ts +3 -0
- package/dist/model/attributeToUpdate.d.ts.map +1 -0
- package/dist/model/automaticFacetFilter.d.ts.map +1 -1
- package/dist/model/baseGetApiKeyResponse.d.ts +11 -0
- package/dist/model/baseGetApiKeyResponse.d.ts.map +1 -0
- package/dist/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/model/baseSearchResponse.d.ts +2 -2
- package/dist/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/model/batchAssignUserIdsParams.d.ts.map +1 -1
- package/dist/model/batchDictionaryEntriesParams.d.ts.map +1 -1
- package/dist/model/batchDictionaryEntriesRequest.d.ts.map +1 -1
- package/dist/model/batchParams.d.ts +2 -2
- package/dist/model/batchParams.d.ts.map +1 -1
- package/dist/model/{batchOperation.d.ts → batchRequest.d.ts} +2 -2
- package/dist/model/batchRequest.d.ts.map +1 -0
- package/dist/model/batchResponse.d.ts.map +1 -1
- package/dist/model/batchWriteParams.d.ts +2 -2
- package/dist/model/batchWriteParams.d.ts.map +1 -1
- package/dist/model/browseRequest.d.ts.map +1 -1
- package/dist/model/browseResponse.d.ts +1 -1
- package/dist/model/browseResponse.d.ts.map +1 -1
- package/dist/model/builtInOperation.d.ts.map +1 -1
- package/dist/model/clientMethodProps.d.ts +21 -8
- package/dist/model/clientMethodProps.d.ts.map +1 -1
- package/dist/model/condition.d.ts.map +1 -1
- package/dist/model/consequence.d.ts.map +1 -1
- package/dist/model/consequenceQueryObject.d.ts.map +1 -1
- package/dist/model/deletedAtResponse.d.ts.map +1 -1
- package/dist/model/dictionaryEntry.d.ts.map +1 -1
- package/dist/model/distinct.d.ts +5 -0
- package/dist/model/distinct.d.ts.map +1 -0
- package/dist/model/edit.d.ts.map +1 -1
- package/dist/model/facetHits.d.ts.map +1 -1
- package/dist/model/facetOrdering.d.ts.map +1 -1
- package/dist/model/facetsStats.d.ts.map +1 -1
- package/dist/model/fetchedIndex.d.ts.map +1 -1
- package/dist/model/getApiKeyResponse.d.ts +4 -0
- package/dist/model/getApiKeyResponse.d.ts.map +1 -0
- package/dist/model/getObjectsParams.d.ts +2 -2
- package/dist/model/getObjectsParams.d.ts.map +1 -1
- package/dist/model/{multipleGetObjectsParams.d.ts → getObjectsRequest.d.ts} +2 -2
- package/dist/model/getObjectsRequest.d.ts.map +1 -0
- package/dist/model/getObjectsResponse.d.ts +2 -2
- package/dist/model/getObjectsResponse.d.ts.map +1 -1
- package/dist/model/hasPendingMappingsResponse.d.ts.map +1 -1
- package/dist/model/highlightResultOption.d.ts.map +1 -1
- package/dist/model/hit.d.ts +1 -1
- package/dist/model/hit.d.ts.map +1 -1
- package/dist/model/index.d.ts +7 -6
- package/dist/model/index.d.ts.map +1 -1
- package/dist/model/indexSettingsAsSearchParams.d.ts +2 -4
- package/dist/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/model/languages.d.ts.map +1 -1
- package/dist/model/listApiKeysResponse.d.ts +2 -2
- package/dist/model/listApiKeysResponse.d.ts.map +1 -1
- package/dist/model/listIndicesResponse.d.ts +1 -1
- package/dist/model/listIndicesResponse.d.ts.map +1 -1
- package/dist/model/log.d.ts.map +1 -1
- package/dist/model/logQuery.d.ts.map +1 -1
- package/dist/model/matchedGeoLocation.d.ts.map +1 -1
- package/dist/model/{multipleBatchOperation.d.ts → multipleBatchRequest.d.ts} +5 -5
- package/dist/model/multipleBatchRequest.d.ts.map +1 -0
- package/dist/model/multipleBatchResponse.d.ts +2 -2
- package/dist/model/multipleBatchResponse.d.ts.map +1 -1
- package/dist/model/operationIndexParams.d.ts.map +1 -1
- package/dist/model/params.d.ts.map +1 -1
- package/dist/model/personalization.d.ts.map +1 -1
- package/dist/model/promoteObjectID.d.ts.map +1 -1
- package/dist/model/promoteObjectIDs.d.ts.map +1 -1
- package/dist/model/rankingInfo.d.ts.map +1 -1
- package/dist/model/rule.d.ts.map +1 -1
- package/dist/model/saveObjectResponse.d.ts +2 -2
- package/dist/model/saveObjectResponse.d.ts.map +1 -1
- package/dist/model/saveSynonymResponse.d.ts.map +1 -1
- package/dist/model/searchDictionaryEntriesParams.d.ts.map +1 -1
- package/dist/model/searchForFacetValuesRequest.d.ts.map +1 -1
- package/dist/model/searchForFacetsOptions.d.ts.map +1 -1
- package/dist/model/searchForHitsOptions.d.ts.map +1 -1
- package/dist/model/searchHits.d.ts +2 -2
- package/dist/model/searchHits.d.ts.map +1 -1
- package/dist/model/searchMethodParams.d.ts.map +1 -1
- package/dist/model/searchResponse.d.ts +1 -1
- package/dist/model/searchResponse.d.ts.map +1 -1
- package/dist/model/searchResponses.d.ts +1 -1
- package/dist/model/searchResponses.d.ts.map +1 -1
- package/dist/model/searchRulesParams.d.ts.map +1 -1
- package/dist/model/searchRulesResponse.d.ts.map +1 -1
- package/dist/model/searchSynonymsResponse.d.ts.map +1 -1
- package/dist/model/searchUserIdsParams.d.ts.map +1 -1
- package/dist/model/searchUserIdsResponse.d.ts.map +1 -1
- package/dist/model/snippetResultOption.d.ts.map +1 -1
- package/dist/model/source.d.ts.map +1 -1
- package/dist/model/standardEntries.d.ts.map +1 -1
- package/dist/model/synonymHit.d.ts.map +1 -1
- package/dist/model/synonymHitHighlightResult.d.ts.map +1 -1
- package/dist/model/timeRange.d.ts.map +1 -1
- package/dist/model/updateApiKeyResponse.d.ts +1 -1
- package/dist/model/updateApiKeyResponse.d.ts.map +1 -1
- package/dist/model/updatedAtResponse.d.ts.map +1 -1
- package/dist/model/updatedAtWithObjectIdResponse.d.ts.map +1 -1
- package/dist/model/updatedRuleResponse.d.ts.map +1 -1
- package/dist/model/userHighlightResult.d.ts.map +1 -1
- package/dist/model/userHit.d.ts.map +1 -1
- package/dist/model/userId.d.ts.map +1 -1
- package/dist/model/value.d.ts.map +1 -1
- package/dist/src/searchClient.d.ts +65 -15
- package/dist/src/searchClient.d.ts.map +1 -1
- package/model/acl.ts +3 -0
- package/model/addApiKeyResponse.ts +2 -1
- package/model/apiKey.ts +7 -0
- package/model/{attributeOrBuiltInOperation.ts → attributeToUpdate.ts} +1 -1
- package/model/automaticFacetFilter.ts +2 -0
- package/model/baseGetApiKeyResponse.ts +13 -0
- package/model/baseIndexSettings.ts +13 -0
- package/model/baseSearchParamsWithoutQuery.ts +32 -0
- package/model/baseSearchResponse.ts +26 -2
- package/model/batchAssignUserIdsParams.ts +1 -0
- package/model/batchDictionaryEntriesParams.ts +1 -0
- package/model/batchDictionaryEntriesRequest.ts +1 -0
- package/model/batchParams.ts +2 -2
- package/model/{batchOperation.ts → batchRequest.ts} +2 -1
- package/model/batchResponse.ts +1 -0
- package/model/batchWriteParams.ts +2 -2
- package/model/browseRequest.ts +1 -0
- package/model/browseResponse.ts +1 -1
- package/model/builtInOperation.ts +1 -0
- package/model/clientMethodProps.ts +28 -12
- package/model/condition.ts +3 -0
- package/model/consequence.ts +4 -0
- package/model/consequenceQueryObject.ts +1 -0
- package/model/deletedAtResponse.ts +1 -0
- package/model/dictionaryEntry.ts +5 -0
- package/model/{createdAtObject.ts → distinct.ts} +4 -6
- package/model/edit.ts +2 -0
- package/model/facetHits.ts +2 -0
- package/model/facetOrdering.ts +1 -0
- package/model/facetsStats.ts +3 -0
- package/model/fetchedIndex.ts +10 -0
- package/model/{key.ts → getApiKeyResponse.ts} +2 -2
- package/model/getObjectsParams.ts +2 -2
- package/model/{multipleGetObjectsParams.ts → getObjectsRequest.ts} +3 -1
- package/model/getObjectsResponse.ts +2 -2
- package/model/hasPendingMappingsResponse.ts +1 -0
- package/model/highlightResultOption.ts +3 -0
- package/model/hit.ts +5 -1
- package/model/index.ts +7 -6
- package/model/indexSettingsAsSearchParams.ts +43 -4
- package/model/languages.ts +2 -0
- package/model/listApiKeysResponse.ts +2 -2
- package/model/listIndicesResponse.ts +2 -1
- package/model/log.ts +14 -0
- package/model/logQuery.ts +2 -0
- package/model/matchedGeoLocation.ts +2 -0
- package/model/{multipleBatchOperation.ts → multipleBatchRequest.ts} +6 -4
- package/model/multipleBatchResponse.ts +3 -2
- package/model/operationIndexParams.ts +2 -0
- package/model/params.ts +3 -0
- package/model/personalization.ts +2 -0
- package/model/promoteObjectID.ts +1 -0
- package/model/promoteObjectIDs.ts +1 -0
- package/model/rankingInfo.ts +12 -0
- package/model/rule.ts +5 -0
- package/model/saveObjectResponse.ts +4 -2
- package/model/saveSynonymResponse.ts +2 -0
- package/model/searchDictionaryEntriesParams.ts +3 -0
- package/model/searchForFacetValuesRequest.ts +2 -0
- package/model/searchForFacetsOptions.ts +4 -0
- package/model/searchForHitsOptions.ts +1 -0
- package/model/searchHits.ts +2 -2
- package/model/searchMethodParams.ts +1 -0
- package/model/searchResponse.ts +2 -1
- package/model/searchResponses.ts +1 -1
- package/model/searchRulesParams.ts +6 -0
- package/model/searchRulesResponse.ts +3 -0
- package/model/searchSynonymsResponse.ts +1 -0
- package/model/searchUserIdsParams.ts +3 -0
- package/model/searchUserIdsResponse.ts +4 -0
- package/model/snippetResultOption.ts +1 -0
- package/model/source.ts +1 -0
- package/model/standardEntries.ts +2 -0
- package/model/synonymHit.ts +8 -0
- package/model/synonymHitHighlightResult.ts +1 -0
- package/model/timeRange.ts +1 -0
- package/model/updateApiKeyResponse.ts +2 -1
- package/model/updatedAtResponse.ts +1 -0
- package/model/updatedAtWithObjectIdResponse.ts +2 -0
- package/model/updatedRuleResponse.ts +2 -0
- package/model/userHighlightResult.ts +1 -0
- package/model/userHit.ts +5 -0
- package/model/userId.ts +3 -0
- package/model/value.ts +1 -0
- package/package.json +5 -5
- package/dist/model/attributeOrBuiltInOperation.d.ts +0 -3
- package/dist/model/attributeOrBuiltInOperation.d.ts.map +0 -1
- package/dist/model/batchOperation.d.ts.map +0 -1
- package/dist/model/createdAtObject.d.ts +0 -7
- package/dist/model/createdAtObject.d.ts.map +0 -1
- package/dist/model/key.d.ts +0 -4
- package/dist/model/key.d.ts.map +0 -1
- package/dist/model/multipleBatchOperation.d.ts.map +0 -1
- package/dist/model/multipleGetObjectsParams.d.ts.map +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"updatedAtWithObjectIdResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/updatedAtWithObjectIdResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,6BAA6B,GAAG;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"updatedAtWithObjectIdResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/updatedAtWithObjectIdResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,6BAA6B,GAAG;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"updatedRuleResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/updatedRuleResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"updatedRuleResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/updatedRuleResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"userHighlightResult.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/userHighlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"userHighlightResult.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/userHighlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAExC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC9C,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"userHit.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/userHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,oBAAY,OAAO,GAAG;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"userHit.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/userHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,oBAAY,OAAO,GAAG;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,gBAAgB,EAAE,mBAAmB,CAAC;CACvC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"userId.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/userId.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"userId.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/userId.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC"}
|
|
@@ -4,12 +4,13 @@ import type { ApiKey } from '../model/apiKey';
|
|
|
4
4
|
import type { BatchParams } from '../model/batchParams';
|
|
5
5
|
import type { BatchResponse } from '../model/batchResponse';
|
|
6
6
|
import type { BrowseResponse } from '../model/browseResponse';
|
|
7
|
-
import type { WaitForTaskOptions, WaitForApiKeyOptions, AddOrUpdateObjectProps, AssignUserIdProps, BatchProps, BatchAssignUserIdsProps, BatchDictionaryEntriesProps, BrowseProps, ClearAllSynonymsProps, ClearObjectsProps, ClearRulesProps, DelProps, DeleteApiKeyProps, DeleteByProps, DeleteIndexProps, DeleteObjectProps, DeleteRuleProps, DeleteSourceProps, DeleteSynonymProps, GetProps, GetApiKeyProps, GetLogsProps, GetObjectProps, GetRuleProps, GetSettingsProps, GetSynonymProps, GetTaskProps, GetUserIdProps, HasPendingMappingsProps, ListIndicesProps, ListUserIdsProps, OperationIndexProps, PartialUpdateObjectProps, PostProps, PutProps, RemoveUserIdProps, ReplaceSourcesProps, RestoreApiKeyProps, SaveObjectProps, SaveRuleProps, SaveRulesProps, SaveSynonymProps, SaveSynonymsProps, LegacySearchMethodProps, SearchDictionaryEntriesProps, SearchForFacetValuesProps, SearchRulesProps, SearchSingleIndexProps, SearchSynonymsProps, SetSettingsProps, UpdateApiKeyProps } from '../model/clientMethodProps';
|
|
7
|
+
import type { BrowseOptions, WaitForTaskOptions, WaitForApiKeyOptions, AddOrUpdateObjectProps, AssignUserIdProps, BatchProps, BatchAssignUserIdsProps, BatchDictionaryEntriesProps, BrowseProps, ClearAllSynonymsProps, ClearObjectsProps, ClearRulesProps, DelProps, DeleteApiKeyProps, DeleteByProps, DeleteIndexProps, DeleteObjectProps, DeleteRuleProps, DeleteSourceProps, DeleteSynonymProps, GetProps, GetApiKeyProps, GetLogsProps, GetObjectProps, GetRuleProps, GetSettingsProps, GetSynonymProps, GetTaskProps, GetUserIdProps, HasPendingMappingsProps, ListIndicesProps, ListUserIdsProps, OperationIndexProps, PartialUpdateObjectProps, PostProps, PutProps, RemoveUserIdProps, ReplaceSourcesProps, RestoreApiKeyProps, SaveObjectProps, SaveRuleProps, SaveRulesProps, SaveSynonymProps, SaveSynonymsProps, LegacySearchMethodProps, SearchDictionaryEntriesProps, SearchForFacetValuesProps, SearchRulesProps, SearchSingleIndexProps, SearchSynonymsProps, SetSettingsProps, UpdateApiKeyProps } from '../model/clientMethodProps';
|
|
8
8
|
import type { CreatedAtResponse } from '../model/createdAtResponse';
|
|
9
9
|
import type { DeleteApiKeyResponse } from '../model/deleteApiKeyResponse';
|
|
10
10
|
import type { DeleteSourceResponse } from '../model/deleteSourceResponse';
|
|
11
11
|
import type { DeletedAtResponse } from '../model/deletedAtResponse';
|
|
12
12
|
import type { DictionarySettingsParams } from '../model/dictionarySettingsParams';
|
|
13
|
+
import type { GetApiKeyResponse } from '../model/getApiKeyResponse';
|
|
13
14
|
import type { GetDictionarySettingsResponse } from '../model/getDictionarySettingsResponse';
|
|
14
15
|
import type { GetLogsResponse } from '../model/getLogsResponse';
|
|
15
16
|
import type { GetObjectsParams } from '../model/getObjectsParams';
|
|
@@ -18,7 +19,6 @@ import type { GetTaskResponse } from '../model/getTaskResponse';
|
|
|
18
19
|
import type { GetTopUserIdsResponse } from '../model/getTopUserIdsResponse';
|
|
19
20
|
import type { HasPendingMappingsResponse } from '../model/hasPendingMappingsResponse';
|
|
20
21
|
import type { IndexSettings } from '../model/indexSettings';
|
|
21
|
-
import type { Key } from '../model/key';
|
|
22
22
|
import type { Languages } from '../model/languages';
|
|
23
23
|
import type { ListApiKeysResponse } from '../model/listApiKeysResponse';
|
|
24
24
|
import type { ListClustersResponse } from '../model/listClustersResponse';
|
|
@@ -45,9 +45,17 @@ import type { UpdatedAtResponse } from '../model/updatedAtResponse';
|
|
|
45
45
|
import type { UpdatedAtWithObjectIdResponse } from '../model/updatedAtWithObjectIdResponse';
|
|
46
46
|
import type { UpdatedRuleResponse } from '../model/updatedRuleResponse';
|
|
47
47
|
import type { UserId } from '../model/userId';
|
|
48
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
48
|
+
export declare const apiClientVersion = "5.0.0-alpha.4";
|
|
49
49
|
export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
|
|
50
50
|
transporter: import("@algolia/client-common").Transporter;
|
|
51
|
+
/**
|
|
52
|
+
* The `appId` currently in use.
|
|
53
|
+
*/
|
|
54
|
+
appId: string;
|
|
55
|
+
/**
|
|
56
|
+
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
|
|
57
|
+
*/
|
|
58
|
+
clearCache(): Promise<void>;
|
|
51
59
|
/**
|
|
52
60
|
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
|
|
53
61
|
*/
|
|
@@ -60,26 +68,65 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
60
68
|
*/
|
|
61
69
|
addAlgoliaAgent(segment: string, version?: string): void;
|
|
62
70
|
/**
|
|
63
|
-
* Helper: Wait for a task to
|
|
71
|
+
* Helper: Wait for a task to be published (completed) for a given `indexName` and `taskID`.
|
|
64
72
|
*
|
|
65
|
-
* @summary
|
|
73
|
+
* @summary Helper method that waits for a task to be published (completed).
|
|
66
74
|
* @param waitForTaskOptions - The waitForTaskOptions object.
|
|
67
75
|
* @param waitForTaskOptions.indexName - The `indexName` where the operation was performed.
|
|
68
76
|
* @param waitForTaskOptions.taskID - The `taskID` returned in the method response.
|
|
77
|
+
* @param waitForTaskOptions.maxRetries - The maximum number of retries. 50 by default.
|
|
78
|
+
* @param waitForTaskOptions.timeout - The function to decide how long to wait between retries.
|
|
69
79
|
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
|
|
70
80
|
*/
|
|
71
|
-
waitForTask({ indexName, taskID,
|
|
81
|
+
waitForTask({ indexName, taskID, maxRetries, timeout, }: WaitForTaskOptions, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
|
|
72
82
|
/**
|
|
73
83
|
* Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
|
|
74
84
|
*
|
|
75
|
-
* @summary
|
|
85
|
+
* @summary Helper method that waits for an API key task to be processed.
|
|
76
86
|
* @param waitForApiKeyOptions - The waitForApiKeyOptions object.
|
|
77
87
|
* @param waitForApiKeyOptions.operation - The `operation` that was done on a `key`.
|
|
78
88
|
* @param waitForApiKeyOptions.key - The `key` that has been added, deleted or updated.
|
|
79
89
|
* @param waitForApiKeyOptions.apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.
|
|
90
|
+
* @param waitForApiKeyOptions.maxRetries - The maximum number of retries. 50 by default.
|
|
91
|
+
* @param waitForApiKeyOptions.timeout - The function to decide how long to wait between retries.
|
|
80
92
|
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getApikey` method and merged with the transporter requestOptions.
|
|
81
93
|
*/
|
|
82
|
-
waitForApiKey({ operation, key, apiKey,
|
|
94
|
+
waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: WaitForApiKeyOptions, requestOptions?: RequestOptions): Promise<ApiError | GetApiKeyResponse>;
|
|
95
|
+
/**
|
|
96
|
+
* Helper: Iterate on the `browse` method of the client to allow aggregating objects of an index.
|
|
97
|
+
*
|
|
98
|
+
* @summary Helper method that iterates on the `browse` method.
|
|
99
|
+
* @param browseObjects - The browseObjects object.
|
|
100
|
+
* @param browseObjects.indexName - The index in which to perform the request.
|
|
101
|
+
* @param browseObjects.browseRequest - The `browse` method parameters.
|
|
102
|
+
* @param browseObjects.validate - The validator function. It receive the resolved return of the API call.
|
|
103
|
+
* @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
|
|
104
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
|
|
105
|
+
*/
|
|
106
|
+
browseObjects<T>({ indexName, browseRequest, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<BrowseResponse<T>>, "aggregator">> & BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T>>;
|
|
107
|
+
/**
|
|
108
|
+
* Helper: Iterate on the `searchRules` method of the client to allow aggregating rules of an index.
|
|
109
|
+
*
|
|
110
|
+
* @summary Helper method that iterates on the `searchRules` method.
|
|
111
|
+
* @param browseObjects - The browseObjects object.
|
|
112
|
+
* @param browseObjects.indexName - The index in which to perform the request.
|
|
113
|
+
* @param browseObjects.searchRulesParams - The `searchRules` method parameters.
|
|
114
|
+
* @param browseObjects.validate - The validator function. It receive the resolved return of the API call.
|
|
115
|
+
* @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
|
|
116
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchRules` method and merged with the transporter requestOptions.
|
|
117
|
+
*/
|
|
118
|
+
browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: BrowseOptions<SearchRulesResponse> & SearchRulesProps, requestOptions?: RequestOptions): Promise<SearchRulesResponse>;
|
|
119
|
+
/**
|
|
120
|
+
* Helper: Iterate on the `searchSynonyms` method of the client to allow aggregating rules of an index.
|
|
121
|
+
*
|
|
122
|
+
* @summary Helper method that iterates on the `searchSynonyms` method.
|
|
123
|
+
* @param browseObjects - The browseObjects object.
|
|
124
|
+
* @param browseObjects.indexName - The index in which to perform the request.
|
|
125
|
+
* @param browseObjects.validate - The validator function. It receive the resolved return of the API call.
|
|
126
|
+
* @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
|
|
127
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchSynonyms` method and merged with the transporter requestOptions.
|
|
128
|
+
*/
|
|
129
|
+
browseSynonyms({ indexName, validate, aggregator, ...browseSynonymsOptions }: BrowseOptions<SearchSynonymsResponse> & SearchSynonymsProps, requestOptions?: RequestOptions): Promise<SearchSynonymsResponse>;
|
|
83
130
|
/**
|
|
84
131
|
* Add a new API Key with specific permissions/restrictions.
|
|
85
132
|
*
|
|
@@ -156,7 +203,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
156
203
|
* @param browse.browseRequest - The browseRequest object.
|
|
157
204
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
158
205
|
*/
|
|
159
|
-
browse<
|
|
206
|
+
browse<T_1>({ indexName, browseRequest }: BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T_1>>;
|
|
160
207
|
/**
|
|
161
208
|
* Remove all synonyms from an index.
|
|
162
209
|
*
|
|
@@ -283,7 +330,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
283
330
|
* @param getApiKey.key - API Key string.
|
|
284
331
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
285
332
|
*/
|
|
286
|
-
getApiKey({ key }: GetApiKeyProps, requestOptions?: RequestOptions): Promise<
|
|
333
|
+
getApiKey({ key }: GetApiKeyProps, requestOptions?: RequestOptions): Promise<GetApiKeyResponse>;
|
|
287
334
|
/**
|
|
288
335
|
* List dictionaries supported per language.
|
|
289
336
|
*
|
|
@@ -328,7 +375,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
328
375
|
* @param getObjectsParams - The Algolia object.
|
|
329
376
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
330
377
|
*/
|
|
331
|
-
getObjects(getObjectsParams: GetObjectsParams, requestOptions?: RequestOptions): Promise<GetObjectsResponse
|
|
378
|
+
getObjects<T_2>(getObjectsParams: GetObjectsParams, requestOptions?: RequestOptions): Promise<GetObjectsResponse<T_2>>;
|
|
332
379
|
/**
|
|
333
380
|
* Retrieve the Rule with the specified objectID.
|
|
334
381
|
*
|
|
@@ -458,11 +505,11 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
458
505
|
* @param partialUpdateObject - The partialUpdateObject object.
|
|
459
506
|
* @param partialUpdateObject.indexName - The index in which to perform the request.
|
|
460
507
|
* @param partialUpdateObject.objectID - Unique identifier of an object.
|
|
461
|
-
* @param partialUpdateObject.
|
|
508
|
+
* @param partialUpdateObject.attributeToUpdate - List of attributes to update.
|
|
462
509
|
* @param partialUpdateObject.createIfNotExists - Creates the record if it does not exist yet.
|
|
463
510
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
464
511
|
*/
|
|
465
|
-
partialUpdateObject({ indexName, objectID,
|
|
512
|
+
partialUpdateObject({ indexName, objectID, attributeToUpdate, createIfNotExists, }: PartialUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
|
|
466
513
|
/**
|
|
467
514
|
* This method allow you to send requests to the Algolia REST API.
|
|
468
515
|
*
|
|
@@ -577,7 +624,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
577
624
|
* @param searchMethodParams - The `search` requests and strategy.
|
|
578
625
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
579
626
|
*/
|
|
580
|
-
search<
|
|
627
|
+
search<T_3>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T_3>>;
|
|
581
628
|
/**
|
|
582
629
|
* Search the dictionary entries.
|
|
583
630
|
*
|
|
@@ -618,7 +665,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
618
665
|
* @param searchSingleIndex.searchParams - The searchParams object.
|
|
619
666
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
620
667
|
*/
|
|
621
|
-
searchSingleIndex<
|
|
668
|
+
searchSingleIndex<T_4>({ indexName, searchParams }: SearchSingleIndexProps, requestOptions?: RequestOptions): Promise<SearchResponse<T_4>>;
|
|
622
669
|
/**
|
|
623
670
|
* Search or browse all synonyms, optionally filtering them by type.
|
|
624
671
|
*
|
|
@@ -670,5 +717,8 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
|
|
|
670
717
|
*/
|
|
671
718
|
updateApiKey({ key, apiKey }: UpdateApiKeyProps, requestOptions?: RequestOptions): Promise<UpdateApiKeyResponse>;
|
|
672
719
|
};
|
|
720
|
+
/**
|
|
721
|
+
* The client type.
|
|
722
|
+
*/
|
|
673
723
|
export declare type SearchClient = ReturnType<typeof createSearchClient>;
|
|
674
724
|
//# sourceMappingURL=searchClient.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEd,QAAQ,
|
|
1
|
+
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEd,QAAQ,EAET,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,UAAU,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,WAAW,EACX,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,QAAQ,EACR,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,SAAS,EACT,QAAQ,EACR,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,4BAA4B,EAC5B,yBAAyB,EACzB,gBAAgB,EAChB,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAsChD,wBAAgB,kBAAkB,CAAC,EACjC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;;;OAUG;6DAQE,kBAAkB,mBACJ,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAgB3B;;;;;;;;;;;OAWG;oEASE,oBAAoB,mBACN,cAAc,GAC9B,QAAQ,QAAQ,GAAG,iBAAiB,CAAC;IAoDxC;;;;;;;;;;OAUG;2TAOgB,cAAc;IAoBjC;;;;;;;;;;OAUG;yEAME,cAAc,mBAAmB,CAAC,GAAG,gBAAgB,mBACvC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA0B/B;;;;;;;;;OASG;kFAOE,cAAc,sBAAsB,CAAC,GAAG,mBAAmB,mBAC7C,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAwBlC;;;;;;OAMG;sBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;qDAE8B,sBAAsB,mBACpC,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAoCzC;;;;;;OAMG;yBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAsB7B;;;;;;;;OAQG;yDAEuC,iBAAiB,mBACxC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAsC7B;;;;;;;;OAQG;2CAEgC,UAAU,mBAC1B,cAAc,GAC9B,QAAQ,aAAa,CAAC;IA+BzB;;;;;;;;OAQG;qEAE6C,uBAAuB,mBACpD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA2C7B;;;;;;;;OAQG;8EAKE,2BAA2B,mBACb,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAqC7B;;;;;;;;OAQG;8CAE6B,WAAW,mBACxB,cAAc;IA0BjC;;;;;;;;OAQG;uDAEiC,qBAAqB,mBACtC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;OAOG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;iDAEiC,eAAe,mBAChC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;0BAEQ,iBAAiB,mBACT,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;OAQG;0CAE4B,aAAa,mBACzB,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA+B7B;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;0CAEwB,iBAAiB,mBACzB,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA6B7B;;;;;;;;;OASG;2DAE2C,eAAe,mBAC1C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;;OASG;8DAE2C,kBAAkB,mBAC7C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;uBAEQ,cAAc,mBACN,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;OAKG;4CAEgB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,SAAS,CAAC,CAAC;IAerC;;;;;OAKG;2CAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;;;;OAUG;iDAEoC,YAAY,mBAChC,cAAc,GAC9B,QAAQ,eAAe,CAAC;IA+B3B;;;;;;;;;OASG;6DAE8C,cAAc,mBAC5C,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC;IAiClC;;;;;;OAMG;sCAEiB,gBAAgB,mBACjB,cAAc;IA+BjC;;;;;;;;OAQG;qCAEwB,YAAY,mBACpB,cAAc,GAC9B,QAAQ,IAAI,CAAC;IA6BhB;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAwBzB;;;;;OAKG;gCACyB,cAAc,GAAG,QAAQ,MAAM,EAAE,CAAC;IAe9D;;;;;;;;OAQG;wCAEwB,eAAe,mBACvB,cAAc,GAC9B,QAAQ,UAAU,CAAC;IA6BtB;;;;;;;;OAQG;mCAEsB,YAAY,mBAClB,cAAc,GAC9B,QAAQ,eAAe,CAAC;IA6B3B;;;;;OAKG;mCAEgB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAejC;;;;;;;OAOG;0BAEW,cAAc,mBACT,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAwBlB;;;;;;;OAOG;wCAEgB,uBAAuB,mBACvB,cAAc,GAC9B,QAAQ,0BAA0B,CAAC;IAmBtC;;;;;OAKG;iCAC0B,cAAc,GAAG,QAAQ,mBAAmB,CAAC;IAe1E;;;;;OAKG;kCAEgB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAehC;;;;;;;OAOG;0BAES,gBAAgB,mBACT,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IAmB/B;;;;;;;;OAQG;uCAEsB,gBAAgB,mBACtB,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;OAMG;+BAEY,WAAW,mBACP,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA4BjC;;;;;;;;OAQG;wDAEoC,mBAAmB,mBACvC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA0C7B;;;;;;;;;;OAUG;wFAOE,wBAAwB,mBACV,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAwCzC;;;;;;;;;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;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;OAOG;+BAEW,mBAAmB,mBACd,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAsBjC;;;;;;;OAOG;2BAEQ,kBAAkB,mBACV,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;oCAEoB,eAAe,mBACnB,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IA+B9B;;;;;;;;;;OAUG;+DAEiD,aAAa,mBAC9C,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA8C/B;;;;;;;;;;OAUG;2EAOE,cAAc,mBACA,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;;OAUG;wEAEuD,gBAAgB,mBACvD,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA8C/B;;;;;;;;;;OAUG;yFAOE,iBAAiB,mBACH,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwC7B;;;;;;OAMG;oCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;IAwDjC;;;;;;;;OAQG;gFAKE,4BAA4B,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;OASG;iFAME,yBAAyB,mBACX,cAAc,GAC9B,QAAQ,4BAA4B,CAAC;IAgCxC;;;;;;;;OAQG;kDAEiC,gBAAgB,mBACjC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA2B/B;;;;;;;;OAQG;wDAE4B,sBAAsB,mBAClC,cAAc;IA4BjC;;;;;;;;;;;OAWG;kFAQE,mBAAmB,mBACL,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAuClC;;;;;;OAMG;uCAEoB,mBAAmB,mBACvB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA8BjC;;;;;;OAMG;oDAEyB,wBAAwB,mBACjC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;iEAEgD,gBAAgB,mBAChD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAmC7B;;;;;;;;OAQG;kCAEgB,iBAAiB,mBACjB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;EAqCnC;AAED;;GAEG;AACH,oBAAY,YAAY,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
|
package/model/acl.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* List of rights for the API key. The following rights can be used: addObject: allows to add/update an object in the index (copy/move index are also allowed with this right). Analytics: allows to retrieve the analytics through the Analytics API. Browse: allows to retrieve all index content via the browse API. DeleteIndex: allows to delete or clear index content. DeleteObject: allows to delete objects from the index. EditSettings: allows to change index settings. ListIndexes: allows to list all accessible indices. Logs: allows to get the logs. Recommendation: Allows usage of the Personalization dashboard and the Recommendation API. Search: allows to search the index. SeeUnretrievableAttributes: disable unretrievableAttributes feature for all operations returning records. Settings: allows to get index settings.
|
|
5
|
+
*/
|
|
3
6
|
export type Acl =
|
|
4
7
|
| 'addObject'
|
|
5
8
|
| 'analytics'
|
package/model/apiKey.ts
CHANGED
|
@@ -10,30 +10,37 @@ export type ApiKey = {
|
|
|
10
10
|
* Set of permissions associated with the key.
|
|
11
11
|
*/
|
|
12
12
|
acl: Acl[];
|
|
13
|
+
|
|
13
14
|
/**
|
|
14
15
|
* A comment used to identify a key more easily in the dashboard. It is not interpreted by the API.
|
|
15
16
|
*/
|
|
16
17
|
description?: string;
|
|
18
|
+
|
|
17
19
|
/**
|
|
18
20
|
* Restrict this new API key to a list of indices or index patterns. If the list is empty, all indices are allowed.
|
|
19
21
|
*/
|
|
20
22
|
indexes?: string[];
|
|
23
|
+
|
|
21
24
|
/**
|
|
22
25
|
* Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.
|
|
23
26
|
*/
|
|
24
27
|
maxHitsPerQuery?: number;
|
|
28
|
+
|
|
25
29
|
/**
|
|
26
30
|
* Maximum number of API calls per hour allowed from a given IP address or a user token.
|
|
27
31
|
*/
|
|
28
32
|
maxQueriesPerIPPerHour?: number;
|
|
33
|
+
|
|
29
34
|
/**
|
|
30
35
|
* URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
|
|
31
36
|
*/
|
|
32
37
|
queryParameters?: string;
|
|
38
|
+
|
|
33
39
|
/**
|
|
34
40
|
* Restrict this new API key to specific referers. If empty or blank, defaults to all referers.
|
|
35
41
|
*/
|
|
36
42
|
referers?: string[];
|
|
43
|
+
|
|
37
44
|
/**
|
|
38
45
|
* Validity limit for this key in seconds. The key will automatically be removed after this period of time.
|
|
39
46
|
*/
|
|
@@ -8,10 +8,12 @@ export type AutomaticFacetFilter = {
|
|
|
8
8
|
* Attribute to filter on. This must match a facet placeholder in the Rule\'s pattern.
|
|
9
9
|
*/
|
|
10
10
|
facet: string;
|
|
11
|
+
|
|
11
12
|
/**
|
|
12
13
|
* Score for the filter. Typically used for optional or disjunctive filters.
|
|
13
14
|
*/
|
|
14
15
|
score?: number;
|
|
16
|
+
|
|
15
17
|
/**
|
|
16
18
|
* Whether the filter is disjunctive (true) or conjunctive (false).
|
|
17
19
|
*/
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
|
|
2
|
+
|
|
3
|
+
export type BaseGetApiKeyResponse = {
|
|
4
|
+
/**
|
|
5
|
+
* The API key.
|
|
6
|
+
*/
|
|
7
|
+
value?: string;
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Time of the event expressed in milliseconds since the Unix epoch.
|
|
11
|
+
*/
|
|
12
|
+
createdAt: number;
|
|
13
|
+
};
|
|
@@ -5,54 +5,67 @@ export type BaseIndexSettings = {
|
|
|
5
5
|
* Creates replicas, exact copies of an index.
|
|
6
6
|
*/
|
|
7
7
|
replicas?: string[];
|
|
8
|
+
|
|
8
9
|
/**
|
|
9
10
|
* Set the maximum number of hits accessible via pagination.
|
|
10
11
|
*/
|
|
11
12
|
paginationLimitedTo?: number;
|
|
13
|
+
|
|
12
14
|
/**
|
|
13
15
|
* A list of words for which you want to turn off typo tolerance.
|
|
14
16
|
*/
|
|
15
17
|
disableTypoToleranceOnWords?: string[];
|
|
18
|
+
|
|
16
19
|
/**
|
|
17
20
|
* Specify on which attributes in your index Algolia should apply Japanese transliteration to make words indexed in Katakana or Kanji searchable in Hiragana.
|
|
18
21
|
*/
|
|
19
22
|
attributesToTransliterate?: string[];
|
|
23
|
+
|
|
20
24
|
/**
|
|
21
25
|
* List of attributes on which to do a decomposition of camel case words.
|
|
22
26
|
*/
|
|
23
27
|
camelCaseAttributes?: string[];
|
|
28
|
+
|
|
24
29
|
/**
|
|
25
30
|
* Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding.
|
|
26
31
|
*/
|
|
27
32
|
decompoundedAttributes?: Record<string, any>;
|
|
33
|
+
|
|
28
34
|
/**
|
|
29
35
|
* Sets the languages at the index level for language-specific processing such as tokenization and normalization.
|
|
30
36
|
*/
|
|
31
37
|
indexLanguages?: string[];
|
|
38
|
+
|
|
32
39
|
/**
|
|
33
40
|
* List of attributes on which you want to disable prefix matching.
|
|
34
41
|
*/
|
|
35
42
|
disablePrefixOnAttributes?: string[];
|
|
43
|
+
|
|
36
44
|
/**
|
|
37
45
|
* Enables compression of large integer arrays.
|
|
38
46
|
*/
|
|
39
47
|
allowCompressionOfIntegerArray?: boolean;
|
|
48
|
+
|
|
40
49
|
/**
|
|
41
50
|
* List of numeric attributes that can be used as numerical filters.
|
|
42
51
|
*/
|
|
43
52
|
numericAttributesForFiltering?: string[];
|
|
53
|
+
|
|
44
54
|
/**
|
|
45
55
|
* Control which separators are indexed.
|
|
46
56
|
*/
|
|
47
57
|
separatorsToIndex?: string;
|
|
58
|
+
|
|
48
59
|
/**
|
|
49
60
|
* The complete list of attributes used for searching.
|
|
50
61
|
*/
|
|
51
62
|
searchableAttributes?: string[];
|
|
63
|
+
|
|
52
64
|
/**
|
|
53
65
|
* Lets you store custom data in your indices.
|
|
54
66
|
*/
|
|
55
67
|
userData?: Record<string, any>;
|
|
68
|
+
|
|
56
69
|
/**
|
|
57
70
|
* Overrides Algolia\'s default normalization.
|
|
58
71
|
*/
|
|
@@ -12,114 +12,146 @@ export type BaseSearchParamsWithoutQuery = {
|
|
|
12
12
|
* Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
|
|
13
13
|
*/
|
|
14
14
|
similarQuery?: string;
|
|
15
|
+
|
|
15
16
|
/**
|
|
16
17
|
* Filter the query with numeric, facet and/or tag filters.
|
|
17
18
|
*/
|
|
18
19
|
filters?: string;
|
|
20
|
+
|
|
19
21
|
facetFilters?: FacetFilters;
|
|
22
|
+
|
|
20
23
|
optionalFilters?: OptionalFilters;
|
|
24
|
+
|
|
21
25
|
numericFilters?: NumericFilters;
|
|
26
|
+
|
|
22
27
|
tagFilters?: TagFilters;
|
|
28
|
+
|
|
23
29
|
/**
|
|
24
30
|
* Determines how to calculate the total score for filtering.
|
|
25
31
|
*/
|
|
26
32
|
sumOrFiltersScores?: boolean;
|
|
33
|
+
|
|
27
34
|
/**
|
|
28
35
|
* Retrieve facets and their facet values.
|
|
29
36
|
*/
|
|
30
37
|
facets?: string[];
|
|
38
|
+
|
|
31
39
|
/**
|
|
32
40
|
* Maximum number of facet values to return for each facet during a regular search.
|
|
33
41
|
*/
|
|
34
42
|
maxValuesPerFacet?: number;
|
|
43
|
+
|
|
35
44
|
/**
|
|
36
45
|
* Force faceting to be applied after de-duplication (via the Distinct setting).
|
|
37
46
|
*/
|
|
38
47
|
facetingAfterDistinct?: boolean;
|
|
48
|
+
|
|
39
49
|
/**
|
|
40
50
|
* Controls how facet values are fetched.
|
|
41
51
|
*/
|
|
42
52
|
sortFacetValuesBy?: string;
|
|
53
|
+
|
|
43
54
|
/**
|
|
44
55
|
* Specify the page to retrieve.
|
|
45
56
|
*/
|
|
46
57
|
page?: number;
|
|
58
|
+
|
|
47
59
|
/**
|
|
48
60
|
* Specify the offset of the first hit to return.
|
|
49
61
|
*/
|
|
50
62
|
offset?: number;
|
|
63
|
+
|
|
51
64
|
/**
|
|
52
65
|
* Set the number of hits to retrieve (used only with offset).
|
|
53
66
|
*/
|
|
54
67
|
length?: number;
|
|
68
|
+
|
|
55
69
|
/**
|
|
56
70
|
* Search for entries around a central geolocation, enabling a geo search within a circular area.
|
|
57
71
|
*/
|
|
58
72
|
aroundLatLng?: string;
|
|
73
|
+
|
|
59
74
|
/**
|
|
60
75
|
* Search for entries around a given location automatically computed from the requester\'s IP address.
|
|
61
76
|
*/
|
|
62
77
|
aroundLatLngViaIP?: boolean;
|
|
78
|
+
|
|
63
79
|
aroundRadius?: AroundRadius;
|
|
80
|
+
|
|
64
81
|
/**
|
|
65
82
|
* Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
|
|
66
83
|
*/
|
|
67
84
|
aroundPrecision?: number;
|
|
85
|
+
|
|
68
86
|
/**
|
|
69
87
|
* Minimum radius (in meters) used for a geo search when aroundRadius is not set.
|
|
70
88
|
*/
|
|
71
89
|
minimumAroundRadius?: number;
|
|
90
|
+
|
|
72
91
|
/**
|
|
73
92
|
* Search inside a rectangular area (in geo coordinates).
|
|
74
93
|
*/
|
|
75
94
|
insideBoundingBox?: number[];
|
|
95
|
+
|
|
76
96
|
/**
|
|
77
97
|
* Search inside a polygon (in geo coordinates).
|
|
78
98
|
*/
|
|
79
99
|
insidePolygon?: number[];
|
|
100
|
+
|
|
80
101
|
/**
|
|
81
102
|
* This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
|
|
82
103
|
*/
|
|
83
104
|
naturalLanguages?: string[];
|
|
105
|
+
|
|
84
106
|
/**
|
|
85
107
|
* Enables contextual rules.
|
|
86
108
|
*/
|
|
87
109
|
ruleContexts?: string[];
|
|
110
|
+
|
|
88
111
|
/**
|
|
89
112
|
* Define the impact of the Personalization feature.
|
|
90
113
|
*/
|
|
91
114
|
personalizationImpact?: number;
|
|
115
|
+
|
|
92
116
|
/**
|
|
93
117
|
* Associates a certain user token with the current search.
|
|
94
118
|
*/
|
|
95
119
|
userToken?: string;
|
|
120
|
+
|
|
96
121
|
/**
|
|
97
122
|
* Retrieve detailed ranking information.
|
|
98
123
|
*/
|
|
99
124
|
getRankingInfo?: boolean;
|
|
125
|
+
|
|
100
126
|
/**
|
|
101
127
|
* Enable the Click Analytics feature.
|
|
102
128
|
*/
|
|
103
129
|
clickAnalytics?: boolean;
|
|
130
|
+
|
|
104
131
|
/**
|
|
105
132
|
* Whether the current query will be taken into account in the Analytics.
|
|
106
133
|
*/
|
|
107
134
|
analytics?: boolean;
|
|
135
|
+
|
|
108
136
|
/**
|
|
109
137
|
* List of tags to apply to the query for analytics purposes.
|
|
110
138
|
*/
|
|
111
139
|
analyticsTags?: string[];
|
|
140
|
+
|
|
112
141
|
/**
|
|
113
142
|
* Whether to include or exclude a query from the processing-time percentile computation.
|
|
114
143
|
*/
|
|
115
144
|
percentileComputation?: boolean;
|
|
145
|
+
|
|
116
146
|
/**
|
|
117
147
|
* Whether this search should participate in running AB tests.
|
|
118
148
|
*/
|
|
119
149
|
enableABTest?: boolean;
|
|
150
|
+
|
|
120
151
|
/**
|
|
121
152
|
* Whether this search should use AI Re-Ranking.
|
|
122
153
|
*/
|
|
123
154
|
enableReRanking?: boolean;
|
|
155
|
+
|
|
124
156
|
reRankingApplyFilter?: ReRankingApplyFilter | null;
|
|
125
157
|
};
|