skola24-node
Version:
Library that provides convenient access to the Skola24 API.
31 lines • 1.68 kB
TypeScript
import { Skola24Client } from "../Skola24Client";
import RequestData from "../types/Request";
import ResponseData from "../types/Response";
import { AdditionalAxiosRequestConfig, ApiRequest, CreateApiRequest } from "../types/utilTypes";
interface IUtilities {
getActiveSchoolYears: ApiRequest<RequestData.getActiveSchoolYears, ResponseData.getActiveSchoolYears>;
encryptSignature: ApiRequest<RequestData.encryptSignature, ResponseData.encryptSignature>;
}
declare class Utilities implements IUtilities {
private client;
private _getActiveSchoolYears;
private _encryptSignature;
constructor(createApiRequest: CreateApiRequest, client: Skola24Client);
/**
* Retrieves active school years.
*
* @param {RequestData.getActiveSchoolYears} data - The request data.
* @param {AdditionalAxiosRequestConfig?} additionalConfig - Additional Axios configuration settings.
* @throws Will throw an error if no active school years are found.
*/
getActiveSchoolYears: (data: RequestData.getActiveSchoolYears, additionalConfig?: AdditionalAxiosRequestConfig) => Promise<ResponseData.getActiveSchoolYears>;
/**
* Encrypts an ID or signature and returns a string that should be used as a selection when fetching timetables.
*
* @param {RequestData.encryptSignature} data - The request data.
* @param {AdditionalAxiosRequestConfig?} additionalConfig - Additional Axios configuration settings.
*/
encryptSignature: (data: RequestData.encryptSignature, additionalConfig?: AdditionalAxiosRequestConfig) => Promise<ResponseData.encryptSignature>;
}
export default Utilities;
//# sourceMappingURL=Utilities.d.ts.map