import {z} from 'zod' export type GetApiSalesApplicantsArgs = {'filter[branch]'?: string | undefined, 'filter[areas]'?: Array | undefined, 'filter[price_from]'?: number | undefined, 'filter[price_to]'?: number | undefined, 'filter[min_bedrooms]'?: number | undefined, 'filter[buying_position]'?: (Array<'FTB' | 'INV' | 'BTLI' | 'NPTS' | 'NOM' | 'OTM' | 'SSTC' | 'UO' | 'PTS' | 'DEV' | 'BUY'>) | undefined, 'filter[financial_position]'?: (Array<'NIP' | 'SOAQ' | 'SAMA' | 'AIP' | 'NFCB' | 'CBFS' | 'PMTG'>) | undefined, 'filter[trashed]'?: ('with' | 'only') | undefined, 'filter[created_from]'?: string | undefined, 'filter[created_to]'?: string | undefined, 'filter[updated_from]'?: string | undefined, 'filter[updated_to]'?: string | undefined, include?: (Array<'branch' | 'offers' | 'viewings' | 'people' | 'company' | 'notes' | 'sales' | 'followUps' | 'negotiator'>) | undefined, 'page[size]'?: number | undefined, 'page[number]'?: number | undefined, 'filter[follow_ups_due_from]'?: string | undefined, 'filter[follow_ups_due_to]'?: string | undefined, 'filter[lead_rating]'?: (Array<'hot' | 'warm' | 'cold' | 'null' | null>) | undefined}; export type GetApiSalesApplicantsOptions = {baseUrl?: string | undefined, yourApiToken?: string | undefined, fetch?: typeof fetch | undefined}; export const applicantPreferenceChoice = z.enum(["Strong Preference", "Don't Mind", "Would Prefer", "Won't Consider", "Might Consider", "Must Have"]); export const meta = z.object({}); export const link = z.union([z.string(), z.object({href: z.string(), meta: meta.optional()})]); export const applicant = z.object({id: z.string().optional(), type: z.literal("applicant").optional(), attributes: z.object({applicant_type: z.enum(["sales", "lettings"]).optional(), name: z.string().optional(), financial_position: z.string().nullable().optional(), buying_position: z.string().optional(), letting_position: z.enum(["Homeowner", "Renting", "Living with Family", "Selling", "Other", "null"]).nullable().optional(), requirements: z.object({min_price: z.number().int().nullable().optional(), max_price: z.number().int().nullable().optional(), min_bedrooms: z.number().int().gte(1).nullable().optional(), preferred_bedrooms: z.number().int().gte(1).nullable().optional(), desired_move_in_date: z.string().nullable().optional(), desired_tenancy_period: z.number().int().nullable().optional(), furnished: z.boolean().nullable().optional(), pets_allowed: z.boolean().nullable().optional(), outside_space: applicantPreferenceChoice.nullable().optional(), min_land_area: z.number().int().nullable().optional(), garage: applicantPreferenceChoice.nullable().optional(), new_build: applicantPreferenceChoice.nullable().optional(), retirement_property: applicantPreferenceChoice.nullable().optional(), min_parking: z.number().int().nullable().optional(), preferred_parking: z.number().int().nullable().optional(), property_type_preference: z.record(z.string(), applicantPreferenceChoice).optional(), new_property_type_preference: z.record(z.string(), applicantPreferenceChoice).optional(), areas: z.array(z.string()).optional()}).optional(), active: z.boolean().optional(), created_at: z.string().optional(), updated_at: z.string().optional(), lead_rating: z.enum(["hot", "warm", "cold", "null"]).nullable().optional()}).optional(), relationships: z.object({branch: z.object({data: z.object({type: z.literal("branch"), id: z.string()}).nullable().optional(), links: z.object({self: link.optional(), related: link.optional()}).optional()}).optional(), viewings: z.object({data: z.array(z.object({type: z.literal("viewing").optional(), id: z.string().optional()})).optional(), links: z.object({self: link.optional(), related: link.optional()}).optional()}).optional(), offers: z.object({data: z.array(z.object({type: z.enum(["sales_offer", "lettings_offer"]).optional(), id: z.string().optional()})).optional(), links: z.object({self: link.optional(), related: link.optional()}).optional()}).optional(), people: z.object({data: z.array(z.object({type: z.literal("person").optional(), id: z.string().optional()})).optional(), links: z.object({self: link.optional(), related: link.optional()}).optional()}).optional(), notes: z.object({data: z.array(z.object({type: z.literal("note").optional(), id: z.string().optional()})).optional(), links: z.object({self: link.optional(), related: link.optional()}).optional()}).optional(), sales: z.object({data: z.array(z.object({type: z.literal("sale").optional(), id: z.string().optional()})).optional(), links: z.object({self: link.optional(), related: link.optional()}).optional()}).optional(), followUps: z.object({data: z.array(z.object({type: z.literal("follow_up").optional(), id: z.string().optional()})).optional(), links: z.object({self: link.optional(), related: link.optional()}).optional()}).optional()}).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 includedBranch = z.object({type: z.literal("branch"), id: z.string(), attributes: z.object({address: addressSimple.optional(), name: z.string().optional(), public_name: z.string().nullable().optional(), email_address: z.string().optional(), telephone: z.string().optional(), website: z.string().nullable().optional(), about_branch_copy: z.string().nullable().optional(), disclaimer: z.string().nullable().optional(), matching_links_to_website: z.boolean().nullable().optional(), matching_url_pattern: 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 includedSalesOffer = z.object({type: z.literal("sales_offer"), id: z.string(), attributes: z.object({address: addressSimple.optional(), offer_amount: z.number().optional(), offer_made_at: z.string().optional(), notes: z.string().nullable().optional(), status: z.enum(["Pending", "Relayed to Vendor", "Accepted", "Rejected", "Withdrawn"]).optional(), created_at: z.string().optional(), updated_at: z.string().optional()}).optional(), relationships: z.object({}).nullable().optional(), meta: meta.optional()}); export const includedViewing = z.object({type: z.literal("viewing"), id: z.string(), attributes: z.object({viewing_type: z.enum(["sales", "lettings"]).optional(), type: z.enum(["sales", "lettings"]).optional(), address: addressSimple.optional(), start: z.string().nullable().optional(), end: z.string().nullable().optional(), unaccompanied: z.boolean().optional(), agent_confirmed: z.boolean().optional(), occupant_confirmed: z.boolean().optional(), applicant_confirmed: z.boolean().optional(), provisional: z.boolean().optional(), occupant_type: z.enum(["By Tenants", "By Owner", "Vacant", "Unknown", "null"]).nullable().optional(), status: z.enum(["unconfirmed", "rejected", "confirmed", "cancelled", "completed", "missed"]).optional(), no_show: z.boolean().optional(), cancelled_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 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 personSimple = z.object({full_name: z.string().optional(), title: z.string().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()}); export const includedCompany = z.object({type: z.literal("company"), id: z.string(), attributes: z.object({name: z.string().optional(), address: addressSimple.nullable().optional(), telephone_number: z.string().optional(), email_address: z.string().optional(), owner: personSimple.nullable().optional(), created_at: z.string().optional(), updated_at: z.string().optional()}).optional(), relationships: z.object({}).nullable().optional(), meta: meta.optional()}); export const includedNegotiator = z.object({type: z.literal("negotiator"), id: z.string(), attributes: z.object({first_name: z.string().optional(), last_name: z.string().optional(), job_title: z.string().nullable().optional(), telephone_number: z.string().nullable().optional(), mobile_number: z.string().nullable().optional(), email_address: z.string().optional(), deactivated_at: z.string().nullable().optional(), deleted_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 includedNotes = z.object({type: z.literal("note"), id: z.string(), attributes: z.object({body: z.string().nullable().optional(), author: z.string().nullable().optional(), pinned_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 includedFollowUp = z.object({type: z.literal("follow_up"), id: z.string(), attributes: z.object({subject_id: z.string().nullable().optional(), subject_type: z.enum(["property", "lettingsApplicant", "salesApplicant", "sale", "valuation", "viewing", "null"]).nullable().optional(), due_date: z.string().nullable().optional(), note: 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 includedSale = z.object({type: z.literal("sale"), id: z.string(), attributes: z.object({address: addressSimple.optional(), status: z.enum(["Completed", "Fallen Through", "Offer Accepted", "Exchanged", "Under Offer"]).optional(), sale_price: z.number().optional(), dates: z.object({offer_accepted_date: z.string().nullable().optional(), expected_exchange_date: z.string().nullable().optional(), exchanged_date: z.string().nullable().optional(), expected_completion_date: z.string().nullable().optional(), completed_date: z.string().nullable().optional()}).optional()}).optional(), relationships: z.object({}).nullable().optional(), meta: meta.optional()}); export const links = z.object({self: z.string().optional(), first: z.string().optional(), next: z.string().optional(), prev: z.string().optional(), last: z.string().optional()}); export const pagination = z.object({pagination: z.object({total: z.number().int().optional(), count: z.number().int().optional(), per_page: z.number().int().optional(), current_page: z.number().int().optional(), total_pages: z.number().int().optional()}).optional()}); export const jsonApi = z.object({version: z.string().optional(), meta: meta.optional()}); export const getApiSalesApplicantsResponse = z.object({data: z.array(applicant).optional(), included: z.array(z.union([includedBranch, includedSalesOffer, includedViewing, includedPerson, includedCompany, includedNegotiator, includedNotes, includedFollowUp, includedSale])).optional(), links: links.optional(), meta: pagination.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 all Sales Applicants * * GET /sales-applicants */ export const getApiSalesApplicants = async (args: GetApiSalesApplicantsArgs, options?: GetApiSalesApplicantsOptions) => { 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['filter[branch]'] != null) query.append("filter[branch]", String(args['filter[branch]'])) if (args['filter[areas]'] != null) query.append("filter[areas]", args['filter[areas]'].join(',')) if (args['filter[price_from]'] != null) query.append("filter[price_from]", String(args['filter[price_from]'])) if (args['filter[price_to]'] != null) query.append("filter[price_to]", String(args['filter[price_to]'])) if (args['filter[min_bedrooms]'] != null) query.append("filter[min_bedrooms]", String(args['filter[min_bedrooms]'])) for (const item of args['filter[buying_position]'] ?? []) query.append("filter[buying_position]", String(item)) for (const item of args['filter[financial_position]'] ?? []) query.append("filter[financial_position]", String(item)) if (args['filter[trashed]'] != null) query.append("filter[trashed]", String(args['filter[trashed]'])) if (args['filter[created_from]'] != null) query.append("filter[created_from]", String(args['filter[created_from]'])) if (args['filter[created_to]'] != null) query.append("filter[created_to]", String(args['filter[created_to]'])) if (args['filter[updated_from]'] != null) query.append("filter[updated_from]", String(args['filter[updated_from]'])) if (args['filter[updated_to]'] != null) query.append("filter[updated_to]", String(args['filter[updated_to]'])) if (args.include != null) query.append("include", args.include.join(',')) if (args['page[size]'] != null) query.append("page[size]", String(args['page[size]'])) if (args['page[number]'] != null) query.append("page[number]", String(args['page[number]'])) if (args['filter[follow_ups_due_from]'] != null) query.append("filter[follow_ups_due_from]", String(args['filter[follow_ups_due_from]'])) if (args['filter[follow_ups_due_to]'] != null) query.append("filter[follow_ups_due_to]", String(args['filter[follow_ups_due_to]'])) if (args['filter[lead_rating]'] != null) query.append("filter[lead_rating]", args['filter[lead_rating]'].join(',')) if (yourApiToken !== undefined) headers.set('authorization', `Bearer ${yourApiToken}`) const url = `${baseUrl.replace(/\/+$/, '')}/sales-applicants${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(getApiSalesApplicantsResponse, await res.json()) };