@vepler/sdk 2.155.0 → 2.164.0

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

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

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

@@ -0,0 +1,262 @@
+/*
+ * 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 { HeritageZone, HeritageZone$inboundSchema } from "./heritagezone.js";
+import { Provenance, Provenance$inboundSchema } from "./provenance.js";
+
+/**
+ * Honest precision of designatedDate — a year-only date is not a day
+ */
+export const HeritageAssessmentsDatePrecision = {
+  Day: "day",
+  Month: "month",
+  Year: "year",
+  None: "none",
+} as const;
+/**
+ * Honest precision of designatedDate — a year-only date is not a day
+ */
+export type HeritageAssessmentsDatePrecision = OpenEnum<
+  typeof HeritageAssessmentsDatePrecision
+>;
+
+/**
+ * Optional — the nearest zone of this kind, with distance
+ */
+export type HeritageAssessmentsNearest = {
+  /**
+   * Designation area in hectares
+   */
+  areaHectares?: number | null | undefined;
+  /**
+   * Battlefield modality (registered_battlefield), e.g. 'land_battle' | 'siege' | 'naval'
+   */
+  battleType?: string | undefined;
+  /**
+   * Compass bearing to the feature, degrees from true north (0-360)
+   */
+  bearingDeg?: number | undefined;
+  /**
+   * Honest precision of designatedDate — a year-only date is not a day
+   */
+  datePrecision?: HeritageAssessmentsDatePrecision | undefined;
+  /**
+   * ISO date the designation took effect
+   */
+  designatedDate?: string | null | undefined;
+  /**
+   * Distance to the feature in metres
+   */
+  distanceM: number;
+  /**
+   * 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;
+};
+
+/**
+ * Outside the zone
+ */
+export type HeritageAssessments2 = {
+  /**
+   * False — the point is not inside any zone of this kind
+   */
+  inside: false;
+  /**
+   * Optional — the nearest zone of this kind, with distance
+   */
+  nearest?: HeritageAssessmentsNearest | undefined;
+};
+
+/**
+ * Inside the zone
+ */
+export type HeritageAssessments1 = {
+  /**
+   * True — the point is inside this zone
+   */
+  inside: true;
+  zone: HeritageZone;
+};
+
+/**
+ * Discriminated inside/outside-with-nearest membership wrapper around any zone schema
+ */
+export type HeritageAssessmentsDesignations =
+  | HeritageAssessments1
+  | HeritageAssessments2;
+
+export type HeritageAssessments = {
+  /**
+   * Heritage designations keyed by designation_type; only matched (inside / nearby) types are present.
+   */
+  designations: { [k: string]: HeritageAssessments1 | HeritageAssessments2 };
+  /**
+   * Universal provenance block — every product envelope carries this
+   */
+  provenance: Provenance;
+};
+
+/** @internal */
+export const HeritageAssessmentsDatePrecision$inboundSchema: z.ZodType<
+  HeritageAssessmentsDatePrecision,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(HeritageAssessmentsDatePrecision);
+
+/** @internal */
+export const HeritageAssessmentsNearest$inboundSchema: z.ZodType<
+  HeritageAssessmentsNearest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaHectares: z.nullable(z.number()).optional(),
+  battleType: z.string().optional(),
+  bearingDeg: z.number().optional(),
+  datePrecision: HeritageAssessmentsDatePrecision$inboundSchema.optional(),
+  designatedDate: z.nullable(z.string()).optional(),
+  distanceM: z.number(),
+  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 heritageAssessmentsNearestFromJSON(
+  jsonString: string,
+): SafeParseResult<HeritageAssessmentsNearest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HeritageAssessmentsNearest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HeritageAssessmentsNearest' from JSON`,
+  );
+}
+
+/** @internal */
+export const HeritageAssessments2$inboundSchema: z.ZodType<
+  HeritageAssessments2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inside: z.literal(false),
+  nearest: z.lazy(() => HeritageAssessmentsNearest$inboundSchema).optional(),
+});
+
+export function heritageAssessments2FromJSON(
+  jsonString: string,
+): SafeParseResult<HeritageAssessments2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HeritageAssessments2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HeritageAssessments2' from JSON`,
+  );
+}
+
+/** @internal */
+export const HeritageAssessments1$inboundSchema: z.ZodType<
+  HeritageAssessments1,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inside: z.literal(true),
+  zone: HeritageZone$inboundSchema,
+});
+
+export function heritageAssessments1FromJSON(
+  jsonString: string,
+): SafeParseResult<HeritageAssessments1, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HeritageAssessments1$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HeritageAssessments1' from JSON`,
+  );
+}
+
+/** @internal */
+export const HeritageAssessmentsDesignations$inboundSchema: z.ZodType<
+  HeritageAssessmentsDesignations,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => HeritageAssessments1$inboundSchema),
+  z.lazy(() => HeritageAssessments2$inboundSchema),
+]);
+
+export function heritageAssessmentsDesignationsFromJSON(
+  jsonString: string,
+): SafeParseResult<HeritageAssessmentsDesignations, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HeritageAssessmentsDesignations$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HeritageAssessmentsDesignations' from JSON`,
+  );
+}
+
+/** @internal */
+export const HeritageAssessments$inboundSchema: z.ZodType<
+  HeritageAssessments,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  designations: z.record(
+    z.union([
+      z.lazy(() => HeritageAssessments1$inboundSchema),
+      z.lazy(() => HeritageAssessments2$inboundSchema),
+    ]),
+  ),
+  provenance: Provenance$inboundSchema,
+});
+
+export function heritageAssessmentsFromJSON(
+  jsonString: string,
+): SafeParseResult<HeritageAssessments, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HeritageAssessments$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HeritageAssessments' from JSON`,
+  );
+}

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`,
+  );
+}