@vepler/sdk 2.30.2 → 2.33.0

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

@@ -0,0 +1,530 @@
+/*
+ * 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 { ClosedEnum, OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Environmental or geographic layer type for coverage calculations
+ */
+export const CoverageType = {
+  FloodRisk: "flood_risk",
+  NoiseRoadLden: "noise_road_lden",
+  NoiseRailLden: "noise_rail_lden",
+  NoiseIndustryLden: "noise_industry_lden",
+  RadonLevel: "radon_level",
+  Ramsar: "ramsar",
+  SpecialAreaConservation: "special_area_conservation",
+  SpecialProtectionArea: "special_protection_area",
+  AncientWoodland: "ancient_woodland",
+  NativeWoodlandSurvey: "native_woodland_survey",
+  AreaNaturalBeauty: "area_natural_beauty",
+  NationalScenicArea: "national_scenic_area",
+  PriorityHabitats: "priority_habitats",
+  ProtectedWoodlands: "protected_woodlands",
+  Natura2000: "natura_2000",
+  Aonb: "aonb",
+  ProtectedScenicLandscapes: "protected_scenic_landscapes",
+  HistoricLandfillSite: "historic_landfill_site",
+  WorldHeritageSite: "world_heritage_site",
+  ProtectedWreckSite: "protected_wreck_site",
+  ScheduledMonument: "scheduled_monument",
+  Battlefield: "battlefield",
+  BrownfieldLand: "brownfield_land",
+  GreenBelt: "green_belt",
+  CommonLand: "common_land",
+  BuiltUpArea250: "built_up_area_250",
+  ParcelsGb: "parcels_gb",
+  Building: "building",
+} as const;
+/**
+ * Environmental or geographic layer type for coverage calculations
+ */
+export type CoverageType = ClosedEnum<typeof CoverageType>;
+
+/**
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), 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 IntersectsWith = {
+  Postcode: "postcode",
+  Outcode: "outcode",
+  UkOutputArea: "uk_output_area",
+  Lsoa21: "lsoa21",
+  Ward: "ward",
+  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;
+/**
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), 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 IntersectsWith = ClosedEnum<typeof IntersectsWith>;
+
+export type GetAreaCoverageRequest = {
+  /**
+   * Coverage layer type for environmental coverage analysis (e.g., flood_risk, noise_road_lden). Mutually exclusive with targetCode.
+   */
+  coverageType?: CoverageType | undefined;
+  /**
+   * Entity type to calculate intersection coverage for (e.g., building, parcels_gb). Only applicable with coverageType.
+   */
+  intersectsWith?: IntersectsWith | undefined;
+  /**
+   * Source geography code to analyse coverage for (e.g., E05000001 for a ward)
+   */
+  sourceCode: string;
+  /**
+   * Target geography code for geography-to-geography coverage calculation. Mutually exclusive with coverageType.
+   */
+  targetCode?: string | undefined;
+};
+
+/**
+ * Additional metadata about the coverage result
+ */
+export type GetAreaCoverageMetadata = {
+  /**
+   * Category name for categorised data (e.g., high, medium, low)
+   */
+  category?: string | undefined;
+  /**
+   * Component layer types for composite coverage types
+   */
+  componentLayers?: Array<string> | undefined;
+  /**
+   * Decibel range for noise coverage (e.g., '<55dB', '55-70dB', '>70dB')
+   */
+  dbRange?: string | undefined;
+  /**
+   * Count of entities affected (for intersectsWith queries)
+   */
+  entityCount?: number | undefined;
+  /**
+   * Number of features contributing to this coverage result
+   */
+  featureCount?: number | undefined;
+  /**
+   * Total count of entities in source area (for intersectsWith queries)
+   */
+  totalEntities?: number | undefined;
+};
+
+/**
+ * Individual coverage calculation result
+ */
+export type Coverage = {
+  /**
+   * Area covered in square metres
+   */
+  area: number;
+  /**
+   * Identifier for the coverage area (e.g., 'flood_risk_high', 'E06000001', '<55dB')
+   */
+  identifier: string;
+  /**
+   * Additional metadata about the coverage result
+   */
+  metadata?: GetAreaCoverageMetadata | undefined;
+  /**
+   * Coverage percentage of the relevant area (source area or intersecting entities)
+   */
+  percentage: number;
+};
+
+/**
+ * Environmental or geographic layer type for coverage calculations
+ */
+export const GetAreaCoverageCoverageType = {
+  FloodRisk: "flood_risk",
+  NoiseRoadLden: "noise_road_lden",
+  NoiseRailLden: "noise_rail_lden",
+  NoiseIndustryLden: "noise_industry_lden",
+  RadonLevel: "radon_level",
+  Ramsar: "ramsar",
+  SpecialAreaConservation: "special_area_conservation",
+  SpecialProtectionArea: "special_protection_area",
+  AncientWoodland: "ancient_woodland",
+  NativeWoodlandSurvey: "native_woodland_survey",
+  AreaNaturalBeauty: "area_natural_beauty",
+  NationalScenicArea: "national_scenic_area",
+  PriorityHabitats: "priority_habitats",
+  ProtectedWoodlands: "protected_woodlands",
+  Natura2000: "natura_2000",
+  Aonb: "aonb",
+  ProtectedScenicLandscapes: "protected_scenic_landscapes",
+  HistoricLandfillSite: "historic_landfill_site",
+  WorldHeritageSite: "world_heritage_site",
+  ProtectedWreckSite: "protected_wreck_site",
+  ScheduledMonument: "scheduled_monument",
+  Battlefield: "battlefield",
+  BrownfieldLand: "brownfield_land",
+  GreenBelt: "green_belt",
+  CommonLand: "common_land",
+  BuiltUpArea250: "built_up_area_250",
+  ParcelsGb: "parcels_gb",
+  Building: "building",
+} as const;
+/**
+ * Environmental or geographic layer type for coverage calculations
+ */
+export type GetAreaCoverageCoverageType = OpenEnum<
+  typeof GetAreaCoverageCoverageType
+>;
+
+/**
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), 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 GetAreaCoverageIntersectsWith = {
+  Postcode: "postcode",
+  Outcode: "outcode",
+  UkOutputArea: "uk_output_area",
+  Lsoa21: "lsoa21",
+  Ward: "ward",
+  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;
+/**
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), 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 GetAreaCoverageIntersectsWith = OpenEnum<
+  typeof GetAreaCoverageIntersectsWith
+>;
+
+/**
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), 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 SourceType = {
+  Postcode: "postcode",
+  Outcode: "outcode",
+  UkOutputArea: "uk_output_area",
+  Lsoa21: "lsoa21",
+  Ward: "ward",
+  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;
+/**
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), 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 SourceType = OpenEnum<typeof SourceType>;
+
+/**
+ * Response containing coverage analysis for a geographic area. Returns either geography-to-geography overlap or environmental layer coverage depending on query parameters.
+ */
+export type GetAreaCoverageResponseBody = {
+  /**
+   * Array of coverage calculation results
+   */
+  coverage: Array<Coverage>;
+  /**
+   * Environmental or geographic layer type for coverage calculations
+   */
+  coverageType?: GetAreaCoverageCoverageType | undefined;
+  /**
+   * Layer type - supports postcodes, outcodes (e.g., SW1A), 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
+   */
+  intersectsWith?: GetAreaCoverageIntersectsWith | undefined;
+  /**
+   * Optional message providing additional context about the response
+   */
+  message?: string | undefined;
+  /**
+   * Total area of source geography in square metres
+   */
+  sourceArea: number;
+  /**
+   * Source geography code that was analysed
+   */
+  sourceCode: string;
+  /**
+   * Human-readable name of the source geography
+   */
+  sourceName: string;
+  /**
+   * Layer type - supports postcodes, outcodes (e.g., SW1A), 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
+   */
+  sourceType: SourceType;
+  /**
+   * Indicates whether the request was successful
+   */
+  success: boolean;
+  /**
+   * Target geography code (for geography-to-geography queries)
+   */
+  targetCode?: string | undefined;
+  /**
+   * Target geography name (for geography-to-geography queries)
+   */
+  targetName?: string | undefined;
+};
+
+/** @internal */
+export const CoverageType$outboundSchema: z.ZodNativeEnum<typeof CoverageType> =
+  z.nativeEnum(CoverageType);
+
+/** @internal */
+export const IntersectsWith$outboundSchema: z.ZodNativeEnum<
+  typeof IntersectsWith
+> = z.nativeEnum(IntersectsWith);
+
+/** @internal */
+export type GetAreaCoverageRequest$Outbound = {
+  coverageType?: string | undefined;
+  intersectsWith?: string | undefined;
+  sourceCode: string;
+  targetCode?: string | undefined;
+};
+
+/** @internal */
+export const GetAreaCoverageRequest$outboundSchema: z.ZodType<
+  GetAreaCoverageRequest$Outbound,
+  z.ZodTypeDef,
+  GetAreaCoverageRequest
+> = z.object({
+  coverageType: CoverageType$outboundSchema.optional(),
+  intersectsWith: IntersectsWith$outboundSchema.optional(),
+  sourceCode: z.string(),
+  targetCode: z.string().optional(),
+});
+
+export function getAreaCoverageRequestToJSON(
+  getAreaCoverageRequest: GetAreaCoverageRequest,
+): string {
+  return JSON.stringify(
+    GetAreaCoverageRequest$outboundSchema.parse(getAreaCoverageRequest),
+  );
+}
+
+/** @internal */
+export const GetAreaCoverageMetadata$inboundSchema: z.ZodType<
+  GetAreaCoverageMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  category: z.string().optional(),
+  componentLayers: z.array(z.string()).optional(),
+  dbRange: z.string().optional(),
+  entityCount: z.number().optional(),
+  featureCount: z.number().optional(),
+  totalEntities: z.number().optional(),
+});
+
+export function getAreaCoverageMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAreaCoverageMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAreaCoverageMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAreaCoverageMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const Coverage$inboundSchema: z.ZodType<
+  Coverage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  area: z.number(),
+  identifier: z.string(),
+  metadata: z.lazy(() => GetAreaCoverageMetadata$inboundSchema).optional(),
+  percentage: z.number(),
+});
+
+export function coverageFromJSON(
+  jsonString: string,
+): SafeParseResult<Coverage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Coverage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Coverage' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAreaCoverageCoverageType$inboundSchema: z.ZodType<
+  GetAreaCoverageCoverageType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetAreaCoverageCoverageType);
+
+/** @internal */
+export const GetAreaCoverageIntersectsWith$inboundSchema: z.ZodType<
+  GetAreaCoverageIntersectsWith,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetAreaCoverageIntersectsWith);
+
+/** @internal */
+export const SourceType$inboundSchema: z.ZodType<
+  SourceType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SourceType);
+
+/** @internal */
+export const GetAreaCoverageResponseBody$inboundSchema: z.ZodType<
+  GetAreaCoverageResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  coverage: z.array(z.lazy(() => Coverage$inboundSchema)),
+  coverageType: GetAreaCoverageCoverageType$inboundSchema.optional(),
+  intersectsWith: GetAreaCoverageIntersectsWith$inboundSchema.optional(),
+  message: z.string().optional(),
+  sourceArea: z.number(),
+  sourceCode: z.string(),
+  sourceName: z.string(),
+  sourceType: SourceType$inboundSchema,
+  success: z.boolean(),
+  targetCode: z.string().optional(),
+  targetName: z.string().optional(),
+});
+
+export function getAreaCoverageResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAreaCoverageResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAreaCoverageResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAreaCoverageResponseBody' from JSON`,
+  );
+}