@openfilz-sdk/typescript-ee 1.9.11 → 1.10.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 +82 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +75 -5
- package/api/ai-analytics-admin-controller-api.ts +137 -0
- package/api/ai-archiving-admin-controller-api.ts +568 -0
- package/api/ai-cloud-usage-admin-controller-api.ts +121 -0
- package/api/aichat-api.ts +9 -9
- package/api/aidirectory-api.ts +121 -0
- package/api/aifiling-rules-api.ts +585 -0
- package/api/aigovernance-api.ts +194 -0
- package/api/aitaxonomy-api.ts +345 -0
- package/api/aiteam-inboxes-api.ts +491 -0
- package/api/archive-controller-api.ts +440 -0
- package/api/collaboration-audit-controller-api.ts +67 -0
- package/api/document-controller-api.ts +74 -0
- package/api/document-insights-api.ts +71 -4
- package/api/esign-api.ts +9 -9
- package/api/esign-enterprise-api.ts +9 -9
- package/api/settings-api.ts +18 -11
- package/api/smart-filing-api.ts +73 -0
- package/api.ts +9 -0
- package/dist/api/ai-analytics-admin-controller-api.d.ts +71 -0
- package/dist/api/ai-analytics-admin-controller-api.js +139 -0
- package/dist/api/ai-archiving-admin-controller-api.d.ts +262 -0
- package/dist/api/ai-archiving-admin-controller-api.js +548 -0
- package/dist/api/ai-cloud-usage-admin-controller-api.d.ts +63 -0
- package/dist/api/ai-cloud-usage-admin-controller-api.js +125 -0
- package/dist/api/aichat-api.d.ts +4 -4
- package/dist/api/aichat-api.js +9 -9
- package/dist/api/aidirectory-api.d.ts +63 -0
- package/dist/api/aidirectory-api.js +125 -0
- package/dist/api/aifiling-rules-api.d.ts +271 -0
- package/dist/api/aifiling-rules-api.js +562 -0
- package/dist/api/aigovernance-api.d.ts +95 -0
- package/dist/api/aigovernance-api.js +195 -0
- package/dist/api/aitaxonomy-api.d.ts +162 -0
- package/dist/api/aitaxonomy-api.js +334 -0
- package/dist/api/aiteam-inboxes-api.d.ts +228 -0
- package/dist/api/aiteam-inboxes-api.js +478 -0
- package/dist/api/archive-controller-api.d.ts +239 -0
- package/dist/api/archive-controller-api.js +430 -0
- package/dist/api/collaboration-audit-controller-api.d.ts +29 -0
- package/dist/api/collaboration-audit-controller-api.js +62 -0
- package/dist/api/document-controller-api.d.ts +33 -0
- package/dist/api/document-controller-api.js +69 -0
- package/dist/api/document-insights-api.d.ts +33 -4
- package/dist/api/document-insights-api.js +66 -4
- package/dist/api/esign-api.d.ts +4 -4
- package/dist/api/esign-api.js +9 -9
- package/dist/api/esign-enterprise-api.d.ts +4 -4
- package/dist/api/esign-enterprise-api.js +9 -9
- package/dist/api/settings-api.d.ts +12 -8
- package/dist/api/settings-api.js +18 -11
- package/dist/api/smart-filing-api.d.ts +33 -0
- package/dist/api/smart-filing-api.js +68 -0
- package/dist/api.d.ts +9 -0
- package/dist/api.js +9 -0
- package/dist/esm/api/ai-analytics-admin-controller-api.d.ts +71 -0
- package/dist/esm/api/ai-analytics-admin-controller-api.js +132 -0
- package/dist/esm/api/ai-archiving-admin-controller-api.d.ts +262 -0
- package/dist/esm/api/ai-archiving-admin-controller-api.js +541 -0
- package/dist/esm/api/ai-cloud-usage-admin-controller-api.d.ts +63 -0
- package/dist/esm/api/ai-cloud-usage-admin-controller-api.js +118 -0
- package/dist/esm/api/aichat-api.d.ts +4 -4
- package/dist/esm/api/aichat-api.js +9 -9
- package/dist/esm/api/aidirectory-api.d.ts +63 -0
- package/dist/esm/api/aidirectory-api.js +118 -0
- package/dist/esm/api/aifiling-rules-api.d.ts +271 -0
- package/dist/esm/api/aifiling-rules-api.js +555 -0
- package/dist/esm/api/aigovernance-api.d.ts +95 -0
- package/dist/esm/api/aigovernance-api.js +188 -0
- package/dist/esm/api/aitaxonomy-api.d.ts +162 -0
- package/dist/esm/api/aitaxonomy-api.js +327 -0
- package/dist/esm/api/aiteam-inboxes-api.d.ts +228 -0
- package/dist/esm/api/aiteam-inboxes-api.js +471 -0
- package/dist/esm/api/archive-controller-api.d.ts +239 -0
- package/dist/esm/api/archive-controller-api.js +423 -0
- package/dist/esm/api/collaboration-audit-controller-api.d.ts +29 -0
- package/dist/esm/api/collaboration-audit-controller-api.js +62 -0
- package/dist/esm/api/document-controller-api.d.ts +33 -0
- package/dist/esm/api/document-controller-api.js +69 -0
- package/dist/esm/api/document-insights-api.d.ts +33 -4
- package/dist/esm/api/document-insights-api.js +66 -4
- package/dist/esm/api/esign-api.d.ts +4 -4
- package/dist/esm/api/esign-api.js +9 -9
- package/dist/esm/api/esign-enterprise-api.d.ts +4 -4
- package/dist/esm/api/esign-enterprise-api.js +9 -9
- package/dist/esm/api/settings-api.d.ts +12 -8
- package/dist/esm/api/settings-api.js +18 -11
- package/dist/esm/api/smart-filing-api.d.ts +33 -0
- package/dist/esm/api/smart-filing-api.js +68 -0
- package/dist/esm/api.d.ts +9 -0
- package/dist/esm/api.js +9 -0
- package/dist/esm/models/ai-analytics-view.d.ts +25 -0
- package/dist/esm/models/ai-analytics-view.js +14 -0
- package/dist/esm/models/ai-cloud-usage-view.d.ts +33 -0
- package/dist/esm/models/ai-cloud-usage-view.js +19 -0
- package/dist/esm/models/ai-governance-settings.d.ts +22 -0
- package/dist/esm/models/ai-governance-settings.js +14 -0
- package/dist/esm/models/ai-preferences-view.d.ts +3 -0
- package/dist/esm/models/ai-taxonomy-category.d.ts +19 -0
- package/dist/esm/models/ai-taxonomy-category.js +14 -0
- package/dist/esm/models/ai-taxonomy-rename-request.d.ts +16 -0
- package/dist/esm/models/ai-taxonomy-rename-request.js +14 -0
- package/dist/esm/models/ai-taxonomy-rename-result.d.ts +17 -0
- package/dist/esm/models/ai-taxonomy-rename-result.js +14 -0
- package/dist/esm/models/ai-taxonomy-view.d.ts +16 -0
- package/dist/esm/models/ai-taxonomy-view.js +14 -0
- package/dist/esm/models/archive-preflight.d.ts +38 -0
- package/dist/esm/models/archive-preflight.js +14 -0
- package/dist/esm/models/archiving-proposal-request.d.ts +19 -0
- package/dist/esm/models/archiving-proposal-request.js +14 -0
- package/dist/esm/models/archiving-proposal-result.d.ts +19 -0
- package/dist/esm/models/archiving-proposal-result.js +14 -0
- package/dist/esm/models/archiving-schedule-request.d.ts +22 -0
- package/dist/esm/models/archiving-schedule-request.js +14 -0
- package/dist/esm/models/archiving-schedule-view.d.ts +29 -0
- package/dist/esm/models/archiving-schedule-view.js +14 -0
- package/dist/esm/models/audit-integrity-status-response.d.ts +37 -0
- package/dist/esm/models/audit-integrity-status-response.js +14 -0
- package/dist/esm/models/auto-file-inbox-request.d.ts +14 -0
- package/dist/esm/models/auto-file-inbox-request.js +14 -0
- package/dist/esm/models/consume-delegated-grant-request.d.ts +1 -1
- package/dist/esm/models/corrections.d.ts +16 -0
- package/dist/esm/models/corrections.js +14 -0
- package/dist/esm/models/create-delegated-grant-request.d.ts +2 -1
- package/dist/esm/models/create-delegated-grant-request.js +1 -0
- package/dist/esm/models/day-count.d.ts +16 -0
- package/dist/esm/models/day-count.js +14 -0
- package/dist/esm/models/delegated-grant-dto.d.ts +1 -0
- package/dist/esm/models/delegated-grant-dto.js +1 -0
- package/dist/esm/models/document-integrity-record.d.ts +23 -0
- package/dist/esm/models/document-integrity-record.js +14 -0
- package/dist/esm/models/enriched-audit-log.d.ts +3 -0
- package/dist/esm/models/enriched-audit-log.js +3 -0
- package/dist/esm/models/facet.d.ts +15 -0
- package/dist/esm/models/facet.js +14 -0
- package/dist/esm/models/filing-rule-event-view.d.ts +19 -0
- package/dist/esm/models/filing-rule-event-view.js +14 -0
- package/dist/esm/models/filing-rule-request.d.ts +47 -0
- package/dist/esm/models/filing-rule-request.js +14 -0
- package/dist/esm/models/filing-rule-test-request.d.ts +14 -0
- package/dist/esm/models/filing-rule-test-request.js +14 -0
- package/dist/esm/models/filing-rule-test-result.d.ts +22 -0
- package/dist/esm/models/filing-rule-test-result.js +14 -0
- package/dist/esm/models/filing-rule-view.d.ts +30 -0
- package/dist/esm/models/filing-rule-view.js +14 -0
- package/dist/esm/models/filing.d.ts +24 -0
- package/dist/esm/models/filing.js +14 -0
- package/dist/esm/models/foreign-item.d.ts +19 -0
- package/dist/esm/models/foreign-item.js +14 -0
- package/dist/esm/models/index.d.ts +32 -0
- package/dist/esm/models/index.js +32 -0
- package/dist/esm/models/insight-facets.d.ts +16 -0
- package/dist/esm/models/insight-facets.js +14 -0
- package/dist/esm/models/insights.d.ts +21 -0
- package/dist/esm/models/insights.js +14 -0
- package/dist/esm/models/key-count.d.ts +15 -0
- package/dist/esm/models/key-count.js +14 -0
- package/dist/esm/models/save-ai-preferences-request.d.ts +1 -0
- package/dist/esm/models/scan-request-dto.d.ts +3 -0
- package/dist/esm/models/search-by-audit-log-request.d.ts +3 -0
- package/dist/esm/models/search-by-audit-log-request.js +3 -0
- package/dist/esm/models/settings.d.ts +1 -0
- package/dist/esm/models/team-inbox-request.d.ts +24 -0
- package/dist/esm/models/team-inbox-request.js +14 -0
- package/dist/esm/models/team-inbox-view.d.ts +31 -0
- package/dist/esm/models/team-inbox-view.js +14 -0
- package/dist/esm/models/team-option-view.d.ts +25 -0
- package/dist/esm/models/team-option-view.js +14 -0
- package/dist/esm/models/untouched.d.ts +16 -0
- package/dist/esm/models/untouched.js +14 -0
- package/dist/models/ai-analytics-view.d.ts +25 -0
- package/dist/models/ai-analytics-view.js +15 -0
- package/dist/models/ai-cloud-usage-view.d.ts +33 -0
- package/dist/models/ai-cloud-usage-view.js +22 -0
- package/dist/models/ai-governance-settings.d.ts +22 -0
- package/dist/models/ai-governance-settings.js +15 -0
- package/dist/models/ai-preferences-view.d.ts +3 -0
- package/dist/models/ai-taxonomy-category.d.ts +19 -0
- package/dist/models/ai-taxonomy-category.js +15 -0
- package/dist/models/ai-taxonomy-rename-request.d.ts +16 -0
- package/dist/models/ai-taxonomy-rename-request.js +15 -0
- package/dist/models/ai-taxonomy-rename-result.d.ts +17 -0
- package/dist/models/ai-taxonomy-rename-result.js +15 -0
- package/dist/models/ai-taxonomy-view.d.ts +16 -0
- package/dist/models/ai-taxonomy-view.js +15 -0
- package/dist/models/archive-preflight.d.ts +38 -0
- package/dist/models/archive-preflight.js +15 -0
- package/dist/models/archiving-proposal-request.d.ts +19 -0
- package/dist/models/archiving-proposal-request.js +15 -0
- package/dist/models/archiving-proposal-result.d.ts +19 -0
- package/dist/models/archiving-proposal-result.js +15 -0
- package/dist/models/archiving-schedule-request.d.ts +22 -0
- package/dist/models/archiving-schedule-request.js +15 -0
- package/dist/models/archiving-schedule-view.d.ts +29 -0
- package/dist/models/archiving-schedule-view.js +15 -0
- package/dist/models/audit-integrity-status-response.d.ts +37 -0
- package/dist/models/audit-integrity-status-response.js +15 -0
- package/dist/models/auto-file-inbox-request.d.ts +14 -0
- package/dist/models/auto-file-inbox-request.js +15 -0
- package/dist/models/consume-delegated-grant-request.d.ts +1 -1
- package/dist/models/corrections.d.ts +16 -0
- package/dist/models/corrections.js +15 -0
- package/dist/models/create-delegated-grant-request.d.ts +2 -1
- package/dist/models/create-delegated-grant-request.js +1 -0
- package/dist/models/day-count.d.ts +16 -0
- package/dist/models/day-count.js +15 -0
- package/dist/models/delegated-grant-dto.d.ts +1 -0
- package/dist/models/delegated-grant-dto.js +1 -0
- package/dist/models/document-integrity-record.d.ts +23 -0
- package/dist/models/document-integrity-record.js +15 -0
- package/dist/models/enriched-audit-log.d.ts +3 -0
- package/dist/models/enriched-audit-log.js +3 -0
- package/dist/models/facet.d.ts +15 -0
- package/dist/models/facet.js +15 -0
- package/dist/models/filing-rule-event-view.d.ts +19 -0
- package/dist/models/filing-rule-event-view.js +15 -0
- package/dist/models/filing-rule-request.d.ts +47 -0
- package/dist/models/filing-rule-request.js +15 -0
- package/dist/models/filing-rule-test-request.d.ts +14 -0
- package/dist/models/filing-rule-test-request.js +15 -0
- package/dist/models/filing-rule-test-result.d.ts +22 -0
- package/dist/models/filing-rule-test-result.js +15 -0
- package/dist/models/filing-rule-view.d.ts +30 -0
- package/dist/models/filing-rule-view.js +15 -0
- package/dist/models/filing.d.ts +24 -0
- package/dist/models/filing.js +15 -0
- package/dist/models/foreign-item.d.ts +19 -0
- package/dist/models/foreign-item.js +15 -0
- package/dist/models/index.d.ts +32 -0
- package/dist/models/index.js +32 -0
- package/dist/models/insight-facets.d.ts +16 -0
- package/dist/models/insight-facets.js +15 -0
- package/dist/models/insights.d.ts +21 -0
- package/dist/models/insights.js +15 -0
- package/dist/models/key-count.d.ts +15 -0
- package/dist/models/key-count.js +15 -0
- package/dist/models/save-ai-preferences-request.d.ts +1 -0
- package/dist/models/scan-request-dto.d.ts +3 -0
- package/dist/models/search-by-audit-log-request.d.ts +3 -0
- package/dist/models/search-by-audit-log-request.js +3 -0
- package/dist/models/settings.d.ts +1 -0
- package/dist/models/team-inbox-request.d.ts +24 -0
- package/dist/models/team-inbox-request.js +15 -0
- package/dist/models/team-inbox-view.d.ts +31 -0
- package/dist/models/team-inbox-view.js +15 -0
- package/dist/models/team-option-view.d.ts +25 -0
- package/dist/models/team-option-view.js +15 -0
- package/dist/models/untouched.d.ts +16 -0
- package/dist/models/untouched.js +15 -0
- package/docs/AIChatApi.md +4 -4
- package/docs/AIDirectoryApi.md +51 -0
- package/docs/AIFilingRulesApi.md +371 -0
- package/docs/AIGovernanceApi.md +104 -0
- package/docs/AITaxonomyApi.md +204 -0
- package/docs/AITeamInboxesApi.md +313 -0
- package/docs/AiAnalyticsAdminControllerApi.md +62 -0
- package/docs/AiAnalyticsView.md +32 -0
- package/docs/AiArchivingAdminControllerApi.md +365 -0
- package/docs/AiCloudUsageAdminControllerApi.md +52 -0
- package/docs/AiCloudUsageView.md +44 -0
- package/docs/AiGovernanceSettings.md +36 -0
- package/docs/AiPreferencesView.md +6 -0
- package/docs/AiTaxonomyCategory.md +30 -0
- package/docs/AiTaxonomyRenameRequest.md +24 -0
- package/docs/AiTaxonomyRenameResult.md +26 -0
- package/docs/AiTaxonomyView.md +22 -0
- package/docs/ArchiveControllerApi.md +276 -0
- package/docs/ArchivePreflight.md +29 -0
- package/docs/ArchivingProposalRequest.md +30 -0
- package/docs/ArchivingProposalResult.md +30 -0
- package/docs/ArchivingScheduleRequest.md +36 -0
- package/docs/ArchivingScheduleView.md +50 -0
- package/docs/AuditIntegrityStatusResponse.md +29 -0
- package/docs/AutoFileInboxRequest.md +20 -0
- package/docs/CollaborationAuditControllerApi.md +45 -0
- package/docs/ConsumeDelegatedGrantRequest.md +1 -1
- package/docs/Corrections.md +24 -0
- package/docs/CreateDelegatedGrantRequest.md +1 -1
- package/docs/DayCount.md +24 -0
- package/docs/DocumentControllerApi.md +52 -0
- package/docs/DocumentInsightsApi.md +46 -1
- package/docs/DocumentIntegrityRecord.md +33 -0
- package/docs/ESignApi.md +4 -4
- package/docs/ESignEnterpriseApi.md +4 -4
- package/docs/Facet.md +22 -0
- package/docs/Filing.md +32 -0
- package/docs/FilingRuleEventView.md +30 -0
- package/docs/FilingRuleRequest.md +44 -0
- package/docs/FilingRuleTestRequest.md +20 -0
- package/docs/FilingRuleTestResult.md +36 -0
- package/docs/FilingRuleView.md +52 -0
- package/docs/ForeignItem.md +25 -0
- package/docs/InsightFacets.md +22 -0
- package/docs/Insights.md +34 -0
- package/docs/KeyCount.md +22 -0
- package/docs/SaveAiPreferencesRequest.md +2 -0
- package/docs/ScanRequestDto.md +6 -0
- package/docs/Settings.md +2 -0
- package/docs/SettingsApi.md +5 -2
- package/docs/SmartFilingApi.md +53 -0
- package/docs/TeamInboxRequest.md +34 -0
- package/docs/TeamInboxView.md +54 -0
- package/docs/TeamOptionView.md +24 -0
- package/docs/Untouched.md +24 -0
- package/graphql/document-search.graphqls +4 -0
- package/graphql/document.graphqls +4 -0
- package/models/ai-analytics-view.ts +41 -0
- package/models/ai-cloud-usage-view.ts +42 -0
- package/models/ai-governance-settings.ts +28 -0
- package/models/ai-preferences-view.ts +3 -0
- package/models/ai-taxonomy-category.ts +25 -0
- package/models/ai-taxonomy-rename-request.ts +22 -0
- package/models/ai-taxonomy-rename-result.ts +23 -0
- package/models/ai-taxonomy-view.ts +24 -0
- package/models/archive-preflight.ts +48 -0
- package/models/archiving-proposal-request.ts +25 -0
- package/models/archiving-proposal-result.ts +25 -0
- package/models/archiving-schedule-request.ts +28 -0
- package/models/archiving-schedule-view.ts +35 -0
- package/models/audit-integrity-status-response.ts +45 -0
- package/models/auto-file-inbox-request.ts +20 -0
- package/models/consume-delegated-grant-request.ts +1 -1
- package/models/corrections.ts +22 -0
- package/models/create-delegated-grant-request.ts +2 -1
- package/models/day-count.ts +22 -0
- package/models/delegated-grant-dto.ts +1 -0
- package/models/document-integrity-record.ts +29 -0
- package/models/enriched-audit-log.ts +3 -0
- package/models/facet.ts +21 -0
- package/models/filing-rule-event-view.ts +25 -0
- package/models/filing-rule-request.ts +53 -0
- package/models/filing-rule-test-request.ts +20 -0
- package/models/filing-rule-test-result.ts +28 -0
- package/models/filing-rule-view.ts +36 -0
- package/models/filing.ts +32 -0
- package/models/foreign-item.ts +25 -0
- package/models/index.ts +32 -0
- package/models/insight-facets.ts +24 -0
- package/models/insights.ts +27 -0
- package/models/key-count.ts +21 -0
- package/models/save-ai-preferences-request.ts +1 -0
- package/models/scan-request-dto.ts +3 -0
- package/models/search-by-audit-log-request.ts +3 -0
- package/models/settings.ts +1 -0
- package/models/team-inbox-request.ts +30 -0
- package/models/team-inbox-view.ts +37 -0
- package/models/team-option-view.ts +31 -0
- package/models/untouched.ts +22 -0
- package/package.json +1 -1
|
@@ -0,0 +1,430 @@
|
|
|
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
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.ArchiveControllerApi = exports.ArchiveControllerApiFactory = exports.ArchiveControllerApiFp = exports.ArchiveControllerApiAxiosParamCreator = void 0;
|
|
26
|
+
const axios_1 = require("axios");
|
|
27
|
+
// Some imports not used depending on template conditions
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
const common_1 = require("../common");
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
const base_1 = require("../base");
|
|
32
|
+
/**
|
|
33
|
+
* ArchiveControllerApi - axios parameter creator
|
|
34
|
+
*/
|
|
35
|
+
const ArchiveControllerApiAxiosParamCreator = function (configuration) {
|
|
36
|
+
return {
|
|
37
|
+
/**
|
|
38
|
+
* Copy to the archive, verify the fingerprint it recorded, then PERMANENTLY delete the source — even when soft delete is enabled, because a recycle-bin restore would resurrect a document that also lives in the archive. Owner only. Once this succeeds there is nothing to undo in this instance: recovery means restoring from the archive.
|
|
39
|
+
* @summary Archive a document
|
|
40
|
+
* @param {string} documentId
|
|
41
|
+
* @param {string} [onBehalfOf]
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
archive: (documentId_1, onBehalfOf_1, ...args_1) => __awaiter(this, [documentId_1, onBehalfOf_1, ...args_1], void 0, function* (documentId, onBehalfOf, options = {}) {
|
|
46
|
+
// verify required parameter 'documentId' is not null or undefined
|
|
47
|
+
(0, common_1.assertParamExists)('archive', 'documentId', documentId);
|
|
48
|
+
const localVarPath = `/api/v1/archive/documents/{documentId}`
|
|
49
|
+
.replace('{documentId}', encodeURIComponent(String(documentId)));
|
|
50
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
52
|
+
let baseOptions;
|
|
53
|
+
if (configuration) {
|
|
54
|
+
baseOptions = configuration.baseOptions;
|
|
55
|
+
}
|
|
56
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
57
|
+
const localVarHeaderParameter = {};
|
|
58
|
+
const localVarQueryParameter = {};
|
|
59
|
+
// authentication keycloak_auth required
|
|
60
|
+
// http bearer authentication required
|
|
61
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
62
|
+
if (onBehalfOf !== undefined) {
|
|
63
|
+
localVarQueryParameter['onBehalfOf'] = onBehalfOf;
|
|
64
|
+
}
|
|
65
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
66
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
67
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
68
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
69
|
+
return {
|
|
70
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
71
|
+
options: localVarRequestOptions,
|
|
72
|
+
};
|
|
73
|
+
}),
|
|
74
|
+
/**
|
|
75
|
+
* Partial by design: files owned by other people stay where they are, because only an owner may archive. Run the pre-flight first — it names what will be left behind and who owns it. Sequential, so a failure part-way leaves a state a human can read: what moved is in the archive, the rest is untouched here.
|
|
76
|
+
* @summary Archive the caller\'s own files in a folder subtree
|
|
77
|
+
* @param {string} folderId
|
|
78
|
+
* @param {*} [options] Override http request option.
|
|
79
|
+
* @throws {RequiredError}
|
|
80
|
+
*/
|
|
81
|
+
archiveFolder: (folderId_1, ...args_1) => __awaiter(this, [folderId_1, ...args_1], void 0, function* (folderId, options = {}) {
|
|
82
|
+
// verify required parameter 'folderId' is not null or undefined
|
|
83
|
+
(0, common_1.assertParamExists)('archiveFolder', 'folderId', folderId);
|
|
84
|
+
const localVarPath = `/api/v1/archive/folders/{folderId}`
|
|
85
|
+
.replace('{folderId}', encodeURIComponent(String(folderId)));
|
|
86
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
87
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
88
|
+
let baseOptions;
|
|
89
|
+
if (configuration) {
|
|
90
|
+
baseOptions = configuration.baseOptions;
|
|
91
|
+
}
|
|
92
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
93
|
+
const localVarHeaderParameter = {};
|
|
94
|
+
const localVarQueryParameter = {};
|
|
95
|
+
// authentication keycloak_auth required
|
|
96
|
+
// http bearer authentication required
|
|
97
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
98
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
99
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
100
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
101
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
102
|
+
return {
|
|
103
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
104
|
+
options: localVarRequestOptions,
|
|
105
|
+
};
|
|
106
|
+
}),
|
|
107
|
+
/**
|
|
108
|
+
* Computed before anything happens (§7.1): what will be archived, what stays behind because the caller does not own it (with the owners named), who loses a share, and how many comments the cascade destroys. Archiving hard-deletes the source even where soft delete is on, so this is a required step of the flow rather than a courtesy.
|
|
109
|
+
* @summary What archiving this would actually do
|
|
110
|
+
* @param {string} documentId
|
|
111
|
+
* @param {*} [options] Override http request option.
|
|
112
|
+
* @throws {RequiredError}
|
|
113
|
+
*/
|
|
114
|
+
preflight: (documentId_1, ...args_1) => __awaiter(this, [documentId_1, ...args_1], void 0, function* (documentId, options = {}) {
|
|
115
|
+
// verify required parameter 'documentId' is not null or undefined
|
|
116
|
+
(0, common_1.assertParamExists)('preflight', 'documentId', documentId);
|
|
117
|
+
const localVarPath = `/api/v1/archive/preflight/{documentId}`
|
|
118
|
+
.replace('{documentId}', encodeURIComponent(String(documentId)));
|
|
119
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
120
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
121
|
+
let baseOptions;
|
|
122
|
+
if (configuration) {
|
|
123
|
+
baseOptions = configuration.baseOptions;
|
|
124
|
+
}
|
|
125
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
126
|
+
const localVarHeaderParameter = {};
|
|
127
|
+
const localVarQueryParameter = {};
|
|
128
|
+
// authentication keycloak_auth required
|
|
129
|
+
// http bearer authentication required
|
|
130
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
131
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
132
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
133
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
134
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
135
|
+
return {
|
|
136
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
137
|
+
options: localVarRequestOptions,
|
|
138
|
+
};
|
|
139
|
+
}),
|
|
140
|
+
/**
|
|
141
|
+
* ADMIN only. Changes who may retrieve the document and nothing else: content, metadata, the deposit record and the integrity ledger stay frozen. Audited as ARCHIVE_OWNER_REASSIGNED. Refused when the deployment has disabled reassignment — 403 on a WORM instance, 404 elsewhere.
|
|
142
|
+
* @summary Hand custody of an archived document to another user
|
|
143
|
+
* @param {string} documentId
|
|
144
|
+
* @param {{ [key: string]: string; }} requestBody
|
|
145
|
+
* @param {*} [options] Override http request option.
|
|
146
|
+
* @throws {RequiredError}
|
|
147
|
+
*/
|
|
148
|
+
reassignOwner: (documentId_1, requestBody_1, ...args_1) => __awaiter(this, [documentId_1, requestBody_1, ...args_1], void 0, function* (documentId, requestBody, options = {}) {
|
|
149
|
+
// verify required parameter 'documentId' is not null or undefined
|
|
150
|
+
(0, common_1.assertParamExists)('reassignOwner', 'documentId', documentId);
|
|
151
|
+
// verify required parameter 'requestBody' is not null or undefined
|
|
152
|
+
(0, common_1.assertParamExists)('reassignOwner', 'requestBody', requestBody);
|
|
153
|
+
const localVarPath = `/api/v1/archive/documents/{documentId}/owner`
|
|
154
|
+
.replace('{documentId}', encodeURIComponent(String(documentId)));
|
|
155
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
156
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
157
|
+
let baseOptions;
|
|
158
|
+
if (configuration) {
|
|
159
|
+
baseOptions = configuration.baseOptions;
|
|
160
|
+
}
|
|
161
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
162
|
+
const localVarHeaderParameter = {};
|
|
163
|
+
const localVarQueryParameter = {};
|
|
164
|
+
// authentication keycloak_auth required
|
|
165
|
+
// http bearer authentication required
|
|
166
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
167
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
168
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
169
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
170
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
171
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
172
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(requestBody, localVarRequestOptions, configuration);
|
|
173
|
+
return {
|
|
174
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
175
|
+
options: localVarRequestOptions,
|
|
176
|
+
};
|
|
177
|
+
}),
|
|
178
|
+
/**
|
|
179
|
+
* Needs ARCHIVIST and CONTRIBUTOR. The archived original is untouched — a restore is a copy, never a move. The new document goes through the ordinary upload pipeline, so audit, checksum, indexing and antivirus all apply.
|
|
180
|
+
* @summary Restore an archived document into this instance
|
|
181
|
+
* @param {string} archiveDocumentId
|
|
182
|
+
* @param {string} [targetFolderId]
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
restore: (archiveDocumentId_1, targetFolderId_1, ...args_1) => __awaiter(this, [archiveDocumentId_1, targetFolderId_1, ...args_1], void 0, function* (archiveDocumentId, targetFolderId, options = {}) {
|
|
187
|
+
// verify required parameter 'archiveDocumentId' is not null or undefined
|
|
188
|
+
(0, common_1.assertParamExists)('restore', 'archiveDocumentId', archiveDocumentId);
|
|
189
|
+
const localVarPath = `/api/v1/archive/documents/{archiveDocumentId}/restore`
|
|
190
|
+
.replace('{archiveDocumentId}', encodeURIComponent(String(archiveDocumentId)));
|
|
191
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
192
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
193
|
+
let baseOptions;
|
|
194
|
+
if (configuration) {
|
|
195
|
+
baseOptions = configuration.baseOptions;
|
|
196
|
+
}
|
|
197
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
198
|
+
const localVarHeaderParameter = {};
|
|
199
|
+
const localVarQueryParameter = {};
|
|
200
|
+
// authentication keycloak_auth required
|
|
201
|
+
// http bearer authentication required
|
|
202
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
203
|
+
if (targetFolderId !== undefined) {
|
|
204
|
+
localVarQueryParameter['targetFolderId'] = targetFolderId;
|
|
205
|
+
}
|
|
206
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
207
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
208
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
209
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
210
|
+
return {
|
|
211
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
212
|
+
options: localVarRequestOptions,
|
|
213
|
+
};
|
|
214
|
+
}),
|
|
215
|
+
};
|
|
216
|
+
};
|
|
217
|
+
exports.ArchiveControllerApiAxiosParamCreator = ArchiveControllerApiAxiosParamCreator;
|
|
218
|
+
/**
|
|
219
|
+
* ArchiveControllerApi - functional programming interface
|
|
220
|
+
*/
|
|
221
|
+
const ArchiveControllerApiFp = function (configuration) {
|
|
222
|
+
const localVarAxiosParamCreator = (0, exports.ArchiveControllerApiAxiosParamCreator)(configuration);
|
|
223
|
+
return {
|
|
224
|
+
/**
|
|
225
|
+
* Copy to the archive, verify the fingerprint it recorded, then PERMANENTLY delete the source — even when soft delete is enabled, because a recycle-bin restore would resurrect a document that also lives in the archive. Owner only. Once this succeeds there is nothing to undo in this instance: recovery means restoring from the archive.
|
|
226
|
+
* @summary Archive a document
|
|
227
|
+
* @param {string} documentId
|
|
228
|
+
* @param {string} [onBehalfOf]
|
|
229
|
+
* @param {*} [options] Override http request option.
|
|
230
|
+
* @throws {RequiredError}
|
|
231
|
+
*/
|
|
232
|
+
archive(documentId, onBehalfOf, options) {
|
|
233
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
234
|
+
var _a, _b, _c;
|
|
235
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.archive(documentId, onBehalfOf, options);
|
|
236
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
237
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ArchiveControllerApi.archive']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
238
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
239
|
+
});
|
|
240
|
+
},
|
|
241
|
+
/**
|
|
242
|
+
* Partial by design: files owned by other people stay where they are, because only an owner may archive. Run the pre-flight first — it names what will be left behind and who owns it. Sequential, so a failure part-way leaves a state a human can read: what moved is in the archive, the rest is untouched here.
|
|
243
|
+
* @summary Archive the caller\'s own files in a folder subtree
|
|
244
|
+
* @param {string} folderId
|
|
245
|
+
* @param {*} [options] Override http request option.
|
|
246
|
+
* @throws {RequiredError}
|
|
247
|
+
*/
|
|
248
|
+
archiveFolder(folderId, options) {
|
|
249
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
250
|
+
var _a, _b, _c;
|
|
251
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.archiveFolder(folderId, options);
|
|
252
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
253
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ArchiveControllerApi.archiveFolder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
254
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
255
|
+
});
|
|
256
|
+
},
|
|
257
|
+
/**
|
|
258
|
+
* Computed before anything happens (§7.1): what will be archived, what stays behind because the caller does not own it (with the owners named), who loses a share, and how many comments the cascade destroys. Archiving hard-deletes the source even where soft delete is on, so this is a required step of the flow rather than a courtesy.
|
|
259
|
+
* @summary What archiving this would actually do
|
|
260
|
+
* @param {string} documentId
|
|
261
|
+
* @param {*} [options] Override http request option.
|
|
262
|
+
* @throws {RequiredError}
|
|
263
|
+
*/
|
|
264
|
+
preflight(documentId, options) {
|
|
265
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
266
|
+
var _a, _b, _c;
|
|
267
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.preflight(documentId, options);
|
|
268
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
269
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ArchiveControllerApi.preflight']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
270
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
271
|
+
});
|
|
272
|
+
},
|
|
273
|
+
/**
|
|
274
|
+
* ADMIN only. Changes who may retrieve the document and nothing else: content, metadata, the deposit record and the integrity ledger stay frozen. Audited as ARCHIVE_OWNER_REASSIGNED. Refused when the deployment has disabled reassignment — 403 on a WORM instance, 404 elsewhere.
|
|
275
|
+
* @summary Hand custody of an archived document to another user
|
|
276
|
+
* @param {string} documentId
|
|
277
|
+
* @param {{ [key: string]: string; }} requestBody
|
|
278
|
+
* @param {*} [options] Override http request option.
|
|
279
|
+
* @throws {RequiredError}
|
|
280
|
+
*/
|
|
281
|
+
reassignOwner(documentId, requestBody, options) {
|
|
282
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
283
|
+
var _a, _b, _c;
|
|
284
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.reassignOwner(documentId, requestBody, options);
|
|
285
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
286
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ArchiveControllerApi.reassignOwner']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
287
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
288
|
+
});
|
|
289
|
+
},
|
|
290
|
+
/**
|
|
291
|
+
* Needs ARCHIVIST and CONTRIBUTOR. The archived original is untouched — a restore is a copy, never a move. The new document goes through the ordinary upload pipeline, so audit, checksum, indexing and antivirus all apply.
|
|
292
|
+
* @summary Restore an archived document into this instance
|
|
293
|
+
* @param {string} archiveDocumentId
|
|
294
|
+
* @param {string} [targetFolderId]
|
|
295
|
+
* @param {*} [options] Override http request option.
|
|
296
|
+
* @throws {RequiredError}
|
|
297
|
+
*/
|
|
298
|
+
restore(archiveDocumentId, targetFolderId, options) {
|
|
299
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
300
|
+
var _a, _b, _c;
|
|
301
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.restore(archiveDocumentId, targetFolderId, options);
|
|
302
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
303
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ArchiveControllerApi.restore']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
304
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
305
|
+
});
|
|
306
|
+
},
|
|
307
|
+
};
|
|
308
|
+
};
|
|
309
|
+
exports.ArchiveControllerApiFp = ArchiveControllerApiFp;
|
|
310
|
+
/**
|
|
311
|
+
* ArchiveControllerApi - factory interface
|
|
312
|
+
*/
|
|
313
|
+
const ArchiveControllerApiFactory = function (configuration, basePath, axios) {
|
|
314
|
+
const localVarFp = (0, exports.ArchiveControllerApiFp)(configuration);
|
|
315
|
+
return {
|
|
316
|
+
/**
|
|
317
|
+
* Copy to the archive, verify the fingerprint it recorded, then PERMANENTLY delete the source — even when soft delete is enabled, because a recycle-bin restore would resurrect a document that also lives in the archive. Owner only. Once this succeeds there is nothing to undo in this instance: recovery means restoring from the archive.
|
|
318
|
+
* @summary Archive a document
|
|
319
|
+
* @param {string} documentId
|
|
320
|
+
* @param {string} [onBehalfOf]
|
|
321
|
+
* @param {*} [options] Override http request option.
|
|
322
|
+
* @throws {RequiredError}
|
|
323
|
+
*/
|
|
324
|
+
archive(documentId, onBehalfOf, options) {
|
|
325
|
+
return localVarFp.archive(documentId, onBehalfOf, options).then((request) => request(axios, basePath));
|
|
326
|
+
},
|
|
327
|
+
/**
|
|
328
|
+
* Partial by design: files owned by other people stay where they are, because only an owner may archive. Run the pre-flight first — it names what will be left behind and who owns it. Sequential, so a failure part-way leaves a state a human can read: what moved is in the archive, the rest is untouched here.
|
|
329
|
+
* @summary Archive the caller\'s own files in a folder subtree
|
|
330
|
+
* @param {string} folderId
|
|
331
|
+
* @param {*} [options] Override http request option.
|
|
332
|
+
* @throws {RequiredError}
|
|
333
|
+
*/
|
|
334
|
+
archiveFolder(folderId, options) {
|
|
335
|
+
return localVarFp.archiveFolder(folderId, options).then((request) => request(axios, basePath));
|
|
336
|
+
},
|
|
337
|
+
/**
|
|
338
|
+
* Computed before anything happens (§7.1): what will be archived, what stays behind because the caller does not own it (with the owners named), who loses a share, and how many comments the cascade destroys. Archiving hard-deletes the source even where soft delete is on, so this is a required step of the flow rather than a courtesy.
|
|
339
|
+
* @summary What archiving this would actually do
|
|
340
|
+
* @param {string} documentId
|
|
341
|
+
* @param {*} [options] Override http request option.
|
|
342
|
+
* @throws {RequiredError}
|
|
343
|
+
*/
|
|
344
|
+
preflight(documentId, options) {
|
|
345
|
+
return localVarFp.preflight(documentId, options).then((request) => request(axios, basePath));
|
|
346
|
+
},
|
|
347
|
+
/**
|
|
348
|
+
* ADMIN only. Changes who may retrieve the document and nothing else: content, metadata, the deposit record and the integrity ledger stay frozen. Audited as ARCHIVE_OWNER_REASSIGNED. Refused when the deployment has disabled reassignment — 403 on a WORM instance, 404 elsewhere.
|
|
349
|
+
* @summary Hand custody of an archived document to another user
|
|
350
|
+
* @param {string} documentId
|
|
351
|
+
* @param {{ [key: string]: string; }} requestBody
|
|
352
|
+
* @param {*} [options] Override http request option.
|
|
353
|
+
* @throws {RequiredError}
|
|
354
|
+
*/
|
|
355
|
+
reassignOwner(documentId, requestBody, options) {
|
|
356
|
+
return localVarFp.reassignOwner(documentId, requestBody, options).then((request) => request(axios, basePath));
|
|
357
|
+
},
|
|
358
|
+
/**
|
|
359
|
+
* Needs ARCHIVIST and CONTRIBUTOR. The archived original is untouched — a restore is a copy, never a move. The new document goes through the ordinary upload pipeline, so audit, checksum, indexing and antivirus all apply.
|
|
360
|
+
* @summary Restore an archived document into this instance
|
|
361
|
+
* @param {string} archiveDocumentId
|
|
362
|
+
* @param {string} [targetFolderId]
|
|
363
|
+
* @param {*} [options] Override http request option.
|
|
364
|
+
* @throws {RequiredError}
|
|
365
|
+
*/
|
|
366
|
+
restore(archiveDocumentId, targetFolderId, options) {
|
|
367
|
+
return localVarFp.restore(archiveDocumentId, targetFolderId, options).then((request) => request(axios, basePath));
|
|
368
|
+
},
|
|
369
|
+
};
|
|
370
|
+
};
|
|
371
|
+
exports.ArchiveControllerApiFactory = ArchiveControllerApiFactory;
|
|
372
|
+
/**
|
|
373
|
+
* ArchiveControllerApi - object-oriented interface
|
|
374
|
+
*/
|
|
375
|
+
class ArchiveControllerApi extends base_1.BaseAPI {
|
|
376
|
+
/**
|
|
377
|
+
* Copy to the archive, verify the fingerprint it recorded, then PERMANENTLY delete the source — even when soft delete is enabled, because a recycle-bin restore would resurrect a document that also lives in the archive. Owner only. Once this succeeds there is nothing to undo in this instance: recovery means restoring from the archive.
|
|
378
|
+
* @summary Archive a document
|
|
379
|
+
* @param {string} documentId
|
|
380
|
+
* @param {string} [onBehalfOf]
|
|
381
|
+
* @param {*} [options] Override http request option.
|
|
382
|
+
* @throws {RequiredError}
|
|
383
|
+
*/
|
|
384
|
+
archive(documentId, onBehalfOf, options) {
|
|
385
|
+
return (0, exports.ArchiveControllerApiFp)(this.configuration).archive(documentId, onBehalfOf, options).then((request) => request(this.axios, this.basePath));
|
|
386
|
+
}
|
|
387
|
+
/**
|
|
388
|
+
* Partial by design: files owned by other people stay where they are, because only an owner may archive. Run the pre-flight first — it names what will be left behind and who owns it. Sequential, so a failure part-way leaves a state a human can read: what moved is in the archive, the rest is untouched here.
|
|
389
|
+
* @summary Archive the caller\'s own files in a folder subtree
|
|
390
|
+
* @param {string} folderId
|
|
391
|
+
* @param {*} [options] Override http request option.
|
|
392
|
+
* @throws {RequiredError}
|
|
393
|
+
*/
|
|
394
|
+
archiveFolder(folderId, options) {
|
|
395
|
+
return (0, exports.ArchiveControllerApiFp)(this.configuration).archiveFolder(folderId, options).then((request) => request(this.axios, this.basePath));
|
|
396
|
+
}
|
|
397
|
+
/**
|
|
398
|
+
* Computed before anything happens (§7.1): what will be archived, what stays behind because the caller does not own it (with the owners named), who loses a share, and how many comments the cascade destroys. Archiving hard-deletes the source even where soft delete is on, so this is a required step of the flow rather than a courtesy.
|
|
399
|
+
* @summary What archiving this would actually do
|
|
400
|
+
* @param {string} documentId
|
|
401
|
+
* @param {*} [options] Override http request option.
|
|
402
|
+
* @throws {RequiredError}
|
|
403
|
+
*/
|
|
404
|
+
preflight(documentId, options) {
|
|
405
|
+
return (0, exports.ArchiveControllerApiFp)(this.configuration).preflight(documentId, options).then((request) => request(this.axios, this.basePath));
|
|
406
|
+
}
|
|
407
|
+
/**
|
|
408
|
+
* ADMIN only. Changes who may retrieve the document and nothing else: content, metadata, the deposit record and the integrity ledger stay frozen. Audited as ARCHIVE_OWNER_REASSIGNED. Refused when the deployment has disabled reassignment — 403 on a WORM instance, 404 elsewhere.
|
|
409
|
+
* @summary Hand custody of an archived document to another user
|
|
410
|
+
* @param {string} documentId
|
|
411
|
+
* @param {{ [key: string]: string; }} requestBody
|
|
412
|
+
* @param {*} [options] Override http request option.
|
|
413
|
+
* @throws {RequiredError}
|
|
414
|
+
*/
|
|
415
|
+
reassignOwner(documentId, requestBody, options) {
|
|
416
|
+
return (0, exports.ArchiveControllerApiFp)(this.configuration).reassignOwner(documentId, requestBody, options).then((request) => request(this.axios, this.basePath));
|
|
417
|
+
}
|
|
418
|
+
/**
|
|
419
|
+
* Needs ARCHIVIST and CONTRIBUTOR. The archived original is untouched — a restore is a copy, never a move. The new document goes through the ordinary upload pipeline, so audit, checksum, indexing and antivirus all apply.
|
|
420
|
+
* @summary Restore an archived document into this instance
|
|
421
|
+
* @param {string} archiveDocumentId
|
|
422
|
+
* @param {string} [targetFolderId]
|
|
423
|
+
* @param {*} [options] Override http request option.
|
|
424
|
+
* @throws {RequiredError}
|
|
425
|
+
*/
|
|
426
|
+
restore(archiveDocumentId, targetFolderId, options) {
|
|
427
|
+
return (0, exports.ArchiveControllerApiFp)(this.configuration).restore(archiveDocumentId, targetFolderId, options).then((request) => request(this.axios, this.basePath));
|
|
428
|
+
}
|
|
429
|
+
}
|
|
430
|
+
exports.ArchiveControllerApi = ArchiveControllerApi;
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { AuditIntegrityStatusResponse } from '../models';
|
|
15
16
|
import type { AuditVerificationResult } from '../models';
|
|
16
17
|
import type { EnrichedAuditLog } from '../models';
|
|
17
18
|
import type { SearchByAuditLogRequest } from '../models';
|
|
@@ -19,6 +20,13 @@ import type { SearchByAuditLogRequest } from '../models';
|
|
|
19
20
|
* CollaborationAuditControllerApi - axios parameter creator
|
|
20
21
|
*/
|
|
21
22
|
export declare const CollaborationAuditControllerApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
|
+
/**
|
|
24
|
+
* Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
|
|
25
|
+
* @summary Last scheduled audit chain verification
|
|
26
|
+
* @param {*} [options] Override http request option.
|
|
27
|
+
* @throws {RequiredError}
|
|
28
|
+
*/
|
|
29
|
+
auditIntegrityStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22
30
|
/**
|
|
23
31
|
* EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
|
|
24
32
|
* @summary Get audit trail for a resource (enriched with actor azp)
|
|
@@ -48,6 +56,13 @@ export declare const CollaborationAuditControllerApiAxiosParamCreator: (configur
|
|
|
48
56
|
* CollaborationAuditControllerApi - functional programming interface
|
|
49
57
|
*/
|
|
50
58
|
export declare const CollaborationAuditControllerApiFp: (configuration?: Configuration) => {
|
|
59
|
+
/**
|
|
60
|
+
* Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
|
|
61
|
+
* @summary Last scheduled audit chain verification
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
auditIntegrityStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuditIntegrityStatusResponse>>;
|
|
51
66
|
/**
|
|
52
67
|
* EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
|
|
53
68
|
* @summary Get audit trail for a resource (enriched with actor azp)
|
|
@@ -77,6 +92,13 @@ export declare const CollaborationAuditControllerApiFp: (configuration?: Configu
|
|
|
77
92
|
* CollaborationAuditControllerApi - factory interface
|
|
78
93
|
*/
|
|
79
94
|
export declare const CollaborationAuditControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
95
|
+
/**
|
|
96
|
+
* Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
|
|
97
|
+
* @summary Last scheduled audit chain verification
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
*/
|
|
101
|
+
auditIntegrityStatus(options?: RawAxiosRequestConfig): AxiosPromise<AuditIntegrityStatusResponse>;
|
|
80
102
|
/**
|
|
81
103
|
* EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
|
|
82
104
|
* @summary Get audit trail for a resource (enriched with actor azp)
|
|
@@ -106,6 +128,13 @@ export declare const CollaborationAuditControllerApiFactory: (configuration?: Co
|
|
|
106
128
|
* CollaborationAuditControllerApi - object-oriented interface
|
|
107
129
|
*/
|
|
108
130
|
export declare class CollaborationAuditControllerApi extends BaseAPI {
|
|
131
|
+
/**
|
|
132
|
+
* Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
|
|
133
|
+
* @summary Last scheduled audit chain verification
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
auditIntegrityStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuditIntegrityStatusResponse, any, {}, any>>;
|
|
109
138
|
/**
|
|
110
139
|
* EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
|
|
111
140
|
* @summary Get audit trail for a resource (enriched with actor azp)
|
|
@@ -34,6 +34,35 @@ const base_1 = require("../base");
|
|
|
34
34
|
*/
|
|
35
35
|
const CollaborationAuditControllerApiAxiosParamCreator = function (configuration) {
|
|
36
36
|
return {
|
|
37
|
+
/**
|
|
38
|
+
* Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
|
|
39
|
+
* @summary Last scheduled audit chain verification
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
auditIntegrityStatus: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
44
|
+
const localVarPath = `/api/v1/audit/verify/status`;
|
|
45
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
47
|
+
let baseOptions;
|
|
48
|
+
if (configuration) {
|
|
49
|
+
baseOptions = configuration.baseOptions;
|
|
50
|
+
}
|
|
51
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
52
|
+
const localVarHeaderParameter = {};
|
|
53
|
+
const localVarQueryParameter = {};
|
|
54
|
+
// authentication keycloak_auth required
|
|
55
|
+
// http bearer authentication required
|
|
56
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
57
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
58
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
59
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
60
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
61
|
+
return {
|
|
62
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
63
|
+
options: localVarRequestOptions,
|
|
64
|
+
};
|
|
65
|
+
}),
|
|
37
66
|
/**
|
|
38
67
|
* EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
|
|
39
68
|
* @summary Get audit trail for a resource (enriched with actor azp)
|
|
@@ -143,6 +172,21 @@ exports.CollaborationAuditControllerApiAxiosParamCreator = CollaborationAuditCon
|
|
|
143
172
|
const CollaborationAuditControllerApiFp = function (configuration) {
|
|
144
173
|
const localVarAxiosParamCreator = (0, exports.CollaborationAuditControllerApiAxiosParamCreator)(configuration);
|
|
145
174
|
return {
|
|
175
|
+
/**
|
|
176
|
+
* Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
|
|
177
|
+
* @summary Last scheduled audit chain verification
|
|
178
|
+
* @param {*} [options] Override http request option.
|
|
179
|
+
* @throws {RequiredError}
|
|
180
|
+
*/
|
|
181
|
+
auditIntegrityStatus(options) {
|
|
182
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
183
|
+
var _a, _b, _c;
|
|
184
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.auditIntegrityStatus(options);
|
|
185
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
186
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CollaborationAuditControllerApi.auditIntegrityStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
187
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
188
|
+
});
|
|
189
|
+
},
|
|
146
190
|
/**
|
|
147
191
|
* EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
|
|
148
192
|
* @summary Get audit trail for a resource (enriched with actor azp)
|
|
@@ -200,6 +244,15 @@ exports.CollaborationAuditControllerApiFp = CollaborationAuditControllerApiFp;
|
|
|
200
244
|
const CollaborationAuditControllerApiFactory = function (configuration, basePath, axios) {
|
|
201
245
|
const localVarFp = (0, exports.CollaborationAuditControllerApiFp)(configuration);
|
|
202
246
|
return {
|
|
247
|
+
/**
|
|
248
|
+
* Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
|
|
249
|
+
* @summary Last scheduled audit chain verification
|
|
250
|
+
* @param {*} [options] Override http request option.
|
|
251
|
+
* @throws {RequiredError}
|
|
252
|
+
*/
|
|
253
|
+
auditIntegrityStatus(options) {
|
|
254
|
+
return localVarFp.auditIntegrityStatus(options).then((request) => request(axios, basePath));
|
|
255
|
+
},
|
|
203
256
|
/**
|
|
204
257
|
* EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
|
|
205
258
|
* @summary Get audit trail for a resource (enriched with actor azp)
|
|
@@ -237,6 +290,15 @@ exports.CollaborationAuditControllerApiFactory = CollaborationAuditControllerApi
|
|
|
237
290
|
* CollaborationAuditControllerApi - object-oriented interface
|
|
238
291
|
*/
|
|
239
292
|
class CollaborationAuditControllerApi extends base_1.BaseAPI {
|
|
293
|
+
/**
|
|
294
|
+
* Returns the cached verdict of the last scheduled verification on this instance, without re-walking the chain. Poll this for monitoring; call /verify for an authoritative, on-demand answer. `verified=false` means the chain has not been checked yet on this instance — it does not mean the chain is valid.
|
|
295
|
+
* @summary Last scheduled audit chain verification
|
|
296
|
+
* @param {*} [options] Override http request option.
|
|
297
|
+
* @throws {RequiredError}
|
|
298
|
+
*/
|
|
299
|
+
auditIntegrityStatus(options) {
|
|
300
|
+
return (0, exports.CollaborationAuditControllerApiFp)(this.configuration).auditIntegrityStatus(options).then((request) => request(this.axios, this.basePath));
|
|
301
|
+
}
|
|
240
302
|
/**
|
|
241
303
|
* EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
|
|
242
304
|
* @summary Get audit trail for a resource (enriched with actor azp)
|