@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.
- package/dist/commonjs/funcs/censusGetBreaks.js +1 -1
- package/dist/commonjs/funcs/censusGetBreaks.js.map +1 -1
- package/dist/commonjs/funcs/censusGetTile.js +1 -1
- package/dist/commonjs/funcs/censusGetTile.js.map +1 -1
- package/dist/commonjs/funcs/censusGetWholeLevel.js +1 -1
- package/dist/commonjs/funcs/censusGetWholeLevel.js.map +1 -1
- package/dist/commonjs/funcs/planningGetPlanningApplications.d.ts +1 -1
- package/dist/commonjs/funcs/planningGetPlanningApplications.js +1 -1
- package/dist/commonjs/funcs/planningGetPlanningApplicationsBySource.d.ts +1 -1
- package/dist/commonjs/funcs/planningGetPlanningApplicationsBySource.js +1 -1
- package/dist/commonjs/funcs/planningSearchPlanningApplications.d.ts +1 -1
- package/dist/commonjs/funcs/planningSearchPlanningApplications.js +1 -1
- package/dist/commonjs/funcs/schoolsGetSchoolById.js +4 -0
- package/dist/commonjs/funcs/schoolsGetSchoolById.js.map +1 -1
- package/dist/commonjs/funcs/schoolsGetSchoolBySource.js +4 -0
- package/dist/commonjs/funcs/schoolsGetSchoolBySource.js.map +1 -1
- package/dist/commonjs/funcs/searchSearchSuggest.d.ts +6 -0
- package/dist/commonjs/funcs/searchSearchSuggest.d.ts.map +1 -1
- package/dist/commonjs/funcs/searchSearchSuggest.js +10 -0
- package/dist/commonjs/funcs/searchSearchSuggest.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/sdk/models/operations/getplanningapplications.d.ts +1 -1
- package/dist/commonjs/sdk/models/operations/getplanningapplicationsbysource.d.ts +1 -1
- package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts +69 -0
- package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getschoolbyid.js +35 -1
- package/dist/commonjs/sdk/models/operations/getschoolbyid.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/getschoolbysource.d.ts +69 -0
- package/dist/commonjs/sdk/models/operations/getschoolbysource.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getschoolbysource.js +35 -1
- package/dist/commonjs/sdk/models/operations/getschoolbysource.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/queryschools.d.ts +78 -0
- package/dist/commonjs/sdk/models/operations/queryschools.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/queryschools.js +42 -1
- package/dist/commonjs/sdk/models/operations/queryschools.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/queryschoolsbysource.d.ts +78 -0
- package/dist/commonjs/sdk/models/operations/queryschoolsbysource.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/queryschoolsbysource.js +41 -1
- package/dist/commonjs/sdk/models/operations/queryschoolsbysource.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts +51 -3
- package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/searchsuggest.js +27 -2
- package/dist/commonjs/sdk/models/operations/searchsuggest.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/chargeentry.d.ts +1 -1
- package/dist/commonjs/sdk/models/shared/chargehistory.d.ts +1 -1
- package/dist/commonjs/sdk/models/shared/index.d.ts +9 -0
- package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/index.js +9 -0
- package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/listing.d.ts +2 -2
- package/dist/commonjs/sdk/models/shared/listingpricechange.d.ts +2 -2
- package/dist/commonjs/sdk/models/shared/planningapplication.d.ts +27 -0
- package/dist/commonjs/sdk/models/shared/planningapplication.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningapplication.js +15 -1
- package/dist/commonjs/sdk/models/shared/planningapplication.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningclassificationreasoning.d.ts +45 -0
- package/dist/commonjs/sdk/models/shared/planningclassificationreasoning.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/planningclassificationreasoning.js +57 -0
- package/dist/commonjs/sdk/models/shared/planningclassificationreasoning.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/planningdocument.d.ts +8 -0
- package/dist/commonjs/sdk/models/shared/planningdocument.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningdocument.js +2 -0
- package/dist/commonjs/sdk/models/shared/planningdocument.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningimage.d.ts +49 -0
- package/dist/commonjs/sdk/models/shared/planningimage.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/planningimage.js +59 -0
- package/dist/commonjs/sdk/models/shared/planningimage.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/planningqueryrequest.d.ts +4 -1
- package/dist/commonjs/sdk/models/shared/planningqueryrequest.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningqueryrequest.js +3 -0
- package/dist/commonjs/sdk/models/shared/planningqueryrequest.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningsemanticchunk.d.ts +37 -0
- package/dist/commonjs/sdk/models/shared/planningsemanticchunk.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/planningsemanticchunk.js +56 -0
- package/dist/commonjs/sdk/models/shared/planningsemanticchunk.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/pricechange.d.ts +2 -2
- package/dist/commonjs/sdk/models/shared/pricingdata.d.ts +4 -4
- package/dist/commonjs/sdk/models/shared/salerecord.d.ts +1 -1
- package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.d.ts +17 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.js +51 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevent.d.ts +103 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevent.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevent.js +112 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionevent.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.d.ts +17 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.js +51 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.d.ts +13 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.js +53 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectorbody.d.ts +19 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectorbody.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectorbody.js +53 -0
- package/dist/commonjs/sdk/models/shared/schoolinspectorbody.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/schooltrustmembership.d.ts +45 -0
- package/dist/commonjs/sdk/models/shared/schooltrustmembership.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/schooltrustmembership.js +58 -0
- package/dist/commonjs/sdk/models/shared/schooltrustmembership.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/searchresult.d.ts +2 -2
- package/dist/commonjs/sdk/models/shared/sitepropertystats.d.ts +2 -2
- package/dist/commonjs/sdk/planning.d.ts +3 -3
- package/dist/commonjs/sdk/planning.js +3 -3
- package/dist/commonjs/sdk/search.d.ts +6 -0
- package/dist/commonjs/sdk/search.d.ts.map +1 -1
- package/dist/commonjs/sdk/search.js +6 -0
- package/dist/commonjs/sdk/search.js.map +1 -1
- package/dist/esm/funcs/censusGetBreaks.js +1 -1
- package/dist/esm/funcs/censusGetBreaks.js.map +1 -1
- package/dist/esm/funcs/censusGetTile.js +1 -1
- package/dist/esm/funcs/censusGetTile.js.map +1 -1
- package/dist/esm/funcs/censusGetWholeLevel.js +1 -1
- package/dist/esm/funcs/censusGetWholeLevel.js.map +1 -1
- package/dist/esm/funcs/planningGetPlanningApplications.d.ts +1 -1
- package/dist/esm/funcs/planningGetPlanningApplications.js +1 -1
- package/dist/esm/funcs/planningGetPlanningApplicationsBySource.d.ts +1 -1
- package/dist/esm/funcs/planningGetPlanningApplicationsBySource.js +1 -1
- package/dist/esm/funcs/planningSearchPlanningApplications.d.ts +1 -1
- package/dist/esm/funcs/planningSearchPlanningApplications.js +1 -1
- package/dist/esm/funcs/schoolsGetSchoolById.js +5 -1
- package/dist/esm/funcs/schoolsGetSchoolById.js.map +1 -1
- package/dist/esm/funcs/schoolsGetSchoolBySource.js +5 -1
- package/dist/esm/funcs/schoolsGetSchoolBySource.js.map +1 -1
- package/dist/esm/funcs/searchSearchSuggest.d.ts +6 -0
- package/dist/esm/funcs/searchSearchSuggest.d.ts.map +1 -1
- package/dist/esm/funcs/searchSearchSuggest.js +10 -0
- package/dist/esm/funcs/searchSearchSuggest.js.map +1 -1
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/sdk/models/operations/getplanningapplications.d.ts +1 -1
- package/dist/esm/sdk/models/operations/getplanningapplicationsbysource.d.ts +1 -1
- package/dist/esm/sdk/models/operations/getschoolbyid.d.ts +69 -0
- package/dist/esm/sdk/models/operations/getschoolbyid.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getschoolbyid.js +31 -0
- package/dist/esm/sdk/models/operations/getschoolbyid.js.map +1 -1
- package/dist/esm/sdk/models/operations/getschoolbysource.d.ts +69 -0
- package/dist/esm/sdk/models/operations/getschoolbysource.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getschoolbysource.js +31 -0
- package/dist/esm/sdk/models/operations/getschoolbysource.js.map +1 -1
- package/dist/esm/sdk/models/operations/queryschools.d.ts +78 -0
- package/dist/esm/sdk/models/operations/queryschools.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/queryschools.js +37 -0
- package/dist/esm/sdk/models/operations/queryschools.js.map +1 -1
- package/dist/esm/sdk/models/operations/queryschoolsbysource.d.ts +78 -0
- package/dist/esm/sdk/models/operations/queryschoolsbysource.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/queryschoolsbysource.js +36 -0
- package/dist/esm/sdk/models/operations/queryschoolsbysource.js.map +1 -1
- package/dist/esm/sdk/models/operations/searchsuggest.d.ts +51 -3
- package/dist/esm/sdk/models/operations/searchsuggest.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/searchsuggest.js +26 -1
- package/dist/esm/sdk/models/operations/searchsuggest.js.map +1 -1
- package/dist/esm/sdk/models/shared/chargeentry.d.ts +1 -1
- package/dist/esm/sdk/models/shared/chargehistory.d.ts +1 -1
- package/dist/esm/sdk/models/shared/index.d.ts +9 -0
- package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/index.js +9 -0
- package/dist/esm/sdk/models/shared/index.js.map +1 -1
- package/dist/esm/sdk/models/shared/listing.d.ts +2 -2
- package/dist/esm/sdk/models/shared/listingpricechange.d.ts +2 -2
- package/dist/esm/sdk/models/shared/planningapplication.d.ts +27 -0
- package/dist/esm/sdk/models/shared/planningapplication.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/planningapplication.js +13 -0
- package/dist/esm/sdk/models/shared/planningapplication.js.map +1 -1
- package/dist/esm/sdk/models/shared/planningclassificationreasoning.d.ts +45 -0
- package/dist/esm/sdk/models/shared/planningclassificationreasoning.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/planningclassificationreasoning.js +20 -0
- package/dist/esm/sdk/models/shared/planningclassificationreasoning.js.map +1 -0
- package/dist/esm/sdk/models/shared/planningdocument.d.ts +8 -0
- package/dist/esm/sdk/models/shared/planningdocument.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/planningdocument.js +2 -0
- package/dist/esm/sdk/models/shared/planningdocument.js.map +1 -1
- package/dist/esm/sdk/models/shared/planningimage.d.ts +49 -0
- package/dist/esm/sdk/models/shared/planningimage.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/planningimage.js +22 -0
- package/dist/esm/sdk/models/shared/planningimage.js.map +1 -0
- package/dist/esm/sdk/models/shared/planningqueryrequest.d.ts +4 -1
- package/dist/esm/sdk/models/shared/planningqueryrequest.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/planningqueryrequest.js +3 -0
- package/dist/esm/sdk/models/shared/planningqueryrequest.js.map +1 -1
- package/dist/esm/sdk/models/shared/planningsemanticchunk.d.ts +37 -0
- package/dist/esm/sdk/models/shared/planningsemanticchunk.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/planningsemanticchunk.js +19 -0
- package/dist/esm/sdk/models/shared/planningsemanticchunk.js.map +1 -0
- package/dist/esm/sdk/models/shared/pricechange.d.ts +2 -2
- package/dist/esm/sdk/models/shared/pricingdata.d.ts +4 -4
- package/dist/esm/sdk/models/shared/salerecord.d.ts +1 -1
- package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.d.ts +17 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.js +14 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.js.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevent.d.ts +103 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevent.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevent.js +74 -0
- package/dist/esm/sdk/models/shared/schoolinspectionevent.js.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectiongrade.d.ts +17 -0
- package/dist/esm/sdk/models/shared/schoolinspectiongrade.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectiongrade.js +14 -0
- package/dist/esm/sdk/models/shared/schoolinspectiongrade.js.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.d.ts +13 -0
- package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.js +16 -0
- package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.js.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectorbody.d.ts +19 -0
- package/dist/esm/sdk/models/shared/schoolinspectorbody.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/schoolinspectorbody.js +17 -0
- package/dist/esm/sdk/models/shared/schoolinspectorbody.js.map +1 -0
- package/dist/esm/sdk/models/shared/schooltrustmembership.d.ts +45 -0
- package/dist/esm/sdk/models/shared/schooltrustmembership.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/schooltrustmembership.js +21 -0
- package/dist/esm/sdk/models/shared/schooltrustmembership.js.map +1 -0
- package/dist/esm/sdk/models/shared/searchresult.d.ts +2 -2
- package/dist/esm/sdk/models/shared/sitepropertystats.d.ts +2 -2
- package/dist/esm/sdk/planning.d.ts +3 -3
- package/dist/esm/sdk/planning.js +3 -3
- package/dist/esm/sdk/search.d.ts +6 -0
- package/dist/esm/sdk/search.d.ts.map +1 -1
- package/dist/esm/sdk/search.js +6 -0
- package/dist/esm/sdk/search.js.map +1 -1
- package/package.json +1 -1
- package/src/funcs/censusGetBreaks.ts +1 -1
- package/src/funcs/censusGetTile.ts +1 -1
- package/src/funcs/censusGetWholeLevel.ts +1 -1
- package/src/funcs/planningGetPlanningApplications.ts +1 -1
- package/src/funcs/planningGetPlanningApplicationsBySource.ts +1 -1
- package/src/funcs/planningSearchPlanningApplications.ts +1 -1
- package/src/funcs/schoolsGetSchoolById.ts +6 -1
- package/src/funcs/schoolsGetSchoolBySource.ts +6 -1
- package/src/funcs/searchSearchSuggest.ts +10 -0
- package/src/lib/config.ts +2 -2
- package/src/sdk/models/operations/getplanningapplications.ts +1 -1
- package/src/sdk/models/operations/getplanningapplicationsbysource.ts +1 -1
- package/src/sdk/models/operations/getschoolbyid.ts +126 -0
- package/src/sdk/models/operations/getschoolbysource.ts +134 -0
- package/src/sdk/models/operations/queryschools.ts +154 -0
- package/src/sdk/models/operations/queryschoolsbysource.ts +153 -0
- package/src/sdk/models/operations/searchsuggest.ts +64 -3
- package/src/sdk/models/shared/chargeentry.ts +1 -1
- package/src/sdk/models/shared/chargehistory.ts +1 -1
- package/src/sdk/models/shared/index.ts +9 -0
- package/src/sdk/models/shared/listing.ts +2 -2
- package/src/sdk/models/shared/listingpricechange.ts +2 -2
- package/src/sdk/models/shared/planningapplication.ts +53 -0
- package/src/sdk/models/shared/planningclassificationreasoning.ts +69 -0
- package/src/sdk/models/shared/planningdocument.ts +10 -0
- package/src/sdk/models/shared/planningimage.ts +79 -0
- package/src/sdk/models/shared/planningqueryrequest.ts +4 -1
- package/src/sdk/models/shared/planningsemanticchunk.ts +64 -0
- package/src/sdk/models/shared/pricechange.ts +2 -2
- package/src/sdk/models/shared/pricingdata.ts +4 -4
- package/src/sdk/models/shared/salerecord.ts +1 -1
- package/src/sdk/models/shared/schoolinspectionevaluationarea.ts +39 -0
- package/src/sdk/models/shared/schoolinspectionevent.ts +184 -0
- package/src/sdk/models/shared/schoolinspectiongrade.ts +39 -0
- package/src/sdk/models/shared/schoolinspectionpredecessor.ts +37 -0
- package/src/sdk/models/shared/schoolinspectorbody.ts +29 -0
- package/src/sdk/models/shared/schooltrustmembership.ts +74 -0
- package/src/sdk/models/shared/searchresult.ts +2 -2
- package/src/sdk/models/shared/sitepropertystats.ts +2 -2
- package/src/sdk/planning.ts +3 -3
- package/src/sdk/search.ts +6 -0
|
@@ -11,6 +11,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
|
|
|
11
11
|
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
12
12
|
import * as shared from "../shared/index.js";
|
|
13
13
|
|
|
14
|
+
/**
|
|
15
|
+
* Fields/blocks to return per school. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`.
|
|
16
|
+
*/
|
|
17
|
+
export type QuerySchoolsAttributes = string | Array<string>;
|
|
18
|
+
|
|
14
19
|
/**
|
|
15
20
|
* Radius search around a point. Adds `distance` field to each result. Mutually exclusive with `within`.
|
|
16
21
|
*/
|
|
@@ -197,6 +202,10 @@ export type Within = {
|
|
|
197
202
|
* Flexible school query. Filter by country/region/provider, categorical fields, free-text, or geography (radius or bounding box). Pagination via limit/offset, ordering via orderBy/order.
|
|
198
203
|
*/
|
|
199
204
|
export type QuerySchoolsRequestBody = {
|
|
205
|
+
/**
|
|
206
|
+
* Fields/blocks to return per school. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`.
|
|
207
|
+
*/
|
|
208
|
+
attributes?: string | Array<string> | undefined;
|
|
200
209
|
/**
|
|
201
210
|
* Filter by local authority name
|
|
202
211
|
*/
|
|
@@ -315,6 +324,42 @@ export type QuerySchoolsCurrentRating = OpenEnum<
|
|
|
315
324
|
typeof QuerySchoolsCurrentRating
|
|
316
325
|
>;
|
|
317
326
|
|
|
327
|
+
/**
|
|
328
|
+
* Cross-register identifiers. Present only when requested via `attributes=identifiers`.
|
|
329
|
+
*/
|
|
330
|
+
export type QuerySchoolsIdentifiers = {
|
|
331
|
+
/**
|
|
332
|
+
* Estyn provider id (Wales).
|
|
333
|
+
*/
|
|
334
|
+
estynId?: string | null | undefined;
|
|
335
|
+
/**
|
|
336
|
+
* Ofsted provider id (England).
|
|
337
|
+
*/
|
|
338
|
+
ofstedProviderId?: string | null | undefined;
|
|
339
|
+
/**
|
|
340
|
+
* Predecessor URNs this school was previously known by (re-identification lineage).
|
|
341
|
+
*/
|
|
342
|
+
oldUrns?: Array<string> | undefined;
|
|
343
|
+
/**
|
|
344
|
+
* UK Provider Reference Number (UKPRN).
|
|
345
|
+
*/
|
|
346
|
+
ukprn?: string | null | undefined;
|
|
347
|
+
};
|
|
348
|
+
|
|
349
|
+
/**
|
|
350
|
+
* Inspection history. Present only when requested via `attributes=inspections`.
|
|
351
|
+
*/
|
|
352
|
+
export type QuerySchoolsInspections = {
|
|
353
|
+
/**
|
|
354
|
+
* Most recent inspection event, or null if never inspected.
|
|
355
|
+
*/
|
|
356
|
+
current: shared.SchoolInspectionEvent | null;
|
|
357
|
+
/**
|
|
358
|
+
* Every inspection event, newest first (includes `current`).
|
|
359
|
+
*/
|
|
360
|
+
history?: Array<shared.SchoolInspectionEvent | null> | undefined;
|
|
361
|
+
};
|
|
362
|
+
|
|
318
363
|
/**
|
|
319
364
|
* Geographic coordinates of the school
|
|
320
365
|
*/
|
|
@@ -372,6 +417,16 @@ export type QuerySchoolsSchoolsStatus = OpenEnum<
|
|
|
372
417
|
typeof QuerySchoolsSchoolsStatus
|
|
373
418
|
>;
|
|
374
419
|
|
|
420
|
+
/**
|
|
421
|
+
* Trust / organisation memberships. Present only when requested via `attributes=trust`.
|
|
422
|
+
*/
|
|
423
|
+
export type QuerySchoolsTrust = {
|
|
424
|
+
/**
|
|
425
|
+
* Active organisation memberships, lead/trust roles first.
|
|
426
|
+
*/
|
|
427
|
+
memberships?: Array<shared.SchoolTrustMembership> | undefined;
|
|
428
|
+
};
|
|
429
|
+
|
|
375
430
|
/**
|
|
376
431
|
* Educational institution type. 'nursery': early years. 'primary': key stages 1-2 / ISCED 1. 'secondary': key stages 3-4 / ISCED 2-3. 'all-through': combined primary + secondary. 'sixth-form': post-16. 'special': special educational needs. 'independent': fee-paying. 'academy': state-funded, independently run. 'other': alternative provision / pupil referral / unclassified.
|
|
377
432
|
*/
|
|
@@ -429,6 +484,14 @@ export type QuerySchoolsData = {
|
|
|
429
484
|
* System-generated identifier. Stable across updates.
|
|
430
485
|
*/
|
|
431
486
|
id: number;
|
|
487
|
+
/**
|
|
488
|
+
* Cross-register identifiers. Present only when requested via `attributes=identifiers`.
|
|
489
|
+
*/
|
|
490
|
+
identifiers?: QuerySchoolsIdentifiers | null | undefined;
|
|
491
|
+
/**
|
|
492
|
+
* Inspection history. Present only when requested via `attributes=inspections`.
|
|
493
|
+
*/
|
|
494
|
+
inspections?: QuerySchoolsInspections | null | undefined;
|
|
432
495
|
/**
|
|
433
496
|
* Provider-scoped identifier. URN for `dfe`, SEED for `seed`, etc. Combined with `provider` this is a globally unique alternate key for the school.
|
|
434
497
|
*/
|
|
@@ -485,6 +548,10 @@ export type QuerySchoolsData = {
|
|
|
485
548
|
*/
|
|
486
549
|
subType?: string | undefined;
|
|
487
550
|
telephone?: string | undefined;
|
|
551
|
+
/**
|
|
552
|
+
* Trust / organisation memberships. Present only when requested via `attributes=trust`.
|
|
553
|
+
*/
|
|
554
|
+
trust?: QuerySchoolsTrust | null | undefined;
|
|
488
555
|
trustId?: string | undefined;
|
|
489
556
|
trustName?: string | undefined;
|
|
490
557
|
/**
|
|
@@ -543,6 +610,24 @@ export type QuerySchoolsResponseBody = {
|
|
|
543
610
|
url: string;
|
|
544
611
|
};
|
|
545
612
|
|
|
613
|
+
/** @internal */
|
|
614
|
+
export type QuerySchoolsAttributes$Outbound = string | Array<string>;
|
|
615
|
+
|
|
616
|
+
/** @internal */
|
|
617
|
+
export const QuerySchoolsAttributes$outboundSchema: z.ZodType<
|
|
618
|
+
QuerySchoolsAttributes$Outbound,
|
|
619
|
+
z.ZodTypeDef,
|
|
620
|
+
QuerySchoolsAttributes
|
|
621
|
+
> = z.union([z.string(), z.array(z.string())]);
|
|
622
|
+
|
|
623
|
+
export function querySchoolsAttributesToJSON(
|
|
624
|
+
querySchoolsAttributes: QuerySchoolsAttributes,
|
|
625
|
+
): string {
|
|
626
|
+
return JSON.stringify(
|
|
627
|
+
QuerySchoolsAttributes$outboundSchema.parse(querySchoolsAttributes),
|
|
628
|
+
);
|
|
629
|
+
}
|
|
630
|
+
|
|
546
631
|
/** @internal */
|
|
547
632
|
export type Near$Outbound = {
|
|
548
633
|
lat: number;
|
|
@@ -655,6 +740,7 @@ export function withinToJSON(within: Within): string {
|
|
|
655
740
|
|
|
656
741
|
/** @internal */
|
|
657
742
|
export type QuerySchoolsRequestBody$Outbound = {
|
|
743
|
+
attributes?: string | Array<string> | undefined;
|
|
658
744
|
authority?: string | undefined;
|
|
659
745
|
catchmentReference?: shared.CatchmentReference$Outbound | undefined;
|
|
660
746
|
country?: string | undefined;
|
|
@@ -680,6 +766,7 @@ export const QuerySchoolsRequestBody$outboundSchema: z.ZodType<
|
|
|
680
766
|
z.ZodTypeDef,
|
|
681
767
|
QuerySchoolsRequestBody
|
|
682
768
|
> = z.object({
|
|
769
|
+
attributes: z.union([z.string(), z.array(z.string())]).optional(),
|
|
683
770
|
authority: z.string().optional(),
|
|
684
771
|
catchmentReference: shared.CatchmentReference$outboundSchema.optional(),
|
|
685
772
|
country: z.string().optional(),
|
|
@@ -740,6 +827,49 @@ export const QuerySchoolsCurrentRating$inboundSchema: z.ZodType<
|
|
|
740
827
|
unknown
|
|
741
828
|
> = openEnums.inboundSchema(QuerySchoolsCurrentRating);
|
|
742
829
|
|
|
830
|
+
/** @internal */
|
|
831
|
+
export const QuerySchoolsIdentifiers$inboundSchema: z.ZodType<
|
|
832
|
+
QuerySchoolsIdentifiers,
|
|
833
|
+
z.ZodTypeDef,
|
|
834
|
+
unknown
|
|
835
|
+
> = z.object({
|
|
836
|
+
estynId: z.nullable(z.string()).optional(),
|
|
837
|
+
ofstedProviderId: z.nullable(z.string()).optional(),
|
|
838
|
+
oldUrns: z.array(z.string()).optional(),
|
|
839
|
+
ukprn: z.nullable(z.string()).optional(),
|
|
840
|
+
});
|
|
841
|
+
|
|
842
|
+
export function querySchoolsIdentifiersFromJSON(
|
|
843
|
+
jsonString: string,
|
|
844
|
+
): SafeParseResult<QuerySchoolsIdentifiers, SDKValidationError> {
|
|
845
|
+
return safeParse(
|
|
846
|
+
jsonString,
|
|
847
|
+
(x) => QuerySchoolsIdentifiers$inboundSchema.parse(JSON.parse(x)),
|
|
848
|
+
`Failed to parse 'QuerySchoolsIdentifiers' from JSON`,
|
|
849
|
+
);
|
|
850
|
+
}
|
|
851
|
+
|
|
852
|
+
/** @internal */
|
|
853
|
+
export const QuerySchoolsInspections$inboundSchema: z.ZodType<
|
|
854
|
+
QuerySchoolsInspections,
|
|
855
|
+
z.ZodTypeDef,
|
|
856
|
+
unknown
|
|
857
|
+
> = z.object({
|
|
858
|
+
current: z.nullable(shared.SchoolInspectionEvent$inboundSchema),
|
|
859
|
+
history: z.array(z.nullable(shared.SchoolInspectionEvent$inboundSchema))
|
|
860
|
+
.optional(),
|
|
861
|
+
});
|
|
862
|
+
|
|
863
|
+
export function querySchoolsInspectionsFromJSON(
|
|
864
|
+
jsonString: string,
|
|
865
|
+
): SafeParseResult<QuerySchoolsInspections, SDKValidationError> {
|
|
866
|
+
return safeParse(
|
|
867
|
+
jsonString,
|
|
868
|
+
(x) => QuerySchoolsInspections$inboundSchema.parse(JSON.parse(x)),
|
|
869
|
+
`Failed to parse 'QuerySchoolsInspections' from JSON`,
|
|
870
|
+
);
|
|
871
|
+
}
|
|
872
|
+
|
|
743
873
|
/** @internal */
|
|
744
874
|
export const QuerySchoolsLocation$inboundSchema: z.ZodType<
|
|
745
875
|
QuerySchoolsLocation,
|
|
@@ -779,6 +909,25 @@ export const QuerySchoolsSchoolsStatus$inboundSchema: z.ZodType<
|
|
|
779
909
|
unknown
|
|
780
910
|
> = openEnums.inboundSchema(QuerySchoolsSchoolsStatus);
|
|
781
911
|
|
|
912
|
+
/** @internal */
|
|
913
|
+
export const QuerySchoolsTrust$inboundSchema: z.ZodType<
|
|
914
|
+
QuerySchoolsTrust,
|
|
915
|
+
z.ZodTypeDef,
|
|
916
|
+
unknown
|
|
917
|
+
> = z.object({
|
|
918
|
+
memberships: z.array(shared.SchoolTrustMembership$inboundSchema).optional(),
|
|
919
|
+
});
|
|
920
|
+
|
|
921
|
+
export function querySchoolsTrustFromJSON(
|
|
922
|
+
jsonString: string,
|
|
923
|
+
): SafeParseResult<QuerySchoolsTrust, SDKValidationError> {
|
|
924
|
+
return safeParse(
|
|
925
|
+
jsonString,
|
|
926
|
+
(x) => QuerySchoolsTrust$inboundSchema.parse(JSON.parse(x)),
|
|
927
|
+
`Failed to parse 'QuerySchoolsTrust' from JSON`,
|
|
928
|
+
);
|
|
929
|
+
}
|
|
930
|
+
|
|
782
931
|
/** @internal */
|
|
783
932
|
export const QuerySchoolsType$inboundSchema: z.ZodType<
|
|
784
933
|
QuerySchoolsType,
|
|
@@ -805,6 +954,10 @@ export const QuerySchoolsData$inboundSchema: z.ZodType<
|
|
|
805
954
|
gender: z.string().optional(),
|
|
806
955
|
headteacher: z.string().optional(),
|
|
807
956
|
id: z.number().int(),
|
|
957
|
+
identifiers: z.nullable(z.lazy(() => QuerySchoolsIdentifiers$inboundSchema))
|
|
958
|
+
.optional(),
|
|
959
|
+
inspections: z.nullable(z.lazy(() => QuerySchoolsInspections$inboundSchema))
|
|
960
|
+
.optional(),
|
|
808
961
|
key: z.string(),
|
|
809
962
|
laCode: z.string().optional(),
|
|
810
963
|
laName: z.string().optional(),
|
|
@@ -826,6 +979,7 @@ export const QuerySchoolsData$inboundSchema: z.ZodType<
|
|
|
826
979
|
status: QuerySchoolsSchoolsStatus$inboundSchema,
|
|
827
980
|
subType: z.string().optional(),
|
|
828
981
|
telephone: z.string().optional(),
|
|
982
|
+
trust: z.nullable(z.lazy(() => QuerySchoolsTrust$inboundSchema)).optional(),
|
|
829
983
|
trustId: z.string().optional(),
|
|
830
984
|
trustName: z.string().optional(),
|
|
831
985
|
type: QuerySchoolsType$inboundSchema,
|
|
@@ -11,6 +11,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
|
|
|
11
11
|
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
12
12
|
import * as shared from "../shared/index.js";
|
|
13
13
|
|
|
14
|
+
/**
|
|
15
|
+
* Fields/blocks to return per school. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`.
|
|
16
|
+
*/
|
|
17
|
+
export type Attributes = string | Array<string>;
|
|
18
|
+
|
|
14
19
|
/**
|
|
15
20
|
* Source register identifier. 'dfe': UK DfE GIAS (England + cross-border Welsh URNs). 'welshgov': Welsh Government School Number. 'seed': Scottish SEED code. 'deni': NI DE Reference. 'dept_edu_ie': Irish Roll Number.
|
|
16
21
|
*/
|
|
@@ -30,6 +35,10 @@ export type Provider = ClosedEnum<typeof Provider>;
|
|
|
30
35
|
* Batch lookup by provider keys. Keys that do not match are silently omitted from the response.
|
|
31
36
|
*/
|
|
32
37
|
export type QuerySchoolsBySourceRequestBody = {
|
|
38
|
+
/**
|
|
39
|
+
* Fields/blocks to return per school. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`.
|
|
40
|
+
*/
|
|
41
|
+
attributes?: string | Array<string> | undefined;
|
|
33
42
|
/**
|
|
34
43
|
* Array of provider-scoped identifiers (URNs / SEED codes / etc). Maximum 500 per request.
|
|
35
44
|
*/
|
|
@@ -97,6 +106,42 @@ export type QuerySchoolsBySourceCurrentRating = OpenEnum<
|
|
|
97
106
|
typeof QuerySchoolsBySourceCurrentRating
|
|
98
107
|
>;
|
|
99
108
|
|
|
109
|
+
/**
|
|
110
|
+
* Cross-register identifiers. Present only when requested via `attributes=identifiers`.
|
|
111
|
+
*/
|
|
112
|
+
export type QuerySchoolsBySourceIdentifiers = {
|
|
113
|
+
/**
|
|
114
|
+
* Estyn provider id (Wales).
|
|
115
|
+
*/
|
|
116
|
+
estynId?: string | null | undefined;
|
|
117
|
+
/**
|
|
118
|
+
* Ofsted provider id (England).
|
|
119
|
+
*/
|
|
120
|
+
ofstedProviderId?: string | null | undefined;
|
|
121
|
+
/**
|
|
122
|
+
* Predecessor URNs this school was previously known by (re-identification lineage).
|
|
123
|
+
*/
|
|
124
|
+
oldUrns?: Array<string> | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* UK Provider Reference Number (UKPRN).
|
|
127
|
+
*/
|
|
128
|
+
ukprn?: string | null | undefined;
|
|
129
|
+
};
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* Inspection history. Present only when requested via `attributes=inspections`.
|
|
133
|
+
*/
|
|
134
|
+
export type QuerySchoolsBySourceInspections = {
|
|
135
|
+
/**
|
|
136
|
+
* Most recent inspection event, or null if never inspected.
|
|
137
|
+
*/
|
|
138
|
+
current: shared.SchoolInspectionEvent | null;
|
|
139
|
+
/**
|
|
140
|
+
* Every inspection event, newest first (includes `current`).
|
|
141
|
+
*/
|
|
142
|
+
history?: Array<shared.SchoolInspectionEvent | null> | undefined;
|
|
143
|
+
};
|
|
144
|
+
|
|
100
145
|
/**
|
|
101
146
|
* Geographic coordinates of the school
|
|
102
147
|
*/
|
|
@@ -156,6 +201,16 @@ export type QuerySchoolsBySourceStatus = OpenEnum<
|
|
|
156
201
|
typeof QuerySchoolsBySourceStatus
|
|
157
202
|
>;
|
|
158
203
|
|
|
204
|
+
/**
|
|
205
|
+
* Trust / organisation memberships. Present only when requested via `attributes=trust`.
|
|
206
|
+
*/
|
|
207
|
+
export type QuerySchoolsBySourceTrust = {
|
|
208
|
+
/**
|
|
209
|
+
* Active organisation memberships, lead/trust roles first.
|
|
210
|
+
*/
|
|
211
|
+
memberships?: Array<shared.SchoolTrustMembership> | undefined;
|
|
212
|
+
};
|
|
213
|
+
|
|
159
214
|
/**
|
|
160
215
|
* Educational institution type. 'nursery': early years. 'primary': key stages 1-2 / ISCED 1. 'secondary': key stages 3-4 / ISCED 2-3. 'all-through': combined primary + secondary. 'sixth-form': post-16. 'special': special educational needs. 'independent': fee-paying. 'academy': state-funded, independently run. 'other': alternative provision / pupil referral / unclassified.
|
|
161
216
|
*/
|
|
@@ -215,6 +270,14 @@ export type QuerySchoolsBySourceData = {
|
|
|
215
270
|
* System-generated identifier. Stable across updates.
|
|
216
271
|
*/
|
|
217
272
|
id: number;
|
|
273
|
+
/**
|
|
274
|
+
* Cross-register identifiers. Present only when requested via `attributes=identifiers`.
|
|
275
|
+
*/
|
|
276
|
+
identifiers?: QuerySchoolsBySourceIdentifiers | null | undefined;
|
|
277
|
+
/**
|
|
278
|
+
* Inspection history. Present only when requested via `attributes=inspections`.
|
|
279
|
+
*/
|
|
280
|
+
inspections?: QuerySchoolsBySourceInspections | null | undefined;
|
|
218
281
|
/**
|
|
219
282
|
* Provider-scoped identifier. URN for `dfe`, SEED for `seed`, etc. Combined with `provider` this is a globally unique alternate key for the school.
|
|
220
283
|
*/
|
|
@@ -271,6 +334,10 @@ export type QuerySchoolsBySourceData = {
|
|
|
271
334
|
*/
|
|
272
335
|
subType?: string | undefined;
|
|
273
336
|
telephone?: string | undefined;
|
|
337
|
+
/**
|
|
338
|
+
* Trust / organisation memberships. Present only when requested via `attributes=trust`.
|
|
339
|
+
*/
|
|
340
|
+
trust?: QuerySchoolsBySourceTrust | null | undefined;
|
|
274
341
|
trustId?: string | undefined;
|
|
275
342
|
trustName?: string | undefined;
|
|
276
343
|
/**
|
|
@@ -323,12 +390,27 @@ export type QuerySchoolsBySourceResponseBody = {
|
|
|
323
390
|
url: string;
|
|
324
391
|
};
|
|
325
392
|
|
|
393
|
+
/** @internal */
|
|
394
|
+
export type Attributes$Outbound = string | Array<string>;
|
|
395
|
+
|
|
396
|
+
/** @internal */
|
|
397
|
+
export const Attributes$outboundSchema: z.ZodType<
|
|
398
|
+
Attributes$Outbound,
|
|
399
|
+
z.ZodTypeDef,
|
|
400
|
+
Attributes
|
|
401
|
+
> = z.union([z.string(), z.array(z.string())]);
|
|
402
|
+
|
|
403
|
+
export function attributesToJSON(attributes: Attributes): string {
|
|
404
|
+
return JSON.stringify(Attributes$outboundSchema.parse(attributes));
|
|
405
|
+
}
|
|
406
|
+
|
|
326
407
|
/** @internal */
|
|
327
408
|
export const Provider$outboundSchema: z.ZodNativeEnum<typeof Provider> = z
|
|
328
409
|
.nativeEnum(Provider);
|
|
329
410
|
|
|
330
411
|
/** @internal */
|
|
331
412
|
export type QuerySchoolsBySourceRequestBody$Outbound = {
|
|
413
|
+
attributes?: string | Array<string> | undefined;
|
|
332
414
|
keys: Array<string>;
|
|
333
415
|
provider: string;
|
|
334
416
|
};
|
|
@@ -339,6 +421,7 @@ export const QuerySchoolsBySourceRequestBody$outboundSchema: z.ZodType<
|
|
|
339
421
|
z.ZodTypeDef,
|
|
340
422
|
QuerySchoolsBySourceRequestBody
|
|
341
423
|
> = z.object({
|
|
424
|
+
attributes: z.union([z.string(), z.array(z.string())]).optional(),
|
|
342
425
|
keys: z.array(z.string()),
|
|
343
426
|
provider: Provider$outboundSchema,
|
|
344
427
|
});
|
|
@@ -383,6 +466,49 @@ export const QuerySchoolsBySourceCurrentRating$inboundSchema: z.ZodType<
|
|
|
383
466
|
unknown
|
|
384
467
|
> = openEnums.inboundSchema(QuerySchoolsBySourceCurrentRating);
|
|
385
468
|
|
|
469
|
+
/** @internal */
|
|
470
|
+
export const QuerySchoolsBySourceIdentifiers$inboundSchema: z.ZodType<
|
|
471
|
+
QuerySchoolsBySourceIdentifiers,
|
|
472
|
+
z.ZodTypeDef,
|
|
473
|
+
unknown
|
|
474
|
+
> = z.object({
|
|
475
|
+
estynId: z.nullable(z.string()).optional(),
|
|
476
|
+
ofstedProviderId: z.nullable(z.string()).optional(),
|
|
477
|
+
oldUrns: z.array(z.string()).optional(),
|
|
478
|
+
ukprn: z.nullable(z.string()).optional(),
|
|
479
|
+
});
|
|
480
|
+
|
|
481
|
+
export function querySchoolsBySourceIdentifiersFromJSON(
|
|
482
|
+
jsonString: string,
|
|
483
|
+
): SafeParseResult<QuerySchoolsBySourceIdentifiers, SDKValidationError> {
|
|
484
|
+
return safeParse(
|
|
485
|
+
jsonString,
|
|
486
|
+
(x) => QuerySchoolsBySourceIdentifiers$inboundSchema.parse(JSON.parse(x)),
|
|
487
|
+
`Failed to parse 'QuerySchoolsBySourceIdentifiers' from JSON`,
|
|
488
|
+
);
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
/** @internal */
|
|
492
|
+
export const QuerySchoolsBySourceInspections$inboundSchema: z.ZodType<
|
|
493
|
+
QuerySchoolsBySourceInspections,
|
|
494
|
+
z.ZodTypeDef,
|
|
495
|
+
unknown
|
|
496
|
+
> = z.object({
|
|
497
|
+
current: z.nullable(shared.SchoolInspectionEvent$inboundSchema),
|
|
498
|
+
history: z.array(z.nullable(shared.SchoolInspectionEvent$inboundSchema))
|
|
499
|
+
.optional(),
|
|
500
|
+
});
|
|
501
|
+
|
|
502
|
+
export function querySchoolsBySourceInspectionsFromJSON(
|
|
503
|
+
jsonString: string,
|
|
504
|
+
): SafeParseResult<QuerySchoolsBySourceInspections, SDKValidationError> {
|
|
505
|
+
return safeParse(
|
|
506
|
+
jsonString,
|
|
507
|
+
(x) => QuerySchoolsBySourceInspections$inboundSchema.parse(JSON.parse(x)),
|
|
508
|
+
`Failed to parse 'QuerySchoolsBySourceInspections' from JSON`,
|
|
509
|
+
);
|
|
510
|
+
}
|
|
511
|
+
|
|
386
512
|
/** @internal */
|
|
387
513
|
export const QuerySchoolsBySourceLocation$inboundSchema: z.ZodType<
|
|
388
514
|
QuerySchoolsBySourceLocation,
|
|
@@ -422,6 +548,25 @@ export const QuerySchoolsBySourceStatus$inboundSchema: z.ZodType<
|
|
|
422
548
|
unknown
|
|
423
549
|
> = openEnums.inboundSchema(QuerySchoolsBySourceStatus);
|
|
424
550
|
|
|
551
|
+
/** @internal */
|
|
552
|
+
export const QuerySchoolsBySourceTrust$inboundSchema: z.ZodType<
|
|
553
|
+
QuerySchoolsBySourceTrust,
|
|
554
|
+
z.ZodTypeDef,
|
|
555
|
+
unknown
|
|
556
|
+
> = z.object({
|
|
557
|
+
memberships: z.array(shared.SchoolTrustMembership$inboundSchema).optional(),
|
|
558
|
+
});
|
|
559
|
+
|
|
560
|
+
export function querySchoolsBySourceTrustFromJSON(
|
|
561
|
+
jsonString: string,
|
|
562
|
+
): SafeParseResult<QuerySchoolsBySourceTrust, SDKValidationError> {
|
|
563
|
+
return safeParse(
|
|
564
|
+
jsonString,
|
|
565
|
+
(x) => QuerySchoolsBySourceTrust$inboundSchema.parse(JSON.parse(x)),
|
|
566
|
+
`Failed to parse 'QuerySchoolsBySourceTrust' from JSON`,
|
|
567
|
+
);
|
|
568
|
+
}
|
|
569
|
+
|
|
425
570
|
/** @internal */
|
|
426
571
|
export const QuerySchoolsBySourceType$inboundSchema: z.ZodType<
|
|
427
572
|
QuerySchoolsBySourceType,
|
|
@@ -449,6 +594,12 @@ export const QuerySchoolsBySourceData$inboundSchema: z.ZodType<
|
|
|
449
594
|
gender: z.string().optional(),
|
|
450
595
|
headteacher: z.string().optional(),
|
|
451
596
|
id: z.number().int(),
|
|
597
|
+
identifiers: z.nullable(
|
|
598
|
+
z.lazy(() => QuerySchoolsBySourceIdentifiers$inboundSchema),
|
|
599
|
+
).optional(),
|
|
600
|
+
inspections: z.nullable(
|
|
601
|
+
z.lazy(() => QuerySchoolsBySourceInspections$inboundSchema),
|
|
602
|
+
).optional(),
|
|
452
603
|
key: z.string(),
|
|
453
604
|
laCode: z.string().optional(),
|
|
454
605
|
laName: z.string().optional(),
|
|
@@ -470,6 +621,8 @@ export const QuerySchoolsBySourceData$inboundSchema: z.ZodType<
|
|
|
470
621
|
status: QuerySchoolsBySourceStatus$inboundSchema,
|
|
471
622
|
subType: z.string().optional(),
|
|
472
623
|
telephone: z.string().optional(),
|
|
624
|
+
trust: z.nullable(z.lazy(() => QuerySchoolsBySourceTrust$inboundSchema))
|
|
625
|
+
.optional(),
|
|
473
626
|
trustId: z.string().optional(),
|
|
474
627
|
trustName: z.string().optional(),
|
|
475
628
|
type: QuerySchoolsBySourceType$inboundSchema,
|
|
@@ -3,10 +3,11 @@
|
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
5
|
import * as z from "zod/v3";
|
|
6
|
+
import { remap as remap$ } from "../../../lib/primitives.js";
|
|
6
7
|
import { ClosedEnum } from "../../types/enums.js";
|
|
7
8
|
|
|
8
9
|
/**
|
|
9
|
-
* Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter
|
|
10
|
+
* Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter, returns all address types. Defaults to 'residential'.
|
|
10
11
|
*/
|
|
11
12
|
export const Classification = {
|
|
12
13
|
Residential: "residential",
|
|
@@ -14,19 +15,58 @@ export const Classification = {
|
|
|
14
15
|
All: "all",
|
|
15
16
|
} as const;
|
|
16
17
|
/**
|
|
17
|
-
* Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter
|
|
18
|
+
* Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter, returns all address types. Defaults to 'residential'.
|
|
18
19
|
*/
|
|
19
20
|
export type Classification = ClosedEnum<typeof Classification>;
|
|
20
21
|
|
|
22
|
+
/**
|
|
23
|
+
* Geographic ranking mode (only applies when `lat` and `lng` are both supplied):
|
|
24
|
+
*
|
|
25
|
+
* @remarks
|
|
26
|
+
* - `bias` (default): soft preference. Still returns the best textual matches, but ranks results near the centre point higher.
|
|
27
|
+
* - `restrict`: hard cutoff. Only returns results within `radius_meters` of the centre point (requires `radius_meters`).
|
|
28
|
+
* Applies to address-source results.
|
|
29
|
+
*/
|
|
30
|
+
export const GeoMode = {
|
|
31
|
+
Bias: "bias",
|
|
32
|
+
Restrict: "restrict",
|
|
33
|
+
} as const;
|
|
34
|
+
/**
|
|
35
|
+
* Geographic ranking mode (only applies when `lat` and `lng` are both supplied):
|
|
36
|
+
*
|
|
37
|
+
* @remarks
|
|
38
|
+
* - `bias` (default): soft preference. Still returns the best textual matches, but ranks results near the centre point higher.
|
|
39
|
+
* - `restrict`: hard cutoff. Only returns results within `radius_meters` of the centre point (requires `radius_meters`).
|
|
40
|
+
* Applies to address-source results.
|
|
41
|
+
*/
|
|
42
|
+
export type GeoMode = ClosedEnum<typeof GeoMode>;
|
|
43
|
+
|
|
21
44
|
export type SearchSuggestRequest = {
|
|
22
45
|
/**
|
|
23
|
-
* Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter
|
|
46
|
+
* Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter, returns all address types. Defaults to 'residential'.
|
|
24
47
|
*/
|
|
25
48
|
classification?: Classification | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* Geographic ranking mode (only applies when `lat` and `lng` are both supplied):
|
|
51
|
+
*
|
|
52
|
+
* @remarks
|
|
53
|
+
* - `bias` (default): soft preference. Still returns the best textual matches, but ranks results near the centre point higher.
|
|
54
|
+
* - `restrict`: hard cutoff. Only returns results within `radius_meters` of the centre point (requires `radius_meters`).
|
|
55
|
+
* Applies to address-source results.
|
|
56
|
+
*/
|
|
57
|
+
geoMode?: GeoMode | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* Latitude of a geographic centre point (WGS84 decimal degrees, -90 to 90). Must be supplied together with `lng`. Enables proximity-aware ranking of address results, most effective when combined with `source=address`.
|
|
60
|
+
*/
|
|
61
|
+
lat?: number | undefined;
|
|
26
62
|
/**
|
|
27
63
|
* Maximum number of results (1-100)
|
|
28
64
|
*/
|
|
29
65
|
limit?: string | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* Longitude of a geographic centre point (WGS84 decimal degrees, -180 to 180). Must be supplied together with `lat`.
|
|
68
|
+
*/
|
|
69
|
+
lng?: number | undefined;
|
|
30
70
|
/**
|
|
31
71
|
* Number of results to skip for pagination
|
|
32
72
|
*/
|
|
@@ -35,6 +75,10 @@ export type SearchSuggestRequest = {
|
|
|
35
75
|
* Search query
|
|
36
76
|
*/
|
|
37
77
|
q: string;
|
|
78
|
+
/**
|
|
79
|
+
* Radius in metres from (`lat`, `lng`). Required when `geo_mode=restrict` (results outside the radius are excluded). When `geo_mode=bias`, it tunes the strength of the soft preference: the distance at which a result's textual score is roughly halved, and defaults to 10000 when omitted.
|
|
80
|
+
*/
|
|
81
|
+
radiusMeters?: number | undefined;
|
|
38
82
|
/**
|
|
39
83
|
* Filter results to specific search source (address or location)
|
|
40
84
|
*/
|
|
@@ -46,12 +90,20 @@ export const Classification$outboundSchema: z.ZodNativeEnum<
|
|
|
46
90
|
typeof Classification
|
|
47
91
|
> = z.nativeEnum(Classification);
|
|
48
92
|
|
|
93
|
+
/** @internal */
|
|
94
|
+
export const GeoMode$outboundSchema: z.ZodNativeEnum<typeof GeoMode> = z
|
|
95
|
+
.nativeEnum(GeoMode);
|
|
96
|
+
|
|
49
97
|
/** @internal */
|
|
50
98
|
export type SearchSuggestRequest$Outbound = {
|
|
51
99
|
classification?: string | undefined;
|
|
100
|
+
geo_mode?: string | undefined;
|
|
101
|
+
lat?: number | undefined;
|
|
52
102
|
limit?: string | undefined;
|
|
103
|
+
lng?: number | undefined;
|
|
53
104
|
offset?: string | undefined;
|
|
54
105
|
q: string;
|
|
106
|
+
radius_meters?: number | undefined;
|
|
55
107
|
source?: string | undefined;
|
|
56
108
|
};
|
|
57
109
|
|
|
@@ -62,10 +114,19 @@ export const SearchSuggestRequest$outboundSchema: z.ZodType<
|
|
|
62
114
|
SearchSuggestRequest
|
|
63
115
|
> = z.object({
|
|
64
116
|
classification: Classification$outboundSchema.optional(),
|
|
117
|
+
geoMode: GeoMode$outboundSchema.optional(),
|
|
118
|
+
lat: z.number().optional(),
|
|
65
119
|
limit: z.string().optional(),
|
|
120
|
+
lng: z.number().optional(),
|
|
66
121
|
offset: z.string().optional(),
|
|
67
122
|
q: z.string(),
|
|
123
|
+
radiusMeters: z.number().int().optional(),
|
|
68
124
|
source: z.string().optional(),
|
|
125
|
+
}).transform((v) => {
|
|
126
|
+
return remap$(v, {
|
|
127
|
+
geoMode: "geo_mode",
|
|
128
|
+
radiusMeters: "radius_meters",
|
|
129
|
+
});
|
|
69
130
|
});
|
|
70
131
|
|
|
71
132
|
export function searchSuggestRequestToJSON(
|
|
@@ -217,6 +217,7 @@ export * from "./personsummary.js";
|
|
|
217
217
|
export * from "./planningagent.js";
|
|
218
218
|
export * from "./planningapplicant.js";
|
|
219
219
|
export * from "./planningapplication.js";
|
|
220
|
+
export * from "./planningclassificationreasoning.js";
|
|
220
221
|
export * from "./planningconsideration.js";
|
|
221
222
|
export * from "./planningconstraint.js";
|
|
222
223
|
export * from "./planningconsulteeresponse.js";
|
|
@@ -229,6 +230,7 @@ export * from "./planningdevelopmentextraction.js";
|
|
|
229
230
|
export * from "./planningdevelopmentextractionenvelope.js";
|
|
230
231
|
export * from "./planningdocument.js";
|
|
231
232
|
export * from "./planningextractioncoverage.js";
|
|
233
|
+
export * from "./planningimage.js";
|
|
232
234
|
export * from "./planninglistresponse.js";
|
|
233
235
|
export * from "./planningofficerassessmentextraction.js";
|
|
234
236
|
export * from "./planningofficerassessmentextractionenvelope.js";
|
|
@@ -242,6 +244,7 @@ export * from "./plannings106extractionenvelope.js";
|
|
|
242
244
|
export * from "./plannings106financialobligation.js";
|
|
243
245
|
export * from "./plannings106nonfinancialobligation.js";
|
|
244
246
|
export * from "./plannings106party.js";
|
|
247
|
+
export * from "./planningsemanticchunk.js";
|
|
245
248
|
export * from "./planningstatushistory.js";
|
|
246
249
|
export * from "./pointcategorystats.js";
|
|
247
250
|
export * from "./pointcategorystatslistresponse.js";
|
|
@@ -293,7 +296,13 @@ export * from "./salerecord.js";
|
|
|
293
296
|
export * from "./scale.js";
|
|
294
297
|
export * from "./schoolcatchmentblock.js";
|
|
295
298
|
export * from "./schoolframeworkcode.js";
|
|
299
|
+
export * from "./schoolinspectionevaluationarea.js";
|
|
300
|
+
export * from "./schoolinspectionevent.js";
|
|
301
|
+
export * from "./schoolinspectiongrade.js";
|
|
302
|
+
export * from "./schoolinspectionpredecessor.js";
|
|
303
|
+
export * from "./schoolinspectorbody.js";
|
|
296
304
|
export * from "./schoolmatchbasis.js";
|
|
305
|
+
export * from "./schooltrustmembership.js";
|
|
297
306
|
export * from "./searchhighlight.js";
|
|
298
307
|
export * from "./searchresponse.js";
|
|
299
308
|
export * from "./searchresult.js";
|
|
@@ -55,11 +55,11 @@ export type Pricing = {
|
|
|
55
55
|
*/
|
|
56
56
|
currency?: string | null | undefined;
|
|
57
57
|
/**
|
|
58
|
-
* Estimated price in
|
|
58
|
+
* Estimated price in GBP (whole pounds)
|
|
59
59
|
*/
|
|
60
60
|
estimated?: number | null | undefined;
|
|
61
61
|
/**
|
|
62
|
-
* Listed price in
|
|
62
|
+
* Listed price in GBP (whole pounds)
|
|
63
63
|
*/
|
|
64
64
|
price?: number | null | undefined;
|
|
65
65
|
};
|
|
@@ -24,7 +24,7 @@ export type Direction = OpenEnum<typeof Direction>;
|
|
|
24
24
|
|
|
25
25
|
export type ListingPriceChange = {
|
|
26
26
|
/**
|
|
27
|
-
* Amount of change in
|
|
27
|
+
* Amount of change in GBP (whole pounds)
|
|
28
28
|
*/
|
|
29
29
|
amount?: number | null | undefined;
|
|
30
30
|
/**
|
|
@@ -40,7 +40,7 @@ export type ListingPriceChange = {
|
|
|
40
40
|
*/
|
|
41
41
|
percent?: number | null | undefined;
|
|
42
42
|
/**
|
|
43
|
-
* New price after change in
|
|
43
|
+
* New price after change in GBP (whole pounds)
|
|
44
44
|
*/
|
|
45
45
|
price?: number | null | undefined;
|
|
46
46
|
};
|