@vepler/sdk 2.164.0 → 3.0.0

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

@@ -0,0 +1,153 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  GeographicContext,
+  GeographicContext$inboundSchema,
+} from "./geographiccontext.js";
+
+/**
+ * WGS84 coordinates
+ */
+export type SearchRetrieveResponseCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+export const SearchRetrieveResponseObject = {
+  Address: "address",
+} as const;
+export type SearchRetrieveResponseObject = ClosedEnum<
+  typeof SearchRetrieveResponseObject
+>;
+
+export type SearchRetrieveResponse = {
+  /**
+   * AddressBase classification code
+   */
+  classificationCode?: string | undefined;
+  /**
+   * WGS84 coordinates
+   */
+  coordinates?: SearchRetrieveResponseCoordinates | undefined;
+  /**
+   * County
+   */
+  county: string;
+  /**
+   * Single-line formatted address
+   */
+  formatted: string;
+  /**
+   * Geographic context (when include=geography)
+   */
+  geography?: GeographicContext | undefined;
+  /**
+   * Primary address line
+   */
+  line1: string;
+  /**
+   * Secondary address line
+   */
+  line2: string;
+  /**
+   * Tertiary address line
+   */
+  line3: string;
+  object: SearchRetrieveResponseObject;
+  /**
+   * Post town
+   */
+  postTown: string;
+  /**
+   * Postcode
+   */
+  postcode: string;
+  /**
+   * Echoes the `search_id` this retrieve was recorded against when a valid session was supplied; null when the retrieve was a direct resolve.
+   */
+  searchId: string | null;
+  /**
+   * Unique Property Reference Number
+   */
+  uprn: string;
+};
+
+/** @internal */
+export const SearchRetrieveResponseCoordinates$inboundSchema: z.ZodType<
+  SearchRetrieveResponseCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function searchRetrieveResponseCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchRetrieveResponseCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchRetrieveResponseCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchRetrieveResponseCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchRetrieveResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchRetrieveResponseObject
+> = z.nativeEnum(SearchRetrieveResponseObject);
+
+/** @internal */
+export const SearchRetrieveResponse$inboundSchema: z.ZodType<
+  SearchRetrieveResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  classification_code: z.string().optional(),
+  coordinates: z.lazy(() => SearchRetrieveResponseCoordinates$inboundSchema)
+    .optional(),
+  county: z.string(),
+  formatted: z.string(),
+  geography: GeographicContext$inboundSchema.optional(),
+  line_1: z.string(),
+  line_2: z.string(),
+  line_3: z.string(),
+  object: SearchRetrieveResponseObject$inboundSchema,
+  post_town: z.string(),
+  postcode: z.string(),
+  search_id: z.nullable(z.string()),
+  uprn: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "classification_code": "classificationCode",
+    "line_1": "line1",
+    "line_2": "line2",
+    "line_3": "line3",
+    "post_town": "postTown",
+    "search_id": "searchId",
+  });
+});
+
+export function searchRetrieveResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchRetrieveResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchRetrieveResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchRetrieveResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,181 @@
+/*
+ * 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 {
+  GeocodePrecision,
+  GeocodePrecision$inboundSchema,
+} from "./geocodeprecision.js";
+
+/**
+ * Street extent
+ */
+export type BoundingBox = {
+  /**
+   * Eastern boundary (max longitude)
+   */
+  east: number;
+  /**
+   * Northern boundary (max latitude)
+   */
+  north: number;
+  /**
+   * Southern boundary (min latitude)
+   */
+  south: number;
+  /**
+   * Western boundary (min longitude)
+   */
+  west: number;
+};
+
+/**
+ * Representative point for the street (centre)
+ */
+export type StreetMatchCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+/**
+ * A named-street geocoding result, keyed on USRN
+ */
+export type StreetMatch = {
+  /**
+   * Administrative area
+   */
+  administrativeArea?: string | undefined;
+  /**
+   * Street extent
+   */
+  boundingBox?: BoundingBox | undefined;
+  /**
+   * Match confidence (0-100)
+   */
+  confidence: number;
+  /**
+   * ISO 3166-1 alpha-2 country code of the street
+   */
+  country: string;
+  /**
+   * Distance from the query point in metres, when a point was supplied
+   */
+  distance?: number | undefined;
+  /**
+   * Result granularity discriminator
+   */
+  granularity: "street";
+  /**
+   * Stable, provider-namespaced street identity in the form `<country>-<scheme>:<value>`, unique across countries. Key street results on this rather than on a national id (which differs per country — USRN in Great Britain, other schemes elsewhere).
+   */
+  id: string;
+  /**
+   * Locality within the town
+   */
+  locality?: string | undefined;
+  /**
+   * Representative point for the street (centre)
+   */
+  location: StreetMatchCoordinates;
+  /**
+   * Street name
+   */
+  name: string;
+  precision: GeocodePrecision;
+  /**
+   * Number of addressable properties on the street
+   */
+  propertyCount?: number | undefined;
+  /**
+   * Town / post town
+   */
+  town?: string | undefined;
+  /**
+   * Unique Street Reference Number — the statutory Great Britain street id (GB results only)
+   */
+  usrn?: number | undefined;
+};
+
+/** @internal */
+export const BoundingBox$inboundSchema: z.ZodType<
+  BoundingBox,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  east: z.number(),
+  north: z.number(),
+  south: z.number(),
+  west: z.number(),
+});
+
+export function boundingBoxFromJSON(
+  jsonString: string,
+): SafeParseResult<BoundingBox, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BoundingBox$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BoundingBox' from JSON`,
+  );
+}
+
+/** @internal */
+export const StreetMatchCoordinates$inboundSchema: z.ZodType<
+  StreetMatchCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function streetMatchCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<StreetMatchCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreetMatchCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreetMatchCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const StreetMatch$inboundSchema: z.ZodType<
+  StreetMatch,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  administrativeArea: z.string().optional(),
+  boundingBox: z.lazy(() => BoundingBox$inboundSchema).optional(),
+  confidence: z.number(),
+  country: z.string(),
+  distance: z.number().optional(),
+  granularity: z.literal("street"),
+  id: z.string(),
+  locality: z.string().optional(),
+  location: z.lazy(() => StreetMatchCoordinates$inboundSchema),
+  name: z.string(),
+  precision: GeocodePrecision$inboundSchema,
+  propertyCount: z.number().optional(),
+  town: z.string().optional(),
+  usrn: z.number().optional(),
+});
+
+export function streetMatchFromJSON(
+  jsonString: string,
+): SafeParseResult<StreetMatch, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreetMatch$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreetMatch' from JSON`,
+  );
+}

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

@@ -4,7 +4,10 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../../lib/primitives.js";
-import { safeParse } from "../../../lib/schemas.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
@@ -22,6 +25,7 @@ export type TermsBucket = {
    * Distinct value for this bucket
    */
   key: string | number | boolean;
+  additionalProperties?: { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -44,10 +48,14 @@ export const TermsBucket$inboundSchema: z.ZodType<
   TermsBucket,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  doc_count: z.number(),
-  key: z.union([z.string(), z.number(), z.boolean()]),
-}).transform((v) => {
+> = collectExtraKeys$(
+  z.object({
+    doc_count: z.number(),
+    key: z.union([z.string(), z.number(), z.boolean()]),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+).transform((v) => {
   return remap$(v, {
     "doc_count": "docCount",
   });

package/src/sdk/models/shared/{extractionrestriction.ts → titlecovenant.ts}

@@ -7,17 +7,26 @@ import { safeParse } from "../../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type ExtractionRestriction = {
+export type TitleCovenant = {
   date: string | null;
+  /**
+   * Legal text quoted verbatim from the register entry
+   */
   rawText: string;
   sourceEntryRef: string;
+  /**
+   * Short summary label
+   */
   title: string;
+  /**
+   * AI-authored plain-language explanation
+   */
   whyThisMatters: string;
 };
 
 /** @internal */
-export const ExtractionRestriction$inboundSchema: z.ZodType<
-  ExtractionRestriction,
+export const TitleCovenant$inboundSchema: z.ZodType<
+  TitleCovenant,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -28,12 +37,12 @@ export const ExtractionRestriction$inboundSchema: z.ZodType<
   whyThisMatters: z.string(),
 });
 
-export function extractionRestrictionFromJSON(
+export function titleCovenantFromJSON(
   jsonString: string,
-): SafeParseResult<ExtractionRestriction, SDKValidationError> {
+): SafeParseResult<TitleCovenant, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => ExtractionRestriction$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ExtractionRestriction' from JSON`,
+    (x) => TitleCovenant$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleCovenant' from JSON`,
   );
 }

package/src/sdk/models/shared/{extractiondocumentsummary.ts → titledocumentsummary.ts}

@@ -16,22 +16,22 @@ export const DocumentType = {
 } as const;
 export type DocumentType = OpenEnum<typeof DocumentType>;
 
-export const ExtractionDocumentSummaryStatus = {
+export const TitleDocumentSummaryStatus = {
   Pending: "pending",
   Uploaded: "uploaded",
   Failed: "failed",
 } as const;
-export type ExtractionDocumentSummaryStatus = OpenEnum<
-  typeof ExtractionDocumentSummaryStatus
+export type TitleDocumentSummaryStatus = OpenEnum<
+  typeof TitleDocumentSummaryStatus
 >;
 
-export type ExtractionDocumentSummary = {
+export type TitleDocumentSummary = {
   description: string;
   displayName: string;
   documentType: DocumentType;
   sizeBytes: number | null;
-  status: ExtractionDocumentSummaryStatus;
-  uploadedAt: string | null;
+  status: TitleDocumentSummaryStatus;
+  uploadedAt: Date | null;
 };
 
 /** @internal */
@@ -42,32 +42,34 @@ export const DocumentType$inboundSchema: z.ZodType<
 > = openEnums.inboundSchema(DocumentType);
 
 /** @internal */
-export const ExtractionDocumentSummaryStatus$inboundSchema: z.ZodType<
-  ExtractionDocumentSummaryStatus,
+export const TitleDocumentSummaryStatus$inboundSchema: z.ZodType<
+  TitleDocumentSummaryStatus,
   z.ZodTypeDef,
   unknown
-> = openEnums.inboundSchema(ExtractionDocumentSummaryStatus);
+> = openEnums.inboundSchema(TitleDocumentSummaryStatus);
 
 /** @internal */
-export const ExtractionDocumentSummary$inboundSchema: z.ZodType<
-  ExtractionDocumentSummary,
+export const TitleDocumentSummary$inboundSchema: z.ZodType<
+  TitleDocumentSummary,
   z.ZodTypeDef,
   unknown
 > = z.object({
   description: z.string(),
   displayName: z.string(),
   documentType: DocumentType$inboundSchema,
-  sizeBytes: z.nullable(z.number()),
-  status: ExtractionDocumentSummaryStatus$inboundSchema,
-  uploadedAt: z.nullable(z.string()),
+  sizeBytes: z.nullable(z.number().int()),
+  status: TitleDocumentSummaryStatus$inboundSchema,
+  uploadedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
 });
 
-export function extractionDocumentSummaryFromJSON(
+export function titleDocumentSummaryFromJSON(
   jsonString: string,
-): SafeParseResult<ExtractionDocumentSummary, SDKValidationError> {
+): SafeParseResult<TitleDocumentSummary, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => ExtractionDocumentSummary$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ExtractionDocumentSummary' from JSON`,
+    (x) => TitleDocumentSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleDocumentSummary' from JSON`,
   );
 }

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

@@ -0,0 +1,170 @@
+/*
+ * 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";
+import {
+  RegisteredCharges,
+  RegisteredCharges$inboundSchema,
+} from "./registeredcharges.js";
+import { TitleCovenant, TitleCovenant$inboundSchema } from "./titlecovenant.js";
+import {
+  TitleDocumentSummary,
+  TitleDocumentSummary$inboundSchema,
+} from "./titledocumentsummary.js";
+import { TitleNotice, TitleNotice$inboundSchema } from "./titlenotice.js";
+import {
+  TitleProprietor,
+  TitleProprietor$inboundSchema,
+} from "./titleproprietor.js";
+import {
+  TitleRestriction,
+  TitleRestriction$inboundSchema,
+} from "./titlerestriction.js";
+import {
+  TitleScheduleNoticeOfLease,
+  TitleScheduleNoticeOfLease$inboundSchema,
+} from "./titleschedulenoticeoflease.js";
+import {
+  TitleSummaryCounts,
+  TitleSummaryCounts$inboundSchema,
+} from "./titlesummarycounts.js";
+
+/**
+ * Class of title from the register (possessory/qualified = material defect). null when not stated.
+ */
+export const ClassOfTitle = {
+  Absolute: "absolute",
+  GoodLeasehold: "good_leasehold",
+  Possessory: "possessory",
+  Qualified: "qualified",
+  Other: "other",
+} as const;
+/**
+ * Class of title from the register (possessory/qualified = material defect). null when not stated.
+ */
+export type ClassOfTitle = OpenEnum<typeof ClassOfTitle>;
+
+export type Ownership = {
+  proprietors: Array<TitleProprietor>;
+};
+
+export const Tenure = {
+  Freehold: "freehold",
+  Leasehold: "leasehold",
+  Commonhold: "commonhold",
+} as const;
+export type Tenure = OpenEnum<typeof Tenure>;
+
+export type TitleExtractionPayload = {
+  /**
+   * Class of title from the register (possessory/qualified = material defect). null when not stated.
+   */
+  classOfTitle: ClassOfTitle | null;
+  covenants: Array<TitleCovenant>;
+  /**
+   * Display string for the current owner card on the summary page.
+   */
+  currentOwnerDisplay: string;
+  documents: Array<TitleDocumentSummary>;
+  extractedAt: Date;
+  /**
+   * 'Not applicable for freehold' or a human lease term summary.
+   */
+  leaseTermDescription: string;
+  notices: Array<TitleNotice>;
+  ownership: Ownership;
+  promptVersion: string;
+  /**
+   * Verbatim QUALIFICATION entry text on qualified titles; null otherwise.
+   */
+  qualification: string | null;
+  /**
+   * Edition date of the HMLR register at time of extract
+   */
+  registerAsOf: Date;
+  registeredCharges: RegisteredCharges;
+  restrictions: Array<TitleRestriction>;
+  /**
+   * Sub-leases noted against the title (schedule of notices of leases), verbatim.
+   */
+  scheduleOfNoticesOfLeases?: Array<TitleScheduleNoticeOfLease> | undefined;
+  summaryCounts: TitleSummaryCounts;
+  tenure: Tenure;
+  titleNumber: string;
+};
+
+/** @internal */
+export const ClassOfTitle$inboundSchema: z.ZodType<
+  ClassOfTitle,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ClassOfTitle);
+
+/** @internal */
+export const Ownership$inboundSchema: z.ZodType<
+  Ownership,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  proprietors: z.array(TitleProprietor$inboundSchema),
+});
+
+export function ownershipFromJSON(
+  jsonString: string,
+): SafeParseResult<Ownership, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Ownership$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Ownership' from JSON`,
+  );
+}
+
+/** @internal */
+export const Tenure$inboundSchema: z.ZodType<Tenure, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Tenure);
+
+/** @internal */
+export const TitleExtractionPayload$inboundSchema: z.ZodType<
+  TitleExtractionPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  classOfTitle: z.nullable(ClassOfTitle$inboundSchema).default(null),
+  covenants: z.array(TitleCovenant$inboundSchema),
+  currentOwnerDisplay: z.string(),
+  documents: z.array(TitleDocumentSummary$inboundSchema),
+  extractedAt: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  leaseTermDescription: z.string(),
+  notices: z.array(TitleNotice$inboundSchema),
+  ownership: z.lazy(() => Ownership$inboundSchema),
+  promptVersion: z.string(),
+  qualification: z.nullable(z.string()).default(null),
+  registerAsOf: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  registeredCharges: RegisteredCharges$inboundSchema,
+  restrictions: z.array(TitleRestriction$inboundSchema),
+  scheduleOfNoticesOfLeases: z.array(TitleScheduleNoticeOfLease$inboundSchema)
+    .optional(),
+  summaryCounts: TitleSummaryCounts$inboundSchema,
+  tenure: Tenure$inboundSchema,
+  titleNumber: z.string(),
+});
+
+export function titleExtractionPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<TitleExtractionPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitleExtractionPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleExtractionPayload' from JSON`,
+  );
+}

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

@@ -10,9 +10,9 @@ import { ClosedEnum, OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  ExtractionPayload,
-  ExtractionPayload$inboundSchema,
-} from "./extractionpayload.js";
+  TitleExtractionPayload,
+  TitleExtractionPayload$inboundSchema,
+} from "./titleextractionpayload.js";
 
 export const TitleExtractionPollResponseObject = {
   TitleExtraction: "title_extraction",
@@ -32,7 +32,7 @@ export type TitleExtractionPollResponseStatus = OpenEnum<
 >;
 
 export type TitleExtractionPollResponse = {
-  extraction: ExtractionPayload | null;
+  extraction: TitleExtractionPayload | null;
   failureCode: string | null;
   failureMessage: string | null;
   object: TitleExtractionPollResponseObject;
@@ -58,7 +58,7 @@ export const TitleExtractionPollResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  extraction: z.nullable(ExtractionPayload$inboundSchema),
+  extraction: z.nullable(TitleExtractionPayload$inboundSchema),
   failure_code: z.nullable(z.string()),
   failure_message: z.nullable(z.string()),
   object: TitleExtractionPollResponseObject$inboundSchema,