@vepler/sdk 2.131.2 → 2.137.0

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

@@ -17,14 +17,38 @@ import {
   PlanningConstraint,
   PlanningConstraint$inboundSchema,
 } from "./planningconstraint.js";
+import {
+  PlanningConsulteeResponsesExtractionEnvelope,
+  PlanningConsulteeResponsesExtractionEnvelope$inboundSchema,
+} from "./planningconsulteeresponsesextractionenvelope.js";
+import {
+  PlanningDecisionExtractionEnvelope,
+  PlanningDecisionExtractionEnvelope$inboundSchema,
+} from "./planningdecisionextractionenvelope.js";
+import {
+  PlanningDevelopmentExtractionEnvelope,
+  PlanningDevelopmentExtractionEnvelope$inboundSchema,
+} from "./planningdevelopmentextractionenvelope.js";
 import {
   PlanningDocument,
   PlanningDocument$inboundSchema,
 } from "./planningdocument.js";
+import {
+  PlanningExtractionCoverage,
+  PlanningExtractionCoverage$inboundSchema,
+} from "./planningextractioncoverage.js";
+import {
+  PlanningOfficerAssessmentExtractionEnvelope,
+  PlanningOfficerAssessmentExtractionEnvelope$inboundSchema,
+} from "./planningofficerassessmentextractionenvelope.js";
 import {
   PlanningRelatedCase,
   PlanningRelatedCase$inboundSchema,
 } from "./planningrelatedcase.js";
+import {
+  PlanningS106ExtractionEnvelope,
+  PlanningS106ExtractionEnvelope$inboundSchema,
+} from "./plannings106extractionenvelope.js";
 import {
   PlanningStatusHistory,
   PlanningStatusHistory$inboundSchema,
@@ -72,6 +96,33 @@ export type PlanningApplicationAddress = {
   ward?: string | null | undefined;
 };
 
+/**
+ * Structured, citation-backed data extracted from the application's documents — decision outcome and refusal reasons, development specifics, section 106 obligations, the officer's assessment, and consultee responses. Only present when 'extractions' is requested via the include parameter (GET) or the include array (POST /query); omitted entirely otherwise. Each sub-extraction may itself be null when that schema has not been extracted for this application. Coverage and per-extraction verification status are reported so consumers can degrade honestly when data is partial or unverified.
+ */
+export type Extractions = {
+  /**
+   * Statutory consultee positions and the public-representations breakdown. Null when not available.
+   */
+  consulteeResponses: PlanningConsulteeResponsesExtractionEnvelope | null;
+  coverage: PlanningExtractionCoverage;
+  /**
+   * Decision outcome, conditions, and refusal reasons from the decision notice. Null when not available.
+   */
+  decision: PlanningDecisionExtractionEnvelope | null;
+  /**
+   * What is being built or changed — type, units, storeys, floor area. Null when not available.
+   */
+  development: PlanningDevelopmentExtractionEnvelope | null;
+  /**
+   * The case officer's recommendation, key issues, policy refs, and CIL/s106 flags. Null when not available.
+   */
+  officerAssessment: PlanningOfficerAssessmentExtractionEnvelope | null;
+  /**
+   * Section 106 financial and non-financial obligations. Null when not available.
+   */
+  s106: PlanningS106ExtractionEnvelope | null;
+};
+
 /**
  * People associated with the application including applicants and planning agents. Contact details (phone, email) are redacted; only names and organisations are included. Null if no applicant or agent data was available.
  */
@@ -102,7 +153,7 @@ export type PlanningApplicationType = ClosedEnum<
 /**
  * Application site centroid as a GeoJSON Point geometry (RFC 7946). Coordinates are in [longitude, latitude] order using the WGS84 datum (EPSG:4326). This point represents the approximate centre of the application site, derived from the planning authority's spatial data or geocoded from the site address. Null if no spatial data was available from the source. For the full site boundary, see spatialFeatures.
  */
-export type Spatial = {
+export type PlanningApplicationSpatial = {
   /**
    * Coordinate pair in GeoJSON [longitude, latitude] order. Uses the WGS84 coordinate reference system (EPSG:4326). Example: [-0.1278, 51.5074] represents a point in central London.
    */
@@ -113,20 +164,6 @@ export type Spatial = {
   type: PlanningApplicationType;
 };
 
-/**
- * GeoJSON geometry type
- */
-export const PlanningApplicationSchemasSpatialFeaturesFeaturesGeometryType = {
-  MultiPolygon: "MultiPolygon",
-} as const;
-/**
- * GeoJSON geometry type
- */
-export type PlanningApplicationSchemasSpatialFeaturesFeaturesGeometryType =
-  ClosedEnum<
-    typeof PlanningApplicationSchemasSpatialFeaturesFeaturesGeometryType
-  >;
-
 /**
  * GeoJSON MultiPolygon geometry
  */
@@ -138,22 +175,9 @@ export type PlanningApplicationGeoJSONMultiPolygon = {
   /**
    * GeoJSON geometry type
    */
-  type: PlanningApplicationSchemasSpatialFeaturesFeaturesGeometryType;
+  type: "MultiPolygon";
 };
 
-/**
- * GeoJSON geometry type
- */
-export const PlanningApplicationSchemasSpatialFeaturesFeaturesType = {
-  Polygon: "Polygon",
-} as const;
-/**
- * GeoJSON geometry type
- */
-export type PlanningApplicationSchemasSpatialFeaturesFeaturesType = ClosedEnum<
-  typeof PlanningApplicationSchemasSpatialFeaturesFeaturesType
->;
-
 /**
  * GeoJSON Polygon geometry
  */
@@ -165,23 +189,9 @@ export type PlanningApplicationGeoJSONPolygon = {
   /**
    * GeoJSON geometry type
    */
-  type: PlanningApplicationSchemasSpatialFeaturesFeaturesType;
+  type: "Polygon";
 };
 
-/**
- * GeoJSON geometry type
- */
-export const PlanningApplicationSchemasSpatialFeaturesFeaturesGeometry1Type = {
-  Point: "Point",
-} as const;
-/**
- * GeoJSON geometry type
- */
-export type PlanningApplicationSchemasSpatialFeaturesFeaturesGeometry1Type =
-  ClosedEnum<
-    typeof PlanningApplicationSchemasSpatialFeaturesFeaturesGeometry1Type
-  >;
-
 /**
  * GeoJSON Point geometry
  */
@@ -193,7 +203,7 @@ export type GeoJSONPoint = {
   /**
    * GeoJSON geometry type
    */
-  type: PlanningApplicationSchemasSpatialFeaturesFeaturesGeometry1Type;
+  type: "Point";
 };
 
 /**
@@ -202,8 +212,7 @@ export type GeoJSONPoint = {
 export type Geometry =
   | GeoJSONPoint
   | PlanningApplicationGeoJSONPolygon
-  | PlanningApplicationGeoJSONMultiPolygon
-  | any;
+  | PlanningApplicationGeoJSONMultiPolygon;
 
 /**
  * GeoJSON feature type, always 'Feature'.
@@ -222,17 +231,15 @@ export type PlanningApplicationFeatures = {
   /**
    * The geometry of this feature. May be a Point (site centroid), Polygon (single boundary), or MultiPolygon (disjoint site areas). Null if the geometry could not be parsed from the source data. Coordinates are in [longitude, latitude] order (WGS84, EPSG:4326).
    */
-  geometry?:
+  geometry:
     | GeoJSONPoint
     | PlanningApplicationGeoJSONPolygon
     | PlanningApplicationGeoJSONMultiPolygon
-    | any
-    | null
-    | undefined;
+    | null;
   /**
    * Key-value metadata associated with this geometry feature. Content varies by source and may include area measurements, boundary descriptions, or source attribution.
    */
-  properties?: { [k: string]: any | null } | undefined;
+  properties?: { [k: string]: any } | undefined;
   /**
    * GeoJSON feature type, always 'Feature'.
    */
@@ -345,6 +352,10 @@ export type PlanningApplication = {
    * The date on which the planning permission expires if not implemented, formatted as an ISO 8601 datetime string. Most permissions must be commenced within three years of approval. Null if not applicable or not recorded.
    */
   expiryDate?: string | null | undefined;
+  /**
+   * Structured, citation-backed data extracted from the application's documents — decision outcome and refusal reasons, development specifics, section 106 obligations, the officer's assessment, and consultee responses. Only present when 'extractions' is requested via the include parameter (GET) or the include array (POST /query); omitted entirely otherwise. Each sub-extraction may itself be null when that schema has not been extracted for this application. Coverage and per-extraction verification status are reported so consumers can degrade honestly when data is partial or unverified.
+   */
+  extractions?: Extractions | null | undefined;
   /**
    * Unique identifier for the planning application record. Use this UUID to retrieve the application via the GET /{applicationIds} endpoint.
    */
@@ -376,7 +387,7 @@ export type PlanningApplication = {
   /**
    * Application site centroid as a GeoJSON Point geometry (RFC 7946). Coordinates are in [longitude, latitude] order using the WGS84 datum (EPSG:4326). This point represents the approximate centre of the application site, derived from the planning authority's spatial data or geocoded from the site address. Null if no spatial data was available from the source. For the full site boundary, see spatialFeatures.
    */
-  spatial?: Spatial | null | undefined;
+  spatial?: PlanningApplicationSpatial | null | undefined;
   /**
    * Full application site geometry as a GeoJSON FeatureCollection (RFC 7946). May contain Point, Polygon, or MultiPolygon geometries representing the application site boundary or boundaries. Coordinates are in [longitude, latitude] order using the WGS84 datum (EPSG:4326). Polygon rings follow the right-hand rule (exterior rings are counterclockwise). This field provides the detailed site boundary when available, whereas the spatial field provides only the centroid point. Null if no geometry data was available from the planning authority.
    */
@@ -446,6 +457,34 @@ export function planningApplicationAddressFromJSON(
   );
 }
 
+/** @internal */
+export const Extractions$inboundSchema: z.ZodType<
+  Extractions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  consulteeResponses: z.nullable(
+    PlanningConsulteeResponsesExtractionEnvelope$inboundSchema,
+  ),
+  coverage: PlanningExtractionCoverage$inboundSchema,
+  decision: z.nullable(PlanningDecisionExtractionEnvelope$inboundSchema),
+  development: z.nullable(PlanningDevelopmentExtractionEnvelope$inboundSchema),
+  officerAssessment: z.nullable(
+    PlanningOfficerAssessmentExtractionEnvelope$inboundSchema,
+  ),
+  s106: z.nullable(PlanningS106ExtractionEnvelope$inboundSchema),
+});
+
+export function extractionsFromJSON(
+  jsonString: string,
+): SafeParseResult<Extractions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Extractions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Extractions' from JSON`,
+  );
+}
+
 /** @internal */
 export const People$inboundSchema: z.ZodType<People, z.ZodTypeDef, unknown> = z
   .object({
@@ -469,30 +508,25 @@ export const PlanningApplicationType$inboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(PlanningApplicationType);
 
 /** @internal */
-export const Spatial$inboundSchema: z.ZodType<Spatial, z.ZodTypeDef, unknown> =
-  z.object({
-    coordinates: z.array(z.number()),
-    type: PlanningApplicationType$inboundSchema,
-  });
+export const PlanningApplicationSpatial$inboundSchema: z.ZodType<
+  PlanningApplicationSpatial,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  coordinates: z.array(z.number()),
+  type: PlanningApplicationType$inboundSchema,
+});
 
-export function spatialFromJSON(
+export function planningApplicationSpatialFromJSON(
   jsonString: string,
-): SafeParseResult<Spatial, SDKValidationError> {
+): SafeParseResult<PlanningApplicationSpatial, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Spatial$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Spatial' from JSON`,
+    (x) => PlanningApplicationSpatial$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningApplicationSpatial' from JSON`,
   );
 }
 
-/** @internal */
-export const PlanningApplicationSchemasSpatialFeaturesFeaturesGeometryType$inboundSchema:
-  z.ZodNativeEnum<
-    typeof PlanningApplicationSchemasSpatialFeaturesFeaturesGeometryType
-  > = z.nativeEnum(
-    PlanningApplicationSchemasSpatialFeaturesFeaturesGeometryType,
-  );
-
 /** @internal */
 export const PlanningApplicationGeoJSONMultiPolygon$inboundSchema: z.ZodType<
   PlanningApplicationGeoJSONMultiPolygon,
@@ -500,8 +534,7 @@ export const PlanningApplicationGeoJSONMultiPolygon$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   coordinates: z.array(z.array(z.array(z.array(z.number())))),
-  type:
-    PlanningApplicationSchemasSpatialFeaturesFeaturesGeometryType$inboundSchema,
+  type: z.literal("MultiPolygon"),
 });
 
 export function planningApplicationGeoJSONMultiPolygonFromJSON(
@@ -515,12 +548,6 @@ export function planningApplicationGeoJSONMultiPolygonFromJSON(
   );
 }
 
-/** @internal */
-export const PlanningApplicationSchemasSpatialFeaturesFeaturesType$inboundSchema:
-  z.ZodNativeEnum<
-    typeof PlanningApplicationSchemasSpatialFeaturesFeaturesType
-  > = z.nativeEnum(PlanningApplicationSchemasSpatialFeaturesFeaturesType);
-
 /** @internal */
 export const PlanningApplicationGeoJSONPolygon$inboundSchema: z.ZodType<
   PlanningApplicationGeoJSONPolygon,
@@ -528,7 +555,7 @@ export const PlanningApplicationGeoJSONPolygon$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   coordinates: z.array(z.array(z.array(z.number()))),
-  type: PlanningApplicationSchemasSpatialFeaturesFeaturesType$inboundSchema,
+  type: z.literal("Polygon"),
 });
 
 export function planningApplicationGeoJSONPolygonFromJSON(
@@ -541,14 +568,6 @@ export function planningApplicationGeoJSONPolygonFromJSON(
   );
 }
 
-/** @internal */
-export const PlanningApplicationSchemasSpatialFeaturesFeaturesGeometry1Type$inboundSchema:
-  z.ZodNativeEnum<
-    typeof PlanningApplicationSchemasSpatialFeaturesFeaturesGeometry1Type
-  > = z.nativeEnum(
-    PlanningApplicationSchemasSpatialFeaturesFeaturesGeometry1Type,
-  );
-
 /** @internal */
 export const GeoJSONPoint$inboundSchema: z.ZodType<
   GeoJSONPoint,
@@ -556,8 +575,7 @@ export const GeoJSONPoint$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   coordinates: z.array(z.number()),
-  type:
-    PlanningApplicationSchemasSpatialFeaturesFeaturesGeometry1Type$inboundSchema,
+  type: z.literal("Point"),
 });
 
 export function geoJSONPointFromJSON(
@@ -579,7 +597,6 @@ export const Geometry$inboundSchema: z.ZodType<
   z.lazy(() => GeoJSONPoint$inboundSchema),
   z.lazy(() => PlanningApplicationGeoJSONPolygon$inboundSchema),
   z.lazy(() => PlanningApplicationGeoJSONMultiPolygon$inboundSchema),
-  z.any(),
 ]);
 
 export function geometryFromJSON(
@@ -608,10 +625,9 @@ export const PlanningApplicationFeatures$inboundSchema: z.ZodType<
       z.lazy(() => GeoJSONPoint$inboundSchema),
       z.lazy(() => PlanningApplicationGeoJSONPolygon$inboundSchema),
       z.lazy(() => PlanningApplicationGeoJSONMultiPolygon$inboundSchema),
-      z.any(),
     ]),
-  ).optional(),
-  properties: z.record(z.nullable(z.any())).optional(),
+  ),
+  properties: z.record(z.any()).optional(),
   type: PlanningApplicationSchemasSpatialFeaturesType$inboundSchema,
 });
 
@@ -677,6 +693,7 @@ export const PlanningApplication$inboundSchema: z.ZodType<
   developmentCategory: z.nullable(z.string()).optional(),
   documents: z.array(PlanningDocument$inboundSchema).optional(),
   expiryDate: z.nullable(z.string()).optional(),
+  extractions: z.nullable(z.lazy(() => Extractions$inboundSchema)).optional(),
   id: z.string(),
   key: z.string(),
   people: z.nullable(z.lazy(() => People$inboundSchema)).optional(),
@@ -685,7 +702,8 @@ export const PlanningApplication$inboundSchema: z.ZodType<
   relatedCases: z.nullable(z.array(PlanningRelatedCase$inboundSchema))
     .optional(),
   sourceId: z.string(),
-  spatial: z.nullable(z.lazy(() => Spatial$inboundSchema)).optional(),
+  spatial: z.nullable(z.lazy(() => PlanningApplicationSpatial$inboundSchema))
+    .optional(),
   spatialFeatures: z.nullable(z.lazy(() => SpatialFeatures$inboundSchema))
     .optional(),
   status: PlanningApplicationStatus$inboundSchema,

package/src/sdk/models/shared/planningconsideration.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";
+
+/**
+ * Planning policy consideration triggered by the risk
+ */
+export type PlanningConsideration = {
+  /**
+   * Human-readable explanation of the consideration
+   */
+  description: string;
+  /**
+   * Regulatory framework citation — e.g. 'NPPF_Ch15', 'PPG_Noise', 'PPG_Flood_Risk'
+   */
+  framework: string;
+  /**
+   * Canonical URL to the framework document
+   */
+  reference?: string | undefined;
+  /**
+   * Whether the consideration is mandatory for development
+   */
+  required: boolean;
+  /**
+   * Subject of the planning consideration
+   */
+  topic: string;
+};
+
+/** @internal */
+export const PlanningConsideration$inboundSchema: z.ZodType<
+  PlanningConsideration,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  description: z.string(),
+  framework: z.string(),
+  reference: z.string().optional(),
+  required: z.boolean(),
+  topic: z.string(),
+});
+
+export function planningConsiderationFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningConsideration, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningConsideration$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningConsideration' from JSON`,
+  );
+}