@vepler/sdk 2.138.0 → 2.140.0

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

@@ -0,0 +1,393 @@
+/*
+ * 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 GetCensusCategoryCensusResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusCategoryCensusResponseType = OpenEnum<
+  typeof GetCensusCategoryCensusResponseType
+>;
+
+export type GetCensusCategoryCensusResponseError = {
+  /**
+   * 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: GetCensusCategoryCensusResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusCategoryCensusResponseResponseBodyData = {
+  error: GetCensusCategoryCensusResponseError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusCategoryCensusResponseResponseBody extends SDKBaseError {
+  error: GetCensusCategoryCensusResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusCategoryCensusResponseResponseBodyData;
+
+  constructor(
+    err: GetCensusCategoryCensusResponseResponseBodyData,
+    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 = "GetCensusCategoryCensusResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetCensusCategoryCensusType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusCategoryCensusType = OpenEnum<
+  typeof GetCensusCategoryCensusType
+>;
+
+export type GetCensusCategoryCensusError = {
+  /**
+   * 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: GetCensusCategoryCensusType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusCategoryCensusResponseBodyData = {
+  error: GetCensusCategoryCensusError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusCategoryCensusResponseBody extends SDKBaseError {
+  error: GetCensusCategoryCensusError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusCategoryCensusResponseBodyData;
+
+  constructor(
+    err: GetCensusCategoryCensusResponseBodyData,
+    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 = "GetCensusCategoryCensusResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetCensusCategoryType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusCategoryType = OpenEnum<typeof GetCensusCategoryType>;
+
+export type GetCensusCategoryError = {
+  /**
+   * 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: GetCensusCategoryType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusCategoryResponseBodyData = {
+  error: GetCensusCategoryError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusCategoryResponseBody extends SDKBaseError {
+  error: GetCensusCategoryError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusCategoryResponseBodyData;
+
+  constructor(
+    err: GetCensusCategoryResponseBodyData,
+    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 = "GetCensusCategoryResponseBody";
+  }
+}
+
+/** @internal */
+export const GetCensusCategoryCensusResponseType$inboundSchema: z.ZodType<
+  GetCensusCategoryCensusResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusCategoryCensusResponseType);
+
+/** @internal */
+export const GetCensusCategoryCensusResponseError$inboundSchema: z.ZodType<
+  GetCensusCategoryCensusResponseError,
+  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: GetCensusCategoryCensusResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusCategoryCensusResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusCategoryCensusResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCensusCategoryCensusResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusCategoryCensusResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusCategoryCensusResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetCensusCategoryCensusResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => GetCensusCategoryCensusResponseError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetCensusCategoryCensusResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetCensusCategoryCensusType$inboundSchema: z.ZodType<
+  GetCensusCategoryCensusType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusCategoryCensusType);
+
+/** @internal */
+export const GetCensusCategoryCensusError$inboundSchema: z.ZodType<
+  GetCensusCategoryCensusError,
+  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: GetCensusCategoryCensusType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusCategoryCensusErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusCategoryCensusError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusCategoryCensusError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusCategoryCensusError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusCategoryCensusResponseBody$inboundSchema: z.ZodType<
+  GetCensusCategoryCensusResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusCategoryCensusError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusCategoryCensusResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetCensusCategoryType$inboundSchema: z.ZodType<
+  GetCensusCategoryType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusCategoryType);
+
+/** @internal */
+export const GetCensusCategoryError$inboundSchema: z.ZodType<
+  GetCensusCategoryError,
+  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: GetCensusCategoryType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusCategoryErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusCategoryError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusCategoryError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusCategoryError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusCategoryResponseBody$inboundSchema: z.ZodType<
+  GetCensusCategoryResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusCategoryError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusCategoryResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });