@openfilz-sdk/typescript-ee 1.9.11 → 1.10.0

package/docs/AIGovernanceApi.md

@@ -0,0 +1,104 @@
+# AIGovernanceApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**get5**](#get5) | **GET** /api/v1/admin/ai/governance | The AI governance settings in force|
+|[**put1**](#put1) | **PUT** /api/v1/admin/ai/governance | Replace the AI governance settings|
+
+# **get5**
+> AiGovernanceSettings get5()
+
+
+### Example
+
+```typescript
+import {
+    AIGovernanceApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIGovernanceApi(configuration);
+
+const { status, data } = await apiInstance.get5();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AiGovernanceSettings**
+
+### 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)
+
+# **put1**
+> AiGovernanceSettings put1(aiGovernanceSettings)
+
+Full replace. blockedCategories must be kinds of the taxonomy (400 otherwise); insightRetentionDays null keeps insights forever. Takes effect within 30 seconds on every node.
+
+### Example
+
+```typescript
+import {
+    AIGovernanceApi,
+    Configuration,
+    AiGovernanceSettings
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIGovernanceApi(configuration);
+
+let aiGovernanceSettings: AiGovernanceSettings; //
+
+const { status, data } = await apiInstance.put1(
+    aiGovernanceSettings
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aiGovernanceSettings** | **AiGovernanceSettings**|  | |
+
+
+### Return type
+
+**AiGovernanceSettings**
+
+### 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/AITaxonomyApi.md

@@ -0,0 +1,204 @@
+# AITaxonomyApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**get4**](#get4) | **GET** /api/v1/admin/ai/taxonomy | The taxonomy and where it comes from|
+|[**put**](#put) | **PUT** /api/v1/admin/ai/taxonomy | Replace the whole taxonomy|
+|[**rename**](#rename) | **POST** /api/v1/admin/ai/taxonomy/{key}/rename | Rename a kind|
+|[**reset**](#reset) | **POST** /api/v1/admin/ai/taxonomy/reset | Delete every managed kind: the properties list rules again|
+
+# **get4**
+> AiTaxonomyView get4()
+
+source PROPERTIES: the table is empty and openfilz.ai.insights.categories rules (the rows shown are that list); source DATABASE: the managed rows rule. \'other\' is never a row — it is always appended.
+
+### Example
+
+```typescript
+import {
+    AITaxonomyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AITaxonomyApi(configuration);
+
+const { status, data } = await apiInstance.get4();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AiTaxonomyView**
+
+### 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)
+
+# **put**
+> AiTaxonomyView put(aiTaxonomyCategory)
+
+Keys are normalised (lower case, hyphens), duplicates and \'other\' refused/dropped, positions follow the list order. An empty list is refused (400): use POST /reset to return to the properties.
+
+### Example
+
+```typescript
+import {
+    AITaxonomyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AITaxonomyApi(configuration);
+
+let aiTaxonomyCategory: Array<AiTaxonomyCategory>; //
+
+const { status, data } = await apiInstance.put(
+    aiTaxonomyCategory
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aiTaxonomyCategory** | **Array<AiTaxonomyCategory>**|  | |
+
+
+### Return type
+
+**AiTaxonomyView**
+
+### 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)
+
+# **rename**
+> AiTaxonomyRenameResult rename(aiTaxonomyRenameRequest)
+
+relabel: rewrite every stored insight carrying the old key (and the search index mirror). backfill: start a forced insights backfill and return its job id — under the enterprise ownership rule it covers the documents the calling admin owns.
+
+### Example
+
+```typescript
+import {
+    AITaxonomyApi,
+    Configuration,
+    AiTaxonomyRenameRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AITaxonomyApi(configuration);
+
+let key: string; // (default to undefined)
+let aiTaxonomyRenameRequest: AiTaxonomyRenameRequest; //
+
+const { status, data } = await apiInstance.rename(
+    key,
+    aiTaxonomyRenameRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **aiTaxonomyRenameRequest** | **AiTaxonomyRenameRequest**|  | |
+| **key** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**AiTaxonomyRenameResult**
+
+### 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)
+
+# **reset**
+> AiTaxonomyView reset()
+
+
+### Example
+
+```typescript
+import {
+    AITaxonomyApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AITaxonomyApi(configuration);
+
+const { status, data } = await apiInstance.reset();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**AiTaxonomyView**
+
+### 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)
+

package/docs/AITeamInboxesApi.md

@@ -0,0 +1,313 @@
+# AITeamInboxesApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**create2**](#create2) | **POST** /api/v1/admin/ai/team-inboxes | Create a team inbox|
+|[**delete1**](#delete1) | **DELETE** /api/v1/admin/ai/team-inboxes/{id} | Delete a team inbox (the folder and its documents stay)|
+|[**get3**](#get3) | **GET** /api/v1/admin/ai/team-inboxes/{id} | One team inbox, with its warnings|
+|[**list2**](#list2) | **GET** /api/v1/admin/ai/team-inboxes | List the team inboxes|
+|[**run**](#run) | **POST** /api/v1/admin/ai/team-inboxes/{id}/run | File the inbox now|
+|[**update2**](#update2) | **PUT** /api/v1/admin/ai/team-inboxes/{id} | Replace a team inbox|
+
+# **create2**
+> TeamInboxView create2(teamInboxRequest)
+
+teamId must be a team, inboxFolderId an existing folder not already an inbox, targetRootFolderId (optional, null = the library root) a folder outside the inbox, technicalUserEmail an OpenFilz user.
+
+### Example
+
+```typescript
+import {
+    AITeamInboxesApi,
+    Configuration,
+    TeamInboxRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AITeamInboxesApi(configuration);
+
+let teamInboxRequest: TeamInboxRequest; //
+
+const { status, data } = await apiInstance.create2(
+    teamInboxRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **teamInboxRequest** | **TeamInboxRequest**|  | |
+
+
+### Return type
+
+**TeamInboxView**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### 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)
+
+# **delete1**
+> delete1()
+
+
+### Example
+
+```typescript
+import {
+    AITeamInboxesApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AITeamInboxesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.delete1(
+    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)
+
+# **get3**
+> TeamInboxView get3()
+
+
+### Example
+
+```typescript
+import {
+    AITeamInboxesApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AITeamInboxesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.get3(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**TeamInboxView**
+
+### 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)
+
+# **list2**
+> Array<TeamInboxView> list2()
+
+
+### Example
+
+```typescript
+import {
+    AITeamInboxesApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AITeamInboxesApi(configuration);
+
+const { status, data } = await apiInstance.list2();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<TeamInboxView>**
+
+### 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)
+
+# **run**
+> TeamInboxView run()
+
+Schedules one smart-filing job for every file lying loose in the inbox, as the technical user, whatever the inbox\'s interval, and returns the inbox with its lastRunAt / lastJobId. 400 when the inbox is disabled or smart filing is off.
+
+### Example
+
+```typescript
+import {
+    AITeamInboxesApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AITeamInboxesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.run(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**TeamInboxView**
+
+### 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)
+
+# **update2**
+> TeamInboxView update2(teamInboxRequest)
+
+
+### Example
+
+```typescript
+import {
+    AITeamInboxesApi,
+    Configuration,
+    TeamInboxRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AITeamInboxesApi(configuration);
+
+let id: string; // (default to undefined)
+let teamInboxRequest: TeamInboxRequest; //
+
+const { status, data } = await apiInstance.update2(
+    id,
+    teamInboxRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **teamInboxRequest** | **TeamInboxRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**TeamInboxView**
+
+### 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/AiAnalyticsAdminControllerApi.md

@@ -0,0 +1,62 @@
+# AiAnalyticsAdminControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**analytics**](#analytics) | **GET** /api/v1/admin/ai/analytics | Tenant-wide AI insights and smart-filing analytics (admin only)|
+
+# **analytics**
+> AiAnalyticsView analytics()
+
+Category and language mix, enrichment pipeline state and today\'s model spend, smart-filing volume / stages / skip reasons / last 30 days, undo and manual-move corrections with the implied accuracy, and the documents untouched for N months. Optionally restricted to a folder subtree.
+
+### Example
+
+```typescript
+import {
+    AiAnalyticsAdminControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AiAnalyticsAdminControllerApi(configuration);
+
+let folderId: string; //Restrict every figure to this folder\'s subtree (optional) (default to undefined)
+let untouchedMonths: number; //Inactivity threshold of the \'untouched\' block, in months (default 12) (optional) (default to undefined)
+
+const { status, data } = await apiInstance.analytics(
+    folderId,
+    untouchedMonths
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **folderId** | [**string**] | Restrict every figure to this folder\'s subtree | (optional) defaults to undefined|
+| **untouchedMonths** | [**number**] | Inactivity threshold of the \'untouched\' block, in months (default 12) | (optional) defaults to undefined|
+
+
+### Return type
+
+**AiAnalyticsView**
+
+### 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/AiAnalyticsView.md

@@ -0,0 +1,32 @@
+# AiAnalyticsView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**folderId** | **string** |  | [optional] [default to undefined]
+**categories** | [**Array<KeyCount>**](KeyCount.md) |  | [optional] [default to undefined]
+**languages** | [**Array<KeyCount>**](KeyCount.md) |  | [optional] [default to undefined]
+**insights** | [**Insights**](Insights.md) |  | [optional] [default to undefined]
+**filing** | [**Filing**](Filing.md) |  | [optional] [default to undefined]
+**corrections** | [**Corrections**](Corrections.md) |  | [optional] [default to undefined]
+**untouched** | [**Untouched**](Untouched.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiAnalyticsView } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiAnalyticsView = {
+    folderId,
+    categories,
+    languages,
+    insights,
+    filing,
+    corrections,
+    untouched,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)