@vepler/sdk 2.131.2 → 2.137.0

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

@@ -0,0 +1,84 @@
+import * as z from "zod/v3";
+import { OpenEnum } from "../../types/enums.js";
+/**
+ * Identifies a country × publishing authority × domain combination. Use to look up metric definitions via `/v1/schools/frameworks/{framework}`. Naming convention: `{country}_{authority}_{domain}`.
+ *
+ * @remarks
+ *
+ * Supported values:
+ *
+ * - `gb_eng_dfes_ks2` — England DfE Key Stage 2 performance — end-of-primary outcomes at age 11. Metrics include `PTRWM_EXP` (% at expected standard in reading/writing/maths combined) and progress scores `PROG_READ`/`PROG_WRIT`/`PROG_MAT`. Annual cadence.
+ * - `gb_eng_dfes_ks4` — England DfE Key Stage 4 performance — GCSE-stage outcomes at age 16. Metrics include `ATT8` (Attainment 8), `EBACCAPS` (EBacc Average Point Score), `P8MEA` (Progress 8). Annual cadence.
+ * - `gb_eng_dfes_ks5` — England DfE Key Stage 5 performance — post-16 outcomes for A-level, AS, technical and applied qualifications. Annual cadence.
+ * - `gb_eng_dfes_destinations_ks4` — England DfE post-KS4 destinations — education / apprenticeship / employment / NEET tracking for year-11 leavers, two-year lag.
+ * - `gb_eng_dfes_destinations_ks5` — England DfE post-KS5 destinations — higher-education entry, apprenticeships, employment for year-13 leavers.
+ * - `gb_eng_dfes_value_added` — England DfE KS5 value-added measures — by qualification and by subject.
+ * - `gb_eng_dfes_school_census` — England DfE School Census (Schools, Pupils and their Characteristics — SPC). Annual headcount + FSM + EAL + SEN by school.
+ * - `gb_eng_esfa_cfr` — England ESFA Consistent Financial Reporting — for maintained / local-authority schools. Annual income / expenditure / balances.
+ * - `gb_eng_esfa_aar` — England ESFA Academies Accounts Return — for academies, free schools and UTCs. Annual finance including trust central-services apportionment.
+ * - `gb_eng_lpa_admissions` — England local-authority published admissions outcomes — published-admission-number (PAN), preferences received, offers made, last-admitted distance, oversubscription criteria with offer counts. Cycle-keyed.
+ * - `gb_eng_ofsted_oeif` — England Ofsted Education Inspection Framework — pre-September-2025 inspection regime. Six numeric sub-judgements (1 outstanding..4 inadequate) plus optional early-years and sixth-form provision grades.
+ * - `gb_eng_ofsted_post_2025` — England Ofsted post-September-2025 reformed inspection — evaluation areas (1-5 ordinals) plus a special `safeguarding_grade` sentinel.
+ * - `gb_wls_welshgov_performance` — Wales Welsh Government performance data — scaffolded for future ingest; not currently populated.
+ * - `gb_wls_estyn_inspections` — Wales Estyn inspections — scaffolded for future ingest; not currently populated.
+ * - `gb_sct_education_scotland_performance` — Scotland Education Scotland performance — scaffolded for future ingest; not currently populated.
+ * - `gb_sct_hmie_inspections` — Scotland HMIE / Education Scotland inspections — scaffolded for future ingest; not currently populated.
+ * - `gb_nir_deni_performance` — Northern Ireland Department of Education performance — scaffolded for future ingest; not currently populated.
+ * - `gb_nir_eti_inspections` — Northern Ireland Education and Training Inspectorate (ETI) — scaffolded for future ingest; not currently populated.
+ * - `ie_doe_performance` — Ireland Department of Education performance — scaffolded for future ingest; not currently populated.
+ * - `ie_doe_inspections` — Ireland Department of Education inspections — scaffolded for future ingest; not currently populated.
+ */
+export declare const SchoolFrameworkCode: {
+    readonly GbEngDfesKs2: "gb_eng_dfes_ks2";
+    readonly GbEngDfesKs4: "gb_eng_dfes_ks4";
+    readonly GbEngDfesKs5: "gb_eng_dfes_ks5";
+    readonly GbEngDfesDestinationsKs4: "gb_eng_dfes_destinations_ks4";
+    readonly GbEngDfesDestinationsKs5: "gb_eng_dfes_destinations_ks5";
+    readonly GbEngDfesValueAdded: "gb_eng_dfes_value_added";
+    readonly GbEngDfesSchoolCensus: "gb_eng_dfes_school_census";
+    readonly GbEngEsfaCfr: "gb_eng_esfa_cfr";
+    readonly GbEngEsfaAar: "gb_eng_esfa_aar";
+    readonly GbEngLpaAdmissions: "gb_eng_lpa_admissions";
+    readonly GbEngOfstedOeif: "gb_eng_ofsted_oeif";
+    readonly GbEngOfstedPost2025: "gb_eng_ofsted_post_2025";
+    readonly GbWlsWelshgovPerformance: "gb_wls_welshgov_performance";
+    readonly GbWlsEstynInspections: "gb_wls_estyn_inspections";
+    readonly GbSctEducationScotlandPerformance: "gb_sct_education_scotland_performance";
+    readonly GbSctHmieInspections: "gb_sct_hmie_inspections";
+    readonly GbNirDeniPerformance: "gb_nir_deni_performance";
+    readonly GbNirEtiInspections: "gb_nir_eti_inspections";
+    readonly IeDoePerformance: "ie_doe_performance";
+    readonly IeDoeInspections: "ie_doe_inspections";
+};
+/**
+ * Identifies a country × publishing authority × domain combination. Use to look up metric definitions via `/v1/schools/frameworks/{framework}`. Naming convention: `{country}_{authority}_{domain}`.
+ *
+ * @remarks
+ *
+ * Supported values:
+ *
+ * - `gb_eng_dfes_ks2` — England DfE Key Stage 2 performance — end-of-primary outcomes at age 11. Metrics include `PTRWM_EXP` (% at expected standard in reading/writing/maths combined) and progress scores `PROG_READ`/`PROG_WRIT`/`PROG_MAT`. Annual cadence.
+ * - `gb_eng_dfes_ks4` — England DfE Key Stage 4 performance — GCSE-stage outcomes at age 16. Metrics include `ATT8` (Attainment 8), `EBACCAPS` (EBacc Average Point Score), `P8MEA` (Progress 8). Annual cadence.
+ * - `gb_eng_dfes_ks5` — England DfE Key Stage 5 performance — post-16 outcomes for A-level, AS, technical and applied qualifications. Annual cadence.
+ * - `gb_eng_dfes_destinations_ks4` — England DfE post-KS4 destinations — education / apprenticeship / employment / NEET tracking for year-11 leavers, two-year lag.
+ * - `gb_eng_dfes_destinations_ks5` — England DfE post-KS5 destinations — higher-education entry, apprenticeships, employment for year-13 leavers.
+ * - `gb_eng_dfes_value_added` — England DfE KS5 value-added measures — by qualification and by subject.
+ * - `gb_eng_dfes_school_census` — England DfE School Census (Schools, Pupils and their Characteristics — SPC). Annual headcount + FSM + EAL + SEN by school.
+ * - `gb_eng_esfa_cfr` — England ESFA Consistent Financial Reporting — for maintained / local-authority schools. Annual income / expenditure / balances.
+ * - `gb_eng_esfa_aar` — England ESFA Academies Accounts Return — for academies, free schools and UTCs. Annual finance including trust central-services apportionment.
+ * - `gb_eng_lpa_admissions` — England local-authority published admissions outcomes — published-admission-number (PAN), preferences received, offers made, last-admitted distance, oversubscription criteria with offer counts. Cycle-keyed.
+ * - `gb_eng_ofsted_oeif` — England Ofsted Education Inspection Framework — pre-September-2025 inspection regime. Six numeric sub-judgements (1 outstanding..4 inadequate) plus optional early-years and sixth-form provision grades.
+ * - `gb_eng_ofsted_post_2025` — England Ofsted post-September-2025 reformed inspection — evaluation areas (1-5 ordinals) plus a special `safeguarding_grade` sentinel.
+ * - `gb_wls_welshgov_performance` — Wales Welsh Government performance data — scaffolded for future ingest; not currently populated.
+ * - `gb_wls_estyn_inspections` — Wales Estyn inspections — scaffolded for future ingest; not currently populated.
+ * - `gb_sct_education_scotland_performance` — Scotland Education Scotland performance — scaffolded for future ingest; not currently populated.
+ * - `gb_sct_hmie_inspections` — Scotland HMIE / Education Scotland inspections — scaffolded for future ingest; not currently populated.
+ * - `gb_nir_deni_performance` — Northern Ireland Department of Education performance — scaffolded for future ingest; not currently populated.
+ * - `gb_nir_eti_inspections` — Northern Ireland Education and Training Inspectorate (ETI) — scaffolded for future ingest; not currently populated.
+ * - `ie_doe_performance` — Ireland Department of Education performance — scaffolded for future ingest; not currently populated.
+ * - `ie_doe_inspections` — Ireland Department of Education inspections — scaffolded for future ingest; not currently populated.
+ */
+export type SchoolFrameworkCode = OpenEnum<typeof SchoolFrameworkCode>;
+/** @internal */
+export declare const SchoolFrameworkCode$inboundSchema: z.ZodType<SchoolFrameworkCode, z.ZodTypeDef, unknown>;
+//# sourceMappingURL=schoolframeworkcode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schoolframeworkcode.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolframeworkcode.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;CAqBtB,CAAC;AACX;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEvE,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CACuC,CAAC"}

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

@@ -0,0 +1,57 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as openEnums from "../../types/enums.js";
+/**
+ * Identifies a country × publishing authority × domain combination. Use to look up metric definitions via `/v1/schools/frameworks/{framework}`. Naming convention: `{country}_{authority}_{domain}`.
+ *
+ * @remarks
+ *
+ * Supported values:
+ *
+ * - `gb_eng_dfes_ks2` — England DfE Key Stage 2 performance — end-of-primary outcomes at age 11. Metrics include `PTRWM_EXP` (% at expected standard in reading/writing/maths combined) and progress scores `PROG_READ`/`PROG_WRIT`/`PROG_MAT`. Annual cadence.
+ * - `gb_eng_dfes_ks4` — England DfE Key Stage 4 performance — GCSE-stage outcomes at age 16. Metrics include `ATT8` (Attainment 8), `EBACCAPS` (EBacc Average Point Score), `P8MEA` (Progress 8). Annual cadence.
+ * - `gb_eng_dfes_ks5` — England DfE Key Stage 5 performance — post-16 outcomes for A-level, AS, technical and applied qualifications. Annual cadence.
+ * - `gb_eng_dfes_destinations_ks4` — England DfE post-KS4 destinations — education / apprenticeship / employment / NEET tracking for year-11 leavers, two-year lag.
+ * - `gb_eng_dfes_destinations_ks5` — England DfE post-KS5 destinations — higher-education entry, apprenticeships, employment for year-13 leavers.
+ * - `gb_eng_dfes_value_added` — England DfE KS5 value-added measures — by qualification and by subject.
+ * - `gb_eng_dfes_school_census` — England DfE School Census (Schools, Pupils and their Characteristics — SPC). Annual headcount + FSM + EAL + SEN by school.
+ * - `gb_eng_esfa_cfr` — England ESFA Consistent Financial Reporting — for maintained / local-authority schools. Annual income / expenditure / balances.
+ * - `gb_eng_esfa_aar` — England ESFA Academies Accounts Return — for academies, free schools and UTCs. Annual finance including trust central-services apportionment.
+ * - `gb_eng_lpa_admissions` — England local-authority published admissions outcomes — published-admission-number (PAN), preferences received, offers made, last-admitted distance, oversubscription criteria with offer counts. Cycle-keyed.
+ * - `gb_eng_ofsted_oeif` — England Ofsted Education Inspection Framework — pre-September-2025 inspection regime. Six numeric sub-judgements (1 outstanding..4 inadequate) plus optional early-years and sixth-form provision grades.
+ * - `gb_eng_ofsted_post_2025` — England Ofsted post-September-2025 reformed inspection — evaluation areas (1-5 ordinals) plus a special `safeguarding_grade` sentinel.
+ * - `gb_wls_welshgov_performance` — Wales Welsh Government performance data — scaffolded for future ingest; not currently populated.
+ * - `gb_wls_estyn_inspections` — Wales Estyn inspections — scaffolded for future ingest; not currently populated.
+ * - `gb_sct_education_scotland_performance` — Scotland Education Scotland performance — scaffolded for future ingest; not currently populated.
+ * - `gb_sct_hmie_inspections` — Scotland HMIE / Education Scotland inspections — scaffolded for future ingest; not currently populated.
+ * - `gb_nir_deni_performance` — Northern Ireland Department of Education performance — scaffolded for future ingest; not currently populated.
+ * - `gb_nir_eti_inspections` — Northern Ireland Education and Training Inspectorate (ETI) — scaffolded for future ingest; not currently populated.
+ * - `ie_doe_performance` — Ireland Department of Education performance — scaffolded for future ingest; not currently populated.
+ * - `ie_doe_inspections` — Ireland Department of Education inspections — scaffolded for future ingest; not currently populated.
+ */
+export const SchoolFrameworkCode = {
+    GbEngDfesKs2: "gb_eng_dfes_ks2",
+    GbEngDfesKs4: "gb_eng_dfes_ks4",
+    GbEngDfesKs5: "gb_eng_dfes_ks5",
+    GbEngDfesDestinationsKs4: "gb_eng_dfes_destinations_ks4",
+    GbEngDfesDestinationsKs5: "gb_eng_dfes_destinations_ks5",
+    GbEngDfesValueAdded: "gb_eng_dfes_value_added",
+    GbEngDfesSchoolCensus: "gb_eng_dfes_school_census",
+    GbEngEsfaCfr: "gb_eng_esfa_cfr",
+    GbEngEsfaAar: "gb_eng_esfa_aar",
+    GbEngLpaAdmissions: "gb_eng_lpa_admissions",
+    GbEngOfstedOeif: "gb_eng_ofsted_oeif",
+    GbEngOfstedPost2025: "gb_eng_ofsted_post_2025",
+    GbWlsWelshgovPerformance: "gb_wls_welshgov_performance",
+    GbWlsEstynInspections: "gb_wls_estyn_inspections",
+    GbSctEducationScotlandPerformance: "gb_sct_education_scotland_performance",
+    GbSctHmieInspections: "gb_sct_hmie_inspections",
+    GbNirDeniPerformance: "gb_nir_deni_performance",
+    GbNirEtiInspections: "gb_nir_eti_inspections",
+    IeDoePerformance: "ie_doe_performance",
+    IeDoeInspections: "ie_doe_inspections",
+};
+/** @internal */
+export const SchoolFrameworkCode$inboundSchema = openEnums.inboundSchema(SchoolFrameworkCode);
+//# sourceMappingURL=schoolframeworkcode.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schoolframeworkcode.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolframeworkcode.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAGlD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,YAAY,EAAE,iBAAiB;IAC/B,YAAY,EAAE,iBAAiB;IAC/B,YAAY,EAAE,iBAAiB;IAC/B,wBAAwB,EAAE,8BAA8B;IACxD,wBAAwB,EAAE,8BAA8B;IACxD,mBAAmB,EAAE,yBAAyB;IAC9C,qBAAqB,EAAE,2BAA2B;IAClD,YAAY,EAAE,iBAAiB;IAC/B,YAAY,EAAE,iBAAiB;IAC/B,kBAAkB,EAAE,uBAAuB;IAC3C,eAAe,EAAE,oBAAoB;IACrC,mBAAmB,EAAE,yBAAyB;IAC9C,wBAAwB,EAAE,6BAA6B;IACvD,qBAAqB,EAAE,0BAA0B;IACjD,iCAAiC,EAAE,uCAAuC;IAC1E,oBAAoB,EAAE,yBAAyB;IAC/C,oBAAoB,EAAE,yBAAyB;IAC/C,mBAAmB,EAAE,wBAAwB;IAC7C,gBAAgB,EAAE,oBAAoB;IACtC,gBAAgB,EAAE,oBAAoB;CAC9B,CAAC;AA+BX,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,SAAS,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC"}

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

@@ -41,7 +41,7 @@ export type SchoolMatchBasis = {
      * Tier-shaped detail object — keys depend on tier (polygon_id, last_admitted_distance_m, parish name, etc.).
      */
     detail: {
-        [k: string]: any | null;
+        [k: string]: any;
     };
     /**
      * Provenance URL for this basis (e.g. LA polygon source).

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

@@ -1 +1 @@
-{"version":3,"file":"schoolmatchbasis.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolmatchbasis.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,0BAA0B;;;;CAI7B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,QAAQ,CAC/C,OAAO,0BAA0B,CAClC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;CAMvB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEzE,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,UAAU,EAAE,0BAA0B,CAAC;IACvC;;OAEG;IACH,MAAM,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,IAAI,CAAA;KAAE,CAAC;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;CAC5B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAC9D,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,OAAO,CAC8C,CAAC;AAExD,gBAAgB;AAChB,eAAO,MAAM,kCAAkC,EAAE,CAAC,CAAC,OAAO,CACxD,oBAAoB,EACpB,CAAC,CAAC,UAAU,EACZ,OAAO,CACwC,CAAC;AAElD,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD"}
+{"version":3,"file":"schoolmatchbasis.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolmatchbasis.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,0BAA0B;;;;CAI7B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,QAAQ,CAC/C,OAAO,0BAA0B,CAClC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;CAMvB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEzE,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,UAAU,EAAE,0BAA0B,CAAC;IACvC;;OAEG;IACH,MAAM,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;CAC5B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAC9D,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,OAAO,CAC8C,CAAC;AAExD,gBAAgB;AAChB,eAAO,MAAM,kCAAkC,EAAE,CAAC,CAAC,OAAO,CACxD,oBAAoB,EACpB,CAAC,CAAC,UAAU,EACZ,OAAO,CACwC,CAAC;AAElD,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD"}

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

@@ -30,7 +30,7 @@ export const SchoolMatchBasisTier$inboundSchema = openEnums.inboundSchema(School
 export const SchoolMatchBasis$inboundSchema = z.object({
     asOfYear: z.string().optional(),
     confidence: SchoolMatchBasisConfidence$inboundSchema,
-    detail: z.record(z.nullable(z.any())),
+    detail: z.record(z.any()),
     sourceUrl: z.string().optional(),
     tier: SchoolMatchBasisTier$inboundSchema,
 });

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

@@ -1 +1 @@
-{"version":3,"file":"schoolmatchbasis.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolmatchbasis.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,0BAA0B,GAAG;IACxC,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;CACJ,CAAC;AAQX;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,iBAAiB,EAAE,oBAAoB;IACvC,oBAAoB,EAAE,wBAAwB;IAC9C,iBAAiB,EAAE,oBAAoB;IACvC,UAAU,EAAE,aAAa;IACzB,eAAe,EAAE,kBAAkB;CAC3B,CAAC;AA6BX,gBAAgB;AAChB,MAAM,CAAC,MAAM,wCAAwC,GAIjD,SAAS,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAAC;AAExD,gBAAgB;AAChB,MAAM,CAAC,MAAM,kCAAkC,GAI3C,SAAS,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;AAElD,gBAAgB;AAChB,MAAM,CAAC,MAAM,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,wCAAwC;IACpD,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;IACrC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,IAAI,EAAE,kCAAkC;CACzC,CAAC,CAAC;AAEH,MAAM,UAAU,wBAAwB,CACtC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8BAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC"}
+{"version":3,"file":"schoolmatchbasis.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/schoolmatchbasis.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,0BAA0B,GAAG;IACxC,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;CACJ,CAAC;AAQX;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,iBAAiB,EAAE,oBAAoB;IACvC,oBAAoB,EAAE,wBAAwB;IAC9C,iBAAiB,EAAE,oBAAoB;IACvC,UAAU,EAAE,aAAa;IACzB,eAAe,EAAE,kBAAkB;CAC3B,CAAC;AA6BX,gBAAgB;AAChB,MAAM,CAAC,MAAM,wCAAwC,GAIjD,SAAS,CAAC,aAAa,CAAC,0BAA0B,CAAC,CAAC;AAExD,gBAAgB;AAChB,MAAM,CAAC,MAAM,kCAAkC,GAI3C,SAAS,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;AAElD,gBAAgB;AAChB,MAAM,CAAC,MAAM,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,wCAAwC;IACpD,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;IACzB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,IAAI,EAAE,kCAAkC;CACzC,CAAC,CAAC;AAEH,MAAM,UAAU,wBAAwB,CACtC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8BAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC"}

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

@@ -69,7 +69,7 @@ export type SearchResult = {
      * Additional result-specific metadata (varies by result type)
      */
     metadata?: {
-        [k: string]: any | null;
+        [k: string]: any;
     } | undefined;
     /**
      * URL path to view full details

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

@@ -1 +1 @@
-{"version":3,"file":"searchresult.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/searchresult.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,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;AACrE,OAAO,EACL,gBAAgB,EAEjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,eAAe,EAEhB,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM;;;CAGT,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,MAAM,CAAC,CAAC;AAE7C,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,QAAQ,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAC/C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,yBAAyB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC;IAChE;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC;IACxD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,IAAI,CAAA;KAAE,GAAG,SAAS,CAAC;IACnD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,uBAAuB,EACvB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,+BAA+B,CAC7C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAM9D;AAED,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CACzC,CAAC;AAElC,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CA6BP,CAAC;AAEH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAMnD"}
+{"version":3,"file":"searchresult.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/searchresult.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,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;AACrE,OAAO,EACL,gBAAgB,EAEjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,eAAe,EAEhB,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM;;;CAGT,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,MAAM,CAAC,CAAC;AAE7C,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,QAAQ,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAC/C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,yBAAyB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC;IAChE;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC;IACxD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,uBAAuB,EACvB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,+BAA+B,CAC7C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAM9D;AAED,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CACzC,CAAC;AAElC,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CA6BP,CAAC;AAEH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAMnD"}

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

@@ -36,7 +36,7 @@ export const SearchResult$inboundSchema = z.object({
     main_text_matched_substrings: z.array(MatchedSubstring$inboundSchema)
         .optional(),
     matched_substrings: z.array(MatchedSubstring$inboundSchema).optional(),
-    metadata: z.record(z.nullable(z.any())).optional(),
+    metadata: z.record(z.any()).optional(),
     path: z.string().optional(),
     postcode: z.string().optional(),
     relevanceScore: z.number(),

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

@@ -1 +1 @@
-{"version":3,"file":"searchresult.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/searchresult.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,8BAA8B,GAC/B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAEL,6BAA6B,GAC9B,MAAM,sBAAsB,CAAC;AAgB9B;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAqFX,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAI9C,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,MAAM,UAAU,+BAA+B,CAC7C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qCAAqC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjE,qDAAqD,CACtD,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAC/B,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;AAElC,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAInC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC,QAAQ,EAAE;IAC7D,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,qCAAqC,CAAC,CAAC,QAAQ,EAAE;IACxE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,4BAA4B,EAAE,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC;SAClE,QAAQ,EAAE;IACb,kBAAkB,EAAE,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,QAAQ,EAAE;IACtE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAClD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,oBAAoB;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,WAAW,EAAE,UAAU;QACvB,8BAA8B,EAAE,2BAA2B;QAC3D,oBAAoB,EAAE,mBAAmB;QACzC,gBAAgB,EAAE,eAAe;KAClC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,oBAAoB,CAClC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,0BAA0B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtD,0CAA0C,CAC3C,CAAC;AACJ,CAAC"}
+{"version":3,"file":"searchresult.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/searchresult.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,8BAA8B,GAC/B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAEL,6BAA6B,GAC9B,MAAM,sBAAsB,CAAC;AAgB9B;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAqFX,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAI9C,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,MAAM,UAAU,+BAA+B,CAC7C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qCAAqC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjE,qDAAqD,CACtD,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAC/B,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;AAElC,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAInC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC,QAAQ,EAAE;IAC7D,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,qCAAqC,CAAC,CAAC,QAAQ,EAAE;IACxE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,4BAA4B,EAAE,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC;SAClE,QAAQ,EAAE;IACb,kBAAkB,EAAE,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,QAAQ,EAAE;IACtE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,oBAAoB;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,WAAW,EAAE,UAAU;QACvB,8BAA8B,EAAE,2BAA2B;QAC3D,oBAAoB,EAAE,mBAAmB;QACzC,gBAAgB,EAAE,eAAe;KAClC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,oBAAoB,CAClC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,0BAA0B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtD,0CAA0C,CAC3C,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,121 @@
+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 { TransactionAddress } from "./transactionaddress.js";
+import { TransactionLocation } from "./transactionlocation.js";
+import { TransactionPrice } from "./transactionprice.js";
+/**
+ * Transaction kind. 'sale': a completed sale/transfer. 'lease_grant': the grant of a new lease (premium).
+ */
+export declare const TransactionKind: {
+    readonly Sale: "sale";
+    readonly LeaseGrant: "lease_grant";
+};
+/**
+ * Transaction kind. 'sale': a completed sale/transfer. 'lease_grant': the grant of a new lease (premium).
+ */
+export type TransactionKind = OpenEnum<typeof TransactionKind>;
+/**
+ * Lease detail; present only when kind is 'lease_grant'.
+ */
+export type TransactionLease = {
+    /**
+     * Lease commencement date, where derivable.
+     */
+    startDate?: Date | null | undefined;
+    /**
+     * Lease term verbatim from the register (e.g. '125 years from 11 February 2004').
+     */
+    termText: string | null;
+    /**
+     * Parsed lease length in years, where derivable.
+     */
+    termYears?: number | null | undefined;
+};
+/**
+ * Object type discriminator. Always 'transaction'.
+ */
+export declare const TransactionObject: {
+    readonly Transaction: "transaction";
+};
+/**
+ * Object type discriminator. Always 'transaction'.
+ */
+export type TransactionObject = ClosedEnum<typeof TransactionObject>;
+/**
+ * Canonical tenure of the transacted interest. Null when the source did not record a usable tenure.
+ */
+export declare const TransactionTenure: {
+    readonly Freehold: "freehold";
+    readonly Leasehold: "leasehold";
+};
+/**
+ * Canonical tenure of the transacted interest. Null when the source did not record a usable tenure.
+ */
+export type TransactionTenure = OpenEnum<typeof TransactionTenure>;
+/**
+ * A standardised property transaction. All monetary values are in minor currency units.
+ */
+export type Transaction = {
+    address: TransactionAddress;
+    /**
+     * ISO 3166-1 alpha-2 country code.
+     */
+    country: string;
+    /**
+     * Completion (sale) or registration (lease grant) date.
+     */
+    date: Date;
+    /**
+     * Opaque composite id: {country}:{provider}:{externalId}.
+     */
+    id: string;
+    /**
+     * Transaction kind. 'sale': a completed sale/transfer. 'lease_grant': the grant of a new lease (premium).
+     */
+    kind: TransactionKind;
+    /**
+     * Lease detail; present only when kind is 'lease_grant'.
+     */
+    lease?: TransactionLease | null | undefined;
+    location?: TransactionLocation | null | undefined;
+    /**
+     * Whether the property was a new build at transaction.
+     */
+    newBuild?: boolean | null | undefined;
+    /**
+     * Object type discriminator. Always 'transaction'.
+     */
+    object: TransactionObject;
+    price: TransactionPrice;
+    /**
+     * Canonical property type.
+     */
+    propertyType: string;
+    /**
+     * Source registry identifier (permission-gated).
+     */
+    provider?: string | undefined;
+    /**
+     * Contributing data sources (permission-gated).
+     */
+    sources?: Array<string> | undefined;
+    /**
+     * Canonical tenure of the transacted interest. Null when the source did not record a usable tenure.
+     */
+    tenure: TransactionTenure | null;
+};
+/** @internal */
+export declare const TransactionKind$inboundSchema: z.ZodType<TransactionKind, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const TransactionLease$inboundSchema: z.ZodType<TransactionLease, z.ZodTypeDef, unknown>;
+export declare function transactionLeaseFromJSON(jsonString: string): SafeParseResult<TransactionLease, SDKValidationError>;
+/** @internal */
+export declare const TransactionObject$inboundSchema: z.ZodNativeEnum<typeof TransactionObject>;
+/** @internal */
+export declare const TransactionTenure$inboundSchema: z.ZodType<TransactionTenure, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const Transaction$inboundSchema: z.ZodType<Transaction, z.ZodTypeDef, unknown>;
+export declare function transactionFromJSON(jsonString: string): SafeParseResult<Transaction, SDKValidationError>;
+//# sourceMappingURL=transaction.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transaction.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,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,kBAAkB,EAEnB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,mBAAmB,EAEpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,gBAAgB,EAEjB,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,eAAe;;;CAGlB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,eAAe,CAAC,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;CAEpB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;CAGpB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IACX;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,GAAG,IAAI,GAAG,SAAS,CAAC;IAC5C,QAAQ,CAAC,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,CAAC;IAClD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAC1B,KAAK,EAAE,gBAAgB,CAAC;IACxB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAClC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,eAAe,EACf,CAAC,CAAC,UAAU,EACZ,OAAO,CACmC,CAAC;AAE7C,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD;AAED,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,aAAa,CAC3D,OAAO,iBAAiB,CACS,CAAC;AAEpC,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,iBAAiB,EACjB,CAAC,CAAC,UAAU,EACZ,OAAO,CACqC,CAAC;AAE/C,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,WAAW,EACX,CAAC,CAAC,UAAU,EACZ,OAAO,CAgBP,CAAC;AAEH,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAMlD"}

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

@@ -0,0 +1,65 @@
+/*
+ * 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";
+import { TransactionAddress$inboundSchema, } from "./transactionaddress.js";
+import { TransactionLocation$inboundSchema, } from "./transactionlocation.js";
+import { TransactionPrice$inboundSchema, } from "./transactionprice.js";
+/**
+ * Transaction kind. 'sale': a completed sale/transfer. 'lease_grant': the grant of a new lease (premium).
+ */
+export const TransactionKind = {
+    Sale: "sale",
+    LeaseGrant: "lease_grant",
+};
+/**
+ * Object type discriminator. Always 'transaction'.
+ */
+export const TransactionObject = {
+    Transaction: "transaction",
+};
+/**
+ * Canonical tenure of the transacted interest. Null when the source did not record a usable tenure.
+ */
+export const TransactionTenure = {
+    Freehold: "freehold",
+    Leasehold: "leasehold",
+};
+/** @internal */
+export const TransactionKind$inboundSchema = openEnums.inboundSchema(TransactionKind);
+/** @internal */
+export const TransactionLease$inboundSchema = z.object({
+    startDate: z.nullable(z.string().datetime({ offset: true }).transform(v => new Date(v))).optional(),
+    termText: z.nullable(z.string()),
+    termYears: z.nullable(z.number()).optional(),
+});
+export function transactionLeaseFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => TransactionLease$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TransactionLease' from JSON`);
+}
+/** @internal */
+export const TransactionObject$inboundSchema = z.nativeEnum(TransactionObject);
+/** @internal */
+export const TransactionTenure$inboundSchema = openEnums.inboundSchema(TransactionTenure);
+/** @internal */
+export const Transaction$inboundSchema = z.object({
+    address: TransactionAddress$inboundSchema,
+    country: z.string(),
+    date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    id: z.string(),
+    kind: TransactionKind$inboundSchema,
+    lease: z.nullable(z.lazy(() => TransactionLease$inboundSchema)).optional(),
+    location: z.nullable(TransactionLocation$inboundSchema).optional(),
+    newBuild: z.nullable(z.boolean()).optional(),
+    object: TransactionObject$inboundSchema,
+    price: TransactionPrice$inboundSchema,
+    propertyType: z.string(),
+    provider: z.string().optional(),
+    sources: z.array(z.string()).optional(),
+    tenure: z.nullable(TransactionTenure$inboundSchema),
+});
+export function transactionFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Transaction$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Transaction' from JSON`);
+}
+//# sourceMappingURL=transaction.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transaction.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;AAIlD,OAAO,EAEL,gCAAgC,GACjC,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAEL,iCAAiC,GAClC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAEL,8BAA8B,GAC/B,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,aAAa;CACjB,CAAC;AAwBX;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,aAAa;CAClB,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;CACd,CAAC;AA2DX,gBAAgB;AAChB,MAAM,CAAC,MAAM,6BAA6B,GAItC,SAAS,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;AAE7C,gBAAgB;AAChB,MAAM,CAAC,MAAM,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,QAAQ,CACnB,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAClE,CAAC,QAAQ,EAAE;IACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAChC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC;AAEH,MAAM,UAAU,wBAAwB,CACtC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8BAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,+BAA+B,GAExC,CAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;AAEpC,gBAAgB;AAChB,MAAM,CAAC,MAAM,+BAA+B,GAIxC,SAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC;AAE/C,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAIlC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,gCAAgC;IACzC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IACvE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,6BAA6B;IACnC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,8BAA8B,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC1E,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,iCAAiC,CAAC,CAAC,QAAQ,EAAE;IAClE,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,MAAM,EAAE,+BAA+B;IACvC,KAAK,EAAE,8BAA8B;IACrC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,+BAA+B,CAAC;CACpD,CAAC,CAAC;AAEH,MAAM,UAAU,mBAAmB,CACjC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,yBAAyB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrD,yCAAyC,CAC1C,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,34 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+export type TransactionAddress = {
+    county?: string | null | undefined;
+    district?: string | null | undefined;
+    /**
+     * Postcode inward code.
+     */
+    incode?: string | null | undefined;
+    locality?: string | null | undefined;
+    /**
+     * Postcode outward code.
+     */
+    outcode?: string | null | undefined;
+    /**
+     * Primary addressable object name (building number/name).
+     */
+    paon?: string | null | undefined;
+    /**
+     * Full postcode.
+     */
+    postcode?: string | null | undefined;
+    /**
+     * Secondary addressable object name (flat/unit).
+     */
+    saon?: string | null | undefined;
+    street?: string | null | undefined;
+    town?: string | null | undefined;
+};
+/** @internal */
+export declare const TransactionAddress$inboundSchema: z.ZodType<TransactionAddress, z.ZodTypeDef, unknown>;
+export declare function transactionAddressFromJSON(jsonString: string): SafeParseResult<TransactionAddress, SDKValidationError>;
+//# sourceMappingURL=transactionaddress.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transactionaddress.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionaddress.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACnC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CAYP,CAAC;AAEH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAMzD"}

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

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+/** @internal */
+export const TransactionAddress$inboundSchema = z.object({
+    county: z.nullable(z.string()).optional(),
+    district: z.nullable(z.string()).optional(),
+    incode: z.nullable(z.string()).optional(),
+    locality: z.nullable(z.string()).optional(),
+    outcode: z.nullable(z.string()).optional(),
+    paon: z.nullable(z.string()).optional(),
+    postcode: z.nullable(z.string()).optional(),
+    saon: z.nullable(z.string()).optional(),
+    street: z.nullable(z.string()).optional(),
+    town: z.nullable(z.string()).optional(),
+});
+export function transactionAddressFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => TransactionAddress$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TransactionAddress' from JSON`);
+}
+//# sourceMappingURL=transactionaddress.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transactionaddress.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionaddress.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAgCpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1C,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,MAAM,UAAU,0BAA0B,CACxC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,gCAAgC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC5D,gDAAgD,CACjD,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,15 @@
+import * as z from "zod/v3";
+import { TransactionOutcodeArea, TransactionOutcodeArea$Outbound } from "./transactionoutcodearea.js";
+import { TransactionPointArea, TransactionPointArea$Outbound } from "./transactionpointarea.js";
+import { TransactionPolygonArea, TransactionPolygonArea$Outbound } from "./transactionpolygonarea.js";
+import { TransactionPostcodeArea, TransactionPostcodeArea$Outbound } from "./transactionpostcodearea.js";
+/**
+ * A geographic area filter. Multiple areas are combined with OR.
+ */
+export type TransactionAreaFilter = TransactionPostcodeArea | TransactionOutcodeArea | TransactionPointArea | TransactionPolygonArea;
+/** @internal */
+export type TransactionAreaFilter$Outbound = TransactionPostcodeArea$Outbound | TransactionOutcodeArea$Outbound | TransactionPointArea$Outbound | TransactionPolygonArea$Outbound;
+/** @internal */
+export declare const TransactionAreaFilter$outboundSchema: z.ZodType<TransactionAreaFilter$Outbound, z.ZodTypeDef, TransactionAreaFilter>;
+export declare function transactionAreaFilterToJSON(transactionAreaFilter: TransactionAreaFilter): string;
+//# sourceMappingURL=transactionareafilter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transactionareafilter.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionareafilter.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EACL,sBAAsB,EACtB,+BAA+B,EAEhC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,oBAAoB,EACpB,6BAA6B,EAE9B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,sBAAsB,EACtB,+BAA+B,EAEhC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,uBAAuB,EACvB,gCAAgC,EAEjC,MAAM,8BAA8B,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,uBAAuB,GACvB,sBAAsB,GACtB,oBAAoB,GACpB,sBAAsB,CAAC;AAE3B,gBAAgB;AAChB,MAAM,MAAM,8BAA8B,GACtC,gCAAgC,GAChC,+BAA+B,GAC/B,6BAA6B,GAC7B,+BAA+B,CAAC;AAEpC,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,qBAAqB,CAMrB,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,qBAAqB,EAAE,qBAAqB,GAC3C,MAAM,CAIR"}

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

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { TransactionOutcodeArea$outboundSchema, } from "./transactionoutcodearea.js";
+import { TransactionPointArea$outboundSchema, } from "./transactionpointarea.js";
+import { TransactionPolygonArea$outboundSchema, } from "./transactionpolygonarea.js";
+import { TransactionPostcodeArea$outboundSchema, } from "./transactionpostcodearea.js";
+/** @internal */
+export const TransactionAreaFilter$outboundSchema = z.union([
+    TransactionPostcodeArea$outboundSchema,
+    TransactionOutcodeArea$outboundSchema,
+    TransactionPointArea$outboundSchema,
+    TransactionPolygonArea$outboundSchema,
+]);
+export function transactionAreaFilterToJSON(transactionAreaFilter) {
+    return JSON.stringify(TransactionAreaFilter$outboundSchema.parse(transactionAreaFilter));
+}
+//# sourceMappingURL=transactionareafilter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transactionareafilter.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionareafilter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAGL,qCAAqC,GACtC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAGL,mCAAmC,GACpC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAGL,qCAAqC,GACtC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAGL,sCAAsC,GACvC,MAAM,8BAA8B,CAAC;AAkBtC,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAI7C,CAAC,CAAC,KAAK,CAAC;IACV,sCAAsC;IACtC,qCAAqC;IACrC,mCAAmC;IACnC,qCAAqC;CACtC,CAAC,CAAC;AAEH,MAAM,UAAU,2BAA2B,CACzC,qBAA4C;IAE5C,OAAO,IAAI,CAAC,SAAS,CACnB,oCAAoC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAClE,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,35 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+/**
+ * WGS84 point [lon, lat].
+ */
+export type TransactionLocationPoint = {
+    lat: number;
+    lon: number;
+};
+export type TransactionLocation = {
+    /**
+     * UPRN match confidence (0–1).
+     */
+    confidence?: number | null | undefined;
+    /**
+     * WGS84 point [lon, lat].
+     */
+    point?: TransactionLocationPoint | null | undefined;
+    /**
+     * Matched internal property identifier.
+     */
+    propertyId?: string | null | undefined;
+    /**
+     * Matched UPRN, where resolved.
+     */
+    uprn?: number | null | undefined;
+};
+/** @internal */
+export declare const TransactionLocationPoint$inboundSchema: z.ZodType<TransactionLocationPoint, z.ZodTypeDef, unknown>;
+export declare function transactionLocationPointFromJSON(jsonString: string): SafeParseResult<TransactionLocationPoint, SDKValidationError>;
+/** @internal */
+export declare const TransactionLocation$inboundSchema: z.ZodType<TransactionLocation, z.ZodTypeDef, unknown>;
+export declare function transactionLocationFromJSON(jsonString: string): SafeParseResult<TransactionLocation, SDKValidationError>;
+//# sourceMappingURL=transactionlocation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transactionlocation.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionlocation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,wBAAwB,GAAG,IAAI,GAAG,SAAS,CAAC;IACpD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D;AAED,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D"}