import {z} from 'zod' export type GetApiPublicV1DocumentsIdDetailsArgs = {id: string}; export type GetApiPublicV1DocumentsIdDetailsOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const token = z.object({name: z.string(), value: z.string().optional()}); export const assignedToRecipientDeliveryMethods = z.object({sms: z.boolean().optional(), email: z.boolean().optional()}); export const recipientRedirectSettings = z.object({is_enabled: z.boolean().optional(), url: z.string().optional()}); export const recipientAssignedTo = z.object({id: z.string().optional(), email: z.string().optional(), recipient_type: z.string().optional(), roles: z.array(z.string()).optional(), signing_order: z.number().int().optional(), has_completed: z.boolean().optional(), first_name: z.string().optional(), last_name: z.string().optional(), phone: z.string().optional(), role: z.string().optional(), delivery_methods: assignedToRecipientDeliveryMethods.optional(), redirect: recipientRedirectSettings.optional(), type: z.literal("recipient").optional()}); export const recipientsGroupAssignedTo = z.object({id: z.string().optional(), email: z.string().optional(), recipient_type: z.string().optional(), roles: z.array(z.string()).optional(), signing_order: z.number().int().optional(), has_completed: z.boolean().optional(), name: z.string().optional(), members: z.array(z.object({id: z.string().optional(), email: z.string().optional(), first_name: z.string().optional(), last_name: z.string().optional()})).optional(), type: z.literal("recipient_group").optional()}); export const checkbox = z.object({uuid: z.string().optional(), name: z.string().optional(), title: z.string().optional(), placeholder: z.string().optional(), assigned_to: z.discriminatedUnion("type", [recipientAssignedTo, recipientsGroupAssignedTo]).optional(), field_id: z.string().optional(), is_filled: z.boolean().optional(), type: z.literal("checkbox").optional(), value: z.boolean().optional(), merge_field: z.string().optional()}); export const collectFile = z.object({uuid: z.string().optional(), name: z.string().optional(), title: z.string().optional(), placeholder: z.string().optional(), assigned_to: z.discriminatedUnion("type", [recipientAssignedTo, recipientsGroupAssignedTo]).optional(), field_id: z.string().optional(), is_filled: z.boolean().optional(), type: z.literal("collect_file").optional(), value: z.object({name: z.string().optional(), url: z.string().optional()}).optional()}); export const date = z.object({uuid: z.string().optional(), name: z.string().optional(), title: z.string().optional(), placeholder: z.string().optional(), assigned_to: z.discriminatedUnion("type", [recipientAssignedTo, recipientsGroupAssignedTo]).optional(), field_id: z.string().optional(), is_filled: z.boolean().optional(), type: z.literal("date").optional(), value: z.string().optional(), merge_field: z.string().optional()}); export const dropdown = z.object({uuid: z.string().optional(), name: z.string().optional(), title: z.string().optional(), placeholder: z.string().optional(), assigned_to: z.discriminatedUnion("type", [recipientAssignedTo, recipientsGroupAssignedTo]).optional(), field_id: z.string().optional(), is_filled: z.boolean().optional(), type: z.literal("dropdown").optional(), value: z.string().optional(), merge_field: z.string().optional()}); export const initials = z.object({uuid: z.string().optional(), name: z.string().optional(), title: z.string().optional(), placeholder: z.string().optional(), assigned_to: z.discriminatedUnion("type", [recipientAssignedTo, recipientsGroupAssignedTo]).optional(), field_id: z.string().optional(), is_filled: z.boolean().optional(), type: z.literal("initials").optional(), value: z.object({}).optional()}); export const payment = z.object({uuid: z.string().optional(), name: z.string().optional(), title: z.string().optional(), placeholder: z.string().optional(), assigned_to: z.discriminatedUnion("type", [recipientAssignedTo, recipientsGroupAssignedTo]).optional(), field_id: z.string().optional(), is_filled: z.boolean().optional(), type: z.literal("payment_details").optional(), value: z.string().optional()}); export const radioButtons = z.object({uuid: z.string().optional(), name: z.string().optional(), title: z.string().optional(), placeholder: z.string().optional(), assigned_to: z.discriminatedUnion("type", [recipientAssignedTo, recipientsGroupAssignedTo]).optional(), field_id: z.string().optional(), is_filled: z.boolean().optional(), type: z.literal("radio_buttons").optional(), value: z.string().optional(), merge_field: z.string().optional()}); export const signature = z.object({uuid: z.string().optional(), name: z.string().optional(), title: z.string().optional(), placeholder: z.string().optional(), assigned_to: z.discriminatedUnion("type", [recipientAssignedTo, recipientsGroupAssignedTo]).optional(), field_id: z.string().optional(), is_filled: z.boolean().optional(), type: z.literal("signature").optional(), value: z.object({}).optional()}); export const stamp = z.object({uuid: z.string().optional(), name: z.string().optional(), title: z.string().optional(), placeholder: z.string().optional(), assigned_to: z.discriminatedUnion("type", [recipientAssignedTo, recipientsGroupAssignedTo]).optional(), field_id: z.string().optional(), is_filled: z.boolean().optional(), type: z.literal("stamp").optional(), value: z.object({}).optional()}); export const text = z.object({uuid: z.string().optional(), name: z.string().optional(), title: z.string().optional(), placeholder: z.string().optional(), assigned_to: z.discriminatedUnion("type", [recipientAssignedTo, recipientsGroupAssignedTo]).optional(), field_id: z.string().optional(), is_filled: z.boolean().optional(), type: z.literal("text").optional(), value: z.string().optional(), merge_field: z.string().nullable().optional()}); export const field = z.discriminatedUnion("type", [checkbox, collectFile, date, dropdown, initials, payment, radioButtons, signature, stamp, text]); export const pricingTableResponse = z.object({name: z.string().optional(), id: z.string().optional(), total: z.string().optional(), is_included_in_total: z.boolean().optional(), summary: z.object({subtotal: z.string().nullable().optional(), total: z.string().nullable().optional(), discount: z.string().nullable().optional(), tax: z.string().nullable().optional(), fee: z.string().nullable().optional()}).nullable().optional(), items: z.array(z.object({id: z.string().nullable().optional(), sku: z.string().nullable().optional(), qty: z.string().nullable().optional(), name: z.string().nullable().optional(), cost: z.string().nullable().optional(), price: z.string().nullable().optional(), description: z.string().nullable().optional(), custom_fields: z.object({}).nullable().optional(), custom_columns: z.object({}).nullable().optional(), discount: z.object({value: z.string().nullable().optional(), type: z.string().nullable().optional()}).nullable().optional(), tax_first: z.object({value: z.string().nullable().optional(), type: z.string().nullable().optional()}).nullable().optional(), tax_second: z.object({value: z.string().nullable().optional(), type: z.string().nullable().optional()}).nullable().optional(), subtotal: z.string().nullable().optional(), options: z.object({optional: z.boolean().nullable().optional(), optional_selected: z.boolean().nullable().optional(), multichoice_enabled: z.boolean().nullable().optional(), multichoice_selected: z.boolean().nullable().optional(), qty_editable: z.boolean().optional()}).nullable().optional(), sale_price: z.string().nullable().optional(), taxes: z.object({}).nullable().optional(), discounts: z.object({}).nullable().optional(), fees: z.object({}).nullable().optional(), merged_data: z.object({}).nullable().optional()})).optional(), currency: z.string().optional()}); export const quoteUpdateRequestBillingFrequencyEnum = z.enum(["weekly", "monthly", "annually", "quarterly", "semiannually"]).nullable(); export const quoteSectionSettings = z.object({optional: z.boolean().optional(), selected: z.boolean().optional(), selection_type: z.enum(["custom", "single", "multiple"]).optional(), data_merge_enabled: z.boolean().optional()}); export const quoteResponse = z.object({id: z.string().optional(), currency: z.string().optional(), total: z.string().optional(), summary: z.object({total: z.string().optional(), subtotal: z.string().nullable().optional(), one_time_subtotal: z.string().nullable().optional(), recurring_subtotal: z.array(z.object({billing_cycle: z.string().optional(), value: z.string().optional()})).nullable().optional(), total_qty: z.string().nullable().optional(), discounts: z.record(z.string(), z.object({type: z.string().nullable().optional(), value: z.string().nullable().optional()})).nullable().optional(), taxes: z.object({}).nullable().optional(), fees: z.object({}).nullable().optional(), custom_fields: z.record(z.string(), z.string()).nullable().optional(), total_discount: z.string().nullable().optional(), total_tax: z.string().nullable().optional(), total_fee: z.string().nullable().optional(), total_savings: z.string().nullable().optional(), total_contract_value: z.string().nullable().optional()}).optional(), sections: z.array(z.object({id: z.string().optional(), name: z.string().optional(), summary: z.object({total: z.string().optional(), subtotal: z.string().nullable().optional(), one_time_subtotal: z.string().nullable().optional(), recurring_subtotal: z.array(z.object({billing_cycle: z.string().optional(), value: z.string().optional()})).nullable().optional(), total_qty: z.string().nullable().optional(), discounts: z.object({}).nullable().optional(), taxes: z.object({}).nullable().optional(), fees: z.object({}).nullable().optional(), custom_fields: z.record(z.string(), z.string()).nullable().optional(), total_section_value: z.string().nullable().optional()}).optional(), columns: z.array(z.object({header: z.string().nullable().optional(), name: z.string().optional(), merge_name: z.string().nullable().optional(), hidden: z.boolean().optional(), formula_expression: z.string().nullable().optional(), formula_error_code: z.string().nullable().optional()})).optional(), items: z.array(z.object({id: z.string().nullable().optional(), sku: z.string().nullable().optional(), name: z.string().nullable().optional(), description: z.string().nullable().optional(), qty: z.string().nullable().optional(), price: z.string().nullable().optional(), cost: z.string().nullable().optional(), billing_frequency: quoteUpdateRequestBillingFrequencyEnum.optional(), contract_term: z.string().nullable().optional(), pricing_method: z.string().nullable().optional(), type: z.string().nullable().optional(), reference_type: z.string().nullable().optional(), options: z.object({selected: z.boolean().nullable().optional(), qty_editable: z.boolean().nullable().optional()}).nullable().optional(), custom_columns: z.record(z.string(), z.string()).nullable().optional(), formula_columns: z.record(z.string(), z.string().nullable()).nullable().optional(), external_columns: z.record(z.string(), z.string()).optional(), discounts: z.record(z.string(), z.object({type: z.string().nullable().optional(), value: z.string().nullable().optional()})).nullable().optional(), taxes: z.record(z.string(), z.object({type: z.string().nullable().optional(), value: z.string().nullable().optional()})).nullable().optional(), fees: z.record(z.string(), z.object({type: z.string().nullable().optional(), value: z.string().nullable().optional()})).nullable().optional(), multipliers: z.record(z.string(), z.string()).nullable().optional(), total: z.string().nullable().optional(), overall_total: z.string().nullable().optional(), total_qty: z.string().nullable().optional(), reference_id: z.string().nullable().optional(), thumbnail: z.string().nullable().optional(), images: z.array(z.string()).nullable().optional(), merged_data: z.object({}).nullable().optional()})).nullable().optional(), total: z.string().optional(), settings: quoteSectionSettings.optional()}).nullable()).optional(), merge_rules: z.array(z.object({id: z.string().optional(), enabled: z.boolean().optional(), action: z.object({type: z.string().optional(), section_id: z.string().optional()}).optional(), condition: z.object({field_name: z.string().optional(), type: z.string().optional(), comparison: z.array(z.object({type: z.string().optional(), value: z.string().optional()})).optional()}).optional()})).optional(), settings: z.object({selection_type: z.enum(["custom", "single", "multiple"]).optional()}).optional()}); export const pricingResponse = z.object({tables: z.array(pricingTableResponse).optional(), quotes: z.array(quoteResponse).optional(), total: z.string().optional()}); export const recipientTypeEnum = z.enum(["signer", "CC", "approver"]); export const recipientDeliveryMethods = z.object({email: z.boolean().optional(), sms: z.boolean().optional()}).nullable(); export const recipientVerificationPlaceEnum = z.enum(["before_open", "before_sign"]); export const recipientVerificationSettingsResponse = z.object({verification_place: recipientVerificationPlaceEnum.optional(), passcode_verification: z.object({passcode: z.string()}).nullable().optional(), phone_verification: z.object({phone_number: z.string()}).nullable().optional(), kba_verification: z.object({time_limit_sec: z.number().int().optional(), score_threshold: z.number().int().optional(), max_attempts_count: z.number().int().optional()}).nullable().optional(), id_verification: z.object({enabled: z.boolean().optional()}).nullable().optional(), email_otp_verification: z.object({email: z.string()}).nullable().optional()}); export const recipientRedirect = z.object({is_enabled: z.boolean(), url: z.string().nullable()}); export const documentDetailsRecipientGroupMember = z.object({id: z.string().optional(), first_name: z.string().optional(), last_name: z.string().optional(), email: z.string().nullable().optional(), shared_link: z.string().optional(), avatar: z.string().nullable().optional(), signature_date: z.string().nullable().optional()}); export const documentStatusEnum = z.enum(["document.draft", "document.sent", "document.completed", "document.uploaded", "document.error", "document.viewed", "document.waiting_approval", "document.approved", "document.rejected", "document.waiting_pay", "document.paid", "document.voided", "document.declined", "document.external_review", "document.scheduled"]); export const documentQESStatusEnum = z.enum(["pending", "in_progress", "completed"]); export const documentDetailsResponse = z.object({id: z.string().optional(), name: z.string().optional(), autonumbering_sequence_name_prefix: z.unknown(), folder_uuid: z.string().nullable().optional(), date_created: z.string().optional(), date_modified: z.string().optional(), date_completed: z.string().nullable().optional(), content_date_modified: z.string().optional(), date_sent: z.string().nullable().optional(), ref_number: z.string().optional(), created_by: z.object({id: z.string().optional(), membership_id: z.string().optional(), email: z.string().optional(), first_name: z.string().optional(), last_name: z.string().optional(), avatar: z.string().nullable().optional()}).optional(), template: z.object({id: z.string().optional(), name: z.string().optional()}).nullable().optional(), expiration_date: z.string().nullable().optional(), metadata: z.object({}).optional(), tokens: z.array(token).optional(), fields: z.array(field).optional(), pricing: pricingResponse.optional(), tables: z.array(z.object({name: z.string().optional()})).optional(), images: z.array(z.object({name: z.string().optional()})).optional(), texts: z.array(z.object({name: z.string().optional()})).optional(), tags: z.array(z.string()).optional(), sent_by: z.object({id: z.string().optional(), email: z.string().optional(), first_name: z.string().optional(), last_name: z.string().optional(), avatar: z.string().nullable().optional()}).nullable().optional(), recipients: z.array(z.discriminatedUnion("type", [z.object({id: z.string().optional(), recipient_type: recipientTypeEnum.optional(), role: z.string().nullable().optional(), roles: z.array(z.string()).optional(), signing_order: z.number().int().gte(1).nullable().optional(), email: z.string().nullable().optional(), has_completed: z.boolean().optional(), last_name: z.string().optional(), contact_id: z.string().optional(), first_name: z.string().optional(), phone: z.string().nullable().optional(), delivery_methods: recipientDeliveryMethods.optional(), shared_link: z.string().optional(), signature_date: z.string().nullable().optional(), verification_settings: recipientVerificationSettingsResponse.optional(), redirect: recipientRedirect.optional(), avatar: z.string().nullable().optional(), type: z.literal("recipient").optional()}), z.object({id: z.string().optional(), recipient_type: recipientTypeEnum.optional(), role: z.string().nullable().optional(), roles: z.array(z.string()).optional(), signing_order: z.number().int().gte(1).nullable().optional(), email: z.string().nullable().optional(), has_completed: z.boolean().optional(), name: z.string().optional(), type: z.literal("recipient_group").optional(), members: z.array(documentDetailsRecipientGroupMember).optional()})])).optional(), grand_total: z.object({amount: z.string().optional(), currency: z.string().optional()}).optional(), linked_objects: z.array(z.object({provider: z.string().optional(), entity_type: z.string().optional(), entity_id: z.string().optional(), id: z.string().optional(), children: z.array(z.object({entity_type: z.string().optional(), entity_id: z.string().optional(), id: z.string().optional()})).optional()})).optional(), status: documentStatusEnum.optional(), qes_status: documentQESStatusEnum.nullable().optional(), approval_execution: z.object({document_uuid: z.string().optional(), revision_number: z.number().int().optional()}).nullable().optional(), version: z.string().optional(), lock: z.object({locked_by_user_id: z.string().min(22).max(22).optional(), lock_type: z.literal("wopi_editing").optional(), expires_at: z.string().optional()}).nullable().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 }; /** * Document Details * * GET /public/v1/documents/{id}/details * * Also accepts auth: oauth2 */ export const getApiPublicV1DocumentsIdDetails = async (args: GetApiPublicV1DocumentsIdDetailsArgs, options?: GetApiPublicV1DocumentsIdDetailsOptions) => { const {baseUrl = "https://api.pandadoc.com", fetch: fetchFn = fetch, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (apiKey !== undefined) headers.set("Authorization", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/public/v1/documents/${encodeURIComponent(String(args.id))}/details${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(documentDetailsResponse, await res.json()) };