@vepler/sdk 2.138.0 → 2.139.0

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

@@ -0,0 +1,127 @@
+/*
+ * 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 GetCensusCategoryRequest = {
+  /**
+   * Category code — '{classificationCode}-{NNN}'.
+   */
+  categoryCode: string;
+  /**
+   * Stable public dataset id.
+   */
+  datasetCode: string;
+};
+
+/**
+ * Single census category response.
+ */
+export type GetCensusCategoryResponseBody = {
+  /**
+   * Geography levels this category can be served at.
+   */
+  availableGeotypes: Array<string>;
+  /**
+   * Category code — '{classificationCode}-{NNN}'.
+   */
+  categoryCode: string;
+  /**
+   * Ordinal index within the classification.
+   */
+  categoryIndex: number;
+  /**
+   * Human-readable category label.
+   */
+  categoryName: string;
+  /**
+   * Parent classification code.
+   */
+  classificationCode: string;
+  /**
+   * Parent classification name.
+   */
+  classificationName: string;
+  /**
+   * Geography levels supporting change-mode comparison.
+   */
+  comparisonGeotypes: Array<string> | null;
+  /**
+   * Hierarchy depth (1 = top level).
+   */
+  hierarchyLevel: number;
+  /**
+   * Whether this category is the population base/total.
+   */
+  isTotal: boolean;
+  /**
+   * Parent variable code.
+   */
+  variableCode: string;
+  /**
+   * Parent variable name.
+   */
+  variableName: string;
+  /**
+   * Parent variable slug.
+   */
+  variableSlug: string;
+};
+
+/** @internal */
+export type GetCensusCategoryRequest$Outbound = {
+  categoryCode: string;
+  datasetCode: string;
+};
+
+/** @internal */
+export const GetCensusCategoryRequest$outboundSchema: z.ZodType<
+  GetCensusCategoryRequest$Outbound,
+  z.ZodTypeDef,
+  GetCensusCategoryRequest
+> = z.object({
+  categoryCode: z.string(),
+  datasetCode: z.string(),
+});
+
+export function getCensusCategoryRequestToJSON(
+  getCensusCategoryRequest: GetCensusCategoryRequest,
+): string {
+  return JSON.stringify(
+    GetCensusCategoryRequest$outboundSchema.parse(getCensusCategoryRequest),
+  );
+}
+
+/** @internal */
+export const GetCensusCategoryResponseBody$inboundSchema: z.ZodType<
+  GetCensusCategoryResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  availableGeotypes: z.array(z.string()),
+  categoryCode: z.string(),
+  categoryIndex: z.number().int(),
+  categoryName: z.string(),
+  classificationCode: z.string(),
+  classificationName: z.string(),
+  comparisonGeotypes: z.nullable(z.array(z.string())),
+  hierarchyLevel: z.number().int(),
+  isTotal: z.boolean(),
+  variableCode: z.string(),
+  variableName: z.string(),
+  variableSlug: z.string(),
+});
+
+export function getCensusCategoryResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusCategoryResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusCategoryResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusCategoryResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,100 @@
+/*
+ * 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 GetCensusClassificationRequest = {
+  /**
+   * Classification (granularity cut) file-stem code.
+   */
+  classificationCode: string;
+  /**
+   * Stable public dataset id.
+   */
+  datasetCode: string;
+};
+
+/**
+ * Single census classification response.
+ */
+export type GetCensusClassificationResponseBody = {
+  /**
+   * Geography levels this classification can be served at.
+   */
+  availableGeotypes: Array<string>;
+  /**
+   * Number of categories in this cut.
+   */
+  categoryCount: number;
+  /**
+   * Classification file-stem code.
+   */
+  classificationCode: string;
+  /**
+   * Human-readable classification name.
+   */
+  classificationName: string;
+  /**
+   * Geography levels supporting change-mode comparison.
+   */
+  comparisonGeotypes: Array<string> | null;
+  /**
+   * Whether this is the default classification for the variable.
+   */
+  isDefault: boolean;
+};
+
+/** @internal */
+export type GetCensusClassificationRequest$Outbound = {
+  classificationCode: string;
+  datasetCode: string;
+};
+
+/** @internal */
+export const GetCensusClassificationRequest$outboundSchema: z.ZodType<
+  GetCensusClassificationRequest$Outbound,
+  z.ZodTypeDef,
+  GetCensusClassificationRequest
+> = z.object({
+  classificationCode: z.string(),
+  datasetCode: z.string(),
+});
+
+export function getCensusClassificationRequestToJSON(
+  getCensusClassificationRequest: GetCensusClassificationRequest,
+): string {
+  return JSON.stringify(
+    GetCensusClassificationRequest$outboundSchema.parse(
+      getCensusClassificationRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetCensusClassificationResponseBody$inboundSchema: z.ZodType<
+  GetCensusClassificationResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  availableGeotypes: z.array(z.string()),
+  categoryCount: z.number().int(),
+  classificationCode: z.string(),
+  classificationName: z.string(),
+  comparisonGeotypes: z.nullable(z.array(z.string())),
+  isDefault: z.boolean(),
+});
+
+export function getCensusClassificationResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusClassificationResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCensusClassificationResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusClassificationResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,101 @@
+/*
+ * 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 GetCensusDatasetRequest = {
+  /**
+   * Stable public dataset id, e.g. 'ew-2021' or 'sco-2022'.
+   */
+  datasetCode: string;
+};
+
+/**
+ * Single census dataset response.
+ */
+export type GetCensusDatasetResponseBody = {
+  /**
+   * 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;
+};
+
+/** @internal */
+export type GetCensusDatasetRequest$Outbound = {
+  datasetCode: string;
+};
+
+/** @internal */
+export const GetCensusDatasetRequest$outboundSchema: z.ZodType<
+  GetCensusDatasetRequest$Outbound,
+  z.ZodTypeDef,
+  GetCensusDatasetRequest
+> = z.object({
+  datasetCode: z.string(),
+});
+
+export function getCensusDatasetRequestToJSON(
+  getCensusDatasetRequest: GetCensusDatasetRequest,
+): string {
+  return JSON.stringify(
+    GetCensusDatasetRequest$outboundSchema.parse(getCensusDatasetRequest),
+  );
+}
+
+/** @internal */
+export const GetCensusDatasetResponseBody$inboundSchema: z.ZodType<
+  GetCensusDatasetResponseBody,
+  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 getCensusDatasetResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusDatasetResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusDatasetResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusDatasetResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,211 @@
+/*
+ * 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";
+
+/**
+ * Optional geography-level filter for the XYZ quad grid. Omit to return tile membership for every level available in the dataset; pass a level (e.g. 'lsoa') to return only that level's tiles.
+ */
+export const QueryParamGeotype = {
+  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;
+/**
+ * Optional geography-level filter for the XYZ quad grid. Omit to return tile membership for every level available in the dataset; pass a level (e.g. 'lsoa') to return only that level's tiles.
+ */
+export type QueryParamGeotype = ClosedEnum<typeof QueryParamGeotype>;
+
+export type GetCensusGridRequest = {
+  /**
+   * Stable public dataset id, e.g. 'ew-2021' or 'sco-2022'.
+   */
+  datasetCode: string;
+  /**
+   * Optional geography-level filter for the XYZ quad grid. Omit to return tile membership for every level available in the dataset; pass a level (e.g. 'lsoa') to return only that level's tiles.
+   */
+  geotype?: QueryParamGeotype | undefined;
+};
+
+/**
+ * One XYZ quad-grid tile membership entry for a dataset.
+ */
+export type GetCensusGridData = {
+  /**
+   * East bound (WGS84).
+   */
+  bboxEast: string;
+  /**
+   * North bound (WGS84).
+   */
+  bboxNorth: string;
+  /**
+   * South bound (WGS84).
+   */
+  bboxSouth: string;
+  /**
+   * West bound (WGS84).
+   */
+  bboxWest: string;
+  /**
+   * Census geography level.
+   */
+  geographicType: string;
+  /**
+   * Tile name — '{x}-{y}-{z}'.
+   */
+  tilename: string;
+  /**
+   * Slippy X coordinate.
+   */
+  x: number | null;
+  /**
+   * Slippy Y coordinate.
+   */
+  y: number | null;
+  /**
+   * Slippy zoom level.
+   */
+  z: number | null;
+};
+
+/**
+ * Object type identifier
+ */
+export const GetCensusGridObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type GetCensusGridObject = ClosedEnum<typeof GetCensusGridObject>;
+
+/**
+ * XYZ quad grid for a census dataset (Stripe-style envelope).
+ */
+export type GetCensusGridResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<GetCensusGridData>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: GetCensusGridObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export const QueryParamGeotype$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamGeotype
+> = z.nativeEnum(QueryParamGeotype);
+
+/** @internal */
+export type GetCensusGridRequest$Outbound = {
+  datasetCode: string;
+  geotype?: string | undefined;
+};
+
+/** @internal */
+export const GetCensusGridRequest$outboundSchema: z.ZodType<
+  GetCensusGridRequest$Outbound,
+  z.ZodTypeDef,
+  GetCensusGridRequest
+> = z.object({
+  datasetCode: z.string(),
+  geotype: QueryParamGeotype$outboundSchema.optional(),
+});
+
+export function getCensusGridRequestToJSON(
+  getCensusGridRequest: GetCensusGridRequest,
+): string {
+  return JSON.stringify(
+    GetCensusGridRequest$outboundSchema.parse(getCensusGridRequest),
+  );
+}
+
+/** @internal */
+export const GetCensusGridData$inboundSchema: z.ZodType<
+  GetCensusGridData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bboxEast: z.string(),
+  bboxNorth: z.string(),
+  bboxSouth: z.string(),
+  bboxWest: z.string(),
+  geographicType: z.string(),
+  tilename: z.string(),
+  x: z.nullable(z.number().int()),
+  y: z.nullable(z.number().int()),
+  z: z.nullable(z.number().int()),
+});
+
+export function getCensusGridDataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusGridData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusGridData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusGridData' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusGridObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetCensusGridObject
+> = z.nativeEnum(GetCensusGridObject);
+
+/** @internal */
+export const GetCensusGridResponseBody$inboundSchema: z.ZodType<
+  GetCensusGridResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => GetCensusGridData$inboundSchema)),
+  has_more: z.boolean(),
+  object: GetCensusGridObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function getCensusGridResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusGridResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusGridResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusGridResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,103 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * 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 PathParamGeotype = {
+  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 PathParamGeotype = ClosedEnum<typeof PathParamGeotype>;
+
+/**
+ * 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 QueryParamMode = {
+  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 QueryParamMode = ClosedEnum<typeof QueryParamMode>;
+
+export type GetCensusTileRequest = {
+  /**
+   * Category code — '{classificationCode}-{NNN}'.
+   */
+  categoryCode: string;
+  /**
+   * 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: PathParamGeotype;
+  /**
+   * 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?: QueryParamMode | undefined;
+  /**
+   * XYZ slippy tile coordinate as '{x}-{y}-{z}'.
+   */
+  tile: string;
+};
+
+/** @internal */
+export const PathParamGeotype$outboundSchema: z.ZodNativeEnum<
+  typeof PathParamGeotype
+> = z.nativeEnum(PathParamGeotype);
+
+/** @internal */
+export const QueryParamMode$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamMode
+> = z.nativeEnum(QueryParamMode);
+
+/** @internal */
+export type GetCensusTileRequest$Outbound = {
+  categoryCode: string;
+  datasetCode: string;
+  geotype: string;
+  mode: string;
+  tile: string;
+};
+
+/** @internal */
+export const GetCensusTileRequest$outboundSchema: z.ZodType<
+  GetCensusTileRequest$Outbound,
+  z.ZodTypeDef,
+  GetCensusTileRequest
+> = z.object({
+  categoryCode: z.string(),
+  datasetCode: z.string(),
+  geotype: PathParamGeotype$outboundSchema,
+  mode: QueryParamMode$outboundSchema.default("standard"),
+  tile: z.string(),
+});
+
+export function getCensusTileRequestToJSON(
+  getCensusTileRequest: GetCensusTileRequest,
+): string {
+  return JSON.stringify(
+    GetCensusTileRequest$outboundSchema.parse(getCensusTileRequest),
+  );
+}