@algolia/client-abtesting 5.9.0 → 5.10.0-beta.1

package/model/index.ts

@@ -1,25 +0,0 @@
-// 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';
-export * from './addABTestsRequest';
-export * from './addABTestsVariant';
-export * from './clientMethodProps';
-export * from './currency';
-export * from './customSearchParams';
-export * from './effect';
-export * from './emptySearch';
-export * from './emptySearchFilter';
-export * from './errorBase';
-export * from './filterEffects';
-export * from './listABTestsResponse';
-export * from './minimumDetectableEffect';
-export * from './outliers';
-export * from './outliersFilter';
-export * from './scheduleABTestResponse';
-export * from './scheduleABTestsRequest';
-export * from './status';
-export * from './variant';

package/model/listABTestsResponse.ts

@@ -1,20 +0,0 @@
-// 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 = {
-  /**
-   * A/B tests.
-   */
-  abtests: Array<ABTest> | null;
-
-  /**
-   * Number of A/B tests.
-   */
-  count: number;
-
-  /**
-   * Number of retrievable A/B tests.
-   */
-  total: number;
-};

package/model/minimumDetectableEffect.ts

@@ -1,15 +0,0 @@
-// 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

@@ -1,11 +0,0 @@
-// 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/outliersFilter.ts

@@ -1,16 +0,0 @@
-// 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 OutliersFilter = {
-  /**
-   * 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/scheduleABTestResponse.ts

@@ -1,8 +0,0 @@
-// 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 ScheduleABTestResponse = {
-  /**
-   * Unique scheduled A/B test identifier.
-   */
-  abTestScheduleID: number;
-};

package/model/scheduleABTestsRequest.ts

@@ -1,25 +0,0 @@
-// 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';
-
-export type ScheduleABTestsRequest = {
-  /**
-   * A/B test name.
-   */
-  name: string;
-
-  /**
-   * A/B test variants.
-   */
-  variants: Array<AddABTestsVariant>;
-
-  /**
-   * Date and time when the A/B test is scheduled to start, in RFC 3339 format.
-   */
-  scheduledAt: string;
-
-  /**
-   * End date and time of the A/B test, in RFC 3339 format.
-   */
-  endAt: string;
-};

package/model/status.ts

@@ -1,6 +0,0 @@
-// 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' | 'stopped' | 'expired' | 'failed';

package/model/variant.ts

@@ -1,103 +0,0 @@
-// 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 { Currency } from './currency';
-import type { FilterEffects } from './filterEffects';
-
-export type Variant = {
-  /**
-   * Number of add-to-cart events for this variant.
-   */
-  addToCartCount: number;
-
-  /**
-   * [Add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate) for this variant.
-   */
-  addToCartRate?: number | null;
-
-  /**
-   * [Average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) for this variant.
-   */
-  averageClickPosition?: number | null;
-
-  /**
-   * Number of click events for this variant.
-   */
-  clickCount: number;
-
-  /**
-   * [Click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate) for this variant.
-   */
-  clickThroughRate?: number | null;
-
-  /**
-   * Number of click events for this variant.
-   */
-  conversionCount: number;
-
-  /**
-   * [Conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate) for this variant.
-   */
-  conversionRate?: number | null;
-
-  /**
-   * A/B test currencies.
-   */
-  currencies?: { [key: string]: Currency };
-
-  /**
-   * 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;
-
-  /**
-   * 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 this variant.
-   */
-  noResultCount: number | null;
-
-  /**
-   * Number of purchase events for this variant.
-   */
-  purchaseCount: number;
-
-  /**
-   * [Purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate) for this variant.
-   */
-  purchaseRate?: number | null;
-
-  /**
-   * Number of searches for this variant.
-   */
-  searchCount: number | null;
-
-  /**
-   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
-   */
-  trackedSearchCount?: number;
-
-  /**
-   * Percentage of search requests each variant receives.
-   */
-  trafficPercentage: number;
-
-  /**
-   * Number of users that made searches to this variant.
-   */
-  userCount: number | null;
-
-  /**
-   * Number of users that made tracked searches to this variant.
-   */
-  trackedUserCount: number | null;
-};