@vepler/sdk 2.131.2 → 2.133.0

package/dist/commonjs/funcs/airQualityPoint.d.ts

@@ -0,0 +1,22 @@
+import { SDKCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../sdk/models/errors/httpclienterrors.js";
+import * as errors from "../sdk/models/errors/index.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import * as shared from "../sdk/models/shared/index.js";
+import { APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+/**
+ * Coordinate-exact air quality with property-decay overlay
+ *
+ * @remarks
+ * Returns property-exact air-quality data for a single (lat, lon) coordinate. Reads the 1km cell substrate, then overlays exact distances to nearest road, nearest motorway, nearby installations, and regulatory zones. A versioned decay model (Karner-2010 exponential, AURN-calibrated) adjusts pollutant concentrations from the cell-level PCM background to the property point.
+ *
+ * Use `/point` for property-level decisions (valuation, mortgage, insurance). Use `/query` for bulk neighbourhood-scale lookups (bbox, postcode, outcode). Both return the same envelope shape; `/point` adds `coordinate`, `cellId`, and `decay` blocks.
+ *
+ * Premium attributes (`nearestRoad`, `nearestMotorway`, `installations`) and the explain-mode calculation trail (`decay.calculation`) require the `air-quality:premium` permission.
+ */
+export declare function airQualityPoint(client: SDKCore, request?: shared.AirQualityPointRequest | undefined, options?: RequestOptions): APIPromise<Result<shared.AirQualityPointResponse, errors.QueryAirQualityPointResponseBody | errors.QueryAirQualityPointAirQualityResponseBody | errors.QueryAirQualityPointAirQualityResponseResponseBody | errors.QueryAirQualityPointAirQualityResponse503ResponseBody | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
+//# sourceMappingURL=airQualityPoint.d.ts.map

package/dist/commonjs/funcs/airQualityPoint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"airQualityPoint.d.ts","sourceRoot":"","sources":["../../../src/funcs/airQualityPoint.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAMrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,iDAAiD,CAAC;AAC1F,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AAChF,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAW,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,MAAM,CAAC,sBAAsB,GAAG,SAAS,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,uBAAuB,EAC5B,MAAM,CAAC,gCAAgC,GACvC,MAAM,CAAC,0CAA0C,GACjD,MAAM,CAAC,kDAAkD,GACzD,MAAM,CAAC,qDAAqD,GAC5D,YAAY,GACZ,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}

package/dist/commonjs/funcs/airQualityPoint.js

@@ -0,0 +1,126 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.airQualityPoint = airQualityPoint;
+const encodings_js_1 = require("../lib/encodings.js");
+const http_js_1 = require("../lib/http.js");
+const M = __importStar(require("../lib/matchers.js"));
+const primitives_js_1 = require("../lib/primitives.js");
+const schemas_js_1 = require("../lib/schemas.js");
+const security_js_1 = require("../lib/security.js");
+const url_js_1 = require("../lib/url.js");
+const errors = __importStar(require("../sdk/models/errors/index.js"));
+const shared = __importStar(require("../sdk/models/shared/index.js"));
+const async_js_1 = require("../sdk/types/async.js");
+/**
+ * Coordinate-exact air quality with property-decay overlay
+ *
+ * @remarks
+ * Returns property-exact air-quality data for a single (lat, lon) coordinate. Reads the 1km cell substrate, then overlays exact distances to nearest road, nearest motorway, nearby installations, and regulatory zones. A versioned decay model (Karner-2010 exponential, AURN-calibrated) adjusts pollutant concentrations from the cell-level PCM background to the property point.
+ *
+ * Use `/point` for property-level decisions (valuation, mortgage, insurance). Use `/query` for bulk neighbourhood-scale lookups (bbox, postcode, outcode). Both return the same envelope shape; `/point` adds `coordinate`, `cellId`, and `decay` blocks.
+ *
+ * Premium attributes (`nearestRoad`, `nearestMotorway`, `installations`) and the explain-mode calculation trail (`decay.calculation`) require the `air-quality:premium` permission.
+ */
+function airQualityPoint(client, request, options) {
+    return new async_js_1.APIPromise($do(client, request, options));
+}
+async function $do(client, request, options) {
+    const parsed = (0, schemas_js_1.safeParse)(request, (value) => shared.AirQualityPointRequest$outboundSchema.optional().parse(value), "Input validation failed");
+    if (!parsed.ok) {
+        return [parsed, { status: "invalid" }];
+    }
+    const payload = parsed.value;
+    const body = payload === undefined
+        ? null
+        : (0, encodings_js_1.encodeJSON)("body", payload, { explode: true });
+    const path = (0, url_js_1.pathToFunc)("/v1/air-quality/point")();
+    const headers = new Headers((0, primitives_js_1.compactMap)({
+        "Content-Type": "application/json",
+        Accept: "application/json",
+    }));
+    const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKeyAuth);
+    const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+    const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
+    const context = {
+        options: client._options,
+        baseURL: options?.serverURL ?? client._baseURL ?? "",
+        operationID: "queryAirQualityPoint",
+        oAuth2Scopes: null,
+        resolvedSecurity: requestSecurity,
+        securitySource: client._options.apiKeyAuth,
+        retryConfig: options?.retries
+            || client._options.retryConfig
+            || { strategy: "none" },
+        retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    };
+    const requestRes = client._createRequest(context, {
+        security: requestSecurity,
+        method: "POST",
+        baseURL: options?.serverURL,
+        path: path,
+        headers: headers,
+        body: body,
+        userAgent: client._options.userAgent,
+        timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+    }, options);
+    if (!requestRes.ok) {
+        return [requestRes, { status: "invalid" }];
+    }
+    const req = requestRes.value;
+    const doResult = await client._do(req, {
+        context,
+        isErrorStatusCode: (statusCode) => (0, http_js_1.matchStatusCode)({ status: statusCode }, ["4XX", "5XX"]),
+        retryConfig: context.retryConfig,
+        retryCodes: context.retryCodes,
+    });
+    if (!doResult.ok) {
+        return [doResult, { status: "request-error", request: req }];
+    }
+    const response = doResult.value;
+    const responseFields = {
+        HttpMeta: { Response: response, Request: req },
+    };
+    const [result] = await M.match(M.json(200, shared.AirQualityPointResponse$inboundSchema), M.jsonErr(400, errors.QueryAirQualityPointResponseBody$inboundSchema), M.jsonErr(404, errors.QueryAirQualityPointAirQualityResponseBody$inboundSchema), M.jsonErr(500, errors.QueryAirQualityPointAirQualityResponseResponseBody$inboundSchema), M.jsonErr(503, errors
+        .QueryAirQualityPointAirQualityResponse503ResponseBody$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
+    if (!result.ok) {
+        return [result, { status: "complete", request: req, response }];
+    }
+    return [result, { status: "complete", request: req, response }];
+}
+//# sourceMappingURL=airQualityPoint.js.map

package/dist/commonjs/funcs/airQualityPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"airQualityPoint.js","sourceRoot":"","sources":["../../../src/funcs/airQualityPoint.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCH,0CA0BC;AA3DD,sDAAiD;AACjD,4CAAiD;AACjD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,sEAAwD;AAIxD,sEAAwD;AACxD,oDAA4D;AAG5D;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAC7B,MAAe,EACf,OAAmD,EACnD,OAAwB;IAkBxB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAAmD,EACnD,OAAwB;IAqBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,MAAM,CAAC,qCAAqC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EACtE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,OAAO,KAAK,SAAS;QAChC,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnD,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,uBAAuB,CAAC,EAAE,CAAC;IAEnD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IACzE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,sBAAsB;QACnC,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU;QAC1C,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,iBAAiB,EAAE,CAAC,UAAkB,EAAE,EAAE,CACxC,IAAA,yBAAe,EAAC,EAAE,MAAM,EAAE,UAAU,EAAc,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACrE,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAe5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,qCAAqC,CAAC,EACzD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,8CAA8C,CAAC,EACrE,CAAC,CAAC,OAAO,CACP,GAAG,EACH,MAAM,CAAC,wDAAwD,CAChE,EACD,CAAC,CAAC,OAAO,CACP,GAAG,EACH,MAAM,CAAC,gEAAgE,CACxE,EACD,CAAC,CAAC,OAAO,CACP,GAAG,EACH,MAAM;SACH,mEAAmE,CACvE,EACD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}

package/dist/commonjs/funcs/airQualityQuery.d.ts

@@ -14,7 +14,7 @@ import { Result } from "../sdk/types/fp.js";
  * @remarks
  * Retrieve air-quality data for one or more geographic areas. Supports nearest-cell lookup (single point with radius 0), radius search, postcode lookup, outcode lookup, bounding-box and polygon area filters. Multiple areas can be combined in a single request — up to 10 areas, results are OR-combined and deduplicated by `airQualityId`.
  *
- * Each response cell carries the air-quality summary (score, band, worst pollutant), per-pollutant concentrations vs UK limits and WHO guidelines, AQMA / vehicle-emission-zone overlays, and provenance. Premium attributes (`roadProximity`, `installations`) require the `air-quality:premium` permission.
+ * Each response cell carries the air-quality summary (platform 0-100 score, band, dominant source), per-pollutant concentrations with framework-tagged compliance checks (UK AQS 2010, WHO AQG 2021), official indices (DAQI), regulator-defined zone memberships (AQMA, CAZ, ULEZ, LEZ, smoke control), and provenance. Premium attributes (`nearestRoad`, `nearestMotorway`, `installations`) require the `air-quality:premium` permission.
  */
 export declare function airQualityQuery(client: SDKCore, request?: shared.AirQualityQueryRequest | undefined, options?: RequestOptions): APIPromise<Result<shared.AirQualityListResponse, errors.QueryAirQualityResponseBody | errors.QueryAirQualityAirQualityResponseBody | errors.QueryAirQualityAirQualityResponseResponseBody | errors.QueryAirQualityAirQualityResponse503ResponseBody | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=airQualityQuery.d.ts.map

package/dist/commonjs/funcs/airQualityQuery.js

@@ -53,7 +53,7 @@ const async_js_1 = require("../sdk/types/async.js");
  * @remarks
  * Retrieve air-quality data for one or more geographic areas. Supports nearest-cell lookup (single point with radius 0), radius search, postcode lookup, outcode lookup, bounding-box and polygon area filters. Multiple areas can be combined in a single request — up to 10 areas, results are OR-combined and deduplicated by `airQualityId`.
  *
- * Each response cell carries the air-quality summary (score, band, worst pollutant), per-pollutant concentrations vs UK limits and WHO guidelines, AQMA / vehicle-emission-zone overlays, and provenance. Premium attributes (`roadProximity`, `installations`) require the `air-quality:premium` permission.
+ * Each response cell carries the air-quality summary (platform 0-100 score, band, dominant source), per-pollutant concentrations with framework-tagged compliance checks (UK AQS 2010, WHO AQG 2021), official indices (DAQI), regulator-defined zone memberships (AQMA, CAZ, ULEZ, LEZ, smoke control), and provenance. Premium attributes (`nearestRoad`, `nearestMotorway`, `installations`) require the `air-quality:premium` permission.
  */
 function airQualityQuery(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/schoolsChangelogList.d.ts

@@ -0,0 +1,20 @@
+import { SDKCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../sdk/models/errors/httpclienterrors.js";
+import * as errors from "../sdk/models/errors/index.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import * as shared from "../sdk/models/shared/index.js";
+import { APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+/**
+ * List Schools API changelog entries
+ *
+ * @remarks
+ * Append-only feed of shape changes to the Schools API. Each entry records a dated `objectVersion`, the kind of change (`additive`, `deprecation`, `removal`, `fix`), the affected shapes or endpoints and — for deprecations — the sunset date that matches the `Sunset` HTTP header on the deprecated endpoint.
+ *
+ * Cache for 1 hour. Cheap to poll.
+ */
+export declare function schoolsChangelogList(client: SDKCore, options?: RequestOptions): APIPromise<Result<shared.ChangelogListResponse, errors.ListSchoolsChangelogResponseBody | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
+//# sourceMappingURL=schoolsChangelogList.d.ts.map

package/dist/commonjs/funcs/schoolsChangelogList.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolsChangelogList.d.ts","sourceRoot":"","sources":["../../../src/funcs/schoolsChangelogList.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAIrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,iDAAiD,CAAC;AAC1F,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AAChF,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAW,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,qBAAqB,EAC1B,MAAM,CAAC,gCAAgC,GACvC,YAAY,GACZ,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAKA"}

package/dist/commonjs/funcs/schoolsChangelogList.js

@@ -0,0 +1,111 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schoolsChangelogList = schoolsChangelogList;
+const http_js_1 = require("../lib/http.js");
+const M = __importStar(require("../lib/matchers.js"));
+const primitives_js_1 = require("../lib/primitives.js");
+const security_js_1 = require("../lib/security.js");
+const url_js_1 = require("../lib/url.js");
+const errors = __importStar(require("../sdk/models/errors/index.js"));
+const shared = __importStar(require("../sdk/models/shared/index.js"));
+const async_js_1 = require("../sdk/types/async.js");
+/**
+ * List Schools API changelog entries
+ *
+ * @remarks
+ * Append-only feed of shape changes to the Schools API. Each entry records a dated `objectVersion`, the kind of change (`additive`, `deprecation`, `removal`, `fix`), the affected shapes or endpoints and — for deprecations — the sunset date that matches the `Sunset` HTTP header on the deprecated endpoint.
+ *
+ * Cache for 1 hour. Cheap to poll.
+ */
+function schoolsChangelogList(client, options) {
+    return new async_js_1.APIPromise($do(client, options));
+}
+async function $do(client, options) {
+    const path = (0, url_js_1.pathToFunc)("/v1/schools/changelog")();
+    const headers = new Headers((0, primitives_js_1.compactMap)({
+        Accept: "application/json",
+    }));
+    const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKeyAuth);
+    const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+    const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
+    const context = {
+        options: client._options,
+        baseURL: options?.serverURL ?? client._baseURL ?? "",
+        operationID: "listSchoolsChangelog",
+        oAuth2Scopes: null,
+        resolvedSecurity: requestSecurity,
+        securitySource: client._options.apiKeyAuth,
+        retryConfig: options?.retries
+            || client._options.retryConfig
+            || { strategy: "none" },
+        retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    };
+    const requestRes = client._createRequest(context, {
+        security: requestSecurity,
+        method: "GET",
+        baseURL: options?.serverURL,
+        path: path,
+        headers: headers,
+        userAgent: client._options.userAgent,
+        timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+    }, options);
+    if (!requestRes.ok) {
+        return [requestRes, { status: "invalid" }];
+    }
+    const req = requestRes.value;
+    const doResult = await client._do(req, {
+        context,
+        isErrorStatusCode: (statusCode) => (0, http_js_1.matchStatusCode)({ status: statusCode }, ["4XX", "5XX"]),
+        retryConfig: context.retryConfig,
+        retryCodes: context.retryCodes,
+    });
+    if (!doResult.ok) {
+        return [doResult, { status: "request-error", request: req }];
+    }
+    const response = doResult.value;
+    const responseFields = {
+        HttpMeta: { Response: response, Request: req },
+    };
+    const [result] = await M.match(M.json(200, shared.ChangelogListResponse$inboundSchema), M.jsonErr(500, errors.ListSchoolsChangelogResponseBody$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
+    if (!result.ok) {
+        return [result, { status: "complete", request: req, response }];
+    }
+    return [result, { status: "complete", request: req, response }];
+}
+//# sourceMappingURL=schoolsChangelogList.js.map

package/dist/commonjs/funcs/schoolsChangelogList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolsChangelogList.js","sourceRoot":"","sources":["../../../src/funcs/schoolsChangelogList.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCH,oDAqBC;AAlDD,4CAAiD;AACjD,sDAAwC;AACxC,wDAAkD;AAElD,oDAA4E;AAC5E,0CAA2C;AAQ3C,sEAAwD;AAIxD,sEAAwD;AACxD,oDAA4D;AAG5D;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAClC,MAAe,EACf,OAAwB;IAexB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAAwB;IAkBxB,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,uBAAuB,CAAC,EAAE,CAAC;IAEnD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IACzE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,sBAAsB;QACnC,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU;QAC1C,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,iBAAiB,EAAE,CAAC,UAAkB,EAAE,EAAE,CACxC,IAAA,yBAAe,EAAC,EAAE,MAAM,EAAE,UAAU,EAAc,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACrE,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,mCAAmC,CAAC,EACvD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,8CAA8C,CAAC,EACrE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}

package/dist/commonjs/funcs/schoolsCoverageMatrixGet.d.ts

@@ -0,0 +1,20 @@
+import { SDKCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../sdk/models/errors/httpclienterrors.js";
+import * as errors from "../sdk/models/errors/index.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import * as shared from "../sdk/models/shared/index.js";
+import { APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+/**
+ * Get the schools coverage matrix
+ *
+ * @remarks
+ * Returns a country × framework × domain × quality matrix describing what schools data Vepler holds, how fresh it is and what entitlement tier is required to access each block. Distinguishes the four reasons a block can be null on a per-school response (`not_applicable`, `not_yet_ingested`, `publisher_not_releasing`, `no_data_to_report`) so callers can make informed routing decisions before issuing per-school queries.
+ *
+ * Cached for 1 hour. Re-snapshotted automatically when ETL pipelines complete and report new counts.
+ */
+export declare function schoolsCoverageMatrixGet(client: SDKCore, options?: RequestOptions): APIPromise<Result<shared.CoverageMatrix, errors.GetSchoolsCoverageResponseBody | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
+//# sourceMappingURL=schoolsCoverageMatrixGet.d.ts.map

package/dist/commonjs/funcs/schoolsCoverageMatrixGet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolsCoverageMatrixGet.d.ts","sourceRoot":"","sources":["../../../src/funcs/schoolsCoverageMatrixGet.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAIrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,iDAAiD,CAAC;AAC1F,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AAChF,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAW,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,cAAc,EACnB,MAAM,CAAC,8BAA8B,GACrC,YAAY,GACZ,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAKA"}

package/dist/commonjs/funcs/schoolsCoverageMatrixGet.js

@@ -0,0 +1,111 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schoolsCoverageMatrixGet = schoolsCoverageMatrixGet;
+const http_js_1 = require("../lib/http.js");
+const M = __importStar(require("../lib/matchers.js"));
+const primitives_js_1 = require("../lib/primitives.js");
+const security_js_1 = require("../lib/security.js");
+const url_js_1 = require("../lib/url.js");
+const errors = __importStar(require("../sdk/models/errors/index.js"));
+const shared = __importStar(require("../sdk/models/shared/index.js"));
+const async_js_1 = require("../sdk/types/async.js");
+/**
+ * Get the schools coverage matrix
+ *
+ * @remarks
+ * Returns a country × framework × domain × quality matrix describing what schools data Vepler holds, how fresh it is and what entitlement tier is required to access each block. Distinguishes the four reasons a block can be null on a per-school response (`not_applicable`, `not_yet_ingested`, `publisher_not_releasing`, `no_data_to_report`) so callers can make informed routing decisions before issuing per-school queries.
+ *
+ * Cached for 1 hour. Re-snapshotted automatically when ETL pipelines complete and report new counts.
+ */
+function schoolsCoverageMatrixGet(client, options) {
+    return new async_js_1.APIPromise($do(client, options));
+}
+async function $do(client, options) {
+    const path = (0, url_js_1.pathToFunc)("/v1/schools/coverage")();
+    const headers = new Headers((0, primitives_js_1.compactMap)({
+        Accept: "application/json",
+    }));
+    const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKeyAuth);
+    const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+    const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
+    const context = {
+        options: client._options,
+        baseURL: options?.serverURL ?? client._baseURL ?? "",
+        operationID: "getSchoolsCoverage",
+        oAuth2Scopes: null,
+        resolvedSecurity: requestSecurity,
+        securitySource: client._options.apiKeyAuth,
+        retryConfig: options?.retries
+            || client._options.retryConfig
+            || { strategy: "none" },
+        retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    };
+    const requestRes = client._createRequest(context, {
+        security: requestSecurity,
+        method: "GET",
+        baseURL: options?.serverURL,
+        path: path,
+        headers: headers,
+        userAgent: client._options.userAgent,
+        timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+    }, options);
+    if (!requestRes.ok) {
+        return [requestRes, { status: "invalid" }];
+    }
+    const req = requestRes.value;
+    const doResult = await client._do(req, {
+        context,
+        isErrorStatusCode: (statusCode) => (0, http_js_1.matchStatusCode)({ status: statusCode }, ["4XX", "5XX"]),
+        retryConfig: context.retryConfig,
+        retryCodes: context.retryCodes,
+    });
+    if (!doResult.ok) {
+        return [doResult, { status: "request-error", request: req }];
+    }
+    const response = doResult.value;
+    const responseFields = {
+        HttpMeta: { Response: response, Request: req },
+    };
+    const [result] = await M.match(M.json(200, shared.CoverageMatrix$inboundSchema), M.jsonErr(500, errors.GetSchoolsCoverageResponseBody$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
+    if (!result.ok) {
+        return [result, { status: "complete", request: req, response }];
+    }
+    return [result, { status: "complete", request: req, response }];
+}
+//# sourceMappingURL=schoolsCoverageMatrixGet.js.map

package/dist/commonjs/funcs/schoolsCoverageMatrixGet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolsCoverageMatrixGet.js","sourceRoot":"","sources":["../../../src/funcs/schoolsCoverageMatrixGet.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCH,4DAqBC;AAlDD,4CAAiD;AACjD,sDAAwC;AACxC,wDAAkD;AAElD,oDAA4E;AAC5E,0CAA2C;AAQ3C,sEAAwD;AAIxD,sEAAwD;AACxD,oDAA4D;AAG5D;;;;;;;GAOG;AACH,SAAgB,wBAAwB,CACtC,MAAe,EACf,OAAwB;IAexB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAAwB;IAkBxB,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,sBAAsB,CAAC,EAAE,CAAC;IAElD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IACzE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,oBAAoB;QACjC,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU;QAC1C,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,iBAAiB,EAAE,CAAC,UAAkB,EAAE,EAAE,CACxC,IAAA,yBAAe,EAAC,EAAE,MAAM,EAAE,UAAU,EAAc,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACrE,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,4BAA4B,CAAC,EAChD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,4CAA4C,CAAC,EACnE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}

package/dist/commonjs/funcs/schoolsFrameworksGet.d.ts

@@ -0,0 +1,21 @@
+import { SDKCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../sdk/models/errors/httpclienterrors.js";
+import * as errors from "../sdk/models/errors/index.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import * as operations from "../sdk/models/operations/index.js";
+import * as shared from "../sdk/models/shared/index.js";
+import { APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+/**
+ * Get framework with full metric definitions
+ *
+ * @remarks
+ * Returns a single framework entry plus the complete list of metric codes published under it. Each metric carries operational interpretation, unit, expected range, nominal national average, cohort dimensions and the publishing authority's small-cohort suppression policy.
+ *
+ * Use this to ground LLM responses: rather than asking a model what `ATT8` means, fetch the metric definition and inject it into the prompt.
+ */
+export declare function schoolsFrameworksGet(client: SDKCore, request: operations.GetFrameworkRequest, options?: RequestOptions): APIPromise<Result<shared.FrameworkDetailResponse, errors.GetFrameworkResponseBody | errors.GetFrameworkSchoolsFrameworksResponseBody | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
+//# sourceMappingURL=schoolsFrameworksGet.d.ts.map

package/dist/commonjs/funcs/schoolsFrameworksGet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolsFrameworksGet.d.ts","sourceRoot":"","sources":["../../../src/funcs/schoolsFrameworksGet.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAMrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,iDAAiD,CAAC;AAC1F,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AAChF,OAAO,KAAK,UAAU,MAAM,mCAAmC,CAAC;AAChE,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAW,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,uBAAuB,EAC5B,MAAM,CAAC,wBAAwB,GAC/B,MAAM,CAAC,yCAAyC,GAChD,YAAY,GACZ,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}

package/dist/commonjs/funcs/schoolsFrameworksGet.js

@@ -0,0 +1,127 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schoolsFrameworksGet = schoolsFrameworksGet;
+const encodings_js_1 = require("../lib/encodings.js");
+const http_js_1 = require("../lib/http.js");
+const M = __importStar(require("../lib/matchers.js"));
+const primitives_js_1 = require("../lib/primitives.js");
+const schemas_js_1 = require("../lib/schemas.js");
+const security_js_1 = require("../lib/security.js");
+const url_js_1 = require("../lib/url.js");
+const errors = __importStar(require("../sdk/models/errors/index.js"));
+const operations = __importStar(require("../sdk/models/operations/index.js"));
+const shared = __importStar(require("../sdk/models/shared/index.js"));
+const async_js_1 = require("../sdk/types/async.js");
+/**
+ * Get framework with full metric definitions
+ *
+ * @remarks
+ * Returns a single framework entry plus the complete list of metric codes published under it. Each metric carries operational interpretation, unit, expected range, nominal national average, cohort dimensions and the publishing authority's small-cohort suppression policy.
+ *
+ * Use this to ground LLM responses: rather than asking a model what `ATT8` means, fetch the metric definition and inject it into the prompt.
+ */
+function schoolsFrameworksGet(client, request, options) {
+    return new async_js_1.APIPromise($do(client, request, options));
+}
+async function $do(client, request, options) {
+    const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.GetFrameworkRequest$outboundSchema.parse(value), "Input validation failed");
+    if (!parsed.ok) {
+        return [parsed, { status: "invalid" }];
+    }
+    const payload = parsed.value;
+    const body = null;
+    const pathParams = {
+        framework: (0, encodings_js_1.encodeSimple)("framework", payload.framework, {
+            explode: false,
+            charEncoding: "percent",
+        }),
+    };
+    const path = (0, url_js_1.pathToFunc)("/v1/schools/frameworks/{framework}")(pathParams);
+    const headers = new Headers((0, primitives_js_1.compactMap)({
+        Accept: "application/json",
+    }));
+    const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKeyAuth);
+    const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+    const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
+    const context = {
+        options: client._options,
+        baseURL: options?.serverURL ?? client._baseURL ?? "",
+        operationID: "getFramework",
+        oAuth2Scopes: null,
+        resolvedSecurity: requestSecurity,
+        securitySource: client._options.apiKeyAuth,
+        retryConfig: options?.retries
+            || client._options.retryConfig
+            || { strategy: "none" },
+        retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    };
+    const requestRes = client._createRequest(context, {
+        security: requestSecurity,
+        method: "GET",
+        baseURL: options?.serverURL,
+        path: path,
+        headers: headers,
+        body: body,
+        userAgent: client._options.userAgent,
+        timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+    }, options);
+    if (!requestRes.ok) {
+        return [requestRes, { status: "invalid" }];
+    }
+    const req = requestRes.value;
+    const doResult = await client._do(req, {
+        context,
+        isErrorStatusCode: (statusCode) => (0, http_js_1.matchStatusCode)({ status: statusCode }, ["4XX", "5XX"]),
+        retryConfig: context.retryConfig,
+        retryCodes: context.retryCodes,
+    });
+    if (!doResult.ok) {
+        return [doResult, { status: "request-error", request: req }];
+    }
+    const response = doResult.value;
+    const responseFields = {
+        HttpMeta: { Response: response, Request: req },
+    };
+    const [result] = await M.match(M.json(200, shared.FrameworkDetailResponse$inboundSchema), M.jsonErr(404, errors.GetFrameworkResponseBody$inboundSchema), M.jsonErr(500, errors.GetFrameworkSchoolsFrameworksResponseBody$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
+    if (!result.ok) {
+        return [result, { status: "complete", request: req, response }];
+    }
+    return [result, { status: "complete", request: req, response }];
+}
+//# sourceMappingURL=schoolsFrameworksGet.js.map