@openfilz-sdk/typescript 1.3.20 → 1.3.22

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 (43) 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/api/settings-api.ts +18 -11
  7. package/dist/api/audit-controller-api.d.ts +29 -0
  8. package/dist/api/audit-controller-api.js +62 -0
  9. package/dist/api/document-controller-api.d.ts +33 -0
  10. package/dist/api/document-controller-api.js +69 -0
  11. package/dist/api/settings-api.d.ts +12 -8
  12. package/dist/api/settings-api.js +18 -11
  13. package/dist/esm/api/audit-controller-api.d.ts +29 -0
  14. package/dist/esm/api/audit-controller-api.js +62 -0
  15. package/dist/esm/api/document-controller-api.d.ts +33 -0
  16. package/dist/esm/api/document-controller-api.js +69 -0
  17. package/dist/esm/api/settings-api.d.ts +12 -8
  18. package/dist/esm/api/settings-api.js +18 -11
  19. package/dist/esm/models/audit-integrity-status-response.d.ts +37 -0
  20. package/dist/esm/models/audit-integrity-status-response.js +14 -0
  21. package/dist/esm/models/document-integrity-record.d.ts +23 -0
  22. package/dist/esm/models/document-integrity-record.js +14 -0
  23. package/dist/esm/models/index.d.ts +2 -0
  24. package/dist/esm/models/index.js +2 -0
  25. package/dist/esm/models/settings.d.ts +3 -0
  26. package/dist/models/audit-integrity-status-response.d.ts +37 -0
  27. package/dist/models/audit-integrity-status-response.js +15 -0
  28. package/dist/models/document-integrity-record.d.ts +23 -0
  29. package/dist/models/document-integrity-record.js +15 -0
  30. package/dist/models/index.d.ts +2 -0
  31. package/dist/models/index.js +2 -0
  32. package/dist/models/settings.d.ts +3 -0
  33. package/docs/AuditControllerApi.md +45 -0
  34. package/docs/AuditIntegrityStatusResponse.md +29 -0
  35. package/docs/DocumentControllerApi.md +52 -0
  36. package/docs/DocumentIntegrityRecord.md +33 -0
  37. package/docs/Settings.md +2 -0
  38. package/docs/SettingsApi.md +10 -3
  39. package/models/audit-integrity-status-response.ts +45 -0
  40. package/models/document-integrity-record.ts +29 -0
  41. package/models/index.ts +2 -0
  42. package/models/settings.ts +1 -0
  43. package/package.json +1 -1
@@ -61,12 +61,13 @@ export const SettingsApiAxiosParamCreator = function (configuration) {
61
61
  };
62
62
  }),
63
63
  /**
64
- * Retrieve user\'s settings : global settings and user\'s preferences
64
+ * Retrieve user\'s settings : global settings and user\'s preferences. The category labels (aiInsightsCategoryLabels) are in the Accept-Language language, English when it is not supported.
65
65
  * @summary Get user\'s settings
66
+ * @param {string} [acceptLanguage]
66
67
  * @param {*} [options] Override http request option.
67
68
  * @throws {RequiredError}
68
69
  */
69
- getSettings1: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
70
+ getSettings1: (acceptLanguage_1, ...args_1) => __awaiter(this, [acceptLanguage_1, ...args_1], void 0, function* (acceptLanguage, options = {}) {
70
71
  const localVarPath = `/api/v1/settings`;
71
72
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
72
73
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -81,6 +82,9 @@ export const SettingsApiAxiosParamCreator = function (configuration) {
81
82
  // http bearer authentication required
82
83
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
83
84
  localVarHeaderParameter['Accept'] = '*/*';
85
+ if (acceptLanguage != null) {
86
+ localVarHeaderParameter['Accept-Language'] = String(acceptLanguage);
87
+ }
84
88
  setSearchParams(localVarUrlObj, localVarQueryParameter);
85
89
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
86
90
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -151,15 +155,16 @@ export const SettingsApiFp = function (configuration) {
151
155
  });
152
156
  },
153
157
  /**
154
- * Retrieve user\'s settings : global settings and user\'s preferences
158
+ * Retrieve user\'s settings : global settings and user\'s preferences. The category labels (aiInsightsCategoryLabels) are in the Accept-Language language, English when it is not supported.
155
159
  * @summary Get user\'s settings
160
+ * @param {string} [acceptLanguage]
156
161
  * @param {*} [options] Override http request option.
157
162
  * @throws {RequiredError}
158
163
  */
159
- getSettings1(options) {
164
+ getSettings1(acceptLanguage, options) {
160
165
  return __awaiter(this, void 0, void 0, function* () {
161
166
  var _a, _b, _c;
162
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getSettings1(options);
167
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getSettings1(acceptLanguage, options);
163
168
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
164
169
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SettingsApi.getSettings1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
165
170
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -200,13 +205,14 @@ export const SettingsApiFactory = function (configuration, basePath, axios) {
200
205
  return localVarFp.get1(options).then((request) => request(axios, basePath));
201
206
  },
202
207
  /**
203
- * Retrieve user\'s settings : global settings and user\'s preferences
208
+ * Retrieve user\'s settings : global settings and user\'s preferences. The category labels (aiInsightsCategoryLabels) are in the Accept-Language language, English when it is not supported.
204
209
  * @summary Get user\'s settings
210
+ * @param {string} [acceptLanguage]
205
211
  * @param {*} [options] Override http request option.
206
212
  * @throws {RequiredError}
207
213
  */
208
- getSettings1(options) {
209
- return localVarFp.getSettings1(options).then((request) => request(axios, basePath));
214
+ getSettings1(acceptLanguage, options) {
215
+ return localVarFp.getSettings1(acceptLanguage, options).then((request) => request(axios, basePath));
210
216
  },
211
217
  /**
212
218
  * A null field leaves the current value unchanged. inbox=true creates the caller\'s Inbox folder at their root on demand (named from Accept-Language, else the deployment\'s default language); inbox=false forgets it without deleting the folder. 400 when the Inbox is not offered.
@@ -235,13 +241,14 @@ export class SettingsApi extends BaseAPI {
235
241
  return SettingsApiFp(this.configuration).get1(options).then((request) => request(this.axios, this.basePath));
236
242
  }
237
243
  /**
238
- * Retrieve user\'s settings : global settings and user\'s preferences
244
+ * Retrieve user\'s settings : global settings and user\'s preferences. The category labels (aiInsightsCategoryLabels) are in the Accept-Language language, English when it is not supported.
239
245
  * @summary Get user\'s settings
246
+ * @param {string} [acceptLanguage]
240
247
  * @param {*} [options] Override http request option.
241
248
  * @throws {RequiredError}
242
249
  */
243
- getSettings1(options) {
244
- return SettingsApiFp(this.configuration).getSettings1(options).then((request) => request(this.axios, this.basePath));
250
+ getSettings1(acceptLanguage, options) {
251
+ return SettingsApiFp(this.configuration).getSettings1(acceptLanguage, options).then((request) => request(this.axios, this.basePath));
245
252
  }
246
253
  /**
247
254
  * A null field leaves the current value unchanged. inbox=true creates the caller\'s Inbox folder at their root on demand (named from Accept-Language, else the deployment\'s default language); inbox=false forgets it without deleting the folder. 400 when the Inbox is not offered.
@@ -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';
@@ -22,6 +22,9 @@ export interface Settings {
22
22
  'aiUserSettingsEnabled'?: boolean;
23
23
  'aiInsightsActive'?: boolean;
24
24
  'aiInsightsCategories'?: Array<string>;
25
+ 'aiInsightsCategoryLabels'?: {
26
+ [key: string]: string;
27
+ };
25
28
  'aiAutoFileActive'?: boolean;
26
29
  'signatureActive'?: boolean;
27
30
  'pdfToolsActive'?: boolean;
@@ -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);
@@ -22,6 +22,9 @@ export interface Settings {
22
22
  'aiUserSettingsEnabled'?: boolean;
23
23
  'aiInsightsActive'?: boolean;
24
24
  'aiInsightsCategories'?: Array<string>;
25
+ 'aiInsightsCategoryLabels'?: {
26
+ [key: string]: string;
27
+ };
25
28
  'aiAutoFileActive'?: boolean;
26
29
  'signatureActive'?: boolean;
27
30
  'pdfToolsActive'?: boolean;
@@ -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
 
@@ -0,0 +1,29 @@
1
+ # AuditIntegrityStatusResponse
2
+
3
+ Last known result of the scheduled audit chain verification on this instance
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **chainBroken** | **boolean** | true when the last scheduled pass reported a broken chain | [optional] [default to undefined]
10
+ **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]
11
+ **lastResult** | [**AuditVerificationResult**](AuditVerificationResult.md) | Verdict of the last completed scheduled verification, if any | [optional] [default to undefined]
12
+ **lastFailureMessage** | **string** | Why the last scheduled verification could not run, if it failed | [optional] [default to undefined]
13
+ **lastFailureAt** | **string** | When the last scheduled verification failed to run, if it did | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { AuditIntegrityStatusResponse } from '@openfilz-sdk/typescript';
19
+
20
+ const instance: AuditIntegrityStatusResponse = {
21
+ chainBroken,
22
+ verified,
23
+ lastResult,
24
+ lastFailureMessage,
25
+ lastFailureAt,
26
+ };
27
+ ```
28
+
29
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -11,6 +11,7 @@ All URIs are relative to *http://localhost:8081*
11
11
  |[**downloadMultipleDocumentsAsZip**](#downloadmultipledocumentsaszip) | **POST** /api/v1/documents/download-multiple | Download multiple documents as ZIP|
12
12
  |[**getDocumentAncestors**](#getdocumentancestors) | **GET** /api/v1/documents/{documentId}/ancestors | Get document ancestors|
13
13
  |[**getDocumentInfo**](#getdocumentinfo) | **GET** /api/v1/documents/{documentId}/info | Get information of a document|
14
+ |[**getDocumentIntegrity**](#getdocumentintegrity) | **GET** /api/v1/documents/{documentId}/integrity | Get a document\&#39;s integrity ledger|
14
15
  |[**getDocumentMetadata**](#getdocumentmetadata) | **POST** /api/v1/documents/{documentId}/search/metadata | Search metadata of a document|
15
16
  |[**getDocumentPosition**](#getdocumentposition) | **GET** /api/v1/documents/{documentId}/position | Get document position in folder|
16
17
  |[**replaceDocumentContent**](#replacedocumentcontent) | **PUT** /api/v1/documents/{documentId}/replace-content | Replace document content|
@@ -384,6 +385,57 @@ const { status, data } = await apiInstance.getDocumentInfo(
384
385
  - **Accept**: */*
385
386
 
386
387
 
388
+ ### HTTP response details
389
+ | Status code | Description | Response headers |
390
+ |-------------|-------------|------------------|
391
+ |**200** | OK | - |
392
+
393
+ [[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)
394
+
395
+ # **getDocumentIntegrity**
396
+ > Array<DocumentIntegrityRecord> getDocumentIntegrity()
397
+
398
+ 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.
399
+
400
+ ### Example
401
+
402
+ ```typescript
403
+ import {
404
+ DocumentControllerApi,
405
+ Configuration
406
+ } from '@openfilz-sdk/typescript';
407
+
408
+ const configuration = new Configuration();
409
+ const apiInstance = new DocumentControllerApi(configuration);
410
+
411
+ let documentId: string; // (default to undefined)
412
+
413
+ const { status, data } = await apiInstance.getDocumentIntegrity(
414
+ documentId
415
+ );
416
+ ```
417
+
418
+ ### Parameters
419
+
420
+ |Name | Type | Description | Notes|
421
+ |------------- | ------------- | ------------- | -------------|
422
+ | **documentId** | [**string**] | | defaults to undefined|
423
+
424
+
425
+ ### Return type
426
+
427
+ **Array<DocumentIntegrityRecord>**
428
+
429
+ ### Authorization
430
+
431
+ [keycloak_auth](../README.md#keycloak_auth)
432
+
433
+ ### HTTP request headers
434
+
435
+ - **Content-Type**: Not defined
436
+ - **Accept**: */*
437
+
438
+
387
439
  ### HTTP response details
388
440
  | Status code | Description | Response headers |
389
441
  |-------------|-------------|------------------|
@@ -0,0 +1,33 @@
1
+ # DocumentIntegrityRecord
2
+
3
+ One entry of a document\'s append-only integrity ledger
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **documentId** | **string** | | [optional] [default to undefined]
10
+ **storagePath** | **string** | | [optional] [default to undefined]
11
+ **versionId** | **string** | | [optional] [default to undefined]
12
+ **algorithm** | **string** | | [optional] [default to undefined]
13
+ **hash** | **string** | | [optional] [default to undefined]
14
+ **recordedAt** | **string** | | [optional] [default to undefined]
15
+ **recordedBy** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { DocumentIntegrityRecord } from '@openfilz-sdk/typescript';
21
+
22
+ const instance: DocumentIntegrityRecord = {
23
+ documentId,
24
+ storagePath,
25
+ versionId,
26
+ algorithm,
27
+ hash,
28
+ recordedAt,
29
+ recordedBy,
30
+ };
31
+ ```
32
+
33
+ [[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/Settings.md CHANGED
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
17
17
  **aiUserSettingsEnabled** | **boolean** | | [optional] [default to undefined]
18
18
  **aiInsightsActive** | **boolean** | | [optional] [default to undefined]
19
19
  **aiInsightsCategories** | **Array&lt;string&gt;** | | [optional] [default to undefined]
20
+ **aiInsightsCategoryLabels** | **{ [key: string]: string; }** | | [optional] [default to undefined]
20
21
  **aiAutoFileActive** | **boolean** | | [optional] [default to undefined]
21
22
  **signatureActive** | **boolean** | | [optional] [default to undefined]
22
23
  **pdfToolsActive** | **boolean** | | [optional] [default to undefined]
@@ -52,6 +53,7 @@ const instance: Settings = {
52
53
  aiUserSettingsEnabled,
53
54
  aiInsightsActive,
54
55
  aiInsightsCategories,
56
+ aiInsightsCategoryLabels,
55
57
  aiAutoFileActive,
56
58
  signatureActive,
57
59
  pdfToolsActive,
@@ -54,7 +54,7 @@ This endpoint does not have any parameters.
54
54
  # **getSettings1**
55
55
  > Settings getSettings1()
56
56
 
57
- Retrieve user\'s settings : global settings and user\'s preferences
57
+ Retrieve user\'s settings : global settings and user\'s preferences. The category labels (aiInsightsCategoryLabels) are in the Accept-Language language, English when it is not supported.
58
58
 
59
59
  ### Example
60
60
 
@@ -67,11 +67,18 @@ import {
67
67
  const configuration = new Configuration();
68
68
  const apiInstance = new SettingsApi(configuration);
69
69
 
70
- const { status, data } = await apiInstance.getSettings1();
70
+ let acceptLanguage: string; // (optional) (default to undefined)
71
+
72
+ const { status, data } = await apiInstance.getSettings1(
73
+ acceptLanguage
74
+ );
71
75
  ```
72
76
 
73
77
  ### Parameters
74
- This endpoint does not have any parameters.
78
+
79
+ |Name | Type | Description | Notes|
80
+ |------------- | ------------- | ------------- | -------------|
81
+ | **acceptLanguage** | [**string**] | | (optional) defaults to undefined|
75
82
 
76
83
 
77
84
  ### Return type
@@ -0,0 +1,45 @@
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
+
15
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { AuditVerificationResult } from './audit-verification-result';
19
+
20
+ /**
21
+ * Last known result of the scheduled audit chain verification on this instance
22
+ */
23
+ export interface AuditIntegrityStatusResponse {
24
+ /**
25
+ * true when the last scheduled pass reported a broken chain
26
+ */
27
+ 'chainBroken'?: boolean;
28
+ /**
29
+ * 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.
30
+ */
31
+ 'verified'?: boolean;
32
+ /**
33
+ * Verdict of the last completed scheduled verification, if any
34
+ */
35
+ 'lastResult'?: AuditVerificationResult;
36
+ /**
37
+ * Why the last scheduled verification could not run, if it failed
38
+ */
39
+ 'lastFailureMessage'?: string;
40
+ /**
41
+ * When the last scheduled verification failed to run, if it did
42
+ */
43
+ 'lastFailureAt'?: string;
44
+ }
45
+