@vepler/sdk 2.145.1 → 2.151.0

package/dist/esm/sdk/models/shared/schoolinspectionevent.d.ts

@@ -0,0 +1,103 @@
+import * as z from "zod/v3";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { SchoolInspectionEvaluationArea } from "./schoolinspectionevaluationarea.js";
+import { SchoolInspectionGrade } from "./schoolinspectiongrade.js";
+import { SchoolInspectionPredecessor } from "./schoolinspectionpredecessor.js";
+import { SchoolInspectorBody } from "./schoolinspectorbody.js";
+/**
+ * The inspectorate's own native overall grade. Not cross-body comparable.
+ */
+export declare const SchoolInspectionEventRating: {
+    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";
+};
+/**
+ * The inspectorate's own native overall grade. Not cross-body comparable.
+ */
+export type SchoolInspectionEventRating = OpenEnum<typeof SchoolInspectionEventRating>;
+/**
+ * OEIF 1-4 sub-judgements (graded pre-2025 inspections).
+ */
+export type Ratings = {
+    behaviourAndAttitudes?: SchoolInspectionGrade | null | undefined;
+    earlyYearsProvision?: SchoolInspectionGrade | null | undefined;
+    leadershipAndManagement?: SchoolInspectionGrade | null | undefined;
+    overallEffectiveness?: SchoolInspectionGrade | null | undefined;
+    personalDevelopment?: SchoolInspectionGrade | null | undefined;
+    qualityOfEducation?: SchoolInspectionGrade | null | undefined;
+    sixthFormProvision?: SchoolInspectionGrade | null | undefined;
+};
+/**
+ * Most recent inspection event, or null if never inspected.
+ */
+export type SchoolInspectionEvent = {
+    /**
+     * Statutory category of concern (e.g. 'Special measures'), where applicable.
+     */
+    categoryOfConcern?: string | null | undefined;
+    /**
+     * Post-2025 Ofsted evaluation-area grades.
+     */
+    evaluationAreas?: Array<SchoolInspectionEvaluationArea> | null | undefined;
+    /**
+     * Framework variant, e.g. 'post_2025' | 'oeif' | 'ungraded_only'.
+     */
+    framework?: string | null | undefined;
+    /**
+     * ISO date of the inspection.
+     */
+    inspectionDate: string;
+    /**
+     * Inspection type as published by the inspectorate.
+     */
+    inspectionType?: string | null | undefined;
+    /**
+     * Inspectorate that issued the rating. ofsted (England), estyn (Wales), education_scotland (Scotland), eti (Northern Ireland), des (Ireland).
+     */
+    inspectorBody: SchoolInspectorBody;
+    predecessor?: SchoolInspectionPredecessor | null | undefined;
+    /**
+     * ISO date the report was published, where known.
+     */
+    publicationDate?: string | null | undefined;
+    /**
+     * The inspectorate's own native overall grade. Not cross-body comparable.
+     */
+    rating: SchoolInspectionEventRating;
+    /**
+     * OEIF 1-4 sub-judgements (graded pre-2025 inspections).
+     */
+    ratings?: Ratings | null | undefined;
+    /**
+     * Canonical link to the published inspection report on the inspectorate's site.
+     */
+    reportUrl?: string | null | undefined;
+};
+/** @internal */
+export declare const SchoolInspectionEventRating$inboundSchema: z.ZodType<SchoolInspectionEventRating, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const Ratings$inboundSchema: z.ZodType<Ratings, z.ZodTypeDef, unknown>;
+export declare function ratingsFromJSON(jsonString: string): SafeParseResult<Ratings, SDKValidationError>;
+/** @internal */
+export declare const SchoolInspectionEvent$inboundSchema: z.ZodType<SchoolInspectionEvent, z.ZodTypeDef, unknown>;
+export declare function schoolInspectionEventFromJSON(jsonString: string): SafeParseResult<SchoolInspectionEvent, SDKValidationError>;
+//# sourceMappingURL=schoolinspectionevent.d.ts.map

package/dist/esm/sdk/models/shared/schoolinspectionevent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolinspectionevent.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolinspectionevent.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,8BAA8B,EAE/B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACL,qBAAqB,EAEtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,2BAA2B,EAE5B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,mBAAmB,EAEpB,MAAM,0BAA0B,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;CAoB9B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,QAAQ,CAChD,OAAO,2BAA2B,CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,qBAAqB,CAAC,EAAE,qBAAqB,GAAG,IAAI,GAAG,SAAS,CAAC;IACjE,mBAAmB,CAAC,EAAE,qBAAqB,GAAG,IAAI,GAAG,SAAS,CAAC;IAC/D,uBAAuB,CAAC,EAAE,qBAAqB,GAAG,IAAI,GAAG,SAAS,CAAC;IACnE,oBAAoB,CAAC,EAAE,qBAAqB,GAAG,IAAI,GAAG,SAAS,CAAC;IAChE,mBAAmB,CAAC,EAAE,qBAAqB,GAAG,IAAI,GAAG,SAAS,CAAC;IAC/D,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,IAAI,GAAG,SAAS,CAAC;IAC9D,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,IAAI,GAAG,SAAS,CAAC;CAC/D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC9C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IAC3E;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,aAAa,EAAE,mBAAmB,CAAC;IACnC,WAAW,CAAC,EAAE,2BAA2B,GAAG,IAAI,GAAG,SAAS,CAAC;IAC7D;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,OAAO,CAC+C,CAAC;AAEzD,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAgBxE,CAAC;AAEL,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAM9C;AAED,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,EAAE,CAAC,CAAC,OAAO,CACzD,qBAAqB,EACrB,CAAC,CAAC,UAAU,EACZ,OAAO,CAeP,CAAC;AAEH,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAM5D"}

package/dist/esm/sdk/models/shared/schoolinspectionevent.js

@@ -0,0 +1,74 @@
+/*
+ * 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 { SchoolInspectionEvaluationArea$inboundSchema, } from "./schoolinspectionevaluationarea.js";
+import { SchoolInspectionGrade$inboundSchema, } from "./schoolinspectiongrade.js";
+import { SchoolInspectionPredecessor$inboundSchema, } from "./schoolinspectionpredecessor.js";
+import { SchoolInspectorBody$inboundSchema, } from "./schoolinspectorbody.js";
+/**
+ * The inspectorate's own native overall grade. Not cross-body comparable.
+ */
+export const SchoolInspectionEventRating = {
+    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",
+};
+/** @internal */
+export const SchoolInspectionEventRating$inboundSchema = openEnums.inboundSchema(SchoolInspectionEventRating);
+/** @internal */
+export const Ratings$inboundSchema = z.object({
+    behaviourAndAttitudes: z.nullable(SchoolInspectionGrade$inboundSchema)
+        .optional(),
+    earlyYearsProvision: z.nullable(SchoolInspectionGrade$inboundSchema)
+        .optional(),
+    leadershipAndManagement: z.nullable(SchoolInspectionGrade$inboundSchema)
+        .optional(),
+    overallEffectiveness: z.nullable(SchoolInspectionGrade$inboundSchema)
+        .optional(),
+    personalDevelopment: z.nullable(SchoolInspectionGrade$inboundSchema)
+        .optional(),
+    qualityOfEducation: z.nullable(SchoolInspectionGrade$inboundSchema)
+        .optional(),
+    sixthFormProvision: z.nullable(SchoolInspectionGrade$inboundSchema)
+        .optional(),
+});
+export function ratingsFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Ratings$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Ratings' from JSON`);
+}
+/** @internal */
+export const SchoolInspectionEvent$inboundSchema = z.object({
+    categoryOfConcern: z.nullable(z.string()).optional(),
+    evaluationAreas: z.nullable(z.array(SchoolInspectionEvaluationArea$inboundSchema)).optional(),
+    framework: z.nullable(z.string()).optional(),
+    inspectionDate: z.string(),
+    inspectionType: z.nullable(z.string()).optional(),
+    inspectorBody: SchoolInspectorBody$inboundSchema,
+    predecessor: z.nullable(SchoolInspectionPredecessor$inboundSchema).optional(),
+    publicationDate: z.nullable(z.string()).optional(),
+    rating: SchoolInspectionEventRating$inboundSchema,
+    ratings: z.nullable(z.lazy(() => Ratings$inboundSchema)).optional(),
+    reportUrl: z.nullable(z.string()).optional(),
+});
+export function schoolInspectionEventFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SchoolInspectionEvent$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SchoolInspectionEvent' from JSON`);
+}
+//# sourceMappingURL=schoolinspectionevent.js.map

package/dist/esm/sdk/models/shared/schoolinspectionevent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolinspectionevent.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolinspectionevent.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,EAEL,4CAA4C,GAC7C,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAEL,mCAAmC,GACpC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAEL,yCAAyC,GAC1C,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAEL,iCAAiC,GAClC,MAAM,0BAA0B,CAAC;AAElC;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,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;AAoEX,gBAAgB;AAChB,MAAM,CAAC,MAAM,yCAAyC,GAIlD,SAAS,CAAC,aAAa,CAAC,2BAA2B,CAAC,CAAC;AAEzD,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAChC,CAAC,CAAC,MAAM,CAAC;IACP,qBAAqB,EAAE,CAAC,CAAC,QAAQ,CAAC,mCAAmC,CAAC;SACnE,QAAQ,EAAE;IACb,mBAAmB,EAAE,CAAC,CAAC,QAAQ,CAAC,mCAAmC,CAAC;SACjE,QAAQ,EAAE;IACb,uBAAuB,EAAE,CAAC,CAAC,QAAQ,CAAC,mCAAmC,CAAC;SACrE,QAAQ,EAAE;IACb,oBAAoB,EAAE,CAAC,CAAC,QAAQ,CAAC,mCAAmC,CAAC;SAClE,QAAQ,EAAE;IACb,mBAAmB,EAAE,CAAC,CAAC,QAAQ,CAAC,mCAAmC,CAAC;SACjE,QAAQ,EAAE;IACb,kBAAkB,EAAE,CAAC,CAAC,QAAQ,CAAC,mCAAmC,CAAC;SAChE,QAAQ,EAAE;IACb,kBAAkB,EAAE,CAAC,CAAC,QAAQ,CAAC,mCAAmC,CAAC;SAChE,QAAQ,EAAE;CACd,CAAC,CAAC;AAEL,MAAM,UAAU,eAAe,CAC7B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjD,qCAAqC,CACtC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAI5C,CAAC,CAAC,MAAM,CAAC;IACX,iBAAiB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACpD,eAAe,EAAE,CAAC,CAAC,QAAQ,CACzB,CAAC,CAAC,KAAK,CAAC,4CAA4C,CAAC,CACtD,CAAC,QAAQ,EAAE;IACZ,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACjD,aAAa,EAAE,iCAAiC;IAChD,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,yCAAyC,CAAC,CAAC,QAAQ,EAAE;IAC7E,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAClD,MAAM,EAAE,yCAAyC;IACjD,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC,QAAQ,EAAE;IACnE,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC;AAEH,MAAM,UAAU,6BAA6B,CAC3C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,mCAAmC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC/D,mDAAmD,CACpD,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/schoolinspectiongrade.d.ts

@@ -0,0 +1,17 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+export type SchoolInspectionGrade = {
+    /**
+     * 1 = Outstanding … 4 = Inadequate
+     */
+    grade: number;
+    /**
+     * Human-readable grade word
+     */
+    label: string;
+};
+/** @internal */
+export declare const SchoolInspectionGrade$inboundSchema: z.ZodType<SchoolInspectionGrade, z.ZodTypeDef, unknown>;
+export declare function schoolInspectionGradeFromJSON(jsonString: string): SafeParseResult<SchoolInspectionGrade, SDKValidationError>;
+//# sourceMappingURL=schoolinspectiongrade.d.ts.map

package/dist/esm/sdk/models/shared/schoolinspectiongrade.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolinspectiongrade.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolinspectiongrade.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,EAAE,CAAC,CAAC,OAAO,CACzD,qBAAqB,EACrB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAM5D"}

package/dist/esm/sdk/models/shared/schoolinspectiongrade.js

@@ -0,0 +1,14 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+/** @internal */
+export const SchoolInspectionGrade$inboundSchema = z.object({
+    grade: z.number().int(),
+    label: z.string(),
+});
+export function schoolInspectionGradeFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SchoolInspectionGrade$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SchoolInspectionGrade' from JSON`);
+}
+//# sourceMappingURL=schoolinspectiongrade.js.map

package/dist/esm/sdk/models/shared/schoolinspectiongrade.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolinspectiongrade.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolinspectiongrade.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAepD,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAI5C,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACvB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH,MAAM,UAAU,6BAA6B,CAC3C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,mCAAmC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC/D,mDAAmD,CACpD,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.d.ts

@@ -0,0 +1,13 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+export type SchoolInspectionPredecessor = {
+    name?: string | null | undefined;
+    relatesToCurrentUrn?: boolean | null | undefined;
+    schoolType?: string | null | undefined;
+    urn?: number | null | undefined;
+};
+/** @internal */
+export declare const SchoolInspectionPredecessor$inboundSchema: z.ZodType<SchoolInspectionPredecessor, z.ZodTypeDef, unknown>;
+export declare function schoolInspectionPredecessorFromJSON(jsonString: string): SafeParseResult<SchoolInspectionPredecessor, SDKValidationError>;
+//# sourceMappingURL=schoolinspectionpredecessor.d.ts.map

package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolinspectionpredecessor.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolinspectionpredecessor.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC,mBAAmB,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IACjD,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACvC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,mCAAmC,CACjD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAMlE"}

package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.js

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+/** @internal */
+export const SchoolInspectionPredecessor$inboundSchema = z.object({
+    name: z.nullable(z.string()).optional(),
+    relatesToCurrentUrn: z.nullable(z.boolean()).optional(),
+    schoolType: z.nullable(z.string()).optional(),
+    urn: z.nullable(z.number().int()).optional(),
+});
+export function schoolInspectionPredecessorFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SchoolInspectionPredecessor$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SchoolInspectionPredecessor' from JSON`);
+}
+//# sourceMappingURL=schoolinspectionpredecessor.js.map

package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolinspectionpredecessor.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolinspectionpredecessor.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAWpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,yCAAyC,GAIlD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,mBAAmB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvD,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC7C,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC;AAEH,MAAM,UAAU,mCAAmC,CACjD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,yCAAyC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrE,yDAAyD,CAC1D,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/schoolinspectorbody.d.ts

@@ -0,0 +1,19 @@
+import * as z from "zod/v3";
+import { OpenEnum } from "../../types/enums.js";
+/**
+ * Inspectorate that issued the rating. ofsted (England), estyn (Wales), education_scotland (Scotland), eti (Northern Ireland), des (Ireland).
+ */
+export declare const SchoolInspectorBody: {
+    readonly Ofsted: "ofsted";
+    readonly Estyn: "estyn";
+    readonly EducationScotland: "education_scotland";
+    readonly Eti: "eti";
+    readonly Des: "des";
+};
+/**
+ * Inspectorate that issued the rating. ofsted (England), estyn (Wales), education_scotland (Scotland), eti (Northern Ireland), des (Ireland).
+ */
+export type SchoolInspectorBody = OpenEnum<typeof SchoolInspectorBody>;
+/** @internal */
+export declare const SchoolInspectorBody$inboundSchema: z.ZodType<SchoolInspectorBody, z.ZodTypeDef, unknown>;
+//# sourceMappingURL=schoolinspectorbody.d.ts.map

package/dist/esm/sdk/models/shared/schoolinspectorbody.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolinspectorbody.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolinspectorbody.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;CAMtB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEvE,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CACuC,CAAC"}

package/dist/esm/sdk/models/shared/schoolinspectorbody.js

@@ -0,0 +1,17 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as openEnums from "../../types/enums.js";
+/**
+ * Inspectorate that issued the rating. ofsted (England), estyn (Wales), education_scotland (Scotland), eti (Northern Ireland), des (Ireland).
+ */
+export const SchoolInspectorBody = {
+    Ofsted: "ofsted",
+    Estyn: "estyn",
+    EducationScotland: "education_scotland",
+    Eti: "eti",
+    Des: "des",
+};
+/** @internal */
+export const SchoolInspectorBody$inboundSchema = openEnums.inboundSchema(SchoolInspectorBody);
+//# sourceMappingURL=schoolinspectorbody.js.map

package/dist/esm/sdk/models/shared/schoolinspectorbody.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolinspectorbody.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolinspectorbody.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAGlD;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,iBAAiB,EAAE,oBAAoB;IACvC,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;CACF,CAAC;AAMX,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,SAAS,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC"}

package/dist/esm/sdk/models/shared/schooltrustmembership.d.ts

@@ -0,0 +1,45 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+export type SchoolTrustMembership = {
+    /**
+     * Source group id (e.g. GIAS trust id 'TR…').
+     */
+    groupId?: string | null | undefined;
+    /**
+     * Source group-type label.
+     */
+    groupType?: string | null | undefined;
+    /**
+     * Organisation name.
+     */
+    name: string;
+    /**
+     * Internal organisation id.
+     */
+    organisationId: number;
+    /**
+     * This school's role in the organisation, e.g. 'member' | 'lead'.
+     */
+    role: string;
+    /**
+     * Organisation status label.
+     */
+    status?: string | null | undefined;
+    /**
+     * Organisation type, e.g. 'mat' | 'sat' | 'federation' | 'diocese'.
+     */
+    type: string;
+    /**
+     * Stable organisation UID (e.g. GIAS group UID).
+     */
+    uid: string;
+    /**
+     * Organisation UKPRN.
+     */
+    ukprn?: string | null | undefined;
+};
+/** @internal */
+export declare const SchoolTrustMembership$inboundSchema: z.ZodType<SchoolTrustMembership, z.ZodTypeDef, unknown>;
+export declare function schoolTrustMembershipFromJSON(jsonString: string): SafeParseResult<SchoolTrustMembership, SDKValidationError>;
+//# sourceMappingURL=schooltrustmembership.d.ts.map

package/dist/esm/sdk/models/shared/schooltrustmembership.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schooltrustmembership.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schooltrustmembership.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACnC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,EAAE,CAAC,CAAC,OAAO,CACzD,qBAAqB,EACrB,CAAC,CAAC,UAAU,EACZ,OAAO,CAWP,CAAC;AAEH,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAM5D"}

package/dist/esm/sdk/models/shared/schooltrustmembership.js

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+/** @internal */
+export const SchoolTrustMembership$inboundSchema = z.object({
+    groupId: z.nullable(z.string()).optional(),
+    groupType: z.nullable(z.string()).optional(),
+    name: z.string(),
+    organisationId: z.number().int(),
+    role: z.string(),
+    status: z.nullable(z.string()).optional(),
+    type: z.string(),
+    uid: z.string(),
+    ukprn: z.nullable(z.string()).optional(),
+});
+export function schoolTrustMembershipFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SchoolTrustMembership$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SchoolTrustMembership' from JSON`);
+}
+//# sourceMappingURL=schooltrustmembership.js.map

package/dist/esm/sdk/models/shared/schooltrustmembership.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schooltrustmembership.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schooltrustmembership.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AA2CpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAI5C,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1C,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAChC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEH,MAAM,UAAU,6BAA6B,CAC3C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,mCAAmC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC/D,mDAAmD,CACpD,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/searchresult.d.ts

@@ -54,7 +54,7 @@ export type SearchResult = {
      */
     location?: SearchResultCoordinates | undefined;
     /**
-     * Primary display text — building + street
+     * Primary display text: building + street
      */
     mainText?: string | undefined;
     /**
@@ -88,7 +88,7 @@ export type SearchResult = {
      */
     score: number;
     /**
-     * Secondary display text — locality + postcode
+     * Secondary display text: locality + postcode
      */
     secondaryText?: string | undefined;
     /**

package/dist/esm/sdk/models/shared/sitepropertystats.d.ts

@@ -6,11 +6,11 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type SitePropertyStats = {
     /**
-     * Average monthly rent in pence
+     * Average monthly rent in GBP (whole pounds)
      */
     avgRent?: number | undefined;
     /**
-     * Average estimated property value in pence
+     * Average estimated property value in GBP (whole pounds)
      */
     avgValue?: number | undefined;
     /**

package/dist/esm/sdk/planning.d.ts

@@ -6,21 +6,21 @@ export declare class Planning extends ClientSDK {
      * Get planning applications by application IDs
      *
      * @remarks
-     * Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead. Pass ?include=extractions to attach structured, citation-backed extractions to each application.
+     * Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
      */
     getPlanningApplications(request: operations.GetPlanningApplicationsRequest, options?: RequestOptions): Promise<shared.PlanningListResponse>;
     /**
      * Get planning applications by source IDs
      *
      * @remarks
-     * Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number. Pass ?include=extractions to attach structured, citation-backed extractions to each application.
+     * Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
      */
     getPlanningApplicationsBySource(request: operations.GetPlanningApplicationsBySourceRequest, options?: RequestOptions): Promise<shared.PlanningListResponse>;
     /**
      * Query planning applications with advanced filters
      *
      * @remarks
-     * Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include: ["extractions"]` to attach structured, citation-backed extractions. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field (the `near` filter overrides sort with closest-first). Supports up to 100 results per page.
+     * Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include` (any of `["extractions", "images", "content", "enrichment"]`) to attach structured citation-backed extractions, a renderable image gallery, document fileUrl/ocrUrl, and/or AI classification reasoning. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field (the `near` filter overrides sort with closest-first). Supports up to 100 results per page.
      */
     searchPlanningApplications(request?: shared.PlanningQueryRequest | undefined, options?: RequestOptions): Promise<shared.PlanningListResponse>;
 }

package/dist/esm/sdk/planning.js

@@ -11,7 +11,7 @@ export class Planning extends ClientSDK {
      * Get planning applications by application IDs
      *
      * @remarks
-     * Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead. Pass ?include=extractions to attach structured, citation-backed extractions to each application.
+     * Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
      */
     async getPlanningApplications(request, options) {
         return unwrapAsync(planningGetPlanningApplications(this, request, options));
@@ -20,7 +20,7 @@ export class Planning extends ClientSDK {
      * Get planning applications by source IDs
      *
      * @remarks
-     * Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number. Pass ?include=extractions to attach structured, citation-backed extractions to each application.
+     * Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
      */
     async getPlanningApplicationsBySource(request, options) {
         return unwrapAsync(planningGetPlanningApplicationsBySource(this, request, options));
@@ -29,7 +29,7 @@ export class Planning extends ClientSDK {
      * Query planning applications with advanced filters
      *
      * @remarks
-     * Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include: ["extractions"]` to attach structured, citation-backed extractions. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field (the `near` filter overrides sort with closest-first). Supports up to 100 results per page.
+     * Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include` (any of `["extractions", "images", "content", "enrichment"]`) to attach structured citation-backed extractions, a renderable image gallery, document fileUrl/ocrUrl, and/or AI classification reasoning. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field (the `near` filter overrides sort with closest-first). Supports up to 100 results per page.
      */
     async searchPlanningApplications(request, options) {
         return unwrapAsync(planningSearchPlanningApplications(this, request, options));

package/dist/esm/sdk/search.d.ts

@@ -7,6 +7,12 @@ export declare class Search extends ClientSDK {
      *
      * @remarks
      * Simple autocomplete for UK properties and locations. Searches across Address and Location sources with fuzzy matching. Automatically detects query type (postcode, address, place name) and returns suggestions.
+     *
+     * Optionally accepts a geographic centre point (`lat`, `lng`) to make results proximity-aware:
+     * - `geo_mode=bias` (default): soft preference. The best textual matches near the point rank higher, but distant matches are still returned.
+     * - `geo_mode=restrict`: hard cutoff. Only address results within `radius_meters` of the point are returned.
+     *
+     * When a centre point is supplied, address results include a `distance` (metres from the point). Geographic ranking applies to the address source, so pair it with `source=address` for the most predictable proximity results.
      */
     searchSuggest(request: operations.SearchSuggestRequest, options?: RequestOptions): Promise<shared.SearchResponse>;
 }

package/dist/esm/sdk/search.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;OAKG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;CAOlC"}
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;OAWG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;CAOlC"}

package/dist/esm/sdk/search.js

@@ -10,6 +10,12 @@ export class Search extends ClientSDK {
      *
      * @remarks
      * Simple autocomplete for UK properties and locations. Searches across Address and Location sources with fuzzy matching. Automatically detects query type (postcode, address, place name) and returns suggestions.
+     *
+     * Optionally accepts a geographic centre point (`lat`, `lng`) to make results proximity-aware:
+     * - `geo_mode=bias` (default): soft preference. The best textual matches near the point rank higher, but distant matches are still returned.
+     * - `geo_mode=restrict`: hard cutoff. Only address results within `radius_meters` of the point are returned.
+     *
+     * When a centre point is supplied, address results include a `distance` (metres from the point). Geographic ranking applies to the address source, so pair it with `source=address` for the most predictable proximity results.
      */
     async searchSuggest(request, options) {
         return unwrapAsync(searchSearchSuggest(this, request, options));

package/dist/esm/sdk/search.js.map

@@ -1 +1 @@
-{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vepler/sdk",
-  "version": "2.145.1",
+  "version": "2.151.0",
   "author": "Vepler Limited",
   "type": "module",
   "tshy": {

package/src/funcs/censusGetBreaks.ts

@@ -109,7 +109,7 @@ async function $do(
     }),
   };
   const path = pathToFunc(
-    "/v1/census/breaks/{datasetCode}/{geotype}/{categoryCode}.json",
+    "/v1/census/breaks/{datasetCode}/{geotype}/{categoryCode}",
   )(pathParams);
 
   const query = encodeFormQuery({

package/src/funcs/censusGetTile.ts

@@ -113,7 +113,7 @@ async function $do(
     }),
   };
   const path = pathToFunc(
-    "/v1/census/tiles/{datasetCode}/{geotype}/{tile}/{categoryCode}.csv",
+    "/v1/census/tiles/{datasetCode}/{geotype}/{tile}/{categoryCode}",
   )(pathParams);
 
   const query = encodeFormQuery({

package/src/funcs/censusGetWholeLevel.ts

@@ -114,7 +114,7 @@ async function $do(
     }),
   };
   const path = pathToFunc(
-    "/v1/census/whole/{datasetCode}/{geotype}/{country}/{categoryCode}.csv",
+    "/v1/census/whole/{datasetCode}/{geotype}/{country}/{categoryCode}",
   )(pathParams);
 
   const query = encodeFormQuery({

package/src/funcs/planningGetPlanningApplications.ts

@@ -31,7 +31,7 @@ import { Result } from "../sdk/types/fp.js";
  * Get planning applications by application IDs
  *
  * @remarks
- * Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead. Pass ?include=extractions to attach structured, citation-backed extractions to each application.
+ * Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
  */
 export function planningGetPlanningApplications(
   client: SDKCore,

package/src/funcs/planningGetPlanningApplicationsBySource.ts

@@ -31,7 +31,7 @@ import { Result } from "../sdk/types/fp.js";
  * Get planning applications by source IDs
  *
  * @remarks
- * Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number. Pass ?include=extractions to attach structured, citation-backed extractions to each application.
+ * Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
  */
 export function planningGetPlanningApplicationsBySource(
   client: SDKCore,

package/src/funcs/planningSearchPlanningApplications.ts

@@ -30,7 +30,7 @@ import { Result } from "../sdk/types/fp.js";
  * Query planning applications with advanced filters
  *
  * @remarks
- * Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include: ["extractions"]` to attach structured, citation-backed extractions. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field (the `near` filter overrides sort with closest-first). Supports up to 100 results per page.
+ * Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include` (any of `["extractions", "images", "content", "enrichment"]`) to attach structured citation-backed extractions, a renderable image gallery, document fileUrl/ocrUrl, and/or AI classification reasoning. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field (the `near` filter overrides sort with closest-first). Supports up to 100 results per page.
  */
 export function planningSearchPlanningApplications(
   client: SDKCore,