@algolia/client-search 5.7.0 → 5.8.1

package/dist/node.d.cts

@@ -1,16 +1,6 @@
 import * as _algolia_client_common from '@algolia/client-common';
 import { CreateIterablePromise, CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
 
-/**
- * Access control list permissions.
- */
-type Acl = 'addObject' | 'analytics' | 'browse' | 'deleteIndex' | 'deleteObject' | 'editSettings' | 'inference' | 'listIndexes' | 'logs' | 'personalization' | 'recommendation' | 'search' | 'seeUnretrievableAttributes' | 'settings' | 'usage';
-
-/**
- * Type of indexing operation.
- */
-type Action = 'addObject' | 'clear' | 'delete' | 'deleteObject' | 'partialUpdateObject' | 'partialUpdateObjectNoCreate' | 'updateObject';
-
 type AddApiKeyResponse = {
     /**
      * API key.
@@ -22,14 +12,10 @@ type AddApiKeyResponse = {
     createdAt: string;
 };
 
-type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
-
-type AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
-
 /**
- * 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`.
+ * Access control list permissions.
  */
-type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';
+type Acl = 'addObject' | 'analytics' | 'browse' | 'deleteObject' | 'deleteIndex' | 'editSettings' | 'inference' | 'listIndexes' | 'logs' | 'personalization' | 'recommendation' | 'search' | 'seeUnretrievableAttributes' | 'settings' | 'usage';
 
 /**
  * API key object.
@@ -38,7 +24,7 @@ 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.
      */
@@ -46,7 +32,7 @@ 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.
      */
@@ -56,697 +42,1137 @@ 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.
      */
     validity?: number;
 };
 
-type ApiKeyOperation = 'add' | 'delete' | 'update';
-
-/**
- * Range object with lower and upper values in meters to define custom ranges.
- */
-type Range = {
-    /**
-     * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
-     */
-    from?: number;
-    /**
-     * Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
-     */
-    value?: number;
-};
-
-/**
- * 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.
- */
-type AroundPrecision = Range[] | number;
-
-/**
- * Return all records with a valid `_geoloc` attribute. Don\'t filter by distance.
- */
-type AroundRadiusAll = 'all';
-
-/**
- * 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.
- */
-type AroundRadius = AroundRadiusAll | number;
-
-/**
- * Assign userID parameters.
- */
-type AssignUserIdParams = {
-    /**
-     * Cluster name.
-     */
-    cluster: string;
-};
-
-/**
- * How to change the attribute.
- */
-type BuiltInOperationType = 'Add' | 'AddUnique' | 'Decrement' | 'Increment' | 'IncrementFrom' | 'IncrementSet' | 'Remove';
-
-type BuiltInOperationValue = number | string;
-
 /**
- * Update to perform on the attribute.
+ * Type of indexing operation.
  */
-type BuiltInOperation = {
-    _operation: BuiltInOperationType;
-    value: BuiltInOperationValue;
-};
+type Action = 'addObject' | 'updateObject' | 'partialUpdateObject' | 'partialUpdateObjectNoCreate' | 'deleteObject' | 'delete' | 'clear';
 
-type AttributeToUpdate = BuiltInOperation | string;
-
-/**
- * Filter or optional filter to be applied to the search.
- */
-type AutomaticFacetFilter = {
-    /**
-     * Facet name to be applied as filter. The name must match placeholders in the `pattern` parameter. For example, with `pattern: {facet:genre}`, `automaticFacetFilters` must be `genre`.
-     */
-    facet: string;
+type MultipleBatchRequest = {
+    action: Action;
     /**
-     * Filter scores to give different weights to individual filters.
+     * Operation arguments (varies with specified `action`).
      */
-    score?: number;
+    body?: Record<string, unknown>;
     /**
-     * Whether the filter is disjunctive or conjunctive.  If true the filter has multiple matches, multiple occurences are combined with the logical `OR` operation. If false, multiple occurences are combined with the logical `AND` operation.
+     * Index name (case-sensitive).
      */
-    disjunctive?: boolean;
+    indexName: string;
 };
 
 /**
- * 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.
+ * Batch parameters.
  */
-type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];
+type BatchParams = {
+    requests: Array<MultipleBatchRequest>;
+};
 
-type BaseGetApiKeyResponse = {
+type BatchResponse = {
     /**
-     * API key.
+     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
      */
-    value?: string;
+    taskID: number;
     /**
-     * Timestamp when the object was created, in milliseconds since the Unix epoch.
+     * Unique record identifiers.
      */
-    createdAt: number;
+    objectIDs: Array<string>;
 };
 
 /**
- * ISO code for a supported language.
+ * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
  */
-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';
-
-type BaseIndexSettings = {
+type Exhaustive = {
     /**
-     * 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))`.
+     * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
      */
-    attributesForFaceting?: string[];
+    facetsCount?: boolean;
     /**
-     * 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/).
+     * The value is `false` if not all facet values are retrieved.
      */
-    replicas?: string[];
+    facetValues?: boolean;
     /**
-     * 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.
+     * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
      */
-    paginationLimitedTo?: number;
+    nbHits?: boolean;
     /**
-     * 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.
+     * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
      */
-    unretrievableAttributes?: string[];
+    rulesMatch?: boolean;
     /**
-     * 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.
+     * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
      */
-    disableTypoToleranceOnWords?: string[];
+    typo?: boolean;
+};
+
+type FacetStats = {
     /**
-     * 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.
+     * Minimum value in the results.
      */
-    attributesToTransliterate?: string[];
+    min?: number;
     /**
-     * Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive.
+     * Maximum value in the results.
      */
-    camelCaseAttributes?: string[];
+    max?: number;
     /**
-     * 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).
+     * Average facet value in the results.
      */
-    decompoundedAttributes?: Record<string, unknown>;
+    avg?: number;
     /**
-     * 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/).
+     * Sum of all values in the results.
      */
-    indexLanguages?: SupportedLanguage[];
+    sum?: number;
+};
+
+/**
+ * Redirect rule data.
+ */
+type RedirectRuleIndexData = {
+    ruleObjectID: string;
+};
+
+type RedirectRuleIndexMetadata = {
     /**
-     * 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.
+     * Source index for the redirect rule.
      */
-    disablePrefixOnAttributes?: string[];
+    source: string;
     /**
-     * Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.
+     * Destination index for the redirect rule.
      */
-    allowCompressionOfIntegerArray?: boolean;
+    dest: string;
     /**
-     * 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 `!=`.
+     * Reason for the redirect rule.
      */
-    numericAttributesForFiltering?: string[];
+    reason: 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.
+     * Redirect rule status.
      */
-    separatorsToIndex?: string;
+    succeed: boolean;
+    data: RedirectRuleIndexData;
+};
+
+/**
+ * [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.
+ */
+type Redirect = {
+    index?: Array<RedirectRuleIndexMetadata>;
+};
+
+/**
+ * Order of facet names.
+ */
+type Facets = {
     /**
-     * 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.
+     * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
      */
-    searchableAttributes?: string[];
+    order?: Array<string>;
+};
+
+/**
+ * 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.
+ */
+type SortRemainingBy = 'count' | 'alpha' | 'hidden';
+
+type Value = {
     /**
-     * An object with custom data.  You can store up to 32kB as custom data.
+     * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
      */
-    userData?: Record<string, unknown>;
+    order?: Array<string>;
+    sortRemainingBy?: SortRemainingBy;
     /**
-     * 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/).
+     * Hide facet values.
      */
-    customNormalization?: Record<string, Record<string, string>>;
+    hide?: Array<string>;
+};
+
+/**
+ * Order of facet names and facet values in your UI.
+ */
+type FacetOrdering = {
+    facets?: Facets;
     /**
-     * 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.
+     * Order of facet values. One object for each facet.
      */
-    attributeForDistinct?: string;
+    values?: {
+        [key: string]: Value;
+    };
 };
 
 /**
- * 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`.
+ * The redirect rule container.
+ */
+type RedirectURL = {
+    url?: string;
+};
+
+/**
+ * url for a search banner image.
  */
-type FacetFilters = FacetFilters[] | string;
+type BannerImageUrl = {
+    url?: string;
+};
 
 /**
- * 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`.
+ * image of a search banner.
  */
-type NumericFilters = NumericFilters[] | string;
+type BannerImage = {
+    urls?: Array<BannerImageUrl>;
+    title?: string;
+};
 
 /**
- * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. 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.
+ * link for a banner defined in merchandising studio.
  */
-type OptionalFilters = OptionalFilters[] | string;
+type BannerLink = {
+    url?: string;
+};
 
 /**
- * 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`.
+ * a search banner with image and url.
  */
-type TagFilters = TagFilters[] | string;
+type Banner = {
+    image?: BannerImage;
+    link?: BannerLink;
+};
 
-type BaseSearchParamsWithoutQuery = {
+/**
+ * widgets returned from any rules that are applied to the current search.
+ */
+type Widgets = {
     /**
-     * Keywords to be used instead of the search query to conduct a more broader search.  Using the `similarQuery` parameter changes other settings:  - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`.  Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
+     * banners defined in the merchandising studio for the given search.
      */
-    similarQuery?: string;
+    banners?: Array<Banner>;
+};
+
+/**
+ * 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.
+ */
+type RenderingContent = {
+    facetOrdering?: FacetOrdering;
+    redirect?: RedirectURL;
+    widgets?: Widgets;
+};
+
+type BaseSearchResponse = Record<string, any> & {
     /**
-     * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+     * A/B test ID. This is only included in the response for indices that are part of an A/B test.
      */
-    filters?: string;
-    facetFilters?: FacetFilters;
-    optionalFilters?: OptionalFilters;
-    numericFilters?: NumericFilters;
-    tagFilters?: TagFilters;
+    abTestID?: number;
     /**
-     * Whether to sum all filter scores.  If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
+     * Variant ID. This is only included in the response for indices that are part of an A/B test.
      */
-    sumOrFiltersScores?: boolean;
+    abTestVariantID?: number;
     /**
-     * Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
+     * Computed geographical location.
      */
-    restrictSearchableAttributes?: string[];
+    aroundLatLng?: 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).
+     * Distance from a central coordinate provided by `aroundLatLng`.
      */
-    facets?: string[];
+    automaticRadius?: string;
+    exhaustive?: Exhaustive;
     /**
-     * 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`.
+     * See the `facetsCount` field of the `exhaustive` object in the response.
      */
-    facetingAfterDistinct?: boolean;
+    exhaustiveFacetsCount?: boolean;
     /**
-     * Page of search results to retrieve.
+     * See the `nbHits` field of the `exhaustive` object in the response.
      */
-    page?: number;
+    exhaustiveNbHits?: boolean;
     /**
-     * Position of the first hit to retrieve.
+     * See the `typo` field of the `exhaustive` object in the response.
      */
-    offset?: number;
+    exhaustiveTypo?: boolean;
     /**
-     * Number of hits to retrieve (used in combination with `offset`).
+     * Facet counts.
      */
-    length?: number;
+    facets?: {
+        [key: string]: {
+            [key: string]: 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`.
+     * Statistics for numerical facets.
      */
-    aroundLatLng?: string;
+    facets_stats?: {
+        [key: string]: FacetStats;
+    };
     /**
-     * Whether to obtain the coordinates from the request\'s IP address.
+     * Index name used for the query.
      */
-    aroundLatLngViaIP?: boolean;
-    aroundRadius?: AroundRadius;
-    aroundPrecision?: AroundPrecision;
+    index?: string;
     /**
-     * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
+     * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
      */
-    minimumAroundRadius?: number;
+    indexUsed?: string;
     /**
-     * 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).
+     * Warnings about the query.
      */
-    insideBoundingBox?: number[][];
+    message?: string;
     /**
-     * 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`.
+     * Number of hits selected and sorted by the relevant sort algorithm.
      */
-    insidePolygon?: number[][];
+    nbSortedHits?: 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`.
+     * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
      */
-    naturalLanguages?: SupportedLanguage[];
+    parsedQuery?: string;
     /**
-     * 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.
+     * Time the server took to process the request, in milliseconds.
      */
-    ruleContexts?: string[];
+    processingTimeMS: number;
     /**
-     * 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).
+     * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
      */
-    personalizationImpact?: number;
+    processingTimingsMS?: Record<string, unknown>;
     /**
-     * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
+     * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
      */
-    userToken?: string;
+    queryAfterRemoval?: string;
+    redirect?: Redirect;
+    renderingContent?: RenderingContent;
     /**
-     * Whether the search response should include detailed ranking information.
+     * Time the server took to process the request, in milliseconds.
      */
-    getRankingInfo?: boolean;
+    serverTimeMS?: number;
     /**
-     * Whether to take into account an index\'s synonyms for this search.
+     * Host name of the server that processed the request.
      */
-    synonyms?: boolean;
+    serverUsed?: string;
     /**
-     * Whether to include a `queryID` attribute in the response.  The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
+     * An object with custom data.  You can store up to 32kB as custom data.
      */
-    clickAnalytics?: boolean;
+    userData?: Record<string, unknown>;
     /**
-     * Whether this search will be included in Analytics.
+     * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
      */
-    analytics?: boolean;
+    queryID?: string;
     /**
-     * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     * Whether automatic events collection is enabled for the application.
      */
-    analyticsTags?: string[];
+    _automaticInsights?: boolean;
+};
+
+type BrowsePagination = {
     /**
-     * Whether to include this search when calculating processing-time percentiles.
+     * Page of search results to retrieve.
      */
-    percentileComputation?: boolean;
+    page?: number;
     /**
-     * Whether to enable A/B testing for this search.
+     * Number of results (hits).
      */
-    enableABTest?: boolean;
+    nbHits?: number;
+    /**
+     * Number of pages of results.
+     */
+    nbPages?: number;
+    /**
+     * Number of hits per page.
+     */
+    hitsPerPage?: number;
 };
 
-type SearchParamsQuery = {
+type Cursor = {
     /**
-     * Search query.
+     * Cursor to get the next page of the response.  The parameter must match the value returned in the response of a previous request. The last page of the response does not return a `cursor` attribute.
      */
-    query?: string;
+    cursor?: string;
 };
 
-type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;
+/**
+ * Whether the whole query string matches or only a part.
+ */
+type MatchLevel = 'none' | 'partial' | 'full';
 
 /**
- * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
+ * Surround words that match the query with HTML tags for highlighting.
  */
-type Exhaustive = {
+type HighlightResultOption = {
     /**
-     * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+     * Highlighted attribute value, including HTML tags.
      */
-    facetsCount?: boolean;
+    value: string;
+    matchLevel: MatchLevel;
     /**
-     * The value is `false` if not all facet values are retrieved.
+     * List of matched words from the search query.
      */
-    facetValues?: boolean;
+    matchedWords: Array<string>;
     /**
-     * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
+     * Whether the entire attribute value is highlighted.
      */
-    nbHits?: boolean;
+    fullyHighlighted?: boolean;
+};
+
+type HighlightResult = HighlightResultOption | {
+    [key: string]: HighlightResult;
+} | Array<HighlightResult>;
+
+type MatchedGeoLocation = {
     /**
-     * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
+     * Latitude of the matched location.
      */
-    rulesMatch?: boolean;
+    lat?: number;
     /**
-     * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
+     * Longitude of the matched location.
      */
-    typo?: boolean;
-};
-
-type FacetStats = {
+    lng?: number;
     /**
-     * Minimum value in the results.
+     * Distance between the matched location and the search location (in meters).
      */
-    min?: number;
+    distance?: number;
+};
+
+type Personalization = {
     /**
-     * Maximum value in the results.
+     * The score of the filters.
      */
-    max?: number;
+    filtersScore?: number;
     /**
-     * Average facet value in the results.
+     * The score of the ranking.
      */
-    avg?: number;
+    rankingScore?: number;
     /**
-     * Sum of all values in the results.
+     * The score of the event.
      */
-    sum?: number;
+    score?: number;
 };
 
 /**
- * Redirect rule data.
+ * Object with detailed information about the record\'s ranking.
  */
-type RedirectRuleIndexData = {
-    ruleObjectID: string;
-};
-
-type RedirectRuleIndexMetadata = {
+type RankingInfo = {
     /**
-     * Source index for the redirect rule.
+     * Whether a filter matched the query.
      */
-    source: string;
+    filters?: number;
     /**
-     * Destination index for the redirect rule.
+     * Position of the first matched word in the best matching attribute of the record.
      */
-    dest: string;
+    firstMatchedWord: number;
     /**
-     * Reason for the redirect rule.
+     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
      */
-    reason: string;
+    geoDistance: number;
     /**
-     * Redirect rule status.
+     * Precision used when computing the geo distance, in meters.
      */
-    succeed: boolean;
-    data: RedirectRuleIndexData;
-};
-
-/**
- * [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.
- */
-type Redirect = {
-    index?: RedirectRuleIndexMetadata[];
-};
-
-/**
- * Order of facet names.
- */
-type Facets = {
+    geoPrecision?: number;
+    matchedGeoLocation?: MatchedGeoLocation;
+    personalization?: Personalization;
     /**
-     * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
+     * Number of exactly matched words.
      */
-    order?: string[];
-};
-
-/**
- * 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.
- */
-type SortRemainingBy = 'alpha' | 'count' | 'hidden';
-
-type Value = {
+    nbExactWords: number;
     /**
-     * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
+     * Number of typos encountered when matching the record.
      */
-    order?: string[];
-    sortRemainingBy?: SortRemainingBy;
+    nbTypos: number;
     /**
-     * Hide facet values.
+     * Whether the record was promoted by a rule.
+     */
+    promoted?: boolean;
+    /**
+     * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
+     */
+    proximityDistance?: number;
+    /**
+     * Overall ranking of the record, expressed as a single integer. This attribute is internal.
+     */
+    userScore: number;
+    /**
+     * Number of matched words.
+     */
+    words?: number;
+    /**
+     * Whether the record is re-ranked.
      */
-    hide?: string[];
+    promotedByReRanking?: boolean;
 };
 
 /**
- * Order of facet names and facet values in your UI.
+ * Snippets that show the context around a matching search query.
  */
-type FacetOrdering = {
-    facets?: Facets;
+type SnippetResultOption = {
     /**
-     * Order of facet values. One object for each facet.
+     * Highlighted attribute value, including HTML tags.
      */
-    values?: Record<string, Value>;
+    value: string;
+    matchLevel: MatchLevel;
 };
 
-/**
- * The redirect rule container.
- */
-type RedirectURL = {
-    url?: string;
-};
+type SnippetResult = SnippetResultOption | {
+    [key: string]: SnippetResult;
+} | Array<SnippetResult>;
 
 /**
- * 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.
+ * Search result.  A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.
  */
-type RenderingContent = {
-    facetOrdering?: FacetOrdering;
-    redirect?: RedirectURL;
-};
-
-type BaseSearchResponse = Record<string, any> & {
-    /**
-     * A/B test ID. This is only included in the response for indices that are part of an A/B test.
-     */
-    abTestID?: number;
+type Hit<T = Record<string, any>> = T & {
     /**
-     * Variant ID. This is only included in the response for indices that are part of an A/B test.
+     * Unique record identifier.
      */
-    abTestVariantID?: number;
+    objectID: string;
     /**
-     * Computed geographical location.
+     * Surround words that match the query with HTML tags for highlighting.
      */
-    aroundLatLng?: string;
+    _highlightResult?: {
+        [key: string]: HighlightResult;
+    };
     /**
-     * Distance from a central coordinate provided by `aroundLatLng`.
+     * Snippets that show the context around a matching search query.
      */
-    automaticRadius?: string;
-    exhaustive?: Exhaustive;
+    _snippetResult?: {
+        [key: string]: SnippetResult;
+    };
+    _rankingInfo?: RankingInfo;
+    _distinctSeqID?: number;
+};
+
+type SearchHits<T = Record<string, any>> = Record<string, any> & {
     /**
-     * See the `facetsCount` field of the `exhaustive` object in the response.
+     * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
      */
-    exhaustiveFacetsCount?: boolean;
+    hits: Hit<T>[];
     /**
-     * See the `nbHits` field of the `exhaustive` object in the response.
+     * Search query.
      */
-    exhaustiveNbHits?: boolean;
+    query: string;
     /**
-     * See the `typo` field of the `exhaustive` object in the response.
+     * URL-encoded string of all search parameters.
      */
-    exhaustiveTypo?: boolean;
+    params: string;
+};
+
+type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & BrowsePagination & SearchHits<T> & Cursor;
+
+/**
+ * Response and creation timestamp.
+ */
+type CreatedAtResponse = {
     /**
-     * Facet counts.
+     * Date and time when the object was created, in RFC 3339 format.
      */
-    facets?: Record<string, Record<string, number>>;
+    createdAt: string;
+};
+
+type DeleteApiKeyResponse = {
     /**
-     * Statistics for numerical facets.
+     * Date and time when the object was deleted, in RFC 3339 format.
      */
-    facets_stats?: Record<string, FacetStats>;
+    deletedAt: string;
+};
+
+type DeleteSourceResponse = {
     /**
-     * Index name used for the query.
+     * Date and time when the object was deleted, in RFC 3339 format.
+     */
+    deletedAt: string;
+};
+
+/**
+ * Response, taskID, and deletion timestamp.
+ */
+type DeletedAtResponse = {
+    /**
+     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
+     */
+    taskID: number;
+    /**
+     * Date and time when the object was deleted, in RFC 3339 format.
+     */
+    deletedAt: string;
+};
+
+/**
+ * Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and boolean values.
+ */
+type StandardEntries = {
+    /**
+     * Key-value pair of a language ISO code and a boolean value.
+     */
+    plurals?: {
+        [key: string]: boolean;
+    } | null;
+    /**
+     * Key-value pair of a language ISO code and a boolean value.
+     */
+    stopwords?: {
+        [key: string]: boolean;
+    } | null;
+    /**
+     * Key-value pair of a language ISO code and a boolean value.
+     */
+    compounds?: {
+        [key: string]: boolean;
+    } | null;
+};
+
+/**
+ * Turn on or off the built-in Algolia stop words for a specific language.
+ */
+type DictionarySettingsParams = {
+    disableStandardEntries: StandardEntries;
+};
+
+type BaseGetApiKeyResponse = {
+    /**
+     * API key.
+     */
+    value?: string;
+    /**
+     * Timestamp when the object was created, in milliseconds since the Unix epoch.
+     */
+    createdAt: number;
+};
+
+type GetApiKeyResponse = BaseGetApiKeyResponse & ApiKey;
+
+type GetDictionarySettingsResponse = {
+    disableStandardEntries: StandardEntries;
+};
+
+type LogQuery = {
+    /**
+     * Index targeted by the query.
+     */
+    index_name?: string;
+    /**
+     * A user identifier.
+     */
+    user_token?: string;
+    /**
+     * Unique query identifier.
+     */
+    query_id?: string;
+};
+
+type Log = {
+    /**
+     * Date and time of the API request, in RFC 3339 format.
+     */
+    timestamp: string;
+    /**
+     * HTTP method of the request.
+     */
+    method: string;
+    /**
+     * HTTP status code of the response.
+     */
+    answer_code: string;
+    /**
+     * Request body.
+     */
+    query_body: string;
+    /**
+     * Response body.
+     */
+    answer: string;
+    /**
+     * URL of the API endpoint.
+     */
+    url: string;
+    /**
+     * IP address of the client that performed the request.
+     */
+    ip: string;
+    /**
+     * Request headers (API keys are obfuscated).
+     */
+    query_headers: string;
+    /**
+     * SHA1 signature of the log entry.
+     */
+    sha1: string;
+    /**
+     * Number of API requests.
+     */
+    nb_api_calls: string;
+    /**
+     * Processing time for the query in milliseconds. This doesn\'t include latency due to the network.
+     */
+    processing_time_ms: string;
+    /**
+     * Index targeted by the query.
      */
     index?: string;
     /**
-     * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
+     * Query parameters sent with the request.
      */
-    indexUsed?: string;
+    query_params?: string;
     /**
-     * Warnings about the query.
+     * Number of search results (hits) returned for the query.
      */
-    message?: string;
+    query_nb_hits?: string;
     /**
-     * Number of hits selected and sorted by the relevant sort algorithm.
+     * Queries performed for the given request.
      */
-    nbSortedHits?: number;
+    inner_queries?: Array<LogQuery>;
+};
+
+type GetLogsResponse = {
+    logs: Array<Log>;
+};
+
+/**
+ * Request body for retrieving records.
+ */
+type GetObjectsRequest = {
     /**
-     * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
+     * Attributes to retrieve. If not specified, all retrievable attributes are returned.
      */
-    parsedQuery?: string;
+    attributesToRetrieve?: Array<string>;
     /**
-     * Time the server took to process the request, in milliseconds.
+     * Object ID for the record to retrieve.
      */
-    processingTimeMS: number;
+    objectID: string;
     /**
-     * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
+     * Index from which to retrieve the records.
      */
-    processingTimingsMS?: Record<string, unknown>;
+    indexName: string;
+};
+
+/**
+ * Request parameters.
+ */
+type GetObjectsParams = {
+    requests: Array<GetObjectsRequest>;
+};
+
+type GetObjectsResponse<T = Record<string, any>> = {
     /**
-     * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
+     * Retrieved records.
      */
-    queryAfterRemoval?: string;
-    redirect?: Redirect;
-    renderingContent?: RenderingContent;
+    results: T[];
+};
+
+/**
+ * Task status, `published` if the task is completed, `notPublished` otherwise.
+ */
+type TaskStatus = 'published' | 'notPublished';
+
+type GetTaskResponse = {
+    status: TaskStatus;
+};
+
+/**
+ * Unique user ID.
+ */
+type UserId = {
     /**
-     * Time the server took to process the request, in milliseconds.
+     * Unique identifier of the user who makes the search request.
      */
-    serverTimeMS?: number;
+    userID: string;
     /**
-     * Host name of the server that processed the request.
+     * Cluster to which the user is assigned.
      */
-    serverUsed?: string;
+    clusterName: string;
     /**
-     * An object with custom data.  You can store up to 32kB as custom data.
+     * Number of records belonging to the user.
      */
-    userData?: Record<string, unknown>;
+    nbRecords: number;
     /**
-     * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+     * Data size used by the user.
      */
-    queryID?: string;
+    dataSize: number;
+};
+
+/**
+ * User IDs and clusters.
+ */
+type GetTopUserIdsResponse = {
     /**
-     * Whether automatic events collection is enabled for the application.
+     * Key-value pairs with cluster names as keys and lists of users with the highest number of records per cluster as values.
      */
-    _automaticInsights?: boolean;
+    topUsers: Array<{
+        [key: string]: Array<UserId>;
+    }>;
+};
+
+type HasPendingMappingsResponse = {
+    /**
+     * Whether there are clusters undergoing migration, creation, or deletion.
+     */
+    pending: boolean;
+    /**
+     * Cluster pending mapping state: migrating, creating, deleting.
+     */
+    clusters?: {
+        [key: string]: Array<string>;
+    };
 };
 
 /**
- * Assign userID parameters.
+ * Dictionary type. If `null`, this dictionary type isn\'t supported for the language.
  */
-type BatchAssignUserIdsParams = {
+type DictionaryLanguage = {
     /**
-     * Cluster name.
+     * Number of custom dictionary entries.
      */
-    cluster: string;
+    nbCustomEntries?: number;
+};
+
+/**
+ * Dictionary language.
+ */
+type Languages = {
+    plurals: DictionaryLanguage | null;
+    stopwords: DictionaryLanguage | null;
+    compounds: DictionaryLanguage | null;
+};
+
+type ListApiKeysResponse = {
     /**
-     * User IDs to assign.
+     * API keys.
      */
-    users: string[];
+    keys: Array<GetApiKeyResponse>;
 };
 
 /**
- * Actions to perform.
+ * Clusters.
  */
-type DictionaryAction = 'addEntry' | 'deleteEntry';
+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: Array<string>;
+};
+
+type FetchedIndex = {
+    /**
+     * Index name.
+     */
+    name: string;
+    /**
+     * Index creation date. An empty string means that the index has no records.
+     */
+    createdAt: string;
+    /**
+     * Date and time when the object was updated, in RFC 3339 format.
+     */
+    updatedAt: string;
+    /**
+     * Number of records contained in the index.
+     */
+    entries: number;
+    /**
+     * Number of bytes of the index in minified format.
+     */
+    dataSize: number;
+    /**
+     * Number of bytes of the index binary file.
+     */
+    fileSize: number;
+    /**
+     * Last build time.
+     */
+    lastBuildTimeS: number;
+    /**
+     * Number of pending indexing operations. This value is deprecated and should not be used.
+     */
+    numberOfPendingTasks: number;
+    /**
+     * A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.
+     */
+    pendingTask: boolean;
+    /**
+     * Only present if the index is a replica. Contains the name of the related primary index.
+     */
+    primary?: string;
+    /**
+     * Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
+     */
+    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).
+     */
+    virtual?: boolean;
+};
+
+type ListIndicesResponse = {
+    /**
+     * All indices in your Algolia application.
+     */
+    items: Array<FetchedIndex>;
+    /**
+     * Number of pages.
+     */
+    nbPages?: number;
+};
 
 /**
- * Whether a dictionary entry is active.
+ * User ID data.
  */
-type DictionaryEntryState = 'disabled' | 'enabled';
+type ListUserIdsResponse = {
+    /**
+     * User IDs.
+     */
+    userIDs: Array<UserId>;
+};
+
+type MultipleBatchResponse = {
+    /**
+     * Task IDs. One for each index.
+     */
+    taskID: {
+        [key: string]: number;
+    };
+    /**
+     * Unique record identifiers.
+     */
+    objectIDs: Array<string>;
+};
+
+type RemoveUserIdResponse = {
+    /**
+     * Date and time when the object was deleted, in RFC 3339 format.
+     */
+    deletedAt: string;
+};
 
 /**
- * Whether a dictionary entry is provided by Algolia (standard), or has been added by you (custom).
+ * Response, taskID, and update timestamp.
  */
-type DictionaryEntryType = 'custom' | 'standard';
+type UpdatedAtResponse = {
+    /**
+     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
+     */
+    taskID: number;
+    /**
+     * Date and time when the object was updated, in RFC 3339 format.
+     */
+    updatedAt: string;
+};
+
+type ReplaceAllObjectsResponse = {
+    copyOperationResponse: UpdatedAtResponse;
+    /**
+     * The response of the `batch` request(s).
+     */
+    batchResponses: Array<BatchResponse>;
+    moveOperationResponse: UpdatedAtResponse;
+};
+
+type ReplaceSourceResponse = {
+    /**
+     * Date and time when the object was updated, in RFC 3339 format.
+     */
+    updatedAt: string;
+};
 
 /**
- * Dictionary entry.
+ * 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`.
  */
-type DictionaryEntry = Record<string, any> & {
+type Anchoring = 'is' | 'startsWith' | 'endsWith' | 'contains';
+
+type Condition = {
     /**
-     * Unique identifier for the dictionary entry.
+     * Query pattern that triggers the rule.  You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\".
      */
-    objectID: string;
-    language?: SupportedLanguage;
+    pattern?: string;
+    anchoring?: Anchoring;
     /**
-     * Matching dictionary word for `stopwords` and `compounds` dictionaries.
+     * Whether the pattern should match plurals, synonyms, and typos.
      */
-    word?: string;
+    alternatives?: boolean;
     /**
-     * Matching words in the `plurals` dictionary including declensions.
+     * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
      */
-    words?: string[];
+    context?: string;
     /**
-     * Invividual components of a compound word in the `compounds` dictionary.
+     * Filters that trigger the rule.  You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
      */
-    decomposition?: string[];
-    state?: DictionaryEntryState;
-    type?: DictionaryEntryType;
+    filters?: string;
 };
 
-type BatchDictionaryEntriesRequest = {
-    action: DictionaryAction;
-    body: DictionaryEntry;
+/**
+ * Object ID of the record to hide.
+ */
+type ConsequenceHide = {
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
 };
 
 /**
- * Request body for updating dictionary entries.
+ * Range object with lower and upper values in meters to define custom ranges.
  */
-type BatchDictionaryEntriesParams = {
+type Range = {
+    /**
+     * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
+     */
+    from?: number;
+    /**
+     * Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
+     */
+    value?: number;
+};
+
+/**
+ * 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.
+ */
+type AroundPrecision = number | Array<Range>;
+
+/**
+ * Return all records with a valid `_geoloc` attribute. Don\'t filter by distance.
+ */
+type AroundRadiusAll = 'all';
+
+/**
+ * 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.
+ */
+type AroundRadius = number | AroundRadiusAll;
+
+/**
+ * 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`.
+ */
+type FacetFilters = Array<FacetFilters> | string;
+
+/**
+ * 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`.
+ */
+type NumericFilters = Array<NumericFilters> | string;
+
+/**
+ * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. 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.
+ */
+type OptionalFilters = Array<OptionalFilters> | string;
+
+/**
+ * ISO code for a supported language.
+ */
+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' | 'pt-br' | 'qu' | 'ro' | 'ru' | 'sk' | 'sq' | 'sv' | 'sw' | 'ta' | 'te' | 'th' | 'tl' | 'tn' | 'tr' | 'tt' | 'uk' | 'ur' | 'uz' | 'zh';
+
+/**
+ * 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`.
+ */
+type TagFilters = Array<TagFilters> | string;
+
+type BaseSearchParamsWithoutQuery = {
+    /**
+     * Keywords to be used instead of the search query to conduct a more broader search.  Using the `similarQuery` parameter changes other settings:  - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`.  Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
+     */
+    similarQuery?: string;
+    /**
+     * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+     */
+    filters?: string;
+    facetFilters?: FacetFilters;
+    optionalFilters?: OptionalFilters;
+    numericFilters?: NumericFilters;
+    tagFilters?: TagFilters;
+    /**
+     * Whether to sum all filter scores.  If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
+     */
+    sumOrFiltersScores?: boolean;
+    /**
+     * Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
+     */
+    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?: 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`.
+     */
+    facetingAfterDistinct?: boolean;
+    /**
+     * Page of search results to retrieve.
+     */
+    page?: number;
+    /**
+     * Position of the first hit to retrieve.
+     */
+    offset?: number;
+    /**
+     * Number of hits to retrieve (used in combination with `offset`).
+     */
+    length?: number;
+    /**
+     * 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;
+    /**
+     * Whether to obtain the coordinates from the request\'s IP address.
+     */
+    aroundLatLngViaIP?: boolean;
+    aroundRadius?: AroundRadius;
+    aroundPrecision?: AroundPrecision;
+    /**
+     * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
+     */
+    minimumAroundRadius?: number;
+    /**
+     * 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?: Array<Array<number>>;
     /**
-     * Whether to replace all custom entries in the dictionary with the ones sent with this request.
+     * 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`.
      */
-    clearExistingDictionaryEntries?: boolean;
+    insidePolygon?: Array<Array<number>>;
     /**
-     * List of additions and deletions to your dictionaries.
+     * 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`.
      */
-    requests: BatchDictionaryEntriesRequest[];
-};
-
-type MultipleBatchRequest = {
-    action: Action;
+    naturalLanguages?: Array<SupportedLanguage>;
     /**
-     * Operation arguments (varies with specified `action`).
+     * 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.
      */
-    body?: Record<string, unknown>;
+    ruleContexts?: Array<string>;
     /**
-     * Index name (case-sensitive).
+     * 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).
      */
-    indexName: string;
-};
-
-/**
- * Batch parameters.
- */
-type BatchParams = {
-    requests: MultipleBatchRequest[];
-};
-
-type BatchRequest = {
-    action: Action;
+    personalizationImpact?: number;
     /**
-     * Operation arguments (varies with specified `action`).
+     * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
-    body: Record<string, unknown>;
-};
-
-type BatchResponse = {
+    userToken?: string;
     /**
-     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
+     * Whether the search response should include detailed ranking information.
      */
-    taskID: number;
+    getRankingInfo?: boolean;
     /**
-     * Unique record identifiers.
+     * Whether to take into account an index\'s synonyms for this search.
      */
-    objectIDs: string[];
-};
-
-/**
- * Batch parameters.
- */
-type BatchWriteParams = {
-    requests: BatchRequest[];
-};
-
-type BooleanString = 'false' | 'true';
-
-type BrowsePagination = {
+    synonyms?: boolean;
     /**
-     * Page of search results to retrieve.
+     * Whether to include a `queryID` attribute in the response.  The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
      */
-    page?: number;
+    clickAnalytics?: boolean;
     /**
-     * Number of results (hits).
+     * Whether this search will be included in Analytics.
      */
-    nbHits?: number;
+    analytics?: boolean;
     /**
-     * Number of pages of results.
+     * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      */
-    nbPages?: number;
+    analyticsTags?: Array<string>;
     /**
-     * Number of hits per page.
+     * Whether to include this search when calculating processing-time percentiles.
      */
-    hitsPerPage?: number;
-};
-
-type Cursor = {
+    percentileComputation?: boolean;
     /**
-     * Cursor to get the next page of the response.  The parameter must match the value returned in the response of a previous request. The last page of the response does not return a `cursor` attribute.
+     * Whether to enable A/B testing for this search.
      */
-    cursor?: string;
+    enableABTest?: boolean;
 };
 
+type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
+
+type AlternativesAsExact = 'ignorePlurals' | 'singleWordSynonym' | 'multiWordsSynonym';
+
 /**
  * Determines how many records of a group are included in the search results.  Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).  The `distinct` setting is ignored if `attributeForDistinct` is not set.
  */
@@ -757,35 +1183,37 @@ type Distinct = boolean | number;
  */
 type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
 
+type BooleanString = 'true' | 'false';
+
 /**
  * Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.
  */
-type IgnorePlurals = BooleanString | SupportedLanguage[] | boolean;
+type IgnorePlurals = Array<SupportedLanguage> | BooleanString | boolean;
 
 /**
  * Search mode the index will use to query for results.  This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
  */
-type Mode = 'keywordSearch' | 'neuralSearch';
+type Mode = 'neuralSearch' | 'keywordSearch';
 
 /**
- * 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/).
  */
-type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
+type QueryType = 'prefixLast' | 'prefixAll' | 'prefixNone';
 
 /**
  * Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
  */
-type ReRankingApplyFilter = ReRankingApplyFilter[] | string;
+type ReRankingApplyFilter = Array<ReRankingApplyFilter> | string;
 
 /**
  * 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.
  */
-type RemoveStopWords = SupportedLanguage[] | boolean;
+type RemoveStopWords = Array<SupportedLanguage> | boolean;
 
 /**
  * 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/).
  */
-type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
+type RemoveWordsIfNoResults = 'none' | 'lastWords' | 'firstWords' | 'allOptional';
 
 /**
  * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
@@ -794,7 +1222,7 @@ type SemanticSearch = {
     /**
      * Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
      */
-    eventSources?: string[] | null;
+    eventSources?: Array<string> | null;
 };
 
 /**
@@ -803,23 +1231,23 @@ type SemanticSearch = {
 type TypoToleranceEnum = 'min' | 'strict';
 
 /**
- * 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.
+ * 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 concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active.
  */
-type TypoTolerance = TypoToleranceEnum | boolean;
+type TypoTolerance = boolean | TypoToleranceEnum;
 
 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.
      */
@@ -827,11 +1255,11 @@ 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.
      */
@@ -868,7 +1296,7 @@ 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;
     removeStopWords?: RemoveStopWords;
     /**
@@ -878,7 +1306,7 @@ 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).
      */
@@ -900,25 +1328,25 @@ 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;
     /**
@@ -928,7 +1356,7 @@ 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).
      */
@@ -954,215 +1382,27 @@ type IndexSettingsAsSearchParams = {
 };
 
 /**
- * Each parameter value, including the `query` must not be larger than 512 bytes.
- */
-type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
-
-type BrowseParamsObject = Cursor & SearchParamsObject;
-
-/**
- * Search parameters as query string.
- */
-type SearchParamsString = {
-    /**
-     * Search parameters as a URL-encoded query string.
-     */
-    params?: string;
-};
-
-type BrowseParams = BrowseParamsObject | SearchParamsString;
-
-/**
- * Whether the whole query string matches or only a part.
- */
-type MatchLevel = 'full' | 'none' | 'partial';
-
-/**
- * Surround words that match the query with HTML tags for highlighting.
- */
-type HighlightResultOption = {
-    /**
-     * Highlighted attribute value, including HTML tags.
-     */
-    value: string;
-    matchLevel: MatchLevel;
-    /**
-     * List of matched words from the search query.
-     */
-    matchedWords: string[];
-    /**
-     * Whether the entire attribute value is highlighted.
-     */
-    fullyHighlighted?: boolean;
-};
-
-type HighlightResult = HighlightResult[] | HighlightResultOption | {
-    [key: string]: HighlightResult;
-};
-
-type MatchedGeoLocation = {
-    /**
-     * Latitude of the matched location.
-     */
-    lat?: number;
-    /**
-     * Longitude of the matched location.
-     */
-    lng?: number;
-    /**
-     * Distance between the matched location and the search location (in meters).
-     */
-    distance?: number;
-};
-
-type Personalization = {
-    /**
-     * The score of the filters.
-     */
-    filtersScore?: number;
-    /**
-     * The score of the ranking.
-     */
-    rankingScore?: number;
-    /**
-     * The score of the event.
-     */
-    score?: number;
-};
-
-/**
- * Object with detailed information about the record\'s ranking.
- */
-type RankingInfo = {
-    /**
-     * Whether a filter matched the query.
-     */
-    filters?: number;
-    /**
-     * Position of the first matched word in the best matching attribute of the record.
-     */
-    firstMatchedWord: number;
-    /**
-     * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
-     */
-    geoDistance: number;
-    /**
-     * Precision used when computing the geo distance, in meters.
-     */
-    geoPrecision?: number;
-    matchedGeoLocation?: MatchedGeoLocation;
-    personalization?: Personalization;
-    /**
-     * Number of exactly matched words.
-     */
-    nbExactWords: number;
-    /**
-     * Number of typos encountered when matching the record.
-     */
-    nbTypos: number;
-    /**
-     * Whether the record was promoted by a rule.
-     */
-    promoted?: boolean;
-    /**
-     * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
-     */
-    proximityDistance?: number;
-    /**
-     * Overall ranking of the record, expressed as a single integer. This attribute is internal.
-     */
-    userScore: number;
-    /**
-     * Number of matched words.
-     */
-    words?: number;
-    /**
-     * Whether the record is re-ranked.
-     */
-    promotedByReRanking?: boolean;
-};
-
-/**
- * Snippets that show the context around a matching search query.
- */
-type SnippetResultOption = {
-    /**
-     * Highlighted attribute value, including HTML tags.
-     */
-    value: string;
-    matchLevel: MatchLevel;
-};
-
-type SnippetResult = SnippetResult[] | SnippetResultOption | {
-    [key: string]: SnippetResult;
-};
-
-/**
- * Search result.  A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.
+ * Filter or optional filter to be applied to the search.
  */
-type Hit<T = Record<string, any>> = T & {
-    /**
-     * Unique record identifier.
-     */
-    objectID: string;
-    /**
-     * Surround words that match the query with HTML tags for highlighting.
-     */
-    _highlightResult?: Record<string, HighlightResult>;
-    /**
-     * Snippets that show the context around a matching search query.
-     */
-    _snippetResult?: Record<string, SnippetResult>;
-    _rankingInfo?: RankingInfo;
-    _distinctSeqID?: number;
-};
-
-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>>;
-    /**
-     * Search query.
-     */
-    query: string;
-    /**
-     * URL-encoded string of all search parameters.
-     */
-    params: string;
-};
-
-type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & BrowsePagination & Cursor & SearchHits<T>;
-
-type Condition = {
-    /**
-     * Query pattern that triggers the rule.  You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\".
-     */
-    pattern?: string;
-    anchoring?: Anchoring;
+type AutomaticFacetFilter = {
     /**
-     * Whether the pattern should match plurals, synonyms, and typos.
+     * Facet name to be applied as filter. The name must match placeholders in the `pattern` parameter. For example, with `pattern: {facet:genre}`, `automaticFacetFilters` must be `genre`.
      */
-    alternatives?: boolean;
+    facet: string;
     /**
-     * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
+     * Filter scores to give different weights to individual filters.
      */
-    context?: string;
+    score?: number;
     /**
-     * Filters that trigger the rule.  You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
+     * Whether the filter is disjunctive or conjunctive.  If true the filter has multiple matches, multiple occurences are combined with the logical `OR` operation. If false, multiple occurences are combined with the logical `AND` operation.
      */
-    filters?: string;
+    disjunctive?: boolean;
 };
 
 /**
- * Object ID of the record to hide.
+ * 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.
  */
-type ConsequenceHide = {
-    /**
-     * Unique record identifier.
-     */
-    objectID: string;
-};
+type AutomaticFacetFilters = Array<AutomaticFacetFilter> | Array<string>;
 
 /**
  * Type of edit.
@@ -1185,11 +1425,11 @@ 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>;
 };
 
 /**
@@ -1230,14 +1470,14 @@ 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.
      */
     position: number;
 };
 
-type Promote = PromoteObjectID | PromoteObjectIDs;
+type Promote = PromoteObjectIDs | PromoteObjectID;
 
 /**
  * Effect of the rule.  For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).
@@ -1247,7 +1487,7 @@ 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.
      */
@@ -1255,825 +1495,693 @@ 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.
      */
     userData?: any | null;
 };
 
-/**
- * Response and creation timestamp.
- */
-type CreatedAtResponse = {
+type TimeRange = {
     /**
-     * Date and time when the object was created, in RFC 3339 format.
+     * When the rule should start to be active, in Unix epoch time.
      */
-    createdAt: string;
-};
-
-type DeleteApiKeyResponse = {
+    from: number;
     /**
-     * Date and time when the object was deleted, in RFC 3339 format.
+     * When the rule should stop to be active, in Unix epoch time.
      */
-    deletedAt: string;
+    until: number;
 };
 
-type DeleteByParams = {
-    facetFilters?: FacetFilters;
+/**
+ * Rule object.
+ */
+type Rule = {
     /**
-     * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+     * Unique identifier of a rule object.
      */
-    filters?: string;
-    numericFilters?: NumericFilters;
-    tagFilters?: TagFilters;
+    objectID: string;
     /**
-     * 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`.
+     * Conditions that trigger a rule.  Some consequences require specific conditions or don\'t require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
      */
-    aroundLatLng?: string;
-    aroundRadius?: AroundRadius;
+    conditions?: Array<Condition>;
+    consequence?: Consequence;
     /**
-     * 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).
+     * Description of the rule\'s purpose to help you distinguish between different rules.
      */
-    insideBoundingBox?: number[][];
+    description?: string;
     /**
-     * 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`.
+     * Whether the rule is active.
      */
-    insidePolygon?: number[][];
-};
-
-type DeleteSourceResponse = {
+    enabled?: boolean;
     /**
-     * Date and time when the object was deleted, in RFC 3339 format.
+     * Time periods when the rule is active.
      */
-    deletedAt: string;
+    validity?: Array<TimeRange>;
 };
 
-/**
- * Response, taskID, and deletion timestamp.
- */
-type DeletedAtResponse = {
+type SaveObjectResponse = {
     /**
-     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
+     * Date and time when the object was created, in RFC 3339 format.
      */
-    taskID: number;
+    createdAt: string;
     /**
-     * Date and time when the object was deleted, in RFC 3339 format.
+     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
      */
-    deletedAt: string;
-};
-
-/**
- * Dictionary type. If `null`, this dictionary type isn\'t supported for the language.
- */
-type DictionaryLanguage = {
+    taskID: number;
     /**
-     * Number of custom dictionary entries.
+     * Unique record identifier.
      */
-    nbCustomEntries?: number;
+    objectID?: string;
 };
 
-/**
- * Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and boolean values.
- */
-type StandardEntries = {
+type SaveSynonymResponse = {
     /**
-     * Key-value pair of a language ISO code and a boolean value.
+     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
      */
-    plurals?: Record<string, boolean> | null;
+    taskID: number;
     /**
-     * Key-value pair of a language ISO code and a boolean value.
+     * Date and time when the object was updated, in RFC 3339 format.
      */
-    stopwords?: Record<string, boolean> | null;
+    updatedAt: string;
     /**
-     * Key-value pair of a language ISO code and a boolean value.
+     * Unique identifier of a synonym object.
      */
-    compounds?: Record<string, boolean> | null;
+    id: string;
 };
 
 /**
- * Turn on or off the built-in Algolia stop words for a specific language.
+ * Whether a dictionary entry is active.
  */
-type DictionarySettingsParams = {
-    disableStandardEntries: StandardEntries;
-};
-
-type DictionaryType = 'compounds' | 'plurals' | 'stopwords';
+type DictionaryEntryState = 'enabled' | 'disabled';
 
 /**
- * Error.
+ * Whether a dictionary entry is provided by Algolia (standard), or has been added by you (custom).
  */
-type ErrorBase = Record<string, any> & {
-    message?: string;
-};
-
-type FacetHits = {
-    /**
-     * Facet value.
-     */
-    value: string;
-    /**
-     * Highlighted attribute value, including HTML tags.
-     */
-    highlighted: string;
-    /**
-     * Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
-     */
-    count: number;
-};
+type DictionaryEntryType = 'custom' | 'standard';
 
-type FetchedIndex = {
-    /**
-     * Index name.
-     */
-    name: string;
-    /**
-     * Index creation date. An empty string means that the index has no records.
-     */
-    createdAt: string;
-    /**
-     * Date and time when the object was updated, in RFC 3339 format.
-     */
-    updatedAt: string;
-    /**
-     * Number of records contained in the index.
-     */
-    entries: number;
+/**
+ * Dictionary entry.
+ */
+type DictionaryEntry = Record<string, any> & {
     /**
-     * Number of bytes of the index in minified format.
+     * Unique identifier for the dictionary entry.
      */
-    dataSize: number;
+    objectID: string;
+    language?: SupportedLanguage;
     /**
-     * Number of bytes of the index binary file.
+     * Matching dictionary word for `stopwords` and `compounds` dictionaries.
      */
-    fileSize: number;
+    word?: string;
     /**
-     * Last build time.
+     * Matching words in the `plurals` dictionary including declensions.
      */
-    lastBuildTimeS: number;
+    words?: Array<string>;
     /**
-     * Number of pending indexing operations. This value is deprecated and should not be used.
+     * Invividual components of a compound word in the `compounds` dictionary.
      */
-    numberOfPendingTasks: number;
+    decomposition?: Array<string>;
+    state?: DictionaryEntryState;
+    type?: DictionaryEntryType;
+};
+
+type SearchDictionaryEntriesResponse = {
     /**
-     * A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.
+     * Dictionary entries matching the search criteria.
      */
-    pendingTask: boolean;
+    hits: Array<DictionaryEntry>;
     /**
-     * Only present if the index is a replica. Contains the name of the related primary index.
+     * Requested page of the API response.
      */
-    primary?: string;
+    page: number;
     /**
-     * Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
+     * Number of results (hits).
      */
-    replicas?: string[];
+    nbHits: number;
     /**
-     * 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).
+     * Number of pages of results.
      */
-    virtual?: boolean;
-};
-
-type GetApiKeyResponse = ApiKey & BaseGetApiKeyResponse;
-
-type GetDictionarySettingsResponse = {
-    disableStandardEntries: StandardEntries;
+    nbPages: number;
 };
 
-type LogQuery = {
+type FacetHits = {
     /**
-     * Index targeted by the query.
+     * Facet value.
      */
-    index_name?: string;
+    value: string;
     /**
-     * A user identifier.
+     * Highlighted attribute value, including HTML tags.
      */
-    user_token?: string;
+    highlighted: string;
     /**
-     * Unique query identifier.
+     * Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
      */
-    query_id?: string;
+    count: number;
 };
 
-type Log = {
-    /**
-     * Date and time of the API request, in RFC 3339 format.
-     */
-    timestamp: string;
-    /**
-     * HTTP method of the request.
-     */
-    method: string;
-    /**
-     * HTTP status code of the response.
-     */
-    answer_code: string;
-    /**
-     * Request body.
-     */
-    query_body: string;
-    /**
-     * Response body.
-     */
-    answer: string;
-    /**
-     * URL of the API endpoint.
-     */
-    url: string;
-    /**
-     * IP address of the client that performed the request.
-     */
-    ip: string;
-    /**
-     * Request headers (API keys are obfuscated).
-     */
-    query_headers: string;
+type SearchForFacetValuesResponse = {
     /**
-     * SHA1 signature of the log entry.
+     * Matching facet values.
      */
-    sha1: string;
+    facetHits: Array<FacetHits>;
     /**
-     * Number of API requests.
+     * 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-).
      */
-    nb_api_calls: string;
+    exhaustiveFacetsCount: boolean;
     /**
-     * Processing time for the query in milliseconds. This doesn\'t include latency due to the network.
+     * Time the server took to process the request, in milliseconds.
      */
-    processing_time_ms: string;
+    processingTimeMS?: number;
+};
+
+/**
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+ */
+type SearchTypeFacet = 'facet';
+
+type SearchForFacetsOptions = {
     /**
-     * Index targeted by the query.
+     * Facet name.
      */
-    index?: string;
+    facet: string;
     /**
-     * Query parameters sent with the request.
+     * Index name (case-sensitive).
      */
-    query_params?: string;
+    indexName: string;
     /**
-     * Number of search results (hits) returned for the query.
+     * Text to search inside the facet\'s values.
      */
-    query_nb_hits?: string;
+    facetQuery?: string;
     /**
-     * Queries performed for the given request.
+     * 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).
      */
-    inner_queries?: LogQuery[];
+    maxFacetHits?: number;
+    type: SearchTypeFacet;
 };
 
-type GetLogsResponse = {
-    logs: Log[];
+type SearchParamsQuery = {
+    /**
+     * Search query.
+     */
+    query?: string;
 };
 
+type BaseSearchParams = SearchParamsQuery & BaseSearchParamsWithoutQuery;
+
 /**
- * Request body for retrieving records.
+ * Each parameter value, including the `query` must not be larger than 512 bytes.
  */
-type GetObjectsRequest = {
-    /**
-     * Attributes to retrieve. If not specified, all retrievable attributes are returned.
-     */
-    attributesToRetrieve?: string[];
-    /**
-     * Object ID for the record to retrieve.
-     */
-    objectID: string;
+type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
+
+/**
+ * Search parameters as query string.
+ */
+type SearchParamsString = {
     /**
-     * Index from which to retrieve the records.
+     * Search parameters as a URL-encoded query string.
      */
-    indexName: string;
+    params?: string;
 };
 
+type SearchParams = SearchParamsString | SearchParamsObject;
+
+type SearchForFacets = SearchParams & SearchForFacetsOptions;
+
 /**
- * Request parameters.
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
  */
-type GetObjectsParams = {
-    requests: GetObjectsRequest[];
-};
+type SearchTypeDefault = 'default';
 
-type GetObjectsResponse<T = Record<string, any>> = {
+type SearchForHitsOptions = {
     /**
-     * Retrieved records.
+     * Index name (case-sensitive).
      */
-    results: T[];
+    indexName: string;
+    type?: SearchTypeDefault;
+} & {
+    facet?: never;
+    maxFacetHits?: never;
+    facetQuery?: never;
 };
 
+type SearchForHits = SearchParams & SearchForHitsOptions;
+
+type SearchQuery = SearchForHits | SearchForFacets;
+
 /**
- * Task status, `published` if the task is completed, `notPublished` otherwise.
+ * 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.
  */
-type TaskStatus = 'notPublished' | 'published';
+type SearchStrategy = 'none' | 'stopIfEnoughMatches';
 
-type GetTaskResponse = {
-    status: TaskStatus;
+type SearchMethodParams = {
+    requests: Array<SearchQuery>;
+    strategy?: SearchStrategy;
 };
 
-/**
- * Unique user ID.
- */
-type UserId = {
+type SearchPagination = {
     /**
-     * Unique identifier of the user who makes the search request.
+     * Page of search results to retrieve.
      */
-    userID: string;
+    page?: number;
     /**
-     * Cluster to which the user is assigned.
+     * Number of results (hits).
      */
-    clusterName: string;
+    nbHits?: number;
     /**
-     * Number of records belonging to the user.
+     * Number of pages of results.
      */
-    nbRecords: number;
+    nbPages?: number;
     /**
-     * Data size used by the user.
+     * Number of hits per page.
      */
-    dataSize: number;
+    hitsPerPage?: number;
 };
 
-/**
- * User IDs and clusters.
- */
-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[]>>;
+type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchPagination & SearchHits<T>;
+
+type SearchResult<T = Record<string, any>> = SearchResponse<T> | SearchForFacetValuesResponse;
+
+type SearchResponses<T = Record<string, any>> = {
+    results: SearchResult<T>[];
 };
 
-type HasPendingMappingsResponse = {
+type SearchRulesResponse = {
     /**
-     * Whether there are clusters undergoing migration, creation, or deletion.
+     * Rules that matched the search criteria.
      */
-    pending: boolean;
+    hits: Array<Rule>;
     /**
-     * Cluster pending mapping state: migrating, creating, deleting.
+     * Number of rules that matched the search criteria.
+     */
+    nbHits: number;
+    /**
+     * Current page.
+     */
+    page: number;
+    /**
+     * Number of pages.
      */
-    clusters?: Record<string, string[]>;
+    nbPages: number;
 };
 
 /**
- * Index settings.
+ * Synonym type.
  */
-type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;
+type SynonymType = 'synonym' | 'onewaysynonym' | 'altcorrection1' | 'altcorrection2' | 'placeholder';
 
 /**
- * Dictionary language.
+ * Synonym object.
  */
-type Languages = {
-    plurals: DictionaryLanguage | null;
-    stopwords: DictionaryLanguage | null;
-    compounds: DictionaryLanguage | null;
-};
-
-type ListApiKeysResponse = {
+type SynonymHit = {
     /**
-     * API keys.
+     * Unique identifier of a synonym object.
      */
-    keys: GetApiKeyResponse[];
-};
-
-/**
- * Clusters.
- */
-type ListClustersResponse = {
+    objectID: string;
+    type: SynonymType;
     /**
-     * Key-value pairs with cluster names as keys and lists of users with the highest number of records per cluster as values.
+     * Words or phrases considered equivalent.
      */
-    topUsers: string[];
-};
-
-type ListIndicesResponse = {
+    synonyms?: Array<string>;
     /**
-     * All indices in your Algolia application.
+     * Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).
      */
-    items: FetchedIndex[];
+    input?: string;
     /**
-     * Number of pages.
+     * Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).
      */
-    nbPages?: number;
-};
-
-/**
- * User ID data.
- */
-type ListUserIdsResponse = {
+    word?: string;
     /**
-     * User IDs.
+     * Words to be matched in records.
      */
-    userIDs: UserId[];
-};
-
-type LogType = 'all' | 'build' | 'error' | 'query';
-
-type MultipleBatchResponse = {
+    corrections?: Array<string>;
     /**
-     * Task IDs. One for each index.
+     * [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
      */
-    taskID: Record<string, number>;
+    placeholder?: string;
     /**
-     * Unique record identifiers.
+     * Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).
      */
-    objectIDs: string[];
+    replacements?: Array<string>;
 };
 
-/**
- * Operation to perform on the index.
- */
-type OperationType = 'copy' | 'move';
-
-type ScopeType = 'rules' | 'settings' | 'synonyms';
-
-type OperationIndexParams = {
-    operation: OperationType;
-    /**
-     * Index name (case-sensitive).
-     */
-    destination: string;
+type SearchSynonymsResponse = Record<string, any> & {
     /**
-     * **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.
+     * Matching synonyms.
      */
-    scope?: ScopeType[];
-};
-
-type RemoveUserIdResponse = {
+    hits: Array<SynonymHit>;
     /**
-     * Date and time when the object was deleted, in RFC 3339 format.
+     * Number of results (hits).
      */
-    deletedAt: string;
+    nbHits: number;
 };
 
 /**
- * Response, taskID, and update timestamp.
+ * OK
  */
-type UpdatedAtResponse = {
+type SearchUserIdsParams = {
     /**
-     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
+     * Query to search. The search is a prefix search with [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) enabled. An empty query will retrieve all users.
      */
-    taskID: number;
+    query: string;
     /**
-     * Date and time when the object was updated, in RFC 3339 format.
+     * Cluster name.
      */
-    updatedAt: string;
-};
-
-type ReplaceAllObjectsResponse = {
-    copyOperationResponse: UpdatedAtResponse;
+    clusterName?: string;
     /**
-     * The response of the `batch` request(s).
+     * Page of search results to retrieve.
      */
-    batchResponses: BatchResponse[];
-    moveOperationResponse: UpdatedAtResponse;
-};
-
-type ReplaceSourceResponse = {
+    page?: number;
     /**
-     * Date and time when the object was updated, in RFC 3339 format.
+     * Number of hits per page.
      */
-    updatedAt: string;
+    hitsPerPage?: number;
 };
 
-type TimeRange = {
-    /**
-     * When the rule should start to be active, in Unix epoch time.
-     */
-    from: number;
-    /**
-     * When the rule should stop to be active, in Unix epoch time.
-     */
-    until: number;
+type UserHighlightResult = {
+    userID: HighlightResult;
+    clusterName: HighlightResult;
 };
 
-/**
- * Rule object.
- */
-type Rule = {
+type UserHit = {
     /**
-     * Unique identifier of a rule object.
+     * Unique identifier of the user who makes the search request.
      */
-    objectID: string;
+    userID: string;
     /**
-     * Conditions that trigger a rule.  Some consequences require specific conditions or don\'t require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
+     * Cluster name.
      */
-    conditions?: Condition[];
-    consequence?: Consequence;
+    clusterName: string;
     /**
-     * Description of the rule\'s purpose to help you distinguish between different rules.
+     * Number of records in the cluster.
      */
-    description?: string;
+    nbRecords: number;
     /**
-     * Whether the rule is active.
+     * Data size taken by all the users assigned to the cluster.
      */
-    enabled?: boolean;
+    dataSize: number;
     /**
-     * Time periods when the rule is active.
+     * userID of the requested user. Same as userID.
      */
-    validity?: TimeRange[];
+    objectID: string;
+    _highlightResult: UserHighlightResult;
 };
 
-type SaveObjectResponse = {
+/**
+ * userIDs data.
+ */
+type SearchUserIdsResponse = {
     /**
-     * Date and time when the object was created, in RFC 3339 format.
+     * User objects that match the query.
      */
-    createdAt: string;
+    hits: Array<UserHit>;
     /**
-     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
+     * Number of results (hits).
      */
-    taskID: number;
+    nbHits: number;
     /**
-     * Unique record identifier.
+     * Page of search results to retrieve.
      */
-    objectID?: string;
-};
-
-type SaveSynonymResponse = {
+    page: number;
     /**
-     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
+     * Maximum number of hits per page.
      */
-    taskID: number;
+    hitsPerPage: number;
     /**
      * Date and time when the object was updated, in RFC 3339 format.
      */
     updatedAt: string;
-    /**
-     * Unique identifier of a synonym object.
-     */
-    id: string;
 };
 
-/**
- * Search parameter.
- */
-type SearchDictionaryEntriesParams = {
+type BaseIndexSettings = {
     /**
-     * Search query.
+     * 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))`.
      */
-    query: string;
+    attributesForFaceting?: Array<string>;
     /**
-     * Page of search results to retrieve.
+     * 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/).
      */
-    page?: number;
+    replicas?: Array<string>;
     /**
-     * Number of hits per page.
+     * 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.
      */
-    hitsPerPage?: number;
-    language?: SupportedLanguage;
-};
-
-type SearchDictionaryEntriesResponse = {
+    paginationLimitedTo?: number;
     /**
-     * Dictionary entries matching the search criteria.
+     * 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.
      */
-    hits: DictionaryEntry[];
+    unretrievableAttributes?: Array<string>;
     /**
-     * Requested page of the API response.
+     * 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.
      */
-    page: number;
+    disableTypoToleranceOnWords?: Array<string>;
     /**
-     * Number of results (hits).
+     * 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.
      */
-    nbHits: number;
+    attributesToTransliterate?: Array<string>;
     /**
-     * Number of pages of results.
+     * Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive.
      */
-    nbPages: number;
-};
-
-type SearchForFacetValuesRequest = {
+    camelCaseAttributes?: Array<string>;
     /**
-     * Search parameters as a URL-encoded query 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).
      */
-    params?: string;
+    decompoundedAttributes?: Record<string, unknown>;
     /**
-     * Text to search inside the facet\'s values.
+     * 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/).
      */
-    facetQuery?: string;
+    indexLanguages?: Array<SupportedLanguage>;
     /**
-     * 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).
+     * 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.
      */
-    maxFacetHits?: number;
-};
-
-type SearchForFacetValuesResponse = {
+    disablePrefixOnAttributes?: Array<string>;
     /**
-     * Matching facet values.
+     * Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.
      */
-    facetHits: FacetHits[];
+    allowCompressionOfIntegerArray?: boolean;
     /**
-     * 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-).
+     * 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 `!=`.
      */
-    exhaustiveFacetsCount: boolean;
+    numericAttributesForFiltering?: Array<string>;
     /**
-     * Time the server took to process the request, in milliseconds.
+     * 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.
      */
-    processingTimeMS?: number;
-};
-
-/**
- * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
- */
-type SearchTypeFacet = 'facet';
-
-type SearchForFacetsOptions = {
+    separatorsToIndex?: string;
     /**
-     * Facet name.
+     * 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.
      */
-    facet: string;
+    searchableAttributes?: Array<string>;
     /**
-     * Index name (case-sensitive).
+     * An object with custom data.  You can store up to 32kB as custom data.
      */
-    indexName: string;
+    userData?: Record<string, unknown>;
     /**
-     * Text to search inside the facet\'s values.
+     * 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/).
      */
-    facetQuery?: string;
+    customNormalization?: {
+        [key: string]: {
+            [key: string]: 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).
+     * 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.
      */
-    maxFacetHits?: number;
-    type: SearchTypeFacet;
+    attributeForDistinct?: string;
 };
 
-type SearchParams = SearchParamsObject | SearchParamsString;
-
-type SearchForFacets = SearchForFacetsOptions & SearchParams;
-
 /**
- * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+ * Index settings.
  */
-type SearchTypeDefault = 'default';
+type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;
 
-type SearchForHitsOptions = {
+type WithPrimary = {
     /**
-     * Index name (case-sensitive).
+     * Replica indices only: the name of the primary index for this replica.
      */
-    indexName: string;
-    type?: SearchTypeDefault;
-} & {
-    facet?: never;
-    maxFacetHits?: never;
-    facetQuery?: never;
+    primary?: string;
 };
 
-type SearchForHits = SearchForHitsOptions & SearchParams;
-
-type SearchQuery = SearchForFacets | SearchForHits;
+type SettingsResponse = IndexSettings & WithPrimary;
 
 /**
- * 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.
+ * Source.
  */
-type SearchStrategy = 'none' | 'stopIfEnoughMatches';
-
-type SearchMethodParams = {
-    requests: SearchQuery[];
-    strategy?: SearchStrategy;
-};
-
-type SearchPagination = {
+type Source = {
     /**
-     * Page of search results to retrieve.
+     * IP address range of the source.
      */
-    page?: number;
+    source: string;
     /**
-     * Number of results (hits).
+     * Source description.
      */
-    nbHits?: number;
+    description?: string;
+};
+
+type UpdateApiKeyResponse = {
     /**
-     * Number of pages of results.
+     * API key.
      */
-    nbPages?: number;
+    key: string;
     /**
-     * Number of hits per page.
+     * Date and time when the object was updated, in RFC 3339 format.
      */
-    hitsPerPage?: number;
-};
-
-type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T> & SearchPagination;
-
-type SearchResult<T = Record<string, any>> = SearchForFacetValuesResponse | SearchResponse<T>;
-
-type SearchResponses<T = Record<string, any>> = {
-    results: Array<SearchResult<T>>;
+    updatedAt: string;
 };
 
 /**
- * Rules search parameters.
+ * Response, taskID, unique object identifier, and an update timestamp.
  */
-type SearchRulesParams = {
-    /**
-     * Search query for rules.
-     */
-    query?: string;
-    anchoring?: Anchoring;
-    /**
-     * Only return rules that match the context (exact match).
-     */
-    context?: string;
+type UpdatedAtWithObjectIdResponse = {
     /**
-     * Requested page of the API response.
+     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
      */
-    page?: number;
+    taskID?: number;
     /**
-     * Maximum number of hits per page.
+     * Date and time when the object was updated, in RFC 3339 format.
      */
-    hitsPerPage?: number;
+    updatedAt?: string;
     /**
-     * If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.
+     * Unique record identifier.
      */
-    enabled?: boolean | null;
+    objectID?: string;
 };
 
-type SearchRulesResponse = {
-    /**
-     * Rules that matched the search criteria.
-     */
-    hits: Rule[];
+type UpdatedRuleResponse = {
     /**
-     * Number of rules that matched the search criteria.
+     * Unique identifier of a rule object.
      */
-    nbHits: number;
+    objectID: string;
     /**
-     * Current page.
+     * Date and time when the object was updated, in RFC 3339 format.
      */
-    page: number;
+    updatedAt: string;
     /**
-     * Number of pages.
+     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
      */
-    nbPages: number;
+    taskID: number;
 };
 
+type ApiKeyOperation = 'add' | 'delete' | 'update';
+
 /**
- * Synonym type.
+ * Assign userID parameters.
  */
-type SynonymType = 'altcorrection1' | 'altcorrection2' | 'onewaysynonym' | 'placeholder' | 'synonym';
-
-type SearchSynonymsParams = {
+type AssignUserIdParams = {
     /**
-     * Search query.
+     * Cluster name.
      */
-    query?: string;
-    type?: SynonymType;
+    cluster: string;
+};
+
+/**
+ * Assign userID parameters.
+ */
+type BatchAssignUserIdsParams = {
     /**
-     * Page of search results to retrieve.
+     * Cluster name.
      */
-    page?: number;
+    cluster: string;
     /**
-     * Number of hits per page.
+     * User IDs to assign.
      */
-    hitsPerPage?: number;
+    users: Array<string>;
 };
 
 /**
- * Synonym object.
+ * Actions to perform.
  */
-type SynonymHit = {
+type DictionaryAction = 'addEntry' | 'deleteEntry';
+
+type BatchDictionaryEntriesRequest = {
+    action: DictionaryAction;
+    body: DictionaryEntry;
+};
+
+/**
+ * Request body for updating dictionary entries.
+ */
+type BatchDictionaryEntriesParams = {
     /**
-     * Unique identifier of a synonym object.
+     * Whether to replace all custom entries in the dictionary with the ones sent with this request.
      */
-    objectID: string;
-    type: SynonymType;
+    clearExistingDictionaryEntries?: boolean;
     /**
-     * Words or phrases considered equivalent.
+     * List of additions and deletions to your dictionaries.
      */
-    synonyms?: string[];
+    requests: Array<BatchDictionaryEntriesRequest>;
+};
+
+type BatchRequest = {
+    action: Action;
     /**
-     * Word or phrase to appear in query strings (for [`onewaysynonym`s](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).
+     * Operation arguments (varies with specified `action`).
      */
-    input?: string;
+    body: Record<string, unknown>;
+};
+
+/**
+ * Batch parameters.
+ */
+type BatchWriteParams = {
+    requests: Array<BatchRequest>;
+};
+
+type BrowseParamsObject = SearchParamsObject & Cursor;
+
+type BrowseParams = SearchParamsString | BrowseParamsObject;
+
+type DeleteByParams = {
+    facetFilters?: FacetFilters;
     /**
-     * Word or phrase to appear in query strings (for [`altcorrection1` and `altcorrection2`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).
+     * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
      */
-    word?: string;
+    filters?: string;
+    numericFilters?: NumericFilters;
+    tagFilters?: TagFilters;
     /**
-     * Words to be matched in records.
+     * 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`.
      */
-    corrections?: string[];
+    aroundLatLng?: string;
+    aroundRadius?: AroundRadius;
     /**
-     * [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
+     * 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).
      */
-    placeholder?: string;
+    insideBoundingBox?: Array<Array<number>>;
     /**
-     * Query words that will match the [placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).
+     * 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`.
      */
-    replacements?: string[];
+    insidePolygon?: Array<Array<number>>;
 };
 
-type SearchSynonymsResponse = Record<string, any> & {
+type DictionaryType = 'plurals' | 'stopwords' | 'compounds';
+
+type LogType = 'all' | 'query' | 'build' | 'error';
+
+/**
+ * Operation to perform on the index.
+ */
+type OperationType = 'move' | 'copy';
+
+type ScopeType = 'settings' | 'synonyms' | 'rules';
+
+type OperationIndexParams = {
+    operation: OperationType;
     /**
-     * Matching synonyms.
+     * Index name (case-sensitive).
      */
-    hits: SynonymHit[];
+    destination: string;
     /**
-     * Number of results (hits).
+     * **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.
      */
-    nbHits: number;
+    scope?: Array<ScopeType>;
 };
 
 /**
- * OK.
+ * Search parameter.
  */
-type SearchUserIdsParams = {
+type SearchDictionaryEntriesParams = {
     /**
-     * Query to search. The search is a prefix search with [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) enabled. An empty query will retrieve all users.
+     * Search query.
      */
     query: string;
-    /**
-     * Cluster name.
-     */
-    clusterName?: string;
     /**
      * Page of search results to retrieve.
      */
@@ -2082,61 +2190,65 @@ type SearchUserIdsParams = {
      * Number of hits per page.
      */
     hitsPerPage?: number;
+    language?: SupportedLanguage;
 };
 
-type UserHighlightResult = {
-    userID: HighlightResult;
-    clusterName: HighlightResult;
-};
-
-type UserHit = {
-    /**
-     * Unique identifier of the user who makes the search request.
-     */
-    userID: string;
-    /**
-     * Cluster name.
-     */
-    clusterName: string;
+type SearchForFacetValuesRequest = {
     /**
-     * Number of records in the cluster.
+     * Search parameters as a URL-encoded query string.
      */
-    nbRecords: number;
+    params?: string;
     /**
-     * Data size taken by all the users assigned to the cluster.
+     * Text to search inside the facet\'s values.
      */
-    dataSize: number;
+    facetQuery?: string;
     /**
-     * UserID of the requested user. Same as userID.
+     * 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).
      */
-    objectID: string;
-    _highlightResult: UserHighlightResult;
+    maxFacetHits?: number;
 };
 
 /**
- * UserIDs data.
+ * Rules search parameters.
  */
-type SearchUserIdsResponse = {
+type SearchRulesParams = {
     /**
-     * User objects that match the query.
+     * Search query for rules.
      */
-    hits: UserHit[];
+    query?: string;
+    anchoring?: Anchoring;
     /**
-     * Number of results (hits).
+     * Only return rules that match the context (exact match).
      */
-    nbHits: number;
+    context?: string;
     /**
-     * Page of search results to retrieve.
+     * Requested page of the API response.
      */
-    page: number;
+    page?: number;
     /**
      * Maximum number of hits per page.
      */
-    hitsPerPage: number;
+    hitsPerPage?: number;
     /**
-     * Date and time when the object was updated, in RFC 3339 format.
+     * If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.
      */
-    updatedAt: string;
+    enabled?: boolean | null;
+};
+
+type SearchSynonymsParams = {
+    /**
+     * Search query.
+     */
+    query?: string;
+    type?: SynonymType;
+    /**
+     * Page of search results to retrieve.
+     */
+    page?: number;
+    /**
+     * Number of hits per page.
+     */
+    hitsPerPage?: number;
 };
 
 type SecuredApiKeyRestrictions = {
@@ -2152,7 +2264,7 @@ type SecuredApiKeyRestrictions = {
     /**
      * 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_\".
      */
-    restrictIndices?: string[];
+    restrictIndices?: Array<string>;
     /**
      * IP network that are allowed to use this key.  You can only add a single source, but you can provide a range of IP addresses. Use this to protect against API key leaking and reuse.
      */
@@ -2163,73 +2275,6 @@ type SecuredApiKeyRestrictions = {
     userToken?: string;
 };
 
-type WithPrimary = {
-    /**
-     * Replica indices only: the name of the primary index for this replica.
-     */
-    primary?: string;
-};
-
-type SettingsResponse = IndexSettings & WithPrimary;
-
-/**
- * Source.
- */
-type Source = {
-    /**
-     * IP address range of the source.
-     */
-    source: string;
-    /**
-     * Source description.
-     */
-    description?: string;
-};
-
-type UpdateApiKeyResponse = {
-    /**
-     * API key.
-     */
-    key: string;
-    /**
-     * Date and time when the object was updated, in RFC 3339 format.
-     */
-    updatedAt: string;
-};
-
-/**
- * Response, taskID, unique object identifier, and an update timestamp.
- */
-type UpdatedAtWithObjectIdResponse = {
-    /**
-     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
-     */
-    taskID?: number;
-    /**
-     * Date and time when the object was updated, in RFC 3339 format.
-     */
-    updatedAt?: string;
-    /**
-     * Unique record identifier.
-     */
-    objectID?: string;
-};
-
-type UpdatedRuleResponse = {
-    /**
-     * Unique identifier of a rule object.
-     */
-    objectID: string;
-    /**
-     * Date and time when the object was updated, in RFC 3339 format.
-     */
-    updatedAt: string;
-    /**
-     * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
-     */
-    taskID: number;
-};
-
 /**
  * Properties for the `addOrUpdateObject` method.
  */
@@ -2243,7 +2288,7 @@ 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>;
 };
@@ -2343,7 +2388,9 @@ type CustomDeleteProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customGet` method.
@@ -2356,7 +2403,9 @@ type CustomGetProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customPost` method.
@@ -2369,7 +2418,9 @@ 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.
      */
@@ -2386,7 +2437,9 @@ 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.
      */
@@ -2530,7 +2583,7 @@ 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>;
 };
 /**
  * Properties for the `getRule` method.
@@ -2671,7 +2724,7 @@ type ReplaceSourcesProps = {
     /**
      * Allowed sources.
      */
-    source: Source[];
+    source: Array<Source>;
 };
 /**
  * Properties for the `restoreApiKey` method.
@@ -2691,7 +2744,7 @@ 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>;
 };
@@ -2721,7 +2774,7 @@ 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.
      */
@@ -2757,7 +2810,7 @@ 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.
      */
@@ -2980,7 +3033,7 @@ type ReplaceAllObjectsOptions = {
     batchSize?: number;
 };
 
-declare const apiClientVersion = "5.7.0";
+declare const apiClientVersion = "5.8.1";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3095,7 +3148,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
      */
-    chunkedBatch({ indexName, objects, action, waitForTasks, batchSize }: ChunkedBatchOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
+    chunkedBatch({ indexName, objects, action, waitForTasks, batchSize }: ChunkedBatchOptions, requestOptions?: RequestOptions): Promise<Array<BatchResponse>>;
     /**
      * Helper: Saves the given array of objects in the given index. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
      *
@@ -3160,14 +3213,13 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchForFacets(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<{
-        results: SearchForFacetValuesResponse[];
+        results: Array<SearchForFacetValuesResponse>;
     }>;
     /**
      * Creates a new API key with specific permissions and restrictions.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param apiKey - The apiKey object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -3176,12 +3228,11 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index.  To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
      *
      * Required API Key ACLs:
-     * - addObject.
-     *
+     *  - addObject
      * @param addOrUpdateObject - The addOrUpdateObject object.
      * @param addOrUpdateObject.indexName - Name of the index on which to perform the operation.
      * @param addOrUpdateObject.objectID - Unique record identifier.
-     * @param addOrUpdateObject.body - The record, a schemaless object with attributes that are useful in the context of search and discovery.
+     * @param addOrUpdateObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     addOrUpdateObject({ indexName, objectID, body }: AddOrUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
@@ -3189,8 +3240,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Adds a source to the list of allowed sources.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param source - Source to add.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -3199,8 +3249,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Assigns or moves a user ID to a cluster.  The time it takes to move a user is proportional to the amount of data linked to the user ID.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param assignUserId - The assignUserId object.
      * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
@@ -3209,7 +3258,6 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
     assignUserId({ xAlgoliaUserID, assignUserIdParams }: AssignUserIdProps, requestOptions?: RequestOptions): Promise<CreatedAtResponse>;
     /**
      * Adds, updates, or deletes records in one index with a single API request.  Batching index updates reduces latency and increases data integrity.  - Actions are applied in the order they\'re specified. - Actions are equivalent to the individual API requests of the same name.
-     *
      * @param batch - The batch object.
      * @param batch.indexName - Name of the index on which to perform the operation.
      * @param batch.batchWriteParams - The batchWriteParams object.
@@ -3220,8 +3268,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Assigns multiple user IDs to a cluster.  **You can\'t move users with this operation**.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param batchAssignUserIds - The batchAssignUserIds object.
      * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
@@ -3232,8 +3279,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param batchDictionaryEntries - The batchDictionaryEntries object.
      * @param batchDictionaryEntries.dictionaryName - Dictionary type in which to search.
      * @param batchDictionaryEntries.batchDictionaryEntriesParams - The batchDictionaryEntriesParams object.
@@ -3241,11 +3287,10 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      */
     batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams }: BatchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Retrieves records from an index, up to 1,000 per request.  While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices.  - The Analytics API doesn\'t collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There\'s no ranking for: typo-tolerance, number of matched words, proximity, geo distance.  Browse requests automatically apply these settings:  - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`)  If you send these parameters with your browse requests, they\'ll be ignored.
+     * Retrieves records from an index, up to 1,000 per request.  While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices.  - The Analytics API doesn\'t collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There\'s no ranking for: typo-tolerance, number of matched words, proximity, geo distance.  Browse requests automatically apply these settings:  - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`)  If you send these parameters with your browse requests, they\'ll be ignored.
      *
      * Required API Key ACLs:
-     * - browse.
-     *
+     *  - browse
      * @param browse - The browse object.
      * @param browse.indexName - Name of the index on which to perform the operation.
      * @param browse.browseParams - The browseParams object.
@@ -3256,8 +3301,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Deletes only the records from an index while keeping settings, synonyms, and rules.
      *
      * Required API Key ACLs:
-     * - deleteIndex.
-     *
+     *  - deleteIndex
      * @param clearObjects - The clearObjects object.
      * @param clearObjects.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3267,8 +3311,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Deletes all rules from the index.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param clearRules - The clearRules object.
      * @param clearRules.indexName - Name of the index on which to perform the operation.
      * @param clearRules.forwardToReplicas - Whether changes are applied to replica indices.
@@ -3279,8 +3322,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Deletes all synonyms from the index.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param clearSynonyms - The clearSynonyms object.
      * @param clearSynonyms.indexName - Name of the index on which to perform the operation.
      * @param clearSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
@@ -3289,7 +3331,6 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
     clearSynonyms({ indexName, forwardToReplicas }: ClearSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -3298,7 +3339,6 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -3307,7 +3347,6 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -3317,7 +3356,6 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -3329,8 +3367,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Deletes the API key.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param deleteApiKey - The deleteApiKey object.
      * @param deleteApiKey.key - API key.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3340,8 +3377,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * This operation doesn\'t accept empty queries or filters.  It\'s more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](#tag/Records/operation/batch).
      *
      * Required API Key ACLs:
-     * - deleteIndex.
-     *
+     *  - deleteIndex
      * @param deleteBy - The deleteBy object.
      * @param deleteBy.indexName - Name of the index on which to perform the operation.
      * @param deleteBy.deleteByParams - The deleteByParams object.
@@ -3352,8 +3388,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Deletes an index and all its settings.  - Deleting an index doesn\'t delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it.   For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).
      *
      * Required API Key ACLs:
-     * - deleteIndex.
-     *
+     *  - deleteIndex
      * @param deleteIndex - The deleteIndex object.
      * @param deleteIndex.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3363,8 +3398,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Deletes a record by its object ID.  To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).
      *
      * Required API Key ACLs:
-     * - deleteObject.
-     *
+     *  - deleteObject
      * @param deleteObject - The deleteObject object.
      * @param deleteObject.indexName - Name of the index on which to perform the operation.
      * @param deleteObject.objectID - Unique record identifier.
@@ -3375,8 +3409,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](#tag/Rules/operation/searchRules).
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param deleteRule - The deleteRule object.
      * @param deleteRule.indexName - Name of the index on which to perform the operation.
      * @param deleteRule.objectID - Unique identifier of a rule object.
@@ -3388,8 +3421,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Deletes a source from the list of allowed sources.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param deleteSource - The deleteSource object.
      * @param deleteSource.source - IP address range of the source.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3399,8 +3431,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param deleteSynonym - The deleteSynonym object.
      * @param deleteSynonym.indexName - Name of the index on which to perform the operation.
      * @param deleteSynonym.objectID - Unique identifier of a synonym object.
@@ -3410,7 +3441,6 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
     deleteSynonym({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
     /**
      * Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
-     *
      * @param getApiKey - The getApiKey object.
      * @param getApiKey.key - API key.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3420,8 +3450,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Checks the status of a given application task.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param getAppTask - The getAppTask object.
      * @param getAppTask.taskID - Unique task identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3431,17 +3460,17 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Lists supported languages with their supported dictionary types and number of custom entries.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getDictionaryLanguages(requestOptions?: RequestOptions): Promise<Record<string, Languages>>;
+    getDictionaryLanguages(requestOptions?: RequestOptions): Promise<{
+        [key: string]: Languages;
+    }>;
     /**
      * Retrieves the languages for which standard dictionary entries are turned off.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getDictionarySettings(requestOptions?: RequestOptions): Promise<GetDictionarySettingsResponse>;
@@ -3449,8 +3478,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).  - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn\'t appear in the logs itself.
      *
      * Required API Key ACLs:
-     * - logs.
-     *
+     *  - logs
      * @param getLogs - The getLogs object.
      * @param getLogs.offset - First log entry to retrieve. The most recent entries are listed first.
      * @param getLogs.length - Maximum number of entries to retrieve.
@@ -3463,8 +3491,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Retrieves one record by its object ID.  To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param getObject - The getObject object.
      * @param getObject.indexName - Name of the index on which to perform the operation.
      * @param getObject.objectID - Unique record identifier.
@@ -3476,8 +3503,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Retrieves one or more records, potentially from different indices.  Records are returned in the same order as the requests.
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param getObjectsParams - Request object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -3486,8 +3512,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param getRule - The getRule object.
      * @param getRule.indexName - Name of the index on which to perform the operation.
      * @param getRule.objectID - Unique identifier of a rule object.
@@ -3498,8 +3523,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Retrieves an object with non-null index settings.
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param getSettings - The getSettings object.
      * @param getSettings.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3509,17 +3533,15 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Retrieves all allowed IP addresses with access to your application.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getSources(requestOptions?: RequestOptions): Promise<Source[]>;
+    getSources(requestOptions?: RequestOptions): Promise<Array<Source>>;
     /**
-     * Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
+     * Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param getSynonym - The getSynonym object.
      * @param getSynonym.indexName - Name of the index on which to perform the operation.
      * @param getSynonym.objectID - Unique identifier of a synonym object.
@@ -3530,8 +3552,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Checks the status of a given task.  Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server.  The indexing tasks\' responses include a task ID that you can use to check the status.
      *
      * Required API Key ACLs:
-     * - addObject.
-     *
+     *  - addObject
      * @param getTask - The getTask object.
      * @param getTask.indexName - Name of the index on which to perform the operation.
      * @param getTask.taskID - Unique task identifier.
@@ -3542,8 +3563,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Get the IDs of the 10 users with the highest number of records per cluster.  Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getTopUserIds(requestOptions?: RequestOptions): Promise<GetTopUserIdsResponse>;
@@ -3551,8 +3571,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Returns the user ID data stored in the mapping.  Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param getUserId - The getUserId object.
      * @param getUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3562,8 +3581,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param hasPendingMappings - The hasPendingMappings object.
      * @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3573,8 +3591,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Lists all API keys associated with your Algolia application, including their permissions and restrictions.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listApiKeys(requestOptions?: RequestOptions): Promise<ListApiKeysResponse>;
@@ -3582,8 +3599,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Lists the available clusters in a multi-cluster setup.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listClusters(requestOptions?: RequestOptions): Promise<ListClustersResponse>;
@@ -3591,8 +3607,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Lists all indices in the current Algolia application.  The request follows any index restrictions of the API key you use to make the request.
      *
      * Required API Key ACLs:
-     * - listIndexes.
-     *
+     *  - listIndexes
      * @param listIndices - The listIndices object.
      * @param listIndices.page - Requested page of the API response. If `null`, the API response is not paginated.
      * @param listIndices.hitsPerPage - Number of hits per page.
@@ -3603,8 +3618,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Lists the userIDs assigned to a multi-cluster application.  Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param listUserIds - The listUserIds object.
      * @param listUserIds.page - Requested page of the API response. If `null`, the API response is not paginated.
      * @param listUserIds.hitsPerPage - Number of hits per page.
@@ -3613,17 +3627,15 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
     listUserIds({ page, hitsPerPage }?: ListUserIdsProps, requestOptions?: RequestOptions | undefined): Promise<ListUserIdsResponse>;
     /**
      * Adds, updates, or deletes records in multiple indices with a single API request.  - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name.
-     *
      * @param batchParams - The batchParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     multipleBatch(batchParams: BatchParams, requestOptions?: RequestOptions): Promise<MultipleBatchResponse>;
     /**
-     * Copies or moves (renames) an index within the same Algolia application.  - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn\'t exist yet, it\'ll be created.  **Copy**  - Copying a source index that doesn\'t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can\'t copy the `enableReRanking`, `mode`, and `replicas` settings. - You can\'t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/)  **Move**  - Moving a source index that doesn\'t exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name.   To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
+     * Copies or moves (renames) an index within the same Algolia application.  - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn\'t exist yet, it\'ll be created.  **Copy**  - Copying a source index that doesn\'t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can\'t copy the `enableReRanking`, `mode`, and `replicas` settings. - You can\'t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/)  **Move**  - Moving a source index that doesn\'t exist is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name.   To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
      *
      * Required API Key ACLs:
-     * - addObject.
-     *
+     *  - addObject
      * @param operationIndex - The operationIndex object.
      * @param operationIndex.indexName - Name of the index on which to perform the operation.
      * @param operationIndex.operationIndexParams - The operationIndexParams object.
@@ -3631,11 +3643,10 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      */
     operationIndex({ indexName, operationIndexParams }: OperationIndexProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Adds new attributes to a record, or update existing ones.  - If a record with the specified object ID doesn\'t exist,   a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn\'t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes.   If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.  To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don\'t have access to your initial data.  - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it\'s not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn\'t exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn\'t exist yet, the engine only creates it if you pass an IncrementSet value that\'s greater than 0.  You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties:  - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
+     * Adds new attributes to a record, or updates existing ones.  - If a record with the specified object ID doesn\'t exist,   a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn\'t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes.   If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.  To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don\'t have access to your initial data.  - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it\'s not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn\'t exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn\'t exist yet, the engine only creates it if you pass an IncrementSet value greater than 0.  You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties:  - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
      *
      * Required API Key ACLs:
-     * - addObject.
-     *
+     *  - addObject
      * @param partialUpdateObject - The partialUpdateObject object.
      * @param partialUpdateObject.indexName - Name of the index on which to perform the operation.
      * @param partialUpdateObject.objectID - Unique record identifier.
@@ -3648,8 +3659,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Deletes a user ID and its associated data from the clusters.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param removeUserId - The removeUserId object.
      * @param removeUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3659,8 +3669,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Replaces the list of allowed sources.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param replaceSources - The replaceSources object.
      * @param replaceSources.source - Allowed sources.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3670,8 +3679,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Restores a deleted API key.  Restoring resets the `validity` attribute to `0`.  Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can\'t be restored.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param restoreApiKey - The restoreApiKey object.
      * @param restoreApiKey.key - API key.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3681,11 +3689,10 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Adds a record to an index or replace it.  - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created.  To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
      *
      * Required API Key ACLs:
-     * - addObject.
-     *
+     *  - addObject
      * @param saveObject - The saveObject object.
      * @param saveObject.indexName - Name of the index on which to perform the operation.
-     * @param saveObject.body - The record, a schemaless object with attributes that are useful in the context of search and discovery.
+     * @param saveObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveObject({ indexName, body }: SaveObjectProps, requestOptions?: RequestOptions): Promise<SaveObjectResponse>;
@@ -3693,8 +3700,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * If a rule with the specified object ID doesn\'t exist, it\'s created. Otherwise, the existing rule is replaced.  To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param saveRule - The saveRule object.
      * @param saveRule.indexName - Name of the index on which to perform the operation.
      * @param saveRule.objectID - Unique identifier of a rule object.
@@ -3707,8 +3713,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Create or update multiple rules.  If a rule with the specified object ID doesn\'t exist, Algolia creates a new one. Otherwise, existing rules are replaced.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param saveRules - The saveRules object.
      * @param saveRules.indexName - Name of the index on which to perform the operation.
      * @param saveRules.rules - The rules object.
@@ -3721,8 +3726,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * If a synonym with the specified object ID doesn\'t exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param saveSynonym - The saveSynonym object.
      * @param saveSynonym.indexName - Name of the index on which to perform the operation.
      * @param saveSynonym.objectID - Unique identifier of a synonym object.
@@ -3735,8 +3739,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * If a synonym with the `objectID` doesn\'t exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param saveSynonyms - The saveSynonyms object.
      * @param saveSynonyms.indexName - Name of the index on which to perform the operation.
      * @param saveSynonyms.synonymHit - The synonymHit object.
@@ -3746,21 +3749,19 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      */
     saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: SaveSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Sends multiple search request to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
+     * Sends multiple search requests to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    search<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;
+    search<T>(searchMethodParams: SearchMethodParams | LegacySearchMethodProps, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;
     /**
      * Searches for standard and custom dictionary entries.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param searchDictionaryEntries - The searchDictionaryEntries object.
      * @param searchDictionaryEntries.dictionaryName - Dictionary type in which to search.
      * @param searchDictionaryEntries.searchDictionaryEntriesParams - The searchDictionaryEntriesParams object.
@@ -3771,8 +3772,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Searches for values of a specified facet attribute.  - By default, facet values are sorted by decreasing count.   You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn\'t work if you have **more than 65 searchable facets and searchable attributes combined**.
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param searchForFacetValues - The searchForFacetValues object.
      * @param searchForFacetValues.indexName - Name of the index on which to perform the operation.
      * @param searchForFacetValues.facetName - Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
@@ -3784,8 +3784,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Searches for rules in your index.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param searchRules - The searchRules object.
      * @param searchRules.indexName - Name of the index on which to perform the operation.
      * @param searchRules.searchRulesParams - The searchRulesParams object.
@@ -3793,11 +3792,10 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      */
     searchRules({ indexName, searchRulesParams }: SearchRulesProps, requestOptions?: RequestOptions): Promise<SearchRulesResponse>;
     /**
-     * Searches a single index and return matching search results (_hits_).  This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.
+     * Searches a single index and returns matching search results (_hits_).  This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.
      *
      * Required API Key ACLs:
-     * - search.
-     *
+     *  - search
      * @param searchSingleIndex - The searchSingleIndex object.
      * @param searchSingleIndex.indexName - Name of the index on which to perform the operation.
      * @param searchSingleIndex.searchParams - The searchParams object.
@@ -3808,8 +3806,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Searches for synonyms in your index.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param searchSynonyms - The searchSynonyms object.
      * @param searchSynonyms.indexName - Name of the index on which to perform the operation.
      * @param searchSynonyms.searchSynonymsParams - Body of the `searchSynonyms` operation.
@@ -3820,8 +3817,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.  To ensure rapid updates, the user IDs index isn\'t built at the same time as the mapping. Instead, it\'s built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param searchUserIdsParams - The searchUserIdsParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -3830,8 +3826,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Turns standard stop word dictionary entries on or off for a given language.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param dictionarySettingsParams - The dictionarySettingsParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -3840,8 +3835,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Update the specified index settings.  Index settings that you don\'t specify are left unchanged. Specify `null` to reset a setting to its default value.  For best performance, update the index settings before you add new records to your index.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param setSettings - The setSettings object.
      * @param setSettings.indexName - Name of the index on which to perform the operation.
      * @param setSettings.indexSettings - The indexSettings object.
@@ -3853,8 +3847,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Replaces the permissions of an existing API key.  Any unspecified attribute resets that attribute to its default value.
      *
      * Required API Key ACLs:
-     * - admin.
-     *
+     *  - admin
      * @param updateApiKey - The updateApiKey object.
      * @param updateApiKey.key - API key.
      * @param updateApiKey.apiKey - The apiKey object.
@@ -3863,8 +3856,32 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
     updateApiKey({ key, apiKey }: UpdateApiKeyProps, requestOptions?: RequestOptions): Promise<UpdateApiKeyResponse>;
 };
 
+/**
+ * How to change the attribute.
+ */
+type BuiltInOperationType = 'Increment' | 'Decrement' | 'Add' | 'Remove' | 'AddUnique' | 'IncrementFrom' | 'IncrementSet';
+
+type BuiltInOperationValue = string | number;
+
+/**
+ * Update to perform on the attribute.
+ */
+type BuiltInOperation = {
+    _operation: BuiltInOperationType;
+    value: BuiltInOperationValue;
+};
+
+type AttributeToUpdate = string | BuiltInOperation;
+
+/**
+ * Error.
+ */
+type ErrorBase = Record<string, any> & {
+    message?: string;
+};
+
 type SearchClient = ReturnType<typeof createSearchClient> & SearchClientNodeHelpers;
 
 declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): SearchClient;
 
-export { type Acl, type Action, type AddApiKeyResponse, type AddOrUpdateObjectProps, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type ApiKey, type ApiKeyOperation, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AssignUserIdParams, type AssignUserIdProps, type AttributeToUpdate, type AutomaticFacetFilter, type AutomaticFacetFilters, type BaseGetApiKeyResponse, type BaseIndexSettings, type BaseSearchParams, type BaseSearchParamsWithoutQuery, type BaseSearchResponse, type BatchAssignUserIdsParams, type BatchAssignUserIdsProps, type BatchDictionaryEntriesParams, type BatchDictionaryEntriesProps, type BatchDictionaryEntriesRequest, type BatchParams, type BatchProps, type BatchRequest, type BatchResponse, type BatchWriteParams, type BooleanString, type BrowseOptions, type BrowsePagination, type BrowseParams, type BrowseParamsObject, type BrowseProps, type BrowseResponse, type BuiltInOperation, type BuiltInOperationType, type BuiltInOperationValue, type ChunkedBatchOptions, type ClearObjectsProps, type ClearRulesProps, type ClearSynonymsProps, type Condition, type Consequence, type ConsequenceHide, type ConsequenceParams, type ConsequenceQuery, type ConsequenceQueryObject, type CreatedAtResponse, type Cursor, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteApiKeyProps, type DeleteApiKeyResponse, type DeleteByParams, type DeleteByProps, type DeleteIndexProps, type DeleteObjectProps, type DeleteObjectsOptions, type DeleteRuleProps, type DeleteSourceProps, type DeleteSourceResponse, type DeleteSynonymProps, type DeletedAtResponse, type DictionaryAction, type DictionaryEntry, type DictionaryEntryState, type DictionaryEntryType, type DictionaryLanguage, type DictionarySettingsParams, type DictionaryType, type Distinct, type Edit, type EditType, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type Facets, type FetchedIndex, type GenerateSecuredApiKeyOptions, type GetApiKeyProps, type GetApiKeyResponse, type GetAppTaskProps, type GetDictionarySettingsResponse, type GetLogsProps, type GetLogsResponse, type GetObjectProps, type GetObjectsParams, type GetObjectsRequest, type GetObjectsResponse, type GetRuleProps, type GetSecuredApiKeyRemainingValidityOptions, type GetSettingsProps, type GetSynonymProps, type GetTaskProps, type GetTaskResponse, type GetTopUserIdsResponse, type GetUserIdProps, type HasPendingMappingsProps, type HasPendingMappingsResponse, type HighlightResult, type HighlightResultOption, type Hit, type IgnorePlurals, type IndexSettings, type IndexSettingsAsSearchParams, type Languages, type LegacySearchMethodProps, type ListApiKeysResponse, type ListClustersResponse, type ListIndicesProps, type ListIndicesResponse, type ListUserIdsProps, type ListUserIdsResponse, type Log, type LogQuery, type LogType, type MatchLevel, type MatchedGeoLocation, type Mode, type MultipleBatchRequest, type MultipleBatchResponse, type NumericFilters, type OperationIndexParams, type OperationIndexProps, type OperationType, type OptionalFilters, type Params, type PartialUpdateObjectProps, type PartialUpdateObjectsOptions, type Personalization, type Promote, type PromoteObjectID, type PromoteObjectIDs, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RemoveStopWords, type RemoveUserIdProps, type RemoveUserIdResponse, type RemoveWordsIfNoResults, type RenderingContent, type ReplaceAllObjectsOptions, type ReplaceAllObjectsResponse, type ReplaceSourceResponse, type ReplaceSourcesProps, type RestoreApiKeyProps, type Rule, type SaveObjectProps, type SaveObjectResponse, type SaveObjectsOptions, type SaveRuleProps, type SaveRulesProps, type SaveSynonymProps, type SaveSynonymResponse, type SaveSynonymsProps, type ScopeType, type SearchClient, type SearchClientNodeHelpers, type SearchDictionaryEntriesParams, type SearchDictionaryEntriesProps, type SearchDictionaryEntriesResponse, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacets, type SearchForFacetsOptions, type SearchForHits, type SearchForHitsOptions, type SearchHits, type SearchMethodParams, type SearchPagination, type SearchParams, type SearchParamsObject, type SearchParamsQuery, type SearchParamsString, type SearchQuery, type SearchResponse, type SearchResponses, type SearchResult, type SearchRulesParams, type SearchRulesProps, type SearchRulesResponse, type SearchSingleIndexProps, type SearchStrategy, type SearchSynonymsParams, type SearchSynonymsProps, type SearchSynonymsResponse, type SearchTypeDefault, type SearchTypeFacet, type SearchUserIdsParams, type SearchUserIdsResponse, type SecuredApiKeyRestrictions, type SemanticSearch, type SetSettingsProps, type SettingsResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type Source, type StandardEntries, type SupportedLanguage, type SynonymHit, type SynonymType, type TagFilters, type TaskStatus, type TimeRange, type TypoTolerance, type TypoToleranceEnum, type UpdateApiKeyProps, type UpdateApiKeyResponse, type UpdatedAtResponse, type UpdatedAtWithObjectIdResponse, type UpdatedRuleResponse, type UserHighlightResult, type UserHit, type UserId, type Value, type WaitForApiKeyOptions, type WaitForAppTaskOptions, type WaitForTaskOptions, type WithPrimary, apiClientVersion, searchClient };
+export { type Acl, type Action, type AddApiKeyResponse, type AddOrUpdateObjectProps, type AdvancedSyntaxFeatures, type AlternativesAsExact, type Anchoring, type ApiKey, type ApiKeyOperation, type AroundPrecision, type AroundRadius, type AroundRadiusAll, type AssignUserIdParams, type AssignUserIdProps, type AttributeToUpdate, type AutomaticFacetFilter, type AutomaticFacetFilters, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseGetApiKeyResponse, type BaseIndexSettings, type BaseSearchParams, type BaseSearchParamsWithoutQuery, type BaseSearchResponse, type BatchAssignUserIdsParams, type BatchAssignUserIdsProps, type BatchDictionaryEntriesParams, type BatchDictionaryEntriesProps, type BatchDictionaryEntriesRequest, type BatchParams, type BatchProps, type BatchRequest, type BatchResponse, type BatchWriteParams, type BooleanString, type BrowseOptions, type BrowsePagination, type BrowseParams, type BrowseParamsObject, type BrowseProps, type BrowseResponse, type BuiltInOperation, type BuiltInOperationType, type BuiltInOperationValue, type ChunkedBatchOptions, type ClearObjectsProps, type ClearRulesProps, type ClearSynonymsProps, type Condition, type Consequence, type ConsequenceHide, type ConsequenceParams, type ConsequenceQuery, type ConsequenceQueryObject, type CreatedAtResponse, type Cursor, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteApiKeyProps, type DeleteApiKeyResponse, type DeleteByParams, type DeleteByProps, type DeleteIndexProps, type DeleteObjectProps, type DeleteObjectsOptions, type DeleteRuleProps, type DeleteSourceProps, type DeleteSourceResponse, type DeleteSynonymProps, type DeletedAtResponse, type DictionaryAction, type DictionaryEntry, type DictionaryEntryState, type DictionaryEntryType, type DictionaryLanguage, type DictionarySettingsParams, type DictionaryType, type Distinct, type Edit, type EditType, type ErrorBase, type ExactOnSingleWordQuery, type Exhaustive, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type Facets, type FetchedIndex, type GenerateSecuredApiKeyOptions, type GetApiKeyProps, type GetApiKeyResponse, type GetAppTaskProps, type GetDictionarySettingsResponse, type GetLogsProps, type GetLogsResponse, type GetObjectProps, type GetObjectsParams, type GetObjectsRequest, type GetObjectsResponse, type GetRuleProps, type GetSecuredApiKeyRemainingValidityOptions, type GetSettingsProps, type GetSynonymProps, type GetTaskProps, type GetTaskResponse, type GetTopUserIdsResponse, type GetUserIdProps, type HasPendingMappingsProps, type HasPendingMappingsResponse, type HighlightResult, type HighlightResultOption, type Hit, type IgnorePlurals, type IndexSettings, type IndexSettingsAsSearchParams, type Languages, type LegacySearchMethodProps, type ListApiKeysResponse, type ListClustersResponse, type ListIndicesProps, type ListIndicesResponse, type ListUserIdsProps, type ListUserIdsResponse, type Log, type LogQuery, type LogType, type MatchLevel, type MatchedGeoLocation, type Mode, type MultipleBatchRequest, type MultipleBatchResponse, type NumericFilters, type OperationIndexParams, type OperationIndexProps, type OperationType, type OptionalFilters, type Params, type PartialUpdateObjectProps, type PartialUpdateObjectsOptions, type Personalization, type Promote, type PromoteObjectID, type PromoteObjectIDs, type QueryType, type Range, type RankingInfo, type ReRankingApplyFilter, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RemoveStopWords, type RemoveUserIdProps, type RemoveUserIdResponse, type RemoveWordsIfNoResults, type RenderingContent, type ReplaceAllObjectsOptions, type ReplaceAllObjectsResponse, type ReplaceSourceResponse, type ReplaceSourcesProps, type RestoreApiKeyProps, type Rule, type SaveObjectProps, type SaveObjectResponse, type SaveObjectsOptions, type SaveRuleProps, type SaveRulesProps, type SaveSynonymProps, type SaveSynonymResponse, type SaveSynonymsProps, type ScopeType, type SearchClient, type SearchClientNodeHelpers, type SearchDictionaryEntriesParams, type SearchDictionaryEntriesProps, type SearchDictionaryEntriesResponse, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacets, type SearchForFacetsOptions, type SearchForHits, type SearchForHitsOptions, type SearchHits, type SearchMethodParams, type SearchPagination, type SearchParams, type SearchParamsObject, type SearchParamsQuery, type SearchParamsString, type SearchQuery, type SearchResponse, type SearchResponses, type SearchResult, type SearchRulesParams, type SearchRulesProps, type SearchRulesResponse, type SearchSingleIndexProps, type SearchStrategy, type SearchSynonymsParams, type SearchSynonymsProps, type SearchSynonymsResponse, type SearchTypeDefault, type SearchTypeFacet, type SearchUserIdsParams, type SearchUserIdsResponse, type SecuredApiKeyRestrictions, type SemanticSearch, type SetSettingsProps, type SettingsResponse, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type Source, type StandardEntries, type SupportedLanguage, type SynonymHit, type SynonymType, type TagFilters, type TaskStatus, type TimeRange, type TypoTolerance, type TypoToleranceEnum, type UpdateApiKeyProps, type UpdateApiKeyResponse, type UpdatedAtResponse, type UpdatedAtWithObjectIdResponse, type UpdatedRuleResponse, type UserHighlightResult, type UserHit, type UserId, type Value, type WaitForApiKeyOptions, type WaitForAppTaskOptions, type WaitForTaskOptions, type Widgets, type WithPrimary, apiClientVersion, searchClient };