@algolia/client-search 5.27.0 → 5.29.0

package/dist/fetch.d.ts

@@ -28,31 +28,31 @@ type ApiKey = {
     /**
      * Description of an API key to help you identify this API key.
      */
-    description?: string;
+    description?: string | undefined;
     /**
      * 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?: Array<string>;
+    indexes?: Array<string> | undefined;
     /**
      * Maximum number of results this API key can retrieve in one query. By default, there\'s no limit.
      */
-    maxHitsPerQuery?: number;
+    maxHitsPerQuery?: number | undefined;
     /**
      * Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) per hour.  If this limit is reached, the API returns an error with status code `429`. By default, there\'s no limit.
      */
-    maxQueriesPerIPPerHour?: number;
+    maxQueriesPerIPPerHour?: number | undefined;
     /**
      * 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;
+    queryParameters?: string | undefined;
     /**
      * 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?: Array<string>;
+    referers?: Array<string> | undefined;
     /**
      * Duration (in seconds) after which the API key expires. By default, API keys don\'t expire.
      */
-    validity?: number;
+    validity?: number | undefined;
 };
 
 /**
@@ -65,7 +65,7 @@ type MultipleBatchRequest = {
     /**
      * Operation arguments (varies with specified `action`).
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
     /**
      * Index name (case-sensitive).
      */
@@ -97,42 +97,42 @@ type Exhaustive = {
     /**
      * 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-).
      */
-    facetsCount?: boolean;
+    facetsCount?: boolean | undefined;
     /**
      * The value is `false` if not all facet values are retrieved.
      */
-    facetValues?: boolean;
+    facetValues?: boolean | undefined;
     /**
      * 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.
      */
-    nbHits?: boolean;
+    nbHits?: boolean | undefined;
     /**
      * 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.
      */
-    rulesMatch?: boolean;
+    rulesMatch?: boolean | undefined;
     /**
      * 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.
      */
-    typo?: boolean;
+    typo?: boolean | undefined;
 };
 
 type FacetStats = {
     /**
      * Minimum value in the results.
      */
-    min?: number;
+    min?: number | undefined;
     /**
      * Maximum value in the results.
      */
-    max?: number;
+    max?: number | undefined;
     /**
      * Average facet value in the results.
      */
-    avg?: number;
+    avg?: number | undefined;
     /**
      * Sum of all values in the results.
      */
-    sum?: number;
+    sum?: number | undefined;
 };
 
 /**
@@ -166,7 +166,7 @@ type RedirectRuleIndexMetadata = {
  * [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
  */
 type Redirect = {
-    index?: Array<RedirectRuleIndexMetadata>;
+    index?: Array<RedirectRuleIndexMetadata> | undefined;
 };
 
 /**
@@ -176,7 +176,7 @@ type Facets = {
     /**
      * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
      */
-    order?: Array<string>;
+    order?: Array<string> | undefined;
 };
 
 /**
@@ -188,62 +188,62 @@ type Value = {
     /**
      * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
      */
-    order?: Array<string>;
-    sortRemainingBy?: SortRemainingBy;
+    order?: Array<string> | undefined;
+    sortRemainingBy?: SortRemainingBy | undefined;
     /**
      * Hide facet values.
      */
-    hide?: Array<string>;
+    hide?: Array<string> | undefined;
 };
 
 /**
  * Order of facet names and facet values in your UI.
  */
 type FacetOrdering = {
-    facets?: Facets;
+    facets?: Facets | undefined;
     /**
      * Order of facet values. One object for each facet.
      */
     values?: {
         [key: string]: Value;
-    };
+    } | undefined;
 };
 
 /**
  * The redirect rule container.
  */
 type RedirectURL = {
-    url?: string;
+    url?: string | undefined;
 };
 
 /**
  * URL for an image to show inside a banner.
  */
 type BannerImageUrl = {
-    url?: string;
+    url?: string | undefined;
 };
 
 /**
  * Image to show inside a banner.
  */
 type BannerImage = {
-    urls?: Array<BannerImageUrl>;
-    title?: string;
+    urls?: Array<BannerImageUrl> | undefined;
+    title?: string | undefined;
 };
 
 /**
  * Link for a banner defined in the Merchandising Studio.
  */
 type BannerLink = {
-    url?: string;
+    url?: string | undefined;
 };
 
 /**
  * Banner with image and link to redirect users.
  */
 type Banner = {
-    image?: BannerImage;
-    link?: BannerLink;
+    image?: BannerImage | undefined;
+    link?: BannerLink | undefined;
 };
 
 /**
@@ -253,52 +253,52 @@ type Widgets = {
     /**
      * Banners defined in the Merchandising Studio for a given search.
      */
-    banners?: Array<Banner>;
+    banners?: Array<Banner> | undefined;
 };
 
 /**
  * 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;
+    facetOrdering?: FacetOrdering | undefined;
+    redirect?: RedirectURL | undefined;
+    widgets?: Widgets | undefined;
 };
 
 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;
+    abTestID?: number | undefined;
     /**
      * Variant ID. This is only included in the response for indices that are part of an A/B test.
      */
-    abTestVariantID?: number;
+    abTestVariantID?: number | undefined;
     /**
      * Computed geographical location.
      */
-    aroundLatLng?: string;
+    aroundLatLng?: string | undefined;
     /**
      * Distance from a central coordinate provided by `aroundLatLng`.
      */
-    automaticRadius?: string;
-    exhaustive?: Exhaustive;
+    automaticRadius?: string | undefined;
+    exhaustive?: Exhaustive | undefined;
     /**
      * Rules applied to the query.
      */
-    appliedRules?: Array<Record<string, unknown>>;
+    appliedRules?: Array<Record<string, unknown>> | undefined;
     /**
      * See the `facetsCount` field of the `exhaustive` object in the response.
      */
-    exhaustiveFacetsCount?: boolean;
+    exhaustiveFacetsCount?: boolean | undefined;
     /**
      * See the `nbHits` field of the `exhaustive` object in the response.
      */
-    exhaustiveNbHits?: boolean;
+    exhaustiveNbHits?: boolean | undefined;
     /**
      * See the `typo` field of the `exhaustive` object in the response.
      */
-    exhaustiveTypo?: boolean;
+    exhaustiveTypo?: boolean | undefined;
     /**
      * Facet counts.
      */
@@ -306,93 +306,93 @@ type BaseSearchResponse = Record<string, any> & {
         [key: string]: {
             [key: string]: number;
         };
-    };
+    } | undefined;
     /**
      * Statistics for numerical facets.
      */
     facets_stats?: {
         [key: string]: FacetStats;
-    };
+    } | undefined;
     /**
      * Index name used for the query.
      */
-    index?: string;
+    index?: string | undefined;
     /**
      * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
      */
-    indexUsed?: string;
+    indexUsed?: string | undefined;
     /**
      * Warnings about the query.
      */
-    message?: string;
+    message?: string | undefined;
     /**
      * Number of hits selected and sorted by the relevant sort algorithm.
      */
-    nbSortedHits?: number;
+    nbSortedHits?: number | undefined;
     /**
      * 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.
      */
-    parsedQuery?: string;
+    parsedQuery?: string | undefined;
     /**
      * Time the server took to process the request, in milliseconds.
      */
-    processingTimeMS: number;
+    processingTimeMS?: number | undefined;
     /**
      * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
      */
-    processingTimingsMS?: Record<string, unknown>;
+    processingTimingsMS?: Record<string, unknown> | undefined;
     /**
      * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
      */
-    queryAfterRemoval?: string;
-    redirect?: Redirect;
-    renderingContent?: RenderingContent;
+    queryAfterRemoval?: string | undefined;
+    redirect?: Redirect | undefined;
+    renderingContent?: RenderingContent | undefined;
     /**
      * Time the server took to process the request, in milliseconds.
      */
-    serverTimeMS?: number;
+    serverTimeMS?: number | undefined;
     /**
      * Host name of the server that processed the request.
      */
-    serverUsed?: string;
+    serverUsed?: string | undefined;
     /**
      * An object with custom data.  You can store up to 32kB as custom data.
      */
-    userData?: any | null;
+    userData?: any | null | undefined;
     /**
      * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
      */
-    queryID?: string;
+    queryID?: string | undefined;
     /**
      * Whether automatic events collection is enabled for the application.
      */
-    _automaticInsights?: boolean;
+    _automaticInsights?: boolean | undefined;
 };
 
 type BrowsePagination = {
     /**
      * Page of search results to retrieve.
      */
-    page?: number;
+    page?: number | undefined;
     /**
      * Number of results (hits).
      */
-    nbHits?: number;
+    nbHits?: number | undefined;
     /**
      * Number of pages of results.
      */
-    nbPages?: number;
+    nbPages?: number | undefined;
     /**
      * Number of hits per page.
      */
-    hitsPerPage?: number;
+    hitsPerPage?: number | undefined;
 };
 
 type Cursor = {
     /**
      * 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.
      */
-    cursor?: string;
+    cursor?: string | undefined;
 };
 
 /**
@@ -416,7 +416,7 @@ type HighlightResultOption = {
     /**
      * Whether the entire attribute value is highlighted.
      */
-    fullyHighlighted?: boolean;
+    fullyHighlighted?: boolean | undefined;
 };
 
 type HighlightResult = HighlightResultOption | {
@@ -427,30 +427,30 @@ type MatchedGeoLocation = {
     /**
      * Latitude of the matched location.
      */
-    lat?: number;
+    lat?: number | undefined;
     /**
      * Longitude of the matched location.
      */
-    lng?: number;
+    lng?: number | undefined;
     /**
      * Distance between the matched location and the search location (in meters).
      */
-    distance?: number;
+    distance?: number | undefined;
 };
 
 type Personalization = {
     /**
      * The score of the filters.
      */
-    filtersScore?: number;
+    filtersScore?: number | undefined;
     /**
      * The score of the ranking.
      */
-    rankingScore?: number;
+    rankingScore?: number | undefined;
     /**
      * The score of the event.
      */
-    score?: number;
+    score?: number | undefined;
 };
 
 /**
@@ -460,7 +460,7 @@ type RankingInfo = {
     /**
      * Whether a filter matched the query.
      */
-    filters?: number;
+    filters?: number | undefined;
     /**
      * Position of the first matched word in the best matching attribute of the record.
      */
@@ -472,9 +472,9 @@ type RankingInfo = {
     /**
      * Precision used when computing the geo distance, in meters.
      */
-    geoPrecision?: number;
-    matchedGeoLocation?: MatchedGeoLocation;
-    personalization?: Personalization;
+    geoPrecision?: number | undefined;
+    matchedGeoLocation?: MatchedGeoLocation | undefined;
+    personalization?: Personalization | undefined;
     /**
      * Number of exactly matched words.
      */
@@ -486,11 +486,11 @@ type RankingInfo = {
     /**
      * Whether the record was promoted by a rule.
      */
-    promoted?: boolean;
+    promoted?: boolean | undefined;
     /**
      * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
      */
-    proximityDistance?: number;
+    proximityDistance?: number | undefined;
     /**
      * Overall ranking of the record, expressed as a single integer. This attribute is internal.
      */
@@ -498,11 +498,11 @@ type RankingInfo = {
     /**
      * Number of matched words.
      */
-    words?: number;
+    words?: number | undefined;
     /**
      * Whether the record is re-ranked.
      */
-    promotedByReRanking?: boolean;
+    promotedByReRanking?: boolean | undefined;
 };
 
 /**
@@ -533,15 +533,15 @@ type Hit<T = Record<string, unknown>> = T & {
      */
     _highlightResult?: {
         [key: string]: HighlightResult;
-    };
+    } | undefined;
     /**
      * Snippets that show the context around a matching search query.
      */
     _snippetResult?: {
         [key: string]: SnippetResult;
-    };
-    _rankingInfo?: RankingInfo;
-    _distinctSeqID?: number;
+    } | undefined;
+    _rankingInfo?: RankingInfo | undefined;
+    _distinctSeqID?: number | undefined;
 };
 
 type SearchHits<T = Record<string, unknown>> = Record<string, any> & {
@@ -608,19 +608,19 @@ type StandardEntries = {
      */
     plurals?: {
         [key: string]: boolean;
-    } | null;
+    } | null | undefined;
     /**
      * Key-value pair of a language ISO code and a boolean value.
      */
     stopwords?: {
         [key: string]: boolean;
-    } | null;
+    } | null | undefined;
     /**
      * Key-value pair of a language ISO code and a boolean value.
      */
     compounds?: {
         [key: string]: boolean;
-    } | null;
+    } | null | undefined;
 };
 
 /**
@@ -651,15 +651,15 @@ type LogQuery = {
     /**
      * Index targeted by the query.
      */
-    index_name?: string;
+    index_name?: string | undefined;
     /**
      * A user identifier.
      */
-    user_token?: string;
+    user_token?: string | undefined;
     /**
      * Unique query identifier.
      */
-    query_id?: string;
+    query_id?: string | undefined;
 };
 
 type Log = {
@@ -702,7 +702,7 @@ type Log = {
     /**
      * Number of API requests.
      */
-    nb_api_calls?: string;
+    nb_api_calls?: string | undefined;
     /**
      * Processing time for the query in milliseconds. This doesn\'t include latency due to the network.
      */
@@ -710,19 +710,19 @@ type Log = {
     /**
      * Index targeted by the query.
      */
-    index?: string;
+    index?: string | undefined;
     /**
      * Query parameters sent with the request.
      */
-    query_params?: string;
+    query_params?: string | undefined;
     /**
      * Number of search results (hits) returned for the query.
      */
-    query_nb_hits?: string;
+    query_nb_hits?: string | undefined;
     /**
      * Queries performed for the given request.
      */
-    inner_queries?: Array<LogQuery>;
+    inner_queries?: Array<LogQuery> | undefined;
 };
 
 type GetLogsResponse = {
@@ -736,7 +736,7 @@ type GetObjectsRequest = {
     /**
      * Attributes to retrieve. If not specified, all retrievable attributes are returned.
      */
-    attributesToRetrieve?: Array<string>;
+    attributesToRetrieve?: Array<string> | undefined;
     /**
      * Object ID for the record to retrieve.
      */
@@ -758,7 +758,7 @@ type GetObjectsResponse<T = Record<string, unknown>> = {
     /**
      * An optional status message.
      */
-    message?: string;
+    message?: string | undefined;
     /**
      * Retrieved records.
      */
@@ -818,7 +818,7 @@ type HasPendingMappingsResponse = {
      */
     clusters?: {
         [key: string]: Array<string>;
-    };
+    } | undefined;
 };
 
 /**
@@ -828,7 +828,7 @@ type DictionaryLanguage = {
     /**
      * Number of custom dictionary entries.
      */
-    nbCustomEntries?: number;
+    nbCustomEntries?: number | undefined;
 };
 
 /**
@@ -897,15 +897,15 @@ type FetchedIndex = {
     /**
      * Only present if the index is a replica. Contains the name of the related primary index.
      */
-    primary?: string;
+    primary?: string | undefined;
     /**
      * Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
      */
-    replicas?: Array<string>;
+    replicas?: Array<string> | undefined;
     /**
      * 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;
+    virtual?: boolean | undefined;
 };
 
 type ListIndicesResponse = {
@@ -916,7 +916,7 @@ type ListIndicesResponse = {
     /**
      * Number of pages.
      */
-    nbPages?: number;
+    nbPages?: number | undefined;
 };
 
 /**
@@ -988,20 +988,20 @@ 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;
+    pattern?: string | undefined;
+    anchoring?: Anchoring | undefined;
     /**
      * Whether the pattern should match plurals, synonyms, and typos.
      */
-    alternatives?: boolean;
+    alternatives?: boolean | undefined;
     /**
      * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
      */
-    context?: string;
+    context?: string | undefined;
     /**
      * Filters that trigger the rule.  You can 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. You can\'t combine multiple filters with `OR` and you can\'t use numeric filters.
      */
-    filters?: string;
+    filters?: string | undefined;
 };
 
 /**
@@ -1021,11 +1021,11 @@ type Range = {
     /**
      * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
      */
-    from?: number;
+    from?: number | undefined;
     /**
      * Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
      */
-    value?: number;
+    value?: number | undefined;
 };
 
 /**
@@ -1074,106 +1074,106 @@ 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;
+    similarQuery?: string | undefined;
     /**
      * 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;
+    filters?: string | undefined;
+    facetFilters?: FacetFilters | undefined;
+    optionalFilters?: OptionalFilters | undefined;
+    numericFilters?: NumericFilters | undefined;
+    tagFilters?: TagFilters | undefined;
     /**
      * 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;
+    sumOrFiltersScores?: boolean | undefined;
     /**
      * Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
      */
-    restrictSearchableAttributes?: Array<string>;
+    restrictSearchableAttributes?: Array<string> | undefined;
     /**
      * 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>;
+    facets?: Array<string> | undefined;
     /**
      * 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;
+    facetingAfterDistinct?: boolean | undefined;
     /**
      * Page of search results to retrieve.
      */
-    page?: number;
+    page?: number | undefined;
     /**
      * Position of the first hit to retrieve.
      */
-    offset?: number;
+    offset?: number | undefined;
     /**
      * Number of hits to retrieve (used in combination with `offset`).
      */
-    length?: number;
+    length?: number | undefined;
     /**
      * 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;
+    aroundLatLng?: string | undefined;
     /**
      * Whether to obtain the coordinates from the request\'s IP address.
      */
-    aroundLatLngViaIP?: boolean;
-    aroundRadius?: AroundRadius;
-    aroundPrecision?: AroundPrecision;
+    aroundLatLngViaIP?: boolean | undefined;
+    aroundRadius?: AroundRadius | undefined;
+    aroundPrecision?: AroundPrecision | undefined;
     /**
      * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
      */
-    minimumAroundRadius?: number;
-    insideBoundingBox?: InsideBoundingBox | null;
+    minimumAroundRadius?: number | undefined;
+    insideBoundingBox?: InsideBoundingBox | null | undefined;
     /**
      * Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
      */
-    insidePolygon?: Array<Array<number>>;
+    insidePolygon?: Array<Array<number>> | undefined;
     /**
      * ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches):  - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
      */
-    naturalLanguages?: Array<SupportedLanguage>;
+    naturalLanguages?: Array<SupportedLanguage> | undefined;
     /**
      * Assigns a rule context to the search query.  [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
      */
-    ruleContexts?: Array<string>;
+    ruleContexts?: Array<string> | undefined;
     /**
      * Impact that Personalization should have on this search.  The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
      */
-    personalizationImpact?: number;
+    personalizationImpact?: number | undefined;
     /**
      * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
-    userToken?: string;
+    userToken?: string | undefined;
     /**
      * Whether the search response should include detailed ranking information.
      */
-    getRankingInfo?: boolean;
+    getRankingInfo?: boolean | undefined;
     /**
      * Whether to take into account an index\'s synonyms for this search.
      */
-    synonyms?: boolean;
+    synonyms?: boolean | undefined;
     /**
      * Whether to include a `queryID` attribute in the response.  The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
      */
-    clickAnalytics?: boolean;
+    clickAnalytics?: boolean | undefined;
     /**
      * Whether this search will be included in Analytics.
      */
-    analytics?: boolean;
+    analytics?: boolean | undefined;
     /**
      * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      */
-    analyticsTags?: Array<string>;
+    analyticsTags?: Array<string> | undefined;
     /**
      * Whether to include this search when calculating processing-time percentiles.
      */
-    percentileComputation?: boolean;
+    percentileComputation?: boolean | undefined;
     /**
      * Whether to enable A/B testing for this search.
      */
-    enableABTest?: boolean;
+    enableABTest?: boolean | undefined;
 };
 
 type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
@@ -1234,7 +1234,7 @@ type SemanticSearch = {
     /**
      * Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
      */
-    eventSources?: Array<string> | null;
+    eventSources?: Array<string> | null | undefined;
 };
 
 /**
@@ -1251,131 +1251,131 @@ 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?: Array<string>;
+    attributesToRetrieve?: Array<string> | undefined;
     /**
      * 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?: Array<string>;
+    ranking?: Array<string> | undefined;
     /**
      * 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.
      */
-    relevancyStrictness?: number;
+    relevancyStrictness?: number | undefined;
     /**
      * 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?: Array<string>;
+    attributesToHighlight?: Array<string> | undefined;
     /**
      * 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?: Array<string>;
+    attributesToSnippet?: Array<string> | undefined;
     /**
      * HTML tag to insert before the highlighted parts in all highlighted results and snippets.
      */
-    highlightPreTag?: string;
+    highlightPreTag?: string | undefined;
     /**
      * HTML tag to insert after the highlighted parts in all highlighted results and snippets.
      */
-    highlightPostTag?: string;
+    highlightPostTag?: string | undefined;
     /**
      * String used as an ellipsis indicator when a snippet is truncated.
      */
-    snippetEllipsisText?: string;
+    snippetEllipsisText?: string | undefined;
     /**
      * Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.
      */
-    restrictHighlightAndSnippetArrays?: boolean;
+    restrictHighlightAndSnippetArrays?: boolean | undefined;
     /**
      * Number of hits per page.
      */
-    hitsPerPage?: number;
+    hitsPerPage?: number | undefined;
     /**
      * Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
      */
-    minWordSizefor1Typo?: number;
+    minWordSizefor1Typo?: number | undefined;
     /**
      * Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
      */
-    minWordSizefor2Typos?: number;
-    typoTolerance?: TypoTolerance;
+    minWordSizefor2Typos?: number | undefined;
+    typoTolerance?: TypoTolerance | undefined;
     /**
      * Whether to allow typos on numbers in the search query.  Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.
      */
-    allowTyposOnNumericTokens?: boolean;
+    allowTyposOnNumericTokens?: boolean | undefined;
     /**
      * 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?: Array<string>;
-    ignorePlurals?: IgnorePlurals;
-    removeStopWords?: RemoveStopWords;
+    disableTypoToleranceOnAttributes?: Array<string> | undefined;
+    ignorePlurals?: IgnorePlurals | undefined;
+    removeStopWords?: RemoveStopWords | undefined;
     /**
      * 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?: Array<SupportedLanguage>;
+    queryLanguages?: Array<SupportedLanguage> | undefined;
     /**
      * 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).
      */
-    decompoundQuery?: boolean;
+    decompoundQuery?: boolean | undefined;
     /**
      * Whether to enable rules.
      */
-    enableRules?: boolean;
+    enableRules?: boolean | undefined;
     /**
      * Whether to enable Personalization.
      */
-    enablePersonalization?: boolean;
-    queryType?: QueryType;
-    removeWordsIfNoResults?: RemoveWordsIfNoResults;
-    mode?: Mode;
-    semanticSearch?: SemanticSearch;
+    enablePersonalization?: boolean | undefined;
+    queryType?: QueryType | undefined;
+    removeWordsIfNoResults?: RemoveWordsIfNoResults | undefined;
+    mode?: Mode | undefined;
+    semanticSearch?: SemanticSearch | undefined;
     /**
      * Whether to support phrase matching and excluding words from search queries.  Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
      */
-    advancedSyntax?: boolean;
-    optionalWords?: OptionalWords | null;
+    advancedSyntax?: boolean | undefined;
+    optionalWords?: OptionalWords | null | undefined;
     /**
      * 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?: Array<string>;
-    exactOnSingleWordQuery?: ExactOnSingleWordQuery;
+    disableExactOnAttributes?: Array<string> | undefined;
+    exactOnSingleWordQuery?: ExactOnSingleWordQuery | undefined;
     /**
      * Determine which plurals and synonyms should be considered an exact matches.  By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example:  - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).  - `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?: Array<AlternativesAsExact>;
+    alternativesAsExact?: Array<AlternativesAsExact> | undefined;
     /**
      * 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?: Array<AdvancedSyntaxFeatures>;
-    distinct?: Distinct;
+    advancedSyntaxFeatures?: Array<AdvancedSyntaxFeatures> | undefined;
+    distinct?: Distinct | undefined;
     /**
      * 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;
+    replaceSynonymsInHighlight?: boolean | undefined;
     /**
      * Minimum proximity score for two matching words.  This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart.  For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.
      */
-    minProximity?: number;
+    minProximity?: number | undefined;
     /**
      * 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 properties should be included.  An empty list may lead to an empty API response (except properties you can\'t exclude).  You can\'t exclude these properties: `message`, `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true.  Your search depends on the `hits` field. If you omit this field, searches won\'t return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience.
      */
-    responseFields?: Array<string>;
+    responseFields?: Array<string> | undefined;
     /**
      * Maximum number of facet values to return for each facet.
      */
-    maxValuesPerFacet?: number;
+    maxValuesPerFacet?: number | undefined;
     /**
      * Order in which to retrieve facet values.  - `count`.   Facet values are retrieved by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Retrieve facet values alphabetically.  This setting doesn\'t influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
      */
-    sortFacetValuesBy?: string;
+    sortFacetValuesBy?: string | undefined;
     /**
      * Whether the best matching attribute should be determined by minimum proximity.  This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.
      */
-    attributeCriteriaComputedByMinProximity?: boolean;
-    renderingContent?: RenderingContent;
+    attributeCriteriaComputedByMinProximity?: boolean | undefined;
+    renderingContent?: RenderingContent | undefined;
     /**
      * Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).  This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
      */
-    enableReRanking?: boolean;
-    reRankingApplyFilter?: ReRankingApplyFilter | null;
+    enableReRanking?: boolean | undefined;
+    reRankingApplyFilter?: ReRankingApplyFilter | null | undefined;
 };
 
 /**
@@ -1389,11 +1389,11 @@ type AutomaticFacetFilter = {
     /**
      * Filter scores to give different weights to individual filters.
      */
-    score?: number;
+    score?: number | undefined;
     /**
      * 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.
      */
-    disjunctive?: boolean;
+    disjunctive?: boolean | undefined;
 };
 
 /**
@@ -1407,26 +1407,26 @@ type AutomaticFacetFilters = Array<AutomaticFacetFilter> | Array<string>;
 type EditType = 'remove' | 'replace';
 
 type Edit = {
-    type?: EditType;
+    type?: EditType | undefined;
     /**
      * Text or patterns to remove from the query string.
      */
-    delete?: string;
+    delete?: string | undefined;
     /**
      * Text to be added in place of the deleted text inside the query string.
      */
-    insert?: string;
+    insert?: string | undefined;
 };
 
 type ConsequenceQueryObject = {
     /**
      * Words to remove from the search query.
      */
-    remove?: Array<string>;
+    remove?: Array<string> | undefined;
     /**
      * Changes to make to the search query.
      */
-    edits?: Array<Edit>;
+    edits?: Array<Edit> | undefined;
 };
 
 /**
@@ -1438,10 +1438,10 @@ type ConsequenceQuery = ConsequenceQueryObject | string;
  * Parameters to apply to this search.  You can use all search parameters, plus special `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`.
  */
 type Params = {
-    query?: ConsequenceQuery;
-    automaticFacetFilters?: AutomaticFacetFilters;
-    automaticOptionalFacetFilters?: AutomaticFacetFilters;
-    renderingContent?: RenderingContent;
+    query?: ConsequenceQuery | undefined;
+    automaticFacetFilters?: AutomaticFacetFilters | undefined;
+    automaticOptionalFacetFilters?: AutomaticFacetFilters | undefined;
+    renderingContent?: RenderingContent | undefined;
 };
 
 type ConsequenceParams = BaseSearchParamsWithoutQuery & IndexSettingsAsSearchParams & Params;
@@ -1480,23 +1480,23 @@ 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).
  */
 type Consequence = {
-    params?: ConsequenceParams;
+    params?: ConsequenceParams | undefined;
     /**
      * 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?: Array<Promote>;
+    promote?: Array<Promote> | undefined;
     /**
      * 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.
      */
-    filterPromotes?: boolean;
+    filterPromotes?: boolean | undefined;
     /**
      * Records you want to hide from the search results.
      */
-    hide?: Array<ConsequenceHide>;
+    hide?: Array<ConsequenceHide> | undefined;
     /**
      * 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?: Record<string, unknown>;
+    userData?: Record<string, unknown> | undefined;
 };
 
 type TimeRange = {
@@ -1521,20 +1521,20 @@ type Rule = {
     /**
      * 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).
      */
-    conditions?: Array<Condition>;
+    conditions?: Array<Condition> | undefined;
     consequence: Consequence;
     /**
      * Description of the rule\'s purpose to help you distinguish between different rules.
      */
-    description?: string;
+    description?: string | undefined;
     /**
      * Whether the rule is active.
      */
-    enabled?: boolean;
+    enabled?: boolean | undefined;
     /**
      * Time periods when the rule is active.
      */
-    validity?: Array<TimeRange>;
+    validity?: Array<TimeRange> | undefined;
 };
 
 type SaveObjectResponse = {
@@ -1549,7 +1549,7 @@ type SaveObjectResponse = {
     /**
      * Unique record identifier.
      */
-    objectID?: string;
+    objectID?: string | undefined;
 };
 
 type SaveSynonymResponse = {
@@ -1585,21 +1585,21 @@ type DictionaryEntry = Record<string, any> & {
      * Unique identifier for the dictionary entry.
      */
     objectID: string;
-    language?: SupportedLanguage;
+    language?: SupportedLanguage | undefined;
     /**
      * Matching dictionary word for `stopwords` and `compounds` dictionaries.
      */
-    word?: string;
+    word?: string | undefined;
     /**
      * Matching words in the `plurals` dictionary including declensions.
      */
-    words?: Array<string>;
+    words?: Array<string> | undefined;
     /**
      * Invividual components of a compound word in the `compounds` dictionary.
      */
-    decomposition?: Array<string>;
-    state?: DictionaryEntryState;
-    type?: DictionaryEntryType;
+    decomposition?: Array<string> | undefined;
+    state?: DictionaryEntryState | undefined;
+    type?: DictionaryEntryType | undefined;
 };
 
 type SearchDictionaryEntriesResponse = {
@@ -1648,7 +1648,7 @@ type SearchForFacetValuesResponse = {
     /**
      * Time the server took to process the request, in milliseconds.
      */
-    processingTimeMS?: number;
+    processingTimeMS?: number | undefined;
 };
 
 /**
@@ -1668,11 +1668,11 @@ type SearchForFacetsOptions = {
     /**
      * Text to search inside the facet\'s values.
      */
-    facetQuery?: string;
+    facetQuery?: string | undefined;
     /**
      * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
      */
-    maxFacetHits?: number;
+    maxFacetHits?: number | undefined;
     type: SearchTypeFacet;
 };
 
@@ -1680,7 +1680,7 @@ type SearchParamsQuery = {
     /**
      * Search query.
      */
-    query?: string;
+    query?: string | undefined;
 };
 
 type BaseSearchParams = SearchParamsQuery & BaseSearchParamsWithoutQuery;
@@ -1697,7 +1697,7 @@ type SearchParamsString = {
     /**
      * Search parameters as a URL-encoded query string.
      */
-    params?: string;
+    params?: string | undefined;
 };
 
 type SearchParams = SearchParamsString | SearchParamsObject;
@@ -1714,11 +1714,11 @@ type SearchForHitsOptions = {
      * Index name (case-sensitive).
      */
     indexName: string;
-    type?: SearchTypeDefault;
+    type?: SearchTypeDefault | undefined;
 } & {
-    facet?: never;
-    maxFacetHits?: never;
-    facetQuery?: never;
+    facet?: never | undefined;
+    maxFacetHits?: never | undefined;
+    facetQuery?: never | undefined;
 };
 
 type SearchForHits = SearchParams & SearchForHitsOptions;
@@ -1732,26 +1732,26 @@ type SearchStrategy = 'none' | 'stopIfEnoughMatches';
 
 type SearchMethodParams = {
     requests: Array<SearchQuery>;
-    strategy?: SearchStrategy;
+    strategy?: SearchStrategy | undefined;
 };
 
 type SearchPagination = {
     /**
      * Page of search results to retrieve.
      */
-    page?: number;
+    page?: number | undefined;
     /**
      * Number of results (hits).
      */
-    nbHits?: number;
+    nbHits?: number | undefined;
     /**
      * Number of pages of results.
      */
-    nbPages?: number;
+    nbPages?: number | undefined;
     /**
      * Number of hits per page.
      */
-    hitsPerPage?: number;
+    hitsPerPage?: number | undefined;
 };
 
 type SearchResponse<T = Record<string, unknown>> = BaseSearchResponse & SearchPagination & SearchHits<T>;
@@ -1798,27 +1798,27 @@ type SynonymHit = {
     /**
      * Words or phrases considered equivalent.
      */
-    synonyms?: Array<string>;
+    synonyms?: Array<string> | undefined;
     /**
      * 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/)).
      */
-    input?: string;
+    input?: string | undefined;
     /**
      * 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/)).
      */
-    word?: string;
+    word?: string | undefined;
     /**
      * Words to be matched in records.
      */
-    corrections?: Array<string>;
+    corrections?: Array<string> | undefined;
     /**
      * [Placeholder token](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.
      */
-    placeholder?: string;
+    placeholder?: string | undefined;
     /**
      * 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/).
      */
-    replacements?: Array<string>;
+    replacements?: Array<string> | undefined;
 };
 
 type SearchSynonymsResponse = Record<string, any> & {
@@ -1843,15 +1843,15 @@ type SearchUserIdsParams = {
     /**
      * Cluster name.
      */
-    clusterName?: string;
+    clusterName?: string | undefined;
     /**
      * Page of search results to retrieve.
      */
-    page?: number;
+    page?: number | undefined;
     /**
      * Number of hits per page.
      */
-    hitsPerPage?: number;
+    hitsPerPage?: number | undefined;
 };
 
 type UserHighlightResult = {
@@ -1913,63 +1913,63 @@ type BaseIndexSettings = {
     /**
      * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).  Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive.  **Modifiers**  - `filterOnly(\"ATTRIBUTE\")`.   Allows the attribute to be used as a filter but doesn\'t evaluate the facet values.  - `searchable(\"ATTRIBUTE\")`.   Allows searching for facet values.  - `afterDistinct(\"ATTRIBUTE\")`.   Evaluates the facet count _after_ deduplication with `distinct`.   This ensures accurate facet counts.   You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
      */
-    attributesForFaceting?: Array<string>;
+    attributesForFaceting?: Array<string> | undefined;
     /**
      * Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).  Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you\'ll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index.  **Modifier**  - `virtual(\"REPLICA\")`.   Create a virtual replica,   Virtual replicas don\'t increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).
      */
-    replicas?: Array<string>;
+    replicas?: Array<string> | undefined;
     /**
      * 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.
      */
-    paginationLimitedTo?: number;
+    paginationLimitedTo?: number | undefined;
     /**
      * Attributes that can\'t be retrieved at query time.  This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don\'t want to include it in the search results. Attribute names are case-sensitive.
      */
-    unretrievableAttributes?: Array<string>;
+    unretrievableAttributes?: Array<string> | undefined;
     /**
      * Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
      */
-    disableTypoToleranceOnWords?: Array<string>;
+    disableTypoToleranceOnWords?: Array<string> | undefined;
     /**
      * Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead).  Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive.
      */
-    attributesToTransliterate?: Array<string>;
+    attributesToTransliterate?: Array<string> | undefined;
     /**
      * Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive.
      */
-    camelCaseAttributes?: Array<string>;
+    camelCaseAttributes?: Array<string> | undefined;
     /**
      * 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).
      */
-    decompoundedAttributes?: Record<string, unknown>;
+    decompoundedAttributes?: Record<string, unknown> | undefined;
     /**
      * Languages for language-specific processing steps, such as word detection and dictionary settings.  **You should always specify an indexing language.** If you don\'t specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
      */
-    indexLanguages?: Array<SupportedLanguage>;
+    indexLanguages?: Array<SupportedLanguage> | undefined;
     /**
      * Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive.
      */
-    disablePrefixOnAttributes?: Array<string>;
+    disablePrefixOnAttributes?: Array<string> | undefined;
     /**
      * Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.
      */
-    allowCompressionOfIntegerArray?: boolean;
+    allowCompressionOfIntegerArray?: boolean | undefined;
     /**
      * Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive.  By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes.  To turn off filtering for all numeric attributes, specify an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`.  **Modifier**  - `equalOnly(\"ATTRIBUTE\")`.   Support only filtering based on equality comparisons `=` and `!=`.
      */
-    numericAttributesForFiltering?: Array<string>;
+    numericAttributesForFiltering?: Array<string> | undefined;
     /**
      * Control which non-alphanumeric characters are indexed.  By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥.  With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
      */
-    separatorsToIndex?: string;
+    separatorsToIndex?: string | undefined;
     /**
      * Attributes used for searching. Attribute names are case-sensitive.  By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered.  For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).  **Modifier**  - `unordered(\"ATTRIBUTE\")`.   Ignore the position of a match within the attribute.  Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
      */
-    searchableAttributes?: Array<string>;
+    searchableAttributes?: Array<string> | undefined;
     /**
      * An object with custom data.  You can store up to 32kB as custom data.
      */
-    userData?: any | null;
+    userData?: any | null | undefined;
     /**
      * 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/).
      */
@@ -1977,23 +1977,23 @@ type BaseIndexSettings = {
         [key: string]: {
             [key: string]: string;
         };
-    };
+    } | undefined;
     /**
      * 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.
      */
-    attributeForDistinct?: string;
+    attributeForDistinct?: string | undefined;
     /**
      * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
      */
-    maxFacetHits?: number;
+    maxFacetHits?: number | undefined;
     /**
      * Characters for which diacritics should be preserved.  By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
      */
-    keepDiacriticsOnCharacters?: string;
+    keepDiacriticsOnCharacters?: string | undefined;
     /**
      * 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?: Array<string>;
+    customRanking?: Array<string> | undefined;
 };
 
 /**
@@ -2005,7 +2005,7 @@ type WithPrimary = {
     /**
      * Replica indices only: the name of the primary index for this replica.
      */
-    primary?: string;
+    primary?: string | undefined;
 };
 
 type SettingsResponse = IndexSettings & WithPrimary;
@@ -2021,7 +2021,7 @@ type Source = {
     /**
      * Source description.
      */
-    description?: string;
+    description?: string | undefined;
 };
 
 type UpdateApiKeyResponse = {
@@ -2042,15 +2042,15 @@ 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;
+    taskID?: number | undefined;
     /**
      * Date and time when the object was updated, in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt?: string | undefined;
     /**
      * Unique record identifier.
      */
-    objectID?: string;
+    objectID?: string | undefined;
 };
 
 type ApiKeyOperation = 'add' | 'delete' | 'update';
@@ -2096,7 +2096,7 @@ type BatchDictionaryEntriesParams = {
     /**
      * Whether to replace all custom entries in the dictionary with the ones sent with this request.
      */
-    clearExistingDictionaryEntries?: boolean;
+    clearExistingDictionaryEntries?: boolean | undefined;
     /**
      * List of additions and deletions to your dictionaries.
      */
@@ -2123,23 +2123,23 @@ type BrowseParamsObject = SearchParamsObject & Cursor;
 type BrowseParams = SearchParamsString | BrowseParamsObject;
 
 type DeleteByParams = {
-    facetFilters?: FacetFilters;
+    facetFilters?: FacetFilters | undefined;
     /**
      * 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;
-    numericFilters?: NumericFilters;
-    tagFilters?: TagFilters;
+    filters?: string | undefined;
+    numericFilters?: NumericFilters | undefined;
+    tagFilters?: TagFilters | undefined;
     /**
      * 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;
-    aroundRadius?: AroundRadius;
-    insideBoundingBox?: InsideBoundingBox | null;
+    aroundLatLng?: string | undefined;
+    aroundRadius?: AroundRadius | undefined;
+    insideBoundingBox?: InsideBoundingBox | null | undefined;
     /**
      * Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
      */
-    insidePolygon?: Array<Array<number>>;
+    insidePolygon?: Array<Array<number>> | undefined;
 };
 
 type DictionaryType = 'plurals' | 'stopwords' | 'compounds';
@@ -2162,7 +2162,7 @@ type OperationIndexParams = {
     /**
      * **Only for copying.**  If you specify a scope, only the selected scopes are copied. Records and the other scopes are left unchanged. If you omit the `scope` parameter, everything is copied: records, settings, synonyms, and rules.
      */
-    scope?: Array<ScopeType>;
+    scope?: Array<ScopeType> | undefined;
 };
 
 /**
@@ -2176,27 +2176,27 @@ type SearchDictionaryEntriesParams = {
     /**
      * Page of search results to retrieve.
      */
-    page?: number;
+    page?: number | undefined;
     /**
      * Number of hits per page.
      */
-    hitsPerPage?: number;
-    language?: SupportedLanguage;
+    hitsPerPage?: number | undefined;
+    language?: SupportedLanguage | undefined;
 };
 
 type SearchForFacetValuesRequest = {
     /**
      * Search parameters as a URL-encoded query string.
      */
-    params?: string;
+    params?: string | undefined;
     /**
      * Text to search inside the facet\'s values.
      */
-    facetQuery?: string;
+    facetQuery?: string | undefined;
     /**
      * Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
      */
-    maxFacetHits?: number;
+    maxFacetHits?: number | undefined;
 };
 
 /**
@@ -2206,64 +2206,64 @@ type SearchRulesParams = {
     /**
      * Search query for rules.
      */
-    query?: string;
-    anchoring?: Anchoring;
+    query?: string | undefined;
+    anchoring?: Anchoring | undefined;
     /**
      * Only return rules that match the context (exact match).
      */
-    context?: string;
+    context?: string | undefined;
     /**
      * Requested page of the API response.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
      */
-    page?: number;
+    page?: number | undefined;
     /**
      * Maximum number of hits per page.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
      */
-    hitsPerPage?: number;
+    hitsPerPage?: number | undefined;
     /**
      * If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.
      */
-    enabled?: boolean | null;
+    enabled?: boolean | null | undefined;
 };
 
 type SearchSynonymsParams = {
     /**
      * Search query.
      */
-    query?: string;
-    type?: SynonymType;
+    query?: string | undefined;
+    type?: SynonymType | undefined;
     /**
      * Page of search results to retrieve.
      */
-    page?: number;
+    page?: number | undefined;
     /**
      * Number of hits per page.
      */
-    hitsPerPage?: number;
+    hitsPerPage?: number | undefined;
 };
 
 type SecuredApiKeyRestrictions = {
-    searchParams?: SearchParamsObject;
+    searchParams?: SearchParamsObject | undefined;
     /**
      * Filters that apply to every search made with the secured API key. Extra filters added at search time will be combined with `AND`. For example, if you set `group:admin` as fixed filter on your generated API key, and add `groups:visitors` to the search query, the complete set of filters will be `group:admin AND groups:visitors`.
      */
-    filters?: string;
+    filters?: string | undefined;
     /**
      * Timestamp when the secured API key expires, measured in seconds since the Unix epoch.
      */
-    validUntil?: number;
+    validUntil?: number | undefined;
     /**
      * 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?: Array<string>;
+    restrictIndices?: Array<string> | undefined;
     /**
      * 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.
      */
-    restrictSources?: string;
+    restrictSources?: string | undefined;
     /**
      * Pseudonymous user identifier to restrict usage of this API key to specific users.  By default, rate limits are set based on IP addresses. This can be an issue if many users search from the same IP address. To avoid this, add a user token to each generated API key.
      */
-    userToken?: string;
+    userToken?: string | undefined;
 };
 
 /**
@@ -2331,7 +2331,7 @@ type BrowseProps = {
      * Name of the index on which to perform the operation.
      */
     indexName: string;
-    browseParams?: BrowseParams;
+    browseParams?: BrowseParams | undefined;
 };
 /**
  * Properties for the `clearObjects` method.
@@ -2353,7 +2353,7 @@ type ClearRulesProps = {
     /**
      * Whether changes are applied to replica indices.
      */
-    forwardToReplicas?: boolean;
+    forwardToReplicas?: boolean | undefined;
 };
 /**
  * Properties for the `clearSynonyms` method.
@@ -2366,14 +2366,14 @@ type ClearSynonymsProps = {
     /**
      * Whether changes are applied to replica indices.
      */
-    forwardToReplicas?: boolean;
+    forwardToReplicas?: boolean | undefined;
 };
 /**
  * Properties for the `customDelete` method.
  */
 type CustomDeleteProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -2381,14 +2381,14 @@ type CustomDeleteProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
 };
 /**
  * Properties for the `customGet` method.
  */
 type CustomGetProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -2396,14 +2396,14 @@ type CustomGetProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
 };
 /**
  * Properties for the `customPost` method.
  */
 type CustomPostProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -2411,18 +2411,18 @@ type CustomPostProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
     /**
      * Parameters to send with the custom request.
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
 };
 /**
  * Properties for the `customPut` method.
  */
 type CustomPutProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -2430,11 +2430,11 @@ type CustomPutProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
     /**
      * Parameters to send with the custom request.
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
 };
 /**
  * Properties for the `deleteApiKey` method.
@@ -2492,7 +2492,7 @@ type DeleteRuleProps = {
     /**
      * Whether changes are applied to replica indices.
      */
-    forwardToReplicas?: boolean;
+    forwardToReplicas?: boolean | undefined;
 };
 /**
  * Properties for the `deleteSource` method.
@@ -2518,7 +2518,7 @@ type DeleteSynonymProps = {
     /**
      * Whether changes are applied to replica indices.
      */
-    forwardToReplicas?: boolean;
+    forwardToReplicas?: boolean | undefined;
 };
 /**
  * Properties for the `getApiKey` method.
@@ -2545,19 +2545,19 @@ type GetLogsProps = {
     /**
      * First log entry to retrieve. The most recent entries are listed first.
      */
-    offset?: number;
+    offset?: number | undefined;
     /**
      * Maximum number of entries to retrieve.
      */
-    length?: number;
+    length?: number | undefined;
     /**
      * Index for which to retrieve log entries. By default, log entries are retrieved for all indices.
      */
-    indexName?: string;
+    indexName?: string | undefined;
     /**
      * Type of log entries to retrieve. By default, all log entries are retrieved.
      */
-    type?: LogType;
+    type?: LogType | undefined;
 };
 /**
  * Properties for the `getObject` method.
@@ -2574,7 +2574,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?: Array<string>;
+    attributesToRetrieve?: Array<string> | undefined;
 };
 /**
  * Properties for the `getRule` method.
@@ -2640,7 +2640,7 @@ type HasPendingMappingsProps = {
     /**
      * Whether to include the cluster\'s pending mapping state in the response.
      */
-    getClusters?: boolean;
+    getClusters?: boolean | undefined;
 };
 /**
  * Properties for the `listIndices` method.
@@ -2649,11 +2649,11 @@ type ListIndicesProps = {
     /**
      * Requested page of the API response. If `null`, the API response is not paginated.
      */
-    page?: number;
+    page?: number | undefined;
     /**
      * Number of hits per page.
      */
-    hitsPerPage?: number;
+    hitsPerPage?: number | undefined;
 };
 /**
  * Properties for the `listUserIds` method.
@@ -2662,11 +2662,11 @@ type ListUserIdsProps = {
     /**
      * Requested page of the API response. If `null`, the API response is not paginated.
      */
-    page?: number;
+    page?: number | undefined;
     /**
      * Number of hits per page.
      */
-    hitsPerPage?: number;
+    hitsPerPage?: number | undefined;
 };
 /**
  * Properties for the `operationIndex` method.
@@ -2697,7 +2697,7 @@ type PartialUpdateObjectProps = {
     /**
      * Whether to create a new record if it doesn\'t exist.
      */
-    createIfNotExists?: boolean;
+    createIfNotExists?: boolean | undefined;
 };
 /**
  * Properties for the `removeUserId` method.
@@ -2755,7 +2755,7 @@ type SaveRuleProps = {
     /**
      * Whether changes are applied to replica indices.
      */
-    forwardToReplicas?: boolean;
+    forwardToReplicas?: boolean | undefined;
 };
 /**
  * Properties for the `saveRules` method.
@@ -2769,11 +2769,11 @@ type SaveRulesProps = {
     /**
      * Whether changes are applied to replica indices.
      */
-    forwardToReplicas?: boolean;
+    forwardToReplicas?: boolean | undefined;
     /**
      * Whether existing rules should be deleted before adding this batch.
      */
-    clearExistingRules?: boolean;
+    clearExistingRules?: boolean | undefined;
 };
 /**
  * Properties for the `saveSynonym` method.
@@ -2791,7 +2791,7 @@ type SaveSynonymProps = {
     /**
      * Whether changes are applied to replica indices.
      */
-    forwardToReplicas?: boolean;
+    forwardToReplicas?: boolean | undefined;
 };
 /**
  * Properties for the `saveSynonyms` method.
@@ -2805,11 +2805,11 @@ type SaveSynonymsProps = {
     /**
      * Whether changes are applied to replica indices.
      */
-    forwardToReplicas?: boolean;
+    forwardToReplicas?: boolean | undefined;
     /**
      * Whether to replace all synonyms in the index with the ones sent with this request.
      */
-    replaceExistingSynonyms?: boolean;
+    replaceExistingSynonyms?: boolean | undefined;
 };
 /**
  * In v4, the search parameters are wrapped in a `params` parameter.
@@ -2817,7 +2817,7 @@ type SaveSynonymsProps = {
  * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
  */
 type LegacySearchParams = {
-    params?: SearchParamsObject;
+    params?: SearchParamsObject | undefined;
 };
 /**
  * In v4, the search parameters are wrapped in a `params` parameter.
@@ -2860,7 +2860,7 @@ type SearchForFacetValuesProps = {
      * Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
      */
     facetName: string;
-    searchForFacetValuesRequest?: SearchForFacetValuesRequest;
+    searchForFacetValuesRequest?: SearchForFacetValuesRequest | undefined;
 };
 /**
  * Properties for the `searchRules` method.
@@ -2870,7 +2870,7 @@ type SearchRulesProps = {
      * Name of the index on which to perform the operation.
      */
     indexName: string;
-    searchRulesParams?: SearchRulesParams;
+    searchRulesParams?: SearchRulesParams | undefined;
 };
 /**
  * Properties for the `searchSingleIndex` method.
@@ -2880,7 +2880,7 @@ type SearchSingleIndexProps = {
      * Name of the index on which to perform the operation.
      */
     indexName: string;
-    searchParams?: SearchParams;
+    searchParams?: SearchParams | undefined;
 };
 /**
  * Properties for the `searchSynonyms` method.
@@ -2893,7 +2893,7 @@ type SearchSynonymsProps = {
     /**
      * Body of the `searchSynonyms` operation.
      */
-    searchSynonymsParams?: SearchSynonymsParams;
+    searchSynonymsParams?: SearchSynonymsParams | undefined;
 };
 /**
  * Properties for the `setSettings` method.
@@ -2907,7 +2907,7 @@ type SetSettingsProps = {
     /**
      * Whether changes are applied to replica indices.
      */
-    forwardToReplicas?: boolean;
+    forwardToReplicas?: boolean | undefined;
 };
 /**
  * Properties for the `updateApiKey` method.
@@ -2974,7 +2974,7 @@ type GenerateSecuredApiKeyOptions = {
     /**
      * A set of properties defining the restrictions of the secured API key.
      */
-    restrictions?: SecuredApiKeyRestrictions;
+    restrictions?: SecuredApiKeyRestrictions | undefined;
 };
 type GetSecuredApiKeyRemainingValidityOptions = {
     /**
@@ -2997,18 +2997,18 @@ type PartialUpdateObjectsOptions = Pick<ChunkedBatchOptions, 'indexName' | 'obje
     /**
      *To be provided if non-existing objects are passed, otherwise, the call will fail.
      */
-    createIfNotExists?: boolean;
+    createIfNotExists?: boolean | undefined;
 };
 type SaveObjectsOptions = Pick<ChunkedBatchOptions, 'indexName' | 'objects' | 'waitForTasks' | 'batchSize'>;
 type ChunkedBatchOptions = ReplaceAllObjectsOptions & {
     /**
      * The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.
      */
-    action?: Action;
+    action?: Action | undefined;
     /**
      * Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
      */
-    waitForTasks?: boolean;
+    waitForTasks?: boolean | undefined;
 };
 type ReplaceAllObjectsOptions = {
     /**
@@ -3022,11 +3022,11 @@ type ReplaceAllObjectsOptions = {
     /**
      * The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      */
-    batchSize?: number;
+    batchSize?: number | undefined;
     /**
      * The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
      */
-    scopes?: Array<ScopeType>;
+    scopes?: Array<ScopeType> | undefined;
 };
 type AccountCopyIndexOptions = {
     /**
@@ -3047,7 +3047,7 @@ type AccountCopyIndexOptions = {
     destinationIndexName: string;
 };
 
-declare const apiClientVersion = "5.27.0";
+declare const apiClientVersion = "5.29.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3072,7 +3072,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param segment - The algolia agent (user-agent) segment to add.
      * @param version - The version of the agent.
      */
-    addAlgoliaAgent(segment: string, version?: string): void;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
     /**
      * Helper method to switch the API key used to authenticate the requests.
      *
@@ -3093,7 +3093,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param waitForTaskOptions.timeout - The function to decide how long to wait between retries.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
      */
-    waitForTask({ indexName, taskID, maxRetries, timeout, }: WaitForTaskOptions, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
+    waitForTask({ indexName, taskID, maxRetries, timeout, }: WaitForTaskOptions, requestOptions?: RequestOptions | undefined): Promise<GetTaskResponse>;
     /**
      * Helper: Wait for an application-level task to complete for a given `taskID`.
      *
@@ -3104,7 +3104,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param waitForAppTaskOptions.timeout - The function to decide how long to wait between retries.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
      */
-    waitForAppTask({ taskID, maxRetries, timeout, }: WaitForAppTaskOptions, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
+    waitForAppTask({ taskID, maxRetries, timeout, }: WaitForAppTaskOptions, requestOptions?: RequestOptions | undefined): Promise<GetTaskResponse>;
     /**
      * Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
      *
@@ -3117,7 +3117,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param waitForApiKeyOptions.timeout - The function to decide how long to wait between retries.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getApikey` method and merged with the transporter requestOptions.
      */
-    waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: WaitForApiKeyOptions, requestOptions?: RequestOptions): Promise<GetApiKeyResponse | undefined>;
+    waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: WaitForApiKeyOptions, requestOptions?: RequestOptions | undefined): Promise<GetApiKeyResponse | undefined>;
     /**
      * Helper: Iterate on the `browse` method of the client to allow aggregating objects of an index.
      *
@@ -3129,7 +3129,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
      */
-    browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: BrowseOptions<BrowseResponse<T>> & BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T>>;
+    browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: BrowseOptions<BrowseResponse<T>> & BrowseProps, requestOptions?: RequestOptions | undefined): Promise<BrowseResponse<T>>;
     /**
      * Helper: Iterate on the `searchRules` method of the client to allow aggregating rules of an index.
      *
@@ -3141,7 +3141,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param browseRules.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchRules` method and merged with the transporter requestOptions.
      */
-    browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: BrowseOptions<SearchRulesResponse> & SearchRulesProps, requestOptions?: RequestOptions): Promise<SearchRulesResponse>;
+    browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: BrowseOptions<SearchRulesResponse> & SearchRulesProps, requestOptions?: RequestOptions | undefined): Promise<SearchRulesResponse>;
     /**
      * Helper: Iterate on the `searchSynonyms` method of the client to allow aggregating rules of an index.
      *
@@ -3153,7 +3153,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param browseSynonyms.searchSynonymsParams - The `searchSynonyms` method parameters.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchSynonyms` method and merged with the transporter requestOptions.
      */
-    browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: BrowseOptions<SearchSynonymsResponse> & SearchSynonymsProps, requestOptions?: RequestOptions): Promise<SearchSynonymsResponse>;
+    browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: BrowseOptions<SearchSynonymsResponse> & SearchSynonymsProps, requestOptions?: RequestOptions | undefined): Promise<SearchSynonymsResponse>;
     /**
      * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
      *
@@ -3178,7 +3178,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param saveObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
-    saveObjects({ indexName, objects, waitForTasks, batchSize }: SaveObjectsOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
+    saveObjects({ indexName, objects, waitForTasks, batchSize }: SaveObjectsOptions, requestOptions?: RequestOptions | undefined): Promise<BatchResponse[]>;
     /**
      * Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
      *
@@ -3190,7 +3190,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param deleteObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
-    deleteObjects({ indexName, objectIDs, waitForTasks, batchSize }: DeleteObjectsOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
+    deleteObjects({ indexName, objectIDs, waitForTasks, batchSize }: DeleteObjectsOptions, requestOptions?: RequestOptions | undefined): Promise<BatchResponse[]>;
     /**
      * Helper: Replaces object content of all the given objects according to their respective `objectID` field. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
      *
@@ -3203,7 +3203,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param partialUpdateObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
      */
-    partialUpdateObjects({ indexName, objects, createIfNotExists, waitForTasks, batchSize }: PartialUpdateObjectsOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
+    partialUpdateObjects({ indexName, objects, createIfNotExists, waitForTasks, batchSize }: PartialUpdateObjectsOptions, requestOptions?: RequestOptions | undefined): Promise<BatchResponse[]>;
     /**
      * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
@@ -3216,7 +3216,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param replaceAllObjects.scopes - The `scopes` to keep from the index. Defaults to ['settings', 'rules', 'synonyms'].
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
      */
-    replaceAllObjects({ indexName, objects, batchSize, scopes }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions): Promise<ReplaceAllObjectsResponse>;
+    replaceAllObjects({ indexName, objects, batchSize, scopes }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions | undefined): Promise<ReplaceAllObjectsResponse>;
     indexExists({ indexName }: GetSettingsProps): Promise<boolean>;
     /**
      * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
@@ -3226,7 +3226,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    searchForHits<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<{
+    searchForHits<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions | undefined): Promise<{
         results: Array<SearchResponse<T>>;
     }>;
     /**
@@ -3237,7 +3237,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
      * @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<{
+    searchForFacets(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions | undefined): Promise<{
         results: Array<SearchForFacetValuesResponse>;
     }>;
     /**
@@ -3361,7 +3361,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
     /**
      * This method lets you 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.path - Path of the endpoint, for example `1/newFeature`.
      * @param customDelete.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -3369,7 +3369,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
     /**
      * This method lets you 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.path - Path of the endpoint, for example `1/newFeature`.
      * @param customGet.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -3377,7 +3377,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
     /**
      * This method lets you 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.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPost.parameters - Query parameters to apply to the current query.
      * @param customPost.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3386,7 +3386,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
     /**
      * This method lets you 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.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPut.parameters - Query parameters to apply to the current query.
      * @param customPut.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3492,7 +3492,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *  - settings
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getDictionaryLanguages(requestOptions?: RequestOptions): Promise<{
+    getDictionaryLanguages(requestOptions?: RequestOptions | undefined): Promise<{
         [key: string]: Languages;
     }>;
     /**
@@ -3502,7 +3502,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *  - settings
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getDictionarySettings(requestOptions?: RequestOptions): Promise<GetDictionarySettingsResponse>;
+    getDictionarySettings(requestOptions?: RequestOptions | undefined): Promise<GetDictionarySettingsResponse>;
     /**
      * 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.
      *
@@ -3565,7 +3565,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *  - admin
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getSources(requestOptions?: RequestOptions): Promise<Array<Source>>;
+    getSources(requestOptions?: RequestOptions | undefined): Promise<Array<Source>>;
     /**
      * Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
      *
@@ -3597,7 +3597,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @deprecated
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getTopUserIds(requestOptions?: RequestOptions): Promise<GetTopUserIdsResponse>;
+    getTopUserIds(requestOptions?: RequestOptions | undefined): Promise<GetTopUserIdsResponse>;
     /**
      * 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.
      *
@@ -3629,7 +3629,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *  - admin
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listApiKeys(requestOptions?: RequestOptions): Promise<ListApiKeysResponse>;
+    listApiKeys(requestOptions?: RequestOptions | undefined): Promise<ListApiKeysResponse>;
     /**
      * Lists the available clusters in a multi-cluster setup.
      *
@@ -3639,7 +3639,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @deprecated
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listClusters(requestOptions?: RequestOptions): Promise<ListClustersResponse>;
+    listClusters(requestOptions?: RequestOptions | undefined): Promise<ListClustersResponse>;
     /**
      * Lists all indices in the current Algolia application.  The request follows any index restrictions of the API key you use to make the request.
      *
@@ -3920,7 +3920,7 @@ type AttributeToUpdate = string | BuiltInOperation;
  * Error.
  */
 type ErrorBase = Record<string, any> & {
-    message?: string;
+    message?: string | undefined;
 };
 
 type EventStatus = 'created' | 'started' | 'retried' | 'failed' | 'succeeded' | 'critical';
@@ -3947,7 +3947,7 @@ type Event = {
     batchSize: number;
     data?: {
         [key: string]: any;
-    } | null;
+    } | null | undefined;
     /**
      * Date of publish RFC 3339 format.
      */
@@ -3962,27 +3962,36 @@ type WatchResponse = {
     /**
      * Universally unique identifier (UUID) of an event.
      */
-    eventID?: string;
+    eventID?: string | undefined;
     /**
      * This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.
      */
-    data?: Array<Record<string, unknown>>;
+    data?: Array<Record<string, unknown>> | undefined;
     /**
      * in case of error, observability events will be added to the response.
      */
-    events?: Array<Event>;
+    events?: Array<Event> | undefined;
     /**
      * a message describing the outcome of the operation that has been ran (push, discover or validate) run.
      */
-    message?: string;
+    message?: string | undefined;
     /**
      * Date of creation in RFC 3339 format.
      */
-    createdAt?: string;
+    createdAt?: string | undefined;
+};
+
+type ReplaceAllObjectsWithTransformationResponse = {
+    copyOperationResponse: UpdatedAtResponse;
+    /**
+     * The response of the `push` request(s).
+     */
+    watchResponses: Array<WatchResponse>;
+    moveOperationResponse: UpdatedAtResponse;
 };
 
 type SearchClient = ReturnType<typeof createSearchClient> & SearchClientNodeHelpers;
 
-declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): SearchClient;
+declare function searchClient(appId: string, apiKey: string, options?: ClientOptions | undefined): SearchClient;
 
-export { type AccountCopyIndexOptions, 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 Event, type EventStatus, type EventType, 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 InsideBoundingBox, 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 OptionalWords, 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 UserHighlightResult, type UserHit, type UserId, type Value, type WaitForApiKeyOptions, type WaitForAppTaskOptions, type WaitForTaskOptions, type WatchResponse, type Widgets, type WithPrimary, apiClientVersion, searchClient };
+export { type AccountCopyIndexOptions, 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 Event, type EventStatus, type EventType, 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 InsideBoundingBox, 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 OptionalWords, 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 ReplaceAllObjectsWithTransformationResponse, 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 UserHighlightResult, type UserHit, type UserId, type Value, type WaitForApiKeyOptions, type WaitForAppTaskOptions, type WaitForTaskOptions, type WatchResponse, type Widgets, type WithPrimary, apiClientVersion, searchClient };