@vepler/sdk 1.9.11 → 1.10.1

package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts

@@ -0,0 +1,901 @@
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+/**
+ * Filter by metric category
+ */
+export declare const Category: {
+    readonly Ks2: "ks2";
+    readonly Ks4: "ks4";
+    readonly Ks5: "ks5";
+    readonly Pupil: "pupil";
+    readonly Finance: "finance";
+    readonly Ofsted: "ofsted";
+};
+/**
+ * Filter by metric category
+ */
+export type Category = ClosedEnum<typeof Category>;
+/**
+ * Filter by cohort type
+ */
+export declare const CohortType: {
+    readonly All: "all";
+    readonly Disadvantaged: "disadvantaged";
+    readonly Boys: "boys";
+    readonly Girls: "girls";
+    readonly Eal: "eal";
+    readonly SenSupport: "senSupport";
+    readonly Ehcp: "ehcp";
+    readonly English: "english";
+    readonly Unclassified: "unclassified";
+};
+/**
+ * Filter by cohort type
+ */
+export type CohortType = ClosedEnum<typeof CohortType>;
+/**
+ * Reporting period
+ */
+export declare const Period: {
+    readonly Annual: "annual";
+    readonly Termly: "termly";
+    readonly Monthly: "monthly";
+};
+/**
+ * Reporting period
+ */
+export type Period = ClosedEnum<typeof Period>;
+export type GetSchoolMetricsRequest = {
+    academicYear?: string | undefined;
+    /**
+     * Filter by metric category
+     */
+    category?: Category | undefined;
+    /**
+     * Filter by cohort type
+     */
+    cohortType?: CohortType | undefined;
+    endYear?: string | undefined;
+    /**
+     * Include national/regional/similar school comparisons
+     */
+    includeComparisons?: string | undefined;
+    /**
+     * Include metric definitions and metadata
+     */
+    includeDefinitions?: string | undefined;
+    limit?: string | undefined;
+    /**
+     * Comma-separated list of specific metric codes
+     */
+    metricCodes?: string | undefined;
+    offset?: string | undefined;
+    /**
+     * Reporting period
+     */
+    period?: Period | undefined;
+    /**
+     * Predefined metric profile
+     */
+    profile?: string | undefined;
+    /**
+     * Comma-separated list of school IDs
+     */
+    schoolIds: string;
+    startYear?: string | undefined;
+    /**
+     * Return time series data instead of point-in-time
+     */
+    timeseries?: string | undefined;
+};
+export declare const GetSchoolMetricsType: {
+    readonly ApiError: "api_error";
+    readonly InvalidRequestError: "invalid_request_error";
+    readonly AuthenticationError: "authentication_error";
+    readonly RateLimitError: "rate_limit_error";
+};
+export type GetSchoolMetricsType = ClosedEnum<typeof GetSchoolMetricsType>;
+export type GetSchoolMetricsSchoolMetricsError = {
+    code?: string | undefined;
+    message: string;
+    param?: string | undefined;
+    type: GetSchoolMetricsType;
+};
+/**
+ * Error response structure
+ */
+export type GetSchoolMetricsSchoolMetricsResponseResponseBody = {
+    error: GetSchoolMetricsSchoolMetricsError;
+};
+export declare const Type: {
+    readonly ApiError: "api_error";
+    readonly InvalidRequestError: "invalid_request_error";
+    readonly AuthenticationError: "authentication_error";
+    readonly RateLimitError: "rate_limit_error";
+};
+export type Type = ClosedEnum<typeof Type>;
+export type GetSchoolMetricsError = {
+    code?: string | undefined;
+    message: string;
+    param?: string | undefined;
+    type: Type;
+};
+/**
+ * Error response structure
+ */
+export type GetSchoolMetricsSchoolMetricsResponseBody = {
+    error: GetSchoolMetricsError;
+};
+export declare const GetSchoolMetricsDataType: {
+    readonly Percentage: "percentage";
+    readonly Score: "score";
+    readonly Count: "count";
+    readonly Currency: "currency";
+    readonly Text: "text";
+};
+export type GetSchoolMetricsDataType = ClosedEnum<typeof GetSchoolMetricsDataType>;
+/**
+ * Metric definition and metadata
+ */
+export type GetSchoolMetricsDefinitions = {
+    category: string;
+    code: string;
+    dataType: GetSchoolMetricsDataType;
+    description: string;
+    isHigherBetter?: boolean | undefined;
+    nationalAverage?: number | undefined;
+    subcategory: string;
+    units?: string | undefined;
+};
+export type Values = number | string;
+/**
+ * Time series data point with multiple metric values
+ */
+export type Series = {
+    values: {
+        [k: string]: number | string;
+    };
+    year: string;
+};
+/**
+ * School metrics time series response
+ */
+export type Two = {
+    definitions?: Array<GetSchoolMetricsDefinitions> | undefined;
+    metricCodes: Array<string>;
+    schoolId: number;
+    series: Array<Series>;
+};
+/**
+ * Comparison data against various benchmarks
+ */
+export type Comparisons = {
+    localAuthority?: number | undefined;
+    national?: number | undefined;
+    regional?: number | undefined;
+    similarSchools?: number | undefined;
+};
+export declare const DataType: {
+    readonly Percentage: "percentage";
+    readonly Score: "score";
+    readonly Count: "count";
+    readonly Currency: "currency";
+    readonly Text: "text";
+};
+export type DataType = ClosedEnum<typeof DataType>;
+/**
+ * Metric definition and metadata
+ */
+export type Definitions = {
+    category: string;
+    code: string;
+    dataType: DataType;
+    description: string;
+    isHigherBetter?: boolean | undefined;
+    nationalAverage?: number | undefined;
+    subcategory: string;
+    units?: string | undefined;
+};
+/**
+ * Confidence interval for metric values
+ */
+export type Confidence = {
+    lower?: number | undefined;
+    upper?: number | undefined;
+};
+export type Value = number | string;
+/**
+ * Individual metric value with metadata
+ */
+export type Metrics = {
+    academicYear?: string | undefined;
+    code: string;
+    cohortType?: string | undefined;
+    /**
+     * Confidence interval for metric values
+     */
+    confidence?: Confidence | undefined;
+    metadata?: {
+        [k: string]: any | null;
+    } | undefined;
+    value: number | string;
+};
+/**
+ * School metrics response for point-in-time data
+ */
+export type One = {
+    comparisons?: {
+        [k: string]: Comparisons;
+    } | undefined;
+    definitions?: Array<Definitions> | undefined;
+    metrics: Array<Metrics>;
+    schoolId: number;
+};
+export type GetSchoolMetricsData = Array<One> | Array<Two>;
+export declare const GetSchoolMetricsObject: {
+    readonly List: "list";
+};
+export type GetSchoolMetricsObject = ClosedEnum<typeof GetSchoolMetricsObject>;
+/**
+ * Paginated metrics response envelope
+ */
+export type GetSchoolMetricsResponseBody = {
+    data: Array<One> | Array<Two>;
+    hasMore: boolean;
+    object: GetSchoolMetricsObject;
+    totalCount?: number | undefined;
+    url: string;
+};
+export type GetSchoolMetricsResponse = GetSchoolMetricsResponseBody | GetSchoolMetricsSchoolMetricsResponseBody | GetSchoolMetricsSchoolMetricsResponseResponseBody;
+/** @internal */
+export declare const Category$inboundSchema: z.ZodNativeEnum<typeof Category>;
+/** @internal */
+export declare const Category$outboundSchema: z.ZodNativeEnum<typeof Category>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Category$ {
+    /** @deprecated use `Category$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly Ks2: "ks2";
+        readonly Ks4: "ks4";
+        readonly Ks5: "ks5";
+        readonly Pupil: "pupil";
+        readonly Finance: "finance";
+        readonly Ofsted: "ofsted";
+    }>;
+    /** @deprecated use `Category$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly Ks2: "ks2";
+        readonly Ks4: "ks4";
+        readonly Ks5: "ks5";
+        readonly Pupil: "pupil";
+        readonly Finance: "finance";
+        readonly Ofsted: "ofsted";
+    }>;
+}
+/** @internal */
+export declare const CohortType$inboundSchema: z.ZodNativeEnum<typeof CohortType>;
+/** @internal */
+export declare const CohortType$outboundSchema: z.ZodNativeEnum<typeof CohortType>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace CohortType$ {
+    /** @deprecated use `CohortType$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly All: "all";
+        readonly Disadvantaged: "disadvantaged";
+        readonly Boys: "boys";
+        readonly Girls: "girls";
+        readonly Eal: "eal";
+        readonly SenSupport: "senSupport";
+        readonly Ehcp: "ehcp";
+        readonly English: "english";
+        readonly Unclassified: "unclassified";
+    }>;
+    /** @deprecated use `CohortType$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly All: "all";
+        readonly Disadvantaged: "disadvantaged";
+        readonly Boys: "boys";
+        readonly Girls: "girls";
+        readonly Eal: "eal";
+        readonly SenSupport: "senSupport";
+        readonly Ehcp: "ehcp";
+        readonly English: "english";
+        readonly Unclassified: "unclassified";
+    }>;
+}
+/** @internal */
+export declare const Period$inboundSchema: z.ZodNativeEnum<typeof Period>;
+/** @internal */
+export declare const Period$outboundSchema: z.ZodNativeEnum<typeof Period>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Period$ {
+    /** @deprecated use `Period$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly Annual: "annual";
+        readonly Termly: "termly";
+        readonly Monthly: "monthly";
+    }>;
+    /** @deprecated use `Period$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly Annual: "annual";
+        readonly Termly: "termly";
+        readonly Monthly: "monthly";
+    }>;
+}
+/** @internal */
+export declare const GetSchoolMetricsRequest$inboundSchema: z.ZodType<GetSchoolMetricsRequest, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetSchoolMetricsRequest$Outbound = {
+    academicYear?: string | undefined;
+    category?: string | undefined;
+    cohortType?: string | undefined;
+    endYear?: string | undefined;
+    includeComparisons?: string | undefined;
+    includeDefinitions?: string | undefined;
+    limit?: string | undefined;
+    metricCodes?: string | undefined;
+    offset?: string | undefined;
+    period?: string | undefined;
+    profile?: string | undefined;
+    schoolIds: string;
+    startYear?: string | undefined;
+    timeseries?: string | undefined;
+};
+/** @internal */
+export declare const GetSchoolMetricsRequest$outboundSchema: z.ZodType<GetSchoolMetricsRequest$Outbound, z.ZodTypeDef, GetSchoolMetricsRequest>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetSchoolMetricsRequest$ {
+    /** @deprecated use `GetSchoolMetricsRequest$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetSchoolMetricsRequest, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetSchoolMetricsRequest$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetSchoolMetricsRequest$Outbound, z.ZodTypeDef, GetSchoolMetricsRequest>;
+    /** @deprecated use `GetSchoolMetricsRequest$Outbound` instead. */
+    type Outbound = GetSchoolMetricsRequest$Outbound;
+}
+export declare function getSchoolMetricsRequestToJSON(getSchoolMetricsRequest: GetSchoolMetricsRequest): string;
+export declare function getSchoolMetricsRequestFromJSON(jsonString: string): SafeParseResult<GetSchoolMetricsRequest, SDKValidationError>;
+/** @internal */
+export declare const GetSchoolMetricsType$inboundSchema: z.ZodNativeEnum<typeof GetSchoolMetricsType>;
+/** @internal */
+export declare const GetSchoolMetricsType$outboundSchema: z.ZodNativeEnum<typeof GetSchoolMetricsType>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetSchoolMetricsType$ {
+    /** @deprecated use `GetSchoolMetricsType$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly ApiError: "api_error";
+        readonly InvalidRequestError: "invalid_request_error";
+        readonly AuthenticationError: "authentication_error";
+        readonly RateLimitError: "rate_limit_error";
+    }>;
+    /** @deprecated use `GetSchoolMetricsType$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly ApiError: "api_error";
+        readonly InvalidRequestError: "invalid_request_error";
+        readonly AuthenticationError: "authentication_error";
+        readonly RateLimitError: "rate_limit_error";
+    }>;
+}
+/** @internal */
+export declare const GetSchoolMetricsSchoolMetricsError$inboundSchema: z.ZodType<GetSchoolMetricsSchoolMetricsError, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetSchoolMetricsSchoolMetricsError$Outbound = {
+    code?: string | undefined;
+    message: string;
+    param?: string | undefined;
+    type: string;
+};
+/** @internal */
+export declare const GetSchoolMetricsSchoolMetricsError$outboundSchema: z.ZodType<GetSchoolMetricsSchoolMetricsError$Outbound, z.ZodTypeDef, GetSchoolMetricsSchoolMetricsError>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetSchoolMetricsSchoolMetricsError$ {
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsError$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetSchoolMetricsSchoolMetricsError, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsError$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetSchoolMetricsSchoolMetricsError$Outbound, z.ZodTypeDef, GetSchoolMetricsSchoolMetricsError>;
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsError$Outbound` instead. */
+    type Outbound = GetSchoolMetricsSchoolMetricsError$Outbound;
+}
+export declare function getSchoolMetricsSchoolMetricsErrorToJSON(getSchoolMetricsSchoolMetricsError: GetSchoolMetricsSchoolMetricsError): string;
+export declare function getSchoolMetricsSchoolMetricsErrorFromJSON(jsonString: string): SafeParseResult<GetSchoolMetricsSchoolMetricsError, SDKValidationError>;
+/** @internal */
+export declare const GetSchoolMetricsSchoolMetricsResponseResponseBody$inboundSchema: z.ZodType<GetSchoolMetricsSchoolMetricsResponseResponseBody, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetSchoolMetricsSchoolMetricsResponseResponseBody$Outbound = {
+    error: GetSchoolMetricsSchoolMetricsError$Outbound;
+};
+/** @internal */
+export declare const GetSchoolMetricsSchoolMetricsResponseResponseBody$outboundSchema: z.ZodType<GetSchoolMetricsSchoolMetricsResponseResponseBody$Outbound, z.ZodTypeDef, GetSchoolMetricsSchoolMetricsResponseResponseBody>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetSchoolMetricsSchoolMetricsResponseResponseBody$ {
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseResponseBody$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetSchoolMetricsSchoolMetricsResponseResponseBody, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseResponseBody$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetSchoolMetricsSchoolMetricsResponseResponseBody$Outbound, z.ZodTypeDef, GetSchoolMetricsSchoolMetricsResponseResponseBody>;
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseResponseBody$Outbound` instead. */
+    type Outbound = GetSchoolMetricsSchoolMetricsResponseResponseBody$Outbound;
+}
+export declare function getSchoolMetricsSchoolMetricsResponseResponseBodyToJSON(getSchoolMetricsSchoolMetricsResponseResponseBody: GetSchoolMetricsSchoolMetricsResponseResponseBody): string;
+export declare function getSchoolMetricsSchoolMetricsResponseResponseBodyFromJSON(jsonString: string): SafeParseResult<GetSchoolMetricsSchoolMetricsResponseResponseBody, SDKValidationError>;
+/** @internal */
+export declare const Type$inboundSchema: z.ZodNativeEnum<typeof Type>;
+/** @internal */
+export declare const Type$outboundSchema: z.ZodNativeEnum<typeof Type>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Type$ {
+    /** @deprecated use `Type$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly ApiError: "api_error";
+        readonly InvalidRequestError: "invalid_request_error";
+        readonly AuthenticationError: "authentication_error";
+        readonly RateLimitError: "rate_limit_error";
+    }>;
+    /** @deprecated use `Type$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly ApiError: "api_error";
+        readonly InvalidRequestError: "invalid_request_error";
+        readonly AuthenticationError: "authentication_error";
+        readonly RateLimitError: "rate_limit_error";
+    }>;
+}
+/** @internal */
+export declare const GetSchoolMetricsError$inboundSchema: z.ZodType<GetSchoolMetricsError, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetSchoolMetricsError$Outbound = {
+    code?: string | undefined;
+    message: string;
+    param?: string | undefined;
+    type: string;
+};
+/** @internal */
+export declare const GetSchoolMetricsError$outboundSchema: z.ZodType<GetSchoolMetricsError$Outbound, z.ZodTypeDef, GetSchoolMetricsError>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetSchoolMetricsError$ {
+    /** @deprecated use `GetSchoolMetricsError$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetSchoolMetricsError, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetSchoolMetricsError$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetSchoolMetricsError$Outbound, z.ZodTypeDef, GetSchoolMetricsError>;
+    /** @deprecated use `GetSchoolMetricsError$Outbound` instead. */
+    type Outbound = GetSchoolMetricsError$Outbound;
+}
+export declare function getSchoolMetricsErrorToJSON(getSchoolMetricsError: GetSchoolMetricsError): string;
+export declare function getSchoolMetricsErrorFromJSON(jsonString: string): SafeParseResult<GetSchoolMetricsError, SDKValidationError>;
+/** @internal */
+export declare const GetSchoolMetricsSchoolMetricsResponseBody$inboundSchema: z.ZodType<GetSchoolMetricsSchoolMetricsResponseBody, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetSchoolMetricsSchoolMetricsResponseBody$Outbound = {
+    error: GetSchoolMetricsError$Outbound;
+};
+/** @internal */
+export declare const GetSchoolMetricsSchoolMetricsResponseBody$outboundSchema: z.ZodType<GetSchoolMetricsSchoolMetricsResponseBody$Outbound, z.ZodTypeDef, GetSchoolMetricsSchoolMetricsResponseBody>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetSchoolMetricsSchoolMetricsResponseBody$ {
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseBody$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetSchoolMetricsSchoolMetricsResponseBody, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseBody$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetSchoolMetricsSchoolMetricsResponseBody$Outbound, z.ZodTypeDef, GetSchoolMetricsSchoolMetricsResponseBody>;
+    /** @deprecated use `GetSchoolMetricsSchoolMetricsResponseBody$Outbound` instead. */
+    type Outbound = GetSchoolMetricsSchoolMetricsResponseBody$Outbound;
+}
+export declare function getSchoolMetricsSchoolMetricsResponseBodyToJSON(getSchoolMetricsSchoolMetricsResponseBody: GetSchoolMetricsSchoolMetricsResponseBody): string;
+export declare function getSchoolMetricsSchoolMetricsResponseBodyFromJSON(jsonString: string): SafeParseResult<GetSchoolMetricsSchoolMetricsResponseBody, SDKValidationError>;
+/** @internal */
+export declare const GetSchoolMetricsDataType$inboundSchema: z.ZodNativeEnum<typeof GetSchoolMetricsDataType>;
+/** @internal */
+export declare const GetSchoolMetricsDataType$outboundSchema: z.ZodNativeEnum<typeof GetSchoolMetricsDataType>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetSchoolMetricsDataType$ {
+    /** @deprecated use `GetSchoolMetricsDataType$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly Percentage: "percentage";
+        readonly Score: "score";
+        readonly Count: "count";
+        readonly Currency: "currency";
+        readonly Text: "text";
+    }>;
+    /** @deprecated use `GetSchoolMetricsDataType$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly Percentage: "percentage";
+        readonly Score: "score";
+        readonly Count: "count";
+        readonly Currency: "currency";
+        readonly Text: "text";
+    }>;
+}
+/** @internal */
+export declare const GetSchoolMetricsDefinitions$inboundSchema: z.ZodType<GetSchoolMetricsDefinitions, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetSchoolMetricsDefinitions$Outbound = {
+    category: string;
+    code: string;
+    dataType: string;
+    description: string;
+    isHigherBetter?: boolean | undefined;
+    nationalAverage?: number | undefined;
+    subcategory: string;
+    units?: string | undefined;
+};
+/** @internal */
+export declare const GetSchoolMetricsDefinitions$outboundSchema: z.ZodType<GetSchoolMetricsDefinitions$Outbound, z.ZodTypeDef, GetSchoolMetricsDefinitions>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetSchoolMetricsDefinitions$ {
+    /** @deprecated use `GetSchoolMetricsDefinitions$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetSchoolMetricsDefinitions, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetSchoolMetricsDefinitions$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetSchoolMetricsDefinitions$Outbound, z.ZodTypeDef, GetSchoolMetricsDefinitions>;
+    /** @deprecated use `GetSchoolMetricsDefinitions$Outbound` instead. */
+    type Outbound = GetSchoolMetricsDefinitions$Outbound;
+}
+export declare function getSchoolMetricsDefinitionsToJSON(getSchoolMetricsDefinitions: GetSchoolMetricsDefinitions): string;
+export declare function getSchoolMetricsDefinitionsFromJSON(jsonString: string): SafeParseResult<GetSchoolMetricsDefinitions, SDKValidationError>;
+/** @internal */
+export declare const Values$inboundSchema: z.ZodType<Values, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Values$Outbound = number | string;
+/** @internal */
+export declare const Values$outboundSchema: z.ZodType<Values$Outbound, z.ZodTypeDef, Values>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Values$ {
+    /** @deprecated use `Values$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Values, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Values$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Values$Outbound, z.ZodTypeDef, Values>;
+    /** @deprecated use `Values$Outbound` instead. */
+    type Outbound = Values$Outbound;
+}
+export declare function valuesToJSON(values: Values): string;
+export declare function valuesFromJSON(jsonString: string): SafeParseResult<Values, SDKValidationError>;
+/** @internal */
+export declare const Series$inboundSchema: z.ZodType<Series, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Series$Outbound = {
+    values: {
+        [k: string]: number | string;
+    };
+    year: string;
+};
+/** @internal */
+export declare const Series$outboundSchema: z.ZodType<Series$Outbound, z.ZodTypeDef, Series>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Series$ {
+    /** @deprecated use `Series$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Series, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Series$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Series$Outbound, z.ZodTypeDef, Series>;
+    /** @deprecated use `Series$Outbound` instead. */
+    type Outbound = Series$Outbound;
+}
+export declare function seriesToJSON(series: Series): string;
+export declare function seriesFromJSON(jsonString: string): SafeParseResult<Series, SDKValidationError>;
+/** @internal */
+export declare const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Two$Outbound = {
+    definitions?: Array<GetSchoolMetricsDefinitions$Outbound> | undefined;
+    metricCodes: Array<string>;
+    schoolId: number;
+    series: Array<Series$Outbound>;
+};
+/** @internal */
+export declare const Two$outboundSchema: z.ZodType<Two$Outbound, z.ZodTypeDef, Two>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Two$ {
+    /** @deprecated use `Two$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Two$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Two$Outbound, z.ZodTypeDef, Two>;
+    /** @deprecated use `Two$Outbound` instead. */
+    type Outbound = Two$Outbound;
+}
+export declare function twoToJSON(two: Two): string;
+export declare function twoFromJSON(jsonString: string): SafeParseResult<Two, SDKValidationError>;
+/** @internal */
+export declare const Comparisons$inboundSchema: z.ZodType<Comparisons, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Comparisons$Outbound = {
+    localAuthority?: number | undefined;
+    national?: number | undefined;
+    regional?: number | undefined;
+    similarSchools?: number | undefined;
+};
+/** @internal */
+export declare const Comparisons$outboundSchema: z.ZodType<Comparisons$Outbound, z.ZodTypeDef, Comparisons>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Comparisons$ {
+    /** @deprecated use `Comparisons$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Comparisons, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Comparisons$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Comparisons$Outbound, z.ZodTypeDef, Comparisons>;
+    /** @deprecated use `Comparisons$Outbound` instead. */
+    type Outbound = Comparisons$Outbound;
+}
+export declare function comparisonsToJSON(comparisons: Comparisons): string;
+export declare function comparisonsFromJSON(jsonString: string): SafeParseResult<Comparisons, SDKValidationError>;
+/** @internal */
+export declare const DataType$inboundSchema: z.ZodNativeEnum<typeof DataType>;
+/** @internal */
+export declare const DataType$outboundSchema: z.ZodNativeEnum<typeof DataType>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace DataType$ {
+    /** @deprecated use `DataType$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly Percentage: "percentage";
+        readonly Score: "score";
+        readonly Count: "count";
+        readonly Currency: "currency";
+        readonly Text: "text";
+    }>;
+    /** @deprecated use `DataType$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly Percentage: "percentage";
+        readonly Score: "score";
+        readonly Count: "count";
+        readonly Currency: "currency";
+        readonly Text: "text";
+    }>;
+}
+/** @internal */
+export declare const Definitions$inboundSchema: z.ZodType<Definitions, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Definitions$Outbound = {
+    category: string;
+    code: string;
+    dataType: string;
+    description: string;
+    isHigherBetter?: boolean | undefined;
+    nationalAverage?: number | undefined;
+    subcategory: string;
+    units?: string | undefined;
+};
+/** @internal */
+export declare const Definitions$outboundSchema: z.ZodType<Definitions$Outbound, z.ZodTypeDef, Definitions>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Definitions$ {
+    /** @deprecated use `Definitions$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Definitions, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Definitions$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Definitions$Outbound, z.ZodTypeDef, Definitions>;
+    /** @deprecated use `Definitions$Outbound` instead. */
+    type Outbound = Definitions$Outbound;
+}
+export declare function definitionsToJSON(definitions: Definitions): string;
+export declare function definitionsFromJSON(jsonString: string): SafeParseResult<Definitions, SDKValidationError>;
+/** @internal */
+export declare const Confidence$inboundSchema: z.ZodType<Confidence, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Confidence$Outbound = {
+    lower?: number | undefined;
+    upper?: number | undefined;
+};
+/** @internal */
+export declare const Confidence$outboundSchema: z.ZodType<Confidence$Outbound, z.ZodTypeDef, Confidence>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Confidence$ {
+    /** @deprecated use `Confidence$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Confidence, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Confidence$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Confidence$Outbound, z.ZodTypeDef, Confidence>;
+    /** @deprecated use `Confidence$Outbound` instead. */
+    type Outbound = Confidence$Outbound;
+}
+export declare function confidenceToJSON(confidence: Confidence): string;
+export declare function confidenceFromJSON(jsonString: string): SafeParseResult<Confidence, SDKValidationError>;
+/** @internal */
+export declare const Value$inboundSchema: z.ZodType<Value, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Value$Outbound = number | string;
+/** @internal */
+export declare const Value$outboundSchema: z.ZodType<Value$Outbound, z.ZodTypeDef, Value>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Value$ {
+    /** @deprecated use `Value$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Value, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Value$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Value$Outbound, z.ZodTypeDef, Value>;
+    /** @deprecated use `Value$Outbound` instead. */
+    type Outbound = Value$Outbound;
+}
+export declare function valueToJSON(value: Value): string;
+export declare function valueFromJSON(jsonString: string): SafeParseResult<Value, SDKValidationError>;
+/** @internal */
+export declare const Metrics$inboundSchema: z.ZodType<Metrics, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Metrics$Outbound = {
+    academicYear?: string | undefined;
+    code: string;
+    cohortType?: string | undefined;
+    confidence?: Confidence$Outbound | undefined;
+    metadata?: {
+        [k: string]: any | null;
+    } | undefined;
+    value: number | string;
+};
+/** @internal */
+export declare const Metrics$outboundSchema: z.ZodType<Metrics$Outbound, z.ZodTypeDef, Metrics>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Metrics$ {
+    /** @deprecated use `Metrics$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Metrics, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Metrics$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Metrics$Outbound, z.ZodTypeDef, Metrics>;
+    /** @deprecated use `Metrics$Outbound` instead. */
+    type Outbound = Metrics$Outbound;
+}
+export declare function metricsToJSON(metrics: Metrics): string;
+export declare function metricsFromJSON(jsonString: string): SafeParseResult<Metrics, SDKValidationError>;
+/** @internal */
+export declare const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown>;
+/** @internal */
+export type One$Outbound = {
+    comparisons?: {
+        [k: string]: Comparisons$Outbound;
+    } | undefined;
+    definitions?: Array<Definitions$Outbound> | undefined;
+    metrics: Array<Metrics$Outbound>;
+    schoolId: number;
+};
+/** @internal */
+export declare const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace One$ {
+    /** @deprecated use `One$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown>;
+    /** @deprecated use `One$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One>;
+    /** @deprecated use `One$Outbound` instead. */
+    type Outbound = One$Outbound;
+}
+export declare function oneToJSON(one: One): string;
+export declare function oneFromJSON(jsonString: string): SafeParseResult<One, SDKValidationError>;
+/** @internal */
+export declare const GetSchoolMetricsData$inboundSchema: z.ZodType<GetSchoolMetricsData, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetSchoolMetricsData$Outbound = Array<One$Outbound> | Array<Two$Outbound>;
+/** @internal */
+export declare const GetSchoolMetricsData$outboundSchema: z.ZodType<GetSchoolMetricsData$Outbound, z.ZodTypeDef, GetSchoolMetricsData>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetSchoolMetricsData$ {
+    /** @deprecated use `GetSchoolMetricsData$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetSchoolMetricsData, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetSchoolMetricsData$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetSchoolMetricsData$Outbound, z.ZodTypeDef, GetSchoolMetricsData>;
+    /** @deprecated use `GetSchoolMetricsData$Outbound` instead. */
+    type Outbound = GetSchoolMetricsData$Outbound;
+}
+export declare function getSchoolMetricsDataToJSON(getSchoolMetricsData: GetSchoolMetricsData): string;
+export declare function getSchoolMetricsDataFromJSON(jsonString: string): SafeParseResult<GetSchoolMetricsData, SDKValidationError>;
+/** @internal */
+export declare const GetSchoolMetricsObject$inboundSchema: z.ZodNativeEnum<typeof GetSchoolMetricsObject>;
+/** @internal */
+export declare const GetSchoolMetricsObject$outboundSchema: z.ZodNativeEnum<typeof GetSchoolMetricsObject>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetSchoolMetricsObject$ {
+    /** @deprecated use `GetSchoolMetricsObject$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly List: "list";
+    }>;
+    /** @deprecated use `GetSchoolMetricsObject$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly List: "list";
+    }>;
+}
+/** @internal */
+export declare const GetSchoolMetricsResponseBody$inboundSchema: z.ZodType<GetSchoolMetricsResponseBody, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetSchoolMetricsResponseBody$Outbound = {
+    data: Array<One$Outbound> | Array<Two$Outbound>;
+    has_more: boolean;
+    object: string;
+    total_count?: number | undefined;
+    url: string;
+};
+/** @internal */
+export declare const GetSchoolMetricsResponseBody$outboundSchema: z.ZodType<GetSchoolMetricsResponseBody$Outbound, z.ZodTypeDef, GetSchoolMetricsResponseBody>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetSchoolMetricsResponseBody$ {
+    /** @deprecated use `GetSchoolMetricsResponseBody$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetSchoolMetricsResponseBody, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetSchoolMetricsResponseBody$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetSchoolMetricsResponseBody$Outbound, z.ZodTypeDef, GetSchoolMetricsResponseBody>;
+    /** @deprecated use `GetSchoolMetricsResponseBody$Outbound` instead. */
+    type Outbound = GetSchoolMetricsResponseBody$Outbound;
+}
+export declare function getSchoolMetricsResponseBodyToJSON(getSchoolMetricsResponseBody: GetSchoolMetricsResponseBody): string;
+export declare function getSchoolMetricsResponseBodyFromJSON(jsonString: string): SafeParseResult<GetSchoolMetricsResponseBody, SDKValidationError>;
+/** @internal */
+export declare const GetSchoolMetricsResponse$inboundSchema: z.ZodType<GetSchoolMetricsResponse, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetSchoolMetricsResponse$Outbound = GetSchoolMetricsResponseBody$Outbound | GetSchoolMetricsSchoolMetricsResponseBody$Outbound | GetSchoolMetricsSchoolMetricsResponseResponseBody$Outbound;
+/** @internal */
+export declare const GetSchoolMetricsResponse$outboundSchema: z.ZodType<GetSchoolMetricsResponse$Outbound, z.ZodTypeDef, GetSchoolMetricsResponse>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetSchoolMetricsResponse$ {
+    /** @deprecated use `GetSchoolMetricsResponse$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetSchoolMetricsResponse, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetSchoolMetricsResponse$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetSchoolMetricsResponse$Outbound, z.ZodTypeDef, GetSchoolMetricsResponse>;
+    /** @deprecated use `GetSchoolMetricsResponse$Outbound` instead. */
+    type Outbound = GetSchoolMetricsResponse$Outbound;
+}
+export declare function getSchoolMetricsResponseToJSON(getSchoolMetricsResponse: GetSchoolMetricsResponse): string;
+export declare function getSchoolMetricsResponseFromJSON(jsonString: string): SafeParseResult<GetSchoolMetricsResponse, SDKValidationError>;
+//# sourceMappingURL=getschoolmetrics.d.ts.map