import {z} from 'zod' export type GetApiPublicBetaDocumentsSearchArgs = {q: string}; export type GetApiPublicBetaDocumentsSearchOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; 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 documentSearchResultOwner = z.object({id: z.string(), name: z.string(), email: z.string(), avatar: z.string().nullable().optional()}); export const documentSearchResultFolder = z.object({id: z.string(), name: z.string()}); export const highLevelDocumentTypeEnum = z.enum(["regular document", "template", "content library item"]); export const documentSearchParentTemplate = z.object({id: z.string().nullable().optional(), name: z.string().nullable().optional()}).nullable(); export const documentSearchPathEntry = z.object({id: z.string().nullable().optional(), name: z.string().nullable().optional()}); export const recipientTypeEnum = z.enum(["signer", "CC", "approver"]); export const documentSearchRecipient = z.object({id: z.string().nullable().optional(), email: z.string().nullable().optional(), phone: z.string().nullable().optional(), first_name: z.string().nullable().optional(), last_name: z.string().nullable().optional(), role_name: z.string().nullable().optional(), date_signed: z.string().nullable().optional(), date_first_viewed: z.string().nullable().optional(), date_last_viewed: z.string().nullable().optional(), viewed_count: z.number().int().nullable().optional(), can_pay: z.boolean().optional(), type: recipientTypeEnum.nullable().optional(), group: z.string().nullable().optional(), user_id: z.string().nullable().optional(), contact_id: z.string().nullable().optional(), company: z.string().nullable().optional(), title: z.string().nullable().optional(), internal: z.boolean().nullable().optional(), location: z.string().nullable().optional(), country: z.string().nullable().optional(), postal_code: z.string().nullable().optional(), state: z.string().nullable().optional(), city: z.string().nullable().optional(), street: z.string().nullable().optional(), avatar: z.string().nullable().optional(), is_done: z.boolean().nullable().optional()}); export const documentSearchGrandTotal = z.object({amount: z.number(), currency: z.string()}).nullable(); export const generalDocumentTypeEnum = z.enum(["Agreement", "Proposal", "Invoice", "Quote", "Form", "Policy"]); export const documentSearchDocumentType = z.object({id: z.string().nullable().optional(), type: z.string().nullable().optional(), general_type: generalDocumentTypeEnum.nullable().optional()}).nullable(); export const documentSearchEffectivePermissions = z.object({can_manage_collaborators: z.boolean(), can_revert_to_draft: z.boolean()}); export const documentSearchClmMetadata = z.object({key: z.string(), value: z.string()}); export const documentSearchExtraFields = z.object({title: z.string().nullable().optional(), date_modified: z.string().nullable().optional(), date_of_last_action: z.string().nullable().optional(), date_sent: z.string().nullable().optional(), date_first_signed: z.string().nullable().optional(), date_last_signed: z.string().nullable().optional(), date_first_viewed: z.string().nullable().optional(), date_last_viewed: z.string().nullable().optional(), date_completed: z.string().nullable().optional(), date_expired: z.string().nullable().optional(), date_expiration: z.string().nullable().optional(), removed: z.boolean().optional(), type: highLevelDocumentTypeEnum.nullable().optional(), parent: documentSearchParentTemplate.optional(), path: z.array(documentSearchPathEntry).nullable().optional(), recipients: z.array(documentSearchRecipient).nullable().optional(), recipient_count: z.number().int().optional(), viewed_total_count: z.number().int().optional(), viewed_count: z.number().int().optional(), signed_count: z.number().int().optional(), completion_rate: z.number().nullable().optional(), time_to_completion_hours: z.number().nullable().optional(), total: documentSearchGrandTotal.optional(), tags: z.array(z.string()).optional(), document_type: documentSearchDocumentType.optional(), effective_permissions: documentSearchEffectivePermissions.optional(), clm_metadata: z.array(documentSearchClmMetadata).nullable().optional()}); export const documentSearchResult = z.object({document_id: z.string(), name: z.string(), status: documentStatusEnum, date_created: z.string(), owner: documentSearchResultOwner, folder: documentSearchResultFolder, extra_fields: documentSearchExtraFields}); export const documentSearchSuggestion = z.object({text: z.string()}); export const documentSearchAppliedFilter = z.object({field: z.string(), value: z.string()}); export const documentSearchResponse = z.object({results: z.array(documentSearchResult), count: z.number().int(), suggestions: z.array(documentSearchSuggestion), message: z.string(), intent: z.array(documentSearchAppliedFilter)}); 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 }; /** * [Beta] List Documents Search * * GET /public/beta/documents/search * * Also accepts auth: oauth2 */ export const getApiPublicBetaDocumentsSearch = async (args: GetApiPublicBetaDocumentsSearchArgs, options?: GetApiPublicBetaDocumentsSearchOptions) => { 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 (args.q != null) query.append("q", String(args.q)) if (apiKey !== undefined) headers.set("Authorization", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/public/beta/documents/search${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(documentSearchResponse, await res.json()) };