@vepler/sdk 2.137.0 → 2.139.0

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

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Request body for the multi-area census profile.
+ */
+export type CensusAreaProfileRequest = {
+  /**
+   * Stable public dataset id.
+   */
+  datasetCode: string;
+  /**
+   * ONS geography codes to profile (max 100).
+   */
+  geographyCodes: Array<string>;
+  /**
+   * Optional variable-slug filter. Values must be slugs returned by GET /datasets/{datasetCode}/variables. Omit to return the full profile.
+   */
+  variableSlugs?: Array<string> | undefined;
+};
+
+/** @internal */
+export type CensusAreaProfileRequest$Outbound = {
+  datasetCode: string;
+  geographyCodes: Array<string>;
+  variableSlugs?: Array<string> | undefined;
+};
+
+/** @internal */
+export const CensusAreaProfileRequest$outboundSchema: z.ZodType<
+  CensusAreaProfileRequest$Outbound,
+  z.ZodTypeDef,
+  CensusAreaProfileRequest
+> = z.object({
+  datasetCode: z.string(),
+  geographyCodes: z.array(z.string()),
+  variableSlugs: z.array(z.string()).optional(),
+});
+
+export function censusAreaProfileRequestToJSON(
+  censusAreaProfileRequest: CensusAreaProfileRequest,
+): string {
+  return JSON.stringify(
+    CensusAreaProfileRequest$outboundSchema.parse(censusAreaProfileRequest),
+  );
+}

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

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CensusHealthResponse = {
+  /**
+   * Service identifier.
+   */
+  service: string;
+  /**
+   * Service status — 'ok' when operational.
+   */
+  status: string;
+  /**
+   * ISO 8601 timestamp the health check was answered at.
+   */
+  timestamp: string;
+};
+
+/** @internal */
+export const CensusHealthResponse$inboundSchema: z.ZodType<
+  CensusHealthResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  service: z.string(),
+  status: z.string(),
+  timestamp: z.string(),
+});
+
+export function censusHealthResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CensusHealthResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CensusHealthResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CensusHealthResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Request body for the custom-area census rollup. Ratios are SUM(count)/SUM(base), never an average of ratios.
+ */
+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>;
+  /**
+   * Stable public dataset id.
+   */
+  datasetCode: string;
+  /**
+   * ONS geography codes forming the custom area (max 100).
+   */
+  geographyCodes: Array<string>;
+};
+
+/** @internal */
+export type CensusRollupRequest$Outbound = {
+  categoryCodes: Array<string>;
+  datasetCode: string;
+  geographyCodes: Array<string>;
+};
+
+/** @internal */
+export const CensusRollupRequest$outboundSchema: z.ZodType<
+  CensusRollupRequest$Outbound,
+  z.ZodTypeDef,
+  CensusRollupRequest
+> = z.object({
+  categoryCodes: z.array(z.string()),
+  datasetCode: z.string(),
+  geographyCodes: z.array(z.string()),
+});
+
+export function censusRollupRequestToJSON(
+  censusRollupRequest: CensusRollupRequest,
+): string {
+  return JSON.stringify(
+    CensusRollupRequest$outboundSchema.parse(censusRollupRequest),
+  );
+}

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

@@ -162,7 +162,7 @@ export type AirTightness = {
 /**
  * Non-null when source value was corrupted/incomplete.
  */
-export const DataQuality = {
+export const EPCDataSchemasFabricFloorDataQuality = {
   TruncatedThermalTransmittance: "truncated_thermal_transmittance",
   QualityLabelOnly: "quality_label_only",
   WelshLanguage: "welsh_language",
@@ -172,7 +172,9 @@ export const DataQuality = {
 /**
  * Non-null when source value was corrupted/incomplete.
  */
-export type DataQuality = OpenEnum<typeof DataQuality>;
+export type EPCDataSchemasFabricFloorDataQuality = OpenEnum<
+  typeof EPCDataSchemasFabricFloorDataQuality
+>;
 
 /**
  * Energy efficiency rating.
@@ -249,7 +251,7 @@ export type Floor = {
   /**
    * Non-null when source value was corrupted/incomplete.
    */
-  dataQuality: DataQuality | null;
+  dataQuality: EPCDataSchemasFabricFloorDataQuality | null;
   /**
    * Raw SAP description string.
    */
@@ -1778,11 +1780,11 @@ export function airTightnessFromJSON(
 }
 
 /** @internal */
-export const DataQuality$inboundSchema: z.ZodType<
-  DataQuality,
+export const EPCDataSchemasFabricFloorDataQuality$inboundSchema: z.ZodType<
+  EPCDataSchemasFabricFloorDataQuality,
   z.ZodTypeDef,
   unknown
-> = openEnums.inboundSchema(DataQuality);
+> = openEnums.inboundSchema(EPCDataSchemasFabricFloorDataQuality);
 
 /** @internal */
 export const EPCDataEnergyEfficiency$inboundSchema: z.ZodType<
@@ -1815,7 +1817,7 @@ export const InsulationType$inboundSchema: z.ZodType<
 /** @internal */
 export const Floor$inboundSchema: z.ZodType<Floor, z.ZodTypeDef, unknown> = z
   .object({
-    dataQuality: z.nullable(DataQuality$inboundSchema),
+    dataQuality: z.nullable(EPCDataSchemasFabricFloorDataQuality$inboundSchema),
     description: z.nullable(z.string()),
     energyEfficiency: z.nullable(EPCDataEnergyEfficiency$inboundSchema),
     environmentalEfficiency: z.nullable(

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

@@ -92,6 +92,9 @@ export * from "./catchmentfeature.js";
 export * from "./catchmentfeaturecollection.js";
 export * from "./catchmentmeta.js";
 export * from "./catchmentreference.js";
+export * from "./censusareaprofilerequest.js";
+export * from "./censushealthresponse.js";
+export * from "./censusrolluprequest.js";
 export * from "./changelogentry.js";
 export * from "./changeloglistresponse.js";
 export * from "./chargeentry.js";
@@ -269,6 +272,8 @@ export * from "./propertyqueryrequest.js";
 export * from "./propertytags.js";
 export * from "./propertyvalueimpact.js";
 export * from "./prosperitydata.js";
+export * from "./prosperitydimensionscore.js";
+export * from "./prosperityindicator.js";
 export * from "./provenance.js";
 export * from "./psc.js";
 export * from "./psclistresponse.js";

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

@@ -344,6 +344,10 @@ export type PlanningApplication = {
    * High-level classification of the proposed development, derived from the application description and type using AI. Common values include: 'Residential' (new homes, conversions to dwellings), 'Commercial' (offices, retail, hospitality), 'Industrial' (manufacturing, warehousing), 'Mixed Use' (combination of residential and commercial), 'Infrastructure' (roads, utilities, telecommunications), 'Change of Use' (altering the permitted use class of a building). Null if the development could not be classified. This field is useful for filtering applications by broad development sector.
    */
   developmentCategory?: string | null | undefined;
+  /**
+   * Straight-line distance in metres from the application site centroid to the centre supplied in a spatial (`near`) query. Present and ordered ascending (closest first) only when the request used the `near` filter; null when this application has no site point, and omitted/null for non-spatial lookups.
+   */
+  distance?: number | null | undefined;
   /**
    * Documents associated with the planning application, including submitted plans, decision notices, consultation responses, and supporting material. May be empty if no documents have been collected from the source.
    */
@@ -691,6 +695,7 @@ export const PlanningApplication$inboundSchema: z.ZodType<
   decidedDate: z.nullable(z.string()).optional(),
   description: z.nullable(z.string()).optional(),
   developmentCategory: z.nullable(z.string()).optional(),
+  distance: z.nullable(z.number()).optional(),
   documents: z.array(PlanningDocument$inboundSchema).optional(),
   expiryDate: z.nullable(z.string()).optional(),
   extractions: z.nullable(z.lazy(() => Extractions$inboundSchema)).optional(),

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

@@ -4,6 +4,24 @@
 
 import * as z from "zod/v3";
 
+/**
+ * Spatial filter. Returns only applications whose site point lies within `radiusM` metres of the given centre, ordered closest-first, with `distance` (metres) populated on each result. This is the primary way to retrieve the planning applications around a property. Combine with other filters (e.g. statuses, receivedDateFrom) to narrow further.
+ */
+export type Near = {
+  /**
+   * Centre latitude in decimal degrees (WGS84).
+   */
+  lat: number;
+  /**
+   * Centre longitude in decimal degrees (WGS84).
+   */
+  lng: number;
+  /**
+   * Search radius in metres (100–50000). Required when `near` is provided.
+   */
+  radiusM: number;
+};
+
 /**
  * Filter criteria for the search. All specified filters are combined with AND logic (applications must match all filters). Within array filters (e.g. statuses, councils), values are combined with OR logic. Omit or pass an empty object to return all applications.
  */
@@ -32,6 +50,10 @@ export type PlanningQueryFilters = {
    * Filter by exact application reference number as assigned by the council. Matches the key field on application objects (e.g. '24/00123/FUL'). Returns applications with this exact reference from any council.
    */
   key?: string | undefined;
+  /**
+   * Spatial filter. Returns only applications whose site point lies within `radiusM` metres of the given centre, ordered closest-first, with `distance` (metres) populated on each result. This is the primary way to retrieve the planning applications around a property. Combine with other filters (e.g. statuses, receivedDateFrom) to narrow further.
+   */
+  near?: Near | undefined;
   /**
    * Include only applications received on or after this date. Provide an ISO 8601 date string (e.g. '2024-01-01' or '2024-01-01T00:00:00Z'). Use together with receivedDateTo to define a date range.
    */
@@ -58,6 +80,25 @@ export type PlanningQueryFilters = {
   validatedDateTo?: string | undefined;
 };
 
+/** @internal */
+export type Near$Outbound = {
+  lat: number;
+  lng: number;
+  radiusM: number;
+};
+
+/** @internal */
+export const Near$outboundSchema: z.ZodType<Near$Outbound, z.ZodTypeDef, Near> =
+  z.object({
+    lat: z.number(),
+    lng: z.number(),
+    radiusM: z.number().int(),
+  });
+
+export function nearToJSON(near: Near): string {
+  return JSON.stringify(Near$outboundSchema.parse(near));
+}
+
 /** @internal */
 export type PlanningQueryFilters$Outbound = {
   appealedDateFrom?: string | undefined;
@@ -66,6 +107,7 @@ export type PlanningQueryFilters$Outbound = {
   developmentCategories?: Array<string> | undefined;
   id?: string | undefined;
   key?: string | undefined;
+  near?: Near$Outbound | undefined;
   receivedDateFrom?: string | undefined;
   receivedDateTo?: string | undefined;
   statuses?: Array<string> | undefined;
@@ -86,6 +128,7 @@ export const PlanningQueryFilters$outboundSchema: z.ZodType<
   developmentCategories: z.array(z.string()).optional(),
   id: z.string().optional(),
   key: z.string().optional(),
+  near: z.lazy(() => Near$outboundSchema).optional(),
   receivedDateFrom: z.string().optional(),
   receivedDateTo: z.string().optional(),
   statuses: z.array(z.string()).optional(),

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

@@ -401,6 +401,10 @@ export type PropertyDataApiSpatial = {
 };
 
 export type PropertyDataApi = {
+  /**
+   * Per-field provenance for claim-resolved fields. Stored, not indexed; returned on request.
+   */
+  provenance?: { [k: string]: { [k: string]: any } } | undefined;
   address?: PropertyAddress | undefined;
   build?: BuildData | undefined;
   /**
@@ -856,6 +860,7 @@ export const PropertyDataApi$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  _provenance: z.record(z.record(z.any())).optional(),
   address: PropertyAddress$inboundSchema.optional(),
   build: BuildData$inboundSchema.optional(),
   building: z.nullable(z.lazy(() => PropertyDataApiBuilding$inboundSchema))
@@ -892,6 +897,10 @@ export const PropertyDataApi$inboundSchema: z.ZodType<
   tenancy: TenancyData$inboundSchema.optional(),
   tenure: TenureData$inboundSchema.optional(),
   unitCount: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_provenance": "provenance",
+  });
 });
 
 export function propertyDataApiFromJSON(

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

@@ -4,56 +4,96 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-export type Employment = {
+import {
+  ProsperityDimensionScore,
+  ProsperityDimensionScore$inboundSchema,
+} from "./prosperitydimensionscore.js";
+import {
+  ProsperityIndicator,
+  ProsperityIndicator$inboundSchema,
+} from "./prosperityindicator.js";
+
+/**
+ * ONS OAC 2021 geodemographic classification (null for Scotland and Northern Ireland, which have no OAC)
+ */
+export type Classification = {
   /**
-   * Dimension score 0-100
+   * OAC group label — the mid-tier segment
    */
-  score: number;
-};
-
-export type Housing = {
+  groupLabel?: string | undefined;
   /**
-   * Dimension score 0-100
+   * Geodemographic classification scheme, e.g. "oac_2021" (ONS Output Area Classification)
    */
-  score: number;
-};
-
-export type Income = {
+  scheme?: string | undefined;
   /**
-   * Dimension score 0-100
+   * OAC subgroup label — the finest-grain segment
    */
-  score: number;
-};
-
-export type LivingStandards = {
+  subgroup?: string | undefined;
   /**
-   * Dimension score 0-100
+   * OAC supergroup label — the broad "what kind of place" segment
    */
-  score: number;
+  supergroupLabel?: string | undefined;
 };
 
+/**
+ * Worst (lowest-quality) data_quality across the populated dimensions; estimated > limited > partial > full
+ */
+export const DataQuality = {
+  Full: "full",
+  Partial: "partial",
+  Limited: "limited",
+  Estimated: "estimated",
+} as const;
+/**
+ * Worst (lowest-quality) data_quality across the populated dimensions; estimated > limited > partial > full
+ */
+export type DataQuality = OpenEnum<typeof DataQuality>;
+
+/**
+ * Per-dimension prosperity breakdown, keyed by dimension
+ */
 export type Dimensions = {
-  employment?: Employment | undefined;
-  housing?: Housing | undefined;
-  income?: Income | undefined;
-  livingStandards?: LivingStandards | undefined;
+  employment?: ProsperityDimensionScore | undefined;
+  housing?: ProsperityDimensionScore | undefined;
+  income?: ProsperityDimensionScore | undefined;
+  livingStandards?: ProsperityDimensionScore | undefined;
 };
 
 export type ProsperityData = {
   /**
-   * National decile 1-10
+   * ONS OAC 2021 geodemographic classification (null for Scotland and Northern Ireland, which have no OAC)
+   */
+  classification?: Classification | null | undefined;
+  /**
+   * ISO 8601 timestamp when this prosperity score was computed
+   */
+  computedAt: Date;
+  /**
+   * Worst (lowest-quality) data_quality across the populated dimensions; estimated > limited > partial > full
+   */
+  dataQuality: DataQuality;
+  /**
+   * National decile 1-10 (10 = most prosperous)
    */
   decile: number;
+  /**
+   * Per-dimension prosperity breakdown, keyed by dimension
+   */
   dimensions?: Dimensions | undefined;
+  /**
+   * Curated array of the underlying indicators (19 ONS/MHCLG measures) that feed the dimensions
+   */
+  indicators?: Array<ProsperityIndicator> | undefined;
   /**
    * National percentile 1-100
    */
   percentile: number;
   /**
-   * Overall prosperity score 0-100
+   * Overall prosperity score 0-100 for the property’s LSOA
    */
   score: number;
   /**
@@ -63,74 +103,33 @@ export type ProsperityData = {
 };
 
 /** @internal */
-export const Employment$inboundSchema: z.ZodType<
-  Employment,
+export const Classification$inboundSchema: z.ZodType<
+  Classification,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  score: z.number(),
+  groupLabel: z.string().optional(),
+  scheme: z.string().optional(),
+  subgroup: z.string().optional(),
+  supergroupLabel: z.string().optional(),
 });
 
-export function employmentFromJSON(
-  jsonString: string,
-): SafeParseResult<Employment, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Employment$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Employment' from JSON`,
-  );
-}
-
-/** @internal */
-export const Housing$inboundSchema: z.ZodType<Housing, z.ZodTypeDef, unknown> =
-  z.object({
-    score: z.number(),
-  });
-
-export function housingFromJSON(
-  jsonString: string,
-): SafeParseResult<Housing, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Housing$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Housing' from JSON`,
-  );
-}
-
-/** @internal */
-export const Income$inboundSchema: z.ZodType<Income, z.ZodTypeDef, unknown> = z
-  .object({
-    score: z.number(),
-  });
-
-export function incomeFromJSON(
+export function classificationFromJSON(
   jsonString: string,
-): SafeParseResult<Income, SDKValidationError> {
+): SafeParseResult<Classification, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Income$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Income' from JSON`,
+    (x) => Classification$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Classification' from JSON`,
   );
 }
 
 /** @internal */
-export const LivingStandards$inboundSchema: z.ZodType<
-  LivingStandards,
+export const DataQuality$inboundSchema: z.ZodType<
+  DataQuality,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  score: z.number(),
-});
-
-export function livingStandardsFromJSON(
-  jsonString: string,
-): SafeParseResult<LivingStandards, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => LivingStandards$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'LivingStandards' from JSON`,
-  );
-}
+> = openEnums.inboundSchema(DataQuality);
 
 /** @internal */
 export const Dimensions$inboundSchema: z.ZodType<
@@ -138,10 +137,10 @@ export const Dimensions$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  employment: z.lazy(() => Employment$inboundSchema).optional(),
-  housing: z.lazy(() => Housing$inboundSchema).optional(),
-  income: z.lazy(() => Income$inboundSchema).optional(),
-  livingStandards: z.lazy(() => LivingStandards$inboundSchema).optional(),
+  employment: ProsperityDimensionScore$inboundSchema.optional(),
+  housing: ProsperityDimensionScore$inboundSchema.optional(),
+  income: ProsperityDimensionScore$inboundSchema.optional(),
+  livingStandards: ProsperityDimensionScore$inboundSchema.optional(),
 });
 
 export function dimensionsFromJSON(
@@ -160,8 +159,13 @@ export const ProsperityData$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  classification: z.nullable(z.lazy(() => Classification$inboundSchema))
+    .optional(),
+  computedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  dataQuality: DataQuality$inboundSchema,
   decile: z.number().int(),
   dimensions: z.lazy(() => Dimensions$inboundSchema).optional(),
+  indicators: z.array(ProsperityIndicator$inboundSchema).optional(),
   percentile: z.number().int(),
   score: z.number(),
   version: z.string(),

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

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Data completeness for this dimension
+ */
+export const ProsperityDimensionScoreDataQuality = {
+  Full: "full",
+  Partial: "partial",
+  Limited: "limited",
+  Estimated: "estimated",
+} as const;
+/**
+ * Data completeness for this dimension
+ */
+export type ProsperityDimensionScoreDataQuality = OpenEnum<
+  typeof ProsperityDimensionScoreDataQuality
+>;
+
+export type ProsperityDimensionScore = {
+  /**
+   * Human-readable weighted formula used to derive the dimension score
+   */
+  calculation: string;
+  /**
+   * Data completeness for this dimension
+   */
+  dataQuality: ProsperityDimensionScoreDataQuality;
+  /**
+   * National percentile for this dimension, 1-100
+   */
+  percentile: number;
+  /**
+   * Dimension score 0-100 (100 = most prosperous)
+   */
+  score: number;
+  /**
+   * This dimension's weight in the overall prosperity score (0-1)
+   */
+  weight: number;
+};
+
+/** @internal */
+export const ProsperityDimensionScoreDataQuality$inboundSchema: z.ZodType<
+  ProsperityDimensionScoreDataQuality,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ProsperityDimensionScoreDataQuality);
+
+/** @internal */
+export const ProsperityDimensionScore$inboundSchema: z.ZodType<
+  ProsperityDimensionScore,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  calculation: z.string(),
+  dataQuality: ProsperityDimensionScoreDataQuality$inboundSchema,
+  percentile: z.number().int(),
+  score: z.number(),
+  weight: z.number(),
+});
+
+export function prosperityDimensionScoreFromJSON(
+  jsonString: string,
+): SafeParseResult<ProsperityDimensionScore, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProsperityDimensionScore$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProsperityDimensionScore' from JSON`,
+  );
+}