@openfilz-sdk/typescript-ee 1.9.9 → 1.9.10

package/dist/esm/models/workflow-audit.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.
+ */
+import type { AuditLogDetails } from './audit-log-details';
+/**
+ * @type WorkflowAudit
+ * type=workflow
+ */
+export type WorkflowAudit = AuditLogDetails;

package/dist/esm/models/workflow-audit.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/workflow-definition-dto.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 { WorkflowSpec } from './workflow-spec';
+export interface WorkflowDefinitionDTO {
+    'id'?: string;
+    'name'?: string;
+    'description'?: string;
+    'active'?: boolean;
+    'spec'?: WorkflowSpec;
+    'triggerFolderIds'?: Array<string>;
+    'version'?: number;
+    'createdBy'?: string;
+    'createdAt'?: string;
+    'updatedAt'?: string;
+    'runningCount'?: number;
+    'canEdit'?: boolean;
+}

package/dist/esm/models/workflow-definition-dto.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/workflow-event-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.
+ */
+export interface WorkflowEventDTO {
+    'id'?: string;
+    'type'?: WorkflowEventDTOTypeEnum;
+    'fromState'?: string;
+    'toState'?: string;
+    'transitionKey'?: string;
+    'actor'?: string;
+    'comment'?: string;
+    'details'?: {
+        [key: string]: any;
+    };
+    'createdAt'?: string;
+}
+export declare const WorkflowEventDTOTypeEnum: {
+    readonly Started: "STARTED";
+    readonly Transitioned: "TRANSITIONED";
+    readonly ActionApplied: "ACTION_APPLIED";
+    readonly ActionFailed: "ACTION_FAILED";
+    readonly Reassigned: "REASSIGNED";
+    readonly Reminded: "REMINDED";
+    readonly Completed: "COMPLETED";
+    readonly Cancelled: "CANCELLED";
+};
+export type WorkflowEventDTOTypeEnum = typeof WorkflowEventDTOTypeEnum[keyof typeof WorkflowEventDTOTypeEnum];

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

@@ -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 const WorkflowEventDTOTypeEnum = {
+    Started: 'STARTED',
+    Transitioned: 'TRANSITIONED',
+    ActionApplied: 'ACTION_APPLIED',
+    ActionFailed: 'ACTION_FAILED',
+    Reassigned: 'REASSIGNED',
+    Reminded: 'REMINDED',
+    Completed: 'COMPLETED',
+    Cancelled: 'CANCELLED',
+};

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

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/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/esm/models/workflow-instance-dto.js

@@ -0,0 +1,18 @@
+/* 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 const WorkflowInstanceDTOStatusEnum = {
+    Running: 'RUNNING',
+    Completed: 'COMPLETED',
+    Cancelled: 'CANCELLED',
+};

package/dist/esm/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/esm/models/workflow-instance-page.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/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/esm/models/workflow-problem.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/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/esm/models/workflow-spec.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/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/esm/models/workflow-state.js

@@ -0,0 +1,18 @@
+/* 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 const WorkflowStateKindEnum = {
+    Start: 'START',
+    Step: 'STEP',
+    End: 'END',
+};

package/dist/esm/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/esm/models/workflow-summary-dto.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/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/esm/models/workflow-task-dto.js

@@ -0,0 +1,18 @@
+/* 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 const WorkflowTaskDTOStatusEnum = {
+    Open: 'OPEN',
+    Done: 'DONE',
+    Cancelled: 'CANCELLED',
+};

package/dist/esm/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/esm/models/workflow-transition.js

@@ -0,0 +1,19 @@
+/* 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 const WorkflowTransitionStyleEnum = {
+    Primary: 'PRIMARY',
+    Success: 'SUCCESS',
+    Danger: 'DANGER',
+    Neutral: 'NEUTRAL',
+};

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

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/models/audit-log-details.d.ts

@@ -10,5 +10,17 @@
  * Do not edit the class manually.
  */
 export interface AuditLogDetails {
+    /**
+     * Workflow instance this action was part of, when a workflow caused it
+     */
+    'workflowInstanceId'?: string;
+    /**
+     * Name of the workflow that caused this action
+     */
+    'workflow'?: string;
+    /**
+     * Label of the workflow status whose entry caused this action
+     */
+    'workflowState'?: string;
     'type': string;
 }

package/dist/models/cancel-instance-request.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 CancelInstanceRequest {
+    'comment'?: string;
+}

package/dist/models/cancel-instance-request.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/complete-task-request.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.
+ */
+export interface CompleteTaskRequest {
+    'transitionKey': string;
+    'comment'?: string;
+}

package/dist/models/complete-task-request.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/enriched-audit-log-details.d.ts

@@ -20,6 +20,8 @@ import type { ReplaceAudit } from './replace-audit';
 import type { RestoreVersionAudit } from './restore-version-audit';
 import type { UpdateMetadataAudit } from './update-metadata-audit';
 import type { UploadAudit } from './upload-audit';
+import type { WorkflowActionFailureAudit } from './workflow-action-failure-audit';
+import type { WorkflowAudit } from './workflow-audit';
 /**
  * @type EnrichedAuditLogDetails
  */
@@ -45,4 +47,8 @@ export type EnrichedAuditLogDetails = {
     type: 'updateMetadata';
 } & UpdateMetadataAudit | {
     type: 'upload';
-} & UploadAudit;
+} & UploadAudit | {
+    type: 'workflow';
+} & WorkflowAudit | {
+    type: 'workflowActionFailure';
+} & WorkflowActionFailureAudit;