algoliasearch 5.0.0-alpha.110 → 5.0.0-alpha.111

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

@@ -7,7 +7,7 @@ import type { PersonalizationClient } from '@algolia/client-personalization';
 import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
 import type { InitClientOptions, InitClientRegion } from './models';
 export * from './models';
-export declare const apiClientVersion = "5.0.0-alpha.110";
+export declare const apiClientVersion = "5.0.0-alpha.111";
 /**
  * The client type.
  */

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

@@ -7,7 +7,7 @@ import type { PersonalizationClient } from '@algolia/client-personalization';
 import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
 import type { InitClientOptions, InitClientRegion, GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from './models';
 export * from './models';
-export declare const apiClientVersion = "5.0.0-alpha.110";
+export declare const apiClientVersion = "5.0.0-alpha.111";
 /**
  * The client type.
  */

package/dist/algoliasearch.cjs

@@ -5,7 +5,7 @@ var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@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$4 = '5.0.0-alpha.110';
+const apiClientVersion$4 = '5.0.0-alpha.111';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -310,7 +310,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // 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$3 = '5.0.0-alpha.110';
+const apiClientVersion$3 = '5.0.0-alpha.111';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$2(region) {
     const url = !region
@@ -473,8 +473,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getAddToCartRate - The getAddToCartRate object.
          * @param getAddToCartRate.index - Index name.
-         * @param getAddToCartRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getAddToCartRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getAddToCartRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getAddToCartRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getAddToCartRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -513,8 +513,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getAverageClickPosition - The getAverageClickPosition object.
          * @param getAverageClickPosition.index - Index name.
-         * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getAverageClickPosition.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getAverageClickPosition.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getAverageClickPosition.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -553,8 +553,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getClickPositions - The getClickPositions object.
          * @param getClickPositions.index - Index name.
-         * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getClickPositions.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getClickPositions.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getClickPositions.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -593,8 +593,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getClickThroughRate - The getClickThroughRate object.
          * @param getClickThroughRate.index - Index name.
-         * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getClickThroughRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getClickThroughRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getClickThroughRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -633,8 +633,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getConversionRate - The getConversionRate object.
          * @param getConversionRate.index - Index name.
-         * @param getConversionRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getConversionRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getConversionRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getConversionRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getConversionRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -673,8 +673,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getNoClickRate - The getNoClickRate object.
          * @param getNoClickRate.index - Index name.
-         * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getNoClickRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getNoClickRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getNoClickRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -713,8 +713,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getNoResultsRate - The getNoResultsRate object.
          * @param getNoResultsRate.index - Index name.
-         * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getNoResultsRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getNoResultsRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getNoResultsRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -753,8 +753,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getPurchaseRate - The getPurchaseRate object.
          * @param getPurchaseRate.index - Index name.
-         * @param getPurchaseRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getPurchaseRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getPurchaseRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getPurchaseRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getPurchaseRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -793,8 +793,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getRevenue - The getRevenue object.
          * @param getRevenue.index - Index name.
-         * @param getRevenue.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getRevenue.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getRevenue.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getRevenue.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getRevenue.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -833,8 +833,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getSearchesCount - The getSearchesCount object.
          * @param getSearchesCount.index - Index name.
-         * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getSearchesCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getSearchesCount.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -873,8 +873,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getSearchesNoClicks - The getSearchesNoClicks object.
          * @param getSearchesNoClicks.index - Index name.
-         * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getSearchesNoClicks.limit - Number of items to return.
          * @param getSearchesNoClicks.offset - Position of the first item to return.
          * @param getSearchesNoClicks.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -921,8 +921,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getSearchesNoResults - The getSearchesNoResults object.
          * @param getSearchesNoResults.index - Index name.
-         * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getSearchesNoResults.limit - Number of items to return.
          * @param getSearchesNoResults.offset - Position of the first item to return.
          * @param getSearchesNoResults.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -997,8 +997,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getTopCountries - The getTopCountries object.
          * @param getTopCountries.index - Index name.
-         * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getTopCountries.limit - Number of items to return.
          * @param getTopCountries.offset - Position of the first item to return.
          * @param getTopCountries.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -1046,8 +1046,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopFilterAttributes - The getTopFilterAttributes object.
          * @param getTopFilterAttributes.index - Index name.
          * @param getTopFilterAttributes.search - Search query.
-         * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getTopFilterAttributes.limit - Number of items to return.
          * @param getTopFilterAttributes.offset - Position of the first item to return.
          * @param getTopFilterAttributes.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -1099,8 +1099,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopFilterForAttribute.attribute - Attribute name.
          * @param getTopFilterForAttribute.index - Index name.
          * @param getTopFilterForAttribute.search - Search query.
-         * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getTopFilterForAttribute.limit - Number of items to return.
          * @param getTopFilterForAttribute.offset - Position of the first item to return.
          * @param getTopFilterForAttribute.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -1154,8 +1154,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
          * @param getTopFiltersNoResults.index - Index name.
          * @param getTopFiltersNoResults.search - Search query.
-         * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getTopFiltersNoResults.limit - Number of items to return.
          * @param getTopFiltersNoResults.offset - Position of the first item to return.
          * @param getTopFiltersNoResults.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -1208,8 +1208,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopHits.search - Search query.
          * @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
          * @param getTopHits.revenueAnalytics - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
-         * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getTopHits.limit - Number of items to return.
          * @param getTopHits.offset - Position of the first item to return.
          * @param getTopHits.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -1267,8 +1267,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopSearches.index - Index name.
          * @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
          * @param getTopSearches.revenueAnalytics - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
-         * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopSearches.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getTopSearches.orderBy - Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
          * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
          * @param getTopSearches.limit - Number of items to return.
@@ -1329,8 +1329,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getUsersCount - The getUsersCount object.
          * @param getUsersCount.index - Index name.
-         * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getUsersCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getUsersCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getUsersCount.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1365,7 +1365,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // 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$2 = '5.0.0-alpha.110';
+const apiClientVersion$2 = '5.0.0-alpha.111';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$1(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -1626,7 +1626,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
 }
 
 // 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$1 = '5.0.0-alpha.110';
+const apiClientVersion$1 = '5.0.0-alpha.111';
 function getDefaultHosts(appId) {
     return [
         {
@@ -2062,7 +2062,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * - admin.
          *
          * @param assignUserId - The assignUserId object.
-         * @param assignUserId.xAlgoliaUserID - User ID to assign.
+         * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
          * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -2128,7 +2128,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * - admin.
          *
          * @param batchAssignUserIds - The batchAssignUserIds object.
-         * @param batchAssignUserIds.xAlgoliaUserID - User ID to assign.
+         * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
          * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -2934,7 +2934,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * - admin.
          *
          * @param getUserId - The getUserId object.
-         * @param getUserId.userID - User ID to assign.
+         * @param getUserId.userID - Unique identifier of the user who makes the search request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getUserId({ userID }, requestOptions) {
@@ -3183,7 +3183,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * - admin.
          *
          * @param removeUserId - The removeUserId object.
-         * @param removeUserId.userID - User ID to assign.
+         * @param removeUserId.userID - Unique identifier of the user who makes the search request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         removeUserId({ userID }, requestOptions) {

package/dist/algoliasearch.esm.browser.js

@@ -685,7 +685,7 @@ const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
 const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
 
 // 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$4 = '5.0.0-alpha.110';
+const apiClientVersion$4 = '5.0.0-alpha.111';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -990,7 +990,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // 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$3 = '5.0.0-alpha.110';
+const apiClientVersion$3 = '5.0.0-alpha.111';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$2(region) {
     const url = !region
@@ -1153,8 +1153,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getAddToCartRate - The getAddToCartRate object.
          * @param getAddToCartRate.index - Index name.
-         * @param getAddToCartRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getAddToCartRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getAddToCartRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getAddToCartRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getAddToCartRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1193,8 +1193,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getAverageClickPosition - The getAverageClickPosition object.
          * @param getAverageClickPosition.index - Index name.
-         * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getAverageClickPosition.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getAverageClickPosition.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getAverageClickPosition.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1233,8 +1233,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getClickPositions - The getClickPositions object.
          * @param getClickPositions.index - Index name.
-         * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getClickPositions.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getClickPositions.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getClickPositions.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1273,8 +1273,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getClickThroughRate - The getClickThroughRate object.
          * @param getClickThroughRate.index - Index name.
-         * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getClickThroughRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getClickThroughRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getClickThroughRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1313,8 +1313,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getConversionRate - The getConversionRate object.
          * @param getConversionRate.index - Index name.
-         * @param getConversionRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getConversionRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getConversionRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getConversionRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getConversionRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1353,8 +1353,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getNoClickRate - The getNoClickRate object.
          * @param getNoClickRate.index - Index name.
-         * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getNoClickRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getNoClickRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getNoClickRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1393,8 +1393,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getNoResultsRate - The getNoResultsRate object.
          * @param getNoResultsRate.index - Index name.
-         * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getNoResultsRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getNoResultsRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getNoResultsRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1433,8 +1433,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getPurchaseRate - The getPurchaseRate object.
          * @param getPurchaseRate.index - Index name.
-         * @param getPurchaseRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getPurchaseRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getPurchaseRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getPurchaseRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getPurchaseRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1473,8 +1473,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getRevenue - The getRevenue object.
          * @param getRevenue.index - Index name.
-         * @param getRevenue.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getRevenue.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getRevenue.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getRevenue.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getRevenue.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1513,8 +1513,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getSearchesCount - The getSearchesCount object.
          * @param getSearchesCount.index - Index name.
-         * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getSearchesCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getSearchesCount.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1553,8 +1553,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getSearchesNoClicks - The getSearchesNoClicks object.
          * @param getSearchesNoClicks.index - Index name.
-         * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getSearchesNoClicks.limit - Number of items to return.
          * @param getSearchesNoClicks.offset - Position of the first item to return.
          * @param getSearchesNoClicks.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -1601,8 +1601,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getSearchesNoResults - The getSearchesNoResults object.
          * @param getSearchesNoResults.index - Index name.
-         * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getSearchesNoResults.limit - Number of items to return.
          * @param getSearchesNoResults.offset - Position of the first item to return.
          * @param getSearchesNoResults.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -1677,8 +1677,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getTopCountries - The getTopCountries object.
          * @param getTopCountries.index - Index name.
-         * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getTopCountries.limit - Number of items to return.
          * @param getTopCountries.offset - Position of the first item to return.
          * @param getTopCountries.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -1726,8 +1726,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopFilterAttributes - The getTopFilterAttributes object.
          * @param getTopFilterAttributes.index - Index name.
          * @param getTopFilterAttributes.search - Search query.
-         * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getTopFilterAttributes.limit - Number of items to return.
          * @param getTopFilterAttributes.offset - Position of the first item to return.
          * @param getTopFilterAttributes.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -1779,8 +1779,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopFilterForAttribute.attribute - Attribute name.
          * @param getTopFilterForAttribute.index - Index name.
          * @param getTopFilterForAttribute.search - Search query.
-         * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getTopFilterForAttribute.limit - Number of items to return.
          * @param getTopFilterForAttribute.offset - Position of the first item to return.
          * @param getTopFilterForAttribute.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -1834,8 +1834,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
          * @param getTopFiltersNoResults.index - Index name.
          * @param getTopFiltersNoResults.search - Search query.
-         * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getTopFiltersNoResults.limit - Number of items to return.
          * @param getTopFiltersNoResults.offset - Position of the first item to return.
          * @param getTopFiltersNoResults.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -1888,8 +1888,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopHits.search - Search query.
          * @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
          * @param getTopHits.revenueAnalytics - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
-         * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getTopHits.limit - Number of items to return.
          * @param getTopHits.offset - Position of the first item to return.
          * @param getTopHits.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -1947,8 +1947,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          * @param getTopSearches.index - Index name.
          * @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
          * @param getTopSearches.revenueAnalytics - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
-         * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopSearches.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getTopSearches.orderBy - Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
          * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
          * @param getTopSearches.limit - Number of items to return.
@@ -2009,8 +2009,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @param getUsersCount - The getUsersCount object.
          * @param getUsersCount.index - Index name.
-         * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
-         * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getUsersCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getUsersCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
          * @param getUsersCount.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -2045,7 +2045,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // 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$2 = '5.0.0-alpha.110';
+const apiClientVersion$2 = '5.0.0-alpha.111';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$1(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -2306,7 +2306,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
 }
 
 // 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$1 = '5.0.0-alpha.110';
+const apiClientVersion$1 = '5.0.0-alpha.111';
 function getDefaultHosts(appId) {
     return [
         {
@@ -2742,7 +2742,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * - admin.
          *
          * @param assignUserId - The assignUserId object.
-         * @param assignUserId.xAlgoliaUserID - User ID to assign.
+         * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
          * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -2808,7 +2808,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * - admin.
          *
          * @param batchAssignUserIds - The batchAssignUserIds object.
-         * @param batchAssignUserIds.xAlgoliaUserID - User ID to assign.
+         * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
          * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -3614,7 +3614,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * - admin.
          *
          * @param getUserId - The getUserId object.
-         * @param getUserId.userID - User ID to assign.
+         * @param getUserId.userID - Unique identifier of the user who makes the search request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getUserId({ userID }, requestOptions) {
@@ -3863,7 +3863,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
          * - admin.
          *
          * @param removeUserId - The removeUserId object.
-         * @param removeUserId.userID - User ID to assign.
+         * @param removeUserId.userID - Unique identifier of the user who makes the search request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         removeUserId({ userID }, requestOptions) {