@vepler/sdk 2.133.0 → 2.137.0

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

@@ -0,0 +1,439 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AdvancedListingAddress,
+  AdvancedListingAddress$inboundSchema,
+} from "./advancedlistingaddress.js";
+import {
+  AdvancedListingBuild,
+  AdvancedListingBuild$inboundSchema,
+} from "./advancedlistingbuild.js";
+import {
+  AdvancedListingEnergyRating,
+  AdvancedListingEnergyRating$inboundSchema,
+} from "./advancedlistingenergyrating.js";
+import {
+  AdvancedListingPricing,
+  AdvancedListingPricing$inboundSchema,
+} from "./advancedlistingpricing.js";
+import {
+  AdvancedListingRoomDetails,
+  AdvancedListingRoomDetails$inboundSchema,
+} from "./advancedlistingroomdetails.js";
+import {
+  AdvancedListingSaleHistory,
+  AdvancedListingSaleHistory$inboundSchema,
+} from "./advancedlistingsalehistory.js";
+import {
+  AdvancedListingSeller,
+  AdvancedListingSeller$inboundSchema,
+} from "./advancedlistingseller.js";
+import {
+  AdvancedListingStatusHistory,
+  AdvancedListingStatusHistory$inboundSchema,
+} from "./advancedlistingstatushistory.js";
+import {
+  AdvancedListingTenure,
+  AdvancedListingTenure$inboundSchema,
+} from "./advancedlistingtenure.js";
+
+/**
+ * A structured key-value property feature extracted from the listing. Features capture specific property attributes such as tenure, EPC rating, parking arrangements, and amenities.
+ */
+export type Features = {
+  /**
+   * Normalised feature identifier key. Common values include: 'parking', 'garden', 'garage', 'central_heating', 'double_glazing', 'epc_rating', 'council_tax_band', 'tenure', 'chain_free', 'conservatory', 'fireplace'. The set of available feature IDs varies by data provider and is not strictly enumerated — treat as a free-form key.
+   */
+  featureId: string;
+  /**
+   * Human-readable feature value as stated by the agent. For boolean-style features this may be 'Yes'/'No'; for categorical features it contains the specific value (e.g. 'Band D' for council_tax_band, 'C' for epc_rating, 'Freehold' for tenure).
+   */
+  value: string;
+};
+
+/**
+ * Classification of the image asset. 'standard': property photography (exterior, rooms, garden, etc.). 'floorplan': annotated floor plan diagram with room dimensions. 'epc': Energy Performance Certificate chart or graph image. 'brochure': marketing brochure page scan or PDF-derived image.
+ */
+export const AdvancedListingType = {
+  Standard: "standard",
+  Floorplan: "floorplan",
+  Epc: "epc",
+  Brochure: "brochure",
+} as const;
+/**
+ * Classification of the image asset. 'standard': property photography (exterior, rooms, garden, etc.). 'floorplan': annotated floor plan diagram with room dimensions. 'epc': Energy Performance Certificate chart or graph image. 'brochure': marketing brochure page scan or PDF-derived image.
+ */
+export type AdvancedListingType = OpenEnum<typeof AdvancedListingType>;
+
+/**
+ * A single image asset associated with a property listing. Images are sourced from property portal CDNs and are publicly accessible.
+ */
+export type FloorPlanImages = {
+  /**
+   * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
+   */
+  caption?: string | undefined;
+  /**
+   * Zero-based display order for the image within its type group. The first image (order 0) is typically the hero/primary image used for thumbnails and search results.
+   */
+  order?: number | undefined;
+  /**
+   * Classification of the image asset. 'standard': property photography (exterior, rooms, garden, etc.). 'floorplan': annotated floor plan diagram with room dimensions. 'epc': Energy Performance Certificate chart or graph image. 'brochure': marketing brochure page scan or PDF-derived image.
+   */
+  type?: AdvancedListingType | undefined;
+  /**
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
+   */
+  url: string;
+};
+
+/**
+ * Classification of the image asset. 'standard': property photography (exterior, rooms, garden, etc.). 'floorplan': annotated floor plan diagram with room dimensions. 'epc': Energy Performance Certificate chart or graph image. 'brochure': marketing brochure page scan or PDF-derived image.
+ */
+export const AdvancedListingSchemasType = {
+  Standard: "standard",
+  Floorplan: "floorplan",
+  Epc: "epc",
+  Brochure: "brochure",
+} as const;
+/**
+ * Classification of the image asset. 'standard': property photography (exterior, rooms, garden, etc.). 'floorplan': annotated floor plan diagram with room dimensions. 'epc': Energy Performance Certificate chart or graph image. 'brochure': marketing brochure page scan or PDF-derived image.
+ */
+export type AdvancedListingSchemasType = OpenEnum<
+  typeof AdvancedListingSchemasType
+>;
+
+/**
+ * A single image asset associated with a property listing. Images are sourced from property portal CDNs and are publicly accessible.
+ */
+export type Images = {
+  /**
+   * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
+   */
+  caption?: string | undefined;
+  /**
+   * Zero-based display order for the image within its type group. The first image (order 0) is typically the hero/primary image used for thumbnails and search results.
+   */
+  order?: number | undefined;
+  /**
+   * Classification of the image asset. 'standard': property photography (exterior, rooms, garden, etc.). 'floorplan': annotated floor plan diagram with room dimensions. 'epc': Energy Performance Certificate chart or graph image. 'brochure': marketing brochure page scan or PDF-derived image.
+   */
+  type?: AdvancedListingSchemasType | undefined;
+  /**
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
+   */
+  url: string;
+};
+
+/**
+ * Geographic coordinates of the property.
+ */
+export type Spatial = {
+  /**
+   * WGS84 latitude in decimal degrees.
+   */
+  lat: number | null;
+  /**
+   * WGS84 longitude in decimal degrees.
+   */
+  lon: number | null;
+};
+
+/**
+ * Current listing status. 'live': actively marketed. 'sstc': sold subject to contract. 'under_offer': an offer has been accepted but not yet to contract. 'reserved': reserved (commonly new-build). 'sold': sale completed. 'removed': withdrawn or no longer present in the source feed.
+ */
+export const Status = {
+  Live: "live",
+  Removed: "removed",
+  Sstc: "sstc",
+  UnderOffer: "under_offer",
+  Sold: "sold",
+  Reserved: "reserved",
+} as const;
+/**
+ * Current listing status. 'live': actively marketed. 'sstc': sold subject to contract. 'under_offer': an offer has been accepted but not yet to contract. 'reserved': reserved (commonly new-build). 'sold': sale completed. 'removed': withdrawn or no longer present in the source feed.
+ */
+export type Status = OpenEnum<typeof Status>;
+
+/**
+ * Market type for the listing. 'sale': property is listed for purchase — the price field represents the asking price in GBP pence. 'rent': property is listed for tenancy — the price field represents the monthly rental amount in GBP pence (per calendar month).
+ */
+export const Type = {
+  Sale: "sale",
+  Rent: "rent",
+} as const;
+/**
+ * Market type for the listing. 'sale': property is listed for purchase — the price field represents the asking price in GBP pence. 'rent': property is listed for tenancy — the price field represents the monthly rental amount in GBP pence (per calendar month).
+ */
+export type Type = OpenEnum<typeof Type>;
+
+/**
+ * An aggregated property listing document, combining data from all available sources for the property. All monetary values are in GBP pounds.
+ */
+export type AdvancedListing = {
+  address?: AdvancedListingAddress | undefined;
+  build?: AdvancedListingBuild | undefined;
+  /**
+   * Key feature bullet points.
+   */
+  bullets?: Array<string> | undefined;
+  /**
+   * Marketing description.
+   */
+  description?: string | null | undefined;
+  /**
+   * Joint-extraction envelopes keyed by extractor id.
+   */
+  descriptors?: { [k: string]: any } | undefined;
+  energyRating?: AdvancedListingEnergyRating | undefined;
+  /**
+   * Structured property features.
+   */
+  features?: Array<Features> | undefined;
+  /**
+   * Floor plan images.
+   */
+  floorPlanImages?: Array<FloorPlanImages> | undefined;
+  /**
+   * System-generated listing identifier.
+   */
+  id: string;
+  /**
+   * Property photography (URLs are served via the provider CDN proxy).
+   */
+  images?: Array<Images> | undefined;
+  /**
+   * Sold via auction.
+   */
+  isAuction?: boolean | undefined;
+  /**
+   * Newly constructed, not previously occupied.
+   */
+  isNewBuild?: boolean | undefined;
+  /**
+   * Age-restricted retirement property.
+   */
+  isRetirement?: boolean | undefined;
+  /**
+   * Offered under shared ownership.
+   */
+  isSharedOwnership?: boolean | undefined;
+  /**
+   * Source reference within the provider (permission-gated).
+   */
+  key?: string | undefined;
+  /**
+   * Internal location identifier (derived from postcode).
+   */
+  locationId?: string | null | undefined;
+  pricing?: AdvancedListingPricing | undefined;
+  /**
+   * Identifier of the physical property this listing maps to.
+   */
+  propertyId?: string | null | undefined;
+  /**
+   * Internal data provider identifier (permission-gated).
+   */
+  provider?: string | undefined;
+  /**
+   * When the listing first appeared on the source.
+   */
+  publishedDate?: Date | undefined;
+  /**
+   * When the listing was removed from the source, if applicable.
+   */
+  removedDate?: Date | null | undefined;
+  roomDetails?: AdvancedListingRoomDetails | undefined;
+  /**
+   * Historic sale records.
+   */
+  saleHistory?: Array<AdvancedListingSaleHistory> | undefined;
+  seller?: AdvancedListingSeller | undefined;
+  /**
+   * Data sources contributing to this document.
+   */
+  sources?: Array<string> | undefined;
+  /**
+   * Geographic coordinates of the property.
+   */
+  spatial?: Spatial | null | undefined;
+  /**
+   * Current listing status. 'live': actively marketed. 'sstc': sold subject to contract. 'under_offer': an offer has been accepted but not yet to contract. 'reserved': reserved (commonly new-build). 'sold': sale completed. 'removed': withdrawn or no longer present in the source feed.
+   */
+  status: Status;
+  /**
+   * History of status transitions.
+   */
+  statusHistory?: Array<AdvancedListingStatusHistory> | undefined;
+  /**
+   * Boolean classification flags.
+   */
+  tags?: { [k: string]: boolean } | undefined;
+  tenure?: AdvancedListingTenure | undefined;
+  /**
+   * Market type for the listing. 'sale': property is listed for purchase — the price field represents the asking price in GBP pence. 'rent': property is listed for tenancy — the price field represents the monthly rental amount in GBP pence (per calendar month).
+   */
+  type: Type;
+};
+
+/** @internal */
+export const Features$inboundSchema: z.ZodType<
+  Features,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  featureId: z.string(),
+  value: z.string(),
+});
+
+export function featuresFromJSON(
+  jsonString: string,
+): SafeParseResult<Features, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Features$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Features' from JSON`,
+  );
+}
+
+/** @internal */
+export const AdvancedListingType$inboundSchema: z.ZodType<
+  AdvancedListingType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AdvancedListingType);
+
+/** @internal */
+export const FloorPlanImages$inboundSchema: z.ZodType<
+  FloorPlanImages,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  caption: z.string().optional(),
+  order: z.number().optional(),
+  type: AdvancedListingType$inboundSchema.optional(),
+  url: z.string(),
+});
+
+export function floorPlanImagesFromJSON(
+  jsonString: string,
+): SafeParseResult<FloorPlanImages, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FloorPlanImages$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FloorPlanImages' from JSON`,
+  );
+}
+
+/** @internal */
+export const AdvancedListingSchemasType$inboundSchema: z.ZodType<
+  AdvancedListingSchemasType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AdvancedListingSchemasType);
+
+/** @internal */
+export const Images$inboundSchema: z.ZodType<Images, z.ZodTypeDef, unknown> = z
+  .object({
+    caption: z.string().optional(),
+    order: z.number().optional(),
+    type: AdvancedListingSchemasType$inboundSchema.optional(),
+    url: z.string(),
+  });
+
+export function imagesFromJSON(
+  jsonString: string,
+): SafeParseResult<Images, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Images$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Images' from JSON`,
+  );
+}
+
+/** @internal */
+export const Spatial$inboundSchema: z.ZodType<Spatial, z.ZodTypeDef, unknown> =
+  z.object({
+    lat: z.nullable(z.number()),
+    lon: z.nullable(z.number()),
+  });
+
+export function spatialFromJSON(
+  jsonString: string,
+): SafeParseResult<Spatial, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Spatial$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Spatial' from JSON`,
+  );
+}
+
+/** @internal */
+export const Status$inboundSchema: z.ZodType<Status, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Status);
+
+/** @internal */
+export const Type$inboundSchema: z.ZodType<Type, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Type);
+
+/** @internal */
+export const AdvancedListing$inboundSchema: z.ZodType<
+  AdvancedListing,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address: AdvancedListingAddress$inboundSchema.optional(),
+  build: AdvancedListingBuild$inboundSchema.optional(),
+  bullets: z.array(z.string()).optional(),
+  description: z.nullable(z.string()).optional(),
+  descriptors: z.record(z.any()).optional(),
+  energyRating: AdvancedListingEnergyRating$inboundSchema.optional(),
+  features: z.array(z.lazy(() => Features$inboundSchema)).optional(),
+  floorPlanImages: z.array(z.lazy(() => FloorPlanImages$inboundSchema))
+    .optional(),
+  id: z.string(),
+  images: z.array(z.lazy(() => Images$inboundSchema)).optional(),
+  isAuction: z.boolean().optional(),
+  isNewBuild: z.boolean().optional(),
+  isRetirement: z.boolean().optional(),
+  isSharedOwnership: z.boolean().optional(),
+  key: z.string().optional(),
+  locationId: z.nullable(z.string()).optional(),
+  pricing: AdvancedListingPricing$inboundSchema.optional(),
+  propertyId: z.nullable(z.string()).optional(),
+  provider: z.string().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(),
+  roomDetails: AdvancedListingRoomDetails$inboundSchema.optional(),
+  saleHistory: z.array(AdvancedListingSaleHistory$inboundSchema).optional(),
+  seller: AdvancedListingSeller$inboundSchema.optional(),
+  sources: z.array(z.string()).optional(),
+  spatial: z.nullable(z.lazy(() => Spatial$inboundSchema)).optional(),
+  status: Status$inboundSchema,
+  statusHistory: z.array(AdvancedListingStatusHistory$inboundSchema).optional(),
+  tags: z.record(z.boolean()).optional(),
+  tenure: AdvancedListingTenure$inboundSchema.optional(),
+  type: Type$inboundSchema,
+});
+
+export function advancedListingFromJSON(
+  jsonString: string,
+): SafeParseResult<AdvancedListing, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdvancedListing$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdvancedListing' from JSON`,
+  );
+}

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

@@ -0,0 +1,49 @@
+/*
+ * 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 AdvancedListingAddress = {
+  /**
+   * Pre-formatted public-facing address.
+   */
+  displayAddress?: string | null | undefined;
+  /**
+   * Postcode incode.
+   */
+  incode: string | null;
+  /**
+   * Postcode outcode.
+   */
+  outcode: string | null;
+  /**
+   * Full postcode.
+   */
+  postcode: string | null;
+};
+
+/** @internal */
+export const AdvancedListingAddress$inboundSchema: z.ZodType<
+  AdvancedListingAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  displayAddress: z.nullable(z.string()).optional(),
+  incode: z.nullable(z.string()),
+  outcode: z.nullable(z.string()),
+  postcode: z.nullable(z.string()),
+});
+
+export function advancedListingAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<AdvancedListingAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdvancedListingAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdvancedListingAddress' from JSON`,
+  );
+}

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

@@ -0,0 +1,49 @@
+/*
+ * 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 AdvancedListingBuild = {
+  /**
+   * Floor height where known.
+   */
+  floorHeight?: number | null | undefined;
+  /**
+   * Number of floors where known.
+   */
+  floors?: number | null | undefined;
+  /**
+   * Normalised property type, e.g. 'detached', 'flat', 'bungalow'.
+   */
+  propertyType: string | null;
+  /**
+   * Total internal floor area in square metres.
+   */
+  totalFloorArea?: number | null | undefined;
+};
+
+/** @internal */
+export const AdvancedListingBuild$inboundSchema: z.ZodType<
+  AdvancedListingBuild,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  floorHeight: z.nullable(z.number()).optional(),
+  floors: z.nullable(z.number()).optional(),
+  propertyType: z.nullable(z.string()),
+  totalFloorArea: z.nullable(z.number()).optional(),
+});
+
+export function advancedListingBuildFromJSON(
+  jsonString: string,
+): SafeParseResult<AdvancedListingBuild, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdvancedListingBuild$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdvancedListingBuild' from JSON`,
+  );
+}

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

@@ -0,0 +1,49 @@
+/*
+ * 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 AdvancedListingEnergyRating = {
+  /**
+   * Current EPC score (0–100).
+   */
+  currentEnergyEfficiency: number | null;
+  /**
+   * Current EPC band (A–G).
+   */
+  currentEnergyRating: string | null;
+  /**
+   * Potential EPC score (0–100).
+   */
+  potentialEnergyEfficiency: number | null;
+  /**
+   * Potential EPC band (A–G).
+   */
+  potentialEnergyRating: string | null;
+};
+
+/** @internal */
+export const AdvancedListingEnergyRating$inboundSchema: z.ZodType<
+  AdvancedListingEnergyRating,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currentEnergyEfficiency: z.nullable(z.number()),
+  currentEnergyRating: z.nullable(z.string()),
+  potentialEnergyEfficiency: z.nullable(z.number()),
+  potentialEnergyRating: z.nullable(z.string()),
+});
+
+export function advancedListingEnergyRatingFromJSON(
+  jsonString: string,
+): SafeParseResult<AdvancedListingEnergyRating, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AdvancedListingEnergyRating$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AdvancedListingEnergyRating' from JSON`,
+  );
+}