@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
@@ -52,7 +52,7 @@ export class Sites extends ClientSDK {
52
52
  * Get site by ID
53
53
  *
54
54
  * @remarks
55
- * Retrieve one registered title by its identifier, which joins the country, the registry and the title number with colons, as in `GB:NPS:AGL123456`. This endpoint returns every attribute, including the boundary geometry, ownership, property statistics, planning statistics and area metrics.
55
+ * Retrieve one registered title by its identifier, which joins the country, the registry and the title number with colons, as in `GB:LR:AGL123456`. This endpoint returns every attribute, including the boundary geometry, ownership, property statistics, planning statistics and area metrics.
56
56
  */
57
57
  async get(request, options) {
58
58
  return unwrapAsync(sitesGet(this, request, options));
@@ -5,7 +5,7 @@ export declare class Streets extends ClientSDK {
5
5
  * Query streets by any identifier
6
6
  *
7
7
  * @remarks
8
- * Returns the streets picked out by one of five identifiers: a USRN, a UPRN, a coordinate and radius, a name search, or a postcode. Each street comes back with its reference number, the coordinates of its start and end, and its name in each language it is recorded in. When an identifier matches no street, the response is an empty list with a `message` explaining which one missed.
8
+ * Returns the streets picked out by one of five identifiers: a USRN, a UPRN, a coordinate and radius, a name search, or a postcode. Each street comes back with its reference number, the dataset that supplied it, its name in each language it is recorded in, its place names and a representative point. `dataset` chooses between Ordnance Survey open data, the Ordnance Survey National Geographic Database (NGD), or open data with the NGD answering only where the open data has nothing. Name, coordinate and postcode lookups are paged: pass the `id` of the last street as `starting_after` while `has_more` is true. Responses that carry open data include the `attribution` that must be shown with it. When an identifier matches no street, the response is an empty list with a `message` explaining which one missed.
9
9
  */
10
10
  searchStreets(request?: shared.StreetQueryRequest | undefined, options?: RequestOptions): Promise<shared.StreetQueryResponse>;
11
11
  }
@@ -9,7 +9,7 @@ export class Streets extends ClientSDK {
9
9
  * Query streets by any identifier
10
10
  *
11
11
  * @remarks
12
- * Returns the streets picked out by one of five identifiers: a USRN, a UPRN, a coordinate and radius, a name search, or a postcode. Each street comes back with its reference number, the coordinates of its start and end, and its name in each language it is recorded in. When an identifier matches no street, the response is an empty list with a `message` explaining which one missed.
12
+ * Returns the streets picked out by one of five identifiers: a USRN, a UPRN, a coordinate and radius, a name search, or a postcode. Each street comes back with its reference number, the dataset that supplied it, its name in each language it is recorded in, its place names and a representative point. `dataset` chooses between Ordnance Survey open data, the Ordnance Survey National Geographic Database (NGD), or open data with the NGD answering only where the open data has nothing. Name, coordinate and postcode lookups are paged: pass the `id` of the last street as `starting_after` while `has_more` is true. Responses that carry open data include the `attribution` that must be shown with it. When an identifier matches no street, the response is an empty list with a `message` explaining which one missed.
13
13
  */
14
14
  async searchStreets(request, options) {
15
15
  return unwrapAsync(streetsSearchStreets(this, request, options));
@@ -14,7 +14,7 @@ dotenv.config();
14
14
  import { SDK } from "@vepler/sdk";
15
15
 
16
16
  const sdk = new SDK({
17
- apiKeyAuth: "vepler_api_YOUR_KEY_HERE",
17
+ apiKeyAuth: "vpr_live_YOUR_KEY_HERE",
18
18
  });
19
19
 
20
20
  async function main() {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vepler/sdk",
3
- "version": "6.1.0",
3
+ "version": "6.36.0",
4
4
  "author": "Vepler Limited",
5
5
  "type": "module",
6
6
  "tshy": {
@@ -29,7 +29,7 @@ import { Result } from "../sdk/types/fp.js";
29
29
  * Everything containing this area
30
30
  *
31
31
  * @remarks
32
- * Walks the whole way up in one read: the containing area at every tier, with how many hops away it is and the worst fit along that path. Check `minFit` before aggregating — an LSOA reaches its local authority by best fit in the current release, because the exact-fit spine exists only at the 2022 boundaries.
32
+ * Walks the whole way up in one read: the containing area at every tier, with how many hops away it is and the worst fit along that path. Check `minFit` before aggregating: an LSOA reaches its local authority by best fit in the current release, because the exact-fit spine exists only at the 2022 boundaries.
33
33
  */
34
34
  export function geographyGetGeographyAncestors(
35
35
  client: SDKCore,
@@ -29,7 +29,7 @@ import { Result } from "../sdk/types/fp.js";
29
29
  * Look up areas by code
30
30
  *
31
31
  * @remarks
32
- * Resolves up to 100 comma-separated GSS codes to their name, type, vintage, nation and tier. A code can legitimately exist at more than one layer or edition, so every match is returned — narrow with `areaType` when a single answer is wanted.
32
+ * Resolves up to 100 comma-separated GSS codes to their name, type, vintage, nation and tier. A code can legitimately exist at more than one layer or edition, so every match is returned. Narrow with `areaType` when you want a single answer.
33
33
  */
34
34
  export function geographyGetGeographyAreas(
35
35
  client: SDKCore,
@@ -29,7 +29,7 @@ import { Result } from "../sdk/types/fp.js";
29
29
  * Everything inside this area
30
30
  *
31
31
  * @remarks
32
- * Paged, because the honest answer can be very large — England and Wales hold 188,880 Output Areas. `total_count` reports the full size of the set being paged through. Note that every unitary authority is both a district and a county under one code, so narrow with `areaType` or each descendant is returned once per matching type.
32
+ * Paged, because the set can be very large: England and Wales hold 188,880 Output Areas. `total_count` reports the full size of the set being paged through. Note that every unitary authority is both a district and a county under one code, so narrow with `areaType` or each descendant is returned once per matching type.
33
33
  */
34
34
  export function geographyGetGeographyDescendants(
35
35
  client: SDKCore,
@@ -29,7 +29,7 @@ import { Result } from "../sdk/types/fp.js";
29
29
  * Where this area's record came from
30
30
  *
31
31
  * @remarks
32
- * The publisher, the pinned file, its licence, and the acknowledgement line that licence requires — verbatim, because the wording differs per custodian and anyone redistributing this data has to reproduce it. `sha256` identifies the exact file the record was parsed from; `fromArchive` is true when the publisher was unreachable and the bytes came from our own archive.
32
+ * The publisher, the pinned file, its licence, and the acknowledgement line that licence requires, verbatim, because the wording differs per custodian and anyone redistributing this data has to reproduce it. `sha256` identifies the exact file the record was parsed from; `fromArchive` is true when the publisher was unreachable and the file came from Vepler's archive.
33
33
  */
34
34
  export function geographyGetGeographyProvenance(
35
35
  client: SDKCore,
@@ -27,7 +27,7 @@ import { Result } from "../sdk/types/fp.js";
27
27
  * Get the current geography release
28
28
  *
29
29
  * @remarks
30
- * Returns the release every other geography endpoint answers from unless one is pinned. A release is a named set of publisher vintages that compose into one consistent tree — the nations publish on their own cycles, so a UK-wide release is a composition rather than a date.
30
+ * Returns the release every other geography endpoint answers from unless one is pinned. A release is a named set of publisher vintages that compose into one consistent tree. The nations publish on their own cycles, so a UK-wide release is a composition rather than a date.
31
31
  */
32
32
  export function geographyGetGeographyRelease(
33
33
  client: SDKCore,
@@ -0,0 +1,154 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { SDKCore } from "../core.js";
6
+ import { matchStatusCode } from "../lib/http.js";
7
+ import * as M from "../lib/matchers.js";
8
+ import { compactMap } from "../lib/primitives.js";
9
+ import { RequestOptions } from "../lib/sdks.js";
10
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
11
+ import { pathToFunc } from "../lib/url.js";
12
+ import {
13
+ ConnectionError,
14
+ InvalidRequestError,
15
+ RequestAbortedError,
16
+ RequestTimeoutError,
17
+ UnexpectedClientError,
18
+ } from "../sdk/models/errors/httpclienterrors.js";
19
+ import * as errors from "../sdk/models/errors/index.js";
20
+ import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
21
+ import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
22
+ import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
23
+ import * as shared from "../sdk/models/shared/index.js";
24
+ import { APICall, APIPromise } from "../sdk/types/async.js";
25
+ import { Result } from "../sdk/types/fp.js";
26
+
27
+ /**
28
+ * List models
29
+ *
30
+ * @remarks
31
+ * Lists the models that can be run, each with what it reads and the JSON Schema of the result it returns. Listing models is free.
32
+ */
33
+ export function modelsGetV1AiModels(
34
+ client: SDKCore,
35
+ options?: RequestOptions,
36
+ ): APIPromise<
37
+ Result<
38
+ shared.ModelList,
39
+ | errors.ModelApiError
40
+ | SDKBaseError
41
+ | ResponseValidationError
42
+ | ConnectionError
43
+ | RequestAbortedError
44
+ | RequestTimeoutError
45
+ | InvalidRequestError
46
+ | UnexpectedClientError
47
+ | SDKValidationError
48
+ >
49
+ > {
50
+ return new APIPromise($do(
51
+ client,
52
+ options,
53
+ ));
54
+ }
55
+
56
+ async function $do(
57
+ client: SDKCore,
58
+ options?: RequestOptions,
59
+ ): Promise<
60
+ [
61
+ Result<
62
+ shared.ModelList,
63
+ | errors.ModelApiError
64
+ | SDKBaseError
65
+ | ResponseValidationError
66
+ | ConnectionError
67
+ | RequestAbortedError
68
+ | RequestTimeoutError
69
+ | InvalidRequestError
70
+ | UnexpectedClientError
71
+ | SDKValidationError
72
+ >,
73
+ APICall,
74
+ ]
75
+ > {
76
+ const path = pathToFunc("/v1/ai/models")();
77
+
78
+ const headers = new Headers(compactMap({
79
+ Accept: "application/json",
80
+ }));
81
+
82
+ const secConfig = await extractSecurity(client._options.apiKeyAuth);
83
+ const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
84
+ const requestSecurity = resolveGlobalSecurity(securityInput);
85
+
86
+ const context = {
87
+ options: client._options,
88
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
89
+ operationID: "get_/v1/ai/models",
90
+ oAuth2Scopes: null,
91
+
92
+ resolvedSecurity: requestSecurity,
93
+
94
+ securitySource: client._options.apiKeyAuth,
95
+ retryConfig: options?.retries
96
+ || client._options.retryConfig
97
+ || { strategy: "none" },
98
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
99
+ };
100
+
101
+ const requestRes = client._createRequest(context, {
102
+ security: requestSecurity,
103
+ method: "GET",
104
+ baseURL: options?.serverURL,
105
+ path: path,
106
+ headers: headers,
107
+ userAgent: client._options.userAgent,
108
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
109
+ }, options);
110
+ if (!requestRes.ok) {
111
+ return [requestRes, { status: "invalid" }];
112
+ }
113
+ const req = requestRes.value;
114
+
115
+ const doResult = await client._do(req, {
116
+ context,
117
+ isErrorStatusCode: (statusCode: number) =>
118
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
119
+ retryConfig: context.retryConfig,
120
+ retryCodes: context.retryCodes,
121
+ });
122
+ if (!doResult.ok) {
123
+ return [doResult, { status: "request-error", request: req }];
124
+ }
125
+ const response = doResult.value;
126
+
127
+ const responseFields = {
128
+ HttpMeta: { Response: response, Request: req },
129
+ };
130
+
131
+ const [result] = await M.match<
132
+ shared.ModelList,
133
+ | errors.ModelApiError
134
+ | SDKBaseError
135
+ | ResponseValidationError
136
+ | ConnectionError
137
+ | RequestAbortedError
138
+ | RequestTimeoutError
139
+ | InvalidRequestError
140
+ | UnexpectedClientError
141
+ | SDKValidationError
142
+ >(
143
+ M.json(200, shared.ModelList$inboundSchema),
144
+ M.jsonErr([401, 403, 429], errors.ModelApiError$inboundSchema),
145
+ M.jsonErr(500, errors.ModelApiError$inboundSchema),
146
+ M.fail("4XX"),
147
+ M.fail("5XX"),
148
+ )(response, req, { extraFields: responseFields });
149
+ if (!result.ok) {
150
+ return [result, { status: "complete", request: req, response }];
151
+ }
152
+
153
+ return [result, { status: "complete", request: req, response }];
154
+ }
@@ -0,0 +1,178 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { SDKCore } from "../core.js";
6
+ import { encodeSimple } from "../lib/encodings.js";
7
+ import { matchStatusCode } from "../lib/http.js";
8
+ import * as M from "../lib/matchers.js";
9
+ import { compactMap } from "../lib/primitives.js";
10
+ import { safeParse } from "../lib/schemas.js";
11
+ import { RequestOptions } from "../lib/sdks.js";
12
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
13
+ import { pathToFunc } from "../lib/url.js";
14
+ import {
15
+ ConnectionError,
16
+ InvalidRequestError,
17
+ RequestAbortedError,
18
+ RequestTimeoutError,
19
+ UnexpectedClientError,
20
+ } from "../sdk/models/errors/httpclienterrors.js";
21
+ import * as errors from "../sdk/models/errors/index.js";
22
+ import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
23
+ import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
24
+ import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
25
+ import * as operations from "../sdk/models/operations/index.js";
26
+ import * as shared from "../sdk/models/shared/index.js";
27
+ import { APICall, APIPromise } from "../sdk/types/async.js";
28
+ import { Result } from "../sdk/types/fp.js";
29
+
30
+ /**
31
+ * Retrieve a model
32
+ *
33
+ * @remarks
34
+ * Returns one model, with what it reads and the JSON Schema of the result it returns. Free.
35
+ */
36
+ export function modelsGetV1AiModelsModel(
37
+ client: SDKCore,
38
+ request: operations.GetV1AiModelsModelRequest,
39
+ options?: RequestOptions,
40
+ ): APIPromise<
41
+ Result<
42
+ shared.Model,
43
+ | errors.ModelApiError
44
+ | SDKBaseError
45
+ | ResponseValidationError
46
+ | ConnectionError
47
+ | RequestAbortedError
48
+ | RequestTimeoutError
49
+ | InvalidRequestError
50
+ | UnexpectedClientError
51
+ | SDKValidationError
52
+ >
53
+ > {
54
+ return new APIPromise($do(
55
+ client,
56
+ request,
57
+ options,
58
+ ));
59
+ }
60
+
61
+ async function $do(
62
+ client: SDKCore,
63
+ request: operations.GetV1AiModelsModelRequest,
64
+ options?: RequestOptions,
65
+ ): Promise<
66
+ [
67
+ Result<
68
+ shared.Model,
69
+ | errors.ModelApiError
70
+ | SDKBaseError
71
+ | ResponseValidationError
72
+ | ConnectionError
73
+ | RequestAbortedError
74
+ | RequestTimeoutError
75
+ | InvalidRequestError
76
+ | UnexpectedClientError
77
+ | SDKValidationError
78
+ >,
79
+ APICall,
80
+ ]
81
+ > {
82
+ const parsed = safeParse(
83
+ request,
84
+ (value) => operations.GetV1AiModelsModelRequest$outboundSchema.parse(value),
85
+ "Input validation failed",
86
+ );
87
+ if (!parsed.ok) {
88
+ return [parsed, { status: "invalid" }];
89
+ }
90
+ const payload = parsed.value;
91
+ const body = null;
92
+
93
+ const pathParams = {
94
+ model: encodeSimple("model", payload.model, {
95
+ explode: false,
96
+ charEncoding: "percent",
97
+ }),
98
+ };
99
+ const path = pathToFunc("/v1/ai/models/{model}")(pathParams);
100
+
101
+ const headers = new Headers(compactMap({
102
+ Accept: "application/json",
103
+ }));
104
+
105
+ const secConfig = await extractSecurity(client._options.apiKeyAuth);
106
+ const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
107
+ const requestSecurity = resolveGlobalSecurity(securityInput);
108
+
109
+ const context = {
110
+ options: client._options,
111
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
112
+ operationID: "get_/v1/ai/models/{model}",
113
+ oAuth2Scopes: null,
114
+
115
+ resolvedSecurity: requestSecurity,
116
+
117
+ securitySource: client._options.apiKeyAuth,
118
+ retryConfig: options?.retries
119
+ || client._options.retryConfig
120
+ || { strategy: "none" },
121
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
122
+ };
123
+
124
+ const requestRes = client._createRequest(context, {
125
+ security: requestSecurity,
126
+ method: "GET",
127
+ baseURL: options?.serverURL,
128
+ path: path,
129
+ headers: headers,
130
+ body: body,
131
+ userAgent: client._options.userAgent,
132
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
133
+ }, options);
134
+ if (!requestRes.ok) {
135
+ return [requestRes, { status: "invalid" }];
136
+ }
137
+ const req = requestRes.value;
138
+
139
+ const doResult = await client._do(req, {
140
+ context,
141
+ isErrorStatusCode: (statusCode: number) =>
142
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
143
+ retryConfig: context.retryConfig,
144
+ retryCodes: context.retryCodes,
145
+ });
146
+ if (!doResult.ok) {
147
+ return [doResult, { status: "request-error", request: req }];
148
+ }
149
+ const response = doResult.value;
150
+
151
+ const responseFields = {
152
+ HttpMeta: { Response: response, Request: req },
153
+ };
154
+
155
+ const [result] = await M.match<
156
+ shared.Model,
157
+ | errors.ModelApiError
158
+ | SDKBaseError
159
+ | ResponseValidationError
160
+ | ConnectionError
161
+ | RequestAbortedError
162
+ | RequestTimeoutError
163
+ | InvalidRequestError
164
+ | UnexpectedClientError
165
+ | SDKValidationError
166
+ >(
167
+ M.json(200, shared.Model$inboundSchema),
168
+ M.jsonErr([401, 403, 404, 429], errors.ModelApiError$inboundSchema),
169
+ M.jsonErr(500, errors.ModelApiError$inboundSchema),
170
+ M.fail("4XX"),
171
+ M.fail("5XX"),
172
+ )(response, req, { extraFields: responseFields });
173
+ if (!result.ok) {
174
+ return [result, { status: "complete", request: req, response }];
175
+ }
176
+
177
+ return [result, { status: "complete", request: req, response }];
178
+ }
@@ -0,0 +1,189 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { SDKCore } from "../core.js";
6
+ import { encodeJSON } from "../lib/encodings.js";
7
+ import { matchStatusCode } from "../lib/http.js";
8
+ import * as M from "../lib/matchers.js";
9
+ import { compactMap } from "../lib/primitives.js";
10
+ import { safeParse } from "../lib/schemas.js";
11
+ import { RequestOptions } from "../lib/sdks.js";
12
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
13
+ import { pathToFunc } from "../lib/url.js";
14
+ import {
15
+ ConnectionError,
16
+ InvalidRequestError,
17
+ RequestAbortedError,
18
+ RequestTimeoutError,
19
+ UnexpectedClientError,
20
+ } from "../sdk/models/errors/httpclienterrors.js";
21
+ import * as errors from "../sdk/models/errors/index.js";
22
+ import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
23
+ import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
24
+ import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
25
+ import * as operations from "../sdk/models/operations/index.js";
26
+ import * as shared from "../sdk/models/shared/index.js";
27
+ import { APICall, APIPromise } from "../sdk/types/async.js";
28
+ import { Result } from "../sdk/types/fp.js";
29
+
30
+ export enum PostV1AiChatCompletionsAcceptEnum {
31
+ applicationJson = "application/json",
32
+ textEventStream = "text/event-stream",
33
+ }
34
+
35
+ /**
36
+ * Run a model
37
+ *
38
+ * @remarks
39
+ * Runs a model on one input and returns its result as one JSON object in a standard chat completion. Send exactly one user message holding one image part. Each input is charged once, in credits, and the charge is shown in `usage`. A repeat of a completed request within 15 minutes is served from cache without charge. With `stream: true` the result arrives as server-sent events: one chunk holding the whole result, a usage chunk when `stream_options.include_usage` is true, then `[DONE]`.
40
+ */
41
+ export function modelsPostV1AiChatCompletions(
42
+ client: SDKCore,
43
+ request: shared.ChatCompletionRequest,
44
+ options?: RequestOptions & {
45
+ acceptHeaderOverride?: PostV1AiChatCompletionsAcceptEnum;
46
+ },
47
+ ): APIPromise<
48
+ Result<
49
+ operations.PostV1AiChatCompletionsResponse,
50
+ | errors.ModelApiError
51
+ | SDKBaseError
52
+ | ResponseValidationError
53
+ | ConnectionError
54
+ | RequestAbortedError
55
+ | RequestTimeoutError
56
+ | InvalidRequestError
57
+ | UnexpectedClientError
58
+ | SDKValidationError
59
+ >
60
+ > {
61
+ return new APIPromise($do(
62
+ client,
63
+ request,
64
+ options,
65
+ ));
66
+ }
67
+
68
+ async function $do(
69
+ client: SDKCore,
70
+ request: shared.ChatCompletionRequest,
71
+ options?: RequestOptions & {
72
+ acceptHeaderOverride?: PostV1AiChatCompletionsAcceptEnum;
73
+ },
74
+ ): Promise<
75
+ [
76
+ Result<
77
+ operations.PostV1AiChatCompletionsResponse,
78
+ | errors.ModelApiError
79
+ | SDKBaseError
80
+ | ResponseValidationError
81
+ | ConnectionError
82
+ | RequestAbortedError
83
+ | RequestTimeoutError
84
+ | InvalidRequestError
85
+ | UnexpectedClientError
86
+ | SDKValidationError
87
+ >,
88
+ APICall,
89
+ ]
90
+ > {
91
+ const parsed = safeParse(
92
+ request,
93
+ (value) => shared.ChatCompletionRequest$outboundSchema.parse(value),
94
+ "Input validation failed",
95
+ );
96
+ if (!parsed.ok) {
97
+ return [parsed, { status: "invalid" }];
98
+ }
99
+ const payload = parsed.value;
100
+ const body = encodeJSON("body", payload, { explode: true });
101
+
102
+ const path = pathToFunc("/v1/ai/chat/completions")();
103
+
104
+ const headers = new Headers(compactMap({
105
+ "Content-Type": "application/json",
106
+ Accept: options?.acceptHeaderOverride
107
+ || "application/json;q=1, text/event-stream;q=0",
108
+ }));
109
+
110
+ const secConfig = await extractSecurity(client._options.apiKeyAuth);
111
+ const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
112
+ const requestSecurity = resolveGlobalSecurity(securityInput);
113
+
114
+ const context = {
115
+ options: client._options,
116
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
117
+ operationID: "post_/v1/ai/chat/completions",
118
+ oAuth2Scopes: null,
119
+
120
+ resolvedSecurity: requestSecurity,
121
+
122
+ securitySource: client._options.apiKeyAuth,
123
+ retryConfig: options?.retries
124
+ || client._options.retryConfig
125
+ || { strategy: "none" },
126
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
127
+ };
128
+
129
+ const requestRes = client._createRequest(context, {
130
+ security: requestSecurity,
131
+ method: "POST",
132
+ baseURL: options?.serverURL,
133
+ path: path,
134
+ headers: headers,
135
+ body: body,
136
+ userAgent: client._options.userAgent,
137
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
138
+ }, options);
139
+ if (!requestRes.ok) {
140
+ return [requestRes, { status: "invalid" }];
141
+ }
142
+ const req = requestRes.value;
143
+
144
+ const doResult = await client._do(req, {
145
+ context,
146
+ isErrorStatusCode: (statusCode: number) =>
147
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
148
+ retryConfig: context.retryConfig,
149
+ retryCodes: context.retryCodes,
150
+ });
151
+ if (!doResult.ok) {
152
+ return [doResult, { status: "request-error", request: req }];
153
+ }
154
+ const response = doResult.value;
155
+
156
+ const responseFields = {
157
+ HttpMeta: { Response: response, Request: req },
158
+ };
159
+
160
+ const [result] = await M.match<
161
+ operations.PostV1AiChatCompletionsResponse,
162
+ | errors.ModelApiError
163
+ | SDKBaseError
164
+ | ResponseValidationError
165
+ | ConnectionError
166
+ | RequestAbortedError
167
+ | RequestTimeoutError
168
+ | InvalidRequestError
169
+ | UnexpectedClientError
170
+ | SDKValidationError
171
+ >(
172
+ M.json(200, operations.PostV1AiChatCompletionsResponse$inboundSchema),
173
+ M.text(200, operations.PostV1AiChatCompletionsResponse$inboundSchema, {
174
+ ctype: "text/event-stream",
175
+ }),
176
+ M.jsonErr(
177
+ [400, 401, 402, 403, 404, 413, 429],
178
+ errors.ModelApiError$inboundSchema,
179
+ ),
180
+ M.jsonErr([500, 503], errors.ModelApiError$inboundSchema),
181
+ M.fail("4XX"),
182
+ M.fail("5XX"),
183
+ )(response, req, { extraFields: responseFields });
184
+ if (!result.ok) {
185
+ return [result, { status: "complete", request: req, response }];
186
+ }
187
+
188
+ return [result, { status: "complete", request: req, response }];
189
+ }