@vepler/sdk 2.158.0 → 2.167.0

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

@@ -0,0 +1,174 @@
+/*
+ * 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 {
+  DesignationGeometry,
+  DesignationGeometry$inboundSchema,
+} from "./designationgeometry.js";
+import { Provenance, Provenance$inboundSchema } from "./provenance.js";
+
+/**
+ * Honest precision of `designatedDate` (heritage). Absent where the product carries no precision flag.
+ */
+export const LandConstraintDesignationFeatureDatePrecision = {
+  Day: "day",
+  Month: "month",
+  Year: "year",
+  None: "none",
+} as const;
+/**
+ * Honest precision of `designatedDate` (heritage). Absent where the product carries no precision flag.
+ */
+export type LandConstraintDesignationFeatureDatePrecision = OpenEnum<
+  typeof LandConstraintDesignationFeatureDatePrecision
+>;
+
+/**
+ * UK home nation — identity-tuple component.
+ */
+export const LandConstraintDesignationFeatureNation = {
+  Eng: "ENG",
+  Sco: "SCO",
+  Wal: "WAL",
+  Nir: "NIR",
+} as const;
+/**
+ * UK home nation — identity-tuple component.
+ */
+export type LandConstraintDesignationFeatureNation = OpenEnum<
+  typeof LandConstraintDesignationFeatureNation
+>;
+
+export type LandConstraintDesignationFeature = {
+  amendedDate?: string | null | undefined;
+  areaHectares?: number | null | undefined;
+  /**
+   * Required attribution string — mandatory, never permission-gated.
+   */
+  attribution: string | null;
+  /**
+   * Custodian / harmonised class label.
+   */
+  category?: string | null | undefined;
+  /**
+   * Honest precision of `designatedDate` (heritage). Absent where the product carries no precision flag.
+   */
+  datePrecision?: LandConstraintDesignationFeatureDatePrecision | undefined;
+  /**
+   * ISO-8601 date or null — read with `datePrecision`.
+   */
+  designatedDate?: string | null | undefined;
+  /**
+   * Date lineage — requires `designationSourceData`.
+   */
+  designatedDateSource?: string | null | undefined;
+  /**
+   * Stable id: design.{product}.{nation}.{type}.{reference}. Survives re-publish; omits the snapshot.
+   */
+  designationId: string;
+  /**
+   * Designation dataset (open enum).
+   */
+  designationType: string;
+  /**
+   * Metres from the query point to the designation boundary (0 if inside). Spatial queries only.
+   */
+  distanceM?: number | null | undefined;
+  geometry: DesignationGeometry;
+  /**
+   * OGL licence identifier — mandatory, never permission-gated.
+   */
+  licence: string | null;
+  localAuthority?: string | null | undefined;
+  /**
+   * Whitelist-projected custodian metadata — requires `designationSourceData`; never dumped raw. Keys are present only where the source carries them and vary by `designationType`: `status`, `legal_regime`, `woodland_composition`, `native_pct`, `canopy_pct`, `dominant_habitat`, `maturity`, `parish`, `geographic_location`, `stat_area_km2`.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  name?: string | null | undefined;
+  /**
+   * Welsh-language name, where the source is bilingual.
+   */
+  nameCy?: string | null | undefined;
+  /**
+   * UK home nation — identity-tuple component.
+   */
+  nation: LandConstraintDesignationFeatureNation;
+  /**
+   * Universal provenance block — every product envelope carries this
+   */
+  provenance: Provenance;
+  /**
+   * Custodian register reference — identity-tuple component.
+   */
+  reference: string;
+  /**
+   * Custodian register id — requires `designationSourceData`.
+   */
+  source?: string | undefined;
+  /**
+   * Public custodian list-entry URL (OGL).
+   */
+  sourceUrl?: string | null | undefined;
+};
+
+/** @internal */
+export const LandConstraintDesignationFeatureDatePrecision$inboundSchema:
+  z.ZodType<
+    LandConstraintDesignationFeatureDatePrecision,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(LandConstraintDesignationFeatureDatePrecision);
+
+/** @internal */
+export const LandConstraintDesignationFeatureNation$inboundSchema: z.ZodType<
+  LandConstraintDesignationFeatureNation,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(LandConstraintDesignationFeatureNation);
+
+/** @internal */
+export const LandConstraintDesignationFeature$inboundSchema: z.ZodType<
+  LandConstraintDesignationFeature,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amendedDate: z.nullable(z.string()).optional(),
+  areaHectares: z.nullable(z.number()).optional(),
+  attribution: z.nullable(z.string()),
+  category: z.nullable(z.string()).optional(),
+  datePrecision: LandConstraintDesignationFeatureDatePrecision$inboundSchema
+    .optional(),
+  designatedDate: z.nullable(z.string()).optional(),
+  designatedDateSource: z.nullable(z.string()).optional(),
+  designationId: z.string(),
+  designationType: z.string(),
+  distanceM: z.nullable(z.number()).optional(),
+  geometry: DesignationGeometry$inboundSchema,
+  licence: z.nullable(z.string()),
+  localAuthority: z.nullable(z.string()).optional(),
+  metadata: z.record(z.any()).optional(),
+  name: z.nullable(z.string()).optional(),
+  nameCy: z.nullable(z.string()).optional(),
+  nation: LandConstraintDesignationFeatureNation$inboundSchema,
+  provenance: Provenance$inboundSchema,
+  reference: z.string(),
+  source: z.string().optional(),
+  sourceUrl: z.nullable(z.string()).optional(),
+});
+
+export function landConstraintDesignationFeatureFromJSON(
+  jsonString: string,
+): SafeParseResult<LandConstraintDesignationFeature, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LandConstraintDesignationFeature$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LandConstraintDesignationFeature' from JSON`,
+  );
+}

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

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  LandConstraintDesignationFeature,
+  LandConstraintDesignationFeature$inboundSchema,
+} from "./landconstraintdesignationfeature.js";
+
+/**
+ * Object type identifier
+ */
+export const LandConstraintDesignationListResponseObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type LandConstraintDesignationListResponseObject = ClosedEnum<
+  typeof LandConstraintDesignationListResponseObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type LandConstraintDesignationListResponse = {
+  /**
+   * Array of items
+   */
+  data: Array<LandConstraintDesignationFeature>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: LandConstraintDesignationListResponseObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export const LandConstraintDesignationListResponseObject$inboundSchema:
+  z.ZodNativeEnum<typeof LandConstraintDesignationListResponseObject> = z
+    .nativeEnum(LandConstraintDesignationListResponseObject);
+
+/** @internal */
+export const LandConstraintDesignationListResponse$inboundSchema: z.ZodType<
+  LandConstraintDesignationListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(LandConstraintDesignationFeature$inboundSchema),
+  has_more: z.boolean(),
+  object: LandConstraintDesignationListResponseObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function landConstraintDesignationListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<LandConstraintDesignationListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      LandConstraintDesignationListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LandConstraintDesignationListResponse' from JSON`,
+  );
+}

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

@@ -78,6 +78,20 @@ export type Seller = {
   name?: string | null | undefined;
 };
 
+/**
+ * Source provider and provider-specific key for this listing. Permission-gated: only returned to callers with `sourceData` access (stripped otherwise).
+ */
+export type Source = {
+  /**
+   * Provider-specific listing key.
+   */
+  key: string;
+  /**
+   * Data provider identifier for this listing.
+   */
+  provider: string;
+};
+
 /**
  * Listing status
  */
@@ -148,6 +162,10 @@ export type Listing = {
    * Seller information
    */
   seller?: Seller | undefined;
+  /**
+   * Source provider and provider-specific key for this listing. Permission-gated: only returned to callers with `sourceData` access (stripped otherwise).
+   */
+  source?: Source | undefined;
   /**
    * Listing status
    */
@@ -240,6 +258,23 @@ export function sellerFromJSON(
   );
 }
 
+/** @internal */
+export const Source$inboundSchema: z.ZodType<Source, z.ZodTypeDef, unknown> = z
+  .object({
+    key: z.string(),
+    provider: z.string(),
+  });
+
+export function sourceFromJSON(
+  jsonString: string,
+): SafeParseResult<Source, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Source$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Source' from JSON`,
+  );
+}
+
 /** @internal */
 export const ListingStatus$inboundSchema: z.ZodType<
   ListingStatus,
@@ -271,6 +306,7 @@ export const Listing$inboundSchema: z.ZodType<Listing, z.ZodTypeDef, unknown> =
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ).optional(),
     seller: z.lazy(() => Seller$inboundSchema).optional(),
+    source: z.lazy(() => Source$inboundSchema).optional(),
     status: ListingStatus$inboundSchema.optional(),
     type: ListingType$inboundSchema.optional(),
   });

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

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type NestedAggregationResult = {
+  /**
+   * Documents matched within the nested context (present on the outer wrapper).
+   */
+  docCount?: number | undefined;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const NestedAggregationResult$inboundSchema: z.ZodType<
+  NestedAggregationResult,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    doc_count: z.number().optional(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+).transform((v) => {
+  return remap$(v, {
+    "doc_count": "docCount",
+  });
+});
+
+export function nestedAggregationResultFromJSON(
+  jsonString: string,
+): SafeParseResult<NestedAggregationResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NestedAggregationResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NestedAggregationResult' from JSON`,
+  );
+}

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

@@ -232,7 +232,7 @@ export type GeoJSONPoint = {
 /**
  * The geometry of this feature. May be a Point (site centroid), Polygon (single boundary), or MultiPolygon (disjoint site areas). Null if the geometry could not be parsed from the source data. Coordinates are in [longitude, latitude] order (WGS84, EPSG:4326).
  */
-export type Geometry =
+export type PlanningApplicationGeometry =
   | GeoJSONPoint
   | PlanningApplicationGeoJSONPolygon
   | PlanningApplicationGeoJSONMultiPolygon;
@@ -644,8 +644,8 @@ export function geoJSONPointFromJSON(
 }
 
 /** @internal */
-export const Geometry$inboundSchema: z.ZodType<
-  Geometry,
+export const PlanningApplicationGeometry$inboundSchema: z.ZodType<
+  PlanningApplicationGeometry,
   z.ZodTypeDef,
   unknown
 > = z.union([
@@ -654,13 +654,13 @@ export const Geometry$inboundSchema: z.ZodType<
   z.lazy(() => PlanningApplicationGeoJSONMultiPolygon$inboundSchema),
 ]);
 
-export function geometryFromJSON(
+export function planningApplicationGeometryFromJSON(
   jsonString: string,
-): SafeParseResult<Geometry, SDKValidationError> {
+): SafeParseResult<PlanningApplicationGeometry, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Geometry$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Geometry' from JSON`,
+    (x) => PlanningApplicationGeometry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningApplicationGeometry' from JSON`,
   );
 }
 

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

@@ -0,0 +1,44 @@
+/*
+ * 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 {
+  ConservationAssessments,
+  ConservationAssessments$inboundSchema,
+} from "./conservationassessments.js";
+import {
+  HeritageAssessments,
+  HeritageAssessments$inboundSchema,
+} from "./heritageassessments.js";
+
+/**
+ * Heritage and conservation designation assessments — per-product zone membership (inside / nearest / clear) with provenance. An absent product means not assessed.
+ */
+export type PropertyAssessments = {
+  conservation?: ConservationAssessments | undefined;
+  heritage?: HeritageAssessments | undefined;
+};
+
+/** @internal */
+export const PropertyAssessments$inboundSchema: z.ZodType<
+  PropertyAssessments,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  conservation: ConservationAssessments$inboundSchema.optional(),
+  heritage: HeritageAssessments$inboundSchema.optional(),
+});
+
+export function propertyAssessmentsFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAssessments, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyAssessments$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAssessments' from JSON`,
+  );
+}

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

@@ -25,6 +25,10 @@ import {
   PropertyAddress,
   PropertyAddress$inboundSchema,
 } from "./propertyaddress.js";
+import {
+  PropertyAssessments,
+  PropertyAssessments$inboundSchema,
+} from "./propertyassessments.js";
 import { PropertyTags, PropertyTags$inboundSchema } from "./propertytags.js";
 import {
   RefurbishmentData,
@@ -402,6 +406,10 @@ export type PropertyDataApi = {
    */
   provenance?: { [k: string]: { [k: string]: any } } | undefined;
   address?: PropertyAddress | undefined;
+  /**
+   * Heritage and conservation designation assessments — per-product zone membership (inside / nearest / clear) with provenance. An absent product means not assessed.
+   */
+  assessments?: PropertyAssessments | undefined;
   build?: BuildData | undefined;
   /**
    * Physical building data from OS NGD and EPC
@@ -857,6 +865,7 @@ export const PropertyDataApi$inboundSchema: z.ZodType<
 > = z.object({
   _provenance: z.record(z.record(z.any())).optional(),
   address: PropertyAddress$inboundSchema.optional(),
+  assessments: PropertyAssessments$inboundSchema.optional(),
   build: BuildData$inboundSchema.optional(),
   building: z.nullable(z.lazy(() => PropertyDataApiBuilding$inboundSchema))
     .optional(),

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

@@ -35,14 +35,14 @@ export type SearchResultCoordinates = {
 /**
  * Data source for this result
  */
-export const Source = {
+export const SearchResultSource = {
   Address: "address",
   Location: "location",
 } as const;
 /**
  * Data source for this result
  */
-export type Source = OpenEnum<typeof Source>;
+export type SearchResultSource = OpenEnum<typeof SearchResultSource>;
 
 export type SearchResult = {
   /**
@@ -108,7 +108,7 @@ export type SearchResult = {
   /**
    * Data source for this result
    */
-  source: Source;
+  source: SearchResultSource;
   /**
    * Result title
    */
@@ -144,8 +144,11 @@ export function searchResultCoordinatesFromJSON(
 }
 
 /** @internal */
-export const Source$inboundSchema: z.ZodType<Source, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Source);
+export const SearchResultSource$inboundSchema: z.ZodType<
+  SearchResultSource,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SearchResultSource);
 
 /** @internal */
 export const SearchResult$inboundSchema: z.ZodType<
@@ -169,7 +172,7 @@ export const SearchResult$inboundSchema: z.ZodType<
   relevanceScore: z.number(),
   score: z.number(),
   secondary_text: z.string().optional(),
-  source: Source$inboundSchema,
+  source: SearchResultSource$inboundSchema,
   title: z.string(),
   type: z.string(),
   uprn: z.string().optional(),

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

@@ -4,7 +4,10 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../../lib/primitives.js";
-import { safeParse } from "../../../lib/schemas.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
@@ -22,6 +25,7 @@ export type TermsBucket = {
    * Distinct value for this bucket
    */
   key: string | number | boolean;
+  additionalProperties?: { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -44,10 +48,14 @@ export const TermsBucket$inboundSchema: z.ZodType<
   TermsBucket,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  doc_count: z.number(),
-  key: z.union([z.string(), z.number(), z.boolean()]),
-}).transform((v) => {
+> = collectExtraKeys$(
+  z.object({
+    doc_count: z.number(),
+    key: z.union([z.string(), z.number(), z.boolean()]),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+).transform((v) => {
   return remap$(v, {
     "doc_count": "docCount",
   });

package/src/sdk/schoolscatchment.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { schoolsCatchmentGetAdmissionArea } from "../funcs/schoolsCatchmentGetAdmissionArea.js";
 import { schoolsCatchmentGetBySchool } from "../funcs/schoolsCatchmentGetBySchool.js";
 import { schoolsCatchmentGetCoverage } from "../funcs/schoolsCatchmentGetCoverage.js";
 import { schoolsQuerySchools } from "../funcs/schoolsQuerySchools.js";
@@ -11,6 +12,23 @@ import * as shared from "./models/shared/index.js";
 import { unwrapAsync } from "./types/fp.js";
 
 export class SchoolsCatchment extends ClientSDK {
+  /**
+   * Per-school unified admission area
+   *
+   * @remarks
+   * Returns a school's admission boundary in whatever form the data supports, as one GeoJSON FeatureCollection: `polygon` features for hard designated catchments, plus a `distance_radius` feature (school centre `Point` + `radiusM`) when last year's furthest-admitted-pupil distance is known. Lets a client draw a polygon or a circle from a single call. Use `academicYear` to pin the radius year and `asOfDate` for historic polygons.
+   */
+  async getAdmissionArea(
+    request: operations.GetSchoolAdmissionAreaRequest,
+    options?: RequestOptions,
+  ): Promise<shared.AdmissionAreaResponse> {
+    return unwrapAsync(schoolsCatchmentGetAdmissionArea(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Per-school catchment geometry
    *

package/src/sdk/sdk.ts

@@ -11,10 +11,13 @@ import { Buildings } from "./buildings.js";
 import { Census } from "./census.js";
 import { Companies } from "./companies.js";
 import { Connectivity } from "./connectivity.js";
+import { Conservation } from "./conservation.js";
 import { Councils } from "./councils.js";
 import { Energy } from "./energy.js";
 import { Epc } from "./epc.js";
 import { FloodRisk } from "./floodrisk.js";
+import { Heritage } from "./heritage.js";
+import { LandConstraint } from "./landconstraint.js";
 import { Listings } from "./listings.js";
 import { Metrics } from "./metrics.js";
 import { Planning } from "./planning.js";
@@ -87,6 +90,11 @@ export class SDK extends ClientSDK {
     return (this._companies ??= new Companies(this._options));
   }
 
+  private _conservation?: Conservation;
+  get conservation(): Conservation {
+    return (this._conservation ??= new Conservation(this._options));
+  }
+
   private _councils?: Councils;
   get councils(): Councils {
     return (this._councils ??= new Councils(this._options));
@@ -107,6 +115,16 @@ export class SDK extends ClientSDK {
     return (this._floodRisk ??= new FloodRisk(this._options));
   }
 
+  private _heritage?: Heritage;
+  get heritage(): Heritage {
+    return (this._heritage ??= new Heritage(this._options));
+  }
+
+  private _landConstraint?: LandConstraint;
+  get landConstraint(): LandConstraint {
+    return (this._landConstraint ??= new LandConstraint(this._options));
+  }
+
   private _listings?: Listings;
   get listings(): Listings {
     return (this._listings ??= new Listings(this._options));