@vepler/sdk 0.1.0 → 1.9.9

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

@@ -4,8 +4,27 @@
 
 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 {
+  CouncilTaxData,
+  CouncilTaxData$inboundSchema,
+  CouncilTaxData$Outbound,
+  CouncilTaxData$outboundSchema,
+} from "./counciltaxdata.js";
+import {
+  EPCData,
+  EPCData$inboundSchema,
+  EPCData$Outbound,
+  EPCData$outboundSchema,
+} from "./epcdata.js";
+import {
+  MarketStatus,
+  MarketStatus$inboundSchema,
+  MarketStatus$Outbound,
+  MarketStatus$outboundSchema,
+} from "./marketstatus.js";
 import {
   PricingData,
   PricingData$inboundSchema,
@@ -18,77 +37,191 @@ import {
   PropertyAddress$Outbound,
   PropertyAddress$outboundSchema,
 } from "./propertyaddress.js";
+import {
+  PropertyTags,
+  PropertyTags$inboundSchema,
+  PropertyTags$Outbound,
+  PropertyTags$outboundSchema,
+} from "./propertytags.js";
+import {
+  RoomDetails,
+  RoomDetails$inboundSchema,
+  RoomDetails$Outbound,
+  RoomDetails$outboundSchema,
+} from "./roomdetails.js";
+import {
+  SaleRecord,
+  SaleRecord$inboundSchema,
+  SaleRecord$Outbound,
+  SaleRecord$outboundSchema,
+} from "./salerecord.js";
+import {
+  TenureData,
+  TenureData$inboundSchema,
+  TenureData$Outbound,
+  TenureData$outboundSchema,
+} from "./tenuredata.js";
 
-export type Coordinates = {
-  latitude: number;
-  longitude: number;
-};
+/**
+ * Property classification code
+ */
+export const ClassificationCode = {
+  Rd: "RD",
+  Rd01: "RD01",
+  Rd02: "RD02",
+  Rd03: "RD03",
+  Rd04: "RD04",
+  Rd06: "RD06",
+  Rd07: "RD07",
+  Rd08: "RD08",
+  Rd10: "RD10",
+} as const;
+/**
+ * Property classification code
+ */
+export type ClassificationCode = ClosedEnum<typeof ClassificationCode>;
+
+/**
+ * Property type
+ */
+export const PropertyType = {
+  Unknown: "unknown",
+  Other: "other",
+  Flat: "flat",
+  Detached: "detached",
+  SemiDetached: "semiDetached",
+  Terraced: "terraced",
+  Bungalow: "bungalow",
+  Maisonette: "maisonette",
+  Cottage: "cottage",
+  Chalet: "chalet",
+  Lodge: "lodge",
+  MobileHome: "mobileHome",
+  Houseboat: "houseboat",
+  Retirement: "retirement",
+  CharacterProperty: "characterProperty",
+  BlockOfFlats: "blockOfFlats",
+  Farm: "farm",
+  Parking: "parking",
+  Equestrian: "equestrian",
+  Restaurant: "restaurant",
+  Industrial: "industrial",
+  Leisure: "leisure",
+  Retail: "retail",
+  Land: "land",
+  Office: "office",
+  Riad: "riad",
+} as const;
+/**
+ * Property type
+ */
+export type PropertyType = ClosedEnum<typeof PropertyType>;
 
 export type PropertyDataSpatial = {
+  /**
+   * Property boundary GeoJSON
+   */
   boundary?: any | null | undefined;
-  coordinates: Coordinates;
+  /**
+   * Latitude coordinate
+   */
+  lat: number;
+  /**
+   * Longitude coordinate
+   */
+  lng: number;
 };
 
 export type PropertyData = {
   address: PropertyAddress;
-  classificationCode?: string | undefined;
+  /**
+   * Property classification code
+   */
+  classificationCode?: ClassificationCode | undefined;
+  councilTax?: CouncilTaxData | undefined;
+  epc?: EPCData | undefined;
+  /**
+   * Total floor area in square metres
+   */
+  floorAreaSqM?: number | undefined;
+  /**
+   * ISO timestamp of last data update
+   */
+  lastUpdated?: string | undefined;
+  /**
+   * Location identifier
+   */
   locationId: string;
+  marketStatus?: MarketStatus | undefined;
+  /**
+   * Plot size in square metres
+   */
+  plotSizeSqM?: number | undefined;
   pricing?: PricingData | undefined;
+  /**
+   * Unique property identifier
+   */
   propertyId: string;
+  /**
+   * Property sub-type
+   */
+  propertySubType?: string | undefined;
+  /**
+   * Property type
+   */
+  propertyType?: PropertyType | undefined;
+  roomDetails?: RoomDetails | undefined;
+  /**
+   * Historical sale records
+   */
+  saleHistory?: Array<SaleRecord> | undefined;
   spatial: PropertyDataSpatial;
+  tags?: PropertyTags | undefined;
+  tenure?: TenureData | undefined;
+  /**
+   * Year property was built
+   */
+  yearBuilt?: number | undefined;
 };
 
 /** @internal */
-export const Coordinates$inboundSchema: z.ZodType<
-  Coordinates,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  latitude: z.number(),
-  longitude: z.number(),
-});
-
-/** @internal */
-export type Coordinates$Outbound = {
-  latitude: number;
-  longitude: number;
-};
+export const ClassificationCode$inboundSchema: z.ZodNativeEnum<
+  typeof ClassificationCode
+> = z.nativeEnum(ClassificationCode);
 
 /** @internal */
-export const Coordinates$outboundSchema: z.ZodType<
-  Coordinates$Outbound,
-  z.ZodTypeDef,
-  Coordinates
-> = z.object({
-  latitude: z.number(),
-  longitude: z.number(),
-});
+export const ClassificationCode$outboundSchema: z.ZodNativeEnum<
+  typeof ClassificationCode
+> = ClassificationCode$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace Coordinates$ {
-  /** @deprecated use `Coordinates$inboundSchema` instead. */
-  export const inboundSchema = Coordinates$inboundSchema;
-  /** @deprecated use `Coordinates$outboundSchema` instead. */
-  export const outboundSchema = Coordinates$outboundSchema;
-  /** @deprecated use `Coordinates$Outbound` instead. */
-  export type Outbound = Coordinates$Outbound;
+export namespace ClassificationCode$ {
+  /** @deprecated use `ClassificationCode$inboundSchema` instead. */
+  export const inboundSchema = ClassificationCode$inboundSchema;
+  /** @deprecated use `ClassificationCode$outboundSchema` instead. */
+  export const outboundSchema = ClassificationCode$outboundSchema;
 }
 
-export function coordinatesToJSON(coordinates: Coordinates): string {
-  return JSON.stringify(Coordinates$outboundSchema.parse(coordinates));
-}
+/** @internal */
+export const PropertyType$inboundSchema: z.ZodNativeEnum<typeof PropertyType> =
+  z.nativeEnum(PropertyType);
 
-export function coordinatesFromJSON(
-  jsonString: string,
-): SafeParseResult<Coordinates, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Coordinates$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Coordinates' from JSON`,
-  );
+/** @internal */
+export const PropertyType$outboundSchema: z.ZodNativeEnum<typeof PropertyType> =
+  PropertyType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyType$ {
+  /** @deprecated use `PropertyType$inboundSchema` instead. */
+  export const inboundSchema = PropertyType$inboundSchema;
+  /** @deprecated use `PropertyType$outboundSchema` instead. */
+  export const outboundSchema = PropertyType$outboundSchema;
 }
 
 /** @internal */
@@ -98,13 +231,15 @@ export const PropertyDataSpatial$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   boundary: z.nullable(z.any()).optional(),
-  coordinates: z.lazy(() => Coordinates$inboundSchema),
+  lat: z.number(),
+  lng: z.number(),
 });
 
 /** @internal */
 export type PropertyDataSpatial$Outbound = {
   boundary?: any | null | undefined;
-  coordinates: Coordinates$Outbound;
+  lat: number;
+  lng: number;
 };
 
 /** @internal */
@@ -114,7 +249,8 @@ export const PropertyDataSpatial$outboundSchema: z.ZodType<
   PropertyDataSpatial
 > = z.object({
   boundary: z.nullable(z.any()).optional(),
-  coordinates: z.lazy(() => Coordinates$outboundSchema),
+  lat: z.number(),
+  lng: z.number(),
 });
 
 /**
@@ -155,21 +291,47 @@ export const PropertyData$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   address: PropertyAddress$inboundSchema,
-  classificationCode: z.string().optional(),
+  classificationCode: ClassificationCode$inboundSchema.optional(),
+  councilTax: CouncilTaxData$inboundSchema.optional(),
+  epc: EPCData$inboundSchema.optional(),
+  floorAreaSqM: z.number().optional(),
+  lastUpdated: z.string().optional(),
   locationId: z.string(),
+  marketStatus: MarketStatus$inboundSchema.optional(),
+  plotSizeSqM: z.number().optional(),
   pricing: PricingData$inboundSchema.optional(),
   propertyId: z.string(),
+  propertySubType: z.string().optional(),
+  propertyType: PropertyType$inboundSchema.optional(),
+  roomDetails: RoomDetails$inboundSchema.optional(),
+  saleHistory: z.array(SaleRecord$inboundSchema).optional(),
   spatial: z.lazy(() => PropertyDataSpatial$inboundSchema),
+  tags: PropertyTags$inboundSchema.optional(),
+  tenure: TenureData$inboundSchema.optional(),
+  yearBuilt: z.number().optional(),
 });
 
 /** @internal */
 export type PropertyData$Outbound = {
   address: PropertyAddress$Outbound;
   classificationCode?: string | undefined;
+  councilTax?: CouncilTaxData$Outbound | undefined;
+  epc?: EPCData$Outbound | undefined;
+  floorAreaSqM?: number | undefined;
+  lastUpdated?: string | undefined;
   locationId: string;
+  marketStatus?: MarketStatus$Outbound | undefined;
+  plotSizeSqM?: number | undefined;
   pricing?: PricingData$Outbound | undefined;
   propertyId: string;
+  propertySubType?: string | undefined;
+  propertyType?: string | undefined;
+  roomDetails?: RoomDetails$Outbound | undefined;
+  saleHistory?: Array<SaleRecord$Outbound> | undefined;
   spatial: PropertyDataSpatial$Outbound;
+  tags?: PropertyTags$Outbound | undefined;
+  tenure?: TenureData$Outbound | undefined;
+  yearBuilt?: number | undefined;
 };
 
 /** @internal */
@@ -179,11 +341,24 @@ export const PropertyData$outboundSchema: z.ZodType<
   PropertyData
 > = z.object({
   address: PropertyAddress$outboundSchema,
-  classificationCode: z.string().optional(),
+  classificationCode: ClassificationCode$outboundSchema.optional(),
+  councilTax: CouncilTaxData$outboundSchema.optional(),
+  epc: EPCData$outboundSchema.optional(),
+  floorAreaSqM: z.number().optional(),
+  lastUpdated: z.string().optional(),
   locationId: z.string(),
+  marketStatus: MarketStatus$outboundSchema.optional(),
+  plotSizeSqM: z.number().optional(),
   pricing: PricingData$outboundSchema.optional(),
   propertyId: z.string(),
+  propertySubType: z.string().optional(),
+  propertyType: PropertyType$outboundSchema.optional(),
+  roomDetails: RoomDetails$outboundSchema.optional(),
+  saleHistory: z.array(SaleRecord$outboundSchema).optional(),
   spatial: z.lazy(() => PropertyDataSpatial$outboundSchema),
+  tags: PropertyTags$outboundSchema.optional(),
+  tenure: TenureData$outboundSchema.optional(),
+  yearBuilt: z.number().optional(),
 });
 
 /**