@vepler/sdk 6.50.12 → 6.57.1

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

@@ -0,0 +1,83 @@
+/*
+ * 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";
+
+/**
+ * The flag that is null.
+ */
+export const Flag = {
+  GreenBelt: "greenBelt",
+  ConservationArea: "conservationArea",
+  Sssi: "sssi",
+  ListedBuildingCurtilage: "listedBuildingCurtilage",
+  Brownfield: "brownfield",
+} as const;
+/**
+ * The flag that is null.
+ */
+export type Flag = OpenEnum<typeof Flag>;
+
+/**
+ * Why the flag was not measured: `outside_source_coverage` when the title lies outside the nations the data covers, `authority_not_in_source` when the title's planning authority has published no feature to the data, `partial_source_coverage` when the data covers only part of its nation, or `source_not_held` when no data for the layer is held.
+ */
+export const SiteConstraintUnmeasuredReason = {
+  OutsideSourceCoverage: "outside_source_coverage",
+  AuthorityNotInSource: "authority_not_in_source",
+  PartialSourceCoverage: "partial_source_coverage",
+  SourceNotHeld: "source_not_held",
+} as const;
+/**
+ * Why the flag was not measured: `outside_source_coverage` when the title lies outside the nations the data covers, `authority_not_in_source` when the title's planning authority has published no feature to the data, `partial_source_coverage` when the data covers only part of its nation, or `source_not_held` when no data for the layer is held.
+ */
+export type SiteConstraintUnmeasuredReason = OpenEnum<
+  typeof SiteConstraintUnmeasuredReason
+>;
+
+export type SiteConstraintUnmeasured = {
+  /**
+   * The flag that is null.
+   */
+  flag?: Flag | undefined;
+  /**
+   * Why the flag was not measured: `outside_source_coverage` when the title lies outside the nations the data covers, `authority_not_in_source` when the title's planning authority has published no feature to the data, `partial_source_coverage` when the data covers only part of its nation, or `source_not_held` when no data for the layer is held.
+   */
+  reason?: SiteConstraintUnmeasuredReason | undefined;
+};
+
+/** @internal */
+export const Flag$inboundSchema: z.ZodType<Flag, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Flag);
+
+/** @internal */
+export const SiteConstraintUnmeasuredReason$inboundSchema: z.ZodType<
+  SiteConstraintUnmeasuredReason,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SiteConstraintUnmeasuredReason);
+
+/** @internal */
+export const SiteConstraintUnmeasured$inboundSchema: z.ZodType<
+  SiteConstraintUnmeasured,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  flag: Flag$inboundSchema.optional(),
+  reason: SiteConstraintUnmeasuredReason$inboundSchema.optional(),
+});
+
+export function siteConstraintUnmeasuredFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteConstraintUnmeasured, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteConstraintUnmeasured$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteConstraintUnmeasured' from JSON`,
+  );
+}

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

@@ -0,0 +1,145 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Geometry type discriminator. Always `Polygon`.
+ */
+export const SiteLandFeatureType = {
+  Polygon: "Polygon",
+} as const;
+/**
+ * Geometry type discriminator. Always `Polygon`.
+ */
+export type SiteLandFeatureType = ClosedEnum<typeof SiteLandFeatureType>;
+
+/**
+ * The whole polygon as published, in WGS84 with positions as [longitude, latitude]. It can extend beyond the title boundary; `areaOnTitleSqm` measures only the part within it. Left out by default; request it with `attributes=geometry`.
+ */
+export type GeoJSONPolygon = {
+  /**
+   * 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.
+   */
+  coordinates: Array<Array<Array<number>>>;
+  /**
+   * Geometry type discriminator. Always `Polygon`.
+   */
+  type: SiteLandFeatureType;
+};
+
+export type SiteLandFeature = {
+  /**
+   * Area of the polygon that lies within the title boundary, in square metres, to one decimal place.
+   */
+  areaOnTitleSqm: number;
+  /**
+   * Release date of the Ordnance Survey version the polygon was read from, as an ISO 8601 timestamp.
+   */
+  asOf: string;
+  /**
+   * Ordnance Survey land cover of the polygon (tier B), as published. The set of values is open.
+   */
+  cover: string;
+  /**
+   * Ordnance Survey land cover group the `cover` value belongs to (tier A), as published.
+   */
+  coverGroup: string;
+  /**
+   * Ordnance Survey description of the feature, as published.
+   */
+  description: string;
+  /**
+   * The whole polygon as published, in WGS84 with positions as [longitude, latitude]. It can extend beyond the title boundary; `areaOnTitleSqm` measures only the part within it. Left out by default; request it with `attributes=geometry`.
+   */
+  geometry?: GeoJSONPolygon | undefined;
+  /**
+   * Identifier of the land polygon: `GB:NGD:` followed by its Ordnance Survey feature identifier.
+   */
+  id: string;
+  /**
+   * True when Ordnance Survey records the polygon's land cover as obscured.
+   */
+  isObscured: boolean;
+  /**
+   * True when Ordnance Survey records the polygon as tidal.
+   */
+  isTidal: boolean;
+  /**
+   * Ordnance Survey landform of the polygon, such as a pit or quarry, as published. Null when none is recorded.
+   */
+  landform: string | null;
+  /**
+   * Kind of feature. Every item is `land` today, and the set of values is open.
+   */
+  type: string;
+  /**
+   * Ordnance Survey land use of the polygon (tier A), as published. The set of values is open.
+   */
+  use: string;
+  /**
+   * Ordnance Survey detailed land use of the polygon (tier B), as published. Null when none is recorded.
+   */
+  useDetail: string | null;
+};
+
+/** @internal */
+export const SiteLandFeatureType$inboundSchema: z.ZodNativeEnum<
+  typeof SiteLandFeatureType
+> = z.nativeEnum(SiteLandFeatureType);
+
+/** @internal */
+export const GeoJSONPolygon$inboundSchema: z.ZodType<
+  GeoJSONPolygon,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  coordinates: z.array(z.array(z.array(z.number()))),
+  type: SiteLandFeatureType$inboundSchema,
+});
+
+export function geoJSONPolygonFromJSON(
+  jsonString: string,
+): SafeParseResult<GeoJSONPolygon, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GeoJSONPolygon$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GeoJSONPolygon' from JSON`,
+  );
+}
+
+/** @internal */
+export const SiteLandFeature$inboundSchema: z.ZodType<
+  SiteLandFeature,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaOnTitleSqm: z.number(),
+  asOf: z.string(),
+  cover: z.string(),
+  coverGroup: z.string(),
+  description: z.string(),
+  geometry: z.lazy(() => GeoJSONPolygon$inboundSchema).optional(),
+  id: z.string(),
+  isObscured: z.boolean(),
+  isTidal: z.boolean(),
+  landform: z.nullable(z.string()),
+  type: z.string(),
+  use: z.string(),
+  useDetail: z.nullable(z.string()),
+});
+
+export function siteLandFeatureFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteLandFeature, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteLandFeature$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteLandFeature' from JSON`,
+  );
+}

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

@@ -0,0 +1,86 @@
+/*
+ * 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 {
+  SiteLandFeature,
+  SiteLandFeature$inboundSchema,
+} from "./sitelandfeature.js";
+
+/**
+ * Object type discriminator. Always `list`.
+ */
+export const SiteLandListResponseObject = {
+  List: "list",
+} as const;
+/**
+ * Object type discriminator. Always `list`.
+ */
+export type SiteLandListResponseObject = ClosedEnum<
+  typeof SiteLandListResponseObject
+>;
+
+/**
+ * One page of results, with the metadata needed to fetch the rest.
+ */
+export type SiteLandListResponse = {
+  /**
+   * The items on this page.
+   */
+  data: Array<SiteLandFeature>;
+  /**
+   * True when further items exist beyond this page.
+   */
+  hasMore: boolean;
+  /**
+   * Object type discriminator. Always `list`.
+   */
+  object: SiteLandListResponseObject;
+  /**
+   * Total number of items matching the request across all pages.
+   */
+  totalCount?: number | undefined;
+  /**
+   * Path this list was requested from.
+   */
+  url: string;
+};
+
+/** @internal */
+export const SiteLandListResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof SiteLandListResponseObject
+> = z.nativeEnum(SiteLandListResponseObject);
+
+/** @internal */
+export const SiteLandListResponse$inboundSchema: z.ZodType<
+  SiteLandListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(SiteLandFeature$inboundSchema),
+  has_more: z.boolean(),
+  object: SiteLandListResponseObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function siteLandListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteLandListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteLandListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteLandListResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,110 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 { SiteLandShare, SiteLandShare$inboundSchema } from "./sitelandshare.js";
+
+/**
+ * Dataset the profile is computed from. Always `os_ngd_land`.
+ */
+export const SiteLandProfileSource = {
+  OsNgdLand: "os_ngd_land",
+} as const;
+/**
+ * Dataset the profile is computed from. Always `os_ngd_land`.
+ */
+export type SiteLandProfileSource = ClosedEnum<typeof SiteLandProfileSource>;
+
+/**
+ * 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.
+ */
+export type SiteLandProfile = {
+  /**
+   * Release date of the Ordnance Survey version the profile was computed from, as an ISO 8601 timestamp.
+   */
+  asOf?: string | undefined;
+  /**
+   * The title's land area by Ordnance Survey land cover class, largest first.
+   */
+  cover?: Array<SiteLandShare> | undefined;
+  /**
+   * Share of the title area covered by land polygons, from 0 to 100. Building footprints are a separate feature type and are measured in `buildingProfile`, so a built title is rarely fully covered.
+   */
+  coveredPct?: number | undefined;
+  /**
+   * Share of the title's land area that is a made surface, from 0 to 100.
+   */
+  madeSurfacePct?: number | undefined;
+  /**
+   * Area of the title whose land cover is a made surface, such as paving or hard standing, in square metres. Building footprints are not included.
+   */
+  madeSurfaceSqm?: number | undefined;
+  /**
+   * Area of the title whose land cover is recorded as obscured, in square metres.
+   */
+  obscuredSqm?: number | undefined;
+  /**
+   * Identifier of that Ordnance Survey release.
+   */
+  osVersion?: string | undefined;
+  /**
+   * Number of land polygons that cover part of the title.
+   */
+  polygonCount?: number | undefined;
+  /**
+   * Dataset the profile is computed from. Always `os_ngd_land`.
+   */
+  source?: SiteLandProfileSource | undefined;
+  /**
+   * Area of the title that is tidal, in square metres.
+   */
+  tidalSqm?: number | undefined;
+  /**
+   * Area of the title covered by land polygons, in square metres.
+   */
+  totalSqm?: number | undefined;
+  /**
+   * The title's land area by Ordnance Survey land use class, largest first.
+   */
+  use?: Array<SiteLandShare> | undefined;
+};
+
+/** @internal */
+export const SiteLandProfileSource$inboundSchema: z.ZodNativeEnum<
+  typeof SiteLandProfileSource
+> = z.nativeEnum(SiteLandProfileSource);
+
+/** @internal */
+export const SiteLandProfile$inboundSchema: z.ZodType<
+  SiteLandProfile,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  asOf: z.string().optional(),
+  cover: z.array(SiteLandShare$inboundSchema).optional(),
+  coveredPct: z.number().optional(),
+  madeSurfacePct: z.number().optional(),
+  madeSurfaceSqm: z.number().optional(),
+  obscuredSqm: z.number().optional(),
+  osVersion: z.string().optional(),
+  polygonCount: z.number().int().optional(),
+  source: SiteLandProfileSource$inboundSchema.optional(),
+  tidalSqm: z.number().optional(),
+  totalSqm: z.number().optional(),
+  use: z.array(SiteLandShare$inboundSchema).optional(),
+});
+
+export function siteLandProfileFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteLandProfile, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteLandProfile$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteLandProfile' from JSON`,
+  );
+}

package/src/sdk/models/shared/sitelandshare.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 SiteLandShare = {
+  /**
+   * Area of the title carrying this class, in square metres.
+   */
+  areaSqm?: number | undefined;
+  /**
+   * The broader Ordnance Survey land cover group the class belongs to. Present on cover shares only.
+   */
+  group?: string | undefined;
+  /**
+   * Share of the title's land area carrying this class, from 0 to 100.
+   */
+  pct?: number | undefined;
+  /**
+   * The Ordnance Survey land cover or land use class this share is keyed by, as published.
+   */
+  value?: string | undefined;
+};
+
+/** @internal */
+export const SiteLandShare$inboundSchema: z.ZodType<
+  SiteLandShare,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaSqm: z.number().optional(),
+  group: z.string().optional(),
+  pct: z.number().optional(),
+  value: z.string().optional(),
+});
+
+export function siteLandShareFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteLandShare, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteLandShare$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteLandShare' from JSON`,
+  );
+}

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

@@ -21,7 +21,7 @@ import {
 } from "./sitequeryoperator.js";
 
 /**
- * Fields to return, either as an array of names or as one comma-separated string such as "siteId,tenureType,areaSqm". Defaults to a standard set that leaves out the `boundary` geometry; name `boundary` to get site polygons back.
+ * Fields to return, either as an array of names or as one comma-separated string such as "siteId,tenureType,areaSqm". Defaults to a standard set that leaves out the `boundary` geometry and the per-building lists; name `boundary` to get site polygons back, `buildings` for the summary of every building on the title, or `buildingIds` for their identifiers alone.
  */
 export type SiteQueryRequestAttributes = string | Array<string>;
 
@@ -149,7 +149,7 @@ export type SiteQueryRequest = {
    */
   area?: Array<SiteAreaFilter> | undefined;
   /**
-   * Fields to return, either as an array of names or as one comma-separated string such as "siteId,tenureType,areaSqm". Defaults to a standard set that leaves out the `boundary` geometry; name `boundary` to get site polygons back.
+   * Fields to return, either as an array of names or as one comma-separated string such as "siteId,tenureType,areaSqm". Defaults to a standard set that leaves out the `boundary` geometry and the per-building lists; name `boundary` to get site polygons back, `buildings` for the summary of every building on the title, or `buildingIds` for their identifiers alone.
    */
   attributes?: string | Array<string> | undefined;
   /**

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

@@ -15,6 +15,10 @@ export type SiteTags = {
    * True when the site's land use includes agricultural land.
    */
   agricultural?: boolean | undefined;
+  /**
+   * Whether the title is on brownfield land, the same value as `constraints.flags.brownfield`. Null when brownfield land was not measured on the title; `constraints.unmeasured` says why.
+   */
+  brownfield?: boolean | null | undefined;
   /**
    * True when more than one property is linked to this site.
    */
@@ -36,6 +40,7 @@ export const SiteTags$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   agricultural: z.boolean().optional(),
+  brownfield: z.nullable(z.boolean()).optional(),
   multipleProperties: z.boolean().optional(),
   noProperties: z.boolean().optional(),
   vacant: z.boolean().optional(),

package/src/sdk/sites.ts

@@ -7,6 +7,7 @@ import { sitesFindByIds } from "../funcs/sitesFindByIds.js";
 import { sitesFindByPoint } from "../funcs/sitesFindByPoint.js";
 import { sitesFindByProperty } from "../funcs/sitesFindByProperty.js";
 import { sitesGet } from "../funcs/sitesGet.js";
+import { sitesGetLand } from "../funcs/sitesGetLand.js";
 import { sitesGetProperties } from "../funcs/sitesGetProperties.js";
 import { sitesGetTiles } from "../funcs/sitesGetTiles.js";
 import { sitesSearch } from "../funcs/sitesSearch.js";
@@ -88,7 +89,7 @@ export class Sites extends ClientSDK {
    * Get site by ID
    *
    * @remarks
-   * Retrieve one registered title by its identifier, which joins the country, the registry and the title number with colons, as in `GB:LR:AGL123456`. This endpoint returns every attribute, including the boundary geometry, ownership, property statistics, planning statistics and area metrics.
+   * Retrieve one registered title by its identifier, which joins the country, the registry and the title number with colons, as in `GB:LR:AGL123456`. This endpoint returns every attribute, including the boundary geometry, ownership, property statistics, planning statistics and area metrics, except the per-building lists: pass `attributes=buildings` to add the summary of every building on the title, or `attributes=buildingIds` for their identifiers alone.
    */
   async get(
     request: operations.GetSiteByIdRequest,
@@ -101,6 +102,23 @@ export class Sites extends ClientSDK {
     ));
   }
 
+  /**
+   * Get land polygons in site
+   *
+   * @remarks
+   * List the Ordnance Survey land polygons that cover part of one registered title, each with its land cover, land use, landform and the area of it that lies within the title. This is the per-polygon detail behind the site's `landProfile`, measured on the title boundary in the same way, read from the current Ordnance Survey release rather than from the stored profile. Polygons come back in order of identifier, so `limit` and `offset` page through them. Each polygon appears on exactly one page while the Ordnance Survey release stays the same; a new release published between two page requests can move a polygon across a page boundary. The polygon boundary is left out by default because of its size; pass `attributes=geometry` to get it. Requires the `osNgdAccess` permission on the licence.
+   */
+  async getLand(
+    request: operations.GetSiteLandRequest,
+    options?: RequestOptions,
+  ): Promise<shared.SiteLandListResponse> {
+    return unwrapAsync(sitesGetLand(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get properties in site
    *
@@ -139,7 +157,7 @@ export class Sites extends ClientSDK {
    * Search sites
    *
    * @remarks
-   * Search registered titles by their attributes, by geographic area, or by both, with sorting and pagination. Area filters accept a polygon, a multi-polygon, a point with a radius, a point the boundary must enclose, or a bounding box; a site matches the area clause if it satisfies any one of the filters supplied, and that has to hold on top of `filters` and `query`. The `boundary` geometry is left out by default because of its size, so pass `attributes: ["boundary"]` to get site polygons back. Up to 1000 sites come back per request, from an offset of at most 100000.
+   * Search registered titles by their attributes, by geographic area, or by both, with sorting and pagination. Area filters accept a polygon, a multi-polygon, a point with a radius, a point the boundary must enclose, or a bounding box; a site matches the area clause if it satisfies any one of the filters supplied, and that has to hold on top of `filters` and `query`. The `boundary` geometry is left out by default because of its size, so pass `attributes: ["boundary"]` to get site polygons back; likewise pass `attributes: ["buildings"]` for the summary of every building on each title. Up to 1000 sites come back per request, from an offset of at most 100000.
    */
   async search(
     request?: shared.SiteQueryRequest | undefined,