@vzeta/camunda-api-zod-schemas
Version:
Zod schemas and TypeScript types for Camunda 8 unified API
189 lines (188 loc) • 8.24 kB
TypeScript
import { z } from 'zod';
import { Endpoint } from './common';
declare const batchOperationTypeSchema: z.ZodEnum<{
CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE";
RESOLVE_INCIDENT: "RESOLVE_INCIDENT";
MIGRATE_PROCESS_INSTANCE: "MIGRATE_PROCESS_INSTANCE";
MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE";
}>;
type BatchOperationType = z.infer<typeof batchOperationTypeSchema>;
declare const batchOperationStateSchema: z.ZodEnum<{
CREATED: "CREATED";
ACTIVE: "ACTIVE";
SUSPENDED: "SUSPENDED";
COMPLETED: "COMPLETED";
COMPLETED_WITH_ERRORS: "COMPLETED_WITH_ERRORS";
CANCELED: "CANCELED";
INCOMPLETED: "INCOMPLETED";
}>;
type BatchOperationState = z.infer<typeof batchOperationStateSchema>;
declare const batchOperationItemStateSchema: z.ZodEnum<{
ACTIVE: "ACTIVE";
COMPLETED: "COMPLETED";
CANCELED: "CANCELED";
FAILED: "FAILED";
}>;
type BatchOperationItemState = z.infer<typeof batchOperationItemStateSchema>;
declare const batchOperationSchema: z.ZodObject<{
batchOperationKey: z.ZodString;
state: z.ZodEnum<{
CREATED: "CREATED";
ACTIVE: "ACTIVE";
SUSPENDED: "SUSPENDED";
COMPLETED: "COMPLETED";
COMPLETED_WITH_ERRORS: "COMPLETED_WITH_ERRORS";
CANCELED: "CANCELED";
INCOMPLETED: "INCOMPLETED";
}>;
batchOperationType: z.ZodEnum<{
CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE";
RESOLVE_INCIDENT: "RESOLVE_INCIDENT";
MIGRATE_PROCESS_INSTANCE: "MIGRATE_PROCESS_INSTANCE";
MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE";
}>;
startDate: z.ZodString;
endDate: z.ZodOptional<z.ZodString>;
operationsTotalCount: z.ZodNumber;
operationsFailedCount: z.ZodNumber;
operationsCompletedCount: z.ZodNumber;
}, z.core.$strip>;
type BatchOperation = z.infer<typeof batchOperationSchema>;
declare const batchOperationItemSchema: z.ZodObject<{
batchOperationKey: z.ZodString;
itemKey: z.ZodString;
processInstanceKey: z.ZodString;
state: z.ZodEnum<{
ACTIVE: "ACTIVE";
COMPLETED: "COMPLETED";
CANCELED: "CANCELED";
FAILED: "FAILED";
}>;
processedDate: z.ZodOptional<z.ZodString>;
errorMessage: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
type BatchOperationItem = z.infer<typeof batchOperationItemSchema>;
declare const queryBatchOperationsRequestBodySchema: z.ZodObject<{
sort: z.ZodOptional<z.ZodArray<z.ZodObject<{
field: z.ZodEnum<{
state: "state";
batchOperationKey: "batchOperationKey";
startDate: "startDate";
endDate: "endDate";
operationType: "operationType";
}>;
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<{
batchOperationKey: z.ZodOptional<z.ZodString>;
operationType: z.ZodOptional<z.ZodEnum<{
CANCEL_PROCESS_INSTANCE: "CANCEL_PROCESS_INSTANCE";
RESOLVE_INCIDENT: "RESOLVE_INCIDENT";
MIGRATE_PROCESS_INSTANCE: "MIGRATE_PROCESS_INSTANCE";
MODIFY_PROCESS_INSTANCE: "MODIFY_PROCESS_INSTANCE";
}>>;
state: z.ZodOptional<z.ZodEnum<{
CREATED: "CREATED";
ACTIVE: "ACTIVE";
SUSPENDED: "SUSPENDED";
COMPLETED: "COMPLETED";
COMPLETED_WITH_ERRORS: "COMPLETED_WITH_ERRORS";
CANCELED: "CANCELED";
INCOMPLETED: "INCOMPLETED";
}>>;
}, z.core.$strip>>;
}, z.core.$strip>;
type QueryBatchOperationsRequestBody = z.infer<typeof queryBatchOperationsRequestBodySchema>;
declare const queryBatchOperationsResponseBodySchema: z.ZodType<import('./common').QueryResponseBody<{
batchOperationKey: string;
state: "CREATED" | "ACTIVE" | "SUSPENDED" | "COMPLETED" | "COMPLETED_WITH_ERRORS" | "CANCELED" | "INCOMPLETED";
batchOperationType: "CANCEL_PROCESS_INSTANCE" | "RESOLVE_INCIDENT" | "MIGRATE_PROCESS_INSTANCE" | "MODIFY_PROCESS_INSTANCE";
startDate: string;
operationsTotalCount: number;
operationsFailedCount: number;
operationsCompletedCount: number;
endDate?: string | undefined;
}>, unknown, z.core.$ZodTypeInternals<import('./common').QueryResponseBody<{
batchOperationKey: string;
state: "CREATED" | "ACTIVE" | "SUSPENDED" | "COMPLETED" | "COMPLETED_WITH_ERRORS" | "CANCELED" | "INCOMPLETED";
batchOperationType: "CANCEL_PROCESS_INSTANCE" | "RESOLVE_INCIDENT" | "MIGRATE_PROCESS_INSTANCE" | "MODIFY_PROCESS_INSTANCE";
startDate: string;
operationsTotalCount: number;
operationsFailedCount: number;
operationsCompletedCount: number;
endDate?: string | undefined;
}>, unknown>>;
type QueryBatchOperationsResponseBody = z.infer<typeof queryBatchOperationsResponseBodySchema>;
declare const queryBatchOperationItemsRequestBodySchema: z.ZodObject<{
sort: z.ZodOptional<z.ZodArray<z.ZodObject<{
field: z.ZodEnum<{
state: "state";
batchOperationKey: "batchOperationKey";
itemKey: "itemKey";
processInstanceKey: "processInstanceKey";
}>;
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<{
batchOperationKey: z.ZodOptional<z.ZodString>;
itemKey: z.ZodOptional<z.ZodString>;
processInstanceKey: z.ZodOptional<z.ZodString>;
state: z.ZodOptional<z.ZodEnum<{
ACTIVE: "ACTIVE";
COMPLETED: "COMPLETED";
CANCELED: "CANCELED";
FAILED: "FAILED";
}>>;
}, z.core.$strip>>;
}, z.core.$strip>;
type QueryBatchOperationItemsRequestBody = z.infer<typeof queryBatchOperationItemsRequestBodySchema>;
declare const queryBatchOperationItemsResponseBodySchema: z.ZodType<import('./common').QueryResponseBody<{
batchOperationKey: string;
itemKey: string;
processInstanceKey: string;
state: "ACTIVE" | "COMPLETED" | "CANCELED" | "FAILED";
processedDate?: string | undefined;
errorMessage?: string | undefined;
}>, unknown, z.core.$ZodTypeInternals<import('./common').QueryResponseBody<{
batchOperationKey: string;
itemKey: string;
processInstanceKey: string;
state: "ACTIVE" | "COMPLETED" | "CANCELED" | "FAILED";
processedDate?: string | undefined;
errorMessage?: string | undefined;
}>, unknown>>;
type QueryBatchOperationItemsResponseBody = z.infer<typeof queryBatchOperationItemsResponseBodySchema>;
declare const getBatchOperation: Endpoint<{
batchOperationKey: string;
}>;
declare const queryBatchOperations: Endpoint;
declare const cancelBatchOperation: Endpoint<{
batchOperationKey: string;
}>;
declare const suspendBatchOperation: Endpoint<{
batchOperationKey: string;
}>;
declare const resumeBatchOperation: Endpoint<{
batchOperationKey: string;
}>;
declare const queryBatchOperationItems: Endpoint;
export { batchOperationTypeSchema, batchOperationStateSchema, batchOperationItemStateSchema, batchOperationSchema, batchOperationItemSchema, queryBatchOperationsRequestBodySchema, queryBatchOperationsResponseBodySchema, queryBatchOperationItemsRequestBodySchema, queryBatchOperationItemsResponseBodySchema, getBatchOperation, queryBatchOperations, cancelBatchOperation, suspendBatchOperation, resumeBatchOperation, queryBatchOperationItems, };
export type { BatchOperationType, BatchOperationState, BatchOperationItemState, BatchOperation, BatchOperationItem, QueryBatchOperationsRequestBody, QueryBatchOperationsResponseBody, QueryBatchOperationItemsRequestBody, QueryBatchOperationItemsResponseBody, };