import {z} from 'zod' export type Recipient = {id?: string | undefined, _temp_id?: string | undefined, template_user_id?: string | undefined, first_name: string, last_name?: string | undefined, email: string, designation: 'Signer' | 'Approver' | 'CC', order?: number | undefined, phone_number?: (string | null) | undefined, street_address?: (string | null) | undefined, city?: (string | null) | undefined, state_province?: (string | null) | undefined, postal_code?: (string | null) | undefined, country?: (string | null) | undefined, title?: (string | null) | undefined, company?: (string | null) | undefined, custom_fields?: {[key: string]: unknown} | undefined}; export type DateFormatRules = {dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined}; export type FileFormatRules = {acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined}; export type FieldValidationRules = {[key: string]: unknown} | null; export type Condition = {field_id: string, operator: 'is_filled' | 'is_empty' | 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'greater_than' | 'less_than' | 'greater_than_or_equal' | 'less_than_or_equal', value?: (string | number | null) | undefined}; export type ConditionGroup = {conditions: Array}; export type ConditionSet = {logic: 'and' | 'or', groups: Array}; export type AnchorTag = {anchor_string: string, type: 'signature' | 'initial' | 'initials' | 'text' | 'date' | 'checkbox' | 'radio_buttons' | 'radio' | 'dropdown' | 'textarea' | 'text_area' | 'url' | 'approval_signature' | 'approval_checkmark' | 'approval_date', recipient_id: number | string, x_offset?: number | undefined, y_offset?: number | undefined, offset_units?: ('percent' | 'pixels') | undefined, width?: number | undefined, height?: number | undefined, case_sensitive?: boolean | undefined, match_whole_word?: boolean | undefined, ignore_if_not_present?: boolean | undefined, occurrence?: number | undefined, remove_anchor_text?: boolean | undefined, add_white_background?: boolean | undefined, required?: boolean | undefined, read_only?: boolean | undefined, read_only_value?: (string | null) | undefined, variable_name?: (string | null) | undefined, variable_defined_name?: (string | null) | undefined, background_color?: (string | null) | undefined, font_size?: number | undefined, dropdown_options?: (Array | Record) | undefined, date_default?: (string | null) | undefined, date_signing_default?: boolean | undefined, multi_group_id?: (string | null) | undefined, document_index?: number | undefined}; export type SigningRequestReminder = {id?: string | undefined, hours: number, all_users?: boolean | undefined, recipient_id?: (string | null) | undefined, subject: string, message: string}; export type SigningRequestSettings = {allow_download?: boolean | undefined, attach_pdf_on_finish?: boolean | undefined, allow_editing_before_sending?: boolean | undefined, use_signing_order?: boolean | undefined, hand_drawn_only?: boolean | undefined, send_signing_email?: boolean | undefined, send_finish_email?: boolean | undefined, send_expiration_email?: boolean | undefined, send_cancellation_email?: boolean | undefined, require_otp_verification?: (boolean | null) | undefined, disable_guided_navigation?: (boolean | null) | undefined, allow_presigning_download?: (boolean | null) | undefined, show_qr_code?: (boolean | null) | undefined, allow_decline?: (boolean | null) | undefined, show_save_for_later?: (boolean | null) | undefined, identity_editable_fields?: (Array | null) | undefined, notify_identity_change_email?: boolean | undefined}; export type SealParticipantInput = {seal_id?: string | undefined, order: number, temp_id: string}; export type CreateApiSigningRequestsArgs = {body: {document: string, name?: string | undefined, description?: string | undefined, expiration_hours?: number | undefined, recipients?: Array | undefined, fields?: (Array<{id?: string | undefined, template_field_id?: string | undefined, type: 'signature' | 'text' | 'date' | 'checkbox' | 'dropdown' | 'initial' | 'initials' | 'text_area' | 'textarea' | 'image' | 'stamp' | 'approval_signature' | 'approval_checkmark' | 'approval_date', position: {x: number, y: number, width: number, height: number}, page_number: number, required?: boolean | undefined, recipient_id?: string | undefined, variable_name?: (string | null) | undefined, variable_defined_name?: (string | null) | undefined, dropdown_options?: (Array | Record) | undefined, date_default?: (string | null) | undefined, date_signing_default?: boolean | undefined, multi_group_id?: (string | null) | undefined, format_rules?: (DateFormatRules | {dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined, acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined} | {dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined} | {[key: string]: unknown} | {acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined, dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined} | FileFormatRules | {acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined} | {[key: string]: unknown} | {dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined} | {[key: string]: unknown} | {acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined} | {[key: string]: unknown} | {[key: string]: unknown}) | undefined, validation_rules?: FieldValidationRules | undefined, read_only?: boolean | undefined, read_only_value?: (string | null) | undefined, prefilled_data?: ('first_name' | 'last_name' | 'full_name' | 'email' | 'phone_number' | 'company' | 'title' | 'street_address' | 'city' | 'state_province' | 'postal_code' | 'country' | null) | undefined, required_conditions?: ConditionSet | undefined, visibility_conditions?: ConditionSet | undefined, background_color?: (string | null) | undefined, seal_participant_temp_id?: (string | null) | undefined, seal_attribute?: ('display_name' | 'signatory_title' | null) | undefined}>) | undefined, anchor_tags?: Array | undefined, reminders?: Array | undefined, settings?: SigningRequestSettings | undefined, language?: ('en' | 'es' | 'it' | 'pt' | 'fr' | 'de' | 'el' | 'ru' | 'pl' | 'cs' | 'sv' | 'nl' | 'ro' | 'nb' | 'ca' | null) | undefined, completion_title?: (string | null) | undefined, completion_message?: (string | null) | undefined, completion_redirect_url?: (string | null) | undefined, completion_redirect_delay?: (number | null) | undefined, seal_participants?: (Array | null) | undefined} | {template_id: string, name?: string | undefined, description?: string | undefined, expiration_hours?: number | undefined, recipients?: Array | undefined, fields?: (Array<{id?: string | undefined, template_field_id?: string | undefined, type: 'signature' | 'text' | 'date' | 'checkbox' | 'dropdown' | 'initial' | 'initials' | 'text_area' | 'textarea' | 'image' | 'stamp' | 'approval_signature' | 'approval_checkmark' | 'approval_date', position: {x: number, y: number, width: number, height: number}, page_number: number, required?: boolean | undefined, recipient_id?: string | undefined, variable_name?: (string | null) | undefined, variable_defined_name?: (string | null) | undefined, dropdown_options?: (Array | Record) | undefined, date_default?: (string | null) | undefined, date_signing_default?: boolean | undefined, multi_group_id?: (string | null) | undefined, format_rules?: (DateFormatRules | {dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined, acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined} | {dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined} | {[key: string]: unknown} | {acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined, dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined} | FileFormatRules | {acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined} | {[key: string]: unknown} | {dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined} | {[key: string]: unknown} | {acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined} | {[key: string]: unknown} | {[key: string]: unknown}) | undefined, validation_rules?: FieldValidationRules | undefined, read_only?: boolean | undefined, read_only_value?: (string | null) | undefined, prefilled_data?: ('first_name' | 'last_name' | 'full_name' | 'email' | 'phone_number' | 'company' | 'title' | 'street_address' | 'city' | 'state_province' | 'postal_code' | 'country' | null) | undefined, required_conditions?: ConditionSet | undefined, visibility_conditions?: ConditionSet | undefined, background_color?: (string | null) | undefined, seal_participant_temp_id?: (string | null) | undefined, seal_attribute?: ('display_name' | 'signatory_title' | null) | undefined}>) | undefined, settings?: SigningRequestSettings | undefined, language?: ('en' | 'es' | 'it' | 'pt' | 'fr' | 'de' | 'el' | 'ru' | 'pl' | 'cs' | 'sv' | 'nl' | 'ro' | 'nb' | 'ca' | null) | undefined, completion_title?: (string | null) | undefined, completion_message?: (string | null) | undefined, completion_redirect_url?: (string | null) | undefined, completion_redirect_delay?: (number | null) | undefined, seal_participants?: (Array | null) | undefined} | {document_ids: Array, name?: string | undefined, description?: string | undefined, expiration_hours?: number | undefined, recipients?: Array | undefined, fields?: (Array<{id?: string | undefined, template_field_id?: string | undefined, type: 'signature' | 'text' | 'date' | 'checkbox' | 'dropdown' | 'initial' | 'initials' | 'text_area' | 'textarea' | 'image' | 'stamp' | 'approval_signature' | 'approval_checkmark' | 'approval_date', position: {x: number, y: number, width: number, height: number}, page_number: number, required?: boolean | undefined, recipient_id?: string | undefined, variable_name?: (string | null) | undefined, variable_defined_name?: (string | null) | undefined, dropdown_options?: (Array | Record) | undefined, date_default?: (string | null) | undefined, date_signing_default?: boolean | undefined, multi_group_id?: (string | null) | undefined, format_rules?: (DateFormatRules | {dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined, acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined} | {dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined} | {[key: string]: unknown} | {acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined, dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined} | FileFormatRules | {acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined} | {[key: string]: unknown} | {dateFormat?: ('MM/dd/yyyy' | 'dd/MM/yyyy' | 'yyyy-MM-dd' | 'MMMM dd, yyyy' | 'MMM dd, yyyy' | 'dd MMMM yyyy') | undefined, fontSize?: number | undefined} | {[key: string]: unknown} | {acceptedFileTypes?: ('image_and_pdf' | 'image' | 'pdf') | undefined} | {[key: string]: unknown} | {[key: string]: unknown}) | undefined, validation_rules?: FieldValidationRules | undefined, read_only?: boolean | undefined, read_only_value?: (string | null) | undefined, prefilled_data?: ('first_name' | 'last_name' | 'full_name' | 'email' | 'phone_number' | 'company' | 'title' | 'street_address' | 'city' | 'state_province' | 'postal_code' | 'country' | null) | undefined, required_conditions?: ConditionSet | undefined, visibility_conditions?: ConditionSet | undefined, background_color?: (string | null) | undefined, seal_participant_temp_id?: (string | null) | undefined, seal_attribute?: ('display_name' | 'signatory_title' | null) | undefined}>) | undefined, anchor_tags?: Array | undefined, reminders?: Array | undefined, settings?: SigningRequestSettings | undefined, language?: ('en' | 'es' | 'it' | 'pt' | 'fr' | 'de' | 'el' | 'ru' | 'pl' | 'cs' | 'sv' | 'nl' | 'ro' | 'nb' | 'ca' | null) | undefined, completion_title?: (string | null) | undefined, completion_message?: (string | null) | undefined, completion_redirect_url?: (string | null) | undefined, completion_redirect_delay?: (number | null) | undefined, seal_participants?: (Array | null) | undefined}}; export type CreateApiSigningRequestsOptions = {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 signingRequestCreateRecipient = z.object({id: z.string().optional(), first_name: z.string().nullable(), last_name: z.string().nullable().optional(), name: z.string().nullable().optional(), email: z.string(), designation: z.enum(["Signer", "Approver", "CC"]), order: z.number().int().gte(1).optional(), 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(), custom_fields: z.object({}).nullable().optional(), finished_date: z.string().nullable().optional()}); export const signingRequestCreateField = 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"]), recipient_id: z.string().nullable(), page_number: z.number().int().gte(1), x_position: z.number().optional(), y_position: z.number().optional(), width: z.number().optional(), height: z.number().optional(), required: z.boolean().optional(), read_only: z.boolean().optional(), read_only_value: z.string().nullable().optional(), variable_name: z.string().nullable().optional(), variable_defined_name: z.string().nullable().optional(), dropdown_options: z.union([z.array(z.string()), z.object({})]).nullable().optional(), format_rules: z.object({}).nullable().optional(), validation_rules: z.object({}).nullable().optional(), date_signing_default: z.boolean().optional(), final_value: z.string().nullable().optional()}); export const sealParticipantCreated = 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(), dropped: z.literal(false)}); export const sealParticipantDropped = z.object({id: z.literal("null").nullable(), order: z.literal(null).nullable(), seal: z.object({id: z.string(), lineage_id: z.string(), name: z.string(), version: z.number().int(), display_name: z.string()}).nullable(), seal_out_of_scope: z.literal(true), dropped: z.literal(true)}); export const signingRequestCreateResponse = z.object({id: z.string(), name: z.string().max(255), description: z.string().nullable().optional(), status: z.literal("draft"), document_url: z.string().optional(), page_count: z.number().int().gte(1).optional(), expiration_hours: z.number().int().gte(1).optional(), template_id: z.string().nullable().optional(), settings: signingRequestSettings.optional(), created_date: z.string().optional(), updated_date: z.string().optional(), sent_date: z.string().nullable().optional(), finished_date: z.string().nullable().optional(), cancelled_date: z.string().nullable().optional(), recipients: z.array(signingRequestCreateRecipient).optional(), fields: z.array(signingRequestCreateField).optional(), warnings: z.array(z.string()).optional(), seal_participants: z.array(z.union([sealParticipantCreated, sealParticipantDropped])).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 }; /** * Create Signing Request * * POST /signing-requests */ export const createApiSigningRequests = async (args: CreateApiSigningRequestsArgs, options?: CreateApiSigningRequestsOptions) => { 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('content-type', "application/json") headers.set('accept', "application/json") if (ApiKeyAuth !== undefined) headers.set("Authorization", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/signing-requests${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(signingRequestCreateResponse, await res.json()) };