@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
@@ -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
@@ -27,12 +27,13 @@ export declare const SettingsApiAxiosParamCreator: (configuration?: Configuratio
27
27
  */
28
28
  get1: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
29
29
  /**
30
- * Retrieve user\'s settings : global settings and user\'s preferences
30
+ * 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.
31
31
  * @summary Get user\'s settings
32
+ * @param {string} [acceptLanguage]
32
33
  * @param {*} [options] Override http request option.
33
34
  * @throws {RequiredError}
34
35
  */
35
- getSettings1: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
36
+ getSettings1: (acceptLanguage?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
36
37
  /**
37
38
  * 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.
38
39
  * @summary Save the caller\'s smart-filing preferences
@@ -55,12 +56,13 @@ export declare const SettingsApiFp: (configuration?: Configuration) => {
55
56
  */
56
57
  get1(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>>;
57
58
  /**
58
- * Retrieve user\'s settings : global settings and user\'s preferences
59
+ * 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.
59
60
  * @summary Get user\'s settings
61
+ * @param {string} [acceptLanguage]
60
62
  * @param {*} [options] Override http request option.
61
63
  * @throws {RequiredError}
62
64
  */
63
- getSettings1(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Settings>>;
65
+ getSettings1(acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Settings>>;
64
66
  /**
65
67
  * 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.
66
68
  * @summary Save the caller\'s smart-filing preferences
@@ -83,12 +85,13 @@ export declare const SettingsApiFactory: (configuration?: Configuration, basePat
83
85
  */
84
86
  get1(options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView>;
85
87
  /**
86
- * Retrieve user\'s settings : global settings and user\'s preferences
88
+ * 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.
87
89
  * @summary Get user\'s settings
90
+ * @param {string} [acceptLanguage]
88
91
  * @param {*} [options] Override http request option.
89
92
  * @throws {RequiredError}
90
93
  */
91
- getSettings1(options?: RawAxiosRequestConfig): AxiosPromise<Settings>;
94
+ getSettings1(acceptLanguage?: string, options?: RawAxiosRequestConfig): AxiosPromise<Settings>;
92
95
  /**
93
96
  * 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.
94
97
  * @summary Save the caller\'s smart-filing preferences
@@ -111,12 +114,13 @@ export declare class SettingsApi extends BaseAPI {
111
114
  */
112
115
  get1(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPreferencesView, any, {}>>;
113
116
  /**
114
- * Retrieve user\'s settings : global settings and user\'s preferences
117
+ * 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.
115
118
  * @summary Get user\'s settings
119
+ * @param {string} [acceptLanguage]
116
120
  * @param {*} [options] Override http request option.
117
121
  * @throws {RequiredError}
118
122
  */
119
- getSettings1(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Settings, any, {}>>;
123
+ getSettings1(acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Settings, any, {}>>;
120
124
  /**
121
125
  * 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.
122
126
  * @summary Save the caller\'s smart-filing preferences
@@ -64,12 +64,13 @@ const SettingsApiAxiosParamCreator = function (configuration) {
64
64
  };
65
65
  }),
66
66
  /**
67
- * Retrieve user\'s settings : global settings and user\'s preferences
67
+ * 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.
68
68
  * @summary Get user\'s settings
69
+ * @param {string} [acceptLanguage]
69
70
  * @param {*} [options] Override http request option.
70
71
  * @throws {RequiredError}
71
72
  */
72
- getSettings1: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
73
+ getSettings1: (acceptLanguage_1, ...args_1) => __awaiter(this, [acceptLanguage_1, ...args_1], void 0, function* (acceptLanguage, options = {}) {
73
74
  const localVarPath = `/api/v1/settings`;
74
75
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
75
76
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -84,6 +85,9 @@ const SettingsApiAxiosParamCreator = function (configuration) {
84
85
  // http bearer authentication required
85
86
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
86
87
  localVarHeaderParameter['Accept'] = '*/*';
88
+ if (acceptLanguage != null) {
89
+ localVarHeaderParameter['Accept-Language'] = String(acceptLanguage);
90
+ }
87
91
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
88
92
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
89
93
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -155,15 +159,16 @@ const SettingsApiFp = function (configuration) {
155
159
  });
156
160
  },
157
161
  /**
158
- * Retrieve user\'s settings : global settings and user\'s preferences
162
+ * 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.
159
163
  * @summary Get user\'s settings
164
+ * @param {string} [acceptLanguage]
160
165
  * @param {*} [options] Override http request option.
161
166
  * @throws {RequiredError}
162
167
  */
163
- getSettings1(options) {
168
+ getSettings1(acceptLanguage, options) {
164
169
  return __awaiter(this, void 0, void 0, function* () {
165
170
  var _a, _b, _c;
166
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getSettings1(options);
171
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getSettings1(acceptLanguage, options);
167
172
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
168
173
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['SettingsApi.getSettings1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
169
174
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -205,13 +210,14 @@ const SettingsApiFactory = function (configuration, basePath, axios) {
205
210
  return localVarFp.get1(options).then((request) => request(axios, basePath));
206
211
  },
207
212
  /**
208
- * Retrieve user\'s settings : global settings and user\'s preferences
213
+ * 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.
209
214
  * @summary Get user\'s settings
215
+ * @param {string} [acceptLanguage]
210
216
  * @param {*} [options] Override http request option.
211
217
  * @throws {RequiredError}
212
218
  */
213
- getSettings1(options) {
214
- return localVarFp.getSettings1(options).then((request) => request(axios, basePath));
219
+ getSettings1(acceptLanguage, options) {
220
+ return localVarFp.getSettings1(acceptLanguage, options).then((request) => request(axios, basePath));
215
221
  },
216
222
  /**
217
223
  * 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.
@@ -241,13 +247,14 @@ class SettingsApi extends base_1.BaseAPI {
241
247
  return (0, exports.SettingsApiFp)(this.configuration).get1(options).then((request) => request(this.axios, this.basePath));
242
248
  }
243
249
  /**
244
- * Retrieve user\'s settings : global settings and user\'s preferences
250
+ * 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.
245
251
  * @summary Get user\'s settings
252
+ * @param {string} [acceptLanguage]
246
253
  * @param {*} [options] Override http request option.
247
254
  * @throws {RequiredError}
248
255
  */
249
- getSettings1(options) {
250
- return (0, exports.SettingsApiFp)(this.configuration).getSettings1(options).then((request) => request(this.axios, this.basePath));
256
+ getSettings1(acceptLanguage, options) {
257
+ return (0, exports.SettingsApiFp)(this.configuration).getSettings1(acceptLanguage, options).then((request) => request(this.axios, this.basePath));
251
258
  }
252
259
  /**
253
260
  * 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.
@@ -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
@@ -27,12 +27,13 @@ export declare const SettingsApiAxiosParamCreator: (configuration?: Configuratio
27
27
  */
28
28
  get1: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
29
29
  /**
30
- * Retrieve user\'s settings : global settings and user\'s preferences
30
+ * 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.
31
31
  * @summary Get user\'s settings
32
+ * @param {string} [acceptLanguage]
32
33
  * @param {*} [options] Override http request option.
33
34
  * @throws {RequiredError}
34
35
  */
35
- getSettings1: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
36
+ getSettings1: (acceptLanguage?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
36
37
  /**
37
38
  * 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.
38
39
  * @summary Save the caller\'s smart-filing preferences
@@ -55,12 +56,13 @@ export declare const SettingsApiFp: (configuration?: Configuration) => {
55
56
  */
56
57
  get1(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>>;
57
58
  /**
58
- * Retrieve user\'s settings : global settings and user\'s preferences
59
+ * 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.
59
60
  * @summary Get user\'s settings
61
+ * @param {string} [acceptLanguage]
60
62
  * @param {*} [options] Override http request option.
61
63
  * @throws {RequiredError}
62
64
  */
63
- getSettings1(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Settings>>;
65
+ getSettings1(acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Settings>>;
64
66
  /**
65
67
  * 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.
66
68
  * @summary Save the caller\'s smart-filing preferences
@@ -83,12 +85,13 @@ export declare const SettingsApiFactory: (configuration?: Configuration, basePat
83
85
  */
84
86
  get1(options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView>;
85
87
  /**
86
- * Retrieve user\'s settings : global settings and user\'s preferences
88
+ * 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.
87
89
  * @summary Get user\'s settings
90
+ * @param {string} [acceptLanguage]
88
91
  * @param {*} [options] Override http request option.
89
92
  * @throws {RequiredError}
90
93
  */
91
- getSettings1(options?: RawAxiosRequestConfig): AxiosPromise<Settings>;
94
+ getSettings1(acceptLanguage?: string, options?: RawAxiosRequestConfig): AxiosPromise<Settings>;
92
95
  /**
93
96
  * 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.
94
97
  * @summary Save the caller\'s smart-filing preferences
@@ -111,12 +114,13 @@ export declare class SettingsApi extends BaseAPI {
111
114
  */
112
115
  get1(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPreferencesView, any, {}>>;
113
116
  /**
114
- * Retrieve user\'s settings : global settings and user\'s preferences
117
+ * 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.
115
118
  * @summary Get user\'s settings
119
+ * @param {string} [acceptLanguage]
116
120
  * @param {*} [options] Override http request option.
117
121
  * @throws {RequiredError}
118
122
  */
119
- getSettings1(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Settings, any, {}>>;
123
+ getSettings1(acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Settings, any, {}>>;
120
124
  /**
121
125
  * 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.
122
126
  * @summary Save the caller\'s smart-filing preferences