@vepler/sdk 1.9.11 → 1.10.1

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 (405) hide show
  1. package/README.md +30 -1
  2. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.d.ts +17 -0
  3. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.d.ts.map +1 -0
  4. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.js +120 -0
  5. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.js.map +1 -0
  6. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.d.ts +17 -0
  7. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.d.ts.map +1 -0
  8. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.js +120 -0
  9. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.js.map +1 -0
  10. package/dist/commonjs/funcs/schoolMetricsGetMetrics.d.ts +17 -0
  11. package/dist/commonjs/funcs/schoolMetricsGetMetrics.d.ts.map +1 -0
  12. package/dist/commonjs/funcs/schoolMetricsGetMetrics.js +130 -0
  13. package/dist/commonjs/funcs/schoolMetricsGetMetrics.js.map +1 -0
  14. package/dist/commonjs/funcs/schoolMetricsListProfiles.d.ts +17 -0
  15. package/dist/commonjs/funcs/schoolMetricsListProfiles.d.ts.map +1 -0
  16. package/dist/commonjs/funcs/schoolMetricsListProfiles.js +104 -0
  17. package/dist/commonjs/funcs/schoolMetricsListProfiles.js.map +1 -0
  18. package/dist/commonjs/funcs/schoolsGet.d.ts +17 -0
  19. package/dist/commonjs/funcs/schoolsGet.d.ts.map +1 -0
  20. package/dist/commonjs/funcs/schoolsGet.js +124 -0
  21. package/dist/commonjs/funcs/schoolsGet.js.map +1 -0
  22. package/dist/commonjs/funcs/schoolsGetBySlug.d.ts +17 -0
  23. package/dist/commonjs/funcs/schoolsGetBySlug.d.ts.map +1 -0
  24. package/dist/commonjs/funcs/schoolsGetBySlug.js +124 -0
  25. package/dist/commonjs/funcs/schoolsGetBySlug.js.map +1 -0
  26. package/dist/commonjs/funcs/schoolsGetByUrn.d.ts +17 -0
  27. package/dist/commonjs/funcs/schoolsGetByUrn.d.ts.map +1 -0
  28. package/dist/commonjs/funcs/schoolsGetByUrn.js +124 -0
  29. package/dist/commonjs/funcs/schoolsGetByUrn.js.map +1 -0
  30. package/dist/commonjs/funcs/schoolsList.d.ts +17 -0
  31. package/dist/commonjs/funcs/schoolsList.d.ts.map +1 -0
  32. package/dist/commonjs/funcs/schoolsList.js +126 -0
  33. package/dist/commonjs/funcs/schoolsList.js.map +1 -0
  34. package/dist/commonjs/funcs/schoolsSearchNearby.d.ts +17 -0
  35. package/dist/commonjs/funcs/schoolsSearchNearby.d.ts.map +1 -0
  36. package/dist/commonjs/funcs/schoolsSearchNearby.js +125 -0
  37. package/dist/commonjs/funcs/schoolsSearchNearby.js.map +1 -0
  38. package/dist/commonjs/funcs/schoolsSearchWithin.d.ts +17 -0
  39. package/dist/commonjs/funcs/schoolsSearchWithin.d.ts.map +1 -0
  40. package/dist/commonjs/funcs/schoolsSearchWithin.js +125 -0
  41. package/dist/commonjs/funcs/schoolsSearchWithin.js.map +1 -0
  42. package/dist/commonjs/lib/config.d.ts +4 -4
  43. package/dist/commonjs/lib/config.d.ts.map +1 -1
  44. package/dist/commonjs/lib/config.js +4 -4
  45. package/dist/commonjs/lib/config.js.map +1 -1
  46. package/dist/commonjs/sdk/models/operations/getmetricprofiles.d.ts +89 -0
  47. package/dist/commonjs/sdk/models/operations/getmetricprofiles.d.ts.map +1 -0
  48. package/dist/commonjs/sdk/models/operations/getmetricprofiles.js +121 -0
  49. package/dist/commonjs/sdk/models/operations/getmetricprofiles.js.map +1 -0
  50. package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts +245 -0
  51. package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts.map +1 -0
  52. package/dist/commonjs/sdk/models/operations/getschoolbyid.js +267 -0
  53. package/dist/commonjs/sdk/models/operations/getschoolbyid.js.map +1 -0
  54. package/dist/commonjs/sdk/models/operations/getschoolbyslug.d.ts +245 -0
  55. package/dist/commonjs/sdk/models/operations/getschoolbyslug.d.ts.map +1 -0
  56. package/dist/commonjs/sdk/models/operations/getschoolbyslug.js +267 -0
  57. package/dist/commonjs/sdk/models/operations/getschoolbyslug.js.map +1 -0
  58. package/dist/commonjs/sdk/models/operations/getschoolbyurn.d.ts +245 -0
  59. package/dist/commonjs/sdk/models/operations/getschoolbyurn.d.ts.map +1 -0
  60. package/dist/commonjs/sdk/models/operations/getschoolbyurn.js +267 -0
  61. package/dist/commonjs/sdk/models/operations/getschoolbyurn.js.map +1 -0
  62. package/dist/commonjs/sdk/models/operations/getschoolmetrics.d.ts +901 -0
  63. package/dist/commonjs/sdk/models/operations/getschoolmetrics.d.ts.map +1 -0
  64. package/dist/commonjs/sdk/models/operations/getschoolmetrics.js +843 -0
  65. package/dist/commonjs/sdk/models/operations/getschoolmetrics.js.map +1 -0
  66. package/dist/commonjs/sdk/models/operations/getv1safetycrime.d.ts +309 -0
  67. package/dist/commonjs/sdk/models/operations/getv1safetycrime.d.ts.map +1 -0
  68. package/dist/commonjs/sdk/models/operations/getv1safetycrime.js +352 -0
  69. package/dist/commonjs/sdk/models/operations/getv1safetycrime.js.map +1 -0
  70. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.d.ts +330 -0
  71. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.d.ts.map +1 -0
  72. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.js +366 -0
  73. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.js.map +1 -0
  74. package/dist/commonjs/sdk/models/operations/index.d.ts +10 -0
  75. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  76. package/dist/commonjs/sdk/models/operations/index.js +10 -0
  77. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  78. package/dist/commonjs/sdk/models/operations/listschools.d.ts +248 -0
  79. package/dist/commonjs/sdk/models/operations/listschools.d.ts.map +1 -0
  80. package/dist/commonjs/sdk/models/operations/listschools.js +262 -0
  81. package/dist/commonjs/sdk/models/operations/listschools.js.map +1 -0
  82. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.d.ts +274 -0
  83. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.d.ts.map +1 -0
  84. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.js +282 -0
  85. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.js.map +1 -0
  86. package/dist/commonjs/sdk/models/operations/searchschoolswithin.d.ts +243 -0
  87. package/dist/commonjs/sdk/models/operations/searchschoolswithin.d.ts.map +1 -0
  88. package/dist/commonjs/sdk/models/operations/searchschoolswithin.js +260 -0
  89. package/dist/commonjs/sdk/models/operations/searchschoolswithin.js.map +1 -0
  90. package/dist/commonjs/sdk/models/shared/index.d.ts +11 -5
  91. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  92. package/dist/commonjs/sdk/models/shared/index.js +11 -5
  93. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  94. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts +1 -1
  95. package/dist/commonjs/sdk/models/shared/propertyareafilter.d.ts +31 -0
  96. package/dist/commonjs/sdk/models/shared/propertyareafilter.d.ts.map +1 -0
  97. package/dist/commonjs/sdk/models/shared/propertyareafilter.js +85 -0
  98. package/dist/commonjs/sdk/models/shared/propertyareafilter.js.map +1 -0
  99. package/dist/commonjs/sdk/models/shared/propertylocationidareafilter.d.ts +32 -0
  100. package/dist/commonjs/sdk/models/shared/propertylocationidareafilter.d.ts.map +1 -0
  101. package/dist/commonjs/sdk/models/shared/propertylocationidareafilter.js +69 -0
  102. package/dist/commonjs/sdk/models/shared/propertylocationidareafilter.js.map +1 -0
  103. package/dist/commonjs/sdk/models/shared/propertymultipolygonareafilter.d.ts +57 -0
  104. package/dist/commonjs/sdk/models/shared/propertymultipolygonareafilter.d.ts.map +1 -0
  105. package/dist/commonjs/sdk/models/shared/{pointareafilter.js → propertymultipolygonareafilter.js} +20 -22
  106. package/dist/commonjs/sdk/models/shared/propertymultipolygonareafilter.js.map +1 -0
  107. package/dist/commonjs/sdk/models/shared/propertyoutcodeareafilter.d.ts +57 -0
  108. package/dist/commonjs/sdk/models/shared/propertyoutcodeareafilter.d.ts.map +1 -0
  109. package/dist/commonjs/sdk/models/shared/propertyoutcodeareafilter.js +89 -0
  110. package/dist/commonjs/sdk/models/shared/propertyoutcodeareafilter.js.map +1 -0
  111. package/dist/commonjs/sdk/models/shared/propertypointareafilter.d.ts +62 -0
  112. package/dist/commonjs/sdk/models/shared/propertypointareafilter.d.ts.map +1 -0
  113. package/dist/commonjs/sdk/models/shared/propertypointareafilter.js +91 -0
  114. package/dist/commonjs/sdk/models/shared/propertypointareafilter.js.map +1 -0
  115. package/dist/commonjs/sdk/models/shared/propertypolygonareafilter.d.ts +57 -0
  116. package/dist/commonjs/sdk/models/shared/propertypolygonareafilter.d.ts.map +1 -0
  117. package/dist/commonjs/sdk/models/shared/propertypolygonareafilter.js +89 -0
  118. package/dist/commonjs/sdk/models/shared/propertypolygonareafilter.js.map +1 -0
  119. package/dist/commonjs/sdk/models/shared/propertypostcodeareafilter.d.ts +62 -0
  120. package/dist/commonjs/sdk/models/shared/propertypostcodeareafilter.d.ts.map +1 -0
  121. package/dist/commonjs/sdk/models/shared/propertypostcodeareafilter.js +91 -0
  122. package/dist/commonjs/sdk/models/shared/propertypostcodeareafilter.js.map +1 -0
  123. package/dist/commonjs/sdk/models/shared/propertyquerycondition.d.ts +146 -0
  124. package/dist/commonjs/sdk/models/shared/propertyquerycondition.d.ts.map +1 -0
  125. package/dist/commonjs/sdk/models/shared/propertyquerycondition.js +173 -0
  126. package/dist/commonjs/sdk/models/shared/propertyquerycondition.js.map +1 -0
  127. package/dist/commonjs/sdk/models/shared/propertyquerygroup.d.ts +33 -0
  128. package/dist/commonjs/sdk/models/shared/propertyquerygroup.d.ts.map +1 -0
  129. package/dist/commonjs/sdk/models/shared/propertyquerygroup.js +70 -0
  130. package/dist/commonjs/sdk/models/shared/propertyquerygroup.js.map +1 -0
  131. package/dist/commonjs/sdk/models/shared/propertyqueryoperator.d.ts +70 -0
  132. package/dist/commonjs/sdk/models/shared/propertyqueryoperator.d.ts.map +1 -0
  133. package/dist/commonjs/sdk/models/shared/propertyqueryoperator.js +95 -0
  134. package/dist/commonjs/sdk/models/shared/propertyqueryoperator.js.map +1 -0
  135. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts +27 -80
  136. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
  137. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js +28 -54
  138. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js.map +1 -1
  139. package/dist/commonjs/sdk/models/shared/school.d.ts +441 -0
  140. package/dist/commonjs/sdk/models/shared/school.d.ts.map +1 -0
  141. package/dist/commonjs/sdk/models/shared/school.js +301 -0
  142. package/dist/commonjs/sdk/models/shared/school.js.map +1 -0
  143. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.d.ts +2 -2
  144. package/dist/commonjs/sdk/safety.d.ts +19 -0
  145. package/dist/commonjs/sdk/safety.d.ts.map +1 -0
  146. package/dist/commonjs/sdk/safety.js +32 -0
  147. package/dist/commonjs/sdk/safety.js.map +1 -0
  148. package/dist/commonjs/sdk/schoolmetrics.d.ts +19 -0
  149. package/dist/commonjs/sdk/schoolmetrics.d.ts.map +1 -0
  150. package/dist/commonjs/sdk/schoolmetrics.js +32 -0
  151. package/dist/commonjs/sdk/schoolmetrics.js.map +1 -0
  152. package/dist/commonjs/sdk/schools.d.ts +47 -0
  153. package/dist/commonjs/sdk/schools.d.ts.map +1 -0
  154. package/dist/commonjs/sdk/schools.js +72 -0
  155. package/dist/commonjs/sdk/schools.js.map +1 -0
  156. package/dist/commonjs/sdk/sdk.d.ts +9 -0
  157. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  158. package/dist/commonjs/sdk/sdk.js +12 -0
  159. package/dist/commonjs/sdk/sdk.js.map +1 -1
  160. package/dist/esm/funcs/safetyGetV1SafetyCrime.d.ts +17 -0
  161. package/dist/esm/funcs/safetyGetV1SafetyCrime.d.ts.map +1 -0
  162. package/dist/esm/funcs/safetyGetV1SafetyCrime.js +84 -0
  163. package/dist/esm/funcs/safetyGetV1SafetyCrime.js.map +1 -0
  164. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.d.ts +17 -0
  165. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.d.ts.map +1 -0
  166. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.js +84 -0
  167. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.js.map +1 -0
  168. package/dist/esm/funcs/schoolMetricsGetMetrics.d.ts +17 -0
  169. package/dist/esm/funcs/schoolMetricsGetMetrics.d.ts.map +1 -0
  170. package/dist/esm/funcs/schoolMetricsGetMetrics.js +94 -0
  171. package/dist/esm/funcs/schoolMetricsGetMetrics.js.map +1 -0
  172. package/dist/esm/funcs/schoolMetricsListProfiles.d.ts +17 -0
  173. package/dist/esm/funcs/schoolMetricsListProfiles.d.ts.map +1 -0
  174. package/dist/esm/funcs/schoolMetricsListProfiles.js +68 -0
  175. package/dist/esm/funcs/schoolMetricsListProfiles.js.map +1 -0
  176. package/dist/esm/funcs/schoolsGet.d.ts +17 -0
  177. package/dist/esm/funcs/schoolsGet.d.ts.map +1 -0
  178. package/dist/esm/funcs/schoolsGet.js +88 -0
  179. package/dist/esm/funcs/schoolsGet.js.map +1 -0
  180. package/dist/esm/funcs/schoolsGetBySlug.d.ts +17 -0
  181. package/dist/esm/funcs/schoolsGetBySlug.d.ts.map +1 -0
  182. package/dist/esm/funcs/schoolsGetBySlug.js +88 -0
  183. package/dist/esm/funcs/schoolsGetBySlug.js.map +1 -0
  184. package/dist/esm/funcs/schoolsGetByUrn.d.ts +17 -0
  185. package/dist/esm/funcs/schoolsGetByUrn.d.ts.map +1 -0
  186. package/dist/esm/funcs/schoolsGetByUrn.js +88 -0
  187. package/dist/esm/funcs/schoolsGetByUrn.js.map +1 -0
  188. package/dist/esm/funcs/schoolsList.d.ts +17 -0
  189. package/dist/esm/funcs/schoolsList.d.ts.map +1 -0
  190. package/dist/esm/funcs/schoolsList.js +90 -0
  191. package/dist/esm/funcs/schoolsList.js.map +1 -0
  192. package/dist/esm/funcs/schoolsSearchNearby.d.ts +17 -0
  193. package/dist/esm/funcs/schoolsSearchNearby.d.ts.map +1 -0
  194. package/dist/esm/funcs/schoolsSearchNearby.js +89 -0
  195. package/dist/esm/funcs/schoolsSearchNearby.js.map +1 -0
  196. package/dist/esm/funcs/schoolsSearchWithin.d.ts +17 -0
  197. package/dist/esm/funcs/schoolsSearchWithin.d.ts.map +1 -0
  198. package/dist/esm/funcs/schoolsSearchWithin.js +89 -0
  199. package/dist/esm/funcs/schoolsSearchWithin.js.map +1 -0
  200. package/dist/esm/lib/config.d.ts +4 -4
  201. package/dist/esm/lib/config.d.ts.map +1 -1
  202. package/dist/esm/lib/config.js +4 -4
  203. package/dist/esm/lib/config.js.map +1 -1
  204. package/dist/esm/sdk/models/operations/getmetricprofiles.d.ts +89 -0
  205. package/dist/esm/sdk/models/operations/getmetricprofiles.d.ts.map +1 -0
  206. package/dist/esm/sdk/models/operations/getmetricprofiles.js +81 -0
  207. package/dist/esm/sdk/models/operations/getmetricprofiles.js.map +1 -0
  208. package/dist/esm/sdk/models/operations/getschoolbyid.d.ts +245 -0
  209. package/dist/esm/sdk/models/operations/getschoolbyid.d.ts.map +1 -0
  210. package/dist/esm/sdk/models/operations/getschoolbyid.js +219 -0
  211. package/dist/esm/sdk/models/operations/getschoolbyid.js.map +1 -0
  212. package/dist/esm/sdk/models/operations/getschoolbyslug.d.ts +245 -0
  213. package/dist/esm/sdk/models/operations/getschoolbyslug.d.ts.map +1 -0
  214. package/dist/esm/sdk/models/operations/getschoolbyslug.js +219 -0
  215. package/dist/esm/sdk/models/operations/getschoolbyslug.js.map +1 -0
  216. package/dist/esm/sdk/models/operations/getschoolbyurn.d.ts +245 -0
  217. package/dist/esm/sdk/models/operations/getschoolbyurn.d.ts.map +1 -0
  218. package/dist/esm/sdk/models/operations/getschoolbyurn.js +219 -0
  219. package/dist/esm/sdk/models/operations/getschoolbyurn.js.map +1 -0
  220. package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts +901 -0
  221. package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts.map +1 -0
  222. package/dist/esm/sdk/models/operations/getschoolmetrics.js +770 -0
  223. package/dist/esm/sdk/models/operations/getschoolmetrics.js.map +1 -0
  224. package/dist/esm/sdk/models/operations/getv1safetycrime.d.ts +309 -0
  225. package/dist/esm/sdk/models/operations/getv1safetycrime.d.ts.map +1 -0
  226. package/dist/esm/sdk/models/operations/getv1safetycrime.js +296 -0
  227. package/dist/esm/sdk/models/operations/getv1safetycrime.js.map +1 -0
  228. package/dist/esm/sdk/models/operations/getv1safetycrimestats.d.ts +330 -0
  229. package/dist/esm/sdk/models/operations/getv1safetycrimestats.d.ts.map +1 -0
  230. package/dist/esm/sdk/models/operations/getv1safetycrimestats.js +310 -0
  231. package/dist/esm/sdk/models/operations/getv1safetycrimestats.js.map +1 -0
  232. package/dist/esm/sdk/models/operations/index.d.ts +10 -0
  233. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  234. package/dist/esm/sdk/models/operations/index.js +10 -0
  235. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  236. package/dist/esm/sdk/models/operations/listschools.d.ts +248 -0
  237. package/dist/esm/sdk/models/operations/listschools.d.ts.map +1 -0
  238. package/dist/esm/sdk/models/operations/listschools.js +216 -0
  239. package/dist/esm/sdk/models/operations/listschools.js.map +1 -0
  240. package/dist/esm/sdk/models/operations/searchschoolsnearby.d.ts +274 -0
  241. package/dist/esm/sdk/models/operations/searchschoolsnearby.d.ts.map +1 -0
  242. package/dist/esm/sdk/models/operations/searchschoolsnearby.js +236 -0
  243. package/dist/esm/sdk/models/operations/searchschoolsnearby.js.map +1 -0
  244. package/dist/esm/sdk/models/operations/searchschoolswithin.d.ts +243 -0
  245. package/dist/esm/sdk/models/operations/searchschoolswithin.d.ts.map +1 -0
  246. package/dist/esm/sdk/models/operations/searchschoolswithin.js +214 -0
  247. package/dist/esm/sdk/models/operations/searchschoolswithin.js.map +1 -0
  248. package/dist/esm/sdk/models/shared/index.d.ts +11 -5
  249. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  250. package/dist/esm/sdk/models/shared/index.js +11 -5
  251. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  252. package/dist/esm/sdk/models/shared/propertyaddress.d.ts +1 -1
  253. package/dist/esm/sdk/models/shared/propertyareafilter.d.ts +31 -0
  254. package/dist/esm/sdk/models/shared/propertyareafilter.d.ts.map +1 -0
  255. package/dist/esm/sdk/models/shared/propertyareafilter.js +47 -0
  256. package/dist/esm/sdk/models/shared/propertyareafilter.js.map +1 -0
  257. package/dist/esm/sdk/models/shared/propertylocationidareafilter.d.ts +32 -0
  258. package/dist/esm/sdk/models/shared/propertylocationidareafilter.d.ts.map +1 -0
  259. package/dist/esm/sdk/models/shared/propertylocationidareafilter.js +31 -0
  260. package/dist/esm/sdk/models/shared/propertylocationidareafilter.js.map +1 -0
  261. package/dist/esm/sdk/models/shared/propertymultipolygonareafilter.d.ts +57 -0
  262. package/dist/esm/sdk/models/shared/propertymultipolygonareafilter.d.ts.map +1 -0
  263. package/dist/esm/sdk/models/shared/propertymultipolygonareafilter.js +51 -0
  264. package/dist/esm/sdk/models/shared/propertymultipolygonareafilter.js.map +1 -0
  265. package/dist/esm/sdk/models/shared/propertyoutcodeareafilter.d.ts +57 -0
  266. package/dist/esm/sdk/models/shared/propertyoutcodeareafilter.d.ts.map +1 -0
  267. package/dist/esm/sdk/models/shared/propertyoutcodeareafilter.js +51 -0
  268. package/dist/esm/sdk/models/shared/propertyoutcodeareafilter.js.map +1 -0
  269. package/dist/esm/sdk/models/shared/propertypointareafilter.d.ts +62 -0
  270. package/dist/esm/sdk/models/shared/propertypointareafilter.d.ts.map +1 -0
  271. package/dist/esm/sdk/models/shared/propertypointareafilter.js +53 -0
  272. package/dist/esm/sdk/models/shared/propertypointareafilter.js.map +1 -0
  273. package/dist/esm/sdk/models/shared/propertypolygonareafilter.d.ts +57 -0
  274. package/dist/esm/sdk/models/shared/propertypolygonareafilter.d.ts.map +1 -0
  275. package/dist/esm/sdk/models/shared/propertypolygonareafilter.js +51 -0
  276. package/dist/esm/sdk/models/shared/propertypolygonareafilter.js.map +1 -0
  277. package/dist/esm/sdk/models/shared/propertypostcodeareafilter.d.ts +62 -0
  278. package/dist/esm/sdk/models/shared/propertypostcodeareafilter.d.ts.map +1 -0
  279. package/dist/esm/sdk/models/shared/propertypostcodeareafilter.js +53 -0
  280. package/dist/esm/sdk/models/shared/propertypostcodeareafilter.js.map +1 -0
  281. package/dist/esm/sdk/models/shared/propertyquerycondition.d.ts +146 -0
  282. package/dist/esm/sdk/models/shared/propertyquerycondition.d.ts.map +1 -0
  283. package/dist/esm/sdk/models/shared/propertyquerycondition.js +131 -0
  284. package/dist/esm/sdk/models/shared/propertyquerycondition.js.map +1 -0
  285. package/dist/esm/sdk/models/shared/propertyquerygroup.d.ts +33 -0
  286. package/dist/esm/sdk/models/shared/propertyquerygroup.d.ts.map +1 -0
  287. package/dist/esm/sdk/models/shared/propertyquerygroup.js +32 -0
  288. package/dist/esm/sdk/models/shared/propertyquerygroup.js.map +1 -0
  289. package/dist/esm/sdk/models/shared/propertyqueryoperator.d.ts +70 -0
  290. package/dist/esm/sdk/models/shared/propertyqueryoperator.d.ts.map +1 -0
  291. package/dist/esm/sdk/models/shared/propertyqueryoperator.js +57 -0
  292. package/dist/esm/sdk/models/shared/propertyqueryoperator.js.map +1 -0
  293. package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts +27 -80
  294. package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
  295. package/dist/esm/sdk/models/shared/propertyqueryrequest.js +25 -53
  296. package/dist/esm/sdk/models/shared/propertyqueryrequest.js.map +1 -1
  297. package/dist/esm/sdk/models/shared/school.d.ts +441 -0
  298. package/dist/esm/sdk/models/shared/school.d.ts.map +1 -0
  299. package/dist/esm/sdk/models/shared/school.js +259 -0
  300. package/dist/esm/sdk/models/shared/school.js.map +1 -0
  301. package/dist/esm/sdk/models/shared/streetquerybycoordinates.d.ts +2 -2
  302. package/dist/esm/sdk/safety.d.ts +19 -0
  303. package/dist/esm/sdk/safety.d.ts.map +1 -0
  304. package/dist/esm/sdk/safety.js +28 -0
  305. package/dist/esm/sdk/safety.js.map +1 -0
  306. package/dist/esm/sdk/schoolmetrics.d.ts +19 -0
  307. package/dist/esm/sdk/schoolmetrics.d.ts.map +1 -0
  308. package/dist/esm/sdk/schoolmetrics.js +28 -0
  309. package/dist/esm/sdk/schoolmetrics.js.map +1 -0
  310. package/dist/esm/sdk/schools.d.ts +47 -0
  311. package/dist/esm/sdk/schools.d.ts.map +1 -0
  312. package/dist/esm/sdk/schools.js +68 -0
  313. package/dist/esm/sdk/schools.js.map +1 -0
  314. package/dist/esm/sdk/sdk.d.ts +9 -0
  315. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  316. package/dist/esm/sdk/sdk.js +12 -0
  317. package/dist/esm/sdk/sdk.js.map +1 -1
  318. package/openapi.json +908 -1
  319. package/package.json +1 -1
  320. package/src/funcs/safetyGetV1SafetyCrime.ts +167 -0
  321. package/src/funcs/safetyGetV1SafetyCrimeStats.ts +168 -0
  322. package/src/funcs/schoolMetricsGetMetrics.ts +177 -0
  323. package/src/funcs/schoolMetricsListProfiles.ts +140 -0
  324. package/src/funcs/schoolsGet.ts +172 -0
  325. package/src/funcs/schoolsGetBySlug.ts +172 -0
  326. package/src/funcs/schoolsGetByUrn.ts +172 -0
  327. package/src/funcs/schoolsList.ts +173 -0
  328. package/src/funcs/schoolsSearchNearby.ts +172 -0
  329. package/src/funcs/schoolsSearchWithin.ts +172 -0
  330. package/src/lib/config.ts +4 -4
  331. package/src/sdk/models/operations/getmetricprofiles.ts +169 -0
  332. package/src/sdk/models/operations/getschoolbyid.ts +473 -0
  333. package/src/sdk/models/operations/getschoolbyslug.ts +479 -0
  334. package/src/sdk/models/operations/getschoolbyurn.ts +474 -0
  335. package/src/sdk/models/operations/getschoolmetrics.ts +1563 -0
  336. package/src/sdk/models/operations/getv1safetycrime.ts +671 -0
  337. package/src/sdk/models/operations/getv1safetycrimestats.ts +733 -0
  338. package/src/sdk/models/operations/index.ts +10 -0
  339. package/src/sdk/models/operations/listschools.ts +470 -0
  340. package/src/sdk/models/operations/searchschoolsnearby.ts +507 -0
  341. package/src/sdk/models/operations/searchschoolswithin.ts +475 -0
  342. package/src/sdk/models/shared/index.ts +11 -5
  343. package/src/sdk/models/shared/propertyaddress.ts +1 -1
  344. package/src/sdk/models/shared/propertyareafilter.ts +120 -0
  345. package/src/sdk/models/shared/propertylocationidareafilter.ts +71 -0
  346. package/src/sdk/models/shared/propertymultipolygonareafilter.ts +101 -0
  347. package/src/sdk/models/shared/propertyoutcodeareafilter.ts +102 -0
  348. package/src/sdk/models/shared/propertypointareafilter.ts +109 -0
  349. package/src/sdk/models/shared/propertypolygonareafilter.ts +102 -0
  350. package/src/sdk/models/shared/propertypostcodeareafilter.ts +109 -0
  351. package/src/sdk/models/shared/propertyquerycondition.ts +238 -0
  352. package/src/sdk/models/shared/propertyquerygroup.ts +75 -0
  353. package/src/sdk/models/shared/propertyqueryoperator.ts +114 -0
  354. package/src/sdk/models/shared/propertyqueryrequest.ts +62 -94
  355. package/src/sdk/models/shared/school.ts +588 -0
  356. package/src/sdk/models/shared/streetquerybycoordinates.ts +2 -2
  357. package/src/sdk/safety.ts +45 -0
  358. package/src/sdk/schoolmetrics.ts +43 -0
  359. package/src/sdk/schools.ts +117 -0
  360. package/src/sdk/sdk.ts +18 -0
  361. package/test-local.ts +4 -4
  362. package/dist/commonjs/sdk/models/shared/areafilter.d.ts +0 -40
  363. package/dist/commonjs/sdk/models/shared/areafilter.d.ts.map +0 -1
  364. package/dist/commonjs/sdk/models/shared/areafilter.js +0 -84
  365. package/dist/commonjs/sdk/models/shared/areafilter.js.map +0 -1
  366. package/dist/commonjs/sdk/models/shared/pointareafilter.d.ts +0 -62
  367. package/dist/commonjs/sdk/models/shared/pointareafilter.d.ts.map +0 -1
  368. package/dist/commonjs/sdk/models/shared/pointareafilter.js.map +0 -1
  369. package/dist/commonjs/sdk/models/shared/polygonareafilter.d.ts +0 -57
  370. package/dist/commonjs/sdk/models/shared/polygonareafilter.d.ts.map +0 -1
  371. package/dist/commonjs/sdk/models/shared/polygonareafilter.js +0 -89
  372. package/dist/commonjs/sdk/models/shared/polygonareafilter.js.map +0 -1
  373. package/dist/commonjs/sdk/models/shared/postcodeareafilter.d.ts +0 -62
  374. package/dist/commonjs/sdk/models/shared/postcodeareafilter.d.ts.map +0 -1
  375. package/dist/commonjs/sdk/models/shared/postcodeareafilter.js +0 -91
  376. package/dist/commonjs/sdk/models/shared/postcodeareafilter.js.map +0 -1
  377. package/dist/commonjs/sdk/models/shared/propertyfilters.d.ts +0 -447
  378. package/dist/commonjs/sdk/models/shared/propertyfilters.d.ts.map +0 -1
  379. package/dist/commonjs/sdk/models/shared/propertyfilters.js +0 -299
  380. package/dist/commonjs/sdk/models/shared/propertyfilters.js.map +0 -1
  381. package/dist/esm/sdk/models/shared/areafilter.d.ts +0 -40
  382. package/dist/esm/sdk/models/shared/areafilter.d.ts.map +0 -1
  383. package/dist/esm/sdk/models/shared/areafilter.js +0 -46
  384. package/dist/esm/sdk/models/shared/areafilter.js.map +0 -1
  385. package/dist/esm/sdk/models/shared/pointareafilter.d.ts +0 -62
  386. package/dist/esm/sdk/models/shared/pointareafilter.d.ts.map +0 -1
  387. package/dist/esm/sdk/models/shared/pointareafilter.js +0 -53
  388. package/dist/esm/sdk/models/shared/pointareafilter.js.map +0 -1
  389. package/dist/esm/sdk/models/shared/polygonareafilter.d.ts +0 -57
  390. package/dist/esm/sdk/models/shared/polygonareafilter.d.ts.map +0 -1
  391. package/dist/esm/sdk/models/shared/polygonareafilter.js +0 -51
  392. package/dist/esm/sdk/models/shared/polygonareafilter.js.map +0 -1
  393. package/dist/esm/sdk/models/shared/postcodeareafilter.d.ts +0 -62
  394. package/dist/esm/sdk/models/shared/postcodeareafilter.d.ts.map +0 -1
  395. package/dist/esm/sdk/models/shared/postcodeareafilter.js +0 -53
  396. package/dist/esm/sdk/models/shared/postcodeareafilter.js.map +0 -1
  397. package/dist/esm/sdk/models/shared/propertyfilters.d.ts +0 -447
  398. package/dist/esm/sdk/models/shared/propertyfilters.d.ts.map +0 -1
  399. package/dist/esm/sdk/models/shared/propertyfilters.js +0 -259
  400. package/dist/esm/sdk/models/shared/propertyfilters.js.map +0 -1
  401. package/src/sdk/models/shared/areafilter.ts +0 -106
  402. package/src/sdk/models/shared/pointareafilter.ts +0 -104
  403. package/src/sdk/models/shared/polygonareafilter.ts +0 -100
  404. package/src/sdk/models/shared/postcodeareafilter.ts +0 -107
  405. package/src/sdk/models/shared/propertyfilters.ts +0 -475
@@ -0,0 +1,475 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { remap as remap$ } from "../../../lib/primitives.js";
7
+ import { safeParse } from "../../../lib/schemas.js";
8
+ import { ClosedEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+ import * as shared from "../shared/index.js";
12
+
13
+ export type SearchSchoolsWithinRequest = {
14
+ /**
15
+ * Eastern boundary longitude
16
+ */
17
+ east: string;
18
+ /**
19
+ * Comma-separated list of related data to include (currently supports: ratings)
20
+ */
21
+ expand?: string | undefined;
22
+ /**
23
+ * Comma-separated list of fields to include
24
+ */
25
+ fields?: string | undefined;
26
+ /**
27
+ * Maximum number of results
28
+ */
29
+ limit?: string | undefined;
30
+ /**
31
+ * Northern boundary latitude
32
+ */
33
+ north: string;
34
+ /**
35
+ * Ofsted rating filter
36
+ */
37
+ rating?: string | undefined;
38
+ /**
39
+ * Southern boundary latitude
40
+ */
41
+ south: string;
42
+ /**
43
+ * School status filter
44
+ */
45
+ status?: string | undefined;
46
+ /**
47
+ * Western boundary longitude
48
+ */
49
+ west: string;
50
+ };
51
+
52
+ export const SearchSchoolsWithinType = {
53
+ ApiError: "api_error",
54
+ InvalidRequestError: "invalid_request_error",
55
+ AuthenticationError: "authentication_error",
56
+ RateLimitError: "rate_limit_error",
57
+ } as const;
58
+ export type SearchSchoolsWithinType = ClosedEnum<
59
+ typeof SearchSchoolsWithinType
60
+ >;
61
+
62
+ export type SearchSchoolsWithinError = {
63
+ code?: string | undefined;
64
+ message: string;
65
+ param?: string | undefined;
66
+ type: SearchSchoolsWithinType;
67
+ };
68
+
69
+ /**
70
+ * Error response
71
+ */
72
+ export type SearchSchoolsWithinSchoolsResponseBody = {
73
+ error: SearchSchoolsWithinError;
74
+ };
75
+
76
+ export const SearchSchoolsWithinObject = {
77
+ List: "list",
78
+ } as const;
79
+ export type SearchSchoolsWithinObject = ClosedEnum<
80
+ typeof SearchSchoolsWithinObject
81
+ >;
82
+
83
+ /**
84
+ * Paginated list of schools
85
+ */
86
+ export type SearchSchoolsWithinResponseBody = {
87
+ data: Array<shared.School>;
88
+ hasMore: boolean;
89
+ object: SearchSchoolsWithinObject;
90
+ totalCount?: number | undefined;
91
+ url: string;
92
+ };
93
+
94
+ export type SearchSchoolsWithinResponse =
95
+ | SearchSchoolsWithinResponseBody
96
+ | SearchSchoolsWithinSchoolsResponseBody;
97
+
98
+ /** @internal */
99
+ export const SearchSchoolsWithinRequest$inboundSchema: z.ZodType<
100
+ SearchSchoolsWithinRequest,
101
+ z.ZodTypeDef,
102
+ unknown
103
+ > = z.object({
104
+ east: z.string(),
105
+ expand: z.string().optional(),
106
+ fields: z.string().optional(),
107
+ limit: z.string().optional(),
108
+ north: z.string(),
109
+ rating: z.string().optional(),
110
+ south: z.string(),
111
+ status: z.string().optional(),
112
+ west: z.string(),
113
+ });
114
+
115
+ /** @internal */
116
+ export type SearchSchoolsWithinRequest$Outbound = {
117
+ east: string;
118
+ expand?: string | undefined;
119
+ fields?: string | undefined;
120
+ limit?: string | undefined;
121
+ north: string;
122
+ rating?: string | undefined;
123
+ south: string;
124
+ status?: string | undefined;
125
+ west: string;
126
+ };
127
+
128
+ /** @internal */
129
+ export const SearchSchoolsWithinRequest$outboundSchema: z.ZodType<
130
+ SearchSchoolsWithinRequest$Outbound,
131
+ z.ZodTypeDef,
132
+ SearchSchoolsWithinRequest
133
+ > = z.object({
134
+ east: z.string(),
135
+ expand: z.string().optional(),
136
+ fields: z.string().optional(),
137
+ limit: z.string().optional(),
138
+ north: z.string(),
139
+ rating: z.string().optional(),
140
+ south: z.string(),
141
+ status: z.string().optional(),
142
+ west: z.string(),
143
+ });
144
+
145
+ /**
146
+ * @internal
147
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
148
+ */
149
+ export namespace SearchSchoolsWithinRequest$ {
150
+ /** @deprecated use `SearchSchoolsWithinRequest$inboundSchema` instead. */
151
+ export const inboundSchema = SearchSchoolsWithinRequest$inboundSchema;
152
+ /** @deprecated use `SearchSchoolsWithinRequest$outboundSchema` instead. */
153
+ export const outboundSchema = SearchSchoolsWithinRequest$outboundSchema;
154
+ /** @deprecated use `SearchSchoolsWithinRequest$Outbound` instead. */
155
+ export type Outbound = SearchSchoolsWithinRequest$Outbound;
156
+ }
157
+
158
+ export function searchSchoolsWithinRequestToJSON(
159
+ searchSchoolsWithinRequest: SearchSchoolsWithinRequest,
160
+ ): string {
161
+ return JSON.stringify(
162
+ SearchSchoolsWithinRequest$outboundSchema.parse(searchSchoolsWithinRequest),
163
+ );
164
+ }
165
+
166
+ export function searchSchoolsWithinRequestFromJSON(
167
+ jsonString: string,
168
+ ): SafeParseResult<SearchSchoolsWithinRequest, SDKValidationError> {
169
+ return safeParse(
170
+ jsonString,
171
+ (x) => SearchSchoolsWithinRequest$inboundSchema.parse(JSON.parse(x)),
172
+ `Failed to parse 'SearchSchoolsWithinRequest' from JSON`,
173
+ );
174
+ }
175
+
176
+ /** @internal */
177
+ export const SearchSchoolsWithinType$inboundSchema: z.ZodNativeEnum<
178
+ typeof SearchSchoolsWithinType
179
+ > = z.nativeEnum(SearchSchoolsWithinType);
180
+
181
+ /** @internal */
182
+ export const SearchSchoolsWithinType$outboundSchema: z.ZodNativeEnum<
183
+ typeof SearchSchoolsWithinType
184
+ > = SearchSchoolsWithinType$inboundSchema;
185
+
186
+ /**
187
+ * @internal
188
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
189
+ */
190
+ export namespace SearchSchoolsWithinType$ {
191
+ /** @deprecated use `SearchSchoolsWithinType$inboundSchema` instead. */
192
+ export const inboundSchema = SearchSchoolsWithinType$inboundSchema;
193
+ /** @deprecated use `SearchSchoolsWithinType$outboundSchema` instead. */
194
+ export const outboundSchema = SearchSchoolsWithinType$outboundSchema;
195
+ }
196
+
197
+ /** @internal */
198
+ export const SearchSchoolsWithinError$inboundSchema: z.ZodType<
199
+ SearchSchoolsWithinError,
200
+ z.ZodTypeDef,
201
+ unknown
202
+ > = z.object({
203
+ code: z.string().optional(),
204
+ message: z.string(),
205
+ param: z.string().optional(),
206
+ type: SearchSchoolsWithinType$inboundSchema,
207
+ });
208
+
209
+ /** @internal */
210
+ export type SearchSchoolsWithinError$Outbound = {
211
+ code?: string | undefined;
212
+ message: string;
213
+ param?: string | undefined;
214
+ type: string;
215
+ };
216
+
217
+ /** @internal */
218
+ export const SearchSchoolsWithinError$outboundSchema: z.ZodType<
219
+ SearchSchoolsWithinError$Outbound,
220
+ z.ZodTypeDef,
221
+ SearchSchoolsWithinError
222
+ > = z.object({
223
+ code: z.string().optional(),
224
+ message: z.string(),
225
+ param: z.string().optional(),
226
+ type: SearchSchoolsWithinType$outboundSchema,
227
+ });
228
+
229
+ /**
230
+ * @internal
231
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
232
+ */
233
+ export namespace SearchSchoolsWithinError$ {
234
+ /** @deprecated use `SearchSchoolsWithinError$inboundSchema` instead. */
235
+ export const inboundSchema = SearchSchoolsWithinError$inboundSchema;
236
+ /** @deprecated use `SearchSchoolsWithinError$outboundSchema` instead. */
237
+ export const outboundSchema = SearchSchoolsWithinError$outboundSchema;
238
+ /** @deprecated use `SearchSchoolsWithinError$Outbound` instead. */
239
+ export type Outbound = SearchSchoolsWithinError$Outbound;
240
+ }
241
+
242
+ export function searchSchoolsWithinErrorToJSON(
243
+ searchSchoolsWithinError: SearchSchoolsWithinError,
244
+ ): string {
245
+ return JSON.stringify(
246
+ SearchSchoolsWithinError$outboundSchema.parse(searchSchoolsWithinError),
247
+ );
248
+ }
249
+
250
+ export function searchSchoolsWithinErrorFromJSON(
251
+ jsonString: string,
252
+ ): SafeParseResult<SearchSchoolsWithinError, SDKValidationError> {
253
+ return safeParse(
254
+ jsonString,
255
+ (x) => SearchSchoolsWithinError$inboundSchema.parse(JSON.parse(x)),
256
+ `Failed to parse 'SearchSchoolsWithinError' from JSON`,
257
+ );
258
+ }
259
+
260
+ /** @internal */
261
+ export const SearchSchoolsWithinSchoolsResponseBody$inboundSchema: z.ZodType<
262
+ SearchSchoolsWithinSchoolsResponseBody,
263
+ z.ZodTypeDef,
264
+ unknown
265
+ > = z.object({
266
+ error: z.lazy(() => SearchSchoolsWithinError$inboundSchema),
267
+ });
268
+
269
+ /** @internal */
270
+ export type SearchSchoolsWithinSchoolsResponseBody$Outbound = {
271
+ error: SearchSchoolsWithinError$Outbound;
272
+ };
273
+
274
+ /** @internal */
275
+ export const SearchSchoolsWithinSchoolsResponseBody$outboundSchema: z.ZodType<
276
+ SearchSchoolsWithinSchoolsResponseBody$Outbound,
277
+ z.ZodTypeDef,
278
+ SearchSchoolsWithinSchoolsResponseBody
279
+ > = z.object({
280
+ error: z.lazy(() => SearchSchoolsWithinError$outboundSchema),
281
+ });
282
+
283
+ /**
284
+ * @internal
285
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
286
+ */
287
+ export namespace SearchSchoolsWithinSchoolsResponseBody$ {
288
+ /** @deprecated use `SearchSchoolsWithinSchoolsResponseBody$inboundSchema` instead. */
289
+ export const inboundSchema =
290
+ SearchSchoolsWithinSchoolsResponseBody$inboundSchema;
291
+ /** @deprecated use `SearchSchoolsWithinSchoolsResponseBody$outboundSchema` instead. */
292
+ export const outboundSchema =
293
+ SearchSchoolsWithinSchoolsResponseBody$outboundSchema;
294
+ /** @deprecated use `SearchSchoolsWithinSchoolsResponseBody$Outbound` instead. */
295
+ export type Outbound = SearchSchoolsWithinSchoolsResponseBody$Outbound;
296
+ }
297
+
298
+ export function searchSchoolsWithinSchoolsResponseBodyToJSON(
299
+ searchSchoolsWithinSchoolsResponseBody:
300
+ SearchSchoolsWithinSchoolsResponseBody,
301
+ ): string {
302
+ return JSON.stringify(
303
+ SearchSchoolsWithinSchoolsResponseBody$outboundSchema.parse(
304
+ searchSchoolsWithinSchoolsResponseBody,
305
+ ),
306
+ );
307
+ }
308
+
309
+ export function searchSchoolsWithinSchoolsResponseBodyFromJSON(
310
+ jsonString: string,
311
+ ): SafeParseResult<SearchSchoolsWithinSchoolsResponseBody, SDKValidationError> {
312
+ return safeParse(
313
+ jsonString,
314
+ (x) =>
315
+ SearchSchoolsWithinSchoolsResponseBody$inboundSchema.parse(JSON.parse(x)),
316
+ `Failed to parse 'SearchSchoolsWithinSchoolsResponseBody' from JSON`,
317
+ );
318
+ }
319
+
320
+ /** @internal */
321
+ export const SearchSchoolsWithinObject$inboundSchema: z.ZodNativeEnum<
322
+ typeof SearchSchoolsWithinObject
323
+ > = z.nativeEnum(SearchSchoolsWithinObject);
324
+
325
+ /** @internal */
326
+ export const SearchSchoolsWithinObject$outboundSchema: z.ZodNativeEnum<
327
+ typeof SearchSchoolsWithinObject
328
+ > = SearchSchoolsWithinObject$inboundSchema;
329
+
330
+ /**
331
+ * @internal
332
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
333
+ */
334
+ export namespace SearchSchoolsWithinObject$ {
335
+ /** @deprecated use `SearchSchoolsWithinObject$inboundSchema` instead. */
336
+ export const inboundSchema = SearchSchoolsWithinObject$inboundSchema;
337
+ /** @deprecated use `SearchSchoolsWithinObject$outboundSchema` instead. */
338
+ export const outboundSchema = SearchSchoolsWithinObject$outboundSchema;
339
+ }
340
+
341
+ /** @internal */
342
+ export const SearchSchoolsWithinResponseBody$inboundSchema: z.ZodType<
343
+ SearchSchoolsWithinResponseBody,
344
+ z.ZodTypeDef,
345
+ unknown
346
+ > = z.object({
347
+ data: z.array(shared.School$inboundSchema),
348
+ has_more: z.boolean(),
349
+ object: SearchSchoolsWithinObject$inboundSchema,
350
+ total_count: z.number().optional(),
351
+ url: z.string(),
352
+ }).transform((v) => {
353
+ return remap$(v, {
354
+ "has_more": "hasMore",
355
+ "total_count": "totalCount",
356
+ });
357
+ });
358
+
359
+ /** @internal */
360
+ export type SearchSchoolsWithinResponseBody$Outbound = {
361
+ data: Array<shared.School$Outbound>;
362
+ has_more: boolean;
363
+ object: string;
364
+ total_count?: number | undefined;
365
+ url: string;
366
+ };
367
+
368
+ /** @internal */
369
+ export const SearchSchoolsWithinResponseBody$outboundSchema: z.ZodType<
370
+ SearchSchoolsWithinResponseBody$Outbound,
371
+ z.ZodTypeDef,
372
+ SearchSchoolsWithinResponseBody
373
+ > = z.object({
374
+ data: z.array(shared.School$outboundSchema),
375
+ hasMore: z.boolean(),
376
+ object: SearchSchoolsWithinObject$outboundSchema,
377
+ totalCount: z.number().optional(),
378
+ url: z.string(),
379
+ }).transform((v) => {
380
+ return remap$(v, {
381
+ hasMore: "has_more",
382
+ totalCount: "total_count",
383
+ });
384
+ });
385
+
386
+ /**
387
+ * @internal
388
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
389
+ */
390
+ export namespace SearchSchoolsWithinResponseBody$ {
391
+ /** @deprecated use `SearchSchoolsWithinResponseBody$inboundSchema` instead. */
392
+ export const inboundSchema = SearchSchoolsWithinResponseBody$inboundSchema;
393
+ /** @deprecated use `SearchSchoolsWithinResponseBody$outboundSchema` instead. */
394
+ export const outboundSchema = SearchSchoolsWithinResponseBody$outboundSchema;
395
+ /** @deprecated use `SearchSchoolsWithinResponseBody$Outbound` instead. */
396
+ export type Outbound = SearchSchoolsWithinResponseBody$Outbound;
397
+ }
398
+
399
+ export function searchSchoolsWithinResponseBodyToJSON(
400
+ searchSchoolsWithinResponseBody: SearchSchoolsWithinResponseBody,
401
+ ): string {
402
+ return JSON.stringify(
403
+ SearchSchoolsWithinResponseBody$outboundSchema.parse(
404
+ searchSchoolsWithinResponseBody,
405
+ ),
406
+ );
407
+ }
408
+
409
+ export function searchSchoolsWithinResponseBodyFromJSON(
410
+ jsonString: string,
411
+ ): SafeParseResult<SearchSchoolsWithinResponseBody, SDKValidationError> {
412
+ return safeParse(
413
+ jsonString,
414
+ (x) => SearchSchoolsWithinResponseBody$inboundSchema.parse(JSON.parse(x)),
415
+ `Failed to parse 'SearchSchoolsWithinResponseBody' from JSON`,
416
+ );
417
+ }
418
+
419
+ /** @internal */
420
+ export const SearchSchoolsWithinResponse$inboundSchema: z.ZodType<
421
+ SearchSchoolsWithinResponse,
422
+ z.ZodTypeDef,
423
+ unknown
424
+ > = z.union([
425
+ z.lazy(() => SearchSchoolsWithinResponseBody$inboundSchema),
426
+ z.lazy(() => SearchSchoolsWithinSchoolsResponseBody$inboundSchema),
427
+ ]);
428
+
429
+ /** @internal */
430
+ export type SearchSchoolsWithinResponse$Outbound =
431
+ | SearchSchoolsWithinResponseBody$Outbound
432
+ | SearchSchoolsWithinSchoolsResponseBody$Outbound;
433
+
434
+ /** @internal */
435
+ export const SearchSchoolsWithinResponse$outboundSchema: z.ZodType<
436
+ SearchSchoolsWithinResponse$Outbound,
437
+ z.ZodTypeDef,
438
+ SearchSchoolsWithinResponse
439
+ > = z.union([
440
+ z.lazy(() => SearchSchoolsWithinResponseBody$outboundSchema),
441
+ z.lazy(() => SearchSchoolsWithinSchoolsResponseBody$outboundSchema),
442
+ ]);
443
+
444
+ /**
445
+ * @internal
446
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
447
+ */
448
+ export namespace SearchSchoolsWithinResponse$ {
449
+ /** @deprecated use `SearchSchoolsWithinResponse$inboundSchema` instead. */
450
+ export const inboundSchema = SearchSchoolsWithinResponse$inboundSchema;
451
+ /** @deprecated use `SearchSchoolsWithinResponse$outboundSchema` instead. */
452
+ export const outboundSchema = SearchSchoolsWithinResponse$outboundSchema;
453
+ /** @deprecated use `SearchSchoolsWithinResponse$Outbound` instead. */
454
+ export type Outbound = SearchSchoolsWithinResponse$Outbound;
455
+ }
456
+
457
+ export function searchSchoolsWithinResponseToJSON(
458
+ searchSchoolsWithinResponse: SearchSchoolsWithinResponse,
459
+ ): string {
460
+ return JSON.stringify(
461
+ SearchSchoolsWithinResponse$outboundSchema.parse(
462
+ searchSchoolsWithinResponse,
463
+ ),
464
+ );
465
+ }
466
+
467
+ export function searchSchoolsWithinResponseFromJSON(
468
+ jsonString: string,
469
+ ): SafeParseResult<SearchSchoolsWithinResponse, SDKValidationError> {
470
+ return safeParse(
471
+ jsonString,
472
+ (x) => SearchSchoolsWithinResponse$inboundSchema.parse(JSON.parse(x)),
473
+ `Failed to parse 'SearchSchoolsWithinResponse' from JSON`,
474
+ );
475
+ }
@@ -2,7 +2,6 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
- export * from "./areafilter.js";
6
5
  export * from "./counciltaxdata.js";
7
6
  export * from "./epcdata.js";
8
7
  export * from "./errorresponse.js";
@@ -12,20 +11,27 @@ export * from "./planningapplication.js";
12
11
  export * from "./planninglistresponse.js";
13
12
  export * from "./planningqueryfilters.js";
14
13
  export * from "./planningqueryrequest.js";
15
- export * from "./pointareafilter.js";
16
- export * from "./polygonareafilter.js";
17
- export * from "./postcodeareafilter.js";
18
14
  export * from "./pricingdata.js";
19
15
  export * from "./propertyaddress.js";
16
+ export * from "./propertyareafilter.js";
20
17
  export * from "./propertybyslugsrequest.js";
21
18
  export * from "./propertydata.js";
22
- export * from "./propertyfilters.js";
23
19
  export * from "./propertylistresponse.js";
20
+ export * from "./propertylocationidareafilter.js";
21
+ export * from "./propertymultipolygonareafilter.js";
24
22
  export * from "./propertyonstreet.js";
23
+ export * from "./propertyoutcodeareafilter.js";
24
+ export * from "./propertypointareafilter.js";
25
+ export * from "./propertypolygonareafilter.js";
26
+ export * from "./propertypostcodeareafilter.js";
27
+ export * from "./propertyquerycondition.js";
28
+ export * from "./propertyquerygroup.js";
29
+ export * from "./propertyqueryoperator.js";
25
30
  export * from "./propertyqueryrequest.js";
26
31
  export * from "./propertytags.js";
27
32
  export * from "./roomdetails.js";
28
33
  export * from "./salerecord.js";
34
+ export * from "./school.js";
29
35
  export * from "./security.js";
30
36
  export * from "./streetdescriptor.js";
31
37
  export * from "./streetdetails.js";
@@ -33,7 +33,7 @@ export type PropertyAddress = {
33
33
  */
34
34
  outcode?: string | undefined;
35
35
  /**
36
- * Full UK postcode
36
+ * UK postcode
37
37
  */
38
38
  postcode: string;
39
39
  /**
@@ -0,0 +1,120 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+ import {
10
+ PropertyLocationIdAreaFilter,
11
+ PropertyLocationIdAreaFilter$inboundSchema,
12
+ PropertyLocationIdAreaFilter$Outbound,
13
+ PropertyLocationIdAreaFilter$outboundSchema,
14
+ } from "./propertylocationidareafilter.js";
15
+ import {
16
+ PropertyMultiPolygonAreaFilter,
17
+ PropertyMultiPolygonAreaFilter$inboundSchema,
18
+ PropertyMultiPolygonAreaFilter$Outbound,
19
+ PropertyMultiPolygonAreaFilter$outboundSchema,
20
+ } from "./propertymultipolygonareafilter.js";
21
+ import {
22
+ PropertyOutcodeAreaFilter,
23
+ PropertyOutcodeAreaFilter$inboundSchema,
24
+ PropertyOutcodeAreaFilter$Outbound,
25
+ PropertyOutcodeAreaFilter$outboundSchema,
26
+ } from "./propertyoutcodeareafilter.js";
27
+ import {
28
+ PropertyPointAreaFilter,
29
+ PropertyPointAreaFilter$inboundSchema,
30
+ PropertyPointAreaFilter$Outbound,
31
+ PropertyPointAreaFilter$outboundSchema,
32
+ } from "./propertypointareafilter.js";
33
+ import {
34
+ PropertyPolygonAreaFilter,
35
+ PropertyPolygonAreaFilter$inboundSchema,
36
+ PropertyPolygonAreaFilter$Outbound,
37
+ PropertyPolygonAreaFilter$outboundSchema,
38
+ } from "./propertypolygonareafilter.js";
39
+ import {
40
+ PropertyPostcodeAreaFilter,
41
+ PropertyPostcodeAreaFilter$inboundSchema,
42
+ PropertyPostcodeAreaFilter$Outbound,
43
+ PropertyPostcodeAreaFilter$outboundSchema,
44
+ } from "./propertypostcodeareafilter.js";
45
+
46
+ export type PropertyAreaFilter =
47
+ | PropertyPointAreaFilter
48
+ | PropertyPostcodeAreaFilter
49
+ | PropertyOutcodeAreaFilter
50
+ | PropertyPolygonAreaFilter
51
+ | PropertyMultiPolygonAreaFilter
52
+ | PropertyLocationIdAreaFilter;
53
+
54
+ /** @internal */
55
+ export const PropertyAreaFilter$inboundSchema: z.ZodType<
56
+ PropertyAreaFilter,
57
+ z.ZodTypeDef,
58
+ unknown
59
+ > = z.union([
60
+ PropertyPointAreaFilter$inboundSchema,
61
+ PropertyPostcodeAreaFilter$inboundSchema,
62
+ PropertyOutcodeAreaFilter$inboundSchema,
63
+ PropertyPolygonAreaFilter$inboundSchema,
64
+ PropertyMultiPolygonAreaFilter$inboundSchema,
65
+ PropertyLocationIdAreaFilter$inboundSchema,
66
+ ]);
67
+
68
+ /** @internal */
69
+ export type PropertyAreaFilter$Outbound =
70
+ | PropertyPointAreaFilter$Outbound
71
+ | PropertyPostcodeAreaFilter$Outbound
72
+ | PropertyOutcodeAreaFilter$Outbound
73
+ | PropertyPolygonAreaFilter$Outbound
74
+ | PropertyMultiPolygonAreaFilter$Outbound
75
+ | PropertyLocationIdAreaFilter$Outbound;
76
+
77
+ /** @internal */
78
+ export const PropertyAreaFilter$outboundSchema: z.ZodType<
79
+ PropertyAreaFilter$Outbound,
80
+ z.ZodTypeDef,
81
+ PropertyAreaFilter
82
+ > = z.union([
83
+ PropertyPointAreaFilter$outboundSchema,
84
+ PropertyPostcodeAreaFilter$outboundSchema,
85
+ PropertyOutcodeAreaFilter$outboundSchema,
86
+ PropertyPolygonAreaFilter$outboundSchema,
87
+ PropertyMultiPolygonAreaFilter$outboundSchema,
88
+ PropertyLocationIdAreaFilter$outboundSchema,
89
+ ]);
90
+
91
+ /**
92
+ * @internal
93
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
94
+ */
95
+ export namespace PropertyAreaFilter$ {
96
+ /** @deprecated use `PropertyAreaFilter$inboundSchema` instead. */
97
+ export const inboundSchema = PropertyAreaFilter$inboundSchema;
98
+ /** @deprecated use `PropertyAreaFilter$outboundSchema` instead. */
99
+ export const outboundSchema = PropertyAreaFilter$outboundSchema;
100
+ /** @deprecated use `PropertyAreaFilter$Outbound` instead. */
101
+ export type Outbound = PropertyAreaFilter$Outbound;
102
+ }
103
+
104
+ export function propertyAreaFilterToJSON(
105
+ propertyAreaFilter: PropertyAreaFilter,
106
+ ): string {
107
+ return JSON.stringify(
108
+ PropertyAreaFilter$outboundSchema.parse(propertyAreaFilter),
109
+ );
110
+ }
111
+
112
+ export function propertyAreaFilterFromJSON(
113
+ jsonString: string,
114
+ ): SafeParseResult<PropertyAreaFilter, SDKValidationError> {
115
+ return safeParse(
116
+ jsonString,
117
+ (x) => PropertyAreaFilter$inboundSchema.parse(JSON.parse(x)),
118
+ `Failed to parse 'PropertyAreaFilter' from JSON`,
119
+ );
120
+ }