@vepler/sdk 2.42.0 → 2.46.0

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

@@ -0,0 +1,684 @@
+/*
+ * 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 FindNearestSubstationsEnergyResponse503Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindNearestSubstationsEnergyResponse503Type = OpenEnum<
+  typeof FindNearestSubstationsEnergyResponse503Type
+>;
+
+export type FindNearestSubstationsEnergyResponse503Error = {
+  /**
+   * 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: FindNearestSubstationsEnergyResponse503Type;
+};
+
+/**
+ * Error response
+ */
+export type FindNearestSubstationsEnergyResponse503ResponseBodyData = {
+  error: FindNearestSubstationsEnergyResponse503Error;
+};
+
+/**
+ * Error response
+ */
+export class FindNearestSubstationsEnergyResponse503ResponseBody
+  extends SDKBaseError
+{
+  error: FindNearestSubstationsEnergyResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindNearestSubstationsEnergyResponse503ResponseBodyData;
+
+  constructor(
+    err: FindNearestSubstationsEnergyResponse503ResponseBodyData,
+    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 = "FindNearestSubstationsEnergyResponse503ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const FindNearestSubstationsEnergyResponse500Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindNearestSubstationsEnergyResponse500Type = OpenEnum<
+  typeof FindNearestSubstationsEnergyResponse500Type
+>;
+
+export type FindNearestSubstationsEnergyResponse500Error = {
+  /**
+   * 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: FindNearestSubstationsEnergyResponse500Type;
+};
+
+/**
+ * Error response
+ */
+export type FindNearestSubstationsEnergyResponse500ResponseBodyData = {
+  error: FindNearestSubstationsEnergyResponse500Error;
+};
+
+/**
+ * Error response
+ */
+export class FindNearestSubstationsEnergyResponse500ResponseBody
+  extends SDKBaseError
+{
+  error: FindNearestSubstationsEnergyResponse500Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindNearestSubstationsEnergyResponse500ResponseBodyData;
+
+  constructor(
+    err: FindNearestSubstationsEnergyResponse500ResponseBodyData,
+    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 = "FindNearestSubstationsEnergyResponse500ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const FindNearestSubstationsEnergyResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindNearestSubstationsEnergyResponseType = OpenEnum<
+  typeof FindNearestSubstationsEnergyResponseType
+>;
+
+export type FindNearestSubstationsEnergyResponseError = {
+  /**
+   * 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: FindNearestSubstationsEnergyResponseType;
+};
+
+/**
+ * Error response
+ */
+export type FindNearestSubstationsEnergyResponseResponseBodyData = {
+  error: FindNearestSubstationsEnergyResponseError;
+};
+
+/**
+ * Error response
+ */
+export class FindNearestSubstationsEnergyResponseResponseBody
+  extends SDKBaseError
+{
+  error: FindNearestSubstationsEnergyResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindNearestSubstationsEnergyResponseResponseBodyData;
+
+  constructor(
+    err: FindNearestSubstationsEnergyResponseResponseBodyData,
+    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 = "FindNearestSubstationsEnergyResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const FindNearestSubstationsEnergyType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindNearestSubstationsEnergyType = OpenEnum<
+  typeof FindNearestSubstationsEnergyType
+>;
+
+export type FindNearestSubstationsEnergyError = {
+  /**
+   * 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: FindNearestSubstationsEnergyType;
+};
+
+/**
+ * Error response
+ */
+export type FindNearestSubstationsEnergyResponseBodyData = {
+  error: FindNearestSubstationsEnergyError;
+};
+
+/**
+ * Error response
+ */
+export class FindNearestSubstationsEnergyResponseBody extends SDKBaseError {
+  error: FindNearestSubstationsEnergyError;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindNearestSubstationsEnergyResponseBodyData;
+
+  constructor(
+    err: FindNearestSubstationsEnergyResponseBodyData,
+    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 = "FindNearestSubstationsEnergyResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const FindNearestSubstationsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type FindNearestSubstationsType = OpenEnum<
+  typeof FindNearestSubstationsType
+>;
+
+export type FindNearestSubstationsError = {
+  /**
+   * 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: FindNearestSubstationsType;
+};
+
+/**
+ * Error response
+ */
+export type FindNearestSubstationsResponseBodyData = {
+  error: FindNearestSubstationsError;
+};
+
+/**
+ * Error response
+ */
+export class FindNearestSubstationsResponseBody extends SDKBaseError {
+  error: FindNearestSubstationsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: FindNearestSubstationsResponseBodyData;
+
+  constructor(
+    err: FindNearestSubstationsResponseBodyData,
+    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 = "FindNearestSubstationsResponseBody";
+  }
+}
+
+/** @internal */
+export const FindNearestSubstationsEnergyResponse503Type$inboundSchema:
+  z.ZodType<
+    FindNearestSubstationsEnergyResponse503Type,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(FindNearestSubstationsEnergyResponse503Type);
+
+/** @internal */
+export const FindNearestSubstationsEnergyResponse503Error$inboundSchema:
+  z.ZodType<
+    FindNearestSubstationsEnergyResponse503Error,
+    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: FindNearestSubstationsEnergyResponse503Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function findNearestSubstationsEnergyResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  FindNearestSubstationsEnergyResponse503Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      FindNearestSubstationsEnergyResponse503Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'FindNearestSubstationsEnergyResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindNearestSubstationsEnergyResponse503ResponseBody$inboundSchema:
+  z.ZodType<
+    FindNearestSubstationsEnergyResponse503ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      FindNearestSubstationsEnergyResponse503Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new FindNearestSubstationsEnergyResponse503ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const FindNearestSubstationsEnergyResponse500Type$inboundSchema:
+  z.ZodType<
+    FindNearestSubstationsEnergyResponse500Type,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(FindNearestSubstationsEnergyResponse500Type);
+
+/** @internal */
+export const FindNearestSubstationsEnergyResponse500Error$inboundSchema:
+  z.ZodType<
+    FindNearestSubstationsEnergyResponse500Error,
+    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: FindNearestSubstationsEnergyResponse500Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function findNearestSubstationsEnergyResponse500ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  FindNearestSubstationsEnergyResponse500Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      FindNearestSubstationsEnergyResponse500Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'FindNearestSubstationsEnergyResponse500Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindNearestSubstationsEnergyResponse500ResponseBody$inboundSchema:
+  z.ZodType<
+    FindNearestSubstationsEnergyResponse500ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      FindNearestSubstationsEnergyResponse500Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new FindNearestSubstationsEnergyResponse500ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const FindNearestSubstationsEnergyResponseType$inboundSchema: z.ZodType<
+  FindNearestSubstationsEnergyResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FindNearestSubstationsEnergyResponseType);
+
+/** @internal */
+export const FindNearestSubstationsEnergyResponseError$inboundSchema: z.ZodType<
+  FindNearestSubstationsEnergyResponseError,
+  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: FindNearestSubstationsEnergyResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function findNearestSubstationsEnergyResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  FindNearestSubstationsEnergyResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      FindNearestSubstationsEnergyResponseError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'FindNearestSubstationsEnergyResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindNearestSubstationsEnergyResponseResponseBody$inboundSchema:
+  z.ZodType<
+    FindNearestSubstationsEnergyResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      FindNearestSubstationsEnergyResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new FindNearestSubstationsEnergyResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const FindNearestSubstationsEnergyType$inboundSchema: z.ZodType<
+  FindNearestSubstationsEnergyType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FindNearestSubstationsEnergyType);
+
+/** @internal */
+export const FindNearestSubstationsEnergyError$inboundSchema: z.ZodType<
+  FindNearestSubstationsEnergyError,
+  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: FindNearestSubstationsEnergyType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function findNearestSubstationsEnergyErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<FindNearestSubstationsEnergyError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FindNearestSubstationsEnergyError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindNearestSubstationsEnergyError' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindNearestSubstationsEnergyResponseBody$inboundSchema: z.ZodType<
+  FindNearestSubstationsEnergyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => FindNearestSubstationsEnergyError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new FindNearestSubstationsEnergyResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const FindNearestSubstationsType$inboundSchema: z.ZodType<
+  FindNearestSubstationsType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FindNearestSubstationsType);
+
+/** @internal */
+export const FindNearestSubstationsError$inboundSchema: z.ZodType<
+  FindNearestSubstationsError,
+  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: FindNearestSubstationsType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function findNearestSubstationsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<FindNearestSubstationsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FindNearestSubstationsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindNearestSubstationsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindNearestSubstationsResponseBody$inboundSchema: z.ZodType<
+  FindNearestSubstationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => FindNearestSubstationsError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new FindNearestSubstationsResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });