@griffin-app/griffin-hub-sdk 1.0.0 → 1.0.1

package/docs/ConfigApi.md

@@ -1,330 +0,0 @@
-# ConfigApi
-
-All URIs are relative to *http://localhost:3000*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**configGet**](#configget) | **GET** /config/ | |
-|[**configOrganizationIdEnvironmentTargetsTargetKeyDelete**](#configorganizationidenvironmenttargetstargetkeydelete) | **DELETE** /config/{organizationId}/{environment}/targets/{targetKey} | |
-|[**configOrganizationIdEnvironmentTargetsTargetKeyGet**](#configorganizationidenvironmenttargetstargetkeyget) | **GET** /config/{organizationId}/{environment}/targets/{targetKey} | |
-|[**configOrganizationIdEnvironmentTargetsTargetKeyPut**](#configorganizationidenvironmenttargetstargetkeyput) | **PUT** /config/{organizationId}/{environment}/targets/{targetKey} | |
-|[**configSingleGet**](#configsingleget) | **GET** /config/single | |
-
-# **configGet**
-> ConfigGet200Response configGet()
-
-
-### Example
-
-```typescript
-import {
-    ConfigApi,
-    Configuration
-} from 'griffin-hub-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new ConfigApi(configuration);
-
-let organizationId: string; // (optional) (default to undefined)
-let environment: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.configGet(
-    organizationId,
-    environment
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **organizationId** | [**string**] |  | (optional) defaults to undefined|
-| **environment** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**ConfigGet200Response**
-
-### 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)
-
-# **configOrganizationIdEnvironmentTargetsTargetKeyDelete**
-> configOrganizationIdEnvironmentTargetsTargetKeyDelete()
-
-
-### Example
-
-```typescript
-import {
-    ConfigApi,
-    Configuration
-} from 'griffin-hub-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new ConfigApi(configuration);
-
-let organizationId: string; // (default to undefined)
-let environment: string; // (default to undefined)
-let targetKey: string; // (default to undefined)
-
-const { status, data } = await apiInstance.configOrganizationIdEnvironmentTargetsTargetKeyDelete(
-    organizationId,
-    environment,
-    targetKey
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **organizationId** | [**string**] |  | defaults to undefined|
-| **environment** | [**string**] |  | defaults to undefined|
-| **targetKey** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | 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)
-
-# **configOrganizationIdEnvironmentTargetsTargetKeyGet**
-> ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200Response configOrganizationIdEnvironmentTargetsTargetKeyGet()
-
-
-### Example
-
-```typescript
-import {
-    ConfigApi,
-    Configuration
-} from 'griffin-hub-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new ConfigApi(configuration);
-
-let organizationId: string; // (default to undefined)
-let environment: string; // (default to undefined)
-let targetKey: string; // (default to undefined)
-
-const { status, data } = await apiInstance.configOrganizationIdEnvironmentTargetsTargetKeyGet(
-    organizationId,
-    environment,
-    targetKey
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **organizationId** | [**string**] |  | defaults to undefined|
-| **environment** | [**string**] |  | defaults to undefined|
-| **targetKey** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**ConfigOrganizationIdEnvironmentTargetsTargetKeyGet200Response**
-
-### 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)
-
-# **configOrganizationIdEnvironmentTargetsTargetKeyPut**
-> ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response configOrganizationIdEnvironmentTargetsTargetKeyPut(configOrganizationIdEnvironmentTargetsTargetKeyPutRequest)
-
-
-### Example
-
-```typescript
-import {
-    ConfigApi,
-    Configuration,
-    ConfigOrganizationIdEnvironmentTargetsTargetKeyPutRequest
-} from 'griffin-hub-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new ConfigApi(configuration);
-
-let organizationId: string; // (default to undefined)
-let environment: string; // (default to undefined)
-let targetKey: string; // (default to undefined)
-let configOrganizationIdEnvironmentTargetsTargetKeyPutRequest: ConfigOrganizationIdEnvironmentTargetsTargetKeyPutRequest; //
-
-const { status, data } = await apiInstance.configOrganizationIdEnvironmentTargetsTargetKeyPut(
-    organizationId,
-    environment,
-    targetKey,
-    configOrganizationIdEnvironmentTargetsTargetKeyPutRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **configOrganizationIdEnvironmentTargetsTargetKeyPutRequest** | **ConfigOrganizationIdEnvironmentTargetsTargetKeyPutRequest**|  | |
-| **organizationId** | [**string**] |  | defaults to undefined|
-| **environment** | [**string**] |  | defaults to undefined|
-| **targetKey** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response**
-
-### 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)
-
-# **configSingleGet**
-> ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response configSingleGet()
-
-
-### Example
-
-```typescript
-import {
-    ConfigApi,
-    Configuration
-} from 'griffin-hub-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new ConfigApi(configuration);
-
-let organizationId: string; // (default to undefined)
-let environment: string; // (default to undefined)
-
-const { status, data } = await apiInstance.configSingleGet(
-    organizationId,
-    environment
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **organizationId** | [**string**] |  | defaults to undefined|
-| **environment** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200Response**
-
-### 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)
-

package/docs/ConfigGet200Response.md

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

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

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

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

@@ -1,30 +0,0 @@
-# ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200ResponseData
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**organizationId** | **string** |  | [default to undefined]
-**environment** | **string** |  | [default to undefined]
-**targets** | **{ [key: string]: string; }** |  | [default to undefined]
-**createdAt** | **string** |  | [default to undefined]
-**updatedAt** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200ResponseData } from 'griffin-hub-sdk';
-
-const instance: ConfigOrganizationIdEnvironmentTargetsTargetKeyPut200ResponseData = {
-    id,
-    organizationId,
-    environment,
-    targets,
-    createdAt,
-    updatedAt,
-};
-```
-
-[[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/ConfigOrganizationIdEnvironmentTargetsTargetKeyPutRequest.md

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

@@ -1,34 +0,0 @@
-# Endpoint1
-
-
-## 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]
-
-## Example
-
-```typescript
-import { Endpoint1 } from 'griffin-hub-sdk';
-
-const instance: Endpoint1 = {
-    id,
-    type,
-    method,
-    path,
-    base,
-    headers,
-    body,
-    response_format,
-};
-```
-
-[[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

@@ -1,38 +0,0 @@
-# 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)