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

chore: format

Browse source
This commit is contained in:
James Cook 2024-05-30 13:17:15 +01:00
parent bdd8a0f379
commit a697c85c8b
1 changed files with 26 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

40
src/types.ts
View file

@ -112,7 +112,13 @@ export interface GetActivityOptions {
export interface ActivityPoint { export interface ActivityPoint {
id: number; id: number;
type: "detention" | "notice" | "attendance_event" | "question" | "event" | "behaviour" type:
| "detention"
| "notice"
| "attendance_event"
| "question"
| "event"
| "behaviour";
polarity: "positive" | "blank" | "negative" | null; polarity: "positive" | "blank" | "negative" | null;
reason: string; reason: string;
score: number; score: number;
@ -120,7 +126,13 @@ export interface ActivityPoint {
timestamp_custom_time: string | null; timestamp_custom_time: string | null;
style: { style: {
border_color: string | null; border_color: string | null;
custom_class: "notice-color" | "colour-orange" | "colour-blue" | "colour-purple" | "colour-green" | null; custom_class:
| "notice-color"
| "colour-orange"
| "colour-blue"
| "colour-purple"
| "colour-green"
| null;
}; };
pupil_name: string; pupil_name: string;
lesson_name: string | null; lesson_name: string | null;
@ -247,7 +259,7 @@ export interface Lesson {
lesson_name: string; lesson_name: string;
subject_name: string; subject_name: string;
is_alternative_lesson: boolean; is_alternative_lesson: boolean;
is_break?: boolean; is_break?: boolean;
period_name: string; period_name: string;
period_number: string; period_number: string;
room_name: string; room_name: string;
@ -366,19 +378,19 @@ export type DetentionsResponse = ClassChartsResponse<
>; >;
export interface AnnouncementConsent { export interface AnnouncementConsent {
consent_given: "yes" | "no" consent_given: "yes" | "no";
comment: string | null comment: string | null;
parent_name: string parent_name: string;
} }
export interface AnnouncementPupilConsent { export interface AnnouncementPupilConsent {
pupil: { pupil: {
id: string id: string;
first_name: string first_name: string;
last_name: string last_name: string;
} };
can_change_consent: boolean can_change_consent: boolean;
consent: AnnouncementConsent | null consent: AnnouncementConsent | null;
} }
export interface Announcement { export interface Announcement {
@ -454,7 +466,7 @@ export interface GetAttendanceOptions {
export interface AttendancePeriod { export interface AttendancePeriod {
code: string; code: string;
status: "yes" | "present" | "ignore" | "no" | "absent" | "excused" | "late"; status: "yes" | "present" | "ignore" | "no" | "absent" | "excused" | "late";
late_minutes: number | string; late_minutes: number | string;
lesson_name?: string; lesson_name?: string;
room_name?: string; room_name?: string;