@vepler/sdk 2.86.0 → 2.131.0

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

@@ -0,0 +1,100 @@
+/*
+ * 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";
+
+/**
+ * How firmly the match should be rendered. 'hard' — solid polygon (designated / faith / feeder). 'indicative' — dashed / semi-transparent (last-admitted-distance). 'soft' — marker + distance only (distance ranking).
+ */
+export const SchoolMatchBasisConfidence = {
+  Hard: "hard",
+  Indicative: "indicative",
+  Soft: "soft",
+} as const;
+/**
+ * How firmly the match should be rendered. 'hard' — solid polygon (designated / faith / feeder). 'indicative' — dashed / semi-transparent (last-admitted-distance). 'soft' — marker + distance only (distance ranking).
+ */
+export type SchoolMatchBasisConfidence = OpenEnum<
+  typeof SchoolMatchBasisConfidence
+>;
+
+/**
+ * Match basis tier. 'designated_polygon' (Tier 1, hard): point is inside the LA-published catchment polygon. 'last_admitted_distance' (Tier 2, indicative): property is within last year's furthest admitted-pupil distance. 'faith_jurisdiction' (Tier 3, hard): point is inside a parish/diocese tied to the school's faith criterion. 'feeder_link' (Tier 4, hard): the school is named as a feeder target by another already-matched school. 'distance_ranking' (Tier 5, soft): nearest-N fallback so the result set is never empty.
+ */
+export const SchoolMatchBasisTier = {
+  DesignatedPolygon: "designated_polygon",
+  LastAdmittedDistance: "last_admitted_distance",
+  FaithJurisdiction: "faith_jurisdiction",
+  FeederLink: "feeder_link",
+  DistanceRanking: "distance_ranking",
+} as const;
+/**
+ * Match basis tier. 'designated_polygon' (Tier 1, hard): point is inside the LA-published catchment polygon. 'last_admitted_distance' (Tier 2, indicative): property is within last year's furthest admitted-pupil distance. 'faith_jurisdiction' (Tier 3, hard): point is inside a parish/diocese tied to the school's faith criterion. 'feeder_link' (Tier 4, hard): the school is named as a feeder target by another already-matched school. 'distance_ranking' (Tier 5, soft): nearest-N fallback so the result set is never empty.
+ */
+export type SchoolMatchBasisTier = OpenEnum<typeof SchoolMatchBasisTier>;
+
+export type SchoolMatchBasis = {
+  /**
+   * Academic year id for which this basis applies (Tier 2 / Tier 4 only).
+   */
+  asOfYear?: string | undefined;
+  /**
+   * How firmly the match should be rendered. 'hard' — solid polygon (designated / faith / feeder). 'indicative' — dashed / semi-transparent (last-admitted-distance). 'soft' — marker + distance only (distance ranking).
+   */
+  confidence: SchoolMatchBasisConfidence;
+  /**
+   * Tier-shaped detail object — keys depend on tier (polygon_id, last_admitted_distance_m, parish name, etc.).
+   */
+  detail: { [k: string]: any | null };
+  /**
+   * Provenance URL for this basis (e.g. LA polygon source).
+   */
+  sourceUrl?: string | undefined;
+  /**
+   * Match basis tier. 'designated_polygon' (Tier 1, hard): point is inside the LA-published catchment polygon. 'last_admitted_distance' (Tier 2, indicative): property is within last year's furthest admitted-pupil distance. 'faith_jurisdiction' (Tier 3, hard): point is inside a parish/diocese tied to the school's faith criterion. 'feeder_link' (Tier 4, hard): the school is named as a feeder target by another already-matched school. 'distance_ranking' (Tier 5, soft): nearest-N fallback so the result set is never empty.
+   */
+  tier: SchoolMatchBasisTier;
+};
+
+/** @internal */
+export const SchoolMatchBasisConfidence$inboundSchema: z.ZodType<
+  SchoolMatchBasisConfidence,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SchoolMatchBasisConfidence);
+
+/** @internal */
+export const SchoolMatchBasisTier$inboundSchema: z.ZodType<
+  SchoolMatchBasisTier,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SchoolMatchBasisTier);
+
+/** @internal */
+export const SchoolMatchBasis$inboundSchema: z.ZodType<
+  SchoolMatchBasis,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  asOfYear: z.string().optional(),
+  confidence: SchoolMatchBasisConfidence$inboundSchema,
+  detail: z.record(z.nullable(z.any())),
+  sourceUrl: z.string().optional(),
+  tier: SchoolMatchBasisTier$inboundSchema,
+});
+
+export function schoolMatchBasisFromJSON(
+  jsonString: string,
+): SafeParseResult<SchoolMatchBasis, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SchoolMatchBasis$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SchoolMatchBasis' from JSON`,
+  );
+}

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

@@ -31,7 +31,7 @@ export type QueryPattern = OpenEnum<typeof QueryPattern>;
  * - address: UK property addresses with UPRN, full address details, and geocoding
  * - location: UK postcodes, places, towns, and geographic locations
  */
-export const Sources = {
+export const SearchResponseSources = {
   Address: "address",
   Location: "location",
 } as const;
@@ -42,7 +42,7 @@ export const Sources = {
  * - address: UK property addresses with UPRN, full address details, and geocoding
  * - location: UK postcodes, places, towns, and geographic locations
  */
-export type Sources = OpenEnum<typeof Sources>;
+export type SearchResponseSources = OpenEnum<typeof SearchResponseSources>;
 
 /**
  * Search metadata
@@ -59,7 +59,7 @@ export type Metadata = {
   /**
    * Data sources used in search
    */
-  sources?: Array<Sources> | undefined;
+  sources?: Array<SearchResponseSources> | undefined;
 };
 
 /**
@@ -108,8 +108,11 @@ export const QueryPattern$inboundSchema: z.ZodType<
 > = openEnums.inboundSchema(QueryPattern);
 
 /** @internal */
-export const Sources$inboundSchema: z.ZodType<Sources, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Sources);
+export const SearchResponseSources$inboundSchema: z.ZodType<
+  SearchResponseSources,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SearchResponseSources);
 
 /** @internal */
 export const Metadata$inboundSchema: z.ZodType<
@@ -119,7 +122,7 @@ export const Metadata$inboundSchema: z.ZodType<
 > = z.object({
   processingTime: z.string().optional(),
   queryPattern: QueryPattern$inboundSchema.optional(),
-  sources: z.array(Sources$inboundSchema).optional(),
+  sources: z.array(SearchResponseSources$inboundSchema).optional(),
 });
 
 export function metadataFromJSON(

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

@@ -26,7 +26,7 @@ import { SiteTags, SiteTags$inboundSchema } from "./sitetags.js";
 /**
  * GeoJSON MultiPolygon geometry
  */
-export type GeoJSONMultiPolygon = {
+export type SiteGeoJSONMultiPolygon = {
   /**
    * Array of polygon coordinate arrays
    */
@@ -40,7 +40,7 @@ export type GeoJSONMultiPolygon = {
 /**
  * GeoJSON Polygon geometry
  */
-export type GeoJSONPolygon = {
+export type SiteGeoJSONPolygon = {
   /**
    * Array of linear rings
    */
@@ -54,7 +54,7 @@ export type GeoJSONPolygon = {
 /**
  * Site boundary geometry in WGS84 (EPSG:4326). GeoJSON Polygon or MultiPolygon with coordinates in [longitude, latitude] order. Excluded from the default attribute set for performance — request explicitly via `attributes: ["boundary"]`.
  */
-export type Boundary = GeoJSONPolygon | GeoJSONMultiPolygon;
+export type Boundary = SiteGeoJSONPolygon | SiteGeoJSONMultiPolygon;
 
 /**
  * Geographic centroid of the site boundary in WGS84. Always present when the site has a boundary. Omitted only if centroid is not included in the requested attributes.
@@ -180,7 +180,7 @@ export type Site = {
   /**
    * Site boundary geometry in WGS84 (EPSG:4326). GeoJSON Polygon or MultiPolygon with coordinates in [longitude, latitude] order. Excluded from the default attribute set for performance — request explicitly via `attributes: ["boundary"]`.
    */
-  boundary?: GeoJSONPolygon | GeoJSONMultiPolygon | undefined;
+  boundary?: SiteGeoJSONPolygon | SiteGeoJSONMultiPolygon | undefined;
   /**
    * Geographic centroid of the site boundary in WGS84. Always present when the site has a boundary. Omitted only if centroid is not included in the requested attributes.
    */
@@ -276,8 +276,8 @@ export type Site = {
 };
 
 /** @internal */
-export const GeoJSONMultiPolygon$inboundSchema: z.ZodType<
-  GeoJSONMultiPolygon,
+export const SiteGeoJSONMultiPolygon$inboundSchema: z.ZodType<
+  SiteGeoJSONMultiPolygon,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -285,19 +285,19 @@ export const GeoJSONMultiPolygon$inboundSchema: z.ZodType<
   type: z.literal("MultiPolygon"),
 });
 
-export function geoJSONMultiPolygonFromJSON(
+export function siteGeoJSONMultiPolygonFromJSON(
   jsonString: string,
-): SafeParseResult<GeoJSONMultiPolygon, SDKValidationError> {
+): SafeParseResult<SiteGeoJSONMultiPolygon, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => GeoJSONMultiPolygon$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GeoJSONMultiPolygon' from JSON`,
+    (x) => SiteGeoJSONMultiPolygon$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteGeoJSONMultiPolygon' from JSON`,
   );
 }
 
 /** @internal */
-export const GeoJSONPolygon$inboundSchema: z.ZodType<
-  GeoJSONPolygon,
+export const SiteGeoJSONPolygon$inboundSchema: z.ZodType<
+  SiteGeoJSONPolygon,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -305,13 +305,13 @@ export const GeoJSONPolygon$inboundSchema: z.ZodType<
   type: z.literal("Polygon"),
 });
 
-export function geoJSONPolygonFromJSON(
+export function siteGeoJSONPolygonFromJSON(
   jsonString: string,
-): SafeParseResult<GeoJSONPolygon, SDKValidationError> {
+): SafeParseResult<SiteGeoJSONPolygon, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => GeoJSONPolygon$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GeoJSONPolygon' from JSON`,
+    (x) => SiteGeoJSONPolygon$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteGeoJSONPolygon' from JSON`,
   );
 }
 
@@ -321,8 +321,8 @@ export const Boundary$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.union([
-  z.lazy(() => GeoJSONPolygon$inboundSchema),
-  z.lazy(() => GeoJSONMultiPolygon$inboundSchema),
+  z.lazy(() => SiteGeoJSONPolygon$inboundSchema),
+  z.lazy(() => SiteGeoJSONMultiPolygon$inboundSchema),
 ]);
 
 export function boundaryFromJSON(
@@ -397,8 +397,8 @@ export const Site$inboundSchema: z.ZodType<Site, z.ZodTypeDef, unknown> = z
     areaMetrics: z.nullable(SiteAreaMetrics$inboundSchema),
     areaSqm: z.number(),
     boundary: z.union([
-      z.lazy(() => GeoJSONPolygon$inboundSchema),
-      z.lazy(() => GeoJSONMultiPolygon$inboundSchema),
+      z.lazy(() => SiteGeoJSONPolygon$inboundSchema),
+      z.lazy(() => SiteGeoJSONMultiPolygon$inboundSchema),
     ]).optional(),
     centroid: z.lazy(() => SiteCoordinates$inboundSchema).optional(),
     classTitleCode: z.nullable(ClassTitleCode$inboundSchema).optional(),

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

@@ -7,7 +7,7 @@ import * as z from "zod/v3";
 /**
  * South-east corner of the bounding box
  */
-export type BottomRight = {
+export type SiteBoundingBoxAreaFilterBottomRight = {
   /**
    * South latitude
    */
@@ -21,7 +21,7 @@ export type BottomRight = {
 /**
  * North-west corner of the bounding box
  */
-export type TopLeft = {
+export type SiteBoundingBoxAreaFilterTopLeft = {
   /**
    * North latitude
    */
@@ -39,58 +39,70 @@ export type SiteBoundingBoxAreaFilter = {
   /**
    * South-east corner of the bounding box
    */
-  bottomRight: BottomRight;
+  bottomRight: SiteBoundingBoxAreaFilterBottomRight;
   /**
    * North-west corner of the bounding box
    */
-  topLeft: TopLeft;
+  topLeft: SiteBoundingBoxAreaFilterTopLeft;
   type: "boundingBox";
 };
 
 /** @internal */
-export type BottomRight$Outbound = {
+export type SiteBoundingBoxAreaFilterBottomRight$Outbound = {
   lat: number;
   lon: number;
 };
 
 /** @internal */
-export const BottomRight$outboundSchema: z.ZodType<
-  BottomRight$Outbound,
+export const SiteBoundingBoxAreaFilterBottomRight$outboundSchema: z.ZodType<
+  SiteBoundingBoxAreaFilterBottomRight$Outbound,
   z.ZodTypeDef,
-  BottomRight
+  SiteBoundingBoxAreaFilterBottomRight
 > = z.object({
   lat: z.number(),
   lon: z.number(),
 });
 
-export function bottomRightToJSON(bottomRight: BottomRight): string {
-  return JSON.stringify(BottomRight$outboundSchema.parse(bottomRight));
+export function siteBoundingBoxAreaFilterBottomRightToJSON(
+  siteBoundingBoxAreaFilterBottomRight: SiteBoundingBoxAreaFilterBottomRight,
+): string {
+  return JSON.stringify(
+    SiteBoundingBoxAreaFilterBottomRight$outboundSchema.parse(
+      siteBoundingBoxAreaFilterBottomRight,
+    ),
+  );
 }
 
 /** @internal */
-export type TopLeft$Outbound = {
+export type SiteBoundingBoxAreaFilterTopLeft$Outbound = {
   lat: number;
   lon: number;
 };
 
 /** @internal */
-export const TopLeft$outboundSchema: z.ZodType<
-  TopLeft$Outbound,
+export const SiteBoundingBoxAreaFilterTopLeft$outboundSchema: z.ZodType<
+  SiteBoundingBoxAreaFilterTopLeft$Outbound,
   z.ZodTypeDef,
-  TopLeft
+  SiteBoundingBoxAreaFilterTopLeft
 > = z.object({
   lat: z.number(),
   lon: z.number(),
 });
 
-export function topLeftToJSON(topLeft: TopLeft): string {
-  return JSON.stringify(TopLeft$outboundSchema.parse(topLeft));
+export function siteBoundingBoxAreaFilterTopLeftToJSON(
+  siteBoundingBoxAreaFilterTopLeft: SiteBoundingBoxAreaFilterTopLeft,
+): string {
+  return JSON.stringify(
+    SiteBoundingBoxAreaFilterTopLeft$outboundSchema.parse(
+      siteBoundingBoxAreaFilterTopLeft,
+    ),
+  );
 }
 
 /** @internal */
 export type SiteBoundingBoxAreaFilter$Outbound = {
-  bottomRight: BottomRight$Outbound;
-  topLeft: TopLeft$Outbound;
+  bottomRight: SiteBoundingBoxAreaFilterBottomRight$Outbound;
+  topLeft: SiteBoundingBoxAreaFilterTopLeft$Outbound;
   type: "boundingBox";
 };
 
@@ -100,8 +112,10 @@ export const SiteBoundingBoxAreaFilter$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SiteBoundingBoxAreaFilter
 > = z.object({
-  bottomRight: z.lazy(() => BottomRight$outboundSchema),
-  topLeft: z.lazy(() => TopLeft$outboundSchema),
+  bottomRight: z.lazy(() =>
+    SiteBoundingBoxAreaFilterBottomRight$outboundSchema
+  ),
+  topLeft: z.lazy(() => SiteBoundingBoxAreaFilterTopLeft$outboundSchema),
   type: z.literal("boundingBox"),
 });
 

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

@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 /**
  * Spatial relation between the site boundary and this multi-polygon. Defaults to "intersects". See SitePolygonAreaFilter for relation definitions.
  */
-export const Relation = {
+export const SiteMultiPolygonAreaFilterRelation = {
   Intersects: "intersects",
   Within: "within",
   Contains: "contains",
@@ -16,7 +16,9 @@ export const Relation = {
 /**
  * Spatial relation between the site boundary and this multi-polygon. Defaults to "intersects". See SitePolygonAreaFilter for relation definitions.
  */
-export type Relation = ClosedEnum<typeof Relation>;
+export type SiteMultiPolygonAreaFilterRelation = ClosedEnum<
+  typeof SiteMultiPolygonAreaFilterRelation
+>;
 
 export type SiteMultiPolygonAreaFilter = {
   /**
@@ -26,13 +28,14 @@ export type SiteMultiPolygonAreaFilter = {
   /**
    * Spatial relation between the site boundary and this multi-polygon. Defaults to "intersects". See SitePolygonAreaFilter for relation definitions.
    */
-  relation?: Relation | undefined;
+  relation?: SiteMultiPolygonAreaFilterRelation | undefined;
   type: "multipolygon";
 };
 
 /** @internal */
-export const Relation$outboundSchema: z.ZodNativeEnum<typeof Relation> = z
-  .nativeEnum(Relation);
+export const SiteMultiPolygonAreaFilterRelation$outboundSchema: z.ZodNativeEnum<
+  typeof SiteMultiPolygonAreaFilterRelation
+> = z.nativeEnum(SiteMultiPolygonAreaFilterRelation);
 
 /** @internal */
 export type SiteMultiPolygonAreaFilter$Outbound = {
@@ -48,7 +51,7 @@ export const SiteMultiPolygonAreaFilter$outboundSchema: z.ZodType<
   SiteMultiPolygonAreaFilter
 > = z.object({
   coordinates: z.array(z.array(z.array(z.array(z.number())))),
-  relation: Relation$outboundSchema.optional(),
+  relation: SiteMultiPolygonAreaFilterRelation$outboundSchema.optional(),
   type: z.literal("multipolygon"),
 });
 

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

@@ -40,7 +40,7 @@ export type SiteQueryRequestOrder = ClosedEnum<typeof SiteQueryRequestOrder>;
 /**
  * Sort results by distance from a reference point, calculated from the site centroid. Applied after any field-based sort — acts as a tiebreaker when field sort values are equal.
  */
-export type GeoSort = {
+export type SiteQueryRequestGeoSort = {
   /**
    * Latitude of the reference point (WGS84)
    */
@@ -159,7 +159,7 @@ export type SiteQueryRequest = {
   /**
    * Sort results by distance from a reference point, calculated from the site centroid. Applied after any field-based sort — acts as a tiebreaker when field sort values are equal.
    */
-  geoSort?: GeoSort | undefined;
+  geoSort?: SiteQueryRequestGeoSort | undefined;
   /**
    * Number of results to return per page (1-1000)
    */
@@ -202,25 +202,29 @@ export const SiteQueryRequestOrder$outboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(SiteQueryRequestOrder);
 
 /** @internal */
-export type GeoSort$Outbound = {
+export type SiteQueryRequestGeoSort$Outbound = {
   lat: number;
   lon: number;
   order: string;
 };
 
 /** @internal */
-export const GeoSort$outboundSchema: z.ZodType<
-  GeoSort$Outbound,
+export const SiteQueryRequestGeoSort$outboundSchema: z.ZodType<
+  SiteQueryRequestGeoSort$Outbound,
   z.ZodTypeDef,
-  GeoSort
+  SiteQueryRequestGeoSort
 > = z.object({
   lat: z.number(),
   lon: z.number(),
   order: SiteQueryRequestOrder$outboundSchema.default("asc"),
 });
 
-export function geoSortToJSON(geoSort: GeoSort): string {
-  return JSON.stringify(GeoSort$outboundSchema.parse(geoSort));
+export function siteQueryRequestGeoSortToJSON(
+  siteQueryRequestGeoSort: SiteQueryRequestGeoSort,
+): string {
+  return JSON.stringify(
+    SiteQueryRequestGeoSort$outboundSchema.parse(siteQueryRequestGeoSort),
+  );
 }
 
 /** @internal */
@@ -276,7 +280,7 @@ export type SiteQueryRequest$Outbound = {
   area?: Array<SiteAreaFilter$Outbound> | undefined;
   attributes?: string | Array<string> | undefined;
   filters?: SiteFilters$Outbound | undefined;
-  geoSort?: GeoSort$Outbound | undefined;
+  geoSort?: SiteQueryRequestGeoSort$Outbound | undefined;
   limit: number;
   offset: number;
   query?: Array<SiteQueryOperator$Outbound> | undefined;
@@ -292,7 +296,7 @@ export const SiteQueryRequest$outboundSchema: z.ZodType<
   area: z.array(SiteAreaFilter$outboundSchema).optional(),
   attributes: z.union([z.string(), z.array(z.string())]).optional(),
   filters: SiteFilters$outboundSchema.optional(),
-  geoSort: z.lazy(() => GeoSort$outboundSchema).optional(),
+  geoSort: z.lazy(() => SiteQueryRequestGeoSort$outboundSchema).optional(),
   limit: z.number().default(25),
   offset: z.number().default(0),
   query: z.array(SiteQueryOperator$outboundSchema).optional(),

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

@@ -0,0 +1,89 @@
+/*
+ * 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";
+
+/**
+ * Machine-readable skip code so clients can map to UI text.
+ */
+export const Code = {
+  NoCoverageForLpa: "no_coverage_for_lpa",
+  NoCoverageForSchool: "no_coverage_for_school",
+  NoPolygonIntersects: "no_polygon_intersects",
+  NoOutcomesInYear: "no_outcomes_in_year",
+  NoFaithJurisdictionForSchool: "no_faith_jurisdiction_for_school",
+  NoFeederLinkResolves: "no_feeder_link_resolves",
+  OutOfMaxDistance: "out_of_max_distance",
+} as const;
+/**
+ * Machine-readable skip code so clients can map to UI text.
+ */
+export type Code = OpenEnum<typeof Code>;
+
+/**
+ * Match basis tier. 'designated_polygon' (Tier 1, hard): point is inside the LA-published catchment polygon. 'last_admitted_distance' (Tier 2, indicative): property is within last year's furthest admitted-pupil distance. 'faith_jurisdiction' (Tier 3, hard): point is inside a parish/diocese tied to the school's faith criterion. 'feeder_link' (Tier 4, hard): the school is named as a feeder target by another already-matched school. 'distance_ranking' (Tier 5, soft): nearest-N fallback so the result set is never empty.
+ */
+export const TierSkipReasonTier = {
+  DesignatedPolygon: "designated_polygon",
+  LastAdmittedDistance: "last_admitted_distance",
+  FaithJurisdiction: "faith_jurisdiction",
+  FeederLink: "feeder_link",
+  DistanceRanking: "distance_ranking",
+} as const;
+/**
+ * Match basis tier. 'designated_polygon' (Tier 1, hard): point is inside the LA-published catchment polygon. 'last_admitted_distance' (Tier 2, indicative): property is within last year's furthest admitted-pupil distance. 'faith_jurisdiction' (Tier 3, hard): point is inside a parish/diocese tied to the school's faith criterion. 'feeder_link' (Tier 4, hard): the school is named as a feeder target by another already-matched school. 'distance_ranking' (Tier 5, soft): nearest-N fallback so the result set is never empty.
+ */
+export type TierSkipReasonTier = OpenEnum<typeof TierSkipReasonTier>;
+
+export type TierSkipReason = {
+  /**
+   * Machine-readable skip code so clients can map to UI text.
+   */
+  code: Code;
+  /**
+   * Human-readable explanation suitable for end-user display.
+   */
+  reason: string;
+  /**
+   * Match basis tier. 'designated_polygon' (Tier 1, hard): point is inside the LA-published catchment polygon. 'last_admitted_distance' (Tier 2, indicative): property is within last year's furthest admitted-pupil distance. 'faith_jurisdiction' (Tier 3, hard): point is inside a parish/diocese tied to the school's faith criterion. 'feeder_link' (Tier 4, hard): the school is named as a feeder target by another already-matched school. 'distance_ranking' (Tier 5, soft): nearest-N fallback so the result set is never empty.
+   */
+  tier: TierSkipReasonTier;
+};
+
+/** @internal */
+export const Code$inboundSchema: z.ZodType<Code, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Code);
+
+/** @internal */
+export const TierSkipReasonTier$inboundSchema: z.ZodType<
+  TierSkipReasonTier,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TierSkipReasonTier);
+
+/** @internal */
+export const TierSkipReason$inboundSchema: z.ZodType<
+  TierSkipReason,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: Code$inboundSchema,
+  reason: z.string(),
+  tier: TierSkipReasonTier$inboundSchema,
+});
+
+export function tierSkipReasonFromJSON(
+  jsonString: string,
+): SafeParseResult<TierSkipReason, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TierSkipReason$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TierSkipReason' from JSON`,
+  );
+}

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

@@ -13,7 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * HMLR document type
  */
-export const DocumentType = {
+export const TitleDeedDocumentListResponseDocumentType = {
   RegisterExtract: "register-extract",
   OfficialTitle: "official-title",
   TitlePlan: "title-plan",
@@ -21,7 +21,9 @@ export const DocumentType = {
 /**
  * HMLR document type
  */
-export type DocumentType = OpenEnum<typeof DocumentType>;
+export type TitleDeedDocumentListResponseDocumentType = OpenEnum<
+  typeof TitleDeedDocumentListResponseDocumentType
+>;
 
 /**
  * Document processing status: pending (being processed), uploaded (ready to download), or failed
@@ -46,7 +48,7 @@ export type Documents = {
   /**
    * HMLR document type
    */
-  documentType: DocumentType;
+  documentType: TitleDeedDocumentListResponseDocumentType;
   /**
    * Relative URL for downloading the document (null unless status is uploaded)
    */
@@ -79,11 +81,11 @@ export type TitleDeedDocumentListResponse = {
 };
 
 /** @internal */
-export const DocumentType$inboundSchema: z.ZodType<
-  DocumentType,
+export const TitleDeedDocumentListResponseDocumentType$inboundSchema: z.ZodType<
+  TitleDeedDocumentListResponseDocumentType,
   z.ZodTypeDef,
   unknown
-> = openEnums.inboundSchema(DocumentType);
+> = openEnums.inboundSchema(TitleDeedDocumentListResponseDocumentType);
 
 /** @internal */
 export const TitleDeedDocumentListResponseStatus$inboundSchema: z.ZodType<
@@ -99,7 +101,7 @@ export const Documents$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   content_type: z.string(),
-  document_type: DocumentType$inboundSchema,
+  document_type: TitleDeedDocumentListResponseDocumentType$inboundSchema,
   download_url: z.nullable(z.string()),
   size_bytes: z.nullable(z.number()),
   status: TitleDeedDocumentListResponseStatus$inboundSchema,