@platzio/sdk 0.6.0-beta.2 → 0.7.0-beta.1

package/src/docs/KubernetesClustersApi.md

@@ -0,0 +1,218 @@
+# KubernetesClustersApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**allK8sClusters**](#allk8sclusters) | **GET** /api/v2/k8s-clusters | |
+|[**deleteK8sCluster**](#deletek8scluster) | **DELETE** /api/v2/k8s-clusters/{id} | |
+|[**getK8sCluster**](#getk8scluster) | **GET** /api/v2/k8s-clusters/{id} | |
+|[**updateK8sCluster**](#updatek8scluster) | **PUT** /api/v2/k8s-clusters/{id} | |
+
+# **allK8sClusters**
+> PaginatedK8sCluster allK8sClusters()
+
+
+### Example
+
+```typescript
+import {
+    KubernetesClustersApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new KubernetesClustersApi(configuration);
+
+let envId: string; // (optional) (default to undefined)
+let name: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.allK8sClusters(
+    envId,
+    name
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **envId** | [**string**] |  | (optional) defaults to undefined|
+| **name** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedK8sCluster**
+
+### Authorization
+
+[access_token](../README.md#access_token), [user_token](../README.md#user_token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+
+# **deleteK8sCluster**
+> deleteK8sCluster()
+
+
+### Example
+
+```typescript
+import {
+    KubernetesClustersApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new KubernetesClustersApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteK8sCluster(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[access_token](../README.md#access_token), [user_token](../README.md#user_token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** |  |  -  |
+
+[[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)
+
+# **getK8sCluster**
+> K8sCluster getK8sCluster()
+
+
+### Example
+
+```typescript
+import {
+    KubernetesClustersApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new KubernetesClustersApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getK8sCluster(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**K8sCluster**
+
+### Authorization
+
+[access_token](../README.md#access_token), [user_token](../README.md#user_token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+
+# **updateK8sCluster**
+> K8sCluster updateK8sCluster(updateK8sCluster)
+
+
+### Example
+
+```typescript
+import {
+    KubernetesClustersApi,
+    Configuration,
+    UpdateK8sCluster
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new KubernetesClustersApi(configuration);
+
+let id: string; // (default to undefined)
+let updateK8sCluster: UpdateK8sCluster; //
+
+const { status, data } = await apiInstance.updateK8sCluster(
+    id,
+    updateK8sCluster
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateK8sCluster** | **UpdateK8sCluster**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**K8sCluster**
+
+### Authorization
+
+[access_token](../README.md#access_token), [user_token](../README.md#user_token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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/src/docs/KubernetesResourcesApi.md

@@ -0,0 +1,118 @@
+# KubernetesResourcesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**allK8sResources**](#allk8sresources) | **GET** /api/v2/k8s-resources | |
+|[**getK8sResource**](#getk8sresource) | **GET** /api/v2/k8s-resources/{id} | |
+
+# **allK8sResources**
+> PaginatedK8sResource allK8sResources()
+
+
+### Example
+
+```typescript
+import {
+    KubernetesResourcesApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new KubernetesResourcesApi(configuration);
+
+let clusterId: string; // (optional) (default to undefined)
+let deploymentId: string; // (optional) (default to undefined)
+let kind: string; // (optional) (default to undefined)
+let name: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.allK8sResources(
+    clusterId,
+    deploymentId,
+    kind,
+    name
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clusterId** | [**string**] |  | (optional) defaults to undefined|
+| **deploymentId** | [**string**] |  | (optional) defaults to undefined|
+| **kind** | [**string**] |  | (optional) defaults to undefined|
+| **name** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedK8sResource**
+
+### Authorization
+
+[access_token](../README.md#access_token), [user_token](../README.md#user_token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+
+# **getK8sResource**
+> K8sResource getK8sResource()
+
+
+### Example
+
+```typescript
+import {
+    KubernetesResourcesApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new KubernetesResourcesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getK8sResource(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**K8sResource**
+
+### Authorization
+
+[access_token](../README.md#access_token), [user_token](../README.md#user_token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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/src/docs/MeResponse.md

@@ -0,0 +1,24 @@
+# MeResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**User** | [**User**](User.md) |  | [default to undefined]
+**Bot** | [**Bot**](Bot.md) |  | [default to undefined]
+**Deployment** | [**MeResponseOneOf2Deployment**](MeResponseOneOf2Deployment.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MeResponse } from './api';
+
+const instance: MeResponse = {
+    User,
+    Bot,
+    Deployment,
+};
+```
+
+[[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/src/docs/MeResponseOneOf.md

@@ -0,0 +1,20 @@
+# MeResponseOneOf
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**User** | [**User**](User.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MeResponseOneOf } from './api';
+
+const instance: MeResponseOneOf = {
+    User,
+};
+```
+
+[[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/src/docs/MeResponseOneOf1.md

@@ -0,0 +1,20 @@
+# MeResponseOneOf1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Bot** | [**Bot**](Bot.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MeResponseOneOf1 } from './api';
+
+const instance: MeResponseOneOf1 = {
+    Bot,
+};
+```
+
+[[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/src/docs/MeResponseOneOf2.md

@@ -0,0 +1,20 @@
+# MeResponseOneOf2
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Deployment** | [**MeResponseOneOf2Deployment**](MeResponseOneOf2Deployment.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MeResponseOneOf2 } from './api';
+
+const instance: MeResponseOneOf2 = {
+    Deployment,
+};
+```
+
+[[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/src/docs/MeResponseOneOf2Deployment.md

@@ -0,0 +1,22 @@
+# MeResponseOneOf2Deployment
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MeResponseOneOf2Deployment } from './api';
+
+const instance: MeResponseOneOf2Deployment = {
+    id,
+    name,
+};
+```
+
+[[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/src/docs/NewDeployment.md

@@ -0,0 +1,30 @@
+# NewDeployment
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**kind_id** | **string** |  | [default to undefined]
+**cluster_id** | **string** |  | [default to undefined]
+**helm_chart_id** | **string** |  | [default to undefined]
+**config** | **any** |  | [default to undefined]
+**values_override** | **any** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { NewDeployment } from './api';
+
+const instance: NewDeployment = {
+    name,
+    kind_id,
+    cluster_id,
+    helm_chart_id,
+    config,
+    values_override,
+};
+```
+
+[[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/src/docs/NewDeploymentPermission.md

@@ -0,0 +1,26 @@
+# NewDeploymentPermission
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**env_id** | **string** |  | [default to undefined]
+**user_id** | **string** |  | [default to undefined]
+**kind_id** | **string** |  | [default to undefined]
+**role** | [**UserDeploymentRole**](UserDeploymentRole.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { NewDeploymentPermission } from './api';
+
+const instance: NewDeploymentPermission = {
+    env_id,
+    user_id,
+    kind_id,
+    role,
+};
+```
+
+[[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/src/docs/NewDeploymentResource.md

@@ -0,0 +1,32 @@
+# NewDeploymentResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**type_id** | **string** |  | [default to undefined]
+**deployment_id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**props** | **any** |  | [default to undefined]
+**sync_status** | [**DeploymentResourceSyncStatus**](DeploymentResourceSyncStatus.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NewDeploymentResource } from './api';
+
+const instance: NewDeploymentResource = {
+    id,
+    created_at,
+    type_id,
+    deployment_id,
+    name,
+    props,
+    sync_status,
+};
+```
+
+[[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/src/docs/NewEnv.md

@@ -0,0 +1,22 @@
+# NewEnv
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**auto_add_new_users** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NewEnv } from './api';
+
+const instance: NewEnv = {
+    name,
+    auto_add_new_users,
+};
+```
+
+[[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/src/docs/NewEnvUserPermission.md

@@ -0,0 +1,24 @@
+# NewEnvUserPermission
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**env_id** | **string** |  | [default to undefined]
+**user_id** | **string** |  | [default to undefined]
+**role** | [**EnvUserRole**](EnvUserRole.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { NewEnvUserPermission } from './api';
+
+const instance: NewEnvUserPermission = {
+    env_id,
+    user_id,
+    role,
+};
+```
+
+[[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/src/docs/NewHelmTagFormat.md

@@ -0,0 +1,20 @@
+# NewHelmTagFormat
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pattern** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { NewHelmTagFormat } from './api';
+
+const instance: NewHelmTagFormat = {
+    pattern,
+};
+```
+
+[[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/src/docs/NewSecret.md

@@ -0,0 +1,26 @@
+# NewSecret
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**env_id** | **string** |  | [default to undefined]
+**collection** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**contents** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { NewSecret } from './api';
+
+const instance: NewSecret = {
+    env_id,
+    collection,
+    name,
+    contents,
+};
+```
+
+[[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/src/docs/OAuth2Response.md

@@ -0,0 +1,20 @@
+# OAuth2Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**auth_code** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { OAuth2Response } from './api';
+
+const instance: OAuth2Response = {
+    auth_code,
+};
+```
+
+[[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/src/docs/PaginatedBot.md

@@ -0,0 +1,26 @@
+# PaginatedBot
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **number** |  | [default to undefined]
+**per_page** | **number** |  | [default to undefined]
+**items** | [**Array<PaginatedBotItemsInner>**](PaginatedBotItemsInner.md) |  | [default to undefined]
+**num_total** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedBot } from './api';
+
+const instance: PaginatedBot = {
+    page,
+    per_page,
+    items,
+    num_total,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)