@vepler/sdk 2.39.0 → 2.45.0

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

@@ -26,7 +26,7 @@ export type CompaniesByLocationResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
   /**
    * Total number of companies registered at this property.
    */
@@ -41,7 +41,7 @@ export const CompaniesByLocationResponse$inboundSchema: z.ZodType<
 > = z.object({
   companies: z.array(CompanySummary$inboundSchema),
   locationId: z.string(),
-  success: z.boolean(),
+  success: z.literal(true),
   total: z.number().int(),
 });
 

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

@@ -34,7 +34,7 @@ export type CompanyListResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
   /**
    * Total number of companies matching the search criteria (across all pages).
    */
@@ -51,7 +51,7 @@ export const CompanyListResponse$inboundSchema: z.ZodType<
   limit: z.number().int(),
   offset: z.number().int(),
   results: z.array(CompanySummary$inboundSchema),
-  success: z.boolean(),
+  success: z.literal(true),
   total: z.number().int(),
 });
 

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

@@ -32,7 +32,7 @@ export type CompanyResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
 };
 
 /** @internal */
@@ -44,7 +44,7 @@ export const CompanyResponse$inboundSchema: z.ZodType<
   officers: z.array(OfficerSummary$inboundSchema).optional(),
   pscs: z.array(PscSummary$inboundSchema).optional(),
   result: Company$inboundSchema,
-  success: z.boolean(),
+  success: z.literal(true),
 });
 
 export function companyResponseFromJSON(

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

@@ -0,0 +1,75 @@
+/*
+ * 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";
+import { CrimeRecord, CrimeRecord$inboundSchema } from "./crimerecord.js";
+
+export type CrimeDataResponseSummary = {
+  /**
+   * Incident count per category
+   */
+  byCategory: { [k: string]: number };
+  /**
+   * Period queried (YYYY-MM)
+   */
+  period: string;
+  /**
+   * Search radius used (metres)
+   */
+  radius: number;
+  /**
+   * Total incidents returned
+   */
+  total: number;
+};
+
+export type CrimeDataResponse = {
+  data: Array<CrimeRecord>;
+  summary: CrimeDataResponseSummary;
+};
+
+/** @internal */
+export const CrimeDataResponseSummary$inboundSchema: z.ZodType<
+  CrimeDataResponseSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  byCategory: z.record(z.number()),
+  period: z.string(),
+  radius: z.number(),
+  total: z.number(),
+});
+
+export function crimeDataResponseSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<CrimeDataResponseSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CrimeDataResponseSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CrimeDataResponseSummary' from JSON`,
+  );
+}
+
+/** @internal */
+export const CrimeDataResponse$inboundSchema: z.ZodType<
+  CrimeDataResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(CrimeRecord$inboundSchema),
+  summary: z.lazy(() => CrimeDataResponseSummary$inboundSchema),
+});
+
+export function crimeDataResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CrimeDataResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CrimeDataResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CrimeDataResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,64 @@
+/*
+ * 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 CrimeRecord = {
+  /**
+   * Crime category
+   */
+  category: string;
+  /**
+   * ISO 8601 date/time of the crime
+   */
+  crimeDate: string;
+  /**
+   * Police-issued crime identifier
+   */
+  crimeId: string | null;
+  /**
+   * Textual location description
+   */
+  crimeLocation: string | null;
+  /**
+   * Database primary key
+   */
+  id: number;
+  /**
+   * Human-readable crime label
+   */
+  label: string | null;
+  /**
+   * Reporting police force
+   */
+  reportedBy: string | null;
+};
+
+/** @internal */
+export const CrimeRecord$inboundSchema: z.ZodType<
+  CrimeRecord,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  category: z.string(),
+  crimeDate: z.string(),
+  crimeId: z.nullable(z.string()),
+  crimeLocation: z.nullable(z.string()),
+  id: z.number(),
+  label: z.nullable(z.string()),
+  reportedBy: z.nullable(z.string()),
+});
+
+export function crimeRecordFromJSON(
+  jsonString: string,
+): SafeParseResult<CrimeRecord, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CrimeRecord$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CrimeRecord' from JSON`,
+  );
+}

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

@@ -4,10 +4,12 @@
 
 export * from "./addresscleanserequest.js";
 export * from "./addresscleanseresponse.js";
+export * from "./addressresolverequest.js";
 export * from "./aggregationinput.js";
 export * from "./aggregationresult.js";
 export * from "./analysiscomparable.js";
 export * from "./appointmentsresponse.js";
+export * from "./areastatsresponse.js";
 export * from "./avmanalysisrequest.js";
 export * from "./avmanalysisresponse.js";
 export * from "./avmconfidenceinterval.js";
@@ -36,6 +38,8 @@ export * from "./councilmetadata.js";
 export * from "./councilserviceurls.js";
 export * from "./counciltaxbanddetails.js";
 export * from "./counciltaxdata.js";
+export * from "./crimedataresponse.js";
+export * from "./crimerecord.js";
 export * from "./dateofbirth.js";
 export * from "./epcdata.js";
 export * from "./extendedstatsaggregationresult.js";
@@ -66,10 +70,18 @@ export * from "./personlistresponse.js";
 export * from "./personqueryrequest.js";
 export * from "./personresponse.js";
 export * from "./personsummary.js";
+export * from "./planningaddress.js";
+export * from "./planningagent.js";
+export * from "./planningapplicant.js";
 export * from "./planningapplication.js";
+export * from "./planningconstraint.js";
+export * from "./planningdocument.js";
 export * from "./planninglistresponse.js";
+export * from "./planningpeople.js";
 export * from "./planningqueryfilters.js";
 export * from "./planningqueryrequest.js";
+export * from "./planningrelatedcase.js";
+export * from "./planningstatushistory.js";
 export * from "./postcodeaddress.js";
 export * from "./postcodelookupresponse.js";
 export * from "./postcodevalidationresponse.js";
@@ -126,11 +138,13 @@ export * from "./siteleafaggregation.js";
 export * from "./sitelistresponse.js";
 export * from "./sitemultipolygonareafilter.js";
 export * from "./sitenestedaggregation.js";
+export * from "./siteownership.js";
 export * from "./siteplanningstats.js";
 export * from "./sitepointareafilter.js";
 export * from "./sitepolygonareafilter.js";
 export * from "./sitepropertiesresponse.js";
 export * from "./sitepropertystats.js";
+export * from "./siteproprietor.js";
 export * from "./sitequerycondition.js";
 export * from "./sitequerygroup.js";
 export * from "./sitequeryoperator.js";
@@ -152,4 +166,6 @@ export * from "./tenancydata.js";
 export * from "./tenuredata.js";
 export * from "./termsaggregationresult.js";
 export * from "./termsbucket.js";
+export * from "./titledeeddocumentlistresponse.js";
+export * from "./titledeedpurchaseresponse.js";
 export * from "./uprnlookupresponse.js";

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

@@ -8,6 +8,10 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListingImage = {
+  /**
+   * Pre-generated CDN thumbnail URL (640×480 WebP)
+   */
+  thumbnailUrl?: string | null | undefined;
   /**
    * Image URL
    */
@@ -20,6 +24,7 @@ export const ListingImage$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  thumbnailUrl: z.nullable(z.string()).optional(),
   url: z.nullable(z.string()).optional(),
 });
 

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

@@ -23,7 +23,7 @@ export type NearestPostcodesResponseCoordinates = {
   lng: number;
 };
 
-export type Data = {
+export type NearestPostcodesResponseData = {
   /**
    * WGS84 coordinate pair
    */
@@ -67,7 +67,7 @@ export type NearestPostcodesResponse = {
   /**
    * Nearby postcodes sorted by distance
    */
-  data: Array<Data>;
+  data: Array<NearestPostcodesResponseData>;
   hasMore: boolean;
   object: NearestPostcodesResponseObject;
   /**
@@ -114,27 +114,28 @@ export function nearestPostcodesResponseCoordinatesFromJSON(
 }
 
 /** @internal */
-export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
-  .object({
-    coordinates: z.lazy(() =>
-      NearestPostcodesResponseCoordinates$inboundSchema
-    ),
-    country: z.string().optional(),
-    distance_metres: z.number(),
-    postcode: z.string(),
-  }).transform((v) => {
-    return remap$(v, {
-      "distance_metres": "distanceMetres",
-    });
+export const NearestPostcodesResponseData$inboundSchema: z.ZodType<
+  NearestPostcodesResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  coordinates: z.lazy(() => NearestPostcodesResponseCoordinates$inboundSchema),
+  country: z.string().optional(),
+  distance_metres: z.number(),
+  postcode: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "distance_metres": "distanceMetres",
   });
+});
 
-export function dataFromJSON(
+export function nearestPostcodesResponseDataFromJSON(
   jsonString: string,
-): SafeParseResult<Data, SDKValidationError> {
+): SafeParseResult<NearestPostcodesResponseData, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Data$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Data' from JSON`,
+    (x) => NearestPostcodesResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NearestPostcodesResponseData' from JSON`,
   );
 }
 
@@ -169,7 +170,7 @@ export const NearestPostcodesResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  data: z.array(z.lazy(() => Data$inboundSchema)),
+  data: z.array(z.lazy(() => NearestPostcodesResponseData$inboundSchema)),
   has_more: z.boolean(),
   object: NearestPostcodesResponseObject$inboundSchema,
   radius: z.number(),

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

@@ -34,7 +34,7 @@ export type OfficerListResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
   /**
    * Total number of officer appointments matching the filters.
    */
@@ -51,7 +51,7 @@ export const OfficerListResponse$inboundSchema: z.ZodType<
   limit: z.number().int(),
   offset: z.number().int(),
   results: z.array(OfficerSummary$inboundSchema),
-  success: z.boolean(),
+  success: z.literal(true),
   total: z.number().int(),
 });
 

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

@@ -19,7 +19,7 @@ export type OfficerResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
 };
 
 /** @internal */
@@ -29,7 +29,7 @@ export const OfficerResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   result: Officer$inboundSchema,
-  success: z.boolean(),
+  success: z.literal(true),
 });
 
 export function officerResponseFromJSON(

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

@@ -19,7 +19,7 @@ export type PersonClusterResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
 };
 
 /** @internal */
@@ -29,7 +29,7 @@ export const PersonClusterResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   result: PersonCluster$inboundSchema,
-  success: z.boolean(),
+  success: z.literal(true),
 });
 
 export function personClusterResponseFromJSON(

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

@@ -31,7 +31,7 @@ export type PersonListResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
   /**
    * Total number of persons matching the search criteria (across all pages).
    */
@@ -48,7 +48,7 @@ export const PersonListResponse$inboundSchema: z.ZodType<
   limit: z.number().int(),
   offset: z.number().int(),
   results: z.array(z.nullable(PersonSummary$inboundSchema)),
-  success: z.boolean(),
+  success: z.literal(true),
   total: z.number().int(),
 });
 

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

@@ -32,7 +32,7 @@ export type PersonResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
 };
 
 /** @internal */
@@ -44,7 +44,7 @@ export const PersonResponse$inboundSchema: z.ZodType<
   appointments: z.array(OfficerSummary$inboundSchema).optional(),
   pscNotifications: z.array(PscSummary$inboundSchema).optional(),
   result: Person$inboundSchema,
-  success: z.boolean(),
+  success: z.literal(true),
 });
 
 export function personResponseFromJSON(

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

@@ -0,0 +1,77 @@
+/*
+ * 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";
+
+/**
+ * Structured address of the application site, as scraped from the planning authority. Field availability varies by council — some provide full structured addresses whilst others provide only a raw string. Null if no address data was available.
+ */
+export type PlanningAddress = {
+  /**
+   * County.
+   */
+  county?: string | null | undefined;
+  /**
+   * Full formatted address as a single string, when available.
+   */
+  formattedAddress?: string | null | undefined;
+  /**
+   * First line of the site address.
+   */
+  line1?: string | null | undefined;
+  /**
+   * Second line of the site address.
+   */
+  line2?: string | null | undefined;
+  /**
+   * Third line of the site address.
+   */
+  line3?: string | null | undefined;
+  /**
+   * Fourth line of the site address.
+   */
+  line4?: string | null | undefined;
+  /**
+   * UK postcode.
+   */
+  postcode?: string | null | undefined;
+  /**
+   * Town or city.
+   */
+  town?: string | null | undefined;
+  /**
+   * Electoral ward in which the site is located.
+   */
+  ward?: string | null | undefined;
+};
+
+/** @internal */
+export const PlanningAddress$inboundSchema: z.ZodType<
+  PlanningAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  county: z.nullable(z.string()).optional(),
+  formattedAddress: z.nullable(z.string()).optional(),
+  line1: z.nullable(z.string()).optional(),
+  line2: z.nullable(z.string()).optional(),
+  line3: z.nullable(z.string()).optional(),
+  line4: z.nullable(z.string()).optional(),
+  postcode: z.nullable(z.string()).optional(),
+  town: z.nullable(z.string()).optional(),
+  ward: z.nullable(z.string()).optional(),
+});
+
+export function planningAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningAddress' from JSON`,
+  );
+}

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

@@ -0,0 +1,39 @@
+/*
+ * 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 PlanningAgent = {
+  /**
+   * Full name of the planning agent.
+   */
+  name?: string | null | undefined;
+  /**
+   * Agent's company or practice name.
+   */
+  organisation?: string | null | undefined;
+};
+
+/** @internal */
+export const PlanningAgent$inboundSchema: z.ZodType<
+  PlanningAgent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.nullable(z.string()).optional(),
+  organisation: z.nullable(z.string()).optional(),
+});
+
+export function planningAgentFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningAgent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningAgent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningAgent' from JSON`,
+  );
+}

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

@@ -0,0 +1,39 @@
+/*
+ * 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 PlanningApplicant = {
+  /**
+   * Company or organisation name, if applicable.
+   */
+  company?: string | null | undefined;
+  /**
+   * Full name of the applicant.
+   */
+  name?: string | null | undefined;
+};
+
+/** @internal */
+export const PlanningApplicant$inboundSchema: z.ZodType<
+  PlanningApplicant,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  company: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+});
+
+export function planningApplicantFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningApplicant, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningApplicant$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningApplicant' from JSON`,
+  );
+}