@openfilz-sdk/typescript-ee 1.10.4 → 1.10.5

package/docs/FileControllerApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *http://localhost:8081*
 |[**deleteFiles**](#deletefiles) | **DELETE** /api/v1/files | Delete files|
 |[**moveFiles**](#movefiles) | **POST** /api/v1/files/move | Move files|
 |[**renameFile**](#renamefile) | **PUT** /api/v1/files/{fileId}/rename | Rename a file|
+|[**unzipFile**](#unzipfile) | **POST** /api/v1/files/{fileId}/unzip | Extract a ZIP file|
 
 # **copyFiles**
 > Array<CopyResponse> copyFiles(copyRequest)
@@ -220,3 +221,58 @@ const { status, data } = await apiInstance.renameFile(
 
 [[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)
 
+# **unzipFile**
+> UnzipResponse unzipFile()
+
+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).
+
+### Example
+
+```typescript
+import {
+    FileControllerApi,
+    Configuration,
+    UnzipRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new FileControllerApi(configuration);
+
+let fileId: string; //Id of the ZIP document (default to undefined)
+let unzipRequest: UnzipRequest; // (optional)
+
+const { status, data } = await apiInstance.unzipFile(
+    fileId,
+    unzipRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **unzipRequest** | **UnzipRequest**|  | |
+| **fileId** | [**string**] | Id of the ZIP document | defaults to undefined|
+
+
+### Return type
+
+**UnzipResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+

package/docs/MoveRequest.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **documentIds** | **Array<string>** | List of document IDs (files or folders) to move. | [optional] [default to undefined]
 **targetFolderId** | **string** | ID of the target folder. | [optional] [default to undefined]
-**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]
+**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]
 
 ## Example
 

package/docs/Settings.md

@@ -34,6 +34,7 @@ Name | Type | Description | Notes
 **mcpMode** | **string** |  | [optional] [default to undefined]
 **mcpAuthorizationServerUrl** | **string** |  | [optional] [default to undefined]
 **mcpClientId** | **string** |  | [optional] [default to undefined]
+**extensions** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -70,6 +71,7 @@ const instance: Settings = {
     mcpMode,
     mcpAuthorizationServerUrl,
     mcpClientId,
+    extensions,
 };
 ```
 

package/docs/SyncBackfillStatus.md

@@ -0,0 +1,34 @@
+# SyncBackfillStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to undefined]
+**startedAt** | **string** |  | [optional] [default to undefined]
+**finishedAt** | **string** |  | [optional] [default to undefined]
+**files** | **number** |  | [optional] [default to undefined]
+**sizesCorrected** | **number** |  | [optional] [default to undefined]
+**hashesAdded** | **number** |  | [optional] [default to undefined]
+**failures** | **number** |  | [optional] [default to undefined]
+**lastError** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SyncBackfillStatus } from '@openfilz-sdk/typescript-ee';
+
+const instance: SyncBackfillStatus = {
+    status,
+    startedAt,
+    finishedAt,
+    files,
+    sizesCorrected,
+    hashesAdded,
+    failures,
+    lastError,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SyncChangesResponse.md

@@ -0,0 +1,24 @@
+# SyncChangesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cursor** | **number** |  | [optional] [default to undefined]
+**hasMore** | **boolean** |  | [optional] [default to undefined]
+**items** | [**Array<SyncItem>**](SyncItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SyncChangesResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: SyncChangesResponse = {
+    cursor,
+    hasMore,
+    items,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SyncItem.md

@@ -0,0 +1,40 @@
+# SyncItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**gone** | **boolean** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**parentId** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**size** | **number** |  | [optional] [default to undefined]
+**sha256** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+**shareRoot** | **boolean** |  | [optional] [default to undefined]
+**canWrite** | **boolean** |  | [optional] [default to undefined]
+**canDelete** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SyncItem } from '@openfilz-sdk/typescript-ee';
+
+const instance: SyncItem = {
+    id,
+    gone,
+    type,
+    parentId,
+    name,
+    size,
+    sha256,
+    updatedAt,
+    shareRoot,
+    canWrite,
+    canDelete,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SyncSnapshotResponse.md

@@ -0,0 +1,24 @@
+# SyncSnapshotResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cursor** | **number** |  | [optional] [default to undefined]
+**after** | **string** |  | [optional] [default to undefined]
+**items** | [**Array<SyncItem>**](SyncItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SyncSnapshotResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: SyncSnapshotResponse = {
+    cursor,
+    after,
+    items,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UnzipRequest.md

@@ -0,0 +1,26 @@
+# UnzipRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**targetFolderId** | **string** | Folder to extract into. Omitted (and targetRoot not set): the folder containing the ZIP. | [optional] [default to undefined]
+**targetRoot** | **boolean** | Extract at the root, whatever targetFolderId says. | [optional] [default to undefined]
+**newFolderName** | **string** | Create a folder of this name in the destination and extract into it. | [optional] [default to undefined]
+**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]
+
+## Example
+
+```typescript
+import { UnzipRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: UnzipRequest = {
+    targetFolderId,
+    targetRoot,
+    newFolderName,
+    allowDuplicateFileNames,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UnzipResponse.md

@@ -0,0 +1,28 @@
+# UnzipResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**targetFolderId** | **string** | Folder the archive was extracted into (null = root). | [optional] [default to undefined]
+**createdFolderId** | **string** | Id of the folder created from newFolderName, if any. | [optional] [default to undefined]
+**foldersCreated** | **number** | Number of folders created. | [optional] [default to undefined]
+**filesExtracted** | **number** | Number of files extracted. | [optional] [default to undefined]
+**skipped** | [**Array<UnzipSkippedEntry>**](UnzipSkippedEntry.md) | Entries that were not extracted, with the reason. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UnzipResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: UnzipResponse = {
+    targetFolderId,
+    createdFolderId,
+    foldersCreated,
+    filesExtracted,
+    skipped,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UnzipSkippedEntry.md

@@ -0,0 +1,24 @@
+# UnzipSkippedEntry
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **string** | Path of the entry inside the archive. | [optional] [default to undefined]
+**reason** | **string** | Why it was skipped. | [optional] [default to undefined]
+**message** | **string** | Details, when available. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UnzipSkippedEntry } from '@openfilz-sdk/typescript-ee';
+
+const instance: UnzipSkippedEntry = {
+    path,
+    reason,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/models/copy-request.ts

@@ -24,7 +24,7 @@ export interface CopyRequest {
      */
     'targetFolderId'?: string;
     /**
-     * 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)
+     * 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.
      */
     'allowDuplicateFileNames'?: boolean;
 }

package/models/desktop-sync-client-info.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface DesktopSyncClientInfo {
+    'server'?: string;
+    'issuer'?: string;
+    'clientId'?: string;
+    'updateUrl'?: string;
+    'downloadUrl'?: string;
+    'webUrl'?: string;
+    'apiVersion'?: number;
+}
+

package/models/enriched-audit-log.ts

@@ -51,6 +51,7 @@ export const EnrichedAuditLogActionEnum = {
     ReplaceDocumentMetadata: 'REPLACE_DOCUMENT_METADATA',
     UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
     DownloadDocument: 'DOWNLOAD_DOCUMENT',
+    OpenDocument: 'OPEN_DOCUMENT',
     DeleteDocumentMetadata: 'DELETE_DOCUMENT_METADATA',
     RestoreFile: 'RESTORE_FILE',
     RestoreFolder: 'RESTORE_FOLDER',

package/models/index.ts

@@ -58,6 +58,7 @@ export * from './delete-metadata-audit';
 export * from './delete-metadata-request';
 export * from './delete-request';
 export * from './delete-share-request';
+export * from './desktop-sync-client-info';
 export * from './document-info';
 export * from './document-insight-view';
 export * from './document-integrity-record';
@@ -162,6 +163,10 @@ export * from './split-request';
 export * from './start-workflow-request';
 export * from './storage-breakdown';
 export * from './suggest';
+export * from './sync-backfill-status';
+export * from './sync-changes-response';
+export * from './sync-item';
+export * from './sync-snapshot-response';
 export * from './team-inbox-request';
 export * from './team-inbox-view';
 export * from './team-member-info';
@@ -170,6 +175,9 @@ export * from './tus-config-response';
 export * from './tus-finalize-request';
 export * from './tus-upload-info';
 export * from './untouched';
+export * from './unzip-request';
+export * from './unzip-response';
+export * from './unzip-skipped-entry';
 export * from './update-comment-request';
 export * from './update-metadata-audit';
 export * from './update-metadata-request';

package/models/move-request.ts

@@ -24,7 +24,7 @@ export interface MoveRequest {
      */
     'targetFolderId'?: string;
     /**
-     * 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)
+     * 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.
      */
     'allowDuplicateFileNames'?: boolean;
 }

package/models/search-by-audit-log-request.ts

@@ -64,6 +64,7 @@ export const SearchByAuditLogRequestActionEnum = {
     ReplaceDocumentMetadata: 'REPLACE_DOCUMENT_METADATA',
     UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
     DownloadDocument: 'DOWNLOAD_DOCUMENT',
+    OpenDocument: 'OPEN_DOCUMENT',
     DeleteDocumentMetadata: 'DELETE_DOCUMENT_METADATA',
     RestoreFile: 'RESTORE_FILE',
     RestoreFolder: 'RESTORE_FOLDER',

package/models/settings.ts

@@ -44,5 +44,6 @@ export interface Settings {
     'mcpMode'?: string;
     'mcpAuthorizationServerUrl'?: string;
     'mcpClientId'?: string;
+    'extensions'?: { [key: string]: any; };
 }
 

package/models/sync-backfill-status.ts

@@ -0,0 +1,27 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface SyncBackfillStatus {
+    'status'?: string;
+    'startedAt'?: string;
+    'finishedAt'?: string;
+    'files'?: number;
+    'sizesCorrected'?: number;
+    'hashesAdded'?: number;
+    'failures'?: number;
+    'lastError'?: string;
+}
+

package/models/sync-changes-response.ts

@@ -0,0 +1,25 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SyncItem } from './sync-item';
+
+export interface SyncChangesResponse {
+    'cursor'?: number;
+    'hasMore'?: boolean;
+    'items'?: Array<SyncItem>;
+}
+

package/models/sync-item.ts

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface SyncItem {
+    'id'?: string;
+    'gone'?: boolean;
+    'type'?: SyncItemTypeEnum;
+    'parentId'?: string;
+    'name'?: string;
+    'size'?: number;
+    'sha256'?: string;
+    'updatedAt'?: string;
+    'shareRoot'?: boolean;
+    'canWrite'?: boolean;
+    'canDelete'?: boolean;
+}
+
+export const SyncItemTypeEnum = {
+    File: 'FILE',
+    Folder: 'FOLDER',
+} as const;
+
+export type SyncItemTypeEnum = typeof SyncItemTypeEnum[keyof typeof SyncItemTypeEnum];
+
+

package/models/sync-snapshot-response.ts

@@ -0,0 +1,25 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SyncItem } from './sync-item';
+
+export interface SyncSnapshotResponse {
+    'cursor'?: number;
+    'after'?: string;
+    'items'?: Array<SyncItem>;
+}
+

package/models/unzip-request.ts

@@ -0,0 +1,35 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface UnzipRequest {
+    /**
+     * Folder to extract into. Omitted (and targetRoot not set): the folder containing the ZIP.
+     */
+    'targetFolderId'?: string;
+    /**
+     * Extract at the root, whatever targetFolderId says.
+     */
+    'targetRoot'?: boolean;
+    /**
+     * Create a folder of this name in the destination and extract into it.
+     */
+    'newFolderName'?: string;
+    /**
+     * 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.
+     */
+    'allowDuplicateFileNames'?: boolean;
+}
+

package/models/unzip-response.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { UnzipSkippedEntry } from './unzip-skipped-entry';
+
+export interface UnzipResponse {
+    /**
+     * Folder the archive was extracted into (null = root).
+     */
+    'targetFolderId'?: string;
+    /**
+     * Id of the folder created from newFolderName, if any.
+     */
+    'createdFolderId'?: string;
+    /**
+     * Number of folders created.
+     */
+    'foldersCreated'?: number;
+    /**
+     * Number of files extracted.
+     */
+    'filesExtracted'?: number;
+    /**
+     * Entries that were not extracted, with the reason.
+     */
+    'skipped'?: Array<UnzipSkippedEntry>;
+}
+

package/models/unzip-skipped-entry.ts

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface UnzipSkippedEntry {
+    /**
+     * Path of the entry inside the archive.
+     */
+    'path'?: string;
+    /**
+     * Why it was skipped.
+     */
+    'reason'?: UnzipSkippedEntryReasonEnum;
+    /**
+     * Details, when available.
+     */
+    'message'?: string;
+}
+
+export const UnzipSkippedEntryReasonEnum = {
+    DuplicateName: 'DUPLICATE_NAME',
+    UnsafePath: 'UNSAFE_PATH',
+    Unsupported: 'UNSUPPORTED',
+    FileTooLarge: 'FILE_TOO_LARGE',
+    ParentNotCreated: 'PARENT_NOT_CREATED',
+    Error: 'ERROR',
+} as const;
+
+export type UnzipSkippedEntryReasonEnum = typeof UnzipSkippedEntryReasonEnum[keyof typeof UnzipSkippedEntryReasonEnum];
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfilz-sdk/typescript-ee",
-  "version": "1.10.4",
+  "version": "1.10.5",
   "description": "OpenAPI client for @openfilz-sdk/typescript-ee",
   "author": "OpenAPI-Generator Contributors",
   "repository": {