@openfilz-sdk/typescript 1.3.23 → 1.3.25
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 +6 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +6 -2
- package/api/document-controller-api.ts +8 -8
- package/api/file-controller-api.ts +82 -0
- package/dist/api/document-controller-api.d.ts +8 -8
- package/dist/api/document-controller-api.js +8 -8
- package/dist/api/file-controller-api.d.ts +38 -0
- package/dist/api/file-controller-api.js +75 -0
- package/dist/esm/api/document-controller-api.d.ts +8 -8
- package/dist/esm/api/document-controller-api.js +8 -8
- package/dist/esm/api/file-controller-api.d.ts +38 -0
- package/dist/esm/api/file-controller-api.js +75 -0
- package/dist/esm/models/audit-log.d.ts +1 -0
- package/dist/esm/models/audit-log.js +1 -0
- package/dist/esm/models/copy-request.d.ts +1 -1
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/esm/models/move-request.d.ts +1 -1
- package/dist/esm/models/search-by-audit-log-request.d.ts +1 -0
- package/dist/esm/models/search-by-audit-log-request.js +1 -0
- package/dist/esm/models/settings.d.ts +3 -0
- package/dist/esm/models/unzip-request.d.ts +29 -0
- package/dist/esm/models/unzip-request.js +14 -0
- package/dist/esm/models/unzip-response.d.ts +34 -0
- package/dist/esm/models/unzip-response.js +14 -0
- package/dist/esm/models/unzip-skipped-entry.d.ts +34 -0
- package/dist/esm/models/unzip-skipped-entry.js +21 -0
- package/dist/models/audit-log.d.ts +1 -0
- package/dist/models/audit-log.js +1 -0
- package/dist/models/copy-request.d.ts +1 -1
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/move-request.d.ts +1 -1
- package/dist/models/search-by-audit-log-request.d.ts +1 -0
- package/dist/models/search-by-audit-log-request.js +1 -0
- package/dist/models/settings.d.ts +3 -0
- package/dist/models/unzip-request.d.ts +29 -0
- package/dist/models/unzip-request.js +15 -0
- package/dist/models/unzip-response.d.ts +34 -0
- package/dist/models/unzip-response.js +15 -0
- package/dist/models/unzip-skipped-entry.d.ts +34 -0
- package/dist/models/unzip-skipped-entry.js +24 -0
- package/docs/CopyRequest.md +1 -1
- package/docs/DocumentControllerApi.md +4 -4
- package/docs/FileControllerApi.md +56 -0
- package/docs/MoveRequest.md +1 -1
- package/docs/Settings.md +2 -0
- package/docs/UnzipRequest.md +26 -0
- package/docs/UnzipResponse.md +28 -0
- package/docs/UnzipSkippedEntry.md +24 -0
- package/models/audit-log.ts +1 -0
- package/models/copy-request.ts +1 -1
- package/models/index.ts +3 -0
- package/models/move-request.ts +1 -1
- package/models/search-by-audit-log-request.ts +1 -0
- package/models/settings.ts +1 -0
- package/models/unzip-request.ts +35 -0
- package/models/unzip-response.ts +42 -0
- package/models/unzip-skipped-entry.ts +43 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -161,6 +161,9 @@ docs/TusConfigResponse.md
|
|
|
161
161
|
docs/TusControllerApi.md
|
|
162
162
|
docs/TusFinalizeRequest.md
|
|
163
163
|
docs/TusUploadInfo.md
|
|
164
|
+
docs/UnzipRequest.md
|
|
165
|
+
docs/UnzipResponse.md
|
|
166
|
+
docs/UnzipSkippedEntry.md
|
|
164
167
|
docs/UpdateMetadataAudit.md
|
|
165
168
|
docs/UpdateMetadataRequest.md
|
|
166
169
|
docs/UploadAudit.md
|
|
@@ -303,6 +306,9 @@ models/suggest.ts
|
|
|
303
306
|
models/tus-config-response.ts
|
|
304
307
|
models/tus-finalize-request.ts
|
|
305
308
|
models/tus-upload-info.ts
|
|
309
|
+
models/unzip-request.ts
|
|
310
|
+
models/unzip-response.ts
|
|
311
|
+
models/unzip-skipped-entry.ts
|
|
306
312
|
models/update-metadata-audit.ts
|
|
307
313
|
models/update-metadata-request.ts
|
|
308
314
|
models/upload-audit.ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
7093094b031f72fc66eab5911a4f6dc70f3493ccc03355fb6870046407a1badd
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @openfilz-sdk/typescript@1.3.
|
|
1
|
+
## @openfilz-sdk/typescript@1.3.25
|
|
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.25 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -127,6 +127,7 @@ Class | Method | HTTP request | Description
|
|
|
127
127
|
*FileControllerApi* | [**deleteFiles**](docs/FileControllerApi.md#deletefiles) | **DELETE** /api/v1/files | Delete files
|
|
128
128
|
*FileControllerApi* | [**moveFiles**](docs/FileControllerApi.md#movefiles) | **POST** /api/v1/files/move | Move files
|
|
129
129
|
*FileControllerApi* | [**renameFile**](docs/FileControllerApi.md#renamefile) | **PUT** /api/v1/files/{fileId}/rename | Rename a file
|
|
130
|
+
*FileControllerApi* | [**unzipFile**](docs/FileControllerApi.md#unzipfile) | **POST** /api/v1/files/{fileId}/unzip | Extract a ZIP file
|
|
130
131
|
*FolderControllerApi* | [**copyFolders**](docs/FolderControllerApi.md#copyfolders) | **POST** /api/v1/folders/copy | Copy folders
|
|
131
132
|
*FolderControllerApi* | [**countFolderElements**](docs/FolderControllerApi.md#countfolderelements) | **GET** /api/v1/folders/count | Count files and subfolders contained in a given folder - return 0 if empty or not exists
|
|
132
133
|
*FolderControllerApi* | [**createFolder**](docs/FolderControllerApi.md#createfolder) | **POST** /api/v1/folders | Create a new folder
|
|
@@ -293,6 +294,9 @@ Class | Method | HTTP request | Description
|
|
|
293
294
|
- [TusConfigResponse](docs/TusConfigResponse.md)
|
|
294
295
|
- [TusFinalizeRequest](docs/TusFinalizeRequest.md)
|
|
295
296
|
- [TusUploadInfo](docs/TusUploadInfo.md)
|
|
297
|
+
- [UnzipRequest](docs/UnzipRequest.md)
|
|
298
|
+
- [UnzipResponse](docs/UnzipResponse.md)
|
|
299
|
+
- [UnzipSkippedEntry](docs/UnzipSkippedEntry.md)
|
|
296
300
|
- [UpdateMetadataAudit](docs/UpdateMetadataAudit.md)
|
|
297
301
|
- [UpdateMetadataRequest](docs/UpdateMetadataRequest.md)
|
|
298
302
|
- [UploadAudit](docs/UploadAudit.md)
|
|
@@ -641,7 +641,7 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration?:
|
|
|
641
641
|
* Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
|
|
642
642
|
* @summary Upload multiple documents
|
|
643
643
|
* @param {Array<File>} file
|
|
644
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
644
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
645
645
|
* @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.
|
|
646
646
|
* @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>
|
|
647
647
|
* @param {*} [options] Override http request option.
|
|
@@ -702,7 +702,7 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration?:
|
|
|
702
702
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
703
703
|
* @summary Upload a single document
|
|
704
704
|
* @param {File} file
|
|
705
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
705
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
706
706
|
* @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.
|
|
707
707
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
708
708
|
* @param {string} [metadata]
|
|
@@ -967,7 +967,7 @@ export const DocumentControllerApiFp = function(configuration?: Configuration) {
|
|
|
967
967
|
* Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
|
|
968
968
|
* @summary Upload multiple documents
|
|
969
969
|
* @param {Array<File>} file
|
|
970
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
970
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
971
971
|
* @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.
|
|
972
972
|
* @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>
|
|
973
973
|
* @param {*} [options] Override http request option.
|
|
@@ -983,7 +983,7 @@ export const DocumentControllerApiFp = function(configuration?: Configuration) {
|
|
|
983
983
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
984
984
|
* @summary Upload a single document
|
|
985
985
|
* @param {File} file
|
|
986
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
986
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
987
987
|
* @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.
|
|
988
988
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
989
989
|
* @param {string} [metadata]
|
|
@@ -1159,7 +1159,7 @@ export const DocumentControllerApiFactory = function (configuration?: Configurat
|
|
|
1159
1159
|
* Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
|
|
1160
1160
|
* @summary Upload multiple documents
|
|
1161
1161
|
* @param {Array<File>} file
|
|
1162
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
1162
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
1163
1163
|
* @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.
|
|
1164
1164
|
* @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>
|
|
1165
1165
|
* @param {*} [options] Override http request option.
|
|
@@ -1172,7 +1172,7 @@ export const DocumentControllerApiFactory = function (configuration?: Configurat
|
|
|
1172
1172
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
1173
1173
|
* @summary Upload a single document
|
|
1174
1174
|
* @param {File} file
|
|
1175
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
1175
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
1176
1176
|
* @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.
|
|
1177
1177
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
1178
1178
|
* @param {string} [metadata]
|
|
@@ -1357,7 +1357,7 @@ export class DocumentControllerApi extends BaseAPI {
|
|
|
1357
1357
|
* Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
|
|
1358
1358
|
* @summary Upload multiple documents
|
|
1359
1359
|
* @param {Array<File>} file
|
|
1360
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
1360
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
1361
1361
|
* @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.
|
|
1362
1362
|
* @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>
|
|
1363
1363
|
* @param {*} [options] Override http request option.
|
|
@@ -1371,7 +1371,7 @@ export class DocumentControllerApi extends BaseAPI {
|
|
|
1371
1371
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
1372
1372
|
* @summary Upload a single document
|
|
1373
1373
|
* @param {File} file
|
|
1374
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
1374
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
1375
1375
|
* @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.
|
|
1376
1376
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
1377
1377
|
* @param {string} [metadata]
|
|
@@ -33,6 +33,10 @@ import type { ElementInfo } from '../models';
|
|
|
33
33
|
import type { MoveRequest } from '../models';
|
|
34
34
|
// @ts-ignore
|
|
35
35
|
import type { RenameRequest } from '../models';
|
|
36
|
+
// @ts-ignore
|
|
37
|
+
import type { UnzipRequest } from '../models';
|
|
38
|
+
// @ts-ignore
|
|
39
|
+
import type { UnzipResponse } from '../models';
|
|
36
40
|
/**
|
|
37
41
|
* FileControllerApi - axios parameter creator
|
|
38
42
|
*/
|
|
@@ -191,6 +195,47 @@ export const FileControllerApiAxiosParamCreator = function (configuration?: Conf
|
|
|
191
195
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
192
196
|
localVarRequestOptions.data = serializeDataIfNeeded(renameRequest, localVarRequestOptions, configuration)
|
|
193
197
|
|
|
198
|
+
return {
|
|
199
|
+
url: toPathString(localVarUrlObj),
|
|
200
|
+
options: localVarRequestOptions,
|
|
201
|
+
};
|
|
202
|
+
},
|
|
203
|
+
/**
|
|
204
|
+
* Extracts a ZIP document server-side, recreating its folder tree. Destination: the root when targetRoot is true, else targetFolderId, else the folder containing the ZIP; with newFolderName, a new folder of that name is created there first. Folders that already exist are merged; files whose name already exists are skipped (unless allowDuplicateFileNames) and listed in the response, like any entry that could not be extracted. Archive-wide limits answer 413 (ZIP_TOO_MANY_ENTRIES, ZIP_TOO_LARGE, ZIP_BOMB); a document that is not a readable ZIP answers 422 (NOT_A_ZIP, ZIP_INVALID).
|
|
205
|
+
* @summary Extract a ZIP file
|
|
206
|
+
* @param {string} fileId Id of the ZIP document
|
|
207
|
+
* @param {UnzipRequest} [unzipRequest]
|
|
208
|
+
* @param {*} [options] Override http request option.
|
|
209
|
+
* @throws {RequiredError}
|
|
210
|
+
*/
|
|
211
|
+
unzipFile: async (fileId: string, unzipRequest?: UnzipRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
212
|
+
// verify required parameter 'fileId' is not null or undefined
|
|
213
|
+
assertParamExists('unzipFile', 'fileId', fileId)
|
|
214
|
+
const localVarPath = `/api/v1/files/{fileId}/unzip`
|
|
215
|
+
.replace('{fileId}', encodeURIComponent(String(fileId)));
|
|
216
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
217
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
218
|
+
let baseOptions;
|
|
219
|
+
if (configuration) {
|
|
220
|
+
baseOptions = configuration.baseOptions;
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
224
|
+
const localVarHeaderParameter = {} as any;
|
|
225
|
+
const localVarQueryParameter = {} as any;
|
|
226
|
+
|
|
227
|
+
// authentication keycloak_auth required
|
|
228
|
+
// http bearer authentication required
|
|
229
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
230
|
+
|
|
231
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
232
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
233
|
+
|
|
234
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
235
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
236
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
237
|
+
localVarRequestOptions.data = serializeDataIfNeeded(unzipRequest, localVarRequestOptions, configuration)
|
|
238
|
+
|
|
194
239
|
return {
|
|
195
240
|
url: toPathString(localVarUrlObj),
|
|
196
241
|
options: localVarRequestOptions,
|
|
@@ -258,6 +303,20 @@ export const FileControllerApiFp = function(configuration?: Configuration) {
|
|
|
258
303
|
const localVarOperationServerBasePath = operationServerMap['FileControllerApi.renameFile']?.[localVarOperationServerIndex]?.url;
|
|
259
304
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
260
305
|
},
|
|
306
|
+
/**
|
|
307
|
+
* Extracts a ZIP document server-side, recreating its folder tree. Destination: the root when targetRoot is true, else targetFolderId, else the folder containing the ZIP; with newFolderName, a new folder of that name is created there first. Folders that already exist are merged; files whose name already exists are skipped (unless allowDuplicateFileNames) and listed in the response, like any entry that could not be extracted. Archive-wide limits answer 413 (ZIP_TOO_MANY_ENTRIES, ZIP_TOO_LARGE, ZIP_BOMB); a document that is not a readable ZIP answers 422 (NOT_A_ZIP, ZIP_INVALID).
|
|
308
|
+
* @summary Extract a ZIP file
|
|
309
|
+
* @param {string} fileId Id of the ZIP document
|
|
310
|
+
* @param {UnzipRequest} [unzipRequest]
|
|
311
|
+
* @param {*} [options] Override http request option.
|
|
312
|
+
* @throws {RequiredError}
|
|
313
|
+
*/
|
|
314
|
+
async unzipFile(fileId: string, unzipRequest?: UnzipRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnzipResponse>> {
|
|
315
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.unzipFile(fileId, unzipRequest, options);
|
|
316
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
317
|
+
const localVarOperationServerBasePath = operationServerMap['FileControllerApi.unzipFile']?.[localVarOperationServerIndex]?.url;
|
|
318
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
319
|
+
},
|
|
261
320
|
}
|
|
262
321
|
};
|
|
263
322
|
|
|
@@ -308,6 +367,17 @@ export const FileControllerApiFactory = function (configuration?: Configuration,
|
|
|
308
367
|
renameFile(fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): AxiosPromise<ElementInfo> {
|
|
309
368
|
return localVarFp.renameFile(fileId, renameRequest, options).then((request) => request(axios, basePath));
|
|
310
369
|
},
|
|
370
|
+
/**
|
|
371
|
+
* Extracts a ZIP document server-side, recreating its folder tree. Destination: the root when targetRoot is true, else targetFolderId, else the folder containing the ZIP; with newFolderName, a new folder of that name is created there first. Folders that already exist are merged; files whose name already exists are skipped (unless allowDuplicateFileNames) and listed in the response, like any entry that could not be extracted. Archive-wide limits answer 413 (ZIP_TOO_MANY_ENTRIES, ZIP_TOO_LARGE, ZIP_BOMB); a document that is not a readable ZIP answers 422 (NOT_A_ZIP, ZIP_INVALID).
|
|
372
|
+
* @summary Extract a ZIP file
|
|
373
|
+
* @param {string} fileId Id of the ZIP document
|
|
374
|
+
* @param {UnzipRequest} [unzipRequest]
|
|
375
|
+
* @param {*} [options] Override http request option.
|
|
376
|
+
* @throws {RequiredError}
|
|
377
|
+
*/
|
|
378
|
+
unzipFile(fileId: string, unzipRequest?: UnzipRequest, options?: RawAxiosRequestConfig): AxiosPromise<UnzipResponse> {
|
|
379
|
+
return localVarFp.unzipFile(fileId, unzipRequest, options).then((request) => request(axios, basePath));
|
|
380
|
+
},
|
|
311
381
|
};
|
|
312
382
|
};
|
|
313
383
|
|
|
@@ -359,5 +429,17 @@ export class FileControllerApi extends BaseAPI {
|
|
|
359
429
|
public renameFile(fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig) {
|
|
360
430
|
return FileControllerApiFp(this.configuration).renameFile(fileId, renameRequest, options).then((request) => request(this.axios, this.basePath));
|
|
361
431
|
}
|
|
432
|
+
|
|
433
|
+
/**
|
|
434
|
+
* Extracts a ZIP document server-side, recreating its folder tree. Destination: the root when targetRoot is true, else targetFolderId, else the folder containing the ZIP; with newFolderName, a new folder of that name is created there first. Folders that already exist are merged; files whose name already exists are skipped (unless allowDuplicateFileNames) and listed in the response, like any entry that could not be extracted. Archive-wide limits answer 413 (ZIP_TOO_MANY_ENTRIES, ZIP_TOO_LARGE, ZIP_BOMB); a document that is not a readable ZIP answers 422 (NOT_A_ZIP, ZIP_INVALID).
|
|
435
|
+
* @summary Extract a ZIP file
|
|
436
|
+
* @param {string} fileId Id of the ZIP document
|
|
437
|
+
* @param {UnzipRequest} [unzipRequest]
|
|
438
|
+
* @param {*} [options] Override http request option.
|
|
439
|
+
* @throws {RequiredError}
|
|
440
|
+
*/
|
|
441
|
+
public unzipFile(fileId: string, unzipRequest?: UnzipRequest, options?: RawAxiosRequestConfig) {
|
|
442
|
+
return FileControllerApiFp(this.configuration).unzipFile(fileId, unzipRequest, options).then((request) => request(this.axios, this.basePath));
|
|
443
|
+
}
|
|
362
444
|
}
|
|
363
445
|
|
|
@@ -155,7 +155,7 @@ export declare const DocumentControllerApiAxiosParamCreator: (configuration?: Co
|
|
|
155
155
|
* Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
|
|
156
156
|
* @summary Upload multiple documents
|
|
157
157
|
* @param {Array<File>} file
|
|
158
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
158
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
159
159
|
* @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.
|
|
160
160
|
* @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>
|
|
161
161
|
* @param {*} [options] Override http request option.
|
|
@@ -166,7 +166,7 @@ export declare const DocumentControllerApiAxiosParamCreator: (configuration?: Co
|
|
|
166
166
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
167
167
|
* @summary Upload a single document
|
|
168
168
|
* @param {File} file
|
|
169
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
169
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
170
170
|
* @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.
|
|
171
171
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
172
172
|
* @param {string} [metadata]
|
|
@@ -309,7 +309,7 @@ export declare const DocumentControllerApiFp: (configuration?: Configuration) =>
|
|
|
309
309
|
* Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
|
|
310
310
|
* @summary Upload multiple documents
|
|
311
311
|
* @param {Array<File>} file
|
|
312
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
312
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
313
313
|
* @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.
|
|
314
314
|
* @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>
|
|
315
315
|
* @param {*} [options] Override http request option.
|
|
@@ -320,7 +320,7 @@ export declare const DocumentControllerApiFp: (configuration?: Configuration) =>
|
|
|
320
320
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
321
321
|
* @summary Upload a single document
|
|
322
322
|
* @param {File} file
|
|
323
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
323
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
324
324
|
* @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.
|
|
325
325
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
326
326
|
* @param {string} [metadata]
|
|
@@ -463,7 +463,7 @@ export declare const DocumentControllerApiFactory: (configuration?: Configuratio
|
|
|
463
463
|
* Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
|
|
464
464
|
* @summary Upload multiple documents
|
|
465
465
|
* @param {Array<File>} file
|
|
466
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
466
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
467
467
|
* @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.
|
|
468
468
|
* @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>
|
|
469
469
|
* @param {*} [options] Override http request option.
|
|
@@ -474,7 +474,7 @@ export declare const DocumentControllerApiFactory: (configuration?: Configuratio
|
|
|
474
474
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
475
475
|
* @summary Upload a single document
|
|
476
476
|
* @param {File} file
|
|
477
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
477
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
478
478
|
* @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.
|
|
479
479
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
480
480
|
* @param {string} [metadata]
|
|
@@ -617,7 +617,7 @@ export declare class DocumentControllerApi extends BaseAPI {
|
|
|
617
617
|
* Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
|
|
618
618
|
* @summary Upload multiple documents
|
|
619
619
|
* @param {Array<File>} file
|
|
620
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
620
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
621
621
|
* @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.
|
|
622
622
|
* @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>
|
|
623
623
|
* @param {*} [options] Override http request option.
|
|
@@ -628,7 +628,7 @@ export declare class DocumentControllerApi extends BaseAPI {
|
|
|
628
628
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
629
629
|
* @summary Upload a single document
|
|
630
630
|
* @param {File} file
|
|
631
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
631
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
632
632
|
* @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.
|
|
633
633
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
634
634
|
* @param {string} [metadata]
|
|
@@ -551,7 +551,7 @@ const DocumentControllerApiAxiosParamCreator = function (configuration) {
|
|
|
551
551
|
* Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
|
|
552
552
|
* @summary Upload multiple documents
|
|
553
553
|
* @param {Array<File>} file
|
|
554
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
554
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
555
555
|
* @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.
|
|
556
556
|
* @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>
|
|
557
557
|
* @param {*} [options] Override http request option.
|
|
@@ -603,7 +603,7 @@ const DocumentControllerApiAxiosParamCreator = function (configuration) {
|
|
|
603
603
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
604
604
|
* @summary Upload a single document
|
|
605
605
|
* @param {File} file
|
|
606
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
606
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
607
607
|
* @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.
|
|
608
608
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
609
609
|
* @param {string} [metadata]
|
|
@@ -900,7 +900,7 @@ const DocumentControllerApiFp = function (configuration) {
|
|
|
900
900
|
* Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
|
|
901
901
|
* @summary Upload multiple documents
|
|
902
902
|
* @param {Array<File>} file
|
|
903
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
903
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
904
904
|
* @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.
|
|
905
905
|
* @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>
|
|
906
906
|
* @param {*} [options] Override http request option.
|
|
@@ -919,7 +919,7 @@ const DocumentControllerApiFp = function (configuration) {
|
|
|
919
919
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
920
920
|
* @summary Upload a single document
|
|
921
921
|
* @param {File} file
|
|
922
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
922
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
923
923
|
* @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.
|
|
924
924
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
925
925
|
* @param {string} [metadata]
|
|
@@ -1098,7 +1098,7 @@ const DocumentControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
1098
1098
|
* Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
|
|
1099
1099
|
* @summary Upload multiple documents
|
|
1100
1100
|
* @param {Array<File>} file
|
|
1101
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
1101
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
1102
1102
|
* @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.
|
|
1103
1103
|
* @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>
|
|
1104
1104
|
* @param {*} [options] Override http request option.
|
|
@@ -1111,7 +1111,7 @@ const DocumentControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
1111
1111
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
1112
1112
|
* @summary Upload a single document
|
|
1113
1113
|
* @param {File} file
|
|
1114
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
1114
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
1115
1115
|
* @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.
|
|
1116
1116
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
1117
1117
|
* @param {string} [metadata]
|
|
@@ -1282,7 +1282,7 @@ class DocumentControllerApi extends base_1.BaseAPI {
|
|
|
1282
1282
|
* Uploads multiple files, optionally with metadata and a parent folder ID. Returns HTTP 200 if all uploads succeed, HTTP 207 (Multi-Status) if some succeed and some fail, or an appropriate error status (404, 409, 403, 500) if all uploads fail.
|
|
1283
1283
|
* @summary Upload multiple documents
|
|
1284
1284
|
* @param {Array<File>} file
|
|
1285
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
1285
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
1286
1286
|
* @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.
|
|
1287
1287
|
* @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>
|
|
1288
1288
|
* @param {*} [options] Override http request option.
|
|
@@ -1295,7 +1295,7 @@ class DocumentControllerApi extends base_1.BaseAPI {
|
|
|
1295
1295
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
1296
1296
|
* @summary Upload a single document
|
|
1297
1297
|
* @param {File} file
|
|
1298
|
-
* @param {boolean} [allowDuplicateFileNames]
|
|
1298
|
+
* @param {boolean} [allowDuplicateFileNames] When true, the file is stored even if a document of the same name already exists in the target folder (nothing is overwritten). When false (default), a 409 is returned.
|
|
1299
1299
|
* @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.
|
|
1300
1300
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
1301
1301
|
* @param {string} [metadata]
|
|
@@ -18,6 +18,8 @@ import type { DeleteRequest } from '../models';
|
|
|
18
18
|
import type { ElementInfo } from '../models';
|
|
19
19
|
import type { MoveRequest } from '../models';
|
|
20
20
|
import type { RenameRequest } from '../models';
|
|
21
|
+
import type { UnzipRequest } from '../models';
|
|
22
|
+
import type { UnzipResponse } from '../models';
|
|
21
23
|
/**
|
|
22
24
|
* FileControllerApi - axios parameter creator
|
|
23
25
|
*/
|
|
@@ -55,6 +57,15 @@ export declare const FileControllerApiAxiosParamCreator: (configuration?: Config
|
|
|
55
57
|
* @throws {RequiredError}
|
|
56
58
|
*/
|
|
57
59
|
renameFile: (fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
|
+
/**
|
|
61
|
+
* Extracts a ZIP document server-side, recreating its folder tree. Destination: the root when targetRoot is true, else targetFolderId, else the folder containing the ZIP; with newFolderName, a new folder of that name is created there first. Folders that already exist are merged; files whose name already exists are skipped (unless allowDuplicateFileNames) and listed in the response, like any entry that could not be extracted. Archive-wide limits answer 413 (ZIP_TOO_MANY_ENTRIES, ZIP_TOO_LARGE, ZIP_BOMB); a document that is not a readable ZIP answers 422 (NOT_A_ZIP, ZIP_INVALID).
|
|
62
|
+
* @summary Extract a ZIP file
|
|
63
|
+
* @param {string} fileId Id of the ZIP document
|
|
64
|
+
* @param {UnzipRequest} [unzipRequest]
|
|
65
|
+
* @param {*} [options] Override http request option.
|
|
66
|
+
* @throws {RequiredError}
|
|
67
|
+
*/
|
|
68
|
+
unzipFile: (fileId: string, unzipRequest?: UnzipRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
69
|
};
|
|
59
70
|
/**
|
|
60
71
|
* FileControllerApi - functional programming interface
|
|
@@ -93,6 +104,15 @@ export declare const FileControllerApiFp: (configuration?: Configuration) => {
|
|
|
93
104
|
* @throws {RequiredError}
|
|
94
105
|
*/
|
|
95
106
|
renameFile(fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ElementInfo>>;
|
|
107
|
+
/**
|
|
108
|
+
* Extracts a ZIP document server-side, recreating its folder tree. Destination: the root when targetRoot is true, else targetFolderId, else the folder containing the ZIP; with newFolderName, a new folder of that name is created there first. Folders that already exist are merged; files whose name already exists are skipped (unless allowDuplicateFileNames) and listed in the response, like any entry that could not be extracted. Archive-wide limits answer 413 (ZIP_TOO_MANY_ENTRIES, ZIP_TOO_LARGE, ZIP_BOMB); a document that is not a readable ZIP answers 422 (NOT_A_ZIP, ZIP_INVALID).
|
|
109
|
+
* @summary Extract a ZIP file
|
|
110
|
+
* @param {string} fileId Id of the ZIP document
|
|
111
|
+
* @param {UnzipRequest} [unzipRequest]
|
|
112
|
+
* @param {*} [options] Override http request option.
|
|
113
|
+
* @throws {RequiredError}
|
|
114
|
+
*/
|
|
115
|
+
unzipFile(fileId: string, unzipRequest?: UnzipRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnzipResponse>>;
|
|
96
116
|
};
|
|
97
117
|
/**
|
|
98
118
|
* FileControllerApi - factory interface
|
|
@@ -131,6 +151,15 @@ export declare const FileControllerApiFactory: (configuration?: Configuration, b
|
|
|
131
151
|
* @throws {RequiredError}
|
|
132
152
|
*/
|
|
133
153
|
renameFile(fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): AxiosPromise<ElementInfo>;
|
|
154
|
+
/**
|
|
155
|
+
* Extracts a ZIP document server-side, recreating its folder tree. Destination: the root when targetRoot is true, else targetFolderId, else the folder containing the ZIP; with newFolderName, a new folder of that name is created there first. Folders that already exist are merged; files whose name already exists are skipped (unless allowDuplicateFileNames) and listed in the response, like any entry that could not be extracted. Archive-wide limits answer 413 (ZIP_TOO_MANY_ENTRIES, ZIP_TOO_LARGE, ZIP_BOMB); a document that is not a readable ZIP answers 422 (NOT_A_ZIP, ZIP_INVALID).
|
|
156
|
+
* @summary Extract a ZIP file
|
|
157
|
+
* @param {string} fileId Id of the ZIP document
|
|
158
|
+
* @param {UnzipRequest} [unzipRequest]
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
*/
|
|
162
|
+
unzipFile(fileId: string, unzipRequest?: UnzipRequest, options?: RawAxiosRequestConfig): AxiosPromise<UnzipResponse>;
|
|
134
163
|
};
|
|
135
164
|
/**
|
|
136
165
|
* FileControllerApi - object-oriented interface
|
|
@@ -169,4 +198,13 @@ export declare class FileControllerApi extends BaseAPI {
|
|
|
169
198
|
* @throws {RequiredError}
|
|
170
199
|
*/
|
|
171
200
|
renameFile(fileId: string, renameRequest: RenameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ElementInfo, any, {}>>;
|
|
201
|
+
/**
|
|
202
|
+
* Extracts a ZIP document server-side, recreating its folder tree. Destination: the root when targetRoot is true, else targetFolderId, else the folder containing the ZIP; with newFolderName, a new folder of that name is created there first. Folders that already exist are merged; files whose name already exists are skipped (unless allowDuplicateFileNames) and listed in the response, like any entry that could not be extracted. Archive-wide limits answer 413 (ZIP_TOO_MANY_ENTRIES, ZIP_TOO_LARGE, ZIP_BOMB); a document that is not a readable ZIP answers 422 (NOT_A_ZIP, ZIP_INVALID).
|
|
203
|
+
* @summary Extract a ZIP file
|
|
204
|
+
* @param {string} fileId Id of the ZIP document
|
|
205
|
+
* @param {UnzipRequest} [unzipRequest]
|
|
206
|
+
* @param {*} [options] Override http request option.
|
|
207
|
+
* @throws {RequiredError}
|
|
208
|
+
*/
|
|
209
|
+
unzipFile(fileId: string, unzipRequest?: UnzipRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UnzipResponse, any, {}>>;
|
|
172
210
|
}
|