@openfilz-sdk/typescript-ee 1.9.11 → 1.10.0

package/docs/AiArchivingAdminControllerApi.md

@@ -0,0 +1,365 @@
+# AiArchivingAdminControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**create4**](#create4) | **POST** /api/v1/admin/ai/archiving/schedules | Create an archiving schedule|
+|[**delete3**](#delete3) | **DELETE** /api/v1/admin/ai/archiving/schedules/{id} | Delete an archiving schedule|
+|[**get7**](#get7) | **GET** /api/v1/admin/ai/archiving/schedules/{id} | Get an archiving schedule|
+|[**propose**](#propose) | **POST** /api/v1/admin/ai/archiving/propose | Propose an archiving plan now (admin only)|
+|[**run1**](#run1) | **POST** /api/v1/admin/ai/archiving/schedules/{id}/run | Run an archiving schedule now|
+|[**schedules**](#schedules) | **GET** /api/v1/admin/ai/archiving/schedules | List archiving schedules|
+|[**update4**](#update4) | **PUT** /api/v1/admin/ai/archiving/schedules/{id} | Update an archiving schedule|
+
+# **create4**
+> ArchivingScheduleView create4(archivingScheduleRequest)
+
+
+### Example
+
+```typescript
+import {
+    AiArchivingAdminControllerApi,
+    Configuration,
+    ArchivingScheduleRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AiArchivingAdminControllerApi(configuration);
+
+let archivingScheduleRequest: ArchivingScheduleRequest; //
+
+const { status, data } = await apiInstance.create4(
+    archivingScheduleRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **archivingScheduleRequest** | **ArchivingScheduleRequest**|  | |
+
+
+### Return type
+
+**ArchivingScheduleView**
+
+### 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 |
+|-------------|-------------|------------------|
+|**201** | Created |  -  |
+
+[[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)
+
+# **delete3**
+> delete3()
+
+
+### Example
+
+```typescript
+import {
+    AiArchivingAdminControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AiArchivingAdminControllerApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.delete3(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**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 |
+|-------------|-------------|------------------|
+|**204** | No Content |  -  |
+
+[[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)
+
+# **get7**
+> ArchivingScheduleView get7()
+
+
+### Example
+
+```typescript
+import {
+    AiArchivingAdminControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AiArchivingAdminControllerApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.get7(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ArchivingScheduleView**
+
+### 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)
+
+# **propose**
+> ArchivingProposalResult propose(archivingProposalRequest)
+
+Selects the active documents under the root untouched for N months (legal hold excluded, capped) and creates a PROPOSED reorganisation plan as ownerEmail. Nothing is moved.
+
+### Example
+
+```typescript
+import {
+    AiArchivingAdminControllerApi,
+    Configuration,
+    ArchivingProposalRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AiArchivingAdminControllerApi(configuration);
+
+let archivingProposalRequest: ArchivingProposalRequest; //
+
+const { status, data } = await apiInstance.propose(
+    archivingProposalRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **archivingProposalRequest** | **ArchivingProposalRequest**|  | |
+
+
+### Return type
+
+**ArchivingProposalResult**
+
+### 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)
+
+# **run1**
+> ArchivingProposalResult run1()
+
+Produces one PROPOSED plan for the schedule\'s owner and records the outcome on the schedule.
+
+### Example
+
+```typescript
+import {
+    AiArchivingAdminControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AiArchivingAdminControllerApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.run1(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ArchivingProposalResult**
+
+### 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)
+
+# **schedules**
+> Array<ArchivingScheduleView> schedules()
+
+
+### Example
+
+```typescript
+import {
+    AiArchivingAdminControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AiArchivingAdminControllerApi(configuration);
+
+const { status, data } = await apiInstance.schedules();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ArchivingScheduleView>**
+
+### 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)
+
+# **update4**
+> ArchivingScheduleView update4(archivingScheduleRequest)
+
+
+### Example
+
+```typescript
+import {
+    AiArchivingAdminControllerApi,
+    Configuration,
+    ArchivingScheduleRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AiArchivingAdminControllerApi(configuration);
+
+let id: string; // (default to undefined)
+let archivingScheduleRequest: ArchivingScheduleRequest; //
+
+const { status, data } = await apiInstance.update4(
+    id,
+    archivingScheduleRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **archivingScheduleRequest** | **ArchivingScheduleRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ArchivingScheduleView**
+
+### 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/AiCloudUsageAdminControllerApi.md

@@ -0,0 +1,52 @@
+# AiCloudUsageAdminControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**cloudUsage**](#cloudusage) | **GET** /api/v1/admin/ai/cloud-usage | OpenFilz Cloud AI usage of this deployment for the current month (admin only)|
+
+# **cloudUsage**
+> AiCloudUsageView cloudUsage()
+
+Documents used against the monthly quota, budget used in percent, whether the gateway is currently refusing new documents, and the key expiry. status = NOT_CONFIGURED when the deployment does not use openfilz-cloud, KEY_REJECTED when the gateway refuses the key, UNREACHABLE when it cannot be reached. Cached 60 s.
+
+### Example
+
+```typescript
+import {
+    AiCloudUsageAdminControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AiCloudUsageAdminControllerApi(configuration);
+
+const { status, data } = await apiInstance.cloudUsage();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AiCloudUsageView**
+
+### 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)
+

package/docs/AiCloudUsageView.md

@@ -0,0 +1,44 @@
+# AiCloudUsageView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**configured** | **boolean** |  | [optional] [default to undefined]
+**available** | **boolean** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**month** | **string** |  | [optional] [default to undefined]
+**documents** | **number** |  | [optional] [default to undefined]
+**monthlyDocumentQuota** | **number** |  | [optional] [default to undefined]
+**documentsUsedPercent** | **number** |  | [optional] [default to undefined]
+**budgetUsedPercent** | **number** |  | [optional] [default to undefined]
+**hardCap** | **boolean** |  | [optional] [default to undefined]
+**blocked** | **boolean** |  | [optional] [default to undefined]
+**periodEnd** | **string** |  | [optional] [default to undefined]
+**expiresAt** | **string** |  | [optional] [default to undefined]
+**tenantStatus** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiCloudUsageView } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiCloudUsageView = {
+    configured,
+    available,
+    status,
+    month,
+    documents,
+    monthlyDocumentQuota,
+    documentsUsedPercent,
+    budgetUsedPercent,
+    hardCap,
+    blocked,
+    periodEnd,
+    expiresAt,
+    tenantStatus,
+};
+```
+
+[[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/AiGovernanceSettings.md

@@ -0,0 +1,36 @@
+# AiGovernanceSettings
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**insightsEnabled** | **boolean** |  | [optional] [default to undefined]
+**autoFileEnabled** | **boolean** |  | [optional] [default to undefined]
+**modelAllowed** | **boolean** |  | [optional] [default to undefined]
+**blockedCategories** | **Array<string>** |  | [optional] [default to undefined]
+**insightsDisabledTeamIds** | **Array<string>** |  | [optional] [default to undefined]
+**autoFileDisabledTeamIds** | **Array<string>** |  | [optional] [default to undefined]
+**insightRetentionDays** | **number** |  | [optional] [default to undefined]
+**updatedBy** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiGovernanceSettings } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiGovernanceSettings = {
+    insightsEnabled,
+    autoFileEnabled,
+    modelAllowed,
+    blockedCategories,
+    insightsDisabledTeamIds,
+    autoFileDisabledTeamIds,
+    insightRetentionDays,
+    updatedBy,
+    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/AiPreferencesView.md

@@ -8,6 +8,9 @@ Name | Type | Description | Notes
 **autoFileAvailable** | **boolean** |  | [optional] [default to undefined]
 **autoFile** | **boolean** |  | [optional] [default to undefined]
 **autoFileNewFolders** | **boolean** |  | [optional] [default to undefined]
+**inboxAvailable** | **boolean** |  | [optional] [default to undefined]
+**inbox** | **boolean** |  | [optional] [default to undefined]
+**inboxFolderId** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -18,6 +21,9 @@ const instance: AiPreferencesView = {
     autoFileAvailable,
     autoFile,
     autoFileNewFolders,
+    inboxAvailable,
+    inbox,
+    inboxFolderId,
 };
 ```
 

package/docs/AiTaxonomyCategory.md

@@ -0,0 +1,30 @@
+# AiTaxonomyCategory
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**examples** | **Array<string>** |  | [optional] [default to undefined]
+**position** | **number** |  | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiTaxonomyCategory } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiTaxonomyCategory = {
+    key,
+    label,
+    description,
+    examples,
+    position,
+    enabled,
+};
+```
+
+[[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/AiTaxonomyRenameRequest.md

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

@@ -0,0 +1,26 @@
+# AiTaxonomyRenameResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**oldKey** | **string** |  | [optional] [default to undefined]
+**newKey** | **string** |  | [optional] [default to undefined]
+**relabelled** | **number** |  | [optional] [default to undefined]
+**backfillJobId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiTaxonomyRenameResult } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiTaxonomyRenameResult = {
+    oldKey,
+    newKey,
+    relabelled,
+    backfillJobId,
+};
+```
+
+[[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/AiTaxonomyView.md

@@ -0,0 +1,22 @@
+# AiTaxonomyView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source** | **string** |  | [optional] [default to undefined]
+**categories** | [**Array<AiTaxonomyCategory>**](AiTaxonomyCategory.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiTaxonomyView } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiTaxonomyView = {
+    source,
+    categories,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)