@vepler/sdk 6.61.0 → 6.66.0

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

@@ -30,7 +30,7 @@ export type GetNearestPOIRequest = {
    */
   routing?: string | undefined;
   /**
-   * Comma-separated categories to include, for example 'education,health,transport'. Every category is returned when omitted.
+   * Comma-separated category codes to include, for example 'RETAIL,RAIL'. The accepted codes are RETAIL, RAIL, METRO, FERRY, AIRPORT, BUS, AIRPORT_SMALL, AIRPORT_INTERNATIONAL. Case and the spaces around each code are ignored, and any other code rejects the request with a 400. Every category is returned when omitted or empty.
    */
   types?: string | undefined;
 };
@@ -101,7 +101,7 @@ export type GetNearestPOILocation = {
 };
 
 /**
- * A point of interest, such as a school, a hospital or a transport hub.
+ * A point of interest, such as a shop, a station or an airport.
  */
 export type GetNearestPOIResult = {
   /**
@@ -109,7 +109,7 @@ export type GetNearestPOIResult = {
    */
   address?: string | null | undefined;
   /**
-   * Code identifying the category the place belongs to, such as `education`. Pass it in `types` to filter a search.
+   * Code identifying the category the place belongs to, one of RETAIL, RAIL, METRO, FERRY, AIRPORT, BUS, AIRPORT_SMALL, AIRPORT_INTERNATIONAL. Pass it in `types` to filter a search.
    */
   categoryId: string;
   /**

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

@@ -104,7 +104,7 @@ export type GetPOIMultipleTilesProperties = {
    */
   category?: string | undefined;
   /**
-   * Code identifying the category the place belongs to, such as `education`.
+   * Code identifying the category the place belongs to, one of RETAIL, RAIL, METRO, FERRY, AIRPORT, BUS, AIRPORT_SMALL, AIRPORT_INTERNATIONAL.
    */
   categoryId: string;
   /**

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

@@ -67,7 +67,7 @@ export type Properties = {
    */
   category?: string | undefined;
   /**
-   * Code identifying the category the place belongs to, such as `education`.
+   * Code identifying the category the place belongs to, one of RETAIL, RAIL, METRO, FERRY, AIRPORT, BUS, AIRPORT_SMALL, AIRPORT_INTERNATIONAL.
    */
   categoryId: string;
   /**

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

@@ -322,6 +322,7 @@ export * from "./propertyattributeentry.js";
 export * from "./propertyattributegroup.js";
 export * from "./propertybyslugsrequest.js";
 export * from "./propertydataapi.js";
+export * from "./propertyfieldprovenance.js";
 export * from "./propertyfilterfield.js";
 export * from "./propertylistresponse.js";
 export * from "./propertylocationidareafilter.js";
@@ -335,6 +336,7 @@ export * from "./propertyquerycondition.js";
 export * from "./propertyquerygroup.js";
 export * from "./propertyqueryoperator.js";
 export * from "./propertyqueryrequest.js";
+export * from "./propertysourcevalue.js";
 export * from "./propertytags.js";
 export * from "./propertytierinfo.js";
 export * from "./propertyvalueimpact.js";

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

@@ -25,6 +25,14 @@ export type PropertyAddressCountryCode = OpenEnum<
 >;
 
 export type PropertyAddress = {
+  /**
+   * The building's name: Royal Mail's where the address has one, otherwise Ordnance Survey's. `_provenance` names which it is and the date of that record. Absent when neither names the building, and on properties whose stored address predates the field.
+   */
+  buildingName?: string | undefined;
+  /**
+   * The building's number on its street, as text: Royal Mail's where the address has one, otherwise Ordnance Survey's. `_provenance` names which it is and the date of that record. Absent when the building has no number, and on properties whose stored address predates the field.
+   */
+  buildingNumber?: string | undefined;
   /**
    * The UK nation the address sits in, as a slug: `england`, `scotland`, `wales` or `northern-ireland`. Null when the nation could not be resolved.
    */
@@ -66,7 +74,7 @@ export type PropertyAddress = {
    */
   outcode?: string | undefined;
   /**
-   * Post town the address is delivered through.
+   * The settlement the street sits in (city, town, village, hamlet or parish), as Ordnance Survey names it. Despite the field name this is the geographic town, not the Royal Mail post town the address is delivered through, and the two can differ.
    */
   postTown?: string | undefined;
   /**
@@ -77,6 +85,10 @@ export type PropertyAddress = {
    * The postcode with the space removed. This is the form a postcode area filter matches against.
    */
   postcodeNoSpace?: string | undefined;
+  /**
+   * The street the address is on: the Royal Mail thoroughfare where the address has one, otherwise the Ordnance Survey street name. `_provenance` names which it is and the date of that record. Absent when neither names a street, and on properties whose stored address predates the field.
+   */
+  street?: string | undefined;
 };
 
 /** @internal */
@@ -92,6 +104,8 @@ export const PropertyAddress$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  buildingName: z.string().optional(),
+  buildingNumber: z.string().optional(),
   country: z.nullable(z.string()).optional(),
   countryCode: PropertyAddressCountryCode$inboundSchema.optional(),
   county: z.string().optional(),
@@ -105,6 +119,7 @@ export const PropertyAddress$inboundSchema: z.ZodType<
   post_town: z.string().optional(),
   postcode: z.string().optional(),
   postcodeNoSpace: z.string().optional(),
+  street: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "line_1": "line1",

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

@@ -31,6 +31,10 @@ import {
   PropertyAssessments,
   PropertyAssessments$inboundSchema,
 } from "./propertyassessments.js";
+import {
+  PropertyFieldProvenance,
+  PropertyFieldProvenance$inboundSchema,
+} from "./propertyfieldprovenance.js";
 import { PropertyTags, PropertyTags$inboundSchema } from "./propertytags.js";
 import {
   RefurbishmentData,
@@ -437,9 +441,9 @@ export type PropertyDataApiSpatial = {
 
 export type PropertyDataApi = {
   /**
-   * Where each claim-resolved value came from, keyed by the field it applies to. Request it through `attributes`; it is returned only to callers holding the source-data permission.
+   * Where each served value came from and the date of its evidence, keyed by the served field's dotted path, such as `address.street`, `classificationCode` or `roomDetails.beds`. Request it through `attributes`; it is returned only to callers holding the source-data permission.
    */
-  provenance?: { [k: string]: { [k: string]: any } } | undefined;
+  provenance?: { [k: string]: PropertyFieldProvenance } | undefined;
   address?: PropertyAddress | undefined;
   /**
    * Heritage and conservation designations assessed at this property's location. A product that is absent was not assessed.
@@ -924,7 +928,7 @@ export const PropertyDataApi$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _provenance: z.record(z.record(z.any())).optional(),
+  _provenance: z.record(PropertyFieldProvenance$inboundSchema).optional(),
   address: PropertyAddress$inboundSchema.optional(),
   assessments: PropertyAssessments$inboundSchema.optional(),
   build: BuildData$inboundSchema.optional(),

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

@@ -0,0 +1,196 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+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";
+import {
+  PropertySourceValue,
+  PropertySourceValue$inboundSchema,
+} from "./propertysourcevalue.js";
+
+export const ContributingSources = {
+  Paf: "paf",
+  Os: "os",
+  OsNgd: "os_ngd",
+  NgdAddresses: "ngd_addresses",
+  Epc: "epc",
+  Hmlr: "hmlr",
+  Voa: "voa",
+  Hmrc: "hmrc",
+  HistoricEngland: "historic_england",
+  Listing: "listing",
+  OpenData: "open_data",
+  Council: "council",
+  Claim: "claim",
+} as const;
+export type ContributingSources = OpenEnum<typeof ContributingSources>;
+
+/**
+ * How the winning value was chosen. `single_source` and `first_non_null` take the first source in priority order that had a value, `newest_evidence` takes the one with the most recent evidence date, `highest_confidence` the one with the highest confidence score, and `narrowest_range` the one giving the tightest year range.
+ */
+export const ResolutionRule = {
+  SingleSource: "single_source",
+  FirstNonNull: "first_non_null",
+  NewestEvidence: "newest_evidence",
+  HighestConfidence: "highest_confidence",
+  NarrowestRange: "narrowest_range",
+} as const;
+/**
+ * How the winning value was chosen. `single_source` and `first_non_null` take the first source in priority order that had a value, `newest_evidence` takes the one with the most recent evidence date, `highest_confidence` the one with the highest confidence score, and `narrowest_range` the one giving the tightest year range.
+ */
+export type ResolutionRule = OpenEnum<typeof ResolutionRule>;
+
+/**
+ * Data source whose value won under `resolutionRule`.
+ */
+export const PropertyFieldProvenanceSource = {
+  Paf: "paf",
+  Os: "os",
+  OsNgd: "os_ngd",
+  NgdAddresses: "ngd_addresses",
+  Epc: "epc",
+  Hmlr: "hmlr",
+  Voa: "voa",
+  Hmrc: "hmrc",
+  HistoricEngland: "historic_england",
+  Listing: "listing",
+  OpenData: "open_data",
+  Council: "council",
+  Claim: "claim",
+} as const;
+/**
+ * Data source whose value won under `resolutionRule`.
+ */
+export type PropertyFieldProvenanceSource = OpenEnum<
+  typeof PropertyFieldProvenanceSource
+>;
+
+/**
+ * What each contributing source reported, keyed by source. Only contributing sources appear.
+ */
+export type SourceValues = {
+  claim?: PropertySourceValue | undefined;
+  council?: PropertySourceValue | undefined;
+  epc?: PropertySourceValue | undefined;
+  historicEngland?: PropertySourceValue | undefined;
+  hmlr?: PropertySourceValue | undefined;
+  hmrc?: PropertySourceValue | undefined;
+  listing?: PropertySourceValue | undefined;
+  ngdAddresses?: PropertySourceValue | undefined;
+  openData?: PropertySourceValue | undefined;
+  os?: PropertySourceValue | undefined;
+  osNgd?: PropertySourceValue | undefined;
+  paf?: PropertySourceValue | undefined;
+  voa?: PropertySourceValue | undefined;
+};
+
+export type PropertyFieldProvenance = {
+  /**
+   * Every data source that had a value for this field, whether or not it won.
+   */
+  contributingSources?: Array<ContributingSources> | undefined;
+  /**
+   * How the winning value was chosen. `single_source` and `first_non_null` take the first source in priority order that had a value, `newest_evidence` takes the one with the most recent evidence date, `highest_confidence` the one with the highest confidence score, and `narrowest_range` the one giving the tightest year range.
+   */
+  resolutionRule?: ResolutionRule | undefined;
+  /**
+   * Data source whose value won under `resolutionRule`.
+   */
+  source?: PropertyFieldProvenanceSource | undefined;
+  /**
+   * What each contributing source reported, keyed by source. Only contributing sources appear.
+   */
+  sourceValues?: SourceValues | undefined;
+  /**
+   * The value that won, which is the one served at the field's path.
+   */
+  value?: any | undefined;
+};
+
+/** @internal */
+export const ContributingSources$inboundSchema: z.ZodType<
+  ContributingSources,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ContributingSources);
+
+/** @internal */
+export const ResolutionRule$inboundSchema: z.ZodType<
+  ResolutionRule,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ResolutionRule);
+
+/** @internal */
+export const PropertyFieldProvenanceSource$inboundSchema: z.ZodType<
+  PropertyFieldProvenanceSource,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyFieldProvenanceSource);
+
+/** @internal */
+export const SourceValues$inboundSchema: z.ZodType<
+  SourceValues,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  claim: PropertySourceValue$inboundSchema.optional(),
+  council: PropertySourceValue$inboundSchema.optional(),
+  epc: PropertySourceValue$inboundSchema.optional(),
+  historic_england: PropertySourceValue$inboundSchema.optional(),
+  hmlr: PropertySourceValue$inboundSchema.optional(),
+  hmrc: PropertySourceValue$inboundSchema.optional(),
+  listing: PropertySourceValue$inboundSchema.optional(),
+  ngd_addresses: PropertySourceValue$inboundSchema.optional(),
+  open_data: PropertySourceValue$inboundSchema.optional(),
+  os: PropertySourceValue$inboundSchema.optional(),
+  os_ngd: PropertySourceValue$inboundSchema.optional(),
+  paf: PropertySourceValue$inboundSchema.optional(),
+  voa: PropertySourceValue$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "historic_england": "historicEngland",
+    "ngd_addresses": "ngdAddresses",
+    "open_data": "openData",
+    "os_ngd": "osNgd",
+  });
+});
+
+export function sourceValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<SourceValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SourceValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SourceValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const PropertyFieldProvenance$inboundSchema: z.ZodType<
+  PropertyFieldProvenance,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  contributingSources: z.array(ContributingSources$inboundSchema).optional(),
+  resolutionRule: ResolutionRule$inboundSchema.optional(),
+  source: PropertyFieldProvenanceSource$inboundSchema.optional(),
+  sourceValues: z.lazy(() => SourceValues$inboundSchema).optional(),
+  value: z.any().optional(),
+});
+
+export function propertyFieldProvenanceFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyFieldProvenance, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyFieldProvenance$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyFieldProvenance' from JSON`,
+  );
+}

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

@@ -0,0 +1,54 @@
+/*
+ * 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 PropertySourceValue = {
+  /**
+   * How this source captured the value, in its own wording, for example `epc:survey` or `advert`.
+   */
+  captureMethod?: string | null | undefined;
+  /**
+   * How far this source's value is trusted, from 0 to 100, where higher is more trusted. The `highest_confidence` rule picks the winner on this number, and `narrowest_range` uses it to break ties.
+   */
+  confidence?: number | undefined;
+  /**
+   * Date of the evidence behind this value, as an ISO 8601 date, such as the date the address record it was read from was last updated or the date the advert stating it was published. Absent when the source gives no date.
+   */
+  evidenceDate?: string | null | undefined;
+  /**
+   * When the source last reported this value, as an ISO 8601 date.
+   */
+  updatedAt?: string | null | undefined;
+  /**
+   * The value this source reported for the field. Its type follows the field.
+   */
+  value?: any | undefined;
+};
+
+/** @internal */
+export const PropertySourceValue$inboundSchema: z.ZodType<
+  PropertySourceValue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  captureMethod: z.nullable(z.string()).optional(),
+  confidence: z.number().optional(),
+  evidenceDate: z.nullable(z.string()).optional(),
+  updatedAt: z.nullable(z.string()).optional(),
+  value: z.any().optional(),
+});
+
+export function propertySourceValueFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertySourceValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertySourceValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertySourceValue' from JSON`,
+  );
+}

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

@@ -388,6 +388,10 @@ export type Site = {
    * Identifier for a single registered title, made up of the country, the registry and the title number joined by colons.
    */
   siteId?: string | undefined;
+  /**
+   * When HM Land Registry last changed this title's boundary record, as an ISO 8601 timestamp: the latest update date across the title's polygons. Null when the register gives no date.
+   */
+  sourceUpdatedAt?: string | null | undefined;
   /**
    * Data sources that contributed to this site record.
    */
@@ -409,7 +413,7 @@ export type Site = {
    */
   titleRef?: string | undefined;
   /**
-   * When this site record was last updated, as an ISO 8601 timestamp.
+   * When Vepler last loaded or rebuilt this site record, as an ISO 8601 timestamp. It is not a date from HM Land Registry; `sourceUpdatedAt` and `registeredAt` are.
    */
   updatedAt?: string | null | undefined;
 };
@@ -611,6 +615,7 @@ export const Site$inboundSchema: z.ZodType<Site, z.ZodTypeDef, unknown> = z
     registry: z.string().optional(),
     relationships: z.array(z.string()).optional(),
     siteId: z.string().optional(),
+    sourceUpdatedAt: z.nullable(z.string()).optional(),
     sources: z.array(z.string()).optional(),
     status: SiteStatus$inboundSchema.optional(),
     tags: SiteTags$inboundSchema.optional(),