@algolia/client-search 5.7.0 → 5.8.1

package/index.d.ts

@@ -1,2 +1 @@
-// eslint-disable-next-line import/no-unresolved
 export * from './dist/node';

package/index.js

@@ -1,2 +1 @@
-// eslint-disable-next-line import/no-commonjs,import/extensions
-module.exports = require('./dist/builds/node.cjs');
+module.exports = require('./dist/builds/node.cjs');

package/model/acl.ts

@@ -7,8 +7,8 @@ export type Acl =
   | 'addObject'
   | 'analytics'
   | 'browse'
-  | 'deleteIndex'
   | 'deleteObject'
+  | 'deleteIndex'
   | 'editSettings'
   | 'inference'
   | 'listIndexes'

package/model/action.ts

@@ -5,9 +5,9 @@
  */
 export type Action =
   | 'addObject'
-  | 'clear'
-  | 'delete'
-  | 'deleteObject'
+  | 'updateObject'
   | 'partialUpdateObject'
   | 'partialUpdateObjectNoCreate'
-  | 'updateObject';
+  | 'deleteObject'
+  | 'delete'
+  | 'clear';

package/model/alternativesAsExact.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 AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
+export type AlternativesAsExact = 'ignorePlurals' | 'singleWordSynonym' | 'multiWordsSynonym';

package/model/anchoring.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.
 
 /**
- * Which part of the search query the pattern should match:  - `startsWith`. The pattern must match the begginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query.  Empty queries are only allowed as pattern with `anchoring: is`.
+ * Which part of the search query the pattern should match:  - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query.  Empty queries are only allowed as patterns with `anchoring: is`.
  */
-export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';
+export type Anchoring = 'is' | 'startsWith' | 'endsWith' | 'contains';

package/model/apiKey.ts

@@ -9,7 +9,7 @@ export type ApiKey = {
   /**
    * Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint\'s reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
    */
-  acl: Acl[];
+  acl: Array<Acl>;
 
   /**
    * Description of an API key to help you identify this API key.
@@ -19,7 +19,7 @@ export type ApiKey = {
   /**
    * Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
    */
-  indexes?: string[];
+  indexes?: Array<string>;
 
   /**
    * Maximum number of results this API key can retrieve in one query. By default, there\'s no limit.
@@ -32,14 +32,14 @@ export type ApiKey = {
   maxQueriesPerIPPerHour?: number;
 
   /**
-   * Query parameters to add when making API requests with this API key.  To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses.  Creating an API key fails if the request is made from an IP address that\'s outside the restricted range.
+   * Query parameters to add when making API requests with this API key.  To restrict this API key to specific IP addresses, add the `restrictSources` parameter. You can only add a single source, but you can provide a range of IP addresses.  Creating an API key fails if the request is made from an IP address outside the restricted range.
    */
   queryParameters?: string;
 
   /**
    * Allowed HTTP referrers for this API key.  By default, all referrers are allowed. You can use leading and trailing wildcard characters (`*`):  - `https://algolia.com/_*` allows all referrers starting with \"https://algolia.com/\" - `*.algolia.com` allows all referrers ending with \".algolia.com\" - `*algolia.com*` allows all referrers in the domain \"algolia.com\".  Like all HTTP headers, referrers can be spoofed. Don\'t rely on them to secure your data. For more information, see [HTTP referrer restrictions](https://www.algolia.com/doc/guides/security/security-best-practices/#http-referrers-restrictions).
    */
-  referers?: string[];
+  referers?: Array<string>;
 
   /**
    * Duration (in seconds) after which the API key expires. By default, API keys don\'t expire.

package/model/aroundPrecision.ts

@@ -5,4 +5,4 @@ import type { Range } from './range';
 /**
  * Precision of a coordinate-based search in meters to group results with similar distances.  The Geo ranking criterion considers all matches within the same range of distances to be equal.
  */
-export type AroundPrecision = Range[] | number;
+export type AroundPrecision = number | Array<Range>;

package/model/aroundRadius.ts

@@ -5,4 +5,4 @@ import type { AroundRadiusAll } from './aroundRadiusAll';
 /**
  * Maximum radius for a search around a central location.  This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.
  */
-export type AroundRadius = AroundRadiusAll | number;
+export type AroundRadius = number | AroundRadiusAll;

package/model/attributeToUpdate.ts

@@ -2,4 +2,4 @@
 
 import type { BuiltInOperation } from './builtInOperation';
 
-export type AttributeToUpdate = BuiltInOperation | string;
+export type AttributeToUpdate = string | BuiltInOperation;

package/model/automaticFacetFilters.ts

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

package/model/banner.ts

@@ -0,0 +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 { BannerImage } from './bannerImage';
+import type { BannerLink } from './bannerLink';
+
+/**
+ * a search banner with image and url.
+ */
+export type Banner = {
+  image?: BannerImage;
+
+  link?: BannerLink;
+};

package/model/bannerImage.ts

@@ -0,0 +1,12 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { BannerImageUrl } from './bannerImageUrl';
+
+/**
+ * image of a search banner.
+ */
+export type BannerImage = {
+  urls?: Array<BannerImageUrl>;
+
+  title?: string;
+};

package/model/bannerImageUrl.ts

@@ -0,0 +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.
+
+/**
+ * url for a search banner image.
+ */
+export type BannerImageUrl = {
+  url?: string;
+};

package/model/bannerLink.ts

@@ -0,0 +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.
+
+/**
+ * link for a banner defined in merchandising studio.
+ */
+export type BannerLink = {
+  url?: string;
+};

package/model/baseIndexSettings.ts

@@ -4,14 +4,14 @@ import type { SupportedLanguage } from './supportedLanguage';
 
 export type BaseIndexSettings = {
   /**
-   * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).  Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive.  **Modifiers**  - `filterOnly(\"ATTRIBUTE\")`.   Allows using this attribute as a filter, but doesn\'t evalue the facet values.  - `searchable(\"ATTRIBUTE\")`.   Allows searching for facet values.  - `afterDistinct(\"ATTRIBUTE\")`.   Evaluates the facet count _after_ deduplication with `distinct`.   This ensures accurate facet counts.   You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
+   * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).  Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive.  **Modifiers**  - `filterOnly(\"ATTRIBUTE\")`.   Allows the attribute to be used as a filter but doesn\'t evaluate the facet values.  - `searchable(\"ATTRIBUTE\")`.   Allows searching for facet values.  - `afterDistinct(\"ATTRIBUTE\")`.   Evaluates the facet count _after_ deduplication with `distinct`.   This ensures accurate facet counts.   You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
    */
-  attributesForFaceting?: string[];
+  attributesForFaceting?: Array<string>;
 
   /**
-   * Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).  Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you\'ll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index.  **Modifier**  - `virtual(\"REPLICA\")`.   Create a virtual replica,   Virtual replicas don\'t increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).
+   * Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).  Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you\'ll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index.  **Modifier**  - `virtual(\"REPLICA\")`.   Create a virtual replica,   Virtual replicas don\'t increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).
    */
-  replicas?: string[];
+  replicas?: Array<string>;
 
   /**
    * Maximum number of search results that can be obtained through pagination.  Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can\'t be guaranteed.
@@ -21,22 +21,22 @@ export type BaseIndexSettings = {
   /**
    * Attributes that can\'t be retrieved at query time.  This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don\'t want to include it in the search results. Attribute names are case-sensitive.
    */
-  unretrievableAttributes?: string[];
+  unretrievableAttributes?: Array<string>;
 
   /**
    * Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
    */
-  disableTypoToleranceOnWords?: string[];
+  disableTypoToleranceOnWords?: Array<string>;
 
   /**
    * Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead).  Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive.
    */
-  attributesToTransliterate?: string[];
+  attributesToTransliterate?: Array<string>;
 
   /**
    * Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive.
    */
-  camelCaseAttributes?: string[];
+  camelCaseAttributes?: Array<string>;
 
   /**
    * Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Attribute names are case-sensitive.  Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately.  You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`). 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).
@@ -46,12 +46,12 @@ export type BaseIndexSettings = {
   /**
    * Languages for language-specific processing steps, such as word detection and dictionary settings.  **You should always specify an indexing 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/).
    */
-  indexLanguages?: SupportedLanguage[];
+  indexLanguages?: Array<SupportedLanguage>;
 
   /**
    * Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive.
    */
-  disablePrefixOnAttributes?: string[];
+  disablePrefixOnAttributes?: Array<string>;
 
   /**
    * Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.
@@ -59,9 +59,9 @@ export type BaseIndexSettings = {
   allowCompressionOfIntegerArray?: boolean;
 
   /**
-   * Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive.  By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes.  If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`.  **Modifier**  - `equalOnly(\"ATTRIBUTE\")`.   Support only filtering based on equality comparisons `=` and `!=`.
+   * Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive.  By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes.  To turn off filtering for all numeric attributes, specify an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`.  **Modifier**  - `equalOnly(\"ATTRIBUTE\")`.   Support only filtering based on equality comparisons `=` and `!=`.
    */
-  numericAttributesForFiltering?: string[];
+  numericAttributesForFiltering?: Array<string>;
 
   /**
    * Controls which separators are indexed.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren\'t indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
@@ -69,9 +69,9 @@ export type BaseIndexSettings = {
   separatorsToIndex?: string;
 
   /**
-   * Attributes used for searching. Attribute names are case-sensitive.  By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered.  For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).  **Modifier**  - `unordered(\"ATTRIBUTE\")`.   Ignore the position of a match within the attribute.  Without modifier, matches at the beginning of an attribute rank higer than matches at the end.
+   * Attributes used for searching. Attribute names are case-sensitive.  By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered.  For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).  **Modifier**  - `unordered(\"ATTRIBUTE\")`.   Ignore the position of a match within the attribute.  Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
    */
-  searchableAttributes?: string[];
+  searchableAttributes?: Array<string>;
 
   /**
    * An object with custom data.  You can store up to 32kB as custom data.
@@ -81,7 +81,7 @@ export type BaseIndexSettings = {
   /**
    * Characters and their normalized replacements. This overrides Algolia\'s default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
    */
-  customNormalization?: Record<string, Record<string, string>>;
+  customNormalization?: { [key: string]: { [key: string]: string } };
 
   /**
    * Attribute that should be used to establish groups of results. Attribute names are case-sensitive.  All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results.  If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts.

package/model/baseSearchParams.ts

@@ -3,4 +3,4 @@
 import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
 import type { SearchParamsQuery } from './searchParamsQuery';
 
-export type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;
+export type BaseSearchParams = SearchParamsQuery & BaseSearchParamsWithoutQuery;

package/model/baseSearchParamsWithoutQuery.ts

@@ -35,12 +35,12 @@ export type BaseSearchParamsWithoutQuery = {
   /**
    * Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
    */
-  restrictSearchableAttributes?: string[];
+  restrictSearchableAttributes?: Array<string>;
 
   /**
    * 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[];
+  facets?: Array<string>;
 
   /**
    * 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`.
@@ -63,7 +63,7 @@ export type BaseSearchParamsWithoutQuery = {
   length?: number;
 
   /**
-   * 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;
 
@@ -84,22 +84,22 @@ export type BaseSearchParamsWithoutQuery = {
   /**
    * 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>>;
 
   /**
    * 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?: SupportedLanguage[];
+  naturalLanguages?: Array<SupportedLanguage>;
 
   /**
    * 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[];
+  ruleContexts?: Array<string>;
 
   /**
    * 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).
@@ -134,7 +134,7 @@ export type BaseSearchParamsWithoutQuery = {
   /**
    * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
    */
-  analyticsTags?: string[];
+  analyticsTags?: Array<string>;
 
   /**
    * Whether to include this search when calculating processing-time percentiles.

package/model/baseSearchResponse.ts

@@ -46,12 +46,12 @@ export type BaseSearchResponse = Record<string, any> & {
   /**
    * Facet counts.
    */
-  facets?: Record<string, Record<string, number>>;
+  facets?: { [key: string]: { [key: string]: number } };
 
   /**
    * Statistics for numerical facets.
    */
-  facets_stats?: Record<string, FacetStats>;
+  facets_stats?: { [key: string]: FacetStats };
 
   /**
    * Index name used for the query.

package/model/batchAssignUserIdsParams.ts

@@ -12,5 +12,5 @@ export type BatchAssignUserIdsParams = {
   /**
    * User IDs to assign.
    */
-  users: string[];
+  users: Array<string>;
 };

package/model/batchDictionaryEntriesParams.ts

@@ -14,5 +14,5 @@ export type BatchDictionaryEntriesParams = {
   /**
    * List of additions and deletions to your dictionaries.
    */
-  requests: BatchDictionaryEntriesRequest[];
+  requests: Array<BatchDictionaryEntriesRequest>;
 };

package/model/batchParams.ts

@@ -6,5 +6,5 @@ import type { MultipleBatchRequest } from './multipleBatchRequest';
  * Batch parameters.
  */
 export type BatchParams = {
-  requests: MultipleBatchRequest[];
+  requests: Array<MultipleBatchRequest>;
 };

package/model/batchResponse.ts

@@ -9,5 +9,5 @@ export type BatchResponse = {
   /**
    * Unique record identifiers.
    */
-  objectIDs: string[];
+  objectIDs: Array<string>;
 };

package/model/batchWriteParams.ts

@@ -6,5 +6,5 @@ import type { BatchRequest } from './batchRequest';
  * Batch parameters.
  */
 export type BatchWriteParams = {
-  requests: BatchRequest[];
+  requests: Array<BatchRequest>;
 };

package/model/booleanString.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 BooleanString = 'false' | 'true';
+export type BooleanString = 'true' | 'false';

package/model/browseParams.ts

@@ -1,6 +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 { BrowseParamsObject } from './browseParamsObject';
+
 import type { SearchParamsString } from './searchParamsString';
 
-export type BrowseParams = BrowseParamsObject | SearchParamsString;
+export type BrowseParams = SearchParamsString | BrowseParamsObject;

package/model/browseParamsObject.ts

@@ -3,4 +3,4 @@
 import type { Cursor } from './cursor';
 import type { SearchParamsObject } from './searchParamsObject';
 
-export type BrowseParamsObject = Cursor & SearchParamsObject;
+export type BrowseParamsObject = SearchParamsObject & Cursor;

package/model/browseResponse.ts

@@ -5,4 +5,4 @@ import type { BrowsePagination } from './browsePagination';
 import type { Cursor } from './cursor';
 import type { SearchHits } from './searchHits';
 
-export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & BrowsePagination & Cursor & SearchHits<T>;
+export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & BrowsePagination & SearchHits<T> & Cursor;

package/model/builtInOperationType.ts

@@ -4,10 +4,10 @@
  * How to change the attribute.
  */
 export type BuiltInOperationType =
+  | 'Increment'
+  | 'Decrement'
   | 'Add'
+  | 'Remove'
   | 'AddUnique'
-  | 'Decrement'
-  | 'Increment'
   | 'IncrementFrom'
-  | 'IncrementSet'
-  | 'Remove';
+  | 'IncrementSet';

package/model/builtInOperationValue.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 BuiltInOperationValue = number | string;
+export type BuiltInOperationValue = string | number;

package/model/clientMethodProps.ts

@@ -1,32 +1,48 @@
 // 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 { CreateIterablePromise } from '@algolia/client-common';
+import { Action } from '../model/action';
+
+import { ApiKey } from '../model/apiKey';
+import { ApiKeyOperation } from '../model/apiKeyOperation';
+import { AssignUserIdParams } from '../model/assignUserIdParams';
+import { BatchAssignUserIdsParams } from '../model/batchAssignUserIdsParams';
+import { BatchDictionaryEntriesParams } from '../model/batchDictionaryEntriesParams';
+
+import { BatchWriteParams } from '../model/batchWriteParams';
+import { BrowseParams } from '../model/browseParams';
+
+import { DeleteByParams } from '../model/deleteByParams';
+
+import { DictionaryType } from '../model/dictionaryType';
+
+import { IndexSettings } from '../model/indexSettings';
+
+import { LogType } from '../model/logType';
+
+import { OperationIndexParams } from '../model/operationIndexParams';
+
+import { Rule } from '../model/rule';
+
+import { SearchDictionaryEntriesParams } from '../model/searchDictionaryEntriesParams';
+
+import { SearchForFacetValuesRequest } from '../model/searchForFacetValuesRequest';
+
+import { SearchParams } from '../model/searchParams';
+
+import { SearchRulesParams } from '../model/searchRulesParams';
+
+import { SearchSynonymsParams } from '../model/searchSynonymsParams';
+
+import { SecuredApiKeyRestrictions } from '../model/securedApiKeyRestrictions';
+
+import { Source } from '../model/source';
+import { SynonymHit } from '../model/synonymHit';
 
-import type { Action } from './action';
-import type { ApiKey } from './apiKey';
-import type { ApiKeyOperation } from './apiKeyOperation';
-import type { AssignUserIdParams } from './assignUserIdParams';
-import type { BatchAssignUserIdsParams } from './batchAssignUserIdsParams';
-import type { BatchDictionaryEntriesParams } from './batchDictionaryEntriesParams';
-import type { BatchWriteParams } from './batchWriteParams';
-import type { BrowseParams } from './browseParams';
-import type { DeleteByParams } from './deleteByParams';
-import type { DictionaryType } from './dictionaryType';
-import type { IndexSettings } from './indexSettings';
-import type { LogType } from './logType';
-import type { OperationIndexParams } from './operationIndexParams';
-import type { Rule } from './rule';
-import type { SearchDictionaryEntriesParams } from './searchDictionaryEntriesParams';
-import type { SearchForFacetValuesRequest } from './searchForFacetValuesRequest';
 import type { SearchForFacetsOptions } from './searchForFacetsOptions';
 import type { SearchForHitsOptions } from './searchForHitsOptions';
-import type { SearchParams } from './searchParams';
-import type { SearchParamsObject } from './searchParamsObject';
-import type { SearchRulesParams } from './searchRulesParams';
-import type { SearchSynonymsParams } from './searchSynonymsParams';
-import type { SecuredApiKeyRestrictions } from './securedApiKeyRestrictions';
-import type { Source } from './source';
-import type { SynonymHit } from './synonymHit';
+import { SearchParamsObject } from './searchParamsObject';
+
+import type { CreateIterablePromise } from '@algolia/client-common';
 
 /**
  * Properties for the `addOrUpdateObject` method.
@@ -41,7 +57,7 @@ export type AddOrUpdateObjectProps = {
    */
   objectID: string;
   /**
-   * The record, a schemaless object with attributes that are useful in the context of search and discovery.
+   * The record. A schemaless object with attributes that are useful in the context of search and discovery.
    */
   body: Record<string, unknown>;
 };
@@ -150,7 +166,7 @@ export type CustomDeleteProps = {
   /**
    * Query parameters to apply to the current query.
    */
-  parameters?: Record<string, any>;
+  parameters?: { [key: string]: any };
 };
 
 /**
@@ -164,7 +180,7 @@ export type CustomGetProps = {
   /**
    * Query parameters to apply to the current query.
    */
-  parameters?: Record<string, any>;
+  parameters?: { [key: string]: any };
 };
 
 /**
@@ -178,7 +194,7 @@ export type CustomPostProps = {
   /**
    * Query parameters to apply to the current query.
    */
-  parameters?: Record<string, any>;
+  parameters?: { [key: string]: any };
   /**
    * Parameters to send with the custom request.
    */
@@ -196,7 +212,7 @@ export type CustomPutProps = {
   /**
    * Query parameters to apply to the current query.
    */
-  parameters?: Record<string, any>;
+  parameters?: { [key: string]: any };
   /**
    * Parameters to send with the custom request.
    */
@@ -351,7 +367,7 @@ export type GetObjectProps = {
   /**
    * Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned.  `objectID` is always retrieved.  Attributes included in `unretrievableAttributes` won\'t be retrieved unless the request is authenticated with the admin API key.
    */
-  attributesToRetrieve?: string[];
+  attributesToRetrieve?: Array<string>;
 };
 
 /**
@@ -504,7 +520,7 @@ export type ReplaceSourcesProps = {
   /**
    * Allowed sources.
    */
-  source: Source[];
+  source: Array<Source>;
 };
 
 /**
@@ -526,7 +542,7 @@ export type SaveObjectProps = {
    */
   indexName: string;
   /**
-   * The record, a schemaless object with attributes that are useful in the context of search and discovery.
+   * The record. A schemaless object with attributes that are useful in the context of search and discovery.
    */
   body: Record<string, unknown>;
 };
@@ -558,7 +574,7 @@ export type SaveRulesProps = {
    * Name of the index on which to perform the operation.
    */
   indexName: string;
-  rules: Rule[];
+  rules: Array<Rule>;
   /**
    * Whether changes are applied to replica indices.
    */
@@ -596,7 +612,7 @@ export type SaveSynonymsProps = {
    * Name of the index on which to perform the operation.
    */
   indexName: string;
-  synonymHit: SynonymHit[];
+  synonymHit: Array<SynonymHit>;
   /**
    * Whether changes are applied to replica indices.
    */