@vepler/sdk 2.158.0 → 2.167.0

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

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

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  DesignationBoundary,
+  DesignationBoundary$inboundSchema,
+} from "./designationboundary.js";
+import {
+  DesignationCentroid,
+  DesignationCentroid$inboundSchema,
+} from "./designationcentroid.js";
+
+export type DesignationGeometry = {
+  /**
+   * The full EPSG:4326 MultiPolygon — opt-in via `attributes: ['geometry']` (can exceed 100 KB).
+   */
+  boundary?: DesignationBoundary | undefined;
+  /**
+   * Always present — the representative point.
+   */
+  centroid: DesignationCentroid;
+};
+
+/** @internal */
+export const DesignationGeometry$inboundSchema: z.ZodType<
+  DesignationGeometry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  boundary: DesignationBoundary$inboundSchema.optional(),
+  centroid: DesignationCentroid$inboundSchema,
+});
+
+export function designationGeometryFromJSON(
+  jsonString: string,
+): SafeParseResult<DesignationGeometry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DesignationGeometry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DesignationGeometry' from JSON`,
+  );
+}

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DesignationMultiPolygonArea = {
+  /**
+   * MultiPolygon coordinates as [latitude, longitude] pairs
+   */
+  coordinates: Array<Array<Array<Array<number>>>>;
+  type: "multipolygon";
+};
+
+/** @internal */
+export type DesignationMultiPolygonArea$Outbound = {
+  coordinates: Array<Array<Array<Array<number>>>>;
+  type: "multipolygon";
+};
+
+/** @internal */
+export const DesignationMultiPolygonArea$outboundSchema: z.ZodType<
+  DesignationMultiPolygonArea$Outbound,
+  z.ZodTypeDef,
+  DesignationMultiPolygonArea
+> = z.object({
+  coordinates: z.array(z.array(z.array(z.array(z.number())))),
+  type: z.literal("multipolygon"),
+});
+
+export function designationMultiPolygonAreaToJSON(
+  designationMultiPolygonArea: DesignationMultiPolygonArea,
+): string {
+  return JSON.stringify(
+    DesignationMultiPolygonArea$outboundSchema.parse(
+      designationMultiPolygonArea,
+    ),
+  );
+}

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DesignationOutcodeArea = {
+  type: "outcode";
+  /**
+   * Outward code only, e.g. 'SP4' or 'M1'
+   */
+  value: string;
+};
+
+/** @internal */
+export type DesignationOutcodeArea$Outbound = {
+  type: "outcode";
+  value: string;
+};
+
+/** @internal */
+export const DesignationOutcodeArea$outboundSchema: z.ZodType<
+  DesignationOutcodeArea$Outbound,
+  z.ZodTypeDef,
+  DesignationOutcodeArea
+> = z.object({
+  type: z.literal("outcode"),
+  value: z.string(),
+});
+
+export function designationOutcodeAreaToJSON(
+  designationOutcodeArea: DesignationOutcodeArea,
+): string {
+  return JSON.stringify(
+    DesignationOutcodeArea$outboundSchema.parse(designationOutcodeArea),
+  );
+}

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

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DesignationPointArea = {
+  /**
+   * [latitude, longitude] in WGS84 decimal degrees. Note: [lat, lng] order (not GeoJSON [lng, lat]), matching other vepler-stack endpoints.
+   */
+  coordinates: Array<number>;
+  /**
+   * Search radius in metres. 0 = designations CONTAINING the point (within-designation lookup). >0 = every designation whose boundary is within the radius.
+   */
+  radius?: number | undefined;
+  type: "point";
+};
+
+/** @internal */
+export type DesignationPointArea$Outbound = {
+  coordinates: Array<number>;
+  radius: number;
+  type: "point";
+};
+
+/** @internal */
+export const DesignationPointArea$outboundSchema: z.ZodType<
+  DesignationPointArea$Outbound,
+  z.ZodTypeDef,
+  DesignationPointArea
+> = z.object({
+  coordinates: z.array(z.number()),
+  radius: z.number().int().default(0),
+  type: z.literal("point"),
+});
+
+export function designationPointAreaToJSON(
+  designationPointArea: DesignationPointArea,
+): string {
+  return JSON.stringify(
+    DesignationPointArea$outboundSchema.parse(designationPointArea),
+  );
+}

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DesignationPolygonArea = {
+  /**
+   * Polygon rings as [latitude, longitude] pairs. Outer ring first; subsequent rings define holes. First and last coordinate must match. Up to 1000 vertices.
+   */
+  coordinates: Array<Array<Array<number>>>;
+  type: "polygon";
+};
+
+/** @internal */
+export type DesignationPolygonArea$Outbound = {
+  coordinates: Array<Array<Array<number>>>;
+  type: "polygon";
+};
+
+/** @internal */
+export const DesignationPolygonArea$outboundSchema: z.ZodType<
+  DesignationPolygonArea$Outbound,
+  z.ZodTypeDef,
+  DesignationPolygonArea
+> = z.object({
+  coordinates: z.array(z.array(z.array(z.number()))),
+  type: z.literal("polygon"),
+});
+
+export function designationPolygonAreaToJSON(
+  designationPolygonArea: DesignationPolygonArea,
+): string {
+  return JSON.stringify(
+    DesignationPolygonArea$outboundSchema.parse(designationPolygonArea),
+  );
+}

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

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DesignationPostcodeArea = {
+  /**
+   * Optional search radius from the postcode centroid in metres.
+   */
+  radius?: number | undefined;
+  type: "postcode";
+  /**
+   * UK postcode
+   */
+  value: string;
+};
+
+/** @internal */
+export type DesignationPostcodeArea$Outbound = {
+  radius: number;
+  type: "postcode";
+  value: string;
+};
+
+/** @internal */
+export const DesignationPostcodeArea$outboundSchema: z.ZodType<
+  DesignationPostcodeArea$Outbound,
+  z.ZodTypeDef,
+  DesignationPostcodeArea
+> = z.object({
+  radius: z.number().int().default(0),
+  type: z.literal("postcode"),
+  value: z.string(),
+});
+
+export function designationPostcodeAreaToJSON(
+  designationPostcodeArea: DesignationPostcodeArea,
+): string {
+  return JSON.stringify(
+    DesignationPostcodeArea$outboundSchema.parse(designationPostcodeArea),
+  );
+}

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

@@ -0,0 +1,101 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  DesignationArea,
+  DesignationArea$Outbound,
+  DesignationArea$outboundSchema,
+} from "./designationarea.js";
+import {
+  DesignationFilters,
+  DesignationFilters$Outbound,
+  DesignationFilters$outboundSchema,
+} from "./designationfilters.js";
+import {
+  DesignationSortField,
+  DesignationSortField$Outbound,
+  DesignationSortField$outboundSchema,
+} from "./designationsortfield.js";
+
+/**
+ * Comma-separated string or array of opt-in heavy attributes. Pass `geometry` to include the full MultiPolygon boundary (centroid is always included). Field exposure is decided by key tier, not here.
+ */
+export type DesignationQueryRequestAttributes = string | Array<string>;
+
+export type DesignationQueryRequest = {
+  /**
+   * Geographic search areas. Multiple areas are OR-combined; results are deduplicated by designationId.
+   */
+  area: Array<DesignationArea>;
+  /**
+   * Comma-separated string or array of opt-in heavy attributes. Pass `geometry` to include the full MultiPolygon boundary (centroid is always included). Field exposure is decided by key tier, not here.
+   */
+  attributes?: string | Array<string> | undefined;
+  filters?: DesignationFilters | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  /**
+   * Pin to a specific published snapshot. When omitted, the live snapshot is used and echoed back inside `provenance.snapshotId`; pinning it holds the data stable across paging and re-publishes.
+   */
+  snapshotId?: string | undefined;
+  /**
+   * Sort order. Default: distance ascending when a point area is given, name ascending otherwise.
+   */
+  sort?: Array<DesignationSortField> | undefined;
+};
+
+/** @internal */
+export type DesignationQueryRequestAttributes$Outbound = string | Array<string>;
+
+/** @internal */
+export const DesignationQueryRequestAttributes$outboundSchema: z.ZodType<
+  DesignationQueryRequestAttributes$Outbound,
+  z.ZodTypeDef,
+  DesignationQueryRequestAttributes
+> = z.union([z.string(), z.array(z.string())]);
+
+export function designationQueryRequestAttributesToJSON(
+  designationQueryRequestAttributes: DesignationQueryRequestAttributes,
+): string {
+  return JSON.stringify(
+    DesignationQueryRequestAttributes$outboundSchema.parse(
+      designationQueryRequestAttributes,
+    ),
+  );
+}
+
+/** @internal */
+export type DesignationQueryRequest$Outbound = {
+  area: Array<DesignationArea$Outbound>;
+  attributes?: string | Array<string> | undefined;
+  filters?: DesignationFilters$Outbound | undefined;
+  limit: number;
+  offset: number;
+  snapshotId?: string | undefined;
+  sort?: Array<DesignationSortField$Outbound> | undefined;
+};
+
+/** @internal */
+export const DesignationQueryRequest$outboundSchema: z.ZodType<
+  DesignationQueryRequest$Outbound,
+  z.ZodTypeDef,
+  DesignationQueryRequest
+> = z.object({
+  area: z.array(DesignationArea$outboundSchema),
+  attributes: z.union([z.string(), z.array(z.string())]).optional(),
+  filters: DesignationFilters$outboundSchema.optional(),
+  limit: z.number().int().default(25),
+  offset: z.number().int().default(0),
+  snapshotId: z.string().optional(),
+  sort: z.array(DesignationSortField$outboundSchema).optional(),
+});
+
+export function designationQueryRequestToJSON(
+  designationQueryRequest: DesignationQueryRequest,
+): string {
+  return JSON.stringify(
+    DesignationQueryRequest$outboundSchema.parse(designationQueryRequest),
+  );
+}