@vepler/sdk 2.138.0 → 2.140.0

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

@@ -0,0 +1,102 @@
+/*
+ * 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 GetCensusVariableRequest = {
+  /**
+   * Stable public dataset id.
+   */
+  datasetCode: string;
+  /**
+   * Variable slug within the dataset.
+   */
+  slug: string;
+};
+
+/**
+ * Single census variable response.
+ */
+export type GetCensusVariableResponseBody = {
+  /**
+   * Long description of the variable.
+   */
+  description: string | null;
+  /**
+   * Catalogue display order.
+   */
+  displayOrder: number | null;
+  /**
+   * Population base for the variable.
+   */
+  populationBase: string | null;
+  /**
+   * Variable code.
+   */
+  variableCode: string;
+  /**
+   * Catalogue group, if any.
+   */
+  variableGroup: string | null;
+  /**
+   * Human-readable variable name.
+   */
+  variableName: string;
+  /**
+   * Variable slug.
+   */
+  variableSlug: string;
+};
+
+/** @internal */
+export type GetCensusVariableRequest$Outbound = {
+  datasetCode: string;
+  slug: string;
+};
+
+/** @internal */
+export const GetCensusVariableRequest$outboundSchema: z.ZodType<
+  GetCensusVariableRequest$Outbound,
+  z.ZodTypeDef,
+  GetCensusVariableRequest
+> = z.object({
+  datasetCode: z.string(),
+  slug: z.string(),
+});
+
+export function getCensusVariableRequestToJSON(
+  getCensusVariableRequest: GetCensusVariableRequest,
+): string {
+  return JSON.stringify(
+    GetCensusVariableRequest$outboundSchema.parse(getCensusVariableRequest),
+  );
+}
+
+/** @internal */
+export const GetCensusVariableResponseBody$inboundSchema: z.ZodType<
+  GetCensusVariableResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  description: z.nullable(z.string()),
+  displayOrder: z.nullable(z.number().int()),
+  populationBase: z.nullable(z.string()),
+  variableCode: z.string(),
+  variableGroup: z.nullable(z.string()),
+  variableName: z.string(),
+  variableSlug: z.string(),
+});
+
+export function getCensusVariableResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusVariableResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusVariableResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusVariableResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,125 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Nation discriminator for the whole-country flat file.
+ */
+export const Country = {
+  Ew: "ew",
+  Sco: "sco",
+  Ni: "ni",
+} as const;
+/**
+ * Nation discriminator for the whole-country flat file.
+ */
+export type Country = ClosedEnum<typeof Country>;
+
+/**
+ * Census geography level. Finer levels (e.g. 'lsoa', 'oa') are served as XYZ tiles; coarse levels (e.g. 'lad', 'region', 'country') are served as one whole-country file.
+ */
+export const GetCensusWholeLevelPathParamGeotype = {
+  Oa: "oa",
+  Lsoa: "lsoa",
+  Msoa: "msoa",
+  Lad: "lad",
+  Region: "region",
+  Country: "country",
+  Dz: "dz",
+  Iz: "iz",
+  Council: "council",
+  Sa: "sa",
+  Sdz: "sdz",
+  Lgd: "lgd",
+} as const;
+/**
+ * Census geography level. Finer levels (e.g. 'lsoa', 'oa') are served as XYZ tiles; coarse levels (e.g. 'lad', 'region', 'country') are served as one whole-country file.
+ */
+export type GetCensusWholeLevelPathParamGeotype = ClosedEnum<
+  typeof GetCensusWholeLevelPathParamGeotype
+>;
+
+/**
+ * Serving mode for the returned values. 'standard' (default): each value is a proportion in [0,1]. 'change': each value is a signed percentage-point change between censuses. Omit to use 'standard'.
+ */
+export const GetCensusWholeLevelQueryParamMode = {
+  Standard: "standard",
+  Change: "change",
+} as const;
+/**
+ * Serving mode for the returned values. 'standard' (default): each value is a proportion in [0,1]. 'change': each value is a signed percentage-point change between censuses. Omit to use 'standard'.
+ */
+export type GetCensusWholeLevelQueryParamMode = ClosedEnum<
+  typeof GetCensusWholeLevelQueryParamMode
+>;
+
+export type GetCensusWholeLevelRequest = {
+  /**
+   * Category code — '{classificationCode}-{NNN}'.
+   */
+  categoryCode: string;
+  /**
+   * Nation discriminator for the whole-country flat file.
+   */
+  country: Country;
+  /**
+   * Stable public dataset id.
+   */
+  datasetCode: string;
+  /**
+   * Census geography level. Finer levels (e.g. 'lsoa', 'oa') are served as XYZ tiles; coarse levels (e.g. 'lad', 'region', 'country') are served as one whole-country file.
+   */
+  geotype: GetCensusWholeLevelPathParamGeotype;
+  /**
+   * Serving mode for the returned values. 'standard' (default): each value is a proportion in [0,1]. 'change': each value is a signed percentage-point change between censuses. Omit to use 'standard'.
+   */
+  mode?: GetCensusWholeLevelQueryParamMode | undefined;
+};
+
+/** @internal */
+export const Country$outboundSchema: z.ZodNativeEnum<typeof Country> = z
+  .nativeEnum(Country);
+
+/** @internal */
+export const GetCensusWholeLevelPathParamGeotype$outboundSchema:
+  z.ZodNativeEnum<typeof GetCensusWholeLevelPathParamGeotype> = z.nativeEnum(
+    GetCensusWholeLevelPathParamGeotype,
+  );
+
+/** @internal */
+export const GetCensusWholeLevelQueryParamMode$outboundSchema: z.ZodNativeEnum<
+  typeof GetCensusWholeLevelQueryParamMode
+> = z.nativeEnum(GetCensusWholeLevelQueryParamMode);
+
+/** @internal */
+export type GetCensusWholeLevelRequest$Outbound = {
+  categoryCode: string;
+  country: string;
+  datasetCode: string;
+  geotype: string;
+  mode: string;
+};
+
+/** @internal */
+export const GetCensusWholeLevelRequest$outboundSchema: z.ZodType<
+  GetCensusWholeLevelRequest$Outbound,
+  z.ZodTypeDef,
+  GetCensusWholeLevelRequest
+> = z.object({
+  categoryCode: z.string(),
+  country: Country$outboundSchema,
+  datasetCode: z.string(),
+  geotype: GetCensusWholeLevelPathParamGeotype$outboundSchema,
+  mode: GetCensusWholeLevelQueryParamMode$outboundSchema.default("standard"),
+});
+
+export function getCensusWholeLevelRequestToJSON(
+  getCensusWholeLevelRequest: GetCensusWholeLevelRequest,
+): string {
+  return JSON.stringify(
+    GetCensusWholeLevelRequest$outboundSchema.parse(getCensusWholeLevelRequest),
+  );
+}

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

@@ -2294,7 +2294,7 @@ export type TransactionType = OpenEnum<typeof TransactionType>;
 /**
  * Unified EPC entity covering domestic, non-domestic, and Display Energy Certificates across England, Wales, and Scotland. Filter by certificateType to narrow to a specific assessment type. Use rating.current.band for cross-type energy efficiency comparisons.
  */
-export type Data = {
+export type GetEpcByLocationIdData = {
   /**
    * Standardised address.
    */
@@ -2452,7 +2452,7 @@ export type GetEpcByLocationIdObject = ClosedEnum<
  * EPC certificates for this location
  */
 export type GetEpcByLocationIdResponseBody = {
-  data: Array<Data>;
+  data: Array<GetEpcByLocationIdData>;
   hasMore: boolean;
   object: GetEpcByLocationIdObject;
   totalCount?: number | undefined;
@@ -3839,57 +3839,60 @@ export const TransactionType$inboundSchema: z.ZodType<
 > = openEnums.inboundSchema(TransactionType);
 
 /** @internal */
-export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
-  .object({
-    address: z.lazy(() => GetEpcByLocationIdAddress$inboundSchema),
-    assessmentMethodology: AssessmentMethodology$inboundSchema,
-    benchmarks: z.nullable(z.lazy(() => Benchmarks$inboundSchema)),
-    buildingReferenceNumber: z.nullable(z.string()),
-    certificateType: GetEpcByLocationIdCertificateType$inboundSchema,
-    constituency: z.nullable(z.string()),
-    constituencyLabel: z.nullable(z.string()),
-    coordinates: z.nullable(z.lazy(() => Coordinates$inboundSchema)),
-    county: z.nullable(z.string()),
-    createdAt: z.string(),
-    dataZone: z.nullable(z.string()),
-    domesticDetails: z.nullable(z.lazy(() => DomesticDetails$inboundSchema)),
-    emissions: z.lazy(() => Emissions$inboundSchema),
-    fabric: z.nullable(z.lazy(() => Fabric$inboundSchema)),
-    id: z.string(),
-    inspectionDate: z.string(),
-    localAuthority: z.nullable(z.string()),
-    localAuthorityLabel: z.nullable(z.string()),
-    locationId: z.nullable(z.number().int()),
-    lodgementDate: z.string(),
-    meesCompliance: MeesCompliance$inboundSchema,
-    operationalPerformance: z.nullable(
-      z.lazy(() => OperationalPerformance$inboundSchema),
-    ),
-    propertyType: z.nullable(z.string()),
-    propertyTypeExternal: z.nullable(z.string()),
-    rating: z.lazy(() => GetEpcByLocationIdRating$inboundSchema),
-    recommendations: z.array(z.lazy(() => Recommendations$inboundSchema)),
-    runningCosts: z.nullable(z.lazy(() => RunningCosts$inboundSchema)),
-    scotlandNativeRating: z.nullable(
-      z.lazy(() => ScotlandNativeRating$inboundSchema),
-    ),
-    source: Source$inboundSchema,
-    sourceReference: z.string(),
-    systems: z.lazy(() => Systems$inboundSchema),
-    totalFloorArea: z.nullable(z.number()),
-    transactionType: z.nullable(TransactionType$inboundSchema),
-    transactionTypeExternal: z.nullable(z.string()),
-    updatedAt: z.string(),
-    validUntil: z.nullable(z.string()),
-  });
+export const GetEpcByLocationIdData$inboundSchema: z.ZodType<
+  GetEpcByLocationIdData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address: z.lazy(() => GetEpcByLocationIdAddress$inboundSchema),
+  assessmentMethodology: AssessmentMethodology$inboundSchema,
+  benchmarks: z.nullable(z.lazy(() => Benchmarks$inboundSchema)),
+  buildingReferenceNumber: z.nullable(z.string()),
+  certificateType: GetEpcByLocationIdCertificateType$inboundSchema,
+  constituency: z.nullable(z.string()),
+  constituencyLabel: z.nullable(z.string()),
+  coordinates: z.nullable(z.lazy(() => Coordinates$inboundSchema)),
+  county: z.nullable(z.string()),
+  createdAt: z.string(),
+  dataZone: z.nullable(z.string()),
+  domesticDetails: z.nullable(z.lazy(() => DomesticDetails$inboundSchema)),
+  emissions: z.lazy(() => Emissions$inboundSchema),
+  fabric: z.nullable(z.lazy(() => Fabric$inboundSchema)),
+  id: z.string(),
+  inspectionDate: z.string(),
+  localAuthority: z.nullable(z.string()),
+  localAuthorityLabel: z.nullable(z.string()),
+  locationId: z.nullable(z.number().int()),
+  lodgementDate: z.string(),
+  meesCompliance: MeesCompliance$inboundSchema,
+  operationalPerformance: z.nullable(
+    z.lazy(() => OperationalPerformance$inboundSchema),
+  ),
+  propertyType: z.nullable(z.string()),
+  propertyTypeExternal: z.nullable(z.string()),
+  rating: z.lazy(() => GetEpcByLocationIdRating$inboundSchema),
+  recommendations: z.array(z.lazy(() => Recommendations$inboundSchema)),
+  runningCosts: z.nullable(z.lazy(() => RunningCosts$inboundSchema)),
+  scotlandNativeRating: z.nullable(
+    z.lazy(() => ScotlandNativeRating$inboundSchema),
+  ),
+  source: Source$inboundSchema,
+  sourceReference: z.string(),
+  systems: z.lazy(() => Systems$inboundSchema),
+  totalFloorArea: z.nullable(z.number()),
+  transactionType: z.nullable(TransactionType$inboundSchema),
+  transactionTypeExternal: z.nullable(z.string()),
+  updatedAt: z.string(),
+  validUntil: z.nullable(z.string()),
+});
 
-export function dataFromJSON(
+export function getEpcByLocationIdDataFromJSON(
   jsonString: string,
-): SafeParseResult<Data, SDKValidationError> {
+): SafeParseResult<GetEpcByLocationIdData, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Data$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Data' from JSON`,
+    (x) => GetEpcByLocationIdData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetEpcByLocationIdData' from JSON`,
   );
 }
 
@@ -3904,7 +3907,7 @@ export const GetEpcByLocationIdResponseBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  data: z.array(z.lazy(() => Data$inboundSchema)),
+  data: z.array(z.lazy(() => GetEpcByLocationIdData$inboundSchema)),
   has_more: z.boolean(),
   object: GetEpcByLocationIdObject$inboundSchema,
   total_count: z.number().optional(),

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

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetProsperityRequest = {
+  /**
+   * Single small-area code or comma-separated list (up to 100), e.g. E01000001 or E01000001,E01000002
+   */
+  geographicCodes: string;
+};
+
+/** @internal */
+export type GetProsperityRequest$Outbound = {
+  geographicCodes: string;
+};
+
+/** @internal */
+export const GetProsperityRequest$outboundSchema: z.ZodType<
+  GetProsperityRequest$Outbound,
+  z.ZodTypeDef,
+  GetProsperityRequest
+> = z.object({
+  geographicCodes: z.string(),
+});
+
+export function getProsperityRequestToJSON(
+  getProsperityRequest: GetProsperityRequest,
+): string {
+  return JSON.stringify(
+    GetProsperityRequest$outboundSchema.parse(getProsperityRequest),
+  );
+}

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

@@ -22,6 +22,15 @@ export * from "./getbuildingbyid.js";
 export * from "./getcatalogbycountry.js";
 export * from "./getcatchmentbyschool.js";
 export * from "./getcatchmentcoverage.js";
+export * from "./getcensusbreaks.js";
+export * from "./getcensuscatalog.js";
+export * from "./getcensuscategory.js";
+export * from "./getcensusclassification.js";
+export * from "./getcensusdataset.js";
+export * from "./getcensusgrid.js";
+export * from "./getcensustile.js";
+export * from "./getcensusvariable.js";
+export * from "./getcensuswholelevel.js";
 export * from "./getchildareas.js";
 export * from "./getcompaniesbylocation.js";
 export * from "./getcompany.js";
@@ -60,6 +69,7 @@ export * from "./getpropertiesbylocation.js";
 export * from "./getpropertiesbysource.js";
 export * from "./getpropertiesinsite.js";
 export * from "./getpropertytiles.js";
+export * from "./getprosperity.js";
 export * from "./getpsc.js";
 export * from "./getschoolbyid.js";
 export * from "./getschoolbysource.js";
@@ -75,10 +85,14 @@ export * from "./getv1titledeedstitlenumber.js";
 export * from "./getv1titledeedstitlenumberdocuments.js";
 export * from "./getv1titledeedstitlenumberdocumentsdocumenttype.js";
 export * from "./listcatalogcountries.js";
+export * from "./listcensusdatasets.js";
+export * from "./listcensusvariables.js";
 export * from "./listcouncils.js";
 export * from "./lookupoutcode.js";
 export * from "./lookuppostcode.js";
 export * from "./lookupuprn.js";
+export * from "./postcensusareaprofile.js";
+export * from "./postcensusrollup.js";
 export * from "./postv1titledeedstitlenumberpurchase.js";
 export * from "./postv1titledeedstitlenumberpurchaseasync.js";
 export * from "./querylistings.js";

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

@@ -0,0 +1,146 @@
+/*
+ * 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";
+
+/**
+ * A single census dataset (a nation's vintage).
+ */
+export type ListCensusDatasetsData = {
+  /**
+   * Nation discriminator: 'ew' | 'sco' | 'ni'.
+   */
+  censusCountry: string;
+  /**
+   * Census year.
+   */
+  censusYear: number;
+  /**
+   * ISO 3166-1 alpha-3 code.
+   */
+  countryCode: string;
+  /**
+   * Stable public dataset id.
+   */
+  datasetCode: string;
+  /**
+   * Whether this is the current release for the nation.
+   */
+  isCurrent: boolean;
+  /**
+   * Free-text methodology / provenance note.
+   */
+  methodology: string | null;
+  /**
+   * Official census reference date (ISO 8601).
+   */
+  referenceDate: string;
+  /**
+   * Dataset release version.
+   */
+  version: string;
+};
+
+/**
+ * Object type identifier
+ */
+export const ListCensusDatasetsObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type ListCensusDatasetsObject = ClosedEnum<
+  typeof ListCensusDatasetsObject
+>;
+
+/**
+ * List of census datasets (Stripe-style envelope).
+ */
+export type ListCensusDatasetsResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<ListCensusDatasetsData>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: ListCensusDatasetsObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export const ListCensusDatasetsData$inboundSchema: z.ZodType<
+  ListCensusDatasetsData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  censusCountry: z.string(),
+  censusYear: z.number().int(),
+  countryCode: z.string(),
+  datasetCode: z.string(),
+  isCurrent: z.boolean(),
+  methodology: z.nullable(z.string()),
+  referenceDate: z.string(),
+  version: z.string(),
+});
+
+export function listCensusDatasetsDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCensusDatasetsData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCensusDatasetsData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCensusDatasetsData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListCensusDatasetsObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListCensusDatasetsObject
+> = z.nativeEnum(ListCensusDatasetsObject);
+
+/** @internal */
+export const ListCensusDatasetsResponseBody$inboundSchema: z.ZodType<
+  ListCensusDatasetsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => ListCensusDatasetsData$inboundSchema)),
+  has_more: z.boolean(),
+  object: ListCensusDatasetsObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function listCensusDatasetsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCensusDatasetsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCensusDatasetsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCensusDatasetsResponseBody' from JSON`,
+  );
+}