@vepler/sdk 2.158.0 → 2.164.0

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

@@ -0,0 +1,542 @@
+/*
+ * 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 GetHeritageDesignationHeritageResponse503Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetHeritageDesignationHeritageResponse503Type = OpenEnum<
+  typeof GetHeritageDesignationHeritageResponse503Type
+>;
+
+export type GetHeritageDesignationHeritageResponse503Error = {
+  /**
+   * 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: GetHeritageDesignationHeritageResponse503Type;
+};
+
+/**
+ * Error response
+ */
+export type GetHeritageDesignationHeritageResponse503ResponseBodyData = {
+  error: GetHeritageDesignationHeritageResponse503Error;
+};
+
+/**
+ * Error response
+ */
+export class GetHeritageDesignationHeritageResponse503ResponseBody
+  extends SDKBaseError
+{
+  error: GetHeritageDesignationHeritageResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetHeritageDesignationHeritageResponse503ResponseBodyData;
+
+  constructor(
+    err: GetHeritageDesignationHeritageResponse503ResponseBodyData,
+    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 = "GetHeritageDesignationHeritageResponse503ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetHeritageDesignationHeritageResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetHeritageDesignationHeritageResponseType = OpenEnum<
+  typeof GetHeritageDesignationHeritageResponseType
+>;
+
+export type GetHeritageDesignationHeritageResponseError = {
+  /**
+   * 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: GetHeritageDesignationHeritageResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetHeritageDesignationHeritageResponseResponseBodyData = {
+  error: GetHeritageDesignationHeritageResponseError;
+};
+
+/**
+ * Error response
+ */
+export class GetHeritageDesignationHeritageResponseResponseBody
+  extends SDKBaseError
+{
+  error: GetHeritageDesignationHeritageResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetHeritageDesignationHeritageResponseResponseBodyData;
+
+  constructor(
+    err: GetHeritageDesignationHeritageResponseResponseBodyData,
+    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 = "GetHeritageDesignationHeritageResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetHeritageDesignationHeritageType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetHeritageDesignationHeritageType = OpenEnum<
+  typeof GetHeritageDesignationHeritageType
+>;
+
+export type GetHeritageDesignationHeritageError = {
+  /**
+   * 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: GetHeritageDesignationHeritageType;
+};
+
+/**
+ * Error response
+ */
+export type GetHeritageDesignationHeritageResponseBodyData = {
+  error: GetHeritageDesignationHeritageError;
+};
+
+/**
+ * Error response
+ */
+export class GetHeritageDesignationHeritageResponseBody extends SDKBaseError {
+  error: GetHeritageDesignationHeritageError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetHeritageDesignationHeritageResponseBodyData;
+
+  constructor(
+    err: GetHeritageDesignationHeritageResponseBodyData,
+    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 = "GetHeritageDesignationHeritageResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetHeritageDesignationType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetHeritageDesignationType = OpenEnum<
+  typeof GetHeritageDesignationType
+>;
+
+export type GetHeritageDesignationError = {
+  /**
+   * 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: GetHeritageDesignationType;
+};
+
+/**
+ * Error response
+ */
+export type GetHeritageDesignationResponseBodyData = {
+  error: GetHeritageDesignationError;
+};
+
+/**
+ * Error response
+ */
+export class GetHeritageDesignationResponseBody extends SDKBaseError {
+  error: GetHeritageDesignationError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetHeritageDesignationResponseBodyData;
+
+  constructor(
+    err: GetHeritageDesignationResponseBodyData,
+    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 = "GetHeritageDesignationResponseBody";
+  }
+}
+
+/** @internal */
+export const GetHeritageDesignationHeritageResponse503Type$inboundSchema:
+  z.ZodType<
+    GetHeritageDesignationHeritageResponse503Type,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(GetHeritageDesignationHeritageResponse503Type);
+
+/** @internal */
+export const GetHeritageDesignationHeritageResponse503Error$inboundSchema:
+  z.ZodType<
+    GetHeritageDesignationHeritageResponse503Error,
+    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: GetHeritageDesignationHeritageResponse503Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getHeritageDesignationHeritageResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetHeritageDesignationHeritageResponse503Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetHeritageDesignationHeritageResponse503Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetHeritageDesignationHeritageResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetHeritageDesignationHeritageResponse503ResponseBody$inboundSchema:
+  z.ZodType<
+    GetHeritageDesignationHeritageResponse503ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetHeritageDesignationHeritageResponse503Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetHeritageDesignationHeritageResponse503ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetHeritageDesignationHeritageResponseType$inboundSchema:
+  z.ZodType<GetHeritageDesignationHeritageResponseType, z.ZodTypeDef, unknown> =
+    openEnums.inboundSchema(GetHeritageDesignationHeritageResponseType);
+
+/** @internal */
+export const GetHeritageDesignationHeritageResponseError$inboundSchema:
+  z.ZodType<
+    GetHeritageDesignationHeritageResponseError,
+    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: GetHeritageDesignationHeritageResponseType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getHeritageDesignationHeritageResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetHeritageDesignationHeritageResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetHeritageDesignationHeritageResponseError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetHeritageDesignationHeritageResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetHeritageDesignationHeritageResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetHeritageDesignationHeritageResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetHeritageDesignationHeritageResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetHeritageDesignationHeritageResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetHeritageDesignationHeritageType$inboundSchema: z.ZodType<
+  GetHeritageDesignationHeritageType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetHeritageDesignationHeritageType);
+
+/** @internal */
+export const GetHeritageDesignationHeritageError$inboundSchema: z.ZodType<
+  GetHeritageDesignationHeritageError,
+  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: GetHeritageDesignationHeritageType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getHeritageDesignationHeritageErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetHeritageDesignationHeritageError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetHeritageDesignationHeritageError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetHeritageDesignationHeritageError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetHeritageDesignationHeritageResponseBody$inboundSchema:
+  z.ZodType<GetHeritageDesignationHeritageResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      error: z.lazy(() => GetHeritageDesignationHeritageError$inboundSchema),
+      request$: z.instanceof(Request),
+      response$: z.instanceof(Response),
+      body$: z.string(),
+    })
+      .transform((v) => {
+        return new GetHeritageDesignationHeritageResponseBody(v, {
+          request: v.request$,
+          response: v.response$,
+          body: v.body$,
+        });
+      });
+
+/** @internal */
+export const GetHeritageDesignationType$inboundSchema: z.ZodType<
+  GetHeritageDesignationType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetHeritageDesignationType);
+
+/** @internal */
+export const GetHeritageDesignationError$inboundSchema: z.ZodType<
+  GetHeritageDesignationError,
+  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: GetHeritageDesignationType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getHeritageDesignationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetHeritageDesignationError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetHeritageDesignationError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetHeritageDesignationError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetHeritageDesignationResponseBody$inboundSchema: z.ZodType<
+  GetHeritageDesignationResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetHeritageDesignationError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetHeritageDesignationResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });