@openfilz-sdk/typescript-ee 1.9.11 → 1.10.0

package/dist/models/key-count.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/save-ai-preferences-request.d.ts

@@ -12,4 +12,5 @@
 export interface SaveAiPreferencesRequest {
     'autoFile'?: boolean;
     'autoFileNewFolders'?: boolean;
+    'inbox'?: boolean;
 }

package/dist/models/scan-request-dto.d.ts

@@ -16,4 +16,7 @@ export interface ScanRequestDto {
     'targetFolderPath'?: string;
     'targetFolderId'?: string;
     'pageSize'?: string;
+    'inputSource'?: string;
+    'autoFile'?: boolean;
+    'category'?: string;
 }

package/dist/models/search-by-audit-log-request.d.ts

@@ -102,5 +102,8 @@ export declare const SearchByAuditLogRequestActionEnum: {
     readonly SignatureReminderSent: "SIGNATURE_REMINDER_SENT";
     readonly SignatureTemplateCreated: "SIGNATURE_TEMPLATE_CREATED";
     readonly SignatureTemplateDeleted: "SIGNATURE_TEMPLATE_DELETED";
+    readonly ArchiveDeposit: "ARCHIVE_DEPOSIT";
+    readonly RestoreFromArchive: "RESTORE_FROM_ARCHIVE";
+    readonly ArchiveOwnerReassigned: "ARCHIVE_OWNER_REASSIGNED";
 };
 export type SearchByAuditLogRequestActionEnum = typeof SearchByAuditLogRequestActionEnum[keyof typeof SearchByAuditLogRequestActionEnum];

package/dist/models/search-by-audit-log-request.js

@@ -79,4 +79,7 @@ exports.SearchByAuditLogRequestActionEnum = {
     SignatureReminderSent: 'SIGNATURE_REMINDER_SENT',
     SignatureTemplateCreated: 'SIGNATURE_TEMPLATE_CREATED',
     SignatureTemplateDeleted: 'SIGNATURE_TEMPLATE_DELETED',
+    ArchiveDeposit: 'ARCHIVE_DEPOSIT',
+    RestoreFromArchive: 'RESTORE_FROM_ARCHIVE',
+    ArchiveOwnerReassigned: 'ARCHIVE_OWNER_REASSIGNED',
 };

package/dist/models/settings.d.ts

@@ -18,6 +18,7 @@ export interface Settings {
     'thumbnailsActive'?: boolean;
     'aiActive'?: boolean;
     'aiChatActive'?: boolean;
+    'aiChatUnavailableReason'?: string;
     'aiUserSettingsEnabled'?: boolean;
     'aiInsightsActive'?: boolean;
     'aiInsightsCategories'?: Array<string>;

package/dist/models/team-inbox-request.d.ts

@@ -0,0 +1,24 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface TeamInboxRequest {
+    'teamId': string;
+    'name': string;
+    'inboxFolderId': string;
+    'targetRootFolderId'?: string;
+    'technicalUserEmail': string;
+    'allowNewFolders'?: boolean;
+    'enabled'?: boolean;
+    /**
+     * Seconds between two scheduled runs (default 300)
+     */
+    'pollIntervalSeconds'?: number;
+}

package/dist/models/team-inbox-request.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/team-inbox-view.d.ts

@@ -0,0 +1,31 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface TeamInboxView {
+    'id'?: string;
+    'teamId'?: string;
+    'teamName'?: string;
+    'name'?: string;
+    'inboxFolderId'?: string;
+    'inboxFolderPath'?: string;
+    'targetRootFolderId'?: string;
+    'targetRootFolderPath'?: string;
+    'technicalUserEmail'?: string;
+    'allowNewFolders'?: boolean;
+    'enabled'?: boolean;
+    'pollIntervalSeconds'?: number;
+    'lastRunAt'?: string;
+    'lastJobId'?: string;
+    'createdBy'?: string;
+    'createdAt'?: string;
+    'updatedAt'?: string;
+    'warnings'?: Array<string>;
+}

package/dist/models/team-inbox-view.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/team-option-view.d.ts

@@ -0,0 +1,25 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface TeamOptionView {
+    /**
+     * users.id of the TEAM row in the DMS database
+     */
+    'id'?: string;
+    /**
+     * Team name
+     */
+    'name'?: string;
+    /**
+     * Team e-mail (the sharing address)
+     */
+    'email'?: string;
+}

package/dist/models/team-option-view.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/untouched.d.ts

@@ -0,0 +1,16 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface Untouched {
+    'months'?: number;
+    'documents'?: number;
+    'bytes'?: number;
+}

package/dist/models/untouched.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/docs/AIChatApi.md

@@ -8,7 +8,7 @@ All URIs are relative to *http://localhost:8081*
 |[**chat**](#chat) | **POST** /api/v1/ai/chat | Chat with AI assistant|
 |[**deleteConversation**](#deleteconversation) | **DELETE** /api/v1/ai/conversations/{conversationId} | Delete conversation|
 |[**discard**](#discard) | **POST** /api/v1/ai/reorganization/{planId}/discard | Discard a proposed reorganisation plan|
-|[**get4**](#get4) | **GET** /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant|
+|[**get9**](#get9) | **GET** /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant|
 |[**getConversationHistory**](#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history|
 |[**listConversations**](#listconversations) | **GET** /api/v1/ai/conversations | List conversations|
 |[**proposeByKind**](#proposebykind) | **POST** /api/v1/ai/reorganization/by-kind | Propose a reorganisation by kind of document — no model involved|
@@ -221,8 +221,8 @@ const { status, data } = await apiInstance.discard(
 
 [[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)
 
-# **get4**
-> ReorganizationPlanView get4()
+# **get9**
+> ReorganizationPlanView get9()
 
 The plan\'s items (what moves where), which are applicable, and its status.
 
@@ -239,7 +239,7 @@ const apiInstance = new AIChatApi(configuration);
 
 let planId: string; // (default to undefined)
 
-const { status, data } = await apiInstance.get4(
+const { status, data } = await apiInstance.get9(
     planId
 );
 ```

package/docs/AIDirectoryApi.md

@@ -0,0 +1,51 @@
+# AIDirectoryApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**teams**](#teams) | **GET** /api/v1/admin/ai/directory/teams | The teams of the DMS database (the ids the AI features store)|
+
+# **teams**
+> Array<TeamOptionView> teams()
+
+
+### Example
+
+```typescript
+import {
+    AIDirectoryApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIDirectoryApi(configuration);
+
+const { status, data } = await apiInstance.teams();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<TeamOptionView>**
+
+### 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/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)
+