@vepler/sdk 2.46.0 → 2.57.3

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

@@ -8,6 +8,70 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { PersonSummary, PersonSummary$inboundSchema } from "./personsummary.js";
 
+/**
+ * Month and year of birth. Day is not disclosed for privacy.
+ */
+export type PersonClusterDateOfBirth = {
+  /**
+   * Birth month (1 = January, 12 = December).
+   */
+  month: number;
+  /**
+   * Birth year (4-digit).
+   */
+  year: number;
+};
+
+/**
+ * The canonical (primary) person record in this cluster. This is the authoritative representation of the individual. Null if no canonical record has been designated.
+ */
+export type CanonicalPerson = {
+  /**
+   * Number of currently active (non-resigned) officer appointments.
+   */
+  activeAppointments: number;
+  /**
+   * Entity resolution cluster identifier. Requires COMPANIES_HOUSE_PREMIUM.
+   */
+  clusterId?: string | null | undefined;
+  /**
+   * Country of usual residence.
+   */
+  countryOfResidence?: string | null | undefined;
+  /**
+   * Month and year of birth. Day is not disclosed for privacy.
+   */
+  dateOfBirth?: PersonClusterDateOfBirth | null | undefined;
+  /**
+   * First (given) name.
+   */
+  forename?: string | null | undefined;
+  /**
+   * Unique identifier for this person record (UUID v4).
+   */
+  id: string;
+  /**
+   * Whether this is the canonical (primary) record within its entity resolution cluster.
+   */
+  isCanonical: boolean;
+  /**
+   * Full name as recorded, typically uppercase.
+   */
+  name: string;
+  /**
+   * Nationality as declared.
+   */
+  nationality?: string | null | undefined;
+  /**
+   * Surname (family name).
+   */
+  surname?: string | null | undefined;
+  /**
+   * Total officer appointments (active and resigned) across all companies.
+   */
+  totalAppointments: number;
+};
+
 /**
  * The entity resolution cluster with all member records.
  */
@@ -15,7 +79,7 @@ export type PersonCluster = {
   /**
    * The canonical (primary) person record in this cluster. This is the authoritative representation of the individual. Null if no canonical record has been designated.
    */
-  canonicalPerson?: PersonSummary | null | undefined;
+  canonicalPerson?: CanonicalPerson | null | undefined;
   /**
    * Overall quality score for this cluster (0.0 to 1.0). Reflects the average pairwise match probability across all cluster members. Null if not yet computed.
    */
@@ -35,25 +99,76 @@ export type PersonCluster = {
   /**
    * All person records in this cluster, including the canonical record. Each member represents a separate record from Companies House that has been determined to belong to the same real-world individual.
    */
-  members: Array<PersonSummary | null>;
+  members: Array<PersonSummary>;
   /**
    * Total number of person records in this cluster.
    */
   totalRecords: number;
 };
 
+/** @internal */
+export const PersonClusterDateOfBirth$inboundSchema: z.ZodType<
+  PersonClusterDateOfBirth,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  month: z.number().int(),
+  year: z.number().int(),
+});
+
+export function personClusterDateOfBirthFromJSON(
+  jsonString: string,
+): SafeParseResult<PersonClusterDateOfBirth, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PersonClusterDateOfBirth$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonClusterDateOfBirth' from JSON`,
+  );
+}
+
+/** @internal */
+export const CanonicalPerson$inboundSchema: z.ZodType<
+  CanonicalPerson,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  activeAppointments: z.number().int(),
+  clusterId: z.nullable(z.string()).optional(),
+  countryOfResidence: z.nullable(z.string()).optional(),
+  dateOfBirth: z.nullable(z.lazy(() => PersonClusterDateOfBirth$inboundSchema))
+    .optional(),
+  forename: z.nullable(z.string()).optional(),
+  id: z.string(),
+  isCanonical: z.boolean(),
+  name: z.string(),
+  nationality: z.nullable(z.string()).optional(),
+  surname: z.nullable(z.string()).optional(),
+  totalAppointments: z.number().int(),
+});
+
+export function canonicalPersonFromJSON(
+  jsonString: string,
+): SafeParseResult<CanonicalPerson, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CanonicalPerson$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CanonicalPerson' from JSON`,
+  );
+}
+
 /** @internal */
 export const PersonCluster$inboundSchema: z.ZodType<
   PersonCluster,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  canonicalPerson: z.nullable(PersonSummary$inboundSchema).optional(),
+  canonicalPerson: z.nullable(z.lazy(() => CanonicalPerson$inboundSchema))
+    .optional(),
   clusterConfidence: z.nullable(z.number()).optional(),
   clusterId: z.string(),
   combinedActiveAppointments: z.number().int(),
   combinedAppointments: z.number().int(),
-  members: z.array(z.nullable(PersonSummary$inboundSchema)),
+  members: z.array(PersonSummary$inboundSchema),
   totalRecords: z.number().int(),
 });
 

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

@@ -27,7 +27,7 @@ export type PersonListResponse = {
   /**
    * Array of person summary records matching the search criteria.
    */
-  results: Array<PersonSummary | null>;
+  results: Array<PersonSummary>;
   /**
    * Indicates the request was successful.
    */
@@ -47,7 +47,7 @@ export const PersonListResponse$inboundSchema: z.ZodType<
   hasMore: z.boolean(),
   limit: z.number().int(),
   offset: z.number().int(),
-  results: z.array(z.nullable(PersonSummary$inboundSchema)),
+  results: z.array(PersonSummary$inboundSchema),
   success: z.literal(true),
   total: z.number().int(),
 });

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

@@ -6,10 +6,23 @@ 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 { DateOfBirth, DateOfBirth$inboundSchema } from "./dateofbirth.js";
 
 /**
- * The canonical (primary) person record in this cluster. This is the authoritative representation of the individual. Null if no canonical record has been designated.
+ * Month and year of birth. Day is not disclosed for privacy.
+ */
+export type PersonSummaryDateOfBirth = {
+  /**
+   * Birth month (1 = January, 12 = December).
+   */
+  month: number;
+  /**
+   * Birth year (4-digit).
+   */
+  year: number;
+};
+
+/**
+ * Lightweight person summary for list responses and nested inclusions.
  */
 export type PersonSummary = {
   /**
@@ -24,7 +37,10 @@ export type PersonSummary = {
    * Country of usual residence.
    */
   countryOfResidence?: string | null | undefined;
-  dateOfBirth?: DateOfBirth | null | undefined;
+  /**
+   * Month and year of birth. Day is not disclosed for privacy.
+   */
+  dateOfBirth?: PersonSummaryDateOfBirth | null | undefined;
   /**
    * First (given) name.
    */
@@ -55,6 +71,26 @@ export type PersonSummary = {
   totalAppointments: number;
 };
 
+/** @internal */
+export const PersonSummaryDateOfBirth$inboundSchema: z.ZodType<
+  PersonSummaryDateOfBirth,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  month: z.number().int(),
+  year: z.number().int(),
+});
+
+export function personSummaryDateOfBirthFromJSON(
+  jsonString: string,
+): SafeParseResult<PersonSummaryDateOfBirth, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PersonSummaryDateOfBirth$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonSummaryDateOfBirth' from JSON`,
+  );
+}
+
 /** @internal */
 export const PersonSummary$inboundSchema: z.ZodType<
   PersonSummary,
@@ -64,7 +100,8 @@ export const PersonSummary$inboundSchema: z.ZodType<
   activeAppointments: z.number().int(),
   clusterId: z.nullable(z.string()).optional(),
   countryOfResidence: z.nullable(z.string()).optional(),
-  dateOfBirth: z.nullable(DateOfBirth$inboundSchema).optional(),
+  dateOfBirth: z.nullable(z.lazy(() => PersonSummaryDateOfBirth$inboundSchema))
+    .optional(),
   forename: z.nullable(z.string()).optional(),
   id: z.string(),
   isCanonical: z.boolean(),

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

@@ -8,10 +8,11 @@ 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";
+import { PlanningAgent, PlanningAgent$inboundSchema } from "./planningagent.js";
 import {
-  PlanningAddress,
-  PlanningAddress$inboundSchema,
-} from "./planningaddress.js";
+  PlanningApplicant,
+  PlanningApplicant$inboundSchema,
+} from "./planningapplicant.js";
 import {
   PlanningConstraint,
   PlanningConstraint$inboundSchema,
@@ -20,10 +21,6 @@ import {
   PlanningDocument,
   PlanningDocument$inboundSchema,
 } from "./planningdocument.js";
-import {
-  PlanningPeople,
-  PlanningPeople$inboundSchema,
-} from "./planningpeople.js";
 import {
   PlanningRelatedCase,
   PlanningRelatedCase$inboundSchema,
@@ -33,6 +30,62 @@ import {
   PlanningStatusHistory$inboundSchema,
 } from "./planningstatushistory.js";
 
+/**
+ * Structured address of the application site, as scraped from the planning authority. Field availability varies by council — some provide full structured addresses whilst others provide only a raw string. Null if no address data was available.
+ */
+export type PlanningApplicationAddress = {
+  /**
+   * County.
+   */
+  county?: string | null | undefined;
+  /**
+   * Full formatted address as a single string, when available.
+   */
+  formattedAddress?: string | null | undefined;
+  /**
+   * First line of the site address.
+   */
+  line1?: string | null | undefined;
+  /**
+   * Second line of the site address.
+   */
+  line2?: string | null | undefined;
+  /**
+   * Third line of the site address.
+   */
+  line3?: string | null | undefined;
+  /**
+   * Fourth line of the site address.
+   */
+  line4?: string | null | undefined;
+  /**
+   * UK postcode.
+   */
+  postcode?: string | null | undefined;
+  /**
+   * Town or city.
+   */
+  town?: string | null | undefined;
+  /**
+   * Electoral ward in which the site is located.
+   */
+  ward?: string | null | undefined;
+};
+
+/**
+ * People associated with the application including applicants and planning agents. Contact details (phone, email) are redacted; only names and organisations are included. Null if no applicant or agent data was available.
+ */
+export type People = {
+  /**
+   * Planning agents or consultants acting on behalf of the applicant.
+   */
+  agents?: Array<PlanningAgent> | undefined;
+  /**
+   * People or organisations who submitted the application.
+   */
+  applicants?: Array<PlanningApplicant> | undefined;
+};
+
 /**
  * GeoJSON geometry type, always 'Point' for application site centroids.
  */
@@ -243,7 +296,7 @@ export type PlanningApplication = {
   /**
    * Structured address of the application site, as scraped from the planning authority. Field availability varies by council — some provide full structured addresses whilst others provide only a raw string. Null if no address data was available.
    */
-  address?: PlanningAddress | null | undefined;
+  address?: PlanningApplicationAddress | null | undefined;
   /**
    * The date on which an appeal was lodged with the Planning Inspectorate, formatted as an ISO 8601 datetime string. An appeal may be lodged when an application is refused or when the authority fails to determine the application within the statutory time limit. Null if no appeal has been lodged.
    */
@@ -303,7 +356,7 @@ export type PlanningApplication = {
   /**
    * People associated with the application including applicants and planning agents. Contact details (phone, email) are redacted; only names and organisations are included. Null if no applicant or agent data was available.
    */
-  people?: PlanningPeople | null | undefined;
+  people?: People | null | undefined;
   /**
    * Identifier for the local planning authority (LPA) or council that received the application. This is a normalised slug derived from the council name (e.g. 'lambeth', 'manchester', 'st-albans'). Use this value in the query endpoint's councils filter to retrieve all applications from a specific authority.
    */
@@ -366,6 +419,50 @@ export type PlanningApplication = {
   validatedDate?: string | null | undefined;
 };
 
+/** @internal */
+export const PlanningApplicationAddress$inboundSchema: z.ZodType<
+  PlanningApplicationAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  county: z.nullable(z.string()).optional(),
+  formattedAddress: z.nullable(z.string()).optional(),
+  line1: z.nullable(z.string()).optional(),
+  line2: z.nullable(z.string()).optional(),
+  line3: z.nullable(z.string()).optional(),
+  line4: z.nullable(z.string()).optional(),
+  postcode: z.nullable(z.string()).optional(),
+  town: z.nullable(z.string()).optional(),
+  ward: z.nullable(z.string()).optional(),
+});
+
+export function planningApplicationAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningApplicationAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningApplicationAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningApplicationAddress' from JSON`,
+  );
+}
+
+/** @internal */
+export const People$inboundSchema: z.ZodType<People, z.ZodTypeDef, unknown> = z
+  .object({
+    agents: z.array(PlanningAgent$inboundSchema).optional(),
+    applicants: z.array(PlanningApplicant$inboundSchema).optional(),
+  });
+
+export function peopleFromJSON(
+  jsonString: string,
+): SafeParseResult<People, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => People$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'People' from JSON`,
+  );
+}
+
 /** @internal */
 export const PlanningApplicationType$inboundSchema: z.ZodNativeEnum<
   typeof PlanningApplicationType
@@ -566,7 +663,8 @@ export const PlanningApplication$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  address: z.nullable(PlanningAddress$inboundSchema).optional(),
+  address: z.nullable(z.lazy(() => PlanningApplicationAddress$inboundSchema))
+    .optional(),
   appealedDate: z.nullable(z.string()).optional(),
   appealedStatus: z.nullable(z.string()).optional(),
   caseOfficer: z.nullable(z.string()).optional(),
@@ -581,7 +679,7 @@ export const PlanningApplication$inboundSchema: z.ZodType<
   expiryDate: z.nullable(z.string()).optional(),
   id: z.string(),
   key: z.string(),
-  people: z.nullable(PlanningPeople$inboundSchema).optional(),
+  people: z.nullable(z.lazy(() => People$inboundSchema)).optional(),
   provider: z.string(),
   receivedDate: z.nullable(z.string()).optional(),
   relatedCases: z.nullable(z.array(PlanningRelatedCase$inboundSchema))

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

@@ -9,7 +9,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * WGS84 coordinate pair
+ * WGS84 coordinates
  */
 export type PostcodeAddressCoordinates = {
   /**
@@ -31,7 +31,7 @@ export type PostcodeAddress = {
    */
   classificationCode?: string | undefined;
   /**
-   * WGS84 coordinate pair
+   * WGS84 coordinates
    */
   coordinates?: PostcodeAddressCoordinates | undefined;
   /**

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

@@ -19,7 +19,7 @@ export type Codes = {
 };
 
 /**
- * WGS84 coordinate pair
+ * Postcode centroid
  */
 export type PostcodeValidationResponseCoordinates = {
   /**
@@ -49,7 +49,7 @@ export type PostcodeValidationResponse = {
    */
   codes?: Codes | undefined;
   /**
-   * WGS84 coordinate pair
+   * Postcode centroid
    */
   coordinates?: PostcodeValidationResponseCoordinates | undefined;
   /**

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

@@ -9,18 +9,39 @@ import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Direction of price change
+ */
 export const PriceChangeDirection = {
   Up: "up",
   Down: "down",
   Initial: "initial",
 } as const;
+/**
+ * Direction of price change
+ */
 export type PriceChangeDirection = OpenEnum<typeof PriceChangeDirection>;
 
 export type PriceChange = {
+  /**
+   * Amount of change in pence
+   */
   amount?: number | null | undefined;
+  /**
+   * Date of price change
+   */
   date?: Date | null | undefined;
+  /**
+   * Direction of price change
+   */
   direction?: PriceChangeDirection | undefined;
+  /**
+   * Percentage change
+   */
   percent?: number | null | undefined;
+  /**
+   * New price after change in pence
+   */
   price?: number | null | undefined;
 };
 

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

@@ -8,10 +8,25 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PricingData = {
+  /**
+   * ISO currency code
+   */
   currency?: string | null | undefined;
+  /**
+   * Current rental price per month in pence
+   */
   currentRent?: number | null | undefined;
+  /**
+   * Current sale price in pence
+   */
   currentSale?: number | null | undefined;
+  /**
+   * Estimated rental value per month in pence
+   */
   estimatedRent?: number | null | undefined;
+  /**
+   * Estimated sale value in pence
+   */
   estimatedSale?: number | null | undefined;
 };
 

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

@@ -8,11 +8,14 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PropertyAddress = {
+  /**
+   * ISO country code
+   */
   country: string;
   /**
    * Formatted display address
    */
-  displayAddress?: string | undefined;
+  displayAddress: string;
   /**
    * Postcode incode
    */
@@ -21,6 +24,9 @@ export type PropertyAddress = {
    * Postcode outcode
    */
   outcode?: string | undefined;
+  /**
+   * UK postcode
+   */
   postcode?: string | undefined;
   /**
    * Postcode without spaces
@@ -35,7 +41,7 @@ export const PropertyAddress$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   country: z.string().default("GB"),
-  displayAddress: z.string().optional(),
+  displayAddress: z.string(),
   incode: z.string().optional(),
   outcode: z.string().optional(),
   postcode: z.string().optional(),