@vepler/sdk 2.46.0 → 2.57.3

package/src/sdk/models/operations/getepchealth.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";
+
+/**
+ * Service health
+ */
+export type GetEpcHealthResponseBody = {
+  status: string;
+};
+
+/** @internal */
+export const GetEpcHealthResponseBody$inboundSchema: z.ZodType<
+  GetEpcHealthResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: z.string(),
+});
+
+export function getEpcHealthResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetEpcHealthResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetEpcHealthResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetEpcHealthResponseBody' from JSON`,
+  );
+}

package/src/sdk/models/operations/getmetricvalues.ts

@@ -72,7 +72,7 @@ export type Pagination = {
 };
 
 /**
- * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
+ * Type of geographic area this value is measured for
  */
 export const GeographicType = {
   Postcode: "postcode",
@@ -129,7 +129,7 @@ export const GeographicType = {
   NoiseIndustryLden: "noise_industry_lden",
 } as const;
 /**
- * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
+ * Type of geographic area this value is measured for
  */
 export type GeographicType = OpenEnum<typeof GeographicType>;
 
@@ -284,9 +284,6 @@ export type Metric = {
   unit: string | null;
 };
 
-/**
- * A single metric observation for a specific geographic area and time period
- */
 export type GetMetricValuesResult = {
   /**
    * Statistical confidence level from 0 to 1, where 1 is highest confidence. Null if not applicable. Values below 0.5 should be treated with caution.
@@ -301,7 +298,7 @@ export type GetMetricValuesResult = {
    */
   geographicCode: string;
   /**
-   * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
+   * Type of geographic area this value is measured for
    */
   geographicType: GeographicType;
   geography?: Geography | undefined;

package/src/sdk/models/operations/getnearestpoi.ts

@@ -89,7 +89,7 @@ export type GetNearestPOIType = ClosedEnum<typeof GetNearestPOIType>;
 /**
  * GeoJSON Point geometry representing the POI location
  */
-export type GetNearestPOILocation = {
+export type Location = {
   /**
    * GeoJSON coordinates [longitude, latitude] in WGS84 (EPSG:4326)
    */
@@ -123,7 +123,7 @@ export type GetNearestPOIResult = {
   /**
    * GeoJSON Point geometry representing the POI location
    */
-  location: GetNearestPOILocation;
+  location: Location;
   /**
    * Name of the point of interest
    */
@@ -249,8 +249,8 @@ export const GetNearestPOIType$inboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(GetNearestPOIType);
 
 /** @internal */
-export const GetNearestPOILocation$inboundSchema: z.ZodType<
-  GetNearestPOILocation,
+export const Location$inboundSchema: z.ZodType<
+  Location,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -258,13 +258,13 @@ export const GetNearestPOILocation$inboundSchema: z.ZodType<
   type: GetNearestPOIType$inboundSchema,
 });
 
-export function getNearestPOILocationFromJSON(
+export function locationFromJSON(
   jsonString: string,
-): SafeParseResult<GetNearestPOILocation, SDKValidationError> {
+): SafeParseResult<Location, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => GetNearestPOILocation$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetNearestPOILocation' from JSON`,
+    (x) => Location$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Location' from JSON`,
   );
 }
 
@@ -278,7 +278,7 @@ export const GetNearestPOIResult$inboundSchema: z.ZodType<
   categoryId: z.string(),
   distance: z.number().optional(),
   id: z.number(),
-  location: z.lazy(() => GetNearestPOILocation$inboundSchema),
+  location: z.lazy(() => Location$inboundSchema),
   name: z.string(),
   routingDistance: z.number().optional(),
   routingDuration: z.number().optional(),

package/src/sdk/models/operations/getschoolbyid.ts

@@ -5,8 +5,17 @@
 import * as z from "zod/v3";
 
 export type GetSchoolByIdRequest = {
+  /**
+   * Comma-separated list of related data to include (currently supports: ratings)
+   */
   expand?: string | undefined;
+  /**
+   * Comma-separated list of fields to include
+   */
   fields?: string | undefined;
+  /**
+   * School ID
+   */
   id: string;
 };
 

package/src/sdk/models/operations/getschoolbyslug.ts

@@ -5,8 +5,17 @@
 import * as z from "zod/v3";
 
 export type GetSchoolBySlugRequest = {
+  /**
+   * Comma-separated list of related data to include (currently supports: ratings)
+   */
   expand?: string | undefined;
+  /**
+   * Comma-separated list of fields to include
+   */
   fields?: string | undefined;
+  /**
+   * School slug
+   */
   slug: string;
 };
 

package/src/sdk/models/operations/getschoolbyurn.ts

@@ -5,8 +5,17 @@
 import * as z from "zod/v3";
 
 export type GetSchoolByUrnRequest = {
+  /**
+   * Comma-separated list of related data to include (currently supports: ratings)
+   */
   expand?: string | undefined;
+  /**
+   * Comma-separated list of fields to include
+   */
   fields?: string | undefined;
+  /**
+   * School URN (Unique Reference Number)
+   */
   urn: string;
 };
 

package/src/sdk/models/operations/getschoolmetrics.ts

@@ -11,7 +11,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Metric categories for grouping related metrics
+ * Filter by metric category
  */
 export const Category = {
   Ks2: "ks2",
@@ -22,12 +22,12 @@ export const Category = {
   Ofsted: "ofsted",
 } as const;
 /**
- * Metric categories for grouping related metrics
+ * Filter by metric category
  */
 export type Category = ClosedEnum<typeof Category>;
 
 /**
- * Student cohort types for metric filtering
+ * Filter by cohort type
  */
 export const CohortType = {
   All: "all",
@@ -41,12 +41,12 @@ export const CohortType = {
   Unclassified: "unclassified",
 } as const;
 /**
- * Student cohort types for metric filtering
+ * Filter by cohort type
  */
 export type CohortType = ClosedEnum<typeof CohortType>;
 
 /**
- * Reporting period frequency
+ * Reporting period
  */
 export const Period = {
   Annual: "annual",
@@ -54,11 +54,14 @@ export const Period = {
   Monthly: "monthly",
 } as const;
 /**
- * Reporting period frequency
+ * Reporting period
  */
 export type Period = ClosedEnum<typeof Period>;
 
 export type GetSchoolMetricsRequest = {
+  /**
+   * Academic year in YYYY/YY format
+   */
   academicYear?: string | undefined;
   /**
    * Filter by metric category
@@ -68,6 +71,9 @@ export type GetSchoolMetricsRequest = {
    * Filter by cohort type
    */
   cohortType?: CohortType | undefined;
+  /**
+   * End year for time series (YYYY/YY format)
+   */
   endYear?: string | undefined;
   /**
    * Include national/regional/similar school comparisons
@@ -87,11 +93,17 @@ export type GetSchoolMetricsRequest = {
    * Reporting period
    */
   period?: Period | undefined;
+  /**
+   * Predefined metric profile
+   */
   profile?: string | undefined;
   /**
    * Comma-separated list of school IDs
    */
   schoolIds: string;
+  /**
+   * Start year for time series (YYYY/YY format)
+   */
   startYear?: string | undefined;
   /**
    * Return time series data instead of point-in-time

package/src/sdk/models/operations/getsubstationbycode.ts

@@ -9,11 +9,14 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetSubstationByCodeRequest = {
+  /**
+   * Unique substation identifier, prefixed with the operator code (e.g. ukpn:PRI-1234, npg:12345)
+   */
   code: string;
 };
 
 /**
- * WGS84 coordinate pair
+ * Geographic location of the substation
  */
 export type GetSubstationByCodeCoordinates = {
   /**
@@ -68,7 +71,7 @@ export type GetSubstationByCodeSubstation = {
    */
   generationHeadroomMw: number | null;
   /**
-   * WGS84 coordinate pair
+   * Geographic location of the substation
    */
   location: GetSubstationByCodeCoordinates | null;
   /**
@@ -84,7 +87,7 @@ export type GetSubstationByCodeSubstation = {
    */
   operatingRegion: string | null;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Network operator that owns and operates this substation
    */
   operator: string;
   /**
@@ -96,7 +99,7 @@ export type GetSubstationByCodeSubstation = {
    */
   reversePowerCapacityMw: number | null;
   /**
-   * Classification of substation within the electricity network hierarchy. Known values: 'gsp', 'bulk_supply', 'grid', 'primary', 'distribution'. 'gsp' (Grid Supply Point) connects to the national transmission grid. 'bulk_supply' and 'grid' operate at intermediate voltages. 'primary' steps down to 11kV for local distribution. 'distribution' serves end customers at low voltage.
+   * Classification of this substation in the network hierarchy
    */
   substationType: string | null;
   /**

package/src/sdk/models/operations/getsubstationcapacity.ts

@@ -10,13 +10,16 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetSubstationCapacityRequest = {
+  /**
+   * Unique substation identifier, prefixed with the operator code (e.g. ukpn:PRI-1234, npg:12345)
+   */
   code: string;
   /**
-   * Start date for the time range (inclusive, ISO 8601)
+   * Start date (inclusive)
    */
   from?: string | undefined;
   /**
-   * End date for the time range (inclusive, ISO 8601)
+   * End date (inclusive)
    */
   to?: string | undefined;
 };

package/src/sdk/models/operations/getsubstationdfes.ts

@@ -10,17 +10,20 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetSubstationDFESRequest = {
+  /**
+   * Unique substation identifier, prefixed with the operator code (e.g. ukpn:PRI-1234, npg:12345)
+   */
   code: string;
   /**
    * Filter by energy planning scenario
    */
   scenario?: string | undefined;
   /**
-   * Start year for the forecast range (inclusive)
+   * Start year (inclusive)
    */
   yearFrom?: number | null | undefined;
   /**
-   * End year for the forecast range (inclusive)
+   * End year (inclusive)
    */
   yearTo?: number | null | undefined;
 };
@@ -51,7 +54,7 @@ export type GetSubstationDFESDFESForecast = {
    */
   forecastMw: number | null;
   /**
-   * Category of a forecast. Known values: 'demand', 'generation', 'storage'. 'demand' forecasts electricity consumption growth. 'generation' forecasts new renewable/distributed generation capacity. 'storage' forecasts battery and other storage deployment. New categories can be added as energy models evolve (e.g. flexibility, hydrogen).
+   * Whether this forecasts demand, generation, or storage capacity
    */
   forecastType: string;
   /**
@@ -63,11 +66,11 @@ export type GetSubstationDFESDFESForecast = {
    */
   operatingRegion: string;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Network operator that published this forecast
    */
   operator: string;
   /**
-   * Energy planning scenario identifier. Each country's energy planning framework defines its own scenarios. Known GB scenarios: 'leading_the_way', 'consumer_transformation', 'system_transformation', 'falling_short', 'best_view', 'holistic_transition'. 'leading_the_way' assumes fastest decarbonisation. 'falling_short' assumes slowest progress. 'best_view' is the operator's most likely central estimate.
+   * Energy planning scenario pathway
    */
   scenario: string;
   /**

package/src/sdk/models/operations/getv1titledeedstitlenumberdocuments.ts

@@ -5,6 +5,9 @@
 import * as z from "zod/v3";
 
 export type GetV1TitleDeedsTitleNumberDocumentsRequest = {
+  /**
+   * HMLR title number (case-insensitive)
+   */
   titleNumber: string;
 };
 

package/src/sdk/models/operations/getv1titledeedstitlenumberdocumentsdocumenttype.ts

@@ -23,6 +23,9 @@ export type GetV1TitleDeedsTitleNumberDocumentsDocumentTypeRequest = {
    * HMLR document type
    */
   documentType: DocumentType;
+  /**
+   * HMLR title number (case-insensitive)
+   */
   titleNumber: string;
 };
 

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

@@ -4,7 +4,6 @@
 
 export * from "./checkareareferencehealth.js";
 export * from "./checkavmhealth.js";
-export * from "./checkepchealth.js";
 export * from "./checklistingshealth.js";
 export * from "./findnearestsubstations.js";
 export * from "./findsitesbypoint.js";
@@ -25,6 +24,7 @@ export * from "./getconnectivityscores.js";
 export * from "./getcouncilbyproviderid.js";
 export * from "./getenergyforproperty.js";
 export * from "./getepcbylocationid.js";
+export * from "./getepchealth.js";
 export * from "./getlistingbyid.js";
 export * from "./getlistingbysource.js";
 export * from "./getlistingsbylocation.js";

package/src/sdk/models/operations/listschools.ts

@@ -11,15 +11,45 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import * as shared from "../shared/index.js";
 
 export type ListSchoolsRequest = {
+  /**
+   * Filter by local authority
+   */
   authority?: string | undefined;
+  /**
+   * Comma-separated list of related data to include (currently supports: ratings)
+   */
   expand?: string | undefined;
+  /**
+   * Comma-separated list of fields to include
+   */
   fields?: string | undefined;
+  /**
+   * Maximum number of results to return
+   */
   limit?: string | undefined;
+  /**
+   * Number of results to skip
+   */
   offset?: string | undefined;
+  /**
+   * Filter by postcode area
+   */
   postcode?: string | undefined;
+  /**
+   * Search query for school name or URN
+   */
   query?: string | undefined;
+  /**
+   * Filter by Ofsted rating
+   */
   rating?: string | undefined;
+  /**
+   * Filter by school status
+   */
   status?: string | undefined;
+  /**
+   * Filter by school type
+   */
   type?: string | undefined;
 };
 

package/src/sdk/models/operations/postv1titledeedstitlenumberpurchase.ts

@@ -5,6 +5,9 @@
 import * as z from "zod/v3";
 
 export type PostV1TitleDeedsTitleNumberPurchaseRequest = {
+  /**
+   * HMLR title number (case-insensitive)
+   */
   titleNumber: string;
 };
 

package/src/sdk/models/operations/resolveaddress.ts

@@ -134,7 +134,7 @@ export type HopperComponents = {
 /**
  * Match strategy that produced this result. direct-match: address tokens matched a single record with high precision. exact-match: full address string matched verbatim. partial-match: most address components matched; some inferred. fuzzy-match: approximate match allowing for typos or abbreviations. index-lookup: resolved via indexed reference data. postcode-fallback: matched by postcode when street-level matching failed. spatial-narrative: resolved from a descriptive or rural address using spatial analysis.
  */
-export const Source = {
+export const ResolveAddressSource = {
   DirectMatch: "direct-match",
   ExactMatch: "exact-match",
   PartialMatch: "partial-match",
@@ -146,7 +146,7 @@ export const Source = {
 /**
  * Match strategy that produced this result. direct-match: address tokens matched a single record with high precision. exact-match: full address string matched verbatim. partial-match: most address components matched; some inferred. fuzzy-match: approximate match allowing for typos or abbreviations. index-lookup: resolved via indexed reference data. postcode-fallback: matched by postcode when street-level matching failed. spatial-narrative: resolved from a descriptive or rural address using spatial analysis.
  */
-export type Source = OpenEnum<typeof Source>;
+export type ResolveAddressSource = OpenEnum<typeof ResolveAddressSource>;
 
 export type Matches = {
   /**
@@ -168,7 +168,7 @@ export type Matches = {
   /**
    * Match strategy that produced this result. direct-match: address tokens matched a single record with high precision. exact-match: full address string matched verbatim. partial-match: most address components matched; some inferred. fuzzy-match: approximate match allowing for typos or abbreviations. index-lookup: resolved via indexed reference data. postcode-fallback: matched by postcode when street-level matching failed. spatial-narrative: resolved from a descriptive or rural address using spatial analysis.
    */
-  source: Source;
+  source: ResolveAddressSource;
   /**
    * Unique Property Reference Number
    */
@@ -401,8 +401,11 @@ export function hopperComponentsFromJSON(
 }
 
 /** @internal */
-export const Source$inboundSchema: z.ZodType<Source, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Source);
+export const ResolveAddressSource$inboundSchema: z.ZodType<
+  ResolveAddressSource,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ResolveAddressSource);
 
 /** @internal */
 export const Matches$inboundSchema: z.ZodType<Matches, z.ZodTypeDef, unknown> =
@@ -411,7 +414,7 @@ export const Matches$inboundSchema: z.ZodType<Matches, z.ZodTypeDef, unknown> =
     confidence: z.number(),
     hopperComponents: z.lazy(() => HopperComponents$inboundSchema).optional(),
     originalAddress: z.string(),
-    source: Source$inboundSchema,
+    source: ResolveAddressSource$inboundSchema,
     uprn: z.string(),
   });
 

package/src/sdk/models/operations/searchconnectionqueue.ts

@@ -39,7 +39,7 @@ export type SearchConnectionQueueConnectionQueueSearchInput = {
    */
   offset?: number | null | undefined;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Filter by network operator code
    */
   operator?: string | undefined;
   /**
@@ -61,7 +61,7 @@ export type SearchConnectionQueueConnectionQueueSearchInput = {
 };
 
 /**
- * WGS84 coordinate pair
+ * Geographic location of the connection site, if available
  */
 export type SearchConnectionQueueCoordinates = {
   /**
@@ -158,7 +158,7 @@ export type SearchConnectionQueueConnectionQueueEntry = {
    */
   importCapacityMw: number | null;
   /**
-   * WGS84 coordinate pair
+   * Geographic location of the connection site, if available
    */
   location: SearchConnectionQueueCoordinates | null;
   /**
@@ -178,7 +178,7 @@ export type SearchConnectionQueueConnectionQueueEntry = {
    */
   operatingRegion: string | null;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Network operator managing this connection
    */
   operator: string;
   /**

package/src/sdk/models/operations/searchecr.ts

@@ -11,11 +11,11 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SearchECRRequest = {
   /**
-   * Filter by connection lifecycle status (e.g. connected, accepted, contracted, in_scoping)
+   * Filter by connection lifecycle status
    */
   connectionStatus?: string | undefined;
   /**
-   * Filter by country (ISO 3166-1 alpha-2)
+   * Filter by country code
    */
   country?: string | undefined;
   /**
@@ -35,13 +35,13 @@ export type SearchECRRequest = {
    */
   operator?: string | undefined;
   /**
-   * Filter by technology type (e.g. solar, wind, battery)
+   * Filter by technology type
    */
   technologyType?: string | undefined;
 };
 
 /**
- * WGS84 coordinate pair
+ * Geographic location of the generation or storage site
  */
 export type SearchECRCoordinates = {
   /**
@@ -78,11 +78,11 @@ export type SearchECRECREntry = {
    */
   connectionDate: string | null;
   /**
-   * Lifecycle status of a generation/storage connection. Known values: 'connected', 'accepted', 'contracted', 'in_scoping'. 'connected' is live and exporting. 'accepted' has a formal connection offer accepted. 'contracted' is under contract but not yet connected. 'in_scoping' is in early feasibility assessment. Different regulatory frameworks may define additional statuses.
+   * Current lifecycle status of this connection
    */
   connectionStatus: string | null;
   /**
-   * Category of an embedded capacity register connection. Known values: 'generation', 'storage', 'generation_and_storage'. 'generation' covers solar, wind, gas, biomass, etc. 'storage' covers batteries. 'generation_and_storage' covers co-located sites. New types can be added as technologies evolve (e.g. hydrogen electrolysis, V2G).
+   * Whether this is a generation, storage, or combined connection
    */
   connectionType: string | null;
   /**
@@ -98,7 +98,7 @@ export type SearchECRECREntry = {
    */
   installedCapacityMw: number | null;
   /**
-   * WGS84 coordinate pair
+   * Geographic location of the generation or storage site
    */
   location: SearchECRCoordinates | null;
   /**
@@ -110,7 +110,7 @@ export type SearchECRECREntry = {
    */
   operatingRegion: string | null;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Network operator that published this ECR data
    */
   operator: string;
   /**

package/src/sdk/models/operations/searchplanningpolicy.ts

@@ -42,8 +42,17 @@ export const SourceType = {
 export type SourceType = ClosedEnum<typeof SourceType>;
 
 export type SearchPlanningPolicyRequest = {
+  /**
+   * Filter by council ID
+   */
   council?: string | undefined;
+  /**
+   * Max results
+   */
   limit?: number | undefined;
+  /**
+   * Search query
+   */
   q: string;
   /**
    * Filter by rule type