@vepler/sdk 6.0.0 → 6.8.0

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

@@ -4,10 +4,66 @@
 
 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";
+import {
+  ImageDocumentClass,
+  ImageDocumentClass$inboundSchema,
+} from "./imagedocumentclass.js";
+import { ImageQuality, ImageQuality$inboundSchema } from "./imagequality.js";
+import {
+  ImageSceneLabel,
+  ImageSceneLabel$inboundSchema,
+} from "./imagescenelabel.js";
+
+/**
+ * The state of repair the photograph suggests. Null when no assessment is published for this image.
+ */
+export const ListingImageCondition = {
+  MoveInReady: "move_in_ready",
+  CosmeticallyDated: "cosmetically_dated",
+  RenovationNeeded: "renovation_needed",
+  Derelict: "derelict",
+} as const;
+/**
+ * The state of repair the photograph suggests. Null when no assessment is published for this image.
+ */
+export type ListingImageCondition = OpenEnum<typeof ListingImageCondition>;
+
+/**
+ * What this image is and what it shows. Null until the image has been analysed.
+ */
+export type Labels = {
+  condition?: ListingImageCondition | null | undefined;
+  /**
+   * What the image is, rather than what it shows. A `photo` is a photograph of the property or its surroundings; the other values are documents published alongside the photographs.
+   */
+  documentClass?: ImageDocumentClass | undefined;
+  /**
+   * How strongly the image supports its document class, from 0 to 1.
+   */
+  documentClassConfidence?: number | undefined;
+  /**
+   * How the photograph presents the property rather than what it shows. `virtually_staged` marks furniture added digitally, and `empty_room` marks an unfurnished space.
+   */
+  presentation?: Array<ImageQuality> | undefined;
+  /**
+   * The spaces the photograph shows, most specific first, each with its own confidence. Keys are hierarchical, so `interior.bathroom.ensuite` also implies `interior.bathroom` and `interior`. Empty for anything that is not a photograph.
+   */
+  scene?: Array<ImageSceneLabel> | undefined;
+  /**
+   * Release of the label vocabulary these values were produced against.
+   */
+  taxonomyVersion?: string | undefined;
+};
 
 export type ListingImage = {
+  /**
+   * What this image is and what it shows. Null until the image has been analysed.
+   */
+  labels?: Labels | null | undefined;
   /**
    * URL of a ready-made 640×480 WebP thumbnail of the same image.
    */
@@ -18,12 +74,41 @@ export type ListingImage = {
   url?: string | null | undefined;
 };
 
+/** @internal */
+export const ListingImageCondition$inboundSchema: z.ZodType<
+  ListingImageCondition,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListingImageCondition);
+
+/** @internal */
+export const Labels$inboundSchema: z.ZodType<Labels, z.ZodTypeDef, unknown> = z
+  .object({
+    condition: z.nullable(ListingImageCondition$inboundSchema).optional(),
+    documentClass: ImageDocumentClass$inboundSchema.optional(),
+    documentClassConfidence: z.number().optional(),
+    presentation: z.array(ImageQuality$inboundSchema).optional(),
+    scene: z.array(ImageSceneLabel$inboundSchema).optional(),
+    taxonomyVersion: z.string().optional(),
+  });
+
+export function labelsFromJSON(
+  jsonString: string,
+): SafeParseResult<Labels, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Labels$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Labels' from JSON`,
+  );
+}
+
 /** @internal */
 export const ListingImage$inboundSchema: z.ZodType<
   ListingImage,
   z.ZodTypeDef,
   unknown
 > = z.object({
+  labels: z.nullable(z.lazy(() => Labels$inboundSchema)).optional(),
   thumbnailUrl: z.nullable(z.string()).optional(),
   url: z.nullable(z.string()).optional(),
 });

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

@@ -20,6 +20,10 @@ export const MortgageChargeStatus = {
 export type MortgageChargeStatus = OpenEnum<typeof MortgageChargeStatus>;
 
 export type MortgageCharge = {
+  /**
+   * Other title numbers the same charge is registered against, read from an `affecting also title …` clause. Empty when the charge affects only `titleAffected`.
+   */
+  alsoAffectsTitles: Array<string>;
   chargeDate: string;
   chargeHolder: TitleProprietor;
   /**
@@ -55,6 +59,7 @@ export const MortgageCharge$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  alsoAffectsTitles: z.array(z.string()),
   chargeDate: z.string(),
   chargeHolder: TitleProprietor$inboundSchema,
   dischargedDate: z.nullable(z.string()),

package/src/sdk/models/shared/observedfeature.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 ObservedFeature = {
+  /**
+   * Confidence of the strongest supporting image, from 0 to 1.
+   */
+  confidence?: number | undefined;
+  /**
+   * How many photographs support the feature. This counts images, not rooms: three photographs of a bathroom do not mean three bathrooms.
+   */
+  imageCount?: number | undefined;
+  /**
+   * Whether the photographs support this feature at the published confidence.
+   */
+  present?: boolean | undefined;
+};
+
+/** @internal */
+export const ObservedFeature$inboundSchema: z.ZodType<
+  ObservedFeature,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  confidence: z.number().optional(),
+  imageCount: z.number().int().optional(),
+  present: z.boolean().optional(),
+});
+
+export function observedFeatureFromJSON(
+  jsonString: string,
+): SafeParseResult<ObservedFeature, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ObservedFeature$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ObservedFeature' from JSON`,
+  );
+}

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

@@ -12,13 +12,20 @@ export type OtherCharge = {
    * The kind of charge, as the register labels it.
    */
   chargeType: string;
+  /**
+   * The date the entry was made in the register (the entry's `(dd.mm.yyyy)` prefix). Null when the entry carries no registration date.
+   */
   date: string | null;
   /**
    * Plain-English explanation of what this charge means for the owner, written by a language model from the register entry.
    */
   effectOfCharge: string;
   /**
-   * The parties named in the original charge entry.
+   * The date of the deed the entry refers to (the conveyance, transfer, lease or charge that created it), when the entry states one. Null otherwise. Distinct from `date`, which is when the entry was registered.
+   */
+  instrumentDate: string | null;
+  /**
+   * The parties the entry names, verbatim, in the order the deed lists them. Empty when the entry names nobody. Never a placeholder: an entry that names parties and reports none here is an extraction defect, not a register fact.
    */
   originalParties: Array<string>;
   sourceEntryRef: string;
@@ -33,6 +40,7 @@ export const OtherCharge$inboundSchema: z.ZodType<
   chargeType: z.string(),
   date: z.nullable(z.string()),
   effectOfCharge: z.string(),
+  instrumentDate: z.nullable(z.string()),
   originalParties: z.array(z.string()),
   sourceEntryRef: z.string(),
 });

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

@@ -8,7 +8,14 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type TitleCovenant = {
+  /**
+   * The date the entry was made in the register (the entry's `(dd.mm.yyyy)` prefix). Null when the entry carries no registration date.
+   */
   date: string | null;
+  /**
+   * The date of the deed the entry refers to (the conveyance, transfer, lease or charge that created it), when the entry states one. Null otherwise. Distinct from `date`, which is when the entry was registered.
+   */
+  instrumentDate: string | null;
   /**
    * The legal text, quoted verbatim from the register entry.
    */
@@ -31,6 +38,7 @@ export const TitleCovenant$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   date: z.nullable(z.string()),
+  instrumentDate: z.nullable(z.string()),
   rawText: z.string(),
   sourceEntryRef: z.string(),
   title: z.string(),

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

@@ -18,6 +18,14 @@ import {
   TitleDocumentSummary$inboundSchema,
 } from "./titledocumentsummary.js";
 import { TitleNotice, TitleNotice$inboundSchema } from "./titlenotice.js";
+import {
+  TitlePricePaid,
+  TitlePricePaid$inboundSchema,
+} from "./titlepricepaid.js";
+import {
+  TitlePropertyRight,
+  TitlePropertyRight$inboundSchema,
+} from "./titlepropertyright.js";
 import {
   TitleProprietor,
   TitleProprietor$inboundSchema,
@@ -71,6 +79,9 @@ export type TitleExtractionPayload = {
    * The current owner, formatted as a single line ready to display.
    */
   currentOwnerDisplay: string;
+  /**
+   * The title's documents as they stood when the extraction ran. Document uploads run concurrently with extraction, so this is a snapshot: the API overlays the live document rows on every read, and a consumer must never treat a `pending` here as current.
+   */
   documents: Array<TitleDocumentSummary>;
   extractedAt: Date;
   /**
@@ -79,13 +90,21 @@ export type TitleExtractionPayload = {
   leaseTermDescription: string;
   notices: Array<TitleNotice>;
   ownership: Ownership;
+  /**
+   * The price-paid entry from the Proprietorship Register. Null when the register records none.
+   */
+  pricePaid: TitlePricePaid | null;
   promptVersion: string;
+  /**
+   * Every Property Register entry other than the estate description and the lease particulars: easements, party-wall provisions, exceptions. Empty when the A register has no such entries.
+   */
+  propertyRights: Array<TitlePropertyRight>;
   /**
    * The qualification entry, quoted verbatim from the register. Null on titles that carry no qualification.
    */
   qualification: string | null;
   /**
-   * The edition date of the register this extract was taken from, as an ISO 8601 timestamp.
+   * The instant the official copy states it shows the register at ("shows the entries on the register of title on 17 SEP 2026 at 12:56:56"), as an ISO 8601 UTC timestamp. Not our fetch clock.
    */
   registerAsOf: Date;
   registeredCharges: RegisteredCharges;
@@ -145,7 +164,9 @@ export const TitleExtractionPayload$inboundSchema: z.ZodType<
   leaseTermDescription: z.string(),
   notices: z.array(TitleNotice$inboundSchema),
   ownership: z.lazy(() => Ownership$inboundSchema),
+  pricePaid: z.nullable(TitlePricePaid$inboundSchema),
   promptVersion: z.string(),
+  propertyRights: z.array(TitlePropertyRight$inboundSchema),
   qualification: z.nullable(z.string()).default(null),
   registerAsOf: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)

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

@@ -19,7 +19,14 @@ export const NoticeType = {
 export type NoticeType = OpenEnum<typeof NoticeType>;
 
 export type TitleNotice = {
+  /**
+   * The date the entry was made in the register (the entry's `(dd.mm.yyyy)` prefix). Null when the entry carries no registration date.
+   */
   date: string | null;
+  /**
+   * The date of the deed the entry refers to (the conveyance, transfer, lease or charge that created it), when the entry states one. Null otherwise. Distinct from `date`, which is when the entry was registered.
+   */
+  instrumentDate: string | null;
   noticeType: NoticeType;
   partyName: string | null;
   /**
@@ -51,6 +58,7 @@ export const TitleNotice$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   date: z.nullable(z.string()),
+  instrumentDate: z.nullable(z.string()),
   noticeType: NoticeType$inboundSchema,
   partyName: z.nullable(z.string()),
   rawText: z.string(),

package/src/sdk/models/shared/titlepricepaid.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";
+
+/**
+ * The price-paid entry from the Proprietorship Register. Null when the register records none.
+ */
+export type TitlePricePaid = {
+  /**
+   * The price as stated in the register, in whole pounds.
+   */
+  amountPounds: number;
+  /**
+   * The date the price is stated to have been paid on. Null when the entry states no date (a leasehold grant price, for instance).
+   */
+  date: string | null;
+  /**
+   * The entry, quoted verbatim from the register.
+   */
+  rawText: string;
+  /**
+   * The date the entry was made in the register (the entry's `(dd.mm.yyyy)` prefix). Null when the entry carries no registration date.
+   */
+  registrationDate: string | null;
+  sourceEntryRef: string;
+};
+
+/** @internal */
+export const TitlePricePaid$inboundSchema: z.ZodType<
+  TitlePricePaid,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amountPounds: z.number().int(),
+  date: z.nullable(z.string()),
+  rawText: z.string(),
+  registrationDate: z.nullable(z.string()),
+  sourceEntryRef: z.string(),
+});
+
+export function titlePricePaidFromJSON(
+  jsonString: string,
+): SafeParseResult<TitlePricePaid, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitlePricePaid$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitlePricePaid' from JSON`,
+  );
+}

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

@@ -0,0 +1,81 @@
+/*
+ * 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";
+
+/**
+ * `benefit`: a right this land enjoys over other land. `burden`: a right other land enjoys over this land. `both`: the entry grants and reserves. `provision`: a declaration or exception that is neither (a party-wall agreement, an exception from registration, a note that the lessor's title is registered).
+ */
+export const Nature = {
+  Benefit: "benefit",
+  Burden: "burden",
+  Both: "both",
+  Provision: "provision",
+} as const;
+/**
+ * `benefit`: a right this land enjoys over other land. `burden`: a right other land enjoys over this land. `both`: the entry grants and reserves. `provision`: a declaration or exception that is neither (a party-wall agreement, an exception from registration, a note that the lessor's title is registered).
+ */
+export type Nature = OpenEnum<typeof Nature>;
+
+export type TitlePropertyRight = {
+  /**
+   * The date the entry was made in the register (the entry's `(dd.mm.yyyy)` prefix). Null when the entry carries no registration date.
+   */
+  date: string | null;
+  /**
+   * The date of the deed the entry refers to (the conveyance, transfer, lease or charge that created it), when the entry states one. Null otherwise. Distinct from `date`, which is when the entry was registered.
+   */
+  instrumentDate: string | null;
+  /**
+   * `benefit`: a right this land enjoys over other land. `burden`: a right other land enjoys over this land. `both`: the entry grants and reserves. `provision`: a declaration or exception that is neither (a party-wall agreement, an exception from registration, a note that the lessor's title is registered).
+   */
+  nature: Nature;
+  /**
+   * The entry, quoted verbatim from the Property Register.
+   */
+  rawText: string;
+  sourceEntryRef: string;
+  /**
+   * Short plain-English label for the entry.
+   */
+  title: string;
+  /**
+   * Plain-English explanation of what the entry means for the current owner, written by a language model from the register entry.
+   */
+  whyThisMatters: string;
+};
+
+/** @internal */
+export const Nature$inboundSchema: z.ZodType<Nature, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Nature);
+
+/** @internal */
+export const TitlePropertyRight$inboundSchema: z.ZodType<
+  TitlePropertyRight,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  date: z.nullable(z.string()),
+  instrumentDate: z.nullable(z.string()),
+  nature: Nature$inboundSchema,
+  rawText: z.string(),
+  sourceEntryRef: z.string(),
+  title: z.string(),
+  whyThisMatters: z.string(),
+});
+
+export function titlePropertyRightFromJSON(
+  jsonString: string,
+): SafeParseResult<TitlePropertyRight, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitlePropertyRight$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitlePropertyRight' from JSON`,
+  );
+}

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

@@ -8,7 +8,14 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type TitleRestriction = {
+  /**
+   * The date the entry was made in the register (the entry's `(dd.mm.yyyy)` prefix). Null when the entry carries no registration date.
+   */
   date: string | null;
+  /**
+   * The date of the deed the entry refers to (the conveyance, transfer, lease or charge that created it), when the entry states one. Null otherwise. Distinct from `date`, which is when the entry was registered.
+   */
+  instrumentDate: string | null;
   /**
    * The legal text, quoted verbatim from the register entry.
    */
@@ -31,6 +38,7 @@ export const TitleRestriction$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   date: z.nullable(z.string()),
+  instrumentDate: z.nullable(z.string()),
   rawText: z.string(),
   sourceEntryRef: z.string(),
   title: z.string(),

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

@@ -13,6 +13,7 @@ export type TitleSummaryCounts = {
   dischargedMortgages: number;
   notices: number;
   otherCharges: number;
+  propertyRights: number;
   restrictions: number;
 };
 
@@ -27,6 +28,7 @@ export const TitleSummaryCounts$inboundSchema: z.ZodType<
   dischargedMortgages: z.number().int(),
   notices: z.number().int(),
   otherCharges: z.number().int(),
+  propertyRights: z.number().int(),
   restrictions: z.number().int(),
 });
 

package/src/sdk/safety.ts

@@ -86,7 +86,7 @@ export class Safety extends ClientSDK {
    * Get crime metrics for one or more geographic areas (England and Wales)
    *
    * @remarks
-   * Return scored crime metrics for one or more areas across one or more months, each with a per-category breakdown and an optional monthly history. Areas are identified by GSS code at six levels: Lower Layer Super Output Area (LSOA, `E01`/`W01`), Middle Layer Super Output Area (MSOA, `E02`/`W02`), local authority district or unitary authority (`E06`-`E09`, `W06`), county (`E10`), English region (`E12`) and country (`E92`, `W92`). Coverage is England and Wales; codes at other levels, such as wards or parishes, and codes in Scotland or Northern Ireland come back as `data: []`. Every month summarises the trailing 24-month window ending at that month, so counts are window totals and rates are per 1,000 residents per year. Months are published two months in arrears, roughly monthly; the catalogue endpoint lists the months held. Scores are null, never 0, where a police force did not report; read `dataAvailability` beside every number. By default the response carries one row per area and month; with `mergeAreas=true` it carries one row per month, with counts and population summed across every requested area and scores, percentiles and trends set to null because they cannot be combined across areas. Choose the months either explicitly with `periods=YYYY-MM,YYYY-MM` or as a range with `startDate` and `endDate`, never both, and set how far each row's history reaches back with `months`, which defaults to 12. An empty result comes back as `data: []` with `total_count: 0`, never as a 204.
+   * Return scored crime metrics for one or more areas across one or more months, each with a per-category breakdown and an optional monthly history. Areas are identified by GSS code at eight levels: Lower Layer Super Output Area (LSOA, `E01`/`W01`), Middle Layer Super Output Area (MSOA, `E02`/`W02`), ward (`E05`/`W05`), built-up area (`E63`/`W45`/`K08`), local authority district or unitary authority (`E06`-`E09`, `W06`), county (`E10`), English region (`E12`) and country (`E92`, `W92`). Coverage is England and Wales; codes at other levels, such as parishes, and codes in Scotland or Northern Ireland come back as `data: []`. Ward and built-up-area figures are aggregated from the Lower Layer Super Output Areas assigned to each area rather than counted on its own boundary, so they are approximations, and `geographyFit` on every row reports how much of the area's footprint those smaller areas cover. A built-up area smaller than the Lower Layer Super Output Area containing it has no figures and comes back as `data: []`. Percentiles rank an area against others of the same type, so a ward is ranked among wards and not among districts. Every month summarises the trailing 24-month window ending at that month, so counts are window totals and rates are per 1,000 residents per year. Months are published two months in arrears, roughly monthly; the catalogue endpoint lists the months held. Scores are null, never 0, where a police force did not report; read `dataAvailability` beside every number. By default the response carries one row per area and month; with `mergeAreas=true` it carries one row per month, with counts and population summed across every requested area and scores, percentiles and trends set to null because they cannot be combined across areas. Choose the months either explicitly with `periods=YYYY-MM,YYYY-MM` or as a range with `startDate` and `endDate`, never both, and set how far each row's history reaches back with `months`, which defaults to 12. An empty result comes back as `data: []` with `total_count: 0`, never as a 204.
    */
   async getGeographyMetrics(
     request: operations.GetGeographyMetricsRequest,