@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
@@ -40,6 +40,7 @@ docs/AiSettingsResponse.md
40
40
  docs/AncestorInfo.md
41
41
  docs/ApplySignatureRequest.md
42
42
  docs/AuditControllerApi.md
43
+ docs/AuditIntegrityStatusResponse.md
43
44
  docs/AuditLog.md
44
45
  docs/AuditLogDetails.md
45
46
  docs/AuditLogDetailsOneOf.md
@@ -71,6 +72,7 @@ docs/DocumentControllerApi.md
71
72
  docs/DocumentInfo.md
72
73
  docs/DocumentInsightView.md
73
74
  docs/DocumentInsightsApi.md
75
+ docs/DocumentIntegrityRecord.md
74
76
  docs/DocumentPosition.md
75
77
  docs/DocumentSuggestionControllerApi.md
76
78
  docs/DocumentVersionControllerApi.md
@@ -192,6 +194,7 @@ models/ai-preferences-view.ts
192
194
  models/ai-settings-response.ts
193
195
  models/ancestor-info.ts
194
196
  models/apply-signature-request.ts
197
+ models/audit-integrity-status-response.ts
195
198
  models/audit-log-details-one-of.ts
196
199
  models/audit-log-details.ts
197
200
  models/audit-log.ts
@@ -220,6 +223,7 @@ models/delete-metadata-request.ts
220
223
  models/delete-request.ts
221
224
  models/document-info.ts
222
225
  models/document-insight-view.ts
226
+ models/document-integrity-record.ts
223
227
  models/document-position.ts
224
228
  models/document-version-info.ts
225
229
  models/element-info.ts
@@ -1 +1 @@
1
- 92e1063d026df6b8f0edd342f5b536e19993cd2e27bd18a21d56bbf17b60bd0a
1
+ 5028c2728c97b24a1e3d89f156885b27c70c2536b5c7aca4323fbfa321eb42c4
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @openfilz-sdk/typescript@1.3.20
1
+ ## @openfilz-sdk/typescript@1.3.21
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @openfilz-sdk/typescript@1.3.20 --save
39
+ npm install @openfilz-sdk/typescript@1.3.21 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -66,6 +66,7 @@ Class | Method | HTTP request | Description
66
66
  *AISettingsApi* | [**listModels**](docs/AISettingsApi.md#listmodels) | **POST** /api/v1/settings/ai/models | List the provider\'s chat models
67
67
  *AISettingsApi* | [**saveSettings**](docs/AISettingsApi.md#savesettings) | **PUT** /api/v1/settings/ai | Save my AI settings
68
68
  *AISettingsApi* | [**testConnection**](docs/AISettingsApi.md#testconnection) | **POST** /api/v1/settings/ai/test | Test AI provider connection
69
+ *AuditControllerApi* | [**auditIntegrityStatus**](docs/AuditControllerApi.md#auditintegritystatus) | **GET** /api/v1/audit/verify/status | Last scheduled audit chain verification
69
70
  *AuditControllerApi* | [**getAuditTrail**](docs/AuditControllerApi.md#getaudittrail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource
70
71
  *AuditControllerApi* | [**searchAuditTrail**](docs/AuditControllerApi.md#searchaudittrail) | **POST** /api/v1/audit/search | Search for audit trails
71
72
  *AuditControllerApi* | [**verifyChain**](docs/AuditControllerApi.md#verifychain) | **GET** /api/v1/audit/verify | Verify audit chain integrity
@@ -77,6 +78,7 @@ Class | Method | HTTP request | Description
77
78
  *DocumentControllerApi* | [**downloadMultipleDocumentsAsZip**](docs/DocumentControllerApi.md#downloadmultipledocumentsaszip) | **POST** /api/v1/documents/download-multiple | Download multiple documents as ZIP
78
79
  *DocumentControllerApi* | [**getDocumentAncestors**](docs/DocumentControllerApi.md#getdocumentancestors) | **GET** /api/v1/documents/{documentId}/ancestors | Get document ancestors
79
80
  *DocumentControllerApi* | [**getDocumentInfo**](docs/DocumentControllerApi.md#getdocumentinfo) | **GET** /api/v1/documents/{documentId}/info | Get information of a document
81
+ *DocumentControllerApi* | [**getDocumentIntegrity**](docs/DocumentControllerApi.md#getdocumentintegrity) | **GET** /api/v1/documents/{documentId}/integrity | Get a document\'s integrity ledger
80
82
  *DocumentControllerApi* | [**getDocumentMetadata**](docs/DocumentControllerApi.md#getdocumentmetadata) | **POST** /api/v1/documents/{documentId}/search/metadata | Search metadata of a document
81
83
  *DocumentControllerApi* | [**getDocumentPosition**](docs/DocumentControllerApi.md#getdocumentposition) | **GET** /api/v1/documents/{documentId}/position | Get document position in folder
82
84
  *DocumentControllerApi* | [**replaceDocumentContent**](docs/DocumentControllerApi.md#replacedocumentcontent) | **PUT** /api/v1/documents/{documentId}/replace-content | Replace document content
@@ -186,6 +188,7 @@ Class | Method | HTTP request | Description
186
188
  - [AiSettingsResponse](docs/AiSettingsResponse.md)
187
189
  - [AncestorInfo](docs/AncestorInfo.md)
188
190
  - [ApplySignatureRequest](docs/ApplySignatureRequest.md)
191
+ - [AuditIntegrityStatusResponse](docs/AuditIntegrityStatusResponse.md)
189
192
  - [AuditLog](docs/AuditLog.md)
190
193
  - [AuditLogDetails](docs/AuditLogDetails.md)
191
194
  - [AuditLogDetailsOneOf](docs/AuditLogDetailsOneOf.md)
@@ -214,6 +217,7 @@ Class | Method | HTTP request | Description
214
217
  - [DeleteRequest](docs/DeleteRequest.md)
215
218
  - [DocumentInfo](docs/DocumentInfo.md)
216
219
  - [DocumentInsightView](docs/DocumentInsightView.md)
220
+ - [DocumentIntegrityRecord](docs/DocumentIntegrityRecord.md)
217
221
  - [DocumentPosition](docs/DocumentPosition.md)
218
222
  - [DocumentVersionInfo](docs/DocumentVersionInfo.md)
219
223
  - [ElementInfo](docs/ElementInfo.md)
@@ -22,6 +22,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  // @ts-ignore
23
23
  import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
24
  // @ts-ignore
25
+ import type { AuditIntegrityStatusResponse } from '../models';
26
+ // @ts-ignore
25
27
  import type { AuditLog } from '../models';
26
28
  // @ts-ignore
27
29
  import type { AuditVerificationResult } from '../models';
@@ -32,6 +34,40 @@ import type { SearchByAuditLogRequest } from '../models';
32
34
  */
33
35
  export const AuditControllerApiAxiosParamCreator = function (configuration?: Configuration) {
34
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: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
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, DUMMY_BASE_URL);
47
+ let baseOptions;
48
+ if (configuration) {
49
+ baseOptions = configuration.baseOptions;
50
+ }
51
+
52
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
53
+ const localVarHeaderParameter = {} as any;
54
+ const localVarQueryParameter = {} as any;
55
+
56
+ // authentication keycloak_auth required
57
+ // http bearer authentication required
58
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
59
+
60
+ localVarHeaderParameter['Accept'] = '*/*';
61
+
62
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
63
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
64
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
65
+
66
+ return {
67
+ url: toPathString(localVarUrlObj),
68
+ options: localVarRequestOptions,
69
+ };
70
+ },
35
71
  /**
36
72
  * Retrieves the audit trail for a given resource.
37
73
  * @summary Get audit trail for a resource
@@ -157,6 +193,18 @@ export const AuditControllerApiAxiosParamCreator = function (configuration?: Con
157
193
  export const AuditControllerApiFp = function(configuration?: Configuration) {
158
194
  const localVarAxiosParamCreator = AuditControllerApiAxiosParamCreator(configuration)
159
195
  return {
196
+ /**
197
+ * 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.
198
+ * @summary Last scheduled audit chain verification
199
+ * @param {*} [options] Override http request option.
200
+ * @throws {RequiredError}
201
+ */
202
+ async auditIntegrityStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuditIntegrityStatusResponse>> {
203
+ const localVarAxiosArgs = await localVarAxiosParamCreator.auditIntegrityStatus(options);
204
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
205
+ const localVarOperationServerBasePath = operationServerMap['AuditControllerApi.auditIntegrityStatus']?.[localVarOperationServerIndex]?.url;
206
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
207
+ },
160
208
  /**
161
209
  * Retrieves the audit trail for a given resource.
162
210
  * @summary Get audit trail for a resource
@@ -205,6 +253,15 @@ export const AuditControllerApiFp = function(configuration?: Configuration) {
205
253
  export const AuditControllerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
206
254
  const localVarFp = AuditControllerApiFp(configuration)
207
255
  return {
256
+ /**
257
+ * 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.
258
+ * @summary Last scheduled audit chain verification
259
+ * @param {*} [options] Override http request option.
260
+ * @throws {RequiredError}
261
+ */
262
+ auditIntegrityStatus(options?: RawAxiosRequestConfig): AxiosPromise<AuditIntegrityStatusResponse> {
263
+ return localVarFp.auditIntegrityStatus(options).then((request) => request(axios, basePath));
264
+ },
208
265
  /**
209
266
  * Retrieves the audit trail for a given resource.
210
267
  * @summary Get audit trail for a resource
@@ -242,6 +299,16 @@ export const AuditControllerApiFactory = function (configuration?: Configuration
242
299
  * AuditControllerApi - object-oriented interface
243
300
  */
244
301
  export class AuditControllerApi extends BaseAPI {
302
+ /**
303
+ * 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.
304
+ * @summary Last scheduled audit chain verification
305
+ * @param {*} [options] Override http request option.
306
+ * @throws {RequiredError}
307
+ */
308
+ public auditIntegrityStatus(options?: RawAxiosRequestConfig) {
309
+ return AuditControllerApiFp(this.configuration).auditIntegrityStatus(options).then((request) => request(this.axios, this.basePath));
310
+ }
311
+
245
312
  /**
246
313
  * Retrieves the audit trail for a given resource.
247
314
  * @summary Get audit trail for a resource
@@ -30,6 +30,8 @@ import type { DeleteMetadataRequest } from '../models';
30
30
  // @ts-ignore
31
31
  import type { DocumentInfo } from '../models';
32
32
  // @ts-ignore
33
+ import type { DocumentIntegrityRecord } from '../models';
34
+ // @ts-ignore
33
35
  import type { DocumentPosition } from '../models';
34
36
  // @ts-ignore
35
37
  import type { ElementInfo } from '../models';
@@ -335,6 +337,44 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration?:
335
337
  options: localVarRequestOptions,
336
338
  };
337
339
  },
340
+ /**
341
+ * 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.
342
+ * @summary Get a document\'s integrity ledger
343
+ * @param {string} documentId
344
+ * @param {*} [options] Override http request option.
345
+ * @throws {RequiredError}
346
+ */
347
+ getDocumentIntegrity: async (documentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
348
+ // verify required parameter 'documentId' is not null or undefined
349
+ assertParamExists('getDocumentIntegrity', 'documentId', documentId)
350
+ const localVarPath = `/api/v1/documents/{documentId}/integrity`
351
+ .replace('{documentId}', encodeURIComponent(String(documentId)));
352
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
353
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
354
+ let baseOptions;
355
+ if (configuration) {
356
+ baseOptions = configuration.baseOptions;
357
+ }
358
+
359
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
360
+ const localVarHeaderParameter = {} as any;
361
+ const localVarQueryParameter = {} as any;
362
+
363
+ // authentication keycloak_auth required
364
+ // http bearer authentication required
365
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
366
+
367
+ localVarHeaderParameter['Accept'] = '*/*';
368
+
369
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
370
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
371
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
372
+
373
+ return {
374
+ url: toPathString(localVarUrlObj),
375
+ options: localVarRequestOptions,
376
+ };
377
+ },
338
378
  /**
339
379
  * Retrieves metadata for a document. Can filter by keys.
340
380
  * @summary Search metadata of a document
@@ -826,6 +866,19 @@ export const DocumentControllerApiFp = function(configuration?: Configuration) {
826
866
  const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.getDocumentInfo']?.[localVarOperationServerIndex]?.url;
827
867
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
828
868
  },
869
+ /**
870
+ * 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.
871
+ * @summary Get a document\'s integrity ledger
872
+ * @param {string} documentId
873
+ * @param {*} [options] Override http request option.
874
+ * @throws {RequiredError}
875
+ */
876
+ async getDocumentIntegrity(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<DocumentIntegrityRecord>>> {
877
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentIntegrity(documentId, options);
878
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
879
+ const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.getDocumentIntegrity']?.[localVarOperationServerIndex]?.url;
880
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
881
+ },
829
882
  /**
830
883
  * Retrieves metadata for a document. Can filter by keys.
831
884
  * @summary Search metadata of a document
@@ -1026,6 +1079,16 @@ export const DocumentControllerApiFactory = function (configuration?: Configurat
1026
1079
  getDocumentInfo(documentId: string, withMetadata?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInfo> {
1027
1080
  return localVarFp.getDocumentInfo(documentId, withMetadata, options).then((request) => request(axios, basePath));
1028
1081
  },
1082
+ /**
1083
+ * 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.
1084
+ * @summary Get a document\'s integrity ledger
1085
+ * @param {string} documentId
1086
+ * @param {*} [options] Override http request option.
1087
+ * @throws {RequiredError}
1088
+ */
1089
+ getDocumentIntegrity(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<DocumentIntegrityRecord>> {
1090
+ return localVarFp.getDocumentIntegrity(documentId, options).then((request) => request(axios, basePath));
1091
+ },
1029
1092
  /**
1030
1093
  * Retrieves metadata for a document. Can filter by keys.
1031
1094
  * @summary Search metadata of a document
@@ -1207,6 +1270,17 @@ export class DocumentControllerApi extends BaseAPI {
1207
1270
  return DocumentControllerApiFp(this.configuration).getDocumentInfo(documentId, withMetadata, options).then((request) => request(this.axios, this.basePath));
1208
1271
  }
1209
1272
 
1273
+ /**
1274
+ * 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.
1275
+ * @summary Get a document\'s integrity ledger
1276
+ * @param {string} documentId
1277
+ * @param {*} [options] Override http request option.
1278
+ * @throws {RequiredError}
1279
+ */
1280
+ public getDocumentIntegrity(documentId: string, options?: RawAxiosRequestConfig) {
1281
+ return DocumentControllerApiFp(this.configuration).getDocumentIntegrity(documentId, options).then((request) => request(this.axios, this.basePath));
1282
+ }
1283
+
1210
1284
  /**
1211
1285
  * Retrieves metadata for a document. Can filter by keys.
1212
1286
  * @summary Search metadata of a document
@@ -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
@@ -34,6 +34,35 @@ const base_1 = require("../base");
34
34
  */
35
35
  const AuditControllerApiAxiosParamCreator = 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
  * Retrieves the audit trail for a given resource.
39
68
  * @summary Get audit trail for a resource
@@ -143,6 +172,21 @@ exports.AuditControllerApiAxiosParamCreator = AuditControllerApiAxiosParamCreato
143
172
  const AuditControllerApiFp = function (configuration) {
144
173
  const localVarAxiosParamCreator = (0, exports.AuditControllerApiAxiosParamCreator)(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['AuditControllerApi.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
  * Retrieves the audit trail for a given resource.
148
192
  * @summary Get audit trail for a resource
@@ -200,6 +244,15 @@ exports.AuditControllerApiFp = AuditControllerApiFp;
200
244
  const AuditControllerApiFactory = function (configuration, basePath, axios) {
201
245
  const localVarFp = (0, exports.AuditControllerApiFp)(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
  * Retrieves the audit trail for a given resource.
205
258
  * @summary Get audit trail for a resource
@@ -237,6 +290,15 @@ exports.AuditControllerApiFactory = AuditControllerApiFactory;
237
290
  * AuditControllerApi - object-oriented interface
238
291
  */
239
292
  class AuditControllerApi 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.AuditControllerApiFp)(this.configuration).auditIntegrityStatus(options).then((request) => request(this.axios, this.basePath));
301
+ }
240
302
  /**
241
303
  * Retrieves the audit trail for a given resource.
242
304
  * @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
@@ -285,6 +285,39 @@ const DocumentControllerApiAxiosParamCreator = function (configuration) {
285
285
  options: localVarRequestOptions,
286
286
  };
287
287
  }),
288
+ /**
289
+ * 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.
290
+ * @summary Get a document\'s integrity ledger
291
+ * @param {string} documentId
292
+ * @param {*} [options] Override http request option.
293
+ * @throws {RequiredError}
294
+ */
295
+ getDocumentIntegrity: (documentId_1, ...args_1) => __awaiter(this, [documentId_1, ...args_1], void 0, function* (documentId, options = {}) {
296
+ // verify required parameter 'documentId' is not null or undefined
297
+ (0, common_1.assertParamExists)('getDocumentIntegrity', 'documentId', documentId);
298
+ const localVarPath = `/api/v1/documents/{documentId}/integrity`
299
+ .replace('{documentId}', encodeURIComponent(String(documentId)));
300
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
301
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
302
+ let baseOptions;
303
+ if (configuration) {
304
+ baseOptions = configuration.baseOptions;
305
+ }
306
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
307
+ const localVarHeaderParameter = {};
308
+ const localVarQueryParameter = {};
309
+ // authentication keycloak_auth required
310
+ // http bearer authentication required
311
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
312
+ localVarHeaderParameter['Accept'] = '*/*';
313
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
314
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
315
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
316
+ return {
317
+ url: (0, common_1.toPathString)(localVarUrlObj),
318
+ options: localVarRequestOptions,
319
+ };
320
+ }),
288
321
  /**
289
322
  * Retrieves metadata for a document. Can filter by keys.
290
323
  * @summary Search metadata of a document
@@ -745,6 +778,22 @@ const DocumentControllerApiFp = function (configuration) {
745
778
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
746
779
  });
747
780
  },
781
+ /**
782
+ * 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.
783
+ * @summary Get a document\'s integrity ledger
784
+ * @param {string} documentId
785
+ * @param {*} [options] Override http request option.
786
+ * @throws {RequiredError}
787
+ */
788
+ getDocumentIntegrity(documentId, options) {
789
+ return __awaiter(this, void 0, void 0, function* () {
790
+ var _a, _b, _c;
791
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getDocumentIntegrity(documentId, options);
792
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
793
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DocumentControllerApi.getDocumentIntegrity']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
794
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
795
+ });
796
+ },
748
797
  /**
749
798
  * Retrieves metadata for a document. Can filter by keys.
750
799
  * @summary Search metadata of a document
@@ -969,6 +1018,16 @@ const DocumentControllerApiFactory = function (configuration, basePath, axios) {
969
1018
  getDocumentInfo(documentId, withMetadata, options) {
970
1019
  return localVarFp.getDocumentInfo(documentId, withMetadata, options).then((request) => request(axios, basePath));
971
1020
  },
1021
+ /**
1022
+ * 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.
1023
+ * @summary Get a document\'s integrity ledger
1024
+ * @param {string} documentId
1025
+ * @param {*} [options] Override http request option.
1026
+ * @throws {RequiredError}
1027
+ */
1028
+ getDocumentIntegrity(documentId, options) {
1029
+ return localVarFp.getDocumentIntegrity(documentId, options).then((request) => request(axios, basePath));
1030
+ },
972
1031
  /**
973
1032
  * Retrieves metadata for a document. Can filter by keys.
974
1033
  * @summary Search metadata of a document
@@ -1143,6 +1202,16 @@ class DocumentControllerApi extends base_1.BaseAPI {
1143
1202
  getDocumentInfo(documentId, withMetadata, options) {
1144
1203
  return (0, exports.DocumentControllerApiFp)(this.configuration).getDocumentInfo(documentId, withMetadata, options).then((request) => request(this.axios, this.basePath));
1145
1204
  }
1205
+ /**
1206
+ * 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.
1207
+ * @summary Get a document\'s integrity ledger
1208
+ * @param {string} documentId
1209
+ * @param {*} [options] Override http request option.
1210
+ * @throws {RequiredError}
1211
+ */
1212
+ getDocumentIntegrity(documentId, options) {
1213
+ return (0, exports.DocumentControllerApiFp)(this.configuration).getDocumentIntegrity(documentId, options).then((request) => request(this.axios, this.basePath));
1214
+ }
1146
1215
  /**
1147
1216
  * Retrieves metadata for a document. Can filter by keys.
1148
1217
  * @summary Search metadata of a document