@vepler/sdk 2.158.0 → 2.164.0

package/src/sdk/models/shared/heritagedesignationfeature.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 {
+  DesignationGeometry,
+  DesignationGeometry$inboundSchema,
+} from "./designationgeometry.js";
+import { Provenance, Provenance$inboundSchema } from "./provenance.js";
+
+/**
+ * Honest precision of `designatedDate` (heritage). Absent where the product carries no precision flag.
+ */
+export const HeritageDesignationFeatureDatePrecision = {
+  Day: "day",
+  Month: "month",
+  Year: "year",
+  None: "none",
+} as const;
+/**
+ * Honest precision of `designatedDate` (heritage). Absent where the product carries no precision flag.
+ */
+export type HeritageDesignationFeatureDatePrecision = OpenEnum<
+  typeof HeritageDesignationFeatureDatePrecision
+>;
+
+/**
+ * UK home nation — identity-tuple component.
+ */
+export const HeritageDesignationFeatureNation = {
+  Eng: "ENG",
+  Sco: "SCO",
+  Wal: "WAL",
+  Nir: "NIR",
+} as const;
+/**
+ * UK home nation — identity-tuple component.
+ */
+export type HeritageDesignationFeatureNation = OpenEnum<
+  typeof HeritageDesignationFeatureNation
+>;
+
+export type HeritageDesignationFeature = {
+  amendedDate?: string | null | undefined;
+  areaHectares?: number | null | undefined;
+  /**
+   * Required attribution string — mandatory, never permission-gated.
+   */
+  attribution: string | null;
+  /**
+   * Battlefield modality — `designationValueData`.
+   */
+  battleTypeCanonical?: string | undefined;
+  /**
+   * Custodian / harmonised class label.
+   */
+  category?: string | null | undefined;
+  /**
+   * Honest precision of `designatedDate` (heritage). Absent where the product carries no precision flag.
+   */
+  datePrecision?: HeritageDesignationFeatureDatePrecision | undefined;
+  /**
+   * ISO-8601 date or null — read with `datePrecision`.
+   */
+  designatedDate?: string | null | undefined;
+  /**
+   * Date lineage — requires `designationSourceData`.
+   */
+  designatedDateSource?: string | null | undefined;
+  /**
+   * Stable id: design.{product}.{nation}.{type}.{reference}. Survives re-publish; omits the snapshot.
+   */
+  designationId: string;
+  /**
+   * Designation dataset (open enum).
+   */
+  designationType: string;
+  /**
+   * Metres from the query point to the designation boundary (0 if inside). Spatial queries only.
+   */
+  distanceM?: number | null | undefined;
+  geometry: DesignationGeometry;
+  /**
+   * OGL licence identifier — mandatory, never permission-gated.
+   */
+  licence: string | null;
+  /**
+   * Harmonised listed-building / registered-park grade — `designationValueData`. Nation-local token (e.g. `grade_i`, `grade_ii_star`, `category_a`, `grade_b_plus`), `unassigned` where absent. Categories A/B/C (Scotland) are NOT equivalent to grades I/II* /II (England/Wales).
+   */
+  listedGrade?: string | undefined;
+  localAuthority?: string | null | undefined;
+  /**
+   * Whitelist-projected custodian metadata — requires `designationSourceData`; never dumped raw. Keys are present only where the source carries them and vary by `designationType`: `status`, `legal_regime`, `woodland_composition`, `native_pct`, `canopy_pct`, `dominant_habitat`, `maturity`, `parish`, `geographic_location`, `stat_area_km2`.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  /**
+   * FISH-aligned monument classes — `designationValueData`.
+   */
+  monumentClassCanonical?: Array<string> | undefined;
+  /**
+   * Primary monument class — `designationValueData`.
+   */
+  monumentClassPrimary?: string | undefined;
+  name?: string | null | undefined;
+  /**
+   * Welsh-language name, where the source is bilingual.
+   */
+  nameCy?: string | null | undefined;
+  /**
+   * UK home nation — identity-tuple component.
+   */
+  nation: HeritageDesignationFeatureNation;
+  /**
+   * Universal provenance block — every product envelope carries this
+   */
+  provenance: Provenance;
+  /**
+   * Custodian register reference — identity-tuple component.
+   */
+  reference: string;
+  /**
+   * Custodian register id — requires `designationSourceData`.
+   */
+  source?: string | undefined;
+  /**
+   * Public custodian list-entry URL (OGL).
+   */
+  sourceUrl?: string | null | undefined;
+  /**
+   * WHS criteria i–x — `designationValueData`.
+   */
+  unescoInscriptionCriteria?: Array<string> | undefined;
+  /**
+   * WHS inscription type — `designationValueData`.
+   */
+  unescoInscriptionType?: string | undefined;
+  /**
+   * Wreck protection regime — `designationValueData`.
+   */
+  wreckProtectionTypeCanonical?: string | undefined;
+  /**
+   * WHS boundary zone — `designationValueData`.
+   */
+  zoneSubtype?: string | undefined;
+};
+
+/** @internal */
+export const HeritageDesignationFeatureDatePrecision$inboundSchema: z.ZodType<
+  HeritageDesignationFeatureDatePrecision,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(HeritageDesignationFeatureDatePrecision);
+
+/** @internal */
+export const HeritageDesignationFeatureNation$inboundSchema: z.ZodType<
+  HeritageDesignationFeatureNation,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(HeritageDesignationFeatureNation);
+
+/** @internal */
+export const HeritageDesignationFeature$inboundSchema: z.ZodType<
+  HeritageDesignationFeature,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amendedDate: z.nullable(z.string()).optional(),
+  areaHectares: z.nullable(z.number()).optional(),
+  attribution: z.nullable(z.string()),
+  battleTypeCanonical: z.string().optional(),
+  category: z.nullable(z.string()).optional(),
+  datePrecision: HeritageDesignationFeatureDatePrecision$inboundSchema
+    .optional(),
+  designatedDate: z.nullable(z.string()).optional(),
+  designatedDateSource: z.nullable(z.string()).optional(),
+  designationId: z.string(),
+  designationType: z.string(),
+  distanceM: z.nullable(z.number()).optional(),
+  geometry: DesignationGeometry$inboundSchema,
+  licence: z.nullable(z.string()),
+  listedGrade: z.string().optional(),
+  localAuthority: z.nullable(z.string()).optional(),
+  metadata: z.record(z.any()).optional(),
+  monumentClassCanonical: z.array(z.string()).optional(),
+  monumentClassPrimary: z.string().optional(),
+  name: z.nullable(z.string()).optional(),
+  nameCy: z.nullable(z.string()).optional(),
+  nation: HeritageDesignationFeatureNation$inboundSchema,
+  provenance: Provenance$inboundSchema,
+  reference: z.string(),
+  source: z.string().optional(),
+  sourceUrl: z.nullable(z.string()).optional(),
+  unescoInscriptionCriteria: z.array(z.string()).optional(),
+  unescoInscriptionType: z.string().optional(),
+  wreckProtectionTypeCanonical: z.string().optional(),
+  zoneSubtype: z.string().optional(),
+});
+
+export function heritageDesignationFeatureFromJSON(
+  jsonString: string,
+): SafeParseResult<HeritageDesignationFeature, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HeritageDesignationFeature$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HeritageDesignationFeature' from JSON`,
+  );
+}

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

@@ -0,0 +1,87 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  HeritageDesignationFeature,
+  HeritageDesignationFeature$inboundSchema,
+} from "./heritagedesignationfeature.js";
+
+/**
+ * Object type identifier
+ */
+export const HeritageDesignationListResponseObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type HeritageDesignationListResponseObject = ClosedEnum<
+  typeof HeritageDesignationListResponseObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type HeritageDesignationListResponse = {
+  /**
+   * Array of items
+   */
+  data: Array<HeritageDesignationFeature>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: HeritageDesignationListResponseObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export const HeritageDesignationListResponseObject$inboundSchema:
+  z.ZodNativeEnum<typeof HeritageDesignationListResponseObject> = z.nativeEnum(
+    HeritageDesignationListResponseObject,
+  );
+
+/** @internal */
+export const HeritageDesignationListResponse$inboundSchema: z.ZodType<
+  HeritageDesignationListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(HeritageDesignationFeature$inboundSchema),
+  has_more: z.boolean(),
+  object: HeritageDesignationListResponseObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function heritageDesignationListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<HeritageDesignationListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HeritageDesignationListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HeritageDesignationListResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,119 @@
+/*
+ * 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";
+
+/**
+ * Honest precision of designatedDate — a year-only date is not a day
+ */
+export const HeritageZoneDatePrecision = {
+  Day: "day",
+  Month: "month",
+  Year: "year",
+  None: "none",
+} as const;
+/**
+ * Honest precision of designatedDate — a year-only date is not a day
+ */
+export type HeritageZoneDatePrecision = OpenEnum<
+  typeof HeritageZoneDatePrecision
+>;
+
+export type HeritageZone = {
+  /**
+   * Designation area in hectares
+   */
+  areaHectares?: number | null | undefined;
+  /**
+   * Battlefield modality (registered_battlefield), e.g. 'land_battle' | 'siege' | 'naval'
+   */
+  battleType?: string | undefined;
+  /**
+   * Honest precision of designatedDate — a year-only date is not a day
+   */
+  datePrecision?: HeritageZoneDatePrecision | undefined;
+  /**
+   * ISO date the designation took effect
+   */
+  designatedDate?: string | null | undefined;
+  /**
+   * Listed-building / registered-park grade — e.g. grade_i | grade_ii_star | category_a (nation-local; no cross-nation equivalence)
+   */
+  listedGrade?: string | undefined;
+  /**
+   * Primary FISH-aligned monument class (scheduled_monument), e.g. 'defensive' (England → 'unassigned')
+   */
+  monumentClass?: string | undefined;
+  /**
+   * All FISH-aligned monument classes for this monument
+   */
+  monumentClasses?: Array<string> | undefined;
+  /**
+   * Designation name, e.g. 'City of Bath'
+   */
+  name?: string | null | undefined;
+  /**
+   * Custodian register reference (identity-tuple component)
+   */
+  reference?: string | undefined;
+  /**
+   * UNESCO selection criteria i–x
+   */
+  unescoInscriptionCriteria?: Array<string> | undefined;
+  /**
+   * UNESCO inscription type (world_heritage_site) — known values: cultural | natural | mixed
+   */
+  unescoInscriptionType?: string | undefined;
+  /**
+   * Protection regime (protected_wreck_site) — e.g. protected_wreck_site | historic_marine_protected_area | protected_historic_wreck
+   */
+  wreckProtectionType?: string | undefined;
+  /**
+   * WHS boundary zone — known values: core_area | buffer_zone
+   */
+  zoneSubtype?: string | undefined;
+};
+
+/** @internal */
+export const HeritageZoneDatePrecision$inboundSchema: z.ZodType<
+  HeritageZoneDatePrecision,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(HeritageZoneDatePrecision);
+
+/** @internal */
+export const HeritageZone$inboundSchema: z.ZodType<
+  HeritageZone,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaHectares: z.nullable(z.number()).optional(),
+  battleType: z.string().optional(),
+  datePrecision: HeritageZoneDatePrecision$inboundSchema.optional(),
+  designatedDate: z.nullable(z.string()).optional(),
+  listedGrade: z.string().optional(),
+  monumentClass: z.string().optional(),
+  monumentClasses: z.array(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+  reference: z.string().optional(),
+  unescoInscriptionCriteria: z.array(z.string()).optional(),
+  unescoInscriptionType: z.string().optional(),
+  wreckProtectionType: z.string().optional(),
+  zoneSubtype: z.string().optional(),
+});
+
+export function heritageZoneFromJSON(
+  jsonString: string,
+): SafeParseResult<HeritageZone, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HeritageZone$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HeritageZone' from JSON`,
+  );
+}

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

@@ -5,6 +5,8 @@
 export * from "./addresscleanserequest.js";
 export * from "./addresscleanseresponse.js";
 export * from "./addressresolverequest.js";
+export * from "./admissionareacriterion.js";
+export * from "./admissionarearesponse.js";
 export * from "./advancedlisting.js";
 export * from "./advancedlistingaddress.js";
 export * from "./advancedlistingbuild.js";
@@ -111,6 +113,10 @@ export * from "./confidence.js";
 export * from "./confidencefactor.js";
 export * from "./confidencefactorseverity.js";
 export * from "./confidencelevel.js";
+export * from "./conservationassessments.js";
+export * from "./conservationdesignationfeature.js";
+export * from "./conservationdesignationlistresponse.js";
+export * from "./conservationzone.js";
 export * from "./costband.js";
 export * from "./council.js";
 export * from "./councilbranding.js";
@@ -133,6 +139,23 @@ export * from "./crimeincidentslistresponse.js";
 export * from "./crimeincidentssummary.js";
 export * from "./crimeperioddetails.js";
 export * from "./datasourceref.js";
+export * from "./designationarea.js";
+export * from "./designationbboxarea.js";
+export * from "./designationboundary.js";
+export * from "./designationcentroid.js";
+export * from "./designationfilters.js";
+export * from "./designationgeometry.js";
+export * from "./designationmultipolygonarea.js";
+export * from "./designationoutcodearea.js";
+export * from "./designationpointarea.js";
+export * from "./designationpolygonarea.js";
+export * from "./designationpostcodearea.js";
+export * from "./designationqueryrequest.js";
+export * from "./designationsnapshot.js";
+export * from "./designationsnapshotlistresponse.js";
+export * from "./designationsortfield.js";
+export * from "./designationtype.js";
+export * from "./designationtypelistresponse.js";
 export * from "./effectiveness.js";
 export * from "./epcareafilter.js";
 export * from "./epcdata.js";
@@ -185,12 +208,18 @@ export * from "./healthevidencelevel.js";
 export * from "./healthimpact.js";
 export * from "./healthimpactseverity.js";
 export * from "./healthresponse.js";
+export * from "./heritageassessments.js";
+export * from "./heritagedesignationfeature.js";
+export * from "./heritagedesignationlistresponse.js";
+export * from "./heritagezone.js";
 export * from "./histogramaggregationresult.js";
 export * from "./histogrambucket.js";
 export * from "./historicalvaluation.js";
 export * from "./insuranceavailability.js";
 export * from "./insuranceimpact.js";
 export * from "./insurancepremiumimpact.js";
+export * from "./landconstraintdesignationfeature.js";
+export * from "./landconstraintdesignationlistresponse.js";
 export * from "./leafaggregation.js";
 export * from "./lease.js";
 export * from "./lenderimpact.js";
@@ -275,6 +304,7 @@ export * from "./propertyaddress.js";
 export * from "./propertyaggregaterequest.js";
 export * from "./propertyaggregateresponse.js";
 export * from "./propertyareafilter.js";
+export * from "./propertyassessments.js";
 export * from "./propertybyslugsrequest.js";
 export * from "./propertydataapi.js";
 export * from "./propertylistresponse.js";

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

@@ -0,0 +1,174 @@
+/*
+ * 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 {
+  DesignationGeometry,
+  DesignationGeometry$inboundSchema,
+} from "./designationgeometry.js";
+import { Provenance, Provenance$inboundSchema } from "./provenance.js";
+
+/**
+ * Honest precision of `designatedDate` (heritage). Absent where the product carries no precision flag.
+ */
+export const LandConstraintDesignationFeatureDatePrecision = {
+  Day: "day",
+  Month: "month",
+  Year: "year",
+  None: "none",
+} as const;
+/**
+ * Honest precision of `designatedDate` (heritage). Absent where the product carries no precision flag.
+ */
+export type LandConstraintDesignationFeatureDatePrecision = OpenEnum<
+  typeof LandConstraintDesignationFeatureDatePrecision
+>;
+
+/**
+ * UK home nation — identity-tuple component.
+ */
+export const LandConstraintDesignationFeatureNation = {
+  Eng: "ENG",
+  Sco: "SCO",
+  Wal: "WAL",
+  Nir: "NIR",
+} as const;
+/**
+ * UK home nation — identity-tuple component.
+ */
+export type LandConstraintDesignationFeatureNation = OpenEnum<
+  typeof LandConstraintDesignationFeatureNation
+>;
+
+export type LandConstraintDesignationFeature = {
+  amendedDate?: string | null | undefined;
+  areaHectares?: number | null | undefined;
+  /**
+   * Required attribution string — mandatory, never permission-gated.
+   */
+  attribution: string | null;
+  /**
+   * Custodian / harmonised class label.
+   */
+  category?: string | null | undefined;
+  /**
+   * Honest precision of `designatedDate` (heritage). Absent where the product carries no precision flag.
+   */
+  datePrecision?: LandConstraintDesignationFeatureDatePrecision | undefined;
+  /**
+   * ISO-8601 date or null — read with `datePrecision`.
+   */
+  designatedDate?: string | null | undefined;
+  /**
+   * Date lineage — requires `designationSourceData`.
+   */
+  designatedDateSource?: string | null | undefined;
+  /**
+   * Stable id: design.{product}.{nation}.{type}.{reference}. Survives re-publish; omits the snapshot.
+   */
+  designationId: string;
+  /**
+   * Designation dataset (open enum).
+   */
+  designationType: string;
+  /**
+   * Metres from the query point to the designation boundary (0 if inside). Spatial queries only.
+   */
+  distanceM?: number | null | undefined;
+  geometry: DesignationGeometry;
+  /**
+   * OGL licence identifier — mandatory, never permission-gated.
+   */
+  licence: string | null;
+  localAuthority?: string | null | undefined;
+  /**
+   * Whitelist-projected custodian metadata — requires `designationSourceData`; never dumped raw. Keys are present only where the source carries them and vary by `designationType`: `status`, `legal_regime`, `woodland_composition`, `native_pct`, `canopy_pct`, `dominant_habitat`, `maturity`, `parish`, `geographic_location`, `stat_area_km2`.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  name?: string | null | undefined;
+  /**
+   * Welsh-language name, where the source is bilingual.
+   */
+  nameCy?: string | null | undefined;
+  /**
+   * UK home nation — identity-tuple component.
+   */
+  nation: LandConstraintDesignationFeatureNation;
+  /**
+   * Universal provenance block — every product envelope carries this
+   */
+  provenance: Provenance;
+  /**
+   * Custodian register reference — identity-tuple component.
+   */
+  reference: string;
+  /**
+   * Custodian register id — requires `designationSourceData`.
+   */
+  source?: string | undefined;
+  /**
+   * Public custodian list-entry URL (OGL).
+   */
+  sourceUrl?: string | null | undefined;
+};
+
+/** @internal */
+export const LandConstraintDesignationFeatureDatePrecision$inboundSchema:
+  z.ZodType<
+    LandConstraintDesignationFeatureDatePrecision,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(LandConstraintDesignationFeatureDatePrecision);
+
+/** @internal */
+export const LandConstraintDesignationFeatureNation$inboundSchema: z.ZodType<
+  LandConstraintDesignationFeatureNation,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(LandConstraintDesignationFeatureNation);
+
+/** @internal */
+export const LandConstraintDesignationFeature$inboundSchema: z.ZodType<
+  LandConstraintDesignationFeature,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amendedDate: z.nullable(z.string()).optional(),
+  areaHectares: z.nullable(z.number()).optional(),
+  attribution: z.nullable(z.string()),
+  category: z.nullable(z.string()).optional(),
+  datePrecision: LandConstraintDesignationFeatureDatePrecision$inboundSchema
+    .optional(),
+  designatedDate: z.nullable(z.string()).optional(),
+  designatedDateSource: z.nullable(z.string()).optional(),
+  designationId: z.string(),
+  designationType: z.string(),
+  distanceM: z.nullable(z.number()).optional(),
+  geometry: DesignationGeometry$inboundSchema,
+  licence: z.nullable(z.string()),
+  localAuthority: z.nullable(z.string()).optional(),
+  metadata: z.record(z.any()).optional(),
+  name: z.nullable(z.string()).optional(),
+  nameCy: z.nullable(z.string()).optional(),
+  nation: LandConstraintDesignationFeatureNation$inboundSchema,
+  provenance: Provenance$inboundSchema,
+  reference: z.string(),
+  source: z.string().optional(),
+  sourceUrl: z.nullable(z.string()).optional(),
+});
+
+export function landConstraintDesignationFeatureFromJSON(
+  jsonString: string,
+): SafeParseResult<LandConstraintDesignationFeature, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LandConstraintDesignationFeature$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LandConstraintDesignationFeature' from JSON`,
+  );
+}