@vepler/sdk 2.42.0 → 2.45.0

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

@@ -0,0 +1,671 @@
+/*
+ * 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 GetSubstationByCodeEnergyResponse500Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetSubstationByCodeEnergyResponse500Type = OpenEnum<
+  typeof GetSubstationByCodeEnergyResponse500Type
+>;
+
+export type GetSubstationByCodeEnergyResponse500Error = {
+  /**
+   * 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: GetSubstationByCodeEnergyResponse500Type;
+};
+
+/**
+ * Error response
+ */
+export type GetSubstationByCodeEnergyResponse500ResponseBodyData = {
+  error: GetSubstationByCodeEnergyResponse500Error;
+};
+
+/**
+ * Error response
+ */
+export class GetSubstationByCodeEnergyResponse500ResponseBody
+  extends SDKBaseError
+{
+  error: GetSubstationByCodeEnergyResponse500Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetSubstationByCodeEnergyResponse500ResponseBodyData;
+
+  constructor(
+    err: GetSubstationByCodeEnergyResponse500ResponseBodyData,
+    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 = "GetSubstationByCodeEnergyResponse500ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetSubstationByCodeEnergyResponse429Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetSubstationByCodeEnergyResponse429Type = OpenEnum<
+  typeof GetSubstationByCodeEnergyResponse429Type
+>;
+
+export type GetSubstationByCodeEnergyResponse429Error = {
+  /**
+   * 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: GetSubstationByCodeEnergyResponse429Type;
+};
+
+/**
+ * Error response
+ */
+export type GetSubstationByCodeEnergyResponse429ResponseBodyData = {
+  error: GetSubstationByCodeEnergyResponse429Error;
+};
+
+/**
+ * Error response
+ */
+export class GetSubstationByCodeEnergyResponse429ResponseBody
+  extends SDKBaseError
+{
+  error: GetSubstationByCodeEnergyResponse429Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetSubstationByCodeEnergyResponse429ResponseBodyData;
+
+  constructor(
+    err: GetSubstationByCodeEnergyResponse429ResponseBodyData,
+    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 = "GetSubstationByCodeEnergyResponse429ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetSubstationByCodeEnergyResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetSubstationByCodeEnergyResponseType = OpenEnum<
+  typeof GetSubstationByCodeEnergyResponseType
+>;
+
+export type GetSubstationByCodeEnergyResponseError = {
+  /**
+   * 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: GetSubstationByCodeEnergyResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetSubstationByCodeEnergyResponseResponseBodyData = {
+  error: GetSubstationByCodeEnergyResponseError;
+};
+
+/**
+ * Error response
+ */
+export class GetSubstationByCodeEnergyResponseResponseBody
+  extends SDKBaseError
+{
+  error: GetSubstationByCodeEnergyResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetSubstationByCodeEnergyResponseResponseBodyData;
+
+  constructor(
+    err: GetSubstationByCodeEnergyResponseResponseBodyData,
+    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 = "GetSubstationByCodeEnergyResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetSubstationByCodeEnergyType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetSubstationByCodeEnergyType = OpenEnum<
+  typeof GetSubstationByCodeEnergyType
+>;
+
+export type GetSubstationByCodeEnergyError = {
+  /**
+   * 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: GetSubstationByCodeEnergyType;
+};
+
+/**
+ * Error response
+ */
+export type GetSubstationByCodeEnergyResponseBodyData = {
+  error: GetSubstationByCodeEnergyError;
+};
+
+/**
+ * Error response
+ */
+export class GetSubstationByCodeEnergyResponseBody extends SDKBaseError {
+  error: GetSubstationByCodeEnergyError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetSubstationByCodeEnergyResponseBodyData;
+
+  constructor(
+    err: GetSubstationByCodeEnergyResponseBodyData,
+    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 = "GetSubstationByCodeEnergyResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetSubstationByCodeType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetSubstationByCodeType = OpenEnum<typeof GetSubstationByCodeType>;
+
+export type GetSubstationByCodeError = {
+  /**
+   * 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: GetSubstationByCodeType;
+};
+
+/**
+ * Error response
+ */
+export type GetSubstationByCodeResponseBodyData = {
+  error: GetSubstationByCodeError;
+};
+
+/**
+ * Error response
+ */
+export class GetSubstationByCodeResponseBody extends SDKBaseError {
+  error: GetSubstationByCodeError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetSubstationByCodeResponseBodyData;
+
+  constructor(
+    err: GetSubstationByCodeResponseBodyData,
+    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 = "GetSubstationByCodeResponseBody";
+  }
+}
+
+/** @internal */
+export const GetSubstationByCodeEnergyResponse500Type$inboundSchema: z.ZodType<
+  GetSubstationByCodeEnergyResponse500Type,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetSubstationByCodeEnergyResponse500Type);
+
+/** @internal */
+export const GetSubstationByCodeEnergyResponse500Error$inboundSchema: z.ZodType<
+  GetSubstationByCodeEnergyResponse500Error,
+  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: GetSubstationByCodeEnergyResponse500Type$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getSubstationByCodeEnergyResponse500ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetSubstationByCodeEnergyResponse500Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSubstationByCodeEnergyResponse500Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetSubstationByCodeEnergyResponse500Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationByCodeEnergyResponse500ResponseBody$inboundSchema:
+  z.ZodType<
+    GetSubstationByCodeEnergyResponse500ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetSubstationByCodeEnergyResponse500Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetSubstationByCodeEnergyResponse500ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetSubstationByCodeEnergyResponse429Type$inboundSchema: z.ZodType<
+  GetSubstationByCodeEnergyResponse429Type,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetSubstationByCodeEnergyResponse429Type);
+
+/** @internal */
+export const GetSubstationByCodeEnergyResponse429Error$inboundSchema: z.ZodType<
+  GetSubstationByCodeEnergyResponse429Error,
+  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: GetSubstationByCodeEnergyResponse429Type$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getSubstationByCodeEnergyResponse429ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetSubstationByCodeEnergyResponse429Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSubstationByCodeEnergyResponse429Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetSubstationByCodeEnergyResponse429Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationByCodeEnergyResponse429ResponseBody$inboundSchema:
+  z.ZodType<
+    GetSubstationByCodeEnergyResponse429ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetSubstationByCodeEnergyResponse429Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetSubstationByCodeEnergyResponse429ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetSubstationByCodeEnergyResponseType$inboundSchema: z.ZodType<
+  GetSubstationByCodeEnergyResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetSubstationByCodeEnergyResponseType);
+
+/** @internal */
+export const GetSubstationByCodeEnergyResponseError$inboundSchema: z.ZodType<
+  GetSubstationByCodeEnergyResponseError,
+  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: GetSubstationByCodeEnergyResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getSubstationByCodeEnergyResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationByCodeEnergyResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSubstationByCodeEnergyResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationByCodeEnergyResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationByCodeEnergyResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetSubstationByCodeEnergyResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => GetSubstationByCodeEnergyResponseError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetSubstationByCodeEnergyResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetSubstationByCodeEnergyType$inboundSchema: z.ZodType<
+  GetSubstationByCodeEnergyType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetSubstationByCodeEnergyType);
+
+/** @internal */
+export const GetSubstationByCodeEnergyError$inboundSchema: z.ZodType<
+  GetSubstationByCodeEnergyError,
+  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: GetSubstationByCodeEnergyType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getSubstationByCodeEnergyErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationByCodeEnergyError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubstationByCodeEnergyError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationByCodeEnergyError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationByCodeEnergyResponseBody$inboundSchema: z.ZodType<
+  GetSubstationByCodeEnergyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetSubstationByCodeEnergyError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetSubstationByCodeEnergyResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetSubstationByCodeType$inboundSchema: z.ZodType<
+  GetSubstationByCodeType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetSubstationByCodeType);
+
+/** @internal */
+export const GetSubstationByCodeError$inboundSchema: z.ZodType<
+  GetSubstationByCodeError,
+  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: GetSubstationByCodeType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getSubstationByCodeErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationByCodeError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubstationByCodeError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationByCodeError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationByCodeResponseBody$inboundSchema: z.ZodType<
+  GetSubstationByCodeResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetSubstationByCodeError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetSubstationByCodeResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });