@vepler/sdk 2.38.2 → 2.42.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 (402) hide show
  1. package/README.md +212 -182
  2. package/dist/commonjs/funcs/planningPolicySearch.d.ts +18 -0
  3. package/dist/commonjs/funcs/planningPolicySearch.d.ts.map +1 -0
  4. package/dist/commonjs/funcs/planningPolicySearch.js +125 -0
  5. package/dist/commonjs/funcs/planningPolicySearch.js.map +1 -0
  6. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.d.ts +3 -2
  7. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.d.ts.map +1 -1
  8. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.js +3 -2
  9. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.js.map +1 -1
  10. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.d.ts +3 -2
  11. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.d.ts.map +1 -1
  12. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.js +3 -2
  13. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.js.map +1 -1
  14. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.d.ts +19 -0
  15. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.d.ts.map +1 -0
  16. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.js +128 -0
  17. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.js.map +1 -0
  18. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.d.ts +18 -0
  19. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.d.ts.map +1 -0
  20. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.js +137 -0
  21. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.js.map +1 -0
  22. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts +19 -0
  23. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts.map +1 -0
  24. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js +128 -0
  25. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js.map +1 -0
  26. package/dist/commonjs/hooks/registration.d.ts.map +1 -1
  27. package/dist/commonjs/hooks/registration.js.map +1 -1
  28. package/dist/commonjs/lib/config.d.ts +3 -3
  29. package/dist/commonjs/lib/config.js +3 -3
  30. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocuments.d.ts +266 -0
  31. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocuments.d.ts.map +1 -0
  32. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocuments.js +265 -0
  33. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocuments.js.map +1 -0
  34. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts +331 -0
  35. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts.map +1 -0
  36. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.js +313 -0
  37. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.js.map +1 -0
  38. package/dist/commonjs/sdk/models/errors/index.d.ts +5 -0
  39. package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
  40. package/dist/commonjs/sdk/models/errors/index.js +5 -0
  41. package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
  42. package/dist/commonjs/sdk/models/errors/insufficientcreditserror.d.ts +49 -0
  43. package/dist/commonjs/sdk/models/errors/insufficientcreditserror.d.ts.map +1 -0
  44. package/dist/commonjs/sdk/models/errors/insufficientcreditserror.js +97 -0
  45. package/dist/commonjs/sdk/models/errors/insufficientcreditserror.js.map +1 -0
  46. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts +266 -0
  47. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts.map +1 -0
  48. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.js +265 -0
  49. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.js.map +1 -0
  50. package/dist/commonjs/sdk/models/errors/searchplanningpolicy.d.ts +65 -0
  51. package/dist/commonjs/sdk/models/errors/searchplanningpolicy.d.ts.map +1 -0
  52. package/dist/commonjs/sdk/models/errors/searchplanningpolicy.js +121 -0
  53. package/dist/commonjs/sdk/models/errors/searchplanningpolicy.js.map +1 -0
  54. package/dist/commonjs/sdk/models/operations/getareacoverage.d.ts +4 -4
  55. package/dist/commonjs/sdk/models/operations/getareacoverage.d.ts.map +1 -1
  56. package/dist/commonjs/sdk/models/operations/getareacoverage.js +4 -4
  57. package/dist/commonjs/sdk/models/operations/getareacoverage.js.map +1 -1
  58. package/dist/commonjs/sdk/models/operations/getepcbylocationid.d.ts +29 -1
  59. package/dist/commonjs/sdk/models/operations/getepcbylocationid.d.ts.map +1 -1
  60. package/dist/commonjs/sdk/models/operations/getepcbylocationid.js +19 -2
  61. package/dist/commonjs/sdk/models/operations/getepcbylocationid.js.map +1 -1
  62. package/dist/commonjs/sdk/models/operations/getschoolmetrics.d.ts +8 -8
  63. package/dist/commonjs/sdk/models/operations/getschoolmetrics.d.ts.map +1 -1
  64. package/dist/commonjs/sdk/models/operations/getschoolmetrics.js +15 -16
  65. package/dist/commonjs/sdk/models/operations/getschoolmetrics.js.map +1 -1
  66. package/dist/commonjs/sdk/models/operations/getv1safetycrime.d.ts +4 -93
  67. package/dist/commonjs/sdk/models/operations/getv1safetycrime.d.ts.map +1 -1
  68. package/dist/commonjs/sdk/models/operations/getv1safetycrime.js +1 -44
  69. package/dist/commonjs/sdk/models/operations/getv1safetycrime.js.map +1 -1
  70. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.d.ts +4 -95
  71. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.d.ts.map +1 -1
  72. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.js +1 -53
  73. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.js.map +1 -1
  74. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocuments.d.ts +12 -0
  75. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocuments.d.ts.map +1 -0
  76. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocuments.js +49 -0
  77. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocuments.js.map +1 -0
  78. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts +32 -0
  79. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts.map +1 -0
  80. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.js +60 -0
  81. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.js.map +1 -0
  82. package/dist/commonjs/sdk/models/operations/index.d.ts +4 -0
  83. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  84. package/dist/commonjs/sdk/models/operations/index.js +4 -0
  85. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  86. package/dist/commonjs/sdk/models/operations/postv1titledeedstitlenumberpurchase.d.ts +12 -0
  87. package/dist/commonjs/sdk/models/operations/postv1titledeedstitlenumberpurchase.d.ts.map +1 -0
  88. package/dist/commonjs/sdk/models/operations/postv1titledeedstitlenumberpurchase.js +49 -0
  89. package/dist/commonjs/sdk/models/operations/postv1titledeedstitlenumberpurchase.js.map +1 -0
  90. package/dist/commonjs/sdk/models/operations/searchplanningpolicy.d.ts +123 -0
  91. package/dist/commonjs/sdk/models/operations/searchplanningpolicy.d.ts.map +1 -0
  92. package/dist/commonjs/sdk/models/operations/searchplanningpolicy.js +160 -0
  93. package/dist/commonjs/sdk/models/operations/searchplanningpolicy.js.map +1 -0
  94. package/dist/commonjs/sdk/models/shared/aggregationresult.d.ts +3 -1
  95. package/dist/commonjs/sdk/models/shared/aggregationresult.d.ts.map +1 -1
  96. package/dist/commonjs/sdk/models/shared/aggregationresult.js +4 -0
  97. package/dist/commonjs/sdk/models/shared/aggregationresult.js.map +1 -1
  98. package/dist/commonjs/sdk/models/shared/areastatsresponse.d.ts +66 -0
  99. package/dist/commonjs/sdk/models/shared/areastatsresponse.d.ts.map +1 -0
  100. package/dist/commonjs/sdk/models/shared/areastatsresponse.js +94 -0
  101. package/dist/commonjs/sdk/models/shared/areastatsresponse.js.map +1 -0
  102. package/dist/commonjs/sdk/models/shared/avmanalysisresponse.d.ts +4 -4
  103. package/dist/commonjs/sdk/models/shared/avmanalysisresponse.d.ts.map +1 -1
  104. package/dist/commonjs/sdk/models/shared/avmanalysisresponse.js +4 -4
  105. package/dist/commonjs/sdk/models/shared/avmanalysisresponse.js.map +1 -1
  106. package/dist/commonjs/sdk/models/shared/crimedataresponse.d.ts +35 -0
  107. package/dist/commonjs/sdk/models/shared/crimedataresponse.d.ts.map +1 -0
  108. package/dist/commonjs/sdk/models/shared/crimedataresponse.js +63 -0
  109. package/dist/commonjs/sdk/models/shared/crimedataresponse.js.map +1 -0
  110. package/dist/commonjs/sdk/models/shared/crimerecord.d.ts +37 -0
  111. package/dist/commonjs/sdk/models/shared/crimerecord.d.ts.map +1 -0
  112. package/dist/commonjs/sdk/models/shared/crimerecord.js +56 -0
  113. package/dist/commonjs/sdk/models/shared/crimerecord.js.map +1 -0
  114. package/dist/commonjs/sdk/models/shared/extendedstatsaggregationresult.d.ts +75 -0
  115. package/dist/commonjs/sdk/models/shared/extendedstatsaggregationresult.d.ts.map +1 -0
  116. package/dist/commonjs/sdk/models/shared/extendedstatsaggregationresult.js +93 -0
  117. package/dist/commonjs/sdk/models/shared/extendedstatsaggregationresult.js.map +1 -0
  118. package/dist/commonjs/sdk/models/shared/index.d.ts +9 -0
  119. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  120. package/dist/commonjs/sdk/models/shared/index.js +9 -0
  121. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  122. package/dist/commonjs/sdk/models/shared/nearestpostcodesresponse.d.ts +4 -4
  123. package/dist/commonjs/sdk/models/shared/nearestpostcodesresponse.d.ts.map +1 -1
  124. package/dist/commonjs/sdk/models/shared/nearestpostcodesresponse.js +6 -7
  125. package/dist/commonjs/sdk/models/shared/nearestpostcodesresponse.js.map +1 -1
  126. package/dist/commonjs/sdk/models/shared/percentilesaggregationresult.d.ts +15 -0
  127. package/dist/commonjs/sdk/models/shared/percentilesaggregationresult.d.ts.map +1 -0
  128. package/dist/commonjs/sdk/models/shared/percentilesaggregationresult.js +50 -0
  129. package/dist/commonjs/sdk/models/shared/percentilesaggregationresult.js.map +1 -0
  130. package/dist/commonjs/sdk/models/shared/site.d.ts +15 -10
  131. package/dist/commonjs/sdk/models/shared/site.d.ts.map +1 -1
  132. package/dist/commonjs/sdk/models/shared/site.js +8 -6
  133. package/dist/commonjs/sdk/models/shared/site.js.map +1 -1
  134. package/dist/commonjs/sdk/models/shared/sitefilters.d.ts +15 -0
  135. package/dist/commonjs/sdk/models/shared/sitefilters.d.ts.map +1 -1
  136. package/dist/commonjs/sdk/models/shared/sitefilters.js +3 -0
  137. package/dist/commonjs/sdk/models/shared/sitefilters.js.map +1 -1
  138. package/dist/commonjs/sdk/models/shared/siteownership.d.ts +41 -0
  139. package/dist/commonjs/sdk/models/shared/siteownership.d.ts.map +1 -0
  140. package/dist/commonjs/sdk/models/shared/siteownership.js +57 -0
  141. package/dist/commonjs/sdk/models/shared/siteownership.js.map +1 -0
  142. package/dist/commonjs/sdk/models/shared/siteproprietor.d.ts +33 -0
  143. package/dist/commonjs/sdk/models/shared/siteproprietor.d.ts.map +1 -0
  144. package/dist/commonjs/sdk/models/shared/siteproprietor.js +55 -0
  145. package/dist/commonjs/sdk/models/shared/siteproprietor.js.map +1 -0
  146. package/dist/commonjs/sdk/models/shared/sitequerycondition.d.ts +0 -1
  147. package/dist/commonjs/sdk/models/shared/sitequerycondition.d.ts.map +1 -1
  148. package/dist/commonjs/sdk/models/shared/sitequerycondition.js +0 -1
  149. package/dist/commonjs/sdk/models/shared/sitequerycondition.js.map +1 -1
  150. package/dist/commonjs/sdk/models/shared/sitequeryrequest.d.ts +0 -3
  151. package/dist/commonjs/sdk/models/shared/sitequeryrequest.d.ts.map +1 -1
  152. package/dist/commonjs/sdk/models/shared/sitequeryrequest.js +0 -3
  153. package/dist/commonjs/sdk/models/shared/sitequeryrequest.js.map +1 -1
  154. package/dist/commonjs/sdk/models/shared/titledeeddocumentlistresponse.d.ts +76 -0
  155. package/dist/commonjs/sdk/models/shared/titledeeddocumentlistresponse.d.ts.map +1 -0
  156. package/dist/commonjs/sdk/models/shared/titledeeddocumentlistresponse.js +104 -0
  157. package/dist/commonjs/sdk/models/shared/titledeeddocumentlistresponse.js.map +1 -0
  158. package/dist/commonjs/sdk/models/shared/titledeedpurchaseresponse.d.ts +205 -0
  159. package/dist/commonjs/sdk/models/shared/titledeedpurchaseresponse.d.ts.map +1 -0
  160. package/dist/commonjs/sdk/models/shared/titledeedpurchaseresponse.js +176 -0
  161. package/dist/commonjs/sdk/models/shared/titledeedpurchaseresponse.js.map +1 -0
  162. package/dist/commonjs/sdk/planningpolicy.d.ts +12 -0
  163. package/dist/commonjs/sdk/planningpolicy.d.ts.map +1 -0
  164. package/dist/commonjs/sdk/planningpolicy.js +22 -0
  165. package/dist/commonjs/sdk/planningpolicy.js.map +1 -0
  166. package/dist/commonjs/sdk/safety.d.ts +5 -4
  167. package/dist/commonjs/sdk/safety.d.ts.map +1 -1
  168. package/dist/commonjs/sdk/safety.js +2 -2
  169. package/dist/commonjs/sdk/safety.js.map +1 -1
  170. package/dist/commonjs/sdk/sdk.d.ts +6 -0
  171. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  172. package/dist/commonjs/sdk/sdk.js +8 -0
  173. package/dist/commonjs/sdk/sdk.js.map +1 -1
  174. package/dist/commonjs/sdk/titledeeds.d.ts +27 -0
  175. package/dist/commonjs/sdk/titledeeds.d.ts.map +1 -0
  176. package/dist/commonjs/sdk/titledeeds.js +42 -0
  177. package/dist/commonjs/sdk/titledeeds.js.map +1 -0
  178. package/dist/esm/funcs/planningPolicySearch.d.ts +18 -0
  179. package/dist/esm/funcs/planningPolicySearch.d.ts.map +1 -0
  180. package/dist/esm/funcs/planningPolicySearch.js +89 -0
  181. package/dist/esm/funcs/planningPolicySearch.js.map +1 -0
  182. package/dist/esm/funcs/safetyGetV1SafetyCrime.d.ts +3 -2
  183. package/dist/esm/funcs/safetyGetV1SafetyCrime.d.ts.map +1 -1
  184. package/dist/esm/funcs/safetyGetV1SafetyCrime.js +3 -2
  185. package/dist/esm/funcs/safetyGetV1SafetyCrime.js.map +1 -1
  186. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.d.ts +3 -2
  187. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.d.ts.map +1 -1
  188. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.js +3 -2
  189. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.js.map +1 -1
  190. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.d.ts +19 -0
  191. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.d.ts.map +1 -0
  192. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.js +92 -0
  193. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.js.map +1 -0
  194. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.d.ts +18 -0
  195. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.d.ts.map +1 -0
  196. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.js +101 -0
  197. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.js.map +1 -0
  198. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts +19 -0
  199. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts.map +1 -0
  200. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js +92 -0
  201. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js.map +1 -0
  202. package/dist/esm/hooks/registration.d.ts.map +1 -1
  203. package/dist/esm/hooks/registration.js.map +1 -1
  204. package/dist/esm/lib/config.d.ts +3 -3
  205. package/dist/esm/lib/config.js +3 -3
  206. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocuments.d.ts +266 -0
  207. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocuments.d.ts.map +1 -0
  208. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocuments.js +221 -0
  209. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocuments.js.map +1 -0
  210. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts +331 -0
  211. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts.map +1 -0
  212. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.js +267 -0
  213. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.js.map +1 -0
  214. package/dist/esm/sdk/models/errors/index.d.ts +5 -0
  215. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  216. package/dist/esm/sdk/models/errors/index.js +5 -0
  217. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  218. package/dist/esm/sdk/models/errors/insufficientcreditserror.d.ts +49 -0
  219. package/dist/esm/sdk/models/errors/insufficientcreditserror.d.ts.map +1 -0
  220. package/dist/esm/sdk/models/errors/insufficientcreditserror.js +59 -0
  221. package/dist/esm/sdk/models/errors/insufficientcreditserror.js.map +1 -0
  222. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts +266 -0
  223. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts.map +1 -0
  224. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.js +221 -0
  225. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.js.map +1 -0
  226. package/dist/esm/sdk/models/errors/searchplanningpolicy.d.ts +65 -0
  227. package/dist/esm/sdk/models/errors/searchplanningpolicy.d.ts.map +1 -0
  228. package/dist/esm/sdk/models/errors/searchplanningpolicy.js +81 -0
  229. package/dist/esm/sdk/models/errors/searchplanningpolicy.js.map +1 -0
  230. package/dist/esm/sdk/models/operations/getareacoverage.d.ts +4 -4
  231. package/dist/esm/sdk/models/operations/getareacoverage.d.ts.map +1 -1
  232. package/dist/esm/sdk/models/operations/getareacoverage.js +3 -3
  233. package/dist/esm/sdk/models/operations/getareacoverage.js.map +1 -1
  234. package/dist/esm/sdk/models/operations/getepcbylocationid.d.ts +29 -1
  235. package/dist/esm/sdk/models/operations/getepcbylocationid.d.ts.map +1 -1
  236. package/dist/esm/sdk/models/operations/getepcbylocationid.js +17 -1
  237. package/dist/esm/sdk/models/operations/getepcbylocationid.js.map +1 -1
  238. package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts +8 -8
  239. package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts.map +1 -1
  240. package/dist/esm/sdk/models/operations/getschoolmetrics.js +12 -13
  241. package/dist/esm/sdk/models/operations/getschoolmetrics.js.map +1 -1
  242. package/dist/esm/sdk/models/operations/getv1safetycrime.d.ts +4 -93
  243. package/dist/esm/sdk/models/operations/getv1safetycrime.d.ts.map +1 -1
  244. package/dist/esm/sdk/models/operations/getv1safetycrime.js +0 -39
  245. package/dist/esm/sdk/models/operations/getv1safetycrime.js.map +1 -1
  246. package/dist/esm/sdk/models/operations/getv1safetycrimestats.d.ts +4 -95
  247. package/dist/esm/sdk/models/operations/getv1safetycrimestats.d.ts.map +1 -1
  248. package/dist/esm/sdk/models/operations/getv1safetycrimestats.js +0 -48
  249. package/dist/esm/sdk/models/operations/getv1safetycrimestats.js.map +1 -1
  250. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocuments.d.ts +12 -0
  251. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocuments.d.ts.map +1 -0
  252. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocuments.js +12 -0
  253. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocuments.js.map +1 -0
  254. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts +32 -0
  255. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts.map +1 -0
  256. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.js +23 -0
  257. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.js.map +1 -0
  258. package/dist/esm/sdk/models/operations/index.d.ts +4 -0
  259. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  260. package/dist/esm/sdk/models/operations/index.js +4 -0
  261. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  262. package/dist/esm/sdk/models/operations/postv1titledeedstitlenumberpurchase.d.ts +12 -0
  263. package/dist/esm/sdk/models/operations/postv1titledeedstitlenumberpurchase.d.ts.map +1 -0
  264. package/dist/esm/sdk/models/operations/postv1titledeedstitlenumberpurchase.js +12 -0
  265. package/dist/esm/sdk/models/operations/postv1titledeedstitlenumberpurchase.js.map +1 -0
  266. package/dist/esm/sdk/models/operations/searchplanningpolicy.d.ts +123 -0
  267. package/dist/esm/sdk/models/operations/searchplanningpolicy.d.ts.map +1 -0
  268. package/dist/esm/sdk/models/operations/searchplanningpolicy.js +117 -0
  269. package/dist/esm/sdk/models/operations/searchplanningpolicy.js.map +1 -0
  270. package/dist/esm/sdk/models/shared/aggregationresult.d.ts +3 -1
  271. package/dist/esm/sdk/models/shared/aggregationresult.d.ts.map +1 -1
  272. package/dist/esm/sdk/models/shared/aggregationresult.js +4 -0
  273. package/dist/esm/sdk/models/shared/aggregationresult.js.map +1 -1
  274. package/dist/esm/sdk/models/shared/areastatsresponse.d.ts +66 -0
  275. package/dist/esm/sdk/models/shared/areastatsresponse.d.ts.map +1 -0
  276. package/dist/esm/sdk/models/shared/areastatsresponse.js +54 -0
  277. package/dist/esm/sdk/models/shared/areastatsresponse.js.map +1 -0
  278. package/dist/esm/sdk/models/shared/avmanalysisresponse.d.ts +4 -4
  279. package/dist/esm/sdk/models/shared/avmanalysisresponse.d.ts.map +1 -1
  280. package/dist/esm/sdk/models/shared/avmanalysisresponse.js +3 -3
  281. package/dist/esm/sdk/models/shared/avmanalysisresponse.js.map +1 -1
  282. package/dist/esm/sdk/models/shared/crimedataresponse.d.ts +35 -0
  283. package/dist/esm/sdk/models/shared/crimedataresponse.d.ts.map +1 -0
  284. package/dist/esm/sdk/models/shared/crimedataresponse.js +25 -0
  285. package/dist/esm/sdk/models/shared/crimedataresponse.js.map +1 -0
  286. package/dist/esm/sdk/models/shared/crimerecord.d.ts +37 -0
  287. package/dist/esm/sdk/models/shared/crimerecord.d.ts.map +1 -0
  288. package/dist/esm/sdk/models/shared/crimerecord.js +19 -0
  289. package/dist/esm/sdk/models/shared/crimerecord.js.map +1 -0
  290. package/dist/esm/sdk/models/shared/extendedstatsaggregationresult.d.ts +75 -0
  291. package/dist/esm/sdk/models/shared/extendedstatsaggregationresult.d.ts.map +1 -0
  292. package/dist/esm/sdk/models/shared/extendedstatsaggregationresult.js +55 -0
  293. package/dist/esm/sdk/models/shared/extendedstatsaggregationresult.js.map +1 -0
  294. package/dist/esm/sdk/models/shared/index.d.ts +9 -0
  295. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  296. package/dist/esm/sdk/models/shared/index.js +9 -0
  297. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  298. package/dist/esm/sdk/models/shared/nearestpostcodesresponse.d.ts +4 -4
  299. package/dist/esm/sdk/models/shared/nearestpostcodesresponse.d.ts.map +1 -1
  300. package/dist/esm/sdk/models/shared/nearestpostcodesresponse.js +4 -5
  301. package/dist/esm/sdk/models/shared/nearestpostcodesresponse.js.map +1 -1
  302. package/dist/esm/sdk/models/shared/percentilesaggregationresult.d.ts +15 -0
  303. package/dist/esm/sdk/models/shared/percentilesaggregationresult.d.ts.map +1 -0
  304. package/dist/esm/sdk/models/shared/percentilesaggregationresult.js +13 -0
  305. package/dist/esm/sdk/models/shared/percentilesaggregationresult.js.map +1 -0
  306. package/dist/esm/sdk/models/shared/site.d.ts +15 -10
  307. package/dist/esm/sdk/models/shared/site.d.ts.map +1 -1
  308. package/dist/esm/sdk/models/shared/site.js +8 -6
  309. package/dist/esm/sdk/models/shared/site.js.map +1 -1
  310. package/dist/esm/sdk/models/shared/sitefilters.d.ts +15 -0
  311. package/dist/esm/sdk/models/shared/sitefilters.d.ts.map +1 -1
  312. package/dist/esm/sdk/models/shared/sitefilters.js +3 -0
  313. package/dist/esm/sdk/models/shared/sitefilters.js.map +1 -1
  314. package/dist/esm/sdk/models/shared/siteownership.d.ts +41 -0
  315. package/dist/esm/sdk/models/shared/siteownership.d.ts.map +1 -0
  316. package/dist/esm/sdk/models/shared/siteownership.js +20 -0
  317. package/dist/esm/sdk/models/shared/siteownership.js.map +1 -0
  318. package/dist/esm/sdk/models/shared/siteproprietor.d.ts +33 -0
  319. package/dist/esm/sdk/models/shared/siteproprietor.d.ts.map +1 -0
  320. package/dist/esm/sdk/models/shared/siteproprietor.js +18 -0
  321. package/dist/esm/sdk/models/shared/siteproprietor.js.map +1 -0
  322. package/dist/esm/sdk/models/shared/sitequerycondition.d.ts +0 -1
  323. package/dist/esm/sdk/models/shared/sitequerycondition.d.ts.map +1 -1
  324. package/dist/esm/sdk/models/shared/sitequerycondition.js +0 -1
  325. package/dist/esm/sdk/models/shared/sitequerycondition.js.map +1 -1
  326. package/dist/esm/sdk/models/shared/sitequeryrequest.d.ts +0 -3
  327. package/dist/esm/sdk/models/shared/sitequeryrequest.d.ts.map +1 -1
  328. package/dist/esm/sdk/models/shared/sitequeryrequest.js +0 -3
  329. package/dist/esm/sdk/models/shared/sitequeryrequest.js.map +1 -1
  330. package/dist/esm/sdk/models/shared/titledeeddocumentlistresponse.d.ts +76 -0
  331. package/dist/esm/sdk/models/shared/titledeeddocumentlistresponse.d.ts.map +1 -0
  332. package/dist/esm/sdk/models/shared/titledeeddocumentlistresponse.js +66 -0
  333. package/dist/esm/sdk/models/shared/titledeeddocumentlistresponse.js.map +1 -0
  334. package/dist/esm/sdk/models/shared/titledeedpurchaseresponse.d.ts +205 -0
  335. package/dist/esm/sdk/models/shared/titledeedpurchaseresponse.d.ts.map +1 -0
  336. package/dist/esm/sdk/models/shared/titledeedpurchaseresponse.js +133 -0
  337. package/dist/esm/sdk/models/shared/titledeedpurchaseresponse.js.map +1 -0
  338. package/dist/esm/sdk/planningpolicy.d.ts +12 -0
  339. package/dist/esm/sdk/planningpolicy.d.ts.map +1 -0
  340. package/dist/esm/sdk/planningpolicy.js +18 -0
  341. package/dist/esm/sdk/planningpolicy.js.map +1 -0
  342. package/dist/esm/sdk/safety.d.ts +5 -4
  343. package/dist/esm/sdk/safety.d.ts.map +1 -1
  344. package/dist/esm/sdk/safety.js +2 -2
  345. package/dist/esm/sdk/safety.js.map +1 -1
  346. package/dist/esm/sdk/sdk.d.ts +6 -0
  347. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  348. package/dist/esm/sdk/sdk.js +8 -0
  349. package/dist/esm/sdk/sdk.js.map +1 -1
  350. package/dist/esm/sdk/titledeeds.d.ts +27 -0
  351. package/dist/esm/sdk/titledeeds.d.ts.map +1 -0
  352. package/dist/esm/sdk/titledeeds.js +38 -0
  353. package/dist/esm/sdk/titledeeds.js.map +1 -0
  354. package/package.json +1 -1
  355. package/src/funcs/planningPolicySearch.ts +185 -0
  356. package/src/funcs/safetyGetV1SafetyCrime.ts +6 -5
  357. package/src/funcs/safetyGetV1SafetyCrimeStats.ts +6 -5
  358. package/src/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.ts +207 -0
  359. package/src/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.ts +223 -0
  360. package/src/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.ts +209 -0
  361. package/src/hooks/registration.ts +1 -4
  362. package/src/lib/config.ts +3 -3
  363. package/src/sdk/models/errors/getv1titledeedstitlenumberdocuments.ts +576 -0
  364. package/src/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.ts +750 -0
  365. package/src/sdk/models/errors/index.ts +5 -0
  366. package/src/sdk/models/errors/insufficientcreditserror.ts +115 -0
  367. package/src/sdk/models/errors/postv1titledeedstitlenumberpurchase.ts +576 -0
  368. package/src/sdk/models/errors/searchplanningpolicy.ts +174 -0
  369. package/src/sdk/models/operations/getareacoverage.ts +9 -7
  370. package/src/sdk/models/operations/getepcbylocationid.ts +54 -2
  371. package/src/sdk/models/operations/getschoolmetrics.ts +39 -32
  372. package/src/sdk/models/operations/getv1safetycrime.ts +4 -167
  373. package/src/sdk/models/operations/getv1safetycrimestats.ts +4 -176
  374. package/src/sdk/models/operations/getv1titledeedstitlenumberdocuments.ts +35 -0
  375. package/src/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.ts +59 -0
  376. package/src/sdk/models/operations/index.ts +4 -0
  377. package/src/sdk/models/operations/postv1titledeedstitlenumberpurchase.ts +35 -0
  378. package/src/sdk/models/operations/searchplanningpolicy.ts +274 -0
  379. package/src/sdk/models/shared/aggregationresult.ts +12 -0
  380. package/src/sdk/models/shared/areastatsresponse.ts +147 -0
  381. package/src/sdk/models/shared/avmanalysisresponse.ts +11 -6
  382. package/src/sdk/models/shared/crimedataresponse.ts +75 -0
  383. package/src/sdk/models/shared/crimerecord.ts +64 -0
  384. package/src/sdk/models/shared/extendedstatsaggregationresult.ts +150 -0
  385. package/src/sdk/models/shared/index.ts +9 -0
  386. package/src/sdk/models/shared/nearestpostcodesresponse.ts +20 -19
  387. package/src/sdk/models/shared/percentilesaggregationresult.ts +34 -0
  388. package/src/sdk/models/shared/site.ts +22 -16
  389. package/src/sdk/models/shared/sitefilters.ts +18 -0
  390. package/src/sdk/models/shared/siteownership.ts +71 -0
  391. package/src/sdk/models/shared/siteproprietor.ts +59 -0
  392. package/src/sdk/models/shared/sitequerycondition.ts +0 -1
  393. package/src/sdk/models/shared/sitequeryrequest.ts +0 -3
  394. package/src/sdk/models/shared/titledeeddocumentlistresponse.ts +155 -0
  395. package/src/sdk/models/shared/titledeedpurchaseresponse.ts +406 -0
  396. package/src/sdk/planningpolicy.ts +27 -0
  397. package/src/sdk/safety.ts +5 -4
  398. package/src/sdk/sdk.ts +12 -0
  399. package/src/sdk/titledeeds.ts +66 -0
  400. package/examples/package.json +0 -18
  401. package/openapi.json +0 -11986
  402. package/tsconfig.json +0 -40
@@ -0,0 +1,174 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKBaseError } from "./sdkbaseerror.js";
9
+ import { SDKValidationError } from "./sdkvalidationerror.js";
10
+
11
+ export type SearchPlanningPolicyPlanningPolicyError = {
12
+ code?: string | undefined;
13
+ message: string;
14
+ param?: string | undefined;
15
+ type: string;
16
+ };
17
+
18
+ /**
19
+ * Internal server error
20
+ */
21
+ export type SearchPlanningPolicyPlanningPolicyResponseBodyData = {
22
+ error: SearchPlanningPolicyPlanningPolicyError;
23
+ };
24
+
25
+ /**
26
+ * Internal server error
27
+ */
28
+ export class SearchPlanningPolicyPlanningPolicyResponseBody
29
+ extends SDKBaseError
30
+ {
31
+ error: SearchPlanningPolicyPlanningPolicyError;
32
+
33
+ /** The original data that was passed to this error instance. */
34
+ data$: SearchPlanningPolicyPlanningPolicyResponseBodyData;
35
+
36
+ constructor(
37
+ err: SearchPlanningPolicyPlanningPolicyResponseBodyData,
38
+ httpMeta: { response: Response; request: Request; body: string },
39
+ ) {
40
+ const message = err.error?.message
41
+ || `API error occurred: ${JSON.stringify(err)}`;
42
+ super(message, httpMeta);
43
+ this.data$ = err;
44
+ this.error = err.error;
45
+
46
+ this.name = "SearchPlanningPolicyPlanningPolicyResponseBody";
47
+ }
48
+ }
49
+
50
+ export type SearchPlanningPolicyError = {
51
+ code?: string | undefined;
52
+ message: string;
53
+ param?: string | undefined;
54
+ type: string;
55
+ };
56
+
57
+ /**
58
+ * Invalid request parameters
59
+ */
60
+ export type SearchPlanningPolicyResponseBodyData = {
61
+ error: SearchPlanningPolicyError;
62
+ };
63
+
64
+ /**
65
+ * Invalid request parameters
66
+ */
67
+ export class SearchPlanningPolicyResponseBody extends SDKBaseError {
68
+ error: SearchPlanningPolicyError;
69
+
70
+ /** The original data that was passed to this error instance. */
71
+ data$: SearchPlanningPolicyResponseBodyData;
72
+
73
+ constructor(
74
+ err: SearchPlanningPolicyResponseBodyData,
75
+ httpMeta: { response: Response; request: Request; body: string },
76
+ ) {
77
+ const message = err.error?.message
78
+ || `API error occurred: ${JSON.stringify(err)}`;
79
+ super(message, httpMeta);
80
+ this.data$ = err;
81
+ this.error = err.error;
82
+
83
+ this.name = "SearchPlanningPolicyResponseBody";
84
+ }
85
+ }
86
+
87
+ /** @internal */
88
+ export const SearchPlanningPolicyPlanningPolicyError$inboundSchema: z.ZodType<
89
+ SearchPlanningPolicyPlanningPolicyError,
90
+ z.ZodTypeDef,
91
+ unknown
92
+ > = z.object({
93
+ code: z.string().optional(),
94
+ message: z.string(),
95
+ param: z.string().optional(),
96
+ type: z.string(),
97
+ });
98
+
99
+ export function searchPlanningPolicyPlanningPolicyErrorFromJSON(
100
+ jsonString: string,
101
+ ): SafeParseResult<
102
+ SearchPlanningPolicyPlanningPolicyError,
103
+ SDKValidationError
104
+ > {
105
+ return safeParse(
106
+ jsonString,
107
+ (x) =>
108
+ SearchPlanningPolicyPlanningPolicyError$inboundSchema.parse(
109
+ JSON.parse(x),
110
+ ),
111
+ `Failed to parse 'SearchPlanningPolicyPlanningPolicyError' from JSON`,
112
+ );
113
+ }
114
+
115
+ /** @internal */
116
+ export const SearchPlanningPolicyPlanningPolicyResponseBody$inboundSchema:
117
+ z.ZodType<
118
+ SearchPlanningPolicyPlanningPolicyResponseBody,
119
+ z.ZodTypeDef,
120
+ unknown
121
+ > = z.object({
122
+ error: z.lazy(() => SearchPlanningPolicyPlanningPolicyError$inboundSchema),
123
+ request$: z.instanceof(Request),
124
+ response$: z.instanceof(Response),
125
+ body$: z.string(),
126
+ })
127
+ .transform((v) => {
128
+ return new SearchPlanningPolicyPlanningPolicyResponseBody(v, {
129
+ request: v.request$,
130
+ response: v.response$,
131
+ body: v.body$,
132
+ });
133
+ });
134
+
135
+ /** @internal */
136
+ export const SearchPlanningPolicyError$inboundSchema: z.ZodType<
137
+ SearchPlanningPolicyError,
138
+ z.ZodTypeDef,
139
+ unknown
140
+ > = z.object({
141
+ code: z.string().optional(),
142
+ message: z.string(),
143
+ param: z.string().optional(),
144
+ type: z.string(),
145
+ });
146
+
147
+ export function searchPlanningPolicyErrorFromJSON(
148
+ jsonString: string,
149
+ ): SafeParseResult<SearchPlanningPolicyError, SDKValidationError> {
150
+ return safeParse(
151
+ jsonString,
152
+ (x) => SearchPlanningPolicyError$inboundSchema.parse(JSON.parse(x)),
153
+ `Failed to parse 'SearchPlanningPolicyError' from JSON`,
154
+ );
155
+ }
156
+
157
+ /** @internal */
158
+ export const SearchPlanningPolicyResponseBody$inboundSchema: z.ZodType<
159
+ SearchPlanningPolicyResponseBody,
160
+ z.ZodTypeDef,
161
+ unknown
162
+ > = z.object({
163
+ error: z.lazy(() => SearchPlanningPolicyError$inboundSchema),
164
+ request$: z.instanceof(Request),
165
+ response$: z.instanceof(Response),
166
+ body$: z.string(),
167
+ })
168
+ .transform((v) => {
169
+ return new SearchPlanningPolicyResponseBody(v, {
170
+ request: v.request$,
171
+ response: v.response$,
172
+ body: v.body$,
173
+ });
174
+ });
@@ -287,7 +287,7 @@ export type GetAreaCoverageIntersectsWith = OpenEnum<
287
287
  /**
288
288
  * Layer type - supports postcodes, outcodes (e.g., SW1A), 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
289
289
  */
290
- export const SourceType = {
290
+ export const GetAreaCoverageSourceType = {
291
291
  Postcode: "postcode",
292
292
  Outcode: "outcode",
293
293
  UkOutputArea: "uk_output_area",
@@ -344,7 +344,9 @@ export const SourceType = {
344
344
  /**
345
345
  * Layer type - supports postcodes, outcodes (e.g., SW1A), 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
346
346
  */
347
- export type SourceType = OpenEnum<typeof SourceType>;
347
+ export type GetAreaCoverageSourceType = OpenEnum<
348
+ typeof GetAreaCoverageSourceType
349
+ >;
348
350
 
349
351
  /**
350
352
  * Response containing coverage analysis for a geographic area. Returns either geography-to-geography overlap or environmental layer coverage depending on query parameters.
@@ -381,7 +383,7 @@ export type GetAreaCoverageResponseBody = {
381
383
  /**
382
384
  * Layer type - supports postcodes, outcodes (e.g., SW1A), 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
383
385
  */
384
- sourceType: SourceType;
386
+ sourceType: GetAreaCoverageSourceType;
385
387
  /**
386
388
  * Indicates whether the request was successful
387
389
  */
@@ -494,11 +496,11 @@ export const GetAreaCoverageIntersectsWith$inboundSchema: z.ZodType<
494
496
  > = openEnums.inboundSchema(GetAreaCoverageIntersectsWith);
495
497
 
496
498
  /** @internal */
497
- export const SourceType$inboundSchema: z.ZodType<
498
- SourceType,
499
+ export const GetAreaCoverageSourceType$inboundSchema: z.ZodType<
500
+ GetAreaCoverageSourceType,
499
501
  z.ZodTypeDef,
500
502
  unknown
501
- > = openEnums.inboundSchema(SourceType);
503
+ > = openEnums.inboundSchema(GetAreaCoverageSourceType);
502
504
 
503
505
  /** @internal */
504
506
  export const GetAreaCoverageResponseBody$inboundSchema: z.ZodType<
@@ -513,7 +515,7 @@ export const GetAreaCoverageResponseBody$inboundSchema: z.ZodType<
513
515
  sourceArea: z.number(),
514
516
  sourceCode: z.string(),
515
517
  sourceName: z.string(),
516
- sourceType: SourceType$inboundSchema,
518
+ sourceType: GetAreaCoverageSourceType$inboundSchema,
517
519
  success: z.boolean(),
518
520
  targetCode: z.string().optional(),
519
521
  targetName: z.string().optional(),
@@ -46,6 +46,31 @@ export type ConstructionAge = {
46
46
  yearTo?: number | undefined;
47
47
  };
48
48
 
49
+ /**
50
+ * GeoJSON geometry type
51
+ */
52
+ export const GetEpcByLocationIdType = {
53
+ Point: "Point",
54
+ } as const;
55
+ /**
56
+ * GeoJSON geometry type
57
+ */
58
+ export type GetEpcByLocationIdType = ClosedEnum<typeof GetEpcByLocationIdType>;
59
+
60
+ /**
61
+ * GeoJSON Point geometry with coordinates in [longitude, latitude] order (WGS84). Null if the property could not be geocoded.
62
+ */
63
+ export type GetEpcByLocationIdGeoJSONPoint = {
64
+ /**
65
+ * Coordinate pair [longitude, latitude]
66
+ */
67
+ coordinates: Array<number>;
68
+ /**
69
+ * GeoJSON geometry type
70
+ */
71
+ type: GetEpcByLocationIdType;
72
+ };
73
+
49
74
  /**
50
75
  * Geographic location attributes for the property
51
76
  */
@@ -121,7 +146,7 @@ export type Data = {
121
146
  /**
122
147
  * GeoJSON Point geometry with coordinates in [longitude, latitude] order (WGS84). Null if the property could not be geocoded.
123
148
  */
124
- coordinates?: any | null | undefined;
149
+ coordinates: GetEpcByLocationIdGeoJSONPoint | null;
125
150
  /**
126
151
  * County name where applicable
127
152
  */
@@ -518,6 +543,31 @@ export function constructionAgeFromJSON(
518
543
  );
519
544
  }
520
545
 
546
+ /** @internal */
547
+ export const GetEpcByLocationIdType$inboundSchema: z.ZodNativeEnum<
548
+ typeof GetEpcByLocationIdType
549
+ > = z.nativeEnum(GetEpcByLocationIdType);
550
+
551
+ /** @internal */
552
+ export const GetEpcByLocationIdGeoJSONPoint$inboundSchema: z.ZodType<
553
+ GetEpcByLocationIdGeoJSONPoint,
554
+ z.ZodTypeDef,
555
+ unknown
556
+ > = z.object({
557
+ coordinates: z.array(z.number()),
558
+ type: GetEpcByLocationIdType$inboundSchema,
559
+ });
560
+
561
+ export function getEpcByLocationIdGeoJSONPointFromJSON(
562
+ jsonString: string,
563
+ ): SafeParseResult<GetEpcByLocationIdGeoJSONPoint, SDKValidationError> {
564
+ return safeParse(
565
+ jsonString,
566
+ (x) => GetEpcByLocationIdGeoJSONPoint$inboundSchema.parse(JSON.parse(x)),
567
+ `Failed to parse 'GetEpcByLocationIdGeoJSONPoint' from JSON`,
568
+ );
569
+ }
570
+
521
571
  /** @internal */
522
572
  export const Location$inboundSchema: z.ZodType<
523
573
  Location,
@@ -572,7 +622,9 @@ export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
572
622
  constituencyLabel: z.nullable(z.string()),
573
623
  constructionAge: z.nullable(z.lazy(() => ConstructionAge$inboundSchema))
574
624
  .optional(),
575
- coordinates: z.nullable(z.any()).optional(),
625
+ coordinates: z.nullable(
626
+ z.lazy(() => GetEpcByLocationIdGeoJSONPoint$inboundSchema),
627
+ ),
576
628
  county: z.nullable(z.string()),
577
629
  createdAt: z.string(),
578
630
  currentEnergyEfficiency: z.nullable(z.number()),
@@ -137,7 +137,7 @@ export type Series = {
137
137
  /**
138
138
  * School metrics time series response
139
139
  */
140
- export type Two = {
140
+ export type GetSchoolMetrics2 = {
141
141
  definitions?: Array<GetSchoolMetricsDefinitions> | undefined;
142
142
  metricCodes: Array<string>;
143
143
  schoolId: number;
@@ -205,14 +205,16 @@ export type Metrics = {
205
205
  /**
206
206
  * School metrics response for point-in-time data
207
207
  */
208
- export type One = {
208
+ export type GetSchoolMetrics1 = {
209
209
  comparisons?: { [k: string]: Comparisons } | undefined;
210
210
  definitions?: Array<Definitions> | undefined;
211
211
  metrics: Array<Metrics>;
212
212
  schoolId: number;
213
213
  };
214
214
 
215
- export type GetSchoolMetricsData = Array<One> | Array<Two>;
215
+ export type GetSchoolMetricsData =
216
+ | Array<GetSchoolMetrics1>
217
+ | Array<GetSchoolMetrics2>;
216
218
 
217
219
  export const GetSchoolMetricsObject = {
218
220
  List: "list",
@@ -223,7 +225,7 @@ export type GetSchoolMetricsObject = ClosedEnum<typeof GetSchoolMetricsObject>;
223
225
  * Paginated metrics response envelope
224
226
  */
225
227
  export type GetSchoolMetricsResponseBody = {
226
- data: Array<One> | Array<Two>;
228
+ data: Array<GetSchoolMetrics1> | Array<GetSchoolMetrics2>;
227
229
  hasMore: boolean;
228
230
  object: GetSchoolMetricsObject;
229
231
  totalCount?: number | undefined;
@@ -355,23 +357,25 @@ export function seriesFromJSON(
355
357
  }
356
358
 
357
359
  /** @internal */
358
- export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
359
- .object({
360
- definitions: z.array(
361
- z.lazy(() => GetSchoolMetricsDefinitions$inboundSchema),
362
- ).optional(),
363
- metricCodes: z.array(z.string()),
364
- schoolId: z.number(),
365
- series: z.array(z.lazy(() => Series$inboundSchema)),
366
- });
360
+ export const GetSchoolMetrics2$inboundSchema: z.ZodType<
361
+ GetSchoolMetrics2,
362
+ z.ZodTypeDef,
363
+ unknown
364
+ > = z.object({
365
+ definitions: z.array(z.lazy(() => GetSchoolMetricsDefinitions$inboundSchema))
366
+ .optional(),
367
+ metricCodes: z.array(z.string()),
368
+ schoolId: z.number(),
369
+ series: z.array(z.lazy(() => Series$inboundSchema)),
370
+ });
367
371
 
368
- export function twoFromJSON(
372
+ export function getSchoolMetrics2FromJSON(
369
373
  jsonString: string,
370
- ): SafeParseResult<Two, SDKValidationError> {
374
+ ): SafeParseResult<GetSchoolMetrics2, SDKValidationError> {
371
375
  return safeParse(
372
376
  jsonString,
373
- (x) => Two$inboundSchema.parse(JSON.parse(x)),
374
- `Failed to parse 'Two' from JSON`,
377
+ (x) => GetSchoolMetrics2$inboundSchema.parse(JSON.parse(x)),
378
+ `Failed to parse 'GetSchoolMetrics2' from JSON`,
375
379
  );
376
380
  }
377
381
 
@@ -486,21 +490,24 @@ export function metricsFromJSON(
486
490
  }
487
491
 
488
492
  /** @internal */
489
- export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
490
- .object({
491
- comparisons: z.record(z.lazy(() => Comparisons$inboundSchema)).optional(),
492
- definitions: z.array(z.lazy(() => Definitions$inboundSchema)).optional(),
493
- metrics: z.array(z.lazy(() => Metrics$inboundSchema)),
494
- schoolId: z.number(),
495
- });
493
+ export const GetSchoolMetrics1$inboundSchema: z.ZodType<
494
+ GetSchoolMetrics1,
495
+ z.ZodTypeDef,
496
+ unknown
497
+ > = z.object({
498
+ comparisons: z.record(z.lazy(() => Comparisons$inboundSchema)).optional(),
499
+ definitions: z.array(z.lazy(() => Definitions$inboundSchema)).optional(),
500
+ metrics: z.array(z.lazy(() => Metrics$inboundSchema)),
501
+ schoolId: z.number(),
502
+ });
496
503
 
497
- export function oneFromJSON(
504
+ export function getSchoolMetrics1FromJSON(
498
505
  jsonString: string,
499
- ): SafeParseResult<One, SDKValidationError> {
506
+ ): SafeParseResult<GetSchoolMetrics1, SDKValidationError> {
500
507
  return safeParse(
501
508
  jsonString,
502
- (x) => One$inboundSchema.parse(JSON.parse(x)),
503
- `Failed to parse 'One' from JSON`,
509
+ (x) => GetSchoolMetrics1$inboundSchema.parse(JSON.parse(x)),
510
+ `Failed to parse 'GetSchoolMetrics1' from JSON`,
504
511
  );
505
512
  }
506
513
 
@@ -510,8 +517,8 @@ export const GetSchoolMetricsData$inboundSchema: z.ZodType<
510
517
  z.ZodTypeDef,
511
518
  unknown
512
519
  > = z.union([
513
- z.array(z.lazy(() => One$inboundSchema)),
514
- z.array(z.lazy(() => Two$inboundSchema)),
520
+ z.array(z.lazy(() => GetSchoolMetrics1$inboundSchema)),
521
+ z.array(z.lazy(() => GetSchoolMetrics2$inboundSchema)),
515
522
  ]);
516
523
 
517
524
  export function getSchoolMetricsDataFromJSON(
@@ -536,8 +543,8 @@ export const GetSchoolMetricsResponseBody$inboundSchema: z.ZodType<
536
543
  unknown
537
544
  > = z.object({
538
545
  data: z.union([
539
- z.array(z.lazy(() => One$inboundSchema)),
540
- z.array(z.lazy(() => Two$inboundSchema)),
546
+ z.array(z.lazy(() => GetSchoolMetrics1$inboundSchema)),
547
+ z.array(z.lazy(() => GetSchoolMetrics2$inboundSchema)),
541
548
  ]),
542
549
  has_more: z.boolean(),
543
550
  object: GetSchoolMetricsObject$inboundSchema,
@@ -3,106 +3,26 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod/v3";
6
- import { safeParse } from "../../../lib/schemas.js";
7
- import { Result as SafeParseResult } from "../../types/fp.js";
8
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
6
 
10
7
  export type GetV1SafetyCrimeRequest = {
11
8
  /**
12
- * Target month in YYYY-MM format (e.g. '2024-06'). If omitted, defaults to the current month. Note that police.uk data is typically published with a 2-month lag, so the most recent month with available data may be earlier than the current date.
9
+ * Target month (YYYY-MM format)
13
10
  */
14
11
  date?: string | undefined;
15
12
  /**
16
- * WGS84 latitude of the search centre point in decimal degrees. Must be between -90 and 90. For UK locations, typical values range from 49.9 (southern England) to 55.8 (northern England).
13
+ * Latitude coordinate
17
14
  */
18
15
  latitude: string;
19
16
  /**
20
- * WGS84 longitude of the search centre point in decimal degrees. Must be between -180 and 180. For UK locations, typical values range from -5.7 (western Wales) to 1.8 (eastern England).
17
+ * Longitude coordinate
21
18
  */
22
19
  longitude: string;
23
20
  /**
24
- * Search radius in metres around the centre point (100-50,000). Defaults to 1,000m (1km). Larger radii will return more results but may be slower. A radius of 1,000m typically covers a single LSOA; 5,000m covers a neighbourhood of several LSOAs.
21
+ * Search radius in metres (100-50000)
25
22
  */
26
23
  radius?: string | undefined;
27
24
  };
28
25
 
29
- /**
30
- * Anonymised location of the crime incident. Coordinates are snapped to a police.uk anonymous map point within the LSOA, not the exact incident location.
31
- */
32
- export type GetV1SafetyCrimeLocation = {
33
- /**
34
- * WGS84 latitude of the anonymised crime location. Note: police.uk snaps crime locations to a nearby anonymous map point (typically a road or public place), so coordinates are approximate to within ~150 metres of the actual incident.
35
- */
36
- latitude: number;
37
- /**
38
- * WGS84 longitude of the anonymised crime location. Subject to the same ~150m anonymisation as latitude.
39
- */
40
- longitude: number;
41
- /**
42
- * Descriptive name of the anonymised location point (e.g. 'On or near High Street'). This is the police.uk snap-point label, not the precise street address of the incident.
43
- */
44
- street?: string | undefined;
45
- };
46
-
47
- export type GetV1SafetyCrimeData = {
48
- /**
49
- * Crime category key using underscore-separated names matching police.uk conventions. Possible values: 'anti_social_behaviour', 'bicycle_theft', 'burglary', 'criminal_damage_and_arson', 'drugs', 'other_crime', 'other_theft', 'possession_of_weapons', 'public_order', 'robbery', 'shoplifting', 'theft_from_the_person', 'vehicle_crime', 'violence_and_sexual_offences'.
50
- */
51
- category: string;
52
- /**
53
- * Month in which the crime was recorded, in YYYY-MM format. Police.uk crime data is published at monthly granularity; the specific day of the incident is not available.
54
- */
55
- date: string;
56
- /**
57
- * Unique identifier for this crime record, derived from the police.uk dataset. Format varies by police force; treat as an opaque string.
58
- */
59
- id: string;
60
- /**
61
- * Anonymised location of the crime incident. Coordinates are snapped to a police.uk anonymous map point within the LSOA, not the exact incident location.
62
- */
63
- location: GetV1SafetyCrimeLocation;
64
- /**
65
- * Outcome of the crime investigation, if available. Common values include: 'Under investigation', 'Unable to prosecute suspect', 'Investigation complete; no suspect identified', 'Awaiting court outcome', 'Offender given a caution', 'Local resolution'. Null or absent when the outcome has not yet been recorded or is not applicable (e.g. ASB incidents).
66
- */
67
- outcome?: string | undefined;
68
- };
69
-
70
- /**
71
- * Summary statistics for the returned crime data, including total count, category breakdown, and the search parameters used.
72
- */
73
- export type Summary = {
74
- /**
75
- * Breakdown of crime counts by category. Keys are underscore-separated crime category names (e.g. 'burglary', 'violence_and_sexual_offences'); values are integer counts.
76
- */
77
- byCategory: { [k: string]: number };
78
- /**
79
- * The target month for the query in YYYY-MM format.
80
- */
81
- period: string;
82
- /**
83
- * The search radius in metres that was used for this query.
84
- */
85
- radius: number;
86
- /**
87
- * Total number of crime incidents returned in the data array.
88
- */
89
- total: number;
90
- };
91
-
92
- /**
93
- * Crime data successfully retrieved. Returns individual incidents and a summary.
94
- */
95
- export type GetV1SafetyCrimeResponseBody = {
96
- /**
97
- * Array of individual crime incidents matching the search criteria. Each incident represents a single recorded crime from the police.uk dataset.
98
- */
99
- data: Array<GetV1SafetyCrimeData>;
100
- /**
101
- * Summary statistics for the returned crime data, including total count, category breakdown, and the search parameters used.
102
- */
103
- summary: Summary;
104
- };
105
-
106
26
  /** @internal */
107
27
  export type GetV1SafetyCrimeRequest$Outbound = {
108
28
  date?: string | undefined;
@@ -130,86 +50,3 @@ export function getV1SafetyCrimeRequestToJSON(
130
50
  GetV1SafetyCrimeRequest$outboundSchema.parse(getV1SafetyCrimeRequest),
131
51
  );
132
52
  }
133
-
134
- /** @internal */
135
- export const GetV1SafetyCrimeLocation$inboundSchema: z.ZodType<
136
- GetV1SafetyCrimeLocation,
137
- z.ZodTypeDef,
138
- unknown
139
- > = z.object({
140
- latitude: z.number(),
141
- longitude: z.number(),
142
- street: z.string().optional(),
143
- });
144
-
145
- export function getV1SafetyCrimeLocationFromJSON(
146
- jsonString: string,
147
- ): SafeParseResult<GetV1SafetyCrimeLocation, SDKValidationError> {
148
- return safeParse(
149
- jsonString,
150
- (x) => GetV1SafetyCrimeLocation$inboundSchema.parse(JSON.parse(x)),
151
- `Failed to parse 'GetV1SafetyCrimeLocation' from JSON`,
152
- );
153
- }
154
-
155
- /** @internal */
156
- export const GetV1SafetyCrimeData$inboundSchema: z.ZodType<
157
- GetV1SafetyCrimeData,
158
- z.ZodTypeDef,
159
- unknown
160
- > = z.object({
161
- category: z.string(),
162
- date: z.string(),
163
- id: z.string(),
164
- location: z.lazy(() => GetV1SafetyCrimeLocation$inboundSchema),
165
- outcome: z.string().optional(),
166
- });
167
-
168
- export function getV1SafetyCrimeDataFromJSON(
169
- jsonString: string,
170
- ): SafeParseResult<GetV1SafetyCrimeData, SDKValidationError> {
171
- return safeParse(
172
- jsonString,
173
- (x) => GetV1SafetyCrimeData$inboundSchema.parse(JSON.parse(x)),
174
- `Failed to parse 'GetV1SafetyCrimeData' from JSON`,
175
- );
176
- }
177
-
178
- /** @internal */
179
- export const Summary$inboundSchema: z.ZodType<Summary, z.ZodTypeDef, unknown> =
180
- z.object({
181
- byCategory: z.record(z.number()),
182
- period: z.string(),
183
- radius: z.number(),
184
- total: z.number(),
185
- });
186
-
187
- export function summaryFromJSON(
188
- jsonString: string,
189
- ): SafeParseResult<Summary, SDKValidationError> {
190
- return safeParse(
191
- jsonString,
192
- (x) => Summary$inboundSchema.parse(JSON.parse(x)),
193
- `Failed to parse 'Summary' from JSON`,
194
- );
195
- }
196
-
197
- /** @internal */
198
- export const GetV1SafetyCrimeResponseBody$inboundSchema: z.ZodType<
199
- GetV1SafetyCrimeResponseBody,
200
- z.ZodTypeDef,
201
- unknown
202
- > = z.object({
203
- data: z.array(z.lazy(() => GetV1SafetyCrimeData$inboundSchema)),
204
- summary: z.lazy(() => Summary$inboundSchema),
205
- });
206
-
207
- export function getV1SafetyCrimeResponseBodyFromJSON(
208
- jsonString: string,
209
- ): SafeParseResult<GetV1SafetyCrimeResponseBody, SDKValidationError> {
210
- return safeParse(
211
- jsonString,
212
- (x) => GetV1SafetyCrimeResponseBody$inboundSchema.parse(JSON.parse(x)),
213
- `Failed to parse 'GetV1SafetyCrimeResponseBody' from JSON`,
214
- );
215
- }