@vepler/sdk 2.131.2 → 2.137.0

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

@@ -4,23 +4,9 @@
 
 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";
 
-/**
- * GeoJSON geometry type
- */
-export const BuildingPartSchemasType = {
-  MultiPolygon: "MultiPolygon",
-} as const;
-/**
- * GeoJSON geometry type
- */
-export type BuildingPartSchemasType = ClosedEnum<
-  typeof BuildingPartSchemasType
->;
-
 /**
  * GeoJSON MultiPolygon geometry
  */
@@ -32,20 +18,9 @@ export type BuildingPartGeoJSONMultiPolygon = {
   /**
    * GeoJSON geometry type
    */
-  type: BuildingPartSchemasType;
+  type: "MultiPolygon";
 };
 
-/**
- * GeoJSON geometry type
- */
-export const BuildingPartType = {
-  Polygon: "Polygon",
-} as const;
-/**
- * GeoJSON geometry type
- */
-export type BuildingPartType = ClosedEnum<typeof BuildingPartType>;
-
 /**
  * GeoJSON Polygon geometry
  */
@@ -57,7 +32,7 @@ export type BuildingPartGeoJSONPolygon = {
   /**
    * GeoJSON geometry type
    */
-  type: BuildingPartType;
+  type: "Polygon";
 };
 
 /**
@@ -65,8 +40,7 @@ export type BuildingPartGeoJSONPolygon = {
  */
 export type BuildingPartFootprint =
   | BuildingPartGeoJSONPolygon
-  | BuildingPartGeoJSONMultiPolygon
-  | any;
+  | BuildingPartGeoJSONMultiPolygon;
 
 export type BuildingPart = {
   /**
@@ -87,7 +61,6 @@ export type BuildingPart = {
   footprint?:
     | BuildingPartGeoJSONPolygon
     | BuildingPartGeoJSONMultiPolygon
-    | any
     | null
     | undefined;
   /**
@@ -108,11 +81,6 @@ export type BuildingPart = {
   physicalLevel?: string | null | undefined;
 };
 
-/** @internal */
-export const BuildingPartSchemasType$inboundSchema: z.ZodNativeEnum<
-  typeof BuildingPartSchemasType
-> = z.nativeEnum(BuildingPartSchemasType);
-
 /** @internal */
 export const BuildingPartGeoJSONMultiPolygon$inboundSchema: z.ZodType<
   BuildingPartGeoJSONMultiPolygon,
@@ -120,7 +88,7 @@ export const BuildingPartGeoJSONMultiPolygon$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   coordinates: z.array(z.array(z.array(z.array(z.number())))),
-  type: BuildingPartSchemasType$inboundSchema,
+  type: z.literal("MultiPolygon"),
 });
 
 export function buildingPartGeoJSONMultiPolygonFromJSON(
@@ -133,11 +101,6 @@ export function buildingPartGeoJSONMultiPolygonFromJSON(
   );
 }
 
-/** @internal */
-export const BuildingPartType$inboundSchema: z.ZodNativeEnum<
-  typeof BuildingPartType
-> = z.nativeEnum(BuildingPartType);
-
 /** @internal */
 export const BuildingPartGeoJSONPolygon$inboundSchema: z.ZodType<
   BuildingPartGeoJSONPolygon,
@@ -145,7 +108,7 @@ export const BuildingPartGeoJSONPolygon$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   coordinates: z.array(z.array(z.array(z.number()))),
-  type: BuildingPartType$inboundSchema,
+  type: z.literal("Polygon"),
 });
 
 export function buildingPartGeoJSONPolygonFromJSON(
@@ -166,7 +129,6 @@ export const BuildingPartFootprint$inboundSchema: z.ZodType<
 > = z.union([
   z.lazy(() => BuildingPartGeoJSONPolygon$inboundSchema),
   z.lazy(() => BuildingPartGeoJSONMultiPolygon$inboundSchema),
-  z.any(),
 ]);
 
 export function buildingPartFootprintFromJSON(
@@ -192,7 +154,6 @@ export const BuildingPart$inboundSchema: z.ZodType<
     z.union([
       z.lazy(() => BuildingPartGeoJSONPolygon$inboundSchema),
       z.lazy(() => BuildingPartGeoJSONMultiPolygon$inboundSchema),
-      z.any(),
     ]),
   ).optional(),
   heightMax: z.nullable(z.number()).optional(),

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

@@ -37,7 +37,7 @@ export type CatchmentFeature = {
   /**
    * GeoJSON geometry (Polygon or MultiPolygon).
    */
-  geometry: { [k: string]: any | null };
+  geometry: { [k: string]: any };
   properties: Properties;
   type: CatchmentFeatureType;
 };
@@ -86,7 +86,7 @@ export const CatchmentFeature$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  geometry: z.record(z.nullable(z.any())),
+  geometry: z.record(z.any()),
   properties: z.lazy(() => Properties$inboundSchema),
   type: CatchmentFeatureType$inboundSchema,
 });

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

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * additive = new field or endpoint; deprecation = old field/endpoint marked for removal; removal = a previously-deprecated thing has been removed; fix = clarification of behaviour, no shape change.
+ */
+export const Kind = {
+  Additive: "additive",
+  Deprecation: "deprecation",
+  Removal: "removal",
+  Fix: "fix",
+} as const;
+/**
+ * additive = new field or endpoint; deprecation = old field/endpoint marked for removal; removal = a previously-deprecated thing has been removed; fix = clarification of behaviour, no shape change.
+ */
+export type Kind = OpenEnum<typeof Kind>;
+
+export const ChangelogEntryObject = {
+  ChangelogEntry: "changelog_entry",
+} as const;
+export type ChangelogEntryObject = ClosedEnum<typeof ChangelogEntryObject>;
+
+export type ChangelogEntry = {
+  /**
+   * Stable references to the shapes / endpoints touched (e.g. `School.performance.ks4`, `endpoint:GET /v1/schools/{schoolId}`). Use for diff tooling.
+   */
+  affects: Array<string>;
+  /**
+   * Plain-English summary.
+   */
+  description: string;
+  docUrl?: string | null | undefined;
+  /**
+   * additive = new field or endpoint; deprecation = old field/endpoint marked for removal; removal = a previously-deprecated thing has been removed; fix = clarification of behaviour, no shape change.
+   */
+  kind: Kind;
+  /**
+   * For deprecation/removal: how callers should migrate.
+   */
+  migrationNotes?: string | null | undefined;
+  object: ChangelogEntryObject;
+  /**
+   * Schema version this entry was published under.
+   */
+  objectVersion: string;
+  publishedAt: Date;
+  /**
+   * For deprecation entries: when the removal becomes effective. RFC 8594 `Sunset` header on the deprecated endpoint matches this.
+   */
+  sunsetAt?: Date | null | undefined;
+};
+
+/** @internal */
+export const Kind$inboundSchema: z.ZodType<Kind, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Kind);
+
+/** @internal */
+export const ChangelogEntryObject$inboundSchema: z.ZodNativeEnum<
+  typeof ChangelogEntryObject
+> = z.nativeEnum(ChangelogEntryObject);
+
+/** @internal */
+export const ChangelogEntry$inboundSchema: z.ZodType<
+  ChangelogEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  affects: z.array(z.string()),
+  description: z.string(),
+  docUrl: z.nullable(z.string()).optional(),
+  kind: Kind$inboundSchema,
+  migrationNotes: z.nullable(z.string()).optional(),
+  object: ChangelogEntryObject$inboundSchema,
+  objectVersion: z.string(),
+  publishedAt: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  sunsetAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+});
+
+export function changelogEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<ChangelogEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChangelogEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChangelogEntry' from JSON`,
+  );
+}

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

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

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

@@ -0,0 +1,90 @@
+/*
+ * 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 {
+  ComplianceStatusValue,
+  ComplianceStatusValue$inboundSchema,
+} from "./compliancestatusvalue.js";
+import {
+  ExceedanceLevel,
+  ExceedanceLevel$inboundSchema,
+} from "./exceedancelevel.js";
+
+/**
+ * Framework-tagged compliance check — a metric may carry multiple entries against different frameworks
+ */
+export type ComplianceStatus = {
+  /**
+   * Severity of exceedance when status is 'exceedance'
+   */
+  exceedanceLevel?: ExceedanceLevel | undefined;
+  /**
+   * Framework identifier — e.g. 'UK_AQS_2010', 'WHO_AQG_2021', 'EU_2008_50_EC', 'US_NAAQS', 'EA_NOISE_BS4142'
+   */
+  framework: string;
+  /**
+   * Specific edition or revision of the framework
+   */
+  frameworkVersion?: string | undefined;
+  /**
+   * Framework limit value the observed value is compared against
+   */
+  limit: number;
+  /**
+   * Percentage margin: (limit - value) / limit * 100. Positive when compliant, negative when in exceedance
+   */
+  marginPct?: number | undefined;
+  /**
+   * Machine code for the metric being checked — e.g. 'annual_mean_no2', 'max_daily_8hr_o3'
+   */
+  metric: string;
+  /**
+   * Canonical URL to the framework definition
+   */
+  reference?: string | undefined;
+  /**
+   * Compliance state against the named framework limit
+   */
+  status: ComplianceStatusValue;
+  /**
+   * Unit of measure — e.g. 'µg/m³', 'mg/m³', 'dB(A)'
+   */
+  unit: string;
+  /**
+   * Observed value
+   */
+  value: number;
+};
+
+/** @internal */
+export const ComplianceStatus$inboundSchema: z.ZodType<
+  ComplianceStatus,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  exceedanceLevel: ExceedanceLevel$inboundSchema.optional(),
+  framework: z.string(),
+  frameworkVersion: z.string().optional(),
+  limit: z.number(),
+  marginPct: z.number().optional(),
+  metric: z.string(),
+  reference: z.string().optional(),
+  status: ComplianceStatusValue$inboundSchema,
+  unit: z.string(),
+  value: z.number(),
+});
+
+export function complianceStatusFromJSON(
+  jsonString: string,
+): SafeParseResult<ComplianceStatus, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ComplianceStatus$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ComplianceStatus' from JSON`,
+  );
+}

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

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Compliance state against the named framework limit
+ */
+export const ComplianceStatusValue = {
+  Compliant: "compliant",
+  Exceedance: "exceedance",
+  Approaching: "approaching",
+} as const;
+/**
+ * Compliance state against the named framework limit
+ */
+export type ComplianceStatusValue = OpenEnum<typeof ComplianceStatusValue>;
+
+/** @internal */
+export const ComplianceStatusValue$inboundSchema: z.ZodType<
+  ComplianceStatusValue,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ComplianceStatusValue);

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

@@ -0,0 +1,50 @@
+/*
+ * 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 {
+  ConfidenceFactor,
+  ConfidenceFactor$inboundSchema,
+} from "./confidencefactor.js";
+import {
+  ConfidenceLevel,
+  ConfidenceLevel$inboundSchema,
+} from "./confidencelevel.js";
+
+/**
+ * Confidence assessment for a product response
+ */
+export type Confidence = {
+  /**
+   * Optional list of factors that drove the level
+   */
+  factors?: Array<ConfidenceFactor> | undefined;
+  /**
+   * Overall confidence tier
+   */
+  level: ConfidenceLevel;
+};
+
+/** @internal */
+export const Confidence$inboundSchema: z.ZodType<
+  Confidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  factors: z.array(ConfidenceFactor$inboundSchema).optional(),
+  level: ConfidenceLevel$inboundSchema,
+});
+
+export function confidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<Confidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Confidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Confidence' from JSON`,
+  );
+}

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

@@ -0,0 +1,51 @@
+/*
+ * 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 {
+  ConfidenceFactorSeverity,
+  ConfidenceFactorSeverity$inboundSchema,
+} from "./confidencefactorseverity.js";
+
+/**
+ * Single factor contributing to the confidence assessment
+ */
+export type ConfidenceFactor = {
+  /**
+   * Machine-readable code for filtering and analytics
+   */
+  code: string;
+  /**
+   * Human-readable explanation of this factor
+   */
+  description: string;
+  /**
+   * How prominently a confidence factor should be surfaced to consumers
+   */
+  severity: ConfidenceFactorSeverity;
+};
+
+/** @internal */
+export const ConfidenceFactor$inboundSchema: z.ZodType<
+  ConfidenceFactor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  description: z.string(),
+  severity: ConfidenceFactorSeverity$inboundSchema,
+});
+
+export function confidenceFactorFromJSON(
+  jsonString: string,
+): SafeParseResult<ConfidenceFactor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConfidenceFactor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConfidenceFactor' from JSON`,
+  );
+}

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

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * How prominently a confidence factor should be surfaced to consumers
+ */
+export const ConfidenceFactorSeverity = {
+  Info: "info",
+  Warning: "warning",
+  Blocker: "blocker",
+} as const;
+/**
+ * How prominently a confidence factor should be surfaced to consumers
+ */
+export type ConfidenceFactorSeverity = OpenEnum<
+  typeof ConfidenceFactorSeverity
+>;
+
+/** @internal */
+export const ConfidenceFactorSeverity$inboundSchema: z.ZodType<
+  ConfidenceFactorSeverity,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ConfidenceFactorSeverity);

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

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Overall confidence tier
+ */
+export const ConfidenceLevel = {
+  High: "high",
+  Medium: "medium",
+  Low: "low",
+} as const;
+/**
+ * Overall confidence tier
+ */
+export type ConfidenceLevel = OpenEnum<typeof ConfidenceLevel>;
+
+/** @internal */
+export const ConfidenceLevel$inboundSchema: z.ZodType<
+  ConfidenceLevel,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ConfidenceLevel);

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

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const CostBand = {
+  Low: "low",
+  Medium: "medium",
+  High: "high",
+} as const;
+export type CostBand = OpenEnum<typeof CostBand>;
+
+/** @internal */
+export const CostBand$inboundSchema: z.ZodType<
+  CostBand,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(CostBand);