@vepler/sdk 2.33.0 → 2.38.2

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

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  SiteAggregationInput,
+  SiteAggregationInput$Outbound,
+  SiteAggregationInput$outboundSchema,
+} from "./siteaggregationinput.js";
+import {
+  SiteAreaFilter,
+  SiteAreaFilter$Outbound,
+  SiteAreaFilter$outboundSchema,
+} from "./siteareafilter.js";
+import {
+  SiteFilters,
+  SiteFilters$Outbound,
+  SiteFilters$outboundSchema,
+} from "./sitefilters.js";
+import {
+  SiteQueryOperator,
+  SiteQueryOperator$Outbound,
+  SiteQueryOperator$outboundSchema,
+} from "./sitequeryoperator.js";
+
+export type SiteAggregateRequest = {
+  /**
+   * Aggregation definitions (max 10)
+   */
+  aggregations: Array<SiteAggregationInput>;
+  /**
+   * Geographic area filters (combined with OR logic)
+   */
+  area?: Array<SiteAreaFilter> | undefined;
+  filters?: SiteFilters | undefined;
+  /**
+   * Advanced query operators
+   */
+  query?: Array<SiteQueryOperator> | undefined;
+};
+
+/** @internal */
+export type SiteAggregateRequest$Outbound = {
+  aggregations: Array<SiteAggregationInput$Outbound>;
+  area?: Array<SiteAreaFilter$Outbound> | undefined;
+  filters?: SiteFilters$Outbound | undefined;
+  query?: Array<SiteQueryOperator$Outbound> | undefined;
+};
+
+/** @internal */
+export const SiteAggregateRequest$outboundSchema: z.ZodType<
+  SiteAggregateRequest$Outbound,
+  z.ZodTypeDef,
+  SiteAggregateRequest
+> = z.object({
+  aggregations: z.array(SiteAggregationInput$outboundSchema),
+  area: z.array(SiteAreaFilter$outboundSchema).optional(),
+  filters: SiteFilters$outboundSchema.optional(),
+  query: z.array(SiteQueryOperator$outboundSchema).optional(),
+});
+
+export function siteAggregateRequestToJSON(
+  siteAggregateRequest: SiteAggregateRequest,
+): string {
+  return JSON.stringify(
+    SiteAggregateRequest$outboundSchema.parse(siteAggregateRequest),
+  );
+}

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

@@ -0,0 +1,43 @@
+/*
+ * 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 {
+  AggregationResult,
+  AggregationResult$inboundSchema,
+} from "./aggregationresult.js";
+
+export type SiteAggregateResponse = {
+  /**
+   * Aggregation results keyed by the `name` you provided in the request. Result shape depends on the aggregation type: terms → buckets with key + doc_count. stats → count, min, max, avg, sum. min/max/avg/sum/cardinality → single value. histogram/date_histogram → buckets with key + doc_count. percentiles → values object with percentile keys.
+   */
+  aggregations: { [k: string]: AggregationResult };
+  /**
+   * Total documents matching the query filters (before aggregation)
+   */
+  total: number;
+};
+
+/** @internal */
+export const SiteAggregateResponse$inboundSchema: z.ZodType<
+  SiteAggregateResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  aggregations: z.record(AggregationResult$inboundSchema),
+  total: z.number(),
+});
+
+export function siteAggregateResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteAggregateResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteAggregateResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteAggregateResponse' from JSON`,
+  );
+}

package/src/sdk/models/shared/siteaggregationinput.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 {
+  SiteNestedAggregation,
+  SiteNestedAggregation$Outbound,
+  SiteNestedAggregation$outboundSchema,
+} from "./sitenestedaggregation.js";
+
+export const SiteAggregationInputOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type SiteAggregationInputOrder = ClosedEnum<
+  typeof SiteAggregationInputOrder
+>;
+
+/**
+ * Type of aggregation
+ */
+export const SiteAggregationInputType = {
+  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 SiteAggregationInputType = ClosedEnum<
+  typeof SiteAggregationInputType
+>;
+
+export type SiteAggregationInput = {
+  /**
+   * Nested sub-aggregations (max 5, up to 2 levels deep)
+   */
+  aggs?: Array<SiteNestedAggregation> | 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]: SiteAggregationInputOrder } | 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: SiteAggregationInputType;
+};
+
+/** @internal */
+export const SiteAggregationInputOrder$outboundSchema: z.ZodNativeEnum<
+  typeof SiteAggregationInputOrder
+> = z.nativeEnum(SiteAggregationInputOrder);
+
+/** @internal */
+export const SiteAggregationInputType$outboundSchema: z.ZodNativeEnum<
+  typeof SiteAggregationInputType
+> = z.nativeEnum(SiteAggregationInputType);
+
+/** @internal */
+export type SiteAggregationInput$Outbound = {
+  aggs?: Array<SiteNestedAggregation$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 SiteAggregationInput$outboundSchema: z.ZodType<
+  SiteAggregationInput$Outbound,
+  z.ZodTypeDef,
+  SiteAggregationInput
+> = z.object({
+  aggs: z.array(SiteNestedAggregation$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(SiteAggregationInputOrder$outboundSchema).optional(),
+  percents: z.array(z.number()).optional(),
+  ranges: z.array(RangeDefinition$outboundSchema).optional(),
+  size: z.number().int().optional(),
+  timeZone: z.string().optional(),
+  type: SiteAggregationInputType$outboundSchema,
+});
+
+export function siteAggregationInputToJSON(
+  siteAggregationInput: SiteAggregationInput,
+): string {
+  return JSON.stringify(
+    SiteAggregationInput$outboundSchema.parse(siteAggregationInput),
+  );
+}

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

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  SiteBoundingBoxAreaFilter,
+  SiteBoundingBoxAreaFilter$Outbound,
+  SiteBoundingBoxAreaFilter$outboundSchema,
+} from "./siteboundingboxareafilter.js";
+import {
+  SiteContainsPointAreaFilter,
+  SiteContainsPointAreaFilter$Outbound,
+  SiteContainsPointAreaFilter$outboundSchema,
+} from "./sitecontainspointareafilter.js";
+import {
+  SiteMultiPolygonAreaFilter,
+  SiteMultiPolygonAreaFilter$Outbound,
+  SiteMultiPolygonAreaFilter$outboundSchema,
+} from "./sitemultipolygonareafilter.js";
+import {
+  SitePointAreaFilter,
+  SitePointAreaFilter$Outbound,
+  SitePointAreaFilter$outboundSchema,
+} from "./sitepointareafilter.js";
+import {
+  SitePolygonAreaFilter,
+  SitePolygonAreaFilter$Outbound,
+  SitePolygonAreaFilter$outboundSchema,
+} from "./sitepolygonareafilter.js";
+
+export type SiteAreaFilter =
+  | SiteBoundingBoxAreaFilter
+  | SiteContainsPointAreaFilter
+  | SiteMultiPolygonAreaFilter
+  | SitePointAreaFilter
+  | SitePolygonAreaFilter;
+
+/** @internal */
+export type SiteAreaFilter$Outbound =
+  | SiteBoundingBoxAreaFilter$Outbound
+  | SiteContainsPointAreaFilter$Outbound
+  | SiteMultiPolygonAreaFilter$Outbound
+  | SitePointAreaFilter$Outbound
+  | SitePolygonAreaFilter$Outbound;
+
+/** @internal */
+export const SiteAreaFilter$outboundSchema: z.ZodType<
+  SiteAreaFilter$Outbound,
+  z.ZodTypeDef,
+  SiteAreaFilter
+> = z.union([
+  SiteBoundingBoxAreaFilter$outboundSchema,
+  SiteContainsPointAreaFilter$outboundSchema,
+  SiteMultiPolygonAreaFilter$outboundSchema,
+  SitePointAreaFilter$outboundSchema,
+  SitePolygonAreaFilter$outboundSchema,
+]);
+
+export function siteAreaFilterToJSON(siteAreaFilter: SiteAreaFilter): string {
+  return JSON.stringify(SiteAreaFilter$outboundSchema.parse(siteAreaFilter));
+}

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

@@ -0,0 +1,57 @@
+/*
+ * 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";
+
+/**
+ * Area-level metrics from the LSOA (Lower Layer Super Output Area) containing the site centroid. Includes crime, deprivation, connectivity, and prosperity indices. Null when the centroid cannot be matched to an LSOA (e.g. sites outside England and Wales).
+ */
+export type SiteAreaMetrics = {
+  /**
+   * Broadband and mobile connectivity score
+   */
+  connectivityScore?: number | undefined;
+  /**
+   * Crime safety score from the site's LSOA (0-100)
+   */
+  crimeScore?: number | undefined;
+  /**
+   * Index of Multiple Deprivation decile (1-10)
+   */
+  deprivationIndex?: number | undefined;
+  /**
+   * Prosperity decile (1-10)
+   */
+  prosperityDecile?: number | undefined;
+  /**
+   * Vepler Prosperity Index score
+   */
+  prosperityScore?: number | undefined;
+};
+
+/** @internal */
+export const SiteAreaMetrics$inboundSchema: z.ZodType<
+  SiteAreaMetrics,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  connectivityScore: z.number().optional(),
+  crimeScore: z.number().optional(),
+  deprivationIndex: z.number().optional(),
+  prosperityDecile: z.number().optional(),
+  prosperityScore: z.number().optional(),
+});
+
+export function siteAreaMetricsFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteAreaMetrics, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteAreaMetrics$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteAreaMetrics' from JSON`,
+  );
+}

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

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Fields to return
+ */
+export type SiteBatchIdsRequestAttributes = string | Array<string>;
+
+export type SiteBatchIdsRequest = {
+  /**
+   * Fields to return
+   */
+  attributes?: string | Array<string> | undefined;
+  /**
+   * Array of site IDs to look up
+   */
+  siteIds: Array<string>;
+};
+
+/** @internal */
+export type SiteBatchIdsRequestAttributes$Outbound = string | Array<string>;
+
+/** @internal */
+export const SiteBatchIdsRequestAttributes$outboundSchema: z.ZodType<
+  SiteBatchIdsRequestAttributes$Outbound,
+  z.ZodTypeDef,
+  SiteBatchIdsRequestAttributes
+> = z.union([z.string(), z.array(z.string())]);
+
+export function siteBatchIdsRequestAttributesToJSON(
+  siteBatchIdsRequestAttributes: SiteBatchIdsRequestAttributes,
+): string {
+  return JSON.stringify(
+    SiteBatchIdsRequestAttributes$outboundSchema.parse(
+      siteBatchIdsRequestAttributes,
+    ),
+  );
+}
+
+/** @internal */
+export type SiteBatchIdsRequest$Outbound = {
+  attributes?: string | Array<string> | undefined;
+  siteIds: Array<string>;
+};
+
+/** @internal */
+export const SiteBatchIdsRequest$outboundSchema: z.ZodType<
+  SiteBatchIdsRequest$Outbound,
+  z.ZodTypeDef,
+  SiteBatchIdsRequest
+> = z.object({
+  attributes: z.union([z.string(), z.array(z.string())]).optional(),
+  siteIds: z.array(z.string()),
+});
+
+export function siteBatchIdsRequestToJSON(
+  siteBatchIdsRequest: SiteBatchIdsRequest,
+): string {
+  return JSON.stringify(
+    SiteBatchIdsRequest$outboundSchema.parse(siteBatchIdsRequest),
+  );
+}

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

@@ -0,0 +1,114 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * South-east corner of the bounding box
+ */
+export type BottomRight = {
+  /**
+   * South latitude
+   */
+  lat: number;
+  /**
+   * East longitude
+   */
+  lon: number;
+};
+
+/**
+ * North-west corner of the bounding box
+ */
+export type TopLeft = {
+  /**
+   * North latitude
+   */
+  lat: number;
+  /**
+   * West longitude
+   */
+  lon: number;
+};
+
+/**
+ * Filter sites whose centroid falls within a rectangular bounding box. Useful for map viewport queries.
+ */
+export type SiteBoundingBoxAreaFilter = {
+  /**
+   * South-east corner of the bounding box
+   */
+  bottomRight: BottomRight;
+  /**
+   * North-west corner of the bounding box
+   */
+  topLeft: TopLeft;
+  type: "boundingBox";
+};
+
+/** @internal */
+export type BottomRight$Outbound = {
+  lat: number;
+  lon: number;
+};
+
+/** @internal */
+export const BottomRight$outboundSchema: z.ZodType<
+  BottomRight$Outbound,
+  z.ZodTypeDef,
+  BottomRight
+> = z.object({
+  lat: z.number(),
+  lon: z.number(),
+});
+
+export function bottomRightToJSON(bottomRight: BottomRight): string {
+  return JSON.stringify(BottomRight$outboundSchema.parse(bottomRight));
+}
+
+/** @internal */
+export type TopLeft$Outbound = {
+  lat: number;
+  lon: number;
+};
+
+/** @internal */
+export const TopLeft$outboundSchema: z.ZodType<
+  TopLeft$Outbound,
+  z.ZodTypeDef,
+  TopLeft
+> = z.object({
+  lat: z.number(),
+  lon: z.number(),
+});
+
+export function topLeftToJSON(topLeft: TopLeft): string {
+  return JSON.stringify(TopLeft$outboundSchema.parse(topLeft));
+}
+
+/** @internal */
+export type SiteBoundingBoxAreaFilter$Outbound = {
+  bottomRight: BottomRight$Outbound;
+  topLeft: TopLeft$Outbound;
+  type: "boundingBox";
+};
+
+/** @internal */
+export const SiteBoundingBoxAreaFilter$outboundSchema: z.ZodType<
+  SiteBoundingBoxAreaFilter$Outbound,
+  z.ZodTypeDef,
+  SiteBoundingBoxAreaFilter
+> = z.object({
+  bottomRight: z.lazy(() => BottomRight$outboundSchema),
+  topLeft: z.lazy(() => TopLeft$outboundSchema),
+  type: z.literal("boundingBox"),
+});
+
+export function siteBoundingBoxAreaFilterToJSON(
+  siteBoundingBoxAreaFilter: SiteBoundingBoxAreaFilter,
+): string {
+  return JSON.stringify(
+    SiteBoundingBoxAreaFilter$outboundSchema.parse(siteBoundingBoxAreaFilter),
+  );
+}

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

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Find sites whose boundary polygon contains this point. Equivalent to a point-in-polygon query.
+ */
+export type SiteContainsPointAreaFilter = {
+  /**
+   * Latitude in decimal degrees (WGS84)
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees (WGS84)
+   */
+  lon: number;
+  type: "containsPoint";
+};
+
+/** @internal */
+export type SiteContainsPointAreaFilter$Outbound = {
+  lat: number;
+  lon: number;
+  type: "containsPoint";
+};
+
+/** @internal */
+export const SiteContainsPointAreaFilter$outboundSchema: z.ZodType<
+  SiteContainsPointAreaFilter$Outbound,
+  z.ZodTypeDef,
+  SiteContainsPointAreaFilter
+> = z.object({
+  lat: z.number(),
+  lon: z.number(),
+  type: z.literal("containsPoint"),
+});
+
+export function siteContainsPointAreaFilterToJSON(
+  siteContainsPointAreaFilter: SiteContainsPointAreaFilter,
+): string {
+  return JSON.stringify(
+    SiteContainsPointAreaFilter$outboundSchema.parse(
+      siteContainsPointAreaFilter,
+    ),
+  );
+}