@algolia/client-search 5.7.0 → 5.8.0

package/model/consequence.ts

@@ -13,7 +13,7 @@ export type Consequence = {
   /**
    * Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either individually, or as groups of up to 100 records each.
    */
-  promote?: Promote[];
+  promote?: Array<Promote>;
 
   /**
    * Whether promoted records must match an active filter for the consequence to be applied.  This ensures that user actions (filtering the search) are given a higher precendence. For example, if you promote a record with the `color: red` attribute, and the user filters the search for `color: blue`, the \"red\" record won\'t be shown.
@@ -23,7 +23,7 @@ export type Consequence = {
   /**
    * Records you want to hide from the search results.
    */
-  hide?: ConsequenceHide[];
+  hide?: Array<ConsequenceHide>;
 
   /**
    * A JSON object with custom data that will be appended to the `userData` array in the response. This object isn\'t interpreted by the API and is limited to 1&nbsp;kB of minified JSON.

package/model/consequenceQueryObject.ts

@@ -6,10 +6,10 @@ export type ConsequenceQueryObject = {
   /**
    * Words to remove from the search query.
    */
-  remove?: string[];
+  remove?: Array<string>;
 
   /**
    * Changes to make to the search query.
    */
-  edits?: Edit[];
+  edits?: Array<Edit>;
 };

package/model/deleteByParams.ts

@@ -18,7 +18,7 @@ export type DeleteByParams = {
   tagFilters?: TagFilters;
 
   /**
-   * 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`.
+   * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.  Only records included within a 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;
 
@@ -27,10 +27,10 @@ export type DeleteByParams = {
   /**
    * 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[][];
+  insideBoundingBox?: Array<Array<number>>;
 
   /**
    * 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[][];
+  insidePolygon?: Array<Array<number>>;
 };

package/model/dictionaryEntry.ts

@@ -23,12 +23,12 @@ export type DictionaryEntry = Record<string, any> & {
   /**
    * Matching words in the `plurals` dictionary including declensions.
    */
-  words?: string[];
+  words?: Array<string>;
 
   /**
    * Invividual components of a compound word in the `compounds` dictionary.
    */
-  decomposition?: string[];
+  decomposition?: Array<string>;
 
   state?: DictionaryEntryState;
 

package/model/dictionaryEntryState.ts

@@ -3,4 +3,4 @@
 /**
  * Whether a dictionary entry is active.
  */
-export type DictionaryEntryState = 'disabled' | 'enabled';
+export type DictionaryEntryState = 'enabled' | 'disabled';

package/model/dictionaryType.ts

@@ -1,3 +1,3 @@
 // 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 DictionaryType = 'compounds' | 'plurals' | 'stopwords';
+export type DictionaryType = 'plurals' | 'stopwords' | 'compounds';

package/model/facetFilters.ts

@@ -3,4 +3,4 @@
 /**
  * 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 = FacetFilters[] | string;
+export type FacetFilters = Array<FacetFilters> | string;

package/model/facetOrdering.ts

@@ -12,5 +12,5 @@ export type FacetOrdering = {
   /**
    * Order of facet values. One object for each facet.
    */
-  values?: Record<string, Value>;
+  values?: { [key: string]: Value };
 };

package/model/facets.ts

@@ -7,5 +7,5 @@ export type Facets = {
   /**
    * 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[];
+  order?: Array<string>;
 };

package/model/fetchedIndex.ts

@@ -54,7 +54,7 @@ export type FetchedIndex = {
   /**
    * Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
    */
-  replicas?: string[];
+  replicas?: Array<string>;
 
   /**
    * Only present if the index is a [virtual replica](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-an-index-alphabetically/#virtual-replicas).

package/model/getApiKeyResponse.ts

@@ -3,4 +3,4 @@
 import type { ApiKey } from './apiKey';
 import type { BaseGetApiKeyResponse } from './baseGetApiKeyResponse';
 
-export type GetApiKeyResponse = ApiKey & BaseGetApiKeyResponse;
+export type GetApiKeyResponse = BaseGetApiKeyResponse & ApiKey;

package/model/getLogsResponse.ts

@@ -3,5 +3,5 @@
 import type { Log } from './log';
 
 export type GetLogsResponse = {
-  logs: Log[];
+  logs: Array<Log>;
 };

package/model/getObjectsParams.ts

@@ -6,5 +6,5 @@ import type { GetObjectsRequest } from './getObjectsRequest';
  * Request parameters.
  */
 export type GetObjectsParams = {
-  requests: GetObjectsRequest[];
+  requests: Array<GetObjectsRequest>;
 };

package/model/getObjectsRequest.ts

@@ -7,7 +7,7 @@ export type GetObjectsRequest = {
   /**
    * Attributes to retrieve. If not specified, all retrievable attributes are returned.
    */
-  attributesToRetrieve?: string[];
+  attributesToRetrieve?: Array<string>;
 
   /**
    * Object ID for the record to retrieve.

package/model/getTopUserIdsResponse.ts

@@ -9,5 +9,5 @@ export type GetTopUserIdsResponse = {
   /**
    * Key-value pairs with cluster names as keys and lists of users with the highest number of records per cluster as values.
    */
-  topUsers: Array<Record<string, UserId[]>>;
+  topUsers: Array<{ [key: string]: Array<UserId> }>;
 };

package/model/hasPendingMappingsResponse.ts

@@ -9,5 +9,5 @@ export type HasPendingMappingsResponse = {
   /**
    * Cluster pending mapping state: migrating, creating, deleting.
    */
-  clusters?: Record<string, string[]>;
+  clusters?: { [key: string]: Array<string> };
 };

package/model/highlightResult.ts

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

package/model/highlightResultOption.ts

@@ -16,7 +16,7 @@ export type HighlightResultOption = {
   /**
    * List of matched words from the search query.
    */
-  matchedWords: string[];
+  matchedWords: Array<string>;
 
   /**
    * Whether the entire attribute value is highlighted.

package/model/hit.ts

@@ -16,12 +16,12 @@ export type Hit<T = Record<string, any>> = T & {
   /**
    * Surround words that match the query with HTML tags for highlighting.
    */
-  _highlightResult?: Record<string, HighlightResult>;
+  _highlightResult?: { [key: string]: HighlightResult };
 
   /**
    * Snippets that show the context around a matching search query.
    */
-  _snippetResult?: Record<string, SnippetResult>;
+  _snippetResult?: { [key: string]: SnippetResult };
 
   _rankingInfo?: RankingInfo;
 

package/model/ignorePlurals.ts

@@ -6,4 +6,4 @@ import type { SupportedLanguage } from './supportedLanguage';
 /**
  * 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 = BooleanString | SupportedLanguage[] | boolean;
+export type IgnorePlurals = Array<SupportedLanguage> | BooleanString | boolean;

package/model/index.ts

@@ -15,6 +15,11 @@ export * from './assignUserIdParams';
 export * from './attributeToUpdate';
 export * from './automaticFacetFilter';
 export * from './automaticFacetFilters';
+export * from './banner';
+export * from './bannerImage';
+export * from './bannerImageUrl';
+export * from './bannerLink';
+export * from './banners';
 export * from './baseGetApiKeyResponse';
 export * from './baseIndexSettings';
 export * from './baseSearchParams';
@@ -35,6 +40,7 @@ export * from './browseResponse';
 export * from './builtInOperation';
 export * from './builtInOperationType';
 export * from './builtInOperationValue';
+export * from './clientMethodProps';
 export * from './condition';
 export * from './consequence';
 export * from './consequenceHide';
@@ -45,8 +51,8 @@ export * from './createdAtResponse';
 export * from './cursor';
 export * from './deleteApiKeyResponse';
 export * from './deleteByParams';
-export * from './deleteSourceResponse';
 export * from './deletedAtResponse';
+export * from './deleteSourceResponse';
 export * from './dictionaryAction';
 export * from './dictionaryEntry';
 export * from './dictionaryEntryState';
@@ -63,8 +69,8 @@ export * from './exhaustive';
 export * from './facetFilters';
 export * from './facetHits';
 export * from './facetOrdering';
-export * from './facetStats';
 export * from './facets';
+export * from './facetStats';
 export * from './fetchedIndex';
 export * from './getApiKeyResponse';
 export * from './getDictionarySettingsResponse';
@@ -89,8 +95,8 @@ export * from './listUserIdsResponse';
 export * from './log';
 export * from './logQuery';
 export * from './logType';
-export * from './matchLevel';
 export * from './matchedGeoLocation';
+export * from './matchLevel';
 export * from './mode';
 export * from './multipleBatchRequest';
 export * from './multipleBatchResponse';
@@ -106,7 +112,6 @@ export * from './promoteObjectIDs';
 export * from './queryType';
 export * from './range';
 export * from './rankingInfo';
-export * from './reRankingApplyFilter';
 export * from './redirect';
 export * from './redirectRuleIndexData';
 export * from './redirectRuleIndexMetadata';
@@ -117,16 +122,17 @@ export * from './removeWordsIfNoResults';
 export * from './renderingContent';
 export * from './replaceAllObjectsResponse';
 export * from './replaceSourceResponse';
+export * from './reRankingApplyFilter';
 export * from './rule';
 export * from './saveObjectResponse';
 export * from './saveSynonymResponse';
 export * from './scopeType';
 export * from './searchDictionaryEntriesParams';
 export * from './searchDictionaryEntriesResponse';
-export * from './searchForFacetValuesRequest';
-export * from './searchForFacetValuesResponse';
 export * from './searchForFacets';
 export * from './searchForFacetsOptions';
+export * from './searchForFacetValuesRequest';
+export * from './searchForFacetValuesResponse';
 export * from './searchForHits';
 export * from './searchForHitsOptions';
 export * from './searchHits';
@@ -173,5 +179,5 @@ export * from './userHighlightResult';
 export * from './userHit';
 export * from './userId';
 export * from './value';
+export * from './widgets';
 export * from './withPrimary';
-export * from './clientMethodProps';

package/model/indexSettingsAsSearchParams.ts

@@ -19,17 +19,17 @@ export type IndexSettingsAsSearchParams = {
   /**
    * Attributes to include in the API response.  To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive.  - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
    */
-  attributesToRetrieve?: string[];
+  attributesToRetrieve?: Array<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**  - `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[];
+  ranking?: Array<string>;
 
   /**
    * Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive.  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[];
+  customRanking?: Array<string>;
 
   /**
    * Relevancy threshold below which less relevant results aren\'t included in the results.  You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
@@ -39,12 +39,12 @@ export type IndexSettingsAsSearchParams = {
   /**
    * Attributes to highlight.  By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive.  With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI.  For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
    */
-  attributesToHighlight?: string[];
+  attributesToHighlight?: Array<string>;
 
   /**
    * Attributes for which to enable snippets. Attribute names are case-sensitive.  Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
    */
-  attributesToSnippet?: string[];
+  attributesToSnippet?: Array<string>;
 
   /**
    * HTML tag to insert before the highlighted parts in all highlighted results and snippets.
@@ -91,7 +91,7 @@ export type IndexSettingsAsSearchParams = {
   /**
    * Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive.  Returning only exact matches can help when:  - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many.   This can happen with attributes that are long blocks of text, such as product descriptions.  Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
    */
-  disableTypoToleranceOnAttributes?: string[];
+  disableTypoToleranceOnAttributes?: Array<string>;
 
   ignorePlurals?: IgnorePlurals;
 
@@ -105,7 +105,7 @@ export type IndexSettingsAsSearchParams = {
   /**
    * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**.  **You should always specify a query language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
    */
-  queryLanguages?: SupportedLanguage[];
+  queryLanguages?: Array<SupportedLanguage>;
 
   /**
    * Whether to split compound words in the query into their building blocks.  For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn\'t work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won\'t be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
@@ -136,31 +136,31 @@ export type IndexSettingsAsSearchParams = {
   advancedSyntax?: boolean;
 
   /**
-   * Words that should be considered optional when found in the query.  By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn\'t include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher.  For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:  - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:   results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words dividied by 5 (rounded down).   For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.  For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
+   * Words that should be considered optional when found in the query.  By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn\'t include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher.  For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:  - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:   results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).   For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.  For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
    */
-  optionalWords?: string[];
+  optionalWords?: Array<string>;
 
   /**
-   * Searchable attributes for which you want to [turn off 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). Attribute names are case-sensitive.  This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
+   * Searchable attributes for which you want to [turn off 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). Attribute names are case-sensitive.  This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
    */
-  disableExactOnAttributes?: string[];
+  disableExactOnAttributes?: Array<string>;
 
   exactOnSingleWordQuery?: ExactOnSingleWordQuery;
 
   /**
    * 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[];
+  alternativesAsExact?: Array<AlternativesAsExact>;
 
   /**
    * 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[];
+  advancedSyntaxFeatures?: Array<AdvancedSyntaxFeatures>;
 
   distinct?: Distinct;
 
   /**
-   * Whether to replace a highlighted word with the matched synonym.  By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted.  With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurences of \"house\" are replaced by \"home\" in the highlighted response.
+   * Whether to replace a highlighted word with the matched synonym.  By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted.  With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurrences of \"house\" are replaced by \"home\" in the highlighted response.
    */
   replaceSynonymsInHighlight?: boolean;
 
@@ -172,7 +172,7 @@ export type IndexSettingsAsSearchParams = {
   /**
    * Properties to include in the API response of `search` and `browse` requests.  By default, all response properties are included. To reduce the response size, you can select, which attributes should be included.  You can\'t exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter.  Don\'t exclude properties that you might need in your search UI.
    */
-  responseFields?: string[];
+  responseFields?: Array<string>;
 
   /**
    * 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).

package/model/listApiKeysResponse.ts

@@ -6,5 +6,5 @@ export type ListApiKeysResponse = {
   /**
    * API keys.
    */
-  keys: GetApiKeyResponse[];
+  keys: Array<GetApiKeyResponse>;
 };

package/model/listClustersResponse.ts

@@ -7,5 +7,5 @@ export type ListClustersResponse = {
   /**
    * Key-value pairs with cluster names as keys and lists of users with the highest number of records per cluster as values.
    */
-  topUsers: string[];
+  topUsers: Array<string>;
 };

package/model/listIndicesResponse.ts

@@ -6,7 +6,7 @@ export type ListIndicesResponse = {
   /**
    * All indices in your Algolia application.
    */
-  items: FetchedIndex[];
+  items: Array<FetchedIndex>;
 
   /**
    * Number of pages.

package/model/listUserIdsResponse.ts

@@ -9,5 +9,5 @@ export type ListUserIdsResponse = {
   /**
    * User IDs.
    */
-  userIDs: UserId[];
+  userIDs: Array<UserId>;
 };

package/model/log.ts

@@ -76,5 +76,5 @@ export type Log = {
   /**
    * Queries performed for the given request.
    */
-  inner_queries?: LogQuery[];
+  inner_queries?: Array<LogQuery>;
 };

package/model/logType.ts

@@ -1,3 +1,3 @@
 // 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 LogType = 'all' | 'build' | 'error' | 'query';
+export type LogType = 'all' | 'query' | 'build' | 'error';

package/model/matchLevel.ts

@@ -3,4 +3,4 @@
 /**
  * Whether the whole query string matches or only a part.
  */
-export type MatchLevel = 'full' | 'none' | 'partial';
+export type MatchLevel = 'none' | 'partial' | 'full';

package/model/mode.ts

@@ -3,4 +3,4 @@
 /**
  * Search mode the index will use to query for results.  This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
  */
-export type Mode = 'keywordSearch' | 'neuralSearch';
+export type Mode = 'neuralSearch' | 'keywordSearch';

package/model/multipleBatchResponse.ts

@@ -4,10 +4,10 @@ export type MultipleBatchResponse = {
   /**
    * Task IDs. One for each index.
    */
-  taskID: Record<string, number>;
+  taskID: { [key: string]: number };
 
   /**
    * Unique record identifiers.
    */
-  objectIDs: string[];
+  objectIDs: Array<string>;
 };

package/model/numericFilters.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.
 
 /**
- * Filter by numeric facets.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
+ * Filter by numeric facets.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
  */
-export type NumericFilters = NumericFilters[] | string;
+export type NumericFilters = Array<NumericFilters> | string;

package/model/operationIndexParams.ts

@@ -14,5 +14,5 @@ export type OperationIndexParams = {
   /**
    * **Only for copying.**  If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged. If you omit the `scope` parameter, everything is copied: records, settings, synonyms, and rules.
    */
-  scope?: ScopeType[];
+  scope?: Array<ScopeType>;
 };

package/model/operationType.ts

@@ -3,4 +3,4 @@
 /**
  * Operation to perform on the index.
  */
-export type OperationType = 'copy' | 'move';
+export type OperationType = 'move' | 'copy';

package/model/optionalFilters.ts

@@ -3,4 +3,4 @@
 /**
  * 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. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.  - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
  */
-export type OptionalFilters = OptionalFilters[] | string;
+export type OptionalFilters = Array<OptionalFilters> | string;

package/model/promote.ts

@@ -3,4 +3,4 @@
 import type { PromoteObjectID } from './promoteObjectID';
 import type { PromoteObjectIDs } from './promoteObjectIDs';
 
-export type Promote = PromoteObjectID | PromoteObjectIDs;
+export type Promote = PromoteObjectIDs | PromoteObjectID;

package/model/promoteObjectIDs.ts

@@ -7,7 +7,7 @@ export type PromoteObjectIDs = {
   /**
    * Object IDs of the records you want to promote.  The records are placed as a group at the `position`. For example, if you want to promote four records to position `0`, they will be the first four search results.
    */
-  objectIDs: string[];
+  objectIDs: Array<string>;
 
   /**
    * Position in the search results where you want to show the promoted records.

package/model/queryType.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 if and how query words are interpreted as prefixes.  By default, only the last query word is treated as prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower.  For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
+ * Determines if and how query words are interpreted as prefixes.  By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower.  For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
  */
-export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
+export type QueryType = 'prefixLast' | 'prefixAll' | 'prefixNone';

package/model/reRankingApplyFilter.ts

@@ -3,4 +3,4 @@
 /**
  * Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
  */
-export type ReRankingApplyFilter = ReRankingApplyFilter[] | string;
+export type ReRankingApplyFilter = Array<ReRankingApplyFilter> | string;

package/model/redirect.ts

@@ -6,5 +6,5 @@ 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/), this this parameter is for internal use only.
  */
 export type Redirect = {
-  index?: RedirectRuleIndexMetadata[];
+  index?: Array<RedirectRuleIndexMetadata>;
 };

package/model/removeStopWords.ts

@@ -5,4 +5,4 @@ import type { SupportedLanguage } from './supportedLanguage';
 /**
  * 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 = SupportedLanguage[] | boolean;
+export type RemoveStopWords = Array<SupportedLanguage> | boolean;

package/model/removeWordsIfNoResults.ts

@@ -3,4 +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/).
  */
-export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
+export type RemoveWordsIfNoResults = 'none' | 'lastWords' | 'firstWords' | 'allOptional';

package/model/renderingContent.ts

@@ -2,12 +2,15 @@
 
 import type { FacetOrdering } from './facetOrdering';
 import type { RedirectURL } from './redirectURL';
+import type { Widgets } from './widgets';
 
 /**
- * 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.
+ * 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;
+
+  widgets?: Widgets;
 };

package/model/replaceAllObjectsResponse.ts

@@ -9,7 +9,7 @@ export type ReplaceAllObjectsResponse = {
   /**
    * The response of the `batch` request(s).
    */
-  batchResponses: BatchResponse[];
+  batchResponses: Array<BatchResponse>;
 
   moveOperationResponse: UpdatedAtResponse;
 };