@vzeta/camunda-api-zod-schemas/dist/element-instance.d.ts

Zod schemas and TypeScript types for Camunda 8 unified API

import { z } from 'zod';
import { Endpoint } from './common';
declare const elementInstanceStateSchema: z.ZodEnum<{
    ACTIVE: "ACTIVE";
    COMPLETED: "COMPLETED";
    TERMINATED: "TERMINATED";
}>;
type ElementInstanceState = z.infer<typeof elementInstanceStateSchema>;
declare const elementInstanceTypeSchema: z.ZodEnum<{
    UNSPECIFIED: "UNSPECIFIED";
    PROCESS: "PROCESS";
    SUB_PROCESS: "SUB_PROCESS";
    EVENT_SUB_PROCESS: "EVENT_SUB_PROCESS";
    INTERMEDIATE_CATCH_EVENT: "INTERMEDIATE_CATCH_EVENT";
    INTERMEDIATE_THROW_EVENT: "INTERMEDIATE_THROW_EVENT";
    BOUNDARY_EVENT: "BOUNDARY_EVENT";
    SERVICE_TASK: "SERVICE_TASK";
    RECEIVE_TASK: "RECEIVE_TASK";
    USER_TASK: "USER_TASK";
    MANUAL_TASK: "MANUAL_TASK";
    TASK: "TASK";
    MULTI_INSTANCE_BODY: "MULTI_INSTANCE_BODY";
    CALL_ACTIVITY: "CALL_ACTIVITY";
    BUSINESS_RULE_TASK: "BUSINESS_RULE_TASK";
    SCRIPT_TASK: "SCRIPT_TASK";
    SEND_TASK: "SEND_TASK";
    UNKNOWN: "UNKNOWN";
    AD_HOC_SUB_PROCESS: "AD_HOC_SUB_PROCESS";
    START_EVENT: "START_EVENT";
    END_EVENT: "END_EVENT";
    EXCLUSIVE_GATEWAY: "EXCLUSIVE_GATEWAY";
    INCLUSIVE_GATEWAY: "INCLUSIVE_GATEWAY";
    PARALLEL_GATEWAY: "PARALLEL_GATEWAY";
    EVENT_BASED_GATEWAY: "EVENT_BASED_GATEWAY";
    SEQUENCE_FLOW: "SEQUENCE_FLOW";
}>;
type ElementInstanceType = z.infer<typeof elementInstanceTypeSchema>;
declare const elementInstanceSchema: z.ZodObject<{
    processDefinitionId: z.ZodString;
    startDate: z.ZodString;
    endDate: z.ZodOptional<z.ZodString>;
    elementId: z.ZodString;
    elementName: z.ZodString;
    type: z.ZodEnum<{
        UNSPECIFIED: "UNSPECIFIED";
        PROCESS: "PROCESS";
        SUB_PROCESS: "SUB_PROCESS";
        EVENT_SUB_PROCESS: "EVENT_SUB_PROCESS";
        INTERMEDIATE_CATCH_EVENT: "INTERMEDIATE_CATCH_EVENT";
        INTERMEDIATE_THROW_EVENT: "INTERMEDIATE_THROW_EVENT";
        BOUNDARY_EVENT: "BOUNDARY_EVENT";
        SERVICE_TASK: "SERVICE_TASK";
        RECEIVE_TASK: "RECEIVE_TASK";
        USER_TASK: "USER_TASK";
        MANUAL_TASK: "MANUAL_TASK";
        TASK: "TASK";
        MULTI_INSTANCE_BODY: "MULTI_INSTANCE_BODY";
        CALL_ACTIVITY: "CALL_ACTIVITY";
        BUSINESS_RULE_TASK: "BUSINESS_RULE_TASK";
        SCRIPT_TASK: "SCRIPT_TASK";
        SEND_TASK: "SEND_TASK";
        UNKNOWN: "UNKNOWN";
        AD_HOC_SUB_PROCESS: "AD_HOC_SUB_PROCESS";
        START_EVENT: "START_EVENT";
        END_EVENT: "END_EVENT";
        EXCLUSIVE_GATEWAY: "EXCLUSIVE_GATEWAY";
        INCLUSIVE_GATEWAY: "INCLUSIVE_GATEWAY";
        PARALLEL_GATEWAY: "PARALLEL_GATEWAY";
        EVENT_BASED_GATEWAY: "EVENT_BASED_GATEWAY";
        SEQUENCE_FLOW: "SEQUENCE_FLOW";
    }>;
    state: z.ZodEnum<{
        ACTIVE: "ACTIVE";
        COMPLETED: "COMPLETED";
        TERMINATED: "TERMINATED";
    }>;
    hasIncident: z.ZodBoolean;
    tenantId: z.ZodString;
    elementInstanceKey: z.ZodString;
    processInstanceKey: z.ZodString;
    processDefinitionKey: z.ZodString;
    incidentKey: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
type ElementInstance = z.infer<typeof elementInstanceSchema>;
declare const elementInstanceFilterSchema: z.ZodObject<{
    processDefinitionId: z.ZodOptional<z.ZodString>;
    state: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
        ACTIVE: "ACTIVE";
        COMPLETED: "COMPLETED";
        TERMINATED: "TERMINATED";
    }>, z.ZodUnion<readonly [z.ZodEnum<{
        ACTIVE: "ACTIVE";
        COMPLETED: "COMPLETED";
        TERMINATED: "TERMINATED";
    }>, z.ZodObject<{
        $eq: z.ZodOptional<z.ZodEnum<{
            ACTIVE: "ACTIVE";
            COMPLETED: "COMPLETED";
            TERMINATED: "TERMINATED";
        }>>;
        $neq: z.ZodOptional<z.ZodEnum<{
            ACTIVE: "ACTIVE";
            COMPLETED: "COMPLETED";
            TERMINATED: "TERMINATED";
        }>>;
        $exists: z.ZodOptional<z.ZodBoolean>;
        $in: z.ZodOptional<z.ZodArray<z.ZodEnum<{
            ACTIVE: "ACTIVE";
            COMPLETED: "COMPLETED";
            TERMINATED: "TERMINATED";
        }>>>;
        $notIn: z.ZodOptional<z.ZodArray<z.ZodEnum<{
            ACTIVE: "ACTIVE";
            COMPLETED: "COMPLETED";
            TERMINATED: "TERMINATED";
        }>>>;
    }, z.core.$strip>]>]>>;
    type: z.ZodOptional<z.ZodEnum<{
        UNSPECIFIED: "UNSPECIFIED";
        PROCESS: "PROCESS";
        SUB_PROCESS: "SUB_PROCESS";
        EVENT_SUB_PROCESS: "EVENT_SUB_PROCESS";
        INTERMEDIATE_CATCH_EVENT: "INTERMEDIATE_CATCH_EVENT";
        INTERMEDIATE_THROW_EVENT: "INTERMEDIATE_THROW_EVENT";
        BOUNDARY_EVENT: "BOUNDARY_EVENT";
        SERVICE_TASK: "SERVICE_TASK";
        RECEIVE_TASK: "RECEIVE_TASK";
        USER_TASK: "USER_TASK";
        MANUAL_TASK: "MANUAL_TASK";
        TASK: "TASK";
        MULTI_INSTANCE_BODY: "MULTI_INSTANCE_BODY";
        CALL_ACTIVITY: "CALL_ACTIVITY";
        BUSINESS_RULE_TASK: "BUSINESS_RULE_TASK";
        SCRIPT_TASK: "SCRIPT_TASK";
        SEND_TASK: "SEND_TASK";
        UNKNOWN: "UNKNOWN";
        AD_HOC_SUB_PROCESS: "AD_HOC_SUB_PROCESS";
        START_EVENT: "START_EVENT";
        END_EVENT: "END_EVENT";
        EXCLUSIVE_GATEWAY: "EXCLUSIVE_GATEWAY";
        INCLUSIVE_GATEWAY: "INCLUSIVE_GATEWAY";
        PARALLEL_GATEWAY: "PARALLEL_GATEWAY";
        EVENT_BASED_GATEWAY: "EVENT_BASED_GATEWAY";
        SEQUENCE_FLOW: "SEQUENCE_FLOW";
    }>>;
    elementId: z.ZodOptional<z.ZodString>;
    elementName: z.ZodOptional<z.ZodString>;
    hasIncident: z.ZodOptional<z.ZodBoolean>;
    tenantId: z.ZodOptional<z.ZodString>;
    elementInstanceKey: z.ZodOptional<z.ZodString>;
    processInstanceKey: z.ZodOptional<z.ZodString>;
    processDefinitionKey: z.ZodOptional<z.ZodString>;
    incidentKey: z.ZodOptional<z.ZodString>;
    scopeKey: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
declare const queryElementInstancesRequestBodySchema: z.ZodObject<{
    sort: z.ZodOptional<z.ZodArray<z.ZodObject<{
        field: z.ZodEnum<{
            type: "type";
            tenantId: "tenantId";
            processDefinitionKey: "processDefinitionKey";
            processDefinitionId: "processDefinitionId";
            elementId: "elementId";
            elementName: "elementName";
            state: "state";
            startDate: "startDate";
            endDate: "endDate";
            processInstanceKey: "processInstanceKey";
            elementInstanceKey: "elementInstanceKey";
            incidentKey: "incidentKey";
        }>;
        order: z.ZodOptional<z.ZodEnum<{
            asc: "asc";
            desc: "desc";
        }>>;
    }, z.core.$strip>>>;
    page: z.ZodOptional<z.ZodObject<{
        from: z.ZodOptional<z.ZodNumber>;
        limit: z.ZodOptional<z.ZodNumber>;
        before: z.ZodOptional<z.ZodOptional<z.ZodString>>;
        after: z.ZodOptional<z.ZodOptional<z.ZodString>>;
    }, z.core.$strip>>;
    filter: z.ZodOptional<z.ZodObject<{
        processDefinitionId: z.ZodOptional<z.ZodString>;
        state: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
            ACTIVE: "ACTIVE";
            COMPLETED: "COMPLETED";
            TERMINATED: "TERMINATED";
        }>, z.ZodUnion<readonly [z.ZodEnum<{
            ACTIVE: "ACTIVE";
            COMPLETED: "COMPLETED";
            TERMINATED: "TERMINATED";
        }>, z.ZodObject<{
            $eq: z.ZodOptional<z.ZodEnum<{
                ACTIVE: "ACTIVE";
                COMPLETED: "COMPLETED";
                TERMINATED: "TERMINATED";
            }>>;
            $neq: z.ZodOptional<z.ZodEnum<{
                ACTIVE: "ACTIVE";
                COMPLETED: "COMPLETED";
                TERMINATED: "TERMINATED";
            }>>;
            $exists: z.ZodOptional<z.ZodBoolean>;
            $in: z.ZodOptional<z.ZodArray<z.ZodEnum<{
                ACTIVE: "ACTIVE";
                COMPLETED: "COMPLETED";
                TERMINATED: "TERMINATED";
            }>>>;
            $notIn: z.ZodOptional<z.ZodArray<z.ZodEnum<{
                ACTIVE: "ACTIVE";
                COMPLETED: "COMPLETED";
                TERMINATED: "TERMINATED";
            }>>>;
        }, z.core.$strip>]>]>>;
        type: z.ZodOptional<z.ZodEnum<{
            UNSPECIFIED: "UNSPECIFIED";
            PROCESS: "PROCESS";
            SUB_PROCESS: "SUB_PROCESS";
            EVENT_SUB_PROCESS: "EVENT_SUB_PROCESS";
            INTERMEDIATE_CATCH_EVENT: "INTERMEDIATE_CATCH_EVENT";
            INTERMEDIATE_THROW_EVENT: "INTERMEDIATE_THROW_EVENT";
            BOUNDARY_EVENT: "BOUNDARY_EVENT";
            SERVICE_TASK: "SERVICE_TASK";
            RECEIVE_TASK: "RECEIVE_TASK";
            USER_TASK: "USER_TASK";
            MANUAL_TASK: "MANUAL_TASK";
            TASK: "TASK";
            MULTI_INSTANCE_BODY: "MULTI_INSTANCE_BODY";
            CALL_ACTIVITY: "CALL_ACTIVITY";
            BUSINESS_RULE_TASK: "BUSINESS_RULE_TASK";
            SCRIPT_TASK: "SCRIPT_TASK";
            SEND_TASK: "SEND_TASK";
            UNKNOWN: "UNKNOWN";
            AD_HOC_SUB_PROCESS: "AD_HOC_SUB_PROCESS";
            START_EVENT: "START_EVENT";
            END_EVENT: "END_EVENT";
            EXCLUSIVE_GATEWAY: "EXCLUSIVE_GATEWAY";
            INCLUSIVE_GATEWAY: "INCLUSIVE_GATEWAY";
            PARALLEL_GATEWAY: "PARALLEL_GATEWAY";
            EVENT_BASED_GATEWAY: "EVENT_BASED_GATEWAY";
            SEQUENCE_FLOW: "SEQUENCE_FLOW";
        }>>;
        elementId: z.ZodOptional<z.ZodString>;
        elementName: z.ZodOptional<z.ZodString>;
        hasIncident: z.ZodOptional<z.ZodBoolean>;
        tenantId: z.ZodOptional<z.ZodString>;
        elementInstanceKey: z.ZodOptional<z.ZodString>;
        processInstanceKey: z.ZodOptional<z.ZodString>;
        processDefinitionKey: z.ZodOptional<z.ZodString>;
        incidentKey: z.ZodOptional<z.ZodString>;
        scopeKey: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>>;
}, z.core.$strip>;
type QueryElementInstancesRequestBody = z.infer<typeof queryElementInstancesRequestBodySchema>;
declare const queryElementInstancesResponseBodySchema: z.ZodType<import('./common').QueryResponseBody<{
    processDefinitionId: string;
    startDate: string;
    elementId: string;
    elementName: string;
    type: "UNSPECIFIED" | "PROCESS" | "SUB_PROCESS" | "EVENT_SUB_PROCESS" | "INTERMEDIATE_CATCH_EVENT" | "INTERMEDIATE_THROW_EVENT" | "BOUNDARY_EVENT" | "SERVICE_TASK" | "RECEIVE_TASK" | "USER_TASK" | "MANUAL_TASK" | "TASK" | "MULTI_INSTANCE_BODY" | "CALL_ACTIVITY" | "BUSINESS_RULE_TASK" | "SCRIPT_TASK" | "SEND_TASK" | "UNKNOWN" | "AD_HOC_SUB_PROCESS" | "START_EVENT" | "END_EVENT" | "EXCLUSIVE_GATEWAY" | "INCLUSIVE_GATEWAY" | "PARALLEL_GATEWAY" | "EVENT_BASED_GATEWAY" | "SEQUENCE_FLOW";
    state: "ACTIVE" | "COMPLETED" | "TERMINATED";
    hasIncident: boolean;
    tenantId: string;
    elementInstanceKey: string;
    processInstanceKey: string;
    processDefinitionKey: string;
    endDate?: string | undefined;
    incidentKey?: string | undefined;
}>, unknown, z.core.$ZodTypeInternals<import('./common').QueryResponseBody<{
    processDefinitionId: string;
    startDate: string;
    elementId: string;
    elementName: string;
    type: "UNSPECIFIED" | "PROCESS" | "SUB_PROCESS" | "EVENT_SUB_PROCESS" | "INTERMEDIATE_CATCH_EVENT" | "INTERMEDIATE_THROW_EVENT" | "BOUNDARY_EVENT" | "SERVICE_TASK" | "RECEIVE_TASK" | "USER_TASK" | "MANUAL_TASK" | "TASK" | "MULTI_INSTANCE_BODY" | "CALL_ACTIVITY" | "BUSINESS_RULE_TASK" | "SCRIPT_TASK" | "SEND_TASK" | "UNKNOWN" | "AD_HOC_SUB_PROCESS" | "START_EVENT" | "END_EVENT" | "EXCLUSIVE_GATEWAY" | "INCLUSIVE_GATEWAY" | "PARALLEL_GATEWAY" | "EVENT_BASED_GATEWAY" | "SEQUENCE_FLOW";
    state: "ACTIVE" | "COMPLETED" | "TERMINATED";
    hasIncident: boolean;
    tenantId: string;
    elementInstanceKey: string;
    processInstanceKey: string;
    processDefinitionKey: string;
    endDate?: string | undefined;
    incidentKey?: string | undefined;
}>, unknown>>;
type QueryElementInstancesResponseBody = z.infer<typeof queryElementInstancesResponseBodySchema>;
declare const queryElementInstances: Endpoint;
declare const getElementInstance: Endpoint<Pick<ElementInstance, 'elementInstanceKey'>>;
declare const getElementInstanceResponseBodySchema: z.ZodObject<{
    processDefinitionId: z.ZodString;
    startDate: z.ZodString;
    endDate: z.ZodOptional<z.ZodString>;
    elementId: z.ZodString;
    elementName: z.ZodString;
    type: z.ZodEnum<{
        UNSPECIFIED: "UNSPECIFIED";
        PROCESS: "PROCESS";
        SUB_PROCESS: "SUB_PROCESS";
        EVENT_SUB_PROCESS: "EVENT_SUB_PROCESS";
        INTERMEDIATE_CATCH_EVENT: "INTERMEDIATE_CATCH_EVENT";
        INTERMEDIATE_THROW_EVENT: "INTERMEDIATE_THROW_EVENT";
        BOUNDARY_EVENT: "BOUNDARY_EVENT";
        SERVICE_TASK: "SERVICE_TASK";
        RECEIVE_TASK: "RECEIVE_TASK";
        USER_TASK: "USER_TASK";
        MANUAL_TASK: "MANUAL_TASK";
        TASK: "TASK";
        MULTI_INSTANCE_BODY: "MULTI_INSTANCE_BODY";
        CALL_ACTIVITY: "CALL_ACTIVITY";
        BUSINESS_RULE_TASK: "BUSINESS_RULE_TASK";
        SCRIPT_TASK: "SCRIPT_TASK";
        SEND_TASK: "SEND_TASK";
        UNKNOWN: "UNKNOWN";
        AD_HOC_SUB_PROCESS: "AD_HOC_SUB_PROCESS";
        START_EVENT: "START_EVENT";
        END_EVENT: "END_EVENT";
        EXCLUSIVE_GATEWAY: "EXCLUSIVE_GATEWAY";
        INCLUSIVE_GATEWAY: "INCLUSIVE_GATEWAY";
        PARALLEL_GATEWAY: "PARALLEL_GATEWAY";
        EVENT_BASED_GATEWAY: "EVENT_BASED_GATEWAY";
        SEQUENCE_FLOW: "SEQUENCE_FLOW";
    }>;
    state: z.ZodEnum<{
        ACTIVE: "ACTIVE";
        COMPLETED: "COMPLETED";
        TERMINATED: "TERMINATED";
    }>;
    hasIncident: z.ZodBoolean;
    tenantId: z.ZodString;
    elementInstanceKey: z.ZodString;
    processInstanceKey: z.ZodString;
    processDefinitionKey: z.ZodString;
    incidentKey: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
type GetElementInstanceResponseBody = z.infer<typeof getElementInstanceResponseBodySchema>;
declare const updateElementInstanceVariablesRequestBodySchema: z.ZodObject<{
    variables: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    local: z.ZodOptional<z.ZodBoolean>;
}, z.core.$strip>;
type UpdateElementInstanceVariablesRequestBody = z.infer<typeof updateElementInstanceVariablesRequestBodySchema>;
declare const updateElementInstanceVariables: Endpoint<Pick<ElementInstance, 'elementInstanceKey'>>;
export { queryElementInstances, getElementInstance, updateElementInstanceVariables, queryElementInstancesRequestBodySchema, queryElementInstancesResponseBodySchema, getElementInstanceResponseBodySchema, updateElementInstanceVariablesRequestBodySchema, elementInstanceStateSchema, elementInstanceTypeSchema, elementInstanceSchema, elementInstanceFilterSchema, };
export type { ElementInstanceState, ElementInstanceType, ElementInstance, QueryElementInstancesRequestBody, QueryElementInstancesResponseBody, GetElementInstanceResponseBody, UpdateElementInstanceVariablesRequestBody, };