@vepler/sdk 2.164.0 → 3.0.0

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

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+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 {
+  TitleProprietor,
+  TitleProprietor$inboundSchema,
+} from "./titleproprietor.js";
+
+export const MortgageChargeStatus = {
+  Active: "active",
+  Discharged: "discharged",
+} as const;
+export type MortgageChargeStatus = OpenEnum<typeof MortgageChargeStatus>;
+
+export type MortgageCharge = {
+  chargeDate: string;
+  chargeHolder: TitleProprietor;
+  /**
+   * Date the charge was discharged. Null when status is 'active'.
+   */
+  dischargedDate: string | null;
+  /**
+   * AI-authored plain-language description of what this charge means for the owner.
+   */
+  effectOfCharge: string;
+  registrationDate: string;
+  /**
+   * Register entry reference for audit traceability
+   */
+  sourceEntryRef: string;
+  status: MortgageChargeStatus;
+  /**
+   * Title number this charge affects. May be this title or a related title.
+   */
+  titleAffected: string;
+};
+
+/** @internal */
+export const MortgageChargeStatus$inboundSchema: z.ZodType<
+  MortgageChargeStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(MortgageChargeStatus);
+
+/** @internal */
+export const MortgageCharge$inboundSchema: z.ZodType<
+  MortgageCharge,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  chargeDate: z.string(),
+  chargeHolder: TitleProprietor$inboundSchema,
+  dischargedDate: z.nullable(z.string()),
+  effectOfCharge: z.string(),
+  registrationDate: z.string(),
+  sourceEntryRef: z.string(),
+  status: MortgageChargeStatus$inboundSchema,
+  titleAffected: z.string(),
+});
+
+export function mortgageChargeFromJSON(
+  jsonString: string,
+): SafeParseResult<MortgageCharge, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MortgageCharge$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MortgageCharge' from JSON`,
+  );
+}

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

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type NestedAggregationResult = {
+  /**
+   * Documents matched within the nested context (present on the outer wrapper).
+   */
+  docCount?: number | undefined;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const NestedAggregationResult$inboundSchema: z.ZodType<
+  NestedAggregationResult,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    doc_count: z.number().optional(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+).transform((v) => {
+  return remap$(v, {
+    "doc_count": "docCount",
+  });
+});
+
+export function nestedAggregationResultFromJSON(
+  jsonString: string,
+): SafeParseResult<NestedAggregationResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NestedAggregationResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NestedAggregationResult' from JSON`,
+  );
+}

package/src/sdk/models/shared/{extractionothercharge.ts → othercharge.ts}

@@ -7,17 +7,26 @@ import { safeParse } from "../../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type ExtractionOtherCharge = {
+export type OtherCharge = {
+  /**
+   * Human-readable charge type from the register
+   */
   chargeType: string;
   date: string | null;
+  /**
+   * AI-authored plain-language description
+   */
   effectOfCharge: string;
+  /**
+   * Parties named in the original charge entry
+   */
   originalParties: Array<string>;
   sourceEntryRef: string;
 };
 
 /** @internal */
-export const ExtractionOtherCharge$inboundSchema: z.ZodType<
-  ExtractionOtherCharge,
+export const OtherCharge$inboundSchema: z.ZodType<
+  OtherCharge,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -28,12 +37,12 @@ export const ExtractionOtherCharge$inboundSchema: z.ZodType<
   sourceEntryRef: z.string(),
 });
 
-export function extractionOtherChargeFromJSON(
+export function otherChargeFromJSON(
   jsonString: string,
-): SafeParseResult<ExtractionOtherCharge, SDKValidationError> {
+): SafeParseResult<OtherCharge, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => ExtractionOtherCharge$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ExtractionOtherCharge' from JSON`,
+    (x) => OtherCharge$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OtherCharge' from JSON`,
   );
 }

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

@@ -4,18 +4,42 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
+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";
 
+/**
+ * Sovereign ISO 3166-1 alpha-2 country code (GB | IE). Distinct from the sub-national `country` nation slug above.
+ */
+export const PropertyAddressCountryCode = {
+  Gb: "GB",
+  Ie: "IE",
+} as const;
+/**
+ * Sovereign ISO 3166-1 alpha-2 country code (GB | IE). Distinct from the sub-national `country` nation slug above.
+ */
+export type PropertyAddressCountryCode = OpenEnum<
+  typeof PropertyAddressCountryCode
+>;
+
 export type PropertyAddress = {
   /**
-   * ISO country code
+   * Nation slug (england | scotland | wales | northern-ireland), or null when unknown
    */
-  country: string;
+  country: string | null;
+  /**
+   * Sovereign ISO 3166-1 alpha-2 country code (GB | IE). Distinct from the sub-national `country` nation slug above.
+   */
+  countryCode?: PropertyAddressCountryCode | undefined;
   /**
    * Formatted display address
    */
   displayAddress: string;
+  /**
+   * Irish postal code (Eircode). Null for GB addresses, where `postcode` (UK format) is used instead.
+   */
+  eircode?: string | null | undefined;
   /**
    * Postcode incode
    */
@@ -34,14 +58,23 @@ export type PropertyAddress = {
   postcodeNoSpace?: string | undefined;
 };
 
+/** @internal */
+export const PropertyAddressCountryCode$inboundSchema: z.ZodType<
+  PropertyAddressCountryCode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyAddressCountryCode);
+
 /** @internal */
 export const PropertyAddress$inboundSchema: z.ZodType<
   PropertyAddress,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  country: z.string().default("GB"),
+  country: z.nullable(z.string()),
+  countryCode: PropertyAddressCountryCode$inboundSchema.optional(),
   displayAddress: z.string(),
+  eircode: z.nullable(z.string()).optional(),
   incode: z.string().optional(),
   outcode: z.string().optional(),
   postcode: z.string().optional(),

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

@@ -9,6 +9,10 @@ export type PropertyBySlugsRequest = {
    * List of attributes to include in response. Only specified fields will be returned (plus locationId which is always included)
    */
   attributes?: Array<string> | undefined;
+  /**
+   * Optional sovereign-country hint (e.g. 'GB', 'IE'). Lenient free-string: normalised internally, never a hard filter. Only GB data exists today, so this is accepted as an ignored/GB-scoped hint; omitting it behaves exactly as today.
+   */
+  countryCode?: string | undefined;
   /**
    * Maximum number of results
    */
@@ -26,6 +30,7 @@ export type PropertyBySlugsRequest = {
 /** @internal */
 export type PropertyBySlugsRequest$Outbound = {
   attributes?: Array<string> | undefined;
+  countryCode?: string | undefined;
   limit: number;
   slugs: Array<string>;
   track: boolean;
@@ -38,6 +43,7 @@ export const PropertyBySlugsRequest$outboundSchema: z.ZodType<
   PropertyBySlugsRequest
 > = z.object({
   attributes: z.array(z.string()).optional(),
+  countryCode: z.string().optional(),
   limit: z.number().default(25),
   slugs: z.array(z.string()),
   track: z.boolean().default(false),

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

@@ -318,6 +318,20 @@ export const CoordinateConfidence = {
  */
 export type CoordinateConfidence = OpenEnum<typeof CoordinateConfidence>;
 
+/**
+ * Sovereign ISO 3166-1 alpha-2 country code (GB | IE). Distinct from the sub-national `address.country` nation slug.
+ */
+export const PropertyDataApiCountryCode = {
+  Gb: "GB",
+  Ie: "IE",
+} as const;
+/**
+ * Sovereign ISO 3166-1 alpha-2 country code (GB | IE). Distinct from the sub-national `address.country` nation slug.
+ */
+export type PropertyDataApiCountryCode = OpenEnum<
+  typeof PropertyDataApiCountryCode
+>;
+
 /**
  * Flood risk information
  */
@@ -332,6 +346,18 @@ export type FloodRisk = {
   suitability?: string | null | undefined;
 };
 
+/**
+ * Identity scheme that `locationId` holds: uprn for Great Britain (OS NGD), eircode for Ireland (future).
+ */
+export const IdScheme = {
+  Uprn: "uprn",
+  Eircode: "eircode",
+} as const;
+/**
+ * Identity scheme that `locationId` holds: uprn for Great Britain (OS NGD), eircode for Ireland (future).
+ */
+export type IdScheme = OpenEnum<typeof IdScheme>;
+
 /**
  * Physical state of the property (derived from AddressBase Premium BLPU State)
  */
@@ -428,11 +454,19 @@ export type PropertyDataApi = {
    */
   coordinateConfidence?: CoordinateConfidence | null | undefined;
   councilTax?: CouncilTaxData | undefined;
+  /**
+   * Sovereign ISO 3166-1 alpha-2 country code (GB | IE). Distinct from the sub-national `address.country` nation slug.
+   */
+  countryCode?: PropertyDataApiCountryCode | undefined;
   epc?: EPCData | undefined;
   /**
    * Flood risk information
    */
   floodRisk?: FloodRisk | undefined;
+  /**
+   * Identity scheme that `locationId` holds: uprn for Great Britain (OS NGD), eircode for Ireland (future).
+   */
+  idScheme?: IdScheme | undefined;
   /**
    * Lease records for leasehold properties
    */
@@ -505,6 +539,10 @@ export type PropertyDataApi = {
    * Number of sub-units in multi-occupancy buildings (null for single units)
    */
   unitCount?: number | null | undefined;
+  /**
+   * Explicit Unique Property Reference Number (UPRN). Equals `locationId` for GB; null for IE.
+   */
+  uprn?: string | null | undefined;
 };
 
 /** @internal */
@@ -734,6 +772,13 @@ export const CoordinateConfidence$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(CoordinateConfidence);
 
+/** @internal */
+export const PropertyDataApiCountryCode$inboundSchema: z.ZodType<
+  PropertyDataApiCountryCode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PropertyDataApiCountryCode);
+
 /** @internal */
 export const FloodRisk$inboundSchema: z.ZodType<
   FloodRisk,
@@ -754,6 +799,13 @@ export function floodRiskFromJSON(
   );
 }
 
+/** @internal */
+export const IdScheme$inboundSchema: z.ZodType<
+  IdScheme,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(IdScheme);
+
 /** @internal */
 export const OccupancyStatus$inboundSchema: z.ZodType<
   OccupancyStatus,
@@ -874,8 +926,10 @@ export const PropertyDataApi$inboundSchema: z.ZodType<
   coordinateConfidence: z.nullable(CoordinateConfidence$inboundSchema)
     .optional(),
   councilTax: CouncilTaxData$inboundSchema.optional(),
+  countryCode: PropertyDataApiCountryCode$inboundSchema.optional(),
   epc: EPCData$inboundSchema.optional(),
   floodRisk: z.lazy(() => FloodRisk$inboundSchema).optional(),
+  idScheme: IdScheme$inboundSchema.optional(),
   leases: z.array(Lease$inboundSchema).optional(),
   listings: z.array(Listing$inboundSchema).optional(),
   locationId: z.string().optional(),
@@ -900,6 +954,7 @@ export const PropertyDataApi$inboundSchema: z.ZodType<
   tenancy: TenancyData$inboundSchema.optional(),
   tenure: TenureData$inboundSchema.optional(),
   unitCount: z.nullable(z.number().int()).optional(),
+  uprn: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "_provenance": "provenance",

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

@@ -122,6 +122,10 @@ export type PropertyQueryRequest = {
    * 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']
    */
   attributes?: string | Array<string> | undefined;
+  /**
+   * Optional sovereign-country hint (e.g. 'GB', 'IE'). Lenient free-string: normalised internally, never a hard filter. Only GB data exists today, so this is accepted as an ignored/GB-scoped hint; omitting it behaves exactly as today.
+   */
+  countryCode?: string | undefined;
   /**
    * Number of results to return per page
    */
@@ -216,6 +220,7 @@ export function propertyQueryRequestSortToJSON(
 export type PropertyQueryRequest$Outbound = {
   area: Array<PropertyAreaFilter$Outbound>;
   attributes?: string | Array<string> | undefined;
+  countryCode?: string | undefined;
   limit: number;
   offset: number;
   query: Array<PropertyQueryOperator$Outbound>;
@@ -231,6 +236,7 @@ export const PropertyQueryRequest$outboundSchema: z.ZodType<
 > = z.object({
   area: z.array(PropertyAreaFilter$outboundSchema),
   attributes: z.union([z.string(), z.array(z.string())]).optional(),
+  countryCode: z.string().optional(),
   limit: z.number().default(25),
   offset: z.number().default(0),
   query: z.array(PropertyQueryOperator$outboundSchema),

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

@@ -0,0 +1,40 @@
+/*
+ * 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";
+import {
+  MortgageCharge,
+  MortgageCharge$inboundSchema,
+} from "./mortgagecharge.js";
+import { OtherCharge, OtherCharge$inboundSchema } from "./othercharge.js";
+
+export type RegisteredCharges = {
+  active: Array<MortgageCharge>;
+  discharged: Array<MortgageCharge>;
+  other: Array<OtherCharge>;
+};
+
+/** @internal */
+export const RegisteredCharges$inboundSchema: z.ZodType<
+  RegisteredCharges,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  active: z.array(MortgageCharge$inboundSchema),
+  discharged: z.array(MortgageCharge$inboundSchema),
+  other: z.array(OtherCharge$inboundSchema),
+});
+
+export function registeredChargesFromJSON(
+  jsonString: string,
+): SafeParseResult<RegisteredCharges, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RegisteredCharges$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RegisteredCharges' from JSON`,
+  );
+}

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

@@ -4,9 +4,37 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
+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";
 
+/**
+ * Nation of the sale record
+ */
+export const SaleRecordNation = {
+  Eng: "ENG",
+  Wal: "WAL",
+  Sco: "SCO",
+  Nir: "NIR",
+} as const;
+/**
+ * Nation of the sale record
+ */
+export type SaleRecordNation = OpenEnum<typeof SaleRecordNation>;
+
+/**
+ * Price Paid category: A = standard market sale; B = additional transfer (repossession, portfolio, right-to-buy, CPO)
+ */
+export const PpdCategory = {
+  A: "A",
+  B: "B",
+} as const;
+/**
+ * Price Paid category: A = standard market sale; B = additional transfer (repossession, portfolio, right-to-buy, CPO)
+ */
+export type PpdCategory = OpenEnum<typeof PpdCategory>;
+
 export type SaleRecord = {
   /**
    * Sale price in GBP (whole pounds)
@@ -16,12 +44,42 @@ export type SaleRecord = {
    * Sale completion date
    */
   date: Date;
+  /**
+   * Nation of the sale record
+   */
+  nation?: SaleRecordNation | undefined;
+  /**
+   * New-build sale flag from the price register
+   */
+  newBuild?: boolean | undefined;
+  /**
+   * Price Paid category: A = standard market sale; B = additional transfer (repossession, portfolio, right-to-buy, CPO)
+   */
+  ppdCategory?: PpdCategory | undefined;
   /**
    * Source identifier for this sale record
    */
   sourceId: string;
+  /**
+   * Tenure recorded on the sale
+   */
+  tenure?: string | undefined;
 };
 
+/** @internal */
+export const SaleRecordNation$inboundSchema: z.ZodType<
+  SaleRecordNation,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SaleRecordNation);
+
+/** @internal */
+export const PpdCategory$inboundSchema: z.ZodType<
+  PpdCategory,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PpdCategory);
+
 /** @internal */
 export const SaleRecord$inboundSchema: z.ZodType<
   SaleRecord,
@@ -30,7 +88,11 @@ export const SaleRecord$inboundSchema: z.ZodType<
 > = z.object({
   amount: z.number(),
   date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  nation: SaleRecordNation$inboundSchema.optional(),
+  newBuild: z.boolean().optional(),
+  ppdCategory: PpdCategory$inboundSchema.optional(),
   sourceId: z.string(),
+  tenure: z.string().optional(),
 });
 
 export function saleRecordFromJSON(

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

@@ -90,6 +90,14 @@ export type SearchResponse = {
    * Object type identifier
    */
   object: SearchResponseObject;
+  /**
+   * Server-issued session id for the current candidate set, or null when no set was formed. Pass it back as the `search_id` query parameter on subsequent keystrokes to narrow within the same set without opening a new data fetch.
+   */
+  searchId?: string | null | undefined;
+  /**
+   * True when the results in this response are the COMPLETE match set for the query, so a client can narrow further keystrokes locally without another request. False when the response is a partial page or the match set was too large to fetch.
+   */
+  setComplete?: boolean | undefined;
   /**
    * Total number of items available
    */
@@ -150,11 +158,15 @@ export const SearchResponse$inboundSchema: z.ZodType<
   has_more: z.boolean(),
   metadata: z.lazy(() => Metadata$inboundSchema).optional(),
   object: SearchResponseObject$inboundSchema,
+  search_id: z.nullable(z.string()).optional(),
+  set_complete: z.boolean().optional(),
   total_count: z.number().optional(),
   url: z.string(),
 }).transform((v) => {
   return remap$(v, {
     "has_more": "hasMore",
+    "search_id": "searchId",
+    "set_complete": "setComplete",
     "total_count": "totalCount",
   });
 });