algoliasearch 5.0.0-alpha.99 → 5.0.0-beta.2

package/lite/model/matchLevel.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Indicates how well the attribute matched the search query.
+ * Whether the whole query string matches or only a part.
  */
 export type MatchLevel = 'full' | 'none' | 'partial';

package/lite/model/mode.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Search mode the index will use to query for results.
+ * Search mode the index will use to query for results.  This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
  */
 export type Mode = 'keywordSearch' | 'neuralSearch';

package/lite/model/numericFilters.ts

@@ -1,8 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { MixedSearchFilters } from './mixedSearchFilters';
-
 /**
- * [Filter on numeric attributes](https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/).
+ * Filter by numeric facets.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
  */
-export type NumericFilters = MixedSearchFilters[] | string;
+export type NumericFilters = NumericFilters[] | string;

package/lite/model/operationType.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Operation to perform (_move_ or _copy_).
+ * Operation to perform on the index.
  */
 export type OperationType = 'copy' | 'move';

package/lite/model/optionalFilters.ts

@@ -1,8 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { MixedSearchFilters } from './mixedSearchFilters';
-
 /**
- * Create filters to boost or demote records.   Records that match the filter are ranked higher for positive and lower for negative optional filters. In contrast to regular filters, records that don\'t match the optional filter are still included in the results, only their ranking is affected.
+ * Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.  - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
  */
-export type OptionalFilters = MixedSearchFilters[] | string;
+export type OptionalFilters = OptionalFilters[] | string;

package/lite/model/params.ts

@@ -5,7 +5,7 @@ import type { ConsequenceQuery } from './consequenceQuery';
 import type { RenderingContent } from './renderingContent';
 
 /**
- * Additional search parameters.
+ * Parameters to apply to this search.  You can use all search parameters, plus special `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`.
  */
 export type Params = {
   query?: ConsequenceQuery;

package/lite/model/promoteObjectID.ts

@@ -5,12 +5,12 @@
  */
 export type PromoteObjectID = {
   /**
-   * Unique identifier of the record to promote.
+   * Unique record identifier.
    */
   objectID: string;
 
   /**
-   * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
+   * Position in the search results where you want to show the promoted records.
    */
   position: number;
 };

package/lite/model/promoteObjectIDs.ts

@@ -5,12 +5,12 @@
  */
 export type PromoteObjectIDs = {
   /**
-   * Unique identifiers of the records to promote.
+   * Object IDs of the records you want to promote.  The records are placed as a group at the `position`. For example, if you want to promote four records to position `0`, they will be the first four search results.
    */
   objectIDs: string[];
 
   /**
-   * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
+   * Position in the search results where you want to show the promoted records.
    */
   position: number;
 };

package/lite/model/queryType.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Determines how query words are [interpreted as prefixes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
+ * Determines if and how query words are interpreted as prefixes.  By default, only the last query word is treated as prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower.  For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
  */
 export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';

package/lite/model/rankingInfo.ts

@@ -3,14 +3,17 @@
 import type { MatchedGeoLocation } from './matchedGeoLocation';
 import type { Personalization } from './personalization';
 
+/**
+ * Object with detailed information about the record\'s ranking.
+ */
 export type RankingInfo = {
   /**
-   * This field is reserved for advanced usage.
+   * Whether a filter matched the query.
    */
   filters: number;
 
   /**
-   * Position of the most important matched attribute in the attributes to index list.
+   * Position of the first matched word in the best matching attribute of the record.
    */
   firstMatchedWord: number;
 
@@ -39,27 +42,27 @@ export type RankingInfo = {
   nbTypos: number;
 
   /**
-   * Present and set to true if a Rule promoted the hit.
+   * Whether the record was promoted by a rule.
    */
   promoted: boolean;
 
   /**
-   * When the query contains more than one word, the sum of the distances between matched words (in meters).
+   * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
    */
   proximityDistance?: number;
 
   /**
-   * Custom ranking for the object, expressed as a single integer value.
+   * Overall ranking of the record, expressed as a single integer. This attribute is internal.
    */
   userScore: number;
 
   /**
-   * Number of matched words, including prefixes and typos.
+   * Number of matched words.
    */
   words: number;
 
   /**
-   * Wether the record are promoted by the re-ranking strategy.
+   * Whether the record is re-ranked.
    */
   promotedByReRanking?: boolean;
 };

package/lite/model/reRankingApplyFilter.ts

@@ -1,8 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { MixedSearchFilters } from './mixedSearchFilters';
-
 /**
- * When [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) is enabled, only records that match these filters will be affected by Dynamic Re-Ranking.
+ * Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
  */
-export type ReRankingApplyFilter = MixedSearchFilters[] | string;
+export type ReRankingApplyFilter = ReRankingApplyFilter[] | string;

package/lite/model/removeStopWords.ts

@@ -1,6 +1,8 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+import type { SupportedLanguage } from './supportedLanguage';
+
 /**
- * Removes stop (common) words from the query before executing it. `removeStopWords` is used in conjunction with the `queryLanguages` setting. _list_: language ISO codes for which stop words should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the stop words feature, ensuring that stop words are removed from consideration in a search. The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the stop words feature, allowing stop words to be taken into account in a search.
+ * Removes stop words from the search query.  Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words.  You should only use this feature for the languages used in your index.
  */
-export type RemoveStopWords = string[] | boolean;
+export type RemoveStopWords = SupportedLanguage[] | boolean;

package/lite/model/removeWordsIfNoResults.ts

@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Strategy to [remove words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/) from the query when it doesn\'t match any hits.
+ * Strategy for removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results.  - `none`.   No words are removed when a query doesn\'t return results.  - `lastWords`.   Treat the last (then second to last, then third to last) word as optional,   until there are results or at most 5 words have been removed.  - `firstWords`.   Treat the first (then second, then third) word as optional,   until there are results or at most 5 words have been removed.  - `allOptional`.   Treat all words as optional.  For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
  */
 export type RemoveWordsIfNoResults =
   | 'allOptional'

package/lite/model/renderingContent.ts

@@ -3,7 +3,7 @@
 import type { FacetOrdering } from './facetOrdering';
 
 /**
- * Extra content for the search UI, for example, to control the [ordering and display of facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor). You can set a default value and dynamically override it with [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/).
+ * Extra data that can be used in the search UI.  You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.
  */
 export type RenderingContent = {
   facetOrdering?: FacetOrdering;

package/lite/model/rule.ts

@@ -9,29 +9,29 @@ import type { TimeRange } from './timeRange';
  */
 export type Rule = {
   /**
-   * Unique identifier for a rule object.
+   * Unique identifier of a rule object.
    */
   objectID: string;
 
   /**
-   * [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions) required to activate a rule. You can use up to 25 conditions per 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?: Condition[];
 
   consequence?: Consequence;
 
   /**
-   * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
+   * Description of the rule\'s purpose to help you distinguish between different rules.
    */
   description?: string;
 
   /**
-   * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
+   * Whether the rule is active.
    */
   enabled?: boolean;
 
   /**
-   * If you specify a validity period, the rule _only_ applies only during that period. If specified, the array must not be empty.
+   * Time periods when the rule is active.
    */
   validity?: TimeRange[];
 };

package/lite/model/searchDictionaryEntriesResponse.ts

@@ -0,0 +1,25 @@
+// 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 { DictionaryEntry } from './dictionaryEntry';
+
+export type SearchDictionaryEntriesResponse = {
+  /**
+   * Dictionary entries matching the search criteria.
+   */
+  hits: DictionaryEntry[];
+
+  /**
+   * Requested page of the API response.
+   */
+  page: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits: number;
+
+  /**
+   * Number of pages of results.
+   */
+  nbPages: number;
+};

package/lite/model/searchForFacetValuesResponse.ts

@@ -3,10 +3,13 @@
 import type { FacetHits } from './facetHits';
 
 export type SearchForFacetValuesResponse = {
+  /**
+   * Matching facet values.
+   */
   facetHits: FacetHits[];
 
   /**
-   * See the `facetsCount` field of the `exhaustive` object in the response.
+   * Whether the facet count is exhaustive (true) or approximate (false). For more information, see [Why are my facet and hit counts not accurate](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
    */
   exhaustiveFacetsCount: boolean;
 

package/lite/model/searchForFacetsOptions.ts

@@ -9,7 +9,7 @@ export type SearchForFacetsOptions = {
   facet: string;
 
   /**
-   * Algolia index name.
+   * Index name (case-sensitive).
    */
   indexName: string;
 
@@ -19,7 +19,7 @@ export type SearchForFacetsOptions = {
   facetQuery?: string;
 
   /**
-   * Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+   * 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;
 

package/lite/model/searchForHitsOptions.ts

@@ -4,7 +4,7 @@ import type { SearchTypeDefault } from './searchTypeDefault';
 
 export type SearchForHitsOptions = {
   /**
-   * Algolia index name.
+   * Index name (case-sensitive).
    */
   indexName: string;
 

package/lite/model/searchHits.ts

@@ -3,15 +3,18 @@
 import type { Hit } from './hit';
 
 export type SearchHits<T = Record<string, any>> = Record<string, any> & {
+  /**
+   * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
+   */
   hits: Array<Hit<T>>;
 
   /**
-   * Text to search for in an index.
+   * Search query.
    */
-  query: T;
+  query: string;
 
   /**
    * URL-encoded string of all search parameters.
    */
-  params: T;
+  params: string;
 };

package/lite/model/searchParamsObject.ts

@@ -3,4 +3,7 @@
 import type { BaseSearchParams } from './baseSearchParams';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
 
+/**
+ * Each parameter value, including the `query` must not be larger than 512 bytes.
+ */
 export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;

package/lite/model/searchParamsQuery.ts

@@ -2,7 +2,7 @@
 
 export type SearchParamsQuery = {
   /**
-   * Text to search for in an index.
+   * Search query.
    */
   query?: string;
 };

package/lite/model/searchStrategy.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * - `none`: executes all queries. - `stopIfEnoughMatches`: executes queries one by one, stopping further query execution as soon as a query matches at least the `hitsPerPage` number of results.
+ * Strategy for multiple search queries:  - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results.
  */
 export type SearchStrategy = 'none' | 'stopIfEnoughMatches';

package/lite/model/searchSynonymsResponse.ts

@@ -4,12 +4,12 @@ import type { SynonymHit } from './synonymHit';
 
 export type SearchSynonymsResponse = Record<string, any> & {
   /**
-   * Synonym objects.
+   * Matching synonyms.
    */
   hits: SynonymHit[];
 
   /**
-   * Number of hits the search query matched.
+   * Number of results (hits).
    */
   nbHits: number;
 };

package/lite/model/securedAPIKeyRestrictions.ts

@@ -0,0 +1,32 @@
+// 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 { SearchParamsObject } from './searchParamsObject';
+
+export type SecuredAPIKeyRestrictions = {
+  searchParams?: SearchParamsObject;
+
+  /**
+   * 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;
+
+  /**
+   * Timestamp when the secured API key expires, measured in seconds since the Unix epoch.
+   */
+  validUntil?: number;
+
+  /**
+   * Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
+   */
+  restrictIndices?: string[];
+
+  /**
+   * 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;
+
+  /**
+   * 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;
+};

package/lite/model/semanticSearch.ts

@@ -1,11 +1,11 @@
 // 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.
 
 /**
- * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
  */
 export type SemanticSearch = {
   /**
-   * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
+   * Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
    */
   eventSources?: string[] | null;
 };

package/lite/model/snippetResult.ts

@@ -4,4 +4,5 @@ import type { SnippetResultOption } from './snippetResultOption';
 
 export type SnippetResult =
   | Record<string, SnippetResultOption>
-  | SnippetResultOption;
+  | SnippetResultOption
+  | SnippetResultOption[];

package/lite/model/snippetResultOption.ts

@@ -3,11 +3,11 @@
 import type { MatchLevel } from './matchLevel';
 
 /**
- * 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.
  */
 export type SnippetResultOption = {
   /**
-   * Markup text with `facetQuery` matches highlighted.
+   * Highlighted attribute value, including HTML tags.
    */
   value: string;
 

package/lite/model/sortRemainingBy.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ * Order of facet values that aren\'t explicitly positioned with the `order` setting.  - `count`.   Order remaining facet values by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Sort facet values alphabetically.  - `hidden`.   Don\'t show facet values that aren\'t explicitly positioned.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';

package/lite/model/supportedLanguage.ts

@@ -0,0 +1,74 @@
+// 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.
+
+/**
+ * ISO code for a supported language.
+ */
+export type SupportedLanguage =
+  | 'af'
+  | 'ar'
+  | 'az'
+  | 'bg'
+  | 'bn'
+  | 'ca'
+  | 'cs'
+  | 'cy'
+  | 'da'
+  | 'de'
+  | 'el'
+  | 'en'
+  | 'eo'
+  | 'es'
+  | 'et'
+  | 'eu'
+  | 'fa'
+  | 'fi'
+  | 'fo'
+  | 'fr'
+  | 'ga'
+  | 'gl'
+  | 'he'
+  | 'hi'
+  | 'hu'
+  | 'hy'
+  | 'id'
+  | 'is'
+  | 'it'
+  | 'ja'
+  | 'ka'
+  | 'kk'
+  | 'ko'
+  | 'ku'
+  | 'ky'
+  | 'lt'
+  | 'lv'
+  | 'mi'
+  | 'mn'
+  | 'mr'
+  | 'ms'
+  | 'mt'
+  | 'nb'
+  | 'nl'
+  | 'no'
+  | 'ns'
+  | 'pl'
+  | 'ps'
+  | 'pt-br'
+  | 'pt'
+  | 'qu'
+  | 'ro'
+  | 'ru'
+  | 'sk'
+  | 'sq'
+  | 'sv'
+  | 'sw'
+  | 'ta'
+  | 'te'
+  | 'th'
+  | 'tl'
+  | 'tn'
+  | 'tr'
+  | 'tt'
+  | 'uk'
+  | 'ur'
+  | 'uz'
+  | 'zh';

package/lite/model/tagFilters.ts

@@ -1,8 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { MixedSearchFilters } from './mixedSearchFilters';
-
 /**
- * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
+ * Filter the search by values of the special `_tags` attribute.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won\'t get a facet count. The same combination and escaping rules apply as for `facetFilters`.
  */
-export type TagFilters = MixedSearchFilters[] | string;
+export type TagFilters = TagFilters[] | string;

package/lite/model/taskStatus.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * _published_ if the task has been processed, _notPublished_ otherwise.
+ * Task status, `published` if the task is completed, `notPublished` otherwise.
  */
 export type TaskStatus = 'notPublished' | 'published';

package/lite/model/timeRange.ts

@@ -2,12 +2,12 @@
 
 export type TimeRange = {
   /**
-   * Lower bound of the time range (Unix timestamp).
+   * When the rule should start to be active, in Unix epoch time.
    */
   from: number;
 
   /**
-   * Upper bound of the time range (Unix timestamp).
+   * When the rule should stop to be active, in Unix epoch time.
    */
   until: number;
 };

package/lite/model/typoTolerance.ts

@@ -3,6 +3,6 @@
 import type { TypoToleranceEnum } from './typoToleranceEnum';
 
 /**
- * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
+ * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
  */
 export type TypoTolerance = TypoToleranceEnum | boolean;

package/lite/model/typoToleranceEnum.ts

@@ -1,3 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+/**
+ * - `min`. Return matches with the lowest number of typos.   For example, if you have matches without typos, only include those.   But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos.   With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
+ */
 export type TypoToleranceEnum = 'min' | 'strict';

package/lite/model/updatedRuleResponse.ts

@@ -2,17 +2,17 @@
 
 export type UpdatedRuleResponse = {
   /**
-   * Unique object identifier.
+   * Unique identifier of a rule object.
    */
   objectID: string;
 
   /**
-   * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time when the object was updated, in RFC 3339 format.
    */
   updatedAt: string;
 
   /**
-   * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
+   * 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;
 };

package/lite/model/userId.ts

@@ -5,7 +5,7 @@
  */
 export type UserId = {
   /**
-   * UserID of the user.
+   * Unique identifier of the user who makes the search request.
    */
   userID: string;