@vepler/sdk 2.155.0 → 2.164.0

package/src/sdk/models/shared/conservationdesignationfeature.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 * 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 DatePrecision = {
+  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 DatePrecision = OpenEnum<typeof DatePrecision>;
+
+/**
+ * UK home nation — identity-tuple component.
+ */
+export const Nation = {
+  Eng: "ENG",
+  Sco: "SCO",
+  Wal: "WAL",
+  Nir: "NIR",
+} as const;
+/**
+ * UK home nation — identity-tuple component.
+ */
+export type Nation = OpenEnum<typeof Nation>;
+
+export type ConservationDesignationFeature = {
+  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?: DatePrecision | 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: Nation;
+  /**
+   * 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 DatePrecision$inboundSchema: z.ZodType<
+  DatePrecision,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(DatePrecision);
+
+/** @internal */
+export const Nation$inboundSchema: z.ZodType<Nation, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Nation);
+
+/** @internal */
+export const ConservationDesignationFeature$inboundSchema: z.ZodType<
+  ConservationDesignationFeature,
+  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: DatePrecision$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: Nation$inboundSchema,
+  provenance: Provenance$inboundSchema,
+  reference: z.string(),
+  source: z.string().optional(),
+  sourceUrl: z.nullable(z.string()).optional(),
+});
+
+export function conservationDesignationFeatureFromJSON(
+  jsonString: string,
+): SafeParseResult<ConservationDesignationFeature, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConservationDesignationFeature$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConservationDesignationFeature' from JSON`,
+  );
+}

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

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

@@ -0,0 +1,99 @@
+/*
+ * 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 ConservationZoneDatePrecision = {
+  Day: "day",
+  Month: "month",
+  Year: "year",
+  None: "none",
+} as const;
+/**
+ * Honest precision of designatedDate — a year-only date is not a day
+ */
+export type ConservationZoneDatePrecision = OpenEnum<
+  typeof ConservationZoneDatePrecision
+>;
+
+export type ConservationZone = {
+  /**
+   * Designation area in hectares
+   */
+  areaHectares?: number | null | undefined;
+  /**
+   * Honest precision of designatedDate — a year-only date is not a day
+   */
+  datePrecision?: ConservationZoneDatePrecision | undefined;
+  /**
+   * ISO date the designation took effect
+   */
+  designatedDate?: string | null | undefined;
+  /**
+   * Priority-habitat classification code (priority_habitat only) — UKBAP / EUNIS code, verbatim
+   */
+  habitatCode?: string | undefined;
+  /**
+   * Landscape class (landscape_designation only) — known values: aonb | national_scenic_area
+   */
+  landscapeClass?: string | undefined;
+  /**
+   * Designation lifecycle — known values: designated | candidate | withdrawn
+   */
+  lifecycle?: string | undefined;
+  /**
+   * Designation name, e.g. 'City of Bath'
+   */
+  name?: string | null | undefined;
+  /**
+   * Custodian register reference (identity-tuple component)
+   */
+  reference?: string | undefined;
+  /**
+   * Woodland antiquity class (woodland types only) — e.g. 'ancient_semi_natural' | 'plantation_on_ancient' | 'long_established'
+   */
+  woodlandClass?: string | undefined;
+};
+
+/** @internal */
+export const ConservationZoneDatePrecision$inboundSchema: z.ZodType<
+  ConservationZoneDatePrecision,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ConservationZoneDatePrecision);
+
+/** @internal */
+export const ConservationZone$inboundSchema: z.ZodType<
+  ConservationZone,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaHectares: z.nullable(z.number()).optional(),
+  datePrecision: ConservationZoneDatePrecision$inboundSchema.optional(),
+  designatedDate: z.nullable(z.string()).optional(),
+  habitatCode: z.string().optional(),
+  landscapeClass: z.string().optional(),
+  lifecycle: z.string().optional(),
+  name: z.nullable(z.string()).optional(),
+  reference: z.string().optional(),
+  woodlandClass: z.string().optional(),
+});
+
+export function conservationZoneFromJSON(
+  jsonString: string,
+): SafeParseResult<ConservationZone, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConservationZone$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConservationZone' from JSON`,
+  );
+}

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

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  DesignationBboxArea,
+  DesignationBboxArea$Outbound,
+  DesignationBboxArea$outboundSchema,
+} from "./designationbboxarea.js";
+import {
+  DesignationMultiPolygonArea,
+  DesignationMultiPolygonArea$Outbound,
+  DesignationMultiPolygonArea$outboundSchema,
+} from "./designationmultipolygonarea.js";
+import {
+  DesignationOutcodeArea,
+  DesignationOutcodeArea$Outbound,
+  DesignationOutcodeArea$outboundSchema,
+} from "./designationoutcodearea.js";
+import {
+  DesignationPointArea,
+  DesignationPointArea$Outbound,
+  DesignationPointArea$outboundSchema,
+} from "./designationpointarea.js";
+import {
+  DesignationPolygonArea,
+  DesignationPolygonArea$Outbound,
+  DesignationPolygonArea$outboundSchema,
+} from "./designationpolygonarea.js";
+import {
+  DesignationPostcodeArea,
+  DesignationPostcodeArea$Outbound,
+  DesignationPostcodeArea$outboundSchema,
+} from "./designationpostcodearea.js";
+
+export type DesignationArea =
+  | DesignationBboxArea
+  | DesignationMultiPolygonArea
+  | DesignationOutcodeArea
+  | DesignationPointArea
+  | DesignationPolygonArea
+  | DesignationPostcodeArea;
+
+/** @internal */
+export type DesignationArea$Outbound =
+  | DesignationBboxArea$Outbound
+  | DesignationMultiPolygonArea$Outbound
+  | DesignationOutcodeArea$Outbound
+  | DesignationPointArea$Outbound
+  | DesignationPolygonArea$Outbound
+  | DesignationPostcodeArea$Outbound;
+
+/** @internal */
+export const DesignationArea$outboundSchema: z.ZodType<
+  DesignationArea$Outbound,
+  z.ZodTypeDef,
+  DesignationArea
+> = z.union([
+  DesignationBboxArea$outboundSchema,
+  DesignationMultiPolygonArea$outboundSchema,
+  DesignationOutcodeArea$outboundSchema,
+  DesignationPointArea$outboundSchema,
+  DesignationPolygonArea$outboundSchema,
+  DesignationPostcodeArea$outboundSchema,
+]);
+
+export function designationAreaToJSON(
+  designationArea: DesignationArea,
+): string {
+  return JSON.stringify(DesignationArea$outboundSchema.parse(designationArea));
+}

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

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DesignationBboxArea = {
+  /**
+   * [latitude, longitude] of the top-right corner
+   */
+  northEast: Array<number>;
+  /**
+   * [latitude, longitude] of the bottom-left corner
+   */
+  southWest: Array<number>;
+  type: "boundingBox";
+};
+
+/** @internal */
+export type DesignationBboxArea$Outbound = {
+  northEast: Array<number>;
+  southWest: Array<number>;
+  type: "boundingBox";
+};
+
+/** @internal */
+export const DesignationBboxArea$outboundSchema: z.ZodType<
+  DesignationBboxArea$Outbound,
+  z.ZodTypeDef,
+  DesignationBboxArea
+> = z.object({
+  northEast: z.array(z.number()),
+  southWest: z.array(z.number()),
+  type: z.literal("boundingBox"),
+});
+
+export function designationBboxAreaToJSON(
+  designationBboxArea: DesignationBboxArea,
+): string {
+  return JSON.stringify(
+    DesignationBboxArea$outboundSchema.parse(designationBboxArea),
+  );
+}

package/src/sdk/models/shared/designationboundary.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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const DesignationBoundaryType = {
+  MultiPolygon: "MultiPolygon",
+} as const;
+export type DesignationBoundaryType = ClosedEnum<
+  typeof DesignationBoundaryType
+>;
+
+/**
+ * The full EPSG:4326 MultiPolygon — opt-in via `attributes: ['geometry']` (can exceed 100 KB).
+ */
+export type DesignationBoundary = {
+  coordinates: Array<Array<Array<Array<number>>>>;
+  type: DesignationBoundaryType;
+};
+
+/** @internal */
+export const DesignationBoundaryType$inboundSchema: z.ZodNativeEnum<
+  typeof DesignationBoundaryType
+> = z.nativeEnum(DesignationBoundaryType);
+
+/** @internal */
+export const DesignationBoundary$inboundSchema: z.ZodType<
+  DesignationBoundary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  coordinates: z.array(z.array(z.array(z.array(z.number())))),
+  type: DesignationBoundaryType$inboundSchema,
+});
+
+export function designationBoundaryFromJSON(
+  jsonString: string,
+): SafeParseResult<DesignationBoundary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DesignationBoundary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DesignationBoundary' from JSON`,
+  );
+}

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

@@ -0,0 +1,52 @@
+/*
+ * 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";
+
+export const DesignationCentroidType = {
+  Point: "Point",
+} as const;
+export type DesignationCentroidType = ClosedEnum<
+  typeof DesignationCentroidType
+>;
+
+/**
+ * Always present — the representative point.
+ */
+export type DesignationCentroid = {
+  /**
+   * [longitude, latitude] in WGS84 — GeoJSON-spec order.
+   */
+  coordinates: Array<number>;
+  type: DesignationCentroidType;
+};
+
+/** @internal */
+export const DesignationCentroidType$inboundSchema: z.ZodNativeEnum<
+  typeof DesignationCentroidType
+> = z.nativeEnum(DesignationCentroidType);
+
+/** @internal */
+export const DesignationCentroid$inboundSchema: z.ZodType<
+  DesignationCentroid,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  coordinates: z.array(z.number()),
+  type: DesignationCentroidType$inboundSchema,
+});
+
+export function designationCentroidFromJSON(
+  jsonString: string,
+): SafeParseResult<DesignationCentroid, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DesignationCentroid$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DesignationCentroid' from JSON`,
+  );
+}

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

@@ -0,0 +1,129 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Match one or more designation types (open enum, e.g. 'scheduled_monument', 'sac').
+ */
+export type DesignationFiltersDesignationType = string | Array<string>;
+
+export const DesignationFilters2 = {
+  Eng: "ENG",
+  Sco: "SCO",
+  Wal: "WAL",
+  Nir: "NIR",
+} as const;
+export type DesignationFilters2 = ClosedEnum<typeof DesignationFilters2>;
+
+export const DesignationFilters1 = {
+  Eng: "ENG",
+  Sco: "SCO",
+  Wal: "WAL",
+  Nir: "NIR",
+} as const;
+export type DesignationFilters1 = ClosedEnum<typeof DesignationFilters1>;
+
+/**
+ * Match one or more UK home nations.
+ */
+export type DesignationFiltersNation =
+  | DesignationFilters1
+  | Array<DesignationFilters2>;
+
+export type DesignationFilters = {
+  /**
+   * Match one or more designation types (open enum, e.g. 'scheduled_monument', 'sac').
+   */
+  designationType?: string | Array<string> | undefined;
+  /**
+   * Match a single local-authority label exactly.
+   */
+  localAuthority?: string | undefined;
+  /**
+   * Match one or more UK home nations.
+   */
+  nation?: DesignationFilters1 | Array<DesignationFilters2> | undefined;
+};
+
+/** @internal */
+export type DesignationFiltersDesignationType$Outbound = string | Array<string>;
+
+/** @internal */
+export const DesignationFiltersDesignationType$outboundSchema: z.ZodType<
+  DesignationFiltersDesignationType$Outbound,
+  z.ZodTypeDef,
+  DesignationFiltersDesignationType
+> = z.union([z.string(), z.array(z.string())]);
+
+export function designationFiltersDesignationTypeToJSON(
+  designationFiltersDesignationType: DesignationFiltersDesignationType,
+): string {
+  return JSON.stringify(
+    DesignationFiltersDesignationType$outboundSchema.parse(
+      designationFiltersDesignationType,
+    ),
+  );
+}
+
+/** @internal */
+export const DesignationFilters2$outboundSchema: z.ZodNativeEnum<
+  typeof DesignationFilters2
+> = z.nativeEnum(DesignationFilters2);
+
+/** @internal */
+export const DesignationFilters1$outboundSchema: z.ZodNativeEnum<
+  typeof DesignationFilters1
+> = z.nativeEnum(DesignationFilters1);
+
+/** @internal */
+export type DesignationFiltersNation$Outbound = string | Array<string>;
+
+/** @internal */
+export const DesignationFiltersNation$outboundSchema: z.ZodType<
+  DesignationFiltersNation$Outbound,
+  z.ZodTypeDef,
+  DesignationFiltersNation
+> = z.union([
+  DesignationFilters1$outboundSchema,
+  z.array(DesignationFilters2$outboundSchema),
+]);
+
+export function designationFiltersNationToJSON(
+  designationFiltersNation: DesignationFiltersNation,
+): string {
+  return JSON.stringify(
+    DesignationFiltersNation$outboundSchema.parse(designationFiltersNation),
+  );
+}
+
+/** @internal */
+export type DesignationFilters$Outbound = {
+  designationType?: string | Array<string> | undefined;
+  localAuthority?: string | undefined;
+  nation?: string | Array<string> | undefined;
+};
+
+/** @internal */
+export const DesignationFilters$outboundSchema: z.ZodType<
+  DesignationFilters$Outbound,
+  z.ZodTypeDef,
+  DesignationFilters
+> = z.object({
+  designationType: z.union([z.string(), z.array(z.string())]).optional(),
+  localAuthority: z.string().optional(),
+  nation: z.union([
+    DesignationFilters1$outboundSchema,
+    z.array(DesignationFilters2$outboundSchema),
+  ]).optional(),
+});
+
+export function designationFiltersToJSON(
+  designationFilters: DesignationFilters,
+): string {
+  return JSON.stringify(
+    DesignationFilters$outboundSchema.parse(designationFilters),
+  );
+}