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

package/src/docs/DbTableOrDeploymentResourceOneOf.md

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

@@ -0,0 +1,46 @@
+# Deployment
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**created_at** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**kind_id** | **string** |  | [default to undefined]
+**cluster_id** | **string** |  | [default to undefined]
+**enabled** | **boolean** |  | [default to undefined]
+**status** | [**DeploymentStatus**](DeploymentStatus.md) |  | [default to undefined]
+**description_md** | **string** |  | [default to undefined]
+**reason** | **string** |  | [default to undefined]
+**revision_id** | **string** |  | [default to undefined]
+**reported_status** | [**DeploymentReportedStatus**](DeploymentReportedStatus.md) |  | [default to undefined]
+**helm_chart_id** | **string** |  | [default to undefined]
+**config** | **any** |  | [default to undefined]
+**values_override** | **any** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Deployment } from './api';
+
+const instance: Deployment = {
+    id,
+    created_at,
+    name,
+    kind_id,
+    cluster_id,
+    enabled,
+    status,
+    description_md,
+    reason,
+    revision_id,
+    reported_status,
+    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/DeploymentInstallTask.md

@@ -0,0 +1,24 @@
+# DeploymentInstallTask
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**helm_chart_id** | **string** |  | [default to undefined]
+**config_inputs** | **any** |  | [default to undefined]
+**values_override** | **any** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeploymentInstallTask } from './api';
+
+const instance: DeploymentInstallTask = {
+    helm_chart_id,
+    config_inputs,
+    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/DeploymentInvokeActionTask.md

@@ -0,0 +1,24 @@
+# DeploymentInvokeActionTask
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**helm_chart_id** | **string** |  | [default to undefined]
+**action_id** | **string** |  | [default to undefined]
+**body** | **any** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeploymentInvokeActionTask } from './api';
+
+const instance: DeploymentInvokeActionTask = {
+    helm_chart_id,
+    action_id,
+    body,
+};
+```
+
+[[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/DeploymentKind.md

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

@@ -0,0 +1,164 @@
+# DeploymentKindsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**allDeploymentKinds**](#alldeploymentkinds) | **GET** /api/v2/deployment-kinds | |
+|[**getDeploymentKind**](#getdeploymentkind) | **GET** /api/v2/deployment-kinds/{id} | |
+|[**updateDeploymentKind**](#updatedeploymentkind) | **PUT** /api/v2/deployment-kinds/{id} | |
+
+# **allDeploymentKinds**
+> PaginatedDeploymentKind allDeploymentKinds()
+
+
+### Example
+
+```typescript
+import {
+    DeploymentKindsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentKindsApi(configuration);
+
+let name: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.allDeploymentKinds(
+    name
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **name** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedDeploymentKind**
+
+### 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)
+
+# **getDeploymentKind**
+> DeploymentKind getDeploymentKind()
+
+
+### Example
+
+```typescript
+import {
+    DeploymentKindsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentKindsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getDeploymentKind(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeploymentKind**
+
+### 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)
+
+# **updateDeploymentKind**
+> DeploymentKind updateDeploymentKind(updateDeploymentKind)
+
+
+### Example
+
+```typescript
+import {
+    DeploymentKindsApi,
+    Configuration,
+    UpdateDeploymentKind
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentKindsApi(configuration);
+
+let id: string; // (default to undefined)
+let updateDeploymentKind: UpdateDeploymentKind; //
+
+const { status, data } = await apiInstance.updateDeploymentKind(
+    id,
+    updateDeploymentKind
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateDeploymentKind** | **UpdateDeploymentKind**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeploymentKind**
+
+### 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/DeploymentPermission.md

@@ -0,0 +1,30 @@
+# DeploymentPermission
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**created_at** | **string** |  | [default to undefined]
+**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 { DeploymentPermission } from './api';
+
+const instance: DeploymentPermission = {
+    id,
+    created_at,
+    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/DeploymentPermissionsApi.md

@@ -0,0 +1,212 @@
+# DeploymentPermissionsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**allDeploymentPermissions**](#alldeploymentpermissions) | **GET** /api/v2/deployment-permissions | |
+|[**createDeploymentPermission**](#createdeploymentpermission) | **POST** /api/v2/deployment-permissions | |
+|[**deleteDeploymentPermission**](#deletedeploymentpermission) | **DELETE** /api/v2/deployment-permissions/{id} | |
+|[**getDeploymentPermission**](#getdeploymentpermission) | **GET** /api/v2/deployment-permissions/{id} | |
+
+# **allDeploymentPermissions**
+> PaginatedDeploymentPermission allDeploymentPermissions()
+
+
+### Example
+
+```typescript
+import {
+    DeploymentPermissionsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentPermissionsApi(configuration);
+
+let envId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.allDeploymentPermissions(
+    envId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **envId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedDeploymentPermission**
+
+### 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)
+
+# **createDeploymentPermission**
+> DeploymentPermission createDeploymentPermission(newDeploymentPermission)
+
+
+### Example
+
+```typescript
+import {
+    DeploymentPermissionsApi,
+    Configuration,
+    NewDeploymentPermission
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentPermissionsApi(configuration);
+
+let newDeploymentPermission: NewDeploymentPermission; //
+
+const { status, data } = await apiInstance.createDeploymentPermission(
+    newDeploymentPermission
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **newDeploymentPermission** | **NewDeploymentPermission**|  | |
+
+
+### Return type
+
+**DeploymentPermission**
+
+### 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 |
+|-------------|-------------|------------------|
+|**201** |  |  -  |
+
+[[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)
+
+# **deleteDeploymentPermission**
+> deleteDeploymentPermission()
+
+
+### Example
+
+```typescript
+import {
+    DeploymentPermissionsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentPermissionsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteDeploymentPermission(
+    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)
+
+# **getDeploymentPermission**
+> DeploymentPermission getDeploymentPermission()
+
+
+### Example
+
+```typescript
+import {
+    DeploymentPermissionsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentPermissionsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getDeploymentPermission(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeploymentPermission**
+
+### 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/DeploymentRecreaseTask.md

@@ -0,0 +1,26 @@
+# DeploymentRecreaseTask
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**old_cluster_id** | **string** |  | [default to undefined]
+**old_namespace** | **string** |  | [default to undefined]
+**new_cluster_id** | **string** |  | [default to undefined]
+**new_namespace** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeploymentRecreaseTask } from './api';
+
+const instance: DeploymentRecreaseTask = {
+    old_cluster_id,
+    old_namespace,
+    new_cluster_id,
+    new_namespace,
+};
+```
+
+[[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/DeploymentReinstallTask.md

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

@@ -0,0 +1,26 @@
+# DeploymentReportedMetric
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **string** |  | [default to undefined]
+**unit** | **string** |  | [default to undefined]
+**short_description** | **string** |  | [default to undefined]
+**color** | [**DeploymentReportedStatusColor**](DeploymentReportedStatusColor.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeploymentReportedMetric } from './api';
+
+const instance: DeploymentReportedMetric = {
+    value,
+    unit,
+    short_description,
+    color,
+};
+```
+
+[[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/DeploymentReportedNotice.md

@@ -0,0 +1,22 @@
+# DeploymentReportedNotice
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**level** | [**DeploymentReportedNoticeLevel**](DeploymentReportedNoticeLevel.md) |  | [default to undefined]
+**text** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeploymentReportedNotice } from './api';
+
+const instance: DeploymentReportedNotice = {
+    level,
+    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)

package/src/docs/DeploymentReportedNoticeLevel.md

@@ -0,0 +1,12 @@
+# DeploymentReportedNoticeLevel
+
+
+## Enum
+
+* `Info` (value: `'Info'`)
+
+* `Warning` (value: `'Warning'`)
+
+* `Danger` (value: `'Danger'`)
+
+[[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/DeploymentReportedStatus.md

@@ -0,0 +1,26 @@
+# DeploymentReportedStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **string** |  | [default to undefined]
+**get_successful** | **boolean** |  | [default to undefined]
+**content** | [**DeploymentReportedStatusContent**](DeploymentReportedStatusContent.md) |  | [default to undefined]
+**error** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeploymentReportedStatus } from './api';
+
+const instance: DeploymentReportedStatus = {
+    timestamp,
+    get_successful,
+    content,
+    error,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)