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

package/dist/client-analytics/model/clientMethodProps.d.ts

@@ -69,11 +69,11 @@ export type GetAddToCartRateProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -90,11 +90,11 @@ export type GetAverageClickPositionProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -111,11 +111,11 @@ export type GetClickPositionsProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -132,11 +132,11 @@ export type GetClickThroughRateProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -153,11 +153,11 @@ export type GetConversionRateProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -174,11 +174,11 @@ export type GetNoClickRateProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -195,11 +195,11 @@ export type GetNoResultsRateProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -216,11 +216,11 @@ export type GetPurchaseRateProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -237,11 +237,11 @@ export type GetRevenueProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -258,11 +258,11 @@ export type GetSearchesCountProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -279,11 +279,11 @@ export type GetSearchesNoClicksProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -308,11 +308,11 @@ export type GetSearchesNoResultsProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -346,11 +346,11 @@ export type GetTopCountriesProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -379,11 +379,11 @@ export type GetTopFilterAttributesProps = {
      */
     search?: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -416,11 +416,11 @@ export type GetTopFilterForAttributeProps = {
      */
     search?: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -449,11 +449,11 @@ export type GetTopFiltersNoResultsProps = {
      */
     search?: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -490,11 +490,11 @@ export type GetTopHitsProps = {
      */
     revenueAnalytics?: boolean;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -527,11 +527,11 @@ export type GetTopSearchesProps = {
      */
     revenueAnalytics?: boolean;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**
@@ -564,11 +564,11 @@ export type GetUsersCountProps = {
      */
     index: string;
     /**
-     * Start date (`YYYY-MM-DD`) of the period to analyze.
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
      */
     startDate?: string;
     /**
-     * End date (`YYYY-MM-DD`) of the period to analyze.
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
      */
     endDate?: string;
     /**

package/dist/client-analytics/model/getStatusResponse.d.ts

@@ -1,6 +1,6 @@
 export type GetStatusResponse = {
     /**
-     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format. If null, no update was performed yet.
+     * Date and time when the object was updated, in RFC 3339 format.
      */
     updatedAt: string | null;
 };

package/dist/client-analytics/src/analyticsClient.d.ts

@@ -20,7 +20,7 @@ import type { GetTopFiltersNoResultsResponse } from '../model/getTopFiltersNoRes
 import type { GetTopHitsResponse } from '../model/getTopHitsResponse';
 import type { GetTopSearchesResponse } from '../model/getTopSearchesResponse';
 import type { GetUsersCountResponse } from '../model/getUsersCountResponse';
-export declare const apiClientVersion = "5.0.0-alpha.110";
+export declare const apiClientVersion = "5.0.0-alpha.111";
 export declare const REGIONS: readonly ["de", "us"];
 export type Region = (typeof REGIONS)[number];
 export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -92,8 +92,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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.
      */
@@ -106,8 +106,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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.
      */
@@ -120,8 +120,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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.
      */
@@ -134,8 +134,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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.
      */
@@ -148,8 +148,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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.
      */
@@ -162,8 +162,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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.
      */
@@ -176,8 +176,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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.
      */
@@ -190,8 +190,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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.
      */
@@ -204,8 +204,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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.
      */
@@ -218,8 +218,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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.
      */
@@ -232,8 +232,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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/).
@@ -248,8 +248,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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/).
@@ -275,8 +275,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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/).
@@ -292,8 +292,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @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/).
@@ -310,8 +310,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @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/).
@@ -327,8 +327,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @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/).
@@ -346,8 +346,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @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/).
@@ -364,8 +364,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @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.
@@ -382,8 +382,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      *
      * @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.
      */

package/dist/client-personalization/src/personalizationClient.d.ts

@@ -4,7 +4,7 @@ import type { DeleteUserProfileResponse } from '../model/deleteUserProfileRespon
 import type { GetUserTokenResponse } from '../model/getUserTokenResponse';
 import type { PersonalizationStrategyParams } from '../model/personalizationStrategyParams';
 import type { SetPersonalizationStrategyResponse } from '../model/setPersonalizationStrategyResponse';
-export declare const apiClientVersion = "5.0.0-alpha.110";
+export declare const apiClientVersion = "5.0.0-alpha.111";
 export declare const REGIONS: readonly ["eu", "us"];
 export type Region = (typeof REGIONS)[number];
 export declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {

package/dist/client-search/model/addApiKeyResponse.d.ts

@@ -4,7 +4,7 @@ export type AddApiKeyResponse = {
      */
     key: string;
     /**
-     * Timestamp of creation in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     * Date and time when the object was created, in RFC 3339 format.
      */
     createdAt: string;
 };

package/dist/client-search/model/baseGetApiKeyResponse.d.ts

@@ -4,7 +4,7 @@ export type BaseGetApiKeyResponse = {
      */
     value?: string;
     /**
-     * Timestamp of creation in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time).
+     * Timestamp when the object was created, in milliseconds since the Unix epoch.
      */
     createdAt: number;
 };

package/dist/client-search/model/baseIndexSettings.d.ts

@@ -1,11 +1,11 @@
 import type { SupportedLanguage } from './supportedLanguage';
 export type BaseIndexSettings = {
     /**
-     * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).  Facets are ways to categorize search results based on attributes. Facets can be used to let user filter search results. By default, no attribute is used for faceting.  **Modifiers**  <dl> <dt><code>filterOnly(\"ATTRIBUTE\")</code></dt> <dd>Allows using this attribute as a filter, but doesn\'t evalue the facet values.</dd> <dt><code>searchable(\"ATTRIBUTE\")</code></dt> <dd>Allows searching for facet values.</dd> <dt><code>afterDistinct(\"ATTRIBUTE\")</code></dt> <dd>  Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.  </dd> </dl>  Without modifiers, the attribute is used as a regular facet.
+     * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).  Facets are ways to categorize search results based on attributes. Facets can be used to let user filter search results. By default, no attribute is used for faceting.  **Modifiers**  - `filterOnly(\"ATTRIBUTE\")`.   Allows using this attribute as a filter, but doesn\'t evalue the facet values.  - `searchable(\"ATTRIBUTE\")`.   Allows searching for facet values.  - `afterDistinct(\"ATTRIBUTE\")`.   Evaluates the facet count _after_ deduplication with `distinct`.   This ensures accurate facet counts.   You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
      */
     attributesForFaceting?: string[];
     /**
-     * Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).  Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you\'ll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index.  **Modifier**  <dl> <dt><code>virtual(\"REPLICA\")</code></dt> <dd>  Create a virtual replica, Virtual replicas don\'t increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).  </dd> </dl>  Without modifier, a standard replica is created, which duplicates your record count and is used for strict, or [exhaustive sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/exhaustive-sort/).
+     * Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).  Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you\'ll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index.  **Modifier**  - `virtual(\"REPLICA\")`.   Create a virtual replica,   Virtual replicas don\'t increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).
      */
     replicas?: string[];
     /**
@@ -45,7 +45,7 @@ export type BaseIndexSettings = {
      */
     allowCompressionOfIntegerArray?: boolean;
     /**
-     * Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).  By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes.  If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`.  **Modifier**  <dl> <dt><code>equalOnly(\"ATTRIBUTE\")</code></dt> <dd>  Support only filtering based on equality comparisons `=` and `!=`.  </dd> </dl>  Without modifier, all numeric comparisons are supported.
+     * Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).  By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes.  If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`.  **Modifier**  - `equalOnly(\"ATTRIBUTE\")`.   Support only filtering based on equality comparisons `=` and `!=`.
      */
     numericAttributesForFiltering?: string[];
     /**
@@ -53,7 +53,7 @@ export type BaseIndexSettings = {
      */
     separatorsToIndex?: string;
     /**
-     * Attributes used for searching.  By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered.  For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).  **Modifier**  <dl> <dt><code>unordered(\"ATTRIBUTE\")</code></dt> <dd> Ignore the position of a match within the attribute. </dd> </dl>  Without modifier, matches at the beginning of an attribute rank higer than matches at the end.
+     * Attributes used for searching.  By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered.  For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).  **Modifier**  - `unordered(\"ATTRIBUTE\")`.   Ignore the position of a match within the attribute.  Without modifier, matches at the beginning of an attribute rank higer than matches at the end.
      */
     searchableAttributes?: string[];
     /**

package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts

@@ -10,7 +10,7 @@ export type BaseSearchParamsWithoutQuery = {
      */
     similarQuery?: string;
     /**
-     * Filter the search so that only records with matching values are included in the results.  These filters are supported:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+     * Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
      */
     filters?: string;
     facetFilters?: FacetFilters;

package/dist/client-search/model/clientMethodProps.d.ts

@@ -49,7 +49,7 @@ export type AddOrUpdateObjectProps = {
  */
 export type AssignUserIdProps = {
     /**
-     * User ID to assign.
+     * Unique identifier of the user who makes the search request.
      */
     xAlgoliaUserID: string;
     assignUserIdParams: AssignUserIdParams;
@@ -69,7 +69,7 @@ export type BatchProps = {
  */
 export type BatchAssignUserIdsProps = {
     /**
-     * User ID to assign.
+     * Unique identifier of the user who makes the search request.
      */
     xAlgoliaUserID: string;
     batchAssignUserIdsParams: BatchAssignUserIdsParams;
@@ -373,7 +373,7 @@ export type GetTaskProps = {
  */
 export type GetUserIdProps = {
     /**
-     * User ID to assign.
+     * Unique identifier of the user who makes the search request.
      */
     userID: string;
 };
@@ -448,7 +448,7 @@ export type PartialUpdateObjectProps = {
  */
 export type RemoveUserIdProps = {
     /**
-     * User ID to assign.
+     * Unique identifier of the user who makes the search request.
      */
     userID: string;
 };

package/dist/client-search/model/createdAtResponse.d.ts

@@ -3,7 +3,7 @@
  */
 export type CreatedAtResponse = {
     /**
-     * Timestamp of creation in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     * Date and time when the object was created, in RFC 3339 format.
      */
     createdAt: string;
 };

package/dist/client-search/model/deleteApiKeyResponse.d.ts

@@ -1,6 +1,6 @@
 export type DeleteApiKeyResponse = {
     /**
-     * Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     * Date and time when the object was deleted, in RFC 3339 format.
      */
     deletedAt: string;
 };