@vepler/sdk 2.6.5 → 2.8.0

package/src/sdk/models/shared/{propertydata.ts → propertydataapi.ts}

@@ -33,17 +33,11 @@ import { SaleRecord, SaleRecord$inboundSchema } from "./salerecord.js";
 import { TenancyData, TenancyData$inboundSchema } from "./tenancydata.js";
 import { TenureData, TenureData$inboundSchema } from "./tenuredata.js";
 
-/**
- * Property charges including service charge and ground rent
- */
 export type Charges = {
   groundRent?: ChargeHistory | null | undefined;
   serviceCharge?: ChargeHistory | null | undefined;
 };
 
-/**
- * Property classification code
- */
 export const ClassificationCode = {
   Rd: "RD",
   Rd01: "RD01",
@@ -283,169 +277,85 @@ export const ClassificationCode = {
   Zw99Tp: "ZW99TP",
   Zw99Lg: "ZW99LG",
 } as const;
-/**
- * Property classification code
- */
 export type ClassificationCode = ClosedEnum<typeof ClassificationCode>;
 
-/**
- * Flood risk information
- */
 export type FloodRisk = {
-  /**
-   * Flood risk level
-   */
-  riskLevel: string;
-  /**
-   * Suitability assessment
-   */
+  riskLevel?: string | undefined;
   suitability?: string | null | undefined;
 };
 
-/**
- * Property category
- */
 export const PropertyCategory = {
   Residential: "residential",
   Commercial: "commercial",
 } as const;
-/**
- * Property category
- */
 export type PropertyCategory = ClosedEnum<typeof PropertyCategory>;
 
-export const PropertyDataSchemasType = {
+export const PropertyDataApiSchemasType = {
   MultiPolygon: "MultiPolygon",
 } as const;
-export type PropertyDataSchemasType = ClosedEnum<
-  typeof PropertyDataSchemasType
+export type PropertyDataApiSchemasType = ClosedEnum<
+  typeof PropertyDataApiSchemasType
 >;
 
 export type Two = {
   coordinates: Array<Array<Array<Array<number>>>>;
-  type: PropertyDataSchemasType;
+  type: PropertyDataApiSchemasType;
 };
 
-export const PropertyDataSchemasSpatialType = {
+export const PropertyDataApiSchemasSpatialType = {
   Polygon: "Polygon",
 } as const;
-export type PropertyDataSchemasSpatialType = ClosedEnum<
-  typeof PropertyDataSchemasSpatialType
+export type PropertyDataApiSchemasSpatialType = ClosedEnum<
+  typeof PropertyDataApiSchemasSpatialType
 >;
 
 export type One = {
   coordinates: Array<Array<Array<number>>>;
-  type: PropertyDataSchemasSpatialType;
+  type: PropertyDataApiSchemasSpatialType;
 };
 
-/**
- * Property boundary GeoJSON (Polygon or MultiPolygon)
- */
 export type Boundary = One | Two;
 
-/**
- * GeoJSON geometry type
- */
-export const PropertyDataType = {
+export const PropertyDataApiType = {
   Point: "Point",
 } as const;
-/**
- * GeoJSON geometry type
- */
-export type PropertyDataType = ClosedEnum<typeof PropertyDataType>;
+export type PropertyDataApiType = ClosedEnum<typeof PropertyDataApiType>;
 
-export type PropertyDataSpatial = {
-  /**
-   * Property boundary GeoJSON (Polygon or MultiPolygon)
-   */
+export type PropertyDataApiSpatial = {
   boundary?: One | Two | undefined;
-  /**
-   * Coordinates as [longitude, latitude] following GeoJSON standard
-   */
   coordinates?: Array<number> | undefined;
-  /**
-   * GeoJSON geometry type
-   */
-  type?: PropertyDataType | undefined;
+  type?: PropertyDataApiType | undefined;
 };
 
-export type PropertyData = {
+export type PropertyDataApi = {
   address?: PropertyAddress | undefined;
   build?: BuildData | undefined;
-  /**
-   * Property charges including service charge and ground rent
-   */
   charges?: Charges | undefined;
-  /**
-   * Property classification code
-   */
   classificationCode?: ClassificationCode | null | undefined;
   councilTax?: CouncilTaxData | undefined;
   epc?: EPCData | undefined;
-  /**
-   * Flood risk information
-   */
   floodRisk?: FloodRisk | undefined;
-  /**
-   * Lease records for leasehold properties
-   */
   leases?: Array<Lease> | undefined;
-  /**
-   * Property listings with images and details
-   */
   listings?: Array<Listing> | undefined;
   /**
    * Location identifier (always returned)
    */
-  locationId: string;
+  locationId?: string | undefined;
   marketStatus?: MarketStatus | undefined;
-  /**
-   * Property overlays and designations
-   */
   overlays?: Array<string> | undefined;
-  /**
-   * Parent location identifier
-   */
   parentLocationId?: string | null | undefined;
-  /**
-   * Rent price change history
-   */
   priceChangeRent?: Array<PriceChange> | undefined;
-  /**
-   * Sale price change history
-   */
   priceChangeSale?: Array<PriceChange> | undefined;
   pricing?: PricingData | undefined;
-  /**
-   * Property category
-   */
   propertyCategory?: PropertyCategory | null | undefined;
-  /**
-   * Unique property identifier
-   */
   propertyId?: string | undefined;
   refurbishment?: RefurbishmentData | undefined;
-  /**
-   * Related property IDs
-   */
   relationships?: Array<string> | undefined;
   roomDetails?: RoomDetails | undefined;
-  /**
-   * Historical sale records
-   */
   saleHistory?: Array<SaleRecord> | undefined;
-  /**
-   * SEO-friendly URL slug
-   */
   slug?: string | undefined;
-  /**
-   * Data source identifiers
-   */
   sources?: Array<string> | undefined;
-  spatial?: PropertyDataSpatial | undefined;
-  /**
-   * Street identifiers
-   */
+  spatial?: PropertyDataApiSpatial | undefined;
   streetIds?: Array<number> | undefined;
   tags?: PropertyTags | undefined;
   tenancy?: TenancyData | undefined;
@@ -480,7 +390,7 @@ export const FloodRisk$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  riskLevel: z.string(),
+  riskLevel: z.string().optional(),
   suitability: z.nullable(z.string()).optional(),
 });
 
@@ -500,15 +410,15 @@ export const PropertyCategory$inboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(PropertyCategory);
 
 /** @internal */
-export const PropertyDataSchemasType$inboundSchema: z.ZodNativeEnum<
-  typeof PropertyDataSchemasType
-> = z.nativeEnum(PropertyDataSchemasType);
+export const PropertyDataApiSchemasType$inboundSchema: z.ZodNativeEnum<
+  typeof PropertyDataApiSchemasType
+> = z.nativeEnum(PropertyDataApiSchemasType);
 
 /** @internal */
 export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
   .object({
     coordinates: z.array(z.array(z.array(z.array(z.number())))),
-    type: PropertyDataSchemasType$inboundSchema,
+    type: PropertyDataApiSchemasType$inboundSchema,
   });
 
 export function twoFromJSON(
@@ -522,15 +432,15 @@ export function twoFromJSON(
 }
 
 /** @internal */
-export const PropertyDataSchemasSpatialType$inboundSchema: z.ZodNativeEnum<
-  typeof PropertyDataSchemasSpatialType
-> = z.nativeEnum(PropertyDataSchemasSpatialType);
+export const PropertyDataApiSchemasSpatialType$inboundSchema: z.ZodNativeEnum<
+  typeof PropertyDataApiSchemasSpatialType
+> = z.nativeEnum(PropertyDataApiSchemasSpatialType);
 
 /** @internal */
 export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
   .object({
     coordinates: z.array(z.array(z.array(z.number()))),
-    type: PropertyDataSchemasSpatialType$inboundSchema,
+    type: PropertyDataApiSchemasSpatialType$inboundSchema,
   });
 
 export function oneFromJSON(
@@ -561,13 +471,13 @@ export function boundaryFromJSON(
 }
 
 /** @internal */
-export const PropertyDataType$inboundSchema: z.ZodNativeEnum<
-  typeof PropertyDataType
-> = z.nativeEnum(PropertyDataType);
+export const PropertyDataApiType$inboundSchema: z.ZodNativeEnum<
+  typeof PropertyDataApiType
+> = z.nativeEnum(PropertyDataApiType);
 
 /** @internal */
-export const PropertyDataSpatial$inboundSchema: z.ZodType<
-  PropertyDataSpatial,
+export const PropertyDataApiSpatial$inboundSchema: z.ZodType<
+  PropertyDataApiSpatial,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -576,22 +486,22 @@ export const PropertyDataSpatial$inboundSchema: z.ZodType<
     z.lazy(() => Two$inboundSchema),
   ]).optional(),
   coordinates: z.array(z.number()).optional(),
-  type: PropertyDataType$inboundSchema.optional(),
+  type: PropertyDataApiType$inboundSchema.optional(),
 });
 
-export function propertyDataSpatialFromJSON(
+export function propertyDataApiSpatialFromJSON(
   jsonString: string,
-): SafeParseResult<PropertyDataSpatial, SDKValidationError> {
+): SafeParseResult<PropertyDataApiSpatial, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => PropertyDataSpatial$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PropertyDataSpatial' from JSON`,
+    (x) => PropertyDataApiSpatial$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyDataApiSpatial' from JSON`,
   );
 }
 
 /** @internal */
-export const PropertyData$inboundSchema: z.ZodType<
-  PropertyData,
+export const PropertyDataApi$inboundSchema: z.ZodType<
+  PropertyDataApi,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -604,7 +514,7 @@ export const PropertyData$inboundSchema: z.ZodType<
   floodRisk: z.lazy(() => FloodRisk$inboundSchema).optional(),
   leases: z.array(Lease$inboundSchema).optional(),
   listings: z.array(Listing$inboundSchema).optional(),
-  locationId: z.string(),
+  locationId: z.string().optional(),
   marketStatus: MarketStatus$inboundSchema.optional(),
   overlays: z.array(z.string()).optional(),
   parentLocationId: z.nullable(z.string()).optional(),
@@ -619,19 +529,19 @@ export const PropertyData$inboundSchema: z.ZodType<
   saleHistory: z.array(SaleRecord$inboundSchema).optional(),
   slug: z.string().optional(),
   sources: z.array(z.string()).optional(),
-  spatial: z.lazy(() => PropertyDataSpatial$inboundSchema).optional(),
+  spatial: z.lazy(() => PropertyDataApiSpatial$inboundSchema).optional(),
   streetIds: z.array(z.number()).optional(),
   tags: PropertyTags$inboundSchema.optional(),
   tenancy: TenancyData$inboundSchema.optional(),
   tenure: TenureData$inboundSchema.optional(),
 });
 
-export function propertyDataFromJSON(
+export function propertyDataApiFromJSON(
   jsonString: string,
-): SafeParseResult<PropertyData, SDKValidationError> {
+): SafeParseResult<PropertyDataApi, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => PropertyData$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PropertyData' from JSON`,
+    (x) => PropertyDataApi$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyDataApi' from JSON`,
   );
 }

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

@@ -6,7 +6,10 @@ 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";
-import { PropertyData, PropertyData$inboundSchema } from "./propertydata.js";
+import {
+  PropertyDataApi,
+  PropertyDataApi$inboundSchema,
+} from "./propertydataapi.js";
 
 export type PropertyListResponse = {
   /**
@@ -20,7 +23,7 @@ export type PropertyListResponse = {
   /**
    * Array of property data objects
    */
-  result: Array<PropertyData>;
+  result: Array<PropertyDataApi>;
   /**
    * Number of properties returned in this response
    */
@@ -40,7 +43,7 @@ export const PropertyListResponse$inboundSchema: z.ZodType<
 > = z.object({
   hasMore: z.boolean().optional(),
   nextOffset: z.number().optional(),
-  result: z.array(PropertyData$inboundSchema),
+  result: z.array(PropertyDataApi$inboundSchema),
   size: z.number(),
   success: z.boolean(),
   totalSize: z.number(),

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

@@ -11,55 +11,55 @@ export type PropertyTags = {
   /**
    * Property has agricultural tie restriction
    */
-  agriculturalTie: boolean;
+  agriculturalTie?: boolean | undefined;
   /**
    * Is this property being sold at auction
    */
-  auction: boolean;
+  auction?: boolean | undefined;
   /**
    * Below Market Value property
    */
-  bmv: boolean;
+  bmv?: boolean | undefined;
   /**
    * Cash buyers only
    */
-  cashBuyers: boolean;
+  cashBuyers?: boolean | undefined;
   /**
    * Is this property chain free
    */
-  chainFree: boolean;
+  chainFree?: boolean | undefined;
   /**
    * House in Multiple Occupation
    */
-  hmo: boolean;
+  hmo?: boolean | undefined;
   /**
    * Property in negative equity
    */
-  negativeEquity: boolean;
+  negativeEquity?: boolean | undefined;
   /**
    * Is this a new build scheme property
    */
-  newBuildScheme: boolean;
+  newBuildScheme?: boolean | undefined;
   /**
    * Quick sale property
    */
-  quickSale: boolean;
+  quickSale?: boolean | undefined;
   /**
    * Is this a retirement property
    */
-  retirement: boolean;
+  retirement?: boolean | undefined;
   /**
    * Is this a shared ownership property
    */
-  sharedOwnership: boolean;
+  sharedOwnership?: boolean | undefined;
   /**
    * Property is slow to sell
    */
-  slowToSell: boolean;
+  slowToSell?: boolean | undefined;
   /**
    * Property is unmodernised
    */
-  unmodernised: boolean;
+  unmodernised?: boolean | undefined;
 };
 
 /** @internal */
@@ -68,19 +68,19 @@ export const PropertyTags$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  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(),
+  agriculturalTie: z.boolean().optional(),
+  auction: z.boolean().optional(),
+  bmv: z.boolean().optional(),
+  cashBuyers: z.boolean().optional(),
+  chainFree: z.boolean().optional(),
+  hmo: z.boolean().optional(),
+  negativeEquity: z.boolean().optional(),
+  newBuildScheme: z.boolean().optional(),
+  quickSale: z.boolean().optional(),
+  retirement: z.boolean().optional(),
+  sharedOwnership: z.boolean().optional(),
+  slowToSell: z.boolean().optional(),
+  unmodernised: z.boolean().optional(),
 });
 
 export function propertyTagsFromJSON(

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

@@ -8,13 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type RoomDetails = {
-  /**
-   * Number of bathrooms
-   */
   baths?: number | null | undefined;
-  /**
-   * Number of bedrooms
-   */
   beds?: number | null | undefined;
 };
 

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

@@ -11,15 +11,15 @@ export type SaleRecord = {
   /**
    * Sale price in pence
    */
-  amount: number;
+  amount?: number | undefined;
   /**
    * Sale completion date
    */
-  date: Date;
+  date?: Date | undefined;
   /**
    * Source identifier for this sale record
    */
-  sourceId: string;
+  sourceId?: string | undefined;
 };
 
 /** @internal */
@@ -28,9 +28,10 @@ export const SaleRecord$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  amount: z.number(),
-  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  sourceId: z.string(),
+  amount: z.number().optional(),
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  sourceId: z.string().optional(),
 });
 
 export function saleRecordFromJSON(

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

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 SearchHighlight = {
+  /**
+   * Field name that was highlighted
+   */
+  field: string;
+  /**
+   * Highlighted text fragments with match context
+   */
+  fragments: Array<string>;
+  /**
+   * Terms that matched in this field
+   */
+  matchedTerms?: Array<string> | undefined;
+};
+
+/** @internal */
+export const SearchHighlight$inboundSchema: z.ZodType<
+  SearchHighlight,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  field: z.string(),
+  fragments: z.array(z.string()),
+  matchedTerms: z.array(z.string()).optional(),
+});
+
+export function searchHighlightFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchHighlight, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchHighlight$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchHighlight' from JSON`,
+  );
+}