@vepler/sdk 5.28.1 → 6.1.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 (441) hide show
  1. package/README.md +436 -409
  2. package/dist/commonjs/funcs/geographyGetGeographyAncestors.d.ts +17 -0
  3. package/dist/commonjs/funcs/geographyGetGeographyAncestors.d.ts.map +1 -0
  4. package/dist/commonjs/funcs/geographyGetGeographyAncestors.js +126 -0
  5. package/dist/commonjs/funcs/geographyGetGeographyAncestors.js.map +1 -0
  6. package/dist/commonjs/funcs/geographyGetGeographyAreas.d.ts +17 -0
  7. package/dist/commonjs/funcs/geographyGetGeographyAreas.d.ts.map +1 -0
  8. package/dist/commonjs/funcs/geographyGetGeographyAreas.js +125 -0
  9. package/dist/commonjs/funcs/geographyGetGeographyAreas.js.map +1 -0
  10. package/dist/commonjs/funcs/geographyGetGeographyChildren.d.ts +17 -0
  11. package/dist/commonjs/funcs/geographyGetGeographyChildren.d.ts.map +1 -0
  12. package/dist/commonjs/funcs/geographyGetGeographyChildren.js +126 -0
  13. package/dist/commonjs/funcs/geographyGetGeographyChildren.js.map +1 -0
  14. package/dist/commonjs/funcs/geographyGetGeographyDescendants.d.ts +17 -0
  15. package/dist/commonjs/funcs/geographyGetGeographyDescendants.d.ts.map +1 -0
  16. package/dist/commonjs/funcs/geographyGetGeographyDescendants.js +128 -0
  17. package/dist/commonjs/funcs/geographyGetGeographyDescendants.js.map +1 -0
  18. package/dist/commonjs/funcs/geographyGetGeographyProvenance.d.ts +17 -0
  19. package/dist/commonjs/funcs/geographyGetGeographyProvenance.d.ts.map +1 -0
  20. package/dist/commonjs/funcs/geographyGetGeographyProvenance.js +125 -0
  21. package/dist/commonjs/funcs/geographyGetGeographyProvenance.js.map +1 -0
  22. package/dist/commonjs/funcs/geographyGetGeographyRelease.d.ts +17 -0
  23. package/dist/commonjs/funcs/geographyGetGeographyRelease.d.ts.map +1 -0
  24. package/dist/commonjs/funcs/geographyGetGeographyRelease.js +105 -0
  25. package/dist/commonjs/funcs/geographyGetGeographyRelease.js.map +1 -0
  26. package/dist/commonjs/funcs/safetyGetCrimeIncidents.d.ts +1 -1
  27. package/dist/commonjs/funcs/safetyGetCrimeIncidents.js +1 -1
  28. package/dist/commonjs/funcs/safetyGetGeographyMetrics.d.ts +2 -2
  29. package/dist/commonjs/funcs/safetyGetGeographyMetrics.js +2 -2
  30. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.d.ts +19 -0
  31. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.d.ts.map +1 -0
  32. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.js +129 -0
  33. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.js.map +1 -0
  34. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.d.ts +19 -0
  35. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.d.ts.map +1 -0
  36. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.js +129 -0
  37. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.js.map +1 -0
  38. package/dist/commonjs/lib/config.d.ts +3 -3
  39. package/dist/commonjs/lib/config.js +3 -3
  40. package/dist/commonjs/lib/config.js.map +1 -1
  41. package/dist/commonjs/lib/encodings.d.ts +10 -9
  42. package/dist/commonjs/lib/encodings.d.ts.map +1 -1
  43. package/dist/commonjs/lib/encodings.js +29 -13
  44. package/dist/commonjs/lib/encodings.js.map +1 -1
  45. package/dist/commonjs/sdk/geography.d.ts +47 -0
  46. package/dist/commonjs/sdk/geography.d.ts.map +1 -0
  47. package/dist/commonjs/sdk/geography.js +72 -0
  48. package/dist/commonjs/sdk/geography.js.map +1 -0
  49. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberapplications.d.ts +266 -0
  50. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberapplications.d.ts.map +1 -0
  51. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberapplications.js +261 -0
  52. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberapplications.js.map +1 -0
  53. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberavailability.d.ts +266 -0
  54. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberavailability.d.ts.map +1 -0
  55. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberavailability.js +261 -0
  56. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberavailability.js.map +1 -0
  57. package/dist/commonjs/sdk/models/errors/index.d.ts +2 -0
  58. package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
  59. package/dist/commonjs/sdk/models/errors/index.js +2 -0
  60. package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
  61. package/dist/commonjs/sdk/models/errors/titledeedpurchasenotfound.d.ts +16 -0
  62. package/dist/commonjs/sdk/models/errors/titledeedpurchasenotfound.d.ts.map +1 -1
  63. package/dist/commonjs/sdk/models/errors/titledeedpurchasenotfound.js +6 -0
  64. package/dist/commonjs/sdk/models/errors/titledeedpurchasenotfound.js.map +1 -1
  65. package/dist/commonjs/sdk/models/operations/getgeographyancestors.d.ts +52 -0
  66. package/dist/commonjs/sdk/models/operations/getgeographyancestors.d.ts.map +1 -0
  67. package/dist/commonjs/sdk/models/operations/getgeographyancestors.js +75 -0
  68. package/dist/commonjs/sdk/models/operations/getgeographyancestors.js.map +1 -0
  69. package/dist/commonjs/sdk/models/operations/getgeographyareas.d.ts +47 -0
  70. package/dist/commonjs/sdk/models/operations/getgeographyareas.d.ts.map +1 -0
  71. package/dist/commonjs/sdk/models/operations/getgeographyareas.js +74 -0
  72. package/dist/commonjs/sdk/models/operations/getgeographyareas.js.map +1 -0
  73. package/dist/commonjs/sdk/models/operations/getgeographychildren.d.ts +82 -0
  74. package/dist/commonjs/sdk/models/operations/getgeographychildren.d.ts.map +1 -0
  75. package/dist/commonjs/sdk/models/operations/getgeographychildren.js +89 -0
  76. package/dist/commonjs/sdk/models/operations/getgeographychildren.js.map +1 -0
  77. package/dist/commonjs/sdk/models/operations/getgeographydescendants.d.ts +62 -0
  78. package/dist/commonjs/sdk/models/operations/getgeographydescendants.d.ts.map +1 -0
  79. package/dist/commonjs/sdk/models/operations/getgeographydescendants.js +77 -0
  80. package/dist/commonjs/sdk/models/operations/getgeographydescendants.js.map +1 -0
  81. package/dist/commonjs/sdk/models/operations/getgeographyprovenance.d.ts +54 -0
  82. package/dist/commonjs/sdk/models/operations/getgeographyprovenance.d.ts.map +1 -0
  83. package/dist/commonjs/sdk/models/operations/getgeographyprovenance.js +89 -0
  84. package/dist/commonjs/sdk/models/operations/getgeographyprovenance.js.map +1 -0
  85. package/dist/commonjs/sdk/models/operations/getgeographyrelease.d.ts +19 -0
  86. package/dist/commonjs/sdk/models/operations/getgeographyrelease.d.ts.map +1 -0
  87. package/dist/commonjs/sdk/models/operations/getgeographyrelease.js +58 -0
  88. package/dist/commonjs/sdk/models/operations/getgeographyrelease.js.map +1 -0
  89. package/dist/commonjs/sdk/models/operations/getlistingbyid.d.ts +2 -2
  90. package/dist/commonjs/sdk/models/operations/getlistingbyid.d.ts.map +1 -1
  91. package/dist/commonjs/sdk/models/operations/getlistingbyid.js +1 -1
  92. package/dist/commonjs/sdk/models/operations/getlistingbyid.js.map +1 -1
  93. package/dist/commonjs/sdk/models/operations/getlistingbysource.d.ts +2 -2
  94. package/dist/commonjs/sdk/models/operations/getlistingbysource.d.ts.map +1 -1
  95. package/dist/commonjs/sdk/models/operations/getlistingbysource.js +1 -1
  96. package/dist/commonjs/sdk/models/operations/getlistingbysource.js.map +1 -1
  97. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.d.ts +2 -2
  98. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.d.ts.map +1 -1
  99. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.js +1 -1
  100. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.js.map +1 -1
  101. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberapplications.d.ts +15 -0
  102. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberapplications.d.ts.map +1 -0
  103. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberapplications.js +49 -0
  104. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberapplications.js.map +1 -0
  105. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberavailability.d.ts +15 -0
  106. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberavailability.d.ts.map +1 -0
  107. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberavailability.js +49 -0
  108. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberavailability.js.map +1 -0
  109. package/dist/commonjs/sdk/models/operations/index.d.ts +8 -0
  110. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  111. package/dist/commonjs/sdk/models/operations/index.js +8 -0
  112. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  113. package/dist/commonjs/sdk/models/operations/querylistings.d.ts +2 -2
  114. package/dist/commonjs/sdk/models/operations/querylistings.d.ts.map +1 -1
  115. package/dist/commonjs/sdk/models/operations/querylistings.js +1 -1
  116. package/dist/commonjs/sdk/models/operations/querylistings.js.map +1 -1
  117. package/dist/commonjs/sdk/models/operations/querylistingsbysource.d.ts +2 -2
  118. package/dist/commonjs/sdk/models/operations/querylistingsbysource.d.ts.map +1 -1
  119. package/dist/commonjs/sdk/models/operations/querylistingsbysource.js +1 -1
  120. package/dist/commonjs/sdk/models/operations/querylistingsbysource.js.map +1 -1
  121. package/dist/commonjs/sdk/models/shared/advancedlisting.d.ts +2 -2
  122. package/dist/commonjs/sdk/models/shared/advancedlisting.d.ts.map +1 -1
  123. package/dist/commonjs/sdk/models/shared/advancedlisting.js +1 -1
  124. package/dist/commonjs/sdk/models/shared/advancedlisting.js.map +1 -1
  125. package/dist/commonjs/sdk/models/shared/conservationdesignationfeature.d.ts +1 -1
  126. package/dist/commonjs/sdk/models/shared/crimecatalogentry.d.ts +5 -6
  127. package/dist/commonjs/sdk/models/shared/crimecatalogentry.d.ts.map +1 -1
  128. package/dist/commonjs/sdk/models/shared/crimecatalogentry.js +1 -2
  129. package/dist/commonjs/sdk/models/shared/crimecatalogentry.js.map +1 -1
  130. package/dist/commonjs/sdk/models/shared/crimecatalogperiodsbycountry.d.ts +1 -1
  131. package/dist/commonjs/sdk/models/shared/crimeconfidenceinterval.d.ts +1 -1
  132. package/dist/commonjs/sdk/models/shared/crimeincident.d.ts +9 -5
  133. package/dist/commonjs/sdk/models/shared/crimeincident.d.ts.map +1 -1
  134. package/dist/commonjs/sdk/models/shared/crimeincident.js +1 -0
  135. package/dist/commonjs/sdk/models/shared/crimeincident.js.map +1 -1
  136. package/dist/commonjs/sdk/models/shared/crimeincidentslistresponse.d.ts +1 -1
  137. package/dist/commonjs/sdk/models/shared/crimeincidentssummary.d.ts +1 -1
  138. package/dist/commonjs/sdk/models/shared/crimeperioddetails.d.ts +13 -1
  139. package/dist/commonjs/sdk/models/shared/crimeperioddetails.d.ts.map +1 -1
  140. package/dist/commonjs/sdk/models/shared/crimeperioddetails.js +3 -0
  141. package/dist/commonjs/sdk/models/shared/crimeperioddetails.js.map +1 -1
  142. package/dist/commonjs/sdk/models/shared/geographyarea.d.ts +33 -0
  143. package/dist/commonjs/sdk/models/shared/geographyarea.d.ts.map +1 -0
  144. package/dist/commonjs/sdk/models/shared/geographyarea.js +55 -0
  145. package/dist/commonjs/sdk/models/shared/geographyarea.js.map +1 -0
  146. package/dist/commonjs/sdk/models/shared/geographycategorymetric.d.ts +46 -10
  147. package/dist/commonjs/sdk/models/shared/geographycategorymetric.d.ts.map +1 -1
  148. package/dist/commonjs/sdk/models/shared/geographycategorymetric.js +9 -0
  149. package/dist/commonjs/sdk/models/shared/geographycategorymetric.js.map +1 -1
  150. package/dist/commonjs/sdk/models/shared/geographymetricsrow.d.ts +32 -4
  151. package/dist/commonjs/sdk/models/shared/geographymetricsrow.d.ts.map +1 -1
  152. package/dist/commonjs/sdk/models/shared/geographymetricsrow.js +7 -0
  153. package/dist/commonjs/sdk/models/shared/geographymetricsrow.js.map +1 -1
  154. package/dist/commonjs/sdk/models/shared/geographyrelatedarea.d.ts +41 -0
  155. package/dist/commonjs/sdk/models/shared/geographyrelatedarea.d.ts.map +1 -0
  156. package/dist/commonjs/sdk/models/shared/geographyrelatedarea.js +57 -0
  157. package/dist/commonjs/sdk/models/shared/geographyrelatedarea.js.map +1 -0
  158. package/dist/commonjs/sdk/models/shared/geographytimeseriespoint.d.ts +9 -5
  159. package/dist/commonjs/sdk/models/shared/geographytimeseriespoint.d.ts.map +1 -1
  160. package/dist/commonjs/sdk/models/shared/geographytimeseriespoint.js +1 -0
  161. package/dist/commonjs/sdk/models/shared/geographytimeseriespoint.js.map +1 -1
  162. package/dist/commonjs/sdk/models/shared/heritagedesignationfeature.d.ts +1 -1
  163. package/dist/commonjs/sdk/models/shared/index.d.ts +5 -0
  164. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  165. package/dist/commonjs/sdk/models/shared/index.js +5 -0
  166. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  167. package/dist/commonjs/sdk/models/shared/landconstraintdesignationfeature.d.ts +1 -1
  168. package/dist/commonjs/sdk/models/shared/listing.d.ts +2 -2
  169. package/dist/commonjs/sdk/models/shared/listing.d.ts.map +1 -1
  170. package/dist/commonjs/sdk/models/shared/listing.js +1 -1
  171. package/dist/commonjs/sdk/models/shared/listing.js.map +1 -1
  172. package/dist/commonjs/sdk/models/shared/titledeedapplication.d.ts +69 -0
  173. package/dist/commonjs/sdk/models/shared/titledeedapplication.d.ts.map +1 -0
  174. package/dist/commonjs/sdk/models/shared/titledeedapplication.js +84 -0
  175. package/dist/commonjs/sdk/models/shared/titledeedapplication.js.map +1 -0
  176. package/dist/commonjs/sdk/models/shared/titledeedapplicationlistresponse.d.ts +24 -0
  177. package/dist/commonjs/sdk/models/shared/titledeedapplicationlistresponse.d.ts.map +1 -0
  178. package/dist/commonjs/sdk/models/shared/titledeedapplicationlistresponse.js +65 -0
  179. package/dist/commonjs/sdk/models/shared/titledeedapplicationlistresponse.js.map +1 -0
  180. package/dist/commonjs/sdk/models/shared/titledeedavailabilityresponse.d.ts +67 -0
  181. package/dist/commonjs/sdk/models/shared/titledeedavailabilityresponse.d.ts.map +1 -0
  182. package/dist/commonjs/sdk/models/shared/titledeedavailabilityresponse.js +108 -0
  183. package/dist/commonjs/sdk/models/shared/titledeedavailabilityresponse.js.map +1 -0
  184. package/dist/commonjs/sdk/safety.d.ts +3 -3
  185. package/dist/commonjs/sdk/safety.js +3 -3
  186. package/dist/commonjs/sdk/sdk.d.ts +3 -0
  187. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  188. package/dist/commonjs/sdk/sdk.js +4 -0
  189. package/dist/commonjs/sdk/sdk.js.map +1 -1
  190. package/dist/commonjs/sdk/titledeeds.d.ts +14 -0
  191. package/dist/commonjs/sdk/titledeeds.d.ts.map +1 -1
  192. package/dist/commonjs/sdk/titledeeds.js +20 -0
  193. package/dist/commonjs/sdk/titledeeds.js.map +1 -1
  194. package/dist/esm/funcs/geographyGetGeographyAncestors.d.ts +17 -0
  195. package/dist/esm/funcs/geographyGetGeographyAncestors.d.ts.map +1 -0
  196. package/dist/esm/funcs/geographyGetGeographyAncestors.js +90 -0
  197. package/dist/esm/funcs/geographyGetGeographyAncestors.js.map +1 -0
  198. package/dist/esm/funcs/geographyGetGeographyAreas.d.ts +17 -0
  199. package/dist/esm/funcs/geographyGetGeographyAreas.d.ts.map +1 -0
  200. package/dist/esm/funcs/geographyGetGeographyAreas.js +89 -0
  201. package/dist/esm/funcs/geographyGetGeographyAreas.js.map +1 -0
  202. package/dist/esm/funcs/geographyGetGeographyChildren.d.ts +17 -0
  203. package/dist/esm/funcs/geographyGetGeographyChildren.d.ts.map +1 -0
  204. package/dist/esm/funcs/geographyGetGeographyChildren.js +90 -0
  205. package/dist/esm/funcs/geographyGetGeographyChildren.js.map +1 -0
  206. package/dist/esm/funcs/geographyGetGeographyDescendants.d.ts +17 -0
  207. package/dist/esm/funcs/geographyGetGeographyDescendants.d.ts.map +1 -0
  208. package/dist/esm/funcs/geographyGetGeographyDescendants.js +92 -0
  209. package/dist/esm/funcs/geographyGetGeographyDescendants.js.map +1 -0
  210. package/dist/esm/funcs/geographyGetGeographyProvenance.d.ts +17 -0
  211. package/dist/esm/funcs/geographyGetGeographyProvenance.d.ts.map +1 -0
  212. package/dist/esm/funcs/geographyGetGeographyProvenance.js +89 -0
  213. package/dist/esm/funcs/geographyGetGeographyProvenance.js.map +1 -0
  214. package/dist/esm/funcs/geographyGetGeographyRelease.d.ts +17 -0
  215. package/dist/esm/funcs/geographyGetGeographyRelease.d.ts.map +1 -0
  216. package/dist/esm/funcs/geographyGetGeographyRelease.js +69 -0
  217. package/dist/esm/funcs/geographyGetGeographyRelease.js.map +1 -0
  218. package/dist/esm/funcs/safetyGetCrimeIncidents.d.ts +1 -1
  219. package/dist/esm/funcs/safetyGetCrimeIncidents.js +1 -1
  220. package/dist/esm/funcs/safetyGetGeographyMetrics.d.ts +2 -2
  221. package/dist/esm/funcs/safetyGetGeographyMetrics.js +2 -2
  222. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.d.ts +19 -0
  223. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.d.ts.map +1 -0
  224. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.js +93 -0
  225. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.js.map +1 -0
  226. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.d.ts +19 -0
  227. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.d.ts.map +1 -0
  228. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.js +93 -0
  229. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.js.map +1 -0
  230. package/dist/esm/lib/config.d.ts +3 -3
  231. package/dist/esm/lib/config.js +3 -3
  232. package/dist/esm/lib/config.js.map +1 -1
  233. package/dist/esm/lib/encodings.d.ts +10 -9
  234. package/dist/esm/lib/encodings.d.ts.map +1 -1
  235. package/dist/esm/lib/encodings.js +29 -13
  236. package/dist/esm/lib/encodings.js.map +1 -1
  237. package/dist/esm/sdk/geography.d.ts +47 -0
  238. package/dist/esm/sdk/geography.d.ts.map +1 -0
  239. package/dist/esm/sdk/geography.js +68 -0
  240. package/dist/esm/sdk/geography.js.map +1 -0
  241. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberapplications.d.ts +266 -0
  242. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberapplications.d.ts.map +1 -0
  243. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberapplications.js +217 -0
  244. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberapplications.js.map +1 -0
  245. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberavailability.d.ts +266 -0
  246. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberavailability.d.ts.map +1 -0
  247. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberavailability.js +217 -0
  248. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberavailability.js.map +1 -0
  249. package/dist/esm/sdk/models/errors/index.d.ts +2 -0
  250. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  251. package/dist/esm/sdk/models/errors/index.js +2 -0
  252. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  253. package/dist/esm/sdk/models/errors/titledeedpurchasenotfound.d.ts +16 -0
  254. package/dist/esm/sdk/models/errors/titledeedpurchasenotfound.d.ts.map +1 -1
  255. package/dist/esm/sdk/models/errors/titledeedpurchasenotfound.js +6 -0
  256. package/dist/esm/sdk/models/errors/titledeedpurchasenotfound.js.map +1 -1
  257. package/dist/esm/sdk/models/operations/getgeographyancestors.d.ts +52 -0
  258. package/dist/esm/sdk/models/operations/getgeographyancestors.d.ts.map +1 -0
  259. package/dist/esm/sdk/models/operations/getgeographyancestors.js +37 -0
  260. package/dist/esm/sdk/models/operations/getgeographyancestors.js.map +1 -0
  261. package/dist/esm/sdk/models/operations/getgeographyareas.d.ts +47 -0
  262. package/dist/esm/sdk/models/operations/getgeographyareas.d.ts.map +1 -0
  263. package/dist/esm/sdk/models/operations/getgeographyareas.js +36 -0
  264. package/dist/esm/sdk/models/operations/getgeographyareas.js.map +1 -0
  265. package/dist/esm/sdk/models/operations/getgeographychildren.d.ts +82 -0
  266. package/dist/esm/sdk/models/operations/getgeographychildren.d.ts.map +1 -0
  267. package/dist/esm/sdk/models/operations/getgeographychildren.js +50 -0
  268. package/dist/esm/sdk/models/operations/getgeographychildren.js.map +1 -0
  269. package/dist/esm/sdk/models/operations/getgeographydescendants.d.ts +62 -0
  270. package/dist/esm/sdk/models/operations/getgeographydescendants.d.ts.map +1 -0
  271. package/dist/esm/sdk/models/operations/getgeographydescendants.js +39 -0
  272. package/dist/esm/sdk/models/operations/getgeographydescendants.js.map +1 -0
  273. package/dist/esm/sdk/models/operations/getgeographyprovenance.d.ts +54 -0
  274. package/dist/esm/sdk/models/operations/getgeographyprovenance.d.ts.map +1 -0
  275. package/dist/esm/sdk/models/operations/getgeographyprovenance.js +50 -0
  276. package/dist/esm/sdk/models/operations/getgeographyprovenance.js.map +1 -0
  277. package/dist/esm/sdk/models/operations/getgeographyrelease.d.ts +19 -0
  278. package/dist/esm/sdk/models/operations/getgeographyrelease.d.ts.map +1 -0
  279. package/dist/esm/sdk/models/operations/getgeographyrelease.js +20 -0
  280. package/dist/esm/sdk/models/operations/getgeographyrelease.js.map +1 -0
  281. package/dist/esm/sdk/models/operations/getlistingbyid.d.ts +2 -2
  282. package/dist/esm/sdk/models/operations/getlistingbyid.d.ts.map +1 -1
  283. package/dist/esm/sdk/models/operations/getlistingbyid.js +1 -1
  284. package/dist/esm/sdk/models/operations/getlistingbyid.js.map +1 -1
  285. package/dist/esm/sdk/models/operations/getlistingbysource.d.ts +2 -2
  286. package/dist/esm/sdk/models/operations/getlistingbysource.d.ts.map +1 -1
  287. package/dist/esm/sdk/models/operations/getlistingbysource.js +1 -1
  288. package/dist/esm/sdk/models/operations/getlistingbysource.js.map +1 -1
  289. package/dist/esm/sdk/models/operations/getlistingsbylocation.d.ts +2 -2
  290. package/dist/esm/sdk/models/operations/getlistingsbylocation.d.ts.map +1 -1
  291. package/dist/esm/sdk/models/operations/getlistingsbylocation.js +1 -1
  292. package/dist/esm/sdk/models/operations/getlistingsbylocation.js.map +1 -1
  293. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberapplications.d.ts +15 -0
  294. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberapplications.d.ts.map +1 -0
  295. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberapplications.js +12 -0
  296. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberapplications.js.map +1 -0
  297. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberavailability.d.ts +15 -0
  298. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberavailability.d.ts.map +1 -0
  299. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberavailability.js +12 -0
  300. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberavailability.js.map +1 -0
  301. package/dist/esm/sdk/models/operations/index.d.ts +8 -0
  302. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  303. package/dist/esm/sdk/models/operations/index.js +8 -0
  304. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  305. package/dist/esm/sdk/models/operations/querylistings.d.ts +2 -2
  306. package/dist/esm/sdk/models/operations/querylistings.d.ts.map +1 -1
  307. package/dist/esm/sdk/models/operations/querylistings.js +1 -1
  308. package/dist/esm/sdk/models/operations/querylistings.js.map +1 -1
  309. package/dist/esm/sdk/models/operations/querylistingsbysource.d.ts +2 -2
  310. package/dist/esm/sdk/models/operations/querylistingsbysource.d.ts.map +1 -1
  311. package/dist/esm/sdk/models/operations/querylistingsbysource.js +1 -1
  312. package/dist/esm/sdk/models/operations/querylistingsbysource.js.map +1 -1
  313. package/dist/esm/sdk/models/shared/advancedlisting.d.ts +2 -2
  314. package/dist/esm/sdk/models/shared/advancedlisting.d.ts.map +1 -1
  315. package/dist/esm/sdk/models/shared/advancedlisting.js +1 -1
  316. package/dist/esm/sdk/models/shared/advancedlisting.js.map +1 -1
  317. package/dist/esm/sdk/models/shared/conservationdesignationfeature.d.ts +1 -1
  318. package/dist/esm/sdk/models/shared/crimecatalogentry.d.ts +5 -6
  319. package/dist/esm/sdk/models/shared/crimecatalogentry.d.ts.map +1 -1
  320. package/dist/esm/sdk/models/shared/crimecatalogentry.js +1 -2
  321. package/dist/esm/sdk/models/shared/crimecatalogentry.js.map +1 -1
  322. package/dist/esm/sdk/models/shared/crimecatalogperiodsbycountry.d.ts +1 -1
  323. package/dist/esm/sdk/models/shared/crimeconfidenceinterval.d.ts +1 -1
  324. package/dist/esm/sdk/models/shared/crimeincident.d.ts +9 -5
  325. package/dist/esm/sdk/models/shared/crimeincident.d.ts.map +1 -1
  326. package/dist/esm/sdk/models/shared/crimeincident.js +1 -0
  327. package/dist/esm/sdk/models/shared/crimeincident.js.map +1 -1
  328. package/dist/esm/sdk/models/shared/crimeincidentslistresponse.d.ts +1 -1
  329. package/dist/esm/sdk/models/shared/crimeincidentssummary.d.ts +1 -1
  330. package/dist/esm/sdk/models/shared/crimeperioddetails.d.ts +13 -1
  331. package/dist/esm/sdk/models/shared/crimeperioddetails.d.ts.map +1 -1
  332. package/dist/esm/sdk/models/shared/crimeperioddetails.js +3 -0
  333. package/dist/esm/sdk/models/shared/crimeperioddetails.js.map +1 -1
  334. package/dist/esm/sdk/models/shared/geographyarea.d.ts +33 -0
  335. package/dist/esm/sdk/models/shared/geographyarea.d.ts.map +1 -0
  336. package/dist/esm/sdk/models/shared/geographyarea.js +18 -0
  337. package/dist/esm/sdk/models/shared/geographyarea.js.map +1 -0
  338. package/dist/esm/sdk/models/shared/geographycategorymetric.d.ts +46 -10
  339. package/dist/esm/sdk/models/shared/geographycategorymetric.d.ts.map +1 -1
  340. package/dist/esm/sdk/models/shared/geographycategorymetric.js +9 -0
  341. package/dist/esm/sdk/models/shared/geographycategorymetric.js.map +1 -1
  342. package/dist/esm/sdk/models/shared/geographymetricsrow.d.ts +32 -4
  343. package/dist/esm/sdk/models/shared/geographymetricsrow.d.ts.map +1 -1
  344. package/dist/esm/sdk/models/shared/geographymetricsrow.js +7 -0
  345. package/dist/esm/sdk/models/shared/geographymetricsrow.js.map +1 -1
  346. package/dist/esm/sdk/models/shared/geographyrelatedarea.d.ts +41 -0
  347. package/dist/esm/sdk/models/shared/geographyrelatedarea.d.ts.map +1 -0
  348. package/dist/esm/sdk/models/shared/geographyrelatedarea.js +20 -0
  349. package/dist/esm/sdk/models/shared/geographyrelatedarea.js.map +1 -0
  350. package/dist/esm/sdk/models/shared/geographytimeseriespoint.d.ts +9 -5
  351. package/dist/esm/sdk/models/shared/geographytimeseriespoint.d.ts.map +1 -1
  352. package/dist/esm/sdk/models/shared/geographytimeseriespoint.js +1 -0
  353. package/dist/esm/sdk/models/shared/geographytimeseriespoint.js.map +1 -1
  354. package/dist/esm/sdk/models/shared/heritagedesignationfeature.d.ts +1 -1
  355. package/dist/esm/sdk/models/shared/index.d.ts +5 -0
  356. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  357. package/dist/esm/sdk/models/shared/index.js +5 -0
  358. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  359. package/dist/esm/sdk/models/shared/landconstraintdesignationfeature.d.ts +1 -1
  360. package/dist/esm/sdk/models/shared/listing.d.ts +2 -2
  361. package/dist/esm/sdk/models/shared/listing.d.ts.map +1 -1
  362. package/dist/esm/sdk/models/shared/listing.js +1 -1
  363. package/dist/esm/sdk/models/shared/listing.js.map +1 -1
  364. package/dist/esm/sdk/models/shared/titledeedapplication.d.ts +69 -0
  365. package/dist/esm/sdk/models/shared/titledeedapplication.d.ts.map +1 -0
  366. package/dist/esm/sdk/models/shared/titledeedapplication.js +47 -0
  367. package/dist/esm/sdk/models/shared/titledeedapplication.js.map +1 -0
  368. package/dist/esm/sdk/models/shared/titledeedapplicationlistresponse.d.ts +24 -0
  369. package/dist/esm/sdk/models/shared/titledeedapplicationlistresponse.d.ts.map +1 -0
  370. package/dist/esm/sdk/models/shared/titledeedapplicationlistresponse.js +28 -0
  371. package/dist/esm/sdk/models/shared/titledeedapplicationlistresponse.js.map +1 -0
  372. package/dist/esm/sdk/models/shared/titledeedavailabilityresponse.d.ts +67 -0
  373. package/dist/esm/sdk/models/shared/titledeedavailabilityresponse.d.ts.map +1 -0
  374. package/dist/esm/sdk/models/shared/titledeedavailabilityresponse.js +69 -0
  375. package/dist/esm/sdk/models/shared/titledeedavailabilityresponse.js.map +1 -0
  376. package/dist/esm/sdk/safety.d.ts +3 -3
  377. package/dist/esm/sdk/safety.js +3 -3
  378. package/dist/esm/sdk/sdk.d.ts +3 -0
  379. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  380. package/dist/esm/sdk/sdk.js +4 -0
  381. package/dist/esm/sdk/sdk.js.map +1 -1
  382. package/dist/esm/sdk/titledeeds.d.ts +14 -0
  383. package/dist/esm/sdk/titledeeds.d.ts.map +1 -1
  384. package/dist/esm/sdk/titledeeds.js +20 -0
  385. package/dist/esm/sdk/titledeeds.js.map +1 -1
  386. package/package.json +1 -1
  387. package/src/funcs/geographyGetGeographyAncestors.ts +175 -0
  388. package/src/funcs/geographyGetGeographyAreas.ts +173 -0
  389. package/src/funcs/geographyGetGeographyChildren.ts +175 -0
  390. package/src/funcs/geographyGetGeographyDescendants.ts +177 -0
  391. package/src/funcs/geographyGetGeographyProvenance.ts +174 -0
  392. package/src/funcs/geographyGetGeographyRelease.ts +144 -0
  393. package/src/funcs/safetyGetCrimeIncidents.ts +1 -1
  394. package/src/funcs/safetyGetGeographyMetrics.ts +2 -2
  395. package/src/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.ts +208 -0
  396. package/src/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.ts +208 -0
  397. package/src/lib/config.ts +3 -3
  398. package/src/lib/encodings.ts +58 -23
  399. package/src/sdk/geography.ts +115 -0
  400. package/src/sdk/models/errors/getv1titledeedstitlenumberapplications.ts +580 -0
  401. package/src/sdk/models/errors/getv1titledeedstitlenumberavailability.ts +580 -0
  402. package/src/sdk/models/errors/index.ts +2 -0
  403. package/src/sdk/models/errors/titledeedpurchasenotfound.ts +22 -0
  404. package/src/sdk/models/operations/getgeographyancestors.ts +108 -0
  405. package/src/sdk/models/operations/getgeographyareas.ts +100 -0
  406. package/src/sdk/models/operations/getgeographychildren.ts +162 -0
  407. package/src/sdk/models/operations/getgeographydescendants.ts +121 -0
  408. package/src/sdk/models/operations/getgeographyprovenance.ts +135 -0
  409. package/src/sdk/models/operations/getgeographyrelease.ts +57 -0
  410. package/src/sdk/models/operations/getlistingbyid.ts +5 -5
  411. package/src/sdk/models/operations/getlistingbysource.ts +5 -5
  412. package/src/sdk/models/operations/getlistingsbylocation.ts +5 -5
  413. package/src/sdk/models/operations/getv1titledeedstitlenumberapplications.ts +38 -0
  414. package/src/sdk/models/operations/getv1titledeedstitlenumberavailability.ts +38 -0
  415. package/src/sdk/models/operations/index.ts +8 -0
  416. package/src/sdk/models/operations/querylistings.ts +5 -5
  417. package/src/sdk/models/operations/querylistingsbysource.ts +5 -5
  418. package/src/sdk/models/shared/advancedlisting.ts +4 -4
  419. package/src/sdk/models/shared/conservationdesignationfeature.ts +1 -1
  420. package/src/sdk/models/shared/crimecatalogentry.ts +5 -6
  421. package/src/sdk/models/shared/crimecatalogperiodsbycountry.ts +1 -1
  422. package/src/sdk/models/shared/crimeconfidenceinterval.ts +1 -1
  423. package/src/sdk/models/shared/crimeincident.ts +10 -5
  424. package/src/sdk/models/shared/crimeincidentslistresponse.ts +1 -1
  425. package/src/sdk/models/shared/crimeincidentssummary.ts +1 -1
  426. package/src/sdk/models/shared/crimeperioddetails.ts +16 -1
  427. package/src/sdk/models/shared/geographyarea.ts +59 -0
  428. package/src/sdk/models/shared/geographycategorymetric.ts +55 -10
  429. package/src/sdk/models/shared/geographymetricsrow.ts +39 -4
  430. package/src/sdk/models/shared/geographyrelatedarea.ts +69 -0
  431. package/src/sdk/models/shared/geographytimeseriespoint.ts +10 -5
  432. package/src/sdk/models/shared/heritagedesignationfeature.ts +1 -1
  433. package/src/sdk/models/shared/index.ts +5 -0
  434. package/src/sdk/models/shared/landconstraintdesignationfeature.ts +1 -1
  435. package/src/sdk/models/shared/listing.ts +4 -4
  436. package/src/sdk/models/shared/titledeedapplication.ts +124 -0
  437. package/src/sdk/models/shared/titledeedapplicationlistresponse.ts +64 -0
  438. package/src/sdk/models/shared/titledeedavailabilityresponse.ts +162 -0
  439. package/src/sdk/safety.ts +3 -3
  440. package/src/sdk/sdk.ts +6 -0
  441. package/src/sdk/titledeeds.ts +36 -0
@@ -593,9 +593,9 @@ export type GetListingBySourceResponseBody = {
593
593
  */
594
594
  provider: string;
595
595
  /**
596
- * When the listing was first published by the source, as an ISO 8601 timestamp. It does not change when the listing is later updated.
596
+ * When the listing was first published by the source, as an ISO 8601 timestamp. It does not change when the listing is later updated, and is null when the source does not publish one.
597
597
  */
598
- publishedDate: Date;
598
+ publishedDate?: Date | null | undefined;
599
599
  /**
600
600
  * Number of reception rooms advertised, meaning the living, dining and sitting rooms. Null when the listing does not state one.
601
601
  */
@@ -1042,9 +1042,9 @@ export const GetListingBySourceResponseBody$inboundSchema: z.ZodType<
1042
1042
  ).optional(),
1043
1043
  propertyType: z.string(),
1044
1044
  provider: z.string(),
1045
- publishedDate: z.string().datetime({ offset: true }).transform(v =>
1046
- new Date(v)
1047
- ),
1045
+ publishedDate: z.nullable(
1046
+ z.string().datetime({ offset: true }).transform(v => new Date(v)),
1047
+ ).optional(),
1048
1048
  receptions: z.nullable(z.number()).optional(),
1049
1049
  removedDate: z.nullable(
1050
1050
  z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -580,9 +580,9 @@ export type GetListingsByLocationData = {
580
580
  */
581
581
  provider: string;
582
582
  /**
583
- * When the listing was first published by the source, as an ISO 8601 timestamp. It does not change when the listing is later updated.
583
+ * When the listing was first published by the source, as an ISO 8601 timestamp. It does not change when the listing is later updated, and is null when the source does not publish one.
584
584
  */
585
- publishedDate: Date;
585
+ publishedDate?: Date | null | undefined;
586
586
  /**
587
587
  * Number of reception rooms advertised, meaning the living, dining and sitting rooms. Null when the listing does not state one.
588
588
  */
@@ -1072,9 +1072,9 @@ export const GetListingsByLocationData$inboundSchema: z.ZodType<
1072
1072
  ).optional(),
1073
1073
  propertyType: z.string(),
1074
1074
  provider: z.string(),
1075
- publishedDate: z.string().datetime({ offset: true }).transform(v =>
1076
- new Date(v)
1077
- ),
1075
+ publishedDate: z.nullable(
1076
+ z.string().datetime({ offset: true }).transform(v => new Date(v)),
1077
+ ).optional(),
1078
1078
  receptions: z.nullable(z.number()).optional(),
1079
1079
  removedDate: z.nullable(
1080
1080
  z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -0,0 +1,38 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+
7
+ export type GetV1TitleDeedsTitleNumberApplicationsRequest = {
8
+ /**
9
+ * HM Land Registry title number: up to three letters followed by one to six digits. Case is not significant and the value is upper-cased; older titles may be digits only.
10
+ */
11
+ titleNumber: string;
12
+ };
13
+
14
+ /** @internal */
15
+ export type GetV1TitleDeedsTitleNumberApplicationsRequest$Outbound = {
16
+ titleNumber: string;
17
+ };
18
+
19
+ /** @internal */
20
+ export const GetV1TitleDeedsTitleNumberApplicationsRequest$outboundSchema:
21
+ z.ZodType<
22
+ GetV1TitleDeedsTitleNumberApplicationsRequest$Outbound,
23
+ z.ZodTypeDef,
24
+ GetV1TitleDeedsTitleNumberApplicationsRequest
25
+ > = z.object({
26
+ titleNumber: z.string(),
27
+ });
28
+
29
+ export function getV1TitleDeedsTitleNumberApplicationsRequestToJSON(
30
+ getV1TitleDeedsTitleNumberApplicationsRequest:
31
+ GetV1TitleDeedsTitleNumberApplicationsRequest,
32
+ ): string {
33
+ return JSON.stringify(
34
+ GetV1TitleDeedsTitleNumberApplicationsRequest$outboundSchema.parse(
35
+ getV1TitleDeedsTitleNumberApplicationsRequest,
36
+ ),
37
+ );
38
+ }
@@ -0,0 +1,38 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+
7
+ export type GetV1TitleDeedsTitleNumberAvailabilityRequest = {
8
+ /**
9
+ * HM Land Registry title number: up to three letters followed by one to six digits. Case is not significant and the value is upper-cased; older titles may be digits only.
10
+ */
11
+ titleNumber: string;
12
+ };
13
+
14
+ /** @internal */
15
+ export type GetV1TitleDeedsTitleNumberAvailabilityRequest$Outbound = {
16
+ titleNumber: string;
17
+ };
18
+
19
+ /** @internal */
20
+ export const GetV1TitleDeedsTitleNumberAvailabilityRequest$outboundSchema:
21
+ z.ZodType<
22
+ GetV1TitleDeedsTitleNumberAvailabilityRequest$Outbound,
23
+ z.ZodTypeDef,
24
+ GetV1TitleDeedsTitleNumberAvailabilityRequest
25
+ > = z.object({
26
+ titleNumber: z.string(),
27
+ });
28
+
29
+ export function getV1TitleDeedsTitleNumberAvailabilityRequestToJSON(
30
+ getV1TitleDeedsTitleNumberAvailabilityRequest:
31
+ GetV1TitleDeedsTitleNumberAvailabilityRequest,
32
+ ): string {
33
+ return JSON.stringify(
34
+ GetV1TitleDeedsTitleNumberAvailabilityRequest$outboundSchema.parse(
35
+ getV1TitleDeedsTitleNumberAvailabilityRequest,
36
+ ),
37
+ );
38
+ }
@@ -49,7 +49,13 @@ export * from "./getepcbylocationid.js";
49
49
  export * from "./getepchealth.js";
50
50
  export * from "./getframework.js";
51
51
  export * from "./getgeographicmetricaggregation.js";
52
+ export * from "./getgeographyancestors.js";
53
+ export * from "./getgeographyareas.js";
54
+ export * from "./getgeographychildren.js";
55
+ export * from "./getgeographydescendants.js";
52
56
  export * from "./getgeographymetrics.js";
57
+ export * from "./getgeographyprovenance.js";
58
+ export * from "./getgeographyrelease.js";
53
59
  export * from "./getheritagedesignation.js";
54
60
  export * from "./getlandconstraintdesignation.js";
55
61
  export * from "./getlistingbyid.js";
@@ -86,6 +92,8 @@ export * from "./getsubstationdfes.js";
86
92
  export * from "./gettransactionbyid.js";
87
93
  export * from "./gettransactionsbyuprn.js";
88
94
  export * from "./getv1titledeedstitlenumber.js";
95
+ export * from "./getv1titledeedstitlenumberapplications.js";
96
+ export * from "./getv1titledeedstitlenumberavailability.js";
89
97
  export * from "./getv1titledeedstitlenumberdocuments.js";
90
98
  export * from "./getv1titledeedstitlenumberdocumentsdocumenttype.js";
91
99
  export * from "./getv1titledeedstitlenumberpurchasestatus.js";
@@ -614,9 +614,9 @@ export type QueryListingsData = {
614
614
  */
615
615
  provider: string;
616
616
  /**
617
- * When the listing was first published by the source, as an ISO 8601 timestamp. It does not change when the listing is later updated.
617
+ * When the listing was first published by the source, as an ISO 8601 timestamp. It does not change when the listing is later updated, and is null when the source does not publish one.
618
618
  */
619
- publishedDate: Date;
619
+ publishedDate?: Date | null | undefined;
620
620
  /**
621
621
  * Number of reception rooms advertised, meaning the living, dining and sitting rooms. Null when the listing does not state one.
622
622
  */
@@ -1107,9 +1107,9 @@ export const QueryListingsData$inboundSchema: z.ZodType<
1107
1107
  .optional(),
1108
1108
  propertyType: z.string(),
1109
1109
  provider: z.string(),
1110
- publishedDate: z.string().datetime({ offset: true }).transform(v =>
1111
- new Date(v)
1112
- ),
1110
+ publishedDate: z.nullable(
1111
+ z.string().datetime({ offset: true }).transform(v => new Date(v)),
1112
+ ).optional(),
1113
1113
  receptions: z.nullable(z.number()).optional(),
1114
1114
  removedDate: z.nullable(
1115
1115
  z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -569,9 +569,9 @@ export type QueryListingsBySourceData = {
569
569
  */
570
570
  provider: string;
571
571
  /**
572
- * When the listing was first published by the source, as an ISO 8601 timestamp. It does not change when the listing is later updated.
572
+ * When the listing was first published by the source, as an ISO 8601 timestamp. It does not change when the listing is later updated, and is null when the source does not publish one.
573
573
  */
574
- publishedDate: Date;
574
+ publishedDate?: Date | null | undefined;
575
575
  /**
576
576
  * Number of reception rooms advertised, meaning the living, dining and sitting rooms. Null when the listing does not state one.
577
577
  */
@@ -1056,9 +1056,9 @@ export const QueryListingsBySourceData$inboundSchema: z.ZodType<
1056
1056
  ).optional(),
1057
1057
  propertyType: z.string(),
1058
1058
  provider: z.string(),
1059
- publishedDate: z.string().datetime({ offset: true }).transform(v =>
1060
- new Date(v)
1061
- ),
1059
+ publishedDate: z.nullable(
1060
+ z.string().datetime({ offset: true }).transform(v => new Date(v)),
1061
+ ).optional(),
1062
1062
  receptions: z.nullable(z.number()).optional(),
1063
1063
  removedDate: z.nullable(
1064
1064
  z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -246,9 +246,9 @@ export type AdvancedListing = {
246
246
  */
247
247
  provider?: string | undefined;
248
248
  /**
249
- * When the listing was first published by the source, as an ISO 8601 timestamp.
249
+ * When the listing was first published by the source, as an ISO 8601 timestamp. Null when the source does not publish one.
250
250
  */
251
- publishedDate?: Date | undefined;
251
+ publishedDate?: Date | null | undefined;
252
252
  /**
253
253
  * When the listing was removed from the source, as an ISO 8601 timestamp. Null while the listing is still there.
254
254
  */
@@ -416,8 +416,8 @@ export const AdvancedListing$inboundSchema: z.ZodType<
416
416
  pricing: AdvancedListingPricing$inboundSchema.optional(),
417
417
  propertyId: z.nullable(z.string()).optional(),
418
418
  provider: z.string().optional(),
419
- publishedDate: z.string().datetime({ offset: true }).transform(v =>
420
- new Date(v)
419
+ publishedDate: z.nullable(
420
+ z.string().datetime({ offset: true }).transform(v => new Date(v)),
421
421
  ).optional(),
422
422
  removedDate: z.nullable(
423
423
  z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -84,7 +84,7 @@ export type ConservationDesignationFeature = {
84
84
  licence: string | null;
85
85
  localAuthority?: string | null | undefined;
86
86
  /**
87
- * Extra detail the custodian publishes, narrowed to a fixed set of keys that varies by `designationType`: `status`, `legal_regime`, `woodland_composition`, `native_pct`, `canopy_pct`, `dominant_habitat`, `maturity`, `parish`, `geographic_location` and `stat_area_km2`. Only the keys the source actually carries appear. Requires the `designationSourceData` permission on the licence.
87
+ * Extra detail the custodian publishes, narrowed to `status`, `legal_regime`, `woodland_composition`, `native_pct`, `canopy_pct`, `dominant_habitat`, `maturity`, `parish`, `geographic_location` and `stat_area_km2`. Only the keys the source actually carries appear. Requires the `designationSourceData` permission on the licence.
88
88
  */
89
89
  metadata?: { [k: string]: any } | undefined;
90
90
  name?: string | null | undefined;
@@ -10,25 +10,24 @@ import { Result as SafeParseResult } from "../../types/fp.js";
10
10
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
11
 
12
12
  /**
13
- * Granularity of `period`.
13
+ * Granularity of `period`. Only monthly periods are published today.
14
14
  */
15
15
  export const PeriodType = {
16
16
  Monthly: "monthly",
17
- Quarterly: "quarterly",
18
17
  Yearly: "yearly",
19
18
  } as const;
20
19
  /**
21
- * Granularity of `period`.
20
+ * Granularity of `period`. Only monthly periods are published today.
22
21
  */
23
22
  export type PeriodType = OpenEnum<typeof PeriodType>;
24
23
 
25
24
  export type CrimeCatalogEntry = {
26
25
  /**
27
- * Country the entry covers.
26
+ * Country the entry covers: `england` or `wales`.
28
27
  */
29
28
  country: string;
30
29
  /**
31
- * True when this period has been ingested and can be queried.
30
+ * True when this period has been published and can be queried.
32
31
  */
33
32
  isAvailable: boolean;
34
33
  /**
@@ -36,7 +35,7 @@ export type CrimeCatalogEntry = {
36
35
  */
37
36
  period: string;
38
37
  /**
39
- * Granularity of `period`.
38
+ * Granularity of `period`. Only monthly periods are published today.
40
39
  */
41
40
  periodType: PeriodType;
42
41
  };
@@ -13,7 +13,7 @@ export type CrimeCatalogPeriodsByCountry = {
13
13
  */
14
14
  monthly: Array<string>;
15
15
  /**
16
- * Yearly periods (`YYYY`) held for the country, most recent first.
16
+ * Yearly periods (`YYYY`) held for the country, most recent first. Empty today.
17
17
  */
18
18
  yearly: Array<string>;
19
19
  };
@@ -8,7 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
8
8
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
9
 
10
10
  /**
11
- * Interval around `crimeScore`. Null when areas are merged and when no interval was computed.
11
+ * 95% confidence interval around `crimeScore`, reflecting sampling only. Null when areas are merged and when no interval was computed.
12
12
  */
13
13
  export type CrimeConfidenceInterval = {
14
14
  /**
@@ -17,23 +17,27 @@ export type CrimeIncident = {
17
17
  */
18
18
  coordinates: Array<number | null> | null;
19
19
  /**
20
- * When the incident was recorded, as an ISO 8601 timestamp.
20
+ * Month the incident was recorded in, as an ISO 8601 timestamp on the first day of that month. The source publishes incidents by month, not by day.
21
21
  */
22
22
  crimeDate: string;
23
23
  /**
24
- * Identifier issued for the incident by the police data source. Null on older records, which were published without one.
24
+ * Identifier issued for the incident by the police data source. Null for anti-social behaviour, which is published without one.
25
25
  */
26
26
  crimeId: string | null;
27
27
  /**
28
- * Location label as published by the data source. It names a street or landmark near the anonymised map point rather than the address the incident happened at.
28
+ * Location label for the incident. The current data source publishes no location text, so this is null; use `coordinates` to place the incident.
29
29
  */
30
30
  crimeLocation: string | null;
31
31
  /**
32
- * Human-readable name for the crime category. Null when the source published none.
32
+ * Human-readable name for the crime category.
33
33
  */
34
34
  label: string | null;
35
35
  /**
36
- * Police force that recorded the incident.
36
+ * Last recorded outcome for the incident, as published by the police data source. Null for anti-social behaviour and for incidents with no outcome yet.
37
+ */
38
+ outcome: string | null;
39
+ /**
40
+ * Identifier of the police force that recorded the incident, in lower-case hyphenated form.
37
41
  */
38
42
  reportedBy: string | null;
39
43
  };
@@ -50,6 +54,7 @@ export const CrimeIncident$inboundSchema: z.ZodType<
50
54
  crimeId: z.nullable(z.string()),
51
55
  crimeLocation: z.nullable(z.string()),
52
56
  label: z.nullable(z.string()),
57
+ outcome: z.nullable(z.string()),
53
58
  reportedBy: z.nullable(z.string()),
54
59
  });
55
60
 
@@ -29,7 +29,7 @@ export type CrimeIncidentsListResponseObject = ClosedEnum<
29
29
 
30
30
  export type CrimeIncidentsListResponse = {
31
31
  /**
32
- * The crime incidents inside the requested radius and date window, most recent first.
32
+ * The crime incidents inside the requested radius and date window, most recent month first.
33
33
  */
34
34
  data: Array<CrimeIncident>;
35
35
  /**
@@ -13,7 +13,7 @@ export type CrimeIncidentsSummary = {
13
13
  */
14
14
  byCategory: { [k: string]: number };
15
15
  /**
16
- * Anchor month for the window, in `YYYY-MM` form. When the request supplies `date` this is that month; otherwise it is the most recent month with significant reporting in the area.
16
+ * Anchor month for the window, in `YYYY-MM` form. When the request supplies `date` this is that month, or the most recent month with significant reporting in the area if that is earlier; otherwise it is the most recent month with significant reporting in the area.
17
17
  */
18
18
  period: string;
19
19
  /**
@@ -11,13 +11,25 @@ import { Result as SafeParseResult } from "../../types/fp.js";
11
11
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
12
12
 
13
13
  /**
14
- * Window length and sample size behind this category's score. Null when areas are merged.
14
+ * The trailing window behind this category's numbers. Null when areas are merged.
15
15
  */
16
16
  export type CrimePeriodDetails = {
17
+ /**
18
+ * How many months of the window had usable data. Null when not known.
19
+ */
20
+ coveredPeriods: number | null;
21
+ /**
22
+ * Last month of the window, in `YYYY-MM` form.
23
+ */
24
+ end: string;
17
25
  /**
18
26
  * Number of incidents in the analysis window.
19
27
  */
20
28
  sampleSize: number;
29
+ /**
30
+ * First month of the window, in `YYYY-MM` form.
31
+ */
32
+ start: string;
21
33
  /**
22
34
  * Length of the analysis window, in months.
23
35
  */
@@ -32,7 +44,10 @@ export const CrimePeriodDetails$inboundSchema: z.ZodType<
32
44
  unknown
33
45
  > = collectExtraKeys$(
34
46
  z.object({
47
+ coveredPeriods: z.nullable(z.number()),
48
+ end: z.string(),
35
49
  sampleSize: z.number(),
50
+ start: z.string(),
36
51
  windowMonths: z.number(),
37
52
  }).catchall(z.any()),
38
53
  "additionalProperties",
@@ -0,0 +1,59 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type GeographyArea = {
11
+ /**
12
+ * The layer as its publisher names it — `lsoa`, `sct_dz`, `nir_dz`. Never carries a vintage.
13
+ */
14
+ areaType: string;
15
+ /**
16
+ * The GSS code, e.g. `E01000001`.
17
+ */
18
+ code: string;
19
+ /**
20
+ * Publisher name. Null where none is published — ONS issues no names for Output Areas — and never unique, so never key on it.
21
+ */
22
+ name: string | null;
23
+ /**
24
+ * `ENG` | `WAL` | `SCO` | `NIR`, or null for a genuinely cross-border area.
25
+ */
26
+ nation: string | null;
27
+ /**
28
+ * Cross-nation tier: `small_area` is an LSOA in England and Wales and a Data Zone in Scotland and Northern Ireland.
29
+ */
30
+ tier: string | null;
31
+ /**
32
+ * The layer edition, e.g. `2021`.
33
+ */
34
+ vintage: string | null;
35
+ };
36
+
37
+ /** @internal */
38
+ export const GeographyArea$inboundSchema: z.ZodType<
39
+ GeographyArea,
40
+ z.ZodTypeDef,
41
+ unknown
42
+ > = z.object({
43
+ areaType: z.string(),
44
+ code: z.string(),
45
+ name: z.nullable(z.string()),
46
+ nation: z.nullable(z.string()),
47
+ tier: z.nullable(z.string()),
48
+ vintage: z.nullable(z.string()),
49
+ });
50
+
51
+ export function geographyAreaFromJSON(
52
+ jsonString: string,
53
+ ): SafeParseResult<GeographyArea, SDKValidationError> {
54
+ return safeParse(
55
+ jsonString,
56
+ (x) => GeographyArea$inboundSchema.parse(JSON.parse(x)),
57
+ `Failed to parse 'GeographyArea' from JSON`,
58
+ );
59
+ }
@@ -17,45 +17,81 @@ import {
17
17
 
18
18
  export type GeographyCategoryMetric = {
19
19
  /**
20
- * Crime category this breakdown covers.
20
+ * Crime category this breakdown covers. `all` is the composite across every category.
21
21
  */
22
22
  category: string;
23
23
  /**
24
- * Interval around `crimeScore`. Null when areas are merged and when no interval was computed.
24
+ * 95% confidence interval around `crimeScore`, reflecting sampling only. Null when areas are merged and when no interval was computed.
25
25
  */
26
26
  confidenceInterval: CrimeConfidenceInterval | null;
27
27
  /**
28
- * Number of incidents in this category for the period.
28
+ * How many months of the 24-month window had usable data. Null when areas are merged.
29
+ */
30
+ coveredPeriods?: number | null | undefined;
31
+ /**
32
+ * Number of incidents in this category over the trailing 24-month window ending at the row's period. Not decayed.
29
33
  */
30
34
  crimeCount: number;
31
35
  /**
32
- * Incidents in this category per 1,000 residents.
36
+ * Incidents in this category per 1,000 residents per year over the window. 0 when the row's `dataAvailability` is `missing`.
33
37
  */
34
38
  crimeRate: number;
35
39
  /**
36
- * Safety score for this category, from 0 to 100, where higher is safer. Null when areas are merged, because scores cannot be combined across geographies, and when scoring has not run for the period.
40
+ * Safety score for this category, from 0 to 100, where higher is safer. Each category has its own scale, so scores are not comparable across categories. Null when areas are merged, because scores cannot be combined across geographies, and when the police force did not report. Never treat a null as 0.
37
41
  */
38
42
  crimeScore: number | null;
39
43
  /**
40
- * How complete the data behind this row is: `available`, `missing`, `partial`, `estimated` or `insufficient`. Rows for merged areas always report `available`.
44
+ * How complete the data behind this row is. `available` means the police force reported throughout the window. `partial` means part of the window or part of the area was not reported. `missing` means the force did not report, so counts and rates come from stray incidents recorded by a neighbouring force and must not be read as evidence of safety. `unknown` means coverage could not be determined. Read this beside every number in the row. Merged rows report `available` only when every merged area is, otherwise `partial`.
41
45
  */
42
46
  dataAvailability: string;
43
47
  /**
44
- * Machine-readable codes describing what drives this category's score. They use the same vocabulary as `CrimeMetrics.explanatoryTags`. Null when areas are merged.
48
+ * Machine-readable codes describing what drives the area's score. They use the same vocabulary as `CrimeMetrics.explanatoryTags`. Only the `all` category carries tags; other categories carry an empty list. Null when areas are merged.
45
49
  */
46
50
  explanatoryTags: Array<string> | null;
47
51
  /**
48
- * Where this category's score ranks nationally, from 0 to 100. Null when areas are merged and when the score has not been ranked.
52
+ * Lower bound of the 80% prediction interval on harm over the next 12 months.
53
+ */
54
+ harmLower?: number | null | undefined;
55
+ /**
56
+ * Expected harm per 1,000 residents per year, weighting each offence by its severity, with recent months weighted more heavily. Null when areas are merged and when the police force did not report.
57
+ */
58
+ harmRate?: number | null | undefined;
59
+ /**
60
+ * Upper bound of the 80% prediction interval on harm over the next 12 months.
61
+ */
62
+ harmUpper?: number | null | undefined;
63
+ /**
64
+ * Where this category's score ranks among areas of the same type in England and Wales for the month, from 0 to 100, where 100 is safest. Null when areas are merged and when fewer than 10 areas could be ranked. Not comparable across area types.
49
65
  */
50
66
  percentile: number | null;
51
67
  /**
52
- * Window length and sample size behind this category's score. Null when areas are merged.
68
+ * The same rank taken within the area's parent local authority. Null for local authorities and above, when areas are merged, and when fewer than 10 areas could be ranked.
69
+ */
70
+ percentileLocal?: number | null | undefined;
71
+ /**
72
+ * The trailing window behind this category's numbers. Null when areas are merged.
53
73
  */
54
74
  periodDetails: CrimePeriodDetails | null;
55
75
  /**
56
- * Direction and size of the change in this category across the window, from -1 to 1. Null when areas are merged and when the score has not been computed.
76
+ * Direction and size of the change in this category, comparing the most recent year with the year before. Positive values mean crime is falling. Null when areas are merged and when not computed.
57
77
  */
58
78
  trendFactor: number | null;
79
+ /**
80
+ * The trend in words: `improving`, `worsening`, `stable` or `unknown`. Null when areas are merged.
81
+ */
82
+ trendLabel?: string | null | undefined;
83
+ /**
84
+ * Incidents in the most recent year divided by the year before. Above 1 means crime is rising.
85
+ */
86
+ trendRatio?: number | null | undefined;
87
+ /**
88
+ * True only when `trendLabel` is `improving` or `worsening`.
89
+ */
90
+ trendSignificant?: boolean | undefined;
91
+ /**
92
+ * Statistical significance of the year-on-year change, as a z-score.
93
+ */
94
+ trendZ?: number | null | undefined;
59
95
  };
60
96
 
61
97
  /** @internal */
@@ -66,14 +102,23 @@ export const GeographyCategoryMetric$inboundSchema: z.ZodType<
66
102
  > = z.object({
67
103
  category: z.string(),
68
104
  confidenceInterval: z.nullable(CrimeConfidenceInterval$inboundSchema),
105
+ coveredPeriods: z.nullable(z.number()).optional(),
69
106
  crimeCount: z.number(),
70
107
  crimeRate: z.number(),
71
108
  crimeScore: z.nullable(z.number()),
72
109
  dataAvailability: z.string(),
73
110
  explanatoryTags: z.nullable(z.array(z.string())),
111
+ harmLower: z.nullable(z.number()).optional(),
112
+ harmRate: z.nullable(z.number()).optional(),
113
+ harmUpper: z.nullable(z.number()).optional(),
74
114
  percentile: z.nullable(z.number()),
115
+ percentileLocal: z.nullable(z.number()).optional(),
75
116
  periodDetails: z.nullable(CrimePeriodDetails$inboundSchema),
76
117
  trendFactor: z.nullable(z.number()),
118
+ trendLabel: z.nullable(z.string()).optional(),
119
+ trendRatio: z.nullable(z.number()).optional(),
120
+ trendSignificant: z.boolean().optional(),
121
+ trendZ: z.nullable(z.number()).optional(),
77
122
  });
78
123
 
79
124
  export function geographyCategoryMetricFromJSON(