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

package/dist/client-search/src/searchClient.d.ts

@@ -4,7 +4,7 @@ import type { ApiKey } from '../model/apiKey';
 import type { BatchParams } from '../model/batchParams';
 import type { BatchResponse } from '../model/batchResponse';
 import type { BrowseResponse } from '../model/browseResponse';
-import type { BrowseOptions, WaitForTaskOptions, WaitForApiKeyOptions, AddOrUpdateObjectProps, AssignUserIdProps, BatchProps, BatchAssignUserIdsProps, BatchDictionaryEntriesProps, BrowseProps, ClearObjectsProps, ClearRulesProps, ClearSynonymsProps, CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteApiKeyProps, DeleteByProps, DeleteIndexProps, DeleteObjectProps, DeleteRuleProps, DeleteSourceProps, DeleteSynonymProps, GetApiKeyProps, GetLogsProps, GetObjectProps, GetRuleProps, GetSettingsProps, GetSynonymProps, GetTaskProps, GetUserIdProps, HasPendingMappingsProps, ListIndicesProps, ListUserIdsProps, OperationIndexProps, PartialUpdateObjectProps, RemoveUserIdProps, ReplaceSourcesProps, RestoreApiKeyProps, SaveObjectProps, SaveRuleProps, SaveRulesProps, SaveSynonymProps, SaveSynonymsProps, LegacySearchMethodProps, SearchDictionaryEntriesProps, SearchForFacetValuesProps, SearchRulesProps, SearchSingleIndexProps, SearchSynonymsProps, SetSettingsProps, UpdateApiKeyProps } from '../model/clientMethodProps';
+import type { BrowseOptions, ChunkedBatchOptions, ReplaceAllObjectsOptions, ReplaceAllObjectsResponse, WaitForApiKeyOptions, WaitForTaskOptions, AddOrUpdateObjectProps, AssignUserIdProps, BatchProps, BatchAssignUserIdsProps, BatchDictionaryEntriesProps, BrowseProps, ClearObjectsProps, ClearRulesProps, ClearSynonymsProps, CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteApiKeyProps, DeleteByProps, DeleteIndexProps, DeleteObjectProps, DeleteRuleProps, DeleteSourceProps, DeleteSynonymProps, GetApiKeyProps, GetLogsProps, GetObjectProps, GetRuleProps, GetSettingsProps, GetSynonymProps, GetTaskProps, GetUserIdProps, HasPendingMappingsProps, ListIndicesProps, ListUserIdsProps, OperationIndexProps, PartialUpdateObjectProps, RemoveUserIdProps, ReplaceSourcesProps, RestoreApiKeyProps, SaveObjectProps, SaveRuleProps, SaveRulesProps, SaveSynonymProps, SaveSynonymsProps, LegacySearchMethodProps, SearchDictionaryEntriesProps, SearchForFacetValuesProps, SearchRulesProps, SearchSingleIndexProps, SearchSynonymsProps, SetSettingsProps, UpdateApiKeyProps } from '../model/clientMethodProps';
 import type { CreatedAtResponse } from '../model/createdAtResponse';
 import type { DeleteApiKeyResponse } from '../model/deleteApiKeyResponse';
 import type { DeleteSourceResponse } from '../model/deleteSourceResponse';
@@ -30,6 +30,7 @@ import type { ReplaceSourceResponse } from '../model/replaceSourceResponse';
 import type { Rule } from '../model/rule';
 import type { SaveObjectResponse } from '../model/saveObjectResponse';
 import type { SaveSynonymResponse } from '../model/saveSynonymResponse';
+import type { SearchDictionaryEntriesResponse } from '../model/searchDictionaryEntriesResponse';
 import type { SearchForFacetValuesResponse } from '../model/searchForFacetValuesResponse';
 import type { SearchMethodParams } from '../model/searchMethodParams';
 import type { SearchResponse } from '../model/searchResponse';
@@ -45,7 +46,7 @@ import type { UpdatedAtResponse } from '../model/updatedAtResponse';
 import type { UpdatedAtWithObjectIdResponse } from '../model/updatedAtWithObjectIdResponse';
 import type { UpdatedRuleResponse } from '../model/updatedRuleResponse';
 import type { UserId } from '../model/userId';
-export declare const apiClientVersion = "5.0.0-alpha.99";
+export declare const apiClientVersion = "5.0.0-beta.1";
 export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: import("@algolia/client-common").Transporter;
     /**
@@ -71,7 +72,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * Helper: Wait for a task to be published (completed) for a given `indexName` and `taskID`.
      *
      * @summary Helper method that waits for a task to be published (completed).
-     * @param waitForTaskOptions - The waitForTaskOptions object.
+     * @param waitForTaskOptions - The `waitForTaskOptions` object.
      * @param waitForTaskOptions.indexName - The `indexName` where the operation was performed.
      * @param waitForTaskOptions.taskID - The `taskID` returned in the method response.
      * @param waitForTaskOptions.maxRetries - The maximum number of retries. 50 by default.
@@ -83,7 +84,7 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
      *
      * @summary Helper method that waits for an API key task to be processed.
-     * @param waitForApiKeyOptions - The waitForApiKeyOptions object.
+     * @param waitForApiKeyOptions - The `waitForApiKeyOptions` object.
      * @param waitForApiKeyOptions.operation - The `operation` that was done on a `key`.
      * @param waitForApiKeyOptions.key - The `key` that has been added, deleted or updated.
      * @param waitForApiKeyOptions.apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.
@@ -96,23 +97,23 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * Helper: Iterate on the `browse` method of the client to allow aggregating objects of an index.
      *
      * @summary Helper method that iterates on the `browse` method.
-     * @param browseObjects - The browseObjects object.
+     * @param browseObjects - The `browseObjects` object.
      * @param browseObjects.indexName - The index in which to perform the request.
      * @param browseObjects.browseParams - The `browse` parameters.
      * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is no `cursor` in the response.
      * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
      */
-    browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<BrowseResponse<T>>, "aggregator">> & BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T>>;
+    browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: BrowseOptions<BrowseResponse<T>> & BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T>>;
     /**
      * Helper: Iterate on the `searchRules` method of the client to allow aggregating rules of an index.
      *
      * @summary Helper method that iterates on the `searchRules` method.
-     * @param browseObjects - The browseObjects object.
-     * @param browseObjects.indexName - The index in which to perform the request.
-     * @param browseObjects.searchRulesParams - The `searchRules` method parameters.
-     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is less hits returned than the number of maximum hits (1000).
-     * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
+     * @param browseRules - The `browseRules` object.
+     * @param browseRules.indexName - The index in which to perform the request.
+     * @param browseRules.searchRulesParams - The `searchRules` method parameters.
+     * @param browseRules.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is less hits returned than the number of maximum hits (1000).
+     * @param browseRules.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchRules` method and merged with the transporter requestOptions.
      */
     browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: BrowseOptions<SearchRulesResponse> & SearchRulesProps, requestOptions?: RequestOptions): Promise<SearchRulesResponse>;
@@ -120,11 +121,11 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      * Helper: Iterate on the `searchSynonyms` method of the client to allow aggregating rules of an index.
      *
      * @summary Helper method that iterates on the `searchSynonyms` method.
-     * @param browseObjects - The browseObjects object.
-     * @param browseObjects.indexName - The index in which to perform the request.
-     * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is less hits returned than the number of maximum hits (1000).
-     * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
-     * @param browseObjects.searchSynonymsParams - The `searchSynonyms` method parameters.
+     * @param browseSynonyms - The `browseSynonyms` object.
+     * @param browseSynonyms.indexName - The index in which to perform the request.
+     * @param browseSynonyms.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is less hits returned than the number of maximum hits (1000).
+     * @param browseSynonyms.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
+     * @param browseSynonyms.searchSynonymsParams - The `searchSynonyms` method parameters.
      * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `searchSynonyms` method and merged with the transporter requestOptions.
      */
     browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: BrowseOptions<SearchSynonymsResponse> & SearchSynonymsProps, requestOptions?: RequestOptions): Promise<SearchSynonymsResponse>;
@@ -151,115 +152,157 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
         results: SearchForFacetValuesResponse[];
     }>;
     /**
-     * Add a new API key with specific permissions and restrictions. The request must be authenticated with the admin API key. The response returns an API key string.
+     * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
+     *
+     * @summary Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
+     * @param chunkedBatch - The `chunkedBatch` object.
+     * @param chunkedBatch.indexName - The `indexName` to replace `objects` in.
+     * @param chunkedBatch.objects - The array of `objects` to store in the given Algolia `indexName`.
+     * @param chunkedBatch.action - The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.
+     * @param chunkedBatch.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
+     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
+     */
+    chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: ChunkedBatchOptions, requestOptions?: RequestOptions): Promise<BatchResponse[]>;
+    /**
+     * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
+     *
+     * @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
+     * @param replaceAllObjects - The `replaceAllObjects` object.
+     * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
+     * @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
+     * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
+     */
+    replaceAllObjects({ indexName, objects, batchSize }: ReplaceAllObjectsOptions, requestOptions?: RequestOptions): Promise<ReplaceAllObjectsResponse>;
+    /**
+     * Creates a new API key with specific permissions and restrictions.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Add API key.
      * @param apiKey - The apiKey object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     addApiKey(apiKey: ApiKey, requestOptions?: RequestOptions): Promise<AddApiKeyResponse>;
     /**
-     * If you use an existing `objectID`, the existing record will be replaced with the new one.  To update only some attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead.  To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch).
+     * If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index.  To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
+     *
+     * Required API Key ACLs:
+     * - addObject.
      *
-     * @summary Add or update a record (using objectID).
      * @param addOrUpdateObject - The addOrUpdateObject object.
-     * @param addOrUpdateObject.indexName - Index on which to perform the request.
-     * @param addOrUpdateObject.objectID - Unique record (object) identifier.
-     * @param addOrUpdateObject.body - Algolia record.
+     * @param addOrUpdateObject.indexName - Name of the index on which to perform the operation.
+     * @param addOrUpdateObject.objectID - Unique record identifier.
+     * @param addOrUpdateObject.body - The record, a schemaless object with attributes that are useful in the context of search and discovery.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     addOrUpdateObject({ indexName, objectID, body }: AddOrUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
     /**
-     * Add a source to the list of allowed sources.
+     * Adds a source to the list of allowed sources.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Add a source.
      * @param source - Source to add.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     appendSource(source: Source, requestOptions?: RequestOptions): Promise<CreatedAtResponse>;
     /**
-     * Assign or move a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID.
+     * Assigns or moves a user ID to a cluster.  The time it takes to move a user is proportional to the amount of data linked to the user ID.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Assign or move a user ID.
      * @param assignUserId - The assignUserId object.
-     * @param assignUserId.xAlgoliaUserID - UserID to assign.
+     * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     assignUserId({ xAlgoliaUserID, assignUserIdParams }: AssignUserIdProps, requestOptions?: RequestOptions): Promise<CreatedAtResponse>;
     /**
-     * To reduce the time spent on network round trips, you can perform several write actions in a single API call. Actions are applied in the order they are specified. The supported `action`s are equivalent to the individual operations of the same name.
+     * Adds, updates, or deletes records in one index with a single API request.  Batching index updates reduces latency and increases data integrity.  - Actions are applied in the order they\'re specified. - Actions are equivalent to the individual API requests of the same name.
      *
-     * @summary Batch write operations on one index.
      * @param batch - The batch object.
-     * @param batch.indexName - Index on which to perform the request.
+     * @param batch.indexName - Name of the index on which to perform the operation.
      * @param batch.batchWriteParams - The batchWriteParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     batch({ indexName, batchWriteParams }: BatchProps, requestOptions?: RequestOptions): Promise<BatchResponse>;
     /**
-     * Assign multiple user IDs to a cluster. **You can\'t _move_ users with this operation.**.
+     * Assigns multiple user IDs to a cluster.  **You can\'t move users with this operation**.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Batch assign userIDs.
      * @param batchAssignUserIds - The batchAssignUserIds object.
-     * @param batchAssignUserIds.xAlgoliaUserID - UserID to assign.
+     * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: BatchAssignUserIdsProps, requestOptions?: RequestOptions): Promise<CreatedAtResponse>;
     /**
-     * Add or remove a batch of dictionary entries.
+     * Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Batch dictionary entries.
      * @param batchDictionaryEntries - The batchDictionaryEntries object.
-     * @param batchDictionaryEntries.dictionaryName - Dictionary to search in.
+     * @param batchDictionaryEntries.dictionaryName - Dictionary type in which to search.
      * @param batchDictionaryEntries.batchDictionaryEntriesParams - The batchDictionaryEntriesParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: BatchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn\'t support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance.
+     * Retrieves records from an index, up to 1,000 per request.  While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices.  - The Analytics API doesn\'t collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There\'s no ranking for: typo-tolerance, number of matched words, proximity, geo distance.
+     *
+     * Required API Key ACLs:
+     * - browse.
      *
-     * @summary Get all records from an index.
      * @param browse - The browse object.
-     * @param browse.indexName - Index on which to perform the request.
+     * @param browse.indexName - Name of the index on which to perform the operation.
      * @param browse.browseParams - The browseParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     browse<T_2>({ indexName, browseParams }: BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T_2>>;
     /**
-     * Delete the records but leave settings and index-specific API keys untouched.
+     * Deletes only the records from an index while keeping settings, synonyms, and rules.
+     *
+     * Required API Key ACLs:
+     * - deleteIndex.
      *
-     * @summary Delete all records from an index.
      * @param clearObjects - The clearObjects object.
-     * @param clearObjects.indexName - Index on which to perform the request.
+     * @param clearObjects.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     clearObjects({ indexName }: ClearObjectsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Delete all rules in the index.
+     * Deletes all rules from the index.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Delete all rules.
      * @param clearRules - The clearRules object.
-     * @param clearRules.indexName - Index on which to perform the request.
-     * @param clearRules.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
+     * @param clearRules.indexName - Name of the index on which to perform the operation.
+     * @param clearRules.forwardToReplicas - Whether changes are applied to replica indices.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     clearRules({ indexName, forwardToReplicas }: ClearRulesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Delete all synonyms in the index.
+     * Deletes all synonyms from the index.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Delete all synonyms.
      * @param clearSynonyms - The clearSynonyms object.
-     * @param clearSynonyms.indexName - Index on which to perform the request.
-     * @param clearSynonyms.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
+     * @param clearSynonyms.indexName - Name of the index on which to perform the operation.
+     * @param clearSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     clearSynonyms({ indexName, forwardToReplicas }: ClearSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -269,7 +312,6 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -279,7 +321,6 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary 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.
@@ -290,7 +331,6 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -299,438 +339,524 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      */
     customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * Delete an existing API key. The request must be authenticated with the admin API key.
+     * Deletes the API key.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Delete API key.
      * @param deleteApiKey - The deleteApiKey object.
      * @param deleteApiKey.key - API key.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteApiKey({ key }: DeleteApiKeyProps, requestOptions?: RequestOptions): Promise<DeleteApiKeyResponse>;
     /**
-     * This operation doesn\'t support all the query options, only its filters (numeric, facet, or tag) and geo queries. It doesn\'t accept empty filters or queries.
+     * This operation doesn\'t accept empty queries or filters.  It\'s more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).
+     *
+     * Required API Key ACLs:
+     * - deleteIndex.
      *
-     * @summary Delete all records matching a query.
      * @param deleteBy - The deleteBy object.
-     * @param deleteBy.indexName - Index on which to perform the request.
+     * @param deleteBy.indexName - Name of the index on which to perform the operation.
      * @param deleteBy.deleteByParams - The deleteByParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteBy({ indexName, deleteByParams }: DeleteByProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
     /**
-     * Delete an existing index.
+     * Deletes an index and all its settings.  - Deleting an index doesn\'t delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it.   For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).
+     *
+     * Required API Key ACLs:
+     * - deleteIndex.
      *
-     * @summary Delete index.
      * @param deleteIndex - The deleteIndex object.
-     * @param deleteIndex.indexName - Index on which to perform the request.
+     * @param deleteIndex.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteIndex({ indexName }: DeleteIndexProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
     /**
-     * To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead.
+     * Deletes a record by its object ID.  To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).
+     *
+     * Required API Key ACLs:
+     * - deleteObject.
      *
-     * @summary Delete a record.
      * @param deleteObject - The deleteObject object.
-     * @param deleteObject.indexName - Index on which to perform the request.
-     * @param deleteObject.objectID - Unique record (object) identifier.
+     * @param deleteObject.indexName - Name of the index on which to perform the operation.
+     * @param deleteObject.objectID - Unique record identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteObject({ indexName, objectID }: DeleteObjectProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
     /**
-     * Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).
+     * Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](#tag/Rules/operation/searchRules).
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Delete a rule.
      * @param deleteRule - The deleteRule object.
-     * @param deleteRule.indexName - Index on which to perform the request.
+     * @param deleteRule.indexName - Name of the index on which to perform the operation.
      * @param deleteRule.objectID - Unique identifier of a rule object.
-     * @param deleteRule.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
+     * @param deleteRule.forwardToReplicas - Whether changes are applied to replica indices.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteRule({ indexName, objectID, forwardToReplicas }: DeleteRuleProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Remove a source from the list of allowed sources.
+     * Deletes a source from the list of allowed sources.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Remove a source.
      * @param deleteSource - The deleteSource object.
      * @param deleteSource.source - IP address range of the source.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteSource({ source }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteSourceResponse>;
     /**
-     * Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
+     * Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Delete a synonym.
      * @param deleteSynonym - The deleteSynonym object.
-     * @param deleteSynonym.indexName - Index on which to perform the request.
+     * @param deleteSynonym.indexName - Name of the index on which to perform the operation.
      * @param deleteSynonym.objectID - Unique identifier of a synonym object.
-     * @param deleteSynonym.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
+     * @param deleteSynonym.forwardToReplicas - Whether changes are applied to replica indices.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteSynonym({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
     /**
-     * Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key.
+     * Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key.
      *
-     * @summary Get API key permissions.
      * @param getApiKey - The getApiKey object.
      * @param getApiKey.key - API key.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getApiKey({ key }: GetApiKeyProps, requestOptions?: RequestOptions): Promise<GetApiKeyResponse>;
     /**
-     * Lists Algolia\'s [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language\'s [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features.
+     * Lists supported languages with their supported dictionary types and number of custom entries.
+     *
+     * Required API Key ACLs:
+     * - settings.
      *
-     * @summary List available languages.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getDictionaryLanguages(requestOptions?: RequestOptions): Promise<Record<string, Languages>>;
     /**
-     * Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings).
+     * Retrieves the languages for which standard dictionary entries are turned off.
+     *
+     * Required API Key ACLs:
+     * - settings.
      *
-     * @summary Get stop word settings.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getDictionarySettings(requestOptions?: RequestOptions): Promise<GetDictionarySettingsResponse>;
     /**
-     * The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There\'s also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn\'t appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN\'s endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers).
+     * The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).  - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn\'t appear in the logs itself.
+     *
+     * Required API Key ACLs:
+     * - logs.
      *
-     * @summary Return the latest log entries.
      * @param getLogs - The getLogs object.
-     * @param getLogs.offset - First log entry to retrieve. Sorted by decreasing date with 0 being the most recent.
+     * @param getLogs.offset - First log entry to retrieve. The most recent entries are listed first.
      * @param getLogs.length - Maximum number of entries to retrieve.
-     * @param getLogs.indexName - Index for which log entries should be retrieved. When omitted, log entries are retrieved for all indices.
-     * @param getLogs.type - Type of log entries to retrieve. When omitted, all log entries are retrieved.
+     * @param getLogs.indexName - Index for which to retrieve log entries. By default, log entries are retrieved for all indices.
+     * @param getLogs.type - Type of log entries to retrieve. By default, all log entries are retrieved.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getLogs({ offset, length, indexName, type }?: GetLogsProps, requestOptions?: RequestOptions | undefined): Promise<GetLogsResponse>;
     /**
-     * To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
+     * Retrieves one record by its object ID.  To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
+     *
+     * Required API Key ACLs:
+     * - search.
      *
-     * @summary Get a record.
      * @param getObject - The getObject object.
-     * @param getObject.indexName - Index on which to perform the request.
-     * @param getObject.objectID - Unique record (object) identifier.
-     * @param getObject.attributesToRetrieve - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved, even when not specified. [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) won\'t be retrieved unless the request is authenticated with the admin API key.
+     * @param getObject.indexName - Name of the index on which to perform the operation.
+     * @param getObject.objectID - Unique record identifier.
+     * @param getObject.attributesToRetrieve - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned.  `objectID` is always retrieved.  Attributes included in `unretrievableAttributes` won\'t be retrieved unless the request is authenticated with the admin API key.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getObject({ indexName, objectID, attributesToRetrieve }: GetObjectProps, requestOptions?: RequestOptions): Promise<Record<string, string>>;
     /**
-     * Retrieve one or more records, potentially from different indices, in a single API operation. Results will be received in the same order as the requests.
+     * Retrieves one or more records, potentially from different indices.  Records are returned in the same order as the requests.
+     *
+     * Required API Key ACLs:
+     * - search.
      *
-     * @summary Get multiple records.
      * @param getObjectsParams - Request object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getObjects<T_3>(getObjectsParams: GetObjectsParams, requestOptions?: RequestOptions): Promise<GetObjectsResponse<T_3>>;
     /**
-     * Get a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).
+     * Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
+     *
+     * Required API Key ACLs:
+     * - settings.
      *
-     * @summary Get a rule.
      * @param getRule - The getRule object.
-     * @param getRule.indexName - Index on which to perform the request.
+     * @param getRule.indexName - Name of the index on which to perform the operation.
      * @param getRule.objectID - Unique identifier of a rule object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getRule({ indexName, objectID }: GetRuleProps, requestOptions?: RequestOptions): Promise<Rule>;
     /**
-     * Return an object containing an index\'s [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
+     * Retrieves an object with non-null index settings.
+     *
+     * Required API Key ACLs:
+     * - search.
      *
-     * @summary Get index settings.
      * @param getSettings - The getSettings object.
-     * @param getSettings.indexName - Index on which to perform the request.
+     * @param getSettings.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getSettings({ indexName }: GetSettingsProps, requestOptions?: RequestOptions): Promise<IndexSettings>;
     /**
-     * Get all allowed sources (IP addresses).
+     * Retrieves all allowed IP addresses with access to your application.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Get all allowed IP addresses.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getSources(requestOptions?: RequestOptions): Promise<Source[]>;
     /**
-     * Get a syonym by its `objectID`. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
+     * Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).
+     *
+     * Required API Key ACLs:
+     * - settings.
      *
-     * @summary Get a synonym object.
      * @param getSynonym - The getSynonym object.
-     * @param getSynonym.indexName - Index on which to perform the request.
+     * @param getSynonym.indexName - Name of the index on which to perform the operation.
      * @param getSynonym.objectID - Unique identifier of a synonym object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getSynonym({ indexName, objectID }: GetSynonymProps, requestOptions?: RequestOptions): Promise<SynonymHit>;
     /**
-     * Some operations, such as copying an index, will respond with a `taskID` value. Use this value here to check the status of that task.
+     * Checks the status of a given task.  Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server.  The indexing tasks\' responses include a task ID that you can use to check the status.
+     *
+     * Required API Key ACLs:
+     * - addObject.
      *
-     * @summary Check a task\'s status.
      * @param getTask - The getTask object.
-     * @param getTask.indexName - Index on which to perform the request.
+     * @param getTask.indexName - Name of the index on which to perform the operation.
      * @param getTask.taskID - Unique task identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getTask({ indexName, taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
     /**
-     * Get the IDs of the 10 users with the highest number of records per cluster. Since it can take up to a few seconds to get the data from the different clusters, the response isn\'t real-time.
+     * Get the IDs of the 10 users with the highest number of records per cluster.  Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Get top userID.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getTopUserIds(requestOptions?: RequestOptions): Promise<GetTopUserIdsResponse>;
     /**
-     * Returns the userID data stored in the mapping. Since it can take up to a few seconds to get the data from the different clusters, the response isn\'t real-time.
+     * Returns the user ID data stored in the mapping.  Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Get userID.
      * @param getUserId - The getUserId object.
-     * @param getUserId.userID - UserID to assign.
+     * @param getUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getUserId({ userID }: GetUserIdProps, requestOptions?: RequestOptions): Promise<UserId>;
     /**
      * To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
      *
-     * @summary Get migration and user mapping status.
+     * Required API Key ACLs:
+     * - admin.
+     *
      * @param hasPendingMappings - The hasPendingMappings object.
-     * @param hasPendingMappings.getClusters - Indicates whether to include the cluster\'s pending mapping state in the response.
+     * @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     hasPendingMappings({ getClusters }?: HasPendingMappingsProps, requestOptions?: RequestOptions | undefined): Promise<HasPendingMappingsResponse>;
     /**
-     * List all API keys associated with your Algolia application, including their permissions and restrictions.
+     * Lists all API keys associated with your Algolia application, including their permissions and restrictions.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary List API keys.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listApiKeys(requestOptions?: RequestOptions): Promise<ListApiKeysResponse>;
     /**
-     * List the available clusters in a multi-cluster setup.
+     * Lists the available clusters in a multi-cluster setup.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary List clusters.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listClusters(requestOptions?: RequestOptions): Promise<ListClustersResponse>;
     /**
-     * List indices in an Algolia application.
+     * Lists all indices in the current Algolia application.  The request follows any index restrictions of the API key you use to make the request.
+     *
+     * Required API Key ACLs:
+     * - listIndexes.
      *
-     * @summary List indices.
      * @param listIndices - The listIndices object.
-     * @param listIndices.page - Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated.
-     * @param listIndices.hitsPerPage - Maximum number of hits per page.
+     * @param listIndices.page - Requested page of the API response. If `null`, the API response is not paginated.
+     * @param listIndices.hitsPerPage - Number of hits per page.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listIndices({ page, hitsPerPage }?: ListIndicesProps, requestOptions?: RequestOptions | undefined): Promise<ListIndicesResponse>;
     /**
-     * List the userIDs assigned to a multi-cluster application. Since it can take up to a few seconds to get the data from the different clusters, the response isn\'t real-time.
+     * Lists the userIDs assigned to a multi-cluster application.  Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary List userIDs.
      * @param listUserIds - The listUserIds object.
-     * @param listUserIds.page - Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated.
-     * @param listUserIds.hitsPerPage - Maximum number of hits per page.
+     * @param listUserIds.page - Requested page of the API response. If `null`, the API response is not paginated.
+     * @param listUserIds.hitsPerPage - Number of hits per page.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listUserIds({ page, hitsPerPage }?: ListUserIdsProps, requestOptions?: RequestOptions | undefined): Promise<ListUserIdsResponse>;
     /**
-     * To reduce the time spent on network round trips, you can perform several write actions in a single request. It\'s a multi-index version of the [`batch` operation](#tag/Records/operation/batch). Actions are applied in the order they are specified. The supported actions are equivalent to the individual operations of the same name.
+     * Adds, updates, or deletes records in multiple indices with a single API request.  - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name.
      *
-     * @summary Batch write operations on multiple indices.
      * @param batchParams - The batchParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     multipleBatch(batchParams: BatchParams, requestOptions?: RequestOptions): Promise<MultipleBatchResponse>;
     /**
-     * This `operation`, _copy_ or _move_, will copy or move a source index\'s (`IndexName`) records, settings, synonyms, and rules to a `destination` index. If the destination index exists, it will be replaced, except for index-specific API keys and analytics data. If the destination index doesn\'t exist, it will be created.  The choice between moving or copying an index depends on your needs. Choose:  - **Move** to rename an index. - **Copy** to create a new index with the same records and configuration as an existing one.  > **Note**: When considering copying or moving, be aware of the [rate limitations](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits) on these processes and the [impact on your analytics data](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/concepts/indices-analytics/).
+     * Copies or moves (renames) an index within the same Algolia application.  - Existing destination indices are overwritten, except for index-specific API keys and analytics data. - If the destination index doesn\'t exist yet, it\'ll be created.  **Copy**  - Copying a source index that doesn\'t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can\'t copy the `enableReRanking`, `mode`, and `replicas` settings. - You can\'t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/)  **Move**  - Moving a source index that doesn\'t exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name.   To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
+     *
+     * Required API Key ACLs:
+     * - addObject.
      *
-     * @summary Copy, move, or rename an index.
      * @param operationIndex - The operationIndex object.
-     * @param operationIndex.indexName - Index on which to perform the request.
+     * @param operationIndex.indexName - Name of the index on which to perform the operation.
      * @param operationIndex.operationIndexParams - The operationIndexParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     operationIndex({ indexName, operationIndexParams }: OperationIndexProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Add new attributes or update current ones in an existing record. You can use any first-level attribute but not nested attributes. If you specify a [nested attribute](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/creating-and-using-nested-attributes/), the engine treats it as a replacement for its first-level ancestor.
+     * Adds new attributes to a record, or update existing ones.  - If a record with the specified object ID doesn\'t exist,   a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn\'t exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes.   If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.
+     *
+     * Required API Key ACLs:
+     * - addObject.
      *
-     * @summary Update record attributes.
      * @param partialUpdateObject - The partialUpdateObject object.
-     * @param partialUpdateObject.indexName - Index on which to perform the request.
-     * @param partialUpdateObject.objectID - Unique record (object) identifier.
-     * @param partialUpdateObject.attributesToUpdate - Object with attributes to update.
-     * @param partialUpdateObject.createIfNotExists - Indicates whether to create a new record if it doesn\'t exist yet.
+     * @param partialUpdateObject.indexName - Name of the index on which to perform the operation.
+     * @param partialUpdateObject.objectID - Unique record identifier.
+     * @param partialUpdateObject.attributesToUpdate - Attributes with their values.
+     * @param partialUpdateObject.createIfNotExists - Whether to create a new record if it doesn\'t exist.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: PartialUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
     /**
-     * Remove a userID and its associated data from the multi-clusters.
+     * Deletes a user ID and its associated data from the clusters.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Remove userID.
      * @param removeUserId - The removeUserId object.
-     * @param removeUserId.userID - UserID to assign.
+     * @param removeUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     removeUserId({ userID }: RemoveUserIdProps, requestOptions?: RequestOptions): Promise<RemoveUserIdResponse>;
     /**
-     * Replace all allowed sources.
+     * Replaces the list of allowed sources.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Replace all sources.
      * @param replaceSources - The replaceSources object.
      * @param replaceSources.source - Allowed sources.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     replaceSources({ source }: ReplaceSourcesProps, requestOptions?: RequestOptions): Promise<ReplaceSourceResponse>;
     /**
-     * Restore a deleted API key, along with its associated permissions. The request must be authenticated with the admin API key.
+     * Restores a deleted API key.  Restoring resets the `validity` attribute to `0`.  Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can\'t be restored.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Restore API key.
      * @param restoreApiKey - The restoreApiKey object.
      * @param restoreApiKey.key - API key.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     restoreApiKey({ key }: RestoreApiKeyProps, requestOptions?: RequestOptions): Promise<AddApiKeyResponse>;
     /**
-     * Add a record (object) to an index or replace it. If the record doesn\'t contain an `objectID`, Algolia automatically adds it. If you use an existing `objectID`, the existing record is replaced with the new one. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch).
+     * Adds a record to an index or replace it.  - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created.  To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
+     *
+     * Required API Key ACLs:
+     * - addObject.
      *
-     * @summary Add or update a record.
      * @param saveObject - The saveObject object.
-     * @param saveObject.indexName - Index on which to perform the request.
-     * @param saveObject.body - The Algolia record.
+     * @param saveObject.indexName - Name of the index on which to perform the operation.
+     * @param saveObject.body - The record, a schemaless object with attributes that are useful in the context of search and discovery.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveObject({ indexName, body }: SaveObjectProps, requestOptions?: RequestOptions): Promise<SaveObjectResponse>;
     /**
-     * To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
+     * If a rule with the specified object ID doesn\'t exist, it\'s created. Otherwise, the existing rule is replaced.  To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Create or update a rule.
      * @param saveRule - The saveRule object.
-     * @param saveRule.indexName - Index on which to perform the request.
+     * @param saveRule.indexName - Name of the index on which to perform the operation.
      * @param saveRule.objectID - Unique identifier of a rule object.
      * @param saveRule.rule - The rule object.
-     * @param saveRule.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
+     * @param saveRule.forwardToReplicas - Whether changes are applied to replica indices.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveRule({ indexName, objectID, rule, forwardToReplicas }: SaveRuleProps, requestOptions?: RequestOptions): Promise<UpdatedRuleResponse>;
     /**
-     * Create or update multiple rules.
+     * Create or update multiple rules.  If a rule with the specified object ID doesn\'t exist, Algolia creates a new one. Otherwise, existing rules are replaced.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Save a batch of rules.
      * @param saveRules - The saveRules object.
-     * @param saveRules.indexName - Index on which to perform the request.
+     * @param saveRules.indexName - Name of the index on which to perform the operation.
      * @param saveRules.rules - The rules object.
-     * @param saveRules.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
-     * @param saveRules.clearExistingRules - Indicates whether existing rules should be deleted before adding this batch.
+     * @param saveRules.forwardToReplicas - Whether changes are applied to replica indices.
+     * @param saveRules.clearExistingRules - Whether existing rules should be deleted before adding this batch.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: SaveRulesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it. If the synonym `objectID` doesn\'t exist, Algolia adds a new one. If you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).
+     * If a synonym with the specified object ID doesn\'t exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Save a synonym.
      * @param saveSynonym - The saveSynonym object.
-     * @param saveSynonym.indexName - Index on which to perform the request.
+     * @param saveSynonym.indexName - Name of the index on which to perform the operation.
      * @param saveSynonym.objectID - Unique identifier of a synonym object.
      * @param saveSynonym.synonymHit - The synonymHit object.
-     * @param saveSynonym.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
+     * @param saveSynonym.forwardToReplicas - Whether changes are applied to replica indices.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: SaveSynonymProps, requestOptions?: RequestOptions): Promise<SaveSynonymResponse>;
     /**
-     * Create or update multiple synonyms.
+     * If a synonym with the `objectID` doesn\'t exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Save a batch of synonyms.
      * @param saveSynonyms - The saveSynonyms object.
-     * @param saveSynonyms.indexName - Index on which to perform the request.
+     * @param saveSynonyms.indexName - Name of the index on which to perform the operation.
      * @param saveSynonyms.synonymHit - The synonymHit object.
-     * @param saveSynonyms.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
-     * @param saveSynonyms.replaceExistingSynonyms - Indicates whether to replace all synonyms in the index with the ones sent with this request.
+     * @param saveSynonyms.forwardToReplicas - Whether changes are applied to replica indices.
+     * @param saveSynonyms.replaceExistingSynonyms - Whether to replace all synonyms in the index with the ones sent with this request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: SaveSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Send multiple search queries to one or more indices.
+     * Sends multiple search request to one or more indices.  This can be useful in these cases:  - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
      *
-     * @summary Search multiple indices.
-     * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+     * Required API Key ACLs:
+     * - search.
+     *
+     * @param searchMethodParams - Muli-search request body. Results are returned in the same order as the requests.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search<T_4>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T_4>>;
     /**
-     * Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries.
+     * Searches for standard and custom dictionary entries.
+     *
+     * Required API Key ACLs:
+     * - settings.
      *
-     * @summary Search dictionary entries.
      * @param searchDictionaryEntries - The searchDictionaryEntries object.
-     * @param searchDictionaryEntries.dictionaryName - Dictionary to search in.
+     * @param searchDictionaryEntries.dictionaryName - Dictionary type in which to search.
      * @param searchDictionaryEntries.searchDictionaryEntriesParams - The searchDictionaryEntriesParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: SearchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
+    searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: SearchDictionaryEntriesProps, requestOptions?: RequestOptions): Promise<SearchDictionaryEntriesResponse>;
     /**
-     * [Search for a facet\'s values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria. > **Note**: Pagination isn\'t supported (`page` and `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`.
+     * Searches for values of a specified facet attribute.  - By default, facet values are sorted by decreasing count.   You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn\'t work if you have **more than 65 searchable facets and searchable attributes combined**.
+     *
+     * Required API Key ACLs:
+     * - search.
      *
-     * @summary Search for facet values.
      * @param searchForFacetValues - The searchForFacetValues object.
-     * @param searchForFacetValues.indexName - Index on which to perform the request.
-     * @param searchForFacetValues.facetName - Facet name.
+     * @param searchForFacetValues.indexName - Name of the index on which to perform the operation.
+     * @param searchForFacetValues.facetName - Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
      * @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: SearchForFacetValuesProps, requestOptions?: RequestOptions): Promise<SearchForFacetValuesResponse>;
     /**
-     * Search for rules in your index. You can control the search with parameters. To list all rules, send an empty request body.
+     * Searches for rules in your index.
+     *
+     * Required API Key ACLs:
+     * - settings.
      *
-     * @summary Search for rules.
      * @param searchRules - The searchRules object.
-     * @param searchRules.indexName - Index on which to perform the request.
+     * @param searchRules.indexName - Name of the index on which to perform the operation.
      * @param searchRules.searchRulesParams - The searchRulesParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchRules({ indexName, searchRulesParams }: SearchRulesProps, requestOptions?: RequestOptions): Promise<SearchRulesResponse>;
     /**
-     * Return records that match the query.
+     * Searches a single index and return matching search results (_hits_).  This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.
+     *
+     * Required API Key ACLs:
+     * - search.
      *
-     * @summary Search an index.
      * @param searchSingleIndex - The searchSingleIndex object.
-     * @param searchSingleIndex.indexName - Index on which to perform the request.
+     * @param searchSingleIndex.indexName - Name of the index on which to perform the operation.
      * @param searchSingleIndex.searchParams - The searchParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchSingleIndex<T_5>({ indexName, searchParams }: SearchSingleIndexProps, requestOptions?: RequestOptions): Promise<SearchResponse<T_5>>;
     /**
-     * Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body.
+     * Searches for synonyms in your index.
+     *
+     * Required API Key ACLs:
+     * - settings.
      *
-     * @summary Search for synonyms.
      * @param searchSynonyms - The searchSynonyms object.
-     * @param searchSynonyms.indexName - Index on which to perform the request.
+     * @param searchSynonyms.indexName - Name of the index on which to perform the operation.
      * @param searchSynonyms.searchSynonymsParams - Body of the `searchSynonyms` operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchSynonyms({ indexName, searchSynonymsParams }: SearchSynonymsProps, requestOptions?: RequestOptions): Promise<SearchSynonymsResponse>;
     /**
-     * Since it can take up to a few seconds to get the data from the different clusters, the response isn\'t real-time. To ensure rapid updates, the user IDs index isn\'t built at the same time as the mapping. Instead, it\'s built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).
+     * Since it can take a few seconds to get the data from the different clusters, the response isn\'t real-time.  To ensure rapid updates, the user IDs index isn\'t built at the same time as the mapping. Instead, it\'s built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Search for a user ID.
      * @param searchUserIdsParams - The searchUserIdsParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchUserIds(searchUserIdsParams: SearchUserIdsParams, requestOptions?: RequestOptions): Promise<SearchUserIdsResponse>;
     /**
-     * Set stop word settings for a specific language.
+     * Turns standard stop word dictionary entries on or off for a given language.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Set stop word settings.
      * @param dictionarySettingsParams - The dictionarySettingsParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     setDictionarySettings(dictionarySettingsParams: DictionarySettingsParams, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). Specifying null for a setting resets it to its default value.
+     * Update the specified index settings.  Index settings that you don\'t specify are left unchanged. Specify `null` to reset a setting to its default value.  For best performance, update the index settings before you add new records to your index.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Update index settings.
      * @param setSettings - The setSettings object.
-     * @param setSettings.indexName - Index on which to perform the request.
+     * @param setSettings.indexName - Name of the index on which to perform the operation.
      * @param setSettings.indexSettings - The indexSettings object.
-     * @param setSettings.forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices.
+     * @param setSettings.forwardToReplicas - Whether changes are applied to replica indices.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     setSettings({ indexName, indexSettings, forwardToReplicas }: SetSettingsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
     /**
-     * Replace the permissions of an existing API key. Any unspecified parameter resets that permission to its default value. The request must be authenticated with the admin API key.
+     * Replaces the permissions of an existing API key.  Any unspecified attribute resets that attribute to its default value.
+     *
+     * Required API Key ACLs:
+     * - admin.
      *
-     * @summary Update an API key.
      * @param updateApiKey - The updateApiKey object.
      * @param updateApiKey.key - API key.
      * @param updateApiKey.apiKey - The apiKey object.
@@ -738,8 +864,4 @@ export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyO
      */
     updateApiKey({ key, apiKey }: UpdateApiKeyProps, requestOptions?: RequestOptions): Promise<UpdateApiKeyResponse>;
 };
-/**
- * The client type.
- */
-export type SearchClient = ReturnType<typeof createSearchClient>;
 //# sourceMappingURL=searchClient.d.ts.map