@algolia/client-search 5.23.0 → 5.23.1

package/dist/fetch.d.ts

@@ -3028,7 +3028,7 @@ type ReplaceAllObjectsOptions = {
     scopes?: Array<ScopeType>;
 };
 
-declare const apiClientVersion = "5.23.0";
+declare const apiClientVersion = "5.23.1";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3256,6 +3256,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param assignUserId - The assignUserId object.
      * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
@@ -3275,6 +3277,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param batchAssignUserIds - The batchAssignUserIds object.
      * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
@@ -3570,6 +3574,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getTopUserIds(requestOptions?: RequestOptions): Promise<GetTopUserIdsResponse>;
@@ -3578,6 +3584,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param getUserId - The getUserId object.
      * @param getUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3588,6 +3596,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @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.
@@ -3606,6 +3616,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listClusters(requestOptions?: RequestOptions): Promise<ListClustersResponse>;
@@ -3625,6 +3637,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @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.
@@ -3666,6 +3680,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param removeUserId - The removeUserId object.
      * @param removeUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3824,6 +3840,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param searchUserIdsParams - The searchUserIdsParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */

package/dist/node.d.cts

@@ -3028,7 +3028,7 @@ type ReplaceAllObjectsOptions = {
     scopes?: Array<ScopeType>;
 };
 
-declare const apiClientVersion = "5.23.0";
+declare const apiClientVersion = "5.23.1";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3256,6 +3256,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param assignUserId - The assignUserId object.
      * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
@@ -3275,6 +3277,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param batchAssignUserIds - The batchAssignUserIds object.
      * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
@@ -3570,6 +3574,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getTopUserIds(requestOptions?: RequestOptions): Promise<GetTopUserIdsResponse>;
@@ -3578,6 +3584,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param getUserId - The getUserId object.
      * @param getUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3588,6 +3596,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @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.
@@ -3606,6 +3616,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listClusters(requestOptions?: RequestOptions): Promise<ListClustersResponse>;
@@ -3625,6 +3637,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @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.
@@ -3666,6 +3680,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param removeUserId - The removeUserId object.
      * @param removeUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3824,6 +3840,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param searchUserIdsParams - The searchUserIdsParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */

package/dist/node.d.ts

@@ -3028,7 +3028,7 @@ type ReplaceAllObjectsOptions = {
     scopes?: Array<ScopeType>;
 };
 
-declare const apiClientVersion = "5.23.0";
+declare const apiClientVersion = "5.23.1";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3256,6 +3256,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param assignUserId - The assignUserId object.
      * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
@@ -3275,6 +3277,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param batchAssignUserIds - The batchAssignUserIds object.
      * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
@@ -3570,6 +3574,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getTopUserIds(requestOptions?: RequestOptions): Promise<GetTopUserIdsResponse>;
@@ -3578,6 +3584,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param getUserId - The getUserId object.
      * @param getUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3588,6 +3596,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @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.
@@ -3606,6 +3616,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listClusters(requestOptions?: RequestOptions): Promise<ListClustersResponse>;
@@ -3625,6 +3637,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @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.
@@ -3666,6 +3680,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param removeUserId - The removeUserId object.
      * @param removeUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3824,6 +3840,8 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param searchUserIdsParams - The searchUserIdsParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */

package/dist/src/searchClient.cjs

@@ -25,7 +25,7 @@ __export(searchClient_exports, {
 });
 module.exports = __toCommonJS(searchClient_exports);
 var import_client_common = require("@algolia/client-common");
-var apiClientVersion = "5.23.0";
+var apiClientVersion = "5.23.1";
 function getDefaultHosts(appId) {
   return [
     {
@@ -638,6 +638,8 @@ function createSearchClient({
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param assignUserId - The assignUserId object.
      * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
@@ -702,6 +704,8 @@ function createSearchClient({
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param batchAssignUserIds - The batchAssignUserIds object.
      * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
      * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
@@ -1476,6 +1480,8 @@ function createSearchClient({
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getTopUserIds(requestOptions) {
@@ -1495,6 +1501,8 @@ function createSearchClient({
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param getUserId - The getUserId object.
      * @param getUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1519,6 +1527,8 @@ function createSearchClient({
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @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.
@@ -1562,6 +1572,8 @@ function createSearchClient({
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listClusters(requestOptions) {
@@ -1609,6 +1621,8 @@ function createSearchClient({
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @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.
@@ -1733,6 +1747,8 @@ function createSearchClient({
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param removeUserId - The removeUserId object.
      * @param removeUserId.userID - Unique identifier of the user who makes the search request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2205,6 +2221,8 @@ function createSearchClient({
      *
      * Required API Key ACLs:
      *  - admin
+     *
+     * @deprecated
      * @param searchUserIdsParams - The searchUserIdsParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */