@vepler/sdk 3.3.0 → 5.28.1

package/dist/esm/sdk/models/operations/getlistingbysource.js

@@ -5,14 +5,14 @@ import * as z from "zod/v3";
 import { collectExtraKeys as collectExtraKeys$, safeParse, } from "../../../lib/schemas.js";
 import * as openEnums from "../../types/enums.js";
 /**
- * Merge listing data from multiple sources into a single enriched record (default: false). When true, the response combines details from all available provider feeds for this property. When false, returns only the primary source record.
+ * Whether to return the enriched record built from everything held for the listing, including its pricing history, features, media, energy rating and extracted attributes. Defaults to 'false', which returns the stored listing on its own.
  */
 export const ForceAggregate = {
     True: "true",
     False: "false",
 };
 /**
- * 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.
+ * What the image shows: property photography, a floor plan, an Energy Performance Certificate chart, or a page from the marketing brochure.
  */
 export const GetListingBySourceListingsType = {
     Standard: "standard",
@@ -21,14 +21,14 @@ export const GetListingBySourceListingsType = {
     Brochure: "brochure",
 };
 /**
- * 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.
+ * Broad category the property falls into: a residential dwelling, or commercial premises such as offices, retail units, warehouses and industrial space.
  */
 export const GetListingBySourceCategory = {
     Residential: "residential",
     Commercial: "commercial",
 };
 /**
- * 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.
+ * What the image shows: property photography, a floor plan, an Energy Performance Certificate chart, or a page from the marketing brochure.
  */
 export const GetListingBySourceListingsResponseType = {
     Standard: "standard",
@@ -37,7 +37,7 @@ export const GetListingBySourceListingsResponseType = {
     Brochure: "brochure",
 };
 /**
- * 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.
+ * What the image shows: property photography, a floor plan, an Energy Performance Certificate chart, or a page from the marketing brochure.
  */
 export const GetListingBySourceListingsResponse200Type = {
     Standard: "standard",
@@ -46,7 +46,7 @@ export const GetListingBySourceListingsResponse200Type = {
     Brochure: "brochure",
 };
 /**
- * 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.
+ * What the image shows: property photography, a floor plan, an Energy Performance Certificate chart, or a page from the marketing brochure.
  */
 export const GetListingBySourceListingsResponse200ApplicationJSONType = {
     Standard: "standard",
@@ -55,7 +55,7 @@ export const GetListingBySourceListingsResponse200ApplicationJSONType = {
     Brochure: "brochure",
 };
 /**
- * Type of narrative content. summary: brief overview of the property (1-2 sentences). description: full marketing description. features: bullet-pointed key selling points. location: description of the surrounding area, transport links, and amenities. other: additional narrative that does not fit other categories.
+ * What this block of marketing text covers: a short overview, the full description, the list of key features, the surrounding area, or anything that fits none of those.
  */
 export const GetListingBySourceListingsResponse200ApplicationJSONResponseBodyType = {
     Summary: "summary",
@@ -65,13 +65,13 @@ export const GetListingBySourceListingsResponse200ApplicationJSONResponseBodyTyp
     Other: "other",
 };
 /**
- * Object type discriminator. Always 'listing' for single listing responses. Follows the Stripe-style convention for typed API responses.
+ * Object type discriminator. Always `listing`.
  */
 export const GetListingBySourceObject = {
     Listing: "listing",
 };
 /**
- * Direction of a price revision. 'increase': the asking price or rent was raised. 'decrease': the asking price or rent was reduced (commonly signals motivated seller or market correction). 'nochange': a price event was recorded but the value remained unchanged (e.g. relisting at the same price).
+ * Whether the price went up, went down, or stayed the same at this revision.
  */
 export const GetListingBySourceDirection = {
     Increase: "increase",
@@ -79,13 +79,13 @@ export const GetListingBySourceDirection = {
     Nochange: "nochange",
 };
 /**
- * GeoJSON geometry type
+ * Geometry type discriminator. Always `Point`.
  */
 export const GetListingBySourceListingsResponse200ApplicationJSONResponseBodySpatialType = {
     Point: "Point",
 };
 /**
- * Current status of the listing. 'live': actively marketed on one or more property portals. 'archived': listing was taken off market by the agent but retained for historical analysis (e.g. price comparisons). 'removed': listing has been permanently withdrawn or the source feed no longer includes it. Typical lifecycle: live -> archived -> removed.
+ * Where the listing stands in its marketing life. 'live': currently being marketed. 'removed': withdrawn, or no longer present in the source feed.
  */
 export const GetListingBySourceStatus = {
     Live: "live",
@@ -93,7 +93,7 @@ export const GetListingBySourceStatus = {
     Removed: "removed",
 };
 /**
- * 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).
+ * Whether the property is advertised for sale or to rent. This governs how to read the price: an asking price for 'sale', the rent quoted by the source for 'rent'.
  */
 export const GetListingBySourceType = {
     Sale: "sale",