@openfilz-sdk/typescript 1.3.4 → 1.3.6
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 +22 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +23 -4
- package/api/aichat-api.ts +9 -9
- package/api/document-controller-api.ts +30 -14
- package/api/document-insights-api.ts +275 -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 +4 -4
- package/dist/api/aichat-api.js +9 -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 +133 -0
- package/dist/api/document-insights-api.js +269 -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 +4 -4
- package/dist/esm/api/aichat-api.js +9 -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 +133 -0
- package/dist/esm/api/document-insights-api.js +262 -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 +133 -1
- 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 +9 -0
- package/dist/esm/models/index.js +9 -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/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 +2 -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 +9 -0
- package/dist/models/index.js +9 -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/save-ai-preferences-request.d.ts +15 -0
- package/dist/models/save-ai-preferences-request.js +15 -0
- package/dist/models/settings.d.ts +2 -0
- package/dist/models/tus-finalize-request.d.ts +1 -0
- package/dist/models/upload-response.d.ts +2 -0
- package/docs/AIChatApi.md +4 -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 +163 -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/SaveAiPreferencesRequest.md +22 -0
- package/docs/Settings.md +4 -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 +9 -0
- package/models/insight-backfill-request.ts +21 -0
- package/models/insight-backfill-status.ts +29 -0
- package/models/save-ai-preferences-request.ts +21 -0
- package/models/settings.ts +2 -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
|
@@ -8,6 +8,7 @@ api/aisettings-api.ts
|
|
|
8
8
|
api/audit-controller-api.ts
|
|
9
9
|
api/dashboard-api.ts
|
|
10
10
|
api/document-controller-api.ts
|
|
11
|
+
api/document-insights-api.ts
|
|
11
12
|
api/document-suggestion-controller-api.ts
|
|
12
13
|
api/document-version-controller-api.ts
|
|
13
14
|
api/esign-api.ts
|
|
@@ -19,6 +20,7 @@ api/folder-controller-api.ts
|
|
|
19
20
|
api/mcp-discovery-controller-api.ts
|
|
20
21
|
api/pdftools-api.ts
|
|
21
22
|
api/settings-api.ts
|
|
23
|
+
api/smart-filing-api.ts
|
|
22
24
|
api/tus-controller-api.ts
|
|
23
25
|
base.ts
|
|
24
26
|
common.ts
|
|
@@ -30,6 +32,7 @@ docs/AiChatRequest.md
|
|
|
30
32
|
docs/AiChatResponse.md
|
|
31
33
|
docs/AiConnectionTestResult.md
|
|
32
34
|
docs/AiModelsResponse.md
|
|
35
|
+
docs/AiPreferencesView.md
|
|
33
36
|
docs/AiSettingsResponse.md
|
|
34
37
|
docs/AncestorInfo.md
|
|
35
38
|
docs/ApplySignatureRequest.md
|
|
@@ -38,6 +41,9 @@ docs/AuditLog.md
|
|
|
38
41
|
docs/AuditLogDetails.md
|
|
39
42
|
docs/AuditLogDetailsOneOf.md
|
|
40
43
|
docs/AuditVerificationResult.md
|
|
44
|
+
docs/AutoFileJobView.md
|
|
45
|
+
docs/AutoFileRequest.md
|
|
46
|
+
docs/AutoFileTicket.md
|
|
41
47
|
docs/BrokenLink.md
|
|
42
48
|
docs/CloudSignatureSubscription.md
|
|
43
49
|
docs/CopyAudit.md
|
|
@@ -56,6 +62,8 @@ docs/DeleteMetadataRequest.md
|
|
|
56
62
|
docs/DeleteRequest.md
|
|
57
63
|
docs/DocumentControllerApi.md
|
|
58
64
|
docs/DocumentInfo.md
|
|
65
|
+
docs/DocumentInsightView.md
|
|
66
|
+
docs/DocumentInsightsApi.md
|
|
59
67
|
docs/DocumentPosition.md
|
|
60
68
|
docs/DocumentSuggestionControllerApi.md
|
|
61
69
|
docs/DocumentVersionControllerApi.md
|
|
@@ -67,10 +75,13 @@ docs/ElementInfo.md
|
|
|
67
75
|
docs/FavoritesApi.md
|
|
68
76
|
docs/FileControllerApi.md
|
|
69
77
|
docs/FileTypeStats.md
|
|
78
|
+
docs/FilingOutcome.md
|
|
70
79
|
docs/FilterInput.md
|
|
71
80
|
docs/FolderControllerApi.md
|
|
72
81
|
docs/FolderElementInfo.md
|
|
73
82
|
docs/FolderResponse.md
|
|
83
|
+
docs/InsightBackfillRequest.md
|
|
84
|
+
docs/InsightBackfillStatus.md
|
|
74
85
|
docs/InstantiateTemplateRequest.md
|
|
75
86
|
docs/Item.md
|
|
76
87
|
docs/ItemResult.md
|
|
@@ -101,6 +112,7 @@ docs/RestoreVersionAudit.md
|
|
|
101
112
|
docs/RestoreVersionResponse.md
|
|
102
113
|
docs/RoleBinding.md
|
|
103
114
|
docs/RotateRequest.md
|
|
115
|
+
docs/SaveAiPreferencesRequest.md
|
|
104
116
|
docs/SaveAiSettingsRequest.md
|
|
105
117
|
docs/SearchByAuditLogRequest.md
|
|
106
118
|
docs/SearchByMetadataRequest.md
|
|
@@ -119,6 +131,7 @@ docs/SignatureTemplateDTO.md
|
|
|
119
131
|
docs/SignatureTemplateField.md
|
|
120
132
|
docs/SignatureTemplateRequest.md
|
|
121
133
|
docs/SignatureTemplateRole.md
|
|
134
|
+
docs/SmartFilingApi.md
|
|
122
135
|
docs/SortInput.md
|
|
123
136
|
docs/SplitOutput.md
|
|
124
137
|
docs/SplitRequest.md
|
|
@@ -140,6 +153,7 @@ models/ai-chat-request.ts
|
|
|
140
153
|
models/ai-chat-response.ts
|
|
141
154
|
models/ai-connection-test-result.ts
|
|
142
155
|
models/ai-models-response.ts
|
|
156
|
+
models/ai-preferences-view.ts
|
|
143
157
|
models/ai-settings-response.ts
|
|
144
158
|
models/ancestor-info.ts
|
|
145
159
|
models/apply-signature-request.ts
|
|
@@ -147,6 +161,9 @@ models/audit-log-details-one-of.ts
|
|
|
147
161
|
models/audit-log-details.ts
|
|
148
162
|
models/audit-log.ts
|
|
149
163
|
models/audit-verification-result.ts
|
|
164
|
+
models/auto-file-job-view.ts
|
|
165
|
+
models/auto-file-request.ts
|
|
166
|
+
models/auto-file-ticket.ts
|
|
150
167
|
models/broken-link.ts
|
|
151
168
|
models/cloud-signature-subscription.ts
|
|
152
169
|
models/copy-audit.ts
|
|
@@ -163,14 +180,18 @@ models/delete-metadata-audit.ts
|
|
|
163
180
|
models/delete-metadata-request.ts
|
|
164
181
|
models/delete-request.ts
|
|
165
182
|
models/document-info.ts
|
|
183
|
+
models/document-insight-view.ts
|
|
166
184
|
models/document-position.ts
|
|
167
185
|
models/document-version-info.ts
|
|
168
186
|
models/element-info.ts
|
|
169
187
|
models/file-type-stats.ts
|
|
188
|
+
models/filing-outcome.ts
|
|
170
189
|
models/filter-input.ts
|
|
171
190
|
models/folder-element-info.ts
|
|
172
191
|
models/folder-response.ts
|
|
173
192
|
models/index.ts
|
|
193
|
+
models/insight-backfill-request.ts
|
|
194
|
+
models/insight-backfill-status.ts
|
|
174
195
|
models/instantiate-template-request.ts
|
|
175
196
|
models/item-result.ts
|
|
176
197
|
models/item.ts
|
|
@@ -199,6 +220,7 @@ models/restore-version-audit.ts
|
|
|
199
220
|
models/restore-version-response.ts
|
|
200
221
|
models/role-binding.ts
|
|
201
222
|
models/rotate-request.ts
|
|
223
|
+
models/save-ai-preferences-request.ts
|
|
202
224
|
models/save-ai-settings-request.ts
|
|
203
225
|
models/search-by-audit-log-request.ts
|
|
204
226
|
models/search-by-metadata-request.ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
43c5d04dd3991a7d4b0c4722474c62b97f9244205cf7bc869b7596cb0bca5568
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @openfilz-sdk/typescript@1.3.
|
|
1
|
+
## @openfilz-sdk/typescript@1.3.6
|
|
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@1.3.
|
|
39
|
+
npm install @openfilz-sdk/typescript@1.3.6 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -55,7 +55,7 @@ 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* | [**get3**](docs/AIChatApi.md#get3) | **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
61
|
*AISettingsApi* | [**deleteSettings**](docs/AISettingsApi.md#deletesettings) | **DELETE** /api/v1/settings/ai | Reset my AI settings
|
|
@@ -82,6 +82,9 @@ Class | Method | HTTP request | Description
|
|
|
82
82
|
*DocumentControllerApi* | [**updateDocumentMetadata**](docs/DocumentControllerApi.md#updatedocumentmetadata) | **PATCH** /api/v1/documents/{documentId}/metadata | Update document metadata
|
|
83
83
|
*DocumentControllerApi* | [**uploadDocument**](docs/DocumentControllerApi.md#uploaddocument) | **POST** /api/v1/documents/upload-multiple | Upload multiple documents
|
|
84
84
|
*DocumentControllerApi* | [**uploadDocument1**](docs/DocumentControllerApi.md#uploaddocument1) | **POST** /api/v1/documents/upload | Upload a single document
|
|
85
|
+
*DocumentInsightsApi* | [**backfill**](docs/DocumentInsightsApi.md#backfill) | **POST** /api/v1/ai/insights/backfill | Enrich existing documents
|
|
86
|
+
*DocumentInsightsApi* | [**backfillStatus**](docs/DocumentInsightsApi.md#backfillstatus) | **GET** /api/v1/ai/insights/backfill/{jobId} | Progress of a backfill job
|
|
87
|
+
*DocumentInsightsApi* | [**getInsights**](docs/DocumentInsightsApi.md#getinsights) | **GET** /api/v1/documents/{documentId}/insights | Get the insights of a document
|
|
85
88
|
*DocumentSuggestionControllerApi* | [**getSuggestions**](docs/DocumentSuggestionControllerApi.md#getsuggestions) | **GET** /api/v1/suggestions |
|
|
86
89
|
*DocumentVersionControllerApi* | [**downloadVersion**](docs/DocumentVersionControllerApi.md#downloadversion) | **GET** /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version
|
|
87
90
|
*DocumentVersionControllerApi* | [**listVersions**](docs/DocumentVersionControllerApi.md#listversions) | **GET** /api/v1/documents/{documentId}/versions | List document versions
|
|
@@ -90,7 +93,7 @@ Class | Method | HTTP request | Description
|
|
|
90
93
|
*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)
|
|
91
94
|
*ESignApi* | [**create**](docs/ESignApi.md#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false)
|
|
92
95
|
*ESignApi* | [**events**](docs/ESignApi.md#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes
|
|
93
|
-
*ESignApi* | [**
|
|
96
|
+
*ESignApi* | [**get2**](docs/ESignApi.md#get2) | **GET** /api/v1/signatures/{id} | Get one of my envelopes (recipients + fields)
|
|
94
97
|
*ESignApi* | [**listSent**](docs/ESignApi.md#listsent) | **GET** /api/v1/signatures | List envelopes I sent for signature
|
|
95
98
|
*ESignApi* | [**listToSign**](docs/ESignApi.md#listtosign) | **GET** /api/v1/signatures/to-sign | List envelopes waiting for my signature
|
|
96
99
|
*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)
|
|
@@ -131,7 +134,14 @@ Class | Method | HTTP request | Description
|
|
|
131
134
|
*PDFToolsApi* | [**organize**](docs/PDFToolsApi.md#organize) | **POST** /api/v1/pdf/organize | Reorganise the pages of a PDF
|
|
132
135
|
*PDFToolsApi* | [**rotate**](docs/PDFToolsApi.md#rotate) | **POST** /api/v1/pdf/rotate | Rotate pages
|
|
133
136
|
*PDFToolsApi* | [**split**](docs/PDFToolsApi.md#split) | **POST** /api/v1/pdf/split | Split a PDF
|
|
137
|
+
*SettingsApi* | [**get1**](docs/SettingsApi.md#get1) | **GET** /api/v1/settings/ai/preferences | The caller\'s smart-filing preferences
|
|
134
138
|
*SettingsApi* | [**getSettings1**](docs/SettingsApi.md#getsettings1) | **GET** /api/v1/settings | Get user\'s settings
|
|
139
|
+
*SettingsApi* | [**save**](docs/SettingsApi.md#save) | **PUT** /api/v1/settings/ai/preferences | Save the caller\'s smart-filing preferences
|
|
140
|
+
*SmartFilingApi* | [**file**](docs/SmartFilingApi.md#file) | **POST** /api/v1/ai/auto-file | File existing documents on demand
|
|
141
|
+
*SmartFilingApi* | [**job**](docs/SmartFilingApi.md#job) | **GET** /api/v1/ai/auto-file/{jobId} | Progress and outcome of a filing job
|
|
142
|
+
*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)
|
|
143
|
+
*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
|
|
144
|
+
*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\")
|
|
135
145
|
*TusControllerApi* | [**_options**](docs/TusControllerApi.md#_options) | **OPTIONS** /api/v1/tus | TUS capability discovery
|
|
136
146
|
*TusControllerApi* | [**cancelUpload**](docs/TusControllerApi.md#cancelupload) | **DELETE** /api/v1/tus/{uploadId} | Cancel upload
|
|
137
147
|
*TusControllerApi* | [**createUpload**](docs/TusControllerApi.md#createupload) | **POST** /api/v1/tus | Create new TUS upload
|
|
@@ -150,6 +160,7 @@ Class | Method | HTTP request | Description
|
|
|
150
160
|
- [AiChatResponse](docs/AiChatResponse.md)
|
|
151
161
|
- [AiConnectionTestResult](docs/AiConnectionTestResult.md)
|
|
152
162
|
- [AiModelsResponse](docs/AiModelsResponse.md)
|
|
163
|
+
- [AiPreferencesView](docs/AiPreferencesView.md)
|
|
153
164
|
- [AiSettingsResponse](docs/AiSettingsResponse.md)
|
|
154
165
|
- [AncestorInfo](docs/AncestorInfo.md)
|
|
155
166
|
- [ApplySignatureRequest](docs/ApplySignatureRequest.md)
|
|
@@ -157,6 +168,9 @@ Class | Method | HTTP request | Description
|
|
|
157
168
|
- [AuditLogDetails](docs/AuditLogDetails.md)
|
|
158
169
|
- [AuditLogDetailsOneOf](docs/AuditLogDetailsOneOf.md)
|
|
159
170
|
- [AuditVerificationResult](docs/AuditVerificationResult.md)
|
|
171
|
+
- [AutoFileJobView](docs/AutoFileJobView.md)
|
|
172
|
+
- [AutoFileRequest](docs/AutoFileRequest.md)
|
|
173
|
+
- [AutoFileTicket](docs/AutoFileTicket.md)
|
|
160
174
|
- [BrokenLink](docs/BrokenLink.md)
|
|
161
175
|
- [CloudSignatureSubscription](docs/CloudSignatureSubscription.md)
|
|
162
176
|
- [CopyAudit](docs/CopyAudit.md)
|
|
@@ -173,13 +187,17 @@ Class | Method | HTTP request | Description
|
|
|
173
187
|
- [DeleteMetadataRequest](docs/DeleteMetadataRequest.md)
|
|
174
188
|
- [DeleteRequest](docs/DeleteRequest.md)
|
|
175
189
|
- [DocumentInfo](docs/DocumentInfo.md)
|
|
190
|
+
- [DocumentInsightView](docs/DocumentInsightView.md)
|
|
176
191
|
- [DocumentPosition](docs/DocumentPosition.md)
|
|
177
192
|
- [DocumentVersionInfo](docs/DocumentVersionInfo.md)
|
|
178
193
|
- [ElementInfo](docs/ElementInfo.md)
|
|
179
194
|
- [FileTypeStats](docs/FileTypeStats.md)
|
|
195
|
+
- [FilingOutcome](docs/FilingOutcome.md)
|
|
180
196
|
- [FilterInput](docs/FilterInput.md)
|
|
181
197
|
- [FolderElementInfo](docs/FolderElementInfo.md)
|
|
182
198
|
- [FolderResponse](docs/FolderResponse.md)
|
|
199
|
+
- [InsightBackfillRequest](docs/InsightBackfillRequest.md)
|
|
200
|
+
- [InsightBackfillStatus](docs/InsightBackfillStatus.md)
|
|
183
201
|
- [InstantiateTemplateRequest](docs/InstantiateTemplateRequest.md)
|
|
184
202
|
- [Item](docs/Item.md)
|
|
185
203
|
- [ItemResult](docs/ItemResult.md)
|
|
@@ -208,6 +226,7 @@ Class | Method | HTTP request | Description
|
|
|
208
226
|
- [RestoreVersionResponse](docs/RestoreVersionResponse.md)
|
|
209
227
|
- [RoleBinding](docs/RoleBinding.md)
|
|
210
228
|
- [RotateRequest](docs/RotateRequest.md)
|
|
229
|
+
- [SaveAiPreferencesRequest](docs/SaveAiPreferencesRequest.md)
|
|
211
230
|
- [SaveAiSettingsRequest](docs/SaveAiSettingsRequest.md)
|
|
212
231
|
- [SearchByAuditLogRequest](docs/SearchByAuditLogRequest.md)
|
|
213
232
|
- [SearchByMetadataRequest](docs/SearchByMetadataRequest.md)
|
package/api/aichat-api.ts
CHANGED
|
@@ -200,9 +200,9 @@ export const AIChatApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
203
|
-
|
|
203
|
+
get3: async (planId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
204
204
|
// verify required parameter 'planId' is not null or undefined
|
|
205
|
-
assertParamExists('
|
|
205
|
+
assertParamExists('get3', 'planId', planId)
|
|
206
206
|
const localVarPath = `/api/v1/ai/reorganization/{planId}`
|
|
207
207
|
.replace('{planId}', encodeURIComponent(String(planId)));
|
|
208
208
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -372,10 +372,10 @@ export const AIChatApiFp = function(configuration?: Configuration) {
|
|
|
372
372
|
* @param {*} [options] Override http request option.
|
|
373
373
|
* @throws {RequiredError}
|
|
374
374
|
*/
|
|
375
|
-
async
|
|
376
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
375
|
+
async get3(planId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>> {
|
|
376
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.get3(planId, options);
|
|
377
377
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
378
|
-
const localVarOperationServerBasePath = operationServerMap['AIChatApi.
|
|
378
|
+
const localVarOperationServerBasePath = operationServerMap['AIChatApi.get3']?.[localVarOperationServerIndex]?.url;
|
|
379
379
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
380
380
|
},
|
|
381
381
|
/**
|
|
@@ -460,8 +460,8 @@ export const AIChatApiFactory = function (configuration?: Configuration, basePat
|
|
|
460
460
|
* @param {*} [options] Override http request option.
|
|
461
461
|
* @throws {RequiredError}
|
|
462
462
|
*/
|
|
463
|
-
|
|
464
|
-
return localVarFp.
|
|
463
|
+
get3(planId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView> {
|
|
464
|
+
return localVarFp.get3(planId, options).then((request) => request(axios, basePath));
|
|
465
465
|
},
|
|
466
466
|
/**
|
|
467
467
|
* Get all messages in a conversation
|
|
@@ -541,8 +541,8 @@ export class AIChatApi extends BaseAPI {
|
|
|
541
541
|
* @param {*} [options] Override http request option.
|
|
542
542
|
* @throws {RequiredError}
|
|
543
543
|
*/
|
|
544
|
-
public
|
|
545
|
-
return AIChatApiFp(this.configuration).
|
|
544
|
+
public get3(planId: string, options?: RawAxiosRequestConfig) {
|
|
545
|
+
return AIChatApiFp(this.configuration).get3(planId, options).then((request) => request(this.axios, this.basePath));
|
|
546
546
|
}
|
|
547
547
|
|
|
548
548
|
/**
|
|
@@ -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
|
|