@algolia/client-search 5.0.0-alpha.11 → 5.0.0-alpha.110

package/dist/model/searchParamsString.d.ts

@@ -1,7 +1,7 @@
-export declare type SearchParamsString = {
-    /**
-     * Search parameters as URL-encoded query string.
-     */
-    params?: string;
-};
+export type SearchParamsString = {
+    /**
+     * Search parameters as a URL-encoded query string.
+     */
+    params?: string;
+};
 //# sourceMappingURL=searchParamsString.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchParamsString.d.ts","sourceRoot":"","sources":["../../model/searchParamsString.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"searchParamsString.d.ts","sourceRoot":"","sources":["../../model/searchParamsString.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/searchQuery.d.ts

@@ -1,4 +1,4 @@
-import type { SearchForFacets } from './searchForFacets';
-import type { SearchForHits } from './searchForHits';
-export declare type SearchQuery = SearchForFacets | SearchForHits;
+import type { SearchForFacets } from './searchForFacets';
+import type { SearchForHits } from './searchForHits';
+export type SearchQuery = SearchForFacets | SearchForHits;
 //# sourceMappingURL=searchQuery.d.ts.map

package/dist/model/searchQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchQuery.d.ts","sourceRoot":"","sources":["../../model/searchQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,oBAAY,WAAW,GAAG,eAAe,GAAG,aAAa,CAAC"}
+{"version":3,"file":"searchQuery.d.ts","sourceRoot":"","sources":["../../model/searchQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,aAAa,CAAC"}

package/dist/model/searchResponse.d.ts

@@ -1,4 +1,4 @@
-import type { BaseSearchResponse } from './baseSearchResponse';
-import type { SearchHits } from './searchHits';
-export declare type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T>;
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { SearchHits } from './searchHits';
+export type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T>;
 //# sourceMappingURL=searchResponse.d.ts.map

package/dist/model/searchResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchResponse.d.ts","sourceRoot":"","sources":["../../model/searchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,kBAAkB,GACtE,UAAU,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"searchResponse.d.ts","sourceRoot":"","sources":["../../model/searchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,kBAAkB,GACtE,UAAU,CAAC,CAAC,CAAC,CAAC"}

package/dist/model/searchResponses.d.ts

@@ -1,5 +1,5 @@
-import type { SearchResponse } from './searchResponse';
-export declare type SearchResponses<T = Record<string, any>> = {
-    results: Array<SearchResponse<T>>;
-};
+import type { SearchResult } from './searchResult';
+export type SearchResponses<T = Record<string, any>> = {
+    results: Array<SearchResult<T>>;
+};
 //# sourceMappingURL=searchResponses.d.ts.map

package/dist/model/searchResponses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchResponses.d.ts","sourceRoot":"","sources":["../../model/searchResponses.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,oBAAY,eAAe,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACrD,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;CACnC,CAAC"}
+{"version":3,"file":"searchResponses.d.ts","sourceRoot":"","sources":["../../model/searchResponses.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,eAAe,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACrD,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CACjC,CAAC"}

package/dist/model/searchResult.d.ts

@@ -0,0 +1,4 @@
+import type { SearchForFacetValuesResponse } from './searchForFacetValuesResponse';
+import type { SearchResponse } from './searchResponse';
+export type SearchResult<T = Record<string, any>> = SearchForFacetValuesResponse | SearchResponse<T>;
+//# sourceMappingURL=searchResult.d.ts.map

package/dist/model/searchResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchResult.d.ts","sourceRoot":"","sources":["../../model/searchResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAC5C,4BAA4B,GAC5B,cAAc,CAAC,CAAC,CAAC,CAAC"}

package/dist/model/searchRulesParams.d.ts

@@ -1,32 +1,28 @@
-import type { Anchoring } from './anchoring';
-/**
- * Parameters for the search.
- */
-export declare type SearchRulesParams = {
-    /**
-     * Full text query.
-     */
-    query?: string;
-    anchoring?: Anchoring;
-    /**
-     * Restricts matches to contextual rules with a specific context (exact match).
-     */
-    context?: string;
-    /**
-     * Requested page (zero-based).
-     */
-    page?: number;
-    /**
-     * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
-     */
-    hitsPerPage?: number;
-    /**
-     * When specified, restricts matches to rules with a specific enabled status. When absent (default), all rules are retrieved, regardless of their enabled status.
-     */
-    enabled?: boolean;
-    /**
-     * A mapping of requestOptions to send along with the request.
-     */
-    requestOptions?: Array<Record<string, any>>;
-};
+import type { Anchoring } from './anchoring';
+/**
+ * Rules search parameters.
+ */
+export type SearchRulesParams = {
+    /**
+     * Search query for rules.
+     */
+    query?: string;
+    anchoring?: Anchoring;
+    /**
+     * Only return rules that match the context (exact match).
+     */
+    context?: string;
+    /**
+     * Requested page of the API response.
+     */
+    page?: number;
+    /**
+     * Maximum number of hits per page.
+     */
+    hitsPerPage?: number;
+    /**
+     * If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.
+     */
+    enabled?: boolean | null;
+};
 //# sourceMappingURL=searchRulesParams.d.ts.map

package/dist/model/searchRulesParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchRulesParams.d.ts","sourceRoot":"","sources":["../../model/searchRulesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,oBAAY,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,CAAC;IAElB;;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":["../../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/model/searchRulesResponse.d.ts

@@ -1,20 +1,20 @@
-import type { Rule } from './rule';
-export declare type SearchRulesResponse = {
-    /**
-     * Fetched rules.
-     */
-    hits: Rule[];
-    /**
-     * Number of fetched rules.
-     */
-    nbHits: number;
-    /**
-     * Current page.
-     */
-    page: number;
-    /**
-     * Number of pages.
-     */
-    nbPages: number;
-};
+import type { Rule } from './rule';
+export type SearchRulesResponse = {
+    /**
+     * Rules that matched the search criteria.
+     */
+    hits: Rule[];
+    /**
+     * Number of rules that matched the search criteria.
+     */
+    nbHits: number;
+    /**
+     * Current page.
+     */
+    page: number;
+    /**
+     * Number of pages.
+     */
+    nbPages: number;
+};
 //# sourceMappingURL=searchRulesResponse.d.ts.map

package/dist/model/searchRulesResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchRulesResponse.d.ts","sourceRoot":"","sources":["../../model/searchRulesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,IAAI,EAAE,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"searchRulesResponse.d.ts","sourceRoot":"","sources":["../../model/searchRulesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,IAAI,EAAE,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/searchStrategy.d.ts

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

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

package/dist/model/searchSynonymsParams.d.ts

@@ -1,7 +1,17 @@
-export declare type SearchSynonymsParams = {
-    /**
-     * The text to search in the index.
-     */
-    query?: string;
-};
+import type { SynonymType } from './synonymType';
+export type SearchSynonymsParams = {
+    /**
+     * Search query.
+     */
+    query?: string;
+    type?: SynonymType;
+    /**
+     * Page of search results to retrieve.
+     */
+    page?: number;
+    /**
+     * Number of hits per page.
+     */
+    hitsPerPage?: number;
+};
 //# sourceMappingURL=searchSynonymsParams.d.ts.map

package/dist/model/searchSynonymsParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchSynonymsParams.d.ts","sourceRoot":"","sources":["../../model/searchSynonymsParams.ts"],"names":[],"mappings":"AAEA,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"searchSynonymsParams.d.ts","sourceRoot":"","sources":["../../model/searchSynonymsParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,CAAC,EAAE,WAAW,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/dist/model/searchSynonymsResponse.d.ts

@@ -1,12 +1,12 @@
-import type { SynonymHit } from './synonymHit';
-export declare type SearchSynonymsResponse = Record<string, any> & {
-    /**
-     * Array of synonym objects.
-     */
-    hits: SynonymHit[];
-    /**
-     * Number of hits that the search query matched.
-     */
-    nbHits: number;
-};
+import type { SynonymHit } from './synonymHit';
+export type SearchSynonymsResponse = Record<string, any> & {
+    /**
+     * Matching synonyms.
+     */
+    hits: SynonymHit[];
+    /**
+     * Number of results (hits).
+     */
+    nbHits: number;
+};
 //# sourceMappingURL=searchSynonymsResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchSynonymsResponse.d.ts","sourceRoot":"","sources":["../../model/searchSynonymsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACzD;;OAEG;IACH,IAAI,EAAE,UAAU,EAAE,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"searchSynonymsResponse.d.ts","sourceRoot":"","sources":["../../model/searchSynonymsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACzD;;OAEG;IACH,IAAI,EAAE,UAAU,EAAE,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/searchTypeDefault.d.ts

@@ -1,5 +1,5 @@
-/**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
- */
-export declare type SearchTypeDefault = 'default';
+/**
+ * - `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/model/searchTypeDefault.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchTypeDefault.d.ts","sourceRoot":"","sources":["../../model/searchTypeDefault.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,iBAAiB,GAAG,SAAS,CAAC"}
+{"version":3,"file":"searchTypeDefault.d.ts","sourceRoot":"","sources":["../../model/searchTypeDefault.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC"}

package/dist/model/searchTypeFacet.d.ts

@@ -1,5 +1,5 @@
-/**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
- */
-export declare type SearchTypeFacet = 'facet';
+/**
+ * - `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/model/searchTypeFacet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchTypeFacet.d.ts","sourceRoot":"","sources":["../../model/searchTypeFacet.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,eAAe,GAAG,OAAO,CAAC"}
+{"version":3,"file":"searchTypeFacet.d.ts","sourceRoot":"","sources":["../../model/searchTypeFacet.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC"}

package/dist/model/searchUserIdsParams.d.ts

@@ -1,22 +1,22 @@
-/**
- * OK.
- */
-export declare type SearchUserIdsParams = {
-    /**
-     * Query to search. The search is a prefix search with typoTolerance. Use empty query to retrieve all users.
-     */
-    query: string;
-    /**
-     * Name of the cluster.
-     */
-    clusterName?: string;
-    /**
-     * Specify the page to retrieve.
-     */
-    page?: number;
-    /**
-     * Set the number of hits per page.
-     */
-    hitsPerPage?: number;
-};
+/**
+ * OK.
+ */
+export type SearchUserIdsParams = {
+    /**
+     * Query to search. The search is a prefix search with [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) enabled. An empty query will retrieve all users.
+     */
+    query: string;
+    /**
+     * Cluster name.
+     */
+    clusterName?: string;
+    /**
+     * Page of search results to retrieve.
+     */
+    page?: number;
+    /**
+     * Number of hits per page.
+     */
+    hitsPerPage?: number;
+};
 //# sourceMappingURL=searchUserIdsParams.d.ts.map

package/dist/model/searchUserIdsParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchUserIdsParams.d.ts","sourceRoot":"","sources":["../../model/searchUserIdsParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}
+{"version":3,"file":"searchUserIdsParams.d.ts","sourceRoot":"","sources":["../../model/searchUserIdsParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/dist/model/searchUserIdsResponse.d.ts

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

package/dist/model/searchUserIdsResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchUserIdsResponse.d.ts","sourceRoot":"","sources":["../../model/searchUserIdsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,OAAO,EAAE,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"searchUserIdsResponse.d.ts","sourceRoot":"","sources":["../../model/searchUserIdsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,OAAO,EAAE,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/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 in [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time) when the API key should expire.
+     */
+    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/model/securedAPIKeyRestrictions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"securedAPIKeyRestrictions.d.ts","sourceRoot":"","sources":["../../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/model/semanticSearch.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 all its replicas are used.
+     */
+    eventSources?: string[] | null;
+};
+//# sourceMappingURL=semanticSearch.d.ts.map

package/dist/model/semanticSearch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semanticSearch.d.ts","sourceRoot":"","sources":["../../model/semanticSearch.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAChC,CAAC"}

package/dist/model/snippetResult.d.ts

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

package/dist/model/snippetResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,oBAAY,aAAa,GAAG,mBAAmB,GAAG,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../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/model/snippetResultOption.d.ts

@@ -1,12 +1,12 @@
-import type { MatchLevel } from './matchLevel';
-/**
- * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
- */
-export declare type SnippetResultOption = {
-    /**
-     * Markup text with occurrences highlighted.
-     */
-    value: string;
-    matchLevel: MatchLevel;
-};
+import type { MatchLevel } from './matchLevel';
+/**
+ * Snippets that show the context around a matching search query.
+ */
+export type SnippetResultOption = {
+    /**
+     * Highlighted attribute value, including HTML tags.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+};
 //# sourceMappingURL=snippetResultOption.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"snippetResultOption.d.ts","sourceRoot":"","sources":["../../model/snippetResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC"}
+{"version":3,"file":"snippetResultOption.d.ts","sourceRoot":"","sources":["../../model/snippetResultOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC"}

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.
- */
-export declare type SortRemainingBy = 'alpha' | 'count' | 'hidden';
+/**
+ * Order of facet values that aren\'t explicitly positioned with the `order` setting.  <dl> <dt><code>count</code></dt> <dd> Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. </dd> <dt><code>alpha</code></dt> <dd>Sort facet values alphabetically.</dd> <dt><code>hidden</code></dt> <dd>Don\'t show facet values that aren\'t explicitly positioned.</dd> </dl>.
+ */
+export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
 //# sourceMappingURL=sortRemainingBy.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"sortRemainingBy.d.ts","sourceRoot":"","sources":["../../model/sortRemainingBy.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,eAAe,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"sortRemainingBy.d.ts","sourceRoot":"","sources":["../../model/sortRemainingBy.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC"}

package/dist/model/source.d.ts

@@ -1,14 +1,14 @@
-/**
- * The source.
- */
-export declare type Source = {
-    /**
-     * The IP range of the source.
-     */
-    source: string;
-    /**
-     * The description of the source.
-     */
-    description?: string;
-};
+/**
+ * Source.
+ */
+export type Source = {
+    /**
+     * IP address range of the source.
+     */
+    source: string;
+    /**
+     * Source description.
+     */
+    description?: string;
+};
 //# sourceMappingURL=source.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../model/source.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}
+{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../model/source.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/dist/model/standardEntries.d.ts

@@ -1,18 +1,18 @@
-/**
- * Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value.
- */
-export declare type StandardEntries = {
-    /**
-     * Language ISO code.
-     */
-    plurals?: Record<string, boolean> | null;
-    /**
-     * Language ISO code.
-     */
-    stopwords?: Record<string, boolean> | null;
-    /**
-     * Language ISO code.
-     */
-    compounds?: Record<string, boolean> | null;
-};
+/**
+ * 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 = {
+    /**
+     * Key-value pair of a language ISO code and a boolean value.
+     */
+    plurals?: Record<string, boolean> | null;
+    /**
+     * Key-value pair of a language ISO code and a boolean value.
+     */
+    stopwords?: Record<string, boolean> | null;
+    /**
+     * Key-value pair of a language ISO code and a boolean value.
+     */
+    compounds?: Record<string, boolean> | null;
+};
 //# sourceMappingURL=standardEntries.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"standardEntries.d.ts","sourceRoot":"","sources":["../../model/standardEntries.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC5C,CAAC"}
+{"version":3,"file":"standardEntries.d.ts","sourceRoot":"","sources":["../../model/standardEntries.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC5C,CAAC"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"supportedLanguage.d.ts","sourceRoot":"","sources":["../../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"}