@openfilz-sdk/typescript-ee 1.9.10 → 1.10.0

package/docs/SmartFilingApi.md

@@ -5,7 +5,9 @@ All URIs are relative to *http://localhost:8081*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**file**](#file) | **POST** /api/v1/ai/auto-file | File existing documents on demand|
+|[**fileInbox**](#fileinbox) | **POST** /api/v1/ai/auto-file/inbox | File everything lying loose in the caller\'s Inbox|
 |[**job**](#job) | **GET** /api/v1/ai/auto-file/{jobId} | Progress and outcome of a filing job|
+|[**jobs**](#jobs) | **POST** /api/v1/ai/auto-file/jobs | Progress and outcome of several filing jobs|
 |[**lastFiling**](#lastfiling) | **GET** /api/v1/ai/auto-file/document/{documentId} | The latest filing record of a document (the \"Filed by OpenFilz\" chip)|
 |[**undo**](#undo) | **POST** /api/v1/ai/auto-file/{jobId}/undo | Move every document the job filed back where it came from|
 |[**undoFiling**](#undofiling) | **POST** /api/v1/ai/auto-file/filing/{planId}/undo | Move one filed document back (the chip\'s \"Move back\")|
@@ -41,6 +43,58 @@ const { status, data } = await apiInstance.file(
 | **autoFileRequest** | **AutoFileRequest**|  | |
 
 
+### Return type
+
+**AutoFileJobView**
+
+### 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)
+
+# **fileInbox**
+> AutoFileJobView fileInbox()
+
+Schedules one filing job for every active file directly in the caller\'s Inbox folder (the per-user Inbox of the smart-filing preferences) and returns the job at once, like the on-demand endpoint. 404 when the caller has no Inbox, 400 when the deployment does not offer it.
+
+### Example
+
+```typescript
+import {
+    SmartFilingApi,
+    Configuration,
+    AutoFileInboxRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SmartFilingApi(configuration);
+
+let autoFileInboxRequest: AutoFileInboxRequest; // (optional)
+
+const { status, data } = await apiInstance.fileInbox(
+    autoFileInboxRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **autoFileInboxRequest** | **AutoFileInboxRequest**|  | |
+
+
 ### Return type
 
 **AutoFileJobView**
@@ -105,6 +159,58 @@ const { status, data } = await apiInstance.job(
  - **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)
+
+# **jobs**
+> Array<AutoFileJobView> jobs(autoFileJobsRequest)
+
+Follows a whole upload batch in one call: the browser sends one upload request per file, so a batch leaves as many jobs to poll. Jobs that do not exist, or belong to somebody else, are left out of the answer rather than failing it. A POST because a batch of ids does not fit in a query string.
+
+### Example
+
+```typescript
+import {
+    SmartFilingApi,
+    Configuration,
+    AutoFileJobsRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new SmartFilingApi(configuration);
+
+let autoFileJobsRequest: AutoFileJobsRequest; //
+
+const { status, data } = await apiInstance.jobs(
+    autoFileJobsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **autoFileJobsRequest** | **AutoFileJobsRequest**|  | |
+
+
+### Return type
+
+**Array<AutoFileJobView>**
+
+### 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 |
 |-------------|-------------|------------------|

package/docs/TeamInboxRequest.md

@@ -0,0 +1,34 @@
+# TeamInboxRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**teamId** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**inboxFolderId** | **string** |  | [default to undefined]
+**targetRootFolderId** | **string** |  | [optional] [default to undefined]
+**technicalUserEmail** | **string** |  | [default to undefined]
+**allowNewFolders** | **boolean** |  | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**pollIntervalSeconds** | **number** | Seconds between two scheduled runs (default 300) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TeamInboxRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: TeamInboxRequest = {
+    teamId,
+    name,
+    inboxFolderId,
+    targetRootFolderId,
+    technicalUserEmail,
+    allowNewFolders,
+    enabled,
+    pollIntervalSeconds,
+};
+```
+
+[[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/TeamInboxView.md

@@ -0,0 +1,54 @@
+# TeamInboxView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**teamId** | **string** |  | [optional] [default to undefined]
+**teamName** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**inboxFolderId** | **string** |  | [optional] [default to undefined]
+**inboxFolderPath** | **string** |  | [optional] [default to undefined]
+**targetRootFolderId** | **string** |  | [optional] [default to undefined]
+**targetRootFolderPath** | **string** |  | [optional] [default to undefined]
+**technicalUserEmail** | **string** |  | [optional] [default to undefined]
+**allowNewFolders** | **boolean** |  | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**pollIntervalSeconds** | **number** |  | [optional] [default to undefined]
+**lastRunAt** | **string** |  | [optional] [default to undefined]
+**lastJobId** | **string** |  | [optional] [default to undefined]
+**createdBy** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+**warnings** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TeamInboxView } from '@openfilz-sdk/typescript-ee';
+
+const instance: TeamInboxView = {
+    id,
+    teamId,
+    teamName,
+    name,
+    inboxFolderId,
+    inboxFolderPath,
+    targetRootFolderId,
+    targetRootFolderPath,
+    technicalUserEmail,
+    allowNewFolders,
+    enabled,
+    pollIntervalSeconds,
+    lastRunAt,
+    lastJobId,
+    createdBy,
+    createdAt,
+    updatedAt,
+    warnings,
+};
+```
+
+[[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/TeamOptionView.md

@@ -0,0 +1,24 @@
+# TeamOptionView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | users.id of the TEAM row in the DMS database | [optional] [default to undefined]
+**name** | **string** | Team name | [optional] [default to undefined]
+**email** | **string** | Team e-mail (the sharing address) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TeamOptionView } from '@openfilz-sdk/typescript-ee';
+
+const instance: TeamOptionView = {
+    id,
+    name,
+    email,
+};
+```
+
+[[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/Untouched.md

@@ -0,0 +1,24 @@
+# Untouched
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**months** | **number** |  | [optional] [default to undefined]
+**documents** | **number** |  | [optional] [default to undefined]
+**bytes** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Untouched } from '@openfilz-sdk/typescript-ee';
+
+const instance: Untouched = {
+    months,
+    documents,
+    bytes,
+};
+```
+
+[[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/graphql/document-search.graphqls

@@ -10,6 +10,10 @@ type DocumentSearchInfo {
     updatedAt: DateTime
     createdBy: String
     updatedBy: String
+    "The AI document insight's category of the file (OpenSearch search path only; null on the database path)"
+    category: String
+    "The document insight's language, BCP-47 primary tag (OpenSearch search path only; null on the database path)"
+    language: String
     contentSnippet: String # return a snippet instead of the full content
     "URL to fetch the thumbnail image, null if not available"
     thumbnailUrl: String

package/graphql/document.graphqls

@@ -79,6 +79,10 @@ input ListFolderRequest {
     recursive : Boolean
     "Keep only the folders the caller may write into (Enterprise: owned, or shared in editor mode). Ignored by the Community Edition, which has no per-document permissions."
     writableOnly : Boolean
+    "Keep only the files whose AI document insight carries one of these categories (the deployment's category keys, e.g. invoice, contract). Needs document insights; a file without an insight row never matches."
+    categories : [String]
+    "Keep only the files whose document insight names one of these languages (BCP-47 primary tags, e.g. fr, en)."
+    languages : [String]
 }
 
 input FavoriteRequest {

package/models/ai-analytics-view.ts

@@ -0,0 +1,41 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Corrections } from './corrections';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Filing } from './filing';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Insights } from './insights';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KeyCount } from './key-count';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Untouched } from './untouched';
+
+export interface AiAnalyticsView {
+    'folderId'?: string;
+    'categories'?: Array<KeyCount>;
+    'languages'?: Array<KeyCount>;
+    'insights'?: Insights;
+    'filing'?: Filing;
+    'corrections'?: Corrections;
+    'untouched'?: Untouched;
+}
+

package/models/ai-cloud-usage-view.ts

@@ -0,0 +1,42 @@
+/* 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.
+ */
+
+
+
+export interface AiCloudUsageView {
+    'configured'?: boolean;
+    'available'?: boolean;
+    'status'?: AiCloudUsageViewStatusEnum;
+    'month'?: string;
+    'documents'?: number;
+    'monthlyDocumentQuota'?: number;
+    'documentsUsedPercent'?: number;
+    'budgetUsedPercent'?: number;
+    'hardCap'?: boolean;
+    'blocked'?: boolean;
+    'periodEnd'?: string;
+    'expiresAt'?: string;
+    'tenantStatus'?: string;
+}
+
+export const AiCloudUsageViewStatusEnum = {
+    Ok: 'OK',
+    NotConfigured: 'NOT_CONFIGURED',
+    KeyRejected: 'KEY_REJECTED',
+    Unreachable: 'UNREACHABLE',
+} as const;
+
+export type AiCloudUsageViewStatusEnum = typeof AiCloudUsageViewStatusEnum[keyof typeof AiCloudUsageViewStatusEnum];
+
+

package/models/ai-governance-settings.ts

@@ -0,0 +1,28 @@
+/* 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.
+ */
+
+
+
+export interface AiGovernanceSettings {
+    'insightsEnabled'?: boolean;
+    'autoFileEnabled'?: boolean;
+    'modelAllowed'?: boolean;
+    'blockedCategories'?: Array<string>;
+    'insightsDisabledTeamIds'?: Array<string>;
+    'autoFileDisabledTeamIds'?: Array<string>;
+    'insightRetentionDays'?: number;
+    'updatedBy'?: string;
+    'updatedAt'?: string;
+}
+

package/models/ai-preferences-view.ts

@@ -18,5 +18,8 @@ export interface AiPreferencesView {
     'autoFileAvailable'?: boolean;
     'autoFile'?: boolean;
     'autoFileNewFolders'?: boolean;
+    'inboxAvailable'?: boolean;
+    'inbox'?: boolean;
+    'inboxFolderId'?: string;
 }
 

package/models/ai-taxonomy-category.ts

@@ -0,0 +1,25 @@
+/* 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.
+ */
+
+
+
+export interface AiTaxonomyCategory {
+    'key'?: string;
+    'label'?: string;
+    'description'?: string;
+    'examples'?: Array<string>;
+    'position'?: number;
+    'enabled'?: boolean;
+}
+

package/models/ai-taxonomy-rename-request.ts

@@ -0,0 +1,22 @@
+/* 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.
+ */
+
+
+
+export interface AiTaxonomyRenameRequest {
+    'newKey'?: string;
+    'relabel'?: boolean;
+    'backfill'?: boolean;
+}
+

package/models/ai-taxonomy-rename-result.ts

@@ -0,0 +1,23 @@
+/* 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.
+ */
+
+
+
+export interface AiTaxonomyRenameResult {
+    'oldKey'?: string;
+    'newKey'?: string;
+    'relabelled'?: number;
+    'backfillJobId'?: string;
+}
+

package/models/ai-taxonomy-view.ts

@@ -0,0 +1,24 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { AiTaxonomyCategory } from './ai-taxonomy-category';
+
+export interface AiTaxonomyView {
+    'source'?: string;
+    'categories'?: Array<AiTaxonomyCategory>;
+}
+

package/models/archive-preflight.ts

@@ -0,0 +1,48 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ForeignItem } from './foreign-item';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Item } from './item';
+
+/**
+ * Consequences of archiving, computed before the user confirms
+ */
+export interface ArchivePreflight {
+    /**
+     * What will actually be archived — owned by the caller
+     */
+    'willBeArchived'?: Array<Item>;
+    /**
+     * Left behind because the caller does not own them. Only the owner may archive a document, so a folder is archived partially rather than refused: an owner should not be blocked by co-workers\' files in the same tree.
+     */
+    'leftBehind'?: Array<ForeignItem>;
+    /**
+     * People who lose access. Archiving revokes every share — a share is a live-collaboration ACL and means nothing in a store only the owner reads.
+     */
+    'shareRecipientsLosingAccess'?: Array<string>;
+    /**
+     * Number of comments that will be DESTROYED in the live instance (doc_comment is ON DELETE CASCADE). They survive only as the read-only transcript inside the deposit record.
+     */
+    'commentsDestroyed'?: number;
+    /**
+     * Always true. Stated explicitly because with soft delete enabled users have learned that a delete is recoverable from the recycle bin. Here it is not.
+     */
+    'irreversibleFromLive'?: boolean;
+}
+

package/models/archiving-proposal-request.ts

@@ -0,0 +1,25 @@
+/* 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.
+ */
+
+
+
+export interface ArchivingProposalRequest {
+    'rootFolderId'?: string;
+    'untouchedMonths'?: number;
+    'targetTemplate'?: string;
+    'legalHoldMetadataKey'?: string;
+    'maxDocuments'?: number;
+    'ownerEmail'?: string;
+}
+

package/models/archiving-proposal-result.ts

@@ -0,0 +1,25 @@
+/* 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.
+ */
+
+
+
+export interface ArchivingProposalResult {
+    'planId'?: string;
+    'documents'?: number;
+    'candidates'?: number;
+    'blocked'?: number;
+    'rationale'?: string;
+    'ownerEmail'?: string;
+}
+

package/models/archiving-schedule-request.ts

@@ -0,0 +1,28 @@
+/* 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.
+ */
+
+
+
+export interface ArchivingScheduleRequest {
+    'name'?: string;
+    'rootFolderId'?: string;
+    'untouchedMonths'?: number;
+    'targetTemplate'?: string;
+    'legalHoldMetadataKey'?: string;
+    'maxDocuments'?: number;
+    'cron'?: string;
+    'ownerEmail'?: string;
+    'enabled'?: boolean;
+}
+

package/models/archiving-schedule-view.ts

@@ -0,0 +1,35 @@
+/* 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.
+ */
+
+
+
+export interface ArchivingScheduleView {
+    'id'?: string;
+    'name'?: string;
+    'rootFolderId'?: string;
+    'untouchedMonths'?: number;
+    'targetTemplate'?: string;
+    'legalHoldMetadataKey'?: string;
+    'maxDocuments'?: number;
+    'cron'?: string;
+    'ownerEmail'?: string;
+    'enabled'?: boolean;
+    'lastRunAt'?: string;
+    'lastPlanId'?: string;
+    'lastOutcome'?: string;
+    'createdBy'?: string;
+    'createdAt'?: string;
+    'updatedAt'?: string;
+}
+