@platzio/sdk 0.6.0-beta.2 → 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 +678 -5113
  3. package/dist/index.d.ts +678 -5113
  4. package/dist/index.js +521 -411
  5. package/dist/index.mjs +513 -408
  6. package/openapi.yaml +1560 -1515
  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 +917 -5356
  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,34 @@
1
+ # PaginatedHelmRegistryItemsInner
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
+ **domain_name** | **string** | | [default to undefined]
11
+ **repo_name** | **string** | | [default to undefined]
12
+ **kind_id** | **string** | | [default to undefined]
13
+ **available** | **boolean** | | [default to undefined]
14
+ **fa_icon** | **string** | | [default to undefined]
15
+ **provider** | [**HelmRegistryProvider**](HelmRegistryProvider.md) | | [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { PaginatedHelmRegistryItemsInner } from './api';
21
+
22
+ const instance: PaginatedHelmRegistryItemsInner = {
23
+ id,
24
+ created_at,
25
+ domain_name,
26
+ repo_name,
27
+ kind_id,
28
+ available,
29
+ fa_icon,
30
+ provider,
31
+ };
32
+ ```
33
+
34
+ [[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,26 @@
1
+ # PaginatedHelmTagFormat
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **page** | **number** | | [default to undefined]
9
+ **per_page** | **number** | | [default to undefined]
10
+ **items** | [**Array<PaginatedHelmTagFormatItemsInner>**](PaginatedHelmTagFormatItemsInner.md) | | [default to undefined]
11
+ **num_total** | **number** | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { PaginatedHelmTagFormat } from './api';
17
+
18
+ const instance: PaginatedHelmTagFormat = {
19
+ page,
20
+ per_page,
21
+ items,
22
+ num_total,
23
+ };
24
+ ```
25
+
26
+ [[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,24 @@
1
+ # PaginatedHelmTagFormatItemsInner
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
+ **pattern** | **string** | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { PaginatedHelmTagFormatItemsInner } from './api';
16
+
17
+ const instance: PaginatedHelmTagFormatItemsInner = {
18
+ id,
19
+ created_at,
20
+ pattern,
21
+ };
22
+ ```
23
+
24
+ [[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,26 @@
1
+ # PaginatedK8sCluster
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **page** | **number** | | [default to undefined]
9
+ **per_page** | **number** | | [default to undefined]
10
+ **items** | [**Array<PaginatedK8sClusterItemsInner>**](PaginatedK8sClusterItemsInner.md) | | [default to undefined]
11
+ **num_total** | **number** | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { PaginatedK8sCluster } from './api';
17
+
18
+ const instance: PaginatedK8sCluster = {
19
+ page,
20
+ per_page,
21
+ items,
22
+ num_total,
23
+ };
24
+ ```
25
+
26
+ [[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,48 @@
1
+ # PaginatedK8sClusterItemsInner
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **env_id** | **string** | | [default to undefined]
10
+ **provider_id** | **string** | | [default to undefined]
11
+ **created_at** | **string** | | [default to undefined]
12
+ **last_seen_at** | **string** | | [default to undefined]
13
+ **name** | **string** | | [default to undefined]
14
+ **region_name** | **string** | | [default to undefined]
15
+ **is_ok** | **boolean** | | [default to undefined]
16
+ **not_ok_reason** | **string** | | [default to undefined]
17
+ **ignore** | **boolean** | | [default to undefined]
18
+ **ingress_domain** | **string** | | [default to undefined]
19
+ **ingress_class** | **string** | | [default to undefined]
20
+ **ingress_tls_secret_name** | **string** | | [default to undefined]
21
+ **grafana_url** | **string** | | [default to undefined]
22
+ **grafana_datasource_name** | **string** | | [default to undefined]
23
+
24
+ ## Example
25
+
26
+ ```typescript
27
+ import { PaginatedK8sClusterItemsInner } from './api';
28
+
29
+ const instance: PaginatedK8sClusterItemsInner = {
30
+ id,
31
+ env_id,
32
+ provider_id,
33
+ created_at,
34
+ last_seen_at,
35
+ name,
36
+ region_name,
37
+ is_ok,
38
+ not_ok_reason,
39
+ ignore,
40
+ ingress_domain,
41
+ ingress_class,
42
+ ingress_tls_secret_name,
43
+ grafana_url,
44
+ grafana_datasource_name,
45
+ };
46
+ ```
47
+
48
+ [[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,26 @@
1
+ # PaginatedK8sResource
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **page** | **number** | | [default to undefined]
9
+ **per_page** | **number** | | [default to undefined]
10
+ **items** | [**Array<PaginatedK8sResourceItemsInner>**](PaginatedK8sResourceItemsInner.md) | | [default to undefined]
11
+ **num_total** | **number** | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { PaginatedK8sResource } from './api';
17
+
18
+ const instance: PaginatedK8sResource = {
19
+ page,
20
+ per_page,
21
+ items,
22
+ num_total,
23
+ };
24
+ ```
25
+
26
+ [[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,36 @@
1
+ # PaginatedK8sResourceItemsInner
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **last_updated_at** | **string** | | [default to undefined]
10
+ **cluster_id** | **string** | | [default to undefined]
11
+ **deployment_id** | **string** | | [default to undefined]
12
+ **kind** | **string** | | [default to undefined]
13
+ **api_version** | **string** | | [default to undefined]
14
+ **name** | **string** | | [default to undefined]
15
+ **status_color** | **Array<string>** | | [default to undefined]
16
+ **metadata** | **any** | | [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { PaginatedK8sResourceItemsInner } from './api';
22
+
23
+ const instance: PaginatedK8sResourceItemsInner = {
24
+ id,
25
+ last_updated_at,
26
+ cluster_id,
27
+ deployment_id,
28
+ kind,
29
+ api_version,
30
+ name,
31
+ status_color,
32
+ metadata,
33
+ };
34
+ ```
35
+
36
+ [[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,26 @@
1
+ # PaginatedSecret
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **page** | **number** | | [default to undefined]
9
+ **per_page** | **number** | | [default to undefined]
10
+ **items** | [**Array<PaginatedSecretItemsInner>**](PaginatedSecretItemsInner.md) | | [default to undefined]
11
+ **num_total** | **number** | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { PaginatedSecret } from './api';
17
+
18
+ const instance: PaginatedSecret = {
19
+ page,
20
+ per_page,
21
+ items,
22
+ num_total,
23
+ };
24
+ ```
25
+
26
+ [[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,30 @@
1
+ # PaginatedSecretItemsInner
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
+ **updated_at** | **string** | | [default to undefined]
11
+ **env_id** | **string** | | [default to undefined]
12
+ **collection** | **string** | | [default to undefined]
13
+ **name** | **string** | | [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { PaginatedSecretItemsInner } from './api';
19
+
20
+ const instance: PaginatedSecretItemsInner = {
21
+ id,
22
+ created_at,
23
+ updated_at,
24
+ env_id,
25
+ collection,
26
+ name,
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,26 @@
1
+ # PaginatedUser
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **page** | **number** | | [default to undefined]
9
+ **per_page** | **number** | | [default to undefined]
10
+ **items** | [**Array<PaginatedUserItemsInner>**](PaginatedUserItemsInner.md) | | [default to undefined]
11
+ **num_total** | **number** | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { PaginatedUser } from './api';
17
+
18
+ const instance: PaginatedUser = {
19
+ page,
20
+ per_page,
21
+ items,
22
+ num_total,
23
+ };
24
+ ```
25
+
26
+ [[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,30 @@
1
+ # PaginatedUserItemsInner
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
+ **display_name** | **string** | | [default to undefined]
11
+ **email** | **string** | | [default to undefined]
12
+ **is_admin** | **boolean** | | [default to undefined]
13
+ **is_active** | **boolean** | | [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { PaginatedUserItemsInner } from './api';
19
+
20
+ const instance: PaginatedUserItemsInner = {
21
+ id,
22
+ created_at,
23
+ display_name,
24
+ email,
25
+ is_admin,
26
+ is_active,
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,26 @@
1
+ # PaginatedUserToken
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **page** | **number** | | [default to undefined]
9
+ **per_page** | **number** | | [default to undefined]
10
+ **items** | [**Array<PaginatedUserTokenItemsInner>**](PaginatedUserTokenItemsInner.md) | | [default to undefined]
11
+ **num_total** | **number** | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { PaginatedUserToken } from './api';
17
+
18
+ const instance: PaginatedUserToken = {
19
+ page,
20
+ per_page,
21
+ items,
22
+ num_total,
23
+ };
24
+ ```
25
+
26
+ [[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,24 @@
1
+ # PaginatedUserTokenItemsInner
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **user_id** | **string** | | [default to undefined]
10
+ **created_at** | **string** | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { PaginatedUserTokenItemsInner } from './api';
16
+
17
+ const instance: PaginatedUserTokenItemsInner = {
18
+ id,
19
+ user_id,
20
+ created_at,
21
+ };
22
+ ```
23
+
24
+ [[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,30 @@
1
+ # Secret
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
+ **updated_at** | **string** | | [default to undefined]
11
+ **env_id** | **string** | | [default to undefined]
12
+ **collection** | **string** | | [default to undefined]
13
+ **name** | **string** | | [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { Secret } from './api';
19
+
20
+ const instance: Secret = {
21
+ id,
22
+ created_at,
23
+ updated_at,
24
+ env_id,
25
+ collection,
26
+ name,
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,273 @@
1
+ # SecretsApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**allSecrets**](#allsecrets) | **GET** /api/v2/secrets | |
8
+ |[**createSecret**](#createsecret) | **POST** /api/v2/secrets | |
9
+ |[**deleteSecret**](#deletesecret) | **DELETE** /api/v2/secrets/{id} | |
10
+ |[**getSecret**](#getsecret) | **GET** /api/v2/secrets/{id} | |
11
+ |[**updateSecret**](#updatesecret) | **PUT** /api/v2/secrets/{id} | |
12
+
13
+ # **allSecrets**
14
+ > PaginatedSecret allSecrets()
15
+
16
+
17
+ ### Example
18
+
19
+ ```typescript
20
+ import {
21
+ SecretsApi,
22
+ Configuration
23
+ } from './api';
24
+
25
+ const configuration = new Configuration();
26
+ const apiInstance = new SecretsApi(configuration);
27
+
28
+ let envId: string; // (optional) (default to undefined)
29
+ let collection: string; // (optional) (default to undefined)
30
+ let name: string; // (optional) (default to undefined)
31
+
32
+ const { status, data } = await apiInstance.allSecrets(
33
+ envId,
34
+ collection,
35
+ name
36
+ );
37
+ ```
38
+
39
+ ### Parameters
40
+
41
+ |Name | Type | Description | Notes|
42
+ |------------- | ------------- | ------------- | -------------|
43
+ | **envId** | [**string**] | | (optional) defaults to undefined|
44
+ | **collection** | [**string**] | | (optional) defaults to undefined|
45
+ | **name** | [**string**] | | (optional) defaults to undefined|
46
+
47
+
48
+ ### Return type
49
+
50
+ **PaginatedSecret**
51
+
52
+ ### Authorization
53
+
54
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
55
+
56
+ ### HTTP request headers
57
+
58
+ - **Content-Type**: Not defined
59
+ - **Accept**: application/json
60
+
61
+
62
+ ### HTTP response details
63
+ | Status code | Description | Response headers |
64
+ |-------------|-------------|------------------|
65
+ |**200** | | - |
66
+
67
+ [[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)
68
+
69
+ # **createSecret**
70
+ > Secret createSecret(newSecret)
71
+
72
+
73
+ ### Example
74
+
75
+ ```typescript
76
+ import {
77
+ SecretsApi,
78
+ Configuration,
79
+ NewSecret
80
+ } from './api';
81
+
82
+ const configuration = new Configuration();
83
+ const apiInstance = new SecretsApi(configuration);
84
+
85
+ let newSecret: NewSecret; //
86
+
87
+ const { status, data } = await apiInstance.createSecret(
88
+ newSecret
89
+ );
90
+ ```
91
+
92
+ ### Parameters
93
+
94
+ |Name | Type | Description | Notes|
95
+ |------------- | ------------- | ------------- | -------------|
96
+ | **newSecret** | **NewSecret**| | |
97
+
98
+
99
+ ### Return type
100
+
101
+ **Secret**
102
+
103
+ ### Authorization
104
+
105
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
106
+
107
+ ### HTTP request headers
108
+
109
+ - **Content-Type**: application/json
110
+ - **Accept**: application/json
111
+
112
+
113
+ ### HTTP response details
114
+ | Status code | Description | Response headers |
115
+ |-------------|-------------|------------------|
116
+ |**201** | | - |
117
+
118
+ [[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)
119
+
120
+ # **deleteSecret**
121
+ > deleteSecret()
122
+
123
+
124
+ ### Example
125
+
126
+ ```typescript
127
+ import {
128
+ SecretsApi,
129
+ Configuration
130
+ } from './api';
131
+
132
+ const configuration = new Configuration();
133
+ const apiInstance = new SecretsApi(configuration);
134
+
135
+ let id: string; // (default to undefined)
136
+
137
+ const { status, data } = await apiInstance.deleteSecret(
138
+ id
139
+ );
140
+ ```
141
+
142
+ ### Parameters
143
+
144
+ |Name | Type | Description | Notes|
145
+ |------------- | ------------- | ------------- | -------------|
146
+ | **id** | [**string**] | | defaults to undefined|
147
+
148
+
149
+ ### Return type
150
+
151
+ void (empty response body)
152
+
153
+ ### Authorization
154
+
155
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
156
+
157
+ ### HTTP request headers
158
+
159
+ - **Content-Type**: Not defined
160
+ - **Accept**: Not defined
161
+
162
+
163
+ ### HTTP response details
164
+ | Status code | Description | Response headers |
165
+ |-------------|-------------|------------------|
166
+ |**204** | | - |
167
+
168
+ [[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)
169
+
170
+ # **getSecret**
171
+ > Secret getSecret()
172
+
173
+
174
+ ### Example
175
+
176
+ ```typescript
177
+ import {
178
+ SecretsApi,
179
+ Configuration
180
+ } from './api';
181
+
182
+ const configuration = new Configuration();
183
+ const apiInstance = new SecretsApi(configuration);
184
+
185
+ let id: string; // (default to undefined)
186
+
187
+ const { status, data } = await apiInstance.getSecret(
188
+ id
189
+ );
190
+ ```
191
+
192
+ ### Parameters
193
+
194
+ |Name | Type | Description | Notes|
195
+ |------------- | ------------- | ------------- | -------------|
196
+ | **id** | [**string**] | | defaults to undefined|
197
+
198
+
199
+ ### Return type
200
+
201
+ **Secret**
202
+
203
+ ### Authorization
204
+
205
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: Not defined
210
+ - **Accept**: application/json
211
+
212
+
213
+ ### HTTP response details
214
+ | Status code | Description | Response headers |
215
+ |-------------|-------------|------------------|
216
+ |**200** | | - |
217
+
218
+ [[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)
219
+
220
+ # **updateSecret**
221
+ > Secret updateSecret(updateSecret)
222
+
223
+
224
+ ### Example
225
+
226
+ ```typescript
227
+ import {
228
+ SecretsApi,
229
+ Configuration,
230
+ UpdateSecret
231
+ } from './api';
232
+
233
+ const configuration = new Configuration();
234
+ const apiInstance = new SecretsApi(configuration);
235
+
236
+ let id: string; // (default to undefined)
237
+ let updateSecret: UpdateSecret; //
238
+
239
+ const { status, data } = await apiInstance.updateSecret(
240
+ id,
241
+ updateSecret
242
+ );
243
+ ```
244
+
245
+ ### Parameters
246
+
247
+ |Name | Type | Description | Notes|
248
+ |------------- | ------------- | ------------- | -------------|
249
+ | **updateSecret** | **UpdateSecret**| | |
250
+ | **id** | [**string**] | | defaults to undefined|
251
+
252
+
253
+ ### Return type
254
+
255
+ **Secret**
256
+
257
+ ### Authorization
258
+
259
+ [access_token](../README.md#access_token), [user_token](../README.md#user_token)
260
+
261
+ ### HTTP request headers
262
+
263
+ - **Content-Type**: application/json
264
+ - **Accept**: application/json
265
+
266
+
267
+ ### HTTP response details
268
+ | Status code | Description | Response headers |
269
+ |-------------|-------------|------------------|
270
+ |**200** | | - |
271
+
272
+ [[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)
273
+