import {z} from 'zod' export type GetApiInvoicesArgs = {include?: (Array<'property' | 'owner' | 'line_items'>) | undefined, 'filter[paid]'?: boolean | undefined, 'filter[voided]'?: boolean | undefined, 'filter[invoice_type]'?: (Array<'sales' | 'lettings'>) | undefined, 'page[size]'?: number | undefined, 'page[number]'?: number | undefined}; export type GetApiInvoicesOptions = {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 invoice = z.object({id: z.string().optional(), type: z.literal("invoice").optional(), attributes: z.object({invoice_prefix: z.string().optional(), invoice_number: z.number().int().optional(), total_amount: z.number().int().optional(), total_amount_vat: z.number().int().optional(), paid: z.boolean().optional(), paid_at: z.string().nullable().optional(), due_date: z.string().optional(), voided_at: z.string().nullable().optional(), created_at: z.string().optional(), updated_at: z.string().optional()}).optional(), relationships: z.object({property: z.object({data: z.object({type: z.literal("property"), id: z.string()}).nullable().optional(), links: z.object({self: link.optional(), related: link.optional()}).optional()}).optional(), owner: z.object({data: z.object({type: z.literal("owner"), id: z.string()}).nullable().optional(), links: z.object({self: link.optional(), related: link.optional()}).optional()}).optional(), line_items: z.object({data: z.array(z.object({type: z.literal("fee").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 includedProperty = z.object({type: z.literal("property"), id: z.string(), attributes: z.object({is_sales: z.boolean().optional(), is_lettings: z.boolean().optional(), company_owned: z.boolean().optional(), is_commercial: z.boolean().optional(), is_residential: z.boolean().optional(), address: addressSimple.optional(), inline_address: z.string().optional(), public_address: z.string().optional(), status: z.enum(["Not On The Market", "Valuation Lost", "Valuation Booked", "Provisional Valuation Booked", "Valuation Pending", "Valuation Cancelled", "Valuation Completed", "Instructed", "For Sale", "Under Offer", "Sold STC", "Exchanged", "Let", "To Let", "Let Agreed", "For Sale and To Let", "Withdrawn Sales", "Withdrawn Lettings", "Withdrawn Sales And Lettings", "Completed"]).optional(), bedrooms: z.number().int().optional(), bathrooms: z.number().int().optional(), receptions: z.number().int().optional(), floor_area: z.string().nullable().optional(), plot_area: z.string().nullable().optional(), land_area: z.string().nullable().optional(), full_description: z.string().nullable().optional(), short_description: z.string().nullable().optional(), location_summary: z.string().nullable().optional(), full_description_lettings: z.string().nullable().optional(), short_description_lettings: z.string().nullable().optional(), location_summary_lettings: z.string().nullable().optional(), property_type: z.string().optional(), property_style: z.string().optional(), property_age_bracket: z.string().optional(), construction_year: z.union([z.string(), z.number().int()]).nullable().optional(), is_listed_building: z.boolean().nullable().optional(), is_conservation_area: z.boolean().nullable().optional(), tenure: z.string().optional(), tenure_notes: z.string().nullable().optional(), lease_expiry_year: z.string().nullable().optional(), lease_expiry_date: z.string().nullable().optional(), lease_start_date: z.string().nullable().optional(), lease_term_years: z.number().int().nullable().optional(), display_property_style: z.string().optional(), work_required: z.boolean().optional(), heating_system: z.string().optional(), council_tax_band: z.string().optional(), council_tax_cost: z.number().int().nullable().optional(), local_authority: z.string().nullable().optional(), service_charge: z.number().int().optional(), service_charge_period: z.string().optional(), service_charge_notes: z.string().nullable().optional(), ground_rent: z.number().int().nullable().optional(), ground_rent_period: z.string().optional(), ground_rent_review_period_years: z.number().int().nullable().optional(), ground_rent_uplift: z.number().int().nullable().optional(), ground_rent_expiry: z.string().nullable().optional(), has_outdoor_space: z.boolean().nullable().optional(), shared_ownership: z.boolean().optional(), shared_ownership_notes: z.string().nullable().optional(), shared_ownership_rent: z.number().int().nullable().optional(), shared_ownership_rent_frequency: z.string().nullable().optional(), shared_ownership_percentage_sold: z.number().int().nullable().optional(), tags: z.array(z.object({name: z.string().optional(), slug: z.string().optional(), order: z.number().optional()})).optional(), features: z.array(z.object({id: z.string().optional(), name: z.string().optional(), order: z.number().optional(), include_on_portals: z.boolean().optional(), highlight: z.boolean().optional()})).optional(), material_information: z.object({council_tax_band: z.string().max(1).nullable().optional(), lease_expiry_date: z.string().nullable().optional(), lease_start_date: z.string().nullable().optional(), lease_term_years: z.number().int().nullable().optional(), ground_rent_pence: z.number().int().nullable().optional(), ground_rent_period: z.string().nullable().optional(), ground_rent_expiry: z.string().nullable().optional(), ground_rent_review_period_years: z.number().int().nullable().optional(), ground_rent_uplift: z.number().int().nullable().optional(), service_charge_pence: z.number().int().nullable().optional(), service_charge_period: z.string().nullable().optional(), service_charge_notes: z.string().nullable().optional(), water_supply: z.array(z.enum(["direct_main_waters", "wells", "boreholes", "springs", "other"])).nullable().optional(), water_supply_other: z.string().nullable().optional(), electricity_supply: z.array(z.enum(["national_grid", "wind_turbine", "solar_panels", "generator", "other"])).nullable().optional(), electricity_supply_other: z.string().nullable().optional(), sewerage: z.array(z.enum(["standard", "septic_tank", "sewage_treatment_plants", "cesspit", "cesspool", "other"])).nullable().optional(), sewerage_other: z.string().nullable().optional(), heating_supply: z.array(z.enum(["electric_central", "gas_central", "gas_other", "communal_heating", "lpg_central", "wood_burner", "biomass_boiler", "solar_panels", "heat_pump", "other"])).nullable().optional(), heating_supply_other: z.string().nullable().optional(), heating_system: z.string().nullable().optional(), broadband: z.enum(["adsl", "cable", "fttc", "fttp", "null"]).nullable().optional(), has_restrictions: z.boolean().nullable().optional(), has_required_access: z.boolean().nullable().optional(), public_right_of_way: z.boolean().nullable().optional(), flood_risk: z.boolean().nullable().optional(), sources_of_flooding: z.array(z.string()).nullable().optional(), sources_of_flooding_other: z.string().nullable().optional(), has_flood_defences: z.boolean().nullable().optional(), has_flooded_in_last_five_years: z.boolean().nullable().optional(), adaptations_list: z.array(z.unknown()).nullable().optional(), adaptations_other: z.string().nullable().optional()}).optional(), viewing_booking_url: z.string().nullable().optional(), last_instructed_sales_at: z.string().nullable().optional(), last_instructed_lettings_at: z.string().nullable().optional(), last_made_available_for_sale_at: z.string().nullable().optional(), last_made_available_to_let_at: z.string().nullable().optional(), last_exchanged_at: z.string().nullable().optional(), last_completed_at: z.string().nullable().optional(), created_at: z.string().optional(), updated_at: z.string().optional(), custom_meta_data: z.union([z.object({}), z.array(z.unknown())]).optional(), lead_source: z.string().nullable().optional(), publish_after: z.string().nullable().optional(), archived_at: z.string().nullable().optional(), virtual_tour: z.string().nullable().optional(), property_urls: z.array(z.object({title: z.string(), type: z.enum(["image", "floor_plan", "brochure", "virtual_tour", "audio_tour", "ipack"]), url: z.string().max(2048)})).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()}).nullable().optional(), meta: meta.optional()}); export const includedOwner = z.object({type: z.literal("owner"), id: z.string(), attributes: z.object({is_company: z.boolean().optional(), contact_name: z.string().optional(), contact_address: addressSimple.nullable().optional(), contact_telephone_number: z.string().nullable().optional(), contact_email_address: z.string().nullable().optional(), created_at: z.string().optional(), updated_at: z.string().optional()}).optional(), relationships: z.object({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(), company: z.object({data: z.object({type: z.literal("company"), id: z.string()}).nullable().optional(), links: z.object({self: link.optional(), related: link.optional()}).optional()}).optional()}).nullable().optional(), meta: meta.optional()}); export const includedFees = z.object({type: z.literal("fee"), id: z.string(), attributes: z.object({package: z.enum(["completion", "upfront"]).optional(), label: z.string().optional(), fee_amount: z.number().int().optional(), vat_type: z.enum(["exc_vat", "inc_vat"]).optional(), fee_type: z.enum(["fixed", "percentage"]).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 includedLinks = z.object({self: link.optional(), related: link.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 getApiInvoicesResponse = z.object({data: z.array(invoice).optional(), included: z.array(z.union([includedProperty, includedOwner, includedFees])).optional(), links: includedLinks.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 Invoices * * GET /invoices */ export const getApiInvoices = async (args: GetApiInvoicesArgs, options?: GetApiInvoicesOptions) => { 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 (args['filter[paid]'] != null) query.append("filter[paid]", String(args['filter[paid]'])) if (args['filter[voided]'] != null) query.append("filter[voided]", String(args['filter[voided]'])) if (args['filter[invoice_type]'] != null) query.append("filter[invoice_type]", args['filter[invoice_type]'].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 (yourApiToken !== undefined) headers.set('authorization', `Bearer ${yourApiToken}`) const url = `${baseUrl.replace(/\/+$/, '')}/invoices${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(getApiInvoicesResponse, await res.json()) };