@vepler/sdk 2.158.0 → 2.167.0

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

@@ -81,7 +81,7 @@ export type Nearest = {
 /**
  * Outside the zone
  */
-export type Two = {
+export type AirQualityRegulatoryZoneMembership2 = {
   /**
    * False — the point is not inside any zone of this kind
    */
@@ -95,7 +95,7 @@ export type Two = {
 /**
  * Inside the zone
  */
-export type One = {
+export type AirQualityRegulatoryZoneMembership1 = {
   /**
    * True — the point is inside this zone
    */
@@ -109,7 +109,9 @@ export type One = {
 /**
  * Discriminated inside/outside-with-nearest membership wrapper around any zone schema
  */
-export type AirQualityRegulatoryZoneMembership = One | Two;
+export type AirQualityRegulatoryZoneMembership =
+  | AirQualityRegulatoryZoneMembership1
+  | AirQualityRegulatoryZoneMembership2;
 
 /** @internal */
 export const Nearest$inboundSchema: z.ZodType<Nearest, z.ZodTypeDef, unknown> =
@@ -141,36 +143,44 @@ export function nearestFromJSON(
 }
 
 /** @internal */
-export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
-  .object({
-    inside: z.literal(false),
-    nearest: z.lazy(() => Nearest$inboundSchema).optional(),
-  });
+export const AirQualityRegulatoryZoneMembership2$inboundSchema: z.ZodType<
+  AirQualityRegulatoryZoneMembership2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inside: z.literal(false),
+  nearest: z.lazy(() => Nearest$inboundSchema).optional(),
+});
 
-export function twoFromJSON(
+export function airQualityRegulatoryZoneMembership2FromJSON(
   jsonString: string,
-): SafeParseResult<Two, SDKValidationError> {
+): SafeParseResult<AirQualityRegulatoryZoneMembership2, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Two$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Two' from JSON`,
+    (x) =>
+      AirQualityRegulatoryZoneMembership2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityRegulatoryZoneMembership2' from JSON`,
   );
 }
 
 /** @internal */
-export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
-  .object({
-    inside: z.literal(true),
-    zone: RegulatoryZone$inboundSchema,
-  });
+export const AirQualityRegulatoryZoneMembership1$inboundSchema: z.ZodType<
+  AirQualityRegulatoryZoneMembership1,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inside: z.literal(true),
+  zone: RegulatoryZone$inboundSchema,
+});
 
-export function oneFromJSON(
+export function airQualityRegulatoryZoneMembership1FromJSON(
   jsonString: string,
-): SafeParseResult<One, SDKValidationError> {
+): SafeParseResult<AirQualityRegulatoryZoneMembership1, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => One$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'One' from JSON`,
+    (x) =>
+      AirQualityRegulatoryZoneMembership1$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityRegulatoryZoneMembership1' from JSON`,
   );
 }
 
@@ -179,7 +189,10 @@ export const AirQualityRegulatoryZoneMembership$inboundSchema: z.ZodType<
   AirQualityRegulatoryZoneMembership,
   z.ZodTypeDef,
   unknown
-> = z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]);
+> = z.union([
+  z.lazy(() => AirQualityRegulatoryZoneMembership1$inboundSchema),
+  z.lazy(() => AirQualityRegulatoryZoneMembership2$inboundSchema),
+]);
 
 export function airQualityRegulatoryZoneMembershipFromJSON(
   jsonString: string,

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

@@ -0,0 +1,246 @@
+/*
+ * 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 {
+  ConservationZone,
+  ConservationZone$inboundSchema,
+} from "./conservationzone.js";
+import { Provenance, Provenance$inboundSchema } from "./provenance.js";
+
+/**
+ * Honest precision of designatedDate — a year-only date is not a day
+ */
+export const ConservationAssessmentsDatePrecision = {
+  Day: "day",
+  Month: "month",
+  Year: "year",
+  None: "none",
+} as const;
+/**
+ * Honest precision of designatedDate — a year-only date is not a day
+ */
+export type ConservationAssessmentsDatePrecision = OpenEnum<
+  typeof ConservationAssessmentsDatePrecision
+>;
+
+/**
+ * Optional — the nearest zone of this kind, with distance
+ */
+export type ConservationAssessmentsNearest = {
+  /**
+   * Designation area in hectares
+   */
+  areaHectares?: number | null | 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?: ConservationAssessmentsDatePrecision | undefined;
+  /**
+   * ISO date the designation took effect
+   */
+  designatedDate?: string | null | undefined;
+  /**
+   * Distance to the feature in metres
+   */
+  distanceM: number;
+  /**
+   * 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;
+};
+
+/**
+ * Outside the zone
+ */
+export type ConservationAssessments2 = {
+  /**
+   * False — the point is not inside any zone of this kind
+   */
+  inside: false;
+  /**
+   * Optional — the nearest zone of this kind, with distance
+   */
+  nearest?: ConservationAssessmentsNearest | undefined;
+};
+
+/**
+ * Inside the zone
+ */
+export type ConservationAssessments1 = {
+  /**
+   * True — the point is inside this zone
+   */
+  inside: true;
+  zone: ConservationZone;
+};
+
+/**
+ * Discriminated inside/outside-with-nearest membership wrapper around any zone schema
+ */
+export type Designations = ConservationAssessments1 | ConservationAssessments2;
+
+export type ConservationAssessments = {
+  /**
+   * Conservation designations keyed by designation_type; only matched (inside / nearby) types are present.
+   */
+  designations: {
+    [k: string]: ConservationAssessments1 | ConservationAssessments2;
+  };
+  /**
+   * Universal provenance block — every product envelope carries this
+   */
+  provenance: Provenance;
+};
+
+/** @internal */
+export const ConservationAssessmentsDatePrecision$inboundSchema: z.ZodType<
+  ConservationAssessmentsDatePrecision,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ConservationAssessmentsDatePrecision);
+
+/** @internal */
+export const ConservationAssessmentsNearest$inboundSchema: z.ZodType<
+  ConservationAssessmentsNearest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaHectares: z.nullable(z.number()).optional(),
+  bearingDeg: z.number().optional(),
+  datePrecision: ConservationAssessmentsDatePrecision$inboundSchema.optional(),
+  designatedDate: z.nullable(z.string()).optional(),
+  distanceM: z.number(),
+  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 conservationAssessmentsNearestFromJSON(
+  jsonString: string,
+): SafeParseResult<ConservationAssessmentsNearest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConservationAssessmentsNearest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConservationAssessmentsNearest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConservationAssessments2$inboundSchema: z.ZodType<
+  ConservationAssessments2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inside: z.literal(false),
+  nearest: z.lazy(() => ConservationAssessmentsNearest$inboundSchema)
+    .optional(),
+});
+
+export function conservationAssessments2FromJSON(
+  jsonString: string,
+): SafeParseResult<ConservationAssessments2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConservationAssessments2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConservationAssessments2' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConservationAssessments1$inboundSchema: z.ZodType<
+  ConservationAssessments1,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  inside: z.literal(true),
+  zone: ConservationZone$inboundSchema,
+});
+
+export function conservationAssessments1FromJSON(
+  jsonString: string,
+): SafeParseResult<ConservationAssessments1, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConservationAssessments1$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConservationAssessments1' from JSON`,
+  );
+}
+
+/** @internal */
+export const Designations$inboundSchema: z.ZodType<
+  Designations,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => ConservationAssessments1$inboundSchema),
+  z.lazy(() => ConservationAssessments2$inboundSchema),
+]);
+
+export function designationsFromJSON(
+  jsonString: string,
+): SafeParseResult<Designations, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Designations$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Designations' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConservationAssessments$inboundSchema: z.ZodType<
+  ConservationAssessments,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  designations: z.record(
+    z.union([
+      z.lazy(() => ConservationAssessments1$inboundSchema),
+      z.lazy(() => ConservationAssessments2$inboundSchema),
+    ]),
+  ),
+  provenance: Provenance$inboundSchema,
+});
+
+export function conservationAssessmentsFromJSON(
+  jsonString: string,
+): SafeParseResult<ConservationAssessments, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConservationAssessments$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConservationAssessments' from JSON`,
+  );
+}

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