@vepler/sdk 2.33.0 → 2.37.0

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

@@ -17,17 +17,19 @@ export type GetMetricProfilesData = {
   name: string;
 };
 
-export const ObjectT = {
+export const GetMetricProfilesObject = {
   List: "list",
 } as const;
-export type ObjectT = ClosedEnum<typeof ObjectT>;
+export type GetMetricProfilesObject = ClosedEnum<
+  typeof GetMetricProfilesObject
+>;
 
 /**
  * List of available metric profiles
  */
 export type GetMetricProfilesResponseBody = {
   data: Array<GetMetricProfilesData>;
-  object: ObjectT;
+  object: GetMetricProfilesObject;
 };
 
 /** @internal */
@@ -52,8 +54,9 @@ export function getMetricProfilesDataFromJSON(
 }
 
 /** @internal */
-export const ObjectT$inboundSchema: z.ZodNativeEnum<typeof ObjectT> = z
-  .nativeEnum(ObjectT);
+export const GetMetricProfilesObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetMetricProfilesObject
+> = z.nativeEnum(GetMetricProfilesObject);
 
 /** @internal */
 export const GetMetricProfilesResponseBody$inboundSchema: z.ZodType<
@@ -62,7 +65,7 @@ export const GetMetricProfilesResponseBody$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   data: z.array(z.lazy(() => GetMetricProfilesData$inboundSchema)),
-  object: ObjectT$inboundSchema,
+  object: GetMetricProfilesObject$inboundSchema,
 });
 
 export function getMetricProfilesResponseBodyFromJSON(

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

@@ -10,33 +10,57 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetMetricValuesRequest = {
+  /**
+   * Filter by metric category (e.g. 'housing', 'income', 'education')
+   */
   category?: string | undefined;
+  /**
+   * Filter to values up to this month within the year range (1-12)
+   */
   endMonth?: number | null | undefined;
+  /**
+   * Filter to values up to this year (inclusive, e.g. 2024)
+   */
   endYear?: number | null | undefined;
   /**
-   * Geographic entity IDs (comma-separated)
+   * Comma-separated ONS geography codes to retrieve values for (e.g. 'E01000001,E01000002')
    */
   geographicEntityIds?: string | undefined;
   /**
-   * Geographic entity types to filter by (comma-separated)
+   * Comma-separated geographic types to filter by (e.g. 'lsoa21,ward'). Only values for areas of these types are returned.
    */
   geographicEntityTypes?: string | undefined;
   /**
-   * Include geographic entity information in response
+   * When 'true', includes geographic entity details (code, name, type) in each result. Default: false.
    */
   includeGeographicEntity?: string | undefined;
   /**
-   * Include metric metadata in response
+   * When 'true', includes the full metric definition object in each result (name, description, unit, source). Default: false.
    */
   includeMetric?: string | undefined;
+  /**
+   * Maximum number of values to return (default: 100)
+   */
   limit?: string | undefined;
   /**
-   * Metric identifiers to retrieve (comma-separated)
+   * Comma-separated numeric metric IDs to retrieve (e.g. '1,5,12'). See the metrics list endpoint for available IDs.
    */
   metricIds?: string | undefined;
+  /**
+   * Filter by metric name (exact match, e.g. 'median_house_price')
+   */
   metricName?: string | undefined;
+  /**
+   * Number of values to skip for pagination (default: 0)
+   */
   offset?: string | undefined;
+  /**
+   * Filter to values from this month onwards within the year range (1-12)
+   */
   startMonth?: number | null | undefined;
+  /**
+   * Filter to values from this year onwards (inclusive, e.g. 2020)
+   */
   startYear?: number | null | undefined;
 };
 
@@ -180,6 +204,9 @@ export type Geography = {
   type: GetMetricValuesType;
 };
 
+/**
+ * Finest geographic granularity at which this metric is available
+ */
 export const AggregationLevel = {
   National: "national",
   Regional: "regional",
@@ -189,8 +216,14 @@ export const AggregationLevel = {
   OutputArea: "output_area",
   Postcode: "postcode",
 } as const;
+/**
+ * Finest geographic granularity at which this metric is available
+ */
 export type AggregationLevel = OpenEnum<typeof AggregationLevel>;
 
+/**
+ * How often this metric is updated by the source publisher
+ */
 export const Frequency = {
   Annual: "annual",
   Quarterly: "quarterly",
@@ -200,36 +233,105 @@ export const Frequency = {
   OneTime: "one_time",
   Irregular: "irregular",
 } as const;
+/**
+ * How often this metric is updated by the source publisher
+ */
 export type Frequency = OpenEnum<typeof Frequency>;
 
+/**
+ * Definition of a statistical metric available in the area reference system
+ */
 export type Metric = {
+  /**
+   * Finest geographic granularity at which this metric is available
+   */
   aggregationLevel: AggregationLevel | null;
+  /**
+   * Thematic category for grouping related metrics (e.g. 'housing', 'income', 'education', 'health', 'environment')
+   */
   category: string | null;
+  /**
+   * Human-readable description of what the metric measures and how it is calculated
+   */
   description: string | null;
+  /**
+   * How often this metric is updated by the source publisher
+   */
   frequency: Frequency | null;
+  /**
+   * Unique metric identifier. Stable across updates — use this to reference a specific metric in queries.
+   */
   id: number;
+  /**
+   * Additional metric metadata that varies by source (e.g. methodology notes, coverage area, data quality flags)
+   */
   metadata?: { [k: string]: any | null } | null | undefined;
+  /**
+   * Machine-readable metric name (e.g. 'median_house_price', 'imd_rank', 'population_density')
+   */
   name: string;
+  /**
+   * Data source organisation (e.g. 'ONS', 'HMLR', 'DWP', 'MHCLG', 'Ofsted')
+   */
   source: string | null;
+  /**
+   * Additional classification tags for filtering (e.g. 'census_2021', 'deprivation', 'price_index')
+   */
   tags?: Array<string> | null | undefined;
+  /**
+   * Unit of measurement (e.g. 'GBP', 'percent', 'per_1000', 'count', 'rank', 'score'). Null if the metric is dimensionless.
+   */
   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.
+   */
   confidence: number | null;
+  /**
+   * ISO 8601 timestamp when this value was first loaded into the system
+   */
   createdAt: string;
+  /**
+   * ONS geography code for the area this value applies to (e.g. 'E01000001' for an LSOA, 'E09000001' for a local authority)
+   */
   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
    */
   geographicType: GeographicType;
   geography?: Geography | undefined;
+  /**
+   * Unique metric value record identifier
+   */
   id: number;
+  /**
+   * Additional value-level metadata (e.g. sample size, margin of error, suppression flags)
+   */
   metadata?: { [k: string]: any | null } | null | undefined;
+  /**
+   * Definition of a statistical metric available in the area reference system
+   */
   metric?: Metric | undefined;
+  /**
+   * References the metric definition (see MetricDefinition.id)
+   */
   metricId: number;
+  /**
+   * Time period the value relates to, as an ISO 8601 date or year string (e.g. '2024', '2024-Q3', '2024-01'). Null for timeless metrics.
+   */
   period: string | null;
+  /**
+   * ISO 8601 timestamp when this value was last updated. Null if never updated after initial load.
+   */
   updatedAt: string | null;
+  /**
+   * The metric value. Interpretation depends on the metric's unit field (e.g. GBP for prices, percentage for rates, integer for counts/ranks).
+   */
   value: number;
 };
 

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

@@ -9,24 +9,69 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetNearestPOIRequest = {
+  /**
+   * WGS84 latitude of the search centre point in decimal degrees (e.g. '51.5074')
+   */
   lat: string;
+  /**
+   * Maximum number of POIs to return per category (default: 10). Results are ordered by distance from the search point.
+   */
   limit?: string | undefined;
+  /**
+   * WGS84 longitude of the search centre point in decimal degrees (e.g. '-0.1278')
+   */
   lng: string;
+  /**
+   * Maximum search radius in metres from the centre point (default: 5000, max: 50000). Only POIs within this distance are returned.
+   */
   radius?: string | undefined;
+  /**
+   * When 'true', includes actual road/path routing distance and travel time for each POI (routingDistance and routingDuration fields). This is slower than straight-line distance but more accurate for real-world navigation. Default: false.
+   */
   routing?: string | undefined;
+  /**
+   * Comma-separated list of POI categories to include (e.g. 'education,health,transport'). If omitted, all categories are returned. See the /poi/categories endpoint for the full list.
+   */
   types?: string | undefined;
 };
 
+/**
+ * The centre point used for the proximity search
+ */
 export type SearchLocation = {
+  /**
+   * Latitude used for the search
+   */
   lat: number;
+  /**
+   * Longitude used for the search
+   */
   lng: number;
 };
 
+/**
+ * Metadata about the search parameters and result set
+ */
 export type Metadata = {
+  /**
+   * POI categories that were included in the search
+   */
   categories?: Array<string> | undefined;
+  /**
+   * Whether road/path routing distances were calculated
+   */
   routingEnabled?: boolean | undefined;
+  /**
+   * The centre point used for the proximity search
+   */
   searchLocation: SearchLocation;
+  /**
+   * Search radius that was applied, in metres
+   */
   searchRadius: number;
+  /**
+   * Total number of POIs found within the search area
+   */
   totalResults: number;
 };
 
@@ -109,7 +154,13 @@ export type GetNearestPOIResponseBody = {
    * Optional message providing additional context about the response
    */
   message?: string | undefined;
+  /**
+   * Metadata about the search parameters and result set
+   */
   metadata: Metadata;
+  /**
+   * Array of nearby points of interest, ordered by distance from the search point
+   */
   result: Array<GetNearestPOIResult>;
   /**
    * Indicates whether the request was successful

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

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetNearestPostcodesRequest = {
+  /**
+   * Maximum results (default: 10, max: 20)
+   */
+  limit?: string | undefined;
+  /**
+   * Source UK postcode
+   */
+  postcode: string;
+  /**
+   * Search radius in metres (default: 2000, max: 10000)
+   */
+  radius?: string | undefined;
+};
+
+/** @internal */
+export type GetNearestPostcodesRequest$Outbound = {
+  limit?: string | undefined;
+  postcode: string;
+  radius?: string | undefined;
+};
+
+/** @internal */
+export const GetNearestPostcodesRequest$outboundSchema: z.ZodType<
+  GetNearestPostcodesRequest$Outbound,
+  z.ZodTypeDef,
+  GetNearestPostcodesRequest
+> = z.object({
+  limit: z.string().optional(),
+  postcode: z.string(),
+  radius: z.string().optional(),
+});
+
+export function getNearestPostcodesRequestToJSON(
+  getNearestPostcodesRequest: GetNearestPostcodesRequest,
+): string {
+  return JSON.stringify(
+    GetNearestPostcodesRequest$outboundSchema.parse(getNearestPostcodesRequest),
+  );
+}

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

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetOfficerRequest = {
+  /**
+   * Unique identifier for an officer appointment record (UUID v4). Obtained from company officer lists or person appointment responses.
+   */
+  officerId: string;
+};
+
+/** @internal */
+export type GetOfficerRequest$Outbound = {
+  officerId: string;
+};
+
+/** @internal */
+export const GetOfficerRequest$outboundSchema: z.ZodType<
+  GetOfficerRequest$Outbound,
+  z.ZodTypeDef,
+  GetOfficerRequest
+> = z.object({
+  officerId: z.string(),
+});
+
+export function getOfficerRequestToJSON(
+  getOfficerRequest: GetOfficerRequest,
+): string {
+  return JSON.stringify(
+    GetOfficerRequest$outboundSchema.parse(getOfficerRequest),
+  );
+}

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

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetPersonRequest = {
+  /**
+   * Unique identifier for a deduplicated person record (UUID v4). Obtained from officer or PSC records via the personId field, or from person search results.
+   */
+  personId: string;
+};
+
+/** @internal */
+export type GetPersonRequest$Outbound = {
+  personId: string;
+};
+
+/** @internal */
+export const GetPersonRequest$outboundSchema: z.ZodType<
+  GetPersonRequest$Outbound,
+  z.ZodTypeDef,
+  GetPersonRequest
+> = z.object({
+  personId: z.string(),
+});
+
+export function getPersonRequestToJSON(
+  getPersonRequest: GetPersonRequest,
+): string {
+  return JSON.stringify(
+    GetPersonRequest$outboundSchema.parse(getPersonRequest),
+  );
+}

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

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetPersonAppointmentsRequest = {
+  /**
+   * Only return active appointments (default: true)
+   */
+  activeOnly?: string | undefined;
+  /**
+   * Maximum results (default: 25, max: 100)
+   */
+  limit?: string | undefined;
+  /**
+   * Skip results for pagination
+   */
+  offset?: string | undefined;
+  /**
+   * Unique identifier for a deduplicated person record (UUID v4). Obtained from officer or PSC records via the personId field, or from person search results.
+   */
+  personId: string;
+};
+
+/** @internal */
+export type GetPersonAppointmentsRequest$Outbound = {
+  activeOnly?: string | undefined;
+  limit?: string | undefined;
+  offset?: string | undefined;
+  personId: string;
+};
+
+/** @internal */
+export const GetPersonAppointmentsRequest$outboundSchema: z.ZodType<
+  GetPersonAppointmentsRequest$Outbound,
+  z.ZodTypeDef,
+  GetPersonAppointmentsRequest
+> = z.object({
+  activeOnly: z.string().optional(),
+  limit: z.string().optional(),
+  offset: z.string().optional(),
+  personId: z.string(),
+});
+
+export function getPersonAppointmentsRequestToJSON(
+  getPersonAppointmentsRequest: GetPersonAppointmentsRequest,
+): string {
+  return JSON.stringify(
+    GetPersonAppointmentsRequest$outboundSchema.parse(
+      getPersonAppointmentsRequest,
+    ),
+  );
+}

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

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetPersonClusterRequest = {
+  /**
+   * Entity resolution cluster identifier (UUID v4). All person records sharing this clusterId have been determined to represent the same real-world individual. Obtained from person records via the clusterId field. Requires COMPANIES_HOUSE_PREMIUM.
+   */
+  clusterId: string;
+};
+
+/** @internal */
+export type GetPersonClusterRequest$Outbound = {
+  clusterId: string;
+};
+
+/** @internal */
+export const GetPersonClusterRequest$outboundSchema: z.ZodType<
+  GetPersonClusterRequest$Outbound,
+  z.ZodTypeDef,
+  GetPersonClusterRequest
+> = z.object({
+  clusterId: z.string(),
+});
+
+export function getPersonClusterRequestToJSON(
+  getPersonClusterRequest: GetPersonClusterRequest,
+): string {
+  return JSON.stringify(
+    GetPersonClusterRequest$outboundSchema.parse(getPersonClusterRequest),
+  );
+}

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

@@ -6,7 +6,7 @@ import * as z from "zod/v3";
 
 export type GetPlanningApplicationsRequest = {
   /**
-   * Comma-separated list of planning application IDs
+   * One or more planning application UUIDs, separated by commas. Maximum 100 IDs per request. These are the internal system identifiers returned in the 'id' field of application objects (e.g. 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'). If you have a council reference number instead, use the GET /sources/{sourceIds} endpoint.
    */
   applicationIds: string;
 };

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

@@ -6,7 +6,7 @@ import * as z from "zod/v3";
 
 export type GetPlanningApplicationsBySourceRequest = {
   /**
-   * Comma-separated list of source IDs (e.g., council-a::APP/2024/0001)
+   * One or more source identifiers, separated by commas. Maximum 100 IDs per request. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). The double-colon separator distinguishes the provider from the reference. This is the recommended lookup method when you know the council and reference number.
    */
   sourceIds: string;
 };