@vepler/sdk 2.131.0 → 2.133.0

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

@@ -0,0 +1,134 @@
+/*
+ * 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";
+
+/**
+ * Per-vehicle-class AADT breakdown if available
+ */
+export type AadtBreakdown = {
+  bus: number | null;
+  cars: number | null;
+  hgv: number | null;
+  lgv: number | null;
+  motorcycle: number | null;
+};
+
+/**
+ * Roadside concentrations at the count point
+ */
+export type Roadside = {
+  no2Ugm3: number | null;
+  pm10Ugm3: number | null;
+  pm25Ugm3: number | null;
+};
+
+export type AirQualityNearestRoad = {
+  /**
+   * Annual Average Daily Flow — all-motor-vehicle count from DfT. Surfaced by `/point` overlay; cell substrate omits it when only PCM census data is available.
+   */
+  aadt?: number | null | undefined;
+  /**
+   * Per-vehicle-class AADT breakdown if available
+   */
+  aadtBreakdown?: AadtBreakdown | null | undefined;
+  /**
+   * Compass bearing to the feature, degrees from true north (0-360)
+   */
+  bearingDeg?: number | undefined;
+  /**
+   * Distance to the feature in metres
+   */
+  distanceM: number;
+  /**
+   * Road classification — 'M' (motorway), 'A(M)' (A-road with motorway restrictions), 'A', 'B', 'C', 'U'
+   */
+  roadClass: string;
+  /**
+   * Road designation (e.g. 'A40', 'M25', 'A100(M)')
+   */
+  roadNumber: string;
+  /**
+   * Roadside concentrations at the count point
+   */
+  roadside: Roadside;
+  /**
+   * Reporting year of the roadside observation
+   */
+  year: number;
+};
+
+/** @internal */
+export const AadtBreakdown$inboundSchema: z.ZodType<
+  AadtBreakdown,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bus: z.nullable(z.number().int()),
+  cars: z.nullable(z.number().int()),
+  hgv: z.nullable(z.number().int()),
+  lgv: z.nullable(z.number().int()),
+  motorcycle: z.nullable(z.number().int()),
+});
+
+export function aadtBreakdownFromJSON(
+  jsonString: string,
+): SafeParseResult<AadtBreakdown, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AadtBreakdown$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AadtBreakdown' from JSON`,
+  );
+}
+
+/** @internal */
+export const Roadside$inboundSchema: z.ZodType<
+  Roadside,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  no2Ugm3: z.nullable(z.number()),
+  pm10Ugm3: z.nullable(z.number()),
+  pm25Ugm3: z.nullable(z.number()),
+});
+
+export function roadsideFromJSON(
+  jsonString: string,
+): SafeParseResult<Roadside, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Roadside$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Roadside' from JSON`,
+  );
+}
+
+/** @internal */
+export const AirQualityNearestRoad$inboundSchema: z.ZodType<
+  AirQualityNearestRoad,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  aadt: z.nullable(z.number().int()).optional(),
+  aadtBreakdown: z.nullable(z.lazy(() => AadtBreakdown$inboundSchema))
+    .optional(),
+  bearingDeg: z.number().optional(),
+  distanceM: z.number(),
+  roadClass: z.string(),
+  roadNumber: z.string(),
+  roadside: z.lazy(() => Roadside$inboundSchema),
+  year: z.number().int(),
+});
+
+export function airQualityNearestRoadFromJSON(
+  jsonString: string,
+): SafeParseResult<AirQualityNearestRoad, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AirQualityNearestRoad$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityNearestRoad' from JSON`,
+  );
+}

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

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Decay model version. Today: 'v1' (exponential Karner-2010, AURN-calibrated). Future: 'adms-lite', 'laei-20m'.
+ */
+export const DecayModel = {
+  V1: "v1",
+} as const;
+/**
+ * Decay model version. Today: 'v1' (exponential Karner-2010, AURN-calibrated). Future: 'adms-lite', 'laei-20m'.
+ */
+export type DecayModel = ClosedEnum<typeof DecayModel>;
+
+export type AirQualityPointOptions = {
+  /**
+   * Apply property-decay overlay. When false, returns the cell envelope unchanged — useful when the caller only needs cell substrate data.
+   */
+  decay?: boolean | undefined;
+  /**
+   * Decay model version. Today: 'v1' (exponential Karner-2010, AURN-calibrated). Future: 'adms-lite', 'laei-20m'.
+   */
+  decayModel?: DecayModel | undefined;
+  /**
+   * Include per-pollutant calculation trail under `decay.calculation`. Premium-gated.
+   */
+  explain?: boolean | undefined;
+};
+
+/** @internal */
+export const DecayModel$outboundSchema: z.ZodNativeEnum<typeof DecayModel> = z
+  .nativeEnum(DecayModel);
+
+/** @internal */
+export type AirQualityPointOptions$Outbound = {
+  decay: boolean;
+  decayModel: string;
+  explain: boolean;
+};
+
+/** @internal */
+export const AirQualityPointOptions$outboundSchema: z.ZodType<
+  AirQualityPointOptions$Outbound,
+  z.ZodTypeDef,
+  AirQualityPointOptions
+> = z.object({
+  decay: z.boolean().default(true),
+  decayModel: DecayModel$outboundSchema.default("v1"),
+  explain: z.boolean().default(false),
+});
+
+export function airQualityPointOptionsToJSON(
+  airQualityPointOptions: AirQualityPointOptions,
+): string {
+  return JSON.stringify(
+    AirQualityPointOptions$outboundSchema.parse(airQualityPointOptions),
+  );
+}

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

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  AirQualityCoordinate,
+  AirQualityCoordinate$Outbound,
+  AirQualityCoordinate$outboundSchema,
+} from "./airqualitycoordinate.js";
+import {
+  AirQualityPointOptions,
+  AirQualityPointOptions$Outbound,
+  AirQualityPointOptions$outboundSchema,
+} from "./airqualitypointoptions.js";
+
+/**
+ * Comma-separated list or array. Restricts response fields. Default = all standard-tier attributes (summary, pollutants, regulatoryZones, provenance, healthImpact, propertyValueImpact).
+ */
+export type Attributes = string | Array<string>;
+
+export type AirQualityPointRequest = {
+  /**
+   * Comma-separated list or array. Restricts response fields. Default = all standard-tier attributes (summary, pollutants, regulatoryZones, provenance, healthImpact, propertyValueImpact).
+   */
+  attributes?: string | Array<string> | undefined;
+  coordinate: AirQualityCoordinate;
+  options?: AirQualityPointOptions | undefined;
+  /**
+   * Pin to specific snapshot. Default = latest published.
+   */
+  snapshotId?: string | undefined;
+  /**
+   * Enable billing tracking telemetry
+   */
+  track?: boolean | undefined;
+};
+
+/** @internal */
+export type Attributes$Outbound = string | Array<string>;
+
+/** @internal */
+export const Attributes$outboundSchema: z.ZodType<
+  Attributes$Outbound,
+  z.ZodTypeDef,
+  Attributes
+> = z.union([z.string(), z.array(z.string())]);
+
+export function attributesToJSON(attributes: Attributes): string {
+  return JSON.stringify(Attributes$outboundSchema.parse(attributes));
+}
+
+/** @internal */
+export type AirQualityPointRequest$Outbound = {
+  attributes?: string | Array<string> | undefined;
+  coordinate: AirQualityCoordinate$Outbound;
+  options?: AirQualityPointOptions$Outbound | undefined;
+  snapshotId?: string | undefined;
+  track: boolean;
+};
+
+/** @internal */
+export const AirQualityPointRequest$outboundSchema: z.ZodType<
+  AirQualityPointRequest$Outbound,
+  z.ZodTypeDef,
+  AirQualityPointRequest
+> = z.object({
+  attributes: z.union([z.string(), z.array(z.string())]).optional(),
+  coordinate: AirQualityCoordinate$outboundSchema,
+  options: AirQualityPointOptions$outboundSchema.optional(),
+  snapshotId: z.string().optional(),
+  track: z.boolean().default(false),
+});
+
+export function airQualityPointRequestToJSON(
+  airQualityPointRequest: AirQualityPointRequest,
+): string {
+  return JSON.stringify(
+    AirQualityPointRequest$outboundSchema.parse(airQualityPointRequest),
+  );
+}

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

@@ -0,0 +1,165 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AirQualityCoordinate,
+  AirQualityCoordinate$inboundSchema,
+} from "./airqualitycoordinate.js";
+import {
+  AirQualityDecay,
+  AirQualityDecay$inboundSchema,
+} from "./airqualitydecay.js";
+import {
+  AirQualityExposure,
+  AirQualityExposure$inboundSchema,
+} from "./airqualityexposure.js";
+import {
+  AirQualityInstallations,
+  AirQualityInstallations$inboundSchema,
+} from "./airqualityinstallations.js";
+import {
+  AirQualityNearestRoad,
+  AirQualityNearestRoad$inboundSchema,
+} from "./airqualitynearestroad.js";
+import {
+  AirQualityPollutants,
+  AirQualityPollutants$inboundSchema,
+} from "./airqualitypollutants.js";
+import {
+  AirQualityRegulatoryZoneMembership,
+  AirQualityRegulatoryZoneMembership$inboundSchema,
+} from "./airqualityregulatoryzonemembership.js";
+import {
+  AirQualitySummary,
+  AirQualitySummary$inboundSchema,
+} from "./airqualitysummary.js";
+import { Confidence, Confidence$inboundSchema } from "./confidence.js";
+import { HealthImpact, HealthImpact$inboundSchema } from "./healthimpact.js";
+import { OfficialIndex, OfficialIndex$inboundSchema } from "./officialindex.js";
+import {
+  PropertyValueImpact,
+  PropertyValueImpact$inboundSchema,
+} from "./propertyvalueimpact.js";
+import { Provenance, Provenance$inboundSchema } from "./provenance.js";
+
+export const AirQualityPointResponseType = {
+  Point: "Point",
+} as const;
+export type AirQualityPointResponseType = ClosedEnum<
+  typeof AirQualityPointResponseType
+>;
+
+export type AirQualityPointResponseCentroid = {
+  /**
+   * [longitude, latitude] in WGS84 — GeoJSON-spec order. Note: this is the stored shape; request area filters use [lat, lng] like other vepler-stack endpoints.
+   */
+  coordinates: Array<number>;
+  type: AirQualityPointResponseType;
+};
+
+export type AirQualityPointResponse = {
+  airQualityId: string;
+  cellId: string;
+  centroid: AirQualityPointResponseCentroid;
+  computedAt: Date;
+  /**
+   * Confidence assessment for a product response
+   */
+  confidence?: Confidence | undefined;
+  coordinate: AirQualityCoordinate;
+  decay: AirQualityDecay;
+  exposure?: AirQualityExposure | undefined;
+  /**
+   * Shared health-impact primitive populated from the cell's band. Always free — no premium gate.
+   */
+  healthImpact?: HealthImpact | undefined;
+  installations?: AirQualityInstallations | undefined;
+  nearestMotorway?: AirQualityNearestRoad | null | undefined;
+  nearestRoad?: AirQualityNearestRoad | null | undefined;
+  /**
+   * Government-defined indices co-surfaced alongside the platform score. Today: DAQI for GB cells. Future: WHO AQI, US AQI, CAQI, AQHI, SAFAR.
+   */
+  officialIndices?: Array<OfficialIndex> | undefined;
+  pollutants: AirQualityPollutants;
+  /**
+   * Shared property-value-impact primitive synthesised from band + AQMA + VEZ containment. Always free — no premium gate.
+   */
+  propertyValueImpact?: PropertyValueImpact | undefined;
+  /**
+   * Universal provenance block — every product envelope carries this
+   */
+  provenance: Provenance;
+  /**
+   * Flat list of regulator-defined zone memberships — AQMA, CAZ, ULEZ, LEZ, smoke control areas. Discriminated on `zone.system` (when inside) or `nearest.system` (when outside).
+   */
+  regulatoryZones?: Array<AirQualityRegulatoryZoneMembership> | undefined;
+  summary: AirQualitySummary;
+};
+
+/** @internal */
+export const AirQualityPointResponseType$inboundSchema: z.ZodNativeEnum<
+  typeof AirQualityPointResponseType
+> = z.nativeEnum(AirQualityPointResponseType);
+
+/** @internal */
+export const AirQualityPointResponseCentroid$inboundSchema: z.ZodType<
+  AirQualityPointResponseCentroid,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  coordinates: z.array(z.number()),
+  type: AirQualityPointResponseType$inboundSchema,
+});
+
+export function airQualityPointResponseCentroidFromJSON(
+  jsonString: string,
+): SafeParseResult<AirQualityPointResponseCentroid, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AirQualityPointResponseCentroid$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityPointResponseCentroid' from JSON`,
+  );
+}
+
+/** @internal */
+export const AirQualityPointResponse$inboundSchema: z.ZodType<
+  AirQualityPointResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  airQualityId: z.string(),
+  cellId: z.string(),
+  centroid: z.lazy(() => AirQualityPointResponseCentroid$inboundSchema),
+  computedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  confidence: Confidence$inboundSchema.optional(),
+  coordinate: AirQualityCoordinate$inboundSchema,
+  decay: AirQualityDecay$inboundSchema,
+  exposure: AirQualityExposure$inboundSchema.optional(),
+  healthImpact: HealthImpact$inboundSchema.optional(),
+  installations: AirQualityInstallations$inboundSchema.optional(),
+  nearestMotorway: z.nullable(AirQualityNearestRoad$inboundSchema).optional(),
+  nearestRoad: z.nullable(AirQualityNearestRoad$inboundSchema).optional(),
+  officialIndices: z.array(OfficialIndex$inboundSchema).optional(),
+  pollutants: AirQualityPollutants$inboundSchema,
+  propertyValueImpact: PropertyValueImpact$inboundSchema.optional(),
+  provenance: Provenance$inboundSchema,
+  regulatoryZones: z.array(AirQualityRegulatoryZoneMembership$inboundSchema)
+    .optional(),
+  summary: AirQualitySummary$inboundSchema,
+});
+
+export function airQualityPointResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AirQualityPointResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AirQualityPointResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityPointResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Per-pollutant band assigned independently of the overall summary band.
+ */
+export const AirQualityPollutantBand = {
+  VeryGood: "very_good",
+  Good: "good",
+  Moderate: "moderate",
+  Poor: "poor",
+  VeryPoor: "very_poor",
+} as const;
+/**
+ * Per-pollutant band assigned independently of the overall summary band.
+ */
+export type AirQualityPollutantBand = OpenEnum<typeof AirQualityPollutantBand>;
+
+/** @internal */
+export const AirQualityPollutantBand$inboundSchema: z.ZodType<
+  AirQualityPollutantBand,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AirQualityPollutantBand);

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

@@ -7,23 +7,41 @@ import { safeParse } from "../../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  AirQualityLimitComparison,
-  AirQualityLimitComparison$inboundSchema,
-} from "./airqualitylimitcomparison.js";
+  AirQualityPollutantBand,
+  AirQualityPollutantBand$inboundSchema,
+} from "./airqualitypollutantband.js";
+import {
+  AirQualityPollutantCode,
+  AirQualityPollutantCode$inboundSchema,
+} from "./airqualitypollutantcode.js";
 import {
   AirQualityPollutantConcentration,
   AirQualityPollutantConcentration$inboundSchema,
 } from "./airqualitypollutantconcentration.js";
 import {
-  AirQualityPollutantTrend,
-  AirQualityPollutantTrend$inboundSchema,
-} from "./airqualitypollutanttrend.js";
+  ComplianceStatus,
+  ComplianceStatus$inboundSchema,
+} from "./compliancestatus.js";
+import { Trend, Trend$inboundSchema } from "./trend.js";
 
 export type AirQualityPollutantBlock = {
+  /**
+   * Per-pollutant band assigned independently of the overall summary band.
+   */
+  band?: AirQualityPollutantBand | undefined;
+  /**
+   * Framework-tagged compliance checks. Today: UK_AQS_2010 + WHO_AQG_2021. Future frameworks slot in as additional array entries without schema change.
+   */
+  compliance: Array<ComplianceStatus>;
   concentration: AirQualityPollutantConcentration;
-  trend?: AirQualityPollutantTrend | undefined;
-  ukLimit: AirQualityLimitComparison;
-  whoGuideline: AirQualityLimitComparison;
+  /**
+   * Pollutant driving the band, when one dominates
+   */
+  pollutant: AirQualityPollutantCode;
+  /**
+   * Temporal trend on a score
+   */
+  trend?: Trend | undefined;
 };
 
 /** @internal */
@@ -32,10 +50,11 @@ export const AirQualityPollutantBlock$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  band: AirQualityPollutantBand$inboundSchema.optional(),
+  compliance: z.array(ComplianceStatus$inboundSchema),
   concentration: AirQualityPollutantConcentration$inboundSchema,
-  trend: AirQualityPollutantTrend$inboundSchema.optional(),
-  ukLimit: AirQualityLimitComparison$inboundSchema,
-  whoGuideline: AirQualityLimitComparison$inboundSchema,
+  pollutant: AirQualityPollutantCode$inboundSchema,
+  trend: Trend$inboundSchema.optional(),
 });
 
 export function airQualityPollutantBlockFromJSON(

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

@@ -6,6 +6,9 @@ import * as z from "zod/v3";
 import * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
 
+/**
+ * Pollutant driving the band, when one dominates
+ */
 export const AirQualityPollutantCode = {
   No2: "no2",
   Pm25: "pm25",
@@ -13,6 +16,9 @@ export const AirQualityPollutantCode = {
   Ozone: "ozone",
   So2: "so2",
 } as const;
+/**
+ * Pollutant driving the band, when one dominates
+ */
 export type AirQualityPollutantCode = OpenEnum<typeof AirQualityPollutantCode>;
 
 /** @internal */

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

@@ -20,9 +20,9 @@ import {
 } from "./airqualitysortfield.js";
 
 /**
- * Comma-separated string or array of top-level attributes to include. Reduces payload size on light queries. airQualityId / cellId / snapshotId / centroid are always included. Premium fields (`roadProximity`, `installations`) require the `air-quality:premium` permission.
+ * Comma-separated string or array of top-level attributes to include. Reduces payload size on light queries. airQualityId / cellId / centroid / computedAt are always included. Premium fields (`nearestRoad`, `nearestMotorway`, `installations`) require the `air-quality:premium` permission.
  */
-export type Attributes = string | Array<string>;
+export type AirQualityQueryRequestAttributes = string | Array<string>;
 
 export type AirQualityQueryRequest = {
   /**
@@ -30,12 +30,15 @@ export type AirQualityQueryRequest = {
    */
   area: Array<AirQualityAreaFilter>;
   /**
-   * Comma-separated string or array of top-level attributes to include. Reduces payload size on light queries. airQualityId / cellId / snapshotId / centroid are always included. Premium fields (`roadProximity`, `installations`) require the `air-quality:premium` permission.
+   * Comma-separated string or array of top-level attributes to include. Reduces payload size on light queries. airQualityId / cellId / centroid / computedAt are always included. Premium fields (`nearestRoad`, `nearestMotorway`, `installations`) require the `air-quality:premium` permission.
    */
   attributes?: string | Array<string> | undefined;
   filters?: AirQualityFilters | undefined;
   limit?: number | undefined;
   offset?: number | undefined;
+  /**
+   * Pin to a specific snapshot. When omitted, the latest published snapshot is used and echoed back on every result.
+   */
   snapshotId?: string | undefined;
   /**
    * Sort order. Default: distance ascending for single-point/postcode area filters, score ascending otherwise.
@@ -48,17 +51,23 @@ export type AirQualityQueryRequest = {
 };
 
 /** @internal */
-export type Attributes$Outbound = string | Array<string>;
+export type AirQualityQueryRequestAttributes$Outbound = string | Array<string>;
 
 /** @internal */
-export const Attributes$outboundSchema: z.ZodType<
-  Attributes$Outbound,
+export const AirQualityQueryRequestAttributes$outboundSchema: z.ZodType<
+  AirQualityQueryRequestAttributes$Outbound,
   z.ZodTypeDef,
-  Attributes
+  AirQualityQueryRequestAttributes
 > = z.union([z.string(), z.array(z.string())]);
 
-export function attributesToJSON(attributes: Attributes): string {
-  return JSON.stringify(Attributes$outboundSchema.parse(attributes));
+export function airQualityQueryRequestAttributesToJSON(
+  airQualityQueryRequestAttributes: AirQualityQueryRequestAttributes,
+): string {
+  return JSON.stringify(
+    AirQualityQueryRequestAttributes$outboundSchema.parse(
+      airQualityQueryRequestAttributes,
+    ),
+  );
 }
 
 /** @internal */