@openfilz-sdk/typescript-ee 1.3.5

package/docs/CommentDTO.md

@@ -0,0 +1,36 @@
+# CommentDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**docIds** | **Set<string>** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**createdUserId** | **string** |  | [optional] [default to undefined]
+**createdUserEmail** | **string** |  | [optional] [default to undefined]
+**createdUserName** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+**mentionedUserIds** | **Set<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CommentDTO } from '@openfilz-sdk/typescript-ee';
+
+const instance: CommentDTO = {
+    id,
+    docIds,
+    message,
+    createdUserId,
+    createdUserEmail,
+    createdUserName,
+    createdAt,
+    updatedAt,
+    mentionedUserIds,
+};
+```
+
+[[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/CommentsApi.md

@@ -0,0 +1,168 @@
+# CommentsApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createComment**](#createcomment) | **POST** /api/v1/documents/comments | Create a comment|
+|[**deleteComment**](#deletecomment) | **DELETE** /api/v1/documents/comments/{id} | Delete a comment|
+|[**updateComment**](#updatecomment) | **PUT** /api/v1/documents/comments/{id} | Update a comment|
+
+# **createComment**
+> CommentDTO createComment(createCommentRequest)
+
+Create a new comment on one or more documents
+
+### Example
+
+```typescript
+import {
+    CommentsApi,
+    Configuration,
+    CreateCommentRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CommentsApi(configuration);
+
+let createCommentRequest: CreateCommentRequest; //
+
+const { status, data } = await apiInstance.createComment(
+    createCommentRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createCommentRequest** | **CreateCommentRequest**|  | |
+
+
+### Return type
+
+**CommentDTO**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### 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)
+
+# **deleteComment**
+> deleteComment()
+
+Delete an existing comment. Only the comment creator can delete their comment.
+
+### Example
+
+```typescript
+import {
+    CommentsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CommentsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteComment(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### 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)
+
+# **updateComment**
+> CommentDTO updateComment(updateCommentRequest)
+
+Update an existing comment. Only the comment creator can update their comment.
+
+### Example
+
+```typescript
+import {
+    CommentsApi,
+    Configuration,
+    UpdateCommentRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CommentsApi(configuration);
+
+let id: string; // (default to undefined)
+let updateCommentRequest: UpdateCommentRequest; //
+
+const { status, data } = await apiInstance.updateComment(
+    id,
+    updateCommentRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateCommentRequest** | **UpdateCommentRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**CommentDTO**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### 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/CopyAudit.md

@@ -0,0 +1,25 @@
+# CopyAudit
+
+type=copy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sourceFileId** | **string** |  | [optional] [default to undefined]
+**targetFolderId** | **string** |  | [optional] [default to undefined]
+**sourceFolderId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CopyAudit } from '@openfilz-sdk/typescript-ee';
+
+const instance: CopyAudit = {
+    sourceFileId,
+    targetFolderId,
+    sourceFolderId,
+};
+```
+
+[[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/CopyRequest.md

@@ -0,0 +1,24 @@
+# CopyRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentIds** | **Array<string>** | List of document IDs (files or folders) to copy. | [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]
+
+## Example
+
+```typescript
+import { CopyRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: CopyRequest = {
+    documentIds,
+    targetFolderId,
+    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/CopyResponse.md

@@ -0,0 +1,22 @@
+# CopyResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**originalId** | **string** | Original file ID | [optional] [default to undefined]
+**copyId** | **string** | Copied file ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CopyResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: CopyResponse = {
+    originalId,
+    copyId,
+};
+```
+
+[[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/CreateBlankDocumentRequest.md

@@ -0,0 +1,24 @@
+# CreateBlankDocumentRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**documentType** | **string** | Type of blank document to create: WORD, EXCEL, POWERPOINT, or TEXT | [default to undefined]
+**parentFolderId** | **string** | ID of the parent folder. If null, created at root. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateBlankDocumentRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: CreateBlankDocumentRequest = {
+    name,
+    documentType,
+    parentFolderId,
+};
+```
+
+[[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/CreateCommentRequest.md

@@ -0,0 +1,24 @@
+# CreateCommentRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**docIds** | **Set<string>** | Document IDs to associate with this comment | [default to undefined]
+**message** | **string** | The comment message content (HTML allowed) | [default to undefined]
+**mentionedUserIds** | **Set<string>** | User IDs mentioned in the comment via @mentions | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateCommentRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: CreateCommentRequest = {
+    docIds,
+    message,
+    mentionedUserIds,
+};
+```
+
+[[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/CreateFolderAudit.md

@@ -0,0 +1,23 @@
+# CreateFolderAudit
+
+type=createFolder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request** | [**CreateFolderRequest**](CreateFolderRequest.md) |  | [optional] [default to undefined]
+**sourceFolderId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateFolderAudit } from '@openfilz-sdk/typescript-ee';
+
+const instance: CreateFolderAudit = {
+    request,
+    sourceFolderId,
+};
+```
+
+[[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/CreateFolderRequest.md

@@ -0,0 +1,22 @@
+# CreateFolderRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**parentId** | **string** | ID of the parent folder. If null, created at root. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateFolderRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: CreateFolderRequest = {
+    name,
+    parentId,
+};
+```
+
+[[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/CreateTeamRequest.md

@@ -0,0 +1,22 @@
+# CreateTeamRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**email** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateTeamRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: CreateTeamRequest = {
+    name,
+    email,
+};
+```
+
+[[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/DashboardApi.md

@@ -0,0 +1,52 @@
+# DashboardApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getDashboardStatistics**](#getdashboardstatistics) | **GET** /api/v1/dashboard/statistics | Get dashboard statistics|
+
+# **getDashboardStatistics**
+> DashboardStatisticsResponse getDashboardStatistics()
+
+Retrieve aggregated dashboard metrics including file counts, storage usage, and file type distribution
+
+### Example
+
+```typescript
+import {
+    DashboardApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DashboardApi(configuration);
+
+const { status, data } = await apiInstance.getDashboardStatistics();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**DashboardStatisticsResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### 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/DashboardStatisticsResponse.md

@@ -0,0 +1,26 @@
+# DashboardStatisticsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalFiles** | **number** |  | [optional] [default to undefined]
+**totalFolders** | **number** |  | [optional] [default to undefined]
+**storage** | [**StorageBreakdown**](StorageBreakdown.md) |  | [optional] [default to undefined]
+**fileTypeCounts** | [**Array<FileTypeStats>**](FileTypeStats.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DashboardStatisticsResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: DashboardStatisticsResponse = {
+    totalFiles,
+    totalFolders,
+    storage,
+    fileTypeCounts,
+};
+```
+
+[[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/DeleteAudit.md

@@ -0,0 +1,21 @@
+# DeleteAudit
+
+type=delete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deletedParentFolderId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteAudit } from '@openfilz-sdk/typescript-ee';
+
+const instance: DeleteAudit = {
+    deletedParentFolderId,
+};
+```
+
+[[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/DeleteMetadataAudit.md

@@ -0,0 +1,21 @@
+# DeleteMetadataAudit
+
+type=deleteMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deletedMetadataKeys** | **Array<string>** | List of deleted metadata keys | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteMetadataAudit } from '@openfilz-sdk/typescript-ee';
+
+const instance: DeleteMetadataAudit = {
+    deletedMetadataKeys,
+};
+```
+
+[[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/DeleteMetadataRequest.md

@@ -0,0 +1,20 @@
+# DeleteMetadataRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadataKeysToDelete** | **Array<string>** | List of metadata keys to delete. | [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteMetadataRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: DeleteMetadataRequest = {
+    metadataKeysToDelete,
+};
+```
+
+[[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/DeleteRequest.md

@@ -0,0 +1,20 @@
+# DeleteRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentIds** | **Array<string>** | List of document IDs to delete. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: DeleteRequest = {
+    documentIds,
+};
+```
+
+[[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/DeleteShareRequest.md

@@ -0,0 +1,22 @@
+# DeleteShareRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentIds** | **Set<string>** | shared documents to remove | [default to undefined]
+**userIds** | **Set<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteShareRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: DeleteShareRequest = {
+    documentIds,
+    userIds,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)