@vepler/sdk 5.28.1 → 6.0.0

package/src/sdk/models/operations/getv1titledeedstitlenumberapplications.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetV1TitleDeedsTitleNumberApplicationsRequest = {
+  /**
+   * HM Land Registry title number: up to three letters followed by one to six digits. Case is not significant and the value is upper-cased; older titles may be digits only.
+   */
+  titleNumber: string;
+};
+
+/** @internal */
+export type GetV1TitleDeedsTitleNumberApplicationsRequest$Outbound = {
+  titleNumber: string;
+};
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberApplicationsRequest$outboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberApplicationsRequest$Outbound,
+    z.ZodTypeDef,
+    GetV1TitleDeedsTitleNumberApplicationsRequest
+  > = z.object({
+    titleNumber: z.string(),
+  });
+
+export function getV1TitleDeedsTitleNumberApplicationsRequestToJSON(
+  getV1TitleDeedsTitleNumberApplicationsRequest:
+    GetV1TitleDeedsTitleNumberApplicationsRequest,
+): string {
+  return JSON.stringify(
+    GetV1TitleDeedsTitleNumberApplicationsRequest$outboundSchema.parse(
+      getV1TitleDeedsTitleNumberApplicationsRequest,
+    ),
+  );
+}

package/src/sdk/models/operations/getv1titledeedstitlenumberavailability.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetV1TitleDeedsTitleNumberAvailabilityRequest = {
+  /**
+   * HM Land Registry title number: up to three letters followed by one to six digits. Case is not significant and the value is upper-cased; older titles may be digits only.
+   */
+  titleNumber: string;
+};
+
+/** @internal */
+export type GetV1TitleDeedsTitleNumberAvailabilityRequest$Outbound = {
+  titleNumber: string;
+};
+
+/** @internal */
+export const GetV1TitleDeedsTitleNumberAvailabilityRequest$outboundSchema:
+  z.ZodType<
+    GetV1TitleDeedsTitleNumberAvailabilityRequest$Outbound,
+    z.ZodTypeDef,
+    GetV1TitleDeedsTitleNumberAvailabilityRequest
+  > = z.object({
+    titleNumber: z.string(),
+  });
+
+export function getV1TitleDeedsTitleNumberAvailabilityRequestToJSON(
+  getV1TitleDeedsTitleNumberAvailabilityRequest:
+    GetV1TitleDeedsTitleNumberAvailabilityRequest,
+): string {
+  return JSON.stringify(
+    GetV1TitleDeedsTitleNumberAvailabilityRequest$outboundSchema.parse(
+      getV1TitleDeedsTitleNumberAvailabilityRequest,
+    ),
+  );
+}

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

@@ -49,7 +49,13 @@ export * from "./getepcbylocationid.js";
 export * from "./getepchealth.js";
 export * from "./getframework.js";
 export * from "./getgeographicmetricaggregation.js";
+export * from "./getgeographyancestors.js";
+export * from "./getgeographyareas.js";
+export * from "./getgeographychildren.js";
+export * from "./getgeographydescendants.js";
 export * from "./getgeographymetrics.js";
+export * from "./getgeographyprovenance.js";
+export * from "./getgeographyrelease.js";
 export * from "./getheritagedesignation.js";
 export * from "./getlandconstraintdesignation.js";
 export * from "./getlistingbyid.js";
@@ -86,6 +92,8 @@ export * from "./getsubstationdfes.js";
 export * from "./gettransactionbyid.js";
 export * from "./gettransactionsbyuprn.js";
 export * from "./getv1titledeedstitlenumber.js";
+export * from "./getv1titledeedstitlenumberapplications.js";
+export * from "./getv1titledeedstitlenumberavailability.js";
 export * from "./getv1titledeedstitlenumberdocuments.js";
 export * from "./getv1titledeedstitlenumberdocumentsdocumenttype.js";
 export * from "./getv1titledeedstitlenumberpurchasestatus.js";

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

@@ -84,7 +84,7 @@ export type ConservationDesignationFeature = {
   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`, `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.
    */
   metadata?: { [k: string]: any } | undefined;
   name?: string | null | undefined;

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

@@ -10,25 +10,24 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Granularity of `period`.
+ * Granularity of `period`. Only monthly periods are published today.
  */
 export const PeriodType = {
   Monthly: "monthly",
-  Quarterly: "quarterly",
   Yearly: "yearly",
 } as const;
 /**
- * Granularity of `period`.
+ * Granularity of `period`. Only monthly periods are published today.
  */
 export type PeriodType = OpenEnum<typeof PeriodType>;
 
 export type CrimeCatalogEntry = {
   /**
-   * Country the entry covers.
+   * Country the entry covers: `england` or `wales`.
    */
   country: string;
   /**
-   * True when this period has been ingested and can be queried.
+   * True when this period has been published and can be queried.
    */
   isAvailable: boolean;
   /**
@@ -36,7 +35,7 @@ export type CrimeCatalogEntry = {
    */
   period: string;
   /**
-   * Granularity of `period`.
+   * Granularity of `period`. Only monthly periods are published today.
    */
   periodType: PeriodType;
 };

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

@@ -13,7 +13,7 @@ export type CrimeCatalogPeriodsByCountry = {
    */
   monthly: Array<string>;
   /**
-   * Yearly periods (`YYYY`) held for the country, most recent first.
+   * Yearly periods (`YYYY`) held for the country, most recent first. Empty today.
    */
   yearly: Array<string>;
 };

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

@@ -8,7 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Interval around `crimeScore`. Null when areas are merged and when no interval was computed.
+ * 95% confidence interval around `crimeScore`, reflecting sampling only. Null when areas are merged and when no interval was computed.
  */
 export type CrimeConfidenceInterval = {
   /**

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

@@ -17,23 +17,27 @@ export type CrimeIncident = {
    */
   coordinates: Array<number | null> | null;
   /**
-   * When the incident was recorded, as an ISO 8601 timestamp.
+   * Month the incident was recorded in, as an ISO 8601 timestamp on the first day of that month. The source publishes incidents by month, not by day.
    */
   crimeDate: string;
   /**
-   * Identifier issued for the incident by the police data source. Null on older records, which were published without one.
+   * Identifier issued for the incident by the police data source. Null for anti-social behaviour, which is published without one.
    */
   crimeId: string | null;
   /**
-   * Location label as published by the data source. It names a street or landmark near the anonymised map point rather than the address the incident happened at.
+   * Location label for the incident. The current data source publishes no location text, so this is null; use `coordinates` to place the incident.
    */
   crimeLocation: string | null;
   /**
-   * Human-readable name for the crime category. Null when the source published none.
+   * Human-readable name for the crime category.
    */
   label: string | null;
   /**
-   * Police force that recorded the incident.
+   * Last recorded outcome for the incident, as published by the police data source. Null for anti-social behaviour and for incidents with no outcome yet.
+   */
+  outcome: string | null;
+  /**
+   * Identifier of the police force that recorded the incident, in lower-case hyphenated form.
    */
   reportedBy: string | null;
 };
@@ -50,6 +54,7 @@ export const CrimeIncident$inboundSchema: z.ZodType<
   crimeId: z.nullable(z.string()),
   crimeLocation: z.nullable(z.string()),
   label: z.nullable(z.string()),
+  outcome: z.nullable(z.string()),
   reportedBy: z.nullable(z.string()),
 });
 

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

@@ -29,7 +29,7 @@ export type CrimeIncidentsListResponseObject = ClosedEnum<
 
 export type CrimeIncidentsListResponse = {
   /**
-   * The crime incidents inside the requested radius and date window, most recent first.
+   * The crime incidents inside the requested radius and date window, most recent month first.
    */
   data: Array<CrimeIncident>;
   /**

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

@@ -13,7 +13,7 @@ export type CrimeIncidentsSummary = {
    */
   byCategory: { [k: string]: number };
   /**
-   * Anchor month for the window, in `YYYY-MM` form. When the request supplies `date` this is that month; otherwise it is the most recent month with significant reporting in the area.
+   * Anchor month for the window, in `YYYY-MM` form. When the request supplies `date` this is that month, or the most recent month with significant reporting in the area if that is earlier; otherwise it is the most recent month with significant reporting in the area.
    */
   period: string;
   /**

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

@@ -11,13 +11,25 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Window length and sample size behind this category's score. Null when areas are merged.
+ * The trailing window behind this category's numbers. Null when areas are merged.
  */
 export type CrimePeriodDetails = {
+  /**
+   * How many months of the window had usable data. Null when not known.
+   */
+  coveredPeriods: number | null;
+  /**
+   * Last month of the window, in `YYYY-MM` form.
+   */
+  end: string;
   /**
    * Number of incidents in the analysis window.
    */
   sampleSize: number;
+  /**
+   * First month of the window, in `YYYY-MM` form.
+   */
+  start: string;
   /**
    * Length of the analysis window, in months.
    */
@@ -32,7 +44,10 @@ export const CrimePeriodDetails$inboundSchema: z.ZodType<
   unknown
 > = collectExtraKeys$(
   z.object({
+    coveredPeriods: z.nullable(z.number()),
+    end: z.string(),
     sampleSize: z.number(),
+    start: z.string(),
     windowMonths: z.number(),
   }).catchall(z.any()),
   "additionalProperties",

package/src/sdk/models/shared/geographyarea.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 GeographyArea = {
+  /**
+   * 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;
+  /**
+   * 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 GeographyArea$inboundSchema: z.ZodType<
+  GeographyArea,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaType: z.string(),
+  code: z.string(),
+  name: z.nullable(z.string()),
+  nation: z.nullable(z.string()),
+  tier: z.nullable(z.string()),
+  vintage: z.nullable(z.string()),
+});
+
+export function geographyAreaFromJSON(
+  jsonString: string,
+): SafeParseResult<GeographyArea, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GeographyArea$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GeographyArea' from JSON`,
+  );
+}

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

@@ -17,45 +17,81 @@ import {
 
 export type GeographyCategoryMetric = {
   /**
-   * Crime category this breakdown covers.
+   * Crime category this breakdown covers. `all` is the composite across every category.
    */
   category: string;
   /**
-   * Interval around `crimeScore`. Null when areas are merged and when no interval was computed.
+   * 95% confidence interval around `crimeScore`, reflecting sampling only. Null when areas are merged and when no interval was computed.
    */
   confidenceInterval: CrimeConfidenceInterval | null;
   /**
-   * Number of incidents in this category for the period.
+   * How many months of the 24-month window had usable data. Null when areas are merged.
+   */
+  coveredPeriods?: number | null | undefined;
+  /**
+   * Number of incidents in this category over the trailing 24-month window ending at the row's period. Not decayed.
    */
   crimeCount: number;
   /**
-   * Incidents in this category per 1,000 residents.
+   * Incidents in this category per 1,000 residents per year over the window. 0 when the row's `dataAvailability` is `missing`.
    */
   crimeRate: number;
   /**
-   * Safety score for this category, from 0 to 100, where higher is safer. Null when areas are merged, because scores cannot be combined across geographies, and when scoring has not run for the period.
+   * Safety score for this category, from 0 to 100, where higher is safer. Each category has its own scale, so scores are not comparable across categories. Null when areas are merged, because scores cannot be combined across geographies, and when the police force did not report. Never treat a null as 0.
    */
   crimeScore: number | null;
   /**
-   * How complete the data behind this row is: `available`, `missing`, `partial`, `estimated` or `insufficient`. Rows for merged areas always report `available`.
+   * 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. Merged rows report `available` only when every merged area is, otherwise `partial`.
    */
   dataAvailability: string;
   /**
-   * Machine-readable codes describing what drives this category's score. They use the same vocabulary as `CrimeMetrics.explanatoryTags`. Null when areas are merged.
+   * Machine-readable codes describing what drives the area's score. They use the same vocabulary as `CrimeMetrics.explanatoryTags`. Only the `all` category carries tags; other categories carry an empty list. Null when areas are merged.
    */
   explanatoryTags: Array<string> | null;
   /**
-   * Where this category's score ranks nationally, from 0 to 100. Null when areas are merged and when the score has not been ranked.
+   * Lower bound of the 80% prediction interval on harm over the next 12 months.
+   */
+  harmLower?: number | null | undefined;
+  /**
+   * Expected harm per 1,000 residents per year, weighting each offence by its severity, with recent months weighted more heavily. Null when areas are merged and when the police force did not report.
+   */
+  harmRate?: number | null | undefined;
+  /**
+   * Upper bound of the 80% prediction interval on harm over the next 12 months.
+   */
+  harmUpper?: number | null | undefined;
+  /**
+   * Where this category's score ranks among areas of the same type in England and Wales for the month, from 0 to 100, where 100 is safest. Null when areas are merged and when fewer than 10 areas could be ranked. Not comparable across area types.
    */
   percentile: number | null;
   /**
-   * Window length and sample size behind this category's score. Null when areas are merged.
+   * The same rank taken within the area's parent local authority. Null for local authorities and above, when areas are merged, and when fewer than 10 areas could be ranked.
+   */
+  percentileLocal?: number | null | undefined;
+  /**
+   * The trailing window behind this category's numbers. Null when areas are merged.
    */
   periodDetails: CrimePeriodDetails | null;
   /**
-   * Direction and size of the change in this category across the window, from -1 to 1. Null when areas are merged and when the score has not been computed.
+   * Direction and size of the change in this category, comparing the most recent year with the year before. Positive values mean crime is falling. Null when areas are merged and when not computed.
    */
   trendFactor: number | null;
+  /**
+   * The trend in words: `improving`, `worsening`, `stable` or `unknown`. Null when areas are merged.
+   */
+  trendLabel?: string | null | undefined;
+  /**
+   * Incidents in the most recent year divided by the year before. Above 1 means crime is rising.
+   */
+  trendRatio?: number | null | undefined;
+  /**
+   * True only when `trendLabel` is `improving` or `worsening`.
+   */
+  trendSignificant?: boolean | undefined;
+  /**
+   * Statistical significance of the year-on-year change, as a z-score.
+   */
+  trendZ?: number | null | undefined;
 };
 
 /** @internal */
@@ -66,14 +102,23 @@ export const GeographyCategoryMetric$inboundSchema: z.ZodType<
 > = z.object({
   category: z.string(),
   confidenceInterval: z.nullable(CrimeConfidenceInterval$inboundSchema),
+  coveredPeriods: z.nullable(z.number()).optional(),
   crimeCount: z.number(),
   crimeRate: z.number(),
   crimeScore: z.nullable(z.number()),
   dataAvailability: z.string(),
   explanatoryTags: z.nullable(z.array(z.string())),
+  harmLower: z.nullable(z.number()).optional(),
+  harmRate: z.nullable(z.number()).optional(),
+  harmUpper: z.nullable(z.number()).optional(),
   percentile: z.nullable(z.number()),
+  percentileLocal: z.nullable(z.number()).optional(),
   periodDetails: z.nullable(CrimePeriodDetails$inboundSchema),
   trendFactor: z.nullable(z.number()),
+  trendLabel: z.nullable(z.string()).optional(),
+  trendRatio: z.nullable(z.number()).optional(),
+  trendSignificant: z.boolean().optional(),
+  trendZ: z.nullable(z.number()).optional(),
 });
 
 export function geographyCategoryMetricFromJSON(

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

@@ -17,19 +17,39 @@ 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`, `local_authority_district`, `county_unitary_authority`, `english_region` or `country_region`. A unitary authority is served as `local_authority_district`. 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;
+  /**
+   * 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 +57,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 +77,18 @@ 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(),
+  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;
   /**