@vepler/sdk 2.137.0 → 2.139.0

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

@@ -0,0 +1,389 @@
+/*
+ * 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 GetCensusTileCensusResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusTileCensusResponseType = OpenEnum<
+  typeof GetCensusTileCensusResponseType
+>;
+
+export type GetCensusTileCensusResponseError = {
+  /**
+   * 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: GetCensusTileCensusResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusTileCensusResponseResponseBodyData = {
+  error: GetCensusTileCensusResponseError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusTileCensusResponseResponseBody extends SDKBaseError {
+  error: GetCensusTileCensusResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusTileCensusResponseResponseBodyData;
+
+  constructor(
+    err: GetCensusTileCensusResponseResponseBodyData,
+    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 = "GetCensusTileCensusResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetCensusTileCensusType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusTileCensusType = OpenEnum<typeof GetCensusTileCensusType>;
+
+export type GetCensusTileCensusError = {
+  /**
+   * 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: GetCensusTileCensusType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusTileCensusResponseBodyData = {
+  error: GetCensusTileCensusError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusTileCensusResponseBody extends SDKBaseError {
+  error: GetCensusTileCensusError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusTileCensusResponseBodyData;
+
+  constructor(
+    err: GetCensusTileCensusResponseBodyData,
+    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 = "GetCensusTileCensusResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetCensusTileType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetCensusTileType = OpenEnum<typeof GetCensusTileType>;
+
+export type GetCensusTileError = {
+  /**
+   * 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: GetCensusTileType;
+};
+
+/**
+ * Error response
+ */
+export type GetCensusTileResponseBodyData = {
+  error: GetCensusTileError;
+};
+
+/**
+ * Error response
+ */
+export class GetCensusTileResponseBody extends SDKBaseError {
+  error: GetCensusTileError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCensusTileResponseBodyData;
+
+  constructor(
+    err: GetCensusTileResponseBodyData,
+    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 = "GetCensusTileResponseBody";
+  }
+}
+
+/** @internal */
+export const GetCensusTileCensusResponseType$inboundSchema: z.ZodType<
+  GetCensusTileCensusResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusTileCensusResponseType);
+
+/** @internal */
+export const GetCensusTileCensusResponseError$inboundSchema: z.ZodType<
+  GetCensusTileCensusResponseError,
+  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: GetCensusTileCensusResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusTileCensusResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusTileCensusResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusTileCensusResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusTileCensusResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusTileCensusResponseResponseBody$inboundSchema: z.ZodType<
+  GetCensusTileCensusResponseResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusTileCensusResponseError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusTileCensusResponseResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetCensusTileCensusType$inboundSchema: z.ZodType<
+  GetCensusTileCensusType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusTileCensusType);
+
+/** @internal */
+export const GetCensusTileCensusError$inboundSchema: z.ZodType<
+  GetCensusTileCensusError,
+  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: GetCensusTileCensusType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusTileCensusErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusTileCensusError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusTileCensusError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusTileCensusError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusTileCensusResponseBody$inboundSchema: z.ZodType<
+  GetCensusTileCensusResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusTileCensusError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusTileCensusResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetCensusTileType$inboundSchema: z.ZodType<
+  GetCensusTileType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCensusTileType);
+
+/** @internal */
+export const GetCensusTileError$inboundSchema: z.ZodType<
+  GetCensusTileError,
+  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: GetCensusTileType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCensusTileErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCensusTileError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetCensusTileError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCensusTileError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCensusTileResponseBody$inboundSchema: z.ZodType<
+  GetCensusTileResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetCensusTileError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetCensusTileResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });