@openfilz-sdk/typescript 1.3.24 → 1.3.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +6 -2
  4. package/api/document-controller-api.ts +8 -8
  5. package/api/file-controller-api.ts +82 -0
  6. package/dist/api/document-controller-api.d.ts +8 -8
  7. package/dist/api/document-controller-api.js +8 -8
  8. package/dist/api/file-controller-api.d.ts +38 -0
  9. package/dist/api/file-controller-api.js +75 -0
  10. package/dist/esm/api/document-controller-api.d.ts +8 -8
  11. package/dist/esm/api/document-controller-api.js +8 -8
  12. package/dist/esm/api/file-controller-api.d.ts +38 -0
  13. package/dist/esm/api/file-controller-api.js +75 -0
  14. package/dist/esm/models/audit-log.d.ts +1 -0
  15. package/dist/esm/models/audit-log.js +1 -0
  16. package/dist/esm/models/copy-request.d.ts +1 -1
  17. package/dist/esm/models/index.d.ts +3 -0
  18. package/dist/esm/models/index.js +3 -0
  19. package/dist/esm/models/move-request.d.ts +1 -1
  20. package/dist/esm/models/search-by-audit-log-request.d.ts +1 -0
  21. package/dist/esm/models/search-by-audit-log-request.js +1 -0
  22. package/dist/esm/models/settings.d.ts +3 -0
  23. package/dist/esm/models/unzip-request.d.ts +29 -0
  24. package/dist/esm/models/unzip-request.js +14 -0
  25. package/dist/esm/models/unzip-response.d.ts +34 -0
  26. package/dist/esm/models/unzip-response.js +14 -0
  27. package/dist/esm/models/unzip-skipped-entry.d.ts +34 -0
  28. package/dist/esm/models/unzip-skipped-entry.js +21 -0
  29. package/dist/models/audit-log.d.ts +1 -0
  30. package/dist/models/audit-log.js +1 -0
  31. package/dist/models/copy-request.d.ts +1 -1
  32. package/dist/models/index.d.ts +3 -0
  33. package/dist/models/index.js +3 -0
  34. package/dist/models/move-request.d.ts +1 -1
  35. package/dist/models/search-by-audit-log-request.d.ts +1 -0
  36. package/dist/models/search-by-audit-log-request.js +1 -0
  37. package/dist/models/settings.d.ts +3 -0
  38. package/dist/models/unzip-request.d.ts +29 -0
  39. package/dist/models/unzip-request.js +15 -0
  40. package/dist/models/unzip-response.d.ts +34 -0
  41. package/dist/models/unzip-response.js +15 -0
  42. package/dist/models/unzip-skipped-entry.d.ts +34 -0
  43. package/dist/models/unzip-skipped-entry.js +24 -0
  44. package/docs/CopyRequest.md +1 -1
  45. package/docs/DocumentControllerApi.md +4 -4
  46. package/docs/FileControllerApi.md +56 -0
  47. package/docs/MoveRequest.md +1 -1
  48. package/docs/Settings.md +2 -0
  49. package/docs/UnzipRequest.md +26 -0
  50. package/docs/UnzipResponse.md +28 -0
  51. package/docs/UnzipSkippedEntry.md +24 -0
  52. package/graphql/document.graphqls +6 -0
  53. package/models/audit-log.ts +1 -0
  54. package/models/copy-request.ts +1 -1
  55. package/models/index.ts +3 -0
  56. package/models/move-request.ts +1 -1
  57. package/models/search-by-audit-log-request.ts +1 -0
  58. package/models/settings.ts +1 -0
  59. package/models/unzip-request.ts +35 -0
  60. package/models/unzip-response.ts +42 -0
  61. package/models/unzip-skipped-entry.ts +43 -0
  62. package/package.json +1 -1
@@ -0,0 +1,29 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface UnzipRequest {
13
+ /**
14
+ * Folder to extract into. Omitted (and targetRoot not set): the folder containing the ZIP.
15
+ */
16
+ 'targetFolderId'?: string;
17
+ /**
18
+ * Extract at the root, whatever targetFolderId says.
19
+ */
20
+ 'targetRoot'?: boolean;
21
+ /**
22
+ * Create a folder of this name in the destination and extract into it.
23
+ */
24
+ 'newFolderName'?: string;
25
+ /**
26
+ * When true, files are extracted even if a document of the same name already exists in their destination folder. When false (default), such entries are skipped and listed in the response. Existing folders are always merged.
27
+ */
28
+ 'allowDuplicateFileNames'?: boolean;
29
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,34 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { UnzipSkippedEntry } from './unzip-skipped-entry';
13
+ export interface UnzipResponse {
14
+ /**
15
+ * Folder the archive was extracted into (null = root).
16
+ */
17
+ 'targetFolderId'?: string;
18
+ /**
19
+ * Id of the folder created from newFolderName, if any.
20
+ */
21
+ 'createdFolderId'?: string;
22
+ /**
23
+ * Number of folders created.
24
+ */
25
+ 'foldersCreated'?: number;
26
+ /**
27
+ * Number of files extracted.
28
+ */
29
+ 'filesExtracted'?: number;
30
+ /**
31
+ * Entries that were not extracted, with the reason.
32
+ */
33
+ 'skipped'?: Array<UnzipSkippedEntry>;
34
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,34 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface UnzipSkippedEntry {
13
+ /**
14
+ * Path of the entry inside the archive.
15
+ */
16
+ 'path'?: string;
17
+ /**
18
+ * Why it was skipped.
19
+ */
20
+ 'reason'?: UnzipSkippedEntryReasonEnum;
21
+ /**
22
+ * Details, when available.
23
+ */
24
+ 'message'?: string;
25
+ }
26
+ export declare const UnzipSkippedEntryReasonEnum: {
27
+ readonly DuplicateName: "DUPLICATE_NAME";
28
+ readonly UnsafePath: "UNSAFE_PATH";
29
+ readonly Unsupported: "UNSUPPORTED";
30
+ readonly FileTooLarge: "FILE_TOO_LARGE";
31
+ readonly ParentNotCreated: "PARENT_NOT_CREATED";
32
+ readonly Error: "ERROR";
33
+ };
34
+ export type UnzipSkippedEntryReasonEnum = typeof UnzipSkippedEntryReasonEnum[keyof typeof UnzipSkippedEntryReasonEnum];
@@ -0,0 +1,21 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export const UnzipSkippedEntryReasonEnum = {
15
+ DuplicateName: 'DUPLICATE_NAME',
16
+ UnsafePath: 'UNSAFE_PATH',
17
+ Unsupported: 'UNSUPPORTED',
18
+ FileTooLarge: 'FILE_TOO_LARGE',
19
+ ParentNotCreated: 'PARENT_NOT_CREATED',
20
+ Error: 'ERROR',
21
+ };
@@ -41,6 +41,7 @@ export declare const AuditLogActionEnum: {
41
41
  readonly ReplaceDocumentMetadata: "REPLACE_DOCUMENT_METADATA";
42
42
  readonly UpdateDocumentMetadata: "UPDATE_DOCUMENT_METADATA";
43
43
  readonly DownloadDocument: "DOWNLOAD_DOCUMENT";
44
+ readonly OpenDocument: "OPEN_DOCUMENT";
44
45
  readonly DeleteDocumentMetadata: "DELETE_DOCUMENT_METADATA";
45
46
  readonly RestoreFile: "RESTORE_FILE";
46
47
  readonly RestoreFolder: "RESTORE_FOLDER";
@@ -32,6 +32,7 @@ exports.AuditLogActionEnum = {
32
32
  ReplaceDocumentMetadata: 'REPLACE_DOCUMENT_METADATA',
33
33
  UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
34
34
  DownloadDocument: 'DOWNLOAD_DOCUMENT',
35
+ OpenDocument: 'OPEN_DOCUMENT',
35
36
  DeleteDocumentMetadata: 'DELETE_DOCUMENT_METADATA',
36
37
  RestoreFile: 'RESTORE_FILE',
37
38
  RestoreFolder: 'RESTORE_FOLDER',
@@ -19,7 +19,7 @@ export interface CopyRequest {
19
19
  */
20
20
  'targetFolderId'?: string;
21
21
  /**
22
- * 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)
22
+ * 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.
23
23
  */
24
24
  'allowDuplicateFileNames'?: boolean;
25
25
  }
@@ -112,6 +112,9 @@ export * from './suggest';
112
112
  export * from './tus-config-response';
113
113
  export * from './tus-finalize-request';
114
114
  export * from './tus-upload-info';
115
+ export * from './unzip-request';
116
+ export * from './unzip-response';
117
+ export * from './unzip-skipped-entry';
115
118
  export * from './update-metadata-audit';
116
119
  export * from './update-metadata-request';
117
120
  export * from './upload-audit';
@@ -128,6 +128,9 @@ __exportStar(require("./suggest"), exports);
128
128
  __exportStar(require("./tus-config-response"), exports);
129
129
  __exportStar(require("./tus-finalize-request"), exports);
130
130
  __exportStar(require("./tus-upload-info"), exports);
131
+ __exportStar(require("./unzip-request"), exports);
132
+ __exportStar(require("./unzip-response"), exports);
133
+ __exportStar(require("./unzip-skipped-entry"), exports);
131
134
  __exportStar(require("./update-metadata-audit"), exports);
132
135
  __exportStar(require("./update-metadata-request"), exports);
133
136
  __exportStar(require("./upload-audit"), exports);
@@ -19,7 +19,7 @@ export interface MoveRequest {
19
19
  */
20
20
  'targetFolderId'?: string;
21
21
  /**
22
- * 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)
22
+ * 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.
23
23
  */
24
24
  'allowDuplicateFileNames'?: boolean;
25
25
  }
@@ -59,6 +59,7 @@ export declare const SearchByAuditLogRequestActionEnum: {
59
59
  readonly ReplaceDocumentMetadata: "REPLACE_DOCUMENT_METADATA";
60
60
  readonly UpdateDocumentMetadata: "UPDATE_DOCUMENT_METADATA";
61
61
  readonly DownloadDocument: "DOWNLOAD_DOCUMENT";
62
+ readonly OpenDocument: "OPEN_DOCUMENT";
62
63
  readonly DeleteDocumentMetadata: "DELETE_DOCUMENT_METADATA";
63
64
  readonly RestoreFile: "RESTORE_FILE";
64
65
  readonly RestoreFolder: "RESTORE_FOLDER";
@@ -36,6 +36,7 @@ exports.SearchByAuditLogRequestActionEnum = {
36
36
  ReplaceDocumentMetadata: 'REPLACE_DOCUMENT_METADATA',
37
37
  UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
38
38
  DownloadDocument: 'DOWNLOAD_DOCUMENT',
39
+ OpenDocument: 'OPEN_DOCUMENT',
39
40
  DeleteDocumentMetadata: 'DELETE_DOCUMENT_METADATA',
40
41
  RestoreFile: 'RESTORE_FILE',
41
42
  RestoreFolder: 'RESTORE_FOLDER',
@@ -41,4 +41,7 @@ export interface Settings {
41
41
  'mcpMode'?: string;
42
42
  'mcpAuthorizationServerUrl'?: string;
43
43
  'mcpClientId'?: string;
44
+ 'extensions'?: {
45
+ [key: string]: any;
46
+ };
44
47
  }
@@ -0,0 +1,29 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface UnzipRequest {
13
+ /**
14
+ * Folder to extract into. Omitted (and targetRoot not set): the folder containing the ZIP.
15
+ */
16
+ 'targetFolderId'?: string;
17
+ /**
18
+ * Extract at the root, whatever targetFolderId says.
19
+ */
20
+ 'targetRoot'?: boolean;
21
+ /**
22
+ * Create a folder of this name in the destination and extract into it.
23
+ */
24
+ 'newFolderName'?: string;
25
+ /**
26
+ * When true, files are extracted even if a document of the same name already exists in their destination folder. When false (default), such entries are skipped and listed in the response. Existing folders are always merged.
27
+ */
28
+ 'allowDuplicateFileNames'?: boolean;
29
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,34 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { UnzipSkippedEntry } from './unzip-skipped-entry';
13
+ export interface UnzipResponse {
14
+ /**
15
+ * Folder the archive was extracted into (null = root).
16
+ */
17
+ 'targetFolderId'?: string;
18
+ /**
19
+ * Id of the folder created from newFolderName, if any.
20
+ */
21
+ 'createdFolderId'?: string;
22
+ /**
23
+ * Number of folders created.
24
+ */
25
+ 'foldersCreated'?: number;
26
+ /**
27
+ * Number of files extracted.
28
+ */
29
+ 'filesExtracted'?: number;
30
+ /**
31
+ * Entries that were not extracted, with the reason.
32
+ */
33
+ 'skipped'?: Array<UnzipSkippedEntry>;
34
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,34 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ export interface UnzipSkippedEntry {
13
+ /**
14
+ * Path of the entry inside the archive.
15
+ */
16
+ 'path'?: string;
17
+ /**
18
+ * Why it was skipped.
19
+ */
20
+ 'reason'?: UnzipSkippedEntryReasonEnum;
21
+ /**
22
+ * Details, when available.
23
+ */
24
+ 'message'?: string;
25
+ }
26
+ export declare const UnzipSkippedEntryReasonEnum: {
27
+ readonly DuplicateName: "DUPLICATE_NAME";
28
+ readonly UnsafePath: "UNSAFE_PATH";
29
+ readonly Unsupported: "UNSUPPORTED";
30
+ readonly FileTooLarge: "FILE_TOO_LARGE";
31
+ readonly ParentNotCreated: "PARENT_NOT_CREATED";
32
+ readonly Error: "ERROR";
33
+ };
34
+ export type UnzipSkippedEntryReasonEnum = typeof UnzipSkippedEntryReasonEnum[keyof typeof UnzipSkippedEntryReasonEnum];
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.UnzipSkippedEntryReasonEnum = void 0;
17
+ exports.UnzipSkippedEntryReasonEnum = {
18
+ DuplicateName: 'DUPLICATE_NAME',
19
+ UnsafePath: 'UNSAFE_PATH',
20
+ Unsupported: 'UNSUPPORTED',
21
+ FileTooLarge: 'FILE_TOO_LARGE',
22
+ ParentNotCreated: 'PARENT_NOT_CREATED',
23
+ Error: 'ERROR',
24
+ };
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **documentIds** | **Array&lt;string&gt;** | List of document IDs (files or folders) to copy. | [optional] [default to undefined]
9
9
  **targetFolderId** | **string** | ID of the target folder. | [optional] [default to undefined]
10
- **allowDuplicateFileNames** | **boolean** | 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) | [optional] [default to undefined]
10
+ **allowDuplicateFileNames** | **boolean** | 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. | [optional] [default to undefined]
11
11
 
12
12
  ## Example
13
13
 
@@ -787,7 +787,7 @@ const configuration = new Configuration();
787
787
  const apiInstance = new DocumentControllerApi(configuration);
788
788
 
789
789
  let file: Array<File>; // (default to undefined)
790
- let allowDuplicateFileNames: boolean; //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) (optional) (default to false)
790
+ let allowDuplicateFileNames: boolean; //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. (optional) (default to false)
791
791
  let autoFile: boolean; //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. (optional) (default to undefined)
792
792
  let parametersByFilename: string; //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> (optional) (default to undefined)
793
793
 
@@ -804,7 +804,7 @@ const { status, data } = await apiInstance.uploadDocument(
804
804
  |Name | Type | Description | Notes|
805
805
  |------------- | ------------- | ------------- | -------------|
806
806
  | **file** | **Array&lt;File&gt;** | | defaults to undefined|
807
- | **allowDuplicateFileNames** | [**boolean**] | 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) | (optional) defaults to false|
807
+ | **allowDuplicateFileNames** | [**boolean**] | 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. | (optional) defaults to false|
808
808
  | **autoFile** | [**boolean**] | 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 &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active. | (optional) defaults to undefined|
809
809
  | **parametersByFilename** | [**string**] | Paste the JSON array here&lt;br&gt;This array provides optional metadata and attributes for the uploaded files&lt;br&gt;&lt;section&gt; &lt;h3&gt;Each object in the array must contain:&lt;/h3&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Field&lt;/th&gt; &lt;th&gt;Type&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;filename&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;fileAttributes&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;JSON Object&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Container for metadata and other file-specific attributes.&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;h4&gt;Inside &lt;code&gt;fileAttributes&lt;/code&gt;:&lt;/h4&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Field&lt;/th&gt; &lt;th&gt;Type&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;parentFolderId&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;UUID&lt;/code&gt;&lt;/td&gt; &lt;td&gt;UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;metadata&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;Map&amp;lt;String, JSON Object&amp;gt;&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Arbitrary metadata to associate with the file (key/value pairs).&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;h4&gt;Example of &lt;code&gt;parametersByFilename&lt;/code&gt; JSON array :&lt;/h4&gt; &lt;pre&gt;&lt;code&gt;[ { \\\&quot;filename\\\&quot;: \\\&quot;file1.txt\\\&quot;, \\\&quot;fileAttributes\\\&quot;: { \\\&quot;parentFolderId\\\&quot;: \\\&quot;f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\&quot;, \\\&quot;metadata\\\&quot;: { \\\&quot;country\\\&quot;: \\\&quot;UK\\\&quot;, \\\&quot;owner\\\&quot;: { \\\&quot;name\\\&quot;: \\\&quot;Joe\\\&quot;, \\\&quot;owner_id\\\&quot;: 1234568 } } } }, { \\\&quot;filename\\\&quot;: \\\&quot;file2.md\\\&quot;, \\\&quot;fileAttributes\\\&quot;: { \\\&quot;metadata\\\&quot;: { \\\&quot;key1\\\&quot;: \\\&quot;value1\\\&quot;, \\\&quot;key2\\\&quot;: \\\&quot;value2\\\&quot;, \\\&quot;key3\\\&quot;: \\\&quot;value3\\\&quot; } } } ]&lt;/code&gt;&lt;/pre&gt; &lt;/section&gt; | (optional) defaults to undefined|
810
810
 
@@ -847,7 +847,7 @@ const configuration = new Configuration();
847
847
  const apiInstance = new DocumentControllerApi(configuration);
848
848
 
849
849
  let file: File; // (default to undefined)
850
- let allowDuplicateFileNames: boolean; //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) (optional) (default to false)
850
+ let allowDuplicateFileNames: boolean; //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. (optional) (default to false)
851
851
  let autoFile: boolean; //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. (optional) (default to undefined)
852
852
  let parentFolderId: string; //Target parent folder ID to store the file; if not sent or null, the file is stored at the root level (optional) (default to undefined)
853
853
  let metadata: string; // (optional) (default to undefined)
@@ -866,7 +866,7 @@ const { status, data } = await apiInstance.uploadDocument1(
866
866
  |Name | Type | Description | Notes|
867
867
  |------------- | ------------- | ------------- | -------------|
868
868
  | **file** | [**File**] | | defaults to undefined|
869
- | **allowDuplicateFileNames** | [**boolean**] | 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) | (optional) defaults to false|
869
+ | **allowDuplicateFileNames** | [**boolean**] | 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. | (optional) defaults to false|
870
870
  | **autoFile** | [**boolean**] | 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 &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active. | (optional) defaults to undefined|
871
871
  | **parentFolderId** | [**string**] | Target parent folder ID to store the file; if not sent or null, the file is stored at the root level | (optional) defaults to undefined|
872
872
  | **metadata** | [**string**] | | (optional) defaults to undefined|
@@ -8,6 +8,7 @@ All URIs are relative to *http://localhost:8081*
8
8
  |[**deleteFiles**](#deletefiles) | **DELETE** /api/v1/files | Delete files|
9
9
  |[**moveFiles**](#movefiles) | **POST** /api/v1/files/move | Move files|
10
10
  |[**renameFile**](#renamefile) | **PUT** /api/v1/files/{fileId}/rename | Rename a file|
11
+ |[**unzipFile**](#unzipfile) | **POST** /api/v1/files/{fileId}/unzip | Extract a ZIP file|
11
12
 
12
13
  # **copyFiles**
13
14
  > Array<CopyResponse> copyFiles(copyRequest)
@@ -220,3 +221,58 @@ const { status, data } = await apiInstance.renameFile(
220
221
 
221
222
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
222
223
 
224
+ # **unzipFile**
225
+ > UnzipResponse unzipFile()
226
+
227
+ 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).
228
+
229
+ ### Example
230
+
231
+ ```typescript
232
+ import {
233
+ FileControllerApi,
234
+ Configuration,
235
+ UnzipRequest
236
+ } from '@openfilz-sdk/typescript';
237
+
238
+ const configuration = new Configuration();
239
+ const apiInstance = new FileControllerApi(configuration);
240
+
241
+ let fileId: string; //Id of the ZIP document (default to undefined)
242
+ let unzipRequest: UnzipRequest; // (optional)
243
+
244
+ const { status, data } = await apiInstance.unzipFile(
245
+ fileId,
246
+ unzipRequest
247
+ );
248
+ ```
249
+
250
+ ### Parameters
251
+
252
+ |Name | Type | Description | Notes|
253
+ |------------- | ------------- | ------------- | -------------|
254
+ | **unzipRequest** | **UnzipRequest**| | |
255
+ | **fileId** | [**string**] | Id of the ZIP document | defaults to undefined|
256
+
257
+
258
+ ### Return type
259
+
260
+ **UnzipResponse**
261
+
262
+ ### Authorization
263
+
264
+ [keycloak_auth](../README.md#keycloak_auth)
265
+
266
+ ### HTTP request headers
267
+
268
+ - **Content-Type**: application/json
269
+ - **Accept**: */*
270
+
271
+
272
+ ### HTTP response details
273
+ | Status code | Description | Response headers |
274
+ |-------------|-------------|------------------|
275
+ |**200** | OK | - |
276
+
277
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
278
+
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **documentIds** | **Array&lt;string&gt;** | List of document IDs (files or folders) to move. | [optional] [default to undefined]
9
9
  **targetFolderId** | **string** | ID of the target folder. | [optional] [default to undefined]
10
- **allowDuplicateFileNames** | **boolean** | 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) | [optional] [default to undefined]
10
+ **allowDuplicateFileNames** | **boolean** | 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. | [optional] [default to undefined]
11
11
 
12
12
  ## Example
13
13
 
package/docs/Settings.md CHANGED
@@ -34,6 +34,7 @@ Name | Type | Description | Notes
34
34
  **mcpMode** | **string** | | [optional] [default to undefined]
35
35
  **mcpAuthorizationServerUrl** | **string** | | [optional] [default to undefined]
36
36
  **mcpClientId** | **string** | | [optional] [default to undefined]
37
+ **extensions** | **{ [key: string]: any; }** | | [optional] [default to undefined]
37
38
 
38
39
  ## Example
39
40
 
@@ -70,6 +71,7 @@ const instance: Settings = {
70
71
  mcpMode,
71
72
  mcpAuthorizationServerUrl,
72
73
  mcpClientId,
74
+ extensions,
73
75
  };
74
76
  ```
75
77
 
@@ -0,0 +1,26 @@
1
+ # UnzipRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **targetFolderId** | **string** | Folder to extract into. Omitted (and targetRoot not set): the folder containing the ZIP. | [optional] [default to undefined]
9
+ **targetRoot** | **boolean** | Extract at the root, whatever targetFolderId says. | [optional] [default to undefined]
10
+ **newFolderName** | **string** | Create a folder of this name in the destination and extract into it. | [optional] [default to undefined]
11
+ **allowDuplicateFileNames** | **boolean** | When true, files are extracted even if a document of the same name already exists in their destination folder. When false (default), such entries are skipped and listed in the response. Existing folders are always merged. | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { UnzipRequest } from '@openfilz-sdk/typescript';
17
+
18
+ const instance: UnzipRequest = {
19
+ targetFolderId,
20
+ targetRoot,
21
+ newFolderName,
22
+ allowDuplicateFileNames,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,28 @@
1
+ # UnzipResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **targetFolderId** | **string** | Folder the archive was extracted into (null &#x3D; root). | [optional] [default to undefined]
9
+ **createdFolderId** | **string** | Id of the folder created from newFolderName, if any. | [optional] [default to undefined]
10
+ **foldersCreated** | **number** | Number of folders created. | [optional] [default to undefined]
11
+ **filesExtracted** | **number** | Number of files extracted. | [optional] [default to undefined]
12
+ **skipped** | [**Array&lt;UnzipSkippedEntry&gt;**](UnzipSkippedEntry.md) | Entries that were not extracted, with the reason. | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { UnzipResponse } from '@openfilz-sdk/typescript';
18
+
19
+ const instance: UnzipResponse = {
20
+ targetFolderId,
21
+ createdFolderId,
22
+ foldersCreated,
23
+ filesExtracted,
24
+ skipped,
25
+ };
26
+ ```
27
+
28
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # UnzipSkippedEntry
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **path** | **string** | Path of the entry inside the archive. | [optional] [default to undefined]
9
+ **reason** | **string** | Why it was skipped. | [optional] [default to undefined]
10
+ **message** | **string** | Details, when available. | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { UnzipSkippedEntry } from '@openfilz-sdk/typescript';
16
+
17
+ const instance: UnzipSkippedEntry = {
18
+ path,
19
+ reason,
20
+ message,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)