@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
|
@@ -107,5 +107,9 @@ export declare const SearchByAuditLogRequestActionEnum: {
|
|
|
107
107
|
readonly ArchiveDeposit: "ARCHIVE_DEPOSIT";
|
|
108
108
|
readonly RestoreFromArchive: "RESTORE_FROM_ARCHIVE";
|
|
109
109
|
readonly ArchiveOwnerReassigned: "ARCHIVE_OWNER_REASSIGNED";
|
|
110
|
+
readonly McpAgentTokenMinted: "MCP_AGENT_TOKEN_MINTED";
|
|
111
|
+
readonly McpAgentTokenRevoked: "MCP_AGENT_TOKEN_REVOKED";
|
|
112
|
+
readonly AdminSettingChanged: "ADMIN_SETTING_CHANGED";
|
|
113
|
+
readonly OrganisationAiMaintenanceStarted: "ORGANISATION_AI_MAINTENANCE_STARTED";
|
|
110
114
|
};
|
|
111
115
|
export type SearchByAuditLogRequestActionEnum = typeof SearchByAuditLogRequestActionEnum[keyof typeof SearchByAuditLogRequestActionEnum];
|
|
@@ -84,4 +84,8 @@ exports.SearchByAuditLogRequestActionEnum = {
|
|
|
84
84
|
ArchiveDeposit: 'ARCHIVE_DEPOSIT',
|
|
85
85
|
RestoreFromArchive: 'RESTORE_FROM_ARCHIVE',
|
|
86
86
|
ArchiveOwnerReassigned: 'ARCHIVE_OWNER_REASSIGNED',
|
|
87
|
+
McpAgentTokenMinted: 'MCP_AGENT_TOKEN_MINTED',
|
|
88
|
+
McpAgentTokenRevoked: 'MCP_AGENT_TOKEN_REVOKED',
|
|
89
|
+
AdminSettingChanged: 'ADMIN_SETTING_CHANGED',
|
|
90
|
+
OrganisationAiMaintenanceStarted: 'ORGANISATION_AI_MAINTENANCE_STARTED',
|
|
87
91
|
};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* openfilz-api
|
|
3
|
+
* API for Document Management System
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface SettingDto {
|
|
13
|
+
'key'?: string;
|
|
14
|
+
'section'?: string;
|
|
15
|
+
'type'?: string;
|
|
16
|
+
'unit'?: string;
|
|
17
|
+
'min'?: number;
|
|
18
|
+
'max'?: number;
|
|
19
|
+
'allowedValues'?: Array<string>;
|
|
20
|
+
'value'?: string;
|
|
21
|
+
'deploymentValue'?: string;
|
|
22
|
+
'source'?: string;
|
|
23
|
+
'locked'?: boolean;
|
|
24
|
+
'updatedBy'?: string;
|
|
25
|
+
'updatedAt'?: string;
|
|
26
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* openfilz-api
|
|
6
|
+
* API for Document Management System
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* openfilz-api
|
|
3
|
+
* API for Document Management System
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface StartRequest {
|
|
13
|
+
'force'?: boolean;
|
|
14
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* openfilz-api
|
|
6
|
+
* API for Document Management System
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -10,8 +10,10 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { FileTypeStats } from './file-type-stats';
|
|
13
|
+
import type { MyStorageQuota } from './my-storage-quota';
|
|
13
14
|
export interface StorageBreakdown {
|
|
14
15
|
'totalStorageUsed'?: number;
|
|
15
16
|
'totalStorageAvailable'?: number;
|
|
16
17
|
'fileTypeBreakdown'?: Array<FileTypeStats>;
|
|
18
|
+
'quota'?: MyStorageQuota;
|
|
17
19
|
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* openfilz-api
|
|
3
|
+
* API for Document Management System
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface TeamQuotaRequest {
|
|
13
|
+
/**
|
|
14
|
+
* Per-member limit in MB; 0 = members exempt
|
|
15
|
+
*/
|
|
16
|
+
'quotaMb'?: number;
|
|
17
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* openfilz-api
|
|
6
|
+
* API for Document Management System
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* openfilz-api
|
|
3
|
+
* API for Document Management System
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface TeamQuotaView {
|
|
13
|
+
'teamId'?: string;
|
|
14
|
+
'name'?: string;
|
|
15
|
+
'quotaMb'?: number;
|
|
16
|
+
'members'?: number;
|
|
17
|
+
'usedBytes'?: number;
|
|
18
|
+
'largestMemberBytes'?: number;
|
|
19
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* openfilz-api
|
|
6
|
+
* API for Document Management System
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* openfilz-api
|
|
3
|
+
* API for Document Management System
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface UserQuotaRequest {
|
|
13
|
+
/**
|
|
14
|
+
* Limit in MB; 0 = no limit for this user
|
|
15
|
+
*/
|
|
16
|
+
'quotaMb'?: number;
|
|
17
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* openfilz-api
|
|
6
|
+
* API for Document Management System
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/docs/AIFilingRulesApi.md
CHANGED
|
@@ -8,9 +8,9 @@ All URIs are relative to *http://localhost:8081*
|
|
|
8
8
|
|[**delete2**](#delete2) | **DELETE** /api/v1/admin/ai/filing-rules/{id} | Delete a filing rule (its events go with it)|
|
|
9
9
|
|[**events1**](#events1) | **GET** /api/v1/admin/ai/filing-rules/{id}/events | What the rule did lately (MATCHED / DRY_RUN / SKIPPED), newest first|
|
|
10
10
|
|[**get6**](#get6) | **GET** /api/v1/admin/ai/filing-rules/{id} | One filing rule|
|
|
11
|
-
|[**
|
|
11
|
+
|[**list4**](#list4) | **GET** /api/v1/admin/ai/filing-rules | List the filing rules, by priority|
|
|
12
12
|
|[**test**](#test) | **POST** /api/v1/admin/ai/filing-rules/{id}/test | Dry evaluation of the rule against an existing document|
|
|
13
|
-
|[**
|
|
13
|
+
|[**update4**](#update4) | **PUT** /api/v1/admin/ai/filing-rules/{id} | Replace a filing rule|
|
|
14
14
|
|
|
15
15
|
# **create3**
|
|
16
16
|
> FilingRuleView create3(filingRuleRequest)
|
|
@@ -217,8 +217,8 @@ const { status, data } = await apiInstance.get6(
|
|
|
217
217
|
|
|
218
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
219
|
|
|
220
|
-
# **
|
|
221
|
-
> Array<FilingRuleView>
|
|
220
|
+
# **list4**
|
|
221
|
+
> Array<FilingRuleView> list4()
|
|
222
222
|
|
|
223
223
|
|
|
224
224
|
### Example
|
|
@@ -232,7 +232,7 @@ import {
|
|
|
232
232
|
const configuration = new Configuration();
|
|
233
233
|
const apiInstance = new AIFilingRulesApi(configuration);
|
|
234
234
|
|
|
235
|
-
const { status, data } = await apiInstance.
|
|
235
|
+
const { status, data } = await apiInstance.list4();
|
|
236
236
|
```
|
|
237
237
|
|
|
238
238
|
### Parameters
|
|
@@ -315,8 +315,8 @@ const { status, data } = await apiInstance.test(
|
|
|
315
315
|
|
|
316
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
317
|
|
|
318
|
-
# **
|
|
319
|
-
> FilingRuleView
|
|
318
|
+
# **update4**
|
|
319
|
+
> FilingRuleView update4(filingRuleRequest)
|
|
320
320
|
|
|
321
321
|
|
|
322
322
|
### Example
|
|
@@ -334,7 +334,7 @@ const apiInstance = new AIFilingRulesApi(configuration);
|
|
|
334
334
|
let id: string; // (default to undefined)
|
|
335
335
|
let filingRuleRequest: FilingRuleRequest; //
|
|
336
336
|
|
|
337
|
-
const { status, data } = await apiInstance.
|
|
337
|
+
const { status, data } = await apiInstance.update4(
|
|
338
338
|
id,
|
|
339
339
|
filingRuleRequest
|
|
340
340
|
);
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
# AIMaintenanceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:8081*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**jobs1**](#jobs1) | **GET** /api/v1/admin/ai/maintenance/jobs | |
|
|
8
|
+
|[**overview1**](#overview1) | **GET** /api/v1/admin/ai/maintenance | What can run here, and the recent library-wide jobs of this instance|
|
|
9
|
+
|[**start2**](#start2) | **POST** /api/v1/admin/ai/maintenance/{kind} | Start a library-wide job: embeddings (re-embed) or insights (re-enrich). force=true redoes documents that are already up to date|
|
|
10
|
+
|[**status2**](#status2) | **GET** /api/v1/admin/ai/maintenance/jobs/{jobId} | Progress of a library-wide job (sum of its per-owner jobs)|
|
|
11
|
+
|
|
12
|
+
# **jobs1**
|
|
13
|
+
> Array<JobStatus> jobs1()
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
AIMaintenanceApi,
|
|
21
|
+
Configuration
|
|
22
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new AIMaintenanceApi(configuration);
|
|
26
|
+
|
|
27
|
+
const { status, data } = await apiInstance.jobs1();
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Parameters
|
|
31
|
+
This endpoint does not have any parameters.
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### Return type
|
|
35
|
+
|
|
36
|
+
**Array<JobStatus>**
|
|
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
|
+
# **overview1**
|
|
56
|
+
> { [key: string]: any; } overview1()
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### Example
|
|
60
|
+
|
|
61
|
+
```typescript
|
|
62
|
+
import {
|
|
63
|
+
AIMaintenanceApi,
|
|
64
|
+
Configuration
|
|
65
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
66
|
+
|
|
67
|
+
const configuration = new Configuration();
|
|
68
|
+
const apiInstance = new AIMaintenanceApi(configuration);
|
|
69
|
+
|
|
70
|
+
const { status, data } = await apiInstance.overview1();
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Parameters
|
|
74
|
+
This endpoint does not have any parameters.
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
### Return type
|
|
78
|
+
|
|
79
|
+
**{ [key: string]: any; }**
|
|
80
|
+
|
|
81
|
+
### Authorization
|
|
82
|
+
|
|
83
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
84
|
+
|
|
85
|
+
### HTTP request headers
|
|
86
|
+
|
|
87
|
+
- **Content-Type**: Not defined
|
|
88
|
+
- **Accept**: */*
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
### HTTP response details
|
|
92
|
+
| Status code | Description | Response headers |
|
|
93
|
+
|-------------|-------------|------------------|
|
|
94
|
+
|**200** | OK | - |
|
|
95
|
+
|
|
96
|
+
[[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)
|
|
97
|
+
|
|
98
|
+
# **start2**
|
|
99
|
+
> JobStatus start2()
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
### Example
|
|
103
|
+
|
|
104
|
+
```typescript
|
|
105
|
+
import {
|
|
106
|
+
AIMaintenanceApi,
|
|
107
|
+
Configuration,
|
|
108
|
+
StartRequest
|
|
109
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
110
|
+
|
|
111
|
+
const configuration = new Configuration();
|
|
112
|
+
const apiInstance = new AIMaintenanceApi(configuration);
|
|
113
|
+
|
|
114
|
+
let kind: string; // (default to undefined)
|
|
115
|
+
let startRequest: StartRequest; // (optional)
|
|
116
|
+
|
|
117
|
+
const { status, data } = await apiInstance.start2(
|
|
118
|
+
kind,
|
|
119
|
+
startRequest
|
|
120
|
+
);
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Parameters
|
|
124
|
+
|
|
125
|
+
|Name | Type | Description | Notes|
|
|
126
|
+
|------------- | ------------- | ------------- | -------------|
|
|
127
|
+
| **startRequest** | **StartRequest**| | |
|
|
128
|
+
| **kind** | [**string**] | | defaults to undefined|
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
### Return type
|
|
132
|
+
|
|
133
|
+
**JobStatus**
|
|
134
|
+
|
|
135
|
+
### Authorization
|
|
136
|
+
|
|
137
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
138
|
+
|
|
139
|
+
### HTTP request headers
|
|
140
|
+
|
|
141
|
+
- **Content-Type**: application/json
|
|
142
|
+
- **Accept**: */*
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
### HTTP response details
|
|
146
|
+
| Status code | Description | Response headers |
|
|
147
|
+
|-------------|-------------|------------------|
|
|
148
|
+
|**202** | Accepted | - |
|
|
149
|
+
|
|
150
|
+
[[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)
|
|
151
|
+
|
|
152
|
+
# **status2**
|
|
153
|
+
> JobStatus status2()
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
### Example
|
|
157
|
+
|
|
158
|
+
```typescript
|
|
159
|
+
import {
|
|
160
|
+
AIMaintenanceApi,
|
|
161
|
+
Configuration
|
|
162
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
163
|
+
|
|
164
|
+
const configuration = new Configuration();
|
|
165
|
+
const apiInstance = new AIMaintenanceApi(configuration);
|
|
166
|
+
|
|
167
|
+
let jobId: string; // (default to undefined)
|
|
168
|
+
|
|
169
|
+
const { status, data } = await apiInstance.status2(
|
|
170
|
+
jobId
|
|
171
|
+
);
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### Parameters
|
|
175
|
+
|
|
176
|
+
|Name | Type | Description | Notes|
|
|
177
|
+
|------------- | ------------- | ------------- | -------------|
|
|
178
|
+
| **jobId** | [**string**] | | defaults to undefined|
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
### Return type
|
|
182
|
+
|
|
183
|
+
**JobStatus**
|
|
184
|
+
|
|
185
|
+
### Authorization
|
|
186
|
+
|
|
187
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
188
|
+
|
|
189
|
+
### HTTP request headers
|
|
190
|
+
|
|
191
|
+
- **Content-Type**: Not defined
|
|
192
|
+
- **Accept**: */*
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
### HTTP response details
|
|
196
|
+
| Status code | Description | Response headers |
|
|
197
|
+
|-------------|-------------|------------------|
|
|
198
|
+
|**200** | OK | - |
|
|
199
|
+
|
|
200
|
+
[[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)
|
|
201
|
+
|
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
|
|