@vepler/sdk 2.131.2 → 2.137.0

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

@@ -21,7 +21,7 @@ import {
 /**
  * Property features from listing
  */
-export type Features = {
+export type ListingFeatures = {
   alarm?: boolean | undefined;
   balcony?: boolean | undefined;
   cctv?: boolean | undefined;
@@ -43,7 +43,7 @@ export type Features = {
   terrace?: boolean | undefined;
   topFloor?: boolean | undefined;
   unfurnished?: boolean | undefined;
-  additionalProperties?: { [k: string]: any | null } | undefined;
+  additionalProperties?: { [k: string]: any } | undefined;
 };
 
 /**
@@ -115,7 +115,7 @@ export type Listing = {
   /**
    * Property features from listing
    */
-  features?: Features | undefined;
+  features?: ListingFeatures | undefined;
   /**
    * Floor plan images
    */
@@ -159,8 +159,8 @@ export type Listing = {
 };
 
 /** @internal */
-export const Features$inboundSchema: z.ZodType<
-  Features,
+export const ListingFeatures$inboundSchema: z.ZodType<
+  ListingFeatures,
   z.ZodTypeDef,
   unknown
 > = collectExtraKeys$(
@@ -191,13 +191,13 @@ export const Features$inboundSchema: z.ZodType<
   true,
 );
 
-export function featuresFromJSON(
+export function listingFeaturesFromJSON(
   jsonString: string,
-): SafeParseResult<Features, SDKValidationError> {
+): SafeParseResult<ListingFeatures, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Features$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Features' from JSON`,
+    (x) => ListingFeatures$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListingFeatures' from JSON`,
   );
 }
 
@@ -258,7 +258,7 @@ export const ListingType$inboundSchema: z.ZodType<
 export const Listing$inboundSchema: z.ZodType<Listing, z.ZodTypeDef, unknown> =
   z.object({
     description: z.nullable(z.string()).optional(),
-    features: z.lazy(() => Features$inboundSchema).optional(),
+    features: z.lazy(() => ListingFeatures$inboundSchema).optional(),
     floorPlanImages: z.array(ListingImage$inboundSchema).optional(),
     images: z.array(ListingImage$inboundSchema).optional(),
     listingId: z.string().optional(),

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

@@ -0,0 +1,216 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  ListingAreaFilter,
+  ListingAreaFilter$Outbound,
+  ListingAreaFilter$outboundSchema,
+} from "./listingareafilter.js";
+import {
+  ListingQueryOperator,
+  ListingQueryOperator$Outbound,
+  ListingQueryOperator$outboundSchema,
+} from "./listingqueryoperator.js";
+
+/**
+ * Comma-separated string or array of fields to include in the response. Reduces payload size by returning only what you request.
+ */
+export type ListingAdvancedQueryRequestAttributes = string | Array<string>;
+
+/**
+ * Field to sort by (whitelisted).
+ */
+export const ListingAdvancedQueryRequestField = {
+  PublishedDate: "publishedDate",
+  RemovedDate: "removedDate",
+  PricingPrice: "pricing.price",
+  PricingPricePerSqft: "pricing.pricePerSqft",
+  PricingPricePerSqm: "pricing.pricePerSqm",
+  RoomDetailsBeds: "roomDetails.beds",
+  RoomDetailsBaths: "roomDetails.baths",
+  BuildTotalFloorArea: "build.totalFloorArea",
+  Score: "_score",
+  Doc: "_doc",
+} as const;
+/**
+ * Field to sort by (whitelisted).
+ */
+export type ListingAdvancedQueryRequestField = ClosedEnum<
+  typeof ListingAdvancedQueryRequestField
+>;
+
+/**
+ * Placement of documents missing the field.
+ */
+export const ListingAdvancedQueryRequestMissing = {
+  First: "_first",
+  Last: "_last",
+} as const;
+/**
+ * Placement of documents missing the field.
+ */
+export type ListingAdvancedQueryRequestMissing = ClosedEnum<
+  typeof ListingAdvancedQueryRequestMissing
+>;
+
+/**
+ * Sort direction.
+ */
+export const ListingAdvancedQueryRequestOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+/**
+ * Sort direction.
+ */
+export type ListingAdvancedQueryRequestOrder = ClosedEnum<
+  typeof ListingAdvancedQueryRequestOrder
+>;
+
+export type ListingAdvancedQueryRequestSort = {
+  /**
+   * Field to sort by (whitelisted).
+   */
+  field: ListingAdvancedQueryRequestField;
+  /**
+   * Placement of documents missing the field.
+   */
+  missing?: ListingAdvancedQueryRequestMissing | undefined;
+  /**
+   * Sort direction.
+   */
+  order: ListingAdvancedQueryRequestOrder;
+};
+
+/**
+ * Advanced, Elasticsearch-backed listing search. Combine geographic areas, a structured field query, sorting and sparse fieldsets. Returns aggregated listing documents.
+ */
+export type ListingAdvancedQueryRequest = {
+  /**
+   * Geographic search areas. Multiple areas are combined with OR logic.
+   */
+  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.
+   */
+  attributes?: string | Array<string> | undefined;
+  /**
+   * Maximum results per page (1–100).
+   */
+  limit?: number | undefined;
+  /**
+   * Number of results to skip for pagination.
+   */
+  offset?: number | undefined;
+  /**
+   * Structured filter. Query groups are combined with OR; conditions within a group by the group operator.
+   */
+  query?: Array<ListingQueryOperator> | undefined;
+  /**
+   * Sort configuration (max 3 fields).
+   */
+  sort?: Array<ListingAdvancedQueryRequestSort> | undefined;
+};
+
+/** @internal */
+export type ListingAdvancedQueryRequestAttributes$Outbound =
+  | string
+  | Array<string>;
+
+/** @internal */
+export const ListingAdvancedQueryRequestAttributes$outboundSchema: z.ZodType<
+  ListingAdvancedQueryRequestAttributes$Outbound,
+  z.ZodTypeDef,
+  ListingAdvancedQueryRequestAttributes
+> = z.union([z.string(), z.array(z.string())]);
+
+export function listingAdvancedQueryRequestAttributesToJSON(
+  listingAdvancedQueryRequestAttributes: ListingAdvancedQueryRequestAttributes,
+): string {
+  return JSON.stringify(
+    ListingAdvancedQueryRequestAttributes$outboundSchema.parse(
+      listingAdvancedQueryRequestAttributes,
+    ),
+  );
+}
+
+/** @internal */
+export const ListingAdvancedQueryRequestField$outboundSchema: z.ZodNativeEnum<
+  typeof ListingAdvancedQueryRequestField
+> = z.nativeEnum(ListingAdvancedQueryRequestField);
+
+/** @internal */
+export const ListingAdvancedQueryRequestMissing$outboundSchema: z.ZodNativeEnum<
+  typeof ListingAdvancedQueryRequestMissing
+> = z.nativeEnum(ListingAdvancedQueryRequestMissing);
+
+/** @internal */
+export const ListingAdvancedQueryRequestOrder$outboundSchema: z.ZodNativeEnum<
+  typeof ListingAdvancedQueryRequestOrder
+> = z.nativeEnum(ListingAdvancedQueryRequestOrder);
+
+/** @internal */
+export type ListingAdvancedQueryRequestSort$Outbound = {
+  field: string;
+  missing?: string | undefined;
+  order: string;
+};
+
+/** @internal */
+export const ListingAdvancedQueryRequestSort$outboundSchema: z.ZodType<
+  ListingAdvancedQueryRequestSort$Outbound,
+  z.ZodTypeDef,
+  ListingAdvancedQueryRequestSort
+> = z.object({
+  field: ListingAdvancedQueryRequestField$outboundSchema,
+  missing: ListingAdvancedQueryRequestMissing$outboundSchema.optional(),
+  order: ListingAdvancedQueryRequestOrder$outboundSchema,
+});
+
+export function listingAdvancedQueryRequestSortToJSON(
+  listingAdvancedQueryRequestSort: ListingAdvancedQueryRequestSort,
+): string {
+  return JSON.stringify(
+    ListingAdvancedQueryRequestSort$outboundSchema.parse(
+      listingAdvancedQueryRequestSort,
+    ),
+  );
+}
+
+/** @internal */
+export type ListingAdvancedQueryRequest$Outbound = {
+  area?: Array<ListingAreaFilter$Outbound> | undefined;
+  attributes?: string | Array<string> | undefined;
+  limit: number;
+  offset: number;
+  query?: Array<ListingQueryOperator$Outbound> | undefined;
+  sort?: Array<ListingAdvancedQueryRequestSort$Outbound> | undefined;
+};
+
+/** @internal */
+export const ListingAdvancedQueryRequest$outboundSchema: z.ZodType<
+  ListingAdvancedQueryRequest$Outbound,
+  z.ZodTypeDef,
+  ListingAdvancedQueryRequest
+> = z.object({
+  area: z.array(ListingAreaFilter$outboundSchema).optional(),
+  attributes: z.union([z.string(), z.array(z.string())]).optional(),
+  limit: z.number().default(25),
+  offset: z.number().default(0),
+  query: z.array(ListingQueryOperator$outboundSchema).optional(),
+  sort: z.array(z.lazy(() => ListingAdvancedQueryRequestSort$outboundSchema))
+    .optional(),
+});
+
+export function listingAdvancedQueryRequestToJSON(
+  listingAdvancedQueryRequest: ListingAdvancedQueryRequest,
+): string {
+  return JSON.stringify(
+    ListingAdvancedQueryRequest$outboundSchema.parse(
+      listingAdvancedQueryRequest,
+    ),
+  );
+}

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

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  ListingMultiPolygonAreaFilter,
+  ListingMultiPolygonAreaFilter$Outbound,
+  ListingMultiPolygonAreaFilter$outboundSchema,
+} from "./listingmultipolygonareafilter.js";
+import {
+  ListingOutcodeAreaFilter,
+  ListingOutcodeAreaFilter$Outbound,
+  ListingOutcodeAreaFilter$outboundSchema,
+} from "./listingoutcodeareafilter.js";
+import {
+  ListingPointAreaFilter,
+  ListingPointAreaFilter$Outbound,
+  ListingPointAreaFilter$outboundSchema,
+} from "./listingpointareafilter.js";
+import {
+  ListingPolygonAreaFilter,
+  ListingPolygonAreaFilter$Outbound,
+  ListingPolygonAreaFilter$outboundSchema,
+} from "./listingpolygonareafilter.js";
+import {
+  ListingPostcodeAreaFilter,
+  ListingPostcodeAreaFilter$Outbound,
+  ListingPostcodeAreaFilter$outboundSchema,
+} from "./listingpostcodeareafilter.js";
+
+/**
+ * A geographic area filter. Multiple areas in a request are combined with OR logic.
+ */
+export type ListingAreaFilter =
+  | ListingPostcodeAreaFilter
+  | ListingOutcodeAreaFilter
+  | ListingPointAreaFilter
+  | ListingPolygonAreaFilter
+  | ListingMultiPolygonAreaFilter;
+
+/** @internal */
+export type ListingAreaFilter$Outbound =
+  | ListingPostcodeAreaFilter$Outbound
+  | ListingOutcodeAreaFilter$Outbound
+  | ListingPointAreaFilter$Outbound
+  | ListingPolygonAreaFilter$Outbound
+  | ListingMultiPolygonAreaFilter$Outbound;
+
+/** @internal */
+export const ListingAreaFilter$outboundSchema: z.ZodType<
+  ListingAreaFilter$Outbound,
+  z.ZodTypeDef,
+  ListingAreaFilter
+> = z.union([
+  ListingPostcodeAreaFilter$outboundSchema,
+  ListingOutcodeAreaFilter$outboundSchema,
+  ListingPointAreaFilter$outboundSchema,
+  ListingPolygonAreaFilter$outboundSchema,
+  ListingMultiPolygonAreaFilter$outboundSchema,
+]);
+
+export function listingAreaFilterToJSON(
+  listingAreaFilter: ListingAreaFilter,
+): string {
+  return JSON.stringify(
+    ListingAreaFilter$outboundSchema.parse(listingAreaFilter),
+  );
+}

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListingMultiPolygonAreaFilter = {
+  /**
+   * Array of polygons, each a list of rings of [longitude, latitude] pairs (GeoJSON order).
+   */
+  coordinates: Array<Array<Array<Array<number>>>>;
+  type: "multipolygon";
+};
+
+/** @internal */
+export type ListingMultiPolygonAreaFilter$Outbound = {
+  coordinates: Array<Array<Array<Array<number>>>>;
+  type: "multipolygon";
+};
+
+/** @internal */
+export const ListingMultiPolygonAreaFilter$outboundSchema: z.ZodType<
+  ListingMultiPolygonAreaFilter$Outbound,
+  z.ZodTypeDef,
+  ListingMultiPolygonAreaFilter
+> = z.object({
+  coordinates: z.array(z.array(z.array(z.array(z.number())))),
+  type: z.literal("multipolygon"),
+});
+
+export function listingMultiPolygonAreaFilterToJSON(
+  listingMultiPolygonAreaFilter: ListingMultiPolygonAreaFilter,
+): string {
+  return JSON.stringify(
+    ListingMultiPolygonAreaFilter$outboundSchema.parse(
+      listingMultiPolygonAreaFilter,
+    ),
+  );
+}

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListingOutcodeAreaFilter = {
+  type: "outcode";
+  /**
+   * Postcode outcode (the part before the space).
+   */
+  value: string;
+};
+
+/** @internal */
+export type ListingOutcodeAreaFilter$Outbound = {
+  type: "outcode";
+  value: string;
+};
+
+/** @internal */
+export const ListingOutcodeAreaFilter$outboundSchema: z.ZodType<
+  ListingOutcodeAreaFilter$Outbound,
+  z.ZodTypeDef,
+  ListingOutcodeAreaFilter
+> = z.object({
+  type: z.literal("outcode"),
+  value: z.string(),
+});
+
+export function listingOutcodeAreaFilterToJSON(
+  listingOutcodeAreaFilter: ListingOutcodeAreaFilter,
+): string {
+  return JSON.stringify(
+    ListingOutcodeAreaFilter$outboundSchema.parse(listingOutcodeAreaFilter),
+  );
+}

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

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListingPointAreaFilter = {
+  /**
+   * [longitude, latitude] in WGS84 decimal degrees (GeoJSON order).
+   */
+  coordinates: Array<number>;
+  /**
+   * Search radius in metres.
+   */
+  radius: number;
+  type: "point";
+};
+
+/** @internal */
+export type ListingPointAreaFilter$Outbound = {
+  coordinates: Array<number>;
+  radius: number;
+  type: "point";
+};
+
+/** @internal */
+export const ListingPointAreaFilter$outboundSchema: z.ZodType<
+  ListingPointAreaFilter$Outbound,
+  z.ZodTypeDef,
+  ListingPointAreaFilter
+> = z.object({
+  coordinates: z.array(z.number()),
+  radius: z.number(),
+  type: z.literal("point"),
+});
+
+export function listingPointAreaFilterToJSON(
+  listingPointAreaFilter: ListingPointAreaFilter,
+): string {
+  return JSON.stringify(
+    ListingPointAreaFilter$outboundSchema.parse(listingPointAreaFilter),
+  );
+}

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListingPolygonAreaFilter = {
+  /**
+   * Polygon ring coordinates as [longitude, latitude] pairs (GeoJSON order). The first and last coordinate of each ring must match to close it.
+   */
+  coordinates: Array<Array<Array<number>>>;
+  type: "polygon";
+};
+
+/** @internal */
+export type ListingPolygonAreaFilter$Outbound = {
+  coordinates: Array<Array<Array<number>>>;
+  type: "polygon";
+};
+
+/** @internal */
+export const ListingPolygonAreaFilter$outboundSchema: z.ZodType<
+  ListingPolygonAreaFilter$Outbound,
+  z.ZodTypeDef,
+  ListingPolygonAreaFilter
+> = z.object({
+  coordinates: z.array(z.array(z.array(z.number()))),
+  type: z.literal("polygon"),
+});
+
+export function listingPolygonAreaFilterToJSON(
+  listingPolygonAreaFilter: ListingPolygonAreaFilter,
+): string {
+  return JSON.stringify(
+    ListingPolygonAreaFilter$outboundSchema.parse(listingPolygonAreaFilter),
+  );
+}

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListingPostcodeAreaFilter = {
+  type: "postcode";
+  /**
+   * Full or partial postcode (spaces ignored).
+   */
+  value: string;
+};
+
+/** @internal */
+export type ListingPostcodeAreaFilter$Outbound = {
+  type: "postcode";
+  value: string;
+};
+
+/** @internal */
+export const ListingPostcodeAreaFilter$outboundSchema: z.ZodType<
+  ListingPostcodeAreaFilter$Outbound,
+  z.ZodTypeDef,
+  ListingPostcodeAreaFilter
+> = z.object({
+  type: z.literal("postcode"),
+  value: z.string(),
+});
+
+export function listingPostcodeAreaFilterToJSON(
+  listingPostcodeAreaFilter: ListingPostcodeAreaFilter,
+): string {
+  return JSON.stringify(
+    ListingPostcodeAreaFilter$outboundSchema.parse(listingPostcodeAreaFilter),
+  );
+}

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

@@ -0,0 +1,133 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Comparison operator. Range operators (gt/gte/lt/lte) apply to numeric and date fields.
+ */
+export const ListingQueryConditionComparator = {
+  Eq: "eq",
+  Ne: "ne",
+  Gt: "gt",
+  Gte: "gte",
+  Lt: "lt",
+  Lte: "lte",
+  In: "in",
+  Nin: "nin",
+} as const;
+/**
+ * Comparison operator. Range operators (gt/gte/lt/lte) apply to numeric and date fields.
+ */
+export type ListingQueryConditionComparator = ClosedEnum<
+  typeof ListingQueryConditionComparator
+>;
+
+export type ListingQueryCondition4 = string | number | boolean;
+
+/**
+ * Value to compare against. Use an array with 'in'/'nin'.
+ */
+export type ListingQueryConditionValue =
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean>;
+
+export type ListingQueryCondition = {
+  /**
+   * Comparison operator. Range operators (gt/gte/lt/lte) apply to numeric and date fields.
+   */
+  comparator: ListingQueryConditionComparator;
+  /**
+   * Field to filter on (Elasticsearch path). Examples: status, type, roomDetails.beds, pricing.price, build.propertyType, tenure.type, address.outcode, publishedDate.
+   */
+  field: string;
+  /**
+   * Value to compare against. Use an array with 'in'/'nin'.
+   */
+  value: string | number | boolean | Array<string | number | boolean>;
+};
+
+/** @internal */
+export const ListingQueryConditionComparator$outboundSchema: z.ZodNativeEnum<
+  typeof ListingQueryConditionComparator
+> = z.nativeEnum(ListingQueryConditionComparator);
+
+/** @internal */
+export type ListingQueryCondition4$Outbound = string | number | boolean;
+
+/** @internal */
+export const ListingQueryCondition4$outboundSchema: z.ZodType<
+  ListingQueryCondition4$Outbound,
+  z.ZodTypeDef,
+  ListingQueryCondition4
+> = z.union([z.string(), z.number(), z.boolean()]);
+
+export function listingQueryCondition4ToJSON(
+  listingQueryCondition4: ListingQueryCondition4,
+): string {
+  return JSON.stringify(
+    ListingQueryCondition4$outboundSchema.parse(listingQueryCondition4),
+  );
+}
+
+/** @internal */
+export type ListingQueryConditionValue$Outbound =
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean>;
+
+/** @internal */
+export const ListingQueryConditionValue$outboundSchema: z.ZodType<
+  ListingQueryConditionValue$Outbound,
+  z.ZodTypeDef,
+  ListingQueryConditionValue
+> = z.union([
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.array(z.union([z.string(), z.number(), z.boolean()])),
+]);
+
+export function listingQueryConditionValueToJSON(
+  listingQueryConditionValue: ListingQueryConditionValue,
+): string {
+  return JSON.stringify(
+    ListingQueryConditionValue$outboundSchema.parse(listingQueryConditionValue),
+  );
+}
+
+/** @internal */
+export type ListingQueryCondition$Outbound = {
+  comparator: string;
+  field: string;
+  value: string | number | boolean | Array<string | number | boolean>;
+};
+
+/** @internal */
+export const ListingQueryCondition$outboundSchema: z.ZodType<
+  ListingQueryCondition$Outbound,
+  z.ZodTypeDef,
+  ListingQueryCondition
+> = z.object({
+  comparator: ListingQueryConditionComparator$outboundSchema,
+  field: z.string(),
+  value: z.union([
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.array(z.union([z.string(), z.number(), z.boolean()])),
+  ]),
+});
+
+export function listingQueryConditionToJSON(
+  listingQueryCondition: ListingQueryCondition,
+): string {
+  return JSON.stringify(
+    ListingQueryCondition$outboundSchema.parse(listingQueryCondition),
+  );
+}