@vepler/sdk 2.167.0 → 3.3.0

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

@@ -11,15 +11,15 @@ export type AdvancedListingRoomDetails = {
   /**
    * Number of bathrooms.
    */
-  baths: number | null;
+  baths?: number | null | undefined;
   /**
    * Number of bedrooms.
    */
-  beds: number | null;
+  beds?: number | null | undefined;
   /**
    * Number of reception rooms.
    */
-  recepts: number | null;
+  recepts?: number | null | undefined;
 };
 
 /** @internal */
@@ -28,9 +28,9 @@ export const AdvancedListingRoomDetails$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  baths: z.nullable(z.number()),
-  beds: z.nullable(z.number()),
-  recepts: z.nullable(z.number()),
+  baths: z.nullable(z.number()).optional(),
+  beds: z.nullable(z.number()).optional(),
+  recepts: z.nullable(z.number()).optional(),
 });
 
 export function advancedListingRoomDetailsFromJSON(

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

@@ -11,11 +11,11 @@ export type AdvancedListingSaleHistory = {
   /**
    * Sale amount in GBP pounds.
    */
-  amount: number;
+  amount?: number | undefined;
   /**
    * Sale date.
    */
-  date: Date;
+  date?: Date | undefined;
 };
 
 /** @internal */
@@ -24,8 +24,9 @@ export const AdvancedListingSaleHistory$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  amount: z.number(),
-  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  amount: z.number().optional(),
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
 });
 
 export function advancedListingSaleHistoryFromJSON(

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

@@ -11,7 +11,7 @@ export type AdvancedListingSeller = {
   /**
    * Marketing agent/seller name.
    */
-  name: string | null;
+  name?: string | null | undefined;
 };
 
 /** @internal */
@@ -20,7 +20,7 @@ export const AdvancedListingSeller$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  name: z.nullable(z.string()),
+  name: z.nullable(z.string()).optional(),
 });
 
 export function advancedListingSellerFromJSON(

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

@@ -31,11 +31,11 @@ export type AdvancedListingStatusHistory = {
   /**
    * When the status took effect.
    */
-  date: Date;
+  date?: Date | undefined;
   /**
    * Current listing status. 'live': actively marketed. 'sstc': sold subject to contract. 'under_offer': an offer has been accepted but not yet to contract. 'reserved': reserved (commonly new-build). 'sold': sale completed. 'removed': withdrawn or no longer present in the source feed.
    */
-  status: AdvancedListingStatusHistoryStatus;
+  status?: AdvancedListingStatusHistoryStatus | undefined;
 };
 
 /** @internal */
@@ -51,8 +51,9 @@ export const AdvancedListingStatusHistory$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  status: AdvancedListingStatusHistoryStatus$inboundSchema,
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  status: AdvancedListingStatusHistoryStatus$inboundSchema.optional(),
 });
 
 export function advancedListingStatusHistoryFromJSON(

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

@@ -30,11 +30,11 @@ export type AdvancedListingTenure = {
   /**
    * Canonical tenure classification, normalised from the raw feed value. Filter on this with a single value (e.g. 'leasehold') — no need to enumerate source variants.
    */
-  type: AdvancedListingTenureType | null;
+  type?: AdvancedListingTenureType | null | undefined;
   /**
    * Original tenure string exactly as supplied by the source feed (may embed lease term detail).
    */
-  typeRaw: string | null;
+  typeRaw?: string | null | undefined;
 };
 
 /** @internal */
@@ -50,8 +50,8 @@ export const AdvancedListingTenure$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: z.nullable(AdvancedListingTenureType$inboundSchema),
-  typeRaw: z.nullable(z.string()),
+  type: z.nullable(AdvancedListingTenureType$inboundSchema).optional(),
+  typeRaw: z.nullable(z.string()).optional(),
 });
 
 export function advancedListingTenureFromJSON(

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

@@ -102,11 +102,11 @@ export type Coordinates = {
   /**
    * Latitude in decimal degrees
    */
-  lat: number;
+  lat?: number | undefined;
   /**
    * Longitude in decimal degrees
    */
-  lng: number;
+  lng?: number | undefined;
 };
 
 /**
@@ -130,19 +130,19 @@ export type Age = {
   /**
    * End year of construction period. Null for 'XXXX onwards' bands.
    */
-  endYear: number | null;
+  endYear?: number | null | undefined;
   /**
    * Whether the construction date is an exact year (true) or a range (false).
    */
-  isExact: boolean;
+  isExact?: boolean | undefined;
   /**
    * Midpoint year. Useful for approximate age calculations.
    */
-  midYear: number | null;
+  midYear?: number | null | undefined;
   /**
    * Start year of construction period. Null for 'before XXXX' bands.
    */
-  startYear: number | null;
+  startYear?: number | null | undefined;
 };
 
 export const BuildingSchemasDataSources = {
@@ -234,6 +234,17 @@ export const DataSources = {
 } as const;
 export type DataSources = OpenEnum<typeof DataSources>;
 
+/**
+ * GeoJSON geometry type
+ */
+export const BuildingSchemasType = {
+  MultiPolygon: "MultiPolygon",
+} as const;
+/**
+ * GeoJSON geometry type
+ */
+export type BuildingSchemasType = ClosedEnum<typeof BuildingSchemasType>;
+
 /**
  * GeoJSON MultiPolygon geometry
  */
@@ -241,13 +252,26 @@ export type GeoJSONMultiPolygon = {
   /**
    * Array of polygon coordinate arrays
    */
-  coordinates: Array<Array<Array<Array<number>>>>;
+  coordinates?: Array<Array<Array<Array<number>>>> | undefined;
   /**
    * GeoJSON geometry type
    */
-  type: "MultiPolygon";
+  type?: BuildingSchemasType | undefined;
 };
 
+/**
+ * GeoJSON geometry type
+ */
+export const BuildingSchemasFootprintType = {
+  Polygon: "Polygon",
+} as const;
+/**
+ * GeoJSON geometry type
+ */
+export type BuildingSchemasFootprintType = ClosedEnum<
+  typeof BuildingSchemasFootprintType
+>;
+
 /**
  * GeoJSON Polygon geometry
  */
@@ -255,11 +279,11 @@ export type GeoJSONPolygon = {
   /**
    * Array of linear rings
    */
-  coordinates: Array<Array<Array<number>>>;
+  coordinates?: Array<Array<Array<number>>> | undefined;
   /**
    * GeoJSON geometry type
    */
-  type: "Polygon";
+  type?: BuildingSchemasFootprintType | undefined;
 };
 
 /**
@@ -522,7 +546,7 @@ export type Building = {
   /**
    * Composite building identifier `{country}:{provider}:{externalId}`
    */
-  buildingId: string;
+  buildingId?: string | undefined;
   /**
    * Primary use as reported by OS NGD
    */
@@ -546,7 +570,7 @@ export type Building = {
   /**
    * ISO 3166-1 alpha-2 country code
    */
-  country: string;
+  country?: string | undefined;
   /**
    * Top-level summary of sources used by this aggregation
    */
@@ -554,7 +578,7 @@ export type Building = {
   /**
    * Raw source identifier (e.g. OS NGD `osid`)
    */
-  externalId: string;
+  externalId?: string | undefined;
   /**
    * Number of above-ground floors
    */
@@ -582,7 +606,7 @@ export type Building = {
   /**
    * Object type identifier
    */
-  object: BuildingObject;
+  object?: BuildingObject | undefined;
   /**
    * Number of building parts associated with this building
    */
@@ -598,7 +622,7 @@ export type Building = {
   /**
    * Source registry / provider code
    */
-  provider: Provider;
+  provider?: Provider | undefined;
   /**
    * UTC date the building was first observed in any source feed
    */
@@ -614,11 +638,11 @@ export type Building = {
   /**
    * All data sources that contributed at least one field to this building
    */
-  sources: Array<Sources>;
+  sources?: Array<Sources> | undefined;
   /**
    * Lifecycle state of the building record
    */
-  status: BuildingStatus;
+  status?: BuildingStatus | undefined;
   /**
    * Physical structure characteristics (OS NGD aerial / LIDAR)
    */
@@ -700,8 +724,8 @@ export const Coordinates$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  lat: z.number(),
-  lng: z.number(),
+  lat: z.number().optional(),
+  lng: z.number().optional(),
 });
 
 export function coordinatesFromJSON(
@@ -724,10 +748,10 @@ export const Connectivity$inboundSchema: z.ZodType<
 /** @internal */
 export const Age$inboundSchema: z.ZodType<Age, z.ZodTypeDef, unknown> = z
   .object({
-    endYear: z.nullable(z.number().int()),
-    isExact: z.boolean(),
-    midYear: z.nullable(z.number().int()),
-    startYear: z.nullable(z.number().int()),
+    endYear: z.nullable(z.number().int()).optional(),
+    isExact: z.boolean().optional(),
+    midYear: z.nullable(z.number().int()).optional(),
+    startYear: z.nullable(z.number().int()).optional(),
   });
 
 export function ageFromJSON(
@@ -785,14 +809,19 @@ export const DataSources$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(DataSources);
 
+/** @internal */
+export const BuildingSchemasType$inboundSchema: z.ZodNativeEnum<
+  typeof BuildingSchemasType
+> = z.nativeEnum(BuildingSchemasType);
+
 /** @internal */
 export const GeoJSONMultiPolygon$inboundSchema: z.ZodType<
   GeoJSONMultiPolygon,
   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: BuildingSchemasType$inboundSchema.optional(),
 });
 
 export function geoJSONMultiPolygonFromJSON(
@@ -805,14 +834,19 @@ export function geoJSONMultiPolygonFromJSON(
   );
 }
 
+/** @internal */
+export const BuildingSchemasFootprintType$inboundSchema: z.ZodNativeEnum<
+  typeof BuildingSchemasFootprintType
+> = z.nativeEnum(BuildingSchemasFootprintType);
+
 /** @internal */
 export const GeoJSONPolygon$inboundSchema: z.ZodType<
   GeoJSONPolygon,
   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: BuildingSchemasFootprintType$inboundSchema.optional(),
 });
 
 export function geoJSONPolygonFromJSON(
@@ -978,15 +1012,15 @@ export const Building$inboundSchema: z.ZodType<
   addresses: z.nullable(z.array(BuildingAddressLink$inboundSchema)).optional(),
   areaSqm: z.nullable(z.number()).optional(),
   basement: z.nullable(z.lazy(() => Basement$inboundSchema)).optional(),
-  buildingId: z.string(),
+  buildingId: z.string().optional(),
   buildingUse: z.nullable(z.string()).optional(),
   buildingUseTierA: z.nullable(z.string()).optional(),
   centroid: z.nullable(z.lazy(() => Coordinates$inboundSchema)).optional(),
   connectivity: z.nullable(Connectivity$inboundSchema).optional(),
   construction: z.nullable(z.lazy(() => Construction$inboundSchema)).optional(),
-  country: z.string(),
+  country: z.string().optional(),
   dataSources: z.array(DataSources$inboundSchema).optional(),
-  externalId: z.string(),
+  externalId: z.string().optional(),
   floors: z.nullable(z.number().int()).optional(),
   footprint: z.nullable(
     z.union([
@@ -998,16 +1032,16 @@ export const Building$inboundSchema: z.ZodType<
   heightRoofBase: z.nullable(z.number()).optional(),
   indexedAt: z.nullable(z.string()).optional(),
   locationIds: z.array(z.string()).optional(),
-  object: BuildingObject$inboundSchema,
+  object: BuildingObject$inboundSchema.optional(),
   partCount: z.number().int().default(0),
   parts: z.nullable(z.array(BuildingPart$inboundSchema)).optional(),
   physicalState: z.nullable(PhysicalState$inboundSchema).optional(),
-  provider: Provider$inboundSchema,
+  provider: Provider$inboundSchema.optional(),
   registeredAt: z.nullable(z.string()).optional(),
   roof: z.nullable(z.lazy(() => Roof$inboundSchema)).optional(),
   sourceUpdatedAt: z.nullable(z.string()).optional(),
-  sources: z.array(Sources$inboundSchema),
-  status: BuildingStatus$inboundSchema,
+  sources: z.array(Sources$inboundSchema).optional(),
+  status: BuildingStatus$inboundSchema.optional(),
   structure: z.nullable(z.lazy(() => Structure$inboundSchema)).optional(),
   type: z.nullable(z.string()).optional(),
   updatedAt: z.nullable(z.string()).optional(),

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/censusareaprofilerequest.ts

@@ -3,11 +3,29 @@
  */
 
 import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
+ */
+export const CodeSystem = {
+  OnsGss: "ons_gss",
+  CsoSa: "cso_sa",
+  CsoEd: "cso_ed",
+} as const;
+/**
+ * Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
+ */
+export type CodeSystem = ClosedEnum<typeof CodeSystem>;
 
 /**
  * Request body for the multi-area census profile.
  */
 export type CensusAreaProfileRequest = {
+  /**
+   * Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
+   */
+  codeSystem?: CodeSystem | undefined;
   /**
    * Stable public dataset id.
    */
@@ -22,8 +40,13 @@ export type CensusAreaProfileRequest = {
   variableSlugs?: Array<string> | undefined;
 };
 
+/** @internal */
+export const CodeSystem$outboundSchema: z.ZodNativeEnum<typeof CodeSystem> = z
+  .nativeEnum(CodeSystem);
+
 /** @internal */
 export type CensusAreaProfileRequest$Outbound = {
+  codeSystem: string;
   datasetCode: string;
   geographyCodes: Array<string>;
   variableSlugs?: Array<string> | undefined;
@@ -35,6 +58,7 @@ export const CensusAreaProfileRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CensusAreaProfileRequest
 > = z.object({
+  codeSystem: CodeSystem$outboundSchema.default("ons_gss"),
   datasetCode: z.string(),
   geographyCodes: z.array(z.string()),
   variableSlugs: z.array(z.string()).optional(),

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

@@ -3,6 +3,22 @@
  */
 
 import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
+ */
+export const CensusRollupRequestCodeSystem = {
+  OnsGss: "ons_gss",
+  CsoSa: "cso_sa",
+  CsoEd: "cso_ed",
+} as const;
+/**
+ * Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
+ */
+export type CensusRollupRequestCodeSystem = ClosedEnum<
+  typeof CensusRollupRequestCodeSystem
+>;
 
 /**
  * Request body for the custom-area census rollup. Ratios are SUM(count)/SUM(base), never an average of ratios.
@@ -12,6 +28,10 @@ export type CensusRollupRequest = {
    * Category codes ('{classificationCode}-{NNN}') to roll up across the custom area. At least one is required; there is no wildcard — list every code you want.
    */
   categoryCodes: Array<string>;
+  /**
+   * Geography-code system the geographyCodes belong to. 'ons_gss' (default): UK ONS GSS codes. 'cso_sa' / 'cso_ed': Irish CSO Small Area / Electoral Division codes (future).
+   */
+  codeSystem?: CensusRollupRequestCodeSystem | undefined;
   /**
    * Stable public dataset id.
    */
@@ -22,9 +42,15 @@ export type CensusRollupRequest = {
   geographyCodes: Array<string>;
 };
 
+/** @internal */
+export const CensusRollupRequestCodeSystem$outboundSchema: z.ZodNativeEnum<
+  typeof CensusRollupRequestCodeSystem
+> = z.nativeEnum(CensusRollupRequestCodeSystem);
+
 /** @internal */
 export type CensusRollupRequest$Outbound = {
   categoryCodes: Array<string>;
+  codeSystem: string;
   datasetCode: string;
   geographyCodes: Array<string>;
 };
@@ -36,6 +62,7 @@ export const CensusRollupRequest$outboundSchema: z.ZodType<
   CensusRollupRequest
 > = z.object({
   categoryCodes: z.array(z.string()),
+  codeSystem: CensusRollupRequestCodeSystem$outboundSchema.default("ons_gss"),
   datasetCode: z.string(),
   geographyCodes: z.array(z.string()),
 });