@algolia/recommend 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 (290) hide show
  1. package/LICENSE +21 -0
  2. package/dist/builds/browser.d.ts +21 -3
  3. package/dist/builds/browser.d.ts.map +1 -1
  4. package/dist/builds/node.d.ts +21 -3
  5. package/dist/builds/node.d.ts.map +1 -1
  6. package/dist/model/aroundPrecision.d.ts +1 -1
  7. package/dist/model/aroundPrecisionFromValueInner.d.ts +9 -0
  8. package/dist/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
  9. package/dist/model/aroundRadius.d.ts +1 -1
  10. package/dist/model/aroundRadiusAll.d.ts +3 -0
  11. package/dist/model/aroundRadiusAll.d.ts.map +1 -1
  12. package/dist/model/autoFacetFilter.d.ts +14 -0
  13. package/dist/model/autoFacetFilter.d.ts.map +1 -0
  14. package/dist/model/baseRecommendRequest.d.ts +6 -4
  15. package/dist/model/baseRecommendRequest.d.ts.map +1 -1
  16. package/dist/model/baseSearchParamsWithoutQuery.d.ts +26 -29
  17. package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  18. package/dist/model/baseSearchResponse.d.ts +8 -20
  19. package/dist/model/baseSearchResponse.d.ts.map +1 -1
  20. package/dist/model/boughtTogetherQuery.d.ts +4 -0
  21. package/dist/model/boughtTogetherQuery.d.ts.map +1 -0
  22. package/dist/model/clientMethodProps.d.ts +18 -11
  23. package/dist/model/clientMethodProps.d.ts.map +1 -1
  24. package/dist/model/condition.d.ts +6 -9
  25. package/dist/model/condition.d.ts.map +1 -1
  26. package/dist/model/consequence.d.ts +9 -17
  27. package/dist/model/consequence.d.ts.map +1 -1
  28. package/dist/model/deletedAtResponse.d.ts +2 -2
  29. package/dist/model/distinct.d.ts +1 -1
  30. package/dist/model/exactOnSingleWordQuery.d.ts +1 -1
  31. package/dist/model/facetFilters.d.ts +2 -3
  32. package/dist/model/facetFilters.d.ts.map +1 -1
  33. package/dist/model/facetOrdering.d.ts +2 -2
  34. package/dist/model/facets.d.ts +2 -2
  35. package/dist/model/fallbackParams.d.ts +3 -0
  36. package/dist/model/fallbackParams.d.ts.map +1 -0
  37. package/dist/model/fbtModel.d.ts +5 -0
  38. package/dist/model/fbtModel.d.ts.map +1 -0
  39. package/dist/model/frequentlyBoughtTogether.d.ts +9 -0
  40. package/dist/model/frequentlyBoughtTogether.d.ts.map +1 -0
  41. package/dist/model/getRecommendationsParams.d.ts +2 -2
  42. package/dist/model/hideConsequenceObject.d.ts +10 -0
  43. package/dist/model/hideConsequenceObject.d.ts.map +1 -0
  44. package/dist/model/highlightResult.d.ts +1 -1
  45. package/dist/model/highlightResult.d.ts.map +1 -1
  46. package/dist/model/highlightResultOption.d.ts +3 -3
  47. package/dist/model/ignorePlurals.d.ts +3 -2
  48. package/dist/model/ignorePlurals.d.ts.map +1 -1
  49. package/dist/model/index.d.ts +23 -24
  50. package/dist/model/index.d.ts.map +1 -1
  51. package/dist/model/indexSettingsAsSearchParams.d.ts +32 -35
  52. package/dist/model/indexSettingsAsSearchParams.d.ts.map +1 -1
  53. package/dist/model/lookingSimilar.d.ts +11 -0
  54. package/dist/model/lookingSimilar.d.ts.map +1 -0
  55. package/dist/model/lookingSimilarModel.d.ts +5 -0
  56. package/dist/model/lookingSimilarModel.d.ts.map +1 -0
  57. package/dist/model/lookingSimilarQuery.d.ts +4 -0
  58. package/dist/model/lookingSimilarQuery.d.ts.map +1 -0
  59. package/dist/model/matchLevel.d.ts +1 -1
  60. package/dist/model/mode.d.ts +1 -1
  61. package/dist/model/numericFilters.d.ts +2 -3
  62. package/dist/model/numericFilters.d.ts.map +1 -1
  63. package/dist/model/optionalFilters.d.ts +2 -3
  64. package/dist/model/optionalFilters.d.ts.map +1 -1
  65. package/dist/model/paramsConsequence.d.ts +19 -0
  66. package/dist/model/paramsConsequence.d.ts.map +1 -0
  67. package/dist/model/promoteConsequenceObject.d.ts +14 -0
  68. package/dist/model/promoteConsequenceObject.d.ts.map +1 -0
  69. package/dist/model/queryType.d.ts +1 -1
  70. package/dist/model/rankingInfo.d.ts +13 -10
  71. package/dist/model/rankingInfo.d.ts.map +1 -1
  72. package/dist/model/reRankingApplyFilter.d.ts +2 -3
  73. package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
  74. package/dist/model/recommendHit.d.ts +3 -3
  75. package/dist/model/recommendRule.d.ts +24 -0
  76. package/dist/model/recommendRule.d.ts.map +1 -0
  77. package/dist/model/recommendRuleMetadata.d.ts +10 -0
  78. package/dist/model/recommendRuleMetadata.d.ts.map +1 -0
  79. package/dist/model/recommendationsHits.d.ts +0 -8
  80. package/dist/model/recommendationsHits.d.ts.map +1 -1
  81. package/dist/model/recommendationsRequest.d.ts +4 -2
  82. package/dist/model/recommendationsRequest.d.ts.map +1 -1
  83. package/dist/model/recommendationsResults.d.ts +2 -1
  84. package/dist/model/recommendationsResults.d.ts.map +1 -1
  85. package/dist/model/recommendedForYou.d.ts +7 -0
  86. package/dist/model/recommendedForYou.d.ts.map +1 -0
  87. package/dist/model/recommendedForYouModel.d.ts +1 -1
  88. package/dist/model/recommendedForYouQuery.d.ts +2 -2
  89. package/dist/model/recommendedForYouQuery.d.ts.map +1 -1
  90. package/dist/model/redirect.d.ts +1 -1
  91. package/dist/model/redirectURL.d.ts +7 -0
  92. package/dist/model/redirectURL.d.ts.map +1 -0
  93. package/dist/model/relatedModel.d.ts +5 -0
  94. package/dist/model/relatedModel.d.ts.map +1 -0
  95. package/dist/model/relatedProducts.d.ts +11 -0
  96. package/dist/model/relatedProducts.d.ts.map +1 -0
  97. package/dist/model/relatedQuery.d.ts +4 -0
  98. package/dist/model/relatedQuery.d.ts.map +1 -0
  99. package/dist/model/removeStopWords.d.ts +3 -2
  100. package/dist/model/removeStopWords.d.ts.map +1 -1
  101. package/dist/model/removeWordsIfNoResults.d.ts +1 -1
  102. package/dist/model/renderingContent.d.ts +3 -1
  103. package/dist/model/renderingContent.d.ts.map +1 -1
  104. package/dist/model/searchPagination.d.ts +19 -0
  105. package/dist/model/searchPagination.d.ts.map +1 -0
  106. package/dist/model/searchParams.d.ts +3 -0
  107. package/dist/model/searchParams.d.ts.map +1 -0
  108. package/dist/model/searchParamsObject.d.ts +3 -0
  109. package/dist/model/searchParamsObject.d.ts.map +1 -1
  110. package/dist/model/searchParamsQuery.d.ts +1 -1
  111. package/dist/model/searchRecommendRulesParams.d.ts +18 -6
  112. package/dist/model/searchRecommendRulesParams.d.ts.map +1 -1
  113. package/dist/model/searchRecommendRulesResponse.d.ts +6 -6
  114. package/dist/model/searchRecommendRulesResponse.d.ts.map +1 -1
  115. package/dist/model/semanticSearch.d.ts +2 -2
  116. package/dist/model/snippetResult.d.ts +1 -1
  117. package/dist/model/snippetResult.d.ts.map +1 -1
  118. package/dist/model/snippetResultOption.d.ts +2 -2
  119. package/dist/model/sortRemainingBy.d.ts +1 -1
  120. package/dist/model/supportedLanguage.d.ts +5 -0
  121. package/dist/model/supportedLanguage.d.ts.map +1 -0
  122. package/dist/model/tagFilters.d.ts +2 -3
  123. package/dist/model/tagFilters.d.ts.map +1 -1
  124. package/dist/model/taskStatus.d.ts +1 -1
  125. package/dist/model/trendingFacetHit.d.ts +2 -2
  126. package/dist/model/trendingFacets.d.ts +11 -0
  127. package/dist/model/trendingFacets.d.ts.map +1 -0
  128. package/dist/model/trendingFacetsModel.d.ts +1 -1
  129. package/dist/model/trendingFacetsQuery.d.ts +2 -2
  130. package/dist/model/trendingFacetsQuery.d.ts.map +1 -1
  131. package/dist/model/trendingItems.d.ts +15 -0
  132. package/dist/model/trendingItems.d.ts.map +1 -0
  133. package/dist/model/trendingItemsModel.d.ts +1 -1
  134. package/dist/model/trendingItemsQuery.d.ts +2 -2
  135. package/dist/model/trendingItemsQuery.d.ts.map +1 -1
  136. package/dist/model/typoTolerance.d.ts +1 -1
  137. package/dist/model/typoToleranceEnum.d.ts +3 -0
  138. package/dist/model/typoToleranceEnum.d.ts.map +1 -1
  139. package/dist/model/value.d.ts +5 -1
  140. package/dist/model/value.d.ts.map +1 -1
  141. package/dist/recommend.cjs +61 -45
  142. package/dist/recommend.esm.browser.js +58 -54
  143. package/dist/recommend.esm.node.js +61 -45
  144. package/dist/recommend.umd.js +2 -2
  145. package/dist/src/recommendClient.d.ts +36 -34
  146. package/dist/src/recommendClient.d.ts.map +1 -1
  147. package/model/aroundPrecision.ts +1 -1
  148. package/model/aroundPrecisionFromValueInner.ts +9 -0
  149. package/model/aroundRadius.ts +1 -1
  150. package/model/aroundRadiusAll.ts +3 -0
  151. package/model/autoFacetFilter.ts +16 -0
  152. package/model/baseRecommendRequest.ts +8 -4
  153. package/model/baseSearchParamsWithoutQuery.ts +26 -30
  154. package/model/baseSearchResponse.ts +9 -24
  155. package/model/{recommendationsQuery.ts → boughtTogetherQuery.ts} +3 -3
  156. package/model/clientMethodProps.ts +19 -11
  157. package/model/condition.ts +6 -12
  158. package/model/consequence.ts +9 -19
  159. package/model/deletedAtResponse.ts +2 -2
  160. package/model/distinct.ts +1 -1
  161. package/model/exactOnSingleWordQuery.ts +1 -1
  162. package/model/facetFilters.ts +2 -4
  163. package/model/facetOrdering.ts +2 -2
  164. package/model/facets.ts +2 -2
  165. package/model/{recommendationModels.ts → fallbackParams.ts} +3 -4
  166. package/model/fbtModel.ts +6 -0
  167. package/model/{consequenceHide.ts → frequentlyBoughtTogether.ts} +6 -5
  168. package/model/getRecommendationsParams.ts +2 -2
  169. package/model/hideConsequenceObject.ts +11 -0
  170. package/model/highlightResult.ts +1 -0
  171. package/model/highlightResultOption.ts +3 -3
  172. package/model/ignorePlurals.ts +4 -2
  173. package/model/index.ts +23 -24
  174. package/model/indexSettingsAsSearchParams.ts +32 -36
  175. package/model/lookingSimilar.ts +15 -0
  176. package/model/lookingSimilarModel.ts +6 -0
  177. package/model/lookingSimilarQuery.ts +6 -0
  178. package/model/matchLevel.ts +1 -1
  179. package/model/mode.ts +1 -1
  180. package/model/numericFilters.ts +2 -4
  181. package/model/optionalFilters.ts +2 -4
  182. package/model/paramsConsequence.ts +23 -0
  183. package/model/promoteConsequenceObject.ts +16 -0
  184. package/model/queryType.ts +1 -1
  185. package/model/rankingInfo.ts +13 -10
  186. package/model/reRankingApplyFilter.ts +2 -4
  187. package/model/recommendHit.ts +3 -3
  188. package/model/{ruleResponse.ts → recommendRule.ts} +7 -10
  189. package/model/{ruleResponseMetadata.ts → recommendRuleMetadata.ts} +5 -2
  190. package/model/recommendationsHits.ts +0 -10
  191. package/model/recommendationsRequest.ts +6 -2
  192. package/model/recommendationsResults.ts +4 -1
  193. package/model/{baseRecommendedForYouQuery.ts → recommendedForYou.ts} +3 -5
  194. package/model/recommendedForYouModel.ts +1 -1
  195. package/model/recommendedForYouQuery.ts +2 -3
  196. package/model/redirect.ts +1 -1
  197. package/model/{editType.ts → redirectURL.ts} +4 -2
  198. package/model/relatedModel.ts +6 -0
  199. package/model/relatedProducts.ts +15 -0
  200. package/model/relatedQuery.ts +6 -0
  201. package/model/removeStopWords.ts +4 -2
  202. package/model/removeWordsIfNoResults.ts +1 -1
  203. package/model/renderingContent.ts +4 -1
  204. package/model/searchPagination.ts +23 -0
  205. package/model/{mixedSearchFilters.ts → searchParams.ts} +3 -1
  206. package/model/searchParamsObject.ts +3 -0
  207. package/model/searchParamsQuery.ts +1 -1
  208. package/model/searchRecommendRulesParams.ts +21 -6
  209. package/model/searchRecommendRulesResponse.ts +6 -6
  210. package/model/semanticSearch.ts +2 -2
  211. package/model/snippetResult.ts +2 -1
  212. package/model/snippetResultOption.ts +2 -2
  213. package/model/sortRemainingBy.ts +1 -1
  214. package/model/supportedLanguage.ts +74 -0
  215. package/model/tagFilters.ts +2 -4
  216. package/model/taskStatus.ts +1 -1
  217. package/model/trendingFacetHit.ts +2 -2
  218. package/model/{baseTrendingFacetsQuery.ts → trendingFacets.ts} +7 -4
  219. package/model/trendingFacetsModel.ts +1 -1
  220. package/model/trendingFacetsQuery.ts +2 -3
  221. package/model/trendingItems.ts +20 -0
  222. package/model/trendingItemsModel.ts +1 -1
  223. package/model/trendingItemsQuery.ts +2 -2
  224. package/model/typoTolerance.ts +1 -1
  225. package/model/typoToleranceEnum.ts +3 -0
  226. package/model/value.ts +6 -1
  227. package/package.json +11 -8
  228. package/dist/model/anchoring.d.ts +0 -5
  229. package/dist/model/anchoring.d.ts.map +0 -1
  230. package/dist/model/automaticFacetFilter.d.ts +0 -18
  231. package/dist/model/automaticFacetFilter.d.ts.map +0 -1
  232. package/dist/model/automaticFacetFilters.d.ts +0 -6
  233. package/dist/model/automaticFacetFilters.d.ts.map +0 -1
  234. package/dist/model/baseRecommendationsQuery.d.ts +0 -12
  235. package/dist/model/baseRecommendationsQuery.d.ts.map +0 -1
  236. package/dist/model/baseRecommendedForYouQuery.d.ts +0 -8
  237. package/dist/model/baseRecommendedForYouQuery.d.ts.map +0 -1
  238. package/dist/model/baseRecommendedForYouQueryParameters.d.ts +0 -7
  239. package/dist/model/baseRecommendedForYouQueryParameters.d.ts.map +0 -1
  240. package/dist/model/baseTrendingFacetsQuery.d.ts +0 -9
  241. package/dist/model/baseTrendingFacetsQuery.d.ts.map +0 -1
  242. package/dist/model/baseTrendingItemsQuery.d.ts +0 -16
  243. package/dist/model/baseTrendingItemsQuery.d.ts.map +0 -1
  244. package/dist/model/consequenceHide.d.ts +0 -10
  245. package/dist/model/consequenceHide.d.ts.map +0 -1
  246. package/dist/model/consequenceParams.d.ts +0 -5
  247. package/dist/model/consequenceParams.d.ts.map +0 -1
  248. package/dist/model/consequenceQuery.d.ts +0 -6
  249. package/dist/model/consequenceQuery.d.ts.map +0 -1
  250. package/dist/model/consequenceQueryObject.d.ts +0 -12
  251. package/dist/model/consequenceQueryObject.d.ts.map +0 -1
  252. package/dist/model/edit.d.ts +0 -13
  253. package/dist/model/edit.d.ts.map +0 -1
  254. package/dist/model/editType.d.ts +0 -5
  255. package/dist/model/editType.d.ts.map +0 -1
  256. package/dist/model/mixedSearchFilters.d.ts +0 -2
  257. package/dist/model/mixedSearchFilters.d.ts.map +0 -1
  258. package/dist/model/params.d.ts +0 -13
  259. package/dist/model/params.d.ts.map +0 -1
  260. package/dist/model/promote.d.ts +0 -4
  261. package/dist/model/promote.d.ts.map +0 -1
  262. package/dist/model/promoteObjectID.d.ts +0 -14
  263. package/dist/model/promoteObjectID.d.ts.map +0 -1
  264. package/dist/model/promoteObjectIDs.d.ts +0 -14
  265. package/dist/model/promoteObjectIDs.d.ts.map +0 -1
  266. package/dist/model/recommendationModels.d.ts +0 -5
  267. package/dist/model/recommendationModels.d.ts.map +0 -1
  268. package/dist/model/recommendationsQuery.d.ts +0 -4
  269. package/dist/model/recommendationsQuery.d.ts.map +0 -1
  270. package/dist/model/recommendedForYouQueryParameters.d.ts +0 -4
  271. package/dist/model/recommendedForYouQueryParameters.d.ts.map +0 -1
  272. package/dist/model/ruleResponse.d.ts +0 -27
  273. package/dist/model/ruleResponse.d.ts.map +0 -1
  274. package/dist/model/ruleResponseMetadata.d.ts +0 -7
  275. package/dist/model/ruleResponseMetadata.d.ts.map +0 -1
  276. package/model/anchoring.ts +0 -6
  277. package/model/automaticFacetFilter.ts +0 -21
  278. package/model/automaticFacetFilters.ts +0 -8
  279. package/model/baseRecommendationsQuery.ts +0 -17
  280. package/model/baseRecommendedForYouQueryParameters.ts +0 -8
  281. package/model/baseTrendingItemsQuery.ts +0 -22
  282. package/model/consequenceParams.ts +0 -9
  283. package/model/consequenceQuery.ts +0 -8
  284. package/model/consequenceQueryObject.ts +0 -15
  285. package/model/edit.ts +0 -17
  286. package/model/params.ts +0 -18
  287. package/model/promote.ts +0 -6
  288. package/model/promoteObjectID.ts +0 -16
  289. package/model/promoteObjectIDs.ts +0 -16
  290. package/model/recommendedForYouQueryParameters.ts +0 -7
@@ -0,0 +1,74 @@
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
+
3
+ /**
4
+ * ISO code for a supported language.
5
+ */
6
+ export type SupportedLanguage =
7
+ | 'af'
8
+ | 'ar'
9
+ | 'az'
10
+ | 'bg'
11
+ | 'bn'
12
+ | 'ca'
13
+ | 'cs'
14
+ | 'cy'
15
+ | 'da'
16
+ | 'de'
17
+ | 'el'
18
+ | 'en'
19
+ | 'eo'
20
+ | 'es'
21
+ | 'et'
22
+ | 'eu'
23
+ | 'fa'
24
+ | 'fi'
25
+ | 'fo'
26
+ | 'fr'
27
+ | 'ga'
28
+ | 'gl'
29
+ | 'he'
30
+ | 'hi'
31
+ | 'hu'
32
+ | 'hy'
33
+ | 'id'
34
+ | 'is'
35
+ | 'it'
36
+ | 'ja'
37
+ | 'ka'
38
+ | 'kk'
39
+ | 'ko'
40
+ | 'ku'
41
+ | 'ky'
42
+ | 'lt'
43
+ | 'lv'
44
+ | 'mi'
45
+ | 'mn'
46
+ | 'mr'
47
+ | 'ms'
48
+ | 'mt'
49
+ | 'nb'
50
+ | 'nl'
51
+ | 'no'
52
+ | 'ns'
53
+ | 'pl'
54
+ | 'ps'
55
+ | 'pt-br'
56
+ | 'pt'
57
+ | 'qu'
58
+ | 'ro'
59
+ | 'ru'
60
+ | 'sk'
61
+ | 'sq'
62
+ | 'sv'
63
+ | 'sw'
64
+ | 'ta'
65
+ | 'te'
66
+ | 'th'
67
+ | 'tl'
68
+ | 'tn'
69
+ | 'tr'
70
+ | 'tt'
71
+ | 'uk'
72
+ | 'ur'
73
+ | 'uz'
74
+ | 'zh';
@@ -1,8 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
- import type { MixedSearchFilters } from './mixedSearchFilters';
4
-
5
3
  /**
6
- * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
4
+ * Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won\'t get a facet count. The same combination and escaping rules apply as for `facetFilters`.
7
5
  */
8
- export type TagFilters = MixedSearchFilters[] | string;
6
+ export type TagFilters = TagFilters[] | string;
@@ -1,6 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
- * _published_ if the task has been processed, _notPublished_ otherwise.
4
+ * Task status, `published` if the task is completed, `notPublished` otherwise.
5
5
  */
6
6
  export type TaskStatus = 'notPublished' | 'published';
@@ -10,12 +10,12 @@ export type TrendingFacetHit = {
10
10
  _score: number;
11
11
 
12
12
  /**
13
- * Facet name for trending models.
13
+ * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
14
14
  */
15
15
  facetName: string;
16
16
 
17
17
  /**
18
- * Facet value for trending models.
18
+ * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
19
19
  */
20
20
  facetValue: string;
21
21
  };
@@ -1,12 +1,15 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
+ import type { FallbackParams } from './fallbackParams';
3
4
  import type { TrendingFacetsModel } from './trendingFacetsModel';
4
5
 
5
- export type BaseTrendingFacetsQuery = {
6
+ export type TrendingFacets = {
6
7
  /**
7
- * Facet name for trending models.
8
+ * Facet attribute for which to retrieve trending facet values.
8
9
  */
9
- facetName: string;
10
+ facetName: any | null;
10
11
 
11
- model?: TrendingFacetsModel;
12
+ model: TrendingFacetsModel;
13
+
14
+ fallbackParameters?: FallbackParams;
12
15
  };
@@ -1,6 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
- * Trending facets model.
4
+ * Trending facet values model. This model recommends trending facet values for the specified facet attribute.
5
5
  */
6
6
  export type TrendingFacetsModel = 'trending-facets';
@@ -1,7 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { BaseRecommendRequest } from './baseRecommendRequest';
4
- import type { BaseTrendingFacetsQuery } from './baseTrendingFacetsQuery';
4
+ import type { TrendingFacets } from './trendingFacets';
5
5
 
6
- export type TrendingFacetsQuery = BaseRecommendRequest &
7
- BaseTrendingFacetsQuery;
6
+ export type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;
@@ -0,0 +1,20 @@
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
+
3
+ import type { SearchParamsObject } from './searchParamsObject';
4
+ import type { TrendingItemsModel } from './trendingItemsModel';
5
+
6
+ export type TrendingItems = {
7
+ /**
8
+ * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
9
+ */
10
+ facetName: string;
11
+
12
+ /**
13
+ * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
14
+ */
15
+ facetValue: string;
16
+
17
+ model: TrendingItemsModel;
18
+
19
+ fallbackParameters?: SearchParamsObject;
20
+ };
@@ -1,6 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
- * Trending items model.
4
+ * Trending items model. Trending items are determined from the number of conversion events collected on them.
5
5
  */
6
6
  export type TrendingItemsModel = 'trending-items';
@@ -1,6 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { BaseRecommendRequest } from './baseRecommendRequest';
4
- import type { BaseTrendingItemsQuery } from './baseTrendingItemsQuery';
4
+ import type { TrendingItems } from './trendingItems';
5
5
 
6
- export type TrendingItemsQuery = BaseRecommendRequest & BaseTrendingItemsQuery;
6
+ export type TrendingItemsQuery = BaseRecommendRequest & TrendingItems;
@@ -3,6 +3,6 @@
3
3
  import type { TypoToleranceEnum } from './typoToleranceEnum';
4
4
 
5
5
  /**
6
- * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
6
+ * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
7
7
  */
8
8
  export type TypoTolerance = TypoToleranceEnum | boolean;
@@ -1,3 +1,6 @@
1
1
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
+ /**
4
+ * - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
5
+ */
3
6
  export type TypoToleranceEnum = 'min' | 'strict';
package/model/value.ts CHANGED
@@ -4,9 +4,14 @@ import type { SortRemainingBy } from './sortRemainingBy';
4
4
 
5
5
  export type Value = {
6
6
  /**
7
- * Pinned order of facet lists.
7
+ * Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list.
8
8
  */
9
9
  order?: string[];
10
10
 
11
11
  sortRemainingBy?: SortRemainingBy;
12
+
13
+ /**
14
+ * Hide facet values.
15
+ */
16
+ hide?: string[];
12
17
  };
package/package.json CHANGED
@@ -1,8 +1,11 @@
1
1
  {
2
2
  "name": "@algolia/recommend",
3
- "version": "5.0.0-alpha.99",
3
+ "version": "5.0.0-beta.10",
4
4
  "description": "JavaScript client for recommend",
5
- "repository": "algolia/algoliasearch-client-javascript",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
8
+ },
6
9
  "license": "MIT",
7
10
  "author": "Algolia",
8
11
  "type": "module",
@@ -39,14 +42,14 @@
39
42
  "clean": "rm -rf ./dist || true"
40
43
  },
41
44
  "dependencies": {
42
- "@algolia/client-common": "5.0.0-alpha.100",
43
- "@algolia/requester-browser-xhr": "5.0.0-alpha.100",
44
- "@algolia/requester-node-http": "5.0.0-alpha.100"
45
+ "@algolia/client-common": "5.0.0-beta.11",
46
+ "@algolia/requester-browser-xhr": "5.0.0-beta.11",
47
+ "@algolia/requester-node-http": "5.0.0-beta.11"
45
48
  },
46
49
  "devDependencies": {
47
- "@types/node": "20.11.0",
48
- "rollup": "4.9.6",
49
- "typescript": "5.3.3"
50
+ "@types/node": "20.14.10",
51
+ "rollup": "4.18.0",
52
+ "typescript": "5.5.3"
50
53
  },
51
54
  "engines": {
52
55
  "node": ">= 14.0.0"
@@ -1,5 +0,0 @@
1
- /**
2
- * Whether the pattern parameter matches the beginning (`startsWith`) or end (`endsWith`) of the query string, is an exact match (`is`), or a partial match (`contains`).
3
- */
4
- export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';
5
- //# sourceMappingURL=anchoring.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"anchoring.d.ts","sourceRoot":"","sources":["../../model/anchoring.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,IAAI,GAAG,YAAY,CAAC"}
@@ -1,18 +0,0 @@
1
- /**
2
- * Automatic facet Filter.
3
- */
4
- export type AutomaticFacetFilter = {
5
- /**
6
- * Attribute to filter on. This must match a facet placeholder in the Rule\'s pattern.
7
- */
8
- facet: string;
9
- /**
10
- * Score for the filter. Typically used for optional or disjunctive filters.
11
- */
12
- score?: number;
13
- /**
14
- * Whether the filter is disjunctive (true) or conjunctive (false).
15
- */
16
- disjunctive?: boolean;
17
- };
18
- //# sourceMappingURL=automaticFacetFilter.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"automaticFacetFilter.d.ts","sourceRoot":"","sources":["../../model/automaticFacetFilter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC"}
@@ -1,6 +0,0 @@
1
- import type { AutomaticFacetFilter } from './automaticFacetFilter';
2
- /**
3
- * Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern.
4
- */
5
- export type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];
6
- //# sourceMappingURL=automaticFacetFilters.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"automaticFacetFilters.d.ts","sourceRoot":"","sources":["../../model/automaticFacetFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,EAAE,GAAG,MAAM,EAAE,CAAC"}
@@ -1,12 +0,0 @@
1
- import type { RecommendationModels } from './recommendationModels';
2
- import type { SearchParamsObject } from './searchParamsObject';
3
- export type BaseRecommendationsQuery = {
4
- model: RecommendationModels;
5
- /**
6
- * Unique object identifier.
7
- */
8
- objectID: string;
9
- queryParameters?: SearchParamsObject;
10
- fallbackParameters?: SearchParamsObject;
11
- };
12
- //# sourceMappingURL=baseRecommendationsQuery.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"baseRecommendationsQuery.d.ts","sourceRoot":"","sources":["../../model/baseRecommendationsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,oBAAoB,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,eAAe,CAAC,EAAE,kBAAkB,CAAC;IAErC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}
@@ -1,8 +0,0 @@
1
- import type { RecommendedForYouModel } from './recommendedForYouModel';
2
- import type { RecommendedForYouQueryParameters } from './recommendedForYouQueryParameters';
3
- export type BaseRecommendedForYouQuery = {
4
- model: RecommendedForYouModel;
5
- queryParameters?: RecommendedForYouQueryParameters;
6
- fallbackParameters?: RecommendedForYouQueryParameters;
7
- };
8
- //# sourceMappingURL=baseRecommendedForYouQuery.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"baseRecommendedForYouQuery.d.ts","sourceRoot":"","sources":["../../model/baseRecommendedForYouQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAE3F,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,sBAAsB,CAAC;IAE9B,eAAe,CAAC,EAAE,gCAAgC,CAAC;IAEnD,kBAAkB,CAAC,EAAE,gCAAgC,CAAC;CACvD,CAAC"}
@@ -1,7 +0,0 @@
1
- export type BaseRecommendedForYouQueryParameters = {
2
- /**
3
- * Associates a [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) with the current search.
4
- */
5
- userToken: string;
6
- };
7
- //# sourceMappingURL=baseRecommendedForYouQueryParameters.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"baseRecommendedForYouQueryParameters.d.ts","sourceRoot":"","sources":["../../model/baseRecommendedForYouQueryParameters.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oCAAoC,GAAG;IACjD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
@@ -1,9 +0,0 @@
1
- import type { TrendingFacetsModel } from './trendingFacetsModel';
2
- export type BaseTrendingFacetsQuery = {
3
- /**
4
- * Facet name for trending models.
5
- */
6
- facetName: string;
7
- model?: TrendingFacetsModel;
8
- };
9
- //# sourceMappingURL=baseTrendingFacetsQuery.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"baseTrendingFacetsQuery.d.ts","sourceRoot":"","sources":["../../model/baseTrendingFacetsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B,CAAC"}
@@ -1,16 +0,0 @@
1
- import type { SearchParamsObject } from './searchParamsObject';
2
- import type { TrendingItemsModel } from './trendingItemsModel';
3
- export type BaseTrendingItemsQuery = {
4
- /**
5
- * Facet name for trending models.
6
- */
7
- facetName?: string;
8
- /**
9
- * Facet value for trending models.
10
- */
11
- facetValue?: string;
12
- model?: TrendingItemsModel;
13
- queryParameters?: SearchParamsObject;
14
- fallbackParameters?: SearchParamsObject;
15
- };
16
- //# sourceMappingURL=baseTrendingItemsQuery.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"baseTrendingItemsQuery.d.ts","sourceRoot":"","sources":["../../model/baseTrendingItemsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAE3B,eAAe,CAAC,EAAE,kBAAkB,CAAC;IAErC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}
@@ -1,10 +0,0 @@
1
- /**
2
- * Unique identifier of the record to hide.
3
- */
4
- export type ConsequenceHide = {
5
- /**
6
- * Unique object identifier.
7
- */
8
- objectID: string;
9
- };
10
- //# sourceMappingURL=consequenceHide.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"consequenceHide.d.ts","sourceRoot":"","sources":["../../model/consequenceHide.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}
@@ -1,5 +0,0 @@
1
- import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
2
- import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
3
- import type { Params } from './params';
4
- export type ConsequenceParams = BaseSearchParamsWithoutQuery & IndexSettingsAsSearchParams & Params;
5
- //# sourceMappingURL=consequenceParams.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"consequenceParams.d.ts","sourceRoot":"","sources":["../../model/consequenceParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,iBAAiB,GAAG,4BAA4B,GAC1D,2BAA2B,GAC3B,MAAM,CAAC"}
@@ -1,6 +0,0 @@
1
- import type { ConsequenceQueryObject } from './consequenceQueryObject';
2
- /**
3
- * When providing a string, it replaces the entire query string. When providing an object, it describes incremental edits to be made to the query string (but you can\'t do both).
4
- */
5
- export type ConsequenceQuery = ConsequenceQueryObject | string;
6
- //# sourceMappingURL=consequenceQuery.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"consequenceQuery.d.ts","sourceRoot":"","sources":["../../model/consequenceQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,sBAAsB,GAAG,MAAM,CAAC"}
@@ -1,12 +0,0 @@
1
- import type { Edit } from './edit';
2
- export type ConsequenceQueryObject = {
3
- /**
4
- * Words to remove.
5
- */
6
- remove?: string[];
7
- /**
8
- * Edits to apply.
9
- */
10
- edits?: Edit[];
11
- };
12
- //# sourceMappingURL=consequenceQueryObject.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"consequenceQueryObject.d.ts","sourceRoot":"","sources":["../../model/consequenceQueryObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;CAChB,CAAC"}
@@ -1,13 +0,0 @@
1
- import type { EditType } from './editType';
2
- export type Edit = {
3
- type?: EditType;
4
- /**
5
- * Text or patterns to remove from the query string.
6
- */
7
- delete?: string;
8
- /**
9
- * Text that should be inserted in place of the removed text inside the query string.
10
- */
11
- insert?: string;
12
- };
13
- //# sourceMappingURL=edit.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"edit.d.ts","sourceRoot":"","sources":["../../model/edit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
@@ -1,5 +0,0 @@
1
- /**
2
- * Type of edit.
3
- */
4
- export type EditType = 'remove' | 'replace';
5
- //# sourceMappingURL=editType.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"editType.d.ts","sourceRoot":"","sources":["../../model/editType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC"}
@@ -1,2 +0,0 @@
1
- export type MixedSearchFilters = string[] | string;
2
- //# sourceMappingURL=mixedSearchFilters.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"mixedSearchFilters.d.ts","sourceRoot":"","sources":["../../model/mixedSearchFilters.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC"}
@@ -1,13 +0,0 @@
1
- import type { AutomaticFacetFilters } from './automaticFacetFilters';
2
- import type { ConsequenceQuery } from './consequenceQuery';
3
- import type { RenderingContent } from './renderingContent';
4
- /**
5
- * Additional search parameters.
6
- */
7
- export type Params = {
8
- query?: ConsequenceQuery;
9
- automaticFacetFilters?: AutomaticFacetFilters;
10
- automaticOptionalFacetFilters?: AutomaticFacetFilters;
11
- renderingContent?: RenderingContent;
12
- };
13
- //# sourceMappingURL=params.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../../model/params.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAEzB,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAE9C,6BAA6B,CAAC,EAAE,qBAAqB,CAAC;IAEtD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC"}
@@ -1,4 +0,0 @@
1
- import type { PromoteObjectID } from './promoteObjectID';
2
- import type { PromoteObjectIDs } from './promoteObjectIDs';
3
- export type Promote = PromoteObjectID | PromoteObjectIDs;
4
- //# sourceMappingURL=promote.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"promote.d.ts","sourceRoot":"","sources":["../../model/promote.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC"}
@@ -1,14 +0,0 @@
1
- /**
2
- * Record to promote.
3
- */
4
- export type PromoteObjectID = {
5
- /**
6
- * Unique identifier of the record to promote.
7
- */
8
- objectID: string;
9
- /**
10
- * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
11
- */
12
- position: number;
13
- };
14
- //# sourceMappingURL=promoteObjectID.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"promoteObjectID.d.ts","sourceRoot":"","sources":["../../model/promoteObjectID.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}
@@ -1,14 +0,0 @@
1
- /**
2
- * Records to promote.
3
- */
4
- export type PromoteObjectIDs = {
5
- /**
6
- * Unique identifiers of the records to promote.
7
- */
8
- objectIDs: string[];
9
- /**
10
- * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
11
- */
12
- position: number;
13
- };
14
- //# sourceMappingURL=promoteObjectIDs.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"promoteObjectIDs.d.ts","sourceRoot":"","sources":["../../model/promoteObjectIDs.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}
@@ -1,5 +0,0 @@
1
- /**
2
- * Recommendation model.
3
- */
4
- export type RecommendationModels = 'bought-together' | 'related-products';
5
- //# sourceMappingURL=recommendationModels.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"recommendationModels.d.ts","sourceRoot":"","sources":["../../model/recommendationModels.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,iBAAiB,GAAG,kBAAkB,CAAC"}
@@ -1,4 +0,0 @@
1
- import type { BaseRecommendRequest } from './baseRecommendRequest';
2
- import type { BaseRecommendationsQuery } from './baseRecommendationsQuery';
3
- export type RecommendationsQuery = BaseRecommendationsQuery & BaseRecommendRequest;
4
- //# sourceMappingURL=recommendationsQuery.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"recommendationsQuery.d.ts","sourceRoot":"","sources":["../../model/recommendationsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAE3E,MAAM,MAAM,oBAAoB,GAAG,wBAAwB,GACzD,oBAAoB,CAAC"}
@@ -1,4 +0,0 @@
1
- import type { BaseRecommendedForYouQueryParameters } from './baseRecommendedForYouQueryParameters';
2
- import type { SearchParamsObject } from './searchParamsObject';
3
- export type RecommendedForYouQueryParameters = BaseRecommendedForYouQueryParameters & SearchParamsObject;
4
- //# sourceMappingURL=recommendedForYouQueryParameters.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"recommendedForYouQueryParameters.d.ts","sourceRoot":"","sources":["../../model/recommendedForYouQueryParameters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oCAAoC,EAAE,MAAM,wCAAwC,CAAC;AACnG,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,gCAAgC,GAC1C,oCAAoC,GAAG,kBAAkB,CAAC"}
@@ -1,27 +0,0 @@
1
- import type { Condition } from './condition';
2
- import type { Consequence } from './consequence';
3
- import type { RuleResponseMetadata } from './ruleResponseMetadata';
4
- /**
5
- * Rule object.
6
- */
7
- export type RuleResponse = {
8
- _metadata?: RuleResponseMetadata;
9
- /**
10
- * Unique identifier for a rule object.
11
- */
12
- objectID: string;
13
- /**
14
- * [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions) required to activate a rule. You can use up to 25 conditions per rule.
15
- */
16
- conditions?: Condition[];
17
- consequence?: Consequence;
18
- /**
19
- * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
20
- */
21
- description?: string;
22
- /**
23
- * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
24
- */
25
- enabled?: boolean;
26
- };
27
- //# sourceMappingURL=ruleResponse.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ruleResponse.d.ts","sourceRoot":"","sources":["../../model/ruleResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,CAAC,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IAEzB,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}
@@ -1,7 +0,0 @@
1
- export type RuleResponseMetadata = {
2
- /**
3
- * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
4
- */
5
- lastUpdate?: string;
6
- };
7
- //# sourceMappingURL=ruleResponseMetadata.d.ts.map