@openfilz-sdk/typescript-ee 1.9.10 → 1.10.0

package/docs/ArchiveControllerApi.md

@@ -0,0 +1,276 @@
+# ArchiveControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**archive**](#archive) | **POST** /api/v1/archive/documents/{documentId} | Archive a document|
+|[**archiveFolder**](#archivefolder) | **POST** /api/v1/archive/folders/{folderId} | Archive the caller\'s own files in a folder subtree|
+|[**preflight**](#preflight) | **GET** /api/v1/archive/preflight/{documentId} | What archiving this would actually do|
+|[**reassignOwner**](#reassignowner) | **PUT** /api/v1/archive/documents/{documentId}/owner | Hand custody of an archived document to another user|
+|[**restore**](#restore) | **POST** /api/v1/archive/documents/{archiveDocumentId}/restore | Restore an archived document into this instance|
+
+# **archive**
+> { [key: string]: any; } archive()
+
+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.
+
+### Example
+
+```typescript
+import {
+    ArchiveControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ArchiveControllerApi(configuration);
+
+let documentId: string; // (default to undefined)
+let onBehalfOf: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.archive(
+    documentId,
+    onBehalfOf
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+| **onBehalfOf** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **archiveFolder**
+> { [key: string]: any; } archiveFolder()
+
+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.
+
+### Example
+
+```typescript
+import {
+    ArchiveControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ArchiveControllerApi(configuration);
+
+let folderId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.archiveFolder(
+    folderId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **folderId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **preflight**
+> ArchivePreflight preflight()
+
+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.
+
+### Example
+
+```typescript
+import {
+    ArchiveControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ArchiveControllerApi(configuration);
+
+let documentId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.preflight(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ArchivePreflight**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **reassignOwner**
+> { [key: string]: any; } reassignOwner(requestBody)
+
+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.
+
+### Example
+
+```typescript
+import {
+    ArchiveControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ArchiveControllerApi(configuration);
+
+let documentId: string; // (default to undefined)
+let requestBody: { [key: string]: string; }; //
+
+const { status, data } = await apiInstance.reassignOwner(
+    documentId,
+    requestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **requestBody** | **{ [key: string]: string; }**|  | |
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **restore**
+> { [key: string]: any; } restore()
+
+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.
+
+### Example
+
+```typescript
+import {
+    ArchiveControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ArchiveControllerApi(configuration);
+
+let archiveDocumentId: string; // (default to undefined)
+let targetFolderId: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.restore(
+    archiveDocumentId,
+    targetFolderId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **archiveDocumentId** | [**string**] |  | defaults to undefined|
+| **targetFolderId** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+

package/docs/ArchivePreflight.md

@@ -0,0 +1,29 @@
+# ArchivePreflight
+
+Consequences of archiving, computed before the user confirms
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**willBeArchived** | [**Array<Item>**](Item.md) | What will actually be archived — owned by the caller | [optional] [default to undefined]
+**leftBehind** | [**Array<ForeignItem>**](ForeignItem.md) | Left behind because the caller does not own them. Only the owner may archive a document, so a folder is archived partially rather than refused: an owner should not be blocked by co-workers\' files in the same tree. | [optional] [default to undefined]
+**shareRecipientsLosingAccess** | **Array<string>** | People who lose access. Archiving revokes every share — a share is a live-collaboration ACL and means nothing in a store only the owner reads. | [optional] [default to undefined]
+**commentsDestroyed** | **number** | Number of comments that will be DESTROYED in the live instance (doc_comment is ON DELETE CASCADE). They survive only as the read-only transcript inside the deposit record. | [optional] [default to undefined]
+**irreversibleFromLive** | **boolean** | Always true. Stated explicitly because with soft delete enabled users have learned that a delete is recoverable from the recycle bin. Here it is not. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ArchivePreflight } from '@openfilz-sdk/typescript-ee';
+
+const instance: ArchivePreflight = {
+    willBeArchived,
+    leftBehind,
+    shareRecipientsLosingAccess,
+    commentsDestroyed,
+    irreversibleFromLive,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ArchivingProposalRequest.md

@@ -0,0 +1,30 @@
+# ArchivingProposalRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rootFolderId** | **string** |  | [optional] [default to undefined]
+**untouchedMonths** | **number** |  | [optional] [default to undefined]
+**targetTemplate** | **string** |  | [optional] [default to undefined]
+**legalHoldMetadataKey** | **string** |  | [optional] [default to undefined]
+**maxDocuments** | **number** |  | [optional] [default to undefined]
+**ownerEmail** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ArchivingProposalRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ArchivingProposalRequest = {
+    rootFolderId,
+    untouchedMonths,
+    targetTemplate,
+    legalHoldMetadataKey,
+    maxDocuments,
+    ownerEmail,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ArchivingProposalResult.md

@@ -0,0 +1,30 @@
+# ArchivingProposalResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**planId** | **string** |  | [optional] [default to undefined]
+**documents** | **number** |  | [optional] [default to undefined]
+**candidates** | **number** |  | [optional] [default to undefined]
+**blocked** | **number** |  | [optional] [default to undefined]
+**rationale** | **string** |  | [optional] [default to undefined]
+**ownerEmail** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ArchivingProposalResult } from '@openfilz-sdk/typescript-ee';
+
+const instance: ArchivingProposalResult = {
+    planId,
+    documents,
+    candidates,
+    blocked,
+    rationale,
+    ownerEmail,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ArchivingScheduleRequest.md

@@ -0,0 +1,36 @@
+# ArchivingScheduleRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**rootFolderId** | **string** |  | [optional] [default to undefined]
+**untouchedMonths** | **number** |  | [optional] [default to undefined]
+**targetTemplate** | **string** |  | [optional] [default to undefined]
+**legalHoldMetadataKey** | **string** |  | [optional] [default to undefined]
+**maxDocuments** | **number** |  | [optional] [default to undefined]
+**cron** | **string** |  | [optional] [default to undefined]
+**ownerEmail** | **string** |  | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ArchivingScheduleRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ArchivingScheduleRequest = {
+    name,
+    rootFolderId,
+    untouchedMonths,
+    targetTemplate,
+    legalHoldMetadataKey,
+    maxDocuments,
+    cron,
+    ownerEmail,
+    enabled,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ArchivingScheduleView.md

@@ -0,0 +1,50 @@
+# ArchivingScheduleView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**rootFolderId** | **string** |  | [optional] [default to undefined]
+**untouchedMonths** | **number** |  | [optional] [default to undefined]
+**targetTemplate** | **string** |  | [optional] [default to undefined]
+**legalHoldMetadataKey** | **string** |  | [optional] [default to undefined]
+**maxDocuments** | **number** |  | [optional] [default to undefined]
+**cron** | **string** |  | [optional] [default to undefined]
+**ownerEmail** | **string** |  | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**lastRunAt** | **string** |  | [optional] [default to undefined]
+**lastPlanId** | **string** |  | [optional] [default to undefined]
+**lastOutcome** | **string** |  | [optional] [default to undefined]
+**createdBy** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ArchivingScheduleView } from '@openfilz-sdk/typescript-ee';
+
+const instance: ArchivingScheduleView = {
+    id,
+    name,
+    rootFolderId,
+    untouchedMonths,
+    targetTemplate,
+    legalHoldMetadataKey,
+    maxDocuments,
+    cron,
+    ownerEmail,
+    enabled,
+    lastRunAt,
+    lastPlanId,
+    lastOutcome,
+    createdBy,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AuditIntegrityStatusResponse.md

@@ -0,0 +1,29 @@
+# AuditIntegrityStatusResponse
+
+Last known result of the scheduled audit chain verification on this instance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**chainBroken** | **boolean** | true when the last scheduled pass reported a broken chain | [optional] [default to undefined]
+**verified** | **boolean** | false until the first scheduled verification has completed on this instance, or when the last one could not run. Not verified is not the same as valid. | [optional] [default to undefined]
+**lastResult** | [**AuditVerificationResult**](AuditVerificationResult.md) | Verdict of the last completed scheduled verification, if any | [optional] [default to undefined]
+**lastFailureMessage** | **string** | Why the last scheduled verification could not run, if it failed | [optional] [default to undefined]
+**lastFailureAt** | **string** | When the last scheduled verification failed to run, if it did | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AuditIntegrityStatusResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: AuditIntegrityStatusResponse = {
+    chainBroken,
+    verified,
+    lastResult,
+    lastFailureMessage,
+    lastFailureAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AutoFileInboxRequest.md

@@ -0,0 +1,20 @@
+# AutoFileInboxRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**allowNewFolders** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AutoFileInboxRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: AutoFileInboxRequest = {
+    allowNewFolders,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AutoFileJobsRequest.md

@@ -0,0 +1,20 @@
+# AutoFileJobsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobIds** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AutoFileJobsRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: AutoFileJobsRequest = {
+    jobIds,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CollaborationAuditControllerApi.md

@@ -4,10 +4,55 @@ All URIs are relative to *http://localhost:8081*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**auditIntegrityStatus**](#auditintegritystatus) | **GET** /api/v1/audit/verify/status | Last scheduled audit chain verification|
 |[**getAuditTrail**](#getaudittrail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource (enriched with actor azp)|
 |[**searchAuditTrail**](#searchaudittrail) | **POST** /api/v1/audit/search | Search audit trail (enriched with actor azp)|
 |[**verifyChain**](#verifychain) | **GET** /api/v1/audit/verify | Verify audit chain integrity|
 
+# **auditIntegrityStatus**
+> AuditIntegrityStatusResponse auditIntegrityStatus()
+
+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.
+
+### Example
+
+```typescript
+import {
+    CollaborationAuditControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationAuditControllerApi(configuration);
+
+const { status, data } = await apiInstance.auditIntegrityStatus();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AuditIntegrityStatusResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
 # **getAuditTrail**
 > Array<EnrichedAuditLog> getAuditTrail()
 

package/docs/ConsumeDelegatedGrantRequest.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subscriptionId** | **string** |  | [default to undefined]
+**subscriptionId** | **string** |  | [optional] [default to undefined]
 **folderId** | **string** |  | [optional] [default to undefined]
 
 ## Example

package/docs/Corrections.md

@@ -0,0 +1,24 @@
+# Corrections
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**undo** | **number** |  | [optional] [default to undefined]
+**manualMove** | **number** |  | [optional] [default to undefined]
+**accuracy** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Corrections } from '@openfilz-sdk/typescript-ee';
+
+const instance: Corrections = {
+    undo,
+    manualMove,
+    accuracy,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateDelegatedGrantRequest.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **grantor** | **string** |  | [default to undefined]
 **purpose** | **string** |  | [default to undefined]
 **note** | **string** |  | [optional] [default to undefined]
-**targetUrl** | **string** |  | [default to undefined]
+**targetUrl** | **string** |  | [optional] [default to undefined]
 
 ## Example
 

package/docs/DayCount.md

@@ -0,0 +1,24 @@
+# DayCount
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**day** | **string** |  | [optional] [default to undefined]
+**filed** | **number** |  | [optional] [default to undefined]
+**skipped** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DayCount } from '@openfilz-sdk/typescript-ee';
+
+const instance: DayCount = {
+    day,
+    filed,
+    skipped,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)