import {z} from 'zod' export type GetApiTemplatesArgs = {page?: number | undefined, page_size?: number | undefined, name?: string | undefined, created_after?: string | undefined, created_before?: string | undefined, sort_by?: ('name' | 'created_on' | 'last_changed_on') | undefined, sort_order?: ('asc' | 'desc') | undefined}; export type GetApiTemplatesOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const signingRequestSettings = z.object({allow_download: z.boolean().optional(), attach_pdf_on_finish: z.boolean().optional(), allow_editing_before_sending: z.boolean().optional(), use_signing_order: z.boolean().optional(), hand_drawn_only: z.boolean().optional(), send_signing_email: z.boolean().optional(), send_finish_email: z.boolean().optional(), send_expiration_email: z.boolean().optional(), send_cancellation_email: z.boolean().optional(), require_otp_verification: z.boolean().nullable().optional(), disable_guided_navigation: z.boolean().nullable().optional(), allow_presigning_download: z.boolean().nullable().optional(), show_qr_code: z.boolean().nullable().optional(), allow_decline: z.boolean().nullable().optional(), show_save_for_later: z.boolean().nullable().optional(), identity_editable_fields: z.array(z.string()).nullable().optional(), notify_identity_change_email: z.boolean().optional()}); export const templateUser = z.object({id: z.string(), name: z.string().optional(), email: z.string(), first_name: z.string().nullable(), last_name: z.string().nullable().optional(), designation: z.enum(["Signer", "Approver", "CC"]), order: z.number().int().gte(1), phone_number: z.string().nullable().optional(), street_address: z.string().nullable().optional(), city: z.string().nullable().optional(), state_province: z.string().nullable().optional(), postal_code: z.string().nullable().optional(), country: z.string().nullable().optional(), title: z.string().nullable().optional(), company: z.string().nullable().optional(), required_fields: z.array(z.string()).optional(), missing_fields: z.array(z.string()).optional(), required_read_only_fields: z.array(z.object({variable_name: z.string().nullable().optional(), variable_defined_name: z.string().nullable().optional(), field_type: z.string().optional()})).optional(), ready_to_send: z.boolean().optional()}); export const dateFormatRules = z.object({dateFormat: z.enum(["MM/dd/yyyy", "dd/MM/yyyy", "yyyy-MM-dd", "MMMM dd, yyyy", "MMM dd, yyyy", "dd MMMM yyyy"]).optional(), fontSize: z.number().int().gte(8).lte(48).optional()}); export const fieldValidationRules = z.record(z.string(), z.unknown()).nullable(); export const templateField = z.object({id: z.string(), type: z.enum(["text", "signature", "date", "checkbox", "dropdown", "radio_buttons", "number", "text_area", "file", "initial", "stamp", "approval_signature", "approval_checkmark", "approval_date"]), required: z.boolean().optional(), recipient_id: z.string().nullable().optional(), variable_name: z.string().nullable().optional(), variable_defined_name: z.string().nullable().optional(), position: z.object({x: z.number().gte(0).lte(100).optional(), y: z.number().gte(0).lte(100).optional(), width: z.number().gte(0).lte(100).optional(), height: z.number().gte(0).lte(100).optional()}).optional(), page_number: z.number().int().gte(1).nullable(), dropdown_options: z.union([z.array(z.string()), z.object({})]).nullable().optional(), multi_group_id: z.string().nullable().optional(), date_default: z.string().nullable().optional(), date_signing_default: z.boolean().optional(), format_rules: dateFormatRules.optional(), validation_rules: fieldValidationRules.optional(), read_only: z.boolean().optional(), read_only_value: z.string().nullable().optional()}); export const documentSummary = z.object({document_id: z.string().nullable(), position: z.number().int().gte(1), label: z.string().max(200).nullable(), original_filename: z.string().max(255).nullable(), page_count: z.number().int().nullable(), document_url: z.string().nullable().optional(), document_url_kind: z.enum(["stored", "signed", "null"]).nullable(), document_only_hash: z.string().nullable().optional()}); export const template = z.object({id: z.string(), name: z.string().max(255), description: z.string().nullable().optional(), document_url: z.string().optional(), document_url_expires_at: z.string().nullable().optional(), page_count: z.number().int().gte(1).optional(), expiration_hours: z.number().int().gte(1).optional(), credit_cost: z.number().int().gte(1).optional(), settings: signingRequestSettings.optional(), recipients: z.array(templateUser).optional(), fields: z.array(templateField).optional(), created_date: z.string(), updated_date: z.string().optional(), documents: z.array(documentSummary).optional(), documents_version: z.number().int().optional(), documents_layout_version: z.number().int().optional()}); export const pagination = z.object({current_page: z.number().int(), page_size: z.number().int(), total_count: z.number().int(), total_pages: z.number().int()}); export const templateListResponse = z.object({results: z.array(template), pagination: pagination}); 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 }; /** * List Templates * * GET /templates */ export const getApiTemplates = async (args: GetApiTemplatesArgs, options?: GetApiTemplatesOptions) => { 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 (args.page != null) query.append("page", String(args.page)) if (args.page_size != null) query.append("page_size", String(args.page_size)) if (args.name != null) query.append("name", String(args.name)) if (args.created_after != null) query.append("created_after", String(args.created_after)) if (args.created_before != null) query.append("created_before", String(args.created_before)) if (args.sort_by != null) query.append("sort_by", String(args.sort_by)) if (args.sort_order != null) query.append("sort_order", String(args.sort_order)) if (ApiKeyAuth !== undefined) headers.set("Authorization", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/templates${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(templateListResponse, await res.json()) };