@vepler/sdk 2.131.2 → 2.133.0

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

@@ -0,0 +1,61 @@
+/*
+ * 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 AirQualityCoordinate = {
+  /**
+   * Latitude in WGS84
+   */
+  lat: number;
+  /**
+   * Longitude in WGS84
+   */
+  lon: number;
+};
+
+/** @internal */
+export const AirQualityCoordinate$inboundSchema: z.ZodType<
+  AirQualityCoordinate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lon: z.number(),
+});
+/** @internal */
+export type AirQualityCoordinate$Outbound = {
+  lat: number;
+  lon: number;
+};
+
+/** @internal */
+export const AirQualityCoordinate$outboundSchema: z.ZodType<
+  AirQualityCoordinate$Outbound,
+  z.ZodTypeDef,
+  AirQualityCoordinate
+> = z.object({
+  lat: z.number(),
+  lon: z.number(),
+});
+
+export function airQualityCoordinateToJSON(
+  airQualityCoordinate: AirQualityCoordinate,
+): string {
+  return JSON.stringify(
+    AirQualityCoordinate$outboundSchema.parse(airQualityCoordinate),
+  );
+}
+export function airQualityCoordinateFromJSON(
+  jsonString: string,
+): SafeParseResult<AirQualityCoordinate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AirQualityCoordinate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityCoordinate' from JSON`,
+  );
+}

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

@@ -0,0 +1,116 @@
+/*
+ * 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 {
+  AirQualityDecayCalibration,
+  AirQualityDecayCalibration$inboundSchema,
+} from "./airqualitydecaycalibration.js";
+import {
+  AirQualityDecayPollutantBreakdown,
+  AirQualityDecayPollutantBreakdown$inboundSchema,
+} from "./airqualitydecaypollutantbreakdown.js";
+
+/**
+ * Per-pollutant calculation trail (explain mode only)
+ */
+export type Pollutants = {
+  no2?: AirQualityDecayPollutantBreakdown | undefined;
+  ozone?: AirQualityDecayPollutantBreakdown | undefined;
+  pm10?: AirQualityDecayPollutantBreakdown | undefined;
+  pm25?: AirQualityDecayPollutantBreakdown | undefined;
+  so2?: AirQualityDecayPollutantBreakdown | undefined;
+};
+
+export type Calculation = {
+  /**
+   * Per-pollutant calculation trail (explain mode only)
+   */
+  pollutants: Pollutants;
+};
+
+export type AirQualityDecay = {
+  /**
+   * Whether the decay overlay was applied to this response
+   */
+  applied: true;
+  calculation?: Calculation | undefined;
+  calibration: AirQualityDecayCalibration;
+  /**
+   * Decay model identifier — e.g. 'v1', 'passthrough'
+   */
+  model: string;
+  /**
+   * Semantic version of the model
+   */
+  modelVersion: string;
+};
+
+/** @internal */
+export const Pollutants$inboundSchema: z.ZodType<
+  Pollutants,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  no2: AirQualityDecayPollutantBreakdown$inboundSchema.optional(),
+  ozone: AirQualityDecayPollutantBreakdown$inboundSchema.optional(),
+  pm10: AirQualityDecayPollutantBreakdown$inboundSchema.optional(),
+  pm25: AirQualityDecayPollutantBreakdown$inboundSchema.optional(),
+  so2: AirQualityDecayPollutantBreakdown$inboundSchema.optional(),
+});
+
+export function pollutantsFromJSON(
+  jsonString: string,
+): SafeParseResult<Pollutants, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Pollutants$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Pollutants' from JSON`,
+  );
+}
+
+/** @internal */
+export const Calculation$inboundSchema: z.ZodType<
+  Calculation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pollutants: z.lazy(() => Pollutants$inboundSchema),
+});
+
+export function calculationFromJSON(
+  jsonString: string,
+): SafeParseResult<Calculation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Calculation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Calculation' from JSON`,
+  );
+}
+
+/** @internal */
+export const AirQualityDecay$inboundSchema: z.ZodType<
+  AirQualityDecay,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  applied: z.literal(true),
+  calculation: z.lazy(() => Calculation$inboundSchema).optional(),
+  calibration: AirQualityDecayCalibration$inboundSchema,
+  model: z.string(),
+  modelVersion: z.string(),
+});
+
+export function airQualityDecayFromJSON(
+  jsonString: string,
+): SafeParseResult<AirQualityDecay, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AirQualityDecay$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityDecay' from JSON`,
+  );
+}

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

@@ -0,0 +1,80 @@
+/*
+ * 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 ResidualStats = {
+  /**
+   * 95% confidence interval, %
+   */
+  ci95Pct: number;
+  /**
+   * Residual stddev, µg/m³
+   */
+  stddev: number;
+};
+
+export type AirQualityDecayCalibration = {
+  /**
+   * ISO date of last fit
+   */
+  fittedAt: string;
+  /**
+   * AURN snapshot identifier used
+   */
+  groundTruthSource: string;
+  /**
+   * Per-pollutant fit residuals — drives confidence bands
+   */
+  residualStats: { [k: string]: ResidualStats };
+  /**
+   * Number of stations included
+   */
+  stations: number;
+};
+
+/** @internal */
+export const ResidualStats$inboundSchema: z.ZodType<
+  ResidualStats,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ci95Pct: z.number(),
+  stddev: z.number(),
+});
+
+export function residualStatsFromJSON(
+  jsonString: string,
+): SafeParseResult<ResidualStats, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ResidualStats$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ResidualStats' from JSON`,
+  );
+}
+
+/** @internal */
+export const AirQualityDecayCalibration$inboundSchema: z.ZodType<
+  AirQualityDecayCalibration,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fittedAt: z.string(),
+  groundTruthSource: z.string(),
+  residualStats: z.record(z.lazy(() => ResidualStats$inboundSchema)),
+  stations: z.number().int(),
+});
+
+export function airQualityDecayCalibrationFromJSON(
+  jsonString: string,
+): SafeParseResult<AirQualityDecayCalibration, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AirQualityDecayCalibration$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityDecayCalibration' from JSON`,
+  );
+}

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

@@ -0,0 +1,90 @@
+/*
+ * 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 DecayInputs = {
+  decayLength: number | null;
+  roadAadt: number | null;
+  roadClass: string | null;
+  roadDistanceM: number | null;
+};
+
+export type AirQualityDecayPollutantBreakdown = {
+  /**
+   * PCM 1km background, µg/m³
+   */
+  background: number;
+  decayInputs: DecayInputs;
+  /**
+   * Combined installation plume contribution, µg/m³
+   */
+  installationContribution: number;
+  /**
+   * Motorway contribution, µg/m³
+   */
+  motorwayContribution: number;
+  /**
+   * Road link contribution, µg/m³
+   */
+  roadContribution: number;
+  /**
+   * Final property-level concentration, µg/m³
+   */
+  total: number;
+  /**
+   * Zone-membership adjustment, µg/m³
+   */
+  zoneModifier: number;
+};
+
+/** @internal */
+export const DecayInputs$inboundSchema: z.ZodType<
+  DecayInputs,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  decayLength: z.nullable(z.number()),
+  roadAadt: z.nullable(z.number()),
+  roadClass: z.nullable(z.string()),
+  roadDistanceM: z.nullable(z.number()),
+});
+
+export function decayInputsFromJSON(
+  jsonString: string,
+): SafeParseResult<DecayInputs, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DecayInputs$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DecayInputs' from JSON`,
+  );
+}
+
+/** @internal */
+export const AirQualityDecayPollutantBreakdown$inboundSchema: z.ZodType<
+  AirQualityDecayPollutantBreakdown,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  background: z.number(),
+  decayInputs: z.lazy(() => DecayInputs$inboundSchema),
+  installationContribution: z.number(),
+  motorwayContribution: z.number(),
+  roadContribution: z.number(),
+  total: z.number(),
+  zoneModifier: z.number(),
+});
+
+export function airQualityDecayPollutantBreakdownFromJSON(
+  jsonString: string,
+): SafeParseResult<AirQualityDecayPollutantBreakdown, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AirQualityDecayPollutantBreakdown$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityDecayPollutantBreakdown' from JSON`,
+  );
+}

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

@@ -6,6 +6,9 @@ import * as z from "zod/v3";
 import * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
 
+/**
+ * Source category contributing the largest share of pollution at this cell
+ */
 export const AirQualityDominantSource = {
   RoadTransport: "roadTransport",
   Domestic: "domestic",
@@ -14,6 +17,9 @@ export const AirQualityDominantSource = {
   Agriculture: "agriculture",
   Other: "other",
 } as const;
+/**
+ * Source category contributing the largest share of pollution at this cell
+ */
 export type AirQualityDominantSource = OpenEnum<
   typeof AirQualityDominantSource
 >;

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

@@ -0,0 +1,45 @@
+/*
+ * 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 {
+  AirQualityDecayedExposure,
+  AirQualityDecayedExposure$inboundSchema,
+} from "./airqualitydecayedexposure.js";
+import {
+  AirQualityExposureBand,
+  AirQualityExposureBand$inboundSchema,
+} from "./airqualityexposureband.js";
+
+export type AirQualityExposure = {
+  band: AirQualityExposureBand;
+  decayed?: AirQualityDecayedExposure | undefined;
+  radiusM: number;
+  withinRadiusCount: number;
+};
+
+/** @internal */
+export const AirQualityExposure$inboundSchema: z.ZodType<
+  AirQualityExposure,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  band: AirQualityExposureBand$inboundSchema,
+  decayed: AirQualityDecayedExposure$inboundSchema.optional(),
+  radiusM: z.number().int(),
+  withinRadiusCount: z.number().int(),
+});
+
+export function airQualityExposureFromJSON(
+  jsonString: string,
+): SafeParseResult<AirQualityExposure, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AirQualityExposure$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityExposure' from JSON`,
+  );
+}

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

@@ -41,7 +41,13 @@ export type AirQualityFilters = {
    * Match only cells inside / outside a CAZ/ULEZ/LEZ
    */
   insideVehicleEmissionZone?: boolean | undefined;
+  /**
+   * Upper bound on platform 0-100 score (higher = better air quality)
+   */
   scoreMax?: number | undefined;
+  /**
+   * Lower bound on platform 0-100 score (higher = better air quality)
+   */
   scoreMin?: number | undefined;
 };
 

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

@@ -6,34 +6,148 @@ 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 {
-  AirQualityNearestInstallation,
-  AirQualityNearestInstallation$inboundSchema,
-} from "./airqualitynearestinstallation.js";
 import {
   AirQualityTopRelease,
   AirQualityTopRelease$inboundSchema,
 } from "./airqualitytoprelease.js";
-import {
-  AirQualityWithinRadius,
-  AirQualityWithinRadius$inboundSchema,
-} from "./airqualitywithinradius.js";
+import { Regulator, Regulator$inboundSchema } from "./regulator.js";
+
+export type Items = {
+  /**
+   * Compass bearing to the feature, degrees from true north (0-360)
+   */
+  bearingDeg?: number | undefined;
+  /**
+   * Optional ComplianceStatus[] entries — EA OPRA bands today, framework-tagged so other regulators slot in without breaking consumers.
+   */
+  compliance?: Array<any> | undefined;
+  /**
+   * Distance to the feature in metres
+   */
+  distanceM: number;
+  operator: string | null;
+  /**
+   * Regulator permit / licence reference
+   */
+  permitReference: string;
+  /**
+   * Reference to a statutory regulator
+   */
+  regulator: Regulator;
+  sector: string | null;
+};
+
+/**
+ * Top-N nearest features in a radius, with honest cap signalling
+ */
+export type Nearby = {
+  /**
+   * Maximum number of items returned (top-N cap)
+   */
+  capacity: number;
+  /**
+   * True when count exceeded capacity and additional matches were dropped
+   */
+  capped: boolean;
+  /**
+   * Actual number of features matched before the cap was applied
+   */
+  count: number;
+  /**
+   * Features sorted by distance ascending
+   */
+  items: Array<Items>;
+  /**
+   * Search radius in metres
+   */
+  radiusM: number;
+};
+
+export type WithinRadius = {
+  count: number;
+  radiusM: number;
+};
 
 export type AirQualityInstallations = {
-  nearest: AirQualityNearestInstallation | null;
+  /**
+   * Top-N nearest features in a radius, with honest cap signalling
+   */
+  nearby?: Nearby | undefined;
   topReleases: Array<AirQualityTopRelease>;
-  withinRadius: AirQualityWithinRadius;
+  withinRadius: WithinRadius;
 };
 
+/** @internal */
+export const Items$inboundSchema: z.ZodType<Items, z.ZodTypeDef, unknown> = z
+  .object({
+    bearingDeg: z.number().optional(),
+    compliance: z.array(z.any()).optional(),
+    distanceM: z.number(),
+    operator: z.nullable(z.string()),
+    permitReference: z.string(),
+    regulator: Regulator$inboundSchema,
+    sector: z.nullable(z.string()),
+  });
+
+export function itemsFromJSON(
+  jsonString: string,
+): SafeParseResult<Items, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Items$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Items' from JSON`,
+  );
+}
+
+/** @internal */
+export const Nearby$inboundSchema: z.ZodType<Nearby, z.ZodTypeDef, unknown> = z
+  .object({
+    capacity: z.number().int(),
+    capped: z.boolean(),
+    count: z.number().int(),
+    items: z.array(z.lazy(() => Items$inboundSchema)),
+    radiusM: z.number(),
+  });
+
+export function nearbyFromJSON(
+  jsonString: string,
+): SafeParseResult<Nearby, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Nearby$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Nearby' from JSON`,
+  );
+}
+
+/** @internal */
+export const WithinRadius$inboundSchema: z.ZodType<
+  WithinRadius,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  radiusM: z.number().int(),
+});
+
+export function withinRadiusFromJSON(
+  jsonString: string,
+): SafeParseResult<WithinRadius, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WithinRadius$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WithinRadius' from JSON`,
+  );
+}
+
 /** @internal */
 export const AirQualityInstallations$inboundSchema: z.ZodType<
   AirQualityInstallations,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  nearest: z.nullable(AirQualityNearestInstallation$inboundSchema),
+  nearby: z.lazy(() => Nearby$inboundSchema).optional(),
   topReleases: z.array(AirQualityTopRelease$inboundSchema),
-  withinRadius: AirQualityWithinRadius$inboundSchema,
+  withinRadius: z.lazy(() => WithinRadius$inboundSchema),
 });
 
 export function airQualityInstallationsFromJSON(