algoliasearch 5.0.0-alpha.99 → 5.0.0-beta.10

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 (888) hide show
  1. package/LICENSE +21 -0
  2. package/builds/browser.ts +22 -18
  3. package/builds/models.ts +140 -6
  4. package/builds/node.ts +92 -16
  5. package/dist/algoliasearch/builds/browser.d.ts +83 -71
  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 +101 -72
  10. package/dist/algoliasearch/builds/node.d.ts.map +1 -1
  11. package/dist/algoliasearch.cjs +1259 -399
  12. package/dist/algoliasearch.esm.browser.js +1226 -423
  13. package/dist/algoliasearch.esm.node.js +1260 -400
  14. package/dist/algoliasearch.umd.js +2 -2
  15. package/dist/client-abtesting/model/aBTest.d.ts +14 -29
  16. package/dist/client-abtesting/model/aBTest.d.ts.map +1 -1
  17. package/dist/client-abtesting/model/aBTestConfiguration.d.ts +12 -0
  18. package/dist/client-abtesting/model/aBTestConfiguration.d.ts.map +1 -0
  19. package/dist/client-abtesting/model/aBTestResponse.d.ts +3 -3
  20. package/dist/client-abtesting/model/abTestsVariant.d.ts +3 -3
  21. package/dist/client-abtesting/model/addABTestsRequest.d.ts +1 -1
  22. package/dist/client-abtesting/model/clientMethodProps.d.ts +7 -7
  23. package/dist/client-abtesting/model/{currenciesValue.d.ts → currency.d.ts} +2 -2
  24. package/dist/client-abtesting/model/currency.d.ts.map +1 -0
  25. package/dist/client-abtesting/model/customSearchParams.d.ts +1 -1
  26. package/dist/client-abtesting/model/effect.d.ts +5 -0
  27. package/dist/client-abtesting/model/effect.d.ts.map +1 -0
  28. package/dist/client-abtesting/model/emptySearch.d.ts +10 -0
  29. package/dist/client-abtesting/model/emptySearch.d.ts.map +1 -0
  30. package/dist/client-abtesting/model/index.d.ts +7 -1
  31. package/dist/client-abtesting/model/index.d.ts.map +1 -1
  32. package/dist/client-abtesting/model/listABTestsResponse.d.ts +2 -2
  33. package/dist/client-abtesting/model/listABTestsResponse.d.ts.map +1 -1
  34. package/dist/client-abtesting/model/minimumDetectableEffect.d.ts +12 -0
  35. package/dist/client-abtesting/model/minimumDetectableEffect.d.ts.map +1 -0
  36. package/dist/client-abtesting/model/outliers.d.ts +10 -0
  37. package/dist/client-abtesting/model/outliers.d.ts.map +1 -0
  38. package/dist/client-abtesting/model/status.d.ts +5 -0
  39. package/dist/client-abtesting/model/status.d.ts.map +1 -0
  40. package/dist/client-abtesting/model/variant.d.ts +29 -25
  41. package/dist/client-abtesting/model/variant.d.ts.map +1 -1
  42. package/dist/client-abtesting/src/abtestingClient.d.ts +28 -26
  43. package/dist/client-abtesting/src/abtestingClient.d.ts.map +1 -1
  44. package/dist/client-analytics/model/clickPositionsInner.d.ts +14 -0
  45. package/dist/client-analytics/model/clickPositionsInner.d.ts.map +1 -0
  46. package/dist/client-analytics/model/clientMethodProps.d.ts +161 -90
  47. package/dist/client-analytics/model/clientMethodProps.d.ts.map +1 -1
  48. package/dist/client-analytics/model/currenciesValue.d.ts +14 -0
  49. package/dist/client-analytics/model/currenciesValue.d.ts.map +1 -0
  50. package/dist/client-analytics/model/dailyAddToCartRates.d.ts +19 -0
  51. package/dist/client-analytics/model/dailyAddToCartRates.d.ts.map +1 -0
  52. package/dist/client-analytics/model/dailyAverageClicks.d.ts +15 -0
  53. package/dist/client-analytics/model/dailyAverageClicks.d.ts.map +1 -0
  54. package/dist/client-analytics/model/dailyClickThroughRates.d.ts +19 -0
  55. package/dist/client-analytics/model/dailyClickThroughRates.d.ts.map +1 -0
  56. package/dist/client-analytics/model/dailyConversionRates.d.ts +19 -0
  57. package/dist/client-analytics/model/dailyConversionRates.d.ts.map +1 -0
  58. package/dist/client-analytics/model/dailyNoClickRates.d.ts +19 -0
  59. package/dist/client-analytics/model/dailyNoClickRates.d.ts.map +1 -0
  60. package/dist/client-analytics/model/dailyNoResultsRates.d.ts +19 -0
  61. package/dist/client-analytics/model/dailyNoResultsRates.d.ts.map +1 -0
  62. package/dist/client-analytics/model/dailyPurchaseRates.d.ts +19 -0
  63. package/dist/client-analytics/model/dailyPurchaseRates.d.ts.map +1 -0
  64. package/dist/client-analytics/model/dailyRevenue.d.ts +12 -0
  65. package/dist/client-analytics/model/dailyRevenue.d.ts.map +1 -0
  66. package/dist/client-analytics/model/dailySearches.d.ts +11 -0
  67. package/dist/client-analytics/model/dailySearches.d.ts.map +1 -0
  68. package/dist/client-analytics/model/dailySearchesNoClicks.d.ts +15 -0
  69. package/dist/client-analytics/model/dailySearchesNoClicks.d.ts.map +1 -0
  70. package/dist/client-analytics/model/dailySearchesNoResults.d.ts +15 -0
  71. package/dist/client-analytics/model/dailySearchesNoResults.d.ts.map +1 -0
  72. package/dist/client-analytics/model/dailyUsers.d.ts +11 -0
  73. package/dist/client-analytics/model/dailyUsers.d.ts.map +1 -0
  74. package/dist/client-analytics/model/getAddToCartRateResponse.d.ts +20 -0
  75. package/dist/client-analytics/model/getAddToCartRateResponse.d.ts.map +1 -0
  76. package/dist/client-analytics/model/getAverageClickPositionResponse.d.ts +6 -6
  77. package/dist/client-analytics/model/getAverageClickPositionResponse.d.ts.map +1 -1
  78. package/dist/client-analytics/model/getClickPositionsResponse.d.ts +3 -3
  79. package/dist/client-analytics/model/getClickPositionsResponse.d.ts.map +1 -1
  80. package/dist/client-analytics/model/getClickThroughRateResponse.d.ts +7 -7
  81. package/dist/client-analytics/model/getClickThroughRateResponse.d.ts.map +1 -1
  82. package/dist/client-analytics/model/getConversionRateResponse.d.ts +20 -0
  83. package/dist/client-analytics/model/getConversionRateResponse.d.ts.map +1 -0
  84. package/dist/client-analytics/model/getNoClickRateResponse.d.ts +6 -6
  85. package/dist/client-analytics/model/getNoClickRateResponse.d.ts.map +1 -1
  86. package/dist/client-analytics/model/getNoResultsRateResponse.d.ts +6 -6
  87. package/dist/client-analytics/model/getNoResultsRateResponse.d.ts.map +1 -1
  88. package/dist/client-analytics/model/getPurchaseRateResponse.d.ts +20 -0
  89. package/dist/client-analytics/model/getPurchaseRateResponse.d.ts.map +1 -0
  90. package/dist/client-analytics/model/getRevenue.d.ts +13 -0
  91. package/dist/client-analytics/model/getRevenue.d.ts.map +1 -0
  92. package/dist/client-analytics/model/getSearchesCountResponse.d.ts +3 -3
  93. package/dist/client-analytics/model/getSearchesCountResponse.d.ts.map +1 -1
  94. package/dist/client-analytics/model/getSearchesNoClicksResponse.d.ts +3 -3
  95. package/dist/client-analytics/model/getSearchesNoClicksResponse.d.ts.map +1 -1
  96. package/dist/client-analytics/model/getSearchesNoResultsResponse.d.ts +3 -3
  97. package/dist/client-analytics/model/getSearchesNoResultsResponse.d.ts.map +1 -1
  98. package/dist/client-analytics/model/getStatusResponse.d.ts +2 -2
  99. package/dist/client-analytics/model/getStatusResponse.d.ts.map +1 -1
  100. package/dist/client-analytics/model/getTopCountriesResponse.d.ts +1 -1
  101. package/dist/client-analytics/model/getTopFilterAttributesResponse.d.ts +1 -1
  102. package/dist/client-analytics/model/getTopFilterForAttribute.d.ts +2 -4
  103. package/dist/client-analytics/model/getTopFilterForAttribute.d.ts.map +1 -1
  104. package/dist/client-analytics/model/getTopFiltersNoResultsResponse.d.ts +2 -2
  105. package/dist/client-analytics/model/getTopFiltersNoResultsResponse.d.ts.map +1 -1
  106. package/dist/client-analytics/model/getTopFiltersNoResultsValue.d.ts +2 -4
  107. package/dist/client-analytics/model/getTopFiltersNoResultsValue.d.ts.map +1 -1
  108. package/dist/client-analytics/model/getTopHitsResponse.d.ts +2 -1
  109. package/dist/client-analytics/model/getTopHitsResponse.d.ts.map +1 -1
  110. package/dist/client-analytics/model/getTopSearchesResponse.d.ts +2 -1
  111. package/dist/client-analytics/model/getTopSearchesResponse.d.ts.map +1 -1
  112. package/dist/client-analytics/model/getUsersCountResponse.d.ts +4 -4
  113. package/dist/client-analytics/model/getUsersCountResponse.d.ts.map +1 -1
  114. package/dist/client-analytics/model/index.d.ts +23 -11
  115. package/dist/client-analytics/model/index.d.ts.map +1 -1
  116. package/dist/client-analytics/model/operator.d.ts +5 -0
  117. package/dist/client-analytics/model/operator.d.ts.map +1 -0
  118. package/dist/client-analytics/model/orderBy.d.ts +1 -1
  119. package/dist/client-analytics/model/topCountry.d.ts +1 -1
  120. package/dist/client-analytics/model/topHit.d.ts +1 -1
  121. package/dist/client-analytics/model/topHitWithAnalytics.d.ts +9 -9
  122. package/dist/client-analytics/model/topHitWithAnalytics.d.ts.map +1 -1
  123. package/dist/client-analytics/model/topHitWithRevenueAnalytics.d.ts +52 -0
  124. package/dist/client-analytics/model/topHitWithRevenueAnalytics.d.ts.map +1 -0
  125. package/dist/client-analytics/model/topHitsResponse.d.ts +1 -1
  126. package/dist/client-analytics/model/topHitsResponseWithAnalytics.d.ts +1 -1
  127. package/dist/client-analytics/model/topHitsResponseWithRevenueAnalytics.d.ts +8 -0
  128. package/dist/client-analytics/model/topHitsResponseWithRevenueAnalytics.d.ts.map +1 -0
  129. package/dist/client-analytics/model/topSearch.d.ts +3 -3
  130. package/dist/client-analytics/model/topSearchWithAnalytics.d.ts +17 -12
  131. package/dist/client-analytics/model/topSearchWithAnalytics.d.ts.map +1 -1
  132. package/dist/client-analytics/model/topSearchWithRevenueAnalytics.d.ts +65 -0
  133. package/dist/client-analytics/model/topSearchWithRevenueAnalytics.d.ts.map +1 -0
  134. package/dist/client-analytics/model/topSearchesResponse.d.ts +1 -1
  135. package/dist/client-analytics/model/topSearchesResponseWithAnalytics.d.ts +1 -1
  136. package/dist/client-analytics/model/topSearchesResponseWithRevenueAnalytics.d.ts +8 -0
  137. package/dist/client-analytics/model/topSearchesResponseWithRevenueAnalytics.d.ts.map +1 -0
  138. package/dist/client-analytics/src/analyticsClient.d.ts +211 -138
  139. package/dist/client-analytics/src/analyticsClient.d.ts.map +1 -1
  140. package/dist/client-personalization/model/clientMethodProps.d.ts +2 -2
  141. package/dist/client-personalization/model/deleteUserProfileResponse.d.ts +2 -2
  142. package/dist/client-personalization/model/eventScoring.d.ts +4 -6
  143. package/dist/client-personalization/model/eventScoring.d.ts.map +1 -1
  144. package/dist/client-personalization/model/eventType.d.ts +5 -0
  145. package/dist/client-personalization/model/eventType.d.ts.map +1 -0
  146. package/dist/client-personalization/model/facetScoring.d.ts +2 -2
  147. package/dist/client-personalization/model/getUserTokenResponse.d.ts +3 -3
  148. package/dist/client-personalization/model/index.d.ts +1 -0
  149. package/dist/client-personalization/model/index.d.ts.map +1 -1
  150. package/dist/client-personalization/model/personalizationStrategyParams.d.ts +3 -3
  151. package/dist/client-personalization/src/personalizationClient.d.ts +19 -19
  152. package/dist/client-personalization/src/personalizationClient.d.ts.map +1 -1
  153. package/dist/client-search/model/acl.d.ts +1 -1
  154. package/dist/client-search/model/action.d.ts +1 -1
  155. package/dist/client-search/model/addApiKeyResponse.d.ts +1 -1
  156. package/dist/client-search/model/anchoring.d.ts +1 -1
  157. package/dist/client-search/model/apiKey.d.ts +8 -8
  158. package/dist/client-search/model/apiKeyOperation.d.ts +2 -0
  159. package/dist/client-search/model/apiKeyOperation.d.ts.map +1 -0
  160. package/dist/client-search/model/aroundPrecision.d.ts +1 -1
  161. package/dist/client-search/model/aroundPrecisionFromValueInner.d.ts +9 -0
  162. package/dist/client-search/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
  163. package/dist/client-search/model/aroundRadius.d.ts +1 -1
  164. package/dist/client-search/model/aroundRadiusAll.d.ts +3 -0
  165. package/dist/client-search/model/aroundRadiusAll.d.ts.map +1 -1
  166. package/dist/client-search/model/automaticFacetFilter.d.ts +4 -4
  167. package/dist/client-search/model/automaticFacetFilters.d.ts +1 -1
  168. package/dist/client-search/model/baseGetApiKeyResponse.d.ts +1 -1
  169. package/dist/client-search/model/baseIndexSettings.d.ts +23 -18
  170. package/dist/client-search/model/baseIndexSettings.d.ts.map +1 -1
  171. package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +26 -29
  172. package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  173. package/dist/client-search/model/baseSearchResponse.d.ts +8 -20
  174. package/dist/client-search/model/baseSearchResponse.d.ts.map +1 -1
  175. package/dist/client-search/model/batchDictionaryEntriesParams.d.ts +3 -3
  176. package/dist/client-search/model/batchResponse.d.ts +2 -2
  177. package/dist/client-search/model/browsePagination.d.ts +19 -0
  178. package/dist/client-search/model/browsePagination.d.ts.map +1 -0
  179. package/dist/client-search/model/browseResponse.d.ts +2 -1
  180. package/dist/client-search/model/browseResponse.d.ts.map +1 -1
  181. package/dist/client-search/model/builtInOperation.d.ts +2 -2
  182. package/dist/client-search/model/builtInOperationType.d.ts +1 -1
  183. package/dist/client-search/model/clientMethodProps.d.ts +137 -70
  184. package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
  185. package/dist/client-search/model/condition.d.ts +7 -3
  186. package/dist/client-search/model/condition.d.ts.map +1 -1
  187. package/dist/client-search/model/consequence.d.ts +5 -5
  188. package/dist/client-search/model/consequenceHide.d.ts +2 -2
  189. package/dist/client-search/model/consequenceQuery.d.ts +1 -1
  190. package/dist/client-search/model/consequenceQueryObject.d.ts +2 -2
  191. package/dist/client-search/model/createdAtResponse.d.ts +1 -1
  192. package/dist/client-search/model/cursor.d.ts +1 -1
  193. package/dist/client-search/model/deleteApiKeyResponse.d.ts +1 -1
  194. package/dist/client-search/model/deleteByParams.d.ts +4 -4
  195. package/dist/client-search/model/deleteSourceResponse.d.ts +1 -1
  196. package/dist/client-search/model/deletedAtResponse.d.ts +2 -2
  197. package/dist/client-search/model/dictionaryEntry.d.ts +6 -8
  198. package/dist/client-search/model/dictionaryEntry.d.ts.map +1 -1
  199. package/dist/client-search/model/dictionaryEntryState.d.ts +1 -1
  200. package/dist/client-search/model/dictionaryLanguage.d.ts +2 -2
  201. package/dist/client-search/model/dictionarySettingsParams.d.ts +1 -1
  202. package/dist/client-search/model/distinct.d.ts +1 -1
  203. package/dist/client-search/model/edit.d.ts +1 -1
  204. package/dist/client-search/model/exactOnSingleWordQuery.d.ts +1 -1
  205. package/dist/client-search/model/facetFilters.d.ts +2 -3
  206. package/dist/client-search/model/facetFilters.d.ts.map +1 -1
  207. package/dist/client-search/model/facetHits.d.ts +2 -2
  208. package/dist/client-search/model/facetOrdering.d.ts +2 -2
  209. package/dist/client-search/model/facets.d.ts +2 -2
  210. package/dist/client-search/model/fetchedIndex.d.ts +5 -1
  211. package/dist/client-search/model/fetchedIndex.d.ts.map +1 -1
  212. package/dist/client-search/model/getObjectsRequest.d.ts +3 -3
  213. package/dist/client-search/model/getObjectsResponse.d.ts +1 -1
  214. package/dist/client-search/model/hasPendingMappingsResponse.d.ts +1 -1
  215. package/dist/client-search/model/highlightResult.d.ts +1 -1
  216. package/dist/client-search/model/highlightResult.d.ts.map +1 -1
  217. package/dist/client-search/model/highlightResultOption.d.ts +3 -3
  218. package/dist/client-search/model/hit.d.ts +4 -4
  219. package/dist/client-search/model/ignorePlurals.d.ts +3 -2
  220. package/dist/client-search/model/ignorePlurals.d.ts.map +1 -1
  221. package/dist/client-search/model/index.d.ts +8 -1
  222. package/dist/client-search/model/index.d.ts.map +1 -1
  223. package/dist/client-search/model/indexSettings.d.ts +1 -1
  224. package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +32 -35
  225. package/dist/client-search/model/indexSettingsAsSearchParams.d.ts.map +1 -1
  226. package/dist/client-search/model/log.d.ts +11 -11
  227. package/dist/client-search/model/logQuery.d.ts +1 -1
  228. package/dist/client-search/model/matchLevel.d.ts +1 -1
  229. package/dist/client-search/model/mode.d.ts +1 -1
  230. package/dist/client-search/model/multipleBatchRequest.d.ts +1 -1
  231. package/dist/client-search/model/multipleBatchResponse.d.ts +2 -2
  232. package/dist/client-search/model/numericFilters.d.ts +2 -3
  233. package/dist/client-search/model/numericFilters.d.ts.map +1 -1
  234. package/dist/client-search/model/operationIndexParams.d.ts +2 -2
  235. package/dist/client-search/model/operationType.d.ts +1 -1
  236. package/dist/client-search/model/optionalFilters.d.ts +2 -3
  237. package/dist/client-search/model/optionalFilters.d.ts.map +1 -1
  238. package/dist/client-search/model/params.d.ts +1 -1
  239. package/dist/client-search/model/promoteObjectID.d.ts +2 -2
  240. package/dist/client-search/model/promoteObjectIDs.d.ts +2 -2
  241. package/dist/client-search/model/queryType.d.ts +1 -1
  242. package/dist/client-search/model/rankingInfo.d.ts +13 -10
  243. package/dist/client-search/model/rankingInfo.d.ts.map +1 -1
  244. package/dist/client-search/model/reRankingApplyFilter.d.ts +2 -3
  245. package/dist/client-search/model/reRankingApplyFilter.d.ts.map +1 -1
  246. package/dist/client-search/model/redirect.d.ts +1 -1
  247. package/dist/client-search/model/redirectURL.d.ts +7 -0
  248. package/dist/client-search/model/redirectURL.d.ts.map +1 -0
  249. package/dist/client-search/model/removeStopWords.d.ts +3 -2
  250. package/dist/client-search/model/removeStopWords.d.ts.map +1 -1
  251. package/dist/client-search/model/removeUserIdResponse.d.ts +1 -1
  252. package/dist/client-search/model/removeWordsIfNoResults.d.ts +1 -1
  253. package/dist/client-search/model/renderingContent.d.ts +3 -1
  254. package/dist/client-search/model/renderingContent.d.ts.map +1 -1
  255. package/dist/client-search/model/replaceAllObjectsResponse.d.ts +11 -0
  256. package/dist/client-search/model/replaceAllObjectsResponse.d.ts.map +1 -0
  257. package/dist/client-search/model/replaceSourceResponse.d.ts +1 -1
  258. package/dist/client-search/model/rule.d.ts +5 -5
  259. package/dist/client-search/model/saveObjectResponse.d.ts +3 -3
  260. package/dist/client-search/model/saveSynonymResponse.d.ts +2 -2
  261. package/dist/client-search/model/searchDictionaryEntriesParams.d.ts +5 -7
  262. package/dist/client-search/model/searchDictionaryEntriesParams.d.ts.map +1 -1
  263. package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts +20 -0
  264. package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
  265. package/dist/client-search/model/searchForFacetValuesRequest.d.ts +1 -1
  266. package/dist/client-search/model/searchForFacetValuesResponse.d.ts +4 -1
  267. package/dist/client-search/model/searchForFacetValuesResponse.d.ts.map +1 -1
  268. package/dist/client-search/model/searchForFacetsOptions.d.ts +2 -2
  269. package/dist/client-search/model/searchForHitsOptions.d.ts +1 -1
  270. package/dist/client-search/model/searchHits.d.ts +6 -3
  271. package/dist/client-search/model/searchHits.d.ts.map +1 -1
  272. package/dist/client-search/model/searchPagination.d.ts +19 -0
  273. package/dist/client-search/model/searchPagination.d.ts.map +1 -0
  274. package/dist/client-search/model/searchParamsObject.d.ts +3 -0
  275. package/dist/client-search/model/searchParamsObject.d.ts.map +1 -1
  276. package/dist/client-search/model/searchParamsQuery.d.ts +1 -1
  277. package/dist/client-search/model/searchResponse.d.ts +2 -1
  278. package/dist/client-search/model/searchResponse.d.ts.map +1 -1
  279. package/dist/client-search/model/searchRulesParams.d.ts +4 -8
  280. package/dist/client-search/model/searchRulesParams.d.ts.map +1 -1
  281. package/dist/client-search/model/searchRulesResponse.d.ts +2 -2
  282. package/dist/client-search/model/searchStrategy.d.ts +1 -1
  283. package/dist/client-search/model/searchSynonymsParams.d.ts +2 -2
  284. package/dist/client-search/model/searchSynonymsResponse.d.ts +2 -2
  285. package/dist/client-search/model/searchUserIdsParams.d.ts +1 -1
  286. package/dist/client-search/model/searchUserIdsResponse.d.ts +3 -3
  287. package/dist/client-search/model/securedApiKeyRestrictions.d.ts +25 -0
  288. package/dist/client-search/model/securedApiKeyRestrictions.d.ts.map +1 -0
  289. package/dist/client-search/model/semanticSearch.d.ts +2 -2
  290. package/dist/client-search/model/snippetResult.d.ts +1 -1
  291. package/dist/client-search/model/snippetResult.d.ts.map +1 -1
  292. package/dist/client-search/model/snippetResultOption.d.ts +2 -2
  293. package/dist/client-search/model/sortRemainingBy.d.ts +1 -1
  294. package/dist/client-search/model/supportedLanguage.d.ts +5 -0
  295. package/dist/client-search/model/supportedLanguage.d.ts.map +1 -0
  296. package/dist/client-search/model/tagFilters.d.ts +2 -3
  297. package/dist/client-search/model/tagFilters.d.ts.map +1 -1
  298. package/dist/client-search/model/taskStatus.d.ts +1 -1
  299. package/dist/client-search/model/timeRange.d.ts +2 -2
  300. package/dist/client-search/model/typoTolerance.d.ts +1 -1
  301. package/dist/client-search/model/typoToleranceEnum.d.ts +3 -0
  302. package/dist/client-search/model/typoToleranceEnum.d.ts.map +1 -1
  303. package/dist/client-search/model/updateApiKeyResponse.d.ts +1 -1
  304. package/dist/client-search/model/updatedAtResponse.d.ts +2 -2
  305. package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts +3 -3
  306. package/dist/client-search/model/updatedRuleResponse.d.ts +3 -3
  307. package/dist/client-search/model/userHit.d.ts +1 -1
  308. package/dist/client-search/model/userId.d.ts +1 -1
  309. package/dist/client-search/model/value.d.ts +5 -1
  310. package/dist/client-search/model/value.d.ts.map +1 -1
  311. package/dist/client-search/src/searchClient.d.ts +385 -208
  312. package/dist/client-search/src/searchClient.d.ts.map +1 -1
  313. package/dist/lite/builds/browser.d.ts +15 -3
  314. package/dist/lite/builds/browser.d.ts.map +1 -1
  315. package/dist/lite/builds/node.d.ts +15 -3
  316. package/dist/lite/builds/node.d.ts.map +1 -1
  317. package/dist/lite/lite.cjs +45 -6
  318. package/dist/lite/lite.esm.browser.js +59 -30
  319. package/dist/lite/lite.esm.node.js +45 -6
  320. package/dist/lite/lite.umd.js +2 -2
  321. package/dist/lite/model/acl.d.ts +1 -1
  322. package/dist/lite/model/apiKey.d.ts +8 -8
  323. package/dist/lite/model/aroundPrecision.d.ts +1 -1
  324. package/dist/lite/model/aroundPrecisionFromValueInner.d.ts +9 -0
  325. package/dist/lite/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
  326. package/dist/lite/model/aroundRadius.d.ts +1 -1
  327. package/dist/lite/model/aroundRadiusAll.d.ts +3 -0
  328. package/dist/lite/model/aroundRadiusAll.d.ts.map +1 -1
  329. package/dist/lite/model/automaticFacetFilter.d.ts +4 -4
  330. package/dist/lite/model/automaticFacetFilters.d.ts +1 -1
  331. package/dist/lite/model/baseGetApiKeyResponse.d.ts +1 -1
  332. package/dist/lite/model/baseIndexSettings.d.ts +23 -18
  333. package/dist/lite/model/baseIndexSettings.d.ts.map +1 -1
  334. package/dist/lite/model/baseRecommendRequest.d.ts +17 -0
  335. package/dist/lite/model/baseRecommendRequest.d.ts.map +1 -0
  336. package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +26 -29
  337. package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  338. package/dist/lite/model/baseSearchResponse.d.ts +8 -20
  339. package/dist/lite/model/baseSearchResponse.d.ts.map +1 -1
  340. package/dist/lite/model/boughtTogetherQuery.d.ts +4 -0
  341. package/dist/lite/model/boughtTogetherQuery.d.ts.map +1 -0
  342. package/dist/lite/model/browsePagination.d.ts +19 -0
  343. package/dist/lite/model/browsePagination.d.ts.map +1 -0
  344. package/dist/lite/model/browseResponse.d.ts +2 -1
  345. package/dist/lite/model/browseResponse.d.ts.map +1 -1
  346. package/dist/lite/model/clientMethodProps.d.ts +7 -0
  347. package/dist/lite/model/clientMethodProps.d.ts.map +1 -1
  348. package/dist/lite/model/consequenceQuery.d.ts +1 -1
  349. package/dist/lite/model/consequenceQueryObject.d.ts +2 -2
  350. package/dist/lite/model/cursor.d.ts +1 -1
  351. package/dist/lite/model/distinct.d.ts +1 -1
  352. package/dist/lite/model/edit.d.ts +1 -1
  353. package/dist/lite/model/exactOnSingleWordQuery.d.ts +1 -1
  354. package/dist/lite/model/facetFilters.d.ts +2 -3
  355. package/dist/lite/model/facetFilters.d.ts.map +1 -1
  356. package/dist/lite/model/facetHits.d.ts +2 -2
  357. package/dist/lite/model/facetOrdering.d.ts +2 -2
  358. package/dist/lite/model/facets.d.ts +2 -2
  359. package/dist/lite/model/fallbackParams.d.ts +3 -0
  360. package/dist/lite/model/fallbackParams.d.ts.map +1 -0
  361. package/dist/lite/model/fbtModel.d.ts +5 -0
  362. package/dist/lite/model/fbtModel.d.ts.map +1 -0
  363. package/dist/lite/model/frequentlyBoughtTogether.d.ts +9 -0
  364. package/dist/lite/model/frequentlyBoughtTogether.d.ts.map +1 -0
  365. package/dist/lite/model/getRecommendationsParams.d.ts +11 -0
  366. package/dist/lite/model/getRecommendationsParams.d.ts.map +1 -0
  367. package/dist/lite/model/getRecommendationsResponse.d.ts +5 -0
  368. package/dist/lite/model/getRecommendationsResponse.d.ts.map +1 -0
  369. package/dist/lite/model/highlightResult.d.ts +1 -1
  370. package/dist/lite/model/highlightResult.d.ts.map +1 -1
  371. package/dist/lite/model/highlightResultOption.d.ts +3 -3
  372. package/dist/lite/model/hit.d.ts +4 -4
  373. package/dist/lite/model/ignorePlurals.d.ts +3 -2
  374. package/dist/lite/model/ignorePlurals.d.ts.map +1 -1
  375. package/dist/lite/model/index.d.ts +32 -37
  376. package/dist/lite/model/index.d.ts.map +1 -1
  377. package/dist/lite/model/indexSettings.d.ts +1 -1
  378. package/dist/lite/model/indexSettingsAsSearchParams.d.ts +32 -35
  379. package/dist/lite/model/indexSettingsAsSearchParams.d.ts.map +1 -1
  380. package/dist/lite/model/lookingSimilar.d.ts +11 -0
  381. package/dist/lite/model/lookingSimilar.d.ts.map +1 -0
  382. package/dist/lite/model/lookingSimilarModel.d.ts +5 -0
  383. package/dist/lite/model/lookingSimilarModel.d.ts.map +1 -0
  384. package/dist/lite/model/lookingSimilarQuery.d.ts +4 -0
  385. package/dist/lite/model/lookingSimilarQuery.d.ts.map +1 -0
  386. package/dist/lite/model/matchLevel.d.ts +1 -1
  387. package/dist/lite/model/mode.d.ts +1 -1
  388. package/dist/lite/model/numericFilters.d.ts +2 -3
  389. package/dist/lite/model/numericFilters.d.ts.map +1 -1
  390. package/dist/lite/model/optionalFilters.d.ts +2 -3
  391. package/dist/lite/model/optionalFilters.d.ts.map +1 -1
  392. package/dist/lite/model/params.d.ts +1 -1
  393. package/dist/lite/model/queryType.d.ts +1 -1
  394. package/dist/lite/model/rankingInfo.d.ts +13 -10
  395. package/dist/lite/model/rankingInfo.d.ts.map +1 -1
  396. package/dist/lite/model/reRankingApplyFilter.d.ts +2 -3
  397. package/dist/lite/model/reRankingApplyFilter.d.ts.map +1 -1
  398. package/dist/lite/model/recommendHit.d.ts +27 -0
  399. package/dist/lite/model/recommendHit.d.ts.map +1 -0
  400. package/dist/lite/model/recommendationsHit.d.ts +4 -0
  401. package/dist/lite/model/recommendationsHit.d.ts.map +1 -0
  402. package/dist/lite/model/recommendationsHits.d.ts +5 -0
  403. package/dist/lite/model/recommendationsHits.d.ts.map +1 -0
  404. package/dist/lite/model/recommendationsRequest.d.ts +8 -0
  405. package/dist/lite/model/recommendationsRequest.d.ts.map +1 -0
  406. package/dist/lite/model/recommendationsResults.d.ts +5 -0
  407. package/dist/lite/model/recommendationsResults.d.ts.map +1 -0
  408. package/dist/lite/model/recommendedForYou.d.ts +7 -0
  409. package/dist/lite/model/recommendedForYou.d.ts.map +1 -0
  410. package/dist/lite/model/recommendedForYouModel.d.ts +5 -0
  411. package/dist/lite/model/recommendedForYouModel.d.ts.map +1 -0
  412. package/dist/lite/model/recommendedForYouQuery.d.ts +4 -0
  413. package/dist/lite/model/recommendedForYouQuery.d.ts.map +1 -0
  414. package/dist/lite/model/redirect.d.ts +1 -1
  415. package/dist/lite/model/redirectURL.d.ts +7 -0
  416. package/dist/lite/model/redirectURL.d.ts.map +1 -0
  417. package/dist/lite/model/relatedModel.d.ts +5 -0
  418. package/dist/lite/model/relatedModel.d.ts.map +1 -0
  419. package/dist/lite/model/relatedProducts.d.ts +11 -0
  420. package/dist/lite/model/relatedProducts.d.ts.map +1 -0
  421. package/dist/lite/model/relatedQuery.d.ts +4 -0
  422. package/dist/lite/model/relatedQuery.d.ts.map +1 -0
  423. package/dist/lite/model/removeStopWords.d.ts +3 -2
  424. package/dist/lite/model/removeStopWords.d.ts.map +1 -1
  425. package/dist/lite/model/removeWordsIfNoResults.d.ts +1 -1
  426. package/dist/lite/model/renderingContent.d.ts +3 -1
  427. package/dist/lite/model/renderingContent.d.ts.map +1 -1
  428. package/dist/lite/model/searchForFacetValuesResponse.d.ts +4 -1
  429. package/dist/lite/model/searchForFacetValuesResponse.d.ts.map +1 -1
  430. package/dist/lite/model/searchForFacetsOptions.d.ts +2 -2
  431. package/dist/lite/model/searchForHitsOptions.d.ts +1 -1
  432. package/dist/lite/model/searchHits.d.ts +6 -3
  433. package/dist/lite/model/searchHits.d.ts.map +1 -1
  434. package/dist/lite/model/searchPagination.d.ts +19 -0
  435. package/dist/lite/model/searchPagination.d.ts.map +1 -0
  436. package/dist/lite/model/searchParams.d.ts +1 -2
  437. package/dist/lite/model/searchParams.d.ts.map +1 -1
  438. package/dist/lite/model/searchParamsObject.d.ts +3 -0
  439. package/dist/lite/model/searchParamsObject.d.ts.map +1 -1
  440. package/dist/lite/model/searchParamsQuery.d.ts +1 -1
  441. package/dist/lite/model/searchResponse.d.ts +2 -1
  442. package/dist/lite/model/searchResponse.d.ts.map +1 -1
  443. package/dist/lite/model/searchStrategy.d.ts +1 -1
  444. package/dist/lite/model/semanticSearch.d.ts +2 -2
  445. package/dist/lite/model/snippetResult.d.ts +1 -1
  446. package/dist/lite/model/snippetResult.d.ts.map +1 -1
  447. package/dist/lite/model/snippetResultOption.d.ts +2 -2
  448. package/dist/lite/model/sortRemainingBy.d.ts +1 -1
  449. package/dist/lite/model/supportedLanguage.d.ts +5 -0
  450. package/dist/lite/model/supportedLanguage.d.ts.map +1 -0
  451. package/dist/lite/model/tagFilters.d.ts +2 -3
  452. package/dist/lite/model/tagFilters.d.ts.map +1 -1
  453. package/dist/lite/model/trendingFacetHit.d.ts +18 -0
  454. package/dist/lite/model/trendingFacetHit.d.ts.map +1 -0
  455. package/dist/lite/model/trendingFacets.d.ts +11 -0
  456. package/dist/lite/model/trendingFacets.d.ts.map +1 -0
  457. package/dist/lite/model/trendingFacetsModel.d.ts +5 -0
  458. package/dist/lite/model/trendingFacetsModel.d.ts.map +1 -0
  459. package/dist/lite/model/trendingFacetsQuery.d.ts +4 -0
  460. package/dist/lite/model/trendingFacetsQuery.d.ts.map +1 -0
  461. package/dist/lite/model/trendingItems.d.ts +15 -0
  462. package/dist/lite/model/trendingItems.d.ts.map +1 -0
  463. package/dist/lite/model/trendingItemsModel.d.ts +5 -0
  464. package/dist/lite/model/trendingItemsModel.d.ts.map +1 -0
  465. package/dist/lite/model/trendingItemsQuery.d.ts +4 -0
  466. package/dist/lite/model/trendingItemsQuery.d.ts.map +1 -0
  467. package/dist/lite/model/typoTolerance.d.ts +1 -1
  468. package/dist/lite/model/typoToleranceEnum.d.ts +3 -0
  469. package/dist/lite/model/typoToleranceEnum.d.ts.map +1 -1
  470. package/dist/lite/model/value.d.ts +5 -1
  471. package/dist/lite/model/value.d.ts.map +1 -1
  472. package/dist/lite/src/liteClient.d.ts +19 -10
  473. package/dist/lite/src/liteClient.d.ts.map +1 -1
  474. package/dist/recommend/model/advancedSyntaxFeatures.d.ts +2 -0
  475. package/dist/recommend/model/advancedSyntaxFeatures.d.ts.map +1 -0
  476. package/dist/recommend/model/alternativesAsExact.d.ts +2 -0
  477. package/dist/recommend/model/alternativesAsExact.d.ts.map +1 -0
  478. package/dist/recommend/model/aroundPrecision.d.ts +6 -0
  479. package/dist/recommend/model/aroundPrecision.d.ts.map +1 -0
  480. package/dist/recommend/model/aroundPrecisionFromValueInner.d.ts +14 -0
  481. package/dist/recommend/model/aroundPrecisionFromValueInner.d.ts.map +1 -0
  482. package/dist/recommend/model/aroundRadius.d.ts +6 -0
  483. package/dist/recommend/model/aroundRadius.d.ts.map +1 -0
  484. package/dist/recommend/model/aroundRadiusAll.d.ts +5 -0
  485. package/dist/recommend/model/aroundRadiusAll.d.ts.map +1 -0
  486. package/dist/recommend/model/autoFacetFilter.d.ts +14 -0
  487. package/dist/recommend/model/autoFacetFilter.d.ts.map +1 -0
  488. package/dist/recommend/model/baseRecommendRequest.d.ts +17 -0
  489. package/dist/recommend/model/baseRecommendRequest.d.ts.map +1 -0
  490. package/dist/recommend/model/baseSearchParams.d.ts +4 -0
  491. package/dist/recommend/model/baseSearchParams.d.ts.map +1 -0
  492. package/dist/recommend/model/baseSearchParamsWithoutQuery.d.ts +116 -0
  493. package/dist/recommend/model/baseSearchParamsWithoutQuery.d.ts.map +1 -0
  494. package/dist/recommend/model/baseSearchResponse.d.ts +94 -0
  495. package/dist/recommend/model/baseSearchResponse.d.ts.map +1 -0
  496. package/dist/recommend/model/boughtTogetherQuery.d.ts +4 -0
  497. package/dist/recommend/model/boughtTogetherQuery.d.ts.map +1 -0
  498. package/dist/recommend/model/clientMethodProps.d.ts +135 -0
  499. package/dist/recommend/model/clientMethodProps.d.ts.map +1 -0
  500. package/dist/recommend/model/condition.d.ts +14 -0
  501. package/dist/recommend/model/condition.d.ts.map +1 -0
  502. package/dist/recommend/model/consequence.d.ts +18 -0
  503. package/dist/recommend/model/consequence.d.ts.map +1 -0
  504. package/dist/recommend/model/deletedAtResponse.d.ts +14 -0
  505. package/dist/recommend/model/deletedAtResponse.d.ts.map +1 -0
  506. package/dist/recommend/model/distinct.d.ts +5 -0
  507. package/dist/recommend/model/distinct.d.ts.map +1 -0
  508. package/dist/recommend/model/errorBase.d.ts +7 -0
  509. package/dist/recommend/model/errorBase.d.ts.map +1 -0
  510. package/dist/recommend/model/exactOnSingleWordQuery.d.ts +5 -0
  511. package/dist/recommend/model/exactOnSingleWordQuery.d.ts.map +1 -0
  512. package/dist/recommend/model/exhaustive.d.ts +26 -0
  513. package/dist/recommend/model/exhaustive.d.ts.map +1 -0
  514. package/dist/recommend/model/facetFilters.d.ts +5 -0
  515. package/dist/recommend/model/facetFilters.d.ts.map +1 -0
  516. package/dist/recommend/model/facetOrdering.d.ts +13 -0
  517. package/dist/recommend/model/facetOrdering.d.ts.map +1 -0
  518. package/dist/recommend/model/facets.d.ts +10 -0
  519. package/dist/recommend/model/facets.d.ts.map +1 -0
  520. package/dist/recommend/model/facetsStats.d.ts +19 -0
  521. package/dist/recommend/model/facetsStats.d.ts.map +1 -0
  522. package/dist/recommend/model/fallbackParams.d.ts +3 -0
  523. package/dist/recommend/model/fallbackParams.d.ts.map +1 -0
  524. package/dist/recommend/model/fbtModel.d.ts +5 -0
  525. package/dist/recommend/model/fbtModel.d.ts.map +1 -0
  526. package/dist/recommend/model/frequentlyBoughtTogether.d.ts +9 -0
  527. package/dist/recommend/model/frequentlyBoughtTogether.d.ts.map +1 -0
  528. package/dist/recommend/model/getRecommendTaskResponse.d.ts +5 -0
  529. package/dist/recommend/model/getRecommendTaskResponse.d.ts.map +1 -0
  530. package/dist/recommend/model/getRecommendationsParams.d.ts +11 -0
  531. package/dist/recommend/model/getRecommendationsParams.d.ts.map +1 -0
  532. package/dist/recommend/model/getRecommendationsResponse.d.ts +5 -0
  533. package/dist/recommend/model/getRecommendationsResponse.d.ts.map +1 -0
  534. package/dist/recommend/model/hideConsequenceObject.d.ts +10 -0
  535. package/dist/recommend/model/hideConsequenceObject.d.ts.map +1 -0
  536. package/dist/recommend/model/highlightResult.d.ts +3 -0
  537. package/dist/recommend/model/highlightResult.d.ts.map +1 -0
  538. package/dist/recommend/model/highlightResultOption.d.ts +20 -0
  539. package/dist/recommend/model/highlightResultOption.d.ts.map +1 -0
  540. package/dist/recommend/model/ignorePlurals.d.ts +6 -0
  541. package/dist/recommend/model/ignorePlurals.d.ts.map +1 -0
  542. package/dist/recommend/model/index.d.ts +94 -0
  543. package/dist/recommend/model/index.d.ts.map +1 -0
  544. package/dist/recommend/model/indexSettingsAsSearchParams.d.ts +160 -0
  545. package/dist/recommend/model/indexSettingsAsSearchParams.d.ts.map +1 -0
  546. package/dist/recommend/model/lookingSimilar.d.ts +11 -0
  547. package/dist/recommend/model/lookingSimilar.d.ts.map +1 -0
  548. package/dist/recommend/model/lookingSimilarModel.d.ts +5 -0
  549. package/dist/recommend/model/lookingSimilarModel.d.ts.map +1 -0
  550. package/dist/recommend/model/lookingSimilarQuery.d.ts +4 -0
  551. package/dist/recommend/model/lookingSimilarQuery.d.ts.map +1 -0
  552. package/dist/recommend/model/matchLevel.d.ts +5 -0
  553. package/dist/recommend/model/matchLevel.d.ts.map +1 -0
  554. package/dist/recommend/model/matchedGeoLocation.d.ts +15 -0
  555. package/dist/recommend/model/matchedGeoLocation.d.ts.map +1 -0
  556. package/dist/recommend/model/mode.d.ts +5 -0
  557. package/dist/recommend/model/mode.d.ts.map +1 -0
  558. package/dist/recommend/model/numericFilters.d.ts +5 -0
  559. package/dist/recommend/model/numericFilters.d.ts.map +1 -0
  560. package/dist/recommend/model/optionalFilters.d.ts +5 -0
  561. package/dist/recommend/model/optionalFilters.d.ts.map +1 -0
  562. package/dist/recommend/model/paramsConsequence.d.ts +19 -0
  563. package/dist/recommend/model/paramsConsequence.d.ts.map +1 -0
  564. package/dist/recommend/model/personalization.d.ts +15 -0
  565. package/dist/recommend/model/personalization.d.ts.map +1 -0
  566. package/dist/recommend/model/promoteConsequenceObject.d.ts +14 -0
  567. package/dist/recommend/model/promoteConsequenceObject.d.ts.map +1 -0
  568. package/dist/recommend/model/queryType.d.ts +5 -0
  569. package/dist/recommend/model/queryType.d.ts.map +1 -0
  570. package/dist/recommend/model/rankingInfo.d.ts +54 -0
  571. package/dist/recommend/model/rankingInfo.d.ts.map +1 -0
  572. package/dist/recommend/model/reRankingApplyFilter.d.ts +5 -0
  573. package/dist/recommend/model/reRankingApplyFilter.d.ts.map +1 -0
  574. package/dist/recommend/model/recommendHit.d.ts +27 -0
  575. package/dist/recommend/model/recommendHit.d.ts.map +1 -0
  576. package/dist/recommend/model/recommendModels.d.ts +2 -0
  577. package/dist/recommend/model/recommendModels.d.ts.map +1 -0
  578. package/dist/recommend/model/recommendRule.d.ts +24 -0
  579. package/dist/recommend/model/recommendRule.d.ts.map +1 -0
  580. package/dist/recommend/model/recommendRuleMetadata.d.ts +10 -0
  581. package/dist/recommend/model/recommendRuleMetadata.d.ts.map +1 -0
  582. package/dist/recommend/model/recommendationsHit.d.ts +4 -0
  583. package/dist/recommend/model/recommendationsHit.d.ts.map +1 -0
  584. package/dist/recommend/model/recommendationsHits.d.ts +5 -0
  585. package/dist/recommend/model/recommendationsHits.d.ts.map +1 -0
  586. package/dist/recommend/model/recommendationsRequest.d.ts +8 -0
  587. package/dist/recommend/model/recommendationsRequest.d.ts.map +1 -0
  588. package/dist/recommend/model/recommendationsResults.d.ts +5 -0
  589. package/dist/recommend/model/recommendationsResults.d.ts.map +1 -0
  590. package/dist/recommend/model/recommendedForYou.d.ts +7 -0
  591. package/dist/recommend/model/recommendedForYou.d.ts.map +1 -0
  592. package/dist/recommend/model/recommendedForYouModel.d.ts +5 -0
  593. package/dist/recommend/model/recommendedForYouModel.d.ts.map +1 -0
  594. package/dist/recommend/model/recommendedForYouQuery.d.ts +4 -0
  595. package/dist/recommend/model/recommendedForYouQuery.d.ts.map +1 -0
  596. package/dist/recommend/model/redirect.d.ts +8 -0
  597. package/dist/recommend/model/redirect.d.ts.map +1 -0
  598. package/dist/recommend/model/redirectRuleIndexMetadata.d.ts +21 -0
  599. package/dist/recommend/model/redirectRuleIndexMetadata.d.ts.map +1 -0
  600. package/dist/recommend/model/redirectRuleIndexMetadataData.d.ts +7 -0
  601. package/dist/recommend/model/redirectRuleIndexMetadataData.d.ts.map +1 -0
  602. package/dist/recommend/model/redirectURL.d.ts +7 -0
  603. package/dist/recommend/model/redirectURL.d.ts.map +1 -0
  604. package/dist/recommend/model/relatedModel.d.ts +5 -0
  605. package/dist/recommend/model/relatedModel.d.ts.map +1 -0
  606. package/dist/recommend/model/relatedProducts.d.ts +11 -0
  607. package/dist/recommend/model/relatedProducts.d.ts.map +1 -0
  608. package/dist/recommend/model/relatedQuery.d.ts +4 -0
  609. package/dist/recommend/model/relatedQuery.d.ts.map +1 -0
  610. package/dist/recommend/model/removeStopWords.d.ts +6 -0
  611. package/dist/recommend/model/removeStopWords.d.ts.map +1 -0
  612. package/dist/recommend/model/removeWordsIfNoResults.d.ts +5 -0
  613. package/dist/recommend/model/removeWordsIfNoResults.d.ts.map +1 -0
  614. package/dist/recommend/model/renderingContent.d.ts +10 -0
  615. package/dist/recommend/model/renderingContent.d.ts.map +1 -0
  616. package/dist/recommend/model/searchPagination.d.ts +19 -0
  617. package/dist/recommend/model/searchPagination.d.ts.map +1 -0
  618. package/dist/recommend/model/searchParams.d.ts +3 -0
  619. package/dist/recommend/model/searchParams.d.ts.map +1 -0
  620. package/dist/recommend/model/searchParamsObject.d.ts +7 -0
  621. package/dist/recommend/model/searchParamsObject.d.ts.map +1 -0
  622. package/dist/recommend/model/searchParamsQuery.d.ts +7 -0
  623. package/dist/recommend/model/searchParamsQuery.d.ts.map +1 -0
  624. package/dist/recommend/model/searchRecommendRulesParams.d.ts +38 -0
  625. package/dist/recommend/model/searchRecommendRulesParams.d.ts.map +1 -0
  626. package/dist/recommend/model/searchRecommendRulesResponse.d.ts +20 -0
  627. package/dist/recommend/model/searchRecommendRulesResponse.d.ts.map +1 -0
  628. package/dist/recommend/model/semanticSearch.d.ts +10 -0
  629. package/dist/recommend/model/semanticSearch.d.ts.map +1 -0
  630. package/dist/recommend/model/snippetResult.d.ts +3 -0
  631. package/dist/recommend/model/snippetResult.d.ts.map +1 -0
  632. package/dist/recommend/model/snippetResultOption.d.ts +12 -0
  633. package/dist/recommend/model/snippetResultOption.d.ts.map +1 -0
  634. package/dist/recommend/model/sortRemainingBy.d.ts +5 -0
  635. package/dist/recommend/model/sortRemainingBy.d.ts.map +1 -0
  636. package/dist/recommend/model/supportedLanguage.d.ts +5 -0
  637. package/dist/recommend/model/supportedLanguage.d.ts.map +1 -0
  638. package/dist/recommend/model/tagFilters.d.ts +5 -0
  639. package/dist/recommend/model/tagFilters.d.ts.map +1 -0
  640. package/dist/recommend/model/taskStatus.d.ts +5 -0
  641. package/dist/recommend/model/taskStatus.d.ts.map +1 -0
  642. package/dist/recommend/model/trendingFacetHit.d.ts +18 -0
  643. package/dist/recommend/model/trendingFacetHit.d.ts.map +1 -0
  644. package/dist/recommend/model/trendingFacets.d.ts +11 -0
  645. package/dist/recommend/model/trendingFacets.d.ts.map +1 -0
  646. package/dist/recommend/model/trendingFacetsModel.d.ts +5 -0
  647. package/dist/recommend/model/trendingFacetsModel.d.ts.map +1 -0
  648. package/dist/recommend/model/trendingFacetsQuery.d.ts +4 -0
  649. package/dist/recommend/model/trendingFacetsQuery.d.ts.map +1 -0
  650. package/dist/recommend/model/trendingItems.d.ts +15 -0
  651. package/dist/recommend/model/trendingItems.d.ts.map +1 -0
  652. package/dist/recommend/model/trendingItemsModel.d.ts +5 -0
  653. package/dist/recommend/model/trendingItemsModel.d.ts.map +1 -0
  654. package/dist/recommend/model/trendingItemsQuery.d.ts +4 -0
  655. package/dist/recommend/model/trendingItemsQuery.d.ts.map +1 -0
  656. package/dist/recommend/model/typoTolerance.d.ts +6 -0
  657. package/dist/recommend/model/typoTolerance.d.ts.map +1 -0
  658. package/dist/recommend/model/typoToleranceEnum.d.ts +5 -0
  659. package/dist/recommend/model/typoToleranceEnum.d.ts.map +1 -0
  660. package/dist/recommend/model/value.d.ts +13 -0
  661. package/dist/recommend/model/value.d.ts.map +1 -0
  662. package/dist/recommend/src/recommendClient.d.ts +132 -0
  663. package/dist/recommend/src/recommendClient.d.ts.map +1 -0
  664. package/lite/builds/browser.ts +11 -6
  665. package/lite/builds/node.ts +10 -5
  666. package/lite/model/acl.ts +1 -1
  667. package/lite/model/apiKey.ts +8 -8
  668. package/lite/model/aroundPrecision.ts +1 -1
  669. package/lite/model/aroundPrecisionFromValueInner.ts +9 -0
  670. package/lite/model/aroundRadius.ts +1 -1
  671. package/lite/model/aroundRadiusAll.ts +3 -0
  672. package/lite/model/automaticFacetFilter.ts +4 -4
  673. package/lite/model/automaticFacetFilters.ts +1 -1
  674. package/lite/model/baseGetApiKeyResponse.ts +1 -1
  675. package/lite/model/baseIndexSettings.ts +25 -18
  676. package/lite/model/baseRecommendRequest.ts +22 -0
  677. package/lite/model/baseSearchParamsWithoutQuery.ts +26 -30
  678. package/lite/model/baseSearchResponse.ts +9 -24
  679. package/lite/model/boughtTogetherQuery.ts +7 -0
  680. package/lite/model/browsePagination.ts +23 -0
  681. package/lite/model/browseResponse.ts +2 -0
  682. package/lite/model/clientMethodProps.ts +8 -0
  683. package/lite/model/consequenceQuery.ts +1 -1
  684. package/lite/model/consequenceQueryObject.ts +2 -2
  685. package/lite/model/cursor.ts +1 -1
  686. package/lite/model/distinct.ts +1 -1
  687. package/lite/model/edit.ts +1 -1
  688. package/lite/model/exactOnSingleWordQuery.ts +1 -1
  689. package/lite/model/facetFilters.ts +2 -4
  690. package/lite/model/facetHits.ts +2 -2
  691. package/lite/model/facetOrdering.ts +2 -2
  692. package/lite/model/facets.ts +2 -2
  693. package/lite/model/{attributeToUpdate.ts → fallbackParams.ts} +2 -2
  694. package/lite/model/fbtModel.ts +6 -0
  695. package/lite/model/{consequenceHide.ts → frequentlyBoughtTogether.ts} +6 -5
  696. package/lite/model/getRecommendationsParams.ts +13 -0
  697. package/lite/model/getRecommendationsResponse.ts +7 -0
  698. package/lite/model/highlightResult.ts +1 -0
  699. package/lite/model/highlightResultOption.ts +3 -3
  700. package/lite/model/hit.ts +4 -4
  701. package/lite/model/ignorePlurals.ts +4 -2
  702. package/lite/model/index.ts +32 -37
  703. package/lite/model/indexSettings.ts +1 -1
  704. package/lite/model/indexSettingsAsSearchParams.ts +32 -36
  705. package/lite/model/lookingSimilar.ts +15 -0
  706. package/lite/model/lookingSimilarModel.ts +6 -0
  707. package/lite/model/lookingSimilarQuery.ts +6 -0
  708. package/lite/model/matchLevel.ts +1 -1
  709. package/lite/model/mode.ts +1 -1
  710. package/lite/model/numericFilters.ts +2 -4
  711. package/lite/model/optionalFilters.ts +2 -4
  712. package/lite/model/params.ts +1 -1
  713. package/lite/model/queryType.ts +1 -1
  714. package/lite/model/rankingInfo.ts +13 -10
  715. package/lite/model/reRankingApplyFilter.ts +2 -4
  716. package/lite/model/recommendHit.ts +34 -0
  717. package/lite/model/{promote.ts → recommendationsHit.ts} +3 -3
  718. package/lite/model/{searchParamsString.ts → recommendationsHits.ts} +4 -5
  719. package/lite/model/recommendationsRequest.ts +16 -0
  720. package/lite/model/recommendationsResults.ts +9 -0
  721. package/lite/model/recommendedForYou.ts +10 -0
  722. package/lite/model/{operationType.ts → recommendedForYouModel.ts} +2 -2
  723. package/lite/model/recommendedForYouQuery.ts +6 -0
  724. package/lite/model/redirect.ts +1 -1
  725. package/lite/model/{dictionaryAction.ts → redirectURL.ts} +4 -2
  726. package/lite/model/relatedModel.ts +6 -0
  727. package/lite/model/relatedProducts.ts +15 -0
  728. package/lite/model/relatedQuery.ts +6 -0
  729. package/lite/model/removeStopWords.ts +4 -2
  730. package/lite/model/removeWordsIfNoResults.ts +1 -1
  731. package/lite/model/renderingContent.ts +4 -1
  732. package/lite/model/searchForFacetValuesResponse.ts +4 -1
  733. package/lite/model/searchForFacetsOptions.ts +2 -2
  734. package/lite/model/searchForHitsOptions.ts +1 -1
  735. package/lite/model/searchHits.ts +6 -3
  736. package/lite/model/searchPagination.ts +23 -0
  737. package/lite/model/searchParams.ts +1 -2
  738. package/lite/model/searchParamsObject.ts +3 -0
  739. package/lite/model/searchParamsQuery.ts +1 -1
  740. package/lite/model/searchResponse.ts +3 -1
  741. package/lite/model/searchStrategy.ts +1 -1
  742. package/lite/model/semanticSearch.ts +2 -2
  743. package/lite/model/snippetResult.ts +2 -1
  744. package/lite/model/snippetResultOption.ts +2 -2
  745. package/lite/model/sortRemainingBy.ts +1 -1
  746. package/lite/model/supportedLanguage.ts +74 -0
  747. package/lite/model/tagFilters.ts +2 -4
  748. package/lite/model/trendingFacetHit.ts +21 -0
  749. package/lite/model/trendingFacets.ts +15 -0
  750. package/lite/model/trendingFacetsModel.ts +6 -0
  751. package/lite/model/trendingFacetsQuery.ts +6 -0
  752. package/lite/model/trendingItems.ts +20 -0
  753. package/lite/model/{dictionaryEntryState.ts → trendingItemsModel.ts} +2 -2
  754. package/lite/model/trendingItemsQuery.ts +6 -0
  755. package/lite/model/typoTolerance.ts +1 -1
  756. package/lite/model/typoToleranceEnum.ts +3 -0
  757. package/lite/model/value.ts +6 -1
  758. package/lite/src/liteClient.ts +64 -12
  759. package/package.json +19 -15
  760. package/dist/client-abtesting/model/currenciesValue.d.ts.map +0 -1
  761. package/dist/client-analytics/model/averageClickEvent.d.ts +0 -15
  762. package/dist/client-analytics/model/averageClickEvent.d.ts.map +0 -1
  763. package/dist/client-analytics/model/clickPosition.d.ts +0 -11
  764. package/dist/client-analytics/model/clickPosition.d.ts.map +0 -1
  765. package/dist/client-analytics/model/clickThroughRateEvent.d.ts +0 -19
  766. package/dist/client-analytics/model/clickThroughRateEvent.d.ts.map +0 -1
  767. package/dist/client-analytics/model/conversionRateEvent.d.ts +0 -19
  768. package/dist/client-analytics/model/conversionRateEvent.d.ts.map +0 -1
  769. package/dist/client-analytics/model/getConversationRateResponse.d.ts +0 -20
  770. package/dist/client-analytics/model/getConversationRateResponse.d.ts.map +0 -1
  771. package/dist/client-analytics/model/noClickRateEvent.d.ts +0 -19
  772. package/dist/client-analytics/model/noClickRateEvent.d.ts.map +0 -1
  773. package/dist/client-analytics/model/noResultsRateEvent.d.ts +0 -19
  774. package/dist/client-analytics/model/noResultsRateEvent.d.ts.map +0 -1
  775. package/dist/client-analytics/model/searchEvent.d.ts +0 -11
  776. package/dist/client-analytics/model/searchEvent.d.ts.map +0 -1
  777. package/dist/client-analytics/model/searchNoClickEvent.d.ts +0 -15
  778. package/dist/client-analytics/model/searchNoClickEvent.d.ts.map +0 -1
  779. package/dist/client-analytics/model/searchNoResultEvent.d.ts +0 -15
  780. package/dist/client-analytics/model/searchNoResultEvent.d.ts.map +0 -1
  781. package/dist/client-analytics/model/userWithDate.d.ts +0 -11
  782. package/dist/client-analytics/model/userWithDate.d.ts.map +0 -1
  783. package/dist/client-search/model/mixedSearchFilters.d.ts +0 -2
  784. package/dist/client-search/model/mixedSearchFilters.d.ts.map +0 -1
  785. package/dist/lite/model/action.d.ts +0 -5
  786. package/dist/lite/model/action.d.ts.map +0 -1
  787. package/dist/lite/model/addApiKeyResponse.d.ts +0 -11
  788. package/dist/lite/model/addApiKeyResponse.d.ts.map +0 -1
  789. package/dist/lite/model/anchoring.d.ts +0 -5
  790. package/dist/lite/model/anchoring.d.ts.map +0 -1
  791. package/dist/lite/model/attributeToUpdate.d.ts +0 -3
  792. package/dist/lite/model/attributeToUpdate.d.ts.map +0 -1
  793. package/dist/lite/model/browseParams.d.ts +0 -4
  794. package/dist/lite/model/browseParams.d.ts.map +0 -1
  795. package/dist/lite/model/builtInOperation.d.ts +0 -12
  796. package/dist/lite/model/builtInOperation.d.ts.map +0 -1
  797. package/dist/lite/model/builtInOperationType.d.ts +0 -5
  798. package/dist/lite/model/builtInOperationType.d.ts.map +0 -1
  799. package/dist/lite/model/condition.d.ts +0 -17
  800. package/dist/lite/model/condition.d.ts.map +0 -1
  801. package/dist/lite/model/consequence.d.ts +0 -26
  802. package/dist/lite/model/consequence.d.ts.map +0 -1
  803. package/dist/lite/model/consequenceHide.d.ts +0 -10
  804. package/dist/lite/model/consequenceHide.d.ts.map +0 -1
  805. package/dist/lite/model/deleteByParams.d.ts +0 -27
  806. package/dist/lite/model/deleteByParams.d.ts.map +0 -1
  807. package/dist/lite/model/dictionaryAction.d.ts +0 -5
  808. package/dist/lite/model/dictionaryAction.d.ts.map +0 -1
  809. package/dist/lite/model/dictionaryEntry.d.ts +0 -28
  810. package/dist/lite/model/dictionaryEntry.d.ts.map +0 -1
  811. package/dist/lite/model/dictionaryEntryState.d.ts +0 -5
  812. package/dist/lite/model/dictionaryEntryState.d.ts.map +0 -1
  813. package/dist/lite/model/dictionaryLanguage.d.ts +0 -10
  814. package/dist/lite/model/dictionaryLanguage.d.ts.map +0 -1
  815. package/dist/lite/model/dictionaryType.d.ts +0 -2
  816. package/dist/lite/model/dictionaryType.d.ts.map +0 -1
  817. package/dist/lite/model/fetchedIndex.d.ts +0 -47
  818. package/dist/lite/model/fetchedIndex.d.ts.map +0 -1
  819. package/dist/lite/model/languages.d.ts +0 -10
  820. package/dist/lite/model/languages.d.ts.map +0 -1
  821. package/dist/lite/model/listIndicesResponse.d.ts +0 -12
  822. package/dist/lite/model/listIndicesResponse.d.ts.map +0 -1
  823. package/dist/lite/model/logType.d.ts +0 -2
  824. package/dist/lite/model/logType.d.ts.map +0 -1
  825. package/dist/lite/model/mixedSearchFilters.d.ts +0 -2
  826. package/dist/lite/model/mixedSearchFilters.d.ts.map +0 -1
  827. package/dist/lite/model/operationType.d.ts +0 -5
  828. package/dist/lite/model/operationType.d.ts.map +0 -1
  829. package/dist/lite/model/promote.d.ts +0 -4
  830. package/dist/lite/model/promote.d.ts.map +0 -1
  831. package/dist/lite/model/promoteObjectID.d.ts +0 -14
  832. package/dist/lite/model/promoteObjectID.d.ts.map +0 -1
  833. package/dist/lite/model/promoteObjectIDs.d.ts +0 -14
  834. package/dist/lite/model/promoteObjectIDs.d.ts.map +0 -1
  835. package/dist/lite/model/rule.d.ts +0 -30
  836. package/dist/lite/model/rule.d.ts.map +0 -1
  837. package/dist/lite/model/scopeType.d.ts +0 -2
  838. package/dist/lite/model/scopeType.d.ts.map +0 -1
  839. package/dist/lite/model/searchParamsString.d.ts +0 -7
  840. package/dist/lite/model/searchParamsString.d.ts.map +0 -1
  841. package/dist/lite/model/searchSynonymsResponse.d.ts +0 -12
  842. package/dist/lite/model/searchSynonymsResponse.d.ts.map +0 -1
  843. package/dist/lite/model/source.d.ts +0 -14
  844. package/dist/lite/model/source.d.ts.map +0 -1
  845. package/dist/lite/model/standardEntries.d.ts +0 -18
  846. package/dist/lite/model/standardEntries.d.ts.map +0 -1
  847. package/dist/lite/model/synonymHit.d.ts +0 -36
  848. package/dist/lite/model/synonymHit.d.ts.map +0 -1
  849. package/dist/lite/model/synonymType.d.ts +0 -5
  850. package/dist/lite/model/synonymType.d.ts.map +0 -1
  851. package/dist/lite/model/taskStatus.d.ts +0 -5
  852. package/dist/lite/model/taskStatus.d.ts.map +0 -1
  853. package/dist/lite/model/timeRange.d.ts +0 -11
  854. package/dist/lite/model/timeRange.d.ts.map +0 -1
  855. package/dist/lite/model/updatedRuleResponse.d.ts +0 -15
  856. package/dist/lite/model/updatedRuleResponse.d.ts.map +0 -1
  857. package/dist/lite/model/userId.d.ts +0 -22
  858. package/dist/lite/model/userId.d.ts.map +0 -1
  859. package/lite/model/action.ts +0 -13
  860. package/lite/model/addApiKeyResponse.ts +0 -13
  861. package/lite/model/anchoring.ts +0 -6
  862. package/lite/model/browseParams.ts +0 -6
  863. package/lite/model/builtInOperation.ts +0 -15
  864. package/lite/model/builtInOperationType.ts +0 -13
  865. package/lite/model/condition.ts +0 -22
  866. package/lite/model/consequence.ts +0 -32
  867. package/lite/model/deleteByParams.ts +0 -36
  868. package/lite/model/dictionaryEntry.ts +0 -35
  869. package/lite/model/dictionaryLanguage.ts +0 -11
  870. package/lite/model/dictionaryType.ts +0 -3
  871. package/lite/model/fetchedIndex.ts +0 -58
  872. package/lite/model/languages.ts +0 -14
  873. package/lite/model/listIndicesResponse.ts +0 -15
  874. package/lite/model/logType.ts +0 -3
  875. package/lite/model/mixedSearchFilters.ts +0 -3
  876. package/lite/model/promoteObjectID.ts +0 -16
  877. package/lite/model/promoteObjectIDs.ts +0 -16
  878. package/lite/model/rule.ts +0 -37
  879. package/lite/model/scopeType.ts +0 -3
  880. package/lite/model/searchSynonymsResponse.ts +0 -15
  881. package/lite/model/source.ts +0 -16
  882. package/lite/model/standardEntries.ts +0 -21
  883. package/lite/model/synonymHit.ts +0 -45
  884. package/lite/model/synonymType.ts +0 -11
  885. package/lite/model/taskStatus.ts +0 -6
  886. package/lite/model/timeRange.ts +0 -13
  887. package/lite/model/updatedRuleResponse.ts +0 -18
  888. package/lite/model/userId.ts +0 -26
@@ -0,0 +1,10 @@
1
+ /**
2
+ * Configuration for handling outliers.
3
+ */
4
+ export type Outliers = {
5
+ /**
6
+ * Whether to exclude outliers when calculating A/B test results.
7
+ */
8
+ exclude?: boolean;
9
+ };
10
+ //# sourceMappingURL=outliers.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"outliers.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/outliers.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
@@ -0,0 +1,5 @@
1
+ /**
2
+ * A/B test status. - `active`. The A/B test is live and search traffic is split between the two variants. - `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. - `expired`. The A/B test was automatically stopped after reaching its end date. - `failed`. Creating the A/B test failed.
3
+ */
4
+ export type Status = 'active' | 'expired' | 'failed' | 'stopped';
5
+ //# sourceMappingURL=status.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/status.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC"}
@@ -1,4 +1,4 @@
1
- import type { CurrenciesValue } from './currenciesValue';
1
+ import type { Currency } from './currency';
2
2
  import type { FilterEffects } from './filterEffects';
3
3
  export type Variant = {
4
4
  /**
@@ -6,73 +6,77 @@ export type Variant = {
6
6
  */
7
7
  addToCartCount: number;
8
8
  /**
9
- * Variant\'s [add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate).
9
+ * [Add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate) for this variant.
10
10
  */
11
- addToCartRate: number;
11
+ addToCartRate: number | null;
12
12
  /**
13
- * Variant\'s [average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position).
13
+ * [Average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) for this variant.
14
14
  */
15
- averageClickPosition: number;
15
+ averageClickPosition: number | null;
16
16
  /**
17
17
  * Number of click events for this variant.
18
18
  */
19
19
  clickCount: number;
20
20
  /**
21
- * Variant\'s [click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
21
+ * [Click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate) for this variant.
22
22
  */
23
- clickThroughRate: number;
23
+ clickThroughRate: number | null;
24
24
  /**
25
25
  * Number of click events for this variant.
26
26
  */
27
27
  conversionCount: number;
28
28
  /**
29
- * Variant\'s [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
29
+ * [Conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate) for this variant.
30
30
  */
31
- conversionRate: number;
31
+ conversionRate: number | null;
32
32
  /**
33
33
  * A/B test currencies.
34
34
  */
35
- currencies: Record<string, CurrenciesValue>;
35
+ currencies?: Record<string, Currency>;
36
36
  /**
37
- * A/B test description.
37
+ * Description for this variant.
38
38
  */
39
39
  description: string;
40
+ /**
41
+ * Estimated number of searches required to achieve the desired statistical significance. The A/B test configuration must include a `mininmumDetectableEffect` setting for this number to be included in the response.
42
+ */
43
+ estimatedSampleSize?: number;
40
44
  filterEffects?: FilterEffects;
41
45
  /**
42
- * A/B test index.
46
+ * Index name of the A/B test variant (case-sensitive).
43
47
  */
44
48
  index: string;
45
49
  /**
46
- * Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for that variant.
50
+ * Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for this variant.
47
51
  */
48
- noResultCount: number;
52
+ noResultCount: number | null;
49
53
  /**
50
54
  * Number of purchase events for this variant.
51
55
  */
52
56
  purchaseCount: number;
53
57
  /**
54
- * Variant\'s [purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate).
58
+ * [Purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate) for this variant.
55
59
  */
56
- purchaseRate: number;
60
+ purchaseRate: number | null;
57
61
  /**
58
- * Number of searches carried out during the A/B test.
62
+ * Number of searches for this variant.
59
63
  */
60
- searchCount: number;
64
+ searchCount: number | null;
61
65
  /**
62
- * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
66
+ * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
63
67
  */
64
- trackedSearchCount: number;
68
+ trackedSearchCount?: number;
65
69
  /**
66
- * A/B test traffic percentage.
70
+ * Percentage of search requests each variant receives.
67
71
  */
68
72
  trafficPercentage: number;
69
73
  /**
70
- * Number of users during the A/B test.
74
+ * Number of users that made searches to this variant.
71
75
  */
72
- userCount: number;
76
+ userCount: number | null;
73
77
  /**
74
- * Number of users that performed a tracked search during the A/B test.
78
+ * Number of users that made tracked searches to this variant.
75
79
  */
76
- trackedUserCount: number;
80
+ trackedUserCount: number | null;
77
81
  };
78
82
  //# sourceMappingURL=variant.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"variant.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/variant.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAE5C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC"}
1
+ {"version":3,"file":"variant.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/variant.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC,CAAC"}
@@ -4,7 +4,7 @@ import type { ABTestResponse } from '../model/aBTestResponse';
4
4
  import type { AddABTestsRequest } from '../model/addABTestsRequest';
5
5
  import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteABTestProps, GetABTestProps, ListABTestsProps, StopABTestProps } from '../model/clientMethodProps';
6
6
  import type { ListABTestsResponse } from '../model/listABTestsResponse';
7
- export declare const apiClientVersion = "5.0.0-alpha.99";
7
+ export declare const apiClientVersion = "5.0.0-beta.10";
8
8
  export declare const REGIONS: readonly ["de", "us"];
9
9
  export type Region = (typeof REGIONS)[number];
10
10
  export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -31,9 +31,11 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
31
31
  */
32
32
  addAlgoliaAgent(segment: string, version?: string): void;
33
33
  /**
34
- * Creates an A/B test.
34
+ * Creates a new A/B test.
35
+ *
36
+ * Required API Key ACLs:
37
+ * - editSettings.
35
38
  *
36
- * @summary Create an A/B test.
37
39
  * @param addABTestsRequest - The addABTestsRequest object.
38
40
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
39
41
  */
@@ -41,7 +43,6 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
41
43
  /**
42
44
  * This method allow you to send requests to the Algolia REST API.
43
45
  *
44
- * @summary Send requests to the Algolia REST API.
45
46
  * @param customDelete - The customDelete object.
46
47
  * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
47
48
  * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -51,7 +52,6 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
51
52
  /**
52
53
  * This method allow you to send requests to the Algolia REST API.
53
54
  *
54
- * @summary Send requests to the Algolia REST API.
55
55
  * @param customGet - The customGet object.
56
56
  * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
57
57
  * @param customGet.parameters - Query parameters to apply to the current query.
@@ -61,7 +61,6 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
61
61
  /**
62
62
  * This method allow you to send requests to the Algolia REST API.
63
63
  *
64
- * @summary Send requests to the Algolia REST API.
65
64
  * @param customPost - The customPost object.
66
65
  * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
67
66
  * @param customPost.parameters - Query parameters to apply to the current query.
@@ -72,7 +71,6 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
72
71
  /**
73
72
  * This method allow you to send requests to the Algolia REST API.
74
73
  *
75
- * @summary Send requests to the Algolia REST API.
76
74
  * @param customPut - The customPut object.
77
75
  * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
78
76
  * @param customPut.parameters - Query parameters to apply to the current query.
@@ -81,47 +79,51 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
81
79
  */
82
80
  customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
83
81
  /**
84
- * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
82
+ * Deletes an A/B test by its ID.
83
+ *
84
+ * Required API Key ACLs:
85
+ * - editSettings.
85
86
  *
86
- * @summary Delete an A/B test.
87
87
  * @param deleteABTest - The deleteABTest object.
88
- * @param deleteABTest.id - Unique A/B test ID.
88
+ * @param deleteABTest.id - Unique A/B test identifier.
89
89
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
90
90
  */
91
91
  deleteABTest({ id }: DeleteABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
92
92
  /**
93
- * Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
93
+ * Retrieves the details for an A/B test by its ID.
94
+ *
95
+ * Required API Key ACLs:
96
+ * - analytics.
94
97
  *
95
- * @summary Get A/B test details.
96
98
  * @param getABTest - The getABTest object.
97
- * @param getABTest.id - Unique A/B test ID.
99
+ * @param getABTest.id - Unique A/B test identifier.
98
100
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
99
101
  */
100
102
  getABTest({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<ABTest>;
101
103
  /**
102
- * List all A/B tests.
104
+ * Lists all A/B tests you configured for this application.
105
+ *
106
+ * Required API Key ACLs:
107
+ * - analytics.
103
108
  *
104
- * @summary List all A/B tests.
105
109
  * @param listABTests - The listABTests object.
106
- * @param listABTests.offset - Position of the starting record. Used for paging. 0 is the first record.
107
- * @param listABTests.limit - Number of records to return (page size).
108
- * @param listABTests.indexPrefix - Only return A/B tests for indices starting with this prefix.
109
- * @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
110
+ * @param listABTests.offset - Position of the first item to return.
111
+ * @param listABTests.limit - Number of items to return.
112
+ * @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
113
+ * @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
110
114
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
111
115
  */
112
116
  listABTests({ offset, limit, indexPrefix, indexSuffix }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<ListABTestsResponse>;
113
117
  /**
114
- * If stopped, the test is over and can\'t be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
118
+ * Stops an A/B test by its ID. You can\'t restart stopped A/B tests.
119
+ *
120
+ * Required API Key ACLs:
121
+ * - editSettings.
115
122
  *
116
- * @summary Stop an A/B test.
117
123
  * @param stopABTest - The stopABTest object.
118
- * @param stopABTest.id - Unique A/B test ID.
124
+ * @param stopABTest.id - Unique A/B test identifier.
119
125
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
120
126
  */
121
127
  stopABTest({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
122
128
  };
123
- /**
124
- * The client type.
125
- */
126
- export type AbtestingClient = ReturnType<typeof createAbtestingClient>;
127
129
  //# sourceMappingURL=abtestingClient.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"abtestingClient.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/src/abtestingClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAExE,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAW9C,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;;IAwBxC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;OAMG;kCAEkB,iBAAiB,mBACnB,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAsC1B;;;;;;;;OAQG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;;OASG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;OAOG;yBAEO,iBAAiB,mBACR,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;OAOG;sBAEO,cAAc,mBACL,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAsBlB;;;;;;;;;;OAUG;8DAE4C,gBAAgB,mBAC7C,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IA+B/B;;;;;;;OAOG;uBAEO,eAAe,mBACN,cAAc,GAC9B,QAAQ,cAAc,CAAC;EAwB7B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC"}
1
+ {"version":3,"file":"abtestingClient.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/src/abtestingClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAExE,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAW9C,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;;IAwBxC;;OAEG;;IAGH;;OAEG;kBACW,OAAO,CAAC,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;kCAEkB,iBAAiB,mBACnB,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;IAsC1B;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;yBAEO,iBAAiB,mBACR,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;IAwB1B;;;;;;;;;OASG;sBAEO,cAAc,mBACL,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC;IAsBlB;;;;;;;;;;;;OAYG;8DAE4C,gBAAgB,mBAC7C,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,mBAAmB,CAAC;IA+B/B;;;;;;;;;OASG;uBAEO,eAAe,mBACN,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;EAwB7B"}
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Click position.
3
+ */
4
+ export type ClickPositionsInner = {
5
+ /**
6
+ * Range of positions in the search results, using the pattern `[start,end]`. For positions 11 and up, click events are summed over the specified range. `-1` indicates the end of the list of search results.
7
+ */
8
+ position?: number[];
9
+ /**
10
+ * Number of times this search has been clicked at that position.
11
+ */
12
+ clickCount?: number;
13
+ };
14
+ //# sourceMappingURL=clickPositionsInner.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"clickPositionsInner.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/clickPositionsInner.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}