james/classcharts-api-js
1
0
Fork 0
mirror of https://github.com/classchartsapi/classcharts-api-js.git synced 2026-05-14 11:58:13 +00:00
Code Activity

fix: pupil types

Browse source
This commit is contained in:
James Cook 2022-03-12 11:34:56 +00:00
parent ab73bd92cd
commit e1ac2b1364
2 changed files with 33 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

19
src/parent.ts
View file

@ -10,13 +10,14 @@ import {
GetBehaviourOptions,
GetHomeworkOptions,
GetLessonsOptions,
GetPupilsResponse,
Homework,
HomeworksResponse,
LessonsResponse,
Student,
} from "./types";
import {ClasschartsClient} from "./client"
import { ClasschartsClient } from "./client";
import { API_BASE_PARENT, BASE_URL } from "./consts";
/**
* The base client
@ -30,7 +31,7 @@ export class ClasschartsParentClient extends ClasschartsClient {
* @param password Parents password
*/
constructor(email: string, password: string) {
super(API_BASE_PARENT)
super(API_BASE_PARENT);
this.email = String(email);
this.password = String(password);
}
@ -76,21 +77,17 @@ export class ClasschartsParentClient extends ClasschartsClient {
let pupil = await this.getPupils();
this.studentId = pupil[0].id;
this.studentName = pupil[0].pupil_name;
this.studentName = pupil[0].name;
}
/**
* Get Pupil details
* @returns an array fo Pupils connected to this parent's account
*/
async getPupils(): Promise<Object> {
let pupils = this.makeAuthedRequest(
this.API_BASE + "/pupils",
{
async getPupils(): Promise<GetPupilsResponse> {
let pupils = this.makeAuthedRequest(this.API_BASE + "/pupils", {
method: "GET",
}
);
return pupils
});
return pupils;
}
}

21
src/types.ts
View file

@ -279,3 +279,24 @@ export interface Announcement {
}
export type AnnouncementsResponse = Array<Announcement>;
export interface Pupil extends Student {
school_name: string;
school_logo: string;
timezone: string;
display_covid_tests: boolean;
can_record_covid_tests: boolean;
detention_yes_count: number;
detention_no_count: number;
detention_pending_count: number;
detention_upscaled_count: number;
homework_todo_count: number;
homework_late_count: number;
homework_not_completed_count: number;
homework_excused_count: number;
homework_completed_count: number;
homework_submitted_count: number;
announcements_count: number;
messages_count: number;
}
export type GetPupilsResponse = Array<Pupil>;