@vepler/sdk 2.158.0 → 2.164.0

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

@@ -0,0 +1,73 @@
+/*
+ * 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";
+
+/**
+ * Only published snapshots are listed.
+ */
+export const DesignationSnapshotStatus = {
+  Published: "published",
+} as const;
+/**
+ * Only published snapshots are listed.
+ */
+export type DesignationSnapshotStatus = ClosedEnum<
+  typeof DesignationSnapshotStatus
+>;
+
+export type DesignationSnapshot = {
+  /**
+   * Semantic version of the product pipeline.
+   */
+  productVersion: string;
+  /**
+   * ISO datetime the snapshot was published.
+   */
+  publishedAt: string | null;
+  /**
+   * Number of designations in the snapshot.
+   */
+  recordCount: number | null;
+  /**
+   * Publish snapshot identifier.
+   */
+  snapshotId: string;
+  /**
+   * Only published snapshots are listed.
+   */
+  status: DesignationSnapshotStatus;
+};
+
+/** @internal */
+export const DesignationSnapshotStatus$inboundSchema: z.ZodNativeEnum<
+  typeof DesignationSnapshotStatus
+> = z.nativeEnum(DesignationSnapshotStatus);
+
+/** @internal */
+export const DesignationSnapshot$inboundSchema: z.ZodType<
+  DesignationSnapshot,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  productVersion: z.string(),
+  publishedAt: z.nullable(z.string()),
+  recordCount: z.nullable(z.number().int()),
+  snapshotId: z.string(),
+  status: DesignationSnapshotStatus$inboundSchema,
+});
+
+export function designationSnapshotFromJSON(
+  jsonString: string,
+): SafeParseResult<DesignationSnapshot, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DesignationSnapshot$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DesignationSnapshot' from JSON`,
+  );
+}

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

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

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const DesignationSortFieldField = {
+  DistanceM: "distanceM",
+  Name: "name",
+  DesignatedDate: "designatedDate",
+  AreaHectares: "areaHectares",
+} as const;
+export type DesignationSortFieldField = ClosedEnum<
+  typeof DesignationSortFieldField
+>;
+
+export const DesignationSortFieldOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type DesignationSortFieldOrder = ClosedEnum<
+  typeof DesignationSortFieldOrder
+>;
+
+export type DesignationSortField = {
+  field: DesignationSortFieldField;
+  order?: DesignationSortFieldOrder | undefined;
+};
+
+/** @internal */
+export const DesignationSortFieldField$outboundSchema: z.ZodNativeEnum<
+  typeof DesignationSortFieldField
+> = z.nativeEnum(DesignationSortFieldField);
+
+/** @internal */
+export const DesignationSortFieldOrder$outboundSchema: z.ZodNativeEnum<
+  typeof DesignationSortFieldOrder
+> = z.nativeEnum(DesignationSortFieldOrder);
+
+/** @internal */
+export type DesignationSortField$Outbound = {
+  field: string;
+  order: string;
+};
+
+/** @internal */
+export const DesignationSortField$outboundSchema: z.ZodType<
+  DesignationSortField$Outbound,
+  z.ZodTypeDef,
+  DesignationSortField
+> = z.object({
+  field: DesignationSortFieldField$outboundSchema,
+  order: DesignationSortFieldOrder$outboundSchema.default("asc"),
+});
+
+export function designationSortFieldToJSON(
+  designationSortField: DesignationSortField,
+): string {
+  return JSON.stringify(
+    DesignationSortField$outboundSchema.parse(designationSortField),
+  );
+}

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

@@ -0,0 +1,44 @@
+/*
+ * 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";
+
+export type DesignationType = {
+  /**
+   * Number of designations of this type in the current snapshot.
+   */
+  count: number;
+  /**
+   * Designation dataset code (open enum).
+   */
+  designationType: string;
+  /**
+   * Human-readable label for the type.
+   */
+  label: string;
+};
+
+/** @internal */
+export const DesignationType$inboundSchema: z.ZodType<
+  DesignationType,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  designationType: z.string(),
+  label: z.string(),
+});
+
+export function designationTypeFromJSON(
+  jsonString: string,
+): SafeParseResult<DesignationType, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DesignationType$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DesignationType' from JSON`,
+  );
+}

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