algoliasearch 5.0.0-alpha.73 → 5.0.0-alpha.75
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/algoliasearch.cjs.js +342 -340
- package/dist/algoliasearch.esm.browser.js +342 -338
- package/dist/algoliasearch.esm.node.js +342 -338
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/builds/browser.d.ts +2 -2
- package/dist/builds/node.d.ts +2 -2
- package/dist/client-abtesting/model/aBTest.d.ts +8 -12
- package/dist/client-abtesting/model/aBTest.d.ts.map +1 -1
- package/dist/client-abtesting/model/aBTestResponse.d.ts +3 -3
- package/dist/client-abtesting/model/abTestsVariant.d.ts +3 -3
- package/dist/client-abtesting/model/addABTestsRequest.d.ts +3 -3
- package/dist/client-abtesting/model/addABTestsRequest.d.ts.map +1 -1
- package/dist/client-abtesting/model/clientMethodProps.d.ts +16 -16
- package/dist/client-abtesting/model/customSearchParams.d.ts +3 -0
- package/dist/client-abtesting/model/customSearchParams.d.ts.map +1 -1
- package/dist/client-abtesting/model/listABTestsResponse.d.ts +3 -3
- package/dist/client-abtesting/model/variant.d.ts +14 -14
- package/dist/client-abtesting/src/abtestingClient.d.ts +27 -27
- package/dist/client-analytics/model/averageClickEvent.d.ts +3 -3
- package/dist/client-analytics/model/clickPosition.d.ts +2 -2
- package/dist/client-analytics/model/clickThroughRateEvent.d.ts +4 -4
- package/dist/client-analytics/model/clientMethodProps.d.ts +91 -91
- package/dist/client-analytics/model/conversionRateEvent.d.ts +4 -4
- package/dist/client-analytics/model/getAverageClickPositionResponse.d.ts +3 -3
- package/dist/client-analytics/model/getClickPositionsResponse.d.ts +1 -1
- package/dist/client-analytics/model/getClickThroughRateResponse.d.ts +4 -4
- package/dist/client-analytics/model/getConversationRateResponse.d.ts +4 -4
- package/dist/client-analytics/model/getNoClickRateResponse.d.ts +4 -4
- package/dist/client-analytics/model/getNoResultsRateResponse.d.ts +4 -4
- package/dist/client-analytics/model/getSearchesCountResponse.d.ts +2 -2
- package/dist/client-analytics/model/getSearchesNoClicksResponse.d.ts +1 -1
- package/dist/client-analytics/model/getSearchesNoResultsResponse.d.ts +1 -1
- package/dist/client-analytics/model/getStatusResponse.d.ts +1 -1
- package/dist/client-analytics/model/getTopCountriesResponse.d.ts +1 -1
- package/dist/client-analytics/model/getTopFilterAttribute.d.ts +2 -2
- package/dist/client-analytics/model/getTopFilterAttributesResponse.d.ts +1 -1
- package/dist/client-analytics/model/getTopFilterForAttribute.d.ts +4 -4
- package/dist/client-analytics/model/getTopFilterForAttributeResponse.d.ts +1 -1
- package/dist/client-analytics/model/getTopFiltersNoResultsResponse.d.ts +1 -1
- package/dist/client-analytics/model/getTopFiltersNoResultsValue.d.ts +3 -3
- package/dist/client-analytics/model/getTopFiltersNoResultsValues.d.ts +2 -2
- package/dist/client-analytics/model/getUsersCountResponse.d.ts +2 -2
- package/dist/client-analytics/model/noClickRateEvent.d.ts +4 -4
- package/dist/client-analytics/model/noResultsRateEvent.d.ts +4 -4
- package/dist/client-analytics/model/orderBy.d.ts +3 -0
- package/dist/client-analytics/model/orderBy.d.ts.map +1 -1
- package/dist/client-analytics/model/searchEvent.d.ts +2 -2
- package/dist/client-analytics/model/searchNoClickEvent.d.ts +3 -3
- package/dist/client-analytics/model/searchNoResultEvent.d.ts +3 -3
- package/dist/client-analytics/model/topCountry.d.ts +2 -2
- package/dist/client-analytics/model/topHit.d.ts +2 -2
- package/dist/client-analytics/model/topHitWithAnalytics.d.ts +7 -7
- package/dist/client-analytics/model/topHitsResponse.d.ts +1 -1
- package/dist/client-analytics/model/topHitsResponseWithAnalytics.d.ts +1 -1
- package/dist/client-analytics/model/topSearch.d.ts +3 -3
- package/dist/client-analytics/model/topSearchWithAnalytics.d.ts +9 -9
- package/dist/client-analytics/model/topSearchesResponse.d.ts +1 -1
- package/dist/client-analytics/model/topSearchesResponseWithAnalytics.d.ts +1 -1
- package/dist/client-analytics/model/userWithDate.d.ts +2 -2
- package/dist/client-analytics/src/analyticsClient.d.ts +114 -114
- package/dist/client-personalization/model/clientMethodProps.d.ts +10 -10
- package/dist/client-personalization/src/personalizationClient.d.ts +11 -11
- package/dist/client-search/model/acl.d.ts +1 -1
- package/dist/client-search/model/action.d.ts +1 -1
- package/dist/client-search/model/addApiKeyResponse.d.ts +2 -2
- package/dist/client-search/model/anchoring.d.ts +1 -1
- package/dist/client-search/model/apiKey.d.ts +9 -9
- package/dist/client-search/model/aroundRadius.d.ts +1 -1
- package/dist/client-search/model/assignUserIdParams.d.ts +1 -1
- package/dist/client-search/model/baseGetApiKeyResponse.d.ts +2 -2
- package/dist/client-search/model/baseIndexSettings.d.ts +14 -14
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +25 -25
- package/dist/client-search/model/baseSearchResponse.d.ts +20 -20
- package/dist/client-search/model/baseSearchResponseRedirect.d.ts +1 -1
- package/dist/client-search/model/batchAssignUserIdsParams.d.ts +2 -2
- package/dist/client-search/model/batchDictionaryEntriesParams.d.ts +3 -3
- package/dist/client-search/model/batchParams.d.ts +1 -1
- package/dist/client-search/model/batchRequest.d.ts +1 -1
- package/dist/client-search/model/batchResponse.d.ts +2 -2
- package/dist/client-search/model/batchWriteParams.d.ts +1 -1
- package/dist/client-search/model/builtInOperation.d.ts +1 -1
- package/dist/client-search/model/builtInOperationType.d.ts +1 -1
- package/dist/client-search/model/clientMethodProps.d.ts +88 -84
- package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-search/model/consequence.d.ts +4 -4
- package/dist/client-search/model/consequenceHide.d.ts +2 -2
- package/dist/client-search/model/createdAtResponse.d.ts +2 -2
- package/dist/client-search/model/cursor.d.ts +1 -1
- package/dist/client-search/model/deleteApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/deleteByParams.d.ts +4 -4
- package/dist/client-search/model/deleteSourceResponse.d.ts +1 -1
- package/dist/client-search/model/deletedAtResponse.d.ts +3 -3
- package/dist/client-search/model/dictionaryEntry.d.ts +6 -6
- package/dist/client-search/model/dictionaryEntryState.d.ts +1 -1
- package/dist/client-search/model/dictionaryLanguage.d.ts +2 -2
- package/dist/client-search/model/dictionarySettingsParams.d.ts +1 -1
- package/dist/client-search/model/distinct.d.ts +1 -1
- package/dist/client-search/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/client-search/model/facetFilters.d.ts +1 -1
- package/dist/client-search/model/facetHits.d.ts +3 -3
- package/dist/client-search/model/facetOrdering.d.ts +2 -2
- package/dist/client-search/model/facets.d.ts +1 -1
- package/dist/client-search/model/facetsStats.d.ts +4 -4
- package/dist/client-search/model/fetchedIndex.d.ts +1 -1
- package/dist/client-search/model/getObjectsParams.d.ts +1 -1
- package/dist/client-search/model/getObjectsRequest.d.ts +4 -4
- package/dist/client-search/model/getObjectsResponse.d.ts +1 -1
- package/dist/client-search/model/getTopUserIdsResponse.d.ts +2 -2
- package/dist/client-search/model/hasPendingMappingsResponse.d.ts +2 -2
- package/dist/client-search/model/highlightResultOption.d.ts +1 -1
- package/dist/client-search/model/hit.d.ts +1 -1
- package/dist/client-search/model/ignorePlurals.d.ts +1 -1
- package/dist/client-search/model/indexSettings.d.ts +1 -1
- package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +30 -30
- package/dist/client-search/model/indexSettingsAsSearchParamsSemanticSearch.d.ts +2 -2
- package/dist/client-search/model/languages.d.ts +1 -1
- package/dist/client-search/model/listApiKeysResponse.d.ts +1 -1
- package/dist/client-search/model/listClustersResponse.d.ts +2 -2
- package/dist/client-search/model/listIndicesResponse.d.ts +1 -1
- package/dist/client-search/model/listUserIdsResponse.d.ts +2 -2
- package/dist/client-search/model/log.d.ts +7 -7
- package/dist/client-search/model/logQuery.d.ts +1 -1
- package/dist/client-search/model/mode.d.ts +1 -1
- package/dist/client-search/model/multipleBatchRequest.d.ts +1 -1
- package/dist/client-search/model/multipleBatchResponse.d.ts +2 -2
- package/dist/client-search/model/numericFilters.d.ts +1 -1
- package/dist/client-search/model/operationIndexParams.d.ts +2 -2
- package/dist/client-search/model/operationType.d.ts +1 -1
- package/dist/client-search/model/optionalFilters.d.ts +1 -1
- package/dist/client-search/model/params.d.ts +1 -1
- package/dist/client-search/model/promoteObjectID.d.ts +3 -3
- package/dist/client-search/model/promoteObjectIDs.d.ts +3 -3
- package/dist/client-search/model/queryType.d.ts +1 -1
- package/dist/client-search/model/reRankingApplyFilter.d.ts +1 -1
- package/dist/client-search/model/redirectRuleIndexMetadata.d.ts +1 -1
- package/dist/client-search/model/redirectRuleIndexMetadataData.d.ts +1 -1
- package/dist/client-search/model/removeStopWords.d.ts +1 -1
- package/dist/client-search/model/removeUserIdResponse.d.ts +1 -1
- package/dist/client-search/model/removeWordsIfNoResults.d.ts +1 -1
- package/dist/client-search/model/renderingContent.d.ts +1 -1
- package/dist/client-search/model/replaceSourceResponse.d.ts +1 -1
- package/dist/client-search/model/rule.d.ts +5 -5
- package/dist/client-search/model/saveObjectResponse.d.ts +5 -2
- package/dist/client-search/model/saveObjectResponse.d.ts.map +1 -1
- package/dist/client-search/model/saveSynonymResponse.d.ts +3 -3
- package/dist/client-search/model/searchDictionaryEntriesParams.d.ts +5 -5
- package/dist/client-search/model/searchForFacetValuesRequest.d.ts +2 -2
- package/dist/client-search/model/searchForFacetsOptions.d.ts +3 -3
- package/dist/client-search/model/searchForHitsOptions.d.ts +1 -1
- package/dist/client-search/model/searchParamsQuery.d.ts +1 -1
- package/dist/client-search/model/searchParamsString.d.ts +1 -1
- package/dist/client-search/model/searchRulesParams.d.ts +7 -7
- package/dist/client-search/model/searchStrategy.d.ts +3 -0
- package/dist/client-search/model/searchStrategy.d.ts.map +1 -1
- package/dist/client-search/model/searchSynonymsParams.d.ts +1 -1
- package/dist/client-search/model/searchSynonymsResponse.d.ts +2 -2
- package/dist/client-search/model/searchTypeDefault.d.ts +1 -1
- package/dist/client-search/model/searchTypeFacet.d.ts +1 -1
- package/dist/client-search/model/searchUserIdsParams.d.ts +4 -4
- package/dist/client-search/model/searchUserIdsResponse.d.ts +5 -5
- package/dist/client-search/model/snippetResultOption.d.ts +1 -1
- package/dist/client-search/model/sortRemainingBy.d.ts +1 -1
- package/dist/client-search/model/source.d.ts +3 -3
- package/dist/client-search/model/standardEntries.d.ts +4 -4
- package/dist/client-search/model/synonymHit.d.ts +6 -6
- package/dist/client-search/model/synonymType.d.ts +1 -1
- package/dist/client-search/model/tagFilters.d.ts +1 -1
- package/dist/client-search/model/taskStatus.d.ts +3 -0
- package/dist/client-search/model/taskStatus.d.ts.map +1 -1
- package/dist/client-search/model/typoTolerance.d.ts +1 -1
- package/dist/client-search/model/updateApiKeyResponse.d.ts +2 -2
- package/dist/client-search/model/updatedAtResponse.d.ts +3 -3
- package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts +4 -4
- package/dist/client-search/model/updatedRuleResponse.d.ts +3 -3
- package/dist/client-search/model/userHit.d.ts +1 -1
- package/dist/client-search/model/userId.d.ts +2 -2
- package/dist/client-search/src/searchClient.d.ts +185 -184
- package/dist/client-search/src/searchClient.d.ts.map +1 -1
- package/dist/lite/lite.cjs.js +6 -8
- package/dist/lite/lite.esm.browser.js +6 -6
- package/dist/lite/lite.esm.node.js +6 -6
- package/dist/lite/lite.umd.js +2 -2
- package/dist/lite/model/acl.d.ts +1 -1
- package/dist/lite/model/action.d.ts +1 -1
- package/dist/lite/model/addApiKeyResponse.d.ts +2 -2
- package/dist/lite/model/anchoring.d.ts +1 -1
- package/dist/lite/model/apiKey.d.ts +9 -9
- package/dist/lite/model/aroundRadius.d.ts +1 -1
- package/dist/lite/model/baseGetApiKeyResponse.d.ts +2 -2
- package/dist/lite/model/baseIndexSettings.d.ts +14 -14
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +25 -25
- package/dist/lite/model/baseSearchResponse.d.ts +20 -20
- package/dist/lite/model/baseSearchResponseRedirect.d.ts +1 -1
- package/dist/lite/model/builtInOperation.d.ts +1 -1
- package/dist/lite/model/builtInOperationType.d.ts +1 -1
- package/dist/lite/model/clientMethodProps.d.ts +3 -3
- package/dist/lite/model/consequence.d.ts +4 -4
- package/dist/lite/model/consequenceHide.d.ts +2 -2
- package/dist/lite/model/cursor.d.ts +1 -1
- package/dist/lite/model/deleteByParams.d.ts +4 -4
- package/dist/lite/model/dictionaryEntry.d.ts +6 -6
- package/dist/lite/model/dictionaryEntryState.d.ts +1 -1
- package/dist/lite/model/dictionaryLanguage.d.ts +2 -2
- package/dist/lite/model/distinct.d.ts +1 -1
- package/dist/lite/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/lite/model/facetFilters.d.ts +1 -1
- package/dist/lite/model/facetOrdering.d.ts +2 -2
- package/dist/lite/model/facets.d.ts +1 -1
- package/dist/lite/model/facetsStats.d.ts +4 -4
- package/dist/lite/model/fetchedIndex.d.ts +1 -1
- package/dist/lite/model/highlightResultOption.d.ts +1 -1
- package/dist/lite/model/hit.d.ts +1 -1
- package/dist/lite/model/ignorePlurals.d.ts +1 -1
- package/dist/lite/model/indexSettings.d.ts +1 -1
- package/dist/lite/model/indexSettingsAsSearchParams.d.ts +30 -30
- package/dist/lite/model/indexSettingsAsSearchParamsSemanticSearch.d.ts +2 -2
- package/dist/lite/model/languages.d.ts +1 -1
- package/dist/lite/model/listIndicesResponse.d.ts +1 -1
- package/dist/lite/model/mode.d.ts +1 -1
- package/dist/lite/model/numericFilters.d.ts +1 -1
- package/dist/lite/model/operationType.d.ts +1 -1
- package/dist/lite/model/optionalFilters.d.ts +1 -1
- package/dist/lite/model/params.d.ts +1 -1
- package/dist/lite/model/promoteObjectID.d.ts +3 -3
- package/dist/lite/model/promoteObjectIDs.d.ts +3 -3
- package/dist/lite/model/queryType.d.ts +1 -1
- package/dist/lite/model/reRankingApplyFilter.d.ts +1 -1
- package/dist/lite/model/redirectRuleIndexMetadata.d.ts +1 -1
- package/dist/lite/model/redirectRuleIndexMetadataData.d.ts +1 -1
- package/dist/lite/model/removeStopWords.d.ts +1 -1
- package/dist/lite/model/removeWordsIfNoResults.d.ts +1 -1
- package/dist/lite/model/renderingContent.d.ts +1 -1
- package/dist/lite/model/rule.d.ts +5 -5
- package/dist/lite/model/searchForFacetsOptions.d.ts +3 -3
- package/dist/lite/model/searchForHitsOptions.d.ts +1 -1
- package/dist/lite/model/searchParamsQuery.d.ts +1 -1
- package/dist/lite/model/searchParamsString.d.ts +1 -1
- package/dist/lite/model/searchStrategy.d.ts +3 -0
- package/dist/lite/model/searchStrategy.d.ts.map +1 -1
- package/dist/lite/model/searchSynonymsResponse.d.ts +2 -2
- package/dist/lite/model/searchTypeDefault.d.ts +1 -1
- package/dist/lite/model/searchTypeFacet.d.ts +1 -1
- package/dist/lite/model/snippetResultOption.d.ts +1 -1
- package/dist/lite/model/sortRemainingBy.d.ts +1 -1
- package/dist/lite/model/source.d.ts +3 -3
- package/dist/lite/model/standardEntries.d.ts +4 -4
- package/dist/lite/model/synonymHit.d.ts +6 -6
- package/dist/lite/model/synonymType.d.ts +1 -1
- package/dist/lite/model/tagFilters.d.ts +1 -1
- package/dist/lite/model/taskStatus.d.ts +3 -0
- package/dist/lite/model/taskStatus.d.ts.map +1 -1
- package/dist/lite/model/typoTolerance.d.ts +1 -1
- package/dist/lite/model/updatedRuleResponse.d.ts +3 -3
- package/dist/lite/model/userId.d.ts +2 -2
- package/dist/lite/src/liteClient.d.ts +6 -6
- package/lite/model/acl.ts +1 -1
- package/lite/model/action.ts +1 -1
- package/lite/model/addApiKeyResponse.ts +2 -2
- package/lite/model/anchoring.ts +1 -1
- package/lite/model/apiKey.ts +9 -9
- package/lite/model/aroundRadius.ts +1 -1
- package/lite/model/baseGetApiKeyResponse.ts +2 -2
- package/lite/model/baseIndexSettings.ts +14 -14
- package/lite/model/baseSearchParamsWithoutQuery.ts +25 -25
- package/lite/model/baseSearchResponse.ts +20 -20
- package/lite/model/baseSearchResponseRedirect.ts +1 -1
- package/lite/model/builtInOperation.ts +1 -1
- package/lite/model/builtInOperationType.ts +1 -1
- package/lite/model/clientMethodProps.ts +3 -3
- package/lite/model/consequence.ts +4 -4
- package/lite/model/consequenceHide.ts +2 -2
- package/lite/model/cursor.ts +1 -1
- package/lite/model/deleteByParams.ts +4 -4
- package/lite/model/dictionaryEntry.ts +6 -6
- package/lite/model/dictionaryEntryState.ts +1 -1
- package/lite/model/dictionaryLanguage.ts +2 -2
- package/lite/model/distinct.ts +1 -1
- package/lite/model/exactOnSingleWordQuery.ts +1 -1
- package/lite/model/facetFilters.ts +1 -1
- package/lite/model/facetOrdering.ts +2 -2
- package/lite/model/facets.ts +1 -1
- package/lite/model/facetsStats.ts +4 -4
- package/lite/model/fetchedIndex.ts +1 -1
- package/lite/model/highlightResultOption.ts +1 -1
- package/lite/model/hit.ts +1 -1
- package/lite/model/ignorePlurals.ts +1 -1
- package/lite/model/indexSettings.ts +1 -1
- package/lite/model/indexSettingsAsSearchParams.ts +30 -30
- package/lite/model/indexSettingsAsSearchParamsSemanticSearch.ts +2 -2
- package/lite/model/languages.ts +1 -1
- package/lite/model/listIndicesResponse.ts +1 -1
- package/lite/model/mode.ts +1 -1
- package/lite/model/numericFilters.ts +1 -1
- package/lite/model/operationType.ts +1 -1
- package/lite/model/optionalFilters.ts +1 -1
- package/lite/model/params.ts +1 -1
- package/lite/model/promoteObjectID.ts +3 -3
- package/lite/model/promoteObjectIDs.ts +3 -3
- package/lite/model/queryType.ts +1 -1
- package/lite/model/reRankingApplyFilter.ts +1 -1
- package/lite/model/redirectRuleIndexMetadata.ts +1 -1
- package/lite/model/redirectRuleIndexMetadataData.ts +1 -1
- package/lite/model/removeStopWords.ts +1 -1
- package/lite/model/removeWordsIfNoResults.ts +1 -1
- package/lite/model/renderingContent.ts +1 -1
- package/lite/model/rule.ts +5 -5
- package/lite/model/searchForFacetsOptions.ts +3 -3
- package/lite/model/searchForHitsOptions.ts +1 -1
- package/lite/model/searchParamsQuery.ts +1 -1
- package/lite/model/searchParamsString.ts +1 -1
- package/lite/model/searchStrategy.ts +3 -0
- package/lite/model/searchSynonymsResponse.ts +2 -2
- package/lite/model/searchTypeDefault.ts +1 -1
- package/lite/model/searchTypeFacet.ts +1 -1
- package/lite/model/snippetResultOption.ts +1 -1
- package/lite/model/sortRemainingBy.ts +1 -1
- package/lite/model/source.ts +3 -3
- package/lite/model/standardEntries.ts +4 -4
- package/lite/model/synonymHit.ts +6 -6
- package/lite/model/synonymType.ts +1 -1
- package/lite/model/tagFilters.ts +1 -1
- package/lite/model/taskStatus.ts +3 -0
- package/lite/model/typoTolerance.ts +1 -1
- package/lite/model/updatedRuleResponse.ts +3 -3
- package/lite/model/userId.ts +2 -2
- package/lite/src/liteClient.ts +6 -6
- package/package.json +15 -14
|
@@ -28,15 +28,15 @@ import type { SynonymType } from './synonymType';
|
|
|
28
28
|
*/
|
|
29
29
|
export type AddOrUpdateObjectProps = {
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* Index on which to perform the request.
|
|
32
32
|
*/
|
|
33
33
|
indexName: string;
|
|
34
34
|
/**
|
|
35
|
-
* Unique
|
|
35
|
+
* Unique record (object) identifier.
|
|
36
36
|
*/
|
|
37
37
|
objectID: string;
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* Algolia record.
|
|
40
40
|
*/
|
|
41
41
|
body: Record<string, any>;
|
|
42
42
|
};
|
|
@@ -55,7 +55,7 @@ export type AssignUserIdProps = {
|
|
|
55
55
|
*/
|
|
56
56
|
export type BatchProps = {
|
|
57
57
|
/**
|
|
58
|
-
*
|
|
58
|
+
* Index on which to perform the request.
|
|
59
59
|
*/
|
|
60
60
|
indexName: string;
|
|
61
61
|
batchWriteParams: BatchWriteParams;
|
|
@@ -75,7 +75,7 @@ export type BatchAssignUserIdsProps = {
|
|
|
75
75
|
*/
|
|
76
76
|
export type BatchDictionaryEntriesProps = {
|
|
77
77
|
/**
|
|
78
|
-
*
|
|
78
|
+
* Dictionary to search in.
|
|
79
79
|
*/
|
|
80
80
|
dictionaryName: DictionaryType;
|
|
81
81
|
batchDictionaryEntriesParams: BatchDictionaryEntriesParams;
|
|
@@ -85,7 +85,7 @@ export type BatchDictionaryEntriesProps = {
|
|
|
85
85
|
*/
|
|
86
86
|
export type BrowseProps = {
|
|
87
87
|
/**
|
|
88
|
-
*
|
|
88
|
+
* Index on which to perform the request.
|
|
89
89
|
*/
|
|
90
90
|
indexName: string;
|
|
91
91
|
browseParams?: BrowseParams;
|
|
@@ -95,11 +95,11 @@ export type BrowseProps = {
|
|
|
95
95
|
*/
|
|
96
96
|
export type ClearAllSynonymsProps = {
|
|
97
97
|
/**
|
|
98
|
-
*
|
|
98
|
+
* Index on which to perform the request.
|
|
99
99
|
*/
|
|
100
100
|
indexName: string;
|
|
101
101
|
/**
|
|
102
|
-
*
|
|
102
|
+
* Indicates whether changed index settings are forwarded to the replica indices.
|
|
103
103
|
*/
|
|
104
104
|
forwardToReplicas?: boolean;
|
|
105
105
|
};
|
|
@@ -108,7 +108,7 @@ export type ClearAllSynonymsProps = {
|
|
|
108
108
|
*/
|
|
109
109
|
export type ClearObjectsProps = {
|
|
110
110
|
/**
|
|
111
|
-
*
|
|
111
|
+
* Index on which to perform the request.
|
|
112
112
|
*/
|
|
113
113
|
indexName: string;
|
|
114
114
|
};
|
|
@@ -117,11 +117,11 @@ export type ClearObjectsProps = {
|
|
|
117
117
|
*/
|
|
118
118
|
export type ClearRulesProps = {
|
|
119
119
|
/**
|
|
120
|
-
*
|
|
120
|
+
* Index on which to perform the request.
|
|
121
121
|
*/
|
|
122
122
|
indexName: string;
|
|
123
123
|
/**
|
|
124
|
-
*
|
|
124
|
+
* Indicates whether changed index settings are forwarded to the replica indices.
|
|
125
125
|
*/
|
|
126
126
|
forwardToReplicas?: boolean;
|
|
127
127
|
};
|
|
@@ -130,11 +130,11 @@ export type ClearRulesProps = {
|
|
|
130
130
|
*/
|
|
131
131
|
export type DelProps = {
|
|
132
132
|
/**
|
|
133
|
-
*
|
|
133
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
134
134
|
*/
|
|
135
135
|
path: string;
|
|
136
136
|
/**
|
|
137
|
-
* Query parameters to
|
|
137
|
+
* Query parameters to apply to the current query.
|
|
138
138
|
*/
|
|
139
139
|
parameters?: Record<string, any>;
|
|
140
140
|
};
|
|
@@ -143,7 +143,7 @@ export type DelProps = {
|
|
|
143
143
|
*/
|
|
144
144
|
export type DeleteApiKeyProps = {
|
|
145
145
|
/**
|
|
146
|
-
* API
|
|
146
|
+
* API key.
|
|
147
147
|
*/
|
|
148
148
|
key: string;
|
|
149
149
|
};
|
|
@@ -152,7 +152,7 @@ export type DeleteApiKeyProps = {
|
|
|
152
152
|
*/
|
|
153
153
|
export type DeleteByProps = {
|
|
154
154
|
/**
|
|
155
|
-
*
|
|
155
|
+
* Index on which to perform the request.
|
|
156
156
|
*/
|
|
157
157
|
indexName: string;
|
|
158
158
|
deleteByParams: DeleteByParams;
|
|
@@ -162,7 +162,7 @@ export type DeleteByProps = {
|
|
|
162
162
|
*/
|
|
163
163
|
export type DeleteIndexProps = {
|
|
164
164
|
/**
|
|
165
|
-
*
|
|
165
|
+
* Index on which to perform the request.
|
|
166
166
|
*/
|
|
167
167
|
indexName: string;
|
|
168
168
|
};
|
|
@@ -171,11 +171,11 @@ export type DeleteIndexProps = {
|
|
|
171
171
|
*/
|
|
172
172
|
export type DeleteObjectProps = {
|
|
173
173
|
/**
|
|
174
|
-
*
|
|
174
|
+
* Index on which to perform the request.
|
|
175
175
|
*/
|
|
176
176
|
indexName: string;
|
|
177
177
|
/**
|
|
178
|
-
* Unique
|
|
178
|
+
* Unique record (object) identifier.
|
|
179
179
|
*/
|
|
180
180
|
objectID: string;
|
|
181
181
|
};
|
|
@@ -184,15 +184,15 @@ export type DeleteObjectProps = {
|
|
|
184
184
|
*/
|
|
185
185
|
export type DeleteRuleProps = {
|
|
186
186
|
/**
|
|
187
|
-
*
|
|
187
|
+
* Index on which to perform the request.
|
|
188
188
|
*/
|
|
189
189
|
indexName: string;
|
|
190
190
|
/**
|
|
191
|
-
* Unique identifier of
|
|
191
|
+
* Unique identifier of a rule object.
|
|
192
192
|
*/
|
|
193
193
|
objectID: string;
|
|
194
194
|
/**
|
|
195
|
-
*
|
|
195
|
+
* Indicates whether changed index settings are forwarded to the replica indices.
|
|
196
196
|
*/
|
|
197
197
|
forwardToReplicas?: boolean;
|
|
198
198
|
};
|
|
@@ -201,7 +201,7 @@ export type DeleteRuleProps = {
|
|
|
201
201
|
*/
|
|
202
202
|
export type DeleteSourceProps = {
|
|
203
203
|
/**
|
|
204
|
-
*
|
|
204
|
+
* IP address range of the source.
|
|
205
205
|
*/
|
|
206
206
|
source: string;
|
|
207
207
|
};
|
|
@@ -210,15 +210,15 @@ export type DeleteSourceProps = {
|
|
|
210
210
|
*/
|
|
211
211
|
export type DeleteSynonymProps = {
|
|
212
212
|
/**
|
|
213
|
-
*
|
|
213
|
+
* Index on which to perform the request.
|
|
214
214
|
*/
|
|
215
215
|
indexName: string;
|
|
216
216
|
/**
|
|
217
|
-
* Unique identifier of
|
|
217
|
+
* Unique identifier of a synonym object.
|
|
218
218
|
*/
|
|
219
219
|
objectID: string;
|
|
220
220
|
/**
|
|
221
|
-
*
|
|
221
|
+
* Indicates whether changed index settings are forwarded to the replica indices.
|
|
222
222
|
*/
|
|
223
223
|
forwardToReplicas?: boolean;
|
|
224
224
|
};
|
|
@@ -227,11 +227,11 @@ export type DeleteSynonymProps = {
|
|
|
227
227
|
*/
|
|
228
228
|
export type GetProps = {
|
|
229
229
|
/**
|
|
230
|
-
*
|
|
230
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
231
231
|
*/
|
|
232
232
|
path: string;
|
|
233
233
|
/**
|
|
234
|
-
* Query parameters to
|
|
234
|
+
* Query parameters to apply to the current query.
|
|
235
235
|
*/
|
|
236
236
|
parameters?: Record<string, any>;
|
|
237
237
|
};
|
|
@@ -240,7 +240,7 @@ export type GetProps = {
|
|
|
240
240
|
*/
|
|
241
241
|
export type GetApiKeyProps = {
|
|
242
242
|
/**
|
|
243
|
-
* API
|
|
243
|
+
* API key.
|
|
244
244
|
*/
|
|
245
245
|
key: string;
|
|
246
246
|
};
|
|
@@ -249,15 +249,15 @@ export type GetApiKeyProps = {
|
|
|
249
249
|
*/
|
|
250
250
|
export type GetLogsProps = {
|
|
251
251
|
/**
|
|
252
|
-
* First entry to retrieve
|
|
252
|
+
* First log entry to retrieve. Sorted by decreasing date with 0 being the most recent.
|
|
253
253
|
*/
|
|
254
254
|
offset?: number;
|
|
255
255
|
/**
|
|
256
|
-
* Maximum number of entries to retrieve.
|
|
256
|
+
* Maximum number of entries to retrieve.
|
|
257
257
|
*/
|
|
258
258
|
length?: number;
|
|
259
259
|
/**
|
|
260
|
-
* Index for which log entries should be retrieved. When omitted, log entries are retrieved
|
|
260
|
+
* Index for which log entries should be retrieved. When omitted, log entries are retrieved for all indices.
|
|
261
261
|
*/
|
|
262
262
|
indexName?: string;
|
|
263
263
|
/**
|
|
@@ -270,15 +270,15 @@ export type GetLogsProps = {
|
|
|
270
270
|
*/
|
|
271
271
|
export type GetObjectProps = {
|
|
272
272
|
/**
|
|
273
|
-
*
|
|
273
|
+
* Index on which to perform the request.
|
|
274
274
|
*/
|
|
275
275
|
indexName: string;
|
|
276
276
|
/**
|
|
277
|
-
* Unique
|
|
277
|
+
* Unique record (object) identifier.
|
|
278
278
|
*/
|
|
279
279
|
objectID: string;
|
|
280
280
|
/**
|
|
281
|
-
*
|
|
281
|
+
* Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved, even when not specified. [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) won\'t be retrieved unless the request is authenticated with the admin API key.
|
|
282
282
|
*/
|
|
283
283
|
attributesToRetrieve?: string[];
|
|
284
284
|
};
|
|
@@ -287,11 +287,11 @@ export type GetObjectProps = {
|
|
|
287
287
|
*/
|
|
288
288
|
export type GetRuleProps = {
|
|
289
289
|
/**
|
|
290
|
-
*
|
|
290
|
+
* Index on which to perform the request.
|
|
291
291
|
*/
|
|
292
292
|
indexName: string;
|
|
293
293
|
/**
|
|
294
|
-
* Unique identifier of
|
|
294
|
+
* Unique identifier of a rule object.
|
|
295
295
|
*/
|
|
296
296
|
objectID: string;
|
|
297
297
|
};
|
|
@@ -300,7 +300,7 @@ export type GetRuleProps = {
|
|
|
300
300
|
*/
|
|
301
301
|
export type GetSettingsProps = {
|
|
302
302
|
/**
|
|
303
|
-
*
|
|
303
|
+
* Index on which to perform the request.
|
|
304
304
|
*/
|
|
305
305
|
indexName: string;
|
|
306
306
|
};
|
|
@@ -309,11 +309,11 @@ export type GetSettingsProps = {
|
|
|
309
309
|
*/
|
|
310
310
|
export type GetSynonymProps = {
|
|
311
311
|
/**
|
|
312
|
-
*
|
|
312
|
+
* Index on which to perform the request.
|
|
313
313
|
*/
|
|
314
314
|
indexName: string;
|
|
315
315
|
/**
|
|
316
|
-
* Unique identifier of
|
|
316
|
+
* Unique identifier of a synonym object.
|
|
317
317
|
*/
|
|
318
318
|
objectID: string;
|
|
319
319
|
};
|
|
@@ -322,11 +322,11 @@ export type GetSynonymProps = {
|
|
|
322
322
|
*/
|
|
323
323
|
export type GetTaskProps = {
|
|
324
324
|
/**
|
|
325
|
-
*
|
|
325
|
+
* Index on which to perform the request.
|
|
326
326
|
*/
|
|
327
327
|
indexName: string;
|
|
328
328
|
/**
|
|
329
|
-
* Unique
|
|
329
|
+
* Unique task identifier.
|
|
330
330
|
*/
|
|
331
331
|
taskID: number;
|
|
332
332
|
};
|
|
@@ -344,7 +344,7 @@ export type GetUserIdProps = {
|
|
|
344
344
|
*/
|
|
345
345
|
export type HasPendingMappingsProps = {
|
|
346
346
|
/**
|
|
347
|
-
*
|
|
347
|
+
* Indicates whether to include the cluster\'s pending mapping state in the response.
|
|
348
348
|
*/
|
|
349
349
|
getClusters?: boolean;
|
|
350
350
|
};
|
|
@@ -353,20 +353,24 @@ export type HasPendingMappingsProps = {
|
|
|
353
353
|
*/
|
|
354
354
|
export type ListIndicesProps = {
|
|
355
355
|
/**
|
|
356
|
-
*
|
|
356
|
+
* Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated.
|
|
357
357
|
*/
|
|
358
358
|
page?: number;
|
|
359
|
+
/**
|
|
360
|
+
* Maximum number of hits per page.
|
|
361
|
+
*/
|
|
362
|
+
hitsPerPage?: number;
|
|
359
363
|
};
|
|
360
364
|
/**
|
|
361
365
|
* Properties for the `listUserIds` method.
|
|
362
366
|
*/
|
|
363
367
|
export type ListUserIdsProps = {
|
|
364
368
|
/**
|
|
365
|
-
*
|
|
369
|
+
* Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated.
|
|
366
370
|
*/
|
|
367
371
|
page?: number;
|
|
368
372
|
/**
|
|
369
|
-
* Maximum number of
|
|
373
|
+
* Maximum number of hits per page.
|
|
370
374
|
*/
|
|
371
375
|
hitsPerPage?: number;
|
|
372
376
|
};
|
|
@@ -375,7 +379,7 @@ export type ListUserIdsProps = {
|
|
|
375
379
|
*/
|
|
376
380
|
export type OperationIndexProps = {
|
|
377
381
|
/**
|
|
378
|
-
*
|
|
382
|
+
* Index on which to perform the request.
|
|
379
383
|
*/
|
|
380
384
|
indexName: string;
|
|
381
385
|
operationIndexParams: OperationIndexParams;
|
|
@@ -385,19 +389,19 @@ export type OperationIndexProps = {
|
|
|
385
389
|
*/
|
|
386
390
|
export type PartialUpdateObjectProps = {
|
|
387
391
|
/**
|
|
388
|
-
*
|
|
392
|
+
* Index on which to perform the request.
|
|
389
393
|
*/
|
|
390
394
|
indexName: string;
|
|
391
395
|
/**
|
|
392
|
-
* Unique
|
|
396
|
+
* Unique record (object) identifier.
|
|
393
397
|
*/
|
|
394
398
|
objectID: string;
|
|
395
399
|
/**
|
|
396
|
-
*
|
|
400
|
+
* Object with attributes to update.
|
|
397
401
|
*/
|
|
398
402
|
attributesToUpdate: Record<string, AttributeToUpdate>;
|
|
399
403
|
/**
|
|
400
|
-
*
|
|
404
|
+
* Indicates whether to create a new record if it doesn\'t exist yet.
|
|
401
405
|
*/
|
|
402
406
|
createIfNotExists?: boolean;
|
|
403
407
|
};
|
|
@@ -406,15 +410,15 @@ export type PartialUpdateObjectProps = {
|
|
|
406
410
|
*/
|
|
407
411
|
export type PostProps = {
|
|
408
412
|
/**
|
|
409
|
-
*
|
|
413
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
410
414
|
*/
|
|
411
415
|
path: string;
|
|
412
416
|
/**
|
|
413
|
-
* Query parameters to
|
|
417
|
+
* Query parameters to apply to the current query.
|
|
414
418
|
*/
|
|
415
419
|
parameters?: Record<string, any>;
|
|
416
420
|
/**
|
|
417
|
-
*
|
|
421
|
+
* Parameters to send with the custom request.
|
|
418
422
|
*/
|
|
419
423
|
body?: Record<string, any>;
|
|
420
424
|
};
|
|
@@ -423,15 +427,15 @@ export type PostProps = {
|
|
|
423
427
|
*/
|
|
424
428
|
export type PutProps = {
|
|
425
429
|
/**
|
|
426
|
-
*
|
|
430
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
427
431
|
*/
|
|
428
432
|
path: string;
|
|
429
433
|
/**
|
|
430
|
-
* Query parameters to
|
|
434
|
+
* Query parameters to apply to the current query.
|
|
431
435
|
*/
|
|
432
436
|
parameters?: Record<string, any>;
|
|
433
437
|
/**
|
|
434
|
-
*
|
|
438
|
+
* Parameters to send with the custom request.
|
|
435
439
|
*/
|
|
436
440
|
body?: Record<string, any>;
|
|
437
441
|
};
|
|
@@ -449,7 +453,7 @@ export type RemoveUserIdProps = {
|
|
|
449
453
|
*/
|
|
450
454
|
export type ReplaceSourcesProps = {
|
|
451
455
|
/**
|
|
452
|
-
*
|
|
456
|
+
* Allowed sources.
|
|
453
457
|
*/
|
|
454
458
|
source: Source[];
|
|
455
459
|
};
|
|
@@ -458,7 +462,7 @@ export type ReplaceSourcesProps = {
|
|
|
458
462
|
*/
|
|
459
463
|
export type RestoreApiKeyProps = {
|
|
460
464
|
/**
|
|
461
|
-
* API
|
|
465
|
+
* API key.
|
|
462
466
|
*/
|
|
463
467
|
key: string;
|
|
464
468
|
};
|
|
@@ -467,7 +471,7 @@ export type RestoreApiKeyProps = {
|
|
|
467
471
|
*/
|
|
468
472
|
export type SaveObjectProps = {
|
|
469
473
|
/**
|
|
470
|
-
*
|
|
474
|
+
* Index on which to perform the request.
|
|
471
475
|
*/
|
|
472
476
|
indexName: string;
|
|
473
477
|
/**
|
|
@@ -480,16 +484,16 @@ export type SaveObjectProps = {
|
|
|
480
484
|
*/
|
|
481
485
|
export type SaveRuleProps = {
|
|
482
486
|
/**
|
|
483
|
-
*
|
|
487
|
+
* Index on which to perform the request.
|
|
484
488
|
*/
|
|
485
489
|
indexName: string;
|
|
486
490
|
/**
|
|
487
|
-
* Unique identifier of
|
|
491
|
+
* Unique identifier of a rule object.
|
|
488
492
|
*/
|
|
489
493
|
objectID: string;
|
|
490
494
|
rule: Rule;
|
|
491
495
|
/**
|
|
492
|
-
*
|
|
496
|
+
* Indicates whether changed index settings are forwarded to the replica indices.
|
|
493
497
|
*/
|
|
494
498
|
forwardToReplicas?: boolean;
|
|
495
499
|
};
|
|
@@ -498,16 +502,16 @@ export type SaveRuleProps = {
|
|
|
498
502
|
*/
|
|
499
503
|
export type SaveRulesProps = {
|
|
500
504
|
/**
|
|
501
|
-
*
|
|
505
|
+
* Index on which to perform the request.
|
|
502
506
|
*/
|
|
503
507
|
indexName: string;
|
|
504
508
|
rules: Rule[];
|
|
505
509
|
/**
|
|
506
|
-
*
|
|
510
|
+
* Indicates whether changed index settings are forwarded to the replica indices.
|
|
507
511
|
*/
|
|
508
512
|
forwardToReplicas?: boolean;
|
|
509
513
|
/**
|
|
510
|
-
*
|
|
514
|
+
* Indicates whether existing rules should be deleted before adding this batch.
|
|
511
515
|
*/
|
|
512
516
|
clearExistingRules?: boolean;
|
|
513
517
|
};
|
|
@@ -516,16 +520,16 @@ export type SaveRulesProps = {
|
|
|
516
520
|
*/
|
|
517
521
|
export type SaveSynonymProps = {
|
|
518
522
|
/**
|
|
519
|
-
*
|
|
523
|
+
* Index on which to perform the request.
|
|
520
524
|
*/
|
|
521
525
|
indexName: string;
|
|
522
526
|
/**
|
|
523
|
-
* Unique identifier of
|
|
527
|
+
* Unique identifier of a synonym object.
|
|
524
528
|
*/
|
|
525
529
|
objectID: string;
|
|
526
530
|
synonymHit: SynonymHit;
|
|
527
531
|
/**
|
|
528
|
-
*
|
|
532
|
+
* Indicates whether changed index settings are forwarded to the replica indices.
|
|
529
533
|
*/
|
|
530
534
|
forwardToReplicas?: boolean;
|
|
531
535
|
};
|
|
@@ -534,16 +538,16 @@ export type SaveSynonymProps = {
|
|
|
534
538
|
*/
|
|
535
539
|
export type SaveSynonymsProps = {
|
|
536
540
|
/**
|
|
537
|
-
*
|
|
541
|
+
* Index on which to perform the request.
|
|
538
542
|
*/
|
|
539
543
|
indexName: string;
|
|
540
544
|
synonymHit: SynonymHit[];
|
|
541
545
|
/**
|
|
542
|
-
*
|
|
546
|
+
* Indicates whether changed index settings are forwarded to the replica indices.
|
|
543
547
|
*/
|
|
544
548
|
forwardToReplicas?: boolean;
|
|
545
549
|
/**
|
|
546
|
-
*
|
|
550
|
+
* Indicates whether to replace all synonyms in the index with the ones sent with this request.
|
|
547
551
|
*/
|
|
548
552
|
replaceExistingSynonyms?: boolean;
|
|
549
553
|
};
|
|
@@ -579,7 +583,7 @@ export type LegacySearchMethodProps = LegacySearchQuery[];
|
|
|
579
583
|
*/
|
|
580
584
|
export type SearchDictionaryEntriesProps = {
|
|
581
585
|
/**
|
|
582
|
-
*
|
|
586
|
+
* Dictionary to search in.
|
|
583
587
|
*/
|
|
584
588
|
dictionaryName: DictionaryType;
|
|
585
589
|
searchDictionaryEntriesParams: SearchDictionaryEntriesParams;
|
|
@@ -589,11 +593,11 @@ export type SearchDictionaryEntriesProps = {
|
|
|
589
593
|
*/
|
|
590
594
|
export type SearchForFacetValuesProps = {
|
|
591
595
|
/**
|
|
592
|
-
*
|
|
596
|
+
* Index on which to perform the request.
|
|
593
597
|
*/
|
|
594
598
|
indexName: string;
|
|
595
599
|
/**
|
|
596
|
-
*
|
|
600
|
+
* Facet name.
|
|
597
601
|
*/
|
|
598
602
|
facetName: string;
|
|
599
603
|
searchForFacetValuesRequest?: SearchForFacetValuesRequest;
|
|
@@ -603,7 +607,7 @@ export type SearchForFacetValuesProps = {
|
|
|
603
607
|
*/
|
|
604
608
|
export type SearchRulesProps = {
|
|
605
609
|
/**
|
|
606
|
-
*
|
|
610
|
+
* Index on which to perform the request.
|
|
607
611
|
*/
|
|
608
612
|
indexName: string;
|
|
609
613
|
searchRulesParams?: SearchRulesParams;
|
|
@@ -613,7 +617,7 @@ export type SearchRulesProps = {
|
|
|
613
617
|
*/
|
|
614
618
|
export type SearchSingleIndexProps = {
|
|
615
619
|
/**
|
|
616
|
-
*
|
|
620
|
+
* Index on which to perform the request.
|
|
617
621
|
*/
|
|
618
622
|
indexName: string;
|
|
619
623
|
searchParams?: SearchParams;
|
|
@@ -623,23 +627,23 @@ export type SearchSingleIndexProps = {
|
|
|
623
627
|
*/
|
|
624
628
|
export type SearchSynonymsProps = {
|
|
625
629
|
/**
|
|
626
|
-
*
|
|
630
|
+
* Index on which to perform the request.
|
|
627
631
|
*/
|
|
628
632
|
indexName: string;
|
|
629
633
|
/**
|
|
630
|
-
*
|
|
634
|
+
* Search for specific [types of synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms).
|
|
631
635
|
*/
|
|
632
636
|
type?: SynonymType;
|
|
633
637
|
/**
|
|
634
|
-
*
|
|
638
|
+
* Returns the requested page number (the first page is 0). Page size is set by `hitsPerPage`. When null, there\'s no pagination.
|
|
635
639
|
*/
|
|
636
640
|
page?: number;
|
|
637
641
|
/**
|
|
638
|
-
* Maximum number of
|
|
642
|
+
* Maximum number of hits per page.
|
|
639
643
|
*/
|
|
640
644
|
hitsPerPage?: number;
|
|
641
645
|
/**
|
|
642
|
-
*
|
|
646
|
+
* Body of the `searchSynonyms` operation.
|
|
643
647
|
*/
|
|
644
648
|
searchSynonymsParams?: SearchSynonymsParams;
|
|
645
649
|
};
|
|
@@ -648,12 +652,12 @@ export type SearchSynonymsProps = {
|
|
|
648
652
|
*/
|
|
649
653
|
export type SetSettingsProps = {
|
|
650
654
|
/**
|
|
651
|
-
*
|
|
655
|
+
* Index on which to perform the request.
|
|
652
656
|
*/
|
|
653
657
|
indexName: string;
|
|
654
658
|
indexSettings: IndexSettings;
|
|
655
659
|
/**
|
|
656
|
-
*
|
|
660
|
+
* Indicates whether changed index settings are forwarded to the replica indices.
|
|
657
661
|
*/
|
|
658
662
|
forwardToReplicas?: boolean;
|
|
659
663
|
};
|
|
@@ -662,7 +666,7 @@ export type SetSettingsProps = {
|
|
|
662
666
|
*/
|
|
663
667
|
export type UpdateApiKeyProps = {
|
|
664
668
|
/**
|
|
665
|
-
* API
|
|
669
|
+
* API key.
|
|
666
670
|
*/
|
|
667
671
|
key: string;
|
|
668
672
|
apiKey: ApiKey;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../../../client-search/model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAEpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,kBAAkB,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,gBAAgB,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,wBAAwB,EAAE,wBAAwB,CAAC;CACpD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC;IAC/B,4BAA4B,EAAE,4BAA4B,CAAC;CAC5D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,cAAc,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../../../client-search/model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAEpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,kBAAkB,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,gBAAgB,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,wBAAwB,EAAE,wBAAwB,CAAC;CACpD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC;IAC/B,4BAA4B,EAAE,4BAA4B,CAAC;CAC5D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,cAAc,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB,EAAE,oBAAoB,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IACtD;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;IACX;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,UAAU,EAAE,CAAC;IACzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF;;;;GAIG;AACH,KAAK,kBAAkB,GAAG;IACxB,MAAM,CAAC,EAAE,kBAAkB,CAAC;CAC7B,CAAC;AAEF;;;;GAIG;AACH,KAAK,qBAAqB,GAAG,kBAAkB,GAAG,sBAAsB,CAAC;AAEzE;;;;GAIG;AACH,KAAK,mBAAmB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;AAErE,KAAK,iBAAiB,GAAG,qBAAqB,GAAG,mBAAmB,CAAC;AAErE;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,EAAE,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC;IAC/B,6BAA6B,EAAE,6BAA6B,CAAC;CAC9D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,2BAA2B,CAAC,EAAE,2BAA2B,CAAC;CAC3D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;CAC7C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,aAAa,CAAC;IAC7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,OAAO,CACpC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAC3C,GACC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;AAEzD,KAAK,cAAc,GAAG,OAAO,CAAC;IAC5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAC;CACzC,CAAC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,GAAG,CACE;IACE;;OAEG;IACH,SAAS,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC5B,MAAM,CAAC,EAAE,KAAK,CAAC;CAChB,GACD;IACE;;OAEG;IACH,SAAS,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB,CACJ,CAAC"}
|
|
@@ -2,20 +2,20 @@ import type { ConsequenceHide } from './consequenceHide';
|
|
|
2
2
|
import type { ConsequenceParams } from './consequenceParams';
|
|
3
3
|
import type { Promote } from './promote';
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences) of a rule.
|
|
6
6
|
*/
|
|
7
7
|
export type Consequence = {
|
|
8
8
|
params?: ConsequenceParams;
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Records to promote.
|
|
11
11
|
*/
|
|
12
12
|
promote?: Promote[];
|
|
13
13
|
/**
|
|
14
|
-
* Only use in combination with the promote consequence. When true
|
|
14
|
+
* Only use in combination with the `promote` consequence. When `true`, promoted results will be restricted to match the filters of the current search. When `false`, the promoted results will show up regardless of the filters.
|
|
15
15
|
*/
|
|
16
16
|
filterPromotes?: boolean;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* Records to hide. By default, you can hide up to 50 records per rule.
|
|
19
19
|
*/
|
|
20
20
|
hide?: ConsequenceHide[];
|
|
21
21
|
/**
|