@algolia/client-abtesting 5.0.0-alpha.111 → 5.0.0-alpha.112

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

@@ -0,0 +1 @@
+{"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../model/status.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC"}

package/dist/model/variant.d.ts

@@ -6,11 +6,11 @@ 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 | 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 | null;
     /**
@@ -18,7 +18,7 @@ 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 | null;
     /**
@@ -26,7 +26,7 @@ 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 | null;
     /**
@@ -34,20 +34,20 @@ export type Variant = {
      */
     currencies?: Record<string, Currency>;
     /**
-     * A/B test description.
+     * Description for this variant.
      */
     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.
+     * 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 | null;
     /**
@@ -55,11 +55,11 @@ 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 | null;
     /**
-     * Number of searches carried out during the A/B test.
+     * Number of searches for this variant.
      */
     searchCount: number | null;
     /**
@@ -67,15 +67,15 @@ export type Variant = {
      */
     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 | 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 | null;
 };

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.111";
+export declare const apiClientVersion = "5.0.0-alpha.112";
 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,7 +31,7 @@ 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.
@@ -79,29 +79,29 @@ 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.
      *
      * @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.
      *
      * @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.
@@ -109,19 +109,19 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
      * @param listABTests - The listABTests object.
      * @param listABTests.offset - Position of the first item to return.
      * @param listABTests.limit - Number of items to return.
-     * @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.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.
      *
      * @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>;

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 | 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 | 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 | 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 | 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> | 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,12 +2,12 @@
 
 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;
 

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;
 };
@@ -97,11 +97,11 @@ export type ListABTestsProps = {
    */
   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/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,6 +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.
 
 export * from './aBTest';
+export * from './aBTestConfiguration';
 export * from './aBTestResponse';
 export * from './abTestsVariant';
 export * from './abTestsVariantSearchParams';
@@ -8,10 +9,15 @@ export * from './addABTestsRequest';
 export * from './addABTestsVariant';
 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

@@ -9,7 +9,7 @@ export type ListABTestsResponse = {
   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';

package/model/variant.ts

@@ -10,12 +10,12 @@ 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 | 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 | null;
 
@@ -25,7 +25,7 @@ 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 | null;
 
@@ -35,7 +35,7 @@ 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 | null;
 
@@ -45,24 +45,24 @@ export type Variant = {
   currencies?: Record<string, Currency>;
 
   /**
-   * A/B test description.
+   * Description for this variant.
    */
   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.
+   * 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 | null;
 
@@ -72,12 +72,12 @@ 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 | null;
 
   /**
-   * Number of searches carried out during the A/B test.
+   * Number of searches for this variant.
    */
   searchCount: number | null;
 
@@ -87,17 +87,17 @@ export type Variant = {
   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 | 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 | null;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-abtesting",
-  "version": "5.0.0-alpha.111",
+  "version": "5.0.0-alpha.112",
   "description": "JavaScript client for client-abtesting",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -39,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.112",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.112",
-    "@algolia/requester-node-http": "5.0.0-alpha.112"
+    "@algolia/client-common": "5.0.0-alpha.113",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.113",
+    "@algolia/requester-node-http": "5.0.0-alpha.113"
   },
   "devDependencies": {
-    "@types/node": "20.12.5",
-    "rollup": "4.14.0",
-    "typescript": "5.4.4"
+    "@types/node": "20.12.7",
+    "rollup": "4.14.2",
+    "typescript": "5.4.5"
   },
   "engines": {
     "node": ">= 14.0.0"