@vepler/sdk 2.42.0 → 2.46.0

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

@@ -0,0 +1,539 @@
+/*
+ * 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 GetSubstationCapacityEnergyResponse500Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetSubstationCapacityEnergyResponse500Type = OpenEnum<
+  typeof GetSubstationCapacityEnergyResponse500Type
+>;
+
+export type GetSubstationCapacityEnergyResponse500Error = {
+  /**
+   * 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: GetSubstationCapacityEnergyResponse500Type;
+};
+
+/**
+ * Error response
+ */
+export type GetSubstationCapacityEnergyResponse500ResponseBodyData = {
+  error: GetSubstationCapacityEnergyResponse500Error;
+};
+
+/**
+ * Error response
+ */
+export class GetSubstationCapacityEnergyResponse500ResponseBody
+  extends SDKBaseError
+{
+  error: GetSubstationCapacityEnergyResponse500Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetSubstationCapacityEnergyResponse500ResponseBodyData;
+
+  constructor(
+    err: GetSubstationCapacityEnergyResponse500ResponseBodyData,
+    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 = "GetSubstationCapacityEnergyResponse500ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetSubstationCapacityEnergyResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetSubstationCapacityEnergyResponseType = OpenEnum<
+  typeof GetSubstationCapacityEnergyResponseType
+>;
+
+export type GetSubstationCapacityEnergyResponseError = {
+  /**
+   * 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: GetSubstationCapacityEnergyResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetSubstationCapacityEnergyResponseResponseBodyData = {
+  error: GetSubstationCapacityEnergyResponseError;
+};
+
+/**
+ * Error response
+ */
+export class GetSubstationCapacityEnergyResponseResponseBody
+  extends SDKBaseError
+{
+  error: GetSubstationCapacityEnergyResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetSubstationCapacityEnergyResponseResponseBodyData;
+
+  constructor(
+    err: GetSubstationCapacityEnergyResponseResponseBodyData,
+    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 = "GetSubstationCapacityEnergyResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetSubstationCapacityEnergyType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetSubstationCapacityEnergyType = OpenEnum<
+  typeof GetSubstationCapacityEnergyType
+>;
+
+export type GetSubstationCapacityEnergyError = {
+  /**
+   * 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: GetSubstationCapacityEnergyType;
+};
+
+/**
+ * Error response
+ */
+export type GetSubstationCapacityEnergyResponseBodyData = {
+  error: GetSubstationCapacityEnergyError;
+};
+
+/**
+ * Error response
+ */
+export class GetSubstationCapacityEnergyResponseBody extends SDKBaseError {
+  error: GetSubstationCapacityEnergyError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetSubstationCapacityEnergyResponseBodyData;
+
+  constructor(
+    err: GetSubstationCapacityEnergyResponseBodyData,
+    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 = "GetSubstationCapacityEnergyResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetSubstationCapacityType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetSubstationCapacityType = OpenEnum<
+  typeof GetSubstationCapacityType
+>;
+
+export type GetSubstationCapacityError = {
+  /**
+   * 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: GetSubstationCapacityType;
+};
+
+/**
+ * Error response
+ */
+export type GetSubstationCapacityResponseBodyData = {
+  error: GetSubstationCapacityError;
+};
+
+/**
+ * Error response
+ */
+export class GetSubstationCapacityResponseBody extends SDKBaseError {
+  error: GetSubstationCapacityError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetSubstationCapacityResponseBodyData;
+
+  constructor(
+    err: GetSubstationCapacityResponseBodyData,
+    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 = "GetSubstationCapacityResponseBody";
+  }
+}
+
+/** @internal */
+export const GetSubstationCapacityEnergyResponse500Type$inboundSchema:
+  z.ZodType<GetSubstationCapacityEnergyResponse500Type, z.ZodTypeDef, unknown> =
+    openEnums.inboundSchema(GetSubstationCapacityEnergyResponse500Type);
+
+/** @internal */
+export const GetSubstationCapacityEnergyResponse500Error$inboundSchema:
+  z.ZodType<
+    GetSubstationCapacityEnergyResponse500Error,
+    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: GetSubstationCapacityEnergyResponse500Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getSubstationCapacityEnergyResponse500ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetSubstationCapacityEnergyResponse500Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSubstationCapacityEnergyResponse500Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetSubstationCapacityEnergyResponse500Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationCapacityEnergyResponse500ResponseBody$inboundSchema:
+  z.ZodType<
+    GetSubstationCapacityEnergyResponse500ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetSubstationCapacityEnergyResponse500Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetSubstationCapacityEnergyResponse500ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetSubstationCapacityEnergyResponseType$inboundSchema: z.ZodType<
+  GetSubstationCapacityEnergyResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetSubstationCapacityEnergyResponseType);
+
+/** @internal */
+export const GetSubstationCapacityEnergyResponseError$inboundSchema: z.ZodType<
+  GetSubstationCapacityEnergyResponseError,
+  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: GetSubstationCapacityEnergyResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getSubstationCapacityEnergyResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetSubstationCapacityEnergyResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSubstationCapacityEnergyResponseError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetSubstationCapacityEnergyResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationCapacityEnergyResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetSubstationCapacityEnergyResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => GetSubstationCapacityEnergyResponseError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetSubstationCapacityEnergyResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetSubstationCapacityEnergyType$inboundSchema: z.ZodType<
+  GetSubstationCapacityEnergyType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetSubstationCapacityEnergyType);
+
+/** @internal */
+export const GetSubstationCapacityEnergyError$inboundSchema: z.ZodType<
+  GetSubstationCapacityEnergyError,
+  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: GetSubstationCapacityEnergyType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getSubstationCapacityEnergyErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationCapacityEnergyError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubstationCapacityEnergyError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationCapacityEnergyError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationCapacityEnergyResponseBody$inboundSchema: z.ZodType<
+  GetSubstationCapacityEnergyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetSubstationCapacityEnergyError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetSubstationCapacityEnergyResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetSubstationCapacityType$inboundSchema: z.ZodType<
+  GetSubstationCapacityType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetSubstationCapacityType);
+
+/** @internal */
+export const GetSubstationCapacityError$inboundSchema: z.ZodType<
+  GetSubstationCapacityError,
+  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: GetSubstationCapacityType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getSubstationCapacityErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationCapacityError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubstationCapacityError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationCapacityError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationCapacityResponseBody$inboundSchema: z.ZodType<
+  GetSubstationCapacityResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetSubstationCapacityError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetSubstationCapacityResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });