algoliasearch 5.0.0-alpha.98 → 5.0.0-beta.1

package/dist/client-search/model/saveObjectResponse.d.ts

@@ -1,14 +1,14 @@
 export type SaveObjectResponse = {
     /**
-     * Date of creation (ISO-8601 format).
+     * Date and time when the object was created, in RFC 3339 format.
      */
     createdAt: 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;
     /**
-     * Unique object identifier.
+     * Unique record identifier.
      */
     objectID?: string;
 };

package/dist/client-search/model/saveSynonymResponse.d.ts

@@ -1,10 +1,10 @@
 export type SaveSynonymResponse = {
     /**
-     * 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;
     /**
-     * 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;
     /**

package/dist/client-search/model/searchDictionaryEntriesParams.d.ts

@@ -1,22 +1,20 @@
+import type { SupportedLanguage } from './supportedLanguage';
 /**
- * `searchDictionaryEntries` parameters.
+ * Search parameter.
  */
 export type SearchDictionaryEntriesParams = {
     /**
-     * Text to search for in an index.
+     * Search query.
      */
     query: string;
     /**
-     * Page to retrieve (the first page is `0`, not `1`).
+     * Page of search results to retrieve.
      */
     page?: number;
     /**
      * Number of hits per page.
      */
     hitsPerPage?: number;
-    /**
-     * [Supported language ISO code](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
-     */
-    language?: string;
+    language?: SupportedLanguage;
 };
 //# sourceMappingURL=searchDictionaryEntriesParams.d.ts.map

package/dist/client-search/model/searchDictionaryEntriesParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchDictionaryEntriesParams.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchDictionaryEntriesParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"searchDictionaryEntriesParams.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchDictionaryEntriesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,EAAE,iBAAiB,CAAC;CAC9B,CAAC"}

package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts

@@ -0,0 +1,20 @@
+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;
+};
+//# sourceMappingURL=searchDictionaryEntriesResponse.d.ts.map

package/dist/client-search/model/searchDictionaryEntriesResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchDictionaryEntriesResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchDictionaryEntriesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,+BAA+B,GAAG;IAC5C;;OAEG;IACH,IAAI,EAAE,eAAe,EAAE,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/client-search/model/searchForFacetValuesRequest.d.ts

@@ -8,7 +8,7 @@ export type SearchForFacetValuesRequest = {
      */
     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/dist/client-search/model/searchForFacetValuesResponse.d.ts

@@ -1,5 +1,8 @@
 import type { FacetHits } from './facetHits';
 export type SearchForFacetValuesResponse = {
+    /**
+     * Matching facet values.
+     */
     facetHits: FacetHits[];
     /**
      * See the `facetsCount` field of the `exhaustive` object in the response.

package/dist/client-search/model/searchForFacetValuesResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchForFacetValuesResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchForFacetValuesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,4BAA4B,GAAG;IACzC,SAAS,EAAE,SAAS,EAAE,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}
+{"version":3,"file":"searchForFacetValuesResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchForFacetValuesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,SAAS,EAAE,SAAS,EAAE,CAAC;IAEvB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}

package/dist/client-search/model/searchForFacetsOptions.d.ts

@@ -5,7 +5,7 @@ export type SearchForFacetsOptions = {
      */
     facet: string;
     /**
-     * Algolia index name.
+     * Index name (case-sensitive).
      */
     indexName: string;
     /**
@@ -13,7 +13,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;
     type: SearchTypeFacet;

package/dist/client-search/model/searchForHitsOptions.d.ts

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

package/dist/client-search/model/searchHits.d.ts

@@ -1,13 +1,16 @@
 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;
 };
 //# sourceMappingURL=searchHits.d.ts.map

package/dist/client-search/model/searchHits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchHits.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACtE,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC;IAET;;OAEG;IACH,MAAM,EAAE,CAAC,CAAC;CACX,CAAC"}
+{"version":3,"file":"searchHits.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACtE;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/client-search/model/searchParamsObject.d.ts

@@ -1,4 +1,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;
 //# sourceMappingURL=searchParamsObject.d.ts.map

package/dist/client-search/model/searchParamsObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}
+{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}

package/dist/client-search/model/searchParamsQuery.d.ts

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

package/dist/client-search/model/searchRulesParams.d.ts

@@ -4,16 +4,16 @@ import type { Anchoring } from './anchoring';
  */
 export type SearchRulesParams = {
     /**
-     * Rule object query.
+     * Search query for rules.
      */
     query?: string;
     anchoring?: Anchoring;
     /**
-     * Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
+     * Only return rules that match the context (exact match).
      */
     context?: string;
     /**
-     * Requested page (the first page is page 0).
+     * Requested page of the API response.
      */
     page?: number;
     /**
@@ -21,12 +21,8 @@ export type SearchRulesParams = {
      */
     hitsPerPage?: number;
     /**
-     * Restricts responses to enabled rules. When not specified (default), _all_ rules are retrieved.
+     * If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.
      */
     enabled?: boolean | null;
-    /**
-     * Request options to send with the API call.
-     */
-    requestOptions?: Array<Record<string, any>>;
 };
 //# sourceMappingURL=searchRulesParams.d.ts.map

package/dist/client-search/model/searchRulesParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchRulesParams.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchRulesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;CAC7C,CAAC"}
+{"version":3,"file":"searchRulesParams.d.ts","sourceRoot":"","sources":["../../../../client-search/model/searchRulesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC1B,CAAC"}

package/dist/client-search/model/searchRulesResponse.d.ts

@@ -1,11 +1,11 @@
 import type { Rule } from './rule';
 export type SearchRulesResponse = {
     /**
-     * Fetched rules.
+     * Rules that matched the search criteria.
      */
     hits: Rule[];
     /**
-     * Number of fetched rules.
+     * Number of rules that matched the search criteria.
      */
     nbHits: number;
     /**

package/dist/client-search/model/searchStrategy.d.ts

@@ -1,5 +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.
+ * 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';
 //# sourceMappingURL=searchStrategy.d.ts.map

package/dist/client-search/model/searchSynonymsParams.d.ts

@@ -1,12 +1,12 @@
 import type { SynonymType } from './synonymType';
 export type SearchSynonymsParams = {
     /**
-     * Text to search for in an index.
+     * Search query.
      */
     query?: string;
     type?: SynonymType;
     /**
-     * Page to retrieve (the first page is `0`, not `1`).
+     * Page of search results to retrieve.
      */
     page?: number;
     /**

package/dist/client-search/model/searchSynonymsResponse.d.ts

@@ -1,11 +1,11 @@
 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/dist/client-search/model/searchUserIdsParams.d.ts

@@ -11,7 +11,7 @@ export type SearchUserIdsParams = {
      */
     clusterName?: string;
     /**
-     * Page to retrieve (the first page is `0`, not `1`).
+     * Page of search results to retrieve.
      */
     page?: number;
     /**

package/dist/client-search/model/searchUserIdsResponse.d.ts

@@ -8,11 +8,11 @@ export type SearchUserIdsResponse = {
      */
     hits: UserHit[];
     /**
-     * Number of hits the search query matched.
+     * Number of results (hits).
      */
     nbHits: number;
     /**
-     * Page to retrieve (the first page is `0`, not `1`).
+     * Page of search results to retrieve.
      */
     page: number;
     /**
@@ -20,7 +20,7 @@ export type SearchUserIdsResponse = {
      */
     hitsPerPage: number;
     /**
-     * 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;
 };

package/dist/client-search/model/securedAPIKeyRestrictions.d.ts

@@ -0,0 +1,25 @@
+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;
+};
+//# sourceMappingURL=securedAPIKeyRestrictions.d.ts.map

package/dist/client-search/model/securedAPIKeyRestrictions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"securedAPIKeyRestrictions.d.ts","sourceRoot":"","sources":["../../../../client-search/model/securedAPIKeyRestrictions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,yBAAyB,GAAG;IACtC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/client-search/model/semanticSearch.d.ts

@@ -1,9 +1,9 @@
 /**
- * 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/dist/client-search/model/snippetResult.d.ts

@@ -1,3 +1,3 @@
 import type { SnippetResultOption } from './snippetResultOption';
-export type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption;
+export type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption | SnippetResultOption[];
 //# sourceMappingURL=snippetResult.d.ts.map

package/dist/client-search/model/snippetResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../../../client-search/model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GACrB,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GACnC,mBAAmB,CAAC"}
+{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../../../client-search/model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GACrB,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GACnC,mBAAmB,GACnB,mBAAmB,EAAE,CAAC"}

package/dist/client-search/model/snippetResultOption.d.ts

@@ -1,10 +1,10 @@
 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;
     matchLevel: MatchLevel;

package/dist/client-search/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.
+ * 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';
 //# sourceMappingURL=sortRemainingBy.d.ts.map

package/dist/client-search/model/supportedLanguage.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 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';
+//# sourceMappingURL=supportedLanguage.d.ts.map

package/dist/client-search/model/supportedLanguage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"supportedLanguage.d.ts","sourceRoot":"","sources":["../../../../client-search/model/supportedLanguage.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC"}

package/dist/client-search/model/tagFilters.d.ts

@@ -1,6 +1,6 @@
 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;
 //# sourceMappingURL=tagFilters.d.ts.map

package/dist/client-search/model/taskStatus.d.ts

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

package/dist/client-search/model/timeRange.d.ts

@@ -1,10 +1,10 @@
 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/dist/client-search/model/typoTolerance.d.ts

@@ -1,6 +1,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;
 //# sourceMappingURL=typoTolerance.d.ts.map

package/dist/client-search/model/typoToleranceEnum.d.ts

@@ -1,2 +1,5 @@
+/**
+ * - `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';
 //# sourceMappingURL=typoToleranceEnum.d.ts.map

package/dist/client-search/model/typoToleranceEnum.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../../../client-search/model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../../../client-search/model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}

package/dist/client-search/model/updateApiKeyResponse.d.ts

@@ -4,7 +4,7 @@ export type UpdateApiKeyResponse = {
      */
     key: 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;
 };

package/dist/client-search/model/updatedAtResponse.d.ts

@@ -3,11 +3,11 @@
  */
 export type UpdatedAtResponse = {
     /**
-     * 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;
     /**
-     * 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;
 };

package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts

@@ -3,15 +3,15 @@
  */
 export type UpdatedAtWithObjectIdResponse = {
     /**
-     * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation 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;
     /**
-     * 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 object identifier.
+     * Unique record identifier.
      */
     objectID?: string;
 };

package/dist/client-search/model/updatedRuleResponse.d.ts

@@ -1,14 +1,14 @@
 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/dist/client-search/model/userHit.d.ts

@@ -1,7 +1,7 @@
 import type { UserHighlightResult } from './userHighlightResult';
 export type UserHit = {
     /**
-     * UserID of the user.
+     * Unique identifier of the user who makes the search request.
      */
     userID: string;
     /**

package/dist/client-search/model/userId.d.ts

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

package/dist/client-search/model/value.d.ts

@@ -1,7 +1,7 @@
 import type { SortRemainingBy } from './sortRemainingBy';
 export type Value = {
     /**
-     * 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[];
     sortRemainingBy?: SortRemainingBy;