@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
@@ -0,0 +1,580 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../../lib/primitives.js";
7
+ import { safeParse } from "../../../lib/schemas.js";
8
+ import * as openEnums from "../../types/enums.js";
9
+ import { OpenEnum } from "../../types/enums.js";
10
+ import { Result as SafeParseResult } from "../../types/fp.js";
11
+ import { SDKBaseError } from "./sdkbaseerror.js";
12
+ import { SDKValidationError } from "./sdkvalidationerror.js";
13
+
14
+ /**
15
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
16
+ */
17
+ export const GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Type = {
18
+ ApiError: "api_error",
19
+ InvalidRequestError: "invalid_request_error",
20
+ AuthenticationError: "authentication_error",
21
+ RateLimitError: "rate_limit_error",
22
+ } as const;
23
+ /**
24
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
25
+ */
26
+ export type GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Type =
27
+ OpenEnum<
28
+ typeof GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Type
29
+ >;
30
+
31
+ export type GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Error = {
32
+ /**
33
+ * Stable code identifying the specific failure, safe to branch on.
34
+ */
35
+ code?: string | undefined;
36
+ /**
37
+ * Link to the documentation for this error.
38
+ */
39
+ docUrl?: string | undefined;
40
+ /**
41
+ * Human-readable explanation of what went wrong.
42
+ */
43
+ message: string;
44
+ /**
45
+ * Name of the request parameter at fault, where the failure can be traced to one.
46
+ */
47
+ param?: string | undefined;
48
+ /**
49
+ * Alternative values worth retrying when the supplied one could not be matched.
50
+ */
51
+ suggestions?: Array<string> | undefined;
52
+ /**
53
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
54
+ */
55
+ type: GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Type;
56
+ };
57
+
58
+ /**
59
+ * Returned in place of the normal payload whenever a request fails.
60
+ */
61
+ export type GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ResponseBodyData =
62
+ {
63
+ error: GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Error;
64
+ };
65
+
66
+ /**
67
+ * Returned in place of the normal payload whenever a request fails.
68
+ */
69
+ export class GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ResponseBody
70
+ extends SDKBaseError
71
+ {
72
+ error: GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Error;
73
+
74
+ /** The original data that was passed to this error instance. */
75
+ data$:
76
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ResponseBodyData;
77
+
78
+ constructor(
79
+ err:
80
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ResponseBodyData,
81
+ httpMeta: { response: Response; request: Request; body: string },
82
+ ) {
83
+ const message = err.error?.message
84
+ || `API error occurred: ${JSON.stringify(err)}`;
85
+ super(message, httpMeta);
86
+ this.data$ = err;
87
+ this.error = err.error;
88
+
89
+ this.name =
90
+ "GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ResponseBody";
91
+ }
92
+ }
93
+
94
+ /**
95
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
96
+ */
97
+ export const GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseType = {
98
+ ApiError: "api_error",
99
+ InvalidRequestError: "invalid_request_error",
100
+ AuthenticationError: "authentication_error",
101
+ RateLimitError: "rate_limit_error",
102
+ } as const;
103
+ /**
104
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
105
+ */
106
+ export type GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseType =
107
+ OpenEnum<typeof GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseType>;
108
+
109
+ export type GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseError = {
110
+ /**
111
+ * Stable code identifying the specific failure, safe to branch on.
112
+ */
113
+ code?: string | undefined;
114
+ /**
115
+ * Link to the documentation for this error.
116
+ */
117
+ docUrl?: string | undefined;
118
+ /**
119
+ * Human-readable explanation of what went wrong.
120
+ */
121
+ message: string;
122
+ /**
123
+ * Name of the request parameter at fault, where the failure can be traced to one.
124
+ */
125
+ param?: string | undefined;
126
+ /**
127
+ * Alternative values worth retrying when the supplied one could not be matched.
128
+ */
129
+ suggestions?: Array<string> | undefined;
130
+ /**
131
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
132
+ */
133
+ type: GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseType;
134
+ };
135
+
136
+ /**
137
+ * Returned in place of the normal payload whenever a request fails.
138
+ */
139
+ export type GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseResponseBodyData =
140
+ {
141
+ error: GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseError;
142
+ };
143
+
144
+ /**
145
+ * Returned in place of the normal payload whenever a request fails.
146
+ */
147
+ export class GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseResponseBody
148
+ extends SDKBaseError
149
+ {
150
+ error: GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseError;
151
+
152
+ /** The original data that was passed to this error instance. */
153
+ data$:
154
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseResponseBodyData;
155
+
156
+ constructor(
157
+ err:
158
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseResponseBodyData,
159
+ httpMeta: { response: Response; request: Request; body: string },
160
+ ) {
161
+ const message = err.error?.message
162
+ || `API error occurred: ${JSON.stringify(err)}`;
163
+ super(message, httpMeta);
164
+ this.data$ = err;
165
+ this.error = err.error;
166
+
167
+ this.name =
168
+ "GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseResponseBody";
169
+ }
170
+ }
171
+
172
+ /**
173
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
174
+ */
175
+ export const GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsType = {
176
+ ApiError: "api_error",
177
+ InvalidRequestError: "invalid_request_error",
178
+ AuthenticationError: "authentication_error",
179
+ RateLimitError: "rate_limit_error",
180
+ } as const;
181
+ /**
182
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
183
+ */
184
+ export type GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsType = OpenEnum<
185
+ typeof GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsType
186
+ >;
187
+
188
+ export type GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsError = {
189
+ /**
190
+ * Stable code identifying the specific failure, safe to branch on.
191
+ */
192
+ code?: string | undefined;
193
+ /**
194
+ * Link to the documentation for this error.
195
+ */
196
+ docUrl?: string | undefined;
197
+ /**
198
+ * Human-readable explanation of what went wrong.
199
+ */
200
+ message: string;
201
+ /**
202
+ * Name of the request parameter at fault, where the failure can be traced to one.
203
+ */
204
+ param?: string | undefined;
205
+ /**
206
+ * Alternative values worth retrying when the supplied one could not be matched.
207
+ */
208
+ suggestions?: Array<string> | undefined;
209
+ /**
210
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
211
+ */
212
+ type: GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsType;
213
+ };
214
+
215
+ /**
216
+ * Returned in place of the normal payload whenever a request fails.
217
+ */
218
+ export type GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseBodyData = {
219
+ error: GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsError;
220
+ };
221
+
222
+ /**
223
+ * Returned in place of the normal payload whenever a request fails.
224
+ */
225
+ export class GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseBody
226
+ extends SDKBaseError
227
+ {
228
+ error: GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsError;
229
+
230
+ /** The original data that was passed to this error instance. */
231
+ data$: GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseBodyData;
232
+
233
+ constructor(
234
+ err: GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseBodyData,
235
+ httpMeta: { response: Response; request: Request; body: string },
236
+ ) {
237
+ const message = err.error?.message
238
+ || `API error occurred: ${JSON.stringify(err)}`;
239
+ super(message, httpMeta);
240
+ this.data$ = err;
241
+ this.error = err.error;
242
+
243
+ this.name = "GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseBody";
244
+ }
245
+ }
246
+
247
+ /**
248
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
249
+ */
250
+ export const GetV1TitleDeedsTitleNumberAvailabilityType = {
251
+ ApiError: "api_error",
252
+ InvalidRequestError: "invalid_request_error",
253
+ AuthenticationError: "authentication_error",
254
+ RateLimitError: "rate_limit_error",
255
+ } as const;
256
+ /**
257
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
258
+ */
259
+ export type GetV1TitleDeedsTitleNumberAvailabilityType = OpenEnum<
260
+ typeof GetV1TitleDeedsTitleNumberAvailabilityType
261
+ >;
262
+
263
+ export type GetV1TitleDeedsTitleNumberAvailabilityError = {
264
+ /**
265
+ * Stable code identifying the specific failure, safe to branch on.
266
+ */
267
+ code?: string | undefined;
268
+ /**
269
+ * Link to the documentation for this error.
270
+ */
271
+ docUrl?: string | undefined;
272
+ /**
273
+ * Human-readable explanation of what went wrong.
274
+ */
275
+ message: string;
276
+ /**
277
+ * Name of the request parameter at fault, where the failure can be traced to one.
278
+ */
279
+ param?: string | undefined;
280
+ /**
281
+ * Alternative values worth retrying when the supplied one could not be matched.
282
+ */
283
+ suggestions?: Array<string> | undefined;
284
+ /**
285
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
286
+ */
287
+ type: GetV1TitleDeedsTitleNumberAvailabilityType;
288
+ };
289
+
290
+ /**
291
+ * Returned in place of the normal payload whenever a request fails.
292
+ */
293
+ export type GetV1TitleDeedsTitleNumberAvailabilityResponseBodyData = {
294
+ error: GetV1TitleDeedsTitleNumberAvailabilityError;
295
+ };
296
+
297
+ /**
298
+ * Returned in place of the normal payload whenever a request fails.
299
+ */
300
+ export class GetV1TitleDeedsTitleNumberAvailabilityResponseBody
301
+ extends SDKBaseError
302
+ {
303
+ error: GetV1TitleDeedsTitleNumberAvailabilityError;
304
+
305
+ /** The original data that was passed to this error instance. */
306
+ data$: GetV1TitleDeedsTitleNumberAvailabilityResponseBodyData;
307
+
308
+ constructor(
309
+ err: GetV1TitleDeedsTitleNumberAvailabilityResponseBodyData,
310
+ httpMeta: { response: Response; request: Request; body: string },
311
+ ) {
312
+ const message = err.error?.message
313
+ || `API error occurred: ${JSON.stringify(err)}`;
314
+ super(message, httpMeta);
315
+ this.data$ = err;
316
+ this.error = err.error;
317
+
318
+ this.name = "GetV1TitleDeedsTitleNumberAvailabilityResponseBody";
319
+ }
320
+ }
321
+
322
+ /** @internal */
323
+ export const GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Type$inboundSchema:
324
+ z.ZodType<
325
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Type,
326
+ z.ZodTypeDef,
327
+ unknown
328
+ > = openEnums.inboundSchema(
329
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Type,
330
+ );
331
+
332
+ /** @internal */
333
+ export const GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Error$inboundSchema:
334
+ z.ZodType<
335
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Error,
336
+ z.ZodTypeDef,
337
+ unknown
338
+ > = z.object({
339
+ code: z.string().optional(),
340
+ doc_url: z.string().optional(),
341
+ message: z.string(),
342
+ param: z.string().optional(),
343
+ suggestions: z.array(z.string()).optional(),
344
+ type:
345
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Type$inboundSchema,
346
+ }).transform((v) => {
347
+ return remap$(v, {
348
+ "doc_url": "docUrl",
349
+ });
350
+ });
351
+
352
+ export function getV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ErrorFromJSON(
353
+ jsonString: string,
354
+ ): SafeParseResult<
355
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Error,
356
+ SDKValidationError
357
+ > {
358
+ return safeParse(
359
+ jsonString,
360
+ (x) =>
361
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Error$inboundSchema
362
+ .parse(JSON.parse(x)),
363
+ `Failed to parse 'GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Error' from JSON`,
364
+ );
365
+ }
366
+
367
+ /** @internal */
368
+ export const GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ResponseBody$inboundSchema:
369
+ z.ZodType<
370
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ResponseBody,
371
+ z.ZodTypeDef,
372
+ unknown
373
+ > = z.object({
374
+ error: z.lazy(() =>
375
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502Error$inboundSchema
376
+ ),
377
+ request$: z.instanceof(Request),
378
+ response$: z.instanceof(Response),
379
+ body$: z.string(),
380
+ })
381
+ .transform((v) => {
382
+ return new GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ResponseBody(
383
+ v,
384
+ { request: v.request$, response: v.response$, body: v.body$ },
385
+ );
386
+ });
387
+
388
+ /** @internal */
389
+ export const GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseType$inboundSchema:
390
+ z.ZodType<
391
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseType,
392
+ z.ZodTypeDef,
393
+ unknown
394
+ > = openEnums.inboundSchema(
395
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseType,
396
+ );
397
+
398
+ /** @internal */
399
+ export const GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseError$inboundSchema:
400
+ z.ZodType<
401
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseError,
402
+ z.ZodTypeDef,
403
+ unknown
404
+ > = z.object({
405
+ code: z.string().optional(),
406
+ doc_url: z.string().optional(),
407
+ message: z.string(),
408
+ param: z.string().optional(),
409
+ suggestions: z.array(z.string()).optional(),
410
+ type:
411
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseType$inboundSchema,
412
+ }).transform((v) => {
413
+ return remap$(v, {
414
+ "doc_url": "docUrl",
415
+ });
416
+ });
417
+
418
+ export function getV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseErrorFromJSON(
419
+ jsonString: string,
420
+ ): SafeParseResult<
421
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseError,
422
+ SDKValidationError
423
+ > {
424
+ return safeParse(
425
+ jsonString,
426
+ (x) =>
427
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseError$inboundSchema
428
+ .parse(JSON.parse(x)),
429
+ `Failed to parse 'GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseError' from JSON`,
430
+ );
431
+ }
432
+
433
+ /** @internal */
434
+ export const GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseResponseBody$inboundSchema:
435
+ z.ZodType<
436
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseResponseBody,
437
+ z.ZodTypeDef,
438
+ unknown
439
+ > = z.object({
440
+ error: z.lazy(() =>
441
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseError$inboundSchema
442
+ ),
443
+ request$: z.instanceof(Request),
444
+ response$: z.instanceof(Response),
445
+ body$: z.string(),
446
+ })
447
+ .transform((v) => {
448
+ return new GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseResponseBody(
449
+ v,
450
+ { request: v.request$, response: v.response$, body: v.body$ },
451
+ );
452
+ });
453
+
454
+ /** @internal */
455
+ export const GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsType$inboundSchema:
456
+ z.ZodType<
457
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsType,
458
+ z.ZodTypeDef,
459
+ unknown
460
+ > = openEnums.inboundSchema(
461
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsType,
462
+ );
463
+
464
+ /** @internal */
465
+ export const GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsError$inboundSchema:
466
+ z.ZodType<
467
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsError,
468
+ z.ZodTypeDef,
469
+ unknown
470
+ > = z.object({
471
+ code: z.string().optional(),
472
+ doc_url: z.string().optional(),
473
+ message: z.string(),
474
+ param: z.string().optional(),
475
+ suggestions: z.array(z.string()).optional(),
476
+ type: GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsType$inboundSchema,
477
+ }).transform((v) => {
478
+ return remap$(v, {
479
+ "doc_url": "docUrl",
480
+ });
481
+ });
482
+
483
+ export function getV1TitleDeedsTitleNumberAvailabilityTitleDeedsErrorFromJSON(
484
+ jsonString: string,
485
+ ): SafeParseResult<
486
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsError,
487
+ SDKValidationError
488
+ > {
489
+ return safeParse(
490
+ jsonString,
491
+ (x) =>
492
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsError$inboundSchema.parse(
493
+ JSON.parse(x),
494
+ ),
495
+ `Failed to parse 'GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsError' from JSON`,
496
+ );
497
+ }
498
+
499
+ /** @internal */
500
+ export const GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseBody$inboundSchema:
501
+ z.ZodType<
502
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseBody,
503
+ z.ZodTypeDef,
504
+ unknown
505
+ > = z.object({
506
+ error: z.lazy(() =>
507
+ GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsError$inboundSchema
508
+ ),
509
+ request$: z.instanceof(Request),
510
+ response$: z.instanceof(Response),
511
+ body$: z.string(),
512
+ })
513
+ .transform((v) => {
514
+ return new GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseBody(
515
+ v,
516
+ { request: v.request$, response: v.response$, body: v.body$ },
517
+ );
518
+ });
519
+
520
+ /** @internal */
521
+ export const GetV1TitleDeedsTitleNumberAvailabilityType$inboundSchema:
522
+ z.ZodType<GetV1TitleDeedsTitleNumberAvailabilityType, z.ZodTypeDef, unknown> =
523
+ openEnums.inboundSchema(GetV1TitleDeedsTitleNumberAvailabilityType);
524
+
525
+ /** @internal */
526
+ export const GetV1TitleDeedsTitleNumberAvailabilityError$inboundSchema:
527
+ z.ZodType<
528
+ GetV1TitleDeedsTitleNumberAvailabilityError,
529
+ z.ZodTypeDef,
530
+ unknown
531
+ > = z.object({
532
+ code: z.string().optional(),
533
+ doc_url: z.string().optional(),
534
+ message: z.string(),
535
+ param: z.string().optional(),
536
+ suggestions: z.array(z.string()).optional(),
537
+ type: GetV1TitleDeedsTitleNumberAvailabilityType$inboundSchema,
538
+ }).transform((v) => {
539
+ return remap$(v, {
540
+ "doc_url": "docUrl",
541
+ });
542
+ });
543
+
544
+ export function getV1TitleDeedsTitleNumberAvailabilityErrorFromJSON(
545
+ jsonString: string,
546
+ ): SafeParseResult<
547
+ GetV1TitleDeedsTitleNumberAvailabilityError,
548
+ SDKValidationError
549
+ > {
550
+ return safeParse(
551
+ jsonString,
552
+ (x) =>
553
+ GetV1TitleDeedsTitleNumberAvailabilityError$inboundSchema.parse(
554
+ JSON.parse(x),
555
+ ),
556
+ `Failed to parse 'GetV1TitleDeedsTitleNumberAvailabilityError' from JSON`,
557
+ );
558
+ }
559
+
560
+ /** @internal */
561
+ export const GetV1TitleDeedsTitleNumberAvailabilityResponseBody$inboundSchema:
562
+ z.ZodType<
563
+ GetV1TitleDeedsTitleNumberAvailabilityResponseBody,
564
+ z.ZodTypeDef,
565
+ unknown
566
+ > = z.object({
567
+ error: z.lazy(() =>
568
+ GetV1TitleDeedsTitleNumberAvailabilityError$inboundSchema
569
+ ),
570
+ request$: z.instanceof(Request),
571
+ response$: z.instanceof(Response),
572
+ body$: z.string(),
573
+ })
574
+ .transform((v) => {
575
+ return new GetV1TitleDeedsTitleNumberAvailabilityResponseBody(v, {
576
+ request: v.request$,
577
+ response: v.response$,
578
+ body: v.body$,
579
+ });
580
+ });
@@ -90,6 +90,8 @@ export * from "./getsubstationdfes.js";
90
90
  export * from "./gettransactionbyid.js";
91
91
  export * from "./gettransactionsbyuprn.js";
92
92
  export * from "./getv1titledeedstitlenumber.js";
93
+ export * from "./getv1titledeedstitlenumberapplications.js";
94
+ export * from "./getv1titledeedstitlenumberavailability.js";
93
95
  export * from "./getv1titledeedstitlenumberdocuments.js";
94
96
  export * from "./getv1titledeedstitlenumberdocumentsdocumenttype.js";
95
97
  export * from "./getv1titledeedstitlenumberpurchasestatus.js";
@@ -26,6 +26,14 @@ export type SchemasTitleDeedPurchaseNotFoundError = {
26
26
 
27
27
  export type TitleDeedPurchaseNotFoundData = {
28
28
  error: SchemasTitleDeedPurchaseNotFoundError;
29
+ /**
30
+ * Why the purchase did not complete, as a stable code, when this account was refunded. `HMLR_PURCHASE_REJECTED` with a pending-application reason means the title cannot be bought until the application completes, so retrying will fail the same way.
31
+ */
32
+ failureCode: string | null;
33
+ /**
34
+ * The refusal in the words HM Land Registry used, when one was given.
35
+ */
36
+ failureMessage: string | null;
29
37
  /**
30
38
  * What this account has been charged for the purchase, stated rather than implied. `charged` means the credits have been taken and the purchase is live, either already delivered or accepted by HM Land Registry for delivery shortly, so a platform reselling it must not refund its own customer. `not_charged` means nothing is held for this attempt, because it was never debited or has been refunded in full, so a refund downstream is safe and a retry starts clean. `unknown` means the outcome could not be established, and the purchase should be held for reconciliation rather than refunded or retried blindly. Responses whose outcome the status code already implies, such as a delivered 200, do not repeat it.
31
39
  */
@@ -38,6 +46,14 @@ export type TitleDeedPurchaseNotFoundData = {
38
46
 
39
47
  export class TitleDeedPurchaseNotFound extends SDKBaseError {
40
48
  error: SchemasTitleDeedPurchaseNotFoundError;
49
+ /**
50
+ * Why the purchase did not complete, as a stable code, when this account was refunded. `HMLR_PURCHASE_REJECTED` with a pending-application reason means the title cannot be bought until the application completes, so retrying will fail the same way.
51
+ */
52
+ failureCode: string | null;
53
+ /**
54
+ * The refusal in the words HM Land Registry used, when one was given.
55
+ */
56
+ failureMessage: string | null;
41
57
  /**
42
58
  * What this account has been charged for the purchase, stated rather than implied. `charged` means the credits have been taken and the purchase is live, either already delivered or accepted by HM Land Registry for delivery shortly, so a platform reselling it must not refund its own customer. `not_charged` means nothing is held for this attempt, because it was never debited or has been refunded in full, so a refund downstream is safe and a retry starts clean. `unknown` means the outcome could not be established, and the purchase should be held for reconciliation rather than refunded or retried blindly. Responses whose outcome the status code already implies, such as a delivered 200, do not repeat it.
43
59
  */
@@ -59,6 +75,8 @@ export class TitleDeedPurchaseNotFound extends SDKBaseError {
59
75
  super(message, httpMeta);
60
76
  this.data$ = err;
61
77
  this.error = err.error;
78
+ this.failureCode = err.failureCode;
79
+ this.failureMessage = err.failureMessage;
62
80
  this.moneyState = err.moneyState;
63
81
  this.purchaseStatus = err.purchaseStatus;
64
82
 
@@ -101,6 +119,8 @@ export const TitleDeedPurchaseNotFound$inboundSchema: z.ZodType<
101
119
  unknown
102
120
  > = z.object({
103
121
  error: z.lazy(() => SchemasTitleDeedPurchaseNotFoundError$inboundSchema),
122
+ failure_code: z.nullable(z.string()),
123
+ failure_message: z.nullable(z.string()),
104
124
  money_state: shared.MoneyState$inboundSchema,
105
125
  purchase_status: shared.PurchaseStatus$inboundSchema,
106
126
  request$: z.instanceof(Request),
@@ -109,6 +129,8 @@ export const TitleDeedPurchaseNotFound$inboundSchema: z.ZodType<
109
129
  })
110
130
  .transform((v) => {
111
131
  const remapped = remap$(v, {
132
+ "failure_code": "failureCode",
133
+ "failure_message": "failureMessage",
112
134
  "money_state": "moneyState",
113
135
  "purchase_status": "purchaseStatus",
114
136
  });