@vepler/sdk 2.131.2 → 2.137.0

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  ListingQueryCondition,
+  ListingQueryCondition$Outbound,
+  ListingQueryCondition$outboundSchema,
+} from "./listingquerycondition.js";
+
+export type ListingQueryGroup = {
+  /**
+   * Conditions within this group.
+   */
+  conditions: Array<ListingQueryCondition>;
+};
+
+/** @internal */
+export type ListingQueryGroup$Outbound = {
+  conditions: Array<ListingQueryCondition$Outbound>;
+};
+
+/** @internal */
+export const ListingQueryGroup$outboundSchema: z.ZodType<
+  ListingQueryGroup$Outbound,
+  z.ZodTypeDef,
+  ListingQueryGroup
+> = z.object({
+  conditions: z.array(ListingQueryCondition$outboundSchema),
+});
+
+export function listingQueryGroupToJSON(
+  listingQueryGroup: ListingQueryGroup,
+): string {
+  return JSON.stringify(
+    ListingQueryGroup$outboundSchema.parse(listingQueryGroup),
+  );
+}

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

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  ListingQueryGroup,
+  ListingQueryGroup$Outbound,
+  ListingQueryGroup$outboundSchema,
+} from "./listingquerygroup.js";
+
+/**
+ * How conditions within each group are combined.
+ */
+export const ListingQueryOperatorOperator = {
+  And: "AND",
+  Or: "OR",
+} as const;
+/**
+ * How conditions within each group are combined.
+ */
+export type ListingQueryOperatorOperator = ClosedEnum<
+  typeof ListingQueryOperatorOperator
+>;
+
+export type ListingQueryOperator = {
+  /**
+   * Condition groups.
+   */
+  groups: Array<ListingQueryGroup>;
+  /**
+   * How conditions within each group are combined.
+   */
+  operator: ListingQueryOperatorOperator;
+};
+
+/** @internal */
+export const ListingQueryOperatorOperator$outboundSchema: z.ZodNativeEnum<
+  typeof ListingQueryOperatorOperator
+> = z.nativeEnum(ListingQueryOperatorOperator);
+
+/** @internal */
+export type ListingQueryOperator$Outbound = {
+  groups: Array<ListingQueryGroup$Outbound>;
+  operator: string;
+};
+
+/** @internal */
+export const ListingQueryOperator$outboundSchema: z.ZodType<
+  ListingQueryOperator$Outbound,
+  z.ZodTypeDef,
+  ListingQueryOperator
+> = z.object({
+  groups: z.array(ListingQueryGroup$outboundSchema),
+  operator: ListingQueryOperatorOperator$outboundSchema,
+});
+
+export function listingQueryOperatorToJSON(
+  listingQueryOperator: ListingQueryOperator,
+): string {
+  return JSON.stringify(
+    ListingQueryOperator$outboundSchema.parse(listingQueryOperator),
+  );
+}

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

@@ -0,0 +1,132 @@
+/*
+ * 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";
+import {
+  SchoolFrameworkCode,
+  SchoolFrameworkCode$inboundSchema,
+} from "./schoolframeworkcode.js";
+
+/**
+ * Expected value range. `nominalNationalAverage` is the typical mid-point (e.g. ATT8 hovers ~47 in England). Useful for AI agents to detect outliers without first loading a national-distribution dataset.
+ */
+export type Range = {
+  max?: number | null | undefined;
+  min?: number | null | undefined;
+  nominalNationalAverage?: number | null | undefined;
+};
+
+export type MetricDefinition = {
+  /**
+   * Canonical metric code as published by the source authority. Example: `ATT8` (DfE KS4 Attainment 8), `PTRWM_EXP` (DfE KS2 percentage at expected standard in reading, writing and maths combined). Codes are stable across years within a framework.
+   */
+  code: string;
+  /**
+   * Cohort breakdowns this metric is published in. Subset of `all | boys | girls | disadvantaged | nonDisadvantaged | eal | nonEal | senSupport | ehcp | nonMobile | priorAttainmentLow | priorAttainmentMiddle | priorAttainmentHigh`.
+   */
+  cohortDimensionsSupported?: Array<string> | undefined;
+  /**
+   * Longer-form explanation of what the metric measures, how it's calculated, and caveats. Drawn from the source authority's published methodology.
+   */
+  description?: string | null | undefined;
+  /**
+   * Concrete example of how this metric appears inside the School aggregate. LLMs use examples for shape-matching more reliably than they use prose schemas.
+   */
+  examplePayload?: { [k: string]: any } | null | undefined;
+  framework: SchoolFrameworkCode;
+  /**
+   * Canonical publisher methodology URL. Researchers cite this; AI agents can fetch it for deep context.
+   */
+  governingPublicationUrl?: string | null | undefined;
+  /**
+   * Whether higher values indicate stronger performance. Null when the metric is descriptive rather than evaluative (e.g. `PUPIL_COUNT`).
+   */
+  higherIsBetter?: boolean | null | undefined;
+  /**
+   * One-sentence operational definition for AI agents and non-DfE readers. E.g. `Average GCSE points across the 8 best subjects, on a 0-90 scale`.
+   */
+  interpretedAs: string;
+  /**
+   * True for percentile-rank metrics. Affects rendering and aggregation.
+   */
+  isPercentile: boolean;
+  /**
+   * Human-readable short label suitable for table headers (e.g. `Attainment 8`).
+   */
+  label: string;
+  /**
+   * First academic year this metric was published.
+   */
+  publishedSince?: string | null | undefined;
+  /**
+   * Expected value range. `nominalNationalAverage` is the typical mid-point (e.g. ATT8 hovers ~47 in England). Useful for AI agents to detect outliers without first loading a national-distribution dataset.
+   */
+  range?: Range | null | undefined;
+  /**
+   * Academic year after which this metric was withdrawn. Null when still active.
+   */
+  retiredIn?: string | null | undefined;
+  /**
+   * Source authority's small-cohort suppression rule (e.g. `Suppressed when fewer than 6 pupils in cohort`). Important for honesty: null values may be policy-suppressed rather than missing.
+   */
+  suppressionPolicy?: string | null | undefined;
+  /**
+   * Unit of measurement. One of: `percent`, `score_out_of_90`, `points`, `count`, `rate_per_1000`, `currency_gbp`, `metres`, `ratio`, `boolean`, `enum`. Clients use this to render values appropriately (e.g. append `%` for percent, format `currency_gbp` as money).
+   */
+  unit: string;
+};
+
+/** @internal */
+export const Range$inboundSchema: z.ZodType<Range, z.ZodTypeDef, unknown> = z
+  .object({
+    max: z.nullable(z.number()).optional(),
+    min: z.nullable(z.number()).optional(),
+    nominalNationalAverage: z.nullable(z.number()).optional(),
+  });
+
+export function rangeFromJSON(
+  jsonString: string,
+): SafeParseResult<Range, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Range$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Range' from JSON`,
+  );
+}
+
+/** @internal */
+export const MetricDefinition$inboundSchema: z.ZodType<
+  MetricDefinition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  cohortDimensionsSupported: z.array(z.string()).optional(),
+  description: z.nullable(z.string()).optional(),
+  examplePayload: z.nullable(z.record(z.any())).optional(),
+  framework: SchoolFrameworkCode$inboundSchema,
+  governingPublicationUrl: z.nullable(z.string()).optional(),
+  higherIsBetter: z.nullable(z.boolean()).optional(),
+  interpretedAs: z.string(),
+  isPercentile: z.boolean().default(false),
+  label: z.string(),
+  publishedSince: z.nullable(z.string()).optional(),
+  range: z.nullable(z.lazy(() => Range$inboundSchema)).optional(),
+  retiredIn: z.nullable(z.string()).optional(),
+  suppressionPolicy: z.nullable(z.string()).optional(),
+  unit: z.string(),
+});
+
+export function metricDefinitionFromJSON(
+  jsonString: string,
+): SafeParseResult<MetricDefinition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MetricDefinition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MetricDefinition' from JSON`,
+  );
+}

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

@@ -0,0 +1,48 @@
+/*
+ * 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";
+import { CostBand, CostBand$inboundSchema } from "./costband.js";
+import { Effectiveness, Effectiveness$inboundSchema } from "./effectiveness.js";
+
+/**
+ * Mitigation measure available to address the risk
+ */
+export type MitigationMeasure = {
+  /**
+   * Mitigation category — e.g. 'ventilation', 'glazing', 'barriers', 'raised_floor'
+   */
+  category: string;
+  /**
+   * Description of the mitigation measure
+   */
+  description: string;
+  effectiveness?: Effectiveness | undefined;
+  estimatedCostBand?: CostBand | undefined;
+};
+
+/** @internal */
+export const MitigationMeasure$inboundSchema: z.ZodType<
+  MitigationMeasure,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  category: z.string(),
+  description: z.string(),
+  effectiveness: Effectiveness$inboundSchema.optional(),
+  estimatedCostBand: CostBand$inboundSchema.optional(),
+});
+
+export function mitigationMeasureFromJSON(
+  jsonString: string,
+): SafeParseResult<MitigationMeasure, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MitigationMeasure$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MitigationMeasure' from JSON`,
+  );
+}

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

@@ -0,0 +1,68 @@
+/*
+ * 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";
+import { Scale, Scale$inboundSchema } from "./scale.js";
+
+/**
+ * Government-defined index value with system, scale and jurisdiction discriminators
+ */
+export type OfficialIndex = {
+  /**
+   * System-defined band label for this value
+   */
+  band?: string | undefined;
+  /**
+   * Jurisdiction this index applies to (ISO 3166-1 alpha-2, optionally with subdivision)
+   */
+  jurisdiction: string;
+  /**
+   * Canonical URL where the index definition is published
+   */
+  reference?: string | undefined;
+  /**
+   * Self-describing scale for a score
+   */
+  scale: Scale;
+  /**
+   * Machine code identifying the index system — e.g. 'DAQI', 'USAQI', 'IMD', 'AQHI', 'CAQI', 'SAFAR'
+   */
+  system: string;
+  /**
+   * Edition, year, or revision of the system
+   */
+  systemVersion?: string | undefined;
+  /**
+   * Index value within the system's scale
+   */
+  value: number;
+};
+
+/** @internal */
+export const OfficialIndex$inboundSchema: z.ZodType<
+  OfficialIndex,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  band: z.string().optional(),
+  jurisdiction: z.string(),
+  reference: z.string().optional(),
+  scale: Scale$inboundSchema,
+  system: z.string(),
+  systemVersion: z.string().optional(),
+  value: z.number(),
+});
+
+export function officialIndexFromJSON(
+  jsonString: string,
+): SafeParseResult<OfficialIndex, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OfficialIndex$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OfficialIndex' from JSON`,
+  );
+}