algoliasearch 5.0.0-alpha.1 → 5.0.0-alpha.100

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../../lite/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/{algoliasearch/lite → lite}/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';
+/**
+ * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ */
+export type SnippetResultOption = {
+    /**
+     * Markup text with `facetQuery` matches highlighted.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+};
 //# sourceMappingURL=snippetResultOption.d.ts.map

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

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

@@ -0,0 +1,5 @@
+/**
+ * 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/sortRemainingBy.d.ts.map

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

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

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

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

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

@@ -0,0 +1,18 @@
+/**
+ * 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/lite/model/standardEntries.d.ts.map

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

@@ -0,0 +1,36 @@
+import type { SynonymType } from './synonymType';
+/**
+ * Synonym object.
+ */
+export type SynonymHit = {
+    /**
+     * Unique identifier of a synonym object.
+     */
+    objectID: string;
+    type: SynonymType;
+    /**
+     * Words or phrases considered equivalent.
+     */
+    synonyms?: string[];
+    /**
+     * 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`](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).
+     */
+    word?: string;
+    /**
+     * Words to be matched in records.
+     */
+    corrections?: string[];
+    /**
+     * [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;
+    /**
+     * 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[];
+};
+//# sourceMappingURL=synonymHit.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"synonymHit.d.ts","sourceRoot":"","sources":["../../../lite/model/synonymHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"synonymType.d.ts","sourceRoot":"","sources":["../../../lite/model/synonymType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,gBAAgB,GAChB,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,SAAS,CAAC"}

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

@@ -0,0 +1,6 @@
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * [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/tagFilters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tagFilters.d.ts","sourceRoot":"","sources":["../../../lite/model/tagFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}

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

@@ -0,0 +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

@@ -0,0 +1 @@
+{"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/{lite/model → model}/timeRange.d.ts

@@ -1,11 +1,11 @@
-export declare type TimeRange = {
-    /**
-     * Lower bound of the time range (Unix timestamp).
-     */
-    from: number;
-    /**
-     * Upper bound of the time range (Unix timestamp).
-     */
-    until: number;
-};
+export type TimeRange = {
+    /**
+     * Lower bound of the time range (Unix timestamp).
+     */
+    from: number;
+    /**
+     * Upper bound of the time range (Unix timestamp).
+     */
+    until: number;
+};
 //# sourceMappingURL=timeRange.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"timeRange.d.ts","sourceRoot":"","sources":["../../../lite/model/timeRange.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

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

@@ -0,0 +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.
+ */
+export type TypoTolerance = TypoToleranceEnum | boolean;
+//# sourceMappingURL=typoTolerance.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"typoTolerance.d.ts","sourceRoot":"","sources":["../../../lite/model/typoTolerance.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,OAAO,CAAC"}

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

@@ -0,0 +1,2 @@
+export type TypoToleranceEnum = 'min' | 'strict';
+//# sourceMappingURL=typoToleranceEnum.d.ts.map

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

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

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

@@ -0,0 +1,15 @@
+export type UpdatedRuleResponse = {
+    /**
+     * Unique object identifier.
+     */
+    objectID: string;
+    /**
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) 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`.
+     */
+    taskID: number;
+};
+//# sourceMappingURL=updatedRuleResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"updatedRuleResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/updatedRuleResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/{algoliasearch/lite → lite}/model/userId.d.ts

@@ -1,22 +1,22 @@
-/**
- * A userID.
- */
-export declare type UserId = {
-    /**
-     * UserID of the user.
-     */
-    userID: string;
-    /**
-     * Cluster on which the user is assigned.
-     */
-    clusterName: string;
-    /**
-     * Number of records belonging to the user.
-     */
-    nbRecords: number;
-    /**
-     * Data size used by the user.
-     */
-    dataSize: number;
-};
+/**
+ * Unique user ID.
+ */
+export type UserId = {
+    /**
+     * UserID of the user.
+     */
+    userID: string;
+    /**
+     * Cluster to which the user is assigned.
+     */
+    clusterName: string;
+    /**
+     * Number of records belonging to the user.
+     */
+    nbRecords: number;
+    /**
+     * Data size used by the user.
+     */
+    dataSize: number;
+};
 //# sourceMappingURL=userId.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"userId.d.ts","sourceRoot":"","sources":["../../../lite/model/userId.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/{algoliasearch/lite → lite}/model/value.d.ts

@@ -1,9 +1,9 @@
-import type { SortRemainingBy } from './sortRemainingBy';
-export declare type Value = {
-    /**
-     * Pinned order of facet lists.
-     */
-    order?: string[];
-    sortRemainingBy?: SortRemainingBy;
-};
+import type { SortRemainingBy } from './sortRemainingBy';
+export type Value = {
+    /**
+     * Pinned order of facet lists.
+     */
+    order?: string[];
+    sortRemainingBy?: SortRemainingBy;
+};
 //# sourceMappingURL=value.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../../lite/model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC"}

package/dist/lite/{lite/src → src}/liteClient.d.ts

@@ -1,40 +1,52 @@
-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.1";
-export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
-    transporter: import("@algolia/client-common").Transporter;
-    /**
-     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
-     */
-    readonly _ua: string;
-    /**
-     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
-     *
-     * @param segment - The algolia agent (user-agent) segment to add.
-     * @param version - The version of the agent.
-     */
-    addAlgoliaAgent(segment: string, version?: string): void;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @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 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.
-     *
-     * @summary Search multiple indices.
-     * @param searchMethodParams - The `search` requests and strategy.
-     * @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>>;
-};
-export declare type LiteClient = ReturnType<typeof createLiteClient>;
+import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
+import type { CustomPostProps, LegacySearchMethodProps } from '../model/clientMethodProps';
+import type { SearchMethodParams } from '../model/searchMethodParams';
+import type { SearchResponses } from '../model/searchResponses';
+export declare const apiClientVersion = "5.0.0-alpha.100";
+export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    /**
+     * The `appId` currently in use.
+     */
+    appId: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    readonly _ua: string;
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.parameters - Query parameters to apply to the current query.
+     * @param customPost.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.
+     */
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * Send multiple search queries to one or more indices.
+     *
+     * Required API Key ACLs:
+     * - search.
+     *
+     * @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>>;
+};
+/**
+ * The client type.
+ */
+export type LiteClient = ReturnType<typeof createLiteClient>;
 //# sourceMappingURL=liteClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"liteClient.d.ts","sourceRoot":"","sources":["../../../lite/src/liteClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,eAAe,EACf,uBAAuB,EACxB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAEhE,eAAO,MAAM,gBAAgB,oBAAoB,CAAC;AAsClD,wBAAgB,gBAAgB,CAAC,EAC/B,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;kCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;EAwDpC;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/index.d.ts

@@ -1,2 +1,2 @@
 // eslint-disable-next-line import/no-unresolved
-export * from './dist/builds/node';
+export * from './dist/algoliasearch/builds/node';

package/index.js

@@ -1,2 +1,2 @@
 // eslint-disable-next-line import/no-commonjs,import/extensions
-module.exports = require('./dist/algoliasearch.cjs.js');
+module.exports = require('./dist/algoliasearch.cjs');

package/lite/builds/browser.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { InitClientOptions } from '@algolia/client-common';
+import type { ClientOptions } from '@algolia/client-common';
 import {
   DEFAULT_CONNECT_TIMEOUT_BROWSER,
   DEFAULT_READ_TIMEOUT_BROWSER,
@@ -20,7 +20,7 @@ export * from '../model';
 export function liteClient(
   appId: string,
   apiKey: string,
-  options?: InitClientOptions
+  options?: ClientOptions
 ): LiteClient {
   if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');

package/lite/builds/node.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { InitClientOptions } from '@algolia/client-common';
+import type { ClientOptions } from '@algolia/client-common';
 import {
   DEFAULT_CONNECT_TIMEOUT_NODE,
   DEFAULT_READ_TIMEOUT_NODE,
@@ -19,7 +19,7 @@ export * from '../model';
 export function liteClient(
   appId: string,
   apiKey: string,
-  options?: InitClientOptions
+  options?: ClientOptions
 ): LiteClient {
   if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');

package/lite/model/acl.ts

@@ -1,5 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
+/**
+ * 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. `inference`: required to access the Inference API. `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'
   | 'analytics'
@@ -7,6 +10,7 @@ export type Acl =
   | 'deleteIndex'
   | 'deleteObject'
   | 'editSettings'
+  | 'inference'
   | 'listIndexes'
   | 'logs'
   | 'personalization'

package/lite/model/action.ts

@@ -1,7 +1,7 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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

@@ -1,12 +1,13 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 export type AddApiKeyResponse = {
   /**
-   * Key string.
+   * 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/advancedSyntaxFeatures.ts

@@ -1,3 +1,3 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 export type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';

package/lite/model/alternativesAsExact.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 export type AlternativesAsExact =
   | 'ignorePlurals'

package/lite/model/anchoring.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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

@@ -1,41 +1,48 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { 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/aroundPrecision.ts

@@ -0,0 +1,8 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { AroundPrecisionFromValueInner } from './aroundPrecisionFromValueInner';
+
+/**
+ * Precision of a geographical search (in meters), to [group results that are more or less the same distance from a central point](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/in-depth/geo-ranking-precision/).
+ */
+export type AroundPrecision = AroundPrecisionFromValueInner[] | number;

package/lite/model/aroundPrecisionFromValueInner.ts

@@ -0,0 +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.
+
+export type AroundPrecisionFromValueInner = {
+  from?: number;
+
+  value?: number;
+};

package/lite/model/aroundRadius.ts

@@ -1,8 +1,8 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { 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;