@vepler/sdk 2.149.0 → 2.152.0

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

@@ -0,0 +1,22 @@
+/*
+ * 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";
+
+export const FloodRiskLevel = {
+  VeryLow: "very_low",
+  Low: "low",
+  Medium: "medium",
+  High: "high",
+} as const;
+export type FloodRiskLevel = OpenEnum<typeof FloodRiskLevel>;
+
+/** @internal */
+export const FloodRiskLevel$inboundSchema: z.ZodType<
+  FloodRiskLevel,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FloodRiskLevel);

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

@@ -0,0 +1,82 @@
+/*
+ * 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";
+import {
+  FloodClimate2080,
+  FloodClimate2080$inboundSchema,
+} from "./floodclimate2080.js";
+import {
+  FloodDataAvailability,
+  FloodDataAvailability$inboundSchema,
+} from "./flooddataavailability.js";
+import { FloodDefence, FloodDefence$inboundSchema } from "./flooddefence.js";
+import { FloodPlanning, FloodPlanning$inboundSchema } from "./floodplanning.js";
+import {
+  FloodRiskCoordinate,
+  FloodRiskCoordinate$inboundSchema,
+} from "./floodriskcoordinate.js";
+import {
+  FloodRiskSummary,
+  FloodRiskSummary$inboundSchema,
+} from "./floodrisksummary.js";
+import {
+  FloodRiversAndSeaRisk,
+  FloodRiversAndSeaRisk$inboundSchema,
+} from "./floodriversandsearisk.js";
+import {
+  FloodSurfaceWaterRisk,
+  FloodSurfaceWaterRisk$inboundSchema,
+} from "./floodsurfacewaterrisk.js";
+import { Provenance, Provenance$inboundSchema } from "./provenance.js";
+
+export type FloodRiskPoint = {
+  climate2080?: FloodClimate2080 | undefined;
+  coordinate: FloodRiskCoordinate;
+  dataAvailability: FloodDataAvailability;
+  defences?: FloodDefence | undefined;
+  /**
+   * Stable identifier for this assessment (cf. airQualityId)
+   */
+  floodRiskId: string;
+  planning?: FloodPlanning | undefined;
+  /**
+   * Universal provenance block — every product envelope carries this
+   */
+  provenance: Provenance;
+  riversAndSeaRisk: FloodRiversAndSeaRisk | null;
+  summary: FloodRiskSummary;
+  surfaceWaterRisk: FloodSurfaceWaterRisk | null;
+};
+
+/** @internal */
+export const FloodRiskPoint$inboundSchema: z.ZodType<
+  FloodRiskPoint,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  climate2080: FloodClimate2080$inboundSchema.optional(),
+  coordinate: FloodRiskCoordinate$inboundSchema,
+  dataAvailability: FloodDataAvailability$inboundSchema,
+  defences: FloodDefence$inboundSchema.optional(),
+  floodRiskId: z.string(),
+  planning: FloodPlanning$inboundSchema.optional(),
+  provenance: Provenance$inboundSchema,
+  riversAndSeaRisk: z.nullable(FloodRiversAndSeaRisk$inboundSchema),
+  summary: FloodRiskSummary$inboundSchema,
+  surfaceWaterRisk: z.nullable(FloodSurfaceWaterRisk$inboundSchema),
+});
+
+export function floodRiskPointFromJSON(
+  jsonString: string,
+): SafeParseResult<FloodRiskPoint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FloodRiskPoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FloodRiskPoint' from JSON`,
+  );
+}

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

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  FloodRiskCoordinate,
+  FloodRiskCoordinate$Outbound,
+  FloodRiskCoordinate$outboundSchema,
+} from "./floodriskcoordinate.js";
+import {
+  FloodScenario,
+  FloodScenario$outboundSchema,
+} from "./floodscenario.js";
+
+export type FloodRiskPointRequest = {
+  coordinate: FloodRiskCoordinate;
+  /**
+   * Which scenarios to assess: present day, climate-change 2080, or both.
+   */
+  scenario?: FloodScenario | undefined;
+  /**
+   * Enable billing tracking telemetry
+   */
+  track?: boolean | undefined;
+};
+
+/** @internal */
+export type FloodRiskPointRequest$Outbound = {
+  coordinate: FloodRiskCoordinate$Outbound;
+  scenario: string;
+  track: boolean;
+};
+
+/** @internal */
+export const FloodRiskPointRequest$outboundSchema: z.ZodType<
+  FloodRiskPointRequest$Outbound,
+  z.ZodTypeDef,
+  FloodRiskPointRequest
+> = z.object({
+  coordinate: FloodRiskCoordinate$outboundSchema,
+  scenario: FloodScenario$outboundSchema.default("both"),
+  track: z.boolean().default(false),
+});
+
+export function floodRiskPointRequestToJSON(
+  floodRiskPointRequest: FloodRiskPointRequest,
+): string {
+  return JSON.stringify(
+    FloodRiskPointRequest$outboundSchema.parse(floodRiskPointRequest),
+  );
+}

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

@@ -0,0 +1,61 @@
+/*
+ * 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 {
+  FloodPrimarySource,
+  FloodPrimarySource$inboundSchema,
+} from "./floodprimarysource.js";
+import {
+  FloodRiskLevel,
+  FloodRiskLevel$inboundSchema,
+} from "./floodrisklevel.js";
+
+export const CountryCode = {
+  Eng: "ENG",
+  Sco: "SCO",
+  Wal: "WAL",
+} as const;
+export type CountryCode = OpenEnum<typeof CountryCode>;
+
+export type FloodRiskSummary = {
+  countryCode: CountryCode | null;
+  label: string;
+  overallRiskLevel: FloodRiskLevel | null;
+  primarySource: FloodPrimarySource | null;
+};
+
+/** @internal */
+export const CountryCode$inboundSchema: z.ZodType<
+  CountryCode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(CountryCode);
+
+/** @internal */
+export const FloodRiskSummary$inboundSchema: z.ZodType<
+  FloodRiskSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  countryCode: z.nullable(CountryCode$inboundSchema),
+  label: z.string(),
+  overallRiskLevel: z.nullable(FloodRiskLevel$inboundSchema),
+  primarySource: z.nullable(FloodPrimarySource$inboundSchema),
+});
+
+export function floodRiskSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<FloodRiskSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FloodRiskSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FloodRiskSummary' from JSON`,
+  );
+}

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

@@ -0,0 +1,51 @@
+/*
+ * 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";
+import {
+  FloodProbability,
+  FloodProbability$inboundSchema,
+} from "./floodprobability.js";
+import {
+  FloodRiskLevel,
+  FloodRiskLevel$inboundSchema,
+} from "./floodrisklevel.js";
+
+export type FloodRiversAndSeaRisk = {
+  /**
+   * Plain-English depth impact, e.g. 'Waist deep — significant property damage likely'
+   */
+  depthImpact: string | null;
+  /**
+   * Maximum modelled flood depth in metres, or null if not modelled here
+   */
+  maxDepthMetres: number | null;
+  probability?: FloodProbability | undefined;
+  riskLevel: FloodRiskLevel | null;
+};
+
+/** @internal */
+export const FloodRiversAndSeaRisk$inboundSchema: z.ZodType<
+  FloodRiversAndSeaRisk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  depthImpact: z.nullable(z.string()),
+  maxDepthMetres: z.nullable(z.number()),
+  probability: FloodProbability$inboundSchema.optional(),
+  riskLevel: z.nullable(FloodRiskLevel$inboundSchema),
+});
+
+export function floodRiversAndSeaRiskFromJSON(
+  jsonString: string,
+): SafeParseResult<FloodRiversAndSeaRisk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FloodRiversAndSeaRisk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FloodRiversAndSeaRisk' from JSON`,
+  );
+}

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

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Which scenarios to assess: present day, climate-change 2080, or both.
+ */
+export const FloodScenario = {
+  Present: "present",
+  Cc2080: "cc_2080",
+  Both: "both",
+} as const;
+/**
+ * Which scenarios to assess: present day, climate-change 2080, or both.
+ */
+export type FloodScenario = ClosedEnum<typeof FloodScenario>;
+
+/** @internal */
+export const FloodScenario$outboundSchema: z.ZodNativeEnum<
+  typeof FloodScenario
+> = z.nativeEnum(FloodScenario);

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

@@ -0,0 +1,49 @@
+/*
+ * 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";
+import {
+  FloodHazardRating,
+  FloodHazardRating$inboundSchema,
+} from "./floodhazardrating.js";
+import {
+  FloodProbability,
+  FloodProbability$inboundSchema,
+} from "./floodprobability.js";
+import {
+  FloodRiskLevel,
+  FloodRiskLevel$inboundSchema,
+} from "./floodrisklevel.js";
+
+export type FloodSurfaceWaterRisk = {
+  hazardRating: FloodHazardRating | null;
+  probability?: FloodProbability | undefined;
+  riskLevel: FloodRiskLevel | null;
+  velocityMps: number | null;
+};
+
+/** @internal */
+export const FloodSurfaceWaterRisk$inboundSchema: z.ZodType<
+  FloodSurfaceWaterRisk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  hazardRating: z.nullable(FloodHazardRating$inboundSchema),
+  probability: FloodProbability$inboundSchema.optional(),
+  riskLevel: z.nullable(FloodRiskLevel$inboundSchema),
+  velocityMps: z.nullable(z.number()),
+});
+
+export function floodSurfaceWaterRiskFromJSON(
+  jsonString: string,
+): SafeParseResult<FloodSurfaceWaterRisk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FloodSurfaceWaterRisk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FloodSurfaceWaterRisk' from JSON`,
+  );
+}

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

@@ -0,0 +1,22 @@
+/*
+ * 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";
+
+export const FloodZone = {
+  One: "1",
+  Two: "2",
+  Threea: "3a",
+  Threeb: "3b",
+} as const;
+export type FloodZone = OpenEnum<typeof FloodZone>;
+
+/** @internal */
+export const FloodZone$inboundSchema: z.ZodType<
+  FloodZone,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FloodZone);

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

@@ -156,6 +156,23 @@ export * from "./extractionothercharge.js";
 export * from "./extractionpayload.js";
 export * from "./extractionproprietor.js";
 export * from "./extractionrestriction.js";
+export * from "./floodclimate2080.js";
+export * from "./flooddataavailability.js";
+export * from "./flooddefence.js";
+export * from "./floodhazardrating.js";
+export * from "./floodnearestdefence.js";
+export * from "./floodplanning.js";
+export * from "./floodprimarysource.js";
+export * from "./floodprobability.js";
+export * from "./floodriskcoordinate.js";
+export * from "./floodrisklevel.js";
+export * from "./floodriskpoint.js";
+export * from "./floodriskpointrequest.js";
+export * from "./floodrisksummary.js";
+export * from "./floodriversandsearisk.js";
+export * from "./floodscenario.js";
+export * from "./floodsurfacewaterrisk.js";
+export * from "./floodzone.js";
 export * from "./framework.js";
 export * from "./frameworkdetailresponse.js";
 export * from "./frameworklistresponse.js";
@@ -296,7 +313,13 @@ export * from "./salerecord.js";
 export * from "./scale.js";
 export * from "./schoolcatchmentblock.js";
 export * from "./schoolframeworkcode.js";
+export * from "./schoolinspectionevaluationarea.js";
+export * from "./schoolinspectionevent.js";
+export * from "./schoolinspectiongrade.js";
+export * from "./schoolinspectionpredecessor.js";
+export * from "./schoolinspectorbody.js";
 export * from "./schoolmatchbasis.js";
+export * from "./schooltrustmembership.js";
 export * from "./searchhighlight.js";
 export * from "./searchresponse.js";
 export * from "./searchresult.js";

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

@@ -55,11 +55,11 @@ export type Pricing = {
    */
   currency?: string | null | undefined;
   /**
-   * Estimated price in pence
+   * Estimated price in GBP (whole pounds)
    */
   estimated?: number | null | undefined;
   /**
-   * Listed price in pence
+   * Listed price in GBP (whole pounds)
    */
   price?: number | null | undefined;
 };

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

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * Direction of price change
  */
-export const Direction = {
+export const ListingPriceChangeDirection = {
   Up: "up",
   Down: "down",
   Initial: "initial",
@@ -20,11 +20,13 @@ export const Direction = {
 /**
  * Direction of price change
  */
-export type Direction = OpenEnum<typeof Direction>;
+export type ListingPriceChangeDirection = OpenEnum<
+  typeof ListingPriceChangeDirection
+>;
 
 export type ListingPriceChange = {
   /**
-   * Amount of change in pence
+   * Amount of change in GBP (whole pounds)
    */
   amount?: number | null | undefined;
   /**
@@ -34,23 +36,23 @@ export type ListingPriceChange = {
   /**
    * Direction of price change
    */
-  direction?: Direction | undefined;
+  direction?: ListingPriceChangeDirection | undefined;
   /**
    * Percentage change
    */
   percent?: number | null | undefined;
   /**
-   * New price after change in pence
+   * New price after change in GBP (whole pounds)
    */
   price?: number | null | undefined;
 };
 
 /** @internal */
-export const Direction$inboundSchema: z.ZodType<
-  Direction,
+export const ListingPriceChangeDirection$inboundSchema: z.ZodType<
+  ListingPriceChangeDirection,
   z.ZodTypeDef,
   unknown
-> = openEnums.inboundSchema(Direction);
+> = openEnums.inboundSchema(ListingPriceChangeDirection);
 
 /** @internal */
 export const ListingPriceChange$inboundSchema: z.ZodType<
@@ -62,7 +64,7 @@ export const ListingPriceChange$inboundSchema: z.ZodType<
   date: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),
-  direction: Direction$inboundSchema.optional(),
+  direction: ListingPriceChangeDirection$inboundSchema.optional(),
   percent: z.nullable(z.number()).optional(),
   price: z.nullable(z.number()).optional(),
 });

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

@@ -24,7 +24,7 @@ export type PriceChangeDirection = OpenEnum<typeof PriceChangeDirection>;
 
 export type PriceChange = {
   /**
-   * Amount of change in pence
+   * Amount of change in GBP (whole pounds)
    */
   amount?: number | null | undefined;
   /**
@@ -40,7 +40,7 @@ export type PriceChange = {
    */
   percent?: number | null | undefined;
   /**
-   * New price after change in pence
+   * New price after change in GBP (whole pounds)
    */
   price?: number | null | undefined;
 };

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

@@ -13,19 +13,19 @@ export type PricingData = {
    */
   currency?: string | null | undefined;
   /**
-   * Current rental price per month in pence
+   * Current rental price per month in GBP (whole pounds)
    */
   currentRent?: number | null | undefined;
   /**
-   * Current sale price in pence
+   * Current sale price in GBP (whole pounds)
    */
   currentSale?: number | null | undefined;
   /**
-   * Estimated rental value per month in pence
+   * Estimated monthly rental value in GBP (whole pounds)
    */
   estimatedRent?: number | null | undefined;
   /**
-   * Estimated sale value in pence
+   * Estimated sale value in GBP (whole pounds)
    */
   estimatedSale?: number | null | undefined;
 };

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

@@ -9,7 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SaleRecord = {
   /**
-   * Sale price in pence
+   * Sale price in GBP (whole pounds)
    */
   amount: number;
   /**

package/src/sdk/models/shared/schoolinspectionevaluationarea.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 SchoolInspectionEvaluationArea = {
+  /**
+   * Evaluation area key, e.g. 'leadership_governance'
+   */
+  area: string;
+  /**
+   * Category grade, e.g. 'Strong standard', or 'Met'/'Not met' for safeguarding
+   */
+  grade: string;
+};
+
+/** @internal */
+export const SchoolInspectionEvaluationArea$inboundSchema: z.ZodType<
+  SchoolInspectionEvaluationArea,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  area: z.string(),
+  grade: z.string(),
+});
+
+export function schoolInspectionEvaluationAreaFromJSON(
+  jsonString: string,
+): SafeParseResult<SchoolInspectionEvaluationArea, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SchoolInspectionEvaluationArea$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SchoolInspectionEvaluationArea' from JSON`,
+  );
+}