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

package/model/variant.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.
 
-import type { CurrenciesValue } from './currenciesValue';
+import type { Currency } from './currency';
 import type { FilterEffects } from './filterEffects';
 
 export type Variant = {
@@ -10,14 +10,14 @@ 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.
@@ -25,9 +25,9 @@ export type 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.
@@ -35,31 +35,36 @@ export type 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.
@@ -67,32 +72,32 @@ export type 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;
 };

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@algolia/client-abtesting",
-  "version": "5.0.0-alpha.99",
+  "version": "5.0.0-beta.10",
   "description": "JavaScript client for client-abtesting",
-  "repository": "algolia/algoliasearch-client-javascript",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "license": "MIT",
   "author": "Algolia",
   "type": "module",
@@ -39,14 +42,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.100",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.100",
-    "@algolia/requester-node-http": "5.0.0-alpha.100"
+    "@algolia/client-common": "5.0.0-beta.11",
+    "@algolia/requester-browser-xhr": "5.0.0-beta.11",
+    "@algolia/requester-node-http": "5.0.0-beta.11"
   },
   "devDependencies": {
-    "@types/node": "20.11.0",
-    "rollup": "4.9.6",
-    "typescript": "5.3.3"
+    "@types/node": "20.14.10",
+    "rollup": "4.18.0",
+    "typescript": "5.5.3"
   },
   "engines": {
     "node": ">= 14.0.0"

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

@@ -1 +0,0 @@
-{"version":3,"file":"currenciesValue.d.ts","sourceRoot":"","sources":["../../model/currenciesValue.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG;IAC5B;;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"}