@vepler/sdk 2.138.0 → 2.140.0

package/src/sdk/models/errors/getcensusdataset.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 GetCensusDatasetCensusResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusDatasetCensusResponseType = OpenEnum<
+  typeof GetCensusDatasetCensusResponseType
+>;
+
+export type GetCensusDatasetCensusResponseError = {
+  /**
+   * 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: GetCensusDatasetCensusResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusDatasetCensusResponseResponseBodyData = {
+  error: GetCensusDatasetCensusResponseError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusDatasetCensusResponseResponseBody extends SDKBaseError {
+  error: GetCensusDatasetCensusResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusDatasetCensusResponseResponseBodyData;
+
+  constructor(
+    err: GetCensusDatasetCensusResponseResponseBodyData,
+    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 = "GetCensusDatasetCensusResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetCensusDatasetCensusType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusDatasetCensusType = OpenEnum<
+  typeof GetCensusDatasetCensusType
+>;
+
+export type GetCensusDatasetCensusError = {
+  /**
+   * 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: GetCensusDatasetCensusType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusDatasetCensusResponseBodyData = {
+  error: GetCensusDatasetCensusError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusDatasetCensusResponseBody extends SDKBaseError {
+  error: GetCensusDatasetCensusError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusDatasetCensusResponseBodyData;
+
+  constructor(
+    err: GetCensusDatasetCensusResponseBodyData,
+    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 = "GetCensusDatasetCensusResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetCensusDatasetType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusDatasetType = OpenEnum<typeof GetCensusDatasetType>;
+
+export type GetCensusDatasetError = {
+  /**
+   * 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: GetCensusDatasetType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusDatasetResponseBodyData = {
+  error: GetCensusDatasetError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusDatasetResponseBody extends SDKBaseError {
+  error: GetCensusDatasetError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusDatasetResponseBodyData;
+
+  constructor(
+    err: GetCensusDatasetResponseBodyData,
+    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 = "GetCensusDatasetResponseBody";
+  }
+}
+
+/** @internal */
+export const GetCensusDatasetCensusResponseType$inboundSchema: z.ZodType<
+  GetCensusDatasetCensusResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusDatasetCensusResponseType);
+
+/** @internal */
+export const GetCensusDatasetCensusResponseError$inboundSchema: z.ZodType<
+  GetCensusDatasetCensusResponseError,
+  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: GetCensusDatasetCensusResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusDatasetCensusResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusDatasetCensusResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCensusDatasetCensusResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusDatasetCensusResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusDatasetCensusResponseResponseBody$inboundSchema:
+  z.ZodType<GetCensusDatasetCensusResponseResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      error: z.lazy(() => GetCensusDatasetCensusResponseError$inboundSchema),
+      request$: z.instanceof(Request),
+      response$: z.instanceof(Response),
+      body$: z.string(),
+    })
+      .transform((v) => {
+        return new GetCensusDatasetCensusResponseResponseBody(v, {
+          request: v.request$,
+          response: v.response$,
+          body: v.body$,
+        });
+      });
+
+/** @internal */
+export const GetCensusDatasetCensusType$inboundSchema: z.ZodType<
+  GetCensusDatasetCensusType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusDatasetCensusType);
+
+/** @internal */
+export const GetCensusDatasetCensusError$inboundSchema: z.ZodType<
+  GetCensusDatasetCensusError,
+  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: GetCensusDatasetCensusType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusDatasetCensusErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusDatasetCensusError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusDatasetCensusError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusDatasetCensusError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusDatasetCensusResponseBody$inboundSchema: z.ZodType<
+  GetCensusDatasetCensusResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusDatasetCensusError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusDatasetCensusResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetCensusDatasetType$inboundSchema: z.ZodType<
+  GetCensusDatasetType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusDatasetType);
+
+/** @internal */
+export const GetCensusDatasetError$inboundSchema: z.ZodType<
+  GetCensusDatasetError,
+  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: GetCensusDatasetType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusDatasetErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusDatasetError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusDatasetError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusDatasetError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusDatasetResponseBody$inboundSchema: z.ZodType<
+  GetCensusDatasetResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusDatasetError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusDatasetResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });