@vepler/sdk 2.38.2 → 2.42.0

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/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,

package/src/sdk/sdk.ts

@@ -13,6 +13,7 @@ import { Epc } from "./epc.js";
 import { Listings } from "./listings.js";
 import { Metrics } from "./metrics.js";
 import { Planning } from "./planning.js";
+import { PlanningPolicy } from "./planningpolicy.js";
 import { Poi } from "./poi.js";
 import { Property } from "./property.js";
 import { Safety } from "./safety.js";
@@ -21,6 +22,7 @@ import { Search } from "./search.js";
 import { Sites } from "./sites.js";
 import { Streets } from "./streets.js";
 import { System } from "./system.js";
+import { TitleDeeds } from "./titledeeds.js";
 
 export class SDK extends ClientSDK {
   private _address?: Address;
@@ -83,6 +85,11 @@ export class SDK extends ClientSDK {
     return (this._streets ??= new Streets(this._options));
   }
 
+  private _planningPolicy?: PlanningPolicy;
+  get planningPolicy(): PlanningPolicy {
+    return (this._planningPolicy ??= new PlanningPolicy(this._options));
+  }
+
   private _planning?: Planning;
   get planning(): Planning {
     return (this._planning ??= new Planning(this._options));
@@ -112,4 +119,9 @@ export class SDK extends ClientSDK {
   get sites(): Sites {
     return (this._sites ??= new Sites(this._options));
   }
+
+  private _titleDeeds?: TitleDeeds;
+  get titleDeeds(): TitleDeeds {
+    return (this._titleDeeds ??= new TitleDeeds(this._options));
+  }
 }

package/src/sdk/titledeeds.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { titleDeedsGetV1TitleDeedsTitleNumberDocuments } from "../funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.js";
+import { titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType } from "../funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.js";
+import { titleDeedsPostV1TitleDeedsTitleNumberPurchase } from "../funcs/titleDeedsPostV1TitleDeedsTitleNumberPurchase.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 TitleDeeds extends ClientSDK {
+  /**
+   * List documents for a purchased title deed
+   *
+   * @remarks
+   * Returns all documents associated with a title deed, including their processing status (pending, uploaded, or failed).
+   */
+  async getV1TitleDeedsTitleNumberDocuments(
+    request: operations.GetV1TitleDeedsTitleNumberDocumentsRequest,
+    options?: RequestOptions,
+  ): Promise<shared.TitleDeedDocumentListResponse> {
+    return unwrapAsync(titleDeedsGetV1TitleDeedsTitleNumberDocuments(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Download a specific document for a purchased title deed
+   *
+   * @remarks
+   * Downloads a PDF document by type. Only available for documents with status 'uploaded'.
+   */
+  async getV1TitleDeedsTitleNumberDocumentsDocumentType(
+    request: operations.GetV1TitleDeedsTitleNumberDocumentsDocumentTypeRequest,
+    options?: RequestOptions,
+  ): Promise<ReadableStream<Uint8Array>> {
+    return unwrapAsync(
+      titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType(
+        this,
+        request,
+        options,
+      ),
+    );
+  }
+
+  /**
+   * Purchase a title deed
+   *
+   * @remarks
+   * Purchase title deed data by title number. Costs 7 credits per title. Previously purchased titles are returned at no additional cost.
+   */
+  async postV1TitleDeedsTitleNumberPurchase(
+    request: operations.PostV1TitleDeedsTitleNumberPurchaseRequest,
+    options?: RequestOptions,
+  ): Promise<shared.TitleDeedPurchaseResponse> {
+    return unwrapAsync(titleDeedsPostV1TitleDeedsTitleNumberPurchase(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/examples/package.json

@@ -1,18 +0,0 @@
-{
-  "name": "@vepler/sdk-examples",
-  "version": "1.0.0",
-  "private": true,
-  "scripts": {
-    "build:parent": "cd .. && npm i && npm run build && cd -",
-    "build:examples": "npm i",
-    "build": "npm run build:parent && npm run build:examples"
-  },
-  "devDependencies": {
-    "@types/node": "^20.0.0",
-    "dotenv": "^16.4.5",
-    "tsx": "^4.19.2"
-  },
-  "dependencies": {
-    "@vepler/sdk": "file:.."
-  }
-}