@vepler/sdk 2.33.0 → 2.37.0

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

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type SitePointAreaFilter = {
+  /**
+   * Latitude in decimal degrees (WGS84)
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees (WGS84)
+   */
+  lon: number;
+  /**
+   * Search radius with unit suffix. Supported units: m (metres), km (kilometres), mi (miles), yd (yards), ft (feet).
+   */
+  radius: string;
+  type: "point";
+};
+
+/** @internal */
+export type SitePointAreaFilter$Outbound = {
+  lat: number;
+  lon: number;
+  radius: string;
+  type: "point";
+};
+
+/** @internal */
+export const SitePointAreaFilter$outboundSchema: z.ZodType<
+  SitePointAreaFilter$Outbound,
+  z.ZodTypeDef,
+  SitePointAreaFilter
+> = z.object({
+  lat: z.number(),
+  lon: z.number(),
+  radius: z.string(),
+  type: z.literal("point"),
+});
+
+export function sitePointAreaFilterToJSON(
+  sitePointAreaFilter: SitePointAreaFilter,
+): string {
+  return JSON.stringify(
+    SitePointAreaFilter$outboundSchema.parse(sitePointAreaFilter),
+  );
+}

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

@@ -0,0 +1,64 @@
+/*
+ * 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 polygon. Defaults to "intersects". intersects: site boundary overlaps the polygon (most common). within: site boundary is entirely inside the polygon. contains: site boundary entirely contains the polygon.
+ */
+export const SitePolygonAreaFilterRelation = {
+  Intersects: "intersects",
+  Within: "within",
+  Contains: "contains",
+} as const;
+/**
+ * Spatial relation between the site boundary and this polygon. Defaults to "intersects". intersects: site boundary overlaps the polygon (most common). within: site boundary is entirely inside the polygon. contains: site boundary entirely contains the polygon.
+ */
+export type SitePolygonAreaFilterRelation = ClosedEnum<
+  typeof SitePolygonAreaFilterRelation
+>;
+
+export type SitePolygonAreaFilter = {
+  /**
+   * GeoJSON polygon rings in [longitude, latitude] order (EPSG:4326). The first ring is the outer boundary; subsequent rings are holes. Each ring must be closed (first coordinate equals last).
+   */
+  coordinates: Array<Array<Array<number>>>;
+  /**
+   * Spatial relation between the site boundary and this polygon. Defaults to "intersects". intersects: site boundary overlaps the polygon (most common). within: site boundary is entirely inside the polygon. contains: site boundary entirely contains the polygon.
+   */
+  relation?: SitePolygonAreaFilterRelation | undefined;
+  type: "polygon";
+};
+
+/** @internal */
+export const SitePolygonAreaFilterRelation$outboundSchema: z.ZodNativeEnum<
+  typeof SitePolygonAreaFilterRelation
+> = z.nativeEnum(SitePolygonAreaFilterRelation);
+
+/** @internal */
+export type SitePolygonAreaFilter$Outbound = {
+  coordinates: Array<Array<Array<number>>>;
+  relation?: string | undefined;
+  type: "polygon";
+};
+
+/** @internal */
+export const SitePolygonAreaFilter$outboundSchema: z.ZodType<
+  SitePolygonAreaFilter$Outbound,
+  z.ZodTypeDef,
+  SitePolygonAreaFilter
+> = z.object({
+  coordinates: z.array(z.array(z.array(z.number()))),
+  relation: SitePolygonAreaFilterRelation$outboundSchema.optional(),
+  type: z.literal("polygon"),
+});
+
+export function sitePolygonAreaFilterToJSON(
+  sitePolygonAreaFilter: SitePolygonAreaFilter,
+): string {
+  return JSON.stringify(
+    SitePolygonAreaFilter$outboundSchema.parse(sitePolygonAreaFilter),
+  );
+}

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

@@ -0,0 +1,39 @@
+/*
+ * 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 SitePropertiesResponse = {
+  /**
+   * UPRNs (Unique Property Reference Numbers) linked to this site via spatial intersection
+   */
+  locationIds: Array<string>;
+  /**
+   * Total number of linked UPRNs
+   */
+  total: number;
+};
+
+/** @internal */
+export const SitePropertiesResponse$inboundSchema: z.ZodType<
+  SitePropertiesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  locationIds: z.array(z.string()),
+  total: z.number(),
+});
+
+export function sitePropertiesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SitePropertiesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SitePropertiesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SitePropertiesResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,62 @@
+/*
+ * 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";
+
+/**
+ * Aggregated statistics for properties linked to this site. Null when no properties are linked (locationCount is 0) or when enrichment has not yet run.
+ */
+export type SitePropertyStats = {
+  /**
+   * Average monthly rent in pence
+   */
+  avgRent?: number | undefined;
+  /**
+   * Average estimated property value in pence
+   */
+  avgValue?: number | undefined;
+  /**
+   * Distinct property types found
+   */
+  propertyTypes: Array<string>;
+  /**
+   * Combined floor area in square metres
+   */
+  totalFloorArea?: number | undefined;
+  /**
+   * Count of properties linked to this site
+   */
+  totalProperties: number;
+  /**
+   * Proportion of vacant properties (0-1)
+   */
+  vacancyRate?: number | undefined;
+};
+
+/** @internal */
+export const SitePropertyStats$inboundSchema: z.ZodType<
+  SitePropertyStats,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  avgRent: z.number().optional(),
+  avgValue: z.number().optional(),
+  propertyTypes: z.array(z.string()),
+  totalFloorArea: z.number().optional(),
+  totalProperties: z.number(),
+  vacancyRate: z.number().optional(),
+});
+
+export function sitePropertyStatsFromJSON(
+  jsonString: string,
+): SafeParseResult<SitePropertyStats, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SitePropertyStats$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SitePropertyStats' from JSON`,
+  );
+}

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

@@ -0,0 +1,197 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Comparison operator. eq: equals (exact match). ne: not equals. gt/gte/lt/lte: greater/less than (inclusive with e). For numeric and date fields. in: value is in array. nin: value is not in array. contains: case-sensitive substring match (wildcard). startswith: case-sensitive prefix match. endswith: case-sensitive suffix match.
+ */
+export const SiteQueryConditionComparator = {
+  Eq: "eq",
+  Ne: "ne",
+  Gt: "gt",
+  Gte: "gte",
+  Lt: "lt",
+  Lte: "lte",
+  In: "in",
+  Nin: "nin",
+  Contains: "contains",
+  Startswith: "startswith",
+  Endswith: "endswith",
+} as const;
+/**
+ * Comparison operator. eq: equals (exact match). ne: not equals. gt/gte/lt/lte: greater/less than (inclusive with e). For numeric and date fields. in: value is in array. nin: value is not in array. contains: case-sensitive substring match (wildcard). startswith: case-sensitive prefix match. endswith: case-sensitive suffix match.
+ */
+export type SiteQueryConditionComparator = ClosedEnum<
+  typeof SiteQueryConditionComparator
+>;
+
+/**
+ * Field to filter on. See the full field list in the schema documentation.
+ */
+export const Field = {
+  SiteId: "siteId",
+  Country: "country",
+  Registry: "registry",
+  TitleRef: "titleRef",
+  Sources: "sources",
+  EstateInterestCode: "estateInterestCode",
+  ClassTitleCode: "classTitleCode",
+  TenureType: "tenureType",
+  Status: "status",
+  AreaSqm: "areaSqm",
+  LocationCount: "locationCount",
+  Overlays: "overlays",
+  Relationships: "relationships",
+  LocationId: "locationId",
+  LocationIds: "locationIds",
+  LandUse: "landUse",
+  TagsVacant: "tags.vacant",
+  TagsBrownfield: "tags.brownfield",
+  TagsAgricultural: "tags.agricultural",
+  TagsDevelopmentPotential: "tags.developmentPotential",
+  TagsMultipleProperties: "tags.multipleProperties",
+  TagsNoProperties: "tags.noProperties",
+  PropertyStatsTotalProperties: "propertyStats.totalProperties",
+  PropertyStatsAvgValue: "propertyStats.avgValue",
+  PropertyStatsAvgRent: "propertyStats.avgRent",
+  PropertyStatsTotalFloorArea: "propertyStats.totalFloorArea",
+  PropertyStatsVacancyRate: "propertyStats.vacancyRate",
+  PropertyStatsPropertyTypes: "propertyStats.propertyTypes",
+  PlanningTotalApplications: "planning.totalApplications",
+  PlanningApprovals: "planning.approvals",
+  PlanningRefusals: "planning.refusals",
+  PlanningPending: "planning.pending",
+  PlanningLatestDecision: "planning.latestDecision",
+  PlanningApplicationTypes: "planning.applicationTypes",
+  PlanningLatestApplicationDate: "planning.latestApplicationDate",
+  ScoresDevelopmentPotential: "scores.developmentPotential",
+  ScoresEnvironmentalRisk: "scores.environmentalRisk",
+  ScoresInvestmentAttractiveness: "scores.investmentAttractiveness",
+  AreaMetricsCrimeScore: "areaMetrics.crimeScore",
+  AreaMetricsDeprivationIndex: "areaMetrics.deprivationIndex",
+  AreaMetricsConnectivityScore: "areaMetrics.connectivityScore",
+  AreaMetricsProsperityScore: "areaMetrics.prosperityScore",
+  AreaMetricsProsperityDecile: "areaMetrics.prosperityDecile",
+  RegisteredAt: "registeredAt",
+  UpdatedAt: "updatedAt",
+  IndexedAt: "indexedAt",
+} as const;
+/**
+ * Field to filter on. See the full field list in the schema documentation.
+ */
+export type Field = ClosedEnum<typeof Field>;
+
+export type SiteQueryCondition4 = string | number | boolean;
+
+/**
+ * Value to compare against. Use an array for `in` and `nin` comparators.
+ */
+export type SiteQueryConditionValue =
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean>;
+
+export type SiteQueryCondition = {
+  /**
+   * Comparison operator. eq: equals (exact match). ne: not equals. gt/gte/lt/lte: greater/less than (inclusive with e). For numeric and date fields. in: value is in array. nin: value is not in array. contains: case-sensitive substring match (wildcard). startswith: case-sensitive prefix match. endswith: case-sensitive suffix match.
+   */
+  comparator: SiteQueryConditionComparator;
+  /**
+   * Field to filter on. See the full field list in the schema documentation.
+   */
+  field: Field;
+  /**
+   * Value to compare against. Use an array for `in` and `nin` comparators.
+   */
+  value: string | number | boolean | Array<string | number | boolean>;
+};
+
+/** @internal */
+export const SiteQueryConditionComparator$outboundSchema: z.ZodNativeEnum<
+  typeof SiteQueryConditionComparator
+> = z.nativeEnum(SiteQueryConditionComparator);
+
+/** @internal */
+export const Field$outboundSchema: z.ZodNativeEnum<typeof Field> = z.nativeEnum(
+  Field,
+);
+
+/** @internal */
+export type SiteQueryCondition4$Outbound = string | number | boolean;
+
+/** @internal */
+export const SiteQueryCondition4$outboundSchema: z.ZodType<
+  SiteQueryCondition4$Outbound,
+  z.ZodTypeDef,
+  SiteQueryCondition4
+> = z.union([z.string(), z.number(), z.boolean()]);
+
+export function siteQueryCondition4ToJSON(
+  siteQueryCondition4: SiteQueryCondition4,
+): string {
+  return JSON.stringify(
+    SiteQueryCondition4$outboundSchema.parse(siteQueryCondition4),
+  );
+}
+
+/** @internal */
+export type SiteQueryConditionValue$Outbound =
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean>;
+
+/** @internal */
+export const SiteQueryConditionValue$outboundSchema: z.ZodType<
+  SiteQueryConditionValue$Outbound,
+  z.ZodTypeDef,
+  SiteQueryConditionValue
+> = z.union([
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.array(z.union([z.string(), z.number(), z.boolean()])),
+]);
+
+export function siteQueryConditionValueToJSON(
+  siteQueryConditionValue: SiteQueryConditionValue,
+): string {
+  return JSON.stringify(
+    SiteQueryConditionValue$outboundSchema.parse(siteQueryConditionValue),
+  );
+}
+
+/** @internal */
+export type SiteQueryCondition$Outbound = {
+  comparator: string;
+  field: string;
+  value: string | number | boolean | Array<string | number | boolean>;
+};
+
+/** @internal */
+export const SiteQueryCondition$outboundSchema: z.ZodType<
+  SiteQueryCondition$Outbound,
+  z.ZodTypeDef,
+  SiteQueryCondition
+> = z.object({
+  comparator: SiteQueryConditionComparator$outboundSchema,
+  field: Field$outboundSchema,
+  value: z.union([
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.array(z.union([z.string(), z.number(), z.boolean()])),
+  ]),
+});
+
+export function siteQueryConditionToJSON(
+  siteQueryCondition: SiteQueryCondition,
+): string {
+  return JSON.stringify(
+    SiteQueryCondition$outboundSchema.parse(siteQueryCondition),
+  );
+}

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

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  SiteQueryCondition,
+  SiteQueryCondition$Outbound,
+  SiteQueryCondition$outboundSchema,
+} from "./sitequerycondition.js";
+
+export type SiteQueryGroup = {
+  /**
+   * Array of filter conditions. All conditions within a group share the parent operator's logic.
+   */
+  conditions: Array<SiteQueryCondition>;
+};
+
+/** @internal */
+export type SiteQueryGroup$Outbound = {
+  conditions: Array<SiteQueryCondition$Outbound>;
+};
+
+/** @internal */
+export const SiteQueryGroup$outboundSchema: z.ZodType<
+  SiteQueryGroup$Outbound,
+  z.ZodTypeDef,
+  SiteQueryGroup
+> = z.object({
+  conditions: z.array(SiteQueryCondition$outboundSchema),
+});
+
+export function siteQueryGroupToJSON(siteQueryGroup: SiteQueryGroup): string {
+  return JSON.stringify(SiteQueryGroup$outboundSchema.parse(siteQueryGroup));
+}

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

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  SiteQueryGroup,
+  SiteQueryGroup$Outbound,
+  SiteQueryGroup$outboundSchema,
+} from "./sitequerygroup.js";
+
+/**
+ * Logical operator applied to conditions within this group. AND: all conditions must match. OR: at least one condition must match.
+ */
+export const SiteQueryOperatorOperator = {
+  And: "AND",
+  Or: "OR",
+} as const;
+/**
+ * Logical operator applied to conditions within this group. AND: all conditions must match. OR: at least one condition must match.
+ */
+export type SiteQueryOperatorOperator = ClosedEnum<
+  typeof SiteQueryOperatorOperator
+>;
+
+export type SiteQueryOperator = {
+  /**
+   * Condition groups. Conditions from all groups are flattened and combined using the operator.
+   */
+  groups: Array<SiteQueryGroup>;
+  /**
+   * Logical operator applied to conditions within this group. AND: all conditions must match. OR: at least one condition must match.
+   */
+  operator: SiteQueryOperatorOperator;
+};
+
+/** @internal */
+export const SiteQueryOperatorOperator$outboundSchema: z.ZodNativeEnum<
+  typeof SiteQueryOperatorOperator
+> = z.nativeEnum(SiteQueryOperatorOperator);
+
+/** @internal */
+export type SiteQueryOperator$Outbound = {
+  groups: Array<SiteQueryGroup$Outbound>;
+  operator: string;
+};
+
+/** @internal */
+export const SiteQueryOperator$outboundSchema: z.ZodType<
+  SiteQueryOperator$Outbound,
+  z.ZodTypeDef,
+  SiteQueryOperator
+> = z.object({
+  groups: z.array(SiteQueryGroup$outboundSchema),
+  operator: SiteQueryOperatorOperator$outboundSchema,
+});
+
+export function siteQueryOperatorToJSON(
+  siteQueryOperator: SiteQueryOperator,
+): string {
+  return JSON.stringify(
+    SiteQueryOperator$outboundSchema.parse(siteQueryOperator),
+  );
+}