@algolia/client-abtesting 5.0.0-alpha.10 → 5.0.0-alpha.100

package/dist/model/filterEffectsOutliers.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Outliers removed from the A/B test as a result of configuration settings.
+ */
+export type FilterEffectsOutliers = {
+    /**
+     * Number of users removed from the A/B test.
+     */
+    usersCount?: number;
+    /**
+     * Number of tracked searches removed from the A/B test.
+     */
+    trackedSearchesCount?: number;
+};
+//# sourceMappingURL=filterEffectsOutliers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"filterEffectsOutliers.d.ts","sourceRoot":"","sources":["../../model/filterEffectsOutliers.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC"}

package/dist/model/index.d.ts

@@ -1,12 +1,16 @@
-export * from './aBTest';
-export * from './aBTestResponse';
-export * from './abTestsVariant';
-export * from './abTestsVariantSearchParams';
-export * from './addABTestsRequest';
-export * from './addABTestsVariant';
-export * from './customSearchParams';
-export * from './errorBase';
-export * from './listABTestsResponse';
-export * from './variant';
-export * from './clientMethodProps';
+export * from './aBTest';
+export * from './aBTestResponse';
+export * from './abTestsVariant';
+export * from './abTestsVariantSearchParams';
+export * from './addABTestsRequest';
+export * from './addABTestsVariant';
+export * from './currenciesValue';
+export * from './customSearchParams';
+export * from './errorBase';
+export * from './filterEffects';
+export * from './filterEffectsEmptySearch';
+export * from './filterEffectsOutliers';
+export * from './listABTestsResponse';
+export * from './variant';
+export * from './clientMethodProps';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC"}

package/dist/model/listABTestsResponse.d.ts

@@ -1,16 +1,16 @@
-import type { ABTest } from './aBTest';
-export declare type ListABTestsResponse = {
-    /**
-     * List of A/B tests.
-     */
-    abtests: ABTest[];
-    /**
-     * Number of A/B tests found for the app.
-     */
-    count: number;
-    /**
-     * Number of A/B tests retrievable.
-     */
-    total: number;
-};
+import type { ABTest } from './aBTest';
+export type ListABTestsResponse = {
+    /**
+     * A/B tests.
+     */
+    abtests: ABTest[];
+    /**
+     * Number of A/B tests implemented.
+     */
+    count: number;
+    /**
+     * Number of retrievable A/B tests.
+     */
+    total: number;
+};
 //# sourceMappingURL=listABTestsResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"listABTestsResponse.d.ts","sourceRoot":"","sources":["../../model/listABTestsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"listABTestsResponse.d.ts","sourceRoot":"","sources":["../../model/listABTestsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/model/variant.d.ts

@@ -1,51 +1,78 @@
-export declare type Variant = {
-    /**
-     * Average click position for the variant.
-     */
-    averageClickPosition: number;
-    /**
-     * Distinct click count for the variant.
-     */
-    clickCount: number;
-    /**
-     * Click through rate for the variant.
-     */
-    clickThroughRate: number;
-    /**
-     * Distinct conversion count for the variant.
-     */
-    conversionCount: number;
-    /**
-     * Conversion rate for the variant.
-     */
-    conversionRate: number;
-    /**
-     * The A/B test description.
-     */
-    description: string;
-    /**
-     * The index performing the A/B test.
-     */
-    index: string;
-    /**
-     * The number of occurrences.
-     */
-    noResultCount: number;
-    /**
-     * The number of search during the A/B test.
-     */
-    searchCount: number;
-    /**
-     * The number of tracked search click.
-     */
-    trackedSearchCount: number;
-    /**
-     * The traffic percentage for the A/B test.
-     */
-    trafficPercentage: number;
-    /**
-     * The number of user during the A/B test.
-     */
-    userCount: number;
-};
+import type { CurrenciesValue } from './currenciesValue';
+import type { FilterEffects } from './filterEffects';
+export type Variant = {
+    /**
+     * Number of add-to-cart events for this variant.
+     */
+    addToCartCount: number;
+    /**
+     * Variant\'s [add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate).
+     */
+    addToCartRate: number;
+    /**
+     * Variant\'s [average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position).
+     */
+    averageClickPosition: number;
+    /**
+     * 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).
+     */
+    clickThroughRate: number;
+    /**
+     * 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).
+     */
+    conversionRate: number;
+    /**
+     * A/B test currencies.
+     */
+    currencies: Record<string, CurrenciesValue>;
+    /**
+     * A/B test description.
+     */
+    description: string;
+    filterEffects?: FilterEffects;
+    /**
+     * A/B test index.
+     */
+    index: string;
+    /**
+     * Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for that variant.
+     */
+    noResultCount: number;
+    /**
+     * 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).
+     */
+    purchaseRate: number;
+    /**
+     * Number of searches carried out during the A/B test.
+     */
+    searchCount: number;
+    /**
+     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
+     */
+    trackedSearchCount: number;
+    /**
+     * A/B test traffic percentage.
+     */
+    trafficPercentage: number;
+    /**
+     * Number of users during the A/B test.
+     */
+    userCount: number;
+    /**
+     * Number of users that performed a tracked search during the A/B test.
+     */
+    trackedUserCount: number;
+};
 //# 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,oBAAY,OAAO,GAAG;IACpB;;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,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;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;CACnB,CAAC"}
+{"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"}

package/dist/src/abtestingClient.d.ts

@@ -1,125 +1,133 @@
-import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
-import type { ABTest } from '../model/aBTest';
-import type { ABTestResponse } from '../model/aBTestResponse';
-import type { AddABTestsRequest } from '../model/addABTestsRequest';
-import type { DelProps, DeleteABTestProps, GetProps, GetABTestProps, ListABTestsProps, PostProps, PutProps, StopABTestProps } from '../model/clientMethodProps';
-import type { ListABTestsResponse } from '../model/listABTestsResponse';
-export declare const apiClientVersion = "5.0.0-alpha.10";
-export declare const REGIONS: readonly ["de", "us"];
-export declare type Region = typeof REGIONS[number];
-export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
-    region?: Region;
-}): {
-    transporter: import("@algolia/client-common").Transporter;
-    /**
-     * The `appId` currently in use.
-     */
-    appId: string;
-    /**
-     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
-     */
-    clearCache(): Promise<void>;
-    /**
-     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
-     */
-    readonly _ua: string;
-    /**
-     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
-     *
-     * @param segment - The algolia agent (user-agent) segment to add.
-     * @param version - The version of the agent.
-     */
-    addAlgoliaAgent(segment: string, version?: string): void;
-    /**
-     * Creates a new A/B test with provided configuration. You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
-     *
-     * @summary Create a test.
-     * @param addABTestsRequest - The addABTestsRequest object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    addABTests(addABTestsRequest: AddABTestsRequest, requestOptions?: RequestOptions): Promise<ABTestResponse>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param del - The del object.
-     * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param del.parameters - Query parameters to be applied to the current query.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-    /**
-     * Delete a test.
-     *
-     * @summary Delete a test.
-     * @param deleteABTest - The deleteABTest object.
-     * @param deleteABTest.id - The A/B test ID.
-     * @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>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param get - The get object.
-     * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param get.parameters - Query parameters to be applied to the current query.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-    /**
-     * Returns metadata and metrics for an A/B test.
-     *
-     * @summary Get a test.
-     * @param getABTest - The getABTest object.
-     * @param getABTest.id - The A/B test ID.
-     * @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>;
-    /**
-     * Fetch all existing A/B tests for App that are available for the current API Key. When no data has been processed, the metrics will be returned as null.
-     *
-     * @summary List all 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. Limit is the size of the page.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    listABTests({ offset, limit }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<ListABTestsResponse>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param post - The post object.
-     * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param post.parameters - Query parameters to be applied to the current query.
-     * @param post.body - The parameters to send with the custom request.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param put - The put object.
-     * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param put.parameters - Query parameters to be applied to the current query.
-     * @param put.body - The parameters to send with the custom request.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-    /**
-     * Marks the A/B test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored.
-     *
-     * @summary Stop a test.
-     * @param stopABTest - The stopABTest object.
-     * @param stopABTest.id - The A/B test ID.
-     * @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 declare type AbtestingClient = ReturnType<typeof createAbtestingClient>;
+import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
+import type { ABTest } from '../model/aBTest';
+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.100";
+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 & {
+    region?: Region;
+}): {
+    transporter: import("@algolia/client-common").Transporter;
+    /**
+     * The `appId` currently in use.
+     */
+    appId: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    readonly _ua: string;
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void;
+    /**
+     * Creates an A/B test.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param addABTestsRequest - The addABTestsRequest object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    addABTests(addABTestsRequest: AddABTestsRequest, requestOptions?: RequestOptions): Promise<ABTestResponse>;
+    /**
+     * This method allow you to 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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to 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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to 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.
+     * @param customPost.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to 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.
+     * @param customPut.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    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).
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param deleteABTest - The deleteABTest object.
+     * @param deleteABTest.id - Unique A/B test ID.
+     * @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).
+     *
+     * Required API Key ACLs:
+     * - analytics.
+     *
+     * @param getABTest - The getABTest object.
+     * @param getABTest.id - Unique A/B test ID.
+     * @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.
+     *
+     * Required API Key ACLs:
+     * - analytics.
+     *
+     * @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 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).
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param stopABTest - The stopABTest object.
+     * @param stopABTest.id - Unique A/B test ID.
+     * @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,QAAQ,EACR,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,gBAAgB,EAChB,SAAS,EACT,QAAQ,EACR,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,oBAAY,MAAM,GAAG,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AAW5C,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;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;yBAEO,iBAAiB,mBACR,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;sBAEO,cAAc,mBACL,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAsBlB;;;;;;;;OAQG;oCAEkB,gBAAgB,mBACnB,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;OAOG;uBAEO,eAAe,mBACN,cAAc,GAC9B,QAAQ,cAAc,CAAC;EAwB7B;AAED;;GAEG;AACH,oBAAY,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,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,oBAAoB,CAAC;AAElD,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;;;;;;;;OAQG;kCAEkB,iBAAiB,mBACnB,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAsC1B;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;yBAEO,iBAAiB,mBACR,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;;;OASG;sBAEO,cAAc,mBACL,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAsBlB;;;;;;;;;;;;OAYG;8DAE4C,gBAAgB,mBAC7C,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IA+B/B;;;;;;;;;OASG;uBAEO,eAAe,mBACN,cAAc,GAC9B,QAAQ,cAAc,CAAC;EAwB7B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC"}

package/index.js

@@ -1,2 +1,2 @@
 // eslint-disable-next-line import/no-commonjs,import/extensions
-module.exports = require('./dist/client-abtesting.cjs.js');
+module.exports = require('./dist/client-abtesting.cjs');

package/model/aBTest.ts

@@ -1,50 +1,65 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { Variant } from './variant';
 
 export type ABTest = {
   /**
-   * The A/B test ID.
+   * Unique A/B test ID.
    */
   abTestID: number;
 
   /**
-   * A/B test significance based on click data. Should be > 0.95 to be considered significant (no matter which variant is winning).
+   * [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;
 
   /**
-   * A/B test significance based on conversion data. Should be > 0.95 to be considered significant (no matter which variant is winning).
+   * [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;
 
   /**
-   * End date for the A/B test expressed as YYYY-MM-DDThh:mm:ssZ.
+   * [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_.
    */
-  endAt: string;
+  addToCartSignificance: 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 purchase data. A value of 0.95 or over is considered to be _significant_.
+   */
+  purchaseSignificance: number;
 
   /**
-   * Update date for the A/B test expressed as YYYY-MM-DDThh:mm:ssZ.
+   * [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>;
+
+  /**
+   * Update date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   updatedAt: string;
 
   /**
-   * Creation date for the A/B test expressed as YYYY-MM-DDThh:mm:ssZ.
+   * Creation date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   createdAt: string;
 
+  /**
+   * End date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+   */
+  endAt: string;
+
   /**
    * A/B test name.
    */
   name: string;
 
   /**
-   * Status of the A/B test.
+   * A/B test status.
    */
   status: string;
 
   /**
-   * List of A/B test variant.
+   * A/B test variants.
    */
   variants: Variant[];
 };

package/model/aBTestResponse.ts

@@ -1,18 +1,18 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 ABTestResponse = {
   /**
-   * The index performing the A/B test.
+   * A/B test index.
    */
   index: string;
 
   /**
-   * The A/B test ID.
+   * Unique A/B test ID.
    */
   abTestID: number;
 
   /**
-   * TaskID of the task to wait for.
+   * 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`.
    */
   taskID: number;
 };