@vepler/sdk 2.155.0 → 2.164.0

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

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