@vepler/sdk 3.0.0 → 5.28.1

package/dist/commonjs/sdk/models/shared/landconstraintdesignationlistresponse.d.ts

@@ -4,37 +4,37 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { LandConstraintDesignationFeature } from "./landconstraintdesignationfeature.js";
 /**
- * Object type identifier
+ * Object type discriminator. Always `list`.
  */
 export declare const LandConstraintDesignationListResponseObject: {
     readonly List: "list";
 };
 /**
- * Object type identifier
+ * Object type discriminator. Always `list`.
  */
 export type LandConstraintDesignationListResponseObject = ClosedEnum<typeof LandConstraintDesignationListResponseObject>;
 /**
- * Paginated list response
+ * One page of results, with the metadata needed to fetch the rest.
  */
 export type LandConstraintDesignationListResponse = {
     /**
-     * Array of items
+     * The items on this page.
      */
     data: Array<LandConstraintDesignationFeature>;
     /**
-     * Whether more items exist
+     * True when further items exist beyond this page.
      */
     hasMore: boolean;
     /**
-     * Object type identifier
+     * Object type discriminator. Always `list`.
      */
     object: LandConstraintDesignationListResponseObject;
     /**
-     * Total number of items available
+     * Total number of items matching the request across all pages.
      */
     totalCount?: number | undefined;
     /**
-     * URL of the request
+     * Path this list was requested from.
      */
     url: string;
 };

package/dist/commonjs/sdk/models/shared/landconstraintdesignationlistresponse.js

@@ -43,7 +43,7 @@ const primitives_js_1 = require("../../../lib/primitives.js");
 const schemas_js_1 = require("../../../lib/schemas.js");
 const landconstraintdesignationfeature_js_1 = require("./landconstraintdesignationfeature.js");
 /**
- * Object type identifier
+ * Object type discriminator. Always `list`.
  */
 exports.LandConstraintDesignationListResponseObject = {
     List: "list",

package/dist/commonjs/sdk/models/shared/leafaggregation.d.ts

@@ -7,7 +7,7 @@ export declare const LeafAggregationOrder: {
 };
 export type LeafAggregationOrder = ClosedEnum<typeof LeafAggregationOrder>;
 /**
- * Type of aggregation to perform. Each type has specific parameter requirements and returns a different result shape.
+ * How the matching records are aggregated. Each type takes its own parameters and returns its own result shape.
  */
 export declare const LeafAggregationType: {
     readonly Terms: "terms";
@@ -25,62 +25,62 @@ export declare const LeafAggregationType: {
     readonly Percentiles: "percentiles";
 };
 /**
- * Type of aggregation to perform. Each type has specific parameter requirements and returns a different result shape.
+ * How the matching records are aggregated. Each type takes its own parameters and returns its own result shape.
  */
 export type LeafAggregationType = ClosedEnum<typeof LeafAggregationType>;
 export type LeafAggregation = {
     /**
-     * Calendar-aware interval for date_histogram. Values: 1m (minute), 1h (hour), 1d (day), 1w (week), 1M (month), 1q (quarter), 1y (year). Mutually exclusive with fixedInterval — provide one or the other, not both.
+     * Calendar-aware bucket width for a date aggregation: 1m (minute), 1h (hour), 1d (day), 1w (week), 1M (month), 1q (quarter) or 1y (year). Mutually exclusive with `fixedInterval`, so supply one or the other, never both.
      */
     calendarInterval?: string | undefined;
     /**
-     * Field to aggregate on. Must be a field allowed by the dataset's aggregation whitelist.
+     * Field to aggregate over. Each dataset allows a fixed set of fields, and each of those supports only certain aggregation types; a field or type outside that set is rejected.
      */
     field: string;
     /**
-     * Fixed-duration interval for date_histogram. Values: any combination of number + unit (ms, s, m, h, d). Examples: "30m", "1h", "7d". Unlike calendarInterval, does not account for daylight saving or month lengths. Mutually exclusive with calendarInterval — provide one or the other, not both.
+     * Fixed-duration bucket width for a date aggregation, written as a number and a unit (ms, s, m, h, d), for example "30m", "1h" or "7d". Unlike `calendarInterval` it takes no account of daylight saving or of months having different lengths. Mutually exclusive with `calendarInterval`, so supply one or the other, never both.
      */
     fixedInterval?: string | undefined;
     /**
-     * Date format string for date_histogram bucket keys. Uses Elasticsearch date format patterns (e.g. "yyyy-MM-dd").
+     * Pattern used to render `key_as_string` on each date bucket, for example "yyyy-MM-dd".
      */
     format?: string | undefined;
     /**
-     * Bucket width for histogram aggregation. Required when type is "histogram".
+     * Width of each bucket for a `histogram` aggregation, in the units of the field. Must be greater than zero. Some datasets reject a `histogram` aggregation that omits it rather than applying a default.
      */
     interval?: number | undefined;
     /**
-     * Minimum document count for a bucket to be included in the result. Applies to: terms, histogram, date_histogram. Default is 1.
+     * Smallest number of matching records a bucket must hold to appear in the result. Set it to 0 to keep buckets that matched nothing. Only the bucketing types honour it; single-value metric types ignore it.
      */
     minDocCount?: number | undefined;
     /**
-     * Unique name for this aggregation. Used as the key in the response `aggregations` object.
+     * Name for this aggregation. It is the key its result appears under in the response `aggregations` object, so it must be unique within the request. Between 1 and 50 characters.
      */
     name: string;
     /**
-     * Sort order for terms buckets. Key is the sort field ("_count", "_key", or a sub-aggregation name), value is direction.
+     * Order the buckets of a `terms` aggregation. The key is what to sort on, either `_count`, `_key`, or the name of one of this aggregation's sub-aggregations; the value is the direction.
      */
     order?: {
         [k: string]: LeafAggregationOrder;
     } | undefined;
     /**
-     * Percentile values to calculate (0-100). Required when type is "percentiles".
+     * The percentiles to compute, each between 0 and 100. Used by the `percentiles` type.
      */
     percents?: Array<number> | undefined;
     /**
-     * Custom numeric ranges for range aggregation. Required when type is "range". Each range has an inclusive `from` and exclusive `to`.
+     * The ranges a `range` aggregation groups into. At least one is needed, and each covers `from` inclusive up to `to` exclusive.
      */
     ranges?: Array<RangeDefinition> | undefined;
     /**
-     * Maximum number of buckets to return. Applies to: terms (default 20), geotile_grid (precision level). Ignored by metric aggregations (stats, min, max, etc.).
+     * Maximum number of buckets a grouping aggregation returns, between 1 and 100. The single-value metric types ignore it. For the map-tile grouping type it sets the tile precision rather than a bucket count. When omitted, the default depends on the dataset and the field.
      */
     size?: number | undefined;
     /**
-     * IANA timezone for date_histogram bucketing (e.g. "Europe/London", "UTC"). Defaults to UTC.
+     * IANA time zone that date bucket boundaries are aligned to, for example "Europe/London".
      */
     timeZone?: string | undefined;
     /**
-     * Type of aggregation to perform. Each type has specific parameter requirements and returns a different result shape.
+     * How the matching records are aggregated. Each type takes its own parameters and returns its own result shape.
      */
     type: LeafAggregationType;
 };

package/dist/commonjs/sdk/models/shared/leafaggregation.js

@@ -45,7 +45,7 @@ exports.LeafAggregationOrder = {
     Desc: "desc",
 };
 /**
- * Type of aggregation to perform. Each type has specific parameter requirements and returns a different result shape.
+ * How the matching records are aggregated. Each type takes its own parameters and returns its own result shape.
  */
 exports.LeafAggregationType = {
     Terms: "terms",

package/dist/commonjs/sdk/models/shared/lease.d.ts

@@ -3,19 +3,19 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 export type Lease = {
     /**
-     * Whether lease has alienation restrictions
+     * True when the lease carries an alienation clause restricting assignment or subletting.
      */
     alienationClause?: boolean | undefined;
     /**
-     * Date when lease was granted
+     * When the lease was granted, as an ISO 8601 date. Null when the register does not give a date.
      */
     dateOfLease?: string | null | undefined;
     /**
-     * Date when lease expires
+     * When the lease expires, as an ISO 8601 date. Null when the register does not give a date.
      */
     expiryDate?: string | null | undefined;
     /**
-     * Type of lease
+     * Kind of lease recorded.
      */
     leaseType?: string | null | undefined;
 };

package/dist/commonjs/sdk/models/shared/lenderimpact.d.ts

@@ -1,7 +1,7 @@
 import * as z from "zod/v3";
 import { OpenEnum } from "../../types/enums.js";
 /**
- * Mortgage lender posture toward the risk
+ * How mortgage lenders typically treat the risk, from no concern through to refusing to lend.
  */
 export declare const LenderImpact: {
     readonly None: "none";
@@ -10,7 +10,7 @@ export declare const LenderImpact: {
     readonly Refused: "refused";
 };
 /**
- * Mortgage lender posture toward the risk
+ * How mortgage lenders typically treat the risk, from no concern through to refusing to lend.
  */
 export type LenderImpact = OpenEnum<typeof LenderImpact>;
 /** @internal */

package/dist/commonjs/sdk/models/shared/lenderimpact.js

@@ -39,7 +39,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LenderImpact$inboundSchema = exports.LenderImpact = void 0;
 const openEnums = __importStar(require("../../types/enums.js"));
 /**
- * Mortgage lender posture toward the risk
+ * How mortgage lenders typically treat the risk, from no concern through to refusing to lend.
  */
 exports.LenderImpact = {
     None: "none",

package/dist/commonjs/sdk/models/shared/liquidityimpact.d.ts

@@ -1,7 +1,7 @@
 import * as z from "zod/v3";
 import { OpenEnum } from "../../types/enums.js";
 /**
- * Effect on time-to-sell
+ * How much longer the risk is expected to make a property take to sell.
  */
 export declare const LiquidityImpact: {
     readonly NoChange: "no_change";
@@ -9,7 +9,7 @@ export declare const LiquidityImpact: {
     readonly MuchSlower: "much_slower";
 };
 /**
- * Effect on time-to-sell
+ * How much longer the risk is expected to make a property take to sell.
  */
 export type LiquidityImpact = OpenEnum<typeof LiquidityImpact>;
 /** @internal */

package/dist/commonjs/sdk/models/shared/liquidityimpact.js

@@ -39,7 +39,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LiquidityImpact$inboundSchema = exports.LiquidityImpact = void 0;
 const openEnums = __importStar(require("../../types/enums.js"));
 /**
- * Effect on time-to-sell
+ * How much longer the risk is expected to make a property take to sell.
  */
 exports.LiquidityImpact = {
     NoChange: "no_change",

package/dist/commonjs/sdk/models/shared/listing.d.ts

@@ -5,7 +5,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { ListingImage } from "./listingimage.js";
 import { ListingPriceChange } from "./listingpricechange.js";
 /**
- * Property features from listing
+ * Features the listing advertises.
  */
 export type ListingFeatures = {
     alarm?: boolean | undefined;
@@ -34,50 +34,50 @@ export type ListingFeatures = {
     } | undefined;
 };
 /**
- * Listing pricing information
+ * What the listing asks for the property.
  */
 export type Pricing = {
     /**
-     * Currency code
+     * Currency the prices are quoted in, as an ISO 4217 code.
      */
     currency?: string | null | undefined;
     /**
-     * Estimated price in GBP (whole pounds)
+     * Estimated value of the property, in whole pounds.
      */
     estimated?: number | null | undefined;
     /**
-     * Listed price in GBP (whole pounds)
+     * Price the listing advertises, in whole pounds.
      */
     price?: number | null | undefined;
 };
 /**
- * Seller information
+ * Who is marketing the property.
  */
 export type Seller = {
     /**
-     * Property Agent Identifier (PAID)
+     * The agent's Property Agent Identifier (PAID).
      */
     paid?: string | null | undefined;
     /**
-     * Seller/agent name
+     * Name of the agent or seller marketing the property.
      */
     name?: string | null | undefined;
 };
 /**
- * Source provider and provider-specific key for this listing. Permission-gated: only returned to callers with `sourceData` access (stripped otherwise).
+ * Where the listing came from. Returned only to callers holding the source-data permission, and left out of the response otherwise.
  */
 export type Source = {
     /**
-     * Provider-specific listing key.
+     * Identifier the provider uses for this listing.
      */
-    key: string;
+    key?: string | undefined;
     /**
-     * Data provider identifier for this listing.
+     * Identifier of the provider that supplied the listing.
      */
-    provider: string;
+    provider?: string | undefined;
 };
 /**
- * Listing status
+ * Where the listing currently stands.
  */
 export declare const ListingStatus: {
     readonly Live: "live";
@@ -89,71 +89,71 @@ export declare const ListingStatus: {
     readonly Reserved: "reserved";
 };
 /**
- * Listing status
+ * Where the listing currently stands.
  */
 export type ListingStatus = OpenEnum<typeof ListingStatus>;
 /**
- * Listing type
+ * Whether the listing is a sale or a letting.
  */
 export declare const ListingType: {
     readonly Sale: "sale";
     readonly Rent: "rent";
 };
 /**
- * Listing type
+ * Whether the listing is a sale or a letting.
  */
 export type ListingType = OpenEnum<typeof ListingType>;
 export type Listing = {
     /**
-     * Listing description text
+     * The listing's own description of the property.
      */
     description?: string | null | undefined;
     /**
-     * Property features from listing
+     * Features the listing advertises.
      */
     features?: ListingFeatures | undefined;
     /**
-     * Floor plan images
+     * Floor plans published with the listing.
      */
     floorPlanImages?: Array<ListingImage> | undefined;
     /**
-     * Property images
+     * Photographs published with the listing.
      */
     images?: Array<ListingImage> | undefined;
     /**
-     * Unique listing identifier
+     * Identifier of this listing.
      */
     listingId?: string | undefined;
     /**
-     * Price change history for this listing
+     * Every price this listing has been advertised at, starting with the first.
      */
     priceChange?: Array<ListingPriceChange> | undefined;
     /**
-     * Listing pricing information
+     * What the listing asks for the property.
      */
     pricing?: Pricing | undefined;
     /**
-     * Date listing was published
+     * When the listing was first published, as an ISO 8601 timestamp.
      */
     publishedDate?: Date | undefined;
     /**
-     * Date listing was removed
+     * When the listing was taken down, as an ISO 8601 timestamp. Null while it is still live.
      */
     removedDate?: Date | null | undefined;
     /**
-     * Seller information
+     * Who is marketing the property.
      */
     seller?: Seller | undefined;
     /**
-     * Source provider and provider-specific key for this listing. Permission-gated: only returned to callers with `sourceData` access (stripped otherwise).
+     * Where the listing came from. Returned only to callers holding the source-data permission, and left out of the response otherwise.
      */
     source?: Source | undefined;
     /**
-     * Listing status
+     * Where the listing currently stands.
      */
     status?: ListingStatus | undefined;
     /**
-     * Listing type
+     * Whether the listing is a sale or a letting.
      */
     type?: ListingType | undefined;
 };

package/dist/commonjs/sdk/models/shared/listing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listing.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/listing.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAO5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,YAAY,EAA8B,MAAM,mBAAmB,CAAC;AAC7E,OAAO,EACL,kBAAkB,EAEnB,MAAM,yBAAyB,CAAC;AAEjC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACrC,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACpC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACpC,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,oBAAoB,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;CACzD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;CAQhB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,aAAa,CAAC,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,WAAW;;;CAGd,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,WAAW,CAAC,CAAC;AAEvD,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;IAClD;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC;IACpD;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,eAAe,EACf,CAAC,CAAC,UAAU,EACZ,OAAO,CA2BR,CAAC;AAEF,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAMtD;AAED,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAKxE,CAAC;AAEL,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAM9C;AAED,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAQtE,CAAC;AAEL,wBAAgB,cAAc,CAC5B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAM7C;AAED,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAItE,CAAC;AAEL,wBAAgB,cAAc,CAC5B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAM7C;AAED,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CACjD,aAAa,EACb,CAAC,CAAC,UAAU,EACZ,OAAO,CACiC,CAAC;AAE3C,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,WAAW,EACX,CAAC,CAAC,UAAU,EACZ,OAAO,CAC+B,CAAC;AAEzC,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAmBxE,CAAC;AAEL,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAM9C"}
+{"version":3,"file":"listing.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/listing.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAO5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,YAAY,EAA8B,MAAM,mBAAmB,CAAC;AAC7E,OAAO,EACL,kBAAkB,EAEnB,MAAM,yBAAyB,CAAC;AAEjC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACrC,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACpC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACpC,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,oBAAoB,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;CACzD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;CAQhB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,aAAa,CAAC,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,WAAW;;;CAGd,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,WAAW,CAAC,CAAC;AAEvD,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;IAClD;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC;IACpD;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,eAAe,EACf,CAAC,CAAC,UAAU,EACZ,OAAO,CA2BR,CAAC;AAEF,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAMtD;AAED,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAKxE,CAAC;AAEL,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAM9C;AAED,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAQtE,CAAC;AAEL,wBAAgB,cAAc,CAC5B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAM7C;AAED,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAItE,CAAC;AAEL,wBAAgB,cAAc,CAC5B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAM7C;AAED,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CACjD,aAAa,EACb,CAAC,CAAC,UAAU,EACZ,OAAO,CACiC,CAAC;AAE3C,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,WAAW,EACX,CAAC,CAAC,UAAU,EACZ,OAAO,CAC+B,CAAC;AAEzC,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAmBxE,CAAC;AAEL,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAM9C"}

package/dist/commonjs/sdk/models/shared/listing.js

@@ -49,7 +49,7 @@ const openEnums = __importStar(require("../../types/enums.js"));
 const listingimage_js_1 = require("./listingimage.js");
 const listingpricechange_js_1 = require("./listingpricechange.js");
 /**
- * Listing status
+ * Where the listing currently stands.
  */
 exports.ListingStatus = {
     Live: "live",
@@ -61,7 +61,7 @@ exports.ListingStatus = {
     Reserved: "reserved",
 };
 /**
- * Listing type
+ * Whether the listing is a sale or a letting.
  */
 exports.ListingType = {
     Sale: "sale",
@@ -119,8 +119,8 @@ function sellerFromJSON(jsonString) {
 /** @internal */
 exports.Source$inboundSchema = z
     .object({
-    key: z.string(),
-    provider: z.string(),
+    key: z.string().optional(),
+    provider: z.string().optional(),
 });
 function sourceFromJSON(jsonString) {
     return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Source$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Source' from JSON`);

package/dist/commonjs/sdk/models/shared/listing.js.map

@@ -1 +1 @@
-{"version":3,"file":"listing.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/listing.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiNH,0DAQC;AAUD,0CAQC;AAaD,wCAQC;AASD,wCAQC;AAsCD,0CAQC;AA7TD,0CAA4B;AAC5B,8DAA6D;AAC7D,wDAGiC;AACjC,gEAAkD;AAIlD,uDAA6E;AAC7E,mEAGiC;AA4EjC;;GAEG;AACU,QAAA,aAAa,GAAG;IAC3B,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,aAAa;IAC1B,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,aAAa;IACzB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;CACZ,CAAC;AAMX;;GAEG;AACU,QAAA,WAAW,GAAG;IACzB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;CACJ,CAAC;AA6DX,gBAAgB;AACH,QAAA,6BAA6B,GAItC,IAAA,6BAAiB,EACnB,CAAC,CAAC,MAAM,CAAC;IACP,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5B,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACtC,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACjC,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACrC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACnC,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACrC,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACpC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,EACpB,sBAAsB,EACtB,IAAI,CACL,CAAC;AAEF,SAAgB,uBAAuB,CACrC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qCAA6B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACzD,6CAA6C,CAC9C,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,qBAAqB,GAChC,CAAC,CAAC,MAAM,CAAC;IACP,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEL,SAAgB,eAAe,CAC7B,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,6BAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjD,qCAAqC,CACtC,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,oBAAoB,GAA6C,CAAC;KAC5E,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,MAAM,EAAE,MAAM;KACf,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,SAAgB,cAAc,CAC5B,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4BAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChD,oCAAoC,CACrC,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,oBAAoB,GAA6C,CAAC;KAC5E,MAAM,CAAC;IACN,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;CACrB,CAAC,CAAC;AAEL,SAAgB,cAAc,CAC5B,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4BAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChD,oCAAoC,CACrC,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,2BAA2B,GAIpC,SAAS,CAAC,aAAa,CAAC,qBAAa,CAAC,CAAC;AAE3C,gBAAgB;AACH,QAAA,yBAAyB,GAIlC,SAAS,CAAC,aAAa,CAAC,mBAAW,CAAC,CAAC;AAEzC,gBAAgB;AACH,QAAA,qBAAqB,GAChC,CAAC,CAAC,MAAM,CAAC;IACP,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC9C,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,qCAA6B,CAAC,CAAC,QAAQ,EAAE;IAChE,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,4CAA0B,CAAC,CAAC,QAAQ,EAAE;IAC/D,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,4CAA0B,CAAC,CAAC,QAAQ,EAAE;IACtD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,wDAAgC,CAAC,CAAC,QAAQ,EAAE;IACjE,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,6BAAqB,CAAC,CAAC,QAAQ,EAAE;IACvD,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CACjE,IAAI,IAAI,CAAC,CAAC,CAAC,CACZ,CAAC,QAAQ,EAAE;IACZ,WAAW,EAAE,CAAC,CAAC,QAAQ,CACrB,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAClE,CAAC,QAAQ,EAAE;IACZ,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,4BAAoB,CAAC,CAAC,QAAQ,EAAE;IACrD,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,4BAAoB,CAAC,CAAC,QAAQ,EAAE;IACrD,MAAM,EAAE,mCAA2B,CAAC,QAAQ,EAAE;IAC9C,IAAI,EAAE,iCAAyB,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC;AAEL,SAAgB,eAAe,CAC7B,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,6BAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjD,qCAAqC,CACtC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"listing.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/listing.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiNH,0DAQC;AAUD,0CAQC;AAaD,wCAQC;AASD,wCAQC;AAsCD,0CAQC;AA7TD,0CAA4B;AAC5B,8DAA6D;AAC7D,wDAGiC;AACjC,gEAAkD;AAIlD,uDAA6E;AAC7E,mEAGiC;AA4EjC;;GAEG;AACU,QAAA,aAAa,GAAG;IAC3B,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,aAAa;IAC1B,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,aAAa;IACzB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;CACZ,CAAC;AAMX;;GAEG;AACU,QAAA,WAAW,GAAG;IACzB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;CACJ,CAAC;AA6DX,gBAAgB;AACH,QAAA,6BAA6B,GAItC,IAAA,6BAAiB,EACnB,CAAC,CAAC,MAAM,CAAC;IACP,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5B,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACtC,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACjC,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACrC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACnC,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACrC,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACpC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,EACpB,sBAAsB,EACtB,IAAI,CACL,CAAC;AAEF,SAAgB,uBAAuB,CACrC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qCAA6B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACzD,6CAA6C,CAC9C,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,qBAAqB,GAChC,CAAC,CAAC,MAAM,CAAC;IACP,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEL,SAAgB,eAAe,CAC7B,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,6BAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjD,qCAAqC,CACtC,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,oBAAoB,GAA6C,CAAC;KAC5E,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,MAAM,EAAE,MAAM;KACf,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,SAAgB,cAAc,CAC5B,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4BAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChD,oCAAoC,CACrC,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,oBAAoB,GAA6C,CAAC;KAC5E,MAAM,CAAC;IACN,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAEL,SAAgB,cAAc,CAC5B,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4BAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChD,oCAAoC,CACrC,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,2BAA2B,GAIpC,SAAS,CAAC,aAAa,CAAC,qBAAa,CAAC,CAAC;AAE3C,gBAAgB;AACH,QAAA,yBAAyB,GAIlC,SAAS,CAAC,aAAa,CAAC,mBAAW,CAAC,CAAC;AAEzC,gBAAgB;AACH,QAAA,qBAAqB,GAChC,CAAC,CAAC,MAAM,CAAC;IACP,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC9C,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,qCAA6B,CAAC,CAAC,QAAQ,EAAE;IAChE,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,4CAA0B,CAAC,CAAC,QAAQ,EAAE;IAC/D,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,4CAA0B,CAAC,CAAC,QAAQ,EAAE;IACtD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,wDAAgC,CAAC,CAAC,QAAQ,EAAE;IACjE,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,6BAAqB,CAAC,CAAC,QAAQ,EAAE;IACvD,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CACjE,IAAI,IAAI,CAAC,CAAC,CAAC,CACZ,CAAC,QAAQ,EAAE;IACZ,WAAW,EAAE,CAAC,CAAC,QAAQ,CACrB,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAClE,CAAC,QAAQ,EAAE;IACZ,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,4BAAoB,CAAC,CAAC,QAAQ,EAAE;IACrD,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,4BAAoB,CAAC,CAAC,QAAQ,EAAE;IACrD,MAAM,EAAE,mCAA2B,CAAC,QAAQ,EAAE;IAC9C,IAAI,EAAE,iCAAyB,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC;AAEL,SAAgB,eAAe,CAC7B,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,6BAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjD,qCAAqC,CACtC,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/listingadvancedqueryrequest.d.ts

@@ -3,11 +3,11 @@ import { ClosedEnum } from "../../types/enums.js";
 import { ListingAreaFilter, ListingAreaFilter$Outbound } from "./listingareafilter.js";
 import { ListingQueryOperator, ListingQueryOperator$Outbound } from "./listingqueryoperator.js";
 /**
- * Comma-separated string or array of fields to include in the response. Reduces payload size by returning only what you request.
+ * Fields to include in each listing returned, as an array or as one comma-separated string. Defaults to the full set; naming fewer makes the response smaller.
  */
 export type ListingAdvancedQueryRequestAttributes = string | Array<string>;
 /**
- * Field to sort by (whitelisted).
+ * Field to sort by. Only the fields listed here can be sorted on.
  */
 export declare const ListingAdvancedQueryRequestField: {
     readonly PublishedDate: "publishedDate";
@@ -22,71 +22,71 @@ export declare const ListingAdvancedQueryRequestField: {
     readonly Doc: "_doc";
 };
 /**
- * Field to sort by (whitelisted).
+ * Field to sort by. Only the fields listed here can be sorted on.
  */
 export type ListingAdvancedQueryRequestField = ClosedEnum<typeof ListingAdvancedQueryRequestField>;
 /**
- * Placement of documents missing the field.
+ * Where to place listings that have no value for the field. Defaults to `_last`, after the listings that do have one.
  */
 export declare const ListingAdvancedQueryRequestMissing: {
     readonly First: "_first";
     readonly Last: "_last";
 };
 /**
- * Placement of documents missing the field.
+ * Where to place listings that have no value for the field. Defaults to `_last`, after the listings that do have one.
  */
 export type ListingAdvancedQueryRequestMissing = ClosedEnum<typeof ListingAdvancedQueryRequestMissing>;
 /**
- * Sort direction.
+ * Whether to sort ascending or descending.
  */
 export declare const ListingAdvancedQueryRequestOrder: {
     readonly Asc: "asc";
     readonly Desc: "desc";
 };
 /**
- * Sort direction.
+ * Whether to sort ascending or descending.
  */
 export type ListingAdvancedQueryRequestOrder = ClosedEnum<typeof ListingAdvancedQueryRequestOrder>;
 export type ListingAdvancedQueryRequestSort = {
     /**
-     * Field to sort by (whitelisted).
+     * Field to sort by. Only the fields listed here can be sorted on.
      */
     field: ListingAdvancedQueryRequestField;
     /**
-     * Placement of documents missing the field.
+     * Where to place listings that have no value for the field. Defaults to `_last`, after the listings that do have one.
      */
     missing?: ListingAdvancedQueryRequestMissing | undefined;
     /**
-     * Sort direction.
+     * Whether to sort ascending or descending.
      */
     order: ListingAdvancedQueryRequestOrder;
 };
 /**
- * Advanced, Elasticsearch-backed listing search. Combine geographic areas, a structured field query, sorting and sparse fieldsets. Returns aggregated listing documents.
+ * A search over the aggregated listings: areas to cover, a filter on the listing fields, how to sort, and which fields to return.
  */
 export type ListingAdvancedQueryRequest = {
     /**
-     * Geographic search areas. Multiple areas are combined with OR logic.
+     * Areas to search. A listing in any one of them is returned.
      */
     area?: Array<ListingAreaFilter> | undefined;
     /**
-     * Comma-separated string or array of fields to include in the response. Reduces payload size by returning only what you request.
+     * Fields to include in each listing returned, as an array or as one comma-separated string. Defaults to the full set; naming fewer makes the response smaller.
      */
     attributes?: string | Array<string> | undefined;
     /**
-     * Maximum results per page (1–100).
+     * Maximum number of listings to return. Defaults to 25. Minimum 1, maximum 100.
      */
     limit?: number | undefined;
     /**
-     * Number of results to skip for pagination.
+     * Number of results to skip before the first one returned. Defaults to 0. Maximum 10000.
      */
     offset?: number | undefined;
     /**
-     * Structured filter. Query groups are combined with OR; conditions within a group by the group operator.
+     * Filter on the listing fields. Conditions inside a group are combined by that entry's operator, and separate entries are combined so that a listing matching any of them is returned.
      */
     query?: Array<ListingQueryOperator> | undefined;
     /**
-     * Sort configuration (max 3 fields).
+     * How to sort the results. Up to 3 fields, applied in the order given.
      */
     sort?: Array<ListingAdvancedQueryRequestSort> | undefined;
 };

package/dist/commonjs/sdk/models/shared/listingadvancedqueryrequest.js

@@ -44,7 +44,7 @@ const z = __importStar(require("zod/v3"));
 const listingareafilter_js_1 = require("./listingareafilter.js");
 const listingqueryoperator_js_1 = require("./listingqueryoperator.js");
 /**
- * Field to sort by (whitelisted).
+ * Field to sort by. Only the fields listed here can be sorted on.
  */
 exports.ListingAdvancedQueryRequestField = {
     PublishedDate: "publishedDate",
@@ -59,14 +59,14 @@ exports.ListingAdvancedQueryRequestField = {
     Doc: "_doc",
 };
 /**
- * Placement of documents missing the field.
+ * Where to place listings that have no value for the field. Defaults to `_last`, after the listings that do have one.
  */
 exports.ListingAdvancedQueryRequestMissing = {
     First: "_first",
     Last: "_last",
 };
 /**
- * Sort direction.
+ * Whether to sort ascending or descending.
  */
 exports.ListingAdvancedQueryRequestOrder = {
     Asc: "asc",

package/dist/commonjs/sdk/models/shared/listingareafilter.d.ts

@@ -5,7 +5,7 @@ import { ListingPointAreaFilter, ListingPointAreaFilter$Outbound } from "./listi
 import { ListingPolygonAreaFilter, ListingPolygonAreaFilter$Outbound } from "./listingpolygonareafilter.js";
 import { ListingPostcodeAreaFilter, ListingPostcodeAreaFilter$Outbound } from "./listingpostcodeareafilter.js";
 /**
- * A geographic area filter. Multiple areas in a request are combined with OR logic.
+ * One area to search, given as a postcode, an outward code, a circle, a polygon or a set of polygons. Where a request carries several areas, a listing in any of them is returned.
  */
 export type ListingAreaFilter = ListingPostcodeAreaFilter | ListingOutcodeAreaFilter | ListingPointAreaFilter | ListingPolygonAreaFilter | ListingMultiPolygonAreaFilter;
 /** @internal */