import {z} from 'zod' export type GetApiUsersUserIdArgs = {include?: (Array<'branch' | 'ownedProperties' | 'applicants'>) | undefined}; export type GetApiUsersUserIdOptions = {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 user = z.object({id: z.string().optional(), type: z.literal("user").optional(), 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({properties: z.object({data: z.array(z.object({type: z.literal("property").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 includedLinks = z.object({self: link.optional(), related: link.optional()}); export const jsonApi = z.object({version: z.string().optional(), meta: meta.optional()}); export const getApiUsersUserIdResponse = z.object({data: user.optional(), included: z.array(includedBranch).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 User * * GET /users/{user_id} */ export const getApiUsersUserId = async (args: GetApiUsersUserIdArgs, options?: GetApiUsersUserIdOptions) => { 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(/\/+$/, '')}/users/${encodeURIComponent(String(args.user_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(getApiUsersUserIdResponse, await res.json()) };