@vepler/sdk 2.38.2 → 2.39.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vepler/sdk",
-  "version": "2.38.2",
+  "version": "2.39.0",
   "author": "Vepler Limited",
   "type": "module",
   "tshy": {

package/src/lib/config.ts

@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "2.38.2",
+  openapiDocVersion: "2.39.0",
   sdkVersion: "0.10.0",
   genVersion: "2.836.5",
-  userAgent: "speakeasy-sdk/typescript 0.10.0 2.836.5 2.38.2 @vepler/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.10.0 2.836.5 2.39.0 @vepler/sdk",
 } as const;

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

@@ -6,10 +6,18 @@ 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 {
+  ExtendedStatsAggregationResult,
+  ExtendedStatsAggregationResult$inboundSchema,
+} from "./extendedstatsaggregationresult.js";
 import {
   HistogramAggregationResult,
   HistogramAggregationResult$inboundSchema,
 } from "./histogramaggregationresult.js";
+import {
+  PercentilesAggregationResult,
+  PercentilesAggregationResult$inboundSchema,
+} from "./percentilesaggregationresult.js";
 import {
   SingleValueAggregationResult,
   SingleValueAggregationResult$inboundSchema,
@@ -24,9 +32,11 @@ import {
 } from "./termsaggregationresult.js";
 
 export type AggregationResult =
+  | ExtendedStatsAggregationResult
   | StatsAggregationResult
   | TermsAggregationResult
   | HistogramAggregationResult
+  | PercentilesAggregationResult
   | SingleValueAggregationResult;
 
 /** @internal */
@@ -35,9 +45,11 @@ export const AggregationResult$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.union([
+  ExtendedStatsAggregationResult$inboundSchema,
   StatsAggregationResult$inboundSchema,
   TermsAggregationResult$inboundSchema,
   HistogramAggregationResult$inboundSchema,
+  PercentilesAggregationResult$inboundSchema,
   SingleValueAggregationResult$inboundSchema,
 ]);
 

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

@@ -0,0 +1,150 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Standard deviation bounds (±2σ from mean). Null if count is 0.
+ */
+export type StdDeviationBounds = {
+  lower: number | null;
+  lowerPopulation: number | null;
+  lowerSampling: number | null;
+  upper: number | null;
+  upperPopulation: number | null;
+  upperSampling: number | null;
+};
+
+export type ExtendedStatsAggregationResult = {
+  /**
+   * Mean value. Null if count is 0.
+   */
+  avg: number | null;
+  /**
+   * Number of documents with a non-null value
+   */
+  count: number;
+  /**
+   * Maximum value. Null if count is 0.
+   */
+  max: number | null;
+  /**
+   * Minimum value. Null if count is 0.
+   */
+  min: number | null;
+  /**
+   * Population standard deviation. Null if count is 0.
+   */
+  stdDeviation: number | null;
+  /**
+   * Standard deviation bounds (±2σ from mean). Null if count is 0.
+   */
+  stdDeviationBounds: StdDeviationBounds | null;
+  /**
+   * Population standard deviation. Null if count is 0.
+   */
+  stdDeviationPopulation: number | null;
+  /**
+   * Sample standard deviation. Null if count < 2.
+   */
+  stdDeviationSampling: number | null;
+  /**
+   * Sum of all values. Null if count is 0.
+   */
+  sum: number | null;
+  /**
+   * Sum of squared values. Null if count is 0.
+   */
+  sumOfSquares: number | null;
+  /**
+   * Population variance. Null if count is 0.
+   */
+  variance: number | null;
+  /**
+   * Population variance. Null if count is 0.
+   */
+  variancePopulation: number | null;
+  /**
+   * Sample variance (Bessel's correction). Null if count < 2.
+   */
+  varianceSampling: number | null;
+};
+
+/** @internal */
+export const StdDeviationBounds$inboundSchema: z.ZodType<
+  StdDeviationBounds,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lower: z.nullable(z.number()),
+  lower_population: z.nullable(z.number()),
+  lower_sampling: z.nullable(z.number()),
+  upper: z.nullable(z.number()),
+  upper_population: z.nullable(z.number()),
+  upper_sampling: z.nullable(z.number()),
+}).transform((v) => {
+  return remap$(v, {
+    "lower_population": "lowerPopulation",
+    "lower_sampling": "lowerSampling",
+    "upper_population": "upperPopulation",
+    "upper_sampling": "upperSampling",
+  });
+});
+
+export function stdDeviationBoundsFromJSON(
+  jsonString: string,
+): SafeParseResult<StdDeviationBounds, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StdDeviationBounds$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StdDeviationBounds' from JSON`,
+  );
+}
+
+/** @internal */
+export const ExtendedStatsAggregationResult$inboundSchema: z.ZodType<
+  ExtendedStatsAggregationResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  avg: z.nullable(z.number()),
+  count: z.number(),
+  max: z.nullable(z.number()),
+  min: z.nullable(z.number()),
+  std_deviation: z.nullable(z.number()),
+  std_deviation_bounds: z.nullable(
+    z.lazy(() => StdDeviationBounds$inboundSchema),
+  ),
+  std_deviation_population: z.nullable(z.number()),
+  std_deviation_sampling: z.nullable(z.number()),
+  sum: z.nullable(z.number()),
+  sum_of_squares: z.nullable(z.number()),
+  variance: z.nullable(z.number()),
+  variance_population: z.nullable(z.number()),
+  variance_sampling: z.nullable(z.number()),
+}).transform((v) => {
+  return remap$(v, {
+    "std_deviation": "stdDeviation",
+    "std_deviation_bounds": "stdDeviationBounds",
+    "std_deviation_population": "stdDeviationPopulation",
+    "std_deviation_sampling": "stdDeviationSampling",
+    "sum_of_squares": "sumOfSquares",
+    "variance_population": "variancePopulation",
+    "variance_sampling": "varianceSampling",
+  });
+});
+
+export function extendedStatsAggregationResultFromJSON(
+  jsonString: string,
+): SafeParseResult<ExtendedStatsAggregationResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExtendedStatsAggregationResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExtendedStatsAggregationResult' from JSON`,
+  );
+}

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

@@ -38,6 +38,7 @@ export * from "./counciltaxbanddetails.js";
 export * from "./counciltaxdata.js";
 export * from "./dateofbirth.js";
 export * from "./epcdata.js";
+export * from "./extendedstatsaggregationresult.js";
 export * from "./geographiccontext.js";
 export * from "./healthresponse.js";
 export * from "./histogramaggregationresult.js";
@@ -57,6 +58,7 @@ export * from "./officerlistresponse.js";
 export * from "./officerresponse.js";
 export * from "./officersummary.js";
 export * from "./outcodelookupresponse.js";
+export * from "./percentilesaggregationresult.js";
 export * from "./person.js";
 export * from "./personcluster.js";
 export * from "./personclusterresponse.js";

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

@@ -0,0 +1,34 @@
+/*
+ * 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 PercentilesAggregationResult = {
+  /**
+   * Percentile values keyed by percentile (e.g. '25.0' → 150.5). Null when no documents match.
+   */
+  values: { [k: string]: number | null };
+};
+
+/** @internal */
+export const PercentilesAggregationResult$inboundSchema: z.ZodType<
+  PercentilesAggregationResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  values: z.record(z.nullable(z.number())),
+});
+
+export function percentilesAggregationResultFromJSON(
+  jsonString: string,
+): SafeParseResult<PercentilesAggregationResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PercentilesAggregationResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PercentilesAggregationResult' from JSON`,
+  );
+}

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

@@ -106,23 +106,23 @@ export type Site = {
   /**
    * Site boundary geometry in WGS84 (EPSG:4326). GeoJSON Polygon or MultiPolygon with coordinates in [longitude, latitude] order. Excluded from the default attribute set for performance — request explicitly via `attributes: ["boundary"]`.
    */
-  boundary: GeoJSONPolygon | GeoJSONMultiPolygon;
+  boundary?: GeoJSONPolygon | GeoJSONMultiPolygon | undefined;
   /**
    * WGS84 coordinate pair
    */
-  centroid: SiteCoordinates;
+  centroid?: SiteCoordinates | undefined;
   /**
-   * HM Land Registry class of title code. Determines title quality and tenure. Freehold codes: AF (Absolute Freehold), QF (Qualified Freehold), PF (Possessory Freehold), SF (Good Leasehold - Freehold). Leasehold codes: AL (Absolute Leasehold), GL (Good Leasehold), QL (Qualified Leasehold), PL (Possessory Leasehold), SL (Scheme Leasehold). Other codes: CF (Caution Freehold), CL (Caution Leasehold), AR, PR, QR (Rentcharge variants), CN (Caution).
+   * HM Land Registry class of title code. Determines title quality and tenure. Freehold codes: AF (Absolute Freehold), QF (Qualified Freehold), PF (Possessory Freehold), SF (Good Leasehold - Freehold). Leasehold codes: AL (Absolute Leasehold), GL (Good Leasehold), QL (Qualified Leasehold), PL (Possessory Leasehold), SL (Scheme Leasehold). Other codes: CF (Caution Freehold), CL (Caution Leasehold), AR, PR, QR (Rentcharge variants), CN (Caution). Not included in the default attribute set — request explicitly via `attributes: ["classTitleCode"]`.
    */
-  classTitleCode: string | null;
+  classTitleCode?: string | null | undefined;
   /**
    * ISO 3166-1 alpha-2 country code
    */
   country: string;
   /**
-   * HM Land Registry estate interest code. Almost always "EL" (Estate in Land). Does not indicate freehold/leasehold — use `classTitleCode` or `tenureType` instead.
+   * HM Land Registry estate interest code. Almost always "EL" (Estate in Land). Does not indicate freehold/leasehold — use `classTitleCode` or `tenureType` instead. Not included in the default attribute set — request explicitly via `attributes: ["estateInterestCode"]`.
    */
-  estateInterestCode: string | null;
+  estateInterestCode?: string | null | undefined;
   /**
    * Land use classifications derived from spatial analysis. Examples: residential, commercial, agricultural, mixed_use, industrial, vacant.
    */
@@ -132,9 +132,9 @@ export type Site = {
    */
   locationCount: number;
   /**
-   * UPRNs (Unique Property Reference Numbers) linked to this title via spatial intersection with the Ordnance Survey AddressBase dataset
+   * UPRNs (Unique Property Reference Numbers) linked to this title via spatial intersection with the Ordnance Survey AddressBase dataset. Not included in the default attribute set — request explicitly via `attributes: ["locationIds"]`.
    */
-  locationIds: Array<string>;
+  locationIds?: Array<string> | undefined;
   /**
    * Object type identifier
    */
@@ -148,9 +148,9 @@ export type Site = {
    */
   planning: SitePlanningStats | null;
   /**
-   * Internal polygon identifiers from the source shapefile. Used for provenance tracking; not typically needed by API consumers.
+   * Internal polygon identifiers from the source shapefile. Used for provenance tracking; not typically needed by API consumers. Not included in the default attribute set — request explicitly via `attributes: ["polygonIds"]`.
    */
-  polygonIds: Array<number>;
+  polygonIds?: Array<number> | undefined;
   /**
    * Aggregated statistics for properties linked to this site. Null when no properties are linked (locationCount is 0) or when enrichment has not yet run.
    */
@@ -300,18 +300,18 @@ export const Site$inboundSchema: z.ZodType<Site, z.ZodTypeDef, unknown> = z
     boundary: z.union([
       z.lazy(() => GeoJSONPolygon$inboundSchema),
       z.lazy(() => GeoJSONMultiPolygon$inboundSchema),
-    ]),
-    centroid: z.lazy(() => SiteCoordinates$inboundSchema),
-    classTitleCode: z.nullable(z.string()),
+    ]).optional(),
+    centroid: z.lazy(() => SiteCoordinates$inboundSchema).optional(),
+    classTitleCode: z.nullable(z.string()).optional(),
     country: z.string(),
-    estateInterestCode: z.nullable(z.string()),
+    estateInterestCode: z.nullable(z.string()).optional(),
     landUse: z.array(z.string()),
     locationCount: z.number(),
-    locationIds: z.array(z.string()),
+    locationIds: z.array(z.string()).optional(),
     object: SiteObject$inboundSchema,
     overlays: z.array(z.string()),
     planning: z.nullable(SitePlanningStats$inboundSchema),
-    polygonIds: z.array(z.number()),
+    polygonIds: z.array(z.number()).optional(),
     propertyStats: z.nullable(SitePropertyStats$inboundSchema),
     registeredAt: z.nullable(z.string()),
     registry: z.string(),

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

@@ -77,7 +77,6 @@ export const Field = {
   AreaMetricsProsperityDecile: "areaMetrics.prosperityDecile",
   RegisteredAt: "registeredAt",
   UpdatedAt: "updatedAt",
-  IndexedAt: "indexedAt",
 } as const;
 /**
  * Field to filter on. See the full field list in the schema documentation.

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

@@ -78,9 +78,6 @@ export const SiteQueryRequestField = {
   PlanningApprovals: "planning.approvals",
   RegisteredAt: "registeredAt",
   UpdatedAt: "updatedAt",
-  IndexedAt: "indexedAt",
-  Score: "_score",
-  Doc: "_doc",
 } as const;
 /**
  * Field to sort by