@vepler/sdk 2.138.0 → 2.139.0

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

@@ -0,0 +1,403 @@
+/*
+ * 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 GetCensusClassificationCensusResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusClassificationCensusResponseType = OpenEnum<
+  typeof GetCensusClassificationCensusResponseType
+>;
+
+export type GetCensusClassificationCensusResponseError = {
+  /**
+   * 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: GetCensusClassificationCensusResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusClassificationCensusResponseResponseBodyData = {
+  error: GetCensusClassificationCensusResponseError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusClassificationCensusResponseResponseBody
+  extends SDKBaseError
+{
+  error: GetCensusClassificationCensusResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusClassificationCensusResponseResponseBodyData;
+
+  constructor(
+    err: GetCensusClassificationCensusResponseResponseBodyData,
+    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 = "GetCensusClassificationCensusResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetCensusClassificationCensusType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusClassificationCensusType = OpenEnum<
+  typeof GetCensusClassificationCensusType
+>;
+
+export type GetCensusClassificationCensusError = {
+  /**
+   * 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: GetCensusClassificationCensusType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusClassificationCensusResponseBodyData = {
+  error: GetCensusClassificationCensusError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusClassificationCensusResponseBody extends SDKBaseError {
+  error: GetCensusClassificationCensusError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusClassificationCensusResponseBodyData;
+
+  constructor(
+    err: GetCensusClassificationCensusResponseBodyData,
+    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 = "GetCensusClassificationCensusResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetCensusClassificationType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusClassificationType = OpenEnum<
+  typeof GetCensusClassificationType
+>;
+
+export type GetCensusClassificationError = {
+  /**
+   * 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: GetCensusClassificationType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusClassificationResponseBodyData = {
+  error: GetCensusClassificationError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusClassificationResponseBody extends SDKBaseError {
+  error: GetCensusClassificationError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusClassificationResponseBodyData;
+
+  constructor(
+    err: GetCensusClassificationResponseBodyData,
+    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 = "GetCensusClassificationResponseBody";
+  }
+}
+
+/** @internal */
+export const GetCensusClassificationCensusResponseType$inboundSchema: z.ZodType<
+  GetCensusClassificationCensusResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusClassificationCensusResponseType);
+
+/** @internal */
+export const GetCensusClassificationCensusResponseError$inboundSchema:
+  z.ZodType<GetCensusClassificationCensusResponseError, 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: GetCensusClassificationCensusResponseType$inboundSchema,
+    }).transform((v) => {
+      return remap$(v, {
+        "doc_url": "docUrl",
+      });
+    });
+
+export function getCensusClassificationCensusResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetCensusClassificationCensusResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCensusClassificationCensusResponseError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetCensusClassificationCensusResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusClassificationCensusResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetCensusClassificationCensusResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetCensusClassificationCensusResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetCensusClassificationCensusResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetCensusClassificationCensusType$inboundSchema: z.ZodType<
+  GetCensusClassificationCensusType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusClassificationCensusType);
+
+/** @internal */
+export const GetCensusClassificationCensusError$inboundSchema: z.ZodType<
+  GetCensusClassificationCensusError,
+  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: GetCensusClassificationCensusType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusClassificationCensusErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusClassificationCensusError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCensusClassificationCensusError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusClassificationCensusError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusClassificationCensusResponseBody$inboundSchema: z.ZodType<
+  GetCensusClassificationCensusResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusClassificationCensusError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusClassificationCensusResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetCensusClassificationType$inboundSchema: z.ZodType<
+  GetCensusClassificationType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusClassificationType);
+
+/** @internal */
+export const GetCensusClassificationError$inboundSchema: z.ZodType<
+  GetCensusClassificationError,
+  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: GetCensusClassificationType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusClassificationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusClassificationError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusClassificationError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusClassificationError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusClassificationResponseBody$inboundSchema: z.ZodType<
+  GetCensusClassificationResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusClassificationError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusClassificationResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });