@openfilz-sdk/typescript-ee 1.12.0 → 1.12.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/.openapi-generator/FILES +30 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +37 -9
- package/api/ai-archiving-admin-controller-api.ts +10 -10
- package/api/aifiling-rules-api.ts +18 -18
- package/api/aimaintenance-api.ts +334 -0
- package/api/aiteam-inboxes-api.ts +18 -18
- package/api/esign-templates-api.ts +8 -8
- package/api/mcp-token-admin-controller-api.ts +75 -8
- package/api/organisation-settings-api.ts +266 -0
- package/api/quota-administration-api.ts +677 -0
- package/api/quotas-api.ts +121 -0
- package/api/tus-controller-api.ts +8 -4
- package/api.ts +4 -0
- package/dist/api/ai-archiving-admin-controller-api.d.ts +4 -4
- package/dist/api/ai-archiving-admin-controller-api.js +10 -10
- package/dist/api/aifiling-rules-api.d.ts +8 -8
- package/dist/api/aifiling-rules-api.js +18 -18
- package/dist/api/aimaintenance-api.d.ts +162 -0
- package/dist/api/aimaintenance-api.js +327 -0
- package/dist/api/aiteam-inboxes-api.d.ts +8 -8
- package/dist/api/aiteam-inboxes-api.js +18 -18
- package/dist/api/esign-templates-api.d.ts +4 -4
- package/dist/api/esign-templates-api.js +8 -8
- package/dist/api/mcp-token-admin-controller-api.d.ts +33 -4
- package/dist/api/mcp-token-admin-controller-api.js +70 -8
- package/dist/api/organisation-settings-api.d.ts +135 -0
- package/dist/api/organisation-settings-api.js +264 -0
- package/dist/api/quota-administration-api.d.ts +312 -0
- package/dist/api/quota-administration-api.js +645 -0
- package/dist/api/quotas-api.d.ts +63 -0
- package/dist/api/quotas-api.js +125 -0
- package/dist/api/tus-controller-api.d.ts +6 -6
- package/dist/api/tus-controller-api.js +2 -0
- package/dist/api.d.ts +4 -0
- package/dist/api.js +4 -0
- package/dist/esm/api/ai-archiving-admin-controller-api.d.ts +4 -4
- package/dist/esm/api/ai-archiving-admin-controller-api.js +10 -10
- package/dist/esm/api/aifiling-rules-api.d.ts +8 -8
- package/dist/esm/api/aifiling-rules-api.js +18 -18
- package/dist/esm/api/aimaintenance-api.d.ts +162 -0
- package/dist/esm/api/aimaintenance-api.js +320 -0
- package/dist/esm/api/aiteam-inboxes-api.d.ts +8 -8
- package/dist/esm/api/aiteam-inboxes-api.js +18 -18
- package/dist/esm/api/esign-templates-api.d.ts +4 -4
- package/dist/esm/api/esign-templates-api.js +8 -8
- package/dist/esm/api/mcp-token-admin-controller-api.d.ts +33 -4
- package/dist/esm/api/mcp-token-admin-controller-api.js +70 -8
- package/dist/esm/api/organisation-settings-api.d.ts +135 -0
- package/dist/esm/api/organisation-settings-api.js +257 -0
- package/dist/esm/api/quota-administration-api.d.ts +312 -0
- package/dist/esm/api/quota-administration-api.js +638 -0
- package/dist/esm/api/quotas-api.d.ts +63 -0
- package/dist/esm/api/quotas-api.js +118 -0
- package/dist/esm/api/tus-controller-api.d.ts +6 -6
- package/dist/esm/api/tus-controller-api.js +2 -0
- package/dist/esm/api.d.ts +4 -0
- package/dist/esm/api.js +4 -0
- package/dist/esm/models/enriched-audit-log.d.ts +4 -0
- package/dist/esm/models/enriched-audit-log.js +4 -0
- package/dist/esm/models/error-response.d.ts +16 -0
- package/dist/esm/models/error-response.js +14 -0
- package/dist/esm/models/index.d.ts +11 -0
- package/dist/esm/models/index.js +11 -0
- package/dist/esm/models/mcp-agent-token-config.d.ts +31 -0
- package/dist/esm/models/mcp-agent-token-config.js +14 -0
- package/dist/esm/models/mcp-agent-token-info.d.ts +1 -0
- package/dist/esm/models/my-storage-quota.d.ts +24 -0
- package/dist/esm/models/my-storage-quota.js +18 -0
- package/dist/esm/models/quota-overview.d.ts +19 -0
- package/dist/esm/models/quota-overview.js +14 -0
- package/dist/esm/models/quota-usage.d.ts +27 -0
- package/dist/esm/models/quota-usage.js +18 -0
- package/dist/esm/models/quota-user-page.d.ts +18 -0
- package/dist/esm/models/quota-user-page.js +14 -0
- package/dist/esm/models/search-by-audit-log-request.d.ts +4 -0
- package/dist/esm/models/search-by-audit-log-request.js +4 -0
- package/dist/esm/models/setting-dto.d.ts +26 -0
- package/dist/esm/models/setting-dto.js +14 -0
- package/dist/esm/models/start-request.d.ts +14 -0
- package/dist/esm/models/start-request.js +14 -0
- package/dist/esm/models/storage-breakdown.d.ts +2 -0
- package/dist/esm/models/team-quota-request.d.ts +17 -0
- package/dist/esm/models/team-quota-request.js +14 -0
- package/dist/esm/models/team-quota-view.d.ts +19 -0
- package/dist/esm/models/team-quota-view.js +14 -0
- package/dist/esm/models/user-quota-request.d.ts +17 -0
- package/dist/esm/models/user-quota-request.js +14 -0
- package/dist/models/enriched-audit-log.d.ts +4 -0
- package/dist/models/enriched-audit-log.js +4 -0
- package/dist/models/error-response.d.ts +16 -0
- package/dist/models/error-response.js +15 -0
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/dist/models/mcp-agent-token-config.d.ts +31 -0
- package/dist/models/mcp-agent-token-config.js +15 -0
- package/dist/models/mcp-agent-token-info.d.ts +1 -0
- package/dist/models/my-storage-quota.d.ts +24 -0
- package/dist/models/my-storage-quota.js +21 -0
- package/dist/models/quota-overview.d.ts +19 -0
- package/dist/models/quota-overview.js +15 -0
- package/dist/models/quota-usage.d.ts +27 -0
- package/dist/models/quota-usage.js +21 -0
- package/dist/models/quota-user-page.d.ts +18 -0
- package/dist/models/quota-user-page.js +15 -0
- package/dist/models/search-by-audit-log-request.d.ts +4 -0
- package/dist/models/search-by-audit-log-request.js +4 -0
- package/dist/models/setting-dto.d.ts +26 -0
- package/dist/models/setting-dto.js +15 -0
- package/dist/models/start-request.d.ts +14 -0
- package/dist/models/start-request.js +15 -0
- package/dist/models/storage-breakdown.d.ts +2 -0
- package/dist/models/team-quota-request.d.ts +17 -0
- package/dist/models/team-quota-request.js +15 -0
- package/dist/models/team-quota-view.d.ts +19 -0
- package/dist/models/team-quota-view.js +15 -0
- package/dist/models/user-quota-request.d.ts +17 -0
- package/dist/models/user-quota-request.js +15 -0
- package/docs/AIFilingRulesApi.md +8 -8
- package/docs/AIMaintenanceApi.md +201 -0
- package/docs/AITeamInboxesApi.md +8 -8
- package/docs/AiArchivingAdminControllerApi.md +4 -4
- package/docs/ESignTemplatesApi.md +4 -4
- package/docs/ErrorResponse.md +24 -0
- package/docs/McpAgentTokenConfig.md +30 -0
- package/docs/McpAgentTokenInfo.md +2 -0
- package/docs/McpTokenAdminControllerApi.md +48 -4
- package/docs/MyStorageQuota.md +28 -0
- package/docs/OrganisationSettingsApi.md +153 -0
- package/docs/QuotaAdministrationApi.md +427 -0
- package/docs/QuotaOverview.md +30 -0
- package/docs/QuotaUsage.md +34 -0
- package/docs/QuotaUserPage.md +26 -0
- package/docs/QuotasApi.md +52 -0
- package/docs/SettingDto.md +44 -0
- package/docs/StartRequest.md +20 -0
- package/docs/StorageBreakdown.md +2 -0
- package/docs/TeamQuotaRequest.md +20 -0
- package/docs/TeamQuotaView.md +30 -0
- package/docs/TusControllerApi.md +8 -7
- package/docs/UserQuotaRequest.md +20 -0
- package/models/enriched-audit-log.ts +4 -0
- package/models/error-response.ts +22 -0
- package/models/index.ts +11 -0
- package/models/mcp-agent-token-config.ts +37 -0
- package/models/mcp-agent-token-info.ts +1 -0
- package/models/my-storage-quota.ts +33 -0
- package/models/quota-overview.ts +25 -0
- package/models/quota-usage.ts +36 -0
- package/models/quota-user-page.ts +26 -0
- package/models/search-by-audit-log-request.ts +4 -0
- package/models/setting-dto.ts +32 -0
- package/models/start-request.ts +20 -0
- package/models/storage-breakdown.ts +4 -0
- package/models/team-quota-request.ts +23 -0
- package/models/team-quota-view.ts +25 -0
- package/models/user-quota-request.ts +23 -0
- package/package.json +1 -1
|
@@ -4,12 +4,13 @@ All URIs are relative to *http://localhost:8081*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
7
|
+
|[**config**](#config) | **GET** /api/v1/admin/mcp/tokens/config | Whether agent tokens can be minted here, and the TTL bounds (no secrets)|
|
|
8
|
+
|[**list2**](#list2) | **GET** /api/v1/admin/mcp/tokens | List minted MCP agent tokens (never returns the credentials)|
|
|
8
9
|
|[**mint**](#mint) | **POST** /api/v1/admin/mcp/tokens | Mint an MCP agent token for a dedicated user (admin only)|
|
|
9
10
|
|[**revoke1**](#revoke1) | **DELETE** /api/v1/admin/mcp/tokens/{jti} | Revoke an MCP agent token|
|
|
10
11
|
|
|
11
|
-
# **
|
|
12
|
-
>
|
|
12
|
+
# **config**
|
|
13
|
+
> McpAgentTokenConfig config()
|
|
13
14
|
|
|
14
15
|
|
|
15
16
|
### Example
|
|
@@ -23,7 +24,50 @@ import {
|
|
|
23
24
|
const configuration = new Configuration();
|
|
24
25
|
const apiInstance = new McpTokenAdminControllerApi(configuration);
|
|
25
26
|
|
|
26
|
-
const { status, data } = await apiInstance.
|
|
27
|
+
const { status, data } = await apiInstance.config();
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Parameters
|
|
31
|
+
This endpoint does not have any parameters.
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### Return type
|
|
35
|
+
|
|
36
|
+
**McpAgentTokenConfig**
|
|
37
|
+
|
|
38
|
+
### Authorization
|
|
39
|
+
|
|
40
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
41
|
+
|
|
42
|
+
### HTTP request headers
|
|
43
|
+
|
|
44
|
+
- **Content-Type**: Not defined
|
|
45
|
+
- **Accept**: */*
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### HTTP response details
|
|
49
|
+
| Status code | Description | Response headers |
|
|
50
|
+
|-------------|-------------|------------------|
|
|
51
|
+
|**200** | OK | - |
|
|
52
|
+
|
|
53
|
+
[[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)
|
|
54
|
+
|
|
55
|
+
# **list2**
|
|
56
|
+
> Array<McpAgentTokenInfo> list2()
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### Example
|
|
60
|
+
|
|
61
|
+
```typescript
|
|
62
|
+
import {
|
|
63
|
+
McpTokenAdminControllerApi,
|
|
64
|
+
Configuration
|
|
65
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
66
|
+
|
|
67
|
+
const configuration = new Configuration();
|
|
68
|
+
const apiInstance = new McpTokenAdminControllerApi(configuration);
|
|
69
|
+
|
|
70
|
+
const { status, data } = await apiInstance.list2();
|
|
27
71
|
```
|
|
28
72
|
|
|
29
73
|
### Parameters
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# MyStorageQuota
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**usedBytes** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**limitBytes** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**source** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**sourceName** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**maxFileSizeBytes** | **number** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { MyStorageQuota } from '@openfilz-sdk/typescript-ee';
|
|
18
|
+
|
|
19
|
+
const instance: MyStorageQuota = {
|
|
20
|
+
usedBytes,
|
|
21
|
+
limitBytes,
|
|
22
|
+
source,
|
|
23
|
+
sourceName,
|
|
24
|
+
maxFileSizeBytes,
|
|
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,153 @@
|
|
|
1
|
+
# OrganisationSettingsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:8081*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**list**](#list) | **GET** /api/v1/admin/settings | List the organisation settings with their effective and deployment values|
|
|
8
|
+
|[**reset1**](#reset1) | **DELETE** /api/v1/admin/settings/{key} | Reset a setting to its deployment value|
|
|
9
|
+
|[**update2**](#update2) | **PUT** /api/v1/admin/settings | Change settings (map of key → value). All are validated before any is stored; a locked key answers 409, an unknown key or invalid value 400|
|
|
10
|
+
|
|
11
|
+
# **list**
|
|
12
|
+
> Array<SettingDto> list()
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
OrganisationSettingsApi,
|
|
20
|
+
Configuration
|
|
21
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new OrganisationSettingsApi(configuration);
|
|
25
|
+
|
|
26
|
+
const { status, data } = await apiInstance.list();
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Parameters
|
|
30
|
+
This endpoint does not have any parameters.
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
### Return type
|
|
34
|
+
|
|
35
|
+
**Array<SettingDto>**
|
|
36
|
+
|
|
37
|
+
### Authorization
|
|
38
|
+
|
|
39
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
40
|
+
|
|
41
|
+
### HTTP request headers
|
|
42
|
+
|
|
43
|
+
- **Content-Type**: Not defined
|
|
44
|
+
- **Accept**: */*
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### HTTP response details
|
|
48
|
+
| Status code | Description | Response headers |
|
|
49
|
+
|-------------|-------------|------------------|
|
|
50
|
+
|**200** | OK | - |
|
|
51
|
+
|
|
52
|
+
[[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)
|
|
53
|
+
|
|
54
|
+
# **reset1**
|
|
55
|
+
> Array<SettingDto> reset1()
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
### Example
|
|
59
|
+
|
|
60
|
+
```typescript
|
|
61
|
+
import {
|
|
62
|
+
OrganisationSettingsApi,
|
|
63
|
+
Configuration
|
|
64
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
65
|
+
|
|
66
|
+
const configuration = new Configuration();
|
|
67
|
+
const apiInstance = new OrganisationSettingsApi(configuration);
|
|
68
|
+
|
|
69
|
+
let key: string; // (default to undefined)
|
|
70
|
+
|
|
71
|
+
const { status, data } = await apiInstance.reset1(
|
|
72
|
+
key
|
|
73
|
+
);
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Parameters
|
|
77
|
+
|
|
78
|
+
|Name | Type | Description | Notes|
|
|
79
|
+
|------------- | ------------- | ------------- | -------------|
|
|
80
|
+
| **key** | [**string**] | | defaults to undefined|
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
### Return type
|
|
84
|
+
|
|
85
|
+
**Array<SettingDto>**
|
|
86
|
+
|
|
87
|
+
### Authorization
|
|
88
|
+
|
|
89
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
90
|
+
|
|
91
|
+
### HTTP request headers
|
|
92
|
+
|
|
93
|
+
- **Content-Type**: Not defined
|
|
94
|
+
- **Accept**: */*
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### HTTP response details
|
|
98
|
+
| Status code | Description | Response headers |
|
|
99
|
+
|-------------|-------------|------------------|
|
|
100
|
+
|**200** | OK | - |
|
|
101
|
+
|
|
102
|
+
[[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)
|
|
103
|
+
|
|
104
|
+
# **update2**
|
|
105
|
+
> Array<SettingDto> update2(requestBody)
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
### Example
|
|
109
|
+
|
|
110
|
+
```typescript
|
|
111
|
+
import {
|
|
112
|
+
OrganisationSettingsApi,
|
|
113
|
+
Configuration
|
|
114
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
115
|
+
|
|
116
|
+
const configuration = new Configuration();
|
|
117
|
+
const apiInstance = new OrganisationSettingsApi(configuration);
|
|
118
|
+
|
|
119
|
+
let requestBody: { [key: string]: string; }; //
|
|
120
|
+
|
|
121
|
+
const { status, data } = await apiInstance.update2(
|
|
122
|
+
requestBody
|
|
123
|
+
);
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Parameters
|
|
127
|
+
|
|
128
|
+
|Name | Type | Description | Notes|
|
|
129
|
+
|------------- | ------------- | ------------- | -------------|
|
|
130
|
+
| **requestBody** | **{ [key: string]: string; }**| | |
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
### Return type
|
|
134
|
+
|
|
135
|
+
**Array<SettingDto>**
|
|
136
|
+
|
|
137
|
+
### Authorization
|
|
138
|
+
|
|
139
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
140
|
+
|
|
141
|
+
### HTTP request headers
|
|
142
|
+
|
|
143
|
+
- **Content-Type**: application/json
|
|
144
|
+
- **Accept**: */*
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
### HTTP response details
|
|
148
|
+
| Status code | Description | Response headers |
|
|
149
|
+
|-------------|-------------|------------------|
|
|
150
|
+
|**200** | OK | - |
|
|
151
|
+
|
|
152
|
+
[[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)
|
|
153
|
+
|
|
@@ -0,0 +1,427 @@
|
|
|
1
|
+
# QuotaAdministrationApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:8081*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**clear**](#clear) | **DELETE** /api/v1/admin/quotas/teams/{teamId} | Remove a team\'s limit|
|
|
8
|
+
|[**clearUserQuota**](#clearuserquota) | **DELETE** /api/v1/admin/quotas/users/{username} | Remove one user\'s own limit|
|
|
9
|
+
|[**getUser**](#getuser) | **GET** /api/v1/admin/quotas/users/{username} | Get one user\'s storage|
|
|
10
|
+
|[**list5**](#list5) | **GET** /api/v1/admin/quotas/teams | List teams with their per-member limit and their members\' usage|
|
|
11
|
+
|[**listUsers**](#listusers) | **GET** /api/v1/admin/quotas/users | List users\' storage|
|
|
12
|
+
|[**overview**](#overview) | **GET** /api/v1/admin/quotas | Quota overview|
|
|
13
|
+
|[**set**](#set) | **PUT** /api/v1/admin/quotas/teams/{teamId} | Set a team\'s per-member limit|
|
|
14
|
+
|[**setUserQuota**](#setuserquota) | **PUT** /api/v1/admin/quotas/users/{username} | Set one user\'s own limit|
|
|
15
|
+
|
|
16
|
+
# **clear**
|
|
17
|
+
> TeamQuotaView clear()
|
|
18
|
+
|
|
19
|
+
Its members fall back to their other teams or the default.
|
|
20
|
+
|
|
21
|
+
### Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import {
|
|
25
|
+
QuotaAdministrationApi,
|
|
26
|
+
Configuration
|
|
27
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
28
|
+
|
|
29
|
+
const configuration = new Configuration();
|
|
30
|
+
const apiInstance = new QuotaAdministrationApi(configuration);
|
|
31
|
+
|
|
32
|
+
let teamId: string; // (default to undefined)
|
|
33
|
+
|
|
34
|
+
const { status, data } = await apiInstance.clear(
|
|
35
|
+
teamId
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
|Name | Type | Description | Notes|
|
|
42
|
+
|------------- | ------------- | ------------- | -------------|
|
|
43
|
+
| **teamId** | [**string**] | | defaults to undefined|
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
**TeamQuotaView**
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: Not defined
|
|
57
|
+
- **Accept**: */*
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### HTTP response details
|
|
61
|
+
| Status code | Description | Response headers |
|
|
62
|
+
|-------------|-------------|------------------|
|
|
63
|
+
|**200** | OK | - |
|
|
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
|
+
# **clearUserQuota**
|
|
68
|
+
> QuotaUsage clearUserQuota()
|
|
69
|
+
|
|
70
|
+
The group or default limit applies again.
|
|
71
|
+
|
|
72
|
+
### Example
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
import {
|
|
76
|
+
QuotaAdministrationApi,
|
|
77
|
+
Configuration
|
|
78
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
79
|
+
|
|
80
|
+
const configuration = new Configuration();
|
|
81
|
+
const apiInstance = new QuotaAdministrationApi(configuration);
|
|
82
|
+
|
|
83
|
+
let username: string; // (default to undefined)
|
|
84
|
+
|
|
85
|
+
const { status, data } = await apiInstance.clearUserQuota(
|
|
86
|
+
username
|
|
87
|
+
);
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Parameters
|
|
91
|
+
|
|
92
|
+
|Name | Type | Description | Notes|
|
|
93
|
+
|------------- | ------------- | ------------- | -------------|
|
|
94
|
+
| **username** | [**string**] | | defaults to undefined|
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### Return type
|
|
98
|
+
|
|
99
|
+
**QuotaUsage**
|
|
100
|
+
|
|
101
|
+
### Authorization
|
|
102
|
+
|
|
103
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
104
|
+
|
|
105
|
+
### HTTP request headers
|
|
106
|
+
|
|
107
|
+
- **Content-Type**: Not defined
|
|
108
|
+
- **Accept**: */*
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
### HTTP response details
|
|
112
|
+
| Status code | Description | Response headers |
|
|
113
|
+
|-------------|-------------|------------------|
|
|
114
|
+
|**200** | OK | - |
|
|
115
|
+
|
|
116
|
+
[[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)
|
|
117
|
+
|
|
118
|
+
# **getUser**
|
|
119
|
+
> QuotaUsage getUser()
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
### Example
|
|
123
|
+
|
|
124
|
+
```typescript
|
|
125
|
+
import {
|
|
126
|
+
QuotaAdministrationApi,
|
|
127
|
+
Configuration
|
|
128
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
129
|
+
|
|
130
|
+
const configuration = new Configuration();
|
|
131
|
+
const apiInstance = new QuotaAdministrationApi(configuration);
|
|
132
|
+
|
|
133
|
+
let username: string; // (default to undefined)
|
|
134
|
+
|
|
135
|
+
const { status, data } = await apiInstance.getUser(
|
|
136
|
+
username
|
|
137
|
+
);
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Parameters
|
|
141
|
+
|
|
142
|
+
|Name | Type | Description | Notes|
|
|
143
|
+
|------------- | ------------- | ------------- | -------------|
|
|
144
|
+
| **username** | [**string**] | | defaults to undefined|
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
### Return type
|
|
148
|
+
|
|
149
|
+
**QuotaUsage**
|
|
150
|
+
|
|
151
|
+
### Authorization
|
|
152
|
+
|
|
153
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
154
|
+
|
|
155
|
+
### HTTP request headers
|
|
156
|
+
|
|
157
|
+
- **Content-Type**: Not defined
|
|
158
|
+
- **Accept**: */*
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
### HTTP response details
|
|
162
|
+
| Status code | Description | Response headers |
|
|
163
|
+
|-------------|-------------|------------------|
|
|
164
|
+
|**200** | OK | - |
|
|
165
|
+
|
|
166
|
+
[[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)
|
|
167
|
+
|
|
168
|
+
# **list5**
|
|
169
|
+
> Array<TeamQuotaView> list5()
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
### Example
|
|
173
|
+
|
|
174
|
+
```typescript
|
|
175
|
+
import {
|
|
176
|
+
QuotaAdministrationApi,
|
|
177
|
+
Configuration
|
|
178
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
179
|
+
|
|
180
|
+
const configuration = new Configuration();
|
|
181
|
+
const apiInstance = new QuotaAdministrationApi(configuration);
|
|
182
|
+
|
|
183
|
+
const { status, data } = await apiInstance.list5();
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Parameters
|
|
187
|
+
This endpoint does not have any parameters.
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
### Return type
|
|
191
|
+
|
|
192
|
+
**Array<TeamQuotaView>**
|
|
193
|
+
|
|
194
|
+
### Authorization
|
|
195
|
+
|
|
196
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
197
|
+
|
|
198
|
+
### HTTP request headers
|
|
199
|
+
|
|
200
|
+
- **Content-Type**: Not defined
|
|
201
|
+
- **Accept**: */*
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
### HTTP response details
|
|
205
|
+
| Status code | Description | Response headers |
|
|
206
|
+
|-------------|-------------|------------------|
|
|
207
|
+
|**200** | OK | - |
|
|
208
|
+
|
|
209
|
+
[[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)
|
|
210
|
+
|
|
211
|
+
# **listUsers**
|
|
212
|
+
> QuotaUserPage listUsers()
|
|
213
|
+
|
|
214
|
+
Every user storage is charged to, with usage, effective limit and its source. Sort by usage (default), percent, limit or name.
|
|
215
|
+
|
|
216
|
+
### Example
|
|
217
|
+
|
|
218
|
+
```typescript
|
|
219
|
+
import {
|
|
220
|
+
QuotaAdministrationApi,
|
|
221
|
+
Configuration
|
|
222
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
223
|
+
|
|
224
|
+
const configuration = new Configuration();
|
|
225
|
+
const apiInstance = new QuotaAdministrationApi(configuration);
|
|
226
|
+
|
|
227
|
+
let search: string; //Case-insensitive filter on the user name (optional) (default to undefined)
|
|
228
|
+
let sort: string; //usage | percent | limit | name (optional) (default to 'usage')
|
|
229
|
+
let order: string; //asc | desc (optional) (default to 'desc')
|
|
230
|
+
let page: number; // (optional) (default to 0)
|
|
231
|
+
let size: number; // (optional) (default to 25)
|
|
232
|
+
|
|
233
|
+
const { status, data } = await apiInstance.listUsers(
|
|
234
|
+
search,
|
|
235
|
+
sort,
|
|
236
|
+
order,
|
|
237
|
+
page,
|
|
238
|
+
size
|
|
239
|
+
);
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
### Parameters
|
|
243
|
+
|
|
244
|
+
|Name | Type | Description | Notes|
|
|
245
|
+
|------------- | ------------- | ------------- | -------------|
|
|
246
|
+
| **search** | [**string**] | Case-insensitive filter on the user name | (optional) defaults to undefined|
|
|
247
|
+
| **sort** | [**string**] | usage | percent | limit | name | (optional) defaults to 'usage'|
|
|
248
|
+
| **order** | [**string**] | asc | desc | (optional) defaults to 'desc'|
|
|
249
|
+
| **page** | [**number**] | | (optional) defaults to 0|
|
|
250
|
+
| **size** | [**number**] | | (optional) defaults to 25|
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
### Return type
|
|
254
|
+
|
|
255
|
+
**QuotaUserPage**
|
|
256
|
+
|
|
257
|
+
### Authorization
|
|
258
|
+
|
|
259
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
260
|
+
|
|
261
|
+
### HTTP request headers
|
|
262
|
+
|
|
263
|
+
- **Content-Type**: Not defined
|
|
264
|
+
- **Accept**: */*
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
### HTTP response details
|
|
268
|
+
| Status code | Description | Response headers |
|
|
269
|
+
|-------------|-------------|------------------|
|
|
270
|
+
|**200** | OK | - |
|
|
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
|
+
|
|
274
|
+
# **overview**
|
|
275
|
+
> QuotaOverview overview()
|
|
276
|
+
|
|
277
|
+
Deployment-wide limits (MB, 0 = no limit), instance usage and the number of user overrides.
|
|
278
|
+
|
|
279
|
+
### Example
|
|
280
|
+
|
|
281
|
+
```typescript
|
|
282
|
+
import {
|
|
283
|
+
QuotaAdministrationApi,
|
|
284
|
+
Configuration
|
|
285
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
286
|
+
|
|
287
|
+
const configuration = new Configuration();
|
|
288
|
+
const apiInstance = new QuotaAdministrationApi(configuration);
|
|
289
|
+
|
|
290
|
+
const { status, data } = await apiInstance.overview();
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
### Parameters
|
|
294
|
+
This endpoint does not have any parameters.
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
### Return type
|
|
298
|
+
|
|
299
|
+
**QuotaOverview**
|
|
300
|
+
|
|
301
|
+
### Authorization
|
|
302
|
+
|
|
303
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
304
|
+
|
|
305
|
+
### HTTP request headers
|
|
306
|
+
|
|
307
|
+
- **Content-Type**: Not defined
|
|
308
|
+
- **Accept**: */*
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
### HTTP response details
|
|
312
|
+
| Status code | Description | Response headers |
|
|
313
|
+
|-------------|-------------|------------------|
|
|
314
|
+
|**200** | OK | - |
|
|
315
|
+
|
|
316
|
+
[[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)
|
|
317
|
+
|
|
318
|
+
# **set**
|
|
319
|
+
> TeamQuotaView set(teamQuotaRequest)
|
|
320
|
+
|
|
321
|
+
quotaMb > 0 = limit per member, 0 = members exempt.
|
|
322
|
+
|
|
323
|
+
### Example
|
|
324
|
+
|
|
325
|
+
```typescript
|
|
326
|
+
import {
|
|
327
|
+
QuotaAdministrationApi,
|
|
328
|
+
Configuration,
|
|
329
|
+
TeamQuotaRequest
|
|
330
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
331
|
+
|
|
332
|
+
const configuration = new Configuration();
|
|
333
|
+
const apiInstance = new QuotaAdministrationApi(configuration);
|
|
334
|
+
|
|
335
|
+
let teamId: string; // (default to undefined)
|
|
336
|
+
let teamQuotaRequest: TeamQuotaRequest; //
|
|
337
|
+
|
|
338
|
+
const { status, data } = await apiInstance.set(
|
|
339
|
+
teamId,
|
|
340
|
+
teamQuotaRequest
|
|
341
|
+
);
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
### Parameters
|
|
345
|
+
|
|
346
|
+
|Name | Type | Description | Notes|
|
|
347
|
+
|------------- | ------------- | ------------- | -------------|
|
|
348
|
+
| **teamQuotaRequest** | **TeamQuotaRequest**| | |
|
|
349
|
+
| **teamId** | [**string**] | | defaults to undefined|
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
### Return type
|
|
353
|
+
|
|
354
|
+
**TeamQuotaView**
|
|
355
|
+
|
|
356
|
+
### Authorization
|
|
357
|
+
|
|
358
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
359
|
+
|
|
360
|
+
### HTTP request headers
|
|
361
|
+
|
|
362
|
+
- **Content-Type**: application/json
|
|
363
|
+
- **Accept**: */*
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
### HTTP response details
|
|
367
|
+
| Status code | Description | Response headers |
|
|
368
|
+
|-------------|-------------|------------------|
|
|
369
|
+
|**200** | OK | - |
|
|
370
|
+
|
|
371
|
+
[[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)
|
|
372
|
+
|
|
373
|
+
# **setUserQuota**
|
|
374
|
+
> QuotaUsage setUserQuota(userQuotaRequest)
|
|
375
|
+
|
|
376
|
+
quotaMb > 0 = this user\'s limit, 0 = no limit for this user. Takes precedence over group and default limits.
|
|
377
|
+
|
|
378
|
+
### Example
|
|
379
|
+
|
|
380
|
+
```typescript
|
|
381
|
+
import {
|
|
382
|
+
QuotaAdministrationApi,
|
|
383
|
+
Configuration,
|
|
384
|
+
UserQuotaRequest
|
|
385
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
386
|
+
|
|
387
|
+
const configuration = new Configuration();
|
|
388
|
+
const apiInstance = new QuotaAdministrationApi(configuration);
|
|
389
|
+
|
|
390
|
+
let username: string; // (default to undefined)
|
|
391
|
+
let userQuotaRequest: UserQuotaRequest; //
|
|
392
|
+
|
|
393
|
+
const { status, data } = await apiInstance.setUserQuota(
|
|
394
|
+
username,
|
|
395
|
+
userQuotaRequest
|
|
396
|
+
);
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
### Parameters
|
|
400
|
+
|
|
401
|
+
|Name | Type | Description | Notes|
|
|
402
|
+
|------------- | ------------- | ------------- | -------------|
|
|
403
|
+
| **userQuotaRequest** | **UserQuotaRequest**| | |
|
|
404
|
+
| **username** | [**string**] | | defaults to undefined|
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
### Return type
|
|
408
|
+
|
|
409
|
+
**QuotaUsage**
|
|
410
|
+
|
|
411
|
+
### Authorization
|
|
412
|
+
|
|
413
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
414
|
+
|
|
415
|
+
### HTTP request headers
|
|
416
|
+
|
|
417
|
+
- **Content-Type**: application/json
|
|
418
|
+
- **Accept**: */*
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
### HTTP response details
|
|
422
|
+
| Status code | Description | Response headers |
|
|
423
|
+
|-------------|-------------|------------------|
|
|
424
|
+
|**200** | OK | - |
|
|
425
|
+
|
|
426
|
+
[[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)
|
|
427
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# QuotaOverview
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**fileUploadMb** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**defaultUserMb** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**totalMb** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**instanceUsedBytes** | **number** | | [optional] [default to undefined]
|
|
12
|
+
**instanceLimitBytes** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**userOverrides** | **number** | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { QuotaOverview } from '@openfilz-sdk/typescript-ee';
|
|
19
|
+
|
|
20
|
+
const instance: QuotaOverview = {
|
|
21
|
+
fileUploadMb,
|
|
22
|
+
defaultUserMb,
|
|
23
|
+
totalMb,
|
|
24
|
+
instanceUsedBytes,
|
|
25
|
+
instanceLimitBytes,
|
|
26
|
+
userOverrides,
|
|
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)
|