@algolia/client-abtesting 5.0.0-alpha.9 → 5.0.0-alpha.91

package/model/addABTestsRequest.ts

@@ -1,4 +1,4 @@
-// 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 { AddABTestsVariant } from './addABTestsVariant';
 
@@ -9,12 +9,12 @@ export type AddABTestsRequest = {
   name: string;
 
   /**
-   * List of 2 variants for the A/B test.
+   * A/B test variants.
    */
-  variant: AddABTestsVariant[];
+  variants: AddABTestsVariant[];
 
   /**
-   * End date for the A/B test expressed as YYYY-MM-DDThh:mm:ssZ.
+   * End date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
    */
   endAt: string;
 };

package/model/addABTestsVariant.ts

@@ -1,4 +1,4 @@
-// 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 { AbTestsVariant } from './abTestsVariant';
 import type { AbTestsVariantSearchParams } from './abTestsVariantSearchParams';

package/model/clientMethodProps.ts

@@ -1,15 +1,15 @@
-// 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.
 
 /**
  * Properties for the `del` method.
  */
 export type DelProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
 };
@@ -19,7 +19,7 @@ export type DelProps = {
  */
 export type DeleteABTestProps = {
   /**
-   * The A/B test ID.
+   * Unique A/B test ID.
    */
   id: number;
 };
@@ -29,11 +29,11 @@ export type DeleteABTestProps = {
  */
 export type GetProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
 };
@@ -43,7 +43,7 @@ export type GetProps = {
  */
 export type GetABTestProps = {
   /**
-   * The A/B test ID.
+   * Unique A/B test ID.
    */
   id: number;
 };
@@ -57,9 +57,17 @@ export type ListABTestsProps = {
    */
   offset?: number;
   /**
-   * Number of records to return. Limit is the size of the page.
+   * Number of records to return (page size).
    */
   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;
 };
 
 /**
@@ -67,15 +75,15 @@ export type ListABTestsProps = {
  */
 export type PostProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
   /**
-   * The parameters to send with the custom request.
+   * Parameters to send with the custom request.
    */
   body?: Record<string, any>;
 };
@@ -85,15 +93,15 @@ export type PostProps = {
  */
 export type PutProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
   /**
-   * The parameters to send with the custom request.
+   * Parameters to send with the custom request.
    */
   body?: Record<string, any>;
 };
@@ -103,7 +111,7 @@ export type PutProps = {
  */
 export type StopABTestProps = {
   /**
-   * The A/B test ID.
+   * Unique A/B test ID.
    */
   id: number;
 };

package/model/currenciesValue.ts

@@ -0,0 +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 type CurrenciesValue = {
+  /**
+   * Currency code.
+   */
+  currency?: string;
+
+  /**
+   * Revenue for this currency.
+   */
+  revenue?: number;
+
+  /**
+   * Mean for this currency.
+   */
+  mean?: number;
+
+  /**
+   * Standard deviation for this currency.
+   */
+  standardDeviation?: number;
+};

package/model/customSearchParams.ts

@@ -1,5 +1,8 @@
-// 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.
 
+/**
+ * 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>;
 };

package/model/errorBase.ts

@@ -1,4 +1,4 @@
-// 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.
 
 /**
  * Error.

package/model/filterEffects.ts

@@ -0,0 +1,13 @@
+// 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 { FilterEffectsEmptySearch } from './filterEffectsEmptySearch';
+import type { FilterEffectsOutliers } from './filterEffectsOutliers';
+
+/**
+ * A/B test filter effects resulting from configuration settings.
+ */
+export type FilterEffects = {
+  outliers?: FilterEffectsOutliers;
+
+  emptySearch?: FilterEffectsEmptySearch;
+};

package/model/filterEffectsEmptySearch.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.
+
+/**
+ * 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;
+};

package/model/filterEffectsOutliers.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.
+
+/**
+ * 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;
+};

package/model/index.ts

@@ -1,4 +1,4 @@
-// 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 * from './aBTest';
 export * from './aBTestResponse';
@@ -6,8 +6,12 @@ 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';

package/model/listABTestsResponse.ts

@@ -1,20 +1,20 @@
-// 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 { ABTest } from './aBTest';
 
 export type ListABTestsResponse = {
   /**
-   * List of A/B tests.
+   * A/B tests.
    */
   abtests: ABTest[];
 
   /**
-   * Number of A/B tests found for the app.
+   * Number of A/B tests implemented.
    */
   count: number;
 
   /**
-   * Number of A/B tests retrievable.
+   * Number of retrievable A/B tests.
    */
   total: number;
 };

package/model/variant.ts

@@ -1,63 +1,93 @@
-// 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 { CurrenciesValue } from './currenciesValue';
+import type { FilterEffects } from './filterEffects';
 
 export type Variant = {
   /**
-   * Average click position for the 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;
 
   /**
-   * Distinct click count for the variant.
+   * Number of click events for this variant.
    */
   clickCount: number;
 
   /**
-   * Click through rate for the variant.
+   * Variant\'s [click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
    */
   clickThroughRate: number;
 
   /**
-   * Distinct conversion count for the variant.
+   * Number of click events for this variant.
    */
   conversionCount: number;
 
   /**
-   * Conversion rate for the variant.
+   * Variant\'s [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
    */
   conversionRate: number;
 
   /**
-   * The A/B test description.
+   * A/B test currencies.
+   */
+  currencies: Record<string, CurrenciesValue>;
+
+  /**
+   * A/B test description.
    */
   description: string;
 
+  filterEffects?: FilterEffects;
+
   /**
-   * The index performing the A/B test.
+   * A/B test index.
    */
   index: string;
 
   /**
-   * The number of occurrences.
+   * Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for that variant.
    */
   noResultCount: number;
 
   /**
-   * The number of search during the A/B test.
+   * 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;
 
   /**
-   * The number of tracked search click.
+   * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
    */
   trackedSearchCount: number;
 
   /**
-   * The traffic percentage for the A/B test.
+   * A/B test traffic percentage.
    */
   trafficPercentage: number;
 
   /**
-   * The number of user during the A/B test.
+   * Number of users during the A/B test.
    */
   userCount: number;
 };

package/package.json

@@ -1,16 +1,33 @@
 {
   "name": "@algolia/client-abtesting",
-  "version": "5.0.0-alpha.9",
+  "version": "5.0.0-alpha.91",
   "description": "JavaScript client for client-abtesting",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
   "author": "Algolia",
-  "main": "index.js",
-  "jsdelivr": "dist/client-abtesting.umd.js",
-  "unpkg": "dist/client-abtesting.umd.js",
-  "module": "dist/client-abtesting.esm.node.js",
-  "browser": "dist/client-abtesting.umd.js",
-  "types": "index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/client-abtesting.esm.node.js",
+        "module": "./dist/client-abtesting.esm.node.js",
+        "require": "./dist/client-abtesting.cjs",
+        "default": "./dist/client-abtesting.cjs"
+      },
+      "default": {
+        "umd": "./dist/client-abtesting.umd.js",
+        "module": "./dist/client-abtesting.esm.browser.js",
+        "import": "./dist/client-abtesting.esm.browser.js",
+        "default": "./dist/client-abtesting.umd.js"
+      }
+    },
+    "./src/*": "./src/*.ts",
+    "./model": "./model/index.ts"
+  },
+  "jsdelivr": "./dist/client-abtesting.umd.js",
+  "unpkg": "./dist/client-abtesting.umd.js",
+  "browser": "./dist/client-abtesting.umd.js",
+  "types": "./index.d.ts",
   "files": [
     "dist",
     "model",
@@ -22,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.9",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.9",
-    "@algolia/requester-node-http": "5.0.0-alpha.9"
+    "@algolia/client-common": "5.0.0-alpha.92",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.92",
+    "@algolia/requester-node-http": "5.0.0-alpha.92"
   },
   "devDependencies": {
-    "@types/node": "16.11.47",
-    "rollup": "2.77.2",
-    "typescript": "4.7.4"
+    "@types/node": "20.9.0",
+    "rollup": "4.3.0",
+    "typescript": "5.2.2"
   },
   "engines": {
     "node": ">= 14.0.0"