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

package/lite/model/recommendationsRequest.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.
+
+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 =
+  | BoughtTogetherQuery
+  | LookingSimilarQuery
+  | RecommendedForYouQuery
+  | RelatedQuery
+  | TrendingFacetsQuery
+  | TrendingItemsQuery;

package/lite/model/recommendationsResults.ts

@@ -0,0 +1,9 @@
+// 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 { BaseSearchResponse } from './baseSearchResponse';
+import type { RecommendationsHits } from './recommendationsHits';
+import type { SearchPagination } from './searchPagination';
+
+export type RecommendationsResults = BaseSearchResponse &
+  RecommendationsHits &
+  SearchPagination;

package/lite/model/recommendedForYou.ts

@@ -0,0 +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';
+
+export type RecommendedForYou = {
+  model: RecommendedForYouModel;
+
+  fallbackParameters?: FallbackParams;
+};

package/lite/model/{operationType.ts → 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.
 
 /**
- * Operation to perform (_move_ or _copy_).
+ * \"Recommened for you\" model.
  */
-export type OperationType = 'copy' | 'move';
+export type RecommendedForYouModel = 'recommended-for-you';

package/lite/model/recommendedForYouQuery.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 { RecommendedForYou } from './recommendedForYou';
+
+export type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;

package/lite/model/redirect.ts

@@ -3,7 +3,7 @@
 import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
 
 /**
- * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
+ * [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.
  */
 export type Redirect = {
   index?: RedirectRuleIndexMetadata[];

package/lite/model/{dictionaryAction.ts → redirectURL.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.
 
 /**
- * Actions to perform.
+ * The redirect rule container.
  */
-export type DictionaryAction = 'addEntry' | 'deleteEntry';
+export type RedirectURL = {
+  url?: string;
+};

package/lite/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/lite/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/lite/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/lite/model/removeStopWords.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';
+
 /**
- * Removes stop (common) words from the query before executing it. `removeStopWords` is used in conjunction with the `queryLanguages` setting. _list_: language ISO codes for which stop words should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the stop words feature, ensuring that stop words are removed from consideration in a search. 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 stop words feature, allowing stop words to be taken into account in a search.
+ * 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.
  */
-export type RemoveStopWords = string[] | boolean;
+export type RemoveStopWords = SupportedLanguage[] | boolean;

package/lite/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 to [remove words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/) from the query when it doesn\'t match any hits.
+ * 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/lite/model/renderingContent.ts

@@ -1,10 +1,13 @@
 // 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 { FacetOrdering } from './facetOrdering';
+import type { RedirectURL } from './redirectURL';
 
 /**
- * Extra content for the search UI, for example, to control the [ordering and display of facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor). You can set a default value and dynamically override it with [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/).
+ * 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.
  */
 export type RenderingContent = {
   facetOrdering?: FacetOrdering;
+
+  redirect?: RedirectURL;
 };

package/lite/model/searchForFacetValuesResponse.ts

@@ -3,10 +3,13 @@
 import type { FacetHits } from './facetHits';
 
 export type SearchForFacetValuesResponse = {
+  /**
+   * Matching facet values.
+   */
   facetHits: FacetHits[];
 
   /**
-   * See the `facetsCount` field of the `exhaustive` object in the response.
+   * Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
    */
   exhaustiveFacetsCount: boolean;
 

package/lite/model/searchForFacetsOptions.ts

@@ -9,7 +9,7 @@ export type SearchForFacetsOptions = {
   facet: string;
 
   /**
-   * Algolia index name.
+   * Index name (case-sensitive).
    */
   indexName: string;
 
@@ -19,7 +19,7 @@ export type SearchForFacetsOptions = {
   facetQuery?: string;
 
   /**
-   * Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+   * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
    */
   maxFacetHits?: number;
 

package/lite/model/searchForHitsOptions.ts

@@ -4,7 +4,7 @@ import type { SearchTypeDefault } from './searchTypeDefault';
 
 export type SearchForHitsOptions = {
   /**
-   * Algolia index name.
+   * Index name (case-sensitive).
    */
   indexName: string;
 

package/lite/model/searchHits.ts

@@ -3,15 +3,18 @@
 import type { Hit } from './hit';
 
 export type SearchHits<T = Record<string, any>> = Record<string, any> & {
+  /**
+   * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
+   */
   hits: Array<Hit<T>>;
 
   /**
-   * Text to search for in an index.
+   * Search query.
    */
-  query: T;
+  query: string;
 
   /**
    * URL-encoded string of all search parameters.
    */
-  params: T;
+  params: string;
 };

package/lite/model/searchPagination.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.
+
+export type SearchPagination = {
+  /**
+   * Page of search results to retrieve.
+   */
+  page: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits: number;
+
+  /**
+   * Number of pages of results.
+   */
+  nbPages: number;
+
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage: number;
+};

package/lite/model/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.
 
 import type { SearchParamsObject } from './searchParamsObject';
-import type { SearchParamsString } from './searchParamsString';
 
-export type SearchParams = SearchParamsObject | SearchParamsString;
+export type SearchParams = Record<string, any> & SearchParamsObject;

package/lite/model/searchParamsObject.ts

@@ -3,4 +3,7 @@
 import type { BaseSearchParams } from './baseSearchParams';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
 
+/**
+ * Each parameter value, including the `query` must not be larger than 512 bytes.
+ */
 export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;

package/lite/model/searchParamsQuery.ts

@@ -2,7 +2,7 @@
 
 export type SearchParamsQuery = {
   /**
-   * Text to search for in an index.
+   * Search query.
    */
   query?: string;
 };

package/lite/model/searchResponse.ts

@@ -2,6 +2,8 @@
 
 import type { BaseSearchResponse } from './baseSearchResponse';
 import type { SearchHits } from './searchHits';
+import type { SearchPagination } from './searchPagination';
 
 export type SearchResponse<T = Record<string, any>> = BaseSearchResponse &
-  SearchHits<T>;
+  SearchHits<T> &
+  SearchPagination;

package/lite/model/searchStrategy.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.
 
 /**
- * - `none`: executes all queries. - `stopIfEnoughMatches`: executes queries one by one, stopping further query execution as soon as a query matches at least the `hitsPerPage` number of results.
+ * Strategy for multiple search queries:  - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.
  */
 export type SearchStrategy = 'none' | 'stopIfEnoughMatches';

package/lite/model/semanticSearch.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.
 
 /**
- * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
  */
 export type SemanticSearch = {
   /**
-   * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
+   * Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
    */
   eventSources?: string[] | null;
 };

package/lite/model/snippetResult.ts

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

package/lite/model/snippetResultOption.ts

@@ -3,11 +3,11 @@
 import type { MatchLevel } from './matchLevel';
 
 /**
- * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ * Snippets that show the context around a matching search query.
  */
 export type SnippetResultOption = {
   /**
-   * Markup text with `facetQuery` matches highlighted.
+   * Highlighted attribute value, including HTML tags.
    */
   value: string;
 

package/lite/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.
 
 /**
- * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ * 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/lite/model/supportedLanguage.ts

@@ -0,0 +1,74 @@
+// 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.
+
+/**
+ * ISO code for a supported language.
+ */
+export type SupportedLanguage =
+  | 'af'
+  | 'ar'
+  | 'az'
+  | 'bg'
+  | 'bn'
+  | 'ca'
+  | 'cs'
+  | 'cy'
+  | 'da'
+  | 'de'
+  | 'el'
+  | 'en'
+  | 'eo'
+  | 'es'
+  | 'et'
+  | 'eu'
+  | 'fa'
+  | 'fi'
+  | 'fo'
+  | 'fr'
+  | 'ga'
+  | 'gl'
+  | 'he'
+  | 'hi'
+  | 'hu'
+  | 'hy'
+  | 'id'
+  | 'is'
+  | 'it'
+  | 'ja'
+  | 'ka'
+  | 'kk'
+  | 'ko'
+  | 'ku'
+  | 'ky'
+  | 'lt'
+  | 'lv'
+  | 'mi'
+  | 'mn'
+  | 'mr'
+  | 'ms'
+  | 'mt'
+  | 'nb'
+  | 'nl'
+  | 'no'
+  | 'ns'
+  | 'pl'
+  | 'ps'
+  | 'pt-br'
+  | 'pt'
+  | 'qu'
+  | 'ro'
+  | 'ru'
+  | 'sk'
+  | 'sq'
+  | 'sv'
+  | 'sw'
+  | 'ta'
+  | 'te'
+  | 'th'
+  | 'tl'
+  | 'tn'
+  | 'tr'
+  | 'tt'
+  | 'uk'
+  | 'ur'
+  | 'uz'
+  | 'zh';

package/lite/model/tagFilters.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 tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
+ * 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`.
  */
-export type TagFilters = MixedSearchFilters[] | string;
+export type TagFilters = TagFilters[] | string;

package/lite/model/trendingFacetHit.ts

@@ -0,0 +1,21 @@
+// 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 facet hit.
+ */
+export type TrendingFacetHit = {
+  /**
+   * Recommendation score.
+   */
+  _score: number;
+
+  /**
+   * 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;
+};

package/lite/model/trendingFacets.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 { TrendingFacetsModel } from './trendingFacetsModel';
+
+export type TrendingFacets = {
+  /**
+   * Facet attribute for which to retrieve trending facet values.
+   */
+  facetName: any | null;
+
+  model: TrendingFacetsModel;
+
+  fallbackParameters?: FallbackParams;
+};

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

package/lite/model/trendingFacetsQuery.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 { TrendingFacets } from './trendingFacets';
+
+export type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;

package/lite/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/lite/model/{dictionaryEntryState.ts → 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.
 
 /**
- * Indicates whether a dictionary entry is active (`enabled`) or inactive (`disabled`).
+ * Trending items model.  Trending items are determined from the number of conversion events collected on them.
  */
-export type DictionaryEntryState = 'disabled' | 'enabled';
+export type TrendingItemsModel = 'trending-items';

package/lite/model/trendingItemsQuery.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 { TrendingItems } from './trendingItems';
+
+export type TrendingItemsQuery = BaseRecommendRequest & TrendingItems;

package/lite/model/typoTolerance.ts

@@ -3,6 +3,6 @@
 import type { TypoToleranceEnum } from './typoToleranceEnum';
 
 /**
- * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
+ * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
  */
 export type TypoTolerance = TypoToleranceEnum | boolean;

package/lite/model/typoToleranceEnum.ts

@@ -1,3 +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.
 
+/**
+ * - `min`. Return matches with the lowest number of typos.   For example, if you have matches without typos, only include those.   But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos.   With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
+ */
 export type TypoToleranceEnum = 'min' | 'strict';

package/lite/model/value.ts

@@ -4,9 +4,14 @@ import type { SortRemainingBy } from './sortRemainingBy';
 
 export type Value = {
   /**
-   * 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[];
 
   sortRemainingBy?: SortRemainingBy;
+
+  /**
+   * Hide facet values.
+   */
+  hide?: string[];
 };