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

package/src/docs/DeploymentReportedStatusColor.md

@@ -0,0 +1,16 @@
+# DeploymentReportedStatusColor
+
+
+## Enum
+
+* `Primary` (value: `'primary'`)
+
+* `Success` (value: `'success'`)
+
+* `Danger` (value: `'danger'`)
+
+* `Warning` (value: `'warning'`)
+
+* `Secondary` (value: `'secondary'`)
+
+[[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/DeploymentReportedStatusContent.md

@@ -0,0 +1,26 @@
+# DeploymentReportedStatusContent
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**DeploymentReportedStatusSummary**](DeploymentReportedStatusSummary.md) |  | [default to undefined]
+**primary_metric** | [**DeploymentReportedMetric**](DeploymentReportedMetric.md) |  | [default to undefined]
+**metrics** | [**Array<DeploymentReportedMetric>**](DeploymentReportedMetric.md) |  | [default to undefined]
+**notices** | [**Array<DeploymentReportedNotice>**](DeploymentReportedNotice.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DeploymentReportedStatusContent } from './api';
+
+const instance: DeploymentReportedStatusContent = {
+    status,
+    primary_metric,
+    metrics,
+    notices,
+};
+```
+
+[[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/DeploymentReportedStatusSummary.md

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

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

@@ -0,0 +1,16 @@
+# DeploymentResourceSyncStatus
+
+
+## Enum
+
+* `Creating` (value: `'Creating'`)
+
+* `Updating` (value: `'Updating'`)
+
+* `Deleting` (value: `'Deleting'`)
+
+* `Ready` (value: `'Ready'`)
+
+* `Error` (value: `'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)

package/src/docs/DeploymentResourceType.md

@@ -0,0 +1,30 @@
+# DeploymentResourceType
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**created_at** | **string** |  | [default to undefined]
+**env_id** | **string** |  | [default to undefined]
+**deployment_kind_id** | **string** |  | [default to undefined]
+**key** | **string** |  | [default to undefined]
+**spec** | [**ChartExtResourceTypeV1Beta1Spec**](ChartExtResourceTypeV1Beta1Spec.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeploymentResourceType } from './api';
+
+const instance: DeploymentResourceType = {
+    id,
+    created_at,
+    env_id,
+    deployment_kind_id,
+    key,
+    spec,
+};
+```
+
+[[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/DeploymentResourceTypesApi.md

@@ -0,0 +1,115 @@
+# DeploymentResourceTypesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**allDeploymentResourceTypes**](#alldeploymentresourcetypes) | **GET** /api/v2/deployment-resource-types | |
+|[**getDeploymentResourceType**](#getdeploymentresourcetype) | **GET** /api/v2/deployment-resource-types/{id} | |
+
+# **allDeploymentResourceTypes**
+> PaginatedDeploymentResourceType allDeploymentResourceTypes()
+
+
+### Example
+
+```typescript
+import {
+    DeploymentResourceTypesApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentResourceTypesApi(configuration);
+
+let envId: string; // (optional) (default to undefined)
+let deploymentKindId: string; // (optional) (default to undefined)
+let key: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.allDeploymentResourceTypes(
+    envId,
+    deploymentKindId,
+    key
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **envId** | [**string**] |  | (optional) defaults to undefined|
+| **deploymentKindId** | [**string**] |  | (optional) defaults to undefined|
+| **key** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedDeploymentResourceType**
+
+### 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)
+
+# **getDeploymentResourceType**
+> DeploymentResourceType getDeploymentResourceType()
+
+
+### Example
+
+```typescript
+import {
+    DeploymentResourceTypesApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentResourceTypesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getDeploymentResourceType(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeploymentResourceType**
+
+### 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/DeploymentResourcesApi.md

@@ -0,0 +1,267 @@
+# DeploymentResourcesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**allDeploymentResources**](#alldeploymentresources) | **GET** /api/v2/deployment-resources | |
+|[**createDeploymentResource**](#createdeploymentresource) | **POST** /api/v2/deployment-resources | |
+|[**deleteDeploymentResource**](#deletedeploymentresource) | **DELETE** /api/v2/deployment-resources/{id} | |
+|[**getDeploymentResource**](#getdeploymentresource) | **GET** /api/v2/deployment-resources/{id} | |
+|[**updateDeploymentResource**](#updatedeploymentresource) | **PUT** /api/v2/deployment-resources/{id} | |
+
+# **allDeploymentResources**
+> PaginatedDeploymentResource allDeploymentResources()
+
+
+### Example
+
+```typescript
+import {
+    DeploymentResourcesApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentResourcesApi(configuration);
+
+let typeId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.allDeploymentResources(
+    typeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **typeId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedDeploymentResource**
+
+### 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)
+
+# **createDeploymentResource**
+> DeploymentResource createDeploymentResource(newDeploymentResource)
+
+
+### Example
+
+```typescript
+import {
+    DeploymentResourcesApi,
+    Configuration,
+    NewDeploymentResource
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentResourcesApi(configuration);
+
+let newDeploymentResource: NewDeploymentResource; //
+
+const { status, data } = await apiInstance.createDeploymentResource(
+    newDeploymentResource
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **newDeploymentResource** | **NewDeploymentResource**|  | |
+
+
+### Return type
+
+**DeploymentResource**
+
+### 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)
+
+# **deleteDeploymentResource**
+> deleteDeploymentResource()
+
+
+### Example
+
+```typescript
+import {
+    DeploymentResourcesApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentResourcesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteDeploymentResource(
+    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)
+
+# **getDeploymentResource**
+> DeploymentResource getDeploymentResource()
+
+
+### Example
+
+```typescript
+import {
+    DeploymentResourcesApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentResourcesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getDeploymentResource(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeploymentResource**
+
+### 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)
+
+# **updateDeploymentResource**
+> DeploymentResource updateDeploymentResource(updateDeploymentResource)
+
+
+### Example
+
+```typescript
+import {
+    DeploymentResourcesApi,
+    Configuration,
+    UpdateDeploymentResource
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeploymentResourcesApi(configuration);
+
+let id: string; // (default to undefined)
+let updateDeploymentResource: UpdateDeploymentResource; //
+
+const { status, data } = await apiInstance.updateDeploymentResource(
+    id,
+    updateDeploymentResource
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateDeploymentResource** | **UpdateDeploymentResource**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeploymentResource**
+
+### 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/DeploymentRestartK8sResourceTask.md

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

@@ -0,0 +1,24 @@
+# DeploymentStatus
+
+
+## Enum
+
+* `Unknown` (value: `'Unknown'`)
+
+* `Installing` (value: `'Installing'`)
+
+* `Renaming` (value: `'Renaming'`)
+
+* `Upgrading` (value: `'Upgrading'`)
+
+* `Running` (value: `'Running'`)
+
+* `Error` (value: `'Error'`)
+
+* `Uninstalling` (value: `'Uninstalling'`)
+
+* `Uninstalled` (value: `'Uninstalled'`)
+
+* `Deleting` (value: `'Deleting'`)
+
+[[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/DeploymentTask.md

@@ -0,0 +1,48 @@
+# DeploymentTask
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**created_at** | **string** |  | [default to undefined]
+**execute_at** | **string** |  | [default to undefined]
+**first_attempted_at** | **string** |  | [default to undefined]
+**started_at** | **string** |  | [default to undefined]
+**finished_at** | **string** |  | [default to undefined]
+**cluster_id** | **string** |  | [default to undefined]
+**deployment_id** | **string** |  | [default to undefined]
+**acting_user_id** | **string** |  | [default to undefined]
+**acting_deployment_id** | **string** |  | [default to undefined]
+**canceled_by_user_id** | **string** |  | [default to undefined]
+**canceled_by_deployment_id** | **string** |  | [default to undefined]
+**operation** | [**DeploymentTaskOperation**](DeploymentTaskOperation.md) |  | [default to undefined]
+**status** | [**DeploymentTaskStatus**](DeploymentTaskStatus.md) |  | [default to undefined]
+**reason** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeploymentTask } from './api';
+
+const instance: DeploymentTask = {
+    id,
+    created_at,
+    execute_at,
+    first_attempted_at,
+    started_at,
+    finished_at,
+    cluster_id,
+    deployment_id,
+    acting_user_id,
+    acting_deployment_id,
+    canceled_by_user_id,
+    canceled_by_deployment_id,
+    operation,
+    status,
+    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/DeploymentTaskOperation.md

@@ -0,0 +1,32 @@
+# DeploymentTaskOperation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Install** | [**DeploymentInstallTask**](DeploymentInstallTask.md) |  | [default to undefined]
+**Upgrade** | [**DeploymentUpgradeTask**](DeploymentUpgradeTask.md) |  | [default to undefined]
+**Reinstall** | [**DeploymentReinstallTask**](DeploymentReinstallTask.md) |  | [default to undefined]
+**Recreate** | [**DeploymentRecreaseTask**](DeploymentRecreaseTask.md) |  | [default to undefined]
+**Uninstall** | **object** |  | [default to undefined]
+**InvokeAction** | [**DeploymentInvokeActionTask**](DeploymentInvokeActionTask.md) |  | [default to undefined]
+**RestartK8sResource** | [**DeploymentRestartK8sResourceTask**](DeploymentRestartK8sResourceTask.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeploymentTaskOperation } from './api';
+
+const instance: DeploymentTaskOperation = {
+    Install,
+    Upgrade,
+    Reinstall,
+    Recreate,
+    Uninstall,
+    InvokeAction,
+    RestartK8sResource,
+};
+```
+
+[[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/DeploymentTaskOperationOneOf.md

@@ -0,0 +1,20 @@
+# DeploymentTaskOperationOneOf
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Install** | [**DeploymentInstallTask**](DeploymentInstallTask.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeploymentTaskOperationOneOf } from './api';
+
+const instance: DeploymentTaskOperationOneOf = {
+    Install,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)