@algolia/recommend 5.0.0-alpha.110 → 5.0.0-alpha.111

package/model/indexSettingsAsSearchParams.ts

@@ -22,12 +22,12 @@ export type IndexSettingsAsSearchParams = {
   attributesToRetrieve?: string[];
 
   /**
-   * Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they\'re specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list.  **Modifiers**  <dl> <dt><code>asc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in ascending order.</dd> <dt><code>desc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in descending order.</dd> </dl>  Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
+   * Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they\'re specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
    */
   ranking?: string[];
 
   /**
-   * Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **Modifiers**  <dl> <dt><code>asc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in ascending order.</dd> <dt><code>desc(\"ATTRIBUTE\")</code></dt> <dd>Sort the index by the values of an attribute, in descending order.</dd> </dl>  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
+   * Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order.  - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
    */
   customRanking?: string[];
 
@@ -148,12 +148,12 @@ export type IndexSettingsAsSearchParams = {
   exactOnSingleWordQuery?: ExactOnSingleWordQuery;
 
   /**
-   * Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.  <dl> <dt><code>ignorePlurals</code></dt> <dd>  Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.  </dd> <dt><code>singleWordSynonym</code></dt> <dd> Single-word synonyms, such as \"NY/NYC\" are considered exact matches. </dd> <dt><code>multiWordsSynonym</code></dt> <dd> Multi-word synonyms, such as \"NY/New York\" are considered exact matches. </dd> </dl>.
+   * Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.  - `ignorePlurals`.   Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.  - `singleWordSynonym`.   Single-word synonyms, such as \"NY/NYC\" are considered exact matches.  - `multiWordsSynonym`.   Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
    */
   alternativesAsExact?: AlternativesAsExact[];
 
   /**
-   * Advanced search syntax features you want to support.  <dl> <dt><code>exactPhrase</code></dt> <dd>  Phrases in quotes must match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\".  </dd> <dt><code>excludeWords</code></dt> <dd>  Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain \"search\" but not \"engine\".  </dd> </dl>  This setting only has an effect if `advancedSyntax` is true.
+   * Advanced search syntax features you want to support.  - `exactPhrase`.   Phrases in quotes must match exactly.   For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\".  - `excludeWords`.   Query words prefixed with a `-` must not occur in a record.   For example, `search -engine` matches records that contain \"search\" but not \"engine\".  This setting only has an effect if `advancedSyntax` is true.
    */
   advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
 
@@ -185,7 +185,7 @@ export type IndexSettingsAsSearchParams = {
   maxValuesPerFacet?: number;
 
   /**
-   * Order in which to retrieve facet values.  <dl> <dt><code>count</code></dt> <dd> Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value. </dd> <dt><code>alpha</code></dt> <dd>Retrieve facet values alphabetically.</dd> </dl>  This setting doesn\'t influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
+   * Order in which to retrieve facet values.  - `count`.   Facet values are retrieved by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Retrieve facet values alphabetically.  This setting doesn\'t influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
    */
   sortFacetValuesBy?: string;
 

package/model/lookingSimilar.ts

@@ -0,0 +1,15 @@
+// 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.
+
+import type { FallbackParams } from './fallbackParams';
+import type { LookingSimilarModel } from './lookingSimilarModel';
+
+export type LookingSimilar = {
+  model: LookingSimilarModel;
+
+  /**
+   * Unique record identifier.
+   */
+  objectID: string;
+
+  fallbackParameters?: FallbackParams;
+};

package/model/lookingSimilarModel.ts

@@ -0,0 +1,6 @@
+// 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.
+
+/**
+ * Looking similar model.  This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index.
+ */
+export type LookingSimilarModel = 'looking-similar';

package/model/lookingSimilarQuery.ts

@@ -0,0 +1,6 @@
+// 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.
+
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { LookingSimilar } from './lookingSimilar';
+
+export type LookingSimilarQuery = BaseRecommendRequest & LookingSimilar;

package/model/paramsConsequence.ts

@@ -0,0 +1,23 @@
+// 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.
+
+import type { AutoFacetFilter } from './autoFacetFilter';
+
+/**
+ * Filter or boost recommendations matching a facet filter.
+ */
+export type ParamsConsequence = {
+  /**
+   * Filter recommendations that match or don\'t match the same `facet:facet_value` combination as the viewed item.
+   */
+  automaticFacetFilters?: AutoFacetFilter[];
+
+  /**
+   * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+   */
+  filters?: string;
+
+  /**
+   * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. Matches with higher weights (`<score=N>`) rank before matches with lower weights. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.
+   */
+  optionalFilters?: string[];
+};

package/model/promoteConsequenceObject.ts

@@ -0,0 +1,16 @@
+// 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.
+
+/**
+ * Object ID and position of the recommendation you want to pin.
+ */
+export type PromoteConsequenceObject = {
+  /**
+   * Unique record identifier.
+   */
+  objectID?: string;
+
+  /**
+   * Index in the list of recommendations where to place this item.
+   */
+  position?: number;
+};

package/model/{ruleResponse.ts → recommendRule.ts}

@@ -2,23 +2,20 @@
 
 import type { Condition } from './condition';
 import type { Consequence } from './consequence';
-import type { RuleResponseMetadata } from './ruleResponseMetadata';
+import type { RecommendRuleMetadata } from './recommendRuleMetadata';
 
 /**
- * Rule object.
+ * Recommend rule.
  */
-export type RuleResponse = {
-  _metadata?: RuleResponseMetadata;
+export type RecommendRule = {
+  _metadata?: RecommendRuleMetadata;
 
   /**
-   * Unique identifier for a rule object.
+   * Unique identifier of a rule object.
    */
-  objectID: string;
+  objectID?: string;
 
-  /**
-   * [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.
-   */
-  conditions?: Condition[];
+  condition?: Condition;
 
   consequence?: Consequence;
 

package/model/{ruleResponseMetadata.ts → recommendRuleMetadata.ts}

@@ -1,8 +1,11 @@
 // 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.
 
-export type RuleResponseMetadata = {
+/**
+ * Rule metadata.
+ */
+export type RecommendRuleMetadata = {
   /**
-   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time when the object was updated, in RFC 3339 format.
    */
   lastUpdate?: string;
 };

package/model/recommendationsHits.ts

@@ -4,14 +4,4 @@ import type { RecommendationsHit } from './recommendationsHit';
 
 export type RecommendationsHits = {
   hits: RecommendationsHit[];
-
-  /**
-   * Search query.
-   */
-  query?: string;
-
-  /**
-   * URL-encoded string of all search parameters.
-   */
-  params?: string;
 };

package/model/recommendationsRequest.ts

@@ -1,12 +1,16 @@
 // 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.
 
-import type { RecommendationsQuery } from './recommendationsQuery';
+import type { BoughtTogetherQuery } from './boughtTogetherQuery';
+import type { LookingSimilarQuery } from './lookingSimilarQuery';
 import type { RecommendedForYouQuery } from './recommendedForYouQuery';
+import type { RelatedQuery } from './relatedQuery';
 import type { TrendingFacetsQuery } from './trendingFacetsQuery';
 import type { TrendingItemsQuery } from './trendingItemsQuery';
 
 export type RecommendationsRequest =
-  | RecommendationsQuery
+  | BoughtTogetherQuery
+  | LookingSimilarQuery
   | RecommendedForYouQuery
+  | RelatedQuery
   | TrendingFacetsQuery
   | TrendingItemsQuery;

package/model/{baseRecommendedForYouQuery.ts → recommendedForYou.ts}

@@ -1,12 +1,10 @@
 // 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.
 
+import type { FallbackParams } from './fallbackParams';
 import type { RecommendedForYouModel } from './recommendedForYouModel';
-import type { RecommendedForYouQueryParameters } from './recommendedForYouQueryParameters';
 
-export type BaseRecommendedForYouQuery = {
+export type RecommendedForYou = {
   model: RecommendedForYouModel;
 
-  queryParameters?: RecommendedForYouQueryParameters;
-
-  fallbackParameters?: RecommendedForYouQueryParameters;
+  fallbackParameters?: FallbackParams;
 };

package/model/recommendedForYouModel.ts

@@ -1,6 +1,6 @@
 // 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.
 
 /**
- * Recommended for you model.
+ * \"Recommened for you\" model.
  */
 export type RecommendedForYouModel = 'recommended-for-you';

package/model/recommendedForYouQuery.ts

@@ -1,7 +1,6 @@
 // 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.
 
 import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseRecommendedForYouQuery } from './baseRecommendedForYouQuery';
+import type { RecommendedForYou } from './recommendedForYou';
 
-export type RecommendedForYouQuery = BaseRecommendedForYouQuery &
-  BaseRecommendRequest;
+export type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;

package/model/relatedModel.ts

@@ -0,0 +1,6 @@
+// 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.
+
+/**
+ * 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.
+ */
+export type RelatedModel = 'related-products';

package/model/relatedProducts.ts

@@ -0,0 +1,15 @@
+// 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.
+
+import type { FallbackParams } from './fallbackParams';
+import type { RelatedModel } from './relatedModel';
+
+export type RelatedProducts = {
+  model: RelatedModel;
+
+  /**
+   * Unique record identifier.
+   */
+  objectID: string;
+
+  fallbackParameters?: FallbackParams;
+};

package/model/relatedQuery.ts

@@ -0,0 +1,6 @@
+// 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.
+
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { RelatedProducts } from './relatedProducts';
+
+export type RelatedQuery = BaseRecommendRequest & RelatedProducts;

package/model/removeWordsIfNoResults.ts

@@ -1,7 +1,7 @@
 // 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.
 
 /**
- * Strategy for removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results.  <dl> <dt><code>none</code></dt> <dd>No words are removed when a query doesn\'t return results.</dd> <dt><code>lastWords</code></dt> <dd>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.</dd> <dt><code>firstWords</code></dt> <dd>Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed.</dd> <dt><code>allOptional</code></dt> <dd>Treat all words as optional.</dd> </dl>  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/).
+ * 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/).
  */
 export type RemoveWordsIfNoResults =
   | 'allOptional'

package/model/{recommendationModels.ts → searchParams.ts}

@@ -1,6 +1,5 @@
 // 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.
 
-/**
- * Recommendation model.
- */
-export type RecommendationModels = 'bought-together' | 'related-products';
+import type { SearchParamsObject } from './searchParamsObject';
+
+export type SearchParams = Record<string, any> & SearchParamsObject;

package/model/searchRecommendRulesParams.ts

@@ -1,7 +1,7 @@
 // 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.
 
 /**
- * Recommend rules search parameters.
+ * Recommend rules parameters.
  */
 export type SearchRecommendRulesParams = {
   /**
@@ -10,7 +10,7 @@ export type SearchRecommendRulesParams = {
   query?: string;
 
   /**
-   * Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
+   * Only search for rules with matching context.
    */
   context?: string;
 
@@ -25,7 +25,22 @@ export type SearchRecommendRulesParams = {
   hitsPerPage?: number;
 
   /**
-   * Restricts responses to enabled rules. When absent (default), _all_ rules are retrieved.
+   * 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.
    */
-  enabled?: boolean | null;
+  enabled?: boolean;
+
+  /**
+   * Filter expression. This only searches for rules matching the filter expression.
+   */
+  filters?: string;
+
+  /**
+   * Include facets and facet values in the response. Use `[\'*\']` to include all facets.
+   */
+  facets?: string[];
+
+  /**
+   * Maximum number of values to return for each facet.
+   */
+  maxValuesPerFacet?: number;
 };

package/model/searchRecommendRulesResponse.ts

@@ -1,12 +1,12 @@
 // 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.
 
-import type { RuleResponse } from './ruleResponse';
+import type { RecommendRule } from './recommendRule';
 
 export type SearchRecommendRulesResponse = {
   /**
-   * Fetched rules.
+   * Recommend rules that match the search criteria.
    */
-  hits: RuleResponse[];
+  hits: RecommendRule[];
 
   /**
    * Number of results (hits).

package/model/sortRemainingBy.ts

@@ -1,6 +1,6 @@
 // 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.
 
 /**
- * Order of facet values that aren\'t explicitly positioned with the `order` setting.  <dl> <dt><code>count</code></dt> <dd> Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. </dd> <dt><code>alpha</code></dt> <dd>Sort facet values alphabetically.</dd> <dt><code>hidden</code></dt> <dd>Don\'t show facet values that aren\'t explicitly positioned.</dd> </dl>.
+ * 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.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';

package/model/trendingFacetHit.ts

@@ -10,12 +10,12 @@ export type TrendingFacetHit = {
   _score: number;
 
   /**
-   * Facet name for trending models.
+   * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
    */
   facetName: string;
 
   /**
-   * Facet value for trending models.
+   * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
    */
   facetValue: string;
 };

package/model/{baseTrendingFacetsQuery.ts → trendingFacets.ts}

@@ -1,12 +1,15 @@
 // 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.
 
+import type { FallbackParams } from './fallbackParams';
 import type { TrendingFacetsModel } from './trendingFacetsModel';
 
-export type BaseTrendingFacetsQuery = {
+export type TrendingFacets = {
   /**
-   * Facet name for trending models.
+   * Facet attribute for which to retrieve trending facet values.
    */
-  facetName: string;
+  facetName: any | null;
 
-  model?: TrendingFacetsModel;
+  model: TrendingFacetsModel;
+
+  fallbackParameters?: FallbackParams;
 };

package/model/trendingFacetsModel.ts

@@ -1,6 +1,6 @@
 // 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.
 
 /**
- * Trending facets model.
+ * Trending facet values model.  This model recommends trending facet values for the specified facet attribute.
  */
 export type TrendingFacetsModel = 'trending-facets';

package/model/trendingFacetsQuery.ts

@@ -1,7 +1,6 @@
 // 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.
 
 import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseTrendingFacetsQuery } from './baseTrendingFacetsQuery';
+import type { TrendingFacets } from './trendingFacets';
 
-export type TrendingFacetsQuery = BaseRecommendRequest &
-  BaseTrendingFacetsQuery;
+export type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;

package/model/trendingItems.ts

@@ -0,0 +1,20 @@
+// 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.
+
+import type { SearchParamsObject } from './searchParamsObject';
+import type { TrendingItemsModel } from './trendingItemsModel';
+
+export type TrendingItems = {
+  /**
+   * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
+   */
+  facetName: string;
+
+  /**
+   * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
+   */
+  facetValue: string;
+
+  model: TrendingItemsModel;
+
+  fallbackParameters?: SearchParamsObject;
+};

package/model/trendingItemsModel.ts

@@ -1,6 +1,6 @@
 // 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.
 
 /**
- * Trending items model.
+ * Trending items model.  Trending items are determined from the number of conversion events collected on them.
  */
 export type TrendingItemsModel = 'trending-items';

package/model/trendingItemsQuery.ts

@@ -1,6 +1,6 @@
 // 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.
 
 import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseTrendingItemsQuery } from './baseTrendingItemsQuery';
+import type { TrendingItems } from './trendingItems';
 
-export type TrendingItemsQuery = BaseRecommendRequest & BaseTrendingItemsQuery;
+export type TrendingItemsQuery = BaseRecommendRequest & TrendingItems;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/recommend",
-  "version": "5.0.0-alpha.110",
+  "version": "5.0.0-alpha.111",
   "description": "JavaScript client for recommend",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -39,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.111",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.111",
-    "@algolia/requester-node-http": "5.0.0-alpha.111"
+    "@algolia/client-common": "5.0.0-alpha.112",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.112",
+    "@algolia/requester-node-http": "5.0.0-alpha.112"
   },
   "devDependencies": {
-    "@types/node": "20.11.30",
-    "rollup": "4.13.2",
-    "typescript": "5.4.3"
+    "@types/node": "20.12.5",
+    "rollup": "4.14.0",
+    "typescript": "5.4.4"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/model/anchoring.d.ts

@@ -1,5 +0,0 @@
-/**
- * Which part of the search query the pattern should match:  - `startsWith`. The pattern must match the begginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query.  Empty queries are only allowed as pattern with `anchoring: is`.
- */
-export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';
-//# sourceMappingURL=anchoring.d.ts.map

package/dist/model/anchoring.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/dist/model/automaticFacetFilter.d.ts

@@ -1,18 +0,0 @@
-/**
- * Filter or optional filter to be applied to the search.
- */
-export type AutomaticFacetFilter = {
-    /**
-     * Facet name to be applied as filter. The name must match placeholders in the `pattern` parameter. For example, with `pattern: {facet:genre}`, `automaticFacetFilters` must be `genre`.
-     */
-    facet: string;
-    /**
-     * Filter scores to give different weights to individual filters.
-     */
-    score?: number;
-    /**
-     * Whether the filter is disjunctive or conjunctive.  If true the filter has multiple matches, multiple occurences are combined with the logical `OR` operation. If false, multiple occurences are combined with the logical `AND` operation.
-     */
-    disjunctive?: boolean;
-};
-//# sourceMappingURL=automaticFacetFilter.d.ts.map

package/dist/model/automaticFacetFilter.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/dist/model/automaticFacetFilters.d.ts

@@ -1,6 +0,0 @@
-import type { AutomaticFacetFilter } from './automaticFacetFilter';
-/**
- * Filter to be applied to the search.  You can use this to respond to search queries that match a facet value. For example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet, you can filter the results to show the top-ranked comedy movies.
- */
-export type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];
-//# sourceMappingURL=automaticFacetFilters.d.ts.map

package/dist/model/automaticFacetFilters.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/dist/model/baseRecommendationsQuery.d.ts

@@ -1,12 +0,0 @@
-import type { RecommendationModels } from './recommendationModels';
-import type { SearchParamsObject } from './searchParamsObject';
-export type BaseRecommendationsQuery = {
-    model: RecommendationModels;
-    /**
-     * Unique record identifier.
-     */
-    objectID: string;
-    queryParameters?: SearchParamsObject;
-    fallbackParameters?: SearchParamsObject;
-};
-//# sourceMappingURL=baseRecommendationsQuery.d.ts.map

package/dist/model/baseRecommendationsQuery.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/dist/model/baseRecommendedForYouQuery.d.ts

@@ -1,8 +0,0 @@
-import type { RecommendedForYouModel } from './recommendedForYouModel';
-import type { RecommendedForYouQueryParameters } from './recommendedForYouQueryParameters';
-export type BaseRecommendedForYouQuery = {
-    model: RecommendedForYouModel;
-    queryParameters?: RecommendedForYouQueryParameters;
-    fallbackParameters?: RecommendedForYouQueryParameters;
-};
-//# sourceMappingURL=baseRecommendedForYouQuery.d.ts.map

package/dist/model/baseRecommendedForYouQuery.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/dist/model/baseRecommendedForYouQueryParameters.d.ts

@@ -1,7 +0,0 @@
-export type BaseRecommendedForYouQueryParameters = {
-    /**
-     * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
-     */
-    userToken: string;
-};
-//# sourceMappingURL=baseRecommendedForYouQueryParameters.d.ts.map

package/dist/model/baseRecommendedForYouQueryParameters.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/dist/model/baseTrendingFacetsQuery.d.ts

@@ -1,9 +0,0 @@
-import type { TrendingFacetsModel } from './trendingFacetsModel';
-export type BaseTrendingFacetsQuery = {
-    /**
-     * Facet name for trending models.
-     */
-    facetName: string;
-    model?: TrendingFacetsModel;
-};
-//# sourceMappingURL=baseTrendingFacetsQuery.d.ts.map

package/dist/model/baseTrendingFacetsQuery.d.ts.map

@@ -1 +0,0 @@
-{"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"}