@vepler/sdk 2.39.0 → 2.45.0

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

@@ -0,0 +1,218 @@
+/*
+ * 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 GetSubstationDFESRequest = {
+  code: string;
+  /**
+   * Filter by energy planning scenario
+   */
+  scenario?: string | undefined;
+  /**
+   * Start year for the forecast range (inclusive)
+   */
+  yearFrom?: number | null | undefined;
+  /**
+   * End year for the forecast range (inclusive)
+   */
+  yearTo?: number | null | undefined;
+};
+
+/**
+ * Object type identifier
+ */
+export const GetSubstationDFESEnergyObject = {
+  DfesForecast: "dfes_forecast",
+} as const;
+/**
+ * Object type identifier
+ */
+export type GetSubstationDFESEnergyObject = ClosedEnum<
+  typeof GetSubstationDFESEnergyObject
+>;
+
+/**
+ * A forecast from an energy planning framework (e.g. DFES in GB), projecting future demand, generation, and storage capacity under different energy transition pathways
+ */
+export type GetSubstationDFESDFESForecast = {
+  /**
+   * ISO 3166-1 alpha-2 country code
+   */
+  country: string;
+  /**
+   * Forecast value, in megawatts (MW), for this scenario, year, and technology
+   */
+  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).
+   */
+  forecastType: string;
+  /**
+   * Object type identifier
+   */
+  object: GetSubstationDFESEnergyObject;
+  /**
+   * Operating region this forecast applies to
+   */
+  operatingRegion: string;
+  /**
+   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   */
+  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.
+   */
+  scenario: string;
+  /**
+   * Code of the substation this forecast applies to, if substation-level
+   */
+  substationCode: string | null;
+  /**
+   * Technology type being forecast (e.g. solar, EV, heat pump, battery)
+   */
+  technologyType: string | null;
+  /**
+   * Forecast year
+   */
+  year: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const GetSubstationDFESObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type GetSubstationDFESObject = ClosedEnum<
+  typeof GetSubstationDFESObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type GetSubstationDFESResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<GetSubstationDFESDFESForecast>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: GetSubstationDFESObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type GetSubstationDFESRequest$Outbound = {
+  code: string;
+  scenario?: string | undefined;
+  yearFrom?: number | null | undefined;
+  yearTo?: number | null | undefined;
+};
+
+/** @internal */
+export const GetSubstationDFESRequest$outboundSchema: z.ZodType<
+  GetSubstationDFESRequest$Outbound,
+  z.ZodTypeDef,
+  GetSubstationDFESRequest
+> = z.object({
+  code: z.string(),
+  scenario: z.string().optional(),
+  yearFrom: z.nullable(z.number()).optional(),
+  yearTo: z.nullable(z.number()).optional(),
+});
+
+export function getSubstationDFESRequestToJSON(
+  getSubstationDFESRequest: GetSubstationDFESRequest,
+): string {
+  return JSON.stringify(
+    GetSubstationDFESRequest$outboundSchema.parse(getSubstationDFESRequest),
+  );
+}
+
+/** @internal */
+export const GetSubstationDFESEnergyObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetSubstationDFESEnergyObject
+> = z.nativeEnum(GetSubstationDFESEnergyObject);
+
+/** @internal */
+export const GetSubstationDFESDFESForecast$inboundSchema: z.ZodType<
+  GetSubstationDFESDFESForecast,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  country: z.string(),
+  forecastMw: z.nullable(z.number()),
+  forecastType: z.string(),
+  object: GetSubstationDFESEnergyObject$inboundSchema,
+  operatingRegion: z.string(),
+  operator: z.string(),
+  scenario: z.string(),
+  substationCode: z.nullable(z.string()),
+  technologyType: z.nullable(z.string()),
+  year: z.number(),
+});
+
+export function getSubstationDFESDFESForecastFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationDFESDFESForecast, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubstationDFESDFESForecast$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationDFESDFESForecast' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationDFESObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetSubstationDFESObject
+> = z.nativeEnum(GetSubstationDFESObject);
+
+/** @internal */
+export const GetSubstationDFESResponseBody$inboundSchema: z.ZodType<
+  GetSubstationDFESResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => GetSubstationDFESDFESForecast$inboundSchema)),
+  has_more: z.boolean(),
+  object: GetSubstationDFESObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function getSubstationDFESResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationDFESResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubstationDFESResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationDFESResponseBody' from JSON`,
+  );
+}

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

@@ -3,106 +3,26 @@
  */
 
 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 GetV1SafetyCrimeRequest = {
   /**
-   * Target month in YYYY-MM format (e.g. '2024-06'). If omitted, defaults to the current month. Note that police.uk data is typically published with a 2-month lag, so the most recent month with available data may be earlier than the current date.
+   * Target month (YYYY-MM format)
    */
   date?: string | undefined;
   /**
-   * WGS84 latitude of the search centre point in decimal degrees. Must be between -90 and 90. For UK locations, typical values range from 49.9 (southern England) to 55.8 (northern England).
+   * Latitude coordinate
    */
   latitude: string;
   /**
-   * WGS84 longitude of the search centre point in decimal degrees. Must be between -180 and 180. For UK locations, typical values range from -5.7 (western Wales) to 1.8 (eastern England).
+   * Longitude coordinate
    */
   longitude: string;
   /**
-   * Search radius in metres around the centre point (100-50,000). Defaults to 1,000m (1km). Larger radii will return more results but may be slower. A radius of 1,000m typically covers a single LSOA; 5,000m covers a neighbourhood of several LSOAs.
+   * Search radius in metres (100-50000)
    */
   radius?: string | undefined;
 };
 
-/**
- * Anonymised location of the crime incident. Coordinates are snapped to a police.uk anonymous map point within the LSOA, not the exact incident location.
- */
-export type GetV1SafetyCrimeLocation = {
-  /**
-   * WGS84 latitude of the anonymised crime location. Note: police.uk snaps crime locations to a nearby anonymous map point (typically a road or public place), so coordinates are approximate to within ~150 metres of the actual incident.
-   */
-  latitude: number;
-  /**
-   * WGS84 longitude of the anonymised crime location. Subject to the same ~150m anonymisation as latitude.
-   */
-  longitude: number;
-  /**
-   * Descriptive name of the anonymised location point (e.g. 'On or near High Street'). This is the police.uk snap-point label, not the precise street address of the incident.
-   */
-  street?: string | undefined;
-};
-
-export type GetV1SafetyCrimeData = {
-  /**
-   * Crime category key using underscore-separated names matching police.uk conventions. Possible values: 'anti_social_behaviour', 'bicycle_theft', 'burglary', 'criminal_damage_and_arson', 'drugs', 'other_crime', 'other_theft', 'possession_of_weapons', 'public_order', 'robbery', 'shoplifting', 'theft_from_the_person', 'vehicle_crime', 'violence_and_sexual_offences'.
-   */
-  category: string;
-  /**
-   * Month in which the crime was recorded, in YYYY-MM format. Police.uk crime data is published at monthly granularity; the specific day of the incident is not available.
-   */
-  date: string;
-  /**
-   * Unique identifier for this crime record, derived from the police.uk dataset. Format varies by police force; treat as an opaque string.
-   */
-  id: string;
-  /**
-   * Anonymised location of the crime incident. Coordinates are snapped to a police.uk anonymous map point within the LSOA, not the exact incident location.
-   */
-  location: GetV1SafetyCrimeLocation;
-  /**
-   * Outcome of the crime investigation, if available. Common values include: 'Under investigation', 'Unable to prosecute suspect', 'Investigation complete; no suspect identified', 'Awaiting court outcome', 'Offender given a caution', 'Local resolution'. Null or absent when the outcome has not yet been recorded or is not applicable (e.g. ASB incidents).
-   */
-  outcome?: string | undefined;
-};
-
-/**
- * Summary statistics for the returned crime data, including total count, category breakdown, and the search parameters used.
- */
-export type Summary = {
-  /**
-   * Breakdown of crime counts by category. Keys are underscore-separated crime category names (e.g. 'burglary', 'violence_and_sexual_offences'); values are integer counts.
-   */
-  byCategory: { [k: string]: number };
-  /**
-   * The target month for the query in YYYY-MM format.
-   */
-  period: string;
-  /**
-   * The search radius in metres that was used for this query.
-   */
-  radius: number;
-  /**
-   * Total number of crime incidents returned in the data array.
-   */
-  total: number;
-};
-
-/**
- * Crime data successfully retrieved. Returns individual incidents and a summary.
- */
-export type GetV1SafetyCrimeResponseBody = {
-  /**
-   * Array of individual crime incidents matching the search criteria. Each incident represents a single recorded crime from the police.uk dataset.
-   */
-  data: Array<GetV1SafetyCrimeData>;
-  /**
-   * Summary statistics for the returned crime data, including total count, category breakdown, and the search parameters used.
-   */
-  summary: Summary;
-};
-
 /** @internal */
 export type GetV1SafetyCrimeRequest$Outbound = {
   date?: string | undefined;
@@ -130,86 +50,3 @@ export function getV1SafetyCrimeRequestToJSON(
     GetV1SafetyCrimeRequest$outboundSchema.parse(getV1SafetyCrimeRequest),
   );
 }
-
-/** @internal */
-export const GetV1SafetyCrimeLocation$inboundSchema: z.ZodType<
-  GetV1SafetyCrimeLocation,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  latitude: z.number(),
-  longitude: z.number(),
-  street: z.string().optional(),
-});
-
-export function getV1SafetyCrimeLocationFromJSON(
-  jsonString: string,
-): SafeParseResult<GetV1SafetyCrimeLocation, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GetV1SafetyCrimeLocation$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetV1SafetyCrimeLocation' from JSON`,
-  );
-}
-
-/** @internal */
-export const GetV1SafetyCrimeData$inboundSchema: z.ZodType<
-  GetV1SafetyCrimeData,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  category: z.string(),
-  date: z.string(),
-  id: z.string(),
-  location: z.lazy(() => GetV1SafetyCrimeLocation$inboundSchema),
-  outcome: z.string().optional(),
-});
-
-export function getV1SafetyCrimeDataFromJSON(
-  jsonString: string,
-): SafeParseResult<GetV1SafetyCrimeData, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GetV1SafetyCrimeData$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetV1SafetyCrimeData' from JSON`,
-  );
-}
-
-/** @internal */
-export const Summary$inboundSchema: z.ZodType<Summary, z.ZodTypeDef, unknown> =
-  z.object({
-    byCategory: z.record(z.number()),
-    period: z.string(),
-    radius: z.number(),
-    total: z.number(),
-  });
-
-export function summaryFromJSON(
-  jsonString: string,
-): SafeParseResult<Summary, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Summary$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Summary' from JSON`,
-  );
-}
-
-/** @internal */
-export const GetV1SafetyCrimeResponseBody$inboundSchema: z.ZodType<
-  GetV1SafetyCrimeResponseBody,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  data: z.array(z.lazy(() => GetV1SafetyCrimeData$inboundSchema)),
-  summary: z.lazy(() => Summary$inboundSchema),
-});
-
-export function getV1SafetyCrimeResponseBodyFromJSON(
-  jsonString: string,
-): SafeParseResult<GetV1SafetyCrimeResponseBody, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GetV1SafetyCrimeResponseBody$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetV1SafetyCrimeResponseBody' from JSON`,
-  );
-}

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

@@ -3,110 +3,26 @@
  */
 
 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 GetV1SafetyCrimeStatsRequest = {
   /**
-   * WGS84 latitude of the search centre point in decimal degrees. Must be between -90 and 90. For UK locations, typical values range from 49.9 (southern England) to 55.8 (northern England).
+   * Latitude coordinate
    */
   latitude: string;
   /**
-   * WGS84 longitude of the search centre point in decimal degrees. Must be between -180 and 180. For UK locations, typical values range from -5.7 (western Wales) to 1.8 (eastern England).
+   * Longitude coordinate
    */
   longitude: string;
   /**
-   * Number of months to include in the analysis, counting backwards from the current date. Defaults to 12. Increasing this value provides a longer baseline for trend detection but increases response time as each month requires a separate data query. Recommended range: 6-24 months.
+   * Number of months to analyse (1-36)
    */
   months?: string | undefined;
   /**
-   * Search radius in metres around the centre point. Defaults to 1,000m. The radius defines a circular search area; all crimes recorded within this area across the requested months are included in the statistics. Larger radii produce more statistically reliable results but cover a wider area.
+   * Search radius in metres (100-50000)
    */
   radius?: string | undefined;
 };
 
-export type MonthlyBreakdown = {
-  /**
-   * Total number of crimes recorded in this month within the search area.
-   */
-  count: number;
-  /**
-   * Month identifier in YYYY-MM format.
-   */
-  month: string;
-};
-
-export type TopCategories = {
-  /**
-   * Crime category key using underscore-separated names (e.g. 'violence_and_sexual_offences').
-   */
-  category: string;
-  /**
-   * Total number of crimes in this category over the analysis period.
-   */
-  count: number;
-  /**
-   * This category's share of total crimes as a whole-number percentage (0-100).
-   */
-  percentage: number;
-};
-
-/**
- * Overall crime trend direction over the analysis period. Determined by comparing the average monthly crime count in the first half of the period to the second half. 'increasing': second half is >10% higher than first half. 'decreasing': second half is >10% lower than first half. 'stable': change is within +/-10%.
- */
-export const Trend = {
-  Increasing: "increasing",
-  Decreasing: "decreasing",
-  Stable: "stable",
-} as const;
-/**
- * Overall crime trend direction over the analysis period. Determined by comparing the average monthly crime count in the first half of the period to the second half. 'increasing': second half is >10% higher than first half. 'decreasing': second half is >10% lower than first half. 'stable': change is within +/-10%.
- */
-export type Trend = OpenEnum<typeof Trend>;
-
-/**
- * Aggregated crime statistics for the queried area and time window.
- */
-export type GetV1SafetyCrimeStatsData = {
-  /**
-   * Average number of crimes per month over the analysis period, rounded to the nearest integer.
-   */
-  monthlyAverage: number;
-  /**
-   * Month-by-month crime counts over the analysis period, ordered from most recent to oldest. Useful for visualising temporal patterns and seasonality.
-   */
-  monthlyBreakdown: Array<MonthlyBreakdown>;
-  /**
-   * Computed safety score for the search area (0-100). Higher scores indicate safer areas. Calculated as an inverse function of crime density: score = 100 - (crimes per km² per month x 10), clamped to the 0-100 range. This is a simplified density-based metric; for the full severity-weighted, time-decayed national score, use the batch crime metrics endpoint with LSOA codes.
-   */
-  safetyScore: number;
-  /**
-   * The top 5 crime categories by volume, sorted in descending order. Each entry includes the category name, absolute count, and percentage of total.
-   */
-  topCategories: Array<TopCategories>;
-  /**
-   * Total number of recorded crimes across all categories within the search area and time window.
-   */
-  totalCrimes: number;
-  /**
-   * Overall crime trend direction over the analysis period. Determined by comparing the average monthly crime count in the first half of the period to the second half. 'increasing': second half is >10% higher than first half. 'decreasing': second half is >10% lower than first half. 'stable': change is within +/-10%.
-   */
-  trend: Trend;
-};
-
-/**
- * Crime statistics successfully retrieved.
- */
-export type GetV1SafetyCrimeStatsResponseBody = {
-  /**
-   * Aggregated crime statistics for the queried area and time window.
-   */
-  data: GetV1SafetyCrimeStatsData;
-};
-
 /** @internal */
 export type GetV1SafetyCrimeStatsRequest$Outbound = {
   latitude: string;
@@ -136,91 +52,3 @@ export function getV1SafetyCrimeStatsRequestToJSON(
     ),
   );
 }
-
-/** @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 GetV1SafetyCrimeStatsData$inboundSchema: z.ZodType<
-  GetV1SafetyCrimeStatsData,
-  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 getV1SafetyCrimeStatsDataFromJSON(
-  jsonString: string,
-): SafeParseResult<GetV1SafetyCrimeStatsData, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GetV1SafetyCrimeStatsData$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetV1SafetyCrimeStatsData' from JSON`,
-  );
-}
-
-/** @internal */
-export const GetV1SafetyCrimeStatsResponseBody$inboundSchema: z.ZodType<
-  GetV1SafetyCrimeStatsResponseBody,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  data: z.lazy(() => GetV1SafetyCrimeStatsData$inboundSchema),
-});
-
-export function getV1SafetyCrimeStatsResponseBodyFromJSON(
-  jsonString: string,
-): SafeParseResult<GetV1SafetyCrimeStatsResponseBody, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => GetV1SafetyCrimeStatsResponseBody$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetV1SafetyCrimeStatsResponseBody' from JSON`,
-  );
-}

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

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetV1TitleDeedsTitleNumberDocumentsRequest = {
+  titleNumber: string;
+};
+
+/** @internal */
+export type GetV1TitleDeedsTitleNumberDocumentsRequest$Outbound = {
+  titleNumber: string;
+};
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsRequest$outboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsRequest$Outbound,
+    z.ZodTypeDef,
+    GetV1TitleDeedsTitleNumberDocumentsRequest
+  > = z.object({
+    titleNumber: z.string(),
+  });
+
+export function getV1TitleDeedsTitleNumberDocumentsRequestToJSON(
+  getV1TitleDeedsTitleNumberDocumentsRequest:
+    GetV1TitleDeedsTitleNumberDocumentsRequest,
+): string {
+  return JSON.stringify(
+    GetV1TitleDeedsTitleNumberDocumentsRequest$outboundSchema.parse(
+      getV1TitleDeedsTitleNumberDocumentsRequest,
+    ),
+  );
+}