@openfilz-sdk/typescript-ee 1.9.9 → 1.9.10

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)

package/docs/WorkflowEventDTO.md

@@ -0,0 +1,36 @@
+# WorkflowEventDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**fromState** | **string** |  | [optional] [default to undefined]
+**toState** | **string** |  | [optional] [default to undefined]
+**transitionKey** | **string** |  | [optional] [default to undefined]
+**actor** | **string** |  | [optional] [default to undefined]
+**comment** | **string** |  | [optional] [default to undefined]
+**details** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowEventDTO } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowEventDTO = {
+    id,
+    type,
+    fromState,
+    toState,
+    transitionKey,
+    actor,
+    comment,
+    details,
+    createdAt,
+};
+```
+
+[[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/WorkflowInstanceDTO.md

@@ -0,0 +1,48 @@
+# WorkflowInstanceDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**definitionId** | **string** |  | [optional] [default to undefined]
+**definitionName** | **string** |  | [optional] [default to undefined]
+**definitionVersion** | **number** |  | [optional] [default to undefined]
+**documentId** | **string** |  | [optional] [default to undefined]
+**documentName** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**currentStateKey** | **string** |  | [optional] [default to undefined]
+**currentStateLabel** | **string** |  | [optional] [default to undefined]
+**currentStateColor** | **string** |  | [optional] [default to undefined]
+**startedBy** | **string** |  | [optional] [default to undefined]
+**startedAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+**completedAt** | **string** |  | [optional] [default to undefined]
+**currentTask** | [**WorkflowTaskDTO**](WorkflowTaskDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowInstanceDTO } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowInstanceDTO = {
+    id,
+    definitionId,
+    definitionName,
+    definitionVersion,
+    documentId,
+    documentName,
+    status,
+    currentStateKey,
+    currentStateLabel,
+    currentStateColor,
+    startedBy,
+    startedAt,
+    updatedAt,
+    completedAt,
+    currentTask,
+};
+```
+
+[[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/WorkflowInstanceDetailDTO.md

@@ -0,0 +1,28 @@
+# WorkflowInstanceDetailDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**instance** | [**WorkflowInstanceDTO**](WorkflowInstanceDTO.md) |  | [optional] [default to undefined]
+**spec** | [**WorkflowSpec**](WorkflowSpec.md) |  | [optional] [default to undefined]
+**assignments** | **{ [key: string]: Array<string>; }** |  | [optional] [default to undefined]
+**history** | [**Array<WorkflowEventDTO>**](WorkflowEventDTO.md) |  | [optional] [default to undefined]
+**canManage** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowInstanceDetailDTO } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowInstanceDetailDTO = {
+    instance,
+    spec,
+    assignments,
+    history,
+    canManage,
+};
+```
+
+[[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/WorkflowInstancePage.md

@@ -0,0 +1,26 @@
+# WorkflowInstancePage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<WorkflowInstanceDTO>**](WorkflowInstanceDTO.md) |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**size** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowInstancePage } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowInstancePage = {
+    items,
+    total,
+    page,
+    size,
+};
+```
+
+[[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/WorkflowProblem.md

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

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

@@ -0,0 +1,36 @@
+# WorkflowState
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**kind** | **string** |  | [optional] [default to undefined]
+**color** | **string** |  | [optional] [default to undefined]
+**assignees** | [**WorkflowAssignment**](WorkflowAssignment.md) |  | [optional] [default to undefined]
+**dueInDays** | **number** |  | [optional] [default to undefined]
+**transitions** | [**Array<WorkflowTransition>**](WorkflowTransition.md) |  | [optional] [default to undefined]
+**onEnter** | [**Array<WorkflowAction>**](WorkflowAction.md) |  | [optional] [default to undefined]
+**end** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowState } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowState = {
+    key,
+    label,
+    kind,
+    color,
+    assignees,
+    dueInDays,
+    transitions,
+    onEnter,
+    end,
+};
+```
+
+[[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/WorkflowSummaryDTO.md

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

@@ -0,0 +1,66 @@
+# WorkflowTaskDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**instanceId** | **string** |  | [optional] [default to undefined]
+**definitionId** | **string** |  | [optional] [default to undefined]
+**definitionName** | **string** |  | [optional] [default to undefined]
+**documentId** | **string** |  | [optional] [default to undefined]
+**documentName** | **string** |  | [optional] [default to undefined]
+**stateKey** | **string** |  | [optional] [default to undefined]
+**stateLabel** | **string** |  | [optional] [default to undefined]
+**stateColor** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**candidates** | **Array<string>** |  | [optional] [default to undefined]
+**candidateRole** | **string** |  | [optional] [default to undefined]
+**startedBy** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**dueAt** | **string** |  | [optional] [default to undefined]
+**overdue** | **boolean** |  | [optional] [default to undefined]
+**completedAt** | **string** |  | [optional] [default to undefined]
+**completedBy** | **string** |  | [optional] [default to undefined]
+**transitionKey** | **string** |  | [optional] [default to undefined]
+**comment** | **string** |  | [optional] [default to undefined]
+**transitions** | [**Array<WorkflowTransition>**](WorkflowTransition.md) |  | [optional] [default to undefined]
+**previousComment** | **string** |  | [optional] [default to undefined]
+**previousActor** | **string** |  | [optional] [default to undefined]
+**mine** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowTaskDTO } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowTaskDTO = {
+    id,
+    instanceId,
+    definitionId,
+    definitionName,
+    documentId,
+    documentName,
+    stateKey,
+    stateLabel,
+    stateColor,
+    status,
+    candidates,
+    candidateRole,
+    startedBy,
+    createdAt,
+    dueAt,
+    overdue,
+    completedAt,
+    completedBy,
+    transitionKey,
+    comment,
+    transitions,
+    previousComment,
+    previousActor,
+    mine,
+};
+```
+
+[[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/WorkflowTransition.md

@@ -0,0 +1,28 @@
+# WorkflowTransition
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**to** | **string** |  | [optional] [default to undefined]
+**style** | **string** |  | [optional] [default to undefined]
+**requireComment** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowTransition } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowTransition = {
+    key,
+    label,
+    to,
+    style,
+    requireComment,
+};
+```
+
+[[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/WorkflowValidationResult.md

@@ -0,0 +1,22 @@
+# WorkflowValidationResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid** | **boolean** |  | [optional] [default to undefined]
+**problems** | [**Array<WorkflowProblem>**](WorkflowProblem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WorkflowValidationResult } from '@openfilz-sdk/typescript-ee';
+
+const instance: WorkflowValidationResult = {
+    valid,
+    problems,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)