@vepler/sdk 2.57.3 → 2.131.0

package/dist/esm/sdk/models/shared/tierskipreason.d.ts

@@ -0,0 +1,56 @@
+import * as z from "zod/v3";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+/**
+ * Machine-readable skip code so clients can map to UI text.
+ */
+export declare const Code: {
+    readonly NoCoverageForLpa: "no_coverage_for_lpa";
+    readonly NoCoverageForSchool: "no_coverage_for_school";
+    readonly NoPolygonIntersects: "no_polygon_intersects";
+    readonly NoOutcomesInYear: "no_outcomes_in_year";
+    readonly NoFaithJurisdictionForSchool: "no_faith_jurisdiction_for_school";
+    readonly NoFeederLinkResolves: "no_feeder_link_resolves";
+    readonly OutOfMaxDistance: "out_of_max_distance";
+};
+/**
+ * Machine-readable skip code so clients can map to UI text.
+ */
+export type Code = OpenEnum<typeof Code>;
+/**
+ * Match basis tier. 'designated_polygon' (Tier 1, hard): point is inside the LA-published catchment polygon. 'last_admitted_distance' (Tier 2, indicative): property is within last year's furthest admitted-pupil distance. 'faith_jurisdiction' (Tier 3, hard): point is inside a parish/diocese tied to the school's faith criterion. 'feeder_link' (Tier 4, hard): the school is named as a feeder target by another already-matched school. 'distance_ranking' (Tier 5, soft): nearest-N fallback so the result set is never empty.
+ */
+export declare const TierSkipReasonTier: {
+    readonly DesignatedPolygon: "designated_polygon";
+    readonly LastAdmittedDistance: "last_admitted_distance";
+    readonly FaithJurisdiction: "faith_jurisdiction";
+    readonly FeederLink: "feeder_link";
+    readonly DistanceRanking: "distance_ranking";
+};
+/**
+ * Match basis tier. 'designated_polygon' (Tier 1, hard): point is inside the LA-published catchment polygon. 'last_admitted_distance' (Tier 2, indicative): property is within last year's furthest admitted-pupil distance. 'faith_jurisdiction' (Tier 3, hard): point is inside a parish/diocese tied to the school's faith criterion. 'feeder_link' (Tier 4, hard): the school is named as a feeder target by another already-matched school. 'distance_ranking' (Tier 5, soft): nearest-N fallback so the result set is never empty.
+ */
+export type TierSkipReasonTier = OpenEnum<typeof TierSkipReasonTier>;
+export type TierSkipReason = {
+    /**
+     * Machine-readable skip code so clients can map to UI text.
+     */
+    code: Code;
+    /**
+     * Human-readable explanation suitable for end-user display.
+     */
+    reason: string;
+    /**
+     * Match basis tier. 'designated_polygon' (Tier 1, hard): point is inside the LA-published catchment polygon. 'last_admitted_distance' (Tier 2, indicative): property is within last year's furthest admitted-pupil distance. 'faith_jurisdiction' (Tier 3, hard): point is inside a parish/diocese tied to the school's faith criterion. 'feeder_link' (Tier 4, hard): the school is named as a feeder target by another already-matched school. 'distance_ranking' (Tier 5, soft): nearest-N fallback so the result set is never empty.
+     */
+    tier: TierSkipReasonTier;
+};
+/** @internal */
+export declare const Code$inboundSchema: z.ZodType<Code, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const TierSkipReasonTier$inboundSchema: z.ZodType<TierSkipReasonTier, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const TierSkipReason$inboundSchema: z.ZodType<TierSkipReason, z.ZodTypeDef, unknown>;
+export declare function tierSkipReasonFromJSON(jsonString: string): SafeParseResult<TierSkipReason, SDKValidationError>;
+//# sourceMappingURL=tierskipreason.d.ts.map

package/dist/esm/sdk/models/shared/tierskipreason.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tierskipreason.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/tierskipreason.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,IAAI;;;;;;;;CAQP,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;AAEzC;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;CAMrB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAErE,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IACX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CACvC,CAAC;AAEhC,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CACsC,CAAC;AAEhD,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAClD,cAAc,EACd,CAAC,CAAC,UAAU,EACZ,OAAO,CAKP,CAAC;AAEH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAMrD"}

package/dist/esm/sdk/models/shared/tierskipreason.js

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+/**
+ * Machine-readable skip code so clients can map to UI text.
+ */
+export const Code = {
+    NoCoverageForLpa: "no_coverage_for_lpa",
+    NoCoverageForSchool: "no_coverage_for_school",
+    NoPolygonIntersects: "no_polygon_intersects",
+    NoOutcomesInYear: "no_outcomes_in_year",
+    NoFaithJurisdictionForSchool: "no_faith_jurisdiction_for_school",
+    NoFeederLinkResolves: "no_feeder_link_resolves",
+    OutOfMaxDistance: "out_of_max_distance",
+};
+/**
+ * Match basis tier. 'designated_polygon' (Tier 1, hard): point is inside the LA-published catchment polygon. 'last_admitted_distance' (Tier 2, indicative): property is within last year's furthest admitted-pupil distance. 'faith_jurisdiction' (Tier 3, hard): point is inside a parish/diocese tied to the school's faith criterion. 'feeder_link' (Tier 4, hard): the school is named as a feeder target by another already-matched school. 'distance_ranking' (Tier 5, soft): nearest-N fallback so the result set is never empty.
+ */
+export const TierSkipReasonTier = {
+    DesignatedPolygon: "designated_polygon",
+    LastAdmittedDistance: "last_admitted_distance",
+    FaithJurisdiction: "faith_jurisdiction",
+    FeederLink: "feeder_link",
+    DistanceRanking: "distance_ranking",
+};
+/** @internal */
+export const Code$inboundSchema = openEnums.inboundSchema(Code);
+/** @internal */
+export const TierSkipReasonTier$inboundSchema = openEnums.inboundSchema(TierSkipReasonTier);
+/** @internal */
+export const TierSkipReason$inboundSchema = z.object({
+    code: Code$inboundSchema,
+    reason: z.string(),
+    tier: TierSkipReasonTier$inboundSchema,
+});
+export function tierSkipReasonFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => TierSkipReason$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TierSkipReason' from JSON`);
+}
+//# sourceMappingURL=tierskipreason.js.map

package/dist/esm/sdk/models/shared/tierskipreason.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tierskipreason.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/tierskipreason.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAKlD;;GAEG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,gBAAgB,EAAE,qBAAqB;IACvC,mBAAmB,EAAE,wBAAwB;IAC7C,mBAAmB,EAAE,uBAAuB;IAC5C,gBAAgB,EAAE,qBAAqB;IACvC,4BAA4B,EAAE,kCAAkC;IAChE,oBAAoB,EAAE,yBAAyB;IAC/C,gBAAgB,EAAE,qBAAqB;CAC/B,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,iBAAiB,EAAE,oBAAoB;IACvC,oBAAoB,EAAE,wBAAwB;IAC9C,iBAAiB,EAAE,oBAAoB;IACvC,UAAU,EAAE,aAAa;IACzB,eAAe,EAAE,kBAAkB;CAC3B,CAAC;AAqBX,gBAAgB;AAChB,MAAM,CAAC,MAAM,kBAAkB,GAC7B,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;AAEhC,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,SAAS,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;AAEhD,gBAAgB;AAChB,MAAM,CAAC,MAAM,4BAA4B,GAIrC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,kBAAkB;IACxB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,gCAAgC;CACvC,CAAC,CAAC;AAEH,MAAM,UAAU,sBAAsB,CACpC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACxD,4CAA4C,CAC7C,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/titledeeddocumentlistresponse.d.ts

@@ -5,7 +5,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * HMLR document type
  */
-export declare const DocumentType: {
+export declare const TitleDeedDocumentListResponseDocumentType: {
     readonly RegisterExtract: "register-extract";
     readonly OfficialTitle: "official-title";
     readonly TitlePlan: "title-plan";
@@ -13,7 +13,7 @@ export declare const DocumentType: {
 /**
  * HMLR document type
  */
-export type DocumentType = OpenEnum<typeof DocumentType>;
+export type TitleDeedDocumentListResponseDocumentType = OpenEnum<typeof TitleDeedDocumentListResponseDocumentType>;
 /**
  * Document processing status: pending (being processed), uploaded (ready to download), or failed
  */
@@ -34,7 +34,7 @@ export type Documents = {
     /**
      * HMLR document type
      */
-    documentType: DocumentType;
+    documentType: TitleDeedDocumentListResponseDocumentType;
     /**
      * Relative URL for downloading the document (null unless status is uploaded)
      */
@@ -62,7 +62,7 @@ export type TitleDeedDocumentListResponse = {
     titleNumber: string;
 };
 /** @internal */
-export declare const DocumentType$inboundSchema: z.ZodType<DocumentType, z.ZodTypeDef, unknown>;
+export declare const TitleDeedDocumentListResponseDocumentType$inboundSchema: z.ZodType<TitleDeedDocumentListResponseDocumentType, z.ZodTypeDef, unknown>;
 /** @internal */
 export declare const TitleDeedDocumentListResponseStatus$inboundSchema: z.ZodType<TitleDeedDocumentListResponseStatus, z.ZodTypeDef, unknown>;
 /** @internal */

package/dist/esm/sdk/models/shared/titledeeddocumentlistresponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"titledeeddocumentlistresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titledeeddocumentlistresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,YAAY;;;;CAIf,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,YAAY,CAAC,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,mCAAmC;;;;CAItC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,QAAQ,CACxD,OAAO,mCAAmC,CAC3C,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAC3B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,MAAM,EAAE,mCAAmC,CAAC;IAC5C;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF,eAAO,MAAM,mCAAmC;;CAEtC,CAAC;AACX,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAC1D,OAAO,mCAAmC,CAC3C,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAC5B,MAAM,EAAE,mCAAmC,CAAC;IAC5C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CACgC,CAAC;AAE1C,gBAAgB;AAChB,eAAO,MAAM,iDAAiD,EAAE,CAAC,CAAC,OAAO,CACvE,mCAAmC,EACnC,CAAC,CAAC,UAAU,EACZ,OAAO,CACuD,CAAC;AAEjE,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,SAAS,EACT,CAAC,CAAC,UAAU,EACZ,OAAO,CAgBP,CAAC;AAEH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAMhD;AAED,gBAAgB;AAChB,eAAO,MAAM,iDAAiD,EAAE,CAAC,CAAC,aAAa,CAC7E,OAAO,mCAAmC,CACS,CAAC;AAEtD,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,OAAO,CACjE,6BAA6B,EAC7B,CAAC,CAAC,UAAU,EACZ,OAAO,CASP,CAAC;AAEH,wBAAgB,qCAAqC,CACnD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,6BAA6B,EAAE,kBAAkB,CAAC,CAMpE"}
+{"version":3,"file":"titledeeddocumentlistresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titledeeddocumentlistresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,yCAAyC;;;;CAI5C,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,yCAAyC,GAAG,QAAQ,CAC9D,OAAO,yCAAyC,CACjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mCAAmC;;;;CAItC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,QAAQ,CACxD,OAAO,mCAAmC,CAC3C,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,yCAAyC,CAAC;IACxD;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,MAAM,EAAE,mCAAmC,CAAC;IAC5C;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF,eAAO,MAAM,mCAAmC;;CAEtC,CAAC;AACX,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAC1D,OAAO,mCAAmC,CAC3C,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAC5B,MAAM,EAAE,mCAAmC,CAAC;IAC5C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uDAAuD,EAAE,CAAC,CAAC,OAAO,CAC7E,yCAAyC,EACzC,CAAC,CAAC,UAAU,EACZ,OAAO,CAC6D,CAAC;AAEvE,gBAAgB;AAChB,eAAO,MAAM,iDAAiD,EAAE,CAAC,CAAC,OAAO,CACvE,mCAAmC,EACnC,CAAC,CAAC,UAAU,EACZ,OAAO,CACuD,CAAC;AAEjE,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,SAAS,EACT,CAAC,CAAC,UAAU,EACZ,OAAO,CAgBP,CAAC;AAEH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAMhD;AAED,gBAAgB;AAChB,eAAO,MAAM,iDAAiD,EAAE,CAAC,CAAC,aAAa,CAC7E,OAAO,mCAAmC,CACS,CAAC;AAEtD,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,OAAO,CACjE,6BAA6B,EAC7B,CAAC,CAAC,UAAU,EACZ,OAAO,CASP,CAAC;AAEH,wBAAgB,qCAAqC,CACnD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,6BAA6B,EAAE,kBAAkB,CAAC,CAMpE"}

package/dist/esm/sdk/models/shared/titledeeddocumentlistresponse.js

@@ -8,7 +8,7 @@ import * as openEnums from "../../types/enums.js";
 /**
  * HMLR document type
  */
-export const DocumentType = {
+export const TitleDeedDocumentListResponseDocumentType = {
     RegisterExtract: "register-extract",
     OfficialTitle: "official-title",
     TitlePlan: "title-plan",
@@ -25,13 +25,13 @@ export const TitleDeedDocumentListResponseObject = {
     TitleDeedDocumentList: "title_deed_document_list",
 };
 /** @internal */
-export const DocumentType$inboundSchema = openEnums.inboundSchema(DocumentType);
+export const TitleDeedDocumentListResponseDocumentType$inboundSchema = openEnums.inboundSchema(TitleDeedDocumentListResponseDocumentType);
 /** @internal */
 export const TitleDeedDocumentListResponseStatus$inboundSchema = openEnums.inboundSchema(TitleDeedDocumentListResponseStatus);
 /** @internal */
 export const Documents$inboundSchema = z.object({
     content_type: z.string(),
-    document_type: DocumentType$inboundSchema,
+    document_type: TitleDeedDocumentListResponseDocumentType$inboundSchema,
     download_url: z.nullable(z.string()),
     size_bytes: z.nullable(z.number()),
     status: TitleDeedDocumentListResponseStatus$inboundSchema,

package/dist/esm/sdk/models/shared/titledeeddocumentlistresponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"titledeeddocumentlistresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titledeeddocumentlistresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAKlD;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,eAAe,EAAE,kBAAkB;IACnC,aAAa,EAAE,gBAAgB;IAC/B,SAAS,EAAE,YAAY;CACf,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG;IACjD,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;CACR,CAAC;AAmCX,MAAM,CAAC,MAAM,mCAAmC,GAAG;IACjD,qBAAqB,EAAE,0BAA0B;CACzC,CAAC;AAWX,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAInC,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;AAE1C,gBAAgB;AAChB,MAAM,CAAC,MAAM,iDAAiD,GAI1D,SAAS,CAAC,aAAa,CAAC,mCAAmC,CAAC,CAAC;AAEjE,gBAAgB;AAChB,MAAM,CAAC,MAAM,uBAAuB,GAIhC,CAAC,CAAC,MAAM,CAAC;IACX,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,aAAa,EAAE,0BAA0B;IACzC,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACpC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAClC,MAAM,EAAE,iDAAiD;IACzD,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CACpC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;QAC7B,eAAe,EAAE,cAAc;QAC/B,cAAc,EAAE,aAAa;QAC7B,YAAY,EAAE,WAAW;QACzB,aAAa,EAAE,YAAY;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,iBAAiB,CAC/B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,uBAAuB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnD,uCAAuC,CACxC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,iDAAiD,GAE1D,CAAC,CAAC,UAAU,CAAC,mCAAmC,CAAC,CAAC;AAEtD,gBAAgB;AAChB,MAAM,CAAC,MAAM,2CAA2C,GAIpD,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,uBAAuB,CAAC,CAAC;IACzD,MAAM,EAAE,iDAAiD;IACzD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;CACzB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;KAC9B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,qCAAqC,CACnD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,2CAA2C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvE,2DAA2D,CAC5D,CAAC;AACJ,CAAC"}
+{"version":3,"file":"titledeeddocumentlistresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titledeeddocumentlistresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAKlD;;GAEG;AACH,MAAM,CAAC,MAAM,yCAAyC,GAAG;IACvD,eAAe,EAAE,kBAAkB;IACnC,aAAa,EAAE,gBAAgB;IAC/B,SAAS,EAAE,YAAY;CACf,CAAC;AAQX;;GAEG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG;IACjD,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;CACR,CAAC;AAmCX,MAAM,CAAC,MAAM,mCAAmC,GAAG;IACjD,qBAAqB,EAAE,0BAA0B;CACzC,CAAC;AAWX,gBAAgB;AAChB,MAAM,CAAC,MAAM,uDAAuD,GAIhE,SAAS,CAAC,aAAa,CAAC,yCAAyC,CAAC,CAAC;AAEvE,gBAAgB;AAChB,MAAM,CAAC,MAAM,iDAAiD,GAI1D,SAAS,CAAC,aAAa,CAAC,mCAAmC,CAAC,CAAC;AAEjE,gBAAgB;AAChB,MAAM,CAAC,MAAM,uBAAuB,GAIhC,CAAC,CAAC,MAAM,CAAC;IACX,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,aAAa,EAAE,uDAAuD;IACtE,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACpC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAClC,MAAM,EAAE,iDAAiD;IACzD,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CACpC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;QAC7B,eAAe,EAAE,cAAc;QAC/B,cAAc,EAAE,aAAa;QAC7B,YAAY,EAAE,WAAW;QACzB,aAAa,EAAE,YAAY;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,iBAAiB,CAC/B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,uBAAuB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnD,uCAAuC,CACxC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,iDAAiD,GAE1D,CAAC,CAAC,UAAU,CAAC,mCAAmC,CAAC,CAAC;AAEtD,gBAAgB;AAChB,MAAM,CAAC,MAAM,2CAA2C,GAIpD,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,uBAAuB,CAAC,CAAC;IACzD,MAAM,EAAE,iDAAiD;IACzD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;CACzB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;KAC9B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,qCAAqC,CACnD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,2CAA2C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvE,2DAA2D,CAC5D,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/titleextractionpollresponse.d.ts

@@ -0,0 +1,32 @@
+import * as z from "zod/v3";
+import { ClosedEnum, OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { ExtractionPayload } from "./extractionpayload.js";
+export declare const TitleExtractionPollResponseObject: {
+    readonly TitleExtraction: "title_extraction";
+};
+export type TitleExtractionPollResponseObject = ClosedEnum<typeof TitleExtractionPollResponseObject>;
+export declare const TitleExtractionPollResponseStatus: {
+    readonly Pending: "pending";
+    readonly Analysing: "analysing";
+    readonly Complete: "complete";
+    readonly Failed: "failed";
+};
+export type TitleExtractionPollResponseStatus = OpenEnum<typeof TitleExtractionPollResponseStatus>;
+export type TitleExtractionPollResponse = {
+    extraction: ExtractionPayload | null;
+    failureCode: string | null;
+    failureMessage: string | null;
+    object: TitleExtractionPollResponseObject;
+    status: TitleExtractionPollResponseStatus;
+    titleNumber: string;
+};
+/** @internal */
+export declare const TitleExtractionPollResponseObject$inboundSchema: z.ZodNativeEnum<typeof TitleExtractionPollResponseObject>;
+/** @internal */
+export declare const TitleExtractionPollResponseStatus$inboundSchema: z.ZodType<TitleExtractionPollResponseStatus, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const TitleExtractionPollResponse$inboundSchema: z.ZodType<TitleExtractionPollResponse, z.ZodTypeDef, unknown>;
+export declare function titleExtractionPollResponseFromJSON(jsonString: string): SafeParseResult<TitleExtractionPollResponse, SDKValidationError>;
+//# sourceMappingURL=titleextractionpollresponse.d.ts.map

package/dist/esm/sdk/models/shared/titleextractionpollresponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"titleextractionpollresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleextractionpollresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,iBAAiB,EAElB,MAAM,wBAAwB,CAAC;AAEhC,eAAO,MAAM,iCAAiC;;CAEpC,CAAC;AACX,MAAM,MAAM,iCAAiC,GAAG,UAAU,CACxD,OAAO,iCAAiC,CACzC,CAAC;AAEF,eAAO,MAAM,iCAAiC;;;;;CAKpC,CAAC;AACX,MAAM,MAAM,iCAAiC,GAAG,QAAQ,CACtD,OAAO,iCAAiC,CACzC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACrC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,iCAAiC,CAAC;IAC1C,MAAM,EAAE,iCAAiC,CAAC;IAC1C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,+CAA+C,EAAE,CAAC,CAAC,aAAa,CAC3E,OAAO,iCAAiC,CACS,CAAC;AAEpD,gBAAgB;AAChB,eAAO,MAAM,+CAA+C,EAAE,CAAC,CAAC,OAAO,CACrE,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,OAAO,CACqD,CAAC;AAE/D,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,mCAAmC,CACjD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAMlE"}

package/dist/esm/sdk/models/shared/titleextractionpollresponse.js

@@ -0,0 +1,40 @@
+/*
+ * 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 { ExtractionPayload$inboundSchema, } from "./extractionpayload.js";
+export const TitleExtractionPollResponseObject = {
+    TitleExtraction: "title_extraction",
+};
+export const TitleExtractionPollResponseStatus = {
+    Pending: "pending",
+    Analysing: "analysing",
+    Complete: "complete",
+    Failed: "failed",
+};
+/** @internal */
+export const TitleExtractionPollResponseObject$inboundSchema = z.nativeEnum(TitleExtractionPollResponseObject);
+/** @internal */
+export const TitleExtractionPollResponseStatus$inboundSchema = openEnums.inboundSchema(TitleExtractionPollResponseStatus);
+/** @internal */
+export const TitleExtractionPollResponse$inboundSchema = z.object({
+    extraction: z.nullable(ExtractionPayload$inboundSchema),
+    failure_code: z.nullable(z.string()),
+    failure_message: z.nullable(z.string()),
+    object: TitleExtractionPollResponseObject$inboundSchema,
+    status: TitleExtractionPollResponseStatus$inboundSchema,
+    title_number: z.string(),
+}).transform((v) => {
+    return remap$(v, {
+        "failure_code": "failureCode",
+        "failure_message": "failureMessage",
+        "title_number": "titleNumber",
+    });
+});
+export function titleExtractionPollResponseFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => TitleExtractionPollResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TitleExtractionPollResponse' from JSON`);
+}
+//# sourceMappingURL=titleextractionpollresponse.js.map

package/dist/esm/sdk/models/shared/titleextractionpollresponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"titleextractionpollresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleextractionpollresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAIlD,OAAO,EAEL,+BAA+B,GAChC,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,MAAM,iCAAiC,GAAG;IAC/C,eAAe,EAAE,kBAAkB;CAC3B,CAAC;AAKX,MAAM,CAAC,MAAM,iCAAiC,GAAG;IAC/C,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;CACR,CAAC;AAcX,gBAAgB;AAChB,MAAM,CAAC,MAAM,+CAA+C,GAExD,CAAC,CAAC,UAAU,CAAC,iCAAiC,CAAC,CAAC;AAEpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,+CAA+C,GAIxD,SAAS,CAAC,aAAa,CAAC,iCAAiC,CAAC,CAAC;AAE/D,gBAAgB;AAChB,MAAM,CAAC,MAAM,yCAAyC,GAIlD,CAAC,CAAC,MAAM,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IACvD,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACpC,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACvC,MAAM,EAAE,+CAA+C;IACvD,MAAM,EAAE,+CAA+C;IACvD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;CACzB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;QAC7B,iBAAiB,EAAE,gBAAgB;QACnC,cAAc,EAAE,aAAa;KAC9B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,mCAAmC,CACjD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,yCAAyC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrE,yDAAyD,CAC1D,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/safety.d.ts

@@ -3,18 +3,59 @@ import * as operations from "./models/operations/index.js";
 import * as shared from "./models/shared/index.js";
 export declare class Safety extends ClientSDK {
     /**
-     * Get crime data near location
+     * Get crime data catalog entries for a single country
      *
      * @remarks
-     * Retrieve crime incidents within a specified radius of coordinates
+     * Returns every catalog entry for the supplied country, newest period first. Filter by granularity with `periodType=yearly|monthly`.
+     *
+     * Period strings are normalised to public form (`YYYY` for yearly, `YYYY-MM` for monthly).
+     */
+    getCatalogByCountry(request: operations.GetCatalogByCountryRequest, options?: RequestOptions): Promise<shared.CrimeCatalogByCountryResponse>;
+    /**
+     * Get monthly crime category counts within a radius
+     *
+     * @remarks
+     * Aggregated monthly crime counts by category for the area within `radius` metres of `(latitude, longitude)`. Returns up to 12 months of data ending at the most recent month with significant reporting in the area. Months with no significant reporting are omitted.
+     */
+    getCrimeAreaStats(request: operations.GetCrimeAreaStatsRequest, options?: RequestOptions): Promise<shared.MonthlyCategoryStatsListResponse>;
+    /**
+     * Get crime incidents near a point
+     *
+     * @remarks
+     * Retrieve individual crime incidents recorded within `radius` metres of `(latitude, longitude)`. Data is sourced from UK police open data (street-level recorded crime) covering England and Wales. Incident locations are anonymised by the provider to a nearby map point (accurate to ~150m). Data is published monthly with an approximate 2-month lag.
+     *
+     * The response is always clipped to a six-month window. When `date` (YYYY-MM) is supplied, the window anchors at that month (or the most recent month with significant reporting, whichever is sooner). When omitted, the window anchors on the latest significant reporting month for the area.
+     *
+     * Responses are hard-capped — when the cap is hit, `summary.truncated` is `true`; narrow the radius or date window to see the full result.
      */
-    getV1SafetyCrime(request: operations.GetV1SafetyCrimeRequest, options?: RequestOptions): Promise<shared.CrimeDataResponse>;
+    getCrimeIncidents(request: operations.GetCrimeIncidentsRequest, options?: RequestOptions): Promise<shared.CrimeIncidentsListResponse>;
     /**
-     * Get crime statistics for an area
+     * Get per-point monthly crime category counts within a radius
      *
      * @remarks
-     * Retrieve aggregated crime statistics for a specified area
+     * Same time window as `/stats` but groups by the exact anonymised reporting point, so multiple incidents at the same coordinate are returned separately. Useful for rendering heat-map style overlays where each incident point matters.
+     */
+    getCrimePointStats(request: operations.GetCrimePointStatsRequest, options?: RequestOptions): Promise<shared.PointCategoryStatsListResponse>;
+    /**
+     * Get crime metrics for one or more geographic areas
+     *
+     * @remarks
+     * Aggregated crime metrics for one or more geographic codes (LSOA / ward / authority) across one or more periods. Two modes:
+     *
+     * - **Individual areas** (default): one response row per `(geographicCode, period)` combination.
+     * - **Merged areas** (`mergeAreas=true`): one response row per period, with counts and population summed across every requested geography.
+     *
+     * Period selection is either explicit (`periods=YYYY-MM,YYYY-MM`) or by range (`startDate=YYYY-MM` + `endDate=YYYY-MM`); the two modes are mutually exclusive. Each requested period optionally drives a lookback time-series controlled by `months` (default 12). Empty result sets are returned as `data: []` with `total_count: 0` — never a 204.
+     */
+    getGeographyMetrics(request: operations.GetGeographyMetricsRequest, options?: RequestOptions): Promise<shared.GeographyMetricsListResponse>;
+    /**
+     * List crime data availability by country
+     *
+     * @remarks
+     * Returns the set of countries with crime data and, for each, the yearly and monthly periods that have been ingested. Use `GET /v1/safety/catalog/{country}` to get the full per-period catalog rows.
+     *
+     * Period strings are normalised to public form (`YYYY` for yearly, `YYYY-MM` for monthly) so they can be round-tripped into other safety queries without translation.
      */
-    getV1SafetyCrimeStats(request: operations.GetV1SafetyCrimeStatsRequest, options?: RequestOptions): Promise<shared.AreaStatsResponse>;
+    listCatalogCountries(request?: operations.ListCatalogCountriesRequest | undefined, options?: RequestOptions): Promise<shared.CrimeCatalogCountriesResponse>;
 }
 //# sourceMappingURL=safety.d.ts.map

package/dist/esm/sdk/safety.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"safety.d.ts","sourceRoot":"","sources":["../../../src/sdk/safety.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;OAKG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC;IAQpC;;;;;OAKG;IACG,qBAAqB,CACzB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC;CAOrC"}
+{"version":3,"file":"safety.d.ts","sourceRoot":"","sources":["../../../src/sdk/safety.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;OAOG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC;IAQhD;;;;;OAKG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gCAAgC,CAAC;IAQnD;;;;;;;;;OASG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,0BAA0B,CAAC;IAQ7C;;;;;OAKG;IACG,kBAAkB,CACtB,OAAO,EAAE,UAAU,CAAC,yBAAyB,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,8BAA8B,CAAC;IAQjD;;;;;;;;;;OAUG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,4BAA4B,CAAC;IAQ/C;;;;;;;OAOG;IACG,oBAAoB,CACxB,OAAO,CAAC,EAAE,UAAU,CAAC,2BAA2B,GAAG,SAAS,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,6BAA6B,CAAC;CAOjD"}

package/dist/esm/sdk/safety.js

@@ -1,28 +1,81 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
-import { safetyGetV1SafetyCrime } from "../funcs/safetyGetV1SafetyCrime.js";
-import { safetyGetV1SafetyCrimeStats } from "../funcs/safetyGetV1SafetyCrimeStats.js";
+import { safetyGetCatalogByCountry } from "../funcs/safetyGetCatalogByCountry.js";
+import { safetyGetCrimeAreaStats } from "../funcs/safetyGetCrimeAreaStats.js";
+import { safetyGetCrimeIncidents } from "../funcs/safetyGetCrimeIncidents.js";
+import { safetyGetCrimePointStats } from "../funcs/safetyGetCrimePointStats.js";
+import { safetyGetGeographyMetrics } from "../funcs/safetyGetGeographyMetrics.js";
+import { safetyListCatalogCountries } from "../funcs/safetyListCatalogCountries.js";
 import { ClientSDK } from "../lib/sdks.js";
 import { unwrapAsync } from "./types/fp.js";
 export class Safety extends ClientSDK {
     /**
-     * Get crime data near location
+     * Get crime data catalog entries for a single country
      *
      * @remarks
-     * Retrieve crime incidents within a specified radius of coordinates
+     * Returns every catalog entry for the supplied country, newest period first. Filter by granularity with `periodType=yearly|monthly`.
+     *
+     * Period strings are normalised to public form (`YYYY` for yearly, `YYYY-MM` for monthly).
+     */
+    async getCatalogByCountry(request, options) {
+        return unwrapAsync(safetyGetCatalogByCountry(this, request, options));
+    }
+    /**
+     * Get monthly crime category counts within a radius
+     *
+     * @remarks
+     * Aggregated monthly crime counts by category for the area within `radius` metres of `(latitude, longitude)`. Returns up to 12 months of data ending at the most recent month with significant reporting in the area. Months with no significant reporting are omitted.
+     */
+    async getCrimeAreaStats(request, options) {
+        return unwrapAsync(safetyGetCrimeAreaStats(this, request, options));
+    }
+    /**
+     * Get crime incidents near a point
+     *
+     * @remarks
+     * Retrieve individual crime incidents recorded within `radius` metres of `(latitude, longitude)`. Data is sourced from UK police open data (street-level recorded crime) covering England and Wales. Incident locations are anonymised by the provider to a nearby map point (accurate to ~150m). Data is published monthly with an approximate 2-month lag.
+     *
+     * The response is always clipped to a six-month window. When `date` (YYYY-MM) is supplied, the window anchors at that month (or the most recent month with significant reporting, whichever is sooner). When omitted, the window anchors on the latest significant reporting month for the area.
+     *
+     * Responses are hard-capped — when the cap is hit, `summary.truncated` is `true`; narrow the radius or date window to see the full result.
      */
-    async getV1SafetyCrime(request, options) {
-        return unwrapAsync(safetyGetV1SafetyCrime(this, request, options));
+    async getCrimeIncidents(request, options) {
+        return unwrapAsync(safetyGetCrimeIncidents(this, request, options));
     }
     /**
-     * Get crime statistics for an area
+     * Get per-point monthly crime category counts within a radius
      *
      * @remarks
-     * Retrieve aggregated crime statistics for a specified area
+     * Same time window as `/stats` but groups by the exact anonymised reporting point, so multiple incidents at the same coordinate are returned separately. Useful for rendering heat-map style overlays where each incident point matters.
+     */
+    async getCrimePointStats(request, options) {
+        return unwrapAsync(safetyGetCrimePointStats(this, request, options));
+    }
+    /**
+     * Get crime metrics for one or more geographic areas
+     *
+     * @remarks
+     * Aggregated crime metrics for one or more geographic codes (LSOA / ward / authority) across one or more periods. Two modes:
+     *
+     * - **Individual areas** (default): one response row per `(geographicCode, period)` combination.
+     * - **Merged areas** (`mergeAreas=true`): one response row per period, with counts and population summed across every requested geography.
+     *
+     * Period selection is either explicit (`periods=YYYY-MM,YYYY-MM`) or by range (`startDate=YYYY-MM` + `endDate=YYYY-MM`); the two modes are mutually exclusive. Each requested period optionally drives a lookback time-series controlled by `months` (default 12). Empty result sets are returned as `data: []` with `total_count: 0` — never a 204.
+     */
+    async getGeographyMetrics(request, options) {
+        return unwrapAsync(safetyGetGeographyMetrics(this, request, options));
+    }
+    /**
+     * List crime data availability by country
+     *
+     * @remarks
+     * Returns the set of countries with crime data and, for each, the yearly and monthly periods that have been ingested. Use `GET /v1/safety/catalog/{country}` to get the full per-period catalog rows.
+     *
+     * Period strings are normalised to public form (`YYYY` for yearly, `YYYY-MM` for monthly) so they can be round-tripped into other safety queries without translation.
      */
-    async getV1SafetyCrimeStats(request, options) {
-        return unwrapAsync(safetyGetV1SafetyCrimeStats(this, request, options));
+    async listCatalogCountries(request, options) {
+        return unwrapAsync(safetyListCatalogCountries(this, request, options));
     }
 }
 //# sourceMappingURL=safety.js.map

package/dist/esm/sdk/safety.js.map

@@ -1 +1 @@
-{"version":3,"file":"safety.js","sourceRoot":"","sources":["../../../src/sdk/safety.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,sBAAsB,CACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,2BAA2B,CAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"safety.js","sourceRoot":"","sources":["../../../src/sdk/safety.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;OAOG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAA4D,EAC5D,OAAwB;QAExB,OAAO,WAAW,CAAC,0BAA0B,CAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/schools.d.ts

@@ -3,26 +3,26 @@ import * as operations from "./models/operations/index.js";
 import * as shared from "./models/shared/index.js";
 export declare class Schools extends ClientSDK {
     /**
-     * Get school by ID
+     * Autocomplete schools by name
      *
      * @remarks
-     * Retrieve a single school by its internal ID
+     * Type-ahead lookup over the school name. Combines a fast prefix match with a trigram similarity fallback so common typos still surface results. Cached for 1h per (query, onlyOpen) tuple.
      */
-    get(request: operations.GetSchoolByIdRequest, options?: RequestOptions): Promise<shared.School>;
+    autocomplete(request: operations.AutocompleteSchoolsRequest, options?: RequestOptions): Promise<operations.AutocompleteSchoolsResponseBody>;
     /**
-     * Get school by slug
+     * Compare metrics across schools
      *
      * @remarks
-     * Retrieve a single school by its URL slug
+     * Build a side-by-side comparison matrix of metric values for 2–50 schools across one or more metric codes. Defaults to the current academic year and the 'all' cohort.
      */
-    getBySlug(request: operations.GetSchoolBySlugRequest, options?: RequestOptions): Promise<shared.School>;
+    compareMetrics(request?: shared.MetricsCompareRequest | undefined, options?: RequestOptions): Promise<operations.CompareSchoolMetricsResponseBody>;
     /**
-     * Get school by URN
+     * Aggregate a metric across geography
      *
      * @remarks
-     * Retrieve a single school by its Unique Reference Number
+     * Aggregate a single metric across local authorities, regions, or nationally. Optional `schoolTypes` filter (comma-separated) limits the contributing schools. Capped at 1000 area rows.
      */
-    getByUrn(request: operations.GetSchoolByUrnRequest, options?: RequestOptions): Promise<shared.School>;
+    getGeographicAggregation(request: operations.GetGeographicMetricAggregationRequest, options?: RequestOptions): Promise<operations.GetGeographicMetricAggregationResponseBody>;
     /**
      * Get school metrics
      *
@@ -31,12 +31,19 @@ export declare class Schools extends ClientSDK {
      */
     getMetrics(request: operations.GetSchoolMetricsRequest, options?: RequestOptions): Promise<operations.GetSchoolMetricsResponseBody>;
     /**
-     * List schools
+     * Get school by id
      *
      * @remarks
-     * Retrieve a paginated list of schools with filtering and field selection
+     * Retrieve a single school by its internal identifier.
      */
-    list(request?: operations.ListSchoolsRequest | undefined, options?: RequestOptions): Promise<operations.ListSchoolsResponseBody>;
+    getSchoolById(request: operations.GetSchoolByIdRequest, options?: RequestOptions): Promise<operations.GetSchoolByIdResponseBody>;
+    /**
+     * Get school by provider and key
+     *
+     * @remarks
+     * Retrieve a single school by its source register identifier. Provider codes: `dfe` (England + Wales URNs), `welshgov` (Wales School Number), `seed` (Scottish SEED), `deni` (NI DE Reference), `dept_edu_ie` (Irish Roll Number).
+     */
+    getSchoolBySource(request: operations.GetSchoolBySourceRequest, options?: RequestOptions): Promise<operations.GetSchoolBySourceResponseBody>;
     /**
      * List metric profiles
      *
@@ -45,18 +52,20 @@ export declare class Schools extends ClientSDK {
      */
     listProfiles(options?: RequestOptions): Promise<operations.GetMetricProfilesResponseBody>;
     /**
-     * Search schools near location
+     * Query schools with filters and optional catchment enrichment
      *
      * @remarks
-     * Find schools within a specified radius of a geographic point
+     * Search for schools by country/region, type, status, rating, authority, postcode, free-text, or geography (radius via `near` or bounding box via `within`). Supports pagination via `limit`/`offset` and ordering via `orderBy`/`order`.
+     *
+     * **Catchment enrichment.** Set `catchmentReference` (with either `uprn` or `point`) to embed a five-tier catchment match per school. Each school gains an inline `catchment` block (`matchBasis` + `verdict`) and the response gains a `meta.catchment` block describing which tiers were applied / skipped and any coverage warnings. When `catchmentReference` is supplied with `uprn` but no `near` or `within`, the server defaults `near` to the property point with a 10 km radius.
      */
-    searchNearby(request: operations.SearchSchoolsNearbyRequest, options?: RequestOptions): Promise<operations.SearchSchoolsNearbyResponseBody>;
+    querySchools(request?: operations.QuerySchoolsRequestBody | undefined, options?: RequestOptions): Promise<operations.QuerySchoolsResponseBody>;
     /**
-     * Search schools within bounds
+     * Batch fetch schools by provider keys
      *
      * @remarks
-     * Find schools within a geographic bounding box
+     * Retrieve multiple schools from a single source register by their provider-scoped keys. Maximum 500 keys per request. Keys that do not match are silently omitted.
      */
-    searchWithin(request: operations.SearchSchoolsWithinRequest, options?: RequestOptions): Promise<operations.SearchSchoolsWithinResponseBody>;
+    querySchoolsBySource(request?: operations.QuerySchoolsBySourceRequestBody | undefined, options?: RequestOptions): Promise<operations.QuerySchoolsBySourceResponseBody>;
 }
 //# sourceMappingURL=schools.d.ts.map

package/dist/esm/sdk/schools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schools.d.ts","sourceRoot":"","sources":["../../../src/sdk/schools.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,OAAQ,SAAQ,SAAS;IACpC;;;;;OAKG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;IAQzB;;;;;OAKG;IACG,SAAS,CACb,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;IAQzB;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;IAQzB;;;;;OAKG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAQnD;;;;;OAKG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,UAAU,CAAC,kBAAkB,GAAG,SAAS,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAQ9C;;;;;OAKG;IACG,YAAY,CAChB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAOpD;;;;;OAKG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+BAA+B,CAAC;IAQtD;;;;;OAKG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+BAA+B,CAAC;CAOvD"}
+{"version":3,"file":"schools.d.ts","sourceRoot":"","sources":["../../../src/sdk/schools.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,OAAQ,SAAQ,SAAS;IACpC;;;;;OAKG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,+BAA+B,CAAC;IAQtD;;;;;OAKG;IACG,cAAc,CAClB,OAAO,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,SAAS,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gCAAgC,CAAC;IAQvD;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,qCAAqC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,0CAA0C,CAAC;IAQjE;;;;;OAKG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAQnD;;;;;OAKG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAQhD;;;;;OAKG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAQpD;;;;;OAKG;IACG,YAAY,CAChB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAOpD;;;;;;;OAOG;IACG,YAAY,CAChB,OAAO,CAAC,EAAE,UAAU,CAAC,uBAAuB,GAAG,SAAS,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAQ/C;;;;;OAKG;IACG,oBAAoB,CACxB,OAAO,CAAC,EAAE,UAAU,CAAC,+BAA+B,GAAG,SAAS,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gCAAgC,CAAC;CAOxD"}