import {z} from 'zod' export type GetApiSigningRequestsIdArgs = {id: string}; export type GetApiSigningRequestsIdOptions = {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 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 signingRequestDetail = z.object({id: z.string(), name: z.string(), template_description: z.string().nullable().optional(), companies_workspaces_id: z.string(), document_url: z.string().optional(), document_url_expires_at: z.string().nullable().optional(), document_page_count: z.number().int().gte(1).optional(), expiration_hours: z.number().int().optional(), expires_at: z.string().nullable().optional(), credit_cost: z.number().int().optional(), status: z.object({sent: z.boolean().optional(), finished: z.boolean().optional(), cancelled: z.boolean().optional(), declined: z.boolean().optional(), expired: z.boolean().optional()}), timestamps: z.object({created_on: z.string().optional(), sent_on: z.string().nullable().optional(), finished_on: z.string().nullable().optional(), cancelled_on: z.string().nullable().optional(), declined_on: z.string().nullable().optional(), last_changed_on: z.string().optional(), last_signing_action_on: z.string().nullable().optional()}).optional(), settings: signingRequestSettings.optional(), use_signing_order: z.union([z.literal(0), z.literal(1)]).optional(), allow_download: z.union([z.literal(0), z.literal(1)]).optional(), allow_editing_before_sending: z.union([z.literal(0), z.literal(1)]).optional(), hand_drawn_only: z.union([z.literal(0), z.literal(1)]).optional(), attach_pdf_on_finish: z.union([z.literal(0), z.literal(1)]).optional(), certificate: z.object({generated: z.boolean().optional(), generated_on: z.string().nullable().optional(), has_error: z.boolean().optional()}).nullable().optional(), final_document_download_url: z.string().nullable().optional(), final_document_download_error: z.enum(["file_not_accessible", "null"]).nullable().optional(), document_only_download_url: z.string().nullable().optional(), document_only_download_error: z.enum(["file_not_accessible", "null"]).nullable().optional(), certificate_only_download_url: z.string().nullable().optional(), certificate_only_download_error: z.enum(["file_not_accessible", "null"]).nullable().optional(), seal_participants: z.array(sealParticipantApi).optional(), documents: z.array(documentSummary).optional(), documents_version: z.number().int().optional(), documents_layout_version: z.number().int().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 Signing Request * * GET /signing-requests/{id} */ export const getApiSigningRequestsId = async (args: GetApiSigningRequestsIdArgs, options?: GetApiSigningRequestsIdOptions) => { 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))}${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(signingRequestDetail, await res.json()) };