@vepler/sdk 2.39.0 → 2.45.0

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

@@ -0,0 +1,59 @@
+/*
+ * 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 SiteProprietor = {
+  /**
+   * Primary address of the proprietor
+   */
+  address: string | null;
+  /**
+   * Company registration number
+   */
+  companyNumber: string | null;
+  /**
+   * Country of incorporation for overseas companies
+   */
+  countryIncorporated: string | null;
+  /**
+   * Date the proprietor was added to the title
+   */
+  dateAdded: string | null;
+  /**
+   * Entity type classification
+   */
+  entityType: string;
+  /**
+   * Proprietor name as recorded
+   */
+  name: string;
+};
+
+/** @internal */
+export const SiteProprietor$inboundSchema: z.ZodType<
+  SiteProprietor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address: z.nullable(z.string()),
+  companyNumber: z.nullable(z.string()),
+  countryIncorporated: z.nullable(z.string()),
+  dateAdded: z.nullable(z.string()),
+  entityType: z.string(),
+  name: z.string(),
+});
+
+export function siteProprietorFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteProprietor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteProprietor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteProprietor' from JSON`,
+  );
+}

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

@@ -0,0 +1,155 @@
+/*
+ * 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 { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * HMLR document type
+ */
+export const DocumentType = {
+  RegisterExtract: "register-extract",
+  OfficialTitle: "official-title",
+  TitlePlan: "title-plan",
+} as const;
+/**
+ * HMLR document type
+ */
+export type DocumentType = OpenEnum<typeof DocumentType>;
+
+/**
+ * Document processing status: pending (being processed), uploaded (ready to download), or failed
+ */
+export const TitleDeedDocumentListResponseStatus = {
+  Pending: "pending",
+  Uploaded: "uploaded",
+  Failed: "failed",
+} as const;
+/**
+ * Document processing status: pending (being processed), uploaded (ready to download), or failed
+ */
+export type TitleDeedDocumentListResponseStatus = OpenEnum<
+  typeof TitleDeedDocumentListResponseStatus
+>;
+
+export type Documents = {
+  /**
+   * MIME type of the document (e.g. application/pdf)
+   */
+  contentType: string;
+  /**
+   * HMLR document type
+   */
+  documentType: DocumentType;
+  /**
+   * Relative URL for downloading the document (null unless status is uploaded)
+   */
+  downloadUrl: string | null;
+  /**
+   * File size in bytes (null while pending or failed)
+   */
+  sizeBytes: number | null;
+  /**
+   * Document processing status: pending (being processed), uploaded (ready to download), or failed
+   */
+  status: TitleDeedDocumentListResponseStatus;
+  /**
+   * ISO 8601 timestamp when the document became available (null until uploaded)
+   */
+  uploadedAt: string | null;
+};
+
+export const TitleDeedDocumentListResponseObject = {
+  TitleDeedDocumentList: "title_deed_document_list",
+} as const;
+export type TitleDeedDocumentListResponseObject = ClosedEnum<
+  typeof TitleDeedDocumentListResponseObject
+>;
+
+export type TitleDeedDocumentListResponse = {
+  documents: Array<Documents>;
+  object: TitleDeedDocumentListResponseObject;
+  titleNumber: string;
+};
+
+/** @internal */
+export const DocumentType$inboundSchema: z.ZodType<
+  DocumentType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(DocumentType);
+
+/** @internal */
+export const TitleDeedDocumentListResponseStatus$inboundSchema: z.ZodType<
+  TitleDeedDocumentListResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TitleDeedDocumentListResponseStatus);
+
+/** @internal */
+export const Documents$inboundSchema: z.ZodType<
+  Documents,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  content_type: z.string(),
+  document_type: DocumentType$inboundSchema,
+  download_url: z.nullable(z.string()),
+  size_bytes: z.nullable(z.number()),
+  status: TitleDeedDocumentListResponseStatus$inboundSchema,
+  uploaded_at: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "content_type": "contentType",
+    "document_type": "documentType",
+    "download_url": "downloadUrl",
+    "size_bytes": "sizeBytes",
+    "uploaded_at": "uploadedAt",
+  });
+});
+
+export function documentsFromJSON(
+  jsonString: string,
+): SafeParseResult<Documents, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Documents$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Documents' from JSON`,
+  );
+}
+
+/** @internal */
+export const TitleDeedDocumentListResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof TitleDeedDocumentListResponseObject
+> = z.nativeEnum(TitleDeedDocumentListResponseObject);
+
+/** @internal */
+export const TitleDeedDocumentListResponse$inboundSchema: z.ZodType<
+  TitleDeedDocumentListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  documents: z.array(z.lazy(() => Documents$inboundSchema)),
+  object: TitleDeedDocumentListResponseObject$inboundSchema,
+  title_number: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "title_number": "titleNumber",
+  });
+});
+
+export function titleDeedDocumentListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TitleDeedDocumentListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitleDeedDocumentListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleDeedDocumentListResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,406 @@
+/*
+ * 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 { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * HMLR document type
+ */
+export const TitleDeedPurchaseResponseDocumentType = {
+  RegisterExtract: "register-extract",
+  OfficialTitle: "official-title",
+  TitlePlan: "title-plan",
+} as const;
+/**
+ * HMLR document type
+ */
+export type TitleDeedPurchaseResponseDocumentType = OpenEnum<
+  typeof TitleDeedPurchaseResponseDocumentType
+>;
+
+/**
+ * Document processing status: pending (being processed), uploaded (ready to download), or failed
+ */
+export const TitleDeedPurchaseResponseStatus = {
+  Pending: "pending",
+  Uploaded: "uploaded",
+  Failed: "failed",
+} as const;
+/**
+ * Document processing status: pending (being processed), uploaded (ready to download), or failed
+ */
+export type TitleDeedPurchaseResponseStatus = OpenEnum<
+  typeof TitleDeedPurchaseResponseStatus
+>;
+
+export type TitleDeedPurchaseResponseDocuments = {
+  /**
+   * MIME type of the document (e.g. application/pdf)
+   */
+  contentType: string;
+  /**
+   * HMLR document type
+   */
+  documentType: TitleDeedPurchaseResponseDocumentType;
+  /**
+   * Relative URL for downloading the document (null unless status is uploaded)
+   */
+  downloadUrl: string | null;
+  /**
+   * File size in bytes (null while pending or failed)
+   */
+  sizeBytes: number | null;
+  /**
+   * Document processing status: pending (being processed), uploaded (ready to download), or failed
+   */
+  status: TitleDeedPurchaseResponseStatus;
+  /**
+   * ISO 8601 timestamp when the document became available (null until uploaded)
+   */
+  uploadedAt: string | null;
+};
+
+export const TitleDeedPurchaseResponseObject = {
+  TitleDeedPurchase: "title_deed_purchase",
+} as const;
+export type TitleDeedPurchaseResponseObject = ClosedEnum<
+  typeof TitleDeedPurchaseResponseObject
+>;
+
+export type Proprietors = {
+  /**
+   * Registered addresses for this proprietor
+   */
+  addresses: Array<string> | null;
+  /**
+   * Companies House registration number, if applicable
+   */
+  companyNumber: string | null;
+  /**
+   * ISO 8601 timestamp
+   */
+  createdAt: string;
+  /**
+   * Entity type: individual, limited_company, corporate_body, etc.
+   */
+  entityType: string;
+  /**
+   * Forenames (individuals only)
+   */
+  forenames: string | null;
+  id: string;
+  /**
+   * Whether this proprietor is the current registered owner
+   */
+  isCurrent: boolean;
+  /**
+   * Display name (full name for individuals, company name for organisations)
+   */
+  name: string;
+  /**
+   * Position in the proprietorship register (1-based)
+   */
+  proprietorOrder: number;
+  /**
+   * Surname (individuals only)
+   */
+  surname: string | null;
+  /**
+   * Tenure type at time of extract (e.g. Freehold, Leasehold)
+   */
+  tenure: string | null;
+  titleNumber: string;
+  /**
+   * ISO 8601 timestamp
+   */
+  updatedAt: string;
+};
+
+export type Purchase = {
+  /**
+   * ISO 8601 timestamp of when the purchase was made
+   */
+  createdAt: string;
+  /**
+   * Credits deducted for this purchase
+   */
+  creditsCharged: number;
+  /**
+   * Purchase record ID
+   */
+  id: string;
+  titleNumber: string;
+};
+
+export type TitleDeedPurchaseResponseAddress = {
+  buildingNumber?: string | undefined;
+  cityName?: string | undefined;
+  postcode?: string | undefined;
+  streetName?: string | undefined;
+};
+
+export type PropertyInfo = {
+  address: TitleDeedPurchaseResponseAddress;
+  /**
+   * Tenure type (e.g. Freehold, Leasehold)
+   */
+  tenureType?: string | undefined;
+  /**
+   * HMLR property type code
+   */
+  typeCode?: string | undefined;
+};
+
+export type TitleDeed = {
+  /**
+   * ISO 8601 timestamp
+   */
+  createdAt: string;
+  id: string;
+  /**
+   * Whether this is the most recent version
+   */
+  isLatest: boolean;
+  propertyInfo: PropertyInfo;
+  titleNumber: string;
+  /**
+   * ISO 8601 timestamp
+   */
+  updatedAt: string;
+  /**
+   * Title deed data version
+   */
+  version: number;
+};
+
+export type TitleDeedPurchaseResponse = {
+  /**
+   * Whether the tenant had already purchased this title
+   */
+  alreadyOwned: boolean;
+  /**
+   * Credits deducted for this request (0 if already owned)
+   */
+  creditsCharged: number;
+  /**
+   * Documents associated with this title deed and their processing statuses
+   */
+  documents: Array<TitleDeedPurchaseResponseDocuments>;
+  object: TitleDeedPurchaseResponseObject;
+  proprietors: Array<Proprietors>;
+  purchase: Purchase;
+  titleDeed: TitleDeed;
+};
+
+/** @internal */
+export const TitleDeedPurchaseResponseDocumentType$inboundSchema: z.ZodType<
+  TitleDeedPurchaseResponseDocumentType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TitleDeedPurchaseResponseDocumentType);
+
+/** @internal */
+export const TitleDeedPurchaseResponseStatus$inboundSchema: z.ZodType<
+  TitleDeedPurchaseResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TitleDeedPurchaseResponseStatus);
+
+/** @internal */
+export const TitleDeedPurchaseResponseDocuments$inboundSchema: z.ZodType<
+  TitleDeedPurchaseResponseDocuments,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  content_type: z.string(),
+  document_type: TitleDeedPurchaseResponseDocumentType$inboundSchema,
+  download_url: z.nullable(z.string()),
+  size_bytes: z.nullable(z.number()),
+  status: TitleDeedPurchaseResponseStatus$inboundSchema,
+  uploaded_at: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "content_type": "contentType",
+    "document_type": "documentType",
+    "download_url": "downloadUrl",
+    "size_bytes": "sizeBytes",
+    "uploaded_at": "uploadedAt",
+  });
+});
+
+export function titleDeedPurchaseResponseDocumentsFromJSON(
+  jsonString: string,
+): SafeParseResult<TitleDeedPurchaseResponseDocuments, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TitleDeedPurchaseResponseDocuments$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleDeedPurchaseResponseDocuments' from JSON`,
+  );
+}
+
+/** @internal */
+export const TitleDeedPurchaseResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof TitleDeedPurchaseResponseObject
+> = z.nativeEnum(TitleDeedPurchaseResponseObject);
+
+/** @internal */
+export const Proprietors$inboundSchema: z.ZodType<
+  Proprietors,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  addresses: z.nullable(z.array(z.string())),
+  companyNumber: z.nullable(z.string()),
+  createdAt: z.string(),
+  entityType: z.string(),
+  forenames: z.nullable(z.string()),
+  id: z.string(),
+  isCurrent: z.boolean(),
+  name: z.string(),
+  proprietorOrder: z.number(),
+  surname: z.nullable(z.string()),
+  tenure: z.nullable(z.string()),
+  titleNumber: z.string(),
+  updatedAt: z.string(),
+});
+
+export function proprietorsFromJSON(
+  jsonString: string,
+): SafeParseResult<Proprietors, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Proprietors$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Proprietors' from JSON`,
+  );
+}
+
+/** @internal */
+export const Purchase$inboundSchema: z.ZodType<
+  Purchase,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  createdAt: z.string(),
+  creditsCharged: z.number(),
+  id: z.string(),
+  titleNumber: z.string(),
+});
+
+export function purchaseFromJSON(
+  jsonString: string,
+): SafeParseResult<Purchase, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Purchase$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Purchase' from JSON`,
+  );
+}
+
+/** @internal */
+export const TitleDeedPurchaseResponseAddress$inboundSchema: z.ZodType<
+  TitleDeedPurchaseResponseAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  buildingNumber: z.string().optional(),
+  cityName: z.string().optional(),
+  postcode: z.string().optional(),
+  streetName: z.string().optional(),
+});
+
+export function titleDeedPurchaseResponseAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<TitleDeedPurchaseResponseAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitleDeedPurchaseResponseAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleDeedPurchaseResponseAddress' from JSON`,
+  );
+}
+
+/** @internal */
+export const PropertyInfo$inboundSchema: z.ZodType<
+  PropertyInfo,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address: z.lazy(() => TitleDeedPurchaseResponseAddress$inboundSchema),
+  tenureType: z.string().optional(),
+  typeCode: z.string().optional(),
+});
+
+export function propertyInfoFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyInfo, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyInfo$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyInfo' from JSON`,
+  );
+}
+
+/** @internal */
+export const TitleDeed$inboundSchema: z.ZodType<
+  TitleDeed,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  createdAt: z.string(),
+  id: z.string(),
+  isLatest: z.boolean(),
+  propertyInfo: z.lazy(() => PropertyInfo$inboundSchema),
+  titleNumber: z.string(),
+  updatedAt: z.string(),
+  version: z.number(),
+});
+
+export function titleDeedFromJSON(
+  jsonString: string,
+): SafeParseResult<TitleDeed, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitleDeed$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleDeed' from JSON`,
+  );
+}
+
+/** @internal */
+export const TitleDeedPurchaseResponse$inboundSchema: z.ZodType<
+  TitleDeedPurchaseResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  already_owned: z.boolean(),
+  credits_charged: z.number(),
+  documents: z.array(
+    z.lazy(() => TitleDeedPurchaseResponseDocuments$inboundSchema),
+  ),
+  object: TitleDeedPurchaseResponseObject$inboundSchema,
+  proprietors: z.array(z.lazy(() => Proprietors$inboundSchema)),
+  purchase: z.lazy(() => Purchase$inboundSchema),
+  title_deed: z.lazy(() => TitleDeed$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "already_owned": "alreadyOwned",
+    "credits_charged": "creditsCharged",
+    "title_deed": "titleDeed",
+  });
+});
+
+export function titleDeedPurchaseResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TitleDeedPurchaseResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitleDeedPurchaseResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleDeedPurchaseResponse' from JSON`,
+  );
+}

package/src/sdk/planningpolicy.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { planningPolicySearch } from "../funcs/planningPolicySearch.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class PlanningPolicy extends ClientSDK {
+  /**
+   * Search planning policy rules
+   *
+   * @remarks
+   * Hybrid search across extracted planning rules and document chunks using vector similarity, keyword matching, and reciprocal rank fusion. Returns rules with full provenance (source, page, section).
+   */
+  async search(
+    request: operations.SearchPlanningPolicyRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SearchPlanningPolicyResponseBody> {
+    return unwrapAsync(planningPolicySearch(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/property.ts

@@ -121,7 +121,10 @@ export class Property extends ClientSDK {
    * Query properties with advanced filters
    *
    * @remarks
-   * Search for properties using location, price, and other criteria
+   * Search for properties using location, price, and other criteria. By default, only residential properties are returned. To include commercial properties, add a `propertyCategory` condition to your query:
+   *
+   * - Commercial only: `{ "field": "propertyCategory", "comparator": "eq", "value": "commercial" }`
+   * - All categories: omit the default by adding `{ "field": "propertyCategory", "comparator": "exists" }`
    */
   async searchProperties(
     request?: shared.PropertyQueryRequest | undefined,

package/src/sdk/safety.ts

@@ -6,6 +6,7 @@ import { safetyGetV1SafetyCrime } from "../funcs/safetyGetV1SafetyCrime.js";
 import { safetyGetV1SafetyCrimeStats } from "../funcs/safetyGetV1SafetyCrimeStats.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "./models/operations/index.js";
+import * as shared from "./models/shared/index.js";
 import { unwrapAsync } from "./types/fp.js";
 
 export class Safety extends ClientSDK {
@@ -13,12 +14,12 @@ export class Safety extends ClientSDK {
    * Get crime data near location
    *
    * @remarks
-   * Retrieve individual crime incidents recorded within a specified radius of the given coordinates. Data is sourced from police.uk street-level crime records covering England and Wales. Incident locations are anonymised by police.uk to a nearby map point (accurate to ~150m). Data is published monthly with an approximate 2-month lag. Use the /crime/stats endpoint for aggregated statistics and safety scores instead of raw incidents.
+   * Retrieve crime incidents within a specified radius of coordinates
    */
   async getV1SafetyCrime(
     request: operations.GetV1SafetyCrimeRequest,
     options?: RequestOptions,
-  ): Promise<operations.GetV1SafetyCrimeResponseBody> {
+  ): Promise<shared.CrimeDataResponse> {
     return unwrapAsync(safetyGetV1SafetyCrime(
       this,
       request,
@@ -30,12 +31,12 @@ export class Safety extends ClientSDK {
    * Get crime statistics for an area
    *
    * @remarks
-   * Retrieve aggregated crime statistics and a computed safety score for the area around a given coordinate. This endpoint queries crime data across multiple months, calculates trends, category breakdowns, and an overall safety score. It is more suitable than /crime for area-level analysis as it returns summary statistics rather than individual incidents. Coverage: England and Wales (police.uk data). Data has an approximate 2-month publication lag.
+   * Retrieve aggregated crime statistics for a specified area
    */
   async getV1SafetyCrimeStats(
     request: operations.GetV1SafetyCrimeStatsRequest,
     options?: RequestOptions,
-  ): Promise<operations.GetV1SafetyCrimeStatsResponseBody> {
+  ): Promise<shared.AreaStatsResponse> {
     return unwrapAsync(safetyGetV1SafetyCrimeStats(
       this,
       request,