@vepler/sdk 2.33.0 → 2.38.2

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

@@ -0,0 +1,529 @@
+/*
+ * 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 FindSitesByPropertySitesResponse500Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindSitesByPropertySitesResponse500Type = OpenEnum<
+  typeof FindSitesByPropertySitesResponse500Type
+>;
+
+export type FindSitesByPropertySitesResponse500Error = {
+  /**
+   * 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: FindSitesByPropertySitesResponse500Type;
+};
+
+/**
+ * Error response
+ */
+export type FindSitesByPropertySitesResponse500ResponseBodyData = {
+  error: FindSitesByPropertySitesResponse500Error;
+};
+
+/**
+ * Error response
+ */
+export class FindSitesByPropertySitesResponse500ResponseBody
+  extends SDKBaseError
+{
+  error: FindSitesByPropertySitesResponse500Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindSitesByPropertySitesResponse500ResponseBodyData;
+
+  constructor(
+    err: FindSitesByPropertySitesResponse500ResponseBodyData,
+    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 = "FindSitesByPropertySitesResponse500ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const FindSitesByPropertySitesResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindSitesByPropertySitesResponseType = OpenEnum<
+  typeof FindSitesByPropertySitesResponseType
+>;
+
+export type FindSitesByPropertySitesResponseError = {
+  /**
+   * 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: FindSitesByPropertySitesResponseType;
+};
+
+/**
+ * Error response
+ */
+export type FindSitesByPropertySitesResponseResponseBodyData = {
+  error: FindSitesByPropertySitesResponseError;
+};
+
+/**
+ * Error response
+ */
+export class FindSitesByPropertySitesResponseResponseBody extends SDKBaseError {
+  error: FindSitesByPropertySitesResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindSitesByPropertySitesResponseResponseBodyData;
+
+  constructor(
+    err: FindSitesByPropertySitesResponseResponseBodyData,
+    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 = "FindSitesByPropertySitesResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const FindSitesByPropertySitesType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindSitesByPropertySitesType = OpenEnum<
+  typeof FindSitesByPropertySitesType
+>;
+
+export type FindSitesByPropertySitesError = {
+  /**
+   * 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: FindSitesByPropertySitesType;
+};
+
+/**
+ * Error response
+ */
+export type FindSitesByPropertySitesResponseBodyData = {
+  error: FindSitesByPropertySitesError;
+};
+
+/**
+ * Error response
+ */
+export class FindSitesByPropertySitesResponseBody extends SDKBaseError {
+  error: FindSitesByPropertySitesError;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindSitesByPropertySitesResponseBodyData;
+
+  constructor(
+    err: FindSitesByPropertySitesResponseBodyData,
+    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 = "FindSitesByPropertySitesResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const FindSitesByPropertyType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindSitesByPropertyType = OpenEnum<typeof FindSitesByPropertyType>;
+
+export type FindSitesByPropertyError = {
+  /**
+   * 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: FindSitesByPropertyType;
+};
+
+/**
+ * Error response
+ */
+export type FindSitesByPropertyResponseBodyData = {
+  error: FindSitesByPropertyError;
+};
+
+/**
+ * Error response
+ */
+export class FindSitesByPropertyResponseBody extends SDKBaseError {
+  error: FindSitesByPropertyError;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindSitesByPropertyResponseBodyData;
+
+  constructor(
+    err: FindSitesByPropertyResponseBodyData,
+    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 = "FindSitesByPropertyResponseBody";
+  }
+}
+
+/** @internal */
+export const FindSitesByPropertySitesResponse500Type$inboundSchema: z.ZodType<
+  FindSitesByPropertySitesResponse500Type,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FindSitesByPropertySitesResponse500Type);
+
+/** @internal */
+export const FindSitesByPropertySitesResponse500Error$inboundSchema: z.ZodType<
+  FindSitesByPropertySitesResponse500Error,
+  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: FindSitesByPropertySitesResponse500Type$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function findSitesByPropertySitesResponse500ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  FindSitesByPropertySitesResponse500Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      FindSitesByPropertySitesResponse500Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'FindSitesByPropertySitesResponse500Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindSitesByPropertySitesResponse500ResponseBody$inboundSchema:
+  z.ZodType<
+    FindSitesByPropertySitesResponse500ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => FindSitesByPropertySitesResponse500Error$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new FindSitesByPropertySitesResponse500ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const FindSitesByPropertySitesResponseType$inboundSchema: z.ZodType<
+  FindSitesByPropertySitesResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FindSitesByPropertySitesResponseType);
+
+/** @internal */
+export const FindSitesByPropertySitesResponseError$inboundSchema: z.ZodType<
+  FindSitesByPropertySitesResponseError,
+  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: FindSitesByPropertySitesResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function findSitesByPropertySitesResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<FindSitesByPropertySitesResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      FindSitesByPropertySitesResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindSitesByPropertySitesResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindSitesByPropertySitesResponseResponseBody$inboundSchema:
+  z.ZodType<
+    FindSitesByPropertySitesResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => FindSitesByPropertySitesResponseError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new FindSitesByPropertySitesResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const FindSitesByPropertySitesType$inboundSchema: z.ZodType<
+  FindSitesByPropertySitesType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FindSitesByPropertySitesType);
+
+/** @internal */
+export const FindSitesByPropertySitesError$inboundSchema: z.ZodType<
+  FindSitesByPropertySitesError,
+  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: FindSitesByPropertySitesType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function findSitesByPropertySitesErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<FindSitesByPropertySitesError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FindSitesByPropertySitesError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindSitesByPropertySitesError' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindSitesByPropertySitesResponseBody$inboundSchema: z.ZodType<
+  FindSitesByPropertySitesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => FindSitesByPropertySitesError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new FindSitesByPropertySitesResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const FindSitesByPropertyType$inboundSchema: z.ZodType<
+  FindSitesByPropertyType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FindSitesByPropertyType);
+
+/** @internal */
+export const FindSitesByPropertyError$inboundSchema: z.ZodType<
+  FindSitesByPropertyError,
+  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: FindSitesByPropertyType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function findSitesByPropertyErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<FindSitesByPropertyError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FindSitesByPropertyError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindSitesByPropertyError' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindSitesByPropertyResponseBody$inboundSchema: z.ZodType<
+  FindSitesByPropertyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => FindSitesByPropertyError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new FindSitesByPropertyResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });