@vepler/sdk 2.133.0 → 2.137.0

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

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

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

@@ -72,6 +72,8 @@ export * from "./getsitetiles.js";
 export * from "./getsubstationbycode.js";
 export * from "./getsubstationcapacity.js";
 export * from "./getsubstationdfes.js";
+export * from "./gettransactionbyid.js";
+export * from "./gettransactionsbyuprn.js";
 export * from "./getv1titledeedstitlenumber.js";
 export * from "./getv1titledeedstitlenumberdocuments.js";
 export * from "./getv1titledeedstitlenumberdocumentsdocumenttype.js";
@@ -93,10 +95,12 @@ export * from "./queryairqualitypoint.js";
 export * from "./querycompanies.js";
 export * from "./queryepc.js";
 export * from "./querylistings.js";
+export * from "./querylistingsadvanced.js";
 export * from "./querylistingsbysource.js";
 export * from "./querypersons.js";
 export * from "./queryschools.js";
 export * from "./queryschoolsbysource.js";
+export * from "./querytransactions.js";
 export * from "./resolveaddress.js";
 export * from "./responsevalidationerror.js";
 export * from "./reversegeocode.js";

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

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