@vepler/sdk 2.131.2 → 2.137.0

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

@@ -0,0 +1,85 @@
+/*
+ * 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 {
+  InsuranceImpact,
+  InsuranceImpact$inboundSchema,
+} from "./insuranceimpact.js";
+import { LenderImpact, LenderImpact$inboundSchema } from "./lenderimpact.js";
+import {
+  LiquidityImpact,
+  LiquidityImpact$inboundSchema,
+} from "./liquidityimpact.js";
+import {
+  MitigationMeasure,
+  MitigationMeasure$inboundSchema,
+} from "./mitigationmeasure.js";
+import {
+  PlanningConsideration,
+  PlanningConsideration$inboundSchema,
+} from "./planningconsideration.js";
+import { ValueImpact, ValueImpact$inboundSchema } from "./valueimpact.js";
+
+/**
+ * Shared property-value-impact primitive synthesised from band + AQMA + VEZ containment. Always free — no premium gate.
+ */
+export type PropertyValueImpact = {
+  /**
+   * Planning policy considerations triggered
+   */
+  considerations: Array<PlanningConsideration>;
+  /**
+   * Top-level regulatory framework underlying the assessment
+   */
+  framework: string;
+  /**
+   * Insurance-market consequences of the risk
+   */
+  insurance?: InsuranceImpact | undefined;
+  /**
+   * Mortgage lender posture toward the risk
+   */
+  lenderImpact?: LenderImpact | undefined;
+  /**
+   * Effect on time-to-sell
+   */
+  liquidity?: LiquidityImpact | undefined;
+  /**
+   * Mitigation measures available to a developer or occupier
+   */
+  mitigations: Array<MitigationMeasure>;
+  /**
+   * Magnitude of expected effect on property value
+   */
+  valueImpact: ValueImpact;
+};
+
+/** @internal */
+export const PropertyValueImpact$inboundSchema: z.ZodType<
+  PropertyValueImpact,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  considerations: z.array(PlanningConsideration$inboundSchema),
+  framework: z.string(),
+  insurance: InsuranceImpact$inboundSchema.optional(),
+  lenderImpact: LenderImpact$inboundSchema.optional(),
+  liquidity: LiquidityImpact$inboundSchema.optional(),
+  mitigations: z.array(MitigationMeasure$inboundSchema),
+  valueImpact: ValueImpact$inboundSchema,
+});
+
+export function propertyValueImpactFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyValueImpact, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyValueImpact$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyValueImpact' from JSON`,
+  );
+}

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

@@ -0,0 +1,63 @@
+/*
+ * 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 { DataSourceRef, DataSourceRef$inboundSchema } from "./datasourceref.js";
+
+/**
+ * Universal provenance block — every product envelope carries this
+ */
+export type Provenance = {
+  /**
+   * ISO datetime indicating the data validity reference (often newer than upstream releaseDate but earlier than publishedAt)
+   */
+  asOf?: string | undefined;
+  /**
+   * Semantic version of the product pipeline that computed this response
+   */
+  productVersion: string;
+  /**
+   * ISO datetime when Vepler published this snapshot
+   */
+  publishedAt: string;
+  /**
+   * Version of the shared scoring contract that produced this response's score/band. Present on air-quality envelopes; lets a consumer detect a substrate (/query) vs overlay (/point) scoring-table mismatch.
+   */
+  scoringContractVersion?: string | undefined;
+  /**
+   * Identifier of the publish snapshot that produced this response
+   */
+  snapshotId: string;
+  /**
+   * All upstream sources contributing to this response
+   */
+  sources: Array<DataSourceRef>;
+};
+
+/** @internal */
+export const Provenance$inboundSchema: z.ZodType<
+  Provenance,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  asOf: z.string().optional(),
+  productVersion: z.string(),
+  publishedAt: z.string(),
+  scoringContractVersion: z.string().optional(),
+  snapshotId: z.string(),
+  sources: z.array(DataSourceRef$inboundSchema),
+});
+
+export function provenanceFromJSON(
+  jsonString: string,
+): SafeParseResult<Provenance, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Provenance$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Provenance' from JSON`,
+  );
+}

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

@@ -58,7 +58,7 @@ export type PscAddress = {
 /**
  * The type of entity with significant control. Determines which fields are populated: 'individual-*' kinds have nationality and date of birth; 'corporate-entity-*' kinds have a corporateEntityId; 'super-secure-*' kinds have limited personal details (identity protected by court order).
  */
-export const Kind = {
+export const PscKind = {
   IndividualPersonWithSignificantControl:
     "individual-person-with-significant-control",
   CorporateEntityPersonWithSignificantControl:
@@ -75,7 +75,7 @@ export const Kind = {
 /**
  * The type of entity with significant control. Determines which fields are populated: 'individual-*' kinds have nationality and date of birth; 'corporate-entity-*' kinds have a corporateEntityId; 'super-secure-*' kinds have limited personal details (identity protected by court order).
  */
-export type Kind = OpenEnum<typeof Kind>;
+export type PscKind = OpenEnum<typeof PscKind>;
 
 /**
  * The full PSC notification record.
@@ -120,7 +120,7 @@ export type Psc = {
   /**
    * The type of entity with significant control. Determines which fields are populated: 'individual-*' kinds have nationality and date of birth; 'corporate-entity-*' kinds have a corporateEntityId; 'super-secure-*' kinds have limited personal details (identity protected by court order).
    */
-  kind: Kind;
+  kind: PscKind;
   /**
    * Linking type for Relevant Legal Entities (RLEs). Indicates how this PSC record links to a higher-level entity in an ownership chain.
    */
@@ -188,8 +188,8 @@ export function pscAddressFromJSON(
 }
 
 /** @internal */
-export const Kind$inboundSchema: z.ZodType<Kind, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Kind);
+export const PscKind$inboundSchema: z.ZodType<PscKind, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(PscKind);
 
 /** @internal */
 export const Psc$inboundSchema: z.ZodType<Psc, z.ZodTypeDef, unknown> = z
@@ -207,7 +207,7 @@ export const Psc$inboundSchema: z.ZodType<Psc, z.ZodTypeDef, unknown> = z
     id: z.string(),
     isSanctioned: z.boolean(),
     isSuperSecure: z.boolean(),
-    kind: Kind$inboundSchema,
+    kind: PscKind$inboundSchema,
     linkingKind: z.nullable(z.string()).optional(),
     name: z.string(),
     nationality: z.nullable(z.string()).optional(),

package/src/sdk/models/shared/regulator.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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  RegulatoryDomain,
+  RegulatoryDomain$inboundSchema,
+} from "./regulatorydomain.js";
+
+/**
+ * Reference to a statutory regulator
+ */
+export type Regulator = {
+  /**
+   * Regulator code — e.g. 'EA', 'SEPA', 'NRW', 'NIEA', 'EPA', 'ARPA_LOM', 'UBA'
+   */
+  code: string;
+  /**
+   * Regulatory domains this body has jurisdiction over
+   */
+  domains: Array<RegulatoryDomain>;
+  /**
+   * ISO 3166-1 alpha-2 (optionally with subdivision)
+   */
+  jurisdiction: string;
+  /**
+   * Full regulator name
+   */
+  name: string;
+  /**
+   * Public website
+   */
+  url?: string | undefined;
+};
+
+/** @internal */
+export const Regulator$inboundSchema: z.ZodType<
+  Regulator,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  domains: z.array(RegulatoryDomain$inboundSchema),
+  jurisdiction: z.string(),
+  name: z.string(),
+  url: z.string().optional(),
+});
+
+export function regulatorFromJSON(
+  jsonString: string,
+): SafeParseResult<Regulator, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Regulator$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Regulator' from JSON`,
+  );
+}

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

@@ -0,0 +1,35 @@
+/*
+ * 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";
+
+/**
+ * Regulatory domain a body has jurisdiction over
+ */
+export const RegulatoryDomain = {
+  AirQuality: "air_quality",
+  Water: "water",
+  IndustrialEmissions: "industrial_emissions",
+  Waste: "waste",
+  Noise: "noise",
+  Planning: "planning",
+  Flood: "flood",
+  Education: "education",
+  Health: "health",
+  Transport: "transport",
+  Energy: "energy",
+} as const;
+/**
+ * Regulatory domain a body has jurisdiction over
+ */
+export type RegulatoryDomain = OpenEnum<typeof RegulatoryDomain>;
+
+/** @internal */
+export const RegulatoryDomain$inboundSchema: z.ZodType<
+  RegulatoryDomain,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(RegulatoryDomain);

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

@@ -0,0 +1,97 @@
+/*
+ * 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 { AuthorityRef, AuthorityRef$inboundSchema } from "./authorityref.js";
+import {
+  RegulatoryZoneCharges,
+  RegulatoryZoneCharges$inboundSchema,
+} from "./regulatoryzonecharges.js";
+
+/**
+ * Government-defined polygon designation, scheme-discriminated
+ */
+export type RegulatoryZone = {
+  /**
+   * Reference to an administrative authority
+   */
+  authority?: AuthorityRef | undefined;
+  /**
+   * Charging / penalty schedule for zones that levy one — CAZ, ULEZ, LEZ, ZEZ, and international equivalents (Umweltzone, Crit'Air). Absent for non-charging designations such as AQMAs and flood zones.
+   */
+  charges?: RegulatoryZoneCharges | undefined;
+  /**
+   * Scheme-specific classification — e.g. 'Class D' for CAZ, 'PM2.5 nonattainment' for US
+   */
+  classification?: string | undefined;
+  /**
+   * Regulator-issued identifier for the zone
+   */
+  code?: string | undefined;
+  /**
+   * Air-quality schemes only — pollutants the zone is declared for
+   */
+  declaredPollutants?: Array<string> | undefined;
+  /**
+   * Free-text description provided by the regulator
+   */
+  description?: string | undefined;
+  /**
+   * ISO date when the designation took effect
+   */
+  effectiveDate?: string | undefined;
+  /**
+   * ISO 3166-1 alpha-2 (optionally with subdivision)
+   */
+  jurisdiction: string;
+  /**
+   * Zone name as designated by the regulator
+   */
+  name: string;
+  /**
+   * Canonical URL to the designation document
+   */
+  reference?: string | undefined;
+  /**
+   * Scheme identifier — e.g. 'AQMA', 'CAZ', 'ULEZ', 'LEZ', 'SMOKE_CONTROL', 'US_NONATTAINMENT', 'DE_UMWELTZONE', 'FR_CRITAIR'
+   */
+  system: string;
+  /**
+   * Scheme edition or revision when applicable
+   */
+  systemVersion?: string | undefined;
+};
+
+/** @internal */
+export const RegulatoryZone$inboundSchema: z.ZodType<
+  RegulatoryZone,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  authority: AuthorityRef$inboundSchema.optional(),
+  charges: RegulatoryZoneCharges$inboundSchema.optional(),
+  classification: z.string().optional(),
+  code: z.string().optional(),
+  declaredPollutants: z.array(z.string()).optional(),
+  description: z.string().optional(),
+  effectiveDate: z.string().optional(),
+  jurisdiction: z.string(),
+  name: z.string(),
+  reference: z.string().optional(),
+  system: z.string(),
+  systemVersion: z.string().optional(),
+});
+
+export function regulatoryZoneFromJSON(
+  jsonString: string,
+): SafeParseResult<RegulatoryZone, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RegulatoryZone$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RegulatoryZone' from JSON`,
+  );
+}

package/src/sdk/models/shared/regulatoryzonechargerate.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";
+
+export type RegulatoryZoneChargeRate = {
+  /**
+   * Charge in GBP; null if this class is exempt in this zone
+   */
+  chargeGbp: number | null;
+  /**
+   * Emission standard a vehicle must meet to avoid the charge
+   */
+  complianceStandard: string | null;
+  /**
+   * Escalation, weight bands, or tiering
+   */
+  notes?: string | null | undefined;
+  /**
+   * car, lgv, taxi, phv, hgv, bus_coach, minibus, motorcycle, or 'all'
+   */
+  vehicleClass: string;
+};
+
+/** @internal */
+export const RegulatoryZoneChargeRate$inboundSchema: z.ZodType<
+  RegulatoryZoneChargeRate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chargeGbp: z.nullable(z.number()),
+  complianceStandard: z.nullable(z.string()),
+  notes: z.nullable(z.string()).optional(),
+  vehicleClass: z.string(),
+});
+
+export function regulatoryZoneChargeRateFromJSON(
+  jsonString: string,
+): SafeParseResult<RegulatoryZoneChargeRate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RegulatoryZoneChargeRate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RegulatoryZoneChargeRate' from JSON`,
+  );
+}

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

@@ -0,0 +1,79 @@
+/*
+ * 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 {
+  RegulatoryZoneChargeRate,
+  RegulatoryZoneChargeRate$inboundSchema,
+} from "./regulatoryzonechargerate.js";
+
+/**
+ * 'daily' = per-day charge for non-compliant entry (England CAZ, London ULEZ/LEZ, Oxford ZEZ); 'penalty' = fine for non-compliant entry, not pre-payable (Scottish LEZs)
+ */
+export const Model = {
+  Daily: "daily",
+  Penalty: "penalty",
+} as const;
+/**
+ * 'daily' = per-day charge for non-compliant entry (England CAZ, London ULEZ/LEZ, Oxford ZEZ); 'penalty' = fine for non-compliant entry, not pre-payable (Scottish LEZs)
+ */
+export type Model = OpenEnum<typeof Model>;
+
+/**
+ * Charging / penalty schedule for zones that levy one — CAZ, ULEZ, LEZ, ZEZ, and international equivalents (Umweltzone, Crit'Air). Absent for non-charging designations such as AQMAs and flood zones.
+ */
+export type RegulatoryZoneCharges = {
+  /**
+   * ISO date the rates were last verified against the source
+   */
+  asOf?: string | null | undefined;
+  /**
+   * 'daily' = per-day charge for non-compliant entry (England CAZ, London ULEZ/LEZ, Oxford ZEZ); 'penalty' = fine for non-compliant entry, not pre-payable (Scottish LEZs)
+   */
+  model: Model;
+  /**
+   * Per-vehicle-class charge lines
+   */
+  rates: Array<RegulatoryZoneChargeRate>;
+  /**
+   * Authority page the rates were curated from
+   */
+  source?: string | null | undefined;
+  /**
+   * Calendar year these rates are in force — the year of record
+   */
+  year: number;
+};
+
+/** @internal */
+export const Model$inboundSchema: z.ZodType<Model, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Model);
+
+/** @internal */
+export const RegulatoryZoneCharges$inboundSchema: z.ZodType<
+  RegulatoryZoneCharges,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  asOf: z.nullable(z.string()).optional(),
+  model: Model$inboundSchema,
+  rates: z.array(RegulatoryZoneChargeRate$inboundSchema),
+  source: z.nullable(z.string()).optional(),
+  year: z.number().int(),
+});
+
+export function regulatoryZoneChargesFromJSON(
+  jsonString: string,
+): SafeParseResult<RegulatoryZoneCharges, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RegulatoryZoneCharges$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RegulatoryZoneCharges' from JSON`,
+  );
+}

package/src/sdk/models/shared/scale.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";
+
+/**
+ * Self-describing scale for a score
+ */
+export type Scale = {
+  /**
+   * True if a higher score means a better outcome (Vepler platform convention is always true)
+   */
+  higherIsBetter: boolean;
+  /**
+   * Upper bound of the score scale
+   */
+  max: number;
+  /**
+   * Lower bound of the score scale
+   */
+  min: number;
+  /**
+   * Optional unit when the score has dimensional meaning (e.g. 'µg/m³')
+   */
+  unit?: string | undefined;
+};
+
+/** @internal */
+export const Scale$inboundSchema: z.ZodType<Scale, z.ZodTypeDef, unknown> = z
+  .object({
+    higherIsBetter: z.boolean(),
+    max: z.number(),
+    min: z.number(),
+    unit: z.string().optional(),
+  });
+
+export function scaleFromJSON(
+  jsonString: string,
+): SafeParseResult<Scale, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Scale$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Scale' from JSON`,
+  );
+}

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

@@ -0,0 +1,94 @@
+/*
+ * 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";
+
+/**
+ * Identifies a country × publishing authority × domain combination. Use to look up metric definitions via `/v1/schools/frameworks/{framework}`. Naming convention: `{country}_{authority}_{domain}`.
+ *
+ * @remarks
+ *
+ * Supported values:
+ *
+ * - `gb_eng_dfes_ks2` — England DfE Key Stage 2 performance — end-of-primary outcomes at age 11. Metrics include `PTRWM_EXP` (% at expected standard in reading/writing/maths combined) and progress scores `PROG_READ`/`PROG_WRIT`/`PROG_MAT`. Annual cadence.
+ * - `gb_eng_dfes_ks4` — England DfE Key Stage 4 performance — GCSE-stage outcomes at age 16. Metrics include `ATT8` (Attainment 8), `EBACCAPS` (EBacc Average Point Score), `P8MEA` (Progress 8). Annual cadence.
+ * - `gb_eng_dfes_ks5` — England DfE Key Stage 5 performance — post-16 outcomes for A-level, AS, technical and applied qualifications. Annual cadence.
+ * - `gb_eng_dfes_destinations_ks4` — England DfE post-KS4 destinations — education / apprenticeship / employment / NEET tracking for year-11 leavers, two-year lag.
+ * - `gb_eng_dfes_destinations_ks5` — England DfE post-KS5 destinations — higher-education entry, apprenticeships, employment for year-13 leavers.
+ * - `gb_eng_dfes_value_added` — England DfE KS5 value-added measures — by qualification and by subject.
+ * - `gb_eng_dfes_school_census` — England DfE School Census (Schools, Pupils and their Characteristics — SPC). Annual headcount + FSM + EAL + SEN by school.
+ * - `gb_eng_esfa_cfr` — England ESFA Consistent Financial Reporting — for maintained / local-authority schools. Annual income / expenditure / balances.
+ * - `gb_eng_esfa_aar` — England ESFA Academies Accounts Return — for academies, free schools and UTCs. Annual finance including trust central-services apportionment.
+ * - `gb_eng_lpa_admissions` — England local-authority published admissions outcomes — published-admission-number (PAN), preferences received, offers made, last-admitted distance, oversubscription criteria with offer counts. Cycle-keyed.
+ * - `gb_eng_ofsted_oeif` — England Ofsted Education Inspection Framework — pre-September-2025 inspection regime. Six numeric sub-judgements (1 outstanding..4 inadequate) plus optional early-years and sixth-form provision grades.
+ * - `gb_eng_ofsted_post_2025` — England Ofsted post-September-2025 reformed inspection — evaluation areas (1-5 ordinals) plus a special `safeguarding_grade` sentinel.
+ * - `gb_wls_welshgov_performance` — Wales Welsh Government performance data — scaffolded for future ingest; not currently populated.
+ * - `gb_wls_estyn_inspections` — Wales Estyn inspections — scaffolded for future ingest; not currently populated.
+ * - `gb_sct_education_scotland_performance` — Scotland Education Scotland performance — scaffolded for future ingest; not currently populated.
+ * - `gb_sct_hmie_inspections` — Scotland HMIE / Education Scotland inspections — scaffolded for future ingest; not currently populated.
+ * - `gb_nir_deni_performance` — Northern Ireland Department of Education performance — scaffolded for future ingest; not currently populated.
+ * - `gb_nir_eti_inspections` — Northern Ireland Education and Training Inspectorate (ETI) — scaffolded for future ingest; not currently populated.
+ * - `ie_doe_performance` — Ireland Department of Education performance — scaffolded for future ingest; not currently populated.
+ * - `ie_doe_inspections` — Ireland Department of Education inspections — scaffolded for future ingest; not currently populated.
+ */
+export const SchoolFrameworkCode = {
+  GbEngDfesKs2: "gb_eng_dfes_ks2",
+  GbEngDfesKs4: "gb_eng_dfes_ks4",
+  GbEngDfesKs5: "gb_eng_dfes_ks5",
+  GbEngDfesDestinationsKs4: "gb_eng_dfes_destinations_ks4",
+  GbEngDfesDestinationsKs5: "gb_eng_dfes_destinations_ks5",
+  GbEngDfesValueAdded: "gb_eng_dfes_value_added",
+  GbEngDfesSchoolCensus: "gb_eng_dfes_school_census",
+  GbEngEsfaCfr: "gb_eng_esfa_cfr",
+  GbEngEsfaAar: "gb_eng_esfa_aar",
+  GbEngLpaAdmissions: "gb_eng_lpa_admissions",
+  GbEngOfstedOeif: "gb_eng_ofsted_oeif",
+  GbEngOfstedPost2025: "gb_eng_ofsted_post_2025",
+  GbWlsWelshgovPerformance: "gb_wls_welshgov_performance",
+  GbWlsEstynInspections: "gb_wls_estyn_inspections",
+  GbSctEducationScotlandPerformance: "gb_sct_education_scotland_performance",
+  GbSctHmieInspections: "gb_sct_hmie_inspections",
+  GbNirDeniPerformance: "gb_nir_deni_performance",
+  GbNirEtiInspections: "gb_nir_eti_inspections",
+  IeDoePerformance: "ie_doe_performance",
+  IeDoeInspections: "ie_doe_inspections",
+} as const;
+/**
+ * Identifies a country × publishing authority × domain combination. Use to look up metric definitions via `/v1/schools/frameworks/{framework}`. Naming convention: `{country}_{authority}_{domain}`.
+ *
+ * @remarks
+ *
+ * Supported values:
+ *
+ * - `gb_eng_dfes_ks2` — England DfE Key Stage 2 performance — end-of-primary outcomes at age 11. Metrics include `PTRWM_EXP` (% at expected standard in reading/writing/maths combined) and progress scores `PROG_READ`/`PROG_WRIT`/`PROG_MAT`. Annual cadence.
+ * - `gb_eng_dfes_ks4` — England DfE Key Stage 4 performance — GCSE-stage outcomes at age 16. Metrics include `ATT8` (Attainment 8), `EBACCAPS` (EBacc Average Point Score), `P8MEA` (Progress 8). Annual cadence.
+ * - `gb_eng_dfes_ks5` — England DfE Key Stage 5 performance — post-16 outcomes for A-level, AS, technical and applied qualifications. Annual cadence.
+ * - `gb_eng_dfes_destinations_ks4` — England DfE post-KS4 destinations — education / apprenticeship / employment / NEET tracking for year-11 leavers, two-year lag.
+ * - `gb_eng_dfes_destinations_ks5` — England DfE post-KS5 destinations — higher-education entry, apprenticeships, employment for year-13 leavers.
+ * - `gb_eng_dfes_value_added` — England DfE KS5 value-added measures — by qualification and by subject.
+ * - `gb_eng_dfes_school_census` — England DfE School Census (Schools, Pupils and their Characteristics — SPC). Annual headcount + FSM + EAL + SEN by school.
+ * - `gb_eng_esfa_cfr` — England ESFA Consistent Financial Reporting — for maintained / local-authority schools. Annual income / expenditure / balances.
+ * - `gb_eng_esfa_aar` — England ESFA Academies Accounts Return — for academies, free schools and UTCs. Annual finance including trust central-services apportionment.
+ * - `gb_eng_lpa_admissions` — England local-authority published admissions outcomes — published-admission-number (PAN), preferences received, offers made, last-admitted distance, oversubscription criteria with offer counts. Cycle-keyed.
+ * - `gb_eng_ofsted_oeif` — England Ofsted Education Inspection Framework — pre-September-2025 inspection regime. Six numeric sub-judgements (1 outstanding..4 inadequate) plus optional early-years and sixth-form provision grades.
+ * - `gb_eng_ofsted_post_2025` — England Ofsted post-September-2025 reformed inspection — evaluation areas (1-5 ordinals) plus a special `safeguarding_grade` sentinel.
+ * - `gb_wls_welshgov_performance` — Wales Welsh Government performance data — scaffolded for future ingest; not currently populated.
+ * - `gb_wls_estyn_inspections` — Wales Estyn inspections — scaffolded for future ingest; not currently populated.
+ * - `gb_sct_education_scotland_performance` — Scotland Education Scotland performance — scaffolded for future ingest; not currently populated.
+ * - `gb_sct_hmie_inspections` — Scotland HMIE / Education Scotland inspections — scaffolded for future ingest; not currently populated.
+ * - `gb_nir_deni_performance` — Northern Ireland Department of Education performance — scaffolded for future ingest; not currently populated.
+ * - `gb_nir_eti_inspections` — Northern Ireland Education and Training Inspectorate (ETI) — scaffolded for future ingest; not currently populated.
+ * - `ie_doe_performance` — Ireland Department of Education performance — scaffolded for future ingest; not currently populated.
+ * - `ie_doe_inspections` — Ireland Department of Education inspections — scaffolded for future ingest; not currently populated.
+ */
+export type SchoolFrameworkCode = OpenEnum<typeof SchoolFrameworkCode>;
+
+/** @internal */
+export const SchoolFrameworkCode$inboundSchema: z.ZodType<
+  SchoolFrameworkCode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SchoolFrameworkCode);