@vepler/sdk 1.9.11 → 1.10.1

package/dist/esm/sdk/models/operations/getschoolmetrics.js

@@ -0,0 +1,770 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+/**
+ * Filter by metric category
+ */
+export const Category = {
+    Ks2: "ks2",
+    Ks4: "ks4",
+    Ks5: "ks5",
+    Pupil: "pupil",
+    Finance: "finance",
+    Ofsted: "ofsted",
+};
+/**
+ * Filter by cohort type
+ */
+export const CohortType = {
+    All: "all",
+    Disadvantaged: "disadvantaged",
+    Boys: "boys",
+    Girls: "girls",
+    Eal: "eal",
+    SenSupport: "senSupport",
+    Ehcp: "ehcp",
+    English: "english",
+    Unclassified: "unclassified",
+};
+/**
+ * Reporting period
+ */
+export const Period = {
+    Annual: "annual",
+    Termly: "termly",
+    Monthly: "monthly",
+};
+export const GetSchoolMetricsType = {
+    ApiError: "api_error",
+    InvalidRequestError: "invalid_request_error",
+    AuthenticationError: "authentication_error",
+    RateLimitError: "rate_limit_error",
+};
+export const Type = {
+    ApiError: "api_error",
+    InvalidRequestError: "invalid_request_error",
+    AuthenticationError: "authentication_error",
+    RateLimitError: "rate_limit_error",
+};
+export const GetSchoolMetricsDataType = {
+    Percentage: "percentage",
+    Score: "score",
+    Count: "count",
+    Currency: "currency",
+    Text: "text",
+};
+export const DataType = {
+    Percentage: "percentage",
+    Score: "score",
+    Count: "count",
+    Currency: "currency",
+    Text: "text",
+};
+export const GetSchoolMetricsObject = {
+    List: "list",
+};
+/** @internal */
+export const Category$inboundSchema = z
+    .nativeEnum(Category);
+/** @internal */
+export const Category$outboundSchema = Category$inboundSchema;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var Category$;
+(function (Category$) {
+    /** @deprecated use `Category$inboundSchema` instead. */
+    Category$.inboundSchema = Category$inboundSchema;
+    /** @deprecated use `Category$outboundSchema` instead. */
+    Category$.outboundSchema = Category$outboundSchema;
+})(Category$ || (Category$ = {}));
+/** @internal */
+export const CohortType$inboundSchema = z
+    .nativeEnum(CohortType);
+/** @internal */
+export const CohortType$outboundSchema = CohortType$inboundSchema;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var CohortType$;
+(function (CohortType$) {
+    /** @deprecated use `CohortType$inboundSchema` instead. */
+    CohortType$.inboundSchema = CohortType$inboundSchema;
+    /** @deprecated use `CohortType$outboundSchema` instead. */
+    CohortType$.outboundSchema = CohortType$outboundSchema;
+})(CohortType$ || (CohortType$ = {}));
+/** @internal */
+export const Period$inboundSchema = z
+    .nativeEnum(Period);
+/** @internal */
+export const Period$outboundSchema = Period$inboundSchema;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var Period$;
+(function (Period$) {
+    /** @deprecated use `Period$inboundSchema` instead. */
+    Period$.inboundSchema = Period$inboundSchema;
+    /** @deprecated use `Period$outboundSchema` instead. */
+    Period$.outboundSchema = Period$outboundSchema;
+})(Period$ || (Period$ = {}));
+/** @internal */
+export const GetSchoolMetricsRequest$inboundSchema = z.object({
+    academicYear: z.string().optional(),
+    category: Category$inboundSchema.optional(),
+    cohortType: CohortType$inboundSchema.optional(),
+    endYear: z.string().optional(),
+    includeComparisons: z.string().optional(),
+    includeDefinitions: z.string().optional(),
+    limit: z.string().optional(),
+    metricCodes: z.string().optional(),
+    offset: z.string().optional(),
+    period: Period$inboundSchema.optional(),
+    profile: z.string().optional(),
+    schoolIds: z.string(),
+    startYear: z.string().optional(),
+    timeseries: z.string().optional(),
+});
+/** @internal */
+export const GetSchoolMetricsRequest$outboundSchema = z.object({
+    academicYear: z.string().optional(),
+    category: Category$outboundSchema.optional(),
+    cohortType: CohortType$outboundSchema.optional(),
+    endYear: z.string().optional(),
+    includeComparisons: z.string().optional(),
+    includeDefinitions: z.string().optional(),
+    limit: z.string().optional(),
+    metricCodes: z.string().optional(),
+    offset: z.string().optional(),
+    period: Period$outboundSchema.optional(),
+    profile: z.string().optional(),
+    schoolIds: z.string(),
+    startYear: z.string().optional(),
+    timeseries: z.string().optional(),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetSchoolMetricsRequest$;
+(function (GetSchoolMetricsRequest$) {
+    /** @deprecated use `GetSchoolMetricsRequest$inboundSchema` instead. */
+    GetSchoolMetricsRequest$.inboundSchema = GetSchoolMetricsRequest$inboundSchema;
+    /** @deprecated use `GetSchoolMetricsRequest$outboundSchema` instead. */
+    GetSchoolMetricsRequest$.outboundSchema = GetSchoolMetricsRequest$outboundSchema;
+})(GetSchoolMetricsRequest$ || (GetSchoolMetricsRequest$ = {}));
+export function getSchoolMetricsRequestToJSON(getSchoolMetricsRequest) {
+    return JSON.stringify(GetSchoolMetricsRequest$outboundSchema.parse(getSchoolMetricsRequest));
+}
+export function getSchoolMetricsRequestFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolMetricsRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolMetricsRequest' from JSON`);
+}
+/** @internal */
+export const GetSchoolMetricsType$inboundSchema = z.nativeEnum(GetSchoolMetricsType);
+/** @internal */
+export const GetSchoolMetricsType$outboundSchema = GetSchoolMetricsType$inboundSchema;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetSchoolMetricsType$;
+(function (GetSchoolMetricsType$) {
+    /** @deprecated use `GetSchoolMetricsType$inboundSchema` instead. */
+    GetSchoolMetricsType$.inboundSchema = GetSchoolMetricsType$inboundSchema;
+    /** @deprecated use `GetSchoolMetricsType$outboundSchema` instead. */
+    GetSchoolMetricsType$.outboundSchema = GetSchoolMetricsType$outboundSchema;
+})(GetSchoolMetricsType$ || (GetSchoolMetricsType$ = {}));
+/** @internal */
+export const GetSchoolMetricsSchoolMetricsError$inboundSchema = z.object({
+    code: z.string().optional(),
+    message: z.string(),
+    param: z.string().optional(),
+    type: GetSchoolMetricsType$inboundSchema,
+});
+/** @internal */
+export const GetSchoolMetricsSchoolMetricsError$outboundSchema = z.object({
+    code: z.string().optional(),
+    message: z.string(),
+    param: z.string().optional(),
+    type: GetSchoolMetricsType$outboundSchema,
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetSchoolMetricsSchoolMetricsError$;
+(function (GetSchoolMetricsSchoolMetricsError$) {
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsError$inboundSchema` instead. */
+    GetSchoolMetricsSchoolMetricsError$.inboundSchema = GetSchoolMetricsSchoolMetricsError$inboundSchema;
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsError$outboundSchema` instead. */
+    GetSchoolMetricsSchoolMetricsError$.outboundSchema = GetSchoolMetricsSchoolMetricsError$outboundSchema;
+})(GetSchoolMetricsSchoolMetricsError$ || (GetSchoolMetricsSchoolMetricsError$ = {}));
+export function getSchoolMetricsSchoolMetricsErrorToJSON(getSchoolMetricsSchoolMetricsError) {
+    return JSON.stringify(GetSchoolMetricsSchoolMetricsError$outboundSchema.parse(getSchoolMetricsSchoolMetricsError));
+}
+export function getSchoolMetricsSchoolMetricsErrorFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolMetricsSchoolMetricsError$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolMetricsSchoolMetricsError' from JSON`);
+}
+/** @internal */
+export const GetSchoolMetricsSchoolMetricsResponseResponseBody$inboundSchema = z.object({
+    error: z.lazy(() => GetSchoolMetricsSchoolMetricsError$inboundSchema),
+});
+/** @internal */
+export const GetSchoolMetricsSchoolMetricsResponseResponseBody$outboundSchema = z.object({
+    error: z.lazy(() => GetSchoolMetricsSchoolMetricsError$outboundSchema),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetSchoolMetricsSchoolMetricsResponseResponseBody$;
+(function (GetSchoolMetricsSchoolMetricsResponseResponseBody$) {
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseResponseBody$inboundSchema` instead. */
+    GetSchoolMetricsSchoolMetricsResponseResponseBody$.inboundSchema = GetSchoolMetricsSchoolMetricsResponseResponseBody$inboundSchema;
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseResponseBody$outboundSchema` instead. */
+    GetSchoolMetricsSchoolMetricsResponseResponseBody$.outboundSchema = GetSchoolMetricsSchoolMetricsResponseResponseBody$outboundSchema;
+})(GetSchoolMetricsSchoolMetricsResponseResponseBody$ || (GetSchoolMetricsSchoolMetricsResponseResponseBody$ = {}));
+export function getSchoolMetricsSchoolMetricsResponseResponseBodyToJSON(getSchoolMetricsSchoolMetricsResponseResponseBody) {
+    return JSON.stringify(GetSchoolMetricsSchoolMetricsResponseResponseBody$outboundSchema.parse(getSchoolMetricsSchoolMetricsResponseResponseBody));
+}
+export function getSchoolMetricsSchoolMetricsResponseResponseBodyFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolMetricsSchoolMetricsResponseResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolMetricsSchoolMetricsResponseResponseBody' from JSON`);
+}
+/** @internal */
+export const Type$inboundSchema = z.nativeEnum(Type);
+/** @internal */
+export const Type$outboundSchema = Type$inboundSchema;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var Type$;
+(function (Type$) {
+    /** @deprecated use `Type$inboundSchema` instead. */
+    Type$.inboundSchema = Type$inboundSchema;
+    /** @deprecated use `Type$outboundSchema` instead. */
+    Type$.outboundSchema = Type$outboundSchema;
+})(Type$ || (Type$ = {}));
+/** @internal */
+export const GetSchoolMetricsError$inboundSchema = z.object({
+    code: z.string().optional(),
+    message: z.string(),
+    param: z.string().optional(),
+    type: Type$inboundSchema,
+});
+/** @internal */
+export const GetSchoolMetricsError$outboundSchema = z.object({
+    code: z.string().optional(),
+    message: z.string(),
+    param: z.string().optional(),
+    type: Type$outboundSchema,
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetSchoolMetricsError$;
+(function (GetSchoolMetricsError$) {
+    /** @deprecated use `GetSchoolMetricsError$inboundSchema` instead. */
+    GetSchoolMetricsError$.inboundSchema = GetSchoolMetricsError$inboundSchema;
+    /** @deprecated use `GetSchoolMetricsError$outboundSchema` instead. */
+    GetSchoolMetricsError$.outboundSchema = GetSchoolMetricsError$outboundSchema;
+})(GetSchoolMetricsError$ || (GetSchoolMetricsError$ = {}));
+export function getSchoolMetricsErrorToJSON(getSchoolMetricsError) {
+    return JSON.stringify(GetSchoolMetricsError$outboundSchema.parse(getSchoolMetricsError));
+}
+export function getSchoolMetricsErrorFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolMetricsError$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolMetricsError' from JSON`);
+}
+/** @internal */
+export const GetSchoolMetricsSchoolMetricsResponseBody$inboundSchema = z.object({
+    error: z.lazy(() => GetSchoolMetricsError$inboundSchema),
+});
+/** @internal */
+export const GetSchoolMetricsSchoolMetricsResponseBody$outboundSchema = z.object({
+    error: z.lazy(() => GetSchoolMetricsError$outboundSchema),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetSchoolMetricsSchoolMetricsResponseBody$;
+(function (GetSchoolMetricsSchoolMetricsResponseBody$) {
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseBody$inboundSchema` instead. */
+    GetSchoolMetricsSchoolMetricsResponseBody$.inboundSchema = GetSchoolMetricsSchoolMetricsResponseBody$inboundSchema;
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseBody$outboundSchema` instead. */
+    GetSchoolMetricsSchoolMetricsResponseBody$.outboundSchema = GetSchoolMetricsSchoolMetricsResponseBody$outboundSchema;
+})(GetSchoolMetricsSchoolMetricsResponseBody$ || (GetSchoolMetricsSchoolMetricsResponseBody$ = {}));
+export function getSchoolMetricsSchoolMetricsResponseBodyToJSON(getSchoolMetricsSchoolMetricsResponseBody) {
+    return JSON.stringify(GetSchoolMetricsSchoolMetricsResponseBody$outboundSchema.parse(getSchoolMetricsSchoolMetricsResponseBody));
+}
+export function getSchoolMetricsSchoolMetricsResponseBodyFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolMetricsSchoolMetricsResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolMetricsSchoolMetricsResponseBody' from JSON`);
+}
+/** @internal */
+export const GetSchoolMetricsDataType$inboundSchema = z.nativeEnum(GetSchoolMetricsDataType);
+/** @internal */
+export const GetSchoolMetricsDataType$outboundSchema = GetSchoolMetricsDataType$inboundSchema;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetSchoolMetricsDataType$;
+(function (GetSchoolMetricsDataType$) {
+    /** @deprecated use `GetSchoolMetricsDataType$inboundSchema` instead. */
+    GetSchoolMetricsDataType$.inboundSchema = GetSchoolMetricsDataType$inboundSchema;
+    /** @deprecated use `GetSchoolMetricsDataType$outboundSchema` instead. */
+    GetSchoolMetricsDataType$.outboundSchema = GetSchoolMetricsDataType$outboundSchema;
+})(GetSchoolMetricsDataType$ || (GetSchoolMetricsDataType$ = {}));
+/** @internal */
+export const GetSchoolMetricsDefinitions$inboundSchema = z.object({
+    category: z.string(),
+    code: z.string(),
+    dataType: GetSchoolMetricsDataType$inboundSchema,
+    description: z.string(),
+    isHigherBetter: z.boolean().optional(),
+    nationalAverage: z.number().optional(),
+    subcategory: z.string(),
+    units: z.string().optional(),
+});
+/** @internal */
+export const GetSchoolMetricsDefinitions$outboundSchema = z.object({
+    category: z.string(),
+    code: z.string(),
+    dataType: GetSchoolMetricsDataType$outboundSchema,
+    description: z.string(),
+    isHigherBetter: z.boolean().optional(),
+    nationalAverage: z.number().optional(),
+    subcategory: z.string(),
+    units: z.string().optional(),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetSchoolMetricsDefinitions$;
+(function (GetSchoolMetricsDefinitions$) {
+    /** @deprecated use `GetSchoolMetricsDefinitions$inboundSchema` instead. */
+    GetSchoolMetricsDefinitions$.inboundSchema = GetSchoolMetricsDefinitions$inboundSchema;
+    /** @deprecated use `GetSchoolMetricsDefinitions$outboundSchema` instead. */
+    GetSchoolMetricsDefinitions$.outboundSchema = GetSchoolMetricsDefinitions$outboundSchema;
+})(GetSchoolMetricsDefinitions$ || (GetSchoolMetricsDefinitions$ = {}));
+export function getSchoolMetricsDefinitionsToJSON(getSchoolMetricsDefinitions) {
+    return JSON.stringify(GetSchoolMetricsDefinitions$outboundSchema.parse(getSchoolMetricsDefinitions));
+}
+export function getSchoolMetricsDefinitionsFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolMetricsDefinitions$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolMetricsDefinitions' from JSON`);
+}
+/** @internal */
+export const Values$inboundSchema = z
+    .union([z.number(), z.string()]);
+/** @internal */
+export const Values$outboundSchema = z.union([z.number(), z.string()]);
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var Values$;
+(function (Values$) {
+    /** @deprecated use `Values$inboundSchema` instead. */
+    Values$.inboundSchema = Values$inboundSchema;
+    /** @deprecated use `Values$outboundSchema` instead. */
+    Values$.outboundSchema = Values$outboundSchema;
+})(Values$ || (Values$ = {}));
+export function valuesToJSON(values) {
+    return JSON.stringify(Values$outboundSchema.parse(values));
+}
+export function valuesFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Values$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Values' from JSON`);
+}
+/** @internal */
+export const Series$inboundSchema = z
+    .object({
+    values: z.record(z.union([z.number(), z.string()])),
+    year: z.string(),
+});
+/** @internal */
+export const Series$outboundSchema = z.object({
+    values: z.record(z.union([z.number(), z.string()])),
+    year: z.string(),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var Series$;
+(function (Series$) {
+    /** @deprecated use `Series$inboundSchema` instead. */
+    Series$.inboundSchema = Series$inboundSchema;
+    /** @deprecated use `Series$outboundSchema` instead. */
+    Series$.outboundSchema = Series$outboundSchema;
+})(Series$ || (Series$ = {}));
+export function seriesToJSON(series) {
+    return JSON.stringify(Series$outboundSchema.parse(series));
+}
+export function seriesFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Series$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Series' from JSON`);
+}
+/** @internal */
+export const Two$inboundSchema = z
+    .object({
+    definitions: z.array(z.lazy(() => GetSchoolMetricsDefinitions$inboundSchema)).optional(),
+    metricCodes: z.array(z.string()),
+    schoolId: z.number(),
+    series: z.array(z.lazy(() => Series$inboundSchema)),
+});
+/** @internal */
+export const Two$outboundSchema = z
+    .object({
+    definitions: z.array(z.lazy(() => GetSchoolMetricsDefinitions$outboundSchema)).optional(),
+    metricCodes: z.array(z.string()),
+    schoolId: z.number(),
+    series: z.array(z.lazy(() => Series$outboundSchema)),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var Two$;
+(function (Two$) {
+    /** @deprecated use `Two$inboundSchema` instead. */
+    Two$.inboundSchema = Two$inboundSchema;
+    /** @deprecated use `Two$outboundSchema` instead. */
+    Two$.outboundSchema = Two$outboundSchema;
+})(Two$ || (Two$ = {}));
+export function twoToJSON(two) {
+    return JSON.stringify(Two$outboundSchema.parse(two));
+}
+export function twoFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Two$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Two' from JSON`);
+}
+/** @internal */
+export const Comparisons$inboundSchema = z.object({
+    localAuthority: z.number().optional(),
+    national: z.number().optional(),
+    regional: z.number().optional(),
+    similarSchools: z.number().optional(),
+});
+/** @internal */
+export const Comparisons$outboundSchema = z.object({
+    localAuthority: z.number().optional(),
+    national: z.number().optional(),
+    regional: z.number().optional(),
+    similarSchools: z.number().optional(),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var Comparisons$;
+(function (Comparisons$) {
+    /** @deprecated use `Comparisons$inboundSchema` instead. */
+    Comparisons$.inboundSchema = Comparisons$inboundSchema;
+    /** @deprecated use `Comparisons$outboundSchema` instead. */
+    Comparisons$.outboundSchema = Comparisons$outboundSchema;
+})(Comparisons$ || (Comparisons$ = {}));
+export function comparisonsToJSON(comparisons) {
+    return JSON.stringify(Comparisons$outboundSchema.parse(comparisons));
+}
+export function comparisonsFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Comparisons$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Comparisons' from JSON`);
+}
+/** @internal */
+export const DataType$inboundSchema = z
+    .nativeEnum(DataType);
+/** @internal */
+export const DataType$outboundSchema = DataType$inboundSchema;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var DataType$;
+(function (DataType$) {
+    /** @deprecated use `DataType$inboundSchema` instead. */
+    DataType$.inboundSchema = DataType$inboundSchema;
+    /** @deprecated use `DataType$outboundSchema` instead. */
+    DataType$.outboundSchema = DataType$outboundSchema;
+})(DataType$ || (DataType$ = {}));
+/** @internal */
+export const Definitions$inboundSchema = z.object({
+    category: z.string(),
+    code: z.string(),
+    dataType: DataType$inboundSchema,
+    description: z.string(),
+    isHigherBetter: z.boolean().optional(),
+    nationalAverage: z.number().optional(),
+    subcategory: z.string(),
+    units: z.string().optional(),
+});
+/** @internal */
+export const Definitions$outboundSchema = z.object({
+    category: z.string(),
+    code: z.string(),
+    dataType: DataType$outboundSchema,
+    description: z.string(),
+    isHigherBetter: z.boolean().optional(),
+    nationalAverage: z.number().optional(),
+    subcategory: z.string(),
+    units: z.string().optional(),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var Definitions$;
+(function (Definitions$) {
+    /** @deprecated use `Definitions$inboundSchema` instead. */
+    Definitions$.inboundSchema = Definitions$inboundSchema;
+    /** @deprecated use `Definitions$outboundSchema` instead. */
+    Definitions$.outboundSchema = Definitions$outboundSchema;
+})(Definitions$ || (Definitions$ = {}));
+export function definitionsToJSON(definitions) {
+    return JSON.stringify(Definitions$outboundSchema.parse(definitions));
+}
+export function definitionsFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Definitions$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Definitions' from JSON`);
+}
+/** @internal */
+export const Confidence$inboundSchema = z.object({
+    lower: z.number().optional(),
+    upper: z.number().optional(),
+});
+/** @internal */
+export const Confidence$outboundSchema = z.object({
+    lower: z.number().optional(),
+    upper: z.number().optional(),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var Confidence$;
+(function (Confidence$) {
+    /** @deprecated use `Confidence$inboundSchema` instead. */
+    Confidence$.inboundSchema = Confidence$inboundSchema;
+    /** @deprecated use `Confidence$outboundSchema` instead. */
+    Confidence$.outboundSchema = Confidence$outboundSchema;
+})(Confidence$ || (Confidence$ = {}));
+export function confidenceToJSON(confidence) {
+    return JSON.stringify(Confidence$outboundSchema.parse(confidence));
+}
+export function confidenceFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Confidence$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Confidence' from JSON`);
+}
+/** @internal */
+export const Value$inboundSchema = z
+    .union([z.number(), z.string()]);
+/** @internal */
+export const Value$outboundSchema = z.union([z.number(), z.string()]);
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var Value$;
+(function (Value$) {
+    /** @deprecated use `Value$inboundSchema` instead. */
+    Value$.inboundSchema = Value$inboundSchema;
+    /** @deprecated use `Value$outboundSchema` instead. */
+    Value$.outboundSchema = Value$outboundSchema;
+})(Value$ || (Value$ = {}));
+export function valueToJSON(value) {
+    return JSON.stringify(Value$outboundSchema.parse(value));
+}
+export function valueFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Value$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Value' from JSON`);
+}
+/** @internal */
+export const Metrics$inboundSchema = z.object({
+    academicYear: z.string().optional(),
+    code: z.string(),
+    cohortType: z.string().optional(),
+    confidence: z.lazy(() => Confidence$inboundSchema).optional(),
+    metadata: z.record(z.nullable(z.any())).optional(),
+    value: z.union([z.number(), z.string()]),
+});
+/** @internal */
+export const Metrics$outboundSchema = z.object({
+    academicYear: z.string().optional(),
+    code: z.string(),
+    cohortType: z.string().optional(),
+    confidence: z.lazy(() => Confidence$outboundSchema).optional(),
+    metadata: z.record(z.nullable(z.any())).optional(),
+    value: z.union([z.number(), z.string()]),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var Metrics$;
+(function (Metrics$) {
+    /** @deprecated use `Metrics$inboundSchema` instead. */
+    Metrics$.inboundSchema = Metrics$inboundSchema;
+    /** @deprecated use `Metrics$outboundSchema` instead. */
+    Metrics$.outboundSchema = Metrics$outboundSchema;
+})(Metrics$ || (Metrics$ = {}));
+export function metricsToJSON(metrics) {
+    return JSON.stringify(Metrics$outboundSchema.parse(metrics));
+}
+export function metricsFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Metrics$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Metrics' from JSON`);
+}
+/** @internal */
+export const One$inboundSchema = z
+    .object({
+    comparisons: z.record(z.lazy(() => Comparisons$inboundSchema)).optional(),
+    definitions: z.array(z.lazy(() => Definitions$inboundSchema)).optional(),
+    metrics: z.array(z.lazy(() => Metrics$inboundSchema)),
+    schoolId: z.number(),
+});
+/** @internal */
+export const One$outboundSchema = z
+    .object({
+    comparisons: z.record(z.lazy(() => Comparisons$outboundSchema)).optional(),
+    definitions: z.array(z.lazy(() => Definitions$outboundSchema)).optional(),
+    metrics: z.array(z.lazy(() => Metrics$outboundSchema)),
+    schoolId: z.number(),
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var One$;
+(function (One$) {
+    /** @deprecated use `One$inboundSchema` instead. */
+    One$.inboundSchema = One$inboundSchema;
+    /** @deprecated use `One$outboundSchema` instead. */
+    One$.outboundSchema = One$outboundSchema;
+})(One$ || (One$ = {}));
+export function oneToJSON(one) {
+    return JSON.stringify(One$outboundSchema.parse(one));
+}
+export function oneFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => One$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'One' from JSON`);
+}
+/** @internal */
+export const GetSchoolMetricsData$inboundSchema = z.union([
+    z.array(z.lazy(() => One$inboundSchema)),
+    z.array(z.lazy(() => Two$inboundSchema)),
+]);
+/** @internal */
+export const GetSchoolMetricsData$outboundSchema = z.union([
+    z.array(z.lazy(() => One$outboundSchema)),
+    z.array(z.lazy(() => Two$outboundSchema)),
+]);
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetSchoolMetricsData$;
+(function (GetSchoolMetricsData$) {
+    /** @deprecated use `GetSchoolMetricsData$inboundSchema` instead. */
+    GetSchoolMetricsData$.inboundSchema = GetSchoolMetricsData$inboundSchema;
+    /** @deprecated use `GetSchoolMetricsData$outboundSchema` instead. */
+    GetSchoolMetricsData$.outboundSchema = GetSchoolMetricsData$outboundSchema;
+})(GetSchoolMetricsData$ || (GetSchoolMetricsData$ = {}));
+export function getSchoolMetricsDataToJSON(getSchoolMetricsData) {
+    return JSON.stringify(GetSchoolMetricsData$outboundSchema.parse(getSchoolMetricsData));
+}
+export function getSchoolMetricsDataFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolMetricsData$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolMetricsData' from JSON`);
+}
+/** @internal */
+export const GetSchoolMetricsObject$inboundSchema = z.nativeEnum(GetSchoolMetricsObject);
+/** @internal */
+export const GetSchoolMetricsObject$outboundSchema = GetSchoolMetricsObject$inboundSchema;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetSchoolMetricsObject$;
+(function (GetSchoolMetricsObject$) {
+    /** @deprecated use `GetSchoolMetricsObject$inboundSchema` instead. */
+    GetSchoolMetricsObject$.inboundSchema = GetSchoolMetricsObject$inboundSchema;
+    /** @deprecated use `GetSchoolMetricsObject$outboundSchema` instead. */
+    GetSchoolMetricsObject$.outboundSchema = GetSchoolMetricsObject$outboundSchema;
+})(GetSchoolMetricsObject$ || (GetSchoolMetricsObject$ = {}));
+/** @internal */
+export const GetSchoolMetricsResponseBody$inboundSchema = z.object({
+    data: z.union([
+        z.array(z.lazy(() => One$inboundSchema)),
+        z.array(z.lazy(() => Two$inboundSchema)),
+    ]),
+    has_more: z.boolean(),
+    object: GetSchoolMetricsObject$inboundSchema,
+    total_count: z.number().optional(),
+    url: z.string(),
+}).transform((v) => {
+    return remap$(v, {
+        "has_more": "hasMore",
+        "total_count": "totalCount",
+    });
+});
+/** @internal */
+export const GetSchoolMetricsResponseBody$outboundSchema = z.object({
+    data: z.union([
+        z.array(z.lazy(() => One$outboundSchema)),
+        z.array(z.lazy(() => Two$outboundSchema)),
+    ]),
+    hasMore: z.boolean(),
+    object: GetSchoolMetricsObject$outboundSchema,
+    totalCount: z.number().optional(),
+    url: z.string(),
+}).transform((v) => {
+    return remap$(v, {
+        hasMore: "has_more",
+        totalCount: "total_count",
+    });
+});
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetSchoolMetricsResponseBody$;
+(function (GetSchoolMetricsResponseBody$) {
+    /** @deprecated use `GetSchoolMetricsResponseBody$inboundSchema` instead. */
+    GetSchoolMetricsResponseBody$.inboundSchema = GetSchoolMetricsResponseBody$inboundSchema;
+    /** @deprecated use `GetSchoolMetricsResponseBody$outboundSchema` instead. */
+    GetSchoolMetricsResponseBody$.outboundSchema = GetSchoolMetricsResponseBody$outboundSchema;
+})(GetSchoolMetricsResponseBody$ || (GetSchoolMetricsResponseBody$ = {}));
+export function getSchoolMetricsResponseBodyToJSON(getSchoolMetricsResponseBody) {
+    return JSON.stringify(GetSchoolMetricsResponseBody$outboundSchema.parse(getSchoolMetricsResponseBody));
+}
+export function getSchoolMetricsResponseBodyFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolMetricsResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolMetricsResponseBody' from JSON`);
+}
+/** @internal */
+export const GetSchoolMetricsResponse$inboundSchema = z.union([
+    z.lazy(() => GetSchoolMetricsResponseBody$inboundSchema),
+    z.lazy(() => GetSchoolMetricsSchoolMetricsResponseBody$inboundSchema),
+    z.lazy(() => GetSchoolMetricsSchoolMetricsResponseResponseBody$inboundSchema),
+]);
+/** @internal */
+export const GetSchoolMetricsResponse$outboundSchema = z.union([
+    z.lazy(() => GetSchoolMetricsResponseBody$outboundSchema),
+    z.lazy(() => GetSchoolMetricsSchoolMetricsResponseBody$outboundSchema),
+    z.lazy(() => GetSchoolMetricsSchoolMetricsResponseResponseBody$outboundSchema),
+]);
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export var GetSchoolMetricsResponse$;
+(function (GetSchoolMetricsResponse$) {
+    /** @deprecated use `GetSchoolMetricsResponse$inboundSchema` instead. */
+    GetSchoolMetricsResponse$.inboundSchema = GetSchoolMetricsResponse$inboundSchema;
+    /** @deprecated use `GetSchoolMetricsResponse$outboundSchema` instead. */
+    GetSchoolMetricsResponse$.outboundSchema = GetSchoolMetricsResponse$outboundSchema;
+})(GetSchoolMetricsResponse$ || (GetSchoolMetricsResponse$ = {}));
+export function getSchoolMetricsResponseToJSON(getSchoolMetricsResponse) {
+    return JSON.stringify(GetSchoolMetricsResponse$outboundSchema.parse(getSchoolMetricsResponse));
+}
+export function getSchoolMetricsResponseFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetSchoolMetricsResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetSchoolMetricsResponse' from JSON`);
+}
+//# sourceMappingURL=getschoolmetrics.js.map