algoliasearch 5.0.0-alpha.105 → 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 +6 -3
- 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 +6 -3
- 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 +6 -3
- 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
|
@@ -685,7 +685,7 @@ const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
|
|
|
685
685
|
const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
|
|
686
686
|
|
|
687
687
|
// 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.
|
|
688
|
-
const apiClientVersion$4 = '5.0.0-alpha.
|
|
688
|
+
const apiClientVersion$4 = '5.0.0-alpha.107';
|
|
689
689
|
const REGIONS$2 = ['de', 'us'];
|
|
690
690
|
function getDefaultHosts$3(region) {
|
|
691
691
|
const url = !region
|
|
@@ -931,8 +931,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
931
931
|
* - analytics.
|
|
932
932
|
*
|
|
933
933
|
* @param listABTests - The listABTests object.
|
|
934
|
-
* @param listABTests.offset - Position of the
|
|
935
|
-
* @param listABTests.limit - Number of
|
|
934
|
+
* @param listABTests.offset - Position of the first item to return.
|
|
935
|
+
* @param listABTests.limit - Number of items to return.
|
|
936
936
|
* @param listABTests.indexPrefix - Only return A/B tests for indices starting with this prefix.
|
|
937
937
|
* @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
|
|
938
938
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -990,7 +990,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
990
990
|
}
|
|
991
991
|
|
|
992
992
|
// 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.
|
|
993
|
-
const apiClientVersion$3 = '5.0.0-alpha.
|
|
993
|
+
const apiClientVersion$3 = '5.0.0-alpha.107';
|
|
994
994
|
const REGIONS$1 = ['de', 'us'];
|
|
995
995
|
function getDefaultHosts$2(region) {
|
|
996
996
|
const url = !region
|
|
@@ -1152,9 +1152,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1152
1152
|
* - analytics.
|
|
1153
1153
|
*
|
|
1154
1154
|
* @param getAverageClickPosition - The getAverageClickPosition object.
|
|
1155
|
-
* @param getAverageClickPosition.index - Index name
|
|
1156
|
-
* @param getAverageClickPosition.startDate - Start date (
|
|
1157
|
-
* @param getAverageClickPosition.endDate - End date (
|
|
1155
|
+
* @param getAverageClickPosition.index - Index name.
|
|
1156
|
+
* @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1157
|
+
* @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1158
1158
|
* @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.
|
|
1159
1159
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1160
1160
|
*/
|
|
@@ -1192,9 +1192,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1192
1192
|
* - analytics.
|
|
1193
1193
|
*
|
|
1194
1194
|
* @param getClickPositions - The getClickPositions object.
|
|
1195
|
-
* @param getClickPositions.index - Index name
|
|
1196
|
-
* @param getClickPositions.startDate - Start date (
|
|
1197
|
-
* @param getClickPositions.endDate - End date (
|
|
1195
|
+
* @param getClickPositions.index - Index name.
|
|
1196
|
+
* @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1197
|
+
* @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1198
1198
|
* @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.
|
|
1199
1199
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1200
1200
|
*/
|
|
@@ -1232,9 +1232,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1232
1232
|
* - analytics.
|
|
1233
1233
|
*
|
|
1234
1234
|
* @param getClickThroughRate - The getClickThroughRate object.
|
|
1235
|
-
* @param getClickThroughRate.index - Index name
|
|
1236
|
-
* @param getClickThroughRate.startDate - Start date (
|
|
1237
|
-
* @param getClickThroughRate.endDate - End date (
|
|
1235
|
+
* @param getClickThroughRate.index - Index name.
|
|
1236
|
+
* @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1237
|
+
* @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1238
1238
|
* @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.
|
|
1239
1239
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1240
1240
|
*/
|
|
@@ -1272,9 +1272,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1272
1272
|
* - analytics.
|
|
1273
1273
|
*
|
|
1274
1274
|
* @param getConversationRate - The getConversationRate object.
|
|
1275
|
-
* @param getConversationRate.index - Index name
|
|
1276
|
-
* @param getConversationRate.startDate - Start date (
|
|
1277
|
-
* @param getConversationRate.endDate - End date (
|
|
1275
|
+
* @param getConversationRate.index - Index name.
|
|
1276
|
+
* @param getConversationRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1277
|
+
* @param getConversationRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1278
1278
|
* @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.
|
|
1279
1279
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1280
1280
|
*/
|
|
@@ -1312,9 +1312,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1312
1312
|
* - analytics.
|
|
1313
1313
|
*
|
|
1314
1314
|
* @param getNoClickRate - The getNoClickRate object.
|
|
1315
|
-
* @param getNoClickRate.index - Index name
|
|
1316
|
-
* @param getNoClickRate.startDate - Start date (
|
|
1317
|
-
* @param getNoClickRate.endDate - End date (
|
|
1315
|
+
* @param getNoClickRate.index - Index name.
|
|
1316
|
+
* @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1317
|
+
* @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1318
1318
|
* @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.
|
|
1319
1319
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1320
1320
|
*/
|
|
@@ -1352,9 +1352,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1352
1352
|
* - analytics.
|
|
1353
1353
|
*
|
|
1354
1354
|
* @param getNoResultsRate - The getNoResultsRate object.
|
|
1355
|
-
* @param getNoResultsRate.index - Index name
|
|
1356
|
-
* @param getNoResultsRate.startDate - Start date (
|
|
1357
|
-
* @param getNoResultsRate.endDate - End date (
|
|
1355
|
+
* @param getNoResultsRate.index - Index name.
|
|
1356
|
+
* @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1357
|
+
* @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1358
1358
|
* @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.
|
|
1359
1359
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1360
1360
|
*/
|
|
@@ -1392,9 +1392,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1392
1392
|
* - analytics.
|
|
1393
1393
|
*
|
|
1394
1394
|
* @param getSearchesCount - The getSearchesCount object.
|
|
1395
|
-
* @param getSearchesCount.index - Index name
|
|
1396
|
-
* @param getSearchesCount.startDate - Start date (
|
|
1397
|
-
* @param getSearchesCount.endDate - End date (
|
|
1395
|
+
* @param getSearchesCount.index - Index name.
|
|
1396
|
+
* @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1397
|
+
* @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1398
1398
|
* @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.
|
|
1399
1399
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1400
1400
|
*/
|
|
@@ -1432,11 +1432,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1432
1432
|
* - analytics.
|
|
1433
1433
|
*
|
|
1434
1434
|
* @param getSearchesNoClicks - The getSearchesNoClicks object.
|
|
1435
|
-
* @param getSearchesNoClicks.index - Index name
|
|
1436
|
-
* @param getSearchesNoClicks.startDate - Start date (
|
|
1437
|
-
* @param getSearchesNoClicks.endDate - End date (
|
|
1438
|
-
* @param getSearchesNoClicks.limit - Number of
|
|
1439
|
-
* @param getSearchesNoClicks.offset - Position of the
|
|
1435
|
+
* @param getSearchesNoClicks.index - Index name.
|
|
1436
|
+
* @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1437
|
+
* @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1438
|
+
* @param getSearchesNoClicks.limit - Number of items to return.
|
|
1439
|
+
* @param getSearchesNoClicks.offset - Position of the first item to return.
|
|
1440
1440
|
* @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.
|
|
1441
1441
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1442
1442
|
*/
|
|
@@ -1480,11 +1480,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1480
1480
|
* - analytics.
|
|
1481
1481
|
*
|
|
1482
1482
|
* @param getSearchesNoResults - The getSearchesNoResults object.
|
|
1483
|
-
* @param getSearchesNoResults.index - Index name
|
|
1484
|
-
* @param getSearchesNoResults.startDate - Start date (
|
|
1485
|
-
* @param getSearchesNoResults.endDate - End date (
|
|
1486
|
-
* @param getSearchesNoResults.limit - Number of
|
|
1487
|
-
* @param getSearchesNoResults.offset - Position of the
|
|
1483
|
+
* @param getSearchesNoResults.index - Index name.
|
|
1484
|
+
* @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1485
|
+
* @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1486
|
+
* @param getSearchesNoResults.limit - Number of items to return.
|
|
1487
|
+
* @param getSearchesNoResults.offset - Position of the first item to return.
|
|
1488
1488
|
* @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.
|
|
1489
1489
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1490
1490
|
*/
|
|
@@ -1528,7 +1528,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1528
1528
|
* - analytics.
|
|
1529
1529
|
*
|
|
1530
1530
|
* @param getStatus - The getStatus object.
|
|
1531
|
-
* @param getStatus.index - Index name
|
|
1531
|
+
* @param getStatus.index - Index name.
|
|
1532
1532
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1533
1533
|
*/
|
|
1534
1534
|
getStatus({ index }, requestOptions) {
|
|
@@ -1556,11 +1556,11 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1556
1556
|
* - analytics.
|
|
1557
1557
|
*
|
|
1558
1558
|
* @param getTopCountries - The getTopCountries object.
|
|
1559
|
-
* @param getTopCountries.index - Index name
|
|
1560
|
-
* @param getTopCountries.startDate - Start date (
|
|
1561
|
-
* @param getTopCountries.endDate - End date (
|
|
1562
|
-
* @param getTopCountries.limit - Number of
|
|
1563
|
-
* @param getTopCountries.offset - Position of the
|
|
1559
|
+
* @param getTopCountries.index - Index name.
|
|
1560
|
+
* @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1561
|
+
* @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1562
|
+
* @param getTopCountries.limit - Number of items to return.
|
|
1563
|
+
* @param getTopCountries.offset - Position of the first item to return.
|
|
1564
1564
|
* @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.
|
|
1565
1565
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1566
1566
|
*/
|
|
@@ -1604,12 +1604,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1604
1604
|
* - analytics.
|
|
1605
1605
|
*
|
|
1606
1606
|
* @param getTopFilterAttributes - The getTopFilterAttributes object.
|
|
1607
|
-
* @param getTopFilterAttributes.index - Index name
|
|
1607
|
+
* @param getTopFilterAttributes.index - Index name.
|
|
1608
1608
|
* @param getTopFilterAttributes.search - User query.
|
|
1609
|
-
* @param getTopFilterAttributes.startDate - Start date (
|
|
1610
|
-
* @param getTopFilterAttributes.endDate - End date (
|
|
1611
|
-
* @param getTopFilterAttributes.limit - Number of
|
|
1612
|
-
* @param getTopFilterAttributes.offset - Position of the
|
|
1609
|
+
* @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1610
|
+
* @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1611
|
+
* @param getTopFilterAttributes.limit - Number of items to return.
|
|
1612
|
+
* @param getTopFilterAttributes.offset - Position of the first item to return.
|
|
1613
1613
|
* @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.
|
|
1614
1614
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1615
1615
|
*/
|
|
@@ -1657,12 +1657,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1657
1657
|
*
|
|
1658
1658
|
* @param getTopFilterForAttribute - The getTopFilterForAttribute object.
|
|
1659
1659
|
* @param getTopFilterForAttribute.attribute - Attribute name.
|
|
1660
|
-
* @param getTopFilterForAttribute.index - Index name
|
|
1660
|
+
* @param getTopFilterForAttribute.index - Index name.
|
|
1661
1661
|
* @param getTopFilterForAttribute.search - User query.
|
|
1662
|
-
* @param getTopFilterForAttribute.startDate - Start date (
|
|
1663
|
-
* @param getTopFilterForAttribute.endDate - End date (
|
|
1664
|
-
* @param getTopFilterForAttribute.limit - Number of
|
|
1665
|
-
* @param getTopFilterForAttribute.offset - Position of the
|
|
1662
|
+
* @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1663
|
+
* @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1664
|
+
* @param getTopFilterForAttribute.limit - Number of items to return.
|
|
1665
|
+
* @param getTopFilterForAttribute.offset - Position of the first item to return.
|
|
1666
1666
|
* @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.
|
|
1667
1667
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1668
1668
|
*/
|
|
@@ -1712,12 +1712,12 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1712
1712
|
* - analytics.
|
|
1713
1713
|
*
|
|
1714
1714
|
* @param getTopFiltersNoResults - The getTopFiltersNoResults object.
|
|
1715
|
-
* @param getTopFiltersNoResults.index - Index name
|
|
1715
|
+
* @param getTopFiltersNoResults.index - Index name.
|
|
1716
1716
|
* @param getTopFiltersNoResults.search - User query.
|
|
1717
|
-
* @param getTopFiltersNoResults.startDate - Start date (
|
|
1718
|
-
* @param getTopFiltersNoResults.endDate - End date (
|
|
1719
|
-
* @param getTopFiltersNoResults.limit - Number of
|
|
1720
|
-
* @param getTopFiltersNoResults.offset - Position of the
|
|
1717
|
+
* @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1718
|
+
* @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1719
|
+
* @param getTopFiltersNoResults.limit - Number of items to return.
|
|
1720
|
+
* @param getTopFiltersNoResults.offset - Position of the first item to return.
|
|
1721
1721
|
* @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.
|
|
1722
1722
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1723
1723
|
*/
|
|
@@ -1764,13 +1764,13 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1764
1764
|
* - analytics.
|
|
1765
1765
|
*
|
|
1766
1766
|
* @param getTopHits - The getTopHits object.
|
|
1767
|
-
* @param getTopHits.index - Index name
|
|
1767
|
+
* @param getTopHits.index - Index name.
|
|
1768
1768
|
* @param getTopHits.search - User query.
|
|
1769
1769
|
* @param getTopHits.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
|
|
1770
|
-
* @param getTopHits.startDate - Start date (
|
|
1771
|
-
* @param getTopHits.endDate - End date (
|
|
1772
|
-
* @param getTopHits.limit - Number of
|
|
1773
|
-
* @param getTopHits.offset - Position of the
|
|
1770
|
+
* @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1771
|
+
* @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1772
|
+
* @param getTopHits.limit - Number of items to return.
|
|
1773
|
+
* @param getTopHits.offset - Position of the first item to return.
|
|
1774
1774
|
* @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.
|
|
1775
1775
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1776
1776
|
*/
|
|
@@ -1820,14 +1820,14 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1820
1820
|
* - analytics.
|
|
1821
1821
|
*
|
|
1822
1822
|
* @param getTopSearches - The getTopSearches object.
|
|
1823
|
-
* @param getTopSearches.index - Index name
|
|
1823
|
+
* @param getTopSearches.index - Index name.
|
|
1824
1824
|
* @param getTopSearches.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
|
|
1825
|
-
* @param getTopSearches.startDate - Start date (
|
|
1826
|
-
* @param getTopSearches.endDate - End date (
|
|
1825
|
+
* @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1826
|
+
* @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1827
1827
|
* @param getTopSearches.orderBy - Reorder the results.
|
|
1828
1828
|
* @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
|
|
1829
|
-
* @param getTopSearches.limit - Number of
|
|
1830
|
-
* @param getTopSearches.offset - Position of the
|
|
1829
|
+
* @param getTopSearches.limit - Number of items to return.
|
|
1830
|
+
* @param getTopSearches.offset - Position of the first item to return.
|
|
1831
1831
|
* @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.
|
|
1832
1832
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1833
1833
|
*/
|
|
@@ -1880,9 +1880,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1880
1880
|
* - analytics.
|
|
1881
1881
|
*
|
|
1882
1882
|
* @param getUsersCount - The getUsersCount object.
|
|
1883
|
-
* @param getUsersCount.index - Index name
|
|
1884
|
-
* @param getUsersCount.startDate - Start date (
|
|
1885
|
-
* @param getUsersCount.endDate - End date (
|
|
1883
|
+
* @param getUsersCount.index - Index name.
|
|
1884
|
+
* @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
|
|
1885
|
+
* @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
|
|
1886
1886
|
* @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.
|
|
1887
1887
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1888
1888
|
*/
|
|
@@ -1917,7 +1917,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1917
1917
|
}
|
|
1918
1918
|
|
|
1919
1919
|
// 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.
|
|
1920
|
-
const apiClientVersion$2 = '5.0.0-alpha.
|
|
1920
|
+
const apiClientVersion$2 = '5.0.0-alpha.107';
|
|
1921
1921
|
const REGIONS = ['eu', 'us'];
|
|
1922
1922
|
function getDefaultHosts$1(region) {
|
|
1923
1923
|
const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
|
|
@@ -2178,7 +2178,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
2178
2178
|
}
|
|
2179
2179
|
|
|
2180
2180
|
// 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.
|
|
2181
|
-
const apiClientVersion$1 = '5.0.0-alpha.
|
|
2181
|
+
const apiClientVersion$1 = '5.0.0-alpha.107';
|
|
2182
2182
|
function getDefaultHosts(appId) {
|
|
2183
2183
|
return [
|
|
2184
2184
|
{
|
|
@@ -2516,7 +2516,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2516
2516
|
return { copyOperationResponse, batchResponses, moveOperationResponse };
|
|
2517
2517
|
},
|
|
2518
2518
|
/**
|
|
2519
|
-
*
|
|
2519
|
+
* Creates a new API key with specific permissions and restrictions.
|
|
2520
2520
|
*
|
|
2521
2521
|
* Required API Key ACLs:
|
|
2522
2522
|
* - admin.
|
|
@@ -2544,15 +2544,15 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2544
2544
|
return transporter.request(request, requestOptions);
|
|
2545
2545
|
},
|
|
2546
2546
|
/**
|
|
2547
|
-
* If
|
|
2547
|
+
* 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).
|
|
2548
2548
|
*
|
|
2549
2549
|
* Required API Key ACLs:
|
|
2550
2550
|
* - addObject.
|
|
2551
2551
|
*
|
|
2552
2552
|
* @param addOrUpdateObject - The addOrUpdateObject object.
|
|
2553
|
-
* @param addOrUpdateObject.indexName -
|
|
2554
|
-
* @param addOrUpdateObject.objectID - Unique record
|
|
2555
|
-
* @param addOrUpdateObject.body -
|
|
2553
|
+
* @param addOrUpdateObject.indexName - Name of the index on which to perform the operation.
|
|
2554
|
+
* @param addOrUpdateObject.objectID - Unique record identifier.
|
|
2555
|
+
* @param addOrUpdateObject.body - The record, a schemaless object with attributes that are useful in the context of search and discovery.
|
|
2556
2556
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2557
2557
|
*/
|
|
2558
2558
|
addOrUpdateObject({ indexName, objectID, body }, requestOptions) {
|
|
@@ -2580,7 +2580,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2580
2580
|
return transporter.request(request, requestOptions);
|
|
2581
2581
|
},
|
|
2582
2582
|
/**
|
|
2583
|
-
*
|
|
2583
|
+
* Adds a source to the list of allowed sources.
|
|
2584
2584
|
*
|
|
2585
2585
|
* Required API Key ACLs:
|
|
2586
2586
|
* - admin.
|
|
@@ -2608,13 +2608,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2608
2608
|
return transporter.request(request, requestOptions);
|
|
2609
2609
|
},
|
|
2610
2610
|
/**
|
|
2611
|
-
*
|
|
2611
|
+
* 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.
|
|
2612
2612
|
*
|
|
2613
2613
|
* Required API Key ACLs:
|
|
2614
2614
|
* - admin.
|
|
2615
2615
|
*
|
|
2616
2616
|
* @param assignUserId - The assignUserId object.
|
|
2617
|
-
* @param assignUserId.xAlgoliaUserID -
|
|
2617
|
+
* @param assignUserId.xAlgoliaUserID - User ID to assign.
|
|
2618
2618
|
* @param assignUserId.assignUserIdParams - The assignUserIdParams object.
|
|
2619
2619
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2620
2620
|
*/
|
|
@@ -2644,10 +2644,10 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2644
2644
|
return transporter.request(request, requestOptions);
|
|
2645
2645
|
},
|
|
2646
2646
|
/**
|
|
2647
|
-
*
|
|
2647
|
+
* 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.
|
|
2648
2648
|
*
|
|
2649
2649
|
* @param batch - The batch object.
|
|
2650
|
-
* @param batch.indexName -
|
|
2650
|
+
* @param batch.indexName - Name of the index on which to perform the operation.
|
|
2651
2651
|
* @param batch.batchWriteParams - The batchWriteParams object.
|
|
2652
2652
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2653
2653
|
*/
|
|
@@ -2674,13 +2674,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2674
2674
|
return transporter.request(request, requestOptions);
|
|
2675
2675
|
},
|
|
2676
2676
|
/**
|
|
2677
|
-
*
|
|
2677
|
+
* Assigns multiple user IDs to a cluster. **You can\'t move users with this operation**.
|
|
2678
2678
|
*
|
|
2679
2679
|
* Required API Key ACLs:
|
|
2680
2680
|
* - admin.
|
|
2681
2681
|
*
|
|
2682
2682
|
* @param batchAssignUserIds - The batchAssignUserIds object.
|
|
2683
|
-
* @param batchAssignUserIds.xAlgoliaUserID -
|
|
2683
|
+
* @param batchAssignUserIds.xAlgoliaUserID - User ID to assign.
|
|
2684
2684
|
* @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
|
|
2685
2685
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2686
2686
|
*/
|
|
@@ -2713,13 +2713,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2713
2713
|
return transporter.request(request, requestOptions);
|
|
2714
2714
|
},
|
|
2715
2715
|
/**
|
|
2716
|
-
*
|
|
2716
|
+
* Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
|
|
2717
2717
|
*
|
|
2718
2718
|
* Required API Key ACLs:
|
|
2719
2719
|
* - editSettings.
|
|
2720
2720
|
*
|
|
2721
2721
|
* @param batchDictionaryEntries - The batchDictionaryEntries object.
|
|
2722
|
-
* @param batchDictionaryEntries.dictionaryName - Dictionary to search
|
|
2722
|
+
* @param batchDictionaryEntries.dictionaryName - Dictionary type in which to search.
|
|
2723
2723
|
* @param batchDictionaryEntries.batchDictionaryEntriesParams - The batchDictionaryEntriesParams object.
|
|
2724
2724
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2725
2725
|
*/
|
|
@@ -2746,13 +2746,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2746
2746
|
return transporter.request(request, requestOptions);
|
|
2747
2747
|
},
|
|
2748
2748
|
/**
|
|
2749
|
-
*
|
|
2749
|
+
* 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.
|
|
2750
2750
|
*
|
|
2751
2751
|
* Required API Key ACLs:
|
|
2752
2752
|
* - browse.
|
|
2753
2753
|
*
|
|
2754
2754
|
* @param browse - The browse object.
|
|
2755
|
-
* @param browse.indexName -
|
|
2755
|
+
* @param browse.indexName - Name of the index on which to perform the operation.
|
|
2756
2756
|
* @param browse.browseParams - The browseParams object.
|
|
2757
2757
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2758
2758
|
*/
|
|
@@ -2773,13 +2773,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2773
2773
|
return transporter.request(request, requestOptions);
|
|
2774
2774
|
},
|
|
2775
2775
|
/**
|
|
2776
|
-
*
|
|
2776
|
+
* Deletes only the records from an index while keeping settings, synonyms, and rules.
|
|
2777
2777
|
*
|
|
2778
2778
|
* Required API Key ACLs:
|
|
2779
2779
|
* - deleteIndex.
|
|
2780
2780
|
*
|
|
2781
2781
|
* @param clearObjects - The clearObjects object.
|
|
2782
|
-
* @param clearObjects.indexName -
|
|
2782
|
+
* @param clearObjects.indexName - Name of the index on which to perform the operation.
|
|
2783
2783
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2784
2784
|
*/
|
|
2785
2785
|
clearObjects({ indexName }, requestOptions) {
|
|
@@ -2798,14 +2798,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2798
2798
|
return transporter.request(request, requestOptions);
|
|
2799
2799
|
},
|
|
2800
2800
|
/**
|
|
2801
|
-
*
|
|
2801
|
+
* Deletes all rules from the index.
|
|
2802
2802
|
*
|
|
2803
2803
|
* Required API Key ACLs:
|
|
2804
2804
|
* - editSettings.
|
|
2805
2805
|
*
|
|
2806
2806
|
* @param clearRules - The clearRules object.
|
|
2807
|
-
* @param clearRules.indexName -
|
|
2808
|
-
* @param clearRules.forwardToReplicas -
|
|
2807
|
+
* @param clearRules.indexName - Name of the index on which to perform the operation.
|
|
2808
|
+
* @param clearRules.forwardToReplicas - Whether changes are applied to replica indices.
|
|
2809
2809
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2810
2810
|
*/
|
|
2811
2811
|
clearRules({ indexName, forwardToReplicas }, requestOptions) {
|
|
@@ -2827,14 +2827,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2827
2827
|
return transporter.request(request, requestOptions);
|
|
2828
2828
|
},
|
|
2829
2829
|
/**
|
|
2830
|
-
*
|
|
2830
|
+
* Deletes all synonyms from the index.
|
|
2831
2831
|
*
|
|
2832
2832
|
* Required API Key ACLs:
|
|
2833
2833
|
* - editSettings.
|
|
2834
2834
|
*
|
|
2835
2835
|
* @param clearSynonyms - The clearSynonyms object.
|
|
2836
|
-
* @param clearSynonyms.indexName -
|
|
2837
|
-
* @param clearSynonyms.forwardToReplicas -
|
|
2836
|
+
* @param clearSynonyms.indexName - Name of the index on which to perform the operation.
|
|
2837
|
+
* @param clearSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
|
|
2838
2838
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2839
2839
|
*/
|
|
2840
2840
|
clearSynonyms({ indexName, forwardToReplicas }, requestOptions) {
|
|
@@ -2952,7 +2952,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2952
2952
|
return transporter.request(request, requestOptions);
|
|
2953
2953
|
},
|
|
2954
2954
|
/**
|
|
2955
|
-
*
|
|
2955
|
+
* Deletes the API key.
|
|
2956
2956
|
*
|
|
2957
2957
|
* Required API Key ACLs:
|
|
2958
2958
|
* - admin.
|
|
@@ -2977,13 +2977,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2977
2977
|
return transporter.request(request, requestOptions);
|
|
2978
2978
|
},
|
|
2979
2979
|
/**
|
|
2980
|
-
* This operation doesn\'t
|
|
2980
|
+
* 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).
|
|
2981
2981
|
*
|
|
2982
2982
|
* Required API Key ACLs:
|
|
2983
2983
|
* - deleteIndex.
|
|
2984
2984
|
*
|
|
2985
2985
|
* @param deleteBy - The deleteBy object.
|
|
2986
|
-
* @param deleteBy.indexName -
|
|
2986
|
+
* @param deleteBy.indexName - Name of the index on which to perform the operation.
|
|
2987
2987
|
* @param deleteBy.deleteByParams - The deleteByParams object.
|
|
2988
2988
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2989
2989
|
*/
|
|
@@ -3007,13 +3007,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3007
3007
|
return transporter.request(request, requestOptions);
|
|
3008
3008
|
},
|
|
3009
3009
|
/**
|
|
3010
|
-
*
|
|
3010
|
+
* 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/).
|
|
3011
3011
|
*
|
|
3012
3012
|
* Required API Key ACLs:
|
|
3013
3013
|
* - deleteIndex.
|
|
3014
3014
|
*
|
|
3015
3015
|
* @param deleteIndex - The deleteIndex object.
|
|
3016
|
-
* @param deleteIndex.indexName -
|
|
3016
|
+
* @param deleteIndex.indexName - Name of the index on which to perform the operation.
|
|
3017
3017
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3018
3018
|
*/
|
|
3019
3019
|
deleteIndex({ indexName }, requestOptions) {
|
|
@@ -3032,14 +3032,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3032
3032
|
return transporter.request(request, requestOptions);
|
|
3033
3033
|
},
|
|
3034
3034
|
/**
|
|
3035
|
-
* To delete
|
|
3035
|
+
* 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).
|
|
3036
3036
|
*
|
|
3037
3037
|
* Required API Key ACLs:
|
|
3038
3038
|
* - deleteObject.
|
|
3039
3039
|
*
|
|
3040
3040
|
* @param deleteObject - The deleteObject object.
|
|
3041
|
-
* @param deleteObject.indexName -
|
|
3042
|
-
* @param deleteObject.objectID - Unique record
|
|
3041
|
+
* @param deleteObject.indexName - Name of the index on which to perform the operation.
|
|
3042
|
+
* @param deleteObject.objectID - Unique record identifier.
|
|
3043
3043
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3044
3044
|
*/
|
|
3045
3045
|
deleteObject({ indexName, objectID }, requestOptions) {
|
|
@@ -3063,15 +3063,15 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3063
3063
|
return transporter.request(request, requestOptions);
|
|
3064
3064
|
},
|
|
3065
3065
|
/**
|
|
3066
|
-
*
|
|
3066
|
+
* Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](#tag/Rules/operation/searchRules).
|
|
3067
3067
|
*
|
|
3068
3068
|
* Required API Key ACLs:
|
|
3069
3069
|
* - editSettings.
|
|
3070
3070
|
*
|
|
3071
3071
|
* @param deleteRule - The deleteRule object.
|
|
3072
|
-
* @param deleteRule.indexName -
|
|
3072
|
+
* @param deleteRule.indexName - Name of the index on which to perform the operation.
|
|
3073
3073
|
* @param deleteRule.objectID - Unique identifier of a rule object.
|
|
3074
|
-
* @param deleteRule.forwardToReplicas -
|
|
3074
|
+
* @param deleteRule.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3075
3075
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3076
3076
|
*/
|
|
3077
3077
|
deleteRule({ indexName, objectID, forwardToReplicas }, requestOptions) {
|
|
@@ -3098,7 +3098,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3098
3098
|
return transporter.request(request, requestOptions);
|
|
3099
3099
|
},
|
|
3100
3100
|
/**
|
|
3101
|
-
*
|
|
3101
|
+
* Deletes a source from the list of allowed sources.
|
|
3102
3102
|
*
|
|
3103
3103
|
* Required API Key ACLs:
|
|
3104
3104
|
* - admin.
|
|
@@ -3123,15 +3123,15 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3123
3123
|
return transporter.request(request, requestOptions);
|
|
3124
3124
|
},
|
|
3125
3125
|
/**
|
|
3126
|
-
*
|
|
3126
|
+
* Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
|
|
3127
3127
|
*
|
|
3128
3128
|
* Required API Key ACLs:
|
|
3129
3129
|
* - editSettings.
|
|
3130
3130
|
*
|
|
3131
3131
|
* @param deleteSynonym - The deleteSynonym object.
|
|
3132
|
-
* @param deleteSynonym.indexName -
|
|
3132
|
+
* @param deleteSynonym.indexName - Name of the index on which to perform the operation.
|
|
3133
3133
|
* @param deleteSynonym.objectID - Unique identifier of a synonym object.
|
|
3134
|
-
* @param deleteSynonym.forwardToReplicas -
|
|
3134
|
+
* @param deleteSynonym.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3135
3135
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3136
3136
|
*/
|
|
3137
3137
|
deleteSynonym({ indexName, objectID, forwardToReplicas }, requestOptions) {
|
|
@@ -3158,7 +3158,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3158
3158
|
return transporter.request(request, requestOptions);
|
|
3159
3159
|
},
|
|
3160
3160
|
/**
|
|
3161
|
-
*
|
|
3161
|
+
* 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.
|
|
3162
3162
|
*
|
|
3163
3163
|
* @param getApiKey - The getApiKey object.
|
|
3164
3164
|
* @param getApiKey.key - API key.
|
|
@@ -3180,7 +3180,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3180
3180
|
return transporter.request(request, requestOptions);
|
|
3181
3181
|
},
|
|
3182
3182
|
/**
|
|
3183
|
-
* Lists
|
|
3183
|
+
* Lists supported languages with their supported dictionary types and number of custom entries.
|
|
3184
3184
|
*
|
|
3185
3185
|
* Required API Key ACLs:
|
|
3186
3186
|
* - settings.
|
|
@@ -3200,7 +3200,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3200
3200
|
return transporter.request(request, requestOptions);
|
|
3201
3201
|
},
|
|
3202
3202
|
/**
|
|
3203
|
-
*
|
|
3203
|
+
* Retrieves the languages for which standard dictionary entries are turned off.
|
|
3204
3204
|
*
|
|
3205
3205
|
* Required API Key ACLs:
|
|
3206
3206
|
* - settings.
|
|
@@ -3220,16 +3220,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3220
3220
|
return transporter.request(request, requestOptions);
|
|
3221
3221
|
},
|
|
3222
3222
|
/**
|
|
3223
|
-
* 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.
|
|
3223
|
+
* 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.
|
|
3224
3224
|
*
|
|
3225
3225
|
* Required API Key ACLs:
|
|
3226
3226
|
* - logs.
|
|
3227
3227
|
*
|
|
3228
3228
|
* @param getLogs - The getLogs object.
|
|
3229
|
-
* @param getLogs.offset - First log entry to retrieve.
|
|
3229
|
+
* @param getLogs.offset - First log entry to retrieve. The most recent entries are listed first.
|
|
3230
3230
|
* @param getLogs.length - Maximum number of entries to retrieve.
|
|
3231
|
-
* @param getLogs.indexName - Index for which log entries
|
|
3232
|
-
* @param getLogs.type - Type of log entries to retrieve.
|
|
3231
|
+
* @param getLogs.indexName - Index for which to retrieve log entries. By default, log entries are retrieved for all indices.
|
|
3232
|
+
* @param getLogs.type - Type of log entries to retrieve. By default, all log entries are retrieved.
|
|
3233
3233
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3234
3234
|
*/
|
|
3235
3235
|
getLogs({ offset, length, indexName, type } = {}, requestOptions = undefined) {
|
|
@@ -3257,15 +3257,15 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3257
3257
|
return transporter.request(request, requestOptions);
|
|
3258
3258
|
},
|
|
3259
3259
|
/**
|
|
3260
|
-
* To
|
|
3260
|
+
* Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
|
|
3261
3261
|
*
|
|
3262
3262
|
* Required API Key ACLs:
|
|
3263
3263
|
* - search.
|
|
3264
3264
|
*
|
|
3265
3265
|
* @param getObject - The getObject object.
|
|
3266
|
-
* @param getObject.indexName -
|
|
3267
|
-
* @param getObject.objectID - Unique record
|
|
3268
|
-
* @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.
|
|
3266
|
+
* @param getObject.indexName - Name of the index on which to perform the operation.
|
|
3267
|
+
* @param getObject.objectID - Unique record identifier.
|
|
3268
|
+
* @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.
|
|
3269
3269
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3270
3270
|
*/
|
|
3271
3271
|
getObject({ indexName, objectID, attributesToRetrieve }, requestOptions) {
|
|
@@ -3292,7 +3292,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3292
3292
|
return transporter.request(request, requestOptions);
|
|
3293
3293
|
},
|
|
3294
3294
|
/**
|
|
3295
|
-
*
|
|
3295
|
+
* Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.
|
|
3296
3296
|
*
|
|
3297
3297
|
* Required API Key ACLs:
|
|
3298
3298
|
* - search.
|
|
@@ -3322,13 +3322,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3322
3322
|
return transporter.request(request, requestOptions);
|
|
3323
3323
|
},
|
|
3324
3324
|
/**
|
|
3325
|
-
*
|
|
3325
|
+
* Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
|
|
3326
3326
|
*
|
|
3327
3327
|
* Required API Key ACLs:
|
|
3328
3328
|
* - settings.
|
|
3329
3329
|
*
|
|
3330
3330
|
* @param getRule - The getRule object.
|
|
3331
|
-
* @param getRule.indexName -
|
|
3331
|
+
* @param getRule.indexName - Name of the index on which to perform the operation.
|
|
3332
3332
|
* @param getRule.objectID - Unique identifier of a rule object.
|
|
3333
3333
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3334
3334
|
*/
|
|
@@ -3353,13 +3353,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3353
3353
|
return transporter.request(request, requestOptions);
|
|
3354
3354
|
},
|
|
3355
3355
|
/**
|
|
3356
|
-
*
|
|
3356
|
+
* Retrieves an object with non-null index settings.
|
|
3357
3357
|
*
|
|
3358
3358
|
* Required API Key ACLs:
|
|
3359
3359
|
* - search.
|
|
3360
3360
|
*
|
|
3361
3361
|
* @param getSettings - The getSettings object.
|
|
3362
|
-
* @param getSettings.indexName -
|
|
3362
|
+
* @param getSettings.indexName - Name of the index on which to perform the operation.
|
|
3363
3363
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3364
3364
|
*/
|
|
3365
3365
|
getSettings({ indexName }, requestOptions) {
|
|
@@ -3378,7 +3378,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3378
3378
|
return transporter.request(request, requestOptions);
|
|
3379
3379
|
},
|
|
3380
3380
|
/**
|
|
3381
|
-
*
|
|
3381
|
+
* Retrieves all allowed IP addresses with access to your application.
|
|
3382
3382
|
*
|
|
3383
3383
|
* Required API Key ACLs:
|
|
3384
3384
|
* - admin.
|
|
@@ -3398,13 +3398,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3398
3398
|
return transporter.request(request, requestOptions);
|
|
3399
3399
|
},
|
|
3400
3400
|
/**
|
|
3401
|
-
*
|
|
3401
|
+
* Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
|
|
3402
3402
|
*
|
|
3403
3403
|
* Required API Key ACLs:
|
|
3404
3404
|
* - settings.
|
|
3405
3405
|
*
|
|
3406
3406
|
* @param getSynonym - The getSynonym object.
|
|
3407
|
-
* @param getSynonym.indexName -
|
|
3407
|
+
* @param getSynonym.indexName - Name of the index on which to perform the operation.
|
|
3408
3408
|
* @param getSynonym.objectID - Unique identifier of a synonym object.
|
|
3409
3409
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3410
3410
|
*/
|
|
@@ -3429,13 +3429,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3429
3429
|
return transporter.request(request, requestOptions);
|
|
3430
3430
|
},
|
|
3431
3431
|
/**
|
|
3432
|
-
*
|
|
3432
|
+
* 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.
|
|
3433
3433
|
*
|
|
3434
3434
|
* Required API Key ACLs:
|
|
3435
3435
|
* - addObject.
|
|
3436
3436
|
*
|
|
3437
3437
|
* @param getTask - The getTask object.
|
|
3438
|
-
* @param getTask.indexName -
|
|
3438
|
+
* @param getTask.indexName - Name of the index on which to perform the operation.
|
|
3439
3439
|
* @param getTask.taskID - Unique task identifier.
|
|
3440
3440
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3441
3441
|
*/
|
|
@@ -3460,7 +3460,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3460
3460
|
return transporter.request(request, requestOptions);
|
|
3461
3461
|
},
|
|
3462
3462
|
/**
|
|
3463
|
-
* Get the IDs of the 10 users with the highest number of records per cluster.
|
|
3463
|
+
* 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.
|
|
3464
3464
|
*
|
|
3465
3465
|
* Required API Key ACLs:
|
|
3466
3466
|
* - admin.
|
|
@@ -3480,13 +3480,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3480
3480
|
return transporter.request(request, requestOptions);
|
|
3481
3481
|
},
|
|
3482
3482
|
/**
|
|
3483
|
-
* Returns the
|
|
3483
|
+
* 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.
|
|
3484
3484
|
*
|
|
3485
3485
|
* Required API Key ACLs:
|
|
3486
3486
|
* - admin.
|
|
3487
3487
|
*
|
|
3488
3488
|
* @param getUserId - The getUserId object.
|
|
3489
|
-
* @param getUserId.userID -
|
|
3489
|
+
* @param getUserId.userID - User ID to assign.
|
|
3490
3490
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3491
3491
|
*/
|
|
3492
3492
|
getUserId({ userID }, requestOptions) {
|
|
@@ -3511,7 +3511,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3511
3511
|
* - admin.
|
|
3512
3512
|
*
|
|
3513
3513
|
* @param hasPendingMappings - The hasPendingMappings object.
|
|
3514
|
-
* @param hasPendingMappings.getClusters -
|
|
3514
|
+
* @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
|
|
3515
3515
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3516
3516
|
*/
|
|
3517
3517
|
hasPendingMappings({ getClusters } = {}, requestOptions = undefined) {
|
|
@@ -3530,7 +3530,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3530
3530
|
return transporter.request(request, requestOptions);
|
|
3531
3531
|
},
|
|
3532
3532
|
/**
|
|
3533
|
-
*
|
|
3533
|
+
* Lists all API keys associated with your Algolia application, including their permissions and restrictions.
|
|
3534
3534
|
*
|
|
3535
3535
|
* Required API Key ACLs:
|
|
3536
3536
|
* - admin.
|
|
@@ -3550,7 +3550,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3550
3550
|
return transporter.request(request, requestOptions);
|
|
3551
3551
|
},
|
|
3552
3552
|
/**
|
|
3553
|
-
*
|
|
3553
|
+
* Lists the available clusters in a multi-cluster setup.
|
|
3554
3554
|
*
|
|
3555
3555
|
* Required API Key ACLs:
|
|
3556
3556
|
* - admin.
|
|
@@ -3570,14 +3570,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3570
3570
|
return transporter.request(request, requestOptions);
|
|
3571
3571
|
},
|
|
3572
3572
|
/**
|
|
3573
|
-
*
|
|
3573
|
+
* Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.
|
|
3574
3574
|
*
|
|
3575
3575
|
* Required API Key ACLs:
|
|
3576
3576
|
* - listIndexes.
|
|
3577
3577
|
*
|
|
3578
3578
|
* @param listIndices - The listIndices object.
|
|
3579
|
-
* @param listIndices.page -
|
|
3580
|
-
* @param listIndices.hitsPerPage -
|
|
3579
|
+
* @param listIndices.page - Requested page of the API response. If `null`, the API response is not paginated.
|
|
3580
|
+
* @param listIndices.hitsPerPage - Number of hits per page.
|
|
3581
3581
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3582
3582
|
*/
|
|
3583
3583
|
listIndices({ page, hitsPerPage } = {}, requestOptions = undefined) {
|
|
@@ -3599,14 +3599,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3599
3599
|
return transporter.request(request, requestOptions);
|
|
3600
3600
|
},
|
|
3601
3601
|
/**
|
|
3602
|
-
*
|
|
3602
|
+
* 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.
|
|
3603
3603
|
*
|
|
3604
3604
|
* Required API Key ACLs:
|
|
3605
3605
|
* - admin.
|
|
3606
3606
|
*
|
|
3607
3607
|
* @param listUserIds - The listUserIds object.
|
|
3608
|
-
* @param listUserIds.page -
|
|
3609
|
-
* @param listUserIds.hitsPerPage -
|
|
3608
|
+
* @param listUserIds.page - Requested page of the API response. If `null`, the API response is not paginated.
|
|
3609
|
+
* @param listUserIds.hitsPerPage - Number of hits per page.
|
|
3610
3610
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3611
3611
|
*/
|
|
3612
3612
|
listUserIds({ page, hitsPerPage } = {}, requestOptions = undefined) {
|
|
@@ -3628,7 +3628,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3628
3628
|
return transporter.request(request, requestOptions);
|
|
3629
3629
|
},
|
|
3630
3630
|
/**
|
|
3631
|
-
*
|
|
3631
|
+
* 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.
|
|
3632
3632
|
*
|
|
3633
3633
|
* @param batchParams - The batchParams object.
|
|
3634
3634
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -3653,13 +3653,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3653
3653
|
return transporter.request(request, requestOptions);
|
|
3654
3654
|
},
|
|
3655
3655
|
/**
|
|
3656
|
-
*
|
|
3656
|
+
* 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/).
|
|
3657
3657
|
*
|
|
3658
3658
|
* Required API Key ACLs:
|
|
3659
3659
|
* - addObject.
|
|
3660
3660
|
*
|
|
3661
3661
|
* @param operationIndex - The operationIndex object.
|
|
3662
|
-
* @param operationIndex.indexName -
|
|
3662
|
+
* @param operationIndex.indexName - Name of the index on which to perform the operation.
|
|
3663
3663
|
* @param operationIndex.operationIndexParams - The operationIndexParams object.
|
|
3664
3664
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3665
3665
|
*/
|
|
@@ -3689,16 +3689,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3689
3689
|
return transporter.request(request, requestOptions);
|
|
3690
3690
|
},
|
|
3691
3691
|
/**
|
|
3692
|
-
*
|
|
3692
|
+
* 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.
|
|
3693
3693
|
*
|
|
3694
3694
|
* Required API Key ACLs:
|
|
3695
3695
|
* - addObject.
|
|
3696
3696
|
*
|
|
3697
3697
|
* @param partialUpdateObject - The partialUpdateObject object.
|
|
3698
|
-
* @param partialUpdateObject.indexName -
|
|
3699
|
-
* @param partialUpdateObject.objectID - Unique record
|
|
3700
|
-
* @param partialUpdateObject.attributesToUpdate -
|
|
3701
|
-
* @param partialUpdateObject.createIfNotExists -
|
|
3698
|
+
* @param partialUpdateObject.indexName - Name of the index on which to perform the operation.
|
|
3699
|
+
* @param partialUpdateObject.objectID - Unique record identifier.
|
|
3700
|
+
* @param partialUpdateObject.attributesToUpdate - Attributes with their values.
|
|
3701
|
+
* @param partialUpdateObject.createIfNotExists - Whether to create a new record if it doesn\'t exist.
|
|
3702
3702
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3703
3703
|
*/
|
|
3704
3704
|
partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }, requestOptions) {
|
|
@@ -3729,13 +3729,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3729
3729
|
return transporter.request(request, requestOptions);
|
|
3730
3730
|
},
|
|
3731
3731
|
/**
|
|
3732
|
-
*
|
|
3732
|
+
* Deletes a user ID and its associated data from the clusters.
|
|
3733
3733
|
*
|
|
3734
3734
|
* Required API Key ACLs:
|
|
3735
3735
|
* - admin.
|
|
3736
3736
|
*
|
|
3737
3737
|
* @param removeUserId - The removeUserId object.
|
|
3738
|
-
* @param removeUserId.userID -
|
|
3738
|
+
* @param removeUserId.userID - User ID to assign.
|
|
3739
3739
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3740
3740
|
*/
|
|
3741
3741
|
removeUserId({ userID }, requestOptions) {
|
|
@@ -3754,7 +3754,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3754
3754
|
return transporter.request(request, requestOptions);
|
|
3755
3755
|
},
|
|
3756
3756
|
/**
|
|
3757
|
-
*
|
|
3757
|
+
* Replaces the list of allowed sources.
|
|
3758
3758
|
*
|
|
3759
3759
|
* Required API Key ACLs:
|
|
3760
3760
|
* - admin.
|
|
@@ -3780,7 +3780,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3780
3780
|
return transporter.request(request, requestOptions);
|
|
3781
3781
|
},
|
|
3782
3782
|
/**
|
|
3783
|
-
*
|
|
3783
|
+
* 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.
|
|
3784
3784
|
*
|
|
3785
3785
|
* Required API Key ACLs:
|
|
3786
3786
|
* - admin.
|
|
@@ -3805,14 +3805,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3805
3805
|
return transporter.request(request, requestOptions);
|
|
3806
3806
|
},
|
|
3807
3807
|
/**
|
|
3808
|
-
*
|
|
3808
|
+
* 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).
|
|
3809
3809
|
*
|
|
3810
3810
|
* Required API Key ACLs:
|
|
3811
3811
|
* - addObject.
|
|
3812
3812
|
*
|
|
3813
3813
|
* @param saveObject - The saveObject object.
|
|
3814
|
-
* @param saveObject.indexName -
|
|
3815
|
-
* @param saveObject.body - The
|
|
3814
|
+
* @param saveObject.indexName - Name of the index on which to perform the operation.
|
|
3815
|
+
* @param saveObject.body - The record, a schemaless object with attributes that are useful in the context of search and discovery.
|
|
3816
3816
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3817
3817
|
*/
|
|
3818
3818
|
saveObject({ indexName, body }, requestOptions) {
|
|
@@ -3835,16 +3835,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3835
3835
|
return transporter.request(request, requestOptions);
|
|
3836
3836
|
},
|
|
3837
3837
|
/**
|
|
3838
|
-
* To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
|
|
3838
|
+
* 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).
|
|
3839
3839
|
*
|
|
3840
3840
|
* Required API Key ACLs:
|
|
3841
3841
|
* - editSettings.
|
|
3842
3842
|
*
|
|
3843
3843
|
* @param saveRule - The saveRule object.
|
|
3844
|
-
* @param saveRule.indexName -
|
|
3844
|
+
* @param saveRule.indexName - Name of the index on which to perform the operation.
|
|
3845
3845
|
* @param saveRule.objectID - Unique identifier of a rule object.
|
|
3846
3846
|
* @param saveRule.rule - The rule object.
|
|
3847
|
-
* @param saveRule.forwardToReplicas -
|
|
3847
|
+
* @param saveRule.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3848
3848
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3849
3849
|
*/
|
|
3850
3850
|
saveRule({ indexName, objectID, rule, forwardToReplicas }, requestOptions) {
|
|
@@ -3878,16 +3878,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3878
3878
|
return transporter.request(request, requestOptions);
|
|
3879
3879
|
},
|
|
3880
3880
|
/**
|
|
3881
|
-
* Create or update multiple rules.
|
|
3881
|
+
* 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.
|
|
3882
3882
|
*
|
|
3883
3883
|
* Required API Key ACLs:
|
|
3884
3884
|
* - editSettings.
|
|
3885
3885
|
*
|
|
3886
3886
|
* @param saveRules - The saveRules object.
|
|
3887
|
-
* @param saveRules.indexName -
|
|
3887
|
+
* @param saveRules.indexName - Name of the index on which to perform the operation.
|
|
3888
3888
|
* @param saveRules.rules - The rules object.
|
|
3889
|
-
* @param saveRules.forwardToReplicas -
|
|
3890
|
-
* @param saveRules.clearExistingRules -
|
|
3889
|
+
* @param saveRules.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3890
|
+
* @param saveRules.clearExistingRules - Whether existing rules should be deleted before adding this batch.
|
|
3891
3891
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3892
3892
|
*/
|
|
3893
3893
|
saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }, requestOptions) {
|
|
@@ -3916,16 +3916,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3916
3916
|
return transporter.request(request, requestOptions);
|
|
3917
3917
|
},
|
|
3918
3918
|
/**
|
|
3919
|
-
*
|
|
3919
|
+
* 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).
|
|
3920
3920
|
*
|
|
3921
3921
|
* Required API Key ACLs:
|
|
3922
3922
|
* - editSettings.
|
|
3923
3923
|
*
|
|
3924
3924
|
* @param saveSynonym - The saveSynonym object.
|
|
3925
|
-
* @param saveSynonym.indexName -
|
|
3925
|
+
* @param saveSynonym.indexName - Name of the index on which to perform the operation.
|
|
3926
3926
|
* @param saveSynonym.objectID - Unique identifier of a synonym object.
|
|
3927
3927
|
* @param saveSynonym.synonymHit - The synonymHit object.
|
|
3928
|
-
* @param saveSynonym.forwardToReplicas -
|
|
3928
|
+
* @param saveSynonym.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3929
3929
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3930
3930
|
*/
|
|
3931
3931
|
saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }, requestOptions) {
|
|
@@ -3962,16 +3962,16 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3962
3962
|
return transporter.request(request, requestOptions);
|
|
3963
3963
|
},
|
|
3964
3964
|
/**
|
|
3965
|
-
*
|
|
3965
|
+
* If a synonym with the `objectID` doesn\'t exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.
|
|
3966
3966
|
*
|
|
3967
3967
|
* Required API Key ACLs:
|
|
3968
3968
|
* - editSettings.
|
|
3969
3969
|
*
|
|
3970
3970
|
* @param saveSynonyms - The saveSynonyms object.
|
|
3971
|
-
* @param saveSynonyms.indexName -
|
|
3971
|
+
* @param saveSynonyms.indexName - Name of the index on which to perform the operation.
|
|
3972
3972
|
* @param saveSynonyms.synonymHit - The synonymHit object.
|
|
3973
|
-
* @param saveSynonyms.forwardToReplicas -
|
|
3974
|
-
* @param saveSynonyms.replaceExistingSynonyms -
|
|
3973
|
+
* @param saveSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
|
|
3974
|
+
* @param saveSynonyms.replaceExistingSynonyms - Whether to replace all synonyms in the index with the ones sent with this request.
|
|
3975
3975
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3976
3976
|
*/
|
|
3977
3977
|
saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }, requestOptions) {
|
|
@@ -4001,12 +4001,12 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
4001
4001
|
return transporter.request(request, requestOptions);
|
|
4002
4002
|
},
|
|
4003
4003
|
/**
|
|
4004
|
-
*
|
|
4004
|
+
* 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.
|
|
4005
4005
|
*
|
|
4006
4006
|
* Required API Key ACLs:
|
|
4007
4007
|
* - search.
|
|
4008
4008
|
*
|
|
4009
|
-
* @param searchMethodParams -
|
|
4009
|
+
* @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
|
|
4010
4010
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
4011
4011
|
*/
|
|
4012
4012
|
search(searchMethodParams, requestOptions) {
|
|
@@ -4053,13 +4053,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
4053
4053
|
return transporter.request(request, requestOptions);
|
|
4054
4054
|
},
|
|
4055
4055
|
/**
|
|
4056
|
-
*
|
|
4056
|
+
* Searches for standard and custom dictionary entries.
|
|
4057
4057
|
*
|
|
4058
4058
|
* Required API Key ACLs:
|
|
4059
4059
|
* - settings.
|
|
4060
4060
|
*
|
|
4061
4061
|
* @param searchDictionaryEntries - The searchDictionaryEntries object.
|
|
4062
|
-
* @param searchDictionaryEntries.dictionaryName - Dictionary to search
|
|
4062
|
+
* @param searchDictionaryEntries.dictionaryName - Dictionary type in which to search.
|
|
4063
4063
|
* @param searchDictionaryEntries.searchDictionaryEntriesParams - The searchDictionaryEntriesParams object.
|
|
4064
4064
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
4065
4065
|
*/
|
|
@@ -4088,14 +4088,14 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
4088
4088
|
return transporter.request(request, requestOptions);
|
|
4089
4089
|
},
|
|
4090
4090
|
/**
|
|
4091
|
-
*
|
|
4091
|
+
* 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**.
|
|
4092
4092
|
*
|
|
4093
4093
|
* Required API Key ACLs:
|
|
4094
4094
|
* - search.
|
|
4095
4095
|
*
|
|
4096
4096
|
* @param searchForFacetValues - The searchForFacetValues object.
|
|
4097
|
-
* @param searchForFacetValues.indexName -
|
|
4098
|
-
* @param searchForFacetValues.facetName - Facet
|
|
4097
|
+
* @param searchForFacetValues.indexName - Name of the index on which to perform the operation.
|
|
4098
|
+
* @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.
|
|
4099
4099
|
* @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.
|
|
4100
4100
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
4101
4101
|
*/
|
|
@@ -4123,13 +4123,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
4123
4123
|
return transporter.request(request, requestOptions);
|
|
4124
4124
|
},
|
|
4125
4125
|
/**
|
|
4126
|
-
*
|
|
4126
|
+
* Searches for rules in your index.
|
|
4127
4127
|
*
|
|
4128
4128
|
* Required API Key ACLs:
|
|
4129
4129
|
* - settings.
|
|
4130
4130
|
*
|
|
4131
4131
|
* @param searchRules - The searchRules object.
|
|
4132
|
-
* @param searchRules.indexName -
|
|
4132
|
+
* @param searchRules.indexName - Name of the index on which to perform the operation.
|
|
4133
4133
|
* @param searchRules.searchRulesParams - The searchRulesParams object.
|
|
4134
4134
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
4135
4135
|
*/
|
|
@@ -4152,13 +4152,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
4152
4152
|
return transporter.request(request, requestOptions);
|
|
4153
4153
|
},
|
|
4154
4154
|
/**
|
|
4155
|
-
*
|
|
4155
|
+
* 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.
|
|
4156
4156
|
*
|
|
4157
4157
|
* Required API Key ACLs:
|
|
4158
4158
|
* - search.
|
|
4159
4159
|
*
|
|
4160
4160
|
* @param searchSingleIndex - The searchSingleIndex object.
|
|
4161
|
-
* @param searchSingleIndex.indexName -
|
|
4161
|
+
* @param searchSingleIndex.indexName - Name of the index on which to perform the operation.
|
|
4162
4162
|
* @param searchSingleIndex.searchParams - The searchParams object.
|
|
4163
4163
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
4164
4164
|
*/
|
|
@@ -4181,13 +4181,13 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
4181
4181
|
return transporter.request(request, requestOptions);
|
|
4182
4182
|
},
|
|
4183
4183
|
/**
|
|
4184
|
-
*
|
|
4184
|
+
* Searches for synonyms in your index.
|
|
4185
4185
|
*
|
|
4186
4186
|
* Required API Key ACLs:
|
|
4187
4187
|
* - settings.
|
|
4188
4188
|
*
|
|
4189
4189
|
* @param searchSynonyms - The searchSynonyms object.
|
|
4190
|
-
* @param searchSynonyms.indexName -
|
|
4190
|
+
* @param searchSynonyms.indexName - Name of the index on which to perform the operation.
|
|
4191
4191
|
* @param searchSynonyms.searchSynonymsParams - Body of the `searchSynonyms` operation.
|
|
4192
4192
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
4193
4193
|
*/
|
|
@@ -4210,7 +4210,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
4210
4210
|
return transporter.request(request, requestOptions);
|
|
4211
4211
|
},
|
|
4212
4212
|
/**
|
|
4213
|
-
* Since it can take
|
|
4213
|
+
* 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).
|
|
4214
4214
|
*
|
|
4215
4215
|
* Required API Key ACLs:
|
|
4216
4216
|
* - admin.
|
|
@@ -4240,7 +4240,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
4240
4240
|
return transporter.request(request, requestOptions);
|
|
4241
4241
|
},
|
|
4242
4242
|
/**
|
|
4243
|
-
*
|
|
4243
|
+
* Turns standard stop word dictionary entries on or off for a given language.
|
|
4244
4244
|
*
|
|
4245
4245
|
* Required API Key ACLs:
|
|
4246
4246
|
* - editSettings.
|
|
@@ -4268,15 +4268,15 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
4268
4268
|
return transporter.request(request, requestOptions);
|
|
4269
4269
|
},
|
|
4270
4270
|
/**
|
|
4271
|
-
* Update the specified
|
|
4271
|
+
* 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.
|
|
4272
4272
|
*
|
|
4273
4273
|
* Required API Key ACLs:
|
|
4274
4274
|
* - editSettings.
|
|
4275
4275
|
*
|
|
4276
4276
|
* @param setSettings - The setSettings object.
|
|
4277
|
-
* @param setSettings.indexName -
|
|
4277
|
+
* @param setSettings.indexName - Name of the index on which to perform the operation.
|
|
4278
4278
|
* @param setSettings.indexSettings - The indexSettings object.
|
|
4279
|
-
* @param setSettings.forwardToReplicas -
|
|
4279
|
+
* @param setSettings.forwardToReplicas - Whether changes are applied to replica indices.
|
|
4280
4280
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
4281
4281
|
*/
|
|
4282
4282
|
setSettings({ indexName, indexSettings, forwardToReplicas }, requestOptions) {
|
|
@@ -4302,7 +4302,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
4302
4302
|
return transporter.request(request, requestOptions);
|
|
4303
4303
|
},
|
|
4304
4304
|
/**
|
|
4305
|
-
*
|
|
4305
|
+
* Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.
|
|
4306
4306
|
*
|
|
4307
4307
|
* Required API Key ACLs:
|
|
4308
4308
|
* - admin.
|