algoliasearch 5.0.0-alpha.9 → 5.0.0-alpha.91

package/dist/client-personalization/src/personalizationClient.d.ts

@@ -1,113 +1,113 @@
-import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
-import type { DelProps, DeleteUserProfileProps, GetProps, GetUserTokenProfileProps, PostProps, PutProps } from '../model/clientMethodProps';
-import type { DeleteUserProfileResponse } from '../model/deleteUserProfileResponse';
-import type { GetUserTokenResponse } from '../model/getUserTokenResponse';
-import type { PersonalizationStrategyParams } from '../model/personalizationStrategyParams';
-import type { SetPersonalizationStrategyResponse } from '../model/setPersonalizationStrategyResponse';
-export declare const apiClientVersion = "5.0.0-alpha.9";
-export declare const REGIONS: readonly ["eu", "us"];
-export declare type Region = typeof REGIONS[number];
-export declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
-    region: Region;
-}): {
-    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.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param del - The del object.
-     * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param del.parameters - Query parameters to be applied to the current query.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-    /**
-     * Delete the user profile and all its associated data.  Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile.  It might take a couple hours for the deletion request to be fully processed.
-     *
-     * @summary Delete a user profile.
-     * @param deleteUserProfile - The deleteUserProfile object.
-     * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    deleteUserProfile({ userToken }: DeleteUserProfileProps, requestOptions?: RequestOptions): Promise<DeleteUserProfileResponse>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param get - The get object.
-     * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param get.parameters - Query parameters to be applied to the current query.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-    /**
-     * The strategy contains information on the events and facets that impact user profiles and personalized search results.
-     *
-     * @summary Get the current strategy.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getPersonalizationStrategy(requestOptions?: RequestOptions): Promise<PersonalizationStrategyParams>;
-    /**
-     * Get the user profile built from Personalization strategy.  The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
-     *
-     * @summary Get a user profile.
-     * @param getUserTokenProfile - The getUserTokenProfile object.
-     * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getUserTokenProfile({ userToken }: GetUserTokenProfileProps, requestOptions?: RequestOptions): Promise<GetUserTokenResponse>;
-    /**
-     * 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>>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param put - The put object.
-     * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param put.parameters - Query parameters to be applied to the current query.
-     * @param put.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.
-     */
-    put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-    /**
-     * A strategy defines the events and facets that impact user profiles and personalized search results.
-     *
-     * @summary Set a new strategy.
-     * @param personalizationStrategyParams - The personalizationStrategyParams object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    setPersonalizationStrategy(personalizationStrategyParams: PersonalizationStrategyParams, requestOptions?: RequestOptions): Promise<SetPersonalizationStrategyResponse>;
-};
-/**
- * The client type.
- */
-export declare type PersonalizationClient = ReturnType<typeof createPersonalizationClient>;
+import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
+import type { DelProps, DeleteUserProfileProps, GetProps, GetUserTokenProfileProps, PostProps, PutProps } from '../model/clientMethodProps';
+import type { DeleteUserProfileResponse } from '../model/deleteUserProfileResponse';
+import type { GetUserTokenResponse } from '../model/getUserTokenResponse';
+import type { PersonalizationStrategyParams } from '../model/personalizationStrategyParams';
+import type { SetPersonalizationStrategyResponse } from '../model/setPersonalizationStrategyResponse';
+export declare const apiClientVersion = "5.0.0-alpha.91";
+export declare const REGIONS: readonly ["eu", "us"];
+export type Region = (typeof REGIONS)[number];
+export declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
+    region: Region;
+}): {
+    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.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param del - The del object.
+     * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param del.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * Delete the user profile and all its associated data.  Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile.  It might take a couple hours for the deletion request to be fully processed.
+     *
+     * @summary Delete a user profile.
+     * @param deleteUserProfile - The deleteUserProfile object.
+     * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    deleteUserProfile({ userToken }: DeleteUserProfileProps, requestOptions?: RequestOptions): Promise<DeleteUserProfileResponse>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param get - The get object.
+     * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param get.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * The strategy contains information on the events and facets that impact user profiles and personalized search results.
+     *
+     * @summary Get the current strategy.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getPersonalizationStrategy(requestOptions?: RequestOptions): Promise<PersonalizationStrategyParams>;
+    /**
+     * Get the user profile built from Personalization strategy.  The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
+     *
+     * @summary Get a user profile.
+     * @param getUserTokenProfile - The getUserTokenProfile object.
+     * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getUserTokenProfile({ userToken }: GetUserTokenProfileProps, requestOptions?: RequestOptions): Promise<GetUserTokenResponse>;
+    /**
+     * 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 - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param post.parameters - Query parameters to apply to the current query.
+     * @param post.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param put - The put object.
+     * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param put.parameters - Query parameters to apply to the current query.
+     * @param put.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.
+     */
+    put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * A strategy defines the events and facets that impact user profiles and personalized search results.
+     *
+     * @summary Set a new strategy.
+     * @param personalizationStrategyParams - The personalizationStrategyParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    setPersonalizationStrategy(personalizationStrategyParams: PersonalizationStrategyParams, requestOptions?: RequestOptions): Promise<SetPersonalizationStrategyResponse>;
+};
+/**
+ * The client type.
+ */
+export type PersonalizationClient = ReturnType<typeof createPersonalizationClient>;
 //# sourceMappingURL=personalizationClient.d.ts.map

package/dist/client-personalization/src/personalizationClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"personalizationClient.d.ts","sourceRoot":"","sources":["../../../../client-personalization/src/personalizationClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,QAAQ,EACR,sBAAsB,EACtB,QAAQ,EACR,wBAAwB,EACxB,SAAS,EACT,QAAQ,EACT,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,6CAA6C,CAAC;AAEtG,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,oBAAY,MAAM,GAAG,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AAY5C,wBAAgB,2BAA2B,CAAC,EAC1C,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAwBvC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;qCAEc,sBAAsB,mBACpB,cAAc,GAC9B,QAAQ,yBAAyB,CAAC;IAwBrC;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;OAKG;gDAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;OAOG;uCAEc,wBAAwB,mBACtB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;OAMG;8DAE8B,6BAA6B,mBAC3C,cAAc,GAC9B,QAAQ,kCAAkC,CAAC;EAsCjD;AAED;;GAEG;AACH,oBAAY,qBAAqB,GAAG,UAAU,CAC5C,OAAO,2BAA2B,CACnC,CAAC"}
+{"version":3,"file":"personalizationClient.d.ts","sourceRoot":"","sources":["../../../../client-personalization/src/personalizationClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,QAAQ,EACR,sBAAsB,EACtB,QAAQ,EACR,wBAAwB,EACxB,SAAS,EACT,QAAQ,EACT,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,6CAA6C,CAAC;AAEtG,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAY9C,wBAAgB,2BAA2B,CAAC,EAC1C,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAwBvC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;qCAEc,sBAAsB,mBACpB,cAAc,GAC9B,QAAQ,yBAAyB,CAAC;IAwBrC;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;OAKG;gDAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;OAOG;uCAEc,wBAAwB,mBACtB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;OAMG;8DAE8B,6BAA6B,mBAC3C,cAAc,GAC9B,QAAQ,kCAAkC,CAAC;EAsCjD;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAC5C,OAAO,2BAA2B,CACnC,CAAC"}

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

@@ -1,5 +1,5 @@
-/**
- * List of rights for the API key. The following rights can be used:  addObject: allows to add/update an object in the index (copy/move index are also allowed with this right). Analytics: allows to retrieve the analytics through the Analytics API. Browse: allows to retrieve all index content via the browse API. DeleteIndex: allows to delete or clear index content. DeleteObject: allows to delete objects from the index. EditSettings: allows to change index settings. ListIndexes: allows to list all accessible indices. Logs: allows to get the logs. Recommendation: Allows usage of the Personalization dashboard and the Recommendation API. Search: allows to search the index. SeeUnretrievableAttributes: disable unretrievableAttributes feature for all operations returning records. Settings: allows to get index settings.
- */
-export declare type Acl = 'addObject' | 'analytics' | 'browse' | 'deleteIndex' | 'deleteObject' | 'editSettings' | 'listIndexes' | 'logs' | 'personalization' | 'recommendation' | 'search' | 'seeUnretrievableAttributes' | 'settings' | 'usage';
+/**
+ * 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' | 'browse' | 'deleteIndex' | 'deleteObject' | 'editSettings' | 'inference' | 'listIndexes' | 'logs' | 'personalization' | 'recommendation' | 'search' | 'seeUnretrievableAttributes' | 'settings' | 'usage';
 //# sourceMappingURL=acl.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"acl.d.ts","sourceRoot":"","sources":["../../../../client-search/model/acl.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,GAAG,GACX,WAAW,GACX,WAAW,GACX,QAAQ,GACR,aAAa,GACb,cAAc,GACd,cAAc,GACd,aAAa,GACb,MAAM,GACN,iBAAiB,GACjB,gBAAgB,GAChB,QAAQ,GACR,4BAA4B,GAC5B,UAAU,GACV,OAAO,CAAC"}
+{"version":3,"file":"acl.d.ts","sourceRoot":"","sources":["../../../../client-search/model/acl.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,GAAG,GACX,WAAW,GACX,WAAW,GACX,QAAQ,GACR,aAAa,GACb,cAAc,GACd,cAAc,GACd,WAAW,GACX,aAAa,GACb,MAAM,GACN,iBAAiB,GACjB,gBAAgB,GAChB,QAAQ,GACR,4BAA4B,GAC5B,UAAU,GACV,OAAO,CAAC"}

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

@@ -1,5 +1,5 @@
-/**
- * Type of operation.
- */
-export declare type Action = 'addObject' | 'clear' | 'delete' | 'deleteObject' | 'partialUpdateObject' | 'partialUpdateObjectNoCreate' | 'updateObject';
+/**
+ * Type of batch operation.
+ */
+export type Action = 'addObject' | 'clear' | 'delete' | 'deleteObject' | 'partialUpdateObject' | 'partialUpdateObjectNoCreate' | 'updateObject';
 //# sourceMappingURL=action.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../../../client-search/model/action.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GACd,WAAW,GACX,OAAO,GACP,QAAQ,GACR,cAAc,GACd,qBAAqB,GACrB,6BAA6B,GAC7B,cAAc,CAAC"}
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../../../client-search/model/action.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GACd,WAAW,GACX,OAAO,GACP,QAAQ,GACR,cAAc,GACd,qBAAqB,GACrB,6BAA6B,GAC7B,cAAc,CAAC"}

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

@@ -1,11 +1,11 @@
-export declare type AddApiKeyResponse = {
-    /**
-     * The API key.
-     */
-    key: string;
-    /**
-     * Date of creation (ISO-8601 format).
-     */
-    createdAt: string;
-};
+export type AddApiKeyResponse = {
+    /**
+     * API key.
+     */
+    key: string;
+    /**
+     * Timestamp of creation in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    createdAt: string;
+};
 //# sourceMappingURL=addApiKeyResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"addApiKeyResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/addApiKeyResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"addApiKeyResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/addApiKeyResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

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

@@ -1,2 +1,2 @@
-export declare type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
+export type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
 //# sourceMappingURL=advancedSyntaxFeatures.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"advancedSyntaxFeatures.d.ts","sourceRoot":"","sources":["../../../../client-search/model/advancedSyntaxFeatures.ts"],"names":[],"mappings":"AAEA,oBAAY,sBAAsB,GAAG,aAAa,GAAG,cAAc,CAAC"}
+{"version":3,"file":"advancedSyntaxFeatures.d.ts","sourceRoot":"","sources":["../../../../client-search/model/advancedSyntaxFeatures.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,sBAAsB,GAAG,aAAa,GAAG,cAAc,CAAC"}

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

@@ -1,2 +1,2 @@
-export declare type AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
+export type AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
 //# sourceMappingURL=alternativesAsExact.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"alternativesAsExact.d.ts","sourceRoot":"","sources":["../../../../client-search/model/alternativesAsExact.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAC3B,eAAe,GACf,mBAAmB,GACnB,mBAAmB,CAAC"}
+{"version":3,"file":"alternativesAsExact.d.ts","sourceRoot":"","sources":["../../../../client-search/model/alternativesAsExact.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAC3B,eAAe,GACf,mBAAmB,GACnB,mBAAmB,CAAC"}

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

@@ -1,5 +1,5 @@
-/**
- * Whether the pattern parameter must match the beginning or the end of the query string, or both, or none.
- */
-export declare type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';
+/**
+ * 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';
 //# sourceMappingURL=anchoring.d.ts.map

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

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

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

@@ -1,39 +1,39 @@
-import type { Acl } from './acl';
-/**
- * Api Key object.
- */
-export declare type ApiKey = {
-    /**
-     * Set of permissions 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?: string;
-    /**
-     * Restrict this new API key to a list of indices or index patterns. If the list is empty, all indices are allowed.
-     */
-    indexes?: string[];
-    /**
-     * Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.
-     */
-    maxHitsPerQuery?: number;
-    /**
-     * Maximum number of API calls per hour allowed from a given IP address or a user token.
-     */
-    maxQueriesPerIPPerHour?: number;
-    /**
-     * URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
-     */
-    queryParameters?: string;
-    /**
-     * Restrict this new API key to specific referers. If empty or blank, defaults to all referers.
-     */
-    referers?: string[];
-    /**
-     * Validity limit for this key in seconds. The key will automatically be removed after this period of time.
-     */
-    validity?: number;
-};
+import type { Acl } from './acl';
+/**
+ * API key object.
+ */
+export type ApiKey = {
+    /**
+     * [Permissions](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl) associated with the key.
+     */
+    acl: Acl[];
+    /**
+     * Description of an API key for you and your team members.
+     */
+    description?: string;
+    /**
+     * 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. > **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 [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;
+    /**
+     * 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 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 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;
+};
 //# sourceMappingURL=apiKey.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"apiKey.d.ts","sourceRoot":"","sources":["../../../../client-search/model/apiKey.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,GAAG,EAAE,GAAG,EAAE,CAAC;IAEX;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"apiKey.d.ts","sourceRoot":"","sources":["../../../../client-search/model/apiKey.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAEjC;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,GAAG,EAAE,GAAG,EAAE,CAAC;IAEX;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"aroundPrecision.d.ts","sourceRoot":"","sources":["../../../../client-search/model/aroundPrecision.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,6BAA6B,EAAE,GAAG,MAAM,CAAC"}

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

@@ -0,0 +1,5 @@
+export type AroundPrecisionFromValueInner = {
+    from?: number;
+    value?: number;
+};
+//# sourceMappingURL=aroundPrecisionFromValueInner.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"aroundPrecisionFromValueInner.d.ts","sourceRoot":"","sources":["../../../../client-search/model/aroundPrecisionFromValueInner.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

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

@@ -1,6 +1,6 @@
-import type { AroundRadiusAll } from './aroundRadiusAll';
-/**
- * Define the maximum radius for a geo search (in meters).
- */
-export declare type AroundRadius = AroundRadiusAll | number;
+import type { AroundRadiusAll } from './aroundRadiusAll';
+/**
+ * [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;
 //# sourceMappingURL=aroundRadius.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"aroundRadius.d.ts","sourceRoot":"","sources":["../../../../client-search/model/aroundRadius.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,oBAAY,YAAY,GAAG,eAAe,GAAG,MAAM,CAAC"}
+{"version":3,"file":"aroundRadius.d.ts","sourceRoot":"","sources":["../../../../client-search/model/aroundRadius.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,eAAe,GAAG,MAAM,CAAC"}

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

@@ -1,2 +1,2 @@
-export declare type AroundRadiusAll = 'all';
+export type AroundRadiusAll = 'all';
 //# sourceMappingURL=aroundRadiusAll.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"aroundRadiusAll.d.ts","sourceRoot":"","sources":["../../../../client-search/model/aroundRadiusAll.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG,KAAK,CAAC"}
+{"version":3,"file":"aroundRadiusAll.d.ts","sourceRoot":"","sources":["../../../../client-search/model/aroundRadiusAll.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC"}

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

@@ -1,10 +1,10 @@
-/**
- * Assign userID parameters.
- */
-export declare type AssignUserIdParams = {
-    /**
-     * Name of the cluster.
-     */
-    cluster: string;
-};
+/**
+ * Assign userID parameters.
+ */
+export type AssignUserIdParams = {
+    /**
+     * Cluster name.
+     */
+    cluster: string;
+};
 //# sourceMappingURL=assignUserIdParams.d.ts.map

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

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

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

@@ -1,3 +1,3 @@
-import type { BuiltInOperation } from './builtInOperation';
-export declare type AttributeToUpdate = BuiltInOperation | string;
+import type { BuiltInOperation } from './builtInOperation';
+export type AttributeToUpdate = BuiltInOperation | string;
 //# sourceMappingURL=attributeToUpdate.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"attributeToUpdate.d.ts","sourceRoot":"","sources":["../../../../client-search/model/attributeToUpdate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,oBAAY,iBAAiB,GAAG,gBAAgB,GAAG,MAAM,CAAC"}
+{"version":3,"file":"attributeToUpdate.d.ts","sourceRoot":"","sources":["../../../../client-search/model/attributeToUpdate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,iBAAiB,GAAG,gBAAgB,GAAG,MAAM,CAAC"}

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

@@ -1,18 +1,18 @@
-/**
- * Automatic facet Filter.
- */
-export declare type AutomaticFacetFilter = {
-    /**
-     * Attribute to filter on. This must match a facet placeholder in the Rule\'s pattern.
-     */
-    facet: string;
-    /**
-     * Score for the filter. Typically used for optional or disjunctive filters.
-     */
-    score?: number;
-    /**
-     * Whether the filter is disjunctive (true) or conjunctive (false).
-     */
-    disjunctive?: boolean;
-};
+/**
+ * Automatic facet Filter.
+ */
+export type AutomaticFacetFilter = {
+    /**
+     * Attribute to filter on. This must match a facet placeholder in the Rule\'s pattern.
+     */
+    facet: string;
+    /**
+     * Score for the filter. Typically used for optional or disjunctive filters.
+     */
+    score?: number;
+    /**
+     * Whether the filter is disjunctive (true) or conjunctive (false).
+     */
+    disjunctive?: boolean;
+};
 //# sourceMappingURL=automaticFacetFilter.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"automaticFacetFilter.d.ts","sourceRoot":"","sources":["../../../../client-search/model/automaticFacetFilter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC"}
+{"version":3,"file":"automaticFacetFilter.d.ts","sourceRoot":"","sources":["../../../../client-search/model/automaticFacetFilter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC"}

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

@@ -1,6 +1,6 @@
-import type { AutomaticFacetFilter } from './automaticFacetFilter';
-/**
- * Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern.
- */
-export declare type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];
+import type { AutomaticFacetFilter } from './automaticFacetFilter';
+/**
+ * Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern.
+ */
+export type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];
 //# sourceMappingURL=automaticFacetFilters.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"automaticFacetFilters.d.ts","sourceRoot":"","sources":["../../../../client-search/model/automaticFacetFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,oBAAY,qBAAqB,GAAG,oBAAoB,EAAE,GAAG,MAAM,EAAE,CAAC"}
+{"version":3,"file":"automaticFacetFilters.d.ts","sourceRoot":"","sources":["../../../../client-search/model/automaticFacetFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,EAAE,GAAG,MAAM,EAAE,CAAC"}

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

@@ -1,11 +1,11 @@
-export declare type BaseGetApiKeyResponse = {
-    /**
-     * The API key.
-     */
-    value?: string;
-    /**
-     * Time of the event expressed in milliseconds since the Unix epoch.
-     */
-    createdAt: number;
-};
+export type BaseGetApiKeyResponse = {
+    /**
+     * API key.
+     */
+    value?: string;
+    /**
+     * Timestamp of creation in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time).
+     */
+    createdAt: number;
+};
 //# sourceMappingURL=baseGetApiKeyResponse.d.ts.map