@vepler/sdk 2.131.0 → 2.133.0

package/dist/esm/funcs/schoolsFrameworksList.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 all framework catalog entries
+ *
+ * @remarks
+ * Returns every framework registered against the Schools API — performance, destinations, census, finance, admissions and inspections — grouped by country and publishing authority. AI agents fetch this once per session and use it to interpret metric codes that appear inside per-school responses without inlining self-documentation on every payload.
+ *
+ * Cache aggressively: `Cache-Control: public, max-age=86400, immutable`. Changes are mirrored to `/v1/schools/changelog`.
+ */
+export declare function schoolsFrameworksList(client: SDKCore, options?: RequestOptions): APIPromise<Result<shared.FrameworkListResponse, errors.ListFrameworksResponseBody | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
+//# sourceMappingURL=schoolsFrameworksList.d.ts.map

package/dist/esm/funcs/schoolsFrameworksList.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolsFrameworksList.d.ts","sourceRoot":"","sources":["../../../src/funcs/schoolsFrameworksList.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,qBAAqB,CACnC,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,qBAAqB,EAC1B,MAAM,CAAC,0BAA0B,GACjC,YAAY,GACZ,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAKA"}

package/dist/esm/funcs/schoolsFrameworksList.js

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as errors from "../sdk/models/errors/index.js";
+import * as shared from "../sdk/models/shared/index.js";
+import { APIPromise } from "../sdk/types/async.js";
+/**
+ * List all framework catalog entries
+ *
+ * @remarks
+ * Returns every framework registered against the Schools API — performance, destinations, census, finance, admissions and inspections — grouped by country and publishing authority. AI agents fetch this once per session and use it to interpret metric codes that appear inside per-school responses without inlining self-documentation on every payload.
+ *
+ * Cache aggressively: `Cache-Control: public, max-age=86400, immutable`. Changes are mirrored to `/v1/schools/changelog`.
+ */
+export function schoolsFrameworksList(client, options) {
+    return new APIPromise($do(client, options));
+}
+async function $do(client, options) {
+    const path = pathToFunc("/v1/schools/frameworks")();
+    const headers = new Headers(compactMap({
+        Accept: "application/json",
+    }));
+    const secConfig = await extractSecurity(client._options.apiKeyAuth);
+    const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+    const requestSecurity = resolveGlobalSecurity(securityInput);
+    const context = {
+        options: client._options,
+        baseURL: options?.serverURL ?? client._baseURL ?? "",
+        operationID: "listFrameworks",
+        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) => 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.FrameworkListResponse$inboundSchema), M.jsonErr(500, errors.ListFrameworksResponseBody$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=schoolsFrameworksList.js.map

package/dist/esm/funcs/schoolsFrameworksList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schoolsFrameworksList.js","sourceRoot":"","sources":["../../../src/funcs/schoolsFrameworksList.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,CAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAQ3C,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AAIxD,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAW,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAG5D;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAAe,EACf,OAAwB;IAexB,OAAO,IAAI,UAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAAwB;IAkBxB,MAAM,IAAI,GAAG,UAAU,CAAC,wBAAwB,CAAC,EAAE,CAAC;IAEpD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,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,qBAAqB,CAAC,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,gBAAgB;QAC7B,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,eAAe,CAAC,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,wCAAwC,CAAC,EAC/D,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/esm/lib/config.d.ts

@@ -30,9 +30,9 @@ export type SDKOptions = {
 export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
-    readonly openapiDocVersion: "2.131.0";
+    readonly openapiDocVersion: "2.133.0";
     readonly sdkVersion: "0.10.0";
-    readonly genVersion: "2.884.4";
-    readonly userAgent: "speakeasy-sdk/typescript 0.10.0 2.884.4 2.131.0 @vepler/sdk";
+    readonly genVersion: "2.888.0";
+    readonly userAgent: "speakeasy-sdk/typescript 0.10.0 2.888.0 2.133.0 @vepler/sdk";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/esm/lib/config.js

@@ -26,9 +26,9 @@ export function serverURLFromOptions(options) {
 }
 export const SDK_METADATA = {
     language: "typescript",
-    openapiDocVersion: "2.131.0",
+    openapiDocVersion: "2.133.0",
     sdkVersion: "0.10.0",
-    genVersion: "2.884.4",
-    userAgent: "speakeasy-sdk/typescript 0.10.0 2.884.4 2.131.0 @vepler/sdk",
+    genVersion: "2.888.0",
+    userAgent: "speakeasy-sdk/typescript 0.10.0 2.888.0 2.133.0 @vepler/sdk",
 };
 //# sourceMappingURL=config.js.map

package/dist/esm/sdk/airquality.d.ts

@@ -1,13 +1,24 @@
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as shared from "./models/shared/index.js";
 export declare class AirQuality extends ClientSDK {
+    /**
+     * 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.
+     */
+    point(request?: shared.AirQualityPointRequest | undefined, options?: RequestOptions): Promise<shared.AirQualityPointResponse>;
     /**
      * Query air quality at one or more locations
      *
      * @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.
      */
     query(request?: shared.AirQualityQueryRequest | undefined, options?: RequestOptions): Promise<shared.AirQualityListResponse>;
 }

package/dist/esm/sdk/airquality.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"airquality.d.ts","sourceRoot":"","sources":["../../../src/sdk/airquality.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,UAAW,SAAQ,SAAS;IACvC;;;;;;;OAOG;IACG,KAAK,CACT,OAAO,CAAC,EAAE,MAAM,CAAC,sBAAsB,GAAG,SAAS,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC;CAO1C"}
+{"version":3,"file":"airquality.d.ts","sourceRoot":"","sources":["../../../src/sdk/airquality.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,UAAW,SAAQ,SAAS;IACvC;;;;;;;;;OASG;IACG,KAAK,CACT,OAAO,CAAC,EAAE,MAAM,CAAC,sBAAsB,GAAG,SAAS,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC;IAQ1C;;;;;;;OAOG;IACG,KAAK,CACT,OAAO,CAAC,EAAE,MAAM,CAAC,sBAAsB,GAAG,SAAS,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC;CAO1C"}

package/dist/esm/sdk/airquality.js

@@ -1,17 +1,31 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
+import { airQualityPoint } from "../funcs/airQualityPoint.js";
 import { airQualityQuery } from "../funcs/airQualityQuery.js";
 import { ClientSDK } from "../lib/sdks.js";
 import { unwrapAsync } from "./types/fp.js";
 export class AirQuality extends ClientSDK {
+    /**
+     * 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.
+     */
+    async point(request, options) {
+        return unwrapAsync(airQualityPoint(this, request, options));
+    }
     /**
      * Query air quality at one or more locations
      *
      * @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.
      */
     async query(request, options) {
         return unwrapAsync(airQualityQuery(this, request, options));

package/dist/esm/sdk/airquality.js.map

@@ -1 +1 @@
-{"version":3,"file":"airquality.js","sourceRoot":"","sources":["../../../src/sdk/airquality.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,UAAW,SAAQ,SAAS;IACvC;;;;;;;OAOG;IACH,KAAK,CAAC,KAAK,CACT,OAAmD,EACnD,OAAwB;QAExB,OAAO,WAAW,CAAC,eAAe,CAChC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"airquality.js","sourceRoot":"","sources":["../../../src/sdk/airquality.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,UAAW,SAAQ,SAAS;IACvC;;;;;;;;;OASG;IACH,KAAK,CAAC,KAAK,CACT,OAAmD,EACnD,OAAwB;QAExB,OAAO,WAAW,CAAC,eAAe,CAChC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,KAAK,CACT,OAAmD,EACnD,OAAwB;QAExB,OAAO,WAAW,CAAC,eAAe,CAChC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/changelog.d.ts

@@ -0,0 +1,14 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as shared from "./models/shared/index.js";
+export declare class Changelog extends ClientSDK {
+    /**
+     * 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.
+     */
+    list(options?: RequestOptions): Promise<shared.ChangelogListResponse>;
+}
+//# sourceMappingURL=changelog.d.ts.map

package/dist/esm/sdk/changelog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"changelog.d.ts","sourceRoot":"","sources":["../../../src/sdk/changelog.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,SAAU,SAAQ,SAAS;IACtC;;;;;;;OAOG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC;CAMzC"}

package/dist/esm/sdk/changelog.js

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { schoolsChangelogList } from "../funcs/schoolsChangelogList.js";
+import { ClientSDK } from "../lib/sdks.js";
+import { unwrapAsync } from "./types/fp.js";
+export class Changelog extends ClientSDK {
+    /**
+     * 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.
+     */
+    async list(options) {
+        return unwrapAsync(schoolsChangelogList(this, options));
+    }
+}
+//# sourceMappingURL=changelog.js.map

package/dist/esm/sdk/changelog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"changelog.js","sourceRoot":"","sources":["../../../src/sdk/changelog.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/coveragematrix.d.ts

@@ -0,0 +1,14 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as shared from "./models/shared/index.js";
+export declare class CoverageMatrix extends ClientSDK {
+    /**
+     * 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.
+     */
+    get(options?: RequestOptions): Promise<shared.CoverageMatrix>;
+}
+//# sourceMappingURL=coveragematrix.d.ts.map

package/dist/esm/sdk/coveragematrix.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coveragematrix.d.ts","sourceRoot":"","sources":["../../../src/sdk/coveragematrix.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,cAAe,SAAQ,SAAS;IAC3C;;;;;;;OAOG;IACG,GAAG,CACP,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;CAMlC"}

package/dist/esm/sdk/coveragematrix.js

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { schoolsCoverageMatrixGet } from "../funcs/schoolsCoverageMatrixGet.js";
+import { ClientSDK } from "../lib/sdks.js";
+import { unwrapAsync } from "./types/fp.js";
+export class CoverageMatrix extends ClientSDK {
+    /**
+     * 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.
+     */
+    async get(options) {
+        return unwrapAsync(schoolsCoverageMatrixGet(this, options));
+    }
+}
+//# sourceMappingURL=coveragematrix.js.map

package/dist/esm/sdk/coveragematrix.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coveragematrix.js","sourceRoot":"","sources":["../../../src/sdk/coveragematrix.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,cAAe,SAAQ,SAAS;IAC3C;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,CACP,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/frameworks.d.ts

@@ -0,0 +1,24 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import * as shared from "./models/shared/index.js";
+export declare class Frameworks extends ClientSDK {
+    /**
+     * 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.
+     */
+    get(request: operations.GetFrameworkRequest, options?: RequestOptions): Promise<shared.FrameworkDetailResponse>;
+    /**
+     * List all framework catalog entries
+     *
+     * @remarks
+     * Returns every framework registered against the Schools API — performance, destinations, census, finance, admissions and inspections — grouped by country and publishing authority. AI agents fetch this once per session and use it to interpret metric codes that appear inside per-school responses without inlining self-documentation on every payload.
+     *
+     * Cache aggressively: `Cache-Control: public, max-age=86400, immutable`. Changes are mirrored to `/v1/schools/changelog`.
+     */
+    list(options?: RequestOptions): Promise<shared.FrameworkListResponse>;
+}
+//# sourceMappingURL=frameworks.d.ts.map

package/dist/esm/sdk/frameworks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frameworks.d.ts","sourceRoot":"","sources":["../../../src/sdk/frameworks.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,UAAW,SAAQ,SAAS;IACvC;;;;;;;OAOG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC;IAQ1C;;;;;;;OAOG;IACG,IAAI,CACR,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC;CAMzC"}

package/dist/esm/sdk/frameworks.js

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { schoolsFrameworksGet } from "../funcs/schoolsFrameworksGet.js";
+import { schoolsFrameworksList } from "../funcs/schoolsFrameworksList.js";
+import { ClientSDK } from "../lib/sdks.js";
+import { unwrapAsync } from "./types/fp.js";
+export class Frameworks extends ClientSDK {
+    /**
+     * 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.
+     */
+    async get(request, options) {
+        return unwrapAsync(schoolsFrameworksGet(this, request, options));
+    }
+    /**
+     * List all framework catalog entries
+     *
+     * @remarks
+     * Returns every framework registered against the Schools API — performance, destinations, census, finance, admissions and inspections — grouped by country and publishing authority. AI agents fetch this once per session and use it to interpret metric codes that appear inside per-school responses without inlining self-documentation on every payload.
+     *
+     * Cache aggressively: `Cache-Control: public, max-age=86400, immutable`. Changes are mirrored to `/v1/schools/changelog`.
+     */
+    async list(options) {
+        return unwrapAsync(schoolsFrameworksList(this, options));
+    }
+}
+//# sourceMappingURL=frameworks.js.map

package/dist/esm/sdk/frameworks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frameworks.js","sourceRoot":"","sources":["../../../src/sdk/frameworks.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,UAAW,SAAQ,SAAS;IACvC;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,CACP,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/sdk/models/errors/getframework.d.ts

@@ -0,0 +1,136 @@
+import * as z from "zod/v3";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKBaseError } from "./sdkbaseerror.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+/**
+ * Error type category
+ */
+export declare const GetFrameworkSchoolsFrameworksType: {
+    readonly ApiError: "api_error";
+    readonly InvalidRequestError: "invalid_request_error";
+    readonly AuthenticationError: "authentication_error";
+    readonly RateLimitError: "rate_limit_error";
+};
+/**
+ * Error type category
+ */
+export type GetFrameworkSchoolsFrameworksType = OpenEnum<typeof GetFrameworkSchoolsFrameworksType>;
+export type GetFrameworkSchoolsFrameworksError = {
+    /**
+     * Machine-readable error code
+     */
+    code?: string | undefined;
+    /**
+     * URL to relevant documentation
+     */
+    docUrl?: string | undefined;
+    /**
+     * Human-readable error message
+     */
+    message: string;
+    /**
+     * Parameter that caused the error
+     */
+    param?: string | undefined;
+    /**
+     * Suggested corrections (e.g. postcode typo suggestions)
+     */
+    suggestions?: Array<string> | undefined;
+    /**
+     * Error type category
+     */
+    type: GetFrameworkSchoolsFrameworksType;
+};
+/**
+ * Error response
+ */
+export type GetFrameworkSchoolsFrameworksResponseBodyData = {
+    error: GetFrameworkSchoolsFrameworksError;
+};
+/**
+ * Error response
+ */
+export declare class GetFrameworkSchoolsFrameworksResponseBody extends SDKBaseError {
+    error: GetFrameworkSchoolsFrameworksError;
+    /** The original data that was passed to this error instance. */
+    data$: GetFrameworkSchoolsFrameworksResponseBodyData;
+    constructor(err: GetFrameworkSchoolsFrameworksResponseBodyData, httpMeta: {
+        response: Response;
+        request: Request;
+        body: string;
+    });
+}
+/**
+ * Error type category
+ */
+export declare const GetFrameworkType: {
+    readonly ApiError: "api_error";
+    readonly InvalidRequestError: "invalid_request_error";
+    readonly AuthenticationError: "authentication_error";
+    readonly RateLimitError: "rate_limit_error";
+};
+/**
+ * Error type category
+ */
+export type GetFrameworkType = OpenEnum<typeof GetFrameworkType>;
+export type GetFrameworkError = {
+    /**
+     * Machine-readable error code
+     */
+    code?: string | undefined;
+    /**
+     * URL to relevant documentation
+     */
+    docUrl?: string | undefined;
+    /**
+     * Human-readable error message
+     */
+    message: string;
+    /**
+     * Parameter that caused the error
+     */
+    param?: string | undefined;
+    /**
+     * Suggested corrections (e.g. postcode typo suggestions)
+     */
+    suggestions?: Array<string> | undefined;
+    /**
+     * Error type category
+     */
+    type: GetFrameworkType;
+};
+/**
+ * Error response
+ */
+export type GetFrameworkResponseBodyData = {
+    error: GetFrameworkError;
+};
+/**
+ * Error response
+ */
+export declare class GetFrameworkResponseBody extends SDKBaseError {
+    error: GetFrameworkError;
+    /** The original data that was passed to this error instance. */
+    data$: GetFrameworkResponseBodyData;
+    constructor(err: GetFrameworkResponseBodyData, httpMeta: {
+        response: Response;
+        request: Request;
+        body: string;
+    });
+}
+/** @internal */
+export declare const GetFrameworkSchoolsFrameworksType$inboundSchema: z.ZodType<GetFrameworkSchoolsFrameworksType, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const GetFrameworkSchoolsFrameworksError$inboundSchema: z.ZodType<GetFrameworkSchoolsFrameworksError, z.ZodTypeDef, unknown>;
+export declare function getFrameworkSchoolsFrameworksErrorFromJSON(jsonString: string): SafeParseResult<GetFrameworkSchoolsFrameworksError, SDKValidationError>;
+/** @internal */
+export declare const GetFrameworkSchoolsFrameworksResponseBody$inboundSchema: z.ZodType<GetFrameworkSchoolsFrameworksResponseBody, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const GetFrameworkType$inboundSchema: z.ZodType<GetFrameworkType, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const GetFrameworkError$inboundSchema: z.ZodType<GetFrameworkError, z.ZodTypeDef, unknown>;
+export declare function getFrameworkErrorFromJSON(jsonString: string): SafeParseResult<GetFrameworkError, SDKValidationError>;
+/** @internal */
+export declare const GetFrameworkResponseBody$inboundSchema: z.ZodType<GetFrameworkResponseBody, z.ZodTypeDef, unknown>;
+//# sourceMappingURL=getframework.d.ts.map

package/dist/esm/sdk/models/errors/getframework.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getframework.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/errors/getframework.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,iCAAiC;;;;;CAKpC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,QAAQ,CACtD,OAAO,iCAAiC,CACzC,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,IAAI,EAAE,iCAAiC,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6CAA6C,GAAG;IAC1D,KAAK,EAAE,kCAAkC,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,qBAAa,yCAA0C,SAAQ,YAAY;IACzE,KAAK,EAAE,kCAAkC,CAAC;IAE1C,gEAAgE;IAChE,KAAK,EAAE,6CAA6C,CAAC;gBAGnD,GAAG,EAAE,6CAA6C,EAClD,QAAQ,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAUnE;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;CAKnB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEjE,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,KAAK,EAAE,iBAAiB,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,YAAY;IACxD,KAAK,EAAE,iBAAiB,CAAC;IAEzB,gEAAgE;IAChE,KAAK,EAAE,4BAA4B,CAAC;gBAGlC,GAAG,EAAE,4BAA4B,EACjC,QAAQ,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAUnE;AAED,gBAAgB;AAChB,eAAO,MAAM,+CAA+C,EAAE,CAAC,CAAC,OAAO,CACrE,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,OAAO,CACqD,CAAC;AAE/D,gBAAgB;AAChB,eAAO,MAAM,gDAAgD,EAAE,CAAC,CAAC,OAAO,CACtE,kCAAkC,EAClC,CAAC,CAAC,UAAU,EACZ,OAAO,CAYP,CAAC;AAEH,wBAAgB,0CAA0C,CACxD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kCAAkC,EAAE,kBAAkB,CAAC,CAOzE;AAED,gBAAgB;AAChB,eAAO,MAAM,uDAAuD,EAAE,CAAC,CAAC,OAAO,CAC7E,yCAAyC,EACzC,CAAC,CAAC,UAAU,EACZ,OAAO,CAaL,CAAC;AAEL,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CACoC,CAAC;AAE9C,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,iBAAiB,EACjB,CAAC,CAAC,UAAU,EACZ,OAAO,CAYP,CAAC;AAEH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAMxD;AAED,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAaL,CAAC"}

package/dist/esm/sdk/models/errors/getframework.js

@@ -0,0 +1,117 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { SDKBaseError } from "./sdkbaseerror.js";
+/**
+ * Error type category
+ */
+export const GetFrameworkSchoolsFrameworksType = {
+    ApiError: "api_error",
+    InvalidRequestError: "invalid_request_error",
+    AuthenticationError: "authentication_error",
+    RateLimitError: "rate_limit_error",
+};
+/**
+ * Error response
+ */
+export class GetFrameworkSchoolsFrameworksResponseBody extends SDKBaseError {
+    constructor(err, httpMeta) {
+        const message = err.error?.message
+            || `API error occurred: ${JSON.stringify(err)}`;
+        super(message, httpMeta);
+        this.data$ = err;
+        this.error = err.error;
+        this.name = "GetFrameworkSchoolsFrameworksResponseBody";
+    }
+}
+/**
+ * Error type category
+ */
+export const GetFrameworkType = {
+    ApiError: "api_error",
+    InvalidRequestError: "invalid_request_error",
+    AuthenticationError: "authentication_error",
+    RateLimitError: "rate_limit_error",
+};
+/**
+ * Error response
+ */
+export class GetFrameworkResponseBody extends SDKBaseError {
+    constructor(err, httpMeta) {
+        const message = err.error?.message
+            || `API error occurred: ${JSON.stringify(err)}`;
+        super(message, httpMeta);
+        this.data$ = err;
+        this.error = err.error;
+        this.name = "GetFrameworkResponseBody";
+    }
+}
+/** @internal */
+export const GetFrameworkSchoolsFrameworksType$inboundSchema = openEnums.inboundSchema(GetFrameworkSchoolsFrameworksType);
+/** @internal */
+export const GetFrameworkSchoolsFrameworksError$inboundSchema = z.object({
+    code: z.string().optional(),
+    doc_url: z.string().optional(),
+    message: z.string(),
+    param: z.string().optional(),
+    suggestions: z.array(z.string()).optional(),
+    type: GetFrameworkSchoolsFrameworksType$inboundSchema,
+}).transform((v) => {
+    return remap$(v, {
+        "doc_url": "docUrl",
+    });
+});
+export function getFrameworkSchoolsFrameworksErrorFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetFrameworkSchoolsFrameworksError$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetFrameworkSchoolsFrameworksError' from JSON`);
+}
+/** @internal */
+export const GetFrameworkSchoolsFrameworksResponseBody$inboundSchema = z.object({
+    error: z.lazy(() => GetFrameworkSchoolsFrameworksError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+})
+    .transform((v) => {
+    return new GetFrameworkSchoolsFrameworksResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+    });
+});
+/** @internal */
+export const GetFrameworkType$inboundSchema = openEnums.inboundSchema(GetFrameworkType);
+/** @internal */
+export const GetFrameworkError$inboundSchema = z.object({
+    code: z.string().optional(),
+    doc_url: z.string().optional(),
+    message: z.string(),
+    param: z.string().optional(),
+    suggestions: z.array(z.string()).optional(),
+    type: GetFrameworkType$inboundSchema,
+}).transform((v) => {
+    return remap$(v, {
+        "doc_url": "docUrl",
+    });
+});
+export function getFrameworkErrorFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GetFrameworkError$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetFrameworkError' from JSON`);
+}
+/** @internal */
+export const GetFrameworkResponseBody$inboundSchema = z.object({
+    error: z.lazy(() => GetFrameworkError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+})
+    .transform((v) => {
+    return new GetFrameworkResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+    });
+});
+//# sourceMappingURL=getframework.js.map