algoliasearch 5.0.0-alpha.11 → 5.0.0-alpha.110

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

@@ -1,724 +1,867 @@
-import type { CreateClientOptions, RequestOptions, ApiError } from '@algolia/client-common';
-import type { AddApiKeyResponse } from '../model/addApiKeyResponse';
-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, ClearAllSynonymsProps, ClearObjectsProps, ClearRulesProps, DelProps, DeleteApiKeyProps, DeleteByProps, DeleteIndexProps, DeleteObjectProps, DeleteRuleProps, DeleteSourceProps, DeleteSynonymProps, GetProps, GetApiKeyProps, GetLogsProps, GetObjectProps, GetRuleProps, GetSettingsProps, GetSynonymProps, GetTaskProps, GetUserIdProps, HasPendingMappingsProps, ListIndicesProps, ListUserIdsProps, OperationIndexProps, PartialUpdateObjectProps, PostProps, PutProps, 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';
-import type { DeletedAtResponse } from '../model/deletedAtResponse';
-import type { DictionarySettingsParams } from '../model/dictionarySettingsParams';
-import type { GetApiKeyResponse } from '../model/getApiKeyResponse';
-import type { GetDictionarySettingsResponse } from '../model/getDictionarySettingsResponse';
-import type { GetLogsResponse } from '../model/getLogsResponse';
-import type { GetObjectsParams } from '../model/getObjectsParams';
-import type { GetObjectsResponse } from '../model/getObjectsResponse';
-import type { GetTaskResponse } from '../model/getTaskResponse';
-import type { GetTopUserIdsResponse } from '../model/getTopUserIdsResponse';
-import type { HasPendingMappingsResponse } from '../model/hasPendingMappingsResponse';
-import type { IndexSettings } from '../model/indexSettings';
-import type { Languages } from '../model/languages';
-import type { ListApiKeysResponse } from '../model/listApiKeysResponse';
-import type { ListClustersResponse } from '../model/listClustersResponse';
-import type { ListIndicesResponse } from '../model/listIndicesResponse';
-import type { ListUserIdsResponse } from '../model/listUserIdsResponse';
-import type { MultipleBatchResponse } from '../model/multipleBatchResponse';
-import type { RemoveUserIdResponse } from '../model/removeUserIdResponse';
-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 { SearchForFacetValuesResponse } from '../model/searchForFacetValuesResponse';
-import type { SearchMethodParams } from '../model/searchMethodParams';
-import type { SearchResponse } from '../model/searchResponse';
-import type { SearchResponses } from '../model/searchResponses';
-import type { SearchRulesResponse } from '../model/searchRulesResponse';
-import type { SearchSynonymsResponse } from '../model/searchSynonymsResponse';
-import type { SearchUserIdsParams } from '../model/searchUserIdsParams';
-import type { SearchUserIdsResponse } from '../model/searchUserIdsResponse';
-import type { Source } from '../model/source';
-import type { SynonymHit } from '../model/synonymHit';
-import type { UpdateApiKeyResponse } from '../model/updateApiKeyResponse';
-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.11";
-export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
-    transporter: import("@algolia/client-common").Transporter;
-    /**
-     * The `appId` currently in use.
-     */
-    appId: string;
-    /**
-     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
-     */
-    clearCache(): Promise<void>;
-    /**
-     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
-     */
-    readonly _ua: string;
-    /**
-     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
-     *
-     * @param segment - The algolia agent (user-agent) segment to add.
-     * @param version - The version of the agent.
-     */
-    addAlgoliaAgent(segment: string, version?: string): void;
-    /**
-     * 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.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.
-     * @param waitForTaskOptions.timeout - The function to decide how long to wait between retries.
-     * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
-     */
-    waitForTask({ indexName, taskID, maxRetries, timeout, }: WaitForTaskOptions, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
-    /**
-     * 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.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.
-     * @param waitForApiKeyOptions.maxRetries - The maximum number of retries. 50 by default.
-     * @param waitForApiKeyOptions.timeout - The function to decide how long to wait between retries.
-     * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getApikey` method and merged with the transporter requestOptions.
-     */
-    waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: WaitForApiKeyOptions, requestOptions?: RequestOptions): Promise<ApiError | GetApiKeyResponse>;
-    /**
-     * 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.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>>;
-    /**
-     * 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 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>;
-    /**
-     * 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 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, validate, aggregator, ...browseSynonymsOptions }: BrowseOptions<SearchSynonymsResponse> & SearchSynonymsProps, requestOptions?: RequestOptions): Promise<SearchSynonymsResponse>;
-    /**
-     * Add a new API Key with specific permissions/restrictions.
-     *
-     * @summary Create an 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>;
-    /**
-     * Add or replace an object with a given object ID. If the object does not exist, it will be created. If it already exists, it will be replaced.
-     *
-     * @summary Add or replace an object.
-     * @param addOrUpdateObject - The addOrUpdateObject object.
-     * @param addOrUpdateObject.indexName - The index in which to perform the request.
-     * @param addOrUpdateObject.objectID - Unique identifier of an object.
-     * @param addOrUpdateObject.body - The Algolia object.
-     * @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 single source to the list of allowed sources.
-     *
-     * @summary Add a single source.
-     * @param source - The 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 userID to a cluster. The time it takes to migrate (move) a user is proportional to the amount of data linked to the userID. Upon success, the response is 200 OK. A successful response indicates that the operation has been taken into account, and the userID is directly usable.
-     *
-     * @summary Assign or Move userID.
-     * @param assignUserId - The assignUserId object.
-     * @param assignUserId.xAlgoliaUserID - UserID to assign.
-     * @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>;
-    /**
-     * Perform multiple write operations targeting one index, in a single API call.
-     *
-     * @summary Batch operations to one index.
-     * @param batch - The batch object.
-     * @param batch.indexName - The index in which to perform the request.
-     * @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 userIDs to a cluster. Upon success, the response is 200 OK. A successful response indicates that the operation has been taken into account, and the userIDs are directly usable.
-     *
-     * @summary Batch assign userIDs.
-     * @param batchAssignUserIds - The batchAssignUserIds object.
-     * @param batchAssignUserIds.xAlgoliaUserID - UserID to assign.
-     * @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>;
-    /**
-     * Send a batch of dictionary entries.
-     *
-     * @summary Batch dictionary entries.
-     * @param batchDictionaryEntries - The batchDictionaryEntries object.
-     * @param batchDictionaryEntries.dictionaryName - The dictionary to search in.
-     * @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>;
-    /**
-     * This method allows you to retrieve all index content. It can retrieve up to 1,000 records per call and supports full text search and filters. For performance reasons, some features are not supported, including `distinct`, sorting by `typos`, `words` or `geo distance`. When there is more content to be browsed, the response contains a cursor field. This cursor has to be passed to the subsequent call to browse in order to get the next page of results. When the end of the index has been reached, the cursor field is absent from the response.
-     *
-     * @summary Retrieve all index content.
-     * @param browse - The browse object.
-     * @param browse.indexName - The index in which to perform the request.
-     * @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_1>({ indexName, browseParams }: BrowseProps, requestOptions?: RequestOptions): Promise<BrowseResponse<T_1>>;
-    /**
-     * Remove all synonyms from an index.
-     *
-     * @summary Clear all synonyms.
-     * @param clearAllSynonyms - The clearAllSynonyms object.
-     * @param clearAllSynonyms.indexName - The index in which to perform the request.
-     * @param clearAllSynonyms.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    clearAllSynonyms({ indexName, forwardToReplicas }: ClearAllSynonymsProps, requestOptions?: RequestOptions): Promise<UpdatedAtResponse>;
-    /**
-     * Delete an index\'s content, but leave settings and index-specific API keys untouched.
-     *
-     * @summary Clear all objects from an index.
-     * @param clearObjects - The clearObjects object.
-     * @param clearObjects.indexName - The index in which to perform the request.
-     * @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.
-     *
-     * @summary Clear Rules.
-     * @param clearRules - The clearRules object.
-     * @param clearRules.indexName - The index in which to perform the request.
-     * @param clearRules.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
-     * @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>;
-    /**
-     * 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 an existing API Key.
-     *
-     * @summary Delete an API key.
-     * @param deleteApiKey - The deleteApiKey object.
-     * @param deleteApiKey.key - API Key string.
-     * @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>;
-    /**
-     * Remove all objects matching a filter (including geo filters). This method enables you to delete one or more objects based on filters (numeric, facet, tag or geo queries). It doesn\'t accept empty filters or a query.
-     *
-     * @summary Delete all records matching the query.
-     * @param deleteBy - The deleteBy object.
-     * @param deleteBy.indexName - The index in which to perform the request.
-     * @param deleteBy.searchParams - The searchParams object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    deleteBy({ indexName, searchParams }: DeleteByProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
-    /**
-     * Delete an existing index.
-     *
-     * @summary Delete index.
-     * @param deleteIndex - The deleteIndex object.
-     * @param deleteIndex.indexName - The index in which to perform the request.
-     * @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>;
-    /**
-     * Delete an existing object.
-     *
-     * @summary Delete an object.
-     * @param deleteObject - The deleteObject object.
-     * @param deleteObject.indexName - The index in which to perform the request.
-     * @param deleteObject.objectID - Unique identifier of an object.
-     * @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 the Rule with the specified objectID.
-     *
-     * @summary Delete a rule.
-     * @param deleteRule - The deleteRule object.
-     * @param deleteRule.indexName - The index in which to perform the request.
-     * @param deleteRule.objectID - Unique identifier of an object.
-     * @param deleteRule.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
-     * @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 single source from the list of allowed sources.
-     *
-     * @summary Remove a single source.
-     * @param deleteSource - The deleteSource object.
-     * @param deleteSource.source - The IP 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 single synonyms set, identified by the given objectID.
-     *
-     * @summary Delete synonym.
-     * @param deleteSynonym - The deleteSynonym object.
-     * @param deleteSynonym.indexName - The index in which to perform the request.
-     * @param deleteSynonym.objectID - Unique identifier of an object.
-     * @param deleteSynonym.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
-     * @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>;
-    /**
-     * 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>>;
-    /**
-     * Get the permissions of an API key.
-     *
-     * @summary Get an API key.
-     * @param getApiKey - The getApiKey object.
-     * @param getApiKey.key - API Key string.
-     * @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>;
-    /**
-     * List dictionaries supported per language.
-     *
-     * @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>>;
-    /**
-     * Retrieve dictionaries settings. The API stores languages whose standard entries are disabled. Fetch settings does not return false values.
-     *
-     * @summary Retrieve dictionaries settings.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getDictionarySettings(requestOptions?: RequestOptions): Promise<GetDictionarySettingsResponse>;
-    /**
-     * Return the latest log entries.
-     *
-     * @summary Return the latest log entries.
-     * @param getLogs - The getLogs object.
-     * @param getLogs.offset - First entry to retrieve (zero-based). Log entries are sorted by decreasing date, therefore 0 designates the most recent log entry.
-     * @param getLogs.length - Maximum number of entries to retrieve. The maximum allowed value is 1000.
-     * @param getLogs.indexName - Index for which log entries should be retrieved. When omitted, log entries are retrieved across all indices.
-     * @param getLogs.type - Type of log entries to retrieve. When omitted, 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>;
-    /**
-     * Retrieve one object from the index.
-     *
-     * @summary Retrieve an object.
-     * @param getObject - The getObject object.
-     * @param getObject.indexName - The index in which to perform the request.
-     * @param getObject.objectID - Unique identifier of an object.
-     * @param getObject.attributesToRetrieve - List of attributes to retrieve. If not specified, all retrievable attributes are returned.
-     * @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 objects, potentially from different indices, in a single API call.
-     *
-     * @summary Retrieve one or more objects.
-     * @param getObjectsParams - The Algolia object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getObjects<T_2>(getObjectsParams: GetObjectsParams, requestOptions?: RequestOptions): Promise<GetObjectsResponse<T_2>>;
-    /**
-     * Retrieve the Rule with the specified objectID.
-     *
-     * @summary Get a rule.
-     * @param getRule - The getRule object.
-     * @param getRule.indexName - The index in which to perform the request.
-     * @param getRule.objectID - Unique identifier of an 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>;
-    /**
-     * Retrieve settings of an index.
-     *
-     * @summary Retrieve settings of an index.
-     * @param getSettings - The getSettings object.
-     * @param getSettings.indexName - The index in which to perform the request.
-     * @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>;
-    /**
-     * List all allowed sources.
-     *
-     * @summary List all allowed sources.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getSources(requestOptions?: RequestOptions): Promise<Source[]>;
-    /**
-     * Fetch a synonym object identified by its objectID.
-     *
-     * @summary Get synonym.
-     * @param getSynonym - The getSynonym object.
-     * @param getSynonym.indexName - The index in which to perform the request.
-     * @param getSynonym.objectID - Unique identifier of an 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>;
-    /**
-     * Check the current status of a given task.
-     *
-     * @summary Check the status of a task.
-     * @param getTask - The getTask object.
-     * @param getTask.indexName - The index in which to perform the request.
-     * @param getTask.taskID - Unique identifier of an task. Numeric value (up to 64bits).
-     * @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 top 10 userIDs with the highest number of records per cluster. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters. Upon success, the response is 200 OK and contains the following array of userIDs and clusters.
-     *
-     * @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. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters. Upon success, the response is 200 OK and contains the following userID data.
-     *
-     * @summary Get userID.
-     * @param getUserId - The getUserId object.
-     * @param getUserId.userID - UserID to assign.
-     * @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>;
-    /**
-     * Get the status of your clusters\' migrations or user creations. Creating a large batch of users or migrating your multi-cluster may take quite some time. This method lets you retrieve the status of the migration, so you can know when it\'s done. Upon success, the response is 200 OK. A successful response indicates that the operation has been taken into account, and the userIDs are directly usable.
-     *
-     * @summary Get migration status.
-     * @param hasPendingMappings - The hasPendingMappings object.
-     * @param hasPendingMappings.getClusters - If the clusters pending mapping state should be on 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 API keys, along with their associated rights.
-     *
-     * @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 clusters available in a multi-clusters setup for a single appID. Upon success, the response is 200 OK and contains the following clusters.
-     *
-     * @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 existing indexes from an application.
-     *
-     * @summary List existing indexes.
-     * @param listIndices - The listIndices object.
-     * @param listIndices.page - Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    listIndices({ page }?: ListIndicesProps, requestOptions?: RequestOptions | undefined): Promise<ListIndicesResponse>;
-    /**
-     * List the userIDs assigned to a multi-clusters appID. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters. Upon success, the response is 200 OK and contains the following userIDs data.
-     *
-     * @summary List userIDs.
-     * @param listUserIds - The listUserIds object.
-     * @param listUserIds.page - Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
-     * @param listUserIds.hitsPerPage - Maximum number of objects to retrieve.
-     * @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>;
-    /**
-     * Perform multiple write operations, potentially targeting multiple indices, in a single API call.
-     *
-     * @summary Batch operations to many 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>;
-    /**
-     * Performs a copy or a move operation on a index.
-     *
-     * @summary Copy/move index.
-     * @param operationIndex - The operationIndex object.
-     * @param operationIndex.indexName - The index in which to perform the request.
-     * @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>;
-    /**
-     * Update one or more attributes of an existing object. This method lets you update only a part of an existing object, either by adding new attributes or updating existing ones. You can partially update several objects in a single method call. If the index targeted by this operation doesn\'t exist yet, it\'s automatically created.
-     *
-     * @summary Partially update an object.
-     * @param partialUpdateObject - The partialUpdateObject object.
-     * @param partialUpdateObject.indexName - The index in which to perform the request.
-     * @param partialUpdateObject.objectID - Unique identifier of an object.
-     * @param partialUpdateObject.attributesToUpdate - Map of attribute(s) to update.
-     * @param partialUpdateObject.createIfNotExists - Creates the record if it does not exist yet.
-     * @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>;
-    /**
-     * 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>>;
-    /**
-     * Remove a userID and its associated data from the multi-clusters. Upon success, the response is 200 OK and a task is created to remove the userID data and mapping.
-     *
-     * @summary Remove userID.
-     * @param removeUserId - The removeUserId object.
-     * @param removeUserId.userID - UserID to assign.
-     * @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.
-     *
-     * @summary Replace all allowed sources.
-     * @param replaceSources - The replaceSources object.
-     * @param replaceSources.source - The sources to allow.
-     * @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 rights.
-     *
-     * @summary Restore an API key.
-     * @param restoreApiKey - The restoreApiKey object.
-     * @param restoreApiKey.key - API Key string.
-     * @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 an object to the index, automatically assigning it an object ID.
-     *
-     * @summary Add an object to the index.
-     * @param saveObject - The saveObject object.
-     * @param saveObject.indexName - The index in which to perform the request.
-     * @param saveObject.body - The Algolia record.
-     * @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>;
-    /**
-     * Create or update the Rule with the specified objectID.
-     *
-     * @summary Save/Update a rule.
-     * @param saveRule - The saveRule object.
-     * @param saveRule.indexName - The index in which to perform the request.
-     * @param saveRule.objectID - Unique identifier of an object.
-     * @param saveRule.rule - The rule object.
-     * @param saveRule.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
-     * @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/update multiple rules objects at once.
-     *
-     * @summary Save a batch of rules.
-     * @param saveRules - The saveRules object.
-     * @param saveRules.indexName - The index in which to perform the request.
-     * @param saveRules.rules - The rules object.
-     * @param saveRules.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
-     * @param saveRules.clearExistingRules - When true, existing Rules are cleared before adding this batch. When false, existing Rules are kept.
-     * @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>;
-    /**
-     * Create a new synonym object or update the existing synonym object with the given object ID.
-     *
-     * @summary Save synonym.
-     * @param saveSynonym - The saveSynonym object.
-     * @param saveSynonym.indexName - The index in which to perform the request.
-     * @param saveSynonym.objectID - Unique identifier of an object.
-     * @param saveSynonym.synonymHit - The synonymHit object.
-     * @param saveSynonym.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
-     * @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/update multiple synonym objects at once, potentially replacing the entire list of synonyms if replaceExistingSynonyms is true.
-     *
-     * @summary Save a batch of synonyms.
-     * @param saveSynonyms - The saveSynonyms object.
-     * @param saveSynonyms.indexName - The index in which to perform the request.
-     * @param saveSynonyms.synonymHit - The synonymHit object.
-     * @param saveSynonyms.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
-     * @param saveSynonyms.replaceExistingSynonyms - Replace all synonyms of 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>;
-    /**
-     * Perform a search operation targeting one or many indices.
-     *
-     * @summary Search multiple indices.
-     * @param searchMethodParams - The `search` requests and strategy.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    search<T_3>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T_3>>;
-    /**
-     * Search the dictionary entries.
-     *
-     * @summary Search a dictionary entries.
-     * @param searchDictionaryEntries - The searchDictionaryEntries object.
-     * @param searchDictionaryEntries.dictionaryName - The dictionary to search in.
-     * @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>;
-    /**
-     * Search for values of a given facet, optionally restricting the returned values to those contained in objects matching other search criteria.
-     *
-     * @summary Search for values of a given facet.
-     * @param searchForFacetValues - The searchForFacetValues object.
-     * @param searchForFacetValues.indexName - The index in which to perform the request.
-     * @param searchForFacetValues.facetName - The facet name.
-     * @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 matching various criteria.
-     *
-     * @summary Search for rules.
-     * @param searchRules - The searchRules object.
-     * @param searchRules.indexName - The index in which to perform the request.
-     * @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>;
-    /**
-     * Perform a search operation targeting one specific index.
-     *
-     * @summary Search in a single index.
-     * @param searchSingleIndex - The searchSingleIndex object.
-     * @param searchSingleIndex.indexName - The index in which to perform the request.
-     * @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_4>({ indexName, searchParams }: SearchSingleIndexProps, requestOptions?: RequestOptions): Promise<SearchResponse<T_4>>;
-    /**
-     * Search or browse all synonyms, optionally filtering them by type.
-     *
-     * @summary Search synonyms.
-     * @param searchSynonyms - The searchSynonyms object.
-     * @param searchSynonyms.indexName - The index in which to perform the request.
-     * @param searchSynonyms.type - Only search for specific types of synonyms.
-     * @param searchSynonyms.page - Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
-     * @param searchSynonyms.hitsPerPage - Maximum number of objects to retrieve.
-     * @param searchSynonyms.searchSynonymsParams - The body of the the `searchSynonyms` method.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    searchSynonyms({ indexName, type, page, hitsPerPage, searchSynonymsParams, }: SearchSynonymsProps, requestOptions?: RequestOptions): Promise<SearchSynonymsResponse>;
-    /**
-     * Search for userIDs. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds propagate to the different clusters. To keep updates moving quickly, the index of userIDs isn\'t built synchronously with the mapping. Instead, the index is built once every 12h, at the same time as the update of userID usage. For example, when you perform a modification like adding or moving a userID, the search will report an outdated value until the next rebuild of the mapping, which takes place every 12h. Upon success, the response is 200 OK and contains the following userIDs data.
-     *
-     * @summary Search userID.
-     * @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 dictionaries settings.
-     *
-     * @summary Set dictionaries 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 settings of an index. Only specified settings are overridden; unspecified settings are left unchanged. Specifying null for a setting resets it to its default value.
-     *
-     * @summary Update settings of an index.
-     * @param setSettings - The setSettings object.
-     * @param setSettings.indexName - The index in which to perform the request.
-     * @param setSettings.indexSettings - The indexSettings object.
-     * @param setSettings.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
-     * @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 every permission of an existing API key.
-     *
-     * @summary Update an API key.
-     * @param updateApiKey - The updateApiKey object.
-     * @param updateApiKey.key - API Key string.
-     * @param updateApiKey.apiKey - The apiKey object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    updateApiKey({ key, apiKey }: UpdateApiKeyProps, requestOptions?: RequestOptions): Promise<UpdateApiKeyResponse>;
-};
-/**
- * The client type.
- */
-export declare type SearchClient = ReturnType<typeof createSearchClient>;
+import type { CreateClientOptions, RequestOptions, ApiError } from '@algolia/client-common';
+import type { AddApiKeyResponse } from '../model/addApiKeyResponse';
+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, 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';
+import type { DeletedAtResponse } from '../model/deletedAtResponse';
+import type { DictionarySettingsParams } from '../model/dictionarySettingsParams';
+import type { GetApiKeyResponse } from '../model/getApiKeyResponse';
+import type { GetDictionarySettingsResponse } from '../model/getDictionarySettingsResponse';
+import type { GetLogsResponse } from '../model/getLogsResponse';
+import type { GetObjectsParams } from '../model/getObjectsParams';
+import type { GetObjectsResponse } from '../model/getObjectsResponse';
+import type { GetTaskResponse } from '../model/getTaskResponse';
+import type { GetTopUserIdsResponse } from '../model/getTopUserIdsResponse';
+import type { HasPendingMappingsResponse } from '../model/hasPendingMappingsResponse';
+import type { IndexSettings } from '../model/indexSettings';
+import type { Languages } from '../model/languages';
+import type { ListApiKeysResponse } from '../model/listApiKeysResponse';
+import type { ListClustersResponse } from '../model/listClustersResponse';
+import type { ListIndicesResponse } from '../model/listIndicesResponse';
+import type { ListUserIdsResponse } from '../model/listUserIdsResponse';
+import type { MultipleBatchResponse } from '../model/multipleBatchResponse';
+import type { RemoveUserIdResponse } from '../model/removeUserIdResponse';
+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';
+import type { SearchResponses } from '../model/searchResponses';
+import type { SearchRulesResponse } from '../model/searchRulesResponse';
+import type { SearchSynonymsResponse } from '../model/searchSynonymsResponse';
+import type { SearchUserIdsParams } from '../model/searchUserIdsParams';
+import type { SearchUserIdsResponse } from '../model/searchUserIdsResponse';
+import type { Source } from '../model/source';
+import type { SynonymHit } from '../model/synonymHit';
+import type { UpdateApiKeyResponse } from '../model/updateApiKeyResponse';
+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.110";
+export declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    /**
+     * The `appId` currently in use.
+     */
+    appId: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    readonly _ua: string;
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void;
+    /**
+     * 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.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.
+     * @param waitForTaskOptions.timeout - The function to decide how long to wait between retries.
+     * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
+     */
+    waitForTask({ indexName, taskID, maxRetries, timeout, }: WaitForTaskOptions, requestOptions?: RequestOptions): Promise<GetTaskResponse>;
+    /**
+     * 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.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.
+     * @param waitForApiKeyOptions.maxRetries - The maximum number of retries. 50 by default.
+     * @param waitForApiKeyOptions.timeout - The function to decide how long to wait between retries.
+     * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getApikey` method and merged with the transporter requestOptions.
+     */
+    waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: WaitForApiKeyOptions, requestOptions?: RequestOptions): Promise<ApiError | GetApiKeyResponse>;
+    /**
+     * 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.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 }: 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 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>;
+    /**
+     * 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 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>;
+    /**
+     * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
+     * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
+     *
+     * @summary Search multiple indices for `hits`.
+     * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    searchForHits<T_1>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<{
+        results: SearchResponse<T_1>[];
+    }>;
+    /**
+     * Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits).
+     * Disclaimer: We don't assert that the parameters you pass to this method only contains `facets` requests to prevent impacting search performances, this helper is purely for typing purposes.
+     *
+     * @summary Search multiple indices for `facets`.
+     * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    searchForFacets(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<{
+        results: SearchForFacetValuesResponse[];
+    }>;
+    /**
+     * 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.
+     *
+     * @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 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.
+     *
+     * @param addOrUpdateObject - The addOrUpdateObject object.
+     * @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>;
+    /**
+     * Adds a source to the list of allowed sources.
+     *
+     * Required API Key ACLs:
+     * - admin.
+     *
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param assignUserId - The assignUserId object.
+     * @param assignUserId.xAlgoliaUserID - User ID to assign.
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param batch - The batch object.
+     * @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>;
+    /**
+     * Assigns multiple user IDs to a cluster.  **You can\'t move users with this operation**.
+     *
+     * Required API Key ACLs:
+     * - admin.
+     *
+     * @param batchAssignUserIds - The batchAssignUserIds object.
+     * @param batchAssignUserIds.xAlgoliaUserID - User ID to assign.
+     * @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>;
+    /**
+     * Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param batchDictionaryEntries - The batchDictionaryEntries object.
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param browse - The browse object.
+     * @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>>;
+    /**
+     * Deletes only the records from an index while keeping settings, synonyms, and rules.
+     *
+     * Required API Key ACLs:
+     * - deleteIndex.
+     *
+     * @param clearObjects - The clearObjects object.
+     * @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>;
+    /**
+     * Deletes all rules from the index.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param clearRules - The clearRules object.
+     * @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>;
+    /**
+     * Deletes all synonyms from the index.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param clearSynonyms - The clearSynonyms object.
+     * @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.
+     *
+     * @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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to 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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.parameters - Query parameters to apply to the current query.
+     * @param customPost.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to 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.
+     * @param customPut.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.
+     */
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * Deletes the API key.
+     *
+     * Required API Key ACLs:
+     * - admin.
+     *
+     * @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 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.
+     *
+     * @param deleteBy - The deleteBy object.
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param deleteIndex - The deleteIndex object.
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param deleteObject - The deleteObject object.
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param deleteRule - The deleteRule object.
+     * @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 - 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>;
+    /**
+     * Deletes a source from the list of allowed sources.
+     *
+     * Required API Key ACLs:
+     * - admin.
+     *
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param deleteSynonym - The deleteSynonym object.
+     * @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 - 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>;
+    /**
+     * 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.
+     *
+     * @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 supported languages with their supported dictionary types and number of custom entries.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @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>>;
+    /**
+     * Retrieves the languages for which standard dictionary entries are turned off.
+     *
+     * Required API Key ACLs:
+     * - 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. - 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.
+     *
+     * @param getLogs - The getLogs object.
+     * @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 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>;
+    /**
+     * 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.
+     *
+     * @param getObject - The getObject object.
+     * @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>>;
+    /**
+     * Retrieves one or more records, potentially from different indices.  Records are returned in the same order as the requests.
+     *
+     * Required API Key ACLs:
+     * - search.
+     *
+     * @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>>;
+    /**
+     * 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.
+     *
+     * @param getRule - The getRule object.
+     * @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>;
+    /**
+     * Retrieves an object with non-null index settings.
+     *
+     * Required API Key ACLs:
+     * - search.
+     *
+     * @param getSettings - The getSettings object.
+     * @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>;
+    /**
+     * Retrieves all allowed IP addresses with access to your application.
+     *
+     * Required API Key ACLs:
+     * - admin.
+     *
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getSources(requestOptions?: RequestOptions): Promise<Source[]>;
+    /**
+     * 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.
+     *
+     * @param getSynonym - The getSynonym object.
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param getTask - The getTask object.
+     * @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 a few seconds to get the data from the different clusters, the response isn\'t real-time.
+     *
+     * Required API Key ACLs:
+     * - admin.
+     *
+     * @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 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.
+     *
+     * @param getUserId - The getUserId object.
+     * @param getUserId.userID - User ID to assign.
+     * @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.
+     *
+     * Required API Key ACLs:
+     * - admin.
+     *
+     * @param hasPendingMappings - The hasPendingMappings object.
+     * @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>;
+    /**
+     * Lists all API keys associated with your Algolia application, including their permissions and restrictions.
+     *
+     * Required API Key ACLs:
+     * - admin.
+     *
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    listApiKeys(requestOptions?: RequestOptions): Promise<ListApiKeysResponse>;
+    /**
+     * Lists the available clusters in a multi-cluster setup.
+     *
+     * Required API Key ACLs:
+     * - admin.
+     *
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    listClusters(requestOptions?: RequestOptions): Promise<ListClustersResponse>;
+    /**
+     * 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.
+     *
+     * @param listIndices - The listIndices object.
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param listUserIds - The listUserIds object.
+     * @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>;
+    /**
+     * 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.
+     *
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param operationIndex - The operationIndex object.
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param partialUpdateObject - The partialUpdateObject object.
+     * @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>;
+    /**
+     * Deletes a user ID and its associated data from the clusters.
+     *
+     * Required API Key ACLs:
+     * - admin.
+     *
+     * @param removeUserId - The removeUserId object.
+     * @param removeUserId.userID - User ID to assign.
+     * @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>;
+    /**
+     * Replaces the list of allowed sources.
+     *
+     * Required API Key ACLs:
+     * - admin.
+     *
+     * @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>;
+    /**
+     * 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.
+     *
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param saveObject - The saveObject object.
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param saveRule - The saveRule object.
+     * @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 - 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.  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.
+     *
+     * @param saveRules - The saveRules object.
+     * @param saveRules.indexName - Name of the index on which to perform the operation.
+     * @param saveRules.rules - The rules object.
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param saveSynonym - The saveSynonym object.
+     * @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 - 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>;
+    /**
+     * If a synonym with the `objectID` doesn\'t exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param saveSynonyms - The saveSynonyms object.
+     * @param saveSynonyms.indexName - Name of the index on which to perform the operation.
+     * @param saveSynonyms.synonymHit - The synonymHit object.
+     * @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>;
+    /**
+     * 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.
+     *
+     * 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>>;
+    /**
+     * Searches for standard and custom dictionary entries.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @param searchDictionaryEntries - The searchDictionaryEntries object.
+     * @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<SearchDictionaryEntriesResponse>;
+    /**
+     * 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.
+     *
+     * @param searchForFacetValues - The searchForFacetValues object.
+     * @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>;
+    /**
+     * Searches for rules in your index.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @param searchRules - The searchRules object.
+     * @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>;
+    /**
+     * 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.
+     *
+     * @param searchSingleIndex - The searchSingleIndex object.
+     * @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>>;
+    /**
+     * Searches for synonyms in your index.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @param searchSynonyms - The searchSynonyms object.
+     * @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 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.
+     *
+     * @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>;
+    /**
+     * Turns standard stop word dictionary entries on or off for a given language.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @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.  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.
+     *
+     * @param setSettings - The setSettings object.
+     * @param setSettings.indexName - Name of the index on which to perform the operation.
+     * @param setSettings.indexSettings - The indexSettings object.
+     * @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>;
+    /**
+     * Replaces the permissions of an existing API key.  Any unspecified attribute resets that attribute to its default value.
+     *
+     * Required API Key ACLs:
+     * - admin.
+     *
+     * @param updateApiKey - The updateApiKey object.
+     * @param updateApiKey.key - API key.
+     * @param updateApiKey.apiKey - The apiKey object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    updateApiKey({ key, apiKey }: UpdateApiKeyProps, requestOptions?: RequestOptions): Promise<UpdateApiKeyResponse>;
+};
 //# sourceMappingURL=searchClient.d.ts.map