algoliasearch 5.0.0-alpha.99 → 5.0.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/builds/browser.ts +10 -17
- package/builds/node.ts +58 -15
- package/dist/algoliasearch/builds/browser.d.ts +10 -5
- package/dist/algoliasearch/builds/browser.d.ts.map +1 -1
- package/dist/algoliasearch/builds/node.d.ts +28 -6
- package/dist/algoliasearch/builds/node.d.ts.map +1 -1
- package/dist/algoliasearch.cjs +752 -387
- package/dist/algoliasearch.esm.browser.js +724 -393
- package/dist/algoliasearch.esm.node.js +753 -388
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/client-abtesting/model/aBTest.d.ts +14 -29
- package/dist/client-abtesting/model/aBTest.d.ts.map +1 -1
- package/dist/client-abtesting/model/aBTestConfiguration.d.ts +12 -0
- package/dist/client-abtesting/model/aBTestConfiguration.d.ts.map +1 -0
- 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 +1 -1
- package/dist/client-abtesting/model/clientMethodProps.d.ts +7 -7
- package/dist/client-abtesting/model/{currenciesValue.d.ts → currency.d.ts} +2 -2
- package/dist/client-abtesting/model/currency.d.ts.map +1 -0
- package/dist/client-abtesting/model/customSearchParams.d.ts +1 -1
- package/dist/client-abtesting/model/effect.d.ts +5 -0
- package/dist/client-abtesting/model/effect.d.ts.map +1 -0
- package/dist/client-abtesting/model/emptySearch.d.ts +10 -0
- package/dist/client-abtesting/model/emptySearch.d.ts.map +1 -0
- package/dist/client-abtesting/model/index.d.ts +7 -1
- package/dist/client-abtesting/model/index.d.ts.map +1 -1
- package/dist/client-abtesting/model/listABTestsResponse.d.ts +2 -2
- package/dist/client-abtesting/model/listABTestsResponse.d.ts.map +1 -1
- package/dist/client-abtesting/model/minimumDetectableEffect.d.ts +12 -0
- package/dist/client-abtesting/model/minimumDetectableEffect.d.ts.map +1 -0
- package/dist/client-abtesting/model/outliers.d.ts +10 -0
- package/dist/client-abtesting/model/outliers.d.ts.map +1 -0
- package/dist/client-abtesting/model/status.d.ts +5 -0
- package/dist/client-abtesting/model/status.d.ts.map +1 -0
- package/dist/client-abtesting/model/variant.d.ts +29 -25
- package/dist/client-abtesting/model/variant.d.ts.map +1 -1
- package/dist/client-abtesting/src/abtestingClient.d.ts +28 -26
- package/dist/client-abtesting/src/abtestingClient.d.ts.map +1 -1
- package/dist/client-analytics/model/clickPositionsInner.d.ts +14 -0
- package/dist/client-analytics/model/clickPositionsInner.d.ts.map +1 -0
- package/dist/client-analytics/model/clientMethodProps.d.ts +161 -90
- package/dist/client-analytics/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-analytics/model/currenciesValue.d.ts +14 -0
- package/dist/client-analytics/model/currenciesValue.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyAddToCartRates.d.ts +19 -0
- package/dist/client-analytics/model/dailyAddToCartRates.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyAverageClicks.d.ts +15 -0
- package/dist/client-analytics/model/dailyAverageClicks.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyClickThroughRates.d.ts +19 -0
- package/dist/client-analytics/model/dailyClickThroughRates.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyConversionRates.d.ts +19 -0
- package/dist/client-analytics/model/dailyConversionRates.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyNoClickRates.d.ts +19 -0
- package/dist/client-analytics/model/dailyNoClickRates.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyNoResultsRates.d.ts +19 -0
- package/dist/client-analytics/model/dailyNoResultsRates.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyPurchaseRates.d.ts +19 -0
- package/dist/client-analytics/model/dailyPurchaseRates.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyRevenue.d.ts +12 -0
- package/dist/client-analytics/model/dailyRevenue.d.ts.map +1 -0
- package/dist/client-analytics/model/dailySearches.d.ts +11 -0
- package/dist/client-analytics/model/dailySearches.d.ts.map +1 -0
- package/dist/client-analytics/model/dailySearchesNoClicks.d.ts +15 -0
- package/dist/client-analytics/model/dailySearchesNoClicks.d.ts.map +1 -0
- package/dist/client-analytics/model/dailySearchesNoResults.d.ts +15 -0
- package/dist/client-analytics/model/dailySearchesNoResults.d.ts.map +1 -0
- package/dist/client-analytics/model/dailyUsers.d.ts +11 -0
- package/dist/client-analytics/model/dailyUsers.d.ts.map +1 -0
- package/dist/client-analytics/model/getAddToCartRateResponse.d.ts +20 -0
- package/dist/client-analytics/model/getAddToCartRateResponse.d.ts.map +1 -0
- package/dist/client-analytics/model/getAverageClickPositionResponse.d.ts +6 -6
- package/dist/client-analytics/model/getAverageClickPositionResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getClickPositionsResponse.d.ts +3 -3
- package/dist/client-analytics/model/getClickPositionsResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getClickThroughRateResponse.d.ts +7 -7
- package/dist/client-analytics/model/getClickThroughRateResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getConversionRateResponse.d.ts +20 -0
- package/dist/client-analytics/model/getConversionRateResponse.d.ts.map +1 -0
- package/dist/client-analytics/model/getNoClickRateResponse.d.ts +6 -6
- package/dist/client-analytics/model/getNoClickRateResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getNoResultsRateResponse.d.ts +6 -6
- package/dist/client-analytics/model/getNoResultsRateResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getPurchaseRateResponse.d.ts +20 -0
- package/dist/client-analytics/model/getPurchaseRateResponse.d.ts.map +1 -0
- package/dist/client-analytics/model/getRevenue.d.ts +13 -0
- package/dist/client-analytics/model/getRevenue.d.ts.map +1 -0
- package/dist/client-analytics/model/getSearchesCountResponse.d.ts +3 -3
- package/dist/client-analytics/model/getSearchesCountResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getSearchesNoClicksResponse.d.ts +3 -3
- package/dist/client-analytics/model/getSearchesNoClicksResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getSearchesNoResultsResponse.d.ts +3 -3
- package/dist/client-analytics/model/getSearchesNoResultsResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getStatusResponse.d.ts +2 -2
- package/dist/client-analytics/model/getStatusResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopCountriesResponse.d.ts +1 -1
- package/dist/client-analytics/model/getTopFilterAttributesResponse.d.ts +1 -1
- package/dist/client-analytics/model/getTopFilterForAttribute.d.ts +2 -4
- package/dist/client-analytics/model/getTopFilterForAttribute.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopFiltersNoResultsResponse.d.ts +2 -2
- package/dist/client-analytics/model/getTopFiltersNoResultsResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopFiltersNoResultsValue.d.ts +2 -4
- package/dist/client-analytics/model/getTopFiltersNoResultsValue.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopHitsResponse.d.ts +2 -1
- package/dist/client-analytics/model/getTopHitsResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getTopSearchesResponse.d.ts +2 -1
- package/dist/client-analytics/model/getTopSearchesResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/getUsersCountResponse.d.ts +4 -4
- package/dist/client-analytics/model/getUsersCountResponse.d.ts.map +1 -1
- package/dist/client-analytics/model/index.d.ts +23 -11
- package/dist/client-analytics/model/index.d.ts.map +1 -1
- package/dist/client-analytics/model/operator.d.ts +5 -0
- package/dist/client-analytics/model/operator.d.ts.map +1 -0
- package/dist/client-analytics/model/orderBy.d.ts +1 -1
- package/dist/client-analytics/model/topCountry.d.ts +1 -1
- package/dist/client-analytics/model/topHit.d.ts +1 -1
- package/dist/client-analytics/model/topHitWithAnalytics.d.ts +9 -9
- package/dist/client-analytics/model/topHitWithAnalytics.d.ts.map +1 -1
- package/dist/client-analytics/model/topHitWithRevenueAnalytics.d.ts +52 -0
- package/dist/client-analytics/model/topHitWithRevenueAnalytics.d.ts.map +1 -0
- 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/topHitsResponseWithRevenueAnalytics.d.ts +8 -0
- package/dist/client-analytics/model/topHitsResponseWithRevenueAnalytics.d.ts.map +1 -0
- package/dist/client-analytics/model/topSearch.d.ts +3 -3
- package/dist/client-analytics/model/topSearchWithAnalytics.d.ts +17 -12
- package/dist/client-analytics/model/topSearchWithAnalytics.d.ts.map +1 -1
- package/dist/client-analytics/model/topSearchWithRevenueAnalytics.d.ts +65 -0
- package/dist/client-analytics/model/topSearchWithRevenueAnalytics.d.ts.map +1 -0
- 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/topSearchesResponseWithRevenueAnalytics.d.ts +8 -0
- package/dist/client-analytics/model/topSearchesResponseWithRevenueAnalytics.d.ts.map +1 -0
- package/dist/client-analytics/src/analyticsClient.d.ts +211 -138
- package/dist/client-analytics/src/analyticsClient.d.ts.map +1 -1
- package/dist/client-personalization/model/clientMethodProps.d.ts +2 -2
- package/dist/client-personalization/model/deleteUserProfileResponse.d.ts +2 -2
- package/dist/client-personalization/model/eventScoring.d.ts +4 -6
- package/dist/client-personalization/model/eventScoring.d.ts.map +1 -1
- package/dist/client-personalization/model/eventType.d.ts +5 -0
- package/dist/client-personalization/model/eventType.d.ts.map +1 -0
- package/dist/client-personalization/model/facetScoring.d.ts +2 -2
- package/dist/client-personalization/model/getUserTokenResponse.d.ts +3 -3
- package/dist/client-personalization/model/index.d.ts +1 -0
- package/dist/client-personalization/model/index.d.ts.map +1 -1
- package/dist/client-personalization/model/personalizationStrategyParams.d.ts +3 -3
- package/dist/client-personalization/src/personalizationClient.d.ts +19 -19
- package/dist/client-personalization/src/personalizationClient.d.ts.map +1 -1
- 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 +1 -1
- package/dist/client-search/model/anchoring.d.ts +1 -1
- package/dist/client-search/model/apiKey.d.ts +8 -8
- package/dist/client-search/model/apiKeyOperation.d.ts +2 -0
- package/dist/client-search/model/apiKeyOperation.d.ts.map +1 -0
- package/dist/client-search/model/aroundPrecision.d.ts +1 -1
- package/dist/client-search/model/aroundPrecisionFromValueInner.d.ts +9 -0
- package/dist/client-search/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
- package/dist/client-search/model/aroundRadius.d.ts +1 -1
- package/dist/client-search/model/aroundRadiusAll.d.ts +3 -0
- package/dist/client-search/model/aroundRadiusAll.d.ts.map +1 -1
- package/dist/client-search/model/automaticFacetFilter.d.ts +4 -4
- package/dist/client-search/model/automaticFacetFilters.d.ts +1 -1
- package/dist/client-search/model/baseGetApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/baseIndexSettings.d.ts +22 -17
- package/dist/client-search/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +26 -29
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/client-search/model/baseSearchResponse.d.ts +10 -6
- package/dist/client-search/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/client-search/model/batchDictionaryEntriesParams.d.ts +3 -3
- package/dist/client-search/model/batchResponse.d.ts +2 -2
- package/dist/client-search/model/builtInOperation.d.ts +2 -2
- package/dist/client-search/model/builtInOperationType.d.ts +1 -1
- package/dist/client-search/model/clientMethodProps.d.ts +124 -65
- package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-search/model/condition.d.ts +7 -3
- package/dist/client-search/model/condition.d.ts.map +1 -1
- package/dist/client-search/model/consequence.d.ts +5 -5
- package/dist/client-search/model/consequenceHide.d.ts +2 -2
- package/dist/client-search/model/consequenceQuery.d.ts +1 -1
- package/dist/client-search/model/consequenceQueryObject.d.ts +2 -2
- package/dist/client-search/model/createdAtResponse.d.ts +1 -1
- 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 +2 -2
- package/dist/client-search/model/dictionaryEntry.d.ts +6 -8
- package/dist/client-search/model/dictionaryEntry.d.ts.map +1 -1
- 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/edit.d.ts +1 -1
- package/dist/client-search/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/client-search/model/facetFilters.d.ts +2 -3
- package/dist/client-search/model/facetFilters.d.ts.map +1 -1
- package/dist/client-search/model/facetHits.d.ts +2 -2
- package/dist/client-search/model/facetOrdering.d.ts +2 -2
- package/dist/client-search/model/facets.d.ts +2 -2
- package/dist/client-search/model/fetchedIndex.d.ts +1 -1
- package/dist/client-search/model/getObjectsRequest.d.ts +3 -3
- package/dist/client-search/model/getObjectsResponse.d.ts +1 -1
- package/dist/client-search/model/hasPendingMappingsResponse.d.ts +1 -1
- package/dist/client-search/model/highlightResult.d.ts +1 -1
- package/dist/client-search/model/highlightResult.d.ts.map +1 -1
- package/dist/client-search/model/highlightResultOption.d.ts +3 -3
- package/dist/client-search/model/hit.d.ts +4 -4
- package/dist/client-search/model/ignorePlurals.d.ts +3 -2
- package/dist/client-search/model/ignorePlurals.d.ts.map +1 -1
- package/dist/client-search/model/index.d.ts +4 -1
- package/dist/client-search/model/index.d.ts.map +1 -1
- package/dist/client-search/model/indexSettings.d.ts +1 -1
- package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +32 -35
- package/dist/client-search/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/client-search/model/log.d.ts +11 -11
- package/dist/client-search/model/logQuery.d.ts +1 -1
- package/dist/client-search/model/matchLevel.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 +2 -3
- package/dist/client-search/model/numericFilters.d.ts.map +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 +2 -3
- package/dist/client-search/model/optionalFilters.d.ts.map +1 -1
- package/dist/client-search/model/params.d.ts +1 -1
- package/dist/client-search/model/promoteObjectID.d.ts +2 -2
- package/dist/client-search/model/promoteObjectIDs.d.ts +2 -2
- package/dist/client-search/model/queryType.d.ts +1 -1
- package/dist/client-search/model/rankingInfo.d.ts +10 -7
- package/dist/client-search/model/rankingInfo.d.ts.map +1 -1
- package/dist/client-search/model/reRankingApplyFilter.d.ts +2 -3
- package/dist/client-search/model/reRankingApplyFilter.d.ts.map +1 -1
- package/dist/client-search/model/removeStopWords.d.ts +3 -2
- package/dist/client-search/model/removeStopWords.d.ts.map +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 +3 -3
- package/dist/client-search/model/saveSynonymResponse.d.ts +2 -2
- package/dist/client-search/model/searchDictionaryEntriesParams.d.ts +5 -7
- package/dist/client-search/model/searchDictionaryEntriesParams.d.ts.map +1 -1
- package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts +20 -0
- package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
- package/dist/client-search/model/searchForFacetValuesRequest.d.ts +1 -1
- package/dist/client-search/model/searchForFacetValuesResponse.d.ts +4 -1
- package/dist/client-search/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/client-search/model/searchForFacetsOptions.d.ts +2 -2
- package/dist/client-search/model/searchForHitsOptions.d.ts +1 -1
- package/dist/client-search/model/searchHits.d.ts +6 -3
- package/dist/client-search/model/searchHits.d.ts.map +1 -1
- package/dist/client-search/model/searchParamsObject.d.ts +3 -0
- package/dist/client-search/model/searchParamsObject.d.ts.map +1 -1
- package/dist/client-search/model/searchParamsQuery.d.ts +1 -1
- package/dist/client-search/model/searchRulesParams.d.ts +4 -8
- package/dist/client-search/model/searchRulesParams.d.ts.map +1 -1
- package/dist/client-search/model/searchRulesResponse.d.ts +2 -2
- package/dist/client-search/model/searchStrategy.d.ts +1 -1
- package/dist/client-search/model/searchSynonymsParams.d.ts +2 -2
- package/dist/client-search/model/searchSynonymsResponse.d.ts +2 -2
- package/dist/client-search/model/searchUserIdsParams.d.ts +1 -1
- package/dist/client-search/model/searchUserIdsResponse.d.ts +3 -3
- package/dist/client-search/model/securedAPIKeyRestrictions.d.ts +25 -0
- package/dist/client-search/model/securedAPIKeyRestrictions.d.ts.map +1 -0
- package/dist/client-search/model/semanticSearch.d.ts +2 -2
- package/dist/client-search/model/snippetResult.d.ts +1 -1
- package/dist/client-search/model/snippetResult.d.ts.map +1 -1
- package/dist/client-search/model/snippetResultOption.d.ts +2 -2
- package/dist/client-search/model/sortRemainingBy.d.ts +1 -1
- package/dist/client-search/model/supportedLanguage.d.ts +5 -0
- package/dist/client-search/model/supportedLanguage.d.ts.map +1 -0
- package/dist/client-search/model/tagFilters.d.ts +2 -3
- package/dist/client-search/model/tagFilters.d.ts.map +1 -1
- package/dist/client-search/model/taskStatus.d.ts +1 -1
- package/dist/client-search/model/timeRange.d.ts +2 -2
- package/dist/client-search/model/typoTolerance.d.ts +1 -1
- package/dist/client-search/model/typoToleranceEnum.d.ts +3 -0
- package/dist/client-search/model/typoToleranceEnum.d.ts.map +1 -1
- package/dist/client-search/model/updateApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/updatedAtResponse.d.ts +2 -2
- package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts +3 -3
- 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 +1 -1
- package/dist/client-search/model/value.d.ts +1 -1
- package/dist/client-search/src/searchClient.d.ts +324 -202
- package/dist/client-search/src/searchClient.d.ts.map +1 -1
- package/dist/lite/builds/browser.d.ts +14 -3
- package/dist/lite/builds/browser.d.ts.map +1 -1
- package/dist/lite/builds/node.d.ts +14 -3
- package/dist/lite/builds/node.d.ts.map +1 -1
- package/dist/lite/lite.cjs +8 -6
- package/dist/lite/lite.esm.browser.js +13 -14
- package/dist/lite/lite.esm.node.js +8 -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 +1 -1
- package/dist/lite/model/anchoring.d.ts +1 -1
- package/dist/lite/model/apiKey.d.ts +8 -8
- package/dist/lite/model/apiKeyOperation.d.ts +2 -0
- package/dist/lite/model/apiKeyOperation.d.ts.map +1 -0
- package/dist/lite/model/aroundPrecision.d.ts +1 -1
- package/dist/lite/model/aroundPrecisionFromValueInner.d.ts +9 -0
- package/dist/lite/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
- package/dist/lite/model/aroundRadius.d.ts +1 -1
- package/dist/lite/model/aroundRadiusAll.d.ts +3 -0
- package/dist/lite/model/aroundRadiusAll.d.ts.map +1 -1
- package/dist/lite/model/automaticFacetFilter.d.ts +4 -4
- package/dist/lite/model/automaticFacetFilters.d.ts +1 -1
- package/dist/lite/model/baseGetApiKeyResponse.d.ts +1 -1
- package/dist/lite/model/baseIndexSettings.d.ts +22 -17
- package/dist/lite/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +26 -29
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/lite/model/baseSearchResponse.d.ts +10 -6
- package/dist/lite/model/baseSearchResponse.d.ts.map +1 -1
- package/dist/lite/model/builtInOperation.d.ts +2 -2
- package/dist/lite/model/builtInOperationType.d.ts +1 -1
- package/dist/lite/model/condition.d.ts +7 -3
- package/dist/lite/model/condition.d.ts.map +1 -1
- package/dist/lite/model/consequence.d.ts +5 -5
- package/dist/lite/model/consequenceHide.d.ts +2 -2
- package/dist/lite/model/consequenceQuery.d.ts +1 -1
- package/dist/lite/model/consequenceQueryObject.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 -8
- package/dist/lite/model/dictionaryEntry.d.ts.map +1 -1
- 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/edit.d.ts +1 -1
- package/dist/lite/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/lite/model/facetFilters.d.ts +2 -3
- package/dist/lite/model/facetFilters.d.ts.map +1 -1
- package/dist/lite/model/facetHits.d.ts +2 -2
- package/dist/lite/model/facetOrdering.d.ts +2 -2
- package/dist/lite/model/facets.d.ts +2 -2
- package/dist/lite/model/fetchedIndex.d.ts +1 -1
- package/dist/lite/model/highlightResult.d.ts +1 -1
- package/dist/lite/model/highlightResult.d.ts.map +1 -1
- package/dist/lite/model/highlightResultOption.d.ts +3 -3
- package/dist/lite/model/hit.d.ts +4 -4
- package/dist/lite/model/ignorePlurals.d.ts +3 -2
- package/dist/lite/model/ignorePlurals.d.ts.map +1 -1
- package/dist/lite/model/index.d.ts +4 -1
- package/dist/lite/model/index.d.ts.map +1 -1
- package/dist/lite/model/indexSettings.d.ts +1 -1
- package/dist/lite/model/indexSettingsAsSearchParams.d.ts +32 -35
- package/dist/lite/model/indexSettingsAsSearchParams.d.ts.map +1 -1
- package/dist/lite/model/matchLevel.d.ts +1 -1
- package/dist/lite/model/mode.d.ts +1 -1
- package/dist/lite/model/numericFilters.d.ts +2 -3
- package/dist/lite/model/numericFilters.d.ts.map +1 -1
- package/dist/lite/model/operationType.d.ts +1 -1
- package/dist/lite/model/optionalFilters.d.ts +2 -3
- package/dist/lite/model/optionalFilters.d.ts.map +1 -1
- package/dist/lite/model/params.d.ts +1 -1
- package/dist/lite/model/promoteObjectID.d.ts +2 -2
- package/dist/lite/model/promoteObjectIDs.d.ts +2 -2
- package/dist/lite/model/queryType.d.ts +1 -1
- package/dist/lite/model/rankingInfo.d.ts +10 -7
- package/dist/lite/model/rankingInfo.d.ts.map +1 -1
- package/dist/lite/model/reRankingApplyFilter.d.ts +2 -3
- package/dist/lite/model/reRankingApplyFilter.d.ts.map +1 -1
- package/dist/lite/model/removeStopWords.d.ts +3 -2
- package/dist/lite/model/removeStopWords.d.ts.map +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/searchDictionaryEntriesResponse.d.ts +20 -0
- package/dist/lite/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
- package/dist/lite/model/searchForFacetValuesResponse.d.ts +4 -1
- package/dist/lite/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/lite/model/searchForFacetsOptions.d.ts +2 -2
- package/dist/lite/model/searchForHitsOptions.d.ts +1 -1
- package/dist/lite/model/searchHits.d.ts +6 -3
- package/dist/lite/model/searchHits.d.ts.map +1 -1
- package/dist/lite/model/searchParamsObject.d.ts +3 -0
- package/dist/lite/model/searchParamsObject.d.ts.map +1 -1
- package/dist/lite/model/searchParamsQuery.d.ts +1 -1
- package/dist/lite/model/searchStrategy.d.ts +1 -1
- package/dist/lite/model/searchSynonymsResponse.d.ts +2 -2
- package/dist/lite/model/securedAPIKeyRestrictions.d.ts +25 -0
- package/dist/lite/model/securedAPIKeyRestrictions.d.ts.map +1 -0
- package/dist/lite/model/semanticSearch.d.ts +2 -2
- package/dist/lite/model/snippetResult.d.ts +1 -1
- package/dist/lite/model/snippetResult.d.ts.map +1 -1
- package/dist/lite/model/snippetResultOption.d.ts +2 -2
- package/dist/lite/model/sortRemainingBy.d.ts +1 -1
- package/dist/lite/model/supportedLanguage.d.ts +5 -0
- package/dist/lite/model/supportedLanguage.d.ts.map +1 -0
- package/dist/lite/model/tagFilters.d.ts +2 -3
- package/dist/lite/model/tagFilters.d.ts.map +1 -1
- package/dist/lite/model/taskStatus.d.ts +1 -1
- package/dist/lite/model/timeRange.d.ts +2 -2
- package/dist/lite/model/typoTolerance.d.ts +1 -1
- package/dist/lite/model/typoToleranceEnum.d.ts +3 -0
- package/dist/lite/model/typoToleranceEnum.d.ts.map +1 -1
- package/dist/lite/model/updatedRuleResponse.d.ts +3 -3
- package/dist/lite/model/userId.d.ts +1 -1
- package/dist/lite/model/value.d.ts +1 -1
- package/dist/lite/src/liteClient.d.ts +6 -9
- package/dist/lite/src/liteClient.d.ts.map +1 -1
- package/lite/builds/browser.ts +11 -6
- package/lite/builds/node.ts +10 -5
- package/lite/model/acl.ts +1 -1
- package/lite/model/action.ts +1 -1
- package/lite/model/addApiKeyResponse.ts +1 -1
- package/lite/model/anchoring.ts +1 -1
- package/lite/model/apiKey.ts +8 -8
- package/lite/model/{mixedSearchFilters.ts → apiKeyOperation.ts} +1 -1
- package/lite/model/aroundPrecision.ts +1 -1
- package/lite/model/aroundPrecisionFromValueInner.ts +9 -0
- package/lite/model/aroundRadius.ts +1 -1
- package/lite/model/aroundRadiusAll.ts +3 -0
- package/lite/model/automaticFacetFilter.ts +4 -4
- package/lite/model/automaticFacetFilters.ts +1 -1
- package/lite/model/baseGetApiKeyResponse.ts +1 -1
- package/lite/model/baseIndexSettings.ts +24 -17
- package/lite/model/baseSearchParamsWithoutQuery.ts +26 -30
- package/lite/model/baseSearchResponse.ts +11 -6
- package/lite/model/builtInOperation.ts +2 -2
- package/lite/model/builtInOperationType.ts +1 -1
- package/lite/model/condition.ts +8 -3
- package/lite/model/consequence.ts +5 -5
- package/lite/model/consequenceHide.ts +2 -2
- package/lite/model/consequenceQuery.ts +1 -1
- package/lite/model/consequenceQueryObject.ts +2 -2
- package/lite/model/cursor.ts +1 -1
- package/lite/model/deleteByParams.ts +4 -4
- package/lite/model/dictionaryEntry.ts +6 -8
- package/lite/model/dictionaryEntryState.ts +1 -1
- package/lite/model/dictionaryLanguage.ts +2 -2
- package/lite/model/distinct.ts +1 -1
- package/lite/model/edit.ts +1 -1
- package/lite/model/exactOnSingleWordQuery.ts +1 -1
- package/lite/model/facetFilters.ts +2 -4
- package/lite/model/facetHits.ts +2 -2
- package/lite/model/facetOrdering.ts +2 -2
- package/lite/model/facets.ts +2 -2
- package/lite/model/fetchedIndex.ts +1 -1
- package/lite/model/highlightResult.ts +1 -0
- package/lite/model/highlightResultOption.ts +3 -3
- package/lite/model/hit.ts +4 -4
- package/lite/model/ignorePlurals.ts +4 -2
- package/lite/model/index.ts +4 -1
- package/lite/model/indexSettings.ts +1 -1
- package/lite/model/indexSettingsAsSearchParams.ts +32 -36
- package/lite/model/matchLevel.ts +1 -1
- package/lite/model/mode.ts +1 -1
- package/lite/model/numericFilters.ts +2 -4
- package/lite/model/operationType.ts +1 -1
- package/lite/model/optionalFilters.ts +2 -4
- package/lite/model/params.ts +1 -1
- package/lite/model/promoteObjectID.ts +2 -2
- package/lite/model/promoteObjectIDs.ts +2 -2
- package/lite/model/queryType.ts +1 -1
- package/lite/model/rankingInfo.ts +10 -7
- package/lite/model/reRankingApplyFilter.ts +2 -4
- package/lite/model/removeStopWords.ts +4 -2
- package/lite/model/removeWordsIfNoResults.ts +1 -1
- package/lite/model/renderingContent.ts +1 -1
- package/lite/model/rule.ts +5 -5
- package/lite/model/searchDictionaryEntriesResponse.ts +25 -0
- package/lite/model/searchForFacetValuesResponse.ts +4 -1
- package/lite/model/searchForFacetsOptions.ts +2 -2
- package/lite/model/searchForHitsOptions.ts +1 -1
- package/lite/model/searchHits.ts +6 -3
- package/lite/model/searchParamsObject.ts +3 -0
- package/lite/model/searchParamsQuery.ts +1 -1
- package/lite/model/searchStrategy.ts +1 -1
- package/lite/model/searchSynonymsResponse.ts +2 -2
- package/lite/model/securedAPIKeyRestrictions.ts +32 -0
- package/lite/model/semanticSearch.ts +2 -2
- package/lite/model/snippetResult.ts +2 -1
- package/lite/model/snippetResultOption.ts +2 -2
- package/lite/model/sortRemainingBy.ts +1 -1
- package/lite/model/supportedLanguage.ts +74 -0
- package/lite/model/tagFilters.ts +2 -4
- package/lite/model/taskStatus.ts +1 -1
- package/lite/model/timeRange.ts +2 -2
- package/lite/model/typoTolerance.ts +1 -1
- package/lite/model/typoToleranceEnum.ts +3 -0
- package/lite/model/updatedRuleResponse.ts +3 -3
- package/lite/model/userId.ts +1 -1
- package/lite/model/value.ts +1 -1
- package/lite/src/liteClient.ts +8 -12
- package/package.json +14 -14
- package/dist/client-abtesting/model/currenciesValue.d.ts.map +0 -1
- package/dist/client-analytics/model/averageClickEvent.d.ts +0 -15
- package/dist/client-analytics/model/averageClickEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/clickPosition.d.ts +0 -11
- package/dist/client-analytics/model/clickPosition.d.ts.map +0 -1
- package/dist/client-analytics/model/clickThroughRateEvent.d.ts +0 -19
- package/dist/client-analytics/model/clickThroughRateEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/conversionRateEvent.d.ts +0 -19
- package/dist/client-analytics/model/conversionRateEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/getConversationRateResponse.d.ts +0 -20
- package/dist/client-analytics/model/getConversationRateResponse.d.ts.map +0 -1
- package/dist/client-analytics/model/noClickRateEvent.d.ts +0 -19
- package/dist/client-analytics/model/noClickRateEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/noResultsRateEvent.d.ts +0 -19
- package/dist/client-analytics/model/noResultsRateEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/searchEvent.d.ts +0 -11
- package/dist/client-analytics/model/searchEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/searchNoClickEvent.d.ts +0 -15
- package/dist/client-analytics/model/searchNoClickEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/searchNoResultEvent.d.ts +0 -15
- package/dist/client-analytics/model/searchNoResultEvent.d.ts.map +0 -1
- package/dist/client-analytics/model/userWithDate.d.ts +0 -11
- package/dist/client-analytics/model/userWithDate.d.ts.map +0 -1
- package/dist/client-search/model/mixedSearchFilters.d.ts +0 -2
- package/dist/client-search/model/mixedSearchFilters.d.ts.map +0 -1
- package/dist/lite/model/mixedSearchFilters.d.ts +0 -2
- package/dist/lite/model/mixedSearchFilters.d.ts.map +0 -1
|
@@ -1,9 +1,12 @@
|
|
|
1
1
|
import type { CreateIterablePromise } from '@algolia/client-common';
|
|
2
|
+
import type { Action } from './action';
|
|
2
3
|
import type { ApiKey } from './apiKey';
|
|
4
|
+
import type { ApiKeyOperation } from './apiKeyOperation';
|
|
3
5
|
import type { AssignUserIdParams } from './assignUserIdParams';
|
|
4
6
|
import type { AttributeToUpdate } from './attributeToUpdate';
|
|
5
7
|
import type { BatchAssignUserIdsParams } from './batchAssignUserIdsParams';
|
|
6
8
|
import type { BatchDictionaryEntriesParams } from './batchDictionaryEntriesParams';
|
|
9
|
+
import type { BatchResponse } from './batchResponse';
|
|
7
10
|
import type { BatchWriteParams } from './batchWriteParams';
|
|
8
11
|
import type { BrowseParams } from './browseParams';
|
|
9
12
|
import type { DeleteByParams } from './deleteByParams';
|
|
@@ -20,22 +23,24 @@ import type { SearchParams } from './searchParams';
|
|
|
20
23
|
import type { SearchParamsObject } from './searchParamsObject';
|
|
21
24
|
import type { SearchRulesParams } from './searchRulesParams';
|
|
22
25
|
import type { SearchSynonymsParams } from './searchSynonymsParams';
|
|
26
|
+
import type { SecuredAPIKeyRestrictions } from './securedAPIKeyRestrictions';
|
|
23
27
|
import type { Source } from './source';
|
|
24
28
|
import type { SynonymHit } from './synonymHit';
|
|
29
|
+
import type { UpdatedAtResponse } from './updatedAtResponse';
|
|
25
30
|
/**
|
|
26
31
|
* Properties for the `addOrUpdateObject` method.
|
|
27
32
|
*/
|
|
28
33
|
export type AddOrUpdateObjectProps = {
|
|
29
34
|
/**
|
|
30
|
-
*
|
|
35
|
+
* Name of the index on which to perform the operation.
|
|
31
36
|
*/
|
|
32
37
|
indexName: string;
|
|
33
38
|
/**
|
|
34
|
-
* Unique record
|
|
39
|
+
* Unique record identifier.
|
|
35
40
|
*/
|
|
36
41
|
objectID: string;
|
|
37
42
|
/**
|
|
38
|
-
*
|
|
43
|
+
* The record, a schemaless object with attributes that are useful in the context of search and discovery.
|
|
39
44
|
*/
|
|
40
45
|
body: Record<string, any>;
|
|
41
46
|
};
|
|
@@ -44,7 +49,7 @@ export type AddOrUpdateObjectProps = {
|
|
|
44
49
|
*/
|
|
45
50
|
export type AssignUserIdProps = {
|
|
46
51
|
/**
|
|
47
|
-
*
|
|
52
|
+
* Unique identifier of the user who makes the search request.
|
|
48
53
|
*/
|
|
49
54
|
xAlgoliaUserID: string;
|
|
50
55
|
assignUserIdParams: AssignUserIdParams;
|
|
@@ -54,7 +59,7 @@ export type AssignUserIdProps = {
|
|
|
54
59
|
*/
|
|
55
60
|
export type BatchProps = {
|
|
56
61
|
/**
|
|
57
|
-
*
|
|
62
|
+
* Name of the index on which to perform the operation.
|
|
58
63
|
*/
|
|
59
64
|
indexName: string;
|
|
60
65
|
batchWriteParams: BatchWriteParams;
|
|
@@ -64,7 +69,7 @@ export type BatchProps = {
|
|
|
64
69
|
*/
|
|
65
70
|
export type BatchAssignUserIdsProps = {
|
|
66
71
|
/**
|
|
67
|
-
*
|
|
72
|
+
* Unique identifier of the user who makes the search request.
|
|
68
73
|
*/
|
|
69
74
|
xAlgoliaUserID: string;
|
|
70
75
|
batchAssignUserIdsParams: BatchAssignUserIdsParams;
|
|
@@ -74,7 +79,7 @@ export type BatchAssignUserIdsProps = {
|
|
|
74
79
|
*/
|
|
75
80
|
export type BatchDictionaryEntriesProps = {
|
|
76
81
|
/**
|
|
77
|
-
* Dictionary to search
|
|
82
|
+
* Dictionary type in which to search.
|
|
78
83
|
*/
|
|
79
84
|
dictionaryName: DictionaryType;
|
|
80
85
|
batchDictionaryEntriesParams: BatchDictionaryEntriesParams;
|
|
@@ -84,7 +89,7 @@ export type BatchDictionaryEntriesProps = {
|
|
|
84
89
|
*/
|
|
85
90
|
export type BrowseProps = {
|
|
86
91
|
/**
|
|
87
|
-
*
|
|
92
|
+
* Name of the index on which to perform the operation.
|
|
88
93
|
*/
|
|
89
94
|
indexName: string;
|
|
90
95
|
browseParams?: BrowseParams;
|
|
@@ -94,7 +99,7 @@ export type BrowseProps = {
|
|
|
94
99
|
*/
|
|
95
100
|
export type ClearObjectsProps = {
|
|
96
101
|
/**
|
|
97
|
-
*
|
|
102
|
+
* Name of the index on which to perform the operation.
|
|
98
103
|
*/
|
|
99
104
|
indexName: string;
|
|
100
105
|
};
|
|
@@ -103,11 +108,11 @@ export type ClearObjectsProps = {
|
|
|
103
108
|
*/
|
|
104
109
|
export type ClearRulesProps = {
|
|
105
110
|
/**
|
|
106
|
-
*
|
|
111
|
+
* Name of the index on which to perform the operation.
|
|
107
112
|
*/
|
|
108
113
|
indexName: string;
|
|
109
114
|
/**
|
|
110
|
-
*
|
|
115
|
+
* Whether changes are applied to replica indices.
|
|
111
116
|
*/
|
|
112
117
|
forwardToReplicas?: boolean;
|
|
113
118
|
};
|
|
@@ -116,11 +121,11 @@ export type ClearRulesProps = {
|
|
|
116
121
|
*/
|
|
117
122
|
export type ClearSynonymsProps = {
|
|
118
123
|
/**
|
|
119
|
-
*
|
|
124
|
+
* Name of the index on which to perform the operation.
|
|
120
125
|
*/
|
|
121
126
|
indexName: string;
|
|
122
127
|
/**
|
|
123
|
-
*
|
|
128
|
+
* Whether changes are applied to replica indices.
|
|
124
129
|
*/
|
|
125
130
|
forwardToReplicas?: boolean;
|
|
126
131
|
};
|
|
@@ -198,7 +203,7 @@ export type DeleteApiKeyProps = {
|
|
|
198
203
|
*/
|
|
199
204
|
export type DeleteByProps = {
|
|
200
205
|
/**
|
|
201
|
-
*
|
|
206
|
+
* Name of the index on which to perform the operation.
|
|
202
207
|
*/
|
|
203
208
|
indexName: string;
|
|
204
209
|
deleteByParams: DeleteByParams;
|
|
@@ -208,7 +213,7 @@ export type DeleteByProps = {
|
|
|
208
213
|
*/
|
|
209
214
|
export type DeleteIndexProps = {
|
|
210
215
|
/**
|
|
211
|
-
*
|
|
216
|
+
* Name of the index on which to perform the operation.
|
|
212
217
|
*/
|
|
213
218
|
indexName: string;
|
|
214
219
|
};
|
|
@@ -217,11 +222,11 @@ export type DeleteIndexProps = {
|
|
|
217
222
|
*/
|
|
218
223
|
export type DeleteObjectProps = {
|
|
219
224
|
/**
|
|
220
|
-
*
|
|
225
|
+
* Name of the index on which to perform the operation.
|
|
221
226
|
*/
|
|
222
227
|
indexName: string;
|
|
223
228
|
/**
|
|
224
|
-
* Unique record
|
|
229
|
+
* Unique record identifier.
|
|
225
230
|
*/
|
|
226
231
|
objectID: string;
|
|
227
232
|
};
|
|
@@ -230,7 +235,7 @@ export type DeleteObjectProps = {
|
|
|
230
235
|
*/
|
|
231
236
|
export type DeleteRuleProps = {
|
|
232
237
|
/**
|
|
233
|
-
*
|
|
238
|
+
* Name of the index on which to perform the operation.
|
|
234
239
|
*/
|
|
235
240
|
indexName: string;
|
|
236
241
|
/**
|
|
@@ -238,7 +243,7 @@ export type DeleteRuleProps = {
|
|
|
238
243
|
*/
|
|
239
244
|
objectID: string;
|
|
240
245
|
/**
|
|
241
|
-
*
|
|
246
|
+
* Whether changes are applied to replica indices.
|
|
242
247
|
*/
|
|
243
248
|
forwardToReplicas?: boolean;
|
|
244
249
|
};
|
|
@@ -256,7 +261,7 @@ export type DeleteSourceProps = {
|
|
|
256
261
|
*/
|
|
257
262
|
export type DeleteSynonymProps = {
|
|
258
263
|
/**
|
|
259
|
-
*
|
|
264
|
+
* Name of the index on which to perform the operation.
|
|
260
265
|
*/
|
|
261
266
|
indexName: string;
|
|
262
267
|
/**
|
|
@@ -264,7 +269,7 @@ export type DeleteSynonymProps = {
|
|
|
264
269
|
*/
|
|
265
270
|
objectID: string;
|
|
266
271
|
/**
|
|
267
|
-
*
|
|
272
|
+
* Whether changes are applied to replica indices.
|
|
268
273
|
*/
|
|
269
274
|
forwardToReplicas?: boolean;
|
|
270
275
|
};
|
|
@@ -282,7 +287,7 @@ export type GetApiKeyProps = {
|
|
|
282
287
|
*/
|
|
283
288
|
export type GetLogsProps = {
|
|
284
289
|
/**
|
|
285
|
-
* First log entry to retrieve.
|
|
290
|
+
* First log entry to retrieve. The most recent entries are listed first.
|
|
286
291
|
*/
|
|
287
292
|
offset?: number;
|
|
288
293
|
/**
|
|
@@ -290,11 +295,11 @@ export type GetLogsProps = {
|
|
|
290
295
|
*/
|
|
291
296
|
length?: number;
|
|
292
297
|
/**
|
|
293
|
-
* Index for which log entries
|
|
298
|
+
* Index for which to retrieve log entries. By default, log entries are retrieved for all indices.
|
|
294
299
|
*/
|
|
295
300
|
indexName?: string;
|
|
296
301
|
/**
|
|
297
|
-
* Type of log entries to retrieve.
|
|
302
|
+
* Type of log entries to retrieve. By default, all log entries are retrieved.
|
|
298
303
|
*/
|
|
299
304
|
type?: LogType;
|
|
300
305
|
};
|
|
@@ -303,15 +308,15 @@ export type GetLogsProps = {
|
|
|
303
308
|
*/
|
|
304
309
|
export type GetObjectProps = {
|
|
305
310
|
/**
|
|
306
|
-
*
|
|
311
|
+
* Name of the index on which to perform the operation.
|
|
307
312
|
*/
|
|
308
313
|
indexName: string;
|
|
309
314
|
/**
|
|
310
|
-
* Unique record
|
|
315
|
+
* Unique record identifier.
|
|
311
316
|
*/
|
|
312
317
|
objectID: string;
|
|
313
318
|
/**
|
|
314
|
-
* 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.
|
|
319
|
+
* 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. Attributes included in `unretrievableAttributes` won\'t be retrieved unless the request is authenticated with the admin API key.
|
|
315
320
|
*/
|
|
316
321
|
attributesToRetrieve?: string[];
|
|
317
322
|
};
|
|
@@ -320,7 +325,7 @@ export type GetObjectProps = {
|
|
|
320
325
|
*/
|
|
321
326
|
export type GetRuleProps = {
|
|
322
327
|
/**
|
|
323
|
-
*
|
|
328
|
+
* Name of the index on which to perform the operation.
|
|
324
329
|
*/
|
|
325
330
|
indexName: string;
|
|
326
331
|
/**
|
|
@@ -333,7 +338,7 @@ export type GetRuleProps = {
|
|
|
333
338
|
*/
|
|
334
339
|
export type GetSettingsProps = {
|
|
335
340
|
/**
|
|
336
|
-
*
|
|
341
|
+
* Name of the index on which to perform the operation.
|
|
337
342
|
*/
|
|
338
343
|
indexName: string;
|
|
339
344
|
};
|
|
@@ -342,7 +347,7 @@ export type GetSettingsProps = {
|
|
|
342
347
|
*/
|
|
343
348
|
export type GetSynonymProps = {
|
|
344
349
|
/**
|
|
345
|
-
*
|
|
350
|
+
* Name of the index on which to perform the operation.
|
|
346
351
|
*/
|
|
347
352
|
indexName: string;
|
|
348
353
|
/**
|
|
@@ -355,7 +360,7 @@ export type GetSynonymProps = {
|
|
|
355
360
|
*/
|
|
356
361
|
export type GetTaskProps = {
|
|
357
362
|
/**
|
|
358
|
-
*
|
|
363
|
+
* Name of the index on which to perform the operation.
|
|
359
364
|
*/
|
|
360
365
|
indexName: string;
|
|
361
366
|
/**
|
|
@@ -368,7 +373,7 @@ export type GetTaskProps = {
|
|
|
368
373
|
*/
|
|
369
374
|
export type GetUserIdProps = {
|
|
370
375
|
/**
|
|
371
|
-
*
|
|
376
|
+
* Unique identifier of the user who makes the search request.
|
|
372
377
|
*/
|
|
373
378
|
userID: string;
|
|
374
379
|
};
|
|
@@ -377,7 +382,7 @@ export type GetUserIdProps = {
|
|
|
377
382
|
*/
|
|
378
383
|
export type HasPendingMappingsProps = {
|
|
379
384
|
/**
|
|
380
|
-
*
|
|
385
|
+
* Whether to include the cluster\'s pending mapping state in the response.
|
|
381
386
|
*/
|
|
382
387
|
getClusters?: boolean;
|
|
383
388
|
};
|
|
@@ -386,11 +391,11 @@ export type HasPendingMappingsProps = {
|
|
|
386
391
|
*/
|
|
387
392
|
export type ListIndicesProps = {
|
|
388
393
|
/**
|
|
389
|
-
*
|
|
394
|
+
* Requested page of the API response. If `null`, the API response is not paginated.
|
|
390
395
|
*/
|
|
391
396
|
page?: number;
|
|
392
397
|
/**
|
|
393
|
-
*
|
|
398
|
+
* Number of hits per page.
|
|
394
399
|
*/
|
|
395
400
|
hitsPerPage?: number;
|
|
396
401
|
};
|
|
@@ -399,11 +404,11 @@ export type ListIndicesProps = {
|
|
|
399
404
|
*/
|
|
400
405
|
export type ListUserIdsProps = {
|
|
401
406
|
/**
|
|
402
|
-
*
|
|
407
|
+
* Requested page of the API response. If `null`, the API response is not paginated.
|
|
403
408
|
*/
|
|
404
409
|
page?: number;
|
|
405
410
|
/**
|
|
406
|
-
*
|
|
411
|
+
* Number of hits per page.
|
|
407
412
|
*/
|
|
408
413
|
hitsPerPage?: number;
|
|
409
414
|
};
|
|
@@ -412,7 +417,7 @@ export type ListUserIdsProps = {
|
|
|
412
417
|
*/
|
|
413
418
|
export type OperationIndexProps = {
|
|
414
419
|
/**
|
|
415
|
-
*
|
|
420
|
+
* Name of the index on which to perform the operation.
|
|
416
421
|
*/
|
|
417
422
|
indexName: string;
|
|
418
423
|
operationIndexParams: OperationIndexParams;
|
|
@@ -422,19 +427,19 @@ export type OperationIndexProps = {
|
|
|
422
427
|
*/
|
|
423
428
|
export type PartialUpdateObjectProps = {
|
|
424
429
|
/**
|
|
425
|
-
*
|
|
430
|
+
* Name of the index on which to perform the operation.
|
|
426
431
|
*/
|
|
427
432
|
indexName: string;
|
|
428
433
|
/**
|
|
429
|
-
* Unique record
|
|
434
|
+
* Unique record identifier.
|
|
430
435
|
*/
|
|
431
436
|
objectID: string;
|
|
432
437
|
/**
|
|
433
|
-
*
|
|
438
|
+
* Attributes with their values.
|
|
434
439
|
*/
|
|
435
440
|
attributesToUpdate: Record<string, AttributeToUpdate>;
|
|
436
441
|
/**
|
|
437
|
-
*
|
|
442
|
+
* Whether to create a new record if it doesn\'t exist.
|
|
438
443
|
*/
|
|
439
444
|
createIfNotExists?: boolean;
|
|
440
445
|
};
|
|
@@ -443,7 +448,7 @@ export type PartialUpdateObjectProps = {
|
|
|
443
448
|
*/
|
|
444
449
|
export type RemoveUserIdProps = {
|
|
445
450
|
/**
|
|
446
|
-
*
|
|
451
|
+
* Unique identifier of the user who makes the search request.
|
|
447
452
|
*/
|
|
448
453
|
userID: string;
|
|
449
454
|
};
|
|
@@ -470,11 +475,11 @@ export type RestoreApiKeyProps = {
|
|
|
470
475
|
*/
|
|
471
476
|
export type SaveObjectProps = {
|
|
472
477
|
/**
|
|
473
|
-
*
|
|
478
|
+
* Name of the index on which to perform the operation.
|
|
474
479
|
*/
|
|
475
480
|
indexName: string;
|
|
476
481
|
/**
|
|
477
|
-
* The
|
|
482
|
+
* The record, a schemaless object with attributes that are useful in the context of search and discovery.
|
|
478
483
|
*/
|
|
479
484
|
body: Record<string, any>;
|
|
480
485
|
};
|
|
@@ -483,7 +488,7 @@ export type SaveObjectProps = {
|
|
|
483
488
|
*/
|
|
484
489
|
export type SaveRuleProps = {
|
|
485
490
|
/**
|
|
486
|
-
*
|
|
491
|
+
* Name of the index on which to perform the operation.
|
|
487
492
|
*/
|
|
488
493
|
indexName: string;
|
|
489
494
|
/**
|
|
@@ -492,7 +497,7 @@ export type SaveRuleProps = {
|
|
|
492
497
|
objectID: string;
|
|
493
498
|
rule: Rule;
|
|
494
499
|
/**
|
|
495
|
-
*
|
|
500
|
+
* Whether changes are applied to replica indices.
|
|
496
501
|
*/
|
|
497
502
|
forwardToReplicas?: boolean;
|
|
498
503
|
};
|
|
@@ -501,16 +506,16 @@ export type SaveRuleProps = {
|
|
|
501
506
|
*/
|
|
502
507
|
export type SaveRulesProps = {
|
|
503
508
|
/**
|
|
504
|
-
*
|
|
509
|
+
* Name of the index on which to perform the operation.
|
|
505
510
|
*/
|
|
506
511
|
indexName: string;
|
|
507
512
|
rules: Rule[];
|
|
508
513
|
/**
|
|
509
|
-
*
|
|
514
|
+
* Whether changes are applied to replica indices.
|
|
510
515
|
*/
|
|
511
516
|
forwardToReplicas?: boolean;
|
|
512
517
|
/**
|
|
513
|
-
*
|
|
518
|
+
* Whether existing rules should be deleted before adding this batch.
|
|
514
519
|
*/
|
|
515
520
|
clearExistingRules?: boolean;
|
|
516
521
|
};
|
|
@@ -519,7 +524,7 @@ export type SaveRulesProps = {
|
|
|
519
524
|
*/
|
|
520
525
|
export type SaveSynonymProps = {
|
|
521
526
|
/**
|
|
522
|
-
*
|
|
527
|
+
* Name of the index on which to perform the operation.
|
|
523
528
|
*/
|
|
524
529
|
indexName: string;
|
|
525
530
|
/**
|
|
@@ -528,7 +533,7 @@ export type SaveSynonymProps = {
|
|
|
528
533
|
objectID: string;
|
|
529
534
|
synonymHit: SynonymHit;
|
|
530
535
|
/**
|
|
531
|
-
*
|
|
536
|
+
* Whether changes are applied to replica indices.
|
|
532
537
|
*/
|
|
533
538
|
forwardToReplicas?: boolean;
|
|
534
539
|
};
|
|
@@ -537,16 +542,16 @@ export type SaveSynonymProps = {
|
|
|
537
542
|
*/
|
|
538
543
|
export type SaveSynonymsProps = {
|
|
539
544
|
/**
|
|
540
|
-
*
|
|
545
|
+
* Name of the index on which to perform the operation.
|
|
541
546
|
*/
|
|
542
547
|
indexName: string;
|
|
543
548
|
synonymHit: SynonymHit[];
|
|
544
549
|
/**
|
|
545
|
-
*
|
|
550
|
+
* Whether changes are applied to replica indices.
|
|
546
551
|
*/
|
|
547
552
|
forwardToReplicas?: boolean;
|
|
548
553
|
/**
|
|
549
|
-
*
|
|
554
|
+
* Whether to replace all synonyms in the index with the ones sent with this request.
|
|
550
555
|
*/
|
|
551
556
|
replaceExistingSynonyms?: boolean;
|
|
552
557
|
};
|
|
@@ -582,7 +587,7 @@ export type LegacySearchMethodProps = LegacySearchQuery[];
|
|
|
582
587
|
*/
|
|
583
588
|
export type SearchDictionaryEntriesProps = {
|
|
584
589
|
/**
|
|
585
|
-
* Dictionary to search
|
|
590
|
+
* Dictionary type in which to search.
|
|
586
591
|
*/
|
|
587
592
|
dictionaryName: DictionaryType;
|
|
588
593
|
searchDictionaryEntriesParams: SearchDictionaryEntriesParams;
|
|
@@ -592,11 +597,11 @@ export type SearchDictionaryEntriesProps = {
|
|
|
592
597
|
*/
|
|
593
598
|
export type SearchForFacetValuesProps = {
|
|
594
599
|
/**
|
|
595
|
-
*
|
|
600
|
+
* Name of the index on which to perform the operation.
|
|
596
601
|
*/
|
|
597
602
|
indexName: string;
|
|
598
603
|
/**
|
|
599
|
-
* Facet
|
|
604
|
+
* Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
|
|
600
605
|
*/
|
|
601
606
|
facetName: string;
|
|
602
607
|
searchForFacetValuesRequest?: SearchForFacetValuesRequest;
|
|
@@ -606,7 +611,7 @@ export type SearchForFacetValuesProps = {
|
|
|
606
611
|
*/
|
|
607
612
|
export type SearchRulesProps = {
|
|
608
613
|
/**
|
|
609
|
-
*
|
|
614
|
+
* Name of the index on which to perform the operation.
|
|
610
615
|
*/
|
|
611
616
|
indexName: string;
|
|
612
617
|
searchRulesParams?: SearchRulesParams;
|
|
@@ -616,7 +621,7 @@ export type SearchRulesProps = {
|
|
|
616
621
|
*/
|
|
617
622
|
export type SearchSingleIndexProps = {
|
|
618
623
|
/**
|
|
619
|
-
*
|
|
624
|
+
* Name of the index on which to perform the operation.
|
|
620
625
|
*/
|
|
621
626
|
indexName: string;
|
|
622
627
|
searchParams?: SearchParams;
|
|
@@ -626,7 +631,7 @@ export type SearchSingleIndexProps = {
|
|
|
626
631
|
*/
|
|
627
632
|
export type SearchSynonymsProps = {
|
|
628
633
|
/**
|
|
629
|
-
*
|
|
634
|
+
* Name of the index on which to perform the operation.
|
|
630
635
|
*/
|
|
631
636
|
indexName: string;
|
|
632
637
|
/**
|
|
@@ -639,12 +644,12 @@ export type SearchSynonymsProps = {
|
|
|
639
644
|
*/
|
|
640
645
|
export type SetSettingsProps = {
|
|
641
646
|
/**
|
|
642
|
-
*
|
|
647
|
+
* Name of the index on which to perform the operation.
|
|
643
648
|
*/
|
|
644
649
|
indexName: string;
|
|
645
650
|
indexSettings: IndexSettings;
|
|
646
651
|
/**
|
|
647
|
-
*
|
|
652
|
+
* Whether changes are applied to replica indices.
|
|
648
653
|
*/
|
|
649
654
|
forwardToReplicas?: boolean;
|
|
650
655
|
};
|
|
@@ -691,17 +696,71 @@ export type WaitForApiKeyOptions = WaitForOptions & {
|
|
|
691
696
|
/**
|
|
692
697
|
* The operation that has been performed, used to compute the stop condition.
|
|
693
698
|
*/
|
|
694
|
-
operation: 'add' | 'delete'
|
|
699
|
+
operation: Extract<ApiKeyOperation, 'add' | 'delete'>;
|
|
695
700
|
apiKey?: never;
|
|
696
701
|
} | {
|
|
697
702
|
/**
|
|
698
703
|
* The operation that has been performed, used to compute the stop condition.
|
|
699
704
|
*/
|
|
700
|
-
operation: 'update'
|
|
705
|
+
operation: Extract<ApiKeyOperation, 'update'>;
|
|
701
706
|
/**
|
|
702
707
|
* The updated fields, used to compute the stop condition.
|
|
703
708
|
*/
|
|
704
709
|
apiKey: Partial<ApiKey>;
|
|
705
710
|
});
|
|
711
|
+
export type GenerateSecuredApiKeyOptions = {
|
|
712
|
+
/**
|
|
713
|
+
* The base API key from which to generate the new secured one.
|
|
714
|
+
*/
|
|
715
|
+
parentApiKey: string;
|
|
716
|
+
/**
|
|
717
|
+
* A set of properties defining the restrictions of the secured API key.
|
|
718
|
+
*/
|
|
719
|
+
restrictions?: SecuredAPIKeyRestrictions;
|
|
720
|
+
};
|
|
721
|
+
export type GetSecuredApiKeyRemainingValidityOptions = {
|
|
722
|
+
/**
|
|
723
|
+
* The secured API key generated with the `generateSecuredApiKey` method.
|
|
724
|
+
*/
|
|
725
|
+
securedApiKey: string;
|
|
726
|
+
};
|
|
727
|
+
export type ChunkedBatchOptions = ReplaceAllObjectsOptions & {
|
|
728
|
+
/**
|
|
729
|
+
* The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.
|
|
730
|
+
*/
|
|
731
|
+
action?: Action;
|
|
732
|
+
/**
|
|
733
|
+
* Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
|
|
734
|
+
*/
|
|
735
|
+
waitForTasks?: boolean;
|
|
736
|
+
};
|
|
737
|
+
export type ReplaceAllObjectsOptions = {
|
|
738
|
+
/**
|
|
739
|
+
* The `indexName` to replace `objects` in.
|
|
740
|
+
*/
|
|
741
|
+
indexName: string;
|
|
742
|
+
/**
|
|
743
|
+
* The array of `objects` to store in the given Algolia `indexName`.
|
|
744
|
+
*/
|
|
745
|
+
objects: Array<Record<string, any>>;
|
|
746
|
+
/**
|
|
747
|
+
* The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
|
|
748
|
+
*/
|
|
749
|
+
batchSize?: number;
|
|
750
|
+
};
|
|
751
|
+
export type ReplaceAllObjectsResponse = {
|
|
752
|
+
/**
|
|
753
|
+
* The response of the `operationIndex` request for the `copy` operation.
|
|
754
|
+
*/
|
|
755
|
+
copyOperationResponse: UpdatedAtResponse;
|
|
756
|
+
/**
|
|
757
|
+
* The response of the `batch` request(s).
|
|
758
|
+
*/
|
|
759
|
+
batchResponses: BatchResponse[];
|
|
760
|
+
/**
|
|
761
|
+
* The response of the `operationIndex` request for the `move` operation.
|
|
762
|
+
*/
|
|
763
|
+
moveOperationResponse: UpdatedAtResponse;
|
|
764
|
+
};
|
|
706
765
|
export {};
|
|
707
766
|
//# sourceMappingURL=clientMethodProps.d.ts.map
|
|
@@ -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;
|
|
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,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,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,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,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,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;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,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,kBAAkB,GAAG;IAC/B;;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,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,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;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,cAAc,GAAG;IAC3B;;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,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,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,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,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,OAAO,CAAC,eAAe,EAAE,KAAK,GAAG,QAAQ,CAAC,CAAC;IACtD,MAAM,CAAC,EAAE,KAAK,CAAC;CAChB,GACD;IACE;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IAC9C;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB,CACJ,CAAC;AAEJ,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,yBAAyB,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,wCAAwC,GAAG;IACrD;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,wBAAwB,GAAG;IAC3D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IAEpC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,qBAAqB,EAAE,iBAAiB,CAAC;IAEzC;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;IAEhC;;OAEG;IACH,qBAAqB,EAAE,iBAAiB,CAAC;CAC1C,CAAC"}
|
|
@@ -1,17 +1,21 @@
|
|
|
1
1
|
import type { Anchoring } from './anchoring';
|
|
2
2
|
export type Condition = {
|
|
3
3
|
/**
|
|
4
|
-
* Query pattern
|
|
4
|
+
* Query pattern that triggers the rule. You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\".
|
|
5
5
|
*/
|
|
6
6
|
pattern?: string;
|
|
7
7
|
anchoring?: Anchoring;
|
|
8
8
|
/**
|
|
9
|
-
* Whether the pattern
|
|
9
|
+
* Whether the pattern should match plurals, synonyms, and typos.
|
|
10
10
|
*/
|
|
11
11
|
alternatives?: boolean;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
|
|
14
14
|
*/
|
|
15
15
|
context?: string;
|
|
16
|
+
/**
|
|
17
|
+
* Filters that trigger the rule. You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
|
|
18
|
+
*/
|
|
19
|
+
filters?: string;
|
|
16
20
|
};
|
|
17
21
|
//# sourceMappingURL=condition.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../../../../client-search/model/condition.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
|
|
1
|
+
{"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../../../../client-search/model/condition.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
|