@vepler/sdk 5.28.1 → 6.0.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 (378) 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/getv1titledeedstitlenumberapplications.d.ts +15 -0
  90. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberapplications.d.ts.map +1 -0
  91. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberapplications.js +49 -0
  92. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberapplications.js.map +1 -0
  93. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberavailability.d.ts +15 -0
  94. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberavailability.d.ts.map +1 -0
  95. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberavailability.js +49 -0
  96. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberavailability.js.map +1 -0
  97. package/dist/commonjs/sdk/models/operations/index.d.ts +8 -0
  98. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  99. package/dist/commonjs/sdk/models/operations/index.js +8 -0
  100. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  101. package/dist/commonjs/sdk/models/shared/conservationdesignationfeature.d.ts +1 -1
  102. package/dist/commonjs/sdk/models/shared/crimecatalogentry.d.ts +5 -6
  103. package/dist/commonjs/sdk/models/shared/crimecatalogentry.d.ts.map +1 -1
  104. package/dist/commonjs/sdk/models/shared/crimecatalogentry.js +1 -2
  105. package/dist/commonjs/sdk/models/shared/crimecatalogentry.js.map +1 -1
  106. package/dist/commonjs/sdk/models/shared/crimecatalogperiodsbycountry.d.ts +1 -1
  107. package/dist/commonjs/sdk/models/shared/crimeconfidenceinterval.d.ts +1 -1
  108. package/dist/commonjs/sdk/models/shared/crimeincident.d.ts +9 -5
  109. package/dist/commonjs/sdk/models/shared/crimeincident.d.ts.map +1 -1
  110. package/dist/commonjs/sdk/models/shared/crimeincident.js +1 -0
  111. package/dist/commonjs/sdk/models/shared/crimeincident.js.map +1 -1
  112. package/dist/commonjs/sdk/models/shared/crimeincidentslistresponse.d.ts +1 -1
  113. package/dist/commonjs/sdk/models/shared/crimeincidentssummary.d.ts +1 -1
  114. package/dist/commonjs/sdk/models/shared/crimeperioddetails.d.ts +13 -1
  115. package/dist/commonjs/sdk/models/shared/crimeperioddetails.d.ts.map +1 -1
  116. package/dist/commonjs/sdk/models/shared/crimeperioddetails.js +3 -0
  117. package/dist/commonjs/sdk/models/shared/crimeperioddetails.js.map +1 -1
  118. package/dist/commonjs/sdk/models/shared/geographyarea.d.ts +33 -0
  119. package/dist/commonjs/sdk/models/shared/geographyarea.d.ts.map +1 -0
  120. package/dist/commonjs/sdk/models/shared/geographyarea.js +55 -0
  121. package/dist/commonjs/sdk/models/shared/geographyarea.js.map +1 -0
  122. package/dist/commonjs/sdk/models/shared/geographycategorymetric.d.ts +46 -10
  123. package/dist/commonjs/sdk/models/shared/geographycategorymetric.d.ts.map +1 -1
  124. package/dist/commonjs/sdk/models/shared/geographycategorymetric.js +9 -0
  125. package/dist/commonjs/sdk/models/shared/geographycategorymetric.js.map +1 -1
  126. package/dist/commonjs/sdk/models/shared/geographymetricsrow.d.ts +28 -4
  127. package/dist/commonjs/sdk/models/shared/geographymetricsrow.d.ts.map +1 -1
  128. package/dist/commonjs/sdk/models/shared/geographymetricsrow.js +6 -0
  129. package/dist/commonjs/sdk/models/shared/geographymetricsrow.js.map +1 -1
  130. package/dist/commonjs/sdk/models/shared/geographyrelatedarea.d.ts +41 -0
  131. package/dist/commonjs/sdk/models/shared/geographyrelatedarea.d.ts.map +1 -0
  132. package/dist/commonjs/sdk/models/shared/geographyrelatedarea.js +57 -0
  133. package/dist/commonjs/sdk/models/shared/geographyrelatedarea.js.map +1 -0
  134. package/dist/commonjs/sdk/models/shared/geographytimeseriespoint.d.ts +9 -5
  135. package/dist/commonjs/sdk/models/shared/geographytimeseriespoint.d.ts.map +1 -1
  136. package/dist/commonjs/sdk/models/shared/geographytimeseriespoint.js +1 -0
  137. package/dist/commonjs/sdk/models/shared/geographytimeseriespoint.js.map +1 -1
  138. package/dist/commonjs/sdk/models/shared/heritagedesignationfeature.d.ts +1 -1
  139. package/dist/commonjs/sdk/models/shared/index.d.ts +5 -0
  140. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  141. package/dist/commonjs/sdk/models/shared/index.js +5 -0
  142. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  143. package/dist/commonjs/sdk/models/shared/landconstraintdesignationfeature.d.ts +1 -1
  144. package/dist/commonjs/sdk/models/shared/titledeedapplication.d.ts +69 -0
  145. package/dist/commonjs/sdk/models/shared/titledeedapplication.d.ts.map +1 -0
  146. package/dist/commonjs/sdk/models/shared/titledeedapplication.js +84 -0
  147. package/dist/commonjs/sdk/models/shared/titledeedapplication.js.map +1 -0
  148. package/dist/commonjs/sdk/models/shared/titledeedapplicationlistresponse.d.ts +24 -0
  149. package/dist/commonjs/sdk/models/shared/titledeedapplicationlistresponse.d.ts.map +1 -0
  150. package/dist/commonjs/sdk/models/shared/titledeedapplicationlistresponse.js +65 -0
  151. package/dist/commonjs/sdk/models/shared/titledeedapplicationlistresponse.js.map +1 -0
  152. package/dist/commonjs/sdk/models/shared/titledeedavailabilityresponse.d.ts +67 -0
  153. package/dist/commonjs/sdk/models/shared/titledeedavailabilityresponse.d.ts.map +1 -0
  154. package/dist/commonjs/sdk/models/shared/titledeedavailabilityresponse.js +108 -0
  155. package/dist/commonjs/sdk/models/shared/titledeedavailabilityresponse.js.map +1 -0
  156. package/dist/commonjs/sdk/safety.d.ts +3 -3
  157. package/dist/commonjs/sdk/safety.js +3 -3
  158. package/dist/commonjs/sdk/sdk.d.ts +3 -0
  159. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  160. package/dist/commonjs/sdk/sdk.js +4 -0
  161. package/dist/commonjs/sdk/sdk.js.map +1 -1
  162. package/dist/commonjs/sdk/titledeeds.d.ts +14 -0
  163. package/dist/commonjs/sdk/titledeeds.d.ts.map +1 -1
  164. package/dist/commonjs/sdk/titledeeds.js +20 -0
  165. package/dist/commonjs/sdk/titledeeds.js.map +1 -1
  166. package/dist/esm/funcs/geographyGetGeographyAncestors.d.ts +17 -0
  167. package/dist/esm/funcs/geographyGetGeographyAncestors.d.ts.map +1 -0
  168. package/dist/esm/funcs/geographyGetGeographyAncestors.js +90 -0
  169. package/dist/esm/funcs/geographyGetGeographyAncestors.js.map +1 -0
  170. package/dist/esm/funcs/geographyGetGeographyAreas.d.ts +17 -0
  171. package/dist/esm/funcs/geographyGetGeographyAreas.d.ts.map +1 -0
  172. package/dist/esm/funcs/geographyGetGeographyAreas.js +89 -0
  173. package/dist/esm/funcs/geographyGetGeographyAreas.js.map +1 -0
  174. package/dist/esm/funcs/geographyGetGeographyChildren.d.ts +17 -0
  175. package/dist/esm/funcs/geographyGetGeographyChildren.d.ts.map +1 -0
  176. package/dist/esm/funcs/geographyGetGeographyChildren.js +90 -0
  177. package/dist/esm/funcs/geographyGetGeographyChildren.js.map +1 -0
  178. package/dist/esm/funcs/geographyGetGeographyDescendants.d.ts +17 -0
  179. package/dist/esm/funcs/geographyGetGeographyDescendants.d.ts.map +1 -0
  180. package/dist/esm/funcs/geographyGetGeographyDescendants.js +92 -0
  181. package/dist/esm/funcs/geographyGetGeographyDescendants.js.map +1 -0
  182. package/dist/esm/funcs/geographyGetGeographyProvenance.d.ts +17 -0
  183. package/dist/esm/funcs/geographyGetGeographyProvenance.d.ts.map +1 -0
  184. package/dist/esm/funcs/geographyGetGeographyProvenance.js +89 -0
  185. package/dist/esm/funcs/geographyGetGeographyProvenance.js.map +1 -0
  186. package/dist/esm/funcs/geographyGetGeographyRelease.d.ts +17 -0
  187. package/dist/esm/funcs/geographyGetGeographyRelease.d.ts.map +1 -0
  188. package/dist/esm/funcs/geographyGetGeographyRelease.js +69 -0
  189. package/dist/esm/funcs/geographyGetGeographyRelease.js.map +1 -0
  190. package/dist/esm/funcs/safetyGetCrimeIncidents.d.ts +1 -1
  191. package/dist/esm/funcs/safetyGetCrimeIncidents.js +1 -1
  192. package/dist/esm/funcs/safetyGetGeographyMetrics.d.ts +2 -2
  193. package/dist/esm/funcs/safetyGetGeographyMetrics.js +2 -2
  194. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.d.ts +19 -0
  195. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.d.ts.map +1 -0
  196. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.js +93 -0
  197. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.js.map +1 -0
  198. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.d.ts +19 -0
  199. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.d.ts.map +1 -0
  200. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.js +93 -0
  201. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.js.map +1 -0
  202. package/dist/esm/lib/config.d.ts +3 -3
  203. package/dist/esm/lib/config.js +3 -3
  204. package/dist/esm/lib/config.js.map +1 -1
  205. package/dist/esm/lib/encodings.d.ts +10 -9
  206. package/dist/esm/lib/encodings.d.ts.map +1 -1
  207. package/dist/esm/lib/encodings.js +29 -13
  208. package/dist/esm/lib/encodings.js.map +1 -1
  209. package/dist/esm/sdk/geography.d.ts +47 -0
  210. package/dist/esm/sdk/geography.d.ts.map +1 -0
  211. package/dist/esm/sdk/geography.js +68 -0
  212. package/dist/esm/sdk/geography.js.map +1 -0
  213. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberapplications.d.ts +266 -0
  214. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberapplications.d.ts.map +1 -0
  215. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberapplications.js +217 -0
  216. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberapplications.js.map +1 -0
  217. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberavailability.d.ts +266 -0
  218. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberavailability.d.ts.map +1 -0
  219. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberavailability.js +217 -0
  220. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberavailability.js.map +1 -0
  221. package/dist/esm/sdk/models/errors/index.d.ts +2 -0
  222. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  223. package/dist/esm/sdk/models/errors/index.js +2 -0
  224. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  225. package/dist/esm/sdk/models/errors/titledeedpurchasenotfound.d.ts +16 -0
  226. package/dist/esm/sdk/models/errors/titledeedpurchasenotfound.d.ts.map +1 -1
  227. package/dist/esm/sdk/models/errors/titledeedpurchasenotfound.js +6 -0
  228. package/dist/esm/sdk/models/errors/titledeedpurchasenotfound.js.map +1 -1
  229. package/dist/esm/sdk/models/operations/getgeographyancestors.d.ts +52 -0
  230. package/dist/esm/sdk/models/operations/getgeographyancestors.d.ts.map +1 -0
  231. package/dist/esm/sdk/models/operations/getgeographyancestors.js +37 -0
  232. package/dist/esm/sdk/models/operations/getgeographyancestors.js.map +1 -0
  233. package/dist/esm/sdk/models/operations/getgeographyareas.d.ts +47 -0
  234. package/dist/esm/sdk/models/operations/getgeographyareas.d.ts.map +1 -0
  235. package/dist/esm/sdk/models/operations/getgeographyareas.js +36 -0
  236. package/dist/esm/sdk/models/operations/getgeographyareas.js.map +1 -0
  237. package/dist/esm/sdk/models/operations/getgeographychildren.d.ts +82 -0
  238. package/dist/esm/sdk/models/operations/getgeographychildren.d.ts.map +1 -0
  239. package/dist/esm/sdk/models/operations/getgeographychildren.js +50 -0
  240. package/dist/esm/sdk/models/operations/getgeographychildren.js.map +1 -0
  241. package/dist/esm/sdk/models/operations/getgeographydescendants.d.ts +62 -0
  242. package/dist/esm/sdk/models/operations/getgeographydescendants.d.ts.map +1 -0
  243. package/dist/esm/sdk/models/operations/getgeographydescendants.js +39 -0
  244. package/dist/esm/sdk/models/operations/getgeographydescendants.js.map +1 -0
  245. package/dist/esm/sdk/models/operations/getgeographyprovenance.d.ts +54 -0
  246. package/dist/esm/sdk/models/operations/getgeographyprovenance.d.ts.map +1 -0
  247. package/dist/esm/sdk/models/operations/getgeographyprovenance.js +50 -0
  248. package/dist/esm/sdk/models/operations/getgeographyprovenance.js.map +1 -0
  249. package/dist/esm/sdk/models/operations/getgeographyrelease.d.ts +19 -0
  250. package/dist/esm/sdk/models/operations/getgeographyrelease.d.ts.map +1 -0
  251. package/dist/esm/sdk/models/operations/getgeographyrelease.js +20 -0
  252. package/dist/esm/sdk/models/operations/getgeographyrelease.js.map +1 -0
  253. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberapplications.d.ts +15 -0
  254. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberapplications.d.ts.map +1 -0
  255. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberapplications.js +12 -0
  256. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberapplications.js.map +1 -0
  257. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberavailability.d.ts +15 -0
  258. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberavailability.d.ts.map +1 -0
  259. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberavailability.js +12 -0
  260. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberavailability.js.map +1 -0
  261. package/dist/esm/sdk/models/operations/index.d.ts +8 -0
  262. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  263. package/dist/esm/sdk/models/operations/index.js +8 -0
  264. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  265. package/dist/esm/sdk/models/shared/conservationdesignationfeature.d.ts +1 -1
  266. package/dist/esm/sdk/models/shared/crimecatalogentry.d.ts +5 -6
  267. package/dist/esm/sdk/models/shared/crimecatalogentry.d.ts.map +1 -1
  268. package/dist/esm/sdk/models/shared/crimecatalogentry.js +1 -2
  269. package/dist/esm/sdk/models/shared/crimecatalogentry.js.map +1 -1
  270. package/dist/esm/sdk/models/shared/crimecatalogperiodsbycountry.d.ts +1 -1
  271. package/dist/esm/sdk/models/shared/crimeconfidenceinterval.d.ts +1 -1
  272. package/dist/esm/sdk/models/shared/crimeincident.d.ts +9 -5
  273. package/dist/esm/sdk/models/shared/crimeincident.d.ts.map +1 -1
  274. package/dist/esm/sdk/models/shared/crimeincident.js +1 -0
  275. package/dist/esm/sdk/models/shared/crimeincident.js.map +1 -1
  276. package/dist/esm/sdk/models/shared/crimeincidentslistresponse.d.ts +1 -1
  277. package/dist/esm/sdk/models/shared/crimeincidentssummary.d.ts +1 -1
  278. package/dist/esm/sdk/models/shared/crimeperioddetails.d.ts +13 -1
  279. package/dist/esm/sdk/models/shared/crimeperioddetails.d.ts.map +1 -1
  280. package/dist/esm/sdk/models/shared/crimeperioddetails.js +3 -0
  281. package/dist/esm/sdk/models/shared/crimeperioddetails.js.map +1 -1
  282. package/dist/esm/sdk/models/shared/geographyarea.d.ts +33 -0
  283. package/dist/esm/sdk/models/shared/geographyarea.d.ts.map +1 -0
  284. package/dist/esm/sdk/models/shared/geographyarea.js +18 -0
  285. package/dist/esm/sdk/models/shared/geographyarea.js.map +1 -0
  286. package/dist/esm/sdk/models/shared/geographycategorymetric.d.ts +46 -10
  287. package/dist/esm/sdk/models/shared/geographycategorymetric.d.ts.map +1 -1
  288. package/dist/esm/sdk/models/shared/geographycategorymetric.js +9 -0
  289. package/dist/esm/sdk/models/shared/geographycategorymetric.js.map +1 -1
  290. package/dist/esm/sdk/models/shared/geographymetricsrow.d.ts +28 -4
  291. package/dist/esm/sdk/models/shared/geographymetricsrow.d.ts.map +1 -1
  292. package/dist/esm/sdk/models/shared/geographymetricsrow.js +6 -0
  293. package/dist/esm/sdk/models/shared/geographymetricsrow.js.map +1 -1
  294. package/dist/esm/sdk/models/shared/geographyrelatedarea.d.ts +41 -0
  295. package/dist/esm/sdk/models/shared/geographyrelatedarea.d.ts.map +1 -0
  296. package/dist/esm/sdk/models/shared/geographyrelatedarea.js +20 -0
  297. package/dist/esm/sdk/models/shared/geographyrelatedarea.js.map +1 -0
  298. package/dist/esm/sdk/models/shared/geographytimeseriespoint.d.ts +9 -5
  299. package/dist/esm/sdk/models/shared/geographytimeseriespoint.d.ts.map +1 -1
  300. package/dist/esm/sdk/models/shared/geographytimeseriespoint.js +1 -0
  301. package/dist/esm/sdk/models/shared/geographytimeseriespoint.js.map +1 -1
  302. package/dist/esm/sdk/models/shared/heritagedesignationfeature.d.ts +1 -1
  303. package/dist/esm/sdk/models/shared/index.d.ts +5 -0
  304. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  305. package/dist/esm/sdk/models/shared/index.js +5 -0
  306. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  307. package/dist/esm/sdk/models/shared/landconstraintdesignationfeature.d.ts +1 -1
  308. package/dist/esm/sdk/models/shared/titledeedapplication.d.ts +69 -0
  309. package/dist/esm/sdk/models/shared/titledeedapplication.d.ts.map +1 -0
  310. package/dist/esm/sdk/models/shared/titledeedapplication.js +47 -0
  311. package/dist/esm/sdk/models/shared/titledeedapplication.js.map +1 -0
  312. package/dist/esm/sdk/models/shared/titledeedapplicationlistresponse.d.ts +24 -0
  313. package/dist/esm/sdk/models/shared/titledeedapplicationlistresponse.d.ts.map +1 -0
  314. package/dist/esm/sdk/models/shared/titledeedapplicationlistresponse.js +28 -0
  315. package/dist/esm/sdk/models/shared/titledeedapplicationlistresponse.js.map +1 -0
  316. package/dist/esm/sdk/models/shared/titledeedavailabilityresponse.d.ts +67 -0
  317. package/dist/esm/sdk/models/shared/titledeedavailabilityresponse.d.ts.map +1 -0
  318. package/dist/esm/sdk/models/shared/titledeedavailabilityresponse.js +69 -0
  319. package/dist/esm/sdk/models/shared/titledeedavailabilityresponse.js.map +1 -0
  320. package/dist/esm/sdk/safety.d.ts +3 -3
  321. package/dist/esm/sdk/safety.js +3 -3
  322. package/dist/esm/sdk/sdk.d.ts +3 -0
  323. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  324. package/dist/esm/sdk/sdk.js +4 -0
  325. package/dist/esm/sdk/sdk.js.map +1 -1
  326. package/dist/esm/sdk/titledeeds.d.ts +14 -0
  327. package/dist/esm/sdk/titledeeds.d.ts.map +1 -1
  328. package/dist/esm/sdk/titledeeds.js +20 -0
  329. package/dist/esm/sdk/titledeeds.js.map +1 -1
  330. package/package.json +1 -1
  331. package/src/funcs/geographyGetGeographyAncestors.ts +175 -0
  332. package/src/funcs/geographyGetGeographyAreas.ts +173 -0
  333. package/src/funcs/geographyGetGeographyChildren.ts +175 -0
  334. package/src/funcs/geographyGetGeographyDescendants.ts +177 -0
  335. package/src/funcs/geographyGetGeographyProvenance.ts +174 -0
  336. package/src/funcs/geographyGetGeographyRelease.ts +144 -0
  337. package/src/funcs/safetyGetCrimeIncidents.ts +1 -1
  338. package/src/funcs/safetyGetGeographyMetrics.ts +2 -2
  339. package/src/funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.ts +208 -0
  340. package/src/funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.ts +208 -0
  341. package/src/lib/config.ts +3 -3
  342. package/src/lib/encodings.ts +58 -23
  343. package/src/sdk/geography.ts +115 -0
  344. package/src/sdk/models/errors/getv1titledeedstitlenumberapplications.ts +580 -0
  345. package/src/sdk/models/errors/getv1titledeedstitlenumberavailability.ts +580 -0
  346. package/src/sdk/models/errors/index.ts +2 -0
  347. package/src/sdk/models/errors/titledeedpurchasenotfound.ts +22 -0
  348. package/src/sdk/models/operations/getgeographyancestors.ts +108 -0
  349. package/src/sdk/models/operations/getgeographyareas.ts +100 -0
  350. package/src/sdk/models/operations/getgeographychildren.ts +162 -0
  351. package/src/sdk/models/operations/getgeographydescendants.ts +121 -0
  352. package/src/sdk/models/operations/getgeographyprovenance.ts +135 -0
  353. package/src/sdk/models/operations/getgeographyrelease.ts +57 -0
  354. package/src/sdk/models/operations/getv1titledeedstitlenumberapplications.ts +38 -0
  355. package/src/sdk/models/operations/getv1titledeedstitlenumberavailability.ts +38 -0
  356. package/src/sdk/models/operations/index.ts +8 -0
  357. package/src/sdk/models/shared/conservationdesignationfeature.ts +1 -1
  358. package/src/sdk/models/shared/crimecatalogentry.ts +5 -6
  359. package/src/sdk/models/shared/crimecatalogperiodsbycountry.ts +1 -1
  360. package/src/sdk/models/shared/crimeconfidenceinterval.ts +1 -1
  361. package/src/sdk/models/shared/crimeincident.ts +10 -5
  362. package/src/sdk/models/shared/crimeincidentslistresponse.ts +1 -1
  363. package/src/sdk/models/shared/crimeincidentssummary.ts +1 -1
  364. package/src/sdk/models/shared/crimeperioddetails.ts +16 -1
  365. package/src/sdk/models/shared/geographyarea.ts +59 -0
  366. package/src/sdk/models/shared/geographycategorymetric.ts +55 -10
  367. package/src/sdk/models/shared/geographymetricsrow.ts +34 -4
  368. package/src/sdk/models/shared/geographyrelatedarea.ts +69 -0
  369. package/src/sdk/models/shared/geographytimeseriespoint.ts +10 -5
  370. package/src/sdk/models/shared/heritagedesignationfeature.ts +1 -1
  371. package/src/sdk/models/shared/index.ts +5 -0
  372. package/src/sdk/models/shared/landconstraintdesignationfeature.ts +1 -1
  373. package/src/sdk/models/shared/titledeedapplication.ts +124 -0
  374. package/src/sdk/models/shared/titledeedapplicationlistresponse.ts +64 -0
  375. package/src/sdk/models/shared/titledeedavailabilityresponse.ts +162 -0
  376. package/src/sdk/safety.ts +3 -3
  377. package/src/sdk/sdk.ts +6 -0
  378. package/src/sdk/titledeeds.ts +36 -0
@@ -0,0 +1,144 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { SDKCore } from "../core.js";
6
+ import { matchStatusCode } from "../lib/http.js";
7
+ import * as M from "../lib/matchers.js";
8
+ import { compactMap } from "../lib/primitives.js";
9
+ import { RequestOptions } from "../lib/sdks.js";
10
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
11
+ import { pathToFunc } from "../lib/url.js";
12
+ import {
13
+ ConnectionError,
14
+ InvalidRequestError,
15
+ RequestAbortedError,
16
+ RequestTimeoutError,
17
+ UnexpectedClientError,
18
+ } from "../sdk/models/errors/httpclienterrors.js";
19
+ import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
20
+ import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
21
+ import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
22
+ import * as operations from "../sdk/models/operations/index.js";
23
+ import { APICall, APIPromise } from "../sdk/types/async.js";
24
+ import { Result } from "../sdk/types/fp.js";
25
+
26
+ /**
27
+ * Get the current geography release
28
+ *
29
+ * @remarks
30
+ * Returns the release every other geography endpoint answers from unless one is pinned. A release is a named set of publisher vintages that compose into one consistent tree — the nations publish on their own cycles, so a UK-wide release is a composition rather than a date.
31
+ */
32
+ export function geographyGetGeographyRelease(
33
+ client: SDKCore,
34
+ options?: RequestOptions,
35
+ ): APIPromise<
36
+ Result<
37
+ operations.GetGeographyReleaseResponseBody,
38
+ | SDKBaseError
39
+ | ResponseValidationError
40
+ | ConnectionError
41
+ | RequestAbortedError
42
+ | RequestTimeoutError
43
+ | InvalidRequestError
44
+ | UnexpectedClientError
45
+ | SDKValidationError
46
+ >
47
+ > {
48
+ return new APIPromise($do(
49
+ client,
50
+ options,
51
+ ));
52
+ }
53
+
54
+ async function $do(
55
+ client: SDKCore,
56
+ options?: RequestOptions,
57
+ ): Promise<
58
+ [
59
+ Result<
60
+ operations.GetGeographyReleaseResponseBody,
61
+ | SDKBaseError
62
+ | ResponseValidationError
63
+ | ConnectionError
64
+ | RequestAbortedError
65
+ | RequestTimeoutError
66
+ | InvalidRequestError
67
+ | UnexpectedClientError
68
+ | SDKValidationError
69
+ >,
70
+ APICall,
71
+ ]
72
+ > {
73
+ const path = pathToFunc("/v1/geography/release")();
74
+
75
+ const headers = new Headers(compactMap({
76
+ Accept: "application/json",
77
+ }));
78
+
79
+ const secConfig = await extractSecurity(client._options.apiKeyAuth);
80
+ const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
81
+ const requestSecurity = resolveGlobalSecurity(securityInput);
82
+
83
+ const context = {
84
+ options: client._options,
85
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
86
+ operationID: "getGeographyRelease",
87
+ oAuth2Scopes: null,
88
+
89
+ resolvedSecurity: requestSecurity,
90
+
91
+ securitySource: client._options.apiKeyAuth,
92
+ retryConfig: options?.retries
93
+ || client._options.retryConfig
94
+ || { strategy: "none" },
95
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
96
+ };
97
+
98
+ const requestRes = client._createRequest(context, {
99
+ security: requestSecurity,
100
+ method: "GET",
101
+ baseURL: options?.serverURL,
102
+ path: path,
103
+ headers: headers,
104
+ userAgent: client._options.userAgent,
105
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
106
+ }, options);
107
+ if (!requestRes.ok) {
108
+ return [requestRes, { status: "invalid" }];
109
+ }
110
+ const req = requestRes.value;
111
+
112
+ const doResult = await client._do(req, {
113
+ context,
114
+ isErrorStatusCode: (statusCode: number) =>
115
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
116
+ retryConfig: context.retryConfig,
117
+ retryCodes: context.retryCodes,
118
+ });
119
+ if (!doResult.ok) {
120
+ return [doResult, { status: "request-error", request: req }];
121
+ }
122
+ const response = doResult.value;
123
+
124
+ const [result] = await M.match<
125
+ operations.GetGeographyReleaseResponseBody,
126
+ | SDKBaseError
127
+ | ResponseValidationError
128
+ | ConnectionError
129
+ | RequestAbortedError
130
+ | RequestTimeoutError
131
+ | InvalidRequestError
132
+ | UnexpectedClientError
133
+ | SDKValidationError
134
+ >(
135
+ M.json(200, operations.GetGeographyReleaseResponseBody$inboundSchema),
136
+ M.fail("4XX"),
137
+ M.fail("5XX"),
138
+ )(response, req);
139
+ if (!result.ok) {
140
+ return [result, { status: "complete", request: req, response }];
141
+ }
142
+
143
+ return [result, { status: "complete", request: req, response }];
144
+ }
@@ -31,7 +31,7 @@ import { Result } from "../sdk/types/fp.js";
31
31
  * Get crime incidents near a point
32
32
  *
33
33
  * @remarks
34
- * Return the individual crime incidents recorded within `radius` metres of a point, covering England and Wales. Incident locations are anonymised at source to a nearby map point, accurate to roughly 150m, and are published monthly around two months in arrears. The response always covers six months: supplying `date` ends that window at the month given, or at the most recent month with significant reporting if that is earlier, and leaving `date` out ends it at the most recent month with significant reporting in the area. A single request returns at most 5,000 incidents, and sets `summary.truncated` to `true` when it hits that cap, so narrow the radius or the date window to see the rest.
34
+ * Return the individual crime incidents recorded within `radius` metres of a point, covering England and Wales from August 2020 onwards. Incident locations are anonymised at source to a nearby map point, accurate to roughly 150m, and are published monthly around two months in arrears, dated to the first of the month they were recorded in. The response always covers six months: supplying `date` ends that window at the month given, or at the most recent month with significant reporting if that is earlier, and leaving `date` out ends it at the most recent month with significant reporting in the area. A single request returns at most 5,000 incidents, and sets `summary.truncated` to `true` when it hits that cap, so narrow the radius or the date window to see the rest.
35
35
  */
36
36
  export function safetyGetCrimeIncidents(
37
37
  client: SDKCore,
@@ -28,10 +28,10 @@ import { APICall, APIPromise } from "../sdk/types/async.js";
28
28
  import { Result } from "../sdk/types/fp.js";
29
29
 
30
30
  /**
31
- * Get crime metrics for one or more geographic areas (England only)
31
+ * Get crime metrics for one or more geographic areas (England and Wales)
32
32
  *
33
33
  * @remarks
34
- * Return scored crime metrics for one or more areas, identified by Lower Layer Super Output Area (LSOA), ward or authority code, across one or more months, each with a per-category breakdown and an optional monthly history. Coverage is England only: the scored area metrics behind this endpoint hold English geographies alone, so codes in Wales, Scotland or Northern Ireland come back as `data: []`, and incident-level data for England and Wales lives at `/v1/safety/crime` instead. By default the response carries one row per area and month; with `mergeAreas=true` it carries one row per month, with counts and population summed across every requested area and scores, percentiles and trends set to null because they cannot be combined across areas. Choose the months either explicitly with `periods=YYYY-MM,YYYY-MM` or as a range with `startDate` and `endDate`, never both, and set how far each row's history reaches back with `months`, which defaults to 12. An empty result comes back as `data: []` with `total_count: 0`, never as a 204.
34
+ * Return scored crime metrics for one or more areas across one or more months, each with a per-category breakdown and an optional monthly history. Areas are identified by GSS code at six levels: Lower Layer Super Output Area (LSOA, `E01`/`W01`), Middle Layer Super Output Area (MSOA, `E02`/`W02`), local authority district or unitary authority (`E06`-`E09`, `W06`), county (`E10`), English region (`E12`) and country (`E92`, `W92`). Coverage is England and Wales; codes at other levels, such as wards or parishes, and codes in Scotland or Northern Ireland come back as `data: []`. Every month summarises the trailing 24-month window ending at that month, so counts are window totals and rates are per 1,000 residents per year. Months are published two months in arrears, roughly monthly; the catalogue endpoint lists the months held. Scores are null, never 0, where a police force did not report; read `dataAvailability` beside every number. By default the response carries one row per area and month; with `mergeAreas=true` it carries one row per month, with counts and population summed across every requested area and scores, percentiles and trends set to null because they cannot be combined across areas. Choose the months either explicitly with `periods=YYYY-MM,YYYY-MM` or as a range with `startDate` and `endDate`, never both, and set how far each row's history reaches back with `months`, which defaults to 12. An empty result comes back as `data: []` with `total_count: 0`, never as a 204.
35
35
  */
36
36
  export function safetyGetGeographyMetrics(
37
37
  client: SDKCore,
@@ -0,0 +1,208 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { SDKCore } from "../core.js";
6
+ import { encodeSimple } from "../lib/encodings.js";
7
+ import { matchStatusCode } from "../lib/http.js";
8
+ import * as M from "../lib/matchers.js";
9
+ import { compactMap } from "../lib/primitives.js";
10
+ import { safeParse } from "../lib/schemas.js";
11
+ import { RequestOptions } from "../lib/sdks.js";
12
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
13
+ import { pathToFunc } from "../lib/url.js";
14
+ import {
15
+ ConnectionError,
16
+ InvalidRequestError,
17
+ RequestAbortedError,
18
+ RequestTimeoutError,
19
+ UnexpectedClientError,
20
+ } from "../sdk/models/errors/httpclienterrors.js";
21
+ import * as errors from "../sdk/models/errors/index.js";
22
+ import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
23
+ import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
24
+ import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
25
+ import * as operations from "../sdk/models/operations/index.js";
26
+ import * as shared from "../sdk/models/shared/index.js";
27
+ import { APICall, APIPromise } from "../sdk/types/async.js";
28
+ import { Result } from "../sdk/types/fp.js";
29
+
30
+ /**
31
+ * List applications pending against a title deed
32
+ *
33
+ * @remarks
34
+ * Returns the applications lodged against this title at HM Land Registry and not yet completed, with the type of each, who lodged it, its priority date and how far it has progressed. Nothing is charged. While any application is pending, a standard official copy of the title cannot be purchased.
35
+ */
36
+ export function titleDeedsGetV1TitleDeedsTitleNumberApplications(
37
+ client: SDKCore,
38
+ request: operations.GetV1TitleDeedsTitleNumberApplicationsRequest,
39
+ options?: RequestOptions,
40
+ ): APIPromise<
41
+ Result<
42
+ shared.TitleDeedApplicationListResponse,
43
+ | errors.GetV1TitleDeedsTitleNumberApplicationsResponseBody
44
+ | errors.GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseBody
45
+ | errors.GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseResponseBody
46
+ | errors.GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ResponseBody
47
+ | SDKBaseError
48
+ | ResponseValidationError
49
+ | ConnectionError
50
+ | RequestAbortedError
51
+ | RequestTimeoutError
52
+ | InvalidRequestError
53
+ | UnexpectedClientError
54
+ | SDKValidationError
55
+ >
56
+ > {
57
+ return new APIPromise($do(
58
+ client,
59
+ request,
60
+ options,
61
+ ));
62
+ }
63
+
64
+ async function $do(
65
+ client: SDKCore,
66
+ request: operations.GetV1TitleDeedsTitleNumberApplicationsRequest,
67
+ options?: RequestOptions,
68
+ ): Promise<
69
+ [
70
+ Result<
71
+ shared.TitleDeedApplicationListResponse,
72
+ | errors.GetV1TitleDeedsTitleNumberApplicationsResponseBody
73
+ | errors.GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseBody
74
+ | errors.GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseResponseBody
75
+ | errors.GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ResponseBody
76
+ | SDKBaseError
77
+ | ResponseValidationError
78
+ | ConnectionError
79
+ | RequestAbortedError
80
+ | RequestTimeoutError
81
+ | InvalidRequestError
82
+ | UnexpectedClientError
83
+ | SDKValidationError
84
+ >,
85
+ APICall,
86
+ ]
87
+ > {
88
+ const parsed = safeParse(
89
+ request,
90
+ (value) =>
91
+ operations.GetV1TitleDeedsTitleNumberApplicationsRequest$outboundSchema
92
+ .parse(value),
93
+ "Input validation failed",
94
+ );
95
+ if (!parsed.ok) {
96
+ return [parsed, { status: "invalid" }];
97
+ }
98
+ const payload = parsed.value;
99
+ const body = null;
100
+
101
+ const pathParams = {
102
+ titleNumber: encodeSimple("titleNumber", payload.titleNumber, {
103
+ explode: false,
104
+ charEncoding: "percent",
105
+ }),
106
+ };
107
+ const path = pathToFunc("/v1/title-deeds/{titleNumber}/applications")(
108
+ pathParams,
109
+ );
110
+
111
+ const headers = new Headers(compactMap({
112
+ Accept: "application/json",
113
+ }));
114
+
115
+ const secConfig = await extractSecurity(client._options.apiKeyAuth);
116
+ const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
117
+ const requestSecurity = resolveGlobalSecurity(securityInput);
118
+
119
+ const context = {
120
+ options: client._options,
121
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
122
+ operationID: "get_/v1/title-deeds/{titleNumber}/applications",
123
+ oAuth2Scopes: null,
124
+
125
+ resolvedSecurity: requestSecurity,
126
+
127
+ securitySource: client._options.apiKeyAuth,
128
+ retryConfig: options?.retries
129
+ || client._options.retryConfig
130
+ || { strategy: "none" },
131
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
132
+ };
133
+
134
+ const requestRes = client._createRequest(context, {
135
+ security: requestSecurity,
136
+ method: "GET",
137
+ baseURL: options?.serverURL,
138
+ path: path,
139
+ headers: headers,
140
+ body: body,
141
+ userAgent: client._options.userAgent,
142
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
143
+ }, options);
144
+ if (!requestRes.ok) {
145
+ return [requestRes, { status: "invalid" }];
146
+ }
147
+ const req = requestRes.value;
148
+
149
+ const doResult = await client._do(req, {
150
+ context,
151
+ isErrorStatusCode: (statusCode: number) =>
152
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
153
+ retryConfig: context.retryConfig,
154
+ retryCodes: context.retryCodes,
155
+ });
156
+ if (!doResult.ok) {
157
+ return [doResult, { status: "request-error", request: req }];
158
+ }
159
+ const response = doResult.value;
160
+
161
+ const responseFields = {
162
+ HttpMeta: { Response: response, Request: req },
163
+ };
164
+
165
+ const [result] = await M.match<
166
+ shared.TitleDeedApplicationListResponse,
167
+ | errors.GetV1TitleDeedsTitleNumberApplicationsResponseBody
168
+ | errors.GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseBody
169
+ | errors.GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseResponseBody
170
+ | errors.GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ResponseBody
171
+ | SDKBaseError
172
+ | ResponseValidationError
173
+ | ConnectionError
174
+ | RequestAbortedError
175
+ | RequestTimeoutError
176
+ | InvalidRequestError
177
+ | UnexpectedClientError
178
+ | SDKValidationError
179
+ >(
180
+ M.json(200, shared.TitleDeedApplicationListResponse$inboundSchema),
181
+ M.jsonErr(
182
+ 400,
183
+ errors.GetV1TitleDeedsTitleNumberApplicationsResponseBody$inboundSchema,
184
+ ),
185
+ M.jsonErr(
186
+ 401,
187
+ errors
188
+ .GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseBody$inboundSchema,
189
+ ),
190
+ M.jsonErr(
191
+ 404,
192
+ errors
193
+ .GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseResponseBody$inboundSchema,
194
+ ),
195
+ M.jsonErr(
196
+ 502,
197
+ errors
198
+ .GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ResponseBody$inboundSchema,
199
+ ),
200
+ M.fail("4XX"),
201
+ M.fail("5XX"),
202
+ )(response, req, { extraFields: responseFields });
203
+ if (!result.ok) {
204
+ return [result, { status: "complete", request: req, response }];
205
+ }
206
+
207
+ return [result, { status: "complete", request: req, response }];
208
+ }
@@ -0,0 +1,208 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { SDKCore } from "../core.js";
6
+ import { encodeSimple } from "../lib/encodings.js";
7
+ import { matchStatusCode } from "../lib/http.js";
8
+ import * as M from "../lib/matchers.js";
9
+ import { compactMap } from "../lib/primitives.js";
10
+ import { safeParse } from "../lib/schemas.js";
11
+ import { RequestOptions } from "../lib/sdks.js";
12
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
13
+ import { pathToFunc } from "../lib/url.js";
14
+ import {
15
+ ConnectionError,
16
+ InvalidRequestError,
17
+ RequestAbortedError,
18
+ RequestTimeoutError,
19
+ UnexpectedClientError,
20
+ } from "../sdk/models/errors/httpclienterrors.js";
21
+ import * as errors from "../sdk/models/errors/index.js";
22
+ import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
23
+ import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
24
+ import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
25
+ import * as operations from "../sdk/models/operations/index.js";
26
+ import * as shared from "../sdk/models/shared/index.js";
27
+ import { APICall, APIPromise } from "../sdk/types/async.js";
28
+ import { Result } from "../sdk/types/fp.js";
29
+
30
+ /**
31
+ * Check whether a title deed can be purchased
32
+ *
33
+ * @remarks
34
+ * Reports whether HM Land Registry will sell an official copy of this title today, and if not, why not. Nothing is charged and no purchase is made, so this can be called before every purchase. The common reason a title cannot be bought is that an application is pending against it, in which case HM Land Registry will not issue a standard official copy until the application completes. Use `/{titleNumber}/applications` to see what is pending.
35
+ */
36
+ export function titleDeedsGetV1TitleDeedsTitleNumberAvailability(
37
+ client: SDKCore,
38
+ request: operations.GetV1TitleDeedsTitleNumberAvailabilityRequest,
39
+ options?: RequestOptions,
40
+ ): APIPromise<
41
+ Result<
42
+ shared.TitleDeedAvailabilityResponse,
43
+ | errors.GetV1TitleDeedsTitleNumberAvailabilityResponseBody
44
+ | errors.GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseBody
45
+ | errors.GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseResponseBody
46
+ | errors.GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ResponseBody
47
+ | SDKBaseError
48
+ | ResponseValidationError
49
+ | ConnectionError
50
+ | RequestAbortedError
51
+ | RequestTimeoutError
52
+ | InvalidRequestError
53
+ | UnexpectedClientError
54
+ | SDKValidationError
55
+ >
56
+ > {
57
+ return new APIPromise($do(
58
+ client,
59
+ request,
60
+ options,
61
+ ));
62
+ }
63
+
64
+ async function $do(
65
+ client: SDKCore,
66
+ request: operations.GetV1TitleDeedsTitleNumberAvailabilityRequest,
67
+ options?: RequestOptions,
68
+ ): Promise<
69
+ [
70
+ Result<
71
+ shared.TitleDeedAvailabilityResponse,
72
+ | errors.GetV1TitleDeedsTitleNumberAvailabilityResponseBody
73
+ | errors.GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseBody
74
+ | errors.GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseResponseBody
75
+ | errors.GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ResponseBody
76
+ | SDKBaseError
77
+ | ResponseValidationError
78
+ | ConnectionError
79
+ | RequestAbortedError
80
+ | RequestTimeoutError
81
+ | InvalidRequestError
82
+ | UnexpectedClientError
83
+ | SDKValidationError
84
+ >,
85
+ APICall,
86
+ ]
87
+ > {
88
+ const parsed = safeParse(
89
+ request,
90
+ (value) =>
91
+ operations.GetV1TitleDeedsTitleNumberAvailabilityRequest$outboundSchema
92
+ .parse(value),
93
+ "Input validation failed",
94
+ );
95
+ if (!parsed.ok) {
96
+ return [parsed, { status: "invalid" }];
97
+ }
98
+ const payload = parsed.value;
99
+ const body = null;
100
+
101
+ const pathParams = {
102
+ titleNumber: encodeSimple("titleNumber", payload.titleNumber, {
103
+ explode: false,
104
+ charEncoding: "percent",
105
+ }),
106
+ };
107
+ const path = pathToFunc("/v1/title-deeds/{titleNumber}/availability")(
108
+ pathParams,
109
+ );
110
+
111
+ const headers = new Headers(compactMap({
112
+ Accept: "application/json",
113
+ }));
114
+
115
+ const secConfig = await extractSecurity(client._options.apiKeyAuth);
116
+ const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
117
+ const requestSecurity = resolveGlobalSecurity(securityInput);
118
+
119
+ const context = {
120
+ options: client._options,
121
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
122
+ operationID: "get_/v1/title-deeds/{titleNumber}/availability",
123
+ oAuth2Scopes: null,
124
+
125
+ resolvedSecurity: requestSecurity,
126
+
127
+ securitySource: client._options.apiKeyAuth,
128
+ retryConfig: options?.retries
129
+ || client._options.retryConfig
130
+ || { strategy: "none" },
131
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
132
+ };
133
+
134
+ const requestRes = client._createRequest(context, {
135
+ security: requestSecurity,
136
+ method: "GET",
137
+ baseURL: options?.serverURL,
138
+ path: path,
139
+ headers: headers,
140
+ body: body,
141
+ userAgent: client._options.userAgent,
142
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
143
+ }, options);
144
+ if (!requestRes.ok) {
145
+ return [requestRes, { status: "invalid" }];
146
+ }
147
+ const req = requestRes.value;
148
+
149
+ const doResult = await client._do(req, {
150
+ context,
151
+ isErrorStatusCode: (statusCode: number) =>
152
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
153
+ retryConfig: context.retryConfig,
154
+ retryCodes: context.retryCodes,
155
+ });
156
+ if (!doResult.ok) {
157
+ return [doResult, { status: "request-error", request: req }];
158
+ }
159
+ const response = doResult.value;
160
+
161
+ const responseFields = {
162
+ HttpMeta: { Response: response, Request: req },
163
+ };
164
+
165
+ const [result] = await M.match<
166
+ shared.TitleDeedAvailabilityResponse,
167
+ | errors.GetV1TitleDeedsTitleNumberAvailabilityResponseBody
168
+ | errors.GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseBody
169
+ | errors.GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseResponseBody
170
+ | errors.GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ResponseBody
171
+ | SDKBaseError
172
+ | ResponseValidationError
173
+ | ConnectionError
174
+ | RequestAbortedError
175
+ | RequestTimeoutError
176
+ | InvalidRequestError
177
+ | UnexpectedClientError
178
+ | SDKValidationError
179
+ >(
180
+ M.json(200, shared.TitleDeedAvailabilityResponse$inboundSchema),
181
+ M.jsonErr(
182
+ 400,
183
+ errors.GetV1TitleDeedsTitleNumberAvailabilityResponseBody$inboundSchema,
184
+ ),
185
+ M.jsonErr(
186
+ 401,
187
+ errors
188
+ .GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseBody$inboundSchema,
189
+ ),
190
+ M.jsonErr(
191
+ 404,
192
+ errors
193
+ .GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponseResponseBody$inboundSchema,
194
+ ),
195
+ M.jsonErr(
196
+ 502,
197
+ errors
198
+ .GetV1TitleDeedsTitleNumberAvailabilityTitleDeedsResponse502ResponseBody$inboundSchema,
199
+ ),
200
+ M.fail("4XX"),
201
+ M.fail("5XX"),
202
+ )(response, req, { extraFields: responseFields });
203
+ if (!result.ok) {
204
+ return [result, { status: "complete", request: req, response }];
205
+ }
206
+
207
+ return [result, { status: "complete", request: req, response }];
208
+ }
package/src/lib/config.ts CHANGED
@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
60
60
 
61
61
  export const SDK_METADATA = {
62
62
  language: "typescript",
63
- openapiDocVersion: "5.28.1",
63
+ openapiDocVersion: "6.0.0",
64
64
  sdkVersion: "0.12.0",
65
- genVersion: "2.932.9",
66
- userAgent: "speakeasy-sdk/typescript 0.12.0 2.932.9 5.28.1 @vepler/sdk",
65
+ genVersion: "2.935.1",
66
+ userAgent: "speakeasy-sdk/typescript 0.12.0 2.935.1 6.0.0 @vepler/sdk",
67
67
  } as const;