@vepler/sdk 2.138.0 → 2.140.0

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

@@ -0,0 +1,170 @@
+/*
+ * 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 ListCensusVariablesRequest = {
+  /**
+   * Stable public dataset id, e.g. 'ew-2021' or 'sco-2022'.
+   */
+  datasetCode: string;
+};
+
+/**
+ * A census variable within a dataset.
+ */
+export type ListCensusVariablesData = {
+  /**
+   * 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;
+};
+
+/**
+ * Object type identifier
+ */
+export const ListCensusVariablesObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type ListCensusVariablesObject = ClosedEnum<
+  typeof ListCensusVariablesObject
+>;
+
+/**
+ * List of census variables (Stripe-style envelope).
+ */
+export type ListCensusVariablesResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<ListCensusVariablesData>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: ListCensusVariablesObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type ListCensusVariablesRequest$Outbound = {
+  datasetCode: string;
+};
+
+/** @internal */
+export const ListCensusVariablesRequest$outboundSchema: z.ZodType<
+  ListCensusVariablesRequest$Outbound,
+  z.ZodTypeDef,
+  ListCensusVariablesRequest
+> = z.object({
+  datasetCode: z.string(),
+});
+
+export function listCensusVariablesRequestToJSON(
+  listCensusVariablesRequest: ListCensusVariablesRequest,
+): string {
+  return JSON.stringify(
+    ListCensusVariablesRequest$outboundSchema.parse(listCensusVariablesRequest),
+  );
+}
+
+/** @internal */
+export const ListCensusVariablesData$inboundSchema: z.ZodType<
+  ListCensusVariablesData,
+  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 listCensusVariablesDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCensusVariablesData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCensusVariablesData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCensusVariablesData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListCensusVariablesObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListCensusVariablesObject
+> = z.nativeEnum(ListCensusVariablesObject);
+
+/** @internal */
+export const ListCensusVariablesResponseBody$inboundSchema: z.ZodType<
+  ListCensusVariablesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => ListCensusVariablesData$inboundSchema)),
+  has_more: z.boolean(),
+  object: ListCensusVariablesObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function listCensusVariablesResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCensusVariablesResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCensusVariablesResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCensusVariablesResponseBody' from JSON`,
+  );
+}

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

@@ -8,14 +8,14 @@ import { ClosedEnum } from "../../types/enums.js";
 /**
  * Filter by country code (GB = Great Britain, IE = Ireland)
  */
-export const Country = {
+export const QueryParamCountry = {
   Gb: "GB",
   Ie: "IE",
 } as const;
 /**
  * Filter by country code (GB = Great Britain, IE = Ireland)
  */
-export type Country = ClosedEnum<typeof Country>;
+export type QueryParamCountry = ClosedEnum<typeof QueryParamCountry>;
 
 /**
  * Filter by council status
@@ -51,7 +51,7 @@ export type ListCouncilsRequest = {
   /**
    * Filter by country code (GB = Great Britain, IE = Ireland)
    */
-  country?: Country | undefined;
+  country?: QueryParamCountry | undefined;
   /**
    * Filter by council status
    */
@@ -63,8 +63,9 @@ export type ListCouncilsRequest = {
 };
 
 /** @internal */
-export const Country$outboundSchema: z.ZodNativeEnum<typeof Country> = z
-  .nativeEnum(Country);
+export const QueryParamCountry$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamCountry
+> = z.nativeEnum(QueryParamCountry);
 
 /** @internal */
 export const QueryParamStatus$outboundSchema: z.ZodNativeEnum<
@@ -89,7 +90,7 @@ export const ListCouncilsRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListCouncilsRequest
 > = z.object({
-  country: Country$outboundSchema.optional(),
+  country: QueryParamCountry$outboundSchema.optional(),
   status: QueryParamStatus$outboundSchema.optional(),
   type: QueryParamType$outboundSchema.optional(),
 });

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

@@ -0,0 +1,196 @@
+/*
+ * 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 * as shared from "../shared/index.js";
+
+export type PostCensusAreaProfileRequest = {
+  /**
+   * Geography codes (max 100) and optional variable-slug filter.
+   */
+  censusAreaProfileRequest?: shared.CensusAreaProfileRequest | undefined;
+  /**
+   * Stable public dataset id, e.g. 'ew-2021' or 'sco-2022'.
+   */
+  datasetCode: string;
+};
+
+/**
+ * One category value for one area in a profile response.
+ */
+export type PostCensusAreaProfileData = {
+  /**
+   * Category code.
+   */
+  categoryCode: string;
+  /**
+   * Category label.
+   */
+  categoryName: string;
+  /**
+   * Classification code.
+   */
+  classificationCode: string;
+  /**
+   * Raw count for the category in this area.
+   */
+  count: string | null;
+  /**
+   * ONS geography code.
+   */
+  geographyCode: string;
+  /**
+   * Proportion in [0,1] of the variable base for this category.
+   */
+  ratio: string | null;
+  /**
+   * Variable code.
+   */
+  variableCode: string;
+  /**
+   * Variable name.
+   */
+  variableName: string;
+  /**
+   * Variable slug.
+   */
+  variableSlug: string;
+};
+
+/**
+ * Object type identifier
+ */
+export const PostCensusAreaProfileObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type PostCensusAreaProfileObject = ClosedEnum<
+  typeof PostCensusAreaProfileObject
+>;
+
+/**
+ * Multi-area census profile (Stripe-style envelope).
+ */
+export type PostCensusAreaProfileResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<PostCensusAreaProfileData>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: PostCensusAreaProfileObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type PostCensusAreaProfileRequest$Outbound = {
+  CensusAreaProfileRequest?:
+    | shared.CensusAreaProfileRequest$Outbound
+    | undefined;
+  datasetCode: string;
+};
+
+/** @internal */
+export const PostCensusAreaProfileRequest$outboundSchema: z.ZodType<
+  PostCensusAreaProfileRequest$Outbound,
+  z.ZodTypeDef,
+  PostCensusAreaProfileRequest
+> = z.object({
+  censusAreaProfileRequest: shared.CensusAreaProfileRequest$outboundSchema
+    .optional(),
+  datasetCode: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    censusAreaProfileRequest: "CensusAreaProfileRequest",
+  });
+});
+
+export function postCensusAreaProfileRequestToJSON(
+  postCensusAreaProfileRequest: PostCensusAreaProfileRequest,
+): string {
+  return JSON.stringify(
+    PostCensusAreaProfileRequest$outboundSchema.parse(
+      postCensusAreaProfileRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const PostCensusAreaProfileData$inboundSchema: z.ZodType<
+  PostCensusAreaProfileData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  categoryCode: z.string(),
+  categoryName: z.string(),
+  classificationCode: z.string(),
+  count: z.nullable(z.string()),
+  geographyCode: z.string(),
+  ratio: z.nullable(z.string()),
+  variableCode: z.string(),
+  variableName: z.string(),
+  variableSlug: z.string(),
+});
+
+export function postCensusAreaProfileDataFromJSON(
+  jsonString: string,
+): SafeParseResult<PostCensusAreaProfileData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PostCensusAreaProfileData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostCensusAreaProfileData' from JSON`,
+  );
+}
+
+/** @internal */
+export const PostCensusAreaProfileObject$inboundSchema: z.ZodNativeEnum<
+  typeof PostCensusAreaProfileObject
+> = z.nativeEnum(PostCensusAreaProfileObject);
+
+/** @internal */
+export const PostCensusAreaProfileResponseBody$inboundSchema: z.ZodType<
+  PostCensusAreaProfileResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => PostCensusAreaProfileData$inboundSchema)),
+  has_more: z.boolean(),
+  object: PostCensusAreaProfileObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function postCensusAreaProfileResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<PostCensusAreaProfileResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PostCensusAreaProfileResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostCensusAreaProfileResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,164 @@
+/*
+ * 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 * as shared from "../shared/index.js";
+
+export type PostCensusRollupRequest = {
+  /**
+   * Geography codes (max 100) and the category codes to roll up.
+   */
+  censusRollupRequest?: shared.CensusRollupRequest | undefined;
+  /**
+   * Stable public dataset id, e.g. 'ew-2021' or 'sco-2022'.
+   */
+  datasetCode: string;
+};
+
+/**
+ * One rolled-up category value over a custom set of areas.
+ */
+export type PostCensusRollupData = {
+  /**
+   * SUM(base count) across the custom area.
+   */
+  base: string | null;
+  /**
+   * Category code.
+   */
+  categoryCode: string;
+  /**
+   * SUM(count)/SUM(base) — never an average of child ratios.
+   */
+  ratio: string | null;
+  /**
+   * SUM(count) across the custom area.
+   */
+  total: string | null;
+};
+
+/**
+ * Object type identifier
+ */
+export const PostCensusRollupObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type PostCensusRollupObject = ClosedEnum<typeof PostCensusRollupObject>;
+
+/**
+ * Custom-area census rollup (Stripe-style envelope).
+ */
+export type PostCensusRollupResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<PostCensusRollupData>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: PostCensusRollupObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type PostCensusRollupRequest$Outbound = {
+  CensusRollupRequest?: shared.CensusRollupRequest$Outbound | undefined;
+  datasetCode: string;
+};
+
+/** @internal */
+export const PostCensusRollupRequest$outboundSchema: z.ZodType<
+  PostCensusRollupRequest$Outbound,
+  z.ZodTypeDef,
+  PostCensusRollupRequest
+> = z.object({
+  censusRollupRequest: shared.CensusRollupRequest$outboundSchema.optional(),
+  datasetCode: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    censusRollupRequest: "CensusRollupRequest",
+  });
+});
+
+export function postCensusRollupRequestToJSON(
+  postCensusRollupRequest: PostCensusRollupRequest,
+): string {
+  return JSON.stringify(
+    PostCensusRollupRequest$outboundSchema.parse(postCensusRollupRequest),
+  );
+}
+
+/** @internal */
+export const PostCensusRollupData$inboundSchema: z.ZodType<
+  PostCensusRollupData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  base: z.nullable(z.string()),
+  categoryCode: z.string(),
+  ratio: z.nullable(z.string()),
+  total: z.nullable(z.string()),
+});
+
+export function postCensusRollupDataFromJSON(
+  jsonString: string,
+): SafeParseResult<PostCensusRollupData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PostCensusRollupData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostCensusRollupData' from JSON`,
+  );
+}
+
+/** @internal */
+export const PostCensusRollupObject$inboundSchema: z.ZodNativeEnum<
+  typeof PostCensusRollupObject
+> = z.nativeEnum(PostCensusRollupObject);
+
+/** @internal */
+export const PostCensusRollupResponseBody$inboundSchema: z.ZodType<
+  PostCensusRollupResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => PostCensusRollupData$inboundSchema)),
+  has_more: z.boolean(),
+  object: PostCensusRollupObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function postCensusRollupResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<PostCensusRollupResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PostCensusRollupResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostCensusRollupResponseBody' from JSON`,
+  );
+}

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

@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 /**
  * Filter matched addresses by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter — returns all address types. Defaults to 'residential'.
  */
-export const Classification = {
+export const AddressResolveRequestClassification = {
   Residential: "residential",
   Commercial: "commercial",
   All: "all",
@@ -16,7 +16,9 @@ export const Classification = {
 /**
  * Filter matched addresses by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter — returns all address types. Defaults to 'residential'.
  */
-export type Classification = ClosedEnum<typeof Classification>;
+export type AddressResolveRequestClassification = ClosedEnum<
+  typeof AddressResolveRequestClassification
+>;
 
 /**
  * Optional matching configuration
@@ -25,7 +27,7 @@ export type Options = {
   /**
    * Filter matched addresses by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter — returns all address types. Defaults to 'residential'.
    */
-  classification?: Classification | undefined;
+  classification?: AddressResolveRequestClassification | undefined;
   /**
    * Minimum confidence threshold for matches (0-100)
    */
@@ -64,9 +66,10 @@ export type AddressResolveRequest = {
 };
 
 /** @internal */
-export const Classification$outboundSchema: z.ZodNativeEnum<
-  typeof Classification
-> = z.nativeEnum(Classification);
+export const AddressResolveRequestClassification$outboundSchema:
+  z.ZodNativeEnum<typeof AddressResolveRequestClassification> = z.nativeEnum(
+    AddressResolveRequestClassification,
+  );
 
 /** @internal */
 export type Options$Outbound = {
@@ -85,7 +88,7 @@ export const Options$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Options
 > = z.object({
-  classification: Classification$outboundSchema.optional(),
+  classification: AddressResolveRequestClassification$outboundSchema.optional(),
   confidenceThreshold: z.number().optional(),
   enableFallback: z.boolean().optional(),
   fallbackThreshold: z.number().optional(),

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

@@ -49,6 +49,7 @@ export const BuildingDataSources = {
   Listing: "listing",
   OpenData: "open_data",
   Council: "council",
+  Claim: "claim",
 } as const;
 export type BuildingDataSources = OpenEnum<typeof BuildingDataSources>;
 
@@ -157,6 +158,7 @@ export const BuildingSchemasDataSources = {
   Listing: "listing",
   OpenData: "open_data",
   Council: "council",
+  Claim: "claim",
 } as const;
 export type BuildingSchemasDataSources = OpenEnum<
   typeof BuildingSchemasDataSources
@@ -228,6 +230,7 @@ export const DataSources = {
   Listing: "listing",
   OpenData: "open_data",
   Council: "council",
+  Claim: "claim",
 } as const;
 export type DataSources = OpenEnum<typeof DataSources>;
 
@@ -316,6 +319,7 @@ export const BuildingSchemasRoofDataSources = {
   Listing: "listing",
   OpenData: "open_data",
   Council: "council",
+  Claim: "claim",
 } as const;
 export type BuildingSchemasRoofDataSources = OpenEnum<
   typeof BuildingSchemasRoofDataSources
@@ -400,6 +404,7 @@ export const Sources = {
   Listing: "listing",
   OpenData: "open_data",
   Council: "council",
+  Claim: "claim",
 } as const;
 export type Sources = OpenEnum<typeof Sources>;
 
@@ -443,6 +448,7 @@ export const BuildingSchemasStructureDataSources = {
   Listing: "listing",
   OpenData: "open_data",
   Council: "council",
+  Claim: "claim",
 } as const;
 export type BuildingSchemasStructureDataSources = OpenEnum<
   typeof BuildingSchemasStructureDataSources

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

@@ -38,6 +38,7 @@ export const BuildingFiltersSources = {
   Listing: "listing",
   OpenData: "open_data",
   Council: "council",
+  Claim: "claim",
 } as const;
 export type BuildingFiltersSources = ClosedEnum<typeof BuildingFiltersSources>;