@teemill/split-tests 1.0.0

package/dist/esm/base.js

@@ -0,0 +1,41 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Split Tests
+ * Inspect split test definitions and performance results.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import globalAxios from 'axios';
+export const BASE_PATH = "https://api.localhost:8080".replace(/\/+$/, "");
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+export class BaseAPI {
+    constructor(configuration, basePath = BASE_PATH, axios = globalAxios) {
+        var _a;
+        this.basePath = basePath;
+        this.axios = axios;
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = (_a = configuration.basePath) !== null && _a !== void 0 ? _a : basePath;
+        }
+    }
+}
+;
+export class RequiredError extends Error {
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        this.name = "RequiredError";
+    }
+}
+export const operationServerMap = {};

package/dist/esm/common.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Split Tests
+ * Inspect split test definitions and performance results.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ * JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
+ * @export
+ */
+export declare const replaceWithSerializableTypeIfNeeded: (_key: string, value: unknown) => unknown;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/esm/common.js

@@ -0,0 +1,159 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Split Tests
+ * Inspect split test definitions and performance results.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { RequiredError } from "./base";
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com';
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName, paramName, paramValue) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+};
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = function (object, keyParamName, configuration) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (configuration && configuration.apiKey) {
+            const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                ? yield configuration.apiKey(keyParamName)
+                : yield configuration.apiKey;
+            object[keyParamName] = localVarApiKeyValue;
+        }
+    });
+};
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object, configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+};
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = function (object, configuration) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (configuration && configuration.accessToken) {
+            const accessToken = typeof configuration.accessToken === 'function'
+                ? yield configuration.accessToken()
+                : yield configuration.accessToken;
+            object["Authorization"] = "Bearer " + accessToken;
+        }
+    });
+};
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = function (object, name, scopes, configuration) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (configuration && configuration.accessToken) {
+            const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                ? yield configuration.accessToken(name, scopes)
+                : yield configuration.accessToken;
+            object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+        }
+    });
+};
+function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
+    if (parameter == null)
+        return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter) || parameter instanceof Set) {
+            parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key !== '' ? `${key}[]` : key));
+        }
+        else {
+            Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`));
+        }
+    }
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        }
+        else {
+            urlSearchParams.set(key, parameter);
+        }
+    }
+}
+/**
+ *
+ * @export
+ */
+export const setSearchParams = function (url, ...objects) {
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = searchParams.toString();
+};
+/**
+ * JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
+ * @export
+ */
+export const replaceWithSerializableTypeIfNeeded = function (_key, value) {
+    if (value instanceof Set) {
+        return Array.from(value);
+    }
+    return value;
+};
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
+        : (value || "");
+};
+/**
+ *
+ * @export
+ */
+export const toPathString = function (url) {
+    return url.pathname + url.search + url.hash;
+};
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
+    return (axios = globalAxios, basePath = BASE_PATH) => {
+        var _a;
+        const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: (axios.defaults.baseURL ? '' : (_a = configuration === null || configuration === void 0 ? void 0 : configuration.basePath) !== null && _a !== void 0 ? _a : basePath) + axiosArgs.url });
+        return axios.request(axiosRequestArgs);
+    };
+};

package/dist/esm/configuration.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Split Tests
+ * Inspect split test definitions and performance results.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface AWSv4Configuration {
+    options?: {
+        region?: string;
+        service?: string;
+    };
+    credentials?: {
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        sessionToken?: string;
+    };
+}
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    awsv4?: AWSv4Configuration;
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * parameter for aws4 signature security
+     * @param {Object} AWS4Signature - AWS4 Signature security
+     * @param {string} options.region - aws region
+     * @param {string} options.service - name of the service.
+     * @param {string} credentials.accessKeyId - aws access key id
+     * @param {string} credentials.secretAccessKey - aws access key
+     * @param {string} credentials.sessionToken - aws session token
+     * @memberof Configuration
+     */
+    awsv4?: AWSv4Configuration;
+    /**
+     * override base path
+     */
+    basePath?: string;
+    /**
+     * override server index
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}
+export {};

package/dist/esm/configuration.js

@@ -0,0 +1,40 @@
+/* tslint:disable */
+/**
+ * Split Tests
+ * Inspect split test definitions and performance results.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export class Configuration {
+    constructor(param = {}) {
+        var _a;
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.awsv4 = param.awsv4;
+        this.basePath = param.basePath;
+        this.serverIndex = param.serverIndex;
+        this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
+        this.formDataCtor = param.formDataCtor;
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        const jsonMime = /^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$/i;
+        return mime !== null && jsonMime.test(mime);
+    }
+}

package/dist/esm/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Split Tests
+ * Inspect split test definitions and performance results.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";

package/dist/esm/index.js

@@ -0,0 +1,15 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Split Tests
+ * Inspect split test definitions and performance results.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Split Tests
+ * Inspect split test definitions and performance results.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";

package/dist/index.js

@@ -0,0 +1,31 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Split Tests
+ * Inspect split test definitions and performance results.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api"), exports);
+__exportStar(require("./configuration"), exports);

package/docs/Error.md

@@ -0,0 +1,20 @@
+# ModelError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Human-readable error message. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ModelError } from '@teemill/split-tests';
+
+const instance: ModelError = {
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ListSplitTests200Response.md

@@ -0,0 +1,20 @@
+# ListSplitTests200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**splitTests** | [**Array<SplitTest>**](SplitTest.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListSplitTests200Response } from '@teemill/split-tests';
+
+const instance: ListSplitTests200Response = {
+    splitTests,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SplitTest.md

@@ -0,0 +1,33 @@
+# SplitTest
+
+Split test definition with variation metadata.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique split test UUID. | [default to undefined]
+**name** | **string** | Human-readable split test name. | [default to undefined]
+**code** | **string** | Stable split test code used by tracking and assignment logic. | [default to undefined]
+**startDate** | **string** | Date the split test starts serving. | [default to undefined]
+**endDate** | **string** | Date the split test stops serving. | [default to undefined]
+**winnerId** | **string** | Winning variation UUID when a winner has been chosen; otherwise `null`. | [default to undefined]
+**variations** | [**Array<SplitTestVariation>**](SplitTestVariation.md) | Variations configured for this split test. | [default to undefined]
+
+## Example
+
+```typescript
+import { SplitTest } from '@teemill/split-tests';
+
+const instance: SplitTest = {
+    id,
+    name,
+    code,
+    startDate,
+    endDate,
+    winnerId,
+    variations,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SplitTestResultBreakdown.md

@@ -0,0 +1,33 @@
+# SplitTestResultBreakdown
+
+Aggregated variation metrics for a single breakdown group.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Breakdown group key (for example, `mobile`, `Chrome`, or a domain). | [default to undefined]
+**sessions** | **number** | Session count for this group. | [default to undefined]
+**value** | **number** | Total tracked order value for this group in minor currency units. | [default to undefined]
+**orderCount** | **number** | Number of orders recorded for this group. | [default to undefined]
+**averageOrderValue** | **number** | Average order value for this group. | [default to undefined]
+**valuePerSession** | **number** | Average tracked value per session for this group. | [default to undefined]
+**controlDifference** | **number** | Difference versus control variation for the selected metric. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SplitTestResultBreakdown } from '@teemill/split-tests';
+
+const instance: SplitTestResultBreakdown = {
+    name,
+    sessions,
+    value,
+    orderCount,
+    averageOrderValue,
+    valuePerSession,
+    controlDifference,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SplitTestResultEvent.md

@@ -0,0 +1,29 @@
+# SplitTestResultEvent
+
+Event-level metrics for a variation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Event name (for example, `purchase` or `add-to-cart`). | [default to undefined]
+**events** | **number** | Number of sessions that triggered this event. | [default to undefined]
+**conversionRate** | **number** | Percentage of sessions that triggered this event. | [default to undefined]
+**controlDifference** | **number** | Difference in conversion rate versus the control variation. | [optional] [default to undefined]
+**valuePerConversion** | **number** | Average value per conversion for this event when available. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SplitTestResultEvent } from '@teemill/split-tests';
+
+const instance: SplitTestResultEvent = {
+    name,
+    events,
+    conversionRate,
+    controlDifference,
+    valuePerConversion,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SplitTestResultVariation.md

@@ -0,0 +1,33 @@
+# SplitTestResultVariation
+
+Aggregated metrics for a single split test variation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Variation label. | [default to undefined]
+**sessions** | **number** | Number of sessions assigned to this variation. | [default to undefined]
+**value** | **number** | Total tracked order value in minor currency units. | [default to undefined]
+**averageOrderValue** | **number** | Average order value for conversion events. | [default to undefined]
+**valuePerSession** | **number** | Average tracked value per session. | [default to undefined]
+**events** | [**Array<SplitTestResultEvent>**](SplitTestResultEvent.md) | Event metrics for this variation. | [default to undefined]
+**breakdowns** | [**Array<SplitTestResultBreakdown>**](SplitTestResultBreakdown.md) | Optional subgroup metrics when a breakdown dimension is requested. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SplitTestResultVariation } from '@teemill/split-tests';
+
+const instance: SplitTestResultVariation = {
+    name,
+    sessions,
+    value,
+    averageOrderValue,
+    valuePerSession,
+    events,
+    breakdowns,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)