@vepler/sdk 2.46.0 → 2.57.3

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

@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 /**
  * Comparison operator
  */
-export const Comparator = {
+export const PropertyQueryConditionComparator = {
   Eq: "eq",
   Ne: "ne",
   Gt: "gt",
@@ -24,14 +24,16 @@ export const Comparator = {
 /**
  * Comparison operator
  */
-export type Comparator = ClosedEnum<typeof Comparator>;
+export type PropertyQueryConditionComparator = ClosedEnum<
+  typeof PropertyQueryConditionComparator
+>;
 
 export type PropertyQueryCondition4 = string | number | boolean;
 
 /**
  * Value to compare against
  */
-export type Value =
+export type PropertyQueryConditionValue =
   | string
   | number
   | boolean
@@ -41,7 +43,7 @@ export type PropertyQueryCondition = {
   /**
    * Comparison operator
    */
-  comparator: Comparator;
+  comparator: PropertyQueryConditionComparator;
   /**
    * Field to filter on. Common fields: propertyType, propertyCategory ('residential' or 'commercial'), roomDetails.beds, pricing.currentSale, pricing.currentRent, build.totalFloorArea, epc.rating
    */
@@ -53,8 +55,9 @@ export type PropertyQueryCondition = {
 };
 
 /** @internal */
-export const Comparator$outboundSchema: z.ZodNativeEnum<typeof Comparator> = z
-  .nativeEnum(Comparator);
+export const PropertyQueryConditionComparator$outboundSchema: z.ZodNativeEnum<
+  typeof PropertyQueryConditionComparator
+> = z.nativeEnum(PropertyQueryConditionComparator);
 
 /** @internal */
 export type PropertyQueryCondition4$Outbound = string | number | boolean;
@@ -75,17 +78,17 @@ export function propertyQueryCondition4ToJSON(
 }
 
 /** @internal */
-export type Value$Outbound =
+export type PropertyQueryConditionValue$Outbound =
   | string
   | number
   | boolean
   | Array<string | number | boolean>;
 
 /** @internal */
-export const Value$outboundSchema: z.ZodType<
-  Value$Outbound,
+export const PropertyQueryConditionValue$outboundSchema: z.ZodType<
+  PropertyQueryConditionValue$Outbound,
   z.ZodTypeDef,
-  Value
+  PropertyQueryConditionValue
 > = z.union([
   z.string(),
   z.number(),
@@ -93,8 +96,14 @@ export const Value$outboundSchema: z.ZodType<
   z.array(z.union([z.string(), z.number(), z.boolean()])),
 ]);
 
-export function valueToJSON(value: Value): string {
-  return JSON.stringify(Value$outboundSchema.parse(value));
+export function propertyQueryConditionValueToJSON(
+  propertyQueryConditionValue: PropertyQueryConditionValue,
+): string {
+  return JSON.stringify(
+    PropertyQueryConditionValue$outboundSchema.parse(
+      propertyQueryConditionValue,
+    ),
+  );
 }
 
 /** @internal */
@@ -110,7 +119,7 @@ export const PropertyQueryCondition$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PropertyQueryCondition
 > = z.object({
-  comparator: Comparator$outboundSchema,
+  comparator: PropertyQueryConditionComparator$outboundSchema,
   field: z.string(),
   value: z.union([
     z.string(),

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

@@ -13,14 +13,16 @@ import {
 /**
  * Logical operator
  */
-export const Operator = {
+export const PropertyQueryOperatorOperator = {
   And: "AND",
   Or: "OR",
 } as const;
 /**
  * Logical operator
  */
-export type Operator = ClosedEnum<typeof Operator>;
+export type PropertyQueryOperatorOperator = ClosedEnum<
+  typeof PropertyQueryOperatorOperator
+>;
 
 export type PropertyQueryOperator = {
   /**
@@ -30,12 +32,13 @@ export type PropertyQueryOperator = {
   /**
    * Logical operator
    */
-  operator: Operator;
+  operator: PropertyQueryOperatorOperator;
 };
 
 /** @internal */
-export const Operator$outboundSchema: z.ZodNativeEnum<typeof Operator> = z
-  .nativeEnum(Operator);
+export const PropertyQueryOperatorOperator$outboundSchema: z.ZodNativeEnum<
+  typeof PropertyQueryOperatorOperator
+> = z.nativeEnum(PropertyQueryOperatorOperator);
 
 /** @internal */
 export type PropertyQueryOperator$Outbound = {
@@ -50,7 +53,7 @@ export const PropertyQueryOperator$outboundSchema: z.ZodType<
   PropertyQueryOperator
 > = z.object({
   groups: z.array(PropertyQueryGroup$outboundSchema),
-  operator: Operator$outboundSchema,
+  operator: PropertyQueryOperatorOperator$outboundSchema,
 });
 
 export function propertyQueryOperatorToJSON(

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

@@ -18,7 +18,7 @@ import {
 /**
  * Comma-separated string or array of attributes to include in the response. Only the specified fields will be returned (plus locationId which is always included). Use this to reduce payload size by requesting only the data you need. Example: 'propertyId,pricing,address' or ['propertyId', 'pricing', 'address']
  */
-export type Attributes = string | Array<string>;
+export type PropertyQueryRequestAttributes = string | Array<string>;
 
 /**
  * Field to sort by (whitelisted fields only)
@@ -143,17 +143,23 @@ export type PropertyQueryRequest = {
 };
 
 /** @internal */
-export type Attributes$Outbound = string | Array<string>;
+export type PropertyQueryRequestAttributes$Outbound = string | Array<string>;
 
 /** @internal */
-export const Attributes$outboundSchema: z.ZodType<
-  Attributes$Outbound,
+export const PropertyQueryRequestAttributes$outboundSchema: z.ZodType<
+  PropertyQueryRequestAttributes$Outbound,
   z.ZodTypeDef,
-  Attributes
+  PropertyQueryRequestAttributes
 > = z.union([z.string(), z.array(z.string())]);
 
-export function attributesToJSON(attributes: Attributes): string {
-  return JSON.stringify(Attributes$outboundSchema.parse(attributes));
+export function propertyQueryRequestAttributesToJSON(
+  propertyQueryRequestAttributes: PropertyQueryRequestAttributes,
+): string {
+  return JSON.stringify(
+    PropertyQueryRequestAttributes$outboundSchema.parse(
+      propertyQueryRequestAttributes,
+    ),
+  );
 }
 
 /** @internal */

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

@@ -11,28 +11,28 @@ export type Employment = {
   /**
    * Dimension score 0-100
    */
-  score?: number | undefined;
+  score: number;
 };
 
 export type Housing = {
   /**
    * Dimension score 0-100
    */
-  score?: number | undefined;
+  score: number;
 };
 
 export type Income = {
   /**
    * Dimension score 0-100
    */
-  score?: number | undefined;
+  score: number;
 };
 
 export type LivingStandards = {
   /**
    * Dimension score 0-100
    */
-  score?: number | undefined;
+  score: number;
 };
 
 export type Dimensions = {
@@ -46,20 +46,20 @@ export type ProsperityData = {
   /**
    * National decile 1-10
    */
-  decile?: number | undefined;
+  decile: number;
   dimensions?: Dimensions | undefined;
   /**
    * National percentile 1-100
    */
-  percentile?: number | undefined;
+  percentile: number;
   /**
    * Overall prosperity score 0-100
    */
-  score?: number | undefined;
+  score: number;
   /**
    * Dataset version e.g. 2026.1
    */
-  version?: string | undefined;
+  version: string;
 };
 
 /** @internal */
@@ -68,7 +68,7 @@ export const Employment$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  score: z.number().optional(),
+  score: z.number(),
 });
 
 export function employmentFromJSON(
@@ -84,7 +84,7 @@ export function employmentFromJSON(
 /** @internal */
 export const Housing$inboundSchema: z.ZodType<Housing, z.ZodTypeDef, unknown> =
   z.object({
-    score: z.number().optional(),
+    score: z.number(),
   });
 
 export function housingFromJSON(
@@ -100,7 +100,7 @@ export function housingFromJSON(
 /** @internal */
 export const Income$inboundSchema: z.ZodType<Income, z.ZodTypeDef, unknown> = z
   .object({
-    score: z.number().optional(),
+    score: z.number(),
   });
 
 export function incomeFromJSON(
@@ -119,7 +119,7 @@ export const LivingStandards$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  score: z.number().optional(),
+  score: z.number(),
 });
 
 export function livingStandardsFromJSON(
@@ -160,11 +160,11 @@ export const ProsperityData$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  decile: z.number().int().optional(),
+  decile: z.number().int(),
   dimensions: z.lazy(() => Dimensions$inboundSchema).optional(),
-  percentile: z.number().int().optional(),
-  score: z.number().optional(),
-  version: z.string().optional(),
+  percentile: z.number().int(),
+  score: z.number(),
+  version: z.string(),
 });
 
 export function prosperityDataFromJSON(

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

@@ -8,10 +8,52 @@ import * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  CompanyAddress,
-  CompanyAddress$inboundSchema,
-} from "./companyaddress.js";
+
+/**
+ * The PSC's correspondence address as publicly disclosed. For individuals, this is the service address (not residential). For corporate entities, this is the registered or principal office address.
+ */
+export type PscAddress = {
+  /**
+   * First line of the street address (e.g. 'Heene Road').
+   */
+  addressLine1?: string | null | undefined;
+  /**
+   * Second line of the address, if applicable (e.g. a district or area within a town).
+   */
+  addressLine2?: string | null | undefined;
+  /**
+   * 'Care of' (c/o) name, used when mail should be directed via a third party.
+   */
+  careOf?: string | null | undefined;
+  /**
+   * Country name as recorded by Companies House (e.g. 'United Kingdom', 'England').
+   */
+  country?: string | null | undefined;
+  /**
+   * Pre-formatted single-line address string combining all available components.
+   */
+  formattedAddress?: string | null | undefined;
+  /**
+   * Town or city name.
+   */
+  locality?: string | null | undefined;
+  /**
+   * PO Box number, if the address uses a PO Box.
+   */
+  poBox?: string | null | undefined;
+  /**
+   * UK postcode or international postal code.
+   */
+  postalCode?: string | null | undefined;
+  /**
+   * Building name or number (e.g. 'MGM House', '10').
+   */
+  premises?: string | null | undefined;
+  /**
+   * County, region, or administrative area.
+   */
+  region?: string | null | undefined;
+};
 
 /**
  * The type of entity with significant control. Determines which fields are populated: 'individual-*' kinds have nationality and date of birth; 'corporate-entity-*' kinds have a corporateEntityId; 'super-secure-*' kinds have limited personal details (identity protected by court order).
@@ -39,7 +81,10 @@ export type Kind = OpenEnum<typeof Kind>;
  * The full PSC notification record.
  */
 export type Psc = {
-  address?: CompanyAddress | null | undefined;
+  /**
+   * The PSC's correspondence address as publicly disclosed. For individuals, this is the service address (not residential). For corporate entities, this is the registered or principal office address.
+   */
+  address?: PscAddress | null | undefined;
   /**
    * Date the PSC ceased to have significant control over the company. Null indicates the PSC still has active control. ISO 8601 format.
    */
@@ -114,6 +159,34 @@ export type Psc = {
   updatedAt: Date;
 };
 
+/** @internal */
+export const PscAddress$inboundSchema: z.ZodType<
+  PscAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  addressLine1: z.nullable(z.string()).optional(),
+  addressLine2: z.nullable(z.string()).optional(),
+  careOf: z.nullable(z.string()).optional(),
+  country: z.nullable(z.string()).optional(),
+  formattedAddress: z.nullable(z.string()).optional(),
+  locality: z.nullable(z.string()).optional(),
+  poBox: z.nullable(z.string()).optional(),
+  postalCode: z.nullable(z.string()).optional(),
+  premises: z.nullable(z.string()).optional(),
+  region: z.nullable(z.string()).optional(),
+});
+
+export function pscAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<PscAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PscAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PscAddress' from JSON`,
+  );
+}
+
 /** @internal */
 export const Kind$inboundSchema: z.ZodType<Kind, z.ZodTypeDef, unknown> =
   openEnums.inboundSchema(Kind);
@@ -121,7 +194,7 @@ export const Kind$inboundSchema: z.ZodType<Kind, z.ZodTypeDef, unknown> =
 /** @internal */
 export const Psc$inboundSchema: z.ZodType<Psc, z.ZodTypeDef, unknown> = z
   .object({
-    address: z.nullable(CompanyAddress$inboundSchema).optional(),
+    address: z.nullable(z.lazy(() => PscAddress$inboundSchema)).optional(),
     ceasedOn: z.nullable(
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ).optional(),

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

@@ -14,7 +14,7 @@ import {
 } from "./postcodeaddress.js";
 
 /**
- * WGS84 coordinate pair
+ * Query coordinates
  */
 export type ReverseGeocodeResponseCoordinates = {
   /**
@@ -36,7 +36,7 @@ export type ReverseGeocodeResponseObject = ClosedEnum<
 
 export type ReverseGeocodeResponse = {
   /**
-   * WGS84 coordinate pair
+   * Query coordinates
    */
   coordinates: ReverseGeocodeResponseCoordinates;
   /**

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

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

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

@@ -12,12 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { SearchResult, SearchResult$inboundSchema } from "./searchresult.js";
 
 /**
- * Pattern detected in the search query:
- *
- * @remarks
- * - postcode: UK postcode (e.g., SW1A 1AA or SW1A for outward code)
- * - address: Full or partial address with house number (e.g., 10 Downing Street)
- * - general: No specific pattern detected (general location search)
+ * Detected query pattern
  */
 export const QueryPattern = {
   Postcode: "postcode",
@@ -25,12 +20,7 @@ export const QueryPattern = {
   General: "general",
 } as const;
 /**
- * Pattern detected in the search query:
- *
- * @remarks
- * - postcode: UK postcode (e.g., SW1A 1AA or SW1A for outward code)
- * - address: Full or partial address with house number (e.g., 10 Downing Street)
- * - general: No specific pattern detected (general location search)
+ * Detected query pattern
  */
 export type QueryPattern = OpenEnum<typeof QueryPattern>;
 
@@ -63,12 +53,7 @@ export type Metadata = {
    */
   processingTime?: string | undefined;
   /**
-   * Pattern detected in the search query:
-   *
-   * @remarks
-   * - postcode: UK postcode (e.g., SW1A 1AA or SW1A for outward code)
-   * - address: Full or partial address with house number (e.g., 10 Downing Street)
-   * - general: No specific pattern detected (general location search)
+   * Detected query pattern
    */
   queryPattern?: QueryPattern | undefined;
   /**
@@ -88,9 +73,6 @@ export const SearchResponseObject = {
  */
 export type SearchResponseObject = ClosedEnum<typeof SearchResponseObject>;
 
-/**
- * Paginated list response
- */
 export type SearchResponse = {
   /**
    * Array of items

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

@@ -19,7 +19,7 @@ import {
 } from "./searchhighlight.js";
 
 /**
- * WGS84 coordinate pair
+ * Geographic coordinates
  */
 export type SearchResultCoordinates = {
   /**
@@ -33,22 +33,14 @@ export type SearchResultCoordinates = {
 };
 
 /**
- * Data source to search:
- *
- * @remarks
- * - address: UK property addresses with UPRN, full address details, and geocoding
- * - location: UK postcodes, places, towns, and geographic locations
+ * Data source for this result
  */
 export const Source = {
   Address: "address",
   Location: "location",
 } as const;
 /**
- * Data source to search:
- *
- * @remarks
- * - address: UK property addresses with UPRN, full address details, and geocoding
- * - location: UK postcodes, places, towns, and geographic locations
+ * Data source for this result
  */
 export type Source = OpenEnum<typeof Source>;
 
@@ -74,7 +66,7 @@ export type SearchResult = {
    */
   id: string;
   /**
-   * WGS84 coordinate pair
+   * Geographic coordinates
    */
   location?: SearchResultCoordinates | undefined;
   /**
@@ -114,11 +106,7 @@ export type SearchResult = {
    */
   secondaryText?: string | undefined;
   /**
-   * Data source to search:
-   *
-   * @remarks
-   * - address: UK property addresses with UPRN, full address details, and geocoding
-   * - location: UK postcodes, places, towns, and geographic locations
+   * Data source for this result
    */
   source: Source;
   /**