@openfilz-sdk/typescript-ee 1.9.6 → 1.9.8

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 (128) hide show
  1. package/.openapi-generator/FILES +26 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +27 -4
  4. package/api/aichat-api.ts +82 -9
  5. package/api/document-controller-api.ts +30 -14
  6. package/api/document-insights-api.ts +357 -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 +37 -4
  12. package/dist/api/aichat-api.js +77 -9
  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 +170 -0
  16. package/dist/api/document-insights-api.js +346 -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 +37 -4
  26. package/dist/esm/api/aichat-api.js +77 -9
  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 +170 -0
  30. package/dist/esm/api/document-insights-api.js +339 -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 +11 -0
  52. package/dist/esm/models/index.js +11 -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/insight-category-update.d.ts +14 -0
  58. package/dist/esm/models/insight-category-update.js +14 -0
  59. package/dist/esm/models/reorganization-by-kind-request.d.ts +14 -0
  60. package/dist/esm/models/reorganization-by-kind-request.js +14 -0
  61. package/dist/esm/models/save-ai-preferences-request.d.ts +15 -0
  62. package/dist/esm/models/save-ai-preferences-request.js +14 -0
  63. package/dist/esm/models/settings.d.ts +3 -0
  64. package/dist/esm/models/tus-finalize-request.d.ts +1 -0
  65. package/dist/esm/models/upload-response.d.ts +2 -0
  66. package/dist/models/ai-preferences-view.d.ts +16 -0
  67. package/dist/models/ai-preferences-view.js +15 -0
  68. package/dist/models/auto-file-job-view.d.ts +25 -0
  69. package/dist/models/auto-file-job-view.js +15 -0
  70. package/dist/models/auto-file-request.d.ts +15 -0
  71. package/dist/models/auto-file-request.js +15 -0
  72. package/dist/models/auto-file-ticket.d.ts +15 -0
  73. package/dist/models/auto-file-ticket.js +15 -0
  74. package/dist/models/document-insight-view.d.ts +33 -0
  75. package/dist/models/document-insight-view.js +15 -0
  76. package/dist/models/filing-outcome.d.ts +25 -0
  77. package/dist/models/filing-outcome.js +15 -0
  78. package/dist/models/index.d.ts +11 -0
  79. package/dist/models/index.js +11 -0
  80. package/dist/models/insight-backfill-request.d.ts +15 -0
  81. package/dist/models/insight-backfill-request.js +15 -0
  82. package/dist/models/insight-backfill-status.d.ts +23 -0
  83. package/dist/models/insight-backfill-status.js +15 -0
  84. package/dist/models/insight-category-update.d.ts +14 -0
  85. package/dist/models/insight-category-update.js +15 -0
  86. package/dist/models/reorganization-by-kind-request.d.ts +14 -0
  87. package/dist/models/reorganization-by-kind-request.js +15 -0
  88. package/dist/models/save-ai-preferences-request.d.ts +15 -0
  89. package/dist/models/save-ai-preferences-request.js +15 -0
  90. package/dist/models/settings.d.ts +3 -0
  91. package/dist/models/tus-finalize-request.d.ts +1 -0
  92. package/dist/models/upload-response.d.ts +2 -0
  93. package/docs/AIChatApi.md +57 -4
  94. package/docs/AiPreferencesView.md +24 -0
  95. package/docs/AutoFileJobView.md +40 -0
  96. package/docs/AutoFileRequest.md +22 -0
  97. package/docs/AutoFileTicket.md +22 -0
  98. package/docs/DocumentControllerApi.md +6 -0
  99. package/docs/DocumentInsightView.md +54 -0
  100. package/docs/DocumentInsightsApi.md +219 -0
  101. package/docs/ESignApi.md +4 -4
  102. package/docs/FilingOutcome.md +42 -0
  103. package/docs/InsightBackfillRequest.md +22 -0
  104. package/docs/InsightBackfillStatus.md +38 -0
  105. package/docs/InsightCategoryUpdate.md +20 -0
  106. package/docs/ReorganizationByKindRequest.md +20 -0
  107. package/docs/SaveAiPreferencesRequest.md +22 -0
  108. package/docs/Settings.md +6 -0
  109. package/docs/SettingsApi.md +97 -0
  110. package/docs/SmartFilingApi.md +264 -0
  111. package/docs/TusFinalizeRequest.md +2 -0
  112. package/docs/UploadResponse.md +2 -0
  113. package/models/ai-preferences-view.ts +22 -0
  114. package/models/auto-file-job-view.ts +33 -0
  115. package/models/auto-file-request.ts +21 -0
  116. package/models/auto-file-ticket.ts +21 -0
  117. package/models/document-insight-view.ts +37 -0
  118. package/models/filing-outcome.ts +31 -0
  119. package/models/index.ts +11 -0
  120. package/models/insight-backfill-request.ts +21 -0
  121. package/models/insight-backfill-status.ts +29 -0
  122. package/models/insight-category-update.ts +20 -0
  123. package/models/reorganization-by-kind-request.ts +20 -0
  124. package/models/save-ai-preferences-request.ts +21 -0
  125. package/models/settings.ts +3 -0
  126. package/models/tus-finalize-request.ts +1 -0
  127. package/models/upload-response.ts +4 -0
  128. package/package.json +1 -1
@@ -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';
@@ -17,6 +17,7 @@ import type { AiChatRequest } from '../models';
17
17
  import type { AiChatResponse } from '../models';
18
18
  import type { ReorganizationApplyRequest } from '../models';
19
19
  import type { ReorganizationApplyResult } from '../models';
20
+ import type { ReorganizationByKindRequest } from '../models';
20
21
  import type { ReorganizationPlanView } from '../models';
21
22
  /**
22
23
  * AIChatApi - axios parameter creator
@@ -62,7 +63,7 @@ export declare const AIChatApiAxiosParamCreator: (configuration?: Configuration)
62
63
  * @param {*} [options] Override http request option.
63
64
  * @throws {RequiredError}
64
65
  */
65
- get3: (planId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
66
+ get4: (planId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
66
67
  /**
67
68
  * Get all messages in a conversation
68
69
  * @summary Get conversation history
@@ -78,6 +79,14 @@ export declare const AIChatApiAxiosParamCreator: (configuration?: Configuration)
78
79
  * @throws {RequiredError}
79
80
  */
80
81
  listConversations: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
82
+ /**
83
+ * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
84
+ * @summary Propose a reorganisation by kind of document — no model involved
85
+ * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
86
+ * @param {*} [options] Override http request option.
87
+ * @throws {RequiredError}
88
+ */
89
+ proposeByKind: (reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
81
90
  };
82
91
  /**
83
92
  * AIChatApi - functional programming interface
@@ -123,7 +132,7 @@ export declare const AIChatApiFp: (configuration?: Configuration) => {
123
132
  * @param {*} [options] Override http request option.
124
133
  * @throws {RequiredError}
125
134
  */
126
- get3(planId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>>;
135
+ get4(planId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>>;
127
136
  /**
128
137
  * Get all messages in a conversation
129
138
  * @summary Get conversation history
@@ -139,6 +148,14 @@ export declare const AIChatApiFp: (configuration?: Configuration) => {
139
148
  * @throws {RequiredError}
140
149
  */
141
150
  listConversations(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AiChatConversation>>>;
151
+ /**
152
+ * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
153
+ * @summary Propose a reorganisation by kind of document — no model involved
154
+ * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
155
+ * @param {*} [options] Override http request option.
156
+ * @throws {RequiredError}
157
+ */
158
+ proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>>;
142
159
  };
143
160
  /**
144
161
  * AIChatApi - factory interface
@@ -184,7 +201,7 @@ export declare const AIChatApiFactory: (configuration?: Configuration, basePath?
184
201
  * @param {*} [options] Override http request option.
185
202
  * @throws {RequiredError}
186
203
  */
187
- get3(planId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView>;
204
+ get4(planId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView>;
188
205
  /**
189
206
  * Get all messages in a conversation
190
207
  * @summary Get conversation history
@@ -200,6 +217,14 @@ export declare const AIChatApiFactory: (configuration?: Configuration, basePath?
200
217
  * @throws {RequiredError}
201
218
  */
202
219
  listConversations(options?: RawAxiosRequestConfig): AxiosPromise<Array<AiChatConversation>>;
220
+ /**
221
+ * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
222
+ * @summary Propose a reorganisation by kind of document — no model involved
223
+ * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
224
+ * @param {*} [options] Override http request option.
225
+ * @throws {RequiredError}
226
+ */
227
+ proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView>;
203
228
  };
204
229
  /**
205
230
  * AIChatApi - object-oriented interface
@@ -245,7 +270,7 @@ export declare class AIChatApi extends BaseAPI {
245
270
  * @param {*} [options] Override http request option.
246
271
  * @throws {RequiredError}
247
272
  */
248
- get3(planId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorganizationPlanView, any, {}, any>>;
273
+ get4(planId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorganizationPlanView, any, {}, any>>;
249
274
  /**
250
275
  * Get all messages in a conversation
251
276
  * @summary Get conversation history
@@ -261,4 +286,12 @@ export declare class AIChatApi extends BaseAPI {
261
286
  * @throws {RequiredError}
262
287
  */
263
288
  listConversations(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AiChatConversation[], any, {}, any>>;
289
+ /**
290
+ * Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
291
+ * @summary Propose a reorganisation by kind of document — no model involved
292
+ * @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
293
+ * @param {*} [options] Override http request option.
294
+ * @throws {RequiredError}
295
+ */
296
+ proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorganizationPlanView, any, {}, any>>;
264
297
  }