@vepler/sdk 2.155.0 → 2.164.0

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

@@ -0,0 +1,418 @@
+/*
+ * 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 GetSchoolAdmissionAreaSchoolsCatchmentResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetSchoolAdmissionAreaSchoolsCatchmentResponseType = OpenEnum<
+  typeof GetSchoolAdmissionAreaSchoolsCatchmentResponseType
+>;
+
+export type GetSchoolAdmissionAreaSchoolsCatchmentResponseError = {
+  /**
+   * 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: GetSchoolAdmissionAreaSchoolsCatchmentResponseType;
+};
+
+/**
+ * Error response
+ */
+export type GetSchoolAdmissionAreaSchoolsCatchmentResponseResponseBodyData = {
+  error: GetSchoolAdmissionAreaSchoolsCatchmentResponseError;
+};
+
+/**
+ * Error response
+ */
+export class GetSchoolAdmissionAreaSchoolsCatchmentResponseResponseBody
+  extends SDKBaseError
+{
+  error: GetSchoolAdmissionAreaSchoolsCatchmentResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetSchoolAdmissionAreaSchoolsCatchmentResponseResponseBodyData;
+
+  constructor(
+    err: GetSchoolAdmissionAreaSchoolsCatchmentResponseResponseBodyData,
+    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 = "GetSchoolAdmissionAreaSchoolsCatchmentResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetSchoolAdmissionAreaSchoolsCatchmentType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetSchoolAdmissionAreaSchoolsCatchmentType = OpenEnum<
+  typeof GetSchoolAdmissionAreaSchoolsCatchmentType
+>;
+
+export type GetSchoolAdmissionAreaSchoolsCatchmentError = {
+  /**
+   * 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: GetSchoolAdmissionAreaSchoolsCatchmentType;
+};
+
+/**
+ * Error response
+ */
+export type GetSchoolAdmissionAreaSchoolsCatchmentResponseBodyData = {
+  error: GetSchoolAdmissionAreaSchoolsCatchmentError;
+};
+
+/**
+ * Error response
+ */
+export class GetSchoolAdmissionAreaSchoolsCatchmentResponseBody
+  extends SDKBaseError
+{
+  error: GetSchoolAdmissionAreaSchoolsCatchmentError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetSchoolAdmissionAreaSchoolsCatchmentResponseBodyData;
+
+  constructor(
+    err: GetSchoolAdmissionAreaSchoolsCatchmentResponseBodyData,
+    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 = "GetSchoolAdmissionAreaSchoolsCatchmentResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetSchoolAdmissionAreaType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetSchoolAdmissionAreaType = OpenEnum<
+  typeof GetSchoolAdmissionAreaType
+>;
+
+export type GetSchoolAdmissionAreaError = {
+  /**
+   * 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: GetSchoolAdmissionAreaType;
+};
+
+/**
+ * Error response
+ */
+export type GetSchoolAdmissionAreaResponseBodyData = {
+  error: GetSchoolAdmissionAreaError;
+};
+
+/**
+ * Error response
+ */
+export class GetSchoolAdmissionAreaResponseBody extends SDKBaseError {
+  error: GetSchoolAdmissionAreaError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetSchoolAdmissionAreaResponseBodyData;
+
+  constructor(
+    err: GetSchoolAdmissionAreaResponseBodyData,
+    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 = "GetSchoolAdmissionAreaResponseBody";
+  }
+}
+
+/** @internal */
+export const GetSchoolAdmissionAreaSchoolsCatchmentResponseType$inboundSchema:
+  z.ZodType<
+    GetSchoolAdmissionAreaSchoolsCatchmentResponseType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    GetSchoolAdmissionAreaSchoolsCatchmentResponseType,
+  );
+
+/** @internal */
+export const GetSchoolAdmissionAreaSchoolsCatchmentResponseError$inboundSchema:
+  z.ZodType<
+    GetSchoolAdmissionAreaSchoolsCatchmentResponseError,
+    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: GetSchoolAdmissionAreaSchoolsCatchmentResponseType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getSchoolAdmissionAreaSchoolsCatchmentResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetSchoolAdmissionAreaSchoolsCatchmentResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSchoolAdmissionAreaSchoolsCatchmentResponseError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetSchoolAdmissionAreaSchoolsCatchmentResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolAdmissionAreaSchoolsCatchmentResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetSchoolAdmissionAreaSchoolsCatchmentResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetSchoolAdmissionAreaSchoolsCatchmentResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetSchoolAdmissionAreaSchoolsCatchmentResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetSchoolAdmissionAreaSchoolsCatchmentType$inboundSchema:
+  z.ZodType<GetSchoolAdmissionAreaSchoolsCatchmentType, z.ZodTypeDef, unknown> =
+    openEnums.inboundSchema(GetSchoolAdmissionAreaSchoolsCatchmentType);
+
+/** @internal */
+export const GetSchoolAdmissionAreaSchoolsCatchmentError$inboundSchema:
+  z.ZodType<
+    GetSchoolAdmissionAreaSchoolsCatchmentError,
+    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: GetSchoolAdmissionAreaSchoolsCatchmentType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getSchoolAdmissionAreaSchoolsCatchmentErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetSchoolAdmissionAreaSchoolsCatchmentError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSchoolAdmissionAreaSchoolsCatchmentError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetSchoolAdmissionAreaSchoolsCatchmentError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolAdmissionAreaSchoolsCatchmentResponseBody$inboundSchema:
+  z.ZodType<
+    GetSchoolAdmissionAreaSchoolsCatchmentResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetSchoolAdmissionAreaSchoolsCatchmentError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetSchoolAdmissionAreaSchoolsCatchmentResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const GetSchoolAdmissionAreaType$inboundSchema: z.ZodType<
+  GetSchoolAdmissionAreaType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetSchoolAdmissionAreaType);
+
+/** @internal */
+export const GetSchoolAdmissionAreaError$inboundSchema: z.ZodType<
+  GetSchoolAdmissionAreaError,
+  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: GetSchoolAdmissionAreaType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getSchoolAdmissionAreaErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolAdmissionAreaError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolAdmissionAreaError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolAdmissionAreaError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolAdmissionAreaResponseBody$inboundSchema: z.ZodType<
+  GetSchoolAdmissionAreaResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetSchoolAdmissionAreaError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetSchoolAdmissionAreaResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -43,6 +43,7 @@ export * from "./getcompanypscs.js";
 export * from "./getconnectionqueuebysubstation.js";
 export * from "./getconnectionqueueentry.js";
 export * from "./getconnectivityscores.js";
+export * from "./getconservationdesignation.js";
 export * from "./getcrimeareastats.js";
 export * from "./getcrimeincidents.js";
 export * from "./getcrimepointstats.js";
@@ -51,6 +52,8 @@ export * from "./getepcbylocationid.js";
 export * from "./getframework.js";
 export * from "./getgeographicmetricaggregation.js";
 export * from "./getgeographymetrics.js";
+export * from "./getheritagedesignation.js";
+export * from "./getlandconstraintdesignation.js";
 export * from "./getlistingbyid.js";
 export * from "./getlistingbysource.js";
 export * from "./getlistingsbylocation.js";
@@ -73,6 +76,7 @@ export * from "./getpropertiesinsite.js";
 export * from "./getpropertytiles.js";
 export * from "./getprosperity.js";
 export * from "./getpsc.js";
+export * from "./getschooladmissionarea.js";
 export * from "./getschoolbyid.js";
 export * from "./getschoolbysource.js";
 export * from "./getschoolmetrics.js";
@@ -93,7 +97,13 @@ export * from "./insufficientcreditserror.js";
 export * from "./listcatalogcountries.js";
 export * from "./listcensusdatasets.js";
 export * from "./listcensusvariables.js";
+export * from "./listconservationsnapshots.js";
+export * from "./listconservationtypes.js";
 export * from "./listframeworks.js";
+export * from "./listheritagesnapshots.js";
+export * from "./listheritagetypes.js";
+export * from "./listlandconstraintsnapshots.js";
+export * from "./listlandconstrainttypes.js";
 export * from "./listschoolschangelog.js";
 export * from "./lookupoutcode.js";
 export * from "./lookuppostcode.js";
@@ -107,8 +117,11 @@ export * from "./predictpropertyvaluebylocation.js";
 export * from "./queryairquality.js";
 export * from "./queryairqualitypoint.js";
 export * from "./querycompanies.js";
+export * from "./queryconservationdesignations.js";
 export * from "./queryepc.js";
 export * from "./queryfloodriskpoint.js";
+export * from "./queryheritagedesignations.js";
+export * from "./querylandconstraintdesignations.js";
 export * from "./querylistings.js";
 export * from "./querylistingsadvanced.js";
 export * from "./querylistingsbysource.js";