@vepler/sdk 2.38.2 → 2.42.0

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

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+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";
+
+export type MonthlyBreakdown = {
+  count: number;
+  month: string;
+};
+
+export type TopCategories = {
+  category: string;
+  count: number;
+  /**
+   * Percentage of total crimes
+   */
+  percentage: number;
+};
+
+/**
+ * Crime trend direction
+ */
+export const Trend = {
+  Increasing: "increasing",
+  Decreasing: "decreasing",
+  Stable: "stable",
+} as const;
+/**
+ * Crime trend direction
+ */
+export type Trend = OpenEnum<typeof Trend>;
+
+export type Data = {
+  /**
+   * Mean crimes per month
+   */
+  monthlyAverage: number;
+  monthlyBreakdown: Array<MonthlyBreakdown>;
+  /**
+   * Derived safety score (0-100, higher = safer)
+   */
+  safetyScore: number;
+  topCategories: Array<TopCategories>;
+  /**
+   * Total crimes across all months
+   */
+  totalCrimes: number;
+  /**
+   * Crime trend direction
+   */
+  trend: Trend;
+};
+
+export type AreaStatsResponse = {
+  data: Data;
+};
+
+/** @internal */
+export const MonthlyBreakdown$inboundSchema: z.ZodType<
+  MonthlyBreakdown,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number(),
+  month: z.string(),
+});
+
+export function monthlyBreakdownFromJSON(
+  jsonString: string,
+): SafeParseResult<MonthlyBreakdown, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MonthlyBreakdown$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MonthlyBreakdown' from JSON`,
+  );
+}
+
+/** @internal */
+export const TopCategories$inboundSchema: z.ZodType<
+  TopCategories,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  category: z.string(),
+  count: z.number(),
+  percentage: z.number(),
+});
+
+export function topCategoriesFromJSON(
+  jsonString: string,
+): SafeParseResult<TopCategories, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TopCategories$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TopCategories' from JSON`,
+  );
+}
+
+/** @internal */
+export const Trend$inboundSchema: z.ZodType<Trend, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Trend);
+
+/** @internal */
+export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
+  .object({
+    monthlyAverage: z.number(),
+    monthlyBreakdown: z.array(z.lazy(() => MonthlyBreakdown$inboundSchema)),
+    safetyScore: z.number(),
+    topCategories: z.array(z.lazy(() => TopCategories$inboundSchema)),
+    totalCrimes: z.number(),
+    trend: Trend$inboundSchema,
+  });
+
+export function dataFromJSON(
+  jsonString: string,
+): SafeParseResult<Data, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Data$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Data' from JSON`,
+  );
+}
+
+/** @internal */
+export const AreaStatsResponse$inboundSchema: z.ZodType<
+  AreaStatsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.lazy(() => Data$inboundSchema),
+});
+
+export function areaStatsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AreaStatsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AreaStatsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AreaStatsResponse' from JSON`,
+  );
+}

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

@@ -68,17 +68,19 @@ export type Change6Month = {
   percentage: number;
 };
 
-export const Trend = {
+export const AVMAnalysisResponseTrend = {
   Rising: "rising",
   Stable: "stable",
   Falling: "falling",
 } as const;
-export type Trend = OpenEnum<typeof Trend>;
+export type AVMAnalysisResponseTrend = OpenEnum<
+  typeof AVMAnalysisResponseTrend
+>;
 
 export type AVMAnalysisResponseSummary = {
   change12Month?: Change12Month | undefined;
   change6Month?: Change6Month | undefined;
-  trend: Trend;
+  trend: AVMAnalysisResponseTrend;
 };
 
 /**
@@ -322,8 +324,11 @@ export function change6MonthFromJSON(
 }
 
 /** @internal */
-export const Trend$inboundSchema: z.ZodType<Trend, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Trend);
+export const AVMAnalysisResponseTrend$inboundSchema: z.ZodType<
+  AVMAnalysisResponseTrend,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AVMAnalysisResponseTrend);
 
 /** @internal */
 export const AVMAnalysisResponseSummary$inboundSchema: z.ZodType<
@@ -333,7 +338,7 @@ export const AVMAnalysisResponseSummary$inboundSchema: z.ZodType<
 > = z.object({
   change12Month: z.lazy(() => Change12Month$inboundSchema).optional(),
   change6Month: z.lazy(() => Change6Month$inboundSchema).optional(),
-  trend: Trend$inboundSchema,
+  trend: AVMAnalysisResponseTrend$inboundSchema,
 });
 
 export function avmAnalysisResponseSummaryFromJSON(

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/extendedstatsaggregationresult.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Standard deviation bounds (±2σ from mean). Null if count is 0.
+ */
+export type StdDeviationBounds = {
+  lower: number | null;
+  lowerPopulation: number | null;
+  lowerSampling: number | null;
+  upper: number | null;
+  upperPopulation: number | null;
+  upperSampling: number | null;
+};
+
+export type ExtendedStatsAggregationResult = {
+  /**
+   * Mean value. Null if count is 0.
+   */
+  avg: number | null;
+  /**
+   * Number of documents with a non-null value
+   */
+  count: number;
+  /**
+   * Maximum value. Null if count is 0.
+   */
+  max: number | null;
+  /**
+   * Minimum value. Null if count is 0.
+   */
+  min: number | null;
+  /**
+   * Population standard deviation. Null if count is 0.
+   */
+  stdDeviation: number | null;
+  /**
+   * Standard deviation bounds (±2σ from mean). Null if count is 0.
+   */
+  stdDeviationBounds: StdDeviationBounds | null;
+  /**
+   * Population standard deviation. Null if count is 0.
+   */
+  stdDeviationPopulation: number | null;
+  /**
+   * Sample standard deviation. Null if count < 2.
+   */
+  stdDeviationSampling: number | null;
+  /**
+   * Sum of all values. Null if count is 0.
+   */
+  sum: number | null;
+  /**
+   * Sum of squared values. Null if count is 0.
+   */
+  sumOfSquares: number | null;
+  /**
+   * Population variance. Null if count is 0.
+   */
+  variance: number | null;
+  /**
+   * Population variance. Null if count is 0.
+   */
+  variancePopulation: number | null;
+  /**
+   * Sample variance (Bessel's correction). Null if count < 2.
+   */
+  varianceSampling: number | null;
+};
+
+/** @internal */
+export const StdDeviationBounds$inboundSchema: z.ZodType<
+  StdDeviationBounds,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lower: z.nullable(z.number()),
+  lower_population: z.nullable(z.number()),
+  lower_sampling: z.nullable(z.number()),
+  upper: z.nullable(z.number()),
+  upper_population: z.nullable(z.number()),
+  upper_sampling: z.nullable(z.number()),
+}).transform((v) => {
+  return remap$(v, {
+    "lower_population": "lowerPopulation",
+    "lower_sampling": "lowerSampling",
+    "upper_population": "upperPopulation",
+    "upper_sampling": "upperSampling",
+  });
+});
+
+export function stdDeviationBoundsFromJSON(
+  jsonString: string,
+): SafeParseResult<StdDeviationBounds, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StdDeviationBounds$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StdDeviationBounds' from JSON`,
+  );
+}
+
+/** @internal */
+export const ExtendedStatsAggregationResult$inboundSchema: z.ZodType<
+  ExtendedStatsAggregationResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  avg: z.nullable(z.number()),
+  count: z.number(),
+  max: z.nullable(z.number()),
+  min: z.nullable(z.number()),
+  std_deviation: z.nullable(z.number()),
+  std_deviation_bounds: z.nullable(
+    z.lazy(() => StdDeviationBounds$inboundSchema),
+  ),
+  std_deviation_population: z.nullable(z.number()),
+  std_deviation_sampling: z.nullable(z.number()),
+  sum: z.nullable(z.number()),
+  sum_of_squares: z.nullable(z.number()),
+  variance: z.nullable(z.number()),
+  variance_population: z.nullable(z.number()),
+  variance_sampling: z.nullable(z.number()),
+}).transform((v) => {
+  return remap$(v, {
+    "std_deviation": "stdDeviation",
+    "std_deviation_bounds": "stdDeviationBounds",
+    "std_deviation_population": "stdDeviationPopulation",
+    "std_deviation_sampling": "stdDeviationSampling",
+    "sum_of_squares": "sumOfSquares",
+    "variance_population": "variancePopulation",
+    "variance_sampling": "varianceSampling",
+  });
+});
+
+export function extendedStatsAggregationResultFromJSON(
+  jsonString: string,
+): SafeParseResult<ExtendedStatsAggregationResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExtendedStatsAggregationResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExtendedStatsAggregationResult' from JSON`,
+  );
+}

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

@@ -8,6 +8,7 @@ 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,8 +37,11 @@ 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";
 export * from "./geographiccontext.js";
 export * from "./healthresponse.js";
 export * from "./histogramaggregationresult.js";
@@ -57,6 +61,7 @@ export * from "./officerlistresponse.js";
 export * from "./officerresponse.js";
 export * from "./officersummary.js";
 export * from "./outcodelookupresponse.js";
+export * from "./percentilesaggregationresult.js";
 export * from "./person.js";
 export * from "./personcluster.js";
 export * from "./personclusterresponse.js";
@@ -124,11 +129,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";
@@ -150,4 +157,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/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/percentilesaggregationresult.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 PercentilesAggregationResult = {
+  /**
+   * Percentile values keyed by percentile (e.g. '25.0' → 150.5). Null when no documents match.
+   */
+  values: { [k: string]: number | null };
+};
+
+/** @internal */
+export const PercentilesAggregationResult$inboundSchema: z.ZodType<
+  PercentilesAggregationResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  values: z.record(z.nullable(z.number())),
+});
+
+export function percentilesAggregationResultFromJSON(
+  jsonString: string,
+): SafeParseResult<PercentilesAggregationResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PercentilesAggregationResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PercentilesAggregationResult' from JSON`,
+  );
+}