@vepler/sdk 2.46.0 → 2.57.3

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.
Files changed (1008) hide show
  1. package/README.md +252 -250
  2. package/dist/commonjs/funcs/addressGetNearestPostcodes.js.map +1 -1
  3. package/dist/commonjs/funcs/addressLookupOutcode.js.map +1 -1
  4. package/dist/commonjs/funcs/addressLookupPostcode.js.map +1 -1
  5. package/dist/commonjs/funcs/addressLookupUprn.js.map +1 -1
  6. package/dist/commonjs/funcs/addressValidatePostcode.js.map +1 -1
  7. package/dist/commonjs/funcs/areasGetAreas.js.map +1 -1
  8. package/dist/commonjs/funcs/areasGetBorderingAreas.js.map +1 -1
  9. package/dist/commonjs/funcs/areasGetChildAreas.js.map +1 -1
  10. package/dist/commonjs/funcs/companiesGetCompaniesByLocation.js.map +1 -1
  11. package/dist/commonjs/funcs/companiesGetCompany.js.map +1 -1
  12. package/dist/commonjs/funcs/companiesGetCompanyOfficers.js.map +1 -1
  13. package/dist/commonjs/funcs/companiesGetCompanyPscs.js.map +1 -1
  14. package/dist/commonjs/funcs/companiesGetOfficer.js.map +1 -1
  15. package/dist/commonjs/funcs/companiesGetPerson.js.map +1 -1
  16. package/dist/commonjs/funcs/companiesGetPersonAppointments.js.map +1 -1
  17. package/dist/commonjs/funcs/companiesGetPersonCluster.js.map +1 -1
  18. package/dist/commonjs/funcs/companiesGetPsc.js.map +1 -1
  19. package/dist/commonjs/funcs/connectivityGetConnectivityScores.js.map +1 -1
  20. package/dist/commonjs/funcs/councilsGet.js.map +1 -1
  21. package/dist/commonjs/funcs/energyGetByProperty.js.map +1 -1
  22. package/dist/commonjs/funcs/energyGetCapacity.js.map +1 -1
  23. package/dist/commonjs/funcs/energyGetConnectionQueueBySubstation.js.map +1 -1
  24. package/dist/commonjs/funcs/energyGetConnectionQueueEntry.js.map +1 -1
  25. package/dist/commonjs/funcs/energyGetDFES.js.map +1 -1
  26. package/dist/commonjs/funcs/energyGetSubstation.js.map +1 -1
  27. package/dist/commonjs/funcs/epcGetEPCByLocationId.d.ts +18 -0
  28. package/dist/commonjs/funcs/epcGetEPCByLocationId.d.ts.map +1 -0
  29. package/dist/commonjs/funcs/{epcGetByLocationId.js → epcGetEPCByLocationId.js} +8 -7
  30. package/dist/commonjs/funcs/epcGetEPCByLocationId.js.map +1 -0
  31. package/dist/commonjs/funcs/{systemCheckEPCHealth.d.ts → epcGetEPCHealth.d.ts} +3 -6
  32. package/dist/commonjs/funcs/epcGetEPCHealth.d.ts.map +1 -0
  33. package/dist/commonjs/funcs/{systemCheckEPCHealth.js → epcGetEPCHealth.js} +6 -9
  34. package/dist/{esm/funcs/systemCheckEPCHealth.js.map → commonjs/funcs/epcGetEPCHealth.js.map} +1 -1
  35. package/dist/commonjs/funcs/epcQueryEPC.d.ts +18 -0
  36. package/dist/commonjs/funcs/epcQueryEPC.d.ts.map +1 -0
  37. package/dist/commonjs/funcs/epcQueryEPC.js +118 -0
  38. package/dist/commonjs/funcs/epcQueryEPC.js.map +1 -0
  39. package/dist/commonjs/funcs/listingsGetListingById.js.map +1 -1
  40. package/dist/commonjs/funcs/listingsGetListingBySource.js.map +1 -1
  41. package/dist/commonjs/funcs/listingsGetListingsByLocation.js.map +1 -1
  42. package/dist/commonjs/funcs/planningGetPlanningApplications.js.map +1 -1
  43. package/dist/commonjs/funcs/planningGetPlanningApplicationsBySource.js.map +1 -1
  44. package/dist/commonjs/funcs/poiGetPOITile.js.map +1 -1
  45. package/dist/commonjs/funcs/propertyGetProperties.js.map +1 -1
  46. package/dist/commonjs/funcs/propertyGetPropertiesByLocation.js.map +1 -1
  47. package/dist/commonjs/funcs/propertyGetPropertiesBySource.js.map +1 -1
  48. package/dist/commonjs/funcs/propertyGetPropertyTiles.js.map +1 -1
  49. package/dist/commonjs/funcs/schoolsGet.js.map +1 -1
  50. package/dist/commonjs/funcs/schoolsGetBySlug.js.map +1 -1
  51. package/dist/commonjs/funcs/schoolsGetByUrn.js.map +1 -1
  52. package/dist/commonjs/funcs/sitesFindByProperty.js.map +1 -1
  53. package/dist/commonjs/funcs/sitesGet.js.map +1 -1
  54. package/dist/commonjs/funcs/sitesGetProperties.js.map +1 -1
  55. package/dist/commonjs/funcs/sitesGetTiles.js.map +1 -1
  56. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.js.map +1 -1
  57. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.js.map +1 -1
  58. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js.map +1 -1
  59. package/dist/commonjs/lib/config.d.ts +3 -3
  60. package/dist/commonjs/lib/config.js +3 -3
  61. package/dist/commonjs/lib/encodings.d.ts.map +1 -1
  62. package/dist/commonjs/lib/encodings.js +20 -5
  63. package/dist/commonjs/lib/encodings.js.map +1 -1
  64. package/dist/commonjs/lib/files.d.ts +13 -0
  65. package/dist/commonjs/lib/files.d.ts.map +1 -1
  66. package/dist/commonjs/lib/files.js +19 -0
  67. package/dist/commonjs/lib/files.js.map +1 -1
  68. package/dist/commonjs/lib/sdks.d.ts.map +1 -1
  69. package/dist/commonjs/lib/sdks.js +8 -4
  70. package/dist/commonjs/lib/sdks.js.map +1 -1
  71. package/dist/commonjs/lib/security.d.ts +1 -1
  72. package/dist/commonjs/lib/security.d.ts.map +1 -1
  73. package/dist/commonjs/lib/security.js +19 -8
  74. package/dist/commonjs/lib/security.js.map +1 -1
  75. package/dist/commonjs/lib/url.d.ts.map +1 -1
  76. package/dist/commonjs/lib/url.js +4 -2
  77. package/dist/commonjs/lib/url.js.map +1 -1
  78. package/dist/commonjs/sdk/epc.d.ts +15 -3
  79. package/dist/commonjs/sdk/epc.d.ts.map +1 -1
  80. package/dist/commonjs/sdk/epc.js +22 -5
  81. package/dist/commonjs/sdk/epc.js.map +1 -1
  82. package/dist/commonjs/sdk/models/errors/getepcbylocationid.d.ts +0 -65
  83. package/dist/commonjs/sdk/models/errors/getepcbylocationid.d.ts.map +1 -1
  84. package/dist/commonjs/sdk/models/errors/getepcbylocationid.js +1 -57
  85. package/dist/commonjs/sdk/models/errors/getepcbylocationid.js.map +1 -1
  86. package/dist/commonjs/sdk/models/errors/index.d.ts +1 -0
  87. package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
  88. package/dist/commonjs/sdk/models/errors/index.js +1 -0
  89. package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
  90. package/dist/commonjs/sdk/models/errors/queryepc.d.ts +71 -0
  91. package/dist/commonjs/sdk/models/errors/queryepc.d.ts.map +1 -0
  92. package/dist/commonjs/sdk/models/errors/queryepc.js +101 -0
  93. package/dist/commonjs/sdk/models/errors/queryepc.js.map +1 -0
  94. package/dist/commonjs/sdk/models/operations/findnearestsubstations.d.ts +7 -7
  95. package/dist/commonjs/sdk/models/operations/findsitesbyproperty.d.ts +3 -0
  96. package/dist/commonjs/sdk/models/operations/findsitesbyproperty.d.ts.map +1 -1
  97. package/dist/commonjs/sdk/models/operations/findsitesbyproperty.js.map +1 -1
  98. package/dist/commonjs/sdk/models/operations/findsupplyareabypoint.d.ts +6 -6
  99. package/dist/commonjs/sdk/models/operations/getareacoverage.d.ts +18 -15
  100. package/dist/commonjs/sdk/models/operations/getareacoverage.d.ts.map +1 -1
  101. package/dist/commonjs/sdk/models/operations/getareacoverage.js +7 -7
  102. package/dist/commonjs/sdk/models/operations/getareacoverage.js.map +1 -1
  103. package/dist/commonjs/sdk/models/operations/getareaswithinradius.d.ts +2 -2
  104. package/dist/commonjs/sdk/models/operations/getareaswithinradius.js +1 -1
  105. package/dist/commonjs/sdk/models/operations/getborderingareas.d.ts +2 -2
  106. package/dist/commonjs/sdk/models/operations/getchildareas.d.ts +2 -2
  107. package/dist/commonjs/sdk/models/operations/getcompaniesbylocation.d.ts +3 -0
  108. package/dist/commonjs/sdk/models/operations/getcompaniesbylocation.d.ts.map +1 -1
  109. package/dist/commonjs/sdk/models/operations/getcompaniesbylocation.js.map +1 -1
  110. package/dist/commonjs/sdk/models/operations/getconnectionqueuebysubstation.d.ts +6 -3
  111. package/dist/commonjs/sdk/models/operations/getconnectionqueuebysubstation.d.ts.map +1 -1
  112. package/dist/commonjs/sdk/models/operations/getconnectionqueuebysubstation.js.map +1 -1
  113. package/dist/commonjs/sdk/models/operations/getconnectionqueueentry.d.ts +11 -8
  114. package/dist/commonjs/sdk/models/operations/getconnectionqueueentry.d.ts.map +1 -1
  115. package/dist/commonjs/sdk/models/operations/getconnectionqueueentry.js +6 -6
  116. package/dist/commonjs/sdk/models/operations/getconnectionqueueentry.js.map +1 -1
  117. package/dist/commonjs/sdk/models/operations/getconnectivityscores.d.ts +12 -12
  118. package/dist/commonjs/sdk/models/operations/getcouncilbyproviderid.d.ts +3 -0
  119. package/dist/commonjs/sdk/models/operations/getcouncilbyproviderid.d.ts.map +1 -1
  120. package/dist/commonjs/sdk/models/operations/getcouncilbyproviderid.js.map +1 -1
  121. package/dist/commonjs/sdk/models/operations/getenergyforproperty.d.ts +29 -26
  122. package/dist/commonjs/sdk/models/operations/getenergyforproperty.d.ts.map +1 -1
  123. package/dist/commonjs/sdk/models/operations/getenergyforproperty.js.map +1 -1
  124. package/dist/commonjs/sdk/models/operations/getepcbylocationid.d.ts +2231 -233
  125. package/dist/commonjs/sdk/models/operations/getepcbylocationid.d.ts.map +1 -1
  126. package/dist/commonjs/sdk/models/operations/getepcbylocationid.js +1411 -110
  127. package/dist/commonjs/sdk/models/operations/getepcbylocationid.js.map +1 -1
  128. package/dist/commonjs/sdk/models/operations/getepchealth.d.ts +13 -0
  129. package/dist/commonjs/sdk/models/operations/getepchealth.d.ts.map +1 -0
  130. package/dist/commonjs/sdk/models/{shared/dateofbirth.js → operations/getepchealth.js} +7 -8
  131. package/dist/commonjs/sdk/models/operations/getepchealth.js.map +1 -0
  132. package/dist/commonjs/sdk/models/operations/getmetricvalues.d.ts +3 -6
  133. package/dist/commonjs/sdk/models/operations/getmetricvalues.d.ts.map +1 -1
  134. package/dist/commonjs/sdk/models/operations/getmetricvalues.js +1 -1
  135. package/dist/commonjs/sdk/models/operations/getmetricvalues.js.map +1 -1
  136. package/dist/commonjs/sdk/models/operations/getnearestpoi.d.ts +4 -4
  137. package/dist/commonjs/sdk/models/operations/getnearestpoi.d.ts.map +1 -1
  138. package/dist/commonjs/sdk/models/operations/getnearestpoi.js +6 -6
  139. package/dist/commonjs/sdk/models/operations/getnearestpoi.js.map +1 -1
  140. package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts +9 -0
  141. package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts.map +1 -1
  142. package/dist/commonjs/sdk/models/operations/getschoolbyid.js.map +1 -1
  143. package/dist/commonjs/sdk/models/operations/getschoolbyslug.d.ts +9 -0
  144. package/dist/commonjs/sdk/models/operations/getschoolbyslug.d.ts.map +1 -1
  145. package/dist/commonjs/sdk/models/operations/getschoolbyslug.js.map +1 -1
  146. package/dist/commonjs/sdk/models/operations/getschoolbyurn.d.ts +9 -0
  147. package/dist/commonjs/sdk/models/operations/getschoolbyurn.d.ts.map +1 -1
  148. package/dist/commonjs/sdk/models/operations/getschoolbyurn.js.map +1 -1
  149. package/dist/commonjs/sdk/models/operations/getschoolmetrics.d.ts +18 -6
  150. package/dist/commonjs/sdk/models/operations/getschoolmetrics.d.ts.map +1 -1
  151. package/dist/commonjs/sdk/models/operations/getschoolmetrics.js +3 -3
  152. package/dist/commonjs/sdk/models/operations/getschoolmetrics.js.map +1 -1
  153. package/dist/commonjs/sdk/models/operations/getsubstationbycode.d.ts +7 -4
  154. package/dist/commonjs/sdk/models/operations/getsubstationbycode.d.ts.map +1 -1
  155. package/dist/commonjs/sdk/models/operations/getsubstationbycode.js.map +1 -1
  156. package/dist/commonjs/sdk/models/operations/getsubstationcapacity.d.ts +5 -2
  157. package/dist/commonjs/sdk/models/operations/getsubstationcapacity.d.ts.map +1 -1
  158. package/dist/commonjs/sdk/models/operations/getsubstationcapacity.js.map +1 -1
  159. package/dist/commonjs/sdk/models/operations/getsubstationdfes.d.ts +8 -5
  160. package/dist/commonjs/sdk/models/operations/getsubstationdfes.d.ts.map +1 -1
  161. package/dist/commonjs/sdk/models/operations/getsubstationdfes.js.map +1 -1
  162. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocuments.d.ts +3 -0
  163. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocuments.d.ts.map +1 -1
  164. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocuments.js.map +1 -1
  165. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts +3 -0
  166. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts.map +1 -1
  167. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.js.map +1 -1
  168. package/dist/commonjs/sdk/models/operations/index.d.ts +1 -1
  169. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  170. package/dist/commonjs/sdk/models/operations/index.js +1 -1
  171. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  172. package/dist/commonjs/sdk/models/operations/listschools.d.ts +30 -0
  173. package/dist/commonjs/sdk/models/operations/listschools.d.ts.map +1 -1
  174. package/dist/commonjs/sdk/models/operations/listschools.js.map +1 -1
  175. package/dist/commonjs/sdk/models/operations/postv1titledeedstitlenumberpurchase.d.ts +3 -0
  176. package/dist/commonjs/sdk/models/operations/postv1titledeedstitlenumberpurchase.d.ts.map +1 -1
  177. package/dist/commonjs/sdk/models/operations/postv1titledeedstitlenumberpurchase.js.map +1 -1
  178. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts +4 -4
  179. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  180. package/dist/commonjs/sdk/models/operations/resolveaddress.js +4 -4
  181. package/dist/commonjs/sdk/models/operations/resolveaddress.js.map +1 -1
  182. package/dist/commonjs/sdk/models/operations/searchconnectionqueue.d.ts +4 -4
  183. package/dist/commonjs/sdk/models/operations/searchecr.d.ts +8 -8
  184. package/dist/commonjs/sdk/models/operations/searchplanningpolicy.d.ts +9 -0
  185. package/dist/commonjs/sdk/models/operations/searchplanningpolicy.d.ts.map +1 -1
  186. package/dist/commonjs/sdk/models/operations/searchplanningpolicy.js.map +1 -1
  187. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.d.ts +24 -0
  188. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.d.ts.map +1 -1
  189. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.js.map +1 -1
  190. package/dist/commonjs/sdk/models/operations/searchschoolswithin.d.ts +27 -0
  191. package/dist/commonjs/sdk/models/operations/searchschoolswithin.d.ts.map +1 -1
  192. package/dist/commonjs/sdk/models/operations/searchschoolswithin.js.map +1 -1
  193. package/dist/commonjs/sdk/models/operations/searchsubstations.d.ts +4 -4
  194. package/dist/commonjs/sdk/models/shared/builddata.d.ts +51 -0
  195. package/dist/commonjs/sdk/models/shared/builddata.d.ts.map +1 -1
  196. package/dist/commonjs/sdk/models/shared/builddata.js +3 -0
  197. package/dist/commonjs/sdk/models/shared/builddata.js.map +1 -1
  198. package/dist/commonjs/sdk/models/shared/chargeentry.d.ts +9 -6
  199. package/dist/commonjs/sdk/models/shared/chargeentry.d.ts.map +1 -1
  200. package/dist/commonjs/sdk/models/shared/chargeentry.js +6 -6
  201. package/dist/commonjs/sdk/models/shared/chargeentry.js.map +1 -1
  202. package/dist/commonjs/sdk/models/shared/chargehistory.d.ts +9 -3
  203. package/dist/commonjs/sdk/models/shared/chargehistory.d.ts.map +1 -1
  204. package/dist/commonjs/sdk/models/shared/chargehistory.js +3 -4
  205. package/dist/commonjs/sdk/models/shared/chargehistory.js.map +1 -1
  206. package/dist/commonjs/sdk/models/shared/company.d.ts +49 -2
  207. package/dist/commonjs/sdk/models/shared/company.d.ts.map +1 -1
  208. package/dist/commonjs/sdk/models/shared/company.js +19 -4
  209. package/dist/commonjs/sdk/models/shared/company.js.map +1 -1
  210. package/dist/commonjs/sdk/models/shared/companysummary.d.ts +52 -2
  211. package/dist/commonjs/sdk/models/shared/companysummary.d.ts.map +1 -1
  212. package/dist/commonjs/sdk/models/shared/companysummary.js +19 -3
  213. package/dist/commonjs/sdk/models/shared/companysummary.js.map +1 -1
  214. package/dist/commonjs/sdk/models/shared/counciltaxbanddetails.d.ts +15 -0
  215. package/dist/commonjs/sdk/models/shared/counciltaxbanddetails.d.ts.map +1 -1
  216. package/dist/commonjs/sdk/models/shared/counciltaxbanddetails.js.map +1 -1
  217. package/dist/commonjs/sdk/models/shared/counciltaxdata.d.ts +27 -0
  218. package/dist/commonjs/sdk/models/shared/counciltaxdata.d.ts.map +1 -1
  219. package/dist/commonjs/sdk/models/shared/counciltaxdata.js +3 -0
  220. package/dist/commonjs/sdk/models/shared/counciltaxdata.js.map +1 -1
  221. package/dist/commonjs/sdk/models/shared/epcareafilter.d.ts +12 -0
  222. package/dist/commonjs/sdk/models/shared/epcareafilter.d.ts.map +1 -0
  223. package/dist/commonjs/sdk/models/shared/{planningaddress.js → epcareafilter.js} +15 -17
  224. package/dist/commonjs/sdk/models/shared/epcareafilter.js.map +1 -0
  225. package/dist/commonjs/sdk/models/shared/epcdata.d.ts +1717 -16
  226. package/dist/commonjs/sdk/models/shared/epcdata.d.ts.map +1 -1
  227. package/dist/commonjs/sdk/models/shared/epcdata.js +1052 -14
  228. package/dist/commonjs/sdk/models/shared/epcdata.js.map +1 -1
  229. package/dist/commonjs/sdk/models/shared/epclocalauthorityareafilter.d.ts +17 -0
  230. package/dist/commonjs/sdk/models/shared/epclocalauthorityareafilter.d.ts.map +1 -0
  231. package/dist/commonjs/sdk/models/shared/{sitescores.js → epclocalauthorityareafilter.js} +8 -10
  232. package/dist/commonjs/sdk/models/shared/epclocalauthorityareafilter.js.map +1 -0
  233. package/dist/commonjs/sdk/models/shared/epcpointareafilter.d.ts +22 -0
  234. package/dist/commonjs/sdk/models/shared/epcpointareafilter.d.ts.map +1 -0
  235. package/dist/commonjs/sdk/models/{operations/checkepchealth.js → shared/epcpointareafilter.js} +9 -10
  236. package/dist/commonjs/sdk/models/shared/epcpointareafilter.js.map +1 -0
  237. package/dist/commonjs/sdk/models/shared/epcpolygonareafilter.d.ts +17 -0
  238. package/dist/commonjs/sdk/models/shared/epcpolygonareafilter.d.ts.map +1 -0
  239. package/dist/commonjs/sdk/models/shared/epcpolygonareafilter.js +50 -0
  240. package/dist/commonjs/sdk/models/shared/epcpolygonareafilter.js.map +1 -0
  241. package/dist/commonjs/sdk/models/shared/epcpostcodeareafilter.d.ts +17 -0
  242. package/dist/commonjs/sdk/models/shared/epcpostcodeareafilter.d.ts.map +1 -0
  243. package/dist/commonjs/sdk/models/shared/epcpostcodeareafilter.js +50 -0
  244. package/dist/commonjs/sdk/models/shared/epcpostcodeareafilter.js.map +1 -0
  245. package/dist/commonjs/sdk/models/shared/epcquerycondition.d.ts +105 -0
  246. package/dist/commonjs/sdk/models/shared/epcquerycondition.d.ts.map +1 -0
  247. package/dist/commonjs/sdk/models/shared/epcquerycondition.js +130 -0
  248. package/dist/commonjs/sdk/models/shared/epcquerycondition.js.map +1 -0
  249. package/dist/commonjs/sdk/models/shared/epcquerygroup.d.ts +16 -0
  250. package/dist/commonjs/sdk/models/shared/epcquerygroup.d.ts.map +1 -0
  251. package/dist/commonjs/sdk/models/shared/{planningpeople.js → epcquerygroup.js} +8 -11
  252. package/dist/commonjs/sdk/models/shared/epcquerygroup.js.map +1 -0
  253. package/dist/commonjs/sdk/models/shared/epcqueryoperator.d.ts +35 -0
  254. package/dist/commonjs/sdk/models/shared/epcqueryoperator.d.ts.map +1 -0
  255. package/dist/commonjs/sdk/models/shared/epcqueryoperator.js +61 -0
  256. package/dist/commonjs/sdk/models/shared/epcqueryoperator.js.map +1 -0
  257. package/dist/commonjs/sdk/models/shared/epcqueryrequest.d.ts +52 -0
  258. package/dist/commonjs/sdk/models/shared/epcqueryrequest.d.ts.map +1 -0
  259. package/dist/commonjs/sdk/models/shared/epcqueryrequest.js +63 -0
  260. package/dist/commonjs/sdk/models/shared/epcqueryrequest.js.map +1 -0
  261. package/dist/commonjs/sdk/models/shared/epcqueryresponse.d.ts +2476 -0
  262. package/dist/commonjs/sdk/models/shared/epcqueryresponse.d.ts.map +1 -0
  263. package/dist/commonjs/sdk/models/shared/epcqueryresponse.js +1507 -0
  264. package/dist/commonjs/sdk/models/shared/epcqueryresponse.js.map +1 -0
  265. package/dist/commonjs/sdk/models/shared/epcsort.d.ts +51 -0
  266. package/dist/commonjs/sdk/models/shared/epcsort.d.ts.map +1 -0
  267. package/dist/commonjs/sdk/models/shared/{companyaddress.js → epcsort.js} +30 -17
  268. package/dist/commonjs/sdk/models/shared/epcsort.js.map +1 -0
  269. package/dist/commonjs/sdk/models/shared/index.d.ts +11 -5
  270. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  271. package/dist/commonjs/sdk/models/shared/index.js +11 -5
  272. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  273. package/dist/commonjs/sdk/models/shared/lease.d.ts +12 -0
  274. package/dist/commonjs/sdk/models/shared/lease.d.ts.map +1 -1
  275. package/dist/commonjs/sdk/models/shared/lease.js.map +1 -1
  276. package/dist/commonjs/sdk/models/shared/listing.d.ts +3 -0
  277. package/dist/commonjs/sdk/models/shared/listing.d.ts.map +1 -1
  278. package/dist/commonjs/sdk/models/shared/listing.js +2 -2
  279. package/dist/commonjs/sdk/models/shared/listing.js.map +1 -1
  280. package/dist/commonjs/sdk/models/shared/marketstatus.d.ts +42 -6
  281. package/dist/commonjs/sdk/models/shared/marketstatus.d.ts.map +1 -1
  282. package/dist/commonjs/sdk/models/shared/marketstatus.js +6 -8
  283. package/dist/commonjs/sdk/models/shared/marketstatus.js.map +1 -1
  284. package/dist/commonjs/sdk/models/shared/nearestpostcodesresponse.d.ts +12 -12
  285. package/dist/commonjs/sdk/models/shared/nearestpostcodesresponse.d.ts.map +1 -1
  286. package/dist/commonjs/sdk/models/shared/nearestpostcodesresponse.js +11 -11
  287. package/dist/commonjs/sdk/models/shared/nearestpostcodesresponse.js.map +1 -1
  288. package/dist/commonjs/sdk/models/shared/officer.d.ts +52 -2
  289. package/dist/commonjs/sdk/models/shared/officer.d.ts.map +1 -1
  290. package/dist/commonjs/sdk/models/shared/officer.js +20 -3
  291. package/dist/commonjs/sdk/models/shared/officer.js.map +1 -1
  292. package/dist/commonjs/sdk/models/shared/outcodelookupresponse.d.ts +2 -2
  293. package/dist/commonjs/sdk/models/shared/person.d.ts +16 -1
  294. package/dist/commonjs/sdk/models/shared/person.d.ts.map +1 -1
  295. package/dist/commonjs/sdk/models/shared/person.js +11 -3
  296. package/dist/commonjs/sdk/models/shared/person.js.map +1 -1
  297. package/dist/commonjs/sdk/models/shared/personcluster.d.ts +70 -2
  298. package/dist/commonjs/sdk/models/shared/personcluster.d.ts.map +1 -1
  299. package/dist/commonjs/sdk/models/shared/personcluster.js +32 -3
  300. package/dist/commonjs/sdk/models/shared/personcluster.js.map +1 -1
  301. package/dist/commonjs/sdk/models/shared/personlistresponse.d.ts +1 -1
  302. package/dist/commonjs/sdk/models/shared/personlistresponse.d.ts.map +1 -1
  303. package/dist/commonjs/sdk/models/shared/personlistresponse.js +1 -1
  304. package/dist/commonjs/sdk/models/shared/personlistresponse.js.map +1 -1
  305. package/dist/commonjs/sdk/models/shared/personsummary.d.ts +21 -3
  306. package/dist/commonjs/sdk/models/shared/personsummary.d.ts.map +1 -1
  307. package/dist/commonjs/sdk/models/shared/personsummary.js +12 -3
  308. package/dist/commonjs/sdk/models/shared/personsummary.js.map +1 -1
  309. package/dist/commonjs/sdk/models/shared/planningapplication.d.ts +64 -4
  310. package/dist/commonjs/sdk/models/shared/planningapplication.d.ts.map +1 -1
  311. package/dist/commonjs/sdk/models/shared/planningapplication.js +32 -5
  312. package/dist/commonjs/sdk/models/shared/planningapplication.js.map +1 -1
  313. package/dist/commonjs/sdk/models/shared/postcodeaddress.d.ts +2 -2
  314. package/dist/commonjs/sdk/models/shared/postcodevalidationresponse.d.ts +2 -2
  315. package/dist/commonjs/sdk/models/shared/pricechange.d.ts +21 -0
  316. package/dist/commonjs/sdk/models/shared/pricechange.d.ts.map +1 -1
  317. package/dist/commonjs/sdk/models/shared/pricechange.js +3 -0
  318. package/dist/commonjs/sdk/models/shared/pricechange.js.map +1 -1
  319. package/dist/commonjs/sdk/models/shared/pricingdata.d.ts +15 -0
  320. package/dist/commonjs/sdk/models/shared/pricingdata.d.ts.map +1 -1
  321. package/dist/commonjs/sdk/models/shared/pricingdata.js.map +1 -1
  322. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts +7 -1
  323. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts.map +1 -1
  324. package/dist/commonjs/sdk/models/shared/propertyaddress.js +1 -1
  325. package/dist/commonjs/sdk/models/shared/propertyaddress.js.map +1 -1
  326. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts +389 -0
  327. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  328. package/dist/commonjs/sdk/models/shared/propertydataapi.js +150 -1
  329. package/dist/commonjs/sdk/models/shared/propertydataapi.js.map +1 -1
  330. package/dist/commonjs/sdk/models/shared/propertyquerycondition.d.ts +8 -8
  331. package/dist/commonjs/sdk/models/shared/propertyquerycondition.d.ts.map +1 -1
  332. package/dist/commonjs/sdk/models/shared/propertyquerycondition.js +8 -9
  333. package/dist/commonjs/sdk/models/shared/propertyquerycondition.js.map +1 -1
  334. package/dist/commonjs/sdk/models/shared/propertyqueryoperator.d.ts +4 -4
  335. package/dist/commonjs/sdk/models/shared/propertyqueryoperator.d.ts.map +1 -1
  336. package/dist/commonjs/sdk/models/shared/propertyqueryoperator.js +4 -5
  337. package/dist/commonjs/sdk/models/shared/propertyqueryoperator.js.map +1 -1
  338. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts +4 -4
  339. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
  340. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js +5 -5
  341. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js.map +1 -1
  342. package/dist/commonjs/sdk/models/shared/prosperitydata.d.ts +8 -8
  343. package/dist/commonjs/sdk/models/shared/prosperitydata.d.ts.map +1 -1
  344. package/dist/commonjs/sdk/models/shared/prosperitydata.js +8 -8
  345. package/dist/commonjs/sdk/models/shared/prosperitydata.js.map +1 -1
  346. package/dist/commonjs/sdk/models/shared/psc.d.ts +52 -2
  347. package/dist/commonjs/sdk/models/shared/psc.d.ts.map +1 -1
  348. package/dist/commonjs/sdk/models/shared/psc.js +19 -3
  349. package/dist/commonjs/sdk/models/shared/psc.js.map +1 -1
  350. package/dist/commonjs/sdk/models/shared/reversegeocoderesponse.d.ts +2 -2
  351. package/dist/commonjs/sdk/models/shared/roomdetails.d.ts +6 -0
  352. package/dist/commonjs/sdk/models/shared/roomdetails.d.ts.map +1 -1
  353. package/dist/commonjs/sdk/models/shared/roomdetails.js.map +1 -1
  354. package/dist/commonjs/sdk/models/shared/salerecord.d.ts +3 -3
  355. package/dist/commonjs/sdk/models/shared/salerecord.d.ts.map +1 -1
  356. package/dist/commonjs/sdk/models/shared/salerecord.js +3 -4
  357. package/dist/commonjs/sdk/models/shared/salerecord.js.map +1 -1
  358. package/dist/commonjs/sdk/models/shared/searchresponse.d.ts +3 -21
  359. package/dist/commonjs/sdk/models/shared/searchresponse.d.ts.map +1 -1
  360. package/dist/commonjs/sdk/models/shared/searchresponse.js +1 -6
  361. package/dist/commonjs/sdk/models/shared/searchresponse.js.map +1 -1
  362. package/dist/commonjs/sdk/models/shared/searchresult.d.ts +5 -17
  363. package/dist/commonjs/sdk/models/shared/searchresult.d.ts.map +1 -1
  364. package/dist/commonjs/sdk/models/shared/searchresult.js +1 -5
  365. package/dist/commonjs/sdk/models/shared/searchresult.js.map +1 -1
  366. package/dist/commonjs/sdk/models/shared/site.d.ts +88 -15
  367. package/dist/commonjs/sdk/models/shared/site.d.ts.map +1 -1
  368. package/dist/commonjs/sdk/models/shared/site.js +71 -8
  369. package/dist/commonjs/sdk/models/shared/site.js.map +1 -1
  370. package/dist/commonjs/sdk/models/shared/siteownership.d.ts +36 -4
  371. package/dist/commonjs/sdk/models/shared/siteownership.d.ts.map +1 -1
  372. package/dist/commonjs/sdk/models/shared/siteownership.js +27 -3
  373. package/dist/commonjs/sdk/models/shared/siteownership.js.map +1 -1
  374. package/dist/commonjs/sdk/models/shared/sitequerycondition.d.ts +4 -9
  375. package/dist/commonjs/sdk/models/shared/sitequerycondition.d.ts.map +1 -1
  376. package/dist/commonjs/sdk/models/shared/sitequerycondition.js +4 -9
  377. package/dist/commonjs/sdk/models/shared/sitequerycondition.js.map +1 -1
  378. package/dist/commonjs/sdk/models/shared/sitequeryrequest.d.ts +0 -3
  379. package/dist/commonjs/sdk/models/shared/sitequeryrequest.d.ts.map +1 -1
  380. package/dist/commonjs/sdk/models/shared/sitequeryrequest.js +0 -3
  381. package/dist/commonjs/sdk/models/shared/sitequeryrequest.js.map +1 -1
  382. package/dist/commonjs/sdk/models/shared/sitetags.d.ts +1 -9
  383. package/dist/commonjs/sdk/models/shared/sitetags.d.ts.map +1 -1
  384. package/dist/commonjs/sdk/models/shared/sitetags.js +0 -2
  385. package/dist/commonjs/sdk/models/shared/sitetags.js.map +1 -1
  386. package/dist/commonjs/sdk/models/shared/streetqueryresponse.d.ts +0 -3
  387. package/dist/commonjs/sdk/models/shared/streetqueryresponse.d.ts.map +1 -1
  388. package/dist/commonjs/sdk/models/shared/streetqueryresponse.js.map +1 -1
  389. package/dist/commonjs/sdk/models/shared/tenancydata.d.ts +6 -0
  390. package/dist/commonjs/sdk/models/shared/tenancydata.d.ts.map +1 -1
  391. package/dist/commonjs/sdk/models/shared/tenancydata.js.map +1 -1
  392. package/dist/commonjs/sdk/models/shared/tenuredata.d.ts +9 -0
  393. package/dist/commonjs/sdk/models/shared/tenuredata.d.ts.map +1 -1
  394. package/dist/commonjs/sdk/models/shared/tenuredata.js +3 -0
  395. package/dist/commonjs/sdk/models/shared/tenuredata.js.map +1 -1
  396. package/dist/commonjs/sdk/models/shared/uprnlookupresponse.d.ts +2 -2
  397. package/dist/commonjs/sdk/system.d.ts +0 -7
  398. package/dist/commonjs/sdk/system.d.ts.map +1 -1
  399. package/dist/commonjs/sdk/system.js +0 -10
  400. package/dist/commonjs/sdk/system.js.map +1 -1
  401. package/dist/esm/funcs/addressGetNearestPostcodes.js.map +1 -1
  402. package/dist/esm/funcs/addressLookupOutcode.js.map +1 -1
  403. package/dist/esm/funcs/addressLookupPostcode.js.map +1 -1
  404. package/dist/esm/funcs/addressLookupUprn.js.map +1 -1
  405. package/dist/esm/funcs/addressValidatePostcode.js.map +1 -1
  406. package/dist/esm/funcs/areasGetAreas.js.map +1 -1
  407. package/dist/esm/funcs/areasGetBorderingAreas.js.map +1 -1
  408. package/dist/esm/funcs/areasGetChildAreas.js.map +1 -1
  409. package/dist/esm/funcs/companiesGetCompaniesByLocation.js.map +1 -1
  410. package/dist/esm/funcs/companiesGetCompany.js.map +1 -1
  411. package/dist/esm/funcs/companiesGetCompanyOfficers.js.map +1 -1
  412. package/dist/esm/funcs/companiesGetCompanyPscs.js.map +1 -1
  413. package/dist/esm/funcs/companiesGetOfficer.js.map +1 -1
  414. package/dist/esm/funcs/companiesGetPerson.js.map +1 -1
  415. package/dist/esm/funcs/companiesGetPersonAppointments.js.map +1 -1
  416. package/dist/esm/funcs/companiesGetPersonCluster.js.map +1 -1
  417. package/dist/esm/funcs/companiesGetPsc.js.map +1 -1
  418. package/dist/esm/funcs/connectivityGetConnectivityScores.js.map +1 -1
  419. package/dist/esm/funcs/councilsGet.js.map +1 -1
  420. package/dist/esm/funcs/energyGetByProperty.js.map +1 -1
  421. package/dist/esm/funcs/energyGetCapacity.js.map +1 -1
  422. package/dist/esm/funcs/energyGetConnectionQueueBySubstation.js.map +1 -1
  423. package/dist/esm/funcs/energyGetConnectionQueueEntry.js.map +1 -1
  424. package/dist/esm/funcs/energyGetDFES.js.map +1 -1
  425. package/dist/esm/funcs/energyGetSubstation.js.map +1 -1
  426. package/dist/esm/funcs/epcGetEPCByLocationId.d.ts +18 -0
  427. package/dist/esm/funcs/epcGetEPCByLocationId.d.ts.map +1 -0
  428. package/dist/esm/funcs/{epcGetByLocationId.js → epcGetEPCByLocationId.js} +7 -6
  429. package/dist/esm/funcs/epcGetEPCByLocationId.js.map +1 -0
  430. package/dist/esm/funcs/{systemCheckEPCHealth.d.ts → epcGetEPCHealth.d.ts} +3 -6
  431. package/dist/esm/funcs/epcGetEPCHealth.d.ts.map +1 -0
  432. package/dist/esm/funcs/{systemCheckEPCHealth.js → epcGetEPCHealth.js} +5 -8
  433. package/dist/esm/funcs/epcGetEPCHealth.js.map +1 -0
  434. package/dist/esm/funcs/epcQueryEPC.d.ts +18 -0
  435. package/dist/esm/funcs/epcQueryEPC.d.ts.map +1 -0
  436. package/dist/esm/funcs/epcQueryEPC.js +82 -0
  437. package/dist/esm/funcs/epcQueryEPC.js.map +1 -0
  438. package/dist/esm/funcs/listingsGetListingById.js.map +1 -1
  439. package/dist/esm/funcs/listingsGetListingBySource.js.map +1 -1
  440. package/dist/esm/funcs/listingsGetListingsByLocation.js.map +1 -1
  441. package/dist/esm/funcs/planningGetPlanningApplications.js.map +1 -1
  442. package/dist/esm/funcs/planningGetPlanningApplicationsBySource.js.map +1 -1
  443. package/dist/esm/funcs/poiGetPOITile.js.map +1 -1
  444. package/dist/esm/funcs/propertyGetProperties.js.map +1 -1
  445. package/dist/esm/funcs/propertyGetPropertiesByLocation.js.map +1 -1
  446. package/dist/esm/funcs/propertyGetPropertiesBySource.js.map +1 -1
  447. package/dist/esm/funcs/propertyGetPropertyTiles.js.map +1 -1
  448. package/dist/esm/funcs/schoolsGet.js.map +1 -1
  449. package/dist/esm/funcs/schoolsGetBySlug.js.map +1 -1
  450. package/dist/esm/funcs/schoolsGetByUrn.js.map +1 -1
  451. package/dist/esm/funcs/sitesFindByProperty.js.map +1 -1
  452. package/dist/esm/funcs/sitesGet.js.map +1 -1
  453. package/dist/esm/funcs/sitesGetProperties.js.map +1 -1
  454. package/dist/esm/funcs/sitesGetTiles.js.map +1 -1
  455. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.js.map +1 -1
  456. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.js.map +1 -1
  457. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js.map +1 -1
  458. package/dist/esm/lib/config.d.ts +3 -3
  459. package/dist/esm/lib/config.js +3 -3
  460. package/dist/esm/lib/encodings.d.ts.map +1 -1
  461. package/dist/esm/lib/encodings.js +20 -5
  462. package/dist/esm/lib/encodings.js.map +1 -1
  463. package/dist/esm/lib/files.d.ts +13 -0
  464. package/dist/esm/lib/files.d.ts.map +1 -1
  465. package/dist/esm/lib/files.js +18 -0
  466. package/dist/esm/lib/files.js.map +1 -1
  467. package/dist/esm/lib/sdks.d.ts.map +1 -1
  468. package/dist/esm/lib/sdks.js +8 -4
  469. package/dist/esm/lib/sdks.js.map +1 -1
  470. package/dist/esm/lib/security.d.ts +1 -1
  471. package/dist/esm/lib/security.d.ts.map +1 -1
  472. package/dist/esm/lib/security.js +19 -8
  473. package/dist/esm/lib/security.js.map +1 -1
  474. package/dist/esm/lib/url.d.ts.map +1 -1
  475. package/dist/esm/lib/url.js +4 -2
  476. package/dist/esm/lib/url.js.map +1 -1
  477. package/dist/esm/sdk/epc.d.ts +15 -3
  478. package/dist/esm/sdk/epc.d.ts.map +1 -1
  479. package/dist/esm/sdk/epc.js +22 -5
  480. package/dist/esm/sdk/epc.js.map +1 -1
  481. package/dist/esm/sdk/models/errors/getepcbylocationid.d.ts +0 -65
  482. package/dist/esm/sdk/models/errors/getepcbylocationid.d.ts.map +1 -1
  483. package/dist/esm/sdk/models/errors/getepcbylocationid.js +0 -54
  484. package/dist/esm/sdk/models/errors/getepcbylocationid.js.map +1 -1
  485. package/dist/esm/sdk/models/errors/index.d.ts +1 -0
  486. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  487. package/dist/esm/sdk/models/errors/index.js +1 -0
  488. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  489. package/dist/esm/sdk/models/errors/queryepc.d.ts +71 -0
  490. package/dist/esm/sdk/models/errors/queryepc.d.ts.map +1 -0
  491. package/dist/esm/sdk/models/errors/queryepc.js +63 -0
  492. package/dist/esm/sdk/models/errors/queryepc.js.map +1 -0
  493. package/dist/esm/sdk/models/operations/findnearestsubstations.d.ts +7 -7
  494. package/dist/esm/sdk/models/operations/findsitesbyproperty.d.ts +3 -0
  495. package/dist/esm/sdk/models/operations/findsitesbyproperty.d.ts.map +1 -1
  496. package/dist/esm/sdk/models/operations/findsitesbyproperty.js.map +1 -1
  497. package/dist/esm/sdk/models/operations/findsupplyareabypoint.d.ts +6 -6
  498. package/dist/esm/sdk/models/operations/getareacoverage.d.ts +18 -15
  499. package/dist/esm/sdk/models/operations/getareacoverage.d.ts.map +1 -1
  500. package/dist/esm/sdk/models/operations/getareacoverage.js +8 -8
  501. package/dist/esm/sdk/models/operations/getareacoverage.js.map +1 -1
  502. package/dist/esm/sdk/models/operations/getareaswithinradius.d.ts +2 -2
  503. package/dist/esm/sdk/models/operations/getareaswithinradius.js +1 -1
  504. package/dist/esm/sdk/models/operations/getborderingareas.d.ts +2 -2
  505. package/dist/esm/sdk/models/operations/getchildareas.d.ts +2 -2
  506. package/dist/esm/sdk/models/operations/getcompaniesbylocation.d.ts +3 -0
  507. package/dist/esm/sdk/models/operations/getcompaniesbylocation.d.ts.map +1 -1
  508. package/dist/esm/sdk/models/operations/getcompaniesbylocation.js.map +1 -1
  509. package/dist/esm/sdk/models/operations/getconnectionqueuebysubstation.d.ts +6 -3
  510. package/dist/esm/sdk/models/operations/getconnectionqueuebysubstation.d.ts.map +1 -1
  511. package/dist/esm/sdk/models/operations/getconnectionqueuebysubstation.js.map +1 -1
  512. package/dist/esm/sdk/models/operations/getconnectionqueueentry.d.ts +11 -8
  513. package/dist/esm/sdk/models/operations/getconnectionqueueentry.d.ts.map +1 -1
  514. package/dist/esm/sdk/models/operations/getconnectionqueueentry.js +4 -4
  515. package/dist/esm/sdk/models/operations/getconnectionqueueentry.js.map +1 -1
  516. package/dist/esm/sdk/models/operations/getconnectivityscores.d.ts +12 -12
  517. package/dist/esm/sdk/models/operations/getcouncilbyproviderid.d.ts +3 -0
  518. package/dist/esm/sdk/models/operations/getcouncilbyproviderid.d.ts.map +1 -1
  519. package/dist/esm/sdk/models/operations/getcouncilbyproviderid.js.map +1 -1
  520. package/dist/esm/sdk/models/operations/getenergyforproperty.d.ts +29 -26
  521. package/dist/esm/sdk/models/operations/getenergyforproperty.d.ts.map +1 -1
  522. package/dist/esm/sdk/models/operations/getenergyforproperty.js.map +1 -1
  523. package/dist/esm/sdk/models/operations/getepcbylocationid.d.ts +2231 -233
  524. package/dist/esm/sdk/models/operations/getepcbylocationid.d.ts.map +1 -1
  525. package/dist/esm/sdk/models/operations/getepcbylocationid.js +1371 -106
  526. package/dist/esm/sdk/models/operations/getepcbylocationid.js.map +1 -1
  527. package/dist/esm/sdk/models/operations/getepchealth.d.ts +13 -0
  528. package/dist/esm/sdk/models/operations/getepchealth.d.ts.map +1 -0
  529. package/dist/esm/sdk/models/operations/getepchealth.js +13 -0
  530. package/dist/esm/sdk/models/operations/getepchealth.js.map +1 -0
  531. package/dist/esm/sdk/models/operations/getmetricvalues.d.ts +3 -6
  532. package/dist/esm/sdk/models/operations/getmetricvalues.d.ts.map +1 -1
  533. package/dist/esm/sdk/models/operations/getmetricvalues.js +1 -1
  534. package/dist/esm/sdk/models/operations/getmetricvalues.js.map +1 -1
  535. package/dist/esm/sdk/models/operations/getnearestpoi.d.ts +4 -4
  536. package/dist/esm/sdk/models/operations/getnearestpoi.d.ts.map +1 -1
  537. package/dist/esm/sdk/models/operations/getnearestpoi.js +4 -4
  538. package/dist/esm/sdk/models/operations/getnearestpoi.js.map +1 -1
  539. package/dist/esm/sdk/models/operations/getschoolbyid.d.ts +9 -0
  540. package/dist/esm/sdk/models/operations/getschoolbyid.d.ts.map +1 -1
  541. package/dist/esm/sdk/models/operations/getschoolbyid.js.map +1 -1
  542. package/dist/esm/sdk/models/operations/getschoolbyslug.d.ts +9 -0
  543. package/dist/esm/sdk/models/operations/getschoolbyslug.d.ts.map +1 -1
  544. package/dist/esm/sdk/models/operations/getschoolbyslug.js.map +1 -1
  545. package/dist/esm/sdk/models/operations/getschoolbyurn.d.ts +9 -0
  546. package/dist/esm/sdk/models/operations/getschoolbyurn.d.ts.map +1 -1
  547. package/dist/esm/sdk/models/operations/getschoolbyurn.js.map +1 -1
  548. package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts +18 -6
  549. package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts.map +1 -1
  550. package/dist/esm/sdk/models/operations/getschoolmetrics.js +3 -3
  551. package/dist/esm/sdk/models/operations/getschoolmetrics.js.map +1 -1
  552. package/dist/esm/sdk/models/operations/getsubstationbycode.d.ts +7 -4
  553. package/dist/esm/sdk/models/operations/getsubstationbycode.d.ts.map +1 -1
  554. package/dist/esm/sdk/models/operations/getsubstationbycode.js.map +1 -1
  555. package/dist/esm/sdk/models/operations/getsubstationcapacity.d.ts +5 -2
  556. package/dist/esm/sdk/models/operations/getsubstationcapacity.d.ts.map +1 -1
  557. package/dist/esm/sdk/models/operations/getsubstationcapacity.js.map +1 -1
  558. package/dist/esm/sdk/models/operations/getsubstationdfes.d.ts +8 -5
  559. package/dist/esm/sdk/models/operations/getsubstationdfes.d.ts.map +1 -1
  560. package/dist/esm/sdk/models/operations/getsubstationdfes.js.map +1 -1
  561. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocuments.d.ts +3 -0
  562. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocuments.d.ts.map +1 -1
  563. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocuments.js.map +1 -1
  564. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts +3 -0
  565. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts.map +1 -1
  566. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.js.map +1 -1
  567. package/dist/esm/sdk/models/operations/index.d.ts +1 -1
  568. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  569. package/dist/esm/sdk/models/operations/index.js +1 -1
  570. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  571. package/dist/esm/sdk/models/operations/listschools.d.ts +30 -0
  572. package/dist/esm/sdk/models/operations/listschools.d.ts.map +1 -1
  573. package/dist/esm/sdk/models/operations/listschools.js.map +1 -1
  574. package/dist/esm/sdk/models/operations/postv1titledeedstitlenumberpurchase.d.ts +3 -0
  575. package/dist/esm/sdk/models/operations/postv1titledeedstitlenumberpurchase.d.ts.map +1 -1
  576. package/dist/esm/sdk/models/operations/postv1titledeedstitlenumberpurchase.js.map +1 -1
  577. package/dist/esm/sdk/models/operations/resolveaddress.d.ts +4 -4
  578. package/dist/esm/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  579. package/dist/esm/sdk/models/operations/resolveaddress.js +3 -3
  580. package/dist/esm/sdk/models/operations/resolveaddress.js.map +1 -1
  581. package/dist/esm/sdk/models/operations/searchconnectionqueue.d.ts +4 -4
  582. package/dist/esm/sdk/models/operations/searchecr.d.ts +8 -8
  583. package/dist/esm/sdk/models/operations/searchplanningpolicy.d.ts +9 -0
  584. package/dist/esm/sdk/models/operations/searchplanningpolicy.d.ts.map +1 -1
  585. package/dist/esm/sdk/models/operations/searchplanningpolicy.js.map +1 -1
  586. package/dist/esm/sdk/models/operations/searchschoolsnearby.d.ts +24 -0
  587. package/dist/esm/sdk/models/operations/searchschoolsnearby.d.ts.map +1 -1
  588. package/dist/esm/sdk/models/operations/searchschoolsnearby.js.map +1 -1
  589. package/dist/esm/sdk/models/operations/searchschoolswithin.d.ts +27 -0
  590. package/dist/esm/sdk/models/operations/searchschoolswithin.d.ts.map +1 -1
  591. package/dist/esm/sdk/models/operations/searchschoolswithin.js.map +1 -1
  592. package/dist/esm/sdk/models/operations/searchsubstations.d.ts +4 -4
  593. package/dist/esm/sdk/models/shared/builddata.d.ts +51 -0
  594. package/dist/esm/sdk/models/shared/builddata.d.ts.map +1 -1
  595. package/dist/esm/sdk/models/shared/builddata.js +3 -0
  596. package/dist/esm/sdk/models/shared/builddata.js.map +1 -1
  597. package/dist/esm/sdk/models/shared/chargeentry.d.ts +9 -6
  598. package/dist/esm/sdk/models/shared/chargeentry.d.ts.map +1 -1
  599. package/dist/esm/sdk/models/shared/chargeentry.js +6 -6
  600. package/dist/esm/sdk/models/shared/chargeentry.js.map +1 -1
  601. package/dist/esm/sdk/models/shared/chargehistory.d.ts +9 -3
  602. package/dist/esm/sdk/models/shared/chargehistory.d.ts.map +1 -1
  603. package/dist/esm/sdk/models/shared/chargehistory.js +3 -4
  604. package/dist/esm/sdk/models/shared/chargehistory.js.map +1 -1
  605. package/dist/esm/sdk/models/shared/company.d.ts +49 -2
  606. package/dist/esm/sdk/models/shared/company.d.ts.map +1 -1
  607. package/dist/esm/sdk/models/shared/company.js +17 -3
  608. package/dist/esm/sdk/models/shared/company.js.map +1 -1
  609. package/dist/esm/sdk/models/shared/companysummary.d.ts +52 -2
  610. package/dist/esm/sdk/models/shared/companysummary.d.ts.map +1 -1
  611. package/dist/esm/sdk/models/shared/companysummary.js +17 -2
  612. package/dist/esm/sdk/models/shared/companysummary.js.map +1 -1
  613. package/dist/esm/sdk/models/shared/counciltaxbanddetails.d.ts +15 -0
  614. package/dist/esm/sdk/models/shared/counciltaxbanddetails.d.ts.map +1 -1
  615. package/dist/esm/sdk/models/shared/counciltaxbanddetails.js.map +1 -1
  616. package/dist/esm/sdk/models/shared/counciltaxdata.d.ts +27 -0
  617. package/dist/esm/sdk/models/shared/counciltaxdata.d.ts.map +1 -1
  618. package/dist/esm/sdk/models/shared/counciltaxdata.js +3 -0
  619. package/dist/esm/sdk/models/shared/counciltaxdata.js.map +1 -1
  620. package/dist/esm/sdk/models/shared/epcareafilter.d.ts +12 -0
  621. package/dist/esm/sdk/models/shared/epcareafilter.d.ts.map +1 -0
  622. package/dist/esm/sdk/models/shared/epcareafilter.js +19 -0
  623. package/dist/esm/sdk/models/shared/epcareafilter.js.map +1 -0
  624. package/dist/esm/sdk/models/shared/epcdata.d.ts +1717 -16
  625. package/dist/esm/sdk/models/shared/epcdata.d.ts.map +1 -1
  626. package/dist/esm/sdk/models/shared/epcdata.js +1022 -13
  627. package/dist/esm/sdk/models/shared/epcdata.js.map +1 -1
  628. package/dist/esm/sdk/models/shared/epclocalauthorityareafilter.d.ts +17 -0
  629. package/dist/esm/sdk/models/shared/epclocalauthorityareafilter.d.ts.map +1 -0
  630. package/dist/esm/sdk/models/shared/epclocalauthorityareafilter.js +13 -0
  631. package/dist/esm/sdk/models/shared/epclocalauthorityareafilter.js.map +1 -0
  632. package/dist/esm/sdk/models/shared/epcpointareafilter.d.ts +22 -0
  633. package/dist/esm/sdk/models/shared/epcpointareafilter.d.ts.map +1 -0
  634. package/dist/esm/sdk/models/shared/epcpointareafilter.js +14 -0
  635. package/dist/esm/sdk/models/shared/epcpointareafilter.js.map +1 -0
  636. package/dist/esm/sdk/models/shared/epcpolygonareafilter.d.ts +17 -0
  637. package/dist/esm/sdk/models/shared/epcpolygonareafilter.d.ts.map +1 -0
  638. package/dist/esm/sdk/models/shared/epcpolygonareafilter.js +13 -0
  639. package/dist/esm/sdk/models/shared/epcpolygonareafilter.js.map +1 -0
  640. package/dist/esm/sdk/models/shared/epcpostcodeareafilter.d.ts +17 -0
  641. package/dist/esm/sdk/models/shared/epcpostcodeareafilter.d.ts.map +1 -0
  642. package/dist/esm/sdk/models/shared/epcpostcodeareafilter.js +13 -0
  643. package/dist/esm/sdk/models/shared/epcpostcodeareafilter.js.map +1 -0
  644. package/dist/esm/sdk/models/shared/epcquerycondition.d.ts +105 -0
  645. package/dist/esm/sdk/models/shared/epcquerycondition.d.ts.map +1 -0
  646. package/dist/esm/sdk/models/shared/epcquerycondition.js +91 -0
  647. package/dist/esm/sdk/models/shared/epcquerycondition.js.map +1 -0
  648. package/dist/esm/sdk/models/shared/epcquerygroup.d.ts +16 -0
  649. package/dist/esm/sdk/models/shared/epcquerygroup.d.ts.map +1 -0
  650. package/dist/esm/sdk/models/shared/epcquerygroup.js +13 -0
  651. package/dist/esm/sdk/models/shared/epcquerygroup.js.map +1 -0
  652. package/dist/esm/sdk/models/shared/epcqueryoperator.d.ts +35 -0
  653. package/dist/esm/sdk/models/shared/epcqueryoperator.d.ts.map +1 -0
  654. package/dist/esm/sdk/models/shared/epcqueryoperator.js +24 -0
  655. package/dist/esm/sdk/models/shared/epcqueryoperator.js.map +1 -0
  656. package/dist/esm/sdk/models/shared/epcqueryrequest.d.ts +52 -0
  657. package/dist/esm/sdk/models/shared/epcqueryrequest.d.ts.map +1 -0
  658. package/dist/esm/sdk/models/shared/epcqueryrequest.js +25 -0
  659. package/dist/esm/sdk/models/shared/epcqueryrequest.js.map +1 -0
  660. package/dist/esm/sdk/models/shared/epcqueryresponse.d.ts +2476 -0
  661. package/dist/esm/sdk/models/shared/epcqueryresponse.d.ts.map +1 -0
  662. package/dist/esm/sdk/models/shared/epcqueryresponse.js +1428 -0
  663. package/dist/esm/sdk/models/shared/epcqueryresponse.js.map +1 -0
  664. package/dist/esm/sdk/models/shared/epcsort.d.ts +51 -0
  665. package/dist/esm/sdk/models/shared/epcsort.d.ts.map +1 -0
  666. package/dist/esm/sdk/models/shared/epcsort.js +35 -0
  667. package/dist/esm/sdk/models/shared/epcsort.js.map +1 -0
  668. package/dist/esm/sdk/models/shared/index.d.ts +11 -5
  669. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  670. package/dist/esm/sdk/models/shared/index.js +11 -5
  671. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  672. package/dist/esm/sdk/models/shared/lease.d.ts +12 -0
  673. package/dist/esm/sdk/models/shared/lease.d.ts.map +1 -1
  674. package/dist/esm/sdk/models/shared/lease.js.map +1 -1
  675. package/dist/esm/sdk/models/shared/listing.d.ts +3 -0
  676. package/dist/esm/sdk/models/shared/listing.d.ts.map +1 -1
  677. package/dist/esm/sdk/models/shared/listing.js +3 -3
  678. package/dist/esm/sdk/models/shared/listing.js.map +1 -1
  679. package/dist/esm/sdk/models/shared/marketstatus.d.ts +42 -6
  680. package/dist/esm/sdk/models/shared/marketstatus.d.ts.map +1 -1
  681. package/dist/esm/sdk/models/shared/marketstatus.js +6 -8
  682. package/dist/esm/sdk/models/shared/marketstatus.js.map +1 -1
  683. package/dist/esm/sdk/models/shared/nearestpostcodesresponse.d.ts +12 -12
  684. package/dist/esm/sdk/models/shared/nearestpostcodesresponse.d.ts.map +1 -1
  685. package/dist/esm/sdk/models/shared/nearestpostcodesresponse.js +8 -8
  686. package/dist/esm/sdk/models/shared/nearestpostcodesresponse.js.map +1 -1
  687. package/dist/esm/sdk/models/shared/officer.d.ts +52 -2
  688. package/dist/esm/sdk/models/shared/officer.d.ts.map +1 -1
  689. package/dist/esm/sdk/models/shared/officer.js +18 -2
  690. package/dist/esm/sdk/models/shared/officer.js.map +1 -1
  691. package/dist/esm/sdk/models/shared/outcodelookupresponse.d.ts +2 -2
  692. package/dist/esm/sdk/models/shared/person.d.ts +16 -1
  693. package/dist/esm/sdk/models/shared/person.d.ts.map +1 -1
  694. package/dist/esm/sdk/models/shared/person.js +9 -2
  695. package/dist/esm/sdk/models/shared/person.js.map +1 -1
  696. package/dist/esm/sdk/models/shared/personcluster.d.ts +70 -2
  697. package/dist/esm/sdk/models/shared/personcluster.d.ts.map +1 -1
  698. package/dist/esm/sdk/models/shared/personcluster.js +29 -2
  699. package/dist/esm/sdk/models/shared/personcluster.js.map +1 -1
  700. package/dist/esm/sdk/models/shared/personlistresponse.d.ts +1 -1
  701. package/dist/esm/sdk/models/shared/personlistresponse.d.ts.map +1 -1
  702. package/dist/esm/sdk/models/shared/personlistresponse.js +1 -1
  703. package/dist/esm/sdk/models/shared/personlistresponse.js.map +1 -1
  704. package/dist/esm/sdk/models/shared/personsummary.d.ts +21 -3
  705. package/dist/esm/sdk/models/shared/personsummary.d.ts.map +1 -1
  706. package/dist/esm/sdk/models/shared/personsummary.js +10 -2
  707. package/dist/esm/sdk/models/shared/personsummary.js.map +1 -1
  708. package/dist/esm/sdk/models/shared/planningapplication.d.ts +64 -4
  709. package/dist/esm/sdk/models/shared/planningapplication.d.ts.map +1 -1
  710. package/dist/esm/sdk/models/shared/planningapplication.js +29 -4
  711. package/dist/esm/sdk/models/shared/planningapplication.js.map +1 -1
  712. package/dist/esm/sdk/models/shared/postcodeaddress.d.ts +2 -2
  713. package/dist/esm/sdk/models/shared/postcodevalidationresponse.d.ts +2 -2
  714. package/dist/esm/sdk/models/shared/pricechange.d.ts +21 -0
  715. package/dist/esm/sdk/models/shared/pricechange.d.ts.map +1 -1
  716. package/dist/esm/sdk/models/shared/pricechange.js +3 -0
  717. package/dist/esm/sdk/models/shared/pricechange.js.map +1 -1
  718. package/dist/esm/sdk/models/shared/pricingdata.d.ts +15 -0
  719. package/dist/esm/sdk/models/shared/pricingdata.d.ts.map +1 -1
  720. package/dist/esm/sdk/models/shared/pricingdata.js.map +1 -1
  721. package/dist/esm/sdk/models/shared/propertyaddress.d.ts +7 -1
  722. package/dist/esm/sdk/models/shared/propertyaddress.d.ts.map +1 -1
  723. package/dist/esm/sdk/models/shared/propertyaddress.js +1 -1
  724. package/dist/esm/sdk/models/shared/propertyaddress.js.map +1 -1
  725. package/dist/esm/sdk/models/shared/propertydataapi.d.ts +389 -0
  726. package/dist/esm/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  727. package/dist/esm/sdk/models/shared/propertydataapi.js +142 -0
  728. package/dist/esm/sdk/models/shared/propertydataapi.js.map +1 -1
  729. package/dist/esm/sdk/models/shared/propertyquerycondition.d.ts +8 -8
  730. package/dist/esm/sdk/models/shared/propertyquerycondition.d.ts.map +1 -1
  731. package/dist/esm/sdk/models/shared/propertyquerycondition.js +6 -7
  732. package/dist/esm/sdk/models/shared/propertyquerycondition.js.map +1 -1
  733. package/dist/esm/sdk/models/shared/propertyqueryoperator.d.ts +4 -4
  734. package/dist/esm/sdk/models/shared/propertyqueryoperator.d.ts.map +1 -1
  735. package/dist/esm/sdk/models/shared/propertyqueryoperator.js +3 -4
  736. package/dist/esm/sdk/models/shared/propertyqueryoperator.js.map +1 -1
  737. package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts +4 -4
  738. package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
  739. package/dist/esm/sdk/models/shared/propertyqueryrequest.js +3 -3
  740. package/dist/esm/sdk/models/shared/propertyqueryrequest.js.map +1 -1
  741. package/dist/esm/sdk/models/shared/prosperitydata.d.ts +8 -8
  742. package/dist/esm/sdk/models/shared/prosperitydata.d.ts.map +1 -1
  743. package/dist/esm/sdk/models/shared/prosperitydata.js +8 -8
  744. package/dist/esm/sdk/models/shared/prosperitydata.js.map +1 -1
  745. package/dist/esm/sdk/models/shared/psc.d.ts +52 -2
  746. package/dist/esm/sdk/models/shared/psc.d.ts.map +1 -1
  747. package/dist/esm/sdk/models/shared/psc.js +17 -2
  748. package/dist/esm/sdk/models/shared/psc.js.map +1 -1
  749. package/dist/esm/sdk/models/shared/reversegeocoderesponse.d.ts +2 -2
  750. package/dist/esm/sdk/models/shared/roomdetails.d.ts +6 -0
  751. package/dist/esm/sdk/models/shared/roomdetails.d.ts.map +1 -1
  752. package/dist/esm/sdk/models/shared/roomdetails.js.map +1 -1
  753. package/dist/esm/sdk/models/shared/salerecord.d.ts +3 -3
  754. package/dist/esm/sdk/models/shared/salerecord.d.ts.map +1 -1
  755. package/dist/esm/sdk/models/shared/salerecord.js +3 -4
  756. package/dist/esm/sdk/models/shared/salerecord.js.map +1 -1
  757. package/dist/esm/sdk/models/shared/searchresponse.d.ts +3 -21
  758. package/dist/esm/sdk/models/shared/searchresponse.d.ts.map +1 -1
  759. package/dist/esm/sdk/models/shared/searchresponse.js +1 -6
  760. package/dist/esm/sdk/models/shared/searchresponse.js.map +1 -1
  761. package/dist/esm/sdk/models/shared/searchresult.d.ts +5 -17
  762. package/dist/esm/sdk/models/shared/searchresult.d.ts.map +1 -1
  763. package/dist/esm/sdk/models/shared/searchresult.js +1 -5
  764. package/dist/esm/sdk/models/shared/searchresult.js.map +1 -1
  765. package/dist/esm/sdk/models/shared/site.d.ts +88 -15
  766. package/dist/esm/sdk/models/shared/site.d.ts.map +1 -1
  767. package/dist/esm/sdk/models/shared/site.js +70 -7
  768. package/dist/esm/sdk/models/shared/site.js.map +1 -1
  769. package/dist/esm/sdk/models/shared/siteownership.d.ts +36 -4
  770. package/dist/esm/sdk/models/shared/siteownership.d.ts.map +1 -1
  771. package/dist/esm/sdk/models/shared/siteownership.js +26 -2
  772. package/dist/esm/sdk/models/shared/siteownership.js.map +1 -1
  773. package/dist/esm/sdk/models/shared/sitequerycondition.d.ts +4 -9
  774. package/dist/esm/sdk/models/shared/sitequerycondition.d.ts.map +1 -1
  775. package/dist/esm/sdk/models/shared/sitequerycondition.js +3 -8
  776. package/dist/esm/sdk/models/shared/sitequerycondition.js.map +1 -1
  777. package/dist/esm/sdk/models/shared/sitequeryrequest.d.ts +0 -3
  778. package/dist/esm/sdk/models/shared/sitequeryrequest.d.ts.map +1 -1
  779. package/dist/esm/sdk/models/shared/sitequeryrequest.js +0 -3
  780. package/dist/esm/sdk/models/shared/sitequeryrequest.js.map +1 -1
  781. package/dist/esm/sdk/models/shared/sitetags.d.ts +1 -9
  782. package/dist/esm/sdk/models/shared/sitetags.d.ts.map +1 -1
  783. package/dist/esm/sdk/models/shared/sitetags.js +0 -2
  784. package/dist/esm/sdk/models/shared/sitetags.js.map +1 -1
  785. package/dist/esm/sdk/models/shared/streetqueryresponse.d.ts +0 -3
  786. package/dist/esm/sdk/models/shared/streetqueryresponse.d.ts.map +1 -1
  787. package/dist/esm/sdk/models/shared/streetqueryresponse.js.map +1 -1
  788. package/dist/esm/sdk/models/shared/tenancydata.d.ts +6 -0
  789. package/dist/esm/sdk/models/shared/tenancydata.d.ts.map +1 -1
  790. package/dist/esm/sdk/models/shared/tenancydata.js.map +1 -1
  791. package/dist/esm/sdk/models/shared/tenuredata.d.ts +9 -0
  792. package/dist/esm/sdk/models/shared/tenuredata.d.ts.map +1 -1
  793. package/dist/esm/sdk/models/shared/tenuredata.js +3 -0
  794. package/dist/esm/sdk/models/shared/tenuredata.js.map +1 -1
  795. package/dist/esm/sdk/models/shared/uprnlookupresponse.d.ts +2 -2
  796. package/dist/esm/sdk/system.d.ts +0 -7
  797. package/dist/esm/sdk/system.d.ts.map +1 -1
  798. package/dist/esm/sdk/system.js +0 -10
  799. package/dist/esm/sdk/system.js.map +1 -1
  800. package/package.json +1 -1
  801. package/src/funcs/addressGetNearestPostcodes.ts +0 -1
  802. package/src/funcs/addressLookupOutcode.ts +0 -1
  803. package/src/funcs/addressLookupPostcode.ts +0 -1
  804. package/src/funcs/addressLookupUprn.ts +0 -1
  805. package/src/funcs/addressValidatePostcode.ts +0 -1
  806. package/src/funcs/areasGetAreas.ts +0 -1
  807. package/src/funcs/areasGetBorderingAreas.ts +0 -1
  808. package/src/funcs/areasGetChildAreas.ts +0 -1
  809. package/src/funcs/companiesGetCompaniesByLocation.ts +0 -1
  810. package/src/funcs/companiesGetCompany.ts +0 -1
  811. package/src/funcs/companiesGetCompanyOfficers.ts +0 -1
  812. package/src/funcs/companiesGetCompanyPscs.ts +0 -1
  813. package/src/funcs/companiesGetOfficer.ts +0 -1
  814. package/src/funcs/companiesGetPerson.ts +0 -1
  815. package/src/funcs/companiesGetPersonAppointments.ts +0 -1
  816. package/src/funcs/companiesGetPersonCluster.ts +0 -1
  817. package/src/funcs/companiesGetPsc.ts +0 -1
  818. package/src/funcs/connectivityGetConnectivityScores.ts +0 -1
  819. package/src/funcs/councilsGet.ts +0 -1
  820. package/src/funcs/energyGetByProperty.ts +0 -1
  821. package/src/funcs/energyGetCapacity.ts +0 -1
  822. package/src/funcs/energyGetConnectionQueueBySubstation.ts +0 -1
  823. package/src/funcs/energyGetConnectionQueueEntry.ts +0 -1
  824. package/src/funcs/energyGetDFES.ts +0 -1
  825. package/src/funcs/energyGetSubstation.ts +0 -1
  826. package/src/funcs/{epcGetByLocationId.ts → epcGetEPCByLocationId.ts} +5 -9
  827. package/src/funcs/{systemCheckEPCHealth.ts → epcGetEPCHealth.ts} +7 -10
  828. package/src/funcs/epcQueryEPC.ts +169 -0
  829. package/src/funcs/listingsGetListingById.ts +0 -1
  830. package/src/funcs/listingsGetListingBySource.ts +0 -1
  831. package/src/funcs/listingsGetListingsByLocation.ts +0 -1
  832. package/src/funcs/planningGetPlanningApplications.ts +0 -1
  833. package/src/funcs/planningGetPlanningApplicationsBySource.ts +0 -1
  834. package/src/funcs/poiGetPOITile.ts +0 -1
  835. package/src/funcs/propertyGetProperties.ts +0 -1
  836. package/src/funcs/propertyGetPropertiesByLocation.ts +0 -1
  837. package/src/funcs/propertyGetPropertiesBySource.ts +0 -1
  838. package/src/funcs/propertyGetPropertyTiles.ts +0 -1
  839. package/src/funcs/schoolsGet.ts +0 -1
  840. package/src/funcs/schoolsGetBySlug.ts +0 -1
  841. package/src/funcs/schoolsGetByUrn.ts +0 -1
  842. package/src/funcs/sitesFindByProperty.ts +0 -1
  843. package/src/funcs/sitesGet.ts +0 -1
  844. package/src/funcs/sitesGetProperties.ts +0 -1
  845. package/src/funcs/sitesGetTiles.ts +0 -1
  846. package/src/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.ts +0 -1
  847. package/src/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.ts +0 -1
  848. package/src/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.ts +0 -1
  849. package/src/lib/config.ts +3 -3
  850. package/src/lib/encodings.ts +23 -4
  851. package/src/lib/files.ts +22 -0
  852. package/src/lib/sdks.ts +7 -5
  853. package/src/lib/security.ts +14 -2
  854. package/src/lib/url.ts +16 -14
  855. package/src/sdk/epc.ts +37 -5
  856. package/src/sdk/models/errors/getepcbylocationid.ts +0 -127
  857. package/src/sdk/models/errors/index.ts +1 -0
  858. package/src/sdk/models/errors/queryepc.ts +137 -0
  859. package/src/sdk/models/operations/findnearestsubstations.ts +7 -7
  860. package/src/sdk/models/operations/findsitesbyproperty.ts +3 -0
  861. package/src/sdk/models/operations/findsupplyareabypoint.ts +6 -6
  862. package/src/sdk/models/operations/getareacoverage.ts +32 -24
  863. package/src/sdk/models/operations/getareaswithinradius.ts +2 -2
  864. package/src/sdk/models/operations/getborderingareas.ts +2 -2
  865. package/src/sdk/models/operations/getchildareas.ts +2 -2
  866. package/src/sdk/models/operations/getcompaniesbylocation.ts +3 -0
  867. package/src/sdk/models/operations/getconnectionqueuebysubstation.ts +6 -3
  868. package/src/sdk/models/operations/getconnectionqueueentry.ts +19 -13
  869. package/src/sdk/models/operations/getconnectivityscores.ts +12 -12
  870. package/src/sdk/models/operations/getcouncilbyproviderid.ts +3 -0
  871. package/src/sdk/models/operations/getenergyforproperty.ts +29 -26
  872. package/src/sdk/models/operations/getepcbylocationid.ts +3587 -416
  873. package/src/sdk/models/operations/getepchealth.ts +34 -0
  874. package/src/sdk/models/operations/getmetricvalues.ts +3 -6
  875. package/src/sdk/models/operations/getnearestpoi.ts +9 -9
  876. package/src/sdk/models/operations/getschoolbyid.ts +9 -0
  877. package/src/sdk/models/operations/getschoolbyslug.ts +9 -0
  878. package/src/sdk/models/operations/getschoolbyurn.ts +9 -0
  879. package/src/sdk/models/operations/getschoolmetrics.ts +18 -6
  880. package/src/sdk/models/operations/getsubstationbycode.ts +7 -4
  881. package/src/sdk/models/operations/getsubstationcapacity.ts +5 -2
  882. package/src/sdk/models/operations/getsubstationdfes.ts +8 -5
  883. package/src/sdk/models/operations/getv1titledeedstitlenumberdocuments.ts +3 -0
  884. package/src/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.ts +3 -0
  885. package/src/sdk/models/operations/index.ts +1 -1
  886. package/src/sdk/models/operations/listschools.ts +30 -0
  887. package/src/sdk/models/operations/postv1titledeedstitlenumberpurchase.ts +3 -0
  888. package/src/sdk/models/operations/resolveaddress.ts +9 -6
  889. package/src/sdk/models/operations/searchconnectionqueue.ts +4 -4
  890. package/src/sdk/models/operations/searchecr.ts +8 -8
  891. package/src/sdk/models/operations/searchplanningpolicy.ts +9 -0
  892. package/src/sdk/models/operations/searchschoolsnearby.ts +24 -0
  893. package/src/sdk/models/operations/searchschoolswithin.ts +27 -0
  894. package/src/sdk/models/operations/searchsubstations.ts +4 -4
  895. package/src/sdk/models/shared/builddata.ts +51 -0
  896. package/src/sdk/models/shared/chargeentry.ts +15 -12
  897. package/src/sdk/models/shared/chargehistory.ts +14 -7
  898. package/src/sdk/models/shared/company.ts +78 -7
  899. package/src/sdk/models/shared/companysummary.ts +85 -6
  900. package/src/sdk/models/shared/counciltaxbanddetails.ts +15 -0
  901. package/src/sdk/models/shared/counciltaxdata.ts +27 -0
  902. package/src/sdk/models/shared/epcareafilter.ts +54 -0
  903. package/src/sdk/models/shared/epcdata.ts +2668 -36
  904. package/src/sdk/models/shared/epclocalauthorityareafilter.ts +39 -0
  905. package/src/sdk/models/shared/epcpointareafilter.ts +43 -0
  906. package/src/sdk/models/shared/epcpolygonareafilter.ts +37 -0
  907. package/src/sdk/models/shared/epcpostcodeareafilter.ts +37 -0
  908. package/src/sdk/models/shared/epcquerycondition.ts +169 -0
  909. package/src/sdk/models/shared/epcquerygroup.ts +35 -0
  910. package/src/sdk/models/shared/epcqueryoperator.ts +62 -0
  911. package/src/sdk/models/shared/epcqueryrequest.ts +96 -0
  912. package/src/sdk/models/shared/epcqueryresponse.ts +4009 -0
  913. package/src/sdk/models/shared/epcsort.ts +73 -0
  914. package/src/sdk/models/shared/index.ts +11 -5
  915. package/src/sdk/models/shared/lease.ts +12 -0
  916. package/src/sdk/models/shared/listing.ts +32 -24
  917. package/src/sdk/models/shared/marketstatus.ts +48 -14
  918. package/src/sdk/models/shared/nearestpostcodesresponse.ts +36 -28
  919. package/src/sdk/models/shared/officer.ts +80 -6
  920. package/src/sdk/models/shared/outcodelookupresponse.ts +2 -2
  921. package/src/sdk/models/shared/person.ts +35 -2
  922. package/src/sdk/models/shared/personcluster.ts +119 -4
  923. package/src/sdk/models/shared/personlistresponse.ts +2 -2
  924. package/src/sdk/models/shared/personsummary.ts +41 -4
  925. package/src/sdk/models/shared/planningapplication.ts +109 -11
  926. package/src/sdk/models/shared/postcodeaddress.ts +2 -2
  927. package/src/sdk/models/shared/postcodevalidationresponse.ts +2 -2
  928. package/src/sdk/models/shared/pricechange.ts +21 -0
  929. package/src/sdk/models/shared/pricingdata.ts +15 -0
  930. package/src/sdk/models/shared/propertyaddress.ts +8 -2
  931. package/src/sdk/models/shared/propertydataapi.ts +559 -0
  932. package/src/sdk/models/shared/propertyquerycondition.ts +22 -13
  933. package/src/sdk/models/shared/propertyqueryoperator.ts +9 -6
  934. package/src/sdk/models/shared/propertyqueryrequest.ts +13 -7
  935. package/src/sdk/models/shared/prosperitydata.ts +16 -16
  936. package/src/sdk/models/shared/psc.ts +79 -6
  937. package/src/sdk/models/shared/reversegeocoderesponse.ts +2 -2
  938. package/src/sdk/models/shared/roomdetails.ts +6 -0
  939. package/src/sdk/models/shared/salerecord.ts +6 -7
  940. package/src/sdk/models/shared/searchresponse.ts +3 -21
  941. package/src/sdk/models/shared/searchresult.ts +5 -17
  942. package/src/sdk/models/shared/site.ts +114 -21
  943. package/src/sdk/models/shared/siteownership.ts +51 -6
  944. package/src/sdk/models/shared/sitequerycondition.ts +9 -12
  945. package/src/sdk/models/shared/sitequeryrequest.ts +0 -3
  946. package/src/sdk/models/shared/sitetags.ts +1 -11
  947. package/src/sdk/models/shared/streetqueryresponse.ts +0 -3
  948. package/src/sdk/models/shared/tenancydata.ts +6 -0
  949. package/src/sdk/models/shared/tenuredata.ts +9 -0
  950. package/src/sdk/models/shared/uprnlookupresponse.ts +2 -2
  951. package/src/sdk/system.ts +0 -16
  952. package/dist/commonjs/funcs/epcGetByLocationId.d.ts +0 -18
  953. package/dist/commonjs/funcs/epcGetByLocationId.d.ts.map +0 -1
  954. package/dist/commonjs/funcs/epcGetByLocationId.js.map +0 -1
  955. package/dist/commonjs/funcs/systemCheckEPCHealth.d.ts.map +0 -1
  956. package/dist/commonjs/funcs/systemCheckEPCHealth.js.map +0 -1
  957. package/dist/commonjs/sdk/models/operations/checkepchealth.d.ts +0 -15
  958. package/dist/commonjs/sdk/models/operations/checkepchealth.d.ts.map +0 -1
  959. package/dist/commonjs/sdk/models/operations/checkepchealth.js.map +0 -1
  960. package/dist/commonjs/sdk/models/shared/companyaddress.d.ts +0 -52
  961. package/dist/commonjs/sdk/models/shared/companyaddress.d.ts.map +0 -1
  962. package/dist/commonjs/sdk/models/shared/companyaddress.js.map +0 -1
  963. package/dist/commonjs/sdk/models/shared/dateofbirth.d.ts +0 -20
  964. package/dist/commonjs/sdk/models/shared/dateofbirth.d.ts.map +0 -1
  965. package/dist/commonjs/sdk/models/shared/dateofbirth.js.map +0 -1
  966. package/dist/commonjs/sdk/models/shared/planningaddress.d.ts +0 -48
  967. package/dist/commonjs/sdk/models/shared/planningaddress.d.ts.map +0 -1
  968. package/dist/commonjs/sdk/models/shared/planningaddress.js.map +0 -1
  969. package/dist/commonjs/sdk/models/shared/planningpeople.d.ts +0 -22
  970. package/dist/commonjs/sdk/models/shared/planningpeople.d.ts.map +0 -1
  971. package/dist/commonjs/sdk/models/shared/planningpeople.js.map +0 -1
  972. package/dist/commonjs/sdk/models/shared/sitescores.d.ts +0 -24
  973. package/dist/commonjs/sdk/models/shared/sitescores.d.ts.map +0 -1
  974. package/dist/commonjs/sdk/models/shared/sitescores.js.map +0 -1
  975. package/dist/esm/funcs/epcGetByLocationId.d.ts +0 -18
  976. package/dist/esm/funcs/epcGetByLocationId.d.ts.map +0 -1
  977. package/dist/esm/funcs/epcGetByLocationId.js.map +0 -1
  978. package/dist/esm/funcs/systemCheckEPCHealth.d.ts.map +0 -1
  979. package/dist/esm/sdk/models/operations/checkepchealth.d.ts +0 -15
  980. package/dist/esm/sdk/models/operations/checkepchealth.d.ts.map +0 -1
  981. package/dist/esm/sdk/models/operations/checkepchealth.js +0 -15
  982. package/dist/esm/sdk/models/operations/checkepchealth.js.map +0 -1
  983. package/dist/esm/sdk/models/shared/companyaddress.d.ts +0 -52
  984. package/dist/esm/sdk/models/shared/companyaddress.d.ts.map +0 -1
  985. package/dist/esm/sdk/models/shared/companyaddress.js +0 -22
  986. package/dist/esm/sdk/models/shared/companyaddress.js.map +0 -1
  987. package/dist/esm/sdk/models/shared/dateofbirth.d.ts +0 -20
  988. package/dist/esm/sdk/models/shared/dateofbirth.d.ts.map +0 -1
  989. package/dist/esm/sdk/models/shared/dateofbirth.js +0 -14
  990. package/dist/esm/sdk/models/shared/dateofbirth.js.map +0 -1
  991. package/dist/esm/sdk/models/shared/planningaddress.d.ts +0 -48
  992. package/dist/esm/sdk/models/shared/planningaddress.d.ts.map +0 -1
  993. package/dist/esm/sdk/models/shared/planningaddress.js +0 -21
  994. package/dist/esm/sdk/models/shared/planningaddress.js.map +0 -1
  995. package/dist/esm/sdk/models/shared/planningpeople.d.ts +0 -22
  996. package/dist/esm/sdk/models/shared/planningpeople.d.ts.map +0 -1
  997. package/dist/esm/sdk/models/shared/planningpeople.js +0 -16
  998. package/dist/esm/sdk/models/shared/planningpeople.js.map +0 -1
  999. package/dist/esm/sdk/models/shared/sitescores.d.ts +0 -24
  1000. package/dist/esm/sdk/models/shared/sitescores.d.ts.map +0 -1
  1001. package/dist/esm/sdk/models/shared/sitescores.js +0 -15
  1002. package/dist/esm/sdk/models/shared/sitescores.js.map +0 -1
  1003. package/src/sdk/models/operations/checkepchealth.ts +0 -38
  1004. package/src/sdk/models/shared/companyaddress.ts +0 -82
  1005. package/src/sdk/models/shared/dateofbirth.ts +0 -42
  1006. package/src/sdk/models/shared/planningaddress.ts +0 -77
  1007. package/src/sdk/models/shared/planningpeople.ts +0 -47
  1008. package/src/sdk/models/shared/sitescores.ts +0 -47
@@ -5,11 +5,29 @@
5
5
  import * as z from "zod/v3";
6
6
  import { remap as remap$ } from "../../../lib/primitives.js";
7
7
  import { safeParse } from "../../../lib/schemas.js";
8
- import { ClosedEnum } from "../../types/enums.js";
8
+ import * as openEnums from "../../types/enums.js";
9
+ import { ClosedEnum, OpenEnum } from "../../types/enums.js";
9
10
  import { Result as SafeParseResult } from "../../types/fp.js";
10
11
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
12
 
13
+ /**
14
+ * Filter by certificate type. Omit to return all types.
15
+ */
16
+ export const CertificateType = {
17
+ Domestic: "domestic",
18
+ NonDomestic: "non_domestic",
19
+ Dec: "dec",
20
+ } as const;
21
+ /**
22
+ * Filter by certificate type. Omit to return all types.
23
+ */
24
+ export type CertificateType = ClosedEnum<typeof CertificateType>;
25
+
12
26
  export type GetEpcByLocationIdRequest = {
27
+ /**
28
+ * Filter by certificate type. Omit to return all types.
29
+ */
30
+ certificateType?: CertificateType | undefined;
13
31
  /**
14
32
  * Maximum records to return (default: 100, max: 1000)
15
33
  */
@@ -25,688 +43,3841 @@ export type GetEpcByLocationIdRequest = {
25
43
  };
26
44
 
27
45
  /**
28
- * Property construction age information derived from EPC assessment
46
+ * Standardised address.
29
47
  */
30
- export type ConstructionAge = {
48
+ export type GetEpcByLocationIdAddress = {
49
+ /**
50
+ * Formatted display address.
51
+ */
52
+ displayAddress: string;
53
+ /**
54
+ * Address line 1.
55
+ */
56
+ line1: string | null;
57
+ /**
58
+ * Address line 2.
59
+ */
60
+ line2: string | null;
31
61
  /**
32
- * Age band code (e.g. 'E' for 1930-1949)
62
+ * Address line 3 / post town.
33
63
  */
34
- band?: string | undefined;
64
+ line3: string | null;
35
65
  /**
36
- * Human-readable age band label (e.g. '1930-1949')
66
+ * Post town.
37
67
  */
38
- description?: string | undefined;
68
+ postTown: string | null;
39
69
  /**
40
- * Start year of the construction age band
70
+ * UK postcode.
41
71
  */
42
- yearFrom?: number | undefined;
72
+ postcode: string;
43
73
  /**
44
- * End year of the construction age band
74
+ * Postcode with spaces removed, for matching.
45
75
  */
46
- yearTo?: number | undefined;
76
+ postcodeNoSpace: string;
47
77
  };
48
78
 
49
79
  /**
50
- * GeoJSON geometry type
80
+ * Assessment methodology: rdsap (existing domestic), sap (new domestic), sbem (non-domestic), dsm (complex non-domestic), operational (DEC).
51
81
  */
52
- export const GetEpcByLocationIdType = {
53
- Point: "Point",
82
+ export const AssessmentMethodology = {
83
+ Rdsap: "rdsap",
84
+ Sap: "sap",
85
+ Sbem: "sbem",
86
+ Dsm: "dsm",
87
+ Operational: "operational",
54
88
  } as const;
55
89
  /**
56
- * GeoJSON geometry type
90
+ * Assessment methodology: rdsap (existing domestic), sap (new domestic), sbem (non-domestic), dsm (complex non-domestic), operational (DEC).
57
91
  */
58
- export type GetEpcByLocationIdType = ClosedEnum<typeof GetEpcByLocationIdType>;
92
+ export type AssessmentMethodology = OpenEnum<typeof AssessmentMethodology>;
59
93
 
60
94
  /**
61
- * GeoJSON Point geometry with coordinates in [longitude, latitude] order (WGS84). Null if the property could not be geocoded.
95
+ * Primary servicing strategy for CO2 emissions calculation.
62
96
  */
63
- export type GetEpcByLocationIdGeoJSONPoint = {
64
- /**
65
- * Coordinate pair [longitude, latitude]
66
- */
67
- coordinates: Array<number>;
68
- /**
69
- * GeoJSON geometry type
70
- */
71
- type: GetEpcByLocationIdType;
72
- };
73
-
97
+ export const BuildingEnvironment = {
98
+ HeatingAndNaturalVentilation: "heating_and_natural_ventilation",
99
+ HeatingAndMechanicalVentilation: "heating_and_mechanical_ventilation",
100
+ AirConditioning: "air_conditioning",
101
+ MixedModeNatural: "mixed_mode_natural",
102
+ MixedModeMechanical: "mixed_mode_mechanical",
103
+ Unconditioned: "unconditioned",
104
+ } as const;
74
105
  /**
75
- * Geographic location attributes for the property
106
+ * Primary servicing strategy for CO2 emissions calculation.
76
107
  */
77
- export type Location = {
78
- /**
79
- * WGS84 latitude coordinate
80
- */
81
- latitude?: number | undefined;
82
- /**
83
- * WGS84 longitude coordinate
84
- */
85
- longitude?: number | undefined;
86
- /**
87
- * UK postcode for the property
88
- */
89
- postcode?: string | undefined;
90
- };
108
+ export type BuildingEnvironment = OpenEnum<typeof BuildingEnvironment>;
91
109
 
92
110
  /**
93
- * Address lines as recorded on the EPC certificate
111
+ * New build benchmark band. Scotland only.
94
112
  */
95
- export type RawAddress = {
96
- /**
97
- * Primary address line (typically house number and street)
98
- */
99
- address1?: string | undefined;
100
- /**
101
- * Secondary address line (locality or district)
102
- */
103
- address2?: string | null | undefined;
104
- /**
105
- * Tertiary address line (town or city)
106
- */
107
- address3?: string | null | undefined;
108
- };
113
+ export const NewBuildBand = {
114
+ APlus: "A+",
115
+ A: "A",
116
+ BPlus: "B+",
117
+ B: "B",
118
+ CPlus: "C+",
119
+ C: "C",
120
+ DPlus: "D+",
121
+ D: "D",
122
+ EPlus: "E+",
123
+ E: "E",
124
+ FPlus: "F+",
125
+ F: "F",
126
+ G: "G",
127
+ } as const;
128
+ /**
129
+ * New build benchmark band. Scotland only.
130
+ */
131
+ export type NewBuildBand = OpenEnum<typeof NewBuildBand>;
109
132
 
110
133
  /**
111
- * EPC (Energy Performance Certificate) record
134
+ * Non-domestic benchmarks and building classification. Null for domestic.
112
135
  */
113
- export type Data = {
114
- /**
115
- * Building reference number from the EPC register. Multiple EPC records for the same physical building share this identifier — useful for tracking rating changes over time.
116
- */
117
- buildingReferenceNumber: string | null;
118
- /**
119
- * Built form of the property (e.g. Detached, Semi-Detached, Mid-Terrace, End-Terrace, Enclosed Mid-Terrace)
120
- */
121
- builtForm: string | null;
122
- /**
123
- * Current CO2 emissions per square metre of floor area (kg CO2/m²/year). Standard MHCLG field name.
124
- */
125
- co2EmissCurrPerFloorArea: number | null;
126
- /**
127
- * Estimated current CO2 emissions in tonnes per year
128
- */
129
- co2EmissionsCurrent: number | null;
130
- /**
131
- * Estimated CO2 emissions after improvements in tonnes per year
132
- */
133
- co2EmissionsPotential: number | null;
134
- /**
135
- * ONS parliamentary constituency code
136
- */
137
- constituency: string | null;
136
+ export type Benchmarks = {
138
137
  /**
139
- * Parliamentary constituency name
138
+ * Total energy use minus on-site generation (kWh/m²/year). Scotland only.
140
139
  */
141
- constituencyLabel: string | null;
142
- /**
143
- * Property construction age information derived from EPC assessment
144
- */
145
- constructionAge?: ConstructionAge | null | undefined;
146
- /**
147
- * GeoJSON Point geometry with coordinates in [longitude, latitude] order (WGS84). Null if the property could not be geocoded.
148
- */
149
- coordinates: GetEpcByLocationIdGeoJSONPoint | null;
150
- /**
151
- * County name where applicable
152
- */
153
- county: string | null;
140
+ approximateEnergyUse: number | null;
154
141
  /**
155
- * Timestamp when this record was created in our system (ISO 8601 format)
142
+ * Building Emission Rate actual annual CO2 output (kg CO2/m²/year).
156
143
  */
157
- createdAt: string;
144
+ buildingEmissions: number | null;
158
145
  /**
159
- * Current energy efficiency SAP score (1-100, higher is better). Determines the rating band.
146
+ * Primary servicing strategy for CO2 emissions calculation.
160
147
  */
161
- currentEnergyEfficiency: number | null;
148
+ buildingEnvironment: BuildingEnvironment | null;
162
149
  /**
163
- * Current energy efficiency rating band (A to G, where A is most efficient)
150
+ * NOS assessor complexity classification. 3=simple (small, naturally ventilated), 4=medium (sophisticated HVAC), 5=complex (DSM required — airports, large shopping centres). E&W only.
164
151
  */
165
- currentEnergyRating: string | null;
152
+ buildingLevel: number | null;
166
153
  /**
167
- * Formatted display address for the property
154
+ * Electricity source (grid vs other). Scotland only. In practice, 100% of records report 'Grid supplied'.
168
155
  */
169
- displayAddress: string | null;
156
+ electricitySource: string | null;
170
157
  /**
171
- * Estimated current energy consumption in kWh per year
158
+ * Existing stock benchmark. E&W only (EXISTING_STOCK_BENCHMARK).
172
159
  */
173
- energyConsumptionCurrent: number | null;
160
+ existingStock: string | null;
174
161
  /**
175
- * Estimated energy consumption after recommended improvements in kWh per year
162
+ * Whether the building meets 2002 Scottish Building Standards (Section 63). Scotland only.
176
163
  */
177
- energyConsumptionPotential: number | null;
164
+ meets2002Standard: boolean | null;
178
165
  /**
179
- * Current energy tariff at the time of assessment (e.g. 'Single', 'Dual', 'Unknown')
166
+ * New build benchmark rating. E&W: text value from NEW_BUILD_BENCHMARK. Scotland: numeric kg CO2/m²/year from NEW_BUILD_ENERGY_PERFORMANCE_RATING.
180
167
  */
181
- energyTariff: string | null;
168
+ newBuild: number | null;
182
169
  /**
183
- * Current environmental impact rating (1-100, higher is better). Based on CO2 emissions per floor area.
170
+ * New build benchmark band. Scotland only.
184
171
  */
185
- environmentImpactCurrent: number | null;
172
+ newBuildBand: NewBuildBand | null;
186
173
  /**
187
- * Potential environmental impact rating after improvements (1-100)
174
+ * Standard Emission Rate fixed improvement-adjusted baseline (kg CO2/m²/year). E&W only.
188
175
  */
189
- environmentImpactPotential: number | null;
176
+ standardEmissions: number | null;
190
177
  /**
191
- * Number of extensions added to the original property
178
+ * Target Emission Rate Building Regs minimum requirement (kg CO2/m²/year).
192
179
  */
193
- extensionCount: number | null;
180
+ targetEmissions: number | null;
194
181
  /**
195
- * Total number of storeys in the building containing the flat. Null for houses.
182
+ * Typical Emission Rate industry comparison baseline (kg CO2/m²/year). E&W only.
196
183
  */
197
- flatStoreyCount: string | null;
184
+ typicalEmissions: number | null;
185
+ };
186
+
187
+ /**
188
+ * Certificate type: domestic, non_domestic, or dec.
189
+ */
190
+ export const GetEpcByLocationIdCertificateType = {
191
+ Domestic: "domestic",
192
+ NonDomestic: "non_domestic",
193
+ Dec: "dec",
194
+ } as const;
195
+ /**
196
+ * Certificate type: domestic, non_domestic, or dec.
197
+ */
198
+ export type GetEpcByLocationIdCertificateType = OpenEnum<
199
+ typeof GetEpcByLocationIdCertificateType
200
+ >;
201
+
202
+ /**
203
+ * Geographic coordinates. Derived from UPRN match or postcode centroid.
204
+ */
205
+ export type Coordinates = {
198
206
  /**
199
- * Whether the flat is on the top floor of the building ('Y' or 'N'). Null for houses.
207
+ * WGS84 latitude.
200
208
  */
201
- flatTopStorey: string | null;
209
+ latitude: number;
202
210
  /**
203
- * Assessor's description of floor construction and insulation (e.g. 'Solid, no insulation (assumed)')
211
+ * WGS84 longitude.
204
212
  */
205
- floorDescription: string | null;
213
+ longitude: number;
214
+ };
215
+
216
+ /**
217
+ * Built form: detached, semi_detached, mid_terrace, end_terrace, enclosed_mid_terrace, enclosed_end_terrace.
218
+ */
219
+ export const BuiltForm = {
220
+ Detached: "detached",
221
+ SemiDetached: "semi_detached",
222
+ MidTerrace: "mid_terrace",
223
+ EndTerrace: "end_terrace",
224
+ EnclosedMidTerrace: "enclosed_mid_terrace",
225
+ EnclosedEndTerrace: "enclosed_end_terrace",
226
+ } as const;
227
+ /**
228
+ * Built form: detached, semi_detached, mid_terrace, end_terrace, enclosed_mid_terrace, enclosed_end_terrace.
229
+ */
230
+ export type BuiltForm = OpenEnum<typeof BuiltForm>;
231
+
232
+ /**
233
+ * Structured construction age. Parsed from CONSTRUCTION_AGE_BAND text.
234
+ */
235
+ export type ConstructionAge = {
206
236
  /**
207
- * Floor energy efficiency rating: Very Good, Good, Average, Poor, or Very Poor
237
+ * End year of construction period. Null for 'XXXX onwards' bands.
208
238
  */
209
- floorEnergyEff: string | null;
239
+ endYear: number | null;
210
240
  /**
211
- * Floor environmental efficiency rating: Very Good, Good, Average, Poor, or Very Poor
241
+ * Whether the construction date is an exact year (true) or a range (false).
212
242
  */
213
- floorEnvEff: string | null;
243
+ isExact: boolean;
214
244
  /**
215
- * Average storey height in metres
245
+ * Midpoint year. Useful for approximate age calculations.
216
246
  */
217
- floorHeight: number | null;
247
+ midYear: number | null;
218
248
  /**
219
- * Floor level for flats (e.g. 'Ground', '1st', '2nd'). Null for houses.
249
+ * Start year of construction period. Null for 'before XXXX' bands.
220
250
  */
221
- floorLevel: string | null;
251
+ startYear: number | null;
252
+ };
253
+
254
+ /**
255
+ * Glazed area relative to typical property. Deprecated in RdSAP10 but persists in register from older assessments.
256
+ */
257
+ export const Area = {
258
+ MuchLessThanTypical: "much_less_than_typical",
259
+ LessThanTypical: "less_than_typical",
260
+ Normal: "normal",
261
+ MoreThanTypical: "more_than_typical",
262
+ MuchMoreThanTypical: "much_more_than_typical",
263
+ } as const;
264
+ /**
265
+ * Glazed area relative to typical property. Deprecated in RdSAP10 but persists in register from older assessments.
266
+ */
267
+ export type Area = OpenEnum<typeof Area>;
268
+
269
+ /**
270
+ * Glazing specification.
271
+ */
272
+ export const GetEpcByLocationIdType = {
273
+ Single: "single",
274
+ DoublePre2002: "double_pre_2002",
275
+ DoublePost2002: "double_post_2002",
276
+ DoubleUnknown: "double_unknown",
277
+ Triple: "triple",
278
+ Secondary: "secondary",
279
+ SecondaryLowEmissivity: "secondary_low_emissivity",
280
+ NotDefined: "not_defined",
281
+ } as const;
282
+ /**
283
+ * Glazing specification.
284
+ */
285
+ export type GetEpcByLocationIdType = OpenEnum<typeof GetEpcByLocationIdType>;
286
+
287
+ /**
288
+ * Glazing details.
289
+ */
290
+ export type Glazing = {
222
291
  /**
223
- * Relative glazed area compared to typical: Normal, More Than Typical, Much More Than Typical, Less Than Typical, Much Less Than Typical
292
+ * Glazed area relative to typical property. Deprecated in RdSAP10 but persists in register from older assessments.
224
293
  */
225
- glazedArea: string | null;
294
+ area: Area | null;
226
295
  /**
227
- * Type of glazing (e.g. 'double glazing installed before 2002', 'triple glazing')
296
+ * Percentage of windows that are double/triple glazed.
228
297
  */
229
- glazedType: string | null;
298
+ proportion: number | null;
230
299
  /**
231
- * Type of corridor adjacent to the property for heat loss calculation (e.g. 'heated corridor', 'unheated corridor', 'no corridor'). Note: field name preserves original MHCLG spelling.
300
+ * Glazing specification.
232
301
  */
233
- heatLossCorridoor: string | null;
302
+ type: GetEpcByLocationIdType | null;
303
+ };
304
+
305
+ /**
306
+ * Tenure type: owner_occupied, rented_social, rented_private, unknown.
307
+ */
308
+ export const Tenure = {
309
+ OwnerOccupied: "owner_occupied",
310
+ RentedSocial: "rented_social",
311
+ RentedPrivate: "rented_private",
312
+ Unknown: "unknown",
313
+ } as const;
314
+ /**
315
+ * Tenure type: owner_occupied, rented_social, rented_private, unknown.
316
+ */
317
+ export type Tenure = OpenEnum<typeof Tenure>;
318
+
319
+ /**
320
+ * Domestic property details — construction, rooms, glazing, Scotland-specific fields. Null for non-domestic and DECs.
321
+ */
322
+ export type DomesticDetails = {
234
323
  /**
235
- * Estimated current annual space heating cost in GBP
324
+ * Built form: detached, semi_detached, mid_terrace, end_terrace, enclosed_mid_terrace, enclosed_end_terrace.
236
325
  */
237
- heatingCostCurrent: number | null;
326
+ builtForm: BuiltForm | null;
238
327
  /**
239
- * Estimated annual space heating cost after improvements in GBP
328
+ * Structured construction age. Parsed from CONSTRUCTION_AGE_BAND text.
240
329
  */
241
- heatingCostPotential: number | null;
330
+ constructionAge: ConstructionAge | null;
242
331
  /**
243
- * Estimated current annual hot water cost in GBP
332
+ * Raw construction age band text from source. E.g. 'England and Wales: 1930-1949' or 'before 1919'.
244
333
  */
245
- hotWaterCostCurrent: number | null;
334
+ constructionAgeBandExternal: string | null;
246
335
  /**
247
- * Estimated annual hot water cost after improvements in GBP
336
+ * Number of extensions.
248
337
  */
249
- hotWaterCostPotential: number | null;
338
+ extensionCount: number | null;
250
339
  /**
251
- * Hot water energy efficiency rating: Very Good, Good, Average, Poor, or Very Poor
340
+ * Total number of storeys in the flat's building.
252
341
  */
253
- hotWaterEnergyEff: string | null;
342
+ flatStoreyCount: number | null;
254
343
  /**
255
- * Hot water environmental efficiency rating: Very Good, Good, Average, Poor, or Very Poor
344
+ * Whether the flat occupies the top storey. Derived from FLAT_TOP_STOREY (Y→true, N→false).
256
345
  */
257
- hotWaterEnvEff: string | null;
346
+ flatTopStorey: boolean | null;
258
347
  /**
259
- * Description of the hot water system (e.g. 'From main system')
348
+ * Average floor-to-ceiling height in metres.
260
349
  */
261
- hotwaterDescription: string | null;
350
+ floorHeight: number | null;
262
351
  /**
263
- * Unique EPC record identifier
352
+ * Floor level (for flats).
264
353
  */
265
- id: number;
354
+ floorLevel: string | null;
266
355
  /**
267
- * Date the EPC assessment was carried out (ISO 8601 format)
356
+ * Glazing details.
268
357
  */
269
- inspectionDate: string | null;
358
+ glazing: Glazing;
270
359
  /**
271
- * Unique EPC certificate reference number (e.g. '0000-0000-0000-0000-0000'). Use this to look up the full certificate on the EPC Register at https://www.gov.uk/find-energy-certificate.
360
+ * Count of habitable rooms.
272
361
  */
273
- inspectionId: string;
362
+ habitableRooms: number | null;
274
363
  /**
275
- * Estimated current annual lighting cost in GBP
364
+ * Count of heated rooms.
276
365
  */
277
- lightingCostCurrent: number | null;
366
+ heatedRooms: number | null;
278
367
  /**
279
- * Estimated annual lighting cost after improvements in GBP
368
+ * Estimated SAP score impact of cavity wall insulation. Scotland only.
280
369
  */
281
- lightingCostPotential: number | null;
370
+ impactCavityWallInsulation: number | null;
282
371
  /**
283
- * Description of lighting provision (e.g. 'Low energy lighting in 80% of fixed outlets')
372
+ * Estimated SAP score impact of loft insulation. Scotland only.
284
373
  */
285
- lightingDescription: string | null;
374
+ impactLoftInsulation: number | null;
286
375
  /**
287
- * Lighting energy efficiency rating: Very Good, Good, Average, Poor, or Very Poor
376
+ * Estimated SAP score impact of solid wall insulation. Scotland only.
288
377
  */
289
- lightingEnergyEff: string | null;
378
+ impactSolidWallInsulation: number | null;
290
379
  /**
291
- * Lighting environmental efficiency rating: Very Good, Good, Average, Poor, or Very Poor
380
+ * Percentage of light fittings that are low-energy.
292
381
  */
293
- lightingEnvEff: string | null;
382
+ lowEnergyLighting: number | null;
294
383
  /**
295
- * ONS local authority code (e.g. 'E09000033' for Westminster)
384
+ * Low/zero carbon energy sources description. Scotland only.
296
385
  */
297
- localAuthority: string | null;
386
+ lzcEnergySources: string | null;
298
387
  /**
299
- * Local authority name (e.g. 'Westminster')
388
+ * Count of open fireplaces.
300
389
  */
301
- localAuthorityLabel: string | null;
390
+ openFireplaces: number | null;
302
391
  /**
303
- * Geographic location attributes for the property
392
+ * Space heating demand in kWh/year. Scotland only.
304
393
  */
305
- location: Location;
394
+ spaceHeatingDemand: number | null;
306
395
  /**
307
- * UPRN (Unique Property Reference Number) linking this EPC to a property location. Use this to cross-reference with the Property API. Null if the EPC record could not be matched to an address.
396
+ * Tenure type: owner_occupied, rented_social, rented_private, unknown.
308
397
  */
309
- locationId: number | null;
398
+ tenure: Tenure | null;
310
399
  /**
311
- * Date the EPC certificate was lodged on the register (ISO 8601 format). EPCs are valid for 10 years from this date.
400
+ * Three-year energy cost at current efficiency (£). Scotland only.
312
401
  */
313
- lodgementDate: string | null;
402
+ threeYearEnergyCostCurrent: number | null;
314
403
  /**
315
- * Percentage of fixed lighting outlets using low-energy fittings (0-100)
404
+ * Three-year potential energy saving (£). Scotland only.
316
405
  */
317
- lowEnergyLighting: number | null;
406
+ threeYearEnergySavingPotential: number | null;
318
407
  /**
319
- * Primary fuel source for the property (e.g. 'mains gas', 'electricity', 'oil', 'LPG')
408
+ * Water heating demand in kWh/year. Scotland only.
320
409
  */
321
- mainFuel: string | null;
410
+ waterHeatingDemand: number | null;
411
+ };
412
+
413
+ /**
414
+ * Unit of co2Current measurement. Domestic: tonnes_per_year. Non-domestic/DEC: kg_co2_per_m2_per_year.
415
+ */
416
+ export const Co2Unit = {
417
+ TonnesPerYear: "tonnes_per_year",
418
+ KgCo2PerM2PerYear: "kg_co2_per_m2_per_year",
419
+ } as const;
420
+ /**
421
+ * Unit of co2Current measurement. Domestic: tonnes_per_year. Non-domestic/DEC: kg_co2_per_m2_per_year.
422
+ */
423
+ export type Co2Unit = OpenEnum<typeof Co2Unit>;
424
+
425
+ /**
426
+ * Unit of energyConsumptionCurrent measurement.
427
+ */
428
+ export const EnergyConsumptionUnit = {
429
+ KwhPerYear: "kwh_per_year",
430
+ KwhPerM2PerYear: "kwh_per_m2_per_year",
431
+ } as const;
432
+ /**
433
+ * Unit of energyConsumptionCurrent measurement.
434
+ */
435
+ export type EnergyConsumptionUnit = OpenEnum<typeof EnergyConsumptionUnit>;
436
+
437
+ /**
438
+ * Environmental impact, CO2 emissions, and energy consumption.
439
+ */
440
+ export type Emissions = {
322
441
  /**
323
- * Heating controls code used in the SAP calculation
442
+ * Current annual CO2 emissions. Domestic: tonnes/year. Non-domestic: kg CO2/m²/year (building emission rate). Check co2Unit for the measurement unit.
324
443
  */
325
- mainHeatingControls: string | null;
444
+ co2Current: number | null;
326
445
  /**
327
- * Description of the main heating system (e.g. 'Boiler and radiators, mains gas')
446
+ * CO2 intensity per unit floor area (kg CO2/m²/year). Directly reported for domestic (CO2_EMISS_CURR_PER_FLOOR_AREA). For non-domestic, this equals BUILDING_EMISSIONS.
328
447
  */
329
- mainheatDescription: string | null;
448
+ co2PerFloorArea: number | null;
330
449
  /**
331
- * Main heating energy efficiency rating: Very Good, Good, Average, Poor, or Very Poor
450
+ * Achievable CO2 emissions after improvements. Domestic only; null for non-domestic and DECs.
332
451
  */
333
- mainheatEnergyEff: string | null;
452
+ co2Potential: number | null;
334
453
  /**
335
- * Main heating environmental efficiency rating: Very Good, Good, Average, Poor, or Very Poor
454
+ * Unit of co2Current measurement. Domestic: tonnes_per_year. Non-domestic/DEC: kg_co2_per_m2_per_year.
336
455
  */
337
- mainheatEnvEff: string | null;
456
+ co2Unit: Co2Unit;
338
457
  /**
339
- * Heating controls energy efficiency rating: Very Good, Good, Average, Poor, or Very Poor. Standard MHCLG field name.
458
+ * Current annual energy consumption. Domestic: kWh/year. Non-domestic: kWh/m²/year (PRIMARY_ENERGY_VALUE). Check energyConsumptionUnit for measurement unit.
340
459
  */
341
- mainheatcEnergyEff: string | null;
460
+ energyConsumptionCurrent: number | null;
342
461
  /**
343
- * Heating controls environmental efficiency rating: Very Good, Good, Average, Poor, or Very Poor. Standard MHCLG field name.
462
+ * Achievable energy consumption. Domestic only.
344
463
  */
345
- mainheatcEnvEff: string | null;
464
+ energyConsumptionPotential: number | null;
346
465
  /**
347
- * Description of main heating controls (e.g. 'Programmer, room thermostat and TRVs')
466
+ * Unit of energyConsumptionCurrent measurement.
348
467
  */
349
- mainheatcontDescription: string | null;
468
+ energyConsumptionUnit: EnergyConsumptionUnit | null;
350
469
  /**
351
- * Whether the property is connected to mains gas ('Y' or 'N')
470
+ * Environmental impact score (1-100, higher is better). Domestic only.
352
471
  */
353
- mainsGasFlag: string | null;
472
+ environmentalScoreCurrent: number | null;
354
473
  /**
355
- * Type of mechanical ventilation system if present (e.g. 'natural', 'mechanical, extract only', 'mechanical, supply and extract')
474
+ * Achievable environmental impact score. Domestic only.
356
475
  */
357
- mechanicalVentilation: string | null;
476
+ environmentalScorePotential: number | null;
477
+ };
478
+
479
+ /**
480
+ * Energy efficiency rating.
481
+ */
482
+ export const EnergyEfficiency = {
483
+ VeryGood: "very_good",
484
+ Good: "good",
485
+ Average: "average",
486
+ Poor: "poor",
487
+ VeryPoor: "very_poor",
488
+ } as const;
489
+ /**
490
+ * Energy efficiency rating.
491
+ */
492
+ export type EnergyEfficiency = OpenEnum<typeof EnergyEfficiency>;
493
+
494
+ /**
495
+ * Environmental efficiency rating.
496
+ */
497
+ export const EnvironmentalEfficiency = {
498
+ VeryGood: "very_good",
499
+ Good: "good",
500
+ Average: "average",
501
+ Poor: "poor",
502
+ VeryPoor: "very_poor",
503
+ } as const;
504
+ /**
505
+ * Environmental efficiency rating.
506
+ */
507
+ export type EnvironmentalEfficiency = OpenEnum<typeof EnvironmentalEfficiency>;
508
+
509
+ /**
510
+ * Air tightness assessment. Scotland only; null for E&W.
511
+ */
512
+ export type AirTightness = {
358
513
  /**
359
- * Percentage of windows that are multi-glazed (0-100)
514
+ * SAP description string from assessor.
360
515
  */
361
- multiGlazeProportion: number | null;
516
+ description: string | null;
362
517
  /**
363
- * Total number of habitable rooms (bedrooms, living rooms, kitchens over a certain size)
518
+ * Energy efficiency rating.
364
519
  */
365
- numberHabitableRooms: number | null;
520
+ energyEfficiency: EnergyEfficiency | null;
366
521
  /**
367
- * Number of rooms with heating provision
522
+ * Environmental efficiency rating.
368
523
  */
369
- numberHeatedRooms: number | null;
524
+ environmentalEfficiency: EnvironmentalEfficiency | null;
525
+ };
526
+
527
+ /**
528
+ * Non-null when source value was corrupted/incomplete.
529
+ */
530
+ export const DataQuality = {
531
+ TruncatedThermalTransmittance: "truncated_thermal_transmittance",
532
+ QualityLabelOnly: "quality_label_only",
533
+ WelshLanguage: "welsh_language",
534
+ CorruptedEncoding: "corrupted_encoding",
535
+ SourceError: "source_error",
536
+ } as const;
537
+ /**
538
+ * Non-null when source value was corrupted/incomplete.
539
+ */
540
+ export type DataQuality = OpenEnum<typeof DataQuality>;
541
+
542
+ /**
543
+ * Energy efficiency rating.
544
+ */
545
+ export const GetEpcByLocationIdEnergyEfficiency = {
546
+ VeryGood: "very_good",
547
+ Good: "good",
548
+ Average: "average",
549
+ Poor: "poor",
550
+ VeryPoor: "very_poor",
551
+ } as const;
552
+ /**
553
+ * Energy efficiency rating.
554
+ */
555
+ export type GetEpcByLocationIdEnergyEfficiency = OpenEnum<
556
+ typeof GetEpcByLocationIdEnergyEfficiency
557
+ >;
558
+
559
+ /**
560
+ * Environmental efficiency rating.
561
+ */
562
+ export const GetEpcByLocationIdEnvironmentalEfficiency = {
563
+ VeryGood: "very_good",
564
+ Good: "good",
565
+ Average: "average",
566
+ Poor: "poor",
567
+ VeryPoor: "very_poor",
568
+ } as const;
569
+ /**
570
+ * Environmental efficiency rating.
571
+ */
572
+ export type GetEpcByLocationIdEnvironmentalEfficiency = OpenEnum<
573
+ typeof GetEpcByLocationIdEnvironmentalEfficiency
574
+ >;
575
+
576
+ /**
577
+ * Floor type: solid, suspended_timber, suspended_sealed, another_dwelling_below, other_premises_below.
578
+ */
579
+ export const FloorType = {
580
+ Solid: "solid",
581
+ SuspendedTimber: "suspended_timber",
582
+ SuspendedSealed: "suspended_sealed",
583
+ AnotherDwellingBelow: "another_dwelling_below",
584
+ OtherPremisesBelow: "other_premises_below",
585
+ } as const;
586
+ /**
587
+ * Floor type: solid, suspended_timber, suspended_sealed, another_dwelling_below, other_premises_below.
588
+ */
589
+ export type FloorType = OpenEnum<typeof FloorType>;
590
+
591
+ /**
592
+ * Insulation type if present.
593
+ */
594
+ export const InsulationType = {
595
+ None: "none",
596
+ AsBuilt: "as_built",
597
+ FilledCavity: "filled_cavity",
598
+ External: "external",
599
+ Internal: "internal",
600
+ FilledCavityAndExternal: "filled_cavity_and_external",
601
+ FilledCavityAndInternal: "filled_cavity_and_internal",
602
+ Partial: "partial",
603
+ RetroFitted: "retro_fitted",
604
+ Loft: "loft",
605
+ Rafter: "rafter",
606
+ } as const;
607
+ /**
608
+ * Insulation type if present.
609
+ */
610
+ export type InsulationType = OpenEnum<typeof InsulationType>;
611
+
612
+ /**
613
+ * Ground floor construction and insulation.
614
+ */
615
+ export type Floor = {
370
616
  /**
371
- * Number of open fireplaces (contributes to heat loss calculation)
617
+ * Non-null when source value was corrupted/incomplete.
372
618
  */
373
- numberOpenFireplaces: number | null;
619
+ dataQuality: DataQuality | null;
374
620
  /**
375
- * Percentage of energy demand met by photovoltaic panels (as a decimal, e.g. '25' for 25%)
621
+ * Raw SAP description string.
376
622
  */
377
- photoSupply: string | null;
623
+ description: string | null;
378
624
  /**
379
- * UK postcode with spaces removed (e.g. 'SW1A2AA'). Useful for exact postcode matching and grouping. This is the standard MHCLG field name.
625
+ * Energy efficiency rating.
380
626
  */
381
- postcodeNoSpace: string;
627
+ energyEfficiency: GetEpcByLocationIdEnergyEfficiency | null;
382
628
  /**
383
- * Potential energy efficiency SAP score after improvements (1-100)
629
+ * Environmental efficiency rating.
384
630
  */
385
- potentialEnergyEfficiency: number | null;
631
+ environmentalEfficiency: GetEpcByLocationIdEnvironmentalEfficiency | null;
386
632
  /**
387
- * Potential energy efficiency rating band after recommended improvements (A to G)
633
+ * Floor type: solid, suspended_timber, suspended_sealed, another_dwelling_below, other_premises_below.
388
634
  */
389
- potentialEnergyRating: string | null;
635
+ floorType: FloorType | null;
390
636
  /**
391
- * Property type classification (e.g. House, Flat, Bungalow, Maisonette, Park home)
637
+ * Whether insulation status is assumed.
392
638
  */
393
- propertyType: string | null;
639
+ insulationAssumed: boolean;
394
640
  /**
395
- * Address lines as recorded on the EPC certificate
641
+ * Whether floor insulation is present.
396
642
  */
397
- rawAddress: RawAddress;
643
+ insulationPresent: boolean | null;
398
644
  /**
399
- * Assessor's description of roof construction and insulation (e.g. 'Pitched, 250mm loft insulation')
645
+ * Insulation type if present.
400
646
  */
401
- roofDescription: string | null;
647
+ insulationType: InsulationType | null;
402
648
  /**
403
- * Roof energy efficiency rating: Very Good, Good, Average, Poor, or Very Poor
649
+ * U-value in W/m²K if reported.
404
650
  */
405
- roofEnergyEff: string | null;
651
+ thermalTransmittance: number | null;
652
+ };
653
+
654
+ /**
655
+ * Energy efficiency rating.
656
+ */
657
+ export const GetEPCByLocationIdEPCEnergyEfficiency = {
658
+ VeryGood: "very_good",
659
+ Good: "good",
660
+ Average: "average",
661
+ Poor: "poor",
662
+ VeryPoor: "very_poor",
663
+ } as const;
664
+ /**
665
+ * Energy efficiency rating.
666
+ */
667
+ export type GetEPCByLocationIdEPCEnergyEfficiency = OpenEnum<
668
+ typeof GetEPCByLocationIdEPCEnergyEfficiency
669
+ >;
670
+
671
+ /**
672
+ * Environmental efficiency rating.
673
+ */
674
+ export const GetEPCByLocationIdEPCEnvironmentalEfficiency = {
675
+ VeryGood: "very_good",
676
+ Good: "good",
677
+ Average: "average",
678
+ Poor: "poor",
679
+ VeryPoor: "very_poor",
680
+ } as const;
681
+ /**
682
+ * Environmental efficiency rating.
683
+ */
684
+ export type GetEPCByLocationIdEPCEnvironmentalEfficiency = OpenEnum<
685
+ typeof GetEPCByLocationIdEPCEnvironmentalEfficiency
686
+ >;
687
+
688
+ /**
689
+ * Heating control system.
690
+ */
691
+ export type HeatingControls = {
406
692
  /**
407
- * Roof environmental efficiency rating: Very Good, Good, Average, Poor, or Very Poor
693
+ * SAP description string from assessor.
408
694
  */
409
- roofEnvEff: string | null;
695
+ description: string | null;
410
696
  /**
411
- * Description of any secondary heating system (e.g. 'Room heaters, electric'). Null if none.
697
+ * Energy efficiency rating.
412
698
  */
413
- secondheatDescription: string | null;
699
+ energyEfficiency: GetEPCByLocationIdEPCEnergyEfficiency | null;
414
700
  /**
415
- * Secondary heating energy efficiency rating: Very Good, Good, Average, Poor, or Very Poor. Standard MHCLG field name.
701
+ * Environmental efficiency rating.
416
702
  */
417
- sheatingEnergyEff: string | null;
703
+ environmentalEfficiency: GetEPCByLocationIdEPCEnvironmentalEfficiency | null;
704
+ };
705
+
706
+ /**
707
+ * Energy efficiency rating.
708
+ */
709
+ export const GetEPCByLocationIdEPCResponseEnergyEfficiency = {
710
+ VeryGood: "very_good",
711
+ Good: "good",
712
+ Average: "average",
713
+ Poor: "poor",
714
+ VeryPoor: "very_poor",
715
+ } as const;
716
+ /**
717
+ * Energy efficiency rating.
718
+ */
719
+ export type GetEPCByLocationIdEPCResponseEnergyEfficiency = OpenEnum<
720
+ typeof GetEPCByLocationIdEPCResponseEnergyEfficiency
721
+ >;
722
+
723
+ /**
724
+ * Environmental efficiency rating.
725
+ */
726
+ export const GetEPCByLocationIdEPCResponseEnvironmentalEfficiency = {
727
+ VeryGood: "very_good",
728
+ Good: "good",
729
+ Average: "average",
730
+ Poor: "poor",
731
+ VeryPoor: "very_poor",
732
+ } as const;
733
+ /**
734
+ * Environmental efficiency rating.
735
+ */
736
+ export type GetEPCByLocationIdEPCResponseEnvironmentalEfficiency = OpenEnum<
737
+ typeof GetEPCByLocationIdEPCResponseEnvironmentalEfficiency
738
+ >;
739
+
740
+ /**
741
+ * Hot water system.
742
+ */
743
+ export type HotWater = {
418
744
  /**
419
- * Secondary heating environmental efficiency rating: Very Good, Good, Average, Poor, or Very Poor. Standard MHCLG field name.
745
+ * SAP description string from assessor.
420
746
  */
421
- sheatingEnvEff: string | null;
747
+ description: string | null;
422
748
  /**
423
- * Whether the property has solar water heating ('Y' or 'N')
749
+ * Energy efficiency rating.
424
750
  */
425
- solarWaterHeatingFlag: string | null;
751
+ energyEfficiency: GetEPCByLocationIdEPCResponseEnergyEfficiency | null;
426
752
  /**
427
- * EPC certificate type. domestic: residential property EPC. non-domestic: commercial or industrial property DEC/EPC. display: Display Energy Certificate for public buildings.
753
+ * Environmental efficiency rating.
428
754
  */
429
- source: string;
755
+ environmentalEfficiency:
756
+ | GetEPCByLocationIdEPCResponseEnvironmentalEfficiency
757
+ | null;
758
+ };
759
+
760
+ /**
761
+ * Energy efficiency rating.
762
+ */
763
+ export const GetEPCByLocationIdEPCResponse200EnergyEfficiency = {
764
+ VeryGood: "very_good",
765
+ Good: "good",
766
+ Average: "average",
767
+ Poor: "poor",
768
+ VeryPoor: "very_poor",
769
+ } as const;
770
+ /**
771
+ * Energy efficiency rating.
772
+ */
773
+ export type GetEPCByLocationIdEPCResponse200EnergyEfficiency = OpenEnum<
774
+ typeof GetEPCByLocationIdEPCResponse200EnergyEfficiency
775
+ >;
776
+
777
+ /**
778
+ * Environmental efficiency rating.
779
+ */
780
+ export const GetEPCByLocationIdEPCResponse200EnvironmentalEfficiency = {
781
+ VeryGood: "very_good",
782
+ Good: "good",
783
+ Average: "average",
784
+ Poor: "poor",
785
+ VeryPoor: "very_poor",
786
+ } as const;
787
+ /**
788
+ * Environmental efficiency rating.
789
+ */
790
+ export type GetEPCByLocationIdEPCResponse200EnvironmentalEfficiency = OpenEnum<
791
+ typeof GetEPCByLocationIdEPCResponse200EnvironmentalEfficiency
792
+ >;
793
+
794
+ /**
795
+ * Lighting system.
796
+ */
797
+ export type Lighting = {
430
798
  /**
431
- * Tenure type at the time of assessment (e.g. Owner-occupied, Rented (social), Rented (private))
799
+ * SAP description string from assessor.
432
800
  */
433
- tenure: string | null;
801
+ description: string | null;
434
802
  /**
435
- * Total internal floor area in square metres, as measured during the EPC assessment
803
+ * Energy efficiency rating.
436
804
  */
437
- totalFloorArea: number | null;
805
+ energyEfficiency: GetEPCByLocationIdEPCResponse200EnergyEfficiency | null;
438
806
  /**
439
- * Transaction context for the EPC assessment (e.g. 'marketed sale', 'rental', 'new dwelling', 'non sale')
807
+ * Environmental efficiency rating.
440
808
  */
441
- transactionType: string | null;
442
- /**
443
- * Length of unheated corridor in metres (used in heat loss calculation for flats)
809
+ environmentalEfficiency:
810
+ | GetEPCByLocationIdEPCResponse200EnvironmentalEfficiency
811
+ | null;
812
+ };
813
+
814
+ /**
815
+ * Non-null when source value was corrupted/incomplete.
816
+ */
817
+ export const GetEpcByLocationIdDataQuality = {
818
+ TruncatedThermalTransmittance: "truncated_thermal_transmittance",
819
+ QualityLabelOnly: "quality_label_only",
820
+ WelshLanguage: "welsh_language",
821
+ CorruptedEncoding: "corrupted_encoding",
822
+ SourceError: "source_error",
823
+ } as const;
824
+ /**
825
+ * Non-null when source value was corrupted/incomplete.
826
+ */
827
+ export type GetEpcByLocationIdDataQuality = OpenEnum<
828
+ typeof GetEpcByLocationIdDataQuality
829
+ >;
830
+
831
+ /**
832
+ * Energy efficiency rating.
833
+ */
834
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONEnergyEfficiency = {
835
+ VeryGood: "very_good",
836
+ Good: "good",
837
+ Average: "average",
838
+ Poor: "poor",
839
+ VeryPoor: "very_poor",
840
+ } as const;
841
+ /**
842
+ * Energy efficiency rating.
843
+ */
844
+ export type GetEPCByLocationIdEPCResponse200ApplicationJSONEnergyEfficiency =
845
+ OpenEnum<
846
+ typeof GetEPCByLocationIdEPCResponse200ApplicationJSONEnergyEfficiency
847
+ >;
848
+
849
+ /**
850
+ * Environmental efficiency rating.
851
+ */
852
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONEnvironmentalEfficiency =
853
+ {
854
+ VeryGood: "very_good",
855
+ Good: "good",
856
+ Average: "average",
857
+ Poor: "poor",
858
+ VeryPoor: "very_poor",
859
+ } as const;
860
+ /**
861
+ * Environmental efficiency rating.
862
+ */
863
+ export type GetEPCByLocationIdEPCResponse200ApplicationJSONEnvironmentalEfficiency =
864
+ OpenEnum<
865
+ typeof GetEPCByLocationIdEPCResponse200ApplicationJSONEnvironmentalEfficiency
866
+ >;
867
+
868
+ /**
869
+ * Fuel type for this heating system.
870
+ */
871
+ export const Fuel = {
872
+ MainsGas: "mains_gas",
873
+ Lpg: "lpg",
874
+ Oil: "oil",
875
+ Electricity: "electricity",
876
+ Biomass: "biomass",
877
+ Coal: "coal",
878
+ Anthracite: "anthracite",
879
+ SmokelessFuel: "smokeless_fuel",
880
+ Biogas: "biogas",
881
+ DistrictHeating: "district_heating",
882
+ HeatPump: "heat_pump",
883
+ DualFuel: "dual_fuel",
884
+ WasteHeat: "waste_heat",
885
+ Other: "other",
886
+ } as const;
887
+ /**
888
+ * Fuel type for this heating system.
889
+ */
890
+ export type Fuel = OpenEnum<typeof Fuel>;
891
+
892
+ /**
893
+ * Heat pump type if applicable: air_source, ground_source, water_source.
894
+ */
895
+ export const HeatPumpType = {
896
+ AirSource: "air_source",
897
+ GroundSource: "ground_source",
898
+ WaterSource: "water_source",
899
+ } as const;
900
+ /**
901
+ * Heat pump type if applicable: air_source, ground_source, water_source.
902
+ */
903
+ export type HeatPumpType = OpenEnum<typeof HeatPumpType>;
904
+
905
+ /**
906
+ * Heating system type: boiler_radiators, storage_heaters, heat_pump_radiators, etc.
907
+ */
908
+ export const SystemType = {
909
+ BoilerRadiators: "boiler_radiators",
910
+ BoilerUnderfloor: "boiler_underfloor",
911
+ StorageHeaters: "storage_heaters",
912
+ RoomHeaters: "room_heaters",
913
+ WarmAir: "warm_air",
914
+ HeatPumpRadiators: "heat_pump_radiators",
915
+ HeatPumpUnderfloor: "heat_pump_underfloor",
916
+ UnderfloorElectric: "underfloor_electric",
917
+ CommunityScheme: "community_scheme",
918
+ MicroChp: "micro_chp",
919
+ NoneAssumed: "none_assumed",
920
+ } as const;
921
+ /**
922
+ * Heating system type: boiler_radiators, storage_heaters, heat_pump_radiators, etc.
923
+ */
924
+ export type SystemType = OpenEnum<typeof SystemType>;
925
+
926
+ /**
927
+ * Main heating system.
928
+ */
929
+ export type MainHeating = {
930
+ /**
931
+ * Non-null when source value was corrupted/incomplete.
444
932
  */
445
- unheatedCorridorLength: number | null;
933
+ dataQuality: GetEpcByLocationIdDataQuality | null;
446
934
  /**
447
- * Timestamp when this record was last updated in our system (ISO 8601 format)
935
+ * Raw SAP description string.
448
936
  */
449
- updatedAt: string;
937
+ description: string | null;
938
+ /**
939
+ * Energy efficiency rating.
940
+ */
941
+ energyEfficiency:
942
+ | GetEPCByLocationIdEPCResponse200ApplicationJSONEnergyEfficiency
943
+ | null;
944
+ /**
945
+ * Environmental efficiency rating.
946
+ */
947
+ environmentalEfficiency:
948
+ | GetEPCByLocationIdEPCResponse200ApplicationJSONEnvironmentalEfficiency
949
+ | null;
950
+ /**
951
+ * Fuel type for this heating system.
952
+ */
953
+ fuel: Fuel | null;
954
+ /**
955
+ * Heat pump type if applicable: air_source, ground_source, water_source.
956
+ */
957
+ heatPumpType: HeatPumpType | null;
958
+ /**
959
+ * Whether this property has multiple heating systems.
960
+ */
961
+ isMultiSystem: boolean;
962
+ /**
963
+ * Heating system type: boiler_radiators, storage_heaters, heat_pump_radiators, etc.
964
+ */
965
+ systemType: SystemType | null;
966
+ };
967
+
968
+ /**
969
+ * Non-null when source value was corrupted/incomplete.
970
+ */
971
+ export const GetEPCByLocationIdEPCDataQuality = {
972
+ TruncatedThermalTransmittance: "truncated_thermal_transmittance",
973
+ QualityLabelOnly: "quality_label_only",
974
+ WelshLanguage: "welsh_language",
975
+ CorruptedEncoding: "corrupted_encoding",
976
+ SourceError: "source_error",
977
+ } as const;
978
+ /**
979
+ * Non-null when source value was corrupted/incomplete.
980
+ */
981
+ export type GetEPCByLocationIdEPCDataQuality = OpenEnum<
982
+ typeof GetEPCByLocationIdEPCDataQuality
983
+ >;
984
+
985
+ /**
986
+ * Energy efficiency rating.
987
+ */
988
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnergyEfficiency =
989
+ {
990
+ VeryGood: "very_good",
991
+ Good: "good",
992
+ Average: "average",
993
+ Poor: "poor",
994
+ VeryPoor: "very_poor",
995
+ } as const;
996
+ /**
997
+ * Energy efficiency rating.
998
+ */
999
+ export type GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnergyEfficiency =
1000
+ OpenEnum<
1001
+ typeof GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnergyEfficiency
1002
+ >;
1003
+
1004
+ /**
1005
+ * Environmental efficiency rating.
1006
+ */
1007
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnvironmentalEfficiency =
1008
+ {
1009
+ VeryGood: "very_good",
1010
+ Good: "good",
1011
+ Average: "average",
1012
+ Poor: "poor",
1013
+ VeryPoor: "very_poor",
1014
+ } as const;
1015
+ /**
1016
+ * Environmental efficiency rating.
1017
+ */
1018
+ export type GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnvironmentalEfficiency =
1019
+ OpenEnum<
1020
+ typeof GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnvironmentalEfficiency
1021
+ >;
1022
+
1023
+ /**
1024
+ * Insulation type: loft, rafter, none, etc.
1025
+ */
1026
+ export const GetEpcByLocationIdInsulationType = {
1027
+ None: "none",
1028
+ AsBuilt: "as_built",
1029
+ FilledCavity: "filled_cavity",
1030
+ External: "external",
1031
+ Internal: "internal",
1032
+ FilledCavityAndExternal: "filled_cavity_and_external",
1033
+ FilledCavityAndInternal: "filled_cavity_and_internal",
1034
+ Partial: "partial",
1035
+ RetroFitted: "retro_fitted",
1036
+ Loft: "loft",
1037
+ Rafter: "rafter",
1038
+ } as const;
1039
+ /**
1040
+ * Insulation type: loft, rafter, none, etc.
1041
+ */
1042
+ export type GetEpcByLocationIdInsulationType = OpenEnum<
1043
+ typeof GetEpcByLocationIdInsulationType
1044
+ >;
1045
+
1046
+ /**
1047
+ * Roof type: pitched, flat, thatched, another_dwelling_above, other_premises_above, roof_room.
1048
+ */
1049
+ export const RoofType = {
1050
+ Pitched: "pitched",
1051
+ Flat: "flat",
1052
+ Thatched: "thatched",
1053
+ AnotherDwellingAbove: "another_dwelling_above",
1054
+ OtherPremisesAbove: "other_premises_above",
1055
+ RoofRoom: "roof_room",
1056
+ } as const;
1057
+ /**
1058
+ * Roof type: pitched, flat, thatched, another_dwelling_above, other_premises_above, roof_room.
1059
+ */
1060
+ export type RoofType = OpenEnum<typeof RoofType>;
1061
+
1062
+ /**
1063
+ * Roof construction and insulation.
1064
+ */
1065
+ export type Roof = {
1066
+ /**
1067
+ * Non-null when source value was corrupted/incomplete.
1068
+ */
1069
+ dataQuality: GetEPCByLocationIdEPCDataQuality | null;
1070
+ /**
1071
+ * Raw SAP description string.
1072
+ */
1073
+ description: string | null;
1074
+ /**
1075
+ * Energy efficiency rating.
1076
+ */
1077
+ energyEfficiency:
1078
+ | GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnergyEfficiency
1079
+ | null;
1080
+ /**
1081
+ * Environmental efficiency rating.
1082
+ */
1083
+ environmentalEfficiency:
1084
+ | GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnvironmentalEfficiency
1085
+ | null;
1086
+ /**
1087
+ * Whether insulation status is assumed.
1088
+ */
1089
+ insulationAssumed: boolean;
1090
+ /**
1091
+ * Loft insulation depth in millimetres.
1092
+ */
1093
+ insulationDepthMm: number | null;
1094
+ /**
1095
+ * Whether roof insulation is present.
1096
+ */
1097
+ insulationPresent: boolean | null;
1098
+ /**
1099
+ * Insulation type: loft, rafter, none, etc.
1100
+ */
1101
+ insulationType: GetEpcByLocationIdInsulationType | null;
1102
+ /**
1103
+ * Roof type: pitched, flat, thatched, another_dwelling_above, other_premises_above, roof_room.
1104
+ */
1105
+ roofType: RoofType | null;
1106
+ /**
1107
+ * U-value in W/m²K if reported.
1108
+ */
1109
+ thermalTransmittance: number | null;
1110
+ };
1111
+
1112
+ /**
1113
+ * Energy efficiency rating.
1114
+ */
1115
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnergyEfficiency =
1116
+ {
1117
+ VeryGood: "very_good",
1118
+ Good: "good",
1119
+ Average: "average",
1120
+ Poor: "poor",
1121
+ VeryPoor: "very_poor",
1122
+ } as const;
1123
+ /**
1124
+ * Energy efficiency rating.
1125
+ */
1126
+ export type GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnergyEfficiency =
1127
+ OpenEnum<
1128
+ typeof GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnergyEfficiency
1129
+ >;
1130
+
1131
+ /**
1132
+ * Environmental efficiency rating.
1133
+ */
1134
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnvironmentalEfficiency =
1135
+ {
1136
+ VeryGood: "very_good",
1137
+ Good: "good",
1138
+ Average: "average",
1139
+ Poor: "poor",
1140
+ VeryPoor: "very_poor",
1141
+ } as const;
1142
+ /**
1143
+ * Environmental efficiency rating.
1144
+ */
1145
+ export type GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnvironmentalEfficiency =
1146
+ OpenEnum<
1147
+ typeof GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnvironmentalEfficiency
1148
+ >;
1149
+
1150
+ /**
1151
+ * Secondary heating system. Null when no secondary heating is present.
1152
+ */
1153
+ export type SecondaryHeating = {
1154
+ /**
1155
+ * SAP description string from assessor.
1156
+ */
1157
+ description: string | null;
1158
+ /**
1159
+ * Energy efficiency rating.
1160
+ */
1161
+ energyEfficiency:
1162
+ | GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnergyEfficiency
1163
+ | null;
1164
+ /**
1165
+ * Environmental efficiency rating.
1166
+ */
1167
+ environmentalEfficiency:
1168
+ | GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnvironmentalEfficiency
1169
+ | null;
1170
+ };
1171
+
1172
+ /**
1173
+ * Wall construction type: cavity, solid_brick, timber_frame, sandstone_or_limestone, etc.
1174
+ */
1175
+ export const Construction = {
1176
+ Cavity: "cavity",
1177
+ SolidBrick: "solid_brick",
1178
+ TimberFrame: "timber_frame",
1179
+ SandstoneOrLimestone: "sandstone_or_limestone",
1180
+ Sandstone: "sandstone",
1181
+ GraniteOrWhinstone: "granite_or_whinstone",
1182
+ Granite: "granite",
1183
+ SystemBuilt: "system_built",
1184
+ SolidStone: "solid_stone",
1185
+ Cob: "cob",
1186
+ ParkHome: "park_home",
1187
+ Basement: "basement",
1188
+ CurtainWall: "curtain_wall",
1189
+ } as const;
1190
+ /**
1191
+ * Wall construction type: cavity, solid_brick, timber_frame, sandstone_or_limestone, etc.
1192
+ */
1193
+ export type Construction = OpenEnum<typeof Construction>;
1194
+
1195
+ /**
1196
+ * Non-null when the source value was corrupted/incomplete. Null = normal quality.
1197
+ */
1198
+ export const GetEPCByLocationIdEPCResponseDataQuality = {
1199
+ TruncatedThermalTransmittance: "truncated_thermal_transmittance",
1200
+ QualityLabelOnly: "quality_label_only",
1201
+ WelshLanguage: "welsh_language",
1202
+ CorruptedEncoding: "corrupted_encoding",
1203
+ SourceError: "source_error",
1204
+ } as const;
1205
+ /**
1206
+ * Non-null when the source value was corrupted/incomplete. Null = normal quality.
1207
+ */
1208
+ export type GetEPCByLocationIdEPCResponseDataQuality = OpenEnum<
1209
+ typeof GetEPCByLocationIdEPCResponseDataQuality
1210
+ >;
1211
+
1212
+ /**
1213
+ * Energy efficiency rating.
1214
+ */
1215
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnergyEfficiency =
1216
+ {
1217
+ VeryGood: "very_good",
1218
+ Good: "good",
1219
+ Average: "average",
1220
+ Poor: "poor",
1221
+ VeryPoor: "very_poor",
1222
+ } as const;
1223
+ /**
1224
+ * Energy efficiency rating.
1225
+ */
1226
+ export type GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnergyEfficiency =
1227
+ OpenEnum<
1228
+ typeof GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnergyEfficiency
1229
+ >;
1230
+
1231
+ /**
1232
+ * Environmental efficiency rating.
1233
+ */
1234
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnvironmentalEfficiency =
1235
+ {
1236
+ VeryGood: "very_good",
1237
+ Good: "good",
1238
+ Average: "average",
1239
+ Poor: "poor",
1240
+ VeryPoor: "very_poor",
1241
+ } as const;
1242
+ /**
1243
+ * Environmental efficiency rating.
1244
+ */
1245
+ export type GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnvironmentalEfficiency =
1246
+ OpenEnum<
1247
+ typeof GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnvironmentalEfficiency
1248
+ >;
1249
+
1250
+ /**
1251
+ * Insulation type: none, filled_cavity, external, internal, as_built, partial, etc.
1252
+ */
1253
+ export const GetEPCByLocationIdEPCInsulationType = {
1254
+ None: "none",
1255
+ AsBuilt: "as_built",
1256
+ FilledCavity: "filled_cavity",
1257
+ External: "external",
1258
+ Internal: "internal",
1259
+ FilledCavityAndExternal: "filled_cavity_and_external",
1260
+ FilledCavityAndInternal: "filled_cavity_and_internal",
1261
+ Partial: "partial",
1262
+ RetroFitted: "retro_fitted",
1263
+ Loft: "loft",
1264
+ Rafter: "rafter",
1265
+ } as const;
1266
+ /**
1267
+ * Insulation type: none, filled_cavity, external, internal, as_built, partial, etc.
1268
+ */
1269
+ export type GetEPCByLocationIdEPCInsulationType = OpenEnum<
1270
+ typeof GetEPCByLocationIdEPCInsulationType
1271
+ >;
1272
+
1273
+ /**
1274
+ * External wall construction and insulation.
1275
+ */
1276
+ export type Walls = {
1277
+ /**
1278
+ * Wall construction type: cavity, solid_brick, timber_frame, sandstone_or_limestone, etc.
1279
+ */
1280
+ construction: Construction | null;
1281
+ /**
1282
+ * Non-null when the source value was corrupted/incomplete. Null = normal quality.
1283
+ */
1284
+ dataQuality: GetEPCByLocationIdEPCResponseDataQuality | null;
1285
+ /**
1286
+ * Raw SAP description string from assessor.
1287
+ */
1288
+ description: string | null;
1289
+ /**
1290
+ * Energy efficiency rating.
1291
+ */
1292
+ energyEfficiency:
1293
+ | GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnergyEfficiency
1294
+ | null;
1295
+ /**
1296
+ * Environmental efficiency rating.
1297
+ */
1298
+ environmentalEfficiency:
1299
+ | GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnvironmentalEfficiency
1300
+ | null;
1301
+ /**
1302
+ * Whether insulation status is assumed by the assessor (true) or confirmed (false).
1303
+ */
1304
+ insulationAssumed: boolean;
1305
+ /**
1306
+ * Whether wall insulation is present.
1307
+ */
1308
+ insulationPresent: boolean | null;
1309
+ /**
1310
+ * Insulation type: none, filled_cavity, external, internal, as_built, partial, etc.
1311
+ */
1312
+ insulationType: GetEPCByLocationIdEPCInsulationType | null;
1313
+ /**
1314
+ * Wall material (e.g. 'brick') where identifiable from description.
1315
+ */
1316
+ material: string | null;
1317
+ /**
1318
+ * U-value in W/m²K if reported. Newer SAP versions report this instead of description text.
1319
+ */
1320
+ thermalTransmittance: number | null;
1321
+ };
1322
+
1323
+ /**
1324
+ * Energy efficiency rating.
1325
+ */
1326
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnergyEfficiency =
1327
+ {
1328
+ VeryGood: "very_good",
1329
+ Good: "good",
1330
+ Average: "average",
1331
+ Poor: "poor",
1332
+ VeryPoor: "very_poor",
1333
+ } as const;
1334
+ /**
1335
+ * Energy efficiency rating.
1336
+ */
1337
+ export type GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnergyEfficiency =
1338
+ OpenEnum<
1339
+ typeof GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnergyEfficiency
1340
+ >;
1341
+
1342
+ /**
1343
+ * Environmental efficiency rating.
1344
+ */
1345
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnvironmentalEfficiency =
1346
+ {
1347
+ VeryGood: "very_good",
1348
+ Good: "good",
1349
+ Average: "average",
1350
+ Poor: "poor",
1351
+ VeryPoor: "very_poor",
1352
+ } as const;
1353
+ /**
1354
+ * Environmental efficiency rating.
1355
+ */
1356
+ export type GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnvironmentalEfficiency =
1357
+ OpenEnum<
1358
+ typeof GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnvironmentalEfficiency
1359
+ >;
1360
+
1361
+ /**
1362
+ * Window glazing specification.
1363
+ */
1364
+ export type Windows = {
1365
+ /**
1366
+ * SAP description string from assessor.
1367
+ */
1368
+ description: string | null;
1369
+ /**
1370
+ * Energy efficiency rating.
1371
+ */
1372
+ energyEfficiency:
1373
+ | GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnergyEfficiency
1374
+ | null;
1375
+ /**
1376
+ * Environmental efficiency rating.
1377
+ */
1378
+ environmentalEfficiency:
1379
+ | GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnvironmentalEfficiency
1380
+ | null;
1381
+ };
1382
+
1383
+ /**
1384
+ * Component-level building fabric assessment. Domestic only; null for non-domestic and DECs.
1385
+ */
1386
+ export type Fabric = {
1387
+ /**
1388
+ * Air tightness assessment. Scotland only; null for E&W.
1389
+ */
1390
+ airTightness: AirTightness | null;
1391
+ /**
1392
+ * Ground floor construction and insulation.
1393
+ */
1394
+ floor: Floor;
1395
+ /**
1396
+ * Heating control system.
1397
+ */
1398
+ heatingControls: HeatingControls;
1399
+ /**
1400
+ * Hot water system.
1401
+ */
1402
+ hotWater: HotWater;
1403
+ /**
1404
+ * Lighting system.
1405
+ */
1406
+ lighting: Lighting;
1407
+ /**
1408
+ * Main heating system.
1409
+ */
1410
+ mainHeating: MainHeating;
1411
+ /**
1412
+ * Roof construction and insulation.
1413
+ */
1414
+ roof: Roof;
450
1415
  /**
451
- * Assessor's description of wall construction and insulation (e.g. 'Cavity wall, filled cavity')
1416
+ * Secondary heating system. Null when no secondary heating is present.
452
1417
  */
453
- wallsDescription: string | null;
1418
+ secondaryHeating: SecondaryHeating | null;
454
1419
  /**
455
- * Walls energy efficiency rating: Very Good, Good, Average, Poor, or Very Poor
1420
+ * External wall construction and insulation.
456
1421
  */
457
- wallsEnergyEff: string | null;
1422
+ walls: Walls;
458
1423
  /**
459
- * Walls environmental efficiency rating: Very Good, Good, Average, Poor, or Very Poor
1424
+ * Window glazing specification.
460
1425
  */
461
- wallsEnvEff: string | null;
1426
+ windows: Windows;
1427
+ };
1428
+
1429
+ /**
1430
+ * Derived MEES compliance status (Decision D11). Based on current energy rating band and certificate type. compliant=A-E, at_risk=E, non_compliant=F-G, exempt=non-domestic/DEC.
1431
+ */
1432
+ export const MeesCompliance = {
1433
+ Compliant: "compliant",
1434
+ AtRisk: "at_risk",
1435
+ NonCompliant: "non_compliant",
1436
+ Exempt: "exempt",
1437
+ Unknown: "unknown",
1438
+ } as const;
1439
+ /**
1440
+ * Derived MEES compliance status (Decision D11). Based on current energy rating band and certificate type. compliant=A-E, at_risk=E, non_compliant=F-G, exempt=non-domestic/DEC.
1441
+ */
1442
+ export type MeesCompliance = OpenEnum<typeof MeesCompliance>;
1443
+
1444
+ export const BuildingCategory = {
1445
+ C1: "C1",
1446
+ C2: "C2",
1447
+ C3: "C3",
1448
+ C4: "C4",
1449
+ C5: "C5",
1450
+ C6: "C6",
1451
+ H1: "H1",
1452
+ H2: "H2",
1453
+ H3: "H3",
1454
+ H4: "H4",
1455
+ H5: "H5",
1456
+ H6: "H6",
1457
+ H7: "H7",
1458
+ H8: "H8",
1459
+ S1: "S1",
1460
+ S2: "S2",
1461
+ S3: "S3",
1462
+ S4: "S4",
1463
+ S5: "S5",
1464
+ S6: "S6",
1465
+ S7: "S7",
1466
+ S8: "S8",
1467
+ S9: "S9",
1468
+ S10: "S10",
1469
+ W1: "W1",
1470
+ W2: "W2",
1471
+ W3: "W3",
1472
+ W4: "W4",
1473
+ W5: "W5",
1474
+ } as const;
1475
+ export type BuildingCategory = OpenEnum<typeof BuildingCategory>;
1476
+
1477
+ /**
1478
+ * Electrical usage — actual vs benchmark.
1479
+ */
1480
+ export type ElectricalUsage = {
462
1481
  /**
463
- * Number of wind turbines installed at the property
1482
+ * Actual annual electrical consumption (kWh/m²/year).
464
1483
  */
465
- windTurbineCount: number | null;
1484
+ actual: number;
466
1485
  /**
467
- * Assessor's description of window glazing (e.g. 'Fully double glazed')
1486
+ * Benchmark electrical consumption (kWh/m²/year).
468
1487
  */
469
- windowsDescription: string | null;
1488
+ typical: number;
1489
+ };
1490
+
1491
+ /**
1492
+ * Operational rating band (A-G, no A+).
1493
+ */
1494
+ export const RatingBand = {
1495
+ APlus: "A+",
1496
+ A: "A",
1497
+ BPlus: "B+",
1498
+ B: "B",
1499
+ CPlus: "C+",
1500
+ C: "C",
1501
+ DPlus: "D+",
1502
+ D: "D",
1503
+ EPlus: "E+",
1504
+ E: "E",
1505
+ FPlus: "F+",
1506
+ F: "F",
1507
+ G: "G",
1508
+ } as const;
1509
+ /**
1510
+ * Operational rating band (A-G, no A+).
1511
+ */
1512
+ export type RatingBand = OpenEnum<typeof RatingBand>;
1513
+
1514
+ /**
1515
+ * Thermal fuel usage — actual vs benchmark.
1516
+ */
1517
+ export type ThermalUsage = {
470
1518
  /**
471
- * Windows energy efficiency rating: Very Good, Good, Average, Poor, or Very Poor
1519
+ * Actual annual thermal fuel consumption (kWh/m²/year).
472
1520
  */
473
- windowsEnergyEff: string | null;
1521
+ actual: number;
474
1522
  /**
475
- * Windows environmental efficiency rating: Very Good, Good, Average, Poor, or Very Poor
1523
+ * Benchmark thermal fuel consumption (kWh/m²/year).
476
1524
  */
477
- windowsEnvEff: string | null;
1525
+ typical: number;
478
1526
  };
479
1527
 
480
- export const GetEpcByLocationIdObject = {
481
- List: "list",
482
- } as const;
483
- export type GetEpcByLocationIdObject = ClosedEnum<
484
- typeof GetEpcByLocationIdObject
485
- >;
1528
+ /**
1529
+ * DEC operational performance from metered energy use. Null for domestic and non-domestic EPCs.
1530
+ */
1531
+ export type OperationalPerformance = {
1532
+ /**
1533
+ * End of the 12-month assessment period (ISO 8601).
1534
+ */
1535
+ assessmentEndDate: string | null;
1536
+ /**
1537
+ * CIBSE TM46 benchmark category codes. Multi-use buildings can have multiple codes.
1538
+ */
1539
+ buildingCategory: Array<BuildingCategory>;
1540
+ /**
1541
+ * Current year operational rating — CO2 efficiency relative to benchmark. 100 = typical for building type. Lower is better. 9999 = placeholder/incomplete.
1542
+ */
1543
+ currentRating: number;
1544
+ /**
1545
+ * Electrical usage — actual vs benchmark.
1546
+ */
1547
+ electricalUsage: ElectricalUsage | null;
1548
+ /**
1549
+ * Primary benchmark category description (e.g. 'General Office', 'Hospital — Clinical and Research').
1550
+ */
1551
+ mainBenchmark: string | null;
1552
+ /**
1553
+ * Assessor-selected reference date (ISO 8601).
1554
+ */
1555
+ nominatedDate: string | null;
1556
+ /**
1557
+ * Building occupancy during operating hours.
1558
+ */
1559
+ occupancyLevel: string | null;
1560
+ /**
1561
+ * Operational rating band (A-G, no A+).
1562
+ */
1563
+ ratingBand: RatingBand;
1564
+ /**
1565
+ * Percentage of electricity from renewable sources.
1566
+ */
1567
+ renewablesElectricalPercentage: number | null;
1568
+ /**
1569
+ * Percentage of heating from renewable sources.
1570
+ */
1571
+ renewablesThermalPercentage: number | null;
1572
+ /**
1573
+ * Thermal fuel usage — actual vs benchmark.
1574
+ */
1575
+ thermalUsage: ThermalUsage | null;
1576
+ /**
1577
+ * Previous year operational rating.
1578
+ */
1579
+ yr1Rating: number | null;
1580
+ /**
1581
+ * Two years ago operational rating.
1582
+ */
1583
+ yr2Rating: number | null;
1584
+ };
1585
+
1586
+ /**
1587
+ * Energy efficiency band. A/A+ is most efficient, G is least. Domestic uses A-G. Non-domestic uses A+-G. Scotland non-domestic also has half-bands (B+, C+, etc.).
1588
+ */
1589
+ export const Band = {
1590
+ APlus: "A+",
1591
+ A: "A",
1592
+ BPlus: "B+",
1593
+ B: "B",
1594
+ CPlus: "C+",
1595
+ C: "C",
1596
+ DPlus: "D+",
1597
+ D: "D",
1598
+ EPlus: "E+",
1599
+ E: "E",
1600
+ FPlus: "F+",
1601
+ F: "F",
1602
+ G: "G",
1603
+ } as const;
1604
+ /**
1605
+ * Energy efficiency band. A/A+ is most efficient, G is least. Domestic uses A-G. Non-domestic uses A+-G. Scotland non-domestic also has half-bands (B+, C+, etc.).
1606
+ */
1607
+ export type Band = OpenEnum<typeof Band>;
1608
+
1609
+ /**
1610
+ * Discriminator for numeric score interpretation.
1611
+ */
1612
+ export const ScoreType = {
1613
+ Sap: "sap",
1614
+ Asset: "asset",
1615
+ Operational: "operational",
1616
+ Epi: "epi",
1617
+ } as const;
1618
+ /**
1619
+ * Discriminator for numeric score interpretation.
1620
+ */
1621
+ export type ScoreType = OpenEnum<typeof ScoreType>;
1622
+
1623
+ /**
1624
+ * Current energy rating at time of assessment.
1625
+ */
1626
+ export type Current = {
1627
+ /**
1628
+ * Energy efficiency band. A/A+ is most efficient, G is least. Domestic uses A-G. Non-domestic uses A+-G. Scotland non-domestic also has half-bands (B+, C+, etc.).
1629
+ */
1630
+ band: Band;
1631
+ /**
1632
+ * Numeric score. Interpretation depends on scoreType: SAP = 1-100 (higher is better); Asset = kg CO2/m² (lower is better, unbounded); Operational = relative to benchmark (lower is better, unbounded); EPI = kg CO2/m² using Scottish weather data.
1633
+ */
1634
+ score: number;
1635
+ /**
1636
+ * Discriminator for numeric score interpretation.
1637
+ */
1638
+ scoreType: ScoreType;
1639
+ };
1640
+
1641
+ /**
1642
+ * Energy efficiency band. A/A+ is most efficient, G is least. Domestic uses A-G. Non-domestic uses A+-G. Scotland non-domestic also has half-bands (B+, C+, etc.).
1643
+ */
1644
+ export const GetEpcByLocationIdBand = {
1645
+ APlus: "A+",
1646
+ A: "A",
1647
+ BPlus: "B+",
1648
+ B: "B",
1649
+ CPlus: "C+",
1650
+ C: "C",
1651
+ DPlus: "D+",
1652
+ D: "D",
1653
+ EPlus: "E+",
1654
+ E: "E",
1655
+ FPlus: "F+",
1656
+ F: "F",
1657
+ G: "G",
1658
+ } as const;
1659
+ /**
1660
+ * Energy efficiency band. A/A+ is most efficient, G is least. Domestic uses A-G. Non-domestic uses A+-G. Scotland non-domestic also has half-bands (B+, C+, etc.).
1661
+ */
1662
+ export type GetEpcByLocationIdBand = OpenEnum<typeof GetEpcByLocationIdBand>;
1663
+
1664
+ /**
1665
+ * Discriminator for numeric score interpretation.
1666
+ */
1667
+ export const GetEpcByLocationIdScoreType = {
1668
+ Sap: "sap",
1669
+ Asset: "asset",
1670
+ Operational: "operational",
1671
+ Epi: "epi",
1672
+ } as const;
1673
+ /**
1674
+ * Discriminator for numeric score interpretation.
1675
+ */
1676
+ export type GetEpcByLocationIdScoreType = OpenEnum<
1677
+ typeof GetEpcByLocationIdScoreType
1678
+ >;
1679
+
1680
+ /**
1681
+ * Achievable rating with recommended improvements. Null for DECs (operational ratings have no potential). E&W non-domestic does not publish a potential rating; Scotland non-domestic does.
1682
+ */
1683
+ export type Potential = {
1684
+ /**
1685
+ * Energy efficiency band. A/A+ is most efficient, G is least. Domestic uses A-G. Non-domestic uses A+-G. Scotland non-domestic also has half-bands (B+, C+, etc.).
1686
+ */
1687
+ band: GetEpcByLocationIdBand;
1688
+ /**
1689
+ * Numeric score. Interpretation depends on scoreType: SAP = 1-100 (higher is better); Asset = kg CO2/m² (lower is better, unbounded); Operational = relative to benchmark (lower is better, unbounded); EPI = kg CO2/m² using Scottish weather data.
1690
+ */
1691
+ score: number;
1692
+ /**
1693
+ * Discriminator for numeric score interpretation.
1694
+ */
1695
+ scoreType: GetEpcByLocationIdScoreType;
1696
+ };
1697
+
1698
+ /**
1699
+ * Energy rating — unified across domestic (SAP), non-domestic (asset), and DEC (operational). Filter on rating.current.band for cross-type comparisons.
1700
+ */
1701
+ export type Rating = {
1702
+ /**
1703
+ * Whether the building achieves net-zero carbon. Scotland non-domestic uses 'Carbon Neu' band; mapped to A+ with this flag set to true.
1704
+ */
1705
+ carbonNeutral: boolean;
1706
+ /**
1707
+ * Current energy rating at time of assessment.
1708
+ */
1709
+ current: Current;
1710
+ /**
1711
+ * Achievable rating with recommended improvements. Null for DECs (operational ratings have no potential). E&W non-domestic does not publish a potential rating; Scotland non-domestic does.
1712
+ */
1713
+ potential: Potential | null;
1714
+ };
1715
+
1716
+ /**
1717
+ * Measure category: insulation, glazing, heating, hot_water, renewables, lighting.
1718
+ */
1719
+ export const GetEpcByLocationIdCategory = {
1720
+ Insulation: "insulation",
1721
+ Glazing: "glazing",
1722
+ Heating: "heating",
1723
+ HotWater: "hot_water",
1724
+ Renewables: "renewables",
1725
+ Lighting: "lighting",
1726
+ } as const;
1727
+ /**
1728
+ * Measure category: insulation, glazing, heating, hot_water, renewables, lighting.
1729
+ */
1730
+ export type GetEpcByLocationIdCategory = OpenEnum<
1731
+ typeof GetEpcByLocationIdCategory
1732
+ >;
1733
+
1734
+ /**
1735
+ * CO2 reduction impact. Scotland non-domestic only: low, medium, high.
1736
+ */
1737
+ export const Co2Impact = {
1738
+ Low: "low",
1739
+ Medium: "medium",
1740
+ High: "high",
1741
+ } as const;
1742
+ /**
1743
+ * CO2 reduction impact. Scotland non-domestic only: low, medium, high.
1744
+ */
1745
+ export type Co2Impact = OpenEnum<typeof Co2Impact>;
1746
+
1747
+ /**
1748
+ * Currency. All values normalised to GBP.
1749
+ */
1750
+ export const Currency = {
1751
+ Gbp: "GBP",
1752
+ } as const;
1753
+ /**
1754
+ * Currency. All values normalised to GBP.
1755
+ */
1756
+ export type Currency = ClosedEnum<typeof Currency>;
1757
+
1758
+ /**
1759
+ * Structured cost estimate with numeric min/max in GBP. Parsed from 1,054 unique source cost strings (including encoding variants). Use cost.year to apply your own inflation adjustment.
1760
+ */
1761
+ export type Cost = {
1762
+ /**
1763
+ * Currency. All values normalised to GBP.
1764
+ */
1765
+ currency: Currency;
1766
+ /**
1767
+ * Raw cost string from source (e.g. '£100 - £350'). Preserved for transparency.
1768
+ */
1769
+ indicative: string | null;
1770
+ /**
1771
+ * Upper bound cost estimate (£ GBP).
1772
+ */
1773
+ max: number | null;
1774
+ /**
1775
+ * Lower bound cost estimate (£ GBP).
1776
+ */
1777
+ min: number | null;
1778
+ /**
1779
+ * Assessment year for this cost estimate. Consumers should apply their own inflation adjustment from this base year.
1780
+ */
1781
+ year: number | null;
1782
+ };
1783
+
1784
+ /**
1785
+ * Canonical improvement measure: wall_insulation, condensing_boiler, solar_pv, etc. 40 canonical values covering all SAP standard improvement measures.
1786
+ */
1787
+ export const Measure = {
1788
+ WallInsulation: "wall_insulation",
1789
+ WallInsulationCombined: "wall_insulation_combined",
1790
+ CavityWallInsulation: "cavity_wall_insulation",
1791
+ LoftInsulation: "loft_insulation",
1792
+ FloorInsulationSolid: "floor_insulation_solid",
1793
+ FloorInsulationSuspended: "floor_insulation_suspended",
1794
+ FlatRoofInsulation: "flat_roof_insulation",
1795
+ RoomInRoofInsulation: "room_in_roof_insulation",
1796
+ PartyWallInsulation: "party_wall_insulation",
1797
+ DraughtProofing: "draught_proofing",
1798
+ ExternalDoors: "external_doors",
1799
+ DoubleGlazing: "double_glazing",
1800
+ ReplacementGlazing: "replacement_glazing",
1801
+ SecondaryGlazing: "secondary_glazing",
1802
+ CondensingBoiler: "condensing_boiler",
1803
+ GasCondensingBoiler: "gas_condensing_boiler",
1804
+ OilCondensingBoiler: "oil_condensing_boiler",
1805
+ RoomToCondensingBoiler: "room_to_condensing_boiler",
1806
+ CondensingUnit: "condensing_unit",
1807
+ GasCondensingUnit: "gas_condensing_unit",
1808
+ WarmAirUnit: "warm_air_unit",
1809
+ StorageHeaters: "storage_heaters",
1810
+ StorageHeatersDualImmersion: "storage_heaters_dual_immersion",
1811
+ HeatingControls: "heating_controls",
1812
+ ZoneControl: "zone_control",
1813
+ FlueGasRecovery: "flue_gas_recovery",
1814
+ ShowerHeatRecovery: "shower_heat_recovery",
1815
+ CylinderJacket: "cylinder_jacket",
1816
+ CylinderInsulation: "cylinder_insulation",
1817
+ CylinderThermostat: "cylinder_thermostat",
1818
+ WaterHeatingControls: "water_heating_controls",
1819
+ HeatPump: "heat_pump",
1820
+ HeatPumpUnderfloor: "heat_pump_underfloor",
1821
+ BiomassBoiler: "biomass_boiler",
1822
+ SolarThermal: "solar_thermal",
1823
+ SolarPv: "solar_pv",
1824
+ WindTurbine: "wind_turbine",
1825
+ PvBattery: "pv_battery",
1826
+ PvDiverter: "pv_diverter",
1827
+ LowEnergyLighting: "low_energy_lighting",
1828
+ } as const;
1829
+ /**
1830
+ * Canonical improvement measure: wall_insulation, condensing_boiler, solar_pv, etc. 40 canonical values covering all SAP standard improvement measures.
1831
+ */
1832
+ export type Measure = OpenEnum<typeof Measure>;
1833
+
1834
+ /**
1835
+ * Payback period classification. Non-domestic only: short, medium, long, other.
1836
+ */
1837
+ export const PaybackType = {
1838
+ Short: "short",
1839
+ Medium: "medium",
1840
+ Long: "long",
1841
+ Other: "other",
1842
+ } as const;
1843
+ /**
1844
+ * Payback period classification. Non-domestic only: short, medium, long, other.
1845
+ */
1846
+ export type PaybackType = OpenEnum<typeof PaybackType>;
1847
+
1848
+ /**
1849
+ * Projected rating after this measure. Domestic only.
1850
+ */
1851
+ export type ProjectedRating = {
1852
+ /**
1853
+ * Projected energy band after this measure (e.g. 'C').
1854
+ */
1855
+ band: string | null;
1856
+ /**
1857
+ * Projected cumulative SAP score after implementing this and all prior measures.
1858
+ */
1859
+ energyScore: number | null;
1860
+ /**
1861
+ * Projected cumulative environmental score.
1862
+ */
1863
+ environmentalScore: number | null;
1864
+ };
1865
+
1866
+ /**
1867
+ * Currency.
1868
+ */
1869
+ export const GetEpcByLocationIdCurrency = {
1870
+ Gbp: "GBP",
1871
+ } as const;
1872
+ /**
1873
+ * Currency.
1874
+ */
1875
+ export type GetEpcByLocationIdCurrency = ClosedEnum<
1876
+ typeof GetEpcByLocationIdCurrency
1877
+ >;
1878
+
1879
+ /**
1880
+ * Estimated annual saving in GBP. Parsed from source typical saving field.
1881
+ */
1882
+ export type Saving = {
1883
+ /**
1884
+ * Estimated annual saving (£ GBP).
1885
+ */
1886
+ annual: number | null;
1887
+ /**
1888
+ * Currency.
1889
+ */
1890
+ currency: GetEpcByLocationIdCurrency;
1891
+ };
1892
+
1893
+ /**
1894
+ * Individual improvement recommendation with structured cost/saving values, canonical measure classification, and projected rating impact.
1895
+ */
1896
+ export type Recommendations = {
1897
+ /**
1898
+ * Measure category: insulation, glazing, heating, hot_water, renewables, lighting.
1899
+ */
1900
+ category: GetEpcByLocationIdCategory | null;
1901
+ /**
1902
+ * CO2 reduction impact. Scotland non-domestic only: low, medium, high.
1903
+ */
1904
+ co2Impact: Co2Impact | null;
1905
+ /**
1906
+ * Structured cost estimate with numeric min/max in GBP. Parsed from 1,054 unique source cost strings (including encoding variants). Use cost.year to apply your own inflation adjustment.
1907
+ */
1908
+ cost: Cost | null;
1909
+ /**
1910
+ * Detailed description with guidance text.
1911
+ */
1912
+ description: string | null;
1913
+ /**
1914
+ * Whether this measure is eligible for Green Deal financing. Boolean — not a raw string code.
1915
+ */
1916
+ greenDealEligible: boolean | null;
1917
+ /**
1918
+ * Canonical improvement measure: wall_insulation, condensing_boiler, solar_pv, etc. 40 canonical values covering all SAP standard improvement measures.
1919
+ */
1920
+ measure: Measure | null;
1921
+ /**
1922
+ * Source measure code. E&W: IMPROVEMENT_ID. Scotland: EPC-prefixed (e.g. EPC-R4).
1923
+ */
1924
+ measureCode: string | null;
1925
+ /**
1926
+ * Payback period classification. Non-domestic only: short, medium, long, other.
1927
+ */
1928
+ paybackType: PaybackType | null;
1929
+ /**
1930
+ * Projected rating after this measure. Domestic only.
1931
+ */
1932
+ projectedRating: ProjectedRating | null;
1933
+ /**
1934
+ * Estimated annual saving in GBP. Parsed from source typical saving field.
1935
+ */
1936
+ saving: Saving | null;
1937
+ /**
1938
+ * Priority order. Implementing measures in sequence provides the most cost-effective path.
1939
+ */
1940
+ sequence: number;
1941
+ /**
1942
+ * Short description of the improvement measure.
1943
+ */
1944
+ summary: string | null;
1945
+ };
1946
+
1947
+ /**
1948
+ * Annual heating costs — current and achievable.
1949
+ */
1950
+ export type Heating = {
1951
+ /**
1952
+ * Current annual heating cost (£).
1953
+ */
1954
+ current: number;
1955
+ /**
1956
+ * Achievable annual heating cost (£).
1957
+ */
1958
+ potential: number;
1959
+ };
1960
+
1961
+ /**
1962
+ * Annual hot water costs — current and achievable.
1963
+ */
1964
+ export type GetEpcByLocationIdHotWater = {
1965
+ /**
1966
+ * Current annual hot water cost (£).
1967
+ */
1968
+ current: number;
1969
+ /**
1970
+ * Achievable annual hot water cost (£).
1971
+ */
1972
+ potential: number;
1973
+ };
1974
+
1975
+ /**
1976
+ * Annual lighting costs — current and achievable.
1977
+ */
1978
+ export type GetEpcByLocationIdLighting = {
1979
+ /**
1980
+ * Current annual lighting cost (£).
1981
+ */
1982
+ current: number;
1983
+ /**
1984
+ * Achievable annual lighting cost (£).
1985
+ */
1986
+ potential: number;
1987
+ };
1988
+
1989
+ /**
1990
+ * Annual running costs in GBP. Domestic only; null for non-domestic and DECs.
1991
+ */
1992
+ export type RunningCosts = {
1993
+ /**
1994
+ * Annual heating costs — current and achievable.
1995
+ */
1996
+ heating: Heating;
1997
+ /**
1998
+ * Annual hot water costs — current and achievable.
1999
+ */
2000
+ hotWater: GetEpcByLocationIdHotWater;
2001
+ /**
2002
+ * Annual lighting costs — current and achievable.
2003
+ */
2004
+ lighting: GetEpcByLocationIdLighting;
2005
+ };
2006
+
2007
+ /**
2008
+ * Current band including Scotland half-bands (B+, C+, etc.) and 'Carbon Neu' → A+.
2009
+ */
2010
+ export const CurrentBand = {
2011
+ APlus: "A+",
2012
+ A: "A",
2013
+ BPlus: "B+",
2014
+ B: "B",
2015
+ CPlus: "C+",
2016
+ C: "C",
2017
+ DPlus: "D+",
2018
+ D: "D",
2019
+ EPlus: "E+",
2020
+ E: "E",
2021
+ FPlus: "F+",
2022
+ F: "F",
2023
+ G: "G",
2024
+ } as const;
2025
+ /**
2026
+ * Current band including Scotland half-bands (B+, C+, etc.) and 'Carbon Neu' → A+.
2027
+ */
2028
+ export type CurrentBand = OpenEnum<typeof CurrentBand>;
2029
+
2030
+ /**
2031
+ * Potential band.
2032
+ */
2033
+ export const PotentialBand = {
2034
+ APlus: "A+",
2035
+ A: "A",
2036
+ BPlus: "B+",
2037
+ B: "B",
2038
+ CPlus: "C+",
2039
+ C: "C",
2040
+ DPlus: "D+",
2041
+ D: "D",
2042
+ EPlus: "E+",
2043
+ E: "E",
2044
+ FPlus: "F+",
2045
+ F: "F",
2046
+ G: "G",
2047
+ } as const;
2048
+ /**
2049
+ * Potential band.
2050
+ */
2051
+ export type PotentialBand = OpenEnum<typeof PotentialBand>;
2052
+
2053
+ /**
2054
+ * Scotland's native non-domestic rating using Scottish weather data. Null for E&W certificates and domestic certificates.
2055
+ */
2056
+ export type ScotlandNativeRating = {
2057
+ /**
2058
+ * Current band including Scotland half-bands (B+, C+, etc.) and 'Carbon Neu' → A+.
2059
+ */
2060
+ currentBand: CurrentBand;
2061
+ /**
2062
+ * Current Energy Performance Rating using Scottish weather data (kg CO2/m²/year).
2063
+ */
2064
+ currentRating: number;
2065
+ /**
2066
+ * Potential band.
2067
+ */
2068
+ potentialBand: PotentialBand | null;
2069
+ /**
2070
+ * Potential rating if improvements carried out. Scotland publishes this; E&W does not.
2071
+ */
2072
+ potentialRating: number | null;
2073
+ };
2074
+
2075
+ /**
2076
+ * Source register: mhclg (England & Wales) or scottish_government (Scotland).
2077
+ */
2078
+ export const Source = {
2079
+ Mhclg: "mhclg",
2080
+ ScottishGovernment: "scottish_government",
2081
+ } as const;
2082
+ /**
2083
+ * Source register: mhclg (England & Wales) or scottish_government (Scotland).
2084
+ */
2085
+ export type Source = OpenEnum<typeof Source>;
2086
+
2087
+ /**
2088
+ * AC inspection commissioning status.
2089
+ */
2090
+ export const InspectionStatus = {
2091
+ Completed: "completed",
2092
+ Commissioned: "commissioned",
2093
+ NotCommissioned: "not_commissioned",
2094
+ NotRelevant: "not_relevant",
2095
+ Unknown: "unknown",
2096
+ } as const;
2097
+ /**
2098
+ * AC inspection commissioning status.
2099
+ */
2100
+ export type InspectionStatus = OpenEnum<typeof InspectionStatus>;
2101
+
2102
+ /**
2103
+ * Air conditioning details. Non-domestic/DEC only; null for domestic.
2104
+ */
2105
+ export type AirConditioning = {
2106
+ /**
2107
+ * Estimated AC capacity when actual is unknown (kW).
2108
+ */
2109
+ estimatedKwRating: number | null;
2110
+ /**
2111
+ * AC inspection commissioning status.
2112
+ */
2113
+ inspectionStatus: InspectionStatus | null;
2114
+ /**
2115
+ * Actual AC system capacity (kW).
2116
+ */
2117
+ kwRating: number | null;
2118
+ /**
2119
+ * Whether AC system is installed.
2120
+ */
2121
+ present: boolean;
2122
+ };
2123
+
2124
+ /**
2125
+ * Electricity tariff type. Domestic only.
2126
+ */
2127
+ export const EnergyTariff = {
2128
+ Single: "single",
2129
+ Dual: "dual",
2130
+ OffPeak7hr: "off_peak_7hr",
2131
+ OffPeak10hr: "off_peak_10hr",
2132
+ OffPeak18hr: "off_peak_18hr",
2133
+ OffPeak24hr: "off_peak_24hr",
2134
+ Unknown: "unknown",
2135
+ } as const;
2136
+ /**
2137
+ * Electricity tariff type. Domestic only.
2138
+ */
2139
+ export type EnergyTariff = OpenEnum<typeof EnergyTariff>;
2140
+
2141
+ /**
2142
+ * Corridor heat loss classification. Flats/maisonettes only.
2143
+ */
2144
+ export const HeatLossCorridor = {
2145
+ NoCorridor: "no_corridor",
2146
+ HeatedCorridor: "heated_corridor",
2147
+ UnheatedCorridor: "unheated_corridor",
2148
+ } as const;
2149
+ /**
2150
+ * Corridor heat loss classification. Flats/maisonettes only.
2151
+ */
2152
+ export type HeatLossCorridor = OpenEnum<typeof HeatLossCorridor>;
2153
+
2154
+ /**
2155
+ * Normalised primary fuel type. See mainFuelExternal for raw source text.
2156
+ */
2157
+ export const MainFuel = {
2158
+ MainsGas: "mains_gas",
2159
+ Lpg: "lpg",
2160
+ Oil: "oil",
2161
+ Electricity: "electricity",
2162
+ Biomass: "biomass",
2163
+ Coal: "coal",
2164
+ Anthracite: "anthracite",
2165
+ SmokelessFuel: "smokeless_fuel",
2166
+ Biogas: "biogas",
2167
+ DistrictHeating: "district_heating",
2168
+ HeatPump: "heat_pump",
2169
+ DualFuel: "dual_fuel",
2170
+ WasteHeat: "waste_heat",
2171
+ Other: "other",
2172
+ } as const;
2173
+ /**
2174
+ * Normalised primary fuel type. See mainFuelExternal for raw source text.
2175
+ */
2176
+ export type MainFuel = OpenEnum<typeof MainFuel>;
2177
+
2178
+ /**
2179
+ * Photovoltaic panel installation.
2180
+ */
2181
+ export type Photovoltaic = {
2182
+ /**
2183
+ * Whether PV panels are installed.
2184
+ */
2185
+ present: boolean;
2186
+ /**
2187
+ * Percentage of demand met by PV. Domestic only (PHOTO_SUPPLY field).
2188
+ */
2189
+ supplyPercentage: number | null;
2190
+ };
2191
+
2192
+ /**
2193
+ * On-site renewable energy installations.
2194
+ */
2195
+ export type Renewables = {
2196
+ /**
2197
+ * Free-text renewable sources description. Non-domestic only (RENEWABLE_SOURCES field).
2198
+ */
2199
+ description: string | null;
2200
+ /**
2201
+ * Photovoltaic panel installation.
2202
+ */
2203
+ photovoltaic: Photovoltaic | null;
2204
+ /**
2205
+ * Solar thermal (hot water) present. Domestic: from SOLAR_WATER_HEATING_FLAG. Non-domestic: derived from RENEWABLE_SOURCES text.
2206
+ */
2207
+ solarThermal: boolean | null;
2208
+ /**
2209
+ * Number of wind turbines installed. Domestic only.
2210
+ */
2211
+ windTurbines: number | null;
2212
+ };
2213
+
2214
+ /**
2215
+ * Mechanical ventilation type. Domestic only. Null means natural ventilation.
2216
+ */
2217
+ export const Ventilation = {
2218
+ Natural: "natural",
2219
+ MechanicalExtract: "mechanical_extract",
2220
+ MechanicalSupplyAndExtract: "mechanical_supply_and_extract",
2221
+ } as const;
2222
+ /**
2223
+ * Mechanical ventilation type. Domestic only. Null means natural ventilation.
2224
+ */
2225
+ export type Ventilation = OpenEnum<typeof Ventilation>;
2226
+
2227
+ /**
2228
+ * Building energy systems — fuel, heating, renewables, ventilation.
2229
+ */
2230
+ export type Systems = {
2231
+ /**
2232
+ * Air conditioning details. Non-domestic/DEC only; null for domestic.
2233
+ */
2234
+ airConditioning: AirConditioning | null;
2235
+ /**
2236
+ * Electricity tariff type. Domestic only.
2237
+ */
2238
+ energyTariff: EnergyTariff | null;
2239
+ /**
2240
+ * Corridor heat loss classification. Flats/maisonettes only.
2241
+ */
2242
+ heatLossCorridor: HeatLossCorridor | null;
2243
+ /**
2244
+ * Normalised primary fuel type. See mainFuelExternal for raw source text.
2245
+ */
2246
+ mainFuel: MainFuel | null;
2247
+ /**
2248
+ * Raw fuel type text from source register. E.g. 'mains gas (not community)', 'electricity (7-hour tariff)', 'Natural Gas'.
2249
+ */
2250
+ mainFuelExternal: string | null;
2251
+ /**
2252
+ * Heating control system code. Domestic only.
2253
+ */
2254
+ mainHeatingControls: string | null;
2255
+ /**
2256
+ * Whether mains gas is connected. Domestic only. Derived from MAINS_GAS_FLAG (Y→true, N→false, blank→null).
2257
+ */
2258
+ mainsGas: boolean | null;
2259
+ /**
2260
+ * On-site renewable energy installations.
2261
+ */
2262
+ renewables: Renewables;
2263
+ /**
2264
+ * Length of unheated corridor in metres. Flats/maisonettes only.
2265
+ */
2266
+ unheatedCorridorLength: number | null;
2267
+ /**
2268
+ * Mechanical ventilation type. Domestic only. Null means natural ventilation.
2269
+ */
2270
+ ventilation: Ventilation | null;
2271
+ };
2272
+
2273
+ /**
2274
+ * Normalised transaction type (trigger for assessment).
2275
+ */
2276
+ export const TransactionType = {
2277
+ MarketedSale: "marketed_sale",
2278
+ NonMarketedSale: "non_marketed_sale",
2279
+ Rental: "rental",
2280
+ NewDwelling: "new_dwelling",
2281
+ Voluntary: "voluntary",
2282
+ VoluntaryReissue: "voluntary_reissue",
2283
+ StockConditionSurvey: "stock_condition_survey",
2284
+ GrantScheme: "grant_scheme",
2285
+ DisplayPublicBuilding: "display_public_building",
2286
+ Construction: "construction",
2287
+ Other: "other",
2288
+ } as const;
2289
+ /**
2290
+ * Normalised transaction type (trigger for assessment).
2291
+ */
2292
+ export type TransactionType = OpenEnum<typeof TransactionType>;
2293
+
2294
+ /**
2295
+ * Unified EPC entity covering domestic, non-domestic, and Display Energy Certificates across England, Wales, and Scotland. Filter by certificateType to narrow to a specific assessment type. Use rating.current.band for cross-type energy efficiency comparisons.
2296
+ */
2297
+ export type Data = {
2298
+ /**
2299
+ * Standardised address.
2300
+ */
2301
+ address: GetEpcByLocationIdAddress;
2302
+ /**
2303
+ * Assessment methodology: rdsap (existing domestic), sap (new domestic), sbem (non-domestic), dsm (complex non-domestic), operational (DEC).
2304
+ */
2305
+ assessmentMethodology: AssessmentMethodology;
2306
+ /**
2307
+ * Non-domestic benchmarks and building classification. Null for domestic.
2308
+ */
2309
+ benchmarks: Benchmarks | null;
2310
+ /**
2311
+ * Tracks the same building across successive assessments. E&W: 12-digit BUILDING_REFERENCE_NUMBER. Scotland: 10-digit SEPCR property identifier (not the same as UPRN).
2312
+ */
2313
+ buildingReferenceNumber: string | null;
2314
+ /**
2315
+ * Certificate type: domestic, non_domestic, or dec.
2316
+ */
2317
+ certificateType: GetEpcByLocationIdCertificateType;
2318
+ /**
2319
+ * ONS constituency code (E&W) or Scottish ward code.
2320
+ */
2321
+ constituency: string | null;
2322
+ /**
2323
+ * Constituency/ward name.
2324
+ */
2325
+ constituencyLabel: string | null;
2326
+ /**
2327
+ * Geographic coordinates. Derived from UPRN match or postcode centroid.
2328
+ */
2329
+ coordinates: Coordinates | null;
2330
+ /**
2331
+ * County name. E&W only.
2332
+ */
2333
+ county: string | null;
2334
+ /**
2335
+ * Record creation timestamp (ISO 8601).
2336
+ */
2337
+ createdAt: string;
2338
+ /**
2339
+ * Scottish Data Zone code. Scotland only.
2340
+ */
2341
+ dataZone: string | null;
2342
+ /**
2343
+ * Domestic property details — construction, rooms, glazing, Scotland-specific fields. Null for non-domestic and DECs.
2344
+ */
2345
+ domesticDetails: DomesticDetails | null;
2346
+ /**
2347
+ * Environmental impact, CO2 emissions, and energy consumption.
2348
+ */
2349
+ emissions: Emissions;
2350
+ /**
2351
+ * Component-level building fabric assessment. Domestic only; null for non-domestic and DECs.
2352
+ */
2353
+ fabric: Fabric | null;
2354
+ /**
2355
+ * Vepler canonical entity ID.
2356
+ */
2357
+ id: string;
2358
+ /**
2359
+ * Date of energy assessment (ISO 8601).
2360
+ */
2361
+ inspectionDate: string;
2362
+ /**
2363
+ * ONS local authority code (E&W) or Scottish LA code.
2364
+ */
2365
+ localAuthority: string | null;
2366
+ /**
2367
+ * Local authority name.
2368
+ */
2369
+ localAuthorityLabel: string | null;
2370
+ /**
2371
+ * UPRN linking this certificate to the Vepler Property Index. Null if not yet matched. Populated by UPRN enrichment pipeline.
2372
+ */
2373
+ locationId: number | null;
2374
+ /**
2375
+ * Date registered with the government (ISO 8601).
2376
+ */
2377
+ lodgementDate: string;
2378
+ /**
2379
+ * Derived MEES compliance status (Decision D11). Based on current energy rating band and certificate type. compliant=A-E, at_risk=E, non_compliant=F-G, exempt=non-domestic/DEC.
2380
+ */
2381
+ meesCompliance: MeesCompliance;
2382
+ /**
2383
+ * DEC operational performance from metered energy use. Null for domestic and non-domestic EPCs.
2384
+ */
2385
+ operationalPerformance: OperationalPerformance | null;
2386
+ /**
2387
+ * Normalised property type. Domestic: house, flat, bungalow, maisonette, park_home. Non-domestic: canonical NCM category (e.g. office_workshop, retail_financial). See EPC_DOMESTIC_PROPERTY_TYPE_VALUES and EPC_NON_DOMESTIC_PROPERTY_TYPE_VALUES.
2388
+ */
2389
+ propertyType: string | null;
2390
+ /**
2391
+ * Raw property type text from source register. E.g. 'House', 'A1/A2 Retail and Financial/Professional services', 'Offices and Workshop businesses'.
2392
+ */
2393
+ propertyTypeExternal: string | null;
2394
+ /**
2395
+ * Energy rating — unified across domestic (SAP), non-domestic (asset), and DEC (operational). Filter on rating.current.band for cross-type comparisons.
2396
+ */
2397
+ rating: Rating;
2398
+ /**
2399
+ * Improvement recommendations ordered by priority. Domestic: from separate recommendations CSV. Non-domestic Scotland: parsed from pipe-delimited IMPROVEMENT_RECOMMENDATIONS field. Non-domestic E&W: from separate recommendations file.
2400
+ */
2401
+ recommendations: Array<Recommendations>;
2402
+ /**
2403
+ * Annual running costs in GBP. Domestic only; null for non-domestic and DECs.
2404
+ */
2405
+ runningCosts: RunningCosts | null;
2406
+ /**
2407
+ * Scotland's native non-domestic rating using Scottish weather data. Null for E&W certificates and domestic certificates.
2408
+ */
2409
+ scotlandNativeRating: ScotlandNativeRating | null;
2410
+ /**
2411
+ * Source register: mhclg (England & Wales) or scottish_government (Scotland).
2412
+ */
2413
+ source: Source;
2414
+ /**
2415
+ * Original certificate identifier from source register. E&W: LMK_KEY. Scotland domestic: OSG_REFERENCE_NUMBER. Scotland non-domestic: REPORT_REFERENCE_NUMBER.
2416
+ */
2417
+ sourceReference: string;
2418
+ /**
2419
+ * Building energy systems — fuel, heating, renewables, ventilation.
2420
+ */
2421
+ systems: Systems;
2422
+ /**
2423
+ * Total floor area in m². Domestic: total internal floor area. Non-domestic: conditioned floor area.
2424
+ */
2425
+ totalFloorArea: number | null;
2426
+ /**
2427
+ * Normalised transaction type (trigger for assessment).
2428
+ */
2429
+ transactionType: TransactionType | null;
2430
+ /**
2431
+ * Raw transaction type text from source register.
2432
+ */
2433
+ transactionTypeExternal: string | null;
2434
+ /**
2435
+ * Record last update timestamp (ISO 8601).
2436
+ */
2437
+ updatedAt: string;
2438
+ /**
2439
+ * Calculated expiry date. Domestic/non-domestic: lodgementDate + 10 years. DEC: lodgementDate + 1 year (advisory report: + 7 years).
2440
+ */
2441
+ validUntil: string | null;
2442
+ };
2443
+
2444
+ export const GetEpcByLocationIdObject = {
2445
+ List: "list",
2446
+ } as const;
2447
+ export type GetEpcByLocationIdObject = ClosedEnum<
2448
+ typeof GetEpcByLocationIdObject
2449
+ >;
2450
+
2451
+ /**
2452
+ * EPC certificates for this location
2453
+ */
2454
+ export type GetEpcByLocationIdResponseBody = {
2455
+ data: Array<Data>;
2456
+ hasMore: boolean;
2457
+ object: GetEpcByLocationIdObject;
2458
+ totalCount?: number | undefined;
2459
+ url: string;
2460
+ };
2461
+
2462
+ /** @internal */
2463
+ export const CertificateType$outboundSchema: z.ZodNativeEnum<
2464
+ typeof CertificateType
2465
+ > = z.nativeEnum(CertificateType);
2466
+
2467
+ /** @internal */
2468
+ export type GetEpcByLocationIdRequest$Outbound = {
2469
+ certificateType?: string | undefined;
2470
+ limit?: string | undefined;
2471
+ locationId: string;
2472
+ offset?: string | undefined;
2473
+ };
2474
+
2475
+ /** @internal */
2476
+ export const GetEpcByLocationIdRequest$outboundSchema: z.ZodType<
2477
+ GetEpcByLocationIdRequest$Outbound,
2478
+ z.ZodTypeDef,
2479
+ GetEpcByLocationIdRequest
2480
+ > = z.object({
2481
+ certificateType: CertificateType$outboundSchema.optional(),
2482
+ limit: z.string().optional(),
2483
+ locationId: z.string(),
2484
+ offset: z.string().optional(),
2485
+ });
2486
+
2487
+ export function getEpcByLocationIdRequestToJSON(
2488
+ getEpcByLocationIdRequest: GetEpcByLocationIdRequest,
2489
+ ): string {
2490
+ return JSON.stringify(
2491
+ GetEpcByLocationIdRequest$outboundSchema.parse(getEpcByLocationIdRequest),
2492
+ );
2493
+ }
2494
+
2495
+ /** @internal */
2496
+ export const GetEpcByLocationIdAddress$inboundSchema: z.ZodType<
2497
+ GetEpcByLocationIdAddress,
2498
+ z.ZodTypeDef,
2499
+ unknown
2500
+ > = z.object({
2501
+ displayAddress: z.string(),
2502
+ line1: z.nullable(z.string()),
2503
+ line2: z.nullable(z.string()),
2504
+ line3: z.nullable(z.string()),
2505
+ postTown: z.nullable(z.string()),
2506
+ postcode: z.string(),
2507
+ postcodeNoSpace: z.string(),
2508
+ });
2509
+
2510
+ export function getEpcByLocationIdAddressFromJSON(
2511
+ jsonString: string,
2512
+ ): SafeParseResult<GetEpcByLocationIdAddress, SDKValidationError> {
2513
+ return safeParse(
2514
+ jsonString,
2515
+ (x) => GetEpcByLocationIdAddress$inboundSchema.parse(JSON.parse(x)),
2516
+ `Failed to parse 'GetEpcByLocationIdAddress' from JSON`,
2517
+ );
2518
+ }
2519
+
2520
+ /** @internal */
2521
+ export const AssessmentMethodology$inboundSchema: z.ZodType<
2522
+ AssessmentMethodology,
2523
+ z.ZodTypeDef,
2524
+ unknown
2525
+ > = openEnums.inboundSchema(AssessmentMethodology);
2526
+
2527
+ /** @internal */
2528
+ export const BuildingEnvironment$inboundSchema: z.ZodType<
2529
+ BuildingEnvironment,
2530
+ z.ZodTypeDef,
2531
+ unknown
2532
+ > = openEnums.inboundSchema(BuildingEnvironment);
2533
+
2534
+ /** @internal */
2535
+ export const NewBuildBand$inboundSchema: z.ZodType<
2536
+ NewBuildBand,
2537
+ z.ZodTypeDef,
2538
+ unknown
2539
+ > = openEnums.inboundSchema(NewBuildBand);
2540
+
2541
+ /** @internal */
2542
+ export const Benchmarks$inboundSchema: z.ZodType<
2543
+ Benchmarks,
2544
+ z.ZodTypeDef,
2545
+ unknown
2546
+ > = z.object({
2547
+ approximateEnergyUse: z.nullable(z.number()),
2548
+ buildingEmissions: z.nullable(z.number()),
2549
+ buildingEnvironment: z.nullable(BuildingEnvironment$inboundSchema),
2550
+ buildingLevel: z.nullable(z.number().int()),
2551
+ electricitySource: z.nullable(z.string()),
2552
+ existingStock: z.nullable(z.string()),
2553
+ meets2002Standard: z.nullable(z.boolean()),
2554
+ newBuild: z.nullable(z.number()),
2555
+ newBuildBand: z.nullable(NewBuildBand$inboundSchema),
2556
+ standardEmissions: z.nullable(z.number()),
2557
+ targetEmissions: z.nullable(z.number()),
2558
+ typicalEmissions: z.nullable(z.number()),
2559
+ });
2560
+
2561
+ export function benchmarksFromJSON(
2562
+ jsonString: string,
2563
+ ): SafeParseResult<Benchmarks, SDKValidationError> {
2564
+ return safeParse(
2565
+ jsonString,
2566
+ (x) => Benchmarks$inboundSchema.parse(JSON.parse(x)),
2567
+ `Failed to parse 'Benchmarks' from JSON`,
2568
+ );
2569
+ }
2570
+
2571
+ /** @internal */
2572
+ export const GetEpcByLocationIdCertificateType$inboundSchema: z.ZodType<
2573
+ GetEpcByLocationIdCertificateType,
2574
+ z.ZodTypeDef,
2575
+ unknown
2576
+ > = openEnums.inboundSchema(GetEpcByLocationIdCertificateType);
2577
+
2578
+ /** @internal */
2579
+ export const Coordinates$inboundSchema: z.ZodType<
2580
+ Coordinates,
2581
+ z.ZodTypeDef,
2582
+ unknown
2583
+ > = z.object({
2584
+ latitude: z.number(),
2585
+ longitude: z.number(),
2586
+ });
2587
+
2588
+ export function coordinatesFromJSON(
2589
+ jsonString: string,
2590
+ ): SafeParseResult<Coordinates, SDKValidationError> {
2591
+ return safeParse(
2592
+ jsonString,
2593
+ (x) => Coordinates$inboundSchema.parse(JSON.parse(x)),
2594
+ `Failed to parse 'Coordinates' from JSON`,
2595
+ );
2596
+ }
2597
+
2598
+ /** @internal */
2599
+ export const BuiltForm$inboundSchema: z.ZodType<
2600
+ BuiltForm,
2601
+ z.ZodTypeDef,
2602
+ unknown
2603
+ > = openEnums.inboundSchema(BuiltForm);
2604
+
2605
+ /** @internal */
2606
+ export const ConstructionAge$inboundSchema: z.ZodType<
2607
+ ConstructionAge,
2608
+ z.ZodTypeDef,
2609
+ unknown
2610
+ > = z.object({
2611
+ endYear: z.nullable(z.number().int()),
2612
+ isExact: z.boolean(),
2613
+ midYear: z.nullable(z.number().int()),
2614
+ startYear: z.nullable(z.number().int()),
2615
+ });
2616
+
2617
+ export function constructionAgeFromJSON(
2618
+ jsonString: string,
2619
+ ): SafeParseResult<ConstructionAge, SDKValidationError> {
2620
+ return safeParse(
2621
+ jsonString,
2622
+ (x) => ConstructionAge$inboundSchema.parse(JSON.parse(x)),
2623
+ `Failed to parse 'ConstructionAge' from JSON`,
2624
+ );
2625
+ }
2626
+
2627
+ /** @internal */
2628
+ export const Area$inboundSchema: z.ZodType<Area, z.ZodTypeDef, unknown> =
2629
+ openEnums.inboundSchema(Area);
2630
+
2631
+ /** @internal */
2632
+ export const GetEpcByLocationIdType$inboundSchema: z.ZodType<
2633
+ GetEpcByLocationIdType,
2634
+ z.ZodTypeDef,
2635
+ unknown
2636
+ > = openEnums.inboundSchema(GetEpcByLocationIdType);
2637
+
2638
+ /** @internal */
2639
+ export const Glazing$inboundSchema: z.ZodType<Glazing, z.ZodTypeDef, unknown> =
2640
+ z.object({
2641
+ area: z.nullable(Area$inboundSchema),
2642
+ proportion: z.nullable(z.number().int()),
2643
+ type: z.nullable(GetEpcByLocationIdType$inboundSchema),
2644
+ });
2645
+
2646
+ export function glazingFromJSON(
2647
+ jsonString: string,
2648
+ ): SafeParseResult<Glazing, SDKValidationError> {
2649
+ return safeParse(
2650
+ jsonString,
2651
+ (x) => Glazing$inboundSchema.parse(JSON.parse(x)),
2652
+ `Failed to parse 'Glazing' from JSON`,
2653
+ );
2654
+ }
2655
+
2656
+ /** @internal */
2657
+ export const Tenure$inboundSchema: z.ZodType<Tenure, z.ZodTypeDef, unknown> =
2658
+ openEnums.inboundSchema(Tenure);
2659
+
2660
+ /** @internal */
2661
+ export const DomesticDetails$inboundSchema: z.ZodType<
2662
+ DomesticDetails,
2663
+ z.ZodTypeDef,
2664
+ unknown
2665
+ > = z.object({
2666
+ builtForm: z.nullable(BuiltForm$inboundSchema),
2667
+ constructionAge: z.nullable(z.lazy(() => ConstructionAge$inboundSchema)),
2668
+ constructionAgeBandExternal: z.nullable(z.string()),
2669
+ extensionCount: z.nullable(z.number().int()),
2670
+ flatStoreyCount: z.nullable(z.number().int()),
2671
+ flatTopStorey: z.nullable(z.boolean()),
2672
+ floorHeight: z.nullable(z.number()),
2673
+ floorLevel: z.nullable(z.string()),
2674
+ glazing: z.lazy(() => Glazing$inboundSchema),
2675
+ habitableRooms: z.nullable(z.number().int()),
2676
+ heatedRooms: z.nullable(z.number().int()),
2677
+ impactCavityWallInsulation: z.nullable(z.number()),
2678
+ impactLoftInsulation: z.nullable(z.number()),
2679
+ impactSolidWallInsulation: z.nullable(z.number()),
2680
+ lowEnergyLighting: z.nullable(z.number().int()),
2681
+ lzcEnergySources: z.nullable(z.string()),
2682
+ openFireplaces: z.nullable(z.number().int()),
2683
+ spaceHeatingDemand: z.nullable(z.number()),
2684
+ tenure: z.nullable(Tenure$inboundSchema),
2685
+ threeYearEnergyCostCurrent: z.nullable(z.number()),
2686
+ threeYearEnergySavingPotential: z.nullable(z.number()),
2687
+ waterHeatingDemand: z.nullable(z.number()),
2688
+ });
2689
+
2690
+ export function domesticDetailsFromJSON(
2691
+ jsonString: string,
2692
+ ): SafeParseResult<DomesticDetails, SDKValidationError> {
2693
+ return safeParse(
2694
+ jsonString,
2695
+ (x) => DomesticDetails$inboundSchema.parse(JSON.parse(x)),
2696
+ `Failed to parse 'DomesticDetails' from JSON`,
2697
+ );
2698
+ }
2699
+
2700
+ /** @internal */
2701
+ export const Co2Unit$inboundSchema: z.ZodType<Co2Unit, z.ZodTypeDef, unknown> =
2702
+ openEnums.inboundSchema(Co2Unit);
2703
+
2704
+ /** @internal */
2705
+ export const EnergyConsumptionUnit$inboundSchema: z.ZodType<
2706
+ EnergyConsumptionUnit,
2707
+ z.ZodTypeDef,
2708
+ unknown
2709
+ > = openEnums.inboundSchema(EnergyConsumptionUnit);
2710
+
2711
+ /** @internal */
2712
+ export const Emissions$inboundSchema: z.ZodType<
2713
+ Emissions,
2714
+ z.ZodTypeDef,
2715
+ unknown
2716
+ > = z.object({
2717
+ co2Current: z.nullable(z.number()),
2718
+ co2PerFloorArea: z.nullable(z.number()),
2719
+ co2Potential: z.nullable(z.number()),
2720
+ co2Unit: Co2Unit$inboundSchema,
2721
+ energyConsumptionCurrent: z.nullable(z.number()),
2722
+ energyConsumptionPotential: z.nullable(z.number()),
2723
+ energyConsumptionUnit: z.nullable(EnergyConsumptionUnit$inboundSchema),
2724
+ environmentalScoreCurrent: z.nullable(z.number().int()),
2725
+ environmentalScorePotential: z.nullable(z.number().int()),
2726
+ });
2727
+
2728
+ export function emissionsFromJSON(
2729
+ jsonString: string,
2730
+ ): SafeParseResult<Emissions, SDKValidationError> {
2731
+ return safeParse(
2732
+ jsonString,
2733
+ (x) => Emissions$inboundSchema.parse(JSON.parse(x)),
2734
+ `Failed to parse 'Emissions' from JSON`,
2735
+ );
2736
+ }
2737
+
2738
+ /** @internal */
2739
+ export const EnergyEfficiency$inboundSchema: z.ZodType<
2740
+ EnergyEfficiency,
2741
+ z.ZodTypeDef,
2742
+ unknown
2743
+ > = openEnums.inboundSchema(EnergyEfficiency);
2744
+
2745
+ /** @internal */
2746
+ export const EnvironmentalEfficiency$inboundSchema: z.ZodType<
2747
+ EnvironmentalEfficiency,
2748
+ z.ZodTypeDef,
2749
+ unknown
2750
+ > = openEnums.inboundSchema(EnvironmentalEfficiency);
2751
+
2752
+ /** @internal */
2753
+ export const AirTightness$inboundSchema: z.ZodType<
2754
+ AirTightness,
2755
+ z.ZodTypeDef,
2756
+ unknown
2757
+ > = z.object({
2758
+ description: z.nullable(z.string()),
2759
+ energyEfficiency: z.nullable(EnergyEfficiency$inboundSchema),
2760
+ environmentalEfficiency: z.nullable(EnvironmentalEfficiency$inboundSchema),
2761
+ });
2762
+
2763
+ export function airTightnessFromJSON(
2764
+ jsonString: string,
2765
+ ): SafeParseResult<AirTightness, SDKValidationError> {
2766
+ return safeParse(
2767
+ jsonString,
2768
+ (x) => AirTightness$inboundSchema.parse(JSON.parse(x)),
2769
+ `Failed to parse 'AirTightness' from JSON`,
2770
+ );
2771
+ }
2772
+
2773
+ /** @internal */
2774
+ export const DataQuality$inboundSchema: z.ZodType<
2775
+ DataQuality,
2776
+ z.ZodTypeDef,
2777
+ unknown
2778
+ > = openEnums.inboundSchema(DataQuality);
2779
+
2780
+ /** @internal */
2781
+ export const GetEpcByLocationIdEnergyEfficiency$inboundSchema: z.ZodType<
2782
+ GetEpcByLocationIdEnergyEfficiency,
2783
+ z.ZodTypeDef,
2784
+ unknown
2785
+ > = openEnums.inboundSchema(GetEpcByLocationIdEnergyEfficiency);
2786
+
2787
+ /** @internal */
2788
+ export const GetEpcByLocationIdEnvironmentalEfficiency$inboundSchema: z.ZodType<
2789
+ GetEpcByLocationIdEnvironmentalEfficiency,
2790
+ z.ZodTypeDef,
2791
+ unknown
2792
+ > = openEnums.inboundSchema(GetEpcByLocationIdEnvironmentalEfficiency);
2793
+
2794
+ /** @internal */
2795
+ export const FloorType$inboundSchema: z.ZodType<
2796
+ FloorType,
2797
+ z.ZodTypeDef,
2798
+ unknown
2799
+ > = openEnums.inboundSchema(FloorType);
2800
+
2801
+ /** @internal */
2802
+ export const InsulationType$inboundSchema: z.ZodType<
2803
+ InsulationType,
2804
+ z.ZodTypeDef,
2805
+ unknown
2806
+ > = openEnums.inboundSchema(InsulationType);
2807
+
2808
+ /** @internal */
2809
+ export const Floor$inboundSchema: z.ZodType<Floor, z.ZodTypeDef, unknown> = z
2810
+ .object({
2811
+ dataQuality: z.nullable(DataQuality$inboundSchema),
2812
+ description: z.nullable(z.string()),
2813
+ energyEfficiency: z.nullable(
2814
+ GetEpcByLocationIdEnergyEfficiency$inboundSchema,
2815
+ ),
2816
+ environmentalEfficiency: z.nullable(
2817
+ GetEpcByLocationIdEnvironmentalEfficiency$inboundSchema,
2818
+ ),
2819
+ floorType: z.nullable(FloorType$inboundSchema),
2820
+ insulationAssumed: z.boolean(),
2821
+ insulationPresent: z.nullable(z.boolean()),
2822
+ insulationType: z.nullable(InsulationType$inboundSchema),
2823
+ thermalTransmittance: z.nullable(z.number()),
2824
+ });
2825
+
2826
+ export function floorFromJSON(
2827
+ jsonString: string,
2828
+ ): SafeParseResult<Floor, SDKValidationError> {
2829
+ return safeParse(
2830
+ jsonString,
2831
+ (x) => Floor$inboundSchema.parse(JSON.parse(x)),
2832
+ `Failed to parse 'Floor' from JSON`,
2833
+ );
2834
+ }
2835
+
2836
+ /** @internal */
2837
+ export const GetEPCByLocationIdEPCEnergyEfficiency$inboundSchema: z.ZodType<
2838
+ GetEPCByLocationIdEPCEnergyEfficiency,
2839
+ z.ZodTypeDef,
2840
+ unknown
2841
+ > = openEnums.inboundSchema(GetEPCByLocationIdEPCEnergyEfficiency);
2842
+
2843
+ /** @internal */
2844
+ export const GetEPCByLocationIdEPCEnvironmentalEfficiency$inboundSchema:
2845
+ z.ZodType<
2846
+ GetEPCByLocationIdEPCEnvironmentalEfficiency,
2847
+ z.ZodTypeDef,
2848
+ unknown
2849
+ > = openEnums.inboundSchema(GetEPCByLocationIdEPCEnvironmentalEfficiency);
2850
+
2851
+ /** @internal */
2852
+ export const HeatingControls$inboundSchema: z.ZodType<
2853
+ HeatingControls,
2854
+ z.ZodTypeDef,
2855
+ unknown
2856
+ > = z.object({
2857
+ description: z.nullable(z.string()),
2858
+ energyEfficiency: z.nullable(
2859
+ GetEPCByLocationIdEPCEnergyEfficiency$inboundSchema,
2860
+ ),
2861
+ environmentalEfficiency: z.nullable(
2862
+ GetEPCByLocationIdEPCEnvironmentalEfficiency$inboundSchema,
2863
+ ),
2864
+ });
2865
+
2866
+ export function heatingControlsFromJSON(
2867
+ jsonString: string,
2868
+ ): SafeParseResult<HeatingControls, SDKValidationError> {
2869
+ return safeParse(
2870
+ jsonString,
2871
+ (x) => HeatingControls$inboundSchema.parse(JSON.parse(x)),
2872
+ `Failed to parse 'HeatingControls' from JSON`,
2873
+ );
2874
+ }
2875
+
2876
+ /** @internal */
2877
+ export const GetEPCByLocationIdEPCResponseEnergyEfficiency$inboundSchema:
2878
+ z.ZodType<
2879
+ GetEPCByLocationIdEPCResponseEnergyEfficiency,
2880
+ z.ZodTypeDef,
2881
+ unknown
2882
+ > = openEnums.inboundSchema(GetEPCByLocationIdEPCResponseEnergyEfficiency);
2883
+
2884
+ /** @internal */
2885
+ export const GetEPCByLocationIdEPCResponseEnvironmentalEfficiency$inboundSchema:
2886
+ z.ZodType<
2887
+ GetEPCByLocationIdEPCResponseEnvironmentalEfficiency,
2888
+ z.ZodTypeDef,
2889
+ unknown
2890
+ > = openEnums.inboundSchema(
2891
+ GetEPCByLocationIdEPCResponseEnvironmentalEfficiency,
2892
+ );
2893
+
2894
+ /** @internal */
2895
+ export const HotWater$inboundSchema: z.ZodType<
2896
+ HotWater,
2897
+ z.ZodTypeDef,
2898
+ unknown
2899
+ > = z.object({
2900
+ description: z.nullable(z.string()),
2901
+ energyEfficiency: z.nullable(
2902
+ GetEPCByLocationIdEPCResponseEnergyEfficiency$inboundSchema,
2903
+ ),
2904
+ environmentalEfficiency: z.nullable(
2905
+ GetEPCByLocationIdEPCResponseEnvironmentalEfficiency$inboundSchema,
2906
+ ),
2907
+ });
2908
+
2909
+ export function hotWaterFromJSON(
2910
+ jsonString: string,
2911
+ ): SafeParseResult<HotWater, SDKValidationError> {
2912
+ return safeParse(
2913
+ jsonString,
2914
+ (x) => HotWater$inboundSchema.parse(JSON.parse(x)),
2915
+ `Failed to parse 'HotWater' from JSON`,
2916
+ );
2917
+ }
2918
+
2919
+ /** @internal */
2920
+ export const GetEPCByLocationIdEPCResponse200EnergyEfficiency$inboundSchema:
2921
+ z.ZodType<
2922
+ GetEPCByLocationIdEPCResponse200EnergyEfficiency,
2923
+ z.ZodTypeDef,
2924
+ unknown
2925
+ > = openEnums.inboundSchema(GetEPCByLocationIdEPCResponse200EnergyEfficiency);
2926
+
2927
+ /** @internal */
2928
+ export const GetEPCByLocationIdEPCResponse200EnvironmentalEfficiency$inboundSchema:
2929
+ z.ZodType<
2930
+ GetEPCByLocationIdEPCResponse200EnvironmentalEfficiency,
2931
+ z.ZodTypeDef,
2932
+ unknown
2933
+ > = openEnums.inboundSchema(
2934
+ GetEPCByLocationIdEPCResponse200EnvironmentalEfficiency,
2935
+ );
2936
+
2937
+ /** @internal */
2938
+ export const Lighting$inboundSchema: z.ZodType<
2939
+ Lighting,
2940
+ z.ZodTypeDef,
2941
+ unknown
2942
+ > = z.object({
2943
+ description: z.nullable(z.string()),
2944
+ energyEfficiency: z.nullable(
2945
+ GetEPCByLocationIdEPCResponse200EnergyEfficiency$inboundSchema,
2946
+ ),
2947
+ environmentalEfficiency: z.nullable(
2948
+ GetEPCByLocationIdEPCResponse200EnvironmentalEfficiency$inboundSchema,
2949
+ ),
2950
+ });
2951
+
2952
+ export function lightingFromJSON(
2953
+ jsonString: string,
2954
+ ): SafeParseResult<Lighting, SDKValidationError> {
2955
+ return safeParse(
2956
+ jsonString,
2957
+ (x) => Lighting$inboundSchema.parse(JSON.parse(x)),
2958
+ `Failed to parse 'Lighting' from JSON`,
2959
+ );
2960
+ }
2961
+
2962
+ /** @internal */
2963
+ export const GetEpcByLocationIdDataQuality$inboundSchema: z.ZodType<
2964
+ GetEpcByLocationIdDataQuality,
2965
+ z.ZodTypeDef,
2966
+ unknown
2967
+ > = openEnums.inboundSchema(GetEpcByLocationIdDataQuality);
2968
+
2969
+ /** @internal */
2970
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONEnergyEfficiency$inboundSchema:
2971
+ z.ZodType<
2972
+ GetEPCByLocationIdEPCResponse200ApplicationJSONEnergyEfficiency,
2973
+ z.ZodTypeDef,
2974
+ unknown
2975
+ > = openEnums.inboundSchema(
2976
+ GetEPCByLocationIdEPCResponse200ApplicationJSONEnergyEfficiency,
2977
+ );
2978
+
2979
+ /** @internal */
2980
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONEnvironmentalEfficiency$inboundSchema:
2981
+ z.ZodType<
2982
+ GetEPCByLocationIdEPCResponse200ApplicationJSONEnvironmentalEfficiency,
2983
+ z.ZodTypeDef,
2984
+ unknown
2985
+ > = openEnums.inboundSchema(
2986
+ GetEPCByLocationIdEPCResponse200ApplicationJSONEnvironmentalEfficiency,
2987
+ );
2988
+
2989
+ /** @internal */
2990
+ export const Fuel$inboundSchema: z.ZodType<Fuel, z.ZodTypeDef, unknown> =
2991
+ openEnums.inboundSchema(Fuel);
2992
+
2993
+ /** @internal */
2994
+ export const HeatPumpType$inboundSchema: z.ZodType<
2995
+ HeatPumpType,
2996
+ z.ZodTypeDef,
2997
+ unknown
2998
+ > = openEnums.inboundSchema(HeatPumpType);
2999
+
3000
+ /** @internal */
3001
+ export const SystemType$inboundSchema: z.ZodType<
3002
+ SystemType,
3003
+ z.ZodTypeDef,
3004
+ unknown
3005
+ > = openEnums.inboundSchema(SystemType);
3006
+
3007
+ /** @internal */
3008
+ export const MainHeating$inboundSchema: z.ZodType<
3009
+ MainHeating,
3010
+ z.ZodTypeDef,
3011
+ unknown
3012
+ > = z.object({
3013
+ dataQuality: z.nullable(GetEpcByLocationIdDataQuality$inboundSchema),
3014
+ description: z.nullable(z.string()),
3015
+ energyEfficiency: z.nullable(
3016
+ GetEPCByLocationIdEPCResponse200ApplicationJSONEnergyEfficiency$inboundSchema,
3017
+ ),
3018
+ environmentalEfficiency: z.nullable(
3019
+ GetEPCByLocationIdEPCResponse200ApplicationJSONEnvironmentalEfficiency$inboundSchema,
3020
+ ),
3021
+ fuel: z.nullable(Fuel$inboundSchema),
3022
+ heatPumpType: z.nullable(HeatPumpType$inboundSchema),
3023
+ isMultiSystem: z.boolean(),
3024
+ systemType: z.nullable(SystemType$inboundSchema),
3025
+ });
3026
+
3027
+ export function mainHeatingFromJSON(
3028
+ jsonString: string,
3029
+ ): SafeParseResult<MainHeating, SDKValidationError> {
3030
+ return safeParse(
3031
+ jsonString,
3032
+ (x) => MainHeating$inboundSchema.parse(JSON.parse(x)),
3033
+ `Failed to parse 'MainHeating' from JSON`,
3034
+ );
3035
+ }
3036
+
3037
+ /** @internal */
3038
+ export const GetEPCByLocationIdEPCDataQuality$inboundSchema: z.ZodType<
3039
+ GetEPCByLocationIdEPCDataQuality,
3040
+ z.ZodTypeDef,
3041
+ unknown
3042
+ > = openEnums.inboundSchema(GetEPCByLocationIdEPCDataQuality);
3043
+
3044
+ /** @internal */
3045
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnergyEfficiency$inboundSchema:
3046
+ z.ZodType<
3047
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnergyEfficiency,
3048
+ z.ZodTypeDef,
3049
+ unknown
3050
+ > = openEnums.inboundSchema(
3051
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnergyEfficiency,
3052
+ );
3053
+
3054
+ /** @internal */
3055
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnvironmentalEfficiency$inboundSchema:
3056
+ z.ZodType<
3057
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnvironmentalEfficiency,
3058
+ z.ZodTypeDef,
3059
+ unknown
3060
+ > = openEnums.inboundSchema(
3061
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnvironmentalEfficiency,
3062
+ );
3063
+
3064
+ /** @internal */
3065
+ export const GetEpcByLocationIdInsulationType$inboundSchema: z.ZodType<
3066
+ GetEpcByLocationIdInsulationType,
3067
+ z.ZodTypeDef,
3068
+ unknown
3069
+ > = openEnums.inboundSchema(GetEpcByLocationIdInsulationType);
3070
+
3071
+ /** @internal */
3072
+ export const RoofType$inboundSchema: z.ZodType<
3073
+ RoofType,
3074
+ z.ZodTypeDef,
3075
+ unknown
3076
+ > = openEnums.inboundSchema(RoofType);
3077
+
3078
+ /** @internal */
3079
+ export const Roof$inboundSchema: z.ZodType<Roof, z.ZodTypeDef, unknown> = z
3080
+ .object({
3081
+ dataQuality: z.nullable(GetEPCByLocationIdEPCDataQuality$inboundSchema),
3082
+ description: z.nullable(z.string()),
3083
+ energyEfficiency: z.nullable(
3084
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnergyEfficiency$inboundSchema,
3085
+ ),
3086
+ environmentalEfficiency: z.nullable(
3087
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyEnvironmentalEfficiency$inboundSchema,
3088
+ ),
3089
+ insulationAssumed: z.boolean(),
3090
+ insulationDepthMm: z.nullable(z.number().int()),
3091
+ insulationPresent: z.nullable(z.boolean()),
3092
+ insulationType: z.nullable(GetEpcByLocationIdInsulationType$inboundSchema),
3093
+ roofType: z.nullable(RoofType$inboundSchema),
3094
+ thermalTransmittance: z.nullable(z.number()),
3095
+ });
3096
+
3097
+ export function roofFromJSON(
3098
+ jsonString: string,
3099
+ ): SafeParseResult<Roof, SDKValidationError> {
3100
+ return safeParse(
3101
+ jsonString,
3102
+ (x) => Roof$inboundSchema.parse(JSON.parse(x)),
3103
+ `Failed to parse 'Roof' from JSON`,
3104
+ );
3105
+ }
3106
+
3107
+ /** @internal */
3108
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnergyEfficiency$inboundSchema:
3109
+ z.ZodType<
3110
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnergyEfficiency,
3111
+ z.ZodTypeDef,
3112
+ unknown
3113
+ > = openEnums.inboundSchema(
3114
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnergyEfficiency,
3115
+ );
3116
+
3117
+ /** @internal */
3118
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnvironmentalEfficiency$inboundSchema:
3119
+ z.ZodType<
3120
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnvironmentalEfficiency,
3121
+ z.ZodTypeDef,
3122
+ unknown
3123
+ > = openEnums.inboundSchema(
3124
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnvironmentalEfficiency,
3125
+ );
3126
+
3127
+ /** @internal */
3128
+ export const SecondaryHeating$inboundSchema: z.ZodType<
3129
+ SecondaryHeating,
3130
+ z.ZodTypeDef,
3131
+ unknown
3132
+ > = z.object({
3133
+ description: z.nullable(z.string()),
3134
+ energyEfficiency: z.nullable(
3135
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnergyEfficiency$inboundSchema,
3136
+ ),
3137
+ environmentalEfficiency: z.nullable(
3138
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataEnvironmentalEfficiency$inboundSchema,
3139
+ ),
3140
+ });
3141
+
3142
+ export function secondaryHeatingFromJSON(
3143
+ jsonString: string,
3144
+ ): SafeParseResult<SecondaryHeating, SDKValidationError> {
3145
+ return safeParse(
3146
+ jsonString,
3147
+ (x) => SecondaryHeating$inboundSchema.parse(JSON.parse(x)),
3148
+ `Failed to parse 'SecondaryHeating' from JSON`,
3149
+ );
3150
+ }
3151
+
3152
+ /** @internal */
3153
+ export const Construction$inboundSchema: z.ZodType<
3154
+ Construction,
3155
+ z.ZodTypeDef,
3156
+ unknown
3157
+ > = openEnums.inboundSchema(Construction);
3158
+
3159
+ /** @internal */
3160
+ export const GetEPCByLocationIdEPCResponseDataQuality$inboundSchema: z.ZodType<
3161
+ GetEPCByLocationIdEPCResponseDataQuality,
3162
+ z.ZodTypeDef,
3163
+ unknown
3164
+ > = openEnums.inboundSchema(GetEPCByLocationIdEPCResponseDataQuality);
3165
+
3166
+ /** @internal */
3167
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnergyEfficiency$inboundSchema:
3168
+ z.ZodType<
3169
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnergyEfficiency,
3170
+ z.ZodTypeDef,
3171
+ unknown
3172
+ > = openEnums.inboundSchema(
3173
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnergyEfficiency,
3174
+ );
3175
+
3176
+ /** @internal */
3177
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnvironmentalEfficiency$inboundSchema:
3178
+ z.ZodType<
3179
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnvironmentalEfficiency,
3180
+ z.ZodTypeDef,
3181
+ unknown
3182
+ > = openEnums.inboundSchema(
3183
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnvironmentalEfficiency,
3184
+ );
3185
+
3186
+ /** @internal */
3187
+ export const GetEPCByLocationIdEPCInsulationType$inboundSchema: z.ZodType<
3188
+ GetEPCByLocationIdEPCInsulationType,
3189
+ z.ZodTypeDef,
3190
+ unknown
3191
+ > = openEnums.inboundSchema(GetEPCByLocationIdEPCInsulationType);
3192
+
3193
+ /** @internal */
3194
+ export const Walls$inboundSchema: z.ZodType<Walls, z.ZodTypeDef, unknown> = z
3195
+ .object({
3196
+ construction: z.nullable(Construction$inboundSchema),
3197
+ dataQuality: z.nullable(
3198
+ GetEPCByLocationIdEPCResponseDataQuality$inboundSchema,
3199
+ ),
3200
+ description: z.nullable(z.string()),
3201
+ energyEfficiency: z.nullable(
3202
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnergyEfficiency$inboundSchema,
3203
+ ),
3204
+ environmentalEfficiency: z.nullable(
3205
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricEnvironmentalEfficiency$inboundSchema,
3206
+ ),
3207
+ insulationAssumed: z.boolean(),
3208
+ insulationPresent: z.nullable(z.boolean()),
3209
+ insulationType: z.nullable(
3210
+ GetEPCByLocationIdEPCInsulationType$inboundSchema,
3211
+ ),
3212
+ material: z.nullable(z.string()),
3213
+ thermalTransmittance: z.nullable(z.number()),
3214
+ });
3215
+
3216
+ export function wallsFromJSON(
3217
+ jsonString: string,
3218
+ ): SafeParseResult<Walls, SDKValidationError> {
3219
+ return safeParse(
3220
+ jsonString,
3221
+ (x) => Walls$inboundSchema.parse(JSON.parse(x)),
3222
+ `Failed to parse 'Walls' from JSON`,
3223
+ );
3224
+ }
3225
+
3226
+ /** @internal */
3227
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnergyEfficiency$inboundSchema:
3228
+ z.ZodType<
3229
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnergyEfficiency,
3230
+ z.ZodTypeDef,
3231
+ unknown
3232
+ > = openEnums.inboundSchema(
3233
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnergyEfficiency,
3234
+ );
3235
+
3236
+ /** @internal */
3237
+ export const GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnvironmentalEfficiency$inboundSchema:
3238
+ z.ZodType<
3239
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnvironmentalEfficiency,
3240
+ z.ZodTypeDef,
3241
+ unknown
3242
+ > = openEnums.inboundSchema(
3243
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnvironmentalEfficiency,
3244
+ );
3245
+
3246
+ /** @internal */
3247
+ export const Windows$inboundSchema: z.ZodType<Windows, z.ZodTypeDef, unknown> =
3248
+ z.object({
3249
+ description: z.nullable(z.string()),
3250
+ energyEfficiency: z.nullable(
3251
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnergyEfficiency$inboundSchema,
3252
+ ),
3253
+ environmentalEfficiency: z.nullable(
3254
+ GetEPCByLocationIdEPCResponse200ApplicationJSONResponseBodyDataFabricWindowsEnvironmentalEfficiency$inboundSchema,
3255
+ ),
3256
+ });
3257
+
3258
+ export function windowsFromJSON(
3259
+ jsonString: string,
3260
+ ): SafeParseResult<Windows, SDKValidationError> {
3261
+ return safeParse(
3262
+ jsonString,
3263
+ (x) => Windows$inboundSchema.parse(JSON.parse(x)),
3264
+ `Failed to parse 'Windows' from JSON`,
3265
+ );
3266
+ }
3267
+
3268
+ /** @internal */
3269
+ export const Fabric$inboundSchema: z.ZodType<Fabric, z.ZodTypeDef, unknown> = z
3270
+ .object({
3271
+ airTightness: z.nullable(z.lazy(() => AirTightness$inboundSchema)),
3272
+ floor: z.lazy(() => Floor$inboundSchema),
3273
+ heatingControls: z.lazy(() => HeatingControls$inboundSchema),
3274
+ hotWater: z.lazy(() => HotWater$inboundSchema),
3275
+ lighting: z.lazy(() => Lighting$inboundSchema),
3276
+ mainHeating: z.lazy(() => MainHeating$inboundSchema),
3277
+ roof: z.lazy(() => Roof$inboundSchema),
3278
+ secondaryHeating: z.nullable(z.lazy(() => SecondaryHeating$inboundSchema)),
3279
+ walls: z.lazy(() => Walls$inboundSchema),
3280
+ windows: z.lazy(() => Windows$inboundSchema),
3281
+ });
3282
+
3283
+ export function fabricFromJSON(
3284
+ jsonString: string,
3285
+ ): SafeParseResult<Fabric, SDKValidationError> {
3286
+ return safeParse(
3287
+ jsonString,
3288
+ (x) => Fabric$inboundSchema.parse(JSON.parse(x)),
3289
+ `Failed to parse 'Fabric' from JSON`,
3290
+ );
3291
+ }
3292
+
3293
+ /** @internal */
3294
+ export const MeesCompliance$inboundSchema: z.ZodType<
3295
+ MeesCompliance,
3296
+ z.ZodTypeDef,
3297
+ unknown
3298
+ > = openEnums.inboundSchema(MeesCompliance);
3299
+
3300
+ /** @internal */
3301
+ export const BuildingCategory$inboundSchema: z.ZodType<
3302
+ BuildingCategory,
3303
+ z.ZodTypeDef,
3304
+ unknown
3305
+ > = openEnums.inboundSchema(BuildingCategory);
3306
+
3307
+ /** @internal */
3308
+ export const ElectricalUsage$inboundSchema: z.ZodType<
3309
+ ElectricalUsage,
3310
+ z.ZodTypeDef,
3311
+ unknown
3312
+ > = z.object({
3313
+ actual: z.number(),
3314
+ typical: z.number(),
3315
+ });
3316
+
3317
+ export function electricalUsageFromJSON(
3318
+ jsonString: string,
3319
+ ): SafeParseResult<ElectricalUsage, SDKValidationError> {
3320
+ return safeParse(
3321
+ jsonString,
3322
+ (x) => ElectricalUsage$inboundSchema.parse(JSON.parse(x)),
3323
+ `Failed to parse 'ElectricalUsage' from JSON`,
3324
+ );
3325
+ }
3326
+
3327
+ /** @internal */
3328
+ export const RatingBand$inboundSchema: z.ZodType<
3329
+ RatingBand,
3330
+ z.ZodTypeDef,
3331
+ unknown
3332
+ > = openEnums.inboundSchema(RatingBand);
486
3333
 
487
- /**
488
- * EPC records retrieved successfully
489
- */
490
- export type GetEpcByLocationIdResponseBody = {
491
- data: Array<Data>;
492
- hasMore: boolean;
493
- object: GetEpcByLocationIdObject;
494
- totalCount?: number | undefined;
495
- url: string;
496
- };
3334
+ /** @internal */
3335
+ export const ThermalUsage$inboundSchema: z.ZodType<
3336
+ ThermalUsage,
3337
+ z.ZodTypeDef,
3338
+ unknown
3339
+ > = z.object({
3340
+ actual: z.number(),
3341
+ typical: z.number(),
3342
+ });
3343
+
3344
+ export function thermalUsageFromJSON(
3345
+ jsonString: string,
3346
+ ): SafeParseResult<ThermalUsage, SDKValidationError> {
3347
+ return safeParse(
3348
+ jsonString,
3349
+ (x) => ThermalUsage$inboundSchema.parse(JSON.parse(x)),
3350
+ `Failed to parse 'ThermalUsage' from JSON`,
3351
+ );
3352
+ }
497
3353
 
498
3354
  /** @internal */
499
- export type GetEpcByLocationIdRequest$Outbound = {
500
- limit?: string | undefined;
501
- locationId: string;
502
- offset?: string | undefined;
503
- };
3355
+ export const OperationalPerformance$inboundSchema: z.ZodType<
3356
+ OperationalPerformance,
3357
+ z.ZodTypeDef,
3358
+ unknown
3359
+ > = z.object({
3360
+ assessmentEndDate: z.nullable(z.string()),
3361
+ buildingCategory: z.array(BuildingCategory$inboundSchema),
3362
+ currentRating: z.number(),
3363
+ electricalUsage: z.nullable(z.lazy(() => ElectricalUsage$inboundSchema)),
3364
+ mainBenchmark: z.nullable(z.string()),
3365
+ nominatedDate: z.nullable(z.string()),
3366
+ occupancyLevel: z.nullable(z.string()),
3367
+ ratingBand: RatingBand$inboundSchema,
3368
+ renewablesElectricalPercentage: z.nullable(z.number()),
3369
+ renewablesThermalPercentage: z.nullable(z.number()),
3370
+ thermalUsage: z.nullable(z.lazy(() => ThermalUsage$inboundSchema)),
3371
+ yr1Rating: z.nullable(z.number()),
3372
+ yr2Rating: z.nullable(z.number()),
3373
+ });
3374
+
3375
+ export function operationalPerformanceFromJSON(
3376
+ jsonString: string,
3377
+ ): SafeParseResult<OperationalPerformance, SDKValidationError> {
3378
+ return safeParse(
3379
+ jsonString,
3380
+ (x) => OperationalPerformance$inboundSchema.parse(JSON.parse(x)),
3381
+ `Failed to parse 'OperationalPerformance' from JSON`,
3382
+ );
3383
+ }
504
3384
 
505
3385
  /** @internal */
506
- export const GetEpcByLocationIdRequest$outboundSchema: z.ZodType<
507
- GetEpcByLocationIdRequest$Outbound,
3386
+ export const Band$inboundSchema: z.ZodType<Band, z.ZodTypeDef, unknown> =
3387
+ openEnums.inboundSchema(Band);
3388
+
3389
+ /** @internal */
3390
+ export const ScoreType$inboundSchema: z.ZodType<
3391
+ ScoreType,
508
3392
  z.ZodTypeDef,
509
- GetEpcByLocationIdRequest
3393
+ unknown
3394
+ > = openEnums.inboundSchema(ScoreType);
3395
+
3396
+ /** @internal */
3397
+ export const Current$inboundSchema: z.ZodType<Current, z.ZodTypeDef, unknown> =
3398
+ z.object({
3399
+ band: Band$inboundSchema,
3400
+ score: z.number(),
3401
+ scoreType: ScoreType$inboundSchema,
3402
+ });
3403
+
3404
+ export function currentFromJSON(
3405
+ jsonString: string,
3406
+ ): SafeParseResult<Current, SDKValidationError> {
3407
+ return safeParse(
3408
+ jsonString,
3409
+ (x) => Current$inboundSchema.parse(JSON.parse(x)),
3410
+ `Failed to parse 'Current' from JSON`,
3411
+ );
3412
+ }
3413
+
3414
+ /** @internal */
3415
+ export const GetEpcByLocationIdBand$inboundSchema: z.ZodType<
3416
+ GetEpcByLocationIdBand,
3417
+ z.ZodTypeDef,
3418
+ unknown
3419
+ > = openEnums.inboundSchema(GetEpcByLocationIdBand);
3420
+
3421
+ /** @internal */
3422
+ export const GetEpcByLocationIdScoreType$inboundSchema: z.ZodType<
3423
+ GetEpcByLocationIdScoreType,
3424
+ z.ZodTypeDef,
3425
+ unknown
3426
+ > = openEnums.inboundSchema(GetEpcByLocationIdScoreType);
3427
+
3428
+ /** @internal */
3429
+ export const Potential$inboundSchema: z.ZodType<
3430
+ Potential,
3431
+ z.ZodTypeDef,
3432
+ unknown
510
3433
  > = z.object({
511
- limit: z.string().optional(),
512
- locationId: z.string(),
513
- offset: z.string().optional(),
3434
+ band: GetEpcByLocationIdBand$inboundSchema,
3435
+ score: z.number(),
3436
+ scoreType: GetEpcByLocationIdScoreType$inboundSchema,
514
3437
  });
515
3438
 
516
- export function getEpcByLocationIdRequestToJSON(
517
- getEpcByLocationIdRequest: GetEpcByLocationIdRequest,
518
- ): string {
519
- return JSON.stringify(
520
- GetEpcByLocationIdRequest$outboundSchema.parse(getEpcByLocationIdRequest),
3439
+ export function potentialFromJSON(
3440
+ jsonString: string,
3441
+ ): SafeParseResult<Potential, SDKValidationError> {
3442
+ return safeParse(
3443
+ jsonString,
3444
+ (x) => Potential$inboundSchema.parse(JSON.parse(x)),
3445
+ `Failed to parse 'Potential' from JSON`,
521
3446
  );
522
3447
  }
523
3448
 
524
3449
  /** @internal */
525
- export const ConstructionAge$inboundSchema: z.ZodType<
526
- ConstructionAge,
3450
+ export const Rating$inboundSchema: z.ZodType<Rating, z.ZodTypeDef, unknown> = z
3451
+ .object({
3452
+ carbonNeutral: z.boolean(),
3453
+ current: z.lazy(() => Current$inboundSchema),
3454
+ potential: z.nullable(z.lazy(() => Potential$inboundSchema)),
3455
+ });
3456
+
3457
+ export function ratingFromJSON(
3458
+ jsonString: string,
3459
+ ): SafeParseResult<Rating, SDKValidationError> {
3460
+ return safeParse(
3461
+ jsonString,
3462
+ (x) => Rating$inboundSchema.parse(JSON.parse(x)),
3463
+ `Failed to parse 'Rating' from JSON`,
3464
+ );
3465
+ }
3466
+
3467
+ /** @internal */
3468
+ export const GetEpcByLocationIdCategory$inboundSchema: z.ZodType<
3469
+ GetEpcByLocationIdCategory,
3470
+ z.ZodTypeDef,
3471
+ unknown
3472
+ > = openEnums.inboundSchema(GetEpcByLocationIdCategory);
3473
+
3474
+ /** @internal */
3475
+ export const Co2Impact$inboundSchema: z.ZodType<
3476
+ Co2Impact,
3477
+ z.ZodTypeDef,
3478
+ unknown
3479
+ > = openEnums.inboundSchema(Co2Impact);
3480
+
3481
+ /** @internal */
3482
+ export const Currency$inboundSchema: z.ZodNativeEnum<typeof Currency> = z
3483
+ .nativeEnum(Currency);
3484
+
3485
+ /** @internal */
3486
+ export const Cost$inboundSchema: z.ZodType<Cost, z.ZodTypeDef, unknown> = z
3487
+ .object({
3488
+ currency: Currency$inboundSchema,
3489
+ indicative: z.nullable(z.string()),
3490
+ max: z.nullable(z.number().int()),
3491
+ min: z.nullable(z.number().int()),
3492
+ year: z.nullable(z.number().int()),
3493
+ });
3494
+
3495
+ export function costFromJSON(
3496
+ jsonString: string,
3497
+ ): SafeParseResult<Cost, SDKValidationError> {
3498
+ return safeParse(
3499
+ jsonString,
3500
+ (x) => Cost$inboundSchema.parse(JSON.parse(x)),
3501
+ `Failed to parse 'Cost' from JSON`,
3502
+ );
3503
+ }
3504
+
3505
+ /** @internal */
3506
+ export const Measure$inboundSchema: z.ZodType<Measure, z.ZodTypeDef, unknown> =
3507
+ openEnums.inboundSchema(Measure);
3508
+
3509
+ /** @internal */
3510
+ export const PaybackType$inboundSchema: z.ZodType<
3511
+ PaybackType,
3512
+ z.ZodTypeDef,
3513
+ unknown
3514
+ > = openEnums.inboundSchema(PaybackType);
3515
+
3516
+ /** @internal */
3517
+ export const ProjectedRating$inboundSchema: z.ZodType<
3518
+ ProjectedRating,
527
3519
  z.ZodTypeDef,
528
3520
  unknown
529
3521
  > = z.object({
530
- band: z.string().optional(),
531
- description: z.string().optional(),
532
- yearFrom: z.number().optional(),
533
- yearTo: z.number().optional(),
3522
+ band: z.nullable(z.string()),
3523
+ energyScore: z.nullable(z.number().int()),
3524
+ environmentalScore: z.nullable(z.number().int()),
534
3525
  });
535
3526
 
536
- export function constructionAgeFromJSON(
3527
+ export function projectedRatingFromJSON(
537
3528
  jsonString: string,
538
- ): SafeParseResult<ConstructionAge, SDKValidationError> {
3529
+ ): SafeParseResult<ProjectedRating, SDKValidationError> {
539
3530
  return safeParse(
540
3531
  jsonString,
541
- (x) => ConstructionAge$inboundSchema.parse(JSON.parse(x)),
542
- `Failed to parse 'ConstructionAge' from JSON`,
3532
+ (x) => ProjectedRating$inboundSchema.parse(JSON.parse(x)),
3533
+ `Failed to parse 'ProjectedRating' from JSON`,
3534
+ );
3535
+ }
3536
+
3537
+ /** @internal */
3538
+ export const GetEpcByLocationIdCurrency$inboundSchema: z.ZodNativeEnum<
3539
+ typeof GetEpcByLocationIdCurrency
3540
+ > = z.nativeEnum(GetEpcByLocationIdCurrency);
3541
+
3542
+ /** @internal */
3543
+ export const Saving$inboundSchema: z.ZodType<Saving, z.ZodTypeDef, unknown> = z
3544
+ .object({
3545
+ annual: z.nullable(z.number().int()),
3546
+ currency: GetEpcByLocationIdCurrency$inboundSchema,
3547
+ });
3548
+
3549
+ export function savingFromJSON(
3550
+ jsonString: string,
3551
+ ): SafeParseResult<Saving, SDKValidationError> {
3552
+ return safeParse(
3553
+ jsonString,
3554
+ (x) => Saving$inboundSchema.parse(JSON.parse(x)),
3555
+ `Failed to parse 'Saving' from JSON`,
3556
+ );
3557
+ }
3558
+
3559
+ /** @internal */
3560
+ export const Recommendations$inboundSchema: z.ZodType<
3561
+ Recommendations,
3562
+ z.ZodTypeDef,
3563
+ unknown
3564
+ > = z.object({
3565
+ category: z.nullable(GetEpcByLocationIdCategory$inboundSchema),
3566
+ co2Impact: z.nullable(Co2Impact$inboundSchema),
3567
+ cost: z.nullable(z.lazy(() => Cost$inboundSchema)),
3568
+ description: z.nullable(z.string()),
3569
+ greenDealEligible: z.nullable(z.boolean()),
3570
+ measure: z.nullable(Measure$inboundSchema),
3571
+ measureCode: z.nullable(z.string()),
3572
+ paybackType: z.nullable(PaybackType$inboundSchema),
3573
+ projectedRating: z.nullable(z.lazy(() => ProjectedRating$inboundSchema)),
3574
+ saving: z.nullable(z.lazy(() => Saving$inboundSchema)),
3575
+ sequence: z.number().int(),
3576
+ summary: z.nullable(z.string()),
3577
+ });
3578
+
3579
+ export function recommendationsFromJSON(
3580
+ jsonString: string,
3581
+ ): SafeParseResult<Recommendations, SDKValidationError> {
3582
+ return safeParse(
3583
+ jsonString,
3584
+ (x) => Recommendations$inboundSchema.parse(JSON.parse(x)),
3585
+ `Failed to parse 'Recommendations' from JSON`,
3586
+ );
3587
+ }
3588
+
3589
+ /** @internal */
3590
+ export const Heating$inboundSchema: z.ZodType<Heating, z.ZodTypeDef, unknown> =
3591
+ z.object({
3592
+ current: z.number().int(),
3593
+ potential: z.number().int(),
3594
+ });
3595
+
3596
+ export function heatingFromJSON(
3597
+ jsonString: string,
3598
+ ): SafeParseResult<Heating, SDKValidationError> {
3599
+ return safeParse(
3600
+ jsonString,
3601
+ (x) => Heating$inboundSchema.parse(JSON.parse(x)),
3602
+ `Failed to parse 'Heating' from JSON`,
3603
+ );
3604
+ }
3605
+
3606
+ /** @internal */
3607
+ export const GetEpcByLocationIdHotWater$inboundSchema: z.ZodType<
3608
+ GetEpcByLocationIdHotWater,
3609
+ z.ZodTypeDef,
3610
+ unknown
3611
+ > = z.object({
3612
+ current: z.number().int(),
3613
+ potential: z.number().int(),
3614
+ });
3615
+
3616
+ export function getEpcByLocationIdHotWaterFromJSON(
3617
+ jsonString: string,
3618
+ ): SafeParseResult<GetEpcByLocationIdHotWater, SDKValidationError> {
3619
+ return safeParse(
3620
+ jsonString,
3621
+ (x) => GetEpcByLocationIdHotWater$inboundSchema.parse(JSON.parse(x)),
3622
+ `Failed to parse 'GetEpcByLocationIdHotWater' from JSON`,
3623
+ );
3624
+ }
3625
+
3626
+ /** @internal */
3627
+ export const GetEpcByLocationIdLighting$inboundSchema: z.ZodType<
3628
+ GetEpcByLocationIdLighting,
3629
+ z.ZodTypeDef,
3630
+ unknown
3631
+ > = z.object({
3632
+ current: z.number().int(),
3633
+ potential: z.number().int(),
3634
+ });
3635
+
3636
+ export function getEpcByLocationIdLightingFromJSON(
3637
+ jsonString: string,
3638
+ ): SafeParseResult<GetEpcByLocationIdLighting, SDKValidationError> {
3639
+ return safeParse(
3640
+ jsonString,
3641
+ (x) => GetEpcByLocationIdLighting$inboundSchema.parse(JSON.parse(x)),
3642
+ `Failed to parse 'GetEpcByLocationIdLighting' from JSON`,
3643
+ );
3644
+ }
3645
+
3646
+ /** @internal */
3647
+ export const RunningCosts$inboundSchema: z.ZodType<
3648
+ RunningCosts,
3649
+ z.ZodTypeDef,
3650
+ unknown
3651
+ > = z.object({
3652
+ heating: z.lazy(() => Heating$inboundSchema),
3653
+ hotWater: z.lazy(() => GetEpcByLocationIdHotWater$inboundSchema),
3654
+ lighting: z.lazy(() => GetEpcByLocationIdLighting$inboundSchema),
3655
+ });
3656
+
3657
+ export function runningCostsFromJSON(
3658
+ jsonString: string,
3659
+ ): SafeParseResult<RunningCosts, SDKValidationError> {
3660
+ return safeParse(
3661
+ jsonString,
3662
+ (x) => RunningCosts$inboundSchema.parse(JSON.parse(x)),
3663
+ `Failed to parse 'RunningCosts' from JSON`,
3664
+ );
3665
+ }
3666
+
3667
+ /** @internal */
3668
+ export const CurrentBand$inboundSchema: z.ZodType<
3669
+ CurrentBand,
3670
+ z.ZodTypeDef,
3671
+ unknown
3672
+ > = openEnums.inboundSchema(CurrentBand);
3673
+
3674
+ /** @internal */
3675
+ export const PotentialBand$inboundSchema: z.ZodType<
3676
+ PotentialBand,
3677
+ z.ZodTypeDef,
3678
+ unknown
3679
+ > = openEnums.inboundSchema(PotentialBand);
3680
+
3681
+ /** @internal */
3682
+ export const ScotlandNativeRating$inboundSchema: z.ZodType<
3683
+ ScotlandNativeRating,
3684
+ z.ZodTypeDef,
3685
+ unknown
3686
+ > = z.object({
3687
+ currentBand: CurrentBand$inboundSchema,
3688
+ currentRating: z.number(),
3689
+ potentialBand: z.nullable(PotentialBand$inboundSchema),
3690
+ potentialRating: z.nullable(z.number()),
3691
+ });
3692
+
3693
+ export function scotlandNativeRatingFromJSON(
3694
+ jsonString: string,
3695
+ ): SafeParseResult<ScotlandNativeRating, SDKValidationError> {
3696
+ return safeParse(
3697
+ jsonString,
3698
+ (x) => ScotlandNativeRating$inboundSchema.parse(JSON.parse(x)),
3699
+ `Failed to parse 'ScotlandNativeRating' from JSON`,
543
3700
  );
544
3701
  }
545
3702
 
546
3703
  /** @internal */
547
- export const GetEpcByLocationIdType$inboundSchema: z.ZodNativeEnum<
548
- typeof GetEpcByLocationIdType
549
- > = z.nativeEnum(GetEpcByLocationIdType);
3704
+ export const Source$inboundSchema: z.ZodType<Source, z.ZodTypeDef, unknown> =
3705
+ openEnums.inboundSchema(Source);
550
3706
 
551
3707
  /** @internal */
552
- export const GetEpcByLocationIdGeoJSONPoint$inboundSchema: z.ZodType<
553
- GetEpcByLocationIdGeoJSONPoint,
3708
+ export const InspectionStatus$inboundSchema: z.ZodType<
3709
+ InspectionStatus,
3710
+ z.ZodTypeDef,
3711
+ unknown
3712
+ > = openEnums.inboundSchema(InspectionStatus);
3713
+
3714
+ /** @internal */
3715
+ export const AirConditioning$inboundSchema: z.ZodType<
3716
+ AirConditioning,
554
3717
  z.ZodTypeDef,
555
3718
  unknown
556
3719
  > = z.object({
557
- coordinates: z.array(z.number()),
558
- type: GetEpcByLocationIdType$inboundSchema,
3720
+ estimatedKwRating: z.nullable(z.number()),
3721
+ inspectionStatus: z.nullable(InspectionStatus$inboundSchema),
3722
+ kwRating: z.nullable(z.number()),
3723
+ present: z.boolean(),
559
3724
  });
560
3725
 
561
- export function getEpcByLocationIdGeoJSONPointFromJSON(
3726
+ export function airConditioningFromJSON(
562
3727
  jsonString: string,
563
- ): SafeParseResult<GetEpcByLocationIdGeoJSONPoint, SDKValidationError> {
3728
+ ): SafeParseResult<AirConditioning, SDKValidationError> {
564
3729
  return safeParse(
565
3730
  jsonString,
566
- (x) => GetEpcByLocationIdGeoJSONPoint$inboundSchema.parse(JSON.parse(x)),
567
- `Failed to parse 'GetEpcByLocationIdGeoJSONPoint' from JSON`,
3731
+ (x) => AirConditioning$inboundSchema.parse(JSON.parse(x)),
3732
+ `Failed to parse 'AirConditioning' from JSON`,
568
3733
  );
569
3734
  }
570
3735
 
571
3736
  /** @internal */
572
- export const Location$inboundSchema: z.ZodType<
573
- Location,
3737
+ export const EnergyTariff$inboundSchema: z.ZodType<
3738
+ EnergyTariff,
3739
+ z.ZodTypeDef,
3740
+ unknown
3741
+ > = openEnums.inboundSchema(EnergyTariff);
3742
+
3743
+ /** @internal */
3744
+ export const HeatLossCorridor$inboundSchema: z.ZodType<
3745
+ HeatLossCorridor,
3746
+ z.ZodTypeDef,
3747
+ unknown
3748
+ > = openEnums.inboundSchema(HeatLossCorridor);
3749
+
3750
+ /** @internal */
3751
+ export const MainFuel$inboundSchema: z.ZodType<
3752
+ MainFuel,
3753
+ z.ZodTypeDef,
3754
+ unknown
3755
+ > = openEnums.inboundSchema(MainFuel);
3756
+
3757
+ /** @internal */
3758
+ export const Photovoltaic$inboundSchema: z.ZodType<
3759
+ Photovoltaic,
574
3760
  z.ZodTypeDef,
575
3761
  unknown
576
3762
  > = z.object({
577
- latitude: z.number().optional(),
578
- longitude: z.number().optional(),
579
- postcode: z.string().optional(),
3763
+ present: z.boolean(),
3764
+ supplyPercentage: z.nullable(z.number()),
580
3765
  });
581
3766
 
582
- export function locationFromJSON(
3767
+ export function photovoltaicFromJSON(
583
3768
  jsonString: string,
584
- ): SafeParseResult<Location, SDKValidationError> {
3769
+ ): SafeParseResult<Photovoltaic, SDKValidationError> {
585
3770
  return safeParse(
586
3771
  jsonString,
587
- (x) => Location$inboundSchema.parse(JSON.parse(x)),
588
- `Failed to parse 'Location' from JSON`,
3772
+ (x) => Photovoltaic$inboundSchema.parse(JSON.parse(x)),
3773
+ `Failed to parse 'Photovoltaic' from JSON`,
589
3774
  );
590
3775
  }
591
3776
 
592
3777
  /** @internal */
593
- export const RawAddress$inboundSchema: z.ZodType<
594
- RawAddress,
3778
+ export const Renewables$inboundSchema: z.ZodType<
3779
+ Renewables,
595
3780
  z.ZodTypeDef,
596
3781
  unknown
597
3782
  > = z.object({
598
- address1: z.string().optional(),
599
- address2: z.nullable(z.string()).optional(),
600
- address3: z.nullable(z.string()).optional(),
3783
+ description: z.nullable(z.string()),
3784
+ photovoltaic: z.nullable(z.lazy(() => Photovoltaic$inboundSchema)),
3785
+ solarThermal: z.nullable(z.boolean()),
3786
+ windTurbines: z.nullable(z.number().int()),
601
3787
  });
602
3788
 
603
- export function rawAddressFromJSON(
3789
+ export function renewablesFromJSON(
3790
+ jsonString: string,
3791
+ ): SafeParseResult<Renewables, SDKValidationError> {
3792
+ return safeParse(
3793
+ jsonString,
3794
+ (x) => Renewables$inboundSchema.parse(JSON.parse(x)),
3795
+ `Failed to parse 'Renewables' from JSON`,
3796
+ );
3797
+ }
3798
+
3799
+ /** @internal */
3800
+ export const Ventilation$inboundSchema: z.ZodType<
3801
+ Ventilation,
3802
+ z.ZodTypeDef,
3803
+ unknown
3804
+ > = openEnums.inboundSchema(Ventilation);
3805
+
3806
+ /** @internal */
3807
+ export const Systems$inboundSchema: z.ZodType<Systems, z.ZodTypeDef, unknown> =
3808
+ z.object({
3809
+ airConditioning: z.nullable(z.lazy(() => AirConditioning$inboundSchema)),
3810
+ energyTariff: z.nullable(EnergyTariff$inboundSchema),
3811
+ heatLossCorridor: z.nullable(HeatLossCorridor$inboundSchema),
3812
+ mainFuel: z.nullable(MainFuel$inboundSchema),
3813
+ mainFuelExternal: z.nullable(z.string()),
3814
+ mainHeatingControls: z.nullable(z.string()),
3815
+ mainsGas: z.nullable(z.boolean()),
3816
+ renewables: z.lazy(() => Renewables$inboundSchema),
3817
+ unheatedCorridorLength: z.nullable(z.number()),
3818
+ ventilation: z.nullable(Ventilation$inboundSchema),
3819
+ });
3820
+
3821
+ export function systemsFromJSON(
604
3822
  jsonString: string,
605
- ): SafeParseResult<RawAddress, SDKValidationError> {
3823
+ ): SafeParseResult<Systems, SDKValidationError> {
606
3824
  return safeParse(
607
3825
  jsonString,
608
- (x) => RawAddress$inboundSchema.parse(JSON.parse(x)),
609
- `Failed to parse 'RawAddress' from JSON`,
3826
+ (x) => Systems$inboundSchema.parse(JSON.parse(x)),
3827
+ `Failed to parse 'Systems' from JSON`,
610
3828
  );
611
3829
  }
612
3830
 
3831
+ /** @internal */
3832
+ export const TransactionType$inboundSchema: z.ZodType<
3833
+ TransactionType,
3834
+ z.ZodTypeDef,
3835
+ unknown
3836
+ > = openEnums.inboundSchema(TransactionType);
3837
+
613
3838
  /** @internal */
614
3839
  export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
615
3840
  .object({
3841
+ address: z.lazy(() => GetEpcByLocationIdAddress$inboundSchema),
3842
+ assessmentMethodology: AssessmentMethodology$inboundSchema,
3843
+ benchmarks: z.nullable(z.lazy(() => Benchmarks$inboundSchema)),
616
3844
  buildingReferenceNumber: z.nullable(z.string()),
617
- builtForm: z.nullable(z.string()),
618
- co2EmissCurrPerFloorArea: z.nullable(z.number()),
619
- co2EmissionsCurrent: z.nullable(z.number()),
620
- co2EmissionsPotential: z.nullable(z.number()),
3845
+ certificateType: GetEpcByLocationIdCertificateType$inboundSchema,
621
3846
  constituency: z.nullable(z.string()),
622
3847
  constituencyLabel: z.nullable(z.string()),
623
- constructionAge: z.nullable(z.lazy(() => ConstructionAge$inboundSchema))
624
- .optional(),
625
- coordinates: z.nullable(
626
- z.lazy(() => GetEpcByLocationIdGeoJSONPoint$inboundSchema),
627
- ),
3848
+ coordinates: z.nullable(z.lazy(() => Coordinates$inboundSchema)),
628
3849
  county: z.nullable(z.string()),
629
3850
  createdAt: z.string(),
630
- currentEnergyEfficiency: z.nullable(z.number()),
631
- currentEnergyRating: z.nullable(z.string()),
632
- displayAddress: z.nullable(z.string()),
633
- energyConsumptionCurrent: z.nullable(z.number()),
634
- energyConsumptionPotential: z.nullable(z.number()),
635
- energyTariff: z.nullable(z.string()),
636
- environmentImpactCurrent: z.nullable(z.number()),
637
- environmentImpactPotential: z.nullable(z.number()),
638
- extensionCount: z.nullable(z.number()),
639
- flatStoreyCount: z.nullable(z.string()),
640
- flatTopStorey: z.nullable(z.string()),
641
- floorDescription: z.nullable(z.string()),
642
- floorEnergyEff: z.nullable(z.string()),
643
- floorEnvEff: z.nullable(z.string()),
644
- floorHeight: z.nullable(z.number()),
645
- floorLevel: z.nullable(z.string()),
646
- glazedArea: z.nullable(z.string()),
647
- glazedType: z.nullable(z.string()),
648
- heatLossCorridoor: z.nullable(z.string()),
649
- heatingCostCurrent: z.nullable(z.number()),
650
- heatingCostPotential: z.nullable(z.number()),
651
- hotWaterCostCurrent: z.nullable(z.number()),
652
- hotWaterCostPotential: z.nullable(z.number()),
653
- hotWaterEnergyEff: z.nullable(z.string()),
654
- hotWaterEnvEff: z.nullable(z.string()),
655
- hotwaterDescription: z.nullable(z.string()),
656
- id: z.number(),
657
- inspectionDate: z.nullable(z.string()),
658
- inspectionId: z.string(),
659
- lightingCostCurrent: z.nullable(z.number()),
660
- lightingCostPotential: z.nullable(z.number()),
661
- lightingDescription: z.nullable(z.string()),
662
- lightingEnergyEff: z.nullable(z.string()),
663
- lightingEnvEff: z.nullable(z.string()),
3851
+ dataZone: z.nullable(z.string()),
3852
+ domesticDetails: z.nullable(z.lazy(() => DomesticDetails$inboundSchema)),
3853
+ emissions: z.lazy(() => Emissions$inboundSchema),
3854
+ fabric: z.nullable(z.lazy(() => Fabric$inboundSchema)),
3855
+ id: z.string(),
3856
+ inspectionDate: z.string(),
664
3857
  localAuthority: z.nullable(z.string()),
665
3858
  localAuthorityLabel: z.nullable(z.string()),
666
- location: z.lazy(() => Location$inboundSchema),
667
- locationId: z.nullable(z.number()),
668
- lodgementDate: z.nullable(z.string()),
669
- lowEnergyLighting: z.nullable(z.number()),
670
- mainFuel: z.nullable(z.string()),
671
- mainHeatingControls: z.nullable(z.string()),
672
- mainheatDescription: z.nullable(z.string()),
673
- mainheatEnergyEff: z.nullable(z.string()),
674
- mainheatEnvEff: z.nullable(z.string()),
675
- mainheatcEnergyEff: z.nullable(z.string()),
676
- mainheatcEnvEff: z.nullable(z.string()),
677
- mainheatcontDescription: z.nullable(z.string()),
678
- mainsGasFlag: z.nullable(z.string()),
679
- mechanicalVentilation: z.nullable(z.string()),
680
- multiGlazeProportion: z.nullable(z.number()),
681
- numberHabitableRooms: z.nullable(z.number()),
682
- numberHeatedRooms: z.nullable(z.number()),
683
- numberOpenFireplaces: z.nullable(z.number()),
684
- photoSupply: z.nullable(z.string()),
685
- postcodeNoSpace: z.string(),
686
- potentialEnergyEfficiency: z.nullable(z.number()),
687
- potentialEnergyRating: z.nullable(z.string()),
3859
+ locationId: z.nullable(z.number().int()),
3860
+ lodgementDate: z.string(),
3861
+ meesCompliance: MeesCompliance$inboundSchema,
3862
+ operationalPerformance: z.nullable(
3863
+ z.lazy(() => OperationalPerformance$inboundSchema),
3864
+ ),
688
3865
  propertyType: z.nullable(z.string()),
689
- rawAddress: z.lazy(() => RawAddress$inboundSchema),
690
- roofDescription: z.nullable(z.string()),
691
- roofEnergyEff: z.nullable(z.string()),
692
- roofEnvEff: z.nullable(z.string()),
693
- secondheatDescription: z.nullable(z.string()),
694
- sheatingEnergyEff: z.nullable(z.string()),
695
- sheatingEnvEff: z.nullable(z.string()),
696
- solarWaterHeatingFlag: z.nullable(z.string()),
697
- source: z.string(),
698
- tenure: z.nullable(z.string()),
3866
+ propertyTypeExternal: z.nullable(z.string()),
3867
+ rating: z.lazy(() => Rating$inboundSchema),
3868
+ recommendations: z.array(z.lazy(() => Recommendations$inboundSchema)),
3869
+ runningCosts: z.nullable(z.lazy(() => RunningCosts$inboundSchema)),
3870
+ scotlandNativeRating: z.nullable(
3871
+ z.lazy(() => ScotlandNativeRating$inboundSchema),
3872
+ ),
3873
+ source: Source$inboundSchema,
3874
+ sourceReference: z.string(),
3875
+ systems: z.lazy(() => Systems$inboundSchema),
699
3876
  totalFloorArea: z.nullable(z.number()),
700
- transactionType: z.nullable(z.string()),
701
- unheatedCorridorLength: z.nullable(z.number()),
3877
+ transactionType: z.nullable(TransactionType$inboundSchema),
3878
+ transactionTypeExternal: z.nullable(z.string()),
702
3879
  updatedAt: z.string(),
703
- wallsDescription: z.nullable(z.string()),
704
- wallsEnergyEff: z.nullable(z.string()),
705
- wallsEnvEff: z.nullable(z.string()),
706
- windTurbineCount: z.nullable(z.number()),
707
- windowsDescription: z.nullable(z.string()),
708
- windowsEnergyEff: z.nullable(z.string()),
709
- windowsEnvEff: z.nullable(z.string()),
3880
+ validUntil: z.nullable(z.string()),
710
3881
  });
711
3882
 
712
3883
  export function dataFromJSON(