import {z} from 'zod' export type GetApiV1ProjectsIdListingsArgs = {id: number}; export type GetApiV1ProjectsIdListingsOptions = {baseUrl?: string | undefined, apikey?: string | undefined, fetch?: typeof fetch | undefined}; export const listingsV2AddressParts = z.object({stateAbbreviation: z.enum(["nsw", "vic", "sa", "nt", "tas", "act", "qld", "wa"]).nullable().optional(), displayType: z.enum(["fullAddress", "streetAndSuburb", "suburbOnly", "regionOnly", "areaOnly", "stateOnly"]).nullable().optional(), streetNumber: z.string().nullable().optional(), unitNumber: z.string().nullable().optional(), street: z.string().nullable().optional(), suburb: z.string().nullable().optional(), suburbId: z.number().int().nullable().optional(), postcode: z.string().nullable().optional(), displayAddress: z.string().nullable().optional()}); export const listingsV2AdvertiserIdentifiers = z.object({advertiserType: z.enum(["agency", "private"]).nullable().optional(), advertiserId: z.number().int().nullable().optional(), contactIds: z.array(z.number().int()).nullable().optional(), agentIds: z.array(z.string()).nullable().optional(), conjunctionContactIds: z.array(z.number().int()).nullable().optional(), conjunctionAgentIds: z.array(z.string()).nullable().optional()}); export const listingsV2AustralianPropertyMonitorsIdentifiers = z.object({addressId: z.number().int().nullable().optional(), streetId: z.number().int().nullable().optional(), suburbId: z.number().int().nullable().optional(), cadastreId: z.number().int().nullable().optional(), postcodeId: z.number().int().nullable().optional(), stateId: z.number().int().nullable().optional(), state: z.string().nullable().optional(), propertyTypeId: z.number().int().nullable().optional(), propertyTypeCategoryId: z.number().int().nullable().optional(), streetNumber: z.string().nullable().optional()}); export const listingsV2GeoLocation = z.object({latitude: z.number().nullable().optional(), longitude: z.number().nullable().optional()}); export const listingsV2Inspection = z.object({recurrence: z.enum(["none", "weekly"]).nullable().optional(), openingDateTime: z.string().nullable().optional(), closingDateTime: z.string().nullable().optional(), description: z.string().nullable().optional()}); export const listingsV2PropertyInspections = z.object({inspections: z.array(listingsV2Inspection).nullable().optional(), pastInspections: z.array(listingsV2Inspection).nullable().optional(), isByAppointmentOnly: z.boolean().nullable().optional()}); export const listingsV2ListingMedia = z.object({category: z.enum(["image", "video", "others"]).nullable().optional(), type: z.enum(["photo", "mp4", "youtube", "floorplan", "vimeo", "notSpecified"]).nullable().optional(), url: z.string().min(1)}); export const listingsV2PriceDetails = z.object({gstOption: z.enum(["na", "inc", "ex"]).nullable().optional(), priceType: z.enum(["gross", "net"]).nullable().optional(), priceUnit: z.enum(["totalAmount", "perSqm"]).nullable().optional(), price: z.number().nullable().optional(), priceFrom: z.number().int().nullable().optional(), priceTo: z.number().int().nullable().optional(), pricePrefix: z.string().nullable().optional(), canDisplayPrice: z.boolean().nullable().optional(), hiddenReasons: z.array(z.enum(["byAgency", "qldRestriction"])).nullable().optional(), displayPrice: z.string().nullable().optional(), bond: z.number().nullable().optional(), priceReduction: z.boolean().nullable().optional()}); export const listingsV2ProviderDetails = z.object({providerSystem: z.string().nullable().optional(), providerAdID: z.string().nullable().optional()}); export const listingsV2RentalDetails = z.object({rentalMethod: z.enum(["notStated", "rent", "share", "holiday", "lease"]).nullable().optional(), source: z.enum(["internal", "external"]).nullable().optional(), leasedDate: z.string().nullable().optional(), leasedPrice: z.number().int().nullable().optional(), canDisplayPrice: z.boolean().nullable().optional(), leasedMonths: z.number().int().nullable().optional(), termOfLeaseFrom: z.number().int().nullable().optional(), termOfLeaseTo: z.number().int().nullable().optional(), leaseOutgoings: z.number().int().nullable().optional()}); export const listingsV2SoldDetails = z.object({soldAction: z.enum(["notStated", "auction", "privateTreaty", "withdrawn", "soldPriorToAuction"]).nullable().optional(), source: z.enum(["internal", "external"]).nullable().optional(), soldPrice: z.number().int().nullable().optional(), governmentRecordedSoldPrice: z.number().int().nullable().optional(), soldDate: z.string().nullable().optional(), canDisplayPrice: z.boolean().nullable().optional()}); export const listingsV2AuctionSchedule = z.object({locationDescription: z.string().nullable().optional(), openingDateTime: z.string().nullable().optional(), terms: z.string().nullable().optional(), url: z.string().max(255).nullable().optional()}); export const listingsV2AuctionDetails = z.object({auctionSchedule: listingsV2AuctionSchedule.optional(), auctionedPrice: z.number().int().nullable().optional(), auctionedDate: z.string().nullable().optional()}); export const listingsV2TenderDetails = z.object({tenderRecipientName: z.string().nullable().optional(), tenderAddress: z.string().nullable().optional(), tenderEndDate: z.string().nullable().optional()}); export const listingsV2TenantDetails = z.object({leaseDateVariable: z.boolean().nullable().optional(), leaseOptions: z.string().nullable().optional(), tenantInfoTermOfLeaseFrom: z.number().int().nullable().optional(), tenantInfoTermOfLeaseTo: z.number().int().nullable().optional(), tenantName: z.string().nullable().optional(), tenantRentDetails: z.string().nullable().optional(), leaseStartDate: z.string().nullable().optional(), leaseEndDate: z.string().nullable().optional()}); export const listingsV2SaleDetails = z.object({saleMethod: z.enum(["notStated", "auction", "privateTreaty", "tender", "expressionOfInterest"]).nullable().optional(), soldDetails: listingsV2SoldDetails.optional(), auctionDetails: listingsV2AuctionDetails.optional(), tenderDetails: listingsV2TenderDetails.optional(), tenantDetails: listingsV2TenantDetails.optional(), annualReturn: z.number().int().nullable().optional(), saleTerms: z.string().nullable().optional()}); export const listingsV2BasicPrice = z.object({from: z.number().int().nullable().optional(), to: z.number().int().nullable().optional()}); export const listingsV2PastSaleData = z.object({unitNumber: z.string().nullable().optional(), streetNumber: z.string().nullable().optional(), street: z.string().nullable().optional(), suburb: z.string().nullable().optional(), postcode: z.string().nullable().optional(), state: z.string().nullable().optional(), displayAddress: z.string().nullable().optional(), dateOfSale: z.string().nullable().optional(), soldPrice: z.number().int().nullable().optional()}); export const listingsV2ComparableData = z.object({comparableProperty: z.array(listingsV2PastSaleData).nullable().optional(), declarationText: z.string().nullable().optional()}); export const listingsV2MedianPriceData = z.object({priceType: z.enum(["house", "apartmentUnitFlat", "vacantLand"]).nullable().optional(), suburb: z.string().nullable().optional(), postcode: z.string().nullable().optional(), medianPrice: z.number().int().nullable().optional(), source: z.string().nullable().optional(), sourceDateFrom: z.string().nullable().optional(), sourceDateTo: z.string().nullable().optional(), sourceCollectionDate: z.string().nullable().optional()}); export const listingsV2StatementOfInformation = z.object({estimatedPrice: listingsV2BasicPrice.optional(), comparableData: listingsV2ComparableData.optional(), suburbMedianPrice: listingsV2MedianPriceData.optional(), documentationUrl: z.string().nullable().optional()}); export const listingsV2Listing = z.object({objective: z.enum(["sale", "rent"]).nullable().optional(), status: z.enum(["unknown", "archived", "underOffer", "sold", "leased", "newDevelopment", "recentlyUpdated", "new", "live", "pending", "depositTaken"]).nullable().optional(), saleMode: z.enum(["buy", "rent", "share", "sold", "leased", "archived"]).nullable().optional(), channel: z.enum(["residential", "commercial", "business"]).nullable().optional(), id: z.number().int(), addressParts: listingsV2AddressParts.optional(), advertiserIdentifiers: listingsV2AdvertiserIdentifiers, apmIdentifiers: listingsV2AustralianPropertyMonitorsIdentifiers.optional(), bathrooms: z.number().nullable().optional(), bedrooms: z.number().nullable().optional(), buildingArea: z.string().nullable().optional(), buildingAreaSqm: z.number().nullable().optional(), carspaces: z.number().nullable().optional(), dateAvailable: z.string().nullable().optional(), dateCreated: z.string().nullable().optional(), dateUpdated: z.string().nullable().optional(), dateMinorUpdated: z.string().nullable().optional(), datePurged: z.string().nullable().optional(), dateListed: z.string().nullable().optional(), description: z.string().nullable().optional(), devProjectId: z.number().int().nullable().optional(), energyEfficiencyRating: z.number().int().nullable().optional(), features: z.array(z.string()).nullable().optional(), geoLocation: listingsV2GeoLocation.optional(), headline: z.string().nullable().optional(), inspectionDetails: listingsV2PropertyInspections.optional(), isNewDevelopment: z.boolean().nullable().optional(), landArea: z.string().nullable().optional(), landAreaSqm: z.number().nullable().optional(), media: z.array(listingsV2ListingMedia).nullable().optional(), priceDetails: listingsV2PriceDetails.optional(), propertyId: z.string().nullable().optional(), propertyTypes: z.array(z.enum(["unknown", "acreageSemiRural", "apartmentUnitFlat", "aquaculture", "blockOfUnits", "carspace", "dairyFarming", "developmentLand", "developmentSite", "duplex", "farm", "fishingForestry", "homeBased", "newHomeDesigns", "hotelLeisure", "house", "newHouseLand", "industrialWarehouse", "irrigationServices", "newLand", "livestock", "international", "medicalConsulting", "newApartments", "offices", "parkingCarSpace", "penthouse", "retail", "retirement", "rural", "ruralCommercialFarming", "semiDetached", "showroomsBulkyGoods", "specialistFarm", "studio", "terrace", "townhouse", "vacantLand", "villa", "servicedOffices", "other", "chickenShop", "seafoodShop", "deliCafe", "cropping", "viticulture", "mixedFarming", "grazing", "horticulture", "equine", "farmlet", "orchard", "ruralLifestyle", "onlineBusiness"])), providerDetails: listingsV2ProviderDetails.optional(), rentalDetails: listingsV2RentalDetails.optional(), saleDetails: listingsV2SaleDetails.optional(), isWithdrawn: z.boolean().nullable().optional(), seoUrl: z.string().nullable().optional(), virtualTourUrl: z.string().nullable().optional(), homepassEnabled: z.boolean().nullable().optional(), statementOfInformation: listingsV2StatementOfInformation.optional(), numberOfDwellings: z.number().int().nullable().optional(), highlights: z.array(z.string()).nullable().optional()}); export const getApiV1ProjectsIdListingsResponse = z.array(listingsV2Listing); 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 }; /** * Project listings * * GET /v1/projects/{id}/listings * * Also accepts auth: oauth2 */ export const getApiV1ProjectsIdListings = async (args: GetApiV1ProjectsIdListingsArgs, options?: GetApiV1ProjectsIdListingsOptions) => { const {baseUrl = "https://api.domain.com.au", fetch: fetchFn = fetch, apikey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (apikey !== undefined) headers.set("x-api-key", apikey) const url = `${baseUrl.replace(/\/+$/, '')}/v1/projects/${encodeURIComponent(String(args.id))}/listings${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(getApiV1ProjectsIdListingsResponse, await res.json()) };