import {z} from 'zod' export type GetApiSigningRequestsIdFieldsArgs = {id: string}; export type GetApiSigningRequestsIdFieldsOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const signingRequestField = z.object({id: z.string(), type: z.enum(["text", "signature", "date", "checkbox", "initial", "dropdown", "radio_buttons", "text_area", "url", "file", "stamp", "approval_signature", "approval_checkmark", "approval_date"]).optional(), recipient_id: z.string().nullable().optional(), value: z.string().nullable().optional(), position: z.object({x: z.number().nullable().optional(), y: z.number().nullable().optional(), width: z.number().nullable().optional(), height: z.number().nullable().optional()}).optional(), companies_workspaces_signing_requests_id: z.string().optional(), companies_workspaces_signing_requests_users_id: z.string().nullable().optional(), field_type: z.enum(["text", "signature", "date", "checkbox", "initial", "dropdown", "radio_buttons", "text_area", "url", "file", "stamp", "approval_signature", "approval_checkmark", "approval_date"]), required: z.boolean().optional(), x_postion: z.number().nullable().optional(), y_position: z.number().nullable().optional(), width: z.number().nullable().optional(), heigh: z.number().nullable().optional(), page_number: z.number().int().nullable(), tl_position: z.number().nullable().optional(), tr_position: z.number().nullable().optional(), bl_position: z.number().nullable().optional(), br_position: z.number().nullable().optional(), variable_name: z.string().nullable().optional(), variable_defined_name: z.string().nullable().optional(), final_value: z.string().nullable().optional(), date_default: z.string().nullable().optional(), date_signing_default: z.boolean().nullable().optional(), format_rules: z.object({}).nullable().optional(), validation_rules: z.object({}).nullable().optional(), dropdown_options: z.union([z.array(z.string()), z.object({})]).nullable().optional(), multi_group_id: z.string().nullable().optional(), read_only: z.boolean().optional(), read_only_value: z.string().nullable().optional(), background_color: z.string().nullable().optional(), calculated_font_size: z.number().nullable().optional(), deleted: z.union([z.literal(0), z.literal(1)]).optional()}); export const signingRequestFieldListResponse = z.object({results: z.array(signingRequestField)}); 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 signing request fields * * GET /signing-requests/{id}/fields */ export const getApiSigningRequestsIdFields = async (args: GetApiSigningRequestsIdFieldsArgs, options?: GetApiSigningRequestsIdFieldsOptions) => { const {baseUrl = "https://api.firma.dev/functions/v1/signing-request-api", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (ApiKeyAuth !== undefined) headers.set("Authorization", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/signing-requests/${encodeURIComponent(String(args.id))}/fields${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(signingRequestFieldListResponse, await res.json()) };