@vepler/sdk 2.133.0 → 2.138.0

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

@@ -0,0 +1,133 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Comparison operator. Range operators (gt/gte/lt/lte) apply to numeric and date fields.
+ */
+export const ListingQueryConditionComparator = {
+  Eq: "eq",
+  Ne: "ne",
+  Gt: "gt",
+  Gte: "gte",
+  Lt: "lt",
+  Lte: "lte",
+  In: "in",
+  Nin: "nin",
+} as const;
+/**
+ * Comparison operator. Range operators (gt/gte/lt/lte) apply to numeric and date fields.
+ */
+export type ListingQueryConditionComparator = ClosedEnum<
+  typeof ListingQueryConditionComparator
+>;
+
+export type ListingQueryCondition4 = string | number | boolean;
+
+/**
+ * Value to compare against. Use an array with 'in'/'nin'.
+ */
+export type ListingQueryConditionValue =
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean>;
+
+export type ListingQueryCondition = {
+  /**
+   * Comparison operator. Range operators (gt/gte/lt/lte) apply to numeric and date fields.
+   */
+  comparator: ListingQueryConditionComparator;
+  /**
+   * Field to filter on (Elasticsearch path). Examples: status, type, roomDetails.beds, pricing.price, build.propertyType, tenure.type, address.outcode, publishedDate.
+   */
+  field: string;
+  /**
+   * Value to compare against. Use an array with 'in'/'nin'.
+   */
+  value: string | number | boolean | Array<string | number | boolean>;
+};
+
+/** @internal */
+export const ListingQueryConditionComparator$outboundSchema: z.ZodNativeEnum<
+  typeof ListingQueryConditionComparator
+> = z.nativeEnum(ListingQueryConditionComparator);
+
+/** @internal */
+export type ListingQueryCondition4$Outbound = string | number | boolean;
+
+/** @internal */
+export const ListingQueryCondition4$outboundSchema: z.ZodType<
+  ListingQueryCondition4$Outbound,
+  z.ZodTypeDef,
+  ListingQueryCondition4
+> = z.union([z.string(), z.number(), z.boolean()]);
+
+export function listingQueryCondition4ToJSON(
+  listingQueryCondition4: ListingQueryCondition4,
+): string {
+  return JSON.stringify(
+    ListingQueryCondition4$outboundSchema.parse(listingQueryCondition4),
+  );
+}
+
+/** @internal */
+export type ListingQueryConditionValue$Outbound =
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean>;
+
+/** @internal */
+export const ListingQueryConditionValue$outboundSchema: z.ZodType<
+  ListingQueryConditionValue$Outbound,
+  z.ZodTypeDef,
+  ListingQueryConditionValue
+> = z.union([
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.array(z.union([z.string(), z.number(), z.boolean()])),
+]);
+
+export function listingQueryConditionValueToJSON(
+  listingQueryConditionValue: ListingQueryConditionValue,
+): string {
+  return JSON.stringify(
+    ListingQueryConditionValue$outboundSchema.parse(listingQueryConditionValue),
+  );
+}
+
+/** @internal */
+export type ListingQueryCondition$Outbound = {
+  comparator: string;
+  field: string;
+  value: string | number | boolean | Array<string | number | boolean>;
+};
+
+/** @internal */
+export const ListingQueryCondition$outboundSchema: z.ZodType<
+  ListingQueryCondition$Outbound,
+  z.ZodTypeDef,
+  ListingQueryCondition
+> = z.object({
+  comparator: ListingQueryConditionComparator$outboundSchema,
+  field: z.string(),
+  value: z.union([
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.array(z.union([z.string(), z.number(), z.boolean()])),
+  ]),
+});
+
+export function listingQueryConditionToJSON(
+  listingQueryCondition: ListingQueryCondition,
+): string {
+  return JSON.stringify(
+    ListingQueryCondition$outboundSchema.parse(listingQueryCondition),
+  );
+}

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  ListingQueryCondition,
+  ListingQueryCondition$Outbound,
+  ListingQueryCondition$outboundSchema,
+} from "./listingquerycondition.js";
+
+export type ListingQueryGroup = {
+  /**
+   * Conditions within this group.
+   */
+  conditions: Array<ListingQueryCondition>;
+};
+
+/** @internal */
+export type ListingQueryGroup$Outbound = {
+  conditions: Array<ListingQueryCondition$Outbound>;
+};
+
+/** @internal */
+export const ListingQueryGroup$outboundSchema: z.ZodType<
+  ListingQueryGroup$Outbound,
+  z.ZodTypeDef,
+  ListingQueryGroup
+> = z.object({
+  conditions: z.array(ListingQueryCondition$outboundSchema),
+});
+
+export function listingQueryGroupToJSON(
+  listingQueryGroup: ListingQueryGroup,
+): string {
+  return JSON.stringify(
+    ListingQueryGroup$outboundSchema.parse(listingQueryGroup),
+  );
+}

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

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  ListingQueryGroup,
+  ListingQueryGroup$Outbound,
+  ListingQueryGroup$outboundSchema,
+} from "./listingquerygroup.js";
+
+/**
+ * How conditions within each group are combined.
+ */
+export const ListingQueryOperatorOperator = {
+  And: "AND",
+  Or: "OR",
+} as const;
+/**
+ * How conditions within each group are combined.
+ */
+export type ListingQueryOperatorOperator = ClosedEnum<
+  typeof ListingQueryOperatorOperator
+>;
+
+export type ListingQueryOperator = {
+  /**
+   * Condition groups.
+   */
+  groups: Array<ListingQueryGroup>;
+  /**
+   * How conditions within each group are combined.
+   */
+  operator: ListingQueryOperatorOperator;
+};
+
+/** @internal */
+export const ListingQueryOperatorOperator$outboundSchema: z.ZodNativeEnum<
+  typeof ListingQueryOperatorOperator
+> = z.nativeEnum(ListingQueryOperatorOperator);
+
+/** @internal */
+export type ListingQueryOperator$Outbound = {
+  groups: Array<ListingQueryGroup$Outbound>;
+  operator: string;
+};
+
+/** @internal */
+export const ListingQueryOperator$outboundSchema: z.ZodType<
+  ListingQueryOperator$Outbound,
+  z.ZodTypeDef,
+  ListingQueryOperator
+> = z.object({
+  groups: z.array(ListingQueryGroup$outboundSchema),
+  operator: ListingQueryOperatorOperator$outboundSchema,
+});
+
+export function listingQueryOperatorToJSON(
+  listingQueryOperator: ListingQueryOperator,
+): string {
+  return JSON.stringify(
+    ListingQueryOperator$outboundSchema.parse(listingQueryOperator),
+  );
+}

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.
    */
@@ -293,6 +344,10 @@ export type PlanningApplication = {
    * High-level classification of the proposed development, derived from the application description and type using AI. Common values include: 'Residential' (new homes, conversions to dwellings), 'Commercial' (offices, retail, hospitality), 'Industrial' (manufacturing, warehousing), 'Mixed Use' (combination of residential and commercial), 'Infrastructure' (roads, utilities, telecommunications), 'Change of Use' (altering the permitted use class of a building). Null if the development could not be classified. This field is useful for filtering applications by broad development sector.
    */
   developmentCategory?: string | null | undefined;
+  /**
+   * Straight-line distance in metres from the application site centroid to the centre supplied in a spatial (`near`) query. Present and ordered ascending (closest first) only when the request used the `near` filter; null when this application has no site point, and omitted/null for non-spatial lookups.
+   */
+  distance?: number | null | undefined;
   /**
    * Documents associated with the planning application, including submitted plans, decision notices, consultation responses, and supporting material. May be empty if no documents have been collected from the source.
    */
@@ -301,6 +356,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.
    */
@@ -332,7 +391,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.
    */
@@ -402,6 +461,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({
@@ -425,19 +512,22 @@ 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`,
   );
 }
 
@@ -605,8 +695,10 @@ export const PlanningApplication$inboundSchema: z.ZodType<
   decidedDate: z.nullable(z.string()).optional(),
   description: z.nullable(z.string()).optional(),
   developmentCategory: z.nullable(z.string()).optional(),
+  distance: z.nullable(z.number()).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(),
@@ -615,7 +707,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,