@vepler/sdk 5.28.1 → 6.1.0

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

@@ -0,0 +1,580 @@
+/*
+ * 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";
+
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export const GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export type GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Type =
+  OpenEnum<
+    typeof GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Type
+  >;
+
+export type GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Error = {
+  /**
+   * Stable code identifying the specific failure, safe to branch on.
+   */
+  code?: string | undefined;
+  /**
+   * Link to the documentation for this error.
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable explanation of what went wrong.
+   */
+  message: string;
+  /**
+   * Name of the request parameter at fault, where the failure can be traced to one.
+   */
+  param?: string | undefined;
+  /**
+   * Alternative values worth retrying when the supplied one could not be matched.
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+   */
+  type: GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Type;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ResponseBodyData =
+  {
+    error: GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Error;
+  };
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ResponseBody
+  extends SDKBaseError
+{
+  error: GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Error;
+
+  /** The original data that was passed to this error instance. */
+  data$:
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ResponseBodyData;
+
+  constructor(
+    err:
+      GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ResponseBodyData,
+    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 =
+      "GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ResponseBody";
+  }
+}
+
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export const GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export type GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseType =
+  OpenEnum<typeof GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseType>;
+
+export type GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseError = {
+  /**
+   * Stable code identifying the specific failure, safe to branch on.
+   */
+  code?: string | undefined;
+  /**
+   * Link to the documentation for this error.
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable explanation of what went wrong.
+   */
+  message: string;
+  /**
+   * Name of the request parameter at fault, where the failure can be traced to one.
+   */
+  param?: string | undefined;
+  /**
+   * Alternative values worth retrying when the supplied one could not be matched.
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+   */
+  type: GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseType;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseResponseBodyData =
+  {
+    error: GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseError;
+  };
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseResponseBody
+  extends SDKBaseError
+{
+  error: GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$:
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseResponseBodyData;
+
+  constructor(
+    err:
+      GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseResponseBodyData,
+    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 =
+      "GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseResponseBody";
+  }
+}
+
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export const GetV1TitleDeedsTitleNumberApplicationsTitleDeedsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export type GetV1TitleDeedsTitleNumberApplicationsTitleDeedsType = OpenEnum<
+  typeof GetV1TitleDeedsTitleNumberApplicationsTitleDeedsType
+>;
+
+export type GetV1TitleDeedsTitleNumberApplicationsTitleDeedsError = {
+  /**
+   * Stable code identifying the specific failure, safe to branch on.
+   */
+  code?: string | undefined;
+  /**
+   * Link to the documentation for this error.
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable explanation of what went wrong.
+   */
+  message: string;
+  /**
+   * Name of the request parameter at fault, where the failure can be traced to one.
+   */
+  param?: string | undefined;
+  /**
+   * Alternative values worth retrying when the supplied one could not be matched.
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+   */
+  type: GetV1TitleDeedsTitleNumberApplicationsTitleDeedsType;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseBodyData = {
+  error: GetV1TitleDeedsTitleNumberApplicationsTitleDeedsError;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseBody
+  extends SDKBaseError
+{
+  error: GetV1TitleDeedsTitleNumberApplicationsTitleDeedsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseBodyData;
+
+  constructor(
+    err: GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseBodyData,
+    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 = "GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseBody";
+  }
+}
+
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export const GetV1TitleDeedsTitleNumberApplicationsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export type GetV1TitleDeedsTitleNumberApplicationsType = OpenEnum<
+  typeof GetV1TitleDeedsTitleNumberApplicationsType
+>;
+
+export type GetV1TitleDeedsTitleNumberApplicationsError = {
+  /**
+   * Stable code identifying the specific failure, safe to branch on.
+   */
+  code?: string | undefined;
+  /**
+   * Link to the documentation for this error.
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable explanation of what went wrong.
+   */
+  message: string;
+  /**
+   * Name of the request parameter at fault, where the failure can be traced to one.
+   */
+  param?: string | undefined;
+  /**
+   * Alternative values worth retrying when the supplied one could not be matched.
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+   */
+  type: GetV1TitleDeedsTitleNumberApplicationsType;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type GetV1TitleDeedsTitleNumberApplicationsResponseBodyData = {
+  error: GetV1TitleDeedsTitleNumberApplicationsError;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class GetV1TitleDeedsTitleNumberApplicationsResponseBody
+  extends SDKBaseError
+{
+  error: GetV1TitleDeedsTitleNumberApplicationsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetV1TitleDeedsTitleNumberApplicationsResponseBodyData;
+
+  constructor(
+    err: GetV1TitleDeedsTitleNumberApplicationsResponseBodyData,
+    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 = "GetV1TitleDeedsTitleNumberApplicationsResponseBody";
+  }
+}
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Type$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Type,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Type,
+  );
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Error$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Error,
+    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:
+      GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Error$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ResponseBody$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponse502ResponseBody(
+        v,
+        { request: v.request$, response: v.response$, body: v.body$ },
+      );
+    });
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseType$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseType,
+  );
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseError$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseError,
+    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:
+      GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseError$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseResponseBody(
+        v,
+        { request: v.request$, response: v.response$, body: v.body$ },
+      );
+    });
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsTitleDeedsType$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsType,
+  );
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsTitleDeedsError$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsError,
+    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: GetV1TitleDeedsTitleNumberApplicationsTitleDeedsType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getV1TitleDeedsTitleNumberApplicationsTitleDeedsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetV1TitleDeedsTitleNumberApplicationsTitleDeedsError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV1TitleDeedsTitleNumberApplicationsTitleDeedsError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetV1TitleDeedsTitleNumberApplicationsTitleDeedsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseBody$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetV1TitleDeedsTitleNumberApplicationsTitleDeedsError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetV1TitleDeedsTitleNumberApplicationsTitleDeedsResponseBody(
+        v,
+        { request: v.request$, response: v.response$, body: v.body$ },
+      );
+    });
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsType$inboundSchema:
+  z.ZodType<GetV1TitleDeedsTitleNumberApplicationsType, z.ZodTypeDef, unknown> =
+    openEnums.inboundSchema(GetV1TitleDeedsTitleNumberApplicationsType);
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsError$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberApplicationsError,
+    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: GetV1TitleDeedsTitleNumberApplicationsType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getV1TitleDeedsTitleNumberApplicationsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetV1TitleDeedsTitleNumberApplicationsError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetV1TitleDeedsTitleNumberApplicationsError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetV1TitleDeedsTitleNumberApplicationsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsResponseBody$inboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberApplicationsResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetV1TitleDeedsTitleNumberApplicationsError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetV1TitleDeedsTitleNumberApplicationsResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });