@vepler/sdk 6.50.12 → 6.57.1

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

@@ -83,6 +83,7 @@ export * from "./getschoolbysource.js";
 export * from "./getschoolmetrics.js";
 export * from "./getschoolscoverage.js";
 export * from "./getsitebyid.js";
+export * from "./getsiteland.js";
 export * from "./getsitetiles.js";
 export * from "./getsubstationbycode.js";
 export * from "./getsubstationcapacity.js";

package/src/sdk/models/operations/getsitebyid.ts

@@ -5,6 +5,10 @@
 import * as z from "zod/v3";
 
 export type GetSiteByIdRequest = {
+  /**
+   * Extra fields to return, as one comma-separated string such as "buildings,buildingIds". They are added to the fields the endpoint returns by default. Name `buildings` to get the summary of every building on the title, or `buildingIds` for their identifiers alone.
+   */
+  attributes?: string | undefined;
   /**
    * Identifier for a single registered title, made up of the country, the registry and the title number joined by colons.
    */
@@ -13,6 +17,7 @@ export type GetSiteByIdRequest = {
 
 /** @internal */
 export type GetSiteByIdRequest$Outbound = {
+  attributes?: string | undefined;
   siteId: string;
 };
 
@@ -22,6 +27,7 @@ export const GetSiteByIdRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetSiteByIdRequest
 > = z.object({
+  attributes: z.string().optional(),
   siteId: z.string(),
 });
 

package/src/sdk/models/operations/getsiteland.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetSiteLandRequest = {
+  /**
+   * Optional fields to add to each land polygon, as one comma-separated string. The only optional field is `geometry`, the polygon boundary, which is left out by default because of its size.
+   */
+  attributes?: string | undefined;
+  /**
+   * Maximum number of land polygons to return. Defaults to 25. Minimum 1, maximum 100.
+   */
+  limit?: number | undefined;
+  /**
+   * Number of land polygons to skip before the first one returned. Defaults to 0.
+   */
+  offset?: number | null | undefined;
+  /**
+   * Identifier for a single registered title, made up of the country, the registry and the title number joined by colons.
+   */
+  siteId: string;
+};
+
+/** @internal */
+export type GetSiteLandRequest$Outbound = {
+  attributes?: string | undefined;
+  limit: number;
+  offset: number | null;
+  siteId: string;
+};
+
+/** @internal */
+export const GetSiteLandRequest$outboundSchema: z.ZodType<
+  GetSiteLandRequest$Outbound,
+  z.ZodTypeDef,
+  GetSiteLandRequest
+> = z.object({
+  attributes: z.string().optional(),
+  limit: z.number().int().default(25),
+  offset: z.nullable(z.number().int().default(0)),
+  siteId: z.string(),
+});
+
+export function getSiteLandRequestToJSON(
+  getSiteLandRequest: GetSiteLandRequest,
+): string {
+  return JSON.stringify(
+    GetSiteLandRequest$outboundSchema.parse(getSiteLandRequest),
+  );
+}

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

@@ -85,6 +85,7 @@ export * from "./getschoolbyid.js";
 export * from "./getschoolbysource.js";
 export * from "./getschoolmetrics.js";
 export * from "./getsitebyid.js";
+export * from "./getsiteland.js";
 export * from "./getsitetiles.js";
 export * from "./getsubstationbycode.js";
 export * from "./getsubstationcapacity.js";

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

@@ -253,7 +253,7 @@ export type GeoJSONMultiPolygon = {
 /**
  * An area expressed as a GeoJSON Polygon geometry.
  */
-export type GeoJSONPolygon = {
+export type BuildingGeoJSONPolygon = {
   /**
    * The rings that make up the polygon. The first ring is the outer boundary and any further rings are holes inside it. Each ring needs at least four positions and closes by repeating its first position as the last.
    */
@@ -268,7 +268,7 @@ export type GeoJSONPolygon = {
  * Outline of the building, as a GeoJSON Polygon or MultiPolygon. Left out of the default attribute set because of its size; request it with `attributes: ["footprint"]`.
  */
 export type Footprint =
-  | GeoJSONPolygon
+  | BuildingGeoJSONPolygon
   | GeoJSONMultiPolygon
   | discriminatedUnionTypes.Unknown<"type">;
 
@@ -568,7 +568,7 @@ export type Building = {
    * Outline of the building, as a GeoJSON Polygon or MultiPolygon. Left out of the default attribute set because of its size; request it with `attributes: ["footprint"]`.
    */
   footprint?:
-    | GeoJSONPolygon
+    | BuildingGeoJSONPolygon
     | GeoJSONMultiPolygon
     | discriminatedUnionTypes.Unknown<"type">
     | null
@@ -820,8 +820,8 @@ export function geoJSONMultiPolygonFromJSON(
 }
 
 /** @internal */
-export const GeoJSONPolygon$inboundSchema: z.ZodType<
-  GeoJSONPolygon,
+export const BuildingGeoJSONPolygon$inboundSchema: z.ZodType<
+  BuildingGeoJSONPolygon,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -829,13 +829,13 @@ export const GeoJSONPolygon$inboundSchema: z.ZodType<
   type: z.literal("Polygon"),
 });
 
-export function geoJSONPolygonFromJSON(
+export function buildingGeoJSONPolygonFromJSON(
   jsonString: string,
-): SafeParseResult<GeoJSONPolygon, SDKValidationError> {
+): SafeParseResult<BuildingGeoJSONPolygon, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => GeoJSONPolygon$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GeoJSONPolygon' from JSON`,
+    (x) => BuildingGeoJSONPolygon$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BuildingGeoJSONPolygon' from JSON`,
   );
 }
 
@@ -845,7 +845,7 @@ export const Footprint$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = discriminatedUnion("type", {
-  Polygon: z.lazy(() => GeoJSONPolygon$inboundSchema),
+  Polygon: z.lazy(() => BuildingGeoJSONPolygon$inboundSchema),
   MultiPolygon: z.lazy(() => GeoJSONMultiPolygon$inboundSchema),
 });
 
@@ -1004,7 +1004,7 @@ export const Building$inboundSchema: z.ZodType<
   floors: z.nullable(z.number().int()).optional(),
   footprint: z.nullable(
     discriminatedUnion("type", {
-      Polygon: z.lazy(() => GeoJSONPolygon$inboundSchema),
+      Polygon: z.lazy(() => BuildingGeoJSONPolygon$inboundSchema),
       MultiPolygon: z.lazy(() => GeoJSONMultiPolygon$inboundSchema),
     }),
   ).optional(),

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

@@ -389,8 +389,19 @@ export * from "./siteareafilter.js";
 export * from "./siteareametrics.js";
 export * from "./sitebatchidsrequest.js";
 export * from "./siteboundingboxareafilter.js";
+export * from "./sitebuilding.js";
+export * from "./sitebuildingcount.js";
+export * from "./sitebuildingprofile.js";
+export * from "./siteconstraintflags.js";
+export * from "./siteconstraintlayer.js";
+export * from "./siteconstraints.js";
+export * from "./siteconstraintunmeasured.js";
 export * from "./sitecontainspointareafilter.js";
 export * from "./sitefilters.js";
+export * from "./sitelandfeature.js";
+export * from "./sitelandlistresponse.js";
+export * from "./sitelandprofile.js";
+export * from "./sitelandshare.js";
 export * from "./siteleafaggregation.js";
 export * from "./sitelistresponse.js";
 export * from "./sitemultipolygonareafilter.js";

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

@@ -14,6 +14,19 @@ import {
   SiteAreaMetrics,
   SiteAreaMetrics$inboundSchema,
 } from "./siteareametrics.js";
+import { SiteBuilding, SiteBuilding$inboundSchema } from "./sitebuilding.js";
+import {
+  SiteBuildingProfile,
+  SiteBuildingProfile$inboundSchema,
+} from "./sitebuildingprofile.js";
+import {
+  SiteConstraints,
+  SiteConstraints$inboundSchema,
+} from "./siteconstraints.js";
+import {
+  SiteLandProfile,
+  SiteLandProfile$inboundSchema,
+} from "./sitelandprofile.js";
 import {
   SitePlanningStats,
   SitePlanningStats$inboundSchema,
@@ -148,7 +161,20 @@ export const SiteObject = {
 export type SiteObject = ClosedEnum<typeof SiteObject>;
 
 /**
- * Broad category the primary proprietor falls into, worked out from its entity type.
+ * Whether the title appears in HM Land Registry's monthly files of land held by UK and overseas companies. 'company' means it does, and its company proprietors are listed. 'not_in_register' means it does not as of `asOf`, so the title is held by one or more private individuals or by a body those files do not cover. 'not_loaded' means the files had not been loaded when this title was last assessed, so its company ownership is not known.
+ */
+export const Availability = {
+  Company: "company",
+  NotInRegister: "not_in_register",
+  NotLoaded: "not_loaded",
+} as const;
+/**
+ * Whether the title appears in HM Land Registry's monthly files of land held by UK and overseas companies. 'company' means it does, and its company proprietors are listed. 'not_in_register' means it does not as of `asOf`, so the title is held by one or more private individuals or by a body those files do not cover. 'not_loaded' means the files had not been loaded when this title was last assessed, so its company ownership is not known.
+ */
+export type Availability = OpenEnum<typeof Availability>;
+
+/**
+ * Broad category the primary proprietor falls into, worked out from its entity type. Null when no proprietor is recorded.
  */
 export const OwnershipCategory = {
   Company: "company",
@@ -158,12 +184,12 @@ export const OwnershipCategory = {
   Unknown: "unknown",
 } as const;
 /**
- * Broad category the primary proprietor falls into, worked out from its entity type.
+ * Broad category the primary proprietor falls into, worked out from its entity type. Null when no proprietor is recorded.
  */
 export type OwnershipCategory = OpenEnum<typeof OwnershipCategory>;
 
 /**
- * Which HM Land Registry record the ownership was taken from.
+ * Which HM Land Registry record the primary proprietor was taken from. Null when no proprietor is recorded.
  */
 export const SiteSource = {
   Ccod: "ccod",
@@ -172,14 +198,22 @@ export const SiteSource = {
   Manual: "manual",
 } as const;
 /**
- * Which HM Land Registry record the ownership was taken from.
+ * Which HM Land Registry record the primary proprietor was taken from. Null when no proprietor is recorded.
  */
 export type SiteSource = OpenEnum<typeof SiteSource>;
 
 /**
- * Registered ownership of the title. Null when no proprietor records are held for it. Requires the `sourceData` permission on the licence, and is left out of the response without it.
+ * Registered ownership of the title. Null when the title has not been assessed for ownership yet. Requires the `sourceData` permission on the licence, and is left out of the response without it.
  */
 export type Ownership = {
+  /**
+   * Month of the company ownership files that `availability` is based on, as YYYY-MM. For 'company', the month of the file the title appears in. For 'not_in_register', the earlier of the company and overseas-company files' months. Null when `availability` is 'not_loaded'.
+   */
+  asOf?: string | null | undefined;
+  /**
+   * Whether the title appears in HM Land Registry's monthly files of land held by UK and overseas companies. 'company' means it does, and its company proprietors are listed. 'not_in_register' means it does not as of `asOf`, so the title is held by one or more private individuals or by a body those files do not cover. 'not_loaded' means the files had not been loaded when this title was last assessed, so its company ownership is not known.
+   */
+  availability?: Availability | undefined;
   /**
    * Company registration number of the primary proprietor, where it is a company.
    */
@@ -193,21 +227,21 @@ export type Ownership = {
    */
   isJointOwnership?: boolean | undefined;
   /**
-   * Broad category the primary proprietor falls into, worked out from its entity type.
+   * Broad category the primary proprietor falls into, worked out from its entity type. Null when no proprietor is recorded.
    */
-  ownershipCategory?: OwnershipCategory | undefined;
+  ownershipCategory?: OwnershipCategory | null | undefined;
   /**
-   * Name of the primary proprietor.
+   * Name of the primary proprietor. Null when no proprietor is recorded.
    */
-  primaryOwnerName?: string | undefined;
+  primaryOwnerName?: string | null | undefined;
   /**
-   * Every proprietor recorded on the title, with the primary one first.
+   * Every proprietor recorded on the title, with the primary one first. Empty when none is recorded.
    */
   proprietors?: Array<SiteProprietor> | undefined;
   /**
-   * Which HM Land Registry record the ownership was taken from.
+   * Which HM Land Registry record the primary proprietor was taken from. Null when no proprietor is recorded.
    */
-  source?: SiteSource | undefined;
+  source?: SiteSource | null | undefined;
 };
 
 /**
@@ -256,6 +290,26 @@ export type Site = {
     | SiteGeoJSONMultiPolygon
     | discriminatedUnionTypes.Unknown<"type">
     | undefined;
+  /**
+   * Identifiers of the buildings whose footprint intersects the title, for use with the buildings endpoints. Left out of the default attribute set; request it with `attributes: ["buildingIds"]`. Requires the `osNgdAccess` permission on the licence.
+   */
+  buildingIds?: Array<string> | undefined;
+  /**
+   * The buildings whose footprint intersects the title, measured on the title boundary. Requires the `osNgdAccess` permission on the licence, and is left out of the response without it.
+   */
+  buildingProfile?: SiteBuildingProfile | undefined;
+  /**
+   * The buildings whose footprint intersects the title, each as the summary the buildings endpoints serve for that building, in identifier order. Holds at most the configured cap of buildings; when `buildingsTruncated` is true because the title has more buildings than the cap, the full set is available from the buildings query endpoint filtered by this site identifier. Left out of the default attribute set because of its size; request it with `attributes: ["buildings"]`. Requires the `osNgdAccess` permission on the licence.
+   */
+  buildings?: Array<SiteBuilding> | undefined;
+  /**
+   * Number of buildings whose footprint intersects the title. The same count as `buildingProfile.count`. Requires the `osNgdAccess` permission on the licence.
+   */
+  buildingsTotal?: number | undefined;
+  /**
+   * Whether `buildings` holds fewer buildings than `buildingsTotal`, either because the title has more buildings than the configured cap or because a building has no record on the buildings endpoints yet. Requires the `osNgdAccess` permission on the licence.
+   */
+  buildingsTruncated?: boolean | undefined;
   /**
    * Centre point of the title boundary. Present whenever the site has a boundary, unless `centroid` is left out of the requested attributes.
    */
@@ -264,6 +318,10 @@ export type Site = {
    * HM Land Registry class of title code, which records the quality of the title and the tenure it is held under. Left out of the default attribute set; request it with `attributes: ["classTitleCode"]`.
    */
   classTitleCode?: ClassTitleCode | null | undefined;
+  /**
+   * Planning designations and environmental hazards measured over the whole title boundary, each with the share of the title it covers. This supersedes `overlays`, which is read at the centre point of the site.
+   */
+  constraints?: SiteConstraints | undefined;
   /**
    * Country the title is registered in, as an ISO 3166-1 alpha-2 code.
    */
@@ -272,6 +330,10 @@ export type Site = {
    * HM Land Registry estate interest code, which records the kind of interest the title covers. Almost always `EL`, an estate in land. It does not distinguish freehold from leasehold; read `classTitleCode` or `tenureType` for that. Left out of the default attribute set; request it with `attributes: ["estateInterestCode"]`.
    */
   estateInterestCode?: EstateInterestCode | null | undefined;
+  /**
+   * Land cover and use composition of the title, measured on the title boundary. Requires the `osNgdAccess` permission on the licence, and is left out of the response without it.
+   */
+  landProfile?: SiteLandProfile | undefined;
   /**
    * Land use classifications recorded for the site.
    */
@@ -289,11 +351,11 @@ export type Site = {
    */
   object?: SiteObject | undefined;
   /**
-   * Codes for the designations and hazards recorded against this site, covering flood risk, road and rail noise, radon, landfill proximity and protected-area designations. The set is open rather than fixed: it depends on which area datasets cover the site.
+   * Codes for the designations and hazards recorded against this site, covering flood risk, road and rail noise, radon, landfill proximity and protected-area designations. `GREEN_BELT`, `CONSERVATION_AREA`, `SSSI` and `LISTED_BUILDING_CURTILAGE` are present when the matching flag in `constraints.flags` is true; the other codes are read at the centre point of the site. The set is open rather than fixed: it depends on which area datasets cover the site.
    */
   overlays?: Array<string> | undefined;
   /**
-   * Registered ownership of the title. Null when no proprietor records are held for it. Requires the `sourceData` permission on the licence, and is left out of the response without it.
+   * Registered ownership of the title. Null when the title has not been assessed for ownership yet. Requires the `sourceData` permission on the licence, and is left out of the response without it.
    */
   ownership?: Ownership | null | undefined;
   /**
@@ -452,6 +514,13 @@ export const LandUse$inboundSchema: z.ZodType<LandUse, z.ZodTypeDef, unknown> =
 export const SiteObject$inboundSchema: z.ZodNativeEnum<typeof SiteObject> = z
   .nativeEnum(SiteObject);
 
+/** @internal */
+export const Availability$inboundSchema: z.ZodType<
+  Availability,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Availability);
+
 /** @internal */
 export const OwnershipCategory$inboundSchema: z.ZodType<
   OwnershipCategory,
@@ -472,13 +541,15 @@ export const Ownership$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  asOf: z.nullable(z.string()).optional(),
+  availability: Availability$inboundSchema.optional(),
   companyNumber: z.nullable(z.string()).optional(),
   dateProprietorAdded: z.nullable(z.string()).optional(),
   isJointOwnership: z.boolean().optional(),
-  ownershipCategory: OwnershipCategory$inboundSchema.optional(),
-  primaryOwnerName: z.string().optional(),
+  ownershipCategory: z.nullable(OwnershipCategory$inboundSchema).optional(),
+  primaryOwnerName: z.nullable(z.string()).optional(),
   proprietors: z.array(SiteProprietor$inboundSchema).optional(),
-  source: SiteSource$inboundSchema.optional(),
+  source: z.nullable(SiteSource$inboundSchema).optional(),
 });
 
 export function ownershipFromJSON(
@@ -514,10 +585,17 @@ export const Site$inboundSchema: z.ZodType<Site, z.ZodTypeDef, unknown> = z
       Polygon: z.lazy(() => SiteGeoJSONPolygon$inboundSchema),
       MultiPolygon: z.lazy(() => SiteGeoJSONMultiPolygon$inboundSchema),
     }).optional(),
+    buildingIds: z.array(z.string()).optional(),
+    buildingProfile: SiteBuildingProfile$inboundSchema.optional(),
+    buildings: z.array(SiteBuilding$inboundSchema).optional(),
+    buildingsTotal: z.number().int().optional(),
+    buildingsTruncated: z.boolean().optional(),
     centroid: z.lazy(() => SiteCoordinates$inboundSchema).optional(),
     classTitleCode: z.nullable(ClassTitleCode$inboundSchema).optional(),
+    constraints: SiteConstraints$inboundSchema.optional(),
     country: z.string().optional(),
     estateInterestCode: z.nullable(EstateInterestCode$inboundSchema).optional(),
+    landProfile: SiteLandProfile$inboundSchema.optional(),
     landUse: z.array(LandUse$inboundSchema).optional(),
     locationCount: z.number().optional(),
     locationIds: z.array(z.string()).optional(),