@griffin-app/griffin-hub-sdk 1.0.0

package/docs/Endpoint1HeadersValue.md

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

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

@@ -0,0 +1,26 @@
+# Endpoint1HeadersValueAnyOfSecret
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **string** |  | [default to undefined]
+**ref** | **string** |  | [default to undefined]
+**version** | **string** |  | [optional] [default to undefined]
+**field** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Endpoint1HeadersValueAnyOfSecret } from 'griffin-hub-sdk';
+
+const instance: Endpoint1HeadersValueAnyOfSecret = {
+    provider,
+    ref,
+    version,
+    field,
+};
+```
+
+[[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/Frequency.md

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

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

@@ -0,0 +1,24 @@
+# HttpMethod
+
+
+## Enum
+
+* `Get` (value: `'GET'`)
+
+* `Post` (value: `'POST'`)
+
+* `Put` (value: `'PUT'`)
+
+* `Delete` (value: `'DELETE'`)
+
+* `Patch` (value: `'PATCH'`)
+
+* `Head` (value: `'HEAD'`)
+
+* `Options` (value: `'OPTIONS'`)
+
+* `Connect` (value: `'CONNECT'`)
+
+* `Trace` (value: `'TRACE'`)
+
+[[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/JSONAssertion.md

@@ -0,0 +1,26 @@
+# JSONAssertion
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodeId** | **string** |  | [default to undefined]
+**accessor** | **string** |  | [default to undefined]
+**path** | **Array<string>** |  | [default to undefined]
+**predicate** | [**JSONAssertion1Predicate**](JSONAssertion1Predicate.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { JSONAssertion } from 'griffin-hub-sdk';
+
+const instance: JSONAssertion = {
+    nodeId,
+    accessor,
+    path,
+    predicate,
+};
+```
+
+[[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/JSONAssertion1Predicate.md

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

@@ -0,0 +1,38 @@
+# Node
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**method** | **string** |  | [default to undefined]
+**path** | **string** |  | [default to undefined]
+**base** | [**Endpoint1Base**](Endpoint1Base.md) |  | [default to undefined]
+**headers** | [**{ [key: string]: Endpoint1HeadersValue; }**](Endpoint1HeadersValue.md) |  | [optional] [default to undefined]
+**body** | **any** |  | [optional] [default to undefined]
+**response_format** | **string** |  | [default to undefined]
+**duration_ms** | **number** |  | [default to undefined]
+**assertions** | [**Array<Assertion1>**](Assertion1.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Node } from 'griffin-hub-sdk';
+
+const instance: Node = {
+    id,
+    type,
+    method,
+    path,
+    base,
+    headers,
+    body,
+    response_format,
+    duration_ms,
+    assertions,
+};
+```
+
+[[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/Node1.md

@@ -0,0 +1,38 @@
+# Node1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**method** | **string** |  | [default to undefined]
+**path** | **string** |  | [default to undefined]
+**base** | [**Endpoint1Base**](Endpoint1Base.md) |  | [default to undefined]
+**headers** | [**{ [key: string]: Endpoint1HeadersValue; }**](Endpoint1HeadersValue.md) |  | [optional] [default to undefined]
+**body** | **any** |  | [optional] [default to undefined]
+**response_format** | **string** |  | [default to undefined]
+**duration_ms** | **number** |  | [default to undefined]
+**assertions** | [**Array<Assertion1>**](Assertion1.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Node1 } from 'griffin-hub-sdk';
+
+const instance: Node1 = {
+    id,
+    type,
+    method,
+    path,
+    base,
+    headers,
+    body,
+    response_format,
+    duration_ms,
+    assertions,
+};
+```
+
+[[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/PlanApi.md

@@ -0,0 +1,132 @@
+# PlanApi
+
+All URIs are relative to *http://localhost:3000*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**planGet**](#planget) | **GET** /plan/ | |
+|[**planPost**](#planpost) | **POST** /plan/ | |
+
+# **planGet**
+> PlanGet200Response planGet()
+
+
+### Example
+
+```typescript
+import {
+    PlanApi,
+    Configuration
+} from 'griffin-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PlanApi(configuration);
+
+let projectId: string; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+let offset: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.planGet(
+    projectId,
+    limit,
+    offset
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **projectId** | [**string**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+| **offset** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PlanGet200Response**
+
+### 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)
+
+# **planPost**
+> PlanPost201Response planPost()
+
+
+### Example
+
+```typescript
+import {
+    PlanApi,
+    Configuration,
+    TestPlanV1
+} from 'griffin-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PlanApi(configuration);
+
+let testPlanV1: TestPlanV1; // (optional)
+
+const { status, data } = await apiInstance.planPost(
+    testPlanV1
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **testPlanV1** | **TestPlanV1**|  | |
+
+
+### Return type
+
+**PlanPost201Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | 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/PlanGet200Response.md

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

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

@@ -0,0 +1,12 @@
+# ResponseFormat
+
+
+## Enum
+
+* `Json` (value: `'JSON'`)
+
+* `Xml` (value: `'XML'`)
+
+* `Text` (value: `'TEXT'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)