@vepler/sdk 2.30.2 → 2.33.0

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

@@ -5,88 +5,39 @@
 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 { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-/**
- * 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 GeographicType = {
-  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 GeographicType = ClosedEnum<typeof GeographicType>;
-
 export type GetMetricValuesRequest = {
   category?: string | undefined;
-  endPeriod?: string | undefined;
-  geographicCode?: string | undefined;
+  endMonth?: number | null | undefined;
+  endYear?: number | null | undefined;
+  /**
+   * Geographic entity IDs (comma-separated)
+   */
+  geographicEntityIds?: string | undefined;
   /**
-   * Layer type identifier. Includes postcodes, outcodes, 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.
+   * Geographic entity types to filter by (comma-separated)
    */
-  geographicType?: GeographicType | undefined;
-  includeGeographyDetails?: string | undefined;
-  includeMetricDetails?: string | undefined;
+  geographicEntityTypes?: string | undefined;
+  /**
+   * Include geographic entity information in response
+   */
+  includeGeographicEntity?: string | undefined;
+  /**
+   * Include metric metadata in response
+   */
+  includeMetric?: string | undefined;
   limit?: string | undefined;
-  metricId?: string | undefined;
+  /**
+   * Metric identifiers to retrieve (comma-separated)
+   */
+  metricIds?: string | undefined;
   metricName?: string | undefined;
   offset?: string | undefined;
-  period?: string | undefined;
-  startPeriod?: string | undefined;
+  startMonth?: number | null | undefined;
+  startYear?: number | null | undefined;
 };
 
 export type Pagination = {
@@ -99,7 +50,7 @@ export type Pagination = {
 /**
  * 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 GetMetricValuesGeographicType = {
+export const GeographicType = {
   Postcode: "postcode",
   Outcode: "outcode",
   UkOutputArea: "uk_output_area",
@@ -156,9 +107,7 @@ export const GetMetricValuesGeographicType = {
 /**
  * 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 GetMetricValuesGeographicType = OpenEnum<
-  typeof GetMetricValuesGeographicType
->;
+export type GeographicType = OpenEnum<typeof GeographicType>;
 
 /**
  * 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
@@ -273,7 +222,7 @@ export type GetMetricValuesResult = {
   /**
    * 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
    */
-  geographicType: GetMetricValuesGeographicType;
+  geographicType: GeographicType;
   geography?: Geography | undefined;
   id: number;
   metadata?: { [k: string]: any | null } | null | undefined;
@@ -300,25 +249,21 @@ export type GetMetricValuesResponseBody = {
   success: boolean;
 };
 
-/** @internal */
-export const GeographicType$outboundSchema: z.ZodNativeEnum<
-  typeof GeographicType
-> = z.nativeEnum(GeographicType);
-
 /** @internal */
 export type GetMetricValuesRequest$Outbound = {
   category?: string | undefined;
-  endPeriod?: string | undefined;
-  geographicCode?: string | undefined;
-  geographicType?: string | undefined;
-  includeGeographyDetails?: string | undefined;
-  includeMetricDetails?: string | undefined;
+  endMonth?: number | null | undefined;
+  endYear?: number | null | undefined;
+  geographicEntityIds?: string | undefined;
+  geographicEntityTypes?: string | undefined;
+  includeGeographicEntity?: string | undefined;
+  includeMetric?: string | undefined;
   limit: string;
-  metricId?: string | undefined;
+  metricIds?: string | undefined;
   metricName?: string | undefined;
   offset: string;
-  period?: string | undefined;
-  startPeriod?: string | undefined;
+  startMonth?: number | null | undefined;
+  startYear?: number | null | undefined;
 };
 
 /** @internal */
@@ -328,17 +273,18 @@ export const GetMetricValuesRequest$outboundSchema: z.ZodType<
   GetMetricValuesRequest
 > = z.object({
   category: z.string().optional(),
-  endPeriod: z.string().optional(),
-  geographicCode: z.string().optional(),
-  geographicType: GeographicType$outboundSchema.optional(),
-  includeGeographyDetails: z.string().optional(),
-  includeMetricDetails: z.string().optional(),
+  endMonth: z.nullable(z.number()).optional(),
+  endYear: z.nullable(z.number()).optional(),
+  geographicEntityIds: z.string().optional(),
+  geographicEntityTypes: z.string().optional(),
+  includeGeographicEntity: z.string().optional(),
+  includeMetric: z.string().optional(),
   limit: z.string().default("100"),
-  metricId: z.string().optional(),
+  metricIds: z.string().optional(),
   metricName: z.string().optional(),
   offset: z.string().default("0"),
-  period: z.string().optional(),
-  startPeriod: z.string().optional(),
+  startMonth: z.nullable(z.number()).optional(),
+  startYear: z.nullable(z.number()).optional(),
 });
 
 export function getMetricValuesRequestToJSON(
@@ -372,11 +318,11 @@ export function paginationFromJSON(
 }
 
 /** @internal */
-export const GetMetricValuesGeographicType$inboundSchema: z.ZodType<
-  GetMetricValuesGeographicType,
+export const GeographicType$inboundSchema: z.ZodType<
+  GeographicType,
   z.ZodTypeDef,
   unknown
-> = openEnums.inboundSchema(GetMetricValuesGeographicType);
+> = openEnums.inboundSchema(GeographicType);
 
 /** @internal */
 export const GetMetricValuesType$inboundSchema: z.ZodType<
@@ -454,7 +400,7 @@ export const GetMetricValuesResult$inboundSchema: z.ZodType<
   confidence: z.nullable(z.number()),
   createdAt: z.string(),
   geographicCode: z.string(),
-  geographicType: GetMetricValuesGeographicType$inboundSchema,
+  geographicType: GeographicType$inboundSchema,
   geography: z.lazy(() => Geography$inboundSchema).optional(),
   id: z.number(),
   metadata: z.nullable(z.record(z.nullable(z.any()))).optional(),

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

@@ -6,6 +6,7 @@ export * from "./checkareareferencehealth.js";
 export * from "./checkavmhealth.js";
 export * from "./checkepchealth.js";
 export * from "./checklistingshealth.js";
+export * from "./getareacoverage.js";
 export * from "./getareasbyfieldandids.js";
 export * from "./getareaswithinradius.js";
 export * from "./getborderingareas.js";