@algolia/client-search 5.0.0-alpha.73 → 5.0.0-alpha.76

package/dist/model/searchUserIdsResponse.d.ts

@@ -4,23 +4,23 @@ import type { UserHit } from './userHit';
  */
 export type SearchUserIdsResponse = {
     /**
-     * List of user object matching the query.
+     * User objects that match the query.
      */
     hits: UserHit[];
     /**
-     * Number of hits that the search query matched.
+     * Number of hits the search query matched.
      */
     nbHits: number;
     /**
-     * Specify the page to retrieve.
+     * Page to retrieve (the first page is `0`, not `1`).
      */
     page: number;
     /**
-     * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
+     * Maximum number of hits per page.
      */
     hitsPerPage: number;
     /**
-     * Date of last update (ISO-8601 format).
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
     updatedAt: string;
 };

package/dist/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/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/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/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/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/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/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/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/model/taskStatus.d.ts.map

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

package/dist/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/model/updateApiKeyResponse.d.ts

@@ -1,10 +1,10 @@
 export type UpdateApiKeyResponse = {
     /**
-     * The API key.
+     * API key.
      */
     key: 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;
 };

package/dist/model/updatedAtResponse.d.ts

@@ -1,13 +1,13 @@
 /**
- * The response with a taskID and an updatedAt timestamp.
+ * Response, taskID, and update timestamp.
  */
 export type UpdatedAtResponse = {
     /**
-     * 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;
     /**
-     * Date of last update (ISO-8601 format).
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
     updatedAt: string;
 };

package/dist/model/updatedAtWithObjectIdResponse.d.ts

@@ -1,17 +1,17 @@
 /**
- * The response with a taskID, an objectID and an updatedAt timestamp.
+ * Response, taskID, unique object identifier, and an update timestamp.
  */
 export type UpdatedAtWithObjectIdResponse = {
     /**
-     * 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;
     /**
-     * Date of last update (ISO-8601 format).
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
     updatedAt?: string;
     /**
-     * Unique identifier of the object.
+     * Unique object identifier.
      */
     objectID?: string;
 };

package/dist/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/model/userHit.d.ts

@@ -5,7 +5,7 @@ export type UserHit = {
      */
     userID: string;
     /**
-     * Name of the cluster.
+     * Cluster name.
      */
     clusterName: string;
     /**

package/dist/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;
     /**