@openfilz-sdk/typescript-ee 1.9.9 → 1.9.11

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)