@vepler/sdk 6.61.4 → 7.1.0

package/dist/esm/sdk/models/shared/siteplanningstats.d.ts

@@ -2,6 +2,7 @@ import * as z from "zod/v3";
 import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { SitePlanningApplicationLink } from "./siteplanningapplicationlink.js";
 export declare const SitePlanningStatsSources: {
     readonly SiteId: "siteId";
     readonly UprnLinks: "uprnLinks";
@@ -9,51 +10,55 @@ export declare const SitePlanningStatsSources: {
 };
 export type SitePlanningStatsSources = OpenEnum<typeof SitePlanningStatsSources>;
 /**
- * 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.
  */
 export type SitePlanningStats = {
     /**
-     * Identifiers of the planning applications linked to this site, most recently received first. Pass them to GET /v1/planning/{applicationIds} to fetch the applications. The list is cut at a fixed limit; truncated says when that happened. Absent on a site whose planning data has not been rebuilt since this field was introduced.
+     * The distinct application types across the applications counted in totalApplications and held in applications.
      */
-    applicationIds?: Array<string> | undefined;
+    applicationTypes?: Array<string> | undefined;
     /**
-     * The distinct application types found across the applications in applicationIds.
+     * The planning applications linked to this site, with how each was found and how its boundary sits against the title. Applications counted in totalApplications come first, then those in partOfLargerSchemeTotal, each group most recently received first. An application whose boundary only meets the title along a shared edge is left out unless it was also found another way. The list is cut at a fixed limit; truncated says when that happened. Absent on a site whose planning data has not been rebuilt since this field was introduced.
      */
-    applicationTypes?: Array<string> | undefined;
+    applications?: Array<SitePlanningApplicationLink> | undefined;
     /**
-     * How many of the applications in applicationIds were approved.
+     * How many of the applications counted in totalApplications and held in applications were approved.
      */
     approvals?: number | undefined;
     /**
-     * When the links were last read, as an ISO 8601 timestamp. Absent when applicationIds is absent.
+     * When the links were last read, as an ISO 8601 timestamp. Absent when applications is absent.
      */
     asOf?: string | undefined;
     /**
-     * When the most recent of those applications was received, as an ISO 8601 timestamp.
+     * When the most recent application counted in totalApplications was received, as an ISO 8601 timestamp.
      */
     latestApplicationDate?: string | undefined;
     /**
-     * Status of the most recent application, in the wording the local authority published.
+     * Status of the most recent application counted in totalApplications, in the wording the local authority published.
      */
     latestDecision?: string | undefined;
     /**
-     * How many of the applications in applicationIds are still awaiting a decision.
+     * Number of linked applications that cover the whole of this title as part of a larger scheme and were found only by their boundary ('title_within_application' in applications). They are not part of totalApplications or the other counts. Absent on a site whose planning data has not been rebuilt since this field was introduced.
+     */
+    partOfLargerSchemeTotal?: number | undefined;
+    /**
+     * How many of the applications counted in totalApplications and held in applications are still awaiting a decision.
      */
     pending?: number | undefined;
     /**
-     * How many of the applications in applicationIds were refused.
+     * How many of the applications counted in totalApplications and held in applications were refused.
      */
     refusals?: number | undefined;
     /**
-     * Which links were used to find the applications: 'siteId' for applications recorded against this site, 'uprnLinks' for applications on a property the title covers, and 'spatial' for applications whose boundary intersects the title boundary. 'spatial' is present only when the site has a boundary. Absent when applicationIds is absent.
+     * Which routes were searched for this site: 'siteId' for applications recorded against this site, 'uprnLinks' for applications on a property the title covers, and 'spatial' for applications whose boundary overlaps the title boundary. 'spatial' is present only when the site has a boundary. Absent when applications is absent.
      */
     sources?: Array<SitePlanningStatsSources> | undefined;
     /**
-     * Number of planning applications linked to this site across every source in sources. This is the full count even when applicationIds is truncated.
+     * Number of planning applications linked to this site: those recorded against the site or one of its properties, and those whose boundary lies inside the title or overlaps part of it. This is the full count even when applications is truncated. Applications that cover this title only as part of a larger scheme are counted in partOfLargerSchemeTotal instead.
      */
     totalApplications?: number | undefined;
     /**
-     * True when applicationIds holds fewer applications than totalApplications because the list was cut at its limit. Absent when applicationIds is absent.
+     * True when applications holds fewer entries than totalApplications and partOfLargerSchemeTotal together because the list was cut at its limit. Absent when applications is absent.
      */
     truncated?: boolean | undefined;
 };

package/dist/esm/sdk/models/shared/siteplanningstats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"siteplanningstats.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/siteplanningstats.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,eAAO,MAAM,wBAAwB;;;;CAI3B,CAAC;AACX,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAC7C,OAAO,wBAAwB,CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,GAAG,SAAS,CAAC;IACtD;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAC4C,CAAC;AAEtD,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,iBAAiB,EACjB,CAAC,CAAC,UAAU,EACZ,OAAO,CAaP,CAAC;AAEH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAMxD"}
+{"version":3,"file":"siteplanningstats.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/siteplanningstats.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,2BAA2B,EAE5B,MAAM,kCAAkC,CAAC;AAE1C,eAAO,MAAM,wBAAwB;;;;CAI3B,CAAC;AACX,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAC7C,OAAO,wBAAwB,CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,2BAA2B,CAAC,GAAG,SAAS,CAAC;IAC9D;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,GAAG,SAAS,CAAC;IACtD;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAC4C,CAAC;AAEtD,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,iBAAiB,EACjB,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAMxD"}

package/dist/esm/sdk/models/shared/siteplanningstats.js

@@ -4,6 +4,7 @@
 import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
 import * as openEnums from "../../types/enums.js";
+import { SitePlanningApplicationLink$inboundSchema, } from "./siteplanningapplicationlink.js";
 export const SitePlanningStatsSources = {
     SiteId: "siteId",
     UprnLinks: "uprnLinks",
@@ -13,12 +14,13 @@ export const SitePlanningStatsSources = {
 export const SitePlanningStatsSources$inboundSchema = openEnums.inboundSchema(SitePlanningStatsSources);
 /** @internal */
 export const SitePlanningStats$inboundSchema = z.object({
-    applicationIds: z.array(z.string()).optional(),
     applicationTypes: z.array(z.string()).optional(),
+    applications: z.array(SitePlanningApplicationLink$inboundSchema).optional(),
     approvals: z.number().optional(),
     asOf: z.string().optional(),
     latestApplicationDate: z.string().optional(),
     latestDecision: z.string().optional(),
+    partOfLargerSchemeTotal: z.number().optional(),
     pending: z.number().optional(),
     refusals: z.number().optional(),
     sources: z.array(SitePlanningStatsSources$inboundSchema).optional(),

package/dist/esm/sdk/models/shared/siteplanningstats.js.map

@@ -1 +1 @@
-{"version":3,"file":"siteplanningstats.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/siteplanningstats.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAKlD,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,SAAS;CACV,CAAC;AAuDX,gBAAgB;AAChB,MAAM,CAAC,MAAM,sCAAsC,GAI/C,SAAS,CAAC,aAAa,CAAC,wBAAwB,CAAC,CAAC;AAEtD,gBAAgB;AAChB,MAAM,CAAC,MAAM,+BAA+B,GAIxC,CAAC,CAAC,MAAM,CAAC;IACX,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC9C,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAChD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC,QAAQ,EAAE;IACnE,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC;AAEH,MAAM,UAAU,yBAAyB,CACvC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,+BAA+B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC3D,+CAA+C,CAChD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"siteplanningstats.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/siteplanningstats.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAIlD,OAAO,EAEL,yCAAyC,GAC1C,MAAM,kCAAkC,CAAC;AAE1C,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,OAAO,EAAE,SAAS;CACV,CAAC;AA2DX,gBAAgB;AAChB,MAAM,CAAC,MAAM,sCAAsC,GAI/C,SAAS,CAAC,aAAa,CAAC,wBAAwB,CAAC,CAAC;AAEtD,gBAAgB;AAChB,MAAM,CAAC,MAAM,+BAA+B,GAIxC,CAAC,CAAC,MAAM,CAAC;IACX,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAChD,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC,QAAQ,EAAE;IAC3E,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,uBAAuB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC,QAAQ,EAAE;IACnE,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC;AAEH,MAAM,UAAU,yBAAyB,CACvC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,+BAA+B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC3D,+CAA+C,CAChD,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vepler/sdk",
-  "version": "6.61.4",
+  "version": "7.1.0",
   "author": "Vepler Limited",
   "type": "module",
   "tshy": {

package/src/funcs/companiesGetCompaniesByLocation.ts

@@ -42,6 +42,7 @@ export function companiesGetCompaniesByLocation(
     shared.CompaniesByLocationResponse,
     | errors.GetCompaniesByLocationResponseBody
     | errors.GetCompaniesByLocationCompaniesResponseBody
+    | errors.GetCompaniesByLocationCompaniesResponseResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -69,6 +70,7 @@ async function $do(
       shared.CompaniesByLocationResponse,
       | errors.GetCompaniesByLocationResponseBody
       | errors.GetCompaniesByLocationCompaniesResponseBody
+      | errors.GetCompaniesByLocationCompaniesResponseResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -159,6 +161,7 @@ async function $do(
     shared.CompaniesByLocationResponse,
     | errors.GetCompaniesByLocationResponseBody
     | errors.GetCompaniesByLocationCompaniesResponseBody
+    | errors.GetCompaniesByLocationCompaniesResponseResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -174,6 +177,10 @@ async function $do(
       500,
       errors.GetCompaniesByLocationCompaniesResponseBody$inboundSchema,
     ),
+    M.jsonErr(
+      503,
+      errors.GetCompaniesByLocationCompaniesResponseResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesGetCompany.ts

@@ -31,7 +31,7 @@ import { Result } from "../sdk/types/fp.js";
  * Get company by registration number
  *
  * @remarks
- * Returns the full company record held on the Companies House register for one eight-character registration number, including its status, type, registered office and filing dates. Set includeOfficers=true or includePscs=true to add up to 50 active officer or PSC summaries.
+ * Returns the full company record held on the Companies House register for one eight-character registration number, including its status, type, registered office and filing dates. Set includeOfficers=true or includePscs=true to add up to 50 active officer or PSC summaries; while that data is not available the request returns 503 rather than leaving them out.
  */
 export function companiesGetCompany(
   client: SDKCore,
@@ -43,6 +43,7 @@ export function companiesGetCompany(
     | errors.GetCompanyResponseBody
     | errors.GetCompanyCompaniesResponseBody
     | errors.GetCompanyCompaniesResponseResponseBody
+    | errors.GetCompanyCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -71,6 +72,7 @@ async function $do(
       | errors.GetCompanyResponseBody
       | errors.GetCompanyCompaniesResponseBody
       | errors.GetCompanyCompaniesResponseResponseBody
+      | errors.GetCompanyCompaniesResponse503ResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -167,6 +169,7 @@ async function $do(
     | errors.GetCompanyResponseBody
     | errors.GetCompanyCompaniesResponseBody
     | errors.GetCompanyCompaniesResponseResponseBody
+    | errors.GetCompanyCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -183,6 +186,10 @@ async function $do(
       500,
       errors.GetCompanyCompaniesResponseResponseBody$inboundSchema,
     ),
+    M.jsonErr(
+      503,
+      errors.GetCompanyCompaniesResponse503ResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesGetCompanyOfficers.ts

@@ -42,6 +42,7 @@ export function companiesGetCompanyOfficers(
     shared.OfficerListResponse,
     | errors.GetCompanyOfficersResponseBody
     | errors.GetCompanyOfficersCompaniesResponseBody
+    | errors.GetCompanyOfficersCompaniesResponseResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -69,6 +70,7 @@ async function $do(
       shared.OfficerListResponse,
       | errors.GetCompanyOfficersResponseBody
       | errors.GetCompanyOfficersCompaniesResponseBody
+      | errors.GetCompanyOfficersCompaniesResponseResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -166,6 +168,7 @@ async function $do(
     shared.OfficerListResponse,
     | errors.GetCompanyOfficersResponseBody
     | errors.GetCompanyOfficersCompaniesResponseBody
+    | errors.GetCompanyOfficersCompaniesResponseResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -181,6 +184,10 @@ async function $do(
       500,
       errors.GetCompanyOfficersCompaniesResponseBody$inboundSchema,
     ),
+    M.jsonErr(
+      503,
+      errors.GetCompanyOfficersCompaniesResponseResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesGetCompanyPscs.ts

@@ -31,7 +31,7 @@ import { Result } from "../sdk/types/fp.js";
  * Get persons with significant control for a company
  *
  * @remarks
- * Returns the people and entities with significant control over a company, as defined by Part 21A of the Companies Act 2006, covering individuals, corporate entities and other legal persons. People whose identities are protected by court order are left out unless excludeSuperSecure is set to `false`.
+ * Returns the people and entities with significant control over a company, as defined by Part 21A of the Companies Act 2006, covering individuals, corporate entities and other legal persons. People whose identities are protected by court order are left out unless excludeSuperSecure is set to `false`. Companies known from PSC data alone are answered too, with companyInRegister false. Returns 503 while PSC data is not available.
  */
 export function companiesGetCompanyPscs(
   client: SDKCore,
@@ -42,6 +42,8 @@ export function companiesGetCompanyPscs(
     shared.PscListResponse,
     | errors.GetCompanyPscsResponseBody
     | errors.GetCompanyPscsCompaniesResponseBody
+    | errors.GetCompanyPscsCompaniesResponseResponseBody
+    | errors.GetCompanyPscsCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -69,6 +71,8 @@ async function $do(
       shared.PscListResponse,
       | errors.GetCompanyPscsResponseBody
       | errors.GetCompanyPscsCompaniesResponseBody
+      | errors.GetCompanyPscsCompaniesResponseResponseBody
+      | errors.GetCompanyPscsCompaniesResponse503ResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -167,6 +171,8 @@ async function $do(
     shared.PscListResponse,
     | errors.GetCompanyPscsResponseBody
     | errors.GetCompanyPscsCompaniesResponseBody
+    | errors.GetCompanyPscsCompaniesResponseResponseBody
+    | errors.GetCompanyPscsCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -178,7 +184,15 @@ async function $do(
   >(
     M.json(200, shared.PscListResponse$inboundSchema),
     M.jsonErr(400, errors.GetCompanyPscsResponseBody$inboundSchema),
-    M.jsonErr(500, errors.GetCompanyPscsCompaniesResponseBody$inboundSchema),
+    M.jsonErr(404, errors.GetCompanyPscsCompaniesResponseBody$inboundSchema),
+    M.jsonErr(
+      500,
+      errors.GetCompanyPscsCompaniesResponseResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      503,
+      errors.GetCompanyPscsCompaniesResponse503ResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesGetOfficer.ts

@@ -43,6 +43,7 @@ export function companiesGetOfficer(
     | errors.GetOfficerResponseBody
     | errors.GetOfficerCompaniesResponseBody
     | errors.GetOfficerCompaniesResponseResponseBody
+    | errors.GetOfficerCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -71,6 +72,7 @@ async function $do(
       | errors.GetOfficerResponseBody
       | errors.GetOfficerCompaniesResponseBody
       | errors.GetOfficerCompaniesResponseResponseBody
+      | errors.GetOfficerCompaniesResponse503ResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -161,6 +163,7 @@ async function $do(
     | errors.GetOfficerResponseBody
     | errors.GetOfficerCompaniesResponseBody
     | errors.GetOfficerCompaniesResponseResponseBody
+    | errors.GetOfficerCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -177,6 +180,10 @@ async function $do(
       500,
       errors.GetOfficerCompaniesResponseResponseBody$inboundSchema,
     ),
+    M.jsonErr(
+      503,
+      errors.GetOfficerCompaniesResponse503ResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesGetPerson.ts

@@ -43,6 +43,7 @@ export function companiesGetPerson(
     | errors.GetPersonResponseBody
     | errors.GetPersonCompaniesResponseBody
     | errors.GetPersonCompaniesResponseResponseBody
+    | errors.GetPersonCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -71,6 +72,7 @@ async function $do(
       | errors.GetPersonResponseBody
       | errors.GetPersonCompaniesResponseBody
       | errors.GetPersonCompaniesResponseResponseBody
+      | errors.GetPersonCompaniesResponse503ResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -161,6 +163,7 @@ async function $do(
     | errors.GetPersonResponseBody
     | errors.GetPersonCompaniesResponseBody
     | errors.GetPersonCompaniesResponseResponseBody
+    | errors.GetPersonCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -174,6 +177,10 @@ async function $do(
     M.jsonErr(400, errors.GetPersonResponseBody$inboundSchema),
     M.jsonErr(404, errors.GetPersonCompaniesResponseBody$inboundSchema),
     M.jsonErr(500, errors.GetPersonCompaniesResponseResponseBody$inboundSchema),
+    M.jsonErr(
+      503,
+      errors.GetPersonCompaniesResponse503ResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesGetPersonAppointments.ts

@@ -43,6 +43,7 @@ export function companiesGetPersonAppointments(
     | errors.GetPersonAppointmentsResponseBody
     | errors.GetPersonAppointmentsCompaniesResponseBody
     | errors.GetPersonAppointmentsCompaniesResponseResponseBody
+    | errors.GetPersonAppointmentsCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -71,6 +72,7 @@ async function $do(
       | errors.GetPersonAppointmentsResponseBody
       | errors.GetPersonAppointmentsCompaniesResponseBody
       | errors.GetPersonAppointmentsCompaniesResponseResponseBody
+      | errors.GetPersonAppointmentsCompaniesResponse503ResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -171,6 +173,7 @@ async function $do(
     | errors.GetPersonAppointmentsResponseBody
     | errors.GetPersonAppointmentsCompaniesResponseBody
     | errors.GetPersonAppointmentsCompaniesResponseResponseBody
+    | errors.GetPersonAppointmentsCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -190,6 +193,11 @@ async function $do(
       500,
       errors.GetPersonAppointmentsCompaniesResponseResponseBody$inboundSchema,
     ),
+    M.jsonErr(
+      503,
+      errors
+        .GetPersonAppointmentsCompaniesResponse503ResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesGetPersonCluster.ts

@@ -43,6 +43,7 @@ export function companiesGetPersonCluster(
     | errors.GetPersonClusterResponseBody
     | errors.GetPersonClusterCompaniesResponseBody
     | errors.GetPersonClusterCompaniesResponseResponseBody
+    | errors.GetPersonClusterCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -71,6 +72,7 @@ async function $do(
       | errors.GetPersonClusterResponseBody
       | errors.GetPersonClusterCompaniesResponseBody
       | errors.GetPersonClusterCompaniesResponseResponseBody
+      | errors.GetPersonClusterCompaniesResponse503ResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -163,6 +165,7 @@ async function $do(
     | errors.GetPersonClusterResponseBody
     | errors.GetPersonClusterCompaniesResponseBody
     | errors.GetPersonClusterCompaniesResponseResponseBody
+    | errors.GetPersonClusterCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -179,6 +182,10 @@ async function $do(
       500,
       errors.GetPersonClusterCompaniesResponseResponseBody$inboundSchema,
     ),
+    M.jsonErr(
+      503,
+      errors.GetPersonClusterCompaniesResponse503ResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesGetPsc.ts

@@ -43,6 +43,7 @@ export function companiesGetPsc(
     | errors.GetPscResponseBody
     | errors.GetPscCompaniesResponseBody
     | errors.GetPscCompaniesResponseResponseBody
+    | errors.GetPscCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -71,6 +72,7 @@ async function $do(
       | errors.GetPscResponseBody
       | errors.GetPscCompaniesResponseBody
       | errors.GetPscCompaniesResponseResponseBody
+      | errors.GetPscCompaniesResponse503ResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -161,6 +163,7 @@ async function $do(
     | errors.GetPscResponseBody
     | errors.GetPscCompaniesResponseBody
     | errors.GetPscCompaniesResponseResponseBody
+    | errors.GetPscCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -174,6 +177,7 @@ async function $do(
     M.jsonErr(400, errors.GetPscResponseBody$inboundSchema),
     M.jsonErr(404, errors.GetPscCompaniesResponseBody$inboundSchema),
     M.jsonErr(500, errors.GetPscCompaniesResponseResponseBody$inboundSchema),
+    M.jsonErr(503, errors.GetPscCompaniesResponse503ResponseBody$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesQueryCompanies.ts

@@ -30,17 +30,18 @@ import { Result } from "../sdk/types/fp.js";
  * Search companies with filters
  *
  * @remarks
- * Searches the company register by name, number, status, type, jurisdiction, SIC code, location, incorporation date and the charge and insolvency flags. Returns a page of company summaries with the total number of matches; limit accepts up to 100 results per page. Officers, PSCs and the registered office address are not part of a search result.
+ * Searches the company register by name, number, status, type, SIC code, location, incorporation date and the charges flag. Returns a page of company summaries with the total number of matches; limit accepts up to 100 results per page. Officers, PSCs and the registered office address are not part of a search result.
  */
 export function companiesQueryCompanies(
   client: SDKCore,
-  request?: shared.CompanyQueryRequest | undefined,
+  request: shared.CompanyQueryRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
     shared.CompanyListResponse,
     | errors.QueryCompaniesResponseBody
     | errors.QueryCompaniesCompaniesResponseBody
+    | errors.QueryCompaniesCompaniesResponseResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -60,7 +61,7 @@ export function companiesQueryCompanies(
 
 async function $do(
   client: SDKCore,
-  request?: shared.CompanyQueryRequest | undefined,
+  request: shared.CompanyQueryRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -68,6 +69,7 @@ async function $do(
       shared.CompanyListResponse,
       | errors.QueryCompaniesResponseBody
       | errors.QueryCompaniesCompaniesResponseBody
+      | errors.QueryCompaniesCompaniesResponseResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -82,17 +84,14 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      shared.CompanyQueryRequest$outboundSchema.optional().parse(value),
+    (value) => shared.CompanyQueryRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = payload === undefined
-    ? null
-    : encodeJSON("body", payload, { explode: true });
+  const body = encodeJSON("body", payload, { explode: true });
 
   const path = pathToFunc("/v1/companies/query")();
 
@@ -155,6 +154,7 @@ async function $do(
     shared.CompanyListResponse,
     | errors.QueryCompaniesResponseBody
     | errors.QueryCompaniesCompaniesResponseBody
+    | errors.QueryCompaniesCompaniesResponseResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -167,6 +167,10 @@ async function $do(
     M.json(200, shared.CompanyListResponse$inboundSchema),
     M.jsonErr(400, errors.QueryCompaniesResponseBody$inboundSchema),
     M.jsonErr(500, errors.QueryCompaniesCompaniesResponseBody$inboundSchema),
+    M.jsonErr(
+      503,
+      errors.QueryCompaniesCompaniesResponseResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesQueryPersons.ts

@@ -41,6 +41,7 @@ export function companiesQueryPersons(
     shared.PersonListResponse,
     | errors.QueryPersonsResponseBody
     | errors.QueryPersonsCompaniesResponseBody
+    | errors.QueryPersonsCompaniesResponseResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -68,6 +69,7 @@ async function $do(
       shared.PersonListResponse,
       | errors.QueryPersonsResponseBody
       | errors.QueryPersonsCompaniesResponseBody
+      | errors.QueryPersonsCompaniesResponseResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -154,6 +156,7 @@ async function $do(
     shared.PersonListResponse,
     | errors.QueryPersonsResponseBody
     | errors.QueryPersonsCompaniesResponseBody
+    | errors.QueryPersonsCompaniesResponseResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -166,6 +169,10 @@ async function $do(
     M.json(200, shared.PersonListResponse$inboundSchema),
     M.jsonErr(400, errors.QueryPersonsResponseBody$inboundSchema),
     M.jsonErr(500, errors.QueryPersonsCompaniesResponseBody$inboundSchema),
+    M.jsonErr(
+      503,
+      errors.QueryPersonsCompaniesResponseResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/lib/config.ts

@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "6.61.4",
+  openapiDocVersion: "7.1.0",
   sdkVersion: "0.12.0",
-  genVersion: "2.952.5",
-  userAgent: "speakeasy-sdk/typescript 0.12.0 2.952.5 6.61.4 @vepler/sdk",
+  genVersion: "2.954.8",
+  userAgent: "speakeasy-sdk/typescript 0.12.0 2.954.8 7.1.0 @vepler/sdk",
 } as const;

package/src/sdk/companies.ts

@@ -40,7 +40,7 @@ export class Companies extends ClientSDK {
    * Get company by registration number
    *
    * @remarks
-   * Returns the full company record held on the Companies House register for one eight-character registration number, including its status, type, registered office and filing dates. Set includeOfficers=true or includePscs=true to add up to 50 active officer or PSC summaries.
+   * Returns the full company record held on the Companies House register for one eight-character registration number, including its status, type, registered office and filing dates. Set includeOfficers=true or includePscs=true to add up to 50 active officer or PSC summaries; while that data is not available the request returns 503 rather than leaving them out.
    */
   async getCompany(
     request: operations.GetCompanyRequest,
@@ -74,7 +74,7 @@ export class Companies extends ClientSDK {
    * Get persons with significant control for a company
    *
    * @remarks
-   * Returns the people and entities with significant control over a company, as defined by Part 21A of the Companies Act 2006, covering individuals, corporate entities and other legal persons. People whose identities are protected by court order are left out unless excludeSuperSecure is set to `false`.
+   * Returns the people and entities with significant control over a company, as defined by Part 21A of the Companies Act 2006, covering individuals, corporate entities and other legal persons. People whose identities are protected by court order are left out unless excludeSuperSecure is set to `false`. Companies known from PSC data alone are answered too, with companyInRegister false. Returns 503 while PSC data is not available.
    */
   async getCompanyPscs(
     request: operations.GetCompanyPscsRequest,
@@ -176,10 +176,10 @@ export class Companies extends ClientSDK {
    * Search companies with filters
    *
    * @remarks
-   * Searches the company register by name, number, status, type, jurisdiction, SIC code, location, incorporation date and the charge and insolvency flags. Returns a page of company summaries with the total number of matches; limit accepts up to 100 results per page. Officers, PSCs and the registered office address are not part of a search result.
+   * Searches the company register by name, number, status, type, SIC code, location, incorporation date and the charges flag. Returns a page of company summaries with the total number of matches; limit accepts up to 100 results per page. Officers, PSCs and the registered office address are not part of a search result.
    */
   async queryCompanies(
-    request?: shared.CompanyQueryRequest | undefined,
+    request: shared.CompanyQueryRequest,
     options?: RequestOptions,
   ): Promise<shared.CompanyListResponse> {
     return unwrapAsync(companiesQueryCompanies(