@vepler/sdk 3.0.0 → 3.3.0

package/src/sdk/models/shared/buildingaddresslink.ts

@@ -19,7 +19,7 @@ export type BuildingAddressLink = {
   /**
    * Vepler locationId (UPRN-derived) linked to this building
    */
-  locationId: string;
+  locationId?: string | undefined;
   /**
    * Postcode of the linked address
    */
@@ -27,7 +27,7 @@ export type BuildingAddressLink = {
   /**
    * Raw UPRN as a string
    */
-  uprn: string;
+  uprn?: string | undefined;
 };
 
 /** @internal */
@@ -38,9 +38,9 @@ export const BuildingAddressLink$inboundSchema: z.ZodType<
 > = z.object({
   addressLine: z.nullable(z.string()).optional(),
   classification: z.nullable(z.string()).optional(),
-  locationId: z.string(),
+  locationId: z.string().optional(),
   postcode: z.nullable(z.string()).optional(),
-  uprn: z.string(),
+  uprn: z.string().optional(),
 });
 
 export function buildingAddressLinkFromJSON(

package/src/sdk/models/shared/buildingpart.ts

@@ -4,9 +4,23 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * GeoJSON geometry type
+ */
+export const BuildingPartSchemasType = {
+  MultiPolygon: "MultiPolygon",
+} as const;
+/**
+ * GeoJSON geometry type
+ */
+export type BuildingPartSchemasType = ClosedEnum<
+  typeof BuildingPartSchemasType
+>;
+
 /**
  * GeoJSON MultiPolygon geometry
  */
@@ -14,13 +28,24 @@ export type BuildingPartGeoJSONMultiPolygon = {
   /**
    * Array of polygon coordinate arrays
    */
-  coordinates: Array<Array<Array<Array<number>>>>;
+  coordinates?: Array<Array<Array<Array<number>>>> | undefined;
   /**
    * GeoJSON geometry type
    */
-  type: "MultiPolygon";
+  type?: BuildingPartSchemasType | undefined;
 };
 
+/**
+ * GeoJSON geometry type
+ */
+export const BuildingPartType = {
+  Polygon: "Polygon",
+} as const;
+/**
+ * GeoJSON geometry type
+ */
+export type BuildingPartType = ClosedEnum<typeof BuildingPartType>;
+
 /**
  * GeoJSON Polygon geometry
  */
@@ -28,11 +53,11 @@ export type BuildingPartGeoJSONPolygon = {
   /**
    * Array of linear rings
    */
-  coordinates: Array<Array<Array<number>>>;
+  coordinates?: Array<Array<Array<number>>> | undefined;
   /**
    * GeoJSON geometry type
    */
-  type: "Polygon";
+  type?: BuildingPartType | undefined;
 };
 
 /**
@@ -54,7 +79,7 @@ export type BuildingPart = {
   /**
    * Raw source identifier for the part
    */
-  externalId: string;
+  externalId?: string | undefined;
   /**
    * Part footprint geometry (WGS84). Only present when attributes include `parts`.
    */
@@ -74,21 +99,26 @@ export type BuildingPart = {
   /**
    * Composite part identifier — `{buildingId}:part:{externalPartId}`
    */
-  partId: string;
+  partId?: string | undefined;
   /**
    * Physical level qualifier (above-ground / underground)
    */
   physicalLevel?: string | null | undefined;
 };
 
+/** @internal */
+export const BuildingPartSchemasType$inboundSchema: z.ZodNativeEnum<
+  typeof BuildingPartSchemasType
+> = z.nativeEnum(BuildingPartSchemasType);
+
 /** @internal */
 export const BuildingPartGeoJSONMultiPolygon$inboundSchema: z.ZodType<
   BuildingPartGeoJSONMultiPolygon,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  coordinates: z.array(z.array(z.array(z.array(z.number())))),
-  type: z.literal("MultiPolygon"),
+  coordinates: z.array(z.array(z.array(z.array(z.number())))).optional(),
+  type: BuildingPartSchemasType$inboundSchema.optional(),
 });
 
 export function buildingPartGeoJSONMultiPolygonFromJSON(
@@ -101,14 +131,19 @@ export function buildingPartGeoJSONMultiPolygonFromJSON(
   );
 }
 
+/** @internal */
+export const BuildingPartType$inboundSchema: z.ZodNativeEnum<
+  typeof BuildingPartType
+> = z.nativeEnum(BuildingPartType);
+
 /** @internal */
 export const BuildingPartGeoJSONPolygon$inboundSchema: z.ZodType<
   BuildingPartGeoJSONPolygon,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  coordinates: z.array(z.array(z.array(z.number()))),
-  type: z.literal("Polygon"),
+  coordinates: z.array(z.array(z.array(z.number()))).optional(),
+  type: BuildingPartType$inboundSchema.optional(),
 });
 
 export function buildingPartGeoJSONPolygonFromJSON(
@@ -149,7 +184,7 @@ export const BuildingPart$inboundSchema: z.ZodType<
 > = z.object({
   areaSqm: z.nullable(z.number()).optional(),
   description: z.nullable(z.string()).optional(),
-  externalId: z.string(),
+  externalId: z.string().optional(),
   footprint: z.nullable(
     z.union([
       z.lazy(() => BuildingPartGeoJSONPolygon$inboundSchema),
@@ -158,7 +193,7 @@ export const BuildingPart$inboundSchema: z.ZodType<
   ).optional(),
   heightMax: z.nullable(z.number()).optional(),
   heightRoofBase: z.nullable(z.number()).optional(),
-  partId: z.string(),
+  partId: z.string().optional(),
   physicalLevel: z.nullable(z.string()).optional(),
 });
 

package/src/sdk/models/shared/chargeentry.ts

@@ -11,7 +11,7 @@ export type ChargeEntry = {
   /**
    * Confidence score (0-100)
    */
-  confidence: number;
+  confidence?: number | undefined;
   /**
    * Currency code
    */
@@ -19,23 +19,23 @@ export type ChargeEntry = {
   /**
    * Whether this value is an outlier
    */
-  isOutlier: boolean;
+  isOutlier?: boolean | undefined;
   /**
    * Date this charge was recorded
    */
-  recordedDate: Date;
+  recordedDate?: Date | undefined;
   /**
    * Source identifier
    */
-  sourceId: string;
+  sourceId?: string | undefined;
   /**
    * Source provider
    */
-  sourceProvider: string;
+  sourceProvider?: string | undefined;
   /**
    * Charge amount in GBP (whole pounds)
    */
-  value: number;
+  value?: number | undefined;
 };
 
 /** @internal */
@@ -44,15 +44,15 @@ export const ChargeEntry$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  confidence: z.number(),
+  confidence: z.number().optional(),
   currency: z.nullable(z.string()).optional(),
-  isOutlier: z.boolean(),
+  isOutlier: z.boolean().optional(),
   recordedDate: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
-  ),
-  sourceId: z.string(),
-  sourceProvider: z.string(),
-  value: z.number(),
+  ).optional(),
+  sourceId: z.string().optional(),
+  sourceProvider: z.string().optional(),
+  value: z.number().optional(),
 });
 
 export function chargeEntryFromJSON(

package/src/sdk/models/shared/chargehistory.ts

@@ -12,7 +12,7 @@ export type ChargeHistory = {
   /**
    * Overall confidence in current value
    */
-  confidence: number;
+  confidence?: number | undefined;
   /**
    * Currency code
    */
@@ -24,11 +24,11 @@ export type ChargeHistory = {
   /**
    * Historical charge records
    */
-  entries: Array<ChargeEntry>;
+  entries?: Array<ChargeEntry> | undefined;
   /**
    * Last update timestamp
    */
-  lastUpdated: Date;
+  lastUpdated?: Date | undefined;
 };
 
 /** @internal */
@@ -37,13 +37,12 @@ export const ChargeHistory$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  confidence: z.number(),
+  confidence: z.number().optional(),
   currency: z.nullable(z.string()).optional(),
   current: z.nullable(z.number()).optional(),
-  entries: z.array(ChargeEntry$inboundSchema),
-  lastUpdated: z.string().datetime({ offset: true }).transform(v =>
-    new Date(v)
-  ),
+  entries: z.array(ChargeEntry$inboundSchema).optional(),
+  lastUpdated: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
 });
 
 export function chargeHistoryFromJSON(

package/src/sdk/models/shared/conservationassessments.ts

@@ -53,7 +53,7 @@ export type ConservationAssessmentsNearest = {
   /**
    * Distance to the feature in metres
    */
-  distanceM: number;
+  distanceM?: number | undefined;
   /**
    * Priority-habitat classification code (priority_habitat only) — UKBAP / EUNIS code, verbatim
    */
@@ -87,7 +87,7 @@ export type ConservationAssessments2 = {
   /**
    * False — the point is not inside any zone of this kind
    */
-  inside: false;
+  inside?: false | undefined;
   /**
    * Optional — the nearest zone of this kind, with distance
    */
@@ -101,8 +101,8 @@ export type ConservationAssessments1 = {
   /**
    * True — the point is inside this zone
    */
-  inside: true;
-  zone: ConservationZone;
+  inside?: true | undefined;
+  zone?: ConservationZone | undefined;
 };
 
 /**
@@ -114,13 +114,13 @@ export type ConservationAssessments = {
   /**
    * Conservation designations keyed by designation_type; only matched (inside / nearby) types are present.
    */
-  designations: {
+  designations?: {
     [k: string]: ConservationAssessments1 | ConservationAssessments2;
-  };
+  } | undefined;
   /**
    * Universal provenance block — every product envelope carries this
    */
-  provenance: Provenance;
+  provenance?: Provenance | undefined;
 };
 
 /** @internal */
@@ -140,7 +140,7 @@ export const ConservationAssessmentsNearest$inboundSchema: z.ZodType<
   bearingDeg: z.number().optional(),
   datePrecision: ConservationAssessmentsDatePrecision$inboundSchema.optional(),
   designatedDate: z.nullable(z.string()).optional(),
-  distanceM: z.number(),
+  distanceM: z.number().optional(),
   habitatCode: z.string().optional(),
   landscapeClass: z.string().optional(),
   lifecycle: z.string().optional(),
@@ -165,7 +165,7 @@ export const ConservationAssessments2$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  inside: z.literal(false),
+  inside: z.literal(false).optional(),
   nearest: z.lazy(() => ConservationAssessmentsNearest$inboundSchema)
     .optional(),
 });
@@ -186,8 +186,8 @@ export const ConservationAssessments1$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  inside: z.literal(true),
-  zone: ConservationZone$inboundSchema,
+  inside: z.literal(true).optional(),
+  zone: ConservationZone$inboundSchema.optional(),
 });
 
 export function conservationAssessments1FromJSON(
@@ -231,8 +231,8 @@ export const ConservationAssessments$inboundSchema: z.ZodType<
       z.lazy(() => ConservationAssessments1$inboundSchema),
       z.lazy(() => ConservationAssessments2$inboundSchema),
     ]),
-  ),
-  provenance: Provenance$inboundSchema,
+  ).optional(),
+  provenance: Provenance$inboundSchema.optional(),
 });
 
 export function conservationAssessmentsFromJSON(

package/src/sdk/models/shared/datasourceref.ts

@@ -22,7 +22,7 @@ export type DataSourceRef = {
   /**
    * Machine code for the source (e.g. 'ea_aqma_register')
    */
-  id: string;
+  id?: string | undefined;
   /**
    * ISO 3166-1 alpha-2 codes (optionally with subdivision) covered by this source
    */
@@ -34,7 +34,7 @@ export type DataSourceRef = {
   /**
    * Human-readable name for the source
    */
-  name: string;
+  name?: string | undefined;
   /**
    * ISO date — when the custodian published this version
    */
@@ -61,10 +61,10 @@ export const DataSourceRef$inboundSchema: z.ZodType<
 > = z.object({
   custodian: z.string().optional(),
   fetchedAt: z.string().optional(),
-  id: z.string(),
+  id: z.string().optional(),
   jurisdiction: z.array(z.string()).optional(),
   licence: z.string().optional(),
-  name: z.string(),
+  name: z.string().optional(),
   releaseDate: z.string().optional(),
   sha256: z.string().optional(),
   url: z.string().optional(),