@openfilz-sdk/typescript-ee 1.13.4 → 1.14.1

package/docs/SharingPolicyApi.md

@@ -0,0 +1,988 @@
+# SharingPolicyApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**adminGetEffectiveSharingPolicy**](#admingeteffectivesharingpolicy) | **GET** /api/v1/admin/sharing-policy/effective/{userId} | A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)|
+|[**adminGetSharingPolicy**](#admingetsharingpolicy) | **GET** /api/v1/admin/sharing-policy | The global mode, allowed domains, e-Sign switch, locked keys and number of overrides|
+|[**adminGetSharingPolicyRevokeJob**](#admingetsharingpolicyrevokejob) | **GET** /api/v1/admin/sharing-policy/violations/revoke/{jobId} | Progress of a background revocation|
+|[**adminListSharingPolicyOverrides**](#adminlistsharingpolicyoverrides) | **GET** /api/v1/admin/sharing-policy/overrides | Users and teams with their own sharing rule|
+|[**adminListSharingPolicyViolations**](#adminlistsharingpolicyviolations) | **GET** /api/v1/admin/sharing-policy/violations | Existing shares the current policies refuse|
+|[**adminRemoveSharingPolicyOverride**](#adminremovesharingpolicyoverride) | **DELETE** /api/v1/admin/sharing-policy/overrides/{subjectId} | Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)|
+|[**adminRevokeSharingPolicyViolations**](#adminrevokesharingpolicyviolations) | **POST** /api/v1/admin/sharing-policy/violations/revoke | Revoke shares that break the policy|
+|[**adminSetSharingPolicyGlobal**](#adminsetsharingpolicyglobal) | **PUT** /api/v1/admin/sharing-policy/global | Change the global mode, allowed domains and e-Sign switch|
+|[**adminSetSharingPolicyOverride**](#adminsetsharingpolicyoverride) | **PUT** /api/v1/admin/sharing-policy/overrides/{subjectId} | Set a user\'s or a team\'s sharing rule|
+|[**getEffectiveSharingPolicy**](#geteffectivesharingpolicy) | **GET** /api/v1/users/sharing-policy/effective/{userId} | A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)|
+|[**getMySharingPolicy**](#getmysharingpolicy) | **GET** /api/v1/users/me/sharing-policy | The caller\'s own sharing rule (for the share dialog)|
+|[**getSharingPolicy**](#getsharingpolicy) | **GET** /api/v1/users/sharing-policy | The global mode, allowed domains, e-Sign switch, locked keys and number of overrides|
+|[**getSharingPolicyRevokeJob**](#getsharingpolicyrevokejob) | **GET** /api/v1/users/sharing-policy/violations/revoke/{jobId} | Progress of a background revocation|
+|[**listSharingPolicyOverrides**](#listsharingpolicyoverrides) | **GET** /api/v1/users/sharing-policy/overrides | Users and teams with their own sharing rule|
+|[**listSharingPolicyViolations**](#listsharingpolicyviolations) | **GET** /api/v1/users/sharing-policy/violations | Existing shares the current policies refuse|
+|[**removeSharingPolicyOverride**](#removesharingpolicyoverride) | **DELETE** /api/v1/users/sharing-policy/overrides/{subjectId} | Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)|
+|[**revokeSharingPolicyViolations**](#revokesharingpolicyviolations) | **POST** /api/v1/users/sharing-policy/violations/revoke | Revoke shares that break the policy|
+|[**setSharingPolicyGlobal**](#setsharingpolicyglobal) | **PUT** /api/v1/users/sharing-policy/global | Change the global mode, allowed domains and e-Sign switch|
+|[**setSharingPolicyOverride**](#setsharingpolicyoverride) | **PUT** /api/v1/users/sharing-policy/overrides/{subjectId} | Set a user\'s or a team\'s sharing rule|
+
+# **adminGetEffectiveSharingPolicy**
+> EffectivePolicy adminGetEffectiveSharingPolicy()
+
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let userId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.adminGetEffectiveSharingPolicy(
+    userId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**EffectivePolicy**
+
+### 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)
+
+# **adminGetSharingPolicy**
+> GlobalPolicy adminGetSharingPolicy()
+
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+const { status, data } = await apiInstance.adminGetSharingPolicy();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GlobalPolicy**
+
+### 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)
+
+# **adminGetSharingPolicyRevokeJob**
+> RevokeResult adminGetSharingPolicyRevokeJob()
+
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let jobId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.adminGetSharingPolicyRevokeJob(
+    jobId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **jobId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**RevokeResult**
+
+### 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)
+
+# **adminListSharingPolicyOverrides**
+> Array<OverrideView> adminListSharingPolicyOverrides()
+
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let type: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.adminListSharingPolicyOverrides(
+    type
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **type** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<OverrideView>**
+
+### 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)
+
+# **adminListSharingPolicyViolations**
+> ViolationsResponse adminListSharingPolicyViolations()
+
+Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let cursor: string; // (optional) (default to undefined)
+let size: number; // (optional) (default to 50)
+let count: boolean; // (optional) (default to false)
+
+const { status, data } = await apiInstance.adminListSharingPolicyViolations(
+    cursor,
+    size,
+    count
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cursor** | [**string**] |  | (optional) defaults to undefined|
+| **size** | [**number**] |  | (optional) defaults to 50|
+| **count** | [**boolean**] |  | (optional) defaults to false|
+
+
+### Return type
+
+**ViolationsResponse**
+
+### 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)
+
+# **adminRemoveSharingPolicyOverride**
+> adminRemoveSharingPolicyOverride()
+
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let subjectId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.adminRemoveSharingPolicyOverride(
+    subjectId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **subjectId** | [**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)
+
+# **adminRevokeSharingPolicyViolations**
+> RevokeResult adminRevokeSharingPolicyViolations(revokeRequest)
+
+items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration,
+    RevokeRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let revokeRequest: RevokeRequest; //
+
+const { status, data } = await apiInstance.adminRevokeSharingPolicyViolations(
+    revokeRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **revokeRequest** | **RevokeRequest**|  | |
+
+
+### Return type
+
+**RevokeResult**
+
+### 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)
+
+# **adminSetSharingPolicyGlobal**
+> GlobalPolicy adminSetSharingPolicyGlobal(globalPolicy)
+
+Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration,
+    GlobalPolicy
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let globalPolicy: GlobalPolicy; //
+
+const { status, data } = await apiInstance.adminSetSharingPolicyGlobal(
+    globalPolicy
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **globalPolicy** | **GlobalPolicy**|  | |
+
+
+### Return type
+
+**GlobalPolicy**
+
+### 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)
+
+# **adminSetSharingPolicyOverride**
+> OverrideView adminSetSharingPolicyOverride(overrideRequest)
+
+A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration,
+    OverrideRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let subjectId: string; // (default to undefined)
+let overrideRequest: OverrideRequest; //
+
+const { status, data } = await apiInstance.adminSetSharingPolicyOverride(
+    subjectId,
+    overrideRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **overrideRequest** | **OverrideRequest**|  | |
+| **subjectId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**OverrideView**
+
+### 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)
+
+# **getEffectiveSharingPolicy**
+> EffectivePolicy getEffectiveSharingPolicy()
+
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let userId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getEffectiveSharingPolicy(
+    userId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**EffectivePolicy**
+
+### 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)
+
+# **getMySharingPolicy**
+> MyPolicy getMySharingPolicy()
+
+The allowed domains are listed only when the rule restricts domains.
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+const { status, data } = await apiInstance.getMySharingPolicy();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**MyPolicy**
+
+### 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)
+
+# **getSharingPolicy**
+> GlobalPolicy getSharingPolicy()
+
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+const { status, data } = await apiInstance.getSharingPolicy();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GlobalPolicy**
+
+### 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)
+
+# **getSharingPolicyRevokeJob**
+> RevokeResult getSharingPolicyRevokeJob()
+
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let jobId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getSharingPolicyRevokeJob(
+    jobId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **jobId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**RevokeResult**
+
+### 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)
+
+# **listSharingPolicyOverrides**
+> Array<OverrideView> listSharingPolicyOverrides()
+
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let type: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listSharingPolicyOverrides(
+    type
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **type** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<OverrideView>**
+
+### 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)
+
+# **listSharingPolicyViolations**
+> ViolationsResponse listSharingPolicyViolations()
+
+Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let cursor: string; // (optional) (default to undefined)
+let size: number; // (optional) (default to 50)
+let count: boolean; // (optional) (default to false)
+
+const { status, data } = await apiInstance.listSharingPolicyViolations(
+    cursor,
+    size,
+    count
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cursor** | [**string**] |  | (optional) defaults to undefined|
+| **size** | [**number**] |  | (optional) defaults to 50|
+| **count** | [**boolean**] |  | (optional) defaults to false|
+
+
+### Return type
+
+**ViolationsResponse**
+
+### 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)
+
+# **removeSharingPolicyOverride**
+> removeSharingPolicyOverride()
+
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let subjectId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.removeSharingPolicyOverride(
+    subjectId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **subjectId** | [**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)
+
+# **revokeSharingPolicyViolations**
+> RevokeResult revokeSharingPolicyViolations(revokeRequest)
+
+items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration,
+    RevokeRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let revokeRequest: RevokeRequest; //
+
+const { status, data } = await apiInstance.revokeSharingPolicyViolations(
+    revokeRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **revokeRequest** | **RevokeRequest**|  | |
+
+
+### Return type
+
+**RevokeResult**
+
+### 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)
+
+# **setSharingPolicyGlobal**
+> GlobalPolicy setSharingPolicyGlobal(globalPolicy)
+
+Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration,
+    GlobalPolicy
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let globalPolicy: GlobalPolicy; //
+
+const { status, data } = await apiInstance.setSharingPolicyGlobal(
+    globalPolicy
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **globalPolicy** | **GlobalPolicy**|  | |
+
+
+### Return type
+
+**GlobalPolicy**
+
+### 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)
+
+# **setSharingPolicyOverride**
+> OverrideView setSharingPolicyOverride(overrideRequest)
+
+A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
+
+### Example
+
+```typescript
+import {
+    SharingPolicyApi,
+    Configuration,
+    OverrideRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SharingPolicyApi(configuration);
+
+let subjectId: string; // (default to undefined)
+let overrideRequest: OverrideRequest; //
+
+const { status, data } = await apiInstance.setSharingPolicyOverride(
+    subjectId,
+    overrideRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **overrideRequest** | **OverrideRequest**|  | |
+| **subjectId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**OverrideView**
+
+### 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)
+