@vepler/sdk 2.0.0 → 2.3.0

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

@@ -8,37 +8,41 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export const Type = {
+export const PropertyMultiPolygonAreaFilterType = {
   Multipolygon: "multipolygon",
 } as const;
-export type Type = ClosedEnum<typeof Type>;
+export type PropertyMultiPolygonAreaFilterType = ClosedEnum<
+  typeof PropertyMultiPolygonAreaFilterType
+>;
 
 export type PropertyMultiPolygonAreaFilter = {
   /**
    * Array of multipolygon coordinates
    */
   coordinates: Array<Array<Array<Array<number>>>>;
-  type: Type;
+  type: PropertyMultiPolygonAreaFilterType;
 };
 
 /** @internal */
-export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
-  Type,
-);
+export const PropertyMultiPolygonAreaFilterType$inboundSchema: z.ZodNativeEnum<
+  typeof PropertyMultiPolygonAreaFilterType
+> = z.nativeEnum(PropertyMultiPolygonAreaFilterType);
 
 /** @internal */
-export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
-  Type$inboundSchema;
+export const PropertyMultiPolygonAreaFilterType$outboundSchema: z.ZodNativeEnum<
+  typeof PropertyMultiPolygonAreaFilterType
+> = PropertyMultiPolygonAreaFilterType$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 namespace PropertyMultiPolygonAreaFilterType$ {
+  /** @deprecated use `PropertyMultiPolygonAreaFilterType$inboundSchema` instead. */
+  export const inboundSchema = PropertyMultiPolygonAreaFilterType$inboundSchema;
+  /** @deprecated use `PropertyMultiPolygonAreaFilterType$outboundSchema` instead. */
+  export const outboundSchema =
+    PropertyMultiPolygonAreaFilterType$outboundSchema;
 }
 
 /** @internal */
@@ -48,7 +52,7 @@ export const PropertyMultiPolygonAreaFilter$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   coordinates: z.array(z.array(z.array(z.array(z.number())))),
-  type: Type$inboundSchema,
+  type: PropertyMultiPolygonAreaFilterType$inboundSchema,
 });
 
 /** @internal */
@@ -64,7 +68,7 @@ export const PropertyMultiPolygonAreaFilter$outboundSchema: z.ZodType<
   PropertyMultiPolygonAreaFilter
 > = z.object({
   coordinates: z.array(z.array(z.array(z.array(z.number())))),
-  type: Type$outboundSchema,
+  type: PropertyMultiPolygonAreaFilterType$outboundSchema,
 });
 
 /**

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

@@ -39,13 +39,13 @@ export const Field = {
   PricingCurrentSale: "pricing.currentSale",
   PricingCurrentRent: "pricing.currentRent",
   PricingPredictedPrice: "pricing.predictedPrice",
-  PricingPricePerSqft: "pricing.pricePerSqft",
+  MarketStatusPricePerSqft: "marketStatus.pricePerSqft",
+  MarketStatusPricePerSqm: "marketStatus.pricePerSqm",
   RoomDetailsBeds: "roomDetails.beds",
   RoomDetailsBaths: "roomDetails.baths",
-  RoomDetailsReceptions: "roomDetails.receptions",
   BuildTotalFloorArea: "build.totalFloorArea",
   BuildPlotSize: "build.plotSize",
-  BuildYearBuilt: "build.yearBuilt",
+  BuildConstructionAgeMidYear: "build.constructionAge.midYear",
   Score: "_score",
   Doc: "_doc",
 } as const;

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

@@ -8,34 +8,58 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PropertyTags = {
+  /**
+   * Property has agricultural tie restriction
+   */
+  agriculturalTie: boolean;
   /**
    * Is this property being sold at auction
    */
-  auction?: boolean | undefined;
+  auction: boolean;
+  /**
+   * Below Market Value property
+   */
+  bmv: boolean;
   /**
    * Cash buyers only
    */
-  cashBuyersOnly?: boolean | undefined;
+  cashBuyers: boolean;
   /**
    * Is this property chain free
    */
-  chainFree?: boolean | undefined;
+  chainFree: boolean;
+  /**
+   * House in Multiple Occupation
+   */
+  hmo: boolean;
   /**
-   * Investment opportunity
+   * Property in negative equity
    */
-  investment?: boolean | undefined;
+  negativeEquity: boolean;
   /**
-   * Is this a new build property
+   * Is this a new build scheme property
    */
-  newBuild?: boolean | undefined;
+  newBuildScheme: boolean;
+  /**
+   * Quick sale property
+   */
+  quickSale: boolean;
   /**
    * Is this a retirement property
    */
-  retirement?: boolean | undefined;
+  retirement: boolean;
   /**
    * Is this a shared ownership property
    */
-  sharedOwnership?: boolean | undefined;
+  sharedOwnership: boolean;
+  /**
+   * Property is slow to sell
+   */
+  slowToSell: boolean;
+  /**
+   * Property is unmodernised
+   */
+  unmodernised: boolean;
 };
 
 /** @internal */
@@ -44,24 +68,36 @@ export const PropertyTags$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  auction: z.boolean().default(false),
-  cashBuyersOnly: z.boolean().default(false),
-  chainFree: z.boolean().default(false),
-  investment: z.boolean().default(false),
-  newBuild: z.boolean().default(false),
-  retirement: z.boolean().default(false),
-  sharedOwnership: z.boolean().default(false),
+  agriculturalTie: z.boolean(),
+  auction: z.boolean(),
+  bmv: z.boolean(),
+  cashBuyers: z.boolean(),
+  chainFree: z.boolean(),
+  hmo: z.boolean(),
+  negativeEquity: z.boolean(),
+  newBuildScheme: z.boolean(),
+  quickSale: z.boolean(),
+  retirement: z.boolean(),
+  sharedOwnership: z.boolean(),
+  slowToSell: z.boolean(),
+  unmodernised: z.boolean(),
 });
 
 /** @internal */
 export type PropertyTags$Outbound = {
+  agriculturalTie: boolean;
   auction: boolean;
-  cashBuyersOnly: boolean;
+  bmv: boolean;
+  cashBuyers: boolean;
   chainFree: boolean;
-  investment: boolean;
-  newBuild: boolean;
+  hmo: boolean;
+  negativeEquity: boolean;
+  newBuildScheme: boolean;
+  quickSale: boolean;
   retirement: boolean;
   sharedOwnership: boolean;
+  slowToSell: boolean;
+  unmodernised: boolean;
 };
 
 /** @internal */
@@ -70,13 +106,19 @@ export const PropertyTags$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PropertyTags
 > = z.object({
-  auction: z.boolean().default(false),
-  cashBuyersOnly: z.boolean().default(false),
-  chainFree: z.boolean().default(false),
-  investment: z.boolean().default(false),
-  newBuild: z.boolean().default(false),
-  retirement: z.boolean().default(false),
-  sharedOwnership: z.boolean().default(false),
+  agriculturalTie: z.boolean(),
+  auction: z.boolean(),
+  bmv: z.boolean(),
+  cashBuyers: z.boolean(),
+  chainFree: z.boolean(),
+  hmo: z.boolean(),
+  negativeEquity: z.boolean(),
+  newBuildScheme: z.boolean(),
+  quickSale: z.boolean(),
+  retirement: z.boolean(),
+  sharedOwnership: z.boolean(),
+  slowToSell: z.boolean(),
+  unmodernised: z.boolean(),
 });
 
 /**

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

@@ -0,0 +1,102 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Size of refurbishment required
+ */
+export const RefurbSize = {
+  Small: "small",
+  Medium: "medium",
+  Large: "large",
+} as const;
+/**
+ * Size of refurbishment required
+ */
+export type RefurbSize = ClosedEnum<typeof RefurbSize>;
+
+export type RefurbishmentData = {
+  /**
+   * Size of refurbishment required
+   */
+  refurbSize?: RefurbSize | null | undefined;
+};
+
+/** @internal */
+export const RefurbSize$inboundSchema: z.ZodNativeEnum<typeof RefurbSize> = z
+  .nativeEnum(RefurbSize);
+
+/** @internal */
+export const RefurbSize$outboundSchema: z.ZodNativeEnum<typeof RefurbSize> =
+  RefurbSize$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RefurbSize$ {
+  /** @deprecated use `RefurbSize$inboundSchema` instead. */
+  export const inboundSchema = RefurbSize$inboundSchema;
+  /** @deprecated use `RefurbSize$outboundSchema` instead. */
+  export const outboundSchema = RefurbSize$outboundSchema;
+}
+
+/** @internal */
+export const RefurbishmentData$inboundSchema: z.ZodType<
+  RefurbishmentData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  refurbSize: z.nullable(RefurbSize$inboundSchema).optional(),
+});
+
+/** @internal */
+export type RefurbishmentData$Outbound = {
+  refurbSize?: string | null | undefined;
+};
+
+/** @internal */
+export const RefurbishmentData$outboundSchema: z.ZodType<
+  RefurbishmentData$Outbound,
+  z.ZodTypeDef,
+  RefurbishmentData
+> = z.object({
+  refurbSize: z.nullable(RefurbSize$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 RefurbishmentData$ {
+  /** @deprecated use `RefurbishmentData$inboundSchema` instead. */
+  export const inboundSchema = RefurbishmentData$inboundSchema;
+  /** @deprecated use `RefurbishmentData$outboundSchema` instead. */
+  export const outboundSchema = RefurbishmentData$outboundSchema;
+  /** @deprecated use `RefurbishmentData$Outbound` instead. */
+  export type Outbound = RefurbishmentData$Outbound;
+}
+
+export function refurbishmentDataToJSON(
+  refurbishmentData: RefurbishmentData,
+): string {
+  return JSON.stringify(
+    RefurbishmentData$outboundSchema.parse(refurbishmentData),
+  );
+}
+
+export function refurbishmentDataFromJSON(
+  jsonString: string,
+): SafeParseResult<RefurbishmentData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RefurbishmentData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RefurbishmentData' from JSON`,
+  );
+}

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

@@ -11,15 +11,11 @@ export type RoomDetails = {
   /**
    * Number of bathrooms
    */
-  baths?: number | undefined;
+  baths?: number | null | undefined;
   /**
    * Number of bedrooms
    */
-  beds?: number | undefined;
-  /**
-   * Number of reception rooms
-   */
-  receptions?: number | undefined;
+  beds?: number | null | undefined;
 };
 
 /** @internal */
@@ -28,16 +24,14 @@ export const RoomDetails$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  baths: z.number().optional(),
-  beds: z.number().optional(),
-  receptions: z.number().optional(),
+  baths: z.nullable(z.number()).optional(),
+  beds: z.nullable(z.number()).optional(),
 });
 
 /** @internal */
 export type RoomDetails$Outbound = {
-  baths?: number | undefined;
-  beds?: number | undefined;
-  receptions?: number | undefined;
+  baths?: number | null | undefined;
+  beds?: number | null | undefined;
 };
 
 /** @internal */
@@ -46,9 +40,8 @@ export const RoomDetails$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RoomDetails
 > = z.object({
-  baths: z.number().optional(),
-  beds: z.number().optional(),
-  receptions: z.number().optional(),
+  baths: z.nullable(z.number()).optional(),
+  beds: z.nullable(z.number()).optional(),
 });
 
 /**

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

@@ -9,21 +9,17 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SaleRecord = {
   /**
-   * Sale completion date
-   */
-  date: string;
-  /**
-   * Was a new build at time of sale
+   * Sale price in pence
    */
-  newBuild?: boolean | undefined;
+  amount: number;
   /**
-   * Sale price in pence
+   * Sale completion date
    */
-  price: number;
+  date: Date;
   /**
-   * Property type at time of sale
+   * Source identifier for this sale record
    */
-  propertyType?: string | undefined;
+  sourceId: string;
 };
 
 /** @internal */
@@ -32,18 +28,16 @@ export const SaleRecord$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  date: z.string(),
-  newBuild: z.boolean().optional(),
-  price: z.number(),
-  propertyType: z.string().optional(),
+  amount: z.number(),
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  sourceId: z.string(),
 });
 
 /** @internal */
 export type SaleRecord$Outbound = {
+  amount: number;
   date: string;
-  newBuild?: boolean | undefined;
-  price: number;
-  propertyType?: string | undefined;
+  sourceId: string;
 };
 
 /** @internal */
@@ -52,10 +46,9 @@ export const SaleRecord$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SaleRecord
 > = z.object({
-  date: z.string(),
-  newBuild: z.boolean().optional(),
-  price: z.number(),
-  propertyType: z.string().optional(),
+  amount: z.number(),
+  date: z.date().transform(v => v.toISOString()),
+  sourceId: z.string(),
 });
 
 /**

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

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type TenancyData = {
+  /**
+   * Confidence score for tenancy status
+   */
+  confidenceScore: number;
+  /**
+   * Whether property is currently tenanted
+   */
+  isTenanted?: boolean | null | undefined;
+};
+
+/** @internal */
+export const TenancyData$inboundSchema: z.ZodType<
+  TenancyData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  confidenceScore: z.number(),
+  isTenanted: z.nullable(z.boolean()).optional(),
+});
+
+/** @internal */
+export type TenancyData$Outbound = {
+  confidenceScore: number;
+  isTenanted?: boolean | null | undefined;
+};
+
+/** @internal */
+export const TenancyData$outboundSchema: z.ZodType<
+  TenancyData$Outbound,
+  z.ZodTypeDef,
+  TenancyData
+> = z.object({
+  confidenceScore: z.number(),
+  isTenanted: z.nullable(z.boolean()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TenancyData$ {
+  /** @deprecated use `TenancyData$inboundSchema` instead. */
+  export const inboundSchema = TenancyData$inboundSchema;
+  /** @deprecated use `TenancyData$outboundSchema` instead. */
+  export const outboundSchema = TenancyData$outboundSchema;
+  /** @deprecated use `TenancyData$Outbound` instead. */
+  export type Outbound = TenancyData$Outbound;
+}
+
+export function tenancyDataToJSON(tenancyData: TenancyData): string {
+  return JSON.stringify(TenancyData$outboundSchema.parse(tenancyData));
+}
+
+export function tenancyDataFromJSON(
+  jsonString: string,
+): SafeParseResult<TenancyData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TenancyData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TenancyData' from JSON`,
+  );
+}

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

@@ -22,22 +22,10 @@ export const TenureDataType = {
 export type TenureDataType = ClosedEnum<typeof TenureDataType>;
 
 export type TenureData = {
-  /**
-   * Annual ground rent in pence
-   */
-  groundRent?: number | undefined;
-  /**
-   * Years remaining on lease
-   */
-  leaseYearsRemaining?: number | undefined;
-  /**
-   * Annual service charge in pence
-   */
-  serviceCharge?: number | undefined;
   /**
    * Property tenure type
    */
-  type?: TenureDataType | undefined;
+  type?: TenureDataType | null | undefined;
 };
 
 /** @internal */
@@ -67,18 +55,12 @@ export const TenureData$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  groundRent: z.number().optional(),
-  leaseYearsRemaining: z.number().optional(),
-  serviceCharge: z.number().optional(),
-  type: TenureDataType$inboundSchema.optional(),
+  type: z.nullable(TenureDataType$inboundSchema).optional(),
 });
 
 /** @internal */
 export type TenureData$Outbound = {
-  groundRent?: number | undefined;
-  leaseYearsRemaining?: number | undefined;
-  serviceCharge?: number | undefined;
-  type?: string | undefined;
+  type?: string | null | undefined;
 };
 
 /** @internal */
@@ -87,10 +69,7 @@ export const TenureData$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TenureData
 > = z.object({
-  groundRent: z.number().optional(),
-  leaseYearsRemaining: z.number().optional(),
-  serviceCharge: z.number().optional(),
-  type: TenureDataType$outboundSchema.optional(),
+  type: z.nullable(TenureDataType$outboundSchema).optional(),
 });
 
 /**