algoliasearch 5.0.0-alpha.106 β 5.0.0-alpha.107
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/builds/browser.d.ts +2 -2
- package/dist/algoliasearch/builds/node.d.ts +2 -2
- package/dist/algoliasearch.cjs +191 -191
- package/dist/algoliasearch.esm.browser.js +191 -191
- package/dist/algoliasearch.esm.node.js +191 -191
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/client-abtesting/model/aBTestResponse.d.ts +1 -1
- package/dist/client-abtesting/model/clientMethodProps.d.ts +2 -2
- package/dist/client-abtesting/src/abtestingClient.d.ts +3 -3
- package/dist/client-analytics/model/clientMethodProps.d.ts +65 -65
- package/dist/client-analytics/model/searchNoResultEvent.d.ts +1 -1
- package/dist/client-analytics/model/topSearch.d.ts +1 -1
- package/dist/client-analytics/model/topSearchWithAnalytics.d.ts +1 -1
- package/dist/client-analytics/src/analyticsClient.d.ts +66 -66
- package/dist/client-personalization/src/personalizationClient.d.ts +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/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/baseIndexSettings.d.ts +20 -16
- package/dist/client-search/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +24 -28
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/client-search/model/baseSearchResponse.d.ts +6 -6
- 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 +63 -63
- 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/deleteByParams.d.ts +4 -4
- package/dist/client-search/model/deletedAtResponse.d.ts +1 -1
- package/dist/client-search/model/dictionaryEntry.d.ts +5 -5
- 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 +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/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/highlightResultOption.d.ts +3 -3
- package/dist/client-search/model/hit.d.ts +4 -4
- package/dist/client-search/model/ignorePlurals.d.ts +1 -1
- package/dist/client-search/model/index.d.ts +1 -0
- 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 +30 -34
- 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/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 +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 +1 -1
- package/dist/client-search/model/removeStopWords.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/rule.d.ts +5 -5
- package/dist/client-search/model/saveObjectResponse.d.ts +3 -3
- package/dist/client-search/model/saveSynonymResponse.d.ts +1 -1
- package/dist/client-search/model/searchDictionaryEntriesParams.d.ts +4 -4
- 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 +3 -0
- 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 +4 -1
- package/dist/client-search/model/searchHits.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 +2 -2
- package/dist/client-search/model/securedAPIKeyRestrictions.d.ts +5 -5
- package/dist/client-search/model/semanticSearch.d.ts +2 -2
- 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/tagFilters.d.ts +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/updatedAtResponse.d.ts +1 -1
- package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts +2 -2
- package/dist/client-search/model/updatedRuleResponse.d.ts +2 -2
- 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 +124 -123
- package/dist/client-search/src/searchClient.d.ts.map +1 -1
- package/dist/lite/lite.cjs +3 -3
- package/dist/lite/lite.esm.browser.js +3 -3
- package/dist/lite/lite.esm.node.js +3 -3
- 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/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/baseIndexSettings.d.ts +20 -16
- package/dist/lite/model/baseIndexSettings.d.ts.map +1 -1
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +24 -28
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/lite/model/baseSearchResponse.d.ts +6 -6
- 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 +5 -5
- 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 +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/highlightResultOption.d.ts +3 -3
- package/dist/lite/model/hit.d.ts +4 -4
- package/dist/lite/model/ignorePlurals.d.ts +1 -1
- package/dist/lite/model/index.d.ts +1 -0
- 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 +30 -34
- 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 +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 +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 +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/searchDictionaryEntriesResponse.d.ts +20 -0
- package/dist/lite/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
- package/dist/lite/model/searchForFacetValuesResponse.d.ts +3 -0
- 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 +4 -1
- package/dist/lite/model/searchHits.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 +5 -5
- package/dist/lite/model/semanticSearch.d.ts +2 -2
- package/dist/lite/model/snippetResultOption.d.ts +2 -2
- package/dist/lite/model/sortRemainingBy.d.ts +1 -1
- package/dist/lite/model/tagFilters.d.ts +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 +2 -2
- 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 +3 -3
- package/dist/lite/src/liteClient.d.ts.map +1 -1
- 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/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/baseIndexSettings.ts +21 -16
- package/lite/model/baseSearchParamsWithoutQuery.ts +24 -29
- package/lite/model/baseSearchResponse.ts +6 -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 +5 -5
- 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 +1 -1
- package/lite/model/facetHits.ts +2 -2
- package/lite/model/facetOrdering.ts +2 -2
- package/lite/model/facets.ts +2 -2
- package/lite/model/highlightResultOption.ts +3 -3
- package/lite/model/hit.ts +4 -4
- package/lite/model/ignorePlurals.ts +1 -1
- package/lite/model/index.ts +1 -0
- package/lite/model/indexSettings.ts +1 -1
- package/lite/model/indexSettingsAsSearchParams.ts +30 -35
- package/lite/model/matchLevel.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 +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 +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/searchDictionaryEntriesResponse.ts +25 -0
- package/lite/model/searchForFacetValuesResponse.ts +3 -0
- package/lite/model/searchForFacetsOptions.ts +2 -2
- package/lite/model/searchForHitsOptions.ts +1 -1
- package/lite/model/searchHits.ts +4 -1
- 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 +5 -5
- package/lite/model/semanticSearch.ts +2 -2
- package/lite/model/snippetResultOption.ts +2 -2
- package/lite/model/sortRemainingBy.ts +1 -1
- package/lite/model/tagFilters.ts +1 -1
- 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 +2 -2
- package/lite/model/userId.ts +1 -1
- package/lite/model/value.ts +1 -1
- package/lite/src/liteClient.ts +3 -3
- package/package.json +11 -11
package/dist/algoliasearch.cjs
CHANGED
|
@@ -5,7 +5,7 @@ var clientCommon = require('@algolia/client-common');
|
|
|
5
5
|
var requesterNodeHttp = require('@algolia/requester-node-http');
|
|
6
6
|
|
|
7
7
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
8
|
-
const apiClientVersion$4 = '5.0.0-alpha.
|
|
8
|
+
const apiClientVersion$4 = '5.0.0-alpha.107';
|
|
9
9
|
const REGIONS$2 = ['de', 'us'];
|
|
10
10
|
function getDefaultHosts$3(region) {
|
|
11
11
|
const url = !region
|
|
@@ -251,8 +251,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
251
251
|
* - analytics.
|
|
252
252
|
*
|
|
253
253
|
* @param listABTests - The listABTests object.
|
|
254
|
-
* @param listABTests.offset - Position of the
|
|
255
|
-
* @param listABTests.limit - Number of
|
|
254
|
+
* @param listABTests.offset - Position of the first item to return.
|
|
255
|
+
* @param listABTests.limit - Number of items to return.
|
|
256
256
|
* @param listABTests.indexPrefix - Only return A/B tests for indices starting with this prefix.
|
|
257
257
|
* @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
|
|
258
258
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -310,7 +310,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
310
310
|
}
|
|
311
311
|
|
|
312
312
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
313
|
-
const apiClientVersion$3 = '5.0.0-alpha.
|
|
313
|
+
const apiClientVersion$3 = '5.0.0-alpha.107';
|
|
314
314
|
const REGIONS$1 = ['de', 'us'];
|
|
315
315
|
function getDefaultHosts$2(region) {
|
|
316
316
|
const url = !region
|
|
@@ -472,9 +472,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
472
472
|
* - analytics.
|
|
473
473
|
*
|
|
474
474
|
* @param getAverageClickPosition - The getAverageClickPosition object.
|
|
475
|
-
* @param getAverageClickPosition.index - Index name
|
|
476
|
-
* @param getAverageClickPosition.startDate - Start date (
|
|
477
|
-
* @param getAverageClickPosition.endDate - End date (
|
|
475
|
+
* @param getAverageClickPosition.index - Index name.
|
|
476
|
+
* @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
477
|
+
* @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
478
478
|
* @param getAverageClickPosition.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
479
479
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
480
480
|
*/
|
|
@@ -512,9 +512,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
512
512
|
* - analytics.
|
|
513
513
|
*
|
|
514
514
|
* @param getClickPositions - The getClickPositions object.
|
|
515
|
-
* @param getClickPositions.index - Index name
|
|
516
|
-
* @param getClickPositions.startDate - Start date (
|
|
517
|
-
* @param getClickPositions.endDate - End date (
|
|
515
|
+
* @param getClickPositions.index - Index name.
|
|
516
|
+
* @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
517
|
+
* @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
518
518
|
* @param getClickPositions.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
519
519
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
520
520
|
*/
|
|
@@ -552,9 +552,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
552
552
|
* - analytics.
|
|
553
553
|
*
|
|
554
554
|
* @param getClickThroughRate - The getClickThroughRate object.
|
|
555
|
-
* @param getClickThroughRate.index - Index name
|
|
556
|
-
* @param getClickThroughRate.startDate - Start date (
|
|
557
|
-
* @param getClickThroughRate.endDate - End date (
|
|
555
|
+
* @param getClickThroughRate.index - Index name.
|
|
556
|
+
* @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
557
|
+
* @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
558
558
|
* @param getClickThroughRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
559
559
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
560
560
|
*/
|
|
@@ -592,9 +592,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
592
592
|
* - analytics.
|
|
593
593
|
*
|
|
594
594
|
* @param getConversationRate - The getConversationRate object.
|
|
595
|
-
* @param getConversationRate.index - Index name
|
|
596
|
-
* @param getConversationRate.startDate - Start date (
|
|
597
|
-
* @param getConversationRate.endDate - End date (
|
|
595
|
+
* @param getConversationRate.index - Index name.
|
|
596
|
+
* @param getConversationRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
597
|
+
* @param getConversationRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
598
598
|
* @param getConversationRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
599
599
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
600
600
|
*/
|
|
@@ -632,9 +632,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
632
632
|
* - analytics.
|
|
633
633
|
*
|
|
634
634
|
* @param getNoClickRate - The getNoClickRate object.
|
|
635
|
-
* @param getNoClickRate.index - Index name
|
|
636
|
-
* @param getNoClickRate.startDate - Start date (
|
|
637
|
-
* @param getNoClickRate.endDate - End date (
|
|
635
|
+
* @param getNoClickRate.index - Index name.
|
|
636
|
+
* @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
637
|
+
* @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
638
638
|
* @param getNoClickRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
639
639
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
640
640
|
*/
|
|
@@ -672,9 +672,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
672
672
|
* - analytics.
|
|
673
673
|
*
|
|
674
674
|
* @param getNoResultsRate - The getNoResultsRate object.
|
|
675
|
-
* @param getNoResultsRate.index - Index name
|
|
676
|
-
* @param getNoResultsRate.startDate - Start date (
|
|
677
|
-
* @param getNoResultsRate.endDate - End date (
|
|
675
|
+
* @param getNoResultsRate.index - Index name.
|
|
676
|
+
* @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
677
|
+
* @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
678
678
|
* @param getNoResultsRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
679
679
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
680
680
|
*/
|
|
@@ -712,9 +712,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
712
712
|
* - analytics.
|
|
713
713
|
*
|
|
714
714
|
* @param getSearchesCount - The getSearchesCount object.
|
|
715
|
-
* @param getSearchesCount.index - Index name
|
|
716
|
-
* @param getSearchesCount.startDate - Start date (
|
|
717
|
-
* @param getSearchesCount.endDate - End date (
|
|
715
|
+
* @param getSearchesCount.index - Index name.
|
|
716
|
+
* @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
717
|
+
* @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
718
718
|
* @param getSearchesCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
719
719
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
720
720
|
*/
|
|
@@ -752,11 +752,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
752
752
|
* - analytics.
|
|
753
753
|
*
|
|
754
754
|
* @param getSearchesNoClicks - The getSearchesNoClicks object.
|
|
755
|
-
* @param getSearchesNoClicks.index - Index name
|
|
756
|
-
* @param getSearchesNoClicks.startDate - Start date (
|
|
757
|
-
* @param getSearchesNoClicks.endDate - End date (
|
|
758
|
-
* @param getSearchesNoClicks.limit - Number of
|
|
759
|
-
* @param getSearchesNoClicks.offset - Position of the
|
|
755
|
+
* @param getSearchesNoClicks.index - Index name.
|
|
756
|
+
* @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
757
|
+
* @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
758
|
+
* @param getSearchesNoClicks.limit - Number of items to return.
|
|
759
|
+
* @param getSearchesNoClicks.offset - Position of the first item to return.
|
|
760
760
|
* @param getSearchesNoClicks.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
761
761
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
762
762
|
*/
|
|
@@ -800,11 +800,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
800
800
|
* - analytics.
|
|
801
801
|
*
|
|
802
802
|
* @param getSearchesNoResults - The getSearchesNoResults object.
|
|
803
|
-
* @param getSearchesNoResults.index - Index name
|
|
804
|
-
* @param getSearchesNoResults.startDate - Start date (
|
|
805
|
-
* @param getSearchesNoResults.endDate - End date (
|
|
806
|
-
* @param getSearchesNoResults.limit - Number of
|
|
807
|
-
* @param getSearchesNoResults.offset - Position of the
|
|
803
|
+
* @param getSearchesNoResults.index - Index name.
|
|
804
|
+
* @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
805
|
+
* @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
806
|
+
* @param getSearchesNoResults.limit - Number of items to return.
|
|
807
|
+
* @param getSearchesNoResults.offset - Position of the first item to return.
|
|
808
808
|
* @param getSearchesNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
809
809
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
810
810
|
*/
|
|
@@ -848,7 +848,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
848
848
|
* - analytics.
|
|
849
849
|
*
|
|
850
850
|
* @param getStatus - The getStatus object.
|
|
851
|
-
* @param getStatus.index - Index name
|
|
851
|
+
* @param getStatus.index - Index name.
|
|
852
852
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
853
853
|
*/
|
|
854
854
|
getStatus({ index }, requestOptions) {
|
|
@@ -876,11 +876,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
876
876
|
* - analytics.
|
|
877
877
|
*
|
|
878
878
|
* @param getTopCountries - The getTopCountries object.
|
|
879
|
-
* @param getTopCountries.index - Index name
|
|
880
|
-
* @param getTopCountries.startDate - Start date (
|
|
881
|
-
* @param getTopCountries.endDate - End date (
|
|
882
|
-
* @param getTopCountries.limit - Number of
|
|
883
|
-
* @param getTopCountries.offset - Position of the
|
|
879
|
+
* @param getTopCountries.index - Index name.
|
|
880
|
+
* @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
881
|
+
* @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
882
|
+
* @param getTopCountries.limit - Number of items to return.
|
|
883
|
+
* @param getTopCountries.offset - Position of the first item to return.
|
|
884
884
|
* @param getTopCountries.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
885
885
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
886
886
|
*/
|
|
@@ -924,12 +924,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
924
924
|
* - analytics.
|
|
925
925
|
*
|
|
926
926
|
* @param getTopFilterAttributes - The getTopFilterAttributes object.
|
|
927
|
-
* @param getTopFilterAttributes.index - Index name
|
|
927
|
+
* @param getTopFilterAttributes.index - Index name.
|
|
928
928
|
* @param getTopFilterAttributes.search - User query.
|
|
929
|
-
* @param getTopFilterAttributes.startDate - Start date (
|
|
930
|
-
* @param getTopFilterAttributes.endDate - End date (
|
|
931
|
-
* @param getTopFilterAttributes.limit - Number of
|
|
932
|
-
* @param getTopFilterAttributes.offset - Position of the
|
|
929
|
+
* @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
930
|
+
* @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
931
|
+
* @param getTopFilterAttributes.limit - Number of items to return.
|
|
932
|
+
* @param getTopFilterAttributes.offset - Position of the first item to return.
|
|
933
933
|
* @param getTopFilterAttributes.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
934
934
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
935
935
|
*/
|
|
@@ -977,12 +977,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
977
977
|
*
|
|
978
978
|
* @param getTopFilterForAttribute - The getTopFilterForAttribute object.
|
|
979
979
|
* @param getTopFilterForAttribute.attribute - Attribute name.
|
|
980
|
-
* @param getTopFilterForAttribute.index - Index name
|
|
980
|
+
* @param getTopFilterForAttribute.index - Index name.
|
|
981
981
|
* @param getTopFilterForAttribute.search - User query.
|
|
982
|
-
* @param getTopFilterForAttribute.startDate - Start date (
|
|
983
|
-
* @param getTopFilterForAttribute.endDate - End date (
|
|
984
|
-
* @param getTopFilterForAttribute.limit - Number of
|
|
985
|
-
* @param getTopFilterForAttribute.offset - Position of the
|
|
982
|
+
* @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
983
|
+
* @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
984
|
+
* @param getTopFilterForAttribute.limit - Number of items to return.
|
|
985
|
+
* @param getTopFilterForAttribute.offset - Position of the first item to return.
|
|
986
986
|
* @param getTopFilterForAttribute.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
987
987
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
988
988
|
*/
|
|
@@ -1032,12 +1032,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1032
1032
|
* - analytics.
|
|
1033
1033
|
*
|
|
1034
1034
|
* @param getTopFiltersNoResults - The getTopFiltersNoResults object.
|
|
1035
|
-
* @param getTopFiltersNoResults.index - Index name
|
|
1035
|
+
* @param getTopFiltersNoResults.index - Index name.
|
|
1036
1036
|
* @param getTopFiltersNoResults.search - User query.
|
|
1037
|
-
* @param getTopFiltersNoResults.startDate - Start date (
|
|
1038
|
-
* @param getTopFiltersNoResults.endDate - End date (
|
|
1039
|
-
* @param getTopFiltersNoResults.limit - Number of
|
|
1040
|
-
* @param getTopFiltersNoResults.offset - Position of the
|
|
1037
|
+
* @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1038
|
+
* @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1039
|
+
* @param getTopFiltersNoResults.limit - Number of items to return.
|
|
1040
|
+
* @param getTopFiltersNoResults.offset - Position of the first item to return.
|
|
1041
1041
|
* @param getTopFiltersNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
1042
1042
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1043
1043
|
*/
|
|
@@ -1084,13 +1084,13 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1084
1084
|
* - analytics.
|
|
1085
1085
|
*
|
|
1086
1086
|
* @param getTopHits - The getTopHits object.
|
|
1087
|
-
* @param getTopHits.index - Index name
|
|
1087
|
+
* @param getTopHits.index - Index name.
|
|
1088
1088
|
* @param getTopHits.search - User query.
|
|
1089
1089
|
* @param getTopHits.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
|
|
1090
|
-
* @param getTopHits.startDate - Start date (
|
|
1091
|
-
* @param getTopHits.endDate - End date (
|
|
1092
|
-
* @param getTopHits.limit - Number of
|
|
1093
|
-
* @param getTopHits.offset - Position of the
|
|
1090
|
+
* @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1091
|
+
* @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1092
|
+
* @param getTopHits.limit - Number of items to return.
|
|
1093
|
+
* @param getTopHits.offset - Position of the first item to return.
|
|
1094
1094
|
* @param getTopHits.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
1095
1095
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1096
1096
|
*/
|
|
@@ -1140,14 +1140,14 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1140
1140
|
* - analytics.
|
|
1141
1141
|
*
|
|
1142
1142
|
* @param getTopSearches - The getTopSearches object.
|
|
1143
|
-
* @param getTopSearches.index - Index name
|
|
1143
|
+
* @param getTopSearches.index - Index name.
|
|
1144
1144
|
* @param getTopSearches.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
|
|
1145
|
-
* @param getTopSearches.startDate - Start date (
|
|
1146
|
-
* @param getTopSearches.endDate - End date (
|
|
1145
|
+
* @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1146
|
+
* @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1147
1147
|
* @param getTopSearches.orderBy - Reorder the results.
|
|
1148
1148
|
* @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
|
|
1149
|
-
* @param getTopSearches.limit - Number of
|
|
1150
|
-
* @param getTopSearches.offset - Position of the
|
|
1149
|
+
* @param getTopSearches.limit - Number of items to return.
|
|
1150
|
+
* @param getTopSearches.offset - Position of the first item to return.
|
|
1151
1151
|
* @param getTopSearches.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
1152
1152
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1153
1153
|
*/
|
|
@@ -1200,9 +1200,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1200
1200
|
* - analytics.
|
|
1201
1201
|
*
|
|
1202
1202
|
* @param getUsersCount - The getUsersCount object.
|
|
1203
|
-
* @param getUsersCount.index - Index name
|
|
1204
|
-
* @param getUsersCount.startDate - Start date (
|
|
1205
|
-
* @param getUsersCount.endDate - End date (
|
|
1203
|
+
* @param getUsersCount.index - Index name.
|
|
1204
|
+
* @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1205
|
+
* @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1206
1206
|
* @param getUsersCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
|
|
1207
1207
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1208
1208
|
*/
|
|
@@ -1237,7 +1237,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1237
1237
|
}
|
|
1238
1238
|
|
|
1239
1239
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
1240
|
-
const apiClientVersion$2 = '5.0.0-alpha.
|
|
1240
|
+
const apiClientVersion$2 = '5.0.0-alpha.107';
|
|
1241
1241
|
const REGIONS = ['eu', 'us'];
|
|
1242
1242
|
function getDefaultHosts$1(region) {
|
|
1243
1243
|
const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
|
|
@@ -1498,7 +1498,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
1498
1498
|
}
|
|
1499
1499
|
|
|
1500
1500
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
1501
|
-
const apiClientVersion$1 = '5.0.0-alpha.
|
|
1501
|
+
const apiClientVersion$1 = '5.0.0-alpha.107';
|
|
1502
1502
|
function getDefaultHosts(appId) {
|
|
1503
1503
|
return [
|
|
1504
1504
|
{
|
|
@@ -1836,7 +1836,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1836
1836
|
return { copyOperationResponse, batchResponses, moveOperationResponse };
|
|
1837
1837
|
},
|
|
1838
1838
|
/**
|
|
1839
|
-
*
|
|
1839
|
+
* Creates a new API key with specific permissions and restrictions.
|
|
1840
1840
|
*
|
|
1841
1841
|
* Required API Key ACLs:
|
|
1842
1842
|
* - admin.
|
|
@@ -1864,15 +1864,15 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1864
1864
|
return transporter.request(request, requestOptions);
|
|
1865
1865
|
},
|
|
1866
1866
|
/**
|
|
1867
|
-
* If
|
|
1867
|
+
* If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
|
|
1868
1868
|
*
|
|
1869
1869
|
* Required API Key ACLs:
|
|
1870
1870
|
* - addObject.
|
|
1871
1871
|
*
|
|
1872
1872
|
* @param addOrUpdateObject - The addOrUpdateObject object.
|
|
1873
|
-
* @param addOrUpdateObject.indexName -
|
|
1874
|
-
* @param addOrUpdateObject.objectID - Unique record
|
|
1875
|
-
* @param addOrUpdateObject.body -
|
|
1873
|
+
* @param addOrUpdateObject.indexName - Name of the index on which to perform the operation.
|
|
1874
|
+
* @param addOrUpdateObject.objectID - Unique record identifier.
|
|
1875
|
+
* @param addOrUpdateObject.body - The record, a schemaless object with attributes that are useful in the context of search and discovery.
|
|
1876
1876
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1877
1877
|
*/
|
|
1878
1878
|
addOrUpdateObject({ indexName, objectID, body }, requestOptions) {
|
|
@@ -1900,7 +1900,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1900
1900
|
return transporter.request(request, requestOptions);
|
|
1901
1901
|
},
|
|
1902
1902
|
/**
|
|
1903
|
-
*
|
|
1903
|
+
* Adds a source to the list of allowed sources.
|
|
1904
1904
|
*
|
|
1905
1905
|
* Required API Key ACLs:
|
|
1906
1906
|
* - admin.
|
|
@@ -1928,13 +1928,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1928
1928
|
return transporter.request(request, requestOptions);
|
|
1929
1929
|
},
|
|
1930
1930
|
/**
|
|
1931
|
-
*
|
|
1931
|
+
* Assigns or moves a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID.
|
|
1932
1932
|
*
|
|
1933
1933
|
* Required API Key ACLs:
|
|
1934
1934
|
* - admin.
|
|
1935
1935
|
*
|
|
1936
1936
|
* @param assignUserId - The assignUserId object.
|
|
1937
|
-
* @param assignUserId.xAlgoliaUserID -
|
|
1937
|
+
* @param assignUserId.xAlgoliaUserID - User ID to assign.
|
|
1938
1938
|
* @param assignUserId.assignUserIdParams - The assignUserIdParams object.
|
|
1939
1939
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1940
1940
|
*/
|
|
@@ -1964,10 +1964,10 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1964
1964
|
return transporter.request(request, requestOptions);
|
|
1965
1965
|
},
|
|
1966
1966
|
/**
|
|
1967
|
-
*
|
|
1967
|
+
* Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they\'re specified. - Actions are equivalent to the individual API requests of the same name.
|
|
1968
1968
|
*
|
|
1969
1969
|
* @param batch - The batch object.
|
|
1970
|
-
* @param batch.indexName -
|
|
1970
|
+
* @param batch.indexName - Name of the index on which to perform the operation.
|
|
1971
1971
|
* @param batch.batchWriteParams - The batchWriteParams object.
|
|
1972
1972
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1973
1973
|
*/
|
|
@@ -1994,13 +1994,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
1994
1994
|
return transporter.request(request, requestOptions);
|
|
1995
1995
|
},
|
|
1996
1996
|
/**
|
|
1997
|
-
*
|
|
1997
|
+
* Assigns multiple user IDs to a cluster. **You can\'t move users with this operation**.
|
|
1998
1998
|
*
|
|
1999
1999
|
* Required API Key ACLs:
|
|
2000
2000
|
* - admin.
|
|
2001
2001
|
*
|
|
2002
2002
|
* @param batchAssignUserIds - The batchAssignUserIds object.
|
|
2003
|
-
* @param batchAssignUserIds.xAlgoliaUserID -
|
|
2003
|
+
* @param batchAssignUserIds.xAlgoliaUserID - User ID to assign.
|
|
2004
2004
|
* @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
|
|
2005
2005
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2006
2006
|
*/
|
|
@@ -2033,13 +2033,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2033
2033
|
return transporter.request(request, requestOptions);
|
|
2034
2034
|
},
|
|
2035
2035
|
/**
|
|
2036
|
-
*
|
|
2036
|
+
* Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
|
|
2037
2037
|
*
|
|
2038
2038
|
* Required API Key ACLs:
|
|
2039
2039
|
* - editSettings.
|
|
2040
2040
|
*
|
|
2041
2041
|
* @param batchDictionaryEntries - The batchDictionaryEntries object.
|
|
2042
|
-
* @param batchDictionaryEntries.dictionaryName - Dictionary to search
|
|
2042
|
+
* @param batchDictionaryEntries.dictionaryName - Dictionary type in which to search.
|
|
2043
2043
|
* @param batchDictionaryEntries.batchDictionaryEntriesParams - The batchDictionaryEntriesParams object.
|
|
2044
2044
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2045
2045
|
*/
|
|
@@ -2066,13 +2066,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2066
2066
|
return transporter.request(request, requestOptions);
|
|
2067
2067
|
},
|
|
2068
2068
|
/**
|
|
2069
|
-
*
|
|
2069
|
+
* Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn\'t collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There\'s no ranking for: typo-tolerance, number of matched words, proximity, geo distance.
|
|
2070
2070
|
*
|
|
2071
2071
|
* Required API Key ACLs:
|
|
2072
2072
|
* - browse.
|
|
2073
2073
|
*
|
|
2074
2074
|
* @param browse - The browse object.
|
|
2075
|
-
* @param browse.indexName -
|
|
2075
|
+
* @param browse.indexName - Name of the index on which to perform the operation.
|
|
2076
2076
|
* @param browse.browseParams - The browseParams object.
|
|
2077
2077
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2078
2078
|
*/
|
|
@@ -2093,13 +2093,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2093
2093
|
return transporter.request(request, requestOptions);
|
|
2094
2094
|
},
|
|
2095
2095
|
/**
|
|
2096
|
-
*
|
|
2096
|
+
* Deletes only the records from an index while keeping settings, synonyms, and rules.
|
|
2097
2097
|
*
|
|
2098
2098
|
* Required API Key ACLs:
|
|
2099
2099
|
* - deleteIndex.
|
|
2100
2100
|
*
|
|
2101
2101
|
* @param clearObjects - The clearObjects object.
|
|
2102
|
-
* @param clearObjects.indexName -
|
|
2102
|
+
* @param clearObjects.indexName - Name of the index on which to perform the operation.
|
|
2103
2103
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2104
2104
|
*/
|
|
2105
2105
|
clearObjects({ indexName }, requestOptions) {
|
|
@@ -2118,14 +2118,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2118
2118
|
return transporter.request(request, requestOptions);
|
|
2119
2119
|
},
|
|
2120
2120
|
/**
|
|
2121
|
-
*
|
|
2121
|
+
* Deletes all rules from the index.
|
|
2122
2122
|
*
|
|
2123
2123
|
* Required API Key ACLs:
|
|
2124
2124
|
* - editSettings.
|
|
2125
2125
|
*
|
|
2126
2126
|
* @param clearRules - The clearRules object.
|
|
2127
|
-
* @param clearRules.indexName -
|
|
2128
|
-
* @param clearRules.forwardToReplicas -
|
|
2127
|
+
* @param clearRules.indexName - Name of the index on which to perform the operation.
|
|
2128
|
+
* @param clearRules.forwardToReplicas - Whether changes are applied to replica indices.
|
|
2129
2129
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2130
2130
|
*/
|
|
2131
2131
|
clearRules({ indexName, forwardToReplicas }, requestOptions) {
|
|
@@ -2147,14 +2147,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2147
2147
|
return transporter.request(request, requestOptions);
|
|
2148
2148
|
},
|
|
2149
2149
|
/**
|
|
2150
|
-
*
|
|
2150
|
+
* Deletes all synonyms from the index.
|
|
2151
2151
|
*
|
|
2152
2152
|
* Required API Key ACLs:
|
|
2153
2153
|
* - editSettings.
|
|
2154
2154
|
*
|
|
2155
2155
|
* @param clearSynonyms - The clearSynonyms object.
|
|
2156
|
-
* @param clearSynonyms.indexName -
|
|
2157
|
-
* @param clearSynonyms.forwardToReplicas -
|
|
2156
|
+
* @param clearSynonyms.indexName - Name of the index on which to perform the operation.
|
|
2157
|
+
* @param clearSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
|
|
2158
2158
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2159
2159
|
*/
|
|
2160
2160
|
clearSynonyms({ indexName, forwardToReplicas }, requestOptions) {
|
|
@@ -2272,7 +2272,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2272
2272
|
return transporter.request(request, requestOptions);
|
|
2273
2273
|
},
|
|
2274
2274
|
/**
|
|
2275
|
-
*
|
|
2275
|
+
* Deletes the API key.
|
|
2276
2276
|
*
|
|
2277
2277
|
* Required API Key ACLs:
|
|
2278
2278
|
* - admin.
|
|
@@ -2297,13 +2297,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2297
2297
|
return transporter.request(request, requestOptions);
|
|
2298
2298
|
},
|
|
2299
2299
|
/**
|
|
2300
|
-
* This operation doesn\'t
|
|
2300
|
+
* This operation doesn\'t accept empty queries or filters. It\'s more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).
|
|
2301
2301
|
*
|
|
2302
2302
|
* Required API Key ACLs:
|
|
2303
2303
|
* - deleteIndex.
|
|
2304
2304
|
*
|
|
2305
2305
|
* @param deleteBy - The deleteBy object.
|
|
2306
|
-
* @param deleteBy.indexName -
|
|
2306
|
+
* @param deleteBy.indexName - Name of the index on which to perform the operation.
|
|
2307
2307
|
* @param deleteBy.deleteByParams - The deleteByParams object.
|
|
2308
2308
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2309
2309
|
*/
|
|
@@ -2327,13 +2327,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2327
2327
|
return transporter.request(request, requestOptions);
|
|
2328
2328
|
},
|
|
2329
2329
|
/**
|
|
2330
|
-
*
|
|
2330
|
+
* Deletes an index and all its settings. - Deleting an index doesn\'t delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).
|
|
2331
2331
|
*
|
|
2332
2332
|
* Required API Key ACLs:
|
|
2333
2333
|
* - deleteIndex.
|
|
2334
2334
|
*
|
|
2335
2335
|
* @param deleteIndex - The deleteIndex object.
|
|
2336
|
-
* @param deleteIndex.indexName -
|
|
2336
|
+
* @param deleteIndex.indexName - Name of the index on which to perform the operation.
|
|
2337
2337
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2338
2338
|
*/
|
|
2339
2339
|
deleteIndex({ indexName }, requestOptions) {
|
|
@@ -2352,14 +2352,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2352
2352
|
return transporter.request(request, requestOptions);
|
|
2353
2353
|
},
|
|
2354
2354
|
/**
|
|
2355
|
-
* To delete
|
|
2355
|
+
* Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).
|
|
2356
2356
|
*
|
|
2357
2357
|
* Required API Key ACLs:
|
|
2358
2358
|
* - deleteObject.
|
|
2359
2359
|
*
|
|
2360
2360
|
* @param deleteObject - The deleteObject object.
|
|
2361
|
-
* @param deleteObject.indexName -
|
|
2362
|
-
* @param deleteObject.objectID - Unique record
|
|
2361
|
+
* @param deleteObject.indexName - Name of the index on which to perform the operation.
|
|
2362
|
+
* @param deleteObject.objectID - Unique record identifier.
|
|
2363
2363
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2364
2364
|
*/
|
|
2365
2365
|
deleteObject({ indexName, objectID }, requestOptions) {
|
|
@@ -2383,15 +2383,15 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2383
2383
|
return transporter.request(request, requestOptions);
|
|
2384
2384
|
},
|
|
2385
2385
|
/**
|
|
2386
|
-
*
|
|
2386
|
+
* Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](#tag/Rules/operation/searchRules).
|
|
2387
2387
|
*
|
|
2388
2388
|
* Required API Key ACLs:
|
|
2389
2389
|
* - editSettings.
|
|
2390
2390
|
*
|
|
2391
2391
|
* @param deleteRule - The deleteRule object.
|
|
2392
|
-
* @param deleteRule.indexName -
|
|
2392
|
+
* @param deleteRule.indexName - Name of the index on which to perform the operation.
|
|
2393
2393
|
* @param deleteRule.objectID - Unique identifier of a rule object.
|
|
2394
|
-
* @param deleteRule.forwardToReplicas -
|
|
2394
|
+
* @param deleteRule.forwardToReplicas - Whether changes are applied to replica indices.
|
|
2395
2395
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2396
2396
|
*/
|
|
2397
2397
|
deleteRule({ indexName, objectID, forwardToReplicas }, requestOptions) {
|
|
@@ -2418,7 +2418,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2418
2418
|
return transporter.request(request, requestOptions);
|
|
2419
2419
|
},
|
|
2420
2420
|
/**
|
|
2421
|
-
*
|
|
2421
|
+
* Deletes a source from the list of allowed sources.
|
|
2422
2422
|
*
|
|
2423
2423
|
* Required API Key ACLs:
|
|
2424
2424
|
* - admin.
|
|
@@ -2443,15 +2443,15 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2443
2443
|
return transporter.request(request, requestOptions);
|
|
2444
2444
|
},
|
|
2445
2445
|
/**
|
|
2446
|
-
*
|
|
2446
|
+
* Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
|
|
2447
2447
|
*
|
|
2448
2448
|
* Required API Key ACLs:
|
|
2449
2449
|
* - editSettings.
|
|
2450
2450
|
*
|
|
2451
2451
|
* @param deleteSynonym - The deleteSynonym object.
|
|
2452
|
-
* @param deleteSynonym.indexName -
|
|
2452
|
+
* @param deleteSynonym.indexName - Name of the index on which to perform the operation.
|
|
2453
2453
|
* @param deleteSynonym.objectID - Unique identifier of a synonym object.
|
|
2454
|
-
* @param deleteSynonym.forwardToReplicas -
|
|
2454
|
+
* @param deleteSynonym.forwardToReplicas - Whether changes are applied to replica indices.
|
|
2455
2455
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2456
2456
|
*/
|
|
2457
2457
|
deleteSynonym({ indexName, objectID, forwardToReplicas }, requestOptions) {
|
|
@@ -2478,7 +2478,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2478
2478
|
return transporter.request(request, requestOptions);
|
|
2479
2479
|
},
|
|
2480
2480
|
/**
|
|
2481
|
-
*
|
|
2481
|
+
* Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key.
|
|
2482
2482
|
*
|
|
2483
2483
|
* @param getApiKey - The getApiKey object.
|
|
2484
2484
|
* @param getApiKey.key - API key.
|
|
@@ -2500,7 +2500,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2500
2500
|
return transporter.request(request, requestOptions);
|
|
2501
2501
|
},
|
|
2502
2502
|
/**
|
|
2503
|
-
* Lists
|
|
2503
|
+
* Lists supported languages with their supported dictionary types and number of custom entries.
|
|
2504
2504
|
*
|
|
2505
2505
|
* Required API Key ACLs:
|
|
2506
2506
|
* - settings.
|
|
@@ -2520,7 +2520,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2520
2520
|
return transporter.request(request, requestOptions);
|
|
2521
2521
|
},
|
|
2522
2522
|
/**
|
|
2523
|
-
*
|
|
2523
|
+
* Retrieves the languages for which standard dictionary entries are turned off.
|
|
2524
2524
|
*
|
|
2525
2525
|
* Required API Key ACLs:
|
|
2526
2526
|
* - settings.
|
|
@@ -2540,16 +2540,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2540
2540
|
return transporter.request(request, requestOptions);
|
|
2541
2541
|
},
|
|
2542
2542
|
/**
|
|
2543
|
-
* The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days.
|
|
2543
|
+
* The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn\'t appear in the logs itself.
|
|
2544
2544
|
*
|
|
2545
2545
|
* Required API Key ACLs:
|
|
2546
2546
|
* - logs.
|
|
2547
2547
|
*
|
|
2548
2548
|
* @param getLogs - The getLogs object.
|
|
2549
|
-
* @param getLogs.offset - First log entry to retrieve.
|
|
2549
|
+
* @param getLogs.offset - First log entry to retrieve. The most recent entries are listed first.
|
|
2550
2550
|
* @param getLogs.length - Maximum number of entries to retrieve.
|
|
2551
|
-
* @param getLogs.indexName - Index for which log entries
|
|
2552
|
-
* @param getLogs.type - Type of log entries to retrieve.
|
|
2551
|
+
* @param getLogs.indexName - Index for which to retrieve log entries. By default, log entries are retrieved for all indices.
|
|
2552
|
+
* @param getLogs.type - Type of log entries to retrieve. By default, all log entries are retrieved.
|
|
2553
2553
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2554
2554
|
*/
|
|
2555
2555
|
getLogs({ offset, length, indexName, type } = {}, requestOptions = undefined) {
|
|
@@ -2577,15 +2577,15 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2577
2577
|
return transporter.request(request, requestOptions);
|
|
2578
2578
|
},
|
|
2579
2579
|
/**
|
|
2580
|
-
* To
|
|
2580
|
+
* Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
|
|
2581
2581
|
*
|
|
2582
2582
|
* Required API Key ACLs:
|
|
2583
2583
|
* - search.
|
|
2584
2584
|
*
|
|
2585
2585
|
* @param getObject - The getObject object.
|
|
2586
|
-
* @param getObject.indexName -
|
|
2587
|
-
* @param getObject.objectID - Unique record
|
|
2588
|
-
* @param getObject.attributesToRetrieve - 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.
|
|
2586
|
+
* @param getObject.indexName - Name of the index on which to perform the operation.
|
|
2587
|
+
* @param getObject.objectID - Unique record identifier.
|
|
2588
|
+
* @param getObject.attributesToRetrieve - 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.
|
|
2589
2589
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2590
2590
|
*/
|
|
2591
2591
|
getObject({ indexName, objectID, attributesToRetrieve }, requestOptions) {
|
|
@@ -2612,7 +2612,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2612
2612
|
return transporter.request(request, requestOptions);
|
|
2613
2613
|
},
|
|
2614
2614
|
/**
|
|
2615
|
-
*
|
|
2615
|
+
* Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.
|
|
2616
2616
|
*
|
|
2617
2617
|
* Required API Key ACLs:
|
|
2618
2618
|
* - search.
|
|
@@ -2642,13 +2642,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2642
2642
|
return transporter.request(request, requestOptions);
|
|
2643
2643
|
},
|
|
2644
2644
|
/**
|
|
2645
|
-
*
|
|
2645
|
+
* Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
|
|
2646
2646
|
*
|
|
2647
2647
|
* Required API Key ACLs:
|
|
2648
2648
|
* - settings.
|
|
2649
2649
|
*
|
|
2650
2650
|
* @param getRule - The getRule object.
|
|
2651
|
-
* @param getRule.indexName -
|
|
2651
|
+
* @param getRule.indexName - Name of the index on which to perform the operation.
|
|
2652
2652
|
* @param getRule.objectID - Unique identifier of a rule object.
|
|
2653
2653
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2654
2654
|
*/
|
|
@@ -2673,13 +2673,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2673
2673
|
return transporter.request(request, requestOptions);
|
|
2674
2674
|
},
|
|
2675
2675
|
/**
|
|
2676
|
-
*
|
|
2676
|
+
* Retrieves an object with non-null index settings.
|
|
2677
2677
|
*
|
|
2678
2678
|
* Required API Key ACLs:
|
|
2679
2679
|
* - search.
|
|
2680
2680
|
*
|
|
2681
2681
|
* @param getSettings - The getSettings object.
|
|
2682
|
-
* @param getSettings.indexName -
|
|
2682
|
+
* @param getSettings.indexName - Name of the index on which to perform the operation.
|
|
2683
2683
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2684
2684
|
*/
|
|
2685
2685
|
getSettings({ indexName }, requestOptions) {
|
|
@@ -2698,7 +2698,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2698
2698
|
return transporter.request(request, requestOptions);
|
|
2699
2699
|
},
|
|
2700
2700
|
/**
|
|
2701
|
-
*
|
|
2701
|
+
* Retrieves all allowed IP addresses with access to your application.
|
|
2702
2702
|
*
|
|
2703
2703
|
* Required API Key ACLs:
|
|
2704
2704
|
* - admin.
|
|
@@ -2718,13 +2718,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2718
2718
|
return transporter.request(request, requestOptions);
|
|
2719
2719
|
},
|
|
2720
2720
|
/**
|
|
2721
|
-
*
|
|
2721
|
+
* Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
|
|
2722
2722
|
*
|
|
2723
2723
|
* Required API Key ACLs:
|
|
2724
2724
|
* - settings.
|
|
2725
2725
|
*
|
|
2726
2726
|
* @param getSynonym - The getSynonym object.
|
|
2727
|
-
* @param getSynonym.indexName -
|
|
2727
|
+
* @param getSynonym.indexName - Name of the index on which to perform the operation.
|
|
2728
2728
|
* @param getSynonym.objectID - Unique identifier of a synonym object.
|
|
2729
2729
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2730
2730
|
*/
|
|
@@ -2749,13 +2749,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2749
2749
|
return transporter.request(request, requestOptions);
|
|
2750
2750
|
},
|
|
2751
2751
|
/**
|
|
2752
|
-
*
|
|
2752
|
+
* Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server. The indexing tasks\' responses include a task ID that you can use to check the status.
|
|
2753
2753
|
*
|
|
2754
2754
|
* Required API Key ACLs:
|
|
2755
2755
|
* - addObject.
|
|
2756
2756
|
*
|
|
2757
2757
|
* @param getTask - The getTask object.
|
|
2758
|
-
* @param getTask.indexName -
|
|
2758
|
+
* @param getTask.indexName - Name of the index on which to perform the operation.
|
|
2759
2759
|
* @param getTask.taskID - Unique task identifier.
|
|
2760
2760
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2761
2761
|
*/
|
|
@@ -2780,7 +2780,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2780
2780
|
return transporter.request(request, requestOptions);
|
|
2781
2781
|
},
|
|
2782
2782
|
/**
|
|
2783
|
-
* Get the IDs of the 10 users with the highest number of records per cluster.
|
|
2783
|
+
* Get the IDs of the 10 users with the highest number of records per cluster. Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
|
|
2784
2784
|
*
|
|
2785
2785
|
* Required API Key ACLs:
|
|
2786
2786
|
* - admin.
|
|
@@ -2800,13 +2800,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2800
2800
|
return transporter.request(request, requestOptions);
|
|
2801
2801
|
},
|
|
2802
2802
|
/**
|
|
2803
|
-
* Returns the
|
|
2803
|
+
* Returns the user ID data stored in the mapping. Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
|
|
2804
2804
|
*
|
|
2805
2805
|
* Required API Key ACLs:
|
|
2806
2806
|
* - admin.
|
|
2807
2807
|
*
|
|
2808
2808
|
* @param getUserId - The getUserId object.
|
|
2809
|
-
* @param getUserId.userID -
|
|
2809
|
+
* @param getUserId.userID - User ID to assign.
|
|
2810
2810
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2811
2811
|
*/
|
|
2812
2812
|
getUserId({ userID }, requestOptions) {
|
|
@@ -2831,7 +2831,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2831
2831
|
* - admin.
|
|
2832
2832
|
*
|
|
2833
2833
|
* @param hasPendingMappings - The hasPendingMappings object.
|
|
2834
|
-
* @param hasPendingMappings.getClusters -
|
|
2834
|
+
* @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
|
|
2835
2835
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2836
2836
|
*/
|
|
2837
2837
|
hasPendingMappings({ getClusters } = {}, requestOptions = undefined) {
|
|
@@ -2850,7 +2850,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2850
2850
|
return transporter.request(request, requestOptions);
|
|
2851
2851
|
},
|
|
2852
2852
|
/**
|
|
2853
|
-
*
|
|
2853
|
+
* Lists all API keys associated with your Algolia application, including their permissions and restrictions.
|
|
2854
2854
|
*
|
|
2855
2855
|
* Required API Key ACLs:
|
|
2856
2856
|
* - admin.
|
|
@@ -2870,7 +2870,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2870
2870
|
return transporter.request(request, requestOptions);
|
|
2871
2871
|
},
|
|
2872
2872
|
/**
|
|
2873
|
-
*
|
|
2873
|
+
* Lists the available clusters in a multi-cluster setup.
|
|
2874
2874
|
*
|
|
2875
2875
|
* Required API Key ACLs:
|
|
2876
2876
|
* - admin.
|
|
@@ -2890,14 +2890,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2890
2890
|
return transporter.request(request, requestOptions);
|
|
2891
2891
|
},
|
|
2892
2892
|
/**
|
|
2893
|
-
*
|
|
2893
|
+
* Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.
|
|
2894
2894
|
*
|
|
2895
2895
|
* Required API Key ACLs:
|
|
2896
2896
|
* - listIndexes.
|
|
2897
2897
|
*
|
|
2898
2898
|
* @param listIndices - The listIndices object.
|
|
2899
|
-
* @param listIndices.page -
|
|
2900
|
-
* @param listIndices.hitsPerPage -
|
|
2899
|
+
* @param listIndices.page - Requested page of the API response. If `null`, the API response is not paginated.
|
|
2900
|
+
* @param listIndices.hitsPerPage - Number of hits per page.
|
|
2901
2901
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2902
2902
|
*/
|
|
2903
2903
|
listIndices({ page, hitsPerPage } = {}, requestOptions = undefined) {
|
|
@@ -2919,14 +2919,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2919
2919
|
return transporter.request(request, requestOptions);
|
|
2920
2920
|
},
|
|
2921
2921
|
/**
|
|
2922
|
-
*
|
|
2922
|
+
* Lists the userIDs assigned to a multi-cluster application. Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
|
|
2923
2923
|
*
|
|
2924
2924
|
* Required API Key ACLs:
|
|
2925
2925
|
* - admin.
|
|
2926
2926
|
*
|
|
2927
2927
|
* @param listUserIds - The listUserIds object.
|
|
2928
|
-
* @param listUserIds.page -
|
|
2929
|
-
* @param listUserIds.hitsPerPage -
|
|
2928
|
+
* @param listUserIds.page - Requested page of the API response. If `null`, the API response is not paginated.
|
|
2929
|
+
* @param listUserIds.hitsPerPage - Number of hits per page.
|
|
2930
2930
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2931
2931
|
*/
|
|
2932
2932
|
listUserIds({ page, hitsPerPage } = {}, requestOptions = undefined) {
|
|
@@ -2948,7 +2948,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2948
2948
|
return transporter.request(request, requestOptions);
|
|
2949
2949
|
},
|
|
2950
2950
|
/**
|
|
2951
|
-
*
|
|
2951
|
+
* Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name.
|
|
2952
2952
|
*
|
|
2953
2953
|
* @param batchParams - The batchParams object.
|
|
2954
2954
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -2973,13 +2973,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2973
2973
|
return transporter.request(request, requestOptions);
|
|
2974
2974
|
},
|
|
2975
2975
|
/**
|
|
2976
|
-
*
|
|
2976
|
+
* Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for index-specific API keys and analytics data. - If the destination index doesn\'t exist yet, it\'ll be created. **Copy** - Copying a source index that doesn\'t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can\'t copy the `enableReRanking`, `mode`, and `replicas` settings. - You can\'t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn\'t exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
|
|
2977
2977
|
*
|
|
2978
2978
|
* Required API Key ACLs:
|
|
2979
2979
|
* - addObject.
|
|
2980
2980
|
*
|
|
2981
2981
|
* @param operationIndex - The operationIndex object.
|
|
2982
|
-
* @param operationIndex.indexName -
|
|
2982
|
+
* @param operationIndex.indexName - Name of the index on which to perform the operation.
|
|
2983
2983
|
* @param operationIndex.operationIndexParams - The operationIndexParams object.
|
|
2984
2984
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2985
2985
|
*/
|
|
@@ -3009,16 +3009,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3009
3009
|
return transporter.request(request, requestOptions);
|
|
3010
3010
|
},
|
|
3011
3011
|
/**
|
|
3012
|
-
*
|
|
3012
|
+
* Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn\'t exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn\'t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.
|
|
3013
3013
|
*
|
|
3014
3014
|
* Required API Key ACLs:
|
|
3015
3015
|
* - addObject.
|
|
3016
3016
|
*
|
|
3017
3017
|
* @param partialUpdateObject - The partialUpdateObject object.
|
|
3018
|
-
* @param partialUpdateObject.indexName -
|
|
3019
|
-
* @param partialUpdateObject.objectID - Unique record
|
|
3020
|
-
* @param partialUpdateObject.attributesToUpdate -
|
|
3021
|
-
* @param partialUpdateObject.createIfNotExists -
|
|
3018
|
+
* @param partialUpdateObject.indexName - Name of the index on which to perform the operation.
|
|
3019
|
+
* @param partialUpdateObject.objectID - Unique record identifier.
|
|
3020
|
+
* @param partialUpdateObject.attributesToUpdate - Attributes with their values.
|
|
3021
|
+
* @param partialUpdateObject.createIfNotExists - Whether to create a new record if it doesn\'t exist.
|
|
3022
3022
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3023
3023
|
*/
|
|
3024
3024
|
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }, requestOptions) {
|
|
@@ -3049,13 +3049,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3049
3049
|
return transporter.request(request, requestOptions);
|
|
3050
3050
|
},
|
|
3051
3051
|
/**
|
|
3052
|
-
*
|
|
3052
|
+
* Deletes a user ID and its associated data from the clusters.
|
|
3053
3053
|
*
|
|
3054
3054
|
* Required API Key ACLs:
|
|
3055
3055
|
* - admin.
|
|
3056
3056
|
*
|
|
3057
3057
|
* @param removeUserId - The removeUserId object.
|
|
3058
|
-
* @param removeUserId.userID -
|
|
3058
|
+
* @param removeUserId.userID - User ID to assign.
|
|
3059
3059
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3060
3060
|
*/
|
|
3061
3061
|
removeUserId({ userID }, requestOptions) {
|
|
@@ -3074,7 +3074,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3074
3074
|
return transporter.request(request, requestOptions);
|
|
3075
3075
|
},
|
|
3076
3076
|
/**
|
|
3077
|
-
*
|
|
3077
|
+
* Replaces the list of allowed sources.
|
|
3078
3078
|
*
|
|
3079
3079
|
* Required API Key ACLs:
|
|
3080
3080
|
* - admin.
|
|
@@ -3100,7 +3100,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3100
3100
|
return transporter.request(request, requestOptions);
|
|
3101
3101
|
},
|
|
3102
3102
|
/**
|
|
3103
|
-
*
|
|
3103
|
+
* Restores a deleted API key. Restoring resets the `validity` attribute to `0`. Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can\'t be restored.
|
|
3104
3104
|
*
|
|
3105
3105
|
* Required API Key ACLs:
|
|
3106
3106
|
* - admin.
|
|
@@ -3125,14 +3125,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3125
3125
|
return transporter.request(request, requestOptions);
|
|
3126
3126
|
},
|
|
3127
3127
|
/**
|
|
3128
|
-
*
|
|
3128
|
+
* Adds a record to an index or replace it. - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
|
|
3129
3129
|
*
|
|
3130
3130
|
* Required API Key ACLs:
|
|
3131
3131
|
* - addObject.
|
|
3132
3132
|
*
|
|
3133
3133
|
* @param saveObject - The saveObject object.
|
|
3134
|
-
* @param saveObject.indexName -
|
|
3135
|
-
* @param saveObject.body - The
|
|
3134
|
+
* @param saveObject.indexName - Name of the index on which to perform the operation.
|
|
3135
|
+
* @param saveObject.body - The record, a schemaless object with attributes that are useful in the context of search and discovery.
|
|
3136
3136
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3137
3137
|
*/
|
|
3138
3138
|
saveObject({ indexName, body }, requestOptions) {
|
|
@@ -3155,16 +3155,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3155
3155
|
return transporter.request(request, requestOptions);
|
|
3156
3156
|
},
|
|
3157
3157
|
/**
|
|
3158
|
-
* To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
|
|
3158
|
+
* If a rule with the specified object ID doesn\'t exist, it\'s created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
|
|
3159
3159
|
*
|
|
3160
3160
|
* Required API Key ACLs:
|
|
3161
3161
|
* - editSettings.
|
|
3162
3162
|
*
|
|
3163
3163
|
* @param saveRule - The saveRule object.
|
|
3164
|
-
* @param saveRule.indexName -
|
|
3164
|
+
* @param saveRule.indexName - Name of the index on which to perform the operation.
|
|
3165
3165
|
* @param saveRule.objectID - Unique identifier of a rule object.
|
|
3166
3166
|
* @param saveRule.rule - The rule object.
|
|
3167
|
-
* @param saveRule.forwardToReplicas -
|
|
3167
|
+
* @param saveRule.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3168
3168
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3169
3169
|
*/
|
|
3170
3170
|
saveRule({ indexName, objectID, rule, forwardToReplicas }, requestOptions) {
|
|
@@ -3198,16 +3198,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3198
3198
|
return transporter.request(request, requestOptions);
|
|
3199
3199
|
},
|
|
3200
3200
|
/**
|
|
3201
|
-
* Create or update multiple rules.
|
|
3201
|
+
* Create or update multiple rules. If a rule with the specified object ID doesn\'t exist, Algolia creates a new one. Otherwise, existing rules are replaced.
|
|
3202
3202
|
*
|
|
3203
3203
|
* Required API Key ACLs:
|
|
3204
3204
|
* - editSettings.
|
|
3205
3205
|
*
|
|
3206
3206
|
* @param saveRules - The saveRules object.
|
|
3207
|
-
* @param saveRules.indexName -
|
|
3207
|
+
* @param saveRules.indexName - Name of the index on which to perform the operation.
|
|
3208
3208
|
* @param saveRules.rules - The rules object.
|
|
3209
|
-
* @param saveRules.forwardToReplicas -
|
|
3210
|
-
* @param saveRules.clearExistingRules -
|
|
3209
|
+
* @param saveRules.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3210
|
+
* @param saveRules.clearExistingRules - Whether existing rules should be deleted before adding this batch.
|
|
3211
3211
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3212
3212
|
*/
|
|
3213
3213
|
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }, requestOptions) {
|
|
@@ -3236,16 +3236,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3236
3236
|
return transporter.request(request, requestOptions);
|
|
3237
3237
|
},
|
|
3238
3238
|
/**
|
|
3239
|
-
*
|
|
3239
|
+
* If a synonym with the specified object ID doesn\'t exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).
|
|
3240
3240
|
*
|
|
3241
3241
|
* Required API Key ACLs:
|
|
3242
3242
|
* - editSettings.
|
|
3243
3243
|
*
|
|
3244
3244
|
* @param saveSynonym - The saveSynonym object.
|
|
3245
|
-
* @param saveSynonym.indexName -
|
|
3245
|
+
* @param saveSynonym.indexName - Name of the index on which to perform the operation.
|
|
3246
3246
|
* @param saveSynonym.objectID - Unique identifier of a synonym object.
|
|
3247
3247
|
* @param saveSynonym.synonymHit - The synonymHit object.
|
|
3248
|
-
* @param saveSynonym.forwardToReplicas -
|
|
3248
|
+
* @param saveSynonym.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3249
3249
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3250
3250
|
*/
|
|
3251
3251
|
saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }, requestOptions) {
|
|
@@ -3282,16 +3282,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3282
3282
|
return transporter.request(request, requestOptions);
|
|
3283
3283
|
},
|
|
3284
3284
|
/**
|
|
3285
|
-
*
|
|
3285
|
+
* If a synonym with the `objectID` doesn\'t exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.
|
|
3286
3286
|
*
|
|
3287
3287
|
* Required API Key ACLs:
|
|
3288
3288
|
* - editSettings.
|
|
3289
3289
|
*
|
|
3290
3290
|
* @param saveSynonyms - The saveSynonyms object.
|
|
3291
|
-
* @param saveSynonyms.indexName -
|
|
3291
|
+
* @param saveSynonyms.indexName - Name of the index on which to perform the operation.
|
|
3292
3292
|
* @param saveSynonyms.synonymHit - The synonymHit object.
|
|
3293
|
-
* @param saveSynonyms.forwardToReplicas -
|
|
3294
|
-
* @param saveSynonyms.replaceExistingSynonyms -
|
|
3293
|
+
* @param saveSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3294
|
+
* @param saveSynonyms.replaceExistingSynonyms - Whether to replace all synonyms in the index with the ones sent with this request.
|
|
3295
3295
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3296
3296
|
*/
|
|
3297
3297
|
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }, requestOptions) {
|
|
@@ -3321,12 +3321,12 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3321
3321
|
return transporter.request(request, requestOptions);
|
|
3322
3322
|
},
|
|
3323
3323
|
/**
|
|
3324
|
-
*
|
|
3324
|
+
* Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same indexβfor example, with different filters.
|
|
3325
3325
|
*
|
|
3326
3326
|
* Required API Key ACLs:
|
|
3327
3327
|
* - search.
|
|
3328
3328
|
*
|
|
3329
|
-
* @param searchMethodParams -
|
|
3329
|
+
* @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
|
|
3330
3330
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3331
3331
|
*/
|
|
3332
3332
|
search(searchMethodParams, requestOptions) {
|
|
@@ -3373,13 +3373,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3373
3373
|
return transporter.request(request, requestOptions);
|
|
3374
3374
|
},
|
|
3375
3375
|
/**
|
|
3376
|
-
*
|
|
3376
|
+
* Searches for standard and custom dictionary entries.
|
|
3377
3377
|
*
|
|
3378
3378
|
* Required API Key ACLs:
|
|
3379
3379
|
* - settings.
|
|
3380
3380
|
*
|
|
3381
3381
|
* @param searchDictionaryEntries - The searchDictionaryEntries object.
|
|
3382
|
-
* @param searchDictionaryEntries.dictionaryName - Dictionary to search
|
|
3382
|
+
* @param searchDictionaryEntries.dictionaryName - Dictionary type in which to search.
|
|
3383
3383
|
* @param searchDictionaryEntries.searchDictionaryEntriesParams - The searchDictionaryEntriesParams object.
|
|
3384
3384
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3385
3385
|
*/
|
|
@@ -3408,14 +3408,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3408
3408
|
return transporter.request(request, requestOptions);
|
|
3409
3409
|
},
|
|
3410
3410
|
/**
|
|
3411
|
-
*
|
|
3411
|
+
* Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn\'t work if you have **more than 65 searchable facets and searchable attributes combined**.
|
|
3412
3412
|
*
|
|
3413
3413
|
* Required API Key ACLs:
|
|
3414
3414
|
* - search.
|
|
3415
3415
|
*
|
|
3416
3416
|
* @param searchForFacetValues - The searchForFacetValues object.
|
|
3417
|
-
* @param searchForFacetValues.indexName -
|
|
3418
|
-
* @param searchForFacetValues.facetName - Facet
|
|
3417
|
+
* @param searchForFacetValues.indexName - Name of the index on which to perform the operation.
|
|
3418
|
+
* @param searchForFacetValues.facetName - Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
|
|
3419
3419
|
* @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.
|
|
3420
3420
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3421
3421
|
*/
|
|
@@ -3443,13 +3443,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3443
3443
|
return transporter.request(request, requestOptions);
|
|
3444
3444
|
},
|
|
3445
3445
|
/**
|
|
3446
|
-
*
|
|
3446
|
+
* Searches for rules in your index.
|
|
3447
3447
|
*
|
|
3448
3448
|
* Required API Key ACLs:
|
|
3449
3449
|
* - settings.
|
|
3450
3450
|
*
|
|
3451
3451
|
* @param searchRules - The searchRules object.
|
|
3452
|
-
* @param searchRules.indexName -
|
|
3452
|
+
* @param searchRules.indexName - Name of the index on which to perform the operation.
|
|
3453
3453
|
* @param searchRules.searchRulesParams - The searchRulesParams object.
|
|
3454
3454
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3455
3455
|
*/
|
|
@@ -3472,13 +3472,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3472
3472
|
return transporter.request(request, requestOptions);
|
|
3473
3473
|
},
|
|
3474
3474
|
/**
|
|
3475
|
-
*
|
|
3475
|
+
* Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.
|
|
3476
3476
|
*
|
|
3477
3477
|
* Required API Key ACLs:
|
|
3478
3478
|
* - search.
|
|
3479
3479
|
*
|
|
3480
3480
|
* @param searchSingleIndex - The searchSingleIndex object.
|
|
3481
|
-
* @param searchSingleIndex.indexName -
|
|
3481
|
+
* @param searchSingleIndex.indexName - Name of the index on which to perform the operation.
|
|
3482
3482
|
* @param searchSingleIndex.searchParams - The searchParams object.
|
|
3483
3483
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3484
3484
|
*/
|
|
@@ -3501,13 +3501,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3501
3501
|
return transporter.request(request, requestOptions);
|
|
3502
3502
|
},
|
|
3503
3503
|
/**
|
|
3504
|
-
*
|
|
3504
|
+
* Searches for synonyms in your index.
|
|
3505
3505
|
*
|
|
3506
3506
|
* Required API Key ACLs:
|
|
3507
3507
|
* - settings.
|
|
3508
3508
|
*
|
|
3509
3509
|
* @param searchSynonyms - The searchSynonyms object.
|
|
3510
|
-
* @param searchSynonyms.indexName -
|
|
3510
|
+
* @param searchSynonyms.indexName - Name of the index on which to perform the operation.
|
|
3511
3511
|
* @param searchSynonyms.searchSynonymsParams - Body of the `searchSynonyms` operation.
|
|
3512
3512
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3513
3513
|
*/
|
|
@@ -3530,7 +3530,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3530
3530
|
return transporter.request(request, requestOptions);
|
|
3531
3531
|
},
|
|
3532
3532
|
/**
|
|
3533
|
-
* Since it can take
|
|
3533
|
+
* Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time. To ensure rapid updates, the user IDs index isn\'t built at the same time as the mapping. Instead, it\'s built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).
|
|
3534
3534
|
*
|
|
3535
3535
|
* Required API Key ACLs:
|
|
3536
3536
|
* - admin.
|
|
@@ -3560,7 +3560,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3560
3560
|
return transporter.request(request, requestOptions);
|
|
3561
3561
|
},
|
|
3562
3562
|
/**
|
|
3563
|
-
*
|
|
3563
|
+
* Turns standard stop word dictionary entries on or off for a given language.
|
|
3564
3564
|
*
|
|
3565
3565
|
* Required API Key ACLs:
|
|
3566
3566
|
* - editSettings.
|
|
@@ -3588,15 +3588,15 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3588
3588
|
return transporter.request(request, requestOptions);
|
|
3589
3589
|
},
|
|
3590
3590
|
/**
|
|
3591
|
-
* Update the specified
|
|
3591
|
+
* Update the specified index settings. Index settings that you don\'t specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.
|
|
3592
3592
|
*
|
|
3593
3593
|
* Required API Key ACLs:
|
|
3594
3594
|
* - editSettings.
|
|
3595
3595
|
*
|
|
3596
3596
|
* @param setSettings - The setSettings object.
|
|
3597
|
-
* @param setSettings.indexName -
|
|
3597
|
+
* @param setSettings.indexName - Name of the index on which to perform the operation.
|
|
3598
3598
|
* @param setSettings.indexSettings - The indexSettings object.
|
|
3599
|
-
* @param setSettings.forwardToReplicas -
|
|
3599
|
+
* @param setSettings.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3600
3600
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3601
3601
|
*/
|
|
3602
3602
|
setSettings({ indexName, indexSettings, forwardToReplicas }, requestOptions) {
|
|
@@ -3622,7 +3622,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3622
3622
|
return transporter.request(request, requestOptions);
|
|
3623
3623
|
},
|
|
3624
3624
|
/**
|
|
3625
|
-
*
|
|
3625
|
+
* Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.
|
|
3626
3626
|
*
|
|
3627
3627
|
* Required API Key ACLs:
|
|
3628
3628
|
* - admin.
|