fix(specs): BREAKING CHANGE - make AB test pValue optional (generated)

algolia/api-clients-automation#7066

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]

package.json

@@ -27,7 +27,7 @@
     "files": [
       {
         "path": "packages/algoliasearch/dist/algoliasearch.umd.js",
-        "maxSize": "22KB"
+        "maxSize": "22.25KB"
       },
       {
         "path": "packages/algoliasearch/dist/lite/builds/browser.umd.js",

packages/abtesting/model/aBTestConfiguration.ts

@@ -1,8 +1,10 @@
 // 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.
 
+import type { AnalysisMethod } from './analysisMethod';
 import type { ErrorCorrectionType } from './errorCorrectionType';
 import type { MetricsFilter } from './metricsFilter';
 import type { MinimumDetectableEffect } from './minimumDetectableEffect';
+import type { PrimaryMetric } from './primaryMetric';
 
 /**
  * A/B test configuration.
@@ -16,4 +18,8 @@ export type ABTestConfiguration = {
   filters?: Array<MetricsFilter> | undefined;
 
   errorCorrection?: ErrorCorrectionType | undefined;
+
+  method?: AnalysisMethod | undefined;
+
+  primaryMetric?: PrimaryMetric | undefined;
 };

packages/abtesting/model/analysisMethod.ts

@@ -0,0 +1,6 @@
+// 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.
+
+/**
+ * A/B test statistical analysis method. When omitted, the test is treated as `frequentist`. The server doesn\'t write a default value back to the configuration.
+ */
+export type AnalysisMethod = 'bayesian' | 'frequentist';

packages/abtesting/model/bayesianMetricResult.ts

@@ -0,0 +1,25 @@
+// 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.
+
+import type { MetricEvidence } from './metricEvidence';
+
+/**
+ * Bayesian inference results for this variant metric. Omitted when Bayesian results aren\'t requested or no Bayesian result is available for this metric. Individual inference fields can be omitted when their values aren\'t available.
+ */
+export type BayesianMetricResult = {
+  /**
+   * Probability that this variant is better than the control.
+   */
+  probabilityToBeBetter?: number | undefined;
+
+  /**
+   * Lower bound of the 95% credible interval for the relative effect (variant/control minus 1).
+   */
+  relativeEffectCILow?: number | undefined;
+
+  /**
+   * Upper bound of the 95% credible interval for the relative effect (variant/control minus 1).
+   */
+  relativeEffectCIHigh?: number | undefined;
+
+  evidence?: MetricEvidence | undefined;
+};

packages/abtesting/model/clientMethodProps.ts

@@ -1,5 +1,6 @@
 // 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.
 
+import type { AnalysisMethod } from '../model/analysisMethod';
 import type { Direction } from '../model/direction';
 import type { MetricName } from '../model/metricName';
 import type { SaveSettingsRequest } from '../model/saveSettingsRequest';
@@ -100,6 +101,10 @@ export type GetABTestProps = {
    * Unique A/B test identifier.
    */
   id: number;
+  /**
+   * 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.
+   */
+  methods?: Array<AnalysisMethod> | undefined;
 };
 
 /**
@@ -132,6 +137,10 @@ export type GetTimeseriesProps = {
    * List of metrics to retrieve. If not specified, all metrics are returned.
    */
   metric?: Array<MetricName> | undefined;
+  /**
+   * 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.
+   */
+  methods?: Array<AnalysisMethod> | undefined;
 };
 
 /**
@@ -158,6 +167,10 @@ export type ListABTestsProps = {
    * Sort order for A/B tests by start date. Use \'asc\' for ascending or \'desc\' for descending. Active A/B tests are always listed first.
    */
   direction?: Direction | undefined;
+  /**
+   * 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.
+   */
+  methods?: Array<AnalysisMethod> | undefined;
 };
 
 /**

packages/abtesting/model/evidenceStatus.ts

@@ -0,0 +1,6 @@
+// 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.
+
+/**
+ * Whether this variant metric\'s result is trustworthy yet. This doesn\'t mean the A/B test has ended, and it doesn\'t declare a winning variant.  - `enough`. Enough evidence has accumulated to trust this metric\'s result for this variant. - `not_enough`. Evidence was computed but hasn\'t reached the threshold yet. - `collecting`. Evidence is still accumulating, so it\'s too early to report a verdict. - `no_data`. No usable data for this variant metric, and none is expected for it. - `unavailable`. Evidence can\'t be computed for this variant metric\'s comparison.
+ */
+export type EvidenceStatus = 'enough' | 'not_enough' | 'collecting' | 'no_data' | 'unavailable';

packages/abtesting/model/index.ts

@@ -8,6 +8,8 @@ export * from './abTestsVariant';
 export * from './abTestsVariantSearchParams';
 export * from './addABTestsRequest';
 export * from './addABTestsVariant';
+export * from './analysisMethod';
+export * from './bayesianMetricResult';
 export * from './clientMethodProps';
 export * from './conflictResponse';
 export * from './createMetric';
@@ -21,16 +23,19 @@ export * from './errorCorrectionType';
 export * from './estimateABTestRequest';
 export * from './estimateABTestResponse';
 export * from './estimateConfiguration';
+export * from './evidenceStatus';
 export * from './featureSettings';
 export * from './filterEffects';
 export * from './listABTestsResponse';
 export * from './metricDate';
+export * from './metricEvidence';
 export * from './metricMetadata';
 export * from './metricName';
 export * from './metricResult';
 export * from './metricsFilter';
 export * from './minimumDetectableEffect';
 export * from './outliersFilter';
+export * from './primaryMetric';
 export * from './saveSettingsRequest';
 export * from './status';
 export * from './timeseries';

packages/abtesting/model/metricEvidence.ts

@@ -0,0 +1,10 @@
+// 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.
+
+import type { EvidenceStatus } from './evidenceStatus';
+
+/**
+ * Evidence status for this variant metric\'s comparison with the control. Only present when the API has an evidence status for the comparison. Omitted when evidence isn\'t applicable or no status exists.
+ */
+export type MetricEvidence = {
+  status: EvidenceStatus;
+};

packages/abtesting/model/metricMetadata.ts

@@ -5,7 +5,7 @@
  */
 export type MetricMetadata = {
   /**
-   * Only present in case the metric is \'revenue\'. It is the amount exceeding the 95th percentile of global revenue transactions involved in the AB Test. This amount is not considered when calculating statistical significance. It is tied to a per revenue-currency pair contrary to other global filter effects (such as outliers and empty search count).
+   * Only present for `revenue` metrics. It is the amount exceeding the 95th percentile of global revenue transactions involved in the AB Test. This amount is not considered when calculating statistical significance. It is tied to a per revenue-currency pair contrary to other global filter effects (such as outliers and empty search count).
    */
   winsorizedValue?: number | undefined;
 

packages/abtesting/model/metricName.ts

@@ -6,6 +6,7 @@ export type MetricName =
   | 'user_count'
   | 'tracked_user_count'
   | 'no_result_count'
+  | 'tracked_no_result_count'
   | 'add_to_cart_count'
   | 'purchase_count'
   | 'clicked_search_count'
@@ -15,4 +16,6 @@ export type MetricName =
   | 'add_to_cart_rate'
   | 'purchase_rate'
   | 'average_click_position'
-  | 'revenue';
+  | 'revenue'
+  | 'revenue_per_search'
+  | 'average_order_value';