@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,1563 @@
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
+
12
+ /**
13
+ * Filter by metric category
14
+ */
15
+ export const Category = {
16
+ Ks2: "ks2",
17
+ Ks4: "ks4",
18
+ Ks5: "ks5",
19
+ Pupil: "pupil",
20
+ Finance: "finance",
21
+ Ofsted: "ofsted",
22
+ } as const;
23
+ /**
24
+ * Filter by metric category
25
+ */
26
+ export type Category = ClosedEnum<typeof Category>;
27
+
28
+ /**
29
+ * Filter by cohort type
30
+ */
31
+ export const CohortType = {
32
+ All: "all",
33
+ Disadvantaged: "disadvantaged",
34
+ Boys: "boys",
35
+ Girls: "girls",
36
+ Eal: "eal",
37
+ SenSupport: "senSupport",
38
+ Ehcp: "ehcp",
39
+ English: "english",
40
+ Unclassified: "unclassified",
41
+ } as const;
42
+ /**
43
+ * Filter by cohort type
44
+ */
45
+ export type CohortType = ClosedEnum<typeof CohortType>;
46
+
47
+ /**
48
+ * Reporting period
49
+ */
50
+ export const Period = {
51
+ Annual: "annual",
52
+ Termly: "termly",
53
+ Monthly: "monthly",
54
+ } as const;
55
+ /**
56
+ * Reporting period
57
+ */
58
+ export type Period = ClosedEnum<typeof Period>;
59
+
60
+ export type GetSchoolMetricsRequest = {
61
+ academicYear?: string | undefined;
62
+ /**
63
+ * Filter by metric category
64
+ */
65
+ category?: Category | undefined;
66
+ /**
67
+ * Filter by cohort type
68
+ */
69
+ cohortType?: CohortType | undefined;
70
+ endYear?: string | undefined;
71
+ /**
72
+ * Include national/regional/similar school comparisons
73
+ */
74
+ includeComparisons?: string | undefined;
75
+ /**
76
+ * Include metric definitions and metadata
77
+ */
78
+ includeDefinitions?: string | undefined;
79
+ limit?: string | undefined;
80
+ /**
81
+ * Comma-separated list of specific metric codes
82
+ */
83
+ metricCodes?: string | undefined;
84
+ offset?: string | undefined;
85
+ /**
86
+ * Reporting period
87
+ */
88
+ period?: Period | undefined;
89
+ /**
90
+ * Predefined metric profile
91
+ */
92
+ profile?: string | undefined;
93
+ /**
94
+ * Comma-separated list of school IDs
95
+ */
96
+ schoolIds: string;
97
+ startYear?: string | undefined;
98
+ /**
99
+ * Return time series data instead of point-in-time
100
+ */
101
+ timeseries?: string | undefined;
102
+ };
103
+
104
+ export const GetSchoolMetricsType = {
105
+ ApiError: "api_error",
106
+ InvalidRequestError: "invalid_request_error",
107
+ AuthenticationError: "authentication_error",
108
+ RateLimitError: "rate_limit_error",
109
+ } as const;
110
+ export type GetSchoolMetricsType = ClosedEnum<typeof GetSchoolMetricsType>;
111
+
112
+ export type GetSchoolMetricsSchoolMetricsError = {
113
+ code?: string | undefined;
114
+ message: string;
115
+ param?: string | undefined;
116
+ type: GetSchoolMetricsType;
117
+ };
118
+
119
+ /**
120
+ * Error response structure
121
+ */
122
+ export type GetSchoolMetricsSchoolMetricsResponseResponseBody = {
123
+ error: GetSchoolMetricsSchoolMetricsError;
124
+ };
125
+
126
+ export const Type = {
127
+ ApiError: "api_error",
128
+ InvalidRequestError: "invalid_request_error",
129
+ AuthenticationError: "authentication_error",
130
+ RateLimitError: "rate_limit_error",
131
+ } as const;
132
+ export type Type = ClosedEnum<typeof Type>;
133
+
134
+ export type GetSchoolMetricsError = {
135
+ code?: string | undefined;
136
+ message: string;
137
+ param?: string | undefined;
138
+ type: Type;
139
+ };
140
+
141
+ /**
142
+ * Error response structure
143
+ */
144
+ export type GetSchoolMetricsSchoolMetricsResponseBody = {
145
+ error: GetSchoolMetricsError;
146
+ };
147
+
148
+ export const GetSchoolMetricsDataType = {
149
+ Percentage: "percentage",
150
+ Score: "score",
151
+ Count: "count",
152
+ Currency: "currency",
153
+ Text: "text",
154
+ } as const;
155
+ export type GetSchoolMetricsDataType = ClosedEnum<
156
+ typeof GetSchoolMetricsDataType
157
+ >;
158
+
159
+ /**
160
+ * Metric definition and metadata
161
+ */
162
+ export type GetSchoolMetricsDefinitions = {
163
+ category: string;
164
+ code: string;
165
+ dataType: GetSchoolMetricsDataType;
166
+ description: string;
167
+ isHigherBetter?: boolean | undefined;
168
+ nationalAverage?: number | undefined;
169
+ subcategory: string;
170
+ units?: string | undefined;
171
+ };
172
+
173
+ export type Values = number | string;
174
+
175
+ /**
176
+ * Time series data point with multiple metric values
177
+ */
178
+ export type Series = {
179
+ values: { [k: string]: number | string };
180
+ year: string;
181
+ };
182
+
183
+ /**
184
+ * School metrics time series response
185
+ */
186
+ export type Two = {
187
+ definitions?: Array<GetSchoolMetricsDefinitions> | undefined;
188
+ metricCodes: Array<string>;
189
+ schoolId: number;
190
+ series: Array<Series>;
191
+ };
192
+
193
+ /**
194
+ * Comparison data against various benchmarks
195
+ */
196
+ export type Comparisons = {
197
+ localAuthority?: number | undefined;
198
+ national?: number | undefined;
199
+ regional?: number | undefined;
200
+ similarSchools?: number | undefined;
201
+ };
202
+
203
+ export const DataType = {
204
+ Percentage: "percentage",
205
+ Score: "score",
206
+ Count: "count",
207
+ Currency: "currency",
208
+ Text: "text",
209
+ } as const;
210
+ export type DataType = ClosedEnum<typeof DataType>;
211
+
212
+ /**
213
+ * Metric definition and metadata
214
+ */
215
+ export type Definitions = {
216
+ category: string;
217
+ code: string;
218
+ dataType: DataType;
219
+ description: string;
220
+ isHigherBetter?: boolean | undefined;
221
+ nationalAverage?: number | undefined;
222
+ subcategory: string;
223
+ units?: string | undefined;
224
+ };
225
+
226
+ /**
227
+ * Confidence interval for metric values
228
+ */
229
+ export type Confidence = {
230
+ lower?: number | undefined;
231
+ upper?: number | undefined;
232
+ };
233
+
234
+ export type Value = number | string;
235
+
236
+ /**
237
+ * Individual metric value with metadata
238
+ */
239
+ export type Metrics = {
240
+ academicYear?: string | undefined;
241
+ code: string;
242
+ cohortType?: string | undefined;
243
+ /**
244
+ * Confidence interval for metric values
245
+ */
246
+ confidence?: Confidence | undefined;
247
+ metadata?: { [k: string]: any | null } | undefined;
248
+ value: number | string;
249
+ };
250
+
251
+ /**
252
+ * School metrics response for point-in-time data
253
+ */
254
+ export type One = {
255
+ comparisons?: { [k: string]: Comparisons } | undefined;
256
+ definitions?: Array<Definitions> | undefined;
257
+ metrics: Array<Metrics>;
258
+ schoolId: number;
259
+ };
260
+
261
+ export type GetSchoolMetricsData = Array<One> | Array<Two>;
262
+
263
+ export const GetSchoolMetricsObject = {
264
+ List: "list",
265
+ } as const;
266
+ export type GetSchoolMetricsObject = ClosedEnum<typeof GetSchoolMetricsObject>;
267
+
268
+ /**
269
+ * Paginated metrics response envelope
270
+ */
271
+ export type GetSchoolMetricsResponseBody = {
272
+ data: Array<One> | Array<Two>;
273
+ hasMore: boolean;
274
+ object: GetSchoolMetricsObject;
275
+ totalCount?: number | undefined;
276
+ url: string;
277
+ };
278
+
279
+ export type GetSchoolMetricsResponse =
280
+ | GetSchoolMetricsResponseBody
281
+ | GetSchoolMetricsSchoolMetricsResponseBody
282
+ | GetSchoolMetricsSchoolMetricsResponseResponseBody;
283
+
284
+ /** @internal */
285
+ export const Category$inboundSchema: z.ZodNativeEnum<typeof Category> = z
286
+ .nativeEnum(Category);
287
+
288
+ /** @internal */
289
+ export const Category$outboundSchema: z.ZodNativeEnum<typeof Category> =
290
+ Category$inboundSchema;
291
+
292
+ /**
293
+ * @internal
294
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
295
+ */
296
+ export namespace Category$ {
297
+ /** @deprecated use `Category$inboundSchema` instead. */
298
+ export const inboundSchema = Category$inboundSchema;
299
+ /** @deprecated use `Category$outboundSchema` instead. */
300
+ export const outboundSchema = Category$outboundSchema;
301
+ }
302
+
303
+ /** @internal */
304
+ export const CohortType$inboundSchema: z.ZodNativeEnum<typeof CohortType> = z
305
+ .nativeEnum(CohortType);
306
+
307
+ /** @internal */
308
+ export const CohortType$outboundSchema: z.ZodNativeEnum<typeof CohortType> =
309
+ CohortType$inboundSchema;
310
+
311
+ /**
312
+ * @internal
313
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
314
+ */
315
+ export namespace CohortType$ {
316
+ /** @deprecated use `CohortType$inboundSchema` instead. */
317
+ export const inboundSchema = CohortType$inboundSchema;
318
+ /** @deprecated use `CohortType$outboundSchema` instead. */
319
+ export const outboundSchema = CohortType$outboundSchema;
320
+ }
321
+
322
+ /** @internal */
323
+ export const Period$inboundSchema: z.ZodNativeEnum<typeof Period> = z
324
+ .nativeEnum(Period);
325
+
326
+ /** @internal */
327
+ export const Period$outboundSchema: z.ZodNativeEnum<typeof Period> =
328
+ Period$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 Period$ {
335
+ /** @deprecated use `Period$inboundSchema` instead. */
336
+ export const inboundSchema = Period$inboundSchema;
337
+ /** @deprecated use `Period$outboundSchema` instead. */
338
+ export const outboundSchema = Period$outboundSchema;
339
+ }
340
+
341
+ /** @internal */
342
+ export const GetSchoolMetricsRequest$inboundSchema: z.ZodType<
343
+ GetSchoolMetricsRequest,
344
+ z.ZodTypeDef,
345
+ unknown
346
+ > = z.object({
347
+ academicYear: z.string().optional(),
348
+ category: Category$inboundSchema.optional(),
349
+ cohortType: CohortType$inboundSchema.optional(),
350
+ endYear: z.string().optional(),
351
+ includeComparisons: z.string().optional(),
352
+ includeDefinitions: z.string().optional(),
353
+ limit: z.string().optional(),
354
+ metricCodes: z.string().optional(),
355
+ offset: z.string().optional(),
356
+ period: Period$inboundSchema.optional(),
357
+ profile: z.string().optional(),
358
+ schoolIds: z.string(),
359
+ startYear: z.string().optional(),
360
+ timeseries: z.string().optional(),
361
+ });
362
+
363
+ /** @internal */
364
+ export type GetSchoolMetricsRequest$Outbound = {
365
+ academicYear?: string | undefined;
366
+ category?: string | undefined;
367
+ cohortType?: string | undefined;
368
+ endYear?: string | undefined;
369
+ includeComparisons?: string | undefined;
370
+ includeDefinitions?: string | undefined;
371
+ limit?: string | undefined;
372
+ metricCodes?: string | undefined;
373
+ offset?: string | undefined;
374
+ period?: string | undefined;
375
+ profile?: string | undefined;
376
+ schoolIds: string;
377
+ startYear?: string | undefined;
378
+ timeseries?: string | undefined;
379
+ };
380
+
381
+ /** @internal */
382
+ export const GetSchoolMetricsRequest$outboundSchema: z.ZodType<
383
+ GetSchoolMetricsRequest$Outbound,
384
+ z.ZodTypeDef,
385
+ GetSchoolMetricsRequest
386
+ > = z.object({
387
+ academicYear: z.string().optional(),
388
+ category: Category$outboundSchema.optional(),
389
+ cohortType: CohortType$outboundSchema.optional(),
390
+ endYear: z.string().optional(),
391
+ includeComparisons: z.string().optional(),
392
+ includeDefinitions: z.string().optional(),
393
+ limit: z.string().optional(),
394
+ metricCodes: z.string().optional(),
395
+ offset: z.string().optional(),
396
+ period: Period$outboundSchema.optional(),
397
+ profile: z.string().optional(),
398
+ schoolIds: z.string(),
399
+ startYear: z.string().optional(),
400
+ timeseries: z.string().optional(),
401
+ });
402
+
403
+ /**
404
+ * @internal
405
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
406
+ */
407
+ export namespace GetSchoolMetricsRequest$ {
408
+ /** @deprecated use `GetSchoolMetricsRequest$inboundSchema` instead. */
409
+ export const inboundSchema = GetSchoolMetricsRequest$inboundSchema;
410
+ /** @deprecated use `GetSchoolMetricsRequest$outboundSchema` instead. */
411
+ export const outboundSchema = GetSchoolMetricsRequest$outboundSchema;
412
+ /** @deprecated use `GetSchoolMetricsRequest$Outbound` instead. */
413
+ export type Outbound = GetSchoolMetricsRequest$Outbound;
414
+ }
415
+
416
+ export function getSchoolMetricsRequestToJSON(
417
+ getSchoolMetricsRequest: GetSchoolMetricsRequest,
418
+ ): string {
419
+ return JSON.stringify(
420
+ GetSchoolMetricsRequest$outboundSchema.parse(getSchoolMetricsRequest),
421
+ );
422
+ }
423
+
424
+ export function getSchoolMetricsRequestFromJSON(
425
+ jsonString: string,
426
+ ): SafeParseResult<GetSchoolMetricsRequest, SDKValidationError> {
427
+ return safeParse(
428
+ jsonString,
429
+ (x) => GetSchoolMetricsRequest$inboundSchema.parse(JSON.parse(x)),
430
+ `Failed to parse 'GetSchoolMetricsRequest' from JSON`,
431
+ );
432
+ }
433
+
434
+ /** @internal */
435
+ export const GetSchoolMetricsType$inboundSchema: z.ZodNativeEnum<
436
+ typeof GetSchoolMetricsType
437
+ > = z.nativeEnum(GetSchoolMetricsType);
438
+
439
+ /** @internal */
440
+ export const GetSchoolMetricsType$outboundSchema: z.ZodNativeEnum<
441
+ typeof GetSchoolMetricsType
442
+ > = GetSchoolMetricsType$inboundSchema;
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 GetSchoolMetricsType$ {
449
+ /** @deprecated use `GetSchoolMetricsType$inboundSchema` instead. */
450
+ export const inboundSchema = GetSchoolMetricsType$inboundSchema;
451
+ /** @deprecated use `GetSchoolMetricsType$outboundSchema` instead. */
452
+ export const outboundSchema = GetSchoolMetricsType$outboundSchema;
453
+ }
454
+
455
+ /** @internal */
456
+ export const GetSchoolMetricsSchoolMetricsError$inboundSchema: z.ZodType<
457
+ GetSchoolMetricsSchoolMetricsError,
458
+ z.ZodTypeDef,
459
+ unknown
460
+ > = z.object({
461
+ code: z.string().optional(),
462
+ message: z.string(),
463
+ param: z.string().optional(),
464
+ type: GetSchoolMetricsType$inboundSchema,
465
+ });
466
+
467
+ /** @internal */
468
+ export type GetSchoolMetricsSchoolMetricsError$Outbound = {
469
+ code?: string | undefined;
470
+ message: string;
471
+ param?: string | undefined;
472
+ type: string;
473
+ };
474
+
475
+ /** @internal */
476
+ export const GetSchoolMetricsSchoolMetricsError$outboundSchema: z.ZodType<
477
+ GetSchoolMetricsSchoolMetricsError$Outbound,
478
+ z.ZodTypeDef,
479
+ GetSchoolMetricsSchoolMetricsError
480
+ > = z.object({
481
+ code: z.string().optional(),
482
+ message: z.string(),
483
+ param: z.string().optional(),
484
+ type: GetSchoolMetricsType$outboundSchema,
485
+ });
486
+
487
+ /**
488
+ * @internal
489
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
490
+ */
491
+ export namespace GetSchoolMetricsSchoolMetricsError$ {
492
+ /** @deprecated use `GetSchoolMetricsSchoolMetricsError$inboundSchema` instead. */
493
+ export const inboundSchema = GetSchoolMetricsSchoolMetricsError$inboundSchema;
494
+ /** @deprecated use `GetSchoolMetricsSchoolMetricsError$outboundSchema` instead. */
495
+ export const outboundSchema =
496
+ GetSchoolMetricsSchoolMetricsError$outboundSchema;
497
+ /** @deprecated use `GetSchoolMetricsSchoolMetricsError$Outbound` instead. */
498
+ export type Outbound = GetSchoolMetricsSchoolMetricsError$Outbound;
499
+ }
500
+
501
+ export function getSchoolMetricsSchoolMetricsErrorToJSON(
502
+ getSchoolMetricsSchoolMetricsError: GetSchoolMetricsSchoolMetricsError,
503
+ ): string {
504
+ return JSON.stringify(
505
+ GetSchoolMetricsSchoolMetricsError$outboundSchema.parse(
506
+ getSchoolMetricsSchoolMetricsError,
507
+ ),
508
+ );
509
+ }
510
+
511
+ export function getSchoolMetricsSchoolMetricsErrorFromJSON(
512
+ jsonString: string,
513
+ ): SafeParseResult<GetSchoolMetricsSchoolMetricsError, SDKValidationError> {
514
+ return safeParse(
515
+ jsonString,
516
+ (x) =>
517
+ GetSchoolMetricsSchoolMetricsError$inboundSchema.parse(JSON.parse(x)),
518
+ `Failed to parse 'GetSchoolMetricsSchoolMetricsError' from JSON`,
519
+ );
520
+ }
521
+
522
+ /** @internal */
523
+ export const GetSchoolMetricsSchoolMetricsResponseResponseBody$inboundSchema:
524
+ z.ZodType<
525
+ GetSchoolMetricsSchoolMetricsResponseResponseBody,
526
+ z.ZodTypeDef,
527
+ unknown
528
+ > = z.object({
529
+ error: z.lazy(() => GetSchoolMetricsSchoolMetricsError$inboundSchema),
530
+ });
531
+
532
+ /** @internal */
533
+ export type GetSchoolMetricsSchoolMetricsResponseResponseBody$Outbound = {
534
+ error: GetSchoolMetricsSchoolMetricsError$Outbound;
535
+ };
536
+
537
+ /** @internal */
538
+ export const GetSchoolMetricsSchoolMetricsResponseResponseBody$outboundSchema:
539
+ z.ZodType<
540
+ GetSchoolMetricsSchoolMetricsResponseResponseBody$Outbound,
541
+ z.ZodTypeDef,
542
+ GetSchoolMetricsSchoolMetricsResponseResponseBody
543
+ > = z.object({
544
+ error: z.lazy(() => GetSchoolMetricsSchoolMetricsError$outboundSchema),
545
+ });
546
+
547
+ /**
548
+ * @internal
549
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
550
+ */
551
+ export namespace GetSchoolMetricsSchoolMetricsResponseResponseBody$ {
552
+ /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseResponseBody$inboundSchema` instead. */
553
+ export const inboundSchema =
554
+ GetSchoolMetricsSchoolMetricsResponseResponseBody$inboundSchema;
555
+ /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseResponseBody$outboundSchema` instead. */
556
+ export const outboundSchema =
557
+ GetSchoolMetricsSchoolMetricsResponseResponseBody$outboundSchema;
558
+ /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseResponseBody$Outbound` instead. */
559
+ export type Outbound =
560
+ GetSchoolMetricsSchoolMetricsResponseResponseBody$Outbound;
561
+ }
562
+
563
+ export function getSchoolMetricsSchoolMetricsResponseResponseBodyToJSON(
564
+ getSchoolMetricsSchoolMetricsResponseResponseBody:
565
+ GetSchoolMetricsSchoolMetricsResponseResponseBody,
566
+ ): string {
567
+ return JSON.stringify(
568
+ GetSchoolMetricsSchoolMetricsResponseResponseBody$outboundSchema.parse(
569
+ getSchoolMetricsSchoolMetricsResponseResponseBody,
570
+ ),
571
+ );
572
+ }
573
+
574
+ export function getSchoolMetricsSchoolMetricsResponseResponseBodyFromJSON(
575
+ jsonString: string,
576
+ ): SafeParseResult<
577
+ GetSchoolMetricsSchoolMetricsResponseResponseBody,
578
+ SDKValidationError
579
+ > {
580
+ return safeParse(
581
+ jsonString,
582
+ (x) =>
583
+ GetSchoolMetricsSchoolMetricsResponseResponseBody$inboundSchema.parse(
584
+ JSON.parse(x),
585
+ ),
586
+ `Failed to parse 'GetSchoolMetricsSchoolMetricsResponseResponseBody' from JSON`,
587
+ );
588
+ }
589
+
590
+ /** @internal */
591
+ export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
592
+ Type,
593
+ );
594
+
595
+ /** @internal */
596
+ export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
597
+ Type$inboundSchema;
598
+
599
+ /**
600
+ * @internal
601
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
602
+ */
603
+ export namespace Type$ {
604
+ /** @deprecated use `Type$inboundSchema` instead. */
605
+ export const inboundSchema = Type$inboundSchema;
606
+ /** @deprecated use `Type$outboundSchema` instead. */
607
+ export const outboundSchema = Type$outboundSchema;
608
+ }
609
+
610
+ /** @internal */
611
+ export const GetSchoolMetricsError$inboundSchema: z.ZodType<
612
+ GetSchoolMetricsError,
613
+ z.ZodTypeDef,
614
+ unknown
615
+ > = z.object({
616
+ code: z.string().optional(),
617
+ message: z.string(),
618
+ param: z.string().optional(),
619
+ type: Type$inboundSchema,
620
+ });
621
+
622
+ /** @internal */
623
+ export type GetSchoolMetricsError$Outbound = {
624
+ code?: string | undefined;
625
+ message: string;
626
+ param?: string | undefined;
627
+ type: string;
628
+ };
629
+
630
+ /** @internal */
631
+ export const GetSchoolMetricsError$outboundSchema: z.ZodType<
632
+ GetSchoolMetricsError$Outbound,
633
+ z.ZodTypeDef,
634
+ GetSchoolMetricsError
635
+ > = z.object({
636
+ code: z.string().optional(),
637
+ message: z.string(),
638
+ param: z.string().optional(),
639
+ type: Type$outboundSchema,
640
+ });
641
+
642
+ /**
643
+ * @internal
644
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
645
+ */
646
+ export namespace GetSchoolMetricsError$ {
647
+ /** @deprecated use `GetSchoolMetricsError$inboundSchema` instead. */
648
+ export const inboundSchema = GetSchoolMetricsError$inboundSchema;
649
+ /** @deprecated use `GetSchoolMetricsError$outboundSchema` instead. */
650
+ export const outboundSchema = GetSchoolMetricsError$outboundSchema;
651
+ /** @deprecated use `GetSchoolMetricsError$Outbound` instead. */
652
+ export type Outbound = GetSchoolMetricsError$Outbound;
653
+ }
654
+
655
+ export function getSchoolMetricsErrorToJSON(
656
+ getSchoolMetricsError: GetSchoolMetricsError,
657
+ ): string {
658
+ return JSON.stringify(
659
+ GetSchoolMetricsError$outboundSchema.parse(getSchoolMetricsError),
660
+ );
661
+ }
662
+
663
+ export function getSchoolMetricsErrorFromJSON(
664
+ jsonString: string,
665
+ ): SafeParseResult<GetSchoolMetricsError, SDKValidationError> {
666
+ return safeParse(
667
+ jsonString,
668
+ (x) => GetSchoolMetricsError$inboundSchema.parse(JSON.parse(x)),
669
+ `Failed to parse 'GetSchoolMetricsError' from JSON`,
670
+ );
671
+ }
672
+
673
+ /** @internal */
674
+ export const GetSchoolMetricsSchoolMetricsResponseBody$inboundSchema: z.ZodType<
675
+ GetSchoolMetricsSchoolMetricsResponseBody,
676
+ z.ZodTypeDef,
677
+ unknown
678
+ > = z.object({
679
+ error: z.lazy(() => GetSchoolMetricsError$inboundSchema),
680
+ });
681
+
682
+ /** @internal */
683
+ export type GetSchoolMetricsSchoolMetricsResponseBody$Outbound = {
684
+ error: GetSchoolMetricsError$Outbound;
685
+ };
686
+
687
+ /** @internal */
688
+ export const GetSchoolMetricsSchoolMetricsResponseBody$outboundSchema:
689
+ z.ZodType<
690
+ GetSchoolMetricsSchoolMetricsResponseBody$Outbound,
691
+ z.ZodTypeDef,
692
+ GetSchoolMetricsSchoolMetricsResponseBody
693
+ > = z.object({
694
+ error: z.lazy(() => GetSchoolMetricsError$outboundSchema),
695
+ });
696
+
697
+ /**
698
+ * @internal
699
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
700
+ */
701
+ export namespace GetSchoolMetricsSchoolMetricsResponseBody$ {
702
+ /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseBody$inboundSchema` instead. */
703
+ export const inboundSchema =
704
+ GetSchoolMetricsSchoolMetricsResponseBody$inboundSchema;
705
+ /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseBody$outboundSchema` instead. */
706
+ export const outboundSchema =
707
+ GetSchoolMetricsSchoolMetricsResponseBody$outboundSchema;
708
+ /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseBody$Outbound` instead. */
709
+ export type Outbound = GetSchoolMetricsSchoolMetricsResponseBody$Outbound;
710
+ }
711
+
712
+ export function getSchoolMetricsSchoolMetricsResponseBodyToJSON(
713
+ getSchoolMetricsSchoolMetricsResponseBody:
714
+ GetSchoolMetricsSchoolMetricsResponseBody,
715
+ ): string {
716
+ return JSON.stringify(
717
+ GetSchoolMetricsSchoolMetricsResponseBody$outboundSchema.parse(
718
+ getSchoolMetricsSchoolMetricsResponseBody,
719
+ ),
720
+ );
721
+ }
722
+
723
+ export function getSchoolMetricsSchoolMetricsResponseBodyFromJSON(
724
+ jsonString: string,
725
+ ): SafeParseResult<
726
+ GetSchoolMetricsSchoolMetricsResponseBody,
727
+ SDKValidationError
728
+ > {
729
+ return safeParse(
730
+ jsonString,
731
+ (x) =>
732
+ GetSchoolMetricsSchoolMetricsResponseBody$inboundSchema.parse(
733
+ JSON.parse(x),
734
+ ),
735
+ `Failed to parse 'GetSchoolMetricsSchoolMetricsResponseBody' from JSON`,
736
+ );
737
+ }
738
+
739
+ /** @internal */
740
+ export const GetSchoolMetricsDataType$inboundSchema: z.ZodNativeEnum<
741
+ typeof GetSchoolMetricsDataType
742
+ > = z.nativeEnum(GetSchoolMetricsDataType);
743
+
744
+ /** @internal */
745
+ export const GetSchoolMetricsDataType$outboundSchema: z.ZodNativeEnum<
746
+ typeof GetSchoolMetricsDataType
747
+ > = GetSchoolMetricsDataType$inboundSchema;
748
+
749
+ /**
750
+ * @internal
751
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
752
+ */
753
+ export namespace GetSchoolMetricsDataType$ {
754
+ /** @deprecated use `GetSchoolMetricsDataType$inboundSchema` instead. */
755
+ export const inboundSchema = GetSchoolMetricsDataType$inboundSchema;
756
+ /** @deprecated use `GetSchoolMetricsDataType$outboundSchema` instead. */
757
+ export const outboundSchema = GetSchoolMetricsDataType$outboundSchema;
758
+ }
759
+
760
+ /** @internal */
761
+ export const GetSchoolMetricsDefinitions$inboundSchema: z.ZodType<
762
+ GetSchoolMetricsDefinitions,
763
+ z.ZodTypeDef,
764
+ unknown
765
+ > = z.object({
766
+ category: z.string(),
767
+ code: z.string(),
768
+ dataType: GetSchoolMetricsDataType$inboundSchema,
769
+ description: z.string(),
770
+ isHigherBetter: z.boolean().optional(),
771
+ nationalAverage: z.number().optional(),
772
+ subcategory: z.string(),
773
+ units: z.string().optional(),
774
+ });
775
+
776
+ /** @internal */
777
+ export type GetSchoolMetricsDefinitions$Outbound = {
778
+ category: string;
779
+ code: string;
780
+ dataType: string;
781
+ description: string;
782
+ isHigherBetter?: boolean | undefined;
783
+ nationalAverage?: number | undefined;
784
+ subcategory: string;
785
+ units?: string | undefined;
786
+ };
787
+
788
+ /** @internal */
789
+ export const GetSchoolMetricsDefinitions$outboundSchema: z.ZodType<
790
+ GetSchoolMetricsDefinitions$Outbound,
791
+ z.ZodTypeDef,
792
+ GetSchoolMetricsDefinitions
793
+ > = z.object({
794
+ category: z.string(),
795
+ code: z.string(),
796
+ dataType: GetSchoolMetricsDataType$outboundSchema,
797
+ description: z.string(),
798
+ isHigherBetter: z.boolean().optional(),
799
+ nationalAverage: z.number().optional(),
800
+ subcategory: z.string(),
801
+ units: z.string().optional(),
802
+ });
803
+
804
+ /**
805
+ * @internal
806
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
807
+ */
808
+ export namespace GetSchoolMetricsDefinitions$ {
809
+ /** @deprecated use `GetSchoolMetricsDefinitions$inboundSchema` instead. */
810
+ export const inboundSchema = GetSchoolMetricsDefinitions$inboundSchema;
811
+ /** @deprecated use `GetSchoolMetricsDefinitions$outboundSchema` instead. */
812
+ export const outboundSchema = GetSchoolMetricsDefinitions$outboundSchema;
813
+ /** @deprecated use `GetSchoolMetricsDefinitions$Outbound` instead. */
814
+ export type Outbound = GetSchoolMetricsDefinitions$Outbound;
815
+ }
816
+
817
+ export function getSchoolMetricsDefinitionsToJSON(
818
+ getSchoolMetricsDefinitions: GetSchoolMetricsDefinitions,
819
+ ): string {
820
+ return JSON.stringify(
821
+ GetSchoolMetricsDefinitions$outboundSchema.parse(
822
+ getSchoolMetricsDefinitions,
823
+ ),
824
+ );
825
+ }
826
+
827
+ export function getSchoolMetricsDefinitionsFromJSON(
828
+ jsonString: string,
829
+ ): SafeParseResult<GetSchoolMetricsDefinitions, SDKValidationError> {
830
+ return safeParse(
831
+ jsonString,
832
+ (x) => GetSchoolMetricsDefinitions$inboundSchema.parse(JSON.parse(x)),
833
+ `Failed to parse 'GetSchoolMetricsDefinitions' from JSON`,
834
+ );
835
+ }
836
+
837
+ /** @internal */
838
+ export const Values$inboundSchema: z.ZodType<Values, z.ZodTypeDef, unknown> = z
839
+ .union([z.number(), z.string()]);
840
+
841
+ /** @internal */
842
+ export type Values$Outbound = number | string;
843
+
844
+ /** @internal */
845
+ export const Values$outboundSchema: z.ZodType<
846
+ Values$Outbound,
847
+ z.ZodTypeDef,
848
+ Values
849
+ > = z.union([z.number(), z.string()]);
850
+
851
+ /**
852
+ * @internal
853
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
854
+ */
855
+ export namespace Values$ {
856
+ /** @deprecated use `Values$inboundSchema` instead. */
857
+ export const inboundSchema = Values$inboundSchema;
858
+ /** @deprecated use `Values$outboundSchema` instead. */
859
+ export const outboundSchema = Values$outboundSchema;
860
+ /** @deprecated use `Values$Outbound` instead. */
861
+ export type Outbound = Values$Outbound;
862
+ }
863
+
864
+ export function valuesToJSON(values: Values): string {
865
+ return JSON.stringify(Values$outboundSchema.parse(values));
866
+ }
867
+
868
+ export function valuesFromJSON(
869
+ jsonString: string,
870
+ ): SafeParseResult<Values, SDKValidationError> {
871
+ return safeParse(
872
+ jsonString,
873
+ (x) => Values$inboundSchema.parse(JSON.parse(x)),
874
+ `Failed to parse 'Values' from JSON`,
875
+ );
876
+ }
877
+
878
+ /** @internal */
879
+ export const Series$inboundSchema: z.ZodType<Series, z.ZodTypeDef, unknown> = z
880
+ .object({
881
+ values: z.record(z.union([z.number(), z.string()])),
882
+ year: z.string(),
883
+ });
884
+
885
+ /** @internal */
886
+ export type Series$Outbound = {
887
+ values: { [k: string]: number | string };
888
+ year: string;
889
+ };
890
+
891
+ /** @internal */
892
+ export const Series$outboundSchema: z.ZodType<
893
+ Series$Outbound,
894
+ z.ZodTypeDef,
895
+ Series
896
+ > = z.object({
897
+ values: z.record(z.union([z.number(), z.string()])),
898
+ year: z.string(),
899
+ });
900
+
901
+ /**
902
+ * @internal
903
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
904
+ */
905
+ export namespace Series$ {
906
+ /** @deprecated use `Series$inboundSchema` instead. */
907
+ export const inboundSchema = Series$inboundSchema;
908
+ /** @deprecated use `Series$outboundSchema` instead. */
909
+ export const outboundSchema = Series$outboundSchema;
910
+ /** @deprecated use `Series$Outbound` instead. */
911
+ export type Outbound = Series$Outbound;
912
+ }
913
+
914
+ export function seriesToJSON(series: Series): string {
915
+ return JSON.stringify(Series$outboundSchema.parse(series));
916
+ }
917
+
918
+ export function seriesFromJSON(
919
+ jsonString: string,
920
+ ): SafeParseResult<Series, SDKValidationError> {
921
+ return safeParse(
922
+ jsonString,
923
+ (x) => Series$inboundSchema.parse(JSON.parse(x)),
924
+ `Failed to parse 'Series' from JSON`,
925
+ );
926
+ }
927
+
928
+ /** @internal */
929
+ export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
930
+ .object({
931
+ definitions: z.array(
932
+ z.lazy(() => GetSchoolMetricsDefinitions$inboundSchema),
933
+ ).optional(),
934
+ metricCodes: z.array(z.string()),
935
+ schoolId: z.number(),
936
+ series: z.array(z.lazy(() => Series$inboundSchema)),
937
+ });
938
+
939
+ /** @internal */
940
+ export type Two$Outbound = {
941
+ definitions?: Array<GetSchoolMetricsDefinitions$Outbound> | undefined;
942
+ metricCodes: Array<string>;
943
+ schoolId: number;
944
+ series: Array<Series$Outbound>;
945
+ };
946
+
947
+ /** @internal */
948
+ export const Two$outboundSchema: z.ZodType<Two$Outbound, z.ZodTypeDef, Two> = z
949
+ .object({
950
+ definitions: z.array(
951
+ z.lazy(() => GetSchoolMetricsDefinitions$outboundSchema),
952
+ ).optional(),
953
+ metricCodes: z.array(z.string()),
954
+ schoolId: z.number(),
955
+ series: z.array(z.lazy(() => Series$outboundSchema)),
956
+ });
957
+
958
+ /**
959
+ * @internal
960
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
961
+ */
962
+ export namespace Two$ {
963
+ /** @deprecated use `Two$inboundSchema` instead. */
964
+ export const inboundSchema = Two$inboundSchema;
965
+ /** @deprecated use `Two$outboundSchema` instead. */
966
+ export const outboundSchema = Two$outboundSchema;
967
+ /** @deprecated use `Two$Outbound` instead. */
968
+ export type Outbound = Two$Outbound;
969
+ }
970
+
971
+ export function twoToJSON(two: Two): string {
972
+ return JSON.stringify(Two$outboundSchema.parse(two));
973
+ }
974
+
975
+ export function twoFromJSON(
976
+ jsonString: string,
977
+ ): SafeParseResult<Two, SDKValidationError> {
978
+ return safeParse(
979
+ jsonString,
980
+ (x) => Two$inboundSchema.parse(JSON.parse(x)),
981
+ `Failed to parse 'Two' from JSON`,
982
+ );
983
+ }
984
+
985
+ /** @internal */
986
+ export const Comparisons$inboundSchema: z.ZodType<
987
+ Comparisons,
988
+ z.ZodTypeDef,
989
+ unknown
990
+ > = z.object({
991
+ localAuthority: z.number().optional(),
992
+ national: z.number().optional(),
993
+ regional: z.number().optional(),
994
+ similarSchools: z.number().optional(),
995
+ });
996
+
997
+ /** @internal */
998
+ export type Comparisons$Outbound = {
999
+ localAuthority?: number | undefined;
1000
+ national?: number | undefined;
1001
+ regional?: number | undefined;
1002
+ similarSchools?: number | undefined;
1003
+ };
1004
+
1005
+ /** @internal */
1006
+ export const Comparisons$outboundSchema: z.ZodType<
1007
+ Comparisons$Outbound,
1008
+ z.ZodTypeDef,
1009
+ Comparisons
1010
+ > = z.object({
1011
+ localAuthority: z.number().optional(),
1012
+ national: z.number().optional(),
1013
+ regional: z.number().optional(),
1014
+ similarSchools: z.number().optional(),
1015
+ });
1016
+
1017
+ /**
1018
+ * @internal
1019
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1020
+ */
1021
+ export namespace Comparisons$ {
1022
+ /** @deprecated use `Comparisons$inboundSchema` instead. */
1023
+ export const inboundSchema = Comparisons$inboundSchema;
1024
+ /** @deprecated use `Comparisons$outboundSchema` instead. */
1025
+ export const outboundSchema = Comparisons$outboundSchema;
1026
+ /** @deprecated use `Comparisons$Outbound` instead. */
1027
+ export type Outbound = Comparisons$Outbound;
1028
+ }
1029
+
1030
+ export function comparisonsToJSON(comparisons: Comparisons): string {
1031
+ return JSON.stringify(Comparisons$outboundSchema.parse(comparisons));
1032
+ }
1033
+
1034
+ export function comparisonsFromJSON(
1035
+ jsonString: string,
1036
+ ): SafeParseResult<Comparisons, SDKValidationError> {
1037
+ return safeParse(
1038
+ jsonString,
1039
+ (x) => Comparisons$inboundSchema.parse(JSON.parse(x)),
1040
+ `Failed to parse 'Comparisons' from JSON`,
1041
+ );
1042
+ }
1043
+
1044
+ /** @internal */
1045
+ export const DataType$inboundSchema: z.ZodNativeEnum<typeof DataType> = z
1046
+ .nativeEnum(DataType);
1047
+
1048
+ /** @internal */
1049
+ export const DataType$outboundSchema: z.ZodNativeEnum<typeof DataType> =
1050
+ DataType$inboundSchema;
1051
+
1052
+ /**
1053
+ * @internal
1054
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1055
+ */
1056
+ export namespace DataType$ {
1057
+ /** @deprecated use `DataType$inboundSchema` instead. */
1058
+ export const inboundSchema = DataType$inboundSchema;
1059
+ /** @deprecated use `DataType$outboundSchema` instead. */
1060
+ export const outboundSchema = DataType$outboundSchema;
1061
+ }
1062
+
1063
+ /** @internal */
1064
+ export const Definitions$inboundSchema: z.ZodType<
1065
+ Definitions,
1066
+ z.ZodTypeDef,
1067
+ unknown
1068
+ > = z.object({
1069
+ category: z.string(),
1070
+ code: z.string(),
1071
+ dataType: DataType$inboundSchema,
1072
+ description: z.string(),
1073
+ isHigherBetter: z.boolean().optional(),
1074
+ nationalAverage: z.number().optional(),
1075
+ subcategory: z.string(),
1076
+ units: z.string().optional(),
1077
+ });
1078
+
1079
+ /** @internal */
1080
+ export type Definitions$Outbound = {
1081
+ category: string;
1082
+ code: string;
1083
+ dataType: string;
1084
+ description: string;
1085
+ isHigherBetter?: boolean | undefined;
1086
+ nationalAverage?: number | undefined;
1087
+ subcategory: string;
1088
+ units?: string | undefined;
1089
+ };
1090
+
1091
+ /** @internal */
1092
+ export const Definitions$outboundSchema: z.ZodType<
1093
+ Definitions$Outbound,
1094
+ z.ZodTypeDef,
1095
+ Definitions
1096
+ > = z.object({
1097
+ category: z.string(),
1098
+ code: z.string(),
1099
+ dataType: DataType$outboundSchema,
1100
+ description: z.string(),
1101
+ isHigherBetter: z.boolean().optional(),
1102
+ nationalAverage: z.number().optional(),
1103
+ subcategory: z.string(),
1104
+ units: z.string().optional(),
1105
+ });
1106
+
1107
+ /**
1108
+ * @internal
1109
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1110
+ */
1111
+ export namespace Definitions$ {
1112
+ /** @deprecated use `Definitions$inboundSchema` instead. */
1113
+ export const inboundSchema = Definitions$inboundSchema;
1114
+ /** @deprecated use `Definitions$outboundSchema` instead. */
1115
+ export const outboundSchema = Definitions$outboundSchema;
1116
+ /** @deprecated use `Definitions$Outbound` instead. */
1117
+ export type Outbound = Definitions$Outbound;
1118
+ }
1119
+
1120
+ export function definitionsToJSON(definitions: Definitions): string {
1121
+ return JSON.stringify(Definitions$outboundSchema.parse(definitions));
1122
+ }
1123
+
1124
+ export function definitionsFromJSON(
1125
+ jsonString: string,
1126
+ ): SafeParseResult<Definitions, SDKValidationError> {
1127
+ return safeParse(
1128
+ jsonString,
1129
+ (x) => Definitions$inboundSchema.parse(JSON.parse(x)),
1130
+ `Failed to parse 'Definitions' from JSON`,
1131
+ );
1132
+ }
1133
+
1134
+ /** @internal */
1135
+ export const Confidence$inboundSchema: z.ZodType<
1136
+ Confidence,
1137
+ z.ZodTypeDef,
1138
+ unknown
1139
+ > = z.object({
1140
+ lower: z.number().optional(),
1141
+ upper: z.number().optional(),
1142
+ });
1143
+
1144
+ /** @internal */
1145
+ export type Confidence$Outbound = {
1146
+ lower?: number | undefined;
1147
+ upper?: number | undefined;
1148
+ };
1149
+
1150
+ /** @internal */
1151
+ export const Confidence$outboundSchema: z.ZodType<
1152
+ Confidence$Outbound,
1153
+ z.ZodTypeDef,
1154
+ Confidence
1155
+ > = z.object({
1156
+ lower: z.number().optional(),
1157
+ upper: z.number().optional(),
1158
+ });
1159
+
1160
+ /**
1161
+ * @internal
1162
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1163
+ */
1164
+ export namespace Confidence$ {
1165
+ /** @deprecated use `Confidence$inboundSchema` instead. */
1166
+ export const inboundSchema = Confidence$inboundSchema;
1167
+ /** @deprecated use `Confidence$outboundSchema` instead. */
1168
+ export const outboundSchema = Confidence$outboundSchema;
1169
+ /** @deprecated use `Confidence$Outbound` instead. */
1170
+ export type Outbound = Confidence$Outbound;
1171
+ }
1172
+
1173
+ export function confidenceToJSON(confidence: Confidence): string {
1174
+ return JSON.stringify(Confidence$outboundSchema.parse(confidence));
1175
+ }
1176
+
1177
+ export function confidenceFromJSON(
1178
+ jsonString: string,
1179
+ ): SafeParseResult<Confidence, SDKValidationError> {
1180
+ return safeParse(
1181
+ jsonString,
1182
+ (x) => Confidence$inboundSchema.parse(JSON.parse(x)),
1183
+ `Failed to parse 'Confidence' from JSON`,
1184
+ );
1185
+ }
1186
+
1187
+ /** @internal */
1188
+ export const Value$inboundSchema: z.ZodType<Value, z.ZodTypeDef, unknown> = z
1189
+ .union([z.number(), z.string()]);
1190
+
1191
+ /** @internal */
1192
+ export type Value$Outbound = number | string;
1193
+
1194
+ /** @internal */
1195
+ export const Value$outboundSchema: z.ZodType<
1196
+ Value$Outbound,
1197
+ z.ZodTypeDef,
1198
+ Value
1199
+ > = z.union([z.number(), z.string()]);
1200
+
1201
+ /**
1202
+ * @internal
1203
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1204
+ */
1205
+ export namespace Value$ {
1206
+ /** @deprecated use `Value$inboundSchema` instead. */
1207
+ export const inboundSchema = Value$inboundSchema;
1208
+ /** @deprecated use `Value$outboundSchema` instead. */
1209
+ export const outboundSchema = Value$outboundSchema;
1210
+ /** @deprecated use `Value$Outbound` instead. */
1211
+ export type Outbound = Value$Outbound;
1212
+ }
1213
+
1214
+ export function valueToJSON(value: Value): string {
1215
+ return JSON.stringify(Value$outboundSchema.parse(value));
1216
+ }
1217
+
1218
+ export function valueFromJSON(
1219
+ jsonString: string,
1220
+ ): SafeParseResult<Value, SDKValidationError> {
1221
+ return safeParse(
1222
+ jsonString,
1223
+ (x) => Value$inboundSchema.parse(JSON.parse(x)),
1224
+ `Failed to parse 'Value' from JSON`,
1225
+ );
1226
+ }
1227
+
1228
+ /** @internal */
1229
+ export const Metrics$inboundSchema: z.ZodType<Metrics, z.ZodTypeDef, unknown> =
1230
+ z.object({
1231
+ academicYear: z.string().optional(),
1232
+ code: z.string(),
1233
+ cohortType: z.string().optional(),
1234
+ confidence: z.lazy(() => Confidence$inboundSchema).optional(),
1235
+ metadata: z.record(z.nullable(z.any())).optional(),
1236
+ value: z.union([z.number(), z.string()]),
1237
+ });
1238
+
1239
+ /** @internal */
1240
+ export type Metrics$Outbound = {
1241
+ academicYear?: string | undefined;
1242
+ code: string;
1243
+ cohortType?: string | undefined;
1244
+ confidence?: Confidence$Outbound | undefined;
1245
+ metadata?: { [k: string]: any | null } | undefined;
1246
+ value: number | string;
1247
+ };
1248
+
1249
+ /** @internal */
1250
+ export const Metrics$outboundSchema: z.ZodType<
1251
+ Metrics$Outbound,
1252
+ z.ZodTypeDef,
1253
+ Metrics
1254
+ > = z.object({
1255
+ academicYear: z.string().optional(),
1256
+ code: z.string(),
1257
+ cohortType: z.string().optional(),
1258
+ confidence: z.lazy(() => Confidence$outboundSchema).optional(),
1259
+ metadata: z.record(z.nullable(z.any())).optional(),
1260
+ value: z.union([z.number(), z.string()]),
1261
+ });
1262
+
1263
+ /**
1264
+ * @internal
1265
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1266
+ */
1267
+ export namespace Metrics$ {
1268
+ /** @deprecated use `Metrics$inboundSchema` instead. */
1269
+ export const inboundSchema = Metrics$inboundSchema;
1270
+ /** @deprecated use `Metrics$outboundSchema` instead. */
1271
+ export const outboundSchema = Metrics$outboundSchema;
1272
+ /** @deprecated use `Metrics$Outbound` instead. */
1273
+ export type Outbound = Metrics$Outbound;
1274
+ }
1275
+
1276
+ export function metricsToJSON(metrics: Metrics): string {
1277
+ return JSON.stringify(Metrics$outboundSchema.parse(metrics));
1278
+ }
1279
+
1280
+ export function metricsFromJSON(
1281
+ jsonString: string,
1282
+ ): SafeParseResult<Metrics, SDKValidationError> {
1283
+ return safeParse(
1284
+ jsonString,
1285
+ (x) => Metrics$inboundSchema.parse(JSON.parse(x)),
1286
+ `Failed to parse 'Metrics' from JSON`,
1287
+ );
1288
+ }
1289
+
1290
+ /** @internal */
1291
+ export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
1292
+ .object({
1293
+ comparisons: z.record(z.lazy(() => Comparisons$inboundSchema)).optional(),
1294
+ definitions: z.array(z.lazy(() => Definitions$inboundSchema)).optional(),
1295
+ metrics: z.array(z.lazy(() => Metrics$inboundSchema)),
1296
+ schoolId: z.number(),
1297
+ });
1298
+
1299
+ /** @internal */
1300
+ export type One$Outbound = {
1301
+ comparisons?: { [k: string]: Comparisons$Outbound } | undefined;
1302
+ definitions?: Array<Definitions$Outbound> | undefined;
1303
+ metrics: Array<Metrics$Outbound>;
1304
+ schoolId: number;
1305
+ };
1306
+
1307
+ /** @internal */
1308
+ export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
1309
+ .object({
1310
+ comparisons: z.record(z.lazy(() => Comparisons$outboundSchema)).optional(),
1311
+ definitions: z.array(z.lazy(() => Definitions$outboundSchema)).optional(),
1312
+ metrics: z.array(z.lazy(() => Metrics$outboundSchema)),
1313
+ schoolId: z.number(),
1314
+ });
1315
+
1316
+ /**
1317
+ * @internal
1318
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1319
+ */
1320
+ export namespace One$ {
1321
+ /** @deprecated use `One$inboundSchema` instead. */
1322
+ export const inboundSchema = One$inboundSchema;
1323
+ /** @deprecated use `One$outboundSchema` instead. */
1324
+ export const outboundSchema = One$outboundSchema;
1325
+ /** @deprecated use `One$Outbound` instead. */
1326
+ export type Outbound = One$Outbound;
1327
+ }
1328
+
1329
+ export function oneToJSON(one: One): string {
1330
+ return JSON.stringify(One$outboundSchema.parse(one));
1331
+ }
1332
+
1333
+ export function oneFromJSON(
1334
+ jsonString: string,
1335
+ ): SafeParseResult<One, SDKValidationError> {
1336
+ return safeParse(
1337
+ jsonString,
1338
+ (x) => One$inboundSchema.parse(JSON.parse(x)),
1339
+ `Failed to parse 'One' from JSON`,
1340
+ );
1341
+ }
1342
+
1343
+ /** @internal */
1344
+ export const GetSchoolMetricsData$inboundSchema: z.ZodType<
1345
+ GetSchoolMetricsData,
1346
+ z.ZodTypeDef,
1347
+ unknown
1348
+ > = z.union([
1349
+ z.array(z.lazy(() => One$inboundSchema)),
1350
+ z.array(z.lazy(() => Two$inboundSchema)),
1351
+ ]);
1352
+
1353
+ /** @internal */
1354
+ export type GetSchoolMetricsData$Outbound =
1355
+ | Array<One$Outbound>
1356
+ | Array<Two$Outbound>;
1357
+
1358
+ /** @internal */
1359
+ export const GetSchoolMetricsData$outboundSchema: z.ZodType<
1360
+ GetSchoolMetricsData$Outbound,
1361
+ z.ZodTypeDef,
1362
+ GetSchoolMetricsData
1363
+ > = z.union([
1364
+ z.array(z.lazy(() => One$outboundSchema)),
1365
+ z.array(z.lazy(() => Two$outboundSchema)),
1366
+ ]);
1367
+
1368
+ /**
1369
+ * @internal
1370
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1371
+ */
1372
+ export namespace GetSchoolMetricsData$ {
1373
+ /** @deprecated use `GetSchoolMetricsData$inboundSchema` instead. */
1374
+ export const inboundSchema = GetSchoolMetricsData$inboundSchema;
1375
+ /** @deprecated use `GetSchoolMetricsData$outboundSchema` instead. */
1376
+ export const outboundSchema = GetSchoolMetricsData$outboundSchema;
1377
+ /** @deprecated use `GetSchoolMetricsData$Outbound` instead. */
1378
+ export type Outbound = GetSchoolMetricsData$Outbound;
1379
+ }
1380
+
1381
+ export function getSchoolMetricsDataToJSON(
1382
+ getSchoolMetricsData: GetSchoolMetricsData,
1383
+ ): string {
1384
+ return JSON.stringify(
1385
+ GetSchoolMetricsData$outboundSchema.parse(getSchoolMetricsData),
1386
+ );
1387
+ }
1388
+
1389
+ export function getSchoolMetricsDataFromJSON(
1390
+ jsonString: string,
1391
+ ): SafeParseResult<GetSchoolMetricsData, SDKValidationError> {
1392
+ return safeParse(
1393
+ jsonString,
1394
+ (x) => GetSchoolMetricsData$inboundSchema.parse(JSON.parse(x)),
1395
+ `Failed to parse 'GetSchoolMetricsData' from JSON`,
1396
+ );
1397
+ }
1398
+
1399
+ /** @internal */
1400
+ export const GetSchoolMetricsObject$inboundSchema: z.ZodNativeEnum<
1401
+ typeof GetSchoolMetricsObject
1402
+ > = z.nativeEnum(GetSchoolMetricsObject);
1403
+
1404
+ /** @internal */
1405
+ export const GetSchoolMetricsObject$outboundSchema: z.ZodNativeEnum<
1406
+ typeof GetSchoolMetricsObject
1407
+ > = GetSchoolMetricsObject$inboundSchema;
1408
+
1409
+ /**
1410
+ * @internal
1411
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1412
+ */
1413
+ export namespace GetSchoolMetricsObject$ {
1414
+ /** @deprecated use `GetSchoolMetricsObject$inboundSchema` instead. */
1415
+ export const inboundSchema = GetSchoolMetricsObject$inboundSchema;
1416
+ /** @deprecated use `GetSchoolMetricsObject$outboundSchema` instead. */
1417
+ export const outboundSchema = GetSchoolMetricsObject$outboundSchema;
1418
+ }
1419
+
1420
+ /** @internal */
1421
+ export const GetSchoolMetricsResponseBody$inboundSchema: z.ZodType<
1422
+ GetSchoolMetricsResponseBody,
1423
+ z.ZodTypeDef,
1424
+ unknown
1425
+ > = z.object({
1426
+ data: z.union([
1427
+ z.array(z.lazy(() => One$inboundSchema)),
1428
+ z.array(z.lazy(() => Two$inboundSchema)),
1429
+ ]),
1430
+ has_more: z.boolean(),
1431
+ object: GetSchoolMetricsObject$inboundSchema,
1432
+ total_count: z.number().optional(),
1433
+ url: z.string(),
1434
+ }).transform((v) => {
1435
+ return remap$(v, {
1436
+ "has_more": "hasMore",
1437
+ "total_count": "totalCount",
1438
+ });
1439
+ });
1440
+
1441
+ /** @internal */
1442
+ export type GetSchoolMetricsResponseBody$Outbound = {
1443
+ data: Array<One$Outbound> | Array<Two$Outbound>;
1444
+ has_more: boolean;
1445
+ object: string;
1446
+ total_count?: number | undefined;
1447
+ url: string;
1448
+ };
1449
+
1450
+ /** @internal */
1451
+ export const GetSchoolMetricsResponseBody$outboundSchema: z.ZodType<
1452
+ GetSchoolMetricsResponseBody$Outbound,
1453
+ z.ZodTypeDef,
1454
+ GetSchoolMetricsResponseBody
1455
+ > = z.object({
1456
+ data: z.union([
1457
+ z.array(z.lazy(() => One$outboundSchema)),
1458
+ z.array(z.lazy(() => Two$outboundSchema)),
1459
+ ]),
1460
+ hasMore: z.boolean(),
1461
+ object: GetSchoolMetricsObject$outboundSchema,
1462
+ totalCount: z.number().optional(),
1463
+ url: z.string(),
1464
+ }).transform((v) => {
1465
+ return remap$(v, {
1466
+ hasMore: "has_more",
1467
+ totalCount: "total_count",
1468
+ });
1469
+ });
1470
+
1471
+ /**
1472
+ * @internal
1473
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1474
+ */
1475
+ export namespace GetSchoolMetricsResponseBody$ {
1476
+ /** @deprecated use `GetSchoolMetricsResponseBody$inboundSchema` instead. */
1477
+ export const inboundSchema = GetSchoolMetricsResponseBody$inboundSchema;
1478
+ /** @deprecated use `GetSchoolMetricsResponseBody$outboundSchema` instead. */
1479
+ export const outboundSchema = GetSchoolMetricsResponseBody$outboundSchema;
1480
+ /** @deprecated use `GetSchoolMetricsResponseBody$Outbound` instead. */
1481
+ export type Outbound = GetSchoolMetricsResponseBody$Outbound;
1482
+ }
1483
+
1484
+ export function getSchoolMetricsResponseBodyToJSON(
1485
+ getSchoolMetricsResponseBody: GetSchoolMetricsResponseBody,
1486
+ ): string {
1487
+ return JSON.stringify(
1488
+ GetSchoolMetricsResponseBody$outboundSchema.parse(
1489
+ getSchoolMetricsResponseBody,
1490
+ ),
1491
+ );
1492
+ }
1493
+
1494
+ export function getSchoolMetricsResponseBodyFromJSON(
1495
+ jsonString: string,
1496
+ ): SafeParseResult<GetSchoolMetricsResponseBody, SDKValidationError> {
1497
+ return safeParse(
1498
+ jsonString,
1499
+ (x) => GetSchoolMetricsResponseBody$inboundSchema.parse(JSON.parse(x)),
1500
+ `Failed to parse 'GetSchoolMetricsResponseBody' from JSON`,
1501
+ );
1502
+ }
1503
+
1504
+ /** @internal */
1505
+ export const GetSchoolMetricsResponse$inboundSchema: z.ZodType<
1506
+ GetSchoolMetricsResponse,
1507
+ z.ZodTypeDef,
1508
+ unknown
1509
+ > = z.union([
1510
+ z.lazy(() => GetSchoolMetricsResponseBody$inboundSchema),
1511
+ z.lazy(() => GetSchoolMetricsSchoolMetricsResponseBody$inboundSchema),
1512
+ z.lazy(() => GetSchoolMetricsSchoolMetricsResponseResponseBody$inboundSchema),
1513
+ ]);
1514
+
1515
+ /** @internal */
1516
+ export type GetSchoolMetricsResponse$Outbound =
1517
+ | GetSchoolMetricsResponseBody$Outbound
1518
+ | GetSchoolMetricsSchoolMetricsResponseBody$Outbound
1519
+ | GetSchoolMetricsSchoolMetricsResponseResponseBody$Outbound;
1520
+
1521
+ /** @internal */
1522
+ export const GetSchoolMetricsResponse$outboundSchema: z.ZodType<
1523
+ GetSchoolMetricsResponse$Outbound,
1524
+ z.ZodTypeDef,
1525
+ GetSchoolMetricsResponse
1526
+ > = z.union([
1527
+ z.lazy(() => GetSchoolMetricsResponseBody$outboundSchema),
1528
+ z.lazy(() => GetSchoolMetricsSchoolMetricsResponseBody$outboundSchema),
1529
+ z.lazy(() =>
1530
+ GetSchoolMetricsSchoolMetricsResponseResponseBody$outboundSchema
1531
+ ),
1532
+ ]);
1533
+
1534
+ /**
1535
+ * @internal
1536
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1537
+ */
1538
+ export namespace GetSchoolMetricsResponse$ {
1539
+ /** @deprecated use `GetSchoolMetricsResponse$inboundSchema` instead. */
1540
+ export const inboundSchema = GetSchoolMetricsResponse$inboundSchema;
1541
+ /** @deprecated use `GetSchoolMetricsResponse$outboundSchema` instead. */
1542
+ export const outboundSchema = GetSchoolMetricsResponse$outboundSchema;
1543
+ /** @deprecated use `GetSchoolMetricsResponse$Outbound` instead. */
1544
+ export type Outbound = GetSchoolMetricsResponse$Outbound;
1545
+ }
1546
+
1547
+ export function getSchoolMetricsResponseToJSON(
1548
+ getSchoolMetricsResponse: GetSchoolMetricsResponse,
1549
+ ): string {
1550
+ return JSON.stringify(
1551
+ GetSchoolMetricsResponse$outboundSchema.parse(getSchoolMetricsResponse),
1552
+ );
1553
+ }
1554
+
1555
+ export function getSchoolMetricsResponseFromJSON(
1556
+ jsonString: string,
1557
+ ): SafeParseResult<GetSchoolMetricsResponse, SDKValidationError> {
1558
+ return safeParse(
1559
+ jsonString,
1560
+ (x) => GetSchoolMetricsResponse$inboundSchema.parse(JSON.parse(x)),
1561
+ `Failed to parse 'GetSchoolMetricsResponse' from JSON`,
1562
+ );
1563
+ }