@griffin-app/griffin-hub-sdk 1.0.0

package/docs/RunsApi.md

@@ -0,0 +1,260 @@
+# RunsApi
+
+All URIs are relative to *http://localhost:3000*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**runsGet**](#runsget) | **GET** /runs/ | |
+|[**runsIdGet**](#runsidget) | **GET** /runs/{id} | |
+|[**runsIdPatch**](#runsidpatch) | **PATCH** /runs/{id} | |
+|[**runsTriggerPlanIdPost**](#runstriggerplanidpost) | **POST** /runs/trigger/{planId} | |
+
+# **runsGet**
+> RunsGet200Response runsGet()
+
+
+### Example
+
+```typescript
+import {
+    RunsApi,
+    Configuration
+} from 'griffin-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new RunsApi(configuration);
+
+let planId: string; // (optional) (default to undefined)
+let status: 'pending' | 'running' | 'completed' | 'failed'; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+let offset: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.runsGet(
+    planId,
+    status,
+    limit,
+    offset
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **planId** | [**string**] |  | (optional) defaults to undefined|
+| **status** | [**&#39;pending&#39; | &#39;running&#39; | &#39;completed&#39; | &#39;failed&#39;**]**Array<&#39;pending&#39; &#124; &#39;running&#39; &#124; &#39;completed&#39; &#124; &#39;failed&#39;>** |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+| **offset** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**RunsGet200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Default Response |  -  |
+|**400** | Default Response |  -  |
+|**401** | Default Response |  -  |
+|**403** | Default Response |  -  |
+|**404** | Default Response |  -  |
+|**500** | Default Response |  -  |
+|**502** | Default Response |  -  |
+|**503** | Default Response |  -  |
+|**504** | Default Response |  -  |
+
+[[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)
+
+# **runsIdGet**
+> RunsIdGet200Response runsIdGet()
+
+
+### Example
+
+```typescript
+import {
+    RunsApi,
+    Configuration
+} from 'griffin-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new RunsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.runsIdGet(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**RunsIdGet200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Default Response |  -  |
+|**400** | Default Response |  -  |
+|**401** | Default Response |  -  |
+|**403** | Default Response |  -  |
+|**404** | Default Response |  -  |
+|**500** | Default Response |  -  |
+|**502** | Default Response |  -  |
+|**503** | Default Response |  -  |
+|**504** | Default Response |  -  |
+
+[[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)
+
+# **runsIdPatch**
+> RunsIdGet200Response runsIdPatch()
+
+
+### Example
+
+```typescript
+import {
+    RunsApi,
+    Configuration,
+    RunsIdPatchRequest
+} from 'griffin-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new RunsApi(configuration);
+
+let id: string; // (default to undefined)
+let runsIdPatchRequest: RunsIdPatchRequest; // (optional)
+
+const { status, data } = await apiInstance.runsIdPatch(
+    id,
+    runsIdPatchRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **runsIdPatchRequest** | **RunsIdPatchRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**RunsIdGet200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Default Response |  -  |
+|**400** | Default Response |  -  |
+|**401** | Default Response |  -  |
+|**403** | Default Response |  -  |
+|**404** | Default Response |  -  |
+|**500** | Default Response |  -  |
+|**502** | Default Response |  -  |
+|**503** | Default Response |  -  |
+|**504** | Default Response |  -  |
+
+[[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)
+
+# **runsTriggerPlanIdPost**
+> RunsIdGet200Response runsTriggerPlanIdPost(runsTriggerPlanIdPostRequest)
+
+
+### Example
+
+```typescript
+import {
+    RunsApi,
+    Configuration,
+    RunsTriggerPlanIdPostRequest
+} from 'griffin-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new RunsApi(configuration);
+
+let planId: string; // (default to undefined)
+let runsTriggerPlanIdPostRequest: RunsTriggerPlanIdPostRequest; //
+
+const { status, data } = await apiInstance.runsTriggerPlanIdPost(
+    planId,
+    runsTriggerPlanIdPostRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **runsTriggerPlanIdPostRequest** | **RunsTriggerPlanIdPostRequest**|  | |
+| **planId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**RunsIdGet200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Default Response |  -  |
+|**400** | Default Response |  -  |
+|**401** | Default Response |  -  |
+|**403** | Default Response |  -  |
+|**404** | Default Response |  -  |
+|**500** | Default Response |  -  |
+|**502** | Default Response |  -  |
+|**503** | Default Response |  -  |
+|**504** | Default Response |  -  |
+
+[[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/docs/RunsGet200Response.md

@@ -0,0 +1,26 @@
+# RunsGet200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<RunsGet200ResponseDataInner>**](RunsGet200ResponseDataInner.md) |  | [default to undefined]
+**total** | **number** |  | [default to undefined]
+**page** | **number** |  | [default to undefined]
+**limit** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RunsGet200Response } from 'griffin-hub-sdk';
+
+const instance: RunsGet200Response = {
+    data,
+    total,
+    page,
+    limit,
+};
+```
+
+[[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/RunsGet200ResponseDataInner.md

@@ -0,0 +1,42 @@
+# RunsGet200ResponseDataInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**planId** | **string** |  | [default to undefined]
+**executionGroupId** | **string** |  | [default to undefined]
+**location** | **string** |  | [default to undefined]
+**environment** | **string** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**triggeredBy** | **string** |  | [default to undefined]
+**startedAt** | **string** |  | [default to undefined]
+**completedAt** | **string** |  | [optional] [default to undefined]
+**duration_ms** | **number** |  | [optional] [default to undefined]
+**success** | **boolean** |  | [optional] [default to undefined]
+**errors** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunsGet200ResponseDataInner } from 'griffin-hub-sdk';
+
+const instance: RunsGet200ResponseDataInner = {
+    id,
+    planId,
+    executionGroupId,
+    location,
+    environment,
+    status,
+    triggeredBy,
+    startedAt,
+    completedAt,
+    duration_ms,
+    success,
+    errors,
+};
+```
+
+[[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/RunsIdGet200Response.md

@@ -0,0 +1,20 @@
+# RunsIdGet200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**RunsIdGet200ResponseData**](RunsIdGet200ResponseData.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RunsIdGet200Response } from 'griffin-hub-sdk';
+
+const instance: RunsIdGet200Response = {
+    data,
+};
+```
+
+[[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/RunsIdGet200ResponseData.md

@@ -0,0 +1,42 @@
+# RunsIdGet200ResponseData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**planId** | **string** |  | [default to undefined]
+**executionGroupId** | **string** |  | [default to undefined]
+**location** | **string** |  | [default to undefined]
+**environment** | **string** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**triggeredBy** | **string** |  | [default to undefined]
+**startedAt** | **string** |  | [default to undefined]
+**completedAt** | **string** |  | [optional] [default to undefined]
+**duration_ms** | **number** |  | [optional] [default to undefined]
+**success** | **boolean** |  | [optional] [default to undefined]
+**errors** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunsIdGet200ResponseData } from 'griffin-hub-sdk';
+
+const instance: RunsIdGet200ResponseData = {
+    id,
+    planId,
+    executionGroupId,
+    location,
+    environment,
+    status,
+    triggeredBy,
+    startedAt,
+    completedAt,
+    duration_ms,
+    success,
+    errors,
+};
+```
+
+[[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/RunsIdPatchRequest.md

@@ -0,0 +1,28 @@
+# RunsIdPatchRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to undefined]
+**completedAt** | **string** |  | [optional] [default to undefined]
+**duration_ms** | **number** |  | [optional] [default to undefined]
+**success** | **boolean** |  | [optional] [default to undefined]
+**errors** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunsIdPatchRequest } from 'griffin-hub-sdk';
+
+const instance: RunsIdPatchRequest = {
+    status,
+    completedAt,
+    duration_ms,
+    success,
+    errors,
+};
+```
+
+[[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/RunsTriggerPlanIdPostRequest.md

@@ -0,0 +1,20 @@
+# RunsTriggerPlanIdPostRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**environment** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RunsTriggerPlanIdPostRequest } from 'griffin-hub-sdk';
+
+const instance: RunsTriggerPlanIdPostRequest = {
+    environment,
+};
+```
+
+[[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/TestPlanV1.md

@@ -0,0 +1,38 @@
+# TestPlanV1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**organization** | **string** |  | [optional] [default to undefined]
+**project** | **string** |  | [optional] [default to undefined]
+**locations** | **Array<string>** |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**version** | **string** |  | [default to undefined]
+**frequency** | [**Frequency1**](Frequency1.md) |  | [optional] [default to undefined]
+**environment** | **string** |  | [default to 'default']
+**nodes** | [**Array<Node1>**](Node1.md) |  | [default to undefined]
+**edges** | [**Array<Edge1>**](Edge1.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { TestPlanV1 } from 'griffin-hub-sdk';
+
+const instance: TestPlanV1 = {
+    organization,
+    project,
+    locations,
+    id,
+    name,
+    version,
+    frequency,
+    environment,
+    nodes,
+    edges,
+};
+```
+
+[[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/UnaryPredicate.md

@@ -0,0 +1,18 @@
+# UnaryPredicate
+
+
+## Enum
+
+* `IsNull` (value: `'IS_NULL'`)
+
+* `IsNotNull` (value: `'IS_NOT_NULL'`)
+
+* `IsTrue` (value: `'IS_TRUE'`)
+
+* `IsFalse` (value: `'IS_FALSE'`)
+
+* `IsEmpty` (value: `'IS_EMPTY'`)
+
+* `IsNotEmpty` (value: `'IS_NOT_EMPTY'`)
+
+[[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/Wait.md

@@ -0,0 +1,24 @@
+# Wait
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**duration_ms** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Wait } from 'griffin-hub-sdk';
+
+const instance: Wait = {
+    id,
+    type,
+    duration_ms,
+};
+```
+
+[[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/Wait1.md

@@ -0,0 +1,24 @@
+# Wait1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**duration_ms** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Wait1 } from 'griffin-hub-sdk';
+
+const instance: Wait1 = {
+    id,
+    type,
+    duration_ms,
+};
+```
+
+[[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/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="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    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 */
+/**
+ * griffin-runner API
+ * API for managing and running test plans
+ *
+ * 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": "@griffin-app/griffin-hub-sdk",
+  "version": "1.0.0",
+  "description": "OpenAPI client for griffin-hub-sdk",
+  "author": "OpenAPI-Generator Contributors",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
+  },
+  "keywords": [
+    "axios",
+    "typescript",
+    "openapi-client",
+    "openapi-generator",
+    "griffin-hub-sdk"
+  ],
+  "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.6.1"
+  },
+  "devDependencies": {
+    "@types/node": "12.11.5 - 12.20.42",
+    "typescript": "^4.0 || ^5.0"
+  }
+}