@vepler/sdk 2.50.3 → 2.57.3

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

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  EPCLocalAuthorityAreaFilter,
+  EPCLocalAuthorityAreaFilter$Outbound,
+  EPCLocalAuthorityAreaFilter$outboundSchema,
+} from "./epclocalauthorityareafilter.js";
+import {
+  EPCPointAreaFilter,
+  EPCPointAreaFilter$Outbound,
+  EPCPointAreaFilter$outboundSchema,
+} from "./epcpointareafilter.js";
+import {
+  EPCPolygonAreaFilter,
+  EPCPolygonAreaFilter$Outbound,
+  EPCPolygonAreaFilter$outboundSchema,
+} from "./epcpolygonareafilter.js";
+import {
+  EPCPostcodeAreaFilter,
+  EPCPostcodeAreaFilter$Outbound,
+  EPCPostcodeAreaFilter$outboundSchema,
+} from "./epcpostcodeareafilter.js";
+
+export type EPCAreaFilter =
+  | EPCPostcodeAreaFilter
+  | EPCPointAreaFilter
+  | EPCPolygonAreaFilter
+  | EPCLocalAuthorityAreaFilter;
+
+/** @internal */
+export type EPCAreaFilter$Outbound =
+  | EPCPostcodeAreaFilter$Outbound
+  | EPCPointAreaFilter$Outbound
+  | EPCPolygonAreaFilter$Outbound
+  | EPCLocalAuthorityAreaFilter$Outbound;
+
+/** @internal */
+export const EPCAreaFilter$outboundSchema: z.ZodType<
+  EPCAreaFilter$Outbound,
+  z.ZodTypeDef,
+  EPCAreaFilter
+> = z.union([
+  EPCPostcodeAreaFilter$outboundSchema,
+  EPCPointAreaFilter$outboundSchema,
+  EPCPolygonAreaFilter$outboundSchema,
+  EPCLocalAuthorityAreaFilter$outboundSchema,
+]);
+
+export function epcAreaFilterToJSON(epcAreaFilter: EPCAreaFilter): string {
+  return JSON.stringify(EPCAreaFilter$outboundSchema.parse(epcAreaFilter));
+}

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

@@ -781,7 +781,7 @@ export type SecondaryHeating = {
 /**
  * Wall construction type: cavity, solid_brick, timber_frame, sandstone_or_limestone, etc.
  */
-export const Construction = {
+export const EPCDataConstruction = {
   Cavity: "cavity",
   SolidBrick: "solid_brick",
   TimberFrame: "timber_frame",
@@ -799,7 +799,7 @@ export const Construction = {
 /**
  * Wall construction type: cavity, solid_brick, timber_frame, sandstone_or_limestone, etc.
  */
-export type Construction = OpenEnum<typeof Construction>;
+export type EPCDataConstruction = OpenEnum<typeof EPCDataConstruction>;
 
 /**
  * Non-null when the source value was corrupted/incomplete. Null = normal quality.
@@ -882,7 +882,7 @@ export type Walls = {
   /**
    * Wall construction type: cavity, solid_brick, timber_frame, sandstone_or_limestone, etc.
    */
-  construction: Construction | null;
+  construction: EPCDataConstruction | null;
   /**
    * Non-null when the source value was corrupted/incomplete. Null = normal quality.
    */
@@ -2142,11 +2142,11 @@ export function secondaryHeatingFromJSON(
 }
 
 /** @internal */
-export const Construction$inboundSchema: z.ZodType<
-  Construction,
+export const EPCDataConstruction$inboundSchema: z.ZodType<
+  EPCDataConstruction,
   z.ZodTypeDef,
   unknown
-> = openEnums.inboundSchema(Construction);
+> = openEnums.inboundSchema(EPCDataConstruction);
 
 /** @internal */
 export const EPCDataSchemasFabricDataQuality$inboundSchema: z.ZodType<
@@ -2180,7 +2180,7 @@ export const EPCDataSchemasInsulationType$inboundSchema: z.ZodType<
 /** @internal */
 export const Walls$inboundSchema: z.ZodType<Walls, z.ZodTypeDef, unknown> = z
   .object({
-    construction: z.nullable(Construction$inboundSchema),
+    construction: z.nullable(EPCDataConstruction$inboundSchema),
     dataQuality: z.nullable(EPCDataSchemasFabricDataQuality$inboundSchema),
     description: z.nullable(z.string()),
     energyEfficiency: z.nullable(

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type EPCLocalAuthorityAreaFilter = {
+  type: "local_authority";
+  /**
+   * ONS local authority code (e.g. 'E09000033').
+   */
+  value: string;
+};
+
+/** @internal */
+export type EPCLocalAuthorityAreaFilter$Outbound = {
+  type: "local_authority";
+  value: string;
+};
+
+/** @internal */
+export const EPCLocalAuthorityAreaFilter$outboundSchema: z.ZodType<
+  EPCLocalAuthorityAreaFilter$Outbound,
+  z.ZodTypeDef,
+  EPCLocalAuthorityAreaFilter
+> = z.object({
+  type: z.literal("local_authority"),
+  value: z.string(),
+});
+
+export function epcLocalAuthorityAreaFilterToJSON(
+  epcLocalAuthorityAreaFilter: EPCLocalAuthorityAreaFilter,
+): string {
+  return JSON.stringify(
+    EPCLocalAuthorityAreaFilter$outboundSchema.parse(
+      epcLocalAuthorityAreaFilter,
+    ),
+  );
+}

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

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type EPCPointAreaFilter = {
+  /**
+   * [latitude, longitude] in WGS84. Note: [lat, lng] order, not GeoJSON.
+   */
+  coordinates: Array<number>;
+  /**
+   * Search radius in metres.
+   */
+  radius: number;
+  type: "point";
+};
+
+/** @internal */
+export type EPCPointAreaFilter$Outbound = {
+  coordinates: Array<number>;
+  radius: number;
+  type: "point";
+};
+
+/** @internal */
+export const EPCPointAreaFilter$outboundSchema: z.ZodType<
+  EPCPointAreaFilter$Outbound,
+  z.ZodTypeDef,
+  EPCPointAreaFilter
+> = z.object({
+  coordinates: z.array(z.number()),
+  radius: z.number(),
+  type: z.literal("point"),
+});
+
+export function epcPointAreaFilterToJSON(
+  epcPointAreaFilter: EPCPointAreaFilter,
+): string {
+  return JSON.stringify(
+    EPCPointAreaFilter$outboundSchema.parse(epcPointAreaFilter),
+  );
+}

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type EPCPolygonAreaFilter = {
+  /**
+   * Polygon rings as [lat, lng] pairs. First and last coordinate must match.
+   */
+  coordinates: Array<Array<Array<number>>>;
+  type: "polygon";
+};
+
+/** @internal */
+export type EPCPolygonAreaFilter$Outbound = {
+  coordinates: Array<Array<Array<number>>>;
+  type: "polygon";
+};
+
+/** @internal */
+export const EPCPolygonAreaFilter$outboundSchema: z.ZodType<
+  EPCPolygonAreaFilter$Outbound,
+  z.ZodTypeDef,
+  EPCPolygonAreaFilter
+> = z.object({
+  coordinates: z.array(z.array(z.array(z.number()))),
+  type: z.literal("polygon"),
+});
+
+export function epcPolygonAreaFilterToJSON(
+  epcPolygonAreaFilter: EPCPolygonAreaFilter,
+): string {
+  return JSON.stringify(
+    EPCPolygonAreaFilter$outboundSchema.parse(epcPolygonAreaFilter),
+  );
+}

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type EPCPostcodeAreaFilter = {
+  type: "postcode";
+  /**
+   * Full or partial UK postcode
+   */
+  value: string;
+};
+
+/** @internal */
+export type EPCPostcodeAreaFilter$Outbound = {
+  type: "postcode";
+  value: string;
+};
+
+/** @internal */
+export const EPCPostcodeAreaFilter$outboundSchema: z.ZodType<
+  EPCPostcodeAreaFilter$Outbound,
+  z.ZodTypeDef,
+  EPCPostcodeAreaFilter
+> = z.object({
+  type: z.literal("postcode"),
+  value: z.string(),
+});
+
+export function epcPostcodeAreaFilterToJSON(
+  epcPostcodeAreaFilter: EPCPostcodeAreaFilter,
+): string {
+  return JSON.stringify(
+    EPCPostcodeAreaFilter$outboundSchema.parse(epcPostcodeAreaFilter),
+  );
+}

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

@@ -0,0 +1,169 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Comparison operator.
+ */
+export const Comparator = {
+  Eq: "eq",
+  Ne: "ne",
+  Gt: "gt",
+  Gte: "gte",
+  Lt: "lt",
+  Lte: "lte",
+  In: "in",
+  Nin: "nin",
+} as const;
+/**
+ * Comparison operator.
+ */
+export type Comparator = ClosedEnum<typeof Comparator>;
+
+/**
+ * Field to filter on.
+ */
+export const Field = {
+  CertificateType: "certificateType",
+  CurrentRatingBand: "currentRatingBand",
+  CurrentRatingScore: "currentRatingScore",
+  MeesCompliance: "meesCompliance",
+  Source: "source",
+  InspectionDate: "inspectionDate",
+  LodgementDate: "lodgementDate",
+  LocalAuthority: "localAuthority",
+  PropertyType: "propertyType",
+  TransactionType: "transactionType",
+  TotalFloorArea: "totalFloorArea",
+  PostcodeNoSpace: "postcodeNoSpace",
+  FabricWallsConstruction: "fabric.walls.construction",
+  FabricWallsInsulationType: "fabric.walls.insulationType",
+  FabricWallsInsulationPresent: "fabric.walls.insulationPresent",
+  FabricWallsThermalTransmittance: "fabric.walls.thermalTransmittance",
+  FabricRoofRoofType: "fabric.roof.roofType",
+  FabricRoofInsulationDepthMm: "fabric.roof.insulationDepthMm",
+  FabricRoofInsulationPresent: "fabric.roof.insulationPresent",
+  FabricFloorFloorType: "fabric.floor.floorType",
+  FabricFloorInsulationPresent: "fabric.floor.insulationPresent",
+  FabricMainHeatingSystemType: "fabric.mainHeating.systemType",
+  FabricMainHeatingFuel: "fabric.mainHeating.fuel",
+  FabricMainHeatingHeatPumpType: "fabric.mainHeating.heatPumpType",
+  DomesticDetailsBuiltForm: "domesticDetails.builtForm",
+  DomesticDetailsTenure: "domesticDetails.tenure",
+  DomesticDetailsConstructionAgeStartYear:
+    "domesticDetails.constructionAge.startYear",
+  DomesticDetailsConstructionAgeEndYear:
+    "domesticDetails.constructionAge.endYear",
+  EmissionsCo2Current: "emissions.co2Current",
+  EmissionsCo2PerFloorArea: "emissions.co2PerFloorArea",
+  EmissionsEnergyConsumptionCurrent: "emissions.energyConsumptionCurrent",
+  RunningCostsHeatingCurrent: "runningCosts.heating.current",
+  RunningCostsHotWaterCurrent: "runningCosts.hotWater.current",
+  RunningCostsLightingCurrent: "runningCosts.lighting.current",
+} as const;
+/**
+ * Field to filter on.
+ */
+export type Field = ClosedEnum<typeof Field>;
+
+export type EPCQueryCondition4 = string | number;
+
+/**
+ * Value to compare against. Use arrays for 'in'/'nin'.
+ */
+export type Value = string | number | boolean | Array<string | number>;
+
+export type EPCQueryCondition = {
+  /**
+   * Comparison operator.
+   */
+  comparator: Comparator;
+  /**
+   * Field to filter on.
+   */
+  field: Field;
+  /**
+   * Value to compare against. Use arrays for 'in'/'nin'.
+   */
+  value: string | number | boolean | Array<string | number>;
+};
+
+/** @internal */
+export const Comparator$outboundSchema: z.ZodNativeEnum<typeof Comparator> = z
+  .nativeEnum(Comparator);
+
+/** @internal */
+export const Field$outboundSchema: z.ZodNativeEnum<typeof Field> = z.nativeEnum(
+  Field,
+);
+
+/** @internal */
+export type EPCQueryCondition4$Outbound = string | number;
+
+/** @internal */
+export const EPCQueryCondition4$outboundSchema: z.ZodType<
+  EPCQueryCondition4$Outbound,
+  z.ZodTypeDef,
+  EPCQueryCondition4
+> = z.union([z.string(), z.number()]);
+
+export function epcQueryCondition4ToJSON(
+  epcQueryCondition4: EPCQueryCondition4,
+): string {
+  return JSON.stringify(
+    EPCQueryCondition4$outboundSchema.parse(epcQueryCondition4),
+  );
+}
+
+/** @internal */
+export type Value$Outbound = string | number | boolean | Array<string | number>;
+
+/** @internal */
+export const Value$outboundSchema: z.ZodType<
+  Value$Outbound,
+  z.ZodTypeDef,
+  Value
+> = z.union([
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.array(z.union([z.string(), z.number()])),
+]);
+
+export function valueToJSON(value: Value): string {
+  return JSON.stringify(Value$outboundSchema.parse(value));
+}
+
+/** @internal */
+export type EPCQueryCondition$Outbound = {
+  comparator: string;
+  field: string;
+  value: string | number | boolean | Array<string | number>;
+};
+
+/** @internal */
+export const EPCQueryCondition$outboundSchema: z.ZodType<
+  EPCQueryCondition$Outbound,
+  z.ZodTypeDef,
+  EPCQueryCondition
+> = z.object({
+  comparator: Comparator$outboundSchema,
+  field: Field$outboundSchema,
+  value: z.union([
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.array(z.union([z.string(), z.number()])),
+  ]),
+});
+
+export function epcQueryConditionToJSON(
+  epcQueryCondition: EPCQueryCondition,
+): string {
+  return JSON.stringify(
+    EPCQueryCondition$outboundSchema.parse(epcQueryCondition),
+  );
+}

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

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  EPCQueryCondition,
+  EPCQueryCondition$Outbound,
+  EPCQueryCondition$outboundSchema,
+} from "./epcquerycondition.js";
+
+export type EPCQueryGroup = {
+  /**
+   * Conditions within this group (AND logic).
+   */
+  conditions: Array<EPCQueryCondition>;
+};
+
+/** @internal */
+export type EPCQueryGroup$Outbound = {
+  conditions: Array<EPCQueryCondition$Outbound>;
+};
+
+/** @internal */
+export const EPCQueryGroup$outboundSchema: z.ZodType<
+  EPCQueryGroup$Outbound,
+  z.ZodTypeDef,
+  EPCQueryGroup
+> = z.object({
+  conditions: z.array(EPCQueryCondition$outboundSchema),
+});
+
+export function epcQueryGroupToJSON(epcQueryGroup: EPCQueryGroup): string {
+  return JSON.stringify(EPCQueryGroup$outboundSchema.parse(epcQueryGroup));
+}

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

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  EPCQueryGroup,
+  EPCQueryGroup$Outbound,
+  EPCQueryGroup$outboundSchema,
+} from "./epcquerygroup.js";
+
+/**
+ * Logical operator between groups.
+ */
+export const Operator = {
+  And: "AND",
+  Or: "OR",
+} as const;
+/**
+ * Logical operator between groups.
+ */
+export type Operator = ClosedEnum<typeof Operator>;
+
+export type EPCQueryOperator = {
+  /**
+   * Condition groups.
+   */
+  groups: Array<EPCQueryGroup>;
+  /**
+   * Logical operator between groups.
+   */
+  operator: Operator;
+};
+
+/** @internal */
+export const Operator$outboundSchema: z.ZodNativeEnum<typeof Operator> = z
+  .nativeEnum(Operator);
+
+/** @internal */
+export type EPCQueryOperator$Outbound = {
+  groups: Array<EPCQueryGroup$Outbound>;
+  operator: string;
+};
+
+/** @internal */
+export const EPCQueryOperator$outboundSchema: z.ZodType<
+  EPCQueryOperator$Outbound,
+  z.ZodTypeDef,
+  EPCQueryOperator
+> = z.object({
+  groups: z.array(EPCQueryGroup$outboundSchema),
+  operator: Operator$outboundSchema,
+});
+
+export function epcQueryOperatorToJSON(
+  epcQueryOperator: EPCQueryOperator,
+): string {
+  return JSON.stringify(
+    EPCQueryOperator$outboundSchema.parse(epcQueryOperator),
+  );
+}

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

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  EPCAreaFilter,
+  EPCAreaFilter$Outbound,
+  EPCAreaFilter$outboundSchema,
+} from "./epcareafilter.js";
+import {
+  EPCQueryOperator,
+  EPCQueryOperator$Outbound,
+  EPCQueryOperator$outboundSchema,
+} from "./epcqueryoperator.js";
+import {
+  EPCSort,
+  EPCSort$Outbound,
+  EPCSort$outboundSchema,
+} from "./epcsort.js";
+
+/**
+ * Fields to include in response. Comma-separated string or array. Default returns all fields. Example: 'rating,fabric.walls,meesCompliance'
+ */
+export type Attributes = string | Array<string>;
+
+export type EPCQueryRequest = {
+  /**
+   * Geographic filters. Multiple areas combined with OR logic.
+   */
+  area?: Array<EPCAreaFilter> | undefined;
+  /**
+   * Fields to include in response. Comma-separated string or array. Default returns all fields. Example: 'rating,fabric.walls,meesCompliance'
+   */
+  attributes?: string | Array<string> | undefined;
+  /**
+   * Results per page.
+   */
+  limit?: number | undefined;
+  /**
+   * Pagination offset.
+   */
+  offset?: number | undefined;
+  /**
+   * Field filters. Combined with AND logic against area filters.
+   */
+  query?: Array<EPCQueryOperator> | undefined;
+  /**
+   * Sort configuration. Max 3 fields. Default: lodgementDate desc.
+   */
+  sort?: Array<EPCSort> | undefined;
+};
+
+/** @internal */
+export type Attributes$Outbound = string | Array<string>;
+
+/** @internal */
+export const Attributes$outboundSchema: z.ZodType<
+  Attributes$Outbound,
+  z.ZodTypeDef,
+  Attributes
+> = z.union([z.string(), z.array(z.string())]);
+
+export function attributesToJSON(attributes: Attributes): string {
+  return JSON.stringify(Attributes$outboundSchema.parse(attributes));
+}
+
+/** @internal */
+export type EPCQueryRequest$Outbound = {
+  area?: Array<EPCAreaFilter$Outbound> | undefined;
+  attributes?: string | Array<string> | undefined;
+  limit: number;
+  offset: number;
+  query?: Array<EPCQueryOperator$Outbound> | undefined;
+  sort?: Array<EPCSort$Outbound> | undefined;
+};
+
+/** @internal */
+export const EPCQueryRequest$outboundSchema: z.ZodType<
+  EPCQueryRequest$Outbound,
+  z.ZodTypeDef,
+  EPCQueryRequest
+> = z.object({
+  area: z.array(EPCAreaFilter$outboundSchema).optional(),
+  attributes: z.union([z.string(), z.array(z.string())]).optional(),
+  limit: z.number().int().default(25),
+  offset: z.number().int().default(0),
+  query: z.array(EPCQueryOperator$outboundSchema).optional(),
+  sort: z.array(EPCSort$outboundSchema).optional(),
+});
+
+export function epcQueryRequestToJSON(
+  epcQueryRequest: EPCQueryRequest,
+): string {
+  return JSON.stringify(EPCQueryRequest$outboundSchema.parse(epcQueryRequest));
+}