@vepler/sdk 2.164.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 (636) hide show
  1. package/README.md +408 -401
  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/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts +1 -1
  65. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts.map +1 -1
  66. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js +2 -1
  67. package/dist/commonjs/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js.map +1 -1
  68. package/dist/commonjs/lib/config.d.ts +3 -3
  69. package/dist/commonjs/lib/config.js +3 -3
  70. package/dist/commonjs/lib/config.js.map +1 -1
  71. package/dist/commonjs/sdk/models/errors/index.d.ts +1 -0
  72. package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
  73. package/dist/commonjs/sdk/models/errors/index.js +1 -0
  74. package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
  75. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts +65 -0
  76. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts.map +1 -1
  77. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.js +55 -1
  78. package/dist/commonjs/sdk/models/errors/postv1titledeedstitlenumberpurchase.js.map +1 -1
  79. package/dist/commonjs/sdk/models/errors/predictpropertyvalue.d.ts +65 -0
  80. package/dist/commonjs/sdk/models/errors/predictpropertyvalue.d.ts.map +1 -1
  81. package/dist/commonjs/sdk/models/errors/predictpropertyvalue.js +57 -1
  82. package/dist/commonjs/sdk/models/errors/predictpropertyvalue.js.map +1 -1
  83. package/dist/commonjs/sdk/models/errors/searchretrieve.d.ts +201 -0
  84. package/dist/commonjs/sdk/models/errors/searchretrieve.d.ts.map +1 -0
  85. package/dist/commonjs/sdk/models/errors/searchretrieve.js +213 -0
  86. package/dist/commonjs/sdk/models/errors/searchretrieve.js.map +1 -0
  87. package/dist/commonjs/sdk/models/operations/getcensuswholelevel.d.ts +1 -0
  88. package/dist/commonjs/sdk/models/operations/getcensuswholelevel.d.ts.map +1 -1
  89. package/dist/commonjs/sdk/models/operations/getcensuswholelevel.js +1 -0
  90. package/dist/commonjs/sdk/models/operations/getcensuswholelevel.js.map +1 -1
  91. package/dist/commonjs/sdk/models/operations/getlistingbyid.d.ts +18 -15
  92. package/dist/commonjs/sdk/models/operations/getlistingbyid.d.ts.map +1 -1
  93. package/dist/commonjs/sdk/models/operations/getlistingbyid.js +15 -15
  94. package/dist/commonjs/sdk/models/operations/getlistingbyid.js.map +1 -1
  95. package/dist/commonjs/sdk/models/operations/getlistingbysource.d.ts +18 -15
  96. package/dist/commonjs/sdk/models/operations/getlistingbysource.d.ts.map +1 -1
  97. package/dist/commonjs/sdk/models/operations/getlistingbysource.js +15 -15
  98. package/dist/commonjs/sdk/models/operations/getlistingbysource.js.map +1 -1
  99. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.d.ts +18 -15
  100. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.d.ts.map +1 -1
  101. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.js +16 -15
  102. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.js.map +1 -1
  103. package/dist/commonjs/sdk/models/operations/getproperties.d.ts +5 -0
  104. package/dist/commonjs/sdk/models/operations/getproperties.d.ts.map +1 -1
  105. package/dist/commonjs/sdk/models/operations/getproperties.js +1 -0
  106. package/dist/commonjs/sdk/models/operations/getproperties.js.map +1 -1
  107. package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.d.ts +5 -0
  108. package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.d.ts.map +1 -1
  109. package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.js +1 -0
  110. package/dist/commonjs/sdk/models/operations/getpropertiesbylocation.js.map +1 -1
  111. package/dist/commonjs/sdk/models/operations/getpropertiesbysource.d.ts +5 -0
  112. package/dist/commonjs/sdk/models/operations/getpropertiesbysource.d.ts.map +1 -1
  113. package/dist/commonjs/sdk/models/operations/getpropertiesbysource.js +1 -0
  114. package/dist/commonjs/sdk/models/operations/getpropertiesbysource.js.map +1 -1
  115. package/dist/commonjs/sdk/models/operations/index.d.ts +1 -0
  116. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  117. package/dist/commonjs/sdk/models/operations/index.js +1 -0
  118. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  119. package/dist/commonjs/sdk/models/operations/querylistings.d.ts +18 -15
  120. package/dist/commonjs/sdk/models/operations/querylistings.d.ts.map +1 -1
  121. package/dist/commonjs/sdk/models/operations/querylistings.js +17 -16
  122. package/dist/commonjs/sdk/models/operations/querylistings.js.map +1 -1
  123. package/dist/commonjs/sdk/models/operations/querylistingsbysource.d.ts +18 -15
  124. package/dist/commonjs/sdk/models/operations/querylistingsbysource.d.ts.map +1 -1
  125. package/dist/commonjs/sdk/models/operations/querylistingsbysource.js +16 -15
  126. package/dist/commonjs/sdk/models/operations/querylistingsbysource.js.map +1 -1
  127. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts +16 -3
  128. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  129. package/dist/commonjs/sdk/models/operations/resolveaddress.js +18 -3
  130. package/dist/commonjs/sdk/models/operations/resolveaddress.js.map +1 -1
  131. package/dist/commonjs/sdk/models/operations/searchretrieve.d.ts +20 -0
  132. package/dist/commonjs/sdk/models/operations/searchretrieve.d.ts.map +1 -0
  133. package/dist/commonjs/sdk/models/operations/searchretrieve.js +55 -0
  134. package/dist/commonjs/sdk/models/operations/searchretrieve.js.map +1 -0
  135. package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts +35 -0
  136. package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts.map +1 -1
  137. package/dist/commonjs/sdk/models/operations/searchsuggest.js +18 -1
  138. package/dist/commonjs/sdk/models/operations/searchsuggest.js.map +1 -1
  139. package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts +27 -0
  140. package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts.map +1 -1
  141. package/dist/commonjs/sdk/models/shared/addressresolverequest.js +25 -1
  142. package/dist/commonjs/sdk/models/shared/addressresolverequest.js.map +1 -1
  143. package/dist/commonjs/sdk/models/shared/advancedlisting.d.ts +2 -2
  144. package/dist/commonjs/sdk/models/shared/advancedlisting.d.ts.map +1 -1
  145. package/dist/commonjs/sdk/models/shared/advancedlisting.js +2 -2
  146. package/dist/commonjs/sdk/models/shared/advancedlisting.js.map +1 -1
  147. package/dist/commonjs/sdk/models/shared/aggregationresult.d.ts +2 -1
  148. package/dist/commonjs/sdk/models/shared/aggregationresult.d.ts.map +1 -1
  149. package/dist/commonjs/sdk/models/shared/aggregationresult.js +2 -0
  150. package/dist/commonjs/sdk/models/shared/aggregationresult.js.map +1 -1
  151. package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.d.ts +20 -0
  152. package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.d.ts.map +1 -1
  153. package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.js +13 -1
  154. package/dist/commonjs/sdk/models/shared/censusareaprofilerequest.js.map +1 -1
  155. package/dist/commonjs/sdk/models/shared/censusrolluprequest.d.ts +20 -0
  156. package/dist/commonjs/sdk/models/shared/censusrolluprequest.d.ts.map +1 -1
  157. package/dist/commonjs/sdk/models/shared/censusrolluprequest.js +12 -1
  158. package/dist/commonjs/sdk/models/shared/censusrolluprequest.js.map +1 -1
  159. package/dist/commonjs/sdk/models/shared/geocodeprecision.d.ts +17 -0
  160. package/dist/commonjs/sdk/models/shared/geocodeprecision.d.ts.map +1 -0
  161. package/dist/commonjs/sdk/models/shared/geocodeprecision.js +51 -0
  162. package/dist/commonjs/sdk/models/shared/geocodeprecision.js.map +1 -0
  163. package/dist/commonjs/sdk/models/shared/histogrambucket.d.ts +7 -0
  164. package/dist/commonjs/sdk/models/shared/histogrambucket.d.ts.map +1 -1
  165. package/dist/commonjs/sdk/models/shared/histogrambucket.js +4 -2
  166. package/dist/commonjs/sdk/models/shared/histogrambucket.js.map +1 -1
  167. package/dist/commonjs/sdk/models/shared/index.d.ts +15 -7
  168. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  169. package/dist/commonjs/sdk/models/shared/index.js +15 -7
  170. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  171. package/dist/commonjs/sdk/models/shared/mortgagecharge.d.ts +38 -0
  172. package/dist/commonjs/sdk/models/shared/mortgagecharge.d.ts.map +1 -0
  173. package/dist/commonjs/sdk/models/shared/{extractionmortgagecharge.js → mortgagecharge.js} +11 -11
  174. package/dist/commonjs/sdk/models/shared/mortgagecharge.js.map +1 -0
  175. package/dist/commonjs/sdk/models/shared/nestedaggregationresult.d.ts +16 -0
  176. package/dist/commonjs/sdk/models/shared/nestedaggregationresult.d.ts.map +1 -0
  177. package/dist/commonjs/sdk/models/shared/{extractionproprietor.js → nestedaggregationresult.js} +12 -15
  178. package/dist/commonjs/sdk/models/shared/nestedaggregationresult.js.map +1 -0
  179. package/dist/commonjs/sdk/models/shared/othercharge.d.ts +23 -0
  180. package/dist/commonjs/sdk/models/shared/othercharge.d.ts.map +1 -0
  181. package/dist/commonjs/sdk/models/shared/{extractionothercharge.js → othercharge.js} +6 -6
  182. package/dist/commonjs/sdk/models/shared/othercharge.js.map +1 -0
  183. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts +24 -2
  184. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts.map +1 -1
  185. package/dist/commonjs/sdk/models/shared/propertyaddress.js +14 -2
  186. package/dist/commonjs/sdk/models/shared/propertyaddress.js.map +1 -1
  187. package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.d.ts +5 -0
  188. package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.d.ts.map +1 -1
  189. package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.js +1 -0
  190. package/dist/commonjs/sdk/models/shared/propertybyslugsrequest.js.map +1 -1
  191. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts +38 -0
  192. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  193. package/dist/commonjs/sdk/models/shared/propertydataapi.js +22 -1
  194. package/dist/commonjs/sdk/models/shared/propertydataapi.js.map +1 -1
  195. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts +5 -0
  196. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
  197. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js +1 -0
  198. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js.map +1 -1
  199. package/dist/commonjs/sdk/models/shared/registeredcharges.d.ts +14 -0
  200. package/dist/commonjs/sdk/models/shared/registeredcharges.d.ts.map +1 -0
  201. package/dist/commonjs/sdk/models/shared/registeredcharges.js +54 -0
  202. package/dist/commonjs/sdk/models/shared/registeredcharges.js.map +1 -0
  203. package/dist/commonjs/sdk/models/shared/salerecord.d.ts +45 -0
  204. package/dist/commonjs/sdk/models/shared/salerecord.d.ts.map +1 -1
  205. package/dist/commonjs/sdk/models/shared/salerecord.js +26 -1
  206. package/dist/commonjs/sdk/models/shared/salerecord.js.map +1 -1
  207. package/dist/commonjs/sdk/models/shared/searchresponse.d.ts +8 -0
  208. package/dist/commonjs/sdk/models/shared/searchresponse.d.ts.map +1 -1
  209. package/dist/commonjs/sdk/models/shared/searchresponse.js +4 -0
  210. package/dist/commonjs/sdk/models/shared/searchresponse.js.map +1 -1
  211. package/dist/commonjs/sdk/models/shared/searchretrieveresponse.d.ts +82 -0
  212. package/dist/commonjs/sdk/models/shared/searchretrieveresponse.d.ts.map +1 -0
  213. package/dist/commonjs/sdk/models/shared/searchretrieveresponse.js +88 -0
  214. package/dist/commonjs/sdk/models/shared/searchretrieveresponse.js.map +1 -0
  215. package/dist/commonjs/sdk/models/shared/streetmatch.d.ts +106 -0
  216. package/dist/commonjs/sdk/models/shared/streetmatch.d.ts.map +1 -0
  217. package/dist/commonjs/sdk/models/shared/streetmatch.js +84 -0
  218. package/dist/commonjs/sdk/models/shared/streetmatch.js.map +1 -0
  219. package/dist/commonjs/sdk/models/shared/termsbucket.d.ts +3 -0
  220. package/dist/commonjs/sdk/models/shared/termsbucket.d.ts.map +1 -1
  221. package/dist/commonjs/sdk/models/shared/termsbucket.js +2 -2
  222. package/dist/commonjs/sdk/models/shared/termsbucket.js.map +1 -1
  223. package/dist/commonjs/sdk/models/shared/titlecovenant.d.ts +23 -0
  224. package/dist/commonjs/sdk/models/shared/titlecovenant.d.ts.map +1 -0
  225. package/dist/commonjs/sdk/models/shared/{extractionrestriction.js → titlecovenant.js} +6 -6
  226. package/dist/commonjs/sdk/models/shared/titlecovenant.js.map +1 -0
  227. package/dist/commonjs/sdk/models/shared/{extractiondocumentsummary.d.ts → titledocumentsummary.d.ts} +9 -9
  228. package/dist/commonjs/sdk/models/shared/titledocumentsummary.d.ts.map +1 -0
  229. package/dist/commonjs/sdk/models/shared/{extractiondocumentsummary.js → titledocumentsummary.js} +11 -11
  230. package/dist/commonjs/sdk/models/shared/titledocumentsummary.js.map +1 -0
  231. package/dist/commonjs/sdk/models/shared/titleextractionpayload.d.ts +83 -0
  232. package/dist/commonjs/sdk/models/shared/titleextractionpayload.d.ts.map +1 -0
  233. package/dist/commonjs/sdk/models/shared/titleextractionpayload.js +103 -0
  234. package/dist/commonjs/sdk/models/shared/titleextractionpayload.js.map +1 -0
  235. package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.d.ts +2 -2
  236. package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.d.ts.map +1 -1
  237. package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.js +2 -2
  238. package/dist/commonjs/sdk/models/shared/titleextractionpollresponse.js.map +1 -1
  239. package/dist/{esm/sdk/models/shared/extractionnotice.d.ts → commonjs/sdk/models/shared/titlenotice.d.ts} +13 -4
  240. package/dist/commonjs/sdk/models/shared/titlenotice.d.ts.map +1 -0
  241. package/dist/commonjs/sdk/models/shared/{extractionnotice.js → titlenotice.js} +6 -6
  242. package/dist/commonjs/sdk/models/shared/titlenotice.js.map +1 -0
  243. package/dist/commonjs/sdk/models/shared/titleproprietor.d.ts +54 -0
  244. package/dist/commonjs/sdk/models/shared/titleproprietor.d.ts.map +1 -0
  245. package/dist/commonjs/sdk/models/shared/titleproprietor.js +75 -0
  246. package/dist/commonjs/sdk/models/shared/titleproprietor.js.map +1 -0
  247. package/dist/commonjs/sdk/models/shared/titlerestriction.d.ts +23 -0
  248. package/dist/commonjs/sdk/models/shared/titlerestriction.d.ts.map +1 -0
  249. package/dist/commonjs/sdk/models/shared/titlerestriction.js +54 -0
  250. package/dist/commonjs/sdk/models/shared/titlerestriction.js.map +1 -0
  251. package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.d.ts +13 -0
  252. package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.d.ts.map +1 -0
  253. package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.js +50 -0
  254. package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.js.map +1 -0
  255. package/dist/commonjs/sdk/models/shared/titlesummarycounts.d.ts +15 -0
  256. package/dist/commonjs/sdk/models/shared/titlesummarycounts.d.ts.map +1 -0
  257. package/dist/commonjs/sdk/models/shared/titlesummarycounts.js +55 -0
  258. package/dist/commonjs/sdk/models/shared/titlesummarycounts.js.map +1 -0
  259. package/dist/commonjs/sdk/search.d.ts +14 -1
  260. package/dist/commonjs/sdk/search.d.ts.map +1 -1
  261. package/dist/commonjs/sdk/search.js +17 -1
  262. package/dist/commonjs/sdk/search.js.map +1 -1
  263. package/dist/esm/address-search/__tests__/controller.test.d.ts +2 -0
  264. package/dist/esm/address-search/__tests__/controller.test.d.ts.map +1 -0
  265. package/dist/esm/address-search/__tests__/controller.test.js +327 -0
  266. package/dist/esm/address-search/__tests__/controller.test.js.map +1 -0
  267. package/dist/esm/address-search/__tests__/default-transports.test.d.ts +2 -0
  268. package/dist/esm/address-search/__tests__/default-transports.test.d.ts.map +1 -0
  269. package/dist/esm/address-search/__tests__/default-transports.test.js +159 -0
  270. package/dist/esm/address-search/__tests__/default-transports.test.js.map +1 -0
  271. package/dist/esm/address-search/__tests__/narrow.test.d.ts +2 -0
  272. package/dist/esm/address-search/__tests__/narrow.test.d.ts.map +1 -0
  273. package/dist/esm/address-search/__tests__/narrow.test.js +61 -0
  274. package/dist/esm/address-search/__tests__/narrow.test.js.map +1 -0
  275. package/dist/esm/address-search/controller.d.ts +14 -0
  276. package/dist/esm/address-search/controller.d.ts.map +1 -0
  277. package/dist/esm/address-search/controller.js +187 -0
  278. package/dist/esm/address-search/controller.js.map +1 -0
  279. package/dist/esm/address-search/default-transports.d.ts +52 -0
  280. package/dist/esm/address-search/default-transports.d.ts.map +1 -0
  281. package/dist/esm/address-search/default-transports.js +129 -0
  282. package/dist/esm/address-search/default-transports.js.map +1 -0
  283. package/dist/esm/address-search/errors.d.ts +5 -0
  284. package/dist/esm/address-search/errors.d.ts.map +1 -0
  285. package/dist/esm/address-search/errors.js +8 -0
  286. package/dist/esm/address-search/errors.js.map +1 -0
  287. package/dist/esm/address-search/index.d.ts +8 -0
  288. package/dist/esm/address-search/index.d.ts.map +1 -0
  289. package/dist/esm/address-search/index.js +30 -0
  290. package/dist/esm/address-search/index.js.map +1 -0
  291. package/dist/esm/address-search/lru-cache.d.ts +13 -0
  292. package/dist/esm/address-search/lru-cache.d.ts.map +1 -0
  293. package/dist/esm/address-search/lru-cache.js +46 -0
  294. package/dist/esm/address-search/lru-cache.js.map +1 -0
  295. package/dist/esm/address-search/narrow.d.ts +21 -0
  296. package/dist/esm/address-search/narrow.d.ts.map +1 -0
  297. package/dist/esm/address-search/narrow.js +43 -0
  298. package/dist/esm/address-search/narrow.js.map +1 -0
  299. package/dist/esm/address-search/types.d.ts +125 -0
  300. package/dist/esm/address-search/types.d.ts.map +1 -0
  301. package/dist/esm/address-search/types.js +8 -0
  302. package/dist/esm/address-search/types.js.map +1 -0
  303. package/dist/esm/address-search.d.ts +3 -0
  304. package/dist/esm/address-search.d.ts.map +1 -0
  305. package/dist/esm/address-search.js +6 -0
  306. package/dist/esm/address-search.js.map +1 -0
  307. package/dist/esm/funcs/avmPredictPropertyValue.d.ts +1 -1
  308. package/dist/esm/funcs/avmPredictPropertyValue.d.ts.map +1 -1
  309. package/dist/esm/funcs/avmPredictPropertyValue.js +1 -1
  310. package/dist/esm/funcs/avmPredictPropertyValue.js.map +1 -1
  311. package/dist/esm/funcs/propertyGetProperties.js +1 -0
  312. package/dist/esm/funcs/propertyGetProperties.js.map +1 -1
  313. package/dist/esm/funcs/propertyGetPropertiesByLocation.js +1 -0
  314. package/dist/esm/funcs/propertyGetPropertiesByLocation.js.map +1 -1
  315. package/dist/esm/funcs/propertyGetPropertiesBySource.js +1 -0
  316. package/dist/esm/funcs/propertyGetPropertiesBySource.js.map +1 -1
  317. package/dist/esm/funcs/searchSearchRetrieve.d.ts +23 -0
  318. package/dist/esm/funcs/searchSearchRetrieve.d.ts.map +1 -0
  319. package/dist/esm/funcs/searchSearchRetrieve.js +92 -0
  320. package/dist/esm/funcs/searchSearchRetrieve.js.map +1 -0
  321. package/dist/esm/funcs/searchSearchSuggest.d.ts +3 -1
  322. package/dist/esm/funcs/searchSearchSuggest.d.ts.map +1 -1
  323. package/dist/esm/funcs/searchSearchSuggest.js +5 -1
  324. package/dist/esm/funcs/searchSearchSuggest.js.map +1 -1
  325. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts +1 -1
  326. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.d.ts.map +1 -1
  327. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js +2 -1
  328. package/dist/esm/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.js.map +1 -1
  329. package/dist/esm/lib/config.d.ts +3 -3
  330. package/dist/esm/lib/config.js +3 -3
  331. package/dist/esm/lib/config.js.map +1 -1
  332. package/dist/esm/sdk/models/errors/index.d.ts +1 -0
  333. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  334. package/dist/esm/sdk/models/errors/index.js +1 -0
  335. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  336. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts +65 -0
  337. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.d.ts.map +1 -1
  338. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.js +52 -0
  339. package/dist/esm/sdk/models/errors/postv1titledeedstitlenumberpurchase.js.map +1 -1
  340. package/dist/esm/sdk/models/errors/predictpropertyvalue.d.ts +65 -0
  341. package/dist/esm/sdk/models/errors/predictpropertyvalue.d.ts.map +1 -1
  342. package/dist/esm/sdk/models/errors/predictpropertyvalue.js +54 -0
  343. package/dist/esm/sdk/models/errors/predictpropertyvalue.js.map +1 -1
  344. package/dist/esm/sdk/models/errors/searchretrieve.d.ts +201 -0
  345. package/dist/esm/sdk/models/errors/searchretrieve.d.ts.map +1 -0
  346. package/dist/esm/sdk/models/errors/searchretrieve.js +171 -0
  347. package/dist/esm/sdk/models/errors/searchretrieve.js.map +1 -0
  348. package/dist/esm/sdk/models/operations/getcensuswholelevel.d.ts +1 -0
  349. package/dist/esm/sdk/models/operations/getcensuswholelevel.d.ts.map +1 -1
  350. package/dist/esm/sdk/models/operations/getcensuswholelevel.js +1 -0
  351. package/dist/esm/sdk/models/operations/getcensuswholelevel.js.map +1 -1
  352. package/dist/esm/sdk/models/operations/getlistingbyid.d.ts +18 -15
  353. package/dist/esm/sdk/models/operations/getlistingbyid.d.ts.map +1 -1
  354. package/dist/esm/sdk/models/operations/getlistingbyid.js +16 -16
  355. package/dist/esm/sdk/models/operations/getlistingbyid.js.map +1 -1
  356. package/dist/esm/sdk/models/operations/getlistingbysource.d.ts +18 -15
  357. package/dist/esm/sdk/models/operations/getlistingbysource.d.ts.map +1 -1
  358. package/dist/esm/sdk/models/operations/getlistingbysource.js +16 -16
  359. package/dist/esm/sdk/models/operations/getlistingbysource.js.map +1 -1
  360. package/dist/esm/sdk/models/operations/getlistingsbylocation.d.ts +18 -15
  361. package/dist/esm/sdk/models/operations/getlistingsbylocation.d.ts.map +1 -1
  362. package/dist/esm/sdk/models/operations/getlistingsbylocation.js +17 -16
  363. package/dist/esm/sdk/models/operations/getlistingsbylocation.js.map +1 -1
  364. package/dist/esm/sdk/models/operations/getproperties.d.ts +5 -0
  365. package/dist/esm/sdk/models/operations/getproperties.d.ts.map +1 -1
  366. package/dist/esm/sdk/models/operations/getproperties.js +1 -0
  367. package/dist/esm/sdk/models/operations/getproperties.js.map +1 -1
  368. package/dist/esm/sdk/models/operations/getpropertiesbylocation.d.ts +5 -0
  369. package/dist/esm/sdk/models/operations/getpropertiesbylocation.d.ts.map +1 -1
  370. package/dist/esm/sdk/models/operations/getpropertiesbylocation.js +1 -0
  371. package/dist/esm/sdk/models/operations/getpropertiesbylocation.js.map +1 -1
  372. package/dist/esm/sdk/models/operations/getpropertiesbysource.d.ts +5 -0
  373. package/dist/esm/sdk/models/operations/getpropertiesbysource.d.ts.map +1 -1
  374. package/dist/esm/sdk/models/operations/getpropertiesbysource.js +1 -0
  375. package/dist/esm/sdk/models/operations/getpropertiesbysource.js.map +1 -1
  376. package/dist/esm/sdk/models/operations/index.d.ts +1 -0
  377. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  378. package/dist/esm/sdk/models/operations/index.js +1 -0
  379. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  380. package/dist/esm/sdk/models/operations/querylistings.d.ts +18 -15
  381. package/dist/esm/sdk/models/operations/querylistings.d.ts.map +1 -1
  382. package/dist/esm/sdk/models/operations/querylistings.js +18 -17
  383. package/dist/esm/sdk/models/operations/querylistings.js.map +1 -1
  384. package/dist/esm/sdk/models/operations/querylistingsbysource.d.ts +18 -15
  385. package/dist/esm/sdk/models/operations/querylistingsbysource.d.ts.map +1 -1
  386. package/dist/esm/sdk/models/operations/querylistingsbysource.js +17 -16
  387. package/dist/esm/sdk/models/operations/querylistingsbysource.js.map +1 -1
  388. package/dist/esm/sdk/models/operations/resolveaddress.d.ts +16 -3
  389. package/dist/esm/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  390. package/dist/esm/sdk/models/operations/resolveaddress.js +16 -2
  391. package/dist/esm/sdk/models/operations/resolveaddress.js.map +1 -1
  392. package/dist/esm/sdk/models/operations/searchretrieve.d.ts +20 -0
  393. package/dist/esm/sdk/models/operations/searchretrieve.d.ts.map +1 -0
  394. package/dist/esm/sdk/models/operations/searchretrieve.js +18 -0
  395. package/dist/esm/sdk/models/operations/searchretrieve.js.map +1 -0
  396. package/dist/esm/sdk/models/operations/searchsuggest.d.ts +35 -0
  397. package/dist/esm/sdk/models/operations/searchsuggest.d.ts.map +1 -1
  398. package/dist/esm/sdk/models/operations/searchsuggest.js +17 -0
  399. package/dist/esm/sdk/models/operations/searchsuggest.js.map +1 -1
  400. package/dist/esm/sdk/models/shared/addressresolverequest.d.ts +27 -0
  401. package/dist/esm/sdk/models/shared/addressresolverequest.d.ts.map +1 -1
  402. package/dist/esm/sdk/models/shared/addressresolverequest.js +23 -0
  403. package/dist/esm/sdk/models/shared/addressresolverequest.js.map +1 -1
  404. package/dist/esm/sdk/models/shared/advancedlisting.d.ts +2 -2
  405. package/dist/esm/sdk/models/shared/advancedlisting.d.ts.map +1 -1
  406. package/dist/esm/sdk/models/shared/advancedlisting.js +2 -2
  407. package/dist/esm/sdk/models/shared/advancedlisting.js.map +1 -1
  408. package/dist/esm/sdk/models/shared/aggregationresult.d.ts +2 -1
  409. package/dist/esm/sdk/models/shared/aggregationresult.d.ts.map +1 -1
  410. package/dist/esm/sdk/models/shared/aggregationresult.js +2 -0
  411. package/dist/esm/sdk/models/shared/aggregationresult.js.map +1 -1
  412. package/dist/esm/sdk/models/shared/censusareaprofilerequest.d.ts +20 -0
  413. package/dist/esm/sdk/models/shared/censusareaprofilerequest.d.ts.map +1 -1
  414. package/dist/esm/sdk/models/shared/censusareaprofilerequest.js +12 -0
  415. package/dist/esm/sdk/models/shared/censusareaprofilerequest.js.map +1 -1
  416. package/dist/esm/sdk/models/shared/censusrolluprequest.d.ts +20 -0
  417. package/dist/esm/sdk/models/shared/censusrolluprequest.d.ts.map +1 -1
  418. package/dist/esm/sdk/models/shared/censusrolluprequest.js +11 -0
  419. package/dist/esm/sdk/models/shared/censusrolluprequest.js.map +1 -1
  420. package/dist/esm/sdk/models/shared/geocodeprecision.d.ts +17 -0
  421. package/dist/esm/sdk/models/shared/geocodeprecision.d.ts.map +1 -0
  422. package/dist/esm/sdk/models/shared/geocodeprecision.js +15 -0
  423. package/dist/esm/sdk/models/shared/geocodeprecision.js.map +1 -0
  424. package/dist/esm/sdk/models/shared/histogrambucket.d.ts +7 -0
  425. package/dist/esm/sdk/models/shared/histogrambucket.d.ts.map +1 -1
  426. package/dist/esm/sdk/models/shared/histogrambucket.js +5 -3
  427. package/dist/esm/sdk/models/shared/histogrambucket.js.map +1 -1
  428. package/dist/esm/sdk/models/shared/index.d.ts +15 -7
  429. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  430. package/dist/esm/sdk/models/shared/index.js +15 -7
  431. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  432. package/dist/esm/sdk/models/shared/mortgagecharge.d.ts +38 -0
  433. package/dist/esm/sdk/models/shared/mortgagecharge.d.ts.map +1 -0
  434. package/dist/esm/sdk/models/shared/mortgagecharge.js +28 -0
  435. package/dist/esm/sdk/models/shared/mortgagecharge.js.map +1 -0
  436. package/dist/esm/sdk/models/shared/nestedaggregationresult.d.ts +16 -0
  437. package/dist/esm/sdk/models/shared/nestedaggregationresult.d.ts.map +1 -0
  438. package/dist/esm/sdk/models/shared/nestedaggregationresult.js +18 -0
  439. package/dist/esm/sdk/models/shared/nestedaggregationresult.js.map +1 -0
  440. package/dist/esm/sdk/models/shared/othercharge.d.ts +23 -0
  441. package/dist/esm/sdk/models/shared/othercharge.d.ts.map +1 -0
  442. package/dist/esm/sdk/models/shared/{extractionothercharge.js → othercharge.js} +4 -4
  443. package/dist/esm/sdk/models/shared/othercharge.js.map +1 -0
  444. package/dist/esm/sdk/models/shared/propertyaddress.d.ts +24 -2
  445. package/dist/esm/sdk/models/shared/propertyaddress.d.ts.map +1 -1
  446. package/dist/esm/sdk/models/shared/propertyaddress.js +13 -1
  447. package/dist/esm/sdk/models/shared/propertyaddress.js.map +1 -1
  448. package/dist/esm/sdk/models/shared/propertybyslugsrequest.d.ts +5 -0
  449. package/dist/esm/sdk/models/shared/propertybyslugsrequest.d.ts.map +1 -1
  450. package/dist/esm/sdk/models/shared/propertybyslugsrequest.js +1 -0
  451. package/dist/esm/sdk/models/shared/propertybyslugsrequest.js.map +1 -1
  452. package/dist/esm/sdk/models/shared/propertydataapi.d.ts +38 -0
  453. package/dist/esm/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  454. package/dist/esm/sdk/models/shared/propertydataapi.js +21 -0
  455. package/dist/esm/sdk/models/shared/propertydataapi.js.map +1 -1
  456. package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts +5 -0
  457. package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
  458. package/dist/esm/sdk/models/shared/propertyqueryrequest.js +1 -0
  459. package/dist/esm/sdk/models/shared/propertyqueryrequest.js.map +1 -1
  460. package/dist/esm/sdk/models/shared/registeredcharges.d.ts +14 -0
  461. package/dist/esm/sdk/models/shared/registeredcharges.d.ts.map +1 -0
  462. package/dist/esm/sdk/models/shared/registeredcharges.js +17 -0
  463. package/dist/esm/sdk/models/shared/registeredcharges.js.map +1 -0
  464. package/dist/esm/sdk/models/shared/salerecord.d.ts +45 -0
  465. package/dist/esm/sdk/models/shared/salerecord.d.ts.map +1 -1
  466. package/dist/esm/sdk/models/shared/salerecord.js +25 -0
  467. package/dist/esm/sdk/models/shared/salerecord.js.map +1 -1
  468. package/dist/esm/sdk/models/shared/searchresponse.d.ts +8 -0
  469. package/dist/esm/sdk/models/shared/searchresponse.d.ts.map +1 -1
  470. package/dist/esm/sdk/models/shared/searchresponse.js +4 -0
  471. package/dist/esm/sdk/models/shared/searchresponse.js.map +1 -1
  472. package/dist/esm/sdk/models/shared/searchretrieveresponse.d.ts +82 -0
  473. package/dist/esm/sdk/models/shared/searchretrieveresponse.d.ts.map +1 -0
  474. package/dist/esm/sdk/models/shared/searchretrieveresponse.js +50 -0
  475. package/dist/esm/sdk/models/shared/searchretrieveresponse.js.map +1 -0
  476. package/dist/esm/sdk/models/shared/streetmatch.d.ts +106 -0
  477. package/dist/esm/sdk/models/shared/streetmatch.d.ts.map +1 -0
  478. package/dist/esm/sdk/models/shared/streetmatch.js +45 -0
  479. package/dist/esm/sdk/models/shared/streetmatch.js.map +1 -0
  480. package/dist/esm/sdk/models/shared/termsbucket.d.ts +3 -0
  481. package/dist/esm/sdk/models/shared/termsbucket.d.ts.map +1 -1
  482. package/dist/esm/sdk/models/shared/termsbucket.js +3 -3
  483. package/dist/esm/sdk/models/shared/termsbucket.js.map +1 -1
  484. package/dist/esm/sdk/models/shared/titlecovenant.d.ts +23 -0
  485. package/dist/esm/sdk/models/shared/titlecovenant.d.ts.map +1 -0
  486. package/dist/esm/sdk/models/shared/{extractionrestriction.js → titlecovenant.js} +4 -4
  487. package/dist/esm/sdk/models/shared/titlecovenant.js.map +1 -0
  488. package/dist/esm/sdk/models/shared/{extractiondocumentsummary.d.ts → titledocumentsummary.d.ts} +9 -9
  489. package/dist/esm/sdk/models/shared/titledocumentsummary.d.ts.map +1 -0
  490. package/dist/esm/sdk/models/shared/{extractiondocumentsummary.js → titledocumentsummary.js} +9 -9
  491. package/dist/esm/sdk/models/shared/titledocumentsummary.js.map +1 -0
  492. package/dist/esm/sdk/models/shared/titleextractionpayload.d.ts +83 -0
  493. package/dist/esm/sdk/models/shared/titleextractionpayload.d.ts.map +1 -0
  494. package/dist/esm/sdk/models/shared/titleextractionpayload.js +65 -0
  495. package/dist/esm/sdk/models/shared/titleextractionpayload.js.map +1 -0
  496. package/dist/esm/sdk/models/shared/titleextractionpollresponse.d.ts +2 -2
  497. package/dist/esm/sdk/models/shared/titleextractionpollresponse.d.ts.map +1 -1
  498. package/dist/esm/sdk/models/shared/titleextractionpollresponse.js +2 -2
  499. package/dist/esm/sdk/models/shared/titleextractionpollresponse.js.map +1 -1
  500. package/dist/{commonjs/sdk/models/shared/extractionnotice.d.ts → esm/sdk/models/shared/titlenotice.d.ts} +13 -4
  501. package/dist/esm/sdk/models/shared/titlenotice.d.ts.map +1 -0
  502. package/dist/esm/sdk/models/shared/{extractionnotice.js → titlenotice.js} +4 -4
  503. package/dist/esm/sdk/models/shared/titlenotice.js.map +1 -0
  504. package/dist/esm/sdk/models/shared/titleproprietor.d.ts +54 -0
  505. package/dist/esm/sdk/models/shared/titleproprietor.d.ts.map +1 -0
  506. package/dist/esm/sdk/models/shared/titleproprietor.js +38 -0
  507. package/dist/esm/sdk/models/shared/titleproprietor.js.map +1 -0
  508. package/dist/esm/sdk/models/shared/titlerestriction.d.ts +23 -0
  509. package/dist/esm/sdk/models/shared/titlerestriction.d.ts.map +1 -0
  510. package/dist/esm/sdk/models/shared/titlerestriction.js +17 -0
  511. package/dist/esm/sdk/models/shared/titlerestriction.js.map +1 -0
  512. package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.d.ts +13 -0
  513. package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.d.ts.map +1 -0
  514. package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.js +13 -0
  515. package/dist/esm/sdk/models/shared/titleschedulenoticeoflease.js.map +1 -0
  516. package/dist/esm/sdk/models/shared/titlesummarycounts.d.ts +15 -0
  517. package/dist/esm/sdk/models/shared/titlesummarycounts.d.ts.map +1 -0
  518. package/dist/esm/sdk/models/shared/titlesummarycounts.js +18 -0
  519. package/dist/esm/sdk/models/shared/titlesummarycounts.js.map +1 -0
  520. package/dist/esm/sdk/search.d.ts +14 -1
  521. package/dist/esm/sdk/search.d.ts.map +1 -1
  522. package/dist/esm/sdk/search.js +17 -1
  523. package/dist/esm/sdk/search.js.map +1 -1
  524. package/package.json +3 -2
  525. package/src/address-search/__tests__/controller.test.ts +395 -0
  526. package/src/address-search/__tests__/default-transports.test.ts +201 -0
  527. package/src/address-search/__tests__/narrow.test.ts +74 -0
  528. package/src/address-search/controller.ts +219 -0
  529. package/src/address-search/default-transports.ts +199 -0
  530. package/src/address-search/errors.ts +7 -0
  531. package/src/address-search/index.ts +54 -0
  532. package/src/address-search/lru-cache.ts +34 -0
  533. package/src/address-search/narrow.ts +45 -0
  534. package/src/address-search/types.ts +147 -0
  535. package/src/address-search.ts +40 -0
  536. package/src/funcs/avmPredictPropertyValue.ts +9 -2
  537. package/src/funcs/propertyGetProperties.ts +1 -0
  538. package/src/funcs/propertyGetPropertiesByLocation.ts +1 -0
  539. package/src/funcs/propertyGetPropertiesBySource.ts +1 -0
  540. package/src/funcs/searchSearchRetrieve.ts +192 -0
  541. package/src/funcs/searchSearchSuggest.ts +5 -1
  542. package/src/funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.ts +8 -0
  543. package/src/lib/config.ts +3 -3
  544. package/src/sdk/models/errors/index.ts +1 -0
  545. package/src/sdk/models/errors/postv1titledeedstitlenumberpurchase.ts +144 -0
  546. package/src/sdk/models/errors/predictpropertyvalue.ts +136 -0
  547. package/src/sdk/models/errors/searchretrieve.ts +391 -0
  548. package/src/sdk/models/operations/getcensuswholelevel.ts +1 -0
  549. package/src/sdk/models/operations/getlistingbyid.ts +84 -76
  550. package/src/sdk/models/operations/getlistingbysource.ts +95 -87
  551. package/src/sdk/models/operations/getlistingsbylocation.ts +95 -86
  552. package/src/sdk/models/operations/getproperties.ts +6 -0
  553. package/src/sdk/models/operations/getpropertiesbylocation.ts +6 -0
  554. package/src/sdk/models/operations/getpropertiesbysource.ts +6 -0
  555. package/src/sdk/models/operations/index.ts +1 -0
  556. package/src/sdk/models/operations/querylistings.ts +91 -82
  557. package/src/sdk/models/operations/querylistingsbysource.ts +95 -86
  558. package/src/sdk/models/operations/resolveaddress.ts +50 -12
  559. package/src/sdk/models/operations/searchretrieve.ts +45 -0
  560. package/src/sdk/models/operations/searchsuggest.ts +41 -0
  561. package/src/sdk/models/shared/addressresolverequest.ts +60 -0
  562. package/src/sdk/models/shared/advancedlisting.ts +4 -4
  563. package/src/sdk/models/shared/aggregationresult.ts +7 -1
  564. package/src/sdk/models/shared/censusareaprofilerequest.ts +24 -0
  565. package/src/sdk/models/shared/censusrolluprequest.ts +27 -0
  566. package/src/sdk/models/shared/geocodeprecision.ts +27 -0
  567. package/src/sdk/models/shared/histogrambucket.ts +19 -5
  568. package/src/sdk/models/shared/index.ts +15 -7
  569. package/src/sdk/models/shared/mortgagecharge.ts +76 -0
  570. package/src/sdk/models/shared/nestedaggregationresult.ts +47 -0
  571. package/src/sdk/models/shared/{extractionothercharge.ts → othercharge.ts} +16 -7
  572. package/src/sdk/models/shared/propertyaddress.ts +36 -3
  573. package/src/sdk/models/shared/propertybyslugsrequest.ts +6 -0
  574. package/src/sdk/models/shared/propertydataapi.ts +55 -0
  575. package/src/sdk/models/shared/propertyqueryrequest.ts +6 -0
  576. package/src/sdk/models/shared/registeredcharges.ts +40 -0
  577. package/src/sdk/models/shared/salerecord.ts +62 -0
  578. package/src/sdk/models/shared/searchresponse.ts +12 -0
  579. package/src/sdk/models/shared/searchretrieveresponse.ts +153 -0
  580. package/src/sdk/models/shared/streetmatch.ts +181 -0
  581. package/src/sdk/models/shared/termsbucket.ts +13 -5
  582. package/src/sdk/models/shared/{extractionrestriction.ts → titlecovenant.ts} +16 -7
  583. package/src/sdk/models/shared/{extractiondocumentsummary.ts → titledocumentsummary.ts} +20 -18
  584. package/src/sdk/models/shared/titleextractionpayload.ts +170 -0
  585. package/src/sdk/models/shared/titleextractionpollresponse.ts +5 -5
  586. package/src/sdk/models/shared/{extractionnotice.ts → titlenotice.ts} +16 -7
  587. package/src/sdk/models/shared/titleproprietor.ts +90 -0
  588. package/src/sdk/models/shared/titlerestriction.ts +48 -0
  589. package/src/sdk/models/shared/titleschedulenoticeoflease.ts +34 -0
  590. package/src/sdk/models/shared/titlesummarycounts.ts +41 -0
  591. package/src/sdk/search.ts +25 -1
  592. package/dist/commonjs/sdk/models/shared/extractiondocumentsummary.d.ts.map +0 -1
  593. package/dist/commonjs/sdk/models/shared/extractiondocumentsummary.js.map +0 -1
  594. package/dist/commonjs/sdk/models/shared/extractionmortgagecharge.d.ts +0 -26
  595. package/dist/commonjs/sdk/models/shared/extractionmortgagecharge.d.ts.map +0 -1
  596. package/dist/commonjs/sdk/models/shared/extractionmortgagecharge.js.map +0 -1
  597. package/dist/commonjs/sdk/models/shared/extractionnotice.d.ts.map +0 -1
  598. package/dist/commonjs/sdk/models/shared/extractionnotice.js.map +0 -1
  599. package/dist/commonjs/sdk/models/shared/extractionothercharge.d.ts +0 -14
  600. package/dist/commonjs/sdk/models/shared/extractionothercharge.d.ts.map +0 -1
  601. package/dist/commonjs/sdk/models/shared/extractionothercharge.js.map +0 -1
  602. package/dist/commonjs/sdk/models/shared/extractionpayload.d.ts +0 -63
  603. package/dist/commonjs/sdk/models/shared/extractionpayload.d.ts.map +0 -1
  604. package/dist/commonjs/sdk/models/shared/extractionpayload.js +0 -108
  605. package/dist/commonjs/sdk/models/shared/extractionpayload.js.map +0 -1
  606. package/dist/commonjs/sdk/models/shared/extractionproprietor.d.ts +0 -18
  607. package/dist/commonjs/sdk/models/shared/extractionproprietor.d.ts.map +0 -1
  608. package/dist/commonjs/sdk/models/shared/extractionproprietor.js.map +0 -1
  609. package/dist/commonjs/sdk/models/shared/extractionrestriction.d.ts +0 -14
  610. package/dist/commonjs/sdk/models/shared/extractionrestriction.d.ts.map +0 -1
  611. package/dist/commonjs/sdk/models/shared/extractionrestriction.js.map +0 -1
  612. package/dist/esm/sdk/models/shared/extractiondocumentsummary.d.ts.map +0 -1
  613. package/dist/esm/sdk/models/shared/extractiondocumentsummary.js.map +0 -1
  614. package/dist/esm/sdk/models/shared/extractionmortgagecharge.d.ts +0 -26
  615. package/dist/esm/sdk/models/shared/extractionmortgagecharge.d.ts.map +0 -1
  616. package/dist/esm/sdk/models/shared/extractionmortgagecharge.js +0 -28
  617. package/dist/esm/sdk/models/shared/extractionmortgagecharge.js.map +0 -1
  618. package/dist/esm/sdk/models/shared/extractionnotice.d.ts.map +0 -1
  619. package/dist/esm/sdk/models/shared/extractionnotice.js.map +0 -1
  620. package/dist/esm/sdk/models/shared/extractionothercharge.d.ts +0 -14
  621. package/dist/esm/sdk/models/shared/extractionothercharge.d.ts.map +0 -1
  622. package/dist/esm/sdk/models/shared/extractionothercharge.js.map +0 -1
  623. package/dist/esm/sdk/models/shared/extractionpayload.d.ts +0 -63
  624. package/dist/esm/sdk/models/shared/extractionpayload.d.ts.map +0 -1
  625. package/dist/esm/sdk/models/shared/extractionpayload.js +0 -68
  626. package/dist/esm/sdk/models/shared/extractionpayload.js.map +0 -1
  627. package/dist/esm/sdk/models/shared/extractionproprietor.d.ts +0 -18
  628. package/dist/esm/sdk/models/shared/extractionproprietor.d.ts.map +0 -1
  629. package/dist/esm/sdk/models/shared/extractionproprietor.js +0 -21
  630. package/dist/esm/sdk/models/shared/extractionproprietor.js.map +0 -1
  631. package/dist/esm/sdk/models/shared/extractionrestriction.d.ts +0 -14
  632. package/dist/esm/sdk/models/shared/extractionrestriction.d.ts.map +0 -1
  633. package/dist/esm/sdk/models/shared/extractionrestriction.js.map +0 -1
  634. package/src/sdk/models/shared/extractionmortgagecharge.ts +0 -66
  635. package/src/sdk/models/shared/extractionpayload.ts +0 -177
  636. package/src/sdk/models/shared/extractionproprietor.ts +0 -47
@@ -3,7 +3,10 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod/v3";
6
- import { safeParse } from "../../../lib/schemas.js";
6
+ import {
7
+ collectExtraKeys as collectExtraKeys$,
8
+ safeParse,
9
+ } from "../../../lib/schemas.js";
7
10
  import * as openEnums from "../../types/enums.js";
8
11
  import { ClosedEnum, OpenEnum } from "../../types/enums.js";
9
12
  import { Result as SafeParseResult } from "../../types/fp.js";
@@ -23,7 +26,7 @@ export type Address = {
23
26
  /**
24
27
  * City, town, or village name as used by Royal Mail for postal addressing.
25
28
  */
26
- city?: string | undefined;
29
+ city?: string | null | undefined;
27
30
  /**
28
31
  * ISO 3166-1 alpha-2 country code. Defaults to 'GB' for Great Britain. Currently only UK properties are supported.
29
32
  */
@@ -31,11 +34,11 @@ export type Address = {
31
34
  /**
32
35
  * Local district, borough, or neighbourhood within the city (e.g. 'Westminster', 'Shoreditch', 'Didsbury').
33
36
  */
34
- district?: string | undefined;
37
+ district?: string | null | undefined;
35
38
  /**
36
39
  * Inward code — the second part of the UK postcode after the space (e.g. '1AA', '4QE'). Combined with outcode forms the full postcode.
37
40
  */
38
- incode?: string | undefined;
41
+ incode?: string | null | undefined;
39
42
  /**
40
43
  * The raw, unstructured address string exactly as received from the source data feed, before any parsing or normalisation. Useful for display purposes or debugging address-matching issues.
41
44
  */
@@ -43,7 +46,7 @@ export type Address = {
43
46
  /**
44
47
  * Outward code — the first part of the UK postcode before the space (e.g. 'SW1A', 'M1', 'EC2'). Useful for area-level grouping and search.
45
48
  */
46
- outcode?: string | undefined;
49
+ outcode?: string | null | undefined;
47
50
  /**
48
51
  * Full UK postcode in standard Royal Mail format (e.g. 'SW1A 1AA'). Always present and is the primary geographic identifier used for location matching.
49
52
  */
@@ -51,15 +54,15 @@ export type Address = {
51
54
  /**
52
55
  * Building or house number, including any suffix (e.g. '12A', '3-5'). May be absent for named properties or new-build plots.
53
56
  */
54
- propertyNumber?: string | undefined;
57
+ propertyNumber?: string | null | undefined;
55
58
  /**
56
59
  * County or administrative region (e.g. 'Greater London', 'West Yorkshire', 'Surrey').
57
60
  */
58
- region?: string | undefined;
61
+ region?: string | null | undefined;
59
62
  /**
60
63
  * Street or road name, without the property number. May include thoroughfare type (e.g. 'High Street', 'Park Lane', 'The Crescent').
61
64
  */
62
- street?: string | undefined;
65
+ street?: string | null | undefined;
63
66
  };
64
67
 
65
68
  /**
@@ -143,7 +146,7 @@ export type BrochureImages = {
143
146
  /**
144
147
  * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
145
148
  */
146
- caption?: string | undefined;
149
+ caption?: string | null | undefined;
147
150
  /**
148
151
  * 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.
149
152
  */
@@ -193,7 +196,7 @@ export type EnergyRatingImages = {
193
196
  /**
194
197
  * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
195
198
  */
196
- caption?: string | undefined;
199
+ caption?: string | null | undefined;
197
200
  /**
198
201
  * 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.
199
202
  */
@@ -245,7 +248,7 @@ export type FloorPlanImages = {
245
248
  /**
246
249
  * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
247
250
  */
248
- caption?: string | undefined;
251
+ caption?: string | null | undefined;
249
252
  /**
250
253
  * 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.
251
254
  */
@@ -283,7 +286,7 @@ export type Images = {
283
286
  /**
284
287
  * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
285
288
  */
286
- caption?: string | undefined;
289
+ caption?: string | null | undefined;
287
290
  /**
288
291
  * 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.
289
292
  */
@@ -471,7 +474,7 @@ export type GetListingByIdResponseBody = {
471
474
  /**
472
475
  * Broad property category. 'residential': dwellings including houses, flats, bungalows, and maisonettes. 'commercial': non-residential premises such as offices, retail units, warehouses, and mixed-use buildings.
473
476
  */
474
- category: GetListingByIdCategory;
477
+ category?: GetListingByIdCategory | null | undefined;
475
478
  /**
476
479
  * ISO 8601 datetime when this listing record was first created in our system. This may differ from publishedDate if the listing was retrospectively imported.
477
480
  */
@@ -545,15 +548,15 @@ export type GetListingByIdResponseBody = {
545
548
  */
546
549
  object: GetListingByIdObject;
547
550
  /**
548
- * Current listing price in GBP pence. Divide by 100 to convert to pounds sterling. For sale listings: the asking price (e.g. 50000000 = £500,000). For rental listings: the monthly rent per calendar month (e.g. 150000 = £1,500 pcm). Always reflects the most recent price after any revisions.
551
+ * Current listing price in GBP pence. Divide by 100 to convert to pounds sterling. For sale listings: the asking price (e.g. 50000000 = £500,000). For rental listings: the monthly rent per calendar month (e.g. 150000 = £1,500 pcm). Always reflects the most recent price after any revisions. May be null/absent when the source feed does not expose a price.
549
552
  */
550
- price: number;
553
+ price?: number | null | undefined;
551
554
  /**
552
555
  * Chronological history of price changes since the listing was first published. Each entry records a revision event with the old and new prices. Useful for tracking asking-price reductions and market sentiment. Ordered from earliest to most recent change.
553
556
  */
554
557
  priceHistory?: Array<PriceHistory> | undefined;
555
558
  /**
556
- * Primary property type classification. Common values for residential include: 'detached', 'semi-detached', 'terraced', 'flat', 'bungalow', 'maisonette', 'end_terrace', 'cottage', 'park_home'. For commercial: 'office', 'retail', 'warehouse', 'industrial', 'land'. Values are normalised from provider-specific taxonomies but may occasionally contain non-standard entries.
559
+ * Primary property type classification, normalised from provider-specific taxonomies to the canonical PROPERTY_TYPE_MAPPING_VALUES set: unknown, other, flat, detached, semiDetached, terraced, bungalow, maisonette, cottage, chalet, lodge, mobileHome, houseboat, retirement, characterProperty, blockOfFlats, houseShare, farmhouse, mill, barn, coachHouse, statelyHome, farm, parking, equestrian, restaurant, industrial, warehouse, leisure, retail, land, office, riad, hotel, studentAccommodation, commercial, pub, bar, hotelRoom, shop, retailHighStreet, retailOutOfTown, industrialDevelopment, distributionWarehouse, industrialPark, storage, servicedOffice, residentialDevelopment, commercialDevelopment, mixedUse. This is a free-form string (not schema-enforced) and may occasionally contain non-standard entries.
557
560
  */
558
561
  propertyType: string;
559
562
  /**
@@ -592,6 +595,7 @@ export type GetListingByIdResponseBody = {
592
595
  * ISO 8601 datetime when this listing record was last modified in our system. Updated whenever any field changes, including price revisions, status transitions, or image additions.
593
596
  */
594
597
  updatedAt?: Date | undefined;
598
+ additionalProperties?: { [k: string]: any } | undefined;
595
599
  };
596
600
 
597
601
  /** @internal */
@@ -619,16 +623,16 @@ export function getListingByIdRequestToJSON(
619
623
  /** @internal */
620
624
  export const Address$inboundSchema: z.ZodType<Address, z.ZodTypeDef, unknown> =
621
625
  z.object({
622
- city: z.string().optional(),
626
+ city: z.nullable(z.string()).optional(),
623
627
  country: z.string().default("GB"),
624
- district: z.string().optional(),
625
- incode: z.string().optional(),
628
+ district: z.nullable(z.string()).optional(),
629
+ incode: z.nullable(z.string()).optional(),
626
630
  originalAddress: z.string(),
627
- outcode: z.string().optional(),
631
+ outcode: z.nullable(z.string()).optional(),
628
632
  postcode: z.string(),
629
- propertyNumber: z.string().optional(),
630
- region: z.string().optional(),
631
- street: z.string().optional(),
633
+ propertyNumber: z.nullable(z.string()).optional(),
634
+ region: z.nullable(z.string()).optional(),
635
+ street: z.nullable(z.string()).optional(),
632
636
  });
633
637
 
634
638
  export function addressFromJSON(
@@ -682,7 +686,7 @@ export const BrochureImages$inboundSchema: z.ZodType<
682
686
  z.ZodTypeDef,
683
687
  unknown
684
688
  > = z.object({
685
- caption: z.string().optional(),
689
+ caption: z.nullable(z.string()).optional(),
686
690
  order: z.number().optional(),
687
691
  type: GetListingByIdListingsType$inboundSchema.optional(),
688
692
  url: z.string(),
@@ -718,7 +722,7 @@ export const EnergyRatingImages$inboundSchema: z.ZodType<
718
722
  z.ZodTypeDef,
719
723
  unknown
720
724
  > = z.object({
721
- caption: z.string().optional(),
725
+ caption: z.nullable(z.string()).optional(),
722
726
  order: z.number().optional(),
723
727
  type: GetListingByIdListingsResponseType$inboundSchema.optional(),
724
728
  url: z.string(),
@@ -767,7 +771,7 @@ export const FloorPlanImages$inboundSchema: z.ZodType<
767
771
  z.ZodTypeDef,
768
772
  unknown
769
773
  > = z.object({
770
- caption: z.string().optional(),
774
+ caption: z.nullable(z.string()).optional(),
771
775
  order: z.number().optional(),
772
776
  type: GetListingByIdListingsResponse200Type$inboundSchema.optional(),
773
777
  url: z.string(),
@@ -796,7 +800,7 @@ export const GetListingByIdListingsResponse200ApplicationJSONType$inboundSchema:
796
800
  /** @internal */
797
801
  export const Images$inboundSchema: z.ZodType<Images, z.ZodTypeDef, unknown> = z
798
802
  .object({
799
- caption: z.string().optional(),
803
+ caption: z.nullable(z.string()).optional(),
800
804
  order: z.number().optional(),
801
805
  type: GetListingByIdListingsResponse200ApplicationJSONType$inboundSchema
802
806
  .optional(),
@@ -942,55 +946,59 @@ export const GetListingByIdResponseBody$inboundSchema: z.ZodType<
942
946
  GetListingByIdResponseBody,
943
947
  z.ZodTypeDef,
944
948
  unknown
945
- > = z.object({
946
- address: z.lazy(() => Address$inboundSchema),
947
- agent: z.nullable(z.lazy(() => Agent$inboundSchema)).optional(),
948
- baths: z.nullable(z.number()).optional(),
949
- beds: z.nullable(z.number()).optional(),
950
- brochureImages: z.array(z.lazy(() => BrochureImages$inboundSchema))
951
- .optional(),
952
- category: GetListingByIdCategory$inboundSchema,
953
- createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
954
- .optional(),
955
- currency: z.string().default("GBP"),
956
- displayAddress: z.string().optional(),
957
- energyRatingImages: z.array(z.lazy(() => EnergyRatingImages$inboundSchema))
958
- .optional(),
959
- features: z.nullable(z.array(z.lazy(() => Features$inboundSchema)))
960
- .optional(),
961
- floorPlanImages: z.array(z.lazy(() => FloorPlanImages$inboundSchema))
962
- .optional(),
963
- id: z.string(),
964
- images: z.array(z.lazy(() => Images$inboundSchema)).optional(),
965
- isAuction: z.boolean().optional(),
966
- isNewBuild: z.boolean().optional(),
967
- isRetirement: z.boolean().optional(),
968
- isSharedOwnership: z.boolean().optional(),
969
- key: z.string(),
970
- lat: z.number().optional(),
971
- lng: z.number().optional(),
972
- locationId: z.nullable(z.string()).optional(),
973
- narratives: z.nullable(z.array(z.lazy(() => Narratives$inboundSchema)))
974
- .optional(),
975
- object: GetListingByIdObject$inboundSchema,
976
- price: z.number(),
977
- priceHistory: z.array(z.lazy(() => PriceHistory$inboundSchema)).optional(),
978
- propertyType: z.string(),
979
- provider: z.string(),
980
- publishedDate: z.string().datetime({ offset: true }).transform(v =>
981
- new Date(v)
982
- ),
983
- receptions: z.nullable(z.number()).optional(),
984
- removedDate: z.nullable(
985
- z.string().datetime({ offset: true }).transform(v => new Date(v)),
986
- ).optional(),
987
- spatial: z.nullable(z.lazy(() => GeoJSONPoint$inboundSchema)).optional(),
988
- status: GetListingByIdStatus$inboundSchema,
989
- subPropertyType: z.nullable(z.string()).optional(),
990
- type: GetListingByIdType$inboundSchema,
991
- updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
992
- .optional(),
993
- });
949
+ > = collectExtraKeys$(
950
+ z.object({
951
+ address: z.lazy(() => Address$inboundSchema),
952
+ agent: z.nullable(z.lazy(() => Agent$inboundSchema)).optional(),
953
+ baths: z.nullable(z.number()).optional(),
954
+ beds: z.nullable(z.number()).optional(),
955
+ brochureImages: z.array(z.lazy(() => BrochureImages$inboundSchema))
956
+ .optional(),
957
+ category: z.nullable(GetListingByIdCategory$inboundSchema).optional(),
958
+ createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
959
+ .optional(),
960
+ currency: z.string().default("GBP"),
961
+ displayAddress: z.string().optional(),
962
+ energyRatingImages: z.array(z.lazy(() => EnergyRatingImages$inboundSchema))
963
+ .optional(),
964
+ features: z.nullable(z.array(z.lazy(() => Features$inboundSchema)))
965
+ .optional(),
966
+ floorPlanImages: z.array(z.lazy(() => FloorPlanImages$inboundSchema))
967
+ .optional(),
968
+ id: z.string(),
969
+ images: z.array(z.lazy(() => Images$inboundSchema)).optional(),
970
+ isAuction: z.boolean().optional(),
971
+ isNewBuild: z.boolean().optional(),
972
+ isRetirement: z.boolean().optional(),
973
+ isSharedOwnership: z.boolean().optional(),
974
+ key: z.string(),
975
+ lat: z.number().optional(),
976
+ lng: z.number().optional(),
977
+ locationId: z.nullable(z.string()).optional(),
978
+ narratives: z.nullable(z.array(z.lazy(() => Narratives$inboundSchema)))
979
+ .optional(),
980
+ object: GetListingByIdObject$inboundSchema,
981
+ price: z.nullable(z.number()).optional(),
982
+ priceHistory: z.array(z.lazy(() => PriceHistory$inboundSchema)).optional(),
983
+ propertyType: z.string(),
984
+ provider: z.string(),
985
+ publishedDate: z.string().datetime({ offset: true }).transform(v =>
986
+ new Date(v)
987
+ ),
988
+ receptions: z.nullable(z.number()).optional(),
989
+ removedDate: z.nullable(
990
+ z.string().datetime({ offset: true }).transform(v => new Date(v)),
991
+ ).optional(),
992
+ spatial: z.nullable(z.lazy(() => GeoJSONPoint$inboundSchema)).optional(),
993
+ status: GetListingByIdStatus$inboundSchema,
994
+ subPropertyType: z.nullable(z.string()).optional(),
995
+ type: GetListingByIdType$inboundSchema,
996
+ updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
997
+ .optional(),
998
+ }).catchall(z.any()),
999
+ "additionalProperties",
1000
+ true,
1001
+ );
994
1002
 
995
1003
  export function getListingByIdResponseBodyFromJSON(
996
1004
  jsonString: string,
@@ -3,7 +3,10 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod/v3";
6
- import { safeParse } from "../../../lib/schemas.js";
6
+ import {
7
+ collectExtraKeys as collectExtraKeys$,
8
+ safeParse,
9
+ } from "../../../lib/schemas.js";
7
10
  import * as openEnums from "../../types/enums.js";
8
11
  import { ClosedEnum, OpenEnum } from "../../types/enums.js";
9
12
  import { Result as SafeParseResult } from "../../types/fp.js";
@@ -43,7 +46,7 @@ export type GetListingBySourceAddress = {
43
46
  /**
44
47
  * City, town, or village name as used by Royal Mail for postal addressing.
45
48
  */
46
- city?: string | undefined;
49
+ city?: string | null | undefined;
47
50
  /**
48
51
  * ISO 3166-1 alpha-2 country code. Defaults to 'GB' for Great Britain. Currently only UK properties are supported.
49
52
  */
@@ -51,11 +54,11 @@ export type GetListingBySourceAddress = {
51
54
  /**
52
55
  * Local district, borough, or neighbourhood within the city (e.g. 'Westminster', 'Shoreditch', 'Didsbury').
53
56
  */
54
- district?: string | undefined;
57
+ district?: string | null | undefined;
55
58
  /**
56
59
  * Inward code — the second part of the UK postcode after the space (e.g. '1AA', '4QE'). Combined with outcode forms the full postcode.
57
60
  */
58
- incode?: string | undefined;
61
+ incode?: string | null | undefined;
59
62
  /**
60
63
  * The raw, unstructured address string exactly as received from the source data feed, before any parsing or normalisation. Useful for display purposes or debugging address-matching issues.
61
64
  */
@@ -63,7 +66,7 @@ export type GetListingBySourceAddress = {
63
66
  /**
64
67
  * Outward code — the first part of the UK postcode before the space (e.g. 'SW1A', 'M1', 'EC2'). Useful for area-level grouping and search.
65
68
  */
66
- outcode?: string | undefined;
69
+ outcode?: string | null | undefined;
67
70
  /**
68
71
  * Full UK postcode in standard Royal Mail format (e.g. 'SW1A 1AA'). Always present and is the primary geographic identifier used for location matching.
69
72
  */
@@ -71,15 +74,15 @@ export type GetListingBySourceAddress = {
71
74
  /**
72
75
  * Building or house number, including any suffix (e.g. '12A', '3-5'). May be absent for named properties or new-build plots.
73
76
  */
74
- propertyNumber?: string | undefined;
77
+ propertyNumber?: string | null | undefined;
75
78
  /**
76
79
  * County or administrative region (e.g. 'Greater London', 'West Yorkshire', 'Surrey').
77
80
  */
78
- region?: string | undefined;
81
+ region?: string | null | undefined;
79
82
  /**
80
83
  * Street or road name, without the property number. May include thoroughfare type (e.g. 'High Street', 'Park Lane', 'The Crescent').
81
84
  */
82
- street?: string | undefined;
85
+ street?: string | null | undefined;
83
86
  };
84
87
 
85
88
  /**
@@ -163,7 +166,7 @@ export type GetListingBySourceBrochureImages = {
163
166
  /**
164
167
  * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
165
168
  */
166
- caption?: string | undefined;
169
+ caption?: string | null | undefined;
167
170
  /**
168
171
  * 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.
169
172
  */
@@ -215,7 +218,7 @@ export type GetListingBySourceEnergyRatingImages = {
215
218
  /**
216
219
  * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
217
220
  */
218
- caption?: string | undefined;
221
+ caption?: string | null | undefined;
219
222
  /**
220
223
  * 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.
221
224
  */
@@ -267,7 +270,7 @@ export type GetListingBySourceFloorPlanImages = {
267
270
  /**
268
271
  * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
269
272
  */
270
- caption?: string | undefined;
273
+ caption?: string | null | undefined;
271
274
  /**
272
275
  * 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.
273
276
  */
@@ -305,7 +308,7 @@ export type GetListingBySourceImages = {
305
308
  /**
306
309
  * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
307
310
  */
308
- caption?: string | undefined;
311
+ caption?: string | null | undefined;
309
312
  /**
310
313
  * 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.
311
314
  */
@@ -500,7 +503,7 @@ export type GetListingBySourceResponseBody = {
500
503
  /**
501
504
  * Broad property category. 'residential': dwellings including houses, flats, bungalows, and maisonettes. 'commercial': non-residential premises such as offices, retail units, warehouses, and mixed-use buildings.
502
505
  */
503
- category: GetListingBySourceCategory;
506
+ category?: GetListingBySourceCategory | null | undefined;
504
507
  /**
505
508
  * ISO 8601 datetime when this listing record was first created in our system. This may differ from publishedDate if the listing was retrospectively imported.
506
509
  */
@@ -574,15 +577,15 @@ export type GetListingBySourceResponseBody = {
574
577
  */
575
578
  object: GetListingBySourceObject;
576
579
  /**
577
- * Current listing price in GBP pence. Divide by 100 to convert to pounds sterling. For sale listings: the asking price (e.g. 50000000 = £500,000). For rental listings: the monthly rent per calendar month (e.g. 150000 = £1,500 pcm). Always reflects the most recent price after any revisions.
580
+ * Current listing price in GBP pence. Divide by 100 to convert to pounds sterling. For sale listings: the asking price (e.g. 50000000 = £500,000). For rental listings: the monthly rent per calendar month (e.g. 150000 = £1,500 pcm). Always reflects the most recent price after any revisions. May be null/absent when the source feed does not expose a price.
578
581
  */
579
- price: number;
582
+ price?: number | null | undefined;
580
583
  /**
581
584
  * Chronological history of price changes since the listing was first published. Each entry records a revision event with the old and new prices. Useful for tracking asking-price reductions and market sentiment. Ordered from earliest to most recent change.
582
585
  */
583
586
  priceHistory?: Array<GetListingBySourcePriceHistory> | undefined;
584
587
  /**
585
- * Primary property type classification. Common values for residential include: 'detached', 'semi-detached', 'terraced', 'flat', 'bungalow', 'maisonette', 'end_terrace', 'cottage', 'park_home'. For commercial: 'office', 'retail', 'warehouse', 'industrial', 'land'. Values are normalised from provider-specific taxonomies but may occasionally contain non-standard entries.
588
+ * Primary property type classification, normalised from provider-specific taxonomies to the canonical PROPERTY_TYPE_MAPPING_VALUES set: unknown, other, flat, detached, semiDetached, terraced, bungalow, maisonette, cottage, chalet, lodge, mobileHome, houseboat, retirement, characterProperty, blockOfFlats, houseShare, farmhouse, mill, barn, coachHouse, statelyHome, farm, parking, equestrian, restaurant, industrial, warehouse, leisure, retail, land, office, riad, hotel, studentAccommodation, commercial, pub, bar, hotelRoom, shop, retailHighStreet, retailOutOfTown, industrialDevelopment, distributionWarehouse, industrialPark, storage, servicedOffice, residentialDevelopment, commercialDevelopment, mixedUse. This is a free-form string (not schema-enforced) and may occasionally contain non-standard entries.
586
589
  */
587
590
  propertyType: string;
588
591
  /**
@@ -621,6 +624,7 @@ export type GetListingBySourceResponseBody = {
621
624
  * ISO 8601 datetime when this listing record was last modified in our system. Updated whenever any field changes, including price revisions, status transitions, or image additions.
622
625
  */
623
626
  updatedAt?: Date | undefined;
627
+ additionalProperties?: { [k: string]: any } | undefined;
624
628
  };
625
629
 
626
630
  /** @internal */
@@ -660,16 +664,16 @@ export const GetListingBySourceAddress$inboundSchema: z.ZodType<
660
664
  z.ZodTypeDef,
661
665
  unknown
662
666
  > = z.object({
663
- city: z.string().optional(),
667
+ city: z.nullable(z.string()).optional(),
664
668
  country: z.string().default("GB"),
665
- district: z.string().optional(),
666
- incode: z.string().optional(),
669
+ district: z.nullable(z.string()).optional(),
670
+ incode: z.nullable(z.string()).optional(),
667
671
  originalAddress: z.string(),
668
- outcode: z.string().optional(),
672
+ outcode: z.nullable(z.string()).optional(),
669
673
  postcode: z.string(),
670
- propertyNumber: z.string().optional(),
671
- region: z.string().optional(),
672
- street: z.string().optional(),
674
+ propertyNumber: z.nullable(z.string()).optional(),
675
+ region: z.nullable(z.string()).optional(),
676
+ street: z.nullable(z.string()).optional(),
673
677
  });
674
678
 
675
679
  export function getListingBySourceAddressFromJSON(
@@ -726,7 +730,7 @@ export const GetListingBySourceBrochureImages$inboundSchema: z.ZodType<
726
730
  z.ZodTypeDef,
727
731
  unknown
728
732
  > = z.object({
729
- caption: z.string().optional(),
733
+ caption: z.nullable(z.string()).optional(),
730
734
  order: z.number().optional(),
731
735
  type: GetListingBySourceListingsType$inboundSchema.optional(),
732
736
  url: z.string(),
@@ -762,7 +766,7 @@ export const GetListingBySourceEnergyRatingImages$inboundSchema: z.ZodType<
762
766
  z.ZodTypeDef,
763
767
  unknown
764
768
  > = z.object({
765
- caption: z.string().optional(),
769
+ caption: z.nullable(z.string()).optional(),
766
770
  order: z.number().optional(),
767
771
  type: GetListingBySourceListingsResponseType$inboundSchema.optional(),
768
772
  url: z.string(),
@@ -812,7 +816,7 @@ export const GetListingBySourceFloorPlanImages$inboundSchema: z.ZodType<
812
816
  z.ZodTypeDef,
813
817
  unknown
814
818
  > = z.object({
815
- caption: z.string().optional(),
819
+ caption: z.nullable(z.string()).optional(),
816
820
  order: z.number().optional(),
817
821
  type: GetListingBySourceListingsResponse200Type$inboundSchema.optional(),
818
822
  url: z.string(),
@@ -844,7 +848,7 @@ export const GetListingBySourceImages$inboundSchema: z.ZodType<
844
848
  z.ZodTypeDef,
845
849
  unknown
846
850
  > = z.object({
847
- caption: z.string().optional(),
851
+ caption: z.nullable(z.string()).optional(),
848
852
  order: z.number().optional(),
849
853
  type: GetListingBySourceListingsResponse200ApplicationJSONType$inboundSchema
850
854
  .optional(),
@@ -993,66 +997,70 @@ export const GetListingBySourceResponseBody$inboundSchema: z.ZodType<
993
997
  GetListingBySourceResponseBody,
994
998
  z.ZodTypeDef,
995
999
  unknown
996
- > = z.object({
997
- address: z.lazy(() => GetListingBySourceAddress$inboundSchema),
998
- agent: z.nullable(z.lazy(() => GetListingBySourceAgent$inboundSchema))
999
- .optional(),
1000
- baths: z.nullable(z.number()).optional(),
1001
- beds: z.nullable(z.number()).optional(),
1002
- brochureImages: z.array(
1003
- z.lazy(() => GetListingBySourceBrochureImages$inboundSchema),
1004
- ).optional(),
1005
- category: GetListingBySourceCategory$inboundSchema,
1006
- createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
1007
- .optional(),
1008
- currency: z.string().default("GBP"),
1009
- displayAddress: z.string().optional(),
1010
- energyRatingImages: z.array(
1011
- z.lazy(() => GetListingBySourceEnergyRatingImages$inboundSchema),
1012
- ).optional(),
1013
- features: z.nullable(
1014
- z.array(z.lazy(() => GetListingBySourceFeatures$inboundSchema)),
1015
- ).optional(),
1016
- floorPlanImages: z.array(
1017
- z.lazy(() => GetListingBySourceFloorPlanImages$inboundSchema),
1018
- ).optional(),
1019
- id: z.string(),
1020
- images: z.array(z.lazy(() => GetListingBySourceImages$inboundSchema))
1021
- .optional(),
1022
- isAuction: z.boolean().optional(),
1023
- isNewBuild: z.boolean().optional(),
1024
- isRetirement: z.boolean().optional(),
1025
- isSharedOwnership: z.boolean().optional(),
1026
- key: z.string(),
1027
- lat: z.number().optional(),
1028
- lng: z.number().optional(),
1029
- locationId: z.nullable(z.string()).optional(),
1030
- narratives: z.nullable(
1031
- z.array(z.lazy(() => GetListingBySourceNarratives$inboundSchema)),
1032
- ).optional(),
1033
- object: GetListingBySourceObject$inboundSchema,
1034
- price: z.number(),
1035
- priceHistory: z.array(
1036
- z.lazy(() => GetListingBySourcePriceHistory$inboundSchema),
1037
- ).optional(),
1038
- propertyType: z.string(),
1039
- provider: z.string(),
1040
- publishedDate: z.string().datetime({ offset: true }).transform(v =>
1041
- new Date(v)
1042
- ),
1043
- receptions: z.nullable(z.number()).optional(),
1044
- removedDate: z.nullable(
1045
- z.string().datetime({ offset: true }).transform(v => new Date(v)),
1046
- ).optional(),
1047
- spatial: z.nullable(
1048
- z.lazy(() => GetListingBySourceGeoJSONPoint$inboundSchema),
1049
- ).optional(),
1050
- status: GetListingBySourceStatus$inboundSchema,
1051
- subPropertyType: z.nullable(z.string()).optional(),
1052
- type: GetListingBySourceType$inboundSchema,
1053
- updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
1054
- .optional(),
1055
- });
1000
+ > = collectExtraKeys$(
1001
+ z.object({
1002
+ address: z.lazy(() => GetListingBySourceAddress$inboundSchema),
1003
+ agent: z.nullable(z.lazy(() => GetListingBySourceAgent$inboundSchema))
1004
+ .optional(),
1005
+ baths: z.nullable(z.number()).optional(),
1006
+ beds: z.nullable(z.number()).optional(),
1007
+ brochureImages: z.array(
1008
+ z.lazy(() => GetListingBySourceBrochureImages$inboundSchema),
1009
+ ).optional(),
1010
+ category: z.nullable(GetListingBySourceCategory$inboundSchema).optional(),
1011
+ createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
1012
+ .optional(),
1013
+ currency: z.string().default("GBP"),
1014
+ displayAddress: z.string().optional(),
1015
+ energyRatingImages: z.array(
1016
+ z.lazy(() => GetListingBySourceEnergyRatingImages$inboundSchema),
1017
+ ).optional(),
1018
+ features: z.nullable(
1019
+ z.array(z.lazy(() => GetListingBySourceFeatures$inboundSchema)),
1020
+ ).optional(),
1021
+ floorPlanImages: z.array(
1022
+ z.lazy(() => GetListingBySourceFloorPlanImages$inboundSchema),
1023
+ ).optional(),
1024
+ id: z.string(),
1025
+ images: z.array(z.lazy(() => GetListingBySourceImages$inboundSchema))
1026
+ .optional(),
1027
+ isAuction: z.boolean().optional(),
1028
+ isNewBuild: z.boolean().optional(),
1029
+ isRetirement: z.boolean().optional(),
1030
+ isSharedOwnership: z.boolean().optional(),
1031
+ key: z.string(),
1032
+ lat: z.number().optional(),
1033
+ lng: z.number().optional(),
1034
+ locationId: z.nullable(z.string()).optional(),
1035
+ narratives: z.nullable(
1036
+ z.array(z.lazy(() => GetListingBySourceNarratives$inboundSchema)),
1037
+ ).optional(),
1038
+ object: GetListingBySourceObject$inboundSchema,
1039
+ price: z.nullable(z.number()).optional(),
1040
+ priceHistory: z.array(
1041
+ z.lazy(() => GetListingBySourcePriceHistory$inboundSchema),
1042
+ ).optional(),
1043
+ propertyType: z.string(),
1044
+ provider: z.string(),
1045
+ publishedDate: z.string().datetime({ offset: true }).transform(v =>
1046
+ new Date(v)
1047
+ ),
1048
+ receptions: z.nullable(z.number()).optional(),
1049
+ removedDate: z.nullable(
1050
+ z.string().datetime({ offset: true }).transform(v => new Date(v)),
1051
+ ).optional(),
1052
+ spatial: z.nullable(
1053
+ z.lazy(() => GetListingBySourceGeoJSONPoint$inboundSchema),
1054
+ ).optional(),
1055
+ status: GetListingBySourceStatus$inboundSchema,
1056
+ subPropertyType: z.nullable(z.string()).optional(),
1057
+ type: GetListingBySourceType$inboundSchema,
1058
+ updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
1059
+ .optional(),
1060
+ }).catchall(z.any()),
1061
+ "additionalProperties",
1062
+ true,
1063
+ );
1056
1064
 
1057
1065
  export function getListingBySourceResponseBodyFromJSON(
1058
1066
  jsonString: string,