@vepler/sdk 2.155.0 → 2.164.0

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

@@ -0,0 +1,559 @@
+/*
+ * 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 GetConservationDesignationConservationResponse503Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetConservationDesignationConservationResponse503Type = OpenEnum<
+  typeof GetConservationDesignationConservationResponse503Type
+>;
+
+export type GetConservationDesignationConservationResponse503Error = {
+  /**
+   * 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: GetConservationDesignationConservationResponse503Type;
+};
+
+/**
+ * Error response
+ */
+export type GetConservationDesignationConservationResponse503ResponseBodyData =
+  {
+    error: GetConservationDesignationConservationResponse503Error;
+  };
+
+/**
+ * Error response
+ */
+export class GetConservationDesignationConservationResponse503ResponseBody
+  extends SDKBaseError
+{
+  error: GetConservationDesignationConservationResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetConservationDesignationConservationResponse503ResponseBodyData;
+
+  constructor(
+    err: GetConservationDesignationConservationResponse503ResponseBodyData,
+    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 = "GetConservationDesignationConservationResponse503ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetConservationDesignationConservationResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetConservationDesignationConservationResponseType = OpenEnum<
+  typeof GetConservationDesignationConservationResponseType
+>;
+
+export type GetConservationDesignationConservationResponseError = {
+  /**
+   * 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: GetConservationDesignationConservationResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetConservationDesignationConservationResponseResponseBodyData = {
+  error: GetConservationDesignationConservationResponseError;
+};
+
+/**
+ * Error response
+ */
+export class GetConservationDesignationConservationResponseResponseBody
+  extends SDKBaseError
+{
+  error: GetConservationDesignationConservationResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetConservationDesignationConservationResponseResponseBodyData;
+
+  constructor(
+    err: GetConservationDesignationConservationResponseResponseBodyData,
+    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 = "GetConservationDesignationConservationResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetConservationDesignationConservationType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetConservationDesignationConservationType = OpenEnum<
+  typeof GetConservationDesignationConservationType
+>;
+
+export type GetConservationDesignationConservationError = {
+  /**
+   * 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: GetConservationDesignationConservationType;
+};
+
+/**
+ * Error response
+ */
+export type GetConservationDesignationConservationResponseBodyData = {
+  error: GetConservationDesignationConservationError;
+};
+
+/**
+ * Error response
+ */
+export class GetConservationDesignationConservationResponseBody
+  extends SDKBaseError
+{
+  error: GetConservationDesignationConservationError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetConservationDesignationConservationResponseBodyData;
+
+  constructor(
+    err: GetConservationDesignationConservationResponseBodyData,
+    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 = "GetConservationDesignationConservationResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetConservationDesignationType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetConservationDesignationType = OpenEnum<
+  typeof GetConservationDesignationType
+>;
+
+export type GetConservationDesignationError = {
+  /**
+   * 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: GetConservationDesignationType;
+};
+
+/**
+ * Error response
+ */
+export type GetConservationDesignationResponseBodyData = {
+  error: GetConservationDesignationError;
+};
+
+/**
+ * Error response
+ */
+export class GetConservationDesignationResponseBody extends SDKBaseError {
+  error: GetConservationDesignationError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetConservationDesignationResponseBodyData;
+
+  constructor(
+    err: GetConservationDesignationResponseBodyData,
+    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 = "GetConservationDesignationResponseBody";
+  }
+}
+
+/** @internal */
+export const GetConservationDesignationConservationResponse503Type$inboundSchema:
+  z.ZodType<
+    GetConservationDesignationConservationResponse503Type,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    GetConservationDesignationConservationResponse503Type,
+  );
+
+/** @internal */
+export const GetConservationDesignationConservationResponse503Error$inboundSchema:
+  z.ZodType<
+    GetConservationDesignationConservationResponse503Error,
+    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: GetConservationDesignationConservationResponse503Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getConservationDesignationConservationResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetConservationDesignationConservationResponse503Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetConservationDesignationConservationResponse503Error$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'GetConservationDesignationConservationResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetConservationDesignationConservationResponse503ResponseBody$inboundSchema:
+  z.ZodType<
+    GetConservationDesignationConservationResponse503ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetConservationDesignationConservationResponse503Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetConservationDesignationConservationResponse503ResponseBody(
+        v,
+        { request: v.request$, response: v.response$, body: v.body$ },
+      );
+    });
+
+/** @internal */
+export const GetConservationDesignationConservationResponseType$inboundSchema:
+  z.ZodType<
+    GetConservationDesignationConservationResponseType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    GetConservationDesignationConservationResponseType,
+  );
+
+/** @internal */
+export const GetConservationDesignationConservationResponseError$inboundSchema:
+  z.ZodType<
+    GetConservationDesignationConservationResponseError,
+    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: GetConservationDesignationConservationResponseType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getConservationDesignationConservationResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetConservationDesignationConservationResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetConservationDesignationConservationResponseError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetConservationDesignationConservationResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetConservationDesignationConservationResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetConservationDesignationConservationResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetConservationDesignationConservationResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetConservationDesignationConservationResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetConservationDesignationConservationType$inboundSchema:
+  z.ZodType<GetConservationDesignationConservationType, z.ZodTypeDef, unknown> =
+    openEnums.inboundSchema(GetConservationDesignationConservationType);
+
+/** @internal */
+export const GetConservationDesignationConservationError$inboundSchema:
+  z.ZodType<
+    GetConservationDesignationConservationError,
+    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: GetConservationDesignationConservationType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getConservationDesignationConservationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetConservationDesignationConservationError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetConservationDesignationConservationError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetConservationDesignationConservationError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetConservationDesignationConservationResponseBody$inboundSchema:
+  z.ZodType<
+    GetConservationDesignationConservationResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetConservationDesignationConservationError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetConservationDesignationConservationResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetConservationDesignationType$inboundSchema: z.ZodType<
+  GetConservationDesignationType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetConservationDesignationType);
+
+/** @internal */
+export const GetConservationDesignationError$inboundSchema: z.ZodType<
+  GetConservationDesignationError,
+  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: GetConservationDesignationType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getConservationDesignationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetConservationDesignationError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetConservationDesignationError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetConservationDesignationError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetConservationDesignationResponseBody$inboundSchema: z.ZodType<
+  GetConservationDesignationResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetConservationDesignationError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetConservationDesignationResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });