@openfilz-sdk/typescript-ee 1.11.0 → 1.12.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.
- package/.openapi-generator/FILES +30 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +38 -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/search-administration-api.ts +65 -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/search-administration-api.d.ts +28 -0
- package/dist/api/search-administration-api.js +62 -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/search-administration-api.d.ts +28 -0
- package/dist/esm/api/search-administration-api.js +62 -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/SearchAdministrationApi.md +45 -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
package/docs/AITeamInboxesApi.md
CHANGED
|
@@ -7,9 +7,9 @@ All URIs are relative to *http://localhost:8081*
|
|
|
7
7
|
|[**create2**](#create2) | **POST** /api/v1/admin/ai/team-inboxes | Create a team inbox|
|
|
8
8
|
|[**delete1**](#delete1) | **DELETE** /api/v1/admin/ai/team-inboxes/{id} | Delete a team inbox (the folder and its documents stay)|
|
|
9
9
|
|[**get3**](#get3) | **GET** /api/v1/admin/ai/team-inboxes/{id} | One team inbox, with its warnings|
|
|
10
|
-
|[**
|
|
10
|
+
|[**list3**](#list3) | **GET** /api/v1/admin/ai/team-inboxes | List the team inboxes|
|
|
11
11
|
|[**run**](#run) | **POST** /api/v1/admin/ai/team-inboxes/{id}/run | File the inbox now|
|
|
12
|
-
|[**
|
|
12
|
+
|[**update3**](#update3) | **PUT** /api/v1/admin/ai/team-inboxes/{id} | Replace a team inbox|
|
|
13
13
|
|
|
14
14
|
# **create2**
|
|
15
15
|
> TeamInboxView create2(teamInboxRequest)
|
|
@@ -163,8 +163,8 @@ const { status, data } = await apiInstance.get3(
|
|
|
163
163
|
|
|
164
164
|
[[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)
|
|
165
165
|
|
|
166
|
-
# **
|
|
167
|
-
> Array<TeamInboxView>
|
|
166
|
+
# **list3**
|
|
167
|
+
> Array<TeamInboxView> list3()
|
|
168
168
|
|
|
169
169
|
|
|
170
170
|
### Example
|
|
@@ -178,7 +178,7 @@ import {
|
|
|
178
178
|
const configuration = new Configuration();
|
|
179
179
|
const apiInstance = new AITeamInboxesApi(configuration);
|
|
180
180
|
|
|
181
|
-
const { status, data } = await apiInstance.
|
|
181
|
+
const { status, data } = await apiInstance.list3();
|
|
182
182
|
```
|
|
183
183
|
|
|
184
184
|
### Parameters
|
|
@@ -257,8 +257,8 @@ const { status, data } = await apiInstance.run(
|
|
|
257
257
|
|
|
258
258
|
[[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)
|
|
259
259
|
|
|
260
|
-
# **
|
|
261
|
-
> TeamInboxView
|
|
260
|
+
# **update3**
|
|
261
|
+
> TeamInboxView update3(teamInboxRequest)
|
|
262
262
|
|
|
263
263
|
|
|
264
264
|
### Example
|
|
@@ -276,7 +276,7 @@ const apiInstance = new AITeamInboxesApi(configuration);
|
|
|
276
276
|
let id: string; // (default to undefined)
|
|
277
277
|
let teamInboxRequest: TeamInboxRequest; //
|
|
278
278
|
|
|
279
|
-
const { status, data } = await apiInstance.
|
|
279
|
+
const { status, data } = await apiInstance.update3(
|
|
280
280
|
id,
|
|
281
281
|
teamInboxRequest
|
|
282
282
|
);
|
|
@@ -10,7 +10,7 @@ All URIs are relative to *http://localhost:8081*
|
|
|
10
10
|
|[**propose**](#propose) | **POST** /api/v1/admin/ai/archiving/propose | Propose an archiving plan now (admin only)|
|
|
11
11
|
|[**run1**](#run1) | **POST** /api/v1/admin/ai/archiving/schedules/{id}/run | Run an archiving schedule now|
|
|
12
12
|
|[**schedules**](#schedules) | **GET** /api/v1/admin/ai/archiving/schedules | List archiving schedules|
|
|
13
|
-
|[**
|
|
13
|
+
|[**update5**](#update5) | **PUT** /api/v1/admin/ai/archiving/schedules/{id} | Update an archiving schedule|
|
|
14
14
|
|
|
15
15
|
# **create4**
|
|
16
16
|
> ArchivingScheduleView create4(archivingScheduleRequest)
|
|
@@ -309,8 +309,8 @@ This endpoint does not have any parameters.
|
|
|
309
309
|
|
|
310
310
|
[[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)
|
|
311
311
|
|
|
312
|
-
# **
|
|
313
|
-
> ArchivingScheduleView
|
|
312
|
+
# **update5**
|
|
313
|
+
> ArchivingScheduleView update5(archivingScheduleRequest)
|
|
314
314
|
|
|
315
315
|
|
|
316
316
|
### Example
|
|
@@ -328,7 +328,7 @@ const apiInstance = new AiArchivingAdminControllerApi(configuration);
|
|
|
328
328
|
let id: string; // (default to undefined)
|
|
329
329
|
let archivingScheduleRequest: ArchivingScheduleRequest; //
|
|
330
330
|
|
|
331
|
-
const { status, data } = await apiInstance.
|
|
331
|
+
const { status, data } = await apiInstance.update5(
|
|
332
332
|
id,
|
|
333
333
|
archivingScheduleRequest
|
|
334
334
|
);
|
|
@@ -8,7 +8,7 @@ All URIs are relative to *http://localhost:8081*
|
|
|
8
8
|
|[**create1**](#create1) | **POST** /api/v1/signature-templates | Create a template|
|
|
9
9
|
|[**get1**](#get1) | **GET** /api/v1/signature-templates/{id} | Get a template|
|
|
10
10
|
|[**instantiate**](#instantiate) | **POST** /api/v1/signature-templates/{id}/envelopes | Create (and send) an envelope from a template|
|
|
11
|
-
|[**
|
|
11
|
+
|[**list1**](#list1) | **GET** /api/v1/signature-templates | List my templates|
|
|
12
12
|
|[**update1**](#update1) | **PUT** /api/v1/signature-templates/{id} | Update a template|
|
|
13
13
|
|
|
14
14
|
# **_delete**
|
|
@@ -216,8 +216,8 @@ const { status, data } = await apiInstance.instantiate(
|
|
|
216
216
|
|
|
217
217
|
[[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)
|
|
218
218
|
|
|
219
|
-
# **
|
|
220
|
-
> Array<SignatureTemplateDTO>
|
|
219
|
+
# **list1**
|
|
220
|
+
> Array<SignatureTemplateDTO> list1()
|
|
221
221
|
|
|
222
222
|
|
|
223
223
|
### Example
|
|
@@ -231,7 +231,7 @@ import {
|
|
|
231
231
|
const configuration = new Configuration();
|
|
232
232
|
const apiInstance = new ESignTemplatesApi(configuration);
|
|
233
233
|
|
|
234
|
-
const { status, data } = await apiInstance.
|
|
234
|
+
const { status, data } = await apiInstance.list1();
|
|
235
235
|
```
|
|
236
236
|
|
|
237
237
|
### Parameters
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ErrorResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**error** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ErrorResponse } from '@openfilz-sdk/typescript-ee';
|
|
16
|
+
|
|
17
|
+
const instance: ErrorResponse = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
error,
|
|
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
|
+
# McpAgentTokenConfig
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**tokensEnabled** | **boolean** | openfilz.mcp.tokens.enabled — minting and agent-token authentication | [optional] [default to undefined]
|
|
9
|
+
**mcpActive** | **boolean** | openfilz.mcp.active — the /mcp endpoint itself | [optional] [default to undefined]
|
|
10
|
+
**mcpMode** | **string** | openfilz.mcp.mode — deployment-wide cap applied on top of each token\'s mode | [optional] [default to undefined]
|
|
11
|
+
**defaultTtlSeconds** | **number** | | [optional] [default to undefined]
|
|
12
|
+
**maxTtlSeconds** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**mcpUrl** | **string** | Public URL of the MCP endpoint, for the client snippet shown after minting | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { McpAgentTokenConfig } from '@openfilz-sdk/typescript-ee';
|
|
19
|
+
|
|
20
|
+
const instance: McpAgentTokenConfig = {
|
|
21
|
+
tokensEnabled,
|
|
22
|
+
mcpActive,
|
|
23
|
+
mcpMode,
|
|
24
|
+
defaultTtlSeconds,
|
|
25
|
+
maxTtlSeconds,
|
|
26
|
+
mcpUrl,
|
|
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)
|
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**revokedAt** | **string** | | [optional] [default to undefined]
|
|
15
15
|
**createdBy** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**createdAt** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**lastUsedAt** | **string** | | [optional] [default to undefined]
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -30,6 +31,7 @@ const instance: McpAgentTokenInfo = {
|
|
|
30
31
|
revokedAt,
|
|
31
32
|
createdBy,
|
|
32
33
|
createdAt,
|
|
34
|
+
lastUsedAt,
|
|
33
35
|
};
|
|
34
36
|
```
|
|
35
37
|
|
|
@@ -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
|
+
|