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

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 (508) hide show
  1. package/builds/browser.ts +10 -17
  2. package/builds/node.ts +58 -15
  3. package/dist/algoliasearch/builds/browser.d.ts +10 -5
  4. package/dist/algoliasearch/builds/browser.d.ts.map +1 -1
  5. package/dist/algoliasearch/builds/node.d.ts +28 -6
  6. package/dist/algoliasearch/builds/node.d.ts.map +1 -1
  7. package/dist/algoliasearch.cjs +752 -387
  8. package/dist/algoliasearch.esm.browser.js +724 -393
  9. package/dist/algoliasearch.esm.node.js +753 -388
  10. package/dist/algoliasearch.umd.js +2 -2
  11. package/dist/client-abtesting/model/aBTest.d.ts +14 -29
  12. package/dist/client-abtesting/model/aBTest.d.ts.map +1 -1
  13. package/dist/client-abtesting/model/aBTestConfiguration.d.ts +12 -0
  14. package/dist/client-abtesting/model/aBTestConfiguration.d.ts.map +1 -0
  15. package/dist/client-abtesting/model/aBTestResponse.d.ts +3 -3
  16. package/dist/client-abtesting/model/abTestsVariant.d.ts +3 -3
  17. package/dist/client-abtesting/model/addABTestsRequest.d.ts +1 -1
  18. package/dist/client-abtesting/model/clientMethodProps.d.ts +7 -7
  19. package/dist/client-abtesting/model/{currenciesValue.d.ts → currency.d.ts} +2 -2
  20. package/dist/client-abtesting/model/currency.d.ts.map +1 -0
  21. package/dist/client-abtesting/model/customSearchParams.d.ts +1 -1
  22. package/dist/client-abtesting/model/effect.d.ts +5 -0
  23. package/dist/client-abtesting/model/effect.d.ts.map +1 -0
  24. package/dist/client-abtesting/model/emptySearch.d.ts +10 -0
  25. package/dist/client-abtesting/model/emptySearch.d.ts.map +1 -0
  26. package/dist/client-abtesting/model/index.d.ts +7 -1
  27. package/dist/client-abtesting/model/index.d.ts.map +1 -1
  28. package/dist/client-abtesting/model/listABTestsResponse.d.ts +2 -2
  29. package/dist/client-abtesting/model/listABTestsResponse.d.ts.map +1 -1
  30. package/dist/client-abtesting/model/minimumDetectableEffect.d.ts +12 -0
  31. package/dist/client-abtesting/model/minimumDetectableEffect.d.ts.map +1 -0
  32. package/dist/client-abtesting/model/outliers.d.ts +10 -0
  33. package/dist/client-abtesting/model/outliers.d.ts.map +1 -0
  34. package/dist/client-abtesting/model/status.d.ts +5 -0
  35. package/dist/client-abtesting/model/status.d.ts.map +1 -0
  36. package/dist/client-abtesting/model/variant.d.ts +29 -25
  37. package/dist/client-abtesting/model/variant.d.ts.map +1 -1
  38. package/dist/client-abtesting/src/abtestingClient.d.ts +28 -26
  39. package/dist/client-abtesting/src/abtestingClient.d.ts.map +1 -1
  40. package/dist/client-analytics/model/clickPositionsInner.d.ts +14 -0
  41. package/dist/client-analytics/model/clickPositionsInner.d.ts.map +1 -0
  42. package/dist/client-analytics/model/clientMethodProps.d.ts +161 -90
  43. package/dist/client-analytics/model/clientMethodProps.d.ts.map +1 -1
  44. package/dist/client-analytics/model/currenciesValue.d.ts +14 -0
  45. package/dist/client-analytics/model/currenciesValue.d.ts.map +1 -0
  46. package/dist/client-analytics/model/dailyAddToCartRates.d.ts +19 -0
  47. package/dist/client-analytics/model/dailyAddToCartRates.d.ts.map +1 -0
  48. package/dist/client-analytics/model/dailyAverageClicks.d.ts +15 -0
  49. package/dist/client-analytics/model/dailyAverageClicks.d.ts.map +1 -0
  50. package/dist/client-analytics/model/dailyClickThroughRates.d.ts +19 -0
  51. package/dist/client-analytics/model/dailyClickThroughRates.d.ts.map +1 -0
  52. package/dist/client-analytics/model/dailyConversionRates.d.ts +19 -0
  53. package/dist/client-analytics/model/dailyConversionRates.d.ts.map +1 -0
  54. package/dist/client-analytics/model/dailyNoClickRates.d.ts +19 -0
  55. package/dist/client-analytics/model/dailyNoClickRates.d.ts.map +1 -0
  56. package/dist/client-analytics/model/dailyNoResultsRates.d.ts +19 -0
  57. package/dist/client-analytics/model/dailyNoResultsRates.d.ts.map +1 -0
  58. package/dist/client-analytics/model/dailyPurchaseRates.d.ts +19 -0
  59. package/dist/client-analytics/model/dailyPurchaseRates.d.ts.map +1 -0
  60. package/dist/client-analytics/model/dailyRevenue.d.ts +12 -0
  61. package/dist/client-analytics/model/dailyRevenue.d.ts.map +1 -0
  62. package/dist/client-analytics/model/dailySearches.d.ts +11 -0
  63. package/dist/client-analytics/model/dailySearches.d.ts.map +1 -0
  64. package/dist/client-analytics/model/dailySearchesNoClicks.d.ts +15 -0
  65. package/dist/client-analytics/model/dailySearchesNoClicks.d.ts.map +1 -0
  66. package/dist/client-analytics/model/dailySearchesNoResults.d.ts +15 -0
  67. package/dist/client-analytics/model/dailySearchesNoResults.d.ts.map +1 -0
  68. package/dist/client-analytics/model/dailyUsers.d.ts +11 -0
  69. package/dist/client-analytics/model/dailyUsers.d.ts.map +1 -0
  70. package/dist/client-analytics/model/getAddToCartRateResponse.d.ts +20 -0
  71. package/dist/client-analytics/model/getAddToCartRateResponse.d.ts.map +1 -0
  72. package/dist/client-analytics/model/getAverageClickPositionResponse.d.ts +6 -6
  73. package/dist/client-analytics/model/getAverageClickPositionResponse.d.ts.map +1 -1
  74. package/dist/client-analytics/model/getClickPositionsResponse.d.ts +3 -3
  75. package/dist/client-analytics/model/getClickPositionsResponse.d.ts.map +1 -1
  76. package/dist/client-analytics/model/getClickThroughRateResponse.d.ts +7 -7
  77. package/dist/client-analytics/model/getClickThroughRateResponse.d.ts.map +1 -1
  78. package/dist/client-analytics/model/getConversionRateResponse.d.ts +20 -0
  79. package/dist/client-analytics/model/getConversionRateResponse.d.ts.map +1 -0
  80. package/dist/client-analytics/model/getNoClickRateResponse.d.ts +6 -6
  81. package/dist/client-analytics/model/getNoClickRateResponse.d.ts.map +1 -1
  82. package/dist/client-analytics/model/getNoResultsRateResponse.d.ts +6 -6
  83. package/dist/client-analytics/model/getNoResultsRateResponse.d.ts.map +1 -1
  84. package/dist/client-analytics/model/getPurchaseRateResponse.d.ts +20 -0
  85. package/dist/client-analytics/model/getPurchaseRateResponse.d.ts.map +1 -0
  86. package/dist/client-analytics/model/getRevenue.d.ts +13 -0
  87. package/dist/client-analytics/model/getRevenue.d.ts.map +1 -0
  88. package/dist/client-analytics/model/getSearchesCountResponse.d.ts +3 -3
  89. package/dist/client-analytics/model/getSearchesCountResponse.d.ts.map +1 -1
  90. package/dist/client-analytics/model/getSearchesNoClicksResponse.d.ts +3 -3
  91. package/dist/client-analytics/model/getSearchesNoClicksResponse.d.ts.map +1 -1
  92. package/dist/client-analytics/model/getSearchesNoResultsResponse.d.ts +3 -3
  93. package/dist/client-analytics/model/getSearchesNoResultsResponse.d.ts.map +1 -1
  94. package/dist/client-analytics/model/getStatusResponse.d.ts +2 -2
  95. package/dist/client-analytics/model/getStatusResponse.d.ts.map +1 -1
  96. package/dist/client-analytics/model/getTopCountriesResponse.d.ts +1 -1
  97. package/dist/client-analytics/model/getTopFilterAttributesResponse.d.ts +1 -1
  98. package/dist/client-analytics/model/getTopFilterForAttribute.d.ts +2 -4
  99. package/dist/client-analytics/model/getTopFilterForAttribute.d.ts.map +1 -1
  100. package/dist/client-analytics/model/getTopFiltersNoResultsResponse.d.ts +2 -2
  101. package/dist/client-analytics/model/getTopFiltersNoResultsResponse.d.ts.map +1 -1
  102. package/dist/client-analytics/model/getTopFiltersNoResultsValue.d.ts +2 -4
  103. package/dist/client-analytics/model/getTopFiltersNoResultsValue.d.ts.map +1 -1
  104. package/dist/client-analytics/model/getTopHitsResponse.d.ts +2 -1
  105. package/dist/client-analytics/model/getTopHitsResponse.d.ts.map +1 -1
  106. package/dist/client-analytics/model/getTopSearchesResponse.d.ts +2 -1
  107. package/dist/client-analytics/model/getTopSearchesResponse.d.ts.map +1 -1
  108. package/dist/client-analytics/model/getUsersCountResponse.d.ts +4 -4
  109. package/dist/client-analytics/model/getUsersCountResponse.d.ts.map +1 -1
  110. package/dist/client-analytics/model/index.d.ts +23 -11
  111. package/dist/client-analytics/model/index.d.ts.map +1 -1
  112. package/dist/client-analytics/model/operator.d.ts +5 -0
  113. package/dist/client-analytics/model/operator.d.ts.map +1 -0
  114. package/dist/client-analytics/model/orderBy.d.ts +1 -1
  115. package/dist/client-analytics/model/topCountry.d.ts +1 -1
  116. package/dist/client-analytics/model/topHit.d.ts +1 -1
  117. package/dist/client-analytics/model/topHitWithAnalytics.d.ts +9 -9
  118. package/dist/client-analytics/model/topHitWithAnalytics.d.ts.map +1 -1
  119. package/dist/client-analytics/model/topHitWithRevenueAnalytics.d.ts +52 -0
  120. package/dist/client-analytics/model/topHitWithRevenueAnalytics.d.ts.map +1 -0
  121. package/dist/client-analytics/model/topHitsResponse.d.ts +1 -1
  122. package/dist/client-analytics/model/topHitsResponseWithAnalytics.d.ts +1 -1
  123. package/dist/client-analytics/model/topHitsResponseWithRevenueAnalytics.d.ts +8 -0
  124. package/dist/client-analytics/model/topHitsResponseWithRevenueAnalytics.d.ts.map +1 -0
  125. package/dist/client-analytics/model/topSearch.d.ts +3 -3
  126. package/dist/client-analytics/model/topSearchWithAnalytics.d.ts +17 -12
  127. package/dist/client-analytics/model/topSearchWithAnalytics.d.ts.map +1 -1
  128. package/dist/client-analytics/model/topSearchWithRevenueAnalytics.d.ts +65 -0
  129. package/dist/client-analytics/model/topSearchWithRevenueAnalytics.d.ts.map +1 -0
  130. package/dist/client-analytics/model/topSearchesResponse.d.ts +1 -1
  131. package/dist/client-analytics/model/topSearchesResponseWithAnalytics.d.ts +1 -1
  132. package/dist/client-analytics/model/topSearchesResponseWithRevenueAnalytics.d.ts +8 -0
  133. package/dist/client-analytics/model/topSearchesResponseWithRevenueAnalytics.d.ts.map +1 -0
  134. package/dist/client-analytics/src/analyticsClient.d.ts +211 -138
  135. package/dist/client-analytics/src/analyticsClient.d.ts.map +1 -1
  136. package/dist/client-personalization/model/clientMethodProps.d.ts +2 -2
  137. package/dist/client-personalization/model/deleteUserProfileResponse.d.ts +2 -2
  138. package/dist/client-personalization/model/eventScoring.d.ts +4 -6
  139. package/dist/client-personalization/model/eventScoring.d.ts.map +1 -1
  140. package/dist/client-personalization/model/eventType.d.ts +5 -0
  141. package/dist/client-personalization/model/eventType.d.ts.map +1 -0
  142. package/dist/client-personalization/model/facetScoring.d.ts +2 -2
  143. package/dist/client-personalization/model/getUserTokenResponse.d.ts +3 -3
  144. package/dist/client-personalization/model/index.d.ts +1 -0
  145. package/dist/client-personalization/model/index.d.ts.map +1 -1
  146. package/dist/client-personalization/model/personalizationStrategyParams.d.ts +3 -3
  147. package/dist/client-personalization/src/personalizationClient.d.ts +19 -19
  148. package/dist/client-personalization/src/personalizationClient.d.ts.map +1 -1
  149. package/dist/client-search/model/acl.d.ts +1 -1
  150. package/dist/client-search/model/action.d.ts +1 -1
  151. package/dist/client-search/model/addApiKeyResponse.d.ts +1 -1
  152. package/dist/client-search/model/anchoring.d.ts +1 -1
  153. package/dist/client-search/model/apiKey.d.ts +8 -8
  154. package/dist/client-search/model/apiKeyOperation.d.ts +2 -0
  155. package/dist/client-search/model/apiKeyOperation.d.ts.map +1 -0
  156. package/dist/client-search/model/aroundPrecision.d.ts +1 -1
  157. package/dist/client-search/model/aroundPrecisionFromValueInner.d.ts +9 -0
  158. package/dist/client-search/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
  159. package/dist/client-search/model/aroundRadius.d.ts +1 -1
  160. package/dist/client-search/model/aroundRadiusAll.d.ts +3 -0
  161. package/dist/client-search/model/aroundRadiusAll.d.ts.map +1 -1
  162. package/dist/client-search/model/automaticFacetFilter.d.ts +4 -4
  163. package/dist/client-search/model/automaticFacetFilters.d.ts +1 -1
  164. package/dist/client-search/model/baseGetApiKeyResponse.d.ts +1 -1
  165. package/dist/client-search/model/baseIndexSettings.d.ts +22 -17
  166. package/dist/client-search/model/baseIndexSettings.d.ts.map +1 -1
  167. package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +26 -29
  168. package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  169. package/dist/client-search/model/baseSearchResponse.d.ts +10 -6
  170. package/dist/client-search/model/baseSearchResponse.d.ts.map +1 -1
  171. package/dist/client-search/model/batchDictionaryEntriesParams.d.ts +3 -3
  172. package/dist/client-search/model/batchResponse.d.ts +2 -2
  173. package/dist/client-search/model/builtInOperation.d.ts +2 -2
  174. package/dist/client-search/model/builtInOperationType.d.ts +1 -1
  175. package/dist/client-search/model/clientMethodProps.d.ts +124 -65
  176. package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
  177. package/dist/client-search/model/condition.d.ts +7 -3
  178. package/dist/client-search/model/condition.d.ts.map +1 -1
  179. package/dist/client-search/model/consequence.d.ts +5 -5
  180. package/dist/client-search/model/consequenceHide.d.ts +2 -2
  181. package/dist/client-search/model/consequenceQuery.d.ts +1 -1
  182. package/dist/client-search/model/consequenceQueryObject.d.ts +2 -2
  183. package/dist/client-search/model/createdAtResponse.d.ts +1 -1
  184. package/dist/client-search/model/cursor.d.ts +1 -1
  185. package/dist/client-search/model/deleteApiKeyResponse.d.ts +1 -1
  186. package/dist/client-search/model/deleteByParams.d.ts +4 -4
  187. package/dist/client-search/model/deleteSourceResponse.d.ts +1 -1
  188. package/dist/client-search/model/deletedAtResponse.d.ts +2 -2
  189. package/dist/client-search/model/dictionaryEntry.d.ts +6 -8
  190. package/dist/client-search/model/dictionaryEntry.d.ts.map +1 -1
  191. package/dist/client-search/model/dictionaryEntryState.d.ts +1 -1
  192. package/dist/client-search/model/dictionaryLanguage.d.ts +2 -2
  193. package/dist/client-search/model/dictionarySettingsParams.d.ts +1 -1
  194. package/dist/client-search/model/distinct.d.ts +1 -1
  195. package/dist/client-search/model/edit.d.ts +1 -1
  196. package/dist/client-search/model/exactOnSingleWordQuery.d.ts +1 -1
  197. package/dist/client-search/model/facetFilters.d.ts +1 -1
  198. package/dist/client-search/model/facetHits.d.ts +2 -2
  199. package/dist/client-search/model/facetOrdering.d.ts +2 -2
  200. package/dist/client-search/model/facets.d.ts +2 -2
  201. package/dist/client-search/model/fetchedIndex.d.ts +1 -1
  202. package/dist/client-search/model/getObjectsRequest.d.ts +3 -3
  203. package/dist/client-search/model/getObjectsResponse.d.ts +1 -1
  204. package/dist/client-search/model/hasPendingMappingsResponse.d.ts +1 -1
  205. package/dist/client-search/model/highlightResult.d.ts +1 -1
  206. package/dist/client-search/model/highlightResult.d.ts.map +1 -1
  207. package/dist/client-search/model/highlightResultOption.d.ts +3 -3
  208. package/dist/client-search/model/hit.d.ts +4 -4
  209. package/dist/client-search/model/ignorePlurals.d.ts +3 -2
  210. package/dist/client-search/model/ignorePlurals.d.ts.map +1 -1
  211. package/dist/client-search/model/index.d.ts +4 -0
  212. package/dist/client-search/model/index.d.ts.map +1 -1
  213. package/dist/client-search/model/indexSettings.d.ts +1 -1
  214. package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +32 -35
  215. package/dist/client-search/model/indexSettingsAsSearchParams.d.ts.map +1 -1
  216. package/dist/client-search/model/log.d.ts +11 -11
  217. package/dist/client-search/model/logQuery.d.ts +1 -1
  218. package/dist/client-search/model/matchLevel.d.ts +1 -1
  219. package/dist/client-search/model/mode.d.ts +1 -1
  220. package/dist/client-search/model/multipleBatchRequest.d.ts +1 -1
  221. package/dist/client-search/model/multipleBatchResponse.d.ts +2 -2
  222. package/dist/client-search/model/numericFilters.d.ts +1 -1
  223. package/dist/client-search/model/operationIndexParams.d.ts +2 -2
  224. package/dist/client-search/model/operationType.d.ts +1 -1
  225. package/dist/client-search/model/optionalFilters.d.ts +1 -1
  226. package/dist/client-search/model/params.d.ts +1 -1
  227. package/dist/client-search/model/promoteObjectID.d.ts +2 -2
  228. package/dist/client-search/model/promoteObjectIDs.d.ts +2 -2
  229. package/dist/client-search/model/queryType.d.ts +1 -1
  230. package/dist/client-search/model/rankingInfo.d.ts +10 -7
  231. package/dist/client-search/model/rankingInfo.d.ts.map +1 -1
  232. package/dist/client-search/model/reRankingApplyFilter.d.ts +1 -1
  233. package/dist/client-search/model/removeStopWords.d.ts +3 -2
  234. package/dist/client-search/model/removeStopWords.d.ts.map +1 -1
  235. package/dist/client-search/model/removeUserIdResponse.d.ts +1 -1
  236. package/dist/client-search/model/removeWordsIfNoResults.d.ts +1 -1
  237. package/dist/client-search/model/renderingContent.d.ts +1 -1
  238. package/dist/client-search/model/replaceSourceResponse.d.ts +1 -1
  239. package/dist/client-search/model/rule.d.ts +5 -5
  240. package/dist/client-search/model/saveObjectResponse.d.ts +3 -3
  241. package/dist/client-search/model/saveSynonymResponse.d.ts +2 -2
  242. package/dist/client-search/model/searchDictionaryEntriesParams.d.ts +5 -7
  243. package/dist/client-search/model/searchDictionaryEntriesParams.d.ts.map +1 -1
  244. package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts +20 -0
  245. package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
  246. package/dist/client-search/model/searchForFacetValuesRequest.d.ts +1 -1
  247. package/dist/client-search/model/searchForFacetValuesResponse.d.ts +3 -0
  248. package/dist/client-search/model/searchForFacetValuesResponse.d.ts.map +1 -1
  249. package/dist/client-search/model/searchForFacetsOptions.d.ts +2 -2
  250. package/dist/client-search/model/searchForHitsOptions.d.ts +1 -1
  251. package/dist/client-search/model/searchHits.d.ts +6 -3
  252. package/dist/client-search/model/searchHits.d.ts.map +1 -1
  253. package/dist/client-search/model/searchParamsObject.d.ts +3 -0
  254. package/dist/client-search/model/searchParamsObject.d.ts.map +1 -1
  255. package/dist/client-search/model/searchParamsQuery.d.ts +1 -1
  256. package/dist/client-search/model/searchRulesParams.d.ts +4 -8
  257. package/dist/client-search/model/searchRulesParams.d.ts.map +1 -1
  258. package/dist/client-search/model/searchRulesResponse.d.ts +2 -2
  259. package/dist/client-search/model/searchStrategy.d.ts +1 -1
  260. package/dist/client-search/model/searchSynonymsParams.d.ts +2 -2
  261. package/dist/client-search/model/searchSynonymsResponse.d.ts +2 -2
  262. package/dist/client-search/model/searchUserIdsParams.d.ts +1 -1
  263. package/dist/client-search/model/searchUserIdsResponse.d.ts +3 -3
  264. package/dist/client-search/model/securedAPIKeyRestrictions.d.ts +25 -0
  265. package/dist/client-search/model/securedAPIKeyRestrictions.d.ts.map +1 -0
  266. package/dist/client-search/model/semanticSearch.d.ts +2 -2
  267. package/dist/client-search/model/snippetResult.d.ts +1 -1
  268. package/dist/client-search/model/snippetResult.d.ts.map +1 -1
  269. package/dist/client-search/model/snippetResultOption.d.ts +2 -2
  270. package/dist/client-search/model/sortRemainingBy.d.ts +1 -1
  271. package/dist/client-search/model/supportedLanguage.d.ts +5 -0
  272. package/dist/client-search/model/supportedLanguage.d.ts.map +1 -0
  273. package/dist/client-search/model/tagFilters.d.ts +1 -1
  274. package/dist/client-search/model/taskStatus.d.ts +1 -1
  275. package/dist/client-search/model/timeRange.d.ts +2 -2
  276. package/dist/client-search/model/typoTolerance.d.ts +1 -1
  277. package/dist/client-search/model/typoToleranceEnum.d.ts +3 -0
  278. package/dist/client-search/model/typoToleranceEnum.d.ts.map +1 -1
  279. package/dist/client-search/model/updateApiKeyResponse.d.ts +1 -1
  280. package/dist/client-search/model/updatedAtResponse.d.ts +2 -2
  281. package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts +3 -3
  282. package/dist/client-search/model/updatedRuleResponse.d.ts +3 -3
  283. package/dist/client-search/model/userHit.d.ts +1 -1
  284. package/dist/client-search/model/userId.d.ts +1 -1
  285. package/dist/client-search/model/value.d.ts +1 -1
  286. package/dist/client-search/src/searchClient.d.ts +324 -202
  287. package/dist/client-search/src/searchClient.d.ts.map +1 -1
  288. package/dist/lite/builds/browser.d.ts +14 -3
  289. package/dist/lite/builds/browser.d.ts.map +1 -1
  290. package/dist/lite/builds/node.d.ts +14 -3
  291. package/dist/lite/builds/node.d.ts.map +1 -1
  292. package/dist/lite/lite.cjs +8 -6
  293. package/dist/lite/lite.esm.browser.js +13 -14
  294. package/dist/lite/lite.esm.node.js +8 -6
  295. package/dist/lite/lite.umd.js +2 -2
  296. package/dist/lite/model/acl.d.ts +1 -1
  297. package/dist/lite/model/action.d.ts +1 -1
  298. package/dist/lite/model/addApiKeyResponse.d.ts +1 -1
  299. package/dist/lite/model/anchoring.d.ts +1 -1
  300. package/dist/lite/model/apiKey.d.ts +8 -8
  301. package/dist/lite/model/apiKeyOperation.d.ts +2 -0
  302. package/dist/lite/model/apiKeyOperation.d.ts.map +1 -0
  303. package/dist/lite/model/aroundPrecision.d.ts +1 -1
  304. package/dist/lite/model/aroundPrecisionFromValueInner.d.ts +9 -0
  305. package/dist/lite/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
  306. package/dist/lite/model/aroundRadius.d.ts +1 -1
  307. package/dist/lite/model/aroundRadiusAll.d.ts +3 -0
  308. package/dist/lite/model/aroundRadiusAll.d.ts.map +1 -1
  309. package/dist/lite/model/automaticFacetFilter.d.ts +4 -4
  310. package/dist/lite/model/automaticFacetFilters.d.ts +1 -1
  311. package/dist/lite/model/baseGetApiKeyResponse.d.ts +1 -1
  312. package/dist/lite/model/baseIndexSettings.d.ts +22 -17
  313. package/dist/lite/model/baseIndexSettings.d.ts.map +1 -1
  314. package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +26 -29
  315. package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  316. package/dist/lite/model/baseSearchResponse.d.ts +10 -6
  317. package/dist/lite/model/baseSearchResponse.d.ts.map +1 -1
  318. package/dist/lite/model/builtInOperation.d.ts +2 -2
  319. package/dist/lite/model/builtInOperationType.d.ts +1 -1
  320. package/dist/lite/model/condition.d.ts +7 -3
  321. package/dist/lite/model/condition.d.ts.map +1 -1
  322. package/dist/lite/model/consequence.d.ts +5 -5
  323. package/dist/lite/model/consequenceHide.d.ts +2 -2
  324. package/dist/lite/model/consequenceQuery.d.ts +1 -1
  325. package/dist/lite/model/consequenceQueryObject.d.ts +2 -2
  326. package/dist/lite/model/cursor.d.ts +1 -1
  327. package/dist/lite/model/deleteByParams.d.ts +4 -4
  328. package/dist/lite/model/dictionaryEntry.d.ts +6 -8
  329. package/dist/lite/model/dictionaryEntry.d.ts.map +1 -1
  330. package/dist/lite/model/dictionaryEntryState.d.ts +1 -1
  331. package/dist/lite/model/dictionaryLanguage.d.ts +2 -2
  332. package/dist/lite/model/distinct.d.ts +1 -1
  333. package/dist/lite/model/edit.d.ts +1 -1
  334. package/dist/lite/model/exactOnSingleWordQuery.d.ts +1 -1
  335. package/dist/lite/model/facetFilters.d.ts +1 -1
  336. package/dist/lite/model/facetHits.d.ts +2 -2
  337. package/dist/lite/model/facetOrdering.d.ts +2 -2
  338. package/dist/lite/model/facets.d.ts +2 -2
  339. package/dist/lite/model/fetchedIndex.d.ts +1 -1
  340. package/dist/lite/model/highlightResult.d.ts +1 -1
  341. package/dist/lite/model/highlightResult.d.ts.map +1 -1
  342. package/dist/lite/model/highlightResultOption.d.ts +3 -3
  343. package/dist/lite/model/hit.d.ts +4 -4
  344. package/dist/lite/model/ignorePlurals.d.ts +3 -2
  345. package/dist/lite/model/ignorePlurals.d.ts.map +1 -1
  346. package/dist/lite/model/index.d.ts +4 -0
  347. package/dist/lite/model/index.d.ts.map +1 -1
  348. package/dist/lite/model/indexSettings.d.ts +1 -1
  349. package/dist/lite/model/indexSettingsAsSearchParams.d.ts +32 -35
  350. package/dist/lite/model/indexSettingsAsSearchParams.d.ts.map +1 -1
  351. package/dist/lite/model/matchLevel.d.ts +1 -1
  352. package/dist/lite/model/mode.d.ts +1 -1
  353. package/dist/lite/model/numericFilters.d.ts +1 -1
  354. package/dist/lite/model/operationType.d.ts +1 -1
  355. package/dist/lite/model/optionalFilters.d.ts +1 -1
  356. package/dist/lite/model/params.d.ts +1 -1
  357. package/dist/lite/model/promoteObjectID.d.ts +2 -2
  358. package/dist/lite/model/promoteObjectIDs.d.ts +2 -2
  359. package/dist/lite/model/queryType.d.ts +1 -1
  360. package/dist/lite/model/rankingInfo.d.ts +10 -7
  361. package/dist/lite/model/rankingInfo.d.ts.map +1 -1
  362. package/dist/lite/model/reRankingApplyFilter.d.ts +1 -1
  363. package/dist/lite/model/removeStopWords.d.ts +3 -2
  364. package/dist/lite/model/removeStopWords.d.ts.map +1 -1
  365. package/dist/lite/model/removeWordsIfNoResults.d.ts +1 -1
  366. package/dist/lite/model/renderingContent.d.ts +1 -1
  367. package/dist/lite/model/rule.d.ts +5 -5
  368. package/dist/lite/model/searchDictionaryEntriesResponse.d.ts +20 -0
  369. package/dist/lite/model/searchDictionaryEntriesResponse.d.ts.map +1 -0
  370. package/dist/lite/model/searchForFacetValuesResponse.d.ts +3 -0
  371. package/dist/lite/model/searchForFacetValuesResponse.d.ts.map +1 -1
  372. package/dist/lite/model/searchForFacetsOptions.d.ts +2 -2
  373. package/dist/lite/model/searchForHitsOptions.d.ts +1 -1
  374. package/dist/lite/model/searchHits.d.ts +6 -3
  375. package/dist/lite/model/searchHits.d.ts.map +1 -1
  376. package/dist/lite/model/searchParamsObject.d.ts +3 -0
  377. package/dist/lite/model/searchParamsObject.d.ts.map +1 -1
  378. package/dist/lite/model/searchParamsQuery.d.ts +1 -1
  379. package/dist/lite/model/searchStrategy.d.ts +1 -1
  380. package/dist/lite/model/searchSynonymsResponse.d.ts +2 -2
  381. package/dist/lite/model/securedAPIKeyRestrictions.d.ts +25 -0
  382. package/dist/lite/model/securedAPIKeyRestrictions.d.ts.map +1 -0
  383. package/dist/lite/model/semanticSearch.d.ts +2 -2
  384. package/dist/lite/model/snippetResult.d.ts +1 -1
  385. package/dist/lite/model/snippetResult.d.ts.map +1 -1
  386. package/dist/lite/model/snippetResultOption.d.ts +2 -2
  387. package/dist/lite/model/sortRemainingBy.d.ts +1 -1
  388. package/dist/lite/model/supportedLanguage.d.ts +5 -0
  389. package/dist/lite/model/supportedLanguage.d.ts.map +1 -0
  390. package/dist/lite/model/tagFilters.d.ts +1 -1
  391. package/dist/lite/model/taskStatus.d.ts +1 -1
  392. package/dist/lite/model/timeRange.d.ts +2 -2
  393. package/dist/lite/model/typoTolerance.d.ts +1 -1
  394. package/dist/lite/model/typoToleranceEnum.d.ts +3 -0
  395. package/dist/lite/model/typoToleranceEnum.d.ts.map +1 -1
  396. package/dist/lite/model/updatedRuleResponse.d.ts +3 -3
  397. package/dist/lite/model/userId.d.ts +1 -1
  398. package/dist/lite/model/value.d.ts +1 -1
  399. package/dist/lite/src/liteClient.d.ts +6 -9
  400. package/dist/lite/src/liteClient.d.ts.map +1 -1
  401. package/lite/builds/browser.ts +11 -6
  402. package/lite/builds/node.ts +10 -5
  403. package/lite/model/acl.ts +1 -1
  404. package/lite/model/action.ts +1 -1
  405. package/lite/model/addApiKeyResponse.ts +1 -1
  406. package/lite/model/anchoring.ts +1 -1
  407. package/lite/model/apiKey.ts +8 -8
  408. package/lite/model/apiKeyOperation.ts +3 -0
  409. package/lite/model/aroundPrecision.ts +1 -1
  410. package/lite/model/aroundPrecisionFromValueInner.ts +9 -0
  411. package/lite/model/aroundRadius.ts +1 -1
  412. package/lite/model/aroundRadiusAll.ts +3 -0
  413. package/lite/model/automaticFacetFilter.ts +4 -4
  414. package/lite/model/automaticFacetFilters.ts +1 -1
  415. package/lite/model/baseGetApiKeyResponse.ts +1 -1
  416. package/lite/model/baseIndexSettings.ts +24 -17
  417. package/lite/model/baseSearchParamsWithoutQuery.ts +26 -30
  418. package/lite/model/baseSearchResponse.ts +11 -6
  419. package/lite/model/builtInOperation.ts +2 -2
  420. package/lite/model/builtInOperationType.ts +1 -1
  421. package/lite/model/condition.ts +8 -3
  422. package/lite/model/consequence.ts +5 -5
  423. package/lite/model/consequenceHide.ts +2 -2
  424. package/lite/model/consequenceQuery.ts +1 -1
  425. package/lite/model/consequenceQueryObject.ts +2 -2
  426. package/lite/model/cursor.ts +1 -1
  427. package/lite/model/deleteByParams.ts +4 -4
  428. package/lite/model/dictionaryEntry.ts +6 -8
  429. package/lite/model/dictionaryEntryState.ts +1 -1
  430. package/lite/model/dictionaryLanguage.ts +2 -2
  431. package/lite/model/distinct.ts +1 -1
  432. package/lite/model/edit.ts +1 -1
  433. package/lite/model/exactOnSingleWordQuery.ts +1 -1
  434. package/lite/model/facetFilters.ts +1 -1
  435. package/lite/model/facetHits.ts +2 -2
  436. package/lite/model/facetOrdering.ts +2 -2
  437. package/lite/model/facets.ts +2 -2
  438. package/lite/model/fetchedIndex.ts +1 -1
  439. package/lite/model/highlightResult.ts +1 -0
  440. package/lite/model/highlightResultOption.ts +3 -3
  441. package/lite/model/hit.ts +4 -4
  442. package/lite/model/ignorePlurals.ts +4 -2
  443. package/lite/model/index.ts +4 -0
  444. package/lite/model/indexSettings.ts +1 -1
  445. package/lite/model/indexSettingsAsSearchParams.ts +32 -36
  446. package/lite/model/matchLevel.ts +1 -1
  447. package/lite/model/mode.ts +1 -1
  448. package/lite/model/numericFilters.ts +1 -1
  449. package/lite/model/operationType.ts +1 -1
  450. package/lite/model/optionalFilters.ts +1 -1
  451. package/lite/model/params.ts +1 -1
  452. package/lite/model/promoteObjectID.ts +2 -2
  453. package/lite/model/promoteObjectIDs.ts +2 -2
  454. package/lite/model/queryType.ts +1 -1
  455. package/lite/model/rankingInfo.ts +10 -7
  456. package/lite/model/reRankingApplyFilter.ts +1 -1
  457. package/lite/model/removeStopWords.ts +4 -2
  458. package/lite/model/removeWordsIfNoResults.ts +1 -1
  459. package/lite/model/renderingContent.ts +1 -1
  460. package/lite/model/rule.ts +5 -5
  461. package/lite/model/searchDictionaryEntriesResponse.ts +25 -0
  462. package/lite/model/searchForFacetValuesResponse.ts +3 -0
  463. package/lite/model/searchForFacetsOptions.ts +2 -2
  464. package/lite/model/searchForHitsOptions.ts +1 -1
  465. package/lite/model/searchHits.ts +6 -3
  466. package/lite/model/searchParamsObject.ts +3 -0
  467. package/lite/model/searchParamsQuery.ts +1 -1
  468. package/lite/model/searchStrategy.ts +1 -1
  469. package/lite/model/searchSynonymsResponse.ts +2 -2
  470. package/lite/model/securedAPIKeyRestrictions.ts +32 -0
  471. package/lite/model/semanticSearch.ts +2 -2
  472. package/lite/model/snippetResult.ts +2 -1
  473. package/lite/model/snippetResultOption.ts +2 -2
  474. package/lite/model/sortRemainingBy.ts +1 -1
  475. package/lite/model/supportedLanguage.ts +74 -0
  476. package/lite/model/tagFilters.ts +1 -1
  477. package/lite/model/taskStatus.ts +1 -1
  478. package/lite/model/timeRange.ts +2 -2
  479. package/lite/model/typoTolerance.ts +1 -1
  480. package/lite/model/typoToleranceEnum.ts +3 -0
  481. package/lite/model/updatedRuleResponse.ts +3 -3
  482. package/lite/model/userId.ts +1 -1
  483. package/lite/model/value.ts +1 -1
  484. package/lite/src/liteClient.ts +8 -12
  485. package/package.json +14 -14
  486. package/dist/client-abtesting/model/currenciesValue.d.ts.map +0 -1
  487. package/dist/client-analytics/model/averageClickEvent.d.ts +0 -15
  488. package/dist/client-analytics/model/averageClickEvent.d.ts.map +0 -1
  489. package/dist/client-analytics/model/clickPosition.d.ts +0 -11
  490. package/dist/client-analytics/model/clickPosition.d.ts.map +0 -1
  491. package/dist/client-analytics/model/clickThroughRateEvent.d.ts +0 -19
  492. package/dist/client-analytics/model/clickThroughRateEvent.d.ts.map +0 -1
  493. package/dist/client-analytics/model/conversionRateEvent.d.ts +0 -19
  494. package/dist/client-analytics/model/conversionRateEvent.d.ts.map +0 -1
  495. package/dist/client-analytics/model/getConversationRateResponse.d.ts +0 -20
  496. package/dist/client-analytics/model/getConversationRateResponse.d.ts.map +0 -1
  497. package/dist/client-analytics/model/noClickRateEvent.d.ts +0 -19
  498. package/dist/client-analytics/model/noClickRateEvent.d.ts.map +0 -1
  499. package/dist/client-analytics/model/noResultsRateEvent.d.ts +0 -19
  500. package/dist/client-analytics/model/noResultsRateEvent.d.ts.map +0 -1
  501. package/dist/client-analytics/model/searchEvent.d.ts +0 -11
  502. package/dist/client-analytics/model/searchEvent.d.ts.map +0 -1
  503. package/dist/client-analytics/model/searchNoClickEvent.d.ts +0 -15
  504. package/dist/client-analytics/model/searchNoClickEvent.d.ts.map +0 -1
  505. package/dist/client-analytics/model/searchNoResultEvent.d.ts +0 -15
  506. package/dist/client-analytics/model/searchNoResultEvent.d.ts.map +0 -1
  507. package/dist/client-analytics/model/userWithDate.d.ts +0 -11
  508. package/dist/client-analytics/model/userWithDate.d.ts.map +0 -1
@@ -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.1";
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,iBAAiB,CAAC;AAE/C,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;;;;;;;;OAQG;kCAEkB,iBAAiB,mBACnB,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAsC1B;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;yBAEO,iBAAiB,mBACR,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;;;OASG;sBAEO,cAAc,mBACL,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAsBlB;;;;;;;;;;;;OAYG;8DAE4C,gBAAgB,mBAC7C,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IA+B/B;;;;;;;;;OASG;uBAEO,eAAe,mBACN,cAAc,GAC9B,QAAQ,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"}