@vepler/sdk 6.66.0 → 7.1.0

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

@@ -8,6 +8,10 @@ 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 {
+  SitePlanningApplicationLink,
+  SitePlanningApplicationLink$inboundSchema,
+} from "./siteplanningapplicationlink.js";
 
 export const SitePlanningStatsSources = {
   SiteId: "siteId",
@@ -19,51 +23,55 @@ export type SitePlanningStatsSources = OpenEnum<
 >;
 
 /**
- * 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;
 };
@@ -81,12 +89,13 @@ export const SitePlanningStats$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = 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(),