@vepler/sdk 2.39.0 → 2.45.0

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

@@ -24,7 +24,7 @@ export type GetConnectivityScoresConnectivityResponseBodyData = {
   /**
    * Always false for error responses
    */
-  success: boolean;
+  success: false;
 };
 
 /**
@@ -48,7 +48,7 @@ export class GetConnectivityScoresConnectivityResponseBody
   /**
    * Always false for error responses
    */
-  success: boolean;
+  success: false;
 
   /** The original data that was passed to this error instance. */
   data$: GetConnectivityScoresConnectivityResponseBodyData;
@@ -90,7 +90,7 @@ export type GetConnectivityScoresResponseBodyData = {
   /**
    * Always false for error responses
    */
-  success: boolean;
+  success: false;
 };
 
 /**
@@ -112,7 +112,7 @@ export class GetConnectivityScoresResponseBody extends SDKBaseError {
   /**
    * Always false for error responses
    */
-  success: boolean;
+  success: false;
 
   /** The original data that was passed to this error instance. */
   data$: GetConnectivityScoresResponseBodyData;
@@ -145,7 +145,7 @@ export const GetConnectivityScoresConnectivityResponseBody$inboundSchema:
     code: z.string().optional(),
     details: z.string().optional(),
     error: z.string(),
-    success: z.boolean(),
+    success: z.literal(false),
     request$: z.instanceof(Request),
     response$: z.instanceof(Response),
     body$: z.string(),
@@ -167,7 +167,7 @@ export const GetConnectivityScoresResponseBody$inboundSchema: z.ZodType<
   code: z.string().optional(),
   details: z.string().optional(),
   error: z.string(),
-  success: z.boolean(),
+  success: z.literal(false),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),
   body$: z.string(),

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

@@ -0,0 +1,674 @@
+/*
+ * 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 GetEnergyForPropertyEnergyResponse503Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetEnergyForPropertyEnergyResponse503Type = OpenEnum<
+  typeof GetEnergyForPropertyEnergyResponse503Type
+>;
+
+export type GetEnergyForPropertyEnergyResponse503Error = {
+  /**
+   * 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: GetEnergyForPropertyEnergyResponse503Type;
+};
+
+/**
+ * Error response
+ */
+export type GetEnergyForPropertyEnergyResponse503ResponseBodyData = {
+  error: GetEnergyForPropertyEnergyResponse503Error;
+};
+
+/**
+ * Error response
+ */
+export class GetEnergyForPropertyEnergyResponse503ResponseBody
+  extends SDKBaseError
+{
+  error: GetEnergyForPropertyEnergyResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetEnergyForPropertyEnergyResponse503ResponseBodyData;
+
+  constructor(
+    err: GetEnergyForPropertyEnergyResponse503ResponseBodyData,
+    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 = "GetEnergyForPropertyEnergyResponse503ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetEnergyForPropertyEnergyResponse500Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetEnergyForPropertyEnergyResponse500Type = OpenEnum<
+  typeof GetEnergyForPropertyEnergyResponse500Type
+>;
+
+export type GetEnergyForPropertyEnergyResponse500Error = {
+  /**
+   * 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: GetEnergyForPropertyEnergyResponse500Type;
+};
+
+/**
+ * Error response
+ */
+export type GetEnergyForPropertyEnergyResponse500ResponseBodyData = {
+  error: GetEnergyForPropertyEnergyResponse500Error;
+};
+
+/**
+ * Error response
+ */
+export class GetEnergyForPropertyEnergyResponse500ResponseBody
+  extends SDKBaseError
+{
+  error: GetEnergyForPropertyEnergyResponse500Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetEnergyForPropertyEnergyResponse500ResponseBodyData;
+
+  constructor(
+    err: GetEnergyForPropertyEnergyResponse500ResponseBodyData,
+    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 = "GetEnergyForPropertyEnergyResponse500ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetEnergyForPropertyEnergyResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetEnergyForPropertyEnergyResponseType = OpenEnum<
+  typeof GetEnergyForPropertyEnergyResponseType
+>;
+
+export type GetEnergyForPropertyEnergyResponseError = {
+  /**
+   * 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: GetEnergyForPropertyEnergyResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetEnergyForPropertyEnergyResponseResponseBodyData = {
+  error: GetEnergyForPropertyEnergyResponseError;
+};
+
+/**
+ * Error response
+ */
+export class GetEnergyForPropertyEnergyResponseResponseBody
+  extends SDKBaseError
+{
+  error: GetEnergyForPropertyEnergyResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetEnergyForPropertyEnergyResponseResponseBodyData;
+
+  constructor(
+    err: GetEnergyForPropertyEnergyResponseResponseBodyData,
+    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 = "GetEnergyForPropertyEnergyResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetEnergyForPropertyEnergyType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetEnergyForPropertyEnergyType = OpenEnum<
+  typeof GetEnergyForPropertyEnergyType
+>;
+
+export type GetEnergyForPropertyEnergyError = {
+  /**
+   * 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: GetEnergyForPropertyEnergyType;
+};
+
+/**
+ * Error response
+ */
+export type GetEnergyForPropertyEnergyResponseBodyData = {
+  error: GetEnergyForPropertyEnergyError;
+};
+
+/**
+ * Error response
+ */
+export class GetEnergyForPropertyEnergyResponseBody extends SDKBaseError {
+  error: GetEnergyForPropertyEnergyError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetEnergyForPropertyEnergyResponseBodyData;
+
+  constructor(
+    err: GetEnergyForPropertyEnergyResponseBodyData,
+    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 = "GetEnergyForPropertyEnergyResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetEnergyForPropertyType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetEnergyForPropertyType = OpenEnum<
+  typeof GetEnergyForPropertyType
+>;
+
+export type GetEnergyForPropertyError = {
+  /**
+   * 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: GetEnergyForPropertyType;
+};
+
+/**
+ * Error response
+ */
+export type GetEnergyForPropertyResponseBodyData = {
+  error: GetEnergyForPropertyError;
+};
+
+/**
+ * Error response
+ */
+export class GetEnergyForPropertyResponseBody extends SDKBaseError {
+  error: GetEnergyForPropertyError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetEnergyForPropertyResponseBodyData;
+
+  constructor(
+    err: GetEnergyForPropertyResponseBodyData,
+    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 = "GetEnergyForPropertyResponseBody";
+  }
+}
+
+/** @internal */
+export const GetEnergyForPropertyEnergyResponse503Type$inboundSchema: z.ZodType<
+  GetEnergyForPropertyEnergyResponse503Type,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetEnergyForPropertyEnergyResponse503Type);
+
+/** @internal */
+export const GetEnergyForPropertyEnergyResponse503Error$inboundSchema:
+  z.ZodType<GetEnergyForPropertyEnergyResponse503Error, 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: GetEnergyForPropertyEnergyResponse503Type$inboundSchema,
+    }).transform((v) => {
+      return remap$(v, {
+        "doc_url": "docUrl",
+      });
+    });
+
+export function getEnergyForPropertyEnergyResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetEnergyForPropertyEnergyResponse503Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetEnergyForPropertyEnergyResponse503Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetEnergyForPropertyEnergyResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetEnergyForPropertyEnergyResponse503ResponseBody$inboundSchema:
+  z.ZodType<
+    GetEnergyForPropertyEnergyResponse503ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetEnergyForPropertyEnergyResponse503Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetEnergyForPropertyEnergyResponse503ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetEnergyForPropertyEnergyResponse500Type$inboundSchema: z.ZodType<
+  GetEnergyForPropertyEnergyResponse500Type,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetEnergyForPropertyEnergyResponse500Type);
+
+/** @internal */
+export const GetEnergyForPropertyEnergyResponse500Error$inboundSchema:
+  z.ZodType<GetEnergyForPropertyEnergyResponse500Error, 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: GetEnergyForPropertyEnergyResponse500Type$inboundSchema,
+    }).transform((v) => {
+      return remap$(v, {
+        "doc_url": "docUrl",
+      });
+    });
+
+export function getEnergyForPropertyEnergyResponse500ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetEnergyForPropertyEnergyResponse500Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetEnergyForPropertyEnergyResponse500Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetEnergyForPropertyEnergyResponse500Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetEnergyForPropertyEnergyResponse500ResponseBody$inboundSchema:
+  z.ZodType<
+    GetEnergyForPropertyEnergyResponse500ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetEnergyForPropertyEnergyResponse500Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetEnergyForPropertyEnergyResponse500ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetEnergyForPropertyEnergyResponseType$inboundSchema: z.ZodType<
+  GetEnergyForPropertyEnergyResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetEnergyForPropertyEnergyResponseType);
+
+/** @internal */
+export const GetEnergyForPropertyEnergyResponseError$inboundSchema: z.ZodType<
+  GetEnergyForPropertyEnergyResponseError,
+  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: GetEnergyForPropertyEnergyResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getEnergyForPropertyEnergyResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetEnergyForPropertyEnergyResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetEnergyForPropertyEnergyResponseError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetEnergyForPropertyEnergyResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetEnergyForPropertyEnergyResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetEnergyForPropertyEnergyResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => GetEnergyForPropertyEnergyResponseError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetEnergyForPropertyEnergyResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetEnergyForPropertyEnergyType$inboundSchema: z.ZodType<
+  GetEnergyForPropertyEnergyType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetEnergyForPropertyEnergyType);
+
+/** @internal */
+export const GetEnergyForPropertyEnergyError$inboundSchema: z.ZodType<
+  GetEnergyForPropertyEnergyError,
+  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: GetEnergyForPropertyEnergyType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getEnergyForPropertyEnergyErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetEnergyForPropertyEnergyError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetEnergyForPropertyEnergyError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetEnergyForPropertyEnergyError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetEnergyForPropertyEnergyResponseBody$inboundSchema: z.ZodType<
+  GetEnergyForPropertyEnergyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetEnergyForPropertyEnergyError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetEnergyForPropertyEnergyResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetEnergyForPropertyType$inboundSchema: z.ZodType<
+  GetEnergyForPropertyType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetEnergyForPropertyType);
+
+/** @internal */
+export const GetEnergyForPropertyError$inboundSchema: z.ZodType<
+  GetEnergyForPropertyError,
+  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: GetEnergyForPropertyType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getEnergyForPropertyErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetEnergyForPropertyError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetEnergyForPropertyError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetEnergyForPropertyError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetEnergyForPropertyResponseBody$inboundSchema: z.ZodType<
+  GetEnergyForPropertyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetEnergyForPropertyError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetEnergyForPropertyResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });