@openfilz-sdk/typescript-ee 1.9.9 → 1.9.10

package/dist/models/workflow-event-dto.js

@@ -0,0 +1,26 @@
+"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 });
+exports.WorkflowEventDTOTypeEnum = void 0;
+exports.WorkflowEventDTOTypeEnum = {
+    Started: 'STARTED',
+    Transitioned: 'TRANSITIONED',
+    ActionApplied: 'ACTION_APPLIED',
+    ActionFailed: 'ACTION_FAILED',
+    Reassigned: 'REASSIGNED',
+    Reminded: 'REMINDED',
+    Completed: 'COMPLETED',
+    Cancelled: 'CANCELLED',
+};

package/dist/models/workflow-instance-detail-dto.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+import type { WorkflowEventDTO } from './workflow-event-dto';
+import type { WorkflowInstanceDTO } from './workflow-instance-dto';
+import type { WorkflowSpec } from './workflow-spec';
+export interface WorkflowInstanceDetailDTO {
+    'instance'?: WorkflowInstanceDTO;
+    'spec'?: WorkflowSpec;
+    'assignments'?: {
+        [key: string]: Array<string>;
+    };
+    'history'?: Array<WorkflowEventDTO>;
+    'canManage'?: boolean;
+}

package/dist/models/workflow-instance-detail-dto.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/workflow-instance-dto.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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.
+ */
+import type { WorkflowTaskDTO } from './workflow-task-dto';
+export interface WorkflowInstanceDTO {
+    'id'?: string;
+    'definitionId'?: string;
+    'definitionName'?: string;
+    'definitionVersion'?: number;
+    'documentId'?: string;
+    'documentName'?: string;
+    'status'?: WorkflowInstanceDTOStatusEnum;
+    'currentStateKey'?: string;
+    'currentStateLabel'?: string;
+    'currentStateColor'?: string;
+    'startedBy'?: string;
+    'startedAt'?: string;
+    'updatedAt'?: string;
+    'completedAt'?: string;
+    'currentTask'?: WorkflowTaskDTO;
+}
+export declare const WorkflowInstanceDTOStatusEnum: {
+    readonly Running: "RUNNING";
+    readonly Completed: "COMPLETED";
+    readonly Cancelled: "CANCELLED";
+};
+export type WorkflowInstanceDTOStatusEnum = typeof WorkflowInstanceDTOStatusEnum[keyof typeof WorkflowInstanceDTOStatusEnum];

package/dist/models/workflow-instance-dto.js

@@ -0,0 +1,21 @@
+"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 });
+exports.WorkflowInstanceDTOStatusEnum = void 0;
+exports.WorkflowInstanceDTOStatusEnum = {
+    Running: 'RUNNING',
+    Completed: 'COMPLETED',
+    Cancelled: 'CANCELLED',
+};

package/dist/models/workflow-instance-page.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+import type { WorkflowInstanceDTO } from './workflow-instance-dto';
+export interface WorkflowInstancePage {
+    'items'?: Array<WorkflowInstanceDTO>;
+    'total'?: number;
+    'page'?: number;
+    'size'?: number;
+}

package/dist/models/workflow-instance-page.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/workflow-problem.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 WorkflowProblem {
+    'path'?: string;
+    'code'?: string;
+    'message'?: string;
+    'args'?: Array<string>;
+}

package/dist/models/workflow-problem.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/workflow-spec.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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.
+ */
+import type { WorkflowState } from './workflow-state';
+export interface WorkflowSpec {
+    'states'?: Array<WorkflowState>;
+}

package/dist/models/workflow-spec.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/workflow-state.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.
+ */
+import type { WorkflowAction } from './workflow-action';
+import type { WorkflowAssignment } from './workflow-assignment';
+import type { WorkflowTransition } from './workflow-transition';
+export interface WorkflowState {
+    'key'?: string;
+    'label'?: string;
+    'kind'?: WorkflowStateKindEnum;
+    'color'?: string;
+    'assignees'?: WorkflowAssignment;
+    'dueInDays'?: number;
+    'transitions'?: Array<WorkflowTransition>;
+    'onEnter'?: Array<WorkflowAction>;
+    'end'?: boolean;
+}
+export declare const WorkflowStateKindEnum: {
+    readonly Start: "START";
+    readonly Step: "STEP";
+    readonly End: "END";
+};
+export type WorkflowStateKindEnum = typeof WorkflowStateKindEnum[keyof typeof WorkflowStateKindEnum];

package/dist/models/workflow-state.js

@@ -0,0 +1,21 @@
+"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 });
+exports.WorkflowStateKindEnum = void 0;
+exports.WorkflowStateKindEnum = {
+    Start: 'START',
+    Step: 'STEP',
+    End: 'END',
+};

package/dist/models/workflow-summary-dto.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+import type { PerDefinition } from './per-definition';
+export interface WorkflowSummaryDTO {
+    'running'?: number;
+    'completed'?: number;
+    'cancelled'?: number;
+    'overdue'?: number;
+    'byDefinition'?: Array<PerDefinition>;
+}

package/dist/models/workflow-summary-dto.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/workflow-task-dto.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+import type { WorkflowTransition } from './workflow-transition';
+export interface WorkflowTaskDTO {
+    'id'?: string;
+    'instanceId'?: string;
+    'definitionId'?: string;
+    'definitionName'?: string;
+    'documentId'?: string;
+    'documentName'?: string;
+    'stateKey'?: string;
+    'stateLabel'?: string;
+    'stateColor'?: string;
+    'status'?: WorkflowTaskDTOStatusEnum;
+    'candidates'?: Array<string>;
+    'candidateRole'?: string;
+    'startedBy'?: string;
+    'createdAt'?: string;
+    'dueAt'?: string;
+    'overdue'?: boolean;
+    'completedAt'?: string;
+    'completedBy'?: string;
+    'transitionKey'?: string;
+    'comment'?: string;
+    'transitions'?: Array<WorkflowTransition>;
+    'previousComment'?: string;
+    'previousActor'?: string;
+    'mine'?: boolean;
+}
+export declare const WorkflowTaskDTOStatusEnum: {
+    readonly Open: "OPEN";
+    readonly Done: "DONE";
+    readonly Cancelled: "CANCELLED";
+};
+export type WorkflowTaskDTOStatusEnum = typeof WorkflowTaskDTOStatusEnum[keyof typeof WorkflowTaskDTOStatusEnum];

package/dist/models/workflow-task-dto.js

@@ -0,0 +1,21 @@
+"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 });
+exports.WorkflowTaskDTOStatusEnum = void 0;
+exports.WorkflowTaskDTOStatusEnum = {
+    Open: 'OPEN',
+    Done: 'DONE',
+    Cancelled: 'CANCELLED',
+};

package/dist/models/workflow-transition.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 WorkflowTransition {
+    'key'?: string;
+    'label'?: string;
+    'to'?: string;
+    'style'?: WorkflowTransitionStyleEnum;
+    'requireComment'?: boolean;
+}
+export declare const WorkflowTransitionStyleEnum: {
+    readonly Primary: "PRIMARY";
+    readonly Success: "SUCCESS";
+    readonly Danger: "DANGER";
+    readonly Neutral: "NEUTRAL";
+};
+export type WorkflowTransitionStyleEnum = typeof WorkflowTransitionStyleEnum[keyof typeof WorkflowTransitionStyleEnum];

package/dist/models/workflow-transition.js

@@ -0,0 +1,22 @@
+"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 });
+exports.WorkflowTransitionStyleEnum = void 0;
+exports.WorkflowTransitionStyleEnum = {
+    Primary: 'PRIMARY',
+    Success: 'SUCCESS',
+    Danger: 'DANGER',
+    Neutral: 'NEUTRAL',
+};

package/dist/models/workflow-validation-result.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.
+ */
+import type { WorkflowProblem } from './workflow-problem';
+export interface WorkflowValidationResult {
+    'valid'?: boolean;
+    'problems'?: Array<WorkflowProblem>;
+}

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/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/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)