@vepler/sdk 2.33.0 → 2.37.0

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

@@ -9,34 +9,73 @@ import { ClosedEnum, OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Output format for tile data (default: 'geojson')
+ */
 export const QueryParamFormat = {
   Geojson: "geojson",
   Mvt: "mvt",
 } as const;
+/**
+ * Output format for tile data (default: 'geojson')
+ */
 export type QueryParamFormat = ClosedEnum<typeof QueryParamFormat>;
 
 export type GetPOIMultipleTilesRequest = {
+  /**
+   * Output format for tile data (default: 'geojson')
+   */
   format?: QueryParamFormat | undefined;
+  /**
+   * Comma-separated list of tile coordinates in 'z/x/y' format (e.g. '14/8192/5461,14/8193/5461'). Useful for prefetching adjacent tiles for smooth map panning.
+   */
   tiles: string;
 };
 
+/**
+ * Format used for the tile data
+ */
 export const GetPOIMultipleTilesFormat = {
   Geojson: "geojson",
   Mvt: "mvt",
 } as const;
+/**
+ * Format used for the tile data
+ */
 export type GetPOIMultipleTilesFormat = OpenEnum<
   typeof GetPOIMultipleTilesFormat
 >;
 
+/**
+ * Summary of the batch tile request
+ */
 export type GetPOIMultipleTilesMetadata = {
+  /**
+   * Number of tiles that failed — check individual tile 'error' fields for details
+   */
   failedTiles: number;
+  /**
+   * Format used for the tile data
+   */
   format: GetPOIMultipleTilesFormat;
+  /**
+   * Total number of tiles requested
+   */
   requestedTiles: number;
+  /**
+   * Number of tiles that loaded successfully
+   */
   successfulTiles: number;
 };
 
 export type GetPOIMultipleTiles2 = {
+  /**
+   * MVT layer name for map styling
+   */
   layerName: string;
+  /**
+   * Base64-encoded MVT binary data
+   */
   tile: string;
 };
 
@@ -48,16 +87,37 @@ export type GetPOIMultipleTilesPOIResponseType = ClosedEnum<
 >;
 
 export type GetPOIMultipleTilesGeometry = {
+  /**
+   * GeoJSON coordinates in [longitude, latitude] order (WGS84)
+   */
   coordinates: Array<number>;
   type: GetPOIMultipleTilesPOIResponseType;
 };
 
 export type GetPOIMultipleTilesProperties = {
+  /**
+   * Street address of the POI
+   */
   address?: string | null | undefined;
+  /**
+   * Human-readable category name
+   */
   category?: string | undefined;
+  /**
+   * POI category identifier (e.g. 'education', 'health')
+   */
   categoryId: string;
+  /**
+   * Unique POI identifier
+   */
   id: number;
+  /**
+   * Name of the point of interest
+   */
   name: string;
+  /**
+   * Data source (e.g. 'OpenStreetMap')
+   */
   source?: string | null | undefined;
 };
 
@@ -68,21 +128,48 @@ export type GetPOIMultipleTilesPOIType = ClosedEnum<
   typeof GetPOIMultipleTilesPOIType
 >;
 
+/**
+ * GeoJSON Feature representing a single POI on a map tile
+ */
 export type GetPOIMultipleTilesFeatures = {
   geometry: GetPOIMultipleTilesGeometry;
   properties: GetPOIMultipleTilesProperties;
   type: GetPOIMultipleTilesPOIType;
 };
 
+/**
+ * Slippy map tile coordinates (z/x/y) for this tile
+ */
 export type GetPOIMultipleTilesTile = {
+  /**
+   * Tile X coordinate
+   */
   x: number;
+  /**
+   * Tile Y coordinate
+   */
   y: number;
+  /**
+   * Tile zoom level
+   */
   z: number;
 };
 
+/**
+ * Tile metadata including coordinates and generation timestamp
+ */
 export type GetPOIMultipleTilesPOIMetadata = {
+  /**
+   * Number of POI features in this tile
+   */
   count: number;
+  /**
+   * ISO 8601 timestamp when the tile was generated
+   */
   generated: string;
+  /**
+   * Slippy map tile coordinates (z/x/y) for this tile
+   */
   tile: GetPOIMultipleTilesTile;
 };
 
@@ -93,19 +180,40 @@ export type GetPOIMultipleTilesType = ClosedEnum<
   typeof GetPOIMultipleTilesType
 >;
 
+/**
+ * GeoJSON FeatureCollection containing POIs for a single map tile
+ */
 export type GetPOIMultipleTiles1 = {
+  /**
+   * Array of GeoJSON Feature objects, one per POI
+   */
   features: Array<GetPOIMultipleTilesFeatures>;
+  /**
+   * Tile metadata including coordinates and generation timestamp
+   */
   metadata?: GetPOIMultipleTilesPOIMetadata | undefined;
   type: GetPOIMultipleTilesType;
 };
 
+/**
+ * Tile data in the requested format (GeoJSON FeatureCollection or MVT payload)
+ */
 export type GetPOIMultipleTilesData =
   | GetPOIMultipleTiles1
   | GetPOIMultipleTiles2;
 
 export type GetPOIMultipleTilesResult = {
+  /**
+   * Tile data in the requested format (GeoJSON FeatureCollection or MVT payload)
+   */
   data: GetPOIMultipleTiles1 | GetPOIMultipleTiles2;
+  /**
+   * Error message if this specific tile failed to load. Other tiles in the batch may still succeed.
+   */
   error?: string | undefined;
+  /**
+   * Tile coordinates in 'z/x/y' format
+   */
   tile: string;
 };
 
@@ -117,7 +225,13 @@ export type GetPOIMultipleTilesResponseBody = {
    * Optional message providing additional context about the response
    */
   message?: string | undefined;
+  /**
+   * Summary of the batch tile request
+   */
   metadata: GetPOIMultipleTilesMetadata;
+  /**
+   * Array of tile results, one per requested tile coordinate
+   */
   result: Array<GetPOIMultipleTilesResult>;
   /**
    * Indicates whether the request was successful

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

@@ -9,15 +9,24 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Output format for tile data (default: 'geojson')
+ */
 export const GetPOITileQueryParamFormat = {
   Geojson: "geojson",
   Mvt: "mvt",
 } as const;
+/**
+ * Output format for tile data (default: 'geojson')
+ */
 export type GetPOITileQueryParamFormat = ClosedEnum<
   typeof GetPOITileQueryParamFormat
 >;
 
 export type GetPOITileRequest = {
+  /**
+   * Output format for tile data (default: 'geojson')
+   */
   format?: GetPOITileQueryParamFormat | undefined;
   /**
    * Tile X coordinate
@@ -41,16 +50,37 @@ export type GetPOITilePOIResponseType = ClosedEnum<
 >;
 
 export type Geometry = {
+  /**
+   * GeoJSON coordinates in [longitude, latitude] order (WGS84)
+   */
   coordinates: Array<number>;
   type: GetPOITilePOIResponseType;
 };
 
 export type Properties = {
+  /**
+   * Street address of the POI
+   */
   address?: string | null | undefined;
+  /**
+   * Human-readable category name
+   */
   category?: string | undefined;
+  /**
+   * POI category identifier (e.g. 'education', 'health')
+   */
   categoryId: string;
+  /**
+   * Unique POI identifier
+   */
   id: number;
+  /**
+   * Name of the point of interest
+   */
   name: string;
+  /**
+   * Data source (e.g. 'OpenStreetMap')
+   */
   source?: string | null | undefined;
 };
 
@@ -59,21 +89,48 @@ export const GetPOITilePOIType = {
 } as const;
 export type GetPOITilePOIType = ClosedEnum<typeof GetPOITilePOIType>;
 
+/**
+ * GeoJSON Feature representing a single POI on a map tile
+ */
 export type GetPOITileFeatures = {
   geometry: Geometry;
   properties: Properties;
   type: GetPOITilePOIType;
 };
 
+/**
+ * Slippy map tile coordinates (z/x/y) for this tile
+ */
 export type Tile = {
+  /**
+   * Tile X coordinate
+   */
   x: number;
+  /**
+   * Tile Y coordinate
+   */
   y: number;
+  /**
+   * Tile zoom level
+   */
   z: number;
 };
 
+/**
+ * Tile metadata including coordinates and generation timestamp
+ */
 export type GetPOITileMetadata = {
+  /**
+   * Number of POI features in this tile
+   */
   count: number;
+  /**
+   * ISO 8601 timestamp when the tile was generated
+   */
   generated: string;
+  /**
+   * Slippy map tile coordinates (z/x/y) for this tile
+   */
   tile: Tile;
 };
 
@@ -82,8 +139,17 @@ export const GetPOITileType = {
 } as const;
 export type GetPOITileType = ClosedEnum<typeof GetPOITileType>;
 
+/**
+ * GeoJSON FeatureCollection containing POIs for a single map tile
+ */
 export type GetPOITileResult = {
+  /**
+   * Array of GeoJSON Feature objects, one per POI
+   */
   features: Array<GetPOITileFeatures>;
+  /**
+   * Tile metadata including coordinates and generation timestamp
+   */
   metadata?: GetPOITileMetadata | undefined;
   type: GetPOITileType;
 };
@@ -96,6 +162,9 @@ export type GetPOITileResponseBody = {
    * Optional message providing additional context about the response
    */
   message?: string | undefined;
+  /**
+   * GeoJSON FeatureCollection containing POIs for a single map tile
+   */
   result: GetPOITileResult;
   /**
    * Indicates whether the request was successful

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

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetPropertiesInSiteRequest = {
+  /**
+   * Composite site identifier (country:registry:titleRef)
+   */
+  siteId: string;
+};
+
+/** @internal */
+export type GetPropertiesInSiteRequest$Outbound = {
+  siteId: string;
+};
+
+/** @internal */
+export const GetPropertiesInSiteRequest$outboundSchema: z.ZodType<
+  GetPropertiesInSiteRequest$Outbound,
+  z.ZodTypeDef,
+  GetPropertiesInSiteRequest
+> = z.object({
+  siteId: z.string(),
+});
+
+export function getPropertiesInSiteRequestToJSON(
+  getPropertiesInSiteRequest: GetPropertiesInSiteRequest,
+): string {
+  return JSON.stringify(
+    GetPropertiesInSiteRequest$outboundSchema.parse(getPropertiesInSiteRequest),
+  );
+}

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

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetPscRequest = {
+  /**
+   * Unique identifier for a PSC notification record (UUID v4). Obtained from company PSC lists or search results.
+   */
+  pscId: string;
+};
+
+/** @internal */
+export type GetPscRequest$Outbound = {
+  pscId: string;
+};
+
+/** @internal */
+export const GetPscRequest$outboundSchema: z.ZodType<
+  GetPscRequest$Outbound,
+  z.ZodTypeDef,
+  GetPscRequest
+> = z.object({
+  pscId: z.string(),
+});
+
+export function getPscRequestToJSON(getPscRequest: GetPscRequest): string {
+  return JSON.stringify(GetPscRequest$outboundSchema.parse(getPscRequest));
+}

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

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetSiteByIdRequest = {
+  /**
+   * Composite site identifier (country:registry:titleRef)
+   */
+  siteId: string;
+};
+
+/** @internal */
+export type GetSiteByIdRequest$Outbound = {
+  siteId: string;
+};
+
+/** @internal */
+export const GetSiteByIdRequest$outboundSchema: z.ZodType<
+  GetSiteByIdRequest$Outbound,
+  z.ZodTypeDef,
+  GetSiteByIdRequest
+> = z.object({
+  siteId: z.string(),
+});
+
+export function getSiteByIdRequestToJSON(
+  getSiteByIdRequest: GetSiteByIdRequest,
+): string {
+  return JSON.stringify(
+    GetSiteByIdRequest$outboundSchema.parse(getSiteByIdRequest),
+  );
+}

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

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetSiteTilesRequest = {
+  /**
+   * JSON-encoded SiteAreaFilter[] for geographic filtering
+   */
+  area?: string | undefined;
+  /**
+   * Comma-separated list of fields to include in tile feature properties
+   */
+  fields?: string | undefined;
+  /**
+   * JSON-encoded SiteFilters object for convenience filtering
+   */
+  filters?: string | undefined;
+  /**
+   * JSON-encoded SiteQueryOperator[] for advanced filtering
+   */
+  query?: string | undefined;
+  /**
+   * Tile X coordinate
+   */
+  x: string;
+  /**
+   * Tile Y coordinate
+   */
+  y: string;
+  /**
+   * Zoom level (0-22)
+   */
+  z: string;
+};
+
+/** @internal */
+export type GetSiteTilesRequest$Outbound = {
+  area?: string | undefined;
+  fields?: string | undefined;
+  filters?: string | undefined;
+  query?: string | undefined;
+  x: string;
+  y: string;
+  z: string;
+};
+
+/** @internal */
+export const GetSiteTilesRequest$outboundSchema: z.ZodType<
+  GetSiteTilesRequest$Outbound,
+  z.ZodTypeDef,
+  GetSiteTilesRequest
+> = z.object({
+  area: z.string().optional(),
+  fields: z.string().optional(),
+  filters: z.string().optional(),
+  query: z.string().optional(),
+  x: z.string(),
+  y: z.string(),
+  z: z.string(),
+});
+
+export function getSiteTilesRequestToJSON(
+  getSiteTilesRequest: GetSiteTilesRequest,
+): string {
+  return JSON.stringify(
+    GetSiteTilesRequest$outboundSchema.parse(getSiteTilesRequest),
+  );
+}

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

@@ -9,49 +9,97 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetV1SafetyCrimeRequest = {
   /**
-   * Target month (YYYY-MM format)
+   * 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.
    */
   date?: string | undefined;
   /**
-   * Latitude coordinate
+   * 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: string;
   /**
-   * Longitude coordinate
+   * 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: string;
   /**
-   * Search radius in meters (100-50000)
+   * 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.
    */
   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
+ * 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;
 };