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

package/src/docs/HelmRegistriesApi.md

@@ -0,0 +1,167 @@
+# HelmRegistriesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**allHelmRegistries**](#allhelmregistries) | **GET** /api/v2/helm-registries | |
+|[**getHelmRegistry**](#gethelmregistry) | **GET** /api/v2/helm-registries/{id} | |
+|[**updateHelmRegistry**](#updatehelmregistry) | **PUT** /api/v2/helm-registries/{id} | |
+
+# **allHelmRegistries**
+> PaginatedHelmRegistry allHelmRegistries()
+
+
+### Example
+
+```typescript
+import {
+    HelmRegistriesApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new HelmRegistriesApi(configuration);
+
+let repoName: string; // (optional) (default to undefined)
+let kindId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.allHelmRegistries(
+    repoName,
+    kindId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **repoName** | [**string**] |  | (optional) defaults to undefined|
+| **kindId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedHelmRegistry**
+
+### 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)
+
+# **getHelmRegistry**
+> HelmRegistry getHelmRegistry()
+
+
+### Example
+
+```typescript
+import {
+    HelmRegistriesApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new HelmRegistriesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getHelmRegistry(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**HelmRegistry**
+
+### 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)
+
+# **updateHelmRegistry**
+> HelmRegistry updateHelmRegistry(updateHelmRegistry)
+
+
+### Example
+
+```typescript
+import {
+    HelmRegistriesApi,
+    Configuration,
+    UpdateHelmRegistry
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new HelmRegistriesApi(configuration);
+
+let id: string; // (default to undefined)
+let updateHelmRegistry: UpdateHelmRegistry; //
+
+const { status, data } = await apiInstance.updateHelmRegistry(
+    id,
+    updateHelmRegistry
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateHelmRegistry** | **UpdateHelmRegistry**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**HelmRegistry**
+
+### 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/HelmRegistry.md

@@ -0,0 +1,34 @@
+# HelmRegistry
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**created_at** | **string** |  | [default to undefined]
+**domain_name** | **string** |  | [default to undefined]
+**repo_name** | **string** |  | [default to undefined]
+**kind_id** | **string** |  | [default to undefined]
+**available** | **boolean** |  | [default to undefined]
+**fa_icon** | **string** |  | [default to undefined]
+**provider** | [**HelmRegistryProvider**](HelmRegistryProvider.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { HelmRegistry } from './api';
+
+const instance: HelmRegistry = {
+    id,
+    created_at,
+    domain_name,
+    repo_name,
+    kind_id,
+    available,
+    fa_icon,
+    provider,
+};
+```
+
+[[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/HelmRegistryProvider.md

@@ -0,0 +1,10 @@
+# HelmRegistryProvider
+
+
+## Enum
+
+* `Ecr` (value: `'Ecr'`)
+
+* `Oci` (value: `'Oci'`)
+
+[[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/HelmTagFormat.md

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

@@ -0,0 +1,212 @@
+# HelmTagFormatsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**allHelmTagFormats**](#allhelmtagformats) | **GET** /api/v2/helm-tag-formats | |
+|[**createHelmTagFormat**](#createhelmtagformat) | **POST** /api/v2/helm-tag-formats | |
+|[**deleteHelmTagFormat**](#deletehelmtagformat) | **DELETE** /api/v2/helm-tag-formats/{id} | |
+|[**getHelmTagFormat**](#gethelmtagformat) | **GET** /api/v2/helm-tag-formats/{id} | |
+
+# **allHelmTagFormats**
+> PaginatedHelmTagFormat allHelmTagFormats()
+
+
+### Example
+
+```typescript
+import {
+    HelmTagFormatsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new HelmTagFormatsApi(configuration);
+
+let pattern: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.allHelmTagFormats(
+    pattern
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pattern** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedHelmTagFormat**
+
+### 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)
+
+# **createHelmTagFormat**
+> HelmTagFormat createHelmTagFormat(newHelmTagFormat)
+
+
+### Example
+
+```typescript
+import {
+    HelmTagFormatsApi,
+    Configuration,
+    NewHelmTagFormat
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new HelmTagFormatsApi(configuration);
+
+let newHelmTagFormat: NewHelmTagFormat; //
+
+const { status, data } = await apiInstance.createHelmTagFormat(
+    newHelmTagFormat
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **newHelmTagFormat** | **NewHelmTagFormat**|  | |
+
+
+### Return type
+
+**HelmTagFormat**
+
+### 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)
+
+# **deleteHelmTagFormat**
+> deleteHelmTagFormat()
+
+
+### Example
+
+```typescript
+import {
+    HelmTagFormatsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new HelmTagFormatsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteHelmTagFormat(
+    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)
+
+# **getHelmTagFormat**
+> HelmTagFormat getHelmTagFormat()
+
+
+### Example
+
+```typescript
+import {
+    HelmTagFormatsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new HelmTagFormatsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getHelmTagFormat(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**HelmTagFormat**
+
+### 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/K8sCluster.md

@@ -0,0 +1,48 @@
+# K8sCluster
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**env_id** | **string** |  | [default to undefined]
+**provider_id** | **string** |  | [default to undefined]
+**created_at** | **string** |  | [default to undefined]
+**last_seen_at** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**region_name** | **string** |  | [default to undefined]
+**is_ok** | **boolean** |  | [default to undefined]
+**not_ok_reason** | **string** |  | [default to undefined]
+**ignore** | **boolean** |  | [default to undefined]
+**ingress_domain** | **string** |  | [default to undefined]
+**ingress_class** | **string** |  | [default to undefined]
+**ingress_tls_secret_name** | **string** |  | [default to undefined]
+**grafana_url** | **string** |  | [default to undefined]
+**grafana_datasource_name** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { K8sCluster } from './api';
+
+const instance: K8sCluster = {
+    id,
+    env_id,
+    provider_id,
+    created_at,
+    last_seen_at,
+    name,
+    region_name,
+    is_ok,
+    not_ok_reason,
+    ignore,
+    ingress_domain,
+    ingress_class,
+    ingress_tls_secret_name,
+    grafana_url,
+    grafana_datasource_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/K8sResource.md

@@ -0,0 +1,36 @@
+# K8sResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**last_updated_at** | **string** |  | [default to undefined]
+**cluster_id** | **string** |  | [default to undefined]
+**deployment_id** | **string** |  | [default to undefined]
+**kind** | **string** |  | [default to undefined]
+**api_version** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**status_color** | **Array<string>** |  | [default to undefined]
+**metadata** | **any** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { K8sResource } from './api';
+
+const instance: K8sResource = {
+    id,
+    last_updated_at,
+    cluster_id,
+    deployment_id,
+    kind,
+    api_version,
+    name,
+    status_color,
+    metadata,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)