@vepler/sdk 2.149.0 → 2.152.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +367 -358
- package/dist/commonjs/funcs/floodRiskPoint.d.ts +22 -0
- package/dist/commonjs/funcs/floodRiskPoint.d.ts.map +1 -0
- package/dist/commonjs/funcs/floodRiskPoint.js +125 -0
- package/dist/commonjs/funcs/floodRiskPoint.js.map +1 -0
- package/dist/commonjs/funcs/schoolsGetSchoolById.js +4 -0
- package/dist/commonjs/funcs/schoolsGetSchoolById.js.map +1 -1
- package/dist/commonjs/funcs/schoolsGetSchoolBySource.js +4 -0
- package/dist/commonjs/funcs/schoolsGetSchoolBySource.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/sdk/floodrisk.d.ts +16 -0
- package/dist/commonjs/sdk/floodrisk.d.ts.map +1 -0
- package/dist/commonjs/sdk/floodrisk.js +26 -0
- package/dist/commonjs/sdk/floodrisk.js.map +1 -0
- package/dist/commonjs/sdk/models/errors/index.d.ts +1 -0
- package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/errors/index.js +1 -0
- package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
- package/dist/commonjs/sdk/models/errors/queryfloodriskpoint.d.ts +266 -0
- package/dist/commonjs/sdk/models/errors/queryfloodriskpoint.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/errors/queryfloodriskpoint.js +269 -0
- package/dist/commonjs/sdk/models/errors/queryfloodriskpoint.js.map +1 -0
- package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts +69 -0
- package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getschoolbyid.js +35 -1
- package/dist/commonjs/sdk/models/operations/getschoolbyid.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/getschoolbysource.d.ts +69 -0
- package/dist/commonjs/sdk/models/operations/getschoolbysource.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getschoolbysource.js +35 -1
- package/dist/commonjs/sdk/models/operations/getschoolbysource.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/queryschools.d.ts +78 -0
- package/dist/commonjs/sdk/models/operations/queryschools.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/queryschools.js +42 -1
- package/dist/commonjs/sdk/models/operations/queryschools.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/queryschoolsbysource.d.ts +78 -0
- package/dist/commonjs/sdk/models/operations/queryschoolsbysource.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/queryschoolsbysource.js +41 -1
- package/dist/commonjs/sdk/models/operations/queryschoolsbysource.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/chargeentry.d.ts +1 -1
- package/dist/commonjs/sdk/models/shared/chargehistory.d.ts +1 -1
- package/dist/commonjs/sdk/models/shared/floodclimate2080.d.ts +21 -0
- package/dist/commonjs/sdk/models/shared/floodclimate2080.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodclimate2080.js +60 -0
- package/dist/commonjs/sdk/models/shared/floodclimate2080.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/flooddataavailability.d.ts +13 -0
- package/dist/commonjs/sdk/models/shared/flooddataavailability.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/flooddataavailability.js +50 -0
- package/dist/commonjs/sdk/models/shared/flooddataavailability.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/flooddefence.d.ts +30 -0
- package/dist/commonjs/sdk/models/shared/flooddefence.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/flooddefence.js +71 -0
- package/dist/commonjs/sdk/models/shared/flooddefence.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodhazardrating.d.ts +12 -0
- package/dist/commonjs/sdk/models/shared/floodhazardrating.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodhazardrating.js +49 -0
- package/dist/commonjs/sdk/models/shared/floodhazardrating.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodnearestdefence.d.ts +28 -0
- package/dist/commonjs/sdk/models/shared/floodnearestdefence.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodnearestdefence.js +64 -0
- package/dist/commonjs/sdk/models/shared/floodnearestdefence.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodplanning.d.ts +14 -0
- package/dist/commonjs/sdk/models/shared/floodplanning.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodplanning.js +54 -0
- package/dist/commonjs/sdk/models/shared/floodplanning.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodprimarysource.d.ts +10 -0
- package/dist/commonjs/sdk/models/shared/floodprimarysource.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodprimarysource.js +47 -0
- package/dist/commonjs/sdk/models/shared/floodprimarysource.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodprobability.d.ts +21 -0
- package/dist/commonjs/sdk/models/shared/floodprobability.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodprobability.js +52 -0
- package/dist/commonjs/sdk/models/shared/floodprobability.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodriskcoordinate.d.ts +25 -0
- package/dist/commonjs/sdk/models/shared/floodriskcoordinate.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodriskcoordinate.js +60 -0
- package/dist/commonjs/sdk/models/shared/floodriskcoordinate.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodrisklevel.d.ts +12 -0
- package/dist/commonjs/sdk/models/shared/floodrisklevel.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodrisklevel.js +49 -0
- package/dist/commonjs/sdk/models/shared/floodrisklevel.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodriskpoint.d.ts +34 -0
- package/dist/commonjs/sdk/models/shared/floodriskpoint.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodriskpoint.js +68 -0
- package/dist/commonjs/sdk/models/shared/floodriskpoint.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodriskpointrequest.d.ts +24 -0
- package/dist/commonjs/sdk/models/shared/floodriskpointrequest.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodriskpointrequest.js +53 -0
- package/dist/commonjs/sdk/models/shared/floodriskpointrequest.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodrisksummary.d.ts +24 -0
- package/dist/commonjs/sdk/models/shared/floodrisksummary.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodrisksummary.js +63 -0
- package/dist/commonjs/sdk/models/shared/floodrisksummary.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodriversandsearisk.d.ts +21 -0
- package/dist/commonjs/sdk/models/shared/floodriversandsearisk.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodriversandsearisk.js +55 -0
- package/dist/commonjs/sdk/models/shared/floodriversandsearisk.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodscenario.d.ts +17 -0
- package/dist/commonjs/sdk/models/shared/floodscenario.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodscenario.js +51 -0
- package/dist/commonjs/sdk/models/shared/floodscenario.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodsurfacewaterrisk.d.ts +16 -0
- package/dist/commonjs/sdk/models/shared/floodsurfacewaterrisk.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodsurfacewaterrisk.js +56 -0
- package/dist/commonjs/sdk/models/shared/floodsurfacewaterrisk.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodzone.d.ts +12 -0
- package/dist/commonjs/sdk/models/shared/floodzone.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/floodzone.js +49 -0
- package/dist/commonjs/sdk/models/shared/floodzone.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/index.d.ts +23 -0
- package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/index.js +23 -0
- package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/listing.d.ts +2 -2
- package/dist/commonjs/sdk/models/shared/listingpricechange.d.ts +6 -6
- package/dist/commonjs/sdk/models/shared/listingpricechange.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/listingpricechange.js +4 -4
- package/dist/commonjs/sdk/models/shared/listingpricechange.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/pricechange.d.ts +2 -2
- package/dist/commonjs/sdk/models/shared/pricingdata.d.ts +4 -4
- package/dist/commonjs/sdk/models/shared/salerecord.d.ts +1 -1
- package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.d.ts +17 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.js +51 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevent.d.ts +103 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevent.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevent.js +112 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevent.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.d.ts +17 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.js +51 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.d.ts +13 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.js +53 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectorbody.d.ts +19 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectorbody.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectorbody.js +53 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectorbody.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/schooltrustmembership.d.ts +45 -0
- package/dist/commonjs/sdk/models/shared/schooltrustmembership.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/schooltrustmembership.js +58 -0
- package/dist/commonjs/sdk/models/shared/schooltrustmembership.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitepropertystats.d.ts +2 -2
- package/dist/commonjs/sdk/sdk.d.ts +3 -0
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +4 -0
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/esm/funcs/floodRiskPoint.d.ts +22 -0
- package/dist/esm/funcs/floodRiskPoint.d.ts.map +1 -0
- package/dist/esm/funcs/floodRiskPoint.js +89 -0
- package/dist/esm/funcs/floodRiskPoint.js.map +1 -0
- package/dist/esm/funcs/schoolsGetSchoolById.js +5 -1
- package/dist/esm/funcs/schoolsGetSchoolById.js.map +1 -1
- package/dist/esm/funcs/schoolsGetSchoolBySource.js +5 -1
- package/dist/esm/funcs/schoolsGetSchoolBySource.js.map +1 -1
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/sdk/floodrisk.d.ts +16 -0
- package/dist/esm/sdk/floodrisk.d.ts.map +1 -0
- package/dist/esm/sdk/floodrisk.js +22 -0
- package/dist/esm/sdk/floodrisk.js.map +1 -0
- package/dist/esm/sdk/models/errors/index.d.ts +1 -0
- package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
- package/dist/esm/sdk/models/errors/index.js +1 -0
- package/dist/esm/sdk/models/errors/index.js.map +1 -1
- package/dist/esm/sdk/models/errors/queryfloodriskpoint.d.ts +266 -0
- package/dist/esm/sdk/models/errors/queryfloodriskpoint.d.ts.map +1 -0
- package/dist/esm/sdk/models/errors/queryfloodriskpoint.js +225 -0
- package/dist/esm/sdk/models/errors/queryfloodriskpoint.js.map +1 -0
- package/dist/esm/sdk/models/operations/getschoolbyid.d.ts +69 -0
- package/dist/esm/sdk/models/operations/getschoolbyid.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getschoolbyid.js +31 -0
- package/dist/esm/sdk/models/operations/getschoolbyid.js.map +1 -1
- package/dist/esm/sdk/models/operations/getschoolbysource.d.ts +69 -0
- package/dist/esm/sdk/models/operations/getschoolbysource.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getschoolbysource.js +31 -0
- package/dist/esm/sdk/models/operations/getschoolbysource.js.map +1 -1
- package/dist/esm/sdk/models/operations/queryschools.d.ts +78 -0
- package/dist/esm/sdk/models/operations/queryschools.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/queryschools.js +37 -0
- package/dist/esm/sdk/models/operations/queryschools.js.map +1 -1
- package/dist/esm/sdk/models/operations/queryschoolsbysource.d.ts +78 -0
- package/dist/esm/sdk/models/operations/queryschoolsbysource.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/queryschoolsbysource.js +36 -0
- package/dist/esm/sdk/models/operations/queryschoolsbysource.js.map +1 -1
- package/dist/esm/sdk/models/shared/chargeentry.d.ts +1 -1
- package/dist/esm/sdk/models/shared/chargehistory.d.ts +1 -1
- package/dist/esm/sdk/models/shared/floodclimate2080.d.ts +21 -0
- package/dist/esm/sdk/models/shared/floodclimate2080.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodclimate2080.js +23 -0
- package/dist/esm/sdk/models/shared/floodclimate2080.js.map +1 -0
- package/dist/esm/sdk/models/shared/flooddataavailability.d.ts +13 -0
- package/dist/esm/sdk/models/shared/flooddataavailability.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/flooddataavailability.js +14 -0
- package/dist/esm/sdk/models/shared/flooddataavailability.js.map +1 -0
- package/dist/esm/sdk/models/shared/flooddefence.d.ts +30 -0
- package/dist/esm/sdk/models/shared/flooddefence.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/flooddefence.js +33 -0
- package/dist/esm/sdk/models/shared/flooddefence.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodhazardrating.d.ts +12 -0
- package/dist/esm/sdk/models/shared/floodhazardrating.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodhazardrating.js +13 -0
- package/dist/esm/sdk/models/shared/floodhazardrating.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodnearestdefence.d.ts +28 -0
- package/dist/esm/sdk/models/shared/floodnearestdefence.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodnearestdefence.js +27 -0
- package/dist/esm/sdk/models/shared/floodnearestdefence.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodplanning.d.ts +14 -0
- package/dist/esm/sdk/models/shared/floodplanning.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodplanning.js +17 -0
- package/dist/esm/sdk/models/shared/floodplanning.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodprimarysource.d.ts +10 -0
- package/dist/esm/sdk/models/shared/floodprimarysource.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodprimarysource.js +11 -0
- package/dist/esm/sdk/models/shared/floodprimarysource.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodprobability.d.ts +21 -0
- package/dist/esm/sdk/models/shared/floodprobability.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodprobability.js +15 -0
- package/dist/esm/sdk/models/shared/floodprobability.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodriskcoordinate.d.ts +25 -0
- package/dist/esm/sdk/models/shared/floodriskcoordinate.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodriskcoordinate.js +22 -0
- package/dist/esm/sdk/models/shared/floodriskcoordinate.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodrisklevel.d.ts +12 -0
- package/dist/esm/sdk/models/shared/floodrisklevel.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodrisklevel.js +13 -0
- package/dist/esm/sdk/models/shared/floodrisklevel.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodriskpoint.d.ts +34 -0
- package/dist/esm/sdk/models/shared/floodriskpoint.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodriskpoint.js +31 -0
- package/dist/esm/sdk/models/shared/floodriskpoint.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodriskpointrequest.d.ts +24 -0
- package/dist/esm/sdk/models/shared/floodriskpointrequest.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodriskpointrequest.js +16 -0
- package/dist/esm/sdk/models/shared/floodriskpointrequest.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodrisksummary.d.ts +24 -0
- package/dist/esm/sdk/models/shared/floodrisksummary.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodrisksummary.js +26 -0
- package/dist/esm/sdk/models/shared/floodrisksummary.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodriversandsearisk.d.ts +21 -0
- package/dist/esm/sdk/models/shared/floodriversandsearisk.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodriversandsearisk.js +18 -0
- package/dist/esm/sdk/models/shared/floodriversandsearisk.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodscenario.d.ts +17 -0
- package/dist/esm/sdk/models/shared/floodscenario.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodscenario.js +15 -0
- package/dist/esm/sdk/models/shared/floodscenario.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodsurfacewaterrisk.d.ts +16 -0
- package/dist/esm/sdk/models/shared/floodsurfacewaterrisk.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodsurfacewaterrisk.js +19 -0
- package/dist/esm/sdk/models/shared/floodsurfacewaterrisk.js.map +1 -0
- package/dist/esm/sdk/models/shared/floodzone.d.ts +12 -0
- package/dist/esm/sdk/models/shared/floodzone.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/floodzone.js +13 -0
- package/dist/esm/sdk/models/shared/floodzone.js.map +1 -0
- package/dist/esm/sdk/models/shared/index.d.ts +23 -0
- package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/index.js +23 -0
- package/dist/esm/sdk/models/shared/index.js.map +1 -1
- package/dist/esm/sdk/models/shared/listing.d.ts +2 -2
- package/dist/esm/sdk/models/shared/listingpricechange.d.ts +6 -6
- package/dist/esm/sdk/models/shared/listingpricechange.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/listingpricechange.js +3 -3
- package/dist/esm/sdk/models/shared/listingpricechange.js.map +1 -1
- package/dist/esm/sdk/models/shared/pricechange.d.ts +2 -2
- package/dist/esm/sdk/models/shared/pricingdata.d.ts +4 -4
- package/dist/esm/sdk/models/shared/salerecord.d.ts +1 -1
- package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.d.ts +17 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.js +14 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.js.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevent.d.ts +103 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevent.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevent.js +74 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevent.js.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectiongrade.d.ts +17 -0
- package/dist/esm/sdk/models/shared/schoolinspectiongrade.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectiongrade.js +14 -0
- package/dist/esm/sdk/models/shared/schoolinspectiongrade.js.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.d.ts +13 -0
- package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.js +16 -0
- package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.js.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectorbody.d.ts +19 -0
- package/dist/esm/sdk/models/shared/schoolinspectorbody.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectorbody.js +17 -0
- package/dist/esm/sdk/models/shared/schoolinspectorbody.js.map +1 -0
- package/dist/esm/sdk/models/shared/schooltrustmembership.d.ts +45 -0
- package/dist/esm/sdk/models/shared/schooltrustmembership.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/schooltrustmembership.js +21 -0
- package/dist/esm/sdk/models/shared/schooltrustmembership.js.map +1 -0
- package/dist/esm/sdk/models/shared/sitepropertystats.d.ts +2 -2
- package/dist/esm/sdk/sdk.d.ts +3 -0
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +4 -0
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/package.json +1 -1
- package/src/funcs/floodRiskPoint.ts +199 -0
- package/src/funcs/schoolsGetSchoolById.ts +6 -1
- package/src/funcs/schoolsGetSchoolBySource.ts +6 -1
- package/src/lib/config.ts +2 -2
- package/src/sdk/floodrisk.ts +31 -0
- package/src/sdk/models/errors/index.ts +1 -0
- package/src/sdk/models/errors/queryfloodriskpoint.ts +542 -0
- package/src/sdk/models/operations/getschoolbyid.ts +126 -0
- package/src/sdk/models/operations/getschoolbysource.ts +134 -0
- package/src/sdk/models/operations/queryschools.ts +154 -0
- package/src/sdk/models/operations/queryschoolsbysource.ts +153 -0
- package/src/sdk/models/shared/chargeentry.ts +1 -1
- package/src/sdk/models/shared/chargehistory.ts +1 -1
- package/src/sdk/models/shared/floodclimate2080.ts +53 -0
- package/src/sdk/models/shared/flooddataavailability.ts +23 -0
- package/src/sdk/models/shared/flooddefence.ts +85 -0
- package/src/sdk/models/shared/floodhazardrating.ts +22 -0
- package/src/sdk/models/shared/floodnearestdefence.ts +63 -0
- package/src/sdk/models/shared/floodplanning.ts +38 -0
- package/src/sdk/models/shared/floodprimarysource.ts +20 -0
- package/src/sdk/models/shared/floodprobability.ts +44 -0
- package/src/sdk/models/shared/floodriskcoordinate.ts +61 -0
- package/src/sdk/models/shared/floodrisklevel.ts +22 -0
- package/src/sdk/models/shared/floodriskpoint.ts +82 -0
- package/src/sdk/models/shared/floodriskpointrequest.ts +52 -0
- package/src/sdk/models/shared/floodrisksummary.ts +61 -0
- package/src/sdk/models/shared/floodriversandsearisk.ts +51 -0
- package/src/sdk/models/shared/floodscenario.ts +24 -0
- package/src/sdk/models/shared/floodsurfacewaterrisk.ts +49 -0
- package/src/sdk/models/shared/floodzone.ts +22 -0
- package/src/sdk/models/shared/index.ts +23 -0
- package/src/sdk/models/shared/listing.ts +2 -2
- package/src/sdk/models/shared/listingpricechange.ts +11 -9
- package/src/sdk/models/shared/pricechange.ts +2 -2
- package/src/sdk/models/shared/pricingdata.ts +4 -4
- package/src/sdk/models/shared/salerecord.ts +1 -1
- package/src/sdk/models/shared/schoolinspectionevaluationarea.ts +39 -0
- package/src/sdk/models/shared/schoolinspectionevent.ts +184 -0
- package/src/sdk/models/shared/schoolinspectiongrade.ts +39 -0
- package/src/sdk/models/shared/schoolinspectionpredecessor.ts +37 -0
- package/src/sdk/models/shared/schoolinspectorbody.ts +29 -0
- package/src/sdk/models/shared/schooltrustmembership.ts +74 -0
- package/src/sdk/models/shared/sitepropertystats.ts +2 -2
- package/src/sdk/sdk.ts +6 -0
|
@@ -11,6 +11,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
|
|
|
11
11
|
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
12
12
|
import * as shared from "../shared/index.js";
|
|
13
13
|
|
|
14
|
+
/**
|
|
15
|
+
* Fields/blocks to return per school. Default (omitted): the full flat record, no blocks. Aggregate blocks (`inspections`, `identifiers`, `trust`) are additive — requesting only block names keeps the full flat record and adds the blocks. List scalar field names to trim.
|
|
16
|
+
*/
|
|
17
|
+
export type Attributes = string | Array<string>;
|
|
18
|
+
|
|
14
19
|
/**
|
|
15
20
|
* Source register identifier. 'dfe': UK DfE GIAS (England + cross-border Welsh URNs). 'welshgov': Welsh Government School Number. 'seed': Scottish SEED code. 'deni': NI DE Reference. 'dept_edu_ie': Irish Roll Number.
|
|
16
21
|
*/
|
|
@@ -30,6 +35,10 @@ export type Provider = ClosedEnum<typeof Provider>;
|
|
|
30
35
|
* Batch lookup by provider keys. Keys that do not match are silently omitted from the response.
|
|
31
36
|
*/
|
|
32
37
|
export type QuerySchoolsBySourceRequestBody = {
|
|
38
|
+
/**
|
|
39
|
+
* Fields/blocks to return per school. Default (omitted): the full flat record, no blocks. Aggregate blocks (`inspections`, `identifiers`, `trust`) are additive — requesting only block names keeps the full flat record and adds the blocks. List scalar field names to trim.
|
|
40
|
+
*/
|
|
41
|
+
attributes?: string | Array<string> | undefined;
|
|
33
42
|
/**
|
|
34
43
|
* Array of provider-scoped identifiers (URNs / SEED codes / etc). Maximum 500 per request.
|
|
35
44
|
*/
|
|
@@ -97,6 +106,42 @@ export type QuerySchoolsBySourceCurrentRating = OpenEnum<
|
|
|
97
106
|
typeof QuerySchoolsBySourceCurrentRating
|
|
98
107
|
>;
|
|
99
108
|
|
|
109
|
+
/**
|
|
110
|
+
* Cross-register identifiers. Present only when requested via `attributes=identifiers`.
|
|
111
|
+
*/
|
|
112
|
+
export type QuerySchoolsBySourceIdentifiers = {
|
|
113
|
+
/**
|
|
114
|
+
* Estyn provider id (Wales).
|
|
115
|
+
*/
|
|
116
|
+
estynId?: string | null | undefined;
|
|
117
|
+
/**
|
|
118
|
+
* Ofsted provider id (England).
|
|
119
|
+
*/
|
|
120
|
+
ofstedProviderId?: string | null | undefined;
|
|
121
|
+
/**
|
|
122
|
+
* Predecessor URNs this school was previously known by (re-identification lineage).
|
|
123
|
+
*/
|
|
124
|
+
oldUrns?: Array<string> | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* UK Provider Reference Number (UKPRN).
|
|
127
|
+
*/
|
|
128
|
+
ukprn?: string | null | undefined;
|
|
129
|
+
};
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* Inspection history. Present only when requested via `attributes=inspections`.
|
|
133
|
+
*/
|
|
134
|
+
export type QuerySchoolsBySourceInspections = {
|
|
135
|
+
/**
|
|
136
|
+
* Most recent inspection event, or null if never inspected.
|
|
137
|
+
*/
|
|
138
|
+
current: shared.SchoolInspectionEvent | null;
|
|
139
|
+
/**
|
|
140
|
+
* Every inspection event, newest first (includes `current`).
|
|
141
|
+
*/
|
|
142
|
+
history?: Array<shared.SchoolInspectionEvent | null> | undefined;
|
|
143
|
+
};
|
|
144
|
+
|
|
100
145
|
/**
|
|
101
146
|
* Geographic coordinates of the school
|
|
102
147
|
*/
|
|
@@ -156,6 +201,16 @@ export type QuerySchoolsBySourceStatus = OpenEnum<
|
|
|
156
201
|
typeof QuerySchoolsBySourceStatus
|
|
157
202
|
>;
|
|
158
203
|
|
|
204
|
+
/**
|
|
205
|
+
* Trust / organisation memberships. Present only when requested via `attributes=trust`.
|
|
206
|
+
*/
|
|
207
|
+
export type QuerySchoolsBySourceTrust = {
|
|
208
|
+
/**
|
|
209
|
+
* Active organisation memberships, lead/trust roles first.
|
|
210
|
+
*/
|
|
211
|
+
memberships?: Array<shared.SchoolTrustMembership> | undefined;
|
|
212
|
+
};
|
|
213
|
+
|
|
159
214
|
/**
|
|
160
215
|
* Educational institution type. 'nursery': early years. 'primary': key stages 1-2 / ISCED 1. 'secondary': key stages 3-4 / ISCED 2-3. 'all-through': combined primary + secondary. 'sixth-form': post-16. 'special': special educational needs. 'independent': fee-paying. 'academy': state-funded, independently run. 'other': alternative provision / pupil referral / unclassified.
|
|
161
216
|
*/
|
|
@@ -215,6 +270,14 @@ export type QuerySchoolsBySourceData = {
|
|
|
215
270
|
* System-generated identifier. Stable across updates.
|
|
216
271
|
*/
|
|
217
272
|
id: number;
|
|
273
|
+
/**
|
|
274
|
+
* Cross-register identifiers. Present only when requested via `attributes=identifiers`.
|
|
275
|
+
*/
|
|
276
|
+
identifiers?: QuerySchoolsBySourceIdentifiers | null | undefined;
|
|
277
|
+
/**
|
|
278
|
+
* Inspection history. Present only when requested via `attributes=inspections`.
|
|
279
|
+
*/
|
|
280
|
+
inspections?: QuerySchoolsBySourceInspections | null | undefined;
|
|
218
281
|
/**
|
|
219
282
|
* Provider-scoped identifier. URN for `dfe`, SEED for `seed`, etc. Combined with `provider` this is a globally unique alternate key for the school.
|
|
220
283
|
*/
|
|
@@ -271,6 +334,10 @@ export type QuerySchoolsBySourceData = {
|
|
|
271
334
|
*/
|
|
272
335
|
subType?: string | undefined;
|
|
273
336
|
telephone?: string | undefined;
|
|
337
|
+
/**
|
|
338
|
+
* Trust / organisation memberships. Present only when requested via `attributes=trust`.
|
|
339
|
+
*/
|
|
340
|
+
trust?: QuerySchoolsBySourceTrust | null | undefined;
|
|
274
341
|
trustId?: string | undefined;
|
|
275
342
|
trustName?: string | undefined;
|
|
276
343
|
/**
|
|
@@ -323,12 +390,27 @@ export type QuerySchoolsBySourceResponseBody = {
|
|
|
323
390
|
url: string;
|
|
324
391
|
};
|
|
325
392
|
|
|
393
|
+
/** @internal */
|
|
394
|
+
export type Attributes$Outbound = string | Array<string>;
|
|
395
|
+
|
|
396
|
+
/** @internal */
|
|
397
|
+
export const Attributes$outboundSchema: z.ZodType<
|
|
398
|
+
Attributes$Outbound,
|
|
399
|
+
z.ZodTypeDef,
|
|
400
|
+
Attributes
|
|
401
|
+
> = z.union([z.string(), z.array(z.string())]);
|
|
402
|
+
|
|
403
|
+
export function attributesToJSON(attributes: Attributes): string {
|
|
404
|
+
return JSON.stringify(Attributes$outboundSchema.parse(attributes));
|
|
405
|
+
}
|
|
406
|
+
|
|
326
407
|
/** @internal */
|
|
327
408
|
export const Provider$outboundSchema: z.ZodNativeEnum<typeof Provider> = z
|
|
328
409
|
.nativeEnum(Provider);
|
|
329
410
|
|
|
330
411
|
/** @internal */
|
|
331
412
|
export type QuerySchoolsBySourceRequestBody$Outbound = {
|
|
413
|
+
attributes?: string | Array<string> | undefined;
|
|
332
414
|
keys: Array<string>;
|
|
333
415
|
provider: string;
|
|
334
416
|
};
|
|
@@ -339,6 +421,7 @@ export const QuerySchoolsBySourceRequestBody$outboundSchema: z.ZodType<
|
|
|
339
421
|
z.ZodTypeDef,
|
|
340
422
|
QuerySchoolsBySourceRequestBody
|
|
341
423
|
> = z.object({
|
|
424
|
+
attributes: z.union([z.string(), z.array(z.string())]).optional(),
|
|
342
425
|
keys: z.array(z.string()),
|
|
343
426
|
provider: Provider$outboundSchema,
|
|
344
427
|
});
|
|
@@ -383,6 +466,49 @@ export const QuerySchoolsBySourceCurrentRating$inboundSchema: z.ZodType<
|
|
|
383
466
|
unknown
|
|
384
467
|
> = openEnums.inboundSchema(QuerySchoolsBySourceCurrentRating);
|
|
385
468
|
|
|
469
|
+
/** @internal */
|
|
470
|
+
export const QuerySchoolsBySourceIdentifiers$inboundSchema: z.ZodType<
|
|
471
|
+
QuerySchoolsBySourceIdentifiers,
|
|
472
|
+
z.ZodTypeDef,
|
|
473
|
+
unknown
|
|
474
|
+
> = z.object({
|
|
475
|
+
estynId: z.nullable(z.string()).optional(),
|
|
476
|
+
ofstedProviderId: z.nullable(z.string()).optional(),
|
|
477
|
+
oldUrns: z.array(z.string()).optional(),
|
|
478
|
+
ukprn: z.nullable(z.string()).optional(),
|
|
479
|
+
});
|
|
480
|
+
|
|
481
|
+
export function querySchoolsBySourceIdentifiersFromJSON(
|
|
482
|
+
jsonString: string,
|
|
483
|
+
): SafeParseResult<QuerySchoolsBySourceIdentifiers, SDKValidationError> {
|
|
484
|
+
return safeParse(
|
|
485
|
+
jsonString,
|
|
486
|
+
(x) => QuerySchoolsBySourceIdentifiers$inboundSchema.parse(JSON.parse(x)),
|
|
487
|
+
`Failed to parse 'QuerySchoolsBySourceIdentifiers' from JSON`,
|
|
488
|
+
);
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
/** @internal */
|
|
492
|
+
export const QuerySchoolsBySourceInspections$inboundSchema: z.ZodType<
|
|
493
|
+
QuerySchoolsBySourceInspections,
|
|
494
|
+
z.ZodTypeDef,
|
|
495
|
+
unknown
|
|
496
|
+
> = z.object({
|
|
497
|
+
current: z.nullable(shared.SchoolInspectionEvent$inboundSchema),
|
|
498
|
+
history: z.array(z.nullable(shared.SchoolInspectionEvent$inboundSchema))
|
|
499
|
+
.optional(),
|
|
500
|
+
});
|
|
501
|
+
|
|
502
|
+
export function querySchoolsBySourceInspectionsFromJSON(
|
|
503
|
+
jsonString: string,
|
|
504
|
+
): SafeParseResult<QuerySchoolsBySourceInspections, SDKValidationError> {
|
|
505
|
+
return safeParse(
|
|
506
|
+
jsonString,
|
|
507
|
+
(x) => QuerySchoolsBySourceInspections$inboundSchema.parse(JSON.parse(x)),
|
|
508
|
+
`Failed to parse 'QuerySchoolsBySourceInspections' from JSON`,
|
|
509
|
+
);
|
|
510
|
+
}
|
|
511
|
+
|
|
386
512
|
/** @internal */
|
|
387
513
|
export const QuerySchoolsBySourceLocation$inboundSchema: z.ZodType<
|
|
388
514
|
QuerySchoolsBySourceLocation,
|
|
@@ -422,6 +548,25 @@ export const QuerySchoolsBySourceStatus$inboundSchema: z.ZodType<
|
|
|
422
548
|
unknown
|
|
423
549
|
> = openEnums.inboundSchema(QuerySchoolsBySourceStatus);
|
|
424
550
|
|
|
551
|
+
/** @internal */
|
|
552
|
+
export const QuerySchoolsBySourceTrust$inboundSchema: z.ZodType<
|
|
553
|
+
QuerySchoolsBySourceTrust,
|
|
554
|
+
z.ZodTypeDef,
|
|
555
|
+
unknown
|
|
556
|
+
> = z.object({
|
|
557
|
+
memberships: z.array(shared.SchoolTrustMembership$inboundSchema).optional(),
|
|
558
|
+
});
|
|
559
|
+
|
|
560
|
+
export function querySchoolsBySourceTrustFromJSON(
|
|
561
|
+
jsonString: string,
|
|
562
|
+
): SafeParseResult<QuerySchoolsBySourceTrust, SDKValidationError> {
|
|
563
|
+
return safeParse(
|
|
564
|
+
jsonString,
|
|
565
|
+
(x) => QuerySchoolsBySourceTrust$inboundSchema.parse(JSON.parse(x)),
|
|
566
|
+
`Failed to parse 'QuerySchoolsBySourceTrust' from JSON`,
|
|
567
|
+
);
|
|
568
|
+
}
|
|
569
|
+
|
|
425
570
|
/** @internal */
|
|
426
571
|
export const QuerySchoolsBySourceType$inboundSchema: z.ZodType<
|
|
427
572
|
QuerySchoolsBySourceType,
|
|
@@ -449,6 +594,12 @@ export const QuerySchoolsBySourceData$inboundSchema: z.ZodType<
|
|
|
449
594
|
gender: z.string().optional(),
|
|
450
595
|
headteacher: z.string().optional(),
|
|
451
596
|
id: z.number().int(),
|
|
597
|
+
identifiers: z.nullable(
|
|
598
|
+
z.lazy(() => QuerySchoolsBySourceIdentifiers$inboundSchema),
|
|
599
|
+
).optional(),
|
|
600
|
+
inspections: z.nullable(
|
|
601
|
+
z.lazy(() => QuerySchoolsBySourceInspections$inboundSchema),
|
|
602
|
+
).optional(),
|
|
452
603
|
key: z.string(),
|
|
453
604
|
laCode: z.string().optional(),
|
|
454
605
|
laName: z.string().optional(),
|
|
@@ -470,6 +621,8 @@ export const QuerySchoolsBySourceData$inboundSchema: z.ZodType<
|
|
|
470
621
|
status: QuerySchoolsBySourceStatus$inboundSchema,
|
|
471
622
|
subType: z.string().optional(),
|
|
472
623
|
telephone: z.string().optional(),
|
|
624
|
+
trust: z.nullable(z.lazy(() => QuerySchoolsBySourceTrust$inboundSchema))
|
|
625
|
+
.optional(),
|
|
473
626
|
trustId: z.string().optional(),
|
|
474
627
|
trustName: z.string().optional(),
|
|
475
628
|
type: QuerySchoolsBySourceType$inboundSchema,
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { safeParse } from "../../../lib/schemas.js";
|
|
7
|
+
import * as openEnums from "../../types/enums.js";
|
|
8
|
+
import { OpenEnum } from "../../types/enums.js";
|
|
9
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
10
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
11
|
+
import {
|
|
12
|
+
FloodRiskLevel,
|
|
13
|
+
FloodRiskLevel$inboundSchema,
|
|
14
|
+
} from "./floodrisklevel.js";
|
|
15
|
+
|
|
16
|
+
export const Direction = {
|
|
17
|
+
Increased: "increased",
|
|
18
|
+
Unchanged: "unchanged",
|
|
19
|
+
Decreased: "decreased",
|
|
20
|
+
} as const;
|
|
21
|
+
export type Direction = OpenEnum<typeof Direction>;
|
|
22
|
+
|
|
23
|
+
export type FloodClimate2080 = {
|
|
24
|
+
direction: Direction;
|
|
25
|
+
projectedRiskLevel: FloodRiskLevel | null;
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
/** @internal */
|
|
29
|
+
export const Direction$inboundSchema: z.ZodType<
|
|
30
|
+
Direction,
|
|
31
|
+
z.ZodTypeDef,
|
|
32
|
+
unknown
|
|
33
|
+
> = openEnums.inboundSchema(Direction);
|
|
34
|
+
|
|
35
|
+
/** @internal */
|
|
36
|
+
export const FloodClimate2080$inboundSchema: z.ZodType<
|
|
37
|
+
FloodClimate2080,
|
|
38
|
+
z.ZodTypeDef,
|
|
39
|
+
unknown
|
|
40
|
+
> = z.object({
|
|
41
|
+
direction: Direction$inboundSchema,
|
|
42
|
+
projectedRiskLevel: z.nullable(FloodRiskLevel$inboundSchema),
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
export function floodClimate2080FromJSON(
|
|
46
|
+
jsonString: string,
|
|
47
|
+
): SafeParseResult<FloodClimate2080, SDKValidationError> {
|
|
48
|
+
return safeParse(
|
|
49
|
+
jsonString,
|
|
50
|
+
(x) => FloodClimate2080$inboundSchema.parse(JSON.parse(x)),
|
|
51
|
+
`Failed to parse 'FloodClimate2080' from JSON`,
|
|
52
|
+
);
|
|
53
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import * as openEnums from "../../types/enums.js";
|
|
7
|
+
import { OpenEnum } from "../../types/enums.js";
|
|
8
|
+
|
|
9
|
+
export const FloodDataAvailability = {
|
|
10
|
+
Assessed: "assessed",
|
|
11
|
+
AssessedNoModelledRisk: "assessed_no_modelled_risk",
|
|
12
|
+
NotAssessed: "not_assessed",
|
|
13
|
+
OutOfCoverage: "out_of_coverage",
|
|
14
|
+
PartialQueryFailure: "partial_query_failure",
|
|
15
|
+
} as const;
|
|
16
|
+
export type FloodDataAvailability = OpenEnum<typeof FloodDataAvailability>;
|
|
17
|
+
|
|
18
|
+
/** @internal */
|
|
19
|
+
export const FloodDataAvailability$inboundSchema: z.ZodType<
|
|
20
|
+
FloodDataAvailability,
|
|
21
|
+
z.ZodTypeDef,
|
|
22
|
+
unknown
|
|
23
|
+
> = openEnums.inboundSchema(FloodDataAvailability);
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { safeParse } from "../../../lib/schemas.js";
|
|
7
|
+
import * as openEnums from "../../types/enums.js";
|
|
8
|
+
import { OpenEnum } from "../../types/enums.js";
|
|
9
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
10
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
11
|
+
import {
|
|
12
|
+
FloodNearestDefence,
|
|
13
|
+
FloodNearestDefence$inboundSchema,
|
|
14
|
+
} from "./floodnearestdefence.js";
|
|
15
|
+
|
|
16
|
+
export const DefendsAgainst = {
|
|
17
|
+
River: "river",
|
|
18
|
+
Sea: "sea",
|
|
19
|
+
} as const;
|
|
20
|
+
export type DefendsAgainst = OpenEnum<typeof DefendsAgainst>;
|
|
21
|
+
|
|
22
|
+
export type WithinDefendedArea = {
|
|
23
|
+
defendsAgainst: DefendsAgainst;
|
|
24
|
+
standardOfProtectionYears: number;
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
export type FloodDefence = {
|
|
28
|
+
hasDefencesNearby: boolean;
|
|
29
|
+
nearbyCount: number;
|
|
30
|
+
nearestDefence: FloodNearestDefence | null;
|
|
31
|
+
residualRiskNote: string;
|
|
32
|
+
withinDefendedArea: WithinDefendedArea | null;
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
/** @internal */
|
|
36
|
+
export const DefendsAgainst$inboundSchema: z.ZodType<
|
|
37
|
+
DefendsAgainst,
|
|
38
|
+
z.ZodTypeDef,
|
|
39
|
+
unknown
|
|
40
|
+
> = openEnums.inboundSchema(DefendsAgainst);
|
|
41
|
+
|
|
42
|
+
/** @internal */
|
|
43
|
+
export const WithinDefendedArea$inboundSchema: z.ZodType<
|
|
44
|
+
WithinDefendedArea,
|
|
45
|
+
z.ZodTypeDef,
|
|
46
|
+
unknown
|
|
47
|
+
> = z.object({
|
|
48
|
+
defendsAgainst: DefendsAgainst$inboundSchema,
|
|
49
|
+
standardOfProtectionYears: z.number(),
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
export function withinDefendedAreaFromJSON(
|
|
53
|
+
jsonString: string,
|
|
54
|
+
): SafeParseResult<WithinDefendedArea, SDKValidationError> {
|
|
55
|
+
return safeParse(
|
|
56
|
+
jsonString,
|
|
57
|
+
(x) => WithinDefendedArea$inboundSchema.parse(JSON.parse(x)),
|
|
58
|
+
`Failed to parse 'WithinDefendedArea' from JSON`,
|
|
59
|
+
);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/** @internal */
|
|
63
|
+
export const FloodDefence$inboundSchema: z.ZodType<
|
|
64
|
+
FloodDefence,
|
|
65
|
+
z.ZodTypeDef,
|
|
66
|
+
unknown
|
|
67
|
+
> = z.object({
|
|
68
|
+
hasDefencesNearby: z.boolean(),
|
|
69
|
+
nearbyCount: z.number().int(),
|
|
70
|
+
nearestDefence: z.nullable(FloodNearestDefence$inboundSchema),
|
|
71
|
+
residualRiskNote: z.string(),
|
|
72
|
+
withinDefendedArea: z.nullable(
|
|
73
|
+
z.lazy(() => WithinDefendedArea$inboundSchema),
|
|
74
|
+
),
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
export function floodDefenceFromJSON(
|
|
78
|
+
jsonString: string,
|
|
79
|
+
): SafeParseResult<FloodDefence, SDKValidationError> {
|
|
80
|
+
return safeParse(
|
|
81
|
+
jsonString,
|
|
82
|
+
(x) => FloodDefence$inboundSchema.parse(JSON.parse(x)),
|
|
83
|
+
`Failed to parse 'FloodDefence' from JSON`,
|
|
84
|
+
);
|
|
85
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import * as openEnums from "../../types/enums.js";
|
|
7
|
+
import { OpenEnum } from "../../types/enums.js";
|
|
8
|
+
|
|
9
|
+
export const FloodHazardRating = {
|
|
10
|
+
Low: "low",
|
|
11
|
+
Moderate: "moderate",
|
|
12
|
+
Significant: "significant",
|
|
13
|
+
Extreme: "extreme",
|
|
14
|
+
} as const;
|
|
15
|
+
export type FloodHazardRating = OpenEnum<typeof FloodHazardRating>;
|
|
16
|
+
|
|
17
|
+
/** @internal */
|
|
18
|
+
export const FloodHazardRating$inboundSchema: z.ZodType<
|
|
19
|
+
FloodHazardRating,
|
|
20
|
+
z.ZodTypeDef,
|
|
21
|
+
unknown
|
|
22
|
+
> = openEnums.inboundSchema(FloodHazardRating);
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { safeParse } from "../../../lib/schemas.js";
|
|
7
|
+
import * as openEnums from "../../types/enums.js";
|
|
8
|
+
import { OpenEnum } from "../../types/enums.js";
|
|
9
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
10
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
11
|
+
|
|
12
|
+
export const FloodNearestDefenceCondition = {
|
|
13
|
+
Good: "good",
|
|
14
|
+
Fair: "fair",
|
|
15
|
+
Poor: "poor",
|
|
16
|
+
Unknown: "unknown",
|
|
17
|
+
} as const;
|
|
18
|
+
export type FloodNearestDefenceCondition = OpenEnum<
|
|
19
|
+
typeof FloodNearestDefenceCondition
|
|
20
|
+
>;
|
|
21
|
+
|
|
22
|
+
export type FloodNearestDefence = {
|
|
23
|
+
condition: FloodNearestDefenceCondition;
|
|
24
|
+
/**
|
|
25
|
+
* Asset type, e.g. 'Raised embankment' (never 'high_ground')
|
|
26
|
+
*/
|
|
27
|
+
defenceType: string;
|
|
28
|
+
distanceMetres: number;
|
|
29
|
+
maintainedBy: string;
|
|
30
|
+
standardOfProtectionYears: number | null;
|
|
31
|
+
watercourseName: string | null;
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
/** @internal */
|
|
35
|
+
export const FloodNearestDefenceCondition$inboundSchema: z.ZodType<
|
|
36
|
+
FloodNearestDefenceCondition,
|
|
37
|
+
z.ZodTypeDef,
|
|
38
|
+
unknown
|
|
39
|
+
> = openEnums.inboundSchema(FloodNearestDefenceCondition);
|
|
40
|
+
|
|
41
|
+
/** @internal */
|
|
42
|
+
export const FloodNearestDefence$inboundSchema: z.ZodType<
|
|
43
|
+
FloodNearestDefence,
|
|
44
|
+
z.ZodTypeDef,
|
|
45
|
+
unknown
|
|
46
|
+
> = z.object({
|
|
47
|
+
condition: FloodNearestDefenceCondition$inboundSchema,
|
|
48
|
+
defenceType: z.string(),
|
|
49
|
+
distanceMetres: z.number(),
|
|
50
|
+
maintainedBy: z.string(),
|
|
51
|
+
standardOfProtectionYears: z.nullable(z.number()),
|
|
52
|
+
watercourseName: z.nullable(z.string()),
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
export function floodNearestDefenceFromJSON(
|
|
56
|
+
jsonString: string,
|
|
57
|
+
): SafeParseResult<FloodNearestDefence, SDKValidationError> {
|
|
58
|
+
return safeParse(
|
|
59
|
+
jsonString,
|
|
60
|
+
(x) => FloodNearestDefence$inboundSchema.parse(JSON.parse(x)),
|
|
61
|
+
`Failed to parse 'FloodNearestDefence' from JSON`,
|
|
62
|
+
);
|
|
63
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { safeParse } from "../../../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
8
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
9
|
+
import { FloodZone, FloodZone$inboundSchema } from "./floodzone.js";
|
|
10
|
+
|
|
11
|
+
export type FloodPlanning = {
|
|
12
|
+
exceptionTestMayApply: boolean;
|
|
13
|
+
floodZone: FloodZone;
|
|
14
|
+
fraRequired: boolean;
|
|
15
|
+
sequentialTestRequired: boolean;
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
/** @internal */
|
|
19
|
+
export const FloodPlanning$inboundSchema: z.ZodType<
|
|
20
|
+
FloodPlanning,
|
|
21
|
+
z.ZodTypeDef,
|
|
22
|
+
unknown
|
|
23
|
+
> = z.object({
|
|
24
|
+
exceptionTestMayApply: z.boolean(),
|
|
25
|
+
floodZone: FloodZone$inboundSchema,
|
|
26
|
+
fraRequired: z.boolean(),
|
|
27
|
+
sequentialTestRequired: z.boolean(),
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
export function floodPlanningFromJSON(
|
|
31
|
+
jsonString: string,
|
|
32
|
+
): SafeParseResult<FloodPlanning, SDKValidationError> {
|
|
33
|
+
return safeParse(
|
|
34
|
+
jsonString,
|
|
35
|
+
(x) => FloodPlanning$inboundSchema.parse(JSON.parse(x)),
|
|
36
|
+
`Failed to parse 'FloodPlanning' from JSON`,
|
|
37
|
+
);
|
|
38
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import * as openEnums from "../../types/enums.js";
|
|
7
|
+
import { OpenEnum } from "../../types/enums.js";
|
|
8
|
+
|
|
9
|
+
export const FloodPrimarySource = {
|
|
10
|
+
RiversSea: "rivers_sea",
|
|
11
|
+
SurfaceWater: "surface_water",
|
|
12
|
+
} as const;
|
|
13
|
+
export type FloodPrimarySource = OpenEnum<typeof FloodPrimarySource>;
|
|
14
|
+
|
|
15
|
+
/** @internal */
|
|
16
|
+
export const FloodPrimarySource$inboundSchema: z.ZodType<
|
|
17
|
+
FloodPrimarySource,
|
|
18
|
+
z.ZodTypeDef,
|
|
19
|
+
unknown
|
|
20
|
+
> = openEnums.inboundSchema(FloodPrimarySource);
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { safeParse } from "../../../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
8
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
9
|
+
|
|
10
|
+
export type FloodProbability = {
|
|
11
|
+
/**
|
|
12
|
+
* Annual chance as a percentage — e.g. 3.3 for a 1-in-30 year flood
|
|
13
|
+
*/
|
|
14
|
+
annualPercentage: number;
|
|
15
|
+
/**
|
|
16
|
+
* Plain-English annual chance, e.g. 'about a 1-in-30 chance each year'
|
|
17
|
+
*/
|
|
18
|
+
description: string;
|
|
19
|
+
/**
|
|
20
|
+
* Return period in years — e.g. 30 for a 1-in-30
|
|
21
|
+
*/
|
|
22
|
+
returnPeriod: number;
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
/** @internal */
|
|
26
|
+
export const FloodProbability$inboundSchema: z.ZodType<
|
|
27
|
+
FloodProbability,
|
|
28
|
+
z.ZodTypeDef,
|
|
29
|
+
unknown
|
|
30
|
+
> = z.object({
|
|
31
|
+
annualPercentage: z.number(),
|
|
32
|
+
description: z.string(),
|
|
33
|
+
returnPeriod: z.number(),
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
export function floodProbabilityFromJSON(
|
|
37
|
+
jsonString: string,
|
|
38
|
+
): SafeParseResult<FloodProbability, SDKValidationError> {
|
|
39
|
+
return safeParse(
|
|
40
|
+
jsonString,
|
|
41
|
+
(x) => FloodProbability$inboundSchema.parse(JSON.parse(x)),
|
|
42
|
+
`Failed to parse 'FloodProbability' from JSON`,
|
|
43
|
+
);
|
|
44
|
+
}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { safeParse } from "../../../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
8
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
9
|
+
|
|
10
|
+
export type FloodRiskCoordinate = {
|
|
11
|
+
/**
|
|
12
|
+
* Latitude in WGS84
|
|
13
|
+
*/
|
|
14
|
+
lat: number;
|
|
15
|
+
/**
|
|
16
|
+
* Longitude in WGS84
|
|
17
|
+
*/
|
|
18
|
+
lon: number;
|
|
19
|
+
};
|
|
20
|
+
|
|
21
|
+
/** @internal */
|
|
22
|
+
export const FloodRiskCoordinate$inboundSchema: z.ZodType<
|
|
23
|
+
FloodRiskCoordinate,
|
|
24
|
+
z.ZodTypeDef,
|
|
25
|
+
unknown
|
|
26
|
+
> = z.object({
|
|
27
|
+
lat: z.number(),
|
|
28
|
+
lon: z.number(),
|
|
29
|
+
});
|
|
30
|
+
/** @internal */
|
|
31
|
+
export type FloodRiskCoordinate$Outbound = {
|
|
32
|
+
lat: number;
|
|
33
|
+
lon: number;
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
/** @internal */
|
|
37
|
+
export const FloodRiskCoordinate$outboundSchema: z.ZodType<
|
|
38
|
+
FloodRiskCoordinate$Outbound,
|
|
39
|
+
z.ZodTypeDef,
|
|
40
|
+
FloodRiskCoordinate
|
|
41
|
+
> = z.object({
|
|
42
|
+
lat: z.number(),
|
|
43
|
+
lon: z.number(),
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
export function floodRiskCoordinateToJSON(
|
|
47
|
+
floodRiskCoordinate: FloodRiskCoordinate,
|
|
48
|
+
): string {
|
|
49
|
+
return JSON.stringify(
|
|
50
|
+
FloodRiskCoordinate$outboundSchema.parse(floodRiskCoordinate),
|
|
51
|
+
);
|
|
52
|
+
}
|
|
53
|
+
export function floodRiskCoordinateFromJSON(
|
|
54
|
+
jsonString: string,
|
|
55
|
+
): SafeParseResult<FloodRiskCoordinate, SDKValidationError> {
|
|
56
|
+
return safeParse(
|
|
57
|
+
jsonString,
|
|
58
|
+
(x) => FloodRiskCoordinate$inboundSchema.parse(JSON.parse(x)),
|
|
59
|
+
`Failed to parse 'FloodRiskCoordinate' from JSON`,
|
|
60
|
+
);
|
|
61
|
+
}
|