@vepler/sdk 2.131.0 → 2.133.0

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

@@ -0,0 +1,265 @@
+/*
+ * 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 GetFrameworkSchoolsFrameworksType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetFrameworkSchoolsFrameworksType = OpenEnum<
+  typeof GetFrameworkSchoolsFrameworksType
+>;
+
+export type GetFrameworkSchoolsFrameworksError = {
+  /**
+   * 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: GetFrameworkSchoolsFrameworksType;
+};
+
+/**
+ * Error response
+ */
+export type GetFrameworkSchoolsFrameworksResponseBodyData = {
+  error: GetFrameworkSchoolsFrameworksError;
+};
+
+/**
+ * Error response
+ */
+export class GetFrameworkSchoolsFrameworksResponseBody extends SDKBaseError {
+  error: GetFrameworkSchoolsFrameworksError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetFrameworkSchoolsFrameworksResponseBodyData;
+
+  constructor(
+    err: GetFrameworkSchoolsFrameworksResponseBodyData,
+    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 = "GetFrameworkSchoolsFrameworksResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const GetFrameworkType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetFrameworkType = OpenEnum<typeof GetFrameworkType>;
+
+export type GetFrameworkError = {
+  /**
+   * 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: GetFrameworkType;
+};
+
+/**
+ * Error response
+ */
+export type GetFrameworkResponseBodyData = {
+  error: GetFrameworkError;
+};
+
+/**
+ * Error response
+ */
+export class GetFrameworkResponseBody extends SDKBaseError {
+  error: GetFrameworkError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetFrameworkResponseBodyData;
+
+  constructor(
+    err: GetFrameworkResponseBodyData,
+    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 = "GetFrameworkResponseBody";
+  }
+}
+
+/** @internal */
+export const GetFrameworkSchoolsFrameworksType$inboundSchema: z.ZodType<
+  GetFrameworkSchoolsFrameworksType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetFrameworkSchoolsFrameworksType);
+
+/** @internal */
+export const GetFrameworkSchoolsFrameworksError$inboundSchema: z.ZodType<
+  GetFrameworkSchoolsFrameworksError,
+  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: GetFrameworkSchoolsFrameworksType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getFrameworkSchoolsFrameworksErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetFrameworkSchoolsFrameworksError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetFrameworkSchoolsFrameworksError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetFrameworkSchoolsFrameworksError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetFrameworkSchoolsFrameworksResponseBody$inboundSchema: z.ZodType<
+  GetFrameworkSchoolsFrameworksResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetFrameworkSchoolsFrameworksError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetFrameworkSchoolsFrameworksResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const GetFrameworkType$inboundSchema: z.ZodType<
+  GetFrameworkType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetFrameworkType);
+
+/** @internal */
+export const GetFrameworkError$inboundSchema: z.ZodType<
+  GetFrameworkError,
+  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: GetFrameworkType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getFrameworkErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetFrameworkError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetFrameworkError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetFrameworkError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetFrameworkResponseBody$inboundSchema: z.ZodType<
+  GetFrameworkResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetFrameworkError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetFrameworkResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

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

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

@@ -39,6 +39,7 @@ export * from "./getcrimeincidents.js";
 export * from "./getcrimepointstats.js";
 export * from "./getenergyforproperty.js";
 export * from "./getepcbylocationid.js";
+export * from "./getframework.js";
 export * from "./getgeographicmetricaggregation.js";
 export * from "./getgeographymetrics.js";
 export * from "./getlistingbyid.js";
@@ -65,6 +66,7 @@ export * from "./getpsc.js";
 export * from "./getschoolbyid.js";
 export * from "./getschoolbysource.js";
 export * from "./getschoolmetrics.js";
+export * from "./getschoolscoverage.js";
 export * from "./getsitebyid.js";
 export * from "./getsitetiles.js";
 export * from "./getsubstationbycode.js";
@@ -77,6 +79,8 @@ export * from "./getvaluationanalysis.js";
 export * from "./httpclienterrors.js";
 export * from "./insufficientcreditserror.js";
 export * from "./listcatalogcountries.js";
+export * from "./listframeworks.js";
+export * from "./listschoolschangelog.js";
 export * from "./lookupoutcode.js";
 export * from "./lookuppostcode.js";
 export * from "./lookupuprn.js";
@@ -85,6 +89,7 @@ export * from "./postv1titledeedstitlenumberpurchaseasync.js";
 export * from "./predictpropertyvalue.js";
 export * from "./predictpropertyvaluebylocation.js";
 export * from "./queryairquality.js";
+export * from "./queryairqualitypoint.js";
 export * from "./querycompanies.js";
 export * from "./queryepc.js";
 export * from "./querylistings.js";

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

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

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

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