@vepler/sdk 2.133.0 → 2.138.0

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

@@ -0,0 +1,121 @@
+/*
+ * 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";
+import {
+  ExtractionCitation,
+  ExtractionCitation$inboundSchema,
+} from "./extractioncitation.js";
+
+/**
+ * Legal name of the party (organisation or individual).
+ */
+export type Name = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Role of a party to the s106 deed.
+ */
+export const PlanningS106PartyValue = {
+  Council: "council",
+  Applicant: "applicant",
+  Landowner: "landowner",
+  Mortgagee: "mortgagee",
+  Leaseholder: "leaseholder",
+  Other: "other",
+} as const;
+/**
+ * Role of a party to the s106 deed.
+ */
+export type PlanningS106PartyValue = OpenEnum<typeof PlanningS106PartyValue>;
+
+export type Role = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  /**
+   * Role of a party to the s106 deed.
+   */
+  value: PlanningS106PartyValue;
+};
+
+export type PlanningS106Party = {
+  /**
+   * Legal name of the party (organisation or individual).
+   */
+  name: Name;
+  role: Role;
+};
+
+/** @internal */
+export const Name$inboundSchema: z.ZodType<Name, z.ZodTypeDef, unknown> = z
+  .object({
+    citation: z.nullable(ExtractionCitation$inboundSchema),
+    value: z.string(),
+  });
+
+export function nameFromJSON(
+  jsonString: string,
+): SafeParseResult<Name, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Name$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Name' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningS106PartyValue$inboundSchema: z.ZodType<
+  PlanningS106PartyValue,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningS106PartyValue);
+
+/** @internal */
+export const Role$inboundSchema: z.ZodType<Role, z.ZodTypeDef, unknown> = z
+  .object({
+    citation: z.nullable(ExtractionCitation$inboundSchema),
+    value: PlanningS106PartyValue$inboundSchema,
+  });
+
+export function roleFromJSON(
+  jsonString: string,
+): SafeParseResult<Role, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Role$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Role' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningS106Party$inboundSchema: z.ZodType<
+  PlanningS106Party,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.lazy(() => Name$inboundSchema),
+  role: z.lazy(() => Role$inboundSchema),
+});
+
+export function planningS106PartyFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningS106Party, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningS106Party$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningS106Party' from JSON`,
+  );
+}

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

@@ -24,6 +24,10 @@ export type Provenance = {
    * ISO datetime when Vepler published this snapshot
    */
   publishedAt: string;
+  /**
+   * Version of the shared scoring contract that produced this response's score/band. Present on air-quality envelopes; lets a consumer detect a substrate (/query) vs overlay (/point) scoring-table mismatch.
+   */
+  scoringContractVersion?: string | undefined;
   /**
    * Identifier of the publish snapshot that produced this response
    */
@@ -43,6 +47,7 @@ export const Provenance$inboundSchema: z.ZodType<
   asOf: z.string().optional(),
   productVersion: z.string(),
   publishedAt: z.string(),
+  scoringContractVersion: z.string().optional(),
   snapshotId: z.string(),
   sources: z.array(DataSourceRef$inboundSchema),
 });

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

@@ -7,6 +7,10 @@ import { safeParse } from "../../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { AuthorityRef, AuthorityRef$inboundSchema } from "./authorityref.js";
+import {
+  RegulatoryZoneCharges,
+  RegulatoryZoneCharges$inboundSchema,
+} from "./regulatoryzonecharges.js";
 
 /**
  * Government-defined polygon designation, scheme-discriminated
@@ -16,6 +20,10 @@ export type RegulatoryZone = {
    * Reference to an administrative authority
    */
   authority?: AuthorityRef | undefined;
+  /**
+   * Charging / penalty schedule for zones that levy one — CAZ, ULEZ, LEZ, ZEZ, and international equivalents (Umweltzone, Crit'Air). Absent for non-charging designations such as AQMAs and flood zones.
+   */
+  charges?: RegulatoryZoneCharges | undefined;
   /**
    * Scheme-specific classification — e.g. 'Class D' for CAZ, 'PM2.5 nonattainment' for US
    */
@@ -65,6 +73,7 @@ export const RegulatoryZone$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   authority: AuthorityRef$inboundSchema.optional(),
+  charges: RegulatoryZoneCharges$inboundSchema.optional(),
   classification: z.string().optional(),
   code: z.string().optional(),
   declaredPollutants: z.array(z.string()).optional(),

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

@@ -0,0 +1,49 @@
+/*
+ * 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 RegulatoryZoneChargeRate = {
+  /**
+   * Charge in GBP; null if this class is exempt in this zone
+   */
+  chargeGbp: number | null;
+  /**
+   * Emission standard a vehicle must meet to avoid the charge
+   */
+  complianceStandard: string | null;
+  /**
+   * Escalation, weight bands, or tiering
+   */
+  notes?: string | null | undefined;
+  /**
+   * car, lgv, taxi, phv, hgv, bus_coach, minibus, motorcycle, or 'all'
+   */
+  vehicleClass: string;
+};
+
+/** @internal */
+export const RegulatoryZoneChargeRate$inboundSchema: z.ZodType<
+  RegulatoryZoneChargeRate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chargeGbp: z.nullable(z.number()),
+  complianceStandard: z.nullable(z.string()),
+  notes: z.nullable(z.string()).optional(),
+  vehicleClass: z.string(),
+});
+
+export function regulatoryZoneChargeRateFromJSON(
+  jsonString: string,
+): SafeParseResult<RegulatoryZoneChargeRate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RegulatoryZoneChargeRate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RegulatoryZoneChargeRate' from JSON`,
+  );
+}

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

@@ -0,0 +1,79 @@
+/*
+ * 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";
+import {
+  RegulatoryZoneChargeRate,
+  RegulatoryZoneChargeRate$inboundSchema,
+} from "./regulatoryzonechargerate.js";
+
+/**
+ * 'daily' = per-day charge for non-compliant entry (England CAZ, London ULEZ/LEZ, Oxford ZEZ); 'penalty' = fine for non-compliant entry, not pre-payable (Scottish LEZs)
+ */
+export const Model = {
+  Daily: "daily",
+  Penalty: "penalty",
+} as const;
+/**
+ * 'daily' = per-day charge for non-compliant entry (England CAZ, London ULEZ/LEZ, Oxford ZEZ); 'penalty' = fine for non-compliant entry, not pre-payable (Scottish LEZs)
+ */
+export type Model = OpenEnum<typeof Model>;
+
+/**
+ * Charging / penalty schedule for zones that levy one — CAZ, ULEZ, LEZ, ZEZ, and international equivalents (Umweltzone, Crit'Air). Absent for non-charging designations such as AQMAs and flood zones.
+ */
+export type RegulatoryZoneCharges = {
+  /**
+   * ISO date the rates were last verified against the source
+   */
+  asOf?: string | null | undefined;
+  /**
+   * 'daily' = per-day charge for non-compliant entry (England CAZ, London ULEZ/LEZ, Oxford ZEZ); 'penalty' = fine for non-compliant entry, not pre-payable (Scottish LEZs)
+   */
+  model: Model;
+  /**
+   * Per-vehicle-class charge lines
+   */
+  rates: Array<RegulatoryZoneChargeRate>;
+  /**
+   * Authority page the rates were curated from
+   */
+  source?: string | null | undefined;
+  /**
+   * Calendar year these rates are in force — the year of record
+   */
+  year: number;
+};
+
+/** @internal */
+export const Model$inboundSchema: z.ZodType<Model, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Model);
+
+/** @internal */
+export const RegulatoryZoneCharges$inboundSchema: z.ZodType<
+  RegulatoryZoneCharges,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  asOf: z.nullable(z.string()).optional(),
+  model: Model$inboundSchema,
+  rates: z.array(RegulatoryZoneChargeRate$inboundSchema),
+  source: z.nullable(z.string()).optional(),
+  year: z.number().int(),
+});
+
+export function regulatoryZoneChargesFromJSON(
+  jsonString: string,
+): SafeParseResult<RegulatoryZoneCharges, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RegulatoryZoneCharges$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RegulatoryZoneCharges' from JSON`,
+  );
+}

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

@@ -0,0 +1,202 @@
+/*
+ * 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 { ClosedEnum, OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  TransactionAddress,
+  TransactionAddress$inboundSchema,
+} from "./transactionaddress.js";
+import {
+  TransactionLocation,
+  TransactionLocation$inboundSchema,
+} from "./transactionlocation.js";
+import {
+  TransactionPrice,
+  TransactionPrice$inboundSchema,
+} from "./transactionprice.js";
+
+/**
+ * Transaction kind. 'sale': a completed sale/transfer. 'lease_grant': the grant of a new lease (premium).
+ */
+export const TransactionKind = {
+  Sale: "sale",
+  LeaseGrant: "lease_grant",
+} as const;
+/**
+ * Transaction kind. 'sale': a completed sale/transfer. 'lease_grant': the grant of a new lease (premium).
+ */
+export type TransactionKind = OpenEnum<typeof TransactionKind>;
+
+/**
+ * Lease detail; present only when kind is 'lease_grant'.
+ */
+export type TransactionLease = {
+  /**
+   * Lease commencement date, where derivable.
+   */
+  startDate?: Date | null | undefined;
+  /**
+   * Lease term verbatim from the register (e.g. '125 years from 11 February 2004').
+   */
+  termText: string | null;
+  /**
+   * Parsed lease length in years, where derivable.
+   */
+  termYears?: number | null | undefined;
+};
+
+/**
+ * Object type discriminator. Always 'transaction'.
+ */
+export const TransactionObject = {
+  Transaction: "transaction",
+} as const;
+/**
+ * Object type discriminator. Always 'transaction'.
+ */
+export type TransactionObject = ClosedEnum<typeof TransactionObject>;
+
+/**
+ * Canonical tenure of the transacted interest. Null when the source did not record a usable tenure.
+ */
+export const TransactionTenure = {
+  Freehold: "freehold",
+  Leasehold: "leasehold",
+} as const;
+/**
+ * Canonical tenure of the transacted interest. Null when the source did not record a usable tenure.
+ */
+export type TransactionTenure = OpenEnum<typeof TransactionTenure>;
+
+/**
+ * A standardised property transaction. All monetary values are in minor currency units.
+ */
+export type Transaction = {
+  address: TransactionAddress;
+  /**
+   * ISO 3166-1 alpha-2 country code.
+   */
+  country: string;
+  /**
+   * Completion (sale) or registration (lease grant) date.
+   */
+  date: Date;
+  /**
+   * Opaque composite id: {country}:{provider}:{externalId}.
+   */
+  id: string;
+  /**
+   * Transaction kind. 'sale': a completed sale/transfer. 'lease_grant': the grant of a new lease (premium).
+   */
+  kind: TransactionKind;
+  /**
+   * Lease detail; present only when kind is 'lease_grant'.
+   */
+  lease?: TransactionLease | null | undefined;
+  location?: TransactionLocation | null | undefined;
+  /**
+   * Whether the property was a new build at transaction.
+   */
+  newBuild?: boolean | null | undefined;
+  /**
+   * Object type discriminator. Always 'transaction'.
+   */
+  object: TransactionObject;
+  price: TransactionPrice;
+  /**
+   * Canonical property type.
+   */
+  propertyType: string;
+  /**
+   * Source registry identifier (permission-gated).
+   */
+  provider?: string | undefined;
+  /**
+   * Contributing data sources (permission-gated).
+   */
+  sources?: Array<string> | undefined;
+  /**
+   * Canonical tenure of the transacted interest. Null when the source did not record a usable tenure.
+   */
+  tenure: TransactionTenure | null;
+};
+
+/** @internal */
+export const TransactionKind$inboundSchema: z.ZodType<
+  TransactionKind,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TransactionKind);
+
+/** @internal */
+export const TransactionLease$inboundSchema: z.ZodType<
+  TransactionLease,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  startDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  termText: z.nullable(z.string()),
+  termYears: z.nullable(z.number()).optional(),
+});
+
+export function transactionLeaseFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionLease, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionLease$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionLease' from JSON`,
+  );
+}
+
+/** @internal */
+export const TransactionObject$inboundSchema: z.ZodNativeEnum<
+  typeof TransactionObject
+> = z.nativeEnum(TransactionObject);
+
+/** @internal */
+export const TransactionTenure$inboundSchema: z.ZodType<
+  TransactionTenure,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TransactionTenure);
+
+/** @internal */
+export const Transaction$inboundSchema: z.ZodType<
+  Transaction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address: TransactionAddress$inboundSchema,
+  country: z.string(),
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  id: z.string(),
+  kind: TransactionKind$inboundSchema,
+  lease: z.nullable(z.lazy(() => TransactionLease$inboundSchema)).optional(),
+  location: z.nullable(TransactionLocation$inboundSchema).optional(),
+  newBuild: z.nullable(z.boolean()).optional(),
+  object: TransactionObject$inboundSchema,
+  price: TransactionPrice$inboundSchema,
+  propertyType: z.string(),
+  provider: z.string().optional(),
+  sources: z.array(z.string()).optional(),
+  tenure: z.nullable(TransactionTenure$inboundSchema),
+});
+
+export function transactionFromJSON(
+  jsonString: string,
+): SafeParseResult<Transaction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Transaction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Transaction' from JSON`,
+  );
+}

package/src/sdk/models/shared/transactionaddress.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 TransactionAddress = {
+  county?: string | null | undefined;
+  district?: string | null | undefined;
+  /**
+   * Postcode inward code.
+   */
+  incode?: string | null | undefined;
+  locality?: string | null | undefined;
+  /**
+   * Postcode outward code.
+   */
+  outcode?: string | null | undefined;
+  /**
+   * Primary addressable object name (building number/name).
+   */
+  paon?: string | null | undefined;
+  /**
+   * Full postcode.
+   */
+  postcode?: string | null | undefined;
+  /**
+   * Secondary addressable object name (flat/unit).
+   */
+  saon?: string | null | undefined;
+  street?: string | null | undefined;
+  town?: string | null | undefined;
+};
+
+/** @internal */
+export const TransactionAddress$inboundSchema: z.ZodType<
+  TransactionAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  county: z.nullable(z.string()).optional(),
+  district: z.nullable(z.string()).optional(),
+  incode: z.nullable(z.string()).optional(),
+  locality: z.nullable(z.string()).optional(),
+  outcode: z.nullable(z.string()).optional(),
+  paon: z.nullable(z.string()).optional(),
+  postcode: z.nullable(z.string()).optional(),
+  saon: z.nullable(z.string()).optional(),
+  street: z.nullable(z.string()).optional(),
+  town: z.nullable(z.string()).optional(),
+});
+
+export function transactionAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionAddress' from JSON`,
+  );
+}

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

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  TransactionOutcodeArea,
+  TransactionOutcodeArea$Outbound,
+  TransactionOutcodeArea$outboundSchema,
+} from "./transactionoutcodearea.js";
+import {
+  TransactionPointArea,
+  TransactionPointArea$Outbound,
+  TransactionPointArea$outboundSchema,
+} from "./transactionpointarea.js";
+import {
+  TransactionPolygonArea,
+  TransactionPolygonArea$Outbound,
+  TransactionPolygonArea$outboundSchema,
+} from "./transactionpolygonarea.js";
+import {
+  TransactionPostcodeArea,
+  TransactionPostcodeArea$Outbound,
+  TransactionPostcodeArea$outboundSchema,
+} from "./transactionpostcodearea.js";
+
+/**
+ * A geographic area filter. Multiple areas are combined with OR.
+ */
+export type TransactionAreaFilter =
+  | TransactionPostcodeArea
+  | TransactionOutcodeArea
+  | TransactionPointArea
+  | TransactionPolygonArea;
+
+/** @internal */
+export type TransactionAreaFilter$Outbound =
+  | TransactionPostcodeArea$Outbound
+  | TransactionOutcodeArea$Outbound
+  | TransactionPointArea$Outbound
+  | TransactionPolygonArea$Outbound;
+
+/** @internal */
+export const TransactionAreaFilter$outboundSchema: z.ZodType<
+  TransactionAreaFilter$Outbound,
+  z.ZodTypeDef,
+  TransactionAreaFilter
+> = z.union([
+  TransactionPostcodeArea$outboundSchema,
+  TransactionOutcodeArea$outboundSchema,
+  TransactionPointArea$outboundSchema,
+  TransactionPolygonArea$outboundSchema,
+]);
+
+export function transactionAreaFilterToJSON(
+  transactionAreaFilter: TransactionAreaFilter,
+): string {
+  return JSON.stringify(
+    TransactionAreaFilter$outboundSchema.parse(transactionAreaFilter),
+  );
+}

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

@@ -0,0 +1,78 @@
+/*
+ * 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";
+
+/**
+ * WGS84 point [lon, lat].
+ */
+export type TransactionLocationPoint = {
+  lat: number;
+  lon: number;
+};
+
+export type TransactionLocation = {
+  /**
+   * UPRN match confidence (0–1).
+   */
+  confidence?: number | null | undefined;
+  /**
+   * WGS84 point [lon, lat].
+   */
+  point?: TransactionLocationPoint | null | undefined;
+  /**
+   * Matched internal property identifier.
+   */
+  propertyId?: string | null | undefined;
+  /**
+   * Matched UPRN, where resolved.
+   */
+  uprn?: number | null | undefined;
+};
+
+/** @internal */
+export const TransactionLocationPoint$inboundSchema: z.ZodType<
+  TransactionLocationPoint,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lon: z.number(),
+});
+
+export function transactionLocationPointFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionLocationPoint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionLocationPoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionLocationPoint' from JSON`,
+  );
+}
+
+/** @internal */
+export const TransactionLocation$inboundSchema: z.ZodType<
+  TransactionLocation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  confidence: z.nullable(z.number()).optional(),
+  point: z.nullable(z.lazy(() => TransactionLocationPoint$inboundSchema))
+    .optional(),
+  propertyId: z.nullable(z.string()).optional(),
+  uprn: z.nullable(z.number()).optional(),
+});
+
+export function transactionLocationFromJSON(
+  jsonString: string,
+): SafeParseResult<TransactionLocation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransactionLocation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransactionLocation' from JSON`,
+  );
+}