@vepler/sdk 2.138.0 → 2.140.0

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

@@ -0,0 +1,114 @@
+/*
+ * 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";
+
+export type ProsperityIndicator = {
+  /**
+   * Whether the value was apportioned from a coarser geography
+   */
+  apportioned: boolean;
+  /**
+   * Indicator code, e.g. "imd_income_2025"
+   */
+  code: string;
+  /**
+   * Parent dimension key (income, housing, employment, living_standards)
+   */
+  dimension: string;
+  /**
+   * Formatted display value with unit
+   */
+  displayValue: string;
+  /**
+   * Plain-English fact summarising this indicator for the area (optional — only present when the ETL supplies a fact template)
+   */
+  fact?: string | undefined;
+  /**
+   * Human-readable indicator name
+   */
+  name: string;
+  /**
+   * National mean across all areas (null if unavailable)
+   */
+  nationalMean: number | null;
+  /**
+   * National median across all areas (null if unavailable)
+   */
+  nationalMedian: number | null;
+  /**
+   * Normalised score 0-100 (100 = most prosperous)
+   */
+  normalised: number;
+  /**
+   * National percentile position, 1-100
+   */
+  percentile: number;
+  /**
+   * Raw value in native units
+   */
+  raw: number;
+  /**
+   * Full source name
+   */
+  sourceName: string;
+  /**
+   * Publishing body
+   */
+  sourcePublisher: string;
+  /**
+   * Canonical source URL (optional — only present when the ETL config supplies it)
+   */
+  sourceUrl?: string | undefined;
+  /**
+   * Whether the source value was statistically suppressed
+   */
+  suppressed: boolean;
+  /**
+   * Unit type: "rate" | "GBP" | "%" | "score"
+   */
+  unit: string;
+  /**
+   * Data year
+   */
+  year: number;
+};
+
+/** @internal */
+export const ProsperityIndicator$inboundSchema: z.ZodType<
+  ProsperityIndicator,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  apportioned: z.boolean(),
+  code: z.string(),
+  dimension: z.string(),
+  displayValue: z.string(),
+  fact: z.string().optional(),
+  name: z.string(),
+  nationalMean: z.nullable(z.number()),
+  nationalMedian: z.nullable(z.number()),
+  normalised: z.number(),
+  percentile: z.number().int(),
+  raw: z.number(),
+  sourceName: z.string(),
+  sourcePublisher: z.string(),
+  sourceUrl: z.string().optional(),
+  suppressed: z.boolean(),
+  unit: z.string(),
+  year: z.number().int(),
+});
+
+export function prosperityIndicatorFromJSON(
+  jsonString: string,
+): SafeParseResult<ProsperityIndicator, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProsperityIndicator$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProsperityIndicator' from JSON`,
+  );
+}

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

@@ -0,0 +1,86 @@
+/*
+ * 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";
+import {
+  ProsperityData,
+  ProsperityData$inboundSchema,
+} from "./prosperitydata.js";
+
+/**
+ * Object type identifier
+ */
+export const ProsperityListResponseObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type ProsperityListResponseObject = ClosedEnum<
+  typeof ProsperityListResponseObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type ProsperityListResponse = {
+  /**
+   * Array of items
+   */
+  data: Array<ProsperityData>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: ProsperityListResponseObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export const ProsperityListResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof ProsperityListResponseObject
+> = z.nativeEnum(ProsperityListResponseObject);
+
+/** @internal */
+export const ProsperityListResponse$inboundSchema: z.ZodType<
+  ProsperityListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(ProsperityData$inboundSchema),
+  has_more: z.boolean(),
+  object: ProsperityListResponseObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function prosperityListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ProsperityListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProsperityListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProsperityListResponse' from JSON`,
+  );
+}

package/src/sdk/prosperity.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { prosperityGet } from "../funcs/prosperityGet.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import * as shared from "./models/shared/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Prosperity extends ClientSDK {
+  /**
+   * Get the Prosperity Index for one or more small areas
+   *
+   * @remarks
+   * Returns the Vepler Prosperity Index for one or more small-area codes — a composite 0-100 economic-prosperity score with national decile (1-10) and percentile. Pass a single code (e.g. `E01000001`) or a comma-separated list (up to 100). Each result is self-describing, carrying its own `geographicCode`, so multi-code lookups can be mapped back by the caller.
+   *
+   * The score breaks down into four weighted dimensions (income, housing, employment, living standards) and the curated underlying indicators (19 ONS/MHCLG measures) that feed them, each with display value, national median/mean, percentile and source attribution. England & Wales areas also carry the ONS OAC 2021 geodemographic classification (null for Scotland and Northern Ireland, which have no OAC).
+   *
+   * Codes with no persisted score are silently omitted from the result set — a request for valid-but-unscored codes returns an empty list, not a 404.
+   */
+  async get(
+    request: operations.GetProsperityRequest,
+    options?: RequestOptions,
+  ): Promise<shared.ProsperityListResponse> {
+    return unwrapAsync(prosperityGet(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -8,6 +8,7 @@ import { AirQuality } from "./airquality.js";
 import { Areas } from "./areas.js";
 import { Avm } from "./avm.js";
 import { Buildings } from "./buildings.js";
+import { Census } from "./census.js";
 import { Companies } from "./companies.js";
 import { Connectivity } from "./connectivity.js";
 import { Councils } from "./councils.js";
@@ -18,6 +19,7 @@ import { Metrics } from "./metrics.js";
 import { Planning } from "./planning.js";
 import { Poi } from "./poi.js";
 import { Property } from "./property.js";
+import { Prosperity } from "./prosperity.js";
 import { Safety } from "./safety.js";
 import { Schools } from "./schools.js";
 import { SchoolsCatchment } from "./schoolscatchment.js";
@@ -74,6 +76,11 @@ export class SDK extends ClientSDK {
     return (this._buildings ??= new Buildings(this._options));
   }
 
+  private _census?: Census;
+  get census(): Census {
+    return (this._census ??= new Census(this._options));
+  }
+
   private _companies?: Companies;
   get companies(): Companies {
     return (this._companies ??= new Companies(this._options));
@@ -114,6 +121,11 @@ export class SDK extends ClientSDK {
     return (this._property ??= new Property(this._options));
   }
 
+  private _prosperity?: Prosperity;
+  get prosperity(): Prosperity {
+    return (this._prosperity ??= new Prosperity(this._options));
+  }
+
   private _safety?: Safety;
   get safety(): Safety {
     return (this._safety ??= new Safety(this._options));

package/src/sdk/system.ts

@@ -4,6 +4,7 @@
 
 import { systemCheckAreaReferenceHealth } from "../funcs/systemCheckAreaReferenceHealth.js";
 import { systemCheckAVMHealth } from "../funcs/systemCheckAVMHealth.js";
+import { systemCheckCensusHealth } from "../funcs/systemCheckCensusHealth.js";
 import { systemCheckCompaniesHealth } from "../funcs/systemCheckCompaniesHealth.js";
 import { systemCheckListingsHealth } from "../funcs/systemCheckListingsHealth.js";
 import { systemCheckLocationHealth } from "../funcs/systemCheckLocationHealth.js";
@@ -48,6 +49,21 @@ export class System extends ClientSDK {
     ));
   }
 
+  /**
+   * Census service health check
+   *
+   * @remarks
+   * Check if the census service is operational.
+   */
+  async checkCensusHealth(
+    options?: RequestOptions,
+  ): Promise<shared.CensusHealthResponse> {
+    return unwrapAsync(systemCheckCensusHealth(
+      this,
+      options,
+    ));
+  }
+
   /**
    * Companies House service health check
    *