import {z} from 'zod' export type GetApiV4ProjectsProjectIdArgs = {projectId: string}; export type GetApiV4ProjectsProjectIdOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const reviewStageResponse = z.object({reviewStageId: z.string().nullable().optional(), stageName: z.string().nullable().optional(), stageOrder: z.number().int().optional(), type: z.enum(["no_review", "yes_no_maybe", "custom_review", "automated_review"]).nullable().optional(), formId: z.string().nullable().optional(), reviewerUserIds: z.array(z.string()).nullable().optional(), hasCompletedReviews: z.boolean().optional(), isDeleted: z.boolean().optional(), randomAssignmentCount: z.number().int().nullable().optional(), nextStageOnCompletedReviews: z.string().nullable().optional()}); export const gallerySortOrder = z.enum(["default", "ascending", "descending", "random"]); export const galleryVotePeriod = z.enum(["day", "week", "entire"]); export const galleryFieldResponse = z.object({fieldId: z.string().optional(), publicView: z.boolean().optional(), allowFilter: z.boolean().optional(), displayFilterShortName: z.string().nullable().optional()}); export const projectGalleryResponse = z.object({enableGallery: z.boolean().optional(), galleryTitle: z.string().nullable().optional(), galleryViewDisplaySubmitter: z.boolean().optional(), galleryViewLabel: z.string().nullable().optional(), galleryViewLabels: z.array(z.string()).nullable().optional(), enableGalleryLabelFilter: z.boolean().optional(), gallerySortOrder: gallerySortOrder.optional(), enableGalleryVoting: z.boolean().optional(), enableAnonymousGalleryVoting: z.boolean().optional(), enableValidatedPublicVoting: z.boolean().optional(), enableLimitGalleryVotes: z.boolean().optional(), voteLimitFrequency: z.number().int().nullable().optional(), voteLimitPeriod: galleryVotePeriod.optional(), hideGalleryVotes: z.boolean().optional(), enableAutomaticVoting: z.boolean().optional(), showSubmitButtonOnGallery: z.boolean().optional(), shareGalleryLink: z.boolean().optional(), galleryConfirmationLinkText: z.string().nullable().optional(), galleryGuidelines: z.string().nullable().optional(), galleryGuidelinesJson: z.string().nullable().optional(), fields: z.array(galleryFieldResponse).nullable().optional(), galleryScoresLastResetDate: z.string().nullable().optional()}); export const requestFormCriteriaResponse = z.object({criteriaId: z.string().optional(), requestFormId: z.string().optional(), start: z.string().nullable().optional(), end: z.string().nullable().optional(), labelIds: z.array(z.string()).nullable().optional(), status: z.enum(["new", "in_progress", "accepted", "declined", "withdrawn", "completed", "editable", "viewed", "received", "published"]).nullable().optional(), order: z.number().int().optional()}); export const projectResponse = z.object({projectId: z.string().optional(), organizationId: z.string().optional(), name: z.string().nullable().optional(), guidelinesHtml: z.string().nullable().optional(), termsOfUse: z.string().nullable().optional(), initialFormId: z.string().nullable().optional(), internalFormId: z.string().nullable().optional(), eligibilityFormId: z.string().nullable().optional(), customIneligibleMessage: z.string().nullable().optional(), startsAt: z.string().nullable().optional(), endsAt: z.string().nullable().optional(), isHidden: z.boolean().optional(), isLive: z.boolean().optional(), isArchived: z.boolean().optional(), shouldHideBlindFields: z.boolean().optional(), blindLevel: z.enum(["None", "Level1", "Level2", "Level3", "Level4", "Level5"]).nullable().optional(), createdByUserId: z.string().optional(), createdAt: z.string().nullable().optional(), concealPublicOrgInfo: z.boolean().optional(), requirePublicOrgId: z.boolean().optional(), enableCollaborativeDrafts: z.boolean().optional(), requireValidatedEmail: z.boolean().optional(), enableUsBankCheckPayment: z.boolean().optional(), enableUsBankAchPayment: z.boolean().optional(), enableUsBankPrepaidCardPayment: z.boolean().optional(), usBankPrepaidCardDisclosureUrl: z.string().nullable().optional(), usBankAchAccountIsIndividual: z.boolean().nullable().optional(), enableOrganizationSearch: z.boolean().optional(), organizationSearchByEIN: z.boolean().optional(), organizationSearchByUEI: z.boolean().optional(), discoverTags: z.array(z.string()).nullable().optional(), defaultNoteVisibility: z.enum(["staff", "private", "All Staff", "Entire Team"]).nullable().optional(), emailOnSubmission: z.boolean().nullable().optional(), autoResponseTemplateId: z.string().nullable().optional(), successUrl: z.string().nullable().optional(), reviewStages: z.array(reviewStageResponse).nullable().optional(), enforceSubmissionCap: z.boolean().optional(), numSubmissionsAllowed: z.number().int().optional(), submissionCapDisplaySubmissionCap: z.boolean().optional(), sendSubmissionCapNotification: z.boolean().optional(), submissionCapNotificationPercentage: z.number().int().nullable().optional(), gallery: projectGalleryResponse.optional(), enableAwardPaymentVisibility: z.boolean().optional(), limitMultipleSubmissions: z.boolean().optional(), enableEditReviews: z.boolean().optional(), totalSubmissionCount: z.number().int().optional(), requestFormCriteria: z.array(requestFormCriteriaResponse).nullable().optional(), enableReimbursements: z.boolean().optional(), allowedFunds: z.array(z.string()).nullable().optional(), budgetCategories: z.array(z.string()).nullable().optional(), organizationSearchAgencies: z.array(z.string()).nullable().optional(), isConcealed: z.boolean().optional(), isAdvancedConcealed: z.boolean().optional(), visibleRoles: z.array(z.string()).nullable().optional(), fundsDistributionAccountId: z.string().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 project * * GET /v4/projects/{projectId} */ export const getApiV4ProjectsProjectId = async (args: GetApiV4ProjectsProjectIdArgs, options?: GetApiV4ProjectsProjectIdOptions) => { const {baseUrl = "https://submittable-api.submittable.com", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") const url = `${baseUrl.replace(/\/+$/, '')}/v4/projects/${encodeURIComponent(String(args.projectId))}${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(projectResponse, await res.json()) };