@openfilz-sdk/typescript-ee 1.3.5 → 1.4.1

package/docs/{AuditControllerApi.md → CollaborationAuditControllerApi.md}

@@ -1,28 +1,28 @@
-# AuditControllerApi
+# CollaborationAuditControllerApi
 
 All URIs are relative to *http://localhost:8081*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getAuditTrail**](#getaudittrail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource|
-|[**searchAuditTrail**](#searchaudittrail) | **POST** /api/v1/audit/search | Search for audit trails|
+|[**getAuditTrail**](#getaudittrail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource (enriched with actor azp)|
+|[**searchAuditTrail**](#searchaudittrail) | **POST** /api/v1/audit/search | Search audit trail (enriched with actor azp)|
 |[**verifyChain**](#verifychain) | **GET** /api/v1/audit/verify | Verify audit chain integrity|
 
 # **getAuditTrail**
-> Array<AuditLog> getAuditTrail()
+> Array<EnrichedAuditLog> getAuditTrail()
 
-Retrieves the audit trail for a given resource.
+EE variant — adds `azp` and `actedViaIntegration` to every row when the audit was authorized via an integration JWT.
 
 ### Example
 
 ```typescript
 import {
-    AuditControllerApi,
+    CollaborationAuditControllerApi,
     Configuration
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new AuditControllerApi(configuration);
+const apiInstance = new CollaborationAuditControllerApi(configuration);
 
 let id: string; //ID of the resource to get the audit trail for (default to undefined)
 let sort: 'ASC' | 'DESC'; //Sort order for the audit trail. Can be \'ASC\' or \'DESC\'. Default is \'DESC\' (optional) (default to undefined)
@@ -43,7 +43,7 @@ const { status, data } = await apiInstance.getAuditTrail(
 
 ### Return type
 
-**Array<AuditLog>**
+**Array<EnrichedAuditLog>**
 
 ### Authorization
 
@@ -63,21 +63,21 @@ const { status, data } = await apiInstance.getAuditTrail(
 [[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)
 
 # **searchAuditTrail**
-> Array<AuditLog> searchAuditTrail(searchByAuditLogRequest)
+> Array<EnrichedAuditLog> searchAuditTrail(searchByAuditLogRequest)
 
-Retrieves the audit trail according to the search parameters
+EE variant — same as core, returns rows enriched with actor azp.
 
 ### Example
 
 ```typescript
 import {
-    AuditControllerApi,
+    CollaborationAuditControllerApi,
     Configuration,
     SearchByAuditLogRequest
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new AuditControllerApi(configuration);
+const apiInstance = new CollaborationAuditControllerApi(configuration);
 
 let searchByAuditLogRequest: SearchByAuditLogRequest; //
 
@@ -95,7 +95,7 @@ const { status, data } = await apiInstance.searchAuditTrail(
 
 ### Return type
 
-**Array<AuditLog>**
+**Array<EnrichedAuditLog>**
 
 ### Authorization
 
@@ -117,18 +117,18 @@ const { status, data } = await apiInstance.searchAuditTrail(
 # **verifyChain**
 > AuditVerificationResult verifyChain()
 
-Verifies the cryptographic hash chain of the audit log to detect any tampering.
+Verifies the cryptographic hash chain of the audit log. Identical to the core variant — actor enrichment is read-side only and does not affect chain hashes.
 
 ### Example
 
 ```typescript
 import {
-    AuditControllerApi,
+    CollaborationAuditControllerApi,
     Configuration
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new AuditControllerApi(configuration);
+const apiInstance = new CollaborationAuditControllerApi(configuration);
 
 const { status, data } = await apiInstance.verifyChain();
 ```

package/docs/ConsumeDelegatedGrantRequest.md

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

@@ -0,0 +1,26 @@
+# CreateDelegatedGrantRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**grantor** | **string** |  | [default to undefined]
+**purpose** | **string** |  | [default to undefined]
+**note** | **string** |  | [optional] [default to undefined]
+**targetUrl** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateDelegatedGrantRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: CreateDelegatedGrantRequest = {
+    grantor,
+    purpose,
+    note,
+    targetUrl,
+};
+```
+
+[[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/DelegatedBrowseGrantsAdminApi.md

@@ -0,0 +1,275 @@
+# DelegatedBrowseGrantsAdminApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**browseFolders**](#browsefolders) | **GET** /api/v1/admin/delegated/folders | Browse folders on behalf of the grantor|
+|[**consume**](#consume) | **POST** /api/v1/admin/delegated/grants/{id}/consume | Mark grant as consumed|
+|[**getGrant**](#getgrant) | **GET** /api/v1/admin/delegated/grants/{id} | Poll grant status|
+|[**listMine**](#listmine) | **GET** /api/v1/admin/delegated/grants | List grants I requested|
+|[**requestGrant**](#requestgrant) | **POST** /api/v1/admin/delegated/grants | Request a grant|
+
+# **browseFolders**
+> Array<DelegatedFolderNode> browseFolders()
+
+List folders under {parent} in the grantor\'s tree. Omit {parent} to list the grantor\'s root-level folders. Returns only name/id/hasChildren — no files, no metadata, no content-types.
+
+### Example
+
+```typescript
+import {
+    DelegatedBrowseGrantsAdminApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DelegatedBrowseGrantsAdminApi(configuration);
+
+let grantId: string; // (default to undefined)
+let parent: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.browseFolders(
+    grantId,
+    parent
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **grantId** | [**string**] |  | defaults to undefined|
+| **parent** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<DelegatedFolderNode>**
+
+### 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)
+
+# **consume**
+> DelegatedGrantDTO consume(consumeDelegatedGrantRequest)
+
+Flip an ACCEPTED grant to CONSUMED after using it to create a webhook. Single-use: subsequent browse calls return 410 Gone.
+
+### Example
+
+```typescript
+import {
+    DelegatedBrowseGrantsAdminApi,
+    Configuration,
+    ConsumeDelegatedGrantRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DelegatedBrowseGrantsAdminApi(configuration);
+
+let id: string; // (default to undefined)
+let consumeDelegatedGrantRequest: ConsumeDelegatedGrantRequest; //
+
+const { status, data } = await apiInstance.consume(
+    id,
+    consumeDelegatedGrantRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **consumeDelegatedGrantRequest** | **ConsumeDelegatedGrantRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DelegatedGrantDTO**
+
+### 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)
+
+# **getGrant**
+> DelegatedGrantDTO getGrant()
+
+Admin UI polls this after creation to learn when the grantor has accepted/declined. 404 if the grant isn\'t yours.
+
+### Example
+
+```typescript
+import {
+    DelegatedBrowseGrantsAdminApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DelegatedBrowseGrantsAdminApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getGrant(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DelegatedGrantDTO**
+
+### 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)
+
+# **listMine**
+> Array<DelegatedGrantDTO> listMine()
+
+Optionally filter by ?status=PENDING|ACCEPTED|...
+
+### Example
+
+```typescript
+import {
+    DelegatedBrowseGrantsAdminApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DelegatedBrowseGrantsAdminApi(configuration);
+
+let status: 'PENDING' | 'ACCEPTED' | 'DECLINED' | 'REVOKED' | 'EXPIRED' | 'CONSUMED'; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listMine(
+    status
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **status** | [**&#39;PENDING&#39; | &#39;ACCEPTED&#39; | &#39;DECLINED&#39; | &#39;REVOKED&#39; | &#39;EXPIRED&#39; | &#39;CONSUMED&#39;**]**Array<&#39;PENDING&#39; &#124; &#39;ACCEPTED&#39; &#124; &#39;DECLINED&#39; &#124; &#39;REVOKED&#39; &#124; &#39;EXPIRED&#39; &#124; &#39;CONSUMED&#39;>** |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<DelegatedGrantDTO>**
+
+### 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)
+
+# **requestGrant**
+> DelegatedGrantDTO requestGrant(createDelegatedGrantRequest)
+
+Create a PENDING grant. Notifies the grantor via in-app + email. Grantor has 15 min to accept or the grant auto-expires.
+
+### Example
+
+```typescript
+import {
+    DelegatedBrowseGrantsAdminApi,
+    Configuration,
+    CreateDelegatedGrantRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DelegatedBrowseGrantsAdminApi(configuration);
+
+let createDelegatedGrantRequest: CreateDelegatedGrantRequest; //
+
+const { status, data } = await apiInstance.requestGrant(
+    createDelegatedGrantRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createDelegatedGrantRequest** | **CreateDelegatedGrantRequest**|  | |
+
+
+### Return type
+
+**DelegatedGrantDTO**
+
+### 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/DelegatedBrowseGrantsEndUserApi.md

@@ -0,0 +1,266 @@
+# DelegatedBrowseGrantsEndUserApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**accept**](#accept) | **POST** /api/v1/users/me/delegated/grants/{id}/accept | Approve a pending grant|
+|[**decline**](#decline) | **POST** /api/v1/users/me/delegated/grants/{id}/decline | Refuse a pending grant|
+|[**disableLinkedWebhook**](#disablelinkedwebhook) | **POST** /api/v1/users/me/delegated/grants/{id}/disable-webhook | Disable the webhook created from this grant|
+|[**listIncoming**](#listincoming) | **GET** /api/v1/users/me/delegated/grants | List grants addressed to me|
+|[**revoke**](#revoke) | **POST** /api/v1/users/me/delegated/grants/{id}/revoke | Revoke an accepted grant|
+
+# **accept**
+> DelegatedGrantDTO accept()
+
+Flip PENDING → ACCEPTED. Admin may then browse my folders for the next 2 hours. Client MUST force a step-up (prompt=login) before calling this — a valid session alone is NOT enough security to approve cross-user browsing.
+
+### Example
+
+```typescript
+import {
+    DelegatedBrowseGrantsEndUserApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DelegatedBrowseGrantsEndUserApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.accept(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DelegatedGrantDTO**
+
+### 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)
+
+# **decline**
+> DelegatedGrantDTO decline()
+
+
+### Example
+
+```typescript
+import {
+    DelegatedBrowseGrantsEndUserApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DelegatedBrowseGrantsEndUserApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.decline(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DelegatedGrantDTO**
+
+### 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)
+
+# **disableLinkedWebhook**
+> DelegatedGrantDTO disableLinkedWebhook()
+
+Grantor-only consent withdrawal. Requires status = CONSUMED. Deletes the linked webhook subscription via webhooks-api; the grant row stays CONSUMED with consumedSubscriptionId preserved as an audit pointer. 409 if the grant is not CONSUMED or has no linked subscription id.
+
+### Example
+
+```typescript
+import {
+    DelegatedBrowseGrantsEndUserApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DelegatedBrowseGrantsEndUserApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.disableLinkedWebhook(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DelegatedGrantDTO**
+
+### 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)
+
+# **listIncoming**
+> Array<DelegatedGrantDTO> listIncoming()
+
+Optionally filter by ?status=PENDING|ACCEPTED|...
+
+### Example
+
+```typescript
+import {
+    DelegatedBrowseGrantsEndUserApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DelegatedBrowseGrantsEndUserApi(configuration);
+
+let status: 'PENDING' | 'ACCEPTED' | 'DECLINED' | 'REVOKED' | 'EXPIRED' | 'CONSUMED'; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listIncoming(
+    status
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **status** | [**&#39;PENDING&#39; | &#39;ACCEPTED&#39; | &#39;DECLINED&#39; | &#39;REVOKED&#39; | &#39;EXPIRED&#39; | &#39;CONSUMED&#39;**]**Array<&#39;PENDING&#39; &#124; &#39;ACCEPTED&#39; &#124; &#39;DECLINED&#39; &#124; &#39;REVOKED&#39; &#124; &#39;EXPIRED&#39; &#124; &#39;CONSUMED&#39;>** |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<DelegatedGrantDTO>**
+
+### 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)
+
+# **revoke**
+> DelegatedGrantDTO revoke()
+
+Flip ACCEPTED → REVOKED. Immediate — any in-flight admin browse becomes 410 on its next call.
+
+### Example
+
+```typescript
+import {
+    DelegatedBrowseGrantsEndUserApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DelegatedBrowseGrantsEndUserApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.revoke(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DelegatedGrantDTO**
+
+### 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)
+