algoliasearch 5.0.0-alpha.72 → 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 +20 -12
- package/dist/client-abtesting/model/variant.d.ts.map +1 -1
- 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
|
@@ -1,38 +1,38 @@
|
|
|
1
1
|
import type { Acl } from './acl';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* API key object.
|
|
4
4
|
*/
|
|
5
5
|
export type ApiKey = {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* [Permissions](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl) associated with the key.
|
|
8
8
|
*/
|
|
9
9
|
acl: Acl[];
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* Description of an API key for you and your team members.
|
|
12
12
|
*/
|
|
13
13
|
description?: string;
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Restricts this API key to a list of indices or index patterns. If the list is empty, all indices are allowed. Specify either an exact index name or a pattern with a leading or trailing wildcard character (or both). For example: - `dev_*` matches all indices starting with \"dev_\" - `*_dev` matches all indices ending with \"_dev\" - `*_products_*` matches all indices containing \"_products_\".
|
|
16
16
|
*/
|
|
17
17
|
indexes?: string[];
|
|
18
18
|
/**
|
|
19
|
-
* Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.
|
|
19
|
+
* Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced. > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
|
|
20
20
|
*/
|
|
21
21
|
maxHitsPerQuery?: number;
|
|
22
22
|
/**
|
|
23
|
-
* Maximum number of API calls per hour allowed from a given IP address or
|
|
23
|
+
* Maximum number of API calls per hour allowed from a given IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). Each time an API call is performed with this key, a check is performed. If there were more than the specified number of calls within the last hour, the API returns an error with the status code `429` (Too Many Requests). > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
|
|
24
24
|
*/
|
|
25
25
|
maxQueriesPerIPPerHour?: number;
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* Force some [query parameters](https://www.algolia.com/doc/api-reference/api-parameters/) to be applied for each query made with this API key. It\'s a URL-encoded query string.
|
|
28
28
|
*/
|
|
29
29
|
queryParameters?: string;
|
|
30
30
|
/**
|
|
31
|
-
* Restrict this
|
|
31
|
+
* Restrict this API key to specific [referrers](https://www.algolia.com/doc/guides/security/api-keys/in-depth/api-key-restrictions/#http-referrers). If empty, all referrers are allowed. For example: - `https://algolia.com/_*` matches all referrers starting with \"https://algolia.com/\" - `*.algolia.com` matches all referrers ending with \".algolia.com\" - `*algolia.com*` allows everything in the domain \"algolia.com\".
|
|
32
32
|
*/
|
|
33
33
|
referers?: string[];
|
|
34
34
|
/**
|
|
35
|
-
* Validity
|
|
35
|
+
* Validity duration of a key (in seconds). The key will automatically be removed after this time has expired. The default value of 0 never expires. Short-lived API keys are useful to grant temporary access to your data. For example, in mobile apps, you can\'t [control when users update your app](https://www.algolia.com/doc/guides/security/security-best-practices/#use-secured-api-keys-in-mobile-apps). So instead of encoding keys into your app as you would for a web app, you should dynamically fetch them from your mobile app\'s backend.
|
|
36
36
|
*/
|
|
37
37
|
validity?: number;
|
|
38
38
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { AroundRadiusAll } from './aroundRadiusAll';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* [Maximum radius](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#increase-the-search-radius) for a geographical search (in meters).
|
|
4
4
|
*/
|
|
5
5
|
export type AroundRadius = AroundRadiusAll | number;
|
|
6
6
|
//# sourceMappingURL=aroundRadius.d.ts.map
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export type BaseGetApiKeyResponse = {
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* API key.
|
|
4
4
|
*/
|
|
5
5
|
value?: string;
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Timestamp of creation in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time).
|
|
8
8
|
*/
|
|
9
9
|
createdAt: number;
|
|
10
10
|
};
|
|
@@ -1,54 +1,54 @@
|
|
|
1
1
|
export type BaseIndexSettings = {
|
|
2
2
|
/**
|
|
3
|
-
* Creates replicas,
|
|
3
|
+
* Creates [replicas](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/), which are copies of a primary index with the same records but different settings.
|
|
4
4
|
*/
|
|
5
5
|
replicas?: string[];
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Maximum number of hits accessible through pagination.
|
|
8
8
|
*/
|
|
9
9
|
paginationLimitedTo?: number;
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* Attributes that can\'t be retrieved at query time.
|
|
12
12
|
*/
|
|
13
13
|
unretrievableAttributes?: string[];
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
|
|
16
16
|
*/
|
|
17
17
|
disableTypoToleranceOnWords?: string[];
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Attributes in your index to which [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead) applies. This will ensure that words indexed in Katakana or Kanji can also be searched in Hiragana.
|
|
20
20
|
*/
|
|
21
21
|
attributesToTransliterate?: string[];
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* Attributes on which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.
|
|
24
24
|
*/
|
|
25
25
|
camelCaseAttributes?: string[];
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* Attributes in your index to which [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding) applies.
|
|
28
28
|
*/
|
|
29
29
|
decompoundedAttributes?: Record<string, any>;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* Set the languages of your index, for language-specific processing steps such as [tokenization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/tokenization/) and [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
|
|
32
32
|
*/
|
|
33
33
|
indexLanguages?: string[];
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* Attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).
|
|
36
36
|
*/
|
|
37
37
|
disablePrefixOnAttributes?: string[];
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* Incidates whether the engine compresses arrays with exclusively non-negative integers. When enabled, the compressed arrays may be reordered.
|
|
40
40
|
*/
|
|
41
41
|
allowCompressionOfIntegerArray?: boolean;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).
|
|
44
44
|
*/
|
|
45
45
|
numericAttributesForFiltering?: string[];
|
|
46
46
|
/**
|
|
47
|
-
*
|
|
47
|
+
* Controls which separators are added to an Algolia index as part of [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean). Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
|
|
48
48
|
*/
|
|
49
49
|
separatorsToIndex?: string;
|
|
50
50
|
/**
|
|
51
|
-
*
|
|
51
|
+
* [Attributes used for searching](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/), including determining [if matches at the beginning of a word are important (ordered) or not (unordered)](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/how-to/configuring-searchable-attributes-the-right-way/#understanding-word-position).
|
|
52
52
|
*/
|
|
53
53
|
searchableAttributes?: string[];
|
|
54
54
|
/**
|
|
@@ -56,7 +56,7 @@ export type BaseIndexSettings = {
|
|
|
56
56
|
*/
|
|
57
57
|
userData?: Record<string, any>;
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
59
|
+
* A list of characters and their normalized replacements to override Algolia\'s default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
|
|
60
60
|
*/
|
|
61
61
|
customNormalization?: Record<string, Record<string, string>>;
|
|
62
62
|
};
|
|
@@ -6,11 +6,11 @@ import type { ReRankingApplyFilter } from './reRankingApplyFilter';
|
|
|
6
6
|
import type { TagFilters } from './tagFilters';
|
|
7
7
|
export type BaseSearchParamsWithoutQuery = {
|
|
8
8
|
/**
|
|
9
|
-
* Overrides the query parameter and performs a more generic search
|
|
9
|
+
* Overrides the query parameter and performs a more generic search.
|
|
10
10
|
*/
|
|
11
11
|
similarQuery?: string;
|
|
12
12
|
/**
|
|
13
|
-
* Filter the query with numeric, facet
|
|
13
|
+
* [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
|
|
14
14
|
*/
|
|
15
15
|
filters?: string;
|
|
16
16
|
facetFilters?: FacetFilters;
|
|
@@ -18,19 +18,19 @@ export type BaseSearchParamsWithoutQuery = {
|
|
|
18
18
|
numericFilters?: NumericFilters;
|
|
19
19
|
tagFilters?: TagFilters;
|
|
20
20
|
/**
|
|
21
|
-
* Determines how to calculate
|
|
21
|
+
* Determines how to calculate [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). If `false`, maximum score is kept. If `true`, score is summed.
|
|
22
22
|
*/
|
|
23
23
|
sumOrFiltersScores?: boolean;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Returns [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts), their facet values, and the number of matching facet values.
|
|
26
26
|
*/
|
|
27
27
|
facets?: string[];
|
|
28
28
|
/**
|
|
29
|
-
* Maximum number of facet values to return for each facet
|
|
29
|
+
* Maximum number of facet values to return for each facet.
|
|
30
30
|
*/
|
|
31
31
|
maxValuesPerFacet?: number;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* Forces faceting to be applied after [de-duplication](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/) (with the distinct feature). Alternatively, the `afterDistinct` [modifier](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) of `attributesForFaceting` allows for more granular control.
|
|
34
34
|
*/
|
|
35
35
|
facetingAfterDistinct?: boolean;
|
|
36
36
|
/**
|
|
@@ -38,72 +38,72 @@ export type BaseSearchParamsWithoutQuery = {
|
|
|
38
38
|
*/
|
|
39
39
|
sortFacetValuesBy?: string;
|
|
40
40
|
/**
|
|
41
|
-
*
|
|
41
|
+
* Page to retrieve (the first page is `0`, not `1`).
|
|
42
42
|
*/
|
|
43
43
|
page?: number;
|
|
44
44
|
/**
|
|
45
|
-
*
|
|
45
|
+
* Specifies the offset of the first hit to return. > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
|
|
46
46
|
*/
|
|
47
47
|
offset?: number;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* Sets the number of hits to retrieve (for use with `offset`). > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
|
|
50
50
|
*/
|
|
51
51
|
length?: number;
|
|
52
52
|
/**
|
|
53
|
-
* Search for entries around a central geolocation, enabling a
|
|
53
|
+
* Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.
|
|
54
54
|
*/
|
|
55
55
|
aroundLatLng?: string;
|
|
56
56
|
/**
|
|
57
|
-
* Search for entries around a
|
|
57
|
+
* Search for entries around a location. The location is automatically computed from the requester\'s IP address.
|
|
58
58
|
*/
|
|
59
59
|
aroundLatLngViaIP?: boolean;
|
|
60
60
|
aroundRadius?: AroundRadius;
|
|
61
61
|
/**
|
|
62
|
-
* Precision of
|
|
62
|
+
* Precision of a geographical search (in meters), to [group results that are more or less the same distance from a central point](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/in-depth/geo-ranking-precision/).
|
|
63
63
|
*/
|
|
64
64
|
aroundPrecision?: number;
|
|
65
65
|
/**
|
|
66
|
-
* Minimum radius (in meters) used for a
|
|
66
|
+
* Minimum radius (in meters) used for a geographical search when `aroundRadius` isn\'t set.
|
|
67
67
|
*/
|
|
68
68
|
minimumAroundRadius?: number;
|
|
69
69
|
/**
|
|
70
|
-
* Search inside a rectangular area (in
|
|
70
|
+
* Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
|
|
71
71
|
*/
|
|
72
72
|
insideBoundingBox?: number[];
|
|
73
73
|
/**
|
|
74
|
-
* Search inside a polygon (in
|
|
74
|
+
* Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
|
|
75
75
|
*/
|
|
76
76
|
insidePolygon?: number[];
|
|
77
77
|
/**
|
|
78
|
-
*
|
|
78
|
+
* Changes the default values of parameters that work best for a natural language query, such as `ignorePlurals`, `removeStopWords`, `removeWordsIfNoResults`, `analyticsTags`, and `ruleContexts`. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries.
|
|
79
79
|
*/
|
|
80
80
|
naturalLanguages?: string[];
|
|
81
81
|
/**
|
|
82
|
-
*
|
|
82
|
+
* Assigns [rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) to search queries.
|
|
83
83
|
*/
|
|
84
84
|
ruleContexts?: string[];
|
|
85
85
|
/**
|
|
86
|
-
*
|
|
86
|
+
* Defines how much [Personalization affects results](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
|
|
87
87
|
*/
|
|
88
88
|
personalizationImpact?: number;
|
|
89
89
|
/**
|
|
90
|
-
* Associates a
|
|
90
|
+
* Associates a [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) with the current search.
|
|
91
91
|
*/
|
|
92
92
|
userToken?: string;
|
|
93
93
|
/**
|
|
94
|
-
*
|
|
94
|
+
* Incidates whether the search response includes [detailed ranking information](https://www.algolia.com/doc/guides/building-search-ui/going-further/backend-search/in-depth/understanding-the-api-response/#ranking-information).
|
|
95
95
|
*/
|
|
96
96
|
getRankingInfo?: boolean;
|
|
97
97
|
/**
|
|
98
|
-
*
|
|
98
|
+
* Indicates whether a query ID parameter is included in the search response. This is required for [tracking click and conversion events](https://www.algolia.com/doc/guides/sending-events/concepts/event-types/#events-related-to-algolia-requests).
|
|
99
99
|
*/
|
|
100
100
|
clickAnalytics?: boolean;
|
|
101
101
|
/**
|
|
102
|
-
*
|
|
102
|
+
* Indicates whether this query will be included in [analytics](https://www.algolia.com/doc/guides/search-analytics/guides/exclude-queries/).
|
|
103
103
|
*/
|
|
104
104
|
analytics?: boolean;
|
|
105
105
|
/**
|
|
106
|
-
*
|
|
106
|
+
* Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
107
107
|
*/
|
|
108
108
|
analyticsTags?: string[];
|
|
109
109
|
/**
|
|
@@ -111,11 +111,11 @@ export type BaseSearchParamsWithoutQuery = {
|
|
|
111
111
|
*/
|
|
112
112
|
percentileComputation?: boolean;
|
|
113
113
|
/**
|
|
114
|
-
*
|
|
114
|
+
* Incidates whether this search will be considered in A/B testing.
|
|
115
115
|
*/
|
|
116
116
|
enableABTest?: boolean;
|
|
117
117
|
/**
|
|
118
|
-
*
|
|
118
|
+
* Indicates whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
|
|
119
119
|
*/
|
|
120
120
|
enableReRanking?: boolean;
|
|
121
121
|
reRankingApplyFilter?: ReRankingApplyFilter | null;
|
|
@@ -3,35 +3,35 @@ import type { FacetsStats } from './facetsStats';
|
|
|
3
3
|
import type { RenderingContent } from './renderingContent';
|
|
4
4
|
export type BaseSearchResponse = {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* A/B test ID. This is only included in the response for indices that are part of an A/B test.
|
|
7
7
|
*/
|
|
8
8
|
abTestID?: number;
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Variant ID. This is only included in the response for indices that are part of an A/B test.
|
|
11
11
|
*/
|
|
12
12
|
abTestVariantID?: number;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Computed geographical location.
|
|
15
15
|
*/
|
|
16
16
|
aroundLatLng?: string;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* Automatically-computed radius.
|
|
19
19
|
*/
|
|
20
20
|
automaticRadius?: string;
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* Indicates whether the facet count is exhaustive (exact) or approximate.
|
|
23
23
|
*/
|
|
24
24
|
exhaustiveFacetsCount?: boolean;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Indicates whether the number of hits `nbHits` is exhaustive (exact) or approximate.
|
|
27
27
|
*/
|
|
28
28
|
exhaustiveNbHits: boolean;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* Indicates whether the search for typos was exhaustive (exact) or approximate.
|
|
31
31
|
*/
|
|
32
32
|
exhaustiveTypo?: boolean;
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* Mapping of each facet name to the corresponding facet counts.
|
|
35
35
|
*/
|
|
36
36
|
facets?: Record<string, Record<string, number>>;
|
|
37
37
|
/**
|
|
@@ -39,7 +39,7 @@ export type BaseSearchResponse = {
|
|
|
39
39
|
*/
|
|
40
40
|
facets_stats?: Record<string, FacetsStats>;
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
42
|
+
* Number of hits per page.
|
|
43
43
|
*/
|
|
44
44
|
hitsPerPage: number;
|
|
45
45
|
/**
|
|
@@ -47,36 +47,36 @@ export type BaseSearchResponse = {
|
|
|
47
47
|
*/
|
|
48
48
|
index?: string;
|
|
49
49
|
/**
|
|
50
|
-
* Index name used for the query.
|
|
50
|
+
* Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
|
|
51
51
|
*/
|
|
52
52
|
indexUsed?: string;
|
|
53
53
|
/**
|
|
54
|
-
*
|
|
54
|
+
* Warnings about the query.
|
|
55
55
|
*/
|
|
56
56
|
message?: string;
|
|
57
57
|
/**
|
|
58
|
-
* Number of hits
|
|
58
|
+
* Number of hits the search query matched.
|
|
59
59
|
*/
|
|
60
60
|
nbHits: number;
|
|
61
61
|
/**
|
|
62
|
-
* Number of pages
|
|
62
|
+
* Number of pages of results for the current query.
|
|
63
63
|
*/
|
|
64
64
|
nbPages: number;
|
|
65
65
|
/**
|
|
66
|
-
*
|
|
66
|
+
* Number of hits selected and sorted by the relevant sort algorithm.
|
|
67
67
|
*/
|
|
68
68
|
nbSortedHits?: number;
|
|
69
69
|
/**
|
|
70
|
-
*
|
|
70
|
+
* Page to retrieve (the first page is `0`, not `1`).
|
|
71
71
|
*/
|
|
72
72
|
page: number;
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
74
|
+
* URL-encoded string of all search parameters.
|
|
75
75
|
*/
|
|
76
76
|
params: string;
|
|
77
77
|
redirect?: BaseSearchResponseRedirect;
|
|
78
78
|
/**
|
|
79
|
-
*
|
|
79
|
+
* Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
|
|
80
80
|
*/
|
|
81
81
|
parsedQuery?: string;
|
|
82
82
|
/**
|
|
@@ -84,15 +84,15 @@ export type BaseSearchResponse = {
|
|
|
84
84
|
*/
|
|
85
85
|
processingTimeMS: number;
|
|
86
86
|
/**
|
|
87
|
-
*
|
|
87
|
+
* Text to search for in an index.
|
|
88
88
|
*/
|
|
89
89
|
query: string;
|
|
90
90
|
/**
|
|
91
|
-
*
|
|
91
|
+
* Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
|
|
92
92
|
*/
|
|
93
93
|
queryAfterRemoval?: string;
|
|
94
94
|
/**
|
|
95
|
-
*
|
|
95
|
+
* Host name of the server that processed the request.
|
|
96
96
|
*/
|
|
97
97
|
serverUsed?: string;
|
|
98
98
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
|
|
4
4
|
*/
|
|
5
5
|
export type BaseSearchResponseRedirect = {
|
|
6
6
|
index?: RedirectRuleIndexMetadata[];
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* `batchDictionaryEntries` parameters.
|
|
4
4
|
*/
|
|
5
5
|
export type BatchDictionaryEntriesParams = {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Incidates whether to replace all custom entries in the dictionary with the ones sent with this request.
|
|
8
8
|
*/
|
|
9
9
|
clearExistingDictionaryEntries?: boolean;
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* Operations to batch.
|
|
12
12
|
*/
|
|
13
13
|
requests: BatchDictionaryEntriesRequest[];
|
|
14
14
|
};
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export type BatchResponse = {
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
|
|
4
4
|
*/
|
|
5
5
|
taskID: number;
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Unique object (record) identifiers.
|
|
8
8
|
*/
|
|
9
9
|
objectIDs: string[];
|
|
10
10
|
};
|
|
@@ -5,7 +5,7 @@ import type { BuiltInOperationType } from './builtInOperationType';
|
|
|
5
5
|
export type BuiltInOperation = {
|
|
6
6
|
_operation: BuiltInOperationType;
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Value that corresponds to the operation, for example an `Increment` or `Decrement` step, `Add` or `Remove` value.
|
|
9
9
|
*/
|
|
10
10
|
value: string;
|
|
11
11
|
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Operation to apply to the attribute.
|
|
3
3
|
*/
|
|
4
4
|
export type BuiltInOperationType = 'Add' | 'AddUnique' | 'Decrement' | 'Increment' | 'IncrementFrom' | 'IncrementSet' | 'Remove';
|
|
5
5
|
//# sourceMappingURL=builtInOperationType.d.ts.map
|