@algolia/recommend 5.0.0-alpha.99 → 5.0.0-beta.2

package/model/baseSearchParamsWithoutQuery.ts

@@ -5,16 +5,17 @@ import type { AroundRadius } from './aroundRadius';
 import type { FacetFilters } from './facetFilters';
 import type { NumericFilters } from './numericFilters';
 import type { OptionalFilters } from './optionalFilters';
+import type { SupportedLanguage } from './supportedLanguage';
 import type { TagFilters } from './tagFilters';
 
 export type BaseSearchParamsWithoutQuery = {
   /**
-   * Overrides the query parameter and performs a more generic search.
+   * Keywords to be used instead of the search query to conduct a more broader search.  Using the `similarQuery` parameter changes other settings:  - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`.  Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
    */
   similarQuery?: string;
 
   /**
-   * [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.
+   * 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;
 
@@ -27,47 +28,47 @@ export type BaseSearchParamsWithoutQuery = {
   tagFilters?: TagFilters;
 
   /**
-   * Determines how to calculate [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). If `false`, maximum score is kept. If `true`, score is summed.
+   * Whether to sum all filter scores.  If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
    */
   sumOrFiltersScores?: boolean;
 
   /**
-   * Restricts a query to only look at a subset of your [searchable attributes](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/).
+   * Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
    */
   restrictSearchableAttributes?: string[];
 
   /**
-   * Returns [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts), their facet values, and the number of matching facet values.
+   * Facets for which to retrieve facet values that match the search criteria and the number of matching facet values.  To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
    */
   facets?: string[];
 
   /**
-   * Forces faceting to be applied after [de-duplication](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/) (with the distinct feature). Alternatively, the `afterDistinct` [modifier](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) of `attributesForFaceting` allows for more granular control.
+   * Whether faceting should be applied after deduplication with `distinct`.  This leads to accurate facet counts when using faceting in combination with `distinct`. It\'s usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
    */
   facetingAfterDistinct?: boolean;
 
   /**
-   * Page to retrieve (the first page is `0`, not `1`).
+   * Page of search results to retrieve.
    */
   page?: number;
 
   /**
-   * Specifies the offset of the first hit to return. > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
+   * Position of the first hit to retrieve.
    */
   offset?: number;
 
   /**
-   * Sets the number of hits to retrieve (for use with `offset`). > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).
+   * Number of hits to retrieve (used in combination with `offset`).
    */
   length?: number;
 
   /**
-   * Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.
+   * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.  Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
    */
   aroundLatLng?: string;
 
   /**
-   * Search for entries around a location. The location is automatically computed from the requester\'s IP address.
+   * Whether to obtain the coordinates from the request\'s IP address.
    */
   aroundLatLngViaIP?: boolean;
 
@@ -76,62 +77,57 @@ export type BaseSearchParamsWithoutQuery = {
   aroundPrecision?: AroundPrecision;
 
   /**
-   * Minimum radius (in meters) used for a geographical search when `aroundRadius` isn\'t set.
+   * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
    */
   minimumAroundRadius?: number;
 
   /**
-   * Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
+   * Coordinates for a rectangular area in which to search.  Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
    */
   insideBoundingBox?: number[][];
 
   /**
-   * Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).
+   * Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
    */
   insidePolygon?: number[][];
 
   /**
-   * Changes the default values of parameters that work best for a natural language query, such as `ignorePlurals`, `removeStopWords`, `removeWordsIfNoResults`, `analyticsTags`, and `ruleContexts`. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries.
+   * ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches):  - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
    */
-  naturalLanguages?: string[];
+  naturalLanguages?: SupportedLanguage[];
 
   /**
-   * Assigns [rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) to search queries.
+   * Assigns a rule context to the search query.  [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
    */
   ruleContexts?: string[];
 
   /**
-   * Defines how much [Personalization affects results](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
+   * Impact that Personalization should have on this search.  The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
    */
   personalizationImpact?: number;
 
   /**
-   * Associates a [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) with the current search.
+   * 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;
 
   /**
-   * Incidates whether the search response includes [detailed ranking information](https://www.algolia.com/doc/guides/building-search-ui/going-further/backend-search/in-depth/understanding-the-api-response/#ranking-information).
+   * Whether the search response should include detailed ranking information.
    */
   getRankingInfo?: boolean;
 
   /**
-   * Enriches the API\'s response with information about how the query was processed.
-   */
-  explain?: string[];
-
-  /**
-   * Whether to take into account an index\'s synonyms for a particular search.
+   * Whether to take into account an index\'s synonyms for this search.
    */
   synonyms?: boolean;
 
   /**
-   * Indicates whether a query ID parameter is included in the search response. This is required for [tracking click and conversion events](https://www.algolia.com/doc/guides/sending-events/concepts/event-types/#events-related-to-algolia-requests).
+   * Whether to include a `queryID` attribute in the response.  The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
    */
   clickAnalytics?: boolean;
 
   /**
-   * Indicates whether this query will be included in [analytics](https://www.algolia.com/doc/guides/search-analytics/guides/exclude-queries/).
+   * Whether this search will be included in Analytics.
    */
   analytics?: boolean;
 
@@ -141,12 +137,12 @@ export type BaseSearchParamsWithoutQuery = {
   analyticsTags?: string[];
 
   /**
-   * Whether to include or exclude a query from the processing-time percentile computation.
+   * Whether to include this search when calculating processing-time percentiles.
    */
   percentileComputation?: boolean;
 
   /**
-   * Incidates whether this search will be considered in A/B testing.
+   * Whether to enable A/B testing for this search.
    */
   enableABTest?: boolean;
 };

package/model/baseSearchResponse.ts

@@ -22,7 +22,7 @@ export type BaseSearchResponse = Record<string, any> & {
   aroundLatLng?: string;
 
   /**
-   * Automatically-computed radius.
+   * Distance from a central coordinate provided by `aroundLatLng`.
    */
   automaticRadius?: string;
 
@@ -44,7 +44,7 @@ export type BaseSearchResponse = Record<string, any> & {
   exhaustiveTypo?: boolean;
 
   /**
-   * Mapping of each facet name to the corresponding facet counts.
+   * Facet counts.
    */
   facets?: Record<string, Record<string, number>>;
 
@@ -74,12 +74,12 @@ export type BaseSearchResponse = Record<string, any> & {
   message?: string;
 
   /**
-   * Number of hits the search query matched.
+   * Number of results (hits).
    */
   nbHits: number;
 
   /**
-   * Number of pages of results for the current query.
+   * Number of pages of results.
    */
   nbPages: number;
 
@@ -89,7 +89,7 @@ export type BaseSearchResponse = Record<string, any> & {
   nbSortedHits?: number;
 
   /**
-   * Page to retrieve (the first page is `0`, not `1`).
+   * Page of search results to retrieve.
    */
   page: number;
 
@@ -128,7 +128,12 @@ export type BaseSearchResponse = Record<string, any> & {
   serverUsed?: string;
 
   /**
-   * Lets you store custom data in your indices.
+   * An object with custom data.  You can store up to 32&nbsp;kB as custom data.
    */
   userData?: any | null;
+
+  /**
+   * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+   */
+  queryID?: string;
 };

package/model/{recommendationsQuery.ts → boughtTogetherQuery.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.
 
 import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseRecommendationsQuery } from './baseRecommendationsQuery';
+import type { FrequentlyBoughtTogether } from './frequentlyBoughtTogether';
 
-export type RecommendationsQuery = BaseRecommendationsQuery &
-  BaseRecommendRequest;
+export type BoughtTogetherQuery = BaseRecommendRequest &
+  FrequentlyBoughtTogether;

package/model/clientMethodProps.ts

@@ -72,15 +72,15 @@ export type CustomPutProps = {
  */
 export type DeleteRecommendRuleProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
    */
   model: RecommendModels;
   /**
-   * Unique record (object) identifier.
+   * Unique record identifier.
    */
   objectID: string;
 };
@@ -90,15 +90,15 @@ export type DeleteRecommendRuleProps = {
  */
 export type GetRecommendRuleProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
    */
   model: RecommendModels;
   /**
-   * Unique record (object) identifier.
+   * Unique record identifier.
    */
   objectID: string;
 };
@@ -108,15 +108,15 @@ export type GetRecommendRuleProps = {
  */
 export type GetRecommendStatusProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
    */
   model: RecommendModels;
   /**
-   * Unique identifier of a task. Numeric value (up to 64bits).
+   * Unique task identifier.
    */
   taskID: number;
 };
@@ -126,11 +126,11 @@ export type GetRecommendStatusProps = {
  */
 export type SearchRecommendRulesProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+   * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
    */
   model: RecommendModels;
   searchRecommendRulesParams?: SearchRecommendRulesParams;

package/model/condition.ts

@@ -1,22 +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 { Anchoring } from './anchoring';
-
+/**
+ * Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
+ */
 export type Condition = {
   /**
-   * Query pattern syntax.
-   */
-  pattern?: string;
-
-  anchoring?: Anchoring;
-
-  /**
-   * Whether the pattern matches on plurals, synonyms, and typos.
+   * 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/).
    */
-  alternatives?: boolean;
+  filters?: string;
 
   /**
-   * Rule context format: [A-Za-z0-9_-]+).
+   * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
    */
   context?: string;
 };

package/model/consequence.ts

@@ -1,32 +1,22 @@
 // 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 { ConsequenceHide } from './consequenceHide';
-import type { ConsequenceParams } from './consequenceParams';
-import type { Promote } from './promote';
+import type { HideConsequenceObject } from './hideConsequenceObject';
+import type { ParamsConsequence } from './paramsConsequence';
+import type { PromoteConsequenceObject } from './promoteConsequenceObject';
 
 /**
- * [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences) of a rule.
+ * Effect of the rule.
  */
 export type Consequence = {
-  params?: ConsequenceParams;
-
-  /**
-   * Records to promote.
-   */
-  promote?: Promote[];
-
   /**
-   * Only use in combination with the `promote` consequence. When `true`, promoted results will be restricted to match the filters of the current search. When `false`, the promoted results will show up regardless of the filters.
+   * Exclude items from recommendations.
    */
-  filterPromotes?: boolean;
+  hide?: HideConsequenceObject[];
 
   /**
-   * Records to hide. By default, you can hide up to 50 records per rule.
+   * Place items at specific positions in the list of recommendations.
    */
-  hide?: ConsequenceHide[];
+  promote?: PromoteConsequenceObject[];
 
-  /**
-   * Custom JSON object that will be appended to the userData array in the response. This object isn\'t interpreted by the API. It\'s limited to 1kB of minified JSON.
-   */
-  userData?: any | null;
+  params?: ParamsConsequence;
 };

package/model/deletedAtResponse.ts

@@ -5,12 +5,12 @@
  */
 export type DeletedAtResponse = {
   /**
-   * 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 and this `taskID`.
+   * 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`.
    */
   taskID: number;
 
   /**
-   * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time when the object was deleted, in RFC 3339 format.
    */
   deletedAt: string;
 };

package/model/distinct.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.
 
 /**
- * Enables [deduplication or grouping of results (Algolia\'s _distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature)).
+ * Determines how many records of a group are included in the search results.  Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).  The `distinct` setting is ignored if `attributeForDistinct` is not set.
  */
 export type Distinct = boolean | number;

package/model/exactOnSingleWordQuery.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.
 
 /**
- * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the query contains only one word.
+ * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word.  - `attribute`.   The Exact ranking criterion is 1 if the query word and attribute value are the same.   For example, a search for \"road\" will match the value \"road\", but not \"road trip\".  - `none`.   The Exact ranking criterion is ignored on single-word searches.  - `word`.   The Exact ranking criterion is 1 if the query word is found in the attribute value.   The query word must have at least 3 characters and must not be a stop word.   Only exact matches will be highlighted,   partial and prefix matches won\'t.
  */
 export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';

package/model/facetFilters.ts

@@ -1,8 +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 { MixedSearchFilters } from './mixedSearchFilters';
-
 /**
- * [Filter hits by facet value](https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/).
+ * Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
  */
-export type FacetFilters = MixedSearchFilters[] | string;
+export type FacetFilters = FacetFilters[] | string;

package/model/facetOrdering.ts

@@ -4,13 +4,13 @@ import type { Facets } from './facets';
 import type { Value } from './value';
 
 /**
- * Defines the ordering of facets (widgets).
+ * Order of facet names and facet values in your UI.
  */
 export type FacetOrdering = {
   facets?: Facets;
 
   /**
-   * Ordering of facet values within an individual facet.
+   * Order of facet values. One object for each facet.
    */
   values?: Record<string, Value>;
 };

package/model/facets.ts

@@ -1,11 +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.
 
 /**
- * Ordering of facets (widgets).
+ * Order of facet names.
  */
 export type Facets = {
   /**
-   * Pinned order of facet lists.
+   * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
    */
   order?: string[];
 };

package/model/{recommendationModels.ts → fallbackParams.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 FallbackParams = Record<string, any> & SearchParamsObject;

package/model/fbtModel.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.
+
+/**
+ * Frequently bought together model.  This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
+ */
+export type FbtModel = 'bought-together';

package/model/{consequenceHide.ts → frequentlyBoughtTogether.ts}

@@ -1,11 +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.
 
-/**
- * Unique identifier of the record to hide.
- */
-export type ConsequenceHide = {
+import type { FbtModel } from './fbtModel';
+
+export type FrequentlyBoughtTogether = {
+  model: FbtModel;
+
   /**
-   * Unique object identifier.
+   * Unique record identifier.
    */
   objectID: string;
 };

package/model/getRecommendationsParams.ts

@@ -3,11 +3,11 @@
 import type { RecommendationsRequest } from './recommendationsRequest';
 
 /**
- * Recommend parameters.
+ * Recommend request body.
  */
 export type GetRecommendationsParams = {
   /**
-   * Request parameters depend on the model (recommendations or trending).
+   * Recommendation request with parameters depending on the requested model.
    */
   requests: RecommendationsRequest[];
 };

package/model/{editType.ts → hideConsequenceObject.ts}

@@ -1,6 +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.
 
 /**
- * Type of edit.
+ * Object ID of the recommendation you want to exclude.
  */
-export type EditType = 'remove' | 'replace';
+export type HideConsequenceObject = {
+  /**
+   * Unique record identifier.
+   */
+  objectID?: string;
+};

package/model/highlightResult.ts

@@ -4,4 +4,5 @@ import type { HighlightResultOption } from './highlightResultOption';
 
 export type HighlightResult =
   | HighlightResultOption
+  | HighlightResultOption[]
   | Record<string, HighlightResultOption>;

package/model/highlightResultOption.ts

@@ -3,18 +3,18 @@
 import type { MatchLevel } from './matchLevel';
 
 /**
- * Show highlighted section and words matched on a query.
+ * Surround words that match the query with HTML tags for highlighting.
  */
 export type HighlightResultOption = {
   /**
-   * Markup text with `facetQuery` matches highlighted.
+   * Highlighted attribute value, including HTML tags.
    */
   value: string;
 
   matchLevel: MatchLevel;
 
   /**
-   * List of words from the query that matched the object.
+   * List of matched words from the search query.
    */
   matchedWords: string[];
 

package/model/ignorePlurals.ts

@@ -1,6 +1,8 @@
 // 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 { SupportedLanguage } from './supportedLanguage';
+
 /**
- * Treats singular, plurals, and other forms of declensions as matching terms. `ignorePlurals` is used in conjunction with the `queryLanguages` setting. _list_: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the ignore plurals feature, where singulars and plurals are considered equivalent (\"foot\" = \"feet\"). The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the ignore plurals feature, so that singulars and plurals aren\'t considered to be the same (\"foot\" will not find \"feet\").
+ * Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.
  */
-export type IgnorePlurals = string[] | boolean;
+export type IgnorePlurals = SupportedLanguage[] | boolean;