@openfilz-sdk/typescript 1.3.20 → 1.3.21

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';
+
+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/DocumentControllerApi.md

@@ -11,6 +11,7 @@ All URIs are relative to *http://localhost:8081*
 |[**downloadMultipleDocumentsAsZip**](#downloadmultipledocumentsaszip) | **POST** /api/v1/documents/download-multiple | Download multiple documents as ZIP|
 |[**getDocumentAncestors**](#getdocumentancestors) | **GET** /api/v1/documents/{documentId}/ancestors | Get document ancestors|
 |[**getDocumentInfo**](#getdocumentinfo) | **GET** /api/v1/documents/{documentId}/info | Get information of a document|
+|[**getDocumentIntegrity**](#getdocumentintegrity) | **GET** /api/v1/documents/{documentId}/integrity | Get a document\'s integrity ledger|
 |[**getDocumentMetadata**](#getdocumentmetadata) | **POST** /api/v1/documents/{documentId}/search/metadata | Search metadata of a document|
 |[**getDocumentPosition**](#getdocumentposition) | **GET** /api/v1/documents/{documentId}/position | Get document position in folder|
 |[**replaceDocumentContent**](#replacedocumentcontent) | **PUT** /api/v1/documents/{documentId}/replace-content | Replace document content|
@@ -384,6 +385,57 @@ const { status, data } = await apiInstance.getDocumentInfo(
  - **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)
+
+# **getDocumentIntegrity**
+> Array<DocumentIntegrityRecord> getDocumentIntegrity()
+
+Append-only history of what this document\'s content hashed to, newest first. Unlike the sha256 in metadata, these entries cannot be modified or deleted — a database trigger refuses UPDATE and DELETE on the table. Empty for documents uploaded before the ledger existed, or when openfilz.calculate-checksum is off.
+
+### Example
+
+```typescript
+import {
+    DocumentControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentControllerApi(configuration);
+
+let documentId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getDocumentIntegrity(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<DocumentIntegrityRecord>**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/docs/DocumentIntegrityRecord.md

@@ -0,0 +1,33 @@
+# DocumentIntegrityRecord
+
+One entry of a document\'s append-only integrity ledger
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** |  | [optional] [default to undefined]
+**storagePath** | **string** |  | [optional] [default to undefined]
+**versionId** | **string** |  | [optional] [default to undefined]
+**algorithm** | **string** |  | [optional] [default to undefined]
+**hash** | **string** |  | [optional] [default to undefined]
+**recordedAt** | **string** |  | [optional] [default to undefined]
+**recordedBy** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DocumentIntegrityRecord } from '@openfilz-sdk/typescript';
+
+const instance: DocumentIntegrityRecord = {
+    documentId,
+    storagePath,
+    versionId,
+    algorithm,
+    hash,
+    recordedAt,
+    recordedBy,
+};
+```
+
+[[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/models/audit-integrity-status-response.ts

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { AuditVerificationResult } from './audit-verification-result';
+
+/**
+ * Last known result of the scheduled audit chain verification on this instance
+ */
+export interface AuditIntegrityStatusResponse {
+    /**
+     * true when the last scheduled pass reported a broken chain
+     */
+    'chainBroken'?: 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.
+     */
+    'verified'?: boolean;
+    /**
+     * Verdict of the last completed scheduled verification, if any
+     */
+    'lastResult'?: AuditVerificationResult;
+    /**
+     * Why the last scheduled verification could not run, if it failed
+     */
+    'lastFailureMessage'?: string;
+    /**
+     * When the last scheduled verification failed to run, if it did
+     */
+    'lastFailureAt'?: string;
+}
+

package/models/document-integrity-record.ts

@@ -0,0 +1,29 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * One entry of a document\'s append-only integrity ledger
+ */
+export interface DocumentIntegrityRecord {
+    'documentId'?: string;
+    'storagePath'?: string;
+    'versionId'?: string;
+    'algorithm'?: string;
+    'hash'?: string;
+    'recordedAt'?: string;
+    'recordedBy'?: string;
+}
+

package/models/index.ts

@@ -7,6 +7,7 @@ export * from './ai-preferences-view';
 export * from './ai-settings-response';
 export * from './ancestor-info';
 export * from './apply-signature-request';
+export * from './audit-integrity-status-response';
 export * from './audit-log';
 export * from './audit-log-details';
 export * from './audit-log-details-one-of';
@@ -35,6 +36,7 @@ export * from './delete-metadata-request';
 export * from './delete-request';
 export * from './document-info';
 export * from './document-insight-view';
+export * from './document-integrity-record';
 export * from './document-position';
 export * from './document-version-info';
 export * from './element-info';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfilz-sdk/typescript",
-  "version": "1.3.20",
+  "version": "1.3.21",
   "description": "OpenAPI client for @openfilz-sdk/typescript",
   "author": "OpenAPI-Generator Contributors",
   "repository": {