@vepler/sdk 2.131.2 → 2.137.0

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

@@ -0,0 +1,84 @@
+/*
+ * 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 { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CoverageQuality,
+  CoverageQuality$inboundSchema,
+} from "./coveragequality.js";
+import {
+  SchoolFrameworkCode,
+  SchoolFrameworkCode$inboundSchema,
+} from "./schoolframeworkcode.js";
+
+/**
+ * Top-level School aggregate block this framework feeds.
+ */
+export const Domain = {
+  Performance: "performance",
+  Destinations: "destinations",
+  ValueAdded: "value_added",
+  Census: "census",
+  Finance: "finance",
+  Admissions: "admissions",
+  Inspections: "inspections",
+  Catchment: "catchment",
+} as const;
+/**
+ * Top-level School aggregate block this framework feeds.
+ */
+export type Domain = OpenEnum<typeof Domain>;
+
+export type CoverageCell = {
+  countryCode: string;
+  /**
+   * Top-level School aggregate block this framework feeds.
+   */
+  domain: Domain;
+  /**
+   * Opaque tier identifier required to access this block. Commercial owns the namespace.
+   */
+  entitlementRequired: string;
+  framework: SchoolFrameworkCode;
+  notes?: string | null | undefined;
+  quality: CoverageQuality;
+  /**
+   * Where this framework's data appears (e.g. `performance.ks4`).
+   */
+  schoolBlockPath: string;
+};
+
+/** @internal */
+export const Domain$inboundSchema: z.ZodType<Domain, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Domain);
+
+/** @internal */
+export const CoverageCell$inboundSchema: z.ZodType<
+  CoverageCell,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  countryCode: z.string(),
+  domain: Domain$inboundSchema,
+  entitlementRequired: z.string(),
+  framework: SchoolFrameworkCode$inboundSchema,
+  notes: z.nullable(z.string()).optional(),
+  quality: CoverageQuality$inboundSchema,
+  schoolBlockPath: z.string(),
+});
+
+export function coverageCellFromJSON(
+  jsonString: string,
+): SafeParseResult<CoverageCell, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CoverageCell$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CoverageCell' from JSON`,
+  );
+}

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

@@ -0,0 +1,94 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { CoverageCell, CoverageCell$inboundSchema } from "./coveragecell.js";
+import {
+  SchoolFrameworkCode,
+  SchoolFrameworkCode$inboundSchema,
+} from "./schoolframeworkcode.js";
+
+export const CoverageMatrixObject = {
+  CoverageMatrix: "coverage_matrix",
+} as const;
+export type CoverageMatrixObject = ClosedEnum<typeof CoverageMatrixObject>;
+
+/**
+ * Top-line totals for quick scan.
+ */
+export type CoverageMatrixSummary = {
+  countriesCovered: Array<string>;
+  frameworksCovered: Array<SchoolFrameworkCode>;
+  totalSchools: number;
+};
+
+export type CoverageMatrix = {
+  /**
+   * One row per (country, framework). Sorted by country, framework.
+   */
+  cells: Array<CoverageCell>;
+  object: CoverageMatrixObject;
+  /**
+   * Schema version this coverage report was generated under.
+   */
+  objectVersion: string;
+  snapshotAt: Date;
+  /**
+   * Top-line totals for quick scan.
+   */
+  summary: CoverageMatrixSummary;
+};
+
+/** @internal */
+export const CoverageMatrixObject$inboundSchema: z.ZodNativeEnum<
+  typeof CoverageMatrixObject
+> = z.nativeEnum(CoverageMatrixObject);
+
+/** @internal */
+export const CoverageMatrixSummary$inboundSchema: z.ZodType<
+  CoverageMatrixSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  countriesCovered: z.array(z.string()),
+  frameworksCovered: z.array(SchoolFrameworkCode$inboundSchema),
+  totalSchools: z.number().int(),
+});
+
+export function coverageMatrixSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<CoverageMatrixSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CoverageMatrixSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CoverageMatrixSummary' from JSON`,
+  );
+}
+
+/** @internal */
+export const CoverageMatrix$inboundSchema: z.ZodType<
+  CoverageMatrix,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cells: z.array(CoverageCell$inboundSchema),
+  object: CoverageMatrixObject$inboundSchema,
+  objectVersion: z.string(),
+  snapshotAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  summary: z.lazy(() => CoverageMatrixSummary$inboundSchema),
+});
+
+export function coverageMatrixFromJSON(
+  jsonString: string,
+): SafeParseResult<CoverageMatrix, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CoverageMatrix$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CoverageMatrix' from JSON`,
+  );
+}

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

@@ -0,0 +1,78 @@
+/*
+ * 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 { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const Cadence = {
+  Annual: "annual",
+  Monthly: "monthly",
+  Rolling: "rolling",
+  AdHoc: "ad_hoc",
+  Discontinued: "discontinued",
+} as const;
+export type Cadence = OpenEnum<typeof Cadence>;
+
+export type CoverageQuality = {
+  cadence: Cadence;
+  /**
+   * Percentage = (schoolsCovered / schoolsExpected) × 100. Researchers cite this.
+   */
+  coveragePct: number;
+  earliestAcademicYear: string | null;
+  lastRefreshedAt: Date | null;
+  latestAcademicYear: string | null;
+  nextRefreshExpectedAt: Date | null;
+  /**
+   * Number of schools for which this framework's data is loaded.
+   */
+  schoolsCovered: number;
+  /**
+   * Number of schools expected to have this framework's data (denominator for coverage %).
+   */
+  schoolsExpected: number;
+  /**
+   * Count of distinct academic years held.
+   */
+  yearsLoaded: number;
+};
+
+/** @internal */
+export const Cadence$inboundSchema: z.ZodType<Cadence, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Cadence);
+
+/** @internal */
+export const CoverageQuality$inboundSchema: z.ZodType<
+  CoverageQuality,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cadence: Cadence$inboundSchema,
+  coveragePct: z.number(),
+  earliestAcademicYear: z.nullable(z.string()),
+  lastRefreshedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  latestAcademicYear: z.nullable(z.string()),
+  nextRefreshExpectedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  schoolsCovered: z.number().int(),
+  schoolsExpected: z.number().int(),
+  yearsLoaded: z.number().int(),
+});
+
+export function coverageQualityFromJSON(
+  jsonString: string,
+): SafeParseResult<CoverageQuality, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CoverageQuality$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CoverageQuality' from JSON`,
+  );
+}

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

@@ -15,7 +15,7 @@ export type CrimeIncident = {
   /**
    * `[longitude, latitude]` of the anonymised reporting point (WGS84). Snapped by the provider to a nearby map point — accurate to ~150m. Null for records that have no recorded geometry.
    */
-  coordinates: Array<number> | null;
+  coordinates: Array<number | null> | null;
   /**
    * ISO 8601 datetime the incident was recorded. The upstream provider publishes monthly resolution.
    */
@@ -45,7 +45,7 @@ export const CrimeIncident$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   category: z.string(),
-  coordinates: z.nullable(z.array(z.number())),
+  coordinates: z.nullable(z.array(z.nullable(z.number()))),
   crimeDate: z.string(),
   crimeId: z.nullable(z.string()),
   crimeLocation: z.nullable(z.string()),

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

@@ -22,7 +22,7 @@ export type CrimePeriodDetails = {
    * Length of the analysis window, in months.
    */
   windowMonths: number;
-  additionalProperties?: { [k: string]: any | null } | undefined;
+  additionalProperties?: { [k: string]: any } | undefined;
 };
 
 /** @internal */

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

@@ -0,0 +1,82 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Reference to a single upstream data source
+ */
+export type DataSourceRef = {
+  /**
+   * Organisation responsible for publishing the source
+   */
+  custodian?: string | undefined;
+  /**
+   * ISO datetime — when Vepler ingested this version
+   */
+  fetchedAt?: string | undefined;
+  /**
+   * Machine code for the source (e.g. 'ea_aqma_register')
+   */
+  id: string;
+  /**
+   * ISO 3166-1 alpha-2 codes (optionally with subdivision) covered by this source
+   */
+  jurisdiction?: Array<string> | undefined;
+  /**
+   * Licence identifier — e.g. 'OGL_v3.0', 'INSPIRE', 'CC_BY_4.0', 'proprietary'
+   */
+  licence?: string | undefined;
+  /**
+   * Human-readable name for the source
+   */
+  name: string;
+  /**
+   * ISO date — when the custodian published this version
+   */
+  releaseDate?: string | undefined;
+  /**
+   * SHA-256 hash of the raw fetched artefact for integrity verification
+   */
+  sha256?: string | undefined;
+  /**
+   * Canonical URL where the source is published
+   */
+  url?: string | undefined;
+  /**
+   * Source-side version when the custodian provides one
+   */
+  version?: string | undefined;
+};
+
+/** @internal */
+export const DataSourceRef$inboundSchema: z.ZodType<
+  DataSourceRef,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  custodian: z.string().optional(),
+  fetchedAt: z.string().optional(),
+  id: z.string(),
+  jurisdiction: z.array(z.string()).optional(),
+  licence: z.string().optional(),
+  name: z.string(),
+  releaseDate: z.string().optional(),
+  sha256: z.string().optional(),
+  url: z.string().optional(),
+  version: z.string().optional(),
+});
+
+export function dataSourceRefFromJSON(
+  jsonString: string,
+): SafeParseResult<DataSourceRef, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DataSourceRef$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DataSourceRef' from JSON`,
+  );
+}

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

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const Effectiveness = {
+  Low: "low",
+  Medium: "medium",
+  High: "high",
+} as const;
+export type Effectiveness = OpenEnum<typeof Effectiveness>;
+
+/** @internal */
+export const Effectiveness$inboundSchema: z.ZodType<
+  Effectiveness,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Effectiveness);

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

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Severity of exceedance when status is 'exceedance'
+ */
+export const ExceedanceLevel = {
+  Minor: "minor",
+  Significant: "significant",
+  Severe: "severe",
+} as const;
+/**
+ * Severity of exceedance when status is 'exceedance'
+ */
+export type ExceedanceLevel = OpenEnum<typeof ExceedanceLevel>;
+
+/** @internal */
+export const ExceedanceLevel$inboundSchema: z.ZodType<
+  ExceedanceLevel,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ExceedanceLevel);

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

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+ */
+export type ExtractionCitation = {
+  /**
+   * Up to ~50 characters of source text either side of the quote, to disambiguate repeated phrases.
+   */
+  context: string;
+  /**
+   * Category of the source document (e.g. 'decision', 'officer_report', 'legal_financial').
+   */
+  documentCategory: string;
+  /**
+   * Identifier of the source document the quote was taken from.
+   */
+  documentId: string;
+  /**
+   * Verbatim span copied from the source document that grounds this value.
+   */
+  quote: string;
+};
+
+/** @internal */
+export const ExtractionCitation$inboundSchema: z.ZodType<
+  ExtractionCitation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  context: z.string(),
+  documentCategory: z.string(),
+  documentId: z.string(),
+  quote: z.string(),
+});
+
+export function extractionCitationFromJSON(
+  jsonString: string,
+): SafeParseResult<ExtractionCitation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExtractionCitation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExtractionCitation' from JSON`,
+  );
+}

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

@@ -0,0 +1,126 @@
+/*
+ * 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 { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  SchoolFrameworkCode,
+  SchoolFrameworkCode$inboundSchema,
+} from "./schoolframeworkcode.js";
+
+/**
+ * How often the source authority publishes updates.
+ */
+export const FrameworkCadence = {
+  Annual: "annual",
+  Monthly: "monthly",
+  Rolling: "rolling",
+  AdHoc: "ad_hoc",
+} as const;
+/**
+ * How often the source authority publishes updates.
+ */
+export type FrameworkCadence = OpenEnum<typeof FrameworkCadence>;
+
+/**
+ * Which top-level School aggregate block this framework feeds.
+ */
+export const FrameworkDomain = {
+  Performance: "performance",
+  Destinations: "destinations",
+  ValueAdded: "value_added",
+  Census: "census",
+  Finance: "finance",
+  Admissions: "admissions",
+  Inspections: "inspections",
+} as const;
+/**
+ * Which top-level School aggregate block this framework feeds.
+ */
+export type FrameworkDomain = OpenEnum<typeof FrameworkDomain>;
+
+export type Framework = {
+  /**
+   * How often the source authority publishes updates.
+   */
+  cadence: FrameworkCadence;
+  /**
+   * ISO 3166-1 alpha-2 country code this framework belongs to.
+   */
+  country: string;
+  /**
+   * Which top-level School aggregate block this framework feeds.
+   */
+  domain: FrameworkDomain;
+  /**
+   * Concrete example of the framework's block as it appears on a School resource.
+   */
+  examplePayload?: { [k: string]: any } | null | undefined;
+  /**
+   * Stable framework identifier.
+   */
+  framework: SchoolFrameworkCode;
+  governingPublicationUrl?: string | null | undefined;
+  /**
+   * All metric codes published in this framework. Lets agents discover what's available without fetching every definition individually.
+   */
+  metricCodes?: Array<string> | undefined;
+  publishedSince?: string | null | undefined;
+  /**
+   * Source authority that publishes this framework's data. E.g. `Department for Education (England)`, `Education Scotland`, `Ofsted`, `ESFA`.
+   */
+  publishingAuthority: string;
+  publishingAuthorityUrl?: string | null | undefined;
+  /**
+   * Where this framework's data lands inside the School aggregate (e.g. `performance.ks4`, `inspections.history[].framework=oeif`).
+   */
+  schoolBlockPath: string;
+};
+
+/** @internal */
+export const FrameworkCadence$inboundSchema: z.ZodType<
+  FrameworkCadence,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FrameworkCadence);
+
+/** @internal */
+export const FrameworkDomain$inboundSchema: z.ZodType<
+  FrameworkDomain,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FrameworkDomain);
+
+/** @internal */
+export const Framework$inboundSchema: z.ZodType<
+  Framework,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cadence: FrameworkCadence$inboundSchema,
+  country: z.string(),
+  domain: FrameworkDomain$inboundSchema,
+  examplePayload: z.nullable(z.record(z.any())).optional(),
+  framework: SchoolFrameworkCode$inboundSchema,
+  governingPublicationUrl: z.nullable(z.string()).optional(),
+  metricCodes: z.array(z.string()).optional(),
+  publishedSince: z.nullable(z.string()).optional(),
+  publishingAuthority: z.string(),
+  publishingAuthorityUrl: z.nullable(z.string()).optional(),
+  schoolBlockPath: z.string(),
+});
+
+export function frameworkFromJSON(
+  jsonString: string,
+): SafeParseResult<Framework, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Framework$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Framework' from JSON`,
+  );
+}

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

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Framework, Framework$inboundSchema } from "./framework.js";
+import {
+  MetricDefinition,
+  MetricDefinition$inboundSchema,
+} from "./metricdefinition.js";
+
+export const FrameworkDetailResponseObject = {
+  FrameworkDetail: "framework_detail",
+} as const;
+export type FrameworkDetailResponseObject = ClosedEnum<
+  typeof FrameworkDetailResponseObject
+>;
+
+export type FrameworkDetailResponse = {
+  framework: Framework;
+  /**
+   * Every metric defined in this framework.
+   */
+  metrics: Array<MetricDefinition>;
+  object: FrameworkDetailResponseObject;
+};
+
+/** @internal */
+export const FrameworkDetailResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof FrameworkDetailResponseObject
+> = z.nativeEnum(FrameworkDetailResponseObject);
+
+/** @internal */
+export const FrameworkDetailResponse$inboundSchema: z.ZodType<
+  FrameworkDetailResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  framework: Framework$inboundSchema,
+  metrics: z.array(MetricDefinition$inboundSchema),
+  object: FrameworkDetailResponseObject$inboundSchema,
+});
+
+export function frameworkDetailResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<FrameworkDetailResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FrameworkDetailResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FrameworkDetailResponse' from JSON`,
+  );
+}