@vepler/sdk 2.167.0 → 3.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 (582) hide show
  1. package/README.md +408 -402
  2. package/dist/commonjs/address-search/__tests__/controller.test.d.ts +2 -0
  3. package/dist/commonjs/address-search/__tests__/controller.test.d.ts.map +1 -0
  4. package/dist/commonjs/address-search/__tests__/controller.test.js +329 -0
  5. package/dist/commonjs/address-search/__tests__/controller.test.js.map +1 -0
  6. package/dist/commonjs/address-search/__tests__/default-transports.test.d.ts +2 -0
  7. package/dist/commonjs/address-search/__tests__/default-transports.test.d.ts.map +1 -0
  8. package/dist/commonjs/address-search/__tests__/default-transports.test.js +161 -0
  9. package/dist/commonjs/address-search/__tests__/default-transports.test.js.map +1 -0
  10. package/dist/commonjs/address-search/__tests__/narrow.test.d.ts +2 -0
  11. package/dist/commonjs/address-search/__tests__/narrow.test.d.ts.map +1 -0
  12. package/dist/commonjs/address-search/__tests__/narrow.test.js +63 -0
  13. package/dist/commonjs/address-search/__tests__/narrow.test.js.map +1 -0
  14. package/dist/commonjs/address-search/controller.d.ts +14 -0
  15. package/dist/commonjs/address-search/controller.d.ts.map +1 -0
  16. package/dist/commonjs/address-search/controller.js +190 -0
  17. package/dist/commonjs/address-search/controller.js.map +1 -0
  18. package/dist/commonjs/address-search/default-transports.d.ts +52 -0
  19. package/dist/commonjs/address-search/default-transports.d.ts.map +1 -0
  20. package/dist/commonjs/address-search/default-transports.js +134 -0
  21. package/dist/commonjs/address-search/default-transports.js.map +1 -0
  22. package/dist/commonjs/address-search/errors.d.ts +5 -0
  23. package/dist/commonjs/address-search/errors.d.ts.map +1 -0
  24. package/dist/commonjs/address-search/errors.js +12 -0
  25. package/dist/commonjs/address-search/errors.js.map +1 -0
  26. package/dist/commonjs/address-search/index.d.ts +8 -0
  27. package/dist/commonjs/address-search/index.d.ts.map +1 -0
  28. package/dist/commonjs/address-search/index.js +43 -0
  29. package/dist/commonjs/address-search/index.js.map +1 -0
  30. package/dist/commonjs/address-search/lru-cache.d.ts +13 -0
  31. package/dist/commonjs/address-search/lru-cache.d.ts.map +1 -0
  32. package/dist/commonjs/address-search/lru-cache.js +50 -0
  33. package/dist/commonjs/address-search/lru-cache.js.map +1 -0
  34. package/dist/commonjs/address-search/narrow.d.ts +21 -0
  35. package/dist/commonjs/address-search/narrow.d.ts.map +1 -0
  36. package/dist/commonjs/address-search/narrow.js +49 -0
  37. package/dist/commonjs/address-search/narrow.js.map +1 -0
  38. package/dist/commonjs/address-search/types.d.ts +125 -0
  39. package/dist/commonjs/address-search/types.d.ts.map +1 -0
  40. package/dist/commonjs/address-search/types.js +9 -0
  41. package/dist/commonjs/address-search/types.js.map +1 -0
  42. package/dist/commonjs/address-search.d.ts +3 -0
  43. package/dist/commonjs/address-search.d.ts.map +1 -0
  44. package/dist/commonjs/address-search.js +19 -0
  45. package/dist/commonjs/address-search.js.map +1 -0
  46. package/dist/commonjs/funcs/avmPredictPropertyValue.d.ts +1 -1
  47. package/dist/commonjs/funcs/avmPredictPropertyValue.d.ts.map +1 -1
  48. package/dist/commonjs/funcs/avmPredictPropertyValue.js +1 -1
  49. package/dist/commonjs/funcs/avmPredictPropertyValue.js.map +1 -1
  50. package/dist/commonjs/funcs/propertyGetProperties.js +1 -0
  51. package/dist/commonjs/funcs/propertyGetProperties.js.map +1 -1
  52. package/dist/commonjs/funcs/propertyGetPropertiesByLocation.js +1 -0
  53. package/dist/commonjs/funcs/propertyGetPropertiesByLocation.js.map +1 -1
  54. package/dist/commonjs/funcs/propertyGetPropertiesBySource.js +1 -0
  55. package/dist/commonjs/funcs/propertyGetPropertiesBySource.js.map +1 -1
  56. package/dist/commonjs/funcs/searchSearchRetrieve.d.ts +23 -0
  57. package/dist/commonjs/funcs/searchSearchRetrieve.d.ts.map +1 -0
  58. package/dist/commonjs/funcs/searchSearchRetrieve.js +128 -0
  59. package/dist/commonjs/funcs/searchSearchRetrieve.js.map +1 -0
  60. package/dist/commonjs/funcs/searchSearchSuggest.d.ts +3 -1
  61. package/dist/commonjs/funcs/searchSearchSuggest.d.ts.map +1 -1
  62. package/dist/commonjs/funcs/searchSearchSuggest.js +5 -1
  63. package/dist/commonjs/funcs/searchSearchSuggest.js.map +1 -1
  64. package/dist/commonjs/lib/config.d.ts +3 -3
  65. package/dist/commonjs/lib/config.js +3 -3
  66. package/dist/commonjs/lib/config.js.map +1 -1
  67. package/dist/commonjs/sdk/models/errors/index.d.ts +1 -0
  68. package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
  69. package/dist/commonjs/sdk/models/errors/index.js +1 -0
  70. package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
  71. package/dist/commonjs/sdk/models/errors/predictpropertyvalue.d.ts +65 -0
  72. package/dist/commonjs/sdk/models/errors/predictpropertyvalue.d.ts.map +1 -1
  73. package/dist/commonjs/sdk/models/errors/predictpropertyvalue.js +57 -1
  74. package/dist/commonjs/sdk/models/errors/predictpropertyvalue.js.map +1 -1
  75. package/dist/commonjs/sdk/models/errors/searchretrieve.d.ts +201 -0
  76. package/dist/commonjs/sdk/models/errors/searchretrieve.d.ts.map +1 -0
  77. package/dist/commonjs/sdk/models/errors/searchretrieve.js +213 -0
  78. package/dist/commonjs/sdk/models/errors/searchretrieve.js.map +1 -0
  79. package/dist/commonjs/sdk/models/operations/getcensuswholelevel.d.ts +1 -0
  80. package/dist/commonjs/sdk/models/operations/getcensuswholelevel.d.ts.map +1 -1
  81. package/dist/commonjs/sdk/models/operations/getcensuswholelevel.js +1 -0
  82. package/dist/commonjs/sdk/models/operations/getcensuswholelevel.js.map +1 -1
  83. package/dist/commonjs/sdk/models/operations/getlistingbyid.d.ts +18 -15
  84. package/dist/commonjs/sdk/models/operations/getlistingbyid.d.ts.map +1 -1
  85. package/dist/commonjs/sdk/models/operations/getlistingbyid.js +15 -15
  86. package/dist/commonjs/sdk/models/operations/getlistingbyid.js.map +1 -1
  87. package/dist/commonjs/sdk/models/operations/getlistingbysource.d.ts +18 -15
  88. package/dist/commonjs/sdk/models/operations/getlistingbysource.d.ts.map +1 -1
  89. package/dist/commonjs/sdk/models/operations/getlistingbysource.js +15 -15
  90. package/dist/commonjs/sdk/models/operations/getlistingbysource.js.map +1 -1
  91. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.d.ts +18 -15
  92. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.d.ts.map +1 -1
  93. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.js +16 -15
  94. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.js.map +1 -1
  95. package/dist/commonjs/sdk/models/operations/getproperties.d.ts +5 -0
  96. package/dist/commonjs/sdk/models/operations/getproperties.d.ts.map +1 -1
  97. package/dist/commonjs/sdk/models/operations/getproperties.js +1 -0
  98. package/dist/commonjs/sdk/models/operations/getproperties.js.map +1 -1
  99. package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.d.ts +5 -0
  100. package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.d.ts.map +1 -1
  101. package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.js +1 -0
  102. package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.js.map +1 -1
  103. package/dist/commonjs/sdk/models/operations/getpropertiesbysource.d.ts +5 -0
  104. package/dist/commonjs/sdk/models/operations/getpropertiesbysource.d.ts.map +1 -1
  105. package/dist/commonjs/sdk/models/operations/getpropertiesbysource.js +1 -0
  106. package/dist/commonjs/sdk/models/operations/getpropertiesbysource.js.map +1 -1
  107. package/dist/commonjs/sdk/models/operations/index.d.ts +1 -0
  108. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  109. package/dist/commonjs/sdk/models/operations/index.js +1 -0
  110. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  111. package/dist/commonjs/sdk/models/operations/querylistings.d.ts +18 -15
  112. package/dist/commonjs/sdk/models/operations/querylistings.d.ts.map +1 -1
  113. package/dist/commonjs/sdk/models/operations/querylistings.js +17 -16
  114. package/dist/commonjs/sdk/models/operations/querylistings.js.map +1 -1
  115. package/dist/commonjs/sdk/models/operations/querylistingsbysource.d.ts +18 -15
  116. package/dist/commonjs/sdk/models/operations/querylistingsbysource.d.ts.map +1 -1
  117. package/dist/commonjs/sdk/models/operations/querylistingsbysource.js +16 -15
  118. package/dist/commonjs/sdk/models/operations/querylistingsbysource.js.map +1 -1
  119. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts +16 -3
  120. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  121. package/dist/commonjs/sdk/models/operations/resolveaddress.js +18 -3
  122. package/dist/commonjs/sdk/models/operations/resolveaddress.js.map +1 -1
  123. package/dist/commonjs/sdk/models/operations/searchretrieve.d.ts +20 -0
  124. package/dist/commonjs/sdk/models/operations/searchretrieve.d.ts.map +1 -0
  125. package/dist/commonjs/sdk/models/operations/searchretrieve.js +55 -0
  126. package/dist/commonjs/sdk/models/operations/searchretrieve.js.map +1 -0
  127. package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts +35 -0
  128. package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts.map +1 -1
  129. package/dist/commonjs/sdk/models/operations/searchsuggest.js +18 -1
  130. package/dist/commonjs/sdk/models/operations/searchsuggest.js.map +1 -1
  131. package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts +27 -0
  132. package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts.map +1 -1
  133. package/dist/commonjs/sdk/models/shared/addressresolverequest.js +25 -1
  134. package/dist/commonjs/sdk/models/shared/addressresolverequest.js.map +1 -1
  135. package/dist/commonjs/sdk/models/shared/advancedlisting.d.ts +2 -2
  136. package/dist/commonjs/sdk/models/shared/advancedlisting.d.ts.map +1 -1
  137. package/dist/commonjs/sdk/models/shared/advancedlisting.js +2 -2
  138. package/dist/commonjs/sdk/models/shared/advancedlisting.js.map +1 -1
  139. package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.d.ts +20 -0
  140. package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.d.ts.map +1 -1
  141. package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.js +13 -1
  142. package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.js.map +1 -1
  143. package/dist/commonjs/sdk/models/shared/censusrolluprequest.d.ts +20 -0
  144. package/dist/commonjs/sdk/models/shared/censusrolluprequest.d.ts.map +1 -1
  145. package/dist/commonjs/sdk/models/shared/censusrolluprequest.js +12 -1
  146. package/dist/commonjs/sdk/models/shared/censusrolluprequest.js.map +1 -1
  147. package/dist/commonjs/sdk/models/shared/geocodeprecision.d.ts +17 -0
  148. package/dist/commonjs/sdk/models/shared/geocodeprecision.d.ts.map +1 -0
  149. package/dist/commonjs/sdk/models/shared/geocodeprecision.js +51 -0
  150. package/dist/commonjs/sdk/models/shared/geocodeprecision.js.map +1 -0
  151. package/dist/commonjs/sdk/models/shared/index.d.ts +14 -7
  152. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  153. package/dist/commonjs/sdk/models/shared/index.js +14 -7
  154. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  155. package/dist/commonjs/sdk/models/shared/mortgagecharge.d.ts +38 -0
  156. package/dist/commonjs/sdk/models/shared/mortgagecharge.d.ts.map +1 -0
  157. package/dist/commonjs/sdk/models/shared/{extractionmortgagecharge.js → mortgagecharge.js} +11 -11
  158. package/dist/commonjs/sdk/models/shared/mortgagecharge.js.map +1 -0
  159. package/dist/commonjs/sdk/models/shared/othercharge.d.ts +23 -0
  160. package/dist/commonjs/sdk/models/shared/othercharge.d.ts.map +1 -0
  161. package/dist/commonjs/sdk/models/shared/{extractionothercharge.js → othercharge.js} +6 -6
  162. package/dist/commonjs/sdk/models/shared/othercharge.js.map +1 -0
  163. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts +24 -2
  164. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts.map +1 -1
  165. package/dist/commonjs/sdk/models/shared/propertyaddress.js +14 -2
  166. package/dist/commonjs/sdk/models/shared/propertyaddress.js.map +1 -1
  167. package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.d.ts +5 -0
  168. package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.d.ts.map +1 -1
  169. package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.js +1 -0
  170. package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.js.map +1 -1
  171. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts +38 -0
  172. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  173. package/dist/commonjs/sdk/models/shared/propertydataapi.js +22 -1
  174. package/dist/commonjs/sdk/models/shared/propertydataapi.js.map +1 -1
  175. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts +5 -0
  176. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
  177. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js +1 -0
  178. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js.map +1 -1
  179. package/dist/commonjs/sdk/models/shared/registeredcharges.d.ts +14 -0
  180. package/dist/commonjs/sdk/models/shared/registeredcharges.d.ts.map +1 -0
  181. package/dist/commonjs/sdk/models/shared/{extractionproprietor.js → registeredcharges.js} +11 -15
  182. package/dist/commonjs/sdk/models/shared/registeredcharges.js.map +1 -0
  183. package/dist/commonjs/sdk/models/shared/salerecord.d.ts +45 -0
  184. package/dist/commonjs/sdk/models/shared/salerecord.d.ts.map +1 -1
  185. package/dist/commonjs/sdk/models/shared/salerecord.js +26 -1
  186. package/dist/commonjs/sdk/models/shared/salerecord.js.map +1 -1
  187. package/dist/commonjs/sdk/models/shared/searchresponse.d.ts +8 -0
  188. package/dist/commonjs/sdk/models/shared/searchresponse.d.ts.map +1 -1
  189. package/dist/commonjs/sdk/models/shared/searchresponse.js +4 -0
  190. package/dist/commonjs/sdk/models/shared/searchresponse.js.map +1 -1
  191. package/dist/commonjs/sdk/models/shared/searchretrieveresponse.d.ts +82 -0
  192. package/dist/commonjs/sdk/models/shared/searchretrieveresponse.d.ts.map +1 -0
  193. package/dist/commonjs/sdk/models/shared/searchretrieveresponse.js +88 -0
  194. package/dist/commonjs/sdk/models/shared/searchretrieveresponse.js.map +1 -0
  195. package/dist/commonjs/sdk/models/shared/streetmatch.d.ts +106 -0
  196. package/dist/commonjs/sdk/models/shared/streetmatch.d.ts.map +1 -0
  197. package/dist/commonjs/sdk/models/shared/streetmatch.js +84 -0
  198. package/dist/commonjs/sdk/models/shared/streetmatch.js.map +1 -0
  199. package/dist/commonjs/sdk/models/shared/titlecovenant.d.ts +23 -0
  200. package/dist/commonjs/sdk/models/shared/titlecovenant.d.ts.map +1 -0
  201. package/dist/commonjs/sdk/models/shared/{extractionrestriction.js → titlecovenant.js} +6 -6
  202. package/dist/commonjs/sdk/models/shared/titlecovenant.js.map +1 -0
  203. package/dist/commonjs/sdk/models/shared/{extractiondocumentsummary.d.ts → titledocumentsummary.d.ts} +9 -9
  204. package/dist/commonjs/sdk/models/shared/titledocumentsummary.d.ts.map +1 -0
  205. package/dist/commonjs/sdk/models/shared/{extractiondocumentsummary.js → titledocumentsummary.js} +11 -11
  206. package/dist/commonjs/sdk/models/shared/titledocumentsummary.js.map +1 -0
  207. package/dist/commonjs/sdk/models/shared/titleextractionpayload.d.ts +83 -0
  208. package/dist/commonjs/sdk/models/shared/titleextractionpayload.d.ts.map +1 -0
  209. package/dist/commonjs/sdk/models/shared/titleextractionpayload.js +103 -0
  210. package/dist/commonjs/sdk/models/shared/titleextractionpayload.js.map +1 -0
  211. package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.d.ts +2 -2
  212. package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.d.ts.map +1 -1
  213. package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.js +2 -2
  214. package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.js.map +1 -1
  215. package/dist/{esm/sdk/models/shared/extractionnotice.d.ts → commonjs/sdk/models/shared/titlenotice.d.ts} +13 -4
  216. package/dist/commonjs/sdk/models/shared/titlenotice.d.ts.map +1 -0
  217. package/dist/commonjs/sdk/models/shared/{extractionnotice.js → titlenotice.js} +6 -6
  218. package/dist/commonjs/sdk/models/shared/titlenotice.js.map +1 -0
  219. package/dist/commonjs/sdk/models/shared/titleproprietor.d.ts +54 -0
  220. package/dist/commonjs/sdk/models/shared/titleproprietor.d.ts.map +1 -0
  221. package/dist/commonjs/sdk/models/shared/titleproprietor.js +75 -0
  222. package/dist/commonjs/sdk/models/shared/titleproprietor.js.map +1 -0
  223. package/dist/commonjs/sdk/models/shared/titlerestriction.d.ts +23 -0
  224. package/dist/commonjs/sdk/models/shared/titlerestriction.d.ts.map +1 -0
  225. package/dist/commonjs/sdk/models/shared/titlerestriction.js +54 -0
  226. package/dist/commonjs/sdk/models/shared/titlerestriction.js.map +1 -0
  227. package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.d.ts +13 -0
  228. package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.d.ts.map +1 -0
  229. package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.js +50 -0
  230. package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.js.map +1 -0
  231. package/dist/commonjs/sdk/models/shared/titlesummarycounts.d.ts +15 -0
  232. package/dist/commonjs/sdk/models/shared/titlesummarycounts.d.ts.map +1 -0
  233. package/dist/commonjs/sdk/models/shared/titlesummarycounts.js +55 -0
  234. package/dist/commonjs/sdk/models/shared/titlesummarycounts.js.map +1 -0
  235. package/dist/commonjs/sdk/search.d.ts +14 -1
  236. package/dist/commonjs/sdk/search.d.ts.map +1 -1
  237. package/dist/commonjs/sdk/search.js +17 -1
  238. package/dist/commonjs/sdk/search.js.map +1 -1
  239. package/dist/esm/address-search/__tests__/controller.test.d.ts +2 -0
  240. package/dist/esm/address-search/__tests__/controller.test.d.ts.map +1 -0
  241. package/dist/esm/address-search/__tests__/controller.test.js +327 -0
  242. package/dist/esm/address-search/__tests__/controller.test.js.map +1 -0
  243. package/dist/esm/address-search/__tests__/default-transports.test.d.ts +2 -0
  244. package/dist/esm/address-search/__tests__/default-transports.test.d.ts.map +1 -0
  245. package/dist/esm/address-search/__tests__/default-transports.test.js +159 -0
  246. package/dist/esm/address-search/__tests__/default-transports.test.js.map +1 -0
  247. package/dist/esm/address-search/__tests__/narrow.test.d.ts +2 -0
  248. package/dist/esm/address-search/__tests__/narrow.test.d.ts.map +1 -0
  249. package/dist/esm/address-search/__tests__/narrow.test.js +61 -0
  250. package/dist/esm/address-search/__tests__/narrow.test.js.map +1 -0
  251. package/dist/esm/address-search/controller.d.ts +14 -0
  252. package/dist/esm/address-search/controller.d.ts.map +1 -0
  253. package/dist/esm/address-search/controller.js +187 -0
  254. package/dist/esm/address-search/controller.js.map +1 -0
  255. package/dist/esm/address-search/default-transports.d.ts +52 -0
  256. package/dist/esm/address-search/default-transports.d.ts.map +1 -0
  257. package/dist/esm/address-search/default-transports.js +129 -0
  258. package/dist/esm/address-search/default-transports.js.map +1 -0
  259. package/dist/esm/address-search/errors.d.ts +5 -0
  260. package/dist/esm/address-search/errors.d.ts.map +1 -0
  261. package/dist/esm/address-search/errors.js +8 -0
  262. package/dist/esm/address-search/errors.js.map +1 -0
  263. package/dist/esm/address-search/index.d.ts +8 -0
  264. package/dist/esm/address-search/index.d.ts.map +1 -0
  265. package/dist/esm/address-search/index.js +30 -0
  266. package/dist/esm/address-search/index.js.map +1 -0
  267. package/dist/esm/address-search/lru-cache.d.ts +13 -0
  268. package/dist/esm/address-search/lru-cache.d.ts.map +1 -0
  269. package/dist/esm/address-search/lru-cache.js +46 -0
  270. package/dist/esm/address-search/lru-cache.js.map +1 -0
  271. package/dist/esm/address-search/narrow.d.ts +21 -0
  272. package/dist/esm/address-search/narrow.d.ts.map +1 -0
  273. package/dist/esm/address-search/narrow.js +43 -0
  274. package/dist/esm/address-search/narrow.js.map +1 -0
  275. package/dist/esm/address-search/types.d.ts +125 -0
  276. package/dist/esm/address-search/types.d.ts.map +1 -0
  277. package/dist/esm/address-search/types.js +8 -0
  278. package/dist/esm/address-search/types.js.map +1 -0
  279. package/dist/esm/address-search.d.ts +3 -0
  280. package/dist/esm/address-search.d.ts.map +1 -0
  281. package/dist/esm/address-search.js +6 -0
  282. package/dist/esm/address-search.js.map +1 -0
  283. package/dist/esm/funcs/avmPredictPropertyValue.d.ts +1 -1
  284. package/dist/esm/funcs/avmPredictPropertyValue.d.ts.map +1 -1
  285. package/dist/esm/funcs/avmPredictPropertyValue.js +1 -1
  286. package/dist/esm/funcs/avmPredictPropertyValue.js.map +1 -1
  287. package/dist/esm/funcs/propertyGetProperties.js +1 -0
  288. package/dist/esm/funcs/propertyGetProperties.js.map +1 -1
  289. package/dist/esm/funcs/propertyGetPropertiesByLocation.js +1 -0
  290. package/dist/esm/funcs/propertyGetPropertiesByLocation.js.map +1 -1
  291. package/dist/esm/funcs/propertyGetPropertiesBySource.js +1 -0
  292. package/dist/esm/funcs/propertyGetPropertiesBySource.js.map +1 -1
  293. package/dist/esm/funcs/searchSearchRetrieve.d.ts +23 -0
  294. package/dist/esm/funcs/searchSearchRetrieve.d.ts.map +1 -0
  295. package/dist/esm/funcs/searchSearchRetrieve.js +92 -0
  296. package/dist/esm/funcs/searchSearchRetrieve.js.map +1 -0
  297. package/dist/esm/funcs/searchSearchSuggest.d.ts +3 -1
  298. package/dist/esm/funcs/searchSearchSuggest.d.ts.map +1 -1
  299. package/dist/esm/funcs/searchSearchSuggest.js +5 -1
  300. package/dist/esm/funcs/searchSearchSuggest.js.map +1 -1
  301. package/dist/esm/lib/config.d.ts +3 -3
  302. package/dist/esm/lib/config.js +3 -3
  303. package/dist/esm/lib/config.js.map +1 -1
  304. package/dist/esm/sdk/models/errors/index.d.ts +1 -0
  305. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  306. package/dist/esm/sdk/models/errors/index.js +1 -0
  307. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  308. package/dist/esm/sdk/models/errors/predictpropertyvalue.d.ts +65 -0
  309. package/dist/esm/sdk/models/errors/predictpropertyvalue.d.ts.map +1 -1
  310. package/dist/esm/sdk/models/errors/predictpropertyvalue.js +54 -0
  311. package/dist/esm/sdk/models/errors/predictpropertyvalue.js.map +1 -1
  312. package/dist/esm/sdk/models/errors/searchretrieve.d.ts +201 -0
  313. package/dist/esm/sdk/models/errors/searchretrieve.d.ts.map +1 -0
  314. package/dist/esm/sdk/models/errors/searchretrieve.js +171 -0
  315. package/dist/esm/sdk/models/errors/searchretrieve.js.map +1 -0
  316. package/dist/esm/sdk/models/operations/getcensuswholelevel.d.ts +1 -0
  317. package/dist/esm/sdk/models/operations/getcensuswholelevel.d.ts.map +1 -1
  318. package/dist/esm/sdk/models/operations/getcensuswholelevel.js +1 -0
  319. package/dist/esm/sdk/models/operations/getcensuswholelevel.js.map +1 -1
  320. package/dist/esm/sdk/models/operations/getlistingbyid.d.ts +18 -15
  321. package/dist/esm/sdk/models/operations/getlistingbyid.d.ts.map +1 -1
  322. package/dist/esm/sdk/models/operations/getlistingbyid.js +16 -16
  323. package/dist/esm/sdk/models/operations/getlistingbyid.js.map +1 -1
  324. package/dist/esm/sdk/models/operations/getlistingbysource.d.ts +18 -15
  325. package/dist/esm/sdk/models/operations/getlistingbysource.d.ts.map +1 -1
  326. package/dist/esm/sdk/models/operations/getlistingbysource.js +16 -16
  327. package/dist/esm/sdk/models/operations/getlistingbysource.js.map +1 -1
  328. package/dist/esm/sdk/models/operations/getlistingsbylocation.d.ts +18 -15
  329. package/dist/esm/sdk/models/operations/getlistingsbylocation.d.ts.map +1 -1
  330. package/dist/esm/sdk/models/operations/getlistingsbylocation.js +17 -16
  331. package/dist/esm/sdk/models/operations/getlistingsbylocation.js.map +1 -1
  332. package/dist/esm/sdk/models/operations/getproperties.d.ts +5 -0
  333. package/dist/esm/sdk/models/operations/getproperties.d.ts.map +1 -1
  334. package/dist/esm/sdk/models/operations/getproperties.js +1 -0
  335. package/dist/esm/sdk/models/operations/getproperties.js.map +1 -1
  336. package/dist/esm/sdk/models/operations/getpropertiesbylocation.d.ts +5 -0
  337. package/dist/esm/sdk/models/operations/getpropertiesbylocation.d.ts.map +1 -1
  338. package/dist/esm/sdk/models/operations/getpropertiesbylocation.js +1 -0
  339. package/dist/esm/sdk/models/operations/getpropertiesbylocation.js.map +1 -1
  340. package/dist/esm/sdk/models/operations/getpropertiesbysource.d.ts +5 -0
  341. package/dist/esm/sdk/models/operations/getpropertiesbysource.d.ts.map +1 -1
  342. package/dist/esm/sdk/models/operations/getpropertiesbysource.js +1 -0
  343. package/dist/esm/sdk/models/operations/getpropertiesbysource.js.map +1 -1
  344. package/dist/esm/sdk/models/operations/index.d.ts +1 -0
  345. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  346. package/dist/esm/sdk/models/operations/index.js +1 -0
  347. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  348. package/dist/esm/sdk/models/operations/querylistings.d.ts +18 -15
  349. package/dist/esm/sdk/models/operations/querylistings.d.ts.map +1 -1
  350. package/dist/esm/sdk/models/operations/querylistings.js +18 -17
  351. package/dist/esm/sdk/models/operations/querylistings.js.map +1 -1
  352. package/dist/esm/sdk/models/operations/querylistingsbysource.d.ts +18 -15
  353. package/dist/esm/sdk/models/operations/querylistingsbysource.d.ts.map +1 -1
  354. package/dist/esm/sdk/models/operations/querylistingsbysource.js +17 -16
  355. package/dist/esm/sdk/models/operations/querylistingsbysource.js.map +1 -1
  356. package/dist/esm/sdk/models/operations/resolveaddress.d.ts +16 -3
  357. package/dist/esm/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  358. package/dist/esm/sdk/models/operations/resolveaddress.js +16 -2
  359. package/dist/esm/sdk/models/operations/resolveaddress.js.map +1 -1
  360. package/dist/esm/sdk/models/operations/searchretrieve.d.ts +20 -0
  361. package/dist/esm/sdk/models/operations/searchretrieve.d.ts.map +1 -0
  362. package/dist/esm/sdk/models/operations/searchretrieve.js +18 -0
  363. package/dist/esm/sdk/models/operations/searchretrieve.js.map +1 -0
  364. package/dist/esm/sdk/models/operations/searchsuggest.d.ts +35 -0
  365. package/dist/esm/sdk/models/operations/searchsuggest.d.ts.map +1 -1
  366. package/dist/esm/sdk/models/operations/searchsuggest.js +17 -0
  367. package/dist/esm/sdk/models/operations/searchsuggest.js.map +1 -1
  368. package/dist/esm/sdk/models/shared/addressresolverequest.d.ts +27 -0
  369. package/dist/esm/sdk/models/shared/addressresolverequest.d.ts.map +1 -1
  370. package/dist/esm/sdk/models/shared/addressresolverequest.js +23 -0
  371. package/dist/esm/sdk/models/shared/addressresolverequest.js.map +1 -1
  372. package/dist/esm/sdk/models/shared/advancedlisting.d.ts +2 -2
  373. package/dist/esm/sdk/models/shared/advancedlisting.d.ts.map +1 -1
  374. package/dist/esm/sdk/models/shared/advancedlisting.js +2 -2
  375. package/dist/esm/sdk/models/shared/advancedlisting.js.map +1 -1
  376. package/dist/esm/sdk/models/shared/censusareaprofilerequest.d.ts +20 -0
  377. package/dist/esm/sdk/models/shared/censusareaprofilerequest.d.ts.map +1 -1
  378. package/dist/esm/sdk/models/shared/censusareaprofilerequest.js +12 -0
  379. package/dist/esm/sdk/models/shared/censusareaprofilerequest.js.map +1 -1
  380. package/dist/esm/sdk/models/shared/censusrolluprequest.d.ts +20 -0
  381. package/dist/esm/sdk/models/shared/censusrolluprequest.d.ts.map +1 -1
  382. package/dist/esm/sdk/models/shared/censusrolluprequest.js +11 -0
  383. package/dist/esm/sdk/models/shared/censusrolluprequest.js.map +1 -1
  384. package/dist/esm/sdk/models/shared/geocodeprecision.d.ts +17 -0
  385. package/dist/esm/sdk/models/shared/geocodeprecision.d.ts.map +1 -0
  386. package/dist/esm/sdk/models/shared/geocodeprecision.js +15 -0
  387. package/dist/esm/sdk/models/shared/geocodeprecision.js.map +1 -0
  388. package/dist/esm/sdk/models/shared/index.d.ts +14 -7
  389. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  390. package/dist/esm/sdk/models/shared/index.js +14 -7
  391. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  392. package/dist/esm/sdk/models/shared/mortgagecharge.d.ts +38 -0
  393. package/dist/esm/sdk/models/shared/mortgagecharge.d.ts.map +1 -0
  394. package/dist/esm/sdk/models/shared/mortgagecharge.js +28 -0
  395. package/dist/esm/sdk/models/shared/mortgagecharge.js.map +1 -0
  396. package/dist/esm/sdk/models/shared/othercharge.d.ts +23 -0
  397. package/dist/esm/sdk/models/shared/othercharge.d.ts.map +1 -0
  398. package/dist/esm/sdk/models/shared/{extractionothercharge.js → othercharge.js} +4 -4
  399. package/dist/esm/sdk/models/shared/othercharge.js.map +1 -0
  400. package/dist/esm/sdk/models/shared/propertyaddress.d.ts +24 -2
  401. package/dist/esm/sdk/models/shared/propertyaddress.d.ts.map +1 -1
  402. package/dist/esm/sdk/models/shared/propertyaddress.js +13 -1
  403. package/dist/esm/sdk/models/shared/propertyaddress.js.map +1 -1
  404. package/dist/esm/sdk/models/shared/propertybyslugsrequest.d.ts +5 -0
  405. package/dist/esm/sdk/models/shared/propertybyslugsrequest.d.ts.map +1 -1
  406. package/dist/esm/sdk/models/shared/propertybyslugsrequest.js +1 -0
  407. package/dist/esm/sdk/models/shared/propertybyslugsrequest.js.map +1 -1
  408. package/dist/esm/sdk/models/shared/propertydataapi.d.ts +38 -0
  409. package/dist/esm/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  410. package/dist/esm/sdk/models/shared/propertydataapi.js +21 -0
  411. package/dist/esm/sdk/models/shared/propertydataapi.js.map +1 -1
  412. package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts +5 -0
  413. package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
  414. package/dist/esm/sdk/models/shared/propertyqueryrequest.js +1 -0
  415. package/dist/esm/sdk/models/shared/propertyqueryrequest.js.map +1 -1
  416. package/dist/esm/sdk/models/shared/registeredcharges.d.ts +14 -0
  417. package/dist/esm/sdk/models/shared/registeredcharges.d.ts.map +1 -0
  418. package/dist/esm/sdk/models/shared/registeredcharges.js +17 -0
  419. package/dist/esm/sdk/models/shared/registeredcharges.js.map +1 -0
  420. package/dist/esm/sdk/models/shared/salerecord.d.ts +45 -0
  421. package/dist/esm/sdk/models/shared/salerecord.d.ts.map +1 -1
  422. package/dist/esm/sdk/models/shared/salerecord.js +25 -0
  423. package/dist/esm/sdk/models/shared/salerecord.js.map +1 -1
  424. package/dist/esm/sdk/models/shared/searchresponse.d.ts +8 -0
  425. package/dist/esm/sdk/models/shared/searchresponse.d.ts.map +1 -1
  426. package/dist/esm/sdk/models/shared/searchresponse.js +4 -0
  427. package/dist/esm/sdk/models/shared/searchresponse.js.map +1 -1
  428. package/dist/esm/sdk/models/shared/searchretrieveresponse.d.ts +82 -0
  429. package/dist/esm/sdk/models/shared/searchretrieveresponse.d.ts.map +1 -0
  430. package/dist/esm/sdk/models/shared/searchretrieveresponse.js +50 -0
  431. package/dist/esm/sdk/models/shared/searchretrieveresponse.js.map +1 -0
  432. package/dist/esm/sdk/models/shared/streetmatch.d.ts +106 -0
  433. package/dist/esm/sdk/models/shared/streetmatch.d.ts.map +1 -0
  434. package/dist/esm/sdk/models/shared/streetmatch.js +45 -0
  435. package/dist/esm/sdk/models/shared/streetmatch.js.map +1 -0
  436. package/dist/esm/sdk/models/shared/titlecovenant.d.ts +23 -0
  437. package/dist/esm/sdk/models/shared/titlecovenant.d.ts.map +1 -0
  438. package/dist/esm/sdk/models/shared/{extractionrestriction.js → titlecovenant.js} +4 -4
  439. package/dist/esm/sdk/models/shared/titlecovenant.js.map +1 -0
  440. package/dist/esm/sdk/models/shared/{extractiondocumentsummary.d.ts → titledocumentsummary.d.ts} +9 -9
  441. package/dist/esm/sdk/models/shared/titledocumentsummary.d.ts.map +1 -0
  442. package/dist/esm/sdk/models/shared/{extractiondocumentsummary.js → titledocumentsummary.js} +9 -9
  443. package/dist/esm/sdk/models/shared/titledocumentsummary.js.map +1 -0
  444. package/dist/esm/sdk/models/shared/titleextractionpayload.d.ts +83 -0
  445. package/dist/esm/sdk/models/shared/titleextractionpayload.d.ts.map +1 -0
  446. package/dist/esm/sdk/models/shared/titleextractionpayload.js +65 -0
  447. package/dist/esm/sdk/models/shared/titleextractionpayload.js.map +1 -0
  448. package/dist/esm/sdk/models/shared/titleextractionpollresponse.d.ts +2 -2
  449. package/dist/esm/sdk/models/shared/titleextractionpollresponse.d.ts.map +1 -1
  450. package/dist/esm/sdk/models/shared/titleextractionpollresponse.js +2 -2
  451. package/dist/esm/sdk/models/shared/titleextractionpollresponse.js.map +1 -1
  452. package/dist/{commonjs/sdk/models/shared/extractionnotice.d.ts → esm/sdk/models/shared/titlenotice.d.ts} +13 -4
  453. package/dist/esm/sdk/models/shared/titlenotice.d.ts.map +1 -0
  454. package/dist/esm/sdk/models/shared/{extractionnotice.js → titlenotice.js} +4 -4
  455. package/dist/esm/sdk/models/shared/titlenotice.js.map +1 -0
  456. package/dist/esm/sdk/models/shared/titleproprietor.d.ts +54 -0
  457. package/dist/esm/sdk/models/shared/titleproprietor.d.ts.map +1 -0
  458. package/dist/esm/sdk/models/shared/titleproprietor.js +38 -0
  459. package/dist/esm/sdk/models/shared/titleproprietor.js.map +1 -0
  460. package/dist/esm/sdk/models/shared/titlerestriction.d.ts +23 -0
  461. package/dist/esm/sdk/models/shared/titlerestriction.d.ts.map +1 -0
  462. package/dist/esm/sdk/models/shared/titlerestriction.js +17 -0
  463. package/dist/esm/sdk/models/shared/titlerestriction.js.map +1 -0
  464. package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.d.ts +13 -0
  465. package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.d.ts.map +1 -0
  466. package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.js +13 -0
  467. package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.js.map +1 -0
  468. package/dist/esm/sdk/models/shared/titlesummarycounts.d.ts +15 -0
  469. package/dist/esm/sdk/models/shared/titlesummarycounts.d.ts.map +1 -0
  470. package/dist/esm/sdk/models/shared/titlesummarycounts.js +18 -0
  471. package/dist/esm/sdk/models/shared/titlesummarycounts.js.map +1 -0
  472. package/dist/esm/sdk/search.d.ts +14 -1
  473. package/dist/esm/sdk/search.d.ts.map +1 -1
  474. package/dist/esm/sdk/search.js +17 -1
  475. package/dist/esm/sdk/search.js.map +1 -1
  476. package/package.json +3 -2
  477. package/src/address-search/__tests__/controller.test.ts +395 -0
  478. package/src/address-search/__tests__/default-transports.test.ts +201 -0
  479. package/src/address-search/__tests__/narrow.test.ts +74 -0
  480. package/src/address-search/controller.ts +219 -0
  481. package/src/address-search/default-transports.ts +199 -0
  482. package/src/address-search/errors.ts +7 -0
  483. package/src/address-search/index.ts +54 -0
  484. package/src/address-search/lru-cache.ts +34 -0
  485. package/src/address-search/narrow.ts +45 -0
  486. package/src/address-search/types.ts +147 -0
  487. package/src/address-search.ts +40 -0
  488. package/src/funcs/avmPredictPropertyValue.ts +9 -2
  489. package/src/funcs/propertyGetProperties.ts +1 -0
  490. package/src/funcs/propertyGetPropertiesByLocation.ts +1 -0
  491. package/src/funcs/propertyGetPropertiesBySource.ts +1 -0
  492. package/src/funcs/searchSearchRetrieve.ts +192 -0
  493. package/src/funcs/searchSearchSuggest.ts +5 -1
  494. package/src/lib/config.ts +3 -3
  495. package/src/sdk/models/errors/index.ts +1 -0
  496. package/src/sdk/models/errors/predictpropertyvalue.ts +136 -0
  497. package/src/sdk/models/errors/searchretrieve.ts +391 -0
  498. package/src/sdk/models/operations/getcensuswholelevel.ts +1 -0
  499. package/src/sdk/models/operations/getlistingbyid.ts +84 -76
  500. package/src/sdk/models/operations/getlistingbysource.ts +95 -87
  501. package/src/sdk/models/operations/getlistingsbylocation.ts +95 -86
  502. package/src/sdk/models/operations/getproperties.ts +6 -0
  503. package/src/sdk/models/operations/getpropertiesbylocation.ts +6 -0
  504. package/src/sdk/models/operations/getpropertiesbysource.ts +6 -0
  505. package/src/sdk/models/operations/index.ts +1 -0
  506. package/src/sdk/models/operations/querylistings.ts +91 -82
  507. package/src/sdk/models/operations/querylistingsbysource.ts +95 -86
  508. package/src/sdk/models/operations/resolveaddress.ts +50 -12
  509. package/src/sdk/models/operations/searchretrieve.ts +45 -0
  510. package/src/sdk/models/operations/searchsuggest.ts +41 -0
  511. package/src/sdk/models/shared/addressresolverequest.ts +60 -0
  512. package/src/sdk/models/shared/advancedlisting.ts +4 -4
  513. package/src/sdk/models/shared/censusareaprofilerequest.ts +24 -0
  514. package/src/sdk/models/shared/censusrolluprequest.ts +27 -0
  515. package/src/sdk/models/shared/geocodeprecision.ts +27 -0
  516. package/src/sdk/models/shared/index.ts +14 -7
  517. package/src/sdk/models/shared/mortgagecharge.ts +76 -0
  518. package/src/sdk/models/shared/{extractionothercharge.ts → othercharge.ts} +16 -7
  519. package/src/sdk/models/shared/propertyaddress.ts +36 -3
  520. package/src/sdk/models/shared/propertybyslugsrequest.ts +6 -0
  521. package/src/sdk/models/shared/propertydataapi.ts +55 -0
  522. package/src/sdk/models/shared/propertyqueryrequest.ts +6 -0
  523. package/src/sdk/models/shared/registeredcharges.ts +40 -0
  524. package/src/sdk/models/shared/salerecord.ts +62 -0
  525. package/src/sdk/models/shared/searchresponse.ts +12 -0
  526. package/src/sdk/models/shared/searchretrieveresponse.ts +153 -0
  527. package/src/sdk/models/shared/streetmatch.ts +181 -0
  528. package/src/sdk/models/shared/{extractionrestriction.ts → titlecovenant.ts} +16 -7
  529. package/src/sdk/models/shared/{extractiondocumentsummary.ts → titledocumentsummary.ts} +20 -18
  530. package/src/sdk/models/shared/titleextractionpayload.ts +170 -0
  531. package/src/sdk/models/shared/titleextractionpollresponse.ts +5 -5
  532. package/src/sdk/models/shared/{extractionnotice.ts → titlenotice.ts} +16 -7
  533. package/src/sdk/models/shared/titleproprietor.ts +90 -0
  534. package/src/sdk/models/shared/titlerestriction.ts +48 -0
  535. package/src/sdk/models/shared/titleschedulenoticeoflease.ts +34 -0
  536. package/src/sdk/models/shared/titlesummarycounts.ts +41 -0
  537. package/src/sdk/search.ts +25 -1
  538. package/dist/commonjs/sdk/models/shared/extractiondocumentsummary.d.ts.map +0 -1
  539. package/dist/commonjs/sdk/models/shared/extractiondocumentsummary.js.map +0 -1
  540. package/dist/commonjs/sdk/models/shared/extractionmortgagecharge.d.ts +0 -26
  541. package/dist/commonjs/sdk/models/shared/extractionmortgagecharge.d.ts.map +0 -1
  542. package/dist/commonjs/sdk/models/shared/extractionmortgagecharge.js.map +0 -1
  543. package/dist/commonjs/sdk/models/shared/extractionnotice.d.ts.map +0 -1
  544. package/dist/commonjs/sdk/models/shared/extractionnotice.js.map +0 -1
  545. package/dist/commonjs/sdk/models/shared/extractionothercharge.d.ts +0 -14
  546. package/dist/commonjs/sdk/models/shared/extractionothercharge.d.ts.map +0 -1
  547. package/dist/commonjs/sdk/models/shared/extractionothercharge.js.map +0 -1
  548. package/dist/commonjs/sdk/models/shared/extractionpayload.d.ts +0 -63
  549. package/dist/commonjs/sdk/models/shared/extractionpayload.d.ts.map +0 -1
  550. package/dist/commonjs/sdk/models/shared/extractionpayload.js +0 -108
  551. package/dist/commonjs/sdk/models/shared/extractionpayload.js.map +0 -1
  552. package/dist/commonjs/sdk/models/shared/extractionproprietor.d.ts +0 -18
  553. package/dist/commonjs/sdk/models/shared/extractionproprietor.d.ts.map +0 -1
  554. package/dist/commonjs/sdk/models/shared/extractionproprietor.js.map +0 -1
  555. package/dist/commonjs/sdk/models/shared/extractionrestriction.d.ts +0 -14
  556. package/dist/commonjs/sdk/models/shared/extractionrestriction.d.ts.map +0 -1
  557. package/dist/commonjs/sdk/models/shared/extractionrestriction.js.map +0 -1
  558. package/dist/esm/sdk/models/shared/extractiondocumentsummary.d.ts.map +0 -1
  559. package/dist/esm/sdk/models/shared/extractiondocumentsummary.js.map +0 -1
  560. package/dist/esm/sdk/models/shared/extractionmortgagecharge.d.ts +0 -26
  561. package/dist/esm/sdk/models/shared/extractionmortgagecharge.d.ts.map +0 -1
  562. package/dist/esm/sdk/models/shared/extractionmortgagecharge.js +0 -28
  563. package/dist/esm/sdk/models/shared/extractionmortgagecharge.js.map +0 -1
  564. package/dist/esm/sdk/models/shared/extractionnotice.d.ts.map +0 -1
  565. package/dist/esm/sdk/models/shared/extractionnotice.js.map +0 -1
  566. package/dist/esm/sdk/models/shared/extractionothercharge.d.ts +0 -14
  567. package/dist/esm/sdk/models/shared/extractionothercharge.d.ts.map +0 -1
  568. package/dist/esm/sdk/models/shared/extractionothercharge.js.map +0 -1
  569. package/dist/esm/sdk/models/shared/extractionpayload.d.ts +0 -63
  570. package/dist/esm/sdk/models/shared/extractionpayload.d.ts.map +0 -1
  571. package/dist/esm/sdk/models/shared/extractionpayload.js +0 -68
  572. package/dist/esm/sdk/models/shared/extractionpayload.js.map +0 -1
  573. package/dist/esm/sdk/models/shared/extractionproprietor.d.ts +0 -18
  574. package/dist/esm/sdk/models/shared/extractionproprietor.d.ts.map +0 -1
  575. package/dist/esm/sdk/models/shared/extractionproprietor.js +0 -21
  576. package/dist/esm/sdk/models/shared/extractionproprietor.js.map +0 -1
  577. package/dist/esm/sdk/models/shared/extractionrestriction.d.ts +0 -14
  578. package/dist/esm/sdk/models/shared/extractionrestriction.d.ts.map +0 -1
  579. package/dist/esm/sdk/models/shared/extractionrestriction.js.map +0 -1
  580. package/src/sdk/models/shared/extractionmortgagecharge.ts +0 -66
  581. package/src/sdk/models/shared/extractionpayload.ts +0 -177
  582. package/src/sdk/models/shared/extractionproprietor.ts +0 -47
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titledocumentsummary.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titledocumentsummary.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAKlD,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,eAAe,EAAE,kBAAkB;IACnC,aAAa,EAAE,gBAAgB;IAC/B,SAAS,EAAE,YAAY;CACf,CAAC;AAGX,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;CACR,CAAC;AAcX,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAInC,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;AAE1C,gBAAgB;AAChB,MAAM,CAAC,MAAM,wCAAwC,GAIjD,SAAS,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAAC;AAExD,gBAAgB;AAChB,MAAM,CAAC,MAAM,kCAAkC,GAI3C,CAAC,CAAC,MAAM,CAAC;IACX,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,YAAY,EAAE,0BAA0B;IACxC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;IACvC,MAAM,EAAE,wCAAwC;IAChD,UAAU,EAAE,CAAC,CAAC,QAAQ,CACpB,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAClE;CACF,CAAC,CAAC;AAEH,MAAM,UAAU,4BAA4B,CAC1C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,kCAAkC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC9D,kDAAkD,CACnD,CAAC;AACJ,CAAC"}
@@ -0,0 +1,83 @@
1
+ import * as z from "zod/v3";
2
+ import { OpenEnum } from "../../types/enums.js";
3
+ import { Result as SafeParseResult } from "../../types/fp.js";
4
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
+ import { RegisteredCharges } from "./registeredcharges.js";
6
+ import { TitleCovenant } from "./titlecovenant.js";
7
+ import { TitleDocumentSummary } from "./titledocumentsummary.js";
8
+ import { TitleNotice } from "./titlenotice.js";
9
+ import { TitleProprietor } from "./titleproprietor.js";
10
+ import { TitleRestriction } from "./titlerestriction.js";
11
+ import { TitleScheduleNoticeOfLease } from "./titleschedulenoticeoflease.js";
12
+ import { TitleSummaryCounts } from "./titlesummarycounts.js";
13
+ /**
14
+ * Class of title from the register (possessory/qualified = material defect). null when not stated.
15
+ */
16
+ export declare const ClassOfTitle: {
17
+ readonly Absolute: "absolute";
18
+ readonly GoodLeasehold: "good_leasehold";
19
+ readonly Possessory: "possessory";
20
+ readonly Qualified: "qualified";
21
+ readonly Other: "other";
22
+ };
23
+ /**
24
+ * Class of title from the register (possessory/qualified = material defect). null when not stated.
25
+ */
26
+ export type ClassOfTitle = OpenEnum<typeof ClassOfTitle>;
27
+ export type Ownership = {
28
+ proprietors: Array<TitleProprietor>;
29
+ };
30
+ export declare const Tenure: {
31
+ readonly Freehold: "freehold";
32
+ readonly Leasehold: "leasehold";
33
+ readonly Commonhold: "commonhold";
34
+ };
35
+ export type Tenure = OpenEnum<typeof Tenure>;
36
+ export type TitleExtractionPayload = {
37
+ /**
38
+ * Class of title from the register (possessory/qualified = material defect). null when not stated.
39
+ */
40
+ classOfTitle: ClassOfTitle | null;
41
+ covenants: Array<TitleCovenant>;
42
+ /**
43
+ * Display string for the current owner card on the summary page.
44
+ */
45
+ currentOwnerDisplay: string;
46
+ documents: Array<TitleDocumentSummary>;
47
+ extractedAt: Date;
48
+ /**
49
+ * 'Not applicable for freehold' or a human lease term summary.
50
+ */
51
+ leaseTermDescription: string;
52
+ notices: Array<TitleNotice>;
53
+ ownership: Ownership;
54
+ promptVersion: string;
55
+ /**
56
+ * Verbatim QUALIFICATION entry text on qualified titles; null otherwise.
57
+ */
58
+ qualification: string | null;
59
+ /**
60
+ * Edition date of the HMLR register at time of extract
61
+ */
62
+ registerAsOf: Date;
63
+ registeredCharges: RegisteredCharges;
64
+ restrictions: Array<TitleRestriction>;
65
+ /**
66
+ * Sub-leases noted against the title (schedule of notices of leases), verbatim.
67
+ */
68
+ scheduleOfNoticesOfLeases?: Array<TitleScheduleNoticeOfLease> | undefined;
69
+ summaryCounts: TitleSummaryCounts;
70
+ tenure: Tenure;
71
+ titleNumber: string;
72
+ };
73
+ /** @internal */
74
+ export declare const ClassOfTitle$inboundSchema: z.ZodType<ClassOfTitle, z.ZodTypeDef, unknown>;
75
+ /** @internal */
76
+ export declare const Ownership$inboundSchema: z.ZodType<Ownership, z.ZodTypeDef, unknown>;
77
+ export declare function ownershipFromJSON(jsonString: string): SafeParseResult<Ownership, SDKValidationError>;
78
+ /** @internal */
79
+ export declare const Tenure$inboundSchema: z.ZodType<Tenure, z.ZodTypeDef, unknown>;
80
+ /** @internal */
81
+ export declare const TitleExtractionPayload$inboundSchema: z.ZodType<TitleExtractionPayload, z.ZodTypeDef, unknown>;
82
+ export declare function titleExtractionPayloadFromJSON(jsonString: string): SafeParseResult<TitleExtractionPayload, SDKValidationError>;
83
+ //# sourceMappingURL=titleextractionpayload.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titleextractionpayload.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleextractionpayload.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,iBAAiB,EAElB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,aAAa,EAA+B,MAAM,oBAAoB,CAAC;AAChF,OAAO,EACL,oBAAoB,EAErB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,WAAW,EAA6B,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EACL,eAAe,EAEhB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,gBAAgB,EAEjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,0BAA0B,EAE3B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,kBAAkB,EAEnB,MAAM,yBAAyB,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;CAMf,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,YAAY,CAAC,CAAC;AAEzD,MAAM,MAAM,SAAS,GAAG;IACtB,WAAW,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CACrC,CAAC;AAEF,eAAO,MAAM,MAAM;;;;CAIT,CAAC;AACX,MAAM,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,MAAM,CAAC,CAAC;AAE7C,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAClC,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAChC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B,SAAS,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACvC,WAAW,EAAE,IAAI,CAAC;IAClB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC5B,SAAS,EAAE,SAAS,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B;;OAEG;IACH,YAAY,EAAE,IAAI,CAAC;IACnB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,YAAY,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACtC;;OAEG;IACH,yBAAyB,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,GAAG,SAAS,CAAC;IAC1E,aAAa,EAAE,kBAAkB,CAAC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CACgC,CAAC;AAE1C,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,SAAS,EACT,CAAC,CAAC,UAAU,EACZ,OAAO,CAGP,CAAC;AAEH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAMhD;AAED,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CACzC,CAAC;AAElC,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,sBAAsB,EACtB,CAAC,CAAC,UAAU,EACZ,OAAO,CAwBP,CAAC;AAEH,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAM7D"}
@@ -0,0 +1,65 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v3";
5
+ import { safeParse } from "../../../lib/schemas.js";
6
+ import * as openEnums from "../../types/enums.js";
7
+ import { RegisteredCharges$inboundSchema, } from "./registeredcharges.js";
8
+ import { TitleCovenant$inboundSchema } from "./titlecovenant.js";
9
+ import { TitleDocumentSummary$inboundSchema, } from "./titledocumentsummary.js";
10
+ import { TitleNotice$inboundSchema } from "./titlenotice.js";
11
+ import { TitleProprietor$inboundSchema, } from "./titleproprietor.js";
12
+ import { TitleRestriction$inboundSchema, } from "./titlerestriction.js";
13
+ import { TitleScheduleNoticeOfLease$inboundSchema, } from "./titleschedulenoticeoflease.js";
14
+ import { TitleSummaryCounts$inboundSchema, } from "./titlesummarycounts.js";
15
+ /**
16
+ * Class of title from the register (possessory/qualified = material defect). null when not stated.
17
+ */
18
+ export const ClassOfTitle = {
19
+ Absolute: "absolute",
20
+ GoodLeasehold: "good_leasehold",
21
+ Possessory: "possessory",
22
+ Qualified: "qualified",
23
+ Other: "other",
24
+ };
25
+ export const Tenure = {
26
+ Freehold: "freehold",
27
+ Leasehold: "leasehold",
28
+ Commonhold: "commonhold",
29
+ };
30
+ /** @internal */
31
+ export const ClassOfTitle$inboundSchema = openEnums.inboundSchema(ClassOfTitle);
32
+ /** @internal */
33
+ export const Ownership$inboundSchema = z.object({
34
+ proprietors: z.array(TitleProprietor$inboundSchema),
35
+ });
36
+ export function ownershipFromJSON(jsonString) {
37
+ return safeParse(jsonString, (x) => Ownership$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Ownership' from JSON`);
38
+ }
39
+ /** @internal */
40
+ export const Tenure$inboundSchema = openEnums.inboundSchema(Tenure);
41
+ /** @internal */
42
+ export const TitleExtractionPayload$inboundSchema = z.object({
43
+ classOfTitle: z.nullable(ClassOfTitle$inboundSchema).default(null),
44
+ covenants: z.array(TitleCovenant$inboundSchema),
45
+ currentOwnerDisplay: z.string(),
46
+ documents: z.array(TitleDocumentSummary$inboundSchema),
47
+ extractedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
48
+ leaseTermDescription: z.string(),
49
+ notices: z.array(TitleNotice$inboundSchema),
50
+ ownership: z.lazy(() => Ownership$inboundSchema),
51
+ promptVersion: z.string(),
52
+ qualification: z.nullable(z.string()).default(null),
53
+ registerAsOf: z.string().datetime({ offset: true }).transform(v => new Date(v)),
54
+ registeredCharges: RegisteredCharges$inboundSchema,
55
+ restrictions: z.array(TitleRestriction$inboundSchema),
56
+ scheduleOfNoticesOfLeases: z.array(TitleScheduleNoticeOfLease$inboundSchema)
57
+ .optional(),
58
+ summaryCounts: TitleSummaryCounts$inboundSchema,
59
+ tenure: Tenure$inboundSchema,
60
+ titleNumber: z.string(),
61
+ });
62
+ export function titleExtractionPayloadFromJSON(jsonString) {
63
+ return safeParse(jsonString, (x) => TitleExtractionPayload$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TitleExtractionPayload' from JSON`);
64
+ }
65
+ //# sourceMappingURL=titleextractionpayload.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titleextractionpayload.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleextractionpayload.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAIlD,OAAO,EAEL,+BAA+B,GAChC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAiB,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AAChF,OAAO,EAEL,kCAAkC,GACnC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAe,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAEL,6BAA6B,GAC9B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAEL,8BAA8B,GAC/B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAEL,wCAAwC,GACzC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEL,gCAAgC,GACjC,MAAM,yBAAyB,CAAC;AAEjC;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,QAAQ,EAAE,UAAU;IACpB,aAAa,EAAE,gBAAgB;IAC/B,UAAU,EAAE,YAAY;IACxB,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,OAAO;CACN,CAAC;AAUX,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,UAAU,EAAE,YAAY;CAChB,CAAC;AAyCX,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAInC,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;AAE1C,gBAAgB;AAChB,MAAM,CAAC,MAAM,uBAAuB,GAIhC,CAAC,CAAC,MAAM,CAAC;IACX,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,6BAA6B,CAAC;CACpD,CAAC,CAAC;AAEH,MAAM,UAAU,iBAAiB,CAC/B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,uBAAuB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnD,uCAAuC,CACxC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAC/B,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;AAElC,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IAClE,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC;IAC/C,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC/B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,kCAAkC,CAAC;IACtD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAC/D,IAAI,IAAI,CAAC,CAAC,CAAC,CACZ;IACD,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC;IAC3C,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,uBAAuB,CAAC;IAChD,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACnD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAChE,IAAI,IAAI,CAAC,CAAC,CAAC,CACZ;IACD,iBAAiB,EAAE,+BAA+B;IAClD,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC;IACrD,yBAAyB,EAAE,CAAC,CAAC,KAAK,CAAC,wCAAwC,CAAC;SACzE,QAAQ,EAAE;IACb,aAAa,EAAE,gCAAgC;IAC/C,MAAM,EAAE,oBAAoB;IAC5B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;CACxB,CAAC,CAAC;AAEH,MAAM,UAAU,8BAA8B,CAC5C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,oCAAoC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChE,oDAAoD,CACrD,CAAC;AACJ,CAAC"}
@@ -2,7 +2,7 @@ import * as z from "zod/v3";
2
2
  import { ClosedEnum, OpenEnum } from "../../types/enums.js";
3
3
  import { Result as SafeParseResult } from "../../types/fp.js";
4
4
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
- import { ExtractionPayload } from "./extractionpayload.js";
5
+ import { TitleExtractionPayload } from "./titleextractionpayload.js";
6
6
  export declare const TitleExtractionPollResponseObject: {
7
7
  readonly TitleExtraction: "title_extraction";
8
8
  };
@@ -15,7 +15,7 @@ export declare const TitleExtractionPollResponseStatus: {
15
15
  };
16
16
  export type TitleExtractionPollResponseStatus = OpenEnum<typeof TitleExtractionPollResponseStatus>;
17
17
  export type TitleExtractionPollResponse = {
18
- extraction: ExtractionPayload | null;
18
+ extraction: TitleExtractionPayload | null;
19
19
  failureCode: string | null;
20
20
  failureMessage: string | null;
21
21
  object: TitleExtractionPollResponseObject;
@@ -1 +1 @@
1
- {"version":3,"file":"titleextractionpollresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleextractionpollresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,iBAAiB,EAElB,MAAM,wBAAwB,CAAC;AAEhC,eAAO,MAAM,iCAAiC;;CAEpC,CAAC;AACX,MAAM,MAAM,iCAAiC,GAAG,UAAU,CACxD,OAAO,iCAAiC,CACzC,CAAC;AAEF,eAAO,MAAM,iCAAiC;;;;;CAKpC,CAAC;AACX,MAAM,MAAM,iCAAiC,GAAG,QAAQ,CACtD,OAAO,iCAAiC,CACzC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACrC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,iCAAiC,CAAC;IAC1C,MAAM,EAAE,iCAAiC,CAAC;IAC1C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,+CAA+C,EAAE,CAAC,CAAC,aAAa,CAC3E,OAAO,iCAAiC,CACS,CAAC;AAEpD,gBAAgB;AAChB,eAAO,MAAM,+CAA+C,EAAE,CAAC,CAAC,OAAO,CACrE,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,OAAO,CACqD,CAAC;AAE/D,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,mCAAmC,CACjD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAMlE"}
1
+ {"version":3,"file":"titleextractionpollresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleextractionpollresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,sBAAsB,EAEvB,MAAM,6BAA6B,CAAC;AAErC,eAAO,MAAM,iCAAiC;;CAEpC,CAAC;AACX,MAAM,MAAM,iCAAiC,GAAG,UAAU,CACxD,OAAO,iCAAiC,CACzC,CAAC;AAEF,eAAO,MAAM,iCAAiC;;;;;CAKpC,CAAC;AACX,MAAM,MAAM,iCAAiC,GAAG,QAAQ,CACtD,OAAO,iCAAiC,CACzC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC1C,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,iCAAiC,CAAC;IAC1C,MAAM,EAAE,iCAAiC,CAAC;IAC1C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,+CAA+C,EAAE,CAAC,CAAC,aAAa,CAC3E,OAAO,iCAAiC,CACS,CAAC;AAEpD,gBAAgB;AAChB,eAAO,MAAM,+CAA+C,EAAE,CAAC,CAAC,OAAO,CACrE,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,OAAO,CACqD,CAAC;AAE/D,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,mCAAmC,CACjD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAMlE"}
@@ -5,7 +5,7 @@ import * as z from "zod/v3";
5
5
  import { remap as remap$ } from "../../../lib/primitives.js";
6
6
  import { safeParse } from "../../../lib/schemas.js";
7
7
  import * as openEnums from "../../types/enums.js";
8
- import { ExtractionPayload$inboundSchema, } from "./extractionpayload.js";
8
+ import { TitleExtractionPayload$inboundSchema, } from "./titleextractionpayload.js";
9
9
  export const TitleExtractionPollResponseObject = {
10
10
  TitleExtraction: "title_extraction",
11
11
  };
@@ -21,7 +21,7 @@ export const TitleExtractionPollResponseObject$inboundSchema = z.nativeEnum(Titl
21
21
  export const TitleExtractionPollResponseStatus$inboundSchema = openEnums.inboundSchema(TitleExtractionPollResponseStatus);
22
22
  /** @internal */
23
23
  export const TitleExtractionPollResponse$inboundSchema = z.object({
24
- extraction: z.nullable(ExtractionPayload$inboundSchema),
24
+ extraction: z.nullable(TitleExtractionPayload$inboundSchema),
25
25
  failure_code: z.nullable(z.string()),
26
26
  failure_message: z.nullable(z.string()),
27
27
  object: TitleExtractionPollResponseObject$inboundSchema,
@@ -1 +1 @@
1
- {"version":3,"file":"titleextractionpollresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleextractionpollresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAIlD,OAAO,EAEL,+BAA+B,GAChC,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,MAAM,iCAAiC,GAAG;IAC/C,eAAe,EAAE,kBAAkB;CAC3B,CAAC;AAKX,MAAM,CAAC,MAAM,iCAAiC,GAAG;IAC/C,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;CACR,CAAC;AAcX,gBAAgB;AAChB,MAAM,CAAC,MAAM,+CAA+C,GAExD,CAAC,CAAC,UAAU,CAAC,iCAAiC,CAAC,CAAC;AAEpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,+CAA+C,GAIxD,SAAS,CAAC,aAAa,CAAC,iCAAiC,CAAC,CAAC;AAE/D,gBAAgB;AAChB,MAAM,CAAC,MAAM,yCAAyC,GAIlD,CAAC,CAAC,MAAM,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IACvD,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACpC,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACvC,MAAM,EAAE,+CAA+C;IACvD,MAAM,EAAE,+CAA+C;IACvD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;CACzB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;QAC7B,iBAAiB,EAAE,gBAAgB;QACnC,cAAc,EAAE,aAAa;KAC9B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,mCAAmC,CACjD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,yCAAyC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrE,yDAAyD,CAC1D,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"titleextractionpollresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleextractionpollresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAIlD,OAAO,EAEL,oCAAoC,GACrC,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,MAAM,iCAAiC,GAAG;IAC/C,eAAe,EAAE,kBAAkB;CAC3B,CAAC;AAKX,MAAM,CAAC,MAAM,iCAAiC,GAAG;IAC/C,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;CACR,CAAC;AAcX,gBAAgB;AAChB,MAAM,CAAC,MAAM,+CAA+C,GAExD,CAAC,CAAC,UAAU,CAAC,iCAAiC,CAAC,CAAC;AAEpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,+CAA+C,GAIxD,SAAS,CAAC,aAAa,CAAC,iCAAiC,CAAC,CAAC;AAE/D,gBAAgB;AAChB,MAAM,CAAC,MAAM,yCAAyC,GAIlD,CAAC,CAAC,MAAM,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,oCAAoC,CAAC;IAC5D,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACpC,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACvC,MAAM,EAAE,+CAA+C;IACvD,MAAM,EAAE,+CAA+C;IACvD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;CACzB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;QAC7B,iBAAiB,EAAE,gBAAgB;QACnC,cAAc,EAAE,aAAa;KAC9B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,mCAAmC,CACjD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,yCAAyC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrE,yDAAyD,CAC1D,CAAC;AACJ,CAAC"}
@@ -10,18 +10,27 @@ export declare const NoticeType: {
10
10
  readonly Bankruptcy: "bankruptcy";
11
11
  };
12
12
  export type NoticeType = OpenEnum<typeof NoticeType>;
13
- export type ExtractionNotice = {
13
+ export type TitleNotice = {
14
14
  date: string | null;
15
15
  noticeType: NoticeType;
16
16
  partyName: string | null;
17
+ /**
18
+ * Legal text quoted verbatim from the register entry
19
+ */
17
20
  rawText: string;
18
21
  sourceEntryRef: string;
22
+ /**
23
+ * Short summary label
24
+ */
19
25
  title: string;
26
+ /**
27
+ * AI-authored plain-language explanation
28
+ */
20
29
  whyThisMatters: string;
21
30
  };
22
31
  /** @internal */
23
32
  export declare const NoticeType$inboundSchema: z.ZodType<NoticeType, z.ZodTypeDef, unknown>;
24
33
  /** @internal */
25
- export declare const ExtractionNotice$inboundSchema: z.ZodType<ExtractionNotice, z.ZodTypeDef, unknown>;
26
- export declare function extractionNoticeFromJSON(jsonString: string): SafeParseResult<ExtractionNotice, SDKValidationError>;
27
- //# sourceMappingURL=extractionnotice.d.ts.map
34
+ export declare const TitleNotice$inboundSchema: z.ZodType<TitleNotice, z.ZodTypeDef, unknown>;
35
+ export declare function titleNoticeFromJSON(jsonString: string): SafeParseResult<TitleNotice, SDKValidationError>;
36
+ //# sourceMappingURL=titlenotice.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titlenotice.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titlenotice.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,eAAO,MAAM,UAAU;;;;;;CAMb,CAAC;AACX,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,UAAU,CAAC,CAAC;AAErD,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,UAAU,EAAE,UAAU,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,UAAU,EACV,CAAC,CAAC,UAAU,EACZ,OAAO,CAC8B,CAAC;AAExC,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,WAAW,EACX,CAAC,CAAC,UAAU,EACZ,OAAO,CASP,CAAC;AAEH,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAMlD"}
@@ -14,7 +14,7 @@ export const NoticeType = {
14
14
  /** @internal */
15
15
  export const NoticeType$inboundSchema = openEnums.inboundSchema(NoticeType);
16
16
  /** @internal */
17
- export const ExtractionNotice$inboundSchema = z.object({
17
+ export const TitleNotice$inboundSchema = z.object({
18
18
  date: z.nullable(z.string()),
19
19
  noticeType: NoticeType$inboundSchema,
20
20
  partyName: z.nullable(z.string()),
@@ -23,7 +23,7 @@ export const ExtractionNotice$inboundSchema = z.object({
23
23
  title: z.string(),
24
24
  whyThisMatters: z.string(),
25
25
  });
26
- export function extractionNoticeFromJSON(jsonString) {
27
- return safeParse(jsonString, (x) => ExtractionNotice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ExtractionNotice' from JSON`);
26
+ export function titleNoticeFromJSON(jsonString) {
27
+ return safeParse(jsonString, (x) => TitleNotice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TitleNotice' from JSON`);
28
28
  }
29
- //# sourceMappingURL=extractionnotice.js.map
29
+ //# sourceMappingURL=titlenotice.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titlenotice.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titlenotice.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAKlD,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE,YAAY;CAChB,CAAC;AAsBX,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAIjC,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;AAExC,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAIlC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B,UAAU,EAAE,wBAAwB;IACpC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;CAC3B,CAAC,CAAC;AAEH,MAAM,UAAU,mBAAmB,CACjC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,yBAAyB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrD,yCAAyC,CAC1C,CAAC;AACJ,CAAC"}
@@ -0,0 +1,54 @@
1
+ import * as z from "zod/v3";
2
+ import { OpenEnum } from "../../types/enums.js";
3
+ import { Result as SafeParseResult } from "../../types/fp.js";
4
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
+ export declare const EntityType: {
6
+ readonly Individual: "individual";
7
+ readonly LimitedCompany: "limited_company";
8
+ readonly Llp: "llp";
9
+ readonly CorporateBody: "corporate_body";
10
+ readonly LocalAuthority: "local_authority";
11
+ readonly CountyCouncil: "county_council";
12
+ readonly RegisteredSociety: "registered_society";
13
+ readonly HousingAssociation: "housing_association";
14
+ readonly UnlimitedCompany: "unlimited_company";
15
+ readonly OverseasCompany: "overseas_company";
16
+ readonly Charity: "charity";
17
+ readonly Unknown: "unknown";
18
+ };
19
+ export type EntityType = OpenEnum<typeof EntityType>;
20
+ export type TitleProprietor = {
21
+ /**
22
+ * Registered addresses for this proprietor (max 3, per HMLR cap)
23
+ */
24
+ addresses: Array<string>;
25
+ /**
26
+ * UK Companies House registration number
27
+ */
28
+ companyRegistrationNumber: string | null;
29
+ /**
30
+ * Country of incorporation
31
+ */
32
+ countryIncorporated: string | null;
33
+ entityType: EntityType;
34
+ forenames: string | null;
35
+ /**
36
+ * Display name — full name for individuals, company/trust name for organisations
37
+ */
38
+ name: string;
39
+ /**
40
+ * Overseas registration / UK regn code
41
+ */
42
+ overseasRegistrationNumber: string | null;
43
+ /**
44
+ * 1-based position within the proprietorship register
45
+ */
46
+ proprietorOrder: number;
47
+ surname: string | null;
48
+ };
49
+ /** @internal */
50
+ export declare const EntityType$inboundSchema: z.ZodType<EntityType, z.ZodTypeDef, unknown>;
51
+ /** @internal */
52
+ export declare const TitleProprietor$inboundSchema: z.ZodType<TitleProprietor, z.ZodTypeDef, unknown>;
53
+ export declare function titleProprietorFromJSON(jsonString: string): SafeParseResult<TitleProprietor, SDKValidationError>;
54
+ //# sourceMappingURL=titleproprietor.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titleproprietor.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleproprietor.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,eAAO,MAAM,UAAU;;;;;;;;;;;;;CAab,CAAC;AACX,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,UAAU,CAAC,CAAC;AAErD,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACzB;;OAEG;IACH,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,UAAU,EAAE,UAAU,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,UAAU,EACV,CAAC,CAAC,UAAU,EACZ,OAAO,CAC8B,CAAC;AAExC,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,eAAe,EACf,CAAC,CAAC,UAAU,EACZ,OAAO,CAWP,CAAC;AAEH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAMtD"}
@@ -0,0 +1,38 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v3";
5
+ import { safeParse } from "../../../lib/schemas.js";
6
+ import * as openEnums from "../../types/enums.js";
7
+ export const EntityType = {
8
+ Individual: "individual",
9
+ LimitedCompany: "limited_company",
10
+ Llp: "llp",
11
+ CorporateBody: "corporate_body",
12
+ LocalAuthority: "local_authority",
13
+ CountyCouncil: "county_council",
14
+ RegisteredSociety: "registered_society",
15
+ HousingAssociation: "housing_association",
16
+ UnlimitedCompany: "unlimited_company",
17
+ OverseasCompany: "overseas_company",
18
+ Charity: "charity",
19
+ Unknown: "unknown",
20
+ };
21
+ /** @internal */
22
+ export const EntityType$inboundSchema = openEnums.inboundSchema(EntityType);
23
+ /** @internal */
24
+ export const TitleProprietor$inboundSchema = z.object({
25
+ addresses: z.array(z.string()),
26
+ companyRegistrationNumber: z.nullable(z.string()),
27
+ countryIncorporated: z.nullable(z.string()),
28
+ entityType: EntityType$inboundSchema,
29
+ forenames: z.nullable(z.string()),
30
+ name: z.string(),
31
+ overseasRegistrationNumber: z.nullable(z.string()),
32
+ proprietorOrder: z.number().int(),
33
+ surname: z.nullable(z.string()),
34
+ });
35
+ export function titleProprietorFromJSON(jsonString) {
36
+ return safeParse(jsonString, (x) => TitleProprietor$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TitleProprietor' from JSON`);
37
+ }
38
+ //# sourceMappingURL=titleproprietor.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titleproprietor.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleproprietor.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAKlD,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,UAAU,EAAE,YAAY;IACxB,cAAc,EAAE,iBAAiB;IACjC,GAAG,EAAE,KAAK;IACV,aAAa,EAAE,gBAAgB;IAC/B,cAAc,EAAE,iBAAiB;IACjC,aAAa,EAAE,gBAAgB;IAC/B,iBAAiB,EAAE,oBAAoB;IACvC,kBAAkB,EAAE,qBAAqB;IACzC,gBAAgB,EAAE,mBAAmB;IACrC,eAAe,EAAE,kBAAkB;IACnC,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;CACV,CAAC;AAiCX,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAIjC,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;AAExC,gBAAgB;AAChB,MAAM,CAAC,MAAM,6BAA6B,GAItC,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC9B,yBAAyB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjD,mBAAmB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3C,UAAU,EAAE,wBAAwB;IACpC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,0BAA0B,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAClD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACjC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAChC,CAAC,CAAC;AAEH,MAAM,UAAU,uBAAuB,CACrC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,6BAA6B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACzD,6CAA6C,CAC9C,CAAC;AACJ,CAAC"}
@@ -0,0 +1,23 @@
1
+ import * as z from "zod/v3";
2
+ import { Result as SafeParseResult } from "../../types/fp.js";
3
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
+ export type TitleRestriction = {
5
+ date: string | null;
6
+ /**
7
+ * Legal text quoted verbatim from the register entry
8
+ */
9
+ rawText: string;
10
+ sourceEntryRef: string;
11
+ /**
12
+ * Short summary label
13
+ */
14
+ title: string;
15
+ /**
16
+ * AI-authored plain-language explanation
17
+ */
18
+ whyThisMatters: string;
19
+ };
20
+ /** @internal */
21
+ export declare const TitleRestriction$inboundSchema: z.ZodType<TitleRestriction, z.ZodTypeDef, unknown>;
22
+ export declare function titleRestrictionFromJSON(jsonString: string): SafeParseResult<TitleRestriction, SDKValidationError>;
23
+ //# sourceMappingURL=titlerestriction.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titlerestriction.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titlerestriction.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD"}
@@ -0,0 +1,17 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v3";
5
+ import { safeParse } from "../../../lib/schemas.js";
6
+ /** @internal */
7
+ export const TitleRestriction$inboundSchema = z.object({
8
+ date: z.nullable(z.string()),
9
+ rawText: z.string(),
10
+ sourceEntryRef: z.string(),
11
+ title: z.string(),
12
+ whyThisMatters: z.string(),
13
+ });
14
+ export function titleRestrictionFromJSON(jsonString) {
15
+ return safeParse(jsonString, (x) => TitleRestriction$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TitleRestriction' from JSON`);
16
+ }
17
+ //# sourceMappingURL=titlerestriction.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titlerestriction.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titlerestriction.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAqBpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;CAC3B,CAAC,CAAC;AAEH,MAAM,UAAU,wBAAwB,CACtC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8BAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC"}
@@ -0,0 +1,13 @@
1
+ import * as z from "zod/v3";
2
+ import { Result as SafeParseResult } from "../../types/fp.js";
3
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
+ export type TitleScheduleNoticeOfLease = {
5
+ /**
6
+ * Verbatim text of the schedule-of-notices-of-leases block from the register.
7
+ */
8
+ rawText: string;
9
+ };
10
+ /** @internal */
11
+ export declare const TitleScheduleNoticeOfLease$inboundSchema: z.ZodType<TitleScheduleNoticeOfLease, z.ZodTypeDef, unknown>;
12
+ export declare function titleScheduleNoticeOfLeaseFromJSON(jsonString: string): SafeParseResult<TitleScheduleNoticeOfLease, SDKValidationError>;
13
+ //# sourceMappingURL=titleschedulenoticeoflease.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titleschedulenoticeoflease.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleschedulenoticeoflease.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAC9D,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,OAAO,CAGP,CAAC;AAEH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,0BAA0B,EAAE,kBAAkB,CAAC,CAMjE"}
@@ -0,0 +1,13 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v3";
5
+ import { safeParse } from "../../../lib/schemas.js";
6
+ /** @internal */
7
+ export const TitleScheduleNoticeOfLease$inboundSchema = z.object({
8
+ rawText: z.string(),
9
+ });
10
+ export function titleScheduleNoticeOfLeaseFromJSON(jsonString) {
11
+ return safeParse(jsonString, (x) => TitleScheduleNoticeOfLease$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TitleScheduleNoticeOfLease' from JSON`);
12
+ }
13
+ //# sourceMappingURL=titleschedulenoticeoflease.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titleschedulenoticeoflease.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleschedulenoticeoflease.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAWpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,wCAAwC,GAIjD,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAEH,MAAM,UAAU,kCAAkC,CAChD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,wCAAwC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACpE,wDAAwD,CACzD,CAAC;AACJ,CAAC"}
@@ -0,0 +1,15 @@
1
+ import * as z from "zod/v3";
2
+ import { Result as SafeParseResult } from "../../types/fp.js";
3
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
+ export type TitleSummaryCounts = {
5
+ activeMortgages: number;
6
+ covenants: number;
7
+ dischargedMortgages: number;
8
+ notices: number;
9
+ otherCharges: number;
10
+ restrictions: number;
11
+ };
12
+ /** @internal */
13
+ export declare const TitleSummaryCounts$inboundSchema: z.ZodType<TitleSummaryCounts, z.ZodTypeDef, unknown>;
14
+ export declare function titleSummaryCountsFromJSON(jsonString: string): SafeParseResult<TitleSummaryCounts, SDKValidationError>;
15
+ //# sourceMappingURL=titlesummarycounts.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titlesummarycounts.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titlesummarycounts.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CAQP,CAAC;AAEH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAMzD"}
@@ -0,0 +1,18 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v3";
5
+ import { safeParse } from "../../../lib/schemas.js";
6
+ /** @internal */
7
+ export const TitleSummaryCounts$inboundSchema = z.object({
8
+ activeMortgages: z.number().int(),
9
+ covenants: z.number().int(),
10
+ dischargedMortgages: z.number().int(),
11
+ notices: z.number().int(),
12
+ otherCharges: z.number().int(),
13
+ restrictions: z.number().int(),
14
+ });
15
+ export function titleSummaryCountsFromJSON(jsonString) {
16
+ return safeParse(jsonString, (x) => TitleSummaryCounts$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TitleSummaryCounts' from JSON`);
17
+ }
18
+ //# sourceMappingURL=titlesummarycounts.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"titlesummarycounts.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titlesummarycounts.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAapD,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACjC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC3B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACrC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACzB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC9B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC/B,CAAC,CAAC;AAEH,MAAM,UAAU,0BAA0B,CACxC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,gCAAgC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC5D,gDAAgD,CACjD,CAAC;AACJ,CAAC"}
@@ -2,6 +2,17 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
2
2
  import * as operations from "./models/operations/index.js";
3
3
  import * as shared from "./models/shared/index.js";
4
4
  export declare class Search extends ClientSDK {
5
+ /**
6
+ * Retrieve the full address record for a selected suggestion
7
+ *
8
+ * @remarks
9
+ * The selection step of the candidate-set search flow. Suggest responses are free and carry only a discovery projection (label + UPRN + match highlights); pass the chosen suggestion's `uprn` here to receive the full address record — address lines, postcode, coordinates and classification.
10
+ *
11
+ * Include the `search_id` from the suggest response to complete that search session; the retrieval is then recorded against it. Without a `search_id` (or with one that has expired or is unknown) the endpoint still works as a direct resolve and is recorded as its own transaction.
12
+ *
13
+ * This endpoint is charged per retrieved record. Repeat retrievals of the same UPRN within a billing window are charged once — see the `X-Already-Charged` response header.
14
+ */
15
+ searchRetrieve(request: operations.SearchRetrieveRequest, options?: RequestOptions): Promise<shared.SearchRetrieveResponse>;
5
16
  /**
6
17
  * Autocomplete search for UK addresses and locations
7
18
  *
@@ -12,7 +23,9 @@ export declare class Search extends ClientSDK {
12
23
  * - `geo_mode=bias` (default): soft preference. The best textual matches near the point rank higher, but distant matches are still returned.
13
24
  * - `geo_mode=restrict`: hard cutoff. Only address results within `radius_meters` of the point are returned.
14
25
  *
15
- * When a centre point is supplied, address results include a `distance` (metres from the point). Geographic ranking applies to the address source, so pair it with `source=address` for the most predictable proximity results.
26
+ * Proximity shapes the RANKING (bias) and membership (restrict) of the address results; pair it with `source=address` for the most predictable proximity behaviour. Suggest returns a discovery projection only — address rows carry the label, UPRN and match highlights, never coordinates, distance or classification. Retrieve a chosen suggestion (`GET /search/retrieve`) for the full record including coordinates.
27
+ *
28
+ * Candidate-set sessions: once a query narrows to a small exact match set, the response carries a `search_id` and slim address rows (label + UPRN + match highlights). Pass `search_id` back on subsequent keystrokes to narrow within that set without a new data fetch; when `set_complete` is true the response already contains the complete match set, so further narrowing can happen client-side. Suggest responses are not charged — charging applies when a full record is retrieved.
16
29
  */
17
30
  searchSuggest(request: operations.SearchSuggestRequest, options?: RequestOptions): Promise<shared.SearchResponse>;
18
31
  }
@@ -1 +1 @@
1
- {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;OAWG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;CAOlC"}
1
+ {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;OASG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC;IAQzC;;;;;;;;;;;;;OAaG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;CAOlC"}
@@ -1,10 +1,24 @@
1
1
  /*
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
+ import { searchSearchRetrieve } from "../funcs/searchSearchRetrieve.js";
4
5
  import { searchSearchSuggest } from "../funcs/searchSearchSuggest.js";
5
6
  import { ClientSDK } from "../lib/sdks.js";
6
7
  import { unwrapAsync } from "./types/fp.js";
7
8
  export class Search extends ClientSDK {
9
+ /**
10
+ * Retrieve the full address record for a selected suggestion
11
+ *
12
+ * @remarks
13
+ * The selection step of the candidate-set search flow. Suggest responses are free and carry only a discovery projection (label + UPRN + match highlights); pass the chosen suggestion's `uprn` here to receive the full address record — address lines, postcode, coordinates and classification.
14
+ *
15
+ * Include the `search_id` from the suggest response to complete that search session; the retrieval is then recorded against it. Without a `search_id` (or with one that has expired or is unknown) the endpoint still works as a direct resolve and is recorded as its own transaction.
16
+ *
17
+ * This endpoint is charged per retrieved record. Repeat retrievals of the same UPRN within a billing window are charged once — see the `X-Already-Charged` response header.
18
+ */
19
+ async searchRetrieve(request, options) {
20
+ return unwrapAsync(searchSearchRetrieve(this, request, options));
21
+ }
8
22
  /**
9
23
  * Autocomplete search for UK addresses and locations
10
24
  *
@@ -15,7 +29,9 @@ export class Search extends ClientSDK {
15
29
  * - `geo_mode=bias` (default): soft preference. The best textual matches near the point rank higher, but distant matches are still returned.
16
30
  * - `geo_mode=restrict`: hard cutoff. Only address results within `radius_meters` of the point are returned.
17
31
  *
18
- * When a centre point is supplied, address results include a `distance` (metres from the point). Geographic ranking applies to the address source, so pair it with `source=address` for the most predictable proximity results.
32
+ * Proximity shapes the RANKING (bias) and membership (restrict) of the address results; pair it with `source=address` for the most predictable proximity behaviour. Suggest returns a discovery projection only — address rows carry the label, UPRN and match highlights, never coordinates, distance or classification. Retrieve a chosen suggestion (`GET /search/retrieve`) for the full record including coordinates.
33
+ *
34
+ * Candidate-set sessions: once a query narrows to a small exact match set, the response carries a `search_id` and slim address rows (label + UPRN + match highlights). Pass `search_id` back on subsequent keystrokes to narrow within that set without a new data fetch; when `set_complete` is true the response already contains the complete match set, so further narrowing can happen client-side. Suggest responses are not charged — charging applies when a full record is retrieved.
19
35
  */
20
36
  async searchSuggest(request, options) {
21
37
  return unwrapAsync(searchSearchSuggest(this, request, options));
@@ -1 +1 @@
1
- {"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc,CAClB,OAAyC,EACzC,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}