@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
@@ -8,6 +8,7 @@ import * as openEnums from "../../types/enums.js";
8
8
  import { ClosedEnum, OpenEnum } from "../../types/enums.js";
9
9
  import { Result as SafeParseResult } from "../../types/fp.js";
10
10
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+ import * as shared from "../shared/index.js";
11
12
 
12
13
  /**
13
14
  * Object type identifier
@@ -148,7 +149,7 @@ export const ResolveAddressSource = {
148
149
  */
149
150
  export type ResolveAddressSource = OpenEnum<typeof ResolveAddressSource>;
150
151
 
151
- export type Matches = {
152
+ export type ResolveAddress1 = {
152
153
  /**
153
154
  * Formatted address string
154
155
  */
@@ -157,6 +158,10 @@ export type Matches = {
157
158
  * Match confidence score (0-100)
158
159
  */
159
160
  confidence: number;
161
+ /**
162
+ * Result granularity discriminator
163
+ */
164
+ granularity: "address";
160
165
  /**
161
166
  * Structural address component scores (0-1 each). Based on the ONS Address Index Matching Service (AIMS) methodology. Use these to understand which parts of the address matched well and which were uncertain.
162
167
  */
@@ -165,6 +170,10 @@ export type Matches = {
165
170
  * Original parsed address fragment
166
171
  */
167
172
  originalAddress: string;
173
+ /**
174
+ * How the returned point was derived (e.g. 'rooftop')
175
+ */
176
+ precision?: shared.GeocodePrecision | undefined;
168
177
  /**
169
178
  * Match strategy that produced this result. direct-match: address tokens matched a single record with high precision. exact-match: full address string matched verbatim. partial-match: most address components matched; some inferred. fuzzy-match: approximate match allowing for typos or abbreviations. index-lookup: resolved via indexed reference data. postcode-fallback: matched by postcode when street-level matching failed. spatial-narrative: resolved from a descriptive or rural address using spatial analysis.
170
179
  */
@@ -175,6 +184,8 @@ export type Matches = {
175
184
  uprn: string;
176
185
  };
177
186
 
187
+ export type Matches = ResolveAddress1 | shared.StreetMatch;
188
+
178
189
  /**
179
190
  * Detected address pattern type
180
191
  */
@@ -278,9 +289,9 @@ export type Result = {
278
289
  */
279
290
  matchQuality?: MatchQuality | undefined;
280
291
  /**
281
- * Array of matched addresses
292
+ * Array of matched addresses and/or streets
282
293
  */
283
- matches: Array<Matches>;
294
+ matches: Array<ResolveAddress1 | shared.StreetMatch>;
284
295
  /**
285
296
  * Metadata about the matching process
286
297
  */
@@ -407,16 +418,38 @@ export const ResolveAddressSource$inboundSchema: z.ZodType<
407
418
  unknown
408
419
  > = openEnums.inboundSchema(ResolveAddressSource);
409
420
 
421
+ /** @internal */
422
+ export const ResolveAddress1$inboundSchema: z.ZodType<
423
+ ResolveAddress1,
424
+ z.ZodTypeDef,
425
+ unknown
426
+ > = z.object({
427
+ address: z.string(),
428
+ confidence: z.number(),
429
+ granularity: z.literal("address"),
430
+ hopperComponents: z.lazy(() => HopperComponents$inboundSchema).optional(),
431
+ originalAddress: z.string(),
432
+ precision: shared.GeocodePrecision$inboundSchema.optional(),
433
+ source: ResolveAddressSource$inboundSchema,
434
+ uprn: z.string(),
435
+ });
436
+
437
+ export function resolveAddress1FromJSON(
438
+ jsonString: string,
439
+ ): SafeParseResult<ResolveAddress1, SDKValidationError> {
440
+ return safeParse(
441
+ jsonString,
442
+ (x) => ResolveAddress1$inboundSchema.parse(JSON.parse(x)),
443
+ `Failed to parse 'ResolveAddress1' from JSON`,
444
+ );
445
+ }
446
+
410
447
  /** @internal */
411
448
  export const Matches$inboundSchema: z.ZodType<Matches, z.ZodTypeDef, unknown> =
412
- z.object({
413
- address: z.string(),
414
- confidence: z.number(),
415
- hopperComponents: z.lazy(() => HopperComponents$inboundSchema).optional(),
416
- originalAddress: z.string(),
417
- source: ResolveAddressSource$inboundSchema,
418
- uprn: z.string(),
419
- });
449
+ z.union([
450
+ z.lazy(() => ResolveAddress1$inboundSchema),
451
+ shared.StreetMatch$inboundSchema,
452
+ ]);
420
453
 
421
454
  export function matchesFromJSON(
422
455
  jsonString: string,
@@ -498,7 +531,12 @@ export const Result$inboundSchema: z.ZodType<Result, z.ZodTypeDef, unknown> = z
498
531
  confidence: z.number(),
499
532
  confidenceZone: ConfidenceZone$inboundSchema.optional(),
500
533
  matchQuality: z.lazy(() => MatchQuality$inboundSchema).optional(),
501
- matches: z.array(z.lazy(() => Matches$inboundSchema)),
534
+ matches: z.array(
535
+ z.union([
536
+ z.lazy(() => ResolveAddress1$inboundSchema),
537
+ shared.StreetMatch$inboundSchema,
538
+ ]),
539
+ ),
502
540
  metadata: z.lazy(() => ResolveAddressMetadata$inboundSchema),
503
541
  recommendationCode: RecommendationCode$inboundSchema.optional(),
504
542
  unambiguityScore: z.number().optional(),
@@ -0,0 +1,45 @@
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
+
8
+ export type SearchRetrieveRequest = {
9
+ /**
10
+ * The `search_id` returned by the suggest response this selection was made from. Supplying it completes that search session. Omitted or unknown, the retrieve still works as a direct resolve and is recorded as its own transaction.
11
+ */
12
+ searchId?: string | undefined;
13
+ /**
14
+ * Unique Property Reference Number of the address to retrieve — the `uprn` field of a suggest result. The full record for this UPRN is returned and charged.
15
+ */
16
+ uprn: string;
17
+ };
18
+
19
+ /** @internal */
20
+ export type SearchRetrieveRequest$Outbound = {
21
+ search_id?: string | undefined;
22
+ uprn: string;
23
+ };
24
+
25
+ /** @internal */
26
+ export const SearchRetrieveRequest$outboundSchema: z.ZodType<
27
+ SearchRetrieveRequest$Outbound,
28
+ z.ZodTypeDef,
29
+ SearchRetrieveRequest
30
+ > = z.object({
31
+ searchId: z.string().optional(),
32
+ uprn: z.string(),
33
+ }).transform((v) => {
34
+ return remap$(v, {
35
+ searchId: "search_id",
36
+ });
37
+ });
38
+
39
+ export function searchRetrieveRequestToJSON(
40
+ searchRetrieveRequest: SearchRetrieveRequest,
41
+ ): string {
42
+ return JSON.stringify(
43
+ SearchRetrieveRequest$outboundSchema.parse(searchRetrieveRequest),
44
+ );
45
+ }
@@ -53,6 +53,26 @@ export const GeoMode = {
53
53
  */
54
54
  export type GeoMode = ClosedEnum<typeof GeoMode>;
55
55
 
56
+ /**
57
+ * Result granularity level:
58
+ *
59
+ * @remarks
60
+ * - `address` (default): premise-level autocomplete — behaviour is unchanged.
61
+ * - `street`: returns one result per named street (USRN-level) with a representative centre point, for partial locations such as 'West Street, Sheffield'. Streets that share a name are disambiguated by the town in the query and, when supplied, the `lat`/`lng`/`radius_meters`/`geo_mode` params.
62
+ */
63
+ export const Granularity = {
64
+ Address: "address",
65
+ Street: "street",
66
+ } as const;
67
+ /**
68
+ * Result granularity level:
69
+ *
70
+ * @remarks
71
+ * - `address` (default): premise-level autocomplete — behaviour is unchanged.
72
+ * - `street`: returns one result per named street (USRN-level) with a representative centre point, for partial locations such as 'West Street, Sheffield'. Streets that share a name are disambiguated by the town in the query and, when supplied, the `lat`/`lng`/`radius_meters`/`geo_mode` params.
73
+ */
74
+ export type Granularity = ClosedEnum<typeof Granularity>;
75
+
56
76
  export type SearchSuggestRequest = {
57
77
  /**
58
78
  * Restrict address results to current, addressable properties only. When 'true', excludes historical and superseded address records (those without a current LPI), returning only addresses that resolve to a live property record. Defaults to 'false' (the full address universe, including historical entries). Applies to address-source results only.
@@ -71,6 +91,14 @@ export type SearchSuggestRequest = {
71
91
  * Applies to address-source results.
72
92
  */
73
93
  geoMode?: GeoMode | undefined;
94
+ /**
95
+ * Result granularity level:
96
+ *
97
+ * @remarks
98
+ * - `address` (default): premise-level autocomplete — behaviour is unchanged.
99
+ * - `street`: returns one result per named street (USRN-level) with a representative centre point, for partial locations such as 'West Street, Sheffield'. Streets that share a name are disambiguated by the town in the query and, when supplied, the `lat`/`lng`/`radius_meters`/`geo_mode` params.
100
+ */
101
+ granularity?: Granularity | undefined;
74
102
  /**
75
103
  * Latitude of a geographic centre point (WGS84 decimal degrees, -90 to 90). Must be supplied together with `lng`. Enables proximity-aware ranking of address results, most effective when combined with `source=address`.
76
104
  */
@@ -95,6 +123,10 @@ export type SearchSuggestRequest = {
95
123
  * Radius in metres from (`lat`, `lng`). Required when `geo_mode=restrict` (results outside the radius are excluded). When `geo_mode=bias`, it tunes the strength of the soft preference: the distance at which a result's textual score is roughly halved, and defaults to 10000 when omitted.
96
124
  */
97
125
  radiusMeters?: number | undefined;
126
+ /**
127
+ * Candidate-set session id returned by a previous suggest response (`search_id`). When supplied and still valid, the new query narrows within the already-fetched candidate set server-side — no new data fetch. An unknown or expired id falls back to a normal search.
128
+ */
129
+ searchId?: string | undefined;
98
130
  /**
99
131
  * Filter results to specific search source (address or location)
100
132
  */
@@ -115,17 +147,23 @@ export const Classification$outboundSchema: z.ZodNativeEnum<
115
147
  export const GeoMode$outboundSchema: z.ZodNativeEnum<typeof GeoMode> = z
116
148
  .nativeEnum(GeoMode);
117
149
 
150
+ /** @internal */
151
+ export const Granularity$outboundSchema: z.ZodNativeEnum<typeof Granularity> = z
152
+ .nativeEnum(Granularity);
153
+
118
154
  /** @internal */
119
155
  export type SearchSuggestRequest$Outbound = {
120
156
  addressable_only?: string | undefined;
121
157
  classification?: string | undefined;
122
158
  geo_mode?: string | undefined;
159
+ granularity?: string | undefined;
123
160
  lat?: number | undefined;
124
161
  limit?: string | undefined;
125
162
  lng?: number | undefined;
126
163
  offset?: string | undefined;
127
164
  q: string;
128
165
  radius_meters?: number | undefined;
166
+ search_id?: string | undefined;
129
167
  source?: string | undefined;
130
168
  };
131
169
 
@@ -138,18 +176,21 @@ export const SearchSuggestRequest$outboundSchema: z.ZodType<
138
176
  addressableOnly: AddressableOnly$outboundSchema.optional(),
139
177
  classification: Classification$outboundSchema.optional(),
140
178
  geoMode: GeoMode$outboundSchema.optional(),
179
+ granularity: Granularity$outboundSchema.optional(),
141
180
  lat: z.number().optional(),
142
181
  limit: z.string().optional(),
143
182
  lng: z.number().optional(),
144
183
  offset: z.string().optional(),
145
184
  q: z.string(),
146
185
  radiusMeters: z.number().int().optional(),
186
+ searchId: z.string().optional(),
147
187
  source: z.string().optional(),
148
188
  }).transform((v) => {
149
189
  return remap$(v, {
150
190
  addressableOnly: "addressable_only",
151
191
  geoMode: "geo_mode",
152
192
  radiusMeters: "radius_meters",
193
+ searchId: "search_id",
153
194
  });
154
195
  });
155
196
 
@@ -20,6 +20,24 @@ export type AddressResolveRequestClassification = ClosedEnum<
20
20
  typeof AddressResolveRequestClassification
21
21
  >;
22
22
 
23
+ export const AddressResolveRequest2 = {
24
+ Auto: "auto",
25
+ } as const;
26
+ export type AddressResolveRequest2 = ClosedEnum<typeof AddressResolveRequest2>;
27
+
28
+ export const AddressResolveRequest1 = {
29
+ Address: "address",
30
+ Street: "street",
31
+ } as const;
32
+ export type AddressResolveRequest1 = ClosedEnum<typeof AddressResolveRequest1>;
33
+
34
+ /**
35
+ * Resolution granularity. 'address' (default): premise-level UPRN resolution — behaviour is unchanged. 'street': resolve to a named street (USRN-level) with a representative point, for partial inputs such as 'West Street, Sheffield' that have no building number. 'auto': try premise-level first and fall back to street-level when no building matches.
36
+ */
37
+ export type AddressResolveRequestGranularity =
38
+ | AddressResolveRequest1
39
+ | AddressResolveRequest2;
40
+
23
41
  /**
24
42
  * Optional matching configuration
25
43
  */
@@ -40,6 +58,10 @@ export type Options = {
40
58
  * Confidence threshold below which fallback matching is triggered
41
59
  */
42
60
  fallbackThreshold?: number | undefined;
61
+ /**
62
+ * Resolution granularity. 'address' (default): premise-level UPRN resolution — behaviour is unchanged. 'street': resolve to a named street (USRN-level) with a representative point, for partial inputs such as 'West Street, Sheffield' that have no building number. 'auto': try premise-level first and fall back to street-level when no building matches.
63
+ */
64
+ granularity?: AddressResolveRequest1 | AddressResolveRequest2 | undefined;
43
65
  /**
44
66
  * Include detailed processing steps in response
45
67
  */
@@ -71,12 +93,46 @@ export const AddressResolveRequestClassification$outboundSchema:
71
93
  AddressResolveRequestClassification,
72
94
  );
73
95
 
96
+ /** @internal */
97
+ export const AddressResolveRequest2$outboundSchema: z.ZodNativeEnum<
98
+ typeof AddressResolveRequest2
99
+ > = z.nativeEnum(AddressResolveRequest2);
100
+
101
+ /** @internal */
102
+ export const AddressResolveRequest1$outboundSchema: z.ZodNativeEnum<
103
+ typeof AddressResolveRequest1
104
+ > = z.nativeEnum(AddressResolveRequest1);
105
+
106
+ /** @internal */
107
+ export type AddressResolveRequestGranularity$Outbound = string | string;
108
+
109
+ /** @internal */
110
+ export const AddressResolveRequestGranularity$outboundSchema: z.ZodType<
111
+ AddressResolveRequestGranularity$Outbound,
112
+ z.ZodTypeDef,
113
+ AddressResolveRequestGranularity
114
+ > = z.union([
115
+ AddressResolveRequest1$outboundSchema,
116
+ AddressResolveRequest2$outboundSchema,
117
+ ]);
118
+
119
+ export function addressResolveRequestGranularityToJSON(
120
+ addressResolveRequestGranularity: AddressResolveRequestGranularity,
121
+ ): string {
122
+ return JSON.stringify(
123
+ AddressResolveRequestGranularity$outboundSchema.parse(
124
+ addressResolveRequestGranularity,
125
+ ),
126
+ );
127
+ }
128
+
74
129
  /** @internal */
75
130
  export type Options$Outbound = {
76
131
  classification?: string | undefined;
77
132
  confidenceThreshold?: number | undefined;
78
133
  enableFallback?: boolean | undefined;
79
134
  fallbackThreshold?: number | undefined;
135
+ granularity?: string | string | undefined;
80
136
  includeProcessingDetails?: boolean | undefined;
81
137
  maxResults?: number | undefined;
82
138
  timeout?: number | undefined;
@@ -92,6 +148,10 @@ export const Options$outboundSchema: z.ZodType<
92
148
  confidenceThreshold: z.number().optional(),
93
149
  enableFallback: z.boolean().optional(),
94
150
  fallbackThreshold: z.number().optional(),
151
+ granularity: z.union([
152
+ AddressResolveRequest1$outboundSchema,
153
+ AddressResolveRequest2$outboundSchema,
154
+ ]).optional(),
95
155
  includeProcessingDetails: z.boolean().optional(),
96
156
  maxResults: z.number().optional(),
97
157
  timeout: z.number().optional(),
@@ -82,7 +82,7 @@ export type FloorPlanImages = {
82
82
  /**
83
83
  * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
84
84
  */
85
- caption?: string | undefined;
85
+ caption?: string | null | undefined;
86
86
  /**
87
87
  * Zero-based display order for the image within its type group. The first image (order 0) is typically the hero/primary image used for thumbnails and search results.
88
88
  */
@@ -120,7 +120,7 @@ export type Images = {
120
120
  /**
121
121
  * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
122
122
  */
123
- caption?: string | undefined;
123
+ caption?: string | null | undefined;
124
124
  /**
125
125
  * Zero-based display order for the image within its type group. The first image (order 0) is typically the hero/primary image used for thumbnails and search results.
126
126
  */
@@ -319,7 +319,7 @@ export const FloorPlanImages$inboundSchema: z.ZodType<
319
319
  z.ZodTypeDef,
320
320
  unknown
321
321
  > = z.object({
322
- caption: z.string().optional(),
322
+ caption: z.nullable(z.string()).optional(),
323
323
  order: z.number().optional(),
324
324
  type: AdvancedListingSchemasType$inboundSchema.optional(),
325
325
  url: z.string(),
@@ -345,7 +345,7 @@ export const AdvancedListingSchemasImagesType$inboundSchema: z.ZodType<
345
345
  /** @internal */
346
346
  export const Images$inboundSchema: z.ZodType<Images, z.ZodTypeDef, unknown> = z
347
347
  .object({
348
- caption: z.string().optional(),
348
+ caption: z.nullable(z.string()).optional(),
349
349
  order: z.number().optional(),
350
350
  type: AdvancedListingSchemasImagesType$inboundSchema.optional(),
351
351
  url: z.string(),
@@ -3,11 +3,29 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod/v3";
6
+ import { ClosedEnum } from "../../types/enums.js";
7
+
8
+ /**
9
+ * Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
10
+ */
11
+ export const CodeSystem = {
12
+ OnsGss: "ons_gss",
13
+ CsoSa: "cso_sa",
14
+ CsoEd: "cso_ed",
15
+ } as const;
16
+ /**
17
+ * Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
18
+ */
19
+ export type CodeSystem = ClosedEnum<typeof CodeSystem>;
6
20
 
7
21
  /**
8
22
  * Request body for the multi-area census profile.
9
23
  */
10
24
  export type CensusAreaProfileRequest = {
25
+ /**
26
+ * Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
27
+ */
28
+ codeSystem?: CodeSystem | undefined;
11
29
  /**
12
30
  * Stable public dataset id.
13
31
  */
@@ -22,8 +40,13 @@ export type CensusAreaProfileRequest = {
22
40
  variableSlugs?: Array<string> | undefined;
23
41
  };
24
42
 
43
+ /** @internal */
44
+ export const CodeSystem$outboundSchema: z.ZodNativeEnum<typeof CodeSystem> = z
45
+ .nativeEnum(CodeSystem);
46
+
25
47
  /** @internal */
26
48
  export type CensusAreaProfileRequest$Outbound = {
49
+ codeSystem: string;
27
50
  datasetCode: string;
28
51
  geographyCodes: Array<string>;
29
52
  variableSlugs?: Array<string> | undefined;
@@ -35,6 +58,7 @@ export const CensusAreaProfileRequest$outboundSchema: z.ZodType<
35
58
  z.ZodTypeDef,
36
59
  CensusAreaProfileRequest
37
60
  > = z.object({
61
+ codeSystem: CodeSystem$outboundSchema.default("ons_gss"),
38
62
  datasetCode: z.string(),
39
63
  geographyCodes: z.array(z.string()),
40
64
  variableSlugs: z.array(z.string()).optional(),
@@ -3,6 +3,22 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod/v3";
6
+ import { ClosedEnum } from "../../types/enums.js";
7
+
8
+ /**
9
+ * Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
10
+ */
11
+ export const CensusRollupRequestCodeSystem = {
12
+ OnsGss: "ons_gss",
13
+ CsoSa: "cso_sa",
14
+ CsoEd: "cso_ed",
15
+ } as const;
16
+ /**
17
+ * Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
18
+ */
19
+ export type CensusRollupRequestCodeSystem = ClosedEnum<
20
+ typeof CensusRollupRequestCodeSystem
21
+ >;
6
22
 
7
23
  /**
8
24
  * Request body for the custom-area census rollup. Ratios are SUM(count)/SUM(base), never an average of ratios.
@@ -12,6 +28,10 @@ export type CensusRollupRequest = {
12
28
  * Category codes ('{classificationCode}-{NNN}') to roll up across the custom area. At least one is required; there is no wildcard — list every code you want.
13
29
  */
14
30
  categoryCodes: Array<string>;
31
+ /**
32
+ * Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
33
+ */
34
+ codeSystem?: CensusRollupRequestCodeSystem | undefined;
15
35
  /**
16
36
  * Stable public dataset id.
17
37
  */
@@ -22,9 +42,15 @@ export type CensusRollupRequest = {
22
42
  geographyCodes: Array<string>;
23
43
  };
24
44
 
45
+ /** @internal */
46
+ export const CensusRollupRequestCodeSystem$outboundSchema: z.ZodNativeEnum<
47
+ typeof CensusRollupRequestCodeSystem
48
+ > = z.nativeEnum(CensusRollupRequestCodeSystem);
49
+
25
50
  /** @internal */
26
51
  export type CensusRollupRequest$Outbound = {
27
52
  categoryCodes: Array<string>;
53
+ codeSystem: string;
28
54
  datasetCode: string;
29
55
  geographyCodes: Array<string>;
30
56
  };
@@ -36,6 +62,7 @@ export const CensusRollupRequest$outboundSchema: z.ZodType<
36
62
  CensusRollupRequest
37
63
  > = z.object({
38
64
  categoryCodes: z.array(z.string()),
65
+ codeSystem: CensusRollupRequestCodeSystem$outboundSchema.default("ons_gss"),
39
66
  datasetCode: z.string(),
40
67
  geographyCodes: z.array(z.string()),
41
68
  });
@@ -0,0 +1,27 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import * as openEnums from "../../types/enums.js";
7
+ import { OpenEnum } from "../../types/enums.js";
8
+
9
+ /**
10
+ * How the returned point was derived (e.g. 'rooftop')
11
+ */
12
+ export const GeocodePrecision = {
13
+ Rooftop: "rooftop",
14
+ StreetCentre: "street_centre",
15
+ Approximate: "approximate",
16
+ } as const;
17
+ /**
18
+ * How the returned point was derived (e.g. 'rooftop')
19
+ */
20
+ export type GeocodePrecision = OpenEnum<typeof GeocodePrecision>;
21
+
22
+ /** @internal */
23
+ export const GeocodePrecision$inboundSchema: z.ZodType<
24
+ GeocodePrecision,
25
+ z.ZodTypeDef,
26
+ unknown
27
+ > = openEnums.inboundSchema(GeocodePrecision);
@@ -172,13 +172,6 @@ export * from "./epcsort.js";
172
172
  export * from "./exceedancelevel.js";
173
173
  export * from "./extendedstatsaggregationresult.js";
174
174
  export * from "./extractioncitation.js";
175
- export * from "./extractiondocumentsummary.js";
176
- export * from "./extractionmortgagecharge.js";
177
- export * from "./extractionnotice.js";
178
- export * from "./extractionothercharge.js";
179
- export * from "./extractionpayload.js";
180
- export * from "./extractionproprietor.js";
181
- export * from "./extractionrestriction.js";
182
175
  export * from "./floodclimate2080.js";
183
176
  export * from "./flooddataavailability.js";
184
177
  export * from "./flooddefence.js";
@@ -199,6 +192,7 @@ export * from "./floodzone.js";
199
192
  export * from "./framework.js";
200
193
  export * from "./frameworkdetailresponse.js";
201
194
  export * from "./frameworklistresponse.js";
195
+ export * from "./geocodeprecision.js";
202
196
  export * from "./geographiccontext.js";
203
197
  export * from "./geographycategorymetric.js";
204
198
  export * from "./geographymetricslistresponse.js";
@@ -244,6 +238,7 @@ export * from "./metricscomparerequest.js";
244
238
  export * from "./mitigationmeasure.js";
245
239
  export * from "./monthlycategorystats.js";
246
240
  export * from "./monthlycategorystatslistresponse.js";
241
+ export * from "./mortgagecharge.js";
247
242
  export * from "./nearestpostcodesresponse.js";
248
243
  export * from "./nestedaggregation.js";
249
244
  export * from "./nestedaggregationresult.js";
@@ -252,6 +247,7 @@ export * from "./officerlistresponse.js";
252
247
  export * from "./officerresponse.js";
253
248
  export * from "./officersummary.js";
254
249
  export * from "./officialindex.js";
250
+ export * from "./othercharge.js";
255
251
  export * from "./outcodelookupresponse.js";
256
252
  export * from "./percentilesaggregationresult.js";
257
253
  export * from "./person.js";
@@ -333,6 +329,7 @@ export * from "./pscresponse.js";
333
329
  export * from "./pscsummary.js";
334
330
  export * from "./rangedefinition.js";
335
331
  export * from "./refurbishmentdata.js";
332
+ export * from "./registeredcharges.js";
336
333
  export * from "./regulator.js";
337
334
  export * from "./regulatorydomain.js";
338
335
  export * from "./regulatoryzone.js";
@@ -358,6 +355,7 @@ export * from "./schoolvideo.js";
358
355
  export * from "./searchhighlight.js";
359
356
  export * from "./searchresponse.js";
360
357
  export * from "./searchresult.js";
358
+ export * from "./searchretrieveresponse.js";
361
359
  export * from "./security.js";
362
360
  export * from "./siccode.js";
363
361
  export * from "./singlevalueaggregationresult.js";
@@ -391,6 +389,7 @@ export * from "./socialmedialinks.js";
391
389
  export * from "./statsaggregationresult.js";
392
390
  export * from "./streetdescriptor.js";
393
391
  export * from "./streetdetails.js";
392
+ export * from "./streetmatch.js";
394
393
  export * from "./streetquerybycoordinates.js";
395
394
  export * from "./streetquerybyname.js";
396
395
  export * from "./streetquerybypostcode.js";
@@ -404,9 +403,17 @@ export * from "./tenuredata.js";
404
403
  export * from "./termsaggregationresult.js";
405
404
  export * from "./termsbucket.js";
406
405
  export * from "./tierskipreason.js";
406
+ export * from "./titlecovenant.js";
407
407
  export * from "./titledeeddocumentlistresponse.js";
408
408
  export * from "./titledeedpurchaseresponse.js";
409
+ export * from "./titledocumentsummary.js";
410
+ export * from "./titleextractionpayload.js";
409
411
  export * from "./titleextractionpollresponse.js";
412
+ export * from "./titlenotice.js";
413
+ export * from "./titleproprietor.js";
414
+ export * from "./titlerestriction.js";
415
+ export * from "./titleschedulenoticeoflease.js";
416
+ export * from "./titlesummarycounts.js";
410
417
  export * from "./transaction.js";
411
418
  export * from "./transactionaddress.js";
412
419
  export * from "./transactionareafilter.js";
@@ -0,0 +1,76 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import * as openEnums from "../../types/enums.js";
8
+ import { OpenEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+ import {
12
+ TitleProprietor,
13
+ TitleProprietor$inboundSchema,
14
+ } from "./titleproprietor.js";
15
+
16
+ export const MortgageChargeStatus = {
17
+ Active: "active",
18
+ Discharged: "discharged",
19
+ } as const;
20
+ export type MortgageChargeStatus = OpenEnum<typeof MortgageChargeStatus>;
21
+
22
+ export type MortgageCharge = {
23
+ chargeDate: string;
24
+ chargeHolder: TitleProprietor;
25
+ /**
26
+ * Date the charge was discharged. Null when status is 'active'.
27
+ */
28
+ dischargedDate: string | null;
29
+ /**
30
+ * AI-authored plain-language description of what this charge means for the owner.
31
+ */
32
+ effectOfCharge: string;
33
+ registrationDate: string;
34
+ /**
35
+ * Register entry reference for audit traceability
36
+ */
37
+ sourceEntryRef: string;
38
+ status: MortgageChargeStatus;
39
+ /**
40
+ * Title number this charge affects. May be this title or a related title.
41
+ */
42
+ titleAffected: string;
43
+ };
44
+
45
+ /** @internal */
46
+ export const MortgageChargeStatus$inboundSchema: z.ZodType<
47
+ MortgageChargeStatus,
48
+ z.ZodTypeDef,
49
+ unknown
50
+ > = openEnums.inboundSchema(MortgageChargeStatus);
51
+
52
+ /** @internal */
53
+ export const MortgageCharge$inboundSchema: z.ZodType<
54
+ MortgageCharge,
55
+ z.ZodTypeDef,
56
+ unknown
57
+ > = z.object({
58
+ chargeDate: z.string(),
59
+ chargeHolder: TitleProprietor$inboundSchema,
60
+ dischargedDate: z.nullable(z.string()),
61
+ effectOfCharge: z.string(),
62
+ registrationDate: z.string(),
63
+ sourceEntryRef: z.string(),
64
+ status: MortgageChargeStatus$inboundSchema,
65
+ titleAffected: z.string(),
66
+ });
67
+
68
+ export function mortgageChargeFromJSON(
69
+ jsonString: string,
70
+ ): SafeParseResult<MortgageCharge, SDKValidationError> {
71
+ return safeParse(
72
+ jsonString,
73
+ (x) => MortgageCharge$inboundSchema.parse(JSON.parse(x)),
74
+ `Failed to parse 'MortgageCharge' from JSON`,
75
+ );
76
+ }