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,9 +1,10 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
- /**
4
- * Object ID of the record to hide.
5
- */
6
- export type ConsequenceHide = {
3
+ import type { FbtModel } from './fbtModel';
4
+
5
+ export type FrequentlyBoughtTogether = {
6
+ model: FbtModel;
7
+
7
8
  /**
8
9
  * Unique record identifier.
9
10
  */
@@ -0,0 +1,13 @@
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 { RecommendationsRequest } from './recommendationsRequest';
4
+
5
+ /**
6
+ * Recommend request body.
7
+ */
8
+ export type GetRecommendationsParams = {
9
+ /**
10
+ * Recommendation request with parameters depending on the requested model.
11
+ */
12
+ requests: RecommendationsRequest[];
13
+ };
@@ -1,3 +1,7 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
- export type ApiKeyOperation = 'add' | 'delete' | 'update';
3
+ import type { RecommendationsResults } from './recommendationsResults';
4
+
5
+ export type GetRecommendationsResponse = {
6
+ results: RecommendationsResults[];
7
+ };
@@ -1,43 +1,29 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  export * from './acl';
4
- export * from './action';
5
- export * from './addApiKeyResponse';
6
4
  export * from './advancedSyntaxFeatures';
7
5
  export * from './alternativesAsExact';
8
- export * from './anchoring';
9
6
  export * from './apiKey';
10
- export * from './apiKeyOperation';
11
7
  export * from './aroundPrecision';
12
8
  export * from './aroundPrecisionFromValueInner';
13
9
  export * from './aroundRadius';
14
10
  export * from './aroundRadiusAll';
15
- export * from './attributeToUpdate';
16
11
  export * from './automaticFacetFilter';
17
12
  export * from './automaticFacetFilters';
18
13
  export * from './baseGetApiKeyResponse';
19
14
  export * from './baseIndexSettings';
15
+ export * from './baseRecommendRequest';
20
16
  export * from './baseSearchParams';
21
17
  export * from './baseSearchParamsWithoutQuery';
22
18
  export * from './baseSearchResponse';
23
- export * from './browseParams';
19
+ export * from './boughtTogetherQuery';
20
+ export * from './browsePagination';
24
21
  export * from './browseParamsObject';
25
22
  export * from './browseResponse';
26
- export * from './builtInOperation';
27
- export * from './builtInOperationType';
28
- export * from './condition';
29
- export * from './consequence';
30
- export * from './consequenceHide';
31
23
  export * from './consequenceParams';
32
24
  export * from './consequenceQuery';
33
25
  export * from './consequenceQueryObject';
34
26
  export * from './cursor';
35
- export * from './deleteByParams';
36
- export * from './dictionaryAction';
37
- export * from './dictionaryEntry';
38
- export * from './dictionaryEntryState';
39
- export * from './dictionaryLanguage';
40
- export * from './dictionaryType';
41
27
  export * from './distinct';
42
28
  export * from './edit';
43
29
  export * from './editType';
@@ -49,41 +35,49 @@ export * from './facetHits';
49
35
  export * from './facetOrdering';
50
36
  export * from './facets';
51
37
  export * from './facetsStats';
52
- export * from './fetchedIndex';
38
+ export * from './fallbackParams';
39
+ export * from './fbtModel';
40
+ export * from './frequentlyBoughtTogether';
53
41
  export * from './getApiKeyResponse';
42
+ export * from './getRecommendationsParams';
43
+ export * from './getRecommendationsResponse';
54
44
  export * from './highlightResult';
55
45
  export * from './highlightResultOption';
56
46
  export * from './hit';
57
47
  export * from './ignorePlurals';
58
48
  export * from './indexSettings';
59
49
  export * from './indexSettingsAsSearchParams';
60
- export * from './languages';
61
- export * from './listIndicesResponse';
62
- export * from './logType';
50
+ export * from './lookingSimilar';
51
+ export * from './lookingSimilarModel';
52
+ export * from './lookingSimilarQuery';
63
53
  export * from './matchLevel';
64
54
  export * from './matchedGeoLocation';
65
- export * from './mixedSearchFilters';
66
55
  export * from './mode';
67
56
  export * from './numericFilters';
68
- export * from './operationType';
69
57
  export * from './optionalFilters';
70
58
  export * from './params';
71
59
  export * from './personalization';
72
- export * from './promote';
73
- export * from './promoteObjectID';
74
- export * from './promoteObjectIDs';
75
60
  export * from './queryType';
76
61
  export * from './rankingInfo';
77
62
  export * from './reRankingApplyFilter';
63
+ export * from './recommendHit';
64
+ export * from './recommendationsHit';
65
+ export * from './recommendationsHits';
66
+ export * from './recommendationsRequest';
67
+ export * from './recommendationsResults';
68
+ export * from './recommendedForYou';
69
+ export * from './recommendedForYouModel';
70
+ export * from './recommendedForYouQuery';
78
71
  export * from './redirect';
79
72
  export * from './redirectRuleIndexMetadata';
80
73
  export * from './redirectRuleIndexMetadataData';
74
+ export * from './redirectURL';
75
+ export * from './relatedModel';
76
+ export * from './relatedProducts';
77
+ export * from './relatedQuery';
81
78
  export * from './removeStopWords';
82
79
  export * from './removeWordsIfNoResults';
83
80
  export * from './renderingContent';
84
- export * from './rule';
85
- export * from './scopeType';
86
- export * from './searchDictionaryEntriesResponse';
87
81
  export * from './searchForFacetValuesResponse';
88
82
  export * from './searchForFacets';
89
83
  export * from './searchForFacetsOptions';
@@ -91,34 +85,31 @@ export * from './searchForHits';
91
85
  export * from './searchForHitsOptions';
92
86
  export * from './searchHits';
93
87
  export * from './searchMethodParams';
88
+ export * from './searchPagination';
94
89
  export * from './searchParams';
95
90
  export * from './searchParamsObject';
96
91
  export * from './searchParamsQuery';
97
- export * from './searchParamsString';
98
92
  export * from './searchQuery';
99
93
  export * from './searchResponse';
100
94
  export * from './searchResponses';
101
95
  export * from './searchResult';
102
96
  export * from './searchStrategy';
103
- export * from './searchSynonymsResponse';
104
97
  export * from './searchTypeDefault';
105
98
  export * from './searchTypeFacet';
106
- export * from './securedAPIKeyRestrictions';
107
99
  export * from './semanticSearch';
108
100
  export * from './snippetResult';
109
101
  export * from './snippetResultOption';
110
102
  export * from './sortRemainingBy';
111
- export * from './source';
112
- export * from './standardEntries';
113
103
  export * from './supportedLanguage';
114
- export * from './synonymHit';
115
- export * from './synonymType';
116
104
  export * from './tagFilters';
117
- export * from './taskStatus';
118
- export * from './timeRange';
105
+ export * from './trendingFacetHit';
106
+ export * from './trendingFacets';
107
+ export * from './trendingFacetsModel';
108
+ export * from './trendingFacetsQuery';
109
+ export * from './trendingItems';
110
+ export * from './trendingItemsModel';
111
+ export * from './trendingItemsQuery';
119
112
  export * from './typoTolerance';
120
113
  export * from './typoToleranceEnum';
121
- export * from './updatedRuleResponse';
122
- export * from './userId';
123
114
  export * from './value';
124
115
  export * from './clientMethodProps';
@@ -0,0 +1,15 @@
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 { FallbackParams } from './fallbackParams';
4
+ import type { LookingSimilarModel } from './lookingSimilarModel';
5
+
6
+ export type LookingSimilar = {
7
+ model: LookingSimilarModel;
8
+
9
+ /**
10
+ * Unique record identifier.
11
+ */
12
+ objectID: string;
13
+
14
+ fallbackParameters?: FallbackParams;
15
+ };
@@ -0,0 +1,6 @@
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
+ * Looking similar model. This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index.
5
+ */
6
+ export type LookingSimilarModel = 'looking-similar';
@@ -0,0 +1,6 @@
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 { BaseRecommendRequest } from './baseRecommendRequest';
4
+ import type { LookingSimilar } from './lookingSimilar';
5
+
6
+ export type LookingSimilarQuery = BaseRecommendRequest & LookingSimilar;
@@ -1,8 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
- import type { MixedSearchFilters } from './mixedSearchFilters';
4
-
5
3
  /**
6
4
  * Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
7
5
  */
8
- export type NumericFilters = MixedSearchFilters[] | string;
6
+ export type NumericFilters = NumericFilters[] | string;
@@ -1,8 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
- import type { MixedSearchFilters } from './mixedSearchFilters';
4
-
5
3
  /**
6
4
  * Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match. - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
7
5
  */
8
- export type OptionalFilters = MixedSearchFilters[] | string;
6
+ export type OptionalFilters = OptionalFilters[] | string;
@@ -10,7 +10,7 @@ export type RankingInfo = {
10
10
  /**
11
11
  * Whether a filter matched the query.
12
12
  */
13
- filters: number;
13
+ filters?: number;
14
14
 
15
15
  /**
16
16
  * Position of the first matched word in the best matching attribute of the record.
@@ -44,7 +44,7 @@ export type RankingInfo = {
44
44
  /**
45
45
  * Whether the record was promoted by a rule.
46
46
  */
47
- promoted: boolean;
47
+ promoted?: boolean;
48
48
 
49
49
  /**
50
50
  * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
@@ -59,7 +59,7 @@ export type RankingInfo = {
59
59
  /**
60
60
  * Number of matched words.
61
61
  */
62
- words: number;
62
+ words?: number;
63
63
 
64
64
  /**
65
65
  * Whether the record is re-ranked.
@@ -1,8 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
- import type { MixedSearchFilters } from './mixedSearchFilters';
4
-
5
3
  /**
6
4
  * Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
7
5
  */
8
- export type ReRankingApplyFilter = MixedSearchFilters[] | string;
6
+ export type ReRankingApplyFilter = ReRankingApplyFilter[] | string;
@@ -0,0 +1,34 @@
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 { HighlightResult } from './highlightResult';
4
+ import type { RankingInfo } from './rankingInfo';
5
+ import type { SnippetResult } from './snippetResult';
6
+
7
+ /**
8
+ * Recommend hit.
9
+ */
10
+ export type RecommendHit = Record<string, any> & {
11
+ /**
12
+ * Unique record identifier.
13
+ */
14
+ objectID: string;
15
+
16
+ /**
17
+ * Surround words that match the query with HTML tags for highlighting.
18
+ */
19
+ _highlightResult?: Record<string, HighlightResult>;
20
+
21
+ /**
22
+ * Snippets that show the context around a matching search query.
23
+ */
24
+ _snippetResult?: Record<string, SnippetResult>;
25
+
26
+ _rankingInfo?: RankingInfo;
27
+
28
+ _distinctSeqID?: number;
29
+
30
+ /**
31
+ * Recommendation score.
32
+ */
33
+ _score: number;
34
+ };
@@ -1,6 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
- import type { PromoteObjectID } from './promoteObjectID';
4
- import type { PromoteObjectIDs } from './promoteObjectIDs';
3
+ import type { RecommendHit } from './recommendHit';
4
+ import type { TrendingFacetHit } from './trendingFacetHit';
5
5
 
6
- export type Promote = PromoteObjectID | PromoteObjectIDs;
6
+ export type RecommendationsHit = RecommendHit | TrendingFacetHit;
@@ -1,8 +1,7 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
- export type SearchParamsString = {
4
- /**
5
- * Search parameters as a URL-encoded query string.
6
- */
7
- params?: string;
3
+ import type { RecommendationsHit } from './recommendationsHit';
4
+
5
+ export type RecommendationsHits = {
6
+ hits: RecommendationsHit[];
8
7
  };
@@ -0,0 +1,16 @@
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 { BoughtTogetherQuery } from './boughtTogetherQuery';
4
+ import type { LookingSimilarQuery } from './lookingSimilarQuery';
5
+ import type { RecommendedForYouQuery } from './recommendedForYouQuery';
6
+ import type { RelatedQuery } from './relatedQuery';
7
+ import type { TrendingFacetsQuery } from './trendingFacetsQuery';
8
+ import type { TrendingItemsQuery } from './trendingItemsQuery';
9
+
10
+ export type RecommendationsRequest =
11
+ | BoughtTogetherQuery
12
+ | LookingSimilarQuery
13
+ | RecommendedForYouQuery
14
+ | RelatedQuery
15
+ | TrendingFacetsQuery
16
+ | TrendingItemsQuery;
@@ -0,0 +1,9 @@
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 { BaseSearchResponse } from './baseSearchResponse';
4
+ import type { RecommendationsHits } from './recommendationsHits';
5
+ import type { SearchPagination } from './searchPagination';
6
+
7
+ export type RecommendationsResults = BaseSearchResponse &
8
+ RecommendationsHits &
9
+ SearchPagination;
@@ -0,0 +1,10 @@
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 { FallbackParams } from './fallbackParams';
4
+ import type { RecommendedForYouModel } from './recommendedForYouModel';
5
+
6
+ export type RecommendedForYou = {
7
+ model: RecommendedForYouModel;
8
+
9
+ fallbackParameters?: FallbackParams;
10
+ };
@@ -1,6 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
- * Operation to perform on the index.
4
+ * \"Recommened for you\" model.
5
5
  */
6
- export type OperationType = 'copy' | 'move';
6
+ export type RecommendedForYouModel = 'recommended-for-you';
@@ -0,0 +1,6 @@
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 { BaseRecommendRequest } from './baseRecommendRequest';
4
+ import type { RecommendedForYou } from './recommendedForYou';
5
+
6
+ export type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;
@@ -3,7 +3,7 @@
3
3
  import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
4
4
 
5
5
  /**
6
- * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
6
+ * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
7
7
  */
8
8
  export type Redirect = {
9
9
  index?: RedirectRuleIndexMetadata[];
@@ -1,6 +1,8 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
- * Actions to perform.
4
+ * The redirect rule container.
5
5
  */
6
- export type DictionaryAction = 'addEntry' | 'deleteEntry';
6
+ export type RedirectURL = {
7
+ url?: string;
8
+ };
@@ -0,0 +1,6 @@
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
+ * Related products or similar content model. This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes.
5
+ */
6
+ export type RelatedModel = 'related-products';
@@ -1,16 +1,15 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
- /**
4
- * Record to promote.
5
- */
6
- export type PromoteObjectID = {
3
+ import type { FallbackParams } from './fallbackParams';
4
+ import type { RelatedModel } from './relatedModel';
5
+
6
+ export type RelatedProducts = {
7
+ model: RelatedModel;
8
+
7
9
  /**
8
10
  * Unique record identifier.
9
11
  */
10
12
  objectID: string;
11
13
 
12
- /**
13
- * Position in the search results where you want to show the promoted records.
14
- */
15
- position: number;
14
+ fallbackParameters?: FallbackParams;
16
15
  };
@@ -0,0 +1,6 @@
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 { BaseRecommendRequest } from './baseRecommendRequest';
4
+ import type { RelatedProducts } from './relatedProducts';
5
+
6
+ export type RelatedQuery = BaseRecommendRequest & RelatedProducts;
@@ -1,10 +1,13 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { FacetOrdering } from './facetOrdering';
4
+ import type { RedirectURL } from './redirectURL';
4
5
 
5
6
  /**
6
7
  * Extra data that can be used in the search UI. You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.
7
8
  */
8
9
  export type RenderingContent = {
9
10
  facetOrdering?: FacetOrdering;
11
+
12
+ redirect?: RedirectURL;
10
13
  };
@@ -9,7 +9,7 @@ export type SearchForFacetValuesResponse = {
9
9
  facetHits: FacetHits[];
10
10
 
11
11
  /**
12
- * See the `facetsCount` field of the `exhaustive` object in the response.
12
+ * Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
13
13
  */
14
14
  exhaustiveFacetsCount: boolean;
15
15
 
@@ -1,15 +1,8 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
- import type { DictionaryEntry } from './dictionaryEntry';
4
-
5
- export type SearchDictionaryEntriesResponse = {
6
- /**
7
- * Dictionary entries matching the search criteria.
8
- */
9
- hits: DictionaryEntry[];
10
-
3
+ export type SearchPagination = {
11
4
  /**
12
- * Requested page of the API response.
5
+ * Page of search results to retrieve.
13
6
  */
14
7
  page: number;
15
8
 
@@ -22,4 +15,9 @@ export type SearchDictionaryEntriesResponse = {
22
15
  * Number of pages of results.
23
16
  */
24
17
  nbPages: number;
18
+
19
+ /**
20
+ * Number of hits per page.
21
+ */
22
+ hitsPerPage: number;
25
23
  };
@@ -1,6 +1,5 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { SearchParamsObject } from './searchParamsObject';
4
- import type { SearchParamsString } from './searchParamsString';
5
4
 
6
- export type SearchParams = SearchParamsObject | SearchParamsString;
5
+ export type SearchParams = Record<string, any> & SearchParamsObject;
@@ -2,6 +2,8 @@
2
2
 
3
3
  import type { BaseSearchResponse } from './baseSearchResponse';
4
4
  import type { SearchHits } from './searchHits';
5
+ import type { SearchPagination } from './searchPagination';
5
6
 
6
7
  export type SearchResponse<T = Record<string, any>> = BaseSearchResponse &
7
- SearchHits<T>;
8
+ SearchHits<T> &
9
+ SearchPagination;
@@ -1,8 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
- import type { MixedSearchFilters } from './mixedSearchFilters';
4
-
5
3
  /**
6
4
  * Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won\'t get a facet count. The same combination and escaping rules apply as for `facetFilters`.
7
5
  */
8
- export type TagFilters = MixedSearchFilters[] | string;
6
+ export type TagFilters = TagFilters[] | string;
@@ -0,0 +1,21 @@
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
+ * Trending facet hit.
5
+ */
6
+ export type TrendingFacetHit = {
7
+ /**
8
+ * Recommendation score.
9
+ */
10
+ _score: number;
11
+
12
+ /**
13
+ * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
14
+ */
15
+ facetName: string;
16
+
17
+ /**
18
+ * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
19
+ */
20
+ facetValue: string;
21
+ };
@@ -0,0 +1,15 @@
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 { FallbackParams } from './fallbackParams';
4
+ import type { TrendingFacetsModel } from './trendingFacetsModel';
5
+
6
+ export type TrendingFacets = {
7
+ /**
8
+ * Facet attribute for which to retrieve trending facet values.
9
+ */
10
+ facetName: any | null;
11
+
12
+ model: TrendingFacetsModel;
13
+
14
+ fallbackParameters?: FallbackParams;
15
+ };
@@ -0,0 +1,6 @@
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
+ * Trending facet values model. This model recommends trending facet values for the specified facet attribute.
5
+ */
6
+ export type TrendingFacetsModel = 'trending-facets';
@@ -0,0 +1,6 @@
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 { BaseRecommendRequest } from './baseRecommendRequest';
4
+ import type { TrendingFacets } from './trendingFacets';
5
+
6
+ export type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;
@@ -0,0 +1,20 @@
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
+ import type { TrendingItemsModel } from './trendingItemsModel';
5
+
6
+ export type TrendingItems = {
7
+ /**
8
+ * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
9
+ */
10
+ facetName?: string;
11
+
12
+ /**
13
+ * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
14
+ */
15
+ facetValue?: string;
16
+
17
+ model: TrendingItemsModel;
18
+
19
+ fallbackParameters?: SearchParamsObject;
20
+ };
@@ -1,6 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
- * Whether a dictionary entry is active.
4
+ * Trending items model. Trending items are determined from the number of conversion events collected on them.
5
5
  */
6
- export type DictionaryEntryState = 'disabled' | 'enabled';
6
+ export type TrendingItemsModel = 'trending-items';