import {z} from 'zod' export type PlaceholderSortField = 'label'; export type PlaceholderSortOrder = 'ascending' | 'descending'; export type GetApiV4MessagesPlaceholdersArgs = {continuationToken?: string | undefined, size?: number | undefined, Search?: string | undefined, IncludeDisabled?: boolean | undefined, IncludeStandard?: boolean | undefined, 'SortBy.Field'?: PlaceholderSortField | undefined, 'SortBy.Order'?: PlaceholderSortOrder | undefined}; export type GetApiV4MessagesPlaceholdersOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const placeholderIntegrationSyncResponse = z.object({integrationType: z.string().nullable().optional(), lastSyncDate: z.string().nullable().optional()}); export const placeholderMappingsResponse = z.object({formId: z.string().nullable().optional(), formFieldId: z.string().nullable().optional()}); export const placeholderResponse = z.object({id: z.string().nullable().optional(), label: z.string().nullable().optional(), isDisabled: z.boolean().optional(), organizationId: z.string().nullable().optional(), type: z.string().nullable().optional(), lastUpdatedAt: z.string().nullable().optional(), integrationSyncs: z.array(placeholderIntegrationSyncResponse).nullable().optional(), mappings: z.array(placeholderMappingsResponse).nullable().optional()}); export const continuationTokenResponsePlaceholderResponse = z.object({continuationToken: z.string().nullable().optional(), items: z.array(placeholderResponse).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 list of placeholders * * GET /v4/messages/placeholders */ export const getApiV4MessagesPlaceholders = async (args: GetApiV4MessagesPlaceholdersArgs, options?: GetApiV4MessagesPlaceholdersOptions) => { 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)) if (args.Search != null) query.append("Search", String(args.Search)) if (args.IncludeDisabled != null) query.append("IncludeDisabled", String(args.IncludeDisabled)) if (args.IncludeStandard != null) query.append("IncludeStandard", String(args.IncludeStandard)) if (args['SortBy.Field'] != null) query.append("SortBy.Field", String(args['SortBy.Field'])) if (args['SortBy.Order'] != null) query.append("SortBy.Order", String(args['SortBy.Order'])) const url = `${baseUrl.replace(/\/+$/, '')}/v4/messages/placeholders${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(continuationTokenResponsePlaceholderResponse, await res.json()) };