@vepler/sdk 2.30.4 → 2.37.0

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

@@ -0,0 +1,641 @@
+/*
+ * 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 FindSitesByIdsSitesResponse500Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindSitesByIdsSitesResponse500Type = OpenEnum<
+  typeof FindSitesByIdsSitesResponse500Type
+>;
+
+export type FindSitesByIdsSitesResponse500Error = {
+  /**
+   * 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: FindSitesByIdsSitesResponse500Type;
+};
+
+/**
+ * Error response
+ */
+export type FindSitesByIdsSitesResponse500ResponseBodyData = {
+  error: FindSitesByIdsSitesResponse500Error;
+};
+
+/**
+ * Error response
+ */
+export class FindSitesByIdsSitesResponse500ResponseBody extends SDKBaseError {
+  error: FindSitesByIdsSitesResponse500Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindSitesByIdsSitesResponse500ResponseBodyData;
+
+  constructor(
+    err: FindSitesByIdsSitesResponse500ResponseBodyData,
+    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 = "FindSitesByIdsSitesResponse500ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const FindSitesByIdsSitesResponse429Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindSitesByIdsSitesResponse429Type = OpenEnum<
+  typeof FindSitesByIdsSitesResponse429Type
+>;
+
+export type FindSitesByIdsSitesResponse429Error = {
+  /**
+   * 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: FindSitesByIdsSitesResponse429Type;
+};
+
+/**
+ * Error response
+ */
+export type FindSitesByIdsSitesResponse429ResponseBodyData = {
+  error: FindSitesByIdsSitesResponse429Error;
+};
+
+/**
+ * Error response
+ */
+export class FindSitesByIdsSitesResponse429ResponseBody extends SDKBaseError {
+  error: FindSitesByIdsSitesResponse429Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindSitesByIdsSitesResponse429ResponseBodyData;
+
+  constructor(
+    err: FindSitesByIdsSitesResponse429ResponseBodyData,
+    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 = "FindSitesByIdsSitesResponse429ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const FindSitesByIdsSitesResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindSitesByIdsSitesResponseType = OpenEnum<
+  typeof FindSitesByIdsSitesResponseType
+>;
+
+export type FindSitesByIdsSitesResponseError = {
+  /**
+   * 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: FindSitesByIdsSitesResponseType;
+};
+
+/**
+ * Error response
+ */
+export type FindSitesByIdsSitesResponseResponseBodyData = {
+  error: FindSitesByIdsSitesResponseError;
+};
+
+/**
+ * Error response
+ */
+export class FindSitesByIdsSitesResponseResponseBody extends SDKBaseError {
+  error: FindSitesByIdsSitesResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindSitesByIdsSitesResponseResponseBodyData;
+
+  constructor(
+    err: FindSitesByIdsSitesResponseResponseBodyData,
+    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 = "FindSitesByIdsSitesResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const FindSitesByIdsSitesType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindSitesByIdsSitesType = OpenEnum<typeof FindSitesByIdsSitesType>;
+
+export type FindSitesByIdsSitesError = {
+  /**
+   * 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: FindSitesByIdsSitesType;
+};
+
+/**
+ * Error response
+ */
+export type FindSitesByIdsSitesResponseBodyData = {
+  error: FindSitesByIdsSitesError;
+};
+
+/**
+ * Error response
+ */
+export class FindSitesByIdsSitesResponseBody extends SDKBaseError {
+  error: FindSitesByIdsSitesError;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindSitesByIdsSitesResponseBodyData;
+
+  constructor(
+    err: FindSitesByIdsSitesResponseBodyData,
+    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 = "FindSitesByIdsSitesResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const FindSitesByIdsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindSitesByIdsType = OpenEnum<typeof FindSitesByIdsType>;
+
+export type FindSitesByIdsError = {
+  /**
+   * 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: FindSitesByIdsType;
+};
+
+/**
+ * Error response
+ */
+export type FindSitesByIdsResponseBodyData = {
+  error: FindSitesByIdsError;
+};
+
+/**
+ * Error response
+ */
+export class FindSitesByIdsResponseBody extends SDKBaseError {
+  error: FindSitesByIdsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindSitesByIdsResponseBodyData;
+
+  constructor(
+    err: FindSitesByIdsResponseBodyData,
+    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 = "FindSitesByIdsResponseBody";
+  }
+}
+
+/** @internal */
+export const FindSitesByIdsSitesResponse500Type$inboundSchema: z.ZodType<
+  FindSitesByIdsSitesResponse500Type,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FindSitesByIdsSitesResponse500Type);
+
+/** @internal */
+export const FindSitesByIdsSitesResponse500Error$inboundSchema: z.ZodType<
+  FindSitesByIdsSitesResponse500Error,
+  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: FindSitesByIdsSitesResponse500Type$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function findSitesByIdsSitesResponse500ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<FindSitesByIdsSitesResponse500Error, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      FindSitesByIdsSitesResponse500Error$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindSitesByIdsSitesResponse500Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindSitesByIdsSitesResponse500ResponseBody$inboundSchema:
+  z.ZodType<FindSitesByIdsSitesResponse500ResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      error: z.lazy(() => FindSitesByIdsSitesResponse500Error$inboundSchema),
+      request$: z.instanceof(Request),
+      response$: z.instanceof(Response),
+      body$: z.string(),
+    })
+      .transform((v) => {
+        return new FindSitesByIdsSitesResponse500ResponseBody(v, {
+          request: v.request$,
+          response: v.response$,
+          body: v.body$,
+        });
+      });
+
+/** @internal */
+export const FindSitesByIdsSitesResponse429Type$inboundSchema: z.ZodType<
+  FindSitesByIdsSitesResponse429Type,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FindSitesByIdsSitesResponse429Type);
+
+/** @internal */
+export const FindSitesByIdsSitesResponse429Error$inboundSchema: z.ZodType<
+  FindSitesByIdsSitesResponse429Error,
+  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: FindSitesByIdsSitesResponse429Type$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function findSitesByIdsSitesResponse429ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<FindSitesByIdsSitesResponse429Error, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      FindSitesByIdsSitesResponse429Error$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindSitesByIdsSitesResponse429Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindSitesByIdsSitesResponse429ResponseBody$inboundSchema:
+  z.ZodType<FindSitesByIdsSitesResponse429ResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      error: z.lazy(() => FindSitesByIdsSitesResponse429Error$inboundSchema),
+      request$: z.instanceof(Request),
+      response$: z.instanceof(Response),
+      body$: z.string(),
+    })
+      .transform((v) => {
+        return new FindSitesByIdsSitesResponse429ResponseBody(v, {
+          request: v.request$,
+          response: v.response$,
+          body: v.body$,
+        });
+      });
+
+/** @internal */
+export const FindSitesByIdsSitesResponseType$inboundSchema: z.ZodType<
+  FindSitesByIdsSitesResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FindSitesByIdsSitesResponseType);
+
+/** @internal */
+export const FindSitesByIdsSitesResponseError$inboundSchema: z.ZodType<
+  FindSitesByIdsSitesResponseError,
+  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: FindSitesByIdsSitesResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function findSitesByIdsSitesResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<FindSitesByIdsSitesResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FindSitesByIdsSitesResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindSitesByIdsSitesResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindSitesByIdsSitesResponseResponseBody$inboundSchema: z.ZodType<
+  FindSitesByIdsSitesResponseResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => FindSitesByIdsSitesResponseError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new FindSitesByIdsSitesResponseResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const FindSitesByIdsSitesType$inboundSchema: z.ZodType<
+  FindSitesByIdsSitesType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FindSitesByIdsSitesType);
+
+/** @internal */
+export const FindSitesByIdsSitesError$inboundSchema: z.ZodType<
+  FindSitesByIdsSitesError,
+  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: FindSitesByIdsSitesType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function findSitesByIdsSitesErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<FindSitesByIdsSitesError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FindSitesByIdsSitesError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindSitesByIdsSitesError' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindSitesByIdsSitesResponseBody$inboundSchema: z.ZodType<
+  FindSitesByIdsSitesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => FindSitesByIdsSitesError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new FindSitesByIdsSitesResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const FindSitesByIdsType$inboundSchema: z.ZodType<
+  FindSitesByIdsType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FindSitesByIdsType);
+
+/** @internal */
+export const FindSitesByIdsError$inboundSchema: z.ZodType<
+  FindSitesByIdsError,
+  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: FindSitesByIdsType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function findSitesByIdsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<FindSitesByIdsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FindSitesByIdsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindSitesByIdsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindSitesByIdsResponseBody$inboundSchema: z.ZodType<
+  FindSitesByIdsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => FindSitesByIdsError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new FindSitesByIdsResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });