import {z} from 'zod' export type AccountTaskStatus = 'todo' | 'dismissed' | 'in-progress' | 'done'; export type AccountTaskTag = 'certificate-of-good-standing' | 'charity-registration' | 'charity-registration-renewal' | 'employee-final-wage-payment' | 'employee-new-hire-reporting' | 'employee-onboarding' | 'employee-termination' | 'exemption' | 'foreign-qualification' | 'initial-statement' | 'local-business-setup' | 'local-payroll-setup' | 'newspaper-publication' | 'notices' | 'payroll-setup' | 'registered-agent' | 'sos-report' | 'setup'; export type GetApiTasksArgs = {definition_id?: (string | null) | undefined, start_date?: (string | null) | undefined, end_date?: (string | null) | undefined, include_managed?: (boolean | null) | undefined, status?: (Array | null) | undefined, tags?: (Array | null) | undefined}; export type GetApiTasksOptions = {baseUrl: string, OAuth2PasswordBearer?: string | undefined, fetch?: typeof fetch | undefined}; export const taskContextEmployee = z.object({scope: z.literal("employee").optional(), employee_id: z.string()}); export const taskContextLegalEntity = z.object({scope: z.literal("legal-entity").optional(), legal_entity_id: z.string()}); export const taskDefinitionType = z.enum(["requirement", "data-collection", "criteria-collection"]); export const locationRef = z.object({id: z.string(), code: z.string(), name: z.string()}); export const accountTaskDefinition = z.object({id: z.string(), title: z.string(), summary: z.string().nullable().optional(), description: z.string(), type: taskDefinitionType, resources: z.array(z.record(z.string(), z.string())), location: locationRef}); export const actionField = z.object({name: z.string(), description: z.string(), required: z.boolean(), type: z.string()}); export const accountTaskResolutionAction = z.object({type: z.literal("action").optional(), description: z.string(), method: z.string(), url: z.string(), content_type: z.string(), fields: z.array(actionField)}); export const accountTaskAutomationFormSpec = z.object({}); export const accountTaskResolutionAutomate = z.object({type: z.literal("automate").optional(), form_spec: accountTaskAutomationFormSpec, submit_url: z.string(), hosted_url: z.string()}); export const accountTaskResolutionManualStepPath = z.object({type: z.string(), value: z.string(), text: z.string().nullable().optional()}); export const accountTaskResolutionManualStep = z.object({id: z.string(), title: z.string(), description: z.string(), paths: z.array(accountTaskResolutionManualStepPath), order: z.number().int()}); export const accountTaskResolutionManual = z.object({type: z.literal("manual").optional(), steps: z.array(accountTaskResolutionManualStep)}); export const accountTaskResolutionRedirect = z.object({type: z.literal("redirect").optional(), url: z.string()}); export const accountManagedProvider = z.object({id: z.string(), name: z.string()}); export const accountTaskStatus = z.enum(["todo", "dismissed", "in-progress", "done"]); export const feeFixed = z.object({type: z.literal("fixed").optional(), amount: z.string()}); export const feeRange = z.object({type: z.literal("range").optional(), min: z.string(), max: z.string()}); export const feeVariable = z.object({type: z.literal("variable").optional(), reason: z.string()}); export const eTAUnit = z.enum(["hour", "day", "week", "month"]); export const accountTaskEstimation = z.object({min: z.number().int(), max: z.number().int(), unit: eTAUnit}); export const accountTaskETA = z.object({estimation: accountTaskEstimation, earliest_date: z.string().nullable().optional(), latest_date: z.string().nullable().optional()}); export const taskPriority = z.enum(["high", "medium", "low"]); export const accountTaskCriteria = z.object({key: z.string(), reason: z.string(), data: z.union([z.object({}), z.unknown()]).optional()}); export const accountTask = z.object({id: z.string(), context: z.discriminatedUnion("scope", [taskContextEmployee, taskContextLegalEntity]), definition: accountTaskDefinition, resolutions: z.record(z.string(), z.discriminatedUnion("type", [accountTaskResolutionAction, accountTaskResolutionAutomate, accountTaskResolutionManual, accountTaskResolutionRedirect])), default_resolution_name: z.string(), managed_provider: accountManagedProvider.nullable().optional(), status: accountTaskStatus, period_start_date: z.string().nullable().optional(), period_end_date: z.string().nullable().optional(), due_date: z.string().nullable().optional(), unblocks: z.array(accountTaskDefinition), fee: z.union([feeFixed, feeRange, feeVariable]).nullable().optional(), eta: accountTaskETA.nullable().optional(), priority: taskPriority.optional(), criteria_met: z.array(accountTaskCriteria), tags: z.array(z.string()).nullable().optional()}); export const getApiTasksResponse = z.array(accountTask); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * List Tasks * * GET /tasks * * Also accepts auth: OAuth2PasswordBearer */ export const getApiTasks = async (args: GetApiTasksArgs, options: GetApiTasksOptions) => { const {baseUrl, fetch: fetchFn = fetch, OAuth2PasswordBearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.definition_id != null) query.append("definition_id", String(args.definition_id)) if (args.start_date != null) query.append("start_date", String(args.start_date)) if (args.end_date != null) query.append("end_date", String(args.end_date)) if (args.include_managed != null) query.append("include_managed", String(args.include_managed)) for (const item of args.status ?? []) query.append("status", String(item)) for (const item of args.tags ?? []) query.append("tags", String(item)) if (OAuth2PasswordBearer !== undefined) headers.set('authorization', `Bearer ${OAuth2PasswordBearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/tasks${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiTasksResponse, await res.json()) };