@openfilz-sdk/typescript-ee 1.12.16 → 1.12.18

package/docs/OwnershipTransferReport.md

@@ -0,0 +1,48 @@
+# OwnershipTransferReport
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobId** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**fromUserId** | **string** |  | [optional] [default to undefined]
+**toUserId** | **string** |  | [optional] [default to undefined]
+**documents** | **number** |  | [optional] [default to undefined]
+**folders** | **number** |  | [optional] [default to undefined]
+**files** | **number** |  | [optional] [default to undefined]
+**bytes** | **number** |  | [optional] [default to undefined]
+**moved** | **number** |  | [optional] [default to undefined]
+**processed** | **number** |  | [optional] [default to undefined]
+**targetFolderId** | **string** |  | [optional] [default to undefined]
+**quota** | [**QuotaCheck**](QuotaCheck.md) |  | [optional] [default to undefined]
+**error** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OwnershipTransferReport } from '@openfilz-sdk/typescript-ee';
+
+const instance: OwnershipTransferReport = {
+    jobId,
+    status,
+    fromUserId,
+    toUserId,
+    documents,
+    folders,
+    files,
+    bytes,
+    moved,
+    processed,
+    targetFolderId,
+    quota,
+    error,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/OwnershipTransferRequest.md

@@ -0,0 +1,37 @@
+# OwnershipTransferRequest
+
+Ownership transfer request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fromUserId** | **string** |  | [default to undefined]
+**toUserId** | **string** |  | [default to undefined]
+**all** | **boolean** | Every document the user owns, recycle bin included | [optional] [default to undefined]
+**documentIds** | **Set<string>** | These documents, folders with their subtree (only what the user owns in it) | [optional] [default to undefined]
+**filter** | [**OwnedDocumentsFilter**](OwnedDocumentsFilter.md) | The documents the filter selects, folders with their subtree | [optional] [default to undefined]
+**keepAccess** | **string** | What the former owner keeps: NONE (default), READER or EDITOR | [optional] [default to undefined]
+**targetFolderId** | **string** | Folder owned by the new owner that receives the transferred items whose parent stays behind; absent = the new owner\'s root | [optional] [default to undefined]
+**dryRun** | **boolean** | Report what would happen, change nothing | [optional] [default to undefined]
+**reason** | **string** | Why — required when the transfer bypasses the user\'s consent | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OwnershipTransferRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: OwnershipTransferRequest = {
+    fromUserId,
+    toUserId,
+    all,
+    documentIds,
+    filter,
+    keepAccess,
+    targetFolderId,
+    dryRun,
+    reason,
+};
+```
+
+[[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/QuotaCheck.md

@@ -0,0 +1,26 @@
+# QuotaCheck
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**usedBytes** | **number** |  | [optional] [default to undefined]
+**transferBytes** | **number** |  | [optional] [default to undefined]
+**limitBytes** | **number** |  | [optional] [default to undefined]
+**exceeded** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { QuotaCheck } from '@openfilz-sdk/typescript-ee';
+
+const instance: QuotaCheck = {
+    usedBytes,
+    transferBytes,
+    limitBytes,
+    exceeded,
+};
+```
+
+[[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/ShareInheritance.md

@@ -0,0 +1,24 @@
+# ShareInheritance
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** |  | [optional] [default to undefined]
+**inherit** | **boolean** |  | [optional] [default to undefined]
+**canChange** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShareInheritance } from '@openfilz-sdk/typescript-ee';
+
+const instance: ShareInheritance = {
+    documentId,
+    inherit,
+    canChange,
+};
+```
+
+[[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/ShareInheritanceRequest.md

@@ -0,0 +1,20 @@
+# ShareInheritanceRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**inherit** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShareInheritanceRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ShareInheritanceRequest = {
+    inherit,
+};
+```
+
+[[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/SharingApi.md

@@ -0,0 +1,114 @@
+# SharingApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getShareInheritance**](#getshareinheritance) | **GET** /api/v1/documents/{id}/share-inheritance | Does the document receive the shares of its ancestors?|
+|[**setShareInheritance**](#setshareinheritance) | **PUT** /api/v1/users/share/inheritance/{id} | Stop (inherit=false) or resume (inherit=true) inheriting the ancestors\' shares|
+
+# **getShareInheritance**
+> ShareInheritance getShareInheritance()
+
+
+### Example
+
+```typescript
+import {
+    SharingApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getShareInheritance(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShareInheritance**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+
+# **setShareInheritance**
+> ShareInheritance setShareInheritance(shareInheritanceRequest)
+
+inherit=false removes every share the document and its subtree inherited from above; shares placed on the document or inside it remain and keep flowing down. inherit=true copies the parent\'s shares down again. Owner or SHARE_ADMIN. Audited SHARE_INHERITANCE_CHANGED.
+
+### Example
+
+```typescript
+import {
+    SharingApi,
+    Configuration,
+    ShareInheritanceRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingApi(configuration);
+
+let id: string; // (default to undefined)
+let shareInheritanceRequest: ShareInheritanceRequest; //
+
+const { status, data } = await apiInstance.setShareInheritance(
+    id,
+    shareInheritanceRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **shareInheritanceRequest** | **ShareInheritanceRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShareInheritance**
+
+### 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/UserRegistrationRequest.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **name** | **string** |  | [default to undefined]
 **email** | **string** |  | [default to undefined]
 **status** | **string** |  | [default to undefined]
+**hostManaged** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -18,6 +19,7 @@ const instance: UserRegistrationRequest = {
     name,
     email,
     status,
+    hostManaged,
 };
 ```
 

package/models/enriched-audit-log-details.ts

@@ -22,6 +22,32 @@ import type { CreateFolderAudit } from './create-folder-audit';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { CreateFolderRequest } from './create-folder-request';
+// @ts-ignore
+import type { CopyAudit } from './copy-audit';
+// @ts-ignore
+import type { CreateFolderAudit } from './create-folder-audit';
+// @ts-ignore
+import type { DeleteAudit } from './delete-audit';
+// @ts-ignore
+import type { DeleteMetadataAudit } from './delete-metadata-audit';
+// @ts-ignore
+import type { MoveAudit } from './move-audit';
+// @ts-ignore
+import type { PdfTransformAudit } from './pdf-transform-audit';
+// @ts-ignore
+import type { RenameAudit } from './rename-audit';
+// @ts-ignore
+import type { ReplaceAudit } from './replace-audit';
+// @ts-ignore
+import type { RestoreVersionAudit } from './restore-version-audit';
+// @ts-ignore
+import type { UpdateMetadataAudit } from './update-metadata-audit';
+// @ts-ignore
+import type { UploadAudit } from './upload-audit';
+// @ts-ignore
+import type { WorkflowActionFailureAudit } from './workflow-action-failure-audit';
+// @ts-ignore
+import type { WorkflowAudit } from './workflow-audit';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { DeleteAudit } from './delete-audit';

package/models/enriched-audit-log.ts

@@ -77,6 +77,15 @@ export const EnrichedAuditLogActionEnum = {
     ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
     ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
     ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
+    ShareInheritanceChanged: 'SHARE_INHERITANCE_CHANGED',
+    TeamCreated: 'TEAM_CREATED',
+    TeamUpdated: 'TEAM_UPDATED',
+    TeamDeleted: 'TEAM_DELETED',
+    TeamMembersAdded: 'TEAM_MEMBERS_ADDED',
+    TeamMembersRemoved: 'TEAM_MEMBERS_REMOVED',
+    OwnershipTransferred: 'OWNERSHIP_TRANSFERRED',
+    OwnershipTransferCompleted: 'OWNERSHIP_TRANSFER_COMPLETED',
+    ConsentBypassed: 'CONSENT_BYPASSED',
     DelegatedGrantRequested: 'DELEGATED_GRANT_REQUESTED',
     DelegatedGrantAccepted: 'DELEGATED_GRANT_ACCEPTED',
     DelegatedGrantDeclined: 'DELEGATED_GRANT_DECLINED',

package/models/index.ts

@@ -114,6 +114,10 @@ export * from './my-tasks-count-dto';
 export * from './notification-dto';
 export * from './organize-request';
 export * from './output-target';
+export * from './owned-document';
+export * from './owned-documents-filter';
+export * from './ownership-transfer-report';
+export * from './ownership-transfer-request';
 export * from './page-instruction';
 export * from './pdf-info';
 export * from './pdf-operation-response';
@@ -123,6 +127,7 @@ export * from './pdf-page-info';
 export * from './pdf-transform-audit';
 export * from './per-definition';
 export * from './public-signature-view';
+export * from './quota-check';
 export * from './quota-overview';
 export * from './quota-usage';
 export * from './quota-user-page';
@@ -151,6 +156,8 @@ export * from './search-by-metadata-request';
 export * from './search-metadata-request';
 export * from './setting-dto';
 export * from './settings';
+export * from './share-inheritance';
+export * from './share-inheritance-request';
 export * from './share-request';
 export * from './share-result-error';
 export * from './share-result-item';

package/models/notification-dto.ts

@@ -41,6 +41,8 @@ export const NotificationDTOTypeEnum = {
     WorkflowTaskOverdue: 'WORKFLOW_TASK_OVERDUE',
     WorkflowCompleted: 'WORKFLOW_COMPLETED',
     WorkflowCancelled: 'WORKFLOW_CANCELLED',
+    OwnershipReceived: 'OWNERSHIP_RECEIVED',
+    OwnershipRemoved: 'OWNERSHIP_REMOVED',
 } as const;
 
 export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];

package/models/owned-document.ts

@@ -0,0 +1,34 @@
+/* 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 OwnedDocument {
+    'id'?: string;
+    'name'?: string;
+    'type'?: OwnedDocumentTypeEnum;
+    'parentId'?: string;
+    'size'?: number;
+    'updatedAt'?: string;
+    'active'?: boolean;
+}
+
+export const OwnedDocumentTypeEnum = {
+    File: 'FILE',
+    Folder: 'FOLDER',
+} as const;
+
+export type OwnedDocumentTypeEnum = typeof OwnedDocumentTypeEnum[keyof typeof OwnedDocumentTypeEnum];
+
+

package/models/owned-documents-filter.ts

@@ -0,0 +1,54 @@
+/* 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.
+ */
+
+
+
+/**
+ * Filter on the documents owned by a user
+ */
+export interface OwnedDocumentsFilter {
+    /**
+     * Children of this folder (owned by the user)
+     */
+    'parentId'?: string;
+    /**
+     * With parentId: every descendant; without: every owned document
+     */
+    'recursive'?: boolean;
+    /**
+     * FILE or FOLDER
+     */
+    'type'?: OwnedDocumentsFilterTypeEnum;
+    /**
+     * Case-insensitive part of the name
+     */
+    'name'?: string;
+    /**
+     * Last modified at or after
+     */
+    'updatedAfter'?: string;
+    /**
+     * Last modified at or before
+     */
+    'updatedBefore'?: string;
+}
+
+export const OwnedDocumentsFilterTypeEnum = {
+    File: 'FILE',
+    Folder: 'FOLDER',
+} as const;
+
+export type OwnedDocumentsFilterTypeEnum = typeof OwnedDocumentsFilterTypeEnum[keyof typeof OwnedDocumentsFilterTypeEnum];
+
+

package/models/ownership-transfer-report.ts

@@ -0,0 +1,37 @@
+/* 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 { QuotaCheck } from './quota-check';
+
+export interface OwnershipTransferReport {
+    'jobId'?: string;
+    'status'?: string;
+    'fromUserId'?: string;
+    'toUserId'?: string;
+    'documents'?: number;
+    'folders'?: number;
+    'files'?: number;
+    'bytes'?: number;
+    'moved'?: number;
+    'processed'?: number;
+    'targetFolderId'?: string;
+    'quota'?: QuotaCheck;
+    'error'?: string;
+    'createdAt'?: string;
+    'updatedAt'?: string;
+}
+

package/models/ownership-transfer-request.ts

@@ -0,0 +1,64 @@
+/* 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 { OwnedDocumentsFilter } from './owned-documents-filter';
+
+/**
+ * Ownership transfer request
+ */
+export interface OwnershipTransferRequest {
+    'fromUserId': string;
+    'toUserId': string;
+    /**
+     * Every document the user owns, recycle bin included
+     */
+    'all'?: boolean;
+    /**
+     * These documents, folders with their subtree (only what the user owns in it)
+     */
+    'documentIds'?: Set<string>;
+    /**
+     * The documents the filter selects, folders with their subtree
+     */
+    'filter'?: OwnedDocumentsFilter;
+    /**
+     * What the former owner keeps: NONE (default), READER or EDITOR
+     */
+    'keepAccess'?: OwnershipTransferRequestKeepAccessEnum;
+    /**
+     * Folder owned by the new owner that receives the transferred items whose parent stays behind; absent = the new owner\'s root
+     */
+    'targetFolderId'?: string;
+    /**
+     * Report what would happen, change nothing
+     */
+    'dryRun'?: boolean;
+    /**
+     * Why — required when the transfer bypasses the user\'s consent
+     */
+    'reason'?: string;
+}
+
+export const OwnershipTransferRequestKeepAccessEnum = {
+    None: 'NONE',
+    Reader: 'READER',
+    Editor: 'EDITOR',
+} as const;
+
+export type OwnershipTransferRequestKeepAccessEnum = typeof OwnershipTransferRequestKeepAccessEnum[keyof typeof OwnershipTransferRequestKeepAccessEnum];
+
+

package/models/quota-check.ts

@@ -0,0 +1,23 @@
+/* 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 QuotaCheck {
+    'usedBytes'?: number;
+    'transferBytes'?: number;
+    'limitBytes'?: number;
+    'exceeded'?: boolean;
+}
+

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

@@ -90,6 +90,15 @@ export const SearchByAuditLogRequestActionEnum = {
     ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
     ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
     ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
+    ShareInheritanceChanged: 'SHARE_INHERITANCE_CHANGED',
+    TeamCreated: 'TEAM_CREATED',
+    TeamUpdated: 'TEAM_UPDATED',
+    TeamDeleted: 'TEAM_DELETED',
+    TeamMembersAdded: 'TEAM_MEMBERS_ADDED',
+    TeamMembersRemoved: 'TEAM_MEMBERS_REMOVED',
+    OwnershipTransferred: 'OWNERSHIP_TRANSFERRED',
+    OwnershipTransferCompleted: 'OWNERSHIP_TRANSFER_COMPLETED',
+    ConsentBypassed: 'CONSENT_BYPASSED',
     DelegatedGrantRequested: 'DELEGATED_GRANT_REQUESTED',
     DelegatedGrantAccepted: 'DELEGATED_GRANT_ACCEPTED',
     DelegatedGrantDeclined: 'DELEGATED_GRANT_DECLINED',

package/models/share-inheritance-request.ts

@@ -0,0 +1,20 @@
+/* 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 ShareInheritanceRequest {
+    'inherit'?: boolean;
+}
+

package/models/share-inheritance.ts

@@ -0,0 +1,22 @@
+/* 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 ShareInheritance {
+    'documentId'?: string;
+    'inherit'?: boolean;
+    'canChange'?: boolean;
+}
+

package/models/user-registration-request.ts

@@ -18,6 +18,7 @@ export interface UserRegistrationRequest {
     'name': string;
     'email': string;
     'status': UserRegistrationRequestStatusEnum;
+    'hostManaged'?: boolean;
 }
 
 export const UserRegistrationRequestStatusEnum = {

package/package.json

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