@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.
- package/.openapi-generator/FILES +26 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +27 -4
- package/api/aichat-api.ts +82 -9
- package/api/document-controller-api.ts +30 -14
- package/api/document-insights-api.ts +357 -0
- package/api/esign-api.ts +9 -9
- package/api/settings-api.ts +142 -0
- package/api/smart-filing-api.ts +421 -0
- package/api.ts +2 -0
- package/dist/api/aichat-api.d.ts +37 -4
- package/dist/api/aichat-api.js +77 -9
- package/dist/api/document-controller-api.d.ts +16 -8
- package/dist/api/document-controller-api.js +28 -14
- package/dist/api/document-insights-api.d.ts +170 -0
- package/dist/api/document-insights-api.js +346 -0
- package/dist/api/esign-api.d.ts +4 -4
- package/dist/api/esign-api.js +9 -9
- package/dist/api/settings-api.d.ts +62 -0
- package/dist/api/settings-api.js +132 -0
- package/dist/api/smart-filing-api.d.ts +197 -0
- package/dist/api/smart-filing-api.js +409 -0
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/esm/api/aichat-api.d.ts +37 -4
- package/dist/esm/api/aichat-api.js +77 -9
- package/dist/esm/api/document-controller-api.d.ts +16 -8
- package/dist/esm/api/document-controller-api.js +28 -14
- package/dist/esm/api/document-insights-api.d.ts +170 -0
- package/dist/esm/api/document-insights-api.js +339 -0
- package/dist/esm/api/esign-api.d.ts +4 -4
- package/dist/esm/api/esign-api.js +9 -9
- package/dist/esm/api/settings-api.d.ts +62 -0
- package/dist/esm/api/settings-api.js +132 -0
- package/dist/esm/api/smart-filing-api.d.ts +197 -0
- package/dist/esm/api/smart-filing-api.js +402 -0
- package/dist/esm/api.d.ts +2 -0
- package/dist/esm/api.js +2 -0
- package/dist/esm/models/ai-preferences-view.d.ts +16 -0
- package/dist/esm/models/ai-preferences-view.js +14 -0
- package/dist/esm/models/auto-file-job-view.d.ts +25 -0
- package/dist/esm/models/auto-file-job-view.js +14 -0
- package/dist/esm/models/auto-file-request.d.ts +15 -0
- package/dist/esm/models/auto-file-request.js +14 -0
- package/dist/esm/models/auto-file-ticket.d.ts +15 -0
- package/dist/esm/models/auto-file-ticket.js +14 -0
- package/dist/esm/models/document-insight-view.d.ts +33 -0
- package/dist/esm/models/document-insight-view.js +14 -0
- package/dist/esm/models/filing-outcome.d.ts +25 -0
- package/dist/esm/models/filing-outcome.js +14 -0
- package/dist/esm/models/index.d.ts +11 -0
- package/dist/esm/models/index.js +11 -0
- package/dist/esm/models/insight-backfill-request.d.ts +15 -0
- package/dist/esm/models/insight-backfill-request.js +14 -0
- package/dist/esm/models/insight-backfill-status.d.ts +23 -0
- package/dist/esm/models/insight-backfill-status.js +14 -0
- package/dist/esm/models/insight-category-update.d.ts +14 -0
- package/dist/esm/models/insight-category-update.js +14 -0
- package/dist/esm/models/reorganization-by-kind-request.d.ts +14 -0
- package/dist/esm/models/reorganization-by-kind-request.js +14 -0
- package/dist/esm/models/save-ai-preferences-request.d.ts +15 -0
- package/dist/esm/models/save-ai-preferences-request.js +14 -0
- package/dist/esm/models/settings.d.ts +3 -0
- package/dist/esm/models/tus-finalize-request.d.ts +1 -0
- package/dist/esm/models/upload-response.d.ts +2 -0
- package/dist/models/ai-preferences-view.d.ts +16 -0
- package/dist/models/ai-preferences-view.js +15 -0
- package/dist/models/auto-file-job-view.d.ts +25 -0
- package/dist/models/auto-file-job-view.js +15 -0
- package/dist/models/auto-file-request.d.ts +15 -0
- package/dist/models/auto-file-request.js +15 -0
- package/dist/models/auto-file-ticket.d.ts +15 -0
- package/dist/models/auto-file-ticket.js +15 -0
- package/dist/models/document-insight-view.d.ts +33 -0
- package/dist/models/document-insight-view.js +15 -0
- package/dist/models/filing-outcome.d.ts +25 -0
- package/dist/models/filing-outcome.js +15 -0
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/dist/models/insight-backfill-request.d.ts +15 -0
- package/dist/models/insight-backfill-request.js +15 -0
- package/dist/models/insight-backfill-status.d.ts +23 -0
- package/dist/models/insight-backfill-status.js +15 -0
- package/dist/models/insight-category-update.d.ts +14 -0
- package/dist/models/insight-category-update.js +15 -0
- package/dist/models/reorganization-by-kind-request.d.ts +14 -0
- package/dist/models/reorganization-by-kind-request.js +15 -0
- package/dist/models/save-ai-preferences-request.d.ts +15 -0
- package/dist/models/save-ai-preferences-request.js +15 -0
- package/dist/models/settings.d.ts +3 -0
- package/dist/models/tus-finalize-request.d.ts +1 -0
- package/dist/models/upload-response.d.ts +2 -0
- package/docs/AIChatApi.md +57 -4
- package/docs/AiPreferencesView.md +24 -0
- package/docs/AutoFileJobView.md +40 -0
- package/docs/AutoFileRequest.md +22 -0
- package/docs/AutoFileTicket.md +22 -0
- package/docs/DocumentControllerApi.md +6 -0
- package/docs/DocumentInsightView.md +54 -0
- package/docs/DocumentInsightsApi.md +219 -0
- package/docs/ESignApi.md +4 -4
- package/docs/FilingOutcome.md +42 -0
- package/docs/InsightBackfillRequest.md +22 -0
- package/docs/InsightBackfillStatus.md +38 -0
- package/docs/InsightCategoryUpdate.md +20 -0
- package/docs/ReorganizationByKindRequest.md +20 -0
- package/docs/SaveAiPreferencesRequest.md +22 -0
- package/docs/Settings.md +6 -0
- package/docs/SettingsApi.md +97 -0
- package/docs/SmartFilingApi.md +264 -0
- package/docs/TusFinalizeRequest.md +2 -0
- package/docs/UploadResponse.md +2 -0
- package/models/ai-preferences-view.ts +22 -0
- package/models/auto-file-job-view.ts +33 -0
- package/models/auto-file-request.ts +21 -0
- package/models/auto-file-ticket.ts +21 -0
- package/models/document-insight-view.ts +37 -0
- package/models/filing-outcome.ts +31 -0
- package/models/index.ts +11 -0
- package/models/insight-backfill-request.ts +21 -0
- package/models/insight-backfill-status.ts +29 -0
- package/models/insight-category-update.ts +20 -0
- package/models/reorganization-by-kind-request.ts +20 -0
- package/models/save-ai-preferences-request.ts +21 -0
- package/models/settings.ts +3 -0
- package/models/tus-finalize-request.ts +1 -0
- package/models/upload-response.ts +4 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -12,6 +12,7 @@ api/dashboard-api.ts
|
|
|
12
12
|
api/delegated-browse-grants-admin-api.ts
|
|
13
13
|
api/delegated-browse-grants-end-user-api.ts
|
|
14
14
|
api/document-controller-api.ts
|
|
15
|
+
api/document-insights-api.ts
|
|
15
16
|
api/document-suggestion-controller-api.ts
|
|
16
17
|
api/document-version-controller-api.ts
|
|
17
18
|
api/esign-api.ts
|
|
@@ -30,6 +31,7 @@ api/scan-agent-api.ts
|
|
|
30
31
|
api/scanner-proxy-api.ts
|
|
31
32
|
api/search-administration-api.ts
|
|
32
33
|
api/settings-api.ts
|
|
34
|
+
api/smart-filing-api.ts
|
|
33
35
|
api/tus-controller-api.ts
|
|
34
36
|
api/upload-token-controller-api.ts
|
|
35
37
|
api/user-privacy-api.ts
|
|
@@ -44,11 +46,15 @@ docs/AiChatRequest.md
|
|
|
44
46
|
docs/AiChatResponse.md
|
|
45
47
|
docs/AiConnectionTestResult.md
|
|
46
48
|
docs/AiModelsResponse.md
|
|
49
|
+
docs/AiPreferencesView.md
|
|
47
50
|
docs/AiSettingsResponse.md
|
|
48
51
|
docs/AncestorInfo.md
|
|
49
52
|
docs/ApplySignatureRequest.md
|
|
50
53
|
docs/AuditLogDetails.md
|
|
51
54
|
docs/AuditVerificationResult.md
|
|
55
|
+
docs/AutoFileJobView.md
|
|
56
|
+
docs/AutoFileRequest.md
|
|
57
|
+
docs/AutoFileTicket.md
|
|
52
58
|
docs/BrokenLink.md
|
|
53
59
|
docs/BulkRow.md
|
|
54
60
|
docs/BulkRowResult.md
|
|
@@ -84,6 +90,8 @@ docs/DeleteRequest.md
|
|
|
84
90
|
docs/DeleteShareRequest.md
|
|
85
91
|
docs/DocumentControllerApi.md
|
|
86
92
|
docs/DocumentInfo.md
|
|
93
|
+
docs/DocumentInsightView.md
|
|
94
|
+
docs/DocumentInsightsApi.md
|
|
87
95
|
docs/DocumentPosition.md
|
|
88
96
|
docs/DocumentSuggestionControllerApi.md
|
|
89
97
|
docs/DocumentVersionControllerApi.md
|
|
@@ -101,11 +109,15 @@ docs/FeatureEntitlement.md
|
|
|
101
109
|
docs/FeatureEntitlementsApi.md
|
|
102
110
|
docs/FileControllerApi.md
|
|
103
111
|
docs/FileTypeStats.md
|
|
112
|
+
docs/FilingOutcome.md
|
|
104
113
|
docs/FilterInput.md
|
|
105
114
|
docs/FolderControllerApi.md
|
|
106
115
|
docs/FolderElementInfo.md
|
|
107
116
|
docs/FolderResponse.md
|
|
108
117
|
docs/IngestionStatusDto.md
|
|
118
|
+
docs/InsightBackfillRequest.md
|
|
119
|
+
docs/InsightBackfillStatus.md
|
|
120
|
+
docs/InsightCategoryUpdate.md
|
|
109
121
|
docs/InstantiateTemplateRequest.md
|
|
110
122
|
docs/Item.md
|
|
111
123
|
docs/ItemResult.md
|
|
@@ -138,6 +150,7 @@ docs/RenameAudit.md
|
|
|
138
150
|
docs/RenameRequest.md
|
|
139
151
|
docs/ReorganizationApplyRequest.md
|
|
140
152
|
docs/ReorganizationApplyResult.md
|
|
153
|
+
docs/ReorganizationByKindRequest.md
|
|
141
154
|
docs/ReorganizationPlanView.md
|
|
142
155
|
docs/ReplaceAudit.md
|
|
143
156
|
docs/Response.md
|
|
@@ -145,6 +158,7 @@ docs/RestoreVersionAudit.md
|
|
|
145
158
|
docs/RestoreVersionResponse.md
|
|
146
159
|
docs/RoleBinding.md
|
|
147
160
|
docs/RotateRequest.md
|
|
161
|
+
docs/SaveAiPreferencesRequest.md
|
|
148
162
|
docs/SaveAiSettingsRequest.md
|
|
149
163
|
docs/ScanAgentApi.md
|
|
150
164
|
docs/ScanJobStatusDto.md
|
|
@@ -174,6 +188,7 @@ docs/SignatureTemplateDTO.md
|
|
|
174
188
|
docs/SignatureTemplateField.md
|
|
175
189
|
docs/SignatureTemplateRequest.md
|
|
176
190
|
docs/SignatureTemplateRole.md
|
|
191
|
+
docs/SmartFilingApi.md
|
|
177
192
|
docs/SortInput.md
|
|
178
193
|
docs/SplitOutput.md
|
|
179
194
|
docs/SplitRequest.md
|
|
@@ -207,11 +222,15 @@ models/ai-chat-request.ts
|
|
|
207
222
|
models/ai-chat-response.ts
|
|
208
223
|
models/ai-connection-test-result.ts
|
|
209
224
|
models/ai-models-response.ts
|
|
225
|
+
models/ai-preferences-view.ts
|
|
210
226
|
models/ai-settings-response.ts
|
|
211
227
|
models/ancestor-info.ts
|
|
212
228
|
models/apply-signature-request.ts
|
|
213
229
|
models/audit-log-details.ts
|
|
214
230
|
models/audit-verification-result.ts
|
|
231
|
+
models/auto-file-job-view.ts
|
|
232
|
+
models/auto-file-request.ts
|
|
233
|
+
models/auto-file-ticket.ts
|
|
215
234
|
models/broken-link.ts
|
|
216
235
|
models/bulk-row-result.ts
|
|
217
236
|
models/bulk-row.ts
|
|
@@ -240,6 +259,7 @@ models/delete-metadata-request.ts
|
|
|
240
259
|
models/delete-request.ts
|
|
241
260
|
models/delete-share-request.ts
|
|
242
261
|
models/document-info.ts
|
|
262
|
+
models/document-insight-view.ts
|
|
243
263
|
models/document-position.ts
|
|
244
264
|
models/document-version-info.ts
|
|
245
265
|
models/element-info.ts
|
|
@@ -248,11 +268,15 @@ models/enriched-audit-log-details.ts
|
|
|
248
268
|
models/enriched-audit-log.ts
|
|
249
269
|
models/feature-entitlement.ts
|
|
250
270
|
models/file-type-stats.ts
|
|
271
|
+
models/filing-outcome.ts
|
|
251
272
|
models/filter-input.ts
|
|
252
273
|
models/folder-element-info.ts
|
|
253
274
|
models/folder-response.ts
|
|
254
275
|
models/index.ts
|
|
255
276
|
models/ingestion-status-dto.ts
|
|
277
|
+
models/insight-backfill-request.ts
|
|
278
|
+
models/insight-backfill-status.ts
|
|
279
|
+
models/insight-category-update.ts
|
|
256
280
|
models/instantiate-template-request.ts
|
|
257
281
|
models/item-result.ts
|
|
258
282
|
models/item.ts
|
|
@@ -281,6 +305,7 @@ models/rename-audit.ts
|
|
|
281
305
|
models/rename-request.ts
|
|
282
306
|
models/reorganization-apply-request.ts
|
|
283
307
|
models/reorganization-apply-result.ts
|
|
308
|
+
models/reorganization-by-kind-request.ts
|
|
284
309
|
models/reorganization-plan-view.ts
|
|
285
310
|
models/replace-audit.ts
|
|
286
311
|
models/response.ts
|
|
@@ -288,6 +313,7 @@ models/restore-version-audit.ts
|
|
|
288
313
|
models/restore-version-response.ts
|
|
289
314
|
models/role-binding.ts
|
|
290
315
|
models/rotate-request.ts
|
|
316
|
+
models/save-ai-preferences-request.ts
|
|
291
317
|
models/save-ai-settings-request.ts
|
|
292
318
|
models/scan-job-status-dto.ts
|
|
293
319
|
models/scan-request-dto.ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
91e0f0055ffddfef3515d682aa9ca428eabf276cc0b75de00534326acb64495b
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @openfilz-sdk/typescript-ee@1.9.
|
|
1
|
+
## @openfilz-sdk/typescript-ee@1.9.8
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @openfilz-sdk/typescript-ee@1.9.
|
|
39
|
+
npm install @openfilz-sdk/typescript-ee@1.9.8 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -55,9 +55,10 @@ Class | Method | HTTP request | Description
|
|
|
55
55
|
*AIChatApi* | [**chat**](docs/AIChatApi.md#chat) | **POST** /api/v1/ai/chat | Chat with AI assistant
|
|
56
56
|
*AIChatApi* | [**deleteConversation**](docs/AIChatApi.md#deleteconversation) | **DELETE** /api/v1/ai/conversations/{conversationId} | Delete conversation
|
|
57
57
|
*AIChatApi* | [**discard**](docs/AIChatApi.md#discard) | **POST** /api/v1/ai/reorganization/{planId}/discard | Discard a proposed reorganisation plan
|
|
58
|
-
*AIChatApi* | [**
|
|
58
|
+
*AIChatApi* | [**get4**](docs/AIChatApi.md#get4) | **GET** /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant
|
|
59
59
|
*AIChatApi* | [**getConversationHistory**](docs/AIChatApi.md#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history
|
|
60
60
|
*AIChatApi* | [**listConversations**](docs/AIChatApi.md#listconversations) | **GET** /api/v1/ai/conversations | List conversations
|
|
61
|
+
*AIChatApi* | [**proposeByKind**](docs/AIChatApi.md#proposebykind) | **POST** /api/v1/ai/reorganization/by-kind | Propose a reorganisation by kind of document — no model involved
|
|
61
62
|
*AISettingsApi* | [**deleteSettings**](docs/AISettingsApi.md#deletesettings) | **DELETE** /api/v1/settings/ai | Reset my AI settings
|
|
62
63
|
*AISettingsApi* | [**getSettings1**](docs/AISettingsApi.md#getsettings1) | **GET** /api/v1/settings/ai | Get my AI settings
|
|
63
64
|
*AISettingsApi* | [**listModels**](docs/AISettingsApi.md#listmodels) | **POST** /api/v1/settings/ai/models | List the provider\'s chat models
|
|
@@ -110,6 +111,10 @@ Class | Method | HTTP request | Description
|
|
|
110
111
|
*DocumentControllerApi* | [**updateDocumentMetadata**](docs/DocumentControllerApi.md#updatedocumentmetadata) | **PATCH** /api/v1/documents/{documentId}/metadata | Update document metadata
|
|
111
112
|
*DocumentControllerApi* | [**uploadDocument**](docs/DocumentControllerApi.md#uploaddocument) | **POST** /api/v1/documents/upload-multiple | Upload multiple documents
|
|
112
113
|
*DocumentControllerApi* | [**uploadDocument1**](docs/DocumentControllerApi.md#uploaddocument1) | **POST** /api/v1/documents/upload | Upload a single document
|
|
114
|
+
*DocumentInsightsApi* | [**backfill**](docs/DocumentInsightsApi.md#backfill) | **POST** /api/v1/ai/insights/backfill | Enrich existing documents
|
|
115
|
+
*DocumentInsightsApi* | [**backfillStatus**](docs/DocumentInsightsApi.md#backfillstatus) | **GET** /api/v1/ai/insights/backfill/{jobId} | Progress of a backfill job
|
|
116
|
+
*DocumentInsightsApi* | [**getInsights**](docs/DocumentInsightsApi.md#getinsights) | **GET** /api/v1/documents/{documentId}/insights | Get the insights of a document
|
|
117
|
+
*DocumentInsightsApi* | [**setCategory**](docs/DocumentInsightsApi.md#setcategory) | **PATCH** /api/v1/documents/{documentId}/insights | Correct the kind of a document
|
|
113
118
|
*DocumentSuggestionControllerApi* | [**getSuggestions**](docs/DocumentSuggestionControllerApi.md#getsuggestions) | **GET** /api/v1/suggestions |
|
|
114
119
|
*DocumentVersionControllerApi* | [**downloadVersion**](docs/DocumentVersionControllerApi.md#downloadversion) | **GET** /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version
|
|
115
120
|
*DocumentVersionControllerApi* | [**listVersions**](docs/DocumentVersionControllerApi.md#listversions) | **GET** /api/v1/documents/{documentId}/versions | List document versions
|
|
@@ -118,7 +123,7 @@ Class | Method | HTTP request | Description
|
|
|
118
123
|
*ESignApi* | [**cloudSubscription**](docs/ESignApi.md#cloudsubscription) | **GET** /api/v1/signatures/cloud-subscription | Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
119
124
|
*ESignApi* | [**create**](docs/ESignApi.md#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false)
|
|
120
125
|
*ESignApi* | [**events**](docs/ESignApi.md#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes
|
|
121
|
-
*ESignApi* | [**
|
|
126
|
+
*ESignApi* | [**get3**](docs/ESignApi.md#get3) | **GET** /api/v1/signatures/{id} | Get one of my envelopes (recipients + fields)
|
|
122
127
|
*ESignApi* | [**listSent**](docs/ESignApi.md#listsent) | **GET** /api/v1/signatures | List envelopes I sent for signature
|
|
123
128
|
*ESignApi* | [**listToSign**](docs/ESignApi.md#listtosign) | **GET** /api/v1/signatures/to-sign | List envelopes waiting for my signature
|
|
124
129
|
*ESignApi* | [**resend**](docs/ESignApi.md#resend) | **POST** /api/v1/signatures/{id}/recipients/{recipientId}/resend | Resend the signing link to a recipient (new token, previous one revoked)
|
|
@@ -182,9 +187,16 @@ Class | Method | HTTP request | Description
|
|
|
182
187
|
*SearchAdministrationApi* | [**deleteIndex**](docs/SearchAdministrationApi.md#deleteindex) | **DELETE** /api/v1/admin/search | Delete search index
|
|
183
188
|
*SearchAdministrationApi* | [**getStatus**](docs/SearchAdministrationApi.md#getstatus) | **GET** /api/v1/admin/search/status | Get reindexation status
|
|
184
189
|
*SearchAdministrationApi* | [**reindexAll**](docs/SearchAdministrationApi.md#reindexall) | **POST** /api/v1/admin/search/reindex | Reindex all documents
|
|
190
|
+
*SettingsApi* | [**get2**](docs/SettingsApi.md#get2) | **GET** /api/v1/settings/ai/preferences | The caller\'s smart-filing preferences
|
|
185
191
|
*SettingsApi* | [**getLicenseInfo**](docs/SettingsApi.md#getlicenseinfo) | **GET** /api/v1/settings/license | Coarse license info
|
|
186
192
|
*SettingsApi* | [**getSettings**](docs/SettingsApi.md#getsettings) | **GET** /api/v1/settings | Get user\'s settings
|
|
193
|
+
*SettingsApi* | [**save**](docs/SettingsApi.md#save) | **PUT** /api/v1/settings/ai/preferences | Save the caller\'s smart-filing preferences
|
|
187
194
|
*SettingsApi* | [**saveSettings**](docs/SettingsApi.md#savesettings) | **PUT** /api/v1/settings | Save user preferences
|
|
195
|
+
*SmartFilingApi* | [**file**](docs/SmartFilingApi.md#file) | **POST** /api/v1/ai/auto-file | File existing documents on demand
|
|
196
|
+
*SmartFilingApi* | [**job**](docs/SmartFilingApi.md#job) | **GET** /api/v1/ai/auto-file/{jobId} | Progress and outcome of a filing job
|
|
197
|
+
*SmartFilingApi* | [**lastFiling**](docs/SmartFilingApi.md#lastfiling) | **GET** /api/v1/ai/auto-file/document/{documentId} | The latest filing record of a document (the \"Filed by OpenFilz\" chip)
|
|
198
|
+
*SmartFilingApi* | [**undo**](docs/SmartFilingApi.md#undo) | **POST** /api/v1/ai/auto-file/{jobId}/undo | Move every document the job filed back where it came from
|
|
199
|
+
*SmartFilingApi* | [**undoFiling**](docs/SmartFilingApi.md#undofiling) | **POST** /api/v1/ai/auto-file/filing/{planId}/undo | Move one filed document back (the chip\'s \"Move back\")
|
|
188
200
|
*TusControllerApi* | [**_options**](docs/TusControllerApi.md#_options) | **OPTIONS** /api/v1/tus | TUS capability discovery
|
|
189
201
|
*TusControllerApi* | [**cancelUpload**](docs/TusControllerApi.md#cancelupload) | **DELETE** /api/v1/tus/{uploadId} | Cancel upload
|
|
190
202
|
*TusControllerApi* | [**createUpload**](docs/TusControllerApi.md#createupload) | **POST** /api/v1/tus | Create new TUS upload
|
|
@@ -214,11 +226,15 @@ Class | Method | HTTP request | Description
|
|
|
214
226
|
- [AiChatResponse](docs/AiChatResponse.md)
|
|
215
227
|
- [AiConnectionTestResult](docs/AiConnectionTestResult.md)
|
|
216
228
|
- [AiModelsResponse](docs/AiModelsResponse.md)
|
|
229
|
+
- [AiPreferencesView](docs/AiPreferencesView.md)
|
|
217
230
|
- [AiSettingsResponse](docs/AiSettingsResponse.md)
|
|
218
231
|
- [AncestorInfo](docs/AncestorInfo.md)
|
|
219
232
|
- [ApplySignatureRequest](docs/ApplySignatureRequest.md)
|
|
220
233
|
- [AuditLogDetails](docs/AuditLogDetails.md)
|
|
221
234
|
- [AuditVerificationResult](docs/AuditVerificationResult.md)
|
|
235
|
+
- [AutoFileJobView](docs/AutoFileJobView.md)
|
|
236
|
+
- [AutoFileRequest](docs/AutoFileRequest.md)
|
|
237
|
+
- [AutoFileTicket](docs/AutoFileTicket.md)
|
|
222
238
|
- [BrokenLink](docs/BrokenLink.md)
|
|
223
239
|
- [BulkRow](docs/BulkRow.md)
|
|
224
240
|
- [BulkRowResult](docs/BulkRowResult.md)
|
|
@@ -247,6 +263,7 @@ Class | Method | HTTP request | Description
|
|
|
247
263
|
- [DeleteRequest](docs/DeleteRequest.md)
|
|
248
264
|
- [DeleteShareRequest](docs/DeleteShareRequest.md)
|
|
249
265
|
- [DocumentInfo](docs/DocumentInfo.md)
|
|
266
|
+
- [DocumentInsightView](docs/DocumentInsightView.md)
|
|
250
267
|
- [DocumentPosition](docs/DocumentPosition.md)
|
|
251
268
|
- [DocumentVersionInfo](docs/DocumentVersionInfo.md)
|
|
252
269
|
- [ElementInfo](docs/ElementInfo.md)
|
|
@@ -255,10 +272,14 @@ Class | Method | HTTP request | Description
|
|
|
255
272
|
- [EnrichedAuditLogDetails](docs/EnrichedAuditLogDetails.md)
|
|
256
273
|
- [FeatureEntitlement](docs/FeatureEntitlement.md)
|
|
257
274
|
- [FileTypeStats](docs/FileTypeStats.md)
|
|
275
|
+
- [FilingOutcome](docs/FilingOutcome.md)
|
|
258
276
|
- [FilterInput](docs/FilterInput.md)
|
|
259
277
|
- [FolderElementInfo](docs/FolderElementInfo.md)
|
|
260
278
|
- [FolderResponse](docs/FolderResponse.md)
|
|
261
279
|
- [IngestionStatusDto](docs/IngestionStatusDto.md)
|
|
280
|
+
- [InsightBackfillRequest](docs/InsightBackfillRequest.md)
|
|
281
|
+
- [InsightBackfillStatus](docs/InsightBackfillStatus.md)
|
|
282
|
+
- [InsightCategoryUpdate](docs/InsightCategoryUpdate.md)
|
|
262
283
|
- [InstantiateTemplateRequest](docs/InstantiateTemplateRequest.md)
|
|
263
284
|
- [Item](docs/Item.md)
|
|
264
285
|
- [ItemResult](docs/ItemResult.md)
|
|
@@ -287,6 +308,7 @@ Class | Method | HTTP request | Description
|
|
|
287
308
|
- [RenameRequest](docs/RenameRequest.md)
|
|
288
309
|
- [ReorganizationApplyRequest](docs/ReorganizationApplyRequest.md)
|
|
289
310
|
- [ReorganizationApplyResult](docs/ReorganizationApplyResult.md)
|
|
311
|
+
- [ReorganizationByKindRequest](docs/ReorganizationByKindRequest.md)
|
|
290
312
|
- [ReorganizationPlanView](docs/ReorganizationPlanView.md)
|
|
291
313
|
- [ReplaceAudit](docs/ReplaceAudit.md)
|
|
292
314
|
- [Response](docs/Response.md)
|
|
@@ -294,6 +316,7 @@ Class | Method | HTTP request | Description
|
|
|
294
316
|
- [RestoreVersionResponse](docs/RestoreVersionResponse.md)
|
|
295
317
|
- [RoleBinding](docs/RoleBinding.md)
|
|
296
318
|
- [RotateRequest](docs/RotateRequest.md)
|
|
319
|
+
- [SaveAiPreferencesRequest](docs/SaveAiPreferencesRequest.md)
|
|
297
320
|
- [SaveAiSettingsRequest](docs/SaveAiSettingsRequest.md)
|
|
298
321
|
- [ScanJobStatusDto](docs/ScanJobStatusDto.md)
|
|
299
322
|
- [ScanRequestDto](docs/ScanRequestDto.md)
|
package/api/aichat-api.ts
CHANGED
|
@@ -32,6 +32,8 @@ import type { ReorganizationApplyRequest } from '../models';
|
|
|
32
32
|
// @ts-ignore
|
|
33
33
|
import type { ReorganizationApplyResult } from '../models';
|
|
34
34
|
// @ts-ignore
|
|
35
|
+
import type { ReorganizationByKindRequest } from '../models';
|
|
36
|
+
// @ts-ignore
|
|
35
37
|
import type { ReorganizationPlanView } from '../models';
|
|
36
38
|
/**
|
|
37
39
|
* AIChatApi - axios parameter creator
|
|
@@ -200,9 +202,9 @@ export const AIChatApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
200
202
|
* @param {*} [options] Override http request option.
|
|
201
203
|
* @throws {RequiredError}
|
|
202
204
|
*/
|
|
203
|
-
|
|
205
|
+
get4: async (planId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
204
206
|
// verify required parameter 'planId' is not null or undefined
|
|
205
|
-
assertParamExists('
|
|
207
|
+
assertParamExists('get4', 'planId', planId)
|
|
206
208
|
const localVarPath = `/api/v1/ai/reorganization/{planId}`
|
|
207
209
|
.replace('{planId}', encodeURIComponent(String(planId)));
|
|
208
210
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -298,6 +300,43 @@ export const AIChatApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
298
300
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
299
301
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
300
302
|
|
|
303
|
+
return {
|
|
304
|
+
url: toPathString(localVarUrlObj),
|
|
305
|
+
options: localVarRequestOptions,
|
|
306
|
+
};
|
|
307
|
+
},
|
|
308
|
+
/**
|
|
309
|
+
* 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.
|
|
310
|
+
* @summary Propose a reorganisation by kind of document — no model involved
|
|
311
|
+
* @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
|
|
312
|
+
* @param {*} [options] Override http request option.
|
|
313
|
+
* @throws {RequiredError}
|
|
314
|
+
*/
|
|
315
|
+
proposeByKind: async (reorganizationByKindRequest?: ReorganizationByKindRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
316
|
+
const localVarPath = `/api/v1/ai/reorganization/by-kind`;
|
|
317
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
318
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
319
|
+
let baseOptions;
|
|
320
|
+
if (configuration) {
|
|
321
|
+
baseOptions = configuration.baseOptions;
|
|
322
|
+
}
|
|
323
|
+
|
|
324
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
325
|
+
const localVarHeaderParameter = {} as any;
|
|
326
|
+
const localVarQueryParameter = {} as any;
|
|
327
|
+
|
|
328
|
+
// authentication keycloak_auth required
|
|
329
|
+
// http bearer authentication required
|
|
330
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
331
|
+
|
|
332
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
333
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
334
|
+
|
|
335
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
336
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
337
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
338
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reorganizationByKindRequest, localVarRequestOptions, configuration)
|
|
339
|
+
|
|
301
340
|
return {
|
|
302
341
|
url: toPathString(localVarUrlObj),
|
|
303
342
|
options: localVarRequestOptions,
|
|
@@ -372,10 +411,10 @@ export const AIChatApiFp = function(configuration?: Configuration) {
|
|
|
372
411
|
* @param {*} [options] Override http request option.
|
|
373
412
|
* @throws {RequiredError}
|
|
374
413
|
*/
|
|
375
|
-
async
|
|
376
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
414
|
+
async get4(planId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>> {
|
|
415
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.get4(planId, options);
|
|
377
416
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
378
|
-
const localVarOperationServerBasePath = operationServerMap['AIChatApi.
|
|
417
|
+
const localVarOperationServerBasePath = operationServerMap['AIChatApi.get4']?.[localVarOperationServerIndex]?.url;
|
|
379
418
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
380
419
|
},
|
|
381
420
|
/**
|
|
@@ -403,6 +442,19 @@ export const AIChatApiFp = function(configuration?: Configuration) {
|
|
|
403
442
|
const localVarOperationServerBasePath = operationServerMap['AIChatApi.listConversations']?.[localVarOperationServerIndex]?.url;
|
|
404
443
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
405
444
|
},
|
|
445
|
+
/**
|
|
446
|
+
* 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.
|
|
447
|
+
* @summary Propose a reorganisation by kind of document — no model involved
|
|
448
|
+
* @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
|
|
449
|
+
* @param {*} [options] Override http request option.
|
|
450
|
+
* @throws {RequiredError}
|
|
451
|
+
*/
|
|
452
|
+
async proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>> {
|
|
453
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.proposeByKind(reorganizationByKindRequest, options);
|
|
454
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
455
|
+
const localVarOperationServerBasePath = operationServerMap['AIChatApi.proposeByKind']?.[localVarOperationServerIndex]?.url;
|
|
456
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
457
|
+
},
|
|
406
458
|
}
|
|
407
459
|
};
|
|
408
460
|
|
|
@@ -460,8 +512,8 @@ export const AIChatApiFactory = function (configuration?: Configuration, basePat
|
|
|
460
512
|
* @param {*} [options] Override http request option.
|
|
461
513
|
* @throws {RequiredError}
|
|
462
514
|
*/
|
|
463
|
-
|
|
464
|
-
return localVarFp.
|
|
515
|
+
get4(planId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView> {
|
|
516
|
+
return localVarFp.get4(planId, options).then((request) => request(axios, basePath));
|
|
465
517
|
},
|
|
466
518
|
/**
|
|
467
519
|
* Get all messages in a conversation
|
|
@@ -482,6 +534,16 @@ export const AIChatApiFactory = function (configuration?: Configuration, basePat
|
|
|
482
534
|
listConversations(options?: RawAxiosRequestConfig): AxiosPromise<Array<AiChatConversation>> {
|
|
483
535
|
return localVarFp.listConversations(options).then((request) => request(axios, basePath));
|
|
484
536
|
},
|
|
537
|
+
/**
|
|
538
|
+
* 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.
|
|
539
|
+
* @summary Propose a reorganisation by kind of document — no model involved
|
|
540
|
+
* @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
|
|
541
|
+
* @param {*} [options] Override http request option.
|
|
542
|
+
* @throws {RequiredError}
|
|
543
|
+
*/
|
|
544
|
+
proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView> {
|
|
545
|
+
return localVarFp.proposeByKind(reorganizationByKindRequest, options).then((request) => request(axios, basePath));
|
|
546
|
+
},
|
|
485
547
|
};
|
|
486
548
|
};
|
|
487
549
|
|
|
@@ -541,8 +603,8 @@ export class AIChatApi extends BaseAPI {
|
|
|
541
603
|
* @param {*} [options] Override http request option.
|
|
542
604
|
* @throws {RequiredError}
|
|
543
605
|
*/
|
|
544
|
-
public
|
|
545
|
-
return AIChatApiFp(this.configuration).
|
|
606
|
+
public get4(planId: string, options?: RawAxiosRequestConfig) {
|
|
607
|
+
return AIChatApiFp(this.configuration).get4(planId, options).then((request) => request(this.axios, this.basePath));
|
|
546
608
|
}
|
|
547
609
|
|
|
548
610
|
/**
|
|
@@ -565,5 +627,16 @@ export class AIChatApi extends BaseAPI {
|
|
|
565
627
|
public listConversations(options?: RawAxiosRequestConfig) {
|
|
566
628
|
return AIChatApiFp(this.configuration).listConversations(options).then((request) => request(this.axios, this.basePath));
|
|
567
629
|
}
|
|
630
|
+
|
|
631
|
+
/**
|
|
632
|
+
* 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.
|
|
633
|
+
* @summary Propose a reorganisation by kind of document — no model involved
|
|
634
|
+
* @param {ReorganizationByKindRequest} [reorganizationByKindRequest]
|
|
635
|
+
* @param {*} [options] Override http request option.
|
|
636
|
+
* @throws {RequiredError}
|
|
637
|
+
*/
|
|
638
|
+
public proposeByKind(reorganizationByKindRequest?: ReorganizationByKindRequest, options?: RawAxiosRequestConfig) {
|
|
639
|
+
return AIChatApiFp(this.configuration).proposeByKind(reorganizationByKindRequest, options).then((request) => request(this.axios, this.basePath));
|
|
640
|
+
}
|
|
568
641
|
}
|
|
569
642
|
|
|
@@ -602,11 +602,12 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration?:
|
|
|
602
602
|
* @summary Upload multiple documents
|
|
603
603
|
* @param {Array<File>} file
|
|
604
604
|
* @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
|
|
605
|
+
* @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent = the user\'s own switch. Needs openfilz.ai.auto-file.active.
|
|
605
606
|
* @param {string} [parametersByFilename] Paste the JSON array here<br>This array provides optional metadata and attributes for the uploaded files<br><section> <h3>Each object in the array must contain:</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>filename</code></td> <td><code>String</code></td> <td>Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.</td> </tr> <tr> <td><code>fileAttributes</code></td> <td><code>JSON Object</code></td> <td>Container for metadata and other file-specific attributes.</td> </tr> </tbody> </table> <h4>Inside <code>fileAttributes</code>:</h4> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>parentFolderId</code></td> <td><code>UUID</code></td> <td>UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)</td> </tr> <tr> <td><code>metadata</code></td> <td><code>Map&lt;String, JSON Object&gt;</code></td> <td>Arbitrary metadata to associate with the file (key/value pairs).</td> </tr> </tbody> </table> <h4>Example of <code>parametersByFilename</code> JSON array :</h4> <pre><code>[ { \\\"filename\\\": \\\"file1.txt\\\", \\\"fileAttributes\\\": { \\\"parentFolderId\\\": \\\"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\", \\\"metadata\\\": { \\\"country\\\": \\\"UK\\\", \\\"owner\\\": { \\\"name\\\": \\\"Joe\\\", \\\"owner_id\\\": 1234568 } } } }, { \\\"filename\\\": \\\"file2.md\\\", \\\"fileAttributes\\\": { \\\"metadata\\\": { \\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\", \\\"key3\\\": \\\"value3\\\" } } } ]</code></pre> </section>
|
|
606
607
|
* @param {*} [options] Override http request option.
|
|
607
608
|
* @throws {RequiredError}
|
|
608
609
|
*/
|
|
609
|
-
uploadDocument: async (file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
610
|
+
uploadDocument: async (file: Array<File>, allowDuplicateFileNames?: boolean, autoFile?: boolean, parametersByFilename?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
610
611
|
// verify required parameter 'file' is not null or undefined
|
|
611
612
|
assertParamExists('uploadDocument', 'file', file)
|
|
612
613
|
const localVarPath = `/api/v1/documents/upload-multiple`;
|
|
@@ -630,6 +631,10 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration?:
|
|
|
630
631
|
localVarQueryParameter['allowDuplicateFileNames'] = allowDuplicateFileNames;
|
|
631
632
|
}
|
|
632
633
|
|
|
634
|
+
if (autoFile !== undefined) {
|
|
635
|
+
localVarQueryParameter['autoFile'] = autoFile;
|
|
636
|
+
}
|
|
637
|
+
|
|
633
638
|
if (file) {
|
|
634
639
|
file.forEach((element) => {
|
|
635
640
|
localVarFormParams.append('file', element as any);
|
|
@@ -658,12 +663,13 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration?:
|
|
|
658
663
|
* @summary Upload a single document
|
|
659
664
|
* @param {File} file
|
|
660
665
|
* @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
|
|
666
|
+
* @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent = the user\'s own switch. Needs openfilz.ai.auto-file.active.
|
|
661
667
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
662
668
|
* @param {string} [metadata]
|
|
663
669
|
* @param {*} [options] Override http request option.
|
|
664
670
|
* @throws {RequiredError}
|
|
665
671
|
*/
|
|
666
|
-
uploadDocument1: async (file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
672
|
+
uploadDocument1: async (file: File, allowDuplicateFileNames?: boolean, autoFile?: boolean, parentFolderId?: string, metadata?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
667
673
|
// verify required parameter 'file' is not null or undefined
|
|
668
674
|
assertParamExists('uploadDocument1', 'file', file)
|
|
669
675
|
const localVarPath = `/api/v1/documents/upload`;
|
|
@@ -687,6 +693,10 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration?:
|
|
|
687
693
|
localVarQueryParameter['allowDuplicateFileNames'] = allowDuplicateFileNames;
|
|
688
694
|
}
|
|
689
695
|
|
|
696
|
+
if (autoFile !== undefined) {
|
|
697
|
+
localVarQueryParameter['autoFile'] = autoFile;
|
|
698
|
+
}
|
|
699
|
+
|
|
690
700
|
|
|
691
701
|
if (file !== undefined) {
|
|
692
702
|
localVarFormParams.append('file', file as any);
|
|
@@ -905,12 +915,13 @@ export const DocumentControllerApiFp = function(configuration?: Configuration) {
|
|
|
905
915
|
* @summary Upload multiple documents
|
|
906
916
|
* @param {Array<File>} file
|
|
907
917
|
* @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
|
|
918
|
+
* @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent = the user\'s own switch. Needs openfilz.ai.auto-file.active.
|
|
908
919
|
* @param {string} [parametersByFilename] Paste the JSON array here<br>This array provides optional metadata and attributes for the uploaded files<br><section> <h3>Each object in the array must contain:</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>filename</code></td> <td><code>String</code></td> <td>Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.</td> </tr> <tr> <td><code>fileAttributes</code></td> <td><code>JSON Object</code></td> <td>Container for metadata and other file-specific attributes.</td> </tr> </tbody> </table> <h4>Inside <code>fileAttributes</code>:</h4> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>parentFolderId</code></td> <td><code>UUID</code></td> <td>UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)</td> </tr> <tr> <td><code>metadata</code></td> <td><code>Map&lt;String, JSON Object&gt;</code></td> <td>Arbitrary metadata to associate with the file (key/value pairs).</td> </tr> </tbody> </table> <h4>Example of <code>parametersByFilename</code> JSON array :</h4> <pre><code>[ { \\\"filename\\\": \\\"file1.txt\\\", \\\"fileAttributes\\\": { \\\"parentFolderId\\\": \\\"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\", \\\"metadata\\\": { \\\"country\\\": \\\"UK\\\", \\\"owner\\\": { \\\"name\\\": \\\"Joe\\\", \\\"owner_id\\\": 1234568 } } } }, { \\\"filename\\\": \\\"file2.md\\\", \\\"fileAttributes\\\": { \\\"metadata\\\": { \\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\", \\\"key3\\\": \\\"value3\\\" } } } ]</code></pre> </section>
|
|
909
920
|
* @param {*} [options] Override http request option.
|
|
910
921
|
* @throws {RequiredError}
|
|
911
922
|
*/
|
|
912
|
-
async uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UploadResponse>>> {
|
|
913
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options);
|
|
923
|
+
async uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, autoFile?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UploadResponse>>> {
|
|
924
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options);
|
|
914
925
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
915
926
|
const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.uploadDocument']?.[localVarOperationServerIndex]?.url;
|
|
916
927
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -920,13 +931,14 @@ export const DocumentControllerApiFp = function(configuration?: Configuration) {
|
|
|
920
931
|
* @summary Upload a single document
|
|
921
932
|
* @param {File} file
|
|
922
933
|
* @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
|
|
934
|
+
* @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent = the user\'s own switch. Needs openfilz.ai.auto-file.active.
|
|
923
935
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
924
936
|
* @param {string} [metadata]
|
|
925
937
|
* @param {*} [options] Override http request option.
|
|
926
938
|
* @throws {RequiredError}
|
|
927
939
|
*/
|
|
928
|
-
async uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadResponse>> {
|
|
929
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options);
|
|
940
|
+
async uploadDocument1(file: File, allowDuplicateFileNames?: boolean, autoFile?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadResponse>> {
|
|
941
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options);
|
|
930
942
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
931
943
|
const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.uploadDocument1']?.[localVarOperationServerIndex]?.url;
|
|
932
944
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1085,25 +1097,27 @@ export const DocumentControllerApiFactory = function (configuration?: Configurat
|
|
|
1085
1097
|
* @summary Upload multiple documents
|
|
1086
1098
|
* @param {Array<File>} file
|
|
1087
1099
|
* @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
|
|
1100
|
+
* @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent = the user\'s own switch. Needs openfilz.ai.auto-file.active.
|
|
1088
1101
|
* @param {string} [parametersByFilename] Paste the JSON array here<br>This array provides optional metadata and attributes for the uploaded files<br><section> <h3>Each object in the array must contain:</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>filename</code></td> <td><code>String</code></td> <td>Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.</td> </tr> <tr> <td><code>fileAttributes</code></td> <td><code>JSON Object</code></td> <td>Container for metadata and other file-specific attributes.</td> </tr> </tbody> </table> <h4>Inside <code>fileAttributes</code>:</h4> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>parentFolderId</code></td> <td><code>UUID</code></td> <td>UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)</td> </tr> <tr> <td><code>metadata</code></td> <td><code>Map&lt;String, JSON Object&gt;</code></td> <td>Arbitrary metadata to associate with the file (key/value pairs).</td> </tr> </tbody> </table> <h4>Example of <code>parametersByFilename</code> JSON array :</h4> <pre><code>[ { \\\"filename\\\": \\\"file1.txt\\\", \\\"fileAttributes\\\": { \\\"parentFolderId\\\": \\\"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\", \\\"metadata\\\": { \\\"country\\\": \\\"UK\\\", \\\"owner\\\": { \\\"name\\\": \\\"Joe\\\", \\\"owner_id\\\": 1234568 } } } }, { \\\"filename\\\": \\\"file2.md\\\", \\\"fileAttributes\\\": { \\\"metadata\\\": { \\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\", \\\"key3\\\": \\\"value3\\\" } } } ]</code></pre> </section>
|
|
1089
1102
|
* @param {*} [options] Override http request option.
|
|
1090
1103
|
* @throws {RequiredError}
|
|
1091
1104
|
*/
|
|
1092
|
-
uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UploadResponse>> {
|
|
1093
|
-
return localVarFp.uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options).then((request) => request(axios, basePath));
|
|
1105
|
+
uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, autoFile?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UploadResponse>> {
|
|
1106
|
+
return localVarFp.uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options).then((request) => request(axios, basePath));
|
|
1094
1107
|
},
|
|
1095
1108
|
/**
|
|
1096
1109
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
1097
1110
|
* @summary Upload a single document
|
|
1098
1111
|
* @param {File} file
|
|
1099
1112
|
* @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
|
|
1113
|
+
* @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent = the user\'s own switch. Needs openfilz.ai.auto-file.active.
|
|
1100
1114
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
1101
1115
|
* @param {string} [metadata]
|
|
1102
1116
|
* @param {*} [options] Override http request option.
|
|
1103
1117
|
* @throws {RequiredError}
|
|
1104
1118
|
*/
|
|
1105
|
-
uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): AxiosPromise<UploadResponse> {
|
|
1106
|
-
return localVarFp.uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options).then((request) => request(axios, basePath));
|
|
1119
|
+
uploadDocument1(file: File, allowDuplicateFileNames?: boolean, autoFile?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): AxiosPromise<UploadResponse> {
|
|
1120
|
+
return localVarFp.uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options).then((request) => request(axios, basePath));
|
|
1107
1121
|
},
|
|
1108
1122
|
};
|
|
1109
1123
|
};
|
|
@@ -1270,12 +1284,13 @@ export class DocumentControllerApi extends BaseAPI {
|
|
|
1270
1284
|
* @summary Upload multiple documents
|
|
1271
1285
|
* @param {Array<File>} file
|
|
1272
1286
|
* @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
|
|
1287
|
+
* @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent = the user\'s own switch. Needs openfilz.ai.auto-file.active.
|
|
1273
1288
|
* @param {string} [parametersByFilename] Paste the JSON array here<br>This array provides optional metadata and attributes for the uploaded files<br><section> <h3>Each object in the array must contain:</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>filename</code></td> <td><code>String</code></td> <td>Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.</td> </tr> <tr> <td><code>fileAttributes</code></td> <td><code>JSON Object</code></td> <td>Container for metadata and other file-specific attributes.</td> </tr> </tbody> </table> <h4>Inside <code>fileAttributes</code>:</h4> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>parentFolderId</code></td> <td><code>UUID</code></td> <td>UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)</td> </tr> <tr> <td><code>metadata</code></td> <td><code>Map&lt;String, JSON Object&gt;</code></td> <td>Arbitrary metadata to associate with the file (key/value pairs).</td> </tr> </tbody> </table> <h4>Example of <code>parametersByFilename</code> JSON array :</h4> <pre><code>[ { \\\"filename\\\": \\\"file1.txt\\\", \\\"fileAttributes\\\": { \\\"parentFolderId\\\": \\\"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\", \\\"metadata\\\": { \\\"country\\\": \\\"UK\\\", \\\"owner\\\": { \\\"name\\\": \\\"Joe\\\", \\\"owner_id\\\": 1234568 } } } }, { \\\"filename\\\": \\\"file2.md\\\", \\\"fileAttributes\\\": { \\\"metadata\\\": { \\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\", \\\"key3\\\": \\\"value3\\\" } } } ]</code></pre> </section>
|
|
1274
1289
|
* @param {*} [options] Override http request option.
|
|
1275
1290
|
* @throws {RequiredError}
|
|
1276
1291
|
*/
|
|
1277
|
-
public uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig) {
|
|
1278
|
-
return DocumentControllerApiFp(this.configuration).uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options).then((request) => request(this.axios, this.basePath));
|
|
1292
|
+
public uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, autoFile?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig) {
|
|
1293
|
+
return DocumentControllerApiFp(this.configuration).uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options).then((request) => request(this.axios, this.basePath));
|
|
1279
1294
|
}
|
|
1280
1295
|
|
|
1281
1296
|
/**
|
|
@@ -1283,13 +1298,14 @@ export class DocumentControllerApi extends BaseAPI {
|
|
|
1283
1298
|
* @summary Upload a single document
|
|
1284
1299
|
* @param {File} file
|
|
1285
1300
|
* @param {boolean} [allowDuplicateFileNames] when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten)
|
|
1301
|
+
* @param {boolean} [autoFile] Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent = the user\'s own switch. Needs openfilz.ai.auto-file.active.
|
|
1286
1302
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
1287
1303
|
* @param {string} [metadata]
|
|
1288
1304
|
* @param {*} [options] Override http request option.
|
|
1289
1305
|
* @throws {RequiredError}
|
|
1290
1306
|
*/
|
|
1291
|
-
public uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig) {
|
|
1292
|
-
return DocumentControllerApiFp(this.configuration).uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options).then((request) => request(this.axios, this.basePath));
|
|
1307
|
+
public uploadDocument1(file: File, allowDuplicateFileNames?: boolean, autoFile?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig) {
|
|
1308
|
+
return DocumentControllerApiFp(this.configuration).uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options).then((request) => request(this.axios, this.basePath));
|
|
1293
1309
|
}
|
|
1294
1310
|
}
|
|
1295
1311
|
|