@vepler/sdk 2.39.0 → 2.45.0

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

@@ -0,0 +1,320 @@
+/*
+ * 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";
+
+export type SearchSubstationsSearchSubstationsInput = {
+  /**
+   * Filter by country code
+   */
+  country?: string | undefined;
+  /**
+   * Maximum number of results to return
+   */
+  limit?: number | undefined;
+  /**
+   * Maximum demand headroom in MW
+   */
+  maxDemandHeadroomMw?: number | null | undefined;
+  /**
+   * Minimum demand headroom in MW
+   */
+  minDemandHeadroomMw?: number | null | undefined;
+  /**
+   * Minimum generation headroom in MW
+   */
+  minGenerationHeadroomMw?: number | null | undefined;
+  /**
+   * Number of results to skip for pagination
+   */
+  offset?: number | null | undefined;
+  /**
+   * Filter by operating region name
+   */
+  operatingRegion?: string | undefined;
+  /**
+   * Filter by network operator code
+   */
+  operator?: string | undefined;
+  /**
+   * Filter by substation type
+   */
+  substationType?: string | undefined;
+};
+
+/**
+ * WGS84 coordinate pair
+ */
+export type SearchSubstationsCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const SearchSubstationsEnergyObject = {
+  Substation: "substation",
+} as const;
+/**
+ * Object type identifier
+ */
+export type SearchSubstationsEnergyObject = ClosedEnum<
+  typeof SearchSubstationsEnergyObject
+>;
+
+/**
+ * A network operator substation with its current capacity and headroom data
+ */
+export type SearchSubstationsSubstation = {
+  /**
+   * Unique substation identifier, prefixed with the operator code
+   */
+  code: string;
+  /**
+   * ISO 3166-1 alpha-2 country code
+   */
+  country: string;
+  /**
+   * Available spare capacity for new demand connections, in megawatts (MW). Calculated as firm capacity minus peak demand
+   */
+  demandHeadroomMw: number | null;
+  /**
+   * Current peak electricity demand at this substation, in megawatts (MW)
+   */
+  demandMw: number | null;
+  /**
+   * Maximum firm capacity rating, in megawatts (MW). This is the guaranteed capacity available under all operating conditions
+   */
+  firmCapacityMw: number | null;
+  /**
+   * Available spare capacity for new generation connections (e.g. solar, wind), in megawatts (MW)
+   */
+  generationHeadroomMw: number | null;
+  /**
+   * WGS84 coordinate pair
+   */
+  location: SearchSubstationsCoordinates | null;
+  /**
+   * Human-readable substation name, where available
+   */
+  name: string | null;
+  /**
+   * Object type identifier
+   */
+  object: SearchSubstationsEnergyObject;
+  /**
+   * Operating region name (e.g. 'UKPN (SPN)' in GB, or region name in other countries)
+   */
+  operatingRegion: string | null;
+  /**
+   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   */
+  operator: string;
+  /**
+   * Code of the parent substation in the network hierarchy (e.g. a primary's parent grid substation). Null for top-level GSPs
+   */
+  parentSubstationCode: string | null;
+  /**
+   * Maximum capacity for reverse power flow (generation exceeding local demand), in megawatts (MW)
+   */
+  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.
+   */
+  substationType: string | null;
+  /**
+   * Current utilisation as a percentage of firm capacity. Higher values indicate less available headroom
+   */
+  utilisationPct: number | null;
+  /**
+   * Operating voltage, in kilovolts (kV)
+   */
+  voltageKv: number | null;
+};
+
+/**
+ * Object type identifier
+ */
+export const SearchSubstationsObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type SearchSubstationsObject = ClosedEnum<
+  typeof SearchSubstationsObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type SearchSubstationsResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<SearchSubstationsSubstation>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: SearchSubstationsObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type SearchSubstationsSearchSubstationsInput$Outbound = {
+  country?: string | undefined;
+  limit: number;
+  maxDemandHeadroomMw?: number | null | undefined;
+  minDemandHeadroomMw?: number | null | undefined;
+  minGenerationHeadroomMw?: number | null | undefined;
+  offset: number | null;
+  operatingRegion?: string | undefined;
+  operator?: string | undefined;
+  substationType?: string | undefined;
+};
+
+/** @internal */
+export const SearchSubstationsSearchSubstationsInput$outboundSchema: z.ZodType<
+  SearchSubstationsSearchSubstationsInput$Outbound,
+  z.ZodTypeDef,
+  SearchSubstationsSearchSubstationsInput
+> = z.object({
+  country: z.string().optional(),
+  limit: z.number().default(100),
+  maxDemandHeadroomMw: z.nullable(z.number()).optional(),
+  minDemandHeadroomMw: z.nullable(z.number()).optional(),
+  minGenerationHeadroomMw: z.nullable(z.number()).optional(),
+  offset: z.nullable(z.number().default(0)),
+  operatingRegion: z.string().optional(),
+  operator: z.string().optional(),
+  substationType: z.string().optional(),
+});
+
+export function searchSubstationsSearchSubstationsInputToJSON(
+  searchSubstationsSearchSubstationsInput:
+    SearchSubstationsSearchSubstationsInput,
+): string {
+  return JSON.stringify(
+    SearchSubstationsSearchSubstationsInput$outboundSchema.parse(
+      searchSubstationsSearchSubstationsInput,
+    ),
+  );
+}
+
+/** @internal */
+export const SearchSubstationsCoordinates$inboundSchema: z.ZodType<
+  SearchSubstationsCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function searchSubstationsCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSubstationsCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSubstationsCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSubstationsCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSubstationsEnergyObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchSubstationsEnergyObject
+> = z.nativeEnum(SearchSubstationsEnergyObject);
+
+/** @internal */
+export const SearchSubstationsSubstation$inboundSchema: z.ZodType<
+  SearchSubstationsSubstation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  country: z.string(),
+  demandHeadroomMw: z.nullable(z.number()),
+  demandMw: z.nullable(z.number()),
+  firmCapacityMw: z.nullable(z.number()),
+  generationHeadroomMw: z.nullable(z.number()),
+  location: z.nullable(
+    z.lazy(() => SearchSubstationsCoordinates$inboundSchema),
+  ),
+  name: z.nullable(z.string()),
+  object: SearchSubstationsEnergyObject$inboundSchema,
+  operatingRegion: z.nullable(z.string()),
+  operator: z.string(),
+  parentSubstationCode: z.nullable(z.string()),
+  reversePowerCapacityMw: z.nullable(z.number()),
+  substationType: z.nullable(z.string()),
+  utilisationPct: z.nullable(z.number()),
+  voltageKv: z.nullable(z.number()),
+});
+
+export function searchSubstationsSubstationFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSubstationsSubstation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSubstationsSubstation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSubstationsSubstation' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSubstationsObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchSubstationsObject
+> = z.nativeEnum(SearchSubstationsObject);
+
+/** @internal */
+export const SearchSubstationsResponseBody$inboundSchema: z.ZodType<
+  SearchSubstationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => SearchSubstationsSubstation$inboundSchema)),
+  has_more: z.boolean(),
+  object: SearchSubstationsObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function searchSubstationsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSubstationsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSubstationsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSubstationsResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,123 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Filter matched addresses by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter — returns all address types. Defaults to 'residential'.
+ */
+export const Classification = {
+  Residential: "residential",
+  Commercial: "commercial",
+  All: "all",
+} as const;
+/**
+ * Filter matched addresses by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter — returns all address types. Defaults to 'residential'.
+ */
+export type Classification = ClosedEnum<typeof Classification>;
+
+/**
+ * Optional matching configuration
+ */
+export type Options = {
+  /**
+   * Filter matched addresses by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter — returns all address types. Defaults to 'residential'.
+   */
+  classification?: Classification | undefined;
+  /**
+   * Minimum confidence threshold for matches (0-100)
+   */
+  confidenceThreshold?: number | undefined;
+  /**
+   * Enable postcode-based fallback matching
+   */
+  enableFallback?: boolean | undefined;
+  /**
+   * Confidence threshold below which fallback matching is triggered
+   */
+  fallbackThreshold?: number | undefined;
+  /**
+   * Include detailed processing steps in response
+   */
+  includeProcessingDetails?: boolean | undefined;
+  /**
+   * Maximum number of results to return
+   */
+  maxResults?: number | undefined;
+  /**
+   * Request timeout in milliseconds
+   */
+  timeout?: number | undefined;
+};
+
+export type AddressResolveRequest = {
+  /**
+   * The address string to resolve
+   */
+  address: string;
+  /**
+   * Optional matching configuration
+   */
+  options?: Options | undefined;
+};
+
+/** @internal */
+export const Classification$outboundSchema: z.ZodNativeEnum<
+  typeof Classification
+> = z.nativeEnum(Classification);
+
+/** @internal */
+export type Options$Outbound = {
+  classification?: string | undefined;
+  confidenceThreshold?: number | undefined;
+  enableFallback?: boolean | undefined;
+  fallbackThreshold?: number | undefined;
+  includeProcessingDetails?: boolean | undefined;
+  maxResults?: number | undefined;
+  timeout?: number | undefined;
+};
+
+/** @internal */
+export const Options$outboundSchema: z.ZodType<
+  Options$Outbound,
+  z.ZodTypeDef,
+  Options
+> = z.object({
+  classification: Classification$outboundSchema.optional(),
+  confidenceThreshold: z.number().optional(),
+  enableFallback: z.boolean().optional(),
+  fallbackThreshold: z.number().optional(),
+  includeProcessingDetails: z.boolean().optional(),
+  maxResults: z.number().optional(),
+  timeout: z.number().optional(),
+});
+
+export function optionsToJSON(options: Options): string {
+  return JSON.stringify(Options$outboundSchema.parse(options));
+}
+
+/** @internal */
+export type AddressResolveRequest$Outbound = {
+  address: string;
+  options?: Options$Outbound | undefined;
+};
+
+/** @internal */
+export const AddressResolveRequest$outboundSchema: z.ZodType<
+  AddressResolveRequest$Outbound,
+  z.ZodTypeDef,
+  AddressResolveRequest
+> = z.object({
+  address: z.string(),
+  options: z.lazy(() => Options$outboundSchema).optional(),
+});
+
+export function addressResolveRequestToJSON(
+  addressResolveRequest: AddressResolveRequest,
+): string {
+  return JSON.stringify(
+    AddressResolveRequest$outboundSchema.parse(addressResolveRequest),
+  );
+}

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

@@ -160,7 +160,7 @@ export type AppointmentsResponse = {
   /**
    * Indicates the request was successful.
    */
-  success: boolean;
+  success: true;
   /**
    * Total officer appointments held by this person (active and resigned).
    */
@@ -227,7 +227,7 @@ export const AppointmentsResponse$inboundSchema: z.ZodType<
   offset: z.number().int(),
   personId: z.string(),
   personName: z.string(),
-  success: z.boolean(),
+  success: z.literal(true),
   totalAppointments: z.number().int(),
 });
 

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

@@ -0,0 +1,147 @@
+/*
+ * 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 { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type MonthlyBreakdown = {
+  count: number;
+  month: string;
+};
+
+export type TopCategories = {
+  category: string;
+  count: number;
+  /**
+   * Percentage of total crimes
+   */
+  percentage: number;
+};
+
+/**
+ * Crime trend direction
+ */
+export const Trend = {
+  Increasing: "increasing",
+  Decreasing: "decreasing",
+  Stable: "stable",
+} as const;
+/**
+ * Crime trend direction
+ */
+export type Trend = OpenEnum<typeof Trend>;
+
+export type Data = {
+  /**
+   * Mean crimes per month
+   */
+  monthlyAverage: number;
+  monthlyBreakdown: Array<MonthlyBreakdown>;
+  /**
+   * Derived safety score (0-100, higher = safer)
+   */
+  safetyScore: number;
+  topCategories: Array<TopCategories>;
+  /**
+   * Total crimes across all months
+   */
+  totalCrimes: number;
+  /**
+   * Crime trend direction
+   */
+  trend: Trend;
+};
+
+export type AreaStatsResponse = {
+  data: Data;
+};
+
+/** @internal */
+export const MonthlyBreakdown$inboundSchema: z.ZodType<
+  MonthlyBreakdown,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number(),
+  month: z.string(),
+});
+
+export function monthlyBreakdownFromJSON(
+  jsonString: string,
+): SafeParseResult<MonthlyBreakdown, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MonthlyBreakdown$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MonthlyBreakdown' from JSON`,
+  );
+}
+
+/** @internal */
+export const TopCategories$inboundSchema: z.ZodType<
+  TopCategories,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  category: z.string(),
+  count: z.number(),
+  percentage: z.number(),
+});
+
+export function topCategoriesFromJSON(
+  jsonString: string,
+): SafeParseResult<TopCategories, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TopCategories$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TopCategories' from JSON`,
+  );
+}
+
+/** @internal */
+export const Trend$inboundSchema: z.ZodType<Trend, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Trend);
+
+/** @internal */
+export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
+  .object({
+    monthlyAverage: z.number(),
+    monthlyBreakdown: z.array(z.lazy(() => MonthlyBreakdown$inboundSchema)),
+    safetyScore: z.number(),
+    topCategories: z.array(z.lazy(() => TopCategories$inboundSchema)),
+    totalCrimes: z.number(),
+    trend: Trend$inboundSchema,
+  });
+
+export function dataFromJSON(
+  jsonString: string,
+): SafeParseResult<Data, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Data$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Data' from JSON`,
+  );
+}
+
+/** @internal */
+export const AreaStatsResponse$inboundSchema: z.ZodType<
+  AreaStatsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.lazy(() => Data$inboundSchema),
+});
+
+export function areaStatsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AreaStatsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AreaStatsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AreaStatsResponse' from JSON`,
+  );
+}

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

@@ -68,17 +68,19 @@ export type Change6Month = {
   percentage: number;
 };
 
-export const Trend = {
+export const AVMAnalysisResponseTrend = {
   Rising: "rising",
   Stable: "stable",
   Falling: "falling",
 } as const;
-export type Trend = OpenEnum<typeof Trend>;
+export type AVMAnalysisResponseTrend = OpenEnum<
+  typeof AVMAnalysisResponseTrend
+>;
 
 export type AVMAnalysisResponseSummary = {
   change12Month?: Change12Month | undefined;
   change6Month?: Change6Month | undefined;
-  trend: Trend;
+  trend: AVMAnalysisResponseTrend;
 };
 
 /**
@@ -322,8 +324,11 @@ export function change6MonthFromJSON(
 }
 
 /** @internal */
-export const Trend$inboundSchema: z.ZodType<Trend, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Trend);
+export const AVMAnalysisResponseTrend$inboundSchema: z.ZodType<
+  AVMAnalysisResponseTrend,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AVMAnalysisResponseTrend);
 
 /** @internal */
 export const AVMAnalysisResponseSummary$inboundSchema: z.ZodType<
@@ -333,7 +338,7 @@ export const AVMAnalysisResponseSummary$inboundSchema: z.ZodType<
 > = z.object({
   change12Month: z.lazy(() => Change12Month$inboundSchema).optional(),
   change6Month: z.lazy(() => Change6Month$inboundSchema).optional(),
-  trend: Trend$inboundSchema,
+  trend: AVMAnalysisResponseTrend$inboundSchema,
 });
 
 export function avmAnalysisResponseSummaryFromJSON(

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

@@ -4,8 +4,25 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Address dataset: 'os' (OS AddressBase, default) or 'paf' (Royal Mail PAF)
+ */
+export const Dataset = {
+  Os: "os",
+  Paf: "paf",
+} as const;
+/**
+ * Address dataset: 'os' (OS AddressBase, default) or 'paf' (Royal Mail PAF)
+ */
+export type Dataset = ClosedEnum<typeof Dataset>;
 
 export type BulkPostcodeLookupRequest = {
+  /**
+   * Address dataset: 'os' (OS AddressBase, default) or 'paf' (Royal Mail PAF)
+   */
+  dataset?: Dataset | undefined;
   /**
    * Maximum addresses per postcode
    */
@@ -16,8 +33,13 @@ export type BulkPostcodeLookupRequest = {
   postcodes: Array<string>;
 };
 
+/** @internal */
+export const Dataset$outboundSchema: z.ZodNativeEnum<typeof Dataset> = z
+  .nativeEnum(Dataset);
+
 /** @internal */
 export type BulkPostcodeLookupRequest$Outbound = {
+  dataset: string;
   per_postcode: number;
   postcodes: Array<string>;
 };
@@ -28,6 +50,7 @@ export const BulkPostcodeLookupRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BulkPostcodeLookupRequest
 > = z.object({
+  dataset: Dataset$outboundSchema.default("os"),
   perPostcode: z.number().int().default(50),
   postcodes: z.array(z.string()),
 }).transform((v) => {