@vepler/sdk 2.30.4 → 2.37.0

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

@@ -0,0 +1,147 @@
+/*
+ * 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 {
+  GeographicContext,
+  GeographicContext$inboundSchema,
+} from "./geographiccontext.js";
+
+/**
+ * WGS84 coordinate pair
+ */
+export type UprnLookupResponseCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+export const UprnLookupResponseObject = {
+  Address: "address",
+} as const;
+export type UprnLookupResponseObject = ClosedEnum<
+  typeof UprnLookupResponseObject
+>;
+
+export type UprnLookupResponse = {
+  /**
+   * AddressBase classification code
+   */
+  classificationCode?: string | undefined;
+  /**
+   * WGS84 coordinate pair
+   */
+  coordinates?: UprnLookupResponseCoordinates | undefined;
+  /**
+   * County
+   */
+  county: string;
+  /**
+   * Single-line formatted address
+   */
+  formatted: string;
+  /**
+   * Geographic context (when include=geography)
+   */
+  geography?: GeographicContext | undefined;
+  /**
+   * Primary address line
+   */
+  line1: string;
+  /**
+   * Secondary address line
+   */
+  line2: string;
+  /**
+   * Tertiary address line
+   */
+  line3: string;
+  object: UprnLookupResponseObject;
+  /**
+   * Post town
+   */
+  postTown: string;
+  /**
+   * Postcode
+   */
+  postcode: string;
+  /**
+   * Unique Property Reference Number
+   */
+  uprn: string;
+};
+
+/** @internal */
+export const UprnLookupResponseCoordinates$inboundSchema: z.ZodType<
+  UprnLookupResponseCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function uprnLookupResponseCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<UprnLookupResponseCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UprnLookupResponseCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UprnLookupResponseCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const UprnLookupResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof UprnLookupResponseObject
+> = z.nativeEnum(UprnLookupResponseObject);
+
+/** @internal */
+export const UprnLookupResponse$inboundSchema: z.ZodType<
+  UprnLookupResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  classification_code: z.string().optional(),
+  coordinates: z.lazy(() => UprnLookupResponseCoordinates$inboundSchema)
+    .optional(),
+  county: z.string(),
+  formatted: z.string(),
+  geography: GeographicContext$inboundSchema.optional(),
+  line_1: z.string(),
+  line_2: z.string(),
+  line_3: z.string(),
+  object: UprnLookupResponseObject$inboundSchema,
+  post_town: z.string(),
+  postcode: z.string(),
+  uprn: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "classification_code": "classificationCode",
+    "line_1": "line1",
+    "line_2": "line2",
+    "line_3": "line3",
+    "post_town": "postTown",
+  });
+});
+
+export function uprnLookupResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UprnLookupResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UprnLookupResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UprnLookupResponse' from JSON`,
+  );
+}

package/src/sdk/planning.ts

@@ -15,7 +15,7 @@ export class Planning extends ClientSDK {
    * Get planning applications by application IDs
    *
    * @remarks
-   * Retrieve planning application data using comma-separated application identifiers
+   * Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead.
    */
   async getPlanningApplications(
     request: operations.GetPlanningApplicationsRequest,
@@ -32,7 +32,7 @@ export class Planning extends ClientSDK {
    * Get planning applications by source IDs
    *
    * @remarks
-   * Retrieve planning application data using comma-separated source identifiers (e.g., council::reference)
+   * Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number.
    */
   async getPlanningApplicationsBySource(
     request: operations.GetPlanningApplicationsBySourceRequest,
@@ -49,7 +49,7 @@ export class Planning extends ClientSDK {
    * Query planning applications with advanced filters
    *
    * @remarks
-   * Search for planning applications using councils, status, dates, and other criteria
+   * Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field. Supports up to 100 results per page.
    */
   async searchPlanningApplications(
     request?: shared.PlanningQueryRequest | undefined,

package/src/sdk/safety.ts

@@ -13,7 +13,7 @@ export class Safety extends ClientSDK {
    * Get crime data near location
    *
    * @remarks
-   * Retrieve crime incidents within a specified radius of coordinates
+   * Retrieve individual crime incidents recorded within a specified radius of the given coordinates. Data is sourced from police.uk street-level crime records covering England and Wales. Incident locations are anonymised by police.uk to a nearby map point (accurate to ~150m). Data is published monthly with an approximate 2-month lag. Use the /crime/stats endpoint for aggregated statistics and safety scores instead of raw incidents.
    */
   async getV1SafetyCrime(
     request: operations.GetV1SafetyCrimeRequest,
@@ -30,7 +30,7 @@ export class Safety extends ClientSDK {
    * Get crime statistics for an area
    *
    * @remarks
-   * Retrieve aggregated crime statistics for a specified area
+   * Retrieve aggregated crime statistics and a computed safety score for the area around a given coordinate. This endpoint queries crime data across multiple months, calculates trends, category breakdowns, and an overall safety score. It is more suitable than /crime for area-level analysis as it returns summary statistics rather than individual incidents. Coverage: England and Wales (police.uk data). Data has an approximate 2-month publication lag.
    */
   async getV1SafetyCrimeStats(
     request: operations.GetV1SafetyCrimeStatsRequest,

package/src/sdk/sdk.ts

@@ -6,6 +6,7 @@ import { ClientSDK } from "../lib/sdks.js";
 import { Address } from "./address.js";
 import { Areas } from "./areas.js";
 import { Avm } from "./avm.js";
+import { Companies } from "./companies.js";
 import { Connectivity } from "./connectivity.js";
 import { Councils } from "./councils.js";
 import { Epc } from "./epc.js";
@@ -17,6 +18,7 @@ import { Property } from "./property.js";
 import { Safety } from "./safety.js";
 import { Schools } from "./schools.js";
 import { Search } from "./search.js";
+import { Sites } from "./sites.js";
 import { Streets } from "./streets.js";
 import { System } from "./system.js";
 
@@ -56,6 +58,11 @@ export class SDK extends ClientSDK {
     return (this._avm ??= new Avm(this._options));
   }
 
+  private _companies?: Companies;
+  get companies(): Companies {
+    return (this._companies ??= new Companies(this._options));
+  }
+
   private _councils?: Councils;
   get councils(): Councils {
     return (this._councils ??= new Councils(this._options));
@@ -100,4 +107,9 @@ export class SDK extends ClientSDK {
   get search(): Search {
     return (this._search ??= new Search(this._options));
   }
+
+  private _sites?: Sites;
+  get sites(): Sites {
+    return (this._sites ??= new Sites(this._options));
+  }
 }

package/src/sdk/sites.ts

@@ -0,0 +1,179 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { sitesAggregate } from "../funcs/sitesAggregate.js";
+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 { sitesGetProperties } from "../funcs/sitesGetProperties.js";
+import { sitesGetTiles } from "../funcs/sitesGetTiles.js";
+import { sitesSearch } from "../funcs/sitesSearch.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import * as shared from "./models/shared/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Sites extends ClientSDK {
+  /**
+   * Aggregate sites
+   *
+   * @remarks
+   * Run aggregations (analytics) on the sites index with optional filters and geographic area filters.
+   *
+   * Supports 14 aggregation types including terms, stats, histogram, date_histogram, percentiles, and geotile_grid. Up to 10 aggregations per request with up to 2 levels of nesting (sub-aggregations).
+   *
+   * The response `aggregations` object is keyed by the `name` you provide in each aggregation definition. The result shape depends on the aggregation type — see the AggregationResult schema for details.
+   *
+   * Filter interaction is the same as the search endpoint: `filters` AND `query` AND any `area` filter.
+   */
+  async aggregate(
+    request?: shared.SiteAggregateRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<shared.SiteAggregateResponse> {
+    return unwrapAsync(sitesAggregate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Batch lookup sites by IDs
+   *
+   * @remarks
+   * Retrieve multiple sites by their composite identifiers in a single request (max 100). IDs that do not match any site are silently omitted from the response — check `total_count` against your input length to detect missing sites. Supports attribute selection to control which fields are returned.
+   */
+  async findByIds(
+    request?: shared.SiteBatchIdsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<shared.SiteListResponse> {
+    return unwrapAsync(sitesFindByIds(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Find sites by point
+   *
+   * @remarks
+   * Find land titles whose boundary polygon contains the given WGS84 (EPSG:4326) coordinate. This is a point-in-polygon spatial query — returns all titles at that location. Multiple overlapping titles are common (e.g. a freehold and leasehold at the same address). Returns up to 50 matching sites. Returns an empty list (not a 404) if no titles contain the point.
+   */
+  async findByPoint(
+    request?: operations.FindSitesByPointRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<shared.SiteListResponse> {
+    return unwrapAsync(sitesFindByPoint(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Find sites by property
+   *
+   * @remarks
+   * Find land titles that contain a specific property UPRN (Unique Property Reference Number). A property can belong to multiple titles (e.g. a flat in a freehold building will match both the leasehold and freehold titles). Returns up to 50 matching sites.
+   */
+  async findByProperty(
+    request: operations.FindSitesByPropertyRequest,
+    options?: RequestOptions,
+  ): Promise<shared.SiteListResponse> {
+    return unwrapAsync(sitesFindByProperty(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get site by ID
+   *
+   * @remarks
+   * Retrieve a single site by its composite identifier in `{country}:{registry}:{titleRef}` format (e.g. `GB:NPS:AGL123456`). Returns the full site object including boundary geometry, property statistics, planning data, scores, and area metrics. Requires a valid API key passed via the `Authorization: Bearer <key>` header.
+   */
+  async get(
+    request: operations.GetSiteByIdRequest,
+    options?: RequestOptions,
+  ): Promise<shared.Site> {
+    return unwrapAsync(sitesGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get properties in site
+   *
+   * @remarks
+   * Get all UPRNs (Unique Property Reference Numbers) linked to a specific site via spatial intersection with the Ordnance Survey AddressBase dataset. Returns an array of UPRN strings and the total count. Use these UPRNs with the Property API to fetch full property details.
+   */
+  async getProperties(
+    request: operations.GetPropertiesInSiteRequest,
+    options?: RequestOptions,
+  ): Promise<shared.SitePropertiesResponse> {
+    return unwrapAsync(sitesGetProperties(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get site boundary tiles
+   *
+   * @remarks
+   * Retrieve site boundaries as Mapbox Vector Tiles (MVT / application/x-protobuf) for map visualisation.
+   *
+   * Returns actual polygon geometries rendered from the `boundary` geo_shape field — not simplified or clustered points. Each feature in the tile includes properties specified by the `fields` parameter (defaults to siteId, titleRef, tenureType, status, areaSqm, locationCount, areaMetrics.prosperityDecile).
+   *
+   * **Zoom constraint:** Only available at zoom level 12 and above. Requests below zoom 12 return a 400 error — site polygons are too small and dense to render meaningfully at lower zoom levels.
+   *
+   * **Filtering:** Supports the same filter, query, and area parameters as the search endpoint, passed as JSON-encoded query parameters. Maximum 10,000 features per tile.
+   *
+   * **Caching:** Responses include `Cache-Control: public, max-age=30, s-maxage=60` headers. Suitable for use with Mapbox GL JS, MapLibre GL JS, or any MVT-compatible map renderer.
+   */
+  async getTiles(
+    request: operations.GetSiteTilesRequest,
+    options?: RequestOptions,
+  ): Promise<Uint8Array> {
+    return unwrapAsync(sitesGetTiles(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Search sites
+   *
+   * @remarks
+   * Search sites with advanced filters, geographic area filters, sorting, and pagination.
+   *
+   * **Filter interaction logic:**
+   * - `filters` (convenience) and `query` (advanced) are combined with AND logic — a site must match both.
+   * - Multiple `area` filters are combined with OR logic — a site matches if it satisfies any area filter.
+   * - Area filters are combined with AND against the other filters.
+   *
+   * **Spatial queries:** Supports polygon, multi-polygon, point+radius, containsPoint, and bounding box area types.
+   *
+   * **Attribute selection:** By default, the heavy `boundary` geometry is excluded. Pass `attributes: ["boundary"]` to include it.
+   *
+   * Requires a valid API key via `Authorization: Bearer <key>` header.
+   */
+  async search(
+    request?: shared.SiteQueryRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<shared.SiteListResponse> {
+    return unwrapAsync(sitesSearch(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/system.ts

@@ -4,6 +4,7 @@
 
 import { systemCheckAreaReferenceHealth } from "../funcs/systemCheckAreaReferenceHealth.js";
 import { systemCheckAVMHealth } from "../funcs/systemCheckAVMHealth.js";
+import { systemCheckCompaniesHealth } from "../funcs/systemCheckCompaniesHealth.js";
 import { systemCheckEPCHealth } from "../funcs/systemCheckEPCHealth.js";
 import { systemCheckListingsHealth } from "../funcs/systemCheckListingsHealth.js";
 import { systemCheckLocationHealth } from "../funcs/systemCheckLocationHealth.js";
@@ -46,6 +47,21 @@ export class System extends ClientSDK {
     ));
   }
 
+  /**
+   * Companies House service health check
+   *
+   * @remarks
+   * Check if the Companies House service is operational
+   */
+  async checkCompaniesHealth(
+    options?: RequestOptions,
+  ): Promise<shared.HealthResponse> {
+    return unwrapAsync(systemCheckCompaniesHealth(
+      this,
+      options,
+    ));
+  }
+
   /**
    * EPC service health check
    *