@vepler/sdk 2.45.0 → 2.50.3

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

@@ -3,14 +3,17 @@
  */
 
 import * as z from "zod/v3";
-import { safeParse } from "../../../lib/schemas.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  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
+ * Coverage layer type for environmental coverage analysis (e.g., flood_risk, noise_road_lden). Mutually exclusive with targetCode.
  */
 export const CoverageType = {
   FloodRisk: "flood_risk",
@@ -43,12 +46,12 @@ export const CoverageType = {
   Building: "building",
 } as const;
 /**
- * Environmental or geographic layer type for coverage calculations
+ * Coverage layer type for environmental coverage analysis (e.g., flood_risk, noise_road_lden). Mutually exclusive with targetCode.
  */
 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
+ * Entity type to calculate intersection coverage for (e.g., building, parcels_gb). Only applicable with coverageType.
  */
 export const IntersectsWith = {
   Postcode: "postcode",
@@ -105,7 +108,7 @@ export const IntersectsWith = {
   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
+ * Entity type to calculate intersection coverage for (e.g., building, parcels_gb). Only applicable with coverageType.
  */
 export type IntersectsWith = ClosedEnum<typeof IntersectsWith>;
 
@@ -129,7 +132,7 @@ export type GetAreaCoverageRequest = {
 };
 
 /**
- * Additional metadata about the coverage result
+ * Additional metadata about this coverage result
  */
 export type GetAreaCoverageMetadata = {
   /**
@@ -156,6 +159,7 @@ export type GetAreaCoverageMetadata = {
    * Total count of entities in source area (for intersectsWith queries)
    */
   totalEntities?: number | undefined;
+  additionalProperties?: { [k: string]: any | null } | undefined;
 };
 
 /**
@@ -171,7 +175,7 @@ export type Coverage = {
    */
   identifier: string;
   /**
-   * Additional metadata about the coverage result
+   * Additional metadata about this coverage result
    */
   metadata?: GetAreaCoverageMetadata | undefined;
   /**
@@ -181,7 +185,7 @@ export type Coverage = {
 };
 
 /**
- * Environmental or geographic layer type for coverage calculations
+ * Coverage layer type (for environmental coverage queries)
  */
 export const GetAreaCoverageCoverageType = {
   FloodRisk: "flood_risk",
@@ -214,14 +218,14 @@ export const GetAreaCoverageCoverageType = {
   Building: "building",
 } as const;
 /**
- * Environmental or geographic layer type for coverage calculations
+ * Coverage layer type (for environmental coverage queries)
  */
 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
+ * Entity type used for intersection analysis
  */
 export const GetAreaCoverageIntersectsWith = {
   Postcode: "postcode",
@@ -278,14 +282,14 @@ export const GetAreaCoverageIntersectsWith = {
   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
+ * Entity type used for intersection analysis
  */
 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
+ * Geographic type of the source area
  */
 export const GetAreaCoverageSourceType = {
   Postcode: "postcode",
@@ -342,7 +346,7 @@ export const GetAreaCoverageSourceType = {
   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
+ * Geographic type of the source area
  */
 export type GetAreaCoverageSourceType = OpenEnum<
   typeof GetAreaCoverageSourceType
@@ -357,11 +361,11 @@ export type GetAreaCoverageResponseBody = {
    */
   coverage: Array<Coverage>;
   /**
-   * Environmental or geographic layer type for coverage calculations
+   * Coverage layer type (for environmental coverage queries)
    */
   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
+   * Entity type used for intersection analysis
    */
   intersectsWith?: GetAreaCoverageIntersectsWith | undefined;
   /**
@@ -381,7 +385,7 @@ export type GetAreaCoverageResponseBody = {
    */
   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
+   * Geographic type of the source area
    */
   sourceType: GetAreaCoverageSourceType;
   /**
@@ -440,14 +444,18 @@ 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(),
-});
+> = collectExtraKeys$(
+  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(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+);
 
 export function getAreaCoverageMetadataFromJSON(
   jsonString: string,

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

@@ -10,7 +10,7 @@ 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
+ * Filter results by geographic type
  */
 export const Type = {
   Postcode: "postcode",
@@ -67,7 +67,7 @@ export const Type = {
   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
+ * Filter results by geographic type
  */
 export type Type = ClosedEnum<typeof Type>;
 

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

@@ -301,7 +301,7 @@ export type GetBorderingAreasAreasType = OpenEnum<
 >;
 
 /**
- * A geographic entity representing an administrative or statistical area
+ * The target area for which borders are being found
  */
 export type Target = {
   /**
@@ -371,7 +371,7 @@ export type GetBorderingAreasResponseBody = {
    */
   success: boolean;
   /**
-   * A geographic entity representing an administrative or statistical area
+   * The target area for which borders are being found
    */
   target: Target;
   /**

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

@@ -295,7 +295,7 @@ export const GetChildAreasAreasType = {
 export type GetChildAreasAreasType = OpenEnum<typeof GetChildAreasAreasType>;
 
 /**
- * A geographic entity representing an administrative or statistical area
+ * The parent geographic entity
  */
 export type Parent = {
   /**
@@ -361,7 +361,7 @@ export type GetChildAreasResponseBody = {
    */
   message?: string | undefined;
   /**
-   * A geographic entity representing an administrative or statistical area
+   * The parent geographic entity
    */
   parent: Parent;
   /**

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

@@ -5,6 +5,9 @@
 import * as z from "zod/v3";
 
 export type GetCompaniesByLocationRequest = {
+  /**
+   * Unique location identifier (e.g. UPRN in the UK)
+   */
   locationId: string;
 };
 

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

@@ -10,11 +10,14 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetConnectionQueueBySubstationRequest = {
+  /**
+   * Unique substation identifier, prefixed with the operator code (e.g. ukpn:PRI-1234, npg:12345)
+   */
   code: string;
 };
 
 /**
- * WGS84 coordinate pair
+ * Geographic location of the connection site, if available
  */
 export type GetConnectionQueueBySubstationCoordinates = {
   /**
@@ -111,7 +114,7 @@ export type ConnectionQueueEntry = {
    */
   importCapacityMw: number | null;
   /**
-   * WGS84 coordinate pair
+   * Geographic location of the connection site, if available
    */
   location: GetConnectionQueueBySubstationCoordinates | null;
   /**
@@ -131,7 +134,7 @@ export type ConnectionQueueEntry = {
    */
   operatingRegion: string | null;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Network operator managing this connection
    */
   operator: string;
   /**

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

@@ -9,17 +9,20 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetConnectionQueueEntryRequest = {
+  /**
+   * Unique project identifier from the source register
+   */
   projectId: string;
   /**
-   * Source register to disambiguate (e.g. neso_tec, neso_embedded)
+   * Source register filter
    */
   sourceDataset?: string | undefined;
 };
 
 /**
- * WGS84 coordinate pair
+ * Geographic location of the connection site, if available
  */
-export type Coordinates = {
+export type GetConnectionQueueEntryCoordinates = {
   /**
    * Latitude in decimal degrees
    */
@@ -114,9 +117,9 @@ export type GetConnectionQueueEntryConnectionQueueEntry = {
    */
   importCapacityMw: number | null;
   /**
-   * WGS84 coordinate pair
+   * Geographic location of the connection site, if available
    */
-  location: Coordinates | null;
+  location: GetConnectionQueueEntryCoordinates | null;
   /**
    * Network voltage level: transmission, distribution, or interconnector
    */
@@ -134,7 +137,7 @@ export type GetConnectionQueueEntryConnectionQueueEntry = {
    */
   operatingRegion: string | null;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Network operator managing this connection
    */
   operator: string;
   /**
@@ -202,8 +205,8 @@ export function getConnectionQueueEntryRequestToJSON(
 }
 
 /** @internal */
-export const Coordinates$inboundSchema: z.ZodType<
-  Coordinates,
+export const GetConnectionQueueEntryCoordinates$inboundSchema: z.ZodType<
+  GetConnectionQueueEntryCoordinates,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -211,13 +214,14 @@ export const Coordinates$inboundSchema: z.ZodType<
   lng: z.number(),
 });
 
-export function coordinatesFromJSON(
+export function getConnectionQueueEntryCoordinatesFromJSON(
   jsonString: string,
-): SafeParseResult<Coordinates, SDKValidationError> {
+): SafeParseResult<GetConnectionQueueEntryCoordinates, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Coordinates$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Coordinates' from JSON`,
+    (x) =>
+      GetConnectionQueueEntryCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetConnectionQueueEntryCoordinates' from JSON`,
   );
 }
 
@@ -266,7 +270,9 @@ export const GetConnectionQueueEntryConnectionQueueEntry$inboundSchema:
     customerName: z.nullable(z.string()),
     exportCapacityMw: z.nullable(z.number()),
     importCapacityMw: z.nullable(z.number()),
-    location: z.nullable(z.lazy(() => Coordinates$inboundSchema)),
+    location: z.nullable(
+      z.lazy(() => GetConnectionQueueEntryCoordinates$inboundSchema),
+    ),
     networkLevel: z.nullable(z.string()),
     object: GetConnectionQueueEntryObject$inboundSchema,
     offerDate: z.nullable(z.string()),

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

@@ -64,7 +64,7 @@ export type GetConnectivityScoresRequest = {
 };
 
 /**
- * Basic information about the geographic area
+ * Area information (when includeAreaInfo=true)
  */
 export type AreaInfo = {
   /**
@@ -307,7 +307,7 @@ export type Breakdown = {
 };
 
 /**
- * Connectivity quality scores for an area
+ * Current connectivity scores
  */
 export type ConnectivityScores = {
   /**
@@ -357,7 +357,7 @@ export type Mobile = {
 };
 
 /**
- * Information about data sources and calculation methods
+ * Information about data sources
  */
 export type DataSources = {
   /**
@@ -393,7 +393,7 @@ export type GetConnectivityScoresMetadata = {
 };
 
 /**
- * Quick summary of broadband speed availability
+ * Broadband speed availability summary
  */
 export type SpeedSummary = {
   /**
@@ -869,7 +869,7 @@ export type GetConnectivityScoresConnectivityBreakdown = {
 };
 
 /**
- * Connectivity quality scores for an area
+ * Connectivity scores for this period
  */
 export type GetConnectivityScoresConnectivityScores = {
   /**
@@ -905,7 +905,7 @@ export type GetConnectivityScoresConnectivityMetadata = {
 };
 
 /**
- * Quick summary of broadband speed availability
+ * Speed summary for this period
  */
 export type GetConnectivityScoresSpeedSummary = {
   /**
@@ -939,7 +939,7 @@ export type Timeseries = {
    */
   breakdown?: GetConnectivityScoresBreakdown | undefined;
   /**
-   * Connectivity quality scores for an area
+   * Connectivity scores for this period
    */
   connectivityScores: GetConnectivityScoresConnectivityScores;
   /**
@@ -951,7 +951,7 @@ export type Timeseries = {
    */
   metadata: GetConnectivityScoresConnectivityMetadata;
   /**
-   * Quick summary of broadband speed availability
+   * Speed summary for this period
    */
   speedSummary?: GetConnectivityScoresSpeedSummary | undefined;
 };
@@ -961,15 +961,15 @@ export type Timeseries = {
  */
 export type GetConnectivityScoresResult = {
   /**
-   * Basic information about the geographic area
+   * Area information (when includeAreaInfo=true)
    */
   areaInfo?: AreaInfo | undefined;
   /**
-   * Connectivity quality scores for an area
+   * Current connectivity scores
    */
   connectivityScores?: ConnectivityScores | undefined;
   /**
-   * Information about data sources and calculation methods
+   * Information about data sources
    */
   dataSources?: DataSources | undefined;
   /**
@@ -981,7 +981,7 @@ export type GetConnectivityScoresResult = {
    */
   metadata: GetConnectivityScoresMetadata;
   /**
-   * Quick summary of broadband speed availability
+   * Broadband speed availability summary
    */
   speedSummary?: SpeedSummary | undefined;
   /**

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

@@ -5,6 +5,9 @@
 import * as z from "zod/v3";
 
 export type GetCouncilByProviderIdRequest = {
+  /**
+   * Council provider identifier (kebab-case)
+   */
   providerId: string;
 };