@vepler/sdk 2.167.0 → 3.0.0

package/src/sdk/models/operations/getlistingsbylocation.ts

@@ -4,7 +4,10 @@
 
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../../lib/primitives.js";
-import { safeParse } from "../../../lib/schemas.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../../lib/schemas.js";
 import * as openEnums from "../../types/enums.js";
 import { ClosedEnum, OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
@@ -42,7 +45,7 @@ export type GetListingsByLocationAddress = {
   /**
    * City, town, or village name as used by Royal Mail for postal addressing.
    */
-  city?: string | undefined;
+  city?: string | null | undefined;
   /**
    * ISO 3166-1 alpha-2 country code. Defaults to 'GB' for Great Britain. Currently only UK properties are supported.
    */
@@ -50,11 +53,11 @@ export type GetListingsByLocationAddress = {
   /**
    * Local district, borough, or neighbourhood within the city (e.g. 'Westminster', 'Shoreditch', 'Didsbury').
    */
-  district?: string | undefined;
+  district?: string | null | undefined;
   /**
    * Inward code — the second part of the UK postcode after the space (e.g. '1AA', '4QE'). Combined with outcode forms the full postcode.
    */
-  incode?: string | undefined;
+  incode?: string | null | undefined;
   /**
    * The raw, unstructured address string exactly as received from the source data feed, before any parsing or normalisation. Useful for display purposes or debugging address-matching issues.
    */
@@ -62,7 +65,7 @@ export type GetListingsByLocationAddress = {
   /**
    * Outward code — the first part of the UK postcode before the space (e.g. 'SW1A', 'M1', 'EC2'). Useful for area-level grouping and search.
    */
-  outcode?: string | undefined;
+  outcode?: string | null | undefined;
   /**
    * Full UK postcode in standard Royal Mail format (e.g. 'SW1A 1AA'). Always present and is the primary geographic identifier used for location matching.
    */
@@ -70,15 +73,15 @@ export type GetListingsByLocationAddress = {
   /**
    * Building or house number, including any suffix (e.g. '12A', '3-5'). May be absent for named properties or new-build plots.
    */
-  propertyNumber?: string | undefined;
+  propertyNumber?: string | null | undefined;
   /**
    * County or administrative region (e.g. 'Greater London', 'West Yorkshire', 'Surrey').
    */
-  region?: string | undefined;
+  region?: string | null | undefined;
   /**
    * Street or road name, without the property number. May include thoroughfare type (e.g. 'High Street', 'Park Lane', 'The Crescent').
    */
-  street?: string | undefined;
+  street?: string | null | undefined;
 };
 
 /**
@@ -162,7 +165,7 @@ export type GetListingsByLocationBrochureImages = {
   /**
    * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
    */
-  caption?: string | undefined;
+  caption?: string | null | 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.
    */
@@ -214,7 +217,7 @@ export type GetListingsByLocationEnergyRatingImages = {
   /**
    * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
    */
-  caption?: string | undefined;
+  caption?: string | null | 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.
    */
@@ -266,7 +269,7 @@ export type GetListingsByLocationFloorPlanImages = {
   /**
    * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
    */
-  caption?: string | undefined;
+  caption?: string | null | 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.
    */
@@ -303,7 +306,7 @@ export type GetListingsByLocationImages = {
   /**
    * Human-readable caption describing the image content, as provided by the listing agent (e.g. 'Master bedroom', 'Rear garden', 'Kitchen/diner').
    */
-  caption?: string | undefined;
+  caption?: string | null | 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.
    */
@@ -489,7 +492,7 @@ export type GetListingsByLocationData = {
   /**
    * Broad property category. 'residential': dwellings including houses, flats, bungalows, and maisonettes. 'commercial': non-residential premises such as offices, retail units, warehouses, and mixed-use buildings.
    */
-  category: GetListingsByLocationCategory;
+  category?: GetListingsByLocationCategory | null | undefined;
   /**
    * ISO 8601 datetime when this listing record was first created in our system. This may differ from publishedDate if the listing was retrospectively imported.
    */
@@ -561,15 +564,15 @@ export type GetListingsByLocationData = {
    */
   narratives?: Array<GetListingsByLocationNarratives> | null | undefined;
   /**
-   * Current listing price in GBP pence. Divide by 100 to convert to pounds sterling. For sale listings: the asking price (e.g. 50000000 = £500,000). For rental listings: the monthly rent per calendar month (e.g. 150000 = £1,500 pcm). Always reflects the most recent price after any revisions.
+   * Current listing price in GBP pence. Divide by 100 to convert to pounds sterling. For sale listings: the asking price (e.g. 50000000 = £500,000). For rental listings: the monthly rent per calendar month (e.g. 150000 = £1,500 pcm). Always reflects the most recent price after any revisions. May be null/absent when the source feed does not expose a price.
    */
-  price: number;
+  price?: number | null | undefined;
   /**
    * Chronological history of price changes since the listing was first published. Each entry records a revision event with the old and new prices. Useful for tracking asking-price reductions and market sentiment. Ordered from earliest to most recent change.
    */
   priceHistory?: Array<GetListingsByLocationPriceHistory> | undefined;
   /**
-   * Primary property type classification. Common values for residential include: 'detached', 'semi-detached', 'terraced', 'flat', 'bungalow', 'maisonette', 'end_terrace', 'cottage', 'park_home'. For commercial: 'office', 'retail', 'warehouse', 'industrial', 'land'. Values are normalised from provider-specific taxonomies but may occasionally contain non-standard entries.
+   * Primary property type classification, normalised from provider-specific taxonomies to the canonical PROPERTY_TYPE_MAPPING_VALUES set: unknown, other, flat, detached, semiDetached, terraced, bungalow, maisonette, cottage, chalet, lodge, mobileHome, houseboat, retirement, characterProperty, blockOfFlats, houseShare, farmhouse, mill, barn, coachHouse, statelyHome, farm, parking, equestrian, restaurant, industrial, warehouse, leisure, retail, land, office, riad, hotel, studentAccommodation, commercial, pub, bar, hotelRoom, shop, retailHighStreet, retailOutOfTown, industrialDevelopment, distributionWarehouse, industrialPark, storage, servicedOffice, residentialDevelopment, commercialDevelopment, mixedUse. This is a free-form string (not schema-enforced) and may occasionally contain non-standard entries.
    */
   propertyType: string;
   /**
@@ -608,6 +611,7 @@ export type GetListingsByLocationData = {
    * ISO 8601 datetime when this listing record was last modified in our system. Updated whenever any field changes, including price revisions, status transitions, or image additions.
    */
   updatedAt?: Date | undefined;
+  additionalProperties?: { [k: string]: any } | undefined;
 };
 
 /**
@@ -686,16 +690,16 @@ export const GetListingsByLocationAddress$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  city: z.string().optional(),
+  city: z.nullable(z.string()).optional(),
   country: z.string().default("GB"),
-  district: z.string().optional(),
-  incode: z.string().optional(),
+  district: z.nullable(z.string()).optional(),
+  incode: z.nullable(z.string()).optional(),
   originalAddress: z.string(),
-  outcode: z.string().optional(),
+  outcode: z.nullable(z.string()).optional(),
   postcode: z.string(),
-  propertyNumber: z.string().optional(),
-  region: z.string().optional(),
-  street: z.string().optional(),
+  propertyNumber: z.nullable(z.string()).optional(),
+  region: z.nullable(z.string()).optional(),
+  street: z.nullable(z.string()).optional(),
 });
 
 export function getListingsByLocationAddressFromJSON(
@@ -752,7 +756,7 @@ export const GetListingsByLocationBrochureImages$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  caption: z.string().optional(),
+  caption: z.nullable(z.string()).optional(),
   order: z.number().optional(),
   type: GetListingsByLocationListingsType$inboundSchema.optional(),
   url: z.string(),
@@ -789,7 +793,7 @@ export const GetListingsByLocationEnergyRatingImages$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  caption: z.string().optional(),
+  caption: z.nullable(z.string()).optional(),
   order: z.number().optional(),
   type: GetListingsByLocationListingsResponseType$inboundSchema.optional(),
   url: z.string(),
@@ -845,7 +849,7 @@ export const GetListingsByLocationFloorPlanImages$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  caption: z.string().optional(),
+  caption: z.nullable(z.string()).optional(),
   order: z.number().optional(),
   type: GetListingsByLocationListingsResponse200Type$inboundSchema.optional(),
   url: z.string(),
@@ -878,7 +882,7 @@ export const GetListingsByLocationImages$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  caption: z.string().optional(),
+  caption: z.nullable(z.string()).optional(),
   order: z.number().optional(),
   type:
     GetListingsByLocationListingsResponse200ApplicationJSONType$inboundSchema
@@ -1023,65 +1027,70 @@ export const GetListingsByLocationData$inboundSchema: z.ZodType<
   GetListingsByLocationData,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  address: z.lazy(() => GetListingsByLocationAddress$inboundSchema),
-  agent: z.nullable(z.lazy(() => GetListingsByLocationAgent$inboundSchema))
-    .optional(),
-  baths: z.nullable(z.number()).optional(),
-  beds: z.nullable(z.number()).optional(),
-  brochureImages: z.array(
-    z.lazy(() => GetListingsByLocationBrochureImages$inboundSchema),
-  ).optional(),
-  category: GetListingsByLocationCategory$inboundSchema,
-  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
-  currency: z.string().default("GBP"),
-  displayAddress: z.string().optional(),
-  energyRatingImages: z.array(
-    z.lazy(() => GetListingsByLocationEnergyRatingImages$inboundSchema),
-  ).optional(),
-  features: z.nullable(
-    z.array(z.lazy(() => GetListingsByLocationFeatures$inboundSchema)),
-  ).optional(),
-  floorPlanImages: z.array(
-    z.lazy(() => GetListingsByLocationFloorPlanImages$inboundSchema),
-  ).optional(),
-  id: z.string(),
-  images: z.array(z.lazy(() => GetListingsByLocationImages$inboundSchema))
-    .optional(),
-  isAuction: z.boolean().optional(),
-  isNewBuild: z.boolean().optional(),
-  isRetirement: z.boolean().optional(),
-  isSharedOwnership: z.boolean().optional(),
-  key: z.string(),
-  lat: z.number().optional(),
-  lng: z.number().optional(),
-  locationId: z.nullable(z.string()).optional(),
-  narratives: z.nullable(
-    z.array(z.lazy(() => GetListingsByLocationNarratives$inboundSchema)),
-  ).optional(),
-  price: z.number(),
-  priceHistory: z.array(
-    z.lazy(() => GetListingsByLocationPriceHistory$inboundSchema),
-  ).optional(),
-  propertyType: z.string(),
-  provider: z.string(),
-  publishedDate: z.string().datetime({ offset: true }).transform(v =>
-    new Date(v)
-  ),
-  receptions: z.nullable(z.number()).optional(),
-  removedDate: z.nullable(
-    z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  ).optional(),
-  spatial: z.nullable(
-    z.lazy(() => GetListingsByLocationGeoJSONPoint$inboundSchema),
-  ).optional(),
-  status: GetListingsByLocationStatus$inboundSchema,
-  subPropertyType: z.nullable(z.string()).optional(),
-  type: GetListingsByLocationType$inboundSchema,
-  updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
-});
+> = collectExtraKeys$(
+  z.object({
+    address: z.lazy(() => GetListingsByLocationAddress$inboundSchema),
+    agent: z.nullable(z.lazy(() => GetListingsByLocationAgent$inboundSchema))
+      .optional(),
+    baths: z.nullable(z.number()).optional(),
+    beds: z.nullable(z.number()).optional(),
+    brochureImages: z.array(
+      z.lazy(() => GetListingsByLocationBrochureImages$inboundSchema),
+    ).optional(),
+    category: z.nullable(GetListingsByLocationCategory$inboundSchema)
+      .optional(),
+    createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    currency: z.string().default("GBP"),
+    displayAddress: z.string().optional(),
+    energyRatingImages: z.array(
+      z.lazy(() => GetListingsByLocationEnergyRatingImages$inboundSchema),
+    ).optional(),
+    features: z.nullable(
+      z.array(z.lazy(() => GetListingsByLocationFeatures$inboundSchema)),
+    ).optional(),
+    floorPlanImages: z.array(
+      z.lazy(() => GetListingsByLocationFloorPlanImages$inboundSchema),
+    ).optional(),
+    id: z.string(),
+    images: z.array(z.lazy(() => GetListingsByLocationImages$inboundSchema))
+      .optional(),
+    isAuction: z.boolean().optional(),
+    isNewBuild: z.boolean().optional(),
+    isRetirement: z.boolean().optional(),
+    isSharedOwnership: z.boolean().optional(),
+    key: z.string(),
+    lat: z.number().optional(),
+    lng: z.number().optional(),
+    locationId: z.nullable(z.string()).optional(),
+    narratives: z.nullable(
+      z.array(z.lazy(() => GetListingsByLocationNarratives$inboundSchema)),
+    ).optional(),
+    price: z.nullable(z.number()).optional(),
+    priceHistory: z.array(
+      z.lazy(() => GetListingsByLocationPriceHistory$inboundSchema),
+    ).optional(),
+    propertyType: z.string(),
+    provider: z.string(),
+    publishedDate: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    receptions: z.nullable(z.number()).optional(),
+    removedDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    spatial: z.nullable(
+      z.lazy(() => GetListingsByLocationGeoJSONPoint$inboundSchema),
+    ).optional(),
+    status: GetListingsByLocationStatus$inboundSchema,
+    subPropertyType: z.nullable(z.string()).optional(),
+    type: GetListingsByLocationType$inboundSchema,
+    updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+);
 
 export function getListingsByLocationDataFromJSON(
   jsonString: string,

package/src/sdk/models/operations/getproperties.ts

@@ -9,6 +9,10 @@ export type GetPropertiesRequest = {
    * Comma-separated list of attributes to include. Only specified fields will be returned (plus locationId which is always included)
    */
   attributes?: string | undefined;
+  /**
+   * Optional sovereign-country hint (e.g. 'GB', 'IE'). Lenient free-string: normalised internally, never a hard filter. Only GB data exists today, so this is accepted as an ignored/GB-scoped hint; omitting it behaves exactly as today.
+   */
+  countryCode?: string | undefined;
   /**
    * Maximum number of results to return
    */
@@ -26,6 +30,7 @@ export type GetPropertiesRequest = {
 /** @internal */
 export type GetPropertiesRequest$Outbound = {
   attributes?: string | undefined;
+  countryCode?: string | undefined;
   limit?: string | undefined;
   offset?: string | undefined;
   propertyIds: string;
@@ -38,6 +43,7 @@ export const GetPropertiesRequest$outboundSchema: z.ZodType<
   GetPropertiesRequest
 > = z.object({
   attributes: z.string().optional(),
+  countryCode: z.string().optional(),
   limit: z.string().optional(),
   offset: z.string().optional(),
   propertyIds: z.string(),

package/src/sdk/models/operations/getpropertiesbylocation.ts

@@ -9,6 +9,10 @@ export type GetPropertiesByLocationRequest = {
    * Comma-separated list of attributes to include. Only specified fields will be returned (plus locationId which is always included)
    */
   attributes?: string | undefined;
+  /**
+   * Optional sovereign-country hint (e.g. 'GB', 'IE'). Lenient free-string: normalised internally, never a hard filter. Only GB data exists today, so this is accepted as an ignored/GB-scoped hint; omitting it behaves exactly as today.
+   */
+  countryCode?: string | undefined;
   /**
    * Maximum number of results to return
    */
@@ -26,6 +30,7 @@ export type GetPropertiesByLocationRequest = {
 /** @internal */
 export type GetPropertiesByLocationRequest$Outbound = {
   attributes?: string | undefined;
+  countryCode?: string | undefined;
   limit?: string | undefined;
   locationIds: string;
   offset?: string | undefined;
@@ -38,6 +43,7 @@ export const GetPropertiesByLocationRequest$outboundSchema: z.ZodType<
   GetPropertiesByLocationRequest
 > = z.object({
   attributes: z.string().optional(),
+  countryCode: z.string().optional(),
   limit: z.string().optional(),
   locationIds: z.string(),
   offset: z.string().optional(),

package/src/sdk/models/operations/getpropertiesbysource.ts

@@ -9,6 +9,10 @@ export type GetPropertiesBySourceRequest = {
    * Comma-separated list of attributes to include. Only specified fields will be returned (plus locationId which is always included)
    */
   attributes?: string | undefined;
+  /**
+   * Optional sovereign-country hint (e.g. 'GB', 'IE'). Lenient free-string: normalised internally, never a hard filter. Only GB data exists today, so this is accepted as an ignored/GB-scoped hint; omitting it behaves exactly as today.
+   */
+  countryCode?: string | undefined;
   /**
    * Maximum number of results to return
    */
@@ -26,6 +30,7 @@ export type GetPropertiesBySourceRequest = {
 /** @internal */
 export type GetPropertiesBySourceRequest$Outbound = {
   attributes?: string | undefined;
+  countryCode?: string | undefined;
   limit?: string | undefined;
   offset?: string | undefined;
   sourceIds: string;
@@ -38,6 +43,7 @@ export const GetPropertiesBySourceRequest$outboundSchema: z.ZodType<
   GetPropertiesBySourceRequest
 > = z.object({
   attributes: z.string().optional(),
+  countryCode: z.string().optional(),
   limit: z.string().optional(),
   offset: z.string().optional(),
   sourceIds: z.string(),

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

@@ -108,6 +108,7 @@ export * from "./resolveaddress.js";
 export * from "./reversegeocode.js";
 export * from "./searchconnectionqueue.js";
 export * from "./searchecr.js";
+export * from "./searchretrieve.js";
 export * from "./searchsubstations.js";
 export * from "./searchsuggest.js";
 export * from "./validatepostcode.js";