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

package/src/docs/BotTokensApi.md

@@ -0,0 +1,215 @@
+# BotTokensApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**allBotTokens**](#allbottokens) | **GET** /api/v2/bot-tokens | |
+|[**createBotToken**](#createbottoken) | **POST** /api/v2/bot-tokens | |
+|[**deleteBotToken**](#deletebottoken) | **DELETE** /api/v2/bot-tokens/{id} | |
+|[**getBotToken**](#getbottoken) | **GET** /api/v2/bot-tokens/{id} | |
+
+# **allBotTokens**
+> PaginatedBotToken allBotTokens()
+
+
+### Example
+
+```typescript
+import {
+    BotTokensApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BotTokensApi(configuration);
+
+let botId: string; // (optional) (default to undefined)
+let createdByUserId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.allBotTokens(
+    botId,
+    createdByUserId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **botId** | [**string**] |  | (optional) defaults to undefined|
+| **createdByUserId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedBotToken**
+
+### Authorization
+
+[access_token](../README.md#access_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)
+
+# **createBotToken**
+> CreatedBotToken createBotToken(createBotToken)
+
+
+### Example
+
+```typescript
+import {
+    BotTokensApi,
+    Configuration,
+    CreateBotToken
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BotTokensApi(configuration);
+
+let createBotToken: CreateBotToken; //
+
+const { status, data } = await apiInstance.createBotToken(
+    createBotToken
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createBotToken** | **CreateBotToken**|  | |
+
+
+### Return type
+
+**CreatedBotToken**
+
+### Authorization
+
+[access_token](../README.md#access_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)
+
+# **deleteBotToken**
+> deleteBotToken()
+
+
+### Example
+
+```typescript
+import {
+    BotTokensApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BotTokensApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteBotToken(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[access_token](../README.md#access_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)
+
+# **getBotToken**
+> BotToken getBotToken()
+
+
+### Example
+
+```typescript
+import {
+    BotTokensApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BotTokensApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getBotToken(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BotToken**
+
+### Authorization
+
+[access_token](../README.md#access_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/BotsApi.md

@@ -0,0 +1,164 @@
+# BotsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**allBots**](#allbots) | **GET** /api/v2/bots | |
+|[**getBot**](#getbot) | **GET** /api/v2/bots/{id} | |
+|[**updateBot**](#updatebot) | **PUT** /api/v2/bots/{id} | |
+
+# **allBots**
+> PaginatedBot allBots()
+
+
+### Example
+
+```typescript
+import {
+    BotsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BotsApi(configuration);
+
+let displayName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.allBots(
+    displayName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **displayName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedBot**
+
+### 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)
+
+# **getBot**
+> Bot getBot()
+
+
+### Example
+
+```typescript
+import {
+    BotsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BotsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getBot(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Bot**
+
+### 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)
+
+# **updateBot**
+> Bot updateBot(updateBot)
+
+
+### Example
+
+```typescript
+import {
+    BotsApi,
+    Configuration,
+    UpdateBot
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BotsApi(configuration);
+
+let id: string; // (default to undefined)
+let updateBot: UpdateBot; //
+
+const { status, data } = await apiInstance.updateBot(
+    id,
+    updateBot
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateBot** | **UpdateBot**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Bot**
+
+### 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/ChartExt.md

@@ -0,0 +1,30 @@
+# ChartExt
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | [**ChartMetadata**](ChartMetadata.md) |  | [optional] [default to undefined]
+**ui_schema** | [**UiSchema**](UiSchema.md) |  | [optional] [default to undefined]
+**actions** | [**ChartExtActions**](ChartExtActions.md) |  | [optional] [default to undefined]
+**features** | [**ChartExtFeatures**](ChartExtFeatures.md) |  | [optional] [default to undefined]
+**resource_types** | [**Array<ChartExtResourceTypeV1Beta1>**](ChartExtResourceTypeV1Beta1.md) |  | [optional] [default to undefined]
+**error** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ChartExt } from './api';
+
+const instance: ChartExt = {
+    metadata,
+    ui_schema,
+    actions,
+    features,
+    resource_types,
+    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/ChartExtActionEndpoint.md

@@ -0,0 +1,8 @@
+# ChartExtActionEndpoint
+
+
+## Enum
+
+* `StandardIngress` (value: `'standard_ingress'`)
+
+[[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/ChartExtActionMethod.md

@@ -0,0 +1,16 @@
+# ChartExtActionMethod
+
+
+## Enum
+
+* `Get` (value: `'GET'`)
+
+* `Post` (value: `'POST'`)
+
+* `Put` (value: `'PUT'`)
+
+* `Patch` (value: `'PATCH'`)
+
+* `Delete` (value: `'DELETE'`)
+
+[[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/ChartExtActionTarget.md

@@ -0,0 +1,24 @@
+# ChartExtActionTarget
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**endpoint** | [**ChartExtActionEndpoint**](ChartExtActionEndpoint.md) |  | [default to undefined]
+**path** | **string** |  | [default to undefined]
+**method** | [**ChartExtActionMethod**](ChartExtActionMethod.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ChartExtActionTarget } from './api';
+
+const instance: ChartExtActionTarget = {
+    endpoint,
+    path,
+    method,
+};
+```
+
+[[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/ChartExtActionUserDeploymentRole.md

@@ -0,0 +1,10 @@
+# ChartExtActionUserDeploymentRole
+
+
+## Enum
+
+* `Owner` (value: `'Owner'`)
+
+* `Maintainer` (value: `'Maintainer'`)
+
+[[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/ChartExtActionV0.md

@@ -0,0 +1,40 @@
+# ChartExtActionV0
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**endpoint** | [**ChartExtActionEndpoint**](ChartExtActionEndpoint.md) |  | [default to undefined]
+**path** | **string** |  | [default to undefined]
+**method** | [**ChartExtActionMethod**](ChartExtActionMethod.md) |  | [default to undefined]
+**id** | **string** |  | [default to undefined]
+**allowed_role** | [**ChartExtActionUserDeploymentRole**](ChartExtActionUserDeploymentRole.md) |  | [default to undefined]
+**allowed_on_statuses** | **Array<string>** |  | [optional] [default to undefined]
+**title** | **string** |  | [default to undefined]
+**fontawesome_icon** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [default to undefined]
+**dangerous** | **boolean** |  | [optional] [default to undefined]
+**ui_schema** | [**UiSchema**](UiSchema.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ChartExtActionV0 } from './api';
+
+const instance: ChartExtActionV0 = {
+    endpoint,
+    path,
+    method,
+    id,
+    allowed_role,
+    allowed_on_statuses,
+    title,
+    fontawesome_icon,
+    description,
+    dangerous,
+    ui_schema,
+};
+```
+
+[[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/ChartExtActionV1Beta1.md

@@ -0,0 +1,24 @@
+# ChartExtActionV1Beta1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**apiVersion** | [**ChartExtVersionV1Beta1**](ChartExtVersionV1Beta1.md) |  | [default to undefined]
+**kind** | [**ChartExtKindAction**](ChartExtKindAction.md) |  | [default to undefined]
+**spec** | [**ChartExtActionV0**](ChartExtActionV0.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ChartExtActionV1Beta1 } from './api';
+
+const instance: ChartExtActionV1Beta1 = {
+    apiVersion,
+    kind,
+    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/ChartExtActions.md

@@ -0,0 +1,22 @@
+# ChartExtActions
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schema_version** | **number** |  | [default to undefined]
+**actions** | [**Array<ChartExtActionV0>**](ChartExtActionV0.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ChartExtActions } from './api';
+
+const instance: ChartExtActions = {
+    schema_version,
+    actions,
+};
+```
+
+[[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/ChartExtActionsV0.md

@@ -0,0 +1,22 @@
+# ChartExtActionsV0
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schema_version** | **number** |  | [default to undefined]
+**actions** | [**Array<ChartExtActionV0>**](ChartExtActionV0.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ChartExtActionsV0 } from './api';
+
+const instance: ChartExtActionsV0 = {
+    schema_version,
+    actions,
+};
+```
+
+[[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/ChartExtCardinality.md

@@ -0,0 +1,10 @@
+# ChartExtCardinality
+
+
+## Enum
+
+* `Many` (value: `'Many'`)
+
+* `OnePerCluster` (value: `'OnePerCluster'`)
+
+[[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/ChartExtDeploymentDisplay.md

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

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

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

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