@platzio/sdk 0.6.0-beta.3 → 0.7.0-beta.2
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.
- package/.github/workflows/release.yaml +17 -5
- package/AGENTS.md +9 -0
- package/dist/index.d.mts +586 -5347
- package/dist/index.d.ts +586 -5347
- package/dist/index.js +262 -435
- package/dist/index.mjs +258 -432
- package/openapi.yaml +1461 -1596
- package/package.json +3 -3
- package/src/.openapi-generator/FILES +190 -0
- package/src/.openapi-generator/VERSION +1 -1
- package/src/api.ts +565 -5536
- package/src/base.ts +0 -24
- package/src/common.ts +19 -42
- package/src/configuration.ts +32 -21
- package/src/docs/AuthenticationApi.md +147 -0
- package/src/docs/Bot.md +24 -0
- package/src/docs/BotToken.md +26 -0
- package/src/docs/BotTokensApi.md +215 -0
- package/src/docs/BotsApi.md +164 -0
- package/src/docs/ChartExt.md +30 -0
- package/src/docs/ChartExtActionEndpoint.md +8 -0
- package/src/docs/ChartExtActionMethod.md +16 -0
- package/src/docs/ChartExtActionTarget.md +24 -0
- package/src/docs/ChartExtActionUserDeploymentRole.md +10 -0
- package/src/docs/ChartExtActionV0.md +40 -0
- package/src/docs/ChartExtActionV1Beta1.md +24 -0
- package/src/docs/ChartExtActions.md +22 -0
- package/src/docs/ChartExtActionsV0.md +22 -0
- package/src/docs/ChartExtCardinality.md +10 -0
- package/src/docs/ChartExtDeploymentDisplay.md +22 -0
- package/src/docs/ChartExtDeploymentDisplayIcon.md +20 -0
- package/src/docs/ChartExtDeploymentDisplayName.md +20 -0
- package/src/docs/ChartExtDeploymentDisplayNameInputField.md +20 -0
- package/src/docs/ChartExtDeploymentDisplayNameOneOf.md +20 -0
- package/src/docs/ChartExtFeatures.md +36 -0
- package/src/docs/ChartExtFeaturesSpec.md +32 -0
- package/src/docs/ChartExtFeaturesV0.md +30 -0
- package/src/docs/ChartExtFeaturesV1Beta1.md +24 -0
- package/src/docs/ChartExtFeaturesV1Beta2.md +24 -0
- package/src/docs/ChartExtIngress.md +22 -0
- package/src/docs/ChartExtIngressHostnameFormat.md +10 -0
- package/src/docs/ChartExtKindAction.md +8 -0
- package/src/docs/ChartExtKindFeatures.md +8 -0
- package/src/docs/ChartExtKindResourceType.md +8 -0
- package/src/docs/ChartExtKindValuesUi.md +8 -0
- package/src/docs/ChartExtResourceLifecycleActionV1Beta1.md +22 -0
- package/src/docs/ChartExtResourceLifecycleV1Beta1.md +24 -0
- package/src/docs/ChartExtResourceTypeV1Beta1.md +26 -0
- package/src/docs/ChartExtResourceTypeV1Beta1Spec.md +30 -0
- package/src/docs/ChartExtStatusFeature.md +24 -0
- package/src/docs/ChartExtVersionV1Beta1.md +8 -0
- package/src/docs/ChartExtVersionV1Beta2.md +8 -0
- package/src/docs/ChartMetadata.md +28 -0
- package/src/docs/CreateBotToken.md +20 -0
- package/src/docs/CreateDeploymentTask.md +24 -0
- package/src/docs/CreateUserToken.md +20 -0
- package/src/docs/CreatedBotToken.md +20 -0
- package/src/docs/CreatedUserToken.md +20 -0
- package/src/docs/DbEvent.md +24 -0
- package/src/docs/DbEventData.md +20 -0
- package/src/docs/DbEventOperation.md +12 -0
- package/src/docs/DbTable.md +40 -0
- package/src/docs/DbTableOrDeploymentResource.md +22 -0
- package/src/docs/DbTableOrDeploymentResourceOneOf.md +22 -0
- package/src/docs/Deployment.md +46 -0
- package/src/docs/DeploymentInstallTask.md +24 -0
- package/src/docs/DeploymentInvokeActionTask.md +24 -0
- package/src/docs/DeploymentKind.md +24 -0
- package/src/docs/DeploymentKindsApi.md +164 -0
- package/src/docs/DeploymentPermission.md +30 -0
- package/src/docs/DeploymentPermissionsApi.md +212 -0
- package/src/docs/DeploymentRecreaseTask.md +26 -0
- package/src/docs/DeploymentReinstallTask.md +20 -0
- package/src/docs/DeploymentReportedMetric.md +26 -0
- package/src/docs/DeploymentReportedNotice.md +22 -0
- package/src/docs/DeploymentReportedNoticeLevel.md +12 -0
- package/src/docs/DeploymentReportedStatus.md +26 -0
- package/src/docs/DeploymentReportedStatusColor.md +16 -0
- package/src/docs/DeploymentReportedStatusContent.md +26 -0
- package/src/docs/DeploymentReportedStatusSummary.md +22 -0
- package/src/docs/DeploymentResource.md +36 -0
- package/src/docs/DeploymentResourceSyncStatus.md +16 -0
- package/src/docs/DeploymentResourceType.md +30 -0
- package/src/docs/DeploymentResourceTypesApi.md +115 -0
- package/src/docs/DeploymentResourcesApi.md +267 -0
- package/src/docs/DeploymentRestartK8sResourceTask.md +22 -0
- package/src/docs/DeploymentStatus.md +24 -0
- package/src/docs/DeploymentTask.md +48 -0
- package/src/docs/DeploymentTaskOperation.md +32 -0
- package/src/docs/DeploymentTaskOperationOneOf.md +20 -0
- package/src/docs/DeploymentTaskOperationOneOf1.md +20 -0
- package/src/docs/DeploymentTaskOperationOneOf2.md +20 -0
- package/src/docs/DeploymentTaskOperationOneOf3.md +20 -0
- package/src/docs/DeploymentTaskOperationOneOf4.md +20 -0
- package/src/docs/DeploymentTaskOperationOneOf5.md +20 -0
- package/src/docs/DeploymentTaskOperationOneOf6.md +20 -0
- package/src/docs/DeploymentTaskStatus.md +16 -0
- package/src/docs/DeploymentTasksApi.md +164 -0
- package/src/docs/DeploymentUpgradeTask.md +28 -0
- package/src/docs/DeploymentsApi.md +276 -0
- package/src/docs/Env.md +30 -0
- package/src/docs/EnvUserPermission.md +28 -0
- package/src/docs/EnvUserPermissionsApi.md +212 -0
- package/src/docs/EnvUserRole.md +10 -0
- package/src/docs/EnvsApi.md +270 -0
- package/src/docs/FinishGoogleLoginResponse.md +20 -0
- package/src/docs/HelmChart.md +50 -0
- package/src/docs/HelmChartsApi.md +112 -0
- package/src/docs/HelmRegistriesApi.md +167 -0
- package/src/docs/HelmRegistry.md +34 -0
- package/src/docs/HelmRegistryProvider.md +10 -0
- package/src/docs/HelmTagFormat.md +24 -0
- package/src/docs/HelmTagFormatsApi.md +212 -0
- package/src/docs/K8sCluster.md +48 -0
- package/src/docs/K8sResource.md +36 -0
- package/src/docs/KubernetesClustersApi.md +218 -0
- package/src/docs/KubernetesResourcesApi.md +118 -0
- package/src/docs/MeResponse.md +24 -0
- package/src/docs/MeResponseOneOf.md +20 -0
- package/src/docs/MeResponseOneOf1.md +20 -0
- package/src/docs/MeResponseOneOf2.md +20 -0
- package/src/docs/MeResponseOneOf2Deployment.md +22 -0
- package/src/docs/NewDeployment.md +30 -0
- package/src/docs/NewDeploymentPermission.md +26 -0
- package/src/docs/NewDeploymentResource.md +32 -0
- package/src/docs/NewEnv.md +22 -0
- package/src/docs/NewEnvUserPermission.md +24 -0
- package/src/docs/NewHelmTagFormat.md +20 -0
- package/src/docs/NewSecret.md +26 -0
- package/src/docs/OAuth2Response.md +20 -0
- package/src/docs/PaginatedBot.md +26 -0
- package/src/docs/PaginatedBotItemsInner.md +24 -0
- package/src/docs/PaginatedBotToken.md +26 -0
- package/src/docs/PaginatedBotTokenItemsInner.md +26 -0
- package/src/docs/PaginatedDeployment.md +26 -0
- package/src/docs/PaginatedDeploymentItemsInner.md +46 -0
- package/src/docs/PaginatedDeploymentKind.md +26 -0
- package/src/docs/PaginatedDeploymentKindItemsInner.md +24 -0
- package/src/docs/PaginatedDeploymentPermission.md +26 -0
- package/src/docs/PaginatedDeploymentPermissionItemsInner.md +30 -0
- package/src/docs/PaginatedDeploymentResource.md +26 -0
- package/src/docs/PaginatedDeploymentResourceItemsInner.md +36 -0
- package/src/docs/PaginatedDeploymentResourceType.md +26 -0
- package/src/docs/PaginatedDeploymentResourceTypeItemsInner.md +30 -0
- package/src/docs/PaginatedDeploymentTask.md +26 -0
- package/src/docs/PaginatedDeploymentTaskItemsInner.md +48 -0
- package/src/docs/PaginatedEnv.md +26 -0
- package/src/docs/PaginatedEnvItemsInner.md +30 -0
- package/src/docs/PaginatedEnvUserPermission.md +26 -0
- package/src/docs/PaginatedEnvUserPermissionItemsInner.md +28 -0
- package/src/docs/PaginatedHelmChart.md +26 -0
- package/src/docs/PaginatedHelmChartItemsInner.md +50 -0
- package/src/docs/PaginatedHelmRegistry.md +26 -0
- package/src/docs/PaginatedHelmRegistryItemsInner.md +34 -0
- package/src/docs/PaginatedHelmTagFormat.md +26 -0
- package/src/docs/PaginatedHelmTagFormatItemsInner.md +24 -0
- package/src/docs/PaginatedK8sCluster.md +26 -0
- package/src/docs/PaginatedK8sClusterItemsInner.md +48 -0
- package/src/docs/PaginatedK8sResource.md +26 -0
- package/src/docs/PaginatedK8sResourceItemsInner.md +36 -0
- package/src/docs/PaginatedSecret.md +26 -0
- package/src/docs/PaginatedSecretItemsInner.md +30 -0
- package/src/docs/PaginatedUser.md +26 -0
- package/src/docs/PaginatedUserItemsInner.md +30 -0
- package/src/docs/PaginatedUserToken.md +26 -0
- package/src/docs/PaginatedUserTokenItemsInner.md +24 -0
- package/src/docs/Secret.md +30 -0
- package/src/docs/SecretsApi.md +273 -0
- package/src/docs/SerializedUiSchemaInputType.md +24 -0
- package/src/docs/ServerApi.md +51 -0
- package/src/docs/ServerInfo.md +20 -0
- package/src/docs/StartGoogleLoginResponse.md +20 -0
- package/src/docs/UiSchema.md +26 -0
- package/src/docs/UiSchemaFieldValuePair.md +22 -0
- package/src/docs/UiSchemaInput.md +50 -0
- package/src/docs/UiSchemaInputFieldOption.md +24 -0
- package/src/docs/UiSchemaInputFieldValue.md +22 -0
- package/src/docs/UiSchemaInputRef.md +22 -0
- package/src/docs/UiSchemaInputRefField.md +20 -0
- package/src/docs/UiSchemaInputRefOneOf.md +20 -0
- package/src/docs/UiSchemaInputRefOneOf1.md +20 -0
- package/src/docs/UiSchemaInputRefProperty.md +22 -0
- package/src/docs/UiSchemaInputSingleType.md +20 -0
- package/src/docs/UiSchemaInputSingleTypeOneOf.md +20 -0
- package/src/docs/UiSchemaInputSingleTypeOneOfCollectionSelect.md +20 -0
- package/src/docs/UiSchemaInputType.md +22 -0
- package/src/docs/UiSchemaOutputValue.md +22 -0
- package/src/docs/UiSchemaOutputs.md +22 -0
- package/src/docs/UiSchemaV0.md +22 -0
- package/src/docs/UiSchemaV1Beta1.md +26 -0
- package/src/docs/UpdateBot.md +20 -0
- package/src/docs/UpdateDeployment.md +32 -0
- package/src/docs/UpdateDeploymentKind.md +20 -0
- package/src/docs/UpdateDeploymentResource.md +22 -0
- package/src/docs/UpdateEnv.md +26 -0
- package/src/docs/UpdateHelmRegistry.md +20 -0
- package/src/docs/UpdateK8sCluster.md +32 -0
- package/src/docs/UpdateSecret.md +22 -0
- package/src/docs/UpdateUser.md +22 -0
- package/src/docs/User.md +30 -0
- package/src/docs/UserDeploymentRole.md +10 -0
- package/src/docs/UserToken.md +24 -0
- package/src/docs/UserTokensApi.md +212 -0
- package/src/docs/UsersApi.md +170 -0
- package/tsconfig.json +1 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UpdateEnv
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**node_selector** | **any** | | [optional] [default to undefined]
|
|
10
|
+
**tolerations** | **any** | | [optional] [default to undefined]
|
|
11
|
+
**auto_add_new_users** | **boolean** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { UpdateEnv } from './api';
|
|
17
|
+
|
|
18
|
+
const instance: UpdateEnv = {
|
|
19
|
+
name,
|
|
20
|
+
node_selector,
|
|
21
|
+
tolerations,
|
|
22
|
+
auto_add_new_users,
|
|
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,20 @@
|
|
|
1
|
+
# UpdateHelmRegistry
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**fa_icon** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdateHelmRegistry } from './api';
|
|
14
|
+
|
|
15
|
+
const instance: UpdateHelmRegistry = {
|
|
16
|
+
fa_icon,
|
|
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,32 @@
|
|
|
1
|
+
# UpdateK8sCluster
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**env_id** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**ignore** | **boolean** | | [optional] [default to undefined]
|
|
10
|
+
**ingress_domain** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**ingress_class** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**ingress_tls_secret_name** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**grafana_url** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**grafana_datasource_name** | **string** | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { UpdateK8sCluster } from './api';
|
|
20
|
+
|
|
21
|
+
const instance: UpdateK8sCluster = {
|
|
22
|
+
env_id,
|
|
23
|
+
ignore,
|
|
24
|
+
ingress_domain,
|
|
25
|
+
ingress_class,
|
|
26
|
+
ingress_tls_secret_name,
|
|
27
|
+
grafana_url,
|
|
28
|
+
grafana_datasource_name,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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,22 @@
|
|
|
1
|
+
# UpdateSecret
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**contents** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { UpdateSecret } from './api';
|
|
15
|
+
|
|
16
|
+
const instance: UpdateSecret = {
|
|
17
|
+
name,
|
|
18
|
+
contents,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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,22 @@
|
|
|
1
|
+
# UpdateUser
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**is_admin** | **boolean** | | [optional] [default to undefined]
|
|
9
|
+
**is_active** | **boolean** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { UpdateUser } from './api';
|
|
15
|
+
|
|
16
|
+
const instance: UpdateUser = {
|
|
17
|
+
is_admin,
|
|
18
|
+
is_active,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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/User.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# User
|
|
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 { User } from './api';
|
|
19
|
+
|
|
20
|
+
const instance: User = {
|
|
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,10 @@
|
|
|
1
|
+
# UserDeploymentRole
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Owner` (value: `'Owner'`)
|
|
7
|
+
|
|
8
|
+
* `Maintainer` (value: `'Maintainer'`)
|
|
9
|
+
|
|
10
|
+
[[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
|
+
# UserToken
|
|
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 { UserToken } from './api';
|
|
16
|
+
|
|
17
|
+
const instance: UserToken = {
|
|
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,212 @@
|
|
|
1
|
+
# UserTokensApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**allUserTokens**](#allusertokens) | **GET** /api/v2/user-tokens | |
|
|
8
|
+
|[**createUserToken**](#createusertoken) | **POST** /api/v2/user-tokens | |
|
|
9
|
+
|[**deleteUserToken**](#deleteusertoken) | **DELETE** /api/v2/user-tokens/{id} | |
|
|
10
|
+
|[**getUserToken**](#getusertoken) | **GET** /api/v2/user-tokens/{id} | |
|
|
11
|
+
|
|
12
|
+
# **allUserTokens**
|
|
13
|
+
> PaginatedUserToken allUserTokens()
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
UserTokensApi,
|
|
21
|
+
Configuration
|
|
22
|
+
} from './api';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new UserTokensApi(configuration);
|
|
26
|
+
|
|
27
|
+
let userId: string; // (optional) (default to undefined)
|
|
28
|
+
|
|
29
|
+
const { status, data } = await apiInstance.allUserTokens(
|
|
30
|
+
userId
|
|
31
|
+
);
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Parameters
|
|
35
|
+
|
|
36
|
+
|Name | Type | Description | Notes|
|
|
37
|
+
|------------- | ------------- | ------------- | -------------|
|
|
38
|
+
| **userId** | [**string**] | | (optional) defaults to undefined|
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
### Return type
|
|
42
|
+
|
|
43
|
+
**PaginatedUserToken**
|
|
44
|
+
|
|
45
|
+
### Authorization
|
|
46
|
+
|
|
47
|
+
[access_token](../README.md#access_token), [user_token](../README.md#user_token)
|
|
48
|
+
|
|
49
|
+
### HTTP request headers
|
|
50
|
+
|
|
51
|
+
- **Content-Type**: Not defined
|
|
52
|
+
- **Accept**: application/json
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
### HTTP response details
|
|
56
|
+
| Status code | Description | Response headers |
|
|
57
|
+
|-------------|-------------|------------------|
|
|
58
|
+
|**200** | | - |
|
|
59
|
+
|
|
60
|
+
[[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)
|
|
61
|
+
|
|
62
|
+
# **createUserToken**
|
|
63
|
+
> CreatedUserToken createUserToken(createUserToken)
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
### Example
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
import {
|
|
70
|
+
UserTokensApi,
|
|
71
|
+
Configuration,
|
|
72
|
+
CreateUserToken
|
|
73
|
+
} from './api';
|
|
74
|
+
|
|
75
|
+
const configuration = new Configuration();
|
|
76
|
+
const apiInstance = new UserTokensApi(configuration);
|
|
77
|
+
|
|
78
|
+
let createUserToken: CreateUserToken; //
|
|
79
|
+
|
|
80
|
+
const { status, data } = await apiInstance.createUserToken(
|
|
81
|
+
createUserToken
|
|
82
|
+
);
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Parameters
|
|
86
|
+
|
|
87
|
+
|Name | Type | Description | Notes|
|
|
88
|
+
|------------- | ------------- | ------------- | -------------|
|
|
89
|
+
| **createUserToken** | **CreateUserToken**| | |
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
### Return type
|
|
93
|
+
|
|
94
|
+
**CreatedUserToken**
|
|
95
|
+
|
|
96
|
+
### Authorization
|
|
97
|
+
|
|
98
|
+
[access_token](../README.md#access_token), [user_token](../README.md#user_token)
|
|
99
|
+
|
|
100
|
+
### HTTP request headers
|
|
101
|
+
|
|
102
|
+
- **Content-Type**: application/json
|
|
103
|
+
- **Accept**: application/json
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### HTTP response details
|
|
107
|
+
| Status code | Description | Response headers |
|
|
108
|
+
|-------------|-------------|------------------|
|
|
109
|
+
|**201** | | - |
|
|
110
|
+
|
|
111
|
+
[[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)
|
|
112
|
+
|
|
113
|
+
# **deleteUserToken**
|
|
114
|
+
> deleteUserToken()
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
### Example
|
|
118
|
+
|
|
119
|
+
```typescript
|
|
120
|
+
import {
|
|
121
|
+
UserTokensApi,
|
|
122
|
+
Configuration
|
|
123
|
+
} from './api';
|
|
124
|
+
|
|
125
|
+
const configuration = new Configuration();
|
|
126
|
+
const apiInstance = new UserTokensApi(configuration);
|
|
127
|
+
|
|
128
|
+
let id: string; // (default to undefined)
|
|
129
|
+
|
|
130
|
+
const { status, data } = await apiInstance.deleteUserToken(
|
|
131
|
+
id
|
|
132
|
+
);
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Parameters
|
|
136
|
+
|
|
137
|
+
|Name | Type | Description | Notes|
|
|
138
|
+
|------------- | ------------- | ------------- | -------------|
|
|
139
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
### Return type
|
|
143
|
+
|
|
144
|
+
void (empty response body)
|
|
145
|
+
|
|
146
|
+
### Authorization
|
|
147
|
+
|
|
148
|
+
[access_token](../README.md#access_token), [user_token](../README.md#user_token)
|
|
149
|
+
|
|
150
|
+
### HTTP request headers
|
|
151
|
+
|
|
152
|
+
- **Content-Type**: Not defined
|
|
153
|
+
- **Accept**: Not defined
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
### HTTP response details
|
|
157
|
+
| Status code | Description | Response headers |
|
|
158
|
+
|-------------|-------------|------------------|
|
|
159
|
+
|**204** | | - |
|
|
160
|
+
|
|
161
|
+
[[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)
|
|
162
|
+
|
|
163
|
+
# **getUserToken**
|
|
164
|
+
> UserToken getUserToken()
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
### Example
|
|
168
|
+
|
|
169
|
+
```typescript
|
|
170
|
+
import {
|
|
171
|
+
UserTokensApi,
|
|
172
|
+
Configuration
|
|
173
|
+
} from './api';
|
|
174
|
+
|
|
175
|
+
const configuration = new Configuration();
|
|
176
|
+
const apiInstance = new UserTokensApi(configuration);
|
|
177
|
+
|
|
178
|
+
let id: string; // (default to undefined)
|
|
179
|
+
|
|
180
|
+
const { status, data } = await apiInstance.getUserToken(
|
|
181
|
+
id
|
|
182
|
+
);
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### Parameters
|
|
186
|
+
|
|
187
|
+
|Name | Type | Description | Notes|
|
|
188
|
+
|------------- | ------------- | ------------- | -------------|
|
|
189
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
### Return type
|
|
193
|
+
|
|
194
|
+
**UserToken**
|
|
195
|
+
|
|
196
|
+
### Authorization
|
|
197
|
+
|
|
198
|
+
[access_token](../README.md#access_token), [user_token](../README.md#user_token)
|
|
199
|
+
|
|
200
|
+
### HTTP request headers
|
|
201
|
+
|
|
202
|
+
- **Content-Type**: Not defined
|
|
203
|
+
- **Accept**: application/json
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
### HTTP response details
|
|
207
|
+
| Status code | Description | Response headers |
|
|
208
|
+
|-------------|-------------|------------------|
|
|
209
|
+
|**200** | | - |
|
|
210
|
+
|
|
211
|
+
[[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)
|
|
212
|
+
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
# UsersApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**allUsers**](#allusers) | **GET** /api/v2/users | |
|
|
8
|
+
|[**getUser**](#getuser) | **GET** /api/v2/users/{id} | |
|
|
9
|
+
|[**updateUser**](#updateuser) | **PUT** /api/v2/users/{id} | |
|
|
10
|
+
|
|
11
|
+
# **allUsers**
|
|
12
|
+
> PaginatedUser allUsers()
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
UsersApi,
|
|
20
|
+
Configuration
|
|
21
|
+
} from './api';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new UsersApi(configuration);
|
|
25
|
+
|
|
26
|
+
let displayName: string; // (optional) (default to undefined)
|
|
27
|
+
let email: string; // (optional) (default to undefined)
|
|
28
|
+
let isActive: boolean; // (optional) (default to undefined)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.allUsers(
|
|
31
|
+
displayName,
|
|
32
|
+
email,
|
|
33
|
+
isActive
|
|
34
|
+
);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
|Name | Type | Description | Notes|
|
|
40
|
+
|------------- | ------------- | ------------- | -------------|
|
|
41
|
+
| **displayName** | [**string**] | | (optional) defaults to undefined|
|
|
42
|
+
| **email** | [**string**] | | (optional) defaults to undefined|
|
|
43
|
+
| **isActive** | [**boolean**] | | (optional) defaults to undefined|
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
**PaginatedUser**
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
[access_token](../README.md#access_token), [user_token](../README.md#user_token)
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: Not defined
|
|
57
|
+
- **Accept**: application/json
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### HTTP response details
|
|
61
|
+
| Status code | Description | Response headers |
|
|
62
|
+
|-------------|-------------|------------------|
|
|
63
|
+
|**200** | | - |
|
|
64
|
+
|
|
65
|
+
[[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)
|
|
66
|
+
|
|
67
|
+
# **getUser**
|
|
68
|
+
> User getUser()
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
### Example
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
import {
|
|
75
|
+
UsersApi,
|
|
76
|
+
Configuration
|
|
77
|
+
} from './api';
|
|
78
|
+
|
|
79
|
+
const configuration = new Configuration();
|
|
80
|
+
const apiInstance = new UsersApi(configuration);
|
|
81
|
+
|
|
82
|
+
let id: string; // (default to undefined)
|
|
83
|
+
|
|
84
|
+
const { status, data } = await apiInstance.getUser(
|
|
85
|
+
id
|
|
86
|
+
);
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Parameters
|
|
90
|
+
|
|
91
|
+
|Name | Type | Description | Notes|
|
|
92
|
+
|------------- | ------------- | ------------- | -------------|
|
|
93
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
### Return type
|
|
97
|
+
|
|
98
|
+
**User**
|
|
99
|
+
|
|
100
|
+
### Authorization
|
|
101
|
+
|
|
102
|
+
[access_token](../README.md#access_token), [user_token](../README.md#user_token)
|
|
103
|
+
|
|
104
|
+
### HTTP request headers
|
|
105
|
+
|
|
106
|
+
- **Content-Type**: Not defined
|
|
107
|
+
- **Accept**: application/json
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
### HTTP response details
|
|
111
|
+
| Status code | Description | Response headers |
|
|
112
|
+
|-------------|-------------|------------------|
|
|
113
|
+
|**200** | | - |
|
|
114
|
+
|
|
115
|
+
[[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)
|
|
116
|
+
|
|
117
|
+
# **updateUser**
|
|
118
|
+
> User updateUser(updateUser)
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
### Example
|
|
122
|
+
|
|
123
|
+
```typescript
|
|
124
|
+
import {
|
|
125
|
+
UsersApi,
|
|
126
|
+
Configuration,
|
|
127
|
+
UpdateUser
|
|
128
|
+
} from './api';
|
|
129
|
+
|
|
130
|
+
const configuration = new Configuration();
|
|
131
|
+
const apiInstance = new UsersApi(configuration);
|
|
132
|
+
|
|
133
|
+
let id: string; // (default to undefined)
|
|
134
|
+
let updateUser: UpdateUser; //
|
|
135
|
+
|
|
136
|
+
const { status, data } = await apiInstance.updateUser(
|
|
137
|
+
id,
|
|
138
|
+
updateUser
|
|
139
|
+
);
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Parameters
|
|
143
|
+
|
|
144
|
+
|Name | Type | Description | Notes|
|
|
145
|
+
|------------- | ------------- | ------------- | -------------|
|
|
146
|
+
| **updateUser** | **UpdateUser**| | |
|
|
147
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
### Return type
|
|
151
|
+
|
|
152
|
+
**User**
|
|
153
|
+
|
|
154
|
+
### Authorization
|
|
155
|
+
|
|
156
|
+
[access_token](../README.md#access_token), [user_token](../README.md#user_token)
|
|
157
|
+
|
|
158
|
+
### HTTP request headers
|
|
159
|
+
|
|
160
|
+
- **Content-Type**: application/json
|
|
161
|
+
- **Accept**: application/json
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
### HTTP response details
|
|
165
|
+
| Status code | Description | Response headers |
|
|
166
|
+
|-------------|-------------|------------------|
|
|
167
|
+
|**200** | | - |
|
|
168
|
+
|
|
169
|
+
[[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)
|
|
170
|
+
|