@openfilz-sdk/typescript 1.3.19 → 1.3.20

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 (59) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +7 -2
  4. package/api/document-insights-api.ts +71 -4
  5. package/api/settings-api.ts +18 -11
  6. package/api/smart-filing-api.ts +73 -0
  7. package/dist/api/document-insights-api.d.ts +33 -4
  8. package/dist/api/document-insights-api.js +66 -4
  9. package/dist/api/settings-api.d.ts +12 -8
  10. package/dist/api/settings-api.js +18 -11
  11. package/dist/api/smart-filing-api.d.ts +33 -0
  12. package/dist/api/smart-filing-api.js +68 -0
  13. package/dist/esm/api/document-insights-api.d.ts +33 -4
  14. package/dist/esm/api/document-insights-api.js +66 -4
  15. package/dist/esm/api/settings-api.d.ts +12 -8
  16. package/dist/esm/api/settings-api.js +18 -11
  17. package/dist/esm/api/smart-filing-api.d.ts +33 -0
  18. package/dist/esm/api/smart-filing-api.js +68 -0
  19. package/dist/esm/models/ai-preferences-view.d.ts +3 -0
  20. package/dist/esm/models/auto-file-inbox-request.d.ts +14 -0
  21. package/dist/esm/models/auto-file-inbox-request.js +14 -0
  22. package/dist/esm/models/facet.d.ts +15 -0
  23. package/dist/esm/models/facet.js +14 -0
  24. package/dist/esm/models/index.d.ts +3 -0
  25. package/dist/esm/models/index.js +3 -0
  26. package/dist/esm/models/insight-facets.d.ts +16 -0
  27. package/dist/esm/models/insight-facets.js +14 -0
  28. package/dist/esm/models/save-ai-preferences-request.d.ts +1 -0
  29. package/dist/esm/models/settings.d.ts +1 -0
  30. package/dist/models/ai-preferences-view.d.ts +3 -0
  31. package/dist/models/auto-file-inbox-request.d.ts +14 -0
  32. package/dist/models/auto-file-inbox-request.js +15 -0
  33. package/dist/models/facet.d.ts +15 -0
  34. package/dist/models/facet.js +15 -0
  35. package/dist/models/index.d.ts +3 -0
  36. package/dist/models/index.js +3 -0
  37. package/dist/models/insight-facets.d.ts +16 -0
  38. package/dist/models/insight-facets.js +15 -0
  39. package/dist/models/save-ai-preferences-request.d.ts +1 -0
  40. package/dist/models/settings.d.ts +1 -0
  41. package/docs/AiPreferencesView.md +6 -0
  42. package/docs/AutoFileInboxRequest.md +20 -0
  43. package/docs/DocumentInsightsApi.md +46 -1
  44. package/docs/Facet.md +22 -0
  45. package/docs/InsightFacets.md +22 -0
  46. package/docs/SaveAiPreferencesRequest.md +2 -0
  47. package/docs/Settings.md +2 -0
  48. package/docs/SettingsApi.md +5 -2
  49. package/docs/SmartFilingApi.md +53 -0
  50. package/graphql/document-search.graphqls +4 -0
  51. package/graphql/document.graphqls +4 -0
  52. package/models/ai-preferences-view.ts +3 -0
  53. package/models/auto-file-inbox-request.ts +20 -0
  54. package/models/facet.ts +21 -0
  55. package/models/index.ts +3 -0
  56. package/models/insight-facets.ts +24 -0
  57. package/models/save-ai-preferences-request.ts +1 -0
  58. package/models/settings.ts +1 -0
  59. package/package.json +1 -1
@@ -96,6 +96,35 @@ export const DocumentInsightsApiAxiosParamCreator = function (configuration) {
96
96
  options: localVarRequestOptions,
97
97
  };
98
98
  }),
99
+ /**
100
+ * 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.
101
+ * @summary The category and language facets of the library
102
+ * @param {*} [options] Override http request option.
103
+ * @throws {RequiredError}
104
+ */
105
+ facets: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
106
+ const localVarPath = `/api/v1/ai/insights/facets`;
107
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
108
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
109
+ let baseOptions;
110
+ if (configuration) {
111
+ baseOptions = configuration.baseOptions;
112
+ }
113
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
114
+ const localVarHeaderParameter = {};
115
+ const localVarQueryParameter = {};
116
+ // authentication keycloak_auth required
117
+ // http bearer authentication required
118
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
119
+ localVarHeaderParameter['Accept'] = 'application/json';
120
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
121
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
122
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
123
+ return {
124
+ url: toPathString(localVarUrlObj),
125
+ options: localVarRequestOptions,
126
+ };
127
+ }),
99
128
  /**
100
129
  * 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.
101
130
  * @summary Get the insights of a document
@@ -130,7 +159,7 @@ export const DocumentInsightsApiAxiosParamCreator = function (configuration) {
130
159
  };
131
160
  }),
132
161
  /**
133
- * 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.
162
+ * 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.
134
163
  * @summary Correct the kind of a document
135
164
  * @param {string} documentId
136
165
  * @param {InsightCategoryUpdate} insightCategoryUpdate
@@ -207,6 +236,21 @@ export const DocumentInsightsApiFp = function (configuration) {
207
236
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
208
237
  });
209
238
  },
239
+ /**
240
+ * 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.
241
+ * @summary The category and language facets of the library
242
+ * @param {*} [options] Override http request option.
243
+ * @throws {RequiredError}
244
+ */
245
+ facets(options) {
246
+ return __awaiter(this, void 0, void 0, function* () {
247
+ var _a, _b, _c;
248
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.facets(options);
249
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
250
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentInsightsApi.facets']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
251
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
252
+ });
253
+ },
210
254
  /**
211
255
  * 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.
212
256
  * @summary Get the insights of a document
@@ -224,7 +268,7 @@ export const DocumentInsightsApiFp = function (configuration) {
224
268
  });
225
269
  },
226
270
  /**
227
- * 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.
271
+ * 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.
228
272
  * @summary Correct the kind of a document
229
273
  * @param {string} documentId
230
274
  * @param {InsightCategoryUpdate} insightCategoryUpdate
@@ -268,6 +312,15 @@ export const DocumentInsightsApiFactory = function (configuration, basePath, axi
268
312
  backfillStatus(jobId, options) {
269
313
  return localVarFp.backfillStatus(jobId, options).then((request) => request(axios, basePath));
270
314
  },
315
+ /**
316
+ * 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.
317
+ * @summary The category and language facets of the library
318
+ * @param {*} [options] Override http request option.
319
+ * @throws {RequiredError}
320
+ */
321
+ facets(options) {
322
+ return localVarFp.facets(options).then((request) => request(axios, basePath));
323
+ },
271
324
  /**
272
325
  * 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.
273
326
  * @summary Get the insights of a document
@@ -279,7 +332,7 @@ export const DocumentInsightsApiFactory = function (configuration, basePath, axi
279
332
  return localVarFp.getInsights(documentId, options).then((request) => request(axios, basePath));
280
333
  },
281
334
  /**
282
- * 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.
335
+ * 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.
283
336
  * @summary Correct the kind of a document
284
337
  * @param {string} documentId
285
338
  * @param {InsightCategoryUpdate} insightCategoryUpdate
@@ -315,6 +368,15 @@ export class DocumentInsightsApi extends BaseAPI {
315
368
  backfillStatus(jobId, options) {
316
369
  return DocumentInsightsApiFp(this.configuration).backfillStatus(jobId, options).then((request) => request(this.axios, this.basePath));
317
370
  }
371
+ /**
372
+ * 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.
373
+ * @summary The category and language facets of the library
374
+ * @param {*} [options] Override http request option.
375
+ * @throws {RequiredError}
376
+ */
377
+ facets(options) {
378
+ return DocumentInsightsApiFp(this.configuration).facets(options).then((request) => request(this.axios, this.basePath));
379
+ }
318
380
  /**
319
381
  * 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.
320
382
  * @summary Get the insights of a document
@@ -326,7 +388,7 @@ export class DocumentInsightsApi extends BaseAPI {
326
388
  return DocumentInsightsApiFp(this.configuration).getInsights(documentId, options).then((request) => request(this.axios, this.basePath));
327
389
  }
328
390
  /**
329
- * 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.
391
+ * 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.
330
392
  * @summary Correct the kind of a document
331
393
  * @param {string} documentId
332
394
  * @param {InsightCategoryUpdate} insightCategoryUpdate
@@ -34,13 +34,14 @@ export declare const SettingsApiAxiosParamCreator: (configuration?: Configuratio
34
34
  */
35
35
  getSettings1: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
36
36
  /**
37
- * A null field leaves the current value unchanged.
37
+ * 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
38
  * @summary Save the caller\'s smart-filing preferences
39
39
  * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
40
+ * @param {string} [acceptLanguage]
40
41
  * @param {*} [options] Override http request option.
41
42
  * @throws {RequiredError}
42
43
  */
43
- save: (saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44
+ save: (saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44
45
  };
45
46
  /**
46
47
  * SettingsApi - functional programming interface
@@ -61,13 +62,14 @@ export declare const SettingsApiFp: (configuration?: Configuration) => {
61
62
  */
62
63
  getSettings1(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Settings>>;
63
64
  /**
64
- * A null field leaves the current value unchanged.
65
+ * 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.
65
66
  * @summary Save the caller\'s smart-filing preferences
66
67
  * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
68
+ * @param {string} [acceptLanguage]
67
69
  * @param {*} [options] Override http request option.
68
70
  * @throws {RequiredError}
69
71
  */
70
- save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>>;
72
+ save(saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>>;
71
73
  };
72
74
  /**
73
75
  * SettingsApi - factory interface
@@ -88,13 +90,14 @@ export declare const SettingsApiFactory: (configuration?: Configuration, basePat
88
90
  */
89
91
  getSettings1(options?: RawAxiosRequestConfig): AxiosPromise<Settings>;
90
92
  /**
91
- * A null field leaves the current value unchanged.
93
+ * 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.
92
94
  * @summary Save the caller\'s smart-filing preferences
93
95
  * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
96
+ * @param {string} [acceptLanguage]
94
97
  * @param {*} [options] Override http request option.
95
98
  * @throws {RequiredError}
96
99
  */
97
- save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView>;
100
+ save(saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView>;
98
101
  };
99
102
  /**
100
103
  * SettingsApi - object-oriented interface
@@ -115,11 +118,12 @@ export declare class SettingsApi extends BaseAPI {
115
118
  */
116
119
  getSettings1(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Settings, any, {}>>;
117
120
  /**
118
- * A null field leaves the current value unchanged.
121
+ * 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.
119
122
  * @summary Save the caller\'s smart-filing preferences
120
123
  * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
124
+ * @param {string} [acceptLanguage]
121
125
  * @param {*} [options] Override http request option.
122
126
  * @throws {RequiredError}
123
127
  */
124
- save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPreferencesView, any, {}>>;
128
+ save(saveAiPreferencesRequest: SaveAiPreferencesRequest, acceptLanguage?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiPreferencesView, any, {}>>;
125
129
  }
@@ -90,13 +90,14 @@ export const SettingsApiAxiosParamCreator = function (configuration) {
90
90
  };
91
91
  }),
92
92
  /**
93
- * A null field leaves the current value unchanged.
93
+ * 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
94
  * @summary Save the caller\'s smart-filing preferences
95
95
  * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
96
+ * @param {string} [acceptLanguage]
96
97
  * @param {*} [options] Override http request option.
97
98
  * @throws {RequiredError}
98
99
  */
99
- save: (saveAiPreferencesRequest_1, ...args_1) => __awaiter(this, [saveAiPreferencesRequest_1, ...args_1], void 0, function* (saveAiPreferencesRequest, options = {}) {
100
+ save: (saveAiPreferencesRequest_1, acceptLanguage_1, ...args_1) => __awaiter(this, [saveAiPreferencesRequest_1, acceptLanguage_1, ...args_1], void 0, function* (saveAiPreferencesRequest, acceptLanguage, options = {}) {
100
101
  // verify required parameter 'saveAiPreferencesRequest' is not null or undefined
101
102
  assertParamExists('save', 'saveAiPreferencesRequest', saveAiPreferencesRequest);
102
103
  const localVarPath = `/api/v1/settings/ai/preferences`;
@@ -114,6 +115,9 @@ export const SettingsApiAxiosParamCreator = function (configuration) {
114
115
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
115
116
  localVarHeaderParameter['Content-Type'] = 'application/json';
116
117
  localVarHeaderParameter['Accept'] = 'application/json';
118
+ if (acceptLanguage != null) {
119
+ localVarHeaderParameter['Accept-Language'] = String(acceptLanguage);
120
+ }
117
121
  setSearchParams(localVarUrlObj, localVarQueryParameter);
118
122
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
119
123
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -162,16 +166,17 @@ export const SettingsApiFp = function (configuration) {
162
166
  });
163
167
  },
164
168
  /**
165
- * A null field leaves the current value unchanged.
169
+ * 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.
166
170
  * @summary Save the caller\'s smart-filing preferences
167
171
  * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
172
+ * @param {string} [acceptLanguage]
168
173
  * @param {*} [options] Override http request option.
169
174
  * @throws {RequiredError}
170
175
  */
171
- save(saveAiPreferencesRequest, options) {
176
+ save(saveAiPreferencesRequest, acceptLanguage, options) {
172
177
  return __awaiter(this, void 0, void 0, function* () {
173
178
  var _a, _b, _c;
174
- const localVarAxiosArgs = yield localVarAxiosParamCreator.save(saveAiPreferencesRequest, options);
179
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.save(saveAiPreferencesRequest, acceptLanguage, options);
175
180
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
176
181
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SettingsApi.save']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
177
182
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -204,14 +209,15 @@ export const SettingsApiFactory = function (configuration, basePath, axios) {
204
209
  return localVarFp.getSettings1(options).then((request) => request(axios, basePath));
205
210
  },
206
211
  /**
207
- * A null field leaves the current value unchanged.
212
+ * 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.
208
213
  * @summary Save the caller\'s smart-filing preferences
209
214
  * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
215
+ * @param {string} [acceptLanguage]
210
216
  * @param {*} [options] Override http request option.
211
217
  * @throws {RequiredError}
212
218
  */
213
- save(saveAiPreferencesRequest, options) {
214
- return localVarFp.save(saveAiPreferencesRequest, options).then((request) => request(axios, basePath));
219
+ save(saveAiPreferencesRequest, acceptLanguage, options) {
220
+ return localVarFp.save(saveAiPreferencesRequest, acceptLanguage, options).then((request) => request(axios, basePath));
215
221
  },
216
222
  };
217
223
  };
@@ -238,13 +244,14 @@ export class SettingsApi extends BaseAPI {
238
244
  return SettingsApiFp(this.configuration).getSettings1(options).then((request) => request(this.axios, this.basePath));
239
245
  }
240
246
  /**
241
- * A null field leaves the current value unchanged.
247
+ * 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.
242
248
  * @summary Save the caller\'s smart-filing preferences
243
249
  * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
250
+ * @param {string} [acceptLanguage]
244
251
  * @param {*} [options] Override http request option.
245
252
  * @throws {RequiredError}
246
253
  */
247
- save(saveAiPreferencesRequest, options) {
248
- return SettingsApiFp(this.configuration).save(saveAiPreferencesRequest, options).then((request) => request(this.axios, this.basePath));
254
+ save(saveAiPreferencesRequest, acceptLanguage, options) {
255
+ return SettingsApiFp(this.configuration).save(saveAiPreferencesRequest, acceptLanguage, options).then((request) => request(this.axios, this.basePath));
249
256
  }
250
257
  }
@@ -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 { AutoFileInboxRequest } from '../models';
15
16
  import type { AutoFileJobView } from '../models';
16
17
  import type { AutoFileJobsRequest } from '../models';
17
18
  import type { AutoFileRequest } from '../models';
@@ -28,6 +29,14 @@ export declare const SmartFilingApiAxiosParamCreator: (configuration?: Configura
28
29
  * @throws {RequiredError}
29
30
  */
30
31
  file: (autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
32
+ /**
33
+ * 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.
34
+ * @summary File everything lying loose in the caller\'s Inbox
35
+ * @param {AutoFileInboxRequest} [autoFileInboxRequest]
36
+ * @param {*} [options] Override http request option.
37
+ * @throws {RequiredError}
38
+ */
39
+ fileInbox: (autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
31
40
  /**
32
41
  *
33
42
  * @summary Progress and outcome of a filing job
@@ -81,6 +90,14 @@ export declare const SmartFilingApiFp: (configuration?: Configuration) => {
81
90
  * @throws {RequiredError}
82
91
  */
83
92
  file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>>;
93
+ /**
94
+ * 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.
95
+ * @summary File everything lying loose in the caller\'s Inbox
96
+ * @param {AutoFileInboxRequest} [autoFileInboxRequest]
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ */
100
+ fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>>;
84
101
  /**
85
102
  *
86
103
  * @summary Progress and outcome of a filing job
@@ -134,6 +151,14 @@ export declare const SmartFilingApiFactory: (configuration?: Configuration, base
134
151
  * @throws {RequiredError}
135
152
  */
136
153
  file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView>;
154
+ /**
155
+ * 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.
156
+ * @summary File everything lying loose in the caller\'s Inbox
157
+ * @param {AutoFileInboxRequest} [autoFileInboxRequest]
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ */
161
+ fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView>;
137
162
  /**
138
163
  *
139
164
  * @summary Progress and outcome of a filing job
@@ -187,6 +212,14 @@ export declare class SmartFilingApi extends BaseAPI {
187
212
  * @throws {RequiredError}
188
213
  */
189
214
  file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AutoFileJobView, any, {}>>;
215
+ /**
216
+ * 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.
217
+ * @summary File everything lying loose in the caller\'s Inbox
218
+ * @param {AutoFileInboxRequest} [autoFileInboxRequest]
219
+ * @param {*} [options] Override http request option.
220
+ * @throws {RequiredError}
221
+ */
222
+ fileInbox(autoFileInboxRequest?: AutoFileInboxRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AutoFileJobView, any, {}>>;
190
223
  /**
191
224
  *
192
225
  * @summary Progress and outcome of a filing job
@@ -65,6 +65,38 @@ export const SmartFilingApiAxiosParamCreator = function (configuration) {
65
65
  options: localVarRequestOptions,
66
66
  };
67
67
  }),
68
+ /**
69
+ * 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.
70
+ * @summary File everything lying loose in the caller\'s Inbox
71
+ * @param {AutoFileInboxRequest} [autoFileInboxRequest]
72
+ * @param {*} [options] Override http request option.
73
+ * @throws {RequiredError}
74
+ */
75
+ fileInbox: (autoFileInboxRequest_1, ...args_1) => __awaiter(this, [autoFileInboxRequest_1, ...args_1], void 0, function* (autoFileInboxRequest, options = {}) {
76
+ const localVarPath = `/api/v1/ai/auto-file/inbox`;
77
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
78
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
79
+ let baseOptions;
80
+ if (configuration) {
81
+ baseOptions = configuration.baseOptions;
82
+ }
83
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
84
+ const localVarHeaderParameter = {};
85
+ const localVarQueryParameter = {};
86
+ // authentication keycloak_auth required
87
+ // http bearer authentication required
88
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
89
+ localVarHeaderParameter['Content-Type'] = 'application/json';
90
+ localVarHeaderParameter['Accept'] = 'application/json';
91
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
92
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
93
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
94
+ localVarRequestOptions.data = serializeDataIfNeeded(autoFileInboxRequest, localVarRequestOptions, configuration);
95
+ return {
96
+ url: toPathString(localVarUrlObj),
97
+ options: localVarRequestOptions,
98
+ };
99
+ }),
68
100
  /**
69
101
  *
70
102
  * @summary Progress and outcome of a filing job
@@ -255,6 +287,22 @@ export const SmartFilingApiFp = function (configuration) {
255
287
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
256
288
  });
257
289
  },
290
+ /**
291
+ * 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.
292
+ * @summary File everything lying loose in the caller\'s Inbox
293
+ * @param {AutoFileInboxRequest} [autoFileInboxRequest]
294
+ * @param {*} [options] Override http request option.
295
+ * @throws {RequiredError}
296
+ */
297
+ fileInbox(autoFileInboxRequest, options) {
298
+ return __awaiter(this, void 0, void 0, function* () {
299
+ var _a, _b, _c;
300
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.fileInbox(autoFileInboxRequest, options);
301
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
302
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SmartFilingApi.fileInbox']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
303
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
304
+ });
305
+ },
258
306
  /**
259
307
  *
260
308
  * @summary Progress and outcome of a filing job
@@ -353,6 +401,16 @@ export const SmartFilingApiFactory = function (configuration, basePath, axios) {
353
401
  file(autoFileRequest, options) {
354
402
  return localVarFp.file(autoFileRequest, options).then((request) => request(axios, basePath));
355
403
  },
404
+ /**
405
+ * 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.
406
+ * @summary File everything lying loose in the caller\'s Inbox
407
+ * @param {AutoFileInboxRequest} [autoFileInboxRequest]
408
+ * @param {*} [options] Override http request option.
409
+ * @throws {RequiredError}
410
+ */
411
+ fileInbox(autoFileInboxRequest, options) {
412
+ return localVarFp.fileInbox(autoFileInboxRequest, options).then((request) => request(axios, basePath));
413
+ },
356
414
  /**
357
415
  *
358
416
  * @summary Progress and outcome of a filing job
@@ -419,6 +477,16 @@ export class SmartFilingApi extends BaseAPI {
419
477
  file(autoFileRequest, options) {
420
478
  return SmartFilingApiFp(this.configuration).file(autoFileRequest, options).then((request) => request(this.axios, this.basePath));
421
479
  }
480
+ /**
481
+ * 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.
482
+ * @summary File everything lying loose in the caller\'s Inbox
483
+ * @param {AutoFileInboxRequest} [autoFileInboxRequest]
484
+ * @param {*} [options] Override http request option.
485
+ * @throws {RequiredError}
486
+ */
487
+ fileInbox(autoFileInboxRequest, options) {
488
+ return SmartFilingApiFp(this.configuration).fileInbox(autoFileInboxRequest, options).then((request) => request(this.axios, this.basePath));
489
+ }
422
490
  /**
423
491
  *
424
492
  * @summary Progress and outcome of a filing job
@@ -13,4 +13,7 @@ export interface AiPreferencesView {
13
13
  'autoFileAvailable'?: boolean;
14
14
  'autoFile'?: boolean;
15
15
  'autoFileNewFolders'?: boolean;
16
+ 'inboxAvailable'?: boolean;
17
+ 'inbox'?: boolean;
18
+ 'inboxFolderId'?: string;
16
19
  }
@@ -0,0 +1,14 @@
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
+ export interface AutoFileInboxRequest {
13
+ 'allowNewFolders'?: boolean;
14
+ }
@@ -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,15 @@
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
+ export interface Facet {
13
+ 'key'?: string;
14
+ 'count'?: number;
15
+ }
@@ -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 {};
@@ -11,6 +11,7 @@ export * from './audit-log';
11
11
  export * from './audit-log-details';
12
12
  export * from './audit-log-details-one-of';
13
13
  export * from './audit-verification-result';
14
+ export * from './auto-file-inbox-request';
14
15
  export * from './auto-file-job-view';
15
16
  export * from './auto-file-jobs-request';
16
17
  export * from './auto-file-request';
@@ -39,6 +40,7 @@ export * from './document-version-info';
39
40
  export * from './element-info';
40
41
  export * from './embedding-backfill-request';
41
42
  export * from './embedding-backfill-status';
43
+ export * from './facet';
42
44
  export * from './file-type-stats';
43
45
  export * from './filing-outcome';
44
46
  export * from './filter-input';
@@ -47,6 +49,7 @@ export * from './folder-response';
47
49
  export * from './insight-backfill-request';
48
50
  export * from './insight-backfill-status';
49
51
  export * from './insight-category-update';
52
+ export * from './insight-facets';
50
53
  export * from './instantiate-template-request';
51
54
  export * from './item';
52
55
  export * from './item-result';
@@ -11,6 +11,7 @@ export * from './audit-log';
11
11
  export * from './audit-log-details';
12
12
  export * from './audit-log-details-one-of';
13
13
  export * from './audit-verification-result';
14
+ export * from './auto-file-inbox-request';
14
15
  export * from './auto-file-job-view';
15
16
  export * from './auto-file-jobs-request';
16
17
  export * from './auto-file-request';
@@ -39,6 +40,7 @@ export * from './document-version-info';
39
40
  export * from './element-info';
40
41
  export * from './embedding-backfill-request';
41
42
  export * from './embedding-backfill-status';
43
+ export * from './facet';
42
44
  export * from './file-type-stats';
43
45
  export * from './filing-outcome';
44
46
  export * from './filter-input';
@@ -47,6 +49,7 @@ export * from './folder-response';
47
49
  export * from './insight-backfill-request';
48
50
  export * from './insight-backfill-status';
49
51
  export * from './insight-category-update';
52
+ export * from './insight-facets';
50
53
  export * from './instantiate-template-request';
51
54
  export * from './item';
52
55
  export * from './item-result';
@@ -0,0 +1,16 @@
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 { Facet } from './facet';
13
+ export interface InsightFacets {
14
+ 'categories'?: Array<Facet>;
15
+ 'languages'?: Array<Facet>;
16
+ }
@@ -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 {};
@@ -12,4 +12,5 @@
12
12
  export interface SaveAiPreferencesRequest {
13
13
  'autoFile'?: boolean;
14
14
  'autoFileNewFolders'?: boolean;
15
+ 'inbox'?: boolean;
15
16
  }
@@ -18,6 +18,7 @@ export interface Settings {
18
18
  'thumbnailsActive'?: boolean;
19
19
  'aiActive'?: boolean;
20
20
  'aiChatActive'?: boolean;
21
+ 'aiChatUnavailableReason'?: string;
21
22
  'aiUserSettingsEnabled'?: boolean;
22
23
  'aiInsightsActive'?: boolean;
23
24
  'aiInsightsCategories'?: Array<string>;
@@ -13,4 +13,7 @@ export interface AiPreferencesView {
13
13
  'autoFileAvailable'?: boolean;
14
14
  'autoFile'?: boolean;
15
15
  'autoFileNewFolders'?: boolean;
16
+ 'inboxAvailable'?: boolean;
17
+ 'inbox'?: boolean;
18
+ 'inboxFolderId'?: string;
16
19
  }
@@ -0,0 +1,14 @@
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
+ export interface AutoFileInboxRequest {
13
+ 'allowNewFolders'?: boolean;
14
+ }