@vepler/sdk 3.3.0 → 6.0.0

package/dist/esm/sdk/energy.js

@@ -19,16 +19,7 @@ export class Energy extends ClientSDK {
      * Find nearest substations
      *
      * @remarks
-     * Find electricity substations within a given radius of a geographic point, ordered by distance from closest to furthest.
-     *
-     * Use this endpoint to identify which substations serve a particular location and assess the available capacity nearby. You can optionally filter by substation type or country.
-     *
-     * **Parameters:**
-     * - `lat`, `lon` — coordinates of the search centre point (WGS84)
-     * - `radius` — search radius in kilometres (default: 5 km, max: 50 km)
-     * - `limit` — maximum results (default: 10, max: 100)
-     * - `substationType` — optional filter (primary, grid, distribution, etc.)
-     * - `country` — optional ISO 3166-1 alpha-2 country code filter
+     * Returns the electricity substations within a radius of a point, closest first, so you can see what sits near a location and how much capacity it has. The radius is in kilometres, defaults to 5 and can be up to 50. Ten substations come back by default and 100 at most. Results can be narrowed to one substation type or one country.
      */
     async findNearestSubstations(request, options) {
         return unwrapAsync(energyFindNearestSubstations(this, request, options));
@@ -37,11 +28,7 @@ export class Energy extends ClientSDK {
      * Find supply areas by point
      *
      * @remarks
-     * Find all supply area boundaries that contain a given geographic point.
-     *
-     * A supply area defines the geographic region served by a specific substation. Multiple boundaries may overlap at a single point because the network is hierarchical — a location can fall within a distribution area, a primary area, a bulk supply point area, and a grid supply point area simultaneously.
-     *
-     * Results are returned from most specific (distribution) to broadest (grid supply point).
+     * Returns every supply area boundary that contains the point, each carrying the code of the substation that serves it where one is recorded. The network is hierarchical, so one location can fall inside several boundaries at once: a distribution area, a primary area, a bulk supply point area and a grid supply point area. At most 50 boundaries are returned. Read `areaType` on each result to tell the levels apart.
      */
     async findSupplyAreaByPoint(request, options) {
         return unwrapAsync(energyFindSupplyAreaByPoint(this, request, options));
@@ -50,20 +37,7 @@ export class Energy extends ClientSDK {
      * Get energy infrastructure for a property
      *
      * @remarks
-     * Get the complete energy infrastructure context for a specific property location.
-     *
-     * This endpoint resolves a property's coordinates to its serving electricity substation and supply area, then enriches the response with:
-     *
-     * - **Supply area** — the geographic boundary served by the substation
-     * - **Substation** — current capacity, demand, and available headroom
-     * - **Capacity history** — quarterly snapshots showing how headroom has changed
-     * - **Embedded connections** — registered generation and storage sites nearby
-     * - **Future forecasts** — projected demand and generation growth
-     * - **Connection queue** — grid connection queue entries at the serving substation
-     *
-     * The `lat` and `lon` query parameters specify the property's coordinates in WGS84.
-     *
-     * Use the `include` parameter to select which layers to return. Defaults to all layers (`supplyArea,substation,capacity,ecr,dfes,connections`). Omitting layers you don't need reduces response size and improves performance.
+     * Resolves a property's coordinates to the supply area and substation that serve it, then returns that substation's current capacity and headroom, its capacity history, the generation and storage registered against it, the projects queued to connect to it, and its future scenario projections. The `lat` and `lon` query parameters are required and carry the property's coordinates in WGS84 decimal degrees. Use `include` to ask for only the layers you need; all of them are returned by default.
      */
     async getByProperty(request, options) {
         return unwrapAsync(energyGetByProperty(this, request, options));
@@ -72,15 +46,7 @@ export class Energy extends ClientSDK {
      * Get capacity time-series
      *
      * @remarks
-     * Get historical capacity snapshots for a substation, ordered chronologically.
-     *
-     * Each snapshot records the substation's demand, firm capacity, and available headroom at a point in time (typically quarterly). Use this data to track how available capacity has changed and identify trends in network utilisation.
-     *
-     * **Headroom** is the spare capacity available for new connections:
-     * - **Demand headroom** — capacity available for new electricity consumers (e.g. data centres, EV charging)
-     * - **Generation headroom** — capacity available for new generators (e.g. solar farms, wind turbines)
-     *
-     * Optionally filter by date range using `from` and `to` parameters.
+     * Returns the capacity snapshots recorded for a substation, oldest first, so you can track how its demand, firm capacity and headroom have moved. Snapshots are typically quarterly. Headroom is the capacity left for new connections: demand headroom for new consumers such as data centres or vehicle charging, generation headroom for new generators such as solar or wind. Use `from` and `to` to narrow the date range.
      */
     async getCapacity(request, options) {
         return unwrapAsync(energyGetCapacity(this, request, options));
@@ -89,9 +55,7 @@ export class Energy extends ClientSDK {
      * Get connection queue entries for a substation
      *
      * @remarks
-     * Get all grid connection queue entries associated with a specific substation.
-     *
-     * Returns projects from both the TEC Register (transmission) and Embedded Register (distribution) that connect at this substation. Ordered by capacity (largest first).
+     * Returns every connection queue project matched to this substation, from both the transmission register (TEC) and the distribution register (Embedded), largest capacity first. Use it to see how much of a substation's remaining headroom is already spoken for.
      */
     async getConnectionQueueBySubstation(request, options) {
         return unwrapAsync(energyGetConnectionQueueBySubstation(this, request, options));
@@ -100,11 +64,7 @@ export class Energy extends ClientSDK {
      * Get connection queue entry by project ID
      *
      * @remarks
-     * Retrieve a single connection queue entry by its project identifier.
-     *
-     * Returns the full entry including all technology components from the junction table. Multi-technology projects (e.g. solar + battery co-location) will include each technology as a separate item in the `technologies` array.
-     *
-     * Optionally pass `sourceDataset` as a query parameter to disambiguate entries that appear in both TEC and Embedded registers.
+     * Returns one connection queue project by its identifier, including the `technologies` breakdown that lists each technology in a combined project, such as solar with a co-located battery. The same identifier can appear in both the transmission and distribution registers, so pass `sourceDataset` to choose which one to read.
      */
     async getConnectionQueueEntry(request, options) {
         return unwrapAsync(energyGetConnectionQueueEntry(this, request, options));
@@ -113,17 +73,7 @@ export class Energy extends ClientSDK {
      * Get future energy scenario forecasts
      *
      * @remarks
-     * Get energy scenario forecasts for a substation.
-     *
-     * Forecasts project how electricity demand, generation, and storage capacity will evolve at each substation over time. Each country's energy planning framework defines its own scenarios — for example, GB uses Distribution Future Energy Scenarios (DFES) with pathways such as:
-     *
-     * - **Leading the Way** — fastest decarbonisation, highest electrification
-     * - **Consumer Transformation** — consumer-led change with high energy efficiency
-     * - **System Transformation** — hydrogen-heavy, centralised generation
-     * - **Falling Short** — slowest progress towards net zero
-     * - **Best View** — the operator's central planning estimate
-     *
-     * Other countries define their own scenario sets. Optionally filter by scenario and/or year range.
+     * Returns the energy scenario projections published for a substation, showing how electricity demand, generation and storage capacity are expected to grow, by scenario, year and technology. Each country's energy planning framework defines its own scenarios; in Great Britain these are the Distribution Future Energy Scenarios (DFES), running from the fastest decarbonisation pathway ('leading_the_way') to the slowest ('falling_short'), alongside the operator's central estimate ('best_view'). Narrow the result with `scenario`, `yearFrom` and `yearTo`.
      */
     async getDFES(request, options) {
         return unwrapAsync(energyGetDFES(this, request, options));
@@ -132,11 +82,7 @@ export class Energy extends ClientSDK {
      * Get substation by code
      *
      * @remarks
-     * Retrieve a single electricity substation by its unique code.
-     *
-     * Substation codes are prefixed with the operator identifier — for example `ukpn:PRI-1234` for a UK Power Networks primary substation, or `npg:12345` for a Northern Powergrid substation.
-     *
-     * The response includes the substation's current capacity ratings, peak demand, and available headroom (spare capacity for new connections).
+     * Returns one electricity substation by its code, with the voltage it runs at, the peak demand it meets, its firm capacity and the headroom left for new connections. Codes are prefixed with the operator, as in `ukpn:PRI-1234` or `npg:12345`.
      */
     async getSubstation(request, options) {
         return unwrapAsync(energyGetSubstation(this, request, options));
@@ -145,22 +91,7 @@ export class Energy extends ClientSDK {
      * Search connection queue
      *
      * @remarks
-     * Search the national grid connection queue for projects awaiting or holding connection agreements to the electricity network.
-     *
-     * Covers both transmission-level connections (TEC Register) and distribution-level connections (Embedded Register) from NESO.
-     *
-     * **Available filters:**
-     * - `country` — filter by ISO 3166-1 alpha-2 country code
-     * - `operator` — filter by network operator code
-     * - `technologyType` — filter by canonical technology (e.g. `solar`, `battery`, `wind_onshore`)
-     * - `technologyCategory` — filter by category (generation, storage, thermal, demand)
-     * - `connectionStatus` — filter by lifecycle stage (e.g. `offer_accepted`, `connected`)
-     * - `networkLevel` — filter by voltage level (transmission, distribution)
-     * - `sourceDataset` — filter by source register (neso_tec, neso_embedded)
-     * - `substationCode` — filter by resolved substation
-     * - `minCapacityMw` / `maxCapacityMw` — filter by capacity range
-     *
-     * Results are ordered by capacity (largest first) and paginated using `limit` and `offset`.
+     * Searches the grid connection queue for projects waiting for or holding an agreement to connect to the electricity network, covering both the transmission register (TEC) and the distribution register (Embedded). Filter by country, operator, technology, technology group, connection stage, network level, source register, matched substation and capacity range. Results come back largest capacity first, paged with `limit` and `offset`. The per-technology breakdown of a project is returned only by the single-entry endpoint.
      */
     async searchConnectionQueue(request, options) {
         return unwrapAsync(energySearchConnectionQueue(this, request, options));
@@ -169,18 +100,7 @@ export class Energy extends ClientSDK {
      * Search embedded capacity register
      *
      * @remarks
-     * Search the Embedded Capacity Register (ECR) for generation and storage connections to the electricity distribution network.
-     *
-     * The ECR is a public record of all distributed generation (solar, wind, gas, biomass) and storage (battery) sites connected to the distribution network. Each entry includes the installed capacity, technology type, connection status, and location.
-     *
-     * **Available filters:**
-     * - `operator` — limit to a specific network operator
-     * - `operatingRegion` — limit to a specific operating region
-     * - `country` — filter by ISO 3166-1 alpha-2 country code
-     * - `technologyType` — filter by technology (e.g. `solar`, `wind`, `battery`)
-     * - `connectionStatus` — filter by lifecycle stage (e.g. `connected`, `accepted`)
-     *
-     * Results are ordered by installed capacity (largest first) and paginated using `limit` and `offset`.
+     * Searches the Embedded Capacity Register (ECR), the public record of generation and storage connected to the electricity distribution network, covering technologies such as solar, wind, gas, biomass and batteries. Each entry carries its installed and export capacity, technology, connection status and location. Filter by operator, licence area, country, technology or connection status. Results come back largest installed capacity first, paged with `limit` and `offset`.
      */
     async searchECR(request, options) {
         return unwrapAsync(energySearchECR(this, request, options));
@@ -189,17 +109,7 @@ export class Energy extends ClientSDK {
      * Search substations
      *
      * @remarks
-     * Search for substations across all network operators with optional filters.
-     *
-     * **Available filters:**
-     * - `operator` — limit to a specific network operator (e.g. `ukpn`, `npg`, `nged`)
-     * - `operatingRegion` — filter by operating region name
-     * - `country` — filter by ISO 3166-1 alpha-2 country code (e.g. `GB`, `IE`, `FR`)
-     * - `substationType` — filter by hierarchy level (primary, grid, distribution, etc.)
-     * - `minDemandHeadroomMw` / `maxDemandHeadroomMw` — filter by available demand headroom range
-     * - `minGenerationHeadroomMw` — filter by minimum generation headroom
-     *
-     * All filters are combined with AND logic. Results are paginated using `limit` and `offset`.
+     * Searches substations across every network operator. Filter by operator, licence area, country, position in the network hierarchy, and by how much demand or generation headroom a substation has left. Every filter supplied must match. Results come back ordered by substation code, paged with `limit` and `offset`, and carry the total count of matches.
      */
     async searchSubstations(request, options) {
         return unwrapAsync(energySearchSubstations(this, request, options));

package/dist/esm/sdk/energy.js.map

@@ -1 +1 @@
-{"version":3,"file":"energy.js","sourceRoot":"","sources":["../../../src/sdk/energy.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,oCAAoC,EAAE,MAAM,kDAAkD,CAAC;AACxG,OAAO,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAC1F,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAA8D,EAC9D,OAAwB;QAExB,OAAO,WAAW,CAAC,4BAA4B,CAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAA6D,EAC7D,OAAwB;QAExB,OAAO,WAAW,CAAC,2BAA2B,CAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,aAAa,CACjB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,WAAW,CACf,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,8BAA8B,CAClC,OAAyD,EACzD,OAAwB;QAExB,OAAO,WAAW,CAAC,oCAAoC,CACrD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,6BAA6B,CAC9C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,OAAO,CACX,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CACjB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAEa,EACb,OAAwB;QAExB,OAAO,WAAW,CAAC,2BAA2B,CAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,SAAS,CACb,OAAiD,EACjD,OAAwB;QAExB,OAAO,WAAW,CAAC,eAAe,CAChC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAwE,EACxE,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"energy.js","sourceRoot":"","sources":["../../../src/sdk/energy.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,oCAAoC,EAAE,MAAM,kDAAkD,CAAC;AACxG,OAAO,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAC1F,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAA8D,EAC9D,OAAwB;QAExB,OAAO,WAAW,CAAC,4BAA4B,CAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAA6D,EAC7D,OAAwB;QAExB,OAAO,WAAW,CAAC,2BAA2B,CAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CACf,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,8BAA8B,CAClC,OAAyD,EACzD,OAAwB;QAExB,OAAO,WAAW,CAAC,oCAAoC,CACrD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,6BAA6B,CAC9C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAEa,EACb,OAAwB;QAExB,OAAO,WAAW,CAAC,2BAA2B,CAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,OAAiD,EACjD,OAAwB;QAExB,OAAO,WAAW,CAAC,eAAe,CAChC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAwE,EACxE,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/epc.d.ts

@@ -6,18 +6,18 @@ export declare class Epc extends ClientSDK {
      * Get EPC certificates by location ID
      *
      * @remarks
-     * Returns all EPC certificates for a given UPRN, ordered by lodgement date (newest first). Includes domestic, non-domestic, and Display Energy Certificates. Each certificate contains structured energy ratings, building fabric analysis, improvement recommendations with numeric costs, and MEES compliance status.
+     * Returns every certificate held for one location, most recently lodged first: domestic and non-domestic Energy Performance Certificates as well as Display Energy Certificates. Each one carries its energy ratings, fabric assessment, recommended improvements with costed estimates, and its Minimum Energy Efficiency Standard status. Returns up to 1000 certificates per request; page through the rest with `limit` and `offset`.
      */
     getEpcByLocationId(request: operations.GetEpcByLocationIdRequest, options?: RequestOptions): Promise<operations.GetEpcByLocationIdResponseBody>;
     /**
-     * Health check
+     * Check EPC service health
      */
     getEpcHealth(options?: RequestOptions): Promise<operations.GetEpcHealthResponseBody>;
     /**
      * Search EPC certificates
      *
      * @remarks
-     * Search and filter EPC certificates by area, energy rating, building fabric, heating system, MEES compliance, and more. Same query interface as the Property API.
+     * Search certificates by area, energy rating, building fabric, heating system, running costs and Minimum Energy Efficiency Standard status. Geographic filters accept a postcode, a point and radius, a polygon, or a local authority code. Returns up to 10000 certificates per request, most recently lodged first unless `sort` says otherwise.
      */
     queryEpc(request: shared.EPCQueryRequest, options?: RequestOptions): Promise<shared.EPCQueryResponse>;
 }

package/dist/esm/sdk/epc.js

@@ -11,13 +11,13 @@ export class Epc extends ClientSDK {
      * Get EPC certificates by location ID
      *
      * @remarks
-     * Returns all EPC certificates for a given UPRN, ordered by lodgement date (newest first). Includes domestic, non-domestic, and Display Energy Certificates. Each certificate contains structured energy ratings, building fabric analysis, improvement recommendations with numeric costs, and MEES compliance status.
+     * Returns every certificate held for one location, most recently lodged first: domestic and non-domestic Energy Performance Certificates as well as Display Energy Certificates. Each one carries its energy ratings, fabric assessment, recommended improvements with costed estimates, and its Minimum Energy Efficiency Standard status. Returns up to 1000 certificates per request; page through the rest with `limit` and `offset`.
      */
     async getEpcByLocationId(request, options) {
         return unwrapAsync(epcGetEPCByLocationId(this, request, options));
     }
     /**
-     * Health check
+     * Check EPC service health
      */
     async getEpcHealth(options) {
         return unwrapAsync(epcGetEPCHealth(this, options));
@@ -26,7 +26,7 @@ export class Epc extends ClientSDK {
      * Search EPC certificates
      *
      * @remarks
-     * Search and filter EPC certificates by area, energy rating, building fabric, heating system, MEES compliance, and more. Same query interface as the Property API.
+     * Search certificates by area, energy rating, building fabric, heating system, running costs and Minimum Energy Efficiency Standard status. Geographic filters accept a postcode, a point and radius, a polygon, or a local authority code. Returns up to 10000 certificates per request, most recently lodged first unless `sort` says otherwise.
      */
     async queryEpc(request, options) {
         return unwrapAsync(epcQueryEPC(this, request, options));

package/dist/esm/sdk/floodrisk.d.ts

@@ -2,14 +2,10 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as shared from "./models/shared/index.js";
 export declare class FloodRisk extends ClientSDK {
     /**
-     * Coordinate-exact flood-risk assessment
+     * Assess flood risk at a coordinate
      *
      * @remarks
-     * Returns a property-level flood-risk assessment for a single (lat, lon) coordinate, from the Environment Agency National Flood Risk Assessment 2 (NaFRA-2).
-     *
-     * Separates the two real sources — Rivers & Sea (with depth-if-it-floods) and Surface Water (with hazard and flow velocity) — and reports present-day risk plus, where it differs, the climate-change 2080 outlook. Flood planning zone and nearby defences are included when present.
-     *
-     * Every response carries a `dataAvailability` field stating whether the point was assessed, falls outside modelled flood extents, or isn't yet covered (Scotland and Wales). Missing data is never reported as a green all-clear: `overallRiskLevel` is null when not assessed, and unbacked concerns (insurance, groundwater, reservoir, historic flooding) are omitted rather than synthesised.
+     * Returns the flood risk at one latitude and longitude, from the Environment Agency National Flood Risk Assessment 2. Rivers and sea (with the depth if it floods) and surface water (with hazard and flow velocity) are reported separately, alongside the present-day risk and, where it differs, the 2080 climate projection. The planning flood zone and nearby defences are included when the point has them. Read `dataAvailability` on every response before reading the bands: it says whether the point was assessed, sits outside every modelled flood extent, or is not yet covered, and `overallRiskLevel` is null rather than reassuring wherever no assessment was possible.
      */
     point(request?: shared.FloodRiskPointRequest | undefined, options?: RequestOptions): Promise<shared.FloodRiskPoint>;
 }

package/dist/esm/sdk/floodrisk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"floodrisk.d.ts","sourceRoot":"","sources":["../../../src/sdk/floodrisk.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,SAAU,SAAQ,SAAS;IACtC;;;;;;;;;OASG;IACG,KAAK,CACT,OAAO,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,SAAS,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;CAOlC"}
+{"version":3,"file":"floodrisk.d.ts","sourceRoot":"","sources":["../../../src/sdk/floodrisk.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,SAAU,SAAQ,SAAS;IACtC;;;;;OAKG;IACG,KAAK,CACT,OAAO,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,SAAS,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;CAOlC"}

package/dist/esm/sdk/floodrisk.js

@@ -6,14 +6,10 @@ import { ClientSDK } from "../lib/sdks.js";
 import { unwrapAsync } from "./types/fp.js";
 export class FloodRisk extends ClientSDK {
     /**
-     * Coordinate-exact flood-risk assessment
+     * Assess flood risk at a coordinate
      *
      * @remarks
-     * Returns a property-level flood-risk assessment for a single (lat, lon) coordinate, from the Environment Agency National Flood Risk Assessment 2 (NaFRA-2).
-     *
-     * Separates the two real sources — Rivers & Sea (with depth-if-it-floods) and Surface Water (with hazard and flow velocity) — and reports present-day risk plus, where it differs, the climate-change 2080 outlook. Flood planning zone and nearby defences are included when present.
-     *
-     * Every response carries a `dataAvailability` field stating whether the point was assessed, falls outside modelled flood extents, or isn't yet covered (Scotland and Wales). Missing data is never reported as a green all-clear: `overallRiskLevel` is null when not assessed, and unbacked concerns (insurance, groundwater, reservoir, historic flooding) are omitted rather than synthesised.
+     * Returns the flood risk at one latitude and longitude, from the Environment Agency National Flood Risk Assessment 2. Rivers and sea (with the depth if it floods) and surface water (with hazard and flow velocity) are reported separately, alongside the present-day risk and, where it differs, the 2080 climate projection. The planning flood zone and nearby defences are included when the point has them. Read `dataAvailability` on every response before reading the bands: it says whether the point was assessed, sits outside every modelled flood extent, or is not yet covered, and `overallRiskLevel` is null rather than reassuring wherever no assessment was possible.
      */
     async point(request, options) {
         return unwrapAsync(floodRiskPoint(this, request, options));

package/dist/esm/sdk/floodrisk.js.map

@@ -1 +1 @@
-{"version":3,"file":"floodrisk.js","sourceRoot":"","sources":["../../../src/sdk/floodrisk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC;;;;;;;;;OASG;IACH,KAAK,CAAC,KAAK,CACT,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"floodrisk.js","sourceRoot":"","sources":["../../../src/sdk/floodrisk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CACT,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/frameworks.d.ts

@@ -6,18 +6,14 @@ export declare class Frameworks extends ClientSDK {
      * Get framework with full metric definitions
      *
      * @remarks
-     * Returns a single framework entry plus the complete list of metric codes published under it. Each metric carries operational interpretation, unit, expected range, nominal national average, cohort dimensions and the publishing authority's small-cohort suppression policy.
-     *
-     * Use this to ground LLM responses: rather than asking a model what `ATT8` means, fetch the metric definition and inject it into the prompt.
+     * Returns one framework together with the full definition of every metric code published under it: what the metric means in a sentence, its unit, its expected range and typical national average, which pupil cohorts it is broken down by, and the authority's rule for suppressing small cohorts. Fetch this once rather than guessing what a code such as `ATT8` stands for. Responses are cacheable for 24 hours.
      */
     get(request: operations.GetFrameworkRequest, options?: RequestOptions): Promise<shared.FrameworkDetailResponse>;
     /**
-     * List all framework catalog entries
+     * List all framework catalogue entries
      *
      * @remarks
-     * Returns every framework registered against the Schools API — performance, destinations, census, finance, admissions and inspections — grouped by country and publishing authority. AI agents fetch this once per session and use it to interpret metric codes that appear inside per-school responses without inlining self-documentation on every payload.
-     *
-     * Cache aggressively: `Cache-Control: public, max-age=86400, immutable`. Changes are mirrored to `/v1/schools/changelog`.
+     * Lists every framework the Schools API publishes figures under, covering performance, destinations, census, finance, admissions and inspections. Each entry names the country, the authority that publishes it and the metric codes it carries, so metric codes seen in a school response can be interpreted without asking for definitions on every call. An entry with an empty `metricCodes` list is registered but not yet loaded. Responses are cacheable for 24 hours, and any change is mirrored to `/v1/schools/changelog`.
      */
     list(options?: RequestOptions): Promise<shared.FrameworkListResponse>;
 }

package/dist/esm/sdk/frameworks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"frameworks.d.ts","sourceRoot":"","sources":["../../../src/sdk/frameworks.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,UAAW,SAAQ,SAAS;IACvC;;;;;;;OAOG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC;IAQ1C;;;;;;;OAOG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC;CAMzC"}
+{"version":3,"file":"frameworks.d.ts","sourceRoot":"","sources":["../../../src/sdk/frameworks.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,UAAW,SAAQ,SAAS;IACvC;;;;;OAKG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC;IAQ1C;;;;;OAKG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC;CAMzC"}

package/dist/esm/sdk/frameworks.js

@@ -10,20 +10,16 @@ export class Frameworks extends ClientSDK {
      * Get framework with full metric definitions
      *
      * @remarks
-     * Returns a single framework entry plus the complete list of metric codes published under it. Each metric carries operational interpretation, unit, expected range, nominal national average, cohort dimensions and the publishing authority's small-cohort suppression policy.
-     *
-     * Use this to ground LLM responses: rather than asking a model what `ATT8` means, fetch the metric definition and inject it into the prompt.
+     * Returns one framework together with the full definition of every metric code published under it: what the metric means in a sentence, its unit, its expected range and typical national average, which pupil cohorts it is broken down by, and the authority's rule for suppressing small cohorts. Fetch this once rather than guessing what a code such as `ATT8` stands for. Responses are cacheable for 24 hours.
      */
     async get(request, options) {
         return unwrapAsync(schoolsFrameworksGet(this, request, options));
     }
     /**
-     * List all framework catalog entries
+     * List all framework catalogue entries
      *
      * @remarks
-     * Returns every framework registered against the Schools API — performance, destinations, census, finance, admissions and inspections — grouped by country and publishing authority. AI agents fetch this once per session and use it to interpret metric codes that appear inside per-school responses without inlining self-documentation on every payload.
-     *
-     * Cache aggressively: `Cache-Control: public, max-age=86400, immutable`. Changes are mirrored to `/v1/schools/changelog`.
+     * Lists every framework the Schools API publishes figures under, covering performance, destinations, census, finance, admissions and inspections. Each entry names the country, the authority that publishes it and the metric codes it carries, so metric codes seen in a school response can be interpreted without asking for definitions on every call. An entry with an empty `metricCodes` list is registered but not yet loaded. Responses are cacheable for 24 hours, and any change is mirrored to `/v1/schools/changelog`.
      */
     async list(options) {
         return unwrapAsync(schoolsFrameworksList(this, options));

package/dist/esm/sdk/frameworks.js.map

@@ -1 +1 @@
-{"version":3,"file":"frameworks.js","sourceRoot":"","sources":["../../../src/sdk/frameworks.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,UAAW,SAAQ,SAAS;IACvC;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,CACP,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"frameworks.js","sourceRoot":"","sources":["../../../src/sdk/frameworks.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,UAAW,SAAQ,SAAS;IACvC;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/geography.d.ts

@@ -0,0 +1,47 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+export declare class Geography extends ClientSDK {
+    /**
+     * Everything containing this area
+     *
+     * @remarks
+     * Walks the whole way up in one read: the containing area at every tier, with how many hops away it is and the worst fit along that path. Check `minFit` before aggregating — an LSOA reaches its local authority by best fit in the current release, because the exact-fit spine exists only at the 2022 boundaries.
+     */
+    getGeographyAncestors(request: operations.GetGeographyAncestorsRequest, options?: RequestOptions): Promise<operations.GetGeographyAncestorsResponseBody>;
+    /**
+     * Look up areas by code
+     *
+     * @remarks
+     * Resolves up to 100 comma-separated GSS codes to their name, type, vintage, nation and tier. A code can legitimately exist at more than one layer or edition, so every match is returned — narrow with `areaType` when a single answer is wanted.
+     */
+    getGeographyAreas(request: operations.GetGeographyAreasRequest, options?: RequestOptions): Promise<operations.GetGeographyAreasResponseBody>;
+    /**
+     * The immediate children of this area
+     *
+     * @remarks
+     * One hop down the curated tree, with the fit of each link and the source that won it. Where publishers disagreed about a parent, `sourceId` names the one whose claim was kept.
+     */
+    getGeographyChildren(request: operations.GetGeographyChildrenRequest, options?: RequestOptions): Promise<operations.GetGeographyChildrenResponseBody>;
+    /**
+     * Everything inside this area
+     *
+     * @remarks
+     * Paged, because the honest answer can be very large — England and Wales hold 188,880 Output Areas. `total_count` reports the full size of the set being paged through. Note that every unitary authority is both a district and a county under one code, so narrow with `areaType` or each descendant is returned once per matching type.
+     */
+    getGeographyDescendants(request: operations.GetGeographyDescendantsRequest, options?: RequestOptions): Promise<operations.GetGeographyDescendantsResponseBody>;
+    /**
+     * Where this area's record came from
+     *
+     * @remarks
+     * The publisher, the pinned file, its licence, and the acknowledgement line that licence requires — verbatim, because the wording differs per custodian and anyone redistributing this data has to reproduce it. `sha256` identifies the exact file the record was parsed from; `fromArchive` is true when the publisher was unreachable and the bytes came from our own archive.
+     */
+    getGeographyProvenance(request: operations.GetGeographyProvenanceRequest, options?: RequestOptions): Promise<operations.GetGeographyProvenanceResponseBody>;
+    /**
+     * Get the current geography release
+     *
+     * @remarks
+     * Returns the release every other geography endpoint answers from unless one is pinned. A release is a named set of publisher vintages that compose into one consistent tree — the nations publish on their own cycles, so a UK-wide release is a composition rather than a date.
+     */
+    getGeographyRelease(options?: RequestOptions): Promise<operations.GetGeographyReleaseResponseBody>;
+}
+//# sourceMappingURL=geography.d.ts.map

package/dist/esm/sdk/geography.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"geography.d.ts","sourceRoot":"","sources":["../../../src/sdk/geography.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAG3D,qBAAa,SAAU,SAAQ,SAAS;IACtC;;;;;OAKG;IACG,qBAAqB,CACzB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iCAAiC,CAAC;IAQxD;;;;;OAKG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAQpD;;;;;OAKG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gCAAgC,CAAC;IAQvD;;;;;OAKG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mCAAmC,CAAC;IAQ1D;;;;;OAKG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kCAAkC,CAAC;IAQzD;;;;;OAKG;IACG,mBAAmB,CACvB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+BAA+B,CAAC;CAMvD"}

package/dist/esm/sdk/geography.js

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { geographyGetGeographyAncestors } from "../funcs/geographyGetGeographyAncestors.js";
+import { geographyGetGeographyAreas } from "../funcs/geographyGetGeographyAreas.js";
+import { geographyGetGeographyChildren } from "../funcs/geographyGetGeographyChildren.js";
+import { geographyGetGeographyDescendants } from "../funcs/geographyGetGeographyDescendants.js";
+import { geographyGetGeographyProvenance } from "../funcs/geographyGetGeographyProvenance.js";
+import { geographyGetGeographyRelease } from "../funcs/geographyGetGeographyRelease.js";
+import { ClientSDK } from "../lib/sdks.js";
+import { unwrapAsync } from "./types/fp.js";
+export class Geography extends ClientSDK {
+    /**
+     * Everything containing this area
+     *
+     * @remarks
+     * Walks the whole way up in one read: the containing area at every tier, with how many hops away it is and the worst fit along that path. Check `minFit` before aggregating — an LSOA reaches its local authority by best fit in the current release, because the exact-fit spine exists only at the 2022 boundaries.
+     */
+    async getGeographyAncestors(request, options) {
+        return unwrapAsync(geographyGetGeographyAncestors(this, request, options));
+    }
+    /**
+     * Look up areas by code
+     *
+     * @remarks
+     * Resolves up to 100 comma-separated GSS codes to their name, type, vintage, nation and tier. A code can legitimately exist at more than one layer or edition, so every match is returned — narrow with `areaType` when a single answer is wanted.
+     */
+    async getGeographyAreas(request, options) {
+        return unwrapAsync(geographyGetGeographyAreas(this, request, options));
+    }
+    /**
+     * The immediate children of this area
+     *
+     * @remarks
+     * One hop down the curated tree, with the fit of each link and the source that won it. Where publishers disagreed about a parent, `sourceId` names the one whose claim was kept.
+     */
+    async getGeographyChildren(request, options) {
+        return unwrapAsync(geographyGetGeographyChildren(this, request, options));
+    }
+    /**
+     * Everything inside this area
+     *
+     * @remarks
+     * Paged, because the honest answer can be very large — England and Wales hold 188,880 Output Areas. `total_count` reports the full size of the set being paged through. Note that every unitary authority is both a district and a county under one code, so narrow with `areaType` or each descendant is returned once per matching type.
+     */
+    async getGeographyDescendants(request, options) {
+        return unwrapAsync(geographyGetGeographyDescendants(this, request, options));
+    }
+    /**
+     * Where this area's record came from
+     *
+     * @remarks
+     * The publisher, the pinned file, its licence, and the acknowledgement line that licence requires — verbatim, because the wording differs per custodian and anyone redistributing this data has to reproduce it. `sha256` identifies the exact file the record was parsed from; `fromArchive` is true when the publisher was unreachable and the bytes came from our own archive.
+     */
+    async getGeographyProvenance(request, options) {
+        return unwrapAsync(geographyGetGeographyProvenance(this, request, options));
+    }
+    /**
+     * Get the current geography release
+     *
+     * @remarks
+     * Returns the release every other geography endpoint answers from unless one is pinned. A release is a named set of publisher vintages that compose into one consistent tree — the nations publish on their own cycles, so a UK-wide release is a composition rather than a date.
+     */
+    async getGeographyRelease(options) {
+        return unwrapAsync(geographyGetGeographyRelease(this, options));
+    }
+}
+//# sourceMappingURL=geography.js.map

package/dist/esm/sdk/geography.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"geography.js","sourceRoot":"","sources":["../../../src/sdk/geography.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,4CAA4C,CAAC;AAC5F,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAC1F,OAAO,EAAE,gCAAgC,EAAE,MAAM,8CAA8C,CAAC;AAChG,OAAO,EAAE,+BAA+B,EAAE,MAAM,6CAA6C,CAAC;AAC9F,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AACxF,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,8BAA8B,CAC/C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,0BAA0B,CAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,WAAW,CAAC,6BAA6B,CAC9C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,gCAAgC,CACjD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAiD,EACjD,OAAwB;QAExB,OAAO,WAAW,CAAC,+BAA+B,CAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAwB;QAExB,OAAO,WAAW,CAAC,4BAA4B,CAC7C,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/heritage.d.ts

@@ -3,31 +3,31 @@ import * as operations from "./models/operations/index.js";
 import * as shared from "./models/shared/index.js";
 export declare class Heritage extends ClientSDK {
     /**
-     * Retrieve one heritage designation
+     * Get one heritage designation
      *
      * @remarks
-     * Retrieve a single designation by its stable `designationId`. Add `?attributes=geometry` for the full boundary, and `?snapshotId=` to pin a historical published snapshot for reproducibility.
+     * Returns a single designation by its stable `designationId`. Add `?attributes=geometry` for the full boundary, and `?snapshotId=` to read an earlier published snapshot so a result can be reproduced.
      */
     get(request: operations.GetHeritageDesignationRequest, options?: RequestOptions): Promise<shared.HeritageDesignationFeature>;
     /**
      * Query heritage designations near a place
      *
      * @remarks
-     * Retrieve heritage designations for one or more geographic areas — point (with radius), postcode, outcode, bounding-box, polygon or multipolygon. Up to 10 areas per request, OR-combined and deduplicated by `designationId`. Radius 0 returns designations whose boundary contains the point. The full MultiPolygon boundary is opt-in via `attributes: ['geometry']`; source lineage and the harmonised value domain require extended permissions on the licence.
+     * Returns heritage designations for one or more areas, given as a point with a radius, a postcode, an outward code, a bounding box, a polygon or a multipolygon. Up to ten areas can be combined in one request, and their results are deduplicated by `designationId`. A radius of 0 returns only the designations whose boundary contains the point. Ask for `geometry` in `attributes` to add the full MultiPolygon boundary; source lineage and the harmonised value fields need extended permissions on the licence.
      */
     query(request?: shared.DesignationQueryRequest | undefined, options?: RequestOptions): Promise<shared.HeritageDesignationListResponse>;
     /**
      * List heritage data snapshots
      *
      * @remarks
-     * List the published snapshots (data lineage / freshness), newest first.
+     * Lists the published snapshots, newest first, with when each was published and how many designations it holds. Use it to check how fresh the data is, or to find a snapshot id to pin a query to.
      */
     snapshots(options?: RequestOptions): Promise<shared.DesignationSnapshotListResponse>;
     /**
      * List heritage designation types
      *
      * @remarks
-     * The self-describing vocabulary for this product — every designation type in the current snapshot with its label and count. Public: it needs no licence, so prospects can see coverage before buying.
+     * Lists every designation type in the current snapshot with its label and how many designations carry it. It needs no licence, so coverage can be checked before buying, and the codes it returns are the ones to pass to the query endpoint's `designationType` filter.
      */
     types(options?: RequestOptions): Promise<shared.DesignationTypeListResponse>;
 }

package/dist/esm/sdk/heritage.js

@@ -9,10 +9,10 @@ import { ClientSDK } from "../lib/sdks.js";
 import { unwrapAsync } from "./types/fp.js";
 export class Heritage extends ClientSDK {
     /**
-     * Retrieve one heritage designation
+     * Get one heritage designation
      *
      * @remarks
-     * Retrieve a single designation by its stable `designationId`. Add `?attributes=geometry` for the full boundary, and `?snapshotId=` to pin a historical published snapshot for reproducibility.
+     * Returns a single designation by its stable `designationId`. Add `?attributes=geometry` for the full boundary, and `?snapshotId=` to read an earlier published snapshot so a result can be reproduced.
      */
     async get(request, options) {
         return unwrapAsync(heritageGet(this, request, options));
@@ -21,7 +21,7 @@ export class Heritage extends ClientSDK {
      * Query heritage designations near a place
      *
      * @remarks
-     * Retrieve heritage designations for one or more geographic areas — point (with radius), postcode, outcode, bounding-box, polygon or multipolygon. Up to 10 areas per request, OR-combined and deduplicated by `designationId`. Radius 0 returns designations whose boundary contains the point. The full MultiPolygon boundary is opt-in via `attributes: ['geometry']`; source lineage and the harmonised value domain require extended permissions on the licence.
+     * Returns heritage designations for one or more areas, given as a point with a radius, a postcode, an outward code, a bounding box, a polygon or a multipolygon. Up to ten areas can be combined in one request, and their results are deduplicated by `designationId`. A radius of 0 returns only the designations whose boundary contains the point. Ask for `geometry` in `attributes` to add the full MultiPolygon boundary; source lineage and the harmonised value fields need extended permissions on the licence.
      */
     async query(request, options) {
         return unwrapAsync(heritageQuery(this, request, options));
@@ -30,7 +30,7 @@ export class Heritage extends ClientSDK {
      * List heritage data snapshots
      *
      * @remarks
-     * List the published snapshots (data lineage / freshness), newest first.
+     * Lists the published snapshots, newest first, with when each was published and how many designations it holds. Use it to check how fresh the data is, or to find a snapshot id to pin a query to.
      */
     async snapshots(options) {
         return unwrapAsync(heritageSnapshots(this, options));
@@ -39,7 +39,7 @@ export class Heritage extends ClientSDK {
      * List heritage designation types
      *
      * @remarks
-     * The self-describing vocabulary for this product — every designation type in the current snapshot with its label and count. Public: it needs no licence, so prospects can see coverage before buying.
+     * Lists every designation type in the current snapshot with its label and how many designations carry it. It needs no licence, so coverage can be checked before buying, and the codes it returns are the ones to pass to the query endpoint's `designationType` filter.
      */
     async types(options) {
         return unwrapAsync(heritageTypes(this, options));