@vepler/sdk 2.38.2 → 2.42.0

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

@@ -0,0 +1,576 @@
+/*
+ * 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 GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Type =
+  OpenEnum<typeof GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Type>;
+
+export type GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Error = {
+  /**
+   * 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: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Type;
+};
+
+/**
+ * Error response
+ */
+export type GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ResponseBodyData =
+  {
+    error: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Error;
+  };
+
+/**
+ * Error response
+ */
+export class GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ResponseBody
+  extends SDKBaseError
+{
+  error: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Error;
+
+  /** The original data that was passed to this error instance. */
+  data$:
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ResponseBodyData;
+
+  constructor(
+    err:
+      GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ResponseBodyData,
+    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 =
+      "GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseType =
+  OpenEnum<typeof GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseType>;
+
+export type GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseError = {
+  /**
+   * 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: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseResponseBodyData =
+  {
+    error: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseError;
+  };
+
+/**
+ * Error response
+ */
+export class GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseResponseBody
+  extends SDKBaseError
+{
+  error: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseResponseBodyData;
+
+  constructor(
+    err: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseResponseBodyData,
+    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 =
+      "GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetV1TitleDeedsTitleNumberDocumentsTitleDeedsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetV1TitleDeedsTitleNumberDocumentsTitleDeedsType = OpenEnum<
+  typeof GetV1TitleDeedsTitleNumberDocumentsTitleDeedsType
+>;
+
+export type GetV1TitleDeedsTitleNumberDocumentsTitleDeedsError = {
+  /**
+   * 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: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsType;
+};
+
+/**
+ * Error response
+ */
+export type GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseBodyData = {
+  error: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsError;
+};
+
+/**
+ * Error response
+ */
+export class GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseBody
+  extends SDKBaseError
+{
+  error: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseBodyData;
+
+  constructor(
+    err: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseBodyData,
+    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 = "GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetV1TitleDeedsTitleNumberDocumentsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetV1TitleDeedsTitleNumberDocumentsType = OpenEnum<
+  typeof GetV1TitleDeedsTitleNumberDocumentsType
+>;
+
+export type GetV1TitleDeedsTitleNumberDocumentsError = {
+  /**
+   * 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: GetV1TitleDeedsTitleNumberDocumentsType;
+};
+
+/**
+ * Error response
+ */
+export type GetV1TitleDeedsTitleNumberDocumentsResponseBodyData = {
+  error: GetV1TitleDeedsTitleNumberDocumentsError;
+};
+
+/**
+ * Error response
+ */
+export class GetV1TitleDeedsTitleNumberDocumentsResponseBody
+  extends SDKBaseError
+{
+  error: GetV1TitleDeedsTitleNumberDocumentsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetV1TitleDeedsTitleNumberDocumentsResponseBodyData;
+
+  constructor(
+    err: GetV1TitleDeedsTitleNumberDocumentsResponseBodyData,
+    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 = "GetV1TitleDeedsTitleNumberDocumentsResponseBody";
+  }
+}
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Type$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Type,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Type,
+  );
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Error$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Error,
+    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:
+      GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Error$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ResponseBody$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponse500ResponseBody(
+        v,
+        { request: v.request$, response: v.response$, body: v.body$ },
+      );
+    });
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseType$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseType,
+  );
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseError$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseError,
+    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:
+      GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseError$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseResponseBody(
+        v,
+        { request: v.request$, response: v.response$, body: v.body$ },
+      );
+    });
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsTitleDeedsType$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsType,
+  );
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsTitleDeedsError$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsError,
+    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: GetV1TitleDeedsTitleNumberDocumentsTitleDeedsType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getV1TitleDeedsTitleNumberDocumentsTitleDeedsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetV1TitleDeedsTitleNumberDocumentsTitleDeedsError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV1TitleDeedsTitleNumberDocumentsTitleDeedsError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetV1TitleDeedsTitleNumberDocumentsTitleDeedsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseBody$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetV1TitleDeedsTitleNumberDocumentsTitleDeedsError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetV1TitleDeedsTitleNumberDocumentsTitleDeedsResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsType$inboundSchema: z.ZodType<
+  GetV1TitleDeedsTitleNumberDocumentsType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetV1TitleDeedsTitleNumberDocumentsType);
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsError$inboundSchema: z.ZodType<
+  GetV1TitleDeedsTitleNumberDocumentsError,
+  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: GetV1TitleDeedsTitleNumberDocumentsType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getV1TitleDeedsTitleNumberDocumentsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetV1TitleDeedsTitleNumberDocumentsError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV1TitleDeedsTitleNumberDocumentsError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetV1TitleDeedsTitleNumberDocumentsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberDocumentsResponseBody$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberDocumentsResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => GetV1TitleDeedsTitleNumberDocumentsError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetV1TitleDeedsTitleNumberDocumentsResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });