@vepler/sdk 2.167.0 → 3.3.0

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

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * How the returned point was derived (e.g. 'rooftop')
+ */
+export const GeocodePrecision = {
+  Rooftop: "rooftop",
+  StreetCentre: "street_centre",
+  Approximate: "approximate",
+} as const;
+/**
+ * How the returned point was derived (e.g. 'rooftop')
+ */
+export type GeocodePrecision = OpenEnum<typeof GeocodePrecision>;
+
+/** @internal */
+export const GeocodePrecision$inboundSchema: z.ZodType<
+  GeocodePrecision,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GeocodePrecision);

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

@@ -54,7 +54,7 @@ export type HeritageAssessmentsNearest = {
   /**
    * Distance to the feature in metres
    */
-  distanceM: number;
+  distanceM?: number | undefined;
   /**
    * Listed-building / registered-park grade — e.g. grade_i | grade_ii_star | category_a (nation-local; no cross-nation equivalence)
    */
@@ -100,7 +100,7 @@ export type HeritageAssessments2 = {
   /**
    * False — the point is not inside any zone of this kind
    */
-  inside: false;
+  inside?: false | undefined;
   /**
    * Optional — the nearest zone of this kind, with distance
    */
@@ -114,8 +114,8 @@ export type HeritageAssessments1 = {
   /**
    * True — the point is inside this zone
    */
-  inside: true;
-  zone: HeritageZone;
+  inside?: true | undefined;
+  zone?: HeritageZone | undefined;
 };
 
 /**
@@ -129,11 +129,13 @@ export type HeritageAssessments = {
   /**
    * Heritage designations keyed by designation_type; only matched (inside / nearby) types are present.
    */
-  designations: { [k: string]: HeritageAssessments1 | HeritageAssessments2 };
+  designations?:
+    | { [k: string]: HeritageAssessments1 | HeritageAssessments2 }
+    | undefined;
   /**
    * Universal provenance block — every product envelope carries this
    */
-  provenance: Provenance;
+  provenance?: Provenance | undefined;
 };
 
 /** @internal */
@@ -154,7 +156,7 @@ export const HeritageAssessmentsNearest$inboundSchema: z.ZodType<
   bearingDeg: z.number().optional(),
   datePrecision: HeritageAssessmentsDatePrecision$inboundSchema.optional(),
   designatedDate: z.nullable(z.string()).optional(),
-  distanceM: z.number(),
+  distanceM: z.number().optional(),
   listedGrade: z.string().optional(),
   monumentClass: z.string().optional(),
   monumentClasses: z.array(z.string()).optional(),
@@ -182,7 +184,7 @@ export const HeritageAssessments2$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  inside: z.literal(false),
+  inside: z.literal(false).optional(),
   nearest: z.lazy(() => HeritageAssessmentsNearest$inboundSchema).optional(),
 });
 
@@ -202,8 +204,8 @@ export const HeritageAssessments1$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  inside: z.literal(true),
-  zone: HeritageZone$inboundSchema,
+  inside: z.literal(true).optional(),
+  zone: HeritageZone$inboundSchema.optional(),
 });
 
 export function heritageAssessments1FromJSON(
@@ -247,8 +249,8 @@ export const HeritageAssessments$inboundSchema: z.ZodType<
       z.lazy(() => HeritageAssessments1$inboundSchema),
       z.lazy(() => HeritageAssessments2$inboundSchema),
     ]),
-  ),
-  provenance: Provenance$inboundSchema,
+  ).optional(),
+  provenance: Provenance$inboundSchema.optional(),
 });
 
 export function heritageAssessmentsFromJSON(

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

@@ -172,13 +172,6 @@ export * from "./epcsort.js";
 export * from "./exceedancelevel.js";
 export * from "./extendedstatsaggregationresult.js";
 export * from "./extractioncitation.js";
-export * from "./extractiondocumentsummary.js";
-export * from "./extractionmortgagecharge.js";
-export * from "./extractionnotice.js";
-export * from "./extractionothercharge.js";
-export * from "./extractionpayload.js";
-export * from "./extractionproprietor.js";
-export * from "./extractionrestriction.js";
 export * from "./floodclimate2080.js";
 export * from "./flooddataavailability.js";
 export * from "./flooddefence.js";
@@ -199,6 +192,7 @@ export * from "./floodzone.js";
 export * from "./framework.js";
 export * from "./frameworkdetailresponse.js";
 export * from "./frameworklistresponse.js";
+export * from "./geocodeprecision.js";
 export * from "./geographiccontext.js";
 export * from "./geographycategorymetric.js";
 export * from "./geographymetricslistresponse.js";
@@ -244,6 +238,7 @@ export * from "./metricscomparerequest.js";
 export * from "./mitigationmeasure.js";
 export * from "./monthlycategorystats.js";
 export * from "./monthlycategorystatslistresponse.js";
+export * from "./mortgagecharge.js";
 export * from "./nearestpostcodesresponse.js";
 export * from "./nestedaggregation.js";
 export * from "./nestedaggregationresult.js";
@@ -252,6 +247,7 @@ export * from "./officerlistresponse.js";
 export * from "./officerresponse.js";
 export * from "./officersummary.js";
 export * from "./officialindex.js";
+export * from "./othercharge.js";
 export * from "./outcodelookupresponse.js";
 export * from "./percentilesaggregationresult.js";
 export * from "./person.js";
@@ -333,6 +329,7 @@ export * from "./pscresponse.js";
 export * from "./pscsummary.js";
 export * from "./rangedefinition.js";
 export * from "./refurbishmentdata.js";
+export * from "./registeredcharges.js";
 export * from "./regulator.js";
 export * from "./regulatorydomain.js";
 export * from "./regulatoryzone.js";
@@ -358,6 +355,7 @@ export * from "./schoolvideo.js";
 export * from "./searchhighlight.js";
 export * from "./searchresponse.js";
 export * from "./searchresult.js";
+export * from "./searchretrieveresponse.js";
 export * from "./security.js";
 export * from "./siccode.js";
 export * from "./singlevalueaggregationresult.js";
@@ -391,6 +389,7 @@ export * from "./socialmedialinks.js";
 export * from "./statsaggregationresult.js";
 export * from "./streetdescriptor.js";
 export * from "./streetdetails.js";
+export * from "./streetmatch.js";
 export * from "./streetquerybycoordinates.js";
 export * from "./streetquerybyname.js";
 export * from "./streetquerybypostcode.js";
@@ -404,9 +403,17 @@ export * from "./tenuredata.js";
 export * from "./termsaggregationresult.js";
 export * from "./termsbucket.js";
 export * from "./tierskipreason.js";
+export * from "./titlecovenant.js";
 export * from "./titledeeddocumentlistresponse.js";
 export * from "./titledeedpurchaseresponse.js";
+export * from "./titledocumentsummary.js";
+export * from "./titleextractionpayload.js";
 export * from "./titleextractionpollresponse.js";
+export * from "./titlenotice.js";
+export * from "./titleproprietor.js";
+export * from "./titlerestriction.js";
+export * from "./titleschedulenoticeoflease.js";
+export * from "./titlesummarycounts.js";
 export * from "./transaction.js";
 export * from "./transactionaddress.js";
 export * from "./transactionareafilter.js";

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

@@ -85,11 +85,11 @@ export type Source = {
   /**
    * Provider-specific listing key.
    */
-  key: string;
+  key?: string | undefined;
   /**
    * Data provider identifier for this listing.
    */
-  provider: string;
+  provider?: string | undefined;
 };
 
 /**
@@ -261,8 +261,8 @@ export function sellerFromJSON(
 /** @internal */
 export const Source$inboundSchema: z.ZodType<Source, z.ZodTypeDef, unknown> = z
   .object({
-    key: z.string(),
-    provider: z.string(),
+    key: z.string().optional(),
+    provider: z.string().optional(),
   });
 
 export function sourceFromJSON(

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

@@ -64,8 +64,8 @@ export type StatusTimeline = {
   /**
    * Period start date
    */
-  start: Date;
-  status: MarketStatusSchemasStatus;
+  start?: Date | undefined;
+  status?: MarketStatusSchemasStatus | undefined;
 };
 
 export const MarketStatusType = {
@@ -76,10 +76,10 @@ export type MarketStatusType = OpenEnum<typeof MarketStatusType>;
 
 export type Timeline = {
   end?: Date | null | undefined;
-  start: Date;
+  start?: Date | undefined;
   status?: MarketStatusStatus | undefined;
   statusTimeline?: Array<StatusTimeline> | undefined;
-  type: MarketStatusType;
+  type?: MarketStatusType | undefined;
 };
 
 export type MarketStatus = {
@@ -94,11 +94,11 @@ export type MarketStatus = {
   /**
    * Rental status
    */
-  forRent: ForRent;
+  forRent?: ForRent | undefined;
   /**
    * Sale status
    */
-  forSale: ForSale;
+  forSale?: ForSale | undefined;
   /**
    * Whether a live rental listing has had a price reduction
    */
@@ -172,8 +172,9 @@ export const StatusTimeline$inboundSchema: z.ZodType<
   end: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),
-  start: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  status: MarketStatusSchemasStatus$inboundSchema,
+  start: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  status: MarketStatusSchemasStatus$inboundSchema.optional(),
 });
 
 export function statusTimelineFromJSON(
@@ -202,11 +203,12 @@ export const Timeline$inboundSchema: z.ZodType<
   end: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ).optional(),
-  start: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  start: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
   status: MarketStatusStatus$inboundSchema.optional(),
   statusTimeline: z.array(z.lazy(() => StatusTimeline$inboundSchema))
     .optional(),
-  type: MarketStatusType$inboundSchema,
+  type: MarketStatusType$inboundSchema.optional(),
 });
 
 export function timelineFromJSON(
@@ -227,8 +229,8 @@ export const MarketStatus$inboundSchema: z.ZodType<
 > = z.object({
   backOTM: z.nullable(z.boolean()).optional(),
   backOTMRent: z.nullable(z.boolean()).optional(),
-  forRent: ForRent$inboundSchema,
-  forSale: ForSale$inboundSchema,
+  forRent: ForRent$inboundSchema.optional(),
+  forSale: ForSale$inboundSchema.optional(),
   hasPriceReductionRent: z.nullable(z.boolean()).optional(),
   hasPriceReductionSale: z.nullable(z.boolean()).optional(),
   lastOTM: z.nullable(

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/{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 | undefined;
+  /**
+   * 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;
+  displayAddress?: string | undefined;
+  /**
+   * 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"),
-  displayAddress: z.string(),
+  country: z.nullable(z.string()).optional(),
+  countryCode: PropertyAddressCountryCode$inboundSchema.optional(),
+  displayAddress: z.string().optional(),
+  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),