@vepler/http-sdk/dist/services/schools/routes/get-metrics.js

The definitive TypeScript SDK for UK property technology. Access comprehensive property data, school metrics, demographics, planning applications, and more through a single, powerful API.

"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
    return new (P || (P = Promise))(function (resolve, reject) {
        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
var __generator = (this && this.__generator) || function (thisArg, body) {
    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
    function verb(n) { return function (v) { return step([n, v]); }; }
    function step(op) {
        if (f) throw new TypeError("Generator is already executing.");
        while (g && (g = 0, op[0] && (_ = 0)), _) try {
            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
            if (y = 0, t) op = [op[0] & 2, t.value];
            switch (op[0]) {
                case 0: case 1: t = op; break;
                case 4: _.label++; return { value: op[1], done: false };
                case 5: _.label++; y = op[1]; op = [0]; continue;
                case 7: op = _.ops.pop(); _.trys.pop(); continue;
                default:
                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
                    if (t[2]) _.ops.pop();
                    _.trys.pop(); continue;
            }
            op = body.call(thisArg, _);
        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
    }
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getMetrics = getMetrics;
var config_1 = require("../../../config");
var errors_1 = require("../../../utils/errors");
function getMetrics(params) {
    return __awaiter(this, void 0, void 0, function () {
        var schoolIds, metricCodes, academicYears, profile, cohortType, period, periodNumber, includeMetadata, priorAttainment, pupilCharacteristic, limit, offset, api, endpoint, queryParams;
        return __generator(this, function (_a) {
            switch (_a.label) {
                case 0:
                    schoolIds = params.schoolIds, metricCodes = params.metricCodes, academicYears = params.academicYears, profile = params.profile, cohortType = params.cohortType, period = params.period, periodNumber = params.periodNumber, includeMetadata = params.includeMetadata, priorAttainment = params.priorAttainment, pupilCharacteristic = params.pupilCharacteristic, limit = params.limit, offset = params.offset;
                    // Validate required parameters
                    if (!schoolIds) {
                        throw new Error((0, errors_1.createRequiredParameterError)('schoolIds'));
                    }
                    if (!metricCodes && !profile) {
                        throw new Error((0, errors_1.createEitherOrParameterError)('metricCodes', 'profile'));
                    }
                    api = (0, config_1.getApiInstance)('schools');
                    endpoint = '/metrics';
                    queryParams = {
                        schoolIds: Array.isArray(schoolIds)
                            ? schoolIds.join(',')
                            : String(schoolIds),
                    };
                    if (metricCodes) {
                        queryParams.metricCodes = Array.isArray(metricCodes)
                            ? metricCodes.join(',')
                            : metricCodes;
                    }
                    if (academicYears) {
                        queryParams.academicYears = Array.isArray(academicYears)
                            ? academicYears.join(',')
                            : academicYears;
                    }
                    if (profile) {
                        queryParams.profile = Array.isArray(profile) ? profile.join(',') : profile;
                    }
                    if (cohortType)
                        queryParams.cohortType = cohortType;
                    if (period)
                        queryParams.period = period;
                    if (periodNumber !== undefined && periodNumber !== null)
                        queryParams.periodNumber = periodNumber;
                    if (includeMetadata !== undefined)
                        queryParams.includeMetadata = includeMetadata;
                    if (priorAttainment)
                        queryParams.priorAttainment = priorAttainment;
                    if (pupilCharacteristic)
                        queryParams.pupilCharacteristic = pupilCharacteristic;
                    if (limit)
                        queryParams.limit = limit;
                    if (offset)
                        queryParams.offset = offset;
                    return [4 /*yield*/, api.query(endpoint, queryParams, {
                            apiKey: config_1.initialisedConfig.apiKey,
                        })];
                case 1: return [2 /*return*/, _a.sent()];
            }
        });
    });
}
//# sourceMappingURL=get-metrics.js.map