@teemill/split-tests 1.0.0

package/common.ts

@@ -0,0 +1,161 @@
+/* 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 { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+import { RequiredError } from "./base";
+
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com'
+
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const accessToken = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+}
+
+function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
+    if (parameter == null) return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter) || parameter instanceof Set) {
+            (parameter as any[]).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: URL, ...objects: any[]) {
+    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: string, value: unknown) {
+    if (value instanceof Set) {
+        return Array.from(value);
+    }
+
+    return value;
+}
+
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: 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: URL) {
+    return url.pathname + url.search + url.hash
+}
+
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
+    return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
+        return axios.request<T, R>(axiosRequestArgs);
+    };
+}

package/configuration.ts

@@ -0,0 +1,121 @@
+/* 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.
+ */
+
+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 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 = {}) {
+        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 = {
+            ...param.baseOptions,
+            headers: {
+                ...param.baseOptions?.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.
+     */
+    public isJsonMime(mime: string): boolean {
+        const jsonMime: RegExp = /^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$/i;
+        return mime !== null && jsonMime.test(mime);
+    }
+}

package/dist/api.d.ts

@@ -0,0 +1,332 @@
+/**
+ * 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 type { RequestArgs } from './base';
+import { BaseAPI } 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 declare const SplitTestsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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: (project: string, splitTestId: string, breakdown?: GetSplitTestResultsBreakdownEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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: (project: string, search?: string, state?: ListSplitTestsStateEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SplitTestsApi - functional programming interface
+ */
+export declare const SplitTestsApiFp: (configuration?: Configuration) => {
+    /**
+     * 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(project: string, splitTestId: string, breakdown?: GetSplitTestResultsBreakdownEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SplitTestResults>>;
+    /**
+     * 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(project: string, search?: string, state?: ListSplitTestsStateEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSplitTests200Response>>;
+};
+/**
+ * SplitTestsApi - factory interface
+ */
+export declare const SplitTestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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>;
+    /**
+     * 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>;
+};
+/**
+ * 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 declare 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}
+     */
+    getSplitTestResults(requestParameters: SplitTestsApiGetSplitTestResultsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SplitTestResults, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<ListSplitTests200Response, any, {}>>;
+}
+export declare const GetSplitTestResultsBreakdownEnum: {
+    readonly None: "none";
+    readonly Device: "device";
+    readonly Platform: "platform";
+    readonly Browser: "browser";
+    readonly Country: "country";
+    readonly Territory: "territory";
+    readonly Domain: "domain";
+};
+export type GetSplitTestResultsBreakdownEnum = typeof GetSplitTestResultsBreakdownEnum[keyof typeof GetSplitTestResultsBreakdownEnum];
+export declare const ListSplitTestsStateEnum: {
+    readonly Active: "active";
+    readonly All: "all";
+};
+export type ListSplitTestsStateEnum = typeof ListSplitTestsStateEnum[keyof typeof ListSplitTestsStateEnum];