@algolia/client-search 5.0.0-alpha.103 → 5.0.0-alpha.105

package/dist/builds/browser.d.ts

@@ -1,6 +1,89 @@
 import type { ClientOptions } from '@algolia/client-common';
-import type { SearchClient } from '../src/searchClient';
-export { apiClientVersion, SearchClient } from '../src/searchClient';
+export { apiClientVersion } from '../src/searchClient';
 export * from '../model';
-export declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): SearchClient;
+/**
+ * The client type.
+ */
+export type SearchClient = ReturnType<typeof searchClient>;
+export declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    readonly _ua: string;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
+    waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
+    waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-common").ApiError | import("../model").GetApiKeyResponse>;
+    browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "aggregator">> & import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T>>;
+    browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "aggregator">> & import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
+    browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "aggregator">> & import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
+    searchForHits<T_1>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
+        results: import("../model").SearchResponse<T_1>[];
+    }>;
+    searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
+        results: import("../model").SearchForFacetValuesResponse[];
+    }>;
+    chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse[]>;
+    replaceAllObjects({ indexName, objects, batchSize }: import("../model").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceAllObjectsResponse>;
+    addApiKey(apiKey: import("../model").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
+    addOrUpdateObject({ indexName, objectID, body }: import("../model").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
+    appendSource(source: import("../model").Source, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
+    assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("../model").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
+    batch({ indexName, batchWriteParams }: import("../model").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse>;
+    batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("../model").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
+    batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("../model").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    browse<T_2>({ indexName, browseParams }: import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T_2>>;
+    clearObjects({ indexName }: import("../model").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    clearRules({ indexName, forwardToReplicas }: import("../model").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    clearSynonyms({ indexName, forwardToReplicas }: import("../model").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    deleteApiKey({ key }: import("../model").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteApiKeyResponse>;
+    deleteBy({ indexName, deleteByParams }: import("../model").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
+    deleteIndex({ indexName }: import("../model").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
+    deleteObject({ indexName, objectID }: import("../model").DeleteObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
+    deleteRule({ indexName, objectID, forwardToReplicas }: import("../model").DeleteRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    deleteSource({ source }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteSourceResponse>;
+    deleteSynonym({ indexName, objectID, forwardToReplicas }: import("../model").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
+    getApiKey({ key }: import("../model").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetApiKeyResponse>;
+    getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, import("../model").Languages>>;
+    getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetDictionarySettingsResponse>;
+    getLogs({ offset, length, indexName, type }?: import("../model").GetLogsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetLogsResponse>;
+    getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, string>>;
+    getObjects<T_3>(getObjectsParams: import("../model").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetObjectsResponse<T_3>>;
+    getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Rule>;
+    getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").IndexSettings>;
+    getSources(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Source[]>;
+    getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SynonymHit>;
+    getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
+    getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTopUserIdsResponse>;
+    getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UserId>;
+    hasPendingMappings({ getClusters }?: import("../model").HasPendingMappingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").HasPendingMappingsResponse>;
+    listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListApiKeysResponse>;
+    listClusters(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListClustersResponse>;
+    listIndices({ page, hitsPerPage }?: import("../model").ListIndicesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListIndicesResponse>;
+    listUserIds({ page, hitsPerPage }?: import("../model").ListUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListUserIdsResponse>;
+    multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").MultipleBatchResponse>;
+    operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
+    removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RemoveUserIdResponse>;
+    replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceSourceResponse>;
+    restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
+    saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveObjectResponse>;
+    saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedRuleResponse>;
+    saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveSynonymResponse>;
+    saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    search<T_4>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponses<T_4>>;
+    searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchForFacetValuesResponse>;
+    searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
+    searchSingleIndex<T_5>({ indexName, searchParams }: import("../model").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponse<T_5>>;
+    searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
+    searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchUserIdsResponse>;
+    setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdateApiKeyResponse>;
+};
 //# sourceMappingURL=browser.d.ts.map

package/dist/builds/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAY5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,cAAc,UAAU,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,YAAY,CA8Bd"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAa5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+BxB"}

package/dist/builds/node.d.ts

@@ -1,6 +1,107 @@
 import type { ClientOptions } from '@algolia/client-common';
-import type { SearchClient } from '../src/searchClient';
-export { apiClientVersion, SearchClient } from '../src/searchClient';
+import type { GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from '../model';
+export { apiClientVersion } from '../src/searchClient';
 export * from '../model';
-export declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): SearchClient;
+/**
+ * The client type.
+ */
+export type SearchClient = ReturnType<typeof searchClient>;
+export declare function searchClient(appId: string, apiKey: string, options?: ClientOptions): {
+    /**
+     * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+     *
+     * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+     * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
+     * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
+     * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
+     */
+    generateSecuredApiKey({ parentApiKey, restrictions, }: GenerateSecuredApiKeyOptions): string;
+    /**
+     * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+     *
+     * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+     * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
+     * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
+     */
+    getSecuredApiKeyRemainingValidity({ securedApiKey, }: GetSecuredApiKeyRemainingValidityOptions): number;
+    transporter: import("@algolia/client-common").Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    _ua: string;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
+    waitForTask({ indexName, taskID, maxRetries, timeout, }: import("../model").WaitForTaskOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
+    waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: import("../model").WaitForApiKeyOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("@algolia/client-common").ApiError | import("../model").GetApiKeyResponse>;
+    browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").BrowseResponse<T>>, "aggregator">> & import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T>>;
+    browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchRulesResponse>, "aggregator">> & import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
+    browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: Partial<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "validate">> & Required<Pick<import("@algolia/client-common").CreateIterablePromise<import("../model").SearchSynonymsResponse>, "aggregator">> & import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
+    searchForHits<T_1>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
+        results: import("../model").SearchResponse<T_1>[];
+    }>;
+    searchForFacets(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<{
+        results: import("../model").SearchForFacetValuesResponse[];
+    }>;
+    chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("../model").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse[]>;
+    replaceAllObjects({ indexName, objects, batchSize }: import("../model").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceAllObjectsResponse>;
+    addApiKey(apiKey: import("../model").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
+    addOrUpdateObject({ indexName, objectID, body }: import("../model").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
+    appendSource(source: import("../model").Source, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
+    assignUserId({ xAlgoliaUserID, assignUserIdParams }: import("../model").AssignUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
+    batch({ indexName, batchWriteParams }: import("../model").BatchProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BatchResponse>;
+    batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: import("../model").BatchAssignUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").CreatedAtResponse>;
+    batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }: import("../model").BatchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    browse<T_2>({ indexName, browseParams }: import("../model").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").BrowseResponse<T_2>>;
+    clearObjects({ indexName }: import("../model").ClearObjectsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    clearRules({ indexName, forwardToReplicas }: import("../model").ClearRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    clearSynonyms({ indexName, forwardToReplicas }: import("../model").ClearSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    deleteApiKey({ key }: import("../model").DeleteApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteApiKeyResponse>;
+    deleteBy({ indexName, deleteByParams }: import("../model").DeleteByProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
+    deleteIndex({ indexName }: import("../model").DeleteIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
+    deleteObject({ indexName, objectID }: import("../model").DeleteObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
+    deleteRule({ indexName, objectID, forwardToReplicas }: import("../model").DeleteRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    deleteSource({ source }: import("../model").DeleteSourceProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteSourceResponse>;
+    deleteSynonym({ indexName, objectID, forwardToReplicas }: import("../model").DeleteSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeletedAtResponse>;
+    getApiKey({ key }: import("../model").GetApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetApiKeyResponse>;
+    getDictionaryLanguages(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, import("../model").Languages>>;
+    getDictionarySettings(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetDictionarySettingsResponse>;
+    getLogs({ offset, length, indexName, type }?: import("../model").GetLogsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetLogsResponse>;
+    getObject({ indexName, objectID, attributesToRetrieve }: import("../model").GetObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, string>>;
+    getObjects<T_3>(getObjectsParams: import("../model").GetObjectsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetObjectsResponse<T_3>>;
+    getRule({ indexName, objectID }: import("../model").GetRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Rule>;
+    getSettings({ indexName }: import("../model").GetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").IndexSettings>;
+    getSources(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").Source[]>;
+    getSynonym({ indexName, objectID }: import("../model").GetSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SynonymHit>;
+    getTask({ indexName, taskID }: import("../model").GetTaskProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTaskResponse>;
+    getTopUserIds(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetTopUserIdsResponse>;
+    getUserId({ userID }: import("../model").GetUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UserId>;
+    hasPendingMappings({ getClusters }?: import("../model").HasPendingMappingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").HasPendingMappingsResponse>;
+    listApiKeys(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListApiKeysResponse>;
+    listClusters(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListClustersResponse>;
+    listIndices({ page, hitsPerPage }?: import("../model").ListIndicesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListIndicesResponse>;
+    listUserIds({ page, hitsPerPage }?: import("../model").ListUserIdsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ListUserIdsResponse>;
+    multipleBatch(batchParams: import("../model").BatchParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").MultipleBatchResponse>;
+    operationIndex({ indexName, operationIndexParams }: import("../model").OperationIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists, }: import("../model").PartialUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtWithObjectIdResponse>;
+    removeUserId({ userID }: import("../model").RemoveUserIdProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").RemoveUserIdResponse>;
+    replaceSources({ source }: import("../model").ReplaceSourcesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").ReplaceSourceResponse>;
+    restoreApiKey({ key }: import("../model").RestoreApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").AddApiKeyResponse>;
+    saveObject({ indexName, body }: import("../model").SaveObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveObjectResponse>;
+    saveRule({ indexName, objectID, rule, forwardToReplicas }: import("../model").SaveRuleProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedRuleResponse>;
+    saveRules({ indexName, rules, forwardToReplicas, clearExistingRules, }: import("../model").SaveRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: import("../model").SaveSynonymProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SaveSynonymResponse>;
+    saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }: import("../model").SaveSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    search<T_4>(searchMethodParams: import("../model").LegacySearchMethodProps | import("../model").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponses<T_4>>;
+    searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }: import("../model").SearchDictionaryEntriesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }: import("../model").SearchForFacetValuesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchForFacetValuesResponse>;
+    searchRules({ indexName, searchRulesParams }: import("../model").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchRulesResponse>;
+    searchSingleIndex<T_5>({ indexName, searchParams }: import("../model").SearchSingleIndexProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchResponse<T_5>>;
+    searchSynonyms({ indexName, searchSynonymsParams }: import("../model").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchSynonymsResponse>;
+    searchUserIds(searchUserIdsParams: import("../model").SearchUserIdsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SearchUserIdsResponse>;
+    setDictionarySettings(dictionarySettingsParams: import("../model").DictionarySettingsParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    setSettings({ indexName, indexSettings, forwardToReplicas }: import("../model").SetSettingsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdatedAtResponse>;
+    updateApiKey({ key, apiKey }: import("../model").UpdateApiKeyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").UpdateApiKeyResponse>;
+};
 //# sourceMappingURL=node.d.ts.map

package/dist/builds/node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACrE,cAAc,UAAU,CAAC;AAEzB,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,YAAY,CAwBd"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EACV,4BAA4B,EAC5B,wCAAwC,EACzC,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAG3D,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;IA2BrB;;;;;;;OAOG;2DAIA,4BAA4B,GAAG,MAAM;IASxC;;;;;;OAMG;0DAGA,wCAAwC,GAAG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcvD"}

package/dist/client-search.cjs

@@ -1,11 +1,11 @@
 'use strict';
 
+var crypto = require('crypto');
 var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@algolia/requester-node-http');
-var crypto = require('crypto');
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '5.0.0-alpha.103';
+const apiClientVersion = '5.0.0-alpha.105';
 function getDefaultHosts(appId) {
     return [
         {
@@ -277,36 +277,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
         searchForFacets(searchMethodParams, requestOptions) {
             return this.search(searchMethodParams, requestOptions);
         },
-        /**
-         * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-         *
-         * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-         * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
-         * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
-         * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
-         */
-        generateSecuredApiKey({ parentApiKey, restrictions = {}, }) {
-            const queryParameters = clientCommon.serializeQueryParameters(restrictions);
-            return Buffer.from(crypto.createHmac('sha256', parentApiKey)
-                .update(queryParameters)
-                .digest('hex') + queryParameters).toString('base64');
-        },
-        /**
-         * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-         *
-         * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-         * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
-         * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
-         */
-        getSecuredApiKeyRemainingValidity({ securedApiKey, }) {
-            const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
-            const regex = /validUntil=(\d+)/;
-            const match = decodedString.match(regex);
-            if (match === null) {
-                throw new Error('ValidUntil not found in given secured api key.');
-            }
-            return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
-        },
         /**
          * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
          *
@@ -2195,6 +2165,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function searchClient(appId, apiKey, options) {
     if (!appId || typeof appId !== 'string') {
         throw new Error('`appId` is missing.');
@@ -2202,21 +2173,53 @@ function searchClient(appId, apiKey, options) {
     if (!apiKey || typeof apiKey !== 'string') {
         throw new Error('`apiKey` is missing.');
     }
-    return createSearchClient({
-        appId,
-        apiKey,
-        timeouts: {
-            connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
-            read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
-            write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
-        },
-        requester: requesterNodeHttp.createHttpRequester(),
-        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
-        responsesCache: clientCommon.createNullCache(),
-        requestsCache: clientCommon.createNullCache(),
-        hostsCache: clientCommon.createMemoryCache(),
-        ...options,
-    });
+    return {
+        ...createSearchClient({
+            appId,
+            apiKey,
+            timeouts: {
+                connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
+                read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
+                write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
+            },
+            requester: requesterNodeHttp.createHttpRequester(),
+            algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+            responsesCache: clientCommon.createNullCache(),
+            requestsCache: clientCommon.createNullCache(),
+            hostsCache: clientCommon.createMemoryCache(),
+            ...options,
+        }),
+        /**
+         * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+         *
+         * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+         * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
+         * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
+         * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
+         */
+        generateSecuredApiKey({ parentApiKey, restrictions = {}, }) {
+            const queryParameters = clientCommon.serializeQueryParameters(restrictions);
+            return Buffer.from(crypto.createHmac('sha256', parentApiKey)
+                .update(queryParameters)
+                .digest('hex') + queryParameters).toString('base64');
+        },
+        /**
+         * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+         *
+         * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+         * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
+         * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
+         */
+        getSecuredApiKeyRemainingValidity({ securedApiKey, }) {
+            const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
+            const regex = /validUntil=(\d+)/;
+            const match = decodedString.match(regex);
+            if (match === null) {
+                throw new Error('validUntil not found in given secured api key.');
+            }
+            return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
+        },
+    };
 }
 
 exports.apiClientVersion = apiClientVersion;

package/dist/client-search.esm.browser.js

@@ -1,5 +1,3 @@
-import { createHmac } from 'crypto';
-
 function createAuth(appId, apiKey, authMode = 'WithinHeaders') {
   const credentials = {
     'x-algolia-api-key': apiKey,
@@ -739,7 +737,7 @@ function createXhrRequester() {
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '5.0.0-alpha.103';
+const apiClientVersion = '5.0.0-alpha.105';
 function getDefaultHosts(appId) {
     return [
         {
@@ -1011,36 +1009,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
         searchForFacets(searchMethodParams, requestOptions) {
             return this.search(searchMethodParams, requestOptions);
         },
-        /**
-         * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-         *
-         * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-         * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
-         * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
-         * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
-         */
-        generateSecuredApiKey({ parentApiKey, restrictions = {}, }) {
-            const queryParameters = serializeQueryParameters(restrictions);
-            return Buffer.from(createHmac('sha256', parentApiKey)
-                .update(queryParameters)
-                .digest('hex') + queryParameters).toString('base64');
-        },
-        /**
-         * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-         *
-         * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-         * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
-         * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
-         */
-        getSecuredApiKeyRemainingValidity({ securedApiKey, }) {
-            const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
-            const regex = /validUntil=(\d+)/;
-            const match = decodedString.match(regex);
-            if (match === null) {
-                throw new Error('ValidUntil not found in given secured api key.');
-            }
-            return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
-        },
         /**
          * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
          *
@@ -2929,6 +2897,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function searchClient(appId, apiKey, options) {
     if (!appId || typeof appId !== 'string') {
         throw new Error('`appId` is missing.');

package/dist/client-search.esm.node.js

@@ -1,9 +1,9 @@
-import { createAuth, createTransporter, getAlgoliaAgent, createIterablePromise, serializeQueryParameters, shuffle, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_NODE, createNullCache, createMemoryCache } from '@algolia/client-common';
-import { createHttpRequester } from '@algolia/requester-node-http';
 import { createHmac } from 'crypto';
+import { createAuth, createTransporter, getAlgoliaAgent, createIterablePromise, shuffle, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_NODE, createNullCache, createMemoryCache, serializeQueryParameters } from '@algolia/client-common';
+import { createHttpRequester } from '@algolia/requester-node-http';
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '5.0.0-alpha.103';
+const apiClientVersion = '5.0.0-alpha.105';
 function getDefaultHosts(appId) {
     return [
         {
@@ -275,36 +275,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
         searchForFacets(searchMethodParams, requestOptions) {
             return this.search(searchMethodParams, requestOptions);
         },
-        /**
-         * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-         *
-         * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-         * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
-         * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
-         * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
-         */
-        generateSecuredApiKey({ parentApiKey, restrictions = {}, }) {
-            const queryParameters = serializeQueryParameters(restrictions);
-            return Buffer.from(createHmac('sha256', parentApiKey)
-                .update(queryParameters)
-                .digest('hex') + queryParameters).toString('base64');
-        },
-        /**
-         * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-         *
-         * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-         * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
-         * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
-         */
-        getSecuredApiKeyRemainingValidity({ securedApiKey, }) {
-            const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
-            const regex = /validUntil=(\d+)/;
-            const match = decodedString.match(regex);
-            if (match === null) {
-                throw new Error('ValidUntil not found in given secured api key.');
-            }
-            return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
-        },
         /**
          * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
          *
@@ -2193,6 +2163,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function searchClient(appId, apiKey, options) {
     if (!appId || typeof appId !== 'string') {
         throw new Error('`appId` is missing.');
@@ -2200,21 +2171,53 @@ function searchClient(appId, apiKey, options) {
     if (!apiKey || typeof apiKey !== 'string') {
         throw new Error('`apiKey` is missing.');
     }
-    return createSearchClient({
-        appId,
-        apiKey,
-        timeouts: {
-            connect: DEFAULT_CONNECT_TIMEOUT_NODE,
-            read: DEFAULT_READ_TIMEOUT_NODE,
-            write: DEFAULT_WRITE_TIMEOUT_NODE,
-        },
-        requester: createHttpRequester(),
-        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
-        responsesCache: createNullCache(),
-        requestsCache: createNullCache(),
-        hostsCache: createMemoryCache(),
-        ...options,
-    });
+    return {
+        ...createSearchClient({
+            appId,
+            apiKey,
+            timeouts: {
+                connect: DEFAULT_CONNECT_TIMEOUT_NODE,
+                read: DEFAULT_READ_TIMEOUT_NODE,
+                write: DEFAULT_WRITE_TIMEOUT_NODE,
+            },
+            requester: createHttpRequester(),
+            algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+            responsesCache: createNullCache(),
+            requestsCache: createNullCache(),
+            hostsCache: createMemoryCache(),
+            ...options,
+        }),
+        /**
+         * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+         *
+         * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+         * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
+         * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
+         * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
+         */
+        generateSecuredApiKey({ parentApiKey, restrictions = {}, }) {
+            const queryParameters = serializeQueryParameters(restrictions);
+            return Buffer.from(createHmac('sha256', parentApiKey)
+                .update(queryParameters)
+                .digest('hex') + queryParameters).toString('base64');
+        },
+        /**
+         * Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+         *
+         * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+         * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
+         * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
+         */
+        getSecuredApiKeyRemainingValidity({ securedApiKey, }) {
+            const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
+            const regex = /validUntil=(\d+)/;
+            const match = decodedString.match(regex);
+            if (match === null) {
+                throw new Error('validUntil not found in given secured api key.');
+            }
+            return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
+        },
+    };
 }
 
 export { apiClientVersion, searchClient };