@teemill/split-tests 1.0.0

package/docs/SplitTestResults.md

@@ -0,0 +1,29 @@
+# SplitTestResults
+
+Aggregated performance summary for a split test.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Split test name. | [default to undefined]
+**sessions** | **number** | Total session count across all returned variations. | [default to undefined]
+**events** | **Array<string>** | Distinct event names present in the result set. | [default to undefined]
+**controlVariation** | [**SplitTestResultVariation**](SplitTestResultVariation.md) |  | [default to undefined]
+**variations** | [**Array<SplitTestResultVariation>**](SplitTestResultVariation.md) | Per-variation performance metrics. | [default to undefined]
+
+## Example
+
+```typescript
+import { SplitTestResults } from '@teemill/split-tests';
+
+const instance: SplitTestResults = {
+    name,
+    sessions,
+    events,
+    controlVariation,
+    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/SplitTestVariation.md

@@ -0,0 +1,27 @@
+# SplitTestVariation
+
+Basic variation metadata for a split test definition.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique variation UUID. | [default to undefined]
+**name** | **string** | Variation label. | [default to undefined]
+**control** | **boolean** | Whether this variation is the control baseline. | [default to undefined]
+**active** | **boolean** | Whether this variation is currently active for assignment. | [default to undefined]
+
+## Example
+
+```typescript
+import { SplitTestVariation } from '@teemill/split-tests';
+
+const instance: SplitTestVariation = {
+    id,
+    name,
+    control,
+    active,
+};
+```
+
+[[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/SplitTestsApi.md

@@ -0,0 +1,130 @@
+# SplitTestsApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getSplitTestResults**](#getsplittestresults) | **GET** /v1/split-tests/{splitTestId}/results | Get split test results|
+|[**listSplitTests**](#listsplittests) | **GET** /v1/split-tests | List split tests|
+
+# **getSplitTestResults**
+> SplitTestResults getSplitTestResults()
+
+Get aggregate split test results and optional breakdowns.
+
+### Example
+
+```typescript
+import {
+    SplitTestsApi,
+    Configuration
+} from '@teemill/split-tests';
+
+const configuration = new Configuration();
+const apiInstance = new SplitTestsApi(configuration);
+
+let project: string; //Project identifier used to scope split test data for the current integration context. (default to undefined)
+let splitTestId: string; //UUID of the split test to fetch detailed results for. (default to undefined)
+let breakdown: 'none' | 'device' | 'platform' | 'browser' | 'country' | 'territory' | 'domain'; //Optional dimension used to group variation metrics in `breakdowns`. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getSplitTestResults(
+    project,
+    splitTestId,
+    breakdown
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project identifier used to scope split test data for the current integration context. | defaults to undefined|
+| **splitTestId** | [**string**] | UUID of the split test to fetch detailed results for. | defaults to undefined|
+| **breakdown** | [**&#39;none&#39; | &#39;device&#39; | &#39;platform&#39; | &#39;browser&#39; | &#39;country&#39; | &#39;territory&#39; | &#39;domain&#39;**]**Array<&#39;none&#39; &#124; &#39;device&#39; &#124; &#39;platform&#39; &#124; &#39;browser&#39; &#124; &#39;country&#39; &#124; &#39;territory&#39; &#124; &#39;domain&#39;>** | Optional dimension used to group variation metrics in &#x60;breakdowns&#x60;. | (optional) defaults to undefined|
+
+
+### Return type
+
+**SplitTestResults**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Split test results |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Forbidden |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listSplitTests**
+> ListSplitTests200Response listSplitTests()
+
+List split tests for inspector tooling.
+
+### Example
+
+```typescript
+import {
+    SplitTestsApi,
+    Configuration
+} from '@teemill/split-tests';
+
+const configuration = new Configuration();
+const apiInstance = new SplitTestsApi(configuration);
+
+let project: string; //Project identifier used to scope split test data for the current integration context. (default to undefined)
+let search: string; //Case-insensitive search term matched against split test name and code. (optional) (default to undefined)
+let state: 'active' | 'all'; //Filter for which split tests to return (`active` for currently running tests, `all` for every test). (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listSplitTests(
+    project,
+    search,
+    state
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project identifier used to scope split test data for the current integration context. | defaults to undefined|
+| **search** | [**string**] | Case-insensitive search term matched against split test name and code. | (optional) defaults to undefined|
+| **state** | [**&#39;active&#39; | &#39;all&#39;**]**Array<&#39;active&#39; &#124; &#39;all&#39;>** | Filter for which split tests to return (&#x60;active&#x60; for currently running tests, &#x60;all&#x60; for every test). | (optional) defaults to undefined|
+
+
+### Return type
+
+**ListSplitTests200Response**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Split test list |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Forbidden |  -  |
+|**500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="Teemill"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="public-api"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/index.ts

@@ -0,0 +1,18 @@
+/* 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/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@teemill/split-tests",
+  "version": "1.0.0",
+  "description": "OpenAPI client for @teemill/split-tests",
+  "author": "OpenAPI-Generator Contributors",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Teemill/public-api.git"
+  },
+  "keywords": [
+    "axios",
+    "typescript",
+    "openapi-client",
+    "openapi-generator",
+    "@teemill/split-tests"
+  ],
+  "license": "Unlicense",
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "dependencies": {
+    "axios": "^1.16.0"
+  },
+  "devDependencies": {
+    "@types/node": "12.11.5 - 12.20.42",
+    "typescript": "^4.0 || ^5.0"
+  }
+}

package/tsconfig.esm.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "outDir": "dist/esm"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "target": "ES6",
+    "module": "commonjs",
+    "noImplicitAny": true,
+    "outDir": "dist",
+    "rootDir": ".",
+    "moduleResolution": "node",
+    "typeRoots": [
+      "node_modules/@types"
+    ]
+  },
+  "exclude": [
+    "dist",
+    "node_modules"
+  ]
+}