@vepler/sdk 6.66.0 → 7.1.2

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

@@ -7,11 +7,12 @@ 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 { RFCDate } from "../../types/rfcdate.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { SicCode, SicCode$inboundSchema } from "./siccode.js";
 
 /**
- * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`.
+ * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`. `not-in-latest-register` means the latest monthly release of the register, which lists live companies only, no longer lists the company; the status it last carried no longer applies, and notInLatestRegisterSince gives the release it first went missing from. Null when the register records no status for the company.
  */
 export const CompanySummaryCompanyStatus = {
   Active: "active",
@@ -26,16 +27,17 @@ export const CompanySummaryCompanyStatus = {
   Closed: "closed",
   Registered: "registered",
   Removed: "removed",
+  NotInLatestRegister: "not-in-latest-register",
 } as const;
 /**
- * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`.
+ * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`. `not-in-latest-register` means the latest monthly release of the register, which lists live companies only, no longer lists the company; the status it last carried no longer applies, and notInLatestRegisterSince gives the release it first went missing from. Null when the register records no status for the company.
  */
 export type CompanySummaryCompanyStatus = OpenEnum<
   typeof CompanySummaryCompanyStatus
 >;
 
 /**
- * The legal structure the entity is registered under. Most companies are `ltd` (private company limited by shares), `plc` (public limited company) or `llp` (limited liability partnership); the remaining values cover overseas entities, investment vehicles, charitable forms and older company types.
+ * The legal structure the entity is registered under. Most companies are `ltd` (private company limited by shares), `plc` (public limited company) or `llp` (limited liability partnership); the remaining values cover overseas entities, investment vehicles, charitable forms and older company types. Null when the register records no type for the company.
  */
 export const CompanySummaryCompanyType = {
   PrivateUnlimited: "private-unlimited",
@@ -82,32 +84,12 @@ export const CompanySummaryCompanyType = {
   RegisteredOverseasEntity: "registered-overseas-entity",
 } as const;
 /**
- * The legal structure the entity is registered under. Most companies are `ltd` (private company limited by shares), `plc` (public limited company) or `llp` (limited liability partnership); the remaining values cover overseas entities, investment vehicles, charitable forms and older company types.
+ * The legal structure the entity is registered under. Most companies are `ltd` (private company limited by shares), `plc` (public limited company) or `llp` (limited liability partnership); the remaining values cover overseas entities, investment vehicles, charitable forms and older company types. Null when the register records no type for the company.
  */
 export type CompanySummaryCompanyType = OpenEnum<
   typeof CompanySummaryCompanyType
 >;
 
-/**
- * The UK jurisdiction the company is registered in, which sets the legal framework that applies to it and the Companies House office that holds the record. Most companies are `england-wales`.
- */
-export const CompanySummaryJurisdiction = {
-  EnglandWales: "england-wales",
-  Wales: "wales",
-  Scotland: "scotland",
-  NorthernIreland: "northern-ireland",
-  EuropeanUnion: "european-union",
-  UnitedKingdom: "united-kingdom",
-  England: "england",
-  Noneu: "noneu",
-} as const;
-/**
- * The UK jurisdiction the company is registered in, which sets the legal framework that applies to it and the Companies House office that holds the record. Most companies are `england-wales`.
- */
-export type CompanySummaryJurisdiction = OpenEnum<
-  typeof CompanySummaryJurisdiction
->;
-
 /**
  * The company's registered office address. Not returned in list responses; fetch the company by its number to read it.
  */
@@ -167,33 +149,33 @@ export type CompanySummary = {
    */
   companyNumber: string;
   /**
-   * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`.
+   * Where the company stands on the Companies House register. `active` and `registered` are live, `dissolved` and `removed` have left the register, and `liquidation`, `receivership`, `administration`, `voluntary-arrangement` and `insolvency-proceedings` are stages of insolvency. Overseas entities use `open` and `closed` rather than `active` and `dissolved`. `not-in-latest-register` means the latest monthly release of the register, which lists live companies only, no longer lists the company; the status it last carried no longer applies, and notInLatestRegisterSince gives the release it first went missing from. Null when the register records no status for the company.
    */
-  companyStatus: CompanySummaryCompanyStatus;
+  companyStatus: CompanySummaryCompanyStatus | null;
   /**
-   * The legal structure the entity is registered under. Most companies are `ltd` (private company limited by shares), `plc` (public limited company) or `llp` (limited liability partnership); the remaining values cover overseas entities, investment vehicles, charitable forms and older company types.
+   * The legal structure the entity is registered under. Most companies are `ltd` (private company limited by shares), `plc` (public limited company) or `llp` (limited liability partnership); the remaining values cover overseas entities, investment vehicles, charitable forms and older company types. Null when the register records no type for the company.
    */
-  companyType: CompanySummaryCompanyType;
+  companyType: CompanySummaryCompanyType | null;
   /**
    * True when the company has charges registered against it.
    */
   hasCharges: boolean;
-  /**
-   * True when the register holds insolvency events for the company.
-   */
-  hasInsolvencyHistory: boolean;
   /**
    * When the company came into legal existence, as an ISO 8601 date.
    */
   incorporationDate?: Date | null | undefined;
-  /**
-   * The UK jurisdiction the company is registered in, which sets the legal framework that applies to it and the Companies House office that holds the record. Most companies are `england-wales`.
-   */
-  jurisdiction: CompanySummaryJurisdiction;
   /**
    * Identifier for a single addressable location. In Great Britain this is the Unique Property Reference Number (UPRN). Null when the registered office address could not be matched to one.
    */
   locationId?: string | null | undefined;
+  /**
+   * The release date of the first monthly release of the register that no longer listed the company, as an ISO 8601 date. The release lists live companies only, so this marks when the company stopped being listed; it is not a dissolution date. Null while the latest release lists the company, and companyStatus is `not-in-latest-register` whenever it is set.
+   */
+  notInLatestRegisterSince?: RFCDate | null | undefined;
+  /**
+   * The company's status exactly as Companies House published it in the latest monthly release of the register that listed the company, such as `Active - Proposal to Strike off`. It keeps detail that companyStatus groups together. Null when no published status is held for the company.
+   */
+  registerStatus?: string | null | undefined;
   /**
    * The company's registered office address. Not returned in list responses; fetch the company by its number to read it.
    */
@@ -221,13 +203,6 @@ export const CompanySummaryCompanyType$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(CompanySummaryCompanyType);
 
-/** @internal */
-export const CompanySummaryJurisdiction$inboundSchema: z.ZodType<
-  CompanySummaryJurisdiction,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(CompanySummaryJurisdiction);
-
 /** @internal */
 export const CompanySummaryRegisteredOfficeAddress$inboundSchema: z.ZodType<
   CompanySummaryRegisteredOfficeAddress,
@@ -265,15 +240,17 @@ export const CompanySummary$inboundSchema: z.ZodType<
 > = z.object({
   companyName: z.string(),
   companyNumber: z.string(),
-  companyStatus: CompanySummaryCompanyStatus$inboundSchema,
-  companyType: CompanySummaryCompanyType$inboundSchema,
+  companyStatus: z.nullable(CompanySummaryCompanyStatus$inboundSchema),
+  companyType: z.nullable(CompanySummaryCompanyType$inboundSchema),
   hasCharges: z.boolean(),
-  hasInsolvencyHistory: z.boolean(),
   incorporationDate: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),
-  jurisdiction: CompanySummaryJurisdiction$inboundSchema,
   locationId: z.nullable(z.string()).optional(),
+  notInLatestRegisterSince: z.nullable(
+    z.string().transform(v => new RFCDate(v)),
+  ).optional(),
+  registerStatus: z.nullable(z.string()).optional(),
   registeredOfficeAddress: z.nullable(
     z.lazy(() => CompanySummaryRegisteredOfficeAddress$inboundSchema),
   ).optional(),

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

@@ -346,8 +346,10 @@ export * from "./prosperityindicator.js";
 export * from "./prosperitylistresponse.js";
 export * from "./provenance.js";
 export * from "./psc.js";
+export * from "./pscexemption.js";
 export * from "./psclistresponse.js";
 export * from "./pscresponse.js";
+export * from "./pscstatement.js";
 export * from "./pscsummary.js";
 export * from "./purchasestatus.js";
 export * from "./rangedefinition.js";
@@ -413,6 +415,7 @@ export * from "./siteleafaggregation.js";
 export * from "./sitelistresponse.js";
 export * from "./sitemultipolygonareafilter.js";
 export * from "./sitenestedaggregation.js";
+export * from "./siteplanningapplicationlink.js";
 export * from "./siteplanningstats.js";
 export * from "./sitepointareafilter.js";
 export * from "./sitepolygonareafilter.js";

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

@@ -105,14 +105,18 @@ export type Psc = {
    * When this record first appeared in the API, as an ISO 8601 timestamp.
    */
   createdAt: Date;
+  /**
+   * What the record is, as Companies House describes it, for a PSC whose identity is protected by court order and so carries no name, for example `super-secure-persons-with-significant-control`. Null for every other PSC.
+   */
+  description: string | null;
   /**
    * Identifier for this PSC notification, as a UUID.
    */
   id: string;
   /**
-   * True when this PSC is subject to financial sanctions. UK sanctions are administered by the Office of Financial Sanctions Implementation (OFSI).
+   * True when this PSC is subject to financial sanctions. Companies House publishes this for the beneficial owners of overseas entities; null where it is not published.
    */
-  isSanctioned: boolean;
+  isSanctioned: boolean | null;
   /**
    * True when this PSC's identity is protected by a court order under s.790ZG of the Companies Act 2006, granted to individuals at serious risk of violence or intimidation. Personal details are withheld from the public register for these records.
    */
@@ -126,9 +130,9 @@ export type Psc = {
    */
   linkingKind?: string | null | undefined;
   /**
-   * The PSC's name as recorded on the notification. For an individual this includes the title; for a corporate entity it is the registered entity name.
+   * The PSC's name as recorded on the notification. For an individual this includes the title; for a corporate entity it is the registered entity name. Null for a PSC whose identity is protected by court order, which Companies House publishes without a name.
    */
-  name: string;
+  name: string | null;
   /**
    * The PSC's nationality. Set for individuals only.
    */
@@ -204,12 +208,13 @@ export const Psc$inboundSchema: z.ZodType<Psc, z.ZodTypeDef, unknown> = z
     createdAt: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ),
+    description: z.nullable(z.string()),
     id: z.string(),
-    isSanctioned: z.boolean(),
+    isSanctioned: z.nullable(z.boolean()),
     isSuperSecure: z.boolean(),
     kind: PscKind$inboundSchema,
     linkingKind: z.nullable(z.string()).optional(),
-    name: z.string(),
+    name: z.nullable(z.string()),
     nationality: z.nullable(z.string()).optional(),
     naturesOfControl: z.array(z.string()),
     notificationId: z.nullable(z.string()).optional(),

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

@@ -0,0 +1,70 @@
+/*
+ * 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 Items = {
+  /**
+   * When the exemption began, as YYYY-MM-DD.
+   */
+  exemptFrom: string;
+  /**
+   * When the exemption ended, as YYYY-MM-DD. Null while it applies.
+   */
+  exemptTo: string | null;
+};
+
+/**
+ * An exemption from the PSC register requirements that Companies House holds for the company.
+ */
+export type PscExemption = {
+  /**
+   * Why the company is exempt from keeping a PSC register, as the Companies House code, for example `psc-exempt-as-shares-admitted-on-market`.
+   */
+  exemptionType: string;
+  /**
+   * The periods the exemption covered, one entry each.
+   */
+  items: Array<Items>;
+};
+
+/** @internal */
+export const Items$inboundSchema: z.ZodType<Items, z.ZodTypeDef, unknown> = z
+  .object({
+    exemptFrom: z.string(),
+    exemptTo: z.nullable(z.string()),
+  });
+
+export function itemsFromJSON(
+  jsonString: string,
+): SafeParseResult<Items, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Items$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Items' from JSON`,
+  );
+}
+
+/** @internal */
+export const PscExemption$inboundSchema: z.ZodType<
+  PscExemption,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  exemptionType: z.string(),
+  items: z.array(z.lazy(() => Items$inboundSchema)),
+});
+
+export function pscExemptionFromJSON(
+  jsonString: string,
+): SafeParseResult<PscExemption, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PscExemption$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PscExemption' from JSON`,
+  );
+}

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

@@ -6,12 +6,22 @@ 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 { PscExemption, PscExemption$inboundSchema } from "./pscexemption.js";
+import { PscStatement, PscStatement$inboundSchema } from "./pscstatement.js";
 import { PscSummary, PscSummary$inboundSchema } from "./pscsummary.js";
 
 /**
- * A page of PSC notifications for one company, with the total number of matches.
+ * A page of PSC notifications for one company, with the total number of matches and the company's PSC statements and exemptions.
  */
 export type PscListResponse = {
+  /**
+   * True when the company is on the register of companies, so /companies/{companyNumber} returns its record. False when the company is known from PSC data only and has no company record here.
+   */
+  companyInRegister: boolean;
+  /**
+   * The company's exemptions from keeping a PSC register. Empty when it has none.
+   */
+  exemptions: Array<PscExemption>;
   /**
    * True when further results exist beyond this page.
    */
@@ -24,10 +34,18 @@ export type PscListResponse = {
    * The number of results skipped before this page.
    */
   offset: number;
+  /**
+   * The date of the Companies House PSC data this answer was read from, as YYYY-MM-DD. Changes made at Companies House after this date are not reflected.
+   */
+  pscDataAsOf: string;
   /**
    * The PSC notifications matching the filters, one summary each.
    */
   results: Array<PscSummary>;
+  /**
+   * The statements the company has filed about its PSC register, such as that it has no PSC. Only statements that still stand, unless activeOnly is set to `false`. When results is empty, a statement here says why.
+   */
+  statements: Array<PscStatement>;
   /**
    * Always true. A failed request returns an error object instead.
    */
@@ -44,10 +62,14 @@ export const PscListResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  companyInRegister: z.boolean(),
+  exemptions: z.array(PscExemption$inboundSchema),
   hasMore: z.boolean(),
   limit: z.number().int(),
   offset: z.number().int(),
+  pscDataAsOf: z.string(),
   results: z.array(PscSummary$inboundSchema),
+  statements: z.array(PscStatement$inboundSchema),
   success: z.literal(true),
   total: z.number().int(),
 });

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

@@ -12,6 +12,10 @@ import { Psc, Psc$inboundSchema } from "./psc.js";
  * One PSC notification.
  */
 export type PscResponse = {
+  /**
+   * The date of the Companies House PSC data this answer was read from, as YYYY-MM-DD. Changes made at Companies House after this date are not reflected.
+   */
+  pscDataAsOf: string;
   /**
    * The PSC notification.
    */
@@ -28,6 +32,7 @@ export const PscResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  pscDataAsOf: z.string(),
   result: Psc$inboundSchema,
   success: z.literal(true),
 });

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

@@ -0,0 +1,57 @@
+/*
+ * 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";
+
+/**
+ * A statement a company filed about its PSC register, for example that no individual or entity has significant control, or that a PSC exists but has not been identified.
+ */
+export type PscStatement = {
+  /**
+   * When the statement was withdrawn, as YYYY-MM-DD. Null while it stands.
+   */
+  ceasedOn: string | null;
+  /**
+   * The PSC the statement concerns, where it names one, such as a PSC who has not confirmed details.
+   */
+  linkedPscName: string | null;
+  /**
+   * When the statement was notified, as YYYY-MM-DD.
+   */
+  notifiedOn: string | null;
+  /**
+   * Why a restrictions notice the statement concerns was withdrawn, as the Companies House code.
+   */
+  restrictionsNoticeWithdrawalReason: string | null;
+  /**
+   * The statement as the Companies House statement code, for example `no-individual-or-entity-with-signficant-control` (the spelling is Companies House's own).
+   */
+  statement: string;
+};
+
+/** @internal */
+export const PscStatement$inboundSchema: z.ZodType<
+  PscStatement,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ceasedOn: z.nullable(z.string()),
+  linkedPscName: z.nullable(z.string()),
+  notifiedOn: z.nullable(z.string()),
+  restrictionsNoticeWithdrawalReason: z.nullable(z.string()),
+  statement: z.string(),
+});
+
+export function pscStatementFromJSON(
+  jsonString: string,
+): SafeParseResult<PscStatement, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PscStatement$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PscStatement' from JSON`,
+  );
+}

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

@@ -43,14 +43,18 @@ export type PscSummary = {
    * The eight-character registration number of the company this PSC has control over.
    */
   companyNumber: string;
+  /**
+   * What the record is, as Companies House describes it, for a PSC whose identity is protected by court order and so carries no name, for example `super-secure-persons-with-significant-control`. Null for every other PSC.
+   */
+  description: string | null;
   /**
    * Identifier for this PSC notification, as a UUID.
    */
   id: string;
   /**
-   * True when this PSC is subject to financial sanctions.
+   * True when this PSC is subject to financial sanctions. Companies House publishes this for the beneficial owners of overseas entities; null where it is not published.
    */
-  isSanctioned: boolean;
+  isSanctioned: boolean | null;
   /**
    * True when this PSC's identity is protected by a court order.
    */
@@ -60,9 +64,9 @@ export type PscSummary = {
    */
   kind: PscSummaryKind;
   /**
-   * The PSC's name as recorded on the notification.
+   * The PSC's name as recorded on the notification. Null for a PSC whose identity is protected by court order, which Companies House publishes without a name.
    */
-  name: string;
+  name: string | null;
   /**
    * How this PSC controls the company, one entry per type and threshold of control.
    */
@@ -94,11 +98,12 @@ export const PscSummary$inboundSchema: z.ZodType<
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),
   companyNumber: z.string(),
+  description: z.nullable(z.string()),
   id: z.string(),
-  isSanctioned: z.boolean(),
+  isSanctioned: z.nullable(z.boolean()),
   isSuperSecure: z.boolean(),
   kind: PscSummaryKind$inboundSchema,
-  name: z.string(),
+  name: z.nullable(z.string()),
   naturesOfControl: z.array(z.string()),
   notifiedOn: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),

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

@@ -361,7 +361,7 @@ export type Site = {
    */
   ownership?: Ownership | null | undefined;
   /**
-   * Statistics across the planning applications whose boundary intersects this site. Null when none intersect it.
+   * The planning applications linked to this site, with counts. Null when no application is linked.
    */
   planning?: SitePlanningStats | null | undefined;
   /**

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

@@ -0,0 +1,92 @@
+/*
+ * 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";
+
+/**
+ * How the application boundary sits against the title boundary: 'application_within_title' when the application lies inside the title, 'title_within_application' when the whole title lies inside the application, and 'partial' when the two overlap in part. Boundaries that only meet along a shared edge do not count as overlapping. Null when 'spatial' is not in routes.
+ */
+export const Relationship = {
+  ApplicationWithinTitle: "application_within_title",
+  TitleWithinApplication: "title_within_application",
+  Partial: "partial",
+} as const;
+/**
+ * How the application boundary sits against the title boundary: 'application_within_title' when the application lies inside the title, 'title_within_application' when the whole title lies inside the application, and 'partial' when the two overlap in part. Boundaries that only meet along a shared edge do not count as overlapping. Null when 'spatial' is not in routes.
+ */
+export type Relationship = OpenEnum<typeof Relationship>;
+
+export const Routes = {
+  SiteId: "siteId",
+  UprnLinks: "uprnLinks",
+  Spatial: "spatial",
+} as const;
+export type Routes = OpenEnum<typeof Routes>;
+
+export type SitePlanningApplicationLink = {
+  /**
+   * Land area inside the application boundary, in square metres to one decimal place. Null when the application has no boundary or its boundary does not lie in Great Britain.
+   */
+  applicationAreaSqm?: number | null | undefined;
+  /**
+   * Identifier of the planning application. Pass it to GET /v1/planning/{applicationIds} to fetch it.
+   */
+  id?: string | undefined;
+  /**
+   * Share of the application boundary's land area that falls on this title, as a percentage from 0 to 100 to one decimal place. Null when 'spatial' is not in routes.
+   */
+  overlapPctOfApplication?: number | null | undefined;
+  /**
+   * Share of the title's land area covered by the application boundary, as a percentage from 0 to 100 to one decimal place. Null when 'spatial' is not in routes.
+   */
+  overlapPctOfTitle?: number | null | undefined;
+  /**
+   * How the application boundary sits against the title boundary: 'application_within_title' when the application lies inside the title, 'title_within_application' when the whole title lies inside the application, and 'partial' when the two overlap in part. Boundaries that only meet along a shared edge do not count as overlapping. Null when 'spatial' is not in routes.
+   */
+  relationship?: Relationship | null | undefined;
+  /**
+   * Every way this application was found on the title: 'siteId' when the application is recorded against this site, 'uprnLinks' when the application's property is one the title covers, and 'spatial' when the application boundary overlaps the title boundary. An application found by more than one route lists each of them.
+   */
+  routes?: Array<Routes> | undefined;
+};
+
+/** @internal */
+export const Relationship$inboundSchema: z.ZodType<
+  Relationship,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Relationship);
+
+/** @internal */
+export const Routes$inboundSchema: z.ZodType<Routes, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Routes);
+
+/** @internal */
+export const SitePlanningApplicationLink$inboundSchema: z.ZodType<
+  SitePlanningApplicationLink,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  applicationAreaSqm: z.nullable(z.number()).optional(),
+  id: z.string().optional(),
+  overlapPctOfApplication: z.nullable(z.number()).optional(),
+  overlapPctOfTitle: z.nullable(z.number()).optional(),
+  relationship: z.nullable(Relationship$inboundSchema).optional(),
+  routes: z.array(Routes$inboundSchema).optional(),
+});
+
+export function sitePlanningApplicationLinkFromJSON(
+  jsonString: string,
+): SafeParseResult<SitePlanningApplicationLink, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SitePlanningApplicationLink$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SitePlanningApplicationLink' from JSON`,
+  );
+}