import {z} from 'zod' export type GetApiV1AgentsIdListingsArgs = {id: number, dateUpdatedSince?: string | undefined, includedArchivedListings?: boolean | undefined, pageNumber?: number | undefined, pageSize?: number | undefined}; export type GetApiV1AgentsIdListingsOptions = {baseUrl?: string | undefined, apikey?: string | undefined, fetch?: typeof fetch | undefined}; export const listingsV1AddressParts = 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 listingsV1AdvertiserIdentifiers = 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 listingsV1AustralianPropertyMonitorsIdentifiers = 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 listingsV1GeoLocation = z.object({latitude: z.number().nullable().optional(), longitude: z.number().nullable().optional()}); export const listingsV1Inspection = 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 listingsV1PropertyInspections = z.object({inspections: z.array(listingsV1Inspection).nullable().optional(), pastInspections: z.array(listingsV1Inspection).nullable().optional(), isByAppointmentOnly: z.boolean().nullable().optional()}); export const listingsV1ListingMedia = 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 listingsV1PriceDetails = 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 listingsV1ProviderDetails = z.object({providerSystem: z.string().nullable().optional(), providerAdID: z.string().nullable().optional()}); export const listingsV1RentalDetails = 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 listingsV1SoldDetails = 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 listingsV1AuctionSchedule = 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 listingsV1AuctionDetails = z.object({auctionSchedule: listingsV1AuctionSchedule.optional(), auctionedPrice: z.number().int().nullable().optional(), auctionedDate: z.string().nullable().optional()}); export const listingsV1TenderDetails = z.object({tenderRecipientName: z.string().nullable().optional(), tenderAddress: z.string().nullable().optional(), tenderEndDate: z.string().nullable().optional()}); export const listingsV1TenantDetails = 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 listingsV1SaleDetails = z.object({saleMethod: z.enum(["notStated", "auction", "privateTreaty", "tender", "expressionOfInterest"]).nullable().optional(), soldDetails: listingsV1SoldDetails.optional(), auctionDetails: listingsV1AuctionDetails.optional(), tenderDetails: listingsV1TenderDetails.optional(), tenantDetails: listingsV1TenantDetails.optional(), annualReturn: z.number().int().nullable().optional(), saleTerms: z.string().nullable().optional()}); export const listingsV1BasicPrice = z.object({from: z.number().int().nullable().optional(), to: z.number().int().nullable().optional()}); export const listingsV1PastSaleData = 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 listingsV1ComparableData = z.object({comparableProperty: z.array(listingsV1PastSaleData).nullable().optional(), declarationText: z.string().nullable().optional()}); export const listingsV1MedianPriceData = 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 listingsV1StatementOfInformation = z.object({estimatedPrice: listingsV1BasicPrice.optional(), comparableData: listingsV1ComparableData.optional(), suburbMedianPrice: listingsV1MedianPriceData.optional(), documentationUrl: z.string().nullable().optional()}); export const listingsV1Listing = 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: listingsV1AddressParts.optional(), advertiserIdentifiers: listingsV1AdvertiserIdentifiers, apmIdentifiers: listingsV1AustralianPropertyMonitorsIdentifiers.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: listingsV1GeoLocation.optional(), headline: z.string().nullable().optional(), inspectionDetails: listingsV1PropertyInspections.optional(), isNewDevelopment: z.boolean().nullable().optional(), landArea: z.string().nullable().optional(), landAreaSqm: z.number().nullable().optional(), media: z.array(listingsV1ListingMedia).nullable().optional(), priceDetails: listingsV1PriceDetails.optional(), propertyId: z.string().nullable().optional(), propertyTypes: z.array(z.enum(["unknown", "accessoriesParts", "accommodationTourism", "accounting", "acreageSemiRural", "adult", "advertisingMarketing", "aerial", "aeronautical", "agedCare", "agricultural", "air", "aircraft", "alarms", "alcoholLiquor", "amusements", "animalRelated", "apartmentUnitFlat", "aquaculture", "aquaticMarineMarinaBerth", "artsCrafts", "autoElectrical", "automotive", "backpackerHostel", "bakery", "barsNightclubs", "beautyHealth", "beautyProducts", "beautySalon", "bikeAndMotorcycle", "blockOfUnits", "boardingKennels", "boatsMarineMarinaBerth", "bookkeeping", "brokerage", "builder", "buildingAndConstruction", "bus", "butcher", "cafeCoffeeShop", "car", "carBusTruck", "carDealership", "carRental", "carSpace", "carWash", "caravanPark", "carpenter", "catering", "childCare", "civil", "cleaning", "cleaningAndMaintenance", "clinicalPractice", "clothingAccessories", "clothingFootwear", "communication", "communications", "computerIT", "computerAndInternet", "construction", "convenienceStore", "copyLaminate", "courier", "cropHarvesting", "customs", "dairyFarming", "deli", "dental", "detailing", "developmentLand", "developmentSite", "distributors", "drivingSchools", "duplex", "educationTraining", "educational", "electrical", "employmentRecruitment", "entertainment", "entertainmentTechnology", "export", "farm", "farming", "fertiliser", "finance", "financialServices", "fishingForestry", "floristNursery", "foodBeverage", "foodBeverageHospitality", "franchiseBusinessOpportunities", "freight", "fruitVegFreshProduce", "fruitPicking", "functionCentre", "furnitureTimber", "gambling", "gardenHousehold", "gardenNurseries", "gardening", "glassCeramic", "guestHouseBB", "hairdresser", "healthBeauty", "healthSpa", "hire", "homeGarden", "homeBased", "newHomeDesigns", "homewareHardware", "hospital", "hotel", "hotelLeisure", "house", "newHouseLand", "huntingTrap", "import", "importExportWholesale", "industrialManufacturing", "industrialWarehouse", "insemination", "insurance", "internet", "irrigationServices", "juiceBar", "landClearing", "newLand", "landscaping", "laundryDryCleaning", "legal", "leisureEntertainment", "limousineTaxi", "livestock", "internationalCommercial", "machinery", "machineryMetal", "managementRights", "manufacturers", "manufacturingEngineering", "marine", "massage", "mechanicalRepair", "media", "medical", "medicalConsulting", "medicalPractice", "miningEarthMoving", "mobileServices", "motel", "motorcycle", "musicRelated", "mustering", "nails", "naturalTherapies", "newApartments", "newsagency", "nursery", "nursingHome", "offices", "officeSupplies", "oilGas", "panelBeating", "paperPrinting", "parkingCarSpace", "penthouse", "pestRelated", "pharmacies", "plastic", "plumbing", "poolWater", "postOffices", "printPhoto", "professional", "propertyRealEstate", "rail", "recreationSport", "recruitment", "repair", "resort", "restaurant", "retail", "retailer", "retirement", "retirementVillage", "road", "rural", "ruralCommercialFarming", "scientific", "sea", "security", "semiDetached", "serviceStation", "services", "shearing", "showroomsBulkyGoods", "specialistFarm", "sportsComplexGym", "studio", "supermarket", "takeawayFood", "taxi", "terrace", "themePark", "tours", "townhouse", "training", "transportDistribution", "travel", "truck", "vacantLand", "vending", "villa", "water", "welding", "wholesale", "wholesalers", "woolClassing", "wreckers", "servicedOffices", "other", "alcoholGrocery", "cafeRestaurants", "discountStore", "ecoFriendly", "green", "grocery", "specialityRetail", "storage", "travelAgency", "varietyStore", "chickenShop", "seafoodShop", "deliCafe", "cropping", "viticulture", "mixedFarming", "grazing", "horticulture", "equine", "farmlet", "orchard", "ruralLifestyle", "onlineBusiness"])), providerDetails: listingsV1ProviderDetails.optional(), rentalDetails: listingsV1RentalDetails.optional(), saleDetails: listingsV1SaleDetails.optional(), isWithdrawn: z.boolean().nullable().optional(), seoUrl: z.string().nullable().optional(), virtualTourUrl: z.string().nullable().optional(), homepassEnabled: z.boolean().nullable().optional(), statementOfInformation: listingsV1StatementOfInformation.optional(), numberOfDwellings: z.number().int().nullable().optional(), highlights: z.array(z.string()).nullable().optional()}); export const getApiV1AgentsIdListingsResponse = z.array(listingsV1Listing); 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 }; /** * Gets listing using the contact id * * GET /v1/agents/{id}/listings * * Also accepts auth: oauth2 */ export const getApiV1AgentsIdListings = async (args: GetApiV1AgentsIdListingsArgs, options?: GetApiV1AgentsIdListingsOptions) => { 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 (args.dateUpdatedSince != null) query.append("dateUpdatedSince", String(args.dateUpdatedSince)) if (args.includedArchivedListings != null) query.append("includedArchivedListings", String(args.includedArchivedListings)) if (args.pageNumber != null) query.append("pageNumber", String(args.pageNumber)) if (args.pageSize != null) query.append("pageSize", String(args.pageSize)) if (apikey !== undefined) headers.set("x-api-key", apikey) const url = `${baseUrl.replace(/\/+$/, '')}/v1/agents/${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(getApiV1AgentsIdListingsResponse, await res.json()) };