@vepler/sdk 2.30.2 → 2.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +90 -85
- package/dist/commonjs/funcs/areasGetCoverage.d.ts +24 -0
- package/dist/commonjs/funcs/areasGetCoverage.d.ts.map +1 -0
- package/dist/commonjs/funcs/areasGetCoverage.js +130 -0
- package/dist/commonjs/funcs/areasGetCoverage.js.map +1 -0
- package/dist/commonjs/funcs/metricsGetMetricValues.js +9 -8
- package/dist/commonjs/funcs/metricsGetMetricValues.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/sdk/areas.d.ts +13 -0
- package/dist/commonjs/sdk/areas.d.ts.map +1 -1
- package/dist/commonjs/sdk/areas.js +16 -0
- package/dist/commonjs/sdk/areas.js.map +1 -1
- package/dist/commonjs/sdk/models/errors/getareacoverage.d.ts +156 -0
- package/dist/commonjs/sdk/models/errors/getareacoverage.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/errors/getareacoverage.js +153 -0
- package/dist/commonjs/sdk/models/errors/getareacoverage.js.map +1 -0
- package/dist/commonjs/sdk/models/errors/index.d.ts +1 -0
- package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/errors/index.js +1 -0
- package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/getareacoverage.d.ts +408 -0
- package/dist/commonjs/sdk/models/operations/getareacoverage.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/operations/getareacoverage.js +343 -0
- package/dist/commonjs/sdk/models/operations/getareacoverage.js.map +1 -0
- package/dist/commonjs/sdk/models/operations/getmetricvalues.d.ts +36 -85
- package/dist/commonjs/sdk/models/operations/getmetricvalues.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getmetricvalues.js +12 -70
- package/dist/commonjs/sdk/models/operations/getmetricvalues.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/index.d.ts +1 -0
- package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/index.js +1 -0
- package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
- package/dist/esm/funcs/areasGetCoverage.d.ts +24 -0
- package/dist/esm/funcs/areasGetCoverage.d.ts.map +1 -0
- package/dist/esm/funcs/areasGetCoverage.js +94 -0
- package/dist/esm/funcs/areasGetCoverage.js.map +1 -0
- package/dist/esm/funcs/metricsGetMetricValues.js +9 -8
- package/dist/esm/funcs/metricsGetMetricValues.js.map +1 -1
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/sdk/areas.d.ts +13 -0
- package/dist/esm/sdk/areas.d.ts.map +1 -1
- package/dist/esm/sdk/areas.js +16 -0
- package/dist/esm/sdk/areas.js.map +1 -1
- package/dist/esm/sdk/models/errors/getareacoverage.d.ts +156 -0
- package/dist/esm/sdk/models/errors/getareacoverage.d.ts.map +1 -0
- package/dist/esm/sdk/models/errors/getareacoverage.js +114 -0
- package/dist/esm/sdk/models/errors/getareacoverage.js.map +1 -0
- package/dist/esm/sdk/models/errors/index.d.ts +1 -0
- package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
- package/dist/esm/sdk/models/errors/index.js +1 -0
- package/dist/esm/sdk/models/errors/index.js.map +1 -1
- package/dist/esm/sdk/models/operations/getareacoverage.d.ts +408 -0
- package/dist/esm/sdk/models/operations/getareacoverage.d.ts.map +1 -0
- package/dist/esm/sdk/models/operations/getareacoverage.js +303 -0
- package/dist/esm/sdk/models/operations/getareacoverage.js.map +1 -0
- package/dist/esm/sdk/models/operations/getmetricvalues.d.ts +36 -85
- package/dist/esm/sdk/models/operations/getmetricvalues.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getmetricvalues.js +11 -69
- package/dist/esm/sdk/models/operations/getmetricvalues.js.map +1 -1
- package/dist/esm/sdk/models/operations/index.d.ts +1 -0
- package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/index.js +1 -0
- package/dist/esm/sdk/models/operations/index.js.map +1 -1
- package/package.json +1 -1
- package/src/funcs/areasGetCoverage.ts +193 -0
- package/src/funcs/metricsGetMetricValues.ts +9 -8
- package/src/lib/config.ts +2 -2
- package/src/sdk/areas.ts +24 -0
- package/src/sdk/models/errors/getareacoverage.ts +264 -0
- package/src/sdk/models/errors/index.ts +1 -0
- package/src/sdk/models/operations/getareacoverage.ts +530 -0
- package/src/sdk/models/operations/getmetricvalues.ts +48 -102
- package/src/sdk/models/operations/index.ts +1 -0
|
@@ -0,0 +1,408 @@
|
|
|
1
|
+
import * as z from "zod/v3";
|
|
2
|
+
import { ClosedEnum, OpenEnum } from "../../types/enums.js";
|
|
3
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
4
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
5
|
+
/**
|
|
6
|
+
* Environmental or geographic layer type for coverage calculations
|
|
7
|
+
*/
|
|
8
|
+
export declare const CoverageType: {
|
|
9
|
+
readonly FloodRisk: "flood_risk";
|
|
10
|
+
readonly NoiseRoadLden: "noise_road_lden";
|
|
11
|
+
readonly NoiseRailLden: "noise_rail_lden";
|
|
12
|
+
readonly NoiseIndustryLden: "noise_industry_lden";
|
|
13
|
+
readonly RadonLevel: "radon_level";
|
|
14
|
+
readonly Ramsar: "ramsar";
|
|
15
|
+
readonly SpecialAreaConservation: "special_area_conservation";
|
|
16
|
+
readonly SpecialProtectionArea: "special_protection_area";
|
|
17
|
+
readonly AncientWoodland: "ancient_woodland";
|
|
18
|
+
readonly NativeWoodlandSurvey: "native_woodland_survey";
|
|
19
|
+
readonly AreaNaturalBeauty: "area_natural_beauty";
|
|
20
|
+
readonly NationalScenicArea: "national_scenic_area";
|
|
21
|
+
readonly PriorityHabitats: "priority_habitats";
|
|
22
|
+
readonly ProtectedWoodlands: "protected_woodlands";
|
|
23
|
+
readonly Natura2000: "natura_2000";
|
|
24
|
+
readonly Aonb: "aonb";
|
|
25
|
+
readonly ProtectedScenicLandscapes: "protected_scenic_landscapes";
|
|
26
|
+
readonly HistoricLandfillSite: "historic_landfill_site";
|
|
27
|
+
readonly WorldHeritageSite: "world_heritage_site";
|
|
28
|
+
readonly ProtectedWreckSite: "protected_wreck_site";
|
|
29
|
+
readonly ScheduledMonument: "scheduled_monument";
|
|
30
|
+
readonly Battlefield: "battlefield";
|
|
31
|
+
readonly BrownfieldLand: "brownfield_land";
|
|
32
|
+
readonly GreenBelt: "green_belt";
|
|
33
|
+
readonly CommonLand: "common_land";
|
|
34
|
+
readonly BuiltUpArea250: "built_up_area_250";
|
|
35
|
+
readonly ParcelsGb: "parcels_gb";
|
|
36
|
+
readonly Building: "building";
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* Environmental or geographic layer type for coverage calculations
|
|
40
|
+
*/
|
|
41
|
+
export type CoverageType = ClosedEnum<typeof CoverageType>;
|
|
42
|
+
/**
|
|
43
|
+
* 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
|
|
44
|
+
*/
|
|
45
|
+
export declare const IntersectsWith: {
|
|
46
|
+
readonly Postcode: "postcode";
|
|
47
|
+
readonly Outcode: "outcode";
|
|
48
|
+
readonly UkOutputArea: "uk_output_area";
|
|
49
|
+
readonly Lsoa21: "lsoa21";
|
|
50
|
+
readonly Ward: "ward";
|
|
51
|
+
readonly Parish: "parish";
|
|
52
|
+
readonly LocalAuthorityDistrict: "local_authority_district";
|
|
53
|
+
readonly County: "county";
|
|
54
|
+
readonly Country: "country";
|
|
55
|
+
readonly CountyElectoralDivision: "county_electoral_division";
|
|
56
|
+
readonly DistrictBoroughUnitary: "district_borough_unitary";
|
|
57
|
+
readonly DistrictBoroughUnitaryWard: "district_borough_unitary_ward";
|
|
58
|
+
readonly LocalPlanningAuthority: "local_planning_authority";
|
|
59
|
+
readonly CeremonialCountiesRegion: "ceremonial_counties_region";
|
|
60
|
+
readonly EnglishRegion: "english_region";
|
|
61
|
+
readonly CountryRegion: "country_region";
|
|
62
|
+
readonly UnitaryElectoralDivision: "unitary_electoral_division";
|
|
63
|
+
readonly Province: "province";
|
|
64
|
+
readonly ElectoralDivision: "electoral_division";
|
|
65
|
+
readonly GreaterLondonConstituency: "greater_london_constituency";
|
|
66
|
+
readonly ScotlandAndWalesConstituency: "scotland_and_wales_constituency";
|
|
67
|
+
readonly ScotlandAndWalesRegion: "scotland_and_wales_region";
|
|
68
|
+
readonly WestminsterConstituency: "westminster_constituency";
|
|
69
|
+
readonly Building: "building";
|
|
70
|
+
readonly BuiltUpArea250: "built_up_area_250";
|
|
71
|
+
readonly GreenBelt: "green_belt";
|
|
72
|
+
readonly CommonLand: "common_land";
|
|
73
|
+
readonly ParcelsGb: "parcels_gb";
|
|
74
|
+
readonly FloodRisk: "flood_risk";
|
|
75
|
+
readonly Ramsar: "ramsar";
|
|
76
|
+
readonly Natura2000: "natura_2000";
|
|
77
|
+
readonly Aonb: "aonb";
|
|
78
|
+
readonly AreaNaturalBeauty: "area_natural_beauty";
|
|
79
|
+
readonly NationalScenicArea: "national_scenic_area";
|
|
80
|
+
readonly SpecialAreaConservation: "special_area_conservation";
|
|
81
|
+
readonly SpecialProtectionArea: "special_protection_area";
|
|
82
|
+
readonly AncientWoodland: "ancient_woodland";
|
|
83
|
+
readonly NativeWoodlandSurvey: "native_woodland_survey";
|
|
84
|
+
readonly PriorityHabitats: "priority_habitats";
|
|
85
|
+
readonly ProtectedWoodlands: "protected_woodlands";
|
|
86
|
+
readonly ProtectedWoodland: "protected_woodland";
|
|
87
|
+
readonly ProtectedScenicLandscapes: "protected_scenic_landscapes";
|
|
88
|
+
readonly WorldHeritageSite: "world_heritage_site";
|
|
89
|
+
readonly ScheduledMonument: "scheduled_monument";
|
|
90
|
+
readonly Battlefield: "battlefield";
|
|
91
|
+
readonly ProtectedWreckSite: "protected_wreck_site";
|
|
92
|
+
readonly HistoricLandfillSite: "historic_landfill_site";
|
|
93
|
+
readonly RadonLevel: "radon_level";
|
|
94
|
+
readonly BrownfieldLand: "brownfield_land";
|
|
95
|
+
readonly NoiseRailLden: "noise_rail_lden";
|
|
96
|
+
readonly NoiseRoadLden: "noise_road_lden";
|
|
97
|
+
readonly NoiseIndustryLden: "noise_industry_lden";
|
|
98
|
+
};
|
|
99
|
+
/**
|
|
100
|
+
* 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
|
|
101
|
+
*/
|
|
102
|
+
export type IntersectsWith = ClosedEnum<typeof IntersectsWith>;
|
|
103
|
+
export type GetAreaCoverageRequest = {
|
|
104
|
+
/**
|
|
105
|
+
* Coverage layer type for environmental coverage analysis (e.g., flood_risk, noise_road_lden). Mutually exclusive with targetCode.
|
|
106
|
+
*/
|
|
107
|
+
coverageType?: CoverageType | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* Entity type to calculate intersection coverage for (e.g., building, parcels_gb). Only applicable with coverageType.
|
|
110
|
+
*/
|
|
111
|
+
intersectsWith?: IntersectsWith | undefined;
|
|
112
|
+
/**
|
|
113
|
+
* Source geography code to analyse coverage for (e.g., E05000001 for a ward)
|
|
114
|
+
*/
|
|
115
|
+
sourceCode: string;
|
|
116
|
+
/**
|
|
117
|
+
* Target geography code for geography-to-geography coverage calculation. Mutually exclusive with coverageType.
|
|
118
|
+
*/
|
|
119
|
+
targetCode?: string | undefined;
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* Additional metadata about the coverage result
|
|
123
|
+
*/
|
|
124
|
+
export type GetAreaCoverageMetadata = {
|
|
125
|
+
/**
|
|
126
|
+
* Category name for categorised data (e.g., high, medium, low)
|
|
127
|
+
*/
|
|
128
|
+
category?: string | undefined;
|
|
129
|
+
/**
|
|
130
|
+
* Component layer types for composite coverage types
|
|
131
|
+
*/
|
|
132
|
+
componentLayers?: Array<string> | undefined;
|
|
133
|
+
/**
|
|
134
|
+
* Decibel range for noise coverage (e.g., '<55dB', '55-70dB', '>70dB')
|
|
135
|
+
*/
|
|
136
|
+
dbRange?: string | undefined;
|
|
137
|
+
/**
|
|
138
|
+
* Count of entities affected (for intersectsWith queries)
|
|
139
|
+
*/
|
|
140
|
+
entityCount?: number | undefined;
|
|
141
|
+
/**
|
|
142
|
+
* Number of features contributing to this coverage result
|
|
143
|
+
*/
|
|
144
|
+
featureCount?: number | undefined;
|
|
145
|
+
/**
|
|
146
|
+
* Total count of entities in source area (for intersectsWith queries)
|
|
147
|
+
*/
|
|
148
|
+
totalEntities?: number | undefined;
|
|
149
|
+
};
|
|
150
|
+
/**
|
|
151
|
+
* Individual coverage calculation result
|
|
152
|
+
*/
|
|
153
|
+
export type Coverage = {
|
|
154
|
+
/**
|
|
155
|
+
* Area covered in square metres
|
|
156
|
+
*/
|
|
157
|
+
area: number;
|
|
158
|
+
/**
|
|
159
|
+
* Identifier for the coverage area (e.g., 'flood_risk_high', 'E06000001', '<55dB')
|
|
160
|
+
*/
|
|
161
|
+
identifier: string;
|
|
162
|
+
/**
|
|
163
|
+
* Additional metadata about the coverage result
|
|
164
|
+
*/
|
|
165
|
+
metadata?: GetAreaCoverageMetadata | undefined;
|
|
166
|
+
/**
|
|
167
|
+
* Coverage percentage of the relevant area (source area or intersecting entities)
|
|
168
|
+
*/
|
|
169
|
+
percentage: number;
|
|
170
|
+
};
|
|
171
|
+
/**
|
|
172
|
+
* Environmental or geographic layer type for coverage calculations
|
|
173
|
+
*/
|
|
174
|
+
export declare const GetAreaCoverageCoverageType: {
|
|
175
|
+
readonly FloodRisk: "flood_risk";
|
|
176
|
+
readonly NoiseRoadLden: "noise_road_lden";
|
|
177
|
+
readonly NoiseRailLden: "noise_rail_lden";
|
|
178
|
+
readonly NoiseIndustryLden: "noise_industry_lden";
|
|
179
|
+
readonly RadonLevel: "radon_level";
|
|
180
|
+
readonly Ramsar: "ramsar";
|
|
181
|
+
readonly SpecialAreaConservation: "special_area_conservation";
|
|
182
|
+
readonly SpecialProtectionArea: "special_protection_area";
|
|
183
|
+
readonly AncientWoodland: "ancient_woodland";
|
|
184
|
+
readonly NativeWoodlandSurvey: "native_woodland_survey";
|
|
185
|
+
readonly AreaNaturalBeauty: "area_natural_beauty";
|
|
186
|
+
readonly NationalScenicArea: "national_scenic_area";
|
|
187
|
+
readonly PriorityHabitats: "priority_habitats";
|
|
188
|
+
readonly ProtectedWoodlands: "protected_woodlands";
|
|
189
|
+
readonly Natura2000: "natura_2000";
|
|
190
|
+
readonly Aonb: "aonb";
|
|
191
|
+
readonly ProtectedScenicLandscapes: "protected_scenic_landscapes";
|
|
192
|
+
readonly HistoricLandfillSite: "historic_landfill_site";
|
|
193
|
+
readonly WorldHeritageSite: "world_heritage_site";
|
|
194
|
+
readonly ProtectedWreckSite: "protected_wreck_site";
|
|
195
|
+
readonly ScheduledMonument: "scheduled_monument";
|
|
196
|
+
readonly Battlefield: "battlefield";
|
|
197
|
+
readonly BrownfieldLand: "brownfield_land";
|
|
198
|
+
readonly GreenBelt: "green_belt";
|
|
199
|
+
readonly CommonLand: "common_land";
|
|
200
|
+
readonly BuiltUpArea250: "built_up_area_250";
|
|
201
|
+
readonly ParcelsGb: "parcels_gb";
|
|
202
|
+
readonly Building: "building";
|
|
203
|
+
};
|
|
204
|
+
/**
|
|
205
|
+
* Environmental or geographic layer type for coverage calculations
|
|
206
|
+
*/
|
|
207
|
+
export type GetAreaCoverageCoverageType = OpenEnum<typeof GetAreaCoverageCoverageType>;
|
|
208
|
+
/**
|
|
209
|
+
* 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
|
|
210
|
+
*/
|
|
211
|
+
export declare const GetAreaCoverageIntersectsWith: {
|
|
212
|
+
readonly Postcode: "postcode";
|
|
213
|
+
readonly Outcode: "outcode";
|
|
214
|
+
readonly UkOutputArea: "uk_output_area";
|
|
215
|
+
readonly Lsoa21: "lsoa21";
|
|
216
|
+
readonly Ward: "ward";
|
|
217
|
+
readonly Parish: "parish";
|
|
218
|
+
readonly LocalAuthorityDistrict: "local_authority_district";
|
|
219
|
+
readonly County: "county";
|
|
220
|
+
readonly Country: "country";
|
|
221
|
+
readonly CountyElectoralDivision: "county_electoral_division";
|
|
222
|
+
readonly DistrictBoroughUnitary: "district_borough_unitary";
|
|
223
|
+
readonly DistrictBoroughUnitaryWard: "district_borough_unitary_ward";
|
|
224
|
+
readonly LocalPlanningAuthority: "local_planning_authority";
|
|
225
|
+
readonly CeremonialCountiesRegion: "ceremonial_counties_region";
|
|
226
|
+
readonly EnglishRegion: "english_region";
|
|
227
|
+
readonly CountryRegion: "country_region";
|
|
228
|
+
readonly UnitaryElectoralDivision: "unitary_electoral_division";
|
|
229
|
+
readonly Province: "province";
|
|
230
|
+
readonly ElectoralDivision: "electoral_division";
|
|
231
|
+
readonly GreaterLondonConstituency: "greater_london_constituency";
|
|
232
|
+
readonly ScotlandAndWalesConstituency: "scotland_and_wales_constituency";
|
|
233
|
+
readonly ScotlandAndWalesRegion: "scotland_and_wales_region";
|
|
234
|
+
readonly WestminsterConstituency: "westminster_constituency";
|
|
235
|
+
readonly Building: "building";
|
|
236
|
+
readonly BuiltUpArea250: "built_up_area_250";
|
|
237
|
+
readonly GreenBelt: "green_belt";
|
|
238
|
+
readonly CommonLand: "common_land";
|
|
239
|
+
readonly ParcelsGb: "parcels_gb";
|
|
240
|
+
readonly FloodRisk: "flood_risk";
|
|
241
|
+
readonly Ramsar: "ramsar";
|
|
242
|
+
readonly Natura2000: "natura_2000";
|
|
243
|
+
readonly Aonb: "aonb";
|
|
244
|
+
readonly AreaNaturalBeauty: "area_natural_beauty";
|
|
245
|
+
readonly NationalScenicArea: "national_scenic_area";
|
|
246
|
+
readonly SpecialAreaConservation: "special_area_conservation";
|
|
247
|
+
readonly SpecialProtectionArea: "special_protection_area";
|
|
248
|
+
readonly AncientWoodland: "ancient_woodland";
|
|
249
|
+
readonly NativeWoodlandSurvey: "native_woodland_survey";
|
|
250
|
+
readonly PriorityHabitats: "priority_habitats";
|
|
251
|
+
readonly ProtectedWoodlands: "protected_woodlands";
|
|
252
|
+
readonly ProtectedWoodland: "protected_woodland";
|
|
253
|
+
readonly ProtectedScenicLandscapes: "protected_scenic_landscapes";
|
|
254
|
+
readonly WorldHeritageSite: "world_heritage_site";
|
|
255
|
+
readonly ScheduledMonument: "scheduled_monument";
|
|
256
|
+
readonly Battlefield: "battlefield";
|
|
257
|
+
readonly ProtectedWreckSite: "protected_wreck_site";
|
|
258
|
+
readonly HistoricLandfillSite: "historic_landfill_site";
|
|
259
|
+
readonly RadonLevel: "radon_level";
|
|
260
|
+
readonly BrownfieldLand: "brownfield_land";
|
|
261
|
+
readonly NoiseRailLden: "noise_rail_lden";
|
|
262
|
+
readonly NoiseRoadLden: "noise_road_lden";
|
|
263
|
+
readonly NoiseIndustryLden: "noise_industry_lden";
|
|
264
|
+
};
|
|
265
|
+
/**
|
|
266
|
+
* 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
|
|
267
|
+
*/
|
|
268
|
+
export type GetAreaCoverageIntersectsWith = OpenEnum<typeof GetAreaCoverageIntersectsWith>;
|
|
269
|
+
/**
|
|
270
|
+
* 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
|
|
271
|
+
*/
|
|
272
|
+
export declare const SourceType: {
|
|
273
|
+
readonly Postcode: "postcode";
|
|
274
|
+
readonly Outcode: "outcode";
|
|
275
|
+
readonly UkOutputArea: "uk_output_area";
|
|
276
|
+
readonly Lsoa21: "lsoa21";
|
|
277
|
+
readonly Ward: "ward";
|
|
278
|
+
readonly Parish: "parish";
|
|
279
|
+
readonly LocalAuthorityDistrict: "local_authority_district";
|
|
280
|
+
readonly County: "county";
|
|
281
|
+
readonly Country: "country";
|
|
282
|
+
readonly CountyElectoralDivision: "county_electoral_division";
|
|
283
|
+
readonly DistrictBoroughUnitary: "district_borough_unitary";
|
|
284
|
+
readonly DistrictBoroughUnitaryWard: "district_borough_unitary_ward";
|
|
285
|
+
readonly LocalPlanningAuthority: "local_planning_authority";
|
|
286
|
+
readonly CeremonialCountiesRegion: "ceremonial_counties_region";
|
|
287
|
+
readonly EnglishRegion: "english_region";
|
|
288
|
+
readonly CountryRegion: "country_region";
|
|
289
|
+
readonly UnitaryElectoralDivision: "unitary_electoral_division";
|
|
290
|
+
readonly Province: "province";
|
|
291
|
+
readonly ElectoralDivision: "electoral_division";
|
|
292
|
+
readonly GreaterLondonConstituency: "greater_london_constituency";
|
|
293
|
+
readonly ScotlandAndWalesConstituency: "scotland_and_wales_constituency";
|
|
294
|
+
readonly ScotlandAndWalesRegion: "scotland_and_wales_region";
|
|
295
|
+
readonly WestminsterConstituency: "westminster_constituency";
|
|
296
|
+
readonly Building: "building";
|
|
297
|
+
readonly BuiltUpArea250: "built_up_area_250";
|
|
298
|
+
readonly GreenBelt: "green_belt";
|
|
299
|
+
readonly CommonLand: "common_land";
|
|
300
|
+
readonly ParcelsGb: "parcels_gb";
|
|
301
|
+
readonly FloodRisk: "flood_risk";
|
|
302
|
+
readonly Ramsar: "ramsar";
|
|
303
|
+
readonly Natura2000: "natura_2000";
|
|
304
|
+
readonly Aonb: "aonb";
|
|
305
|
+
readonly AreaNaturalBeauty: "area_natural_beauty";
|
|
306
|
+
readonly NationalScenicArea: "national_scenic_area";
|
|
307
|
+
readonly SpecialAreaConservation: "special_area_conservation";
|
|
308
|
+
readonly SpecialProtectionArea: "special_protection_area";
|
|
309
|
+
readonly AncientWoodland: "ancient_woodland";
|
|
310
|
+
readonly NativeWoodlandSurvey: "native_woodland_survey";
|
|
311
|
+
readonly PriorityHabitats: "priority_habitats";
|
|
312
|
+
readonly ProtectedWoodlands: "protected_woodlands";
|
|
313
|
+
readonly ProtectedWoodland: "protected_woodland";
|
|
314
|
+
readonly ProtectedScenicLandscapes: "protected_scenic_landscapes";
|
|
315
|
+
readonly WorldHeritageSite: "world_heritage_site";
|
|
316
|
+
readonly ScheduledMonument: "scheduled_monument";
|
|
317
|
+
readonly Battlefield: "battlefield";
|
|
318
|
+
readonly ProtectedWreckSite: "protected_wreck_site";
|
|
319
|
+
readonly HistoricLandfillSite: "historic_landfill_site";
|
|
320
|
+
readonly RadonLevel: "radon_level";
|
|
321
|
+
readonly BrownfieldLand: "brownfield_land";
|
|
322
|
+
readonly NoiseRailLden: "noise_rail_lden";
|
|
323
|
+
readonly NoiseRoadLden: "noise_road_lden";
|
|
324
|
+
readonly NoiseIndustryLden: "noise_industry_lden";
|
|
325
|
+
};
|
|
326
|
+
/**
|
|
327
|
+
* 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
|
|
328
|
+
*/
|
|
329
|
+
export type SourceType = OpenEnum<typeof SourceType>;
|
|
330
|
+
/**
|
|
331
|
+
* Response containing coverage analysis for a geographic area. Returns either geography-to-geography overlap or environmental layer coverage depending on query parameters.
|
|
332
|
+
*/
|
|
333
|
+
export type GetAreaCoverageResponseBody = {
|
|
334
|
+
/**
|
|
335
|
+
* Array of coverage calculation results
|
|
336
|
+
*/
|
|
337
|
+
coverage: Array<Coverage>;
|
|
338
|
+
/**
|
|
339
|
+
* Environmental or geographic layer type for coverage calculations
|
|
340
|
+
*/
|
|
341
|
+
coverageType?: GetAreaCoverageCoverageType | undefined;
|
|
342
|
+
/**
|
|
343
|
+
* 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
|
|
344
|
+
*/
|
|
345
|
+
intersectsWith?: GetAreaCoverageIntersectsWith | undefined;
|
|
346
|
+
/**
|
|
347
|
+
* Optional message providing additional context about the response
|
|
348
|
+
*/
|
|
349
|
+
message?: string | undefined;
|
|
350
|
+
/**
|
|
351
|
+
* Total area of source geography in square metres
|
|
352
|
+
*/
|
|
353
|
+
sourceArea: number;
|
|
354
|
+
/**
|
|
355
|
+
* Source geography code that was analysed
|
|
356
|
+
*/
|
|
357
|
+
sourceCode: string;
|
|
358
|
+
/**
|
|
359
|
+
* Human-readable name of the source geography
|
|
360
|
+
*/
|
|
361
|
+
sourceName: string;
|
|
362
|
+
/**
|
|
363
|
+
* 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
|
|
364
|
+
*/
|
|
365
|
+
sourceType: SourceType;
|
|
366
|
+
/**
|
|
367
|
+
* Indicates whether the request was successful
|
|
368
|
+
*/
|
|
369
|
+
success: boolean;
|
|
370
|
+
/**
|
|
371
|
+
* Target geography code (for geography-to-geography queries)
|
|
372
|
+
*/
|
|
373
|
+
targetCode?: string | undefined;
|
|
374
|
+
/**
|
|
375
|
+
* Target geography name (for geography-to-geography queries)
|
|
376
|
+
*/
|
|
377
|
+
targetName?: string | undefined;
|
|
378
|
+
};
|
|
379
|
+
/** @internal */
|
|
380
|
+
export declare const CoverageType$outboundSchema: z.ZodNativeEnum<typeof CoverageType>;
|
|
381
|
+
/** @internal */
|
|
382
|
+
export declare const IntersectsWith$outboundSchema: z.ZodNativeEnum<typeof IntersectsWith>;
|
|
383
|
+
/** @internal */
|
|
384
|
+
export type GetAreaCoverageRequest$Outbound = {
|
|
385
|
+
coverageType?: string | undefined;
|
|
386
|
+
intersectsWith?: string | undefined;
|
|
387
|
+
sourceCode: string;
|
|
388
|
+
targetCode?: string | undefined;
|
|
389
|
+
};
|
|
390
|
+
/** @internal */
|
|
391
|
+
export declare const GetAreaCoverageRequest$outboundSchema: z.ZodType<GetAreaCoverageRequest$Outbound, z.ZodTypeDef, GetAreaCoverageRequest>;
|
|
392
|
+
export declare function getAreaCoverageRequestToJSON(getAreaCoverageRequest: GetAreaCoverageRequest): string;
|
|
393
|
+
/** @internal */
|
|
394
|
+
export declare const GetAreaCoverageMetadata$inboundSchema: z.ZodType<GetAreaCoverageMetadata, z.ZodTypeDef, unknown>;
|
|
395
|
+
export declare function getAreaCoverageMetadataFromJSON(jsonString: string): SafeParseResult<GetAreaCoverageMetadata, SDKValidationError>;
|
|
396
|
+
/** @internal */
|
|
397
|
+
export declare const Coverage$inboundSchema: z.ZodType<Coverage, z.ZodTypeDef, unknown>;
|
|
398
|
+
export declare function coverageFromJSON(jsonString: string): SafeParseResult<Coverage, SDKValidationError>;
|
|
399
|
+
/** @internal */
|
|
400
|
+
export declare const GetAreaCoverageCoverageType$inboundSchema: z.ZodType<GetAreaCoverageCoverageType, z.ZodTypeDef, unknown>;
|
|
401
|
+
/** @internal */
|
|
402
|
+
export declare const GetAreaCoverageIntersectsWith$inboundSchema: z.ZodType<GetAreaCoverageIntersectsWith, z.ZodTypeDef, unknown>;
|
|
403
|
+
/** @internal */
|
|
404
|
+
export declare const SourceType$inboundSchema: z.ZodType<SourceType, z.ZodTypeDef, unknown>;
|
|
405
|
+
/** @internal */
|
|
406
|
+
export declare const GetAreaCoverageResponseBody$inboundSchema: z.ZodType<GetAreaCoverageResponseBody, z.ZodTypeDef, unknown>;
|
|
407
|
+
export declare function getAreaCoverageResponseBodyFromJSON(jsonString: string): SafeParseResult<GetAreaCoverageResponseBody, SDKValidationError>;
|
|
408
|
+
//# sourceMappingURL=getareacoverage.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getareacoverage.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/operations/getareacoverage.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6Bf,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqDjB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAC/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6B9B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,QAAQ,CAChD,OAAO,2BAA2B,CACnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqDhC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,QAAQ,CAClD,OAAO,6BAA6B,CACrC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqDb,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,UAAU,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;IACvD;;OAEG;IACH,cAAc,CAAC,EAAE,6BAA6B,GAAG,SAAS,CAAC;IAC3D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,YAAY,CACjD,CAAC;AAE7B,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,aAAa,CACzD,OAAO,cAAc,CACS,CAAC;AAEjC,gBAAgB;AAChB,MAAM,MAAM,+BAA+B,GAAG;IAC5C,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,+BAA+B,EAC/B,CAAC,CAAC,UAAU,EACZ,sBAAsB,CAMtB,CAAC;AAEH,wBAAgB,4BAA4B,CAC1C,sBAAsB,EAAE,sBAAsB,GAC7C,MAAM,CAIR;AAED,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,uBAAuB,EACvB,CAAC,CAAC,UAAU,EACZ,OAAO,CAQP,CAAC;AAEH,wBAAgB,+BAA+B,CAC7C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAM9D;AAED,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAC5C,QAAQ,EACR,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAM/C;AAED,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,OAAO,CAC+C,CAAC;AAEzD,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,OAAO,CACjE,6BAA6B,EAC7B,CAAC,CAAC,UAAU,EACZ,OAAO,CACiD,CAAC;AAE3D,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,UAAU,EACV,CAAC,CAAC,UAAU,EACZ,OAAO,CAC8B,CAAC;AAExC,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,OAAO,CAaP,CAAC;AAEH,wBAAgB,mCAAmC,CACjD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAMlE"}
|