@vepler/sdk 2.8.0 → 2.12.0

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

@@ -9,21 +9,63 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
  */
 export const GeographicType = {
   Postcode: "postcode",
-  Lsoa21: "lsoa21",
   UkOutputArea: "uk_output_area",
+  Lsoa21: "lsoa21",
   Ward: "ward",
-  Country: "country",
-  County: "county",
+  Parish: "parish",
   LocalAuthorityDistrict: "local_authority_district",
+  County: "county",
+  Country: "country",
+  CountyElectoralDivision: "county_electoral_division",
+  DistrictBoroughUnitary: "district_borough_unitary",
+  DistrictBoroughUnitaryWard: "district_borough_unitary_ward",
+  LocalPlanningAuthority: "local_planning_authority",
+  CeremonialCountiesRegion: "ceremonial_counties_region",
+  EnglishRegion: "english_region",
+  CountryRegion: "country_region",
+  UnitaryElectoralDivision: "unitary_electoral_division",
+  Province: "province",
+  ElectoralDivision: "electoral_division",
+  GreaterLondonConstituency: "greater_london_constituency",
+  ScotlandAndWalesConstituency: "scotland_and_wales_constituency",
+  ScotlandAndWalesRegion: "scotland_and_wales_region",
+  WestminsterConstituency: "westminster_constituency",
+  Building: "building",
+  BuiltUpArea250: "built_up_area_250",
+  GreenBelt: "green_belt",
+  CommonLand: "common_land",
+  ParcelsGb: "parcels_gb",
+  FloodRisk: "flood_risk",
+  Ramsar: "ramsar",
+  Natura2000: "natura_2000",
+  Aonb: "aonb",
   AreaNaturalBeauty: "area_natural_beauty",
   NationalScenicArea: "national_scenic_area",
+  SpecialAreaConservation: "special_area_conservation",
+  SpecialProtectionArea: "special_protection_area",
+  AncientWoodland: "ancient_woodland",
+  NativeWoodlandSurvey: "native_woodland_survey",
+  PriorityHabitats: "priority_habitats",
+  ProtectedWoodlands: "protected_woodlands",
+  ProtectedWoodland: "protected_woodland",
+  ProtectedScenicLandscapes: "protected_scenic_landscapes",
+  WorldHeritageSite: "world_heritage_site",
+  ScheduledMonument: "scheduled_monument",
+  Battlefield: "battlefield",
+  ProtectedWreckSite: "protected_wreck_site",
+  HistoricLandfillSite: "historic_landfill_site",
+  RadonLevel: "radon_level",
+  BrownfieldLand: "brownfield_land",
+  NoiseRailLden: "noise_rail_lden",
+  NoiseRoadLden: "noise_road_lden",
+  NoiseIndustryLden: "noise_industry_lden",
 } as const;
 /**
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
  */
 export type GeographicType = ClosedEnum<typeof GeographicType>;
 
@@ -32,7 +74,7 @@ export type GetMetricValuesRequest = {
   endPeriod?: string | undefined;
   geographicCode?: string | undefined;
   /**
-   * Type of geographic entity. Options: postcode (UK postal code area), lsoa21 (Lower Layer Super Output Area 2021), uk_output_area (Census Output Area), ward (Electoral ward), country (Country level), county (County level), local_authority_district (Local authority district), area_natural_beauty (Area of Outstanding Natural Beauty), national_scenic_area (National Scenic Area in Scotland)
+   * Layer type identifier. Includes ONS statistical geographies, HM Land Registry INSPIRE polygons, Environment Agency flood zones, Natural England/NatureScot environmental designations, Historic England heritage assets, and DEFRA END Directive noise mapping.
    */
   geographicType?: GeographicType | undefined;
   includeGeographyDetails?: string | undefined;
@@ -97,42 +139,126 @@ export type Pagination = {
 };
 
 /**
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
  */
 export const GetMetricValuesGeographicType = {
   Postcode: "postcode",
-  Lsoa21: "lsoa21",
   UkOutputArea: "uk_output_area",
+  Lsoa21: "lsoa21",
   Ward: "ward",
-  Country: "country",
-  County: "county",
+  Parish: "parish",
   LocalAuthorityDistrict: "local_authority_district",
+  County: "county",
+  Country: "country",
+  CountyElectoralDivision: "county_electoral_division",
+  DistrictBoroughUnitary: "district_borough_unitary",
+  DistrictBoroughUnitaryWard: "district_borough_unitary_ward",
+  LocalPlanningAuthority: "local_planning_authority",
+  CeremonialCountiesRegion: "ceremonial_counties_region",
+  EnglishRegion: "english_region",
+  CountryRegion: "country_region",
+  UnitaryElectoralDivision: "unitary_electoral_division",
+  Province: "province",
+  ElectoralDivision: "electoral_division",
+  GreaterLondonConstituency: "greater_london_constituency",
+  ScotlandAndWalesConstituency: "scotland_and_wales_constituency",
+  ScotlandAndWalesRegion: "scotland_and_wales_region",
+  WestminsterConstituency: "westminster_constituency",
+  Building: "building",
+  BuiltUpArea250: "built_up_area_250",
+  GreenBelt: "green_belt",
+  CommonLand: "common_land",
+  ParcelsGb: "parcels_gb",
+  FloodRisk: "flood_risk",
+  Ramsar: "ramsar",
+  Natura2000: "natura_2000",
+  Aonb: "aonb",
   AreaNaturalBeauty: "area_natural_beauty",
   NationalScenicArea: "national_scenic_area",
+  SpecialAreaConservation: "special_area_conservation",
+  SpecialProtectionArea: "special_protection_area",
+  AncientWoodland: "ancient_woodland",
+  NativeWoodlandSurvey: "native_woodland_survey",
+  PriorityHabitats: "priority_habitats",
+  ProtectedWoodlands: "protected_woodlands",
+  ProtectedWoodland: "protected_woodland",
+  ProtectedScenicLandscapes: "protected_scenic_landscapes",
+  WorldHeritageSite: "world_heritage_site",
+  ScheduledMonument: "scheduled_monument",
+  Battlefield: "battlefield",
+  ProtectedWreckSite: "protected_wreck_site",
+  HistoricLandfillSite: "historic_landfill_site",
+  RadonLevel: "radon_level",
+  BrownfieldLand: "brownfield_land",
+  NoiseRailLden: "noise_rail_lden",
+  NoiseRoadLden: "noise_road_lden",
+  NoiseIndustryLden: "noise_industry_lden",
 } as const;
 /**
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
  */
 export type GetMetricValuesGeographicType = ClosedEnum<
   typeof GetMetricValuesGeographicType
 >;
 
 /**
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
  */
 export const GetMetricValuesType = {
   Postcode: "postcode",
-  Lsoa21: "lsoa21",
   UkOutputArea: "uk_output_area",
+  Lsoa21: "lsoa21",
   Ward: "ward",
-  Country: "country",
-  County: "county",
+  Parish: "parish",
   LocalAuthorityDistrict: "local_authority_district",
+  County: "county",
+  Country: "country",
+  CountyElectoralDivision: "county_electoral_division",
+  DistrictBoroughUnitary: "district_borough_unitary",
+  DistrictBoroughUnitaryWard: "district_borough_unitary_ward",
+  LocalPlanningAuthority: "local_planning_authority",
+  CeremonialCountiesRegion: "ceremonial_counties_region",
+  EnglishRegion: "english_region",
+  CountryRegion: "country_region",
+  UnitaryElectoralDivision: "unitary_electoral_division",
+  Province: "province",
+  ElectoralDivision: "electoral_division",
+  GreaterLondonConstituency: "greater_london_constituency",
+  ScotlandAndWalesConstituency: "scotland_and_wales_constituency",
+  ScotlandAndWalesRegion: "scotland_and_wales_region",
+  WestminsterConstituency: "westminster_constituency",
+  Building: "building",
+  BuiltUpArea250: "built_up_area_250",
+  GreenBelt: "green_belt",
+  CommonLand: "common_land",
+  ParcelsGb: "parcels_gb",
+  FloodRisk: "flood_risk",
+  Ramsar: "ramsar",
+  Natura2000: "natura_2000",
+  Aonb: "aonb",
   AreaNaturalBeauty: "area_natural_beauty",
   NationalScenicArea: "national_scenic_area",
+  SpecialAreaConservation: "special_area_conservation",
+  SpecialProtectionArea: "special_protection_area",
+  AncientWoodland: "ancient_woodland",
+  NativeWoodlandSurvey: "native_woodland_survey",
+  PriorityHabitats: "priority_habitats",
+  ProtectedWoodlands: "protected_woodlands",
+  ProtectedWoodland: "protected_woodland",
+  ProtectedScenicLandscapes: "protected_scenic_landscapes",
+  WorldHeritageSite: "world_heritage_site",
+  ScheduledMonument: "scheduled_monument",
+  Battlefield: "battlefield",
+  ProtectedWreckSite: "protected_wreck_site",
+  HistoricLandfillSite: "historic_landfill_site",
+  RadonLevel: "radon_level",
+  BrownfieldLand: "brownfield_land",
+  NoiseRailLden: "noise_rail_lden",
+  NoiseRoadLden: "noise_road_lden",
+  NoiseIndustryLden: "noise_industry_lden",
 } as const;
 /**
- * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
  */
 export type GetMetricValuesType = ClosedEnum<typeof GetMetricValuesType>;
 
@@ -140,7 +266,7 @@ export type Geography = {
   code: string;
   name: string;
   /**
-   * Geographic hierarchy type - from smallest (output_area) to largest (country)
+   * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
    */
   type: GetMetricValuesType;
 };
@@ -185,7 +311,7 @@ export type GetMetricValuesResult = {
   createdAt: string;
   geographicCode: string;
   /**
-   * Geographic hierarchy type - from smallest (output_area) to largest (country)
+   * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
    */
   geographicType: GetMetricValuesGeographicType;
   geography?: Geography | undefined;

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

@@ -11,8 +11,6 @@ export * from "./getareaswithinradius.js";
 export * from "./getborderingareas.js";
 export * from "./getchildareas.js";
 export * from "./getconnectivityscores.js";
-export * from "./getepcbylocationid.js";
-export * from "./getepcbypostcode.js";
 export * from "./getlistingbyid.js";
 export * from "./getlistingbysource.js";
 export * from "./getlistingsbylocation.js";
@@ -35,6 +33,7 @@ export * from "./getv1safetycrime.js";
 export * from "./getv1safetycrimestats.js";
 export * from "./listschools.js";
 export * from "./predictpropertyvalue.js";
+export * from "./predictpropertyvaluebylocation.js";
 export * from "./querylistings.js";
 export * from "./querylistingsbysource.js";
 export * from "./resolveaddress.js";