@vepler/sdk 6.8.0 → 6.42.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (508) 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/{shared/propertyonstreet.js → operations/postv1aichatcompletions.js} +7 -12
  62. package/dist/commonjs/sdk/models/operations/postv1aichatcompletions.js.map +1 -0
  63. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts +4 -0
  64. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  65. package/dist/commonjs/sdk/models/operations/resolveaddress.js +1 -0
  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 +3 -0
  72. package/dist/commonjs/sdk/models/shared/addressresolverequest.d.ts.map +1 -1
  73. package/dist/commonjs/sdk/models/shared/addressresolverequest.js +2 -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/index.d.ts +16 -3
  95. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  96. package/dist/commonjs/sdk/models/shared/index.js +16 -3
  97. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  98. package/dist/commonjs/sdk/models/shared/model.d.ts +72 -0
  99. package/dist/commonjs/sdk/models/shared/model.d.ts.map +1 -0
  100. package/dist/commonjs/sdk/models/shared/model.js +100 -0
  101. package/dist/commonjs/sdk/models/shared/model.js.map +1 -0
  102. package/dist/commonjs/sdk/models/shared/modellist.d.ts +19 -0
  103. package/dist/commonjs/sdk/models/shared/modellist.d.ts.map +1 -0
  104. package/dist/commonjs/sdk/models/shared/{streetdetails.js → modellist.js} +14 -13
  105. package/dist/commonjs/sdk/models/shared/modellist.js.map +1 -0
  106. package/dist/commonjs/sdk/models/shared/modelresponse.d.ts +116 -0
  107. package/dist/commonjs/sdk/models/shared/modelresponse.d.ts.map +1 -0
  108. package/dist/commonjs/sdk/models/shared/modelresponse.js +137 -0
  109. package/dist/commonjs/sdk/models/shared/modelresponse.js.map +1 -0
  110. package/dist/commonjs/sdk/models/shared/regulatoryzonecharges.d.ts +4 -4
  111. package/dist/commonjs/sdk/models/shared/regulatoryzonecharges.d.ts.map +1 -1
  112. package/dist/commonjs/sdk/models/shared/regulatoryzonecharges.js +4 -4
  113. package/dist/commonjs/sdk/models/shared/regulatoryzonecharges.js.map +1 -1
  114. package/dist/commonjs/sdk/models/shared/responserequest.d.ts +148 -0
  115. package/dist/commonjs/sdk/models/shared/responserequest.d.ts.map +1 -0
  116. package/dist/commonjs/sdk/models/shared/responserequest.js +111 -0
  117. package/dist/commonjs/sdk/models/shared/responserequest.js.map +1 -0
  118. package/dist/commonjs/sdk/models/shared/searchresponse.d.ts +4 -0
  119. package/dist/commonjs/sdk/models/shared/searchresponse.d.ts.map +1 -1
  120. package/dist/commonjs/sdk/models/shared/searchresponse.js +1 -0
  121. package/dist/commonjs/sdk/models/shared/searchresponse.js.map +1 -1
  122. package/dist/commonjs/sdk/models/shared/site.d.ts +1 -1
  123. package/dist/commonjs/sdk/models/shared/streetdataset.d.ts +17 -0
  124. package/dist/commonjs/sdk/models/shared/streetdataset.d.ts.map +1 -0
  125. package/dist/commonjs/sdk/models/shared/streetdataset.js +51 -0
  126. package/dist/commonjs/sdk/models/shared/streetdataset.js.map +1 -0
  127. package/dist/commonjs/sdk/models/shared/streetdescriptor.d.ts +2 -2
  128. package/dist/commonjs/sdk/models/shared/streetdescriptor.d.ts.map +1 -1
  129. package/dist/commonjs/sdk/models/shared/streetdescriptor.js +1 -1
  130. package/dist/commonjs/sdk/models/shared/streetdescriptor.js.map +1 -1
  131. package/dist/commonjs/sdk/models/shared/streetfield.d.ts +16 -0
  132. package/dist/commonjs/sdk/models/shared/streetfield.d.ts.map +1 -0
  133. package/dist/commonjs/sdk/models/shared/streetfield.js +54 -0
  134. package/dist/commonjs/sdk/models/shared/streetfield.js.map +1 -0
  135. package/dist/commonjs/sdk/models/shared/streetmatch.d.ts +9 -4
  136. package/dist/commonjs/sdk/models/shared/streetmatch.d.ts.map +1 -1
  137. package/dist/commonjs/sdk/models/shared/streetmatch.js +2 -0
  138. package/dist/commonjs/sdk/models/shared/streetmatch.js.map +1 -1
  139. package/dist/commonjs/sdk/models/shared/streetnameconfidence.d.ts +17 -0
  140. package/dist/commonjs/sdk/models/shared/streetnameconfidence.d.ts.map +1 -0
  141. package/dist/commonjs/sdk/models/shared/streetnameconfidence.js +51 -0
  142. package/dist/commonjs/sdk/models/shared/streetnameconfidence.js.map +1 -0
  143. package/dist/commonjs/sdk/models/shared/streetnamekind.d.ts +16 -0
  144. package/dist/commonjs/sdk/models/shared/streetnamekind.d.ts.map +1 -0
  145. package/dist/commonjs/sdk/models/shared/streetnamekind.js +50 -0
  146. package/dist/commonjs/sdk/models/shared/streetnamekind.js.map +1 -0
  147. package/dist/commonjs/sdk/models/shared/streetproperties.d.ts +20 -0
  148. package/dist/commonjs/sdk/models/shared/streetproperties.d.ts.map +1 -0
  149. package/dist/commonjs/sdk/models/shared/{streetstatistics.js → streetproperties.js} +8 -8
  150. package/dist/commonjs/sdk/models/shared/streetproperties.js.map +1 -0
  151. package/dist/commonjs/sdk/models/shared/streetpropertyoptions.d.ts +28 -0
  152. package/dist/commonjs/sdk/models/shared/streetpropertyoptions.d.ts.map +1 -0
  153. package/dist/commonjs/sdk/models/shared/streetpropertyoptions.js +51 -0
  154. package/dist/commonjs/sdk/models/shared/streetpropertyoptions.js.map +1 -0
  155. package/dist/commonjs/sdk/models/shared/streetprovenance.d.ts +45 -0
  156. package/dist/commonjs/sdk/models/shared/streetprovenance.d.ts.map +1 -0
  157. package/dist/commonjs/sdk/models/shared/streetprovenance.js +58 -0
  158. package/dist/commonjs/sdk/models/shared/streetprovenance.js.map +1 -0
  159. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.d.ts +6 -1
  160. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.d.ts.map +1 -1
  161. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.js +1 -0
  162. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.js.map +1 -1
  163. package/dist/commonjs/sdk/models/shared/streetquerybyname.d.ts +2 -2
  164. package/dist/commonjs/sdk/models/shared/streetquerybyname.js +1 -1
  165. package/dist/commonjs/sdk/models/shared/streetquerybyname.js.map +1 -1
  166. package/dist/commonjs/sdk/models/shared/streetquerybypostcode.d.ts +5 -0
  167. package/dist/commonjs/sdk/models/shared/streetquerybypostcode.d.ts.map +1 -1
  168. package/dist/commonjs/sdk/models/shared/streetquerybypostcode.js +1 -0
  169. package/dist/commonjs/sdk/models/shared/streetquerybypostcode.js.map +1 -1
  170. package/dist/commonjs/sdk/models/shared/streetqueryrequest.d.ts +20 -28
  171. package/dist/commonjs/sdk/models/shared/streetqueryrequest.d.ts.map +1 -1
  172. package/dist/commonjs/sdk/models/shared/streetqueryrequest.js +13 -12
  173. package/dist/commonjs/sdk/models/shared/streetqueryrequest.js.map +1 -1
  174. package/dist/commonjs/sdk/models/shared/streetqueryresponse.d.ts +6 -14
  175. package/dist/commonjs/sdk/models/shared/streetqueryresponse.d.ts.map +1 -1
  176. package/dist/commonjs/sdk/models/shared/streetqueryresponse.js +3 -6
  177. package/dist/commonjs/sdk/models/shared/streetqueryresponse.js.map +1 -1
  178. package/dist/commonjs/sdk/models/shared/streetrecord.d.ts +126 -0
  179. package/dist/commonjs/sdk/models/shared/streetrecord.d.ts.map +1 -0
  180. package/dist/commonjs/sdk/models/shared/streetrecord.js +87 -0
  181. package/dist/commonjs/sdk/models/shared/streetrecord.js.map +1 -0
  182. package/dist/commonjs/sdk/models/shared/streetsource.d.ts +16 -0
  183. package/dist/commonjs/sdk/models/shared/streetsource.d.ts.map +1 -0
  184. package/dist/commonjs/sdk/models/shared/streetsource.js +50 -0
  185. package/dist/commonjs/sdk/models/shared/streetsource.js.map +1 -0
  186. package/dist/commonjs/sdk/models/shared/titlealert.d.ts +30 -0
  187. package/dist/commonjs/sdk/models/shared/titlealert.d.ts.map +1 -0
  188. package/dist/commonjs/sdk/models/shared/titlealert.js +66 -0
  189. package/dist/commonjs/sdk/models/shared/titlealert.js.map +1 -0
  190. package/dist/commonjs/sdk/models/shared/titleextractionpayload.d.ts +5 -0
  191. package/dist/commonjs/sdk/models/shared/titleextractionpayload.d.ts.map +1 -1
  192. package/dist/commonjs/sdk/models/shared/titleextractionpayload.js +2 -0
  193. package/dist/commonjs/sdk/models/shared/titleextractionpayload.js.map +1 -1
  194. package/dist/commonjs/sdk/models/shared/titlepricepaid.d.ts +19 -0
  195. package/dist/commonjs/sdk/models/shared/titlepricepaid.d.ts.map +1 -1
  196. package/dist/commonjs/sdk/models/shared/titlepricepaid.js +13 -1
  197. package/dist/commonjs/sdk/models/shared/titlepricepaid.js.map +1 -1
  198. package/dist/commonjs/sdk/models.d.ts +38 -0
  199. package/dist/commonjs/sdk/models.d.ts.map +1 -0
  200. package/dist/commonjs/sdk/models.js +54 -0
  201. package/dist/commonjs/sdk/models.js.map +1 -0
  202. package/dist/commonjs/sdk/sdk.d.ts +3 -0
  203. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  204. package/dist/commonjs/sdk/sdk.js +4 -0
  205. package/dist/commonjs/sdk/sdk.js.map +1 -1
  206. package/dist/commonjs/sdk/sites.d.ts +1 -1
  207. package/dist/commonjs/sdk/sites.js +1 -1
  208. package/dist/commonjs/sdk/streets.d.ts +1 -1
  209. package/dist/commonjs/sdk/streets.js +1 -1
  210. package/dist/esm/funcs/geographyGetGeographyAncestors.d.ts +1 -1
  211. package/dist/esm/funcs/geographyGetGeographyAncestors.js +1 -1
  212. package/dist/esm/funcs/geographyGetGeographyAreas.d.ts +1 -1
  213. package/dist/esm/funcs/geographyGetGeographyAreas.js +1 -1
  214. package/dist/esm/funcs/geographyGetGeographyDescendants.d.ts +1 -1
  215. package/dist/esm/funcs/geographyGetGeographyDescendants.js +1 -1
  216. package/dist/esm/funcs/geographyGetGeographyProvenance.d.ts +1 -1
  217. package/dist/esm/funcs/geographyGetGeographyProvenance.js +1 -1
  218. package/dist/esm/funcs/geographyGetGeographyRelease.d.ts +1 -1
  219. package/dist/esm/funcs/geographyGetGeographyRelease.js +1 -1
  220. package/dist/esm/funcs/modelsGetV1AiModels.d.ts +18 -0
  221. package/dist/esm/funcs/modelsGetV1AiModels.d.ts.map +1 -0
  222. package/dist/esm/funcs/modelsGetV1AiModels.js +73 -0
  223. package/dist/esm/funcs/modelsGetV1AiModels.js.map +1 -0
  224. package/dist/esm/funcs/modelsGetV1AiModelsModel.d.ts +19 -0
  225. package/dist/esm/funcs/modelsGetV1AiModelsModel.d.ts.map +1 -0
  226. package/dist/esm/funcs/modelsGetV1AiModelsModel.js +89 -0
  227. package/dist/esm/funcs/modelsGetV1AiModelsModel.js.map +1 -0
  228. package/dist/esm/funcs/modelsPostV1AiChatCompletions.d.ts +25 -0
  229. package/dist/esm/funcs/modelsPostV1AiChatCompletions.d.ts.map +1 -0
  230. package/dist/esm/funcs/modelsPostV1AiChatCompletions.js +92 -0
  231. package/dist/esm/funcs/modelsPostV1AiChatCompletions.js.map +1 -0
  232. package/dist/esm/funcs/modelsPostV1AiResponses.d.ts +18 -0
  233. package/dist/esm/funcs/modelsPostV1AiResponses.d.ts.map +1 -0
  234. package/dist/esm/funcs/modelsPostV1AiResponses.js +83 -0
  235. package/dist/esm/funcs/modelsPostV1AiResponses.js.map +1 -0
  236. package/dist/esm/funcs/searchSearchSuggest.js +1 -0
  237. package/dist/esm/funcs/searchSearchSuggest.js.map +1 -1
  238. package/dist/esm/funcs/sitesGet.d.ts +1 -1
  239. package/dist/esm/funcs/sitesGet.js +1 -1
  240. package/dist/esm/funcs/streetsSearchStreets.d.ts +1 -1
  241. package/dist/esm/funcs/streetsSearchStreets.js +1 -1
  242. package/dist/esm/lib/config.d.ts +3 -3
  243. package/dist/esm/lib/config.js +3 -3
  244. package/dist/esm/lib/config.js.map +1 -1
  245. package/dist/esm/sdk/geography.d.ts +5 -5
  246. package/dist/esm/sdk/geography.js +5 -5
  247. package/dist/esm/sdk/models/errors/index.d.ts +1 -0
  248. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  249. package/dist/esm/sdk/models/errors/index.js +1 -0
  250. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  251. package/dist/esm/sdk/models/errors/modelapierror.d.ts +57 -0
  252. package/dist/esm/sdk/models/errors/modelapierror.d.ts.map +1 -0
  253. package/dist/esm/sdk/models/errors/modelapierror.js +53 -0
  254. package/dist/esm/sdk/models/errors/modelapierror.js.map +1 -0
  255. package/dist/esm/sdk/models/operations/getepcbylocationid.d.ts +3 -3
  256. package/dist/esm/sdk/models/operations/getepcbylocationid.js +1 -1
  257. package/dist/esm/sdk/models/operations/getgeographychildren.d.ts +2 -2
  258. package/dist/esm/sdk/models/operations/getv1aimodelsmodel.d.ts +15 -0
  259. package/dist/esm/sdk/models/operations/getv1aimodelsmodel.d.ts.map +1 -0
  260. package/dist/esm/sdk/models/operations/getv1aimodelsmodel.js +12 -0
  261. package/dist/esm/sdk/models/operations/getv1aimodelsmodel.js.map +1 -0
  262. package/dist/esm/sdk/models/operations/index.d.ts +2 -0
  263. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  264. package/dist/esm/sdk/models/operations/index.js +2 -0
  265. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  266. package/dist/esm/sdk/models/operations/postv1aichatcompletions.d.ts +9 -0
  267. package/dist/esm/sdk/models/operations/postv1aichatcompletions.d.ts.map +1 -0
  268. package/dist/esm/sdk/models/operations/postv1aichatcompletions.js +12 -0
  269. package/dist/esm/sdk/models/operations/postv1aichatcompletions.js.map +1 -0
  270. package/dist/esm/sdk/models/operations/resolveaddress.d.ts +4 -0
  271. package/dist/esm/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  272. package/dist/esm/sdk/models/operations/resolveaddress.js +1 -0
  273. package/dist/esm/sdk/models/operations/resolveaddress.js.map +1 -1
  274. package/dist/esm/sdk/models/operations/searchsuggest.d.ts +19 -0
  275. package/dist/esm/sdk/models/operations/searchsuggest.d.ts.map +1 -1
  276. package/dist/esm/sdk/models/operations/searchsuggest.js +11 -0
  277. package/dist/esm/sdk/models/operations/searchsuggest.js.map +1 -1
  278. package/dist/esm/sdk/models/shared/addressresolverequest.d.ts +3 -0
  279. package/dist/esm/sdk/models/shared/addressresolverequest.d.ts.map +1 -1
  280. package/dist/esm/sdk/models/shared/addressresolverequest.js +2 -0
  281. package/dist/esm/sdk/models/shared/addressresolverequest.js.map +1 -1
  282. package/dist/esm/sdk/models/shared/avmanalysisresponse.d.ts +1 -1
  283. package/dist/esm/sdk/models/shared/avmconfidenceinterval.d.ts +3 -3
  284. package/dist/esm/sdk/models/shared/avmmetadata.d.ts +1 -1
  285. package/dist/esm/sdk/models/shared/avmpredictbylocationrequest.d.ts +3 -3
  286. package/dist/esm/sdk/models/shared/avmpredictbylocationrequest.js +1 -1
  287. package/dist/esm/sdk/models/shared/avmpredictresponse.d.ts +1 -1
  288. package/dist/esm/sdk/models/shared/chatcompletion.d.ts +95 -0
  289. package/dist/esm/sdk/models/shared/chatcompletion.d.ts.map +1 -0
  290. package/dist/esm/sdk/models/shared/chatcompletion.js +82 -0
  291. package/dist/esm/sdk/models/shared/chatcompletion.js.map +1 -0
  292. package/dist/esm/sdk/models/shared/chatcompletionrequest.d.ts +203 -0
  293. package/dist/esm/sdk/models/shared/chatcompletionrequest.d.ts.map +1 -0
  294. package/dist/esm/sdk/models/shared/chatcompletionrequest.js +103 -0
  295. package/dist/esm/sdk/models/shared/chatcompletionrequest.js.map +1 -0
  296. package/dist/esm/sdk/models/shared/epcqueryresponse.d.ts +3 -3
  297. package/dist/esm/sdk/models/shared/epcqueryresponse.js +1 -1
  298. package/dist/esm/sdk/models/shared/geographyarea.d.ts +2 -2
  299. package/dist/esm/sdk/models/shared/geographyrelatedarea.d.ts +2 -2
  300. package/dist/esm/sdk/models/shared/historicalvaluation.d.ts +3 -3
  301. package/dist/esm/sdk/models/shared/index.d.ts +16 -3
  302. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  303. package/dist/esm/sdk/models/shared/index.js +16 -3
  304. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  305. package/dist/esm/sdk/models/shared/model.d.ts +72 -0
  306. package/dist/esm/sdk/models/shared/model.d.ts.map +1 -0
  307. package/dist/esm/sdk/models/shared/model.js +62 -0
  308. package/dist/esm/sdk/models/shared/model.js.map +1 -0
  309. package/dist/esm/sdk/models/shared/modellist.d.ts +19 -0
  310. package/dist/esm/sdk/models/shared/modellist.d.ts.map +1 -0
  311. package/dist/esm/sdk/models/shared/modellist.js +20 -0
  312. package/dist/esm/sdk/models/shared/modellist.js.map +1 -0
  313. package/dist/esm/sdk/models/shared/modelresponse.d.ts +116 -0
  314. package/dist/esm/sdk/models/shared/modelresponse.d.ts.map +1 -0
  315. package/dist/esm/sdk/models/shared/modelresponse.js +97 -0
  316. package/dist/esm/sdk/models/shared/modelresponse.js.map +1 -0
  317. package/dist/esm/sdk/models/shared/regulatoryzonecharges.d.ts +4 -4
  318. package/dist/esm/sdk/models/shared/regulatoryzonecharges.d.ts.map +1 -1
  319. package/dist/esm/sdk/models/shared/regulatoryzonecharges.js +3 -3
  320. package/dist/esm/sdk/models/shared/regulatoryzonecharges.js.map +1 -1
  321. package/dist/esm/sdk/models/shared/responserequest.d.ts +148 -0
  322. package/dist/esm/sdk/models/shared/responserequest.d.ts.map +1 -0
  323. package/dist/esm/sdk/models/shared/responserequest.js +71 -0
  324. package/dist/esm/sdk/models/shared/responserequest.js.map +1 -0
  325. package/dist/esm/sdk/models/shared/searchresponse.d.ts +4 -0
  326. package/dist/esm/sdk/models/shared/searchresponse.d.ts.map +1 -1
  327. package/dist/esm/sdk/models/shared/searchresponse.js +1 -0
  328. package/dist/esm/sdk/models/shared/searchresponse.js.map +1 -1
  329. package/dist/esm/sdk/models/shared/site.d.ts +1 -1
  330. package/dist/esm/sdk/models/shared/streetdataset.d.ts +17 -0
  331. package/dist/esm/sdk/models/shared/streetdataset.d.ts.map +1 -0
  332. package/dist/esm/sdk/models/shared/streetdataset.js +15 -0
  333. package/dist/esm/sdk/models/shared/streetdataset.js.map +1 -0
  334. package/dist/esm/sdk/models/shared/streetdescriptor.d.ts +2 -2
  335. package/dist/esm/sdk/models/shared/streetdescriptor.d.ts.map +1 -1
  336. package/dist/esm/sdk/models/shared/streetdescriptor.js +1 -1
  337. package/dist/esm/sdk/models/shared/streetdescriptor.js.map +1 -1
  338. package/dist/esm/sdk/models/shared/streetfield.d.ts +16 -0
  339. package/dist/esm/sdk/models/shared/streetfield.d.ts.map +1 -0
  340. package/dist/esm/sdk/models/shared/streetfield.js +18 -0
  341. package/dist/esm/sdk/models/shared/streetfield.js.map +1 -0
  342. package/dist/esm/sdk/models/shared/streetmatch.d.ts +9 -4
  343. package/dist/esm/sdk/models/shared/streetmatch.d.ts.map +1 -1
  344. package/dist/esm/sdk/models/shared/streetmatch.js +2 -0
  345. package/dist/esm/sdk/models/shared/streetmatch.js.map +1 -1
  346. package/dist/esm/sdk/models/shared/streetnameconfidence.d.ts +17 -0
  347. package/dist/esm/sdk/models/shared/streetnameconfidence.d.ts.map +1 -0
  348. package/dist/esm/sdk/models/shared/streetnameconfidence.js +15 -0
  349. package/dist/esm/sdk/models/shared/streetnameconfidence.js.map +1 -0
  350. package/dist/esm/sdk/models/shared/streetnamekind.d.ts +16 -0
  351. package/dist/esm/sdk/models/shared/streetnamekind.d.ts.map +1 -0
  352. package/dist/esm/sdk/models/shared/streetnamekind.js +14 -0
  353. package/dist/esm/sdk/models/shared/streetnamekind.js.map +1 -0
  354. package/dist/esm/sdk/models/shared/streetproperties.d.ts +20 -0
  355. package/dist/esm/sdk/models/shared/streetproperties.d.ts.map +1 -0
  356. package/dist/esm/sdk/models/shared/streetproperties.js +14 -0
  357. package/dist/esm/sdk/models/shared/streetproperties.js.map +1 -0
  358. package/dist/esm/sdk/models/shared/streetpropertyoptions.d.ts +28 -0
  359. package/dist/esm/sdk/models/shared/streetpropertyoptions.d.ts.map +1 -0
  360. package/dist/esm/sdk/models/shared/streetpropertyoptions.js +14 -0
  361. package/dist/esm/sdk/models/shared/streetpropertyoptions.js.map +1 -0
  362. package/dist/esm/sdk/models/shared/streetprovenance.d.ts +45 -0
  363. package/dist/esm/sdk/models/shared/streetprovenance.d.ts.map +1 -0
  364. package/dist/esm/sdk/models/shared/streetprovenance.js +21 -0
  365. package/dist/esm/sdk/models/shared/streetprovenance.js.map +1 -0
  366. package/dist/esm/sdk/models/shared/streetquerybycoordinates.d.ts +6 -1
  367. package/dist/esm/sdk/models/shared/streetquerybycoordinates.d.ts.map +1 -1
  368. package/dist/esm/sdk/models/shared/streetquerybycoordinates.js +1 -0
  369. package/dist/esm/sdk/models/shared/streetquerybycoordinates.js.map +1 -1
  370. package/dist/esm/sdk/models/shared/streetquerybyname.d.ts +2 -2
  371. package/dist/esm/sdk/models/shared/streetquerybyname.js +1 -1
  372. package/dist/esm/sdk/models/shared/streetquerybyname.js.map +1 -1
  373. package/dist/esm/sdk/models/shared/streetquerybypostcode.d.ts +5 -0
  374. package/dist/esm/sdk/models/shared/streetquerybypostcode.d.ts.map +1 -1
  375. package/dist/esm/sdk/models/shared/streetquerybypostcode.js +1 -0
  376. package/dist/esm/sdk/models/shared/streetquerybypostcode.js.map +1 -1
  377. package/dist/esm/sdk/models/shared/streetqueryrequest.d.ts +20 -28
  378. package/dist/esm/sdk/models/shared/streetqueryrequest.d.ts.map +1 -1
  379. package/dist/esm/sdk/models/shared/streetqueryrequest.js +12 -10
  380. package/dist/esm/sdk/models/shared/streetqueryrequest.js.map +1 -1
  381. package/dist/esm/sdk/models/shared/streetqueryresponse.d.ts +6 -14
  382. package/dist/esm/sdk/models/shared/streetqueryresponse.d.ts.map +1 -1
  383. package/dist/esm/sdk/models/shared/streetqueryresponse.js +3 -6
  384. package/dist/esm/sdk/models/shared/streetqueryresponse.js.map +1 -1
  385. package/dist/esm/sdk/models/shared/streetrecord.d.ts +126 -0
  386. package/dist/esm/sdk/models/shared/streetrecord.d.ts.map +1 -0
  387. package/dist/esm/sdk/models/shared/streetrecord.js +49 -0
  388. package/dist/esm/sdk/models/shared/streetrecord.js.map +1 -0
  389. package/dist/esm/sdk/models/shared/streetsource.d.ts +16 -0
  390. package/dist/esm/sdk/models/shared/streetsource.d.ts.map +1 -0
  391. package/dist/esm/sdk/models/shared/streetsource.js +14 -0
  392. package/dist/esm/sdk/models/shared/streetsource.js.map +1 -0
  393. package/dist/esm/sdk/models/shared/titlealert.d.ts +30 -0
  394. package/dist/esm/sdk/models/shared/titlealert.d.ts.map +1 -0
  395. package/dist/esm/sdk/models/shared/titlealert.js +29 -0
  396. package/dist/esm/sdk/models/shared/titlealert.js.map +1 -0
  397. package/dist/esm/sdk/models/shared/titleextractionpayload.d.ts +5 -0
  398. package/dist/esm/sdk/models/shared/titleextractionpayload.d.ts.map +1 -1
  399. package/dist/esm/sdk/models/shared/titleextractionpayload.js +2 -0
  400. package/dist/esm/sdk/models/shared/titleextractionpayload.js.map +1 -1
  401. package/dist/esm/sdk/models/shared/titlepricepaid.d.ts +19 -0
  402. package/dist/esm/sdk/models/shared/titlepricepaid.d.ts.map +1 -1
  403. package/dist/esm/sdk/models/shared/titlepricepaid.js +12 -0
  404. package/dist/esm/sdk/models/shared/titlepricepaid.js.map +1 -1
  405. package/dist/esm/sdk/models.d.ts +38 -0
  406. package/dist/esm/sdk/models.d.ts.map +1 -0
  407. package/dist/esm/sdk/models.js +49 -0
  408. package/dist/esm/sdk/models.js.map +1 -0
  409. package/dist/esm/sdk/sdk.d.ts +3 -0
  410. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  411. package/dist/esm/sdk/sdk.js +4 -0
  412. package/dist/esm/sdk/sdk.js.map +1 -1
  413. package/dist/esm/sdk/sites.d.ts +1 -1
  414. package/dist/esm/sdk/sites.js +1 -1
  415. package/dist/esm/sdk/streets.d.ts +1 -1
  416. package/dist/esm/sdk/streets.js +1 -1
  417. package/examples/addressBulkLookupPostcodes.example.ts +1 -1
  418. package/package.json +1 -1
  419. package/src/funcs/geographyGetGeographyAncestors.ts +1 -1
  420. package/src/funcs/geographyGetGeographyAreas.ts +1 -1
  421. package/src/funcs/geographyGetGeographyDescendants.ts +1 -1
  422. package/src/funcs/geographyGetGeographyProvenance.ts +1 -1
  423. package/src/funcs/geographyGetGeographyRelease.ts +1 -1
  424. package/src/funcs/modelsGetV1AiModels.ts +154 -0
  425. package/src/funcs/modelsGetV1AiModelsModel.ts +178 -0
  426. package/src/funcs/modelsPostV1AiChatCompletions.ts +189 -0
  427. package/src/funcs/modelsPostV1AiResponses.ts +175 -0
  428. package/src/funcs/searchSearchSuggest.ts +1 -0
  429. package/src/funcs/sitesGet.ts +1 -1
  430. package/src/funcs/streetsSearchStreets.ts +1 -1
  431. package/src/lib/config.ts +3 -3
  432. package/src/sdk/geography.ts +5 -5
  433. package/src/sdk/models/errors/index.ts +1 -0
  434. package/src/sdk/models/errors/modelapierror.ts +118 -0
  435. package/src/sdk/models/operations/getepcbylocationid.ts +3 -3
  436. package/src/sdk/models/operations/getgeographychildren.ts +2 -2
  437. package/src/sdk/models/operations/getv1aimodelsmodel.ts +34 -0
  438. package/src/sdk/models/operations/index.ts +2 -0
  439. package/src/sdk/models/operations/postv1aichatcompletions.ts +28 -0
  440. package/src/sdk/models/operations/resolveaddress.ts +5 -0
  441. package/src/sdk/models/operations/searchsuggest.ts +26 -0
  442. package/src/sdk/models/shared/addressresolverequest.ts +7 -0
  443. package/src/sdk/models/shared/avmanalysisresponse.ts +1 -1
  444. package/src/sdk/models/shared/avmconfidenceinterval.ts +3 -3
  445. package/src/sdk/models/shared/avmmetadata.ts +1 -1
  446. package/src/sdk/models/shared/avmpredictbylocationrequest.ts +3 -3
  447. package/src/sdk/models/shared/avmpredictresponse.ts +1 -1
  448. package/src/sdk/models/shared/chatcompletion.ts +201 -0
  449. package/src/sdk/models/shared/chatcompletionrequest.ts +318 -0
  450. package/src/sdk/models/shared/epcqueryresponse.ts +3 -3
  451. package/src/sdk/models/shared/geographyarea.ts +2 -2
  452. package/src/sdk/models/shared/geographyrelatedarea.ts +2 -2
  453. package/src/sdk/models/shared/historicalvaluation.ts +3 -3
  454. package/src/sdk/models/shared/index.ts +16 -3
  455. package/src/sdk/models/shared/model.ts +130 -0
  456. package/src/sdk/models/shared/modellist.ts +45 -0
  457. package/src/sdk/models/shared/modelresponse.ts +242 -0
  458. package/src/sdk/models/shared/regulatoryzonecharges.ts +11 -6
  459. package/src/sdk/models/shared/responserequest.ts +220 -0
  460. package/src/sdk/models/shared/searchresponse.ts +5 -0
  461. package/src/sdk/models/shared/site.ts +1 -1
  462. package/src/sdk/models/shared/streetdataset.ts +24 -0
  463. package/src/sdk/models/shared/streetdescriptor.ts +3 -3
  464. package/src/sdk/models/shared/streetfield.ts +22 -0
  465. package/src/sdk/models/shared/streetmatch.ts +10 -4
  466. package/src/sdk/models/shared/streetnameconfidence.ts +27 -0
  467. package/src/sdk/models/shared/streetnamekind.ts +26 -0
  468. package/src/sdk/models/shared/streetproperties.ts +42 -0
  469. package/src/sdk/models/shared/streetpropertyoptions.ts +49 -0
  470. package/src/sdk/models/shared/streetprovenance.ts +73 -0
  471. package/src/sdk/models/shared/streetquerybycoordinates.ts +7 -1
  472. package/src/sdk/models/shared/streetquerybyname.ts +3 -3
  473. package/src/sdk/models/shared/streetquerybypostcode.ts +6 -0
  474. package/src/sdk/models/shared/streetqueryrequest.ts +36 -45
  475. package/src/sdk/models/shared/streetqueryresponse.ts +8 -21
  476. package/src/sdk/models/shared/streetrecord.ts +202 -0
  477. package/src/sdk/models/shared/streetsource.ts +26 -0
  478. package/src/sdk/models/shared/titlealert.ts +60 -0
  479. package/src/sdk/models/shared/titleextractionpayload.ts +6 -0
  480. package/src/sdk/models/shared/titlepricepaid.ts +24 -0
  481. package/src/sdk/models.ts +87 -0
  482. package/src/sdk/sdk.ts +6 -0
  483. package/src/sdk/sites.ts +1 -1
  484. package/src/sdk/streets.ts +1 -1
  485. package/dist/commonjs/sdk/models/shared/propertyonstreet.d.ts +0 -29
  486. package/dist/commonjs/sdk/models/shared/propertyonstreet.d.ts.map +0 -1
  487. package/dist/commonjs/sdk/models/shared/propertyonstreet.js.map +0 -1
  488. package/dist/commonjs/sdk/models/shared/streetdetails.d.ts +0 -34
  489. package/dist/commonjs/sdk/models/shared/streetdetails.d.ts.map +0 -1
  490. package/dist/commonjs/sdk/models/shared/streetdetails.js.map +0 -1
  491. package/dist/commonjs/sdk/models/shared/streetstatistics.d.ts +0 -19
  492. package/dist/commonjs/sdk/models/shared/streetstatistics.d.ts.map +0 -1
  493. package/dist/commonjs/sdk/models/shared/streetstatistics.js.map +0 -1
  494. package/dist/esm/sdk/models/shared/propertyonstreet.d.ts +0 -29
  495. package/dist/esm/sdk/models/shared/propertyonstreet.d.ts.map +0 -1
  496. package/dist/esm/sdk/models/shared/propertyonstreet.js +0 -17
  497. package/dist/esm/sdk/models/shared/propertyonstreet.js.map +0 -1
  498. package/dist/esm/sdk/models/shared/streetdetails.d.ts +0 -34
  499. package/dist/esm/sdk/models/shared/streetdetails.d.ts.map +0 -1
  500. package/dist/esm/sdk/models/shared/streetdetails.js +0 -19
  501. package/dist/esm/sdk/models/shared/streetdetails.js.map +0 -1
  502. package/dist/esm/sdk/models/shared/streetstatistics.d.ts +0 -19
  503. package/dist/esm/sdk/models/shared/streetstatistics.d.ts.map +0 -1
  504. package/dist/esm/sdk/models/shared/streetstatistics.js +0 -14
  505. package/dist/esm/sdk/models/shared/streetstatistics.js.map +0 -1
  506. package/src/sdk/models/shared/propertyonstreet.ts +0 -54
  507. package/src/sdk/models/shared/streetdetails.ts +0 -63
  508. package/src/sdk/models/shared/streetstatistics.ts +0 -39
@@ -0,0 +1,14 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v3";
5
+ import { safeParse } from "../../../lib/schemas.js";
6
+ /** @internal */
7
+ export const StreetProperties$inboundSchema = z.object({
8
+ hasMore: z.boolean(),
9
+ uprns: z.array(z.number()),
10
+ });
11
+ export function streetPropertiesFromJSON(jsonString) {
12
+ return safeParse(jsonString, (x) => StreetProperties$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'StreetProperties' from JSON`);
13
+ }
14
+ //# sourceMappingURL=streetproperties.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"streetproperties.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetproperties.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAkBpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAC3B,CAAC,CAAC;AAEH,MAAM,UAAU,wBAAwB,CACtC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8BAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC"}
@@ -0,0 +1,28 @@
1
+ import * as z from "zod/v3";
2
+ /**
3
+ * How to page and filter each street's property list. Accepted only when `includeProperties` is true.
4
+ */
5
+ export type StreetPropertyOptions = {
6
+ /**
7
+ * Include retired address records alongside the current ones. Defaults to false, which returns only approved and alternative addresses. Available only with `dataset` set to `ngd`.
8
+ */
9
+ includeHistoric?: boolean | undefined;
10
+ /**
11
+ * Maximum number of properties to return per street. Defaults to 100. Minimum 1, maximum 500.
12
+ */
13
+ limit?: number | undefined;
14
+ /**
15
+ * Number of properties to skip on each street before the first one returned. Defaults to 0.
16
+ */
17
+ offset?: number | undefined;
18
+ };
19
+ /** @internal */
20
+ export type StreetPropertyOptions$Outbound = {
21
+ includeHistoric: boolean;
22
+ limit: number;
23
+ offset: number;
24
+ };
25
+ /** @internal */
26
+ export declare const StreetPropertyOptions$outboundSchema: z.ZodType<StreetPropertyOptions$Outbound, z.ZodTypeDef, StreetPropertyOptions>;
27
+ export declare function streetPropertyOptionsToJSON(streetPropertyOptions: StreetPropertyOptions): string;
28
+ //# sourceMappingURL=streetpropertyoptions.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"streetpropertyoptions.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetpropertyoptions.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,8BAA8B,GAAG;IAC3C,eAAe,EAAE,OAAO,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,qBAAqB,CAKrB,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,qBAAqB,EAAE,qBAAqB,GAC3C,MAAM,CAIR"}
@@ -0,0 +1,14 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v3";
5
+ /** @internal */
6
+ export const StreetPropertyOptions$outboundSchema = z.object({
7
+ includeHistoric: z.boolean().default(false),
8
+ limit: z.number().int().default(100),
9
+ offset: z.number().int().default(0),
10
+ });
11
+ export function streetPropertyOptionsToJSON(streetPropertyOptions) {
12
+ return JSON.stringify(StreetPropertyOptions$outboundSchema.parse(streetPropertyOptions));
13
+ }
14
+ //# sourceMappingURL=streetpropertyoptions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"streetpropertyoptions.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetpropertyoptions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AA2B5B,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC3C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC;IACpC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;CACpC,CAAC,CAAC;AAEH,MAAM,UAAU,2BAA2B,CACzC,qBAA4C;IAE5C,OAAO,IAAI,CAAC,SAAS,CACnB,oCAAoC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAClE,CAAC;AACJ,CAAC"}
@@ -0,0 +1,45 @@
1
+ import * as z from "zod/v3";
2
+ import { Result as SafeParseResult } from "../../types/fp.js";
3
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
+ import { StreetSource } from "./streetsource.js";
5
+ /**
6
+ * Which dataset supplied each returned field. Present only when a street's fields came from more than one dataset.
7
+ */
8
+ export type StreetProvenance = {
9
+ /**
10
+ * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
11
+ */
12
+ county?: StreetSource | undefined;
13
+ /**
14
+ * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
15
+ */
16
+ district?: StreetSource | undefined;
17
+ /**
18
+ * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
19
+ */
20
+ locality?: StreetSource | undefined;
21
+ /**
22
+ * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
23
+ */
24
+ location?: StreetSource | undefined;
25
+ /**
26
+ * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
27
+ */
28
+ name?: StreetSource | undefined;
29
+ /**
30
+ * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
31
+ */
32
+ postcodeDistrict?: StreetSource | undefined;
33
+ /**
34
+ * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
35
+ */
36
+ streetType?: StreetSource | undefined;
37
+ /**
38
+ * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
39
+ */
40
+ town?: StreetSource | undefined;
41
+ };
42
+ /** @internal */
43
+ export declare const StreetProvenance$inboundSchema: z.ZodType<StreetProvenance, z.ZodTypeDef, unknown>;
44
+ export declare function streetProvenanceFromJSON(jsonString: string): SafeParseResult<StreetProvenance, SDKValidationError>;
45
+ //# sourceMappingURL=streetprovenance.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"streetprovenance.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetprovenance.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,YAAY,EAA8B,MAAM,mBAAmB,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,gBAAgB,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CAUP,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD"}
@@ -0,0 +1,21 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v3";
5
+ import { safeParse } from "../../../lib/schemas.js";
6
+ import { StreetSource$inboundSchema } from "./streetsource.js";
7
+ /** @internal */
8
+ export const StreetProvenance$inboundSchema = z.object({
9
+ county: StreetSource$inboundSchema.optional(),
10
+ district: StreetSource$inboundSchema.optional(),
11
+ locality: StreetSource$inboundSchema.optional(),
12
+ location: StreetSource$inboundSchema.optional(),
13
+ name: StreetSource$inboundSchema.optional(),
14
+ postcodeDistrict: StreetSource$inboundSchema.optional(),
15
+ streetType: StreetSource$inboundSchema.optional(),
16
+ town: StreetSource$inboundSchema.optional(),
17
+ });
18
+ export function streetProvenanceFromJSON(jsonString) {
19
+ return safeParse(jsonString, (x) => StreetProvenance$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'StreetProvenance' from JSON`);
20
+ }
21
+ //# sourceMappingURL=streetprovenance.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"streetprovenance.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetprovenance.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAGpD,OAAO,EAAgB,0BAA0B,EAAE,MAAM,mBAAmB,CAAC;AAwC7E,gBAAgB;AAChB,MAAM,CAAC,MAAM,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IAC7C,QAAQ,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IAC/C,QAAQ,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IAC/C,QAAQ,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IAC/C,IAAI,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IAC3C,gBAAgB,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IACvD,UAAU,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IACjD,IAAI,EAAE,0BAA0B,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAEH,MAAM,UAAU,wBAAwB,CACtC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8BAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC"}
@@ -4,12 +4,16 @@ export type StreetQueryByCoordinates = {
4
4
  * Latitude in WGS84 decimal degrees.
5
5
  */
6
6
  lat: number;
7
+ /**
8
+ * Maximum number of streets to return on this page. Defaults to 10. Minimum 1, maximum 50.
9
+ */
10
+ limit?: number | undefined;
7
11
  /**
8
12
  * Longitude in WGS84 decimal degrees.
9
13
  */
10
14
  lng: number;
11
15
  /**
12
- * How far from the point to search, in metres. Defaults to 50. Minimum 1, maximum 1000.
16
+ * How far from the point to search, in metres, measured to each street's centre in the dataset searched. Under `open_then_ngd` that is the open data unless the open data has no street in the radius, so a street the NGD supplies whole can have its `location` outside the radius. Defaults to 50. Minimum 1, maximum 1000.
13
17
  */
14
18
  radius?: number | undefined;
15
19
  type: "coordinates";
@@ -17,6 +21,7 @@ export type StreetQueryByCoordinates = {
17
21
  /** @internal */
18
22
  export type StreetQueryByCoordinates$Outbound = {
19
23
  lat: number;
24
+ limit: number;
20
25
  lng: number;
21
26
  radius: number;
22
27
  type: "coordinates";
@@ -1 +1 @@
1
- {"version":3,"file":"streetquerybycoordinates.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybycoordinates.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,iCAAiC,GAAG;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,wBAAwB,CAMxB,CAAC;AAEH,wBAAgB,8BAA8B,CAC5C,wBAAwB,EAAE,wBAAwB,GACjD,MAAM,CAIR"}
1
+ {"version":3,"file":"streetquerybycoordinates.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybycoordinates.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,iCAAiC,GAAG;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,wBAAwB,CAOxB,CAAC;AAEH,wBAAgB,8BAA8B,CAC5C,wBAAwB,EAAE,wBAAwB,GACjD,MAAM,CAIR"}
@@ -5,6 +5,7 @@ import * as z from "zod/v3";
5
5
  /** @internal */
6
6
  export const StreetQueryByCoordinates$outboundSchema = z.object({
7
7
  lat: z.number(),
8
+ limit: z.number().int().default(10),
8
9
  lng: z.number(),
9
10
  radius: z.number().default(50),
10
11
  type: z.literal("coordinates"),
@@ -1 +1 @@
1
- {"version":3,"file":"streetquerybycoordinates.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybycoordinates.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AA0B5B,gBAAgB;AAChB,MAAM,CAAC,MAAM,uCAAuC,GAIhD,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;CAC/B,CAAC,CAAC;AAEH,MAAM,UAAU,8BAA8B,CAC5C,wBAAkD;IAElD,OAAO,IAAI,CAAC,SAAS,CACnB,uCAAuC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CACxE,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"streetquerybycoordinates.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybycoordinates.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AA+B5B,gBAAgB;AAChB,MAAM,CAAC,MAAM,uCAAuC,GAIhD,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;CAC/B,CAAC,CAAC;AAEH,MAAM,UAAU,8BAA8B,CAC5C,wBAAkD;IAElD,OAAO,IAAI,CAAC,SAAS,CACnB,uCAAuC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CACxE,CAAC;AACJ,CAAC"}
@@ -1,11 +1,11 @@
1
1
  import * as z from "zod/v3";
2
2
  export type StreetQueryByName = {
3
3
  /**
4
- * Maximum number of streets to return. Defaults to 10. Minimum 1, maximum 50.
4
+ * Maximum number of streets to return on this page. Defaults to 10. Minimum 1, maximum 50.
5
5
  */
6
6
  limit?: number | undefined;
7
7
  /**
8
- * Street name to search for. Matched anywhere in the name. Minimum 2 characters.
8
+ * Street name to search for, optionally followed by its locality or town. Case is not significant and small misspellings are tolerated; every word must match. Minimum 2 characters.
9
9
  */
10
10
  searchTerm: string;
11
11
  type: "name";
@@ -4,7 +4,7 @@
4
4
  import * as z from "zod/v3";
5
5
  /** @internal */
6
6
  export const StreetQueryByName$outboundSchema = z.object({
7
- limit: z.number().default(10),
7
+ limit: z.number().int().default(10),
8
8
  searchTerm: z.string(),
9
9
  type: z.literal("name"),
10
10
  });
@@ -1 +1 @@
1
- {"version":3,"file":"streetquerybyname.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybyname.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAqB5B,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC7B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;CACxB,CAAC,CAAC;AAEH,MAAM,UAAU,uBAAuB,CACrC,iBAAoC;IAEpC,OAAO,IAAI,CAAC,SAAS,CACnB,gCAAgC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAC1D,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"streetquerybyname.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybyname.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAqB5B,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;CACxB,CAAC,CAAC;AAEH,MAAM,UAAU,uBAAuB,CACrC,iBAAoC;IAEpC,OAAO,IAAI,CAAC,SAAS,CACnB,gCAAgC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAC1D,CAAC;AACJ,CAAC"}
@@ -1,5 +1,9 @@
1
1
  import * as z from "zod/v3";
2
2
  export type StreetQueryByPostcode = {
3
+ /**
4
+ * Maximum number of streets to return on this page. Defaults to 10. Minimum 1, maximum 50.
5
+ */
6
+ limit?: number | undefined;
3
7
  /**
4
8
  * A full UK postcode. The space is optional and case is not significant; the value is returned upper-cased.
5
9
  */
@@ -8,6 +12,7 @@ export type StreetQueryByPostcode = {
8
12
  };
9
13
  /** @internal */
10
14
  export type StreetQueryByPostcode$Outbound = {
15
+ limit: number;
11
16
  postcode: string;
12
17
  type: "postcode";
13
18
  };
@@ -1 +1 @@
1
- {"version":3,"file":"streetquerybypostcode.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybypostcode.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,8BAA8B,GAAG;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,qBAAqB,CAIrB,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,qBAAqB,EAAE,qBAAqB,GAC3C,MAAM,CAIR"}
1
+ {"version":3,"file":"streetquerybypostcode.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybypostcode.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,8BAA8B,GAAG;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,qBAAqB,CAKrB,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,qBAAqB,EAAE,qBAAqB,GAC3C,MAAM,CAIR"}
@@ -4,6 +4,7 @@
4
4
  import * as z from "zod/v3";
5
5
  /** @internal */
6
6
  export const StreetQueryByPostcode$outboundSchema = z.object({
7
+ limit: z.number().int().default(10),
7
8
  postcode: z.string(),
8
9
  type: z.literal("postcode"),
9
10
  });
@@ -1 +1 @@
1
- {"version":3,"file":"streetquerybypostcode.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybypostcode.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAgB5B,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;CAC5B,CAAC,CAAC;AAEH,MAAM,UAAU,2BAA2B,CACzC,qBAA4C;IAE5C,OAAO,IAAI,CAAC,SAAS,CACnB,oCAAoC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAClE,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"streetquerybypostcode.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybypostcode.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAqB5B,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;CAC5B,CAAC,CAAC;AAEH,MAAM,UAAU,2BAA2B,CACzC,qBAA4C;IAE5C,OAAO,IAAI,CAAC,SAAS,CACnB,oCAAoC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAClE,CAAC;AACJ,CAAC"}
@@ -1,4 +1,7 @@
1
1
  import * as z from "zod/v3";
2
+ import { StreetDataset } from "./streetdataset.js";
3
+ import { StreetField } from "./streetfield.js";
4
+ import { StreetPropertyOptions, StreetPropertyOptions$Outbound } from "./streetpropertyoptions.js";
2
5
  import { StreetQueryByCoordinates, StreetQueryByCoordinates$Outbound } from "./streetquerybycoordinates.js";
3
6
  import { StreetQueryByName, StreetQueryByName$Outbound } from "./streetquerybyname.js";
4
7
  import { StreetQueryByPostcode, StreetQueryByPostcode$Outbound } from "./streetquerybypostcode.js";
@@ -8,40 +11,35 @@ import { StreetQueryByUsrn, StreetQueryByUsrn$Outbound } from "./streetquerybyus
8
11
  * Which streets to return, given as one of five identifier types. Set `type` to `usrn`, `uprn`, `coordinates`, `name` or `postcode` and supply that type's own fields.
9
12
  */
10
13
  export type Identifier = StreetQueryByCoordinates | StreetQueryByName | StreetQueryByPostcode | StreetQueryByUprn | StreetQueryByUsrn;
11
- /**
12
- * How to page and filter the property list, when `includeProperties` is set.
13
- */
14
- export type PropertyOptions = {
15
- /**
16
- * Include retired address records alongside the current ones. Defaults to false, which returns only approved and alternative addresses.
17
- */
18
- includeHistoric?: boolean | undefined;
14
+ export type StreetQueryRequest = {
19
15
  /**
20
- * Maximum number of properties to return. Defaults to 100. Minimum 1, maximum 500.
16
+ * Which street dataset to read. 'open' reads Ordnance Survey open data published under the Open Government Licence. 'ngd' reads the Ordnance Survey National Geographic Database (NGD). 'open_then_ngd' reads the open data first and turns to the NGD only when the open data has no record or no name for the street, or when a search finds nothing in it. Postcode lookups are answered from the NGD only, so they are rejected under 'open'. Defaults to 'open_then_ngd'.
21
17
  */
22
- limit?: number | undefined;
18
+ dataset?: StreetDataset | undefined;
23
19
  /**
24
- * Number of properties to skip before the first one returned. Defaults to 0.
20
+ * The street fields to return. When omitted, every field the answering dataset holds is returned. Under `open_then_ngd`, a field named here that the open data lacks for a street is taken from the NGD, and `provenance` then shows which dataset supplied each field. A name is always taken whole from one dataset.
25
21
  */
26
- offset?: number | undefined;
27
- };
28
- export type StreetQueryRequest = {
22
+ fields?: Array<StreetField> | undefined;
29
23
  /**
30
24
  * Which streets to return, given as one of five identifier types. Set `type` to `usrn`, `uprn`, `coordinates`, `name` or `postcode` and supply that type's own fields.
31
25
  */
32
26
  identifier: StreetQueryByCoordinates | StreetQueryByName | StreetQueryByPostcode | StreetQueryByUprn | StreetQueryByUsrn;
33
27
  /**
34
- * Ask for the addressable properties on each matched street. Defaults to false.
28
+ * Return the properties on each street under `properties`, as UPRNs. Defaults to false. Paged by `propertyOptions`.
35
29
  */
36
30
  includeProperties?: boolean | undefined;
37
31
  /**
38
- * Ask for the property counts and classification breakdown for each matched street. Defaults to false.
32
+ * Return the number of properties on each street as `propertyCount`. Defaults to false.
39
33
  */
40
34
  includeStatistics?: boolean | undefined;
41
35
  /**
42
- * How to page and filter the property list, when `includeProperties` is set.
36
+ * How to page and filter each street's property list. Accepted only when `includeProperties` is true.
37
+ */
38
+ propertyOptions?: StreetPropertyOptions | undefined;
39
+ /**
40
+ * Cursor for the next page: the `id` of the last street on the current page. Applies to name, coordinate and postcode lookups.
43
41
  */
44
- propertyOptions?: PropertyOptions | undefined;
42
+ startingAfter?: string | undefined;
45
43
  };
46
44
  /** @internal */
47
45
  export type Identifier$Outbound = StreetQueryByCoordinates$Outbound | StreetQueryByName$Outbound | StreetQueryByPostcode$Outbound | StreetQueryByUprn$Outbound | StreetQueryByUsrn$Outbound;
@@ -49,20 +47,14 @@ export type Identifier$Outbound = StreetQueryByCoordinates$Outbound | StreetQuer
49
47
  export declare const Identifier$outboundSchema: z.ZodType<Identifier$Outbound, z.ZodTypeDef, Identifier>;
50
48
  export declare function identifierToJSON(identifier: Identifier): string;
51
49
  /** @internal */
52
- export type PropertyOptions$Outbound = {
53
- includeHistoric: boolean;
54
- limit: number;
55
- offset: number;
56
- };
57
- /** @internal */
58
- export declare const PropertyOptions$outboundSchema: z.ZodType<PropertyOptions$Outbound, z.ZodTypeDef, PropertyOptions>;
59
- export declare function propertyOptionsToJSON(propertyOptions: PropertyOptions): string;
60
- /** @internal */
61
50
  export type StreetQueryRequest$Outbound = {
51
+ dataset: string;
52
+ fields?: Array<string> | undefined;
62
53
  identifier: StreetQueryByCoordinates$Outbound | StreetQueryByName$Outbound | StreetQueryByPostcode$Outbound | StreetQueryByUprn$Outbound | StreetQueryByUsrn$Outbound;
63
54
  includeProperties: boolean;
64
55
  includeStatistics: boolean;
65
- propertyOptions?: PropertyOptions$Outbound | undefined;
56
+ propertyOptions?: StreetPropertyOptions$Outbound | undefined;
57
+ starting_after?: string | undefined;
66
58
  };
67
59
  /** @internal */
68
60
  export declare const StreetQueryRequest$outboundSchema: z.ZodType<StreetQueryRequest$Outbound, z.ZodTypeDef, StreetQueryRequest>;
@@ -1 +1 @@
1
- {"version":3,"file":"streetqueryrequest.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryrequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EACL,wBAAwB,EACxB,iCAAiC,EAElC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,qBAAqB,EACrB,8BAA8B,EAE/B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,UAAU,EACN,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,CAAC;IACtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,mBAAmB,GAC3B,iCAAiC,GACjC,0BAA0B,GAC1B,8BAA8B,GAC9B,0BAA0B,GAC1B,0BAA0B,CAAC;AAE/B,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,UAAU,CAOV,CAAC;AAEH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAE/D;AAED,gBAAgB;AAChB,MAAM,MAAM,wBAAwB,GAAG;IACrC,eAAe,EAAE,OAAO,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,eAAe,CAKf,CAAC;AAEH,wBAAgB,qBAAqB,CACnC,eAAe,EAAE,eAAe,GAC/B,MAAM,CAER;AAED,gBAAgB;AAChB,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EACN,iCAAiC,GACjC,0BAA0B,GAC1B,8BAA8B,GAC9B,0BAA0B,GAC1B,0BAA0B,CAAC;IAC/B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,eAAe,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;CACxD,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,kBAAkB,CAYlB,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,kBAAkB,EAAE,kBAAkB,GACrC,MAAM,CAIR"}
1
+ {"version":3,"file":"streetqueryrequest.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryrequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EACL,aAAa,EAEd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAA8B,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EACL,qBAAqB,EACrB,8BAA8B,EAE/B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,EAElC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,qBAAqB,EACrB,8BAA8B,EAE/B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,CAAC;AAEtB,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,UAAU,EACN,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,CAAC;IACtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,eAAe,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;IACpD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,mBAAmB,GAC3B,iCAAiC,GACjC,0BAA0B,GAC1B,8BAA8B,GAC9B,0BAA0B,GAC1B,0BAA0B,CAAC;AAE/B,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,UAAU,CAOV,CAAC;AAEH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAE/D;AAED,gBAAgB;AAChB,MAAM,MAAM,2BAA2B,GAAG;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACnC,UAAU,EACN,iCAAiC,GACjC,0BAA0B,GAC1B,8BAA8B,GAC9B,0BAA0B,GAC1B,0BAA0B,CAAC;IAC/B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,eAAe,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAC;IAC7D,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,kBAAkB,CAmBlB,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,kBAAkB,EAAE,kBAAkB,GACrC,MAAM,CAIR"}
@@ -2,6 +2,10 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
  import * as z from "zod/v3";
5
+ import { remap as remap$ } from "../../../lib/primitives.js";
6
+ import { StreetDataset$outboundSchema, } from "./streetdataset.js";
7
+ import { StreetField$outboundSchema } from "./streetfield.js";
8
+ import { StreetPropertyOptions$outboundSchema, } from "./streetpropertyoptions.js";
5
9
  import { StreetQueryByCoordinates$outboundSchema, } from "./streetquerybycoordinates.js";
6
10
  import { StreetQueryByName$outboundSchema, } from "./streetquerybyname.js";
7
11
  import { StreetQueryByPostcode$outboundSchema, } from "./streetquerybypostcode.js";
@@ -19,16 +23,9 @@ export function identifierToJSON(identifier) {
19
23
  return JSON.stringify(Identifier$outboundSchema.parse(identifier));
20
24
  }
21
25
  /** @internal */
22
- export const PropertyOptions$outboundSchema = z.object({
23
- includeHistoric: z.boolean().default(false),
24
- limit: z.number().default(100),
25
- offset: z.number().default(0),
26
- });
27
- export function propertyOptionsToJSON(propertyOptions) {
28
- return JSON.stringify(PropertyOptions$outboundSchema.parse(propertyOptions));
29
- }
30
- /** @internal */
31
26
  export const StreetQueryRequest$outboundSchema = z.object({
27
+ dataset: StreetDataset$outboundSchema.default("open_then_ngd"),
28
+ fields: z.array(StreetField$outboundSchema).optional(),
32
29
  identifier: z.union([
33
30
  StreetQueryByCoordinates$outboundSchema,
34
31
  StreetQueryByName$outboundSchema,
@@ -38,7 +35,12 @@ export const StreetQueryRequest$outboundSchema = z.object({
38
35
  ]),
39
36
  includeProperties: z.boolean().default(false),
40
37
  includeStatistics: z.boolean().default(false),
41
- propertyOptions: z.lazy(() => PropertyOptions$outboundSchema).optional(),
38
+ propertyOptions: StreetPropertyOptions$outboundSchema.optional(),
39
+ startingAfter: z.string().optional(),
40
+ }).transform((v) => {
41
+ return remap$(v, {
42
+ startingAfter: "starting_after",
43
+ });
42
44
  });
43
45
  export function streetQueryRequestToJSON(streetQueryRequest) {
44
46
  return JSON.stringify(StreetQueryRequest$outboundSchema.parse(streetQueryRequest));
@@ -1 +1 @@
1
- {"version":3,"file":"streetqueryrequest.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryrequest.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAGL,uCAAuC,GACxC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAGL,gCAAgC,GACjC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAGL,oCAAoC,GACrC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAGL,gCAAgC,GACjC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAGL,gCAAgC,GACjC,MAAM,wBAAwB,CAAC;AA8DhC,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAIlC,CAAC,CAAC,KAAK,CAAC;IACV,uCAAuC;IACvC,gCAAgC;IAChC,oCAAoC;IACpC,gCAAgC;IAChC,gCAAgC;CACjC,CAAC,CAAC;AAEH,MAAM,UAAU,gBAAgB,CAAC,UAAsB;IACrD,OAAO,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;AACrE,CAAC;AASD,gBAAgB;AAChB,MAAM,CAAC,MAAM,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC3C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC;IAC9B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;CAC9B,CAAC,CAAC;AAEH,MAAM,UAAU,qBAAqB,CACnC,eAAgC;IAEhC,OAAO,IAAI,CAAC,SAAS,CAAC,8BAA8B,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;AAC/E,CAAC;AAeD,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC;QAClB,uCAAuC;QACvC,gCAAgC;QAChC,oCAAoC;QACpC,gCAAgC;QAChC,gCAAgC;KACjC,CAAC;IACF,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC7C,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC7C,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,8BAA8B,CAAC,CAAC,QAAQ,EAAE;CACzE,CAAC,CAAC;AAEH,MAAM,UAAU,wBAAwB,CACtC,kBAAsC;IAEtC,OAAO,IAAI,CAAC,SAAS,CACnB,iCAAiC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAC5D,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"streetqueryrequest.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryrequest.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAEL,4BAA4B,GAC7B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAe,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAGL,oCAAoC,GACrC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAGL,uCAAuC,GACxC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAGL,gCAAgC,GACjC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAGL,oCAAoC,GACrC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAGL,gCAAgC,GACjC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAGL,gCAAgC,GACjC,MAAM,wBAAwB,CAAC;AAwDhC,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAIlC,CAAC,CAAC,KAAK,CAAC;IACV,uCAAuC;IACvC,gCAAgC;IAChC,oCAAoC;IACpC,gCAAgC;IAChC,gCAAgC;CACjC,CAAC,CAAC;AAEH,MAAM,UAAU,gBAAgB,CAAC,UAAsB;IACrD,OAAO,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;AACrE,CAAC;AAkBD,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,4BAA4B,CAAC,OAAO,CAAC,eAAe,CAAC;IAC9D,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,QAAQ,EAAE;IACtD,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC;QAClB,uCAAuC;QACvC,gCAAgC;QAChC,oCAAoC;QACpC,gCAAgC;QAChC,gCAAgC;KACjC,CAAC;IACF,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC7C,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC7C,eAAe,EAAE,oCAAoC,CAAC,QAAQ,EAAE;IAChE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,aAAa,EAAE,gBAAgB;KAChC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,wBAAwB,CACtC,kBAAsC;IAEtC,OAAO,IAAI,CAAC,SAAS,CACnB,iCAAiC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAC5D,CAAC;AACJ,CAAC"}
@@ -2,9 +2,7 @@ import * as z from "zod/v3";
2
2
  import { ClosedEnum } from "../../types/enums.js";
3
3
  import { Result as SafeParseResult } from "../../types/fp.js";
4
4
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
- import { PropertyOnStreet } from "./propertyonstreet.js";
6
- import { StreetDetails } from "./streetdetails.js";
7
- import { StreetStatistics } from "./streetstatistics.js";
5
+ import { StreetRecord } from "./streetrecord.js";
8
6
  /**
9
7
  * Object type discriminator. Always `list`.
10
8
  */
@@ -16,10 +14,14 @@ export declare const StreetQueryResponseObject: {
16
14
  */
17
15
  export type StreetQueryResponseObject = ClosedEnum<typeof StreetQueryResponseObject>;
18
16
  export type StreetQueryResponse = {
17
+ /**
18
+ * The attribution that must be shown wherever the open-data street fields in this response are displayed. Present when at least one returned street carries open data.
19
+ */
20
+ attribution?: string | undefined;
19
21
  /**
20
22
  * The items on this page.
21
23
  */
22
- data: Array<StreetDetails>;
24
+ data: Array<StreetRecord>;
23
25
  /**
24
26
  * True when further items exist beyond this page.
25
27
  */
@@ -32,16 +34,6 @@ export type StreetQueryResponse = {
32
34
  * Object type discriminator. Always `list`.
33
35
  */
34
36
  object: StreetQueryResponseObject;
35
- /**
36
- * The addressable properties on the matched streets. Not present in every response.
37
- */
38
- properties?: Array<PropertyOnStreet> | undefined;
39
- /**
40
- * Property counts for each matched street, keyed by USRN. Not present in every response.
41
- */
42
- statistics?: {
43
- [k: string]: StreetStatistics;
44
- } | undefined;
45
37
  /**
46
38
  * Total number of items matching the request across all pages.
47
39
  */
@@ -1 +1 @@
1
- {"version":3,"file":"streetqueryresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,gBAAgB,EAEjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAA+B,MAAM,oBAAoB,CAAC;AAChF,OAAO,EACL,gBAAgB,EAEjB,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,yBAAyB;;CAE5B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,UAAU,CAChD,OAAO,yBAAyB,CACjC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC;IACjD;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,GAAG,SAAS,CAAC;IAC3D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,aAAa,CACnE,OAAO,yBAAyB,CACS,CAAC;AAE5C,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAeP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D"}
1
+ {"version":3,"file":"streetqueryresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,YAAY,EAA8B,MAAM,mBAAmB,CAAC;AAE7E;;GAEG;AACH,eAAO,MAAM,yBAAyB;;CAE5B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,UAAU,CAChD,OAAO,yBAAyB,CACjC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAC1B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,aAAa,CACnE,OAAO,yBAAyB,CACS,CAAC;AAE5C,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D"}
@@ -4,9 +4,7 @@
4
4
  import * as z from "zod/v3";
5
5
  import { remap as remap$ } from "../../../lib/primitives.js";
6
6
  import { safeParse } from "../../../lib/schemas.js";
7
- import { PropertyOnStreet$inboundSchema, } from "./propertyonstreet.js";
8
- import { StreetDetails$inboundSchema } from "./streetdetails.js";
9
- import { StreetStatistics$inboundSchema, } from "./streetstatistics.js";
7
+ import { StreetRecord$inboundSchema } from "./streetrecord.js";
10
8
  /**
11
9
  * Object type discriminator. Always `list`.
12
10
  */
@@ -17,12 +15,11 @@ export const StreetQueryResponseObject = {
17
15
  export const StreetQueryResponseObject$inboundSchema = z.nativeEnum(StreetQueryResponseObject);
18
16
  /** @internal */
19
17
  export const StreetQueryResponse$inboundSchema = z.object({
20
- data: z.array(StreetDetails$inboundSchema),
18
+ attribution: z.string().optional(),
19
+ data: z.array(StreetRecord$inboundSchema),
21
20
  has_more: z.boolean(),
22
21
  message: z.string().optional(),
23
22
  object: StreetQueryResponseObject$inboundSchema,
24
- properties: z.array(PropertyOnStreet$inboundSchema).optional(),
25
- statistics: z.record(StreetStatistics$inboundSchema).optional(),
26
23
  total_count: z.number().optional(),
27
24
  url: z.string(),
28
25
  }).transform((v) => {
@@ -1 +1 @@
1
- {"version":3,"file":"streetqueryresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAIpD,OAAO,EAEL,8BAA8B,GAC/B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAiB,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AAChF,OAAO,EAEL,8BAA8B,GAC/B,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,IAAI,EAAE,MAAM;CACJ,CAAC;AA2CX,gBAAgB;AAChB,MAAM,CAAC,MAAM,uCAAuC,GAEhD,CAAC,CAAC,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAE5C,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC;IAC1C,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,MAAM,EAAE,uCAAuC;IAC/C,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,QAAQ,EAAE;IAC9D,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAAC,QAAQ,EAAE;IAC/D,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,UAAU,EAAE,SAAS;QACrB,aAAa,EAAE,YAAY;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,2BAA2B,CACzC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAiC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC7D,iDAAiD,CAClD,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"streetqueryresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAIpD,OAAO,EAAgB,0BAA0B,EAAE,MAAM,mBAAmB,CAAC;AAE7E;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,IAAI,EAAE,MAAM;CACJ,CAAC;AAuCX,gBAAgB;AAChB,MAAM,CAAC,MAAM,uCAAuC,GAEhD,CAAC,CAAC,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAE5C,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC;IACzC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,MAAM,EAAE,uCAAuC;IAC/C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,UAAU,EAAE,SAAS;QACrB,aAAa,EAAE,YAAY;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,2BAA2B,CACzC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAiC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC7D,iDAAiD,CAClD,CAAC;AACJ,CAAC"}