@vepler/sdk 6.52.0 → 6.57.1

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

@@ -0,0 +1,57 @@
+/*
+ * 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";
+
+/**
+ * Yes or no answers for five common constraints. A flag is false only when its layer was measured on the title and covers no more than `flagThresholdPct` of it.
+ */
+export type SiteConstraintFlags = {
+  /**
+   * Whether the title is on brownfield land. Null when it was not measured.
+   */
+  brownfield?: boolean | null | undefined;
+  /**
+   * True when a conservation area covers more of the title than `flagThresholdPct`. Null when it was not measured.
+   */
+  conservationArea?: boolean | null | undefined;
+  /**
+   * True when Green Belt covers more of the title than `flagThresholdPct`. Null when it was not measured.
+   */
+  greenBelt?: boolean | null | undefined;
+  /**
+   * True when the curtilage of a listed building covers more of the title than `flagThresholdPct`. Null otherwise, because curtilage is published for only part of Wales and its absence elsewhere proves nothing.
+   */
+  listedBuildingCurtilage?: boolean | null | undefined;
+  /**
+   * True when a Site of Special Scientific Interest covers more of the title than `flagThresholdPct`. Null when it was not measured.
+   */
+  sssi?: boolean | null | undefined;
+};
+
+/** @internal */
+export const SiteConstraintFlags$inboundSchema: z.ZodType<
+  SiteConstraintFlags,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  brownfield: z.nullable(z.boolean()).optional(),
+  conservationArea: z.nullable(z.boolean()).optional(),
+  greenBelt: z.nullable(z.boolean()).optional(),
+  listedBuildingCurtilage: z.nullable(z.boolean()).optional(),
+  sssi: z.nullable(z.boolean()).optional(),
+});
+
+export function siteConstraintFlagsFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteConstraintFlags, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteConstraintFlags$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteConstraintFlags' from JSON`,
+  );
+}

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

@@ -0,0 +1,74 @@
+/*
+ * 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 SiteConstraintLayer = {
+  /**
+   * Date the layer's data was retrieved from its publisher, as an ISO 8601 date. Null when no retrieval date is recorded for the layer.
+   */
+  asOf?: string | null | undefined;
+  /**
+   * The layer within its family: a designation type such as `green_belt` or `flood_zone_3`, or a hazard band such as `RADON_HIGH`, `ROAD_NOISE_MED` or `HISTORIC_LANDFILL_DIRECT`.
+   */
+  code?: string | undefined;
+  /**
+   * The publisher's edition of the data, as it states it: a date, an atlas version or a mapping year. Null when the publisher states none.
+   */
+  edition?: string | null | undefined;
+  /**
+   * Number of the layer's features that lie on the title. Null for the noise layers, which are mapped as a grid rather than as features.
+   */
+  featureCount?: number | null | undefined;
+  /**
+   * Readable name of the layer.
+   */
+  name?: string | undefined;
+  /**
+   * Nation the designation was made in, such as `ENG` or `WAL`. Null for the hazard layers, which are not designations.
+   */
+  nation?: string | null | undefined;
+  /**
+   * Share of the title area the layer covers, from 0 to 100. Null when `overlapSqm` is null.
+   */
+  overlapPct?: number | null | undefined;
+  /**
+   * Area of the title the layer covers, in square metres. Overlapping features of one layer count the ground once. Null when the layer's features on the title are points, which have no area.
+   */
+  overlapSqm?: number | null | undefined;
+  /**
+   * The dataset the layer comes from: a designation product (`heritage`, `conservation` for nature conservation, `conservation_area` or `land_constraint`) or a hazard (`radon`, `historic_landfill`, `road_noise` or `rail_noise`). The set is open and grows as layers are added.
+   */
+  type?: string | undefined;
+};
+
+/** @internal */
+export const SiteConstraintLayer$inboundSchema: z.ZodType<
+  SiteConstraintLayer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  asOf: z.nullable(z.string()).optional(),
+  code: z.string().optional(),
+  edition: z.nullable(z.string()).optional(),
+  featureCount: z.nullable(z.number().int()).optional(),
+  name: z.string().optional(),
+  nation: z.nullable(z.string()).optional(),
+  overlapPct: z.nullable(z.number()).optional(),
+  overlapSqm: z.nullable(z.number()).optional(),
+  type: z.string().optional(),
+});
+
+export function siteConstraintLayerFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteConstraintLayer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteConstraintLayer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteConstraintLayer' from JSON`,
+  );
+}

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

@@ -0,0 +1,64 @@
+/*
+ * 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 {
+  SiteConstraintFlags,
+  SiteConstraintFlags$inboundSchema,
+} from "./siteconstraintflags.js";
+import {
+  SiteConstraintLayer,
+  SiteConstraintLayer$inboundSchema,
+} from "./siteconstraintlayer.js";
+import {
+  SiteConstraintUnmeasured,
+  SiteConstraintUnmeasured$inboundSchema,
+} from "./siteconstraintunmeasured.js";
+
+/**
+ * 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.
+ */
+export type SiteConstraints = {
+  /**
+   * Share of the title area, from 0 to 100, a flag's layer must exceed for the flag to be true. It keeps thin slivers where two datasets' boundaries disagree from setting a flag.
+   */
+  flagThresholdPct?: number | undefined;
+  /**
+   * Yes or no answers for five common constraints. A flag is false only when its layer was measured on the title and covers no more than `flagThresholdPct` of it.
+   */
+  flags?: SiteConstraintFlags | undefined;
+  /**
+   * Every constraint layer with at least one feature on the title, measured over the whole title boundary, sorted by `type` then `code`. A layer absent from the list has no feature on the title in the data held, which is not proof the constraint does not apply: read `flags` and `unmeasured` for whether a layer's data covers the title.
+   */
+  layers?: Array<SiteConstraintLayer> | undefined;
+  /**
+   * One entry for each null flag, saying why it was not measured.
+   */
+  unmeasured?: Array<SiteConstraintUnmeasured> | undefined;
+};
+
+/** @internal */
+export const SiteConstraints$inboundSchema: z.ZodType<
+  SiteConstraints,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  flagThresholdPct: z.number().optional(),
+  flags: SiteConstraintFlags$inboundSchema.optional(),
+  layers: z.array(SiteConstraintLayer$inboundSchema).optional(),
+  unmeasured: z.array(SiteConstraintUnmeasured$inboundSchema).optional(),
+});
+
+export function siteConstraintsFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteConstraints, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteConstraints$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteConstraints' from JSON`,
+  );
+}

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/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,