@vepler/sdk 5.28.1 → 6.0.0

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

@@ -195,9 +195,11 @@ export * from "./frameworkdetailresponse.js";
 export * from "./frameworklistresponse.js";
 export * from "./geocodeprecision.js";
 export * from "./geographiccontext.js";
+export * from "./geographyarea.js";
 export * from "./geographycategorymetric.js";
 export * from "./geographymetricslistresponse.js";
 export * from "./geographymetricsrow.js";
+export * from "./geographyrelatedarea.js";
 export * from "./geographytimeseriespoint.js";
 export * from "./healthevidencelevel.js";
 export * from "./healthimpact.js";
@@ -413,6 +415,9 @@ export * from "./termsaggregationresult.js";
 export * from "./termsbucket.js";
 export * from "./tierskipreason.js";
 export * from "./titlecovenant.js";
+export * from "./titledeedapplication.js";
+export * from "./titledeedapplicationlistresponse.js";
+export * from "./titledeedavailabilityresponse.js";
 export * from "./titledeeddocumentlistresponse.js";
 export * from "./titledeedpurchasepending.js";
 export * from "./titledeedpurchaseresponse.js";

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

@@ -88,7 +88,7 @@ export type LandConstraintDesignationFeature = {
   licence: string | null;
   localAuthority?: string | null | undefined;
   /**
-   * Extra detail the custodian publishes, narrowed to a fixed set of keys that varies by `designationType`: `status`, `legal_regime`, `woodland_composition`, `native_pct`, `canopy_pct`, `dominant_habitat`, `maturity`, `parish`, `geographic_location` and `stat_area_km2`. Only the keys the source actually carries appear. Requires the `designationSourceData` permission on the licence.
+   * Extra detail the custodian publishes, narrowed to `status`, `legal_regime`, `permitted_development_rights` and `bmv`. On an Article 4 direction area, `permitted_development_rights` records which rights that direction withdraws, in the wording the local authority used: most entries are semicolon-separated class codes from the Town and Country Planning (General Permitted Development) (England) Order 2015, such as `1A;1C;1D;1F;2A;2B`, but a substantial minority are a sentence naming the Parts and Classes instead, so parse it defensively. On an agricultural land classification area, `bmv` is true where the grade counts as Best and Most Versatile agricultural land. Only the keys the source actually carries appear, and this field requires the `designationSourceData` permission on the licence.
    */
   metadata?: { [k: string]: any } | undefined;
   name?: string | null | undefined;

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

@@ -0,0 +1,124 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type TitleDeedApplication = {
+  /**
+   * Who the application was made for, where it is recorded.
+   */
+  applicant: string | null;
+  customerReference: string | null;
+  /**
+   * True when the applicant has asked HM Land Registry to expedite the application.
+   */
+  expedited: boolean;
+  /**
+   * The firm that lodged the application.
+   */
+  lodgedBy: string | null;
+  /**
+   * Titles this application will create, such as a new leasehold title over part of the property.
+   */
+  newTitles: Array<string> | null;
+  /**
+   * Titles this application is being carved out of.
+   */
+  parentTitles: Array<string> | null;
+  /**
+   * The date the application takes priority from, where one applies.
+   */
+  priorityDate: string | null;
+  /**
+   * End of the priority period, after which the protection lapses.
+   */
+  priorityEndDate: string | null;
+  /**
+   * Start of the priority period, on a search that carries one.
+   */
+  priorityStartDate: string | null;
+  priorityTime: string | null;
+  /**
+   * How far HM Land Registry has taken the application, in their own words.
+   */
+  progress: string | null;
+  /**
+   * The part of the property the application concerns, where it names one.
+   */
+  propertyDescription: string | null;
+  /**
+   * The channel the application arrived through.
+   */
+  receivedBy: string | null;
+  /**
+   * The reference HM Land Registry allocated to this application.
+   */
+  reference: string;
+  searchCertificateNumber: string | null;
+  searchInterest: string | null;
+  /**
+   * What kind of application this is, such as a dealing or a first lease.
+   */
+  type: string;
+  /**
+   * The numeric code behind `type`, for callers that prefer to switch on a stable value.
+   */
+  typeCode: string;
+};
+
+/** @internal */
+export const TitleDeedApplication$inboundSchema: z.ZodType<
+  TitleDeedApplication,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  applicant: z.nullable(z.string()),
+  customer_reference: z.nullable(z.string()),
+  expedited: z.boolean(),
+  lodged_by: z.nullable(z.string()),
+  new_titles: z.nullable(z.array(z.string())),
+  parent_titles: z.nullable(z.array(z.string())),
+  priority_date: z.nullable(z.string()),
+  priority_end_date: z.nullable(z.string()),
+  priority_start_date: z.nullable(z.string()),
+  priority_time: z.nullable(z.string()),
+  progress: z.nullable(z.string()),
+  property_description: z.nullable(z.string()),
+  received_by: z.nullable(z.string()),
+  reference: z.string(),
+  search_certificate_number: z.nullable(z.string()),
+  search_interest: z.nullable(z.string()),
+  type: z.string(),
+  type_code: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "customer_reference": "customerReference",
+    "lodged_by": "lodgedBy",
+    "new_titles": "newTitles",
+    "parent_titles": "parentTitles",
+    "priority_date": "priorityDate",
+    "priority_end_date": "priorityEndDate",
+    "priority_start_date": "priorityStartDate",
+    "priority_time": "priorityTime",
+    "property_description": "propertyDescription",
+    "received_by": "receivedBy",
+    "search_certificate_number": "searchCertificateNumber",
+    "search_interest": "searchInterest",
+    "type_code": "typeCode",
+  });
+});
+
+export function titleDeedApplicationFromJSON(
+  jsonString: string,
+): SafeParseResult<TitleDeedApplication, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitleDeedApplication$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleDeedApplication' from JSON`,
+  );
+}

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

@@ -0,0 +1,64 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  TitleDeedApplication,
+  TitleDeedApplication$inboundSchema,
+} from "./titledeedapplication.js";
+
+export const TitleDeedApplicationListResponseObject = {
+  TitleDeedApplicationList: "title_deed_application_list",
+} as const;
+export type TitleDeedApplicationListResponseObject = ClosedEnum<
+  typeof TitleDeedApplicationListResponseObject
+>;
+
+export type TitleDeedApplicationListResponse = {
+  applications: Array<TitleDeedApplication>;
+  /**
+   * True when at least one application is lodged against this title. While that is the case a standard official copy cannot be purchased.
+   */
+  applicationsPending: boolean;
+  object: TitleDeedApplicationListResponseObject;
+  titleNumber: string;
+};
+
+/** @internal */
+export const TitleDeedApplicationListResponseObject$inboundSchema:
+  z.ZodNativeEnum<typeof TitleDeedApplicationListResponseObject> = z.nativeEnum(
+    TitleDeedApplicationListResponseObject,
+  );
+
+/** @internal */
+export const TitleDeedApplicationListResponse$inboundSchema: z.ZodType<
+  TitleDeedApplicationListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  applications: z.array(TitleDeedApplication$inboundSchema),
+  applications_pending: z.boolean(),
+  object: TitleDeedApplicationListResponseObject$inboundSchema,
+  title_number: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "applications_pending": "applicationsPending",
+    "title_number": "titleNumber",
+  });
+});
+
+export function titleDeedApplicationListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TitleDeedApplicationListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitleDeedApplicationListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleDeedApplicationListResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,162 @@
+/*
+ * 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";
+
+export const TitleDeedAvailabilityResponseObject = {
+  TitleDeedAvailability: "title_deed_availability",
+} as const;
+export type TitleDeedAvailabilityResponseObject = ClosedEnum<
+  typeof TitleDeedAvailabilityResponseObject
+>;
+
+/**
+ * Why the title cannot be bought, or null when it can. `applications_pending` means an application is lodged against the title and HM Land Registry will not issue a standard official copy until it completes. `register_unavailable` means the register cannot be delivered electronically at all.
+ */
+export const ReasonCode = {
+  RegisterUnavailable: "register_unavailable",
+  ApplicationsPending: "applications_pending",
+} as const;
+/**
+ * Why the title cannot be bought, or null when it can. `applications_pending` means an application is lodged against the title and HM Land Registry will not issue a standard official copy until it completes. `register_unavailable` means the register cannot be delivered electronically at all.
+ */
+export type ReasonCode = OpenEnum<typeof ReasonCode>;
+
+export type Register = {
+  availabilityCode: string | null;
+  backdated: boolean | null;
+};
+
+export type TitlePlan = {
+  availabilityCode: string | null;
+  backdated: boolean | null;
+};
+
+export type TitleDeedAvailabilityResponse = {
+  /**
+   * True when one or more applications are lodged against this title and not yet completed.
+   */
+  applicationsPending: boolean | null;
+  object: TitleDeedAvailabilityResponseObject;
+  /**
+   * True when a purchase of this title would be accepted today. False means a purchase would be refused and refunded, so check this before buying.
+   */
+  purchasable: boolean;
+  /**
+   * The refusal explained in a sentence, or null when the title can be bought.
+   */
+  reason: string | null;
+  /**
+   * Why the title cannot be bought, or null when it can. `applications_pending` means an application is lodged against the title and HM Land Registry will not issue a standard official copy until it completes. `register_unavailable` means the register cannot be delivered electronically at all.
+   */
+  reasonCode: ReasonCode | null;
+  register: Register;
+  titleNumber: string;
+  titlePlan: TitlePlan;
+  /**
+   * The registration status HM Land Registry holds for this title.
+   */
+  titleStatus: string | null;
+};
+
+/** @internal */
+export const TitleDeedAvailabilityResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof TitleDeedAvailabilityResponseObject
+> = z.nativeEnum(TitleDeedAvailabilityResponseObject);
+
+/** @internal */
+export const ReasonCode$inboundSchema: z.ZodType<
+  ReasonCode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ReasonCode);
+
+/** @internal */
+export const Register$inboundSchema: z.ZodType<
+  Register,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  availability_code: z.nullable(z.string()),
+  backdated: z.nullable(z.boolean()),
+}).transform((v) => {
+  return remap$(v, {
+    "availability_code": "availabilityCode",
+  });
+});
+
+export function registerFromJSON(
+  jsonString: string,
+): SafeParseResult<Register, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Register$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Register' from JSON`,
+  );
+}
+
+/** @internal */
+export const TitlePlan$inboundSchema: z.ZodType<
+  TitlePlan,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  availability_code: z.nullable(z.string()),
+  backdated: z.nullable(z.boolean()),
+}).transform((v) => {
+  return remap$(v, {
+    "availability_code": "availabilityCode",
+  });
+});
+
+export function titlePlanFromJSON(
+  jsonString: string,
+): SafeParseResult<TitlePlan, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitlePlan$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitlePlan' from JSON`,
+  );
+}
+
+/** @internal */
+export const TitleDeedAvailabilityResponse$inboundSchema: z.ZodType<
+  TitleDeedAvailabilityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  applications_pending: z.nullable(z.boolean()),
+  object: TitleDeedAvailabilityResponseObject$inboundSchema,
+  purchasable: z.boolean(),
+  reason: z.nullable(z.string()),
+  reason_code: z.nullable(ReasonCode$inboundSchema),
+  register: z.lazy(() => Register$inboundSchema),
+  title_number: z.string(),
+  title_plan: z.lazy(() => TitlePlan$inboundSchema),
+  title_status: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "applications_pending": "applicationsPending",
+    "reason_code": "reasonCode",
+    "title_number": "titleNumber",
+    "title_plan": "titlePlan",
+    "title_status": "titleStatus",
+  });
+});
+
+export function titleDeedAvailabilityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TitleDeedAvailabilityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TitleDeedAvailabilityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TitleDeedAvailabilityResponse' from JSON`,
+  );
+}

package/src/sdk/safety.ts

@@ -52,7 +52,7 @@ export class Safety extends ClientSDK {
    * Get crime incidents near a point
    *
    * @remarks
-   * Return the individual crime incidents recorded within `radius` metres of a point, covering England and Wales. Incident locations are anonymised at source to a nearby map point, accurate to roughly 150m, and are published monthly around two months in arrears. The response always covers six months: supplying `date` ends that window at the month given, or at the most recent month with significant reporting if that is earlier, and leaving `date` out ends it at the most recent month with significant reporting in the area. A single request returns at most 5,000 incidents, and sets `summary.truncated` to `true` when it hits that cap, so narrow the radius or the date window to see the rest.
+   * Return the individual crime incidents recorded within `radius` metres of a point, covering England and Wales from August 2020 onwards. Incident locations are anonymised at source to a nearby map point, accurate to roughly 150m, and are published monthly around two months in arrears, dated to the first of the month they were recorded in. The response always covers six months: supplying `date` ends that window at the month given, or at the most recent month with significant reporting if that is earlier, and leaving `date` out ends it at the most recent month with significant reporting in the area. A single request returns at most 5,000 incidents, and sets `summary.truncated` to `true` when it hits that cap, so narrow the radius or the date window to see the rest.
    */
   async getCrimeIncidents(
     request: operations.GetCrimeIncidentsRequest,
@@ -83,10 +83,10 @@ export class Safety extends ClientSDK {
   }
 
   /**
-   * Get crime metrics for one or more geographic areas (England only)
+   * Get crime metrics for one or more geographic areas (England and Wales)
    *
    * @remarks
-   * Return scored crime metrics for one or more areas, identified by Lower Layer Super Output Area (LSOA), ward or authority code, across one or more months, each with a per-category breakdown and an optional monthly history. Coverage is England only: the scored area metrics behind this endpoint hold English geographies alone, so codes in Wales, Scotland or Northern Ireland come back as `data: []`, and incident-level data for England and Wales lives at `/v1/safety/crime` instead. By default the response carries one row per area and month; with `mergeAreas=true` it carries one row per month, with counts and population summed across every requested area and scores, percentiles and trends set to null because they cannot be combined across areas. Choose the months either explicitly with `periods=YYYY-MM,YYYY-MM` or as a range with `startDate` and `endDate`, never both, and set how far each row's history reaches back with `months`, which defaults to 12. An empty result comes back as `data: []` with `total_count: 0`, never as a 204.
+   * Return scored crime metrics for one or more areas across one or more months, each with a per-category breakdown and an optional monthly history. Areas are identified by GSS code at six levels: Lower Layer Super Output Area (LSOA, `E01`/`W01`), Middle Layer Super Output Area (MSOA, `E02`/`W02`), local authority district or unitary authority (`E06`-`E09`, `W06`), county (`E10`), English region (`E12`) and country (`E92`, `W92`). Coverage is England and Wales; codes at other levels, such as wards or parishes, and codes in Scotland or Northern Ireland come back as `data: []`. Every month summarises the trailing 24-month window ending at that month, so counts are window totals and rates are per 1,000 residents per year. Months are published two months in arrears, roughly monthly; the catalogue endpoint lists the months held. Scores are null, never 0, where a police force did not report; read `dataAvailability` beside every number. By default the response carries one row per area and month; with `mergeAreas=true` it carries one row per month, with counts and population summed across every requested area and scores, percentiles and trends set to null because they cannot be combined across areas. Choose the months either explicitly with `periods=YYYY-MM,YYYY-MM` or as a range with `startDate` and `endDate`, never both, and set how far each row's history reaches back with `months`, which defaults to 12. An empty result comes back as `data: []` with `total_count: 0`, never as a 204.
    */
   async getGeographyMetrics(
     request: operations.GetGeographyMetricsRequest,

package/src/sdk/sdk.ts

@@ -16,6 +16,7 @@ import { Councils } from "./councils.js";
 import { Energy } from "./energy.js";
 import { Epc } from "./epc.js";
 import { FloodRisk } from "./floodrisk.js";
+import { Geography } from "./geography.js";
 import { Heritage } from "./heritage.js";
 import { LandConstraint } from "./landconstraint.js";
 import { Listings } from "./listings.js";
@@ -115,6 +116,11 @@ export class SDK extends ClientSDK {
     return (this._floodRisk ??= new FloodRisk(this._options));
   }
 
+  private _geography?: Geography;
+  get geography(): Geography {
+    return (this._geography ??= new Geography(this._options));
+  }
+
   private _heritage?: Heritage;
   get heritage(): Heritage {
     return (this._heritage ??= new Heritage(this._options));

package/src/sdk/titledeeds.ts

@@ -3,6 +3,8 @@
  */
 
 import { titleDeedsGetV1TitleDeedsTitleNumber } from "../funcs/titleDeedsGetV1TitleDeedsTitleNumber.js";
+import { titleDeedsGetV1TitleDeedsTitleNumberApplications } from "../funcs/titleDeedsGetV1TitleDeedsTitleNumberApplications.js";
+import { titleDeedsGetV1TitleDeedsTitleNumberAvailability } from "../funcs/titleDeedsGetV1TitleDeedsTitleNumberAvailability.js";
 import { titleDeedsGetV1TitleDeedsTitleNumberDocuments } from "../funcs/titleDeedsGetV1TitleDeedsTitleNumberDocuments.js";
 import { titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType } from "../funcs/titleDeedsGetV1TitleDeedsTitleNumberDocumentsDocumentType.js";
 import { titleDeedsGetV1TitleDeedsTitleNumberPurchaseStatus } from "../funcs/titleDeedsGetV1TitleDeedsTitleNumberPurchaseStatus.js";
@@ -31,6 +33,40 @@ export class TitleDeeds extends ClientSDK {
     ));
   }
 
+  /**
+   * List applications pending against a title deed
+   *
+   * @remarks
+   * Returns the applications lodged against this title at HM Land Registry and not yet completed, with the type of each, who lodged it, its priority date and how far it has progressed. Nothing is charged. While any application is pending, a standard official copy of the title cannot be purchased.
+   */
+  async getV1TitleDeedsTitleNumberApplications(
+    request: operations.GetV1TitleDeedsTitleNumberApplicationsRequest,
+    options?: RequestOptions,
+  ): Promise<shared.TitleDeedApplicationListResponse> {
+    return unwrapAsync(titleDeedsGetV1TitleDeedsTitleNumberApplications(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Check whether a title deed can be purchased
+   *
+   * @remarks
+   * Reports whether HM Land Registry will sell an official copy of this title today, and if not, why not. Nothing is charged and no purchase is made, so this can be called before every purchase. The common reason a title cannot be bought is that an application is pending against it, in which case HM Land Registry will not issue a standard official copy until the application completes. Use `/{titleNumber}/applications` to see what is pending.
+   */
+  async getV1TitleDeedsTitleNumberAvailability(
+    request: operations.GetV1TitleDeedsTitleNumberAvailabilityRequest,
+    options?: RequestOptions,
+  ): Promise<shared.TitleDeedAvailabilityResponse> {
+    return unwrapAsync(titleDeedsGetV1TitleDeedsTitleNumberAvailability(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List documents for a purchased title deed
    *