UNPKG

@vzeta/camunda-api-zod-schemas

Version:

Zod schemas and TypeScript types for Camunda 8 unified API

321 lines (320 loc) 16.7 kB
import { z } from 'zod'; import { Endpoint } from './common'; declare const permissionTypeSchema: z.ZodEnum<{ ACCESS: "ACCESS"; CREATE: "CREATE"; CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_RESOLVE_INCIDENT: "CREATE_BATCH_OPERATION_RESOLVE_INCIDENT"; CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE: "CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE"; CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION: "CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION"; CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION: "CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION"; CREATE_PROCESS_INSTANCE: "CREATE_PROCESS_INSTANCE"; CREATE_DECISION_INSTANCE: "CREATE_DECISION_INSTANCE"; READ: "READ"; READ_PROCESS_INSTANCE: "READ_PROCESS_INSTANCE"; READ_USER_TASK: "READ_USER_TASK"; READ_DECISION_INSTANCE: "READ_DECISION_INSTANCE"; READ_PROCESS_DEFINITION: "READ_PROCESS_DEFINITION"; READ_DECISION_DEFINITION: "READ_DECISION_DEFINITION"; UPDATE: "UPDATE"; UPDATE_PROCESS_INSTANCE: "UPDATE_PROCESS_INSTANCE"; UPDATE_USER_TASK: "UPDATE_USER_TASK"; DELETE: "DELETE"; DELETE_PROCESS: "DELETE_PROCESS"; DELETE_DRD: "DELETE_DRD"; DELETE_FORM: "DELETE_FORM"; DELETE_RESOURCE: "DELETE_RESOURCE"; DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE"; DELETE_DECISION_INSTANCE: "DELETE_DECISION_INSTANCE"; }>; type PermissionType = z.infer<typeof permissionTypeSchema>; declare const resourceTypeSchema: z.ZodEnum<{ AUTHORIZATION: "AUTHORIZATION"; MAPPING_RULE: "MAPPING_RULE"; MESSAGE: "MESSAGE"; BATCH: "BATCH"; BATCH_OPERATION: "BATCH_OPERATION"; APPLICATION: "APPLICATION"; SYSTEM: "SYSTEM"; TENANT: "TENANT"; RESOURCE: "RESOURCE"; PROCESS_DEFINITION: "PROCESS_DEFINITION"; DECISION_REQUIREMENTS_DEFINITION: "DECISION_REQUIREMENTS_DEFINITION"; DECISION_DEFINITION: "DECISION_DEFINITION"; GROUP: "GROUP"; USER: "USER"; ROLE: "ROLE"; }>; type ResourceType = z.infer<typeof resourceTypeSchema>; declare const ownerTypeSchema: z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; GROUP: "GROUP"; USER: "USER"; ROLE: "ROLE"; CLIENT: "CLIENT"; MAPPING: "MAPPING"; }>; type OwnerType = z.infer<typeof ownerTypeSchema>; declare const authorizationSchema: z.ZodObject<{ ownerId: z.ZodString; ownerType: z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; GROUP: "GROUP"; USER: "USER"; ROLE: "ROLE"; CLIENT: "CLIENT"; MAPPING: "MAPPING"; }>; resourceType: z.ZodEnum<{ AUTHORIZATION: "AUTHORIZATION"; MAPPING_RULE: "MAPPING_RULE"; MESSAGE: "MESSAGE"; BATCH: "BATCH"; BATCH_OPERATION: "BATCH_OPERATION"; APPLICATION: "APPLICATION"; SYSTEM: "SYSTEM"; TENANT: "TENANT"; RESOURCE: "RESOURCE"; PROCESS_DEFINITION: "PROCESS_DEFINITION"; DECISION_REQUIREMENTS_DEFINITION: "DECISION_REQUIREMENTS_DEFINITION"; DECISION_DEFINITION: "DECISION_DEFINITION"; GROUP: "GROUP"; USER: "USER"; ROLE: "ROLE"; }>; resourceId: z.ZodString; permissionTypes: z.ZodArray<z.ZodEnum<{ ACCESS: "ACCESS"; CREATE: "CREATE"; CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_RESOLVE_INCIDENT: "CREATE_BATCH_OPERATION_RESOLVE_INCIDENT"; CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE: "CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE"; CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION: "CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION"; CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION: "CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION"; CREATE_PROCESS_INSTANCE: "CREATE_PROCESS_INSTANCE"; CREATE_DECISION_INSTANCE: "CREATE_DECISION_INSTANCE"; READ: "READ"; READ_PROCESS_INSTANCE: "READ_PROCESS_INSTANCE"; READ_USER_TASK: "READ_USER_TASK"; READ_DECISION_INSTANCE: "READ_DECISION_INSTANCE"; READ_PROCESS_DEFINITION: "READ_PROCESS_DEFINITION"; READ_DECISION_DEFINITION: "READ_DECISION_DEFINITION"; UPDATE: "UPDATE"; UPDATE_PROCESS_INSTANCE: "UPDATE_PROCESS_INSTANCE"; UPDATE_USER_TASK: "UPDATE_USER_TASK"; DELETE: "DELETE"; DELETE_PROCESS: "DELETE_PROCESS"; DELETE_DRD: "DELETE_DRD"; DELETE_FORM: "DELETE_FORM"; DELETE_RESOURCE: "DELETE_RESOURCE"; DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE"; DELETE_DECISION_INSTANCE: "DELETE_DECISION_INSTANCE"; }>>; authorizationKey: z.ZodString; }, z.core.$strip>; type Authorization = z.infer<typeof authorizationSchema>; declare const createAuthorizationRequestBodySchema: z.ZodObject<{ ownerType: z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; GROUP: "GROUP"; USER: "USER"; ROLE: "ROLE"; CLIENT: "CLIENT"; MAPPING: "MAPPING"; }>; resourceType: z.ZodEnum<{ AUTHORIZATION: "AUTHORIZATION"; MAPPING_RULE: "MAPPING_RULE"; MESSAGE: "MESSAGE"; BATCH: "BATCH"; BATCH_OPERATION: "BATCH_OPERATION"; APPLICATION: "APPLICATION"; SYSTEM: "SYSTEM"; TENANT: "TENANT"; RESOURCE: "RESOURCE"; PROCESS_DEFINITION: "PROCESS_DEFINITION"; DECISION_REQUIREMENTS_DEFINITION: "DECISION_REQUIREMENTS_DEFINITION"; DECISION_DEFINITION: "DECISION_DEFINITION"; GROUP: "GROUP"; USER: "USER"; ROLE: "ROLE"; }>; ownerId: z.ZodString; resourceId: z.ZodString; permissionTypes: z.ZodArray<z.ZodEnum<{ ACCESS: "ACCESS"; CREATE: "CREATE"; CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_RESOLVE_INCIDENT: "CREATE_BATCH_OPERATION_RESOLVE_INCIDENT"; CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE: "CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE"; CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION: "CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION"; CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION: "CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION"; CREATE_PROCESS_INSTANCE: "CREATE_PROCESS_INSTANCE"; CREATE_DECISION_INSTANCE: "CREATE_DECISION_INSTANCE"; READ: "READ"; READ_PROCESS_INSTANCE: "READ_PROCESS_INSTANCE"; READ_USER_TASK: "READ_USER_TASK"; READ_DECISION_INSTANCE: "READ_DECISION_INSTANCE"; READ_PROCESS_DEFINITION: "READ_PROCESS_DEFINITION"; READ_DECISION_DEFINITION: "READ_DECISION_DEFINITION"; UPDATE: "UPDATE"; UPDATE_PROCESS_INSTANCE: "UPDATE_PROCESS_INSTANCE"; UPDATE_USER_TASK: "UPDATE_USER_TASK"; DELETE: "DELETE"; DELETE_PROCESS: "DELETE_PROCESS"; DELETE_DRD: "DELETE_DRD"; DELETE_FORM: "DELETE_FORM"; DELETE_RESOURCE: "DELETE_RESOURCE"; DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE"; DELETE_DECISION_INSTANCE: "DELETE_DECISION_INSTANCE"; }>>; }, z.core.$strip>; type CreateAuthorizationRequestBody = z.infer<typeof createAuthorizationRequestBodySchema>; declare const updateAuthorizationRequestBodySchema: z.ZodObject<{ ownerType: z.ZodOptional<z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; GROUP: "GROUP"; USER: "USER"; ROLE: "ROLE"; CLIENT: "CLIENT"; MAPPING: "MAPPING"; }>>; resourceType: z.ZodOptional<z.ZodEnum<{ AUTHORIZATION: "AUTHORIZATION"; MAPPING_RULE: "MAPPING_RULE"; MESSAGE: "MESSAGE"; BATCH: "BATCH"; BATCH_OPERATION: "BATCH_OPERATION"; APPLICATION: "APPLICATION"; SYSTEM: "SYSTEM"; TENANT: "TENANT"; RESOURCE: "RESOURCE"; PROCESS_DEFINITION: "PROCESS_DEFINITION"; DECISION_REQUIREMENTS_DEFINITION: "DECISION_REQUIREMENTS_DEFINITION"; DECISION_DEFINITION: "DECISION_DEFINITION"; GROUP: "GROUP"; USER: "USER"; ROLE: "ROLE"; }>>; ownerId: z.ZodOptional<z.ZodString>; resourceId: z.ZodOptional<z.ZodString>; permissionTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<{ ACCESS: "ACCESS"; CREATE: "CREATE"; CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE: "CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE"; CREATE_BATCH_OPERATION_RESOLVE_INCIDENT: "CREATE_BATCH_OPERATION_RESOLVE_INCIDENT"; CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE: "CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE"; CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION: "CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION"; CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION: "CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION"; CREATE_PROCESS_INSTANCE: "CREATE_PROCESS_INSTANCE"; CREATE_DECISION_INSTANCE: "CREATE_DECISION_INSTANCE"; READ: "READ"; READ_PROCESS_INSTANCE: "READ_PROCESS_INSTANCE"; READ_USER_TASK: "READ_USER_TASK"; READ_DECISION_INSTANCE: "READ_DECISION_INSTANCE"; READ_PROCESS_DEFINITION: "READ_PROCESS_DEFINITION"; READ_DECISION_DEFINITION: "READ_DECISION_DEFINITION"; UPDATE: "UPDATE"; UPDATE_PROCESS_INSTANCE: "UPDATE_PROCESS_INSTANCE"; UPDATE_USER_TASK: "UPDATE_USER_TASK"; DELETE: "DELETE"; DELETE_PROCESS: "DELETE_PROCESS"; DELETE_DRD: "DELETE_DRD"; DELETE_FORM: "DELETE_FORM"; DELETE_RESOURCE: "DELETE_RESOURCE"; DELETE_PROCESS_INSTANCE: "DELETE_PROCESS_INSTANCE"; DELETE_DECISION_INSTANCE: "DELETE_DECISION_INSTANCE"; }>>>; }, z.core.$strip>; type UpdateAuthorizationRequestBody = z.infer<typeof updateAuthorizationRequestBodySchema>; declare const queryAuthorizationsRequestBodySchema: z.ZodObject<{ sort: z.ZodOptional<z.ZodArray<z.ZodObject<{ field: z.ZodEnum<{ ownerType: "ownerType"; resourceType: "resourceType"; ownerId: "ownerId"; resourceId: "resourceId"; }>; 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<{ ownerType: z.ZodOptional<z.ZodEnum<{ UNSPECIFIED: "UNSPECIFIED"; GROUP: "GROUP"; USER: "USER"; ROLE: "ROLE"; CLIENT: "CLIENT"; MAPPING: "MAPPING"; }>>; resourceType: z.ZodOptional<z.ZodEnum<{ AUTHORIZATION: "AUTHORIZATION"; MAPPING_RULE: "MAPPING_RULE"; MESSAGE: "MESSAGE"; BATCH: "BATCH"; BATCH_OPERATION: "BATCH_OPERATION"; APPLICATION: "APPLICATION"; SYSTEM: "SYSTEM"; TENANT: "TENANT"; RESOURCE: "RESOURCE"; PROCESS_DEFINITION: "PROCESS_DEFINITION"; DECISION_REQUIREMENTS_DEFINITION: "DECISION_REQUIREMENTS_DEFINITION"; DECISION_DEFINITION: "DECISION_DEFINITION"; GROUP: "GROUP"; USER: "USER"; ROLE: "ROLE"; }>>; ownerId: z.ZodOptional<z.ZodString>; resourceId: z.ZodOptional<z.ZodArray<z.ZodString>>; }, z.core.$strip>>; }, z.core.$strip>; type QueryAuthorizationsRequestBody = z.infer<typeof queryAuthorizationsRequestBodySchema>; declare const queryAuthorizationsResponseBodySchema: z.ZodType<import('./common').QueryResponseBody<{ ownerId: string; ownerType: "UNSPECIFIED" | "GROUP" | "USER" | "ROLE" | "CLIENT" | "MAPPING"; resourceType: "AUTHORIZATION" | "MAPPING_RULE" | "MESSAGE" | "BATCH" | "BATCH_OPERATION" | "APPLICATION" | "SYSTEM" | "TENANT" | "RESOURCE" | "PROCESS_DEFINITION" | "DECISION_REQUIREMENTS_DEFINITION" | "DECISION_DEFINITION" | "GROUP" | "USER" | "ROLE"; resourceId: string; permissionTypes: ("ACCESS" | "CREATE" | "CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE" | "CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE" | "CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE" | "CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE" | "CREATE_BATCH_OPERATION_RESOLVE_INCIDENT" | "CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE" | "CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION" | "CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION" | "CREATE_PROCESS_INSTANCE" | "CREATE_DECISION_INSTANCE" | "READ" | "READ_PROCESS_INSTANCE" | "READ_USER_TASK" | "READ_DECISION_INSTANCE" | "READ_PROCESS_DEFINITION" | "READ_DECISION_DEFINITION" | "UPDATE" | "UPDATE_PROCESS_INSTANCE" | "UPDATE_USER_TASK" | "DELETE" | "DELETE_PROCESS" | "DELETE_DRD" | "DELETE_FORM" | "DELETE_RESOURCE" | "DELETE_PROCESS_INSTANCE" | "DELETE_DECISION_INSTANCE")[]; authorizationKey: string; }>, unknown, z.core.$ZodTypeInternals<import('./common').QueryResponseBody<{ ownerId: string; ownerType: "UNSPECIFIED" | "GROUP" | "USER" | "ROLE" | "CLIENT" | "MAPPING"; resourceType: "AUTHORIZATION" | "MAPPING_RULE" | "MESSAGE" | "BATCH" | "BATCH_OPERATION" | "APPLICATION" | "SYSTEM" | "TENANT" | "RESOURCE" | "PROCESS_DEFINITION" | "DECISION_REQUIREMENTS_DEFINITION" | "DECISION_DEFINITION" | "GROUP" | "USER" | "ROLE"; resourceId: string; permissionTypes: ("ACCESS" | "CREATE" | "CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE" | "CREATE_BATCH_OPERATION_DELETE_PROCESS_INSTANCE" | "CREATE_BATCH_OPERATION_MIGRATE_PROCESS_INSTANCE" | "CREATE_BATCH_OPERATION_MODIFY_PROCESS_INSTANCE" | "CREATE_BATCH_OPERATION_RESOLVE_INCIDENT" | "CREATE_BATCH_OPERATION_DELETE_DECISION_INSTANCE" | "CREATE_BATCH_OPERATION_DELETE_DECISION_DEFINITION" | "CREATE_BATCH_OPERATION_DELETE_PROCESS_DEFINITION" | "CREATE_PROCESS_INSTANCE" | "CREATE_DECISION_INSTANCE" | "READ" | "READ_PROCESS_INSTANCE" | "READ_USER_TASK" | "READ_DECISION_INSTANCE" | "READ_PROCESS_DEFINITION" | "READ_DECISION_DEFINITION" | "UPDATE" | "UPDATE_PROCESS_INSTANCE" | "UPDATE_USER_TASK" | "DELETE" | "DELETE_PROCESS" | "DELETE_DRD" | "DELETE_FORM" | "DELETE_RESOURCE" | "DELETE_PROCESS_INSTANCE" | "DELETE_DECISION_INSTANCE")[]; authorizationKey: string; }>, unknown>>; type QueryAuthorizationsResponseBody = z.infer<typeof queryAuthorizationsResponseBodySchema>; declare const createAuthorization: Endpoint; declare const updateAuthorization: Endpoint<{ authorizationKey: string; }>; declare const getAuthorization: Endpoint<{ authorizationKey: string; }>; declare const deleteAuthorization: Endpoint<{ authorizationKey: string; }>; declare const queryAuthorizations: Endpoint; export { permissionTypeSchema, resourceTypeSchema, ownerTypeSchema, authorizationSchema, createAuthorizationRequestBodySchema, updateAuthorizationRequestBodySchema, queryAuthorizationsRequestBodySchema, queryAuthorizationsResponseBodySchema, createAuthorization, updateAuthorization, getAuthorization, deleteAuthorization, queryAuthorizations, }; export type { PermissionType, ResourceType, OwnerType, Authorization, CreateAuthorizationRequestBody, UpdateAuthorizationRequestBody, QueryAuthorizationsRequestBody, QueryAuthorizationsResponseBody, };