@vepler/sdk 2.138.0 → 2.139.0

package/src/sdk/census.ts

@@ -0,0 +1,241 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { censusAreaProfile } from "../funcs/censusAreaProfile.js";
+import { censusGetBreaks } from "../funcs/censusGetBreaks.js";
+import { censusGetCatalog } from "../funcs/censusGetCatalog.js";
+import { censusGetCategory } from "../funcs/censusGetCategory.js";
+import { censusGetClassification } from "../funcs/censusGetClassification.js";
+import { censusGetDataset } from "../funcs/censusGetDataset.js";
+import { censusGetGrid } from "../funcs/censusGetGrid.js";
+import { censusGetTile } from "../funcs/censusGetTile.js";
+import { censusGetVariable } from "../funcs/censusGetVariable.js";
+import { censusGetWholeLevel } from "../funcs/censusGetWholeLevel.js";
+import { censusListDatasets } from "../funcs/censusListDatasets.js";
+import { censusListVariables } from "../funcs/censusListVariables.js";
+import { censusRollup } from "../funcs/censusRollup.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Census extends ClientSDK {
+  /**
+   * Build a multi-area census profile
+   *
+   * @remarks
+   * Return every (or a filtered set of) category value for up to 100 ONS geography codes. Each row carries its variable/classification context plus the raw count and the proportion in [0,1].
+   */
+  async areaProfile(
+    request: operations.PostCensusAreaProfileRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PostCensusAreaProfileResponseBody> {
+    return unwrapAsync(censusAreaProfile(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get ckmeans class breaks (JSON)
+   *
+   * @remarks
+   * Return the ONS Census Maps ckmeans legend for one category at one geography level — a bare flat JSON array of exactly 6 floats [min, b1, b2, b3, b4, max] giving 5 colour classes. Pass `?mode=change` for breaks computed over signed percentage-point change values.
+   */
+  async getBreaks(
+    request: operations.GetCensusBreaksRequest,
+    options?: RequestOptions,
+  ): Promise<Array<number>> {
+    return unwrapAsync(censusGetBreaks(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get the census catalogue for a dataset
+   *
+   * @remarks
+   * Flat machine-readable catalogue of every census category in the dataset and the geography levels it can be served at. Use this to discover `categoryCode`s for the tile / break / value endpoints.
+   */
+  async getCatalog(
+    request: operations.GetCensusCatalogRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetCensusCatalogResponseBody> {
+    return unwrapAsync(censusGetCatalog(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a census category
+   *
+   * @remarks
+   * Retrieve a single census category by its code ('{classificationCode}-{NNN}') within a dataset.
+   */
+  async getCategory(
+    request: operations.GetCensusCategoryRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetCensusCategoryResponseBody> {
+    return unwrapAsync(censusGetCategory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a census classification
+   *
+   * @remarks
+   * Retrieve a single census classification (granularity cut) by its code within a dataset.
+   */
+  async getClassification(
+    request: operations.GetCensusClassificationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetCensusClassificationResponseBody> {
+    return unwrapAsync(censusGetClassification(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a census dataset
+   *
+   * @remarks
+   * Retrieve a single census dataset by its stable code.
+   */
+  async getDataset(
+    request: operations.GetCensusDatasetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetCensusDatasetResponseBody> {
+    return unwrapAsync(censusGetDataset(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get the XYZ quad grid for a dataset
+   *
+   * @remarks
+   * Return the client XYZ quad grid (tile membership + bbox) for a dataset, optionally filtered to one geography level via the `geotype` query parameter.
+   */
+  async getGrid(
+    request: operations.GetCensusGridRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetCensusGridResponseBody> {
+    return unwrapAsync(censusGetGrid(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a census choropleth tile (CSV)
+   *
+   * @remarks
+   * Return the ONS Census Maps flat-file CSV for one XYZ slippy tile: areas of `geotype` whose centroid falls inside the tile bbox, as `geography_code,{categoryCode}` rows. The `tile` path segment is '{x}-{y}-{z}'. Pass `?mode=change` for signed percentage-point change values.
+   */
+  async getTile(
+    request: operations.GetCensusTileRequest,
+    options?: RequestOptions,
+  ): Promise<string> {
+    return unwrapAsync(censusGetTile(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a census variable
+   *
+   * @remarks
+   * Retrieve a single census variable by its slug within a dataset.
+   */
+  async getVariable(
+    request: operations.GetCensusVariableRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetCensusVariableResponseBody> {
+    return unwrapAsync(censusGetVariable(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a whole-country census level (CSV)
+   *
+   * @remarks
+   * Return the ONS Census Maps whole-country flat-file CSV for one coarse geography level (e.g. lad/region/country) of one nation, as `geography_code,{categoryCode}` rows. Pass `?mode=change` for signed percentage-point change values.
+   */
+  async getWholeLevel(
+    request: operations.GetCensusWholeLevelRequest,
+    options?: RequestOptions,
+  ): Promise<string> {
+    return unwrapAsync(censusGetWholeLevel(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List census datasets
+   *
+   * @remarks
+   * List every census dataset (a nation's vintage, e.g. 'ew-2021', 'sco-2022').
+   */
+  async listDatasets(
+    options?: RequestOptions,
+  ): Promise<operations.ListCensusDatasetsResponseBody> {
+    return unwrapAsync(censusListDatasets(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * List census variables for a dataset
+   *
+   * @remarks
+   * List the census variables (topics) available in a dataset.
+   */
+  async listVariables(
+    request: operations.ListCensusVariablesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListCensusVariablesResponseBody> {
+    return unwrapAsync(censusListVariables(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Roll up census categories over a custom area
+   *
+   * @remarks
+   * Aggregate category counts over a custom set of up to 100 ONS geography codes. Ratios are SUM(count)/SUM(base) — never an average of child ratios.
+   */
+  async rollup(
+    request: operations.PostCensusRollupRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PostCensusRollupResponseBody> {
+    return unwrapAsync(censusRollup(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/models/errors/getcensusbreaks.ts

@@ -0,0 +1,392 @@
+/*
+ * 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 * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKBaseError } from "./sdkbaseerror.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+
+/**
+ * Error type category
+ */
+export const GetCensusBreaksCensusResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusBreaksCensusResponseType = OpenEnum<
+  typeof GetCensusBreaksCensusResponseType
+>;
+
+export type GetCensusBreaksCensusResponseError = {
+  /**
+   * Machine-readable error code
+   */
+  code?: string | undefined;
+  /**
+   * URL to relevant documentation
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable error message
+   */
+  message: string;
+  /**
+   * Parameter that caused the error
+   */
+  param?: string | undefined;
+  /**
+   * Suggested corrections (e.g. postcode typo suggestions)
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Error type category
+   */
+  type: GetCensusBreaksCensusResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusBreaksCensusResponseResponseBodyData = {
+  error: GetCensusBreaksCensusResponseError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusBreaksCensusResponseResponseBody extends SDKBaseError {
+  error: GetCensusBreaksCensusResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusBreaksCensusResponseResponseBodyData;
+
+  constructor(
+    err: GetCensusBreaksCensusResponseResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.error?.message
+      || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "GetCensusBreaksCensusResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetCensusBreaksCensusType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusBreaksCensusType = OpenEnum<
+  typeof GetCensusBreaksCensusType
+>;
+
+export type GetCensusBreaksCensusError = {
+  /**
+   * Machine-readable error code
+   */
+  code?: string | undefined;
+  /**
+   * URL to relevant documentation
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable error message
+   */
+  message: string;
+  /**
+   * Parameter that caused the error
+   */
+  param?: string | undefined;
+  /**
+   * Suggested corrections (e.g. postcode typo suggestions)
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Error type category
+   */
+  type: GetCensusBreaksCensusType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusBreaksCensusResponseBodyData = {
+  error: GetCensusBreaksCensusError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusBreaksCensusResponseBody extends SDKBaseError {
+  error: GetCensusBreaksCensusError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusBreaksCensusResponseBodyData;
+
+  constructor(
+    err: GetCensusBreaksCensusResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.error?.message
+      || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "GetCensusBreaksCensusResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetCensusBreaksType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusBreaksType = OpenEnum<typeof GetCensusBreaksType>;
+
+export type GetCensusBreaksError = {
+  /**
+   * Machine-readable error code
+   */
+  code?: string | undefined;
+  /**
+   * URL to relevant documentation
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable error message
+   */
+  message: string;
+  /**
+   * Parameter that caused the error
+   */
+  param?: string | undefined;
+  /**
+   * Suggested corrections (e.g. postcode typo suggestions)
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Error type category
+   */
+  type: GetCensusBreaksType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusBreaksResponseBodyData = {
+  error: GetCensusBreaksError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusBreaksResponseBody extends SDKBaseError {
+  error: GetCensusBreaksError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusBreaksResponseBodyData;
+
+  constructor(
+    err: GetCensusBreaksResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.error?.message
+      || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "GetCensusBreaksResponseBody";
+  }
+}
+
+/** @internal */
+export const GetCensusBreaksCensusResponseType$inboundSchema: z.ZodType<
+  GetCensusBreaksCensusResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusBreaksCensusResponseType);
+
+/** @internal */
+export const GetCensusBreaksCensusResponseError$inboundSchema: z.ZodType<
+  GetCensusBreaksCensusResponseError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  suggestions: z.array(z.string()).optional(),
+  type: GetCensusBreaksCensusResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusBreaksCensusResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusBreaksCensusResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCensusBreaksCensusResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusBreaksCensusResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusBreaksCensusResponseResponseBody$inboundSchema: z.ZodType<
+  GetCensusBreaksCensusResponseResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusBreaksCensusResponseError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusBreaksCensusResponseResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetCensusBreaksCensusType$inboundSchema: z.ZodType<
+  GetCensusBreaksCensusType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusBreaksCensusType);
+
+/** @internal */
+export const GetCensusBreaksCensusError$inboundSchema: z.ZodType<
+  GetCensusBreaksCensusError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  suggestions: z.array(z.string()).optional(),
+  type: GetCensusBreaksCensusType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusBreaksCensusErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusBreaksCensusError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusBreaksCensusError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusBreaksCensusError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusBreaksCensusResponseBody$inboundSchema: z.ZodType<
+  GetCensusBreaksCensusResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusBreaksCensusError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusBreaksCensusResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetCensusBreaksType$inboundSchema: z.ZodType<
+  GetCensusBreaksType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusBreaksType);
+
+/** @internal */
+export const GetCensusBreaksError$inboundSchema: z.ZodType<
+  GetCensusBreaksError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  suggestions: z.array(z.string()).optional(),
+  type: GetCensusBreaksType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusBreaksErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusBreaksError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusBreaksError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusBreaksError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusBreaksResponseBody$inboundSchema: z.ZodType<
+  GetCensusBreaksResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusBreaksError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusBreaksResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });