@openfilz-sdk/typescript-ee 1.9.8 → 1.9.10

package/dist/models/workflow-validation-result.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/AIEmbeddingsApi.md

@@ -0,0 +1,111 @@
+# AIEmbeddingsApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**backfill1**](#backfill1) | **POST** /api/v1/ai/embeddings/backfill | Embed existing documents|
+|[**backfillStatus1**](#backfillstatus1) | **GET** /api/v1/ai/embeddings/backfill/{jobId} | Progress of an embedding backfill job|
+
+# **backfill1**
+> EmbeddingBackfillStatus backfill1()
+
+Queues every FILE without a chunk in the vector store (or every FILE when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}. Run it after wiping the vector store for an embedding-provider switch.
+
+### Example
+
+```typescript
+import {
+    AIEmbeddingsApi,
+    Configuration,
+    EmbeddingBackfillRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIEmbeddingsApi(configuration);
+
+let embeddingBackfillRequest: EmbeddingBackfillRequest; // (optional)
+
+const { status, data } = await apiInstance.backfill1(
+    embeddingBackfillRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **embeddingBackfillRequest** | **EmbeddingBackfillRequest**|  | |
+
+
+### Return type
+
+**EmbeddingBackfillStatus**
+
+### 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)
+
+# **backfillStatus1**
+> EmbeddingBackfillStatus backfillStatus1()
+
+
+### Example
+
+```typescript
+import {
+    AIEmbeddingsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AIEmbeddingsApi(configuration);
+
+let jobId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.backfillStatus1(
+    jobId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **jobId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**EmbeddingBackfillStatus**
+
+### 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/AuditLogDetails.md

@@ -5,6 +5,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**workflowInstanceId** | **string** | Workflow instance this action was part of, when a workflow caused it | [optional] [default to undefined]
+**workflow** | **string** | Name of the workflow that caused this action | [optional] [default to undefined]
+**workflowState** | **string** | Label of the workflow status whose entry caused this action | [optional] [default to undefined]
 **type** | **string** |  | [default to undefined]
 
 ## Example
@@ -13,6 +16,9 @@ Name | Type | Description | Notes
 import { AuditLogDetails } from '@openfilz-sdk/typescript-ee';
 
 const instance: AuditLogDetails = {
+    workflowInstanceId,
+    workflow,
+    workflowState,
     type,
 };
 ```

package/docs/CancelInstanceRequest.md

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

@@ -0,0 +1,22 @@
+# CompleteTaskRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transitionKey** | **string** |  | [default to undefined]
+**comment** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CompleteTaskRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: CompleteTaskRequest = {
+    transitionKey,
+    comment,
+};
+```
+
+[[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/ESignApi.md

@@ -4,7 +4,7 @@ All URIs are relative to *http://localhost:8081*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**cancel**](#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope|
+|[**cancel1**](#cancel1) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope|
 |[**cloudSubscription**](#cloudsubscription) | **GET** /api/v1/signatures/cloud-subscription | Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)|
 |[**create**](#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false)|
 |[**events**](#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes|
@@ -15,8 +15,8 @@ All URIs are relative to *http://localhost:8081*
 |[**send**](#send) | **POST** /api/v1/signatures/{id}/send | Send a DRAFT envelope|
 |[**signedDocument**](#signeddocument) | **GET** /api/v1/signatures/{id}/signed-document | Download the sealed PDF of a completed envelope|
 
-# **cancel**
-> SignatureEnvelopeDTO cancel()
+# **cancel1**
+> SignatureEnvelopeDTO cancel1()
 
 
 ### Example
@@ -32,7 +32,7 @@ const apiInstance = new ESignApi(configuration);
 
 let id: string; // (default to undefined)
 
-const { status, data } = await apiInstance.cancel(
+const { status, data } = await apiInstance.cancel1(
     id
 );
 ```

package/docs/EmbeddingBackfillRequest.md

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

@@ -0,0 +1,38 @@
+# EmbeddingBackfillStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**jobId** | **string** |  | [optional] [default to undefined]
+**folderId** | **string** |  | [optional] [default to undefined]
+**force** | **boolean** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**done** | **number** |  | [optional] [default to undefined]
+**failed** | **number** |  | [optional] [default to undefined]
+**skipped** | **number** |  | [optional] [default to undefined]
+**startedAt** | **string** |  | [optional] [default to undefined]
+**finishedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EmbeddingBackfillStatus } from '@openfilz-sdk/typescript-ee';
+
+const instance: EmbeddingBackfillStatus = {
+    jobId,
+    folderId,
+    force,
+    status,
+    total,
+    done,
+    failed,
+    skipped,
+    startedAt,
+    finishedAt,
+};
+```
+
+[[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/EnrichedAuditLogDetails.md

@@ -5,6 +5,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**workflowInstanceId** | **string** | Workflow instance this action was part of, when a workflow caused it | [optional] [default to undefined]
+**workflow** | **string** | Workflow definition name | [optional] [default to undefined]
+**workflowState** | **string** | Label of the workflow status whose entry caused this action | [optional] [default to undefined]
 **type** | **string** |  | [default to undefined]
 **sourceFileId** | **string** |  | [optional] [default to undefined]
 **targetFolderId** | **string** |  | [optional] [default to undefined]
@@ -23,6 +26,14 @@ Name | Type | Description | Notes
 **restoredFromDate** | **string** | Creation date of the restored version | [optional] [default to undefined]
 **updatedMetadata** | **{ [key: string]: any; }** | Updated Metadata | [optional] [default to undefined]
 **parentFolderId** | **string** |  | [optional] [default to undefined]
+**action** | **string** | Action that failed (MOVE_TO_FOLDER, SET_METADATA, NOTIFY) | [optional] [default to undefined]
+**target** | **string** | What it targeted: the destination folder, the metadata keys, the recipients | [optional] [default to undefined]
+**error** | **string** | Why it failed | [optional] [default to undefined]
+**instanceId** | **string** | Workflow instance | [optional] [default to undefined]
+**fromState** | **string** | Status left (null on start) | [optional] [default to undefined]
+**toState** | **string** | Status entered | [optional] [default to undefined]
+**transition** | **string** | Transition taken | [optional] [default to undefined]
+**comment** | **string** | Decision comment | [optional] [default to undefined]
 
 ## Example
 
@@ -30,6 +41,9 @@ Name | Type | Description | Notes
 import { EnrichedAuditLogDetails } from '@openfilz-sdk/typescript-ee';
 
 const instance: EnrichedAuditLogDetails = {
+    workflowInstanceId,
+    workflow,
+    workflowState,
     type,
     sourceFileId,
     targetFolderId,
@@ -48,6 +62,14 @@ const instance: EnrichedAuditLogDetails = {
     restoredFromDate,
     updatedMetadata,
     parentFolderId,
+    action,
+    target,
+    error,
+    instanceId,
+    fromState,
+    toState,
+    transition,
+    comment,
 };
 ```
 

package/docs/MyTasksCountDTO.md

@@ -0,0 +1,22 @@
+# MyTasksCountDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [optional] [default to undefined]
+**overdue** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MyTasksCountDTO } from '@openfilz-sdk/typescript-ee';
+
+const instance: MyTasksCountDTO = {
+    count,
+    overdue,
+};
+```
+
+[[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/PerDefinition.md

@@ -0,0 +1,28 @@
+# PerDefinition
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**definitionId** | **string** |  | [optional] [default to undefined]
+**definitionName** | **string** |  | [optional] [default to undefined]
+**running** | **number** |  | [optional] [default to undefined]
+**completed** | **number** |  | [optional] [default to undefined]
+**cancelled** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PerDefinition } from '@openfilz-sdk/typescript-ee';
+
+const instance: PerDefinition = {
+    definitionId,
+    definitionName,
+    running,
+    completed,
+    cancelled,
+};
+```
+
+[[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/ReassignTaskRequest.md

@@ -0,0 +1,22 @@
+# ReassignTaskRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emails** | **Array<string>** |  | [default to undefined]
+**comment** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReassignTaskRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ReassignTaskRequest = {
+    emails,
+    comment,
+};
+```
+
+[[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/SaveWorkflowDefinitionRequest.md

@@ -0,0 +1,28 @@
+# SaveWorkflowDefinitionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**active** | **boolean** |  | [optional] [default to undefined]
+**spec** | [**WorkflowSpec**](WorkflowSpec.md) |  | [default to undefined]
+**triggerFolderIds** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SaveWorkflowDefinitionRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: SaveWorkflowDefinitionRequest = {
+    name,
+    description,
+    active,
+    spec,
+    triggerFolderIds,
+};
+```
+
+[[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/Settings.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **theme** | **string** |  | [optional] [default to undefined]
 **thumbnailsActive** | **boolean** |  | [optional] [default to undefined]
 **aiActive** | **boolean** |  | [optional] [default to undefined]
+**aiChatActive** | **boolean** |  | [optional] [default to undefined]
 **aiUserSettingsEnabled** | **boolean** |  | [optional] [default to undefined]
 **aiInsightsActive** | **boolean** |  | [optional] [default to undefined]
 **aiInsightsCategories** | **Array<string>** |  | [optional] [default to undefined]
@@ -22,6 +23,8 @@ Name | Type | Description | Notes
 **signatureAuthMethods** | **Array<string>** |  | [optional] [default to undefined]
 **signatureRemindersActive** | **boolean** |  | [optional] [default to undefined]
 **signatureCloudActive** | **boolean** |  | [optional] [default to undefined]
+**workflowsActive** | **boolean** |  | [optional] [default to undefined]
+**workflowDesignerRoleRequired** | **boolean** |  | [optional] [default to undefined]
 **demoMode** | **boolean** |  | [optional] [default to undefined]
 **sealProvider** | **string** |  | [optional] [default to undefined]
 **mcpActive** | **boolean** |  | [optional] [default to undefined]
@@ -43,6 +46,7 @@ const instance: Settings = {
     theme,
     thumbnailsActive,
     aiActive,
+    aiChatActive,
     aiUserSettingsEnabled,
     aiInsightsActive,
     aiInsightsCategories,
@@ -53,6 +57,8 @@ const instance: Settings = {
     signatureAuthMethods,
     signatureRemindersActive,
     signatureCloudActive,
+    workflowsActive,
+    workflowDesignerRoleRequired,
     demoMode,
     sealProvider,
     mcpActive,

package/docs/StartWorkflowRequest.md

@@ -0,0 +1,28 @@
+# StartWorkflowRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**definitionId** | **string** |  | [default to undefined]
+**documentId** | **string** |  | [default to undefined]
+**assignments** | **{ [key: string]: Array<string>; }** |  | [optional] [default to undefined]
+**transitionKey** | **string** |  | [optional] [default to undefined]
+**comment** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StartWorkflowRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: StartWorkflowRequest = {
+    definitionId,
+    documentId,
+    assignments,
+    transitionKey,
+    comment,
+};
+```
+
+[[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/WorkflowAction.md

@@ -0,0 +1,26 @@
+# WorkflowAction
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [optional] [default to undefined]
+**folderId** | **string** |  | [optional] [default to undefined]
+**entries** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**emails** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowAction } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowAction = {
+    type,
+    folderId,
+    entries,
+    emails,
+};
+```
+
+[[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/WorkflowActionFailureAudit.md

@@ -0,0 +1,25 @@
+# WorkflowActionFailureAudit
+
+type=workflowActionFailure
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **string** | Action that failed (MOVE_TO_FOLDER, SET_METADATA, NOTIFY) | [optional] [default to undefined]
+**target** | **string** | What it targeted: the destination folder, the metadata keys, the recipients | [optional] [default to undefined]
+**error** | **string** | Why it failed | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowActionFailureAudit } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowActionFailureAudit = {
+    action,
+    target,
+    error,
+};
+```
+
+[[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/WorkflowAssignment.md

@@ -0,0 +1,26 @@
+# WorkflowAssignment
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [optional] [default to undefined]
+**emails** | **Array<string>** |  | [optional] [default to undefined]
+**role** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowAssignment } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowAssignment = {
+    type,
+    emails,
+    role,
+    label,
+};
+```
+
+[[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/WorkflowAudit.md

@@ -0,0 +1,31 @@
+# WorkflowAudit
+
+type=workflow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**workflow** | **string** | Workflow definition name | [optional] [default to undefined]
+**instanceId** | **string** | Workflow instance | [optional] [default to undefined]
+**fromState** | **string** | Status left (null on start) | [optional] [default to undefined]
+**toState** | **string** | Status entered | [optional] [default to undefined]
+**transition** | **string** | Transition taken | [optional] [default to undefined]
+**comment** | **string** | Decision comment | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowAudit } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowAudit = {
+    workflow,
+    instanceId,
+    fromState,
+    toState,
+    transition,
+    comment,
+};
+```
+
+[[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/WorkflowDefinitionDTO.md

@@ -0,0 +1,42 @@
+# WorkflowDefinitionDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**active** | **boolean** |  | [optional] [default to undefined]
+**spec** | [**WorkflowSpec**](WorkflowSpec.md) |  | [optional] [default to undefined]
+**triggerFolderIds** | **Array<string>** |  | [optional] [default to undefined]
+**version** | **number** |  | [optional] [default to undefined]
+**createdBy** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+**runningCount** | **number** |  | [optional] [default to undefined]
+**canEdit** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowDefinitionDTO } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowDefinitionDTO = {
+    id,
+    name,
+    description,
+    active,
+    spec,
+    triggerFolderIds,
+    version,
+    createdBy,
+    createdAt,
+    updatedAt,
+    runningCount,
+    canEdit,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)