algoliasearch 5.0.0-alpha.73 → 5.0.0-alpha.75

package/dist/lite/model/listIndicesResponse.d.ts

@@ -1,7 +1,7 @@
 import type { FetchedIndex } from './fetchedIndex';
 export type ListIndicesResponse = {
     /**
-     * List of the fetched indices.
+     * All indices in your Algolia application.
      */
     items: FetchedIndex[];
     /**

package/dist/lite/model/mode.d.ts

@@ -1,5 +1,5 @@
 /**
- * The search mode that the index will use to query for results.
+ * Search mode the index will use to query for results.
  */
 export type Mode = 'keywordSearch' | 'neuralSearch';
 //# sourceMappingURL=mode.d.ts.map

package/dist/lite/model/numericFilters.d.ts

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * Filter on numeric attributes.
+ * [Filter on numeric attributes](https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/).
  */
 export type NumericFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=numericFilters.d.ts.map

package/dist/lite/model/operationType.d.ts

@@ -1,5 +1,5 @@
 /**
- * Type of operation to perform (move or copy).
+ * Operation to perform (_move_ or _copy_).
  */
 export type OperationType = 'copy' | 'move';
 //# sourceMappingURL=operationType.d.ts.map

package/dist/lite/model/optionalFilters.d.ts

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.
+ * 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.
  */
 export type OptionalFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=optionalFilters.d.ts.map

package/dist/lite/model/params.d.ts

@@ -2,7 +2,7 @@ import type { AutomaticFacetFilters } from './automaticFacetFilters';
 import type { ConsequenceQuery } from './consequenceQuery';
 import type { RenderingContent } from './renderingContent';
 /**
- * Additional search parameters. Any valid search parameter is allowed.
+ * Additional search parameters.
  */
 export type Params = {
     query?: ConsequenceQuery;

package/dist/lite/model/promoteObjectID.d.ts

@@ -1,13 +1,13 @@
 /**
- * Single objectID to promote as hits.
+ * Record to promote.
  */
 export type PromoteObjectID = {
     /**
-     * Unique identifier of the object to promote.
+     * Unique identifier of the record to promote.
      */
     objectID: string;
     /**
-     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+     * 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: number;
 };

package/dist/lite/model/promoteObjectIDs.d.ts

@@ -1,13 +1,13 @@
 /**
- * Multiple objectIDs to promote as hits.
+ * Records to promote.
  */
 export type PromoteObjectIDs = {
     /**
-     * Array of unique identifiers of the objects to promote.
+     * Unique identifiers of the records to promote.
      */
     objectIDs: string[];
     /**
-     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+     * 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: number;
 };

package/dist/lite/model/queryType.d.ts

@@ -1,5 +1,5 @@
 /**
- * Controls if and how query words are interpreted as prefixes.
+ * 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/).
  */
 export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
 //# sourceMappingURL=queryType.d.ts.map

package/dist/lite/model/reRankingApplyFilter.d.ts

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+ * 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.
  */
 export type ReRankingApplyFilter = MixedSearchFilters[] | string;
 //# sourceMappingURL=reRankingApplyFilter.d.ts.map

package/dist/lite/model/redirectRuleIndexMetadata.d.ts

@@ -13,7 +13,7 @@ export type RedirectRuleIndexMetadata = {
      */
     reason: string;
     /**
-     * Status for the redirect rule.
+     * Redirect rule status.
      */
     succeed: boolean;
     data: RedirectRuleIndexMetadataData;

package/dist/lite/model/redirectRuleIndexMetadataData.d.ts

@@ -1,5 +1,5 @@
 /**
- * Data for the redirect rule.
+ * Redirect rule data.
  */
 export type RedirectRuleIndexMetadataData = {
     ruleObjectID: string;

package/dist/lite/model/removeStopWords.d.ts

@@ -1,5 +1,5 @@
 /**
- * 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 ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
+ * 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.
  */
 export type RemoveStopWords = string[] | boolean;
 //# sourceMappingURL=removeStopWords.d.ts.map

package/dist/lite/model/removeWordsIfNoResults.d.ts

@@ -1,5 +1,5 @@
 /**
- * Selects a strategy to remove words from the query when it doesn\'t match any hits.
+ * 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.
  */
 export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
 //# sourceMappingURL=removeWordsIfNoResults.d.ts.map

package/dist/lite/model/renderingContent.d.ts

@@ -1,6 +1,6 @@
 import type { FacetOrdering } from './facetOrdering';
 /**
- * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
+ * 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/).
  */
 export type RenderingContent = {
     facetOrdering?: FacetOrdering;

package/dist/lite/model/rule.d.ts

@@ -6,24 +6,24 @@ import type { TimeRange } from './timeRange';
  */
 export type Rule = {
     /**
-     * Unique identifier of the object.
+     * Unique identifier for a rule object.
      */
     objectID: string;
     /**
-     * A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.
+     * [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?: Condition[];
     consequence?: Consequence;
     /**
-     * This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It\'s not interpreted by the API.
+     * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
      */
     description?: string;
     /**
-     * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
+     * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
      */
     enabled?: boolean;
     /**
-     * By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it\'s ignored the rest of the time. The list must not be empty.
+     * If you specify a validity period, the rule _only_ applies only during that period. If specified, the array must not be empty.
      */
     validity?: TimeRange[];
 };

package/dist/lite/model/searchForFacetsOptions.d.ts

@@ -1,11 +1,11 @@
 import type { SearchTypeFacet } from './searchTypeFacet';
 export type SearchForFacetsOptions = {
     /**
-     * The `facet` name.
+     * Facet name.
      */
     facet: string;
     /**
-     * The Algolia index name.
+     * Algolia index name.
      */
     indexName: string;
     /**
@@ -13,7 +13,7 @@ export type SearchForFacetsOptions = {
      */
     facetQuery?: string;
     /**
-     * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
+     * 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).
      */
     maxFacetHits?: number;
     type: SearchTypeFacet;

package/dist/lite/model/searchForHitsOptions.d.ts

@@ -1,7 +1,7 @@
 import type { SearchTypeDefault } from './searchTypeDefault';
 export type SearchForHitsOptions = {
     /**
-     * The Algolia index name.
+     * Algolia index name.
      */
     indexName: string;
     type?: SearchTypeDefault;

package/dist/lite/model/searchParamsQuery.d.ts

@@ -1,6 +1,6 @@
 export type SearchParamsQuery = {
     /**
-     * The text to search in the index.
+     * Text to search for in an index.
      */
     query?: string;
 };

package/dist/lite/model/searchParamsString.d.ts

@@ -1,6 +1,6 @@
 export type SearchParamsString = {
     /**
-     * Search parameters as URL-encoded query string.
+     * Search parameters as a URL-encoded query string.
      */
     params?: string;
 };

package/dist/lite/model/searchStrategy.d.ts

@@ -1,2 +1,5 @@
+/**
+ * - `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.
+ */
 export type SearchStrategy = 'none' | 'stopIfEnoughMatches';
 //# sourceMappingURL=searchStrategy.d.ts.map

package/dist/lite/model/searchStrategy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchStrategy.d.ts","sourceRoot":"","sources":["../../../lite/model/searchStrategy.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,qBAAqB,CAAC"}
+{"version":3,"file":"searchStrategy.d.ts","sourceRoot":"","sources":["../../../lite/model/searchStrategy.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,qBAAqB,CAAC"}

package/dist/lite/model/searchSynonymsResponse.d.ts

@@ -1,11 +1,11 @@
 import type { SynonymHit } from './synonymHit';
 export type SearchSynonymsResponse = Record<string, any> & {
     /**
-     * Array of synonym objects.
+     * Synonym objects.
      */
     hits: SynonymHit[];
     /**
-     * Number of hits that the search query matched.
+     * Number of hits the search query matched.
      */
     nbHits: number;
 };

package/dist/lite/model/searchTypeDefault.d.ts

@@ -1,5 +1,5 @@
 /**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
  */
 export type SearchTypeDefault = 'default';
 //# sourceMappingURL=searchTypeDefault.d.ts.map

package/dist/lite/model/searchTypeFacet.d.ts

@@ -1,5 +1,5 @@
 /**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
  */
 export type SearchTypeFacet = 'facet';
 //# sourceMappingURL=searchTypeFacet.d.ts.map

package/dist/lite/model/snippetResultOption.d.ts

@@ -4,7 +4,7 @@ import type { MatchLevel } from './matchLevel';
  */
 export type SnippetResultOption = {
     /**
-     * Markup text with occurrences highlighted.
+     * Markup text with `facetQuery` matches highlighted.
      */
     value: string;
     matchLevel: MatchLevel;

package/dist/lite/model/sortRemainingBy.d.ts

@@ -1,5 +1,5 @@
 /**
- * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
 //# sourceMappingURL=sortRemainingBy.d.ts.map

package/dist/lite/model/source.d.ts

@@ -1,13 +1,13 @@
 /**
- * The source.
+ * Source.
  */
 export type Source = {
     /**
-     * The IP range of the source.
+     * IP address range of the source.
      */
     source: string;
     /**
-     * The description of the source.
+     * Source description.
      */
     description?: string;
 };

package/dist/lite/model/standardEntries.d.ts

@@ -1,17 +1,17 @@
 /**
- * Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value.
+ * Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and boolean values.
  */
 export type StandardEntries = {
     /**
-     * Language ISO code.
+     * Key-value pair of a language ISO code and a boolean value.
      */
     plurals?: Record<string, boolean> | null;
     /**
-     * Language ISO code.
+     * Key-value pair of a language ISO code and a boolean value.
      */
     stopwords?: Record<string, boolean> | null;
     /**
-     * Language ISO code.
+     * Key-value pair of a language ISO code and a boolean value.
      */
     compounds?: Record<string, boolean> | null;
 };

package/dist/lite/model/synonymHit.d.ts

@@ -4,20 +4,20 @@ import type { SynonymType } from './synonymType';
  */
 export type SynonymHit = {
     /**
-     * Unique identifier of the synonym object to be created or updated.
+     * Unique identifier of a synonym object.
      */
     objectID: string;
     type: SynonymType;
     /**
-     * Words or phrases to be considered equivalent.
+     * Words or phrases considered equivalent.
      */
     synonyms?: string[];
     /**
-     * Word or phrase to appear in query strings (for onewaysynonym).
+     * 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;
     /**
-     * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
+     * 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;
     /**
@@ -25,11 +25,11 @@ export type SynonymHit = {
      */
     corrections?: string[];
     /**
-     * Token to be put inside records.
+     * [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;
     /**
-     * List of query words that will match the token.
+     * 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?: string[];
 };

package/dist/lite/model/synonymType.d.ts

@@ -1,5 +1,5 @@
 /**
- * Type of the synonym object.
+ * Synonym type.
  */
 export type SynonymType = 'altcorrection1' | 'altcorrection2' | 'onewaysynonym' | 'placeholder' | 'synonym';
 //# sourceMappingURL=synonymType.d.ts.map

package/dist/lite/model/tagFilters.d.ts

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * Filter hits by tags.
+ * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
  */
 export type TagFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=tagFilters.d.ts.map

package/dist/lite/model/taskStatus.d.ts

@@ -1,2 +1,5 @@
+/**
+ * _published_ if the task has been processed, _notPublished_ otherwise.
+ */
 export type TaskStatus = 'notPublished' | 'published';
 //# sourceMappingURL=taskStatus.d.ts.map

package/dist/lite/model/taskStatus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"taskStatus.d.ts","sourceRoot":"","sources":["../../../lite/model/taskStatus.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,WAAW,CAAC"}
+{"version":3,"file":"taskStatus.d.ts","sourceRoot":"","sources":["../../../lite/model/taskStatus.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,WAAW,CAAC"}

package/dist/lite/model/typoTolerance.d.ts

@@ -1,6 +1,6 @@
 import type { TypoToleranceEnum } from './typoToleranceEnum';
 /**
- * Controls whether typo tolerance is enabled and how it is applied.
+ * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
  */
 export type TypoTolerance = TypoToleranceEnum | boolean;
 //# sourceMappingURL=typoTolerance.d.ts.map

package/dist/lite/model/updatedRuleResponse.d.ts

@@ -1,14 +1,14 @@
 export type UpdatedRuleResponse = {
     /**
-     * Unique identifier of the object.
+     * Unique object identifier.
      */
     objectID: 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;
     /**
-     * TaskID of the task to wait for.
+     * 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`.
      */
     taskID: number;
 };

package/dist/lite/model/userId.d.ts

@@ -1,5 +1,5 @@
 /**
- * A userID.
+ * Unique user ID.
  */
 export type UserId = {
     /**
@@ -7,7 +7,7 @@ export type UserId = {
      */
     userID: string;
     /**
-     * Cluster on which the user is assigned.
+     * Cluster to which the user is assigned.
      */
     clusterName: string;
     /**

package/dist/lite/src/liteClient.d.ts

@@ -2,7 +2,7 @@ import type { CreateClientOptions, RequestOptions } from '@algolia/client-common
 import type { PostProps, LegacySearchMethodProps } from '../model/clientMethodProps';
 import type { SearchMethodParams } from '../model/searchMethodParams';
 import type { SearchResponses } from '../model/searchResponses';
-export declare const apiClientVersion = "5.0.0-alpha.73";
+export declare const apiClientVersion = "5.0.0-alpha.75";
 export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: import("@algolia/client-common").Transporter;
     /**
@@ -29,17 +29,17 @@ export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOpt
      *
      * @summary Send requests to the Algolia REST API.
      * @param post - The post object.
-     * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param post.parameters - Query parameters to be applied to the current query.
-     * @param post.body - The parameters to send with the custom request.
+     * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param post.parameters - Query parameters to apply to the current query.
+     * @param post.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.
      */
     post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * Perform a search operation targeting one or many indices.
+     * Send multiple search queries to one or more indices.
      *
      * @summary Search multiple indices.
-     * @param searchMethodParams - The `search` requests and strategy.
+     * @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.
      */
     search<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;

package/lite/model/acl.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.
 
 /**
- * List of rights for the API key. The following rights can be used:  addObject: allows to add/update an object in the index (copy/move index are also allowed with this right). Analytics: allows to retrieve the analytics through the Analytics API. Browse: allows to retrieve all index content via the browse API. DeleteIndex: allows to delete or clear index content. DeleteObject: allows to delete objects from the index. EditSettings: allows to change index settings. ListIndexes: allows to list all accessible indices. Logs: allows to get the logs. Recommendation: Allows usage of the Personalization dashboard and the Recommendation API. Search: allows to search the index. SeeUnretrievableAttributes: disable unretrievableAttributes feature for all operations returning records. Settings: allows to get index settings.
+ * API key permissions:  `addObject`: required to add or update records, copy or move an index. `analytics`: required to access the Analytics API. `browse`: required to view records `deleteIndex`: required to delete indices. `deleteObject`: required to delete records. `editSettings`: required to change index settings. `listIndexes`: required to list indices. `logs`: required to access logs of search and indexing operations. `recommendation`: required to access the Personalization and Recommend APIs. `search`: required to search records `seeUnretrievableAttributes`: required to retrieve [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) for all operations that return records. `settings`: required to examine index settings.
  */
 export type Acl =
   | 'addObject'

package/lite/model/action.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.
 
 /**
- * Type of operation.
+ * Type of batch operation.
  */
 export type Action =
   | 'addObject'

package/lite/model/addApiKeyResponse.ts

@@ -2,12 +2,12 @@
 
 export type AddApiKeyResponse = {
   /**
-   * The API key.
+   * API key.
    */
   key: string;
 
   /**
-   * Date of creation (ISO-8601 format).
+   * Timestamp of creation in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   createdAt: string;
 };

package/lite/model/anchoring.ts

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Whether the pattern parameter must match the beginning or the end of the query string, or both, or none.
+ * Whether the pattern parameter matches the beginning (`startsWith`) or end (`endsWith`) of the query string, is an exact match (`is`), or a partial match (`contains`).
  */
 export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';

package/lite/model/apiKey.ts

@@ -3,46 +3,46 @@
 import type { Acl } from './acl';
 
 /**
- * Api Key object.
+ * API key object.
  */
 export type ApiKey = {
   /**
-   * Set of permissions associated with the key.
+   * [Permissions](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl) associated with the key.
    */
   acl: Acl[];
 
   /**
-   * A comment used to identify a key more easily in the dashboard. It is not interpreted by the API.
+   * Description of an API key for you and your team members.
    */
   description?: string;
 
   /**
-   * Restrict this new API key to a list of indices or index patterns. If the list is empty, all indices are allowed.
+   * Restricts this API key to a list of indices or index patterns. If the list is empty, all indices are allowed. Specify either an exact index name or a pattern with a leading or trailing wildcard character (or both). For example: - `dev_*` matches all indices starting with \"dev_\" - `*_dev` matches all indices ending with \"_dev\" - `*_products_*` matches all indices containing \"_products_\".
    */
   indexes?: string[];
 
   /**
-   * Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.
+   * Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced. > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
    */
   maxHitsPerQuery?: number;
 
   /**
-   * Maximum number of API calls per hour allowed from a given IP address or a user token.
+   * Maximum number of API calls per hour allowed from a given IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). Each time an API call is performed with this key, a check is performed. If there were more than the specified number of calls within the last hour, the API returns an error with the status code `429` (Too Many Requests).  > **Note**: Use this parameter to protect you from third-party attempts to retrieve your entire content by massively querying the index.
    */
   maxQueriesPerIPPerHour?: number;
 
   /**
-   * URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
+   * Force some [query parameters](https://www.algolia.com/doc/api-reference/api-parameters/) to be applied for each query made with this API key. It\'s a URL-encoded query string.
    */
   queryParameters?: string;
 
   /**
-   * Restrict this new API key to specific referers. If empty or blank, defaults to all referers.
+   * Restrict this API key to specific [referrers](https://www.algolia.com/doc/guides/security/api-keys/in-depth/api-key-restrictions/#http-referrers). If empty, all referrers are allowed. For example: - `https://algolia.com/_*` matches all referrers starting with \"https://algolia.com/\" - `*.algolia.com` matches all referrers ending with \".algolia.com\" - `*algolia.com*` allows everything in the domain \"algolia.com\".
    */
   referers?: string[];
 
   /**
-   * Validity limit for this key in seconds. The key will automatically be removed after this period of time.
+   * Validity duration of a key (in seconds).  The key will automatically be removed after this time has expired. The default value of 0 never expires. Short-lived API keys are useful to grant temporary access to your data. For example, in mobile apps, you can\'t [control when users update your app](https://www.algolia.com/doc/guides/security/security-best-practices/#use-secured-api-keys-in-mobile-apps). So instead of encoding keys into your app as you would for a web app, you should dynamically fetch them from your mobile app\'s backend.
    */
   validity?: number;
 };

package/lite/model/aroundRadius.ts

@@ -3,6 +3,6 @@
 import type { AroundRadiusAll } from './aroundRadiusAll';
 
 /**
- * Define the maximum radius for a geo search (in meters).
+ * [Maximum radius](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#increase-the-search-radius) for a geographical search (in meters).
  */
 export type AroundRadius = AroundRadiusAll | number;