@vepler/sdk 2.38.2 → 2.42.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (402) hide show
  1. package/README.md +212 -182
  2. package/dist/commonjs/funcs/planningPolicySearch.d.ts +18 -0
  3. package/dist/commonjs/funcs/planningPolicySearch.d.ts.map +1 -0
  4. package/dist/commonjs/funcs/planningPolicySearch.js +125 -0
  5. package/dist/commonjs/funcs/planningPolicySearch.js.map +1 -0
  6. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.d.ts +3 -2
  7. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.d.ts.map +1 -1
  8. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.js +3 -2
  9. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.js.map +1 -1
  10. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.d.ts +3 -2
  11. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.d.ts.map +1 -1
  12. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.js +3 -2
  13. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.js.map +1 -1
  14. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.d.ts +19 -0
  15. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.d.ts.map +1 -0
  16. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.js +128 -0
  17. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.js.map +1 -0
  18. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.d.ts +18 -0
  19. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.d.ts.map +1 -0
  20. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.js +137 -0
  21. package/dist/commonjs/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.js.map +1 -0
  22. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts +19 -0
  23. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts.map +1 -0
  24. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js +128 -0
  25. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js.map +1 -0
  26. package/dist/commonjs/hooks/registration.d.ts.map +1 -1
  27. package/dist/commonjs/hooks/registration.js.map +1 -1
  28. package/dist/commonjs/lib/config.d.ts +3 -3
  29. package/dist/commonjs/lib/config.js +3 -3
  30. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocuments.d.ts +266 -0
  31. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocuments.d.ts.map +1 -0
  32. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocuments.js +265 -0
  33. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocuments.js.map +1 -0
  34. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts +331 -0
  35. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts.map +1 -0
  36. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.js +313 -0
  37. package/dist/commonjs/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.js.map +1 -0
  38. package/dist/commonjs/sdk/models/errors/index.d.ts +5 -0
  39. package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
  40. package/dist/commonjs/sdk/models/errors/index.js +5 -0
  41. package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
  42. package/dist/commonjs/sdk/models/errors/insufficientcreditserror.d.ts +49 -0
  43. package/dist/commonjs/sdk/models/errors/insufficientcreditserror.d.ts.map +1 -0
  44. package/dist/commonjs/sdk/models/errors/insufficientcreditserror.js +97 -0
  45. package/dist/commonjs/sdk/models/errors/insufficientcreditserror.js.map +1 -0
  46. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts +266 -0
  47. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts.map +1 -0
  48. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.js +265 -0
  49. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.js.map +1 -0
  50. package/dist/commonjs/sdk/models/errors/searchplanningpolicy.d.ts +65 -0
  51. package/dist/commonjs/sdk/models/errors/searchplanningpolicy.d.ts.map +1 -0
  52. package/dist/commonjs/sdk/models/errors/searchplanningpolicy.js +121 -0
  53. package/dist/commonjs/sdk/models/errors/searchplanningpolicy.js.map +1 -0
  54. package/dist/commonjs/sdk/models/operations/getareacoverage.d.ts +4 -4
  55. package/dist/commonjs/sdk/models/operations/getareacoverage.d.ts.map +1 -1
  56. package/dist/commonjs/sdk/models/operations/getareacoverage.js +4 -4
  57. package/dist/commonjs/sdk/models/operations/getareacoverage.js.map +1 -1
  58. package/dist/commonjs/sdk/models/operations/getepcbylocationid.d.ts +29 -1
  59. package/dist/commonjs/sdk/models/operations/getepcbylocationid.d.ts.map +1 -1
  60. package/dist/commonjs/sdk/models/operations/getepcbylocationid.js +19 -2
  61. package/dist/commonjs/sdk/models/operations/getepcbylocationid.js.map +1 -1
  62. package/dist/commonjs/sdk/models/operations/getschoolmetrics.d.ts +8 -8
  63. package/dist/commonjs/sdk/models/operations/getschoolmetrics.d.ts.map +1 -1
  64. package/dist/commonjs/sdk/models/operations/getschoolmetrics.js +15 -16
  65. package/dist/commonjs/sdk/models/operations/getschoolmetrics.js.map +1 -1
  66. package/dist/commonjs/sdk/models/operations/getv1safetycrime.d.ts +4 -93
  67. package/dist/commonjs/sdk/models/operations/getv1safetycrime.d.ts.map +1 -1
  68. package/dist/commonjs/sdk/models/operations/getv1safetycrime.js +1 -44
  69. package/dist/commonjs/sdk/models/operations/getv1safetycrime.js.map +1 -1
  70. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.d.ts +4 -95
  71. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.d.ts.map +1 -1
  72. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.js +1 -53
  73. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.js.map +1 -1
  74. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocuments.d.ts +12 -0
  75. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocuments.d.ts.map +1 -0
  76. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocuments.js +49 -0
  77. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocuments.js.map +1 -0
  78. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts +32 -0
  79. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts.map +1 -0
  80. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.js +60 -0
  81. package/dist/commonjs/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.js.map +1 -0
  82. package/dist/commonjs/sdk/models/operations/index.d.ts +4 -0
  83. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  84. package/dist/commonjs/sdk/models/operations/index.js +4 -0
  85. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  86. package/dist/commonjs/sdk/models/operations/postv1titledeedstitlenumberpurchase.d.ts +12 -0
  87. package/dist/commonjs/sdk/models/operations/postv1titledeedstitlenumberpurchase.d.ts.map +1 -0
  88. package/dist/commonjs/sdk/models/operations/postv1titledeedstitlenumberpurchase.js +49 -0
  89. package/dist/commonjs/sdk/models/operations/postv1titledeedstitlenumberpurchase.js.map +1 -0
  90. package/dist/commonjs/sdk/models/operations/searchplanningpolicy.d.ts +123 -0
  91. package/dist/commonjs/sdk/models/operations/searchplanningpolicy.d.ts.map +1 -0
  92. package/dist/commonjs/sdk/models/operations/searchplanningpolicy.js +160 -0
  93. package/dist/commonjs/sdk/models/operations/searchplanningpolicy.js.map +1 -0
  94. package/dist/commonjs/sdk/models/shared/aggregationresult.d.ts +3 -1
  95. package/dist/commonjs/sdk/models/shared/aggregationresult.d.ts.map +1 -1
  96. package/dist/commonjs/sdk/models/shared/aggregationresult.js +4 -0
  97. package/dist/commonjs/sdk/models/shared/aggregationresult.js.map +1 -1
  98. package/dist/commonjs/sdk/models/shared/areastatsresponse.d.ts +66 -0
  99. package/dist/commonjs/sdk/models/shared/areastatsresponse.d.ts.map +1 -0
  100. package/dist/commonjs/sdk/models/shared/areastatsresponse.js +94 -0
  101. package/dist/commonjs/sdk/models/shared/areastatsresponse.js.map +1 -0
  102. package/dist/commonjs/sdk/models/shared/avmanalysisresponse.d.ts +4 -4
  103. package/dist/commonjs/sdk/models/shared/avmanalysisresponse.d.ts.map +1 -1
  104. package/dist/commonjs/sdk/models/shared/avmanalysisresponse.js +4 -4
  105. package/dist/commonjs/sdk/models/shared/avmanalysisresponse.js.map +1 -1
  106. package/dist/commonjs/sdk/models/shared/crimedataresponse.d.ts +35 -0
  107. package/dist/commonjs/sdk/models/shared/crimedataresponse.d.ts.map +1 -0
  108. package/dist/commonjs/sdk/models/shared/crimedataresponse.js +63 -0
  109. package/dist/commonjs/sdk/models/shared/crimedataresponse.js.map +1 -0
  110. package/dist/commonjs/sdk/models/shared/crimerecord.d.ts +37 -0
  111. package/dist/commonjs/sdk/models/shared/crimerecord.d.ts.map +1 -0
  112. package/dist/commonjs/sdk/models/shared/crimerecord.js +56 -0
  113. package/dist/commonjs/sdk/models/shared/crimerecord.js.map +1 -0
  114. package/dist/commonjs/sdk/models/shared/extendedstatsaggregationresult.d.ts +75 -0
  115. package/dist/commonjs/sdk/models/shared/extendedstatsaggregationresult.d.ts.map +1 -0
  116. package/dist/commonjs/sdk/models/shared/extendedstatsaggregationresult.js +93 -0
  117. package/dist/commonjs/sdk/models/shared/extendedstatsaggregationresult.js.map +1 -0
  118. package/dist/commonjs/sdk/models/shared/index.d.ts +9 -0
  119. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  120. package/dist/commonjs/sdk/models/shared/index.js +9 -0
  121. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  122. package/dist/commonjs/sdk/models/shared/nearestpostcodesresponse.d.ts +4 -4
  123. package/dist/commonjs/sdk/models/shared/nearestpostcodesresponse.d.ts.map +1 -1
  124. package/dist/commonjs/sdk/models/shared/nearestpostcodesresponse.js +6 -7
  125. package/dist/commonjs/sdk/models/shared/nearestpostcodesresponse.js.map +1 -1
  126. package/dist/commonjs/sdk/models/shared/percentilesaggregationresult.d.ts +15 -0
  127. package/dist/commonjs/sdk/models/shared/percentilesaggregationresult.d.ts.map +1 -0
  128. package/dist/commonjs/sdk/models/shared/percentilesaggregationresult.js +50 -0
  129. package/dist/commonjs/sdk/models/shared/percentilesaggregationresult.js.map +1 -0
  130. package/dist/commonjs/sdk/models/shared/site.d.ts +15 -10
  131. package/dist/commonjs/sdk/models/shared/site.d.ts.map +1 -1
  132. package/dist/commonjs/sdk/models/shared/site.js +8 -6
  133. package/dist/commonjs/sdk/models/shared/site.js.map +1 -1
  134. package/dist/commonjs/sdk/models/shared/sitefilters.d.ts +15 -0
  135. package/dist/commonjs/sdk/models/shared/sitefilters.d.ts.map +1 -1
  136. package/dist/commonjs/sdk/models/shared/sitefilters.js +3 -0
  137. package/dist/commonjs/sdk/models/shared/sitefilters.js.map +1 -1
  138. package/dist/commonjs/sdk/models/shared/siteownership.d.ts +41 -0
  139. package/dist/commonjs/sdk/models/shared/siteownership.d.ts.map +1 -0
  140. package/dist/commonjs/sdk/models/shared/siteownership.js +57 -0
  141. package/dist/commonjs/sdk/models/shared/siteownership.js.map +1 -0
  142. package/dist/commonjs/sdk/models/shared/siteproprietor.d.ts +33 -0
  143. package/dist/commonjs/sdk/models/shared/siteproprietor.d.ts.map +1 -0
  144. package/dist/commonjs/sdk/models/shared/siteproprietor.js +55 -0
  145. package/dist/commonjs/sdk/models/shared/siteproprietor.js.map +1 -0
  146. package/dist/commonjs/sdk/models/shared/sitequerycondition.d.ts +0 -1
  147. package/dist/commonjs/sdk/models/shared/sitequerycondition.d.ts.map +1 -1
  148. package/dist/commonjs/sdk/models/shared/sitequerycondition.js +0 -1
  149. package/dist/commonjs/sdk/models/shared/sitequerycondition.js.map +1 -1
  150. package/dist/commonjs/sdk/models/shared/sitequeryrequest.d.ts +0 -3
  151. package/dist/commonjs/sdk/models/shared/sitequeryrequest.d.ts.map +1 -1
  152. package/dist/commonjs/sdk/models/shared/sitequeryrequest.js +0 -3
  153. package/dist/commonjs/sdk/models/shared/sitequeryrequest.js.map +1 -1
  154. package/dist/commonjs/sdk/models/shared/titledeeddocumentlistresponse.d.ts +76 -0
  155. package/dist/commonjs/sdk/models/shared/titledeeddocumentlistresponse.d.ts.map +1 -0
  156. package/dist/commonjs/sdk/models/shared/titledeeddocumentlistresponse.js +104 -0
  157. package/dist/commonjs/sdk/models/shared/titledeeddocumentlistresponse.js.map +1 -0
  158. package/dist/commonjs/sdk/models/shared/titledeedpurchaseresponse.d.ts +205 -0
  159. package/dist/commonjs/sdk/models/shared/titledeedpurchaseresponse.d.ts.map +1 -0
  160. package/dist/commonjs/sdk/models/shared/titledeedpurchaseresponse.js +176 -0
  161. package/dist/commonjs/sdk/models/shared/titledeedpurchaseresponse.js.map +1 -0
  162. package/dist/commonjs/sdk/planningpolicy.d.ts +12 -0
  163. package/dist/commonjs/sdk/planningpolicy.d.ts.map +1 -0
  164. package/dist/commonjs/sdk/planningpolicy.js +22 -0
  165. package/dist/commonjs/sdk/planningpolicy.js.map +1 -0
  166. package/dist/commonjs/sdk/safety.d.ts +5 -4
  167. package/dist/commonjs/sdk/safety.d.ts.map +1 -1
  168. package/dist/commonjs/sdk/safety.js +2 -2
  169. package/dist/commonjs/sdk/safety.js.map +1 -1
  170. package/dist/commonjs/sdk/sdk.d.ts +6 -0
  171. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  172. package/dist/commonjs/sdk/sdk.js +8 -0
  173. package/dist/commonjs/sdk/sdk.js.map +1 -1
  174. package/dist/commonjs/sdk/titledeeds.d.ts +27 -0
  175. package/dist/commonjs/sdk/titledeeds.d.ts.map +1 -0
  176. package/dist/commonjs/sdk/titledeeds.js +42 -0
  177. package/dist/commonjs/sdk/titledeeds.js.map +1 -0
  178. package/dist/esm/funcs/planningPolicySearch.d.ts +18 -0
  179. package/dist/esm/funcs/planningPolicySearch.d.ts.map +1 -0
  180. package/dist/esm/funcs/planningPolicySearch.js +89 -0
  181. package/dist/esm/funcs/planningPolicySearch.js.map +1 -0
  182. package/dist/esm/funcs/safetyGetV1SafetyCrime.d.ts +3 -2
  183. package/dist/esm/funcs/safetyGetV1SafetyCrime.d.ts.map +1 -1
  184. package/dist/esm/funcs/safetyGetV1SafetyCrime.js +3 -2
  185. package/dist/esm/funcs/safetyGetV1SafetyCrime.js.map +1 -1
  186. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.d.ts +3 -2
  187. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.d.ts.map +1 -1
  188. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.js +3 -2
  189. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.js.map +1 -1
  190. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.d.ts +19 -0
  191. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.d.ts.map +1 -0
  192. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.js +92 -0
  193. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.js.map +1 -0
  194. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.d.ts +18 -0
  195. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.d.ts.map +1 -0
  196. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.js +101 -0
  197. package/dist/esm/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.js.map +1 -0
  198. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts +19 -0
  199. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts.map +1 -0
  200. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js +92 -0
  201. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js.map +1 -0
  202. package/dist/esm/hooks/registration.d.ts.map +1 -1
  203. package/dist/esm/hooks/registration.js.map +1 -1
  204. package/dist/esm/lib/config.d.ts +3 -3
  205. package/dist/esm/lib/config.js +3 -3
  206. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocuments.d.ts +266 -0
  207. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocuments.d.ts.map +1 -0
  208. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocuments.js +221 -0
  209. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocuments.js.map +1 -0
  210. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts +331 -0
  211. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts.map +1 -0
  212. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.js +267 -0
  213. package/dist/esm/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.js.map +1 -0
  214. package/dist/esm/sdk/models/errors/index.d.ts +5 -0
  215. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  216. package/dist/esm/sdk/models/errors/index.js +5 -0
  217. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  218. package/dist/esm/sdk/models/errors/insufficientcreditserror.d.ts +49 -0
  219. package/dist/esm/sdk/models/errors/insufficientcreditserror.d.ts.map +1 -0
  220. package/dist/esm/sdk/models/errors/insufficientcreditserror.js +59 -0
  221. package/dist/esm/sdk/models/errors/insufficientcreditserror.js.map +1 -0
  222. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts +266 -0
  223. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts.map +1 -0
  224. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.js +221 -0
  225. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.js.map +1 -0
  226. package/dist/esm/sdk/models/errors/searchplanningpolicy.d.ts +65 -0
  227. package/dist/esm/sdk/models/errors/searchplanningpolicy.d.ts.map +1 -0
  228. package/dist/esm/sdk/models/errors/searchplanningpolicy.js +81 -0
  229. package/dist/esm/sdk/models/errors/searchplanningpolicy.js.map +1 -0
  230. package/dist/esm/sdk/models/operations/getareacoverage.d.ts +4 -4
  231. package/dist/esm/sdk/models/operations/getareacoverage.d.ts.map +1 -1
  232. package/dist/esm/sdk/models/operations/getareacoverage.js +3 -3
  233. package/dist/esm/sdk/models/operations/getareacoverage.js.map +1 -1
  234. package/dist/esm/sdk/models/operations/getepcbylocationid.d.ts +29 -1
  235. package/dist/esm/sdk/models/operations/getepcbylocationid.d.ts.map +1 -1
  236. package/dist/esm/sdk/models/operations/getepcbylocationid.js +17 -1
  237. package/dist/esm/sdk/models/operations/getepcbylocationid.js.map +1 -1
  238. package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts +8 -8
  239. package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts.map +1 -1
  240. package/dist/esm/sdk/models/operations/getschoolmetrics.js +12 -13
  241. package/dist/esm/sdk/models/operations/getschoolmetrics.js.map +1 -1
  242. package/dist/esm/sdk/models/operations/getv1safetycrime.d.ts +4 -93
  243. package/dist/esm/sdk/models/operations/getv1safetycrime.d.ts.map +1 -1
  244. package/dist/esm/sdk/models/operations/getv1safetycrime.js +0 -39
  245. package/dist/esm/sdk/models/operations/getv1safetycrime.js.map +1 -1
  246. package/dist/esm/sdk/models/operations/getv1safetycrimestats.d.ts +4 -95
  247. package/dist/esm/sdk/models/operations/getv1safetycrimestats.d.ts.map +1 -1
  248. package/dist/esm/sdk/models/operations/getv1safetycrimestats.js +0 -48
  249. package/dist/esm/sdk/models/operations/getv1safetycrimestats.js.map +1 -1
  250. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocuments.d.ts +12 -0
  251. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocuments.d.ts.map +1 -0
  252. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocuments.js +12 -0
  253. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocuments.js.map +1 -0
  254. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts +32 -0
  255. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.d.ts.map +1 -0
  256. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.js +23 -0
  257. package/dist/esm/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.js.map +1 -0
  258. package/dist/esm/sdk/models/operations/index.d.ts +4 -0
  259. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  260. package/dist/esm/sdk/models/operations/index.js +4 -0
  261. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  262. package/dist/esm/sdk/models/operations/postv1titledeedstitlenumberpurchase.d.ts +12 -0
  263. package/dist/esm/sdk/models/operations/postv1titledeedstitlenumberpurchase.d.ts.map +1 -0
  264. package/dist/esm/sdk/models/operations/postv1titledeedstitlenumberpurchase.js +12 -0
  265. package/dist/esm/sdk/models/operations/postv1titledeedstitlenumberpurchase.js.map +1 -0
  266. package/dist/esm/sdk/models/operations/searchplanningpolicy.d.ts +123 -0
  267. package/dist/esm/sdk/models/operations/searchplanningpolicy.d.ts.map +1 -0
  268. package/dist/esm/sdk/models/operations/searchplanningpolicy.js +117 -0
  269. package/dist/esm/sdk/models/operations/searchplanningpolicy.js.map +1 -0
  270. package/dist/esm/sdk/models/shared/aggregationresult.d.ts +3 -1
  271. package/dist/esm/sdk/models/shared/aggregationresult.d.ts.map +1 -1
  272. package/dist/esm/sdk/models/shared/aggregationresult.js +4 -0
  273. package/dist/esm/sdk/models/shared/aggregationresult.js.map +1 -1
  274. package/dist/esm/sdk/models/shared/areastatsresponse.d.ts +66 -0
  275. package/dist/esm/sdk/models/shared/areastatsresponse.d.ts.map +1 -0
  276. package/dist/esm/sdk/models/shared/areastatsresponse.js +54 -0
  277. package/dist/esm/sdk/models/shared/areastatsresponse.js.map +1 -0
  278. package/dist/esm/sdk/models/shared/avmanalysisresponse.d.ts +4 -4
  279. package/dist/esm/sdk/models/shared/avmanalysisresponse.d.ts.map +1 -1
  280. package/dist/esm/sdk/models/shared/avmanalysisresponse.js +3 -3
  281. package/dist/esm/sdk/models/shared/avmanalysisresponse.js.map +1 -1
  282. package/dist/esm/sdk/models/shared/crimedataresponse.d.ts +35 -0
  283. package/dist/esm/sdk/models/shared/crimedataresponse.d.ts.map +1 -0
  284. package/dist/esm/sdk/models/shared/crimedataresponse.js +25 -0
  285. package/dist/esm/sdk/models/shared/crimedataresponse.js.map +1 -0
  286. package/dist/esm/sdk/models/shared/crimerecord.d.ts +37 -0
  287. package/dist/esm/sdk/models/shared/crimerecord.d.ts.map +1 -0
  288. package/dist/esm/sdk/models/shared/crimerecord.js +19 -0
  289. package/dist/esm/sdk/models/shared/crimerecord.js.map +1 -0
  290. package/dist/esm/sdk/models/shared/extendedstatsaggregationresult.d.ts +75 -0
  291. package/dist/esm/sdk/models/shared/extendedstatsaggregationresult.d.ts.map +1 -0
  292. package/dist/esm/sdk/models/shared/extendedstatsaggregationresult.js +55 -0
  293. package/dist/esm/sdk/models/shared/extendedstatsaggregationresult.js.map +1 -0
  294. package/dist/esm/sdk/models/shared/index.d.ts +9 -0
  295. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  296. package/dist/esm/sdk/models/shared/index.js +9 -0
  297. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  298. package/dist/esm/sdk/models/shared/nearestpostcodesresponse.d.ts +4 -4
  299. package/dist/esm/sdk/models/shared/nearestpostcodesresponse.d.ts.map +1 -1
  300. package/dist/esm/sdk/models/shared/nearestpostcodesresponse.js +4 -5
  301. package/dist/esm/sdk/models/shared/nearestpostcodesresponse.js.map +1 -1
  302. package/dist/esm/sdk/models/shared/percentilesaggregationresult.d.ts +15 -0
  303. package/dist/esm/sdk/models/shared/percentilesaggregationresult.d.ts.map +1 -0
  304. package/dist/esm/sdk/models/shared/percentilesaggregationresult.js +13 -0
  305. package/dist/esm/sdk/models/shared/percentilesaggregationresult.js.map +1 -0
  306. package/dist/esm/sdk/models/shared/site.d.ts +15 -10
  307. package/dist/esm/sdk/models/shared/site.d.ts.map +1 -1
  308. package/dist/esm/sdk/models/shared/site.js +8 -6
  309. package/dist/esm/sdk/models/shared/site.js.map +1 -1
  310. package/dist/esm/sdk/models/shared/sitefilters.d.ts +15 -0
  311. package/dist/esm/sdk/models/shared/sitefilters.d.ts.map +1 -1
  312. package/dist/esm/sdk/models/shared/sitefilters.js +3 -0
  313. package/dist/esm/sdk/models/shared/sitefilters.js.map +1 -1
  314. package/dist/esm/sdk/models/shared/siteownership.d.ts +41 -0
  315. package/dist/esm/sdk/models/shared/siteownership.d.ts.map +1 -0
  316. package/dist/esm/sdk/models/shared/siteownership.js +20 -0
  317. package/dist/esm/sdk/models/shared/siteownership.js.map +1 -0
  318. package/dist/esm/sdk/models/shared/siteproprietor.d.ts +33 -0
  319. package/dist/esm/sdk/models/shared/siteproprietor.d.ts.map +1 -0
  320. package/dist/esm/sdk/models/shared/siteproprietor.js +18 -0
  321. package/dist/esm/sdk/models/shared/siteproprietor.js.map +1 -0
  322. package/dist/esm/sdk/models/shared/sitequerycondition.d.ts +0 -1
  323. package/dist/esm/sdk/models/shared/sitequerycondition.d.ts.map +1 -1
  324. package/dist/esm/sdk/models/shared/sitequerycondition.js +0 -1
  325. package/dist/esm/sdk/models/shared/sitequerycondition.js.map +1 -1
  326. package/dist/esm/sdk/models/shared/sitequeryrequest.d.ts +0 -3
  327. package/dist/esm/sdk/models/shared/sitequeryrequest.d.ts.map +1 -1
  328. package/dist/esm/sdk/models/shared/sitequeryrequest.js +0 -3
  329. package/dist/esm/sdk/models/shared/sitequeryrequest.js.map +1 -1
  330. package/dist/esm/sdk/models/shared/titledeeddocumentlistresponse.d.ts +76 -0
  331. package/dist/esm/sdk/models/shared/titledeeddocumentlistresponse.d.ts.map +1 -0
  332. package/dist/esm/sdk/models/shared/titledeeddocumentlistresponse.js +66 -0
  333. package/dist/esm/sdk/models/shared/titledeeddocumentlistresponse.js.map +1 -0
  334. package/dist/esm/sdk/models/shared/titledeedpurchaseresponse.d.ts +205 -0
  335. package/dist/esm/sdk/models/shared/titledeedpurchaseresponse.d.ts.map +1 -0
  336. package/dist/esm/sdk/models/shared/titledeedpurchaseresponse.js +133 -0
  337. package/dist/esm/sdk/models/shared/titledeedpurchaseresponse.js.map +1 -0
  338. package/dist/esm/sdk/planningpolicy.d.ts +12 -0
  339. package/dist/esm/sdk/planningpolicy.d.ts.map +1 -0
  340. package/dist/esm/sdk/planningpolicy.js +18 -0
  341. package/dist/esm/sdk/planningpolicy.js.map +1 -0
  342. package/dist/esm/sdk/safety.d.ts +5 -4
  343. package/dist/esm/sdk/safety.d.ts.map +1 -1
  344. package/dist/esm/sdk/safety.js +2 -2
  345. package/dist/esm/sdk/safety.js.map +1 -1
  346. package/dist/esm/sdk/sdk.d.ts +6 -0
  347. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  348. package/dist/esm/sdk/sdk.js +8 -0
  349. package/dist/esm/sdk/sdk.js.map +1 -1
  350. package/dist/esm/sdk/titledeeds.d.ts +27 -0
  351. package/dist/esm/sdk/titledeeds.d.ts.map +1 -0
  352. package/dist/esm/sdk/titledeeds.js +38 -0
  353. package/dist/esm/sdk/titledeeds.js.map +1 -0
  354. package/package.json +1 -1
  355. package/src/funcs/planningPolicySearch.ts +185 -0
  356. package/src/funcs/safetyGetV1SafetyCrime.ts +6 -5
  357. package/src/funcs/safetyGetV1SafetyCrimeStats.ts +6 -5
  358. package/src/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.ts +207 -0
  359. package/src/funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.ts +223 -0
  360. package/src/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.ts +209 -0
  361. package/src/hooks/registration.ts +1 -4
  362. package/src/lib/config.ts +3 -3
  363. package/src/sdk/models/errors/getv1titledeedstitlenumberdocuments.ts +576 -0
  364. package/src/sdk/models/errors/getv1titledeedstitlenumberdocumentsdocumenttype.ts +750 -0
  365. package/src/sdk/models/errors/index.ts +5 -0
  366. package/src/sdk/models/errors/insufficientcreditserror.ts +115 -0
  367. package/src/sdk/models/errors/postv1titledeedstitlenumberpurchase.ts +576 -0
  368. package/src/sdk/models/errors/searchplanningpolicy.ts +174 -0
  369. package/src/sdk/models/operations/getareacoverage.ts +9 -7
  370. package/src/sdk/models/operations/getepcbylocationid.ts +54 -2
  371. package/src/sdk/models/operations/getschoolmetrics.ts +39 -32
  372. package/src/sdk/models/operations/getv1safetycrime.ts +4 -167
  373. package/src/sdk/models/operations/getv1safetycrimestats.ts +4 -176
  374. package/src/sdk/models/operations/getv1titledeedstitlenumberdocuments.ts +35 -0
  375. package/src/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.ts +59 -0
  376. package/src/sdk/models/operations/index.ts +4 -0
  377. package/src/sdk/models/operations/postv1titledeedstitlenumberpurchase.ts +35 -0
  378. package/src/sdk/models/operations/searchplanningpolicy.ts +274 -0
  379. package/src/sdk/models/shared/aggregationresult.ts +12 -0
  380. package/src/sdk/models/shared/areastatsresponse.ts +147 -0
  381. package/src/sdk/models/shared/avmanalysisresponse.ts +11 -6
  382. package/src/sdk/models/shared/crimedataresponse.ts +75 -0
  383. package/src/sdk/models/shared/crimerecord.ts +64 -0
  384. package/src/sdk/models/shared/extendedstatsaggregationresult.ts +150 -0
  385. package/src/sdk/models/shared/index.ts +9 -0
  386. package/src/sdk/models/shared/nearestpostcodesresponse.ts +20 -19
  387. package/src/sdk/models/shared/percentilesaggregationresult.ts +34 -0
  388. package/src/sdk/models/shared/site.ts +22 -16
  389. package/src/sdk/models/shared/sitefilters.ts +18 -0
  390. package/src/sdk/models/shared/siteownership.ts +71 -0
  391. package/src/sdk/models/shared/siteproprietor.ts +59 -0
  392. package/src/sdk/models/shared/sitequerycondition.ts +0 -1
  393. package/src/sdk/models/shared/sitequeryrequest.ts +0 -3
  394. package/src/sdk/models/shared/titledeeddocumentlistresponse.ts +155 -0
  395. package/src/sdk/models/shared/titledeedpurchaseresponse.ts +406 -0
  396. package/src/sdk/planningpolicy.ts +27 -0
  397. package/src/sdk/safety.ts +5 -4
  398. package/src/sdk/sdk.ts +12 -0
  399. package/src/sdk/titledeeds.ts +66 -0
  400. package/examples/package.json +0 -18
  401. package/openapi.json +0 -11986
  402. package/tsconfig.json +0 -40
@@ -0,0 +1,750 @@
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
+ * Error type category
16
+ */
17
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Type =
18
+ {
19
+ ApiError: "api_error",
20
+ InvalidRequestError: "invalid_request_error",
21
+ AuthenticationError: "authentication_error",
22
+ RateLimitError: "rate_limit_error",
23
+ } as const;
24
+ /**
25
+ * Error type category
26
+ */
27
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Type =
28
+ OpenEnum<
29
+ typeof GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Type
30
+ >;
31
+
32
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Error =
33
+ {
34
+ /**
35
+ * Machine-readable error code
36
+ */
37
+ code?: string | undefined;
38
+ /**
39
+ * URL to relevant documentation
40
+ */
41
+ docUrl?: string | undefined;
42
+ /**
43
+ * Human-readable error message
44
+ */
45
+ message: string;
46
+ /**
47
+ * Parameter that caused the error
48
+ */
49
+ param?: string | undefined;
50
+ /**
51
+ * Suggested corrections (e.g. postcode typo suggestions)
52
+ */
53
+ suggestions?: Array<string> | undefined;
54
+ /**
55
+ * Error type category
56
+ */
57
+ type:
58
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Type;
59
+ };
60
+
61
+ /**
62
+ * Error response
63
+ */
64
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500ResponseBodyData =
65
+ {
66
+ error:
67
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Error;
68
+ };
69
+
70
+ /**
71
+ * Error response
72
+ */
73
+ export class GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500ResponseBody
74
+ extends SDKBaseError
75
+ {
76
+ error:
77
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Error;
78
+
79
+ /** The original data that was passed to this error instance. */
80
+ data$:
81
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500ResponseBodyData;
82
+
83
+ constructor(
84
+ err:
85
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500ResponseBodyData,
86
+ httpMeta: { response: Response; request: Request; body: string },
87
+ ) {
88
+ const message = err.error?.message
89
+ || `API error occurred: ${JSON.stringify(err)}`;
90
+ super(message, httpMeta);
91
+ this.data$ = err;
92
+ this.error = err.error;
93
+
94
+ this.name =
95
+ "GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500ResponseBody";
96
+ }
97
+ }
98
+
99
+ /**
100
+ * Error type category
101
+ */
102
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Type =
103
+ {
104
+ ApiError: "api_error",
105
+ InvalidRequestError: "invalid_request_error",
106
+ AuthenticationError: "authentication_error",
107
+ RateLimitError: "rate_limit_error",
108
+ } as const;
109
+ /**
110
+ * Error type category
111
+ */
112
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Type =
113
+ OpenEnum<
114
+ typeof GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Type
115
+ >;
116
+
117
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Error =
118
+ {
119
+ /**
120
+ * Machine-readable error code
121
+ */
122
+ code?: string | undefined;
123
+ /**
124
+ * URL to relevant documentation
125
+ */
126
+ docUrl?: string | undefined;
127
+ /**
128
+ * Human-readable error message
129
+ */
130
+ message: string;
131
+ /**
132
+ * Parameter that caused the error
133
+ */
134
+ param?: string | undefined;
135
+ /**
136
+ * Suggested corrections (e.g. postcode typo suggestions)
137
+ */
138
+ suggestions?: Array<string> | undefined;
139
+ /**
140
+ * Error type category
141
+ */
142
+ type:
143
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Type;
144
+ };
145
+
146
+ /**
147
+ * Error response
148
+ */
149
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404ResponseBodyData =
150
+ {
151
+ error:
152
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Error;
153
+ };
154
+
155
+ /**
156
+ * Error response
157
+ */
158
+ export class GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404ResponseBody
159
+ extends SDKBaseError
160
+ {
161
+ error:
162
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Error;
163
+
164
+ /** The original data that was passed to this error instance. */
165
+ data$:
166
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404ResponseBodyData;
167
+
168
+ constructor(
169
+ err:
170
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404ResponseBodyData,
171
+ httpMeta: { response: Response; request: Request; body: string },
172
+ ) {
173
+ const message = err.error?.message
174
+ || `API error occurred: ${JSON.stringify(err)}`;
175
+ super(message, httpMeta);
176
+ this.data$ = err;
177
+ this.error = err.error;
178
+
179
+ this.name =
180
+ "GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404ResponseBody";
181
+ }
182
+ }
183
+
184
+ /**
185
+ * Error type category
186
+ */
187
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseType =
188
+ {
189
+ ApiError: "api_error",
190
+ InvalidRequestError: "invalid_request_error",
191
+ AuthenticationError: "authentication_error",
192
+ RateLimitError: "rate_limit_error",
193
+ } as const;
194
+ /**
195
+ * Error type category
196
+ */
197
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseType =
198
+ OpenEnum<
199
+ typeof GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseType
200
+ >;
201
+
202
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseError =
203
+ {
204
+ /**
205
+ * Machine-readable error code
206
+ */
207
+ code?: string | undefined;
208
+ /**
209
+ * URL to relevant documentation
210
+ */
211
+ docUrl?: string | undefined;
212
+ /**
213
+ * Human-readable error message
214
+ */
215
+ message: string;
216
+ /**
217
+ * Parameter that caused the error
218
+ */
219
+ param?: string | undefined;
220
+ /**
221
+ * Suggested corrections (e.g. postcode typo suggestions)
222
+ */
223
+ suggestions?: Array<string> | undefined;
224
+ /**
225
+ * Error type category
226
+ */
227
+ type: GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseType;
228
+ };
229
+
230
+ /**
231
+ * Error response
232
+ */
233
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseResponseBodyData =
234
+ {
235
+ error:
236
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseError;
237
+ };
238
+
239
+ /**
240
+ * Error response
241
+ */
242
+ export class GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseResponseBody
243
+ extends SDKBaseError
244
+ {
245
+ error: GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseError;
246
+
247
+ /** The original data that was passed to this error instance. */
248
+ data$:
249
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseResponseBodyData;
250
+
251
+ constructor(
252
+ err:
253
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseResponseBodyData,
254
+ httpMeta: { response: Response; request: Request; body: string },
255
+ ) {
256
+ const message = err.error?.message
257
+ || `API error occurred: ${JSON.stringify(err)}`;
258
+ super(message, httpMeta);
259
+ this.data$ = err;
260
+ this.error = err.error;
261
+
262
+ this.name =
263
+ "GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseResponseBody";
264
+ }
265
+ }
266
+
267
+ /**
268
+ * Error type category
269
+ */
270
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsType = {
271
+ ApiError: "api_error",
272
+ InvalidRequestError: "invalid_request_error",
273
+ AuthenticationError: "authentication_error",
274
+ RateLimitError: "rate_limit_error",
275
+ } as const;
276
+ /**
277
+ * Error type category
278
+ */
279
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsType =
280
+ OpenEnum<
281
+ typeof GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsType
282
+ >;
283
+
284
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsError = {
285
+ /**
286
+ * Machine-readable error code
287
+ */
288
+ code?: string | undefined;
289
+ /**
290
+ * URL to relevant documentation
291
+ */
292
+ docUrl?: string | undefined;
293
+ /**
294
+ * Human-readable error message
295
+ */
296
+ message: string;
297
+ /**
298
+ * Parameter that caused the error
299
+ */
300
+ param?: string | undefined;
301
+ /**
302
+ * Suggested corrections (e.g. postcode typo suggestions)
303
+ */
304
+ suggestions?: Array<string> | undefined;
305
+ /**
306
+ * Error type category
307
+ */
308
+ type: GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsType;
309
+ };
310
+
311
+ /**
312
+ * Error response
313
+ */
314
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseBodyData =
315
+ {
316
+ error: GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsError;
317
+ };
318
+
319
+ /**
320
+ * Error response
321
+ */
322
+ export class GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseBody
323
+ extends SDKBaseError
324
+ {
325
+ error: GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsError;
326
+
327
+ /** The original data that was passed to this error instance. */
328
+ data$:
329
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseBodyData;
330
+
331
+ constructor(
332
+ err:
333
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseBodyData,
334
+ httpMeta: { response: Response; request: Request; body: string },
335
+ ) {
336
+ const message = err.error?.message
337
+ || `API error occurred: ${JSON.stringify(err)}`;
338
+ super(message, httpMeta);
339
+ this.data$ = err;
340
+ this.error = err.error;
341
+
342
+ this.name =
343
+ "GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseBody";
344
+ }
345
+ }
346
+
347
+ /**
348
+ * Error type category
349
+ */
350
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeType = {
351
+ ApiError: "api_error",
352
+ InvalidRequestError: "invalid_request_error",
353
+ AuthenticationError: "authentication_error",
354
+ RateLimitError: "rate_limit_error",
355
+ } as const;
356
+ /**
357
+ * Error type category
358
+ */
359
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeType = OpenEnum<
360
+ typeof GetV1TitleDeedsTitleNumberDocumentsDocumentTypeType
361
+ >;
362
+
363
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeError = {
364
+ /**
365
+ * Machine-readable error code
366
+ */
367
+ code?: string | undefined;
368
+ /**
369
+ * URL to relevant documentation
370
+ */
371
+ docUrl?: string | undefined;
372
+ /**
373
+ * Human-readable error message
374
+ */
375
+ message: string;
376
+ /**
377
+ * Parameter that caused the error
378
+ */
379
+ param?: string | undefined;
380
+ /**
381
+ * Suggested corrections (e.g. postcode typo suggestions)
382
+ */
383
+ suggestions?: Array<string> | undefined;
384
+ /**
385
+ * Error type category
386
+ */
387
+ type: GetV1TitleDeedsTitleNumberDocumentsDocumentTypeType;
388
+ };
389
+
390
+ /**
391
+ * Error response
392
+ */
393
+ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeResponseBodyData = {
394
+ error: GetV1TitleDeedsTitleNumberDocumentsDocumentTypeError;
395
+ };
396
+
397
+ /**
398
+ * Error response
399
+ */
400
+ export class GetV1TitleDeedsTitleNumberDocumentsDocumentTypeResponseBody
401
+ extends SDKBaseError
402
+ {
403
+ error: GetV1TitleDeedsTitleNumberDocumentsDocumentTypeError;
404
+
405
+ /** The original data that was passed to this error instance. */
406
+ data$: GetV1TitleDeedsTitleNumberDocumentsDocumentTypeResponseBodyData;
407
+
408
+ constructor(
409
+ err: GetV1TitleDeedsTitleNumberDocumentsDocumentTypeResponseBodyData,
410
+ httpMeta: { response: Response; request: Request; body: string },
411
+ ) {
412
+ const message = err.error?.message
413
+ || `API error occurred: ${JSON.stringify(err)}`;
414
+ super(message, httpMeta);
415
+ this.data$ = err;
416
+ this.error = err.error;
417
+
418
+ this.name = "GetV1TitleDeedsTitleNumberDocumentsDocumentTypeResponseBody";
419
+ }
420
+ }
421
+
422
+ /** @internal */
423
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Type$inboundSchema:
424
+ z.ZodType<
425
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Type,
426
+ z.ZodTypeDef,
427
+ unknown
428
+ > = openEnums.inboundSchema(
429
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Type,
430
+ );
431
+
432
+ /** @internal */
433
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Error$inboundSchema:
434
+ z.ZodType<
435
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Error,
436
+ z.ZodTypeDef,
437
+ unknown
438
+ > = z.object({
439
+ code: z.string().optional(),
440
+ doc_url: z.string().optional(),
441
+ message: z.string(),
442
+ param: z.string().optional(),
443
+ suggestions: z.array(z.string()).optional(),
444
+ type:
445
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Type$inboundSchema,
446
+ }).transform((v) => {
447
+ return remap$(v, {
448
+ "doc_url": "docUrl",
449
+ });
450
+ });
451
+
452
+ export function getV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500ErrorFromJSON(
453
+ jsonString: string,
454
+ ): SafeParseResult<
455
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Error,
456
+ SDKValidationError
457
+ > {
458
+ return safeParse(
459
+ jsonString,
460
+ (x) =>
461
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Error$inboundSchema
462
+ .parse(JSON.parse(x)),
463
+ `Failed to parse 'GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Error' from JSON`,
464
+ );
465
+ }
466
+
467
+ /** @internal */
468
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500ResponseBody$inboundSchema:
469
+ z.ZodType<
470
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500ResponseBody,
471
+ z.ZodTypeDef,
472
+ unknown
473
+ > = z.object({
474
+ error: z.lazy(() =>
475
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500Error$inboundSchema
476
+ ),
477
+ request$: z.instanceof(Request),
478
+ response$: z.instanceof(Response),
479
+ body$: z.string(),
480
+ })
481
+ .transform((v) => {
482
+ return new GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse500ResponseBody(
483
+ v,
484
+ { request: v.request$, response: v.response$, body: v.body$ },
485
+ );
486
+ });
487
+
488
+ /** @internal */
489
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Type$inboundSchema:
490
+ z.ZodType<
491
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Type,
492
+ z.ZodTypeDef,
493
+ unknown
494
+ > = openEnums.inboundSchema(
495
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Type,
496
+ );
497
+
498
+ /** @internal */
499
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Error$inboundSchema:
500
+ z.ZodType<
501
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Error,
502
+ z.ZodTypeDef,
503
+ unknown
504
+ > = z.object({
505
+ code: z.string().optional(),
506
+ doc_url: z.string().optional(),
507
+ message: z.string(),
508
+ param: z.string().optional(),
509
+ suggestions: z.array(z.string()).optional(),
510
+ type:
511
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Type$inboundSchema,
512
+ }).transform((v) => {
513
+ return remap$(v, {
514
+ "doc_url": "docUrl",
515
+ });
516
+ });
517
+
518
+ export function getV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404ErrorFromJSON(
519
+ jsonString: string,
520
+ ): SafeParseResult<
521
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Error,
522
+ SDKValidationError
523
+ > {
524
+ return safeParse(
525
+ jsonString,
526
+ (x) =>
527
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Error$inboundSchema
528
+ .parse(JSON.parse(x)),
529
+ `Failed to parse 'GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Error' from JSON`,
530
+ );
531
+ }
532
+
533
+ /** @internal */
534
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404ResponseBody$inboundSchema:
535
+ z.ZodType<
536
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404ResponseBody,
537
+ z.ZodTypeDef,
538
+ unknown
539
+ > = z.object({
540
+ error: z.lazy(() =>
541
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404Error$inboundSchema
542
+ ),
543
+ request$: z.instanceof(Request),
544
+ response$: z.instanceof(Response),
545
+ body$: z.string(),
546
+ })
547
+ .transform((v) => {
548
+ return new GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponse404ResponseBody(
549
+ v,
550
+ { request: v.request$, response: v.response$, body: v.body$ },
551
+ );
552
+ });
553
+
554
+ /** @internal */
555
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseType$inboundSchema:
556
+ z.ZodType<
557
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseType,
558
+ z.ZodTypeDef,
559
+ unknown
560
+ > = openEnums.inboundSchema(
561
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseType,
562
+ );
563
+
564
+ /** @internal */
565
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseError$inboundSchema:
566
+ z.ZodType<
567
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseError,
568
+ z.ZodTypeDef,
569
+ unknown
570
+ > = z.object({
571
+ code: z.string().optional(),
572
+ doc_url: z.string().optional(),
573
+ message: z.string(),
574
+ param: z.string().optional(),
575
+ suggestions: z.array(z.string()).optional(),
576
+ type:
577
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseType$inboundSchema,
578
+ }).transform((v) => {
579
+ return remap$(v, {
580
+ "doc_url": "docUrl",
581
+ });
582
+ });
583
+
584
+ export function getV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseErrorFromJSON(
585
+ jsonString: string,
586
+ ): SafeParseResult<
587
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseError,
588
+ SDKValidationError
589
+ > {
590
+ return safeParse(
591
+ jsonString,
592
+ (x) =>
593
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseError$inboundSchema
594
+ .parse(JSON.parse(x)),
595
+ `Failed to parse 'GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseError' from JSON`,
596
+ );
597
+ }
598
+
599
+ /** @internal */
600
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseResponseBody$inboundSchema:
601
+ z.ZodType<
602
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseResponseBody,
603
+ z.ZodTypeDef,
604
+ unknown
605
+ > = z.object({
606
+ error: z.lazy(() =>
607
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseError$inboundSchema
608
+ ),
609
+ request$: z.instanceof(Request),
610
+ response$: z.instanceof(Response),
611
+ body$: z.string(),
612
+ })
613
+ .transform((v) => {
614
+ return new GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseResponseBody(
615
+ v,
616
+ { request: v.request$, response: v.response$, body: v.body$ },
617
+ );
618
+ });
619
+
620
+ /** @internal */
621
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsType$inboundSchema:
622
+ z.ZodType<
623
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsType,
624
+ z.ZodTypeDef,
625
+ unknown
626
+ > = openEnums.inboundSchema(
627
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsType,
628
+ );
629
+
630
+ /** @internal */
631
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsError$inboundSchema:
632
+ z.ZodType<
633
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsError,
634
+ z.ZodTypeDef,
635
+ unknown
636
+ > = z.object({
637
+ code: z.string().optional(),
638
+ doc_url: z.string().optional(),
639
+ message: z.string(),
640
+ param: z.string().optional(),
641
+ suggestions: z.array(z.string()).optional(),
642
+ type:
643
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsType$inboundSchema,
644
+ }).transform((v) => {
645
+ return remap$(v, {
646
+ "doc_url": "docUrl",
647
+ });
648
+ });
649
+
650
+ export function getV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsErrorFromJSON(
651
+ jsonString: string,
652
+ ): SafeParseResult<
653
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsError,
654
+ SDKValidationError
655
+ > {
656
+ return safeParse(
657
+ jsonString,
658
+ (x) =>
659
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsError$inboundSchema
660
+ .parse(JSON.parse(x)),
661
+ `Failed to parse 'GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsError' from JSON`,
662
+ );
663
+ }
664
+
665
+ /** @internal */
666
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseBody$inboundSchema:
667
+ z.ZodType<
668
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseBody,
669
+ z.ZodTypeDef,
670
+ unknown
671
+ > = z.object({
672
+ error: z.lazy(() =>
673
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsError$inboundSchema
674
+ ),
675
+ request$: z.instanceof(Request),
676
+ response$: z.instanceof(Response),
677
+ body$: z.string(),
678
+ })
679
+ .transform((v) => {
680
+ return new GetV1TitleDeedsTitleNumberDocumentsDocumentTypeTitleDeedsResponseBody(
681
+ v,
682
+ { request: v.request$, response: v.response$, body: v.body$ },
683
+ );
684
+ });
685
+
686
+ /** @internal */
687
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeType$inboundSchema:
688
+ z.ZodType<
689
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeType,
690
+ z.ZodTypeDef,
691
+ unknown
692
+ > = openEnums.inboundSchema(
693
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeType,
694
+ );
695
+
696
+ /** @internal */
697
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeError$inboundSchema:
698
+ z.ZodType<
699
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeError,
700
+ z.ZodTypeDef,
701
+ unknown
702
+ > = z.object({
703
+ code: z.string().optional(),
704
+ doc_url: z.string().optional(),
705
+ message: z.string(),
706
+ param: z.string().optional(),
707
+ suggestions: z.array(z.string()).optional(),
708
+ type: GetV1TitleDeedsTitleNumberDocumentsDocumentTypeType$inboundSchema,
709
+ }).transform((v) => {
710
+ return remap$(v, {
711
+ "doc_url": "docUrl",
712
+ });
713
+ });
714
+
715
+ export function getV1TitleDeedsTitleNumberDocumentsDocumentTypeErrorFromJSON(
716
+ jsonString: string,
717
+ ): SafeParseResult<
718
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeError,
719
+ SDKValidationError
720
+ > {
721
+ return safeParse(
722
+ jsonString,
723
+ (x) =>
724
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeError$inboundSchema.parse(
725
+ JSON.parse(x),
726
+ ),
727
+ `Failed to parse 'GetV1TitleDeedsTitleNumberDocumentsDocumentTypeError' from JSON`,
728
+ );
729
+ }
730
+
731
+ /** @internal */
732
+ export const GetV1TitleDeedsTitleNumberDocumentsDocumentTypeResponseBody$inboundSchema:
733
+ z.ZodType<
734
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeResponseBody,
735
+ z.ZodTypeDef,
736
+ unknown
737
+ > = z.object({
738
+ error: z.lazy(() =>
739
+ GetV1TitleDeedsTitleNumberDocumentsDocumentTypeError$inboundSchema
740
+ ),
741
+ request$: z.instanceof(Request),
742
+ response$: z.instanceof(Response),
743
+ body$: z.string(),
744
+ })
745
+ .transform((v) => {
746
+ return new GetV1TitleDeedsTitleNumberDocumentsDocumentTypeResponseBody(
747
+ v,
748
+ { request: v.request$, response: v.response$, body: v.body$ },
749
+ );
750
+ });