import { BpmnType, EventType } from '../../ProcessModel/index';
/**
 * @swagger
 * components:
 *   schemas:
 *     EventMessage:
 *       description: The base type for definining event messages.
 *       type: object
 *       required:
 *         - correlationId
 *         - processDefinitionId
 *         - processModelId
 *         - processInstanceId
 *         - ownerId
 *         - currentToken
 *       properties:
 *         correlationId:
 *           description: The ID of the correlation that the event belongs to.
 *           type: string
 *         processDefinitionId:
 *           description: The ID of the ProcessDefinition that the event belongs to.
 *           type: string
 *         processModelId:
 *           description: The ID of the ProcessModel that the event belongs to.
 *           type: string
 *         embeddedProcessModelId:
 *           description: The ID of the SubProcess containing the ProcessModel that the event belongs to.
 *           type: string
 *         processModelName:
 *           description: The name of the ProcessModel that the event belongs to.
 *           type: string
 *         processModelVersion:
 *           description: The version of the ProcessModel that the event belongs to.
 *           type: string
 *         processInstanceId:
 *           description: The ID of the ProcessInstance that the event belongs to.
 *           type: string
 *         parentProcessInstanceId:
 *           description: The ID of the parent ProcessInstance (if event occured in a sub process)
 *           type: string
 *         flowNodeId:
 *           description: The ID of the FlowNode that the event belongs to.
 *           type: string
 *         flowNodeName:
 *           description: The name of the FlowNode that the event belongs to.
 *           type: string
 *         flowNodeLane:
 *           description: The lane the FlowNode is located on (if any).
 *           type: string
 *         flowNodeType:
 *           description: The BPMN type of the FlowNode that the event belongs to.
 *           $ref: '#/components/schemas/BpmnType'
 *         flowNodeInstanceId:
 *           description: The ID of the FlowNodeInstance that the event belongs to.
 *           type: string
 *         ownerId:
 *           description: The ID of the user that owns the ProcessInstance that the event belongs to.
 *           type: string
 *         previousFlowNodeInstanceId:
 *           description: The ID of the FlowNodeInstance that was executed before.
 *           type: string
 *         currentToken:
 *           description: The current token of the ProcessInstance.
 *           type: object
 *         eventType:
 *           description: The type of the event.
 *           $ref: '#/components/schemas/EventType'
 *         eventName:
 *           description: The name of the event.
 *           type: string
 *         customCorrelationId:
 *           description: Process Instances triggered by this Message will use the following Correlation ID.
 *           type: string
 */
/**
 * The base type for definining event messages.
 */
export type EventMessage = {
    correlationId: string;
    processDefinitionId: string;
    processModelId: string;
    embeddedProcessModelId?: string;
    processModelName?: string;
    processModelVersion?: string;
    processInstanceId: string;
    parentProcessInstanceId?: string;
    flowNodeId?: string;
    flowNodeName?: string;
    flowNodeLane?: string;
    flowNodeType?: BpmnType;
    flowNodeInstanceId?: string;
    ownerId: string;
    previousFlowNodeInstanceId?: string;
    currentToken: any;
    eventType?: EventType;
    eventName?: string;
    /**
     * Optional: Process Instances triggered by this Message will use the following Correlation ID.
     */
    customCorrelationId?: string;
};