@openfilz-sdk/typescript-ee 1.9.10 → 1.10.0

package/docs/AIFilingRulesApi.md

@@ -0,0 +1,371 @@
+# AIFilingRulesApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**create3**](#create3) | **POST** /api/v1/admin/ai/filing-rules | Create a filing rule|
+|[**delete2**](#delete2) | **DELETE** /api/v1/admin/ai/filing-rules/{id} | Delete a filing rule (its events go with it)|
+|[**events1**](#events1) | **GET** /api/v1/admin/ai/filing-rules/{id}/events | What the rule did lately (MATCHED / DRY_RUN / SKIPPED), newest first|
+|[**get6**](#get6) | **GET** /api/v1/admin/ai/filing-rules/{id} | One filing rule|
+|[**list3**](#list3) | **GET** /api/v1/admin/ai/filing-rules | List the filing rules, by priority|
+|[**test**](#test) | **POST** /api/v1/admin/ai/filing-rules/{id}/test | Dry evaluation of the rule against an existing document|
+|[**update3**](#update3) | **PUT** /api/v1/admin/ai/filing-rules/{id} | Replace a filing rule|
+
+# **create3**
+> FilingRuleView create3(filingRuleRequest)
+
+destinationPath is absolute from the library root and may use {year}, {month}, {category}, {entity:<key>}, {uploader}, {team}. Null match fields mean \"any\". Takes effect on the next filing.
+
+### Example
+
+```typescript
+import {
+    AIFilingRulesApi,
+    Configuration,
+    FilingRuleRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIFilingRulesApi(configuration);
+
+let filingRuleRequest: FilingRuleRequest; //
+
+const { status, data } = await apiInstance.create3(
+    filingRuleRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **filingRuleRequest** | **FilingRuleRequest**|  | |
+
+
+### Return type
+
+**FilingRuleView**
+
+### 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)
+
+# **delete2**
+> delete2()
+
+
+### Example
+
+```typescript
+import {
+    AIFilingRulesApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIFilingRulesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.delete2(
+    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)
+
+# **events1**
+> Array<FilingRuleEventView> events1()
+
+
+### Example
+
+```typescript
+import {
+    AIFilingRulesApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIFilingRulesApi(configuration);
+
+let id: string; // (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.events1(
+    id,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<FilingRuleEventView>**
+
+### 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)
+
+# **get6**
+> FilingRuleView get6()
+
+
+### Example
+
+```typescript
+import {
+    AIFilingRulesApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIFilingRulesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.get6(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**FilingRuleView**
+
+### 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)
+
+# **list3**
+> Array<FilingRuleView> list3()
+
+
+### Example
+
+```typescript
+import {
+    AIFilingRulesApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIFilingRulesApi(configuration);
+
+const { status, data } = await apiInstance.list3();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<FilingRuleView>**
+
+### 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)
+
+# **test**
+> FilingRuleTestResult test(filingRuleTestRequest)
+
+What the rule would do for the document as the engine sees it today (current insight, metadata, uploader = the document\'s creator). Nothing moves and no event is recorded. Outcomes: MATCHED, DRY_RUN, SKIPPED, NO_MATCH, DISABLED.
+
+### Example
+
+```typescript
+import {
+    AIFilingRulesApi,
+    Configuration,
+    FilingRuleTestRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIFilingRulesApi(configuration);
+
+let id: string; // (default to undefined)
+let filingRuleTestRequest: FilingRuleTestRequest; //
+
+const { status, data } = await apiInstance.test(
+    id,
+    filingRuleTestRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **filingRuleTestRequest** | **FilingRuleTestRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**FilingRuleTestResult**
+
+### 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)
+
+# **update3**
+> FilingRuleView update3(filingRuleRequest)
+
+
+### Example
+
+```typescript
+import {
+    AIFilingRulesApi,
+    Configuration,
+    FilingRuleRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIFilingRulesApi(configuration);
+
+let id: string; // (default to undefined)
+let filingRuleRequest: FilingRuleRequest; //
+
+const { status, data } = await apiInstance.update3(
+    id,
+    filingRuleRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **filingRuleRequest** | **FilingRuleRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**FilingRuleView**
+
+### 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/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)
+