@algolia/client-search 5.0.0-alpha.11 → 5.0.0-alpha.110

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.
Files changed (519) hide show
  1. package/dist/builds/browser.d.ts +88 -5
  2. package/dist/builds/browser.d.ts.map +1 -1
  3. package/dist/builds/node.d.ts +106 -5
  4. package/dist/builds/node.d.ts.map +1 -1
  5. package/dist/{client-search.cjs.js → client-search.cjs} +2215 -1991
  6. package/dist/client-search.esm.browser.js +2403 -2242
  7. package/dist/client-search.esm.node.js +2216 -1990
  8. package/dist/client-search.umd.js +2 -2
  9. package/dist/model/acl.d.ts +4 -4
  10. package/dist/model/acl.d.ts.map +1 -1
  11. package/dist/model/action.d.ts +4 -4
  12. package/dist/model/action.d.ts.map +1 -1
  13. package/dist/model/addApiKeyResponse.d.ts +10 -10
  14. package/dist/model/addApiKeyResponse.d.ts.map +1 -1
  15. package/dist/model/advancedSyntaxFeatures.d.ts +1 -1
  16. package/dist/model/advancedSyntaxFeatures.d.ts.map +1 -1
  17. package/dist/model/alternativesAsExact.d.ts +1 -1
  18. package/dist/model/alternativesAsExact.d.ts.map +1 -1
  19. package/dist/model/anchoring.d.ts +4 -4
  20. package/dist/model/anchoring.d.ts.map +1 -1
  21. package/dist/model/apiKey.d.ts +38 -38
  22. package/dist/model/apiKey.d.ts.map +1 -1
  23. package/dist/model/apiKeyOperation.d.ts +2 -0
  24. package/dist/model/apiKeyOperation.d.ts.map +1 -0
  25. package/dist/model/aroundPrecision.d.ts +6 -0
  26. package/dist/model/aroundPrecision.d.ts.map +1 -0
  27. package/dist/model/aroundPrecisionFromValueInner.d.ts +14 -0
  28. package/dist/model/aroundPrecisionFromValueInner.d.ts.map +1 -0
  29. package/dist/model/aroundRadius.d.ts +5 -5
  30. package/dist/model/aroundRadius.d.ts.map +1 -1
  31. package/dist/model/aroundRadiusAll.d.ts +4 -1
  32. package/dist/model/aroundRadiusAll.d.ts.map +1 -1
  33. package/dist/model/assignUserIdParams.d.ts +9 -9
  34. package/dist/model/assignUserIdParams.d.ts.map +1 -1
  35. package/dist/model/attributeToUpdate.d.ts +2 -2
  36. package/dist/model/attributeToUpdate.d.ts.map +1 -1
  37. package/dist/model/automaticFacetFilter.d.ts +17 -17
  38. package/dist/model/automaticFacetFilter.d.ts.map +1 -1
  39. package/dist/model/automaticFacetFilters.d.ts +5 -5
  40. package/dist/model/automaticFacetFilters.d.ts.map +1 -1
  41. package/dist/model/baseGetApiKeyResponse.d.ts +10 -10
  42. package/dist/model/baseGetApiKeyResponse.d.ts.map +1 -1
  43. package/dist/model/baseIndexSettings.d.ts +71 -58
  44. package/dist/model/baseIndexSettings.d.ts.map +1 -1
  45. package/dist/model/baseSearchParams.d.ts +3 -3
  46. package/dist/model/baseSearchParams.d.ts.map +1 -1
  47. package/dist/model/baseSearchParamsWithoutQuery.d.ts +114 -122
  48. package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  49. package/dist/model/baseSearchResponse.d.ts +109 -101
  50. package/dist/model/baseSearchResponse.d.ts.map +1 -1
  51. package/dist/model/batchAssignUserIdsParams.d.ts +13 -13
  52. package/dist/model/batchAssignUserIdsParams.d.ts.map +1 -1
  53. package/dist/model/batchDictionaryEntriesParams.d.ts +14 -14
  54. package/dist/model/batchDictionaryEntriesParams.d.ts.map +1 -1
  55. package/dist/model/batchDictionaryEntriesRequest.d.ts +6 -6
  56. package/dist/model/batchDictionaryEntriesRequest.d.ts.map +1 -1
  57. package/dist/model/batchParams.d.ts +7 -7
  58. package/dist/model/batchParams.d.ts.map +1 -1
  59. package/dist/model/batchRequest.d.ts +8 -8
  60. package/dist/model/batchRequest.d.ts.map +1 -1
  61. package/dist/model/batchResponse.d.ts +10 -10
  62. package/dist/model/batchResponse.d.ts.map +1 -1
  63. package/dist/model/batchWriteParams.d.ts +7 -7
  64. package/dist/model/batchWriteParams.d.ts.map +1 -1
  65. package/dist/model/browseParams.d.ts +3 -3
  66. package/dist/model/browseParams.d.ts.map +1 -1
  67. package/dist/model/browseParamsObject.d.ts +3 -3
  68. package/dist/model/browseParamsObject.d.ts.map +1 -1
  69. package/dist/model/browseResponse.d.ts +4 -4
  70. package/dist/model/browseResponse.d.ts.map +1 -1
  71. package/dist/model/builtInOperation.d.ts +11 -11
  72. package/dist/model/builtInOperation.d.ts.map +1 -1
  73. package/dist/model/builtInOperationType.d.ts +4 -4
  74. package/dist/model/builtInOperationType.d.ts.map +1 -1
  75. package/dist/model/clientMethodProps.d.ts +765 -714
  76. package/dist/model/clientMethodProps.d.ts.map +1 -1
  77. package/dist/model/condition.d.ts +20 -16
  78. package/dist/model/condition.d.ts.map +1 -1
  79. package/dist/model/consequence.d.ts +25 -25
  80. package/dist/model/consequence.d.ts.map +1 -1
  81. package/dist/model/consequenceHide.d.ts +9 -9
  82. package/dist/model/consequenceHide.d.ts.map +1 -1
  83. package/dist/model/consequenceParams.d.ts +4 -4
  84. package/dist/model/consequenceParams.d.ts.map +1 -1
  85. package/dist/model/consequenceQuery.d.ts +5 -5
  86. package/dist/model/consequenceQuery.d.ts.map +1 -1
  87. package/dist/model/consequenceQueryObject.d.ts +11 -11
  88. package/dist/model/consequenceQueryObject.d.ts.map +1 -1
  89. package/dist/model/createdAtResponse.d.ts +9 -9
  90. package/dist/model/createdAtResponse.d.ts.map +1 -1
  91. package/dist/model/cursor.d.ts +6 -6
  92. package/dist/model/cursor.d.ts.map +1 -1
  93. package/dist/model/deleteApiKeyResponse.d.ts +6 -6
  94. package/dist/model/deleteApiKeyResponse.d.ts.map +1 -1
  95. package/dist/model/deleteByParams.d.ts +27 -0
  96. package/dist/model/deleteByParams.d.ts.map +1 -0
  97. package/dist/model/deleteSourceResponse.d.ts +6 -6
  98. package/dist/model/deleteSourceResponse.d.ts.map +1 -1
  99. package/dist/model/deletedAtResponse.d.ts +13 -13
  100. package/dist/model/deletedAtResponse.d.ts.map +1 -1
  101. package/dist/model/dictionaryAction.d.ts +4 -4
  102. package/dist/model/dictionaryAction.d.ts.map +1 -1
  103. package/dist/model/dictionaryEntry.d.ts +25 -27
  104. package/dist/model/dictionaryEntry.d.ts.map +1 -1
  105. package/dist/model/dictionaryEntryState.d.ts +4 -4
  106. package/dist/model/dictionaryEntryState.d.ts.map +1 -1
  107. package/dist/model/dictionaryLanguage.d.ts +9 -9
  108. package/dist/model/dictionaryLanguage.d.ts.map +1 -1
  109. package/dist/model/dictionarySettingsParams.d.ts +7 -7
  110. package/dist/model/dictionarySettingsParams.d.ts.map +1 -1
  111. package/dist/model/dictionaryType.d.ts +1 -1
  112. package/dist/model/dictionaryType.d.ts.map +1 -1
  113. package/dist/model/distinct.d.ts +4 -4
  114. package/dist/model/distinct.d.ts.map +1 -1
  115. package/dist/model/edit.d.ts +12 -12
  116. package/dist/model/edit.d.ts.map +1 -1
  117. package/dist/model/editType.d.ts +4 -4
  118. package/dist/model/editType.d.ts.map +1 -1
  119. package/dist/model/errorBase.d.ts +6 -6
  120. package/dist/model/errorBase.d.ts.map +1 -1
  121. package/dist/model/exactOnSingleWordQuery.d.ts +4 -4
  122. package/dist/model/exactOnSingleWordQuery.d.ts.map +1 -1
  123. package/dist/model/exhaustive.d.ts +26 -0
  124. package/dist/model/exhaustive.d.ts.map +1 -0
  125. package/dist/model/facetFilters.d.ts +5 -5
  126. package/dist/model/facetFilters.d.ts.map +1 -1
  127. package/dist/model/facetHits.d.ts +14 -14
  128. package/dist/model/facetHits.d.ts.map +1 -1
  129. package/dist/model/facetOrdering.d.ts +12 -12
  130. package/dist/model/facetOrdering.d.ts.map +1 -1
  131. package/dist/model/facets.d.ts +9 -9
  132. package/dist/model/facets.d.ts.map +1 -1
  133. package/dist/model/facetsStats.d.ts +18 -18
  134. package/dist/model/facetsStats.d.ts.map +1 -1
  135. package/dist/model/fetchedIndex.d.ts +46 -46
  136. package/dist/model/fetchedIndex.d.ts.map +1 -1
  137. package/dist/model/getApiKeyResponse.d.ts +3 -3
  138. package/dist/model/getApiKeyResponse.d.ts.map +1 -1
  139. package/dist/model/getDictionarySettingsResponse.d.ts +4 -4
  140. package/dist/model/getDictionarySettingsResponse.d.ts.map +1 -1
  141. package/dist/model/getLogsResponse.d.ts +4 -4
  142. package/dist/model/getLogsResponse.d.ts.map +1 -1
  143. package/dist/model/getObjectsParams.d.ts +7 -7
  144. package/dist/model/getObjectsParams.d.ts.map +1 -1
  145. package/dist/model/getObjectsRequest.d.ts +17 -17
  146. package/dist/model/getObjectsRequest.d.ts.map +1 -1
  147. package/dist/model/getObjectsResponse.d.ts +6 -6
  148. package/dist/model/getObjectsResponse.d.ts.map +1 -1
  149. package/dist/model/getTaskResponse.d.ts +4 -4
  150. package/dist/model/getTaskResponse.d.ts.map +1 -1
  151. package/dist/model/getTopUserIdsResponse.d.ts +10 -10
  152. package/dist/model/getTopUserIdsResponse.d.ts.map +1 -1
  153. package/dist/model/hasPendingMappingsResponse.d.ts +10 -10
  154. package/dist/model/hasPendingMappingsResponse.d.ts.map +1 -1
  155. package/dist/model/highlightResult.d.ts +2 -2
  156. package/dist/model/highlightResult.d.ts.map +1 -1
  157. package/dist/model/highlightResultOption.d.ts +19 -19
  158. package/dist/model/highlightResultOption.d.ts.map +1 -1
  159. package/dist/model/hit.d.ts +22 -22
  160. package/dist/model/hit.d.ts.map +1 -1
  161. package/dist/model/ignorePlurals.d.ts +5 -4
  162. package/dist/model/ignorePlurals.d.ts.map +1 -1
  163. package/dist/model/index.d.ts +167 -154
  164. package/dist/model/index.d.ts.map +1 -1
  165. package/dist/model/indexSettings.d.ts +6 -6
  166. package/dist/model/indexSettings.d.ts.map +1 -1
  167. package/dist/model/indexSettingsAsSearchParams.d.ts +159 -160
  168. package/dist/model/indexSettingsAsSearchParams.d.ts.map +1 -1
  169. package/dist/model/languages.d.ts +9 -9
  170. package/dist/model/languages.d.ts.map +1 -1
  171. package/dist/model/listApiKeysResponse.d.ts +7 -7
  172. package/dist/model/listApiKeysResponse.d.ts.map +1 -1
  173. package/dist/model/listClustersResponse.d.ts +9 -9
  174. package/dist/model/listClustersResponse.d.ts.map +1 -1
  175. package/dist/model/listIndicesResponse.d.ts +11 -11
  176. package/dist/model/listIndicesResponse.d.ts.map +1 -1
  177. package/dist/model/listUserIdsResponse.d.ts +10 -10
  178. package/dist/model/listUserIdsResponse.d.ts.map +1 -1
  179. package/dist/model/log.d.ts +63 -63
  180. package/dist/model/log.d.ts.map +1 -1
  181. package/dist/model/logQuery.d.ts +14 -14
  182. package/dist/model/logQuery.d.ts.map +1 -1
  183. package/dist/model/logType.d.ts +1 -1
  184. package/dist/model/logType.d.ts.map +1 -1
  185. package/dist/model/matchLevel.d.ts +4 -4
  186. package/dist/model/matchLevel.d.ts.map +1 -1
  187. package/dist/model/matchedGeoLocation.d.ts +14 -14
  188. package/dist/model/matchedGeoLocation.d.ts.map +1 -1
  189. package/dist/model/mixedSearchFilters.d.ts +1 -1
  190. package/dist/model/mixedSearchFilters.d.ts.map +1 -1
  191. package/dist/model/mode.d.ts +5 -0
  192. package/dist/model/mode.d.ts.map +1 -0
  193. package/dist/model/multipleBatchRequest.d.ts +12 -12
  194. package/dist/model/multipleBatchRequest.d.ts.map +1 -1
  195. package/dist/model/multipleBatchResponse.d.ts +10 -10
  196. package/dist/model/multipleBatchResponse.d.ts.map +1 -1
  197. package/dist/model/numericFilters.d.ts +5 -5
  198. package/dist/model/numericFilters.d.ts.map +1 -1
  199. package/dist/model/operationIndexParams.d.ts +13 -13
  200. package/dist/model/operationIndexParams.d.ts.map +1 -1
  201. package/dist/model/operationType.d.ts +4 -4
  202. package/dist/model/operationType.d.ts.map +1 -1
  203. package/dist/model/optionalFilters.d.ts +5 -5
  204. package/dist/model/optionalFilters.d.ts.map +1 -1
  205. package/dist/model/params.d.ts +12 -12
  206. package/dist/model/params.d.ts.map +1 -1
  207. package/dist/model/personalization.d.ts +14 -14
  208. package/dist/model/personalization.d.ts.map +1 -1
  209. package/dist/model/promote.d.ts +3 -3
  210. package/dist/model/promote.d.ts.map +1 -1
  211. package/dist/model/promoteObjectID.d.ts +13 -13
  212. package/dist/model/promoteObjectID.d.ts.map +1 -1
  213. package/dist/model/promoteObjectIDs.d.ts +13 -13
  214. package/dist/model/promoteObjectIDs.d.ts.map +1 -1
  215. package/dist/model/queryType.d.ts +4 -4
  216. package/dist/model/queryType.d.ts.map +1 -1
  217. package/dist/model/rankingInfo.d.ts +53 -50
  218. package/dist/model/rankingInfo.d.ts.map +1 -1
  219. package/dist/model/reRankingApplyFilter.d.ts +5 -5
  220. package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
  221. package/dist/model/redirect.d.ts +8 -0
  222. package/dist/model/redirect.d.ts.map +1 -0
  223. package/dist/model/redirectRuleIndexMetadata.d.ts +21 -0
  224. package/dist/model/redirectRuleIndexMetadata.d.ts.map +1 -0
  225. package/dist/model/redirectRuleIndexMetadataData.d.ts +7 -0
  226. package/dist/model/redirectRuleIndexMetadataData.d.ts.map +1 -0
  227. package/dist/model/removeStopWords.d.ts +5 -4
  228. package/dist/model/removeStopWords.d.ts.map +1 -1
  229. package/dist/model/removeUserIdResponse.d.ts +6 -6
  230. package/dist/model/removeUserIdResponse.d.ts.map +1 -1
  231. package/dist/model/removeWordsIfNoResults.d.ts +4 -4
  232. package/dist/model/removeWordsIfNoResults.d.ts.map +1 -1
  233. package/dist/model/renderingContent.d.ts +7 -7
  234. package/dist/model/renderingContent.d.ts.map +1 -1
  235. package/dist/model/replaceSourceResponse.d.ts +6 -6
  236. package/dist/model/replaceSourceResponse.d.ts.map +1 -1
  237. package/dist/model/rule.d.ts +29 -29
  238. package/dist/model/rule.d.ts.map +1 -1
  239. package/dist/model/saveObjectResponse.d.ts +14 -11
  240. package/dist/model/saveObjectResponse.d.ts.map +1 -1
  241. package/dist/model/saveSynonymResponse.d.ts +14 -14
  242. package/dist/model/saveSynonymResponse.d.ts.map +1 -1
  243. package/dist/model/scopeType.d.ts +1 -1
  244. package/dist/model/scopeType.d.ts.map +1 -1
  245. package/dist/model/searchDictionaryEntriesParams.d.ts +19 -21
  246. package/dist/model/searchDictionaryEntriesParams.d.ts.map +1 -1
  247. package/dist/model/searchDictionaryEntriesResponse.d.ts +20 -0
  248. package/dist/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
  249. package/dist/model/searchForFacetValuesRequest.d.ts +14 -14
  250. package/dist/model/searchForFacetValuesRequest.d.ts.map +1 -1
  251. package/dist/model/searchForFacetValuesResponse.d.ts +15 -4
  252. package/dist/model/searchForFacetValuesResponse.d.ts.map +1 -1
  253. package/dist/model/searchForFacets.d.ts +3 -3
  254. package/dist/model/searchForFacets.d.ts.map +1 -1
  255. package/dist/model/searchForFacetsOptions.d.ts +20 -20
  256. package/dist/model/searchForFacetsOptions.d.ts.map +1 -1
  257. package/dist/model/searchForHits.d.ts +3 -3
  258. package/dist/model/searchForHits.d.ts.map +1 -1
  259. package/dist/model/searchForHitsOptions.d.ts +12 -12
  260. package/dist/model/searchForHitsOptions.d.ts.map +1 -1
  261. package/dist/model/searchHits.d.ts +15 -4
  262. package/dist/model/searchHits.d.ts.map +1 -1
  263. package/dist/model/searchMethodParams.d.ts +6 -6
  264. package/dist/model/searchMethodParams.d.ts.map +1 -1
  265. package/dist/model/searchParams.d.ts +3 -3
  266. package/dist/model/searchParams.d.ts.map +1 -1
  267. package/dist/model/searchParamsObject.d.ts +3 -3
  268. package/dist/model/searchParamsObject.d.ts.map +1 -1
  269. package/dist/model/searchParamsQuery.d.ts +6 -6
  270. package/dist/model/searchParamsQuery.d.ts.map +1 -1
  271. package/dist/model/searchParamsString.d.ts +6 -6
  272. package/dist/model/searchParamsString.d.ts.map +1 -1
  273. package/dist/model/searchQuery.d.ts +3 -3
  274. package/dist/model/searchQuery.d.ts.map +1 -1
  275. package/dist/model/searchResponse.d.ts +3 -3
  276. package/dist/model/searchResponse.d.ts.map +1 -1
  277. package/dist/model/searchResponses.d.ts +4 -4
  278. package/dist/model/searchResponses.d.ts.map +1 -1
  279. package/dist/model/searchResult.d.ts +4 -0
  280. package/dist/model/searchResult.d.ts.map +1 -0
  281. package/dist/model/searchRulesParams.d.ts +27 -31
  282. package/dist/model/searchRulesParams.d.ts.map +1 -1
  283. package/dist/model/searchRulesResponse.d.ts +19 -19
  284. package/dist/model/searchRulesResponse.d.ts.map +1 -1
  285. package/dist/model/searchStrategy.d.ts +4 -1
  286. package/dist/model/searchStrategy.d.ts.map +1 -1
  287. package/dist/model/searchSynonymsParams.d.ts +16 -6
  288. package/dist/model/searchSynonymsParams.d.ts.map +1 -1
  289. package/dist/model/searchSynonymsResponse.d.ts +11 -11
  290. package/dist/model/searchSynonymsResponse.d.ts.map +1 -1
  291. package/dist/model/searchTypeDefault.d.ts +4 -4
  292. package/dist/model/searchTypeDefault.d.ts.map +1 -1
  293. package/dist/model/searchTypeFacet.d.ts +4 -4
  294. package/dist/model/searchTypeFacet.d.ts.map +1 -1
  295. package/dist/model/searchUserIdsParams.d.ts +21 -21
  296. package/dist/model/searchUserIdsParams.d.ts.map +1 -1
  297. package/dist/model/searchUserIdsResponse.d.ts +26 -26
  298. package/dist/model/searchUserIdsResponse.d.ts.map +1 -1
  299. package/dist/model/securedAPIKeyRestrictions.d.ts +25 -0
  300. package/dist/model/securedAPIKeyRestrictions.d.ts.map +1 -0
  301. package/dist/model/semanticSearch.d.ts +10 -0
  302. package/dist/model/semanticSearch.d.ts.map +1 -0
  303. package/dist/model/snippetResult.d.ts +2 -2
  304. package/dist/model/snippetResult.d.ts.map +1 -1
  305. package/dist/model/snippetResultOption.d.ts +11 -11
  306. package/dist/model/snippetResultOption.d.ts.map +1 -1
  307. package/dist/model/sortRemainingBy.d.ts +4 -4
  308. package/dist/model/sortRemainingBy.d.ts.map +1 -1
  309. package/dist/model/source.d.ts +13 -13
  310. package/dist/model/source.d.ts.map +1 -1
  311. package/dist/model/standardEntries.d.ts +17 -17
  312. package/dist/model/standardEntries.d.ts.map +1 -1
  313. package/dist/model/supportedLanguage.d.ts +5 -0
  314. package/dist/model/supportedLanguage.d.ts.map +1 -0
  315. package/dist/model/synonymHit.d.ts +35 -37
  316. package/dist/model/synonymHit.d.ts.map +1 -1
  317. package/dist/model/synonymType.d.ts +4 -4
  318. package/dist/model/synonymType.d.ts.map +1 -1
  319. package/dist/model/tagFilters.d.ts +5 -5
  320. package/dist/model/tagFilters.d.ts.map +1 -1
  321. package/dist/model/taskStatus.d.ts +4 -1
  322. package/dist/model/taskStatus.d.ts.map +1 -1
  323. package/dist/model/timeRange.d.ts +10 -10
  324. package/dist/model/timeRange.d.ts.map +1 -1
  325. package/dist/model/typoTolerance.d.ts +5 -5
  326. package/dist/model/typoTolerance.d.ts.map +1 -1
  327. package/dist/model/typoToleranceEnum.d.ts +4 -1
  328. package/dist/model/typoToleranceEnum.d.ts.map +1 -1
  329. package/dist/model/updateApiKeyResponse.d.ts +10 -10
  330. package/dist/model/updateApiKeyResponse.d.ts.map +1 -1
  331. package/dist/model/updatedAtResponse.d.ts +13 -13
  332. package/dist/model/updatedAtResponse.d.ts.map +1 -1
  333. package/dist/model/updatedAtWithObjectIdResponse.d.ts +17 -17
  334. package/dist/model/updatedAtWithObjectIdResponse.d.ts.map +1 -1
  335. package/dist/model/updatedRuleResponse.d.ts +14 -14
  336. package/dist/model/updatedRuleResponse.d.ts.map +1 -1
  337. package/dist/model/userHighlightResult.d.ts +5 -11
  338. package/dist/model/userHighlightResult.d.ts.map +1 -1
  339. package/dist/model/userHit.d.ts +24 -24
  340. package/dist/model/userHit.d.ts.map +1 -1
  341. package/dist/model/userId.d.ts +21 -21
  342. package/dist/model/userId.d.ts.map +1 -1
  343. package/dist/model/value.d.ts +8 -8
  344. package/dist/model/value.d.ts.map +1 -1
  345. package/dist/src/searchClient.d.ts +866 -723
  346. package/dist/src/searchClient.d.ts.map +1 -1
  347. package/index.js +1 -1
  348. package/model/acl.ts +3 -2
  349. package/model/action.ts +2 -2
  350. package/model/addApiKeyResponse.ts +3 -3
  351. package/model/advancedSyntaxFeatures.ts +1 -1
  352. package/model/alternativesAsExact.ts +1 -1
  353. package/model/anchoring.ts +2 -2
  354. package/model/apiKey.ts +10 -10
  355. package/model/apiKeyOperation.ts +3 -0
  356. package/model/aroundPrecision.ts +8 -0
  357. package/model/aroundPrecisionFromValueInner.ts +16 -0
  358. package/model/aroundRadius.ts +2 -2
  359. package/model/aroundRadiusAll.ts +4 -1
  360. package/model/assignUserIdParams.ts +2 -2
  361. package/model/attributeToUpdate.ts +1 -1
  362. package/model/automaticFacetFilter.ts +5 -5
  363. package/model/automaticFacetFilters.ts +2 -2
  364. package/model/baseGetApiKeyResponse.ts +3 -3
  365. package/model/baseIndexSettings.ts +34 -17
  366. package/model/baseSearchParams.ts +1 -1
  367. package/model/baseSearchParamsWithoutQuery.ts +36 -46
  368. package/model/baseSearchResponse.ts +42 -31
  369. package/model/batchAssignUserIdsParams.ts +3 -3
  370. package/model/batchDictionaryEntriesParams.ts +4 -4
  371. package/model/batchDictionaryEntriesRequest.ts +1 -1
  372. package/model/batchParams.ts +2 -2
  373. package/model/batchRequest.ts +2 -2
  374. package/model/batchResponse.ts +3 -3
  375. package/model/batchWriteParams.ts +2 -2
  376. package/model/browseParams.ts +1 -1
  377. package/model/browseParamsObject.ts +1 -1
  378. package/model/browseResponse.ts +1 -1
  379. package/model/builtInOperation.ts +3 -3
  380. package/model/builtInOperationType.ts +2 -2
  381. package/model/clientMethodProps.ts +218 -156
  382. package/model/condition.ts +9 -4
  383. package/model/consequence.ts +7 -7
  384. package/model/consequenceHide.ts +3 -3
  385. package/model/consequenceParams.ts +1 -1
  386. package/model/consequenceQuery.ts +2 -2
  387. package/model/consequenceQueryObject.ts +3 -3
  388. package/model/createdAtResponse.ts +3 -3
  389. package/model/cursor.ts +2 -2
  390. package/model/deleteApiKeyResponse.ts +2 -2
  391. package/model/deleteByParams.ts +36 -0
  392. package/model/deleteSourceResponse.ts +2 -2
  393. package/model/deletedAtResponse.ts +4 -4
  394. package/model/dictionaryAction.ts +1 -1
  395. package/model/dictionaryEntry.ts +8 -10
  396. package/model/dictionaryEntryState.ts +2 -2
  397. package/model/dictionaryLanguage.ts +4 -4
  398. package/model/dictionarySettingsParams.ts +2 -2
  399. package/model/dictionaryType.ts +1 -1
  400. package/model/distinct.ts +2 -2
  401. package/model/edit.ts +2 -2
  402. package/model/editType.ts +1 -1
  403. package/model/errorBase.ts +1 -1
  404. package/model/exactOnSingleWordQuery.ts +2 -2
  405. package/model/exhaustive.ts +31 -0
  406. package/model/facetFilters.ts +2 -2
  407. package/model/facetHits.ts +4 -4
  408. package/model/facetOrdering.ts +3 -3
  409. package/model/facets.ts +3 -3
  410. package/model/facetsStats.ts +5 -5
  411. package/model/fetchedIndex.ts +3 -3
  412. package/model/getApiKeyResponse.ts +1 -1
  413. package/model/getDictionarySettingsResponse.ts +1 -1
  414. package/model/getLogsResponse.ts +1 -1
  415. package/model/getObjectsParams.ts +2 -2
  416. package/model/getObjectsRequest.ts +5 -5
  417. package/model/getObjectsResponse.ts +2 -2
  418. package/model/getTaskResponse.ts +1 -1
  419. package/model/getTopUserIdsResponse.ts +3 -3
  420. package/model/hasPendingMappingsResponse.ts +3 -3
  421. package/model/highlightResult.ts +5 -2
  422. package/model/highlightResultOption.ts +4 -4
  423. package/model/hit.ts +5 -5
  424. package/model/ignorePlurals.ts +5 -3
  425. package/model/index.ts +15 -2
  426. package/model/indexSettings.ts +2 -2
  427. package/model/indexSettingsAsSearchParams.ts +54 -54
  428. package/model/languages.ts +2 -2
  429. package/model/listApiKeysResponse.ts +2 -2
  430. package/model/listClustersResponse.ts +3 -3
  431. package/model/listIndicesResponse.ts +2 -2
  432. package/model/listUserIdsResponse.ts +3 -3
  433. package/model/log.ts +13 -13
  434. package/model/logQuery.ts +3 -3
  435. package/model/logType.ts +1 -1
  436. package/model/matchLevel.ts +2 -2
  437. package/model/matchedGeoLocation.ts +1 -1
  438. package/model/mixedSearchFilters.ts +1 -1
  439. package/model/mode.ts +6 -0
  440. package/model/multipleBatchRequest.ts +2 -2
  441. package/model/multipleBatchResponse.ts +3 -3
  442. package/model/numericFilters.ts +2 -2
  443. package/model/operationIndexParams.ts +3 -3
  444. package/model/operationType.ts +2 -2
  445. package/model/optionalFilters.ts +2 -2
  446. package/model/params.ts +2 -2
  447. package/model/personalization.ts +1 -1
  448. package/model/promote.ts +1 -1
  449. package/model/promoteObjectID.ts +4 -4
  450. package/model/promoteObjectIDs.ts +4 -4
  451. package/model/queryType.ts +2 -2
  452. package/model/rankingInfo.ts +11 -8
  453. package/model/reRankingApplyFilter.ts +2 -2
  454. package/model/redirect.ts +10 -0
  455. package/model/redirectRuleIndexMetadata.ts +27 -0
  456. package/model/redirectRuleIndexMetadataData.ts +8 -0
  457. package/model/removeStopWords.ts +5 -3
  458. package/model/removeUserIdResponse.ts +2 -2
  459. package/model/removeWordsIfNoResults.ts +2 -2
  460. package/model/renderingContent.ts +2 -2
  461. package/model/replaceSourceResponse.ts +2 -2
  462. package/model/rule.ts +6 -6
  463. package/model/saveObjectResponse.ts +6 -3
  464. package/model/saveSynonymResponse.ts +4 -4
  465. package/model/scopeType.ts +1 -1
  466. package/model/searchDictionaryEntriesParams.ts +8 -9
  467. package/model/searchDictionaryEntriesResponse.ts +25 -0
  468. package/model/searchForFacetValuesRequest.ts +3 -3
  469. package/model/searchForFacetValuesResponse.ts +14 -1
  470. package/model/searchForFacets.ts +1 -1
  471. package/model/searchForFacetsOptions.ts +4 -4
  472. package/model/searchForHits.ts +1 -1
  473. package/model/searchForHitsOptions.ts +2 -2
  474. package/model/searchHits.ts +15 -2
  475. package/model/searchMethodParams.ts +1 -1
  476. package/model/searchParams.ts +1 -1
  477. package/model/searchParamsObject.ts +1 -1
  478. package/model/searchParamsQuery.ts +2 -2
  479. package/model/searchParamsString.ts +2 -2
  480. package/model/searchQuery.ts +1 -1
  481. package/model/searchResponse.ts +1 -1
  482. package/model/searchResponses.ts +3 -3
  483. package/model/searchResult.ts +8 -0
  484. package/model/searchRulesParams.ts +8 -13
  485. package/model/searchRulesResponse.ts +3 -3
  486. package/model/searchStrategy.ts +4 -1
  487. package/model/searchSynonymsParams.ts +16 -2
  488. package/model/searchSynonymsResponse.ts +3 -3
  489. package/model/searchTypeDefault.ts +2 -2
  490. package/model/searchTypeFacet.ts +2 -2
  491. package/model/searchUserIdsParams.ts +5 -5
  492. package/model/searchUserIdsResponse.ts +6 -6
  493. package/model/securedAPIKeyRestrictions.ts +32 -0
  494. package/model/semanticSearch.ts +11 -0
  495. package/model/snippetResult.ts +5 -2
  496. package/model/snippetResultOption.ts +3 -3
  497. package/model/sortRemainingBy.ts +2 -2
  498. package/model/source.ts +4 -4
  499. package/model/standardEntries.ts +5 -5
  500. package/model/supportedLanguage.ts +74 -0
  501. package/model/synonymHit.ts +7 -10
  502. package/model/synonymType.ts +2 -2
  503. package/model/tagFilters.ts +2 -2
  504. package/model/taskStatus.ts +4 -1
  505. package/model/timeRange.ts +3 -3
  506. package/model/typoTolerance.ts +2 -2
  507. package/model/typoToleranceEnum.ts +4 -1
  508. package/model/updateApiKeyResponse.ts +3 -3
  509. package/model/updatedAtResponse.ts +4 -4
  510. package/model/updatedAtWithObjectIdResponse.ts +5 -5
  511. package/model/updatedRuleResponse.ts +4 -4
  512. package/model/userHighlightResult.ts +3 -9
  513. package/model/userHit.ts +3 -3
  514. package/model/userId.ts +4 -4
  515. package/model/value.ts +2 -2
  516. package/package.json +10 -9
  517. package/dist/model/synonymHitHighlightResult.d.ts +0 -12
  518. package/dist/model/synonymHitHighlightResult.d.ts.map +0 -1
  519. package/model/synonymHitHighlightResult.ts +0 -15
@@ -1,6 +1,89 @@
1
- import type { ClientOptions } from '@algolia/client-common';
2
- import type { SearchClient } from '../src/searchClient';
3
- export { apiClientVersion, SearchClient } from '../src/searchClient';
4
- export * from '../model';
5
- export declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): SearchClient;
1
+ import type { ClientOptions } from '@algolia/client-common';
2
+ export { apiClientVersion } from '../src/searchClient';
3
+ export * from '../model';
4
+ /**
5
+ * The client type.
6
+ */
7
+ export type SearchClient = ReturnType<typeof searchClient>;
8
+ export declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): {
9
+ transporter: import("@algolia/client-common").Transporter;
10
+ appId: string;
11
+ clearCache(): Promise<void>;
12
+ readonly _ua: string;
13
+ addAlgoliaAgent(segment: string, version?: string | undefined): void;
14
+ waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
15
+ waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-common").ApiError | import("../model").GetApiKeyResponse>;
16
+ browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "aggregator">> & import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T>>;
17
+ browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "aggregator">> & import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
18
+ browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "aggregator">> & import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
19
+ searchForHits<T_1>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
20
+ results: import("../model").SearchResponse<T_1>[];
21
+ }>;
22
+ searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
23
+ results: import("../model").SearchForFacetValuesResponse[];
24
+ }>;
25
+ chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse[]>;
26
+ replaceAllObjects({ indexName, objects, batchSize }: import("../model").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceAllObjectsResponse>;
27
+ addApiKey(apiKey: import("../model").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
28
+ addOrUpdateObject({ indexName, objectID, body }: import("../model").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
29
+ appendSource(source: import("../model").Source, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
30
+ assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("../model").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
31
+ batch({ indexName, batchWriteParams }: import("../model").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse>;
32
+ batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("../model").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
33
+ batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("../model").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
34
+ browse<T_2>({ indexName, browseParams }: import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T_2>>;
35
+ clearObjects({ indexName }: import("../model").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
36
+ clearRules({ indexName, forwardToReplicas }: import("../model").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
37
+ clearSynonyms({ indexName, forwardToReplicas }: import("../model").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
38
+ customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
39
+ customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
40
+ customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
41
+ customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
42
+ deleteApiKey({ key }: import("../model").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteApiKeyResponse>;
43
+ deleteBy({ indexName, deleteByParams }: import("../model").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
44
+ deleteIndex({ indexName }: import("../model").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
45
+ deleteObject({ indexName, objectID }: import("../model").DeleteObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
46
+ deleteRule({ indexName, objectID, forwardToReplicas }: import("../model").DeleteRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
47
+ deleteSource({ source }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteSourceResponse>;
48
+ deleteSynonym({ indexName, objectID, forwardToReplicas }: import("../model").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
49
+ getApiKey({ key }: import("../model").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetApiKeyResponse>;
50
+ getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, import("../model").Languages>>;
51
+ getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetDictionarySettingsResponse>;
52
+ getLogs({ offset, length, indexName, type }?: import("../model").GetLogsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetLogsResponse>;
53
+ getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, string>>;
54
+ getObjects<T_3>(getObjectsParams: import("../model").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetObjectsResponse<T_3>>;
55
+ getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Rule>;
56
+ getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").IndexSettings>;
57
+ getSources(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Source[]>;
58
+ getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SynonymHit>;
59
+ getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
60
+ getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTopUserIdsResponse>;
61
+ getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UserId>;
62
+ hasPendingMappings({ getClusters }?: import("../model").HasPendingMappingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").HasPendingMappingsResponse>;
63
+ listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListApiKeysResponse>;
64
+ listClusters(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListClustersResponse>;
65
+ listIndices({ page, hitsPerPage }?: import("../model").ListIndicesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListIndicesResponse>;
66
+ listUserIds({ page, hitsPerPage }?: import("../model").ListUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListUserIdsResponse>;
67
+ multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").MultipleBatchResponse>;
68
+ operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
69
+ partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
70
+ removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RemoveUserIdResponse>;
71
+ replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceSourceResponse>;
72
+ restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
73
+ saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveObjectResponse>;
74
+ saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedRuleResponse>;
75
+ saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
76
+ saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveSynonymResponse>;
77
+ saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
78
+ search<T_4>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponses<T_4>>;
79
+ searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchDictionaryEntriesResponse>;
80
+ searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchForFacetValuesResponse>;
81
+ searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
82
+ searchSingleIndex<T_5>({ indexName, searchParams }: import("../model").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponse<T_5>>;
83
+ searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
84
+ searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchUserIdsResponse>;
85
+ setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
86
+ setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
87
+ updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdateApiKeyResponse>;
88
+ };
6
89
  //# sourceMappingURL=browser.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAY5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,cAAc,UAAU,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,YAAY,CA8Bd"}
1
+ {"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAa5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+BxB"}
@@ -1,6 +1,107 @@
1
- import type { ClientOptions } from '@algolia/client-common';
2
- import type { SearchClient } from '../src/searchClient';
3
- export { apiClientVersion, SearchClient } from '../src/searchClient';
4
- export * from '../model';
5
- export declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): SearchClient;
1
+ import type { ClientOptions } from '@algolia/client-common';
2
+ import type { GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from '../model';
3
+ export { apiClientVersion } from '../src/searchClient';
4
+ export * from '../model';
5
+ /**
6
+ * The client type.
7
+ */
8
+ export type SearchClient = ReturnType<typeof searchClient>;
9
+ export declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): {
10
+ /**
11
+ * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
12
+ *
13
+ * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
14
+ * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
15
+ * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
16
+ * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
17
+ */
18
+ generateSecuredApiKey({ parentApiKey, restrictions, }: GenerateSecuredApiKeyOptions): string;
19
+ /**
20
+ * Helper: Retrieves the remaining validity of the previous generated `securedApiKey`, the `ValidUntil` parameter must have been provided.
21
+ *
22
+ * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
23
+ * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
24
+ * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
25
+ */
26
+ getSecuredApiKeyRemainingValidity({ securedApiKey, }: GetSecuredApiKeyRemainingValidityOptions): number;
27
+ transporter: import("@algolia/client-common").Transporter;
28
+ appId: string;
29
+ clearCache(): Promise<void>;
30
+ _ua: string;
31
+ addAlgoliaAgent(segment: string, version?: string | undefined): void;
32
+ waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
33
+ waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-common").ApiError | import("../model").GetApiKeyResponse>;
34
+ browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "aggregator">> & import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T>>;
35
+ browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "aggregator">> & import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
36
+ browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "aggregator">> & import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
37
+ searchForHits<T_1>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
38
+ results: import("../model").SearchResponse<T_1>[];
39
+ }>;
40
+ searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
41
+ results: import("../model").SearchForFacetValuesResponse[];
42
+ }>;
43
+ chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse[]>;
44
+ replaceAllObjects({ indexName, objects, batchSize }: import("../model").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceAllObjectsResponse>;
45
+ addApiKey(apiKey: import("../model").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
46
+ addOrUpdateObject({ indexName, objectID, body }: import("../model").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
47
+ appendSource(source: import("../model").Source, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
48
+ assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("../model").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
49
+ batch({ indexName, batchWriteParams }: import("../model").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse>;
50
+ batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("../model").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
51
+ batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("../model").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
52
+ browse<T_2>({ indexName, browseParams }: import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T_2>>;
53
+ clearObjects({ indexName }: import("../model").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
54
+ clearRules({ indexName, forwardToReplicas }: import("../model").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
55
+ clearSynonyms({ indexName, forwardToReplicas }: import("../model").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
56
+ customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
57
+ customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
58
+ customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
59
+ customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
60
+ deleteApiKey({ key }: import("../model").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteApiKeyResponse>;
61
+ deleteBy({ indexName, deleteByParams }: import("../model").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
62
+ deleteIndex({ indexName }: import("../model").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
63
+ deleteObject({ indexName, objectID }: import("../model").DeleteObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
64
+ deleteRule({ indexName, objectID, forwardToReplicas }: import("../model").DeleteRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
65
+ deleteSource({ source }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteSourceResponse>;
66
+ deleteSynonym({ indexName, objectID, forwardToReplicas }: import("../model").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
67
+ getApiKey({ key }: import("../model").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetApiKeyResponse>;
68
+ getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, import("../model").Languages>>;
69
+ getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetDictionarySettingsResponse>;
70
+ getLogs({ offset, length, indexName, type }?: import("../model").GetLogsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetLogsResponse>;
71
+ getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, string>>;
72
+ getObjects<T_3>(getObjectsParams: import("../model").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetObjectsResponse<T_3>>;
73
+ getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Rule>;
74
+ getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").IndexSettings>;
75
+ getSources(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Source[]>;
76
+ getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SynonymHit>;
77
+ getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
78
+ getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTopUserIdsResponse>;
79
+ getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UserId>;
80
+ hasPendingMappings({ getClusters }?: import("../model").HasPendingMappingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").HasPendingMappingsResponse>;
81
+ listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListApiKeysResponse>;
82
+ listClusters(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListClustersResponse>;
83
+ listIndices({ page, hitsPerPage }?: import("../model").ListIndicesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListIndicesResponse>;
84
+ listUserIds({ page, hitsPerPage }?: import("../model").ListUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListUserIdsResponse>;
85
+ multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").MultipleBatchResponse>;
86
+ operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
87
+ partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
88
+ removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RemoveUserIdResponse>;
89
+ replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceSourceResponse>;
90
+ restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
91
+ saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveObjectResponse>;
92
+ saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedRuleResponse>;
93
+ saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
94
+ saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveSynonymResponse>;
95
+ saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
96
+ search<T_4>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponses<T_4>>;
97
+ searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchDictionaryEntriesResponse>;
98
+ searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchForFacetValuesResponse>;
99
+ searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
100
+ searchSingleIndex<T_5>({ indexName, searchParams }: import("../model").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponse<T_5>>;
101
+ searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
102
+ searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchUserIdsResponse>;
103
+ setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
104
+ setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
105
+ updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdateApiKeyResponse>;
106
+ };
6
107
  //# sourceMappingURL=node.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,cAAc,UAAU,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,YAAY,CAwBd"}
1
+ {"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EACV,4BAA4B,EAC5B,wCAAwC,EACzC,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;IA2BrB;;;;;;;OAOG;2DAIA,4BAA4B,GAAG,MAAM;IASxC;;;;;;OAMG;0DAGA,wCAAwC,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcvD"}