@vepler/sdk 2.6.5 → 2.8.0

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

@@ -8,9 +8,6 @@ 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",
@@ -20,14 +17,8 @@ export const CurrentEnergyRating = {
   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",
@@ -37,47 +28,17 @@ export const PotentialEnergyRating = {
   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
-   */
+  currentEnergyEfficiency?: number | null | undefined;
   currentEnergyRating?: CurrentEnergyRating | undefined;
-  /**
-   * Current annual heating cost in pence
-   */
-  heatingCostCurrent?: number | undefined;
-  /**
-   * Potential annual heating cost in pence
-   */
-  heatingCostPotential?: number | undefined;
-  /**
-   * Current annual hot water cost in pence
-   */
-  hotWaterCostCurrent?: number | undefined;
-  /**
-   * Potential annual hot water cost in pence
-   */
-  hotWaterCostPotential?: number | undefined;
-  /**
-   * Type of main heating control system
-   */
-  mainHeatingControls?: string | undefined;
-  /**
-   * Potential energy efficiency score
-   */
-  potentialEnergyEfficiency?: number | undefined;
-  /**
-   * Potential EPC rating
-   */
+  heatingCostCurrent?: number | null | undefined;
+  heatingCostPotential?: number | null | undefined;
+  hotWaterCostCurrent?: number | null | undefined;
+  hotWaterCostPotential?: number | null | undefined;
+  mainHeatingControls?: string | null | undefined;
+  potentialEnergyEfficiency?: number | null | undefined;
   potentialEnergyRating?: PotentialEnergyRating | undefined;
 };
 
@@ -94,14 +55,14 @@ export const PotentialEnergyRating$inboundSchema: z.ZodNativeEnum<
 /** @internal */
 export const EPCData$inboundSchema: z.ZodType<EPCData, z.ZodTypeDef, unknown> =
   z.object({
-    currentEnergyEfficiency: z.number().optional(),
+    currentEnergyEfficiency: z.nullable(z.number()).optional(),
     currentEnergyRating: CurrentEnergyRating$inboundSchema.optional(),
-    heatingCostCurrent: z.number().optional(),
-    heatingCostPotential: z.number().optional(),
-    hotWaterCostCurrent: z.number().optional(),
-    hotWaterCostPotential: z.number().optional(),
-    mainHeatingControls: z.string().optional(),
-    potentialEnergyEfficiency: z.number().optional(),
+    heatingCostCurrent: z.nullable(z.number()).optional(),
+    heatingCostPotential: z.nullable(z.number()).optional(),
+    hotWaterCostCurrent: z.nullable(z.number()).optional(),
+    hotWaterCostPotential: z.nullable(z.number()).optional(),
+    mainHeatingControls: z.nullable(z.string()).optional(),
+    potentialEnergyEfficiency: z.nullable(z.number()).optional(),
     potentialEnergyRating: PotentialEnergyRating$inboundSchema.optional(),
   });
 

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

@@ -28,7 +28,7 @@ export * from "./pricingdata.js";
 export * from "./propertyaddress.js";
 export * from "./propertyareafilter.js";
 export * from "./propertybyslugsrequest.js";
-export * from "./propertydata.js";
+export * from "./propertydataapi.js";
 export * from "./propertylistresponse.js";
 export * from "./propertylocationidareafilter.js";
 export * from "./propertymultipolygonareafilter.js";
@@ -46,6 +46,9 @@ export * from "./refurbishmentdata.js";
 export * from "./roomdetails.js";
 export * from "./salerecord.js";
 export * from "./school.js";
+export * from "./searchhighlight.js";
+export * from "./searchresponse.js";
+export * from "./searchresult.js";
 export * from "./security.js";
 export * from "./streetdescriptor.js";
 export * from "./streetdetails.js";

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

@@ -8,31 +8,19 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type Lease = {
-  /**
-   * Whether lease has alienation restrictions
-   */
-  alienationClause: boolean;
-  /**
-   * Date when lease was granted
-   */
+  alienationClause?: boolean | undefined;
   dateOfLease?: string | null | undefined;
-  /**
-   * Date when lease expires
-   */
   expiryDate?: string | null | undefined;
-  /**
-   * Type of lease
-   */
-  leaseType: string;
+  leaseType?: string | null | undefined;
 };
 
 /** @internal */
 export const Lease$inboundSchema: z.ZodType<Lease, z.ZodTypeDef, unknown> = z
   .object({
-    alienationClause: z.boolean(),
+    alienationClause: z.boolean().optional(),
     dateOfLease: z.nullable(z.string()).optional(),
     expiryDate: z.nullable(z.string()).optional(),
-    leaseType: z.string(),
+    leaseType: z.nullable(z.string()).optional(),
   });
 
 export function leaseFromJSON(

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

@@ -48,7 +48,7 @@ export type Pricing = {
   /**
    * Currency code
    */
-  currency: string;
+  currency?: string | null | undefined;
   /**
    * Estimated price in pence
    */
@@ -56,7 +56,7 @@ export type Pricing = {
   /**
    * Listed price in pence
    */
-  price: number;
+  price?: number | null | undefined;
 };
 
 /**
@@ -66,11 +66,11 @@ export type Seller = {
   /**
    * Property Agent Identifier (PAID)
    */
-  paid?: string | undefined;
+  paid?: string | null | undefined;
   /**
    * Seller/agent name
    */
-  name?: string | undefined;
+  name?: string | null | undefined;
 };
 
 /**
@@ -110,31 +110,31 @@ export type Listing = {
   /**
    * Property features from listing
    */
-  features: Features;
+  features?: Features | undefined;
   /**
    * Floor plan images
    */
-  floorPlanImages: Array<ListingImage>;
+  floorPlanImages?: Array<ListingImage> | undefined;
   /**
    * Property images
    */
-  images: Array<ListingImage>;
+  images?: Array<ListingImage> | undefined;
   /**
    * Unique listing identifier
    */
-  listingId: string;
+  listingId?: string | undefined;
   /**
    * Price change history for this listing
    */
-  priceChange: Array<ListingPriceChange>;
+  priceChange?: Array<ListingPriceChange> | undefined;
   /**
    * Listing pricing information
    */
-  pricing: Pricing;
+  pricing?: Pricing | undefined;
   /**
    * Date listing was published
    */
-  publishedDate: Date;
+  publishedDate?: Date | undefined;
   /**
    * Date listing was removed
    */
@@ -142,15 +142,15 @@ export type Listing = {
   /**
    * Seller information
    */
-  seller: Seller;
+  seller?: Seller | undefined;
   /**
    * Listing status
    */
-  status: Status;
+  status?: Status | undefined;
   /**
    * Listing type
    */
-  type: Type;
+  type?: Type | undefined;
 };
 
 /** @internal */
@@ -195,9 +195,9 @@ export function featuresFromJSON(
 /** @internal */
 export const Pricing$inboundSchema: z.ZodType<Pricing, z.ZodTypeDef, unknown> =
   z.object({
-    currency: z.string(),
+    currency: z.nullable(z.string()).optional(),
     estimated: z.nullable(z.number()).optional(),
-    price: z.number(),
+    price: z.nullable(z.number()).optional(),
   });
 
 export function pricingFromJSON(
@@ -213,8 +213,8 @@ export function pricingFromJSON(
 /** @internal */
 export const Seller$inboundSchema: z.ZodType<Seller, z.ZodTypeDef, unknown> = z
   .object({
-    PAID: z.string().optional(),
-    name: z.string().optional(),
+    PAID: z.nullable(z.string()).optional(),
+    name: z.nullable(z.string()).optional(),
   }).transform((v) => {
     return remap$(v, {
       "PAID": "paid",
@@ -244,21 +244,21 @@ export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
 export const Listing$inboundSchema: z.ZodType<Listing, z.ZodTypeDef, unknown> =
   z.object({
     description: z.nullable(z.string()).optional(),
-    features: z.lazy(() => Features$inboundSchema),
-    floorPlanImages: z.array(ListingImage$inboundSchema),
-    images: z.array(ListingImage$inboundSchema),
-    listingId: z.string(),
-    priceChange: z.array(ListingPriceChange$inboundSchema),
-    pricing: z.lazy(() => Pricing$inboundSchema),
+    features: z.lazy(() => Features$inboundSchema).optional(),
+    floorPlanImages: z.array(ListingImage$inboundSchema).optional(),
+    images: z.array(ListingImage$inboundSchema).optional(),
+    listingId: z.string().optional(),
+    priceChange: z.array(ListingPriceChange$inboundSchema).optional(),
+    pricing: z.lazy(() => Pricing$inboundSchema).optional(),
     publishedDate: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
-    ),
+    ).optional(),
     removedDate: z.nullable(
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ).optional(),
-    seller: z.lazy(() => Seller$inboundSchema),
-    status: Status$inboundSchema,
-    type: Type$inboundSchema,
+    seller: z.lazy(() => Seller$inboundSchema).optional(),
+    status: Status$inboundSchema.optional(),
+    type: Type$inboundSchema.optional(),
   });
 
 export function listingFromJSON(

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

@@ -11,7 +11,7 @@ export type ListingImage = {
   /**
    * Image URL
    */
-  url: string;
+  url?: string | null | undefined;
 };
 
 /** @internal */
@@ -20,7 +20,7 @@ export const ListingImage$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  url: z.string(),
+  url: z.nullable(z.string()).optional(),
 });
 
 export function listingImageFromJSON(

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

@@ -25,23 +25,23 @@ export type ListingPriceChange = {
   /**
    * Amount of change in pence
    */
-  amount: number;
+  amount?: number | null | undefined;
   /**
    * Date of price change
    */
-  date: Date;
+  date?: Date | null | undefined;
   /**
    * Direction of price change
    */
-  direction: Direction;
+  direction?: Direction | undefined;
   /**
    * Percentage change
    */
-  percent: number;
+  percent?: number | null | undefined;
   /**
    * New price after change in pence
    */
-  price: number;
+  price?: number | null | undefined;
 };
 
 /** @internal */
@@ -54,11 +54,13 @@ export const ListingPriceChange$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  amount: z.number(),
-  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  direction: Direction$inboundSchema,
-  percent: z.number(),
-  price: z.number(),
+  amount: z.nullable(z.number()).optional(),
+  date: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  direction: Direction$inboundSchema.optional(),
+  percent: z.nullable(z.number()).optional(),
+  price: z.nullable(z.number()).optional(),
 });
 
 export function listingPriceChangeFromJSON(

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

@@ -56,15 +56,12 @@ export type MarketStatusSchemasStatus = ClosedEnum<
 >;
 
 export type StatusTimeline = {
-  /**
-   * Period end date
-   */
   end?: Date | null | undefined;
   /**
    * Period start date
    */
-  start: Date;
-  status: MarketStatusSchemasStatus;
+  start?: Date | undefined;
+  status?: MarketStatusSchemasStatus | undefined;
 };
 
 export const MarketStatusType = {
@@ -75,20 +72,14 @@ export type MarketStatusType = ClosedEnum<typeof MarketStatusType>;
 
 export type Timeline = {
   end?: Date | null | undefined;
-  start: Date;
+  start?: Date | undefined;
   status?: MarketStatusStatus | undefined;
   statusTimeline?: Array<StatusTimeline> | undefined;
-  type: MarketStatusType;
+  type?: MarketStatusType | undefined;
 };
 
 export type MarketStatus = {
-  /**
-   * Back on the market for sale
-   */
   backOTM?: boolean | null | undefined;
-  /**
-   * Back on the market for rent
-   */
   backOTMRent?: boolean | null | undefined;
   /**
    * Rental status
@@ -98,37 +89,16 @@ export type MarketStatus = {
    * Sale status
    */
   forSale?: ForSale | undefined;
-  /**
-   * Last date property was on the market for sale
-   */
   lastOTM?: Date | null | undefined;
-  /**
-   * Last date property was on the market for rent
-   */
   lastOTMRent?: Date | null | undefined;
-  /**
-   * Price per square foot
-   */
   pricePerSqft?: number | null | undefined;
-  /**
-   * Price per square metre
-   */
   pricePerSqm?: number | null | undefined;
-  /**
-   * Reserved date
-   */
   reservedDate?: Date | null | undefined;
-  /**
-   * Sold Subject To Contract date
-   */
   sstcDate?: Date | null | undefined;
   /**
    * Market timeline history
    */
   timeline?: Array<Timeline> | undefined;
-  /**
-   * Under offer date
-   */
   underOfferDate?: Date | null | undefined;
 };
 
@@ -159,8 +129,9 @@ export const StatusTimeline$inboundSchema: z.ZodType<
   end: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),
-  start: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  status: MarketStatusSchemasStatus$inboundSchema,
+  start: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  status: MarketStatusSchemasStatus$inboundSchema.optional(),
 });
 
 export function statusTimelineFromJSON(
@@ -187,11 +158,12 @@ export const Timeline$inboundSchema: z.ZodType<
   end: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),
-  start: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  start: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
   status: MarketStatusStatus$inboundSchema.optional(),
   statusTimeline: z.array(z.lazy(() => StatusTimeline$inboundSchema))
     .optional(),
-  type: MarketStatusType$inboundSchema,
+  type: MarketStatusType$inboundSchema.optional(),
 });
 
 export function timelineFromJSON(

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

@@ -8,40 +8,19 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-/**
- * Direction of price change
- */
 export const PriceChangeDirection = {
   Up: "up",
   Down: "down",
   Initial: "initial",
 } as const;
-/**
- * Direction of price change
- */
 export type PriceChangeDirection = ClosedEnum<typeof PriceChangeDirection>;
 
 export type PriceChange = {
-  /**
-   * Amount of change in pence
-   */
-  amount: number;
-  /**
-   * Date of price change
-   */
-  date: Date;
-  /**
-   * Direction of price change
-   */
-  direction: PriceChangeDirection;
-  /**
-   * Percentage change
-   */
-  percent: number;
-  /**
-   * New price after change in pence
-   */
-  price: number;
+  amount?: number | null | undefined;
+  date?: Date | null | undefined;
+  direction?: PriceChangeDirection | undefined;
+  percent?: number | null | undefined;
+  price?: number | null | undefined;
 };
 
 /** @internal */
@@ -55,11 +34,13 @@ export const PriceChange$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  amount: z.number(),
-  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  direction: PriceChangeDirection$inboundSchema,
-  percent: z.number(),
-  price: z.number(),
+  amount: z.nullable(z.number()).optional(),
+  date: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  direction: PriceChangeDirection$inboundSchema.optional(),
+  percent: z.nullable(z.number()).optional(),
+  price: z.nullable(z.number()).optional(),
 });
 
 export function priceChangeFromJSON(

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

@@ -8,25 +8,10 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PricingData = {
-  /**
-   * ISO currency code
-   */
-  currency?: string | undefined;
-  /**
-   * Current rental price per month in pence
-   */
+  currency?: string | null | undefined;
   currentRent?: number | null | undefined;
-  /**
-   * Current sale price in pence
-   */
   currentSale?: number | null | undefined;
-  /**
-   * Estimated rental value per month in pence
-   */
   estimatedRent?: number | null | undefined;
-  /**
-   * Estimated sale value in pence
-   */
   estimatedSale?: number | null | undefined;
 };
 
@@ -36,7 +21,7 @@ export const PricingData$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  currency: z.string().optional(),
+  currency: z.nullable(z.string()).optional(),
   currentRent: z.nullable(z.number()).optional(),
   currentSale: z.nullable(z.number()).optional(),
   estimatedRent: z.nullable(z.number()).optional(),

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

@@ -8,9 +8,6 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PropertyAddress = {
-  /**
-   * ISO country code
-   */
   country?: string | undefined;
   /**
    * Formatted display address
@@ -24,9 +21,6 @@ export type PropertyAddress = {
    * Postcode outcode
    */
   outcode?: string | undefined;
-  /**
-   * UK postcode
-   */
   postcode?: string | undefined;
   /**
    * Postcode without spaces