import {z} from 'zod' export type GetApiSigningRequestsArgs = {page?: number | undefined, page_size?: number | undefined, name?: string | undefined, status?: ('not_sent' | 'in_progress' | 'finished' | 'cancelled' | 'declined' | 'deleted' | 'expired') | undefined, exclude_deleted?: boolean | undefined, created_after?: string | undefined, created_before?: string | undefined, signer_email?: string | undefined, signer_name?: string | undefined, sort_by?: ('name' | 'created_on' | 'expiration_hours' | 'sent_on' | 'finished_on') | undefined, sort_order?: ('asc' | 'desc') | undefined}; export type GetApiSigningRequestsOptions = {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 signingRequestListRecipient = z.object({id: z.string().optional(), name: z.string().optional(), email: z.string().optional(), designation: z.enum(["Signer", "Approver", "CC"]).optional(), order: z.number().int().gte(1).optional(), finished_date: z.string().nullable().optional(), signature_details: z.object({}).nullable().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 sealParticipantApi = z.object({id: z.string(), order: z.number().int().gte(1), seal: z.object({id: z.string(), lineage_id: z.string(), name: z.string(), version: z.number().int(), display_name: z.string()}), status: z.enum(["pending", "paused", "applied"]), applied_at: z.string().nullable(), paused_at: z.string().nullable(), pause_reason: z.enum(["seal_revoked_stop_pending", "seal_integrity_mismatch", "null"]).nullable(), swapped_from_seal_id: z.string().nullable(), triggered_by_recipient_id: z.string().nullable(), sender_kind: z.enum(["dashboard", "api_key", "embedded", "null"]).nullable(), seal_out_of_scope: z.boolean()}); 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 signingRequestListItem = z.object({id: z.string(), name: z.string().max(255), description: z.string().nullable().optional(), status: z.enum(["not_sent", "in_progress", "finished", "cancelled", "declined", "deleted", "expired"]), 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(), expires_at: z.string().nullable().optional(), credit_cost: z.number().int().gte(1).optional(), template_id: z.string().nullable().optional(), settings: signingRequestSettings.optional(), created_date: z.string(), updated_date: z.string().optional(), sent_date: z.string().nullable().optional(), finished_date: z.string().nullable().optional(), cancelled_date: z.string().nullable().optional(), declined_date: z.string().nullable().optional(), recipients: z.array(signingRequestListRecipient).optional(), fields: z.array(z.object({id: z.string().optional(), type: z.enum(["text", "signature", "date", "checkbox", "dropdown", "radio_buttons", "number", "text_area", "file", "initial", "stamp", "approval_signature", "approval_checkmark", "approval_date"]).optional(), 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().optional(), y: z.number().optional(), width: z.number().optional(), height: z.number().optional()}).optional(), value: z.string().nullable().optional(), dropdown_options: z.union([z.array(z.string()), z.object({})]).nullable().optional(), format_rules: dateFormatRules.optional(), validation_rules: fieldValidationRules.optional()})).optional(), seal_participants: z.array(sealParticipantApi).optional(), documents: z.array(documentSummary).optional(), documents_version: z.number().int().nullable().optional(), documents_layout_version: z.number().int().nullable().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 signingRequestListResponse = z.object({results: z.array(signingRequestListItem), 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 Signing Requests * * GET /signing-requests */ export const getApiSigningRequests = async (args: GetApiSigningRequestsArgs, options?: GetApiSigningRequestsOptions) => { 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.status != null) query.append("status", String(args.status)) if (args.exclude_deleted != null) query.append("exclude_deleted", String(args.exclude_deleted)) 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.signer_email != null) query.append("signer_email", String(args.signer_email)) if (args.signer_name != null) query.append("signer_name", String(args.signer_name)) 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(/\/+$/, '')}/signing-requests${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(signingRequestListResponse, await res.json()) };