@vepler/sdk 2.138.0 → 2.139.0

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

@@ -0,0 +1,390 @@
+/*
+ * 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 PostCensusRollupCensusResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type PostCensusRollupCensusResponseType = OpenEnum<
+  typeof PostCensusRollupCensusResponseType
+>;
+
+export type PostCensusRollupCensusResponseError = {
+  /**
+   * 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: PostCensusRollupCensusResponseType;
+};
+
+/**
+ * Error response
+ */
+export type PostCensusRollupCensusResponseResponseBodyData = {
+  error: PostCensusRollupCensusResponseError;
+};
+
+/**
+ * Error response
+ */
+export class PostCensusRollupCensusResponseResponseBody extends SDKBaseError {
+  error: PostCensusRollupCensusResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: PostCensusRollupCensusResponseResponseBodyData;
+
+  constructor(
+    err: PostCensusRollupCensusResponseResponseBodyData,
+    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 = "PostCensusRollupCensusResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const PostCensusRollupCensusType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type PostCensusRollupCensusType = OpenEnum<
+  typeof PostCensusRollupCensusType
+>;
+
+export type PostCensusRollupCensusError = {
+  /**
+   * 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: PostCensusRollupCensusType;
+};
+
+/**
+ * Error response
+ */
+export type PostCensusRollupCensusResponseBodyData = {
+  error: PostCensusRollupCensusError;
+};
+
+/**
+ * Error response
+ */
+export class PostCensusRollupCensusResponseBody extends SDKBaseError {
+  error: PostCensusRollupCensusError;
+
+  /** The original data that was passed to this error instance. */
+  data$: PostCensusRollupCensusResponseBodyData;
+
+  constructor(
+    err: PostCensusRollupCensusResponseBodyData,
+    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 = "PostCensusRollupCensusResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const PostCensusRollupType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type PostCensusRollupType = OpenEnum<typeof PostCensusRollupType>;
+
+export type PostCensusRollupError = {
+  /**
+   * 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: PostCensusRollupType;
+};
+
+/**
+ * Error response
+ */
+export type PostCensusRollupResponseBodyData = {
+  error: PostCensusRollupError;
+};
+
+/**
+ * Error response
+ */
+export class PostCensusRollupResponseBody extends SDKBaseError {
+  error: PostCensusRollupError;
+
+  /** The original data that was passed to this error instance. */
+  data$: PostCensusRollupResponseBodyData;
+
+  constructor(
+    err: PostCensusRollupResponseBodyData,
+    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 = "PostCensusRollupResponseBody";
+  }
+}
+
+/** @internal */
+export const PostCensusRollupCensusResponseType$inboundSchema: z.ZodType<
+  PostCensusRollupCensusResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PostCensusRollupCensusResponseType);
+
+/** @internal */
+export const PostCensusRollupCensusResponseError$inboundSchema: z.ZodType<
+  PostCensusRollupCensusResponseError,
+  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: PostCensusRollupCensusResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function postCensusRollupCensusResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<PostCensusRollupCensusResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PostCensusRollupCensusResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostCensusRollupCensusResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const PostCensusRollupCensusResponseResponseBody$inboundSchema:
+  z.ZodType<PostCensusRollupCensusResponseResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      error: z.lazy(() => PostCensusRollupCensusResponseError$inboundSchema),
+      request$: z.instanceof(Request),
+      response$: z.instanceof(Response),
+      body$: z.string(),
+    })
+      .transform((v) => {
+        return new PostCensusRollupCensusResponseResponseBody(v, {
+          request: v.request$,
+          response: v.response$,
+          body: v.body$,
+        });
+      });
+
+/** @internal */
+export const PostCensusRollupCensusType$inboundSchema: z.ZodType<
+  PostCensusRollupCensusType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PostCensusRollupCensusType);
+
+/** @internal */
+export const PostCensusRollupCensusError$inboundSchema: z.ZodType<
+  PostCensusRollupCensusError,
+  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: PostCensusRollupCensusType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function postCensusRollupCensusErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<PostCensusRollupCensusError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PostCensusRollupCensusError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostCensusRollupCensusError' from JSON`,
+  );
+}
+
+/** @internal */
+export const PostCensusRollupCensusResponseBody$inboundSchema: z.ZodType<
+  PostCensusRollupCensusResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => PostCensusRollupCensusError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new PostCensusRollupCensusResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const PostCensusRollupType$inboundSchema: z.ZodType<
+  PostCensusRollupType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PostCensusRollupType);
+
+/** @internal */
+export const PostCensusRollupError$inboundSchema: z.ZodType<
+  PostCensusRollupError,
+  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: PostCensusRollupType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function postCensusRollupErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<PostCensusRollupError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PostCensusRollupError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostCensusRollupError' from JSON`,
+  );
+}
+
+/** @internal */
+export const PostCensusRollupResponseBody$inboundSchema: z.ZodType<
+  PostCensusRollupResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => PostCensusRollupError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new PostCensusRollupResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -0,0 +1,96 @@
+/*
+ * 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 Geotype = {
+  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 Geotype = ClosedEnum<typeof Geotype>;
+
+/**
+ * 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 Mode = {
+  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 Mode = ClosedEnum<typeof Mode>;
+
+export type GetCensusBreaksRequest = {
+  /**
+   * 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: Geotype;
+  /**
+   * 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?: Mode | undefined;
+};
+
+/** @internal */
+export const Geotype$outboundSchema: z.ZodNativeEnum<typeof Geotype> = z
+  .nativeEnum(Geotype);
+
+/** @internal */
+export const Mode$outboundSchema: z.ZodNativeEnum<typeof Mode> = z.nativeEnum(
+  Mode,
+);
+
+/** @internal */
+export type GetCensusBreaksRequest$Outbound = {
+  categoryCode: string;
+  datasetCode: string;
+  geotype: string;
+  mode: string;
+};
+
+/** @internal */
+export const GetCensusBreaksRequest$outboundSchema: z.ZodType<
+  GetCensusBreaksRequest$Outbound,
+  z.ZodTypeDef,
+  GetCensusBreaksRequest
+> = z.object({
+  categoryCode: z.string(),
+  datasetCode: z.string(),
+  geotype: Geotype$outboundSchema,
+  mode: Mode$outboundSchema.default("standard"),
+});
+
+export function getCensusBreaksRequestToJSON(
+  getCensusBreaksRequest: GetCensusBreaksRequest,
+): string {
+  return JSON.stringify(
+    GetCensusBreaksRequest$outboundSchema.parse(getCensusBreaksRequest),
+  );
+}

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

@@ -0,0 +1,165 @@
+/*
+ * 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 GetCensusCatalogRequest = {
+  /**
+   * Stable public dataset id, e.g. 'ew-2021' or 'sco-2022'.
+   */
+  datasetCode: string;
+};
+
+/**
+ * One flat catalogue entry — a category and where it can be served.
+ */
+export type Data = {
+  /**
+   * Geography levels this category can be served at.
+   */
+  availableGeotypes: Array<string>;
+  /**
+   * Category code — '{classificationCode}-{NNN}'.
+   */
+  categoryCode: string;
+  /**
+   * Human-readable category label.
+   */
+  categoryName: string;
+  /**
+   * Classification file-stem code.
+   */
+  classificationCode: string;
+  /**
+   * Whether this is the default classification for the variable.
+   */
+  isDefault: boolean;
+  /**
+   * Variable code.
+   */
+  variableCode: string;
+  /**
+   * Variable slug.
+   */
+  variableSlug: string;
+};
+
+/**
+ * Object type identifier
+ */
+export const GetCensusCatalogObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type GetCensusCatalogObject = ClosedEnum<typeof GetCensusCatalogObject>;
+
+/**
+ * Flat machine-readable census catalogue (Stripe-style envelope).
+ */
+export type GetCensusCatalogResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<Data>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: GetCensusCatalogObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type GetCensusCatalogRequest$Outbound = {
+  datasetCode: string;
+};
+
+/** @internal */
+export const GetCensusCatalogRequest$outboundSchema: z.ZodType<
+  GetCensusCatalogRequest$Outbound,
+  z.ZodTypeDef,
+  GetCensusCatalogRequest
+> = z.object({
+  datasetCode: z.string(),
+});
+
+export function getCensusCatalogRequestToJSON(
+  getCensusCatalogRequest: GetCensusCatalogRequest,
+): string {
+  return JSON.stringify(
+    GetCensusCatalogRequest$outboundSchema.parse(getCensusCatalogRequest),
+  );
+}
+
+/** @internal */
+export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
+  .object({
+    availableGeotypes: z.array(z.string()),
+    categoryCode: z.string(),
+    categoryName: z.string(),
+    classificationCode: z.string(),
+    isDefault: z.boolean(),
+    variableCode: z.string(),
+    variableSlug: z.string(),
+  });
+
+export function dataFromJSON(
+  jsonString: string,
+): SafeParseResult<Data, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Data$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Data' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusCatalogObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetCensusCatalogObject
+> = z.nativeEnum(GetCensusCatalogObject);
+
+/** @internal */
+export const GetCensusCatalogResponseBody$inboundSchema: z.ZodType<
+  GetCensusCatalogResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => Data$inboundSchema)),
+  has_more: z.boolean(),
+  object: GetCensusCatalogObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function getCensusCatalogResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusCatalogResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusCatalogResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusCatalogResponseBody' from JSON`,
+  );
+}