@algolia/client-search 5.0.0-alpha.72 → 5.0.0-alpha.75
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client-search.cjs.js +188 -186
- package/dist/client-search.esm.browser.js +188 -184
- package/dist/client-search.esm.node.js +188 -184
- package/dist/client-search.umd.js +2 -2
- package/dist/model/acl.d.ts +1 -1
- package/dist/model/action.d.ts +1 -1
- package/dist/model/addApiKeyResponse.d.ts +2 -2
- package/dist/model/anchoring.d.ts +1 -1
- package/dist/model/apiKey.d.ts +9 -9
- package/dist/model/aroundRadius.d.ts +1 -1
- package/dist/model/assignUserIdParams.d.ts +1 -1
- package/dist/model/baseGetApiKeyResponse.d.ts +2 -2
- package/dist/model/baseIndexSettings.d.ts +14 -14
- package/dist/model/baseSearchParamsWithoutQuery.d.ts +25 -25
- package/dist/model/baseSearchResponse.d.ts +20 -20
- package/dist/model/baseSearchResponseRedirect.d.ts +1 -1
- package/dist/model/batchAssignUserIdsParams.d.ts +2 -2
- package/dist/model/batchDictionaryEntriesParams.d.ts +3 -3
- package/dist/model/batchParams.d.ts +1 -1
- package/dist/model/batchRequest.d.ts +1 -1
- package/dist/model/batchResponse.d.ts +2 -2
- package/dist/model/batchWriteParams.d.ts +1 -1
- package/dist/model/builtInOperation.d.ts +1 -1
- package/dist/model/builtInOperationType.d.ts +1 -1
- package/dist/model/clientMethodProps.d.ts +88 -84
- package/dist/model/clientMethodProps.d.ts.map +1 -1
- package/dist/model/consequence.d.ts +4 -4
- package/dist/model/consequenceHide.d.ts +2 -2
- package/dist/model/createdAtResponse.d.ts +2 -2
- package/dist/model/cursor.d.ts +1 -1
- package/dist/model/deleteApiKeyResponse.d.ts +1 -1
- package/dist/model/deleteByParams.d.ts +4 -4
- package/dist/model/deleteSourceResponse.d.ts +1 -1
- package/dist/model/deletedAtResponse.d.ts +3 -3
- package/dist/model/dictionaryEntry.d.ts +6 -6
- package/dist/model/dictionaryEntryState.d.ts +1 -1
- package/dist/model/dictionaryLanguage.d.ts +2 -2
- package/dist/model/dictionarySettingsParams.d.ts +1 -1
- package/dist/model/distinct.d.ts +1 -1
- package/dist/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/model/facetFilters.d.ts +1 -1
- package/dist/model/facetHits.d.ts +3 -3
- package/dist/model/facetOrdering.d.ts +2 -2
- package/dist/model/facets.d.ts +1 -1
- package/dist/model/facetsStats.d.ts +4 -4
- package/dist/model/fetchedIndex.d.ts +1 -1
- package/dist/model/getObjectsParams.d.ts +1 -1
- package/dist/model/getObjectsRequest.d.ts +4 -4
- package/dist/model/getObjectsResponse.d.ts +1 -1
- package/dist/model/getTopUserIdsResponse.d.ts +2 -2
- package/dist/model/hasPendingMappingsResponse.d.ts +2 -2
- package/dist/model/highlightResultOption.d.ts +1 -1
- package/dist/model/hit.d.ts +1 -1
- package/dist/model/ignorePlurals.d.ts +1 -1
- package/dist/model/indexSettings.d.ts +1 -1
- package/dist/model/indexSettingsAsSearchParams.d.ts +30 -30
- package/dist/model/indexSettingsAsSearchParamsSemanticSearch.d.ts +2 -2
- package/dist/model/languages.d.ts +1 -1
- package/dist/model/listApiKeysResponse.d.ts +1 -1
- package/dist/model/listClustersResponse.d.ts +2 -2
- package/dist/model/listIndicesResponse.d.ts +1 -1
- package/dist/model/listUserIdsResponse.d.ts +2 -2
- package/dist/model/log.d.ts +7 -7
- package/dist/model/logQuery.d.ts +1 -1
- package/dist/model/mode.d.ts +1 -1
- package/dist/model/multipleBatchRequest.d.ts +1 -1
- package/dist/model/multipleBatchResponse.d.ts +2 -2
- package/dist/model/numericFilters.d.ts +1 -1
- package/dist/model/operationIndexParams.d.ts +2 -2
- package/dist/model/operationType.d.ts +1 -1
- package/dist/model/optionalFilters.d.ts +1 -1
- package/dist/model/params.d.ts +1 -1
- package/dist/model/promoteObjectID.d.ts +3 -3
- package/dist/model/promoteObjectIDs.d.ts +3 -3
- package/dist/model/queryType.d.ts +1 -1
- package/dist/model/reRankingApplyFilter.d.ts +1 -1
- package/dist/model/redirectRuleIndexMetadata.d.ts +1 -1
- package/dist/model/redirectRuleIndexMetadataData.d.ts +1 -1
- package/dist/model/removeStopWords.d.ts +1 -1
- package/dist/model/removeUserIdResponse.d.ts +1 -1
- package/dist/model/removeWordsIfNoResults.d.ts +1 -1
- package/dist/model/renderingContent.d.ts +1 -1
- package/dist/model/replaceSourceResponse.d.ts +1 -1
- package/dist/model/rule.d.ts +5 -5
- package/dist/model/saveObjectResponse.d.ts +5 -2
- package/dist/model/saveObjectResponse.d.ts.map +1 -1
- package/dist/model/saveSynonymResponse.d.ts +3 -3
- package/dist/model/searchDictionaryEntriesParams.d.ts +5 -5
- package/dist/model/searchForFacetValuesRequest.d.ts +2 -2
- package/dist/model/searchForFacetsOptions.d.ts +3 -3
- package/dist/model/searchForHitsOptions.d.ts +1 -1
- package/dist/model/searchParamsQuery.d.ts +1 -1
- package/dist/model/searchParamsString.d.ts +1 -1
- package/dist/model/searchRulesParams.d.ts +7 -7
- package/dist/model/searchStrategy.d.ts +3 -0
- package/dist/model/searchStrategy.d.ts.map +1 -1
- package/dist/model/searchSynonymsParams.d.ts +1 -1
- package/dist/model/searchSynonymsResponse.d.ts +2 -2
- package/dist/model/searchTypeDefault.d.ts +1 -1
- package/dist/model/searchTypeFacet.d.ts +1 -1
- package/dist/model/searchUserIdsParams.d.ts +4 -4
- package/dist/model/searchUserIdsResponse.d.ts +5 -5
- package/dist/model/snippetResultOption.d.ts +1 -1
- package/dist/model/sortRemainingBy.d.ts +1 -1
- package/dist/model/source.d.ts +3 -3
- package/dist/model/standardEntries.d.ts +4 -4
- package/dist/model/synonymHit.d.ts +6 -6
- package/dist/model/synonymType.d.ts +1 -1
- package/dist/model/tagFilters.d.ts +1 -1
- package/dist/model/taskStatus.d.ts +3 -0
- package/dist/model/taskStatus.d.ts.map +1 -1
- package/dist/model/typoTolerance.d.ts +1 -1
- package/dist/model/updateApiKeyResponse.d.ts +2 -2
- package/dist/model/updatedAtResponse.d.ts +3 -3
- package/dist/model/updatedAtWithObjectIdResponse.d.ts +4 -4
- package/dist/model/updatedRuleResponse.d.ts +3 -3
- package/dist/model/userHit.d.ts +1 -1
- package/dist/model/userId.d.ts +2 -2
- package/dist/src/searchClient.d.ts +185 -184
- package/dist/src/searchClient.d.ts.map +1 -1
- package/model/acl.ts +1 -1
- package/model/action.ts +1 -1
- package/model/addApiKeyResponse.ts +2 -2
- package/model/anchoring.ts +1 -1
- package/model/apiKey.ts +9 -9
- package/model/aroundRadius.ts +1 -1
- package/model/assignUserIdParams.ts +1 -1
- package/model/baseGetApiKeyResponse.ts +2 -2
- package/model/baseIndexSettings.ts +14 -14
- package/model/baseSearchParamsWithoutQuery.ts +25 -25
- package/model/baseSearchResponse.ts +20 -20
- package/model/baseSearchResponseRedirect.ts +1 -1
- package/model/batchAssignUserIdsParams.ts +2 -2
- package/model/batchDictionaryEntriesParams.ts +3 -3
- package/model/batchParams.ts +1 -1
- package/model/batchRequest.ts +1 -1
- package/model/batchResponse.ts +2 -2
- package/model/batchWriteParams.ts +1 -1
- package/model/builtInOperation.ts +1 -1
- package/model/builtInOperationType.ts +1 -1
- package/model/clientMethodProps.ts +88 -84
- package/model/consequence.ts +4 -4
- package/model/consequenceHide.ts +2 -2
- package/model/createdAtResponse.ts +2 -2
- package/model/cursor.ts +1 -1
- package/model/deleteApiKeyResponse.ts +1 -1
- package/model/deleteByParams.ts +4 -4
- package/model/deleteSourceResponse.ts +1 -1
- package/model/deletedAtResponse.ts +3 -3
- package/model/dictionaryEntry.ts +6 -6
- package/model/dictionaryEntryState.ts +1 -1
- package/model/dictionaryLanguage.ts +2 -2
- package/model/dictionarySettingsParams.ts +1 -1
- package/model/distinct.ts +1 -1
- package/model/exactOnSingleWordQuery.ts +1 -1
- package/model/facetFilters.ts +1 -1
- package/model/facetHits.ts +3 -3
- package/model/facetOrdering.ts +2 -2
- package/model/facets.ts +1 -1
- package/model/facetsStats.ts +4 -4
- package/model/fetchedIndex.ts +1 -1
- package/model/getObjectsParams.ts +1 -1
- package/model/getObjectsRequest.ts +4 -4
- package/model/getObjectsResponse.ts +1 -1
- package/model/getTopUserIdsResponse.ts +2 -2
- package/model/hasPendingMappingsResponse.ts +2 -2
- package/model/highlightResultOption.ts +1 -1
- package/model/hit.ts +1 -1
- package/model/ignorePlurals.ts +1 -1
- package/model/indexSettings.ts +1 -1
- package/model/indexSettingsAsSearchParams.ts +30 -30
- package/model/indexSettingsAsSearchParamsSemanticSearch.ts +2 -2
- package/model/languages.ts +1 -1
- package/model/listApiKeysResponse.ts +1 -1
- package/model/listClustersResponse.ts +2 -2
- package/model/listIndicesResponse.ts +1 -1
- package/model/listUserIdsResponse.ts +2 -2
- package/model/log.ts +7 -7
- package/model/logQuery.ts +1 -1
- package/model/mode.ts +1 -1
- package/model/multipleBatchRequest.ts +1 -1
- package/model/multipleBatchResponse.ts +2 -2
- package/model/numericFilters.ts +1 -1
- package/model/operationIndexParams.ts +2 -2
- package/model/operationType.ts +1 -1
- package/model/optionalFilters.ts +1 -1
- package/model/params.ts +1 -1
- package/model/promoteObjectID.ts +3 -3
- package/model/promoteObjectIDs.ts +3 -3
- package/model/queryType.ts +1 -1
- package/model/reRankingApplyFilter.ts +1 -1
- package/model/redirectRuleIndexMetadata.ts +1 -1
- package/model/redirectRuleIndexMetadataData.ts +1 -1
- package/model/removeStopWords.ts +1 -1
- package/model/removeUserIdResponse.ts +1 -1
- package/model/removeWordsIfNoResults.ts +1 -1
- package/model/renderingContent.ts +1 -1
- package/model/replaceSourceResponse.ts +1 -1
- package/model/rule.ts +5 -5
- package/model/saveObjectResponse.ts +5 -2
- package/model/saveSynonymResponse.ts +3 -3
- package/model/searchDictionaryEntriesParams.ts +5 -5
- package/model/searchForFacetValuesRequest.ts +2 -2
- package/model/searchForFacetsOptions.ts +3 -3
- package/model/searchForHitsOptions.ts +1 -1
- package/model/searchParamsQuery.ts +1 -1
- package/model/searchParamsString.ts +1 -1
- package/model/searchRulesParams.ts +7 -7
- package/model/searchStrategy.ts +3 -0
- package/model/searchSynonymsParams.ts +1 -1
- package/model/searchSynonymsResponse.ts +2 -2
- package/model/searchTypeDefault.ts +1 -1
- package/model/searchTypeFacet.ts +1 -1
- package/model/searchUserIdsParams.ts +4 -4
- package/model/searchUserIdsResponse.ts +5 -5
- package/model/snippetResultOption.ts +1 -1
- package/model/sortRemainingBy.ts +1 -1
- package/model/source.ts +3 -3
- package/model/standardEntries.ts +4 -4
- package/model/synonymHit.ts +6 -6
- package/model/synonymType.ts +1 -1
- package/model/tagFilters.ts +1 -1
- package/model/taskStatus.ts +3 -0
- package/model/typoTolerance.ts +1 -1
- package/model/updateApiKeyResponse.ts +2 -2
- package/model/updatedAtResponse.ts +3 -3
- package/model/updatedAtWithObjectIdResponse.ts +4 -4
- package/model/updatedRuleResponse.ts +3 -3
- package/model/userHit.ts +1 -1
- package/model/userId.ts +2 -2
- package/package.json +8 -7
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEd,QAAQ,EAET,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,UAAU,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,WAAW,EACX,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,QAAQ,EACR,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,SAAS,EACT,QAAQ,EACR,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,4BAA4B,EAC5B,yBAAyB,EACzB,gBAAgB,EAChB,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAsCjD,wBAAgB,kBAAkB,CAAC,EACjC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;;;OAUG;6DAQE,kBAAkB,mBACJ,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAgB3B;;;;;;;;;;;OAWG;oEASE,oBAAoB,mBACN,cAAc,GAC9B,QAAQ,QAAQ,GAAG,iBAAiB,CAAC;IAoDxC;;;;;;;;;;OAUG;0TAOgB,cAAc;IAoBjC;;;;;;;;;;OAUG;yEAME,cAAc,mBAAmB,CAAC,GAAG,gBAAgB,mBACvC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA0B/B;;;;;;;;;OASG;kFAOE,cAAc,sBAAsB,CAAC,GAAG,mBAAmB,mBAC7C,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAwBlC;;;;;;OAMG;sBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;qDAE8B,sBAAsB,mBACpC,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAoCzC;;;;;;OAMG;yBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;OAQG;yDAEuC,iBAAiB,mBACxC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAsC7B;;;;;;;;OAQG;2CAEgC,UAAU,mBAC1B,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAqCzB;;;;;;;;OAQG;qEAE6C,uBAAuB,mBACpD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA2C7B;;;;;;;;OAQG;8EAKE,2BAA2B,mBACb,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAqC7B;;;;;;;;OAQG;6CAE4B,WAAW,mBACvB,cAAc;IA0BjC;;;;;;;;OAQG;uDAEiC,qBAAqB,mBACtC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;OAOG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;iDAEiC,eAAe,mBAChC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;0BAEQ,iBAAiB,mBACT,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;OAQG;4CAE8B,aAAa,mBAC3B,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA+B7B;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;0CAEwB,iBAAiB,mBACzB,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA6B7B;;;;;;;;;OASG;2DAE2C,eAAe,mBAC1C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;;OASG;8DAE2C,kBAAkB,mBAC7C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;uBAEQ,cAAc,mBACN,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;OAKG;4CAEgB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,SAAS,CAAC,CAAC;IAerC;;;;;OAKG;2CAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;;;;OAUG;kDAEoC,YAAY,mBACjC,cAAc,GAAG,SAAS,GACzC,QAAQ,eAAe,CAAC;IA+B3B;;;;;;;;;OASG;6DAE8C,cAAc,mBAC5C,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC;IAiClC;;;;;;OAMG;sCAEiB,gBAAgB,mBACjB,cAAc;IA+BjC;;;;;;;;OAQG;qCAEwB,YAAY,mBACpB,cAAc,GAC9B,QAAQ,IAAI,CAAC;IA6BhB;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAwBzB;;;;;OAKG;gCACyB,cAAc,GAAG,QAAQ,MAAM,EAAE,CAAC;IAe9D;;;;;;;;OAQG;wCAEwB,eAAe,mBACvB,cAAc,GAC9B,QAAQ,UAAU,CAAC;IA6BtB;;;;;;;;OAQG;mCAEsB,YAAY,mBAClB,cAAc,GAC9B,QAAQ,eAAe,CAAC;IA6B3B;;;;;OAKG;mCAEgB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAejC;;;;;;;OAOG;0BAEW,cAAc,mBACT,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAwBlB;;;;;;;OAOG;yCAEgB,uBAAuB,mBACxB,cAAc,GAAG,SAAS,GACzC,QAAQ,0BAA0B,CAAC;IAmBtC;;;;;OAKG;iCAC0B,cAAc,GAAG,QAAQ,mBAAmB,CAAC;IAe1E;;;;;OAKG;kCAEgB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAehC
|
|
1
|
+
{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../src/searchClient.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEd,QAAQ,EAET,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,UAAU,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,WAAW,EACX,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,QAAQ,EACR,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,SAAS,EACT,QAAQ,EACR,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,4BAA4B,EAC5B,yBAAyB,EACzB,gBAAgB,EAChB,sBAAsB,EACtB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAsCjD,wBAAgB,kBAAkB,CAAC,EACjC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;;;OAUG;6DAQE,kBAAkB,mBACJ,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAgB3B;;;;;;;;;;;OAWG;oEASE,oBAAoB,mBACN,cAAc,GAC9B,QAAQ,QAAQ,GAAG,iBAAiB,CAAC;IAoDxC;;;;;;;;;;OAUG;0TAOgB,cAAc;IAoBjC;;;;;;;;;;OAUG;yEAME,cAAc,mBAAmB,CAAC,GAAG,gBAAgB,mBACvC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA0B/B;;;;;;;;;OASG;kFAOE,cAAc,sBAAsB,CAAC,GAAG,mBAAmB,mBAC7C,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAwBlC;;;;;;OAMG;sBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;qDAE8B,sBAAsB,mBACpC,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAoCzC;;;;;;OAMG;yBAEO,MAAM,mBACG,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;OAQG;yDAEuC,iBAAiB,mBACxC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAsC7B;;;;;;;;OAQG;2CAEgC,UAAU,mBAC1B,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAqCzB;;;;;;;;OAQG;qEAE6C,uBAAuB,mBACpD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA2C7B;;;;;;;;OAQG;8EAKE,2BAA2B,mBACb,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAqC7B;;;;;;;;OAQG;6CAE4B,WAAW,mBACvB,cAAc;IA0BjC;;;;;;;;OAQG;uDAEiC,qBAAqB,mBACtC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;OAOG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;iDAEiC,eAAe,mBAChC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;0BAEQ,iBAAiB,mBACT,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;OAQG;4CAE8B,aAAa,mBAC3B,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA+B7B;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;0CAEwB,iBAAiB,mBACzB,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA6B7B;;;;;;;;;OASG;2DAE2C,eAAe,mBAC1C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;;OASG;8DAE2C,kBAAkB,mBAC7C,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAiC7B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;uBAEQ,cAAc,mBACN,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;OAKG;4CAEgB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,SAAS,CAAC,CAAC;IAerC;;;;;OAKG;2CAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;;;;OAUG;kDAEoC,YAAY,mBACjC,cAAc,GAAG,SAAS,GACzC,QAAQ,eAAe,CAAC;IA+B3B;;;;;;;;;OASG;6DAE8C,cAAc,mBAC5C,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC;IAiClC;;;;;;OAMG;sCAEiB,gBAAgB,mBACjB,cAAc;IA+BjC;;;;;;;;OAQG;qCAEwB,YAAY,mBACpB,cAAc,GAC9B,QAAQ,IAAI,CAAC;IA6BhB;;;;;;;OAOG;+BAEc,gBAAgB,mBACd,cAAc,GAC9B,QAAQ,aAAa,CAAC;IAwBzB;;;;;OAKG;gCACyB,cAAc,GAAG,QAAQ,MAAM,EAAE,CAAC;IAe9D;;;;;;;;OAQG;wCAEwB,eAAe,mBACvB,cAAc,GAC9B,QAAQ,UAAU,CAAC;IA6BtB;;;;;;;;OAQG;mCAEsB,YAAY,mBAClB,cAAc,GAC9B,QAAQ,eAAe,CAAC;IA6B3B;;;;;OAKG;mCAEgB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAejC;;;;;;;OAOG;0BAEW,cAAc,mBACT,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAwBlB;;;;;;;OAOG;yCAEgB,uBAAuB,mBACxB,cAAc,GAAG,SAAS,GACzC,QAAQ,0BAA0B,CAAC;IAmBtC;;;;;OAKG;iCAC0B,cAAc,GAAG,QAAQ,mBAAmB,CAAC;IAe1E;;;;;OAKG;kCAEgB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAehC;;;;;;;;OAQG;wCAEsB,gBAAgB,mBACvB,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;;;OAQG;wCAEsB,gBAAgB,mBACvB,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;OAMG;+BAEY,WAAW,mBACP,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA4BjC;;;;;;;;OAQG;wDAEoC,mBAAmB,mBACvC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA0C7B;;;;;;;;;;OAUG;yFAOE,wBAAwB,mBACV,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAwCzC;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;OAOG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;OAOG;+BAEW,mBAAmB,mBACd,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAsBjC;;;;;;;OAOG;2BAEQ,kBAAkB,mBACV,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;;;OAQG;oCAEoB,eAAe,mBACnB,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IA+B9B;;;;;;;;;;OAUG;+DAEiD,aAAa,mBAC9C,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA8C/B;;;;;;;;;;OAUG;4EAOE,cAAc,mBACA,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;;OAUG;wEAEuD,gBAAgB,mBACvD,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IAmD/B;;;;;;;;;;OAUG;yFAOE,iBAAiB,mBACH,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwC7B;;;;;;OAMG;oCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;IAwDjC;;;;;;;;OAQG;gFAKE,4BAA4B,mBACd,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAuC7B;;;;;;;;;OASG;iFAME,yBAAyB,mBACX,cAAc,GAC9B,QAAQ,4BAA4B,CAAC;IAgCxC;;;;;;;;OAQG;kDAEiC,gBAAgB,mBACjC,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IA2B/B;;;;;;;;OAQG;wDAE4B,sBAAsB,mBAClC,cAAc;IA4BjC;;;;;;;;;;;OAWG;kFAQE,mBAAmB,mBACL,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAuClC;;;;;;OAMG;uCAEoB,mBAAmB,mBACvB,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IA8BjC;;;;;;OAMG;oDAEyB,wBAAwB,mBACjC,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IA4B7B;;;;;;;;;OASG;iEAEgD,gBAAgB,mBAChD,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAmC7B;;;;;;;;OAQG;kCAEgB,iBAAiB,mBACjB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;EAqCnC;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
|
package/model/acl.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// 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.
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* API key permissions: `addObject`: required to add or update records, copy or move an index. `analytics`: required to access the Analytics API. `browse`: required to view records `deleteIndex`: required to delete indices. `deleteObject`: required to delete records. `editSettings`: required to change index settings. `listIndexes`: required to list indices. `logs`: required to access logs of search and indexing operations. `recommendation`: required to access the Personalization and Recommend APIs. `search`: required to search records `seeUnretrievableAttributes`: required to retrieve [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) for all operations that return records. `settings`: required to examine index settings.
|
|
5
5
|
*/
|
|
6
6
|
export type Acl =
|
|
7
7
|
| 'addObject'
|
package/model/action.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// 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.
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* Type of operation.
|
|
4
|
+
* Type of batch operation.
|
|
5
5
|
*/
|
|
6
6
|
export type Action =
|
|
7
7
|
| 'addObject'
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
export type AddApiKeyResponse = {
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* API key.
|
|
6
6
|
*/
|
|
7
7
|
key: string;
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Timestamp of creation in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
|
|
11
11
|
*/
|
|
12
12
|
createdAt: string;
|
|
13
13
|
};
|
package/model/anchoring.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// 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.
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* Whether the pattern parameter
|
|
4
|
+
* Whether the pattern parameter matches the beginning (`startsWith`) or end (`endsWith`) of the query string, is an exact match (`is`), or a partial match (`contains`).
|
|
5
5
|
*/
|
|
6
6
|
export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';
|
package/model/apiKey.ts
CHANGED
|
@@ -3,46 +3,46 @@
|
|
|
3
3
|
import type { Acl } from './acl';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* API key object.
|
|
7
7
|
*/
|
|
8
8
|
export type ApiKey = {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* [Permissions](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl) associated with the key.
|
|
11
11
|
*/
|
|
12
12
|
acl: Acl[];
|
|
13
13
|
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Description of an API key for you and your team members.
|
|
16
16
|
*/
|
|
17
17
|
description?: string;
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* Restricts this API key to a list of indices or index patterns. If the list is empty, all indices are allowed. Specify either an exact index name or a pattern with a leading or trailing wildcard character (or both). For example: - `dev_*` matches all indices starting with \"dev_\" - `*_dev` matches all indices ending with \"_dev\" - `*_products_*` matches all indices containing \"_products_\".
|
|
21
21
|
*/
|
|
22
22
|
indexes?: string[];
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
|
-
* Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.
|
|
25
|
+
* Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced. > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
|
|
26
26
|
*/
|
|
27
27
|
maxHitsPerQuery?: number;
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
* Maximum number of API calls per hour allowed from a given IP address or
|
|
30
|
+
* Maximum number of API calls per hour allowed from a given IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). Each time an API call is performed with this key, a check is performed. If there were more than the specified number of calls within the last hour, the API returns an error with the status code `429` (Too Many Requests). > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
|
|
31
31
|
*/
|
|
32
32
|
maxQueriesPerIPPerHour?: number;
|
|
33
33
|
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* Force some [query parameters](https://www.algolia.com/doc/api-reference/api-parameters/) to be applied for each query made with this API key. It\'s a URL-encoded query string.
|
|
36
36
|
*/
|
|
37
37
|
queryParameters?: string;
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
|
-
* Restrict this
|
|
40
|
+
* Restrict this API key to specific [referrers](https://www.algolia.com/doc/guides/security/api-keys/in-depth/api-key-restrictions/#http-referrers). If empty, all referrers are allowed. For example: - `https://algolia.com/_*` matches all referrers starting with \"https://algolia.com/\" - `*.algolia.com` matches all referrers ending with \".algolia.com\" - `*algolia.com*` allows everything in the domain \"algolia.com\".
|
|
41
41
|
*/
|
|
42
42
|
referers?: string[];
|
|
43
43
|
|
|
44
44
|
/**
|
|
45
|
-
* Validity
|
|
45
|
+
* Validity duration of a key (in seconds). The key will automatically be removed after this time has expired. The default value of 0 never expires. Short-lived API keys are useful to grant temporary access to your data. For example, in mobile apps, you can\'t [control when users update your app](https://www.algolia.com/doc/guides/security/security-best-practices/#use-secured-api-keys-in-mobile-apps). So instead of encoding keys into your app as you would for a web app, you should dynamically fetch them from your mobile app\'s backend.
|
|
46
46
|
*/
|
|
47
47
|
validity?: number;
|
|
48
48
|
};
|
package/model/aroundRadius.ts
CHANGED
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
import type { AroundRadiusAll } from './aroundRadiusAll';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* [Maximum radius](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#increase-the-search-radius) for a geographical search (in meters).
|
|
7
7
|
*/
|
|
8
8
|
export type AroundRadius = AroundRadiusAll | number;
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
export type BaseGetApiKeyResponse = {
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* API key.
|
|
6
6
|
*/
|
|
7
7
|
value?: string;
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Timestamp of creation in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time).
|
|
11
11
|
*/
|
|
12
12
|
createdAt: number;
|
|
13
13
|
};
|
|
@@ -2,67 +2,67 @@
|
|
|
2
2
|
|
|
3
3
|
export type BaseIndexSettings = {
|
|
4
4
|
/**
|
|
5
|
-
* Creates replicas,
|
|
5
|
+
* Creates [replicas](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/), which are copies of a primary index with the same records but different settings.
|
|
6
6
|
*/
|
|
7
7
|
replicas?: string[];
|
|
8
8
|
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Maximum number of hits accessible through pagination.
|
|
11
11
|
*/
|
|
12
12
|
paginationLimitedTo?: number;
|
|
13
13
|
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Attributes that can\'t be retrieved at query time.
|
|
16
16
|
*/
|
|
17
17
|
unretrievableAttributes?: string[];
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
|
|
21
21
|
*/
|
|
22
22
|
disableTypoToleranceOnWords?: string[];
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Attributes in your index to which [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead) applies. This will ensure that words indexed in Katakana or Kanji can also be searched in Hiragana.
|
|
26
26
|
*/
|
|
27
27
|
attributesToTransliterate?: string[];
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* Attributes on which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.
|
|
31
31
|
*/
|
|
32
32
|
camelCaseAttributes?: string[];
|
|
33
33
|
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* Attributes in your index to which [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding) applies.
|
|
36
36
|
*/
|
|
37
37
|
decompoundedAttributes?: Record<string, any>;
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
|
-
*
|
|
40
|
+
* Set the languages of your index, for language-specific processing steps such as [tokenization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/tokenization/) and [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
|
|
41
41
|
*/
|
|
42
42
|
indexLanguages?: string[];
|
|
43
43
|
|
|
44
44
|
/**
|
|
45
|
-
*
|
|
45
|
+
* Attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).
|
|
46
46
|
*/
|
|
47
47
|
disablePrefixOnAttributes?: string[];
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
50
|
+
* Incidates whether the engine compresses arrays with exclusively non-negative integers. When enabled, the compressed arrays may be reordered.
|
|
51
51
|
*/
|
|
52
52
|
allowCompressionOfIntegerArray?: boolean;
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
|
-
*
|
|
55
|
+
* Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).
|
|
56
56
|
*/
|
|
57
57
|
numericAttributesForFiltering?: string[];
|
|
58
58
|
|
|
59
59
|
/**
|
|
60
|
-
*
|
|
60
|
+
* Controls which separators are added to an Algolia index as part of [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean). Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
|
|
61
61
|
*/
|
|
62
62
|
separatorsToIndex?: string;
|
|
63
63
|
|
|
64
64
|
/**
|
|
65
|
-
*
|
|
65
|
+
* [Attributes used for searching](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/), including determining [if matches at the beginning of a word are important (ordered) or not (unordered)](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/how-to/configuring-searchable-attributes-the-right-way/#understanding-word-position).
|
|
66
66
|
*/
|
|
67
67
|
searchableAttributes?: string[];
|
|
68
68
|
|
|
@@ -72,7 +72,7 @@ export type BaseIndexSettings = {
|
|
|
72
72
|
userData?: Record<string, any>;
|
|
73
73
|
|
|
74
74
|
/**
|
|
75
|
-
*
|
|
75
|
+
* A list of characters and their normalized replacements to override Algolia\'s default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
|
|
76
76
|
*/
|
|
77
77
|
customNormalization?: Record<string, Record<string, string>>;
|
|
78
78
|
};
|
|
@@ -9,12 +9,12 @@ import type { TagFilters } from './tagFilters';
|
|
|
9
9
|
|
|
10
10
|
export type BaseSearchParamsWithoutQuery = {
|
|
11
11
|
/**
|
|
12
|
-
* Overrides the query parameter and performs a more generic search
|
|
12
|
+
* Overrides the query parameter and performs a more generic search.
|
|
13
13
|
*/
|
|
14
14
|
similarQuery?: string;
|
|
15
15
|
|
|
16
16
|
/**
|
|
17
|
-
* Filter the query with numeric, facet
|
|
17
|
+
* [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
|
|
18
18
|
*/
|
|
19
19
|
filters?: string;
|
|
20
20
|
|
|
@@ -27,22 +27,22 @@ export type BaseSearchParamsWithoutQuery = {
|
|
|
27
27
|
tagFilters?: TagFilters;
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
* Determines how to calculate
|
|
30
|
+
* Determines how to calculate [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). If `false`, maximum score is kept. If `true`, score is summed.
|
|
31
31
|
*/
|
|
32
32
|
sumOrFiltersScores?: boolean;
|
|
33
33
|
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* Returns [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts), their facet values, and the number of matching facet values.
|
|
36
36
|
*/
|
|
37
37
|
facets?: string[];
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
|
-
* Maximum number of facet values to return for each facet
|
|
40
|
+
* Maximum number of facet values to return for each facet.
|
|
41
41
|
*/
|
|
42
42
|
maxValuesPerFacet?: number;
|
|
43
43
|
|
|
44
44
|
/**
|
|
45
|
-
*
|
|
45
|
+
* Forces faceting to be applied after [de-duplication](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/) (with the distinct feature). Alternatively, the `afterDistinct` [modifier](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) of `attributesForFaceting` allows for more granular control.
|
|
46
46
|
*/
|
|
47
47
|
facetingAfterDistinct?: boolean;
|
|
48
48
|
|
|
@@ -52,89 +52,89 @@ export type BaseSearchParamsWithoutQuery = {
|
|
|
52
52
|
sortFacetValuesBy?: string;
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
|
-
*
|
|
55
|
+
* Page to retrieve (the first page is `0`, not `1`).
|
|
56
56
|
*/
|
|
57
57
|
page?: number;
|
|
58
58
|
|
|
59
59
|
/**
|
|
60
|
-
*
|
|
60
|
+
* Specifies the offset of the first hit to return. > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
|
|
61
61
|
*/
|
|
62
62
|
offset?: number;
|
|
63
63
|
|
|
64
64
|
/**
|
|
65
|
-
*
|
|
65
|
+
* Sets the number of hits to retrieve (for use with `offset`). > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
|
|
66
66
|
*/
|
|
67
67
|
length?: number;
|
|
68
68
|
|
|
69
69
|
/**
|
|
70
|
-
* Search for entries around a central geolocation, enabling a
|
|
70
|
+
* Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.
|
|
71
71
|
*/
|
|
72
72
|
aroundLatLng?: string;
|
|
73
73
|
|
|
74
74
|
/**
|
|
75
|
-
* Search for entries around a
|
|
75
|
+
* Search for entries around a location. The location is automatically computed from the requester\'s IP address.
|
|
76
76
|
*/
|
|
77
77
|
aroundLatLngViaIP?: boolean;
|
|
78
78
|
|
|
79
79
|
aroundRadius?: AroundRadius;
|
|
80
80
|
|
|
81
81
|
/**
|
|
82
|
-
* Precision of
|
|
82
|
+
* Precision of a geographical search (in meters), to [group results that are more or less the same distance from a central point](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/in-depth/geo-ranking-precision/).
|
|
83
83
|
*/
|
|
84
84
|
aroundPrecision?: number;
|
|
85
85
|
|
|
86
86
|
/**
|
|
87
|
-
* Minimum radius (in meters) used for a
|
|
87
|
+
* Minimum radius (in meters) used for a geographical search when `aroundRadius` isn\'t set.
|
|
88
88
|
*/
|
|
89
89
|
minimumAroundRadius?: number;
|
|
90
90
|
|
|
91
91
|
/**
|
|
92
|
-
* Search inside a rectangular area (in
|
|
92
|
+
* Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
|
|
93
93
|
*/
|
|
94
94
|
insideBoundingBox?: number[];
|
|
95
95
|
|
|
96
96
|
/**
|
|
97
|
-
* Search inside a polygon (in
|
|
97
|
+
* Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
|
|
98
98
|
*/
|
|
99
99
|
insidePolygon?: number[];
|
|
100
100
|
|
|
101
101
|
/**
|
|
102
|
-
*
|
|
102
|
+
* Changes the default values of parameters that work best for a natural language query, such as `ignorePlurals`, `removeStopWords`, `removeWordsIfNoResults`, `analyticsTags`, and `ruleContexts`. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries.
|
|
103
103
|
*/
|
|
104
104
|
naturalLanguages?: string[];
|
|
105
105
|
|
|
106
106
|
/**
|
|
107
|
-
*
|
|
107
|
+
* Assigns [rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) to search queries.
|
|
108
108
|
*/
|
|
109
109
|
ruleContexts?: string[];
|
|
110
110
|
|
|
111
111
|
/**
|
|
112
|
-
*
|
|
112
|
+
* Defines how much [Personalization affects results](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
|
|
113
113
|
*/
|
|
114
114
|
personalizationImpact?: number;
|
|
115
115
|
|
|
116
116
|
/**
|
|
117
|
-
* Associates a
|
|
117
|
+
* Associates a [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) with the current search.
|
|
118
118
|
*/
|
|
119
119
|
userToken?: string;
|
|
120
120
|
|
|
121
121
|
/**
|
|
122
|
-
*
|
|
122
|
+
* Incidates whether the search response includes [detailed ranking information](https://www.algolia.com/doc/guides/building-search-ui/going-further/backend-search/in-depth/understanding-the-api-response/#ranking-information).
|
|
123
123
|
*/
|
|
124
124
|
getRankingInfo?: boolean;
|
|
125
125
|
|
|
126
126
|
/**
|
|
127
|
-
*
|
|
127
|
+
* Indicates whether a query ID parameter is included in the search response. This is required for [tracking click and conversion events](https://www.algolia.com/doc/guides/sending-events/concepts/event-types/#events-related-to-algolia-requests).
|
|
128
128
|
*/
|
|
129
129
|
clickAnalytics?: boolean;
|
|
130
130
|
|
|
131
131
|
/**
|
|
132
|
-
*
|
|
132
|
+
* Indicates whether this query will be included in [analytics](https://www.algolia.com/doc/guides/search-analytics/guides/exclude-queries/).
|
|
133
133
|
*/
|
|
134
134
|
analytics?: boolean;
|
|
135
135
|
|
|
136
136
|
/**
|
|
137
|
-
*
|
|
137
|
+
* Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
138
138
|
*/
|
|
139
139
|
analyticsTags?: string[];
|
|
140
140
|
|
|
@@ -144,12 +144,12 @@ export type BaseSearchParamsWithoutQuery = {
|
|
|
144
144
|
percentileComputation?: boolean;
|
|
145
145
|
|
|
146
146
|
/**
|
|
147
|
-
*
|
|
147
|
+
* Incidates whether this search will be considered in A/B testing.
|
|
148
148
|
*/
|
|
149
149
|
enableABTest?: boolean;
|
|
150
150
|
|
|
151
151
|
/**
|
|
152
|
-
*
|
|
152
|
+
* Indicates whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
|
|
153
153
|
*/
|
|
154
154
|
enableReRanking?: boolean;
|
|
155
155
|
|
|
@@ -6,42 +6,42 @@ import type { RenderingContent } from './renderingContent';
|
|
|
6
6
|
|
|
7
7
|
export type BaseSearchResponse = {
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* A/B test ID. This is only included in the response for indices that are part of an A/B test.
|
|
10
10
|
*/
|
|
11
11
|
abTestID?: number;
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Variant ID. This is only included in the response for indices that are part of an A/B test.
|
|
15
15
|
*/
|
|
16
16
|
abTestVariantID?: number;
|
|
17
17
|
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* Computed geographical location.
|
|
20
20
|
*/
|
|
21
21
|
aroundLatLng?: string;
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* Automatically-computed radius.
|
|
25
25
|
*/
|
|
26
26
|
automaticRadius?: string;
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Indicates whether the facet count is exhaustive (exact) or approximate.
|
|
30
30
|
*/
|
|
31
31
|
exhaustiveFacetsCount?: boolean;
|
|
32
32
|
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* Indicates whether the number of hits `nbHits` is exhaustive (exact) or approximate.
|
|
35
35
|
*/
|
|
36
36
|
exhaustiveNbHits: boolean;
|
|
37
37
|
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* Indicates whether the search for typos was exhaustive (exact) or approximate.
|
|
40
40
|
*/
|
|
41
41
|
exhaustiveTypo?: boolean;
|
|
42
42
|
|
|
43
43
|
/**
|
|
44
|
-
*
|
|
44
|
+
* Mapping of each facet name to the corresponding facet counts.
|
|
45
45
|
*/
|
|
46
46
|
facets?: Record<string, Record<string, number>>;
|
|
47
47
|
|
|
@@ -51,7 +51,7 @@ export type BaseSearchResponse = {
|
|
|
51
51
|
facets_stats?: Record<string, FacetsStats>;
|
|
52
52
|
|
|
53
53
|
/**
|
|
54
|
-
*
|
|
54
|
+
* Number of hits per page.
|
|
55
55
|
*/
|
|
56
56
|
hitsPerPage: number;
|
|
57
57
|
|
|
@@ -61,44 +61,44 @@ export type BaseSearchResponse = {
|
|
|
61
61
|
index?: string;
|
|
62
62
|
|
|
63
63
|
/**
|
|
64
|
-
* Index name used for the query.
|
|
64
|
+
* Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
|
|
65
65
|
*/
|
|
66
66
|
indexUsed?: string;
|
|
67
67
|
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* Warnings about the query.
|
|
70
70
|
*/
|
|
71
71
|
message?: string;
|
|
72
72
|
|
|
73
73
|
/**
|
|
74
|
-
* Number of hits
|
|
74
|
+
* Number of hits the search query matched.
|
|
75
75
|
*/
|
|
76
76
|
nbHits: number;
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
|
-
* Number of pages
|
|
79
|
+
* Number of pages of results for the current query.
|
|
80
80
|
*/
|
|
81
81
|
nbPages: number;
|
|
82
82
|
|
|
83
83
|
/**
|
|
84
|
-
*
|
|
84
|
+
* Number of hits selected and sorted by the relevant sort algorithm.
|
|
85
85
|
*/
|
|
86
86
|
nbSortedHits?: number;
|
|
87
87
|
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* Page to retrieve (the first page is `0`, not `1`).
|
|
90
90
|
*/
|
|
91
91
|
page: number;
|
|
92
92
|
|
|
93
93
|
/**
|
|
94
|
-
*
|
|
94
|
+
* URL-encoded string of all search parameters.
|
|
95
95
|
*/
|
|
96
96
|
params: string;
|
|
97
97
|
|
|
98
98
|
redirect?: BaseSearchResponseRedirect;
|
|
99
99
|
|
|
100
100
|
/**
|
|
101
|
-
*
|
|
101
|
+
* Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
|
|
102
102
|
*/
|
|
103
103
|
parsedQuery?: string;
|
|
104
104
|
|
|
@@ -108,17 +108,17 @@ export type BaseSearchResponse = {
|
|
|
108
108
|
processingTimeMS: number;
|
|
109
109
|
|
|
110
110
|
/**
|
|
111
|
-
*
|
|
111
|
+
* Text to search for in an index.
|
|
112
112
|
*/
|
|
113
113
|
query: string;
|
|
114
114
|
|
|
115
115
|
/**
|
|
116
|
-
*
|
|
116
|
+
* Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
|
|
117
117
|
*/
|
|
118
118
|
queryAfterRemoval?: string;
|
|
119
119
|
|
|
120
120
|
/**
|
|
121
|
-
*
|
|
121
|
+
* Host name of the server that processed the request.
|
|
122
122
|
*/
|
|
123
123
|
serverUsed?: string;
|
|
124
124
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
|
|
7
7
|
*/
|
|
8
8
|
export type BaseSearchResponseRedirect = {
|
|
9
9
|
index?: RedirectRuleIndexMetadata[];
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
*/
|
|
6
6
|
export type BatchAssignUserIdsParams = {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Cluster name.
|
|
9
9
|
*/
|
|
10
10
|
cluster: string;
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* User IDs to assign.
|
|
14
14
|
*/
|
|
15
15
|
users: string[];
|
|
16
16
|
};
|
|
@@ -3,16 +3,16 @@
|
|
|
3
3
|
import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* `batchDictionaryEntries` parameters.
|
|
7
7
|
*/
|
|
8
8
|
export type BatchDictionaryEntriesParams = {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Incidates whether to replace all custom entries in the dictionary with the ones sent with this request.
|
|
11
11
|
*/
|
|
12
12
|
clearExistingDictionaryEntries?: boolean;
|
|
13
13
|
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Operations to batch.
|
|
16
16
|
*/
|
|
17
17
|
requests: BatchDictionaryEntriesRequest[];
|
|
18
18
|
};
|