import {z} from 'zod' export type GetApiEsignDocumentsEsignDocumentIdArgs = {include?: (Array<'recipients' | 'recipients.person'>) | undefined}; export type GetApiEsignDocumentsEsignDocumentIdOptions = {baseUrl?: string | undefined, yourApiToken?: string | undefined, fetch?: typeof fetch | undefined}; export const meta = z.object({}); export const link = z.union([z.string(), z.object({href: z.string(), meta: meta.optional()})]); export const esignDocument = z.object({id: z.string().optional(), type: z.literal("esign_document").optional(), attributes: z.object({name: z.string().optional(), sent_at: z.string().optional(), completed_at: z.string().nullable().optional(), cancelled_at: z.string().nullable().optional(), created_at: z.string().optional(), updated_at: z.string().optional()}).optional(), relationships: z.object({recipients: z.object({data: z.array(z.object({type: z.literal("esign_document_recipient").optional(), id: z.string().optional()})).optional(), links: z.object({self: link.optional(), related: link.optional()}).optional()}).optional()}).optional()}); export const includedEsignDocumentRecipient = z.object({type: z.literal("esign_document_recipient"), id: z.string(), attributes: z.object({email: z.string().optional(), name: z.string().optional(), sent_at: z.string().nullable().optional(), signed_at: z.string().nullable().optional(), created_at: z.string().optional(), updated_at: z.string().optional()}).optional(), relationships: z.object({}).nullable().optional(), meta: meta.optional()}); export const addressSimple = z.object({single_line: z.string().optional(), anon_single_line: z.string().optional(), building_number: z.string().nullable().optional(), building_name: z.string().nullable().optional(), street: z.string().nullable().optional(), line_1: z.string().optional(), line_2: z.string().nullable().optional(), line_3: z.string().nullable().optional(), line_4: z.string().nullable().optional(), town: z.string().nullable().optional(), country: z.string().optional(), postcode: z.string().optional(), udprn: z.string().nullable().optional(), geo: z.object({lat: z.number().nullable().optional(), lng: z.number().nullable().optional()}).optional(), royal_mail: z.object({postcode: z.string().optional(), post_town: z.string().optional(), thoroughfare: z.string().optional(), building_name: z.string().nullable().optional(), building_number: z.string().nullable().optional(), department_name: z.string().nullable().optional(), organisation_name: z.string().nullable().optional(), sub_building_name: z.string().nullable().optional(), dependent_locality: z.string().nullable().optional(), dependent_thoroughfare: z.string().nullable().optional(), double_dependent_locality: z.string().nullable().optional()}).nullable().optional(), street_group_property_id: z.string().nullable().optional()}); export const telephoneNumberSimple = z.object({value: z.string().optional(), notes: z.string().nullable().optional(), primary: z.boolean().optional()}); export const emailAddressSimple = z.object({value: z.string().optional(), notes: z.string().nullable().optional(), primary: z.boolean().optional()}); export const preferredLanguage = z.enum(["aa", "ab", "ae", "af", "ak", "am", "an", "ar", "as", "av", "ay", "az", "ba", "be", "bg", "bi", "bm", "bn", "bo", "br", "bs", "ca", "ce", "ch", "co", "cr", "cs", "cu", "cv", "cy", "da", "de", "dv", "dz", "ee", "el", "en", "eo", "es", "et", "eu", "fa", "ff", "fi", "fj", "fo", "fr", "fy", "ga", "gd", "gl", "gn", "gu", "gv", "ha", "he", "hi", "ho", "hr", "ht", "hu", "hy", "hz", "ia", "id", "ie", "ig", "ii", "ik", "io", "is", "it", "iu", "ja", "jv", "ka", "kg", "ki", "kj", "kk", "kl", "km", "kn", "ko", "kr", "ks", "ku", "kv", "kw", "ky", "la", "lb", "lg", "li", "ln", "lo", "lt", "lu", "lv", "mg", "mh", "mi", "mk", "ml", "mn", "mr", "ms", "mt", "my", "na", "nb", "nd", "ne", "ng", "nl", "nn", "no", "nr", "nv", "ny", "oc", "oj", "om", "or", "os", "pa", "pi", "pl", "ps", "pt", "qu", "rm", "rn", "ro", "ru", "rw", "sa", "sc", "sd", "se", "sg", "sh", "si", "sk", "sl", "sm", "sn", "so", "sq", "sr", "ss", "st", "su", "sv", "sw", "ta", "te", "tg", "th", "ti", "tk", "tl", "tn", "to", "tr", "ts", "tt", "tw", "ty", "ug", "uk", "ur", "uz", "ve", "vi", "vo", "wa", "wo", "xh", "yi", "yo", "za", "zh", "zu"]); export const includedPerson = z.object({type: z.literal("person"), id: z.string(), attributes: z.object({full_name: z.string().optional(), title: z.string().nullable().optional(), first_name: z.string().optional(), last_name: z.string().optional(), address: addressSimple.nullable().optional(), telephone_numbers: z.array(telephoneNumberSimple).optional(), email_addresses: z.array(emailAddressSimple).optional(), marketing_consent: z.boolean().nullable().optional(), contact_preferences: z.object({email: z.boolean().optional(), post: z.boolean().optional(), text: z.boolean().optional(), phone: z.boolean().optional()}).optional(), preferred_language: preferredLanguage.optional(), statuses: z.object({vendor: z.enum(["null", "Current", "Previous"]).nullable().optional(), landlord: z.enum(["null", "Current", "Previous"]).nullable().optional(), tenant: z.enum(["null", "Current", "Previous"]).nullable().optional()}).optional(), created_at: z.string().optional(), updated_at: z.string().optional()}).optional(), relationships: z.object({}).nullable().optional(), meta: meta.optional()}); export const includedLinks = z.object({self: link.optional(), related: link.optional()}); export const jsonApi = z.object({version: z.string().optional(), meta: meta.optional()}); export const getApiEsignDocumentsEsignDocumentIdResponse = z.object({data: esignDocument.optional(), included: z.array(z.union([includedEsignDocumentRecipient, includedPerson])).optional(), links: includedLinks.optional(), meta: z.object({}).optional(), jsonapi: jsonApi.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 a single E-Sign Document * * GET /esign-documents/{esign_document_id} */ export const getApiEsignDocumentsEsignDocumentId = async (args: GetApiEsignDocumentsEsignDocumentIdArgs, options?: GetApiEsignDocumentsEsignDocumentIdOptions) => { const {baseUrl = "https://street.co.uk/open-api/v1", fetch: fetchFn = fetch, yourApiToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/vnd.api+json") if (args.include != null) query.append("include", args.include.join(',')) if (yourApiToken !== undefined) headers.set('authorization', `Bearer ${yourApiToken}`) const url = `${baseUrl.replace(/\/+$/, '')}/esign-documents/${encodeURIComponent(String(args.esign_document_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(getApiEsignDocumentsEsignDocumentIdResponse, await res.json()) };