@algolia/recommend 5.9.0 → 5.10.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 (121) hide show
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +1 -1
  3. package/dist/builds/browser.js +1 -1
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +1 -1
  8. package/dist/builds/fetch.js +1 -1
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +1 -1
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +1 -1
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/fetch.d.ts +1 -1
  15. package/dist/node.d.cts +1 -1
  16. package/dist/node.d.ts +1 -1
  17. package/dist/src/recommendClient.cjs +1 -1
  18. package/dist/src/recommendClient.cjs.map +1 -1
  19. package/dist/src/recommendClient.js +1 -1
  20. package/dist/src/recommendClient.js.map +1 -1
  21. package/package.json +6 -7
  22. package/model/advancedSyntaxFeatures.ts +0 -3
  23. package/model/alternativesAsExact.ts +0 -3
  24. package/model/aroundPrecision.ts +0 -8
  25. package/model/aroundRadius.ts +0 -8
  26. package/model/aroundRadiusAll.ts +0 -6
  27. package/model/autoFacetFilter.ts +0 -16
  28. package/model/banner.ts +0 -13
  29. package/model/bannerImage.ts +0 -12
  30. package/model/bannerImageUrl.ts +0 -8
  31. package/model/bannerLink.ts +0 -8
  32. package/model/baseIndexSettings.ts +0 -90
  33. package/model/baseRecommendIndexSettings.ts +0 -184
  34. package/model/baseRecommendRequest.ts +0 -22
  35. package/model/baseRecommendSearchParams.ts +0 -133
  36. package/model/baseSearchResponse.ts +0 -129
  37. package/model/booleanString.ts +0 -3
  38. package/model/boughtTogetherQuery.ts +0 -6
  39. package/model/clientMethodProps.ts +0 -163
  40. package/model/condition.ts +0 -16
  41. package/model/consequence.ts +0 -22
  42. package/model/deletedAtResponse.ts +0 -16
  43. package/model/distinct.ts +0 -6
  44. package/model/errorBase.ts +0 -8
  45. package/model/exactOnSingleWordQuery.ts +0 -6
  46. package/model/exhaustive.ts +0 -31
  47. package/model/facetFilters.ts +0 -6
  48. package/model/facetOrdering.ts +0 -16
  49. package/model/facetStats.ts +0 -23
  50. package/model/fallbackParams.ts +0 -5
  51. package/model/fbtModel.ts +0 -6
  52. package/model/frequentlyBoughtTogether.ts +0 -12
  53. package/model/getRecommendTaskResponse.ts +0 -7
  54. package/model/getRecommendationsParams.ts +0 -13
  55. package/model/getRecommendationsResponse.ts +0 -7
  56. package/model/hideConsequenceObject.ts +0 -11
  57. package/model/highlightResult.ts +0 -5
  58. package/model/highlightResultOption.ts +0 -25
  59. package/model/ignorePlurals.ts +0 -9
  60. package/model/index.ts +0 -101
  61. package/model/indexSettingsFacets.ts +0 -11
  62. package/model/lookingSimilar.ts +0 -15
  63. package/model/lookingSimilarModel.ts +0 -6
  64. package/model/lookingSimilarQuery.ts +0 -6
  65. package/model/matchLevel.ts +0 -6
  66. package/model/matchedGeoLocation.ts +0 -18
  67. package/model/numericFilters.ts +0 -6
  68. package/model/optionalFilters.ts +0 -6
  69. package/model/paramsConsequence.ts +0 -23
  70. package/model/personalization.ts +0 -18
  71. package/model/promoteConsequenceObject.ts +0 -16
  72. package/model/queryType.ts +0 -6
  73. package/model/range.ts +0 -16
  74. package/model/rankingInfo.ts +0 -68
  75. package/model/reRankingApplyFilter.ts +0 -6
  76. package/model/recommendHit.ts +0 -34
  77. package/model/recommendIndexSettings.ts +0 -9
  78. package/model/recommendModels.ts +0 -3
  79. package/model/recommendRule.ts +0 -37
  80. package/model/recommendSearchParams.ts +0 -10
  81. package/model/recommendUpdatedAtResponse.ts +0 -16
  82. package/model/recommendationsHit.ts +0 -7
  83. package/model/recommendationsHits.ts +0 -7
  84. package/model/recommendationsRequest.ts +0 -18
  85. package/model/recommendationsResults.ts +0 -7
  86. package/model/recommendedForYou.ts +0 -10
  87. package/model/recommendedForYouModel.ts +0 -6
  88. package/model/recommendedForYouQuery.ts +0 -6
  89. package/model/redirect.ts +0 -10
  90. package/model/redirectRuleIndexData.ts +0 -8
  91. package/model/redirectRuleIndexMetadata.ts +0 -27
  92. package/model/redirectURL.ts +0 -8
  93. package/model/relatedModel.ts +0 -6
  94. package/model/relatedProducts.ts +0 -15
  95. package/model/relatedQuery.ts +0 -6
  96. package/model/removeStopWords.ts +0 -8
  97. package/model/removeWordsIfNoResults.ts +0 -6
  98. package/model/renderingContent.ts +0 -16
  99. package/model/ruleMetadata.ts +0 -11
  100. package/model/searchPagination.ts +0 -23
  101. package/model/searchParamsQuery.ts +0 -8
  102. package/model/searchRecommendRulesParams.ts +0 -46
  103. package/model/searchRecommendRulesResponse.ts +0 -25
  104. package/model/snippetResult.ts +0 -5
  105. package/model/snippetResultOption.ts +0 -15
  106. package/model/sortRemainingBy.ts +0 -6
  107. package/model/supportedLanguage.ts +0 -74
  108. package/model/tagFilters.ts +0 -6
  109. package/model/taskStatus.ts +0 -6
  110. package/model/timeRange.ts +0 -13
  111. package/model/trendingFacetHit.ts +0 -21
  112. package/model/trendingFacets.ts +0 -15
  113. package/model/trendingFacetsModel.ts +0 -6
  114. package/model/trendingFacetsQuery.ts +0 -6
  115. package/model/trendingItems.ts +0 -20
  116. package/model/trendingItemsModel.ts +0 -6
  117. package/model/trendingItemsQuery.ts +0 -6
  118. package/model/typoTolerance.ts +0 -8
  119. package/model/typoToleranceEnum.ts +0 -6
  120. package/model/value.ts +0 -17
  121. package/model/widgets.ts +0 -13
@@ -1,6 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
5
- */
6
- export type ReRankingApplyFilter = Array<ReRankingApplyFilter> | string;
@@ -1,34 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { HighlightResult } from './highlightResult';
4
- import type { RankingInfo } from './rankingInfo';
5
- import type { SnippetResult } from './snippetResult';
6
-
7
- /**
8
- * Recommend hit.
9
- */
10
- export type RecommendHit = Record<string, any> & {
11
- /**
12
- * Unique record identifier.
13
- */
14
- objectID: string;
15
-
16
- /**
17
- * Surround words that match the query with HTML tags for highlighting.
18
- */
19
- _highlightResult?: { [key: string]: HighlightResult };
20
-
21
- /**
22
- * Snippets that show the context around a matching search query.
23
- */
24
- _snippetResult?: { [key: string]: SnippetResult };
25
-
26
- _rankingInfo?: RankingInfo;
27
-
28
- _distinctSeqID?: number;
29
-
30
- /**
31
- * Recommendation score.
32
- */
33
- _score?: number;
34
- };
@@ -1,9 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { BaseIndexSettings } from './baseIndexSettings';
4
- import type { BaseRecommendIndexSettings } from './baseRecommendIndexSettings';
5
-
6
- /**
7
- * Index settings.
8
- */
9
- export type RecommendIndexSettings = BaseIndexSettings & BaseRecommendIndexSettings;
@@ -1,3 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- export type RecommendModels = 'related-products' | 'bought-together' | 'trending-facets' | 'trending-items';
@@ -1,37 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { Condition } from './condition';
4
- import type { Consequence } from './consequence';
5
- import type { RuleMetadata } from './ruleMetadata';
6
- import type { TimeRange } from './timeRange';
7
-
8
- /**
9
- * Recommend rule.
10
- */
11
- export type RecommendRule = {
12
- _metadata?: RuleMetadata;
13
-
14
- /**
15
- * Unique identifier of a rule object.
16
- */
17
- objectID?: string;
18
-
19
- condition?: Condition;
20
-
21
- consequence?: Consequence;
22
-
23
- /**
24
- * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
25
- */
26
- description?: string;
27
-
28
- /**
29
- * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
30
- */
31
- enabled?: boolean;
32
-
33
- /**
34
- * Time periods when the rule is active.
35
- */
36
- validity?: Array<TimeRange>;
37
- };
@@ -1,10 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { BaseRecommendSearchParams } from './baseRecommendSearchParams';
4
- import type { RecommendIndexSettings } from './recommendIndexSettings';
5
- import type { SearchParamsQuery } from './searchParamsQuery';
6
-
7
- /**
8
- * Search parameters for filtering the recommendations.
9
- */
10
- export type RecommendSearchParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings;
@@ -1,16 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Response, taskID, and update timestamp.
5
- */
6
- export type RecommendUpdatedAtResponse = {
7
- /**
8
- * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
9
- */
10
- taskID: number;
11
-
12
- /**
13
- * Date and time when the object was updated, in RFC 3339 format.
14
- */
15
- updatedAt: string;
16
- };
@@ -1,7 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { RecommendHit } from './recommendHit';
4
-
5
- import type { TrendingFacetHit } from './trendingFacetHit';
6
-
7
- export type RecommendationsHit = RecommendHit | TrendingFacetHit;
@@ -1,7 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { RecommendationsHit } from './recommendationsHit';
4
-
5
- export type RecommendationsHits = {
6
- hits: Array<RecommendationsHit>;
7
- };
@@ -1,18 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { BoughtTogetherQuery } from './boughtTogetherQuery';
4
-
5
- import type { LookingSimilarQuery } from './lookingSimilarQuery';
6
-
7
- import type { RecommendedForYouQuery } from './recommendedForYouQuery';
8
- import type { RelatedQuery } from './relatedQuery';
9
- import type { TrendingFacetsQuery } from './trendingFacetsQuery';
10
- import type { TrendingItemsQuery } from './trendingItemsQuery';
11
-
12
- export type RecommendationsRequest =
13
- | BoughtTogetherQuery
14
- | RelatedQuery
15
- | TrendingItemsQuery
16
- | TrendingFacetsQuery
17
- | LookingSimilarQuery
18
- | RecommendedForYouQuery;
@@ -1,7 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { BaseSearchResponse } from './baseSearchResponse';
4
- import type { RecommendationsHits } from './recommendationsHits';
5
- import type { SearchPagination } from './searchPagination';
6
-
7
- export type RecommendationsResults = BaseSearchResponse & SearchPagination & RecommendationsHits;
@@ -1,10 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { FallbackParams } from './fallbackParams';
4
- import type { RecommendedForYouModel } from './recommendedForYouModel';
5
-
6
- export type RecommendedForYou = {
7
- model: RecommendedForYouModel;
8
-
9
- fallbackParameters?: FallbackParams;
10
- };
@@ -1,6 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * \"Recommened for you\" model.
5
- */
6
- export type RecommendedForYouModel = 'recommended-for-you';
@@ -1,6 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { BaseRecommendRequest } from './baseRecommendRequest';
4
- import type { RecommendedForYou } from './recommendedForYou';
5
-
6
- export type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;
package/model/redirect.ts DELETED
@@ -1,10 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
4
-
5
- /**
6
- * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
7
- */
8
- export type Redirect = {
9
- index?: Array<RedirectRuleIndexMetadata>;
10
- };
@@ -1,8 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Redirect rule data.
5
- */
6
- export type RedirectRuleIndexData = {
7
- ruleObjectID: string;
8
- };
@@ -1,27 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { RedirectRuleIndexData } from './redirectRuleIndexData';
4
-
5
- export type RedirectRuleIndexMetadata = {
6
- /**
7
- * Source index for the redirect rule.
8
- */
9
- source: string;
10
-
11
- /**
12
- * Destination index for the redirect rule.
13
- */
14
- dest: string;
15
-
16
- /**
17
- * Reason for the redirect rule.
18
- */
19
- reason: string;
20
-
21
- /**
22
- * Redirect rule status.
23
- */
24
- succeed: boolean;
25
-
26
- data: RedirectRuleIndexData;
27
- };
@@ -1,8 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * The redirect rule container.
5
- */
6
- export type RedirectURL = {
7
- url?: string;
8
- };
@@ -1,6 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Related products or similar content model. This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes.
5
- */
6
- export type RelatedModel = 'related-products';
@@ -1,15 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { FallbackParams } from './fallbackParams';
4
- import type { RelatedModel } from './relatedModel';
5
-
6
- export type RelatedProducts = {
7
- model: RelatedModel;
8
-
9
- /**
10
- * Unique record identifier.
11
- */
12
- objectID: string;
13
-
14
- fallbackParameters?: FallbackParams;
15
- };
@@ -1,6 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { BaseRecommendRequest } from './baseRecommendRequest';
4
- import type { RelatedProducts } from './relatedProducts';
5
-
6
- export type RelatedQuery = BaseRecommendRequest & RelatedProducts;
@@ -1,8 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { SupportedLanguage } from './supportedLanguage';
4
-
5
- /**
6
- * Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You should only use this feature for the languages used in your index.
7
- */
8
- export type RemoveStopWords = Array<SupportedLanguage> | boolean;
@@ -1,6 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Strategy for removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn\'t return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
5
- */
6
- export type RemoveWordsIfNoResults = 'none' | 'lastWords' | 'firstWords' | 'allOptional';
@@ -1,16 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { FacetOrdering } from './facetOrdering';
4
- import type { RedirectURL } from './redirectURL';
5
- import type { Widgets } from './widgets';
6
-
7
- /**
8
- * Extra data that can be used in the search UI. You can use this to control aspects of your search UI, such as the order of facet names and values without changing your frontend code.
9
- */
10
- export type RenderingContent = {
11
- facetOrdering?: FacetOrdering;
12
-
13
- redirect?: RedirectURL;
14
-
15
- widgets?: Widgets;
16
- };
@@ -1,11 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Rule metadata.
5
- */
6
- export type RuleMetadata = {
7
- /**
8
- * Date and time when the object was updated, in RFC 3339 format.
9
- */
10
- lastUpdate?: string;
11
- };
@@ -1,23 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- export type SearchPagination = {
4
- /**
5
- * Page of search results to retrieve.
6
- */
7
- page?: number;
8
-
9
- /**
10
- * Number of results (hits).
11
- */
12
- nbHits?: number;
13
-
14
- /**
15
- * Number of pages of results.
16
- */
17
- nbPages?: number;
18
-
19
- /**
20
- * Number of hits per page.
21
- */
22
- hitsPerPage?: number;
23
- };
@@ -1,8 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- export type SearchParamsQuery = {
4
- /**
5
- * Search query.
6
- */
7
- query?: string;
8
- };
@@ -1,46 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Recommend rules parameters.
5
- */
6
- export type SearchRecommendRulesParams = {
7
- /**
8
- * Search query.
9
- */
10
- query?: string;
11
-
12
- /**
13
- * Only search for rules with matching context.
14
- */
15
- context?: string;
16
-
17
- /**
18
- * Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
19
- */
20
- page?: number;
21
-
22
- /**
23
- * Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
24
- */
25
- hitsPerPage?: number;
26
-
27
- /**
28
- * Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property.
29
- */
30
- enabled?: boolean;
31
-
32
- /**
33
- * Filter expression. This only searches for rules matching the filter expression.
34
- */
35
- filters?: string;
36
-
37
- /**
38
- * Include facets and facet values in the response. Use `[\'*\']` to include all facets.
39
- */
40
- facets?: Array<string>;
41
-
42
- /**
43
- * Maximum number of values to return for each facet.
44
- */
45
- maxValuesPerFacet?: number;
46
- };
@@ -1,25 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { RecommendRule } from './recommendRule';
4
-
5
- export type SearchRecommendRulesResponse = {
6
- /**
7
- * Recommend rules that match the search criteria.
8
- */
9
- hits: Array<RecommendRule>;
10
-
11
- /**
12
- * Number of results (hits).
13
- */
14
- nbHits: number;
15
-
16
- /**
17
- * Page of search results to retrieve.
18
- */
19
- page: number;
20
-
21
- /**
22
- * Number of pages of results.
23
- */
24
- nbPages: number;
25
- };
@@ -1,5 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { SnippetResultOption } from './snippetResultOption';
4
-
5
- export type SnippetResult = SnippetResultOption | { [key: string]: SnippetResult } | Array<SnippetResult>;
@@ -1,15 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { MatchLevel } from './matchLevel';
4
-
5
- /**
6
- * Snippets that show the context around a matching search query.
7
- */
8
- export type SnippetResultOption = {
9
- /**
10
- * Highlighted attribute value, including HTML tags.
11
- */
12
- value: string;
13
-
14
- matchLevel: MatchLevel;
15
- };
@@ -1,6 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Order of facet values that aren\'t explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don\'t show facet values that aren\'t explicitly positioned.
5
- */
6
- export type SortRemainingBy = 'count' | 'alpha' | 'hidden';
@@ -1,74 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * 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'
56
- | 'pt-br'
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,6 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * 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`.
5
- */
6
- export type TagFilters = Array<TagFilters> | string;
@@ -1,6 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Task status, `published` if the task is completed, `notPublished` otherwise.
5
- */
6
- export type TaskStatus = 'published' | 'notPublished';
@@ -1,13 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- export type TimeRange = {
4
- /**
5
- * When the rule should start to be active, in Unix epoch time.
6
- */
7
- from: number;
8
-
9
- /**
10
- * When the rule should stop to be active, in Unix epoch time.
11
- */
12
- until: number;
13
- };
@@ -1,21 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Trending facet hit.
5
- */
6
- export type TrendingFacetHit = {
7
- /**
8
- * Recommendation score.
9
- */
10
- _score?: number;
11
-
12
- /**
13
- * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
14
- */
15
- facetName: string;
16
-
17
- /**
18
- * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
19
- */
20
- facetValue: string;
21
- };
@@ -1,15 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { FallbackParams } from './fallbackParams';
4
- import type { TrendingFacetsModel } from './trendingFacetsModel';
5
-
6
- export type TrendingFacets = {
7
- /**
8
- * Facet attribute for which to retrieve trending facet values.
9
- */
10
- facetName: any | null;
11
-
12
- model: TrendingFacetsModel;
13
-
14
- fallbackParameters?: FallbackParams;
15
- };
@@ -1,6 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- /**
4
- * Trending facet values model. This model recommends trending facet values for the specified facet attribute.
5
- */
6
- export type TrendingFacetsModel = 'trending-facets';
@@ -1,6 +0,0 @@
1
- // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
-
3
- import type { BaseRecommendRequest } from './baseRecommendRequest';
4
- import type { TrendingFacets } from './trendingFacets';
5
-
6
- export type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;