@openfilz-sdk/typescript 1.3.20 → 1.3.21

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.
Files changed (33) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +6 -2
  4. package/api/audit-controller-api.ts +67 -0
  5. package/api/document-controller-api.ts +74 -0
  6. package/dist/api/audit-controller-api.d.ts +29 -0
  7. package/dist/api/audit-controller-api.js +62 -0
  8. package/dist/api/document-controller-api.d.ts +33 -0
  9. package/dist/api/document-controller-api.js +69 -0
  10. package/dist/esm/api/audit-controller-api.d.ts +29 -0
  11. package/dist/esm/api/audit-controller-api.js +62 -0
  12. package/dist/esm/api/document-controller-api.d.ts +33 -0
  13. package/dist/esm/api/document-controller-api.js +69 -0
  14. package/dist/esm/models/audit-integrity-status-response.d.ts +37 -0
  15. package/dist/esm/models/audit-integrity-status-response.js +14 -0
  16. package/dist/esm/models/document-integrity-record.d.ts +23 -0
  17. package/dist/esm/models/document-integrity-record.js +14 -0
  18. package/dist/esm/models/index.d.ts +2 -0
  19. package/dist/esm/models/index.js +2 -0
  20. package/dist/models/audit-integrity-status-response.d.ts +37 -0
  21. package/dist/models/audit-integrity-status-response.js +15 -0
  22. package/dist/models/document-integrity-record.d.ts +23 -0
  23. package/dist/models/document-integrity-record.js +15 -0
  24. package/dist/models/index.d.ts +2 -0
  25. package/dist/models/index.js +2 -0
  26. package/docs/AuditControllerApi.md +45 -0
  27. package/docs/AuditIntegrityStatusResponse.md +29 -0
  28. package/docs/DocumentControllerApi.md +52 -0
  29. package/docs/DocumentIntegrityRecord.md +33 -0
  30. package/models/audit-integrity-status-response.ts +45 -0
  31. package/models/document-integrity-record.ts +29 -0
  32. package/models/index.ts +2 -0
  33. package/package.json +1 -1
@@ -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 { AuditLog } from '../models';
16
17
  import type { AuditVerificationResult } from '../models';
17
18
  import type { SearchByAuditLogRequest } from '../models';
@@ -19,6 +20,13 @@ import type { SearchByAuditLogRequest } from '../models';
19
20
  * AuditControllerApi - axios parameter creator
20
21
  */
21
22
  export declare const AuditControllerApiAxiosParamCreator: (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
  * Retrieves the audit trail for a given resource.
24
32
  * @summary Get audit trail for a resource
@@ -48,6 +56,13 @@ export declare const AuditControllerApiAxiosParamCreator: (configuration?: Confi
48
56
  * AuditControllerApi - functional programming interface
49
57
  */
50
58
  export declare const AuditControllerApiFp: (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
  * Retrieves the audit trail for a given resource.
53
68
  * @summary Get audit trail for a resource
@@ -77,6 +92,13 @@ export declare const AuditControllerApiFp: (configuration?: Configuration) => {
77
92
  * AuditControllerApi - factory interface
78
93
  */
79
94
  export declare const AuditControllerApiFactory: (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
  * Retrieves the audit trail for a given resource.
82
104
  * @summary Get audit trail for a resource
@@ -106,6 +128,13 @@ export declare const AuditControllerApiFactory: (configuration?: Configuration,
106
128
  * AuditControllerApi - object-oriented interface
107
129
  */
108
130
  export declare class AuditControllerApi 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, {}>>;
109
138
  /**
110
139
  * Retrieves the audit trail for a given resource.
111
140
  * @summary Get audit trail for a resource
@@ -31,6 +31,35 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
31
31
  */
32
32
  export const AuditControllerApiAxiosParamCreator = function (configuration) {
33
33
  return {
34
+ /**
35
+ * 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.
36
+ * @summary Last scheduled audit chain verification
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ */
40
+ auditIntegrityStatus: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
41
+ const localVarPath = `/api/v1/audit/verify/status`;
42
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
43
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
44
+ let baseOptions;
45
+ if (configuration) {
46
+ baseOptions = configuration.baseOptions;
47
+ }
48
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
49
+ const localVarHeaderParameter = {};
50
+ const localVarQueryParameter = {};
51
+ // authentication keycloak_auth required
52
+ // http bearer authentication required
53
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
54
+ localVarHeaderParameter['Accept'] = '*/*';
55
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
56
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
57
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
58
+ return {
59
+ url: toPathString(localVarUrlObj),
60
+ options: localVarRequestOptions,
61
+ };
62
+ }),
34
63
  /**
35
64
  * Retrieves the audit trail for a given resource.
36
65
  * @summary Get audit trail for a resource
@@ -139,6 +168,21 @@ export const AuditControllerApiAxiosParamCreator = function (configuration) {
139
168
  export const AuditControllerApiFp = function (configuration) {
140
169
  const localVarAxiosParamCreator = AuditControllerApiAxiosParamCreator(configuration);
141
170
  return {
171
+ /**
172
+ * 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.
173
+ * @summary Last scheduled audit chain verification
174
+ * @param {*} [options] Override http request option.
175
+ * @throws {RequiredError}
176
+ */
177
+ auditIntegrityStatus(options) {
178
+ return __awaiter(this, void 0, void 0, function* () {
179
+ var _a, _b, _c;
180
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.auditIntegrityStatus(options);
181
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
182
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AuditControllerApi.auditIntegrityStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
183
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
184
+ });
185
+ },
142
186
  /**
143
187
  * Retrieves the audit trail for a given resource.
144
188
  * @summary Get audit trail for a resource
@@ -195,6 +239,15 @@ export const AuditControllerApiFp = function (configuration) {
195
239
  export const AuditControllerApiFactory = function (configuration, basePath, axios) {
196
240
  const localVarFp = AuditControllerApiFp(configuration);
197
241
  return {
242
+ /**
243
+ * 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.
244
+ * @summary Last scheduled audit chain verification
245
+ * @param {*} [options] Override http request option.
246
+ * @throws {RequiredError}
247
+ */
248
+ auditIntegrityStatus(options) {
249
+ return localVarFp.auditIntegrityStatus(options).then((request) => request(axios, basePath));
250
+ },
198
251
  /**
199
252
  * Retrieves the audit trail for a given resource.
200
253
  * @summary Get audit trail for a resource
@@ -231,6 +284,15 @@ export const AuditControllerApiFactory = function (configuration, basePath, axio
231
284
  * AuditControllerApi - object-oriented interface
232
285
  */
233
286
  export class AuditControllerApi extends BaseAPI {
287
+ /**
288
+ * 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.
289
+ * @summary Last scheduled audit chain verification
290
+ * @param {*} [options] Override http request option.
291
+ * @throws {RequiredError}
292
+ */
293
+ auditIntegrityStatus(options) {
294
+ return AuditControllerApiFp(this.configuration).auditIntegrityStatus(options).then((request) => request(this.axios, this.basePath));
295
+ }
234
296
  /**
235
297
  * Retrieves the audit trail for a given resource.
236
298
  * @summary Get audit trail for a resource
@@ -16,6 +16,7 @@ import type { AncestorInfo } from '../models';
16
16
  import type { CreateBlankDocumentRequest } from '../models';
17
17
  import type { DeleteMetadataRequest } from '../models';
18
18
  import type { DocumentInfo } from '../models';
19
+ import type { DocumentIntegrityRecord } from '../models';
19
20
  import type { DocumentPosition } from '../models';
20
21
  import type { ElementInfo } from '../models';
21
22
  import type { SearchByMetadataRequest } from '../models';
@@ -86,6 +87,14 @@ export declare const DocumentControllerApiAxiosParamCreator: (configuration?: Co
86
87
  * @throws {RequiredError}
87
88
  */
88
89
  getDocumentInfo: (documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
90
+ /**
91
+ * 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.
92
+ * @summary Get a document\'s integrity ledger
93
+ * @param {string} documentId
94
+ * @param {*} [options] Override http request option.
95
+ * @throws {RequiredError}
96
+ */
97
+ getDocumentIntegrity: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
89
98
  /**
90
99
  * Retrieves metadata for a document. Can filter by keys.
91
100
  * @summary Search metadata of a document
@@ -230,6 +239,14 @@ export declare const DocumentControllerApiFp: (configuration?: Configuration) =>
230
239
  * @throws {RequiredError}
231
240
  */
232
241
  getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInfo>>;
242
+ /**
243
+ * 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.
244
+ * @summary Get a document\'s integrity ledger
245
+ * @param {string} documentId
246
+ * @param {*} [options] Override http request option.
247
+ * @throws {RequiredError}
248
+ */
249
+ getDocumentIntegrity(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DocumentIntegrityRecord>>>;
233
250
  /**
234
251
  * Retrieves metadata for a document. Can filter by keys.
235
252
  * @summary Search metadata of a document
@@ -376,6 +393,14 @@ export declare const DocumentControllerApiFactory: (configuration?: Configuratio
376
393
  * @throws {RequiredError}
377
394
  */
378
395
  getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInfo>;
396
+ /**
397
+ * 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.
398
+ * @summary Get a document\'s integrity ledger
399
+ * @param {string} documentId
400
+ * @param {*} [options] Override http request option.
401
+ * @throws {RequiredError}
402
+ */
403
+ getDocumentIntegrity(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<DocumentIntegrityRecord>>;
379
404
  /**
380
405
  * Retrieves metadata for a document. Can filter by keys.
381
406
  * @summary Search metadata of a document
@@ -522,6 +547,14 @@ export declare class DocumentControllerApi extends BaseAPI {
522
547
  * @throws {RequiredError}
523
548
  */
524
549
  getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentInfo, any, {}>>;
550
+ /**
551
+ * 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.
552
+ * @summary Get a document\'s integrity ledger
553
+ * @param {string} documentId
554
+ * @param {*} [options] Override http request option.
555
+ * @throws {RequiredError}
556
+ */
557
+ getDocumentIntegrity(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentIntegrityRecord[], any, {}>>;
525
558
  /**
526
559
  * Retrieves metadata for a document. Can filter by keys.
527
560
  * @summary Search metadata of a document
@@ -282,6 +282,39 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration) {
282
282
  options: localVarRequestOptions,
283
283
  };
284
284
  }),
285
+ /**
286
+ * 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.
287
+ * @summary Get a document\'s integrity ledger
288
+ * @param {string} documentId
289
+ * @param {*} [options] Override http request option.
290
+ * @throws {RequiredError}
291
+ */
292
+ getDocumentIntegrity: (documentId_1, ...args_1) => __awaiter(this, [documentId_1, ...args_1], void 0, function* (documentId, options = {}) {
293
+ // verify required parameter 'documentId' is not null or undefined
294
+ assertParamExists('getDocumentIntegrity', 'documentId', documentId);
295
+ const localVarPath = `/api/v1/documents/{documentId}/integrity`
296
+ .replace('{documentId}', encodeURIComponent(String(documentId)));
297
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
298
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
299
+ let baseOptions;
300
+ if (configuration) {
301
+ baseOptions = configuration.baseOptions;
302
+ }
303
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
304
+ const localVarHeaderParameter = {};
305
+ const localVarQueryParameter = {};
306
+ // authentication keycloak_auth required
307
+ // http bearer authentication required
308
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
309
+ localVarHeaderParameter['Accept'] = '*/*';
310
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
311
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
312
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
313
+ return {
314
+ url: toPathString(localVarUrlObj),
315
+ options: localVarRequestOptions,
316
+ };
317
+ }),
285
318
  /**
286
319
  * Retrieves metadata for a document. Can filter by keys.
287
320
  * @summary Search metadata of a document
@@ -741,6 +774,22 @@ export const DocumentControllerApiFp = function (configuration) {
741
774
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
742
775
  });
743
776
  },
777
+ /**
778
+ * 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.
779
+ * @summary Get a document\'s integrity ledger
780
+ * @param {string} documentId
781
+ * @param {*} [options] Override http request option.
782
+ * @throws {RequiredError}
783
+ */
784
+ getDocumentIntegrity(documentId, options) {
785
+ return __awaiter(this, void 0, void 0, function* () {
786
+ var _a, _b, _c;
787
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getDocumentIntegrity(documentId, options);
788
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
789
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentControllerApi.getDocumentIntegrity']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
790
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
791
+ });
792
+ },
744
793
  /**
745
794
  * Retrieves metadata for a document. Can filter by keys.
746
795
  * @summary Search metadata of a document
@@ -964,6 +1013,16 @@ export const DocumentControllerApiFactory = function (configuration, basePath, a
964
1013
  getDocumentInfo(documentId, withMetadata, options) {
965
1014
  return localVarFp.getDocumentInfo(documentId, withMetadata, options).then((request) => request(axios, basePath));
966
1015
  },
1016
+ /**
1017
+ * 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.
1018
+ * @summary Get a document\'s integrity ledger
1019
+ * @param {string} documentId
1020
+ * @param {*} [options] Override http request option.
1021
+ * @throws {RequiredError}
1022
+ */
1023
+ getDocumentIntegrity(documentId, options) {
1024
+ return localVarFp.getDocumentIntegrity(documentId, options).then((request) => request(axios, basePath));
1025
+ },
967
1026
  /**
968
1027
  * Retrieves metadata for a document. Can filter by keys.
969
1028
  * @summary Search metadata of a document
@@ -1137,6 +1196,16 @@ export class DocumentControllerApi extends BaseAPI {
1137
1196
  getDocumentInfo(documentId, withMetadata, options) {
1138
1197
  return DocumentControllerApiFp(this.configuration).getDocumentInfo(documentId, withMetadata, options).then((request) => request(this.axios, this.basePath));
1139
1198
  }
1199
+ /**
1200
+ * 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.
1201
+ * @summary Get a document\'s integrity ledger
1202
+ * @param {string} documentId
1203
+ * @param {*} [options] Override http request option.
1204
+ * @throws {RequiredError}
1205
+ */
1206
+ getDocumentIntegrity(documentId, options) {
1207
+ return DocumentControllerApiFp(this.configuration).getDocumentIntegrity(documentId, options).then((request) => request(this.axios, this.basePath));
1208
+ }
1140
1209
  /**
1141
1210
  * Retrieves metadata for a document. Can filter by keys.
1142
1211
  * @summary Search metadata of a document
@@ -0,0 +1,37 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { AuditVerificationResult } from './audit-verification-result';
13
+ /**
14
+ * Last known result of the scheduled audit chain verification on this instance
15
+ */
16
+ export interface AuditIntegrityStatusResponse {
17
+ /**
18
+ * true when the last scheduled pass reported a broken chain
19
+ */
20
+ 'chainBroken'?: boolean;
21
+ /**
22
+ * 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.
23
+ */
24
+ 'verified'?: boolean;
25
+ /**
26
+ * Verdict of the last completed scheduled verification, if any
27
+ */
28
+ 'lastResult'?: AuditVerificationResult;
29
+ /**
30
+ * Why the last scheduled verification could not run, if it failed
31
+ */
32
+ 'lastFailureMessage'?: string;
33
+ /**
34
+ * When the last scheduled verification failed to run, if it did
35
+ */
36
+ 'lastFailureAt'?: string;
37
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,23 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * One entry of a document\'s append-only integrity ledger
14
+ */
15
+ export interface DocumentIntegrityRecord {
16
+ 'documentId'?: string;
17
+ 'storagePath'?: string;
18
+ 'versionId'?: string;
19
+ 'algorithm'?: string;
20
+ 'hash'?: string;
21
+ 'recordedAt'?: string;
22
+ 'recordedBy'?: string;
23
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -7,6 +7,7 @@ export * from './ai-preferences-view';
7
7
  export * from './ai-settings-response';
8
8
  export * from './ancestor-info';
9
9
  export * from './apply-signature-request';
10
+ export * from './audit-integrity-status-response';
10
11
  export * from './audit-log';
11
12
  export * from './audit-log-details';
12
13
  export * from './audit-log-details-one-of';
@@ -35,6 +36,7 @@ export * from './delete-metadata-request';
35
36
  export * from './delete-request';
36
37
  export * from './document-info';
37
38
  export * from './document-insight-view';
39
+ export * from './document-integrity-record';
38
40
  export * from './document-position';
39
41
  export * from './document-version-info';
40
42
  export * from './element-info';
@@ -7,6 +7,7 @@ export * from './ai-preferences-view';
7
7
  export * from './ai-settings-response';
8
8
  export * from './ancestor-info';
9
9
  export * from './apply-signature-request';
10
+ export * from './audit-integrity-status-response';
10
11
  export * from './audit-log';
11
12
  export * from './audit-log-details';
12
13
  export * from './audit-log-details-one-of';
@@ -35,6 +36,7 @@ export * from './delete-metadata-request';
35
36
  export * from './delete-request';
36
37
  export * from './document-info';
37
38
  export * from './document-insight-view';
39
+ export * from './document-integrity-record';
38
40
  export * from './document-position';
39
41
  export * from './document-version-info';
40
42
  export * from './element-info';
@@ -0,0 +1,37 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { AuditVerificationResult } from './audit-verification-result';
13
+ /**
14
+ * Last known result of the scheduled audit chain verification on this instance
15
+ */
16
+ export interface AuditIntegrityStatusResponse {
17
+ /**
18
+ * true when the last scheduled pass reported a broken chain
19
+ */
20
+ 'chainBroken'?: boolean;
21
+ /**
22
+ * 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.
23
+ */
24
+ 'verified'?: boolean;
25
+ /**
26
+ * Verdict of the last completed scheduled verification, if any
27
+ */
28
+ 'lastResult'?: AuditVerificationResult;
29
+ /**
30
+ * Why the last scheduled verification could not run, if it failed
31
+ */
32
+ 'lastFailureMessage'?: string;
33
+ /**
34
+ * When the last scheduled verification failed to run, if it did
35
+ */
36
+ 'lastFailureAt'?: string;
37
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,23 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * One entry of a document\'s append-only integrity ledger
14
+ */
15
+ export interface DocumentIntegrityRecord {
16
+ 'documentId'?: string;
17
+ 'storagePath'?: string;
18
+ 'versionId'?: string;
19
+ 'algorithm'?: string;
20
+ 'hash'?: string;
21
+ 'recordedAt'?: string;
22
+ 'recordedBy'?: string;
23
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -7,6 +7,7 @@ export * from './ai-preferences-view';
7
7
  export * from './ai-settings-response';
8
8
  export * from './ancestor-info';
9
9
  export * from './apply-signature-request';
10
+ export * from './audit-integrity-status-response';
10
11
  export * from './audit-log';
11
12
  export * from './audit-log-details';
12
13
  export * from './audit-log-details-one-of';
@@ -35,6 +36,7 @@ export * from './delete-metadata-request';
35
36
  export * from './delete-request';
36
37
  export * from './document-info';
37
38
  export * from './document-insight-view';
39
+ export * from './document-integrity-record';
38
40
  export * from './document-position';
39
41
  export * from './document-version-info';
40
42
  export * from './element-info';
@@ -23,6 +23,7 @@ __exportStar(require("./ai-preferences-view"), exports);
23
23
  __exportStar(require("./ai-settings-response"), exports);
24
24
  __exportStar(require("./ancestor-info"), exports);
25
25
  __exportStar(require("./apply-signature-request"), exports);
26
+ __exportStar(require("./audit-integrity-status-response"), exports);
26
27
  __exportStar(require("./audit-log"), exports);
27
28
  __exportStar(require("./audit-log-details"), exports);
28
29
  __exportStar(require("./audit-log-details-one-of"), exports);
@@ -51,6 +52,7 @@ __exportStar(require("./delete-metadata-request"), exports);
51
52
  __exportStar(require("./delete-request"), exports);
52
53
  __exportStar(require("./document-info"), exports);
53
54
  __exportStar(require("./document-insight-view"), exports);
55
+ __exportStar(require("./document-integrity-record"), exports);
54
56
  __exportStar(require("./document-position"), exports);
55
57
  __exportStar(require("./document-version-info"), exports);
56
58
  __exportStar(require("./element-info"), exports);
@@ -4,10 +4,55 @@ All URIs are relative to *http://localhost:8081*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**auditIntegrityStatus**](#auditintegritystatus) | **GET** /api/v1/audit/verify/status | Last scheduled audit chain verification|
7
8
  |[**getAuditTrail**](#getaudittrail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource|
8
9
  |[**searchAuditTrail**](#searchaudittrail) | **POST** /api/v1/audit/search | Search for audit trails|
9
10
  |[**verifyChain**](#verifychain) | **GET** /api/v1/audit/verify | Verify audit chain integrity|
10
11
 
12
+ # **auditIntegrityStatus**
13
+ > AuditIntegrityStatusResponse auditIntegrityStatus()
14
+
15
+ 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.
16
+
17
+ ### Example
18
+
19
+ ```typescript
20
+ import {
21
+ AuditControllerApi,
22
+ Configuration
23
+ } from '@openfilz-sdk/typescript';
24
+
25
+ const configuration = new Configuration();
26
+ const apiInstance = new AuditControllerApi(configuration);
27
+
28
+ const { status, data } = await apiInstance.auditIntegrityStatus();
29
+ ```
30
+
31
+ ### Parameters
32
+ This endpoint does not have any parameters.
33
+
34
+
35
+ ### Return type
36
+
37
+ **AuditIntegrityStatusResponse**
38
+
39
+ ### Authorization
40
+
41
+ [keycloak_auth](../README.md#keycloak_auth)
42
+
43
+ ### HTTP request headers
44
+
45
+ - **Content-Type**: Not defined
46
+ - **Accept**: */*
47
+
48
+
49
+ ### HTTP response details
50
+ | Status code | Description | Response headers |
51
+ |-------------|-------------|------------------|
52
+ |**200** | OK | - |
53
+
54
+ [[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)
55
+
11
56
  # **getAuditTrail**
12
57
  > Array<AuditLog> getAuditTrail()
13
58