@vepler/sdk 2.137.0 → 2.139.0

package/src/sdk/models/errors/getcensuscatalog.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 GetCensusCatalogCensusResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusCatalogCensusResponseType = OpenEnum<
+  typeof GetCensusCatalogCensusResponseType
+>;
+
+export type GetCensusCatalogCensusResponseError = {
+  /**
+   * 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: GetCensusCatalogCensusResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusCatalogCensusResponseResponseBodyData = {
+  error: GetCensusCatalogCensusResponseError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusCatalogCensusResponseResponseBody extends SDKBaseError {
+  error: GetCensusCatalogCensusResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusCatalogCensusResponseResponseBodyData;
+
+  constructor(
+    err: GetCensusCatalogCensusResponseResponseBodyData,
+    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 = "GetCensusCatalogCensusResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetCensusCatalogCensusType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusCatalogCensusType = OpenEnum<
+  typeof GetCensusCatalogCensusType
+>;
+
+export type GetCensusCatalogCensusError = {
+  /**
+   * 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: GetCensusCatalogCensusType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusCatalogCensusResponseBodyData = {
+  error: GetCensusCatalogCensusError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusCatalogCensusResponseBody extends SDKBaseError {
+  error: GetCensusCatalogCensusError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusCatalogCensusResponseBodyData;
+
+  constructor(
+    err: GetCensusCatalogCensusResponseBodyData,
+    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 = "GetCensusCatalogCensusResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetCensusCatalogType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusCatalogType = OpenEnum<typeof GetCensusCatalogType>;
+
+export type GetCensusCatalogError = {
+  /**
+   * 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: GetCensusCatalogType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusCatalogResponseBodyData = {
+  error: GetCensusCatalogError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusCatalogResponseBody extends SDKBaseError {
+  error: GetCensusCatalogError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusCatalogResponseBodyData;
+
+  constructor(
+    err: GetCensusCatalogResponseBodyData,
+    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 = "GetCensusCatalogResponseBody";
+  }
+}
+
+/** @internal */
+export const GetCensusCatalogCensusResponseType$inboundSchema: z.ZodType<
+  GetCensusCatalogCensusResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusCatalogCensusResponseType);
+
+/** @internal */
+export const GetCensusCatalogCensusResponseError$inboundSchema: z.ZodType<
+  GetCensusCatalogCensusResponseError,
+  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: GetCensusCatalogCensusResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusCatalogCensusResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusCatalogCensusResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCensusCatalogCensusResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusCatalogCensusResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusCatalogCensusResponseResponseBody$inboundSchema:
+  z.ZodType<GetCensusCatalogCensusResponseResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      error: z.lazy(() => GetCensusCatalogCensusResponseError$inboundSchema),
+      request$: z.instanceof(Request),
+      response$: z.instanceof(Response),
+      body$: z.string(),
+    })
+      .transform((v) => {
+        return new GetCensusCatalogCensusResponseResponseBody(v, {
+          request: v.request$,
+          response: v.response$,
+          body: v.body$,
+        });
+      });
+
+/** @internal */
+export const GetCensusCatalogCensusType$inboundSchema: z.ZodType<
+  GetCensusCatalogCensusType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusCatalogCensusType);
+
+/** @internal */
+export const GetCensusCatalogCensusError$inboundSchema: z.ZodType<
+  GetCensusCatalogCensusError,
+  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: GetCensusCatalogCensusType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusCatalogCensusErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusCatalogCensusError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusCatalogCensusError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusCatalogCensusError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusCatalogCensusResponseBody$inboundSchema: z.ZodType<
+  GetCensusCatalogCensusResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusCatalogCensusError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusCatalogCensusResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetCensusCatalogType$inboundSchema: z.ZodType<
+  GetCensusCatalogType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusCatalogType);
+
+/** @internal */
+export const GetCensusCatalogError$inboundSchema: z.ZodType<
+  GetCensusCatalogError,
+  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: GetCensusCatalogType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusCatalogErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusCatalogError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusCatalogError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusCatalogError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusCatalogResponseBody$inboundSchema: z.ZodType<
+  GetCensusCatalogResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusCatalogError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusCatalogResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });