UNPKG

@vzeta/camunda-api-zod-schemas

Version:

Zod schemas and TypeScript types for Camunda 8 unified API

302 lines (301 loc) 14.2 kB
import { z } from 'zod'; import { Endpoint } from './common'; declare const incidentErrorTypeSchema: z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; UNKNOWN: "UNKNOWN"; IO_MAPPING_ERROR: "IO_MAPPING_ERROR"; JOB_NO_RETRIES: "JOB_NO_RETRIES"; EXECUTION_LISTENER_NO_RETRIES: "EXECUTION_LISTENER_NO_RETRIES"; TASK_LISTENER_NO_RETRIES: "TASK_LISTENER_NO_RETRIES"; CONDITION_ERROR: "CONDITION_ERROR"; EXTRACT_VALUE_ERROR: "EXTRACT_VALUE_ERROR"; CALLED_ELEMENT_ERROR: "CALLED_ELEMENT_ERROR"; UNHANDLED_ERROR_EVENT: "UNHANDLED_ERROR_EVENT"; MESSAGE_SIZE_EXCEEDED: "MESSAGE_SIZE_EXCEEDED"; CALLED_DECISION_ERROR: "CALLED_DECISION_ERROR"; DECISION_EVALUATION_ERROR: "DECISION_EVALUATION_ERROR"; FORM_NOT_FOUND: "FORM_NOT_FOUND"; RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND"; }>; type IncidentErrorType = z.infer<typeof incidentErrorTypeSchema>; declare const incidentStateSchema: z.ZodEnum<{ ACTIVE: "ACTIVE"; MIGRATED: "MIGRATED"; RESOLVED: "RESOLVED"; PENDING: "PENDING"; }>; type IncidentState = z.infer<typeof incidentStateSchema>; declare const incidentSchema: z.ZodObject<{ processDefinitionId: z.ZodString; errorType: z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; UNKNOWN: "UNKNOWN"; IO_MAPPING_ERROR: "IO_MAPPING_ERROR"; JOB_NO_RETRIES: "JOB_NO_RETRIES"; EXECUTION_LISTENER_NO_RETRIES: "EXECUTION_LISTENER_NO_RETRIES"; TASK_LISTENER_NO_RETRIES: "TASK_LISTENER_NO_RETRIES"; CONDITION_ERROR: "CONDITION_ERROR"; EXTRACT_VALUE_ERROR: "EXTRACT_VALUE_ERROR"; CALLED_ELEMENT_ERROR: "CALLED_ELEMENT_ERROR"; UNHANDLED_ERROR_EVENT: "UNHANDLED_ERROR_EVENT"; MESSAGE_SIZE_EXCEEDED: "MESSAGE_SIZE_EXCEEDED"; CALLED_DECISION_ERROR: "CALLED_DECISION_ERROR"; DECISION_EVALUATION_ERROR: "DECISION_EVALUATION_ERROR"; FORM_NOT_FOUND: "FORM_NOT_FOUND"; RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND"; }>; errorMessage: z.ZodString; elementId: z.ZodString; creationTime: z.ZodString; state: z.ZodEnum<{ ACTIVE: "ACTIVE"; MIGRATED: "MIGRATED"; RESOLVED: "RESOLVED"; PENDING: "PENDING"; }>; tenantId: z.ZodString; incidentKey: z.ZodString; processDefinitionKey: z.ZodString; processInstanceKey: z.ZodString; elementInstanceKey: z.ZodString; jobKey: z.ZodString; }, z.core.$strip>; type Incident = z.infer<typeof incidentSchema>; declare const resolveIncident: Endpoint<Pick<Incident, 'incidentKey'>>; declare const getIncident: Endpoint<Pick<Incident, 'incidentKey'>>; declare const getIncidentResponseBodySchema: z.ZodObject<{ processDefinitionId: z.ZodString; errorType: z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; UNKNOWN: "UNKNOWN"; IO_MAPPING_ERROR: "IO_MAPPING_ERROR"; JOB_NO_RETRIES: "JOB_NO_RETRIES"; EXECUTION_LISTENER_NO_RETRIES: "EXECUTION_LISTENER_NO_RETRIES"; TASK_LISTENER_NO_RETRIES: "TASK_LISTENER_NO_RETRIES"; CONDITION_ERROR: "CONDITION_ERROR"; EXTRACT_VALUE_ERROR: "EXTRACT_VALUE_ERROR"; CALLED_ELEMENT_ERROR: "CALLED_ELEMENT_ERROR"; UNHANDLED_ERROR_EVENT: "UNHANDLED_ERROR_EVENT"; MESSAGE_SIZE_EXCEEDED: "MESSAGE_SIZE_EXCEEDED"; CALLED_DECISION_ERROR: "CALLED_DECISION_ERROR"; DECISION_EVALUATION_ERROR: "DECISION_EVALUATION_ERROR"; FORM_NOT_FOUND: "FORM_NOT_FOUND"; RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND"; }>; errorMessage: z.ZodString; elementId: z.ZodString; creationTime: z.ZodString; state: z.ZodEnum<{ ACTIVE: "ACTIVE"; MIGRATED: "MIGRATED"; RESOLVED: "RESOLVED"; PENDING: "PENDING"; }>; tenantId: z.ZodString; incidentKey: z.ZodString; processDefinitionKey: z.ZodString; processInstanceKey: z.ZodString; elementInstanceKey: z.ZodString; jobKey: z.ZodString; }, z.core.$strip>; type GetIncidentResponseBody = z.infer<typeof getIncidentResponseBodySchema>; declare const queryIncidentsRequestBodySchema: z.ZodObject<{ sort: z.ZodOptional<z.ZodArray<z.ZodObject<{ field: z.ZodEnum<{ tenantId: "tenantId"; processDefinitionKey: "processDefinitionKey"; processDefinitionId: "processDefinitionId"; elementId: "elementId"; state: "state"; processInstanceKey: "processInstanceKey"; errorMessage: "errorMessage"; elementInstanceKey: "elementInstanceKey"; incidentKey: "incidentKey"; errorType: "errorType"; creationTime: "creationTime"; jobKey: "jobKey"; }>; 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<{ tenantId: z.ZodOptional<z.ZodString>; processDefinitionKey: z.ZodOptional<z.ZodString>; processDefinitionId: z.ZodOptional<z.ZodString>; elementId: z.ZodOptional<z.ZodString>; processInstanceKey: z.ZodOptional<z.ZodString>; errorMessage: z.ZodOptional<z.ZodString>; elementInstanceKey: z.ZodOptional<z.ZodString>; incidentKey: z.ZodOptional<z.ZodString>; jobKey: z.ZodOptional<z.ZodString>; errorType: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; UNKNOWN: "UNKNOWN"; IO_MAPPING_ERROR: "IO_MAPPING_ERROR"; JOB_NO_RETRIES: "JOB_NO_RETRIES"; EXECUTION_LISTENER_NO_RETRIES: "EXECUTION_LISTENER_NO_RETRIES"; TASK_LISTENER_NO_RETRIES: "TASK_LISTENER_NO_RETRIES"; CONDITION_ERROR: "CONDITION_ERROR"; EXTRACT_VALUE_ERROR: "EXTRACT_VALUE_ERROR"; CALLED_ELEMENT_ERROR: "CALLED_ELEMENT_ERROR"; UNHANDLED_ERROR_EVENT: "UNHANDLED_ERROR_EVENT"; MESSAGE_SIZE_EXCEEDED: "MESSAGE_SIZE_EXCEEDED"; CALLED_DECISION_ERROR: "CALLED_DECISION_ERROR"; DECISION_EVALUATION_ERROR: "DECISION_EVALUATION_ERROR"; FORM_NOT_FOUND: "FORM_NOT_FOUND"; RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND"; }>, z.ZodObject<{ $eq: z.ZodOptional<z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; UNKNOWN: "UNKNOWN"; IO_MAPPING_ERROR: "IO_MAPPING_ERROR"; JOB_NO_RETRIES: "JOB_NO_RETRIES"; EXECUTION_LISTENER_NO_RETRIES: "EXECUTION_LISTENER_NO_RETRIES"; TASK_LISTENER_NO_RETRIES: "TASK_LISTENER_NO_RETRIES"; CONDITION_ERROR: "CONDITION_ERROR"; EXTRACT_VALUE_ERROR: "EXTRACT_VALUE_ERROR"; CALLED_ELEMENT_ERROR: "CALLED_ELEMENT_ERROR"; UNHANDLED_ERROR_EVENT: "UNHANDLED_ERROR_EVENT"; MESSAGE_SIZE_EXCEEDED: "MESSAGE_SIZE_EXCEEDED"; CALLED_DECISION_ERROR: "CALLED_DECISION_ERROR"; DECISION_EVALUATION_ERROR: "DECISION_EVALUATION_ERROR"; FORM_NOT_FOUND: "FORM_NOT_FOUND"; RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND"; }>>; $neq: z.ZodOptional<z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; UNKNOWN: "UNKNOWN"; IO_MAPPING_ERROR: "IO_MAPPING_ERROR"; JOB_NO_RETRIES: "JOB_NO_RETRIES"; EXECUTION_LISTENER_NO_RETRIES: "EXECUTION_LISTENER_NO_RETRIES"; TASK_LISTENER_NO_RETRIES: "TASK_LISTENER_NO_RETRIES"; CONDITION_ERROR: "CONDITION_ERROR"; EXTRACT_VALUE_ERROR: "EXTRACT_VALUE_ERROR"; CALLED_ELEMENT_ERROR: "CALLED_ELEMENT_ERROR"; UNHANDLED_ERROR_EVENT: "UNHANDLED_ERROR_EVENT"; MESSAGE_SIZE_EXCEEDED: "MESSAGE_SIZE_EXCEEDED"; CALLED_DECISION_ERROR: "CALLED_DECISION_ERROR"; DECISION_EVALUATION_ERROR: "DECISION_EVALUATION_ERROR"; FORM_NOT_FOUND: "FORM_NOT_FOUND"; RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND"; }>>; $exists: z.ZodOptional<z.ZodBoolean>; $in: z.ZodOptional<z.ZodArray<z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; UNKNOWN: "UNKNOWN"; IO_MAPPING_ERROR: "IO_MAPPING_ERROR"; JOB_NO_RETRIES: "JOB_NO_RETRIES"; EXECUTION_LISTENER_NO_RETRIES: "EXECUTION_LISTENER_NO_RETRIES"; TASK_LISTENER_NO_RETRIES: "TASK_LISTENER_NO_RETRIES"; CONDITION_ERROR: "CONDITION_ERROR"; EXTRACT_VALUE_ERROR: "EXTRACT_VALUE_ERROR"; CALLED_ELEMENT_ERROR: "CALLED_ELEMENT_ERROR"; UNHANDLED_ERROR_EVENT: "UNHANDLED_ERROR_EVENT"; MESSAGE_SIZE_EXCEEDED: "MESSAGE_SIZE_EXCEEDED"; CALLED_DECISION_ERROR: "CALLED_DECISION_ERROR"; DECISION_EVALUATION_ERROR: "DECISION_EVALUATION_ERROR"; FORM_NOT_FOUND: "FORM_NOT_FOUND"; RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND"; }>>>; $notIn: z.ZodOptional<z.ZodArray<z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; UNKNOWN: "UNKNOWN"; IO_MAPPING_ERROR: "IO_MAPPING_ERROR"; JOB_NO_RETRIES: "JOB_NO_RETRIES"; EXECUTION_LISTENER_NO_RETRIES: "EXECUTION_LISTENER_NO_RETRIES"; TASK_LISTENER_NO_RETRIES: "TASK_LISTENER_NO_RETRIES"; CONDITION_ERROR: "CONDITION_ERROR"; EXTRACT_VALUE_ERROR: "EXTRACT_VALUE_ERROR"; CALLED_ELEMENT_ERROR: "CALLED_ELEMENT_ERROR"; UNHANDLED_ERROR_EVENT: "UNHANDLED_ERROR_EVENT"; MESSAGE_SIZE_EXCEEDED: "MESSAGE_SIZE_EXCEEDED"; CALLED_DECISION_ERROR: "CALLED_DECISION_ERROR"; DECISION_EVALUATION_ERROR: "DECISION_EVALUATION_ERROR"; FORM_NOT_FOUND: "FORM_NOT_FOUND"; RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND"; }>>>; }, z.core.$strip>]>>; creationTime: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{ $eq: z.ZodOptional<z.ZodString>; $neq: z.ZodOptional<z.ZodString>; $exists: z.ZodOptional<z.ZodBoolean>; $gt: z.ZodOptional<z.ZodString>; $gte: z.ZodOptional<z.ZodString>; $lt: z.ZodOptional<z.ZodString>; $lte: z.ZodOptional<z.ZodString>; $in: z.ZodOptional<z.ZodArray<z.ZodString>>; }, z.core.$strip>]>>; state: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{ ACTIVE: "ACTIVE"; MIGRATED: "MIGRATED"; RESOLVED: "RESOLVED"; PENDING: "PENDING"; }>, z.ZodObject<{ $eq: z.ZodOptional<z.ZodEnum<{ ACTIVE: "ACTIVE"; MIGRATED: "MIGRATED"; RESOLVED: "RESOLVED"; PENDING: "PENDING"; }>>; $neq: z.ZodOptional<z.ZodEnum<{ ACTIVE: "ACTIVE"; MIGRATED: "MIGRATED"; RESOLVED: "RESOLVED"; PENDING: "PENDING"; }>>; $exists: z.ZodOptional<z.ZodBoolean>; $in: z.ZodOptional<z.ZodArray<z.ZodEnum<{ ACTIVE: "ACTIVE"; MIGRATED: "MIGRATED"; RESOLVED: "RESOLVED"; PENDING: "PENDING"; }>>>; $notIn: z.ZodOptional<z.ZodArray<z.ZodEnum<{ ACTIVE: "ACTIVE"; MIGRATED: "MIGRATED"; RESOLVED: "RESOLVED"; PENDING: "PENDING"; }>>>; }, z.core.$strip>]>>; }, z.core.$strip>>; }, z.core.$strip>; type QueryIncidentsRequestBody = z.infer<typeof queryIncidentsRequestBodySchema>; declare const queryIncidentsResponseBodySchema: z.ZodType<import('./common').QueryResponseBody<{ processDefinitionId: string; errorType: "UNSPECIFIED" | "UNKNOWN" | "IO_MAPPING_ERROR" | "JOB_NO_RETRIES" | "EXECUTION_LISTENER_NO_RETRIES" | "TASK_LISTENER_NO_RETRIES" | "CONDITION_ERROR" | "EXTRACT_VALUE_ERROR" | "CALLED_ELEMENT_ERROR" | "UNHANDLED_ERROR_EVENT" | "MESSAGE_SIZE_EXCEEDED" | "CALLED_DECISION_ERROR" | "DECISION_EVALUATION_ERROR" | "FORM_NOT_FOUND" | "RESOURCE_NOT_FOUND"; errorMessage: string; elementId: string; creationTime: string; state: "ACTIVE" | "MIGRATED" | "RESOLVED" | "PENDING"; tenantId: string; incidentKey: string; processDefinitionKey: string; processInstanceKey: string; elementInstanceKey: string; jobKey: string; }>, unknown, z.core.$ZodTypeInternals<import('./common').QueryResponseBody<{ processDefinitionId: string; errorType: "UNSPECIFIED" | "UNKNOWN" | "IO_MAPPING_ERROR" | "JOB_NO_RETRIES" | "EXECUTION_LISTENER_NO_RETRIES" | "TASK_LISTENER_NO_RETRIES" | "CONDITION_ERROR" | "EXTRACT_VALUE_ERROR" | "CALLED_ELEMENT_ERROR" | "UNHANDLED_ERROR_EVENT" | "MESSAGE_SIZE_EXCEEDED" | "CALLED_DECISION_ERROR" | "DECISION_EVALUATION_ERROR" | "FORM_NOT_FOUND" | "RESOURCE_NOT_FOUND"; errorMessage: string; elementId: string; creationTime: string; state: "ACTIVE" | "MIGRATED" | "RESOLVED" | "PENDING"; tenantId: string; incidentKey: string; processDefinitionKey: string; processInstanceKey: string; elementInstanceKey: string; jobKey: string; }>, unknown>>; type QueryIncidentsResponseBody = z.infer<typeof queryIncidentsResponseBodySchema>; declare const queryIncidents: Endpoint; export { resolveIncident, getIncident, queryIncidents, getIncidentResponseBodySchema, queryIncidentsRequestBodySchema, queryIncidentsResponseBodySchema, incidentErrorTypeSchema, incidentStateSchema, incidentSchema, }; export type { IncidentErrorType, IncidentState, Incident, GetIncidentResponseBody, QueryIncidentsRequestBody, QueryIncidentsResponseBody, };