@openfilz-sdk/typescript-ee 1.9.5 → 1.9.7

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 (146) hide show
  1. package/.openapi-generator/FILES +32 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +30 -3
  4. package/api/aichat-api.ts +228 -0
  5. package/api/document-controller-api.ts +30 -14
  6. package/api/document-insights-api.ts +275 -0
  7. package/api/esign-api.ts +9 -9
  8. package/api/settings-api.ts +142 -0
  9. package/api/smart-filing-api.ts +421 -0
  10. package/api.ts +2 -0
  11. package/dist/api/aichat-api.d.ts +103 -0
  12. package/dist/api/aichat-api.js +213 -0
  13. package/dist/api/document-controller-api.d.ts +16 -8
  14. package/dist/api/document-controller-api.js +28 -14
  15. package/dist/api/document-insights-api.d.ts +133 -0
  16. package/dist/api/document-insights-api.js +269 -0
  17. package/dist/api/esign-api.d.ts +4 -4
  18. package/dist/api/esign-api.js +9 -9
  19. package/dist/api/settings-api.d.ts +62 -0
  20. package/dist/api/settings-api.js +132 -0
  21. package/dist/api/smart-filing-api.d.ts +197 -0
  22. package/dist/api/smart-filing-api.js +409 -0
  23. package/dist/api.d.ts +2 -0
  24. package/dist/api.js +2 -0
  25. package/dist/esm/api/aichat-api.d.ts +103 -0
  26. package/dist/esm/api/aichat-api.js +213 -0
  27. package/dist/esm/api/document-controller-api.d.ts +16 -8
  28. package/dist/esm/api/document-controller-api.js +28 -14
  29. package/dist/esm/api/document-insights-api.d.ts +133 -0
  30. package/dist/esm/api/document-insights-api.js +262 -0
  31. package/dist/esm/api/esign-api.d.ts +4 -4
  32. package/dist/esm/api/esign-api.js +9 -9
  33. package/dist/esm/api/settings-api.d.ts +62 -0
  34. package/dist/esm/api/settings-api.js +132 -0
  35. package/dist/esm/api/smart-filing-api.d.ts +197 -0
  36. package/dist/esm/api/smart-filing-api.js +402 -0
  37. package/dist/esm/api.d.ts +2 -0
  38. package/dist/esm/api.js +2 -0
  39. package/dist/esm/models/ai-preferences-view.d.ts +16 -0
  40. package/dist/esm/models/ai-preferences-view.js +14 -0
  41. package/dist/esm/models/auto-file-job-view.d.ts +25 -0
  42. package/dist/esm/models/auto-file-job-view.js +14 -0
  43. package/dist/esm/models/auto-file-request.d.ts +15 -0
  44. package/dist/esm/models/auto-file-request.js +14 -0
  45. package/dist/esm/models/auto-file-ticket.d.ts +15 -0
  46. package/dist/esm/models/auto-file-ticket.js +14 -0
  47. package/dist/esm/models/document-insight-view.d.ts +33 -0
  48. package/dist/esm/models/document-insight-view.js +14 -0
  49. package/dist/esm/models/filing-outcome.d.ts +25 -0
  50. package/dist/esm/models/filing-outcome.js +14 -0
  51. package/dist/esm/models/index.d.ts +14 -0
  52. package/dist/esm/models/index.js +14 -0
  53. package/dist/esm/models/insight-backfill-request.d.ts +15 -0
  54. package/dist/esm/models/insight-backfill-request.js +14 -0
  55. package/dist/esm/models/insight-backfill-status.d.ts +23 -0
  56. package/dist/esm/models/insight-backfill-status.js +14 -0
  57. package/dist/esm/models/item-result.d.ts +16 -0
  58. package/dist/esm/models/item-result.js +14 -0
  59. package/dist/esm/models/item.d.ts +21 -0
  60. package/dist/esm/models/item.js +14 -0
  61. package/dist/esm/models/reorganization-apply-request.d.ts +14 -0
  62. package/dist/esm/models/reorganization-apply-request.js +14 -0
  63. package/dist/esm/models/reorganization-apply-result.d.ts +22 -0
  64. package/dist/esm/models/reorganization-apply-result.js +14 -0
  65. package/dist/esm/models/reorganization-plan-view.d.ts +28 -0
  66. package/dist/esm/models/reorganization-plan-view.js +14 -0
  67. package/dist/esm/models/save-ai-preferences-request.d.ts +15 -0
  68. package/dist/esm/models/save-ai-preferences-request.js +14 -0
  69. package/dist/esm/models/settings.d.ts +2 -0
  70. package/dist/esm/models/tus-finalize-request.d.ts +1 -0
  71. package/dist/esm/models/upload-response.d.ts +2 -0
  72. package/dist/models/ai-preferences-view.d.ts +16 -0
  73. package/dist/models/ai-preferences-view.js +15 -0
  74. package/dist/models/auto-file-job-view.d.ts +25 -0
  75. package/dist/models/auto-file-job-view.js +15 -0
  76. package/dist/models/auto-file-request.d.ts +15 -0
  77. package/dist/models/auto-file-request.js +15 -0
  78. package/dist/models/auto-file-ticket.d.ts +15 -0
  79. package/dist/models/auto-file-ticket.js +15 -0
  80. package/dist/models/document-insight-view.d.ts +33 -0
  81. package/dist/models/document-insight-view.js +15 -0
  82. package/dist/models/filing-outcome.d.ts +25 -0
  83. package/dist/models/filing-outcome.js +15 -0
  84. package/dist/models/index.d.ts +14 -0
  85. package/dist/models/index.js +14 -0
  86. package/dist/models/insight-backfill-request.d.ts +15 -0
  87. package/dist/models/insight-backfill-request.js +15 -0
  88. package/dist/models/insight-backfill-status.d.ts +23 -0
  89. package/dist/models/insight-backfill-status.js +15 -0
  90. package/dist/models/item-result.d.ts +16 -0
  91. package/dist/models/item-result.js +15 -0
  92. package/dist/models/item.d.ts +21 -0
  93. package/dist/models/item.js +15 -0
  94. package/dist/models/reorganization-apply-request.d.ts +14 -0
  95. package/dist/models/reorganization-apply-request.js +15 -0
  96. package/dist/models/reorganization-apply-result.d.ts +22 -0
  97. package/dist/models/reorganization-apply-result.js +15 -0
  98. package/dist/models/reorganization-plan-view.d.ts +28 -0
  99. package/dist/models/reorganization-plan-view.js +15 -0
  100. package/dist/models/save-ai-preferences-request.d.ts +15 -0
  101. package/dist/models/save-ai-preferences-request.js +15 -0
  102. package/dist/models/settings.d.ts +2 -0
  103. package/dist/models/tus-finalize-request.d.ts +1 -0
  104. package/dist/models/upload-response.d.ts +2 -0
  105. package/docs/AIChatApi.md +159 -0
  106. package/docs/AiPreferencesView.md +24 -0
  107. package/docs/AutoFileJobView.md +40 -0
  108. package/docs/AutoFileRequest.md +22 -0
  109. package/docs/AutoFileTicket.md +22 -0
  110. package/docs/DocumentControllerApi.md +6 -0
  111. package/docs/DocumentInsightView.md +54 -0
  112. package/docs/DocumentInsightsApi.md +163 -0
  113. package/docs/ESignApi.md +4 -4
  114. package/docs/FilingOutcome.md +42 -0
  115. package/docs/InsightBackfillRequest.md +22 -0
  116. package/docs/InsightBackfillStatus.md +38 -0
  117. package/docs/Item.md +34 -0
  118. package/docs/ItemResult.md +24 -0
  119. package/docs/ReorganizationApplyRequest.md +20 -0
  120. package/docs/ReorganizationApplyResult.md +34 -0
  121. package/docs/ReorganizationPlanView.md +44 -0
  122. package/docs/SaveAiPreferencesRequest.md +22 -0
  123. package/docs/Settings.md +4 -0
  124. package/docs/SettingsApi.md +97 -0
  125. package/docs/SmartFilingApi.md +264 -0
  126. package/docs/TusFinalizeRequest.md +2 -0
  127. package/docs/UploadResponse.md +2 -0
  128. package/models/ai-preferences-view.ts +22 -0
  129. package/models/auto-file-job-view.ts +33 -0
  130. package/models/auto-file-request.ts +21 -0
  131. package/models/auto-file-ticket.ts +21 -0
  132. package/models/document-insight-view.ts +37 -0
  133. package/models/filing-outcome.ts +31 -0
  134. package/models/index.ts +14 -0
  135. package/models/insight-backfill-request.ts +21 -0
  136. package/models/insight-backfill-status.ts +29 -0
  137. package/models/item-result.ts +22 -0
  138. package/models/item.ts +27 -0
  139. package/models/reorganization-apply-request.ts +20 -0
  140. package/models/reorganization-apply-result.ts +30 -0
  141. package/models/reorganization-plan-view.ts +38 -0
  142. package/models/save-ai-preferences-request.ts +21 -0
  143. package/models/settings.ts +2 -0
  144. package/models/tus-finalize-request.ts +1 -0
  145. package/models/upload-response.ts +4 -0
  146. package/package.json +1 -1
@@ -22,8 +22,12 @@ 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 { AiPreferencesView } from '../models';
26
+ // @ts-ignore
25
27
  import type { LicenseInfo } from '../models';
26
28
  // @ts-ignore
29
+ import type { SaveAiPreferencesRequest } from '../models';
30
+ // @ts-ignore
27
31
  import type { Settings } from '../models';
28
32
  // @ts-ignore
29
33
  import type { UserPreferencesRequest } from '../models';
@@ -32,6 +36,40 @@ import type { UserPreferencesRequest } from '../models';
32
36
  */
33
37
  export const SettingsApiAxiosParamCreator = function (configuration?: Configuration) {
34
38
  return {
39
+ /**
40
+ *
41
+ * @summary The caller\'s smart-filing preferences
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ get2: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
46
+ const localVarPath = `/api/v1/settings/ai/preferences`;
47
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
48
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
49
+ let baseOptions;
50
+ if (configuration) {
51
+ baseOptions = configuration.baseOptions;
52
+ }
53
+
54
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
55
+ const localVarHeaderParameter = {} as any;
56
+ const localVarQueryParameter = {} as any;
57
+
58
+ // authentication keycloak_auth required
59
+ // http bearer authentication required
60
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
61
+
62
+ localVarHeaderParameter['Accept'] = 'application/json';
63
+
64
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
65
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
66
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
67
+
68
+ return {
69
+ url: toPathString(localVarUrlObj),
70
+ options: localVarRequestOptions,
71
+ };
72
+ },
35
73
  /**
36
74
  * License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
37
75
  * @summary Coarse license info
@@ -100,6 +138,45 @@ export const SettingsApiAxiosParamCreator = function (configuration?: Configurat
100
138
  options: localVarRequestOptions,
101
139
  };
102
140
  },
141
+ /**
142
+ * A null field leaves the current value unchanged.
143
+ * @summary Save the caller\'s smart-filing preferences
144
+ * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ save: async (saveAiPreferencesRequest: SaveAiPreferencesRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
149
+ // verify required parameter 'saveAiPreferencesRequest' is not null or undefined
150
+ assertParamExists('save', 'saveAiPreferencesRequest', saveAiPreferencesRequest)
151
+ const localVarPath = `/api/v1/settings/ai/preferences`;
152
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
153
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
154
+ let baseOptions;
155
+ if (configuration) {
156
+ baseOptions = configuration.baseOptions;
157
+ }
158
+
159
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
160
+ const localVarHeaderParameter = {} as any;
161
+ const localVarQueryParameter = {} as any;
162
+
163
+ // authentication keycloak_auth required
164
+ // http bearer authentication required
165
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
166
+
167
+ localVarHeaderParameter['Content-Type'] = 'application/json';
168
+ localVarHeaderParameter['Accept'] = 'application/json';
169
+
170
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
171
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
172
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
173
+ localVarRequestOptions.data = serializeDataIfNeeded(saveAiPreferencesRequest, localVarRequestOptions, configuration)
174
+
175
+ return {
176
+ url: toPathString(localVarUrlObj),
177
+ options: localVarRequestOptions,
178
+ };
179
+ },
103
180
  /**
104
181
  * Save user\'s language and theme preferences
105
182
  * @summary Save user preferences
@@ -148,6 +225,18 @@ export const SettingsApiAxiosParamCreator = function (configuration?: Configurat
148
225
  export const SettingsApiFp = function(configuration?: Configuration) {
149
226
  const localVarAxiosParamCreator = SettingsApiAxiosParamCreator(configuration)
150
227
  return {
228
+ /**
229
+ *
230
+ * @summary The caller\'s smart-filing preferences
231
+ * @param {*} [options] Override http request option.
232
+ * @throws {RequiredError}
233
+ */
234
+ async get2(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>> {
235
+ const localVarAxiosArgs = await localVarAxiosParamCreator.get2(options);
236
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
237
+ const localVarOperationServerBasePath = operationServerMap['SettingsApi.get2']?.[localVarOperationServerIndex]?.url;
238
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
239
+ },
151
240
  /**
152
241
  * License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
153
242
  * @summary Coarse license info
@@ -172,6 +261,19 @@ export const SettingsApiFp = function(configuration?: Configuration) {
172
261
  const localVarOperationServerBasePath = operationServerMap['SettingsApi.getSettings']?.[localVarOperationServerIndex]?.url;
173
262
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
174
263
  },
264
+ /**
265
+ * A null field leaves the current value unchanged.
266
+ * @summary Save the caller\'s smart-filing preferences
267
+ * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
268
+ * @param {*} [options] Override http request option.
269
+ * @throws {RequiredError}
270
+ */
271
+ async save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>> {
272
+ const localVarAxiosArgs = await localVarAxiosParamCreator.save(saveAiPreferencesRequest, options);
273
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
274
+ const localVarOperationServerBasePath = operationServerMap['SettingsApi.save']?.[localVarOperationServerIndex]?.url;
275
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
276
+ },
175
277
  /**
176
278
  * Save user\'s language and theme preferences
177
279
  * @summary Save user preferences
@@ -194,6 +296,15 @@ export const SettingsApiFp = function(configuration?: Configuration) {
194
296
  export const SettingsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
195
297
  const localVarFp = SettingsApiFp(configuration)
196
298
  return {
299
+ /**
300
+ *
301
+ * @summary The caller\'s smart-filing preferences
302
+ * @param {*} [options] Override http request option.
303
+ * @throws {RequiredError}
304
+ */
305
+ get2(options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView> {
306
+ return localVarFp.get2(options).then((request) => request(axios, basePath));
307
+ },
197
308
  /**
198
309
  * License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
199
310
  * @summary Coarse license info
@@ -212,6 +323,16 @@ export const SettingsApiFactory = function (configuration?: Configuration, baseP
212
323
  getSettings(options?: RawAxiosRequestConfig): AxiosPromise<Settings> {
213
324
  return localVarFp.getSettings(options).then((request) => request(axios, basePath));
214
325
  },
326
+ /**
327
+ * A null field leaves the current value unchanged.
328
+ * @summary Save the caller\'s smart-filing preferences
329
+ * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
330
+ * @param {*} [options] Override http request option.
331
+ * @throws {RequiredError}
332
+ */
333
+ save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView> {
334
+ return localVarFp.save(saveAiPreferencesRequest, options).then((request) => request(axios, basePath));
335
+ },
215
336
  /**
216
337
  * Save user\'s language and theme preferences
217
338
  * @summary Save user preferences
@@ -229,6 +350,16 @@ export const SettingsApiFactory = function (configuration?: Configuration, baseP
229
350
  * SettingsApi - object-oriented interface
230
351
  */
231
352
  export class SettingsApi extends BaseAPI {
353
+ /**
354
+ *
355
+ * @summary The caller\'s smart-filing preferences
356
+ * @param {*} [options] Override http request option.
357
+ * @throws {RequiredError}
358
+ */
359
+ public get2(options?: RawAxiosRequestConfig) {
360
+ return SettingsApiFp(this.configuration).get2(options).then((request) => request(this.axios, this.basePath));
361
+ }
362
+
232
363
  /**
233
364
  * License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
234
365
  * @summary Coarse license info
@@ -249,6 +380,17 @@ export class SettingsApi extends BaseAPI {
249
380
  return SettingsApiFp(this.configuration).getSettings(options).then((request) => request(this.axios, this.basePath));
250
381
  }
251
382
 
383
+ /**
384
+ * A null field leaves the current value unchanged.
385
+ * @summary Save the caller\'s smart-filing preferences
386
+ * @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
387
+ * @param {*} [options] Override http request option.
388
+ * @throws {RequiredError}
389
+ */
390
+ public save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig) {
391
+ return SettingsApiFp(this.configuration).save(saveAiPreferencesRequest, options).then((request) => request(this.axios, this.basePath));
392
+ }
393
+
252
394
  /**
253
395
  * Save user\'s language and theme preferences
254
396
  * @summary Save user preferences
@@ -0,0 +1,421 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import type { Configuration } from '../configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
22
+ // @ts-ignore
23
+ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
+ // @ts-ignore
25
+ import type { AutoFileJobView } from '../models';
26
+ // @ts-ignore
27
+ import type { AutoFileRequest } from '../models';
28
+ // @ts-ignore
29
+ import type { FilingOutcome } from '../models';
30
+ /**
31
+ * SmartFilingApi - axios parameter creator
32
+ */
33
+ export const SmartFilingApiAxiosParamCreator = function (configuration?: Configuration) {
34
+ return {
35
+ /**
36
+ * Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once.
37
+ * @summary File existing documents on demand
38
+ * @param {AutoFileRequest} autoFileRequest
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ file: async (autoFileRequest: AutoFileRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
43
+ // verify required parameter 'autoFileRequest' is not null or undefined
44
+ assertParamExists('file', 'autoFileRequest', autoFileRequest)
45
+ const localVarPath = `/api/v1/ai/auto-file`;
46
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
47
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
48
+ let baseOptions;
49
+ if (configuration) {
50
+ baseOptions = configuration.baseOptions;
51
+ }
52
+
53
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
54
+ const localVarHeaderParameter = {} as any;
55
+ const localVarQueryParameter = {} as any;
56
+
57
+ // authentication keycloak_auth required
58
+ // http bearer authentication required
59
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
60
+
61
+ localVarHeaderParameter['Content-Type'] = 'application/json';
62
+ localVarHeaderParameter['Accept'] = 'application/json';
63
+
64
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
65
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
66
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
67
+ localVarRequestOptions.data = serializeDataIfNeeded(autoFileRequest, localVarRequestOptions, configuration)
68
+
69
+ return {
70
+ url: toPathString(localVarUrlObj),
71
+ options: localVarRequestOptions,
72
+ };
73
+ },
74
+ /**
75
+ *
76
+ * @summary Progress and outcome of a filing job
77
+ * @param {string} jobId
78
+ * @param {*} [options] Override http request option.
79
+ * @throws {RequiredError}
80
+ */
81
+ job: async (jobId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
82
+ // verify required parameter 'jobId' is not null or undefined
83
+ assertParamExists('job', 'jobId', jobId)
84
+ const localVarPath = `/api/v1/ai/auto-file/{jobId}`
85
+ .replace('{jobId}', encodeURIComponent(String(jobId)));
86
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
87
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
88
+ let baseOptions;
89
+ if (configuration) {
90
+ baseOptions = configuration.baseOptions;
91
+ }
92
+
93
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
94
+ const localVarHeaderParameter = {} as any;
95
+ const localVarQueryParameter = {} as any;
96
+
97
+ // authentication keycloak_auth required
98
+ // http bearer authentication required
99
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
100
+
101
+ localVarHeaderParameter['Accept'] = 'application/json';
102
+
103
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
104
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
105
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
106
+
107
+ return {
108
+ url: toPathString(localVarUrlObj),
109
+ options: localVarRequestOptions,
110
+ };
111
+ },
112
+ /**
113
+ *
114
+ * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip)
115
+ * @param {string} documentId
116
+ * @param {*} [options] Override http request option.
117
+ * @throws {RequiredError}
118
+ */
119
+ lastFiling: async (documentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
120
+ // verify required parameter 'documentId' is not null or undefined
121
+ assertParamExists('lastFiling', 'documentId', documentId)
122
+ const localVarPath = `/api/v1/ai/auto-file/document/{documentId}`
123
+ .replace('{documentId}', encodeURIComponent(String(documentId)));
124
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
125
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
126
+ let baseOptions;
127
+ if (configuration) {
128
+ baseOptions = configuration.baseOptions;
129
+ }
130
+
131
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
132
+ const localVarHeaderParameter = {} as any;
133
+ const localVarQueryParameter = {} as any;
134
+
135
+ // authentication keycloak_auth required
136
+ // http bearer authentication required
137
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
138
+
139
+ localVarHeaderParameter['Accept'] = 'application/json';
140
+
141
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
142
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
143
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
144
+
145
+ return {
146
+ url: toPathString(localVarUrlObj),
147
+ options: localVarRequestOptions,
148
+ };
149
+ },
150
+ /**
151
+ *
152
+ * @summary Move every document the job filed back where it came from
153
+ * @param {string} jobId
154
+ * @param {*} [options] Override http request option.
155
+ * @throws {RequiredError}
156
+ */
157
+ undo: async (jobId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
158
+ // verify required parameter 'jobId' is not null or undefined
159
+ assertParamExists('undo', 'jobId', jobId)
160
+ const localVarPath = `/api/v1/ai/auto-file/{jobId}/undo`
161
+ .replace('{jobId}', encodeURIComponent(String(jobId)));
162
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
163
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
164
+ let baseOptions;
165
+ if (configuration) {
166
+ baseOptions = configuration.baseOptions;
167
+ }
168
+
169
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
170
+ const localVarHeaderParameter = {} as any;
171
+ const localVarQueryParameter = {} as any;
172
+
173
+ // authentication keycloak_auth required
174
+ // http bearer authentication required
175
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
176
+
177
+ localVarHeaderParameter['Accept'] = 'application/json';
178
+
179
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
180
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
181
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
182
+
183
+ return {
184
+ url: toPathString(localVarUrlObj),
185
+ options: localVarRequestOptions,
186
+ };
187
+ },
188
+ /**
189
+ *
190
+ * @summary Move one filed document back (the chip\'s \"Move back\")
191
+ * @param {string} planId
192
+ * @param {*} [options] Override http request option.
193
+ * @throws {RequiredError}
194
+ */
195
+ undoFiling: async (planId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
196
+ // verify required parameter 'planId' is not null or undefined
197
+ assertParamExists('undoFiling', 'planId', planId)
198
+ const localVarPath = `/api/v1/ai/auto-file/filing/{planId}/undo`
199
+ .replace('{planId}', encodeURIComponent(String(planId)));
200
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
201
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
202
+ let baseOptions;
203
+ if (configuration) {
204
+ baseOptions = configuration.baseOptions;
205
+ }
206
+
207
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
208
+ const localVarHeaderParameter = {} as any;
209
+ const localVarQueryParameter = {} as any;
210
+
211
+ // authentication keycloak_auth required
212
+ // http bearer authentication required
213
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
214
+
215
+ localVarHeaderParameter['Accept'] = 'application/json';
216
+
217
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
218
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
219
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
220
+
221
+ return {
222
+ url: toPathString(localVarUrlObj),
223
+ options: localVarRequestOptions,
224
+ };
225
+ },
226
+ }
227
+ };
228
+
229
+ /**
230
+ * SmartFilingApi - functional programming interface
231
+ */
232
+ export const SmartFilingApiFp = function(configuration?: Configuration) {
233
+ const localVarAxiosParamCreator = SmartFilingApiAxiosParamCreator(configuration)
234
+ return {
235
+ /**
236
+ * Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once.
237
+ * @summary File existing documents on demand
238
+ * @param {AutoFileRequest} autoFileRequest
239
+ * @param {*} [options] Override http request option.
240
+ * @throws {RequiredError}
241
+ */
242
+ async file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>> {
243
+ const localVarAxiosArgs = await localVarAxiosParamCreator.file(autoFileRequest, options);
244
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
245
+ const localVarOperationServerBasePath = operationServerMap['SmartFilingApi.file']?.[localVarOperationServerIndex]?.url;
246
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
247
+ },
248
+ /**
249
+ *
250
+ * @summary Progress and outcome of a filing job
251
+ * @param {string} jobId
252
+ * @param {*} [options] Override http request option.
253
+ * @throws {RequiredError}
254
+ */
255
+ async job(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>> {
256
+ const localVarAxiosArgs = await localVarAxiosParamCreator.job(jobId, options);
257
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
258
+ const localVarOperationServerBasePath = operationServerMap['SmartFilingApi.job']?.[localVarOperationServerIndex]?.url;
259
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
260
+ },
261
+ /**
262
+ *
263
+ * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip)
264
+ * @param {string} documentId
265
+ * @param {*} [options] Override http request option.
266
+ * @throws {RequiredError}
267
+ */
268
+ async lastFiling(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilingOutcome>> {
269
+ const localVarAxiosArgs = await localVarAxiosParamCreator.lastFiling(documentId, options);
270
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
271
+ const localVarOperationServerBasePath = operationServerMap['SmartFilingApi.lastFiling']?.[localVarOperationServerIndex]?.url;
272
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
273
+ },
274
+ /**
275
+ *
276
+ * @summary Move every document the job filed back where it came from
277
+ * @param {string} jobId
278
+ * @param {*} [options] Override http request option.
279
+ * @throws {RequiredError}
280
+ */
281
+ async undo(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutoFileJobView>> {
282
+ const localVarAxiosArgs = await localVarAxiosParamCreator.undo(jobId, options);
283
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
284
+ const localVarOperationServerBasePath = operationServerMap['SmartFilingApi.undo']?.[localVarOperationServerIndex]?.url;
285
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
286
+ },
287
+ /**
288
+ *
289
+ * @summary Move one filed document back (the chip\'s \"Move back\")
290
+ * @param {string} planId
291
+ * @param {*} [options] Override http request option.
292
+ * @throws {RequiredError}
293
+ */
294
+ async undoFiling(planId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilingOutcome>> {
295
+ const localVarAxiosArgs = await localVarAxiosParamCreator.undoFiling(planId, options);
296
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
297
+ const localVarOperationServerBasePath = operationServerMap['SmartFilingApi.undoFiling']?.[localVarOperationServerIndex]?.url;
298
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
299
+ },
300
+ }
301
+ };
302
+
303
+ /**
304
+ * SmartFilingApi - factory interface
305
+ */
306
+ export const SmartFilingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
307
+ const localVarFp = SmartFilingApiFp(configuration)
308
+ return {
309
+ /**
310
+ * Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once.
311
+ * @summary File existing documents on demand
312
+ * @param {AutoFileRequest} autoFileRequest
313
+ * @param {*} [options] Override http request option.
314
+ * @throws {RequiredError}
315
+ */
316
+ file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView> {
317
+ return localVarFp.file(autoFileRequest, options).then((request) => request(axios, basePath));
318
+ },
319
+ /**
320
+ *
321
+ * @summary Progress and outcome of a filing job
322
+ * @param {string} jobId
323
+ * @param {*} [options] Override http request option.
324
+ * @throws {RequiredError}
325
+ */
326
+ job(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView> {
327
+ return localVarFp.job(jobId, options).then((request) => request(axios, basePath));
328
+ },
329
+ /**
330
+ *
331
+ * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip)
332
+ * @param {string} documentId
333
+ * @param {*} [options] Override http request option.
334
+ * @throws {RequiredError}
335
+ */
336
+ lastFiling(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FilingOutcome> {
337
+ return localVarFp.lastFiling(documentId, options).then((request) => request(axios, basePath));
338
+ },
339
+ /**
340
+ *
341
+ * @summary Move every document the job filed back where it came from
342
+ * @param {string} jobId
343
+ * @param {*} [options] Override http request option.
344
+ * @throws {RequiredError}
345
+ */
346
+ undo(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<AutoFileJobView> {
347
+ return localVarFp.undo(jobId, options).then((request) => request(axios, basePath));
348
+ },
349
+ /**
350
+ *
351
+ * @summary Move one filed document back (the chip\'s \"Move back\")
352
+ * @param {string} planId
353
+ * @param {*} [options] Override http request option.
354
+ * @throws {RequiredError}
355
+ */
356
+ undoFiling(planId: string, options?: RawAxiosRequestConfig): AxiosPromise<FilingOutcome> {
357
+ return localVarFp.undoFiling(planId, options).then((request) => request(axios, basePath));
358
+ },
359
+ };
360
+ };
361
+
362
+ /**
363
+ * SmartFilingApi - object-oriented interface
364
+ */
365
+ export class SmartFilingApi extends BaseAPI {
366
+ /**
367
+ * Runs smart filing for the given documents (e.g. the contents of an Inbox) and returns the job at once.
368
+ * @summary File existing documents on demand
369
+ * @param {AutoFileRequest} autoFileRequest
370
+ * @param {*} [options] Override http request option.
371
+ * @throws {RequiredError}
372
+ */
373
+ public file(autoFileRequest: AutoFileRequest, options?: RawAxiosRequestConfig) {
374
+ return SmartFilingApiFp(this.configuration).file(autoFileRequest, options).then((request) => request(this.axios, this.basePath));
375
+ }
376
+
377
+ /**
378
+ *
379
+ * @summary Progress and outcome of a filing job
380
+ * @param {string} jobId
381
+ * @param {*} [options] Override http request option.
382
+ * @throws {RequiredError}
383
+ */
384
+ public job(jobId: string, options?: RawAxiosRequestConfig) {
385
+ return SmartFilingApiFp(this.configuration).job(jobId, options).then((request) => request(this.axios, this.basePath));
386
+ }
387
+
388
+ /**
389
+ *
390
+ * @summary The latest filing record of a document (the \"Filed by OpenFilz\" chip)
391
+ * @param {string} documentId
392
+ * @param {*} [options] Override http request option.
393
+ * @throws {RequiredError}
394
+ */
395
+ public lastFiling(documentId: string, options?: RawAxiosRequestConfig) {
396
+ return SmartFilingApiFp(this.configuration).lastFiling(documentId, options).then((request) => request(this.axios, this.basePath));
397
+ }
398
+
399
+ /**
400
+ *
401
+ * @summary Move every document the job filed back where it came from
402
+ * @param {string} jobId
403
+ * @param {*} [options] Override http request option.
404
+ * @throws {RequiredError}
405
+ */
406
+ public undo(jobId: string, options?: RawAxiosRequestConfig) {
407
+ return SmartFilingApiFp(this.configuration).undo(jobId, options).then((request) => request(this.axios, this.basePath));
408
+ }
409
+
410
+ /**
411
+ *
412
+ * @summary Move one filed document back (the chip\'s \"Move back\")
413
+ * @param {string} planId
414
+ * @param {*} [options] Override http request option.
415
+ * @throws {RequiredError}
416
+ */
417
+ public undoFiling(planId: string, options?: RawAxiosRequestConfig) {
418
+ return SmartFilingApiFp(this.configuration).undoFiling(planId, options).then((request) => request(this.axios, this.basePath));
419
+ }
420
+ }
421
+
package/api.ts CHANGED
@@ -23,6 +23,7 @@ export * from './api/dashboard-api';
23
23
  export * from './api/delegated-browse-grants-admin-api';
24
24
  export * from './api/delegated-browse-grants-end-user-api';
25
25
  export * from './api/document-controller-api';
26
+ export * from './api/document-insights-api';
26
27
  export * from './api/document-suggestion-controller-api';
27
28
  export * from './api/document-version-controller-api';
28
29
  export * from './api/esign-api';
@@ -41,6 +42,7 @@ export * from './api/scan-agent-api';
41
42
  export * from './api/scanner-proxy-api';
42
43
  export * from './api/search-administration-api';
43
44
  export * from './api/settings-api';
45
+ export * from './api/smart-filing-api';
44
46
  export * from './api/tus-controller-api';
45
47
  export * from './api/upload-token-controller-api';
46
48
  export * from './api/user-privacy-api';