@openfilz-sdk/typescript 1.3.19 → 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 (83) hide show
  1. package/.openapi-generator/FILES +10 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +11 -2
  4. package/api/audit-controller-api.ts +67 -0
  5. package/api/document-controller-api.ts +74 -0
  6. package/api/document-insights-api.ts +71 -4
  7. package/api/settings-api.ts +18 -11
  8. package/api/smart-filing-api.ts +73 -0
  9. package/dist/api/audit-controller-api.d.ts +29 -0
  10. package/dist/api/audit-controller-api.js +62 -0
  11. package/dist/api/document-controller-api.d.ts +33 -0
  12. package/dist/api/document-controller-api.js +69 -0
  13. package/dist/api/document-insights-api.d.ts +33 -4
  14. package/dist/api/document-insights-api.js +66 -4
  15. package/dist/api/settings-api.d.ts +12 -8
  16. package/dist/api/settings-api.js +18 -11
  17. package/dist/api/smart-filing-api.d.ts +33 -0
  18. package/dist/api/smart-filing-api.js +68 -0
  19. package/dist/esm/api/audit-controller-api.d.ts +29 -0
  20. package/dist/esm/api/audit-controller-api.js +62 -0
  21. package/dist/esm/api/document-controller-api.d.ts +33 -0
  22. package/dist/esm/api/document-controller-api.js +69 -0
  23. package/dist/esm/api/document-insights-api.d.ts +33 -4
  24. package/dist/esm/api/document-insights-api.js +66 -4
  25. package/dist/esm/api/settings-api.d.ts +12 -8
  26. package/dist/esm/api/settings-api.js +18 -11
  27. package/dist/esm/api/smart-filing-api.d.ts +33 -0
  28. package/dist/esm/api/smart-filing-api.js +68 -0
  29. package/dist/esm/models/ai-preferences-view.d.ts +3 -0
  30. package/dist/esm/models/audit-integrity-status-response.d.ts +37 -0
  31. package/dist/esm/models/audit-integrity-status-response.js +14 -0
  32. package/dist/esm/models/auto-file-inbox-request.d.ts +14 -0
  33. package/dist/esm/models/auto-file-inbox-request.js +14 -0
  34. package/dist/esm/models/document-integrity-record.d.ts +23 -0
  35. package/dist/esm/models/document-integrity-record.js +14 -0
  36. package/dist/esm/models/facet.d.ts +15 -0
  37. package/dist/esm/models/facet.js +14 -0
  38. package/dist/esm/models/index.d.ts +5 -0
  39. package/dist/esm/models/index.js +5 -0
  40. package/dist/esm/models/insight-facets.d.ts +16 -0
  41. package/dist/esm/models/insight-facets.js +14 -0
  42. package/dist/esm/models/save-ai-preferences-request.d.ts +1 -0
  43. package/dist/esm/models/settings.d.ts +1 -0
  44. package/dist/models/ai-preferences-view.d.ts +3 -0
  45. package/dist/models/audit-integrity-status-response.d.ts +37 -0
  46. package/dist/models/audit-integrity-status-response.js +15 -0
  47. package/dist/models/auto-file-inbox-request.d.ts +14 -0
  48. package/dist/models/auto-file-inbox-request.js +15 -0
  49. package/dist/models/document-integrity-record.d.ts +23 -0
  50. package/dist/models/document-integrity-record.js +15 -0
  51. package/dist/models/facet.d.ts +15 -0
  52. package/dist/models/facet.js +15 -0
  53. package/dist/models/index.d.ts +5 -0
  54. package/dist/models/index.js +5 -0
  55. package/dist/models/insight-facets.d.ts +16 -0
  56. package/dist/models/insight-facets.js +15 -0
  57. package/dist/models/save-ai-preferences-request.d.ts +1 -0
  58. package/dist/models/settings.d.ts +1 -0
  59. package/docs/AiPreferencesView.md +6 -0
  60. package/docs/AuditControllerApi.md +45 -0
  61. package/docs/AuditIntegrityStatusResponse.md +29 -0
  62. package/docs/AutoFileInboxRequest.md +20 -0
  63. package/docs/DocumentControllerApi.md +52 -0
  64. package/docs/DocumentInsightsApi.md +46 -1
  65. package/docs/DocumentIntegrityRecord.md +33 -0
  66. package/docs/Facet.md +22 -0
  67. package/docs/InsightFacets.md +22 -0
  68. package/docs/SaveAiPreferencesRequest.md +2 -0
  69. package/docs/Settings.md +2 -0
  70. package/docs/SettingsApi.md +5 -2
  71. package/docs/SmartFilingApi.md +53 -0
  72. package/graphql/document-search.graphqls +4 -0
  73. package/graphql/document.graphqls +4 -0
  74. package/models/ai-preferences-view.ts +3 -0
  75. package/models/audit-integrity-status-response.ts +45 -0
  76. package/models/auto-file-inbox-request.ts +20 -0
  77. package/models/document-integrity-record.ts +29 -0
  78. package/models/facet.ts +21 -0
  79. package/models/index.ts +5 -0
  80. package/models/insight-facets.ts +24 -0
  81. package/models/save-ai-preferences-request.ts +1 -0
  82. package/models/settings.ts +1 -0
  83. package/package.json +1 -1
@@ -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 { AutoFileInboxRequest } from '../models';
26
+ // @ts-ignore
25
27
  import type { AutoFileJobView } from '../models';
26
28
  // @ts-ignore
27
29
  import type { AutoFileJobsRequest } from '../models';
@@ -73,6 +75,43 @@ export const SmartFilingApiAxiosParamCreator = function (configuration?: Configu
73
75
  options: localVarRequestOptions,
74
76
  };
75
77
  },
78
+ /**
79
+ * Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
80
+ * @summary File everything lying loose in the caller\'s Inbox
81
+ * @param {AutoFileInboxRequest} [autoFileInboxRequest]
82
+ * @param {*} [options] Override http request option.
83
+ * @throws {RequiredError}
84
+ */
85
+ fileInbox: async (autoFileInboxRequest?: AutoFileInboxRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
86
+ const localVarPath = `/api/v1/ai/auto-file/inbox`;
87
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
88
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
89
+ let baseOptions;
90
+ if (configuration) {
91
+ baseOptions = configuration.baseOptions;
92
+ }
93
+
94
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
95
+ const localVarHeaderParameter = {} as any;
96
+ const localVarQueryParameter = {} as any;
97
+
98
+ // authentication keycloak_auth required
99
+ // http bearer authentication required
100
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
101
+
102
+ localVarHeaderParameter['Content-Type'] = 'application/json';
103
+ localVarHeaderParameter['Accept'] = 'application/json';
104
+
105
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
106
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
107
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
108
+ localVarRequestOptions.data = serializeDataIfNeeded(autoFileInboxRequest, localVarRequestOptions, configuration)
109
+
110
+ return {
111
+ url: toPathString(localVarUrlObj),
112
+ options: localVarRequestOptions,
113
+ };
114
+ },
76
115
  /**
77
116
  *
78
117
  * @summary Progress and outcome of a filing job
@@ -286,6 +325,19 @@ export const SmartFilingApiFp = function(configuration?: Configuration) {
286
325
  const localVarOperationServerBasePath = operationServerMap['SmartFilingApi.file']?.[localVarOperationServerIndex]?.url;
287
326
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
288
327
  },
328
+ /**
329
+ * Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
330
+ * @summary File everything lying loose in the caller\'s Inbox
331
+ * @param {AutoFileInboxRequest} [autoFileInboxRequest]
332
+ * @param {*} [options] Override http request option.
333
+ * @throws {RequiredError}
334
+ */
335
+ async fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>> {
336
+ const localVarAxiosArgs = await localVarAxiosParamCreator.fileInbox(autoFileInboxRequest, options);
337
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
338
+ const localVarOperationServerBasePath = operationServerMap['SmartFilingApi.fileInbox']?.[localVarOperationServerIndex]?.url;
339
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
340
+ },
289
341
  /**
290
342
  *
291
343
  * @summary Progress and outcome of a filing job
@@ -370,6 +422,16 @@ export const SmartFilingApiFactory = function (configuration?: Configuration, ba
370
422
  file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView> {
371
423
  return localVarFp.file(autoFileRequest, options).then((request) => request(axios, basePath));
372
424
  },
425
+ /**
426
+ * Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
427
+ * @summary File everything lying loose in the caller\'s Inbox
428
+ * @param {AutoFileInboxRequest} [autoFileInboxRequest]
429
+ * @param {*} [options] Override http request option.
430
+ * @throws {RequiredError}
431
+ */
432
+ fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView> {
433
+ return localVarFp.fileInbox(autoFileInboxRequest, options).then((request) => request(axios, basePath));
434
+ },
373
435
  /**
374
436
  *
375
437
  * @summary Progress and outcome of a filing job
@@ -438,6 +500,17 @@ export class SmartFilingApi extends BaseAPI {
438
500
  return SmartFilingApiFp(this.configuration).file(autoFileRequest, options).then((request) => request(this.axios, this.basePath));
439
501
  }
440
502
 
503
+ /**
504
+ * Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
505
+ * @summary File everything lying loose in the caller\'s Inbox
506
+ * @param {AutoFileInboxRequest} [autoFileInboxRequest]
507
+ * @param {*} [options] Override http request option.
508
+ * @throws {RequiredError}
509
+ */
510
+ public fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig) {
511
+ return SmartFilingApiFp(this.configuration).fileInbox(autoFileInboxRequest, options).then((request) => request(this.axios, this.basePath));
512
+ }
513
+
441
514
  /**
442
515
  *
443
516
  * @summary Progress and outcome of a filing job
@@ -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
@@ -16,6 +16,7 @@ import type { DocumentInsightView } from '../models';
16
16
  import type { InsightBackfillRequest } from '../models';
17
17
  import type { InsightBackfillStatus } from '../models';
18
18
  import type { InsightCategoryUpdate } from '../models';
19
+ import type { InsightFacets } from '../models';
19
20
  /**
20
21
  * DocumentInsightsApi - axios parameter creator
21
22
  */
@@ -36,6 +37,13 @@ export declare const DocumentInsightsApiAxiosParamCreator: (configuration?: Conf
36
37
  * @throws {RequiredError}
37
38
  */
38
39
  backfillStatus: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
40
+ /**
41
+ * How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
42
+ * @summary The category and language facets of the library
43
+ * @param {*} [options] Override http request option.
44
+ * @throws {RequiredError}
45
+ */
46
+ facets: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
39
47
  /**
40
48
  * Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
41
49
  * @summary Get the insights of a document
@@ -45,7 +53,7 @@ export declare const DocumentInsightsApiAxiosParamCreator: (configuration?: Conf
45
53
  */
46
54
  getInsights: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47
55
  /**
48
- * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
56
+ * Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
49
57
  * @summary Correct the kind of a document
50
58
  * @param {string} documentId
51
59
  * @param {InsightCategoryUpdate} insightCategoryUpdate
@@ -74,6 +82,13 @@ export declare const DocumentInsightsApiFp: (configuration?: Configuration) => {
74
82
  * @throws {RequiredError}
75
83
  */
76
84
  backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightBackfillStatus>>;
85
+ /**
86
+ * How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
87
+ * @summary The category and language facets of the library
88
+ * @param {*} [options] Override http request option.
89
+ * @throws {RequiredError}
90
+ */
91
+ facets(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightFacets>>;
77
92
  /**
78
93
  * Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
79
94
  * @summary Get the insights of a document
@@ -83,7 +98,7 @@ export declare const DocumentInsightsApiFp: (configuration?: Configuration) => {
83
98
  */
84
99
  getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInsightView>>;
85
100
  /**
86
- * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
101
+ * Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
87
102
  * @summary Correct the kind of a document
88
103
  * @param {string} documentId
89
104
  * @param {InsightCategoryUpdate} insightCategoryUpdate
@@ -112,6 +127,13 @@ export declare const DocumentInsightsApiFactory: (configuration?: Configuration,
112
127
  * @throws {RequiredError}
113
128
  */
114
129
  backfillStatus(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<InsightBackfillStatus>;
130
+ /**
131
+ * How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
132
+ * @summary The category and language facets of the library
133
+ * @param {*} [options] Override http request option.
134
+ * @throws {RequiredError}
135
+ */
136
+ facets(options?: RawAxiosRequestConfig): AxiosPromise<InsightFacets>;
115
137
  /**
116
138
  * Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
117
139
  * @summary Get the insights of a document
@@ -121,7 +143,7 @@ export declare const DocumentInsightsApiFactory: (configuration?: Configuration,
121
143
  */
122
144
  getInsights(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInsightView>;
123
145
  /**
124
- * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
146
+ * Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
125
147
  * @summary Correct the kind of a document
126
148
  * @param {string} documentId
127
149
  * @param {InsightCategoryUpdate} insightCategoryUpdate
@@ -150,6 +172,13 @@ export declare class DocumentInsightsApi extends BaseAPI {
150
172
  * @throws {RequiredError}
151
173
  */
152
174
  backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InsightBackfillStatus, any, {}>>;
175
+ /**
176
+ * How many active files carry each tier-2 category and each detected language, from the document insights (largest first). The keys are what searchDocuments accepts in its \'category\' / \'language\' filters. 404 when the AI features are off (openfilz.ai.active); READER.
177
+ * @summary The category and language facets of the library
178
+ * @param {*} [options] Override http request option.
179
+ * @throws {RequiredError}
180
+ */
181
+ facets(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InsightFacets, any, {}>>;
153
182
  /**
154
183
  * Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
155
184
  * @summary Get the insights of a document
@@ -159,7 +188,7 @@ export declare class DocumentInsightsApi extends BaseAPI {
159
188
  */
160
189
  getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentInsightView, any, {}>>;
161
190
  /**
162
- * Sets the tier-2 category to one of the deployment\'s categories (openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
191
+ * Sets the tier-2 category to one of the deployment\'s kinds (the category taxonomy: openfilz.ai.insights.categories, or \'other\'), recorded as written by the user: it is never overwritten by a non-forced backfill, it teaches the learned classifier, and the by-kind reorganisation and smart filing use it like a model\'s label. 400 for a kind the deployment does not know; 403 without modify access.
163
192
  * @summary Correct the kind of a document
164
193
  * @param {string} documentId
165
194
  * @param {InsightCategoryUpdate} insightCategoryUpdate