@vepler/sdk 2.39.0 → 2.42.0

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

@@ -0,0 +1,147 @@
+/*
+ * 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 type MonthlyBreakdown = {
+  count: number;
+  month: string;
+};
+
+export type TopCategories = {
+  category: string;
+  count: number;
+  /**
+   * Percentage of total crimes
+   */
+  percentage: number;
+};
+
+/**
+ * Crime trend direction
+ */
+export const Trend = {
+  Increasing: "increasing",
+  Decreasing: "decreasing",
+  Stable: "stable",
+} as const;
+/**
+ * Crime trend direction
+ */
+export type Trend = OpenEnum<typeof Trend>;
+
+export type Data = {
+  /**
+   * Mean crimes per month
+   */
+  monthlyAverage: number;
+  monthlyBreakdown: Array<MonthlyBreakdown>;
+  /**
+   * Derived safety score (0-100, higher = safer)
+   */
+  safetyScore: number;
+  topCategories: Array<TopCategories>;
+  /**
+   * Total crimes across all months
+   */
+  totalCrimes: number;
+  /**
+   * Crime trend direction
+   */
+  trend: Trend;
+};
+
+export type AreaStatsResponse = {
+  data: Data;
+};
+
+/** @internal */
+export const MonthlyBreakdown$inboundSchema: z.ZodType<
+  MonthlyBreakdown,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number(),
+  month: z.string(),
+});
+
+export function monthlyBreakdownFromJSON(
+  jsonString: string,
+): SafeParseResult<MonthlyBreakdown, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MonthlyBreakdown$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MonthlyBreakdown' from JSON`,
+  );
+}
+
+/** @internal */
+export const TopCategories$inboundSchema: z.ZodType<
+  TopCategories,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  category: z.string(),
+  count: z.number(),
+  percentage: z.number(),
+});
+
+export function topCategoriesFromJSON(
+  jsonString: string,
+): SafeParseResult<TopCategories, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TopCategories$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TopCategories' from JSON`,
+  );
+}
+
+/** @internal */
+export const Trend$inboundSchema: z.ZodType<Trend, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Trend);
+
+/** @internal */
+export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
+  .object({
+    monthlyAverage: z.number(),
+    monthlyBreakdown: z.array(z.lazy(() => MonthlyBreakdown$inboundSchema)),
+    safetyScore: z.number(),
+    topCategories: z.array(z.lazy(() => TopCategories$inboundSchema)),
+    totalCrimes: z.number(),
+    trend: Trend$inboundSchema,
+  });
+
+export function dataFromJSON(
+  jsonString: string,
+): SafeParseResult<Data, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Data$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Data' from JSON`,
+  );
+}
+
+/** @internal */
+export const AreaStatsResponse$inboundSchema: z.ZodType<
+  AreaStatsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.lazy(() => Data$inboundSchema),
+});
+
+export function areaStatsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AreaStatsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AreaStatsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AreaStatsResponse' from JSON`,
+  );
+}

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

@@ -68,17 +68,19 @@ export type Change6Month = {
   percentage: number;
 };
 
-export const Trend = {
+export const AVMAnalysisResponseTrend = {
   Rising: "rising",
   Stable: "stable",
   Falling: "falling",
 } as const;
-export type Trend = OpenEnum<typeof Trend>;
+export type AVMAnalysisResponseTrend = OpenEnum<
+  typeof AVMAnalysisResponseTrend
+>;
 
 export type AVMAnalysisResponseSummary = {
   change12Month?: Change12Month | undefined;
   change6Month?: Change6Month | undefined;
-  trend: Trend;
+  trend: AVMAnalysisResponseTrend;
 };
 
 /**
@@ -322,8 +324,11 @@ export function change6MonthFromJSON(
 }
 
 /** @internal */
-export const Trend$inboundSchema: z.ZodType<Trend, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Trend);
+export const AVMAnalysisResponseTrend$inboundSchema: z.ZodType<
+  AVMAnalysisResponseTrend,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AVMAnalysisResponseTrend);
 
 /** @internal */
 export const AVMAnalysisResponseSummary$inboundSchema: z.ZodType<
@@ -333,7 +338,7 @@ export const AVMAnalysisResponseSummary$inboundSchema: z.ZodType<
 > = z.object({
   change12Month: z.lazy(() => Change12Month$inboundSchema).optional(),
   change6Month: z.lazy(() => Change6Month$inboundSchema).optional(),
-  trend: Trend$inboundSchema,
+  trend: AVMAnalysisResponseTrend$inboundSchema,
 });
 
 export function avmAnalysisResponseSummaryFromJSON(

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

@@ -0,0 +1,75 @@
+/*
+ * 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 { CrimeRecord, CrimeRecord$inboundSchema } from "./crimerecord.js";
+
+export type CrimeDataResponseSummary = {
+  /**
+   * Incident count per category
+   */
+  byCategory: { [k: string]: number };
+  /**
+   * Period queried (YYYY-MM)
+   */
+  period: string;
+  /**
+   * Search radius used (metres)
+   */
+  radius: number;
+  /**
+   * Total incidents returned
+   */
+  total: number;
+};
+
+export type CrimeDataResponse = {
+  data: Array<CrimeRecord>;
+  summary: CrimeDataResponseSummary;
+};
+
+/** @internal */
+export const CrimeDataResponseSummary$inboundSchema: z.ZodType<
+  CrimeDataResponseSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  byCategory: z.record(z.number()),
+  period: z.string(),
+  radius: z.number(),
+  total: z.number(),
+});
+
+export function crimeDataResponseSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<CrimeDataResponseSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CrimeDataResponseSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CrimeDataResponseSummary' from JSON`,
+  );
+}
+
+/** @internal */
+export const CrimeDataResponse$inboundSchema: z.ZodType<
+  CrimeDataResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(CrimeRecord$inboundSchema),
+  summary: z.lazy(() => CrimeDataResponseSummary$inboundSchema),
+});
+
+export function crimeDataResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CrimeDataResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CrimeDataResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CrimeDataResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,64 @@
+/*
+ * 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 CrimeRecord = {
+  /**
+   * Crime category
+   */
+  category: string;
+  /**
+   * ISO 8601 date/time of the crime
+   */
+  crimeDate: string;
+  /**
+   * Police-issued crime identifier
+   */
+  crimeId: string | null;
+  /**
+   * Textual location description
+   */
+  crimeLocation: string | null;
+  /**
+   * Database primary key
+   */
+  id: number;
+  /**
+   * Human-readable crime label
+   */
+  label: string | null;
+  /**
+   * Reporting police force
+   */
+  reportedBy: string | null;
+};
+
+/** @internal */
+export const CrimeRecord$inboundSchema: z.ZodType<
+  CrimeRecord,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  category: z.string(),
+  crimeDate: z.string(),
+  crimeId: z.nullable(z.string()),
+  crimeLocation: z.nullable(z.string()),
+  id: z.number(),
+  label: z.nullable(z.string()),
+  reportedBy: z.nullable(z.string()),
+});
+
+export function crimeRecordFromJSON(
+  jsonString: string,
+): SafeParseResult<CrimeRecord, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CrimeRecord$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CrimeRecord' from JSON`,
+  );
+}

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

@@ -8,6 +8,7 @@ export * from "./aggregationinput.js";
 export * from "./aggregationresult.js";
 export * from "./analysiscomparable.js";
 export * from "./appointmentsresponse.js";
+export * from "./areastatsresponse.js";
 export * from "./avmanalysisrequest.js";
 export * from "./avmanalysisresponse.js";
 export * from "./avmconfidenceinterval.js";
@@ -36,6 +37,8 @@ export * from "./councilmetadata.js";
 export * from "./councilserviceurls.js";
 export * from "./counciltaxbanddetails.js";
 export * from "./counciltaxdata.js";
+export * from "./crimedataresponse.js";
+export * from "./crimerecord.js";
 export * from "./dateofbirth.js";
 export * from "./epcdata.js";
 export * from "./extendedstatsaggregationresult.js";
@@ -126,11 +129,13 @@ export * from "./siteleafaggregation.js";
 export * from "./sitelistresponse.js";
 export * from "./sitemultipolygonareafilter.js";
 export * from "./sitenestedaggregation.js";
+export * from "./siteownership.js";
 export * from "./siteplanningstats.js";
 export * from "./sitepointareafilter.js";
 export * from "./sitepolygonareafilter.js";
 export * from "./sitepropertiesresponse.js";
 export * from "./sitepropertystats.js";
+export * from "./siteproprietor.js";
 export * from "./sitequerycondition.js";
 export * from "./sitequerygroup.js";
 export * from "./sitequeryoperator.js";
@@ -152,4 +157,6 @@ export * from "./tenancydata.js";
 export * from "./tenuredata.js";
 export * from "./termsaggregationresult.js";
 export * from "./termsbucket.js";
+export * from "./titledeeddocumentlistresponse.js";
+export * from "./titledeedpurchaseresponse.js";
 export * from "./uprnlookupresponse.js";

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

@@ -23,7 +23,7 @@ export type NearestPostcodesResponseCoordinates = {
   lng: number;
 };
 
-export type Data = {
+export type NearestPostcodesResponseData = {
   /**
    * WGS84 coordinate pair
    */
@@ -67,7 +67,7 @@ export type NearestPostcodesResponse = {
   /**
    * Nearby postcodes sorted by distance
    */
-  data: Array<Data>;
+  data: Array<NearestPostcodesResponseData>;
   hasMore: boolean;
   object: NearestPostcodesResponseObject;
   /**
@@ -114,27 +114,28 @@ export function nearestPostcodesResponseCoordinatesFromJSON(
 }
 
 /** @internal */
-export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
-  .object({
-    coordinates: z.lazy(() =>
-      NearestPostcodesResponseCoordinates$inboundSchema
-    ),
-    country: z.string().optional(),
-    distance_metres: z.number(),
-    postcode: z.string(),
-  }).transform((v) => {
-    return remap$(v, {
-      "distance_metres": "distanceMetres",
-    });
+export const NearestPostcodesResponseData$inboundSchema: z.ZodType<
+  NearestPostcodesResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  coordinates: z.lazy(() => NearestPostcodesResponseCoordinates$inboundSchema),
+  country: z.string().optional(),
+  distance_metres: z.number(),
+  postcode: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "distance_metres": "distanceMetres",
   });
+});
 
-export function dataFromJSON(
+export function nearestPostcodesResponseDataFromJSON(
   jsonString: string,
-): SafeParseResult<Data, SDKValidationError> {
+): SafeParseResult<NearestPostcodesResponseData, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Data$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Data' from JSON`,
+    (x) => NearestPostcodesResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NearestPostcodesResponseData' from JSON`,
   );
 }
 
@@ -169,7 +170,7 @@ export const NearestPostcodesResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  data: z.array(z.lazy(() => Data$inboundSchema)),
+  data: z.array(z.lazy(() => NearestPostcodesResponseData$inboundSchema)),
   has_more: z.boolean(),
   object: NearestPostcodesResponseObject$inboundSchema,
   radius: z.number(),

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,
@@ -143,6 +144,10 @@ 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.
    */
@@ -310,6 +315,7 @@ export const Site$inboundSchema: z.ZodType<Site, z.ZodTypeDef, unknown> = z
     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()).optional(),
     propertyStats: z.nullable(SitePropertyStats$inboundSchema),

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`,
+  );
+}