@teemill/split-tests 1.0.0

package/.openapi-generator/FILES

@@ -0,0 +1,22 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+README.md
+api.ts
+base.ts
+common.ts
+configuration.ts
+docs/Error.md
+docs/ListSplitTests200Response.md
+docs/SplitTest.md
+docs/SplitTestResultBreakdown.md
+docs/SplitTestResultEvent.md
+docs/SplitTestResultVariation.md
+docs/SplitTestResults.md
+docs/SplitTestVariation.md
+docs/SplitTestsApi.md
+git_push.sh
+index.ts
+package.json
+tsconfig.esm.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.23.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/README.md

@@ -0,0 +1,89 @@
+## @teemill/split-tests@1.0.0
+
+This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
+
+Environment
+* Node.js
+* Webpack
+* Browserify
+
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
+
+### Building
+
+To build and compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run `npm publish`
+
+### Consuming
+
+navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install @teemill/split-tests@1.0.0 --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save
+```
+
+### Documentation for API Endpoints
+
+All URIs are relative to *https://api.localhost:8080*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SplitTestsApi* | [**getSplitTestResults**](docs/SplitTestsApi.md#getsplittestresults) | **GET** /v1/split-tests/{splitTestId}/results | Get split test results
+*SplitTestsApi* | [**listSplitTests**](docs/SplitTestsApi.md#listsplittests) | **GET** /v1/split-tests | List split tests
+
+
+### Documentation For Models
+
+ - [ListSplitTests200Response](docs/ListSplitTests200Response.md)
+ - [ModelError](docs/ModelError.md)
+ - [SplitTest](docs/SplitTest.md)
+ - [SplitTestResultBreakdown](docs/SplitTestResultBreakdown.md)
+ - [SplitTestResultEvent](docs/SplitTestResultEvent.md)
+ - [SplitTestResultVariation](docs/SplitTestResultVariation.md)
+ - [SplitTestResults](docs/SplitTestResults.md)
+ - [SplitTestVariation](docs/SplitTestVariation.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="api-key"></a>
+### api-key
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+<a id="session-oauth"></a>
+### session-oauth
+
+- **Type**: OAuth
+- **Flow**: password
+- **Authorization URL**: 
+- **Scopes**: N/A
+

package/api.ts

@@ -0,0 +1,469 @@
+/* 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 type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from './common';
+import type { RequestArgs } from './base';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
+
+export interface ListSplitTests200Response {
+    'splitTests': Array<SplitTest>;
+}
+export interface ModelError {
+    /**
+     * Human-readable error message.
+     */
+    'message'?: string;
+}
+/**
+ * Split test definition with variation metadata.
+ */
+export interface SplitTest {
+    /**
+     * Unique split test UUID.
+     */
+    'id': string;
+    /**
+     * Human-readable split test name.
+     */
+    'name': string;
+    /**
+     * Stable split test code used by tracking and assignment logic.
+     */
+    'code': string;
+    /**
+     * Date the split test starts serving.
+     */
+    'startDate': string;
+    /**
+     * Date the split test stops serving.
+     */
+    'endDate': string;
+    /**
+     * Winning variation UUID when a winner has been chosen; otherwise `null`.
+     */
+    'winnerId': string | null;
+    /**
+     * Variations configured for this split test.
+     */
+    'variations': Array<SplitTestVariation>;
+}
+/**
+ * Aggregated variation metrics for a single breakdown group.
+ */
+export interface SplitTestResultBreakdown {
+    /**
+     * Breakdown group key (for example, `mobile`, `Chrome`, or a domain).
+     */
+    'name': string;
+    /**
+     * Session count for this group.
+     */
+    'sessions': number;
+    /**
+     * Total tracked order value for this group in minor currency units.
+     */
+    'value': number;
+    /**
+     * Number of orders recorded for this group.
+     */
+    'orderCount': number;
+    /**
+     * Average order value for this group.
+     */
+    'averageOrderValue': number;
+    /**
+     * Average tracked value per session for this group.
+     */
+    'valuePerSession': number;
+    /**
+     * Difference versus control variation for the selected metric.
+     */
+    'controlDifference'?: number | null;
+}
+/**
+ * Event-level metrics for a variation.
+ */
+export interface SplitTestResultEvent {
+    /**
+     * Event name (for example, `purchase` or `add-to-cart`).
+     */
+    'name': string;
+    /**
+     * Number of sessions that triggered this event.
+     */
+    'events': number;
+    /**
+     * Percentage of sessions that triggered this event.
+     */
+    'conversionRate': number;
+    /**
+     * Difference in conversion rate versus the control variation.
+     */
+    'controlDifference'?: number | null;
+    /**
+     * Average value per conversion for this event when available.
+     */
+    'valuePerConversion'?: number | null;
+}
+/**
+ * Aggregated metrics for a single split test variation.
+ */
+export interface SplitTestResultVariation {
+    /**
+     * Variation label.
+     */
+    'name': string;
+    /**
+     * Number of sessions assigned to this variation.
+     */
+    'sessions': number;
+    /**
+     * Total tracked order value in minor currency units.
+     */
+    'value': number;
+    /**
+     * Average order value for conversion events.
+     */
+    'averageOrderValue': number;
+    /**
+     * Average tracked value per session.
+     */
+    'valuePerSession': number;
+    /**
+     * Event metrics for this variation.
+     */
+    'events': Array<SplitTestResultEvent>;
+    /**
+     * Optional subgroup metrics when a breakdown dimension is requested.
+     */
+    'breakdowns'?: Array<SplitTestResultBreakdown>;
+}
+/**
+ * Aggregated performance summary for a split test.
+ */
+export interface SplitTestResults {
+    /**
+     * Split test name.
+     */
+    'name': string;
+    /**
+     * Total session count across all returned variations.
+     */
+    'sessions': number;
+    /**
+     * Distinct event names present in the result set.
+     */
+    'events': Array<string>;
+    'controlVariation': SplitTestResultVariation;
+    /**
+     * Per-variation performance metrics.
+     */
+    'variations': Array<SplitTestResultVariation>;
+}
+/**
+ * Basic variation metadata for a split test definition.
+ */
+export interface SplitTestVariation {
+    /**
+     * Unique variation UUID.
+     */
+    'id': string;
+    /**
+     * Variation label.
+     */
+    'name': string;
+    /**
+     * Whether this variation is the control baseline.
+     */
+    'control': boolean;
+    /**
+     * Whether this variation is currently active for assignment.
+     */
+    'active': boolean;
+}
+
+/**
+ * SplitTestsApi - axios parameter creator
+ */
+export const SplitTestsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Get aggregate split test results and optional breakdowns.
+         * @summary Get split test results
+         * @param {string} project Project identifier used to scope split test data for the current integration context.
+         * @param {string} splitTestId UUID of the split test to fetch detailed results for.
+         * @param {GetSplitTestResultsBreakdownEnum} [breakdown] Optional dimension used to group variation metrics in &#x60;breakdowns&#x60;.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSplitTestResults: async (project: string, splitTestId: string, breakdown?: GetSplitTestResultsBreakdownEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('getSplitTestResults', 'project', project)
+            // verify required parameter 'splitTestId' is not null or undefined
+            assertParamExists('getSplitTestResults', 'splitTestId', splitTestId)
+            const localVarPath = `/v1/split-tests/{splitTestId}/results`
+                .replace('{splitTestId}', encodeURIComponent(String(splitTestId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+            if (breakdown !== undefined) {
+                localVarQueryParameter['breakdown'] = breakdown;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * List split tests for inspector tooling.
+         * @summary List split tests
+         * @param {string} project Project identifier used to scope split test data for the current integration context.
+         * @param {string} [search] Case-insensitive search term matched against split test name and code.
+         * @param {ListSplitTestsStateEnum} [state] Filter for which split tests to return (&#x60;active&#x60; for currently running tests, &#x60;all&#x60; for every test).
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSplitTests: async (project: string, search?: string, state?: ListSplitTestsStateEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('listSplitTests', 'project', project)
+            const localVarPath = `/v1/split-tests`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (state !== undefined) {
+                localVarQueryParameter['state'] = state;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * SplitTestsApi - functional programming interface
+ */
+export const SplitTestsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = SplitTestsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Get aggregate split test results and optional breakdowns.
+         * @summary Get split test results
+         * @param {string} project Project identifier used to scope split test data for the current integration context.
+         * @param {string} splitTestId UUID of the split test to fetch detailed results for.
+         * @param {GetSplitTestResultsBreakdownEnum} [breakdown] Optional dimension used to group variation metrics in &#x60;breakdowns&#x60;.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getSplitTestResults(project: string, splitTestId: string, breakdown?: GetSplitTestResultsBreakdownEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SplitTestResults>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSplitTestResults(project, splitTestId, breakdown, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SplitTestsApi.getSplitTestResults']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * List split tests for inspector tooling.
+         * @summary List split tests
+         * @param {string} project Project identifier used to scope split test data for the current integration context.
+         * @param {string} [search] Case-insensitive search term matched against split test name and code.
+         * @param {ListSplitTestsStateEnum} [state] Filter for which split tests to return (&#x60;active&#x60; for currently running tests, &#x60;all&#x60; for every test).
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listSplitTests(project: string, search?: string, state?: ListSplitTestsStateEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSplitTests200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listSplitTests(project, search, state, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SplitTestsApi.listSplitTests']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * SplitTestsApi - factory interface
+ */
+export const SplitTestsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = SplitTestsApiFp(configuration)
+    return {
+        /**
+         * Get aggregate split test results and optional breakdowns.
+         * @summary Get split test results
+         * @param {SplitTestsApiGetSplitTestResultsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSplitTestResults(requestParameters: SplitTestsApiGetSplitTestResultsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SplitTestResults> {
+            return localVarFp.getSplitTestResults(requestParameters.project, requestParameters.splitTestId, requestParameters.breakdown, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * List split tests for inspector tooling.
+         * @summary List split tests
+         * @param {SplitTestsApiListSplitTestsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSplitTests(requestParameters: SplitTestsApiListSplitTestsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListSplitTests200Response> {
+            return localVarFp.listSplitTests(requestParameters.project, requestParameters.search, requestParameters.state, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for getSplitTestResults operation in SplitTestsApi.
+ */
+export interface SplitTestsApiGetSplitTestResultsRequest {
+    /**
+     * Project identifier used to scope split test data for the current integration context.
+     */
+    readonly project: string
+
+    /**
+     * UUID of the split test to fetch detailed results for.
+     */
+    readonly splitTestId: string
+
+    /**
+     * Optional dimension used to group variation metrics in &#x60;breakdowns&#x60;.
+     */
+    readonly breakdown?: GetSplitTestResultsBreakdownEnum
+}
+
+/**
+ * Request parameters for listSplitTests operation in SplitTestsApi.
+ */
+export interface SplitTestsApiListSplitTestsRequest {
+    /**
+     * Project identifier used to scope split test data for the current integration context.
+     */
+    readonly project: string
+
+    /**
+     * Case-insensitive search term matched against split test name and code.
+     */
+    readonly search?: string
+
+    /**
+     * Filter for which split tests to return (&#x60;active&#x60; for currently running tests, &#x60;all&#x60; for every test).
+     */
+    readonly state?: ListSplitTestsStateEnum
+}
+
+/**
+ * SplitTestsApi - object-oriented interface
+ */
+export class SplitTestsApi extends BaseAPI {
+    /**
+     * Get aggregate split test results and optional breakdowns.
+     * @summary Get split test results
+     * @param {SplitTestsApiGetSplitTestResultsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getSplitTestResults(requestParameters: SplitTestsApiGetSplitTestResultsRequest, options?: RawAxiosRequestConfig) {
+        return SplitTestsApiFp(this.configuration).getSplitTestResults(requestParameters.project, requestParameters.splitTestId, requestParameters.breakdown, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * List split tests for inspector tooling.
+     * @summary List split tests
+     * @param {SplitTestsApiListSplitTestsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public listSplitTests(requestParameters: SplitTestsApiListSplitTestsRequest, options?: RawAxiosRequestConfig) {
+        return SplitTestsApiFp(this.configuration).listSplitTests(requestParameters.project, requestParameters.search, requestParameters.state, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+export const GetSplitTestResultsBreakdownEnum = {
+    None: 'none',
+    Device: 'device',
+    Platform: 'platform',
+    Browser: 'browser',
+    Country: 'country',
+    Territory: 'territory',
+    Domain: 'domain',
+} as const;
+export type GetSplitTestResultsBreakdownEnum = typeof GetSplitTestResultsBreakdownEnum[keyof typeof GetSplitTestResultsBreakdownEnum];
+export const ListSplitTestsStateEnum = {
+    Active: 'active',
+    All: 'all',
+} as const;
+export type ListSplitTestsStateEnum = typeof ListSplitTestsStateEnum[keyof typeof ListSplitTestsStateEnum];
+
+

package/base.ts

@@ -0,0 +1,62 @@
+/* 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 type { Configuration } from './configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+
+export const BASE_PATH = "https://api.localhost:8080".replace(/\/+$/, "");
+
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+export interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+
+export class BaseAPI {
+    protected configuration: Configuration | undefined;
+
+    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath ?? basePath;
+        }
+    }
+};
+
+export class RequiredError extends Error {
+    constructor(public field: string, msg?: string) {
+        super(msg);
+        this.name = "RequiredError"
+    }
+}
+
+interface ServerMap {
+    [key: string]: {
+        url: string,
+        description: string,
+    }[];
+}
+
+export const operationServerMap: ServerMap = {
+}