@vepler/sdk 2.38.2 → 2.42.0

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

@@ -12,6 +12,7 @@ import {
   SiteAreaMetrics,
   SiteAreaMetrics$inboundSchema,
 } from "./siteareametrics.js";
+import { SiteOwnership, SiteOwnership$inboundSchema } from "./siteownership.js";
 import {
   SitePlanningStats,
   SitePlanningStats$inboundSchema,
@@ -106,23 +107,23 @@ export type Site = {
   /**
    * Site boundary geometry in WGS84 (EPSG:4326). GeoJSON Polygon or MultiPolygon with coordinates in [longitude, latitude] order. Excluded from the default attribute set for performance — request explicitly via `attributes: ["boundary"]`.
    */
-  boundary: GeoJSONPolygon | GeoJSONMultiPolygon;
+  boundary?: GeoJSONPolygon | GeoJSONMultiPolygon | undefined;
   /**
    * WGS84 coordinate pair
    */
-  centroid: SiteCoordinates;
+  centroid?: SiteCoordinates | undefined;
   /**
-   * HM Land Registry class of title code. Determines title quality and tenure. Freehold codes: AF (Absolute Freehold), QF (Qualified Freehold), PF (Possessory Freehold), SF (Good Leasehold - Freehold). Leasehold codes: AL (Absolute Leasehold), GL (Good Leasehold), QL (Qualified Leasehold), PL (Possessory Leasehold), SL (Scheme Leasehold). Other codes: CF (Caution Freehold), CL (Caution Leasehold), AR, PR, QR (Rentcharge variants), CN (Caution).
+   * HM Land Registry class of title code. Determines title quality and tenure. Freehold codes: AF (Absolute Freehold), QF (Qualified Freehold), PF (Possessory Freehold), SF (Good Leasehold - Freehold). Leasehold codes: AL (Absolute Leasehold), GL (Good Leasehold), QL (Qualified Leasehold), PL (Possessory Leasehold), SL (Scheme Leasehold). Other codes: CF (Caution Freehold), CL (Caution Leasehold), AR, PR, QR (Rentcharge variants), CN (Caution). Not included in the default attribute set — request explicitly via `attributes: ["classTitleCode"]`.
    */
-  classTitleCode: string | null;
+  classTitleCode?: string | null | undefined;
   /**
    * ISO 3166-1 alpha-2 country code
    */
   country: string;
   /**
-   * HM Land Registry estate interest code. Almost always "EL" (Estate in Land). Does not indicate freehold/leasehold — use `classTitleCode` or `tenureType` instead.
+   * HM Land Registry estate interest code. Almost always "EL" (Estate in Land). Does not indicate freehold/leasehold — use `classTitleCode` or `tenureType` instead. Not included in the default attribute set — request explicitly via `attributes: ["estateInterestCode"]`.
    */
-  estateInterestCode: string | null;
+  estateInterestCode?: string | null | undefined;
   /**
    * Land use classifications derived from spatial analysis. Examples: residential, commercial, agricultural, mixed_use, industrial, vacant.
    */
@@ -132,9 +133,9 @@ export type Site = {
    */
   locationCount: number;
   /**
-   * UPRNs (Unique Property Reference Numbers) linked to this title via spatial intersection with the Ordnance Survey AddressBase dataset
+   * UPRNs (Unique Property Reference Numbers) linked to this title via spatial intersection with the Ordnance Survey AddressBase dataset. Not included in the default attribute set — request explicitly via `attributes: ["locationIds"]`.
    */
-  locationIds: Array<string>;
+  locationIds?: Array<string> | undefined;
   /**
    * Object type identifier
    */
@@ -143,14 +144,18 @@ export type Site = {
    * Spatial overlay keywords derived from area reference data intersecting the site boundary. Examples include flood risk zones, conservation areas, green belt, listed building curtilage, and other planning designations. Values are not from a fixed enum — they depend on available area reference datasets.
    */
   overlays: Array<string>;
+  /**
+   * Title ownership data from CCOD/OCOD/title deeds
+   */
+  ownership: SiteOwnership | null;
   /**
    * Planning application statistics from applications whose boundary intersects this site. Null when no planning applications intersect or when enrichment has not yet run.
    */
   planning: SitePlanningStats | null;
   /**
-   * Internal polygon identifiers from the source shapefile. Used for provenance tracking; not typically needed by API consumers.
+   * Internal polygon identifiers from the source shapefile. Used for provenance tracking; not typically needed by API consumers. Not included in the default attribute set — request explicitly via `attributes: ["polygonIds"]`.
    */
-  polygonIds: Array<number>;
+  polygonIds?: Array<number> | undefined;
   /**
    * Aggregated statistics for properties linked to this site. Null when no properties are linked (locationCount is 0) or when enrichment has not yet run.
    */
@@ -300,18 +305,19 @@ export const Site$inboundSchema: z.ZodType<Site, z.ZodTypeDef, unknown> = z
     boundary: z.union([
       z.lazy(() => GeoJSONPolygon$inboundSchema),
       z.lazy(() => GeoJSONMultiPolygon$inboundSchema),
-    ]),
-    centroid: z.lazy(() => SiteCoordinates$inboundSchema),
-    classTitleCode: z.nullable(z.string()),
+    ]).optional(),
+    centroid: z.lazy(() => SiteCoordinates$inboundSchema).optional(),
+    classTitleCode: z.nullable(z.string()).optional(),
     country: z.string(),
-    estateInterestCode: z.nullable(z.string()),
+    estateInterestCode: z.nullable(z.string()).optional(),
     landUse: z.array(z.string()),
     locationCount: z.number(),
-    locationIds: z.array(z.string()),
+    locationIds: z.array(z.string()).optional(),
     object: SiteObject$inboundSchema,
     overlays: z.array(z.string()),
+    ownership: z.nullable(SiteOwnership$inboundSchema),
     planning: z.nullable(SitePlanningStats$inboundSchema),
-    polygonIds: z.array(z.number()),
+    polygonIds: z.array(z.number()).optional(),
     propertyStats: z.nullable(SitePropertyStats$inboundSchema),
     registeredAt: z.nullable(z.string()),
     registry: z.string(),

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

@@ -58,6 +58,10 @@ export type SiteFilters = {
    * Filter by HM Land Registry class of title codes. Freehold: AF, QF, PF, SF. Leasehold: AL, GL, QL, PL, SL. Other: CF, CL, AR, PR, QR, CN.
    */
   classTitleCode?: Array<string> | undefined;
+  /**
+   * Filter by company registration number
+   */
+  companyNumber?: string | undefined;
   /**
    * Filter by ISO 3166-1 alpha-2 country code
    */
@@ -66,6 +70,14 @@ export type SiteFilters = {
    * Filter sites that intersect specific spatial overlays (e.g. flood zones, conservation areas)
    */
   overlays?: Array<string> | undefined;
+  /**
+   * Filter by owner name (partial match)
+   */
+  ownerName?: string | undefined;
+  /**
+   * Filter by ownership category: company, corporate, government, individual
+   */
+  ownershipCategory?: Array<string> | undefined;
   /**
    * Filter by site status. active: current titles. pending: awaiting registration. closed: no longer active.
    */
@@ -115,8 +127,11 @@ export type SiteFilters$Outbound = {
   areaSqmMax?: number | undefined;
   areaSqmMin?: number | undefined;
   classTitleCode?: Array<string> | undefined;
+  companyNumber?: string | undefined;
   country?: string | undefined;
   overlays?: Array<string> | undefined;
+  ownerName?: string | undefined;
+  ownershipCategory?: Array<string> | undefined;
   status?: Array<string> | undefined;
   tags?: Tags$Outbound | undefined;
   tenureType?: Array<string> | undefined;
@@ -131,8 +146,11 @@ export const SiteFilters$outboundSchema: z.ZodType<
   areaSqmMax: z.number().optional(),
   areaSqmMin: z.number().optional(),
   classTitleCode: z.array(z.string()).optional(),
+  companyNumber: z.string().optional(),
   country: z.string().optional(),
   overlays: z.array(z.string()).optional(),
+  ownerName: z.string().optional(),
+  ownershipCategory: z.array(z.string()).optional(),
   status: z.array(SiteFiltersStatus$outboundSchema).optional(),
   tags: z.lazy(() => Tags$outboundSchema).optional(),
   tenureType: z.array(z.string()).optional(),

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

@@ -0,0 +1,71 @@
+/*
+ * 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 {
+  SiteProprietor,
+  SiteProprietor$inboundSchema,
+} from "./siteproprietor.js";
+
+/**
+ * Title ownership data from CCOD/OCOD/title deeds
+ */
+export type SiteOwnership = {
+  /**
+   * Company registration number of the primary proprietor
+   */
+  companyNumber: string | null;
+  /**
+   * Date the primary proprietor was added
+   */
+  dateProprietorAdded: string | null;
+  /**
+   * Whether the title has multiple proprietors
+   */
+  isJointOwnership: boolean;
+  /**
+   * Primary ownership category: company, corporate, government, individual, unknown
+   */
+  ownershipCategory: string;
+  /**
+   * Display name of the primary proprietor
+   */
+  primaryOwnerName: string;
+  /**
+   * All current proprietors of this title
+   */
+  proprietors: Array<SiteProprietor>;
+  /**
+   * Data source: ccod, ocod, title_deed, manual
+   */
+  source: string;
+};
+
+/** @internal */
+export const SiteOwnership$inboundSchema: z.ZodType<
+  SiteOwnership,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  companyNumber: z.nullable(z.string()),
+  dateProprietorAdded: z.nullable(z.string()),
+  isJointOwnership: z.boolean(),
+  ownershipCategory: z.string(),
+  primaryOwnerName: z.string(),
+  proprietors: z.array(SiteProprietor$inboundSchema),
+  source: z.string(),
+});
+
+export function siteOwnershipFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteOwnership, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteOwnership$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteOwnership' from JSON`,
+  );
+}

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

@@ -0,0 +1,59 @@
+/*
+ * 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 SiteProprietor = {
+  /**
+   * Primary address of the proprietor
+   */
+  address: string | null;
+  /**
+   * Company registration number
+   */
+  companyNumber: string | null;
+  /**
+   * Country of incorporation for overseas companies
+   */
+  countryIncorporated: string | null;
+  /**
+   * Date the proprietor was added to the title
+   */
+  dateAdded: string | null;
+  /**
+   * Entity type classification
+   */
+  entityType: string;
+  /**
+   * Proprietor name as recorded
+   */
+  name: string;
+};
+
+/** @internal */
+export const SiteProprietor$inboundSchema: z.ZodType<
+  SiteProprietor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address: z.nullable(z.string()),
+  companyNumber: z.nullable(z.string()),
+  countryIncorporated: z.nullable(z.string()),
+  dateAdded: z.nullable(z.string()),
+  entityType: z.string(),
+  name: z.string(),
+});
+
+export function siteProprietorFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteProprietor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteProprietor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteProprietor' from JSON`,
+  );
+}

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

@@ -77,7 +77,6 @@ export const Field = {
   AreaMetricsProsperityDecile: "areaMetrics.prosperityDecile",
   RegisteredAt: "registeredAt",
   UpdatedAt: "updatedAt",
-  IndexedAt: "indexedAt",
 } as const;
 /**
  * Field to filter on. See the full field list in the schema documentation.

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

@@ -78,9 +78,6 @@ export const SiteQueryRequestField = {
   PlanningApprovals: "planning.approvals",
   RegisteredAt: "registeredAt",
   UpdatedAt: "updatedAt",
-  IndexedAt: "indexedAt",
-  Score: "_score",
-  Doc: "_doc",
 } as const;
 /**
  * Field to sort by

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

@@ -0,0 +1,155 @@
+/*
+ * 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 { ClosedEnum, OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * HMLR document type
+ */
+export const DocumentType = {
+  RegisterExtract: "register-extract",
+  OfficialTitle: "official-title",
+  TitlePlan: "title-plan",
+} as const;
+/**
+ * HMLR document type
+ */
+export type DocumentType = OpenEnum<typeof DocumentType>;
+
+/**
+ * Document processing status: pending (being processed), uploaded (ready to download), or failed
+ */
+export const TitleDeedDocumentListResponseStatus = {
+  Pending: "pending",
+  Uploaded: "uploaded",
+  Failed: "failed",
+} as const;
+/**
+ * Document processing status: pending (being processed), uploaded (ready to download), or failed
+ */
+export type TitleDeedDocumentListResponseStatus = OpenEnum<
+  typeof TitleDeedDocumentListResponseStatus
+>;
+
+export type Documents = {
+  /**
+   * MIME type of the document (e.g. application/pdf)
+   */
+  contentType: string;
+  /**
+   * HMLR document type
+   */
+  documentType: DocumentType;
+  /**
+   * Relative URL for downloading the document (null unless status is uploaded)
+   */
+  downloadUrl: string | null;
+  /**
+   * File size in bytes (null while pending or failed)
+   */
+  sizeBytes: number | null;
+  /**
+   * Document processing status: pending (being processed), uploaded (ready to download), or failed
+   */
+  status: TitleDeedDocumentListResponseStatus;
+  /**
+   * ISO 8601 timestamp when the document became available (null until uploaded)
+   */
+  uploadedAt: string | null;
+};
+
+export const TitleDeedDocumentListResponseObject = {
+  TitleDeedDocumentList: "title_deed_document_list",
+} as const;
+export type TitleDeedDocumentListResponseObject = ClosedEnum<
+  typeof TitleDeedDocumentListResponseObject
+>;
+
+export type TitleDeedDocumentListResponse = {
+  documents: Array<Documents>;
+  object: TitleDeedDocumentListResponseObject;
+  titleNumber: string;
+};
+
+/** @internal */
+export const DocumentType$inboundSchema: z.ZodType<
+  DocumentType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(DocumentType);
+
+/** @internal */
+export const TitleDeedDocumentListResponseStatus$inboundSchema: z.ZodType<
+  TitleDeedDocumentListResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TitleDeedDocumentListResponseStatus);
+
+/** @internal */
+export const Documents$inboundSchema: z.ZodType<
+  Documents,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  content_type: z.string(),
+  document_type: DocumentType$inboundSchema,
+  download_url: z.nullable(z.string()),
+  size_bytes: z.nullable(z.number()),
+  status: TitleDeedDocumentListResponseStatus$inboundSchema,
+  uploaded_at: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "content_type": "contentType",
+    "document_type": "documentType",
+    "download_url": "downloadUrl",
+    "size_bytes": "sizeBytes",
+    "uploaded_at": "uploadedAt",
+  });
+});
+
+export function documentsFromJSON(
+  jsonString: string,
+): SafeParseResult<Documents, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Documents$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Documents' from JSON`,
+  );
+}
+
+/** @internal */
+export const TitleDeedDocumentListResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof TitleDeedDocumentListResponseObject
+> = z.nativeEnum(TitleDeedDocumentListResponseObject);
+
+/** @internal */
+export const TitleDeedDocumentListResponse$inboundSchema: z.ZodType<
+  TitleDeedDocumentListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  documents: z.array(z.lazy(() => Documents$inboundSchema)),
+  object: TitleDeedDocumentListResponseObject$inboundSchema,
+  title_number: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "title_number": "titleNumber",
+  });
+});
+
+export function titleDeedDocumentListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TitleDeedDocumentListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitleDeedDocumentListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleDeedDocumentListResponse' from JSON`,
+  );
+}