import {z} from 'zod' export type FormEntrySortField = 'dateSent' | 'status' | 'deadline' | 'dateSubmitted' | 'requestFormEntryStatus'; export type FormEntrySortOrder = 'ascending' | 'descending'; export type GetApiV4EntriesMetadataFormsFormIdArgs = {formId: string, continuationToken?: string | undefined, size?: number | undefined, ProjectIds?: Array | undefined, States?: (Array<'submitted' | 'editable'>) | undefined, 'SortBy.sort'?: FormEntrySortField | undefined, 'SortBy.direction'?: FormEntrySortOrder | undefined, Statuses?: Array | undefined, SentDateFrom?: string | undefined, SentDateTo?: string | undefined, DeadlineDateFrom?: string | undefined, DeadlineDateTo?: string | undefined, RequestFormEntryStatuses?: (Array<'new' | 'in_progress' | 'accepted' | 'declined' | 'completed'>) | undefined, SubmittedDateFrom?: string | undefined, SubmittedDateTo?: string | undefined}; export type GetApiV4EntriesMetadataFormsFormIdOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const anyFormTypeInitialFormEntryMetadataResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable()}); export const anyFormTypeAdditionalFormEntryMetadataResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable()}); export const anyFormTypeInternalFormEntryMetadataResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable()}); export const anyFormTypeReferenceFormEntryMetadataResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable()}); export const anyFormTypeReviewFormEntryMetadataResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable()}); export const anyFormTypeEligibilityFormEntryMetadataResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable()}); export const anyFormTypeRequestFormEntryMetadataResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable()}); export const continuationTokenResponseAnyFormTypeEntryMetadataResponse = z.object({continuationToken: z.string().nullable().optional(), items: z.array(z.discriminatedUnion("formType", [anyFormTypeInitialFormEntryMetadataResponse, anyFormTypeAdditionalFormEntryMetadataResponse, anyFormTypeInternalFormEntryMetadataResponse, anyFormTypeReferenceFormEntryMetadataResponse, anyFormTypeReviewFormEntryMetadataResponse, anyFormTypeEligibilityFormEntryMetadataResponse, anyFormTypeRequestFormEntryMetadataResponse])).nullable().optional()}); 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 }; /** * Get a page of form entry metadata * * GET /v4/entries/metadata/forms/{formId} */ export const getApiV4EntriesMetadataFormsFormId = async (args: GetApiV4EntriesMetadataFormsFormIdArgs, options?: GetApiV4EntriesMetadataFormsFormIdOptions) => { const {baseUrl = "https://submittable-api.submittable.com", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.continuationToken != null) query.append("continuationToken", String(args.continuationToken)) if (args.size != null) query.append("size", String(args.size)) for (const item of args.ProjectIds ?? []) query.append("ProjectIds", String(item)) for (const item of args.States ?? []) query.append("States", String(item)) if (args['SortBy.sort'] != null) query.append("SortBy.sort", String(args['SortBy.sort'])) if (args['SortBy.direction'] != null) query.append("SortBy.direction", String(args['SortBy.direction'])) for (const item of args.Statuses ?? []) query.append("Statuses", String(item)) if (args.SentDateFrom != null) query.append("SentDateFrom", String(args.SentDateFrom)) if (args.SentDateTo != null) query.append("SentDateTo", String(args.SentDateTo)) if (args.DeadlineDateFrom != null) query.append("DeadlineDateFrom", String(args.DeadlineDateFrom)) if (args.DeadlineDateTo != null) query.append("DeadlineDateTo", String(args.DeadlineDateTo)) for (const item of args.RequestFormEntryStatuses ?? []) query.append("RequestFormEntryStatuses", String(item)) if (args.SubmittedDateFrom != null) query.append("SubmittedDateFrom", String(args.SubmittedDateFrom)) if (args.SubmittedDateTo != null) query.append("SubmittedDateTo", String(args.SubmittedDateTo)) const url = `${baseUrl.replace(/\/+$/, '')}/v4/entries/metadata/forms/${encodeURIComponent(String(args.formId))}${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(continuationTokenResponseAnyFormTypeEntryMetadataResponse, await res.json()) };