@openfilz-sdk/typescript-ee 1.3.5 → 1.4.1

package/docs/DelegatedFolderNode.md

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

@@ -0,0 +1,52 @@
+# DelegatedGrantDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**grantor** | **string** |  | [optional] [default to undefined]
+**grantee** | **string** |  | [optional] [default to undefined]
+**purpose** | **string** |  | [optional] [default to undefined]
+**purposeNote** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**acceptDeadline** | **string** |  | [optional] [default to undefined]
+**useDeadline** | **string** |  | [optional] [default to undefined]
+**acceptedAt** | **string** |  | [optional] [default to undefined]
+**declinedAt** | **string** |  | [optional] [default to undefined]
+**revokedAt** | **string** |  | [optional] [default to undefined]
+**consumedAt** | **string** |  | [optional] [default to undefined]
+**consumedSubscriptionId** | **string** |  | [optional] [default to undefined]
+**consumedFolderId** | **string** |  | [optional] [default to undefined]
+**targetUrl** | **string** |  | [optional] [default to undefined]
+**subscriptionRevokedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DelegatedGrantDTO } from '@openfilz-sdk/typescript-ee';
+
+const instance: DelegatedGrantDTO = {
+    id,
+    grantor,
+    grantee,
+    purpose,
+    purposeNote,
+    status,
+    createdAt,
+    acceptDeadline,
+    useDeadline,
+    acceptedAt,
+    declinedAt,
+    revokedAt,
+    consumedAt,
+    consumedSubscriptionId,
+    consumedFolderId,
+    targetUrl,
+    subscriptionRevokedAt,
+};
+```
+
+[[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/{AuditLog.md → EnrichedAuditLog.md}

@@ -1,6 +1,6 @@
-# AuditLog
+# EnrichedAuditLog
 
-Audit information
+Audit information enriched with the actor (azp) provenance — EE only.
 
 ## Properties
 
@@ -11,16 +11,18 @@ Name | Type | Description | Notes
 **username** | **string** |  | [optional] [default to undefined]
 **action** | **string** |  | [optional] [default to undefined]
 **resourceType** | **string** |  | [optional] [default to undefined]
-**details** | [**AuditLogDetailsOneOf**](AuditLogDetailsOneOf.md) |  | [optional] [default to undefined]
+**details** | [**EnrichedAuditLogDetails**](EnrichedAuditLogDetails.md) |  | [optional] [default to undefined]
 **previousHash** | **string** |  | [optional] [default to undefined]
 **hash** | **string** |  | [optional] [default to undefined]
+**azp** | **string** |  | [optional] [default to undefined]
+**actedViaIntegration** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { AuditLog } from '@openfilz-sdk/typescript-ee';
+import { EnrichedAuditLog } from '@openfilz-sdk/typescript-ee';
 
-const instance: AuditLog = {
+const instance: EnrichedAuditLog = {
     id,
     timestamp,
     username,
@@ -29,6 +31,8 @@ const instance: AuditLog = {
     details,
     previousHash,
     hash,
+    azp,
+    actedViaIntegration,
 };
 ```
 

package/docs/{AuditLogDetailsOneOf.md → EnrichedAuditLogDetails.md}

@@ -1,4 +1,4 @@
-# AuditLogDetailsOneOf
+# EnrichedAuditLogDetails
 
 
 ## Properties
@@ -21,9 +21,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { AuditLogDetailsOneOf } from '@openfilz-sdk/typescript-ee';
+import { EnrichedAuditLogDetails } from '@openfilz-sdk/typescript-ee';
 
-const instance: AuditLogDetailsOneOf = {
+const instance: EnrichedAuditLogDetails = {
     type,
     sourceFileId,
     targetFolderId,

package/docs/MintUploadTokenRequest.md

@@ -0,0 +1,26 @@
+# MintUploadTokenRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**targetFolderId** | **string** |  | [default to undefined]
+**maxSizeBytes** | **number** |  | [optional] [default to undefined]
+**allowedMimeTypes** | **Array<string>** |  | [default to undefined]
+**ttlSeconds** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MintUploadTokenRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: MintUploadTokenRequest = {
+    targetFolderId,
+    maxSizeBytes,
+    allowedMimeTypes,
+    ttlSeconds,
+};
+```
+
+[[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/UpdateUserPrivacyRequest.md

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

@@ -0,0 +1,115 @@
+# UploadTokenControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**mintUploadToken**](#mintuploadtoken) | **POST** /api/v1/upload-tokens | Mint a scoped upload token|
+|[**uploadWithToken**](#uploadwithtoken) | **POST** /api/v1/upload-tokens/upload | Upload a single document with a scoped upload token|
+
+# **mintUploadToken**
+> UploadTokenResponse mintUploadToken(mintUploadTokenRequest)
+
+Issues a one-shot HS256 JWT scoped to a single upload into a single folder. Caller must hold the UPLOAD_TOKEN_ISSUER realm role.
+
+### Example
+
+```typescript
+import {
+    UploadTokenControllerApi,
+    Configuration,
+    MintUploadTokenRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new UploadTokenControllerApi(configuration);
+
+let mintUploadTokenRequest: MintUploadTokenRequest; //
+
+const { status, data } = await apiInstance.mintUploadToken(
+    mintUploadTokenRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mintUploadTokenRequest** | **MintUploadTokenRequest**|  | |
+
+
+### Return type
+
+**UploadTokenResponse**
+
+### 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)
+
+# **uploadWithToken**
+> UploadResponse uploadWithToken()
+
+Anonymous-callable endpoint authenticated by the scoped JWT minted via POST /api/v1/upload-tokens. Forces the target folder to the one baked into the token. One-shot — replays return 401.
+
+### Example
+
+```typescript
+import {
+    UploadTokenControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new UploadTokenControllerApi(configuration);
+
+let file: File; // (default to undefined)
+let metadata: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.uploadWithToken(
+    file,
+    metadata
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **file** | [**File**] |  | defaults to undefined|
+| **metadata** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**UploadResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **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/UploadTokenResponse.md

@@ -0,0 +1,28 @@
+# UploadTokenResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **string** |  | [optional] [default to undefined]
+**expiresAt** | **string** |  | [optional] [default to undefined]
+**uploadUrl** | **string** |  | [optional] [default to undefined]
+**targetFolderId** | **string** |  | [optional] [default to undefined]
+**maxSizeBytes** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UploadTokenResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: UploadTokenResponse = {
+    token,
+    expiresAt,
+    uploadUrl,
+    targetFolderId,
+    maxSizeBytes,
+};
+```
+
+[[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/UserPrivacyApi.md

@@ -0,0 +1,104 @@
+# UserPrivacyApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**get**](#get) | **GET** /api/v1/users/me/privacy | Read my privacy preferences|
+|[**update**](#update) | **PUT** /api/v1/users/me/privacy | Update my privacy preferences|
+
+# **get**
+> UserPrivacyDTO get()
+
+
+### Example
+
+```typescript
+import {
+    UserPrivacyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new UserPrivacyApi(configuration);
+
+const { status, data } = await apiInstance.get();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**UserPrivacyDTO**
+
+### 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)
+
+# **update**
+> UserPrivacyDTO update(updateUserPrivacyRequest)
+
+Idempotent. Audits ADMIN_MONITORING_OPT_OUT_CHANGED only when the value actually changes — repeated PUTs with the same flag are silent.
+
+### Example
+
+```typescript
+import {
+    UserPrivacyApi,
+    Configuration,
+    UpdateUserPrivacyRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new UserPrivacyApi(configuration);
+
+let updateUserPrivacyRequest: UpdateUserPrivacyRequest; //
+
+const { status, data } = await apiInstance.update(
+    updateUserPrivacyRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateUserPrivacyRequest** | **UpdateUserPrivacyRequest**|  | |
+
+
+### Return type
+
+**UserPrivacyDTO**
+
+### 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/UserPrivacyDTO.md

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