algoliasearch 5.0.0-alpha.11 → 5.0.0-alpha.110

package/lite/model/consequence.ts

@@ -1,32 +1,32 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { ConsequenceHide } from './consequenceHide';
 import type { ConsequenceParams } from './consequenceParams';
 import type { Promote } from './promote';
 
 /**
- * Consequence of the Rule.
+ * Effect of the rule.  For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).
  */
 export type Consequence = {
   params?: ConsequenceParams;
 
   /**
-   * Objects to promote as hits.
+   * Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either individually, or as groups of up to 100 records each.
    */
   promote?: Promote[];
 
   /**
-   * Only use in combination with the promote consequence. When true, promoted results will be restricted to match the filters of the current search. When false, the promoted results will show up regardless of the filters.
+   * 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;
 
   /**
-   * Objects to hide from hits. Each object must contain an objectID field. By default, you can hide up to 50 items per rule.
+   * Records you want to hide from the search results.
    */
   hide?: ConsequenceHide[];
 
   /**
-   * Custom JSON object that will be appended to the userData array in the response. This object isn\'t interpreted by the API. It\'s limited to 1kB of minified JSON.
+   * 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 kB of minified JSON.
    */
-  userData?: Record<string, any>;
+  userData?: any | null;
 };

package/lite/model/consequenceHide.ts

@@ -1,11 +1,11 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Unique identifier of the object to hide.
+ * Object ID of the record to hide.
  */
 export type ConsequenceHide = {
   /**
-   * Unique identifier of the object.
+   * Unique record identifier.
    */
   objectID: string;
 };

package/lite/model/consequenceParams.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';

package/lite/model/consequenceQuery.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { ConsequenceQueryObject } from './consequenceQueryObject';
 
 /**
- * When providing a string, it replaces the entire query string. When providing an object, it describes incremental edits to be made to the query string (but you can\'t do both).
+ * Replace or edit the search query.  If `consequenceQuery` is a string, the entire search query is replaced with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query.
  */
 export type ConsequenceQuery = ConsequenceQueryObject | string;

package/lite/model/consequenceQueryObject.ts

@@ -1,15 +1,15 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { Edit } from './edit';
 
 export type ConsequenceQueryObject = {
   /**
-   * Words to remove.
+   * Words to remove from the search query.
    */
   remove?: string[];
 
   /**
-   * Edits to apply.
+   * Changes to make to the search query.
    */
   edits?: Edit[];
 };

package/lite/model/cursor.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export type Cursor = {
   /**
-   * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
+   * 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;
 };

package/lite/model/deleteByParams.ts

@@ -0,0 +1,36 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { AroundRadius } from './aroundRadius';
+import type { FacetFilters } from './facetFilters';
+import type { NumericFilters } from './numericFilters';
+import type { TagFilters } from './tagFilters';
+
+export type DeleteByParams = {
+  facetFilters?: FacetFilters;
+
+  /**
+   * Filter the search so that only records with matching values are included in the results.  These filters are supported:  - **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;
+
+  /**
+   * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.  Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
+   */
+  aroundLatLng?: string;
+
+  aroundRadius?: AroundRadius;
+
+  /**
+   * Coordinates for a rectangular area in which to search.  Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
+   */
+  insideBoundingBox?: number[][];
+
+  /**
+   * Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored, if you also specify `insideBoundingBox`.
+   */
+  insidePolygon?: number[][];
+};

package/lite/model/dictionaryAction.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
  * Actions to perform.

package/lite/model/dictionaryEntry.ts

@@ -1,33 +1,31 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { DictionaryEntryState } from './dictionaryEntryState';
+import type { SupportedLanguage } from './supportedLanguage';
 
 /**
- * A dictionary entry.
+ * Dictionary entry.
  */
 export type DictionaryEntry = Record<string, any> & {
   /**
-   * Unique identifier of the object.
+   * Unique identifier for the dictionary entry.
    */
   objectID: string;
 
-  /**
-   * Language ISO code supported by the dictionary (e.g., \"en\" for English).
-   */
-  language: string;
+  language: SupportedLanguage;
 
   /**
-   * The word of the dictionary entry.
+   * Matching dictionary word for `stopwords` and `compounds` dictionaries.
    */
   word?: string;
 
   /**
-   * The words of the dictionary entry.
+   * Matching words in the `plurals` dictionary including declensions.
    */
   words?: string[];
 
   /**
-   * A decomposition of the word of the dictionary entry.
+   * Invividual components of a compound word in the `compounds` dictionary.
    */
   decomposition?: string[];
 

package/lite/model/dictionaryEntryState.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * The state of the dictionary entry.
+ * Whether a dictionary entry is active.
  */
 export type DictionaryEntryState = 'disabled' | 'enabled';

package/lite/model/dictionaryLanguage.ts

@@ -1,11 +1,11 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Custom entries for a dictionary.
+ * Dictionary type. If `null`, this dictionary type isn\'t supported for the language.
  */
 export type DictionaryLanguage = {
   /**
-   * When nbCustomEntries is set to 0, the user didn\'t customize the dictionary. The dictionary is still supported with standard, Algolia-provided entries.
+   * Number of custom dictionary entries.
    */
-  nbCustomEntires?: number;
+  nbCustomEntries?: number;
 };

package/lite/model/dictionaryType.ts

@@ -1,3 +1,3 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export type DictionaryType = 'compounds' | 'plurals' | 'stopwords';

package/lite/model/distinct.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Enables de-duplication or grouping of results.
+ * Determines how many records of a group are included in the search results.  Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).  The `distinct` setting is ignored if `attributeForDistinct` is not set.
  */
 export type Distinct = boolean | number;

package/lite/model/edit.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { EditType } from './editType';
 
@@ -11,7 +11,7 @@ export type Edit = {
   delete?: string;
 
   /**
-   * Text that should be inserted in place of the removed text inside the query string.
+   * Text to be added in place of the deleted text inside the query string.
    */
   insert?: string;
 };

package/lite/model/editType.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
  * Type of edit.

package/lite/model/errorBase.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
  * Error.

package/lite/model/exactOnSingleWordQuery.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Controls how the exact ranking criterion is computed when the query contains only one word.
+ * Determines how 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) is computed when the search query has only one word.  <dl> <dt><code>attribute</code></dt> <dd> The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". </dd> <dt><code>none</code></dt> <dd> The Exact ranking criterion is ignored on single-word searches. </dd> <dt><code>word</code></dt> <dd> The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. </dd> </dl>  If `exactOnSingleWordQuery` is `word`, only exact matches will be highlighted, partial and prefix matches won\'t.
  */
 export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';

package/lite/model/exhaustive.ts

@@ -0,0 +1,31 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
+ */
+export 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;
+
+  /**
+   * The value is `false` if not all facet values are retrieved.
+   */
+  facetValues?: boolean;
+
+  /**
+   * 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;
+
+  /**
+   * 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;
+
+  /**
+   * 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;
+};

package/lite/model/facetFilters.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { MixedSearchFilters } from './mixedSearchFilters';
 
 /**
- * Filter hits by facet value.
+ * Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
  */
 export type FacetFilters = MixedSearchFilters[] | string;

package/lite/model/facetHits.ts

@@ -0,0 +1,18 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type FacetHits = {
+  /**
+   * Facet value.
+   */
+  value: string;
+
+  /**
+   * Highlighted attribute value, including HTML tags.
+   */
+  highlighted: string;
+
+  /**
+   * Number of records with this facet value. [The count may be approximated](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+   */
+  count: number;
+};

package/lite/model/facetOrdering.ts

@@ -1,16 +1,16 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { Facets } from './facets';
 import type { Value } from './value';
 
 /**
- * Defining how facets should be ordered.
+ * Order of facet names and facet values in your UI.
  */
 export type FacetOrdering = {
   facets?: Facets;
 
   /**
-   * The ordering of facet values, within an individual list.
+   * Order of facet values. One object for each facet.
    */
   values?: Record<string, Value>;
 };

package/lite/model/facets.ts

@@ -1,11 +1,11 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * The ordering of facets (widgets).
+ * Order of facet names.
  */
 export type Facets = {
   /**
-   * Pinned order of facet lists.
+   * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
    */
   order?: string[];
 };

package/lite/model/facetsStats.ts

@@ -1,23 +1,23 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export type FacetsStats = {
   /**
-   * The minimum value in the result set.
+   * Minimum value in the results.
    */
   min?: number;
 
   /**
-   * The maximum value in the result set.
+   * Maximum value in the results.
    */
   max?: number;
 
   /**
-   * The average facet value in the result set.
+   * Average facet value in the results.
    */
   avg?: number;
 
   /**
-   * The sum of all values in the result set.
+   * Sum of all values in the results.
    */
   sum?: number;
 };

package/lite/model/fetchedIndex.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export type FetchedIndex = {
   /**
@@ -12,7 +12,7 @@ export type FetchedIndex = {
   createdAt: string;
 
   /**
-   * Date of last update (ISO-8601 format).
+   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   updatedAt: string;
 
@@ -39,7 +39,7 @@ export type FetchedIndex = {
   /**
    * Number of pending indexing operations. This value is deprecated and should not be used.
    */
-  numberOfPendingTask?: number;
+  numberOfPendingTasks: number;
 
   /**
    * A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.

package/lite/model/getApiKeyResponse.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { ApiKey } from './apiKey';
 import type { BaseGetApiKeyResponse } from './baseGetApiKeyResponse';

package/lite/model/highlightResult.ts

@@ -1,5 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { HighlightResultOption } from './highlightResultOption';
 
-export type HighlightResult = HighlightResultOption | HighlightResultOption[];
+export type HighlightResult =
+  | HighlightResultOption
+  | HighlightResultOption[]
+  | Record<string, HighlightResultOption>;

package/lite/model/highlightResultOption.ts

@@ -1,20 +1,20 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { MatchLevel } from './matchLevel';
 
 /**
- * Show highlighted section and words matched on a query.
+ * Surround words that match the query with HTML tags for highlighting.
  */
 export type HighlightResultOption = {
   /**
-   * Markup text with occurrences highlighted.
+   * Highlighted attribute value, including HTML tags.
    */
   value: string;
 
   matchLevel: MatchLevel;
 
   /**
-   * List of words from the query that matched the object.
+   * List of matched words from the search query.
    */
   matchedWords: string[];
 

package/lite/model/hit.ts

@@ -1,25 +1,25 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { HighlightResult } from './highlightResult';
 import type { RankingInfo } from './rankingInfo';
 import type { SnippetResult } from './snippetResult';
 
 /**
- * A single hit.
+ * Search result.  A hit is a record from your index, augmented with special attributes for highlighting, snippeting, and ranking.
  */
 export type Hit<T = Record<string, any>> = T & {
   /**
-   * Unique identifier of the object.
+   * Unique record identifier.
    */
   objectID: string;
 
   /**
-   * Show highlighted section and words matched on a query.
+   * Surround words that match the query with HTML tags for highlighting.
    */
   _highlightResult?: Record<string, HighlightResult>;
 
   /**
-   * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+   * Snippets that show the context around a matching search query.
    */
   _snippetResult?: Record<string, SnippetResult>;
 

package/lite/model/ignorePlurals.ts

@@ -1,6 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { SupportedLanguage } from './supportedLanguage';
 
 /**
- * Treats singular, plurals, and other forms of declensions as matching terms. IgnorePlurals is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. False: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).
+ * Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.
  */
-export type IgnorePlurals = string[] | boolean;
+export type IgnorePlurals = SupportedLanguage[] | boolean;

package/lite/model/index.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export * from './acl';
 export * from './action';
@@ -7,6 +7,9 @@ export * from './advancedSyntaxFeatures';
 export * from './alternativesAsExact';
 export * from './anchoring';
 export * from './apiKey';
+export * from './apiKeyOperation';
+export * from './aroundPrecision';
+export * from './aroundPrecisionFromValueInner';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
 export * from './attributeToUpdate';
@@ -29,6 +32,7 @@ export * from './consequenceParams';
 export * from './consequenceQuery';
 export * from './consequenceQueryObject';
 export * from './cursor';
+export * from './deleteByParams';
 export * from './dictionaryAction';
 export * from './dictionaryEntry';
 export * from './dictionaryEntryState';
@@ -39,7 +43,9 @@ export * from './edit';
 export * from './editType';
 export * from './errorBase';
 export * from './exactOnSingleWordQuery';
+export * from './exhaustive';
 export * from './facetFilters';
+export * from './facetHits';
 export * from './facetOrdering';
 export * from './facets';
 export * from './facetsStats';
@@ -57,6 +63,7 @@ export * from './logType';
 export * from './matchLevel';
 export * from './matchedGeoLocation';
 export * from './mixedSearchFilters';
+export * from './mode';
 export * from './numericFilters';
 export * from './operationType';
 export * from './optionalFilters';
@@ -68,11 +75,16 @@ export * from './promoteObjectIDs';
 export * from './queryType';
 export * from './rankingInfo';
 export * from './reRankingApplyFilter';
+export * from './redirect';
+export * from './redirectRuleIndexMetadata';
+export * from './redirectRuleIndexMetadataData';
 export * from './removeStopWords';
 export * from './removeWordsIfNoResults';
 export * from './renderingContent';
 export * from './rule';
 export * from './scopeType';
+export * from './searchDictionaryEntriesResponse';
+export * from './searchForFacetValuesResponse';
 export * from './searchForFacets';
 export * from './searchForFacetsOptions';
 export * from './searchForHits';
@@ -86,17 +98,20 @@ export * from './searchParamsString';
 export * from './searchQuery';
 export * from './searchResponse';
 export * from './searchResponses';
+export * from './searchResult';
 export * from './searchStrategy';
 export * from './searchSynonymsResponse';
 export * from './searchTypeDefault';
 export * from './searchTypeFacet';
+export * from './securedAPIKeyRestrictions';
+export * from './semanticSearch';
 export * from './snippetResult';
 export * from './snippetResultOption';
 export * from './sortRemainingBy';
 export * from './source';
 export * from './standardEntries';
+export * from './supportedLanguage';
 export * from './synonymHit';
-export * from './synonymHitHighlightResult';
 export * from './synonymType';
 export * from './tagFilters';
 export * from './taskStatus';