@vepler/sdk 6.1.0 → 6.36.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 (643) hide show
  1. package/FUNCTIONS.md +1 -1
  2. package/README.md +433 -421
  3. package/dist/commonjs/funcs/geographyGetGeographyAncestors.d.ts +1 -1
  4. package/dist/commonjs/funcs/geographyGetGeographyAncestors.js +1 -1
  5. package/dist/commonjs/funcs/geographyGetGeographyAreas.d.ts +1 -1
  6. package/dist/commonjs/funcs/geographyGetGeographyAreas.js +1 -1
  7. package/dist/commonjs/funcs/geographyGetGeographyDescendants.d.ts +1 -1
  8. package/dist/commonjs/funcs/geographyGetGeographyDescendants.js +1 -1
  9. package/dist/commonjs/funcs/geographyGetGeographyProvenance.d.ts +1 -1
  10. package/dist/commonjs/funcs/geographyGetGeographyProvenance.js +1 -1
  11. package/dist/commonjs/funcs/geographyGetGeographyRelease.d.ts +1 -1
  12. package/dist/commonjs/funcs/geographyGetGeographyRelease.js +1 -1
  13. package/dist/commonjs/funcs/modelsGetV1AiModels.d.ts +18 -0
  14. package/dist/commonjs/funcs/modelsGetV1AiModels.d.ts.map +1 -0
  15. package/dist/commonjs/funcs/modelsGetV1AiModels.js +109 -0
  16. package/dist/commonjs/funcs/modelsGetV1AiModels.js.map +1 -0
  17. package/dist/commonjs/funcs/modelsGetV1AiModelsModel.d.ts +19 -0
  18. package/dist/commonjs/funcs/modelsGetV1AiModelsModel.d.ts.map +1 -0
  19. package/dist/commonjs/funcs/modelsGetV1AiModelsModel.js +125 -0
  20. package/dist/commonjs/funcs/modelsGetV1AiModelsModel.js.map +1 -0
  21. package/dist/commonjs/funcs/modelsPostV1AiChatCompletions.d.ts +25 -0
  22. package/dist/commonjs/funcs/modelsPostV1AiChatCompletions.d.ts.map +1 -0
  23. package/dist/commonjs/funcs/modelsPostV1AiChatCompletions.js +129 -0
  24. package/dist/commonjs/funcs/modelsPostV1AiChatCompletions.js.map +1 -0
  25. package/dist/commonjs/funcs/modelsPostV1AiResponses.d.ts +18 -0
  26. package/dist/commonjs/funcs/modelsPostV1AiResponses.d.ts.map +1 -0
  27. package/dist/commonjs/funcs/modelsPostV1AiResponses.js +119 -0
  28. package/dist/commonjs/funcs/modelsPostV1AiResponses.js.map +1 -0
  29. package/dist/commonjs/funcs/searchSearchSuggest.js +1 -0
  30. package/dist/commonjs/funcs/searchSearchSuggest.js.map +1 -1
  31. package/dist/commonjs/funcs/sitesGet.d.ts +1 -1
  32. package/dist/commonjs/funcs/sitesGet.js +1 -1
  33. package/dist/commonjs/funcs/streetsSearchStreets.d.ts +1 -1
  34. package/dist/commonjs/funcs/streetsSearchStreets.js +1 -1
  35. package/dist/commonjs/lib/config.d.ts +3 -3
  36. package/dist/commonjs/lib/config.js +3 -3
  37. package/dist/commonjs/lib/config.js.map +1 -1
  38. package/dist/commonjs/sdk/geography.d.ts +5 -5
  39. package/dist/commonjs/sdk/geography.js +5 -5
  40. package/dist/commonjs/sdk/models/errors/index.d.ts +1 -0
  41. package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
  42. package/dist/commonjs/sdk/models/errors/index.js +1 -0
  43. package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
  44. package/dist/commonjs/sdk/models/errors/modelapierror.d.ts +57 -0
  45. package/dist/commonjs/sdk/models/errors/modelapierror.d.ts.map +1 -0
  46. package/dist/commonjs/sdk/models/errors/modelapierror.js +91 -0
  47. package/dist/commonjs/sdk/models/errors/modelapierror.js.map +1 -0
  48. package/dist/commonjs/sdk/models/operations/getepcbylocationid.d.ts +3 -3
  49. package/dist/commonjs/sdk/models/operations/getepcbylocationid.js +1 -1
  50. package/dist/commonjs/sdk/models/operations/getgeographychildren.d.ts +2 -2
  51. package/dist/commonjs/sdk/models/operations/getv1aimodelsmodel.d.ts +15 -0
  52. package/dist/commonjs/sdk/models/operations/getv1aimodelsmodel.d.ts.map +1 -0
  53. package/dist/commonjs/sdk/models/operations/getv1aimodelsmodel.js +49 -0
  54. package/dist/commonjs/sdk/models/operations/getv1aimodelsmodel.js.map +1 -0
  55. package/dist/commonjs/sdk/models/operations/index.d.ts +2 -0
  56. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  57. package/dist/commonjs/sdk/models/operations/index.js +2 -0
  58. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  59. package/dist/commonjs/sdk/models/operations/postv1aichatcompletions.d.ts +9 -0
  60. package/dist/commonjs/sdk/models/operations/postv1aichatcompletions.d.ts.map +1 -0
  61. package/dist/commonjs/sdk/models/operations/postv1aichatcompletions.js +49 -0
  62. package/dist/commonjs/sdk/models/operations/postv1aichatcompletions.js.map +1 -0
  63. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts +28 -0
  64. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  65. package/dist/commonjs/sdk/models/operations/resolveaddress.js +13 -1
  66. package/dist/commonjs/sdk/models/operations/resolveaddress.js.map +1 -1
  67. package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts +19 -0
  68. package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts.map +1 -1
  69. package/dist/commonjs/sdk/models/operations/searchsuggest.js +12 -1
  70. package/dist/commonjs/sdk/models/operations/searchsuggest.js.map +1 -1
  71. package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts +8 -0
  72. package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts.map +1 -1
  73. package/dist/commonjs/sdk/models/shared/addressresolverequest.js +3 -0
  74. package/dist/commonjs/sdk/models/shared/addressresolverequest.js.map +1 -1
  75. package/dist/commonjs/sdk/models/shared/avmanalysisresponse.d.ts +1 -1
  76. package/dist/commonjs/sdk/models/shared/avmconfidenceinterval.d.ts +3 -3
  77. package/dist/commonjs/sdk/models/shared/avmmetadata.d.ts +1 -1
  78. package/dist/commonjs/sdk/models/shared/avmpredictbylocationrequest.d.ts +3 -3
  79. package/dist/commonjs/sdk/models/shared/avmpredictbylocationrequest.js +1 -1
  80. package/dist/commonjs/sdk/models/shared/avmpredictresponse.d.ts +1 -1
  81. package/dist/commonjs/sdk/models/shared/chatcompletion.d.ts +95 -0
  82. package/dist/commonjs/sdk/models/shared/chatcompletion.d.ts.map +1 -0
  83. package/dist/commonjs/sdk/models/shared/chatcompletion.js +122 -0
  84. package/dist/commonjs/sdk/models/shared/chatcompletion.js.map +1 -0
  85. package/dist/commonjs/sdk/models/shared/chatcompletionrequest.d.ts +203 -0
  86. package/dist/commonjs/sdk/models/shared/chatcompletionrequest.d.ts.map +1 -0
  87. package/dist/commonjs/sdk/models/shared/chatcompletionrequest.js +144 -0
  88. package/dist/commonjs/sdk/models/shared/chatcompletionrequest.js.map +1 -0
  89. package/dist/commonjs/sdk/models/shared/epcqueryresponse.d.ts +3 -3
  90. package/dist/commonjs/sdk/models/shared/epcqueryresponse.js +1 -1
  91. package/dist/commonjs/sdk/models/shared/geographyarea.d.ts +2 -2
  92. package/dist/commonjs/sdk/models/shared/geographyrelatedarea.d.ts +2 -2
  93. package/dist/commonjs/sdk/models/shared/historicalvaluation.d.ts +3 -3
  94. package/dist/commonjs/sdk/models/shared/imagecondition.d.ts +18 -0
  95. package/dist/commonjs/sdk/models/shared/imagecondition.d.ts.map +1 -0
  96. package/dist/commonjs/sdk/models/shared/imagecondition.js +52 -0
  97. package/dist/commonjs/sdk/models/shared/imagecondition.js.map +1 -0
  98. package/dist/commonjs/sdk/models/shared/imagedocumentclass.d.ts +22 -0
  99. package/dist/commonjs/sdk/models/shared/imagedocumentclass.d.ts.map +1 -0
  100. package/dist/commonjs/sdk/models/shared/imagedocumentclass.js +56 -0
  101. package/dist/commonjs/sdk/models/shared/imagedocumentclass.js.map +1 -0
  102. package/dist/commonjs/sdk/models/shared/imagequality.d.ts +12 -0
  103. package/dist/commonjs/sdk/models/shared/imagequality.d.ts.map +1 -0
  104. package/dist/commonjs/sdk/models/shared/imagequality.js +49 -0
  105. package/dist/commonjs/sdk/models/shared/imagequality.js.map +1 -0
  106. package/dist/commonjs/sdk/models/shared/imagescene.d.ts +62 -0
  107. package/dist/commonjs/sdk/models/shared/imagescene.d.ts.map +1 -0
  108. package/dist/commonjs/sdk/models/shared/imagescene.js +96 -0
  109. package/dist/commonjs/sdk/models/shared/imagescene.js.map +1 -0
  110. package/dist/commonjs/sdk/models/shared/imagescenelabel.d.ts +18 -0
  111. package/dist/commonjs/sdk/models/shared/imagescenelabel.d.ts.map +1 -0
  112. package/dist/commonjs/sdk/models/shared/{propertyonstreet.js → imagescenelabel.js} +9 -11
  113. package/dist/commonjs/sdk/models/shared/imagescenelabel.js.map +1 -0
  114. package/dist/commonjs/sdk/models/shared/index.d.ts +24 -3
  115. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  116. package/dist/commonjs/sdk/models/shared/index.js +24 -3
  117. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  118. package/dist/commonjs/sdk/models/shared/listing.d.ts +118 -0
  119. package/dist/commonjs/sdk/models/shared/listing.d.ts.map +1 -1
  120. package/dist/commonjs/sdk/models/shared/listing.js +148 -1
  121. package/dist/commonjs/sdk/models/shared/listing.js.map +1 -1
  122. package/dist/commonjs/sdk/models/shared/listingimage.d.ts +52 -0
  123. package/dist/commonjs/sdk/models/shared/listingimage.d.ts.map +1 -1
  124. package/dist/commonjs/sdk/models/shared/listingimage.js +31 -1
  125. package/dist/commonjs/sdk/models/shared/listingimage.js.map +1 -1
  126. package/dist/commonjs/sdk/models/shared/model.d.ts +72 -0
  127. package/dist/commonjs/sdk/models/shared/model.d.ts.map +1 -0
  128. package/dist/commonjs/sdk/models/shared/model.js +100 -0
  129. package/dist/commonjs/sdk/models/shared/model.js.map +1 -0
  130. package/dist/commonjs/sdk/models/shared/modellist.d.ts +19 -0
  131. package/dist/commonjs/sdk/models/shared/modellist.d.ts.map +1 -0
  132. package/dist/commonjs/sdk/models/shared/{streetdetails.js → modellist.js} +14 -13
  133. package/dist/commonjs/sdk/models/shared/modellist.js.map +1 -0
  134. package/dist/commonjs/sdk/models/shared/modelresponse.d.ts +116 -0
  135. package/dist/commonjs/sdk/models/shared/modelresponse.d.ts.map +1 -0
  136. package/dist/commonjs/sdk/models/shared/modelresponse.js +137 -0
  137. package/dist/commonjs/sdk/models/shared/modelresponse.js.map +1 -0
  138. package/dist/commonjs/sdk/models/shared/mortgagecharge.d.ts +4 -0
  139. package/dist/commonjs/sdk/models/shared/mortgagecharge.d.ts.map +1 -1
  140. package/dist/commonjs/sdk/models/shared/mortgagecharge.js +1 -0
  141. package/dist/commonjs/sdk/models/shared/mortgagecharge.js.map +1 -1
  142. package/dist/commonjs/sdk/models/shared/observedfeature.d.ts +21 -0
  143. package/dist/commonjs/sdk/models/shared/observedfeature.d.ts.map +1 -0
  144. package/dist/commonjs/sdk/models/shared/observedfeature.js +52 -0
  145. package/dist/commonjs/sdk/models/shared/observedfeature.js.map +1 -0
  146. package/dist/commonjs/sdk/models/shared/othercharge.d.ts +8 -1
  147. package/dist/commonjs/sdk/models/shared/othercharge.d.ts.map +1 -1
  148. package/dist/commonjs/sdk/models/shared/othercharge.js +1 -0
  149. package/dist/commonjs/sdk/models/shared/othercharge.js.map +1 -1
  150. package/dist/commonjs/sdk/models/shared/regulatoryzonecharges.d.ts +4 -4
  151. package/dist/commonjs/sdk/models/shared/regulatoryzonecharges.d.ts.map +1 -1
  152. package/dist/commonjs/sdk/models/shared/regulatoryzonecharges.js +4 -4
  153. package/dist/commonjs/sdk/models/shared/regulatoryzonecharges.js.map +1 -1
  154. package/dist/commonjs/sdk/models/shared/responserequest.d.ts +148 -0
  155. package/dist/commonjs/sdk/models/shared/responserequest.d.ts.map +1 -0
  156. package/dist/commonjs/sdk/models/shared/responserequest.js +111 -0
  157. package/dist/commonjs/sdk/models/shared/responserequest.js.map +1 -0
  158. package/dist/commonjs/sdk/models/shared/searchresponse.d.ts +4 -0
  159. package/dist/commonjs/sdk/models/shared/searchresponse.d.ts.map +1 -1
  160. package/dist/commonjs/sdk/models/shared/searchresponse.js +1 -0
  161. package/dist/commonjs/sdk/models/shared/searchresponse.js.map +1 -1
  162. package/dist/commonjs/sdk/models/shared/site.d.ts +1 -1
  163. package/dist/commonjs/sdk/models/shared/streetdataset.d.ts +17 -0
  164. package/dist/commonjs/sdk/models/shared/streetdataset.d.ts.map +1 -0
  165. package/dist/commonjs/sdk/models/shared/streetdataset.js +51 -0
  166. package/dist/commonjs/sdk/models/shared/streetdataset.js.map +1 -0
  167. package/dist/commonjs/sdk/models/shared/streetdescriptor.d.ts +2 -2
  168. package/dist/commonjs/sdk/models/shared/streetdescriptor.d.ts.map +1 -1
  169. package/dist/commonjs/sdk/models/shared/streetdescriptor.js +1 -1
  170. package/dist/commonjs/sdk/models/shared/streetdescriptor.js.map +1 -1
  171. package/dist/commonjs/sdk/models/shared/streetfield.d.ts +16 -0
  172. package/dist/commonjs/sdk/models/shared/streetfield.d.ts.map +1 -0
  173. package/dist/commonjs/sdk/models/shared/streetfield.js +54 -0
  174. package/dist/commonjs/sdk/models/shared/streetfield.js.map +1 -0
  175. package/dist/commonjs/sdk/models/shared/streetmatch.d.ts +9 -4
  176. package/dist/commonjs/sdk/models/shared/streetmatch.d.ts.map +1 -1
  177. package/dist/commonjs/sdk/models/shared/streetmatch.js +2 -0
  178. package/dist/commonjs/sdk/models/shared/streetmatch.js.map +1 -1
  179. package/dist/commonjs/sdk/models/shared/streetnameconfidence.d.ts +17 -0
  180. package/dist/commonjs/sdk/models/shared/streetnameconfidence.d.ts.map +1 -0
  181. package/dist/commonjs/sdk/models/shared/streetnameconfidence.js +51 -0
  182. package/dist/commonjs/sdk/models/shared/streetnameconfidence.js.map +1 -0
  183. package/dist/commonjs/sdk/models/shared/streetnamekind.d.ts +16 -0
  184. package/dist/commonjs/sdk/models/shared/streetnamekind.d.ts.map +1 -0
  185. package/dist/commonjs/sdk/models/shared/streetnamekind.js +50 -0
  186. package/dist/commonjs/sdk/models/shared/streetnamekind.js.map +1 -0
  187. package/dist/commonjs/sdk/models/shared/streetproperties.d.ts +20 -0
  188. package/dist/commonjs/sdk/models/shared/streetproperties.d.ts.map +1 -0
  189. package/dist/commonjs/sdk/models/shared/{streetstatistics.js → streetproperties.js} +8 -8
  190. package/dist/commonjs/sdk/models/shared/streetproperties.js.map +1 -0
  191. package/dist/commonjs/sdk/models/shared/streetpropertyoptions.d.ts +28 -0
  192. package/dist/commonjs/sdk/models/shared/streetpropertyoptions.d.ts.map +1 -0
  193. package/dist/commonjs/sdk/models/shared/streetpropertyoptions.js +51 -0
  194. package/dist/commonjs/sdk/models/shared/streetpropertyoptions.js.map +1 -0
  195. package/dist/commonjs/sdk/models/shared/streetprovenance.d.ts +45 -0
  196. package/dist/commonjs/sdk/models/shared/streetprovenance.d.ts.map +1 -0
  197. package/dist/commonjs/sdk/models/shared/streetprovenance.js +58 -0
  198. package/dist/commonjs/sdk/models/shared/streetprovenance.js.map +1 -0
  199. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.d.ts +6 -1
  200. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.d.ts.map +1 -1
  201. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.js +1 -0
  202. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.js.map +1 -1
  203. package/dist/commonjs/sdk/models/shared/streetquerybyname.d.ts +2 -2
  204. package/dist/commonjs/sdk/models/shared/streetquerybyname.js +1 -1
  205. package/dist/commonjs/sdk/models/shared/streetquerybyname.js.map +1 -1
  206. package/dist/commonjs/sdk/models/shared/streetquerybypostcode.d.ts +5 -0
  207. package/dist/commonjs/sdk/models/shared/streetquerybypostcode.d.ts.map +1 -1
  208. package/dist/commonjs/sdk/models/shared/streetquerybypostcode.js +1 -0
  209. package/dist/commonjs/sdk/models/shared/streetquerybypostcode.js.map +1 -1
  210. package/dist/commonjs/sdk/models/shared/streetqueryrequest.d.ts +20 -28
  211. package/dist/commonjs/sdk/models/shared/streetqueryrequest.d.ts.map +1 -1
  212. package/dist/commonjs/sdk/models/shared/streetqueryrequest.js +13 -12
  213. package/dist/commonjs/sdk/models/shared/streetqueryrequest.js.map +1 -1
  214. package/dist/commonjs/sdk/models/shared/streetqueryresponse.d.ts +6 -14
  215. package/dist/commonjs/sdk/models/shared/streetqueryresponse.d.ts.map +1 -1
  216. package/dist/commonjs/sdk/models/shared/streetqueryresponse.js +3 -6
  217. package/dist/commonjs/sdk/models/shared/streetqueryresponse.js.map +1 -1
  218. package/dist/commonjs/sdk/models/shared/streetrecord.d.ts +126 -0
  219. package/dist/commonjs/sdk/models/shared/streetrecord.d.ts.map +1 -0
  220. package/dist/commonjs/sdk/models/shared/streetrecord.js +87 -0
  221. package/dist/commonjs/sdk/models/shared/streetrecord.js.map +1 -0
  222. package/dist/commonjs/sdk/models/shared/streetsource.d.ts +16 -0
  223. package/dist/commonjs/sdk/models/shared/streetsource.d.ts.map +1 -0
  224. package/dist/commonjs/sdk/models/shared/streetsource.js +50 -0
  225. package/dist/commonjs/sdk/models/shared/streetsource.js.map +1 -0
  226. package/dist/commonjs/sdk/models/shared/titlealert.d.ts +30 -0
  227. package/dist/commonjs/sdk/models/shared/titlealert.d.ts.map +1 -0
  228. package/dist/commonjs/sdk/models/shared/titlealert.js +66 -0
  229. package/dist/commonjs/sdk/models/shared/titlealert.js.map +1 -0
  230. package/dist/commonjs/sdk/models/shared/titlecovenant.d.ts +7 -0
  231. package/dist/commonjs/sdk/models/shared/titlecovenant.d.ts.map +1 -1
  232. package/dist/commonjs/sdk/models/shared/titlecovenant.js +1 -0
  233. package/dist/commonjs/sdk/models/shared/titlecovenant.js.map +1 -1
  234. package/dist/commonjs/sdk/models/shared/titleextractionpayload.d.ts +19 -1
  235. package/dist/commonjs/sdk/models/shared/titleextractionpayload.d.ts.map +1 -1
  236. package/dist/commonjs/sdk/models/shared/titleextractionpayload.js +6 -0
  237. package/dist/commonjs/sdk/models/shared/titleextractionpayload.js.map +1 -1
  238. package/dist/commonjs/sdk/models/shared/titlenotice.d.ts +7 -0
  239. package/dist/commonjs/sdk/models/shared/titlenotice.d.ts.map +1 -1
  240. package/dist/commonjs/sdk/models/shared/titlenotice.js +1 -0
  241. package/dist/commonjs/sdk/models/shared/titlenotice.js.map +1 -1
  242. package/dist/commonjs/sdk/models/shared/titlepricepaid.d.ts +48 -0
  243. package/dist/commonjs/sdk/models/shared/titlepricepaid.d.ts.map +1 -0
  244. package/dist/commonjs/sdk/models/shared/titlepricepaid.js +66 -0
  245. package/dist/commonjs/sdk/models/shared/titlepricepaid.js.map +1 -0
  246. package/dist/commonjs/sdk/models/shared/titlepropertyright.d.ts +50 -0
  247. package/dist/commonjs/sdk/models/shared/titlepropertyright.d.ts.map +1 -0
  248. package/dist/commonjs/sdk/models/shared/titlepropertyright.js +68 -0
  249. package/dist/commonjs/sdk/models/shared/titlepropertyright.js.map +1 -0
  250. package/dist/commonjs/sdk/models/shared/titlerestriction.d.ts +7 -0
  251. package/dist/commonjs/sdk/models/shared/titlerestriction.d.ts.map +1 -1
  252. package/dist/commonjs/sdk/models/shared/titlerestriction.js +1 -0
  253. package/dist/commonjs/sdk/models/shared/titlerestriction.js.map +1 -1
  254. package/dist/commonjs/sdk/models/shared/titlesummarycounts.d.ts +1 -0
  255. package/dist/commonjs/sdk/models/shared/titlesummarycounts.d.ts.map +1 -1
  256. package/dist/commonjs/sdk/models/shared/titlesummarycounts.js +1 -0
  257. package/dist/commonjs/sdk/models/shared/titlesummarycounts.js.map +1 -1
  258. package/dist/commonjs/sdk/models.d.ts +38 -0
  259. package/dist/commonjs/sdk/models.d.ts.map +1 -0
  260. package/dist/commonjs/sdk/models.js +54 -0
  261. package/dist/commonjs/sdk/models.js.map +1 -0
  262. package/dist/commonjs/sdk/sdk.d.ts +3 -0
  263. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  264. package/dist/commonjs/sdk/sdk.js +4 -0
  265. package/dist/commonjs/sdk/sdk.js.map +1 -1
  266. package/dist/commonjs/sdk/sites.d.ts +1 -1
  267. package/dist/commonjs/sdk/sites.js +1 -1
  268. package/dist/commonjs/sdk/streets.d.ts +1 -1
  269. package/dist/commonjs/sdk/streets.js +1 -1
  270. package/dist/esm/funcs/geographyGetGeographyAncestors.d.ts +1 -1
  271. package/dist/esm/funcs/geographyGetGeographyAncestors.js +1 -1
  272. package/dist/esm/funcs/geographyGetGeographyAreas.d.ts +1 -1
  273. package/dist/esm/funcs/geographyGetGeographyAreas.js +1 -1
  274. package/dist/esm/funcs/geographyGetGeographyDescendants.d.ts +1 -1
  275. package/dist/esm/funcs/geographyGetGeographyDescendants.js +1 -1
  276. package/dist/esm/funcs/geographyGetGeographyProvenance.d.ts +1 -1
  277. package/dist/esm/funcs/geographyGetGeographyProvenance.js +1 -1
  278. package/dist/esm/funcs/geographyGetGeographyRelease.d.ts +1 -1
  279. package/dist/esm/funcs/geographyGetGeographyRelease.js +1 -1
  280. package/dist/esm/funcs/modelsGetV1AiModels.d.ts +18 -0
  281. package/dist/esm/funcs/modelsGetV1AiModels.d.ts.map +1 -0
  282. package/dist/esm/funcs/modelsGetV1AiModels.js +73 -0
  283. package/dist/esm/funcs/modelsGetV1AiModels.js.map +1 -0
  284. package/dist/esm/funcs/modelsGetV1AiModelsModel.d.ts +19 -0
  285. package/dist/esm/funcs/modelsGetV1AiModelsModel.d.ts.map +1 -0
  286. package/dist/esm/funcs/modelsGetV1AiModelsModel.js +89 -0
  287. package/dist/esm/funcs/modelsGetV1AiModelsModel.js.map +1 -0
  288. package/dist/esm/funcs/modelsPostV1AiChatCompletions.d.ts +25 -0
  289. package/dist/esm/funcs/modelsPostV1AiChatCompletions.d.ts.map +1 -0
  290. package/dist/esm/funcs/modelsPostV1AiChatCompletions.js +92 -0
  291. package/dist/esm/funcs/modelsPostV1AiChatCompletions.js.map +1 -0
  292. package/dist/esm/funcs/modelsPostV1AiResponses.d.ts +18 -0
  293. package/dist/esm/funcs/modelsPostV1AiResponses.d.ts.map +1 -0
  294. package/dist/esm/funcs/modelsPostV1AiResponses.js +83 -0
  295. package/dist/esm/funcs/modelsPostV1AiResponses.js.map +1 -0
  296. package/dist/esm/funcs/searchSearchSuggest.js +1 -0
  297. package/dist/esm/funcs/searchSearchSuggest.js.map +1 -1
  298. package/dist/esm/funcs/sitesGet.d.ts +1 -1
  299. package/dist/esm/funcs/sitesGet.js +1 -1
  300. package/dist/esm/funcs/streetsSearchStreets.d.ts +1 -1
  301. package/dist/esm/funcs/streetsSearchStreets.js +1 -1
  302. package/dist/esm/lib/config.d.ts +3 -3
  303. package/dist/esm/lib/config.js +3 -3
  304. package/dist/esm/lib/config.js.map +1 -1
  305. package/dist/esm/sdk/geography.d.ts +5 -5
  306. package/dist/esm/sdk/geography.js +5 -5
  307. package/dist/esm/sdk/models/errors/index.d.ts +1 -0
  308. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  309. package/dist/esm/sdk/models/errors/index.js +1 -0
  310. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  311. package/dist/esm/sdk/models/errors/modelapierror.d.ts +57 -0
  312. package/dist/esm/sdk/models/errors/modelapierror.d.ts.map +1 -0
  313. package/dist/esm/sdk/models/errors/modelapierror.js +53 -0
  314. package/dist/esm/sdk/models/errors/modelapierror.js.map +1 -0
  315. package/dist/esm/sdk/models/operations/getepcbylocationid.d.ts +3 -3
  316. package/dist/esm/sdk/models/operations/getepcbylocationid.js +1 -1
  317. package/dist/esm/sdk/models/operations/getgeographychildren.d.ts +2 -2
  318. package/dist/esm/sdk/models/operations/getv1aimodelsmodel.d.ts +15 -0
  319. package/dist/esm/sdk/models/operations/getv1aimodelsmodel.d.ts.map +1 -0
  320. package/dist/esm/sdk/models/operations/getv1aimodelsmodel.js +12 -0
  321. package/dist/esm/sdk/models/operations/getv1aimodelsmodel.js.map +1 -0
  322. package/dist/esm/sdk/models/operations/index.d.ts +2 -0
  323. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  324. package/dist/esm/sdk/models/operations/index.js +2 -0
  325. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  326. package/dist/esm/sdk/models/operations/postv1aichatcompletions.d.ts +9 -0
  327. package/dist/esm/sdk/models/operations/postv1aichatcompletions.d.ts.map +1 -0
  328. package/dist/esm/sdk/models/operations/postv1aichatcompletions.js +12 -0
  329. package/dist/esm/sdk/models/operations/postv1aichatcompletions.js.map +1 -0
  330. package/dist/esm/sdk/models/operations/resolveaddress.d.ts +28 -0
  331. package/dist/esm/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  332. package/dist/esm/sdk/models/operations/resolveaddress.js +11 -0
  333. package/dist/esm/sdk/models/operations/resolveaddress.js.map +1 -1
  334. package/dist/esm/sdk/models/operations/searchsuggest.d.ts +19 -0
  335. package/dist/esm/sdk/models/operations/searchsuggest.d.ts.map +1 -1
  336. package/dist/esm/sdk/models/operations/searchsuggest.js +11 -0
  337. package/dist/esm/sdk/models/operations/searchsuggest.js.map +1 -1
  338. package/dist/esm/sdk/models/shared/addressresolverequest.d.ts +8 -0
  339. package/dist/esm/sdk/models/shared/addressresolverequest.d.ts.map +1 -1
  340. package/dist/esm/sdk/models/shared/addressresolverequest.js +3 -0
  341. package/dist/esm/sdk/models/shared/addressresolverequest.js.map +1 -1
  342. package/dist/esm/sdk/models/shared/avmanalysisresponse.d.ts +1 -1
  343. package/dist/esm/sdk/models/shared/avmconfidenceinterval.d.ts +3 -3
  344. package/dist/esm/sdk/models/shared/avmmetadata.d.ts +1 -1
  345. package/dist/esm/sdk/models/shared/avmpredictbylocationrequest.d.ts +3 -3
  346. package/dist/esm/sdk/models/shared/avmpredictbylocationrequest.js +1 -1
  347. package/dist/esm/sdk/models/shared/avmpredictresponse.d.ts +1 -1
  348. package/dist/esm/sdk/models/shared/chatcompletion.d.ts +95 -0
  349. package/dist/esm/sdk/models/shared/chatcompletion.d.ts.map +1 -0
  350. package/dist/esm/sdk/models/shared/chatcompletion.js +82 -0
  351. package/dist/esm/sdk/models/shared/chatcompletion.js.map +1 -0
  352. package/dist/esm/sdk/models/shared/chatcompletionrequest.d.ts +203 -0
  353. package/dist/esm/sdk/models/shared/chatcompletionrequest.d.ts.map +1 -0
  354. package/dist/esm/sdk/models/shared/chatcompletionrequest.js +103 -0
  355. package/dist/esm/sdk/models/shared/chatcompletionrequest.js.map +1 -0
  356. package/dist/esm/sdk/models/shared/epcqueryresponse.d.ts +3 -3
  357. package/dist/esm/sdk/models/shared/epcqueryresponse.js +1 -1
  358. package/dist/esm/sdk/models/shared/geographyarea.d.ts +2 -2
  359. package/dist/esm/sdk/models/shared/geographyrelatedarea.d.ts +2 -2
  360. package/dist/esm/sdk/models/shared/historicalvaluation.d.ts +3 -3
  361. package/dist/esm/sdk/models/shared/imagecondition.d.ts +18 -0
  362. package/dist/esm/sdk/models/shared/imagecondition.d.ts.map +1 -0
  363. package/dist/esm/sdk/models/shared/imagecondition.js +16 -0
  364. package/dist/esm/sdk/models/shared/imagecondition.js.map +1 -0
  365. package/dist/esm/sdk/models/shared/imagedocumentclass.d.ts +22 -0
  366. package/dist/esm/sdk/models/shared/imagedocumentclass.d.ts.map +1 -0
  367. package/dist/esm/sdk/models/shared/imagedocumentclass.js +20 -0
  368. package/dist/esm/sdk/models/shared/imagedocumentclass.js.map +1 -0
  369. package/dist/esm/sdk/models/shared/imagequality.d.ts +12 -0
  370. package/dist/esm/sdk/models/shared/imagequality.d.ts.map +1 -0
  371. package/dist/esm/sdk/models/shared/imagequality.js +13 -0
  372. package/dist/esm/sdk/models/shared/imagequality.js.map +1 -0
  373. package/dist/esm/sdk/models/shared/imagescene.d.ts +62 -0
  374. package/dist/esm/sdk/models/shared/imagescene.d.ts.map +1 -0
  375. package/dist/esm/sdk/models/shared/imagescene.js +60 -0
  376. package/dist/esm/sdk/models/shared/imagescene.js.map +1 -0
  377. package/dist/esm/sdk/models/shared/imagescenelabel.d.ts +18 -0
  378. package/dist/esm/sdk/models/shared/imagescenelabel.d.ts.map +1 -0
  379. package/dist/esm/sdk/models/shared/imagescenelabel.js +15 -0
  380. package/dist/esm/sdk/models/shared/imagescenelabel.js.map +1 -0
  381. package/dist/esm/sdk/models/shared/index.d.ts +24 -3
  382. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  383. package/dist/esm/sdk/models/shared/index.js +24 -3
  384. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  385. package/dist/esm/sdk/models/shared/listing.d.ts +118 -0
  386. package/dist/esm/sdk/models/shared/listing.d.ts.map +1 -1
  387. package/dist/esm/sdk/models/shared/listing.js +143 -0
  388. package/dist/esm/sdk/models/shared/listing.js.map +1 -1
  389. package/dist/esm/sdk/models/shared/listingimage.d.ts +52 -0
  390. package/dist/esm/sdk/models/shared/listingimage.d.ts.map +1 -1
  391. package/dist/esm/sdk/models/shared/listingimage.js +29 -0
  392. package/dist/esm/sdk/models/shared/listingimage.js.map +1 -1
  393. package/dist/esm/sdk/models/shared/model.d.ts +72 -0
  394. package/dist/esm/sdk/models/shared/model.d.ts.map +1 -0
  395. package/dist/esm/sdk/models/shared/model.js +62 -0
  396. package/dist/esm/sdk/models/shared/model.js.map +1 -0
  397. package/dist/esm/sdk/models/shared/modellist.d.ts +19 -0
  398. package/dist/esm/sdk/models/shared/modellist.d.ts.map +1 -0
  399. package/dist/esm/sdk/models/shared/modellist.js +20 -0
  400. package/dist/esm/sdk/models/shared/modellist.js.map +1 -0
  401. package/dist/esm/sdk/models/shared/modelresponse.d.ts +116 -0
  402. package/dist/esm/sdk/models/shared/modelresponse.d.ts.map +1 -0
  403. package/dist/esm/sdk/models/shared/modelresponse.js +97 -0
  404. package/dist/esm/sdk/models/shared/modelresponse.js.map +1 -0
  405. package/dist/esm/sdk/models/shared/mortgagecharge.d.ts +4 -0
  406. package/dist/esm/sdk/models/shared/mortgagecharge.d.ts.map +1 -1
  407. package/dist/esm/sdk/models/shared/mortgagecharge.js +1 -0
  408. package/dist/esm/sdk/models/shared/mortgagecharge.js.map +1 -1
  409. package/dist/esm/sdk/models/shared/observedfeature.d.ts +21 -0
  410. package/dist/esm/sdk/models/shared/observedfeature.d.ts.map +1 -0
  411. package/dist/esm/sdk/models/shared/observedfeature.js +15 -0
  412. package/dist/esm/sdk/models/shared/observedfeature.js.map +1 -0
  413. package/dist/esm/sdk/models/shared/othercharge.d.ts +8 -1
  414. package/dist/esm/sdk/models/shared/othercharge.d.ts.map +1 -1
  415. package/dist/esm/sdk/models/shared/othercharge.js +1 -0
  416. package/dist/esm/sdk/models/shared/othercharge.js.map +1 -1
  417. package/dist/esm/sdk/models/shared/regulatoryzonecharges.d.ts +4 -4
  418. package/dist/esm/sdk/models/shared/regulatoryzonecharges.d.ts.map +1 -1
  419. package/dist/esm/sdk/models/shared/regulatoryzonecharges.js +3 -3
  420. package/dist/esm/sdk/models/shared/regulatoryzonecharges.js.map +1 -1
  421. package/dist/esm/sdk/models/shared/responserequest.d.ts +148 -0
  422. package/dist/esm/sdk/models/shared/responserequest.d.ts.map +1 -0
  423. package/dist/esm/sdk/models/shared/responserequest.js +71 -0
  424. package/dist/esm/sdk/models/shared/responserequest.js.map +1 -0
  425. package/dist/esm/sdk/models/shared/searchresponse.d.ts +4 -0
  426. package/dist/esm/sdk/models/shared/searchresponse.d.ts.map +1 -1
  427. package/dist/esm/sdk/models/shared/searchresponse.js +1 -0
  428. package/dist/esm/sdk/models/shared/searchresponse.js.map +1 -1
  429. package/dist/esm/sdk/models/shared/site.d.ts +1 -1
  430. package/dist/esm/sdk/models/shared/streetdataset.d.ts +17 -0
  431. package/dist/esm/sdk/models/shared/streetdataset.d.ts.map +1 -0
  432. package/dist/esm/sdk/models/shared/streetdataset.js +15 -0
  433. package/dist/esm/sdk/models/shared/streetdataset.js.map +1 -0
  434. package/dist/esm/sdk/models/shared/streetdescriptor.d.ts +2 -2
  435. package/dist/esm/sdk/models/shared/streetdescriptor.d.ts.map +1 -1
  436. package/dist/esm/sdk/models/shared/streetdescriptor.js +1 -1
  437. package/dist/esm/sdk/models/shared/streetdescriptor.js.map +1 -1
  438. package/dist/esm/sdk/models/shared/streetfield.d.ts +16 -0
  439. package/dist/esm/sdk/models/shared/streetfield.d.ts.map +1 -0
  440. package/dist/esm/sdk/models/shared/streetfield.js +18 -0
  441. package/dist/esm/sdk/models/shared/streetfield.js.map +1 -0
  442. package/dist/esm/sdk/models/shared/streetmatch.d.ts +9 -4
  443. package/dist/esm/sdk/models/shared/streetmatch.d.ts.map +1 -1
  444. package/dist/esm/sdk/models/shared/streetmatch.js +2 -0
  445. package/dist/esm/sdk/models/shared/streetmatch.js.map +1 -1
  446. package/dist/esm/sdk/models/shared/streetnameconfidence.d.ts +17 -0
  447. package/dist/esm/sdk/models/shared/streetnameconfidence.d.ts.map +1 -0
  448. package/dist/esm/sdk/models/shared/streetnameconfidence.js +15 -0
  449. package/dist/esm/sdk/models/shared/streetnameconfidence.js.map +1 -0
  450. package/dist/esm/sdk/models/shared/streetnamekind.d.ts +16 -0
  451. package/dist/esm/sdk/models/shared/streetnamekind.d.ts.map +1 -0
  452. package/dist/esm/sdk/models/shared/streetnamekind.js +14 -0
  453. package/dist/esm/sdk/models/shared/streetnamekind.js.map +1 -0
  454. package/dist/esm/sdk/models/shared/streetproperties.d.ts +20 -0
  455. package/dist/esm/sdk/models/shared/streetproperties.d.ts.map +1 -0
  456. package/dist/esm/sdk/models/shared/streetproperties.js +14 -0
  457. package/dist/esm/sdk/models/shared/streetproperties.js.map +1 -0
  458. package/dist/esm/sdk/models/shared/streetpropertyoptions.d.ts +28 -0
  459. package/dist/esm/sdk/models/shared/streetpropertyoptions.d.ts.map +1 -0
  460. package/dist/esm/sdk/models/shared/streetpropertyoptions.js +14 -0
  461. package/dist/esm/sdk/models/shared/streetpropertyoptions.js.map +1 -0
  462. package/dist/esm/sdk/models/shared/streetprovenance.d.ts +45 -0
  463. package/dist/esm/sdk/models/shared/streetprovenance.d.ts.map +1 -0
  464. package/dist/esm/sdk/models/shared/streetprovenance.js +21 -0
  465. package/dist/esm/sdk/models/shared/streetprovenance.js.map +1 -0
  466. package/dist/esm/sdk/models/shared/streetquerybycoordinates.d.ts +6 -1
  467. package/dist/esm/sdk/models/shared/streetquerybycoordinates.d.ts.map +1 -1
  468. package/dist/esm/sdk/models/shared/streetquerybycoordinates.js +1 -0
  469. package/dist/esm/sdk/models/shared/streetquerybycoordinates.js.map +1 -1
  470. package/dist/esm/sdk/models/shared/streetquerybyname.d.ts +2 -2
  471. package/dist/esm/sdk/models/shared/streetquerybyname.js +1 -1
  472. package/dist/esm/sdk/models/shared/streetquerybyname.js.map +1 -1
  473. package/dist/esm/sdk/models/shared/streetquerybypostcode.d.ts +5 -0
  474. package/dist/esm/sdk/models/shared/streetquerybypostcode.d.ts.map +1 -1
  475. package/dist/esm/sdk/models/shared/streetquerybypostcode.js +1 -0
  476. package/dist/esm/sdk/models/shared/streetquerybypostcode.js.map +1 -1
  477. package/dist/esm/sdk/models/shared/streetqueryrequest.d.ts +20 -28
  478. package/dist/esm/sdk/models/shared/streetqueryrequest.d.ts.map +1 -1
  479. package/dist/esm/sdk/models/shared/streetqueryrequest.js +12 -10
  480. package/dist/esm/sdk/models/shared/streetqueryrequest.js.map +1 -1
  481. package/dist/esm/sdk/models/shared/streetqueryresponse.d.ts +6 -14
  482. package/dist/esm/sdk/models/shared/streetqueryresponse.d.ts.map +1 -1
  483. package/dist/esm/sdk/models/shared/streetqueryresponse.js +3 -6
  484. package/dist/esm/sdk/models/shared/streetqueryresponse.js.map +1 -1
  485. package/dist/esm/sdk/models/shared/streetrecord.d.ts +126 -0
  486. package/dist/esm/sdk/models/shared/streetrecord.d.ts.map +1 -0
  487. package/dist/esm/sdk/models/shared/streetrecord.js +49 -0
  488. package/dist/esm/sdk/models/shared/streetrecord.js.map +1 -0
  489. package/dist/esm/sdk/models/shared/streetsource.d.ts +16 -0
  490. package/dist/esm/sdk/models/shared/streetsource.d.ts.map +1 -0
  491. package/dist/esm/sdk/models/shared/streetsource.js +14 -0
  492. package/dist/esm/sdk/models/shared/streetsource.js.map +1 -0
  493. package/dist/esm/sdk/models/shared/titlealert.d.ts +30 -0
  494. package/dist/esm/sdk/models/shared/titlealert.d.ts.map +1 -0
  495. package/dist/esm/sdk/models/shared/titlealert.js +29 -0
  496. package/dist/esm/sdk/models/shared/titlealert.js.map +1 -0
  497. package/dist/esm/sdk/models/shared/titlecovenant.d.ts +7 -0
  498. package/dist/esm/sdk/models/shared/titlecovenant.d.ts.map +1 -1
  499. package/dist/esm/sdk/models/shared/titlecovenant.js +1 -0
  500. package/dist/esm/sdk/models/shared/titlecovenant.js.map +1 -1
  501. package/dist/esm/sdk/models/shared/titleextractionpayload.d.ts +19 -1
  502. package/dist/esm/sdk/models/shared/titleextractionpayload.d.ts.map +1 -1
  503. package/dist/esm/sdk/models/shared/titleextractionpayload.js +6 -0
  504. package/dist/esm/sdk/models/shared/titleextractionpayload.js.map +1 -1
  505. package/dist/esm/sdk/models/shared/titlenotice.d.ts +7 -0
  506. package/dist/esm/sdk/models/shared/titlenotice.d.ts.map +1 -1
  507. package/dist/esm/sdk/models/shared/titlenotice.js +1 -0
  508. package/dist/esm/sdk/models/shared/titlenotice.js.map +1 -1
  509. package/dist/esm/sdk/models/shared/titlepricepaid.d.ts +48 -0
  510. package/dist/esm/sdk/models/shared/titlepricepaid.d.ts.map +1 -0
  511. package/dist/esm/sdk/models/shared/titlepricepaid.js +29 -0
  512. package/dist/esm/sdk/models/shared/titlepricepaid.js.map +1 -0
  513. package/dist/esm/sdk/models/shared/titlepropertyright.d.ts +50 -0
  514. package/dist/esm/sdk/models/shared/titlepropertyright.d.ts.map +1 -0
  515. package/dist/esm/sdk/models/shared/titlepropertyright.js +31 -0
  516. package/dist/esm/sdk/models/shared/titlepropertyright.js.map +1 -0
  517. package/dist/esm/sdk/models/shared/titlerestriction.d.ts +7 -0
  518. package/dist/esm/sdk/models/shared/titlerestriction.d.ts.map +1 -1
  519. package/dist/esm/sdk/models/shared/titlerestriction.js +1 -0
  520. package/dist/esm/sdk/models/shared/titlerestriction.js.map +1 -1
  521. package/dist/esm/sdk/models/shared/titlesummarycounts.d.ts +1 -0
  522. package/dist/esm/sdk/models/shared/titlesummarycounts.d.ts.map +1 -1
  523. package/dist/esm/sdk/models/shared/titlesummarycounts.js +1 -0
  524. package/dist/esm/sdk/models/shared/titlesummarycounts.js.map +1 -1
  525. package/dist/esm/sdk/models.d.ts +38 -0
  526. package/dist/esm/sdk/models.d.ts.map +1 -0
  527. package/dist/esm/sdk/models.js +49 -0
  528. package/dist/esm/sdk/models.js.map +1 -0
  529. package/dist/esm/sdk/sdk.d.ts +3 -0
  530. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  531. package/dist/esm/sdk/sdk.js +4 -0
  532. package/dist/esm/sdk/sdk.js.map +1 -1
  533. package/dist/esm/sdk/sites.d.ts +1 -1
  534. package/dist/esm/sdk/sites.js +1 -1
  535. package/dist/esm/sdk/streets.d.ts +1 -1
  536. package/dist/esm/sdk/streets.js +1 -1
  537. package/examples/addressBulkLookupPostcodes.example.ts +1 -1
  538. package/package.json +1 -1
  539. package/src/funcs/geographyGetGeographyAncestors.ts +1 -1
  540. package/src/funcs/geographyGetGeographyAreas.ts +1 -1
  541. package/src/funcs/geographyGetGeographyDescendants.ts +1 -1
  542. package/src/funcs/geographyGetGeographyProvenance.ts +1 -1
  543. package/src/funcs/geographyGetGeographyRelease.ts +1 -1
  544. package/src/funcs/modelsGetV1AiModels.ts +154 -0
  545. package/src/funcs/modelsGetV1AiModelsModel.ts +178 -0
  546. package/src/funcs/modelsPostV1AiChatCompletions.ts +189 -0
  547. package/src/funcs/modelsPostV1AiResponses.ts +175 -0
  548. package/src/funcs/searchSearchSuggest.ts +1 -0
  549. package/src/funcs/sitesGet.ts +1 -1
  550. package/src/funcs/streetsSearchStreets.ts +1 -1
  551. package/src/lib/config.ts +3 -3
  552. package/src/sdk/geography.ts +5 -5
  553. package/src/sdk/models/errors/index.ts +1 -0
  554. package/src/sdk/models/errors/modelapierror.ts +118 -0
  555. package/src/sdk/models/operations/getepcbylocationid.ts +3 -3
  556. package/src/sdk/models/operations/getgeographychildren.ts +2 -2
  557. package/src/sdk/models/operations/getv1aimodelsmodel.ts +34 -0
  558. package/src/sdk/models/operations/index.ts +2 -0
  559. package/src/sdk/models/operations/postv1aichatcompletions.ts +28 -0
  560. package/src/sdk/models/operations/resolveaddress.ts +49 -0
  561. package/src/sdk/models/operations/searchsuggest.ts +26 -0
  562. package/src/sdk/models/shared/addressresolverequest.ts +13 -0
  563. package/src/sdk/models/shared/avmanalysisresponse.ts +1 -1
  564. package/src/sdk/models/shared/avmconfidenceinterval.ts +3 -3
  565. package/src/sdk/models/shared/avmmetadata.ts +1 -1
  566. package/src/sdk/models/shared/avmpredictbylocationrequest.ts +3 -3
  567. package/src/sdk/models/shared/avmpredictresponse.ts +1 -1
  568. package/src/sdk/models/shared/chatcompletion.ts +201 -0
  569. package/src/sdk/models/shared/chatcompletionrequest.ts +318 -0
  570. package/src/sdk/models/shared/epcqueryresponse.ts +3 -3
  571. package/src/sdk/models/shared/geographyarea.ts +2 -2
  572. package/src/sdk/models/shared/geographyrelatedarea.ts +2 -2
  573. package/src/sdk/models/shared/historicalvaluation.ts +3 -3
  574. package/src/sdk/models/shared/imagecondition.ts +28 -0
  575. package/src/sdk/models/shared/imagedocumentclass.ts +32 -0
  576. package/src/sdk/models/shared/imagequality.ts +22 -0
  577. package/src/sdk/models/shared/imagescene.ts +72 -0
  578. package/src/sdk/models/shared/imagescenelabel.ts +40 -0
  579. package/src/sdk/models/shared/index.ts +24 -3
  580. package/src/sdk/models/shared/listing.ts +301 -0
  581. package/src/sdk/models/shared/listingimage.ts +85 -0
  582. package/src/sdk/models/shared/model.ts +130 -0
  583. package/src/sdk/models/shared/modellist.ts +45 -0
  584. package/src/sdk/models/shared/modelresponse.ts +242 -0
  585. package/src/sdk/models/shared/mortgagecharge.ts +5 -0
  586. package/src/sdk/models/shared/observedfeature.ts +44 -0
  587. package/src/sdk/models/shared/othercharge.ts +9 -1
  588. package/src/sdk/models/shared/regulatoryzonecharges.ts +11 -6
  589. package/src/sdk/models/shared/responserequest.ts +220 -0
  590. package/src/sdk/models/shared/searchresponse.ts +5 -0
  591. package/src/sdk/models/shared/site.ts +1 -1
  592. package/src/sdk/models/shared/streetdataset.ts +24 -0
  593. package/src/sdk/models/shared/streetdescriptor.ts +3 -3
  594. package/src/sdk/models/shared/streetfield.ts +22 -0
  595. package/src/sdk/models/shared/streetmatch.ts +10 -4
  596. package/src/sdk/models/shared/streetnameconfidence.ts +27 -0
  597. package/src/sdk/models/shared/streetnamekind.ts +26 -0
  598. package/src/sdk/models/shared/streetproperties.ts +42 -0
  599. package/src/sdk/models/shared/streetpropertyoptions.ts +49 -0
  600. package/src/sdk/models/shared/streetprovenance.ts +73 -0
  601. package/src/sdk/models/shared/streetquerybycoordinates.ts +7 -1
  602. package/src/sdk/models/shared/streetquerybyname.ts +3 -3
  603. package/src/sdk/models/shared/streetquerybypostcode.ts +6 -0
  604. package/src/sdk/models/shared/streetqueryrequest.ts +36 -45
  605. package/src/sdk/models/shared/streetqueryresponse.ts +8 -21
  606. package/src/sdk/models/shared/streetrecord.ts +202 -0
  607. package/src/sdk/models/shared/streetsource.ts +26 -0
  608. package/src/sdk/models/shared/titlealert.ts +60 -0
  609. package/src/sdk/models/shared/titlecovenant.ts +8 -0
  610. package/src/sdk/models/shared/titleextractionpayload.ts +28 -1
  611. package/src/sdk/models/shared/titlenotice.ts +8 -0
  612. package/src/sdk/models/shared/titlepricepaid.ts +78 -0
  613. package/src/sdk/models/shared/titlepropertyright.ts +81 -0
  614. package/src/sdk/models/shared/titlerestriction.ts +8 -0
  615. package/src/sdk/models/shared/titlesummarycounts.ts +2 -0
  616. package/src/sdk/models.ts +87 -0
  617. package/src/sdk/sdk.ts +6 -0
  618. package/src/sdk/sites.ts +1 -1
  619. package/src/sdk/streets.ts +1 -1
  620. package/dist/commonjs/sdk/models/shared/propertyonstreet.d.ts +0 -29
  621. package/dist/commonjs/sdk/models/shared/propertyonstreet.d.ts.map +0 -1
  622. package/dist/commonjs/sdk/models/shared/propertyonstreet.js.map +0 -1
  623. package/dist/commonjs/sdk/models/shared/streetdetails.d.ts +0 -34
  624. package/dist/commonjs/sdk/models/shared/streetdetails.d.ts.map +0 -1
  625. package/dist/commonjs/sdk/models/shared/streetdetails.js.map +0 -1
  626. package/dist/commonjs/sdk/models/shared/streetstatistics.d.ts +0 -19
  627. package/dist/commonjs/sdk/models/shared/streetstatistics.d.ts.map +0 -1
  628. package/dist/commonjs/sdk/models/shared/streetstatistics.js.map +0 -1
  629. package/dist/esm/sdk/models/shared/propertyonstreet.d.ts +0 -29
  630. package/dist/esm/sdk/models/shared/propertyonstreet.d.ts.map +0 -1
  631. package/dist/esm/sdk/models/shared/propertyonstreet.js +0 -17
  632. package/dist/esm/sdk/models/shared/propertyonstreet.js.map +0 -1
  633. package/dist/esm/sdk/models/shared/streetdetails.d.ts +0 -34
  634. package/dist/esm/sdk/models/shared/streetdetails.d.ts.map +0 -1
  635. package/dist/esm/sdk/models/shared/streetdetails.js +0 -19
  636. package/dist/esm/sdk/models/shared/streetdetails.js.map +0 -1
  637. package/dist/esm/sdk/models/shared/streetstatistics.d.ts +0 -19
  638. package/dist/esm/sdk/models/shared/streetstatistics.d.ts.map +0 -1
  639. package/dist/esm/sdk/models/shared/streetstatistics.js +0 -14
  640. package/dist/esm/sdk/models/shared/streetstatistics.js.map +0 -1
  641. package/src/sdk/models/shared/propertyonstreet.ts +0 -54
  642. package/src/sdk/models/shared/streetdetails.ts +0 -63
  643. package/src/sdk/models/shared/streetstatistics.ts +0 -39
@@ -102,6 +102,8 @@ export * from "./changelogentry.js";
102
102
  export * from "./changeloglistresponse.js";
103
103
  export * from "./chargeentry.js";
104
104
  export * from "./chargehistory.js";
105
+ export * from "./chatcompletion.js";
106
+ export * from "./chatcompletionrequest.js";
105
107
  export * from "./companiesbylocationresponse.js";
106
108
  export * from "./company.js";
107
109
  export * from "./companylistresponse.js";
@@ -212,6 +214,11 @@ export * from "./heritagezone.js";
212
214
  export * from "./histogramaggregationresult.js";
213
215
  export * from "./histogrambucket.js";
214
216
  export * from "./historicalvaluation.js";
217
+ export * from "./imagecondition.js";
218
+ export * from "./imagedocumentclass.js";
219
+ export * from "./imagequality.js";
220
+ export * from "./imagescene.js";
221
+ export * from "./imagescenelabel.js";
215
222
  export * from "./insuranceavailability.js";
216
223
  export * from "./insuranceimpact.js";
217
224
  export * from "./insurancepremiumimpact.js";
@@ -239,6 +246,9 @@ export * from "./matchedsubstring.js";
239
246
  export * from "./metricdefinition.js";
240
247
  export * from "./metricscomparerequest.js";
241
248
  export * from "./mitigationmeasure.js";
249
+ export * from "./model.js";
250
+ export * from "./modellist.js";
251
+ export * from "./modelresponse.js";
242
252
  export * from "./moneystate.js";
243
253
  export * from "./monthlycategorystats.js";
244
254
  export * from "./monthlycategorystatslistresponse.js";
@@ -246,6 +256,7 @@ export * from "./mortgagecharge.js";
246
256
  export * from "./nearestpostcodesresponse.js";
247
257
  export * from "./nestedaggregation.js";
248
258
  export * from "./nestedaggregationresult.js";
259
+ export * from "./observedfeature.js";
249
260
  export * from "./officer.js";
250
261
  export * from "./officerlistresponse.js";
251
262
  export * from "./officerresponse.js";
@@ -316,7 +327,6 @@ export * from "./propertylistresponse.js";
316
327
  export * from "./propertylocationidareafilter.js";
317
328
  export * from "./propertymonitoringreceipt.js";
318
329
  export * from "./propertymultipolygonareafilter.js";
319
- export * from "./propertyonstreet.js";
320
330
  export * from "./propertyoutcodeareafilter.js";
321
331
  export * from "./propertypointareafilter.js";
322
332
  export * from "./propertypolygonareafilter.js";
@@ -346,6 +356,7 @@ export * from "./regulatorydomain.js";
346
356
  export * from "./regulatoryzone.js";
347
357
  export * from "./regulatoryzonechargerate.js";
348
358
  export * from "./regulatoryzonecharges.js";
359
+ export * from "./responserequest.js";
349
360
  export * from "./reversegeocoderesponse.js";
350
361
  export * from "./roomdetails.js";
351
362
  export * from "./royalmailaddress.js";
@@ -398,9 +409,15 @@ export * from "./sitequeryrequest.js";
398
409
  export * from "./sitetags.js";
399
410
  export * from "./socialmedialinks.js";
400
411
  export * from "./statsaggregationresult.js";
412
+ export * from "./streetdataset.js";
401
413
  export * from "./streetdescriptor.js";
402
- export * from "./streetdetails.js";
414
+ export * from "./streetfield.js";
403
415
  export * from "./streetmatch.js";
416
+ export * from "./streetnameconfidence.js";
417
+ export * from "./streetnamekind.js";
418
+ export * from "./streetproperties.js";
419
+ export * from "./streetpropertyoptions.js";
420
+ export * from "./streetprovenance.js";
404
421
  export * from "./streetquerybycoordinates.js";
405
422
  export * from "./streetquerybyname.js";
406
423
  export * from "./streetquerybypostcode.js";
@@ -408,12 +425,14 @@ export * from "./streetquerybyuprn.js";
408
425
  export * from "./streetquerybyusrn.js";
409
426
  export * from "./streetqueryrequest.js";
410
427
  export * from "./streetqueryresponse.js";
411
- export * from "./streetstatistics.js";
428
+ export * from "./streetrecord.js";
429
+ export * from "./streetsource.js";
412
430
  export * from "./tenancydata.js";
413
431
  export * from "./tenuredata.js";
414
432
  export * from "./termsaggregationresult.js";
415
433
  export * from "./termsbucket.js";
416
434
  export * from "./tierskipreason.js";
435
+ export * from "./titlealert.js";
417
436
  export * from "./titlecovenant.js";
418
437
  export * from "./titledeedapplication.js";
419
438
  export * from "./titledeedapplicationlistresponse.js";
@@ -425,6 +444,8 @@ export * from "./titledocumentsummary.js";
425
444
  export * from "./titleextractionpayload.js";
426
445
  export * from "./titleextractionpollresponse.js";
427
446
  export * from "./titlenotice.js";
447
+ export * from "./titlepricepaid.js";
448
+ export * from "./titlepropertyright.js";
428
449
  export * from "./titleproprietor.js";
429
450
  export * from "./titlerestriction.js";
430
451
  export * from "./titleschedulenoticeoflease.js";
@@ -12,11 +12,19 @@ import * as openEnums from "../../types/enums.js";
12
12
  import { OpenEnum } from "../../types/enums.js";
13
13
  import { Result as SafeParseResult } from "../../types/fp.js";
14
14
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
15
+ import {
16
+ ImageCondition,
17
+ ImageCondition$inboundSchema,
18
+ } from "./imagecondition.js";
15
19
  import { ListingImage, ListingImage$inboundSchema } from "./listingimage.js";
16
20
  import {
17
21
  ListingPriceChange,
18
22
  ListingPriceChange$inboundSchema,
19
23
  } from "./listingpricechange.js";
24
+ import {
25
+ ObservedFeature,
26
+ ObservedFeature$inboundSchema,
27
+ } from "./observedfeature.js";
20
28
 
21
29
  /**
22
30
  * Features the listing advertises.
@@ -46,6 +54,110 @@ export type ListingFeatures = {
46
54
  additionalProperties?: { [k: string]: any } | undefined;
47
55
  };
48
56
 
57
+ /**
58
+ * The state of repair across the photographs as a whole. Null when too few photographs carry an assessment to summarise one.
59
+ */
60
+ export type ListingCondition = {
61
+ /**
62
+ * Confidence in that assessment, from 0 to 1.
63
+ */
64
+ confidence?: number | undefined;
65
+ /**
66
+ * The state of repair the photographs suggest.
67
+ */
68
+ value?: ImageCondition | undefined;
69
+ };
70
+
71
+ /**
72
+ * How the photographs present the property, keyed by quality key. `virtually_staged` is worth reading before treating condition as evidence, because digitally added furniture changes how a room reads.
73
+ */
74
+ export type Presentation = {
75
+ emptyRoom?: ObservedFeature | undefined;
76
+ furnished?: ObservedFeature | undefined;
77
+ virtuallyStaged?: ObservedFeature | undefined;
78
+ watermarkPresent?: ObservedFeature | undefined;
79
+ };
80
+
81
+ /**
82
+ * Spaces the photographs show, keyed by scene key, each with the evidence behind it. A key is absent when no photograph supports it, which is not the same as the property lacking that space.
83
+ */
84
+ export type Spaces = {
85
+ communal?: ObservedFeature | undefined;
86
+ communalCorridor?: ObservedFeature | undefined;
87
+ communalGarden?: ObservedFeature | undefined;
88
+ communalLobby?: ObservedFeature | undefined;
89
+ exterior?: ObservedFeature | undefined;
90
+ exteriorAerial?: ObservedFeature | undefined;
91
+ exteriorFrontElevation?: ObservedFeature | undefined;
92
+ exteriorRearElevation?: ObservedFeature | undefined;
93
+ exteriorStreet?: ObservedFeature | undefined;
94
+ interior?: ObservedFeature | undefined;
95
+ interiorAttic?: ObservedFeature | undefined;
96
+ interiorBasement?: ObservedFeature | undefined;
97
+ interiorBathroom?: ObservedFeature | undefined;
98
+ interiorBathroomCloakroom?: ObservedFeature | undefined;
99
+ interiorBathroomEnsuite?: ObservedFeature | undefined;
100
+ interiorBathroomShowerRoom?: ObservedFeature | undefined;
101
+ interiorBedroom?: ObservedFeature | undefined;
102
+ interiorConservatory?: ObservedFeature | undefined;
103
+ interiorDiningRoom?: ObservedFeature | undefined;
104
+ interiorDressingRoom?: ObservedFeature | undefined;
105
+ interiorGamesRoom?: ObservedFeature | undefined;
106
+ interiorGarageInterior?: ObservedFeature | undefined;
107
+ interiorGym?: ObservedFeature | undefined;
108
+ interiorHallway?: ObservedFeature | undefined;
109
+ interiorKitchen?: ObservedFeature | undefined;
110
+ interiorKitchenDiner?: ObservedFeature | undefined;
111
+ interiorKitchenLiving?: ObservedFeature | undefined;
112
+ interiorLanding?: ObservedFeature | undefined;
113
+ interiorLibrary?: ObservedFeature | undefined;
114
+ interiorLivingRoom?: ObservedFeature | undefined;
115
+ interiorPoolRoom?: ObservedFeature | undefined;
116
+ interiorPorch?: ObservedFeature | undefined;
117
+ interiorSauna?: ObservedFeature | undefined;
118
+ interiorStairs?: ObservedFeature | undefined;
119
+ interiorStorage?: ObservedFeature | undefined;
120
+ interiorStudy?: ObservedFeature | undefined;
121
+ interiorUtilityRoom?: ObservedFeature | undefined;
122
+ interiorWineCellar?: ObservedFeature | undefined;
123
+ interiorWorkshop?: ObservedFeature | undefined;
124
+ nonProperty?: ObservedFeature | undefined;
125
+ outdoorSpace?: ObservedFeature | undefined;
126
+ outdoorSpaceBalcony?: ObservedFeature | undefined;
127
+ outdoorSpaceDriveway?: ObservedFeature | undefined;
128
+ outdoorSpaceGarden?: ObservedFeature | undefined;
129
+ outdoorSpaceOutbuilding?: ObservedFeature | undefined;
130
+ outdoorSpacePatio?: ObservedFeature | undefined;
131
+ outdoorSpacePool?: ObservedFeature | undefined;
132
+ outdoorSpaceTerrace?: ObservedFeature | undefined;
133
+ };
134
+
135
+ /**
136
+ * What the listing's photographs show, as distinct from what its text advertises. Null until the gallery has been analysed.
137
+ */
138
+ export type ObservedFeatures = {
139
+ /**
140
+ * The state of repair across the photographs as a whole. Null when too few photographs carry an assessment to summarise one.
141
+ */
142
+ condition?: ListingCondition | null | undefined;
143
+ /**
144
+ * How many of the listing's images these values were drawn from.
145
+ */
146
+ imagesAnalysed?: number | undefined;
147
+ /**
148
+ * How the photographs present the property, keyed by quality key. `virtually_staged` is worth reading before treating condition as evidence, because digitally added furniture changes how a room reads.
149
+ */
150
+ presentation?: Presentation | undefined;
151
+ /**
152
+ * Spaces the photographs show, keyed by scene key, each with the evidence behind it. A key is absent when no photograph supports it, which is not the same as the property lacking that space.
153
+ */
154
+ spaces?: Spaces | undefined;
155
+ /**
156
+ * Release of the label vocabulary these values were produced against.
157
+ */
158
+ taxonomyVersion?: string | undefined;
159
+ };
160
+
49
161
  /**
50
162
  * What the listing asks for the property.
51
163
  */
@@ -142,6 +254,10 @@ export type Listing = {
142
254
  * Identifier of this listing.
143
255
  */
144
256
  listingId?: string | undefined;
257
+ /**
258
+ * What the listing's photographs show, as distinct from what its text advertises. Null until the gallery has been analysed.
259
+ */
260
+ observedFeatures?: ObservedFeatures | null | undefined;
145
261
  /**
146
262
  * Every price this listing has been advertised at, starting with the first.
147
263
  */
@@ -219,6 +335,189 @@ export function listingFeaturesFromJSON(
219
335
  );
220
336
  }
221
337
 
338
+ /** @internal */
339
+ export const ListingCondition$inboundSchema: z.ZodType<
340
+ ListingCondition,
341
+ z.ZodTypeDef,
342
+ unknown
343
+ > = z.object({
344
+ confidence: z.number().optional(),
345
+ value: ImageCondition$inboundSchema.optional(),
346
+ });
347
+
348
+ export function listingConditionFromJSON(
349
+ jsonString: string,
350
+ ): SafeParseResult<ListingCondition, SDKValidationError> {
351
+ return safeParse(
352
+ jsonString,
353
+ (x) => ListingCondition$inboundSchema.parse(JSON.parse(x)),
354
+ `Failed to parse 'ListingCondition' from JSON`,
355
+ );
356
+ }
357
+
358
+ /** @internal */
359
+ export const Presentation$inboundSchema: z.ZodType<
360
+ Presentation,
361
+ z.ZodTypeDef,
362
+ unknown
363
+ > = z.object({
364
+ empty_room: ObservedFeature$inboundSchema.optional(),
365
+ furnished: ObservedFeature$inboundSchema.optional(),
366
+ virtually_staged: ObservedFeature$inboundSchema.optional(),
367
+ watermark_present: ObservedFeature$inboundSchema.optional(),
368
+ }).transform((v) => {
369
+ return remap$(v, {
370
+ "empty_room": "emptyRoom",
371
+ "virtually_staged": "virtuallyStaged",
372
+ "watermark_present": "watermarkPresent",
373
+ });
374
+ });
375
+
376
+ export function presentationFromJSON(
377
+ jsonString: string,
378
+ ): SafeParseResult<Presentation, SDKValidationError> {
379
+ return safeParse(
380
+ jsonString,
381
+ (x) => Presentation$inboundSchema.parse(JSON.parse(x)),
382
+ `Failed to parse 'Presentation' from JSON`,
383
+ );
384
+ }
385
+
386
+ /** @internal */
387
+ export const Spaces$inboundSchema: z.ZodType<Spaces, z.ZodTypeDef, unknown> = z
388
+ .object({
389
+ communal: ObservedFeature$inboundSchema.optional(),
390
+ "communal.corridor": ObservedFeature$inboundSchema.optional(),
391
+ "communal.garden": ObservedFeature$inboundSchema.optional(),
392
+ "communal.lobby": ObservedFeature$inboundSchema.optional(),
393
+ exterior: ObservedFeature$inboundSchema.optional(),
394
+ "exterior.aerial": ObservedFeature$inboundSchema.optional(),
395
+ "exterior.front_elevation": ObservedFeature$inboundSchema.optional(),
396
+ "exterior.rear_elevation": ObservedFeature$inboundSchema.optional(),
397
+ "exterior.street": ObservedFeature$inboundSchema.optional(),
398
+ interior: ObservedFeature$inboundSchema.optional(),
399
+ "interior.attic": ObservedFeature$inboundSchema.optional(),
400
+ "interior.basement": ObservedFeature$inboundSchema.optional(),
401
+ "interior.bathroom": ObservedFeature$inboundSchema.optional(),
402
+ "interior.bathroom.cloakroom": ObservedFeature$inboundSchema.optional(),
403
+ "interior.bathroom.ensuite": ObservedFeature$inboundSchema.optional(),
404
+ "interior.bathroom.shower_room": ObservedFeature$inboundSchema.optional(),
405
+ "interior.bedroom": ObservedFeature$inboundSchema.optional(),
406
+ "interior.conservatory": ObservedFeature$inboundSchema.optional(),
407
+ "interior.dining_room": ObservedFeature$inboundSchema.optional(),
408
+ "interior.dressing_room": ObservedFeature$inboundSchema.optional(),
409
+ "interior.games_room": ObservedFeature$inboundSchema.optional(),
410
+ "interior.garage_interior": ObservedFeature$inboundSchema.optional(),
411
+ "interior.gym": ObservedFeature$inboundSchema.optional(),
412
+ "interior.hallway": ObservedFeature$inboundSchema.optional(),
413
+ "interior.kitchen": ObservedFeature$inboundSchema.optional(),
414
+ "interior.kitchen_diner": ObservedFeature$inboundSchema.optional(),
415
+ "interior.kitchen_living": ObservedFeature$inboundSchema.optional(),
416
+ "interior.landing": ObservedFeature$inboundSchema.optional(),
417
+ "interior.library": ObservedFeature$inboundSchema.optional(),
418
+ "interior.living_room": ObservedFeature$inboundSchema.optional(),
419
+ "interior.pool_room": ObservedFeature$inboundSchema.optional(),
420
+ "interior.porch": ObservedFeature$inboundSchema.optional(),
421
+ "interior.sauna": ObservedFeature$inboundSchema.optional(),
422
+ "interior.stairs": ObservedFeature$inboundSchema.optional(),
423
+ "interior.storage": ObservedFeature$inboundSchema.optional(),
424
+ "interior.study": ObservedFeature$inboundSchema.optional(),
425
+ "interior.utility_room": ObservedFeature$inboundSchema.optional(),
426
+ "interior.wine_cellar": ObservedFeature$inboundSchema.optional(),
427
+ "interior.workshop": ObservedFeature$inboundSchema.optional(),
428
+ non_property: ObservedFeature$inboundSchema.optional(),
429
+ outdoor_space: ObservedFeature$inboundSchema.optional(),
430
+ "outdoor_space.balcony": ObservedFeature$inboundSchema.optional(),
431
+ "outdoor_space.driveway": ObservedFeature$inboundSchema.optional(),
432
+ "outdoor_space.garden": ObservedFeature$inboundSchema.optional(),
433
+ "outdoor_space.outbuilding": ObservedFeature$inboundSchema.optional(),
434
+ "outdoor_space.patio": ObservedFeature$inboundSchema.optional(),
435
+ "outdoor_space.pool": ObservedFeature$inboundSchema.optional(),
436
+ "outdoor_space.terrace": ObservedFeature$inboundSchema.optional(),
437
+ }).transform((v) => {
438
+ return remap$(v, {
439
+ "communal.corridor": "communalCorridor",
440
+ "communal.garden": "communalGarden",
441
+ "communal.lobby": "communalLobby",
442
+ "exterior.aerial": "exteriorAerial",
443
+ "exterior.front_elevation": "exteriorFrontElevation",
444
+ "exterior.rear_elevation": "exteriorRearElevation",
445
+ "exterior.street": "exteriorStreet",
446
+ "interior.attic": "interiorAttic",
447
+ "interior.basement": "interiorBasement",
448
+ "interior.bathroom": "interiorBathroom",
449
+ "interior.bathroom.cloakroom": "interiorBathroomCloakroom",
450
+ "interior.bathroom.ensuite": "interiorBathroomEnsuite",
451
+ "interior.bathroom.shower_room": "interiorBathroomShowerRoom",
452
+ "interior.bedroom": "interiorBedroom",
453
+ "interior.conservatory": "interiorConservatory",
454
+ "interior.dining_room": "interiorDiningRoom",
455
+ "interior.dressing_room": "interiorDressingRoom",
456
+ "interior.games_room": "interiorGamesRoom",
457
+ "interior.garage_interior": "interiorGarageInterior",
458
+ "interior.gym": "interiorGym",
459
+ "interior.hallway": "interiorHallway",
460
+ "interior.kitchen": "interiorKitchen",
461
+ "interior.kitchen_diner": "interiorKitchenDiner",
462
+ "interior.kitchen_living": "interiorKitchenLiving",
463
+ "interior.landing": "interiorLanding",
464
+ "interior.library": "interiorLibrary",
465
+ "interior.living_room": "interiorLivingRoom",
466
+ "interior.pool_room": "interiorPoolRoom",
467
+ "interior.porch": "interiorPorch",
468
+ "interior.sauna": "interiorSauna",
469
+ "interior.stairs": "interiorStairs",
470
+ "interior.storage": "interiorStorage",
471
+ "interior.study": "interiorStudy",
472
+ "interior.utility_room": "interiorUtilityRoom",
473
+ "interior.wine_cellar": "interiorWineCellar",
474
+ "interior.workshop": "interiorWorkshop",
475
+ "non_property": "nonProperty",
476
+ "outdoor_space": "outdoorSpace",
477
+ "outdoor_space.balcony": "outdoorSpaceBalcony",
478
+ "outdoor_space.driveway": "outdoorSpaceDriveway",
479
+ "outdoor_space.garden": "outdoorSpaceGarden",
480
+ "outdoor_space.outbuilding": "outdoorSpaceOutbuilding",
481
+ "outdoor_space.patio": "outdoorSpacePatio",
482
+ "outdoor_space.pool": "outdoorSpacePool",
483
+ "outdoor_space.terrace": "outdoorSpaceTerrace",
484
+ });
485
+ });
486
+
487
+ export function spacesFromJSON(
488
+ jsonString: string,
489
+ ): SafeParseResult<Spaces, SDKValidationError> {
490
+ return safeParse(
491
+ jsonString,
492
+ (x) => Spaces$inboundSchema.parse(JSON.parse(x)),
493
+ `Failed to parse 'Spaces' from JSON`,
494
+ );
495
+ }
496
+
497
+ /** @internal */
498
+ export const ObservedFeatures$inboundSchema: z.ZodType<
499
+ ObservedFeatures,
500
+ z.ZodTypeDef,
501
+ unknown
502
+ > = z.object({
503
+ condition: z.nullable(z.lazy(() => ListingCondition$inboundSchema))
504
+ .optional(),
505
+ imagesAnalysed: z.number().int().optional(),
506
+ presentation: z.lazy(() => Presentation$inboundSchema).optional(),
507
+ spaces: z.lazy(() => Spaces$inboundSchema).optional(),
508
+ taxonomyVersion: z.string().optional(),
509
+ });
510
+
511
+ export function observedFeaturesFromJSON(
512
+ jsonString: string,
513
+ ): SafeParseResult<ObservedFeatures, SDKValidationError> {
514
+ return safeParse(
515
+ jsonString,
516
+ (x) => ObservedFeatures$inboundSchema.parse(JSON.parse(x)),
517
+ `Failed to parse 'ObservedFeatures' from JSON`,
518
+ );
519
+ }
520
+
222
521
  /** @internal */
223
522
  export const Pricing$inboundSchema: z.ZodType<Pricing, z.ZodTypeDef, unknown> =
224
523
  z.object({
@@ -297,6 +596,8 @@ export const Listing$inboundSchema: z.ZodType<Listing, z.ZodTypeDef, unknown> =
297
596
  floorPlanImages: z.array(ListingImage$inboundSchema).optional(),
298
597
  images: z.array(ListingImage$inboundSchema).optional(),
299
598
  listingId: z.string().optional(),
599
+ observedFeatures: z.nullable(z.lazy(() => ObservedFeatures$inboundSchema))
600
+ .optional(),
300
601
  priceChange: z.array(ListingPriceChange$inboundSchema).optional(),
301
602
  pricing: z.lazy(() => Pricing$inboundSchema).optional(),
302
603
  publishedDate: z.nullable(
@@ -4,10 +4,66 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import { safeParse } from "../../../lib/schemas.js";
7
+ import * as openEnums from "../../types/enums.js";
8
+ import { OpenEnum } from "../../types/enums.js";
7
9
  import { Result as SafeParseResult } from "../../types/fp.js";
8
10
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+ import {
12
+ ImageDocumentClass,
13
+ ImageDocumentClass$inboundSchema,
14
+ } from "./imagedocumentclass.js";
15
+ import { ImageQuality, ImageQuality$inboundSchema } from "./imagequality.js";
16
+ import {
17
+ ImageSceneLabel,
18
+ ImageSceneLabel$inboundSchema,
19
+ } from "./imagescenelabel.js";
20
+
21
+ /**
22
+ * The state of repair the photograph suggests. Null when no assessment is published for this image.
23
+ */
24
+ export const ListingImageCondition = {
25
+ MoveInReady: "move_in_ready",
26
+ CosmeticallyDated: "cosmetically_dated",
27
+ RenovationNeeded: "renovation_needed",
28
+ Derelict: "derelict",
29
+ } as const;
30
+ /**
31
+ * The state of repair the photograph suggests. Null when no assessment is published for this image.
32
+ */
33
+ export type ListingImageCondition = OpenEnum<typeof ListingImageCondition>;
34
+
35
+ /**
36
+ * What this image is and what it shows. Null until the image has been analysed.
37
+ */
38
+ export type Labels = {
39
+ condition?: ListingImageCondition | null | undefined;
40
+ /**
41
+ * What the image is, rather than what it shows. A `photo` is a photograph of the property or its surroundings; the other values are documents published alongside the photographs.
42
+ */
43
+ documentClass?: ImageDocumentClass | undefined;
44
+ /**
45
+ * How strongly the image supports its document class, from 0 to 1.
46
+ */
47
+ documentClassConfidence?: number | undefined;
48
+ /**
49
+ * How the photograph presents the property rather than what it shows. `virtually_staged` marks furniture added digitally, and `empty_room` marks an unfurnished space.
50
+ */
51
+ presentation?: Array<ImageQuality> | undefined;
52
+ /**
53
+ * The spaces the photograph shows, most specific first, each with its own confidence. Keys are hierarchical, so `interior.bathroom.ensuite` also implies `interior.bathroom` and `interior`. Empty for anything that is not a photograph.
54
+ */
55
+ scene?: Array<ImageSceneLabel> | undefined;
56
+ /**
57
+ * Release of the label vocabulary these values were produced against.
58
+ */
59
+ taxonomyVersion?: string | undefined;
60
+ };
9
61
 
10
62
  export type ListingImage = {
63
+ /**
64
+ * What this image is and what it shows. Null until the image has been analysed.
65
+ */
66
+ labels?: Labels | null | undefined;
11
67
  /**
12
68
  * URL of a ready-made 640×480 WebP thumbnail of the same image.
13
69
  */
@@ -18,12 +74,41 @@ export type ListingImage = {
18
74
  url?: string | null | undefined;
19
75
  };
20
76
 
77
+ /** @internal */
78
+ export const ListingImageCondition$inboundSchema: z.ZodType<
79
+ ListingImageCondition,
80
+ z.ZodTypeDef,
81
+ unknown
82
+ > = openEnums.inboundSchema(ListingImageCondition);
83
+
84
+ /** @internal */
85
+ export const Labels$inboundSchema: z.ZodType<Labels, z.ZodTypeDef, unknown> = z
86
+ .object({
87
+ condition: z.nullable(ListingImageCondition$inboundSchema).optional(),
88
+ documentClass: ImageDocumentClass$inboundSchema.optional(),
89
+ documentClassConfidence: z.number().optional(),
90
+ presentation: z.array(ImageQuality$inboundSchema).optional(),
91
+ scene: z.array(ImageSceneLabel$inboundSchema).optional(),
92
+ taxonomyVersion: z.string().optional(),
93
+ });
94
+
95
+ export function labelsFromJSON(
96
+ jsonString: string,
97
+ ): SafeParseResult<Labels, SDKValidationError> {
98
+ return safeParse(
99
+ jsonString,
100
+ (x) => Labels$inboundSchema.parse(JSON.parse(x)),
101
+ `Failed to parse 'Labels' from JSON`,
102
+ );
103
+ }
104
+
21
105
  /** @internal */
22
106
  export const ListingImage$inboundSchema: z.ZodType<
23
107
  ListingImage,
24
108
  z.ZodTypeDef,
25
109
  unknown
26
110
  > = z.object({
111
+ labels: z.nullable(z.lazy(() => Labels$inboundSchema)).optional(),
27
112
  thumbnailUrl: z.nullable(z.string()).optional(),
28
113
  url: z.nullable(z.string()).optional(),
29
114
  });
@@ -0,0 +1,130 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../../lib/primitives.js";
7
+ import { safeParse } from "../../../lib/schemas.js";
8
+ import { ClosedEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ export const ModelObject = {
13
+ Model: "model",
14
+ } as const;
15
+ export type ModelObject = ClosedEnum<typeof ModelObject>;
16
+
17
+ export const OwnedBy = {
18
+ Vepler: "vepler",
19
+ } as const;
20
+ export type OwnedBy = ClosedEnum<typeof OwnedBy>;
21
+
22
+ /**
23
+ * Kind of input the model takes in the user message.
24
+ */
25
+ export const InputType = {
26
+ Image: "image",
27
+ } as const;
28
+ /**
29
+ * Kind of input the model takes in the user message.
30
+ */
31
+ export type InputType = ClosedEnum<typeof InputType>;
32
+
33
+ export type Vepler = {
34
+ /**
35
+ * What the model reads and returns.
36
+ */
37
+ description: string;
38
+ /**
39
+ * Kind of input the model takes in the user message.
40
+ */
41
+ inputType: InputType;
42
+ /**
43
+ * JSON Schema of the result. A `json_schema` response format may carry it unchanged as `schema`.
44
+ */
45
+ outputSchema: { [k: string]: any };
46
+ /**
47
+ * Name to send as `response_format.json_schema.name`.
48
+ */
49
+ outputSchemaName: string;
50
+ /**
51
+ * Version currently served, as reported in `system_fingerprint`.
52
+ */
53
+ version: string;
54
+ };
55
+
56
+ export type Model = {
57
+ /**
58
+ * Unix time in seconds when the served version was published.
59
+ */
60
+ created: number;
61
+ /**
62
+ * Id to pass as `model`.
63
+ */
64
+ id: string;
65
+ object: ModelObject;
66
+ ownedBy: OwnedBy;
67
+ vepler: Vepler;
68
+ };
69
+
70
+ /** @internal */
71
+ export const ModelObject$inboundSchema: z.ZodNativeEnum<typeof ModelObject> = z
72
+ .nativeEnum(ModelObject);
73
+
74
+ /** @internal */
75
+ export const OwnedBy$inboundSchema: z.ZodNativeEnum<typeof OwnedBy> = z
76
+ .nativeEnum(OwnedBy);
77
+
78
+ /** @internal */
79
+ export const InputType$inboundSchema: z.ZodNativeEnum<typeof InputType> = z
80
+ .nativeEnum(InputType);
81
+
82
+ /** @internal */
83
+ export const Vepler$inboundSchema: z.ZodType<Vepler, z.ZodTypeDef, unknown> = z
84
+ .object({
85
+ description: z.string(),
86
+ input_type: InputType$inboundSchema,
87
+ output_schema: z.record(z.any()),
88
+ output_schema_name: z.string(),
89
+ version: z.string(),
90
+ }).transform((v) => {
91
+ return remap$(v, {
92
+ "input_type": "inputType",
93
+ "output_schema": "outputSchema",
94
+ "output_schema_name": "outputSchemaName",
95
+ });
96
+ });
97
+
98
+ export function veplerFromJSON(
99
+ jsonString: string,
100
+ ): SafeParseResult<Vepler, SDKValidationError> {
101
+ return safeParse(
102
+ jsonString,
103
+ (x) => Vepler$inboundSchema.parse(JSON.parse(x)),
104
+ `Failed to parse 'Vepler' from JSON`,
105
+ );
106
+ }
107
+
108
+ /** @internal */
109
+ export const Model$inboundSchema: z.ZodType<Model, z.ZodTypeDef, unknown> = z
110
+ .object({
111
+ created: z.number().int(),
112
+ id: z.string(),
113
+ object: ModelObject$inboundSchema,
114
+ owned_by: OwnedBy$inboundSchema,
115
+ vepler: z.lazy(() => Vepler$inboundSchema),
116
+ }).transform((v) => {
117
+ return remap$(v, {
118
+ "owned_by": "ownedBy",
119
+ });
120
+ });
121
+
122
+ export function modelFromJSON(
123
+ jsonString: string,
124
+ ): SafeParseResult<Model, SDKValidationError> {
125
+ return safeParse(
126
+ jsonString,
127
+ (x) => Model$inboundSchema.parse(JSON.parse(x)),
128
+ `Failed to parse 'Model' from JSON`,
129
+ );
130
+ }