@vepler/sdk 0.1.0 → 1.9.9

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

@@ -4,19 +4,376 @@
 
 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";
 
+export const CouncilTaxBand = {
+  A: "A",
+  B: "B",
+  C: "C",
+  D: "D",
+  E: "E",
+  F: "F",
+  G: "G",
+  H: "H",
+  I: "I",
+} as const;
+export type CouncilTaxBand = ClosedEnum<typeof CouncilTaxBand>;
+
+export const EpcRating = {
+  A: "A",
+  B: "B",
+  C: "C",
+  D: "D",
+  E: "E",
+  F: "F",
+  G: "G",
+} as const;
+export type EpcRating = ClosedEnum<typeof EpcRating>;
+
+export const PropertyFiltersPropertyType = {
+  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;
+export type PropertyFiltersPropertyType = ClosedEnum<
+  typeof PropertyFiltersPropertyType
+>;
+
+export const RentStatus = {
+  Live: "live",
+  Reserved: "reserved",
+  Unavailable: "unavailable",
+} as const;
+export type RentStatus = ClosedEnum<typeof RentStatus>;
+
+export const SaleStatus = {
+  Live: "live",
+  Sstc: "sstc",
+  UnderOffer: "under_offer",
+  Unavailable: "unavailable",
+} as const;
+export type SaleStatus = ClosedEnum<typeof SaleStatus>;
+
+/**
+ * Property tags filter
+ */
+export type Tags = {
+  /**
+   * Filter for auction properties
+   */
+  auction?: boolean | undefined;
+  /**
+   * Filter for cash buyers only
+   */
+  cashBuyersOnly?: boolean | undefined;
+  /**
+   * Filter for chain free properties
+   */
+  chainFree?: boolean | undefined;
+  /**
+   * Filter for investment properties
+   */
+  investment?: boolean | undefined;
+  /**
+   * Filter for new builds
+   */
+  newBuild?: boolean | undefined;
+  /**
+   * Filter for retirement properties
+   */
+  retirement?: boolean | undefined;
+  /**
+   * Filter for shared ownership
+   */
+  sharedOwnership?: boolean | undefined;
+};
+
+export const Tenure = {
+  Freehold: "freehold",
+  Leasehold: "leasehold",
+  Unknown: "unknown",
+} as const;
+export type Tenure = ClosedEnum<typeof Tenure>;
+
+/**
+ * Property attribute filters
+ */
 export type PropertyFilters = {
+  /**
+   * Number of bathrooms (multiple values for OR search)
+   */
   baths?: Array<number> | undefined;
+  /**
+   * Number of bedrooms (multiple values for OR search)
+   */
   beds?: Array<number> | undefined;
-  epcRating?: Array<string> | undefined;
+  /**
+   * Council tax bands
+   */
+  councilTaxBand?: Array<CouncilTaxBand> | undefined;
+  /**
+   * Acceptable EPC ratings
+   */
+  epcRating?: Array<EpcRating> | undefined;
+  /**
+   * Maximum floor area in sqm
+   */
+  floorAreaMax?: number | undefined;
+  /**
+   * Minimum floor area in sqm
+   */
+  floorAreaMin?: number | undefined;
+  /**
+   * Maximum price in pence
+   */
   priceMax?: number | undefined;
+  /**
+   * Minimum price in pence
+   */
   priceMin?: number | undefined;
-  propertyType?: Array<string> | undefined;
-  tenure?: Array<string> | undefined;
+  /**
+   * Property types to include
+   */
+  propertyType?: Array<PropertyFiltersPropertyType> | undefined;
+  /**
+   * Maximum rent per month in pence
+   */
+  rentMax?: number | undefined;
+  /**
+   * Minimum rent per month in pence
+   */
+  rentMin?: number | undefined;
+  /**
+   * Rent status filter
+   */
+  rentStatus?: Array<RentStatus> | undefined;
+  /**
+   * Sale status filter
+   */
+  saleStatus?: Array<SaleStatus> | undefined;
+  /**
+   * Property tags filter
+   */
+  tags?: Tags | undefined;
+  /**
+   * Property tenure types
+   */
+  tenure?: Array<Tenure> | undefined;
+  /**
+   * Maximum year built
+   */
+  yearBuiltMax?: number | undefined;
+  /**
+   * Minimum year built
+   */
+  yearBuiltMin?: number | undefined;
+};
+
+/** @internal */
+export const CouncilTaxBand$inboundSchema: z.ZodNativeEnum<
+  typeof CouncilTaxBand
+> = z.nativeEnum(CouncilTaxBand);
+
+/** @internal */
+export const CouncilTaxBand$outboundSchema: z.ZodNativeEnum<
+  typeof CouncilTaxBand
+> = CouncilTaxBand$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CouncilTaxBand$ {
+  /** @deprecated use `CouncilTaxBand$inboundSchema` instead. */
+  export const inboundSchema = CouncilTaxBand$inboundSchema;
+  /** @deprecated use `CouncilTaxBand$outboundSchema` instead. */
+  export const outboundSchema = CouncilTaxBand$outboundSchema;
+}
+
+/** @internal */
+export const EpcRating$inboundSchema: z.ZodNativeEnum<typeof EpcRating> = z
+  .nativeEnum(EpcRating);
+
+/** @internal */
+export const EpcRating$outboundSchema: z.ZodNativeEnum<typeof EpcRating> =
+  EpcRating$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EpcRating$ {
+  /** @deprecated use `EpcRating$inboundSchema` instead. */
+  export const inboundSchema = EpcRating$inboundSchema;
+  /** @deprecated use `EpcRating$outboundSchema` instead. */
+  export const outboundSchema = EpcRating$outboundSchema;
+}
+
+/** @internal */
+export const PropertyFiltersPropertyType$inboundSchema: z.ZodNativeEnum<
+  typeof PropertyFiltersPropertyType
+> = z.nativeEnum(PropertyFiltersPropertyType);
+
+/** @internal */
+export const PropertyFiltersPropertyType$outboundSchema: z.ZodNativeEnum<
+  typeof PropertyFiltersPropertyType
+> = PropertyFiltersPropertyType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyFiltersPropertyType$ {
+  /** @deprecated use `PropertyFiltersPropertyType$inboundSchema` instead. */
+  export const inboundSchema = PropertyFiltersPropertyType$inboundSchema;
+  /** @deprecated use `PropertyFiltersPropertyType$outboundSchema` instead. */
+  export const outboundSchema = PropertyFiltersPropertyType$outboundSchema;
+}
+
+/** @internal */
+export const RentStatus$inboundSchema: z.ZodNativeEnum<typeof RentStatus> = z
+  .nativeEnum(RentStatus);
+
+/** @internal */
+export const RentStatus$outboundSchema: z.ZodNativeEnum<typeof RentStatus> =
+  RentStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RentStatus$ {
+  /** @deprecated use `RentStatus$inboundSchema` instead. */
+  export const inboundSchema = RentStatus$inboundSchema;
+  /** @deprecated use `RentStatus$outboundSchema` instead. */
+  export const outboundSchema = RentStatus$outboundSchema;
+}
+
+/** @internal */
+export const SaleStatus$inboundSchema: z.ZodNativeEnum<typeof SaleStatus> = z
+  .nativeEnum(SaleStatus);
+
+/** @internal */
+export const SaleStatus$outboundSchema: z.ZodNativeEnum<typeof SaleStatus> =
+  SaleStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SaleStatus$ {
+  /** @deprecated use `SaleStatus$inboundSchema` instead. */
+  export const inboundSchema = SaleStatus$inboundSchema;
+  /** @deprecated use `SaleStatus$outboundSchema` instead. */
+  export const outboundSchema = SaleStatus$outboundSchema;
+}
+
+/** @internal */
+export const Tags$inboundSchema: z.ZodType<Tags, z.ZodTypeDef, unknown> = z
+  .object({
+    auction: z.boolean().optional(),
+    cashBuyersOnly: z.boolean().optional(),
+    chainFree: z.boolean().optional(),
+    investment: z.boolean().optional(),
+    newBuild: z.boolean().optional(),
+    retirement: z.boolean().optional(),
+    sharedOwnership: z.boolean().optional(),
+  });
+
+/** @internal */
+export type Tags$Outbound = {
+  auction?: boolean | undefined;
+  cashBuyersOnly?: boolean | undefined;
+  chainFree?: boolean | undefined;
+  investment?: boolean | undefined;
+  newBuild?: boolean | undefined;
+  retirement?: boolean | undefined;
+  sharedOwnership?: boolean | undefined;
 };
 
+/** @internal */
+export const Tags$outboundSchema: z.ZodType<Tags$Outbound, z.ZodTypeDef, Tags> =
+  z.object({
+    auction: z.boolean().optional(),
+    cashBuyersOnly: z.boolean().optional(),
+    chainFree: z.boolean().optional(),
+    investment: z.boolean().optional(),
+    newBuild: z.boolean().optional(),
+    retirement: z.boolean().optional(),
+    sharedOwnership: 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 Tags$ {
+  /** @deprecated use `Tags$inboundSchema` instead. */
+  export const inboundSchema = Tags$inboundSchema;
+  /** @deprecated use `Tags$outboundSchema` instead. */
+  export const outboundSchema = Tags$outboundSchema;
+  /** @deprecated use `Tags$Outbound` instead. */
+  export type Outbound = Tags$Outbound;
+}
+
+export function tagsToJSON(tags: Tags): string {
+  return JSON.stringify(Tags$outboundSchema.parse(tags));
+}
+
+export function tagsFromJSON(
+  jsonString: string,
+): SafeParseResult<Tags, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Tags$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Tags' from JSON`,
+  );
+}
+
+/** @internal */
+export const Tenure$inboundSchema: z.ZodNativeEnum<typeof Tenure> = z
+  .nativeEnum(Tenure);
+
+/** @internal */
+export const Tenure$outboundSchema: z.ZodNativeEnum<typeof Tenure> =
+  Tenure$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Tenure$ {
+  /** @deprecated use `Tenure$inboundSchema` instead. */
+  export const inboundSchema = Tenure$inboundSchema;
+  /** @deprecated use `Tenure$outboundSchema` instead. */
+  export const outboundSchema = Tenure$outboundSchema;
+}
+
 /** @internal */
 export const PropertyFilters$inboundSchema: z.ZodType<
   PropertyFilters,
@@ -25,22 +382,42 @@ export const PropertyFilters$inboundSchema: z.ZodType<
 > = z.object({
   baths: z.array(z.number()).optional(),
   beds: z.array(z.number()).optional(),
-  epcRating: z.array(z.string()).optional(),
+  councilTaxBand: z.array(CouncilTaxBand$inboundSchema).optional(),
+  epcRating: z.array(EpcRating$inboundSchema).optional(),
+  floorAreaMax: z.number().optional(),
+  floorAreaMin: z.number().optional(),
   priceMax: z.number().optional(),
   priceMin: z.number().optional(),
-  propertyType: z.array(z.string()).optional(),
-  tenure: z.array(z.string()).optional(),
+  propertyType: z.array(PropertyFiltersPropertyType$inboundSchema).optional(),
+  rentMax: z.number().optional(),
+  rentMin: z.number().optional(),
+  rentStatus: z.array(RentStatus$inboundSchema).optional(),
+  saleStatus: z.array(SaleStatus$inboundSchema).optional(),
+  tags: z.lazy(() => Tags$inboundSchema).optional(),
+  tenure: z.array(Tenure$inboundSchema).optional(),
+  yearBuiltMax: z.number().optional(),
+  yearBuiltMin: z.number().optional(),
 });
 
 /** @internal */
 export type PropertyFilters$Outbound = {
   baths?: Array<number> | undefined;
   beds?: Array<number> | undefined;
+  councilTaxBand?: Array<string> | undefined;
   epcRating?: Array<string> | undefined;
+  floorAreaMax?: number | undefined;
+  floorAreaMin?: number | undefined;
   priceMax?: number | undefined;
   priceMin?: number | undefined;
   propertyType?: Array<string> | undefined;
+  rentMax?: number | undefined;
+  rentMin?: number | undefined;
+  rentStatus?: Array<string> | undefined;
+  saleStatus?: Array<string> | undefined;
+  tags?: Tags$Outbound | undefined;
   tenure?: Array<string> | undefined;
+  yearBuiltMax?: number | undefined;
+  yearBuiltMin?: number | undefined;
 };
 
 /** @internal */
@@ -51,11 +428,21 @@ export const PropertyFilters$outboundSchema: z.ZodType<
 > = z.object({
   baths: z.array(z.number()).optional(),
   beds: z.array(z.number()).optional(),
-  epcRating: z.array(z.string()).optional(),
+  councilTaxBand: z.array(CouncilTaxBand$outboundSchema).optional(),
+  epcRating: z.array(EpcRating$outboundSchema).optional(),
+  floorAreaMax: z.number().optional(),
+  floorAreaMin: z.number().optional(),
   priceMax: z.number().optional(),
   priceMin: z.number().optional(),
-  propertyType: z.array(z.string()).optional(),
-  tenure: z.array(z.string()).optional(),
+  propertyType: z.array(PropertyFiltersPropertyType$outboundSchema).optional(),
+  rentMax: z.number().optional(),
+  rentMin: z.number().optional(),
+  rentStatus: z.array(RentStatus$outboundSchema).optional(),
+  saleStatus: z.array(SaleStatus$outboundSchema).optional(),
+  tags: z.lazy(() => Tags$outboundSchema).optional(),
+  tenure: z.array(Tenure$outboundSchema).optional(),
+  yearBuiltMax: z.number().optional(),
+  yearBuiltMin: z.number().optional(),
 });
 
 /**

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

@@ -14,9 +14,26 @@ import {
 } from "./propertydata.js";
 
 export type PropertyListResponse = {
+  /**
+   * Indicates if more results are available
+   */
+  hasMore?: boolean | undefined;
+  /**
+   * Offset to use for next page of results
+   */
+  nextOffset?: number | undefined;
+  /**
+   * Array of property data objects
+   */
   result: Array<PropertyData>;
+  /**
+   * Number of properties returned in this response
+   */
   size: number;
   success: boolean;
+  /**
+   * Total number of properties matching the query
+   */
   totalSize: number;
 };
 
@@ -26,6 +43,8 @@ export const PropertyListResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  hasMore: z.boolean().optional(),
+  nextOffset: z.number().optional(),
   result: z.array(PropertyData$inboundSchema),
   size: z.number(),
   success: z.boolean(),
@@ -34,6 +53,8 @@ export const PropertyListResponse$inboundSchema: z.ZodType<
 
 /** @internal */
 export type PropertyListResponse$Outbound = {
+  hasMore?: boolean | undefined;
+  nextOffset?: number | undefined;
   result: Array<PropertyData$Outbound>;
   size: number;
   success: boolean;
@@ -46,6 +67,8 @@ export const PropertyListResponse$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PropertyListResponse
 > = z.object({
+  hasMore: z.boolean().optional(),
+  nextOffset: z.number().optional(),
   result: z.array(PropertyData$outboundSchema),
   size: z.number(),
   success: z.boolean(),

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

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PropertyOnStreet = {
+  /**
+   * Primary addressable object start number
+   */
+  paoStartNumber?: number | undefined;
+  /**
+   * Primary addressable object text
+   */
+  paoText?: string | undefined;
+  /**
+   * Secondary addressable object start number
+   */
+  saoStartNumber?: number | undefined;
+  /**
+   * Secondary addressable object text
+   */
+  saoText?: string | undefined;
+  /**
+   * Unique Property Reference Number
+   */
+  uprn: number;
+};
+
+/** @internal */
+export const PropertyOnStreet$inboundSchema: z.ZodType<
+  PropertyOnStreet,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  paoStartNumber: z.number().optional(),
+  paoText: z.string().optional(),
+  saoStartNumber: z.number().optional(),
+  saoText: z.string().optional(),
+  uprn: z.number(),
+});
+
+/** @internal */
+export type PropertyOnStreet$Outbound = {
+  paoStartNumber?: number | undefined;
+  paoText?: string | undefined;
+  saoStartNumber?: number | undefined;
+  saoText?: string | undefined;
+  uprn: number;
+};
+
+/** @internal */
+export const PropertyOnStreet$outboundSchema: z.ZodType<
+  PropertyOnStreet$Outbound,
+  z.ZodTypeDef,
+  PropertyOnStreet
+> = z.object({
+  paoStartNumber: z.number().optional(),
+  paoText: z.string().optional(),
+  saoStartNumber: z.number().optional(),
+  saoText: z.string().optional(),
+  uprn: z.number(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyOnStreet$ {
+  /** @deprecated use `PropertyOnStreet$inboundSchema` instead. */
+  export const inboundSchema = PropertyOnStreet$inboundSchema;
+  /** @deprecated use `PropertyOnStreet$outboundSchema` instead. */
+  export const outboundSchema = PropertyOnStreet$outboundSchema;
+  /** @deprecated use `PropertyOnStreet$Outbound` instead. */
+  export type Outbound = PropertyOnStreet$Outbound;
+}
+
+export function propertyOnStreetToJSON(
+  propertyOnStreet: PropertyOnStreet,
+): string {
+  return JSON.stringify(
+    PropertyOnStreet$outboundSchema.parse(propertyOnStreet),
+  );
+}
+
+export function propertyOnStreetFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyOnStreet, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyOnStreet$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyOnStreet' from JSON`,
+  );
+}