@vepler/sdk 2.46.0 → 2.50.3

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

@@ -25,7 +25,6 @@ export * from "./chargeentry.js";
 export * from "./chargehistory.js";
 export * from "./companiesbylocationresponse.js";
 export * from "./company.js";
-export * from "./companyaddress.js";
 export * from "./companylistresponse.js";
 export * from "./companyqueryrequest.js";
 export * from "./companyresponse.js";
@@ -40,7 +39,6 @@ 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";
 export * from "./geographiccontext.js";
@@ -70,14 +68,12 @@ export * from "./personlistresponse.js";
 export * from "./personqueryrequest.js";
 export * from "./personresponse.js";
 export * from "./personsummary.js";
-export * from "./planningaddress.js";
 export * from "./planningagent.js";
 export * from "./planningapplicant.js";
 export * from "./planningapplication.js";
 export * from "./planningconstraint.js";
 export * from "./planningdocument.js";
 export * from "./planninglistresponse.js";
-export * from "./planningpeople.js";
 export * from "./planningqueryfilters.js";
 export * from "./planningqueryrequest.js";
 export * from "./planningrelatedcase.js";

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

@@ -8,9 +8,21 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type Lease = {
+  /**
+   * Whether lease has alienation restrictions
+   */
   alienationClause?: boolean | undefined;
+  /**
+   * Date when lease was granted
+   */
   dateOfLease?: string | null | undefined;
+  /**
+   * Date when lease expires
+   */
   expiryDate?: string | null | undefined;
+  /**
+   * Type of lease
+   */
   leaseType?: string | null | undefined;
 };
 

package/src/sdk/models/shared/listing.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 * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
@@ -40,6 +43,7 @@ export type Features = {
   terrace?: boolean | undefined;
   topFloor?: boolean | undefined;
   unfurnished?: boolean | undefined;
+  additionalProperties?: { [k: string]: any | null } | undefined;
 };
 
 /**
@@ -159,29 +163,33 @@ export const Features$inboundSchema: z.ZodType<
   Features,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  alarm: z.boolean().optional(),
-  balcony: z.boolean().optional(),
-  cctv: z.boolean().optional(),
-  centralHeating: z.boolean().optional(),
-  chainFree: z.boolean().optional(),
-  conservatory: z.boolean().optional(),
-  doubleGlazing: z.boolean().optional(),
-  ensuite: z.boolean().optional(),
-  fireplace: z.boolean().optional(),
-  furnished: z.boolean().optional(),
-  garage: z.boolean().optional(),
-  garden: z.boolean().optional(),
-  groundFloor: z.boolean().optional(),
-  lift: z.boolean().optional(),
-  newBuild: z.boolean().optional(),
-  parking: z.boolean().optional(),
-  partFurnished: z.boolean().optional(),
-  patio: z.boolean().optional(),
-  terrace: z.boolean().optional(),
-  topFloor: z.boolean().optional(),
-  unfurnished: z.boolean().optional(),
-});
+> = collectExtraKeys$(
+  z.object({
+    alarm: z.boolean().optional(),
+    balcony: z.boolean().optional(),
+    cctv: z.boolean().optional(),
+    centralHeating: z.boolean().optional(),
+    chainFree: z.boolean().optional(),
+    conservatory: z.boolean().optional(),
+    doubleGlazing: z.boolean().optional(),
+    ensuite: z.boolean().optional(),
+    fireplace: z.boolean().optional(),
+    furnished: z.boolean().optional(),
+    garage: z.boolean().optional(),
+    garden: z.boolean().optional(),
+    groundFloor: z.boolean().optional(),
+    lift: z.boolean().optional(),
+    newBuild: z.boolean().optional(),
+    parking: z.boolean().optional(),
+    partFurnished: z.boolean().optional(),
+    patio: z.boolean().optional(),
+    terrace: z.boolean().optional(),
+    topFloor: z.boolean().optional(),
+    unfurnished: z.boolean().optional(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+);
 
 export function featuresFromJSON(
   jsonString: string,

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

@@ -57,12 +57,15 @@ export type MarketStatusSchemasStatus = OpenEnum<
 >;
 
 export type StatusTimeline = {
+  /**
+   * Period end date
+   */
   end?: Date | null | undefined;
   /**
    * Period start date
    */
-  start?: Date | undefined;
-  status?: MarketStatusSchemasStatus | undefined;
+  start: Date;
+  status: MarketStatusSchemasStatus;
 };
 
 export const MarketStatusType = {
@@ -73,35 +76,68 @@ export type MarketStatusType = OpenEnum<typeof MarketStatusType>;
 
 export type Timeline = {
   end?: Date | null | undefined;
-  start?: Date | undefined;
+  start: Date;
   status?: MarketStatusStatus | undefined;
   statusTimeline?: Array<StatusTimeline> | undefined;
-  type?: MarketStatusType | undefined;
+  type: MarketStatusType;
 };
 
 export type MarketStatus = {
+  /**
+   * Back on the market for sale
+   */
   backOTM?: boolean | null | undefined;
+  /**
+   * Back on the market for rent
+   */
   backOTMRent?: boolean | null | undefined;
   /**
    * Rental status
    */
-  forRent?: ForRent | undefined;
+  forRent: ForRent;
   /**
    * Sale status
    */
-  forSale?: ForSale | undefined;
+  forSale: ForSale;
+  /**
+   * Whether a live rental listing has had a price reduction
+   */
   hasPriceReductionRent?: boolean | null | undefined;
+  /**
+   * Whether a live sale listing has had a price reduction
+   */
   hasPriceReductionSale?: boolean | null | undefined;
+  /**
+   * Last date property was on the market for sale
+   */
   lastOTM?: Date | null | undefined;
+  /**
+   * Last date property was on the market for rent
+   */
   lastOTMRent?: Date | null | undefined;
+  /**
+   * Price per square foot
+   */
   pricePerSqft?: number | null | undefined;
+  /**
+   * Price per square metre
+   */
   pricePerSqm?: number | null | undefined;
+  /**
+   * Reserved date
+   */
   reservedDate?: Date | null | undefined;
+  /**
+   * Sold Subject To Contract date
+   */
   sstcDate?: Date | null | undefined;
   /**
    * Market timeline history
    */
-  timeline?: Array<Timeline> | undefined;
+  timeline: Array<Timeline>;
+  /**
+   * Under offer date
+   */
   underOfferDate?: Date | null | undefined;
 };
 
@@ -136,9 +172,8 @@ export const StatusTimeline$inboundSchema: z.ZodType<
   end: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),
-  start: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
-  status: MarketStatusSchemasStatus$inboundSchema.optional(),
+  start: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  status: MarketStatusSchemasStatus$inboundSchema,
 });
 
 export function statusTimelineFromJSON(
@@ -167,12 +202,11 @@ export const Timeline$inboundSchema: z.ZodType<
   end: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),
-  start: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
+  start: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   status: MarketStatusStatus$inboundSchema.optional(),
   statusTimeline: z.array(z.lazy(() => StatusTimeline$inboundSchema))
     .optional(),
-  type: MarketStatusType$inboundSchema.optional(),
+  type: MarketStatusType$inboundSchema,
 });
 
 export function timelineFromJSON(
@@ -193,8 +227,8 @@ export const MarketStatus$inboundSchema: z.ZodType<
 > = z.object({
   backOTM: z.nullable(z.boolean()).optional(),
   backOTMRent: z.nullable(z.boolean()).optional(),
-  forRent: ForRent$inboundSchema.optional(),
-  forSale: ForSale$inboundSchema.optional(),
+  forRent: ForRent$inboundSchema,
+  forSale: ForSale$inboundSchema,
   hasPriceReductionRent: z.nullable(z.boolean()).optional(),
   hasPriceReductionSale: z.nullable(z.boolean()).optional(),
   lastOTM: z.nullable(
@@ -211,7 +245,7 @@ export const MarketStatus$inboundSchema: z.ZodType<
   sstcDate: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),
-  timeline: z.array(z.lazy(() => Timeline$inboundSchema)).optional(),
+  timeline: z.array(z.lazy(() => Timeline$inboundSchema)),
   underOfferDate: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),

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

@@ -10,7 +10,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * WGS84 coordinate pair
+ * Centroid coordinates
  */
 export type NearestPostcodesResponseCoordinates = {
   /**
@@ -25,7 +25,7 @@ export type NearestPostcodesResponseCoordinates = {
 
 export type NearestPostcodesResponseData = {
   /**
-   * WGS84 coordinate pair
+   * Centroid coordinates
    */
   coordinates: NearestPostcodesResponseCoordinates;
   /**
@@ -50,7 +50,7 @@ export type NearestPostcodesResponseObject = ClosedEnum<
 >;
 
 /**
- * WGS84 coordinate pair
+ * Source postcode centroid
  */
 export type Coordinates = {
   /**
@@ -75,7 +75,7 @@ export type NearestPostcodesResponse = {
    */
   radius: number;
   /**
-   * WGS84 coordinate pair
+   * Source postcode centroid
    */
   sourceCoordinates: Coordinates;
   /**

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

@@ -8,10 +8,6 @@ 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 {
-  CompanyAddress,
-  CompanyAddress$inboundSchema,
-} from "./companyaddress.js";
 
 /**
  * The role held by this officer in the company. Common values: 'director', 'secretary', 'llp-member', 'llp-designated-member'. Corporate variants (prefixed with 'corporate-') indicate a body corporate acting as officer.
@@ -57,6 +53,52 @@ export const OfficerRole = {
  */
 export type OfficerRole = OpenEnum<typeof OfficerRole>;
 
+/**
+ * The officer's service address -- the publicly disclosed address for official correspondence. This replaces the residential address in public records (residential addresses are protected under s.240 of the Companies Act 2006).
+ */
+export type ServiceAddress = {
+  /**
+   * First line of the street address (e.g. 'Heene Road').
+   */
+  addressLine1?: string | null | undefined;
+  /**
+   * Second line of the address, if applicable (e.g. a district or area within a town).
+   */
+  addressLine2?: string | null | undefined;
+  /**
+   * 'Care of' (c/o) name, used when mail should be directed via a third party.
+   */
+  careOf?: string | null | undefined;
+  /**
+   * Country name as recorded by Companies House (e.g. 'United Kingdom', 'England').
+   */
+  country?: string | null | undefined;
+  /**
+   * Pre-formatted single-line address string combining all available components.
+   */
+  formattedAddress?: string | null | undefined;
+  /**
+   * Town or city name.
+   */
+  locality?: string | null | undefined;
+  /**
+   * PO Box number, if the address uses a PO Box.
+   */
+  poBox?: string | null | undefined;
+  /**
+   * UK postcode or international postal code.
+   */
+  postalCode?: string | null | undefined;
+  /**
+   * Building name or number (e.g. 'MGM House', '10').
+   */
+  premises?: string | null | undefined;
+  /**
+   * County, region, or administrative area.
+   */
+  region?: string | null | undefined;
+};
+
 /**
  * The full officer appointment record.
  */
@@ -125,7 +167,10 @@ export type Officer = {
    * Description of the officer's responsibilities. Primarily used for LLP designated members who have specific statutory duties beyond those of ordinary LLP members.
    */
   responsibilities?: string | null | undefined;
-  serviceAddress?: CompanyAddress | null | undefined;
+  /**
+   * The officer's service address -- the publicly disclosed address for official correspondence. This replaces the residential address in public records (residential addresses are protected under s.240 of the Companies Act 2006).
+   */
+  serviceAddress?: ServiceAddress | null | undefined;
   /**
    * Timestamp when this record was last updated in our database. ISO 8601 format.
    */
@@ -139,6 +184,34 @@ export const OfficerRole$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(OfficerRole);
 
+/** @internal */
+export const ServiceAddress$inboundSchema: z.ZodType<
+  ServiceAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  addressLine1: z.nullable(z.string()).optional(),
+  addressLine2: z.nullable(z.string()).optional(),
+  careOf: z.nullable(z.string()).optional(),
+  country: z.nullable(z.string()).optional(),
+  formattedAddress: z.nullable(z.string()).optional(),
+  locality: z.nullable(z.string()).optional(),
+  poBox: z.nullable(z.string()).optional(),
+  postalCode: z.nullable(z.string()).optional(),
+  premises: z.nullable(z.string()).optional(),
+  region: z.nullable(z.string()).optional(),
+});
+
+export function serviceAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<ServiceAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ServiceAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ServiceAddress' from JSON`,
+  );
+}
+
 /** @internal */
 export const Officer$inboundSchema: z.ZodType<Officer, z.ZodTypeDef, unknown> =
   z.object({
@@ -166,7 +239,8 @@ export const Officer$inboundSchema: z.ZodType<Officer, z.ZodTypeDef, unknown> =
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ).optional(),
     responsibilities: z.nullable(z.string()).optional(),
-    serviceAddress: z.nullable(CompanyAddress$inboundSchema).optional(),
+    serviceAddress: z.nullable(z.lazy(() => ServiceAddress$inboundSchema))
+      .optional(),
     updatedAt: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ),

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

@@ -10,7 +10,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * WGS84 coordinate pair
+ * Outcode centroid
  */
 export type OutcodeLookupResponseCoordinates = {
   /**
@@ -32,7 +32,7 @@ export type OutcodeLookupResponseObject = ClosedEnum<
 
 export type OutcodeLookupResponse = {
   /**
-   * WGS84 coordinate pair
+   * Outcode centroid
    */
   coordinates?: OutcodeLookupResponseCoordinates | undefined;
   /**

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

@@ -6,7 +6,20 @@ 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";
+
+/**
+ * Month and year of birth. Day of birth is not disclosed by Companies House for privacy. Null if not available (e.g. for very old records).
+ */
+export type DateOfBirth = {
+  /**
+   * Birth month (1 = January, 12 = December).
+   */
+  month: number;
+  /**
+   * Birth year (4-digit).
+   */
+  year: number;
+};
 
 /**
  * The full deduplicated person record.
@@ -74,6 +87,26 @@ export type Person = {
   updatedAt: Date;
 };
 
+/** @internal */
+export const DateOfBirth$inboundSchema: z.ZodType<
+  DateOfBirth,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  month: z.number().int(),
+  year: z.number().int(),
+});
+
+export function dateOfBirthFromJSON(
+  jsonString: string,
+): SafeParseResult<DateOfBirth, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DateOfBirth$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DateOfBirth' from JSON`,
+  );
+}
+
 /** @internal */
 export const Person$inboundSchema: z.ZodType<Person, z.ZodTypeDef, unknown> = z
   .object({
@@ -83,7 +116,7 @@ export const Person$inboundSchema: z.ZodType<Person, z.ZodTypeDef, unknown> = z
     createdAt: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ),
-    dateOfBirth: z.nullable(DateOfBirth$inboundSchema).optional(),
+    dateOfBirth: z.nullable(z.lazy(() => DateOfBirth$inboundSchema)).optional(),
     forename: z.nullable(z.string()).optional(),
     id: z.string(),
     isCanonical: z.boolean(),

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