@vepler/sdk 2.149.0 → 2.152.0

package/src/sdk/models/shared/schoolinspectionevent.ts

@@ -0,0 +1,184 @@
+/*
+ * 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 { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  SchoolInspectionEvaluationArea,
+  SchoolInspectionEvaluationArea$inboundSchema,
+} from "./schoolinspectionevaluationarea.js";
+import {
+  SchoolInspectionGrade,
+  SchoolInspectionGrade$inboundSchema,
+} from "./schoolinspectiongrade.js";
+import {
+  SchoolInspectionPredecessor,
+  SchoolInspectionPredecessor$inboundSchema,
+} from "./schoolinspectionpredecessor.js";
+import {
+  SchoolInspectorBody,
+  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",
+} as const;
+/**
+ * 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 const SchoolInspectionEventRating$inboundSchema: z.ZodType<
+  SchoolInspectionEventRating,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SchoolInspectionEventRating);
+
+/** @internal */
+export const Ratings$inboundSchema: z.ZodType<Ratings, z.ZodTypeDef, unknown> =
+  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: string,
+): SafeParseResult<Ratings, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Ratings$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Ratings' from JSON`,
+  );
+}
+
+/** @internal */
+export const SchoolInspectionEvent$inboundSchema: z.ZodType<
+  SchoolInspectionEvent,
+  z.ZodTypeDef,
+  unknown
+> = 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: string,
+): SafeParseResult<SchoolInspectionEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SchoolInspectionEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SchoolInspectionEvent' from JSON`,
+  );
+}

package/src/sdk/models/shared/schoolinspectiongrade.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+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 const SchoolInspectionGrade$inboundSchema: z.ZodType<
+  SchoolInspectionGrade,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  grade: z.number().int(),
+  label: z.string(),
+});
+
+export function schoolInspectionGradeFromJSON(
+  jsonString: string,
+): SafeParseResult<SchoolInspectionGrade, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SchoolInspectionGrade$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SchoolInspectionGrade' from JSON`,
+  );
+}

package/src/sdk/models/shared/schoolinspectionpredecessor.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+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 const SchoolInspectionPredecessor$inboundSchema: z.ZodType<
+  SchoolInspectionPredecessor,
+  z.ZodTypeDef,
+  unknown
+> = 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: string,
+): SafeParseResult<SchoolInspectionPredecessor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SchoolInspectionPredecessor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SchoolInspectionPredecessor' from JSON`,
+  );
+}

package/src/sdk/models/shared/schoolinspectorbody.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } 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",
+} as const;
+/**
+ * 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 const SchoolInspectorBody$inboundSchema: z.ZodType<
+  SchoolInspectorBody,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SchoolInspectorBody);

package/src/sdk/models/shared/schooltrustmembership.ts

@@ -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 { 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 const SchoolTrustMembership$inboundSchema: z.ZodType<
+  SchoolTrustMembership,
+  z.ZodTypeDef,
+  unknown
+> = 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: string,
+): SafeParseResult<SchoolTrustMembership, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SchoolTrustMembership$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SchoolTrustMembership' from JSON`,
+  );
+}

package/src/sdk/models/shared/sitepropertystats.ts

@@ -12,11 +12,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/src/sdk/sdk.ts

@@ -14,6 +14,7 @@ import { Connectivity } from "./connectivity.js";
 import { Councils } from "./councils.js";
 import { Energy } from "./energy.js";
 import { Epc } from "./epc.js";
+import { FloodRisk } from "./floodrisk.js";
 import { Listings } from "./listings.js";
 import { Metrics } from "./metrics.js";
 import { Planning } from "./planning.js";
@@ -101,6 +102,11 @@ export class SDK extends ClientSDK {
     return (this._epc ??= new Epc(this._options));
   }
 
+  private _floodRisk?: FloodRisk;
+  get floodRisk(): FloodRisk {
+    return (this._floodRisk ??= new FloodRisk(this._options));
+  }
+
   private _listings?: Listings;
   get listings(): Listings {
     return (this._listings ??= new Listings(this._options));