@vepler/sdk 2.86.0 → 2.131.0

package/dist/esm/sdk/models/operations/getschoolbyid.js

@@ -2,13 +2,149 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import * as shared from "../shared/index.js";
+/**
+ * Latest published inspection rating. Native rating from the inspector body that issued it (England: Ofsted; Wales: Estyn; Scotland: Education Scotland; NI: ETI; IE: DES Inspectorate). Rating scales differ by inspector body — do not assume cross-body equivalence.
+ */
+export const CurrentRating = {
+    Outstanding: "outstanding",
+    Good: "good",
+    Satisfactory: "satisfactory",
+    Inadequate: "inadequate",
+    Exceptional: "exceptional",
+    StrongStandard: "strong_standard",
+    ExpectedStandard: "expected_standard",
+    NeedsAttention: "needs_attention",
+    UrgentImprovement: "urgent_improvement",
+    RequiresImprovement: "requires_improvement",
+    NotYetInspected: "not_yet_inspected",
+    Excellent: "excellent",
+    Adequate: "adequate",
+    Unsatisfactory: "unsatisfactory",
+    VeryGood: "very_good",
+    Weak: "weak",
+    ImportantAreaForImprovement: "important_area_for_improvement",
+    RequiresSignificantImprovement: "requires_significant_improvement",
+    Fair: "fair",
+};
+/**
+ * Object type discriminator. Always 'school' for school responses.
+ */
+export const GetSchoolByIdObject = {
+    School: "school",
+};
+/**
+ * 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.
+ */
+export const GetSchoolByIdProvider = {
+    Dfe: "dfe",
+    Welshgov: "welshgov",
+    Seed: "seed",
+    Deni: "deni",
+    DeptEduIe: "dept_edu_ie",
+};
+/**
+ * Operational status of the school (sourced from official registers e.g. DfE GIAS for England). 'open': actively operating. 'closed': permanently closed. 'pending_closure': scheduled to close — still operational but may not be admitting new pupils. Most consumers should filter on 'open'.
+ */
+export const GetSchoolByIdStatus = {
+    Open: "open",
+    Closed: "closed",
+    PendingClosure: "pending_closure",
+};
+/**
+ * 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.
+ */
+export const GetSchoolByIdType = {
+    Nursery: "nursery",
+    Primary: "primary",
+    Secondary: "secondary",
+    AllThrough: "all-through",
+    SixthForm: "sixth-form",
+    Special: "special",
+    Independent: "independent",
+    Academy: "academy",
+    Other: "other",
+};
 /** @internal */
 export const GetSchoolByIdRequest$outboundSchema = z.object({
-    expand: z.string().optional(),
-    fields: z.string().optional(),
     id: z.string(),
 });
 export function getSchoolByIdRequestToJSON(getSchoolByIdRequest) {
     return JSON.stringify(GetSchoolByIdRequest$outboundSchema.parse(getSchoolByIdRequest));
 }
+/** @internal */
+export const GetSchoolByIdAddress$inboundSchema = z.object({
+    county: z.string().optional(),
+    locality: z.string().optional(),
+    postcode: z.string().optional(),
+    street: z.string().optional(),
+    town: z.string().optional(),
+});
+export function getSchoolByIdAddressFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolByIdAddress$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolByIdAddress' from JSON`);
+}
+/** @internal */
+export const CurrentRating$inboundSchema = openEnums.inboundSchema(CurrentRating);
+/** @internal */
+export const Location$inboundSchema = z.object({
+    lat: z.number(),
+    lng: z.number(),
+});
+export function locationFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Location$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Location' from JSON`);
+}
+/** @internal */
+export const GetSchoolByIdObject$inboundSchema = z.nativeEnum(GetSchoolByIdObject);
+/** @internal */
+export const GetSchoolByIdProvider$inboundSchema = openEnums.inboundSchema(GetSchoolByIdProvider);
+/** @internal */
+export const GetSchoolByIdStatus$inboundSchema = openEnums.inboundSchema(GetSchoolByIdStatus);
+/** @internal */
+export const GetSchoolByIdType$inboundSchema = openEnums.inboundSchema(GetSchoolByIdType);
+/** @internal */
+export const GetSchoolByIdResponseBody$inboundSchema = z.object({
+    address: z.lazy(() => GetSchoolByIdAddress$inboundSchema).optional(),
+    admissionsPolicy: z.string().optional(),
+    ageRange: z.string().optional(),
+    capacity: z.number().int().optional(),
+    catchment: shared.SchoolCatchmentBlock$inboundSchema.optional(),
+    country: z.string().default("GB"),
+    createdAt: z.string(),
+    currentRating: z.nullable(CurrentRating$inboundSchema).optional(),
+    distance: z.number().optional(),
+    establishmentNumber: z.number().int().optional(),
+    gender: z.string().optional(),
+    headteacher: z.string().optional(),
+    id: z.number().int(),
+    key: z.string(),
+    laCode: z.string().optional(),
+    laName: z.string().optional(),
+    lastInspectionDate: z.string().optional(),
+    lastUpdated: z.string(),
+    location: z.nullable(z.lazy(() => Location$inboundSchema)).optional(),
+    lsoaCode: z.nullable(z.string()).optional(),
+    name: z.string(),
+    numberOfPupils: z.number().int().optional(),
+    object: GetSchoolByIdObject$inboundSchema,
+    phase: z.string().optional(),
+    provider: GetSchoolByIdProvider$inboundSchema,
+    region: z.string(),
+    religiousCharacter: z.string().optional(),
+    slug: z.nullable(z.string()).optional(),
+    specialClasses: z.string().optional(),
+    specialistResource: z.string().optional(),
+    status: GetSchoolByIdStatus$inboundSchema,
+    subType: z.string().optional(),
+    telephone: z.string().optional(),
+    trustId: z.string().optional(),
+    trustName: z.string().optional(),
+    type: GetSchoolByIdType$inboundSchema,
+    updatedAt: z.string(),
+    website: z.string().optional(),
+});
+export function getSchoolByIdResponseBodyFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolByIdResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolByIdResponseBody' from JSON`);
+}
 //# sourceMappingURL=getschoolbyid.js.map

package/dist/esm/sdk/models/operations/getschoolbyid.js.map

@@ -1 +1 @@
-{"version":3,"file":"getschoolbyid.js","sourceRoot":"","sources":["../../../../../src/sdk/models/operations/getschoolbyid.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAwB5B,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAI5C,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;CACf,CAAC,CAAC;AAEH,MAAM,UAAU,0BAA0B,CACxC,oBAA0C;IAE1C,OAAO,IAAI,CAAC,SAAS,CACnB,mCAAmC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAChE,CAAC;AACJ,CAAC"}
+{"version":3,"file":"getschoolbyid.js","sourceRoot":"","sources":["../../../../../src/sdk/models/operations/getschoolbyid.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAIlD,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAmC7C;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,WAAW,EAAE,aAAa;IAC1B,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;IACxB,WAAW,EAAE,aAAa;IAC1B,cAAc,EAAE,iBAAiB;IACjC,gBAAgB,EAAE,mBAAmB;IACrC,cAAc,EAAE,iBAAiB;IACjC,iBAAiB,EAAE,oBAAoB;IACvC,mBAAmB,EAAE,sBAAsB;IAC3C,eAAe,EAAE,mBAAmB;IACpC,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,gBAAgB;IAChC,QAAQ,EAAE,WAAW;IACrB,IAAI,EAAE,MAAM;IACZ,2BAA2B,EAAE,gCAAgC;IAC7D,8BAA8B,EAAE,kCAAkC;IAClE,IAAI,EAAE,MAAM;CACJ,CAAC;AAoBX;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,QAAQ;CACR,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,GAAG,EAAE,KAAK;IACV,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,aAAa;CAChB,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,cAAc,EAAE,iBAAiB;CACzB,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,UAAU,EAAE,aAAa;IACzB,SAAS,EAAE,YAAY;IACvB,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;IAC1B,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;CACN,CAAC;AAsHX,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAI5C,CAAC,CAAC,MAAM,CAAC;IACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;CACf,CAAC,CAAC;AAEH,MAAM,UAAU,0BAA0B,CACxC,oBAA0C;IAE1C,OAAO,IAAI,CAAC,SAAS,CACnB,mCAAmC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAChE,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,kCAAkC,GAI3C,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAEH,MAAM,UAAU,4BAA4B,CAC1C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,kCAAkC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC9D,kDAAkD,CACnD,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,2BAA2B,GAIpC,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;AAE3C,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAI/B,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,MAAM,UAAU,gBAAgB,CAC9B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClD,sCAAsC,CACvC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAE1C,CAAC,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAEtC,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAI5C,SAAS,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEnD,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,SAAS,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;AAEjD,gBAAgB;AAChB,MAAM,CAAC,MAAM,+BAA+B,GAIxC,SAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC;AAE/C,gBAAgB;AAChB,MAAM,CAAC,MAAM,uCAAuC,GAIhD,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,kCAAkC,CAAC,CAAC,QAAQ,EAAE;IACpE,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACrC,SAAS,EAAE,MAAM,CAAC,kCAAkC,CAAC,QAAQ,EAAE;IAC/D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IACjC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,2BAA2B,CAAC,CAAC,QAAQ,EAAE;IACjE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAChD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACpB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,sBAAsB,CAAC,CAAC,CAAC,QAAQ,EAAE;IACrE,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC3C,MAAM,EAAE,iCAAiC;IACzC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,QAAQ,EAAE,mCAAmC;IAC7C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,MAAM,EAAE,iCAAiC;IACzC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,IAAI,EAAE,+BAA+B;IACrC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEH,MAAM,UAAU,iCAAiC,CAC/C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,uCAAuC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnE,uDAAuD,CACxD,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/operations/getschoolbysource.d.ts

@@ -0,0 +1,285 @@
+import * as z from "zod/v3";
+import { ClosedEnum, OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as shared from "../shared/index.js";
+/**
+ * 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.
+ */
+export declare const PathParamProvider: {
+    readonly Dfe: "dfe";
+    readonly Welshgov: "welshgov";
+    readonly Seed: "seed";
+    readonly Deni: "deni";
+    readonly DeptEduIe: "dept_edu_ie";
+};
+/**
+ * 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.
+ */
+export type PathParamProvider = ClosedEnum<typeof PathParamProvider>;
+export type GetSchoolBySourceRequest = {
+    /**
+     * Provider-scoped identifier (URN for dfe, SEED for seed, …)
+     */
+    key: string;
+    /**
+     * 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.
+     */
+    provider: PathParamProvider;
+};
+/**
+ * Postal address of the school
+ */
+export type GetSchoolBySourceAddress = {
+    /**
+     * County or region
+     */
+    county?: string | undefined;
+    /**
+     * Locality / district
+     */
+    locality?: string | undefined;
+    /**
+     * Postcode (UK / Eircode / etc — country-specific format)
+     */
+    postcode?: string | undefined;
+    /**
+     * Street and number
+     */
+    street?: string | undefined;
+    /**
+     * Town or city
+     */
+    town?: string | undefined;
+};
+/**
+ * Latest published inspection rating. Native rating from the inspector body that issued it (England: Ofsted; Wales: Estyn; Scotland: Education Scotland; NI: ETI; IE: DES Inspectorate). Rating scales differ by inspector body — do not assume cross-body equivalence.
+ */
+export declare const GetSchoolBySourceCurrentRating: {
+    readonly Outstanding: "outstanding";
+    readonly Good: "good";
+    readonly Satisfactory: "satisfactory";
+    readonly Inadequate: "inadequate";
+    readonly Exceptional: "exceptional";
+    readonly StrongStandard: "strong_standard";
+    readonly ExpectedStandard: "expected_standard";
+    readonly NeedsAttention: "needs_attention";
+    readonly UrgentImprovement: "urgent_improvement";
+    readonly RequiresImprovement: "requires_improvement";
+    readonly NotYetInspected: "not_yet_inspected";
+    readonly Excellent: "excellent";
+    readonly Adequate: "adequate";
+    readonly Unsatisfactory: "unsatisfactory";
+    readonly VeryGood: "very_good";
+    readonly Weak: "weak";
+    readonly ImportantAreaForImprovement: "important_area_for_improvement";
+    readonly RequiresSignificantImprovement: "requires_significant_improvement";
+    readonly Fair: "fair";
+};
+/**
+ * Latest published inspection rating. Native rating from the inspector body that issued it (England: Ofsted; Wales: Estyn; Scotland: Education Scotland; NI: ETI; IE: DES Inspectorate). Rating scales differ by inspector body — do not assume cross-body equivalence.
+ */
+export type GetSchoolBySourceCurrentRating = OpenEnum<typeof GetSchoolBySourceCurrentRating>;
+/**
+ * Geographic coordinates of the school
+ */
+export type GetSchoolBySourceLocation = {
+    /**
+     * WGS84 latitude in decimal degrees
+     */
+    lat: number;
+    /**
+     * WGS84 longitude in decimal degrees
+     */
+    lng: number;
+};
+/**
+ * Object type discriminator. Always 'school' for school responses.
+ */
+export declare const GetSchoolBySourceObject: {
+    readonly School: "school";
+};
+/**
+ * Object type discriminator. Always 'school' for school responses.
+ */
+export type GetSchoolBySourceObject = ClosedEnum<typeof GetSchoolBySourceObject>;
+/**
+ * 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.
+ */
+export declare const GetSchoolBySourceProvider: {
+    readonly Dfe: "dfe";
+    readonly Welshgov: "welshgov";
+    readonly Seed: "seed";
+    readonly Deni: "deni";
+    readonly DeptEduIe: "dept_edu_ie";
+};
+/**
+ * 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.
+ */
+export type GetSchoolBySourceProvider = OpenEnum<typeof GetSchoolBySourceProvider>;
+/**
+ * Operational status of the school (sourced from official registers e.g. DfE GIAS for England). 'open': actively operating. 'closed': permanently closed. 'pending_closure': scheduled to close — still operational but may not be admitting new pupils. Most consumers should filter on 'open'.
+ */
+export declare const GetSchoolBySourceStatus: {
+    readonly Open: "open";
+    readonly Closed: "closed";
+    readonly PendingClosure: "pending_closure";
+};
+/**
+ * Operational status of the school (sourced from official registers e.g. DfE GIAS for England). 'open': actively operating. 'closed': permanently closed. 'pending_closure': scheduled to close — still operational but may not be admitting new pupils. Most consumers should filter on 'open'.
+ */
+export type GetSchoolBySourceStatus = OpenEnum<typeof GetSchoolBySourceStatus>;
+/**
+ * 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.
+ */
+export declare const GetSchoolBySourceType: {
+    readonly Nursery: "nursery";
+    readonly Primary: "primary";
+    readonly Secondary: "secondary";
+    readonly AllThrough: "all-through";
+    readonly SixthForm: "sixth-form";
+    readonly Special: "special";
+    readonly Independent: "independent";
+    readonly Academy: "academy";
+    readonly Other: "other";
+};
+/**
+ * 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.
+ */
+export type GetSchoolBySourceType = OpenEnum<typeof GetSchoolBySourceType>;
+/**
+ * Single school response
+ */
+export type GetSchoolBySourceResponseBody = {
+    /**
+     * Postal address of the school
+     */
+    address?: GetSchoolBySourceAddress | undefined;
+    admissionsPolicy?: string | undefined;
+    ageRange?: string | undefined;
+    capacity?: number | undefined;
+    /**
+     * Catchment match block. Present only when the request included `catchmentReference`. `matchBasis` is empty when the school is only in range (Tier 5 distance fallback); `verdict` is always populated.
+     */
+    catchment?: shared.SchoolCatchmentBlock | undefined;
+    /**
+     * ISO 3166-1 alpha-2 country code
+     */
+    country: string;
+    /**
+     * ISO 8601 datetime when this record was first created
+     */
+    createdAt: string;
+    /**
+     * Latest published inspection rating. Native rating from the inspector body that issued it (England: Ofsted; Wales: Estyn; Scotland: Education Scotland; NI: ETI; IE: DES Inspectorate). Rating scales differ by inspector body — do not assume cross-body equivalence.
+     */
+    currentRating?: GetSchoolBySourceCurrentRating | null | undefined;
+    /**
+     * Distance from search point in metres (only present when searching by `near`)
+     */
+    distance?: number | undefined;
+    establishmentNumber?: number | undefined;
+    gender?: string | undefined;
+    headteacher?: string | undefined;
+    /**
+     * System-generated identifier. Stable across updates.
+     */
+    id: number;
+    /**
+     * Provider-scoped identifier. URN for `dfe`, SEED for `seed`, etc. Combined with `provider` this is a globally unique alternate key for the school.
+     */
+    key: string;
+    laCode?: string | undefined;
+    laName?: string | undefined;
+    /**
+     * ISO 8601 date of the most recent inspection
+     */
+    lastInspectionDate?: string | undefined;
+    /**
+     * ISO 8601 datetime of the most recent source-data refresh
+     */
+    lastUpdated: string;
+    /**
+     * Geographic coordinates of the school
+     */
+    location?: GetSchoolBySourceLocation | null | undefined;
+    /**
+     * Lower Layer Super Output Area code (2021 ONS Census, England + Wales). Use to join with Area Reference / Safety / Prosperity APIs. Null for non-UK or unmapped schools.
+     */
+    lsoaCode?: string | null | undefined;
+    /**
+     * Official school name
+     */
+    name: string;
+    numberOfPupils?: number | undefined;
+    /**
+     * Object type discriminator. Always 'school' for school responses.
+     */
+    object: GetSchoolBySourceObject;
+    phase?: string | undefined;
+    /**
+     * 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.
+     */
+    provider: GetSchoolBySourceProvider;
+    /**
+     * ISO 3166-2 region code identifying the education-system jurisdiction. GB-ENG (England), GB-WLS (Wales), GB-SCT (Scotland), GB-NIR (Northern Ireland), IE (Ireland), …
+     */
+    region: string;
+    religiousCharacter?: string | undefined;
+    /**
+     * URL-friendly slug derived from the school name
+     */
+    slug?: string | null | undefined;
+    specialClasses?: string | undefined;
+    specialistResource?: string | undefined;
+    /**
+     * Operational status of the school (sourced from official registers e.g. DfE GIAS for England). 'open': actively operating. 'closed': permanently closed. 'pending_closure': scheduled to close — still operational but may not be admitting new pupils. Most consumers should filter on 'open'.
+     */
+    status: GetSchoolBySourceStatus;
+    /**
+     * Provider sub-type (e.g. 'Voluntary Aided School', 'Academy Converter')
+     */
+    subType?: string | undefined;
+    telephone?: string | undefined;
+    trustId?: string | undefined;
+    trustName?: string | undefined;
+    /**
+     * 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.
+     */
+    type: GetSchoolBySourceType;
+    /**
+     * ISO 8601 datetime of the most recent update to this record
+     */
+    updatedAt: string;
+    website?: string | undefined;
+};
+/** @internal */
+export declare const PathParamProvider$outboundSchema: z.ZodNativeEnum<typeof PathParamProvider>;
+/** @internal */
+export type GetSchoolBySourceRequest$Outbound = {
+    key: string;
+    provider: string;
+};
+/** @internal */
+export declare const GetSchoolBySourceRequest$outboundSchema: z.ZodType<GetSchoolBySourceRequest$Outbound, z.ZodTypeDef, GetSchoolBySourceRequest>;
+export declare function getSchoolBySourceRequestToJSON(getSchoolBySourceRequest: GetSchoolBySourceRequest): string;
+/** @internal */
+export declare const GetSchoolBySourceAddress$inboundSchema: z.ZodType<GetSchoolBySourceAddress, z.ZodTypeDef, unknown>;
+export declare function getSchoolBySourceAddressFromJSON(jsonString: string): SafeParseResult<GetSchoolBySourceAddress, SDKValidationError>;
+/** @internal */
+export declare const GetSchoolBySourceCurrentRating$inboundSchema: z.ZodType<GetSchoolBySourceCurrentRating, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const GetSchoolBySourceLocation$inboundSchema: z.ZodType<GetSchoolBySourceLocation, z.ZodTypeDef, unknown>;
+export declare function getSchoolBySourceLocationFromJSON(jsonString: string): SafeParseResult<GetSchoolBySourceLocation, SDKValidationError>;
+/** @internal */
+export declare const GetSchoolBySourceObject$inboundSchema: z.ZodNativeEnum<typeof GetSchoolBySourceObject>;
+/** @internal */
+export declare const GetSchoolBySourceProvider$inboundSchema: z.ZodType<GetSchoolBySourceProvider, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const GetSchoolBySourceStatus$inboundSchema: z.ZodType<GetSchoolBySourceStatus, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const GetSchoolBySourceType$inboundSchema: z.ZodType<GetSchoolBySourceType, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const GetSchoolBySourceResponseBody$inboundSchema: z.ZodType<GetSchoolBySourceResponseBody, z.ZodTypeDef, unknown>;
+export declare function getSchoolBySourceResponseBodyFromJSON(jsonString: string): SafeParseResult<GetSchoolBySourceResponseBody, SDKValidationError>;
+//# sourceMappingURL=getschoolbysource.d.ts.map

package/dist/esm/sdk/models/operations/getschoolbysource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getschoolbysource.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/operations/getschoolbysource.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;CAMpB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAErE,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,QAAQ,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;CAoBjC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,QAAQ,CACnD,OAAO,8BAA8B,CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;CAE1B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAC9C,OAAO,uBAAuB,CAC/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;CAM5B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAC9C,OAAO,yBAAyB,CACjC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;CAI1B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,QAAQ,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAE/E;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;CAUxB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,QAAQ,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;IAC/C,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,SAAS,CAAC;IACpD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,8BAA8B,GAAG,IAAI,GAAG,SAAS,CAAC;IAClE;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,yBAAyB,GAAG,IAAI,GAAG,SAAS,CAAC;IACxD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,MAAM,EAAE,uBAAuB,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,QAAQ,EAAE,yBAAyB,CAAC;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,MAAM,EAAE,uBAAuB,CAAC;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,aAAa,CAC5D,OAAO,iBAAiB,CACS,CAAC;AAEpC,gBAAgB;AAChB,MAAM,MAAM,iCAAiC,GAAG;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,wBAAwB,CAIxB,CAAC;AAEH,wBAAgB,8BAA8B,CAC5C,wBAAwB,EAAE,wBAAwB,GACjD,MAAM,CAIR;AAED,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D;AAED,gBAAgB;AAChB,eAAO,MAAM,4CAA4C,EAAE,CAAC,CAAC,OAAO,CAClE,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,OAAO,CACkD,CAAC;AAE5D,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,yBAAyB,EACzB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,iCAAiC,CAC/C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,CAMhE;AAED,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,aAAa,CACjE,OAAO,uBAAuB,CACS,CAAC;AAE1C,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,yBAAyB,EACzB,CAAC,CAAC,UAAU,EACZ,OAAO,CAC6C,CAAC;AAEvD,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,uBAAuB,EACvB,CAAC,CAAC,UAAU,EACZ,OAAO,CAC2C,CAAC;AAErD,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,EAAE,CAAC,CAAC,OAAO,CACzD,qBAAqB,EACrB,CAAC,CAAC,UAAU,EACZ,OAAO,CACyC,CAAC;AAEnD,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,OAAO,CACjE,6BAA6B,EAC7B,CAAC,CAAC,UAAU,EACZ,OAAO,CA0CP,CAAC;AAEH,wBAAgB,qCAAqC,CACnD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,6BAA6B,EAAE,kBAAkB,CAAC,CAMpE"}

package/dist/esm/sdk/models/operations/getschoolbysource.js

@@ -0,0 +1,165 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import * as shared from "../shared/index.js";
+/**
+ * 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.
+ */
+export const PathParamProvider = {
+    Dfe: "dfe",
+    Welshgov: "welshgov",
+    Seed: "seed",
+    Deni: "deni",
+    DeptEduIe: "dept_edu_ie",
+};
+/**
+ * Latest published inspection rating. Native rating from the inspector body that issued it (England: Ofsted; Wales: Estyn; Scotland: Education Scotland; NI: ETI; IE: DES Inspectorate). Rating scales differ by inspector body — do not assume cross-body equivalence.
+ */
+export const GetSchoolBySourceCurrentRating = {
+    Outstanding: "outstanding",
+    Good: "good",
+    Satisfactory: "satisfactory",
+    Inadequate: "inadequate",
+    Exceptional: "exceptional",
+    StrongStandard: "strong_standard",
+    ExpectedStandard: "expected_standard",
+    NeedsAttention: "needs_attention",
+    UrgentImprovement: "urgent_improvement",
+    RequiresImprovement: "requires_improvement",
+    NotYetInspected: "not_yet_inspected",
+    Excellent: "excellent",
+    Adequate: "adequate",
+    Unsatisfactory: "unsatisfactory",
+    VeryGood: "very_good",
+    Weak: "weak",
+    ImportantAreaForImprovement: "important_area_for_improvement",
+    RequiresSignificantImprovement: "requires_significant_improvement",
+    Fair: "fair",
+};
+/**
+ * Object type discriminator. Always 'school' for school responses.
+ */
+export const GetSchoolBySourceObject = {
+    School: "school",
+};
+/**
+ * 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.
+ */
+export const GetSchoolBySourceProvider = {
+    Dfe: "dfe",
+    Welshgov: "welshgov",
+    Seed: "seed",
+    Deni: "deni",
+    DeptEduIe: "dept_edu_ie",
+};
+/**
+ * Operational status of the school (sourced from official registers e.g. DfE GIAS for England). 'open': actively operating. 'closed': permanently closed. 'pending_closure': scheduled to close — still operational but may not be admitting new pupils. Most consumers should filter on 'open'.
+ */
+export const GetSchoolBySourceStatus = {
+    Open: "open",
+    Closed: "closed",
+    PendingClosure: "pending_closure",
+};
+/**
+ * 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.
+ */
+export const GetSchoolBySourceType = {
+    Nursery: "nursery",
+    Primary: "primary",
+    Secondary: "secondary",
+    AllThrough: "all-through",
+    SixthForm: "sixth-form",
+    Special: "special",
+    Independent: "independent",
+    Academy: "academy",
+    Other: "other",
+};
+/** @internal */
+export const PathParamProvider$outboundSchema = z.nativeEnum(PathParamProvider);
+/** @internal */
+export const GetSchoolBySourceRequest$outboundSchema = z.object({
+    key: z.string(),
+    provider: PathParamProvider$outboundSchema,
+});
+export function getSchoolBySourceRequestToJSON(getSchoolBySourceRequest) {
+    return JSON.stringify(GetSchoolBySourceRequest$outboundSchema.parse(getSchoolBySourceRequest));
+}
+/** @internal */
+export const GetSchoolBySourceAddress$inboundSchema = z.object({
+    county: z.string().optional(),
+    locality: z.string().optional(),
+    postcode: z.string().optional(),
+    street: z.string().optional(),
+    town: z.string().optional(),
+});
+export function getSchoolBySourceAddressFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolBySourceAddress$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolBySourceAddress' from JSON`);
+}
+/** @internal */
+export const GetSchoolBySourceCurrentRating$inboundSchema = openEnums.inboundSchema(GetSchoolBySourceCurrentRating);
+/** @internal */
+export const GetSchoolBySourceLocation$inboundSchema = z.object({
+    lat: z.number(),
+    lng: z.number(),
+});
+export function getSchoolBySourceLocationFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolBySourceLocation$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolBySourceLocation' from JSON`);
+}
+/** @internal */
+export const GetSchoolBySourceObject$inboundSchema = z.nativeEnum(GetSchoolBySourceObject);
+/** @internal */
+export const GetSchoolBySourceProvider$inboundSchema = openEnums.inboundSchema(GetSchoolBySourceProvider);
+/** @internal */
+export const GetSchoolBySourceStatus$inboundSchema = openEnums.inboundSchema(GetSchoolBySourceStatus);
+/** @internal */
+export const GetSchoolBySourceType$inboundSchema = openEnums.inboundSchema(GetSchoolBySourceType);
+/** @internal */
+export const GetSchoolBySourceResponseBody$inboundSchema = z.object({
+    address: z.lazy(() => GetSchoolBySourceAddress$inboundSchema).optional(),
+    admissionsPolicy: z.string().optional(),
+    ageRange: z.string().optional(),
+    capacity: z.number().int().optional(),
+    catchment: shared.SchoolCatchmentBlock$inboundSchema.optional(),
+    country: z.string().default("GB"),
+    createdAt: z.string(),
+    currentRating: z.nullable(GetSchoolBySourceCurrentRating$inboundSchema)
+        .optional(),
+    distance: z.number().optional(),
+    establishmentNumber: z.number().int().optional(),
+    gender: z.string().optional(),
+    headteacher: z.string().optional(),
+    id: z.number().int(),
+    key: z.string(),
+    laCode: z.string().optional(),
+    laName: z.string().optional(),
+    lastInspectionDate: z.string().optional(),
+    lastUpdated: z.string(),
+    location: z.nullable(z.lazy(() => GetSchoolBySourceLocation$inboundSchema))
+        .optional(),
+    lsoaCode: z.nullable(z.string()).optional(),
+    name: z.string(),
+    numberOfPupils: z.number().int().optional(),
+    object: GetSchoolBySourceObject$inboundSchema,
+    phase: z.string().optional(),
+    provider: GetSchoolBySourceProvider$inboundSchema,
+    region: z.string(),
+    religiousCharacter: z.string().optional(),
+    slug: z.nullable(z.string()).optional(),
+    specialClasses: z.string().optional(),
+    specialistResource: z.string().optional(),
+    status: GetSchoolBySourceStatus$inboundSchema,
+    subType: z.string().optional(),
+    telephone: z.string().optional(),
+    trustId: z.string().optional(),
+    trustName: z.string().optional(),
+    type: GetSchoolBySourceType$inboundSchema,
+    updatedAt: z.string(),
+    website: z.string().optional(),
+});
+export function getSchoolBySourceResponseBodyFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolBySourceResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolBySourceResponseBody' from JSON`);
+}
+//# sourceMappingURL=getschoolbysource.js.map

package/dist/esm/sdk/models/operations/getschoolbysource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getschoolbysource.js","sourceRoot":"","sources":["../../../../../src/sdk/models/operations/getschoolbysource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAIlD,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAE7C;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,GAAG,EAAE,KAAK;IACV,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,aAAa;CAChB,CAAC;AA2CX;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG;IAC5C,WAAW,EAAE,aAAa;IAC1B,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;IACxB,WAAW,EAAE,aAAa;IAC1B,cAAc,EAAE,iBAAiB;IACjC,gBAAgB,EAAE,mBAAmB;IACrC,cAAc,EAAE,iBAAiB;IACjC,iBAAiB,EAAE,oBAAoB;IACvC,mBAAmB,EAAE,sBAAsB;IAC3C,eAAe,EAAE,mBAAmB;IACpC,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,gBAAgB;IAChC,QAAQ,EAAE,WAAW;IACrB,IAAI,EAAE,MAAM;IACZ,2BAA2B,EAAE,gCAAgC;IAC7D,8BAA8B,EAAE,kCAAkC;IAClE,IAAI,EAAE,MAAM;CACJ,CAAC;AAsBX;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,MAAM,EAAE,QAAQ;CACR,CAAC;AAQX;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,GAAG,EAAE,KAAK;IACV,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,aAAa;CAChB,CAAC;AAQX;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,cAAc,EAAE,iBAAiB;CACzB,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,UAAU,EAAE,aAAa;IACzB,SAAS,EAAE,YAAY;IACvB,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;IAC1B,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;CACN,CAAC;AAiHX,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAEzC,CAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;AAQpC,gBAAgB;AAChB,MAAM,CAAC,MAAM,uCAAuC,GAIhD,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,QAAQ,EAAE,gCAAgC;CAC3C,CAAC,CAAC;AAEH,MAAM,UAAU,8BAA8B,CAC5C,wBAAkD;IAElD,OAAO,IAAI,CAAC,SAAS,CACnB,uCAAuC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CACxE,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,sCAAsC,GAI/C,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAEH,MAAM,UAAU,gCAAgC,CAC9C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sCAAsC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClE,sDAAsD,CACvD,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,4CAA4C,GAIrD,SAAS,CAAC,aAAa,CAAC,8BAA8B,CAAC,CAAC;AAE5D,gBAAgB;AAChB,MAAM,CAAC,MAAM,uCAAuC,GAIhD,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,MAAM,UAAU,iCAAiC,CAC/C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,uCAAuC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnE,uDAAuD,CACxD,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAE9C,CAAC,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAE1C,gBAAgB;AAChB,MAAM,CAAC,MAAM,uCAAuC,GAIhD,SAAS,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;AAEvD,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAI9C,SAAS,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;AAErD,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAI5C,SAAS,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEnD,gBAAgB;AAChB,MAAM,CAAC,MAAM,2CAA2C,GAIpD,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,sCAAsC,CAAC,CAAC,QAAQ,EAAE;IACxE,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACrC,SAAS,EAAE,MAAM,CAAC,kCAAkC,CAAC,QAAQ,EAAE;IAC/D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IACjC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,4CAA4C,CAAC;SACpE,QAAQ,EAAE;IACb,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAChD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACpB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,uCAAuC,CAAC,CAAC;SACxE,QAAQ,EAAE;IACb,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC3C,MAAM,EAAE,qCAAqC;IAC7C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,QAAQ,EAAE,uCAAuC;IACjD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,MAAM,EAAE,qCAAqC;IAC7C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,IAAI,EAAE,mCAAmC;IACzC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEH,MAAM,UAAU,qCAAqC,CACnD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,2CAA2C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvE,2DAA2D,CAC5D,CAAC;AACJ,CAAC"}