@algolia/client-abtesting 5.0.0-alpha.99 → 5.0.0-beta.10

package/dist/model/variant.d.ts

@@ -1,4 +1,4 @@
-import type { CurrenciesValue } from './currenciesValue';
+import type { Currency } from './currency';
 import type { FilterEffects } from './filterEffects';
 export type Variant = {
     /**
@@ -6,73 +6,77 @@ export type Variant = {
      */
     addToCartCount: number;
     /**
-     * Variant\'s [add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate).
+     * [Add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate) for this variant.
      */
-    addToCartRate: number;
+    addToCartRate: number | null;
     /**
-     * Variant\'s [average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position).
+     * [Average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) for this variant.
      */
-    averageClickPosition: number;
+    averageClickPosition: number | null;
     /**
      * Number of click events for this variant.
      */
     clickCount: number;
     /**
-     * Variant\'s [click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+     * [Click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate) for this variant.
      */
-    clickThroughRate: number;
+    clickThroughRate: number | null;
     /**
      * Number of click events for this variant.
      */
     conversionCount: number;
     /**
-     * Variant\'s [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
+     * [Conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate) for this variant.
      */
-    conversionRate: number;
+    conversionRate: number | null;
     /**
      * A/B test currencies.
      */
-    currencies: Record<string, CurrenciesValue>;
+    currencies?: Record<string, Currency>;
     /**
-     * A/B test description.
+     * Description for this variant.
      */
     description: string;
+    /**
+     * Estimated number of searches required to achieve the desired statistical significance.  The A/B test configuration must include a `mininmumDetectableEffect` setting for this number to be included in the response.
+     */
+    estimatedSampleSize?: number;
     filterEffects?: FilterEffects;
     /**
-     * A/B test index.
+     * Index name of the A/B test variant (case-sensitive).
      */
     index: string;
     /**
-     * Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for that variant.
+     * Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for this variant.
      */
-    noResultCount: number;
+    noResultCount: number | null;
     /**
      * Number of purchase events for this variant.
      */
     purchaseCount: number;
     /**
-     * Variant\'s [purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate).
+     * [Purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate) for this variant.
      */
-    purchaseRate: number;
+    purchaseRate: number | null;
     /**
-     * Number of searches carried out during the A/B test.
+     * Number of searches for this variant.
      */
-    searchCount: number;
+    searchCount: number | null;
     /**
-     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      */
-    trackedSearchCount: number;
+    trackedSearchCount?: number;
     /**
-     * A/B test traffic percentage.
+     * Percentage of search requests each variant receives.
      */
     trafficPercentage: number;
     /**
-     * Number of users during the A/B test.
+     * Number of users that made searches to this variant.
      */
-    userCount: number;
+    userCount: number | null;
     /**
-     * Number of users that performed a tracked search during the A/B test.
+     * Number of users that made tracked searches to this variant.
      */
-    trackedUserCount: number;
+    trackedUserCount: number | null;
 };
 //# sourceMappingURL=variant.d.ts.map

package/dist/model/variant.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"variant.d.ts","sourceRoot":"","sources":["../../model/variant.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAE5C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC"}
+{"version":3,"file":"variant.d.ts","sourceRoot":"","sources":["../../model/variant.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC,CAAC"}

package/dist/src/abtestingClient.d.ts

@@ -4,7 +4,7 @@ import type { ABTestResponse } from '../model/aBTestResponse';
 import type { AddABTestsRequest } from '../model/addABTestsRequest';
 import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteABTestProps, GetABTestProps, ListABTestsProps, StopABTestProps } from '../model/clientMethodProps';
 import type { ListABTestsResponse } from '../model/listABTestsResponse';
-export declare const apiClientVersion = "5.0.0-alpha.99";
+export declare const apiClientVersion = "5.0.0-beta.10";
 export declare const REGIONS: readonly ["de", "us"];
 export type Region = (typeof REGIONS)[number];
 export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -31,9 +31,11 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
      */
     addAlgoliaAgent(segment: string, version?: string): void;
     /**
-     * Creates an A/B test.
+     * Creates a new A/B test.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Create an A/B test.
      * @param addABTestsRequest - The addABTestsRequest object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -41,7 +43,6 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -51,7 +52,6 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -61,7 +61,6 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -72,7 +71,6 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -81,47 +79,51 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
      */
     customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+     * Deletes an A/B test by its ID.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Delete an A/B test.
      * @param deleteABTest - The deleteABTest object.
-     * @param deleteABTest.id - Unique A/B test ID.
+     * @param deleteABTest.id - Unique A/B test identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteABTest({ id }: DeleteABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
     /**
-     * Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+     * Retrieves the details for an A/B test by its ID.
+     *
+     * Required API Key ACLs:
+     * - analytics.
      *
-     * @summary Get A/B test details.
      * @param getABTest - The getABTest object.
-     * @param getABTest.id - Unique A/B test ID.
+     * @param getABTest.id - Unique A/B test identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getABTest({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<ABTest>;
     /**
-     * List all A/B tests.
+     * Lists all A/B tests you configured for this application.
+     *
+     * Required API Key ACLs:
+     * - analytics.
      *
-     * @summary List all A/B tests.
      * @param listABTests - The listABTests object.
-     * @param listABTests.offset - Position of the starting record. Used for paging. 0 is the first record.
-     * @param listABTests.limit - Number of records to return (page size).
-     * @param listABTests.indexPrefix - Only return A/B tests for indices starting with this prefix.
-     * @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
+     * @param listABTests.offset - Position of the first item to return.
+     * @param listABTests.limit - Number of items to return.
+     * @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
+     * @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listABTests({ offset, limit, indexPrefix, indexSuffix }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<ListABTestsResponse>;
     /**
-     * If stopped, the test is over and can\'t be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+     * Stops an A/B test by its ID.  You can\'t restart stopped A/B tests.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Stop an A/B test.
      * @param stopABTest - The stopABTest object.
-     * @param stopABTest.id - Unique A/B test ID.
+     * @param stopABTest.id - Unique A/B test identifier.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     stopABTest({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
 };
-/**
- * The client type.
- */
-export type AbtestingClient = ReturnType<typeof createAbtestingClient>;
 //# sourceMappingURL=abtestingClient.d.ts.map

package/dist/src/abtestingClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"abtestingClient.d.ts","sourceRoot":"","sources":["../../src/abtestingClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAExE,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAW9C,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;;IAwBxC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;OAMG;kCAEkB,iBAAiB,mBACnB,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAsC1B;;;;;;;;OAQG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;;OASG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;OAOG;yBAEO,iBAAiB,mBACR,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;OAOG;sBAEO,cAAc,mBACL,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAsBlB;;;;;;;;;;OAUG;8DAE4C,gBAAgB,mBAC7C,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IA+B/B;;;;;;;OAOG;uBAEO,eAAe,mBACN,cAAc,GAC9B,QAAQ,cAAc,CAAC;EAwB7B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"abtestingClient.d.ts","sourceRoot":"","sources":["../../src/abtestingClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,eAAe,EAChB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAExE,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAW9C,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;;IAwBxC;;OAEG;;IAGH;;OAEG;kBACW,OAAO,CAAC,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;kCAEkB,iBAAiB,mBACnB,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;IAsC1B;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;yBAEO,iBAAiB,mBACR,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;IAwB1B;;;;;;;;;OASG;sBAEO,cAAc,mBACL,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC;IAsBlB;;;;;;;;;;;;OAYG;8DAE4C,gBAAgB,mBAC7C,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,mBAAmB,CAAC;IA+B/B;;;;;;;;;OASG;uBAEO,eAAe,mBACN,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;EAwB7B"}

package/model/aBTest.ts

@@ -1,50 +1,37 @@
 // 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 { ABTestConfiguration } from './aBTestConfiguration';
+import type { Status } from './status';
 import type { Variant } from './variant';
 
 export type ABTest = {
   /**
-   * Unique A/B test ID.
+   * Unique A/B test identifier.
    */
   abTestID: number;
 
-  /**
-   * [A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance) based on click data. A value of 0.95 or over is considered to be _significant_.
-   */
-  clickSignificance: number;
+  clickSignificance: number | null;
 
-  /**
-   * [A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance) based on conversion. A value of 0.95 or over is considered to be _significant_.
-   */
-  conversionSignificance: number;
+  conversionSignificance: number | null;
 
-  /**
-   * [A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance) based on add-to-cart data. A value of 0.95 or over is considered to be _significant_.
-   */
-  addToCartSignificance: number;
+  addToCartSignificance: number | null;
 
-  /**
-   * [A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance) based on purchase data. A value of 0.95 or over is considered to be _significant_.
-   */
-  purchaseSignificance: number;
+  purchaseSignificance: number | null;
 
-  /**
-   * [A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance) based on revenue data. A value of 0.95 or over is considered to be _significant_.
-   */
-  revenueSignificance: Record<string, number>;
+  revenueSignificance: Record<string, number> | null;
 
   /**
-   * Update date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time when the A/B test was last updated, in RFC 3339 format.
    */
   updatedAt: string;
 
   /**
-   * Creation date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time when the A/B test was created, in RFC 3339 format.
    */
   createdAt: string;
 
   /**
-   * End date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * End date and time of the A/B test, in RFC 3339 format.
    */
   endAt: string;
 
@@ -53,13 +40,12 @@ export type ABTest = {
    */
   name: string;
 
-  /**
-   * A/B test status.
-   */
-  status: string;
+  status: Status;
 
   /**
-   * A/B test variants.
+   * A/B test variants.  The first variant is your _control_ index, typically your production index. The second variant is an index with changed settings that you want to test against the control.
    */
   variants: Variant[];
+
+  configuration?: ABTestConfiguration;
 };

package/model/aBTestConfiguration.ts

@@ -0,0 +1,16 @@
+// 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 { EmptySearch } from './emptySearch';
+import type { MinimumDetectableEffect } from './minimumDetectableEffect';
+import type { Outliers } from './outliers';
+
+/**
+ * A/B test configuration.
+ */
+export type ABTestConfiguration = {
+  outliers: Outliers;
+
+  emptySearch?: EmptySearch;
+
+  minimumDetectableEffect?: MinimumDetectableEffect;
+};

package/model/aBTestResponse.ts

@@ -2,17 +2,17 @@
 
 export type ABTestResponse = {
   /**
-   * A/B test index.
+   * Index name of the A/B test variant (case-sensitive).
    */
   index: string;
 
   /**
-   * Unique A/B test ID.
+   * Unique A/B test identifier.
    */
   abTestID: number;
 
   /**
-   * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
+   * Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
    */
   taskID: number;
 };

package/model/abTestsVariant.ts

@@ -2,17 +2,17 @@
 
 export type AbTestsVariant = {
   /**
-   * A/B test index.
+   * Index name of the A/B test variant (case-sensitive).
    */
   index: string;
 
   /**
-   * A/B test traffic percentage.
+   * Percentage of search requests each variant receives.
    */
   trafficPercentage: number;
 
   /**
-   * A/B test description.
+   * Description for this variant.
    */
   description?: string;
 };

package/model/addABTestsRequest.ts

@@ -14,7 +14,7 @@ export type AddABTestsRequest = {
   variants: AddABTestsVariant[];
 
   /**
-   * End date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * End date and time of the A/B test, in RFC 3339 format.
    */
   endAt: string;
 };

package/model/clientMethodProps.ts

@@ -69,7 +69,7 @@ export type CustomPutProps = {
  */
 export type DeleteABTestProps = {
   /**
-   * Unique A/B test ID.
+   * Unique A/B test identifier.
    */
   id: number;
 };
@@ -79,7 +79,7 @@ export type DeleteABTestProps = {
  */
 export type GetABTestProps = {
   /**
-   * Unique A/B test ID.
+   * Unique A/B test identifier.
    */
   id: number;
 };
@@ -89,19 +89,19 @@ export type GetABTestProps = {
  */
 export type ListABTestsProps = {
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
   offset?: number;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Only return A/B tests for indices starting with this prefix.
+   * Index name prefix. Only A/B tests for indices starting with this string are included in the response.
    */
   indexPrefix?: string;
   /**
-   * Only return A/B tests for indices ending with this suffix.
+   * Index name suffix. Only A/B tests for indices ending with this string are included in the response.
    */
   indexSuffix?: string;
 };
@@ -111,7 +111,7 @@ export type ListABTestsProps = {
  */
 export type StopABTestProps = {
   /**
-   * Unique A/B test ID.
+   * Unique A/B test identifier.
    */
   id: number;
 };

package/model/{currenciesValue.ts → currency.ts}

@@ -1,6 +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.
 
-export type CurrenciesValue = {
+export type Currency = {
   /**
    * Currency code.
    */

package/model/customSearchParams.ts

@@ -1,7 +1,7 @@
 // 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.
 
 /**
- * Applies search parameters from [a restricted set of options](https://www.algolia.com/doc/api-reference/api-methods/add-ab-test/#method-param-customsearchparameters). Only use this parameter if the two variants use the same index.
+ * Search parameters to add to the test variant. Only use this parameter if the two variants use the same index.
  */
 export type CustomSearchParams = {
   customSearchParameters: Record<string, any>;

package/model/effect.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.
+
+/**
+ * Metric for which you want to detect the smallest relative difference.
+ */
+export type Effect =
+  | 'addToCartRate'
+  | 'clickThroughRate'
+  | 'conversionRate'
+  | 'purchaseRate';

package/model/emptySearch.ts

@@ -0,0 +1,11 @@
+// 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.
+
+/**
+ * Configuration for handling empty searches.
+ */
+export type EmptySearch = {
+  /**
+   * Whether to exclude empty searches when calculating A/B test results.
+   */
+  exclude?: boolean;
+};

package/model/index.ts

@@ -1,17 +1,23 @@
 // 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.
 
 export * from './aBTest';
+export * from './aBTestConfiguration';
 export * from './aBTestResponse';
 export * from './abTestsVariant';
 export * from './abTestsVariantSearchParams';
 export * from './addABTestsRequest';
 export * from './addABTestsVariant';
-export * from './currenciesValue';
+export * from './currency';
 export * from './customSearchParams';
+export * from './effect';
+export * from './emptySearch';
 export * from './errorBase';
 export * from './filterEffects';
 export * from './filterEffectsEmptySearch';
 export * from './filterEffectsOutliers';
 export * from './listABTestsResponse';
+export * from './minimumDetectableEffect';
+export * from './outliers';
+export * from './status';
 export * from './variant';
 export * from './clientMethodProps';

package/model/listABTestsResponse.ts

@@ -6,10 +6,10 @@ export type ListABTestsResponse = {
   /**
    * A/B tests.
    */
-  abtests: ABTest[];
+  abtests: ABTest[] | null;
 
   /**
-   * Number of A/B tests implemented.
+   * Number of A/B tests.
    */
   count: number;
 

package/model/minimumDetectableEffect.ts

@@ -0,0 +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.
+
+import type { Effect } from './effect';
+
+/**
+ * Configuration for the smallest difference between test variants you want to detect.
+ */
+export type MinimumDetectableEffect = {
+  /**
+   * Smallest difference in an observable metric between variants. For example, to detect a 10% difference between variants, set this value to 0.1.
+   */
+  size?: number;
+
+  effect?: Effect;
+};

package/model/outliers.ts

@@ -0,0 +1,11 @@
+// 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.
+
+/**
+ * Configuration for handling outliers.
+ */
+export type Outliers = {
+  /**
+   * Whether to exclude outliers when calculating A/B test results.
+   */
+  exclude?: boolean;
+};

package/model/status.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 status.  - `active`. The A/B test is live and search traffic is split between the two variants. - `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. - `expired`. The A/B test was automatically stopped after reaching its end date. - `failed`. Creating the A/B test failed.
+ */
+export type Status = 'active' | 'expired' | 'failed' | 'stopped';