feat(specs): add user metrics to abtesting-v3 timeseries enum (generated)

algolia/api-clients-automation#7181

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Steven Evans <steven.evans@algolia.com>

Author: algolia-api-clients-automation-bot[bot]

packages/abtesting/model/clientMethodProps.ts

@@ -134,7 +134,7 @@ export type GetTimeseriesProps = {
    */
   endDate?: string | undefined;
   /**
-   * List of metrics to retrieve. If not specified, all metrics are returned.
+   * Metrics to retrieve, as a comma-separated list. If not specified, all metrics are returned.
    */
   metric?: Array<MetricName> | undefined;
   /**

packages/abtesting/model/metricName.ts

@@ -18,4 +18,20 @@ export type MetricName =
   | 'average_click_position'
   | 'revenue'
   | 'revenue_per_search'
-  | 'average_order_value';
+  | 'average_order_value'
+  | 'clicked_users_count'
+  | 'converted_users_count'
+  | 'add_to_cart_users_count'
+  | 'purchase_users_count'
+  | 'users_with_no_results_count'
+  | 'clicked_users_rate'
+  | 'converted_users_rate'
+  | 'add_to_cart_users_rate'
+  | 'purchase_users_rate'
+  | 'avg_click_through_rate_per_user'
+  | 'avg_conversion_rate_per_user'
+  | 'avg_purchase_rate_per_user'
+  | 'avg_add_to_cart_rate_per_user'
+  | 'avg_click_position_per_user'
+  | 'winsorized_revenue_per_user'
+  | 'winsorized_revenue_per_purchaser';

packages/abtesting/model/primaryMetric.ts

@@ -1,7 +1,15 @@
 // 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.
 
 /**
- * Primary metric for Bayesian analysis. Required when `method` is `bayesian`. When `method` is omitted and the test defaults to `bayesian`, the default primary metric is `conversion_rate`, or the first metric in `metrics` that supports Bayesian analysis if `metrics` doesn\'t include conversion rate. If the request includes a non-empty `metrics` list, this metric must be in that list. Revenue per search requires access to revenue analytics.
+ * Primary metric for Bayesian analysis. Required when `method` is `bayesian`. When `method` is omitted and the test defaults to `bayesian`, the default primary metric is `conversion_rate`, or the first metric in `metrics` that supports Bayesian analysis if `metrics` doesn\'t include conversion rate. If the request includes a non-empty `metrics` list, this metric must be in that list. User-level rates (`*_users_rate`) are the share of tracked users with at least one such search. Add-to-cart rates, purchase rates, and revenue per search require access to revenue analytics.
  */
 export type PrimaryMetric =
-  'add_to_cart_rate' | 'click_through_rate' | 'conversion_rate' | 'purchase_rate' | 'revenue_per_search';
+  | 'add_to_cart_rate'
+  | 'click_through_rate'
+  | 'conversion_rate'
+  | 'purchase_rate'
+  | 'revenue_per_search'
+  | 'add_to_cart_users_rate'
+  | 'clicked_users_rate'
+  | 'converted_users_rate'
+  | 'purchase_users_rate';

packages/abtesting/src/abtestingV3Client.ts

@@ -754,7 +754,7 @@ export function createAbtestingV3Client({
      * @param getTimeseries.id - Unique A/B test identifier.
      * @param getTimeseries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTimeseries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
-     * @param getTimeseries.metric - List of metrics to retrieve. If not specified, all metrics are returned.
+     * @param getTimeseries.metric - Metrics to retrieve, as a comma-separated list. If not specified, all metrics are returned.
      * @param getTimeseries.methods - Statistical analysis results to include, as a comma-separated list. When omitted, each test uses its configured method, or `frequentist` if no method is configured. Request both methods to include both sets of available results. This doesn\'t change the test configuration or compute missing results. Duplicate values aren\'t allowed.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -804,7 +804,7 @@ export function createAbtestingV3Client({
      * @param getTimeseries.id - Unique A/B test identifier.
      * @param getTimeseries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTimeseries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
-     * @param getTimeseries.metric - List of metrics to retrieve. If not specified, all metrics are returned.
+     * @param getTimeseries.metric - Metrics to retrieve, as a comma-separated list. If not specified, all metrics are returned.
      * @param getTimeseries.methods - Statistical analysis results to include, as a comma-separated list. When omitted, each test uses its configured method, or `frequentist` if no method is configured. Request both methods to include both sets of available results. This doesn\'t change the test configuration or compute missing results. Duplicate values aren\'t allowed.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @see getTimeseries for the plain version.