@vepler/sdk 2.8.0 → 2.12.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 (291) hide show
  1. package/README.md +2 -7
  2. package/dist/commonjs/funcs/avmPredictPropertyValue.d.ts +1 -1
  3. package/dist/commonjs/funcs/avmPredictPropertyValue.js +1 -1
  4. package/dist/commonjs/funcs/avmPredictPropertyValueByLocation.d.ts +18 -0
  5. package/dist/commonjs/funcs/avmPredictPropertyValueByLocation.d.ts.map +1 -0
  6. package/dist/commonjs/funcs/{epcGetEPCByPostcode.js → avmPredictPropertyValueByLocation.js} +13 -17
  7. package/dist/commonjs/funcs/avmPredictPropertyValueByLocation.js.map +1 -0
  8. package/dist/commonjs/lib/config.d.ts +3 -3
  9. package/dist/commonjs/lib/config.js +3 -3
  10. package/dist/commonjs/lib/config.js.map +1 -1
  11. package/dist/commonjs/lib/encodings.d.ts +1 -0
  12. package/dist/commonjs/lib/encodings.d.ts.map +1 -1
  13. package/dist/commonjs/lib/encodings.js +12 -1
  14. package/dist/commonjs/lib/encodings.js.map +1 -1
  15. package/dist/commonjs/sdk/avm.d.ts +8 -1
  16. package/dist/commonjs/sdk/avm.d.ts.map +1 -1
  17. package/dist/commonjs/sdk/avm.js +11 -1
  18. package/dist/commonjs/sdk/avm.js.map +1 -1
  19. package/dist/commonjs/sdk/models/operations/getareasbyfieldandids.d.ts +48 -6
  20. package/dist/commonjs/sdk/models/operations/getareasbyfieldandids.d.ts.map +1 -1
  21. package/dist/commonjs/sdk/models/operations/getareasbyfieldandids.js +46 -4
  22. package/dist/commonjs/sdk/models/operations/getareasbyfieldandids.js.map +1 -1
  23. package/dist/commonjs/sdk/models/operations/getareaswithinradius.d.ts +95 -11
  24. package/dist/commonjs/sdk/models/operations/getareaswithinradius.d.ts.map +1 -1
  25. package/dist/commonjs/sdk/models/operations/getareaswithinradius.js +92 -8
  26. package/dist/commonjs/sdk/models/operations/getareaswithinradius.js.map +1 -1
  27. package/dist/commonjs/sdk/models/operations/getborderingareas.d.ts +96 -12
  28. package/dist/commonjs/sdk/models/operations/getborderingareas.d.ts.map +1 -1
  29. package/dist/commonjs/sdk/models/operations/getborderingareas.js +92 -8
  30. package/dist/commonjs/sdk/models/operations/getborderingareas.js.map +1 -1
  31. package/dist/commonjs/sdk/models/operations/getchildareas.d.ts +96 -12
  32. package/dist/commonjs/sdk/models/operations/getchildareas.d.ts.map +1 -1
  33. package/dist/commonjs/sdk/models/operations/getchildareas.js +92 -8
  34. package/dist/commonjs/sdk/models/operations/getchildareas.js.map +1 -1
  35. package/dist/commonjs/sdk/models/operations/getmetricvalues.d.ts +144 -18
  36. package/dist/commonjs/sdk/models/operations/getmetricvalues.d.ts.map +1 -1
  37. package/dist/commonjs/sdk/models/operations/getmetricvalues.js +138 -12
  38. package/dist/commonjs/sdk/models/operations/getmetricvalues.js.map +1 -1
  39. package/dist/commonjs/sdk/models/operations/index.d.ts +1 -2
  40. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  41. package/dist/commonjs/sdk/models/operations/index.js +1 -2
  42. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  43. package/dist/commonjs/sdk/models/operations/predictpropertyvaluebylocation.d.ts +206 -0
  44. package/dist/commonjs/sdk/models/operations/predictpropertyvaluebylocation.d.ts.map +1 -0
  45. package/dist/commonjs/sdk/models/operations/predictpropertyvaluebylocation.js +199 -0
  46. package/dist/commonjs/sdk/models/operations/predictpropertyvaluebylocation.js.map +1 -0
  47. package/dist/commonjs/sdk/models/shared/avmpredictbylocationrequest.d.ts +148 -0
  48. package/dist/commonjs/sdk/models/shared/avmpredictbylocationrequest.d.ts.map +1 -0
  49. package/dist/commonjs/sdk/models/shared/avmpredictbylocationrequest.js +119 -0
  50. package/dist/commonjs/sdk/models/shared/avmpredictbylocationrequest.js.map +1 -0
  51. package/dist/commonjs/sdk/models/shared/avmpredictrequest.d.ts +16 -16
  52. package/dist/commonjs/sdk/models/shared/avmpredictrequest.d.ts.map +1 -1
  53. package/dist/commonjs/sdk/models/shared/avmpredictrequest.js +13 -14
  54. package/dist/commonjs/sdk/models/shared/avmpredictrequest.js.map +1 -1
  55. package/dist/commonjs/sdk/models/shared/builddata.d.ts +57 -1
  56. package/dist/commonjs/sdk/models/shared/builddata.d.ts.map +1 -1
  57. package/dist/commonjs/sdk/models/shared/builddata.js +56 -2
  58. package/dist/commonjs/sdk/models/shared/builddata.js.map +1 -1
  59. package/dist/commonjs/sdk/models/shared/index.d.ts +1 -0
  60. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  61. package/dist/commonjs/sdk/models/shared/index.js +1 -0
  62. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  63. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts +3 -257
  64. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  65. package/dist/commonjs/sdk/models/shared/propertydataapi.js +4 -255
  66. package/dist/commonjs/sdk/models/shared/propertydataapi.js.map +1 -1
  67. package/dist/commonjs/sdk/models/shared/propertytags.d.ts +8 -4
  68. package/dist/commonjs/sdk/models/shared/propertytags.d.ts.map +1 -1
  69. package/dist/commonjs/sdk/models/shared/propertytags.js +2 -1
  70. package/dist/commonjs/sdk/models/shared/propertytags.js.map +1 -1
  71. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.d.ts +2 -9
  72. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.d.ts.map +1 -1
  73. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.js +2 -7
  74. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.js.map +1 -1
  75. package/dist/commonjs/sdk/models/shared/streetquerybyname.d.ts +2 -9
  76. package/dist/commonjs/sdk/models/shared/streetquerybyname.d.ts.map +1 -1
  77. package/dist/commonjs/sdk/models/shared/streetquerybyname.js +2 -7
  78. package/dist/commonjs/sdk/models/shared/streetquerybyname.js.map +1 -1
  79. package/dist/commonjs/sdk/models/shared/streetquerybypostcode.d.ts +2 -9
  80. package/dist/commonjs/sdk/models/shared/streetquerybypostcode.d.ts.map +1 -1
  81. package/dist/commonjs/sdk/models/shared/streetquerybypostcode.js +2 -7
  82. package/dist/commonjs/sdk/models/shared/streetquerybypostcode.js.map +1 -1
  83. package/dist/commonjs/sdk/models/shared/streetquerybyuprn.d.ts +2 -9
  84. package/dist/commonjs/sdk/models/shared/streetquerybyuprn.d.ts.map +1 -1
  85. package/dist/commonjs/sdk/models/shared/streetquerybyuprn.js +2 -7
  86. package/dist/commonjs/sdk/models/shared/streetquerybyuprn.js.map +1 -1
  87. package/dist/commonjs/sdk/models/shared/streetquerybyusrn.d.ts +2 -9
  88. package/dist/commonjs/sdk/models/shared/streetquerybyusrn.d.ts.map +1 -1
  89. package/dist/commonjs/sdk/models/shared/streetquerybyusrn.js +2 -7
  90. package/dist/commonjs/sdk/models/shared/streetquerybyusrn.js.map +1 -1
  91. package/dist/commonjs/sdk/models/shared/streetqueryrequest.d.ts +4 -44
  92. package/dist/commonjs/sdk/models/shared/streetqueryrequest.d.ts.map +1 -1
  93. package/dist/commonjs/sdk/models/shared/streetqueryrequest.js +10 -24
  94. package/dist/commonjs/sdk/models/shared/streetqueryrequest.js.map +1 -1
  95. package/dist/commonjs/sdk/sdk.d.ts +0 -3
  96. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  97. package/dist/commonjs/sdk/sdk.js +0 -4
  98. package/dist/commonjs/sdk/sdk.js.map +1 -1
  99. package/dist/commonjs/sdk/types/enums.d.ts +1 -8
  100. package/dist/commonjs/sdk/types/enums.d.ts.map +1 -1
  101. package/dist/commonjs/sdk/types/enums.js +3 -21
  102. package/dist/commonjs/sdk/types/enums.js.map +1 -1
  103. package/dist/commonjs/sdk/types/index.d.ts +2 -1
  104. package/dist/commonjs/sdk/types/index.d.ts.map +1 -1
  105. package/dist/commonjs/sdk/types/index.js +15 -0
  106. package/dist/commonjs/sdk/types/index.js.map +1 -1
  107. package/dist/commonjs/sdk/types/unrecognized.d.ts +16 -0
  108. package/dist/commonjs/sdk/types/unrecognized.d.ts.map +1 -0
  109. package/dist/commonjs/sdk/types/unrecognized.js +34 -0
  110. package/dist/commonjs/sdk/types/unrecognized.js.map +1 -0
  111. package/dist/esm/funcs/avmPredictPropertyValue.d.ts +1 -1
  112. package/dist/esm/funcs/avmPredictPropertyValue.js +1 -1
  113. package/dist/esm/funcs/avmPredictPropertyValueByLocation.d.ts +18 -0
  114. package/dist/esm/funcs/avmPredictPropertyValueByLocation.d.ts.map +1 -0
  115. package/dist/esm/funcs/{epcGetEPCByPostcode.js → avmPredictPropertyValueByLocation.js} +13 -17
  116. package/dist/esm/funcs/avmPredictPropertyValueByLocation.js.map +1 -0
  117. package/dist/esm/lib/config.d.ts +3 -3
  118. package/dist/esm/lib/config.js +3 -3
  119. package/dist/esm/lib/config.js.map +1 -1
  120. package/dist/esm/lib/encodings.d.ts +1 -0
  121. package/dist/esm/lib/encodings.d.ts.map +1 -1
  122. package/dist/esm/lib/encodings.js +12 -1
  123. package/dist/esm/lib/encodings.js.map +1 -1
  124. package/dist/esm/sdk/avm.d.ts +8 -1
  125. package/dist/esm/sdk/avm.d.ts.map +1 -1
  126. package/dist/esm/sdk/avm.js +11 -1
  127. package/dist/esm/sdk/avm.js.map +1 -1
  128. package/dist/esm/sdk/models/operations/getareasbyfieldandids.d.ts +48 -6
  129. package/dist/esm/sdk/models/operations/getareasbyfieldandids.d.ts.map +1 -1
  130. package/dist/esm/sdk/models/operations/getareasbyfieldandids.js +46 -4
  131. package/dist/esm/sdk/models/operations/getareasbyfieldandids.js.map +1 -1
  132. package/dist/esm/sdk/models/operations/getareaswithinradius.d.ts +95 -11
  133. package/dist/esm/sdk/models/operations/getareaswithinradius.d.ts.map +1 -1
  134. package/dist/esm/sdk/models/operations/getareaswithinradius.js +92 -8
  135. package/dist/esm/sdk/models/operations/getareaswithinradius.js.map +1 -1
  136. package/dist/esm/sdk/models/operations/getborderingareas.d.ts +96 -12
  137. package/dist/esm/sdk/models/operations/getborderingareas.d.ts.map +1 -1
  138. package/dist/esm/sdk/models/operations/getborderingareas.js +92 -8
  139. package/dist/esm/sdk/models/operations/getborderingareas.js.map +1 -1
  140. package/dist/esm/sdk/models/operations/getchildareas.d.ts +96 -12
  141. package/dist/esm/sdk/models/operations/getchildareas.d.ts.map +1 -1
  142. package/dist/esm/sdk/models/operations/getchildareas.js +92 -8
  143. package/dist/esm/sdk/models/operations/getchildareas.js.map +1 -1
  144. package/dist/esm/sdk/models/operations/getmetricvalues.d.ts +144 -18
  145. package/dist/esm/sdk/models/operations/getmetricvalues.d.ts.map +1 -1
  146. package/dist/esm/sdk/models/operations/getmetricvalues.js +138 -12
  147. package/dist/esm/sdk/models/operations/getmetricvalues.js.map +1 -1
  148. package/dist/esm/sdk/models/operations/index.d.ts +1 -2
  149. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  150. package/dist/esm/sdk/models/operations/index.js +1 -2
  151. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  152. package/dist/esm/sdk/models/operations/predictpropertyvaluebylocation.d.ts +206 -0
  153. package/dist/esm/sdk/models/operations/predictpropertyvaluebylocation.d.ts.map +1 -0
  154. package/dist/esm/sdk/models/operations/predictpropertyvaluebylocation.js +154 -0
  155. package/dist/esm/sdk/models/operations/predictpropertyvaluebylocation.js.map +1 -0
  156. package/dist/esm/sdk/models/shared/avmpredictbylocationrequest.d.ts +148 -0
  157. package/dist/esm/sdk/models/shared/avmpredictbylocationrequest.d.ts.map +1 -0
  158. package/dist/esm/sdk/models/shared/avmpredictbylocationrequest.js +82 -0
  159. package/dist/esm/sdk/models/shared/avmpredictbylocationrequest.js.map +1 -0
  160. package/dist/esm/sdk/models/shared/avmpredictrequest.d.ts +16 -16
  161. package/dist/esm/sdk/models/shared/avmpredictrequest.d.ts.map +1 -1
  162. package/dist/esm/sdk/models/shared/avmpredictrequest.js +12 -13
  163. package/dist/esm/sdk/models/shared/avmpredictrequest.js.map +1 -1
  164. package/dist/esm/sdk/models/shared/builddata.d.ts +57 -1
  165. package/dist/esm/sdk/models/shared/builddata.d.ts.map +1 -1
  166. package/dist/esm/sdk/models/shared/builddata.js +55 -1
  167. package/dist/esm/sdk/models/shared/builddata.js.map +1 -1
  168. package/dist/esm/sdk/models/shared/index.d.ts +1 -0
  169. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  170. package/dist/esm/sdk/models/shared/index.js +1 -0
  171. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  172. package/dist/esm/sdk/models/shared/propertydataapi.d.ts +3 -257
  173. package/dist/esm/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  174. package/dist/esm/sdk/models/shared/propertydataapi.js +3 -254
  175. package/dist/esm/sdk/models/shared/propertydataapi.js.map +1 -1
  176. package/dist/esm/sdk/models/shared/propertytags.d.ts +8 -4
  177. package/dist/esm/sdk/models/shared/propertytags.d.ts.map +1 -1
  178. package/dist/esm/sdk/models/shared/propertytags.js +2 -1
  179. package/dist/esm/sdk/models/shared/propertytags.js.map +1 -1
  180. package/dist/esm/sdk/models/shared/streetquerybycoordinates.d.ts +2 -9
  181. package/dist/esm/sdk/models/shared/streetquerybycoordinates.d.ts.map +1 -1
  182. package/dist/esm/sdk/models/shared/streetquerybycoordinates.js +1 -6
  183. package/dist/esm/sdk/models/shared/streetquerybycoordinates.js.map +1 -1
  184. package/dist/esm/sdk/models/shared/streetquerybyname.d.ts +2 -9
  185. package/dist/esm/sdk/models/shared/streetquerybyname.d.ts.map +1 -1
  186. package/dist/esm/sdk/models/shared/streetquerybyname.js +1 -6
  187. package/dist/esm/sdk/models/shared/streetquerybyname.js.map +1 -1
  188. package/dist/esm/sdk/models/shared/streetquerybypostcode.d.ts +2 -9
  189. package/dist/esm/sdk/models/shared/streetquerybypostcode.d.ts.map +1 -1
  190. package/dist/esm/sdk/models/shared/streetquerybypostcode.js +1 -6
  191. package/dist/esm/sdk/models/shared/streetquerybypostcode.js.map +1 -1
  192. package/dist/esm/sdk/models/shared/streetquerybyuprn.d.ts +2 -9
  193. package/dist/esm/sdk/models/shared/streetquerybyuprn.d.ts.map +1 -1
  194. package/dist/esm/sdk/models/shared/streetquerybyuprn.js +1 -6
  195. package/dist/esm/sdk/models/shared/streetquerybyuprn.js.map +1 -1
  196. package/dist/esm/sdk/models/shared/streetquerybyusrn.d.ts +2 -9
  197. package/dist/esm/sdk/models/shared/streetquerybyusrn.d.ts.map +1 -1
  198. package/dist/esm/sdk/models/shared/streetquerybyusrn.js +1 -6
  199. package/dist/esm/sdk/models/shared/streetquerybyusrn.js.map +1 -1
  200. package/dist/esm/sdk/models/shared/streetqueryrequest.d.ts +4 -44
  201. package/dist/esm/sdk/models/shared/streetqueryrequest.d.ts.map +1 -1
  202. package/dist/esm/sdk/models/shared/streetqueryrequest.js +10 -24
  203. package/dist/esm/sdk/models/shared/streetqueryrequest.js.map +1 -1
  204. package/dist/esm/sdk/sdk.d.ts +0 -3
  205. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  206. package/dist/esm/sdk/sdk.js +0 -4
  207. package/dist/esm/sdk/sdk.js.map +1 -1
  208. package/dist/esm/sdk/types/enums.d.ts +1 -8
  209. package/dist/esm/sdk/types/enums.d.ts.map +1 -1
  210. package/dist/esm/sdk/types/enums.js +1 -18
  211. package/dist/esm/sdk/types/enums.js.map +1 -1
  212. package/dist/esm/sdk/types/index.d.ts +2 -1
  213. package/dist/esm/sdk/types/index.d.ts.map +1 -1
  214. package/dist/esm/sdk/types/index.js +1 -0
  215. package/dist/esm/sdk/types/index.js.map +1 -1
  216. package/dist/esm/sdk/types/unrecognized.d.ts +16 -0
  217. package/dist/esm/sdk/types/unrecognized.d.ts.map +1 -0
  218. package/dist/esm/sdk/types/unrecognized.js +31 -0
  219. package/dist/esm/sdk/types/unrecognized.js.map +1 -0
  220. package/package.json +1 -1
  221. package/src/funcs/avmPredictPropertyValue.ts +1 -1
  222. package/src/funcs/{epcGetEPCByPostcode.ts → avmPredictPropertyValueByLocation.ts} +36 -23
  223. package/src/lib/config.ts +3 -3
  224. package/src/lib/encodings.ts +17 -3
  225. package/src/sdk/avm.ts +19 -1
  226. package/src/sdk/models/operations/getareasbyfieldandids.ts +48 -6
  227. package/src/sdk/models/operations/getareaswithinradius.ts +95 -11
  228. package/src/sdk/models/operations/getborderingareas.ts +96 -12
  229. package/src/sdk/models/operations/getchildareas.ts +96 -12
  230. package/src/sdk/models/operations/getmetricvalues.ts +144 -18
  231. package/src/sdk/models/operations/index.ts +1 -2
  232. package/src/sdk/models/operations/predictpropertyvaluebylocation.ts +479 -0
  233. package/src/sdk/models/shared/avmpredictbylocationrequest.ts +194 -0
  234. package/src/sdk/models/shared/avmpredictrequest.ts +36 -26
  235. package/src/sdk/models/shared/builddata.ts +62 -2
  236. package/src/sdk/models/shared/index.ts +1 -0
  237. package/src/sdk/models/shared/propertydataapi.ts +6 -276
  238. package/src/sdk/models/shared/propertytags.ts +10 -5
  239. package/src/sdk/models/shared/streetquerybycoordinates.ts +3 -16
  240. package/src/sdk/models/shared/streetquerybyname.ts +3 -14
  241. package/src/sdk/models/shared/streetquerybypostcode.ts +3 -16
  242. package/src/sdk/models/shared/streetquerybyuprn.ts +3 -14
  243. package/src/sdk/models/shared/streetquerybyusrn.ts +3 -14
  244. package/src/sdk/models/shared/streetqueryrequest.ts +30 -64
  245. package/src/sdk/sdk.ts +0 -6
  246. package/src/sdk/types/enums.ts +1 -21
  247. package/src/sdk/types/index.ts +2 -1
  248. package/src/sdk/types/unrecognized.ts +35 -0
  249. package/tsconfig.json +1 -2
  250. package/dist/commonjs/funcs/epcGetEPC.d.ts +0 -17
  251. package/dist/commonjs/funcs/epcGetEPC.d.ts.map +0 -1
  252. package/dist/commonjs/funcs/epcGetEPC.js +0 -119
  253. package/dist/commonjs/funcs/epcGetEPC.js.map +0 -1
  254. package/dist/commonjs/funcs/epcGetEPCByPostcode.d.ts +0 -17
  255. package/dist/commonjs/funcs/epcGetEPCByPostcode.d.ts.map +0 -1
  256. package/dist/commonjs/funcs/epcGetEPCByPostcode.js.map +0 -1
  257. package/dist/commonjs/sdk/epc.d.ts +0 -19
  258. package/dist/commonjs/sdk/epc.d.ts.map +0 -1
  259. package/dist/commonjs/sdk/epc.js +0 -32
  260. package/dist/commonjs/sdk/epc.js.map +0 -1
  261. package/dist/commonjs/sdk/models/operations/getepcbylocationid.d.ts +0 -130
  262. package/dist/commonjs/sdk/models/operations/getepcbylocationid.d.ts.map +0 -1
  263. package/dist/commonjs/sdk/models/operations/getepcbylocationid.js +0 -140
  264. package/dist/commonjs/sdk/models/operations/getepcbylocationid.js.map +0 -1
  265. package/dist/commonjs/sdk/models/operations/getepcbypostcode.d.ts +0 -82
  266. package/dist/commonjs/sdk/models/operations/getepcbypostcode.d.ts.map +0 -1
  267. package/dist/commonjs/sdk/models/operations/getepcbypostcode.js +0 -105
  268. package/dist/commonjs/sdk/models/operations/getepcbypostcode.js.map +0 -1
  269. package/dist/esm/funcs/epcGetEPC.d.ts +0 -17
  270. package/dist/esm/funcs/epcGetEPC.d.ts.map +0 -1
  271. package/dist/esm/funcs/epcGetEPC.js +0 -83
  272. package/dist/esm/funcs/epcGetEPC.js.map +0 -1
  273. package/dist/esm/funcs/epcGetEPCByPostcode.d.ts +0 -17
  274. package/dist/esm/funcs/epcGetEPCByPostcode.d.ts.map +0 -1
  275. package/dist/esm/funcs/epcGetEPCByPostcode.js.map +0 -1
  276. package/dist/esm/sdk/epc.d.ts +0 -19
  277. package/dist/esm/sdk/epc.d.ts.map +0 -1
  278. package/dist/esm/sdk/epc.js +0 -28
  279. package/dist/esm/sdk/epc.js.map +0 -1
  280. package/dist/esm/sdk/models/operations/getepcbylocationid.d.ts +0 -130
  281. package/dist/esm/sdk/models/operations/getepcbylocationid.d.ts.map +0 -1
  282. package/dist/esm/sdk/models/operations/getepcbylocationid.js +0 -97
  283. package/dist/esm/sdk/models/operations/getepcbylocationid.js.map +0 -1
  284. package/dist/esm/sdk/models/operations/getepcbypostcode.d.ts +0 -82
  285. package/dist/esm/sdk/models/operations/getepcbypostcode.d.ts.map +0 -1
  286. package/dist/esm/sdk/models/operations/getepcbypostcode.js +0 -64
  287. package/dist/esm/sdk/models/operations/getepcbypostcode.js.map +0 -1
  288. package/src/funcs/epcGetEPC.ts +0 -166
  289. package/src/sdk/epc.ts +0 -45
  290. package/src/sdk/models/operations/getepcbylocationid.ts +0 -291
  291. package/src/sdk/models/operations/getepcbypostcode.ts +0 -188
@@ -102,8 +102,9 @@ export function encodeLabel(
102
102
  });
103
103
  encValue = mapped?.join("").slice(1);
104
104
  } else {
105
- const k =
106
- options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : "";
105
+ const k = options?.explode && isPlainObject(value)
106
+ ? `${encodeString(pk)}=`
107
+ : "";
107
108
  encValue = `${k}${encodeValue(pv)}`;
108
109
  }
109
110
 
@@ -426,6 +427,7 @@ export function queryJoin(...args: (string | undefined)[]): string {
426
427
  type QueryEncoderOptions = {
427
428
  explode?: boolean;
428
429
  charEncoding?: "percent" | "none";
430
+ allowEmptyValue?: string[];
429
431
  };
430
432
 
431
433
  type QueryEncoder = (
@@ -440,7 +442,7 @@ type BulkQueryEncoder = (
440
442
  ) => string;
441
443
 
442
444
  export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
443
- const bulkEncode = function (
445
+ const bulkEncode = function(
444
446
  values: Record<string, unknown>,
445
447
  options?: QueryEncoderOptions,
446
448
  ): string {
@@ -450,7 +452,19 @@ export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
450
452
  charEncoding: options?.charEncoding ?? "percent",
451
453
  };
452
454
 
455
+ const allowEmptySet = new Set(options?.allowEmptyValue ?? []);
456
+
453
457
  const encoded = Object.entries(values).map(([key, value]) => {
458
+ if (allowEmptySet.has(key)) {
459
+ if (
460
+ value === undefined
461
+ || value === null
462
+ || value === ""
463
+ || (Array.isArray(value) && value.length === 0)
464
+ ) {
465
+ return `${encodeURIComponent(key)}=`;
466
+ }
467
+ }
454
468
  return f(key, value, opts);
455
469
  });
456
470
  return queryJoin(...encoded);
package/src/sdk/avm.ts CHANGED
@@ -3,6 +3,7 @@
3
3
  */
4
4
 
5
5
  import { avmPredictPropertyValue } from "../funcs/avmPredictPropertyValue.js";
6
+ import { avmPredictPropertyValueByLocation } from "../funcs/avmPredictPropertyValueByLocation.js";
6
7
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
7
8
  import * as operations from "./models/operations/index.js";
8
9
  import * as shared from "./models/shared/index.js";
@@ -13,7 +14,7 @@ export class Avm extends ClientSDK {
13
14
  * Predict property value
14
15
  *
15
16
  * @remarks
16
- * Get an automated valuation for a property based on its characteristics and location. The AVM uses ensemble machine learning models (Neural Networks, XGBoost, LightGBM) to provide accurate property valuations with confidence intervals.
17
+ * Get an automated valuation for a property based on its characteristics and location. Receive accurate property valuations with confidence intervals powered by advanced machine learning.
17
18
  */
18
19
  async predictPropertyValue(
19
20
  request: shared.AVMPredictRequest,
@@ -25,4 +26,21 @@ export class Avm extends ClientSDK {
25
26
  options,
26
27
  ));
27
28
  }
29
+
30
+ /**
31
+ * Predict property value by location ID
32
+ *
33
+ * @remarks
34
+ * Get an automated valuation for a property using its location ID. We'll retrieve the property details and generate an accurate valuation with confidence intervals. You can optionally override any property characteristics to see how they affect the valuation.
35
+ */
36
+ async predictPropertyValueByLocation(
37
+ request: shared.AVMPredictByLocationRequest,
38
+ options?: RequestOptions,
39
+ ): Promise<operations.PredictPropertyValueByLocationResponse> {
40
+ return unwrapAsync(avmPredictPropertyValueByLocation(
41
+ this,
42
+ request,
43
+ options,
44
+ ));
45
+ }
28
46
  }
@@ -122,21 +122,63 @@ export type Relationships = {
122
122
  };
123
123
 
124
124
  /**
125
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
125
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
126
126
  */
127
127
  export const GetAreasByFieldAndIdsType = {
128
128
  Postcode: "postcode",
129
- Lsoa21: "lsoa21",
130
129
  UkOutputArea: "uk_output_area",
130
+ Lsoa21: "lsoa21",
131
131
  Ward: "ward",
132
- Country: "country",
133
- County: "county",
132
+ Parish: "parish",
134
133
  LocalAuthorityDistrict: "local_authority_district",
134
+ County: "county",
135
+ Country: "country",
136
+ CountyElectoralDivision: "county_electoral_division",
137
+ DistrictBoroughUnitary: "district_borough_unitary",
138
+ DistrictBoroughUnitaryWard: "district_borough_unitary_ward",
139
+ LocalPlanningAuthority: "local_planning_authority",
140
+ CeremonialCountiesRegion: "ceremonial_counties_region",
141
+ EnglishRegion: "english_region",
142
+ CountryRegion: "country_region",
143
+ UnitaryElectoralDivision: "unitary_electoral_division",
144
+ Province: "province",
145
+ ElectoralDivision: "electoral_division",
146
+ GreaterLondonConstituency: "greater_london_constituency",
147
+ ScotlandAndWalesConstituency: "scotland_and_wales_constituency",
148
+ ScotlandAndWalesRegion: "scotland_and_wales_region",
149
+ WestminsterConstituency: "westminster_constituency",
150
+ Building: "building",
151
+ BuiltUpArea250: "built_up_area_250",
152
+ GreenBelt: "green_belt",
153
+ CommonLand: "common_land",
154
+ ParcelsGb: "parcels_gb",
155
+ FloodRisk: "flood_risk",
156
+ Ramsar: "ramsar",
157
+ Natura2000: "natura_2000",
158
+ Aonb: "aonb",
135
159
  AreaNaturalBeauty: "area_natural_beauty",
136
160
  NationalScenicArea: "national_scenic_area",
161
+ SpecialAreaConservation: "special_area_conservation",
162
+ SpecialProtectionArea: "special_protection_area",
163
+ AncientWoodland: "ancient_woodland",
164
+ NativeWoodlandSurvey: "native_woodland_survey",
165
+ PriorityHabitats: "priority_habitats",
166
+ ProtectedWoodlands: "protected_woodlands",
167
+ ProtectedWoodland: "protected_woodland",
168
+ ProtectedScenicLandscapes: "protected_scenic_landscapes",
169
+ WorldHeritageSite: "world_heritage_site",
170
+ ScheduledMonument: "scheduled_monument",
171
+ Battlefield: "battlefield",
172
+ ProtectedWreckSite: "protected_wreck_site",
173
+ HistoricLandfillSite: "historic_landfill_site",
174
+ RadonLevel: "radon_level",
175
+ BrownfieldLand: "brownfield_land",
176
+ NoiseRailLden: "noise_rail_lden",
177
+ NoiseRoadLden: "noise_road_lden",
178
+ NoiseIndustryLden: "noise_industry_lden",
137
179
  } as const;
138
180
  /**
139
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
181
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
140
182
  */
141
183
  export type GetAreasByFieldAndIdsType = ClosedEnum<
142
184
  typeof GetAreasByFieldAndIdsType
@@ -191,7 +233,7 @@ export type GetAreasByFieldAndIdsResult = {
191
233
  */
192
234
  status?: string | undefined;
193
235
  /**
194
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
236
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
195
237
  */
196
238
  type: GetAreasByFieldAndIdsType;
197
239
  };
@@ -9,21 +9,63 @@ import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
11
  /**
12
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
12
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
13
13
  */
14
14
  export const Type = {
15
15
  Postcode: "postcode",
16
- Lsoa21: "lsoa21",
17
16
  UkOutputArea: "uk_output_area",
17
+ Lsoa21: "lsoa21",
18
18
  Ward: "ward",
19
- Country: "country",
20
- County: "county",
19
+ Parish: "parish",
21
20
  LocalAuthorityDistrict: "local_authority_district",
21
+ County: "county",
22
+ Country: "country",
23
+ CountyElectoralDivision: "county_electoral_division",
24
+ DistrictBoroughUnitary: "district_borough_unitary",
25
+ DistrictBoroughUnitaryWard: "district_borough_unitary_ward",
26
+ LocalPlanningAuthority: "local_planning_authority",
27
+ CeremonialCountiesRegion: "ceremonial_counties_region",
28
+ EnglishRegion: "english_region",
29
+ CountryRegion: "country_region",
30
+ UnitaryElectoralDivision: "unitary_electoral_division",
31
+ Province: "province",
32
+ ElectoralDivision: "electoral_division",
33
+ GreaterLondonConstituency: "greater_london_constituency",
34
+ ScotlandAndWalesConstituency: "scotland_and_wales_constituency",
35
+ ScotlandAndWalesRegion: "scotland_and_wales_region",
36
+ WestminsterConstituency: "westminster_constituency",
37
+ Building: "building",
38
+ BuiltUpArea250: "built_up_area_250",
39
+ GreenBelt: "green_belt",
40
+ CommonLand: "common_land",
41
+ ParcelsGb: "parcels_gb",
42
+ FloodRisk: "flood_risk",
43
+ Ramsar: "ramsar",
44
+ Natura2000: "natura_2000",
45
+ Aonb: "aonb",
22
46
  AreaNaturalBeauty: "area_natural_beauty",
23
47
  NationalScenicArea: "national_scenic_area",
48
+ SpecialAreaConservation: "special_area_conservation",
49
+ SpecialProtectionArea: "special_protection_area",
50
+ AncientWoodland: "ancient_woodland",
51
+ NativeWoodlandSurvey: "native_woodland_survey",
52
+ PriorityHabitats: "priority_habitats",
53
+ ProtectedWoodlands: "protected_woodlands",
54
+ ProtectedWoodland: "protected_woodland",
55
+ ProtectedScenicLandscapes: "protected_scenic_landscapes",
56
+ WorldHeritageSite: "world_heritage_site",
57
+ ScheduledMonument: "scheduled_monument",
58
+ Battlefield: "battlefield",
59
+ ProtectedWreckSite: "protected_wreck_site",
60
+ HistoricLandfillSite: "historic_landfill_site",
61
+ RadonLevel: "radon_level",
62
+ BrownfieldLand: "brownfield_land",
63
+ NoiseRailLden: "noise_rail_lden",
64
+ NoiseRoadLden: "noise_road_lden",
65
+ NoiseIndustryLden: "noise_industry_lden",
24
66
  } as const;
25
67
  /**
26
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
68
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
27
69
  */
28
70
  export type Type = ClosedEnum<typeof Type>;
29
71
 
@@ -133,21 +175,63 @@ export type GetAreasWithinRadiusRelationships = {
133
175
  };
134
176
 
135
177
  /**
136
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
178
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
137
179
  */
138
180
  export const GetAreasWithinRadiusType = {
139
181
  Postcode: "postcode",
140
- Lsoa21: "lsoa21",
141
182
  UkOutputArea: "uk_output_area",
183
+ Lsoa21: "lsoa21",
142
184
  Ward: "ward",
143
- Country: "country",
144
- County: "county",
185
+ Parish: "parish",
145
186
  LocalAuthorityDistrict: "local_authority_district",
187
+ County: "county",
188
+ Country: "country",
189
+ CountyElectoralDivision: "county_electoral_division",
190
+ DistrictBoroughUnitary: "district_borough_unitary",
191
+ DistrictBoroughUnitaryWard: "district_borough_unitary_ward",
192
+ LocalPlanningAuthority: "local_planning_authority",
193
+ CeremonialCountiesRegion: "ceremonial_counties_region",
194
+ EnglishRegion: "english_region",
195
+ CountryRegion: "country_region",
196
+ UnitaryElectoralDivision: "unitary_electoral_division",
197
+ Province: "province",
198
+ ElectoralDivision: "electoral_division",
199
+ GreaterLondonConstituency: "greater_london_constituency",
200
+ ScotlandAndWalesConstituency: "scotland_and_wales_constituency",
201
+ ScotlandAndWalesRegion: "scotland_and_wales_region",
202
+ WestminsterConstituency: "westminster_constituency",
203
+ Building: "building",
204
+ BuiltUpArea250: "built_up_area_250",
205
+ GreenBelt: "green_belt",
206
+ CommonLand: "common_land",
207
+ ParcelsGb: "parcels_gb",
208
+ FloodRisk: "flood_risk",
209
+ Ramsar: "ramsar",
210
+ Natura2000: "natura_2000",
211
+ Aonb: "aonb",
146
212
  AreaNaturalBeauty: "area_natural_beauty",
147
213
  NationalScenicArea: "national_scenic_area",
214
+ SpecialAreaConservation: "special_area_conservation",
215
+ SpecialProtectionArea: "special_protection_area",
216
+ AncientWoodland: "ancient_woodland",
217
+ NativeWoodlandSurvey: "native_woodland_survey",
218
+ PriorityHabitats: "priority_habitats",
219
+ ProtectedWoodlands: "protected_woodlands",
220
+ ProtectedWoodland: "protected_woodland",
221
+ ProtectedScenicLandscapes: "protected_scenic_landscapes",
222
+ WorldHeritageSite: "world_heritage_site",
223
+ ScheduledMonument: "scheduled_monument",
224
+ Battlefield: "battlefield",
225
+ ProtectedWreckSite: "protected_wreck_site",
226
+ HistoricLandfillSite: "historic_landfill_site",
227
+ RadonLevel: "radon_level",
228
+ BrownfieldLand: "brownfield_land",
229
+ NoiseRailLden: "noise_rail_lden",
230
+ NoiseRoadLden: "noise_road_lden",
231
+ NoiseIndustryLden: "noise_industry_lden",
148
232
  } as const;
149
233
  /**
150
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
234
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
151
235
  */
152
236
  export type GetAreasWithinRadiusType = ClosedEnum<
153
237
  typeof GetAreasWithinRadiusType
@@ -206,7 +290,7 @@ export type GetAreasWithinRadiusResult = {
206
290
  */
207
291
  status?: string | undefined;
208
292
  /**
209
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
293
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
210
294
  */
211
295
  type: GetAreasWithinRadiusType;
212
296
  };
@@ -106,21 +106,63 @@ export type GetBorderingAreasRelationships = {
106
106
  };
107
107
 
108
108
  /**
109
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
109
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
110
110
  */
111
111
  export const GetBorderingAreasType = {
112
112
  Postcode: "postcode",
113
- Lsoa21: "lsoa21",
114
113
  UkOutputArea: "uk_output_area",
114
+ Lsoa21: "lsoa21",
115
115
  Ward: "ward",
116
- Country: "country",
117
- County: "county",
116
+ Parish: "parish",
118
117
  LocalAuthorityDistrict: "local_authority_district",
118
+ County: "county",
119
+ Country: "country",
120
+ CountyElectoralDivision: "county_electoral_division",
121
+ DistrictBoroughUnitary: "district_borough_unitary",
122
+ DistrictBoroughUnitaryWard: "district_borough_unitary_ward",
123
+ LocalPlanningAuthority: "local_planning_authority",
124
+ CeremonialCountiesRegion: "ceremonial_counties_region",
125
+ EnglishRegion: "english_region",
126
+ CountryRegion: "country_region",
127
+ UnitaryElectoralDivision: "unitary_electoral_division",
128
+ Province: "province",
129
+ ElectoralDivision: "electoral_division",
130
+ GreaterLondonConstituency: "greater_london_constituency",
131
+ ScotlandAndWalesConstituency: "scotland_and_wales_constituency",
132
+ ScotlandAndWalesRegion: "scotland_and_wales_region",
133
+ WestminsterConstituency: "westminster_constituency",
134
+ Building: "building",
135
+ BuiltUpArea250: "built_up_area_250",
136
+ GreenBelt: "green_belt",
137
+ CommonLand: "common_land",
138
+ ParcelsGb: "parcels_gb",
139
+ FloodRisk: "flood_risk",
140
+ Ramsar: "ramsar",
141
+ Natura2000: "natura_2000",
142
+ Aonb: "aonb",
119
143
  AreaNaturalBeauty: "area_natural_beauty",
120
144
  NationalScenicArea: "national_scenic_area",
145
+ SpecialAreaConservation: "special_area_conservation",
146
+ SpecialProtectionArea: "special_protection_area",
147
+ AncientWoodland: "ancient_woodland",
148
+ NativeWoodlandSurvey: "native_woodland_survey",
149
+ PriorityHabitats: "priority_habitats",
150
+ ProtectedWoodlands: "protected_woodlands",
151
+ ProtectedWoodland: "protected_woodland",
152
+ ProtectedScenicLandscapes: "protected_scenic_landscapes",
153
+ WorldHeritageSite: "world_heritage_site",
154
+ ScheduledMonument: "scheduled_monument",
155
+ Battlefield: "battlefield",
156
+ ProtectedWreckSite: "protected_wreck_site",
157
+ HistoricLandfillSite: "historic_landfill_site",
158
+ RadonLevel: "radon_level",
159
+ BrownfieldLand: "brownfield_land",
160
+ NoiseRailLden: "noise_rail_lden",
161
+ NoiseRoadLden: "noise_road_lden",
162
+ NoiseIndustryLden: "noise_industry_lden",
121
163
  } as const;
122
164
  /**
123
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
165
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
124
166
  */
125
167
  export type GetBorderingAreasType = ClosedEnum<typeof GetBorderingAreasType>;
126
168
 
@@ -173,7 +215,7 @@ export type BorderingAreas = {
173
215
  */
174
216
  status?: string | undefined;
175
217
  /**
176
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
218
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
177
219
  */
178
220
  type: GetBorderingAreasType;
179
221
  };
@@ -213,21 +255,63 @@ export type GetBorderingAreasAreasRelationships = {
213
255
  };
214
256
 
215
257
  /**
216
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
258
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
217
259
  */
218
260
  export const GetBorderingAreasAreasType = {
219
261
  Postcode: "postcode",
220
- Lsoa21: "lsoa21",
221
262
  UkOutputArea: "uk_output_area",
263
+ Lsoa21: "lsoa21",
222
264
  Ward: "ward",
223
- Country: "country",
224
- County: "county",
265
+ Parish: "parish",
225
266
  LocalAuthorityDistrict: "local_authority_district",
267
+ County: "county",
268
+ Country: "country",
269
+ CountyElectoralDivision: "county_electoral_division",
270
+ DistrictBoroughUnitary: "district_borough_unitary",
271
+ DistrictBoroughUnitaryWard: "district_borough_unitary_ward",
272
+ LocalPlanningAuthority: "local_planning_authority",
273
+ CeremonialCountiesRegion: "ceremonial_counties_region",
274
+ EnglishRegion: "english_region",
275
+ CountryRegion: "country_region",
276
+ UnitaryElectoralDivision: "unitary_electoral_division",
277
+ Province: "province",
278
+ ElectoralDivision: "electoral_division",
279
+ GreaterLondonConstituency: "greater_london_constituency",
280
+ ScotlandAndWalesConstituency: "scotland_and_wales_constituency",
281
+ ScotlandAndWalesRegion: "scotland_and_wales_region",
282
+ WestminsterConstituency: "westminster_constituency",
283
+ Building: "building",
284
+ BuiltUpArea250: "built_up_area_250",
285
+ GreenBelt: "green_belt",
286
+ CommonLand: "common_land",
287
+ ParcelsGb: "parcels_gb",
288
+ FloodRisk: "flood_risk",
289
+ Ramsar: "ramsar",
290
+ Natura2000: "natura_2000",
291
+ Aonb: "aonb",
226
292
  AreaNaturalBeauty: "area_natural_beauty",
227
293
  NationalScenicArea: "national_scenic_area",
294
+ SpecialAreaConservation: "special_area_conservation",
295
+ SpecialProtectionArea: "special_protection_area",
296
+ AncientWoodland: "ancient_woodland",
297
+ NativeWoodlandSurvey: "native_woodland_survey",
298
+ PriorityHabitats: "priority_habitats",
299
+ ProtectedWoodlands: "protected_woodlands",
300
+ ProtectedWoodland: "protected_woodland",
301
+ ProtectedScenicLandscapes: "protected_scenic_landscapes",
302
+ WorldHeritageSite: "world_heritage_site",
303
+ ScheduledMonument: "scheduled_monument",
304
+ Battlefield: "battlefield",
305
+ ProtectedWreckSite: "protected_wreck_site",
306
+ HistoricLandfillSite: "historic_landfill_site",
307
+ RadonLevel: "radon_level",
308
+ BrownfieldLand: "brownfield_land",
309
+ NoiseRailLden: "noise_rail_lden",
310
+ NoiseRoadLden: "noise_road_lden",
311
+ NoiseIndustryLden: "noise_industry_lden",
228
312
  } as const;
229
313
  /**
230
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
314
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
231
315
  */
232
316
  export type GetBorderingAreasAreasType = ClosedEnum<
233
317
  typeof GetBorderingAreasAreasType
@@ -282,7 +366,7 @@ export type Target = {
282
366
  */
283
367
  status?: string | undefined;
284
368
  /**
285
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
369
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
286
370
  */
287
371
  type: GetBorderingAreasAreasType;
288
372
  };
@@ -102,21 +102,63 @@ export type GetChildAreasRelationships = {
102
102
  };
103
103
 
104
104
  /**
105
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
105
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
106
106
  */
107
107
  export const GetChildAreasType = {
108
108
  Postcode: "postcode",
109
- Lsoa21: "lsoa21",
110
109
  UkOutputArea: "uk_output_area",
110
+ Lsoa21: "lsoa21",
111
111
  Ward: "ward",
112
- Country: "country",
113
- County: "county",
112
+ Parish: "parish",
114
113
  LocalAuthorityDistrict: "local_authority_district",
114
+ County: "county",
115
+ Country: "country",
116
+ CountyElectoralDivision: "county_electoral_division",
117
+ DistrictBoroughUnitary: "district_borough_unitary",
118
+ DistrictBoroughUnitaryWard: "district_borough_unitary_ward",
119
+ LocalPlanningAuthority: "local_planning_authority",
120
+ CeremonialCountiesRegion: "ceremonial_counties_region",
121
+ EnglishRegion: "english_region",
122
+ CountryRegion: "country_region",
123
+ UnitaryElectoralDivision: "unitary_electoral_division",
124
+ Province: "province",
125
+ ElectoralDivision: "electoral_division",
126
+ GreaterLondonConstituency: "greater_london_constituency",
127
+ ScotlandAndWalesConstituency: "scotland_and_wales_constituency",
128
+ ScotlandAndWalesRegion: "scotland_and_wales_region",
129
+ WestminsterConstituency: "westminster_constituency",
130
+ Building: "building",
131
+ BuiltUpArea250: "built_up_area_250",
132
+ GreenBelt: "green_belt",
133
+ CommonLand: "common_land",
134
+ ParcelsGb: "parcels_gb",
135
+ FloodRisk: "flood_risk",
136
+ Ramsar: "ramsar",
137
+ Natura2000: "natura_2000",
138
+ Aonb: "aonb",
115
139
  AreaNaturalBeauty: "area_natural_beauty",
116
140
  NationalScenicArea: "national_scenic_area",
141
+ SpecialAreaConservation: "special_area_conservation",
142
+ SpecialProtectionArea: "special_protection_area",
143
+ AncientWoodland: "ancient_woodland",
144
+ NativeWoodlandSurvey: "native_woodland_survey",
145
+ PriorityHabitats: "priority_habitats",
146
+ ProtectedWoodlands: "protected_woodlands",
147
+ ProtectedWoodland: "protected_woodland",
148
+ ProtectedScenicLandscapes: "protected_scenic_landscapes",
149
+ WorldHeritageSite: "world_heritage_site",
150
+ ScheduledMonument: "scheduled_monument",
151
+ Battlefield: "battlefield",
152
+ ProtectedWreckSite: "protected_wreck_site",
153
+ HistoricLandfillSite: "historic_landfill_site",
154
+ RadonLevel: "radon_level",
155
+ BrownfieldLand: "brownfield_land",
156
+ NoiseRailLden: "noise_rail_lden",
157
+ NoiseRoadLden: "noise_road_lden",
158
+ NoiseIndustryLden: "noise_industry_lden",
117
159
  } as const;
118
160
  /**
119
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
161
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
120
162
  */
121
163
  export type GetChildAreasType = ClosedEnum<typeof GetChildAreasType>;
122
164
 
@@ -169,7 +211,7 @@ export type Children = {
169
211
  */
170
212
  status?: string | undefined;
171
213
  /**
172
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
214
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
173
215
  */
174
216
  type: GetChildAreasType;
175
217
  };
@@ -209,21 +251,63 @@ export type GetChildAreasAreasRelationships = {
209
251
  };
210
252
 
211
253
  /**
212
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
254
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
213
255
  */
214
256
  export const GetChildAreasAreasType = {
215
257
  Postcode: "postcode",
216
- Lsoa21: "lsoa21",
217
258
  UkOutputArea: "uk_output_area",
259
+ Lsoa21: "lsoa21",
218
260
  Ward: "ward",
219
- Country: "country",
220
- County: "county",
261
+ Parish: "parish",
221
262
  LocalAuthorityDistrict: "local_authority_district",
263
+ County: "county",
264
+ Country: "country",
265
+ CountyElectoralDivision: "county_electoral_division",
266
+ DistrictBoroughUnitary: "district_borough_unitary",
267
+ DistrictBoroughUnitaryWard: "district_borough_unitary_ward",
268
+ LocalPlanningAuthority: "local_planning_authority",
269
+ CeremonialCountiesRegion: "ceremonial_counties_region",
270
+ EnglishRegion: "english_region",
271
+ CountryRegion: "country_region",
272
+ UnitaryElectoralDivision: "unitary_electoral_division",
273
+ Province: "province",
274
+ ElectoralDivision: "electoral_division",
275
+ GreaterLondonConstituency: "greater_london_constituency",
276
+ ScotlandAndWalesConstituency: "scotland_and_wales_constituency",
277
+ ScotlandAndWalesRegion: "scotland_and_wales_region",
278
+ WestminsterConstituency: "westminster_constituency",
279
+ Building: "building",
280
+ BuiltUpArea250: "built_up_area_250",
281
+ GreenBelt: "green_belt",
282
+ CommonLand: "common_land",
283
+ ParcelsGb: "parcels_gb",
284
+ FloodRisk: "flood_risk",
285
+ Ramsar: "ramsar",
286
+ Natura2000: "natura_2000",
287
+ Aonb: "aonb",
222
288
  AreaNaturalBeauty: "area_natural_beauty",
223
289
  NationalScenicArea: "national_scenic_area",
290
+ SpecialAreaConservation: "special_area_conservation",
291
+ SpecialProtectionArea: "special_protection_area",
292
+ AncientWoodland: "ancient_woodland",
293
+ NativeWoodlandSurvey: "native_woodland_survey",
294
+ PriorityHabitats: "priority_habitats",
295
+ ProtectedWoodlands: "protected_woodlands",
296
+ ProtectedWoodland: "protected_woodland",
297
+ ProtectedScenicLandscapes: "protected_scenic_landscapes",
298
+ WorldHeritageSite: "world_heritage_site",
299
+ ScheduledMonument: "scheduled_monument",
300
+ Battlefield: "battlefield",
301
+ ProtectedWreckSite: "protected_wreck_site",
302
+ HistoricLandfillSite: "historic_landfill_site",
303
+ RadonLevel: "radon_level",
304
+ BrownfieldLand: "brownfield_land",
305
+ NoiseRailLden: "noise_rail_lden",
306
+ NoiseRoadLden: "noise_road_lden",
307
+ NoiseIndustryLden: "noise_industry_lden",
224
308
  } as const;
225
309
  /**
226
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
310
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
227
311
  */
228
312
  export type GetChildAreasAreasType = ClosedEnum<typeof GetChildAreasAreasType>;
229
313
 
@@ -276,7 +360,7 @@ export type Parent = {
276
360
  */
277
361
  status?: string | undefined;
278
362
  /**
279
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
363
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
280
364
  */
281
365
  type: GetChildAreasAreasType;
282
366
  };