@vepler/sdk 2.133.0 → 2.137.0

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

@@ -0,0 +1,301 @@
+/*
+ * 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";
+
+/**
+ * Principal sum in GBP.
+ */
+export type AmountGBP = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * Indexation formula (e.g. 'BCIS All-in TPI'). Null when not indexed.
+ */
+export type IndexFormula = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Whether the sum is index-linked.
+ */
+export type Indexed = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: boolean;
+};
+
+/**
+ * Short name of the obligation (e.g. 'Affordable Housing Contribution').
+ */
+export type Label = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * What the money is for (e.g. 'off-site affordable housing').
+ */
+export type Purpose = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Specific recipient body when stated. Null when the council retains the funds.
+ */
+export type Recipient = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * When a financial obligation falls due.
+ */
+export const PlanningS106FinancialObligationValue = {
+  Commencement: "commencement",
+  FirstOccupation: "first_occupation",
+  PracticalCompletion: "practical_completion",
+  DefinedDate: "defined_date",
+  SignedDate: "signed_date",
+  Phased: "phased",
+  Other: "other",
+} as const;
+/**
+ * When a financial obligation falls due.
+ */
+export type PlanningS106FinancialObligationValue = OpenEnum<
+  typeof PlanningS106FinancialObligationValue
+>;
+
+export type TriggerEvent = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  /**
+   * When a financial obligation falls due.
+   */
+  value: PlanningS106FinancialObligationValue;
+};
+
+export type PlanningS106FinancialObligation = {
+  /**
+   * Principal sum in GBP.
+   */
+  amountGBP: AmountGBP;
+  /**
+   * Indexation formula (e.g. 'BCIS All-in TPI'). Null when not indexed.
+   */
+  indexFormula: IndexFormula | null;
+  /**
+   * Whether the sum is index-linked.
+   */
+  indexed: Indexed;
+  /**
+   * Short name of the obligation (e.g. 'Affordable Housing Contribution').
+   */
+  label: Label;
+  /**
+   * What the money is for (e.g. 'off-site affordable housing').
+   */
+  purpose: Purpose;
+  /**
+   * Specific recipient body when stated. Null when the council retains the funds.
+   */
+  recipient: Recipient | null;
+  triggerEvent: TriggerEvent;
+};
+
+/** @internal */
+export const AmountGBP$inboundSchema: z.ZodType<
+  AmountGBP,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function amountGBPFromJSON(
+  jsonString: string,
+): SafeParseResult<AmountGBP, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AmountGBP$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AmountGBP' from JSON`,
+  );
+}
+
+/** @internal */
+export const IndexFormula$inboundSchema: z.ZodType<
+  IndexFormula,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function indexFormulaFromJSON(
+  jsonString: string,
+): SafeParseResult<IndexFormula, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IndexFormula$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IndexFormula' from JSON`,
+  );
+}
+
+/** @internal */
+export const Indexed$inboundSchema: z.ZodType<Indexed, z.ZodTypeDef, unknown> =
+  z.object({
+    citation: z.nullable(ExtractionCitation$inboundSchema),
+    value: z.boolean(),
+  });
+
+export function indexedFromJSON(
+  jsonString: string,
+): SafeParseResult<Indexed, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Indexed$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Indexed' from JSON`,
+  );
+}
+
+/** @internal */
+export const Label$inboundSchema: z.ZodType<Label, z.ZodTypeDef, unknown> = z
+  .object({
+    citation: z.nullable(ExtractionCitation$inboundSchema),
+    value: z.string(),
+  });
+
+export function labelFromJSON(
+  jsonString: string,
+): SafeParseResult<Label, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Label$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Label' from JSON`,
+  );
+}
+
+/** @internal */
+export const Purpose$inboundSchema: z.ZodType<Purpose, z.ZodTypeDef, unknown> =
+  z.object({
+    citation: z.nullable(ExtractionCitation$inboundSchema),
+    value: z.string(),
+  });
+
+export function purposeFromJSON(
+  jsonString: string,
+): SafeParseResult<Purpose, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Purpose$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Purpose' from JSON`,
+  );
+}
+
+/** @internal */
+export const Recipient$inboundSchema: z.ZodType<
+  Recipient,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function recipientFromJSON(
+  jsonString: string,
+): SafeParseResult<Recipient, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Recipient$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Recipient' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningS106FinancialObligationValue$inboundSchema: z.ZodType<
+  PlanningS106FinancialObligationValue,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningS106FinancialObligationValue);
+
+/** @internal */
+export const TriggerEvent$inboundSchema: z.ZodType<
+  TriggerEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: PlanningS106FinancialObligationValue$inboundSchema,
+});
+
+export function triggerEventFromJSON(
+  jsonString: string,
+): SafeParseResult<TriggerEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TriggerEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TriggerEvent' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningS106FinancialObligation$inboundSchema: z.ZodType<
+  PlanningS106FinancialObligation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amountGBP: z.lazy(() => AmountGBP$inboundSchema),
+  indexFormula: z.nullable(z.lazy(() => IndexFormula$inboundSchema)),
+  indexed: z.lazy(() => Indexed$inboundSchema),
+  label: z.lazy(() => Label$inboundSchema),
+  purpose: z.lazy(() => Purpose$inboundSchema),
+  recipient: z.nullable(z.lazy(() => Recipient$inboundSchema)),
+  triggerEvent: z.lazy(() => TriggerEvent$inboundSchema),
+});
+
+export function planningS106FinancialObligationFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningS106FinancialObligation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningS106FinancialObligation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningS106FinancialObligation' from JSON`,
+  );
+}

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

@@ -0,0 +1,213 @@
+/*
+ * 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";
+
+/**
+ * Full text of the obligation clause.
+ */
+export type PlanningS106NonFinancialObligationBody = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Short name of the obligation (e.g. 'Travel Plan').
+ */
+export type PlanningS106NonFinancialObligationLabel = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Party who must perform a non-financial obligation.
+ */
+export const PlanningS106NonFinancialObligationValue = {
+  Applicant: "applicant",
+  Council: "council",
+  Owner: "owner",
+  Other: "other",
+} as const;
+/**
+ * Party who must perform a non-financial obligation.
+ */
+export type PlanningS106NonFinancialObligationValue = OpenEnum<
+  typeof PlanningS106NonFinancialObligationValue
+>;
+
+export type Party = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  /**
+   * Party who must perform a non-financial obligation.
+   */
+  value: PlanningS106NonFinancialObligationValue;
+};
+
+/**
+ * When the obligation must be performed (free text).
+ */
+export type PlanningS106NonFinancialObligationTriggerEvent = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+export type PlanningS106NonFinancialObligation = {
+  /**
+   * Full text of the obligation clause.
+   */
+  body: PlanningS106NonFinancialObligationBody;
+  /**
+   * Short name of the obligation (e.g. 'Travel Plan').
+   */
+  label: PlanningS106NonFinancialObligationLabel;
+  party: Party;
+  /**
+   * When the obligation must be performed (free text).
+   */
+  triggerEvent: PlanningS106NonFinancialObligationTriggerEvent;
+};
+
+/** @internal */
+export const PlanningS106NonFinancialObligationBody$inboundSchema: z.ZodType<
+  PlanningS106NonFinancialObligationBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function planningS106NonFinancialObligationBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningS106NonFinancialObligationBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlanningS106NonFinancialObligationBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningS106NonFinancialObligationBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningS106NonFinancialObligationLabel$inboundSchema: z.ZodType<
+  PlanningS106NonFinancialObligationLabel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function planningS106NonFinancialObligationLabelFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PlanningS106NonFinancialObligationLabel,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlanningS106NonFinancialObligationLabel$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PlanningS106NonFinancialObligationLabel' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningS106NonFinancialObligationValue$inboundSchema: z.ZodType<
+  PlanningS106NonFinancialObligationValue,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningS106NonFinancialObligationValue);
+
+/** @internal */
+export const Party$inboundSchema: z.ZodType<Party, z.ZodTypeDef, unknown> = z
+  .object({
+    citation: z.nullable(ExtractionCitation$inboundSchema),
+    value: PlanningS106NonFinancialObligationValue$inboundSchema,
+  });
+
+export function partyFromJSON(
+  jsonString: string,
+): SafeParseResult<Party, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Party$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Party' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningS106NonFinancialObligationTriggerEvent$inboundSchema:
+  z.ZodType<
+    PlanningS106NonFinancialObligationTriggerEvent,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    citation: z.nullable(ExtractionCitation$inboundSchema),
+    value: z.string(),
+  });
+
+export function planningS106NonFinancialObligationTriggerEventFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PlanningS106NonFinancialObligationTriggerEvent,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlanningS106NonFinancialObligationTriggerEvent$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PlanningS106NonFinancialObligationTriggerEvent' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningS106NonFinancialObligation$inboundSchema: z.ZodType<
+  PlanningS106NonFinancialObligation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  body: z.lazy(() => PlanningS106NonFinancialObligationBody$inboundSchema),
+  label: z.lazy(() => PlanningS106NonFinancialObligationLabel$inboundSchema),
+  party: z.lazy(() => Party$inboundSchema),
+  triggerEvent: z.lazy(() =>
+    PlanningS106NonFinancialObligationTriggerEvent$inboundSchema
+  ),
+});
+
+export function planningS106NonFinancialObligationFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningS106NonFinancialObligation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlanningS106NonFinancialObligation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningS106NonFinancialObligation' from JSON`,
+  );
+}

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(),