algoliasearch 5.0.0-alpha.11 → 5.0.0-alpha.111

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

@@ -1,101 +1,109 @@
-/**
- * Properties for the `del` method.
- */
-export declare type DelProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `deleteABTest` method.
- */
-export declare type DeleteABTestProps = {
-    /**
-     * The A/B test ID.
-     */
-    id: number;
-};
-/**
- * Properties for the `get` method.
- */
-export declare type GetProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `getABTest` method.
- */
-export declare type GetABTestProps = {
-    /**
-     * The A/B test ID.
-     */
-    id: number;
-};
-/**
- * Properties for the `listABTests` method.
- */
-export declare type ListABTestsProps = {
-    /**
-     * Position of the starting record. Used for paging. 0 is the first record.
-     */
-    offset?: number;
-    /**
-     * Number of records to return. Limit is the size of the page.
-     */
-    limit?: number;
-};
-/**
- * Properties for the `post` method.
- */
-export declare type PostProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-    /**
-     * The parameters to send with the custom request.
-     */
-    body?: Record<string, any>;
-};
-/**
- * Properties for the `put` method.
- */
-export declare type PutProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-    /**
-     * The parameters to send with the custom request.
-     */
-    body?: Record<string, any>;
-};
-/**
- * Properties for the `stopABTest` method.
- */
-export declare type StopABTestProps = {
-    /**
-     * The A/B test ID.
-     */
-    id: number;
-};
+/**
+ * Properties for the `customDelete` method.
+ */
+export type CustomDeleteProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customGet` method.
+ */
+export type CustomGetProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customPost` method.
+ */
+export type CustomPostProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, any>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+export type CustomPutProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, any>;
+};
+/**
+ * Properties for the `deleteABTest` method.
+ */
+export type DeleteABTestProps = {
+    /**
+     * Unique A/B test ID.
+     */
+    id: number;
+};
+/**
+ * Properties for the `getABTest` method.
+ */
+export type GetABTestProps = {
+    /**
+     * Unique A/B test ID.
+     */
+    id: number;
+};
+/**
+ * Properties for the `listABTests` method.
+ */
+export type ListABTestsProps = {
+    /**
+     * Position of the first item to return.
+     */
+    offset?: number;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Only return A/B tests for indices starting with this prefix.
+     */
+    indexPrefix?: string;
+    /**
+     * Only return A/B tests for indices ending with this suffix.
+     */
+    indexSuffix?: string;
+};
+/**
+ * Properties for the `stopABTest` method.
+ */
+export type StopABTestProps = {
+    /**
+     * Unique A/B test ID.
+     */
+    id: number;
+};
 //# sourceMappingURL=clientMethodProps.d.ts.map

package/dist/client-abtesting/model/clientMethodProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/clientMethodProps.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,oBAAY,cAAc,GAAG;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC"}
+{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/clientMethodProps.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC"}

package/dist/client-abtesting/model/currency.d.ts

@@ -0,0 +1,19 @@
+export type Currency = {
+    /**
+     * Currency code.
+     */
+    currency?: string;
+    /**
+     * Revenue for this currency.
+     */
+    revenue?: number;
+    /**
+     * Mean for this currency.
+     */
+    mean?: number;
+    /**
+     * Standard deviation for this currency.
+     */
+    standardDeviation?: number;
+};
+//# sourceMappingURL=currency.d.ts.map

package/dist/client-abtesting/model/currency.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"currency.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/currency.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC"}

package/dist/client-abtesting/model/customSearchParams.d.ts

@@ -1,4 +1,7 @@
-export declare type CustomSearchParams = {
-    customSearchParameters: Record<string, any>;
-};
+/**
+ * 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.
+ */
+export type CustomSearchParams = {
+    customSearchParameters: Record<string, any>;
+};
 //# sourceMappingURL=customSearchParams.d.ts.map

package/dist/client-abtesting/model/customSearchParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customSearchParams.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/customSearchParams.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7C,CAAC"}
+{"version":3,"file":"customSearchParams.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/customSearchParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7C,CAAC"}

package/dist/client-abtesting/model/errorBase.d.ts

@@ -1,7 +1,7 @@
-/**
- * Error.
- */
-export declare type ErrorBase = Record<string, any> & {
-    message?: string;
-};
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+    message?: string;
+};
 //# sourceMappingURL=errorBase.d.ts.map

package/dist/client-abtesting/model/errorBase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errorBase.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/errorBase.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
+{"version":3,"file":"errorBase.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/errorBase.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/client-abtesting/model/filterEffects.d.ts

@@ -0,0 +1,10 @@
+import type { FilterEffectsEmptySearch } from './filterEffectsEmptySearch';
+import type { FilterEffectsOutliers } from './filterEffectsOutliers';
+/**
+ * A/B test filter effects resulting from configuration settings.
+ */
+export type FilterEffects = {
+    outliers?: FilterEffectsOutliers;
+    emptySearch?: FilterEffectsEmptySearch;
+};
+//# sourceMappingURL=filterEffects.d.ts.map

package/dist/client-abtesting/model/filterEffects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filterEffects.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/model/filterEffects.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IAEjC,WAAW,CAAC,EAAE,wBAAwB,CAAC;CACxC,CAAC"}

package/dist/client-abtesting/model/filterEffectsEmptySearch.d.ts

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

package/dist/client-abtesting/model/filterEffectsEmptySearch.d.ts.map

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

package/dist/client-abtesting/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/client-abtesting/model/filterEffectsOutliers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filterEffectsOutliers.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/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/client-abtesting/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 './currency';
+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/client-abtesting/model/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/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":["../../../../client-abtesting/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,YAAY,CAAC;AAC3B,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/client-abtesting/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[] | null;
+    /**
+     * Number of A/B tests implemented.
+     */
+    count: number;
+    /**
+     * Number of retrievable A/B tests.
+     */
+    total: number;
+};
 //# sourceMappingURL=listABTestsResponse.d.ts.map

package/dist/client-abtesting/model/listABTestsResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listABTestsResponse.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/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":["../../../../client-abtesting/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,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/client-abtesting/model/variant.d.ts

@@ -1,51 +1,82 @@
-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 { Currency } from './currency';
+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 | null;
+    /**
+     * Variant\'s [average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position).
+     */
+    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).
+     */
+    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).
+     */
+    conversionRate: number | null;
+    /**
+     * A/B test currencies.
+     */
+    currencies?: Record<string, Currency>;
+    /**
+     * A/B test description.
+     */
+    description: string;
+    /**
+     * The estimated number of searches that will need to be run to achieve the desired confidence level and statistical power. A `minimumDetectableEffect` must be set in the `configuration` object for this to be used.
+     */
+    estimatedSampleSize?: number;
+    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 | 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).
+     */
+    purchaseRate: number | null;
+    /**
+     * Number of searches carried out during the A/B test.
+     */
+    searchCount: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are 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 | null;
+    /**
+     * Number of users that performed a tracked search during the A/B test.
+     */
+    trackedUserCount: number | null;
+};
 //# sourceMappingURL=variant.d.ts.map

package/dist/client-abtesting/model/variant.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"variant.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/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":["../../../../client-abtesting/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"}