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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (203) hide show
  1. package/.github/workflows/release.yaml +17 -5
  2. package/dist/index.d.mts +526 -5298
  3. package/dist/index.d.ts +526 -5298
  4. package/dist/index.js +262 -435
  5. package/dist/index.mjs +258 -432
  6. package/openapi.yaml +1461 -1596
  7. package/package.json +3 -3
  8. package/src/.openapi-generator/FILES +190 -0
  9. package/src/.openapi-generator/VERSION +1 -1
  10. package/src/api.ts +565 -5536
  11. package/src/base.ts +0 -24
  12. package/src/common.ts +19 -42
  13. package/src/configuration.ts +32 -21
  14. package/src/docs/AuthenticationApi.md +147 -0
  15. package/src/docs/Bot.md +24 -0
  16. package/src/docs/BotToken.md +26 -0
  17. package/src/docs/BotTokensApi.md +215 -0
  18. package/src/docs/BotsApi.md +164 -0
  19. package/src/docs/ChartExt.md +30 -0
  20. package/src/docs/ChartExtActionEndpoint.md +8 -0
  21. package/src/docs/ChartExtActionMethod.md +16 -0
  22. package/src/docs/ChartExtActionTarget.md +24 -0
  23. package/src/docs/ChartExtActionUserDeploymentRole.md +10 -0
  24. package/src/docs/ChartExtActionV0.md +40 -0
  25. package/src/docs/ChartExtActionV1Beta1.md +24 -0
  26. package/src/docs/ChartExtActions.md +22 -0
  27. package/src/docs/ChartExtActionsV0.md +22 -0
  28. package/src/docs/ChartExtCardinality.md +10 -0
  29. package/src/docs/ChartExtDeploymentDisplay.md +22 -0
  30. package/src/docs/ChartExtDeploymentDisplayIcon.md +20 -0
  31. package/src/docs/ChartExtDeploymentDisplayName.md +20 -0
  32. package/src/docs/ChartExtDeploymentDisplayNameInputField.md +20 -0
  33. package/src/docs/ChartExtDeploymentDisplayNameOneOf.md +20 -0
  34. package/src/docs/ChartExtFeatures.md +36 -0
  35. package/src/docs/ChartExtFeaturesSpec.md +32 -0
  36. package/src/docs/ChartExtFeaturesV0.md +30 -0
  37. package/src/docs/ChartExtFeaturesV1Beta1.md +24 -0
  38. package/src/docs/ChartExtFeaturesV1Beta2.md +24 -0
  39. package/src/docs/ChartExtIngress.md +22 -0
  40. package/src/docs/ChartExtIngressHostnameFormat.md +10 -0
  41. package/src/docs/ChartExtKindAction.md +8 -0
  42. package/src/docs/ChartExtKindFeatures.md +8 -0
  43. package/src/docs/ChartExtKindResourceType.md +8 -0
  44. package/src/docs/ChartExtKindValuesUi.md +8 -0
  45. package/src/docs/ChartExtResourceLifecycleActionV1Beta1.md +22 -0
  46. package/src/docs/ChartExtResourceLifecycleV1Beta1.md +24 -0
  47. package/src/docs/ChartExtResourceTypeV1Beta1.md +26 -0
  48. package/src/docs/ChartExtResourceTypeV1Beta1Spec.md +30 -0
  49. package/src/docs/ChartExtStatusFeature.md +24 -0
  50. package/src/docs/ChartExtVersionV1Beta1.md +8 -0
  51. package/src/docs/ChartExtVersionV1Beta2.md +8 -0
  52. package/src/docs/ChartMetadata.md +28 -0
  53. package/src/docs/CreateBotToken.md +20 -0
  54. package/src/docs/CreateDeploymentTask.md +24 -0
  55. package/src/docs/CreateUserToken.md +20 -0
  56. package/src/docs/CreatedBotToken.md +20 -0
  57. package/src/docs/CreatedUserToken.md +20 -0
  58. package/src/docs/DbEvent.md +24 -0
  59. package/src/docs/DbEventData.md +20 -0
  60. package/src/docs/DbEventOperation.md +12 -0
  61. package/src/docs/DbTable.md +40 -0
  62. package/src/docs/DbTableOrDeploymentResource.md +22 -0
  63. package/src/docs/DbTableOrDeploymentResourceOneOf.md +22 -0
  64. package/src/docs/Deployment.md +46 -0
  65. package/src/docs/DeploymentInstallTask.md +24 -0
  66. package/src/docs/DeploymentInvokeActionTask.md +24 -0
  67. package/src/docs/DeploymentKind.md +24 -0
  68. package/src/docs/DeploymentKindsApi.md +164 -0
  69. package/src/docs/DeploymentPermission.md +30 -0
  70. package/src/docs/DeploymentPermissionsApi.md +212 -0
  71. package/src/docs/DeploymentRecreaseTask.md +26 -0
  72. package/src/docs/DeploymentReinstallTask.md +20 -0
  73. package/src/docs/DeploymentReportedMetric.md +26 -0
  74. package/src/docs/DeploymentReportedNotice.md +22 -0
  75. package/src/docs/DeploymentReportedNoticeLevel.md +12 -0
  76. package/src/docs/DeploymentReportedStatus.md +26 -0
  77. package/src/docs/DeploymentReportedStatusColor.md +16 -0
  78. package/src/docs/DeploymentReportedStatusContent.md +26 -0
  79. package/src/docs/DeploymentReportedStatusSummary.md +22 -0
  80. package/src/docs/DeploymentResource.md +36 -0
  81. package/src/docs/DeploymentResourceSyncStatus.md +16 -0
  82. package/src/docs/DeploymentResourceType.md +30 -0
  83. package/src/docs/DeploymentResourceTypesApi.md +115 -0
  84. package/src/docs/DeploymentResourcesApi.md +267 -0
  85. package/src/docs/DeploymentRestartK8sResourceTask.md +22 -0
  86. package/src/docs/DeploymentStatus.md +24 -0
  87. package/src/docs/DeploymentTask.md +48 -0
  88. package/src/docs/DeploymentTaskOperation.md +32 -0
  89. package/src/docs/DeploymentTaskOperationOneOf.md +20 -0
  90. package/src/docs/DeploymentTaskOperationOneOf1.md +20 -0
  91. package/src/docs/DeploymentTaskOperationOneOf2.md +20 -0
  92. package/src/docs/DeploymentTaskOperationOneOf3.md +20 -0
  93. package/src/docs/DeploymentTaskOperationOneOf4.md +20 -0
  94. package/src/docs/DeploymentTaskOperationOneOf5.md +20 -0
  95. package/src/docs/DeploymentTaskOperationOneOf6.md +20 -0
  96. package/src/docs/DeploymentTaskStatus.md +16 -0
  97. package/src/docs/DeploymentTasksApi.md +164 -0
  98. package/src/docs/DeploymentUpgradeTask.md +28 -0
  99. package/src/docs/DeploymentsApi.md +276 -0
  100. package/src/docs/Env.md +30 -0
  101. package/src/docs/EnvUserPermission.md +28 -0
  102. package/src/docs/EnvUserPermissionsApi.md +212 -0
  103. package/src/docs/EnvUserRole.md +10 -0
  104. package/src/docs/EnvsApi.md +270 -0
  105. package/src/docs/FinishGoogleLoginResponse.md +20 -0
  106. package/src/docs/HelmChart.md +50 -0
  107. package/src/docs/HelmChartsApi.md +112 -0
  108. package/src/docs/HelmRegistriesApi.md +167 -0
  109. package/src/docs/HelmRegistry.md +34 -0
  110. package/src/docs/HelmRegistryProvider.md +10 -0
  111. package/src/docs/HelmTagFormat.md +24 -0
  112. package/src/docs/HelmTagFormatsApi.md +212 -0
  113. package/src/docs/K8sCluster.md +48 -0
  114. package/src/docs/K8sResource.md +36 -0
  115. package/src/docs/KubernetesClustersApi.md +218 -0
  116. package/src/docs/KubernetesResourcesApi.md +118 -0
  117. package/src/docs/MeResponse.md +24 -0
  118. package/src/docs/MeResponseOneOf.md +20 -0
  119. package/src/docs/MeResponseOneOf1.md +20 -0
  120. package/src/docs/MeResponseOneOf2.md +20 -0
  121. package/src/docs/MeResponseOneOf2Deployment.md +22 -0
  122. package/src/docs/NewDeployment.md +30 -0
  123. package/src/docs/NewDeploymentPermission.md +26 -0
  124. package/src/docs/NewDeploymentResource.md +32 -0
  125. package/src/docs/NewEnv.md +22 -0
  126. package/src/docs/NewEnvUserPermission.md +24 -0
  127. package/src/docs/NewHelmTagFormat.md +20 -0
  128. package/src/docs/NewSecret.md +26 -0
  129. package/src/docs/OAuth2Response.md +20 -0
  130. package/src/docs/PaginatedBot.md +26 -0
  131. package/src/docs/PaginatedBotItemsInner.md +24 -0
  132. package/src/docs/PaginatedBotToken.md +26 -0
  133. package/src/docs/PaginatedBotTokenItemsInner.md +26 -0
  134. package/src/docs/PaginatedDeployment.md +26 -0
  135. package/src/docs/PaginatedDeploymentItemsInner.md +46 -0
  136. package/src/docs/PaginatedDeploymentKind.md +26 -0
  137. package/src/docs/PaginatedDeploymentKindItemsInner.md +24 -0
  138. package/src/docs/PaginatedDeploymentPermission.md +26 -0
  139. package/src/docs/PaginatedDeploymentPermissionItemsInner.md +30 -0
  140. package/src/docs/PaginatedDeploymentResource.md +26 -0
  141. package/src/docs/PaginatedDeploymentResourceItemsInner.md +36 -0
  142. package/src/docs/PaginatedDeploymentResourceType.md +26 -0
  143. package/src/docs/PaginatedDeploymentResourceTypeItemsInner.md +30 -0
  144. package/src/docs/PaginatedDeploymentTask.md +26 -0
  145. package/src/docs/PaginatedDeploymentTaskItemsInner.md +48 -0
  146. package/src/docs/PaginatedEnv.md +26 -0
  147. package/src/docs/PaginatedEnvItemsInner.md +30 -0
  148. package/src/docs/PaginatedEnvUserPermission.md +26 -0
  149. package/src/docs/PaginatedEnvUserPermissionItemsInner.md +28 -0
  150. package/src/docs/PaginatedHelmChart.md +26 -0
  151. package/src/docs/PaginatedHelmChartItemsInner.md +50 -0
  152. package/src/docs/PaginatedHelmRegistry.md +26 -0
  153. package/src/docs/PaginatedHelmRegistryItemsInner.md +34 -0
  154. package/src/docs/PaginatedHelmTagFormat.md +26 -0
  155. package/src/docs/PaginatedHelmTagFormatItemsInner.md +24 -0
  156. package/src/docs/PaginatedK8sCluster.md +26 -0
  157. package/src/docs/PaginatedK8sClusterItemsInner.md +48 -0
  158. package/src/docs/PaginatedK8sResource.md +26 -0
  159. package/src/docs/PaginatedK8sResourceItemsInner.md +36 -0
  160. package/src/docs/PaginatedSecret.md +26 -0
  161. package/src/docs/PaginatedSecretItemsInner.md +30 -0
  162. package/src/docs/PaginatedUser.md +26 -0
  163. package/src/docs/PaginatedUserItemsInner.md +30 -0
  164. package/src/docs/PaginatedUserToken.md +26 -0
  165. package/src/docs/PaginatedUserTokenItemsInner.md +24 -0
  166. package/src/docs/Secret.md +30 -0
  167. package/src/docs/SecretsApi.md +273 -0
  168. package/src/docs/SerializedUiSchemaInputType.md +24 -0
  169. package/src/docs/ServerApi.md +51 -0
  170. package/src/docs/ServerInfo.md +20 -0
  171. package/src/docs/StartGoogleLoginResponse.md +20 -0
  172. package/src/docs/UiSchema.md +26 -0
  173. package/src/docs/UiSchemaFieldValuePair.md +22 -0
  174. package/src/docs/UiSchemaInput.md +50 -0
  175. package/src/docs/UiSchemaInputFieldOption.md +24 -0
  176. package/src/docs/UiSchemaInputFieldValue.md +22 -0
  177. package/src/docs/UiSchemaInputRef.md +22 -0
  178. package/src/docs/UiSchemaInputRefField.md +20 -0
  179. package/src/docs/UiSchemaInputRefOneOf.md +20 -0
  180. package/src/docs/UiSchemaInputRefOneOf1.md +20 -0
  181. package/src/docs/UiSchemaInputRefProperty.md +22 -0
  182. package/src/docs/UiSchemaInputSingleType.md +20 -0
  183. package/src/docs/UiSchemaInputSingleTypeOneOf.md +20 -0
  184. package/src/docs/UiSchemaInputSingleTypeOneOfCollectionSelect.md +20 -0
  185. package/src/docs/UiSchemaInputType.md +22 -0
  186. package/src/docs/UiSchemaOutputValue.md +22 -0
  187. package/src/docs/UiSchemaOutputs.md +22 -0
  188. package/src/docs/UiSchemaV0.md +22 -0
  189. package/src/docs/UiSchemaV1Beta1.md +26 -0
  190. package/src/docs/UpdateBot.md +20 -0
  191. package/src/docs/UpdateDeployment.md +32 -0
  192. package/src/docs/UpdateDeploymentKind.md +20 -0
  193. package/src/docs/UpdateDeploymentResource.md +22 -0
  194. package/src/docs/UpdateEnv.md +26 -0
  195. package/src/docs/UpdateHelmRegistry.md +20 -0
  196. package/src/docs/UpdateK8sCluster.md +32 -0
  197. package/src/docs/UpdateSecret.md +22 -0
  198. package/src/docs/UpdateUser.md +22 -0
  199. package/src/docs/User.md +30 -0
  200. package/src/docs/UserDeploymentRole.md +10 -0
  201. package/src/docs/UserToken.md +24 -0
  202. package/src/docs/UserTokensApi.md +212 -0
  203. package/src/docs/UsersApi.md +170 -0
@@ -0,0 +1,20 @@
1
+ # DeploymentTaskOperationOneOf1
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **Upgrade** | [**DeploymentUpgradeTask**](DeploymentUpgradeTask.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { DeploymentTaskOperationOneOf1 } from './api';
14
+
15
+ const instance: DeploymentTaskOperationOneOf1 = {
16
+ Upgrade,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # DeploymentTaskOperationOneOf2
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **Reinstall** | [**DeploymentReinstallTask**](DeploymentReinstallTask.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { DeploymentTaskOperationOneOf2 } from './api';
14
+
15
+ const instance: DeploymentTaskOperationOneOf2 = {
16
+ Reinstall,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # DeploymentTaskOperationOneOf3
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **Recreate** | [**DeploymentRecreaseTask**](DeploymentRecreaseTask.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { DeploymentTaskOperationOneOf3 } from './api';
14
+
15
+ const instance: DeploymentTaskOperationOneOf3 = {
16
+ Recreate,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # DeploymentTaskOperationOneOf4
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **Uninstall** | **object** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { DeploymentTaskOperationOneOf4 } from './api';
14
+
15
+ const instance: DeploymentTaskOperationOneOf4 = {
16
+ Uninstall,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # DeploymentTaskOperationOneOf5
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **InvokeAction** | [**DeploymentInvokeActionTask**](DeploymentInvokeActionTask.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { DeploymentTaskOperationOneOf5 } from './api';
14
+
15
+ const instance: DeploymentTaskOperationOneOf5 = {
16
+ InvokeAction,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # DeploymentTaskOperationOneOf6
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **RestartK8sResource** | [**DeploymentRestartK8sResourceTask**](DeploymentRestartK8sResourceTask.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { DeploymentTaskOperationOneOf6 } from './api';
14
+
15
+ const instance: DeploymentTaskOperationOneOf6 = {
16
+ RestartK8sResource,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,16 @@
1
+ # DeploymentTaskStatus
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Pending` (value: `'Pending'`)
7
+
8
+ * `Started` (value: `'Started'`)
9
+
10
+ * `Failed` (value: `'Failed'`)
11
+
12
+ * `Canceled` (value: `'Canceled'`)
13
+
14
+ * `Done` (value: `'Done'`)
15
+
16
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,164 @@
1
+ # DeploymentTasksApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**allDeploymentTasks**](#alldeploymenttasks) | **GET** /api/v2/deployment-tasks | |
8
+ |[**createDeploymentTask**](#createdeploymenttask) | **POST** /api/v2/deployment-tasks | |
9
+ |[**getDeploymentTask**](#getdeploymenttask) | **GET** /api/v2/deployment-tasks/{id} | |
10
+
11
+ # **allDeploymentTasks**
12
+ > PaginatedDeploymentTask allDeploymentTasks()
13
+
14
+
15
+ ### Example
16
+
17
+ ```typescript
18
+ import {
19
+ DeploymentTasksApi,
20
+ Configuration
21
+ } from './api';
22
+
23
+ const configuration = new Configuration();
24
+ const apiInstance = new DeploymentTasksApi(configuration);
25
+
26
+ let clusterId: string; // (optional) (default to undefined)
27
+ let deploymentId: string; // (optional) (default to undefined)
28
+
29
+ const { status, data } = await apiInstance.allDeploymentTasks(
30
+ clusterId,
31
+ deploymentId
32
+ );
33
+ ```
34
+
35
+ ### Parameters
36
+
37
+ |Name | Type | Description | Notes|
38
+ |------------- | ------------- | ------------- | -------------|
39
+ | **clusterId** | [**string**] | | (optional) defaults to undefined|
40
+ | **deploymentId** | [**string**] | | (optional) defaults to undefined|
41
+
42
+
43
+ ### Return type
44
+
45
+ **PaginatedDeploymentTask**
46
+
47
+ ### Authorization
48
+
49
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
50
+
51
+ ### HTTP request headers
52
+
53
+ - **Content-Type**: Not defined
54
+ - **Accept**: application/json
55
+
56
+
57
+ ### HTTP response details
58
+ | Status code | Description | Response headers |
59
+ |-------------|-------------|------------------|
60
+ |**200** | | - |
61
+
62
+ [[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)
63
+
64
+ # **createDeploymentTask**
65
+ > DeploymentTask createDeploymentTask(createDeploymentTask)
66
+
67
+
68
+ ### Example
69
+
70
+ ```typescript
71
+ import {
72
+ DeploymentTasksApi,
73
+ Configuration,
74
+ CreateDeploymentTask
75
+ } from './api';
76
+
77
+ const configuration = new Configuration();
78
+ const apiInstance = new DeploymentTasksApi(configuration);
79
+
80
+ let createDeploymentTask: CreateDeploymentTask; //
81
+
82
+ const { status, data } = await apiInstance.createDeploymentTask(
83
+ createDeploymentTask
84
+ );
85
+ ```
86
+
87
+ ### Parameters
88
+
89
+ |Name | Type | Description | Notes|
90
+ |------------- | ------------- | ------------- | -------------|
91
+ | **createDeploymentTask** | **CreateDeploymentTask**| | |
92
+
93
+
94
+ ### Return type
95
+
96
+ **DeploymentTask**
97
+
98
+ ### Authorization
99
+
100
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
101
+
102
+ ### HTTP request headers
103
+
104
+ - **Content-Type**: application/json
105
+ - **Accept**: application/json
106
+
107
+
108
+ ### HTTP response details
109
+ | Status code | Description | Response headers |
110
+ |-------------|-------------|------------------|
111
+ |**201** | | - |
112
+
113
+ [[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)
114
+
115
+ # **getDeploymentTask**
116
+ > DeploymentTask getDeploymentTask()
117
+
118
+
119
+ ### Example
120
+
121
+ ```typescript
122
+ import {
123
+ DeploymentTasksApi,
124
+ Configuration
125
+ } from './api';
126
+
127
+ const configuration = new Configuration();
128
+ const apiInstance = new DeploymentTasksApi(configuration);
129
+
130
+ let id: string; // (default to undefined)
131
+
132
+ const { status, data } = await apiInstance.getDeploymentTask(
133
+ id
134
+ );
135
+ ```
136
+
137
+ ### Parameters
138
+
139
+ |Name | Type | Description | Notes|
140
+ |------------- | ------------- | ------------- | -------------|
141
+ | **id** | [**string**] | | defaults to undefined|
142
+
143
+
144
+ ### Return type
145
+
146
+ **DeploymentTask**
147
+
148
+ ### Authorization
149
+
150
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
151
+
152
+ ### HTTP request headers
153
+
154
+ - **Content-Type**: Not defined
155
+ - **Accept**: application/json
156
+
157
+
158
+ ### HTTP response details
159
+ | Status code | Description | Response headers |
160
+ |-------------|-------------|------------------|
161
+ |**200** | | - |
162
+
163
+ [[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)
164
+
@@ -0,0 +1,28 @@
1
+ # DeploymentUpgradeTask
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **helm_chart_id** | **string** | | [default to undefined]
9
+ **prev_helm_chart_id** | **string** | | [default to undefined]
10
+ **config_inputs** | **any** | | [default to undefined]
11
+ **config_delta** | **{ [key: string]: Array<any>; }** | | [default to undefined]
12
+ **values_override** | **any** | | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { DeploymentUpgradeTask } from './api';
18
+
19
+ const instance: DeploymentUpgradeTask = {
20
+ helm_chart_id,
21
+ prev_helm_chart_id,
22
+ config_inputs,
23
+ config_delta,
24
+ values_override,
25
+ };
26
+ ```
27
+
28
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,276 @@
1
+ # DeploymentsApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**allDeployments**](#alldeployments) | **GET** /api/v2/deployments | |
8
+ |[**createDeployment**](#createdeployment) | **POST** /api/v2/deployments | |
9
+ |[**deleteDeployment**](#deletedeployment) | **DELETE** /api/v2/deployments/{id} | |
10
+ |[**getDeployment**](#getdeployment) | **GET** /api/v2/deployments/{id} | |
11
+ |[**updateDeployment**](#updatedeployment) | **PUT** /api/v2/deployments/{id} | |
12
+
13
+ # **allDeployments**
14
+ > PaginatedDeployment allDeployments()
15
+
16
+
17
+ ### Example
18
+
19
+ ```typescript
20
+ import {
21
+ DeploymentsApi,
22
+ Configuration
23
+ } from './api';
24
+
25
+ const configuration = new Configuration();
26
+ const apiInstance = new DeploymentsApi(configuration);
27
+
28
+ let name: string; // (optional) (default to undefined)
29
+ let kindId: string; // (optional) (default to undefined)
30
+ let clusterId: string; // (optional) (default to undefined)
31
+ let enabled: boolean; // (optional) (default to undefined)
32
+
33
+ const { status, data } = await apiInstance.allDeployments(
34
+ name,
35
+ kindId,
36
+ clusterId,
37
+ enabled
38
+ );
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+ |Name | Type | Description | Notes|
44
+ |------------- | ------------- | ------------- | -------------|
45
+ | **name** | [**string**] | | (optional) defaults to undefined|
46
+ | **kindId** | [**string**] | | (optional) defaults to undefined|
47
+ | **clusterId** | [**string**] | | (optional) defaults to undefined|
48
+ | **enabled** | [**boolean**] | | (optional) defaults to undefined|
49
+
50
+
51
+ ### Return type
52
+
53
+ **PaginatedDeployment**
54
+
55
+ ### Authorization
56
+
57
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
58
+
59
+ ### HTTP request headers
60
+
61
+ - **Content-Type**: Not defined
62
+ - **Accept**: application/json
63
+
64
+
65
+ ### HTTP response details
66
+ | Status code | Description | Response headers |
67
+ |-------------|-------------|------------------|
68
+ |**200** | | - |
69
+
70
+ [[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)
71
+
72
+ # **createDeployment**
73
+ > Deployment createDeployment(newDeployment)
74
+
75
+
76
+ ### Example
77
+
78
+ ```typescript
79
+ import {
80
+ DeploymentsApi,
81
+ Configuration,
82
+ NewDeployment
83
+ } from './api';
84
+
85
+ const configuration = new Configuration();
86
+ const apiInstance = new DeploymentsApi(configuration);
87
+
88
+ let newDeployment: NewDeployment; //
89
+
90
+ const { status, data } = await apiInstance.createDeployment(
91
+ newDeployment
92
+ );
93
+ ```
94
+
95
+ ### Parameters
96
+
97
+ |Name | Type | Description | Notes|
98
+ |------------- | ------------- | ------------- | -------------|
99
+ | **newDeployment** | **NewDeployment**| | |
100
+
101
+
102
+ ### Return type
103
+
104
+ **Deployment**
105
+
106
+ ### Authorization
107
+
108
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
109
+
110
+ ### HTTP request headers
111
+
112
+ - **Content-Type**: application/json
113
+ - **Accept**: application/json
114
+
115
+
116
+ ### HTTP response details
117
+ | Status code | Description | Response headers |
118
+ |-------------|-------------|------------------|
119
+ |**201** | | - |
120
+
121
+ [[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)
122
+
123
+ # **deleteDeployment**
124
+ > deleteDeployment()
125
+
126
+
127
+ ### Example
128
+
129
+ ```typescript
130
+ import {
131
+ DeploymentsApi,
132
+ Configuration
133
+ } from './api';
134
+
135
+ const configuration = new Configuration();
136
+ const apiInstance = new DeploymentsApi(configuration);
137
+
138
+ let id: string; // (default to undefined)
139
+
140
+ const { status, data } = await apiInstance.deleteDeployment(
141
+ id
142
+ );
143
+ ```
144
+
145
+ ### Parameters
146
+
147
+ |Name | Type | Description | Notes|
148
+ |------------- | ------------- | ------------- | -------------|
149
+ | **id** | [**string**] | | defaults to undefined|
150
+
151
+
152
+ ### Return type
153
+
154
+ void (empty response body)
155
+
156
+ ### Authorization
157
+
158
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
159
+
160
+ ### HTTP request headers
161
+
162
+ - **Content-Type**: Not defined
163
+ - **Accept**: Not defined
164
+
165
+
166
+ ### HTTP response details
167
+ | Status code | Description | Response headers |
168
+ |-------------|-------------|------------------|
169
+ |**204** | | - |
170
+
171
+ [[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)
172
+
173
+ # **getDeployment**
174
+ > Deployment getDeployment()
175
+
176
+
177
+ ### Example
178
+
179
+ ```typescript
180
+ import {
181
+ DeploymentsApi,
182
+ Configuration
183
+ } from './api';
184
+
185
+ const configuration = new Configuration();
186
+ const apiInstance = new DeploymentsApi(configuration);
187
+
188
+ let id: string; // (default to undefined)
189
+
190
+ const { status, data } = await apiInstance.getDeployment(
191
+ id
192
+ );
193
+ ```
194
+
195
+ ### Parameters
196
+
197
+ |Name | Type | Description | Notes|
198
+ |------------- | ------------- | ------------- | -------------|
199
+ | **id** | [**string**] | | defaults to undefined|
200
+
201
+
202
+ ### Return type
203
+
204
+ **Deployment**
205
+
206
+ ### Authorization
207
+
208
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
209
+
210
+ ### HTTP request headers
211
+
212
+ - **Content-Type**: Not defined
213
+ - **Accept**: application/json
214
+
215
+
216
+ ### HTTP response details
217
+ | Status code | Description | Response headers |
218
+ |-------------|-------------|------------------|
219
+ |**200** | | - |
220
+
221
+ [[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)
222
+
223
+ # **updateDeployment**
224
+ > Deployment updateDeployment(updateDeployment)
225
+
226
+
227
+ ### Example
228
+
229
+ ```typescript
230
+ import {
231
+ DeploymentsApi,
232
+ Configuration,
233
+ UpdateDeployment
234
+ } from './api';
235
+
236
+ const configuration = new Configuration();
237
+ const apiInstance = new DeploymentsApi(configuration);
238
+
239
+ let id: string; // (default to undefined)
240
+ let updateDeployment: UpdateDeployment; //
241
+
242
+ const { status, data } = await apiInstance.updateDeployment(
243
+ id,
244
+ updateDeployment
245
+ );
246
+ ```
247
+
248
+ ### Parameters
249
+
250
+ |Name | Type | Description | Notes|
251
+ |------------- | ------------- | ------------- | -------------|
252
+ | **updateDeployment** | **UpdateDeployment**| | |
253
+ | **id** | [**string**] | | defaults to undefined|
254
+
255
+
256
+ ### Return type
257
+
258
+ **Deployment**
259
+
260
+ ### Authorization
261
+
262
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
263
+
264
+ ### HTTP request headers
265
+
266
+ - **Content-Type**: application/json
267
+ - **Accept**: application/json
268
+
269
+
270
+ ### HTTP response details
271
+ | Status code | Description | Response headers |
272
+ |-------------|-------------|------------------|
273
+ |**200** | | - |
274
+
275
+ [[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)
276
+
@@ -0,0 +1,30 @@
1
+ # Env
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **created_at** | **string** | | [default to undefined]
10
+ **name** | **string** | | [default to undefined]
11
+ **node_selector** | **any** | | [default to undefined]
12
+ **tolerations** | **any** | | [default to undefined]
13
+ **auto_add_new_users** | **boolean** | | [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { Env } from './api';
19
+
20
+ const instance: Env = {
21
+ id,
22
+ created_at,
23
+ name,
24
+ node_selector,
25
+ tolerations,
26
+ auto_add_new_users,
27
+ };
28
+ ```
29
+
30
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,28 @@
1
+ # EnvUserPermission
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **created_at** | **string** | | [default to undefined]
10
+ **env_id** | **string** | | [default to undefined]
11
+ **user_id** | **string** | | [default to undefined]
12
+ **role** | [**EnvUserRole**](EnvUserRole.md) | | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { EnvUserPermission } from './api';
18
+
19
+ const instance: EnvUserPermission = {
20
+ id,
21
+ created_at,
22
+ env_id,
23
+ user_id,
24
+ role,
25
+ };
26
+ ```
27
+
28
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)