@vepler/sdk 2.30.4 → 2.37.0

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

@@ -0,0 +1,143 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const SiteFiltersStatus = {
+  Active: "active",
+  Pending: "pending",
+  Closed: "closed",
+} as const;
+export type SiteFiltersStatus = ClosedEnum<typeof SiteFiltersStatus>;
+
+/**
+ * Filter by boolean tags. Set a tag to `true` to require it, or `false` to exclude it.
+ */
+export type Tags = {
+  /**
+   * Filter for agricultural land
+   */
+  agricultural?: boolean | undefined;
+  /**
+   * Filter for sites on brownfield land
+   */
+  brownfield?: boolean | undefined;
+  /**
+   * Filter for sites with development potential
+   */
+  developmentPotential?: boolean | undefined;
+  /**
+   * Filter for sites with multiple linked properties
+   */
+  multipleProperties?: boolean | undefined;
+  /**
+   * Filter for sites with zero linked properties
+   */
+  noProperties?: boolean | undefined;
+  /**
+   * Filter for sites with no linked properties
+   */
+  vacant?: boolean | undefined;
+};
+
+/**
+ * Convenience filters
+ */
+export type SiteFilters = {
+  /**
+   * Maximum site area in square metres (inclusive)
+   */
+  areaSqmMax?: number | undefined;
+  /**
+   * Minimum site area in square metres (inclusive)
+   */
+  areaSqmMin?: number | undefined;
+  /**
+   * Filter by HM Land Registry class of title codes. Freehold: AF, QF, PF, SF. Leasehold: AL, GL, QL, PL, SL. Other: CF, CL, AR, PR, QR, CN.
+   */
+  classTitleCode?: Array<string> | undefined;
+  /**
+   * Filter by ISO 3166-1 alpha-2 country code
+   */
+  country?: string | undefined;
+  /**
+   * Filter sites that intersect specific spatial overlays (e.g. flood zones, conservation areas)
+   */
+  overlays?: Array<string> | undefined;
+  /**
+   * Filter by site status. active: current titles. pending: awaiting registration. closed: no longer active.
+   */
+  status?: Array<SiteFiltersStatus> | undefined;
+  /**
+   * Filter by boolean tags. Set a tag to `true` to require it, or `false` to exclude it.
+   */
+  tags?: Tags | undefined;
+  /**
+   * Filter by tenure types. Allowed values: freehold, leasehold, commonhold, rentcharge, caution, other.
+   */
+  tenureType?: Array<string> | undefined;
+};
+
+/** @internal */
+export const SiteFiltersStatus$outboundSchema: z.ZodNativeEnum<
+  typeof SiteFiltersStatus
+> = z.nativeEnum(SiteFiltersStatus);
+
+/** @internal */
+export type Tags$Outbound = {
+  agricultural?: boolean | undefined;
+  brownfield?: boolean | undefined;
+  developmentPotential?: boolean | undefined;
+  multipleProperties?: boolean | undefined;
+  noProperties?: boolean | undefined;
+  vacant?: boolean | undefined;
+};
+
+/** @internal */
+export const Tags$outboundSchema: z.ZodType<Tags$Outbound, z.ZodTypeDef, Tags> =
+  z.object({
+    agricultural: z.boolean().optional(),
+    brownfield: z.boolean().optional(),
+    developmentPotential: z.boolean().optional(),
+    multipleProperties: z.boolean().optional(),
+    noProperties: z.boolean().optional(),
+    vacant: z.boolean().optional(),
+  });
+
+export function tagsToJSON(tags: Tags): string {
+  return JSON.stringify(Tags$outboundSchema.parse(tags));
+}
+
+/** @internal */
+export type SiteFilters$Outbound = {
+  areaSqmMax?: number | undefined;
+  areaSqmMin?: number | undefined;
+  classTitleCode?: Array<string> | undefined;
+  country?: string | undefined;
+  overlays?: Array<string> | undefined;
+  status?: Array<string> | undefined;
+  tags?: Tags$Outbound | undefined;
+  tenureType?: Array<string> | undefined;
+};
+
+/** @internal */
+export const SiteFilters$outboundSchema: z.ZodType<
+  SiteFilters$Outbound,
+  z.ZodTypeDef,
+  SiteFilters
+> = z.object({
+  areaSqmMax: z.number().optional(),
+  areaSqmMin: z.number().optional(),
+  classTitleCode: z.array(z.string()).optional(),
+  country: z.string().optional(),
+  overlays: z.array(z.string()).optional(),
+  status: z.array(SiteFiltersStatus$outboundSchema).optional(),
+  tags: z.lazy(() => Tags$outboundSchema).optional(),
+  tenureType: z.array(z.string()).optional(),
+});
+
+export function siteFiltersToJSON(siteFilters: SiteFilters): string {
+  return JSON.stringify(SiteFilters$outboundSchema.parse(siteFilters));
+}

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

@@ -0,0 +1,156 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  RangeDefinition,
+  RangeDefinition$Outbound,
+  RangeDefinition$outboundSchema,
+} from "./rangedefinition.js";
+
+export const SiteLeafAggregationOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type SiteLeafAggregationOrder = ClosedEnum<
+  typeof SiteLeafAggregationOrder
+>;
+
+/**
+ * Type of aggregation
+ */
+export const SiteLeafAggregationType = {
+  Terms: "terms",
+  Range: "range",
+  Histogram: "histogram",
+  DateHistogram: "date_histogram",
+  Stats: "stats",
+  ExtendedStats: "extended_stats",
+  Min: "min",
+  Max: "max",
+  Avg: "avg",
+  Sum: "sum",
+  Count: "count",
+  Cardinality: "cardinality",
+  Percentiles: "percentiles",
+  GeotileGrid: "geotile_grid",
+} as const;
+/**
+ * Type of aggregation
+ */
+export type SiteLeafAggregationType = ClosedEnum<
+  typeof SiteLeafAggregationType
+>;
+
+export type SiteLeafAggregation = {
+  /**
+   * Calendar-aware interval for date_histogram. Values: 1m (minute), 1h (hour), 1d (day), 1w (week), 1M (month), 1q (quarter), 1y (year). Mutually exclusive with fixedInterval — provide one or the other, not both.
+   */
+  calendarInterval?: string | undefined;
+  /**
+   * Field to aggregate on. Must be a field allowed by the dataset's aggregation whitelist.
+   */
+  field: string;
+  /**
+   * Fixed-duration interval for date_histogram. Values: any combination of number + unit (ms, s, m, h, d). Examples: "30m", "1h", "7d". Unlike calendarInterval, does not account for daylight saving or month lengths. Mutually exclusive with calendarInterval — provide one or the other, not both.
+   */
+  fixedInterval?: string | undefined;
+  /**
+   * Date format string for date_histogram bucket keys. Uses Elasticsearch date format patterns (e.g. "yyyy-MM-dd").
+   */
+  format?: string | undefined;
+  /**
+   * Bucket width for histogram aggregation. Required when type is "histogram".
+   */
+  interval?: number | undefined;
+  /**
+   * Minimum document count for a bucket to be included in the result. Applies to: terms, histogram, date_histogram. Default is 1.
+   */
+  minDocCount?: number | undefined;
+  /**
+   * Unique name for this aggregation. Used as the key in the response `aggregations` object.
+   */
+  name: string;
+  /**
+   * Sort order for terms buckets. Key is the sort field ("_count", "_key", or a sub-aggregation name), value is direction.
+   */
+  order?: { [k: string]: SiteLeafAggregationOrder } | undefined;
+  /**
+   * Percentile values to calculate (0-100). Required when type is "percentiles".
+   */
+  percents?: Array<number> | undefined;
+  /**
+   * Custom numeric ranges for range aggregation. Required when type is "range". Each range has an inclusive `from` and exclusive `to`.
+   */
+  ranges?: Array<RangeDefinition> | undefined;
+  /**
+   * Maximum number of buckets to return. Applies to: terms (default 20), geotile_grid (precision level). Ignored by metric aggregations (stats, min, max, etc.).
+   */
+  size?: number | undefined;
+  /**
+   * IANA timezone for date_histogram bucketing (e.g. "Europe/London", "UTC"). Defaults to UTC.
+   */
+  timeZone?: string | undefined;
+  /**
+   * Type of aggregation
+   */
+  type: SiteLeafAggregationType;
+};
+
+/** @internal */
+export const SiteLeafAggregationOrder$outboundSchema: z.ZodNativeEnum<
+  typeof SiteLeafAggregationOrder
+> = z.nativeEnum(SiteLeafAggregationOrder);
+
+/** @internal */
+export const SiteLeafAggregationType$outboundSchema: z.ZodNativeEnum<
+  typeof SiteLeafAggregationType
+> = z.nativeEnum(SiteLeafAggregationType);
+
+/** @internal */
+export type SiteLeafAggregation$Outbound = {
+  calendarInterval?: string | undefined;
+  field: string;
+  fixedInterval?: string | undefined;
+  format?: string | undefined;
+  interval?: number | undefined;
+  minDocCount?: number | undefined;
+  name: string;
+  order?: { [k: string]: string } | undefined;
+  percents?: Array<number> | undefined;
+  ranges?: Array<RangeDefinition$Outbound> | undefined;
+  size?: number | undefined;
+  timeZone?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const SiteLeafAggregation$outboundSchema: z.ZodType<
+  SiteLeafAggregation$Outbound,
+  z.ZodTypeDef,
+  SiteLeafAggregation
+> = z.object({
+  calendarInterval: z.string().optional(),
+  field: z.string(),
+  fixedInterval: z.string().optional(),
+  format: z.string().optional(),
+  interval: z.number().optional(),
+  minDocCount: z.number().int().optional(),
+  name: z.string(),
+  order: z.record(SiteLeafAggregationOrder$outboundSchema).optional(),
+  percents: z.array(z.number()).optional(),
+  ranges: z.array(RangeDefinition$outboundSchema).optional(),
+  size: z.number().int().optional(),
+  timeZone: z.string().optional(),
+  type: SiteLeafAggregationType$outboundSchema,
+});
+
+export function siteLeafAggregationToJSON(
+  siteLeafAggregation: SiteLeafAggregation,
+): string {
+  return JSON.stringify(
+    SiteLeafAggregation$outboundSchema.parse(siteLeafAggregation),
+  );
+}

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

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

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

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Spatial relation between the site boundary and this multi-polygon. Defaults to "intersects". See SitePolygonAreaFilter for relation definitions.
+ */
+export const Relation = {
+  Intersects: "intersects",
+  Within: "within",
+  Contains: "contains",
+} as const;
+/**
+ * Spatial relation between the site boundary and this multi-polygon. Defaults to "intersects". See SitePolygonAreaFilter for relation definitions.
+ */
+export type Relation = ClosedEnum<typeof Relation>;
+
+export type SiteMultiPolygonAreaFilter = {
+  /**
+   * GeoJSON MultiPolygon coordinates in [longitude, latitude] order (EPSG:4326). An array of polygon coordinate arrays.
+   */
+  coordinates: Array<Array<Array<Array<number>>>>;
+  /**
+   * Spatial relation between the site boundary and this multi-polygon. Defaults to "intersects". See SitePolygonAreaFilter for relation definitions.
+   */
+  relation?: Relation | undefined;
+  type: "multipolygon";
+};
+
+/** @internal */
+export const Relation$outboundSchema: z.ZodNativeEnum<typeof Relation> = z
+  .nativeEnum(Relation);
+
+/** @internal */
+export type SiteMultiPolygonAreaFilter$Outbound = {
+  coordinates: Array<Array<Array<Array<number>>>>;
+  relation?: string | undefined;
+  type: "multipolygon";
+};
+
+/** @internal */
+export const SiteMultiPolygonAreaFilter$outboundSchema: z.ZodType<
+  SiteMultiPolygonAreaFilter$Outbound,
+  z.ZodTypeDef,
+  SiteMultiPolygonAreaFilter
+> = z.object({
+  coordinates: z.array(z.array(z.array(z.array(z.number())))),
+  relation: Relation$outboundSchema.optional(),
+  type: z.literal("multipolygon"),
+});
+
+export function siteMultiPolygonAreaFilterToJSON(
+  siteMultiPolygonAreaFilter: SiteMultiPolygonAreaFilter,
+): string {
+  return JSON.stringify(
+    SiteMultiPolygonAreaFilter$outboundSchema.parse(siteMultiPolygonAreaFilter),
+  );
+}

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

@@ -0,0 +1,167 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  RangeDefinition,
+  RangeDefinition$Outbound,
+  RangeDefinition$outboundSchema,
+} from "./rangedefinition.js";
+import {
+  SiteLeafAggregation,
+  SiteLeafAggregation$Outbound,
+  SiteLeafAggregation$outboundSchema,
+} from "./siteleafaggregation.js";
+
+export const SiteNestedAggregationOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type SiteNestedAggregationOrder = ClosedEnum<
+  typeof SiteNestedAggregationOrder
+>;
+
+/**
+ * Type of aggregation
+ */
+export const SiteNestedAggregationType = {
+  Terms: "terms",
+  Range: "range",
+  Histogram: "histogram",
+  DateHistogram: "date_histogram",
+  Stats: "stats",
+  ExtendedStats: "extended_stats",
+  Min: "min",
+  Max: "max",
+  Avg: "avg",
+  Sum: "sum",
+  Count: "count",
+  Cardinality: "cardinality",
+  Percentiles: "percentiles",
+  GeotileGrid: "geotile_grid",
+} as const;
+/**
+ * Type of aggregation
+ */
+export type SiteNestedAggregationType = ClosedEnum<
+  typeof SiteNestedAggregationType
+>;
+
+export type SiteNestedAggregation = {
+  /**
+   * Sub-aggregations (max 5, no further nesting)
+   */
+  aggs?: Array<SiteLeafAggregation> | undefined;
+  /**
+   * Calendar-aware interval for date_histogram. Values: 1m (minute), 1h (hour), 1d (day), 1w (week), 1M (month), 1q (quarter), 1y (year). Mutually exclusive with fixedInterval — provide one or the other, not both.
+   */
+  calendarInterval?: string | undefined;
+  /**
+   * Field to aggregate on. Must be a field allowed by the dataset's aggregation whitelist.
+   */
+  field: string;
+  /**
+   * Fixed-duration interval for date_histogram. Values: any combination of number + unit (ms, s, m, h, d). Examples: "30m", "1h", "7d". Unlike calendarInterval, does not account for daylight saving or month lengths. Mutually exclusive with calendarInterval — provide one or the other, not both.
+   */
+  fixedInterval?: string | undefined;
+  /**
+   * Date format string for date_histogram bucket keys. Uses Elasticsearch date format patterns (e.g. "yyyy-MM-dd").
+   */
+  format?: string | undefined;
+  /**
+   * Bucket width for histogram aggregation. Required when type is "histogram".
+   */
+  interval?: number | undefined;
+  /**
+   * Minimum document count for a bucket to be included in the result. Applies to: terms, histogram, date_histogram. Default is 1.
+   */
+  minDocCount?: number | undefined;
+  /**
+   * Unique name for this aggregation. Used as the key in the response `aggregations` object.
+   */
+  name: string;
+  /**
+   * Sort order for terms buckets. Key is the sort field ("_count", "_key", or a sub-aggregation name), value is direction.
+   */
+  order?: { [k: string]: SiteNestedAggregationOrder } | undefined;
+  /**
+   * Percentile values to calculate (0-100). Required when type is "percentiles".
+   */
+  percents?: Array<number> | undefined;
+  /**
+   * Custom numeric ranges for range aggregation. Required when type is "range". Each range has an inclusive `from` and exclusive `to`.
+   */
+  ranges?: Array<RangeDefinition> | undefined;
+  /**
+   * Maximum number of buckets to return. Applies to: terms (default 20), geotile_grid (precision level). Ignored by metric aggregations (stats, min, max, etc.).
+   */
+  size?: number | undefined;
+  /**
+   * IANA timezone for date_histogram bucketing (e.g. "Europe/London", "UTC"). Defaults to UTC.
+   */
+  timeZone?: string | undefined;
+  /**
+   * Type of aggregation
+   */
+  type: SiteNestedAggregationType;
+};
+
+/** @internal */
+export const SiteNestedAggregationOrder$outboundSchema: z.ZodNativeEnum<
+  typeof SiteNestedAggregationOrder
+> = z.nativeEnum(SiteNestedAggregationOrder);
+
+/** @internal */
+export const SiteNestedAggregationType$outboundSchema: z.ZodNativeEnum<
+  typeof SiteNestedAggregationType
+> = z.nativeEnum(SiteNestedAggregationType);
+
+/** @internal */
+export type SiteNestedAggregation$Outbound = {
+  aggs?: Array<SiteLeafAggregation$Outbound> | undefined;
+  calendarInterval?: string | undefined;
+  field: string;
+  fixedInterval?: string | undefined;
+  format?: string | undefined;
+  interval?: number | undefined;
+  minDocCount?: number | undefined;
+  name: string;
+  order?: { [k: string]: string } | undefined;
+  percents?: Array<number> | undefined;
+  ranges?: Array<RangeDefinition$Outbound> | undefined;
+  size?: number | undefined;
+  timeZone?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const SiteNestedAggregation$outboundSchema: z.ZodType<
+  SiteNestedAggregation$Outbound,
+  z.ZodTypeDef,
+  SiteNestedAggregation
+> = z.object({
+  aggs: z.array(SiteLeafAggregation$outboundSchema).optional(),
+  calendarInterval: z.string().optional(),
+  field: z.string(),
+  fixedInterval: z.string().optional(),
+  format: z.string().optional(),
+  interval: z.number().optional(),
+  minDocCount: z.number().int().optional(),
+  name: z.string(),
+  order: z.record(SiteNestedAggregationOrder$outboundSchema).optional(),
+  percents: z.array(z.number()).optional(),
+  ranges: z.array(RangeDefinition$outboundSchema).optional(),
+  size: z.number().int().optional(),
+  timeZone: z.string().optional(),
+  type: SiteNestedAggregationType$outboundSchema,
+});
+
+export function siteNestedAggregationToJSON(
+  siteNestedAggregation: SiteNestedAggregation,
+): string {
+  return JSON.stringify(
+    SiteNestedAggregation$outboundSchema.parse(siteNestedAggregation),
+  );
+}

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

@@ -0,0 +1,67 @@
+/*
+ * 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";
+
+/**
+ * Planning application statistics from applications whose boundary intersects this site. Null when no planning applications intersect or when enrichment has not yet run.
+ */
+export type SitePlanningStats = {
+  /**
+   * Distinct application types
+   */
+  applicationTypes: Array<string>;
+  /**
+   * Number of approved applications
+   */
+  approvals: number;
+  /**
+   * UTC date of the most recent planning application, in ISO 8601 format
+   */
+  latestApplicationDate?: string | undefined;
+  /**
+   * Decision on the most recent application
+   */
+  latestDecision?: string | undefined;
+  /**
+   * Number of pending applications
+   */
+  pending: number;
+  /**
+   * Number of refused applications
+   */
+  refusals: number;
+  /**
+   * Total planning applications intersecting this site
+   */
+  totalApplications: number;
+};
+
+/** @internal */
+export const SitePlanningStats$inboundSchema: z.ZodType<
+  SitePlanningStats,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  applicationTypes: z.array(z.string()),
+  approvals: z.number(),
+  latestApplicationDate: z.string().optional(),
+  latestDecision: z.string().optional(),
+  pending: z.number(),
+  refusals: z.number(),
+  totalApplications: z.number(),
+});
+
+export function sitePlanningStatsFromJSON(
+  jsonString: string,
+): SafeParseResult<SitePlanningStats, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SitePlanningStats$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SitePlanningStats' from JSON`,
+  );
+}