algoliasearch 5.0.0-beta.1 → 5.0.0-beta.11

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 (517) hide show
  1. package/LICENSE +21 -0
  2. package/builds/browser.ts +13 -2
  3. package/builds/models.ts +140 -6
  4. package/builds/node.ts +37 -4
  5. package/dist/algoliasearch/builds/browser.d.ts +77 -70
  6. package/dist/algoliasearch/builds/browser.d.ts.map +1 -1
  7. package/dist/algoliasearch/builds/models.d.ts +4 -2
  8. package/dist/algoliasearch/builds/models.d.ts.map +1 -1
  9. package/dist/algoliasearch/builds/node.d.ts +77 -70
  10. package/dist/algoliasearch/builds/node.d.ts.map +1 -1
  11. package/dist/algoliasearch.cjs +531 -31
  12. package/dist/algoliasearch.esm.browser.js +524 -47
  13. package/dist/algoliasearch.esm.node.js +531 -31
  14. package/dist/algoliasearch.umd.js +2 -2
  15. package/dist/client-abtesting/src/abtestingClient.d.ts +1 -1
  16. package/dist/client-abtesting/src/abtestingClient.d.ts.map +1 -1
  17. package/dist/client-analytics/src/analyticsClient.d.ts +1 -1
  18. package/dist/client-analytics/src/analyticsClient.d.ts.map +1 -1
  19. package/dist/client-personalization/src/personalizationClient.d.ts +1 -1
  20. package/dist/client-personalization/src/personalizationClient.d.ts.map +1 -1
  21. package/dist/client-search/model/baseIndexSettings.d.ts +2 -2
  22. package/dist/client-search/model/baseIndexSettings.d.ts.map +1 -1
  23. package/dist/client-search/model/baseSearchResponse.d.ts +2 -18
  24. package/dist/client-search/model/baseSearchResponse.d.ts.map +1 -1
  25. package/dist/client-search/model/browsePagination.d.ts +19 -0
  26. package/dist/client-search/model/browsePagination.d.ts.map +1 -0
  27. package/dist/client-search/model/browseResponse.d.ts +2 -1
  28. package/dist/client-search/model/browseResponse.d.ts.map +1 -1
  29. package/dist/client-search/model/clientMethodProps.d.ts +31 -23
  30. package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
  31. package/dist/client-search/model/facetFilters.d.ts +1 -2
  32. package/dist/client-search/model/facetFilters.d.ts.map +1 -1
  33. package/dist/client-search/model/fetchedIndex.d.ts +4 -0
  34. package/dist/client-search/model/fetchedIndex.d.ts.map +1 -1
  35. package/dist/client-search/model/index.d.ts +5 -2
  36. package/dist/client-search/model/index.d.ts.map +1 -1
  37. package/dist/client-search/model/numericFilters.d.ts +1 -2
  38. package/dist/client-search/model/numericFilters.d.ts.map +1 -1
  39. package/dist/client-search/model/optionalFilters.d.ts +1 -2
  40. package/dist/client-search/model/optionalFilters.d.ts.map +1 -1
  41. package/dist/client-search/model/rankingInfo.d.ts +3 -3
  42. package/dist/client-search/model/rankingInfo.d.ts.map +1 -1
  43. package/dist/client-search/model/reRankingApplyFilter.d.ts +1 -2
  44. package/dist/client-search/model/reRankingApplyFilter.d.ts.map +1 -1
  45. package/dist/client-search/model/redirect.d.ts +1 -1
  46. package/dist/client-search/model/redirectURL.d.ts +7 -0
  47. package/dist/client-search/model/redirectURL.d.ts.map +1 -0
  48. package/dist/client-search/model/renderingContent.d.ts +2 -0
  49. package/dist/client-search/model/renderingContent.d.ts.map +1 -1
  50. package/dist/client-search/model/replaceAllObjectsResponse.d.ts +11 -0
  51. package/dist/client-search/model/replaceAllObjectsResponse.d.ts.map +1 -0
  52. package/dist/client-search/model/searchForFacetValuesResponse.d.ts +1 -1
  53. package/dist/client-search/model/searchPagination.d.ts +19 -0
  54. package/dist/client-search/model/searchPagination.d.ts.map +1 -0
  55. package/dist/client-search/model/searchResponse.d.ts +2 -1
  56. package/dist/client-search/model/searchResponse.d.ts.map +1 -1
  57. package/dist/{lite/model/securedAPIKeyRestrictions.d.ts → client-search/model/securedApiKeyRestrictions.d.ts} +2 -2
  58. package/dist/client-search/model/{securedAPIKeyRestrictions.d.ts.map → securedApiKeyRestrictions.d.ts.map} +1 -1
  59. package/dist/client-search/model/tagFilters.d.ts +1 -2
  60. package/dist/client-search/model/tagFilters.d.ts.map +1 -1
  61. package/dist/client-search/model/value.d.ts +4 -0
  62. package/dist/client-search/model/value.d.ts.map +1 -1
  63. package/dist/client-search/src/searchClient.d.ts +69 -14
  64. package/dist/client-search/src/searchClient.d.ts.map +1 -1
  65. package/dist/lite/builds/browser.d.ts +4 -3
  66. package/dist/lite/builds/browser.d.ts.map +1 -1
  67. package/dist/lite/builds/node.d.ts +4 -3
  68. package/dist/lite/builds/node.d.ts.map +1 -1
  69. package/dist/lite/lite.cjs +38 -1
  70. package/dist/lite/lite.esm.browser.js +48 -18
  71. package/dist/lite/lite.esm.node.js +38 -1
  72. package/dist/lite/lite.umd.js +2 -2
  73. package/dist/lite/model/baseIndexSettings.d.ts +2 -2
  74. package/dist/lite/model/baseIndexSettings.d.ts.map +1 -1
  75. package/dist/lite/model/baseRecommendRequest.d.ts +17 -0
  76. package/dist/lite/model/baseRecommendRequest.d.ts.map +1 -0
  77. package/dist/lite/model/baseSearchResponse.d.ts +2 -18
  78. package/dist/lite/model/baseSearchResponse.d.ts.map +1 -1
  79. package/dist/lite/model/boughtTogetherQuery.d.ts +4 -0
  80. package/dist/lite/model/boughtTogetherQuery.d.ts.map +1 -0
  81. package/dist/lite/model/browsePagination.d.ts +19 -0
  82. package/dist/lite/model/browsePagination.d.ts.map +1 -0
  83. package/dist/lite/model/browseResponse.d.ts +2 -1
  84. package/dist/lite/model/browseResponse.d.ts.map +1 -1
  85. package/dist/lite/model/clientMethodProps.d.ts +7 -0
  86. package/dist/lite/model/clientMethodProps.d.ts.map +1 -1
  87. package/dist/lite/model/facetFilters.d.ts +1 -2
  88. package/dist/lite/model/facetFilters.d.ts.map +1 -1
  89. package/dist/lite/model/fallbackParams.d.ts +3 -0
  90. package/dist/lite/model/fallbackParams.d.ts.map +1 -0
  91. package/dist/lite/model/fbtModel.d.ts +5 -0
  92. package/dist/lite/model/fbtModel.d.ts.map +1 -0
  93. package/dist/lite/model/frequentlyBoughtTogether.d.ts +9 -0
  94. package/dist/lite/model/frequentlyBoughtTogether.d.ts.map +1 -0
  95. package/dist/lite/model/getRecommendationsParams.d.ts +11 -0
  96. package/dist/lite/model/getRecommendationsParams.d.ts.map +1 -0
  97. package/dist/lite/model/getRecommendationsResponse.d.ts +5 -0
  98. package/dist/lite/model/getRecommendationsResponse.d.ts.map +1 -0
  99. package/dist/lite/model/index.d.ts +31 -40
  100. package/dist/lite/model/index.d.ts.map +1 -1
  101. package/dist/lite/model/lookingSimilar.d.ts +11 -0
  102. package/dist/lite/model/lookingSimilar.d.ts.map +1 -0
  103. package/dist/lite/model/lookingSimilarModel.d.ts +5 -0
  104. package/dist/lite/model/lookingSimilarModel.d.ts.map +1 -0
  105. package/dist/lite/model/lookingSimilarQuery.d.ts +4 -0
  106. package/dist/lite/model/lookingSimilarQuery.d.ts.map +1 -0
  107. package/dist/lite/model/numericFilters.d.ts +1 -2
  108. package/dist/lite/model/numericFilters.d.ts.map +1 -1
  109. package/dist/lite/model/optionalFilters.d.ts +1 -2
  110. package/dist/lite/model/optionalFilters.d.ts.map +1 -1
  111. package/dist/lite/model/rankingInfo.d.ts +3 -3
  112. package/dist/lite/model/rankingInfo.d.ts.map +1 -1
  113. package/dist/lite/model/reRankingApplyFilter.d.ts +1 -2
  114. package/dist/lite/model/reRankingApplyFilter.d.ts.map +1 -1
  115. package/dist/lite/model/recommendHit.d.ts +27 -0
  116. package/dist/lite/model/recommendHit.d.ts.map +1 -0
  117. package/dist/lite/model/recommendationsHit.d.ts +4 -0
  118. package/dist/lite/model/recommendationsHit.d.ts.map +1 -0
  119. package/dist/lite/model/recommendationsHits.d.ts +5 -0
  120. package/dist/lite/model/recommendationsHits.d.ts.map +1 -0
  121. package/dist/lite/model/recommendationsRequest.d.ts +8 -0
  122. package/dist/lite/model/recommendationsRequest.d.ts.map +1 -0
  123. package/dist/lite/model/recommendationsResults.d.ts +5 -0
  124. package/dist/lite/model/recommendationsResults.d.ts.map +1 -0
  125. package/dist/lite/model/recommendedForYou.d.ts +7 -0
  126. package/dist/lite/model/recommendedForYou.d.ts.map +1 -0
  127. package/dist/lite/model/recommendedForYouModel.d.ts +5 -0
  128. package/dist/lite/model/recommendedForYouModel.d.ts.map +1 -0
  129. package/dist/lite/model/recommendedForYouQuery.d.ts +4 -0
  130. package/dist/lite/model/recommendedForYouQuery.d.ts.map +1 -0
  131. package/dist/lite/model/redirect.d.ts +1 -1
  132. package/dist/lite/model/redirectURL.d.ts +7 -0
  133. package/dist/lite/model/redirectURL.d.ts.map +1 -0
  134. package/dist/lite/model/relatedModel.d.ts +5 -0
  135. package/dist/lite/model/relatedModel.d.ts.map +1 -0
  136. package/dist/lite/model/relatedProducts.d.ts +11 -0
  137. package/dist/lite/model/relatedProducts.d.ts.map +1 -0
  138. package/dist/lite/model/relatedQuery.d.ts +4 -0
  139. package/dist/lite/model/relatedQuery.d.ts.map +1 -0
  140. package/dist/lite/model/renderingContent.d.ts +2 -0
  141. package/dist/lite/model/renderingContent.d.ts.map +1 -1
  142. package/dist/lite/model/searchForFacetValuesResponse.d.ts +1 -1
  143. package/dist/lite/model/searchPagination.d.ts +19 -0
  144. package/dist/lite/model/searchPagination.d.ts.map +1 -0
  145. package/dist/lite/model/searchParams.d.ts +1 -2
  146. package/dist/lite/model/searchParams.d.ts.map +1 -1
  147. package/dist/lite/model/searchResponse.d.ts +2 -1
  148. package/dist/lite/model/searchResponse.d.ts.map +1 -1
  149. package/dist/lite/model/tagFilters.d.ts +1 -2
  150. package/dist/lite/model/tagFilters.d.ts.map +1 -1
  151. package/dist/lite/model/trendingFacetHit.d.ts +18 -0
  152. package/dist/lite/model/trendingFacetHit.d.ts.map +1 -0
  153. package/dist/lite/model/trendingFacets.d.ts +11 -0
  154. package/dist/lite/model/trendingFacets.d.ts.map +1 -0
  155. package/dist/lite/model/trendingFacetsModel.d.ts +5 -0
  156. package/dist/lite/model/trendingFacetsModel.d.ts.map +1 -0
  157. package/dist/lite/model/trendingFacetsQuery.d.ts +4 -0
  158. package/dist/lite/model/trendingFacetsQuery.d.ts.map +1 -0
  159. package/dist/lite/model/trendingItems.d.ts +15 -0
  160. package/dist/lite/model/trendingItems.d.ts.map +1 -0
  161. package/dist/lite/model/trendingItemsModel.d.ts +5 -0
  162. package/dist/lite/model/trendingItemsModel.d.ts.map +1 -0
  163. package/dist/lite/model/trendingItemsQuery.d.ts +4 -0
  164. package/dist/lite/model/trendingItemsQuery.d.ts.map +1 -0
  165. package/dist/lite/model/value.d.ts +4 -0
  166. package/dist/lite/model/value.d.ts.map +1 -1
  167. package/dist/lite/src/liteClient.d.ts +14 -2
  168. package/dist/lite/src/liteClient.d.ts.map +1 -1
  169. package/dist/recommend/model/advancedSyntaxFeatures.d.ts +2 -0
  170. package/dist/recommend/model/advancedSyntaxFeatures.d.ts.map +1 -0
  171. package/dist/recommend/model/alternativesAsExact.d.ts +2 -0
  172. package/dist/recommend/model/alternativesAsExact.d.ts.map +1 -0
  173. package/dist/recommend/model/aroundPrecision.d.ts +6 -0
  174. package/dist/recommend/model/aroundPrecision.d.ts.map +1 -0
  175. package/dist/recommend/model/aroundPrecisionFromValueInner.d.ts +14 -0
  176. package/dist/recommend/model/aroundPrecisionFromValueInner.d.ts.map +1 -0
  177. package/dist/recommend/model/aroundRadius.d.ts +6 -0
  178. package/dist/recommend/model/aroundRadius.d.ts.map +1 -0
  179. package/dist/recommend/model/aroundRadiusAll.d.ts +5 -0
  180. package/dist/recommend/model/aroundRadiusAll.d.ts.map +1 -0
  181. package/dist/recommend/model/autoFacetFilter.d.ts +14 -0
  182. package/dist/recommend/model/autoFacetFilter.d.ts.map +1 -0
  183. package/dist/recommend/model/baseRecommendRequest.d.ts +17 -0
  184. package/dist/recommend/model/baseRecommendRequest.d.ts.map +1 -0
  185. package/dist/recommend/model/baseSearchParams.d.ts +4 -0
  186. package/dist/recommend/model/baseSearchParams.d.ts.map +1 -0
  187. package/dist/recommend/model/baseSearchParamsWithoutQuery.d.ts +116 -0
  188. package/dist/recommend/model/baseSearchParamsWithoutQuery.d.ts.map +1 -0
  189. package/dist/recommend/model/baseSearchResponse.d.ts +94 -0
  190. package/dist/recommend/model/baseSearchResponse.d.ts.map +1 -0
  191. package/dist/recommend/model/boughtTogetherQuery.d.ts +4 -0
  192. package/dist/recommend/model/boughtTogetherQuery.d.ts.map +1 -0
  193. package/dist/recommend/model/clientMethodProps.d.ts +135 -0
  194. package/dist/recommend/model/clientMethodProps.d.ts.map +1 -0
  195. package/dist/recommend/model/condition.d.ts +14 -0
  196. package/dist/recommend/model/condition.d.ts.map +1 -0
  197. package/dist/recommend/model/consequence.d.ts +18 -0
  198. package/dist/recommend/model/consequence.d.ts.map +1 -0
  199. package/dist/{lite/model/updatedRuleResponse.d.ts → recommend/model/deletedAtResponse.d.ts} +9 -10
  200. package/dist/recommend/model/deletedAtResponse.d.ts.map +1 -0
  201. package/dist/recommend/model/distinct.d.ts +5 -0
  202. package/dist/recommend/model/distinct.d.ts.map +1 -0
  203. package/dist/recommend/model/errorBase.d.ts +7 -0
  204. package/dist/recommend/model/errorBase.d.ts.map +1 -0
  205. package/dist/recommend/model/exactOnSingleWordQuery.d.ts +5 -0
  206. package/dist/recommend/model/exactOnSingleWordQuery.d.ts.map +1 -0
  207. package/dist/recommend/model/exhaustive.d.ts +26 -0
  208. package/dist/recommend/model/exhaustive.d.ts.map +1 -0
  209. package/dist/recommend/model/facetFilters.d.ts +5 -0
  210. package/dist/recommend/model/facetFilters.d.ts.map +1 -0
  211. package/dist/recommend/model/facetOrdering.d.ts +13 -0
  212. package/dist/recommend/model/facetOrdering.d.ts.map +1 -0
  213. package/dist/recommend/model/facets.d.ts +10 -0
  214. package/dist/recommend/model/facets.d.ts.map +1 -0
  215. package/dist/recommend/model/facetsStats.d.ts +19 -0
  216. package/dist/recommend/model/facetsStats.d.ts.map +1 -0
  217. package/dist/recommend/model/fallbackParams.d.ts +3 -0
  218. package/dist/recommend/model/fallbackParams.d.ts.map +1 -0
  219. package/dist/recommend/model/fbtModel.d.ts +5 -0
  220. package/dist/recommend/model/fbtModel.d.ts.map +1 -0
  221. package/dist/recommend/model/frequentlyBoughtTogether.d.ts +9 -0
  222. package/dist/recommend/model/frequentlyBoughtTogether.d.ts.map +1 -0
  223. package/dist/recommend/model/getRecommendTaskResponse.d.ts +5 -0
  224. package/dist/recommend/model/getRecommendTaskResponse.d.ts.map +1 -0
  225. package/dist/recommend/model/getRecommendationsParams.d.ts +11 -0
  226. package/dist/recommend/model/getRecommendationsParams.d.ts.map +1 -0
  227. package/dist/recommend/model/getRecommendationsResponse.d.ts +5 -0
  228. package/dist/recommend/model/getRecommendationsResponse.d.ts.map +1 -0
  229. package/dist/recommend/model/hideConsequenceObject.d.ts +10 -0
  230. package/dist/recommend/model/hideConsequenceObject.d.ts.map +1 -0
  231. package/dist/recommend/model/highlightResult.d.ts +3 -0
  232. package/dist/recommend/model/highlightResult.d.ts.map +1 -0
  233. package/dist/recommend/model/highlightResultOption.d.ts +20 -0
  234. package/dist/recommend/model/highlightResultOption.d.ts.map +1 -0
  235. package/dist/recommend/model/ignorePlurals.d.ts +6 -0
  236. package/dist/recommend/model/ignorePlurals.d.ts.map +1 -0
  237. package/dist/recommend/model/index.d.ts +94 -0
  238. package/dist/recommend/model/index.d.ts.map +1 -0
  239. package/dist/recommend/model/indexSettingsAsSearchParams.d.ts +160 -0
  240. package/dist/recommend/model/indexSettingsAsSearchParams.d.ts.map +1 -0
  241. package/dist/recommend/model/lookingSimilar.d.ts +11 -0
  242. package/dist/recommend/model/lookingSimilar.d.ts.map +1 -0
  243. package/dist/recommend/model/lookingSimilarModel.d.ts +5 -0
  244. package/dist/recommend/model/lookingSimilarModel.d.ts.map +1 -0
  245. package/dist/recommend/model/lookingSimilarQuery.d.ts +4 -0
  246. package/dist/recommend/model/lookingSimilarQuery.d.ts.map +1 -0
  247. package/dist/recommend/model/matchLevel.d.ts +5 -0
  248. package/dist/recommend/model/matchLevel.d.ts.map +1 -0
  249. package/dist/recommend/model/matchedGeoLocation.d.ts +15 -0
  250. package/dist/recommend/model/matchedGeoLocation.d.ts.map +1 -0
  251. package/dist/recommend/model/mode.d.ts +5 -0
  252. package/dist/recommend/model/mode.d.ts.map +1 -0
  253. package/dist/recommend/model/numericFilters.d.ts +5 -0
  254. package/dist/recommend/model/numericFilters.d.ts.map +1 -0
  255. package/dist/recommend/model/optionalFilters.d.ts +5 -0
  256. package/dist/recommend/model/optionalFilters.d.ts.map +1 -0
  257. package/dist/recommend/model/paramsConsequence.d.ts +19 -0
  258. package/dist/recommend/model/paramsConsequence.d.ts.map +1 -0
  259. package/dist/recommend/model/personalization.d.ts +15 -0
  260. package/dist/recommend/model/personalization.d.ts.map +1 -0
  261. package/dist/recommend/model/promoteConsequenceObject.d.ts +14 -0
  262. package/dist/recommend/model/promoteConsequenceObject.d.ts.map +1 -0
  263. package/dist/recommend/model/queryType.d.ts +5 -0
  264. package/dist/recommend/model/queryType.d.ts.map +1 -0
  265. package/dist/recommend/model/rankingInfo.d.ts +54 -0
  266. package/dist/recommend/model/rankingInfo.d.ts.map +1 -0
  267. package/dist/recommend/model/reRankingApplyFilter.d.ts +5 -0
  268. package/dist/recommend/model/reRankingApplyFilter.d.ts.map +1 -0
  269. package/dist/recommend/model/recommendHit.d.ts +27 -0
  270. package/dist/recommend/model/recommendHit.d.ts.map +1 -0
  271. package/dist/recommend/model/recommendModels.d.ts +2 -0
  272. package/dist/recommend/model/recommendModels.d.ts.map +1 -0
  273. package/dist/recommend/model/recommendRule.d.ts +24 -0
  274. package/dist/recommend/model/recommendRule.d.ts.map +1 -0
  275. package/dist/recommend/model/recommendRuleMetadata.d.ts +10 -0
  276. package/dist/recommend/model/recommendRuleMetadata.d.ts.map +1 -0
  277. package/dist/recommend/model/recommendationsHit.d.ts +4 -0
  278. package/dist/recommend/model/recommendationsHit.d.ts.map +1 -0
  279. package/dist/recommend/model/recommendationsHits.d.ts +5 -0
  280. package/dist/recommend/model/recommendationsHits.d.ts.map +1 -0
  281. package/dist/recommend/model/recommendationsRequest.d.ts +8 -0
  282. package/dist/recommend/model/recommendationsRequest.d.ts.map +1 -0
  283. package/dist/recommend/model/recommendationsResults.d.ts +5 -0
  284. package/dist/recommend/model/recommendationsResults.d.ts.map +1 -0
  285. package/dist/recommend/model/recommendedForYou.d.ts +7 -0
  286. package/dist/recommend/model/recommendedForYou.d.ts.map +1 -0
  287. package/dist/recommend/model/recommendedForYouModel.d.ts +5 -0
  288. package/dist/recommend/model/recommendedForYouModel.d.ts.map +1 -0
  289. package/dist/recommend/model/recommendedForYouQuery.d.ts +4 -0
  290. package/dist/recommend/model/recommendedForYouQuery.d.ts.map +1 -0
  291. package/dist/recommend/model/redirect.d.ts +8 -0
  292. package/dist/recommend/model/redirect.d.ts.map +1 -0
  293. package/dist/recommend/model/redirectRuleIndexMetadata.d.ts +21 -0
  294. package/dist/recommend/model/redirectRuleIndexMetadata.d.ts.map +1 -0
  295. package/dist/recommend/model/redirectRuleIndexMetadataData.d.ts +7 -0
  296. package/dist/recommend/model/redirectRuleIndexMetadataData.d.ts.map +1 -0
  297. package/dist/recommend/model/redirectURL.d.ts +7 -0
  298. package/dist/recommend/model/redirectURL.d.ts.map +1 -0
  299. package/dist/recommend/model/relatedModel.d.ts +5 -0
  300. package/dist/recommend/model/relatedModel.d.ts.map +1 -0
  301. package/dist/recommend/model/relatedProducts.d.ts +11 -0
  302. package/dist/recommend/model/relatedProducts.d.ts.map +1 -0
  303. package/dist/recommend/model/relatedQuery.d.ts +4 -0
  304. package/dist/recommend/model/relatedQuery.d.ts.map +1 -0
  305. package/dist/recommend/model/removeStopWords.d.ts +6 -0
  306. package/dist/recommend/model/removeStopWords.d.ts.map +1 -0
  307. package/dist/recommend/model/removeWordsIfNoResults.d.ts +5 -0
  308. package/dist/recommend/model/removeWordsIfNoResults.d.ts.map +1 -0
  309. package/dist/recommend/model/renderingContent.d.ts +10 -0
  310. package/dist/recommend/model/renderingContent.d.ts.map +1 -0
  311. package/dist/recommend/model/searchPagination.d.ts +19 -0
  312. package/dist/recommend/model/searchPagination.d.ts.map +1 -0
  313. package/dist/recommend/model/searchParams.d.ts +3 -0
  314. package/dist/recommend/model/searchParams.d.ts.map +1 -0
  315. package/dist/recommend/model/searchParamsObject.d.ts +7 -0
  316. package/dist/recommend/model/searchParamsObject.d.ts.map +1 -0
  317. package/dist/recommend/model/searchParamsQuery.d.ts +7 -0
  318. package/dist/recommend/model/searchParamsQuery.d.ts.map +1 -0
  319. package/dist/recommend/model/searchRecommendRulesParams.d.ts +38 -0
  320. package/dist/recommend/model/searchRecommendRulesParams.d.ts.map +1 -0
  321. package/dist/recommend/model/searchRecommendRulesResponse.d.ts +20 -0
  322. package/dist/recommend/model/searchRecommendRulesResponse.d.ts.map +1 -0
  323. package/dist/recommend/model/semanticSearch.d.ts +10 -0
  324. package/dist/recommend/model/semanticSearch.d.ts.map +1 -0
  325. package/dist/recommend/model/snippetResult.d.ts +3 -0
  326. package/dist/recommend/model/snippetResult.d.ts.map +1 -0
  327. package/dist/recommend/model/snippetResultOption.d.ts +12 -0
  328. package/dist/recommend/model/snippetResultOption.d.ts.map +1 -0
  329. package/dist/recommend/model/sortRemainingBy.d.ts +5 -0
  330. package/dist/recommend/model/sortRemainingBy.d.ts.map +1 -0
  331. package/dist/recommend/model/supportedLanguage.d.ts +5 -0
  332. package/dist/recommend/model/supportedLanguage.d.ts.map +1 -0
  333. package/dist/recommend/model/tagFilters.d.ts +5 -0
  334. package/dist/recommend/model/tagFilters.d.ts.map +1 -0
  335. package/dist/recommend/model/taskStatus.d.ts.map +1 -0
  336. package/dist/recommend/model/trendingFacetHit.d.ts +18 -0
  337. package/dist/recommend/model/trendingFacetHit.d.ts.map +1 -0
  338. package/dist/recommend/model/trendingFacets.d.ts +11 -0
  339. package/dist/recommend/model/trendingFacets.d.ts.map +1 -0
  340. package/dist/recommend/model/trendingFacetsModel.d.ts +5 -0
  341. package/dist/recommend/model/trendingFacetsModel.d.ts.map +1 -0
  342. package/dist/recommend/model/trendingFacetsQuery.d.ts +4 -0
  343. package/dist/recommend/model/trendingFacetsQuery.d.ts.map +1 -0
  344. package/dist/recommend/model/trendingItems.d.ts +15 -0
  345. package/dist/recommend/model/trendingItems.d.ts.map +1 -0
  346. package/dist/recommend/model/trendingItemsModel.d.ts +5 -0
  347. package/dist/recommend/model/trendingItemsModel.d.ts.map +1 -0
  348. package/dist/recommend/model/trendingItemsQuery.d.ts +4 -0
  349. package/dist/recommend/model/trendingItemsQuery.d.ts.map +1 -0
  350. package/dist/recommend/model/typoTolerance.d.ts +6 -0
  351. package/dist/recommend/model/typoTolerance.d.ts.map +1 -0
  352. package/dist/recommend/model/typoToleranceEnum.d.ts +5 -0
  353. package/dist/recommend/model/typoToleranceEnum.d.ts.map +1 -0
  354. package/dist/recommend/model/value.d.ts +13 -0
  355. package/dist/recommend/model/value.d.ts.map +1 -0
  356. package/dist/recommend/src/recommendClient.d.ts +132 -0
  357. package/dist/recommend/src/recommendClient.d.ts.map +1 -0
  358. package/lite/model/baseIndexSettings.ts +2 -2
  359. package/lite/model/baseRecommendRequest.ts +22 -0
  360. package/lite/model/baseSearchResponse.ts +2 -22
  361. package/lite/model/boughtTogetherQuery.ts +7 -0
  362. package/lite/model/browsePagination.ts +23 -0
  363. package/lite/model/browseResponse.ts +2 -0
  364. package/lite/model/clientMethodProps.ts +8 -0
  365. package/lite/model/facetFilters.ts +1 -3
  366. package/lite/model/{attributeToUpdate.ts → fallbackParams.ts} +2 -2
  367. package/lite/model/{builtInOperationType.ts → fbtModel.ts} +2 -9
  368. package/lite/model/{consequenceHide.ts → frequentlyBoughtTogether.ts} +5 -4
  369. package/lite/model/getRecommendationsParams.ts +13 -0
  370. package/lite/model/{apiKeyOperation.ts → getRecommendationsResponse.ts} +5 -1
  371. package/lite/model/index.ts +31 -40
  372. package/lite/model/lookingSimilar.ts +15 -0
  373. package/lite/model/lookingSimilarModel.ts +6 -0
  374. package/lite/model/lookingSimilarQuery.ts +6 -0
  375. package/lite/model/numericFilters.ts +1 -3
  376. package/lite/model/optionalFilters.ts +1 -3
  377. package/lite/model/rankingInfo.ts +3 -3
  378. package/lite/model/reRankingApplyFilter.ts +1 -3
  379. package/lite/model/recommendHit.ts +34 -0
  380. package/lite/model/{promote.ts → recommendationsHit.ts} +3 -3
  381. package/lite/model/{searchParamsString.ts → recommendationsHits.ts} +4 -5
  382. package/lite/model/recommendationsRequest.ts +16 -0
  383. package/lite/model/recommendationsResults.ts +9 -0
  384. package/lite/model/recommendedForYou.ts +10 -0
  385. package/lite/model/{operationType.ts → recommendedForYouModel.ts} +2 -2
  386. package/lite/model/recommendedForYouQuery.ts +6 -0
  387. package/lite/model/redirect.ts +1 -1
  388. package/lite/model/{dictionaryAction.ts → redirectURL.ts} +4 -2
  389. package/lite/model/relatedModel.ts +6 -0
  390. package/lite/model/{promoteObjectID.ts → relatedProducts.ts} +7 -8
  391. package/lite/model/relatedQuery.ts +6 -0
  392. package/lite/model/renderingContent.ts +3 -0
  393. package/lite/model/searchForFacetValuesResponse.ts +1 -1
  394. package/lite/model/{searchDictionaryEntriesResponse.ts → searchPagination.ts} +7 -9
  395. package/lite/model/searchParams.ts +1 -2
  396. package/lite/model/searchResponse.ts +3 -1
  397. package/lite/model/tagFilters.ts +1 -3
  398. package/lite/model/trendingFacetHit.ts +21 -0
  399. package/lite/model/trendingFacets.ts +15 -0
  400. package/lite/model/trendingFacetsModel.ts +6 -0
  401. package/lite/model/trendingFacetsQuery.ts +6 -0
  402. package/lite/model/trendingItems.ts +20 -0
  403. package/lite/model/{dictionaryEntryState.ts → trendingItemsModel.ts} +2 -2
  404. package/lite/model/trendingItemsQuery.ts +6 -0
  405. package/lite/model/value.ts +5 -0
  406. package/lite/src/liteClient.ts +57 -1
  407. package/package.json +18 -14
  408. package/dist/client-search/model/mixedSearchFilters.d.ts +0 -2
  409. package/dist/client-search/model/mixedSearchFilters.d.ts.map +0 -1
  410. package/dist/client-search/model/securedAPIKeyRestrictions.d.ts +0 -25
  411. package/dist/lite/model/action.d.ts +0 -5
  412. package/dist/lite/model/action.d.ts.map +0 -1
  413. package/dist/lite/model/addApiKeyResponse.d.ts +0 -11
  414. package/dist/lite/model/addApiKeyResponse.d.ts.map +0 -1
  415. package/dist/lite/model/anchoring.d.ts +0 -5
  416. package/dist/lite/model/anchoring.d.ts.map +0 -1
  417. package/dist/lite/model/apiKeyOperation.d.ts +0 -2
  418. package/dist/lite/model/apiKeyOperation.d.ts.map +0 -1
  419. package/dist/lite/model/attributeToUpdate.d.ts +0 -3
  420. package/dist/lite/model/attributeToUpdate.d.ts.map +0 -1
  421. package/dist/lite/model/browseParams.d.ts +0 -4
  422. package/dist/lite/model/browseParams.d.ts.map +0 -1
  423. package/dist/lite/model/builtInOperation.d.ts +0 -12
  424. package/dist/lite/model/builtInOperation.d.ts.map +0 -1
  425. package/dist/lite/model/builtInOperationType.d.ts +0 -5
  426. package/dist/lite/model/builtInOperationType.d.ts.map +0 -1
  427. package/dist/lite/model/condition.d.ts +0 -21
  428. package/dist/lite/model/condition.d.ts.map +0 -1
  429. package/dist/lite/model/consequence.d.ts +0 -26
  430. package/dist/lite/model/consequence.d.ts.map +0 -1
  431. package/dist/lite/model/consequenceHide.d.ts +0 -10
  432. package/dist/lite/model/consequenceHide.d.ts.map +0 -1
  433. package/dist/lite/model/deleteByParams.d.ts +0 -27
  434. package/dist/lite/model/deleteByParams.d.ts.map +0 -1
  435. package/dist/lite/model/dictionaryAction.d.ts +0 -5
  436. package/dist/lite/model/dictionaryAction.d.ts.map +0 -1
  437. package/dist/lite/model/dictionaryEntry.d.ts +0 -26
  438. package/dist/lite/model/dictionaryEntry.d.ts.map +0 -1
  439. package/dist/lite/model/dictionaryEntryState.d.ts +0 -5
  440. package/dist/lite/model/dictionaryEntryState.d.ts.map +0 -1
  441. package/dist/lite/model/dictionaryLanguage.d.ts +0 -10
  442. package/dist/lite/model/dictionaryLanguage.d.ts.map +0 -1
  443. package/dist/lite/model/dictionaryType.d.ts +0 -2
  444. package/dist/lite/model/dictionaryType.d.ts.map +0 -1
  445. package/dist/lite/model/fetchedIndex.d.ts +0 -47
  446. package/dist/lite/model/fetchedIndex.d.ts.map +0 -1
  447. package/dist/lite/model/languages.d.ts +0 -10
  448. package/dist/lite/model/languages.d.ts.map +0 -1
  449. package/dist/lite/model/listIndicesResponse.d.ts +0 -12
  450. package/dist/lite/model/listIndicesResponse.d.ts.map +0 -1
  451. package/dist/lite/model/logType.d.ts +0 -2
  452. package/dist/lite/model/logType.d.ts.map +0 -1
  453. package/dist/lite/model/mixedSearchFilters.d.ts +0 -2
  454. package/dist/lite/model/mixedSearchFilters.d.ts.map +0 -1
  455. package/dist/lite/model/operationType.d.ts +0 -5
  456. package/dist/lite/model/operationType.d.ts.map +0 -1
  457. package/dist/lite/model/promote.d.ts +0 -4
  458. package/dist/lite/model/promote.d.ts.map +0 -1
  459. package/dist/lite/model/promoteObjectID.d.ts +0 -14
  460. package/dist/lite/model/promoteObjectID.d.ts.map +0 -1
  461. package/dist/lite/model/promoteObjectIDs.d.ts +0 -14
  462. package/dist/lite/model/promoteObjectIDs.d.ts.map +0 -1
  463. package/dist/lite/model/rule.d.ts +0 -30
  464. package/dist/lite/model/rule.d.ts.map +0 -1
  465. package/dist/lite/model/scopeType.d.ts +0 -2
  466. package/dist/lite/model/scopeType.d.ts.map +0 -1
  467. package/dist/lite/model/searchDictionaryEntriesResponse.d.ts +0 -20
  468. package/dist/lite/model/searchDictionaryEntriesResponse.d.ts.map +0 -1
  469. package/dist/lite/model/searchParamsString.d.ts +0 -7
  470. package/dist/lite/model/searchParamsString.d.ts.map +0 -1
  471. package/dist/lite/model/searchSynonymsResponse.d.ts +0 -12
  472. package/dist/lite/model/searchSynonymsResponse.d.ts.map +0 -1
  473. package/dist/lite/model/securedAPIKeyRestrictions.d.ts.map +0 -1
  474. package/dist/lite/model/source.d.ts +0 -14
  475. package/dist/lite/model/source.d.ts.map +0 -1
  476. package/dist/lite/model/standardEntries.d.ts +0 -18
  477. package/dist/lite/model/standardEntries.d.ts.map +0 -1
  478. package/dist/lite/model/synonymHit.d.ts +0 -36
  479. package/dist/lite/model/synonymHit.d.ts.map +0 -1
  480. package/dist/lite/model/synonymType.d.ts +0 -5
  481. package/dist/lite/model/synonymType.d.ts.map +0 -1
  482. package/dist/lite/model/taskStatus.d.ts.map +0 -1
  483. package/dist/lite/model/timeRange.d.ts +0 -11
  484. package/dist/lite/model/timeRange.d.ts.map +0 -1
  485. package/dist/lite/model/updatedRuleResponse.d.ts.map +0 -1
  486. package/dist/lite/model/userId.d.ts +0 -22
  487. package/dist/lite/model/userId.d.ts.map +0 -1
  488. package/lite/model/action.ts +0 -13
  489. package/lite/model/addApiKeyResponse.ts +0 -13
  490. package/lite/model/anchoring.ts +0 -6
  491. package/lite/model/browseParams.ts +0 -6
  492. package/lite/model/builtInOperation.ts +0 -15
  493. package/lite/model/condition.ts +0 -27
  494. package/lite/model/consequence.ts +0 -32
  495. package/lite/model/deleteByParams.ts +0 -36
  496. package/lite/model/dictionaryEntry.ts +0 -33
  497. package/lite/model/dictionaryLanguage.ts +0 -11
  498. package/lite/model/dictionaryType.ts +0 -3
  499. package/lite/model/fetchedIndex.ts +0 -58
  500. package/lite/model/languages.ts +0 -14
  501. package/lite/model/listIndicesResponse.ts +0 -15
  502. package/lite/model/logType.ts +0 -3
  503. package/lite/model/mixedSearchFilters.ts +0 -3
  504. package/lite/model/promoteObjectIDs.ts +0 -16
  505. package/lite/model/rule.ts +0 -37
  506. package/lite/model/scopeType.ts +0 -3
  507. package/lite/model/searchSynonymsResponse.ts +0 -15
  508. package/lite/model/securedAPIKeyRestrictions.ts +0 -32
  509. package/lite/model/source.ts +0 -16
  510. package/lite/model/standardEntries.ts +0 -21
  511. package/lite/model/synonymHit.ts +0 -45
  512. package/lite/model/synonymType.ts +0 -11
  513. package/lite/model/taskStatus.ts +0 -6
  514. package/lite/model/timeRange.ts +0 -13
  515. package/lite/model/updatedRuleResponse.ts +0 -18
  516. package/lite/model/userId.ts +0 -26
  517. /package/dist/{lite → recommend}/model/taskStatus.d.ts +0 -0
@@ -1,32 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { SearchParamsObject } from './searchParamsObject';
4
-
5
- export type SecuredAPIKeyRestrictions = {
6
- searchParams?: SearchParamsObject;
7
-
8
- /**
9
- * Filters that apply to every search made with the secured API key. Extra filters added at search time will be combined with `AND`. For example, if you set `group:admin` as fixed filter on your generated API key, and add `groups:visitors` to the search query, the complete set of filters will be `group:admin AND groups:visitors`.
10
- */
11
- filters?: string;
12
-
13
- /**
14
- * Timestamp when the secured API key expires, measured in seconds since the Unix epoch.
15
- */
16
- validUntil?: number;
17
-
18
- /**
19
- * Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (`*`): - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
20
- */
21
- restrictIndices?: string[];
22
-
23
- /**
24
- * IP network that are allowed to use this key. You can only add a single source, but you can provide a range of IP addresses. Use this to protect against API key leaking and reuse.
25
- */
26
- restrictSources?: string;
27
-
28
- /**
29
- * Pseudonymous user identifier to restrict usage of this API key to specific users. By default, rate limits are set based on IP addresses. This can be an issue if many users search from the same IP address. To avoid this, add a user token to each generated API key.
30
- */
31
- userToken?: string;
32
- };
@@ -1,16 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Source.
5
- */
6
- export type Source = {
7
- /**
8
- * IP address range of the source.
9
- */
10
- source: string;
11
-
12
- /**
13
- * Source description.
14
- */
15
- description?: string;
16
- };
@@ -1,21 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and boolean values.
5
- */
6
- export type StandardEntries = {
7
- /**
8
- * Key-value pair of a language ISO code and a boolean value.
9
- */
10
- plurals?: Record<string, boolean> | null;
11
-
12
- /**
13
- * Key-value pair of a language ISO code and a boolean value.
14
- */
15
- stopwords?: Record<string, boolean> | null;
16
-
17
- /**
18
- * Key-value pair of a language ISO code and a boolean value.
19
- */
20
- compounds?: Record<string, boolean> | null;
21
- };
@@ -1,45 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { SynonymType } from './synonymType';
4
-
5
- /**
6
- * Synonym object.
7
- */
8
- export type SynonymHit = {
9
- /**
10
- * Unique identifier of a synonym object.
11
- */
12
- objectID: string;
13
-
14
- type: SynonymType;
15
-
16
- /**
17
- * Words or phrases considered equivalent.
18
- */
19
- synonyms?: string[];
20
-
21
- /**
22
- * Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).
23
- */
24
- input?: string;
25
-
26
- /**
27
- * Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).
28
- */
29
- word?: string;
30
-
31
- /**
32
- * Words to be matched in records.
33
- */
34
- corrections?: string[];
35
-
36
- /**
37
- * [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
38
- */
39
- placeholder?: string;
40
-
41
- /**
42
- * Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).
43
- */
44
- replacements?: string[];
45
- };
@@ -1,11 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Synonym type.
5
- */
6
- export type SynonymType =
7
- | 'altcorrection1'
8
- | 'altcorrection2'
9
- | 'onewaysynonym'
10
- | 'placeholder'
11
- | 'synonym';
@@ -1,6 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Task status, `published` if the task is completed, `notPublished` otherwise.
5
- */
6
- export type TaskStatus = 'notPublished' | 'published';
@@ -1,13 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- export type TimeRange = {
4
- /**
5
- * When the rule should start to be active, in Unix epoch time.
6
- */
7
- from: number;
8
-
9
- /**
10
- * When the rule should stop to be active, in Unix epoch time.
11
- */
12
- until: number;
13
- };
@@ -1,18 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- export type UpdatedRuleResponse = {
4
- /**
5
- * Unique identifier of a rule object.
6
- */
7
- objectID: string;
8
-
9
- /**
10
- * Date and time when the object was updated, in RFC 3339 format.
11
- */
12
- updatedAt: string;
13
-
14
- /**
15
- * 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`.
16
- */
17
- taskID: number;
18
- };
@@ -1,26 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Unique user ID.
5
- */
6
- export type UserId = {
7
- /**
8
- * Unique identifier of the user who makes the search request.
9
- */
10
- userID: string;
11
-
12
- /**
13
- * Cluster to which the user is assigned.
14
- */
15
- clusterName: string;
16
-
17
- /**
18
- * Number of records belonging to the user.
19
- */
20
- nbRecords: number;
21
-
22
- /**
23
- * Data size used by the user.
24
- */
25
- dataSize: number;
26
- };
File without changes