@vepler/sdk 2.42.0 → 2.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (767) hide show
  1. package/README.md +272 -198
  2. package/dist/commonjs/funcs/addressLookupPostcode.js +1 -0
  3. package/dist/commonjs/funcs/addressLookupPostcode.js.map +1 -1
  4. package/dist/commonjs/funcs/addressLookupUprn.js +1 -0
  5. package/dist/commonjs/funcs/addressLookupUprn.js.map +1 -1
  6. package/dist/commonjs/funcs/addressResolveAddress.d.ts +4 -1
  7. package/dist/commonjs/funcs/addressResolveAddress.d.ts.map +1 -1
  8. package/dist/commonjs/funcs/addressResolveAddress.js +4 -1
  9. package/dist/commonjs/funcs/addressResolveAddress.js.map +1 -1
  10. package/dist/commonjs/funcs/addressReverseGeocode.js +1 -0
  11. package/dist/commonjs/funcs/addressReverseGeocode.js.map +1 -1
  12. package/dist/commonjs/funcs/energyFindNearestSubstations.d.ts +27 -0
  13. package/dist/commonjs/funcs/energyFindNearestSubstations.d.ts.map +1 -0
  14. package/dist/commonjs/funcs/energyFindNearestSubstations.js +135 -0
  15. package/dist/commonjs/funcs/energyFindNearestSubstations.js.map +1 -0
  16. package/dist/commonjs/funcs/energyFindSupplyAreaByPoint.d.ts +22 -0
  17. package/dist/commonjs/funcs/energyFindSupplyAreaByPoint.d.ts.map +1 -0
  18. package/dist/commonjs/funcs/energyFindSupplyAreaByPoint.js +126 -0
  19. package/dist/commonjs/funcs/energyFindSupplyAreaByPoint.js.map +1 -0
  20. package/dist/commonjs/funcs/energyGetByProperty.d.ts +31 -0
  21. package/dist/commonjs/funcs/energyGetByProperty.d.ts.map +1 -0
  22. package/dist/commonjs/funcs/energyGetByProperty.js +142 -0
  23. package/dist/commonjs/funcs/energyGetByProperty.js.map +1 -0
  24. package/dist/commonjs/funcs/energyGetCapacity.d.ts +26 -0
  25. package/dist/commonjs/funcs/energyGetCapacity.d.ts.map +1 -0
  26. package/dist/commonjs/funcs/energyGetCapacity.js +136 -0
  27. package/dist/commonjs/funcs/energyGetCapacity.js.map +1 -0
  28. package/dist/commonjs/funcs/energyGetConnectionQueueBySubstation.d.ts +20 -0
  29. package/dist/commonjs/funcs/energyGetConnectionQueueBySubstation.d.ts.map +1 -0
  30. package/dist/commonjs/funcs/energyGetConnectionQueueBySubstation.js +127 -0
  31. package/dist/commonjs/funcs/energyGetConnectionQueueBySubstation.js.map +1 -0
  32. package/dist/commonjs/funcs/energyGetConnectionQueueEntry.d.ts +22 -0
  33. package/dist/commonjs/funcs/energyGetConnectionQueueEntry.d.ts.map +1 -0
  34. package/dist/commonjs/funcs/energyGetConnectionQueueEntry.js +131 -0
  35. package/dist/commonjs/funcs/energyGetConnectionQueueEntry.js.map +1 -0
  36. package/dist/commonjs/funcs/energyGetDFES.d.ts +28 -0
  37. package/dist/commonjs/funcs/energyGetDFES.d.ts.map +1 -0
  38. package/dist/commonjs/funcs/energyGetDFES.js +139 -0
  39. package/dist/commonjs/funcs/energyGetDFES.js.map +1 -0
  40. package/dist/commonjs/funcs/energyGetSubstation.d.ts +22 -0
  41. package/dist/commonjs/funcs/energyGetSubstation.d.ts.map +1 -0
  42. package/dist/commonjs/funcs/energyGetSubstation.js +127 -0
  43. package/dist/commonjs/funcs/energyGetSubstation.js.map +1 -0
  44. package/dist/commonjs/funcs/energySearchConnectionQueue.d.ts +33 -0
  45. package/dist/commonjs/funcs/energySearchConnectionQueue.d.ts.map +1 -0
  46. package/dist/commonjs/funcs/energySearchConnectionQueue.js +136 -0
  47. package/dist/commonjs/funcs/energySearchConnectionQueue.js.map +1 -0
  48. package/dist/commonjs/funcs/energySearchECR.d.ts +29 -0
  49. package/dist/commonjs/funcs/energySearchECR.d.ts.map +1 -0
  50. package/dist/commonjs/funcs/energySearchECR.js +138 -0
  51. package/dist/commonjs/funcs/energySearchECR.js.map +1 -0
  52. package/dist/commonjs/funcs/energySearchSubstations.d.ts +28 -0
  53. package/dist/commonjs/funcs/energySearchSubstations.d.ts.map +1 -0
  54. package/dist/commonjs/funcs/energySearchSubstations.js +131 -0
  55. package/dist/commonjs/funcs/energySearchSubstations.js.map +1 -0
  56. package/dist/commonjs/funcs/propertySearchProperties.d.ts +4 -1
  57. package/dist/commonjs/funcs/propertySearchProperties.d.ts.map +1 -1
  58. package/dist/commonjs/funcs/propertySearchProperties.js +4 -1
  59. package/dist/commonjs/funcs/propertySearchProperties.js.map +1 -1
  60. package/dist/commonjs/lib/config.d.ts +3 -3
  61. package/dist/commonjs/lib/config.js +3 -3
  62. package/dist/commonjs/lib/matchers.d.ts.map +1 -1
  63. package/dist/commonjs/lib/matchers.js +0 -1
  64. package/dist/commonjs/lib/matchers.js.map +1 -1
  65. package/dist/commonjs/lib/security.d.ts.map +1 -1
  66. package/dist/commonjs/lib/security.js +1 -2
  67. package/dist/commonjs/lib/security.js.map +1 -1
  68. package/dist/commonjs/sdk/address.d.ts +3 -1
  69. package/dist/commonjs/sdk/address.d.ts.map +1 -1
  70. package/dist/commonjs/sdk/address.js +2 -0
  71. package/dist/commonjs/sdk/address.js.map +1 -1
  72. package/dist/commonjs/sdk/energy.d.ts +172 -0
  73. package/dist/commonjs/sdk/energy.d.ts.map +1 -0
  74. package/dist/commonjs/sdk/energy.js +212 -0
  75. package/dist/commonjs/sdk/energy.js.map +1 -0
  76. package/dist/commonjs/sdk/models/errors/findnearestsubstations.d.ts +331 -0
  77. package/dist/commonjs/sdk/models/errors/findnearestsubstations.d.ts.map +1 -0
  78. package/dist/commonjs/sdk/models/errors/findnearestsubstations.js +325 -0
  79. package/dist/commonjs/sdk/models/errors/findnearestsubstations.js.map +1 -0
  80. package/dist/commonjs/sdk/models/errors/findsupplyareabypoint.d.ts +266 -0
  81. package/dist/commonjs/sdk/models/errors/findsupplyareabypoint.d.ts.map +1 -0
  82. package/dist/commonjs/sdk/models/errors/findsupplyareabypoint.js +269 -0
  83. package/dist/commonjs/sdk/models/errors/findsupplyareabypoint.js.map +1 -0
  84. package/dist/commonjs/sdk/models/errors/getareacoverage.d.ts +6 -6
  85. package/dist/commonjs/sdk/models/errors/getareacoverage.d.ts.map +1 -1
  86. package/dist/commonjs/sdk/models/errors/getareacoverage.js +3 -3
  87. package/dist/commonjs/sdk/models/errors/getareacoverage.js.map +1 -1
  88. package/dist/commonjs/sdk/models/errors/getareasbyfieldandids.d.ts +4 -4
  89. package/dist/commonjs/sdk/models/errors/getareasbyfieldandids.d.ts.map +1 -1
  90. package/dist/commonjs/sdk/models/errors/getareasbyfieldandids.js +2 -2
  91. package/dist/commonjs/sdk/models/errors/getareasbyfieldandids.js.map +1 -1
  92. package/dist/commonjs/sdk/models/errors/getareaswithinradius.d.ts +4 -4
  93. package/dist/commonjs/sdk/models/errors/getareaswithinradius.d.ts.map +1 -1
  94. package/dist/commonjs/sdk/models/errors/getareaswithinradius.js +2 -2
  95. package/dist/commonjs/sdk/models/errors/getareaswithinradius.js.map +1 -1
  96. package/dist/commonjs/sdk/models/errors/getborderingareas.d.ts +4 -4
  97. package/dist/commonjs/sdk/models/errors/getborderingareas.d.ts.map +1 -1
  98. package/dist/commonjs/sdk/models/errors/getborderingareas.js +2 -2
  99. package/dist/commonjs/sdk/models/errors/getborderingareas.js.map +1 -1
  100. package/dist/commonjs/sdk/models/errors/getchildareas.d.ts +4 -4
  101. package/dist/commonjs/sdk/models/errors/getchildareas.d.ts.map +1 -1
  102. package/dist/commonjs/sdk/models/errors/getchildareas.js +2 -2
  103. package/dist/commonjs/sdk/models/errors/getchildareas.js.map +1 -1
  104. package/dist/commonjs/sdk/models/errors/getconnectionqueuebysubstation.d.ts +266 -0
  105. package/dist/commonjs/sdk/models/errors/getconnectionqueuebysubstation.d.ts.map +1 -0
  106. package/dist/commonjs/sdk/models/errors/getconnectionqueuebysubstation.js +265 -0
  107. package/dist/commonjs/sdk/models/errors/getconnectionqueuebysubstation.js.map +1 -0
  108. package/dist/commonjs/sdk/models/errors/getconnectionqueueentry.d.ts +331 -0
  109. package/dist/commonjs/sdk/models/errors/getconnectionqueueentry.d.ts.map +1 -0
  110. package/dist/commonjs/sdk/models/errors/getconnectionqueueentry.js +325 -0
  111. package/dist/commonjs/sdk/models/errors/getconnectionqueueentry.js.map +1 -0
  112. package/dist/commonjs/sdk/models/errors/getconnectivityscores.d.ts +4 -4
  113. package/dist/commonjs/sdk/models/errors/getconnectivityscores.d.ts.map +1 -1
  114. package/dist/commonjs/sdk/models/errors/getconnectivityscores.js +2 -2
  115. package/dist/commonjs/sdk/models/errors/getconnectivityscores.js.map +1 -1
  116. package/dist/commonjs/sdk/models/errors/getenergyforproperty.d.ts +331 -0
  117. package/dist/commonjs/sdk/models/errors/getenergyforproperty.d.ts.map +1 -0
  118. package/dist/commonjs/sdk/models/errors/getenergyforproperty.js +325 -0
  119. package/dist/commonjs/sdk/models/errors/getenergyforproperty.js.map +1 -0
  120. package/dist/commonjs/sdk/models/errors/getmetricvalues.d.ts +4 -4
  121. package/dist/commonjs/sdk/models/errors/getmetricvalues.d.ts.map +1 -1
  122. package/dist/commonjs/sdk/models/errors/getmetricvalues.js +2 -2
  123. package/dist/commonjs/sdk/models/errors/getmetricvalues.js.map +1 -1
  124. package/dist/commonjs/sdk/models/errors/getnearestpoi.d.ts +4 -4
  125. package/dist/commonjs/sdk/models/errors/getnearestpoi.d.ts.map +1 -1
  126. package/dist/commonjs/sdk/models/errors/getnearestpoi.js +2 -2
  127. package/dist/commonjs/sdk/models/errors/getnearestpoi.js.map +1 -1
  128. package/dist/commonjs/sdk/models/errors/getpoimultipletiles.d.ts +4 -4
  129. package/dist/commonjs/sdk/models/errors/getpoimultipletiles.d.ts.map +1 -1
  130. package/dist/commonjs/sdk/models/errors/getpoimultipletiles.js +2 -2
  131. package/dist/commonjs/sdk/models/errors/getpoimultipletiles.js.map +1 -1
  132. package/dist/commonjs/sdk/models/errors/getpoitile.d.ts +4 -4
  133. package/dist/commonjs/sdk/models/errors/getpoitile.d.ts.map +1 -1
  134. package/dist/commonjs/sdk/models/errors/getpoitile.js +2 -2
  135. package/dist/commonjs/sdk/models/errors/getpoitile.js.map +1 -1
  136. package/dist/commonjs/sdk/models/errors/getsubstationbycode.d.ts +331 -0
  137. package/dist/commonjs/sdk/models/errors/getsubstationbycode.d.ts.map +1 -0
  138. package/dist/commonjs/sdk/models/errors/getsubstationbycode.js +325 -0
  139. package/dist/commonjs/sdk/models/errors/getsubstationbycode.js.map +1 -0
  140. package/dist/commonjs/sdk/models/errors/getsubstationcapacity.d.ts +266 -0
  141. package/dist/commonjs/sdk/models/errors/getsubstationcapacity.d.ts.map +1 -0
  142. package/dist/commonjs/sdk/models/errors/getsubstationcapacity.js +269 -0
  143. package/dist/commonjs/sdk/models/errors/getsubstationcapacity.js.map +1 -0
  144. package/dist/commonjs/sdk/models/errors/getsubstationdfes.d.ts +266 -0
  145. package/dist/commonjs/sdk/models/errors/getsubstationdfes.d.ts.map +1 -0
  146. package/dist/commonjs/sdk/models/errors/getsubstationdfes.js +269 -0
  147. package/dist/commonjs/sdk/models/errors/getsubstationdfes.js.map +1 -0
  148. package/dist/commonjs/sdk/models/errors/index.d.ts +11 -0
  149. package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
  150. package/dist/commonjs/sdk/models/errors/index.js +11 -0
  151. package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
  152. package/dist/commonjs/sdk/models/errors/searchconnectionqueue.d.ts +266 -0
  153. package/dist/commonjs/sdk/models/errors/searchconnectionqueue.d.ts.map +1 -0
  154. package/dist/commonjs/sdk/models/errors/searchconnectionqueue.js +269 -0
  155. package/dist/commonjs/sdk/models/errors/searchconnectionqueue.js.map +1 -0
  156. package/dist/commonjs/sdk/models/errors/searchecr.d.ts +266 -0
  157. package/dist/commonjs/sdk/models/errors/searchecr.d.ts.map +1 -0
  158. package/dist/commonjs/sdk/models/errors/searchecr.js +269 -0
  159. package/dist/commonjs/sdk/models/errors/searchecr.js.map +1 -0
  160. package/dist/commonjs/sdk/models/errors/searchsubstations.d.ts +331 -0
  161. package/dist/commonjs/sdk/models/errors/searchsubstations.d.ts.map +1 -0
  162. package/dist/commonjs/sdk/models/errors/searchsubstations.js +325 -0
  163. package/dist/commonjs/sdk/models/errors/searchsubstations.js.map +1 -0
  164. package/dist/commonjs/sdk/models/operations/findnearestsubstations.d.ts +183 -0
  165. package/dist/commonjs/sdk/models/operations/findnearestsubstations.d.ts.map +1 -0
  166. package/dist/commonjs/sdk/models/operations/findnearestsubstations.js +121 -0
  167. package/dist/commonjs/sdk/models/operations/findnearestsubstations.js.map +1 -0
  168. package/dist/commonjs/sdk/models/operations/findsitesbyproperty.d.ts +0 -3
  169. package/dist/commonjs/sdk/models/operations/findsitesbyproperty.d.ts.map +1 -1
  170. package/dist/commonjs/sdk/models/operations/findsitesbyproperty.js.map +1 -1
  171. package/dist/commonjs/sdk/models/operations/findsupplyareabypoint.d.ts +139 -0
  172. package/dist/commonjs/sdk/models/operations/findsupplyareabypoint.d.ts.map +1 -0
  173. package/dist/commonjs/sdk/models/operations/findsupplyareabypoint.js +111 -0
  174. package/dist/commonjs/sdk/models/operations/findsupplyareabypoint.js.map +1 -0
  175. package/dist/commonjs/sdk/models/operations/getcompaniesbylocation.d.ts +0 -3
  176. package/dist/commonjs/sdk/models/operations/getcompaniesbylocation.d.ts.map +1 -1
  177. package/dist/commonjs/sdk/models/operations/getcompaniesbylocation.js.map +1 -1
  178. package/dist/commonjs/sdk/models/operations/getconnectionqueuebysubstation.d.ts +219 -0
  179. package/dist/commonjs/sdk/models/operations/getconnectionqueuebysubstation.d.ts.map +1 -0
  180. package/dist/commonjs/sdk/models/operations/getconnectionqueuebysubstation.js +139 -0
  181. package/dist/commonjs/sdk/models/operations/getconnectionqueuebysubstation.js.map +1 -0
  182. package/dist/commonjs/sdk/models/operations/getconnectionqueueentry.d.ts +184 -0
  183. package/dist/commonjs/sdk/models/operations/getconnectionqueueentry.d.ts.map +1 -0
  184. package/dist/commonjs/sdk/models/operations/getconnectionqueueentry.js +113 -0
  185. package/dist/commonjs/sdk/models/operations/getconnectionqueueentry.js.map +1 -0
  186. package/dist/commonjs/sdk/models/operations/getenergyforproperty.d.ts +642 -0
  187. package/dist/commonjs/sdk/models/operations/getenergyforproperty.d.ts.map +1 -0
  188. package/dist/commonjs/sdk/models/operations/getenergyforproperty.js +304 -0
  189. package/dist/commonjs/sdk/models/operations/getenergyforproperty.js.map +1 -0
  190. package/dist/commonjs/sdk/models/operations/getsubstationbycode.d.ts +115 -0
  191. package/dist/commonjs/sdk/models/operations/getsubstationbycode.d.ts.map +1 -0
  192. package/dist/commonjs/sdk/models/operations/getsubstationbycode.js +90 -0
  193. package/dist/commonjs/sdk/models/operations/getsubstationbycode.js.map +1 -0
  194. package/dist/commonjs/sdk/models/operations/getsubstationcapacity.d.ts +133 -0
  195. package/dist/commonjs/sdk/models/operations/getsubstationcapacity.d.ts.map +1 -0
  196. package/dist/commonjs/sdk/models/operations/getsubstationcapacity.js +105 -0
  197. package/dist/commonjs/sdk/models/operations/getsubstationcapacity.js.map +1 -0
  198. package/dist/commonjs/sdk/models/operations/getsubstationdfes.d.ts +130 -0
  199. package/dist/commonjs/sdk/models/operations/getsubstationdfes.d.ts.map +1 -0
  200. package/dist/commonjs/sdk/models/operations/getsubstationdfes.js +104 -0
  201. package/dist/commonjs/sdk/models/operations/getsubstationdfes.js.map +1 -0
  202. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.d.ts +1 -1
  203. package/dist/commonjs/sdk/models/operations/index.d.ts +11 -0
  204. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  205. package/dist/commonjs/sdk/models/operations/index.js +11 -0
  206. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  207. package/dist/commonjs/sdk/models/operations/lookuppostcode.d.ts +19 -0
  208. package/dist/commonjs/sdk/models/operations/lookuppostcode.d.ts.map +1 -1
  209. package/dist/commonjs/sdk/models/operations/lookuppostcode.js +12 -1
  210. package/dist/commonjs/sdk/models/operations/lookuppostcode.js.map +1 -1
  211. package/dist/commonjs/sdk/models/operations/lookupuprn.d.ts +19 -0
  212. package/dist/commonjs/sdk/models/operations/lookupuprn.d.ts.map +1 -1
  213. package/dist/commonjs/sdk/models/operations/lookupuprn.js +11 -1
  214. package/dist/commonjs/sdk/models/operations/lookupuprn.js.map +1 -1
  215. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts +0 -62
  216. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  217. package/dist/commonjs/sdk/models/operations/resolveaddress.js +1 -23
  218. package/dist/commonjs/sdk/models/operations/resolveaddress.js.map +1 -1
  219. package/dist/commonjs/sdk/models/operations/reversegeocode.d.ts +19 -0
  220. package/dist/commonjs/sdk/models/operations/reversegeocode.d.ts.map +1 -1
  221. package/dist/commonjs/sdk/models/operations/reversegeocode.js +11 -1
  222. package/dist/commonjs/sdk/models/operations/reversegeocode.js.map +1 -1
  223. package/dist/commonjs/sdk/models/operations/searchconnectionqueue.d.ts +277 -0
  224. package/dist/commonjs/sdk/models/operations/searchconnectionqueue.d.ts.map +1 -0
  225. package/dist/commonjs/sdk/models/operations/searchconnectionqueue.js +148 -0
  226. package/dist/commonjs/sdk/models/operations/searchconnectionqueue.js.map +1 -0
  227. package/dist/commonjs/sdk/models/operations/searchecr.d.ts +176 -0
  228. package/dist/commonjs/sdk/models/operations/searchecr.d.ts.map +1 -0
  229. package/dist/commonjs/sdk/models/operations/searchecr.js +119 -0
  230. package/dist/commonjs/sdk/models/operations/searchecr.js.map +1 -0
  231. package/dist/commonjs/sdk/models/operations/searchsubstations.d.ts +198 -0
  232. package/dist/commonjs/sdk/models/operations/searchsubstations.d.ts.map +1 -0
  233. package/dist/commonjs/sdk/models/operations/searchsubstations.js +124 -0
  234. package/dist/commonjs/sdk/models/operations/searchsubstations.js.map +1 -0
  235. package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts +81 -0
  236. package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts.map +1 -0
  237. package/dist/commonjs/sdk/models/shared/addressresolverequest.js +74 -0
  238. package/dist/commonjs/sdk/models/shared/addressresolverequest.js.map +1 -0
  239. package/dist/commonjs/sdk/models/shared/appointmentsresponse.d.ts +1 -1
  240. package/dist/commonjs/sdk/models/shared/appointmentsresponse.d.ts.map +1 -1
  241. package/dist/commonjs/sdk/models/shared/appointmentsresponse.js +1 -1
  242. package/dist/commonjs/sdk/models/shared/appointmentsresponse.js.map +1 -1
  243. package/dist/commonjs/sdk/models/shared/bulkpostcodelookuprequest.d.ts +19 -0
  244. package/dist/commonjs/sdk/models/shared/bulkpostcodelookuprequest.d.ts.map +1 -1
  245. package/dist/commonjs/sdk/models/shared/bulkpostcodelookuprequest.js +12 -1
  246. package/dist/commonjs/sdk/models/shared/bulkpostcodelookuprequest.js.map +1 -1
  247. package/dist/commonjs/sdk/models/shared/companiesbylocationresponse.d.ts +1 -1
  248. package/dist/commonjs/sdk/models/shared/companiesbylocationresponse.d.ts.map +1 -1
  249. package/dist/commonjs/sdk/models/shared/companiesbylocationresponse.js +1 -1
  250. package/dist/commonjs/sdk/models/shared/companiesbylocationresponse.js.map +1 -1
  251. package/dist/commonjs/sdk/models/shared/companylistresponse.d.ts +1 -1
  252. package/dist/commonjs/sdk/models/shared/companylistresponse.d.ts.map +1 -1
  253. package/dist/commonjs/sdk/models/shared/companylistresponse.js +1 -1
  254. package/dist/commonjs/sdk/models/shared/companylistresponse.js.map +1 -1
  255. package/dist/commonjs/sdk/models/shared/companyresponse.d.ts +1 -1
  256. package/dist/commonjs/sdk/models/shared/companyresponse.d.ts.map +1 -1
  257. package/dist/commonjs/sdk/models/shared/companyresponse.js +1 -1
  258. package/dist/commonjs/sdk/models/shared/companyresponse.js.map +1 -1
  259. package/dist/commonjs/sdk/models/shared/index.d.ts +9 -0
  260. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  261. package/dist/commonjs/sdk/models/shared/index.js +9 -0
  262. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  263. package/dist/commonjs/sdk/models/shared/listingimage.d.ts +4 -0
  264. package/dist/commonjs/sdk/models/shared/listingimage.d.ts.map +1 -1
  265. package/dist/commonjs/sdk/models/shared/listingimage.js +1 -0
  266. package/dist/commonjs/sdk/models/shared/listingimage.js.map +1 -1
  267. package/dist/commonjs/sdk/models/shared/officerlistresponse.d.ts +1 -1
  268. package/dist/commonjs/sdk/models/shared/officerlistresponse.d.ts.map +1 -1
  269. package/dist/commonjs/sdk/models/shared/officerlistresponse.js +1 -1
  270. package/dist/commonjs/sdk/models/shared/officerlistresponse.js.map +1 -1
  271. package/dist/commonjs/sdk/models/shared/officerresponse.d.ts +1 -1
  272. package/dist/commonjs/sdk/models/shared/officerresponse.d.ts.map +1 -1
  273. package/dist/commonjs/sdk/models/shared/officerresponse.js +1 -1
  274. package/dist/commonjs/sdk/models/shared/officerresponse.js.map +1 -1
  275. package/dist/commonjs/sdk/models/shared/personclusterresponse.d.ts +1 -1
  276. package/dist/commonjs/sdk/models/shared/personclusterresponse.d.ts.map +1 -1
  277. package/dist/commonjs/sdk/models/shared/personclusterresponse.js +1 -1
  278. package/dist/commonjs/sdk/models/shared/personclusterresponse.js.map +1 -1
  279. package/dist/commonjs/sdk/models/shared/personlistresponse.d.ts +1 -1
  280. package/dist/commonjs/sdk/models/shared/personlistresponse.d.ts.map +1 -1
  281. package/dist/commonjs/sdk/models/shared/personlistresponse.js +1 -1
  282. package/dist/commonjs/sdk/models/shared/personlistresponse.js.map +1 -1
  283. package/dist/commonjs/sdk/models/shared/personresponse.d.ts +1 -1
  284. package/dist/commonjs/sdk/models/shared/personresponse.d.ts.map +1 -1
  285. package/dist/commonjs/sdk/models/shared/personresponse.js +1 -1
  286. package/dist/commonjs/sdk/models/shared/personresponse.js.map +1 -1
  287. package/dist/commonjs/sdk/models/shared/planningaddress.d.ts +48 -0
  288. package/dist/commonjs/sdk/models/shared/planningaddress.d.ts.map +1 -0
  289. package/dist/commonjs/sdk/models/shared/planningaddress.js +58 -0
  290. package/dist/commonjs/sdk/models/shared/planningaddress.js.map +1 -0
  291. package/dist/commonjs/sdk/models/shared/planningagent.d.ts +17 -0
  292. package/dist/commonjs/sdk/models/shared/planningagent.d.ts.map +1 -0
  293. package/dist/commonjs/sdk/models/shared/planningagent.js +51 -0
  294. package/dist/commonjs/sdk/models/shared/planningagent.js.map +1 -0
  295. package/dist/commonjs/sdk/models/shared/planningapplicant.d.ts +17 -0
  296. package/dist/commonjs/sdk/models/shared/planningapplicant.d.ts.map +1 -0
  297. package/dist/commonjs/sdk/models/shared/planningapplicant.js +51 -0
  298. package/dist/commonjs/sdk/models/shared/planningapplicant.js.map +1 -0
  299. package/dist/commonjs/sdk/models/shared/planningapplication.d.ts +50 -0
  300. package/dist/commonjs/sdk/models/shared/planningapplication.d.ts.map +1 -1
  301. package/dist/commonjs/sdk/models/shared/planningapplication.js +18 -0
  302. package/dist/commonjs/sdk/models/shared/planningapplication.js.map +1 -1
  303. package/dist/commonjs/sdk/models/shared/planningconstraint.d.ts +25 -0
  304. package/dist/commonjs/sdk/models/shared/planningconstraint.d.ts.map +1 -0
  305. package/dist/commonjs/sdk/models/shared/planningconstraint.js +53 -0
  306. package/dist/commonjs/sdk/models/shared/planningconstraint.js.map +1 -0
  307. package/dist/commonjs/sdk/models/shared/planningdocument.d.ts +41 -0
  308. package/dist/commonjs/sdk/models/shared/planningdocument.d.ts.map +1 -0
  309. package/dist/commonjs/sdk/models/shared/planningdocument.js +57 -0
  310. package/dist/commonjs/sdk/models/shared/planningdocument.js.map +1 -0
  311. package/dist/commonjs/sdk/models/shared/planningpeople.d.ts +22 -0
  312. package/dist/commonjs/sdk/models/shared/planningpeople.d.ts.map +1 -0
  313. package/dist/commonjs/sdk/models/shared/planningpeople.js +53 -0
  314. package/dist/commonjs/sdk/models/shared/planningpeople.js.map +1 -0
  315. package/dist/commonjs/sdk/models/shared/planningrelatedcase.d.ts +21 -0
  316. package/dist/commonjs/sdk/models/shared/planningrelatedcase.d.ts.map +1 -0
  317. package/dist/commonjs/sdk/models/shared/planningrelatedcase.js +52 -0
  318. package/dist/commonjs/sdk/models/shared/planningrelatedcase.js.map +1 -0
  319. package/dist/commonjs/sdk/models/shared/planningstatushistory.d.ts +33 -0
  320. package/dist/commonjs/sdk/models/shared/planningstatushistory.d.ts.map +1 -0
  321. package/dist/commonjs/sdk/models/shared/planningstatushistory.js +55 -0
  322. package/dist/commonjs/sdk/models/shared/planningstatushistory.js.map +1 -0
  323. package/dist/commonjs/sdk/models/shared/propertyquerycondition.d.ts +1 -1
  324. package/dist/commonjs/sdk/models/shared/psclistresponse.d.ts +1 -1
  325. package/dist/commonjs/sdk/models/shared/psclistresponse.d.ts.map +1 -1
  326. package/dist/commonjs/sdk/models/shared/psclistresponse.js +1 -1
  327. package/dist/commonjs/sdk/models/shared/psclistresponse.js.map +1 -1
  328. package/dist/commonjs/sdk/models/shared/pscresponse.d.ts +1 -1
  329. package/dist/commonjs/sdk/models/shared/pscresponse.d.ts.map +1 -1
  330. package/dist/commonjs/sdk/models/shared/pscresponse.js +1 -1
  331. package/dist/commonjs/sdk/models/shared/pscresponse.js.map +1 -1
  332. package/dist/commonjs/sdk/property.d.ts +4 -1
  333. package/dist/commonjs/sdk/property.d.ts.map +1 -1
  334. package/dist/commonjs/sdk/property.js +4 -1
  335. package/dist/commonjs/sdk/property.js.map +1 -1
  336. package/dist/commonjs/sdk/sdk.d.ts +3 -0
  337. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  338. package/dist/commonjs/sdk/sdk.js +4 -0
  339. package/dist/commonjs/sdk/sdk.js.map +1 -1
  340. package/dist/esm/funcs/addressLookupPostcode.js +1 -0
  341. package/dist/esm/funcs/addressLookupPostcode.js.map +1 -1
  342. package/dist/esm/funcs/addressLookupUprn.js +1 -0
  343. package/dist/esm/funcs/addressLookupUprn.js.map +1 -1
  344. package/dist/esm/funcs/addressResolveAddress.d.ts +4 -1
  345. package/dist/esm/funcs/addressResolveAddress.d.ts.map +1 -1
  346. package/dist/esm/funcs/addressResolveAddress.js +4 -1
  347. package/dist/esm/funcs/addressResolveAddress.js.map +1 -1
  348. package/dist/esm/funcs/addressReverseGeocode.js +1 -0
  349. package/dist/esm/funcs/addressReverseGeocode.js.map +1 -1
  350. package/dist/esm/funcs/energyFindNearestSubstations.d.ts +27 -0
  351. package/dist/esm/funcs/energyFindNearestSubstations.d.ts.map +1 -0
  352. package/dist/esm/funcs/energyFindNearestSubstations.js +99 -0
  353. package/dist/esm/funcs/energyFindNearestSubstations.js.map +1 -0
  354. package/dist/esm/funcs/energyFindSupplyAreaByPoint.d.ts +22 -0
  355. package/dist/esm/funcs/energyFindSupplyAreaByPoint.d.ts.map +1 -0
  356. package/dist/esm/funcs/energyFindSupplyAreaByPoint.js +90 -0
  357. package/dist/esm/funcs/energyFindSupplyAreaByPoint.js.map +1 -0
  358. package/dist/esm/funcs/energyGetByProperty.d.ts +31 -0
  359. package/dist/esm/funcs/energyGetByProperty.d.ts.map +1 -0
  360. package/dist/esm/funcs/energyGetByProperty.js +106 -0
  361. package/dist/esm/funcs/energyGetByProperty.js.map +1 -0
  362. package/dist/esm/funcs/energyGetCapacity.d.ts +26 -0
  363. package/dist/esm/funcs/energyGetCapacity.d.ts.map +1 -0
  364. package/dist/esm/funcs/energyGetCapacity.js +100 -0
  365. package/dist/esm/funcs/energyGetCapacity.js.map +1 -0
  366. package/dist/esm/funcs/energyGetConnectionQueueBySubstation.d.ts +20 -0
  367. package/dist/esm/funcs/energyGetConnectionQueueBySubstation.d.ts.map +1 -0
  368. package/dist/esm/funcs/energyGetConnectionQueueBySubstation.js +91 -0
  369. package/dist/esm/funcs/energyGetConnectionQueueBySubstation.js.map +1 -0
  370. package/dist/esm/funcs/energyGetConnectionQueueEntry.d.ts +22 -0
  371. package/dist/esm/funcs/energyGetConnectionQueueEntry.d.ts.map +1 -0
  372. package/dist/esm/funcs/energyGetConnectionQueueEntry.js +95 -0
  373. package/dist/esm/funcs/energyGetConnectionQueueEntry.js.map +1 -0
  374. package/dist/esm/funcs/energyGetDFES.d.ts +28 -0
  375. package/dist/esm/funcs/energyGetDFES.d.ts.map +1 -0
  376. package/dist/esm/funcs/energyGetDFES.js +103 -0
  377. package/dist/esm/funcs/energyGetDFES.js.map +1 -0
  378. package/dist/esm/funcs/energyGetSubstation.d.ts +22 -0
  379. package/dist/esm/funcs/energyGetSubstation.d.ts.map +1 -0
  380. package/dist/esm/funcs/energyGetSubstation.js +91 -0
  381. package/dist/esm/funcs/energyGetSubstation.js.map +1 -0
  382. package/dist/esm/funcs/energySearchConnectionQueue.d.ts +33 -0
  383. package/dist/esm/funcs/energySearchConnectionQueue.d.ts.map +1 -0
  384. package/dist/esm/funcs/energySearchConnectionQueue.js +100 -0
  385. package/dist/esm/funcs/energySearchConnectionQueue.js.map +1 -0
  386. package/dist/esm/funcs/energySearchECR.d.ts +29 -0
  387. package/dist/esm/funcs/energySearchECR.d.ts.map +1 -0
  388. package/dist/esm/funcs/energySearchECR.js +102 -0
  389. package/dist/esm/funcs/energySearchECR.js.map +1 -0
  390. package/dist/esm/funcs/energySearchSubstations.d.ts +28 -0
  391. package/dist/esm/funcs/energySearchSubstations.d.ts.map +1 -0
  392. package/dist/esm/funcs/energySearchSubstations.js +95 -0
  393. package/dist/esm/funcs/energySearchSubstations.js.map +1 -0
  394. package/dist/esm/funcs/propertySearchProperties.d.ts +4 -1
  395. package/dist/esm/funcs/propertySearchProperties.d.ts.map +1 -1
  396. package/dist/esm/funcs/propertySearchProperties.js +4 -1
  397. package/dist/esm/funcs/propertySearchProperties.js.map +1 -1
  398. package/dist/esm/lib/config.d.ts +3 -3
  399. package/dist/esm/lib/config.js +3 -3
  400. package/dist/esm/lib/matchers.d.ts.map +1 -1
  401. package/dist/esm/lib/matchers.js +0 -1
  402. package/dist/esm/lib/matchers.js.map +1 -1
  403. package/dist/esm/lib/security.d.ts.map +1 -1
  404. package/dist/esm/lib/security.js +1 -2
  405. package/dist/esm/lib/security.js.map +1 -1
  406. package/dist/esm/sdk/address.d.ts +3 -1
  407. package/dist/esm/sdk/address.d.ts.map +1 -1
  408. package/dist/esm/sdk/address.js +2 -0
  409. package/dist/esm/sdk/address.js.map +1 -1
  410. package/dist/esm/sdk/energy.d.ts +172 -0
  411. package/dist/esm/sdk/energy.d.ts.map +1 -0
  412. package/dist/esm/sdk/energy.js +208 -0
  413. package/dist/esm/sdk/energy.js.map +1 -0
  414. package/dist/esm/sdk/models/errors/findnearestsubstations.d.ts +331 -0
  415. package/dist/esm/sdk/models/errors/findnearestsubstations.d.ts.map +1 -0
  416. package/dist/esm/sdk/models/errors/findnearestsubstations.js +279 -0
  417. package/dist/esm/sdk/models/errors/findnearestsubstations.js.map +1 -0
  418. package/dist/esm/sdk/models/errors/findsupplyareabypoint.d.ts +266 -0
  419. package/dist/esm/sdk/models/errors/findsupplyareabypoint.d.ts.map +1 -0
  420. package/dist/esm/sdk/models/errors/findsupplyareabypoint.js +225 -0
  421. package/dist/esm/sdk/models/errors/findsupplyareabypoint.js.map +1 -0
  422. package/dist/esm/sdk/models/errors/getareacoverage.d.ts +6 -6
  423. package/dist/esm/sdk/models/errors/getareacoverage.d.ts.map +1 -1
  424. package/dist/esm/sdk/models/errors/getareacoverage.js +3 -3
  425. package/dist/esm/sdk/models/errors/getareacoverage.js.map +1 -1
  426. package/dist/esm/sdk/models/errors/getareasbyfieldandids.d.ts +4 -4
  427. package/dist/esm/sdk/models/errors/getareasbyfieldandids.d.ts.map +1 -1
  428. package/dist/esm/sdk/models/errors/getareasbyfieldandids.js +2 -2
  429. package/dist/esm/sdk/models/errors/getareasbyfieldandids.js.map +1 -1
  430. package/dist/esm/sdk/models/errors/getareaswithinradius.d.ts +4 -4
  431. package/dist/esm/sdk/models/errors/getareaswithinradius.d.ts.map +1 -1
  432. package/dist/esm/sdk/models/errors/getareaswithinradius.js +2 -2
  433. package/dist/esm/sdk/models/errors/getareaswithinradius.js.map +1 -1
  434. package/dist/esm/sdk/models/errors/getborderingareas.d.ts +4 -4
  435. package/dist/esm/sdk/models/errors/getborderingareas.d.ts.map +1 -1
  436. package/dist/esm/sdk/models/errors/getborderingareas.js +2 -2
  437. package/dist/esm/sdk/models/errors/getborderingareas.js.map +1 -1
  438. package/dist/esm/sdk/models/errors/getchildareas.d.ts +4 -4
  439. package/dist/esm/sdk/models/errors/getchildareas.d.ts.map +1 -1
  440. package/dist/esm/sdk/models/errors/getchildareas.js +2 -2
  441. package/dist/esm/sdk/models/errors/getchildareas.js.map +1 -1
  442. package/dist/esm/sdk/models/errors/getconnectionqueuebysubstation.d.ts +266 -0
  443. package/dist/esm/sdk/models/errors/getconnectionqueuebysubstation.d.ts.map +1 -0
  444. package/dist/esm/sdk/models/errors/getconnectionqueuebysubstation.js +221 -0
  445. package/dist/esm/sdk/models/errors/getconnectionqueuebysubstation.js.map +1 -0
  446. package/dist/esm/sdk/models/errors/getconnectionqueueentry.d.ts +331 -0
  447. package/dist/esm/sdk/models/errors/getconnectionqueueentry.d.ts.map +1 -0
  448. package/dist/esm/sdk/models/errors/getconnectionqueueentry.js +279 -0
  449. package/dist/esm/sdk/models/errors/getconnectionqueueentry.js.map +1 -0
  450. package/dist/esm/sdk/models/errors/getconnectivityscores.d.ts +4 -4
  451. package/dist/esm/sdk/models/errors/getconnectivityscores.d.ts.map +1 -1
  452. package/dist/esm/sdk/models/errors/getconnectivityscores.js +2 -2
  453. package/dist/esm/sdk/models/errors/getconnectivityscores.js.map +1 -1
  454. package/dist/esm/sdk/models/errors/getenergyforproperty.d.ts +331 -0
  455. package/dist/esm/sdk/models/errors/getenergyforproperty.d.ts.map +1 -0
  456. package/dist/esm/sdk/models/errors/getenergyforproperty.js +279 -0
  457. package/dist/esm/sdk/models/errors/getenergyforproperty.js.map +1 -0
  458. package/dist/esm/sdk/models/errors/getmetricvalues.d.ts +4 -4
  459. package/dist/esm/sdk/models/errors/getmetricvalues.d.ts.map +1 -1
  460. package/dist/esm/sdk/models/errors/getmetricvalues.js +2 -2
  461. package/dist/esm/sdk/models/errors/getmetricvalues.js.map +1 -1
  462. package/dist/esm/sdk/models/errors/getnearestpoi.d.ts +4 -4
  463. package/dist/esm/sdk/models/errors/getnearestpoi.d.ts.map +1 -1
  464. package/dist/esm/sdk/models/errors/getnearestpoi.js +2 -2
  465. package/dist/esm/sdk/models/errors/getnearestpoi.js.map +1 -1
  466. package/dist/esm/sdk/models/errors/getpoimultipletiles.d.ts +4 -4
  467. package/dist/esm/sdk/models/errors/getpoimultipletiles.d.ts.map +1 -1
  468. package/dist/esm/sdk/models/errors/getpoimultipletiles.js +2 -2
  469. package/dist/esm/sdk/models/errors/getpoimultipletiles.js.map +1 -1
  470. package/dist/esm/sdk/models/errors/getpoitile.d.ts +4 -4
  471. package/dist/esm/sdk/models/errors/getpoitile.d.ts.map +1 -1
  472. package/dist/esm/sdk/models/errors/getpoitile.js +2 -2
  473. package/dist/esm/sdk/models/errors/getpoitile.js.map +1 -1
  474. package/dist/esm/sdk/models/errors/getsubstationbycode.d.ts +331 -0
  475. package/dist/esm/sdk/models/errors/getsubstationbycode.d.ts.map +1 -0
  476. package/dist/esm/sdk/models/errors/getsubstationbycode.js +279 -0
  477. package/dist/esm/sdk/models/errors/getsubstationbycode.js.map +1 -0
  478. package/dist/esm/sdk/models/errors/getsubstationcapacity.d.ts +266 -0
  479. package/dist/esm/sdk/models/errors/getsubstationcapacity.d.ts.map +1 -0
  480. package/dist/esm/sdk/models/errors/getsubstationcapacity.js +225 -0
  481. package/dist/esm/sdk/models/errors/getsubstationcapacity.js.map +1 -0
  482. package/dist/esm/sdk/models/errors/getsubstationdfes.d.ts +266 -0
  483. package/dist/esm/sdk/models/errors/getsubstationdfes.d.ts.map +1 -0
  484. package/dist/esm/sdk/models/errors/getsubstationdfes.js +225 -0
  485. package/dist/esm/sdk/models/errors/getsubstationdfes.js.map +1 -0
  486. package/dist/esm/sdk/models/errors/index.d.ts +11 -0
  487. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  488. package/dist/esm/sdk/models/errors/index.js +11 -0
  489. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  490. package/dist/esm/sdk/models/errors/searchconnectionqueue.d.ts +266 -0
  491. package/dist/esm/sdk/models/errors/searchconnectionqueue.d.ts.map +1 -0
  492. package/dist/esm/sdk/models/errors/searchconnectionqueue.js +225 -0
  493. package/dist/esm/sdk/models/errors/searchconnectionqueue.js.map +1 -0
  494. package/dist/esm/sdk/models/errors/searchecr.d.ts +266 -0
  495. package/dist/esm/sdk/models/errors/searchecr.d.ts.map +1 -0
  496. package/dist/esm/sdk/models/errors/searchecr.js +225 -0
  497. package/dist/esm/sdk/models/errors/searchecr.js.map +1 -0
  498. package/dist/esm/sdk/models/errors/searchsubstations.d.ts +331 -0
  499. package/dist/esm/sdk/models/errors/searchsubstations.d.ts.map +1 -0
  500. package/dist/esm/sdk/models/errors/searchsubstations.js +279 -0
  501. package/dist/esm/sdk/models/errors/searchsubstations.js.map +1 -0
  502. package/dist/esm/sdk/models/operations/findnearestsubstations.d.ts +183 -0
  503. package/dist/esm/sdk/models/operations/findnearestsubstations.d.ts.map +1 -0
  504. package/dist/esm/sdk/models/operations/findnearestsubstations.js +81 -0
  505. package/dist/esm/sdk/models/operations/findnearestsubstations.js.map +1 -0
  506. package/dist/esm/sdk/models/operations/findsitesbyproperty.d.ts +0 -3
  507. package/dist/esm/sdk/models/operations/findsitesbyproperty.d.ts.map +1 -1
  508. package/dist/esm/sdk/models/operations/findsitesbyproperty.js.map +1 -1
  509. package/dist/esm/sdk/models/operations/findsupplyareabypoint.d.ts +139 -0
  510. package/dist/esm/sdk/models/operations/findsupplyareabypoint.d.ts.map +1 -0
  511. package/dist/esm/sdk/models/operations/findsupplyareabypoint.js +71 -0
  512. package/dist/esm/sdk/models/operations/findsupplyareabypoint.js.map +1 -0
  513. package/dist/esm/sdk/models/operations/getcompaniesbylocation.d.ts +0 -3
  514. package/dist/esm/sdk/models/operations/getcompaniesbylocation.d.ts.map +1 -1
  515. package/dist/esm/sdk/models/operations/getcompaniesbylocation.js.map +1 -1
  516. package/dist/esm/sdk/models/operations/getconnectionqueuebysubstation.d.ts +219 -0
  517. package/dist/esm/sdk/models/operations/getconnectionqueuebysubstation.d.ts.map +1 -0
  518. package/dist/esm/sdk/models/operations/getconnectionqueuebysubstation.js +98 -0
  519. package/dist/esm/sdk/models/operations/getconnectionqueuebysubstation.js.map +1 -0
  520. package/dist/esm/sdk/models/operations/getconnectionqueueentry.d.ts +184 -0
  521. package/dist/esm/sdk/models/operations/getconnectionqueueentry.d.ts.map +1 -0
  522. package/dist/esm/sdk/models/operations/getconnectionqueueentry.js +73 -0
  523. package/dist/esm/sdk/models/operations/getconnectionqueueentry.js.map +1 -0
  524. package/dist/esm/sdk/models/operations/getenergyforproperty.d.ts +642 -0
  525. package/dist/esm/sdk/models/operations/getenergyforproperty.d.ts.map +1 -0
  526. package/dist/esm/sdk/models/operations/getenergyforproperty.js +255 -0
  527. package/dist/esm/sdk/models/operations/getenergyforproperty.js.map +1 -0
  528. package/dist/esm/sdk/models/operations/getsubstationbycode.d.ts +115 -0
  529. package/dist/esm/sdk/models/operations/getsubstationbycode.d.ts.map +1 -0
  530. package/dist/esm/sdk/models/operations/getsubstationbycode.js +51 -0
  531. package/dist/esm/sdk/models/operations/getsubstationbycode.js.map +1 -0
  532. package/dist/esm/sdk/models/operations/getsubstationcapacity.d.ts +133 -0
  533. package/dist/esm/sdk/models/operations/getsubstationcapacity.d.ts.map +1 -0
  534. package/dist/esm/sdk/models/operations/getsubstationcapacity.js +66 -0
  535. package/dist/esm/sdk/models/operations/getsubstationcapacity.js.map +1 -0
  536. package/dist/esm/sdk/models/operations/getsubstationdfes.d.ts +130 -0
  537. package/dist/esm/sdk/models/operations/getsubstationdfes.d.ts.map +1 -0
  538. package/dist/esm/sdk/models/operations/getsubstationdfes.js +65 -0
  539. package/dist/esm/sdk/models/operations/getsubstationdfes.js.map +1 -0
  540. package/dist/esm/sdk/models/operations/getv1safetycrimestats.d.ts +1 -1
  541. package/dist/esm/sdk/models/operations/index.d.ts +11 -0
  542. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  543. package/dist/esm/sdk/models/operations/index.js +11 -0
  544. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  545. package/dist/esm/sdk/models/operations/lookuppostcode.d.ts +19 -0
  546. package/dist/esm/sdk/models/operations/lookuppostcode.d.ts.map +1 -1
  547. package/dist/esm/sdk/models/operations/lookuppostcode.js +11 -0
  548. package/dist/esm/sdk/models/operations/lookuppostcode.js.map +1 -1
  549. package/dist/esm/sdk/models/operations/lookupuprn.d.ts +19 -0
  550. package/dist/esm/sdk/models/operations/lookupuprn.d.ts.map +1 -1
  551. package/dist/esm/sdk/models/operations/lookupuprn.js +10 -0
  552. package/dist/esm/sdk/models/operations/lookupuprn.js.map +1 -1
  553. package/dist/esm/sdk/models/operations/resolveaddress.d.ts +0 -62
  554. package/dist/esm/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  555. package/dist/esm/sdk/models/operations/resolveaddress.js +0 -20
  556. package/dist/esm/sdk/models/operations/resolveaddress.js.map +1 -1
  557. package/dist/esm/sdk/models/operations/reversegeocode.d.ts +19 -0
  558. package/dist/esm/sdk/models/operations/reversegeocode.d.ts.map +1 -1
  559. package/dist/esm/sdk/models/operations/reversegeocode.js +10 -0
  560. package/dist/esm/sdk/models/operations/reversegeocode.js.map +1 -1
  561. package/dist/esm/sdk/models/operations/searchconnectionqueue.d.ts +277 -0
  562. package/dist/esm/sdk/models/operations/searchconnectionqueue.d.ts.map +1 -0
  563. package/dist/esm/sdk/models/operations/searchconnectionqueue.js +107 -0
  564. package/dist/esm/sdk/models/operations/searchconnectionqueue.js.map +1 -0
  565. package/dist/esm/sdk/models/operations/searchecr.d.ts +176 -0
  566. package/dist/esm/sdk/models/operations/searchecr.d.ts.map +1 -0
  567. package/dist/esm/sdk/models/operations/searchecr.js +79 -0
  568. package/dist/esm/sdk/models/operations/searchecr.js.map +1 -0
  569. package/dist/esm/sdk/models/operations/searchsubstations.d.ts +198 -0
  570. package/dist/esm/sdk/models/operations/searchsubstations.d.ts.map +1 -0
  571. package/dist/esm/sdk/models/operations/searchsubstations.js +84 -0
  572. package/dist/esm/sdk/models/operations/searchsubstations.js.map +1 -0
  573. package/dist/esm/sdk/models/shared/addressresolverequest.d.ts +81 -0
  574. package/dist/esm/sdk/models/shared/addressresolverequest.d.ts.map +1 -0
  575. package/dist/esm/sdk/models/shared/addressresolverequest.js +36 -0
  576. package/dist/esm/sdk/models/shared/addressresolverequest.js.map +1 -0
  577. package/dist/esm/sdk/models/shared/appointmentsresponse.d.ts +1 -1
  578. package/dist/esm/sdk/models/shared/appointmentsresponse.d.ts.map +1 -1
  579. package/dist/esm/sdk/models/shared/appointmentsresponse.js +1 -1
  580. package/dist/esm/sdk/models/shared/appointmentsresponse.js.map +1 -1
  581. package/dist/esm/sdk/models/shared/bulkpostcodelookuprequest.d.ts +19 -0
  582. package/dist/esm/sdk/models/shared/bulkpostcodelookuprequest.d.ts.map +1 -1
  583. package/dist/esm/sdk/models/shared/bulkpostcodelookuprequest.js +11 -0
  584. package/dist/esm/sdk/models/shared/bulkpostcodelookuprequest.js.map +1 -1
  585. package/dist/esm/sdk/models/shared/companiesbylocationresponse.d.ts +1 -1
  586. package/dist/esm/sdk/models/shared/companiesbylocationresponse.d.ts.map +1 -1
  587. package/dist/esm/sdk/models/shared/companiesbylocationresponse.js +1 -1
  588. package/dist/esm/sdk/models/shared/companiesbylocationresponse.js.map +1 -1
  589. package/dist/esm/sdk/models/shared/companylistresponse.d.ts +1 -1
  590. package/dist/esm/sdk/models/shared/companylistresponse.d.ts.map +1 -1
  591. package/dist/esm/sdk/models/shared/companylistresponse.js +1 -1
  592. package/dist/esm/sdk/models/shared/companylistresponse.js.map +1 -1
  593. package/dist/esm/sdk/models/shared/companyresponse.d.ts +1 -1
  594. package/dist/esm/sdk/models/shared/companyresponse.d.ts.map +1 -1
  595. package/dist/esm/sdk/models/shared/companyresponse.js +1 -1
  596. package/dist/esm/sdk/models/shared/companyresponse.js.map +1 -1
  597. package/dist/esm/sdk/models/shared/index.d.ts +9 -0
  598. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  599. package/dist/esm/sdk/models/shared/index.js +9 -0
  600. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  601. package/dist/esm/sdk/models/shared/listingimage.d.ts +4 -0
  602. package/dist/esm/sdk/models/shared/listingimage.d.ts.map +1 -1
  603. package/dist/esm/sdk/models/shared/listingimage.js +1 -0
  604. package/dist/esm/sdk/models/shared/listingimage.js.map +1 -1
  605. package/dist/esm/sdk/models/shared/officerlistresponse.d.ts +1 -1
  606. package/dist/esm/sdk/models/shared/officerlistresponse.d.ts.map +1 -1
  607. package/dist/esm/sdk/models/shared/officerlistresponse.js +1 -1
  608. package/dist/esm/sdk/models/shared/officerlistresponse.js.map +1 -1
  609. package/dist/esm/sdk/models/shared/officerresponse.d.ts +1 -1
  610. package/dist/esm/sdk/models/shared/officerresponse.d.ts.map +1 -1
  611. package/dist/esm/sdk/models/shared/officerresponse.js +1 -1
  612. package/dist/esm/sdk/models/shared/officerresponse.js.map +1 -1
  613. package/dist/esm/sdk/models/shared/personclusterresponse.d.ts +1 -1
  614. package/dist/esm/sdk/models/shared/personclusterresponse.d.ts.map +1 -1
  615. package/dist/esm/sdk/models/shared/personclusterresponse.js +1 -1
  616. package/dist/esm/sdk/models/shared/personclusterresponse.js.map +1 -1
  617. package/dist/esm/sdk/models/shared/personlistresponse.d.ts +1 -1
  618. package/dist/esm/sdk/models/shared/personlistresponse.d.ts.map +1 -1
  619. package/dist/esm/sdk/models/shared/personlistresponse.js +1 -1
  620. package/dist/esm/sdk/models/shared/personlistresponse.js.map +1 -1
  621. package/dist/esm/sdk/models/shared/personresponse.d.ts +1 -1
  622. package/dist/esm/sdk/models/shared/personresponse.d.ts.map +1 -1
  623. package/dist/esm/sdk/models/shared/personresponse.js +1 -1
  624. package/dist/esm/sdk/models/shared/personresponse.js.map +1 -1
  625. package/dist/esm/sdk/models/shared/planningaddress.d.ts +48 -0
  626. package/dist/esm/sdk/models/shared/planningaddress.d.ts.map +1 -0
  627. package/dist/esm/sdk/models/shared/planningaddress.js +21 -0
  628. package/dist/esm/sdk/models/shared/planningaddress.js.map +1 -0
  629. package/dist/esm/sdk/models/shared/planningagent.d.ts +17 -0
  630. package/dist/esm/sdk/models/shared/planningagent.d.ts.map +1 -0
  631. package/dist/esm/sdk/models/shared/planningagent.js +14 -0
  632. package/dist/esm/sdk/models/shared/planningagent.js.map +1 -0
  633. package/dist/esm/sdk/models/shared/planningapplicant.d.ts +17 -0
  634. package/dist/esm/sdk/models/shared/planningapplicant.d.ts.map +1 -0
  635. package/dist/esm/sdk/models/shared/planningapplicant.js +14 -0
  636. package/dist/esm/sdk/models/shared/planningapplicant.js.map +1 -0
  637. package/dist/esm/sdk/models/shared/planningapplication.d.ts +50 -0
  638. package/dist/esm/sdk/models/shared/planningapplication.d.ts.map +1 -1
  639. package/dist/esm/sdk/models/shared/planningapplication.js +18 -0
  640. package/dist/esm/sdk/models/shared/planningapplication.js.map +1 -1
  641. package/dist/esm/sdk/models/shared/planningconstraint.d.ts +25 -0
  642. package/dist/esm/sdk/models/shared/planningconstraint.d.ts.map +1 -0
  643. package/dist/esm/sdk/models/shared/planningconstraint.js +16 -0
  644. package/dist/esm/sdk/models/shared/planningconstraint.js.map +1 -0
  645. package/dist/esm/sdk/models/shared/planningdocument.d.ts +41 -0
  646. package/dist/esm/sdk/models/shared/planningdocument.d.ts.map +1 -0
  647. package/dist/esm/sdk/models/shared/planningdocument.js +20 -0
  648. package/dist/esm/sdk/models/shared/planningdocument.js.map +1 -0
  649. package/dist/esm/sdk/models/shared/planningpeople.d.ts +22 -0
  650. package/dist/esm/sdk/models/shared/planningpeople.d.ts.map +1 -0
  651. package/dist/esm/sdk/models/shared/planningpeople.js +16 -0
  652. package/dist/esm/sdk/models/shared/planningpeople.js.map +1 -0
  653. package/dist/esm/sdk/models/shared/planningrelatedcase.d.ts +21 -0
  654. package/dist/esm/sdk/models/shared/planningrelatedcase.d.ts.map +1 -0
  655. package/dist/esm/sdk/models/shared/planningrelatedcase.js +15 -0
  656. package/dist/esm/sdk/models/shared/planningrelatedcase.js.map +1 -0
  657. package/dist/esm/sdk/models/shared/planningstatushistory.d.ts +33 -0
  658. package/dist/esm/sdk/models/shared/planningstatushistory.d.ts.map +1 -0
  659. package/dist/esm/sdk/models/shared/planningstatushistory.js +18 -0
  660. package/dist/esm/sdk/models/shared/planningstatushistory.js.map +1 -0
  661. package/dist/esm/sdk/models/shared/propertyquerycondition.d.ts +1 -1
  662. package/dist/esm/sdk/models/shared/psclistresponse.d.ts +1 -1
  663. package/dist/esm/sdk/models/shared/psclistresponse.d.ts.map +1 -1
  664. package/dist/esm/sdk/models/shared/psclistresponse.js +1 -1
  665. package/dist/esm/sdk/models/shared/psclistresponse.js.map +1 -1
  666. package/dist/esm/sdk/models/shared/pscresponse.d.ts +1 -1
  667. package/dist/esm/sdk/models/shared/pscresponse.d.ts.map +1 -1
  668. package/dist/esm/sdk/models/shared/pscresponse.js +1 -1
  669. package/dist/esm/sdk/models/shared/pscresponse.js.map +1 -1
  670. package/dist/esm/sdk/property.d.ts +4 -1
  671. package/dist/esm/sdk/property.d.ts.map +1 -1
  672. package/dist/esm/sdk/property.js +4 -1
  673. package/dist/esm/sdk/property.js.map +1 -1
  674. package/dist/esm/sdk/sdk.d.ts +3 -0
  675. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  676. package/dist/esm/sdk/sdk.js +4 -0
  677. package/dist/esm/sdk/sdk.js.map +1 -1
  678. package/package.json +2 -2
  679. package/src/funcs/addressLookupPostcode.ts +1 -0
  680. package/src/funcs/addressLookupUprn.ts +1 -0
  681. package/src/funcs/addressResolveAddress.ts +6 -5
  682. package/src/funcs/addressReverseGeocode.ts +1 -0
  683. package/src/funcs/energyFindNearestSubstations.ts +218 -0
  684. package/src/funcs/energyFindSupplyAreaByPoint.ts +202 -0
  685. package/src/funcs/energyGetByProperty.ts +221 -0
  686. package/src/funcs/energyGetCapacity.ts +211 -0
  687. package/src/funcs/energyGetConnectionQueueBySubstation.ts +211 -0
  688. package/src/funcs/energyGetConnectionQueueEntry.ts +218 -0
  689. package/src/funcs/energyGetDFES.ts +210 -0
  690. package/src/funcs/energyGetSubstation.ts +205 -0
  691. package/src/funcs/energySearchConnectionQueue.ts +213 -0
  692. package/src/funcs/energySearchECR.ts +203 -0
  693. package/src/funcs/energySearchSubstations.ts +208 -0
  694. package/src/funcs/propertySearchProperties.ts +4 -1
  695. package/src/lib/config.ts +3 -3
  696. package/src/lib/matchers.ts +3 -2
  697. package/src/lib/security.ts +1 -2
  698. package/src/sdk/address.ts +3 -1
  699. package/src/sdk/energy.ts +299 -0
  700. package/src/sdk/models/errors/findnearestsubstations.ts +684 -0
  701. package/src/sdk/models/errors/findsupplyareabypoint.ts +539 -0
  702. package/src/sdk/models/errors/getareacoverage.ts +9 -9
  703. package/src/sdk/models/errors/getareasbyfieldandids.ts +6 -6
  704. package/src/sdk/models/errors/getareaswithinradius.ts +6 -6
  705. package/src/sdk/models/errors/getborderingareas.ts +6 -6
  706. package/src/sdk/models/errors/getchildareas.ts +6 -6
  707. package/src/sdk/models/errors/getconnectionqueuebysubstation.ts +557 -0
  708. package/src/sdk/models/errors/getconnectionqueueentry.ts +683 -0
  709. package/src/sdk/models/errors/getconnectivityscores.ts +6 -6
  710. package/src/sdk/models/errors/getenergyforproperty.ts +674 -0
  711. package/src/sdk/models/errors/getmetricvalues.ts +6 -6
  712. package/src/sdk/models/errors/getnearestpoi.ts +6 -6
  713. package/src/sdk/models/errors/getpoimultipletiles.ts +6 -6
  714. package/src/sdk/models/errors/getpoitile.ts +6 -6
  715. package/src/sdk/models/errors/getsubstationbycode.ts +671 -0
  716. package/src/sdk/models/errors/getsubstationcapacity.ts +539 -0
  717. package/src/sdk/models/errors/getsubstationdfes.ts +529 -0
  718. package/src/sdk/models/errors/index.ts +11 -0
  719. package/src/sdk/models/errors/searchconnectionqueue.ts +539 -0
  720. package/src/sdk/models/errors/searchecr.ts +516 -0
  721. package/src/sdk/models/errors/searchsubstations.ts +665 -0
  722. package/src/sdk/models/operations/findnearestsubstations.ts +302 -0
  723. package/src/sdk/models/operations/findsitesbyproperty.ts +0 -3
  724. package/src/sdk/models/operations/findsupplyareabypoint.ts +247 -0
  725. package/src/sdk/models/operations/getcompaniesbylocation.ts +0 -3
  726. package/src/sdk/models/operations/getconnectionqueuebysubstation.ts +385 -0
  727. package/src/sdk/models/operations/getconnectionqueueentry.ts +301 -0
  728. package/src/sdk/models/operations/getenergyforproperty.ts +1076 -0
  729. package/src/sdk/models/operations/getsubstationbycode.ts +193 -0
  730. package/src/sdk/models/operations/getsubstationcapacity.ts +227 -0
  731. package/src/sdk/models/operations/getsubstationdfes.ts +218 -0
  732. package/src/sdk/models/operations/getv1safetycrimestats.ts +1 -1
  733. package/src/sdk/models/operations/index.ts +11 -0
  734. package/src/sdk/models/operations/lookuppostcode.ts +23 -0
  735. package/src/sdk/models/operations/lookupuprn.ts +24 -0
  736. package/src/sdk/models/operations/resolveaddress.ts +0 -96
  737. package/src/sdk/models/operations/reversegeocode.ts +26 -0
  738. package/src/sdk/models/operations/searchconnectionqueue.ts +452 -0
  739. package/src/sdk/models/operations/searchecr.ts +284 -0
  740. package/src/sdk/models/operations/searchsubstations.ts +320 -0
  741. package/src/sdk/models/shared/addressresolverequest.ts +123 -0
  742. package/src/sdk/models/shared/appointmentsresponse.ts +2 -2
  743. package/src/sdk/models/shared/bulkpostcodelookuprequest.ts +23 -0
  744. package/src/sdk/models/shared/companiesbylocationresponse.ts +2 -2
  745. package/src/sdk/models/shared/companylistresponse.ts +2 -2
  746. package/src/sdk/models/shared/companyresponse.ts +2 -2
  747. package/src/sdk/models/shared/index.ts +9 -0
  748. package/src/sdk/models/shared/listingimage.ts +5 -0
  749. package/src/sdk/models/shared/officerlistresponse.ts +2 -2
  750. package/src/sdk/models/shared/officerresponse.ts +2 -2
  751. package/src/sdk/models/shared/personclusterresponse.ts +2 -2
  752. package/src/sdk/models/shared/personlistresponse.ts +2 -2
  753. package/src/sdk/models/shared/personresponse.ts +2 -2
  754. package/src/sdk/models/shared/planningaddress.ts +77 -0
  755. package/src/sdk/models/shared/planningagent.ts +39 -0
  756. package/src/sdk/models/shared/planningapplicant.ts +39 -0
  757. package/src/sdk/models/shared/planningapplication.ts +80 -0
  758. package/src/sdk/models/shared/planningconstraint.ts +49 -0
  759. package/src/sdk/models/shared/planningdocument.ts +69 -0
  760. package/src/sdk/models/shared/planningpeople.ts +47 -0
  761. package/src/sdk/models/shared/planningrelatedcase.ts +44 -0
  762. package/src/sdk/models/shared/planningstatushistory.ts +59 -0
  763. package/src/sdk/models/shared/propertyquerycondition.ts +1 -1
  764. package/src/sdk/models/shared/psclistresponse.ts +2 -2
  765. package/src/sdk/models/shared/pscresponse.ts +2 -2
  766. package/src/sdk/property.ts +4 -1
  767. package/src/sdk/sdk.ts +6 -0
@@ -0,0 +1,1076 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { ClosedEnum } from "../../types/enums.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+
11
+ export type GetEnergyForPropertyRequest = {
12
+ /**
13
+ * Comma-separated list of layers to include in the response. Available layers: supplyArea, substation, capacity, ecr, dfes, connections. Defaults to all layers if omitted
14
+ */
15
+ include?: string | undefined;
16
+ /**
17
+ * Latitude of the property location (WGS84)
18
+ */
19
+ lat?: number | null | undefined;
20
+ locationId: string;
21
+ /**
22
+ * Longitude of the property location (WGS84)
23
+ */
24
+ lon?: number | null | undefined;
25
+ };
26
+
27
+ /**
28
+ * Object type identifier
29
+ */
30
+ export const GetEnergyForPropertyEnergyObject = {
31
+ CapacitySnapshot: "capacity_snapshot",
32
+ } as const;
33
+ /**
34
+ * Object type identifier
35
+ */
36
+ export type GetEnergyForPropertyEnergyObject = ClosedEnum<
37
+ typeof GetEnergyForPropertyEnergyObject
38
+ >;
39
+
40
+ /**
41
+ * A quarterly snapshot of substation capacity and headroom. Use these to track how available capacity changes over time
42
+ */
43
+ export type CapacitySnapshot = {
44
+ /**
45
+ * Battery-specific headroom, in megawatts (MW). Only available from some operators
46
+ */
47
+ batteryHeadroomMw: number | null;
48
+ /**
49
+ * Available demand headroom at this snapshot date, in megawatts (MW)
50
+ */
51
+ demandHeadroomMw: number | null;
52
+ /**
53
+ * Peak demand at this snapshot date, in megawatts (MW)
54
+ */
55
+ demandMw: number | null;
56
+ /**
57
+ * Electric vehicle charger-specific headroom, in megawatts (MW). Only available from some operators
58
+ */
59
+ evHeadroomMw: number | null;
60
+ /**
61
+ * Firm capacity rating at this snapshot date, in megawatts (MW)
62
+ */
63
+ firmCapacityMw: number | null;
64
+ /**
65
+ * Available generation headroom at this snapshot date, in megawatts (MW)
66
+ */
67
+ generationHeadroomMw: number | null;
68
+ /**
69
+ * Object type identifier
70
+ */
71
+ object: GetEnergyForPropertyEnergyObject;
72
+ /**
73
+ * Date of this capacity snapshot, typically the start of a quarter (ISO 8601)
74
+ */
75
+ snapshotDate: string;
76
+ /**
77
+ * Identifier for the data source this snapshot was extracted from
78
+ */
79
+ snapshotSource: string;
80
+ /**
81
+ * Solar-specific headroom, in megawatts (MW). Only available from some operators
82
+ */
83
+ solarHeadroomMw: number | null;
84
+ /**
85
+ * Code of the substation this snapshot belongs to
86
+ */
87
+ substationCode: string;
88
+ /**
89
+ * Utilisation percentage at this snapshot date
90
+ */
91
+ utilisationPct: number | null;
92
+ };
93
+
94
+ /**
95
+ * WGS84 coordinate pair
96
+ */
97
+ export type GetEnergyForPropertyCoordinates = {
98
+ /**
99
+ * Latitude in decimal degrees
100
+ */
101
+ lat: number;
102
+ /**
103
+ * Longitude in decimal degrees
104
+ */
105
+ lng: number;
106
+ };
107
+
108
+ /**
109
+ * Object type identifier
110
+ */
111
+ export const GetEnergyForPropertyEnergyResponseObject = {
112
+ ConnectionQueueEntry: "connection_queue_entry",
113
+ } as const;
114
+ /**
115
+ * Object type identifier
116
+ */
117
+ export type GetEnergyForPropertyEnergyResponseObject = ClosedEnum<
118
+ typeof GetEnergyForPropertyEnergyResponseObject
119
+ >;
120
+
121
+ /**
122
+ * A technology component of a multi-technology connection queue entry
123
+ */
124
+ export type GetEnergyForPropertyConnectionQueueTechnology = {
125
+ /**
126
+ * Capacity allocated to this technology, in megawatts (MW)
127
+ */
128
+ capacityMw: number | null;
129
+ /**
130
+ * Whether this is the primary technology for the project
131
+ */
132
+ isPrimary: boolean;
133
+ /**
134
+ * Technology grouping (generation, storage, thermal, demand, infrastructure, other)
135
+ */
136
+ technologyCategory: string | null;
137
+ /**
138
+ * Canonical technology type from the shared taxonomy
139
+ */
140
+ technologyType: string;
141
+ };
142
+
143
+ /**
144
+ * An entry from the national grid connection queue — representing a project awaiting or holding a connection agreement to the electricity network. Covers both transmission (TEC Register) and distribution (Embedded Register) connections
145
+ */
146
+ export type GetEnergyForPropertyConnectionQueueEntry = {
147
+ /**
148
+ * Date the connection offer was accepted (ISO 8601)
149
+ */
150
+ acceptanceDate: string | null;
151
+ /**
152
+ * Date the connection application was submitted (ISO 8601)
153
+ */
154
+ applicationDate: string | null;
155
+ /**
156
+ * Total connection capacity, in megawatts (MW)
157
+ */
158
+ capacityMw: number | null;
159
+ /**
160
+ * Agreed or expected connection date (ISO 8601)
161
+ */
162
+ connectionDate: string | null;
163
+ /**
164
+ * Raw connection site name from the source register
165
+ */
166
+ connectionSite: string | null;
167
+ /**
168
+ * Canonical connection lifecycle status
169
+ */
170
+ connectionStatus: string | null;
171
+ /**
172
+ * ISO 3166-1 alpha-2 country code
173
+ */
174
+ country: string;
175
+ /**
176
+ * Cumulative capacity of all projects ahead in the queue, in megawatts (MW)
177
+ */
178
+ cumulativeCapacityMw: number | null;
179
+ /**
180
+ * Name of the connecting customer or developer
181
+ */
182
+ customerName: string | null;
183
+ /**
184
+ * Maximum export capacity, in megawatts (MW)
185
+ */
186
+ exportCapacityMw: number | null;
187
+ /**
188
+ * Maximum import capacity, in megawatts (MW)
189
+ */
190
+ importCapacityMw: number | null;
191
+ /**
192
+ * WGS84 coordinate pair
193
+ */
194
+ location: GetEnergyForPropertyCoordinates | null;
195
+ /**
196
+ * Network voltage level: transmission, distribution, or interconnector
197
+ */
198
+ networkLevel: string | null;
199
+ /**
200
+ * Object type identifier
201
+ */
202
+ object: GetEnergyForPropertyEnergyResponseObject;
203
+ /**
204
+ * Date the connection offer was made (ISO 8601)
205
+ */
206
+ offerDate: string | null;
207
+ /**
208
+ * Licence area or operating region
209
+ */
210
+ operatingRegion: string | null;
211
+ /**
212
+ * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
213
+ */
214
+ operator: string;
215
+ /**
216
+ * Unique project identifier from the source register
217
+ */
218
+ projectId: string;
219
+ /**
220
+ * Human-readable project name
221
+ */
222
+ projectName: string | null;
223
+ /**
224
+ * Secondary project reference number
225
+ */
226
+ projectNumber: string | null;
227
+ /**
228
+ * Position in the connection queue, if available
229
+ */
230
+ queuePosition: number | null;
231
+ /**
232
+ * Source register identifier (e.g. neso_tec, neso_embedded)
233
+ */
234
+ sourceDataset: string;
235
+ /**
236
+ * Code of the resolved substation, if matched
237
+ */
238
+ substationCode: string | null;
239
+ /**
240
+ * All technology components for multi-technology projects
241
+ */
242
+ technologies?:
243
+ | Array<GetEnergyForPropertyConnectionQueueTechnology>
244
+ | undefined;
245
+ /**
246
+ * Primary technology category
247
+ */
248
+ technologyCategory: string | null;
249
+ /**
250
+ * Primary canonical technology type
251
+ */
252
+ technologyType: string | null;
253
+ };
254
+
255
+ /**
256
+ * Object type identifier
257
+ */
258
+ export const GetEnergyForPropertyEnergyResponse200Object = {
259
+ DfesForecast: "dfes_forecast",
260
+ } as const;
261
+ /**
262
+ * Object type identifier
263
+ */
264
+ export type GetEnergyForPropertyEnergyResponse200Object = ClosedEnum<
265
+ typeof GetEnergyForPropertyEnergyResponse200Object
266
+ >;
267
+
268
+ /**
269
+ * A forecast from an energy planning framework (e.g. DFES in GB), projecting future demand, generation, and storage capacity under different energy transition pathways
270
+ */
271
+ export type DfesForecast = {
272
+ /**
273
+ * ISO 3166-1 alpha-2 country code
274
+ */
275
+ country: string;
276
+ /**
277
+ * Forecast value, in megawatts (MW), for this scenario, year, and technology
278
+ */
279
+ forecastMw: number | null;
280
+ /**
281
+ * Category of a forecast. Known values: 'demand', 'generation', 'storage'. 'demand' forecasts electricity consumption growth. 'generation' forecasts new renewable/distributed generation capacity. 'storage' forecasts battery and other storage deployment. New categories can be added as energy models evolve (e.g. flexibility, hydrogen).
282
+ */
283
+ forecastType: string;
284
+ /**
285
+ * Object type identifier
286
+ */
287
+ object: GetEnergyForPropertyEnergyResponse200Object;
288
+ /**
289
+ * Operating region this forecast applies to
290
+ */
291
+ operatingRegion: string;
292
+ /**
293
+ * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
294
+ */
295
+ operator: string;
296
+ /**
297
+ * Energy planning scenario identifier. Each country's energy planning framework defines its own scenarios. Known GB scenarios: 'leading_the_way', 'consumer_transformation', 'system_transformation', 'falling_short', 'best_view', 'holistic_transition'. 'leading_the_way' assumes fastest decarbonisation. 'falling_short' assumes slowest progress. 'best_view' is the operator's most likely central estimate.
298
+ */
299
+ scenario: string;
300
+ /**
301
+ * Code of the substation this forecast applies to, if substation-level
302
+ */
303
+ substationCode: string | null;
304
+ /**
305
+ * Technology type being forecast (e.g. solar, EV, heat pump, battery)
306
+ */
307
+ technologyType: string | null;
308
+ /**
309
+ * Forecast year
310
+ */
311
+ year: number;
312
+ };
313
+
314
+ /**
315
+ * WGS84 coordinate pair
316
+ */
317
+ export type GetEnergyForPropertyEnergyCoordinates = {
318
+ /**
319
+ * Latitude in decimal degrees
320
+ */
321
+ lat: number;
322
+ /**
323
+ * Longitude in decimal degrees
324
+ */
325
+ lng: number;
326
+ };
327
+
328
+ /**
329
+ * Object type identifier
330
+ */
331
+ export const GetEnergyForPropertyEnergyResponse200ApplicationJSONObject = {
332
+ EcrEntry: "ecr_entry",
333
+ } as const;
334
+ /**
335
+ * Object type identifier
336
+ */
337
+ export type GetEnergyForPropertyEnergyResponse200ApplicationJSONObject =
338
+ ClosedEnum<typeof GetEnergyForPropertyEnergyResponse200ApplicationJSONObject>;
339
+
340
+ /**
341
+ * An entry from the Embedded Capacity Register (ECR) — a public record of all generation and storage connections to the distribution network
342
+ */
343
+ export type EcrEntry = {
344
+ /**
345
+ * Unique identifier for this ECR entry
346
+ */
347
+ code: string;
348
+ /**
349
+ * Date the connection was made or is expected (ISO 8601)
350
+ */
351
+ connectionDate: string | null;
352
+ /**
353
+ * Lifecycle status of a generation/storage connection. Known values: 'connected', 'accepted', 'contracted', 'in_scoping'. 'connected' is live and exporting. 'accepted' has a formal connection offer accepted. 'contracted' is under contract but not yet connected. 'in_scoping' is in early feasibility assessment. Different regulatory frameworks may define additional statuses.
354
+ */
355
+ connectionStatus: string | null;
356
+ /**
357
+ * Category of an embedded capacity register connection. Known values: 'generation', 'storage', 'generation_and_storage'. 'generation' covers solar, wind, gas, biomass, etc. 'storage' covers batteries. 'generation_and_storage' covers co-located sites. New types can be added as technologies evolve (e.g. hydrogen electrolysis, V2G).
358
+ */
359
+ connectionType: string | null;
360
+ /**
361
+ * ISO 3166-1 alpha-2 country code
362
+ */
363
+ country: string;
364
+ /**
365
+ * Maximum export capacity agreed with the network operator, in megawatts (MW)
366
+ */
367
+ exportCapacityMw: number | null;
368
+ /**
369
+ * Total installed capacity of the connection, in megawatts (MW)
370
+ */
371
+ installedCapacityMw: number | null;
372
+ /**
373
+ * WGS84 coordinate pair
374
+ */
375
+ location: GetEnergyForPropertyEnergyCoordinates | null;
376
+ /**
377
+ * Object type identifier
378
+ */
379
+ object: GetEnergyForPropertyEnergyResponse200ApplicationJSONObject;
380
+ /**
381
+ * Operating region where this connection is located
382
+ */
383
+ operatingRegion: string | null;
384
+ /**
385
+ * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
386
+ */
387
+ operator: string;
388
+ /**
389
+ * Code of the substation this connection is registered against
390
+ */
391
+ substationCode: string | null;
392
+ /**
393
+ * Technology used for generation or storage (e.g. solar, wind, battery, gas, biomass)
394
+ */
395
+ technologyType: string | null;
396
+ };
397
+
398
+ /**
399
+ * Object type identifier
400
+ */
401
+ export const GetEnergyForPropertyObject = {
402
+ EnergyForProperty: "energy_for_property",
403
+ } as const;
404
+ /**
405
+ * Object type identifier
406
+ */
407
+ export type GetEnergyForPropertyObject = ClosedEnum<
408
+ typeof GetEnergyForPropertyObject
409
+ >;
410
+
411
+ /**
412
+ * WGS84 coordinate pair
413
+ */
414
+ export type GetEnergyForPropertyEnergyResponseCoordinates = {
415
+ /**
416
+ * Latitude in decimal degrees
417
+ */
418
+ lat: number;
419
+ /**
420
+ * Longitude in decimal degrees
421
+ */
422
+ lng: number;
423
+ };
424
+
425
+ /**
426
+ * Object type identifier
427
+ */
428
+ export const GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodyObject =
429
+ {
430
+ Substation: "substation",
431
+ } as const;
432
+ /**
433
+ * Object type identifier
434
+ */
435
+ export type GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodyObject =
436
+ ClosedEnum<
437
+ typeof GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodyObject
438
+ >;
439
+
440
+ /**
441
+ * A network operator substation with its current capacity and headroom data
442
+ */
443
+ export type GetEnergyForPropertySubstation = {
444
+ /**
445
+ * Unique substation identifier, prefixed with the operator code
446
+ */
447
+ code: string;
448
+ /**
449
+ * ISO 3166-1 alpha-2 country code
450
+ */
451
+ country: string;
452
+ /**
453
+ * Available spare capacity for new demand connections, in megawatts (MW). Calculated as firm capacity minus peak demand
454
+ */
455
+ demandHeadroomMw: number | null;
456
+ /**
457
+ * Current peak electricity demand at this substation, in megawatts (MW)
458
+ */
459
+ demandMw: number | null;
460
+ /**
461
+ * Maximum firm capacity rating, in megawatts (MW). This is the guaranteed capacity available under all operating conditions
462
+ */
463
+ firmCapacityMw: number | null;
464
+ /**
465
+ * Available spare capacity for new generation connections (e.g. solar, wind), in megawatts (MW)
466
+ */
467
+ generationHeadroomMw: number | null;
468
+ /**
469
+ * WGS84 coordinate pair
470
+ */
471
+ location: GetEnergyForPropertyEnergyResponseCoordinates | null;
472
+ /**
473
+ * Human-readable substation name, where available
474
+ */
475
+ name: string | null;
476
+ /**
477
+ * Object type identifier
478
+ */
479
+ object:
480
+ GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodyObject;
481
+ /**
482
+ * Operating region name (e.g. 'UKPN (SPN)' in GB, or region name in other countries)
483
+ */
484
+ operatingRegion: string | null;
485
+ /**
486
+ * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
487
+ */
488
+ operator: string;
489
+ /**
490
+ * Code of the parent substation in the network hierarchy (e.g. a primary's parent grid substation). Null for top-level GSPs
491
+ */
492
+ parentSubstationCode: string | null;
493
+ /**
494
+ * Maximum capacity for reverse power flow (generation exceeding local demand), in megawatts (MW)
495
+ */
496
+ reversePowerCapacityMw: number | null;
497
+ /**
498
+ * Classification of substation within the electricity network hierarchy. Known values: 'gsp', 'bulk_supply', 'grid', 'primary', 'distribution'. 'gsp' (Grid Supply Point) connects to the national transmission grid. 'bulk_supply' and 'grid' operate at intermediate voltages. 'primary' steps down to 11kV for local distribution. 'distribution' serves end customers at low voltage.
499
+ */
500
+ substationType: string | null;
501
+ /**
502
+ * Current utilisation as a percentage of firm capacity. Higher values indicate less available headroom
503
+ */
504
+ utilisationPct: number | null;
505
+ /**
506
+ * Operating voltage, in kilovolts (kV)
507
+ */
508
+ voltageKv: number | null;
509
+ };
510
+
511
+ /**
512
+ * WGS84 coordinate pair
513
+ */
514
+ export type GetEnergyForPropertyEnergyResponse200Coordinates = {
515
+ /**
516
+ * Latitude in decimal degrees
517
+ */
518
+ lat: number;
519
+ /**
520
+ * Longitude in decimal degrees
521
+ */
522
+ lng: number;
523
+ };
524
+
525
+ /**
526
+ * Object type identifier
527
+ */
528
+ export const GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodySupplyAreaObject =
529
+ {
530
+ SupplyArea: "supply_area",
531
+ } as const;
532
+ /**
533
+ * Object type identifier
534
+ */
535
+ export type GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodySupplyAreaObject =
536
+ ClosedEnum<
537
+ typeof GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodySupplyAreaObject
538
+ >;
539
+
540
+ /**
541
+ * A geographic boundary defining the area served by a specific substation
542
+ */
543
+ export type GetEnergyForPropertySupplyArea = {
544
+ /**
545
+ * Area of the supply boundary in square kilometres
546
+ */
547
+ areaSqkm: number | null;
548
+ /**
549
+ * Classification of supply area boundary. Each type corresponds to a level in the network hierarchy. Known values: 'gsp', 'bsp', 'grid', 'primary', 'distribution'. 'distribution' is the most granular, 'gsp' (Grid Supply Point) is the broadest.
550
+ */
551
+ areaType: string | null;
552
+ /**
553
+ * WGS84 coordinate pair
554
+ */
555
+ centroid: GetEnergyForPropertyEnergyResponse200Coordinates | null;
556
+ /**
557
+ * Unique supply area identifier, prefixed with the operator code
558
+ */
559
+ code: string;
560
+ /**
561
+ * ISO 3166-1 alpha-2 country code
562
+ */
563
+ country: string;
564
+ /**
565
+ * Human-readable supply area name, where available
566
+ */
567
+ name: string | null;
568
+ /**
569
+ * Object type identifier
570
+ */
571
+ object:
572
+ GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodySupplyAreaObject;
573
+ /**
574
+ * Operating region name
575
+ */
576
+ operatingRegion: string | null;
577
+ /**
578
+ * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
579
+ */
580
+ operator: string;
581
+ /**
582
+ * Code of the substation that serves this supply area
583
+ */
584
+ substationCode: string | null;
585
+ };
586
+
587
+ /**
588
+ * Complete energy infrastructure context for a property location. Resolves the property coordinates to its serving supply area and substation, then enriches with capacity history, registered connections, and future energy forecasts. Use the `include` query parameter to select which layers to return (defaults to all). If a layer is requested via `include` but no data exists for the property's location, that field will be `null` (not omitted from the response)
589
+ */
590
+ export type GetEnergyForPropertyEnergyForProperty = {
591
+ /**
592
+ * Historical quarterly capacity snapshots for the serving substation, ordered chronologically. Omitted if not requested via `include`
593
+ */
594
+ capacitySnapshots?: Array<CapacitySnapshot> | undefined;
595
+ /**
596
+ * Grid connection queue entries at or near the serving substation. Omitted if not requested via `include`
597
+ */
598
+ connectionQueueEntries?:
599
+ | Array<GetEnergyForPropertyConnectionQueueEntry>
600
+ | undefined;
601
+ /**
602
+ * ISO 3166-1 alpha-2 country code, derived from the resolved operator. Null if no infrastructure was resolved
603
+ */
604
+ country: string | null;
605
+ /**
606
+ * Future energy scenario forecasts for the serving substation. Omitted if not requested via `include`
607
+ */
608
+ dfesForecasts?: Array<DfesForecast> | undefined;
609
+ /**
610
+ * Generation and storage connections registered at or near the serving substation. Omitted if not requested via `include`
611
+ */
612
+ ecrEntries?: Array<EcrEntry> | undefined;
613
+ /**
614
+ * Unique location identifier (e.g. UPRN in the UK)
615
+ */
616
+ locationId: string;
617
+ /**
618
+ * Object type identifier
619
+ */
620
+ object: GetEnergyForPropertyObject;
621
+ /**
622
+ * A network operator substation with its current capacity and headroom data
623
+ */
624
+ substation?: GetEnergyForPropertySubstation | null | undefined;
625
+ /**
626
+ * A geographic boundary defining the area served by a specific substation
627
+ */
628
+ supplyArea?: GetEnergyForPropertySupplyArea | null | undefined;
629
+ };
630
+
631
+ /** @internal */
632
+ export type GetEnergyForPropertyRequest$Outbound = {
633
+ include?: string | undefined;
634
+ lat?: number | null | undefined;
635
+ locationId: string;
636
+ lon?: number | null | undefined;
637
+ };
638
+
639
+ /** @internal */
640
+ export const GetEnergyForPropertyRequest$outboundSchema: z.ZodType<
641
+ GetEnergyForPropertyRequest$Outbound,
642
+ z.ZodTypeDef,
643
+ GetEnergyForPropertyRequest
644
+ > = z.object({
645
+ include: z.string().optional(),
646
+ lat: z.nullable(z.number()).optional(),
647
+ locationId: z.string(),
648
+ lon: z.nullable(z.number()).optional(),
649
+ });
650
+
651
+ export function getEnergyForPropertyRequestToJSON(
652
+ getEnergyForPropertyRequest: GetEnergyForPropertyRequest,
653
+ ): string {
654
+ return JSON.stringify(
655
+ GetEnergyForPropertyRequest$outboundSchema.parse(
656
+ getEnergyForPropertyRequest,
657
+ ),
658
+ );
659
+ }
660
+
661
+ /** @internal */
662
+ export const GetEnergyForPropertyEnergyObject$inboundSchema: z.ZodNativeEnum<
663
+ typeof GetEnergyForPropertyEnergyObject
664
+ > = z.nativeEnum(GetEnergyForPropertyEnergyObject);
665
+
666
+ /** @internal */
667
+ export const CapacitySnapshot$inboundSchema: z.ZodType<
668
+ CapacitySnapshot,
669
+ z.ZodTypeDef,
670
+ unknown
671
+ > = z.object({
672
+ batteryHeadroomMw: z.nullable(z.number()),
673
+ demandHeadroomMw: z.nullable(z.number()),
674
+ demandMw: z.nullable(z.number()),
675
+ evHeadroomMw: z.nullable(z.number()),
676
+ firmCapacityMw: z.nullable(z.number()),
677
+ generationHeadroomMw: z.nullable(z.number()),
678
+ object: GetEnergyForPropertyEnergyObject$inboundSchema,
679
+ snapshotDate: z.string(),
680
+ snapshotSource: z.string(),
681
+ solarHeadroomMw: z.nullable(z.number()),
682
+ substationCode: z.string(),
683
+ utilisationPct: z.nullable(z.number()),
684
+ });
685
+
686
+ export function capacitySnapshotFromJSON(
687
+ jsonString: string,
688
+ ): SafeParseResult<CapacitySnapshot, SDKValidationError> {
689
+ return safeParse(
690
+ jsonString,
691
+ (x) => CapacitySnapshot$inboundSchema.parse(JSON.parse(x)),
692
+ `Failed to parse 'CapacitySnapshot' from JSON`,
693
+ );
694
+ }
695
+
696
+ /** @internal */
697
+ export const GetEnergyForPropertyCoordinates$inboundSchema: z.ZodType<
698
+ GetEnergyForPropertyCoordinates,
699
+ z.ZodTypeDef,
700
+ unknown
701
+ > = z.object({
702
+ lat: z.number(),
703
+ lng: z.number(),
704
+ });
705
+
706
+ export function getEnergyForPropertyCoordinatesFromJSON(
707
+ jsonString: string,
708
+ ): SafeParseResult<GetEnergyForPropertyCoordinates, SDKValidationError> {
709
+ return safeParse(
710
+ jsonString,
711
+ (x) => GetEnergyForPropertyCoordinates$inboundSchema.parse(JSON.parse(x)),
712
+ `Failed to parse 'GetEnergyForPropertyCoordinates' from JSON`,
713
+ );
714
+ }
715
+
716
+ /** @internal */
717
+ export const GetEnergyForPropertyEnergyResponseObject$inboundSchema:
718
+ z.ZodNativeEnum<typeof GetEnergyForPropertyEnergyResponseObject> = z
719
+ .nativeEnum(GetEnergyForPropertyEnergyResponseObject);
720
+
721
+ /** @internal */
722
+ export const GetEnergyForPropertyConnectionQueueTechnology$inboundSchema:
723
+ z.ZodType<
724
+ GetEnergyForPropertyConnectionQueueTechnology,
725
+ z.ZodTypeDef,
726
+ unknown
727
+ > = z.object({
728
+ capacityMw: z.nullable(z.number()),
729
+ isPrimary: z.boolean(),
730
+ technologyCategory: z.nullable(z.string()),
731
+ technologyType: z.string(),
732
+ });
733
+
734
+ export function getEnergyForPropertyConnectionQueueTechnologyFromJSON(
735
+ jsonString: string,
736
+ ): SafeParseResult<
737
+ GetEnergyForPropertyConnectionQueueTechnology,
738
+ SDKValidationError
739
+ > {
740
+ return safeParse(
741
+ jsonString,
742
+ (x) =>
743
+ GetEnergyForPropertyConnectionQueueTechnology$inboundSchema.parse(
744
+ JSON.parse(x),
745
+ ),
746
+ `Failed to parse 'GetEnergyForPropertyConnectionQueueTechnology' from JSON`,
747
+ );
748
+ }
749
+
750
+ /** @internal */
751
+ export const GetEnergyForPropertyConnectionQueueEntry$inboundSchema: z.ZodType<
752
+ GetEnergyForPropertyConnectionQueueEntry,
753
+ z.ZodTypeDef,
754
+ unknown
755
+ > = z.object({
756
+ acceptanceDate: z.nullable(z.string()),
757
+ applicationDate: z.nullable(z.string()),
758
+ capacityMw: z.nullable(z.number()),
759
+ connectionDate: z.nullable(z.string()),
760
+ connectionSite: z.nullable(z.string()),
761
+ connectionStatus: z.nullable(z.string()),
762
+ country: z.string(),
763
+ cumulativeCapacityMw: z.nullable(z.number()),
764
+ customerName: z.nullable(z.string()),
765
+ exportCapacityMw: z.nullable(z.number()),
766
+ importCapacityMw: z.nullable(z.number()),
767
+ location: z.nullable(
768
+ z.lazy(() => GetEnergyForPropertyCoordinates$inboundSchema),
769
+ ),
770
+ networkLevel: z.nullable(z.string()),
771
+ object: GetEnergyForPropertyEnergyResponseObject$inboundSchema,
772
+ offerDate: z.nullable(z.string()),
773
+ operatingRegion: z.nullable(z.string()),
774
+ operator: z.string(),
775
+ projectId: z.string(),
776
+ projectName: z.nullable(z.string()),
777
+ projectNumber: z.nullable(z.string()),
778
+ queuePosition: z.nullable(z.number()),
779
+ sourceDataset: z.string(),
780
+ substationCode: z.nullable(z.string()),
781
+ technologies: z.array(
782
+ z.lazy(() => GetEnergyForPropertyConnectionQueueTechnology$inboundSchema),
783
+ ).optional(),
784
+ technologyCategory: z.nullable(z.string()),
785
+ technologyType: z.nullable(z.string()),
786
+ });
787
+
788
+ export function getEnergyForPropertyConnectionQueueEntryFromJSON(
789
+ jsonString: string,
790
+ ): SafeParseResult<
791
+ GetEnergyForPropertyConnectionQueueEntry,
792
+ SDKValidationError
793
+ > {
794
+ return safeParse(
795
+ jsonString,
796
+ (x) =>
797
+ GetEnergyForPropertyConnectionQueueEntry$inboundSchema.parse(
798
+ JSON.parse(x),
799
+ ),
800
+ `Failed to parse 'GetEnergyForPropertyConnectionQueueEntry' from JSON`,
801
+ );
802
+ }
803
+
804
+ /** @internal */
805
+ export const GetEnergyForPropertyEnergyResponse200Object$inboundSchema:
806
+ z.ZodNativeEnum<typeof GetEnergyForPropertyEnergyResponse200Object> = z
807
+ .nativeEnum(GetEnergyForPropertyEnergyResponse200Object);
808
+
809
+ /** @internal */
810
+ export const DfesForecast$inboundSchema: z.ZodType<
811
+ DfesForecast,
812
+ z.ZodTypeDef,
813
+ unknown
814
+ > = z.object({
815
+ country: z.string(),
816
+ forecastMw: z.nullable(z.number()),
817
+ forecastType: z.string(),
818
+ object: GetEnergyForPropertyEnergyResponse200Object$inboundSchema,
819
+ operatingRegion: z.string(),
820
+ operator: z.string(),
821
+ scenario: z.string(),
822
+ substationCode: z.nullable(z.string()),
823
+ technologyType: z.nullable(z.string()),
824
+ year: z.number(),
825
+ });
826
+
827
+ export function dfesForecastFromJSON(
828
+ jsonString: string,
829
+ ): SafeParseResult<DfesForecast, SDKValidationError> {
830
+ return safeParse(
831
+ jsonString,
832
+ (x) => DfesForecast$inboundSchema.parse(JSON.parse(x)),
833
+ `Failed to parse 'DfesForecast' from JSON`,
834
+ );
835
+ }
836
+
837
+ /** @internal */
838
+ export const GetEnergyForPropertyEnergyCoordinates$inboundSchema: z.ZodType<
839
+ GetEnergyForPropertyEnergyCoordinates,
840
+ z.ZodTypeDef,
841
+ unknown
842
+ > = z.object({
843
+ lat: z.number(),
844
+ lng: z.number(),
845
+ });
846
+
847
+ export function getEnergyForPropertyEnergyCoordinatesFromJSON(
848
+ jsonString: string,
849
+ ): SafeParseResult<GetEnergyForPropertyEnergyCoordinates, SDKValidationError> {
850
+ return safeParse(
851
+ jsonString,
852
+ (x) =>
853
+ GetEnergyForPropertyEnergyCoordinates$inboundSchema.parse(JSON.parse(x)),
854
+ `Failed to parse 'GetEnergyForPropertyEnergyCoordinates' from JSON`,
855
+ );
856
+ }
857
+
858
+ /** @internal */
859
+ export const GetEnergyForPropertyEnergyResponse200ApplicationJSONObject$inboundSchema:
860
+ z.ZodNativeEnum<
861
+ typeof GetEnergyForPropertyEnergyResponse200ApplicationJSONObject
862
+ > = z.nativeEnum(GetEnergyForPropertyEnergyResponse200ApplicationJSONObject);
863
+
864
+ /** @internal */
865
+ export const EcrEntry$inboundSchema: z.ZodType<
866
+ EcrEntry,
867
+ z.ZodTypeDef,
868
+ unknown
869
+ > = z.object({
870
+ code: z.string(),
871
+ connectionDate: z.nullable(z.string()),
872
+ connectionStatus: z.nullable(z.string()),
873
+ connectionType: z.nullable(z.string()),
874
+ country: z.string(),
875
+ exportCapacityMw: z.nullable(z.number()),
876
+ installedCapacityMw: z.nullable(z.number()),
877
+ location: z.nullable(
878
+ z.lazy(() => GetEnergyForPropertyEnergyCoordinates$inboundSchema),
879
+ ),
880
+ object:
881
+ GetEnergyForPropertyEnergyResponse200ApplicationJSONObject$inboundSchema,
882
+ operatingRegion: z.nullable(z.string()),
883
+ operator: z.string(),
884
+ substationCode: z.nullable(z.string()),
885
+ technologyType: z.nullable(z.string()),
886
+ });
887
+
888
+ export function ecrEntryFromJSON(
889
+ jsonString: string,
890
+ ): SafeParseResult<EcrEntry, SDKValidationError> {
891
+ return safeParse(
892
+ jsonString,
893
+ (x) => EcrEntry$inboundSchema.parse(JSON.parse(x)),
894
+ `Failed to parse 'EcrEntry' from JSON`,
895
+ );
896
+ }
897
+
898
+ /** @internal */
899
+ export const GetEnergyForPropertyObject$inboundSchema: z.ZodNativeEnum<
900
+ typeof GetEnergyForPropertyObject
901
+ > = z.nativeEnum(GetEnergyForPropertyObject);
902
+
903
+ /** @internal */
904
+ export const GetEnergyForPropertyEnergyResponseCoordinates$inboundSchema:
905
+ z.ZodType<
906
+ GetEnergyForPropertyEnergyResponseCoordinates,
907
+ z.ZodTypeDef,
908
+ unknown
909
+ > = z.object({
910
+ lat: z.number(),
911
+ lng: z.number(),
912
+ });
913
+
914
+ export function getEnergyForPropertyEnergyResponseCoordinatesFromJSON(
915
+ jsonString: string,
916
+ ): SafeParseResult<
917
+ GetEnergyForPropertyEnergyResponseCoordinates,
918
+ SDKValidationError
919
+ > {
920
+ return safeParse(
921
+ jsonString,
922
+ (x) =>
923
+ GetEnergyForPropertyEnergyResponseCoordinates$inboundSchema.parse(
924
+ JSON.parse(x),
925
+ ),
926
+ `Failed to parse 'GetEnergyForPropertyEnergyResponseCoordinates' from JSON`,
927
+ );
928
+ }
929
+
930
+ /** @internal */
931
+ export const GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodyObject$inboundSchema:
932
+ z.ZodNativeEnum<
933
+ typeof GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodyObject
934
+ > = z.nativeEnum(
935
+ GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodyObject,
936
+ );
937
+
938
+ /** @internal */
939
+ export const GetEnergyForPropertySubstation$inboundSchema: z.ZodType<
940
+ GetEnergyForPropertySubstation,
941
+ z.ZodTypeDef,
942
+ unknown
943
+ > = z.object({
944
+ code: z.string(),
945
+ country: z.string(),
946
+ demandHeadroomMw: z.nullable(z.number()),
947
+ demandMw: z.nullable(z.number()),
948
+ firmCapacityMw: z.nullable(z.number()),
949
+ generationHeadroomMw: z.nullable(z.number()),
950
+ location: z.nullable(
951
+ z.lazy(() => GetEnergyForPropertyEnergyResponseCoordinates$inboundSchema),
952
+ ),
953
+ name: z.nullable(z.string()),
954
+ object:
955
+ GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodyObject$inboundSchema,
956
+ operatingRegion: z.nullable(z.string()),
957
+ operator: z.string(),
958
+ parentSubstationCode: z.nullable(z.string()),
959
+ reversePowerCapacityMw: z.nullable(z.number()),
960
+ substationType: z.nullable(z.string()),
961
+ utilisationPct: z.nullable(z.number()),
962
+ voltageKv: z.nullable(z.number()),
963
+ });
964
+
965
+ export function getEnergyForPropertySubstationFromJSON(
966
+ jsonString: string,
967
+ ): SafeParseResult<GetEnergyForPropertySubstation, SDKValidationError> {
968
+ return safeParse(
969
+ jsonString,
970
+ (x) => GetEnergyForPropertySubstation$inboundSchema.parse(JSON.parse(x)),
971
+ `Failed to parse 'GetEnergyForPropertySubstation' from JSON`,
972
+ );
973
+ }
974
+
975
+ /** @internal */
976
+ export const GetEnergyForPropertyEnergyResponse200Coordinates$inboundSchema:
977
+ z.ZodType<
978
+ GetEnergyForPropertyEnergyResponse200Coordinates,
979
+ z.ZodTypeDef,
980
+ unknown
981
+ > = z.object({
982
+ lat: z.number(),
983
+ lng: z.number(),
984
+ });
985
+
986
+ export function getEnergyForPropertyEnergyResponse200CoordinatesFromJSON(
987
+ jsonString: string,
988
+ ): SafeParseResult<
989
+ GetEnergyForPropertyEnergyResponse200Coordinates,
990
+ SDKValidationError
991
+ > {
992
+ return safeParse(
993
+ jsonString,
994
+ (x) =>
995
+ GetEnergyForPropertyEnergyResponse200Coordinates$inboundSchema.parse(
996
+ JSON.parse(x),
997
+ ),
998
+ `Failed to parse 'GetEnergyForPropertyEnergyResponse200Coordinates' from JSON`,
999
+ );
1000
+ }
1001
+
1002
+ /** @internal */
1003
+ export const GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodySupplyAreaObject$inboundSchema:
1004
+ z.ZodNativeEnum<
1005
+ typeof GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodySupplyAreaObject
1006
+ > = z.nativeEnum(
1007
+ GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodySupplyAreaObject,
1008
+ );
1009
+
1010
+ /** @internal */
1011
+ export const GetEnergyForPropertySupplyArea$inboundSchema: z.ZodType<
1012
+ GetEnergyForPropertySupplyArea,
1013
+ z.ZodTypeDef,
1014
+ unknown
1015
+ > = z.object({
1016
+ areaSqkm: z.nullable(z.number()),
1017
+ areaType: z.nullable(z.string()),
1018
+ centroid: z.nullable(
1019
+ z.lazy(() =>
1020
+ GetEnergyForPropertyEnergyResponse200Coordinates$inboundSchema
1021
+ ),
1022
+ ),
1023
+ code: z.string(),
1024
+ country: z.string(),
1025
+ name: z.nullable(z.string()),
1026
+ object:
1027
+ GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodySupplyAreaObject$inboundSchema,
1028
+ operatingRegion: z.nullable(z.string()),
1029
+ operator: z.string(),
1030
+ substationCode: z.nullable(z.string()),
1031
+ });
1032
+
1033
+ export function getEnergyForPropertySupplyAreaFromJSON(
1034
+ jsonString: string,
1035
+ ): SafeParseResult<GetEnergyForPropertySupplyArea, SDKValidationError> {
1036
+ return safeParse(
1037
+ jsonString,
1038
+ (x) => GetEnergyForPropertySupplyArea$inboundSchema.parse(JSON.parse(x)),
1039
+ `Failed to parse 'GetEnergyForPropertySupplyArea' from JSON`,
1040
+ );
1041
+ }
1042
+
1043
+ /** @internal */
1044
+ export const GetEnergyForPropertyEnergyForProperty$inboundSchema: z.ZodType<
1045
+ GetEnergyForPropertyEnergyForProperty,
1046
+ z.ZodTypeDef,
1047
+ unknown
1048
+ > = z.object({
1049
+ capacitySnapshots: z.array(z.lazy(() => CapacitySnapshot$inboundSchema))
1050
+ .optional(),
1051
+ connectionQueueEntries: z.array(
1052
+ z.lazy(() => GetEnergyForPropertyConnectionQueueEntry$inboundSchema),
1053
+ ).optional(),
1054
+ country: z.nullable(z.string()),
1055
+ dfesForecasts: z.array(z.lazy(() => DfesForecast$inboundSchema)).optional(),
1056
+ ecrEntries: z.array(z.lazy(() => EcrEntry$inboundSchema)).optional(),
1057
+ locationId: z.string(),
1058
+ object: GetEnergyForPropertyObject$inboundSchema,
1059
+ substation: z.nullable(
1060
+ z.lazy(() => GetEnergyForPropertySubstation$inboundSchema),
1061
+ ).optional(),
1062
+ supplyArea: z.nullable(
1063
+ z.lazy(() => GetEnergyForPropertySupplyArea$inboundSchema),
1064
+ ).optional(),
1065
+ });
1066
+
1067
+ export function getEnergyForPropertyEnergyForPropertyFromJSON(
1068
+ jsonString: string,
1069
+ ): SafeParseResult<GetEnergyForPropertyEnergyForProperty, SDKValidationError> {
1070
+ return safeParse(
1071
+ jsonString,
1072
+ (x) =>
1073
+ GetEnergyForPropertyEnergyForProperty$inboundSchema.parse(JSON.parse(x)),
1074
+ `Failed to parse 'GetEnergyForPropertyEnergyForProperty' from JSON`,
1075
+ );
1076
+ }