@vepler/sdk 2.145.1 → 2.151.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (264) hide show
  1. package/dist/commonjs/funcs/censusGetBreaks.js +1 -1
  2. package/dist/commonjs/funcs/censusGetBreaks.js.map +1 -1
  3. package/dist/commonjs/funcs/censusGetTile.js +1 -1
  4. package/dist/commonjs/funcs/censusGetTile.js.map +1 -1
  5. package/dist/commonjs/funcs/censusGetWholeLevel.js +1 -1
  6. package/dist/commonjs/funcs/censusGetWholeLevel.js.map +1 -1
  7. package/dist/commonjs/funcs/planningGetPlanningApplications.d.ts +1 -1
  8. package/dist/commonjs/funcs/planningGetPlanningApplications.js +1 -1
  9. package/dist/commonjs/funcs/planningGetPlanningApplicationsBySource.d.ts +1 -1
  10. package/dist/commonjs/funcs/planningGetPlanningApplicationsBySource.js +1 -1
  11. package/dist/commonjs/funcs/planningSearchPlanningApplications.d.ts +1 -1
  12. package/dist/commonjs/funcs/planningSearchPlanningApplications.js +1 -1
  13. package/dist/commonjs/funcs/schoolsGetSchoolById.js +4 -0
  14. package/dist/commonjs/funcs/schoolsGetSchoolById.js.map +1 -1
  15. package/dist/commonjs/funcs/schoolsGetSchoolBySource.js +4 -0
  16. package/dist/commonjs/funcs/schoolsGetSchoolBySource.js.map +1 -1
  17. package/dist/commonjs/funcs/searchSearchSuggest.d.ts +6 -0
  18. package/dist/commonjs/funcs/searchSearchSuggest.d.ts.map +1 -1
  19. package/dist/commonjs/funcs/searchSearchSuggest.js +10 -0
  20. package/dist/commonjs/funcs/searchSearchSuggest.js.map +1 -1
  21. package/dist/commonjs/lib/config.d.ts +2 -2
  22. package/dist/commonjs/lib/config.js +2 -2
  23. package/dist/commonjs/sdk/models/operations/getplanningapplications.d.ts +1 -1
  24. package/dist/commonjs/sdk/models/operations/getplanningapplicationsbysource.d.ts +1 -1
  25. package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts +69 -0
  26. package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts.map +1 -1
  27. package/dist/commonjs/sdk/models/operations/getschoolbyid.js +35 -1
  28. package/dist/commonjs/sdk/models/operations/getschoolbyid.js.map +1 -1
  29. package/dist/commonjs/sdk/models/operations/getschoolbysource.d.ts +69 -0
  30. package/dist/commonjs/sdk/models/operations/getschoolbysource.d.ts.map +1 -1
  31. package/dist/commonjs/sdk/models/operations/getschoolbysource.js +35 -1
  32. package/dist/commonjs/sdk/models/operations/getschoolbysource.js.map +1 -1
  33. package/dist/commonjs/sdk/models/operations/queryschools.d.ts +78 -0
  34. package/dist/commonjs/sdk/models/operations/queryschools.d.ts.map +1 -1
  35. package/dist/commonjs/sdk/models/operations/queryschools.js +42 -1
  36. package/dist/commonjs/sdk/models/operations/queryschools.js.map +1 -1
  37. package/dist/commonjs/sdk/models/operations/queryschoolsbysource.d.ts +78 -0
  38. package/dist/commonjs/sdk/models/operations/queryschoolsbysource.d.ts.map +1 -1
  39. package/dist/commonjs/sdk/models/operations/queryschoolsbysource.js +41 -1
  40. package/dist/commonjs/sdk/models/operations/queryschoolsbysource.js.map +1 -1
  41. package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts +51 -3
  42. package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts.map +1 -1
  43. package/dist/commonjs/sdk/models/operations/searchsuggest.js +27 -2
  44. package/dist/commonjs/sdk/models/operations/searchsuggest.js.map +1 -1
  45. package/dist/commonjs/sdk/models/shared/chargeentry.d.ts +1 -1
  46. package/dist/commonjs/sdk/models/shared/chargehistory.d.ts +1 -1
  47. package/dist/commonjs/sdk/models/shared/index.d.ts +9 -0
  48. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  49. package/dist/commonjs/sdk/models/shared/index.js +9 -0
  50. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  51. package/dist/commonjs/sdk/models/shared/listing.d.ts +2 -2
  52. package/dist/commonjs/sdk/models/shared/listingpricechange.d.ts +2 -2
  53. package/dist/commonjs/sdk/models/shared/planningapplication.d.ts +27 -0
  54. package/dist/commonjs/sdk/models/shared/planningapplication.d.ts.map +1 -1
  55. package/dist/commonjs/sdk/models/shared/planningapplication.js +15 -1
  56. package/dist/commonjs/sdk/models/shared/planningapplication.js.map +1 -1
  57. package/dist/commonjs/sdk/models/shared/planningclassificationreasoning.d.ts +45 -0
  58. package/dist/commonjs/sdk/models/shared/planningclassificationreasoning.d.ts.map +1 -0
  59. package/dist/commonjs/sdk/models/shared/planningclassificationreasoning.js +57 -0
  60. package/dist/commonjs/sdk/models/shared/planningclassificationreasoning.js.map +1 -0
  61. package/dist/commonjs/sdk/models/shared/planningdocument.d.ts +8 -0
  62. package/dist/commonjs/sdk/models/shared/planningdocument.d.ts.map +1 -1
  63. package/dist/commonjs/sdk/models/shared/planningdocument.js +2 -0
  64. package/dist/commonjs/sdk/models/shared/planningdocument.js.map +1 -1
  65. package/dist/commonjs/sdk/models/shared/planningimage.d.ts +49 -0
  66. package/dist/commonjs/sdk/models/shared/planningimage.d.ts.map +1 -0
  67. package/dist/commonjs/sdk/models/shared/planningimage.js +59 -0
  68. package/dist/commonjs/sdk/models/shared/planningimage.js.map +1 -0
  69. package/dist/commonjs/sdk/models/shared/planningqueryrequest.d.ts +4 -1
  70. package/dist/commonjs/sdk/models/shared/planningqueryrequest.d.ts.map +1 -1
  71. package/dist/commonjs/sdk/models/shared/planningqueryrequest.js +3 -0
  72. package/dist/commonjs/sdk/models/shared/planningqueryrequest.js.map +1 -1
  73. package/dist/commonjs/sdk/models/shared/planningsemanticchunk.d.ts +37 -0
  74. package/dist/commonjs/sdk/models/shared/planningsemanticchunk.d.ts.map +1 -0
  75. package/dist/commonjs/sdk/models/shared/planningsemanticchunk.js +56 -0
  76. package/dist/commonjs/sdk/models/shared/planningsemanticchunk.js.map +1 -0
  77. package/dist/commonjs/sdk/models/shared/pricechange.d.ts +2 -2
  78. package/dist/commonjs/sdk/models/shared/pricingdata.d.ts +4 -4
  79. package/dist/commonjs/sdk/models/shared/salerecord.d.ts +1 -1
  80. package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.d.ts +17 -0
  81. package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.d.ts.map +1 -0
  82. package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.js +51 -0
  83. package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.js.map +1 -0
  84. package/dist/commonjs/sdk/models/shared/schoolinspectionevent.d.ts +103 -0
  85. package/dist/commonjs/sdk/models/shared/schoolinspectionevent.d.ts.map +1 -0
  86. package/dist/commonjs/sdk/models/shared/schoolinspectionevent.js +112 -0
  87. package/dist/commonjs/sdk/models/shared/schoolinspectionevent.js.map +1 -0
  88. package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.d.ts +17 -0
  89. package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.d.ts.map +1 -0
  90. package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.js +51 -0
  91. package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.js.map +1 -0
  92. package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.d.ts +13 -0
  93. package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.d.ts.map +1 -0
  94. package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.js +53 -0
  95. package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.js.map +1 -0
  96. package/dist/commonjs/sdk/models/shared/schoolinspectorbody.d.ts +19 -0
  97. package/dist/commonjs/sdk/models/shared/schoolinspectorbody.d.ts.map +1 -0
  98. package/dist/commonjs/sdk/models/shared/schoolinspectorbody.js +53 -0
  99. package/dist/commonjs/sdk/models/shared/schoolinspectorbody.js.map +1 -0
  100. package/dist/commonjs/sdk/models/shared/schooltrustmembership.d.ts +45 -0
  101. package/dist/commonjs/sdk/models/shared/schooltrustmembership.d.ts.map +1 -0
  102. package/dist/commonjs/sdk/models/shared/schooltrustmembership.js +58 -0
  103. package/dist/commonjs/sdk/models/shared/schooltrustmembership.js.map +1 -0
  104. package/dist/commonjs/sdk/models/shared/searchresult.d.ts +2 -2
  105. package/dist/commonjs/sdk/models/shared/sitepropertystats.d.ts +2 -2
  106. package/dist/commonjs/sdk/planning.d.ts +3 -3
  107. package/dist/commonjs/sdk/planning.js +3 -3
  108. package/dist/commonjs/sdk/search.d.ts +6 -0
  109. package/dist/commonjs/sdk/search.d.ts.map +1 -1
  110. package/dist/commonjs/sdk/search.js +6 -0
  111. package/dist/commonjs/sdk/search.js.map +1 -1
  112. package/dist/esm/funcs/censusGetBreaks.js +1 -1
  113. package/dist/esm/funcs/censusGetBreaks.js.map +1 -1
  114. package/dist/esm/funcs/censusGetTile.js +1 -1
  115. package/dist/esm/funcs/censusGetTile.js.map +1 -1
  116. package/dist/esm/funcs/censusGetWholeLevel.js +1 -1
  117. package/dist/esm/funcs/censusGetWholeLevel.js.map +1 -1
  118. package/dist/esm/funcs/planningGetPlanningApplications.d.ts +1 -1
  119. package/dist/esm/funcs/planningGetPlanningApplications.js +1 -1
  120. package/dist/esm/funcs/planningGetPlanningApplicationsBySource.d.ts +1 -1
  121. package/dist/esm/funcs/planningGetPlanningApplicationsBySource.js +1 -1
  122. package/dist/esm/funcs/planningSearchPlanningApplications.d.ts +1 -1
  123. package/dist/esm/funcs/planningSearchPlanningApplications.js +1 -1
  124. package/dist/esm/funcs/schoolsGetSchoolById.js +5 -1
  125. package/dist/esm/funcs/schoolsGetSchoolById.js.map +1 -1
  126. package/dist/esm/funcs/schoolsGetSchoolBySource.js +5 -1
  127. package/dist/esm/funcs/schoolsGetSchoolBySource.js.map +1 -1
  128. package/dist/esm/funcs/searchSearchSuggest.d.ts +6 -0
  129. package/dist/esm/funcs/searchSearchSuggest.d.ts.map +1 -1
  130. package/dist/esm/funcs/searchSearchSuggest.js +10 -0
  131. package/dist/esm/funcs/searchSearchSuggest.js.map +1 -1
  132. package/dist/esm/lib/config.d.ts +2 -2
  133. package/dist/esm/lib/config.js +2 -2
  134. package/dist/esm/sdk/models/operations/getplanningapplications.d.ts +1 -1
  135. package/dist/esm/sdk/models/operations/getplanningapplicationsbysource.d.ts +1 -1
  136. package/dist/esm/sdk/models/operations/getschoolbyid.d.ts +69 -0
  137. package/dist/esm/sdk/models/operations/getschoolbyid.d.ts.map +1 -1
  138. package/dist/esm/sdk/models/operations/getschoolbyid.js +31 -0
  139. package/dist/esm/sdk/models/operations/getschoolbyid.js.map +1 -1
  140. package/dist/esm/sdk/models/operations/getschoolbysource.d.ts +69 -0
  141. package/dist/esm/sdk/models/operations/getschoolbysource.d.ts.map +1 -1
  142. package/dist/esm/sdk/models/operations/getschoolbysource.js +31 -0
  143. package/dist/esm/sdk/models/operations/getschoolbysource.js.map +1 -1
  144. package/dist/esm/sdk/models/operations/queryschools.d.ts +78 -0
  145. package/dist/esm/sdk/models/operations/queryschools.d.ts.map +1 -1
  146. package/dist/esm/sdk/models/operations/queryschools.js +37 -0
  147. package/dist/esm/sdk/models/operations/queryschools.js.map +1 -1
  148. package/dist/esm/sdk/models/operations/queryschoolsbysource.d.ts +78 -0
  149. package/dist/esm/sdk/models/operations/queryschoolsbysource.d.ts.map +1 -1
  150. package/dist/esm/sdk/models/operations/queryschoolsbysource.js +36 -0
  151. package/dist/esm/sdk/models/operations/queryschoolsbysource.js.map +1 -1
  152. package/dist/esm/sdk/models/operations/searchsuggest.d.ts +51 -3
  153. package/dist/esm/sdk/models/operations/searchsuggest.d.ts.map +1 -1
  154. package/dist/esm/sdk/models/operations/searchsuggest.js +26 -1
  155. package/dist/esm/sdk/models/operations/searchsuggest.js.map +1 -1
  156. package/dist/esm/sdk/models/shared/chargeentry.d.ts +1 -1
  157. package/dist/esm/sdk/models/shared/chargehistory.d.ts +1 -1
  158. package/dist/esm/sdk/models/shared/index.d.ts +9 -0
  159. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  160. package/dist/esm/sdk/models/shared/index.js +9 -0
  161. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  162. package/dist/esm/sdk/models/shared/listing.d.ts +2 -2
  163. package/dist/esm/sdk/models/shared/listingpricechange.d.ts +2 -2
  164. package/dist/esm/sdk/models/shared/planningapplication.d.ts +27 -0
  165. package/dist/esm/sdk/models/shared/planningapplication.d.ts.map +1 -1
  166. package/dist/esm/sdk/models/shared/planningapplication.js +13 -0
  167. package/dist/esm/sdk/models/shared/planningapplication.js.map +1 -1
  168. package/dist/esm/sdk/models/shared/planningclassificationreasoning.d.ts +45 -0
  169. package/dist/esm/sdk/models/shared/planningclassificationreasoning.d.ts.map +1 -0
  170. package/dist/esm/sdk/models/shared/planningclassificationreasoning.js +20 -0
  171. package/dist/esm/sdk/models/shared/planningclassificationreasoning.js.map +1 -0
  172. package/dist/esm/sdk/models/shared/planningdocument.d.ts +8 -0
  173. package/dist/esm/sdk/models/shared/planningdocument.d.ts.map +1 -1
  174. package/dist/esm/sdk/models/shared/planningdocument.js +2 -0
  175. package/dist/esm/sdk/models/shared/planningdocument.js.map +1 -1
  176. package/dist/esm/sdk/models/shared/planningimage.d.ts +49 -0
  177. package/dist/esm/sdk/models/shared/planningimage.d.ts.map +1 -0
  178. package/dist/esm/sdk/models/shared/planningimage.js +22 -0
  179. package/dist/esm/sdk/models/shared/planningimage.js.map +1 -0
  180. package/dist/esm/sdk/models/shared/planningqueryrequest.d.ts +4 -1
  181. package/dist/esm/sdk/models/shared/planningqueryrequest.d.ts.map +1 -1
  182. package/dist/esm/sdk/models/shared/planningqueryrequest.js +3 -0
  183. package/dist/esm/sdk/models/shared/planningqueryrequest.js.map +1 -1
  184. package/dist/esm/sdk/models/shared/planningsemanticchunk.d.ts +37 -0
  185. package/dist/esm/sdk/models/shared/planningsemanticchunk.d.ts.map +1 -0
  186. package/dist/esm/sdk/models/shared/planningsemanticchunk.js +19 -0
  187. package/dist/esm/sdk/models/shared/planningsemanticchunk.js.map +1 -0
  188. package/dist/esm/sdk/models/shared/pricechange.d.ts +2 -2
  189. package/dist/esm/sdk/models/shared/pricingdata.d.ts +4 -4
  190. package/dist/esm/sdk/models/shared/salerecord.d.ts +1 -1
  191. package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.d.ts +17 -0
  192. package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.d.ts.map +1 -0
  193. package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.js +14 -0
  194. package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.js.map +1 -0
  195. package/dist/esm/sdk/models/shared/schoolinspectionevent.d.ts +103 -0
  196. package/dist/esm/sdk/models/shared/schoolinspectionevent.d.ts.map +1 -0
  197. package/dist/esm/sdk/models/shared/schoolinspectionevent.js +74 -0
  198. package/dist/esm/sdk/models/shared/schoolinspectionevent.js.map +1 -0
  199. package/dist/esm/sdk/models/shared/schoolinspectiongrade.d.ts +17 -0
  200. package/dist/esm/sdk/models/shared/schoolinspectiongrade.d.ts.map +1 -0
  201. package/dist/esm/sdk/models/shared/schoolinspectiongrade.js +14 -0
  202. package/dist/esm/sdk/models/shared/schoolinspectiongrade.js.map +1 -0
  203. package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.d.ts +13 -0
  204. package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.d.ts.map +1 -0
  205. package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.js +16 -0
  206. package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.js.map +1 -0
  207. package/dist/esm/sdk/models/shared/schoolinspectorbody.d.ts +19 -0
  208. package/dist/esm/sdk/models/shared/schoolinspectorbody.d.ts.map +1 -0
  209. package/dist/esm/sdk/models/shared/schoolinspectorbody.js +17 -0
  210. package/dist/esm/sdk/models/shared/schoolinspectorbody.js.map +1 -0
  211. package/dist/esm/sdk/models/shared/schooltrustmembership.d.ts +45 -0
  212. package/dist/esm/sdk/models/shared/schooltrustmembership.d.ts.map +1 -0
  213. package/dist/esm/sdk/models/shared/schooltrustmembership.js +21 -0
  214. package/dist/esm/sdk/models/shared/schooltrustmembership.js.map +1 -0
  215. package/dist/esm/sdk/models/shared/searchresult.d.ts +2 -2
  216. package/dist/esm/sdk/models/shared/sitepropertystats.d.ts +2 -2
  217. package/dist/esm/sdk/planning.d.ts +3 -3
  218. package/dist/esm/sdk/planning.js +3 -3
  219. package/dist/esm/sdk/search.d.ts +6 -0
  220. package/dist/esm/sdk/search.d.ts.map +1 -1
  221. package/dist/esm/sdk/search.js +6 -0
  222. package/dist/esm/sdk/search.js.map +1 -1
  223. package/package.json +1 -1
  224. package/src/funcs/censusGetBreaks.ts +1 -1
  225. package/src/funcs/censusGetTile.ts +1 -1
  226. package/src/funcs/censusGetWholeLevel.ts +1 -1
  227. package/src/funcs/planningGetPlanningApplications.ts +1 -1
  228. package/src/funcs/planningGetPlanningApplicationsBySource.ts +1 -1
  229. package/src/funcs/planningSearchPlanningApplications.ts +1 -1
  230. package/src/funcs/schoolsGetSchoolById.ts +6 -1
  231. package/src/funcs/schoolsGetSchoolBySource.ts +6 -1
  232. package/src/funcs/searchSearchSuggest.ts +10 -0
  233. package/src/lib/config.ts +2 -2
  234. package/src/sdk/models/operations/getplanningapplications.ts +1 -1
  235. package/src/sdk/models/operations/getplanningapplicationsbysource.ts +1 -1
  236. package/src/sdk/models/operations/getschoolbyid.ts +126 -0
  237. package/src/sdk/models/operations/getschoolbysource.ts +134 -0
  238. package/src/sdk/models/operations/queryschools.ts +154 -0
  239. package/src/sdk/models/operations/queryschoolsbysource.ts +153 -0
  240. package/src/sdk/models/operations/searchsuggest.ts +64 -3
  241. package/src/sdk/models/shared/chargeentry.ts +1 -1
  242. package/src/sdk/models/shared/chargehistory.ts +1 -1
  243. package/src/sdk/models/shared/index.ts +9 -0
  244. package/src/sdk/models/shared/listing.ts +2 -2
  245. package/src/sdk/models/shared/listingpricechange.ts +2 -2
  246. package/src/sdk/models/shared/planningapplication.ts +53 -0
  247. package/src/sdk/models/shared/planningclassificationreasoning.ts +69 -0
  248. package/src/sdk/models/shared/planningdocument.ts +10 -0
  249. package/src/sdk/models/shared/planningimage.ts +79 -0
  250. package/src/sdk/models/shared/planningqueryrequest.ts +4 -1
  251. package/src/sdk/models/shared/planningsemanticchunk.ts +64 -0
  252. package/src/sdk/models/shared/pricechange.ts +2 -2
  253. package/src/sdk/models/shared/pricingdata.ts +4 -4
  254. package/src/sdk/models/shared/salerecord.ts +1 -1
  255. package/src/sdk/models/shared/schoolinspectionevaluationarea.ts +39 -0
  256. package/src/sdk/models/shared/schoolinspectionevent.ts +184 -0
  257. package/src/sdk/models/shared/schoolinspectiongrade.ts +39 -0
  258. package/src/sdk/models/shared/schoolinspectionpredecessor.ts +37 -0
  259. package/src/sdk/models/shared/schoolinspectorbody.ts +29 -0
  260. package/src/sdk/models/shared/schooltrustmembership.ts +74 -0
  261. package/src/sdk/models/shared/searchresult.ts +2 -2
  262. package/src/sdk/models/shared/sitepropertystats.ts +2 -2
  263. package/src/sdk/planning.ts +3 -3
  264. package/src/sdk/search.ts +6 -0
@@ -13,6 +13,10 @@ import {
13
13
  PlanningApplicant,
14
14
  PlanningApplicant$inboundSchema,
15
15
  } from "./planningapplicant.js";
16
+ import {
17
+ PlanningClassificationReasoning,
18
+ PlanningClassificationReasoning$inboundSchema,
19
+ } from "./planningclassificationreasoning.js";
16
20
  import {
17
21
  PlanningConstraint,
18
22
  PlanningConstraint$inboundSchema,
@@ -37,6 +41,7 @@ import {
37
41
  PlanningExtractionCoverage,
38
42
  PlanningExtractionCoverage$inboundSchema,
39
43
  } from "./planningextractioncoverage.js";
44
+ import { PlanningImage, PlanningImage$inboundSchema } from "./planningimage.js";
40
45
  import {
41
46
  PlanningOfficerAssessmentExtractionEnvelope,
42
47
  PlanningOfficerAssessmentExtractionEnvelope$inboundSchema,
@@ -49,6 +54,10 @@ import {
49
54
  PlanningS106ExtractionEnvelope,
50
55
  PlanningS106ExtractionEnvelope$inboundSchema,
51
56
  } from "./plannings106extractionenvelope.js";
57
+ import {
58
+ PlanningSemanticChunk,
59
+ PlanningSemanticChunk$inboundSchema,
60
+ } from "./planningsemanticchunk.js";
52
61
  import {
53
62
  PlanningStatusHistory,
54
63
  PlanningStatusHistory$inboundSchema,
@@ -96,6 +105,20 @@ export type PlanningApplicationAddress = {
96
105
  ward?: string | null | undefined;
97
106
  };
98
107
 
108
+ /**
109
+ * AI reasoning and processing artefacts behind the application: how it was classified (with confidence and uncertainty) and how its documents were segmented and summarised. Only present when 'enrichment' is requested via the include parameter. Sub-arrays may be empty when the relevant pipeline has not run for this application.
110
+ */
111
+ export type Enrichment = {
112
+ /**
113
+ * AI classification reasoning runs for the application (most recent first). Shows how our pipeline determined the application's type, status and development category, with confidence and uncertainty. May be empty when no audit was recorded.
114
+ */
115
+ classification: Array<PlanningClassificationReasoning>;
116
+ /**
117
+ * Section-level structure and AI context summaries derived from the application's documents (no embeddings or full text). Conveys how the documents were segmented and understood. May be empty when semantic processing has not run.
118
+ */
119
+ semanticChunks: Array<PlanningSemanticChunk>;
120
+ };
121
+
99
122
  /**
100
123
  * Structured, citation-backed data extracted from the application's documents — decision outcome and refusal reasons, development specifics, section 106 obligations, the officer's assessment, and consultee responses. Only present when 'extractions' is requested via the include parameter (GET) or the include array (POST /query); omitted entirely otherwise. Each sub-extraction may itself be null when that schema has not been extracted for this application. Coverage and per-extraction verification status are reported so consumers can degrade honestly when data is partial or unverified.
101
124
  */
@@ -352,6 +375,10 @@ export type PlanningApplication = {
352
375
  * Documents associated with the planning application, including submitted plans, decision notices, consultation responses, and supporting material. May be empty if no documents have been collected from the source.
353
376
  */
354
377
  documents?: Array<PlanningDocument> | undefined;
378
+ /**
379
+ * AI reasoning and processing artefacts behind the application: how it was classified (with confidence and uncertainty) and how its documents were segmented and summarised. Only present when 'enrichment' is requested via the include parameter. Sub-arrays may be empty when the relevant pipeline has not run for this application.
380
+ */
381
+ enrichment?: Enrichment | null | undefined;
355
382
  /**
356
383
  * The date on which the planning permission expires if not implemented, formatted as an ISO 8601 datetime string. Most permissions must be commenced within three years of approval. Null if not applicable or not recorded.
357
384
  */
@@ -364,6 +391,10 @@ export type PlanningApplication = {
364
391
  * Unique identifier for the planning application record. Use this UUID to retrieve the application via the GET /{applicationIds} endpoint.
365
392
  */
366
393
  id: string;
394
+ /**
395
+ * Deduplicated gallery of images (plans, elevations, photographs) extracted from the application's documents, each with a directly-renderable CDN URL. Only present when 'images' is requested via the include parameter. May be empty when no images have been extracted — image coverage is sparse, so expect this for most applications and render an honest empty state.
396
+ */
397
+ images?: Array<PlanningImage> | undefined;
367
398
  /**
368
399
  * The planning application reference number as assigned by the local planning authority. Format varies by council (e.g. 'APP/2024/0001', '24/00123/FUL', 'DC/24/0456'). This is the reference number a member of the public would use when contacting the council about the application.
369
400
  */
@@ -461,6 +492,26 @@ export function planningApplicationAddressFromJSON(
461
492
  );
462
493
  }
463
494
 
495
+ /** @internal */
496
+ export const Enrichment$inboundSchema: z.ZodType<
497
+ Enrichment,
498
+ z.ZodTypeDef,
499
+ unknown
500
+ > = z.object({
501
+ classification: z.array(PlanningClassificationReasoning$inboundSchema),
502
+ semanticChunks: z.array(PlanningSemanticChunk$inboundSchema),
503
+ });
504
+
505
+ export function enrichmentFromJSON(
506
+ jsonString: string,
507
+ ): SafeParseResult<Enrichment, SDKValidationError> {
508
+ return safeParse(
509
+ jsonString,
510
+ (x) => Enrichment$inboundSchema.parse(JSON.parse(x)),
511
+ `Failed to parse 'Enrichment' from JSON`,
512
+ );
513
+ }
514
+
464
515
  /** @internal */
465
516
  export const Extractions$inboundSchema: z.ZodType<
466
517
  Extractions,
@@ -697,9 +748,11 @@ export const PlanningApplication$inboundSchema: z.ZodType<
697
748
  developmentCategory: z.nullable(z.string()).optional(),
698
749
  distance: z.nullable(z.number()).optional(),
699
750
  documents: z.array(PlanningDocument$inboundSchema).optional(),
751
+ enrichment: z.nullable(z.lazy(() => Enrichment$inboundSchema)).optional(),
700
752
  expiryDate: z.nullable(z.string()).optional(),
701
753
  extractions: z.nullable(z.lazy(() => Extractions$inboundSchema)).optional(),
702
754
  id: z.string(),
755
+ images: z.array(PlanningImage$inboundSchema).optional(),
703
756
  key: z.string(),
704
757
  people: z.nullable(z.lazy(() => People$inboundSchema)).optional(),
705
758
  provider: z.string(),
@@ -0,0 +1,69 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type PlanningClassificationReasoning = {
11
+ /**
12
+ * Version of the classification pipeline that produced this result.
13
+ */
14
+ classificationVersion?: string | null | undefined;
15
+ /**
16
+ * Per-dimension confidence detail behind the final classification.
17
+ */
18
+ confidenceBreakdown?: { [k: string]: any } | null | undefined;
19
+ /**
20
+ * ISO 8601 datetime when this classification run was recorded.
21
+ */
22
+ createdAt: string;
23
+ /**
24
+ * The ensemble's final classification result (type/status/category and supporting fields).
25
+ */
26
+ finalClassification?: { [k: string]: any } | null | undefined;
27
+ /**
28
+ * Natural-language explanation of how the classification was reached.
29
+ */
30
+ reasoning?: string | null | undefined;
31
+ /**
32
+ * Whether the pipeline flagged this classification for human review.
33
+ */
34
+ requiresHumanReview?: boolean | null | undefined;
35
+ /**
36
+ * Specific points of uncertainty the model surfaced (empty when none).
37
+ */
38
+ uncertaintyFlags?: Array<any> | undefined;
39
+ /**
40
+ * Issues flagged by the validation pass (empty when none).
41
+ */
42
+ validationIssues?: Array<any> | undefined;
43
+ };
44
+
45
+ /** @internal */
46
+ export const PlanningClassificationReasoning$inboundSchema: z.ZodType<
47
+ PlanningClassificationReasoning,
48
+ z.ZodTypeDef,
49
+ unknown
50
+ > = z.object({
51
+ classificationVersion: z.nullable(z.string()).optional(),
52
+ confidenceBreakdown: z.nullable(z.record(z.any())).optional(),
53
+ createdAt: z.string(),
54
+ finalClassification: z.nullable(z.record(z.any())).optional(),
55
+ reasoning: z.nullable(z.string()).optional(),
56
+ requiresHumanReview: z.nullable(z.boolean()).optional(),
57
+ uncertaintyFlags: z.array(z.any()).optional(),
58
+ validationIssues: z.array(z.any()).optional(),
59
+ });
60
+
61
+ export function planningClassificationReasoningFromJSON(
62
+ jsonString: string,
63
+ ): SafeParseResult<PlanningClassificationReasoning, SDKValidationError> {
64
+ return safeParse(
65
+ jsonString,
66
+ (x) => PlanningClassificationReasoning$inboundSchema.parse(JSON.parse(x)),
67
+ `Failed to parse 'PlanningClassificationReasoning' from JSON`,
68
+ );
69
+ }
@@ -28,10 +28,18 @@ export type PlanningDocument = {
28
28
  * File size in bytes, if known. Null if the file size was not available from the source.
29
29
  */
30
30
  fileSize?: number | null | undefined;
31
+ /**
32
+ * Direct, publicly-readable URL to the document file (PDF) as stored and served by us via CDN — stable and CORS-enabled, suitable for rendering in-browser (unlike the council's sourceUrl, which may require cookies or expire). Present only when the 'content' expansion is requested via the include parameter. Null when we hold no stored copy of the file (fall back to sourceUrl).
33
+ */
34
+ fileUrl?: string | null | undefined;
31
35
  /**
32
36
  * Unique identifier for the document record.
33
37
  */
34
38
  id: string;
39
+ /**
40
+ * Direct, publicly-readable CDN URL to the extracted text of the document, as Markdown. Produced by our OCR/conversion pipeline. Present only when the 'content' expansion is requested. Null when the document has not been OCR-processed (no text is available).
41
+ */
42
+ ocrUrl?: string | null | undefined;
35
43
  /**
36
44
  * Number of pages in the document, if known. Primarily available for PDF documents.
37
45
  */
@@ -57,7 +65,9 @@ export const PlanningDocument$inboundSchema: z.ZodType<
57
65
  documentTypeDetailed: z.nullable(z.string()).optional(),
58
66
  fileName: z.string(),
59
67
  fileSize: z.nullable(z.number()).optional(),
68
+ fileUrl: z.nullable(z.string()).optional(),
60
69
  id: z.string(),
70
+ ocrUrl: z.nullable(z.string()).optional(),
61
71
  pageCount: z.nullable(z.number()).optional(),
62
72
  planningApplicationId: z.string(),
63
73
  sourceUrl: z.string(),
@@ -0,0 +1,79 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type PlanningImage = {
11
+ /**
12
+ * AI classification of what the image depicts (e.g. 'site_plan', 'elevation', 'floor_plan', 'location_plan', 'photograph'). Null when the image has not yet been classified.
13
+ */
14
+ classification?: string | null | undefined;
15
+ /**
16
+ * Confidence in the classification, 0–1. Null when unclassified.
17
+ */
18
+ classificationConfidence?: number | null | undefined;
19
+ /**
20
+ * File name of the source document the image was extracted from, when known.
21
+ */
22
+ documentFileName?: string | null | undefined;
23
+ /**
24
+ * Image height in pixels, if known.
25
+ */
26
+ height?: number | null | undefined;
27
+ /**
28
+ * Unique identifier for the canonical image (deduplicated within the application).
29
+ */
30
+ id: string;
31
+ /**
32
+ * Image MIME type.
33
+ */
34
+ mimeType?: string | null | undefined;
35
+ /**
36
+ * Page of the source document on which this image first appears (1-based).
37
+ */
38
+ pageNumber?: number | null | undefined;
39
+ /**
40
+ * How many times this image appears across the application's documents. A higher count often indicates a recurring key drawing (e.g. a site plan repeated in several documents).
41
+ */
42
+ refCount?: number | undefined;
43
+ /**
44
+ * Publicly-readable CDN URL for the image, suitable for direct rendering in an <img> tag. Stable and CORS-enabled.
45
+ */
46
+ url: string;
47
+ /**
48
+ * Image width in pixels, if known.
49
+ */
50
+ width?: number | null | undefined;
51
+ };
52
+
53
+ /** @internal */
54
+ export const PlanningImage$inboundSchema: z.ZodType<
55
+ PlanningImage,
56
+ z.ZodTypeDef,
57
+ unknown
58
+ > = z.object({
59
+ classification: z.nullable(z.string()).optional(),
60
+ classificationConfidence: z.nullable(z.number()).optional(),
61
+ documentFileName: z.nullable(z.string()).optional(),
62
+ height: z.nullable(z.number()).optional(),
63
+ id: z.string(),
64
+ mimeType: z.nullable(z.string()).optional(),
65
+ pageNumber: z.nullable(z.number()).optional(),
66
+ refCount: z.number().optional(),
67
+ url: z.string(),
68
+ width: z.nullable(z.number()).optional(),
69
+ });
70
+
71
+ export function planningImageFromJSON(
72
+ jsonString: string,
73
+ ): SafeParseResult<PlanningImage, SDKValidationError> {
74
+ return safeParse(
75
+ jsonString,
76
+ (x) => PlanningImage$inboundSchema.parse(JSON.parse(x)),
77
+ `Failed to parse 'PlanningImage' from JSON`,
78
+ );
79
+ }
@@ -12,6 +12,9 @@ import {
12
12
 
13
13
  export const Include = {
14
14
  Extractions: "extractions",
15
+ Images: "images",
16
+ Content: "content",
17
+ Enrichment: "enrichment",
15
18
  } as const;
16
19
  export type Include = ClosedEnum<typeof Include>;
17
20
 
@@ -48,7 +51,7 @@ export type PlanningQueryRequestSortOrder = ClosedEnum<
48
51
 
49
52
  export type PlanningQueryRequest = {
50
53
  /**
51
- * Optional expansions to attach to each returned application. 'extractions' attaches structured, citation-backed extractions (decision, development, s106, officer assessment, consultee responses). Omitted by default to keep responses lean — extractions are large. Request only when you need the detail (e.g. a handful of specific applications), not for bulk aggregation.
54
+ * Optional expansions to attach to each returned application. 'extractions' — structured, citation-backed extractions (decision, development, s106, officer assessment, consultee responses). 'images' — a deduplicated image gallery with directly-renderable CDN URLs. 'content' — adds fileUrl (CDN PDF) and ocrUrl (CDN Markdown text) to each document so it can be rendered/searched in-browser. 'enrichment' — AI classification reasoning and document segmentation summaries. All are omitted by default to keep responses lean; request only what you need (e.g. a handful of specific applications), not for bulk aggregation.
52
55
  */
53
56
  include?: Array<Include> | undefined;
54
57
  /**
@@ -0,0 +1,64 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type PlanningSemanticChunk = {
11
+ /**
12
+ * Kind of chunk (e.g. 'document', 'section').
13
+ */
14
+ chunkType?: string | null | undefined;
15
+ /**
16
+ * AI-written summary giving the surrounding context of this chunk.
17
+ */
18
+ contextSummary?: string | null | undefined;
19
+ /**
20
+ * UUID of the source document this chunk belongs to.
21
+ */
22
+ documentId?: string | null | undefined;
23
+ /**
24
+ * Unique identifier for the semantic chunk.
25
+ */
26
+ id: string;
27
+ /**
28
+ * Last page the chunk spans (1-based).
29
+ */
30
+ pageEnd?: number | null | undefined;
31
+ /**
32
+ * First page the chunk spans (1-based).
33
+ */
34
+ pageStart?: number | null | undefined;
35
+ /**
36
+ * Hierarchical section heading path locating the chunk within the document.
37
+ */
38
+ sectionPath?: Array<string> | null | undefined;
39
+ };
40
+
41
+ /** @internal */
42
+ export const PlanningSemanticChunk$inboundSchema: z.ZodType<
43
+ PlanningSemanticChunk,
44
+ z.ZodTypeDef,
45
+ unknown
46
+ > = z.object({
47
+ chunkType: z.nullable(z.string()).optional(),
48
+ contextSummary: z.nullable(z.string()).optional(),
49
+ documentId: z.nullable(z.string()).optional(),
50
+ id: z.string(),
51
+ pageEnd: z.nullable(z.number()).optional(),
52
+ pageStart: z.nullable(z.number()).optional(),
53
+ sectionPath: z.nullable(z.array(z.string())).optional(),
54
+ });
55
+
56
+ export function planningSemanticChunkFromJSON(
57
+ jsonString: string,
58
+ ): SafeParseResult<PlanningSemanticChunk, SDKValidationError> {
59
+ return safeParse(
60
+ jsonString,
61
+ (x) => PlanningSemanticChunk$inboundSchema.parse(JSON.parse(x)),
62
+ `Failed to parse 'PlanningSemanticChunk' from JSON`,
63
+ );
64
+ }
@@ -24,7 +24,7 @@ export type PriceChangeDirection = OpenEnum<typeof PriceChangeDirection>;
24
24
 
25
25
  export type PriceChange = {
26
26
  /**
27
- * Amount of change in pence
27
+ * Amount of change in GBP (whole pounds)
28
28
  */
29
29
  amount?: number | null | undefined;
30
30
  /**
@@ -40,7 +40,7 @@ export type PriceChange = {
40
40
  */
41
41
  percent?: number | null | undefined;
42
42
  /**
43
- * New price after change in pence
43
+ * New price after change in GBP (whole pounds)
44
44
  */
45
45
  price?: number | null | undefined;
46
46
  };
@@ -13,19 +13,19 @@ export type PricingData = {
13
13
  */
14
14
  currency?: string | null | undefined;
15
15
  /**
16
- * Current rental price per month in pence
16
+ * Current rental price per month in GBP (whole pounds)
17
17
  */
18
18
  currentRent?: number | null | undefined;
19
19
  /**
20
- * Current sale price in pence
20
+ * Current sale price in GBP (whole pounds)
21
21
  */
22
22
  currentSale?: number | null | undefined;
23
23
  /**
24
- * Estimated rental value per month in pence
24
+ * Estimated monthly rental value in GBP (whole pounds)
25
25
  */
26
26
  estimatedRent?: number | null | undefined;
27
27
  /**
28
- * Estimated sale value in pence
28
+ * Estimated sale value in GBP (whole pounds)
29
29
  */
30
30
  estimatedSale?: number | null | undefined;
31
31
  };
@@ -9,7 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
9
 
10
10
  export type SaleRecord = {
11
11
  /**
12
- * Sale price in pence
12
+ * Sale price in GBP (whole pounds)
13
13
  */
14
14
  amount: number;
15
15
  /**
@@ -0,0 +1,39 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type SchoolInspectionEvaluationArea = {
11
+ /**
12
+ * Evaluation area key, e.g. 'leadership_governance'
13
+ */
14
+ area: string;
15
+ /**
16
+ * Category grade, e.g. 'Strong standard', or 'Met'/'Not met' for safeguarding
17
+ */
18
+ grade: string;
19
+ };
20
+
21
+ /** @internal */
22
+ export const SchoolInspectionEvaluationArea$inboundSchema: z.ZodType<
23
+ SchoolInspectionEvaluationArea,
24
+ z.ZodTypeDef,
25
+ unknown
26
+ > = z.object({
27
+ area: z.string(),
28
+ grade: z.string(),
29
+ });
30
+
31
+ export function schoolInspectionEvaluationAreaFromJSON(
32
+ jsonString: string,
33
+ ): SafeParseResult<SchoolInspectionEvaluationArea, SDKValidationError> {
34
+ return safeParse(
35
+ jsonString,
36
+ (x) => SchoolInspectionEvaluationArea$inboundSchema.parse(JSON.parse(x)),
37
+ `Failed to parse 'SchoolInspectionEvaluationArea' from JSON`,
38
+ );
39
+ }
@@ -0,0 +1,184 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import * as openEnums from "../../types/enums.js";
8
+ import { OpenEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+ import {
12
+ SchoolInspectionEvaluationArea,
13
+ SchoolInspectionEvaluationArea$inboundSchema,
14
+ } from "./schoolinspectionevaluationarea.js";
15
+ import {
16
+ SchoolInspectionGrade,
17
+ SchoolInspectionGrade$inboundSchema,
18
+ } from "./schoolinspectiongrade.js";
19
+ import {
20
+ SchoolInspectionPredecessor,
21
+ SchoolInspectionPredecessor$inboundSchema,
22
+ } from "./schoolinspectionpredecessor.js";
23
+ import {
24
+ SchoolInspectorBody,
25
+ SchoolInspectorBody$inboundSchema,
26
+ } from "./schoolinspectorbody.js";
27
+
28
+ /**
29
+ * The inspectorate's own native overall grade. Not cross-body comparable.
30
+ */
31
+ export const SchoolInspectionEventRating = {
32
+ Outstanding: "outstanding",
33
+ Good: "good",
34
+ Satisfactory: "satisfactory",
35
+ Inadequate: "inadequate",
36
+ Exceptional: "exceptional",
37
+ StrongStandard: "strong_standard",
38
+ ExpectedStandard: "expected_standard",
39
+ NeedsAttention: "needs_attention",
40
+ UrgentImprovement: "urgent_improvement",
41
+ RequiresImprovement: "requires_improvement",
42
+ NotYetInspected: "not_yet_inspected",
43
+ Excellent: "excellent",
44
+ Adequate: "adequate",
45
+ Unsatisfactory: "unsatisfactory",
46
+ VeryGood: "very_good",
47
+ Weak: "weak",
48
+ ImportantAreaForImprovement: "important_area_for_improvement",
49
+ RequiresSignificantImprovement: "requires_significant_improvement",
50
+ Fair: "fair",
51
+ } as const;
52
+ /**
53
+ * The inspectorate's own native overall grade. Not cross-body comparable.
54
+ */
55
+ export type SchoolInspectionEventRating = OpenEnum<
56
+ typeof SchoolInspectionEventRating
57
+ >;
58
+
59
+ /**
60
+ * OEIF 1-4 sub-judgements (graded pre-2025 inspections).
61
+ */
62
+ export type Ratings = {
63
+ behaviourAndAttitudes?: SchoolInspectionGrade | null | undefined;
64
+ earlyYearsProvision?: SchoolInspectionGrade | null | undefined;
65
+ leadershipAndManagement?: SchoolInspectionGrade | null | undefined;
66
+ overallEffectiveness?: SchoolInspectionGrade | null | undefined;
67
+ personalDevelopment?: SchoolInspectionGrade | null | undefined;
68
+ qualityOfEducation?: SchoolInspectionGrade | null | undefined;
69
+ sixthFormProvision?: SchoolInspectionGrade | null | undefined;
70
+ };
71
+
72
+ /**
73
+ * Most recent inspection event, or null if never inspected.
74
+ */
75
+ export type SchoolInspectionEvent = {
76
+ /**
77
+ * Statutory category of concern (e.g. 'Special measures'), where applicable.
78
+ */
79
+ categoryOfConcern?: string | null | undefined;
80
+ /**
81
+ * Post-2025 Ofsted evaluation-area grades.
82
+ */
83
+ evaluationAreas?: Array<SchoolInspectionEvaluationArea> | null | undefined;
84
+ /**
85
+ * Framework variant, e.g. 'post_2025' | 'oeif' | 'ungraded_only'.
86
+ */
87
+ framework?: string | null | undefined;
88
+ /**
89
+ * ISO date of the inspection.
90
+ */
91
+ inspectionDate: string;
92
+ /**
93
+ * Inspection type as published by the inspectorate.
94
+ */
95
+ inspectionType?: string | null | undefined;
96
+ /**
97
+ * Inspectorate that issued the rating. ofsted (England), estyn (Wales), education_scotland (Scotland), eti (Northern Ireland), des (Ireland).
98
+ */
99
+ inspectorBody: SchoolInspectorBody;
100
+ predecessor?: SchoolInspectionPredecessor | null | undefined;
101
+ /**
102
+ * ISO date the report was published, where known.
103
+ */
104
+ publicationDate?: string | null | undefined;
105
+ /**
106
+ * The inspectorate's own native overall grade. Not cross-body comparable.
107
+ */
108
+ rating: SchoolInspectionEventRating;
109
+ /**
110
+ * OEIF 1-4 sub-judgements (graded pre-2025 inspections).
111
+ */
112
+ ratings?: Ratings | null | undefined;
113
+ /**
114
+ * Canonical link to the published inspection report on the inspectorate's site.
115
+ */
116
+ reportUrl?: string | null | undefined;
117
+ };
118
+
119
+ /** @internal */
120
+ export const SchoolInspectionEventRating$inboundSchema: z.ZodType<
121
+ SchoolInspectionEventRating,
122
+ z.ZodTypeDef,
123
+ unknown
124
+ > = openEnums.inboundSchema(SchoolInspectionEventRating);
125
+
126
+ /** @internal */
127
+ export const Ratings$inboundSchema: z.ZodType<Ratings, z.ZodTypeDef, unknown> =
128
+ z.object({
129
+ behaviourAndAttitudes: z.nullable(SchoolInspectionGrade$inboundSchema)
130
+ .optional(),
131
+ earlyYearsProvision: z.nullable(SchoolInspectionGrade$inboundSchema)
132
+ .optional(),
133
+ leadershipAndManagement: z.nullable(SchoolInspectionGrade$inboundSchema)
134
+ .optional(),
135
+ overallEffectiveness: z.nullable(SchoolInspectionGrade$inboundSchema)
136
+ .optional(),
137
+ personalDevelopment: z.nullable(SchoolInspectionGrade$inboundSchema)
138
+ .optional(),
139
+ qualityOfEducation: z.nullable(SchoolInspectionGrade$inboundSchema)
140
+ .optional(),
141
+ sixthFormProvision: z.nullable(SchoolInspectionGrade$inboundSchema)
142
+ .optional(),
143
+ });
144
+
145
+ export function ratingsFromJSON(
146
+ jsonString: string,
147
+ ): SafeParseResult<Ratings, SDKValidationError> {
148
+ return safeParse(
149
+ jsonString,
150
+ (x) => Ratings$inboundSchema.parse(JSON.parse(x)),
151
+ `Failed to parse 'Ratings' from JSON`,
152
+ );
153
+ }
154
+
155
+ /** @internal */
156
+ export const SchoolInspectionEvent$inboundSchema: z.ZodType<
157
+ SchoolInspectionEvent,
158
+ z.ZodTypeDef,
159
+ unknown
160
+ > = z.object({
161
+ categoryOfConcern: z.nullable(z.string()).optional(),
162
+ evaluationAreas: z.nullable(
163
+ z.array(SchoolInspectionEvaluationArea$inboundSchema),
164
+ ).optional(),
165
+ framework: z.nullable(z.string()).optional(),
166
+ inspectionDate: z.string(),
167
+ inspectionType: z.nullable(z.string()).optional(),
168
+ inspectorBody: SchoolInspectorBody$inboundSchema,
169
+ predecessor: z.nullable(SchoolInspectionPredecessor$inboundSchema).optional(),
170
+ publicationDate: z.nullable(z.string()).optional(),
171
+ rating: SchoolInspectionEventRating$inboundSchema,
172
+ ratings: z.nullable(z.lazy(() => Ratings$inboundSchema)).optional(),
173
+ reportUrl: z.nullable(z.string()).optional(),
174
+ });
175
+
176
+ export function schoolInspectionEventFromJSON(
177
+ jsonString: string,
178
+ ): SafeParseResult<SchoolInspectionEvent, SDKValidationError> {
179
+ return safeParse(
180
+ jsonString,
181
+ (x) => SchoolInspectionEvent$inboundSchema.parse(JSON.parse(x)),
182
+ `Failed to parse 'SchoolInspectionEvent' from JSON`,
183
+ );
184
+ }