@vepler/sdk 6.1.0 → 6.36.0

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

@@ -0,0 +1,202 @@
+/*
+ * 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";
+import {
+  StreetDescriptor,
+  StreetDescriptor$inboundSchema,
+} from "./streetdescriptor.js";
+import {
+  StreetNameConfidence,
+  StreetNameConfidence$inboundSchema,
+} from "./streetnameconfidence.js";
+import {
+  StreetNameKind,
+  StreetNameKind$inboundSchema,
+} from "./streetnamekind.js";
+import {
+  StreetProperties,
+  StreetProperties$inboundSchema,
+} from "./streetproperties.js";
+import {
+  StreetProvenance,
+  StreetProvenance$inboundSchema,
+} from "./streetprovenance.js";
+import { StreetSource, StreetSource$inboundSchema } from "./streetsource.js";
+
+/**
+ * Representative point for the street, at its centre.
+ */
+export type StreetRecordCoordinates = {
+  /**
+   * Latitude in WGS84 decimal degrees.
+   */
+  lat: number;
+  /**
+   * Longitude in WGS84 decimal degrees.
+   */
+  lng: number;
+};
+
+/**
+ * A street, identified by its Unique Street Reference Number (USRN).
+ */
+export type StreetRecord = {
+  /**
+   * Territory the street sits in, as an ISO 3166-1 alpha-2 code.
+   */
+  country: string;
+  /**
+   * County the street falls in.
+   */
+  county?: string | null | undefined;
+  /**
+   * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
+   */
+  dataset: StreetSource;
+  /**
+   * How the street is named: `name` first, then each further name the dataset records, such as the name in another language. Empty when no name is recorded or `name` was not requested.
+   */
+  descriptors: Array<StreetDescriptor>;
+  /**
+   * Distance from the query point to the street's centre in the dataset the search matched it in, in metres. Present on coordinate lookups. Under `open_then_ngd` that is the open data unless the open data has no street in the radius, so a street the NGD supplies whole because the open data holds no name for it is measured to its open data centre, and `distance` can differ from the distance to `location`.
+   */
+  distance?: number | undefined;
+  /**
+   * Local authority district the street falls in.
+   */
+  district?: string | null | undefined;
+  /**
+   * Stable identifier for the street, in the form `<country>-<scheme>:<value>`. Pass it as `starting_after` to fetch the page that follows this street.
+   */
+  id: string;
+  /**
+   * Locality the street sits in.
+   */
+  locality?: string | null | undefined;
+  /**
+   * Representative point for the street, at its centre.
+   */
+  location?: StreetRecordCoordinates | undefined;
+  /**
+   * Name of the street as the dataset that answered records it, with the dataset's own capitalisation. Names in other languages are in `descriptors`. Null when the dataset holds no name. Read `nameKind` before showing it as a street name.
+   */
+  name?: string | null | undefined;
+  /**
+   * How settled the open-data name is. 'confident' is a single name. 'ambiguous' means more than one open-data name competes for the street and `name` is one of them. 'absent' means the open data holds no name, so `name` is null.
+   */
+  nameConfidence?: StreetNameConfidence | undefined;
+  /**
+   * What `name` holds. 'name' is a street name. 'descriptor' is a description the naming authority records in place of a name, such as a road number or 'Access to ...', and is not a name the street is known by.
+   */
+  nameKind?: StreetNameKind | null | undefined;
+  /**
+   * Postcode district the street falls in, the outward part of its postcodes.
+   */
+  postcodeDistrict?: string | null | undefined;
+  /**
+   * The properties on the street, paged by `propertyOptions`.
+   */
+  properties?: StreetProperties | undefined;
+  /**
+   * Number of properties on the street. Present when `includeStatistics` is true.
+   */
+  propertyCount?: number | undefined;
+  /**
+   * Which dataset supplied each returned field. Present only when a street's fields came from more than one dataset.
+   */
+  provenance?: StreetProvenance | undefined;
+  /**
+   * Latitude where the street ends, in WGS84 decimal degrees. Present alongside `streetStartLat`.
+   */
+  streetEndLat?: number | undefined;
+  /**
+   * Longitude where the street ends, in WGS84 decimal degrees. Present alongside `streetStartLat`.
+   */
+  streetEndLng?: number | undefined;
+  /**
+   * Latitude where the street starts, in WGS84 decimal degrees. Present when the dataset that supplied the street records its start and end, which the NGD does and the open data does not.
+   */
+  streetStartLat?: number | undefined;
+  /**
+   * Longitude where the street starts, in WGS84 decimal degrees. Present alongside `streetStartLat`.
+   */
+  streetStartLng?: number | undefined;
+  /**
+   * Type of street as the naming authority records it.
+   */
+  streetType?: string | null | undefined;
+  /**
+   * Town or city the street sits in.
+   */
+  town?: string | null | undefined;
+  /**
+   * The Unique Street Reference Number (USRN).
+   */
+  usrn: number;
+};
+
+/** @internal */
+export const StreetRecordCoordinates$inboundSchema: z.ZodType<
+  StreetRecordCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function streetRecordCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<StreetRecordCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreetRecordCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreetRecordCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const StreetRecord$inboundSchema: z.ZodType<
+  StreetRecord,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  country: z.string(),
+  county: z.nullable(z.string()).optional(),
+  dataset: StreetSource$inboundSchema,
+  descriptors: z.array(StreetDescriptor$inboundSchema),
+  distance: z.number().optional(),
+  district: z.nullable(z.string()).optional(),
+  id: z.string(),
+  locality: z.nullable(z.string()).optional(),
+  location: z.lazy(() => StreetRecordCoordinates$inboundSchema).optional(),
+  name: z.nullable(z.string()).optional(),
+  nameConfidence: StreetNameConfidence$inboundSchema.optional(),
+  nameKind: z.nullable(StreetNameKind$inboundSchema).optional(),
+  postcodeDistrict: z.nullable(z.string()).optional(),
+  properties: StreetProperties$inboundSchema.optional(),
+  propertyCount: z.number().optional(),
+  provenance: StreetProvenance$inboundSchema.optional(),
+  streetEndLat: z.number().optional(),
+  streetEndLng: z.number().optional(),
+  streetStartLat: z.number().optional(),
+  streetStartLng: z.number().optional(),
+  streetType: z.nullable(z.string()).optional(),
+  town: z.nullable(z.string()).optional(),
+  usrn: z.number(),
+});
+
+export function streetRecordFromJSON(
+  jsonString: string,
+): SafeParseResult<StreetRecord, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreetRecord$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreetRecord' from JSON`,
+  );
+}

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

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
+ */
+export const StreetSource = {
+  Open: "open",
+  Ngd: "ngd",
+} as const;
+/**
+ * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
+ */
+export type StreetSource = OpenEnum<typeof StreetSource>;
+
+/** @internal */
+export const StreetSource$inboundSchema: z.ZodType<
+  StreetSource,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(StreetSource);

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

@@ -0,0 +1,60 @@
+/*
+ * 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";
+
+export const TitleAlertKind = {
+  LeaseTermEnded: "lease_term_ended",
+  DividedByFloor: "divided_by_floor",
+  ValueNotPrice: "value_not_price",
+  PriceCoversOtherTitles: "price_covers_other_titles",
+  LeasePremium: "lease_premium",
+  NominalPrice: "nominal_price",
+  PossessoryTitle: "possessory_title",
+  QualifiedTitle: "qualified_title",
+  GoodLeaseholdTitle: "good_leasehold_title",
+} as const;
+export type TitleAlertKind = OpenEnum<typeof TitleAlertKind>;
+
+export type TitleAlert = {
+  kind: TitleAlertKind;
+  /**
+   * Plain-English statement of the fact and why it matters.
+   */
+  message: string;
+  sourceEntryRef: string | null;
+};
+
+/** @internal */
+export const TitleAlertKind$inboundSchema: z.ZodType<
+  TitleAlertKind,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TitleAlertKind);
+
+/** @internal */
+export const TitleAlert$inboundSchema: z.ZodType<
+  TitleAlert,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  kind: TitleAlertKind$inboundSchema,
+  message: z.string(),
+  sourceEntryRef: z.nullable(z.string()),
+});
+
+export function titleAlertFromJSON(
+  jsonString: string,
+): SafeParseResult<TitleAlert, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitleAlert$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleAlert' from JSON`,
+  );
+}

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

@@ -12,12 +12,21 @@ import {
   RegisteredCharges,
   RegisteredCharges$inboundSchema,
 } from "./registeredcharges.js";
+import { TitleAlert, TitleAlert$inboundSchema } from "./titlealert.js";
 import { TitleCovenant, TitleCovenant$inboundSchema } from "./titlecovenant.js";
 import {
   TitleDocumentSummary,
   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,
@@ -62,6 +71,10 @@ export const Tenure = {
 export type Tenure = OpenEnum<typeof Tenure>;
 
 export type TitleExtractionPayload = {
+  /**
+   * Facts that no single entry states but a buyer must know: an ended lease term, a title divided by floor, a price that is a value, a premium or nominal, a class of title weaker than absolute. Empty when there are none.
+   */
+  alerts?: Array<TitleAlert> | undefined;
   /**
    * The class of title recorded in the register. `possessory` and `qualified` are material defects a lender will want to see. Null when the register does not state a class.
    */
@@ -71,6 +84,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 +95,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;
@@ -135,6 +159,7 @@ export const TitleExtractionPayload$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  alerts: z.array(TitleAlert$inboundSchema).optional(),
   classOfTitle: z.nullable(ClassOfTitle$inboundSchema).default(null),
   covenants: z.array(TitleCovenant$inboundSchema),
   currentOwnerDisplay: z.string(),
@@ -145,7 +170,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,78 @@
+/*
+ * 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";
+
+/**
+ * What the amount is. `price`: the price paid on a sale. `value`: a value stated where no price was paid (a gift, a transfer into joint names); never show it as a price. `lease_premium`: the premium paid on the grant of the lease, not a price on a later sale.
+ */
+export const Basis = {
+  Price: "price",
+  Value: "value",
+  LeasePremium: "lease_premium",
+} as const;
+/**
+ * What the amount is. `price`: the price paid on a sale. `value`: a value stated where no price was paid (a gift, a transfer into joint names); never show it as a price. `lease_premium`: the premium paid on the grant of the lease, not a price on a later sale.
+ */
+export type Basis = OpenEnum<typeof Basis>;
+
+/**
+ * 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;
+  /**
+   * What the amount is. `price`: the price paid on a sale. `value`: a value stated where no price was paid (a gift, a transfer into joint names); never show it as a price. `lease_premium`: the premium paid on the grant of the lease, not a price on a later sale.
+   */
+  basis: Basis;
+  /**
+   * 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 Basis$inboundSchema: z.ZodType<Basis, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Basis);
+
+/** @internal */
+export const TitlePricePaid$inboundSchema: z.ZodType<
+  TitlePricePaid,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amountPounds: z.number().int(),
+  basis: Basis$inboundSchema.default("price"),
+  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(),
 });