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

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,102 +1,110 @@
1
- import type { FacetsStats } from './facetsStats';
2
- import type { RenderingContent } from './renderingContent';
3
- export declare type BaseSearchResponse = {
4
- /**
5
- * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
6
- */
7
- abTestID?: number;
8
- /**
9
- * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
10
- */
11
- abTestVariantID?: number;
12
- /**
13
- * The computed geo location.
14
- */
15
- aroundLatLng?: string;
16
- /**
17
- * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
18
- */
19
- automaticRadius?: string;
20
- /**
21
- * Whether the facet count is exhaustive or approximate.
22
- */
23
- exhaustiveFacetsCount?: boolean;
24
- /**
25
- * Indicate if the nbHits count was exhaustive or approximate.
26
- */
27
- exhaustiveNbHits: boolean;
28
- /**
29
- * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
30
- */
31
- exhaustiveTypo?: boolean;
32
- /**
33
- * A mapping of each facet name to the corresponding facet counts.
34
- */
35
- facets?: Record<string, Record<string, number>>;
36
- /**
37
- * Statistics for numerical facets.
38
- */
39
- facets_stats?: Record<string, FacetsStats>;
40
- /**
41
- * Set the number of hits per page.
42
- */
43
- hitsPerPage: number;
44
- /**
45
- * Index name used for the query.
46
- */
47
- index?: string;
48
- /**
49
- * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
50
- */
51
- indexUsed?: string;
52
- /**
53
- * Used to return warnings about the query.
54
- */
55
- message?: string;
56
- /**
57
- * Number of hits that the search query matched.
58
- */
59
- nbHits: number;
60
- /**
61
- * Number of pages available for the current query.
62
- */
63
- nbPages: number;
64
- /**
65
- * The number of hits selected and sorted by the relevant sort algorithm.
66
- */
67
- nbSortedHits?: number;
68
- /**
69
- * Specify the page to retrieve.
70
- */
71
- page: number;
72
- /**
73
- * A url-encoded string of all search parameters.
74
- */
75
- params: string;
76
- /**
77
- * The query string that will be searched, after normalization.
78
- */
79
- parsedQuery?: string;
80
- /**
81
- * Time the server took to process the request, in milliseconds.
82
- */
83
- processingTimeMS: number;
84
- /**
85
- * The text to search in the index.
86
- */
87
- query: string;
88
- /**
89
- * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
90
- */
91
- queryAfterRemoval?: string;
92
- /**
93
- * Actual host name of the server that processed the request.
94
- */
95
- serverUsed?: string;
96
- /**
97
- * Lets you store custom data in your indices.
98
- */
99
- userData?: Record<string, any>;
100
- renderingContent?: RenderingContent;
101
- };
1
+ import type { Exhaustive } from './exhaustive';
2
+ import type { FacetsStats } from './facetsStats';
3
+ import type { Redirect } from './redirect';
4
+ import type { RenderingContent } from './renderingContent';
5
+ export type BaseSearchResponse = Record<string, any> & {
6
+ /**
7
+ * A/B test ID. This is only included in the response for indices that are part of an A/B test.
8
+ */
9
+ abTestID?: number;
10
+ /**
11
+ * Variant ID. This is only included in the response for indices that are part of an A/B test.
12
+ */
13
+ abTestVariantID?: number;
14
+ /**
15
+ * Computed geographical location.
16
+ */
17
+ aroundLatLng?: string;
18
+ /**
19
+ * Distance from a central coordinate provided by `aroundLatLng`.
20
+ */
21
+ automaticRadius?: string;
22
+ exhaustive?: Exhaustive;
23
+ /**
24
+ * See the `facetsCount` field of the `exhaustive` object in the response.
25
+ */
26
+ exhaustiveFacetsCount?: boolean;
27
+ /**
28
+ * See the `nbHits` field of the `exhaustive` object in the response.
29
+ */
30
+ exhaustiveNbHits?: boolean;
31
+ /**
32
+ * See the `typo` field of the `exhaustive` object in the response.
33
+ */
34
+ exhaustiveTypo?: boolean;
35
+ /**
36
+ * Facet counts.
37
+ */
38
+ facets?: Record<string, Record<string, number>>;
39
+ /**
40
+ * Statistics for numerical facets.
41
+ */
42
+ facets_stats?: Record<string, FacetsStats>;
43
+ /**
44
+ * Number of hits per page.
45
+ */
46
+ hitsPerPage: number;
47
+ /**
48
+ * Index name used for the query.
49
+ */
50
+ index?: string;
51
+ /**
52
+ * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
53
+ */
54
+ indexUsed?: string;
55
+ /**
56
+ * Warnings about the query.
57
+ */
58
+ message?: string;
59
+ /**
60
+ * Number of results (hits).
61
+ */
62
+ nbHits: number;
63
+ /**
64
+ * Number of pages of results.
65
+ */
66
+ nbPages: number;
67
+ /**
68
+ * Number of hits selected and sorted by the relevant sort algorithm.
69
+ */
70
+ nbSortedHits?: number;
71
+ /**
72
+ * Page of search results to retrieve.
73
+ */
74
+ page: number;
75
+ /**
76
+ * 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.
77
+ */
78
+ parsedQuery?: string;
79
+ /**
80
+ * Time the server took to process the request, in milliseconds.
81
+ */
82
+ processingTimeMS: number;
83
+ /**
84
+ * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
85
+ */
86
+ processingTimingsMS?: Record<string, any>;
87
+ /**
88
+ * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
89
+ */
90
+ queryAfterRemoval?: string;
91
+ redirect?: Redirect;
92
+ renderingContent?: RenderingContent;
93
+ /**
94
+ * Time the server took to process the request, in milliseconds.
95
+ */
96
+ serverTimeMS?: number;
97
+ /**
98
+ * Host name of the server that processed the request.
99
+ */
100
+ serverUsed?: string;
101
+ /**
102
+ * An object with custom data. You can store up to 32&nbsp;kB as custom data.
103
+ */
104
+ userData?: any | null;
105
+ /**
106
+ * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
107
+ */
108
+ queryID?: string;
109
+ };
102
110
  //# sourceMappingURL=baseSearchResponse.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"baseSearchResponse.d.ts","sourceRoot":"","sources":["../../model/baseSearchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE/B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC"}
1
+ {"version":3,"file":"baseSearchResponse.d.ts","sourceRoot":"","sources":["../../model/baseSearchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACrD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
@@ -1,14 +1,14 @@
1
- /**
2
- * Assign userID parameters.
3
- */
4
- export declare type BatchAssignUserIdsParams = {
5
- /**
6
- * Name of the cluster.
7
- */
8
- cluster: string;
9
- /**
10
- * UserIDs to assign. Note you cannot move users with this method.
11
- */
12
- users: string[];
13
- };
1
+ /**
2
+ * Assign userID parameters.
3
+ */
4
+ export type BatchAssignUserIdsParams = {
5
+ /**
6
+ * Cluster name.
7
+ */
8
+ cluster: string;
9
+ /**
10
+ * User IDs to assign.
11
+ */
12
+ users: string[];
13
+ };
14
14
  //# sourceMappingURL=batchAssignUserIdsParams.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"batchAssignUserIdsParams.d.ts","sourceRoot":"","sources":["../../model/batchAssignUserIdsParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,wBAAwB,GAAG;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC"}
1
+ {"version":3,"file":"batchAssignUserIdsParams.d.ts","sourceRoot":"","sources":["../../model/batchAssignUserIdsParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC"}
@@ -1,15 +1,15 @@
1
- import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
2
- /**
3
- * The `batchDictionaryEntries` parameters.
4
- */
5
- export declare type BatchDictionaryEntriesParams = {
6
- /**
7
- * When `true`, start the batch by removing all the custom entries from the dictionary.
8
- */
9
- clearExistingDictionaryEntries?: boolean;
10
- /**
11
- * List of operations to batch. Each operation is described by an `action` and a `body`.
12
- */
13
- requests: BatchDictionaryEntriesRequest[];
14
- };
1
+ import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
2
+ /**
3
+ * Request body for updating dictionary entries.
4
+ */
5
+ export type BatchDictionaryEntriesParams = {
6
+ /**
7
+ * Whether to replace all custom entries in the dictionary with the ones sent with this request.
8
+ */
9
+ clearExistingDictionaryEntries?: boolean;
10
+ /**
11
+ * List of additions and deletions to your dictionaries.
12
+ */
13
+ requests: BatchDictionaryEntriesRequest[];
14
+ };
15
15
  //# sourceMappingURL=batchDictionaryEntriesParams.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"batchDictionaryEntriesParams.d.ts","sourceRoot":"","sources":["../../model/batchDictionaryEntriesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF;;GAEG;AACH,oBAAY,4BAA4B,GAAG;IACzC;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,QAAQ,EAAE,6BAA6B,EAAE,CAAC;CAC3C,CAAC"}
1
+ {"version":3,"file":"batchDictionaryEntriesParams.d.ts","sourceRoot":"","sources":["../../model/batchDictionaryEntriesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,QAAQ,EAAE,6BAA6B,EAAE,CAAC;CAC3C,CAAC"}
@@ -1,7 +1,7 @@
1
- import type { DictionaryAction } from './dictionaryAction';
2
- import type { DictionaryEntry } from './dictionaryEntry';
3
- export declare type BatchDictionaryEntriesRequest = {
4
- action: DictionaryAction;
5
- body: DictionaryEntry;
6
- };
1
+ import type { DictionaryAction } from './dictionaryAction';
2
+ import type { DictionaryEntry } from './dictionaryEntry';
3
+ export type BatchDictionaryEntriesRequest = {
4
+ action: DictionaryAction;
5
+ body: DictionaryEntry;
6
+ };
7
7
  //# sourceMappingURL=batchDictionaryEntriesRequest.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"batchDictionaryEntriesRequest.d.ts","sourceRoot":"","sources":["../../model/batchDictionaryEntriesRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,6BAA6B,GAAG;IAC1C,MAAM,EAAE,gBAAgB,CAAC;IAEzB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC"}
1
+ {"version":3,"file":"batchDictionaryEntriesRequest.d.ts","sourceRoot":"","sources":["../../model/batchDictionaryEntriesRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,EAAE,gBAAgB,CAAC;IAEzB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC"}
@@ -1,8 +1,8 @@
1
- import type { MultipleBatchRequest } from './multipleBatchRequest';
2
- /**
3
- * The `multipleBatch` parameters.
4
- */
5
- export declare type BatchParams = {
6
- requests: MultipleBatchRequest[];
7
- };
1
+ import type { MultipleBatchRequest } from './multipleBatchRequest';
2
+ /**
3
+ * Batch parameters.
4
+ */
5
+ export type BatchParams = {
6
+ requests: MultipleBatchRequest[];
7
+ };
8
8
  //# sourceMappingURL=batchParams.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"batchParams.d.ts","sourceRoot":"","sources":["../../model/batchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,oBAAY,WAAW,GAAG;IACxB,QAAQ,EAAE,oBAAoB,EAAE,CAAC;CAClC,CAAC"}
1
+ {"version":3,"file":"batchParams.d.ts","sourceRoot":"","sources":["../../model/batchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,oBAAoB,EAAE,CAAC;CAClC,CAAC"}
@@ -1,9 +1,9 @@
1
- import type { Action } from './action';
2
- export declare type BatchRequest = {
3
- action: Action;
4
- /**
5
- * Arguments to the operation (depends on the type of the operation).
6
- */
7
- body: Record<string, any>;
8
- };
1
+ import type { Action } from './action';
2
+ export type BatchRequest = {
3
+ action: Action;
4
+ /**
5
+ * Operation arguments (varies with specified `action`).
6
+ */
7
+ body: Record<string, any>;
8
+ };
9
9
  //# sourceMappingURL=batchRequest.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"batchRequest.d.ts","sourceRoot":"","sources":["../../model/batchRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,oBAAY,YAAY,GAAG;IACzB,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B,CAAC"}
1
+ {"version":3,"file":"batchRequest.d.ts","sourceRoot":"","sources":["../../model/batchRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B,CAAC"}
@@ -1,11 +1,11 @@
1
- export declare type BatchResponse = {
2
- /**
3
- * TaskID of the task to wait for.
4
- */
5
- taskID: number;
6
- /**
7
- * List of objectID.
8
- */
9
- objectIDs: string[];
10
- };
1
+ export type BatchResponse = {
2
+ /**
3
+ * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
4
+ */
5
+ taskID: number;
6
+ /**
7
+ * Unique record identifiers.
8
+ */
9
+ objectIDs: string[];
10
+ };
11
11
  //# sourceMappingURL=batchResponse.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"batchResponse.d.ts","sourceRoot":"","sources":["../../model/batchResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC"}
1
+ {"version":3,"file":"batchResponse.d.ts","sourceRoot":"","sources":["../../model/batchResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC"}
@@ -1,8 +1,8 @@
1
- import type { BatchRequest } from './batchRequest';
2
- /**
3
- * The `batch` parameters.
4
- */
5
- export declare type BatchWriteParams = {
6
- requests: BatchRequest[];
7
- };
1
+ import type { BatchRequest } from './batchRequest';
2
+ /**
3
+ * Batch parameters.
4
+ */
5
+ export type BatchWriteParams = {
6
+ requests: BatchRequest[];
7
+ };
8
8
  //# sourceMappingURL=batchWriteParams.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"batchWriteParams.d.ts","sourceRoot":"","sources":["../../model/batchWriteParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B,CAAC"}
1
+ {"version":3,"file":"batchWriteParams.d.ts","sourceRoot":"","sources":["../../model/batchWriteParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B,CAAC"}
@@ -1,4 +1,4 @@
1
- import type { BrowseParamsObject } from './browseParamsObject';
2
- import type { SearchParamsString } from './searchParamsString';
3
- export declare type BrowseParams = BrowseParamsObject | SearchParamsString;
1
+ import type { BrowseParamsObject } from './browseParamsObject';
2
+ import type { SearchParamsString } from './searchParamsString';
3
+ export type BrowseParams = BrowseParamsObject | SearchParamsString;
4
4
  //# sourceMappingURL=browseParams.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"browseParams.d.ts","sourceRoot":"","sources":["../../model/browseParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,oBAAY,YAAY,GAAG,kBAAkB,GAAG,kBAAkB,CAAC"}
1
+ {"version":3,"file":"browseParams.d.ts","sourceRoot":"","sources":["../../model/browseParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,kBAAkB,CAAC"}
@@ -1,4 +1,4 @@
1
- import type { Cursor } from './cursor';
2
- import type { SearchParamsObject } from './searchParamsObject';
3
- export declare type BrowseParamsObject = Cursor & SearchParamsObject;
1
+ import type { Cursor } from './cursor';
2
+ import type { SearchParamsObject } from './searchParamsObject';
3
+ export type BrowseParamsObject = Cursor & SearchParamsObject;
4
4
  //# sourceMappingURL=browseParamsObject.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"browseParamsObject.d.ts","sourceRoot":"","sources":["../../model/browseParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,oBAAY,kBAAkB,GAAG,MAAM,GAAG,kBAAkB,CAAC"}
1
+ {"version":3,"file":"browseParamsObject.d.ts","sourceRoot":"","sources":["../../model/browseParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,kBAAkB,CAAC"}
@@ -1,5 +1,5 @@
1
- import type { BaseSearchResponse } from './baseSearchResponse';
2
- import type { Cursor } from './cursor';
3
- import type { SearchHits } from './searchHits';
4
- export declare type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & Cursor & SearchHits<T>;
1
+ import type { BaseSearchResponse } from './baseSearchResponse';
2
+ import type { Cursor } from './cursor';
3
+ import type { SearchHits } from './searchHits';
4
+ export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & Cursor & SearchHits<T>;
5
5
  //# sourceMappingURL=browseResponse.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"browseResponse.d.ts","sourceRoot":"","sources":["../../model/browseResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,kBAAkB,GACtE,MAAM,GACN,UAAU,CAAC,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"browseResponse.d.ts","sourceRoot":"","sources":["../../model/browseResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,kBAAkB,GACtE,MAAM,GACN,UAAU,CAAC,CAAC,CAAC,CAAC"}
@@ -1,12 +1,12 @@
1
- import type { BuiltInOperationType } from './builtInOperationType';
2
- /**
3
- * To update an attribute without pushing the entire record, you can use these built-in operations.
4
- */
5
- export declare type BuiltInOperation = {
6
- _operation: BuiltInOperationType;
7
- /**
8
- * The right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
9
- */
10
- value: string;
11
- };
1
+ import type { BuiltInOperationType } from './builtInOperationType';
2
+ /**
3
+ * Update to perform on the attribute.
4
+ */
5
+ export type BuiltInOperation = {
6
+ _operation: BuiltInOperationType;
7
+ /**
8
+ * Value that corresponds to the operation, for example an `Increment` or `Decrement` step, or an `Add` or `Remove` value.
9
+ */
10
+ value: string;
11
+ };
12
12
  //# sourceMappingURL=builtInOperation.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"builtInOperation.d.ts","sourceRoot":"","sources":["../../model/builtInOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,UAAU,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
1
+ {"version":3,"file":"builtInOperation.d.ts","sourceRoot":"","sources":["../../model/builtInOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
@@ -1,5 +1,5 @@
1
- /**
2
- * The operation to apply on the attribute.
3
- */
4
- export declare type BuiltInOperationType = 'Add' | 'AddUnique' | 'Decrement' | 'Increment' | 'IncrementFrom' | 'IncrementSet' | 'Remove';
1
+ /**
2
+ * How to change the attribute.
3
+ */
4
+ export type BuiltInOperationType = 'Add' | 'AddUnique' | 'Decrement' | 'Increment' | 'IncrementFrom' | 'IncrementSet' | 'Remove';
5
5
  //# sourceMappingURL=builtInOperationType.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"builtInOperationType.d.ts","sourceRoot":"","sources":["../../model/builtInOperationType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,oBAAoB,GAC5B,KAAK,GACL,WAAW,GACX,WAAW,GACX,WAAW,GACX,eAAe,GACf,cAAc,GACd,QAAQ,CAAC"}
1
+ {"version":3,"file":"builtInOperationType.d.ts","sourceRoot":"","sources":["../../model/builtInOperationType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC5B,KAAK,GACL,WAAW,GACX,WAAW,GACX,WAAW,GACX,eAAe,GACf,cAAc,GACd,QAAQ,CAAC"}