import {z} from 'zod' export type TitleFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type NameFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type AddressFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type ShortAnswerFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type LongAnswerFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type SingleCheckboxFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type MultipleResponseFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type SingleResponseFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type FileUploadFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type TableFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type NumberFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type DateFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type EmailFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type WebsiteFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type PhoneFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type CoverLetterFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type TextOnlyFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type ReferenceFormFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type DividerFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type SingleRatingFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type MultipleRatingFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type DropdownRatingFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type DropdownListFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type CharityCheckFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type EligibilityCharityCheckFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type EligibilitySingleCheckboxFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type EligibilitySingleResponseFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type EligibilityDropdownListFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type BankDetailsFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type FraudPreventionFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type SsnItinFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type EinFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type UeiFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type DisclosureFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type DataExtractionFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type ESignFieldRequest = {fieldType: string, formFieldId?: (string | null) | undefined, additionalInstructions?: (string | null) | undefined, isRequired?: boolean | undefined, branchId?: (string | null) | undefined, blockId?: (string | null) | undefined, tags?: (Array | null) | undefined, shareFeedback?: boolean | undefined}; export type BranchRequest = {branchId: string, label: string, color: string}; export type BlockRequest = {blockId: string, blockType: 'payment'}; export type InitialFormRequest = {formType: 'additional' | 'initial' | 'reference' | 'review' | 'internal' | 'eligibility' | 'request', name: string, fields?: (Array | null) | undefined, branches?: (Array | null) | undefined, blocks?: (Array | null) | undefined}; export type AdditionalFormRequest = {formType: 'additional' | 'initial' | 'reference' | 'review' | 'internal' | 'eligibility' | 'request', name: string, fields?: (Array | null) | undefined, branches?: (Array | null) | undefined, blocks?: (Array | null) | undefined}; export type ReferenceFormRequest = {formType: 'additional' | 'initial' | 'reference' | 'review' | 'internal' | 'eligibility' | 'request', name: string, fields?: (Array | null) | undefined, branches?: (Array | null) | undefined, blocks?: (Array | null) | undefined}; export type ReviewFormRequest = {formType: 'additional' | 'initial' | 'reference' | 'review' | 'internal' | 'eligibility' | 'request', name: string, fields?: (Array | null) | undefined, branches?: (Array | null) | undefined, blocks?: (Array | null) | undefined}; export type InternalFormRequest = {formType: 'additional' | 'initial' | 'reference' | 'review' | 'internal' | 'eligibility' | 'request', name: string, fields?: (Array | null) | undefined, branches?: (Array | null) | undefined, blocks?: (Array | null) | undefined}; export type EligibilityFormRequest = {formType: 'additional' | 'initial' | 'reference' | 'review' | 'internal' | 'eligibility' | 'request', name: string, fields?: (Array | null) | undefined, branches?: (Array | null) | undefined, blocks?: (Array | null) | undefined}; export type RequestFormRequest = {formType: 'additional' | 'initial' | 'reference' | 'review' | 'internal' | 'eligibility' | 'request', name: string, fields?: (Array | null) | undefined, branches?: (Array | null) | undefined, blocks?: (Array | null) | undefined}; export type CreateApiV4FormsArgs = {body: InitialFormRequest | AdditionalFormRequest | ReferenceFormRequest | ReviewFormRequest | InternalFormRequest | EligibilityFormRequest | RequestFormRequest}; export type CreateApiV4FormsOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const titleFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const nameFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const addressFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const shortAnswerFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const longAnswerFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const singleCheckboxFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const multipleResponseFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const singleResponseFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const fileUploadFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const tableFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const numberFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const dateFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const emailFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const websiteFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const phoneFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const coverLetterFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const textOnlyFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const referenceFormFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const dividerFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const singleRatingFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const multipleRatingFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const dropdownRatingFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const dropdownListFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const charityCheckFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const eligibilityCharityCheckFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const eligibilitySingleCheckboxFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const eligibilitySingleResponseFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const eligibilityDropdownListFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const bankDetailsFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const fraudPreventionFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const ssnItinFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const einFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const ueiFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const disclosureFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const dataExtractionFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const eSignFieldResponse = z.object({fieldType: z.string().nullable(), formFieldId: z.string().nullable().optional(), label: z.string().nullable().optional(), additionalInstructions: z.string().nullable().optional(), isRequired: z.boolean().optional(), branchId: z.string().nullable().optional(), blockId: z.string().nullable().optional(), tags: z.array(z.string()).nullable().optional(), shareFeedback: z.boolean().optional(), isEditable: z.boolean().nullable().optional()}); export const branchResponse = z.object({branchId: z.string().nullable().optional(), label: z.string().nullable().optional(), color: z.string().nullable().optional()}); export const blockResponse = z.object({blockId: z.string().nullable().optional(), blockType: z.literal("payment").nullable().optional()}); export const initialFormResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable(), formId: z.string().nullable().optional(), name: z.string().nullable().optional(), fields: z.array(z.discriminatedUnion("fieldType", [titleFieldResponse, nameFieldResponse, addressFieldResponse, shortAnswerFieldResponse, longAnswerFieldResponse, singleCheckboxFieldResponse, multipleResponseFieldResponse, singleResponseFieldResponse, fileUploadFieldResponse, tableFieldResponse, numberFieldResponse, dateFieldResponse, emailFieldResponse, websiteFieldResponse, phoneFieldResponse, coverLetterFieldResponse, textOnlyFieldResponse, referenceFormFieldResponse, dividerFieldResponse, singleRatingFieldResponse, multipleRatingFieldResponse, dropdownRatingFieldResponse, dropdownListFieldResponse, charityCheckFieldResponse, eligibilityCharityCheckFieldResponse, eligibilitySingleCheckboxFieldResponse, eligibilitySingleResponseFieldResponse, eligibilityDropdownListFieldResponse, bankDetailsFieldResponse, fraudPreventionFieldResponse, ssnItinFieldResponse, einFieldResponse, ueiFieldResponse, disclosureFieldResponse, dataExtractionFieldResponse, eSignFieldResponse])).nullable().optional(), branches: z.array(branchResponse).nullable().optional(), blocks: z.array(blockResponse).nullable().optional(), createdBy: z.string().optional(), createdAt: z.string().nullable().optional(), updatedBy: z.string().optional(), updatedAt: z.string().nullable().optional(), isDeleted: z.boolean().optional()}); export const additionalFormResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable(), formId: z.string().nullable().optional(), name: z.string().nullable().optional(), fields: z.array(z.discriminatedUnion("fieldType", [titleFieldResponse, nameFieldResponse, addressFieldResponse, shortAnswerFieldResponse, longAnswerFieldResponse, singleCheckboxFieldResponse, multipleResponseFieldResponse, singleResponseFieldResponse, fileUploadFieldResponse, tableFieldResponse, numberFieldResponse, dateFieldResponse, emailFieldResponse, websiteFieldResponse, phoneFieldResponse, coverLetterFieldResponse, textOnlyFieldResponse, referenceFormFieldResponse, dividerFieldResponse, singleRatingFieldResponse, multipleRatingFieldResponse, dropdownRatingFieldResponse, dropdownListFieldResponse, charityCheckFieldResponse, eligibilityCharityCheckFieldResponse, eligibilitySingleCheckboxFieldResponse, eligibilitySingleResponseFieldResponse, eligibilityDropdownListFieldResponse, bankDetailsFieldResponse, fraudPreventionFieldResponse, ssnItinFieldResponse, einFieldResponse, ueiFieldResponse, disclosureFieldResponse, dataExtractionFieldResponse, eSignFieldResponse])).nullable().optional(), branches: z.array(branchResponse).nullable().optional(), blocks: z.array(blockResponse).nullable().optional(), createdBy: z.string().optional(), createdAt: z.string().nullable().optional(), updatedBy: z.string().optional(), updatedAt: z.string().nullable().optional(), isDeleted: z.boolean().optional()}); export const referenceFormResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable(), formId: z.string().nullable().optional(), name: z.string().nullable().optional(), fields: z.array(z.discriminatedUnion("fieldType", [titleFieldResponse, nameFieldResponse, addressFieldResponse, shortAnswerFieldResponse, longAnswerFieldResponse, singleCheckboxFieldResponse, multipleResponseFieldResponse, singleResponseFieldResponse, fileUploadFieldResponse, tableFieldResponse, numberFieldResponse, dateFieldResponse, emailFieldResponse, websiteFieldResponse, phoneFieldResponse, coverLetterFieldResponse, textOnlyFieldResponse, referenceFormFieldResponse, dividerFieldResponse, singleRatingFieldResponse, multipleRatingFieldResponse, dropdownRatingFieldResponse, dropdownListFieldResponse, charityCheckFieldResponse, eligibilityCharityCheckFieldResponse, eligibilitySingleCheckboxFieldResponse, eligibilitySingleResponseFieldResponse, eligibilityDropdownListFieldResponse, bankDetailsFieldResponse, fraudPreventionFieldResponse, ssnItinFieldResponse, einFieldResponse, ueiFieldResponse, disclosureFieldResponse, dataExtractionFieldResponse, eSignFieldResponse])).nullable().optional(), branches: z.array(branchResponse).nullable().optional(), blocks: z.array(blockResponse).nullable().optional(), createdBy: z.string().optional(), createdAt: z.string().nullable().optional(), updatedBy: z.string().optional(), updatedAt: z.string().nullable().optional(), isDeleted: z.boolean().optional()}); export const reviewFormResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable(), formId: z.string().nullable().optional(), name: z.string().nullable().optional(), fields: z.array(z.discriminatedUnion("fieldType", [titleFieldResponse, nameFieldResponse, addressFieldResponse, shortAnswerFieldResponse, longAnswerFieldResponse, singleCheckboxFieldResponse, multipleResponseFieldResponse, singleResponseFieldResponse, fileUploadFieldResponse, tableFieldResponse, numberFieldResponse, dateFieldResponse, emailFieldResponse, websiteFieldResponse, phoneFieldResponse, coverLetterFieldResponse, textOnlyFieldResponse, referenceFormFieldResponse, dividerFieldResponse, singleRatingFieldResponse, multipleRatingFieldResponse, dropdownRatingFieldResponse, dropdownListFieldResponse, charityCheckFieldResponse, eligibilityCharityCheckFieldResponse, eligibilitySingleCheckboxFieldResponse, eligibilitySingleResponseFieldResponse, eligibilityDropdownListFieldResponse, bankDetailsFieldResponse, fraudPreventionFieldResponse, ssnItinFieldResponse, einFieldResponse, ueiFieldResponse, disclosureFieldResponse, dataExtractionFieldResponse, eSignFieldResponse])).nullable().optional(), branches: z.array(branchResponse).nullable().optional(), blocks: z.array(blockResponse).nullable().optional(), createdBy: z.string().optional(), createdAt: z.string().nullable().optional(), updatedBy: z.string().optional(), updatedAt: z.string().nullable().optional(), isDeleted: z.boolean().optional()}); export const eligibilityFormResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable(), formId: z.string().nullable().optional(), name: z.string().nullable().optional(), fields: z.array(z.discriminatedUnion("fieldType", [titleFieldResponse, nameFieldResponse, addressFieldResponse, shortAnswerFieldResponse, longAnswerFieldResponse, singleCheckboxFieldResponse, multipleResponseFieldResponse, singleResponseFieldResponse, fileUploadFieldResponse, tableFieldResponse, numberFieldResponse, dateFieldResponse, emailFieldResponse, websiteFieldResponse, phoneFieldResponse, coverLetterFieldResponse, textOnlyFieldResponse, referenceFormFieldResponse, dividerFieldResponse, singleRatingFieldResponse, multipleRatingFieldResponse, dropdownRatingFieldResponse, dropdownListFieldResponse, charityCheckFieldResponse, eligibilityCharityCheckFieldResponse, eligibilitySingleCheckboxFieldResponse, eligibilitySingleResponseFieldResponse, eligibilityDropdownListFieldResponse, bankDetailsFieldResponse, fraudPreventionFieldResponse, ssnItinFieldResponse, einFieldResponse, ueiFieldResponse, disclosureFieldResponse, dataExtractionFieldResponse, eSignFieldResponse])).nullable().optional(), branches: z.array(branchResponse).nullable().optional(), blocks: z.array(blockResponse).nullable().optional(), createdBy: z.string().optional(), createdAt: z.string().nullable().optional(), updatedBy: z.string().optional(), updatedAt: z.string().nullable().optional(), isDeleted: z.boolean().optional()}); export const internalFormResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable(), formId: z.string().nullable().optional(), name: z.string().nullable().optional(), fields: z.array(z.discriminatedUnion("fieldType", [titleFieldResponse, nameFieldResponse, addressFieldResponse, shortAnswerFieldResponse, longAnswerFieldResponse, singleCheckboxFieldResponse, multipleResponseFieldResponse, singleResponseFieldResponse, fileUploadFieldResponse, tableFieldResponse, numberFieldResponse, dateFieldResponse, emailFieldResponse, websiteFieldResponse, phoneFieldResponse, coverLetterFieldResponse, textOnlyFieldResponse, referenceFormFieldResponse, dividerFieldResponse, singleRatingFieldResponse, multipleRatingFieldResponse, dropdownRatingFieldResponse, dropdownListFieldResponse, charityCheckFieldResponse, eligibilityCharityCheckFieldResponse, eligibilitySingleCheckboxFieldResponse, eligibilitySingleResponseFieldResponse, eligibilityDropdownListFieldResponse, bankDetailsFieldResponse, fraudPreventionFieldResponse, ssnItinFieldResponse, einFieldResponse, ueiFieldResponse, disclosureFieldResponse, dataExtractionFieldResponse, eSignFieldResponse])).nullable().optional(), branches: z.array(branchResponse).nullable().optional(), blocks: z.array(blockResponse).nullable().optional(), createdBy: z.string().optional(), createdAt: z.string().nullable().optional(), updatedBy: z.string().optional(), updatedAt: z.string().nullable().optional(), isDeleted: z.boolean().optional()}); export const requestFormResponse = z.object({formType: z.enum(["additional", "initial", "reference", "review", "internal", "eligibility", "request"]).nullable(), formId: z.string().nullable().optional(), name: z.string().nullable().optional(), fields: z.array(z.discriminatedUnion("fieldType", [titleFieldResponse, nameFieldResponse, addressFieldResponse, shortAnswerFieldResponse, longAnswerFieldResponse, singleCheckboxFieldResponse, multipleResponseFieldResponse, singleResponseFieldResponse, fileUploadFieldResponse, tableFieldResponse, numberFieldResponse, dateFieldResponse, emailFieldResponse, websiteFieldResponse, phoneFieldResponse, coverLetterFieldResponse, textOnlyFieldResponse, referenceFormFieldResponse, dividerFieldResponse, singleRatingFieldResponse, multipleRatingFieldResponse, dropdownRatingFieldResponse, dropdownListFieldResponse, charityCheckFieldResponse, eligibilityCharityCheckFieldResponse, eligibilitySingleCheckboxFieldResponse, eligibilitySingleResponseFieldResponse, eligibilityDropdownListFieldResponse, bankDetailsFieldResponse, fraudPreventionFieldResponse, ssnItinFieldResponse, einFieldResponse, ueiFieldResponse, disclosureFieldResponse, dataExtractionFieldResponse, eSignFieldResponse])).nullable().optional(), branches: z.array(branchResponse).nullable().optional(), blocks: z.array(blockResponse).nullable().optional(), createdBy: z.string().optional(), createdAt: z.string().nullable().optional(), updatedBy: z.string().optional(), updatedAt: z.string().nullable().optional(), isDeleted: z.boolean().optional()}); export const createApiV4FormsResponse = z.discriminatedUnion("formType", [initialFormResponse, additionalFormResponse, referenceFormResponse, reviewFormResponse, eligibilityFormResponse, internalFormResponse, requestFormResponse]); 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 }; /** * Create a form * * POST /v4/forms */ export const createApiV4Forms = async (args: CreateApiV4FormsArgs, options?: CreateApiV4FormsOptions) => { const {baseUrl = "https://submittable-api.submittable.com", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") const url = `${baseUrl.replace(/\/+$/, '')}/v4/forms${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(createApiV4FormsResponse, await res.json()) };