@vepler/sdk 2.42.0 → 2.45.0

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

@@ -0,0 +1,665 @@
+/*
+ * 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 SearchSubstationsEnergyResponse503Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type SearchSubstationsEnergyResponse503Type = OpenEnum<
+  typeof SearchSubstationsEnergyResponse503Type
+>;
+
+export type SearchSubstationsEnergyResponse503Error = {
+  /**
+   * 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: SearchSubstationsEnergyResponse503Type;
+};
+
+/**
+ * Error response
+ */
+export type SearchSubstationsEnergyResponse503ResponseBodyData = {
+  error: SearchSubstationsEnergyResponse503Error;
+};
+
+/**
+ * Error response
+ */
+export class SearchSubstationsEnergyResponse503ResponseBody
+  extends SDKBaseError
+{
+  error: SearchSubstationsEnergyResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: SearchSubstationsEnergyResponse503ResponseBodyData;
+
+  constructor(
+    err: SearchSubstationsEnergyResponse503ResponseBodyData,
+    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 = "SearchSubstationsEnergyResponse503ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const SearchSubstationsEnergyResponse500Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type SearchSubstationsEnergyResponse500Type = OpenEnum<
+  typeof SearchSubstationsEnergyResponse500Type
+>;
+
+export type SearchSubstationsEnergyResponse500Error = {
+  /**
+   * 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: SearchSubstationsEnergyResponse500Type;
+};
+
+/**
+ * Error response
+ */
+export type SearchSubstationsEnergyResponse500ResponseBodyData = {
+  error: SearchSubstationsEnergyResponse500Error;
+};
+
+/**
+ * Error response
+ */
+export class SearchSubstationsEnergyResponse500ResponseBody
+  extends SDKBaseError
+{
+  error: SearchSubstationsEnergyResponse500Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: SearchSubstationsEnergyResponse500ResponseBodyData;
+
+  constructor(
+    err: SearchSubstationsEnergyResponse500ResponseBodyData,
+    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 = "SearchSubstationsEnergyResponse500ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const SearchSubstationsEnergyResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type SearchSubstationsEnergyResponseType = OpenEnum<
+  typeof SearchSubstationsEnergyResponseType
+>;
+
+export type SearchSubstationsEnergyResponseError = {
+  /**
+   * 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: SearchSubstationsEnergyResponseType;
+};
+
+/**
+ * Error response
+ */
+export type SearchSubstationsEnergyResponseResponseBodyData = {
+  error: SearchSubstationsEnergyResponseError;
+};
+
+/**
+ * Error response
+ */
+export class SearchSubstationsEnergyResponseResponseBody extends SDKBaseError {
+  error: SearchSubstationsEnergyResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: SearchSubstationsEnergyResponseResponseBodyData;
+
+  constructor(
+    err: SearchSubstationsEnergyResponseResponseBodyData,
+    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 = "SearchSubstationsEnergyResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const SearchSubstationsEnergyType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type SearchSubstationsEnergyType = OpenEnum<
+  typeof SearchSubstationsEnergyType
+>;
+
+export type SearchSubstationsEnergyError = {
+  /**
+   * 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: SearchSubstationsEnergyType;
+};
+
+/**
+ * Error response
+ */
+export type SearchSubstationsEnergyResponseBodyData = {
+  error: SearchSubstationsEnergyError;
+};
+
+/**
+ * Error response
+ */
+export class SearchSubstationsEnergyResponseBody extends SDKBaseError {
+  error: SearchSubstationsEnergyError;
+
+  /** The original data that was passed to this error instance. */
+  data$: SearchSubstationsEnergyResponseBodyData;
+
+  constructor(
+    err: SearchSubstationsEnergyResponseBodyData,
+    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 = "SearchSubstationsEnergyResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const SearchSubstationsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type SearchSubstationsType = OpenEnum<typeof SearchSubstationsType>;
+
+export type SearchSubstationsError = {
+  /**
+   * 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: SearchSubstationsType;
+};
+
+/**
+ * Error response
+ */
+export type SearchSubstationsResponseBodyData = {
+  error: SearchSubstationsError;
+};
+
+/**
+ * Error response
+ */
+export class SearchSubstationsResponseBody extends SDKBaseError {
+  error: SearchSubstationsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: SearchSubstationsResponseBodyData;
+
+  constructor(
+    err: SearchSubstationsResponseBodyData,
+    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 = "SearchSubstationsResponseBody";
+  }
+}
+
+/** @internal */
+export const SearchSubstationsEnergyResponse503Type$inboundSchema: z.ZodType<
+  SearchSubstationsEnergyResponse503Type,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SearchSubstationsEnergyResponse503Type);
+
+/** @internal */
+export const SearchSubstationsEnergyResponse503Error$inboundSchema: z.ZodType<
+  SearchSubstationsEnergyResponse503Error,
+  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: SearchSubstationsEnergyResponse503Type$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function searchSubstationsEnergyResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SearchSubstationsEnergyResponse503Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SearchSubstationsEnergyResponse503Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SearchSubstationsEnergyResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSubstationsEnergyResponse503ResponseBody$inboundSchema:
+  z.ZodType<
+    SearchSubstationsEnergyResponse503ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => SearchSubstationsEnergyResponse503Error$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new SearchSubstationsEnergyResponse503ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const SearchSubstationsEnergyResponse500Type$inboundSchema: z.ZodType<
+  SearchSubstationsEnergyResponse500Type,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SearchSubstationsEnergyResponse500Type);
+
+/** @internal */
+export const SearchSubstationsEnergyResponse500Error$inboundSchema: z.ZodType<
+  SearchSubstationsEnergyResponse500Error,
+  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: SearchSubstationsEnergyResponse500Type$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function searchSubstationsEnergyResponse500ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SearchSubstationsEnergyResponse500Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SearchSubstationsEnergyResponse500Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SearchSubstationsEnergyResponse500Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSubstationsEnergyResponse500ResponseBody$inboundSchema:
+  z.ZodType<
+    SearchSubstationsEnergyResponse500ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => SearchSubstationsEnergyResponse500Error$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new SearchSubstationsEnergyResponse500ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const SearchSubstationsEnergyResponseType$inboundSchema: z.ZodType<
+  SearchSubstationsEnergyResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SearchSubstationsEnergyResponseType);
+
+/** @internal */
+export const SearchSubstationsEnergyResponseError$inboundSchema: z.ZodType<
+  SearchSubstationsEnergyResponseError,
+  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: SearchSubstationsEnergyResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function searchSubstationsEnergyResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSubstationsEnergyResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SearchSubstationsEnergyResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSubstationsEnergyResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSubstationsEnergyResponseResponseBody$inboundSchema:
+  z.ZodType<
+    SearchSubstationsEnergyResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => SearchSubstationsEnergyResponseError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new SearchSubstationsEnergyResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const SearchSubstationsEnergyType$inboundSchema: z.ZodType<
+  SearchSubstationsEnergyType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SearchSubstationsEnergyType);
+
+/** @internal */
+export const SearchSubstationsEnergyError$inboundSchema: z.ZodType<
+  SearchSubstationsEnergyError,
+  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: SearchSubstationsEnergyType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function searchSubstationsEnergyErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSubstationsEnergyError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSubstationsEnergyError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSubstationsEnergyError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSubstationsEnergyResponseBody$inboundSchema: z.ZodType<
+  SearchSubstationsEnergyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => SearchSubstationsEnergyError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new SearchSubstationsEnergyResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const SearchSubstationsType$inboundSchema: z.ZodType<
+  SearchSubstationsType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SearchSubstationsType);
+
+/** @internal */
+export const SearchSubstationsError$inboundSchema: z.ZodType<
+  SearchSubstationsError,
+  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: SearchSubstationsType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function searchSubstationsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSubstationsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSubstationsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSubstationsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSubstationsResponseBody$inboundSchema: z.ZodType<
+  SearchSubstationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => SearchSubstationsError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new SearchSubstationsResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });