@vepler/sdk 6.61.4 → 7.1.0

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

@@ -322,6 +322,7 @@ export * from "./propertyattributeentry.js";
 export * from "./propertyattributegroup.js";
 export * from "./propertybyslugsrequest.js";
 export * from "./propertydataapi.js";
+export * from "./propertyfieldprovenance.js";
 export * from "./propertyfilterfield.js";
 export * from "./propertylistresponse.js";
 export * from "./propertylocationidareafilter.js";
@@ -335,6 +336,7 @@ export * from "./propertyquerycondition.js";
 export * from "./propertyquerygroup.js";
 export * from "./propertyqueryoperator.js";
 export * from "./propertyqueryrequest.js";
+export * from "./propertysourcevalue.js";
 export * from "./propertytags.js";
 export * from "./propertytierinfo.js";
 export * from "./propertyvalueimpact.js";
@@ -344,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";
@@ -411,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/propertyaddress.ts

@@ -25,6 +25,14 @@ export type PropertyAddressCountryCode = OpenEnum<
 >;
 
 export type PropertyAddress = {
+  /**
+   * The building's name: Royal Mail's where the address has one, otherwise Ordnance Survey's. `_provenance` names which it is and the date of that record. Absent when neither names the building, and on properties whose stored address predates the field.
+   */
+  buildingName?: string | undefined;
+  /**
+   * The building's number on its street, as text: Royal Mail's where the address has one, otherwise Ordnance Survey's. `_provenance` names which it is and the date of that record. Absent when the building has no number, and on properties whose stored address predates the field.
+   */
+  buildingNumber?: string | undefined;
   /**
    * The UK nation the address sits in, as a slug: `england`, `scotland`, `wales` or `northern-ireland`. Null when the nation could not be resolved.
    */
@@ -66,7 +74,7 @@ export type PropertyAddress = {
    */
   outcode?: string | undefined;
   /**
-   * Post town the address is delivered through.
+   * The settlement the street sits in (city, town, village, hamlet or parish), as Ordnance Survey names it. Despite the field name this is the geographic town, not the Royal Mail post town the address is delivered through, and the two can differ.
    */
   postTown?: string | undefined;
   /**
@@ -77,6 +85,10 @@ export type PropertyAddress = {
    * The postcode with the space removed. This is the form a postcode area filter matches against.
    */
   postcodeNoSpace?: string | undefined;
+  /**
+   * The street the address is on: the Royal Mail thoroughfare where the address has one, otherwise the Ordnance Survey street name. `_provenance` names which it is and the date of that record. Absent when neither names a street, and on properties whose stored address predates the field.
+   */
+  street?: string | undefined;
 };
 
 /** @internal */
@@ -92,6 +104,8 @@ export const PropertyAddress$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  buildingName: z.string().optional(),
+  buildingNumber: z.string().optional(),
   country: z.nullable(z.string()).optional(),
   countryCode: PropertyAddressCountryCode$inboundSchema.optional(),
   county: z.string().optional(),
@@ -105,6 +119,7 @@ export const PropertyAddress$inboundSchema: z.ZodType<
   post_town: z.string().optional(),
   postcode: z.string().optional(),
   postcodeNoSpace: z.string().optional(),
+  street: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "line_1": "line1",

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

@@ -31,6 +31,10 @@ import {
   PropertyAssessments,
   PropertyAssessments$inboundSchema,
 } from "./propertyassessments.js";
+import {
+  PropertyFieldProvenance,
+  PropertyFieldProvenance$inboundSchema,
+} from "./propertyfieldprovenance.js";
 import { PropertyTags, PropertyTags$inboundSchema } from "./propertytags.js";
 import {
   RefurbishmentData,
@@ -437,9 +441,9 @@ export type PropertyDataApiSpatial = {
 
 export type PropertyDataApi = {
   /**
-   * Where each claim-resolved value came from, keyed by the field it applies to. Request it through `attributes`; it is returned only to callers holding the source-data permission.
+   * Where each served value came from and the date of its evidence, keyed by the served field's dotted path, such as `address.street`, `classificationCode` or `roomDetails.beds`. Request it through `attributes`; it is returned only to callers holding the source-data permission.
    */
-  provenance?: { [k: string]: { [k: string]: any } } | undefined;
+  provenance?: { [k: string]: PropertyFieldProvenance } | undefined;
   address?: PropertyAddress | undefined;
   /**
    * Heritage and conservation designations assessed at this property's location. A product that is absent was not assessed.
@@ -924,7 +928,7 @@ export const PropertyDataApi$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _provenance: z.record(z.record(z.any())).optional(),
+  _provenance: z.record(PropertyFieldProvenance$inboundSchema).optional(),
   address: PropertyAddress$inboundSchema.optional(),
   assessments: PropertyAssessments$inboundSchema.optional(),
   build: BuildData$inboundSchema.optional(),

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

@@ -0,0 +1,196 @@
+/*
+ * 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 { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PropertySourceValue,
+  PropertySourceValue$inboundSchema,
+} from "./propertysourcevalue.js";
+
+export const ContributingSources = {
+  Paf: "paf",
+  Os: "os",
+  OsNgd: "os_ngd",
+  NgdAddresses: "ngd_addresses",
+  Epc: "epc",
+  Hmlr: "hmlr",
+  Voa: "voa",
+  Hmrc: "hmrc",
+  HistoricEngland: "historic_england",
+  Listing: "listing",
+  OpenData: "open_data",
+  Council: "council",
+  Claim: "claim",
+} as const;
+export type ContributingSources = OpenEnum<typeof ContributingSources>;
+
+/**
+ * How the winning value was chosen. `single_source` and `first_non_null` take the first source in priority order that had a value, `newest_evidence` takes the one with the most recent evidence date, `highest_confidence` the one with the highest confidence score, and `narrowest_range` the one giving the tightest year range.
+ */
+export const ResolutionRule = {
+  SingleSource: "single_source",
+  FirstNonNull: "first_non_null",
+  NewestEvidence: "newest_evidence",
+  HighestConfidence: "highest_confidence",
+  NarrowestRange: "narrowest_range",
+} as const;
+/**
+ * How the winning value was chosen. `single_source` and `first_non_null` take the first source in priority order that had a value, `newest_evidence` takes the one with the most recent evidence date, `highest_confidence` the one with the highest confidence score, and `narrowest_range` the one giving the tightest year range.
+ */
+export type ResolutionRule = OpenEnum<typeof ResolutionRule>;
+
+/**
+ * Data source whose value won under `resolutionRule`.
+ */
+export const PropertyFieldProvenanceSource = {
+  Paf: "paf",
+  Os: "os",
+  OsNgd: "os_ngd",
+  NgdAddresses: "ngd_addresses",
+  Epc: "epc",
+  Hmlr: "hmlr",
+  Voa: "voa",
+  Hmrc: "hmrc",
+  HistoricEngland: "historic_england",
+  Listing: "listing",
+  OpenData: "open_data",
+  Council: "council",
+  Claim: "claim",
+} as const;
+/**
+ * Data source whose value won under `resolutionRule`.
+ */
+export type PropertyFieldProvenanceSource = OpenEnum<
+  typeof PropertyFieldProvenanceSource
+>;
+
+/**
+ * What each contributing source reported, keyed by source. Only contributing sources appear.
+ */
+export type SourceValues = {
+  claim?: PropertySourceValue | undefined;
+  council?: PropertySourceValue | undefined;
+  epc?: PropertySourceValue | undefined;
+  historicEngland?: PropertySourceValue | undefined;
+  hmlr?: PropertySourceValue | undefined;
+  hmrc?: PropertySourceValue | undefined;
+  listing?: PropertySourceValue | undefined;
+  ngdAddresses?: PropertySourceValue | undefined;
+  openData?: PropertySourceValue | undefined;
+  os?: PropertySourceValue | undefined;
+  osNgd?: PropertySourceValue | undefined;
+  paf?: PropertySourceValue | undefined;
+  voa?: PropertySourceValue | undefined;
+};
+
+export type PropertyFieldProvenance = {
+  /**
+   * Every data source that had a value for this field, whether or not it won.
+   */
+  contributingSources?: Array<ContributingSources> | undefined;
+  /**
+   * How the winning value was chosen. `single_source` and `first_non_null` take the first source in priority order that had a value, `newest_evidence` takes the one with the most recent evidence date, `highest_confidence` the one with the highest confidence score, and `narrowest_range` the one giving the tightest year range.
+   */
+  resolutionRule?: ResolutionRule | undefined;
+  /**
+   * Data source whose value won under `resolutionRule`.
+   */
+  source?: PropertyFieldProvenanceSource | undefined;
+  /**
+   * What each contributing source reported, keyed by source. Only contributing sources appear.
+   */
+  sourceValues?: SourceValues | undefined;
+  /**
+   * The value that won, which is the one served at the field's path.
+   */
+  value?: any | undefined;
+};
+
+/** @internal */
+export const ContributingSources$inboundSchema: z.ZodType<
+  ContributingSources,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ContributingSources);
+
+/** @internal */
+export const ResolutionRule$inboundSchema: z.ZodType<
+  ResolutionRule,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ResolutionRule);
+
+/** @internal */
+export const PropertyFieldProvenanceSource$inboundSchema: z.ZodType<
+  PropertyFieldProvenanceSource,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyFieldProvenanceSource);
+
+/** @internal */
+export const SourceValues$inboundSchema: z.ZodType<
+  SourceValues,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  claim: PropertySourceValue$inboundSchema.optional(),
+  council: PropertySourceValue$inboundSchema.optional(),
+  epc: PropertySourceValue$inboundSchema.optional(),
+  historic_england: PropertySourceValue$inboundSchema.optional(),
+  hmlr: PropertySourceValue$inboundSchema.optional(),
+  hmrc: PropertySourceValue$inboundSchema.optional(),
+  listing: PropertySourceValue$inboundSchema.optional(),
+  ngd_addresses: PropertySourceValue$inboundSchema.optional(),
+  open_data: PropertySourceValue$inboundSchema.optional(),
+  os: PropertySourceValue$inboundSchema.optional(),
+  os_ngd: PropertySourceValue$inboundSchema.optional(),
+  paf: PropertySourceValue$inboundSchema.optional(),
+  voa: PropertySourceValue$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "historic_england": "historicEngland",
+    "ngd_addresses": "ngdAddresses",
+    "open_data": "openData",
+    "os_ngd": "osNgd",
+  });
+});
+
+export function sourceValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<SourceValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SourceValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SourceValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const PropertyFieldProvenance$inboundSchema: z.ZodType<
+  PropertyFieldProvenance,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  contributingSources: z.array(ContributingSources$inboundSchema).optional(),
+  resolutionRule: ResolutionRule$inboundSchema.optional(),
+  source: PropertyFieldProvenanceSource$inboundSchema.optional(),
+  sourceValues: z.lazy(() => SourceValues$inboundSchema).optional(),
+  value: z.any().optional(),
+});
+
+export function propertyFieldProvenanceFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyFieldProvenance, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyFieldProvenance$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyFieldProvenance' from JSON`,
+  );
+}

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

@@ -0,0 +1,54 @@
+/*
+ * 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 PropertySourceValue = {
+  /**
+   * How this source captured the value, in its own wording, for example `epc:survey` or `advert`.
+   */
+  captureMethod?: string | null | undefined;
+  /**
+   * How far this source's value is trusted, from 0 to 100, where higher is more trusted. The `highest_confidence` rule picks the winner on this number, and `narrowest_range` uses it to break ties.
+   */
+  confidence?: number | undefined;
+  /**
+   * Date of the evidence behind this value, as an ISO 8601 date, such as the date the address record it was read from was last updated or the date the advert stating it was published. Absent when the source gives no date.
+   */
+  evidenceDate?: string | null | undefined;
+  /**
+   * When the source last reported this value, as an ISO 8601 date.
+   */
+  updatedAt?: string | null | undefined;
+  /**
+   * The value this source reported for the field. Its type follows the field.
+   */
+  value?: any | undefined;
+};
+
+/** @internal */
+export const PropertySourceValue$inboundSchema: z.ZodType<
+  PropertySourceValue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  captureMethod: z.nullable(z.string()).optional(),
+  confidence: z.number().optional(),
+  evidenceDate: z.nullable(z.string()).optional(),
+  updatedAt: z.nullable(z.string()).optional(),
+  value: z.any().optional(),
+});
+
+export function propertySourceValueFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertySourceValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertySourceValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertySourceValue' from JSON`,
+  );
+}

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)),