@vepler/sdk 1.10.1 → 2.3.0

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,43 +2,47 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export const Type = {
+export const PropertyMultiPolygonAreaFilterType = {
   Multipolygon: "multipolygon",
 } as const;
-export type Type = ClosedEnum<typeof Type>;
+export type PropertyMultiPolygonAreaFilterType = ClosedEnum<
+  typeof PropertyMultiPolygonAreaFilterType
+>;
 
 export type PropertyMultiPolygonAreaFilter = {
   /**
    * Array of multipolygon coordinates
    */
   coordinates: Array<Array<Array<Array<number>>>>;
-  type: Type;
+  type: PropertyMultiPolygonAreaFilterType;
 };
 
 /** @internal */
-export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
-  Type,
-);
+export const PropertyMultiPolygonAreaFilterType$inboundSchema: z.ZodNativeEnum<
+  typeof PropertyMultiPolygonAreaFilterType
+> = z.nativeEnum(PropertyMultiPolygonAreaFilterType);
 
 /** @internal */
-export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
-  Type$inboundSchema;
+export const PropertyMultiPolygonAreaFilterType$outboundSchema: z.ZodNativeEnum<
+  typeof PropertyMultiPolygonAreaFilterType
+> = PropertyMultiPolygonAreaFilterType$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace Type$ {
-  /** @deprecated use `Type$inboundSchema` instead. */
-  export const inboundSchema = Type$inboundSchema;
-  /** @deprecated use `Type$outboundSchema` instead. */
-  export const outboundSchema = Type$outboundSchema;
+export namespace PropertyMultiPolygonAreaFilterType$ {
+  /** @deprecated use `PropertyMultiPolygonAreaFilterType$inboundSchema` instead. */
+  export const inboundSchema = PropertyMultiPolygonAreaFilterType$inboundSchema;
+  /** @deprecated use `PropertyMultiPolygonAreaFilterType$outboundSchema` instead. */
+  export const outboundSchema =
+    PropertyMultiPolygonAreaFilterType$outboundSchema;
 }
 
 /** @internal */
@@ -48,7 +52,7 @@ export const PropertyMultiPolygonAreaFilter$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   coordinates: z.array(z.array(z.array(z.array(z.number())))),
-  type: Type$inboundSchema,
+  type: PropertyMultiPolygonAreaFilterType$inboundSchema,
 });
 
 /** @internal */
@@ -64,7 +68,7 @@ export const PropertyMultiPolygonAreaFilter$outboundSchema: z.ZodType<
   PropertyMultiPolygonAreaFilter
 > = z.object({
   coordinates: z.array(z.array(z.array(z.array(z.number())))),
-  type: Type$outboundSchema,
+  type: PropertyMultiPolygonAreaFilterType$outboundSchema,
 });
 
 /**

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

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

@@ -2,8 +2,9 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
@@ -24,6 +25,93 @@ import {
  */
 export type Attributes = string | Array<string>;
 
+/**
+ * Field to sort by (whitelisted fields only)
+ */
+export const Field = {
+  MarketStatusLastOTM: "marketStatus.lastOTM",
+  MarketStatusLastOTMRent: "marketStatus.lastOTMRent",
+  MarketStatusBackOTM: "marketStatus.backOTM",
+  MarketStatusBackOTMRent: "marketStatus.backOTMRent",
+  MarketStatusSstcDate: "marketStatus.sstcDate",
+  MarketStatusUnderOfferDate: "marketStatus.underOfferDate",
+  MarketStatusReservedDate: "marketStatus.reservedDate",
+  PricingCurrentSale: "pricing.currentSale",
+  PricingCurrentRent: "pricing.currentRent",
+  PricingPredictedPrice: "pricing.predictedPrice",
+  MarketStatusPricePerSqft: "marketStatus.pricePerSqft",
+  MarketStatusPricePerSqm: "marketStatus.pricePerSqm",
+  RoomDetailsBeds: "roomDetails.beds",
+  RoomDetailsBaths: "roomDetails.baths",
+  BuildTotalFloorArea: "build.totalFloorArea",
+  BuildPlotSize: "build.plotSize",
+  BuildConstructionAgeMidYear: "build.constructionAge.midYear",
+  Score: "_score",
+  Doc: "_doc",
+} as const;
+/**
+ * Field to sort by (whitelisted fields only)
+ */
+export type Field = ClosedEnum<typeof Field>;
+
+/**
+ * How to handle missing values
+ */
+export const Missing = {
+  First: "_first",
+  Last: "_last",
+} as const;
+/**
+ * How to handle missing values
+ */
+export type Missing = ClosedEnum<typeof Missing>;
+
+/**
+ * Mode for multi-valued fields
+ */
+export const Mode = {
+  Min: "min",
+  Max: "max",
+  Sum: "sum",
+  Avg: "avg",
+  Median: "median",
+} as const;
+/**
+ * Mode for multi-valued fields
+ */
+export type Mode = ClosedEnum<typeof Mode>;
+
+/**
+ * Sort order
+ */
+export const Order = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+/**
+ * Sort order
+ */
+export type Order = ClosedEnum<typeof Order>;
+
+export type Sort = {
+  /**
+   * Field to sort by (whitelisted fields only)
+   */
+  field: Field;
+  /**
+   * How to handle missing values
+   */
+  missing?: Missing | undefined;
+  /**
+   * Mode for multi-valued fields
+   */
+  mode?: Mode | undefined;
+  /**
+   * Sort order
+   */
+  order: Order;
+};
+
 export type PropertyQueryRequest = {
   /**
    * Geographic search areas (multiple areas will be combined with OR logic)
@@ -45,6 +133,10 @@ export type PropertyQueryRequest = {
    * Array of query operators for filtering
    */
   query: Array<PropertyQueryOperator>;
+  /**
+   * Sort configuration (max 3 fields)
+   */
+  sort?: Array<Sort> | undefined;
   /**
    * Enable tracking for billing purposes
    */
@@ -95,6 +187,138 @@ export function attributesFromJSON(
   );
 }
 
+/** @internal */
+export const Field$inboundSchema: z.ZodNativeEnum<typeof Field> = z.nativeEnum(
+  Field,
+);
+
+/** @internal */
+export const Field$outboundSchema: z.ZodNativeEnum<typeof Field> =
+  Field$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Field$ {
+  /** @deprecated use `Field$inboundSchema` instead. */
+  export const inboundSchema = Field$inboundSchema;
+  /** @deprecated use `Field$outboundSchema` instead. */
+  export const outboundSchema = Field$outboundSchema;
+}
+
+/** @internal */
+export const Missing$inboundSchema: z.ZodNativeEnum<typeof Missing> = z
+  .nativeEnum(Missing);
+
+/** @internal */
+export const Missing$outboundSchema: z.ZodNativeEnum<typeof Missing> =
+  Missing$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Missing$ {
+  /** @deprecated use `Missing$inboundSchema` instead. */
+  export const inboundSchema = Missing$inboundSchema;
+  /** @deprecated use `Missing$outboundSchema` instead. */
+  export const outboundSchema = Missing$outboundSchema;
+}
+
+/** @internal */
+export const Mode$inboundSchema: z.ZodNativeEnum<typeof Mode> = z.nativeEnum(
+  Mode,
+);
+
+/** @internal */
+export const Mode$outboundSchema: z.ZodNativeEnum<typeof Mode> =
+  Mode$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Mode$ {
+  /** @deprecated use `Mode$inboundSchema` instead. */
+  export const inboundSchema = Mode$inboundSchema;
+  /** @deprecated use `Mode$outboundSchema` instead. */
+  export const outboundSchema = Mode$outboundSchema;
+}
+
+/** @internal */
+export const Order$inboundSchema: z.ZodNativeEnum<typeof Order> = z.nativeEnum(
+  Order,
+);
+
+/** @internal */
+export const Order$outboundSchema: z.ZodNativeEnum<typeof Order> =
+  Order$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Order$ {
+  /** @deprecated use `Order$inboundSchema` instead. */
+  export const inboundSchema = Order$inboundSchema;
+  /** @deprecated use `Order$outboundSchema` instead. */
+  export const outboundSchema = Order$outboundSchema;
+}
+
+/** @internal */
+export const Sort$inboundSchema: z.ZodType<Sort, z.ZodTypeDef, unknown> = z
+  .object({
+    field: Field$inboundSchema,
+    missing: Missing$inboundSchema.optional(),
+    mode: Mode$inboundSchema.optional(),
+    order: Order$inboundSchema,
+  });
+
+/** @internal */
+export type Sort$Outbound = {
+  field: string;
+  missing?: string | undefined;
+  mode?: string | undefined;
+  order: string;
+};
+
+/** @internal */
+export const Sort$outboundSchema: z.ZodType<Sort$Outbound, z.ZodTypeDef, Sort> =
+  z.object({
+    field: Field$outboundSchema,
+    missing: Missing$outboundSchema.optional(),
+    mode: Mode$outboundSchema.optional(),
+    order: Order$outboundSchema,
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Sort$ {
+  /** @deprecated use `Sort$inboundSchema` instead. */
+  export const inboundSchema = Sort$inboundSchema;
+  /** @deprecated use `Sort$outboundSchema` instead. */
+  export const outboundSchema = Sort$outboundSchema;
+  /** @deprecated use `Sort$Outbound` instead. */
+  export type Outbound = Sort$Outbound;
+}
+
+export function sortToJSON(sort: Sort): string {
+  return JSON.stringify(Sort$outboundSchema.parse(sort));
+}
+
+export function sortFromJSON(
+  jsonString: string,
+): SafeParseResult<Sort, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Sort$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Sort' from JSON`,
+  );
+}
+
 /** @internal */
 export const PropertyQueryRequest$inboundSchema: z.ZodType<
   PropertyQueryRequest,
@@ -106,6 +330,7 @@ export const PropertyQueryRequest$inboundSchema: z.ZodType<
   limit: z.number().default(25),
   offset: z.number().default(0),
   query: z.array(PropertyQueryOperator$inboundSchema),
+  sort: z.array(z.lazy(() => Sort$inboundSchema)).optional(),
   track: z.boolean().default(false),
 });
 
@@ -116,6 +341,7 @@ export type PropertyQueryRequest$Outbound = {
   limit: number;
   offset: number;
   query: Array<PropertyQueryOperator$Outbound>;
+  sort?: Array<Sort$Outbound> | undefined;
   track: boolean;
 };
 
@@ -130,6 +356,7 @@ export const PropertyQueryRequest$outboundSchema: z.ZodType<
   limit: z.number().default(25),
   offset: z.number().default(0),
   query: z.array(PropertyQueryOperator$outboundSchema),
+  sort: z.array(z.lazy(() => Sort$outboundSchema)).optional(),
   track: z.boolean().default(false),
 });
 

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

@@ -2,40 +2,64 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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 PropertyTags = {
+  /**
+   * Property has agricultural tie restriction
+   */
+  agriculturalTie: boolean;
   /**
    * Is this property being sold at auction
    */
-  auction?: boolean | undefined;
+  auction: boolean;
+  /**
+   * Below Market Value property
+   */
+  bmv: boolean;
   /**
    * Cash buyers only
    */
-  cashBuyersOnly?: boolean | undefined;
+  cashBuyers: boolean;
   /**
    * Is this property chain free
    */
-  chainFree?: boolean | undefined;
+  chainFree: boolean;
+  /**
+   * House in Multiple Occupation
+   */
+  hmo: boolean;
   /**
-   * Investment opportunity
+   * Property in negative equity
    */
-  investment?: boolean | undefined;
+  negativeEquity: boolean;
   /**
-   * Is this a new build property
+   * Is this a new build scheme property
    */
-  newBuild?: boolean | undefined;
+  newBuildScheme: boolean;
+  /**
+   * Quick sale property
+   */
+  quickSale: boolean;
   /**
    * Is this a retirement property
    */
-  retirement?: boolean | undefined;
+  retirement: boolean;
   /**
    * Is this a shared ownership property
    */
-  sharedOwnership?: boolean | undefined;
+  sharedOwnership: boolean;
+  /**
+   * Property is slow to sell
+   */
+  slowToSell: boolean;
+  /**
+   * Property is unmodernised
+   */
+  unmodernised: boolean;
 };
 
 /** @internal */
@@ -44,24 +68,36 @@ export const PropertyTags$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  auction: z.boolean().default(false),
-  cashBuyersOnly: z.boolean().default(false),
-  chainFree: z.boolean().default(false),
-  investment: z.boolean().default(false),
-  newBuild: z.boolean().default(false),
-  retirement: z.boolean().default(false),
-  sharedOwnership: z.boolean().default(false),
+  agriculturalTie: z.boolean(),
+  auction: z.boolean(),
+  bmv: z.boolean(),
+  cashBuyers: z.boolean(),
+  chainFree: z.boolean(),
+  hmo: z.boolean(),
+  negativeEquity: z.boolean(),
+  newBuildScheme: z.boolean(),
+  quickSale: z.boolean(),
+  retirement: z.boolean(),
+  sharedOwnership: z.boolean(),
+  slowToSell: z.boolean(),
+  unmodernised: z.boolean(),
 });
 
 /** @internal */
 export type PropertyTags$Outbound = {
+  agriculturalTie: boolean;
   auction: boolean;
-  cashBuyersOnly: boolean;
+  bmv: boolean;
+  cashBuyers: boolean;
   chainFree: boolean;
-  investment: boolean;
-  newBuild: boolean;
+  hmo: boolean;
+  negativeEquity: boolean;
+  newBuildScheme: boolean;
+  quickSale: boolean;
   retirement: boolean;
   sharedOwnership: boolean;
+  slowToSell: boolean;
+  unmodernised: boolean;
 };
 
 /** @internal */
@@ -70,13 +106,19 @@ export const PropertyTags$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PropertyTags
 > = z.object({
-  auction: z.boolean().default(false),
-  cashBuyersOnly: z.boolean().default(false),
-  chainFree: z.boolean().default(false),
-  investment: z.boolean().default(false),
-  newBuild: z.boolean().default(false),
-  retirement: z.boolean().default(false),
-  sharedOwnership: z.boolean().default(false),
+  agriculturalTie: z.boolean(),
+  auction: z.boolean(),
+  bmv: z.boolean(),
+  cashBuyers: z.boolean(),
+  chainFree: z.boolean(),
+  hmo: z.boolean(),
+  negativeEquity: z.boolean(),
+  newBuildScheme: z.boolean(),
+  quickSale: z.boolean(),
+  retirement: z.boolean(),
+  sharedOwnership: z.boolean(),
+  slowToSell: z.boolean(),
+  unmodernised: z.boolean(),
 });
 
 /**