@vepler/sdk 0.1.0 → 1.9.9

package/src/sdk/models/shared/areafilter.ts

@@ -4,82 +4,79 @@
 
 import * as z from "zod";
 import { safeParse } from "../../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PointAreaFilter,
+  PointAreaFilter$inboundSchema,
+  PointAreaFilter$Outbound,
+  PointAreaFilter$outboundSchema,
+} from "./pointareafilter.js";
+import {
+  PolygonAreaFilter,
+  PolygonAreaFilter$inboundSchema,
+  PolygonAreaFilter$Outbound,
+  PolygonAreaFilter$outboundSchema,
+} from "./polygonareafilter.js";
+import {
+  PostcodeAreaFilter,
+  PostcodeAreaFilter$inboundSchema,
+  PostcodeAreaFilter$Outbound,
+  PostcodeAreaFilter$outboundSchema,
+} from "./postcodeareafilter.js";
 
-export const Type = {
-  Postcode: "postcode",
-  Point: "point",
-  Polygon: "polygon",
-} as const;
-export type Type = ClosedEnum<typeof Type>;
-
-export type AreaFilter = {
-  coordinates?: Array<number> | undefined;
-  polygon?: Array<Array<number>> | undefined;
-  /**
-   * Radius in meters for coordinate searches
-   */
-  radius?: number | undefined;
-  type: Type;
-  value?: string | undefined;
-};
-
-/** @internal */
-export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
-  Type,
-);
-
-/** @internal */
-export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
-  Type$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Type$ {
-  /** @deprecated use `Type$inboundSchema` instead. */
-  export const inboundSchema = Type$inboundSchema;
-  /** @deprecated use `Type$outboundSchema` instead. */
-  export const outboundSchema = Type$outboundSchema;
-}
+export type AreaFilter =
+  | (PointAreaFilter & { type: "point" })
+  | (PolygonAreaFilter & { type: "polygon" })
+  | (PostcodeAreaFilter & { type: "postcode" });
 
 /** @internal */
 export const AreaFilter$inboundSchema: z.ZodType<
   AreaFilter,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  coordinates: z.array(z.number()).optional(),
-  polygon: z.array(z.array(z.number())).optional(),
-  radius: z.number().optional(),
-  type: Type$inboundSchema,
-  value: z.string().optional(),
-});
+> = z.union([
+  PointAreaFilter$inboundSchema.and(
+    z.object({ type: z.literal("point") }).transform((v) => ({ type: v.type })),
+  ),
+  PolygonAreaFilter$inboundSchema.and(
+    z.object({ type: z.literal("polygon") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
+  PostcodeAreaFilter$inboundSchema.and(
+    z.object({ type: z.literal("postcode") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
+]);
 
 /** @internal */
-export type AreaFilter$Outbound = {
-  coordinates?: Array<number> | undefined;
-  polygon?: Array<Array<number>> | undefined;
-  radius?: number | undefined;
-  type: string;
-  value?: string | undefined;
-};
+export type AreaFilter$Outbound =
+  | (PointAreaFilter$Outbound & { type: "point" })
+  | (PolygonAreaFilter$Outbound & { type: "polygon" })
+  | (PostcodeAreaFilter$Outbound & { type: "postcode" });
 
 /** @internal */
 export const AreaFilter$outboundSchema: z.ZodType<
   AreaFilter$Outbound,
   z.ZodTypeDef,
   AreaFilter
-> = z.object({
-  coordinates: z.array(z.number()).optional(),
-  polygon: z.array(z.array(z.number())).optional(),
-  radius: z.number().optional(),
-  type: Type$outboundSchema,
-  value: z.string().optional(),
-});
+> = z.union([
+  PointAreaFilter$outboundSchema.and(
+    z.object({ type: z.literal("point") }).transform((v) => ({ type: v.type })),
+  ),
+  PolygonAreaFilter$outboundSchema.and(
+    z.object({ type: z.literal("polygon") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
+  PostcodeAreaFilter$outboundSchema.and(
+    z.object({ type: z.literal("postcode") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
+]);
 
 /**
  * @internal

package/src/sdk/models/shared/counciltaxdata.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Council tax band
+ */
+export const TaxBand = {
+  A: "A",
+  B: "B",
+  C: "C",
+  D: "D",
+  E: "E",
+  F: "F",
+  G: "G",
+  H: "H",
+  I: "I",
+} as const;
+/**
+ * Council tax band
+ */
+export type TaxBand = ClosedEnum<typeof TaxBand>;
+
+export type CouncilTaxData = {
+  /**
+   * Annual council tax charge in pence
+   */
+  annualCharge?: number | undefined;
+  /**
+   * Local authority name
+   */
+  localAuthority?: string | undefined;
+  /**
+   * Council tax band
+   */
+  taxBand?: TaxBand | undefined;
+};
+
+/** @internal */
+export const TaxBand$inboundSchema: z.ZodNativeEnum<typeof TaxBand> = z
+  .nativeEnum(TaxBand);
+
+/** @internal */
+export const TaxBand$outboundSchema: z.ZodNativeEnum<typeof TaxBand> =
+  TaxBand$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TaxBand$ {
+  /** @deprecated use `TaxBand$inboundSchema` instead. */
+  export const inboundSchema = TaxBand$inboundSchema;
+  /** @deprecated use `TaxBand$outboundSchema` instead. */
+  export const outboundSchema = TaxBand$outboundSchema;
+}
+
+/** @internal */
+export const CouncilTaxData$inboundSchema: z.ZodType<
+  CouncilTaxData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  annualCharge: z.number().optional(),
+  localAuthority: z.string().optional(),
+  taxBand: TaxBand$inboundSchema.optional(),
+});
+
+/** @internal */
+export type CouncilTaxData$Outbound = {
+  annualCharge?: number | undefined;
+  localAuthority?: string | undefined;
+  taxBand?: string | undefined;
+};
+
+/** @internal */
+export const CouncilTaxData$outboundSchema: z.ZodType<
+  CouncilTaxData$Outbound,
+  z.ZodTypeDef,
+  CouncilTaxData
+> = z.object({
+  annualCharge: z.number().optional(),
+  localAuthority: z.string().optional(),
+  taxBand: TaxBand$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CouncilTaxData$ {
+  /** @deprecated use `CouncilTaxData$inboundSchema` instead. */
+  export const inboundSchema = CouncilTaxData$inboundSchema;
+  /** @deprecated use `CouncilTaxData$outboundSchema` instead. */
+  export const outboundSchema = CouncilTaxData$outboundSchema;
+  /** @deprecated use `CouncilTaxData$Outbound` instead. */
+  export type Outbound = CouncilTaxData$Outbound;
+}
+
+export function councilTaxDataToJSON(councilTaxData: CouncilTaxData): string {
+  return JSON.stringify(CouncilTaxData$outboundSchema.parse(councilTaxData));
+}
+
+export function councilTaxDataFromJSON(
+  jsonString: string,
+): SafeParseResult<CouncilTaxData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CouncilTaxData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CouncilTaxData' from JSON`,
+  );
+}

package/src/sdk/models/shared/epcdata.ts

@@ -0,0 +1,174 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Current EPC rating
+ */
+export const CurrentEnergyRating = {
+  A: "A",
+  B: "B",
+  C: "C",
+  D: "D",
+  E: "E",
+  F: "F",
+  G: "G",
+} as const;
+/**
+ * Current EPC rating
+ */
+export type CurrentEnergyRating = ClosedEnum<typeof CurrentEnergyRating>;
+
+/**
+ * Potential EPC rating
+ */
+export const PotentialEnergyRating = {
+  A: "A",
+  B: "B",
+  C: "C",
+  D: "D",
+  E: "E",
+  F: "F",
+  G: "G",
+} as const;
+/**
+ * Potential EPC rating
+ */
+export type PotentialEnergyRating = ClosedEnum<typeof PotentialEnergyRating>;
+
+export type EPCData = {
+  /**
+   * Current energy efficiency score
+   */
+  currentEnergyEfficiency?: number | undefined;
+  /**
+   * Current EPC rating
+   */
+  currentEnergyRating?: CurrentEnergyRating | undefined;
+  /**
+   * Potential energy efficiency score
+   */
+  potentialEnergyEfficiency?: number | undefined;
+  /**
+   * Potential EPC rating
+   */
+  potentialEnergyRating?: PotentialEnergyRating | undefined;
+  /**
+   * EPC certificate valid from date
+   */
+  validFrom?: string | undefined;
+  /**
+   * EPC certificate valid to date
+   */
+  validTo?: string | undefined;
+};
+
+/** @internal */
+export const CurrentEnergyRating$inboundSchema: z.ZodNativeEnum<
+  typeof CurrentEnergyRating
+> = z.nativeEnum(CurrentEnergyRating);
+
+/** @internal */
+export const CurrentEnergyRating$outboundSchema: z.ZodNativeEnum<
+  typeof CurrentEnergyRating
+> = CurrentEnergyRating$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CurrentEnergyRating$ {
+  /** @deprecated use `CurrentEnergyRating$inboundSchema` instead. */
+  export const inboundSchema = CurrentEnergyRating$inboundSchema;
+  /** @deprecated use `CurrentEnergyRating$outboundSchema` instead. */
+  export const outboundSchema = CurrentEnergyRating$outboundSchema;
+}
+
+/** @internal */
+export const PotentialEnergyRating$inboundSchema: z.ZodNativeEnum<
+  typeof PotentialEnergyRating
+> = z.nativeEnum(PotentialEnergyRating);
+
+/** @internal */
+export const PotentialEnergyRating$outboundSchema: z.ZodNativeEnum<
+  typeof PotentialEnergyRating
+> = PotentialEnergyRating$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PotentialEnergyRating$ {
+  /** @deprecated use `PotentialEnergyRating$inboundSchema` instead. */
+  export const inboundSchema = PotentialEnergyRating$inboundSchema;
+  /** @deprecated use `PotentialEnergyRating$outboundSchema` instead. */
+  export const outboundSchema = PotentialEnergyRating$outboundSchema;
+}
+
+/** @internal */
+export const EPCData$inboundSchema: z.ZodType<EPCData, z.ZodTypeDef, unknown> =
+  z.object({
+    currentEnergyEfficiency: z.number().optional(),
+    currentEnergyRating: CurrentEnergyRating$inboundSchema.optional(),
+    potentialEnergyEfficiency: z.number().optional(),
+    potentialEnergyRating: PotentialEnergyRating$inboundSchema.optional(),
+    validFrom: z.string().optional(),
+    validTo: z.string().optional(),
+  });
+
+/** @internal */
+export type EPCData$Outbound = {
+  currentEnergyEfficiency?: number | undefined;
+  currentEnergyRating?: string | undefined;
+  potentialEnergyEfficiency?: number | undefined;
+  potentialEnergyRating?: string | undefined;
+  validFrom?: string | undefined;
+  validTo?: string | undefined;
+};
+
+/** @internal */
+export const EPCData$outboundSchema: z.ZodType<
+  EPCData$Outbound,
+  z.ZodTypeDef,
+  EPCData
+> = z.object({
+  currentEnergyEfficiency: z.number().optional(),
+  currentEnergyRating: CurrentEnergyRating$outboundSchema.optional(),
+  potentialEnergyEfficiency: z.number().optional(),
+  potentialEnergyRating: PotentialEnergyRating$outboundSchema.optional(),
+  validFrom: z.string().optional(),
+  validTo: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EPCData$ {
+  /** @deprecated use `EPCData$inboundSchema` instead. */
+  export const inboundSchema = EPCData$inboundSchema;
+  /** @deprecated use `EPCData$outboundSchema` instead. */
+  export const outboundSchema = EPCData$outboundSchema;
+  /** @deprecated use `EPCData$Outbound` instead. */
+  export type Outbound = EPCData$Outbound;
+}
+
+export function epcDataToJSON(epcData: EPCData): string {
+  return JSON.stringify(EPCData$outboundSchema.parse(epcData));
+}
+
+export function epcDataFromJSON(
+  jsonString: string,
+): SafeParseResult<EPCData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EPCData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EPCData' from JSON`,
+  );
+}

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

@@ -3,17 +3,38 @@
  */
 
 export * from "./areafilter.js";
+export * from "./counciltaxdata.js";
+export * from "./epcdata.js";
 export * from "./errorresponse.js";
 export * from "./healthresponse.js";
+export * from "./marketstatus.js";
 export * from "./planningapplication.js";
 export * from "./planninglistresponse.js";
 export * from "./planningqueryfilters.js";
 export * from "./planningqueryrequest.js";
+export * from "./pointareafilter.js";
+export * from "./polygonareafilter.js";
+export * from "./postcodeareafilter.js";
 export * from "./pricingdata.js";
 export * from "./propertyaddress.js";
 export * from "./propertybyslugsrequest.js";
 export * from "./propertydata.js";
 export * from "./propertyfilters.js";
 export * from "./propertylistresponse.js";
+export * from "./propertyonstreet.js";
 export * from "./propertyqueryrequest.js";
+export * from "./propertytags.js";
+export * from "./roomdetails.js";
+export * from "./salerecord.js";
 export * from "./security.js";
+export * from "./streetdescriptor.js";
+export * from "./streetdetails.js";
+export * from "./streetquerybycoordinates.js";
+export * from "./streetquerybyname.js";
+export * from "./streetquerybypostcode.js";
+export * from "./streetquerybyuprn.js";
+export * from "./streetquerybyusrn.js";
+export * from "./streetqueryrequest.js";
+export * from "./streetqueryresponse.js";
+export * from "./streetstatistics.js";
+export * from "./tenuredata.js";

package/src/sdk/models/shared/marketstatus.ts

@@ -0,0 +1,159 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Rental status
+ */
+export const ForRent = {
+  Live: "live",
+  Reserved: "reserved",
+  Unavailable: "unavailable",
+} as const;
+/**
+ * Rental status
+ */
+export type ForRent = ClosedEnum<typeof ForRent>;
+
+/**
+ * Sale status
+ */
+export const ForSale = {
+  Live: "live",
+  Sstc: "sstc",
+  UnderOffer: "under_offer",
+  Unavailable: "unavailable",
+} as const;
+/**
+ * Sale status
+ */
+export type ForSale = ClosedEnum<typeof ForSale>;
+
+export type MarketStatus = {
+  /**
+   * Number of days on market
+   */
+  daysOnMarket?: number | undefined;
+  /**
+   * Rental status
+   */
+  forRent?: ForRent | undefined;
+  /**
+   * Sale status
+   */
+  forSale?: ForSale | undefined;
+  /**
+   * ISO date when property was listed
+   */
+  listingDate?: string | undefined;
+  /**
+   * ISO date when property was sold
+   */
+  soldDate?: string | undefined;
+};
+
+/** @internal */
+export const ForRent$inboundSchema: z.ZodNativeEnum<typeof ForRent> = z
+  .nativeEnum(ForRent);
+
+/** @internal */
+export const ForRent$outboundSchema: z.ZodNativeEnum<typeof ForRent> =
+  ForRent$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ForRent$ {
+  /** @deprecated use `ForRent$inboundSchema` instead. */
+  export const inboundSchema = ForRent$inboundSchema;
+  /** @deprecated use `ForRent$outboundSchema` instead. */
+  export const outboundSchema = ForRent$outboundSchema;
+}
+
+/** @internal */
+export const ForSale$inboundSchema: z.ZodNativeEnum<typeof ForSale> = z
+  .nativeEnum(ForSale);
+
+/** @internal */
+export const ForSale$outboundSchema: z.ZodNativeEnum<typeof ForSale> =
+  ForSale$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ForSale$ {
+  /** @deprecated use `ForSale$inboundSchema` instead. */
+  export const inboundSchema = ForSale$inboundSchema;
+  /** @deprecated use `ForSale$outboundSchema` instead. */
+  export const outboundSchema = ForSale$outboundSchema;
+}
+
+/** @internal */
+export const MarketStatus$inboundSchema: z.ZodType<
+  MarketStatus,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  daysOnMarket: z.number().optional(),
+  forRent: ForRent$inboundSchema.optional(),
+  forSale: ForSale$inboundSchema.optional(),
+  listingDate: z.string().optional(),
+  soldDate: z.string().optional(),
+});
+
+/** @internal */
+export type MarketStatus$Outbound = {
+  daysOnMarket?: number | undefined;
+  forRent?: string | undefined;
+  forSale?: string | undefined;
+  listingDate?: string | undefined;
+  soldDate?: string | undefined;
+};
+
+/** @internal */
+export const MarketStatus$outboundSchema: z.ZodType<
+  MarketStatus$Outbound,
+  z.ZodTypeDef,
+  MarketStatus
+> = z.object({
+  daysOnMarket: z.number().optional(),
+  forRent: ForRent$outboundSchema.optional(),
+  forSale: ForSale$outboundSchema.optional(),
+  listingDate: z.string().optional(),
+  soldDate: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MarketStatus$ {
+  /** @deprecated use `MarketStatus$inboundSchema` instead. */
+  export const inboundSchema = MarketStatus$inboundSchema;
+  /** @deprecated use `MarketStatus$outboundSchema` instead. */
+  export const outboundSchema = MarketStatus$outboundSchema;
+  /** @deprecated use `MarketStatus$Outbound` instead. */
+  export type Outbound = MarketStatus$Outbound;
+}
+
+export function marketStatusToJSON(marketStatus: MarketStatus): string {
+  return JSON.stringify(MarketStatus$outboundSchema.parse(marketStatus));
+}
+
+export function marketStatusFromJSON(
+  jsonString: string,
+): SafeParseResult<MarketStatus, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MarketStatus$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MarketStatus' from JSON`,
+  );
+}