@openfilz-sdk/typescript-ee 1.3.5 → 1.4.1

package/docs/WebhookProxyControllerApi.md

@@ -0,0 +1,364 @@
+# WebhookProxyControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**proxy**](#proxy) | **GET** /api/v1/webhooks/** | |
+|[**proxy1**](#proxy1) | **POST** /api/v1/webhooks/** | |
+|[**proxy2**](#proxy2) | **PUT** /api/v1/webhooks/** | |
+|[**proxy3**](#proxy3) | **DELETE** /api/v1/webhooks/** | |
+|[**proxy4**](#proxy4) | **PATCH** /api/v1/webhooks/** | |
+|[**proxy5**](#proxy5) | **HEAD** /api/v1/webhooks/** | |
+|[**proxy6**](#proxy6) | **OPTIONS** /api/v1/webhooks/** | |
+
+# **proxy**
+> string proxy()
+
+
+### Example
+
+```typescript
+import {
+    WebhookProxyControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WebhookProxyControllerApi(configuration);
+
+let body: string; // (optional)
+
+const { status, data } = await apiInstance.proxy(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**|  | |
+
+
+### Return type
+
+**string**
+
+### 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)
+
+# **proxy1**
+> string proxy1()
+
+
+### Example
+
+```typescript
+import {
+    WebhookProxyControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WebhookProxyControllerApi(configuration);
+
+let body: string; // (optional)
+
+const { status, data } = await apiInstance.proxy1(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**|  | |
+
+
+### Return type
+
+**string**
+
+### 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)
+
+# **proxy2**
+> string proxy2()
+
+
+### Example
+
+```typescript
+import {
+    WebhookProxyControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WebhookProxyControllerApi(configuration);
+
+let body: string; // (optional)
+
+const { status, data } = await apiInstance.proxy2(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**|  | |
+
+
+### Return type
+
+**string**
+
+### 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)
+
+# **proxy3**
+> string proxy3()
+
+
+### Example
+
+```typescript
+import {
+    WebhookProxyControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WebhookProxyControllerApi(configuration);
+
+let body: string; // (optional)
+
+const { status, data } = await apiInstance.proxy3(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**|  | |
+
+
+### Return type
+
+**string**
+
+### 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)
+
+# **proxy4**
+> string proxy4()
+
+
+### Example
+
+```typescript
+import {
+    WebhookProxyControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WebhookProxyControllerApi(configuration);
+
+let body: string; // (optional)
+
+const { status, data } = await apiInstance.proxy4(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**|  | |
+
+
+### Return type
+
+**string**
+
+### 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)
+
+# **proxy5**
+> string proxy5()
+
+
+### Example
+
+```typescript
+import {
+    WebhookProxyControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WebhookProxyControllerApi(configuration);
+
+let body: string; // (optional)
+
+const { status, data } = await apiInstance.proxy5(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**|  | |
+
+
+### Return type
+
+**string**
+
+### 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)
+
+# **proxy6**
+> string proxy6()
+
+
+### Example
+
+```typescript
+import {
+    WebhookProxyControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WebhookProxyControllerApi(configuration);
+
+let body: string; // (optional)
+
+const { status, data } = await apiInstance.proxy6(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**|  | |
+
+
+### Return type
+
+**string**
+
+### 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/models/consume-delegated-grant-request.ts

@@ -0,0 +1,21 @@
+/* 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 ConsumeDelegatedGrantRequest {
+    'subscriptionId': string;
+    'folderId'?: string;
+}
+

package/models/create-delegated-grant-request.ts

@@ -0,0 +1,30 @@
+/* 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 CreateDelegatedGrantRequest {
+    'grantor': string;
+    'purpose': CreateDelegatedGrantRequestPurposeEnum;
+    'note'?: string;
+    'targetUrl': string;
+}
+
+export const CreateDelegatedGrantRequestPurposeEnum = {
+    WebhookSubscription: 'WEBHOOK_SUBSCRIPTION'
+} as const;
+
+export type CreateDelegatedGrantRequestPurposeEnum = typeof CreateDelegatedGrantRequestPurposeEnum[keyof typeof CreateDelegatedGrantRequestPurposeEnum];
+
+

package/models/delegated-folder-node.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 DelegatedFolderNode {
+    'id'?: string;
+    'name'?: string;
+    'hasChildren'?: boolean;
+}
+

package/models/delegated-grant-dto.ts

@@ -0,0 +1,53 @@
+/* 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 DelegatedGrantDTO {
+    'id'?: string;
+    'grantor'?: string;
+    'grantee'?: string;
+    'purpose'?: DelegatedGrantDTOPurposeEnum;
+    'purposeNote'?: string;
+    'status'?: DelegatedGrantDTOStatusEnum;
+    'createdAt'?: string;
+    'acceptDeadline'?: string;
+    'useDeadline'?: string;
+    'acceptedAt'?: string;
+    'declinedAt'?: string;
+    'revokedAt'?: string;
+    'consumedAt'?: string;
+    'consumedSubscriptionId'?: string;
+    'consumedFolderId'?: string;
+    'targetUrl'?: string;
+    'subscriptionRevokedAt'?: string;
+}
+
+export const DelegatedGrantDTOPurposeEnum = {
+    WebhookSubscription: 'WEBHOOK_SUBSCRIPTION'
+} as const;
+
+export type DelegatedGrantDTOPurposeEnum = typeof DelegatedGrantDTOPurposeEnum[keyof typeof DelegatedGrantDTOPurposeEnum];
+export const DelegatedGrantDTOStatusEnum = {
+    Pending: 'PENDING',
+    Accepted: 'ACCEPTED',
+    Declined: 'DECLINED',
+    Revoked: 'REVOKED',
+    Expired: 'EXPIRED',
+    Consumed: 'CONSUMED'
+} as const;
+
+export type DelegatedGrantDTOStatusEnum = typeof DelegatedGrantDTOStatusEnum[keyof typeof DelegatedGrantDTOStatusEnum];
+
+

package/models/{audit-log-details-one-of.ts → enriched-audit-log-details.ts}

@@ -22,24 +22,6 @@ 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 { RenameAudit } from './rename-audit';
-// @ts-ignore
-import type { ReplaceAudit } from './replace-audit';
-// @ts-ignore
-import type { UpdateMetadataAudit } from './update-metadata-audit';
-// @ts-ignore
-import type { UploadAudit } from './upload-audit';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { DeleteAudit } from './delete-audit';
@@ -63,8 +45,8 @@ import type { UpdateMetadataAudit } from './update-metadata-audit';
 import type { UploadAudit } from './upload-audit';
 
 /**
- * @type AuditLogDetailsOneOf
+ * @type EnrichedAuditLogDetails
  */
-export type AuditLogDetailsOneOf = { type: 'copy' } & CopyAudit | { type: 'createFolder' } & CreateFolderAudit | { type: 'delete' } & DeleteAudit | { type: 'deleteMetadata' } & DeleteMetadataAudit | { type: 'move' } & MoveAudit | { type: 'rename' } & RenameAudit | { type: 'replace' } & ReplaceAudit | { type: 'updateMetadata' } & UpdateMetadataAudit | { type: 'upload' } & UploadAudit;
+export type EnrichedAuditLogDetails = { type: 'copy' } & CopyAudit | { type: 'createFolder' } & CreateFolderAudit | { type: 'delete' } & DeleteAudit | { type: 'deleteMetadata' } & DeleteMetadataAudit | { type: 'move' } & MoveAudit | { type: 'rename' } & RenameAudit | { type: 'replace' } & ReplaceAudit | { type: 'updateMetadata' } & UpdateMetadataAudit | { type: 'upload' } & UploadAudit;
 
 

package/models/{audit-log.ts → enriched-audit-log.ts}

@@ -15,23 +15,25 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import type { AuditLogDetailsOneOf } from './audit-log-details-one-of';
+import type { EnrichedAuditLogDetails } from './enriched-audit-log-details';
 
 /**
- * Audit information
+ * Audit information enriched with the actor (azp) provenance — EE only.
  */
-export interface AuditLog {
+export interface EnrichedAuditLog {
     'id'?: string;
     'timestamp'?: string;
     'username'?: string;
-    'action'?: AuditLogActionEnum;
-    'resourceType'?: AuditLogResourceTypeEnum;
-    'details'?: AuditLogDetailsOneOf;
+    'action'?: EnrichedAuditLogActionEnum;
+    'resourceType'?: EnrichedAuditLogResourceTypeEnum;
+    'details'?: EnrichedAuditLogDetails;
     'previousHash'?: string;
     'hash'?: string;
+    'azp'?: string;
+    'actedViaIntegration'?: boolean;
 }
 
-export const AuditLogActionEnum = {
+export const EnrichedAuditLogActionEnum = {
     CopyFile: 'COPY_FILE',
     CopyFileChild: 'COPY_FILE_CHILD',
     RenameFile: 'RENAME_FILE',
@@ -49,27 +51,36 @@ export const AuditLogActionEnum = {
     UpdateDocumentMetadata: 'UPDATE_DOCUMENT_METADATA',
     DownloadDocument: 'DOWNLOAD_DOCUMENT',
     DeleteDocumentMetadata: 'DELETE_DOCUMENT_METADATA',
-    ShareDocuments: 'SHARE_DOCUMENTS',
-    ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
-    ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
-    ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
     RestoreFile: 'RESTORE_FILE',
     RestoreFolder: 'RESTORE_FOLDER',
     PermanentDeleteFile: 'PERMANENT_DELETE_FILE',
     PermanentDeleteFolder: 'PERMANENT_DELETE_FOLDER',
+    EmptyRecycleBin: 'EMPTY_RECYCLE_BIN',
+    ChainGenesis: 'CHAIN_GENESIS',
     CommentCreate: 'COMMENT_CREATE',
     CommentUpdate: 'COMMENT_UPDATE',
     CommentDelete: 'COMMENT_DELETE',
-    EmptyRecycleBin: 'EMPTY_RECYCLE_BIN',
-    ChainGenesis: 'CHAIN_GENESIS'
+    ShareDocuments: 'SHARE_DOCUMENTS',
+    ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
+    ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
+    ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
+    DelegatedGrantRequested: 'DELEGATED_GRANT_REQUESTED',
+    DelegatedGrantAccepted: 'DELEGATED_GRANT_ACCEPTED',
+    DelegatedGrantDeclined: 'DELEGATED_GRANT_DECLINED',
+    DelegatedGrantRevoked: 'DELEGATED_GRANT_REVOKED',
+    DelegatedGrantExpired: 'DELEGATED_GRANT_EXPIRED',
+    DelegatedGrantConsumed: 'DELEGATED_GRANT_CONSUMED',
+    DelegatedGrantSubscriptionRevokedByAdmin: 'DELEGATED_GRANT_SUBSCRIPTION_REVOKED_BY_ADMIN',
+    DelegatedBrowse: 'DELEGATED_BROWSE',
+    AdminMonitoringOptOutChanged: 'ADMIN_MONITORING_OPT_OUT_CHANGED'
 } as const;
 
-export type AuditLogActionEnum = typeof AuditLogActionEnum[keyof typeof AuditLogActionEnum];
-export const AuditLogResourceTypeEnum = {
+export type EnrichedAuditLogActionEnum = typeof EnrichedAuditLogActionEnum[keyof typeof EnrichedAuditLogActionEnum];
+export const EnrichedAuditLogResourceTypeEnum = {
     File: 'FILE',
     Folder: 'FOLDER'
 } as const;
 
-export type AuditLogResourceTypeEnum = typeof AuditLogResourceTypeEnum[keyof typeof AuditLogResourceTypeEnum];
+export type EnrichedAuditLogResourceTypeEnum = typeof EnrichedAuditLogResourceTypeEnum[keyof typeof EnrichedAuditLogResourceTypeEnum];
 
 

package/models/index.ts

@@ -1,19 +1,21 @@
 export * from './ancestor-info';
-export * from './audit-log';
 export * from './audit-log-details';
-export * from './audit-log-details-one-of';
 export * from './audit-verification-result';
 export * from './broken-link';
 export * from './comment-dto';
+export * from './consume-delegated-grant-request';
 export * from './copy-audit';
 export * from './copy-request';
 export * from './copy-response';
 export * from './create-blank-document-request';
 export * from './create-comment-request';
+export * from './create-delegated-grant-request';
 export * from './create-folder-audit';
 export * from './create-folder-request';
 export * from './create-team-request';
 export * from './dashboard-statistics-response';
+export * from './delegated-folder-node';
+export * from './delegated-grant-dto';
 export * from './delete-audit';
 export * from './delete-metadata-audit';
 export * from './delete-metadata-request';
@@ -22,11 +24,14 @@ export * from './delete-share-request';
 export * from './document-info';
 export * from './document-position';
 export * from './element-info';
+export * from './enriched-audit-log';
+export * from './enriched-audit-log-details';
 export * from './file-type-stats';
 export * from './filter-input';
 export * from './folder-element-info';
 export * from './folder-response';
 export * from './ingestion-status-dto';
+export * from './mint-upload-token-request';
 export * from './move-audit';
 export * from './move-request';
 export * from './notification-dto';
@@ -55,8 +60,11 @@ export * from './update-comment-request';
 export * from './update-metadata-audit';
 export * from './update-metadata-request';
 export * from './update-team-request';
+export * from './update-user-privacy-request';
 export * from './update-user-request';
 export * from './upload-audit';
 export * from './upload-response';
+export * from './upload-token-response';
 export * from './user-preferences-request';
+export * from './user-privacy-dto';
 export * from './user-registration-request';

package/models/mint-upload-token-request.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 MintUploadTokenRequest {
+    'targetFolderId': string;
+    'maxSizeBytes'?: number;
+    'allowedMimeTypes': Array<string>;
+    'ttlSeconds'?: number;
+}
+

package/models/notification-dto.ts

@@ -30,7 +30,10 @@ export const NotificationDTOTypeEnum = {
     NewShare: 'NEW_SHARE',
     Mention: 'MENTION',
     ShareRequest: 'SHARE_REQUEST',
-    VirusDetected: 'VIRUS_DETECTED'
+    VirusDetected: 'VIRUS_DETECTED',
+    DelegatedGrantRequested: 'DELEGATED_GRANT_REQUESTED',
+    DelegatedGrantConsumed: 'DELEGATED_GRANT_CONSUMED',
+    DelegatedGrantExpired: 'DELEGATED_GRANT_EXPIRED'
 } as const;
 
 export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];