@vepler/sdk 2.158.0 → 2.164.0

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

@@ -0,0 +1,564 @@
+/*
+ * 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 QueryConservationDesignationsConservationResponse503Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryConservationDesignationsConservationResponse503Type = OpenEnum<
+  typeof QueryConservationDesignationsConservationResponse503Type
+>;
+
+export type QueryConservationDesignationsConservationResponse503Error = {
+  /**
+   * 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: QueryConservationDesignationsConservationResponse503Type;
+};
+
+/**
+ * Error response
+ */
+export type QueryConservationDesignationsConservationResponse503ResponseBodyData =
+  {
+    error: QueryConservationDesignationsConservationResponse503Error;
+  };
+
+/**
+ * Error response
+ */
+export class QueryConservationDesignationsConservationResponse503ResponseBody
+  extends SDKBaseError
+{
+  error: QueryConservationDesignationsConservationResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryConservationDesignationsConservationResponse503ResponseBodyData;
+
+  constructor(
+    err: QueryConservationDesignationsConservationResponse503ResponseBodyData,
+    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 =
+      "QueryConservationDesignationsConservationResponse503ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryConservationDesignationsConservationResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryConservationDesignationsConservationResponseType = OpenEnum<
+  typeof QueryConservationDesignationsConservationResponseType
+>;
+
+export type QueryConservationDesignationsConservationResponseError = {
+  /**
+   * 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: QueryConservationDesignationsConservationResponseType;
+};
+
+/**
+ * Error response
+ */
+export type QueryConservationDesignationsConservationResponseResponseBodyData =
+  {
+    error: QueryConservationDesignationsConservationResponseError;
+  };
+
+/**
+ * Error response
+ */
+export class QueryConservationDesignationsConservationResponseResponseBody
+  extends SDKBaseError
+{
+  error: QueryConservationDesignationsConservationResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryConservationDesignationsConservationResponseResponseBodyData;
+
+  constructor(
+    err: QueryConservationDesignationsConservationResponseResponseBodyData,
+    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 = "QueryConservationDesignationsConservationResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryConservationDesignationsConservationType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryConservationDesignationsConservationType = OpenEnum<
+  typeof QueryConservationDesignationsConservationType
+>;
+
+export type QueryConservationDesignationsConservationError = {
+  /**
+   * 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: QueryConservationDesignationsConservationType;
+};
+
+/**
+ * Error response
+ */
+export type QueryConservationDesignationsConservationResponseBodyData = {
+  error: QueryConservationDesignationsConservationError;
+};
+
+/**
+ * Error response
+ */
+export class QueryConservationDesignationsConservationResponseBody
+  extends SDKBaseError
+{
+  error: QueryConservationDesignationsConservationError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryConservationDesignationsConservationResponseBodyData;
+
+  constructor(
+    err: QueryConservationDesignationsConservationResponseBodyData,
+    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 = "QueryConservationDesignationsConservationResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryConservationDesignationsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryConservationDesignationsType = OpenEnum<
+  typeof QueryConservationDesignationsType
+>;
+
+export type QueryConservationDesignationsError = {
+  /**
+   * 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: QueryConservationDesignationsType;
+};
+
+/**
+ * Error response
+ */
+export type QueryConservationDesignationsResponseBodyData = {
+  error: QueryConservationDesignationsError;
+};
+
+/**
+ * Error response
+ */
+export class QueryConservationDesignationsResponseBody extends SDKBaseError {
+  error: QueryConservationDesignationsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryConservationDesignationsResponseBodyData;
+
+  constructor(
+    err: QueryConservationDesignationsResponseBodyData,
+    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 = "QueryConservationDesignationsResponseBody";
+  }
+}
+
+/** @internal */
+export const QueryConservationDesignationsConservationResponse503Type$inboundSchema:
+  z.ZodType<
+    QueryConservationDesignationsConservationResponse503Type,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    QueryConservationDesignationsConservationResponse503Type,
+  );
+
+/** @internal */
+export const QueryConservationDesignationsConservationResponse503Error$inboundSchema:
+  z.ZodType<
+    QueryConservationDesignationsConservationResponse503Error,
+    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:
+      QueryConservationDesignationsConservationResponse503Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function queryConservationDesignationsConservationResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  QueryConservationDesignationsConservationResponse503Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryConservationDesignationsConservationResponse503Error$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'QueryConservationDesignationsConservationResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryConservationDesignationsConservationResponse503ResponseBody$inboundSchema:
+  z.ZodType<
+    QueryConservationDesignationsConservationResponse503ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      QueryConservationDesignationsConservationResponse503Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryConservationDesignationsConservationResponse503ResponseBody(
+        v,
+        { request: v.request$, response: v.response$, body: v.body$ },
+      );
+    });
+
+/** @internal */
+export const QueryConservationDesignationsConservationResponseType$inboundSchema:
+  z.ZodType<
+    QueryConservationDesignationsConservationResponseType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    QueryConservationDesignationsConservationResponseType,
+  );
+
+/** @internal */
+export const QueryConservationDesignationsConservationResponseError$inboundSchema:
+  z.ZodType<
+    QueryConservationDesignationsConservationResponseError,
+    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: QueryConservationDesignationsConservationResponseType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function queryConservationDesignationsConservationResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  QueryConservationDesignationsConservationResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryConservationDesignationsConservationResponseError$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'QueryConservationDesignationsConservationResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryConservationDesignationsConservationResponseResponseBody$inboundSchema:
+  z.ZodType<
+    QueryConservationDesignationsConservationResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      QueryConservationDesignationsConservationResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryConservationDesignationsConservationResponseResponseBody(
+        v,
+        { request: v.request$, response: v.response$, body: v.body$ },
+      );
+    });
+
+/** @internal */
+export const QueryConservationDesignationsConservationType$inboundSchema:
+  z.ZodType<
+    QueryConservationDesignationsConservationType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(QueryConservationDesignationsConservationType);
+
+/** @internal */
+export const QueryConservationDesignationsConservationError$inboundSchema:
+  z.ZodType<
+    QueryConservationDesignationsConservationError,
+    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: QueryConservationDesignationsConservationType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function queryConservationDesignationsConservationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  QueryConservationDesignationsConservationError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryConservationDesignationsConservationError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'QueryConservationDesignationsConservationError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryConservationDesignationsConservationResponseBody$inboundSchema:
+  z.ZodType<
+    QueryConservationDesignationsConservationResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      QueryConservationDesignationsConservationError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryConservationDesignationsConservationResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const QueryConservationDesignationsType$inboundSchema: z.ZodType<
+  QueryConservationDesignationsType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryConservationDesignationsType);
+
+/** @internal */
+export const QueryConservationDesignationsError$inboundSchema: z.ZodType<
+  QueryConservationDesignationsError,
+  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: QueryConservationDesignationsType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryConservationDesignationsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryConservationDesignationsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryConservationDesignationsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryConservationDesignationsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryConservationDesignationsResponseBody$inboundSchema: z.ZodType<
+  QueryConservationDesignationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => QueryConservationDesignationsError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new QueryConservationDesignationsResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });