@vepler/sdk 5.28.1 → 6.1.0

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

@@ -17,19 +17,43 @@ import {
 
 export type GeographyMetricsRow = {
   /**
-   * Breakdown of the period by crime category.
+   * Breakdown of the period by crime category, `all` first.
    */
   categories: Array<GeographyCategoryMetric>;
+  /**
+   * `england` or `wales`. Null when merged areas span both.
+   */
+  country?: string | null | undefined;
+  /**
+   * How complete the data behind this row is. `available` means the police force reported throughout the window. `partial` means part of the window or part of the area was not reported. `missing` means the force did not report, so counts and rates come from stray incidents recorded by a neighbouring force and must not be read as evidence of safety. `unknown` means coverage could not be determined. Read this beside every number in the row.
+   */
+  dataAvailability?: string | undefined;
+  /**
+   * Type of area the code identifies: `lsoa21`, `msoa21`, `district_borough_unitary_ward`, `built_up_area_250`, `local_authority_district`, `county_unitary_authority`, `english_region` or `country_region`. A unitary authority is served as `local_authority_district`, and every ward, in England and in Wales, is served as `district_borough_unitary_ward`. Null when areas are merged.
+   */
+  entityType?: string | null | undefined;
   /**
    * Area code this row covers. When areas are merged it is the comma-joined list of every requested code that contributed to the row.
    */
   geographicCode: string;
+  /**
+   * How much of this area's own footprint is covered by the Lower Layer Super Output Areas its figures are aggregated from, as a fraction from 0 to 1. A value means the figures are an approximation of that quality, so 0.88 says the areas summed together cover 88% of this one. Null means the area is made up of whole Lower Layer Super Output Areas and no approximation arises, which is the case at every administrative level from LSOA to country; it is not an unknown value. Wards and built-up areas average about 0.88, and roughly one in eight is below 0.7.
+   */
+  geographyFit?: number | null | undefined;
+  /**
+   * Version of the scoring model that produced the row.
+   */
+  modelVersion?: string | null | undefined;
+  /**
+   * Name of the area. Null when areas are merged.
+   */
+  name?: string | null | undefined;
   /**
    * Month this row covers, in `YYYY-MM` form.
    */
   period: string;
   /**
-   * Resident population the rates are calculated against. When areas are merged it is the sum across them.
+   * Resident population the rates are calculated against, from the latest mid-year estimate. When areas are merged it is the sum across them. 0 when the area's data is missing.
    */
   population: number;
   /**
@@ -37,13 +61,17 @@ export type GeographyMetricsRow = {
    */
   timeSeriesData: Array<GeographyTimeSeriesPoint>;
   /**
-   * Number of incidents across all categories for the period.
+   * Number of incidents across all categories over the 24-month window ending at the period.
    */
   totalCrimeCount: number;
   /**
-   * Incidents across all categories per 1,000 residents.
+   * Incidents across all categories per 1,000 residents per year over the window.
    */
   totalCrimeRate: number;
+  /**
+   * The area's overall safety score, from 0 to 100, where higher is safer. The same value as the `all` category's `crimeScore`. Null when areas are merged and when the police force did not report.
+   */
+  totalCrimeScore?: number | null | undefined;
 };
 
 /** @internal */
@@ -53,12 +81,19 @@ export const GeographyMetricsRow$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   categories: z.array(GeographyCategoryMetric$inboundSchema),
+  country: z.nullable(z.string()).optional(),
+  dataAvailability: z.string().optional(),
+  entityType: z.nullable(z.string()).optional(),
   geographicCode: z.string(),
+  geographyFit: z.nullable(z.number()).optional(),
+  modelVersion: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
   period: z.string(),
   population: z.number(),
   timeSeriesData: z.array(GeographyTimeSeriesPoint$inboundSchema),
   totalCrimeCount: z.number(),
   totalCrimeRate: z.number(),
+  totalCrimeScore: z.nullable(z.number()).optional(),
 });
 
 export function geographyMetricsRowFromJSON(

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

@@ -0,0 +1,69 @@
+/*
+ * 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 GeographyRelatedArea = {
+  /**
+   * The layer as its publisher names it — `lsoa`, `sct_dz`, `nir_dz`. Never carries a vintage.
+   */
+  areaType: string;
+  /**
+   * The GSS code, e.g. `E01000001`.
+   */
+  code: string;
+  /**
+   * Hops from the area asked about. 1 is a direct parent or child.
+   */
+  depth: number;
+  /**
+   * Worst fit along the whole path: `exact`, `best_fit` or `spatial`. Anything other than `exact` means aggregating across this relationship gives an approximate answer.
+   */
+  minFit: string;
+  /**
+   * Publisher name. Null where none is published — ONS issues no names for Output Areas — and never unique, so never key on it.
+   */
+  name: string | null;
+  /**
+   * `ENG` | `WAL` | `SCO` | `NIR`, or null for a genuinely cross-border area.
+   */
+  nation: string | null;
+  /**
+   * Cross-nation tier: `small_area` is an LSOA in England and Wales and a Data Zone in Scotland and Northern Ireland.
+   */
+  tier: string | null;
+  /**
+   * The layer edition, e.g. `2021`.
+   */
+  vintage: string | null;
+};
+
+/** @internal */
+export const GeographyRelatedArea$inboundSchema: z.ZodType<
+  GeographyRelatedArea,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaType: z.string(),
+  code: z.string(),
+  depth: z.number().int(),
+  minFit: z.string(),
+  name: z.nullable(z.string()),
+  nation: z.nullable(z.string()),
+  tier: z.nullable(z.string()),
+  vintage: z.nullable(z.string()),
+});
+
+export function geographyRelatedAreaFromJSON(
+  jsonString: string,
+): SafeParseResult<GeographyRelatedArea, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GeographyRelatedArea$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GeographyRelatedArea' from JSON`,
+  );
+}

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

@@ -13,19 +13,23 @@ export type GeographyTimeSeriesPoint = {
    */
   category: string;
   /**
-   * Number of incidents in this category for the month.
+   * Number of incidents in this category over the 24-month window ending at this month.
    */
   crimeCount: number;
   /**
-   * Incidents in this category per 1,000 residents.
+   * Incidents in this category per 1,000 residents per year over that window.
    */
   crimeRate: number;
   /**
-   * Safety score for this month and category, from 0 to 100, where higher is safer. Null when areas are merged.
+   * Safety score for this month and category, from 0 to 100, where higher is safer. Null when areas are merged and when the police force did not report.
    */
   crimeScore: number | null;
   /**
-   * Where this month's score ranks nationally, from 0 to 100. Null when it has not been ranked.
+   * How complete the data behind this row is. `available` means the police force reported throughout the window. `partial` means part of the window or part of the area was not reported. `missing` means the force did not report, so counts and rates come from stray incidents recorded by a neighbouring force and must not be read as evidence of safety. `unknown` means coverage could not be determined. Read this beside every number in the row.
+   */
+  dataAvailability?: string | undefined;
+  /**
+   * Where this month's score ranks among areas of the same type, from 0 to 100, where 100 is safest. Null when it has not been ranked.
    */
   percentile: number | null;
   /**
@@ -33,7 +37,7 @@ export type GeographyTimeSeriesPoint = {
    */
   period: string;
   /**
-   * Direction and size of the change for this month and category, from -1 to 1. Null when areas are merged.
+   * Direction and size of the year-on-year change for this month and category. Positive means crime is falling. Null when areas are merged.
    */
   trendFactor: number | null;
 };
@@ -48,6 +52,7 @@ export const GeographyTimeSeriesPoint$inboundSchema: z.ZodType<
   crimeCount: z.number(),
   crimeRate: z.number(),
   crimeScore: z.nullable(z.number()),
+  dataAvailability: z.string().optional(),
   percentile: z.nullable(z.number()),
   period: z.string(),
   trendFactor: z.nullable(z.number()),

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

@@ -96,7 +96,7 @@ export type HeritageDesignationFeature = {
   listedGrade?: string | undefined;
   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` and `parish`. `legal_regime` names the Act the designation is made under, and `status` is the register status the custodian records for it. Only the keys the source actually carries appear. Requires the `designationSourceData` permission on the licence.
    */
   metadata?: { [k: string]: any } | undefined;
   /**

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/listing.ts

@@ -151,9 +151,9 @@ export type Listing = {
    */
   pricing?: Pricing | undefined;
   /**
-   * When the listing was first published, as an ISO 8601 timestamp.
+   * When the listing was first published, as an ISO 8601 timestamp. Null when the source does not publish one.
    */
-  publishedDate?: Date | undefined;
+  publishedDate?: Date | null | undefined;
   /**
    * When the listing was taken down, as an ISO 8601 timestamp. Null while it is still live.
    */
@@ -299,8 +299,8 @@ export const Listing$inboundSchema: z.ZodType<Listing, z.ZodTypeDef, unknown> =
     listingId: z.string().optional(),
     priceChange: z.array(ListingPriceChange$inboundSchema).optional(),
     pricing: z.lazy(() => Pricing$inboundSchema).optional(),
-    publishedDate: z.string().datetime({ offset: true }).transform(v =>
-      new Date(v)
+    publishedDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ).optional(),
     removedDate: z.nullable(
       z.string().datetime({ offset: true }).transform(v => new Date(v)),

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 eight levels: Lower Layer Super Output Area (LSOA, `E01`/`W01`), Middle Layer Super Output Area (MSOA, `E02`/`W02`), ward (`E05`/`W05`), built-up area (`E63`/`W45`/`K08`), 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 parishes, and codes in Scotland or Northern Ireland come back as `data: []`. Ward and built-up-area figures are aggregated from the Lower Layer Super Output Areas assigned to each area rather than counted on its own boundary, so they are approximations, and `geographyFit` on every row reports how much of the area's footprint those smaller areas cover. A built-up area smaller than the Lower Layer Super Output Area containing it has no figures and comes back as `data: []`. Percentiles rank an area against others of the same type, so a ward is ranked among wards and not among districts. 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));