@vepler/sdk 2.158.0 → 2.167.0

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

@@ -0,0 +1,550 @@
+/*
+ * 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 QueryHeritageDesignationsHeritageResponse503Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryHeritageDesignationsHeritageResponse503Type = OpenEnum<
+  typeof QueryHeritageDesignationsHeritageResponse503Type
+>;
+
+export type QueryHeritageDesignationsHeritageResponse503Error = {
+  /**
+   * 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: QueryHeritageDesignationsHeritageResponse503Type;
+};
+
+/**
+ * Error response
+ */
+export type QueryHeritageDesignationsHeritageResponse503ResponseBodyData = {
+  error: QueryHeritageDesignationsHeritageResponse503Error;
+};
+
+/**
+ * Error response
+ */
+export class QueryHeritageDesignationsHeritageResponse503ResponseBody
+  extends SDKBaseError
+{
+  error: QueryHeritageDesignationsHeritageResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryHeritageDesignationsHeritageResponse503ResponseBodyData;
+
+  constructor(
+    err: QueryHeritageDesignationsHeritageResponse503ResponseBodyData,
+    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 = "QueryHeritageDesignationsHeritageResponse503ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryHeritageDesignationsHeritageResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryHeritageDesignationsHeritageResponseType = OpenEnum<
+  typeof QueryHeritageDesignationsHeritageResponseType
+>;
+
+export type QueryHeritageDesignationsHeritageResponseError = {
+  /**
+   * 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: QueryHeritageDesignationsHeritageResponseType;
+};
+
+/**
+ * Error response
+ */
+export type QueryHeritageDesignationsHeritageResponseResponseBodyData = {
+  error: QueryHeritageDesignationsHeritageResponseError;
+};
+
+/**
+ * Error response
+ */
+export class QueryHeritageDesignationsHeritageResponseResponseBody
+  extends SDKBaseError
+{
+  error: QueryHeritageDesignationsHeritageResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryHeritageDesignationsHeritageResponseResponseBodyData;
+
+  constructor(
+    err: QueryHeritageDesignationsHeritageResponseResponseBodyData,
+    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 = "QueryHeritageDesignationsHeritageResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryHeritageDesignationsHeritageType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryHeritageDesignationsHeritageType = OpenEnum<
+  typeof QueryHeritageDesignationsHeritageType
+>;
+
+export type QueryHeritageDesignationsHeritageError = {
+  /**
+   * 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: QueryHeritageDesignationsHeritageType;
+};
+
+/**
+ * Error response
+ */
+export type QueryHeritageDesignationsHeritageResponseBodyData = {
+  error: QueryHeritageDesignationsHeritageError;
+};
+
+/**
+ * Error response
+ */
+export class QueryHeritageDesignationsHeritageResponseBody
+  extends SDKBaseError
+{
+  error: QueryHeritageDesignationsHeritageError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryHeritageDesignationsHeritageResponseBodyData;
+
+  constructor(
+    err: QueryHeritageDesignationsHeritageResponseBodyData,
+    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 = "QueryHeritageDesignationsHeritageResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryHeritageDesignationsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryHeritageDesignationsType = OpenEnum<
+  typeof QueryHeritageDesignationsType
+>;
+
+export type QueryHeritageDesignationsError = {
+  /**
+   * 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: QueryHeritageDesignationsType;
+};
+
+/**
+ * Error response
+ */
+export type QueryHeritageDesignationsResponseBodyData = {
+  error: QueryHeritageDesignationsError;
+};
+
+/**
+ * Error response
+ */
+export class QueryHeritageDesignationsResponseBody extends SDKBaseError {
+  error: QueryHeritageDesignationsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryHeritageDesignationsResponseBodyData;
+
+  constructor(
+    err: QueryHeritageDesignationsResponseBodyData,
+    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 = "QueryHeritageDesignationsResponseBody";
+  }
+}
+
+/** @internal */
+export const QueryHeritageDesignationsHeritageResponse503Type$inboundSchema:
+  z.ZodType<
+    QueryHeritageDesignationsHeritageResponse503Type,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(QueryHeritageDesignationsHeritageResponse503Type);
+
+/** @internal */
+export const QueryHeritageDesignationsHeritageResponse503Error$inboundSchema:
+  z.ZodType<
+    QueryHeritageDesignationsHeritageResponse503Error,
+    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: QueryHeritageDesignationsHeritageResponse503Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function queryHeritageDesignationsHeritageResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  QueryHeritageDesignationsHeritageResponse503Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryHeritageDesignationsHeritageResponse503Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'QueryHeritageDesignationsHeritageResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryHeritageDesignationsHeritageResponse503ResponseBody$inboundSchema:
+  z.ZodType<
+    QueryHeritageDesignationsHeritageResponse503ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      QueryHeritageDesignationsHeritageResponse503Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryHeritageDesignationsHeritageResponse503ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const QueryHeritageDesignationsHeritageResponseType$inboundSchema:
+  z.ZodType<
+    QueryHeritageDesignationsHeritageResponseType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(QueryHeritageDesignationsHeritageResponseType);
+
+/** @internal */
+export const QueryHeritageDesignationsHeritageResponseError$inboundSchema:
+  z.ZodType<
+    QueryHeritageDesignationsHeritageResponseError,
+    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: QueryHeritageDesignationsHeritageResponseType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function queryHeritageDesignationsHeritageResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  QueryHeritageDesignationsHeritageResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryHeritageDesignationsHeritageResponseError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'QueryHeritageDesignationsHeritageResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryHeritageDesignationsHeritageResponseResponseBody$inboundSchema:
+  z.ZodType<
+    QueryHeritageDesignationsHeritageResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      QueryHeritageDesignationsHeritageResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryHeritageDesignationsHeritageResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const QueryHeritageDesignationsHeritageType$inboundSchema: z.ZodType<
+  QueryHeritageDesignationsHeritageType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryHeritageDesignationsHeritageType);
+
+/** @internal */
+export const QueryHeritageDesignationsHeritageError$inboundSchema: z.ZodType<
+  QueryHeritageDesignationsHeritageError,
+  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: QueryHeritageDesignationsHeritageType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryHeritageDesignationsHeritageErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryHeritageDesignationsHeritageError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryHeritageDesignationsHeritageError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryHeritageDesignationsHeritageError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryHeritageDesignationsHeritageResponseBody$inboundSchema:
+  z.ZodType<
+    QueryHeritageDesignationsHeritageResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => QueryHeritageDesignationsHeritageError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryHeritageDesignationsHeritageResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const QueryHeritageDesignationsType$inboundSchema: z.ZodType<
+  QueryHeritageDesignationsType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryHeritageDesignationsType);
+
+/** @internal */
+export const QueryHeritageDesignationsError$inboundSchema: z.ZodType<
+  QueryHeritageDesignationsError,
+  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: QueryHeritageDesignationsType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryHeritageDesignationsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryHeritageDesignationsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QueryHeritageDesignationsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryHeritageDesignationsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryHeritageDesignationsResponseBody$inboundSchema: z.ZodType<
+  QueryHeritageDesignationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => QueryHeritageDesignationsError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new QueryHeritageDesignationsResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });