From 63289a7ad429e01c56afc51dfa66c755c1c7cccc Mon Sep 17 00:00:00 2001 From: aa0 <71089234+Ahmad-A0@users.noreply.github.com> Date: Sat, 9 Apr 2022 20:31:55 +0100 Subject: [PATCH] prep release `0.4.0` --- docs/classes/Edulink_API.md | 20 ++--- docs/classes/Edulink_Raw.md | 52 ++++++------ docs/modules/Edulink_Raw_Response_Types.md | 82 ++++++++++--------- package.json | 2 +- .../Edulink_Timetable.ts | 3 +- 5 files changed, 81 insertions(+), 78 deletions(-) diff --git a/docs/classes/Edulink_API.md b/docs/classes/Edulink_API.md index fa23b66..e338439 100644 --- a/docs/classes/Edulink_API.md +++ b/docs/classes/Edulink_API.md @@ -34,7 +34,7 @@ If you require more granular control over the API, you can use the [Edulink_Raw] #### Defined in -[API/API.ts:98](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/API/API.ts#L98) +[API/API.ts:98](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/API/API.ts#L98) ## Properties @@ -46,7 +46,7 @@ This is the [Edulink_Raw](Edulink_API.md#edulink_raw) instance that is used to m #### Defined in -[API/API.ts:31](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/API/API.ts#L31) +[API/API.ts:31](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/API/API.ts#L31) --- @@ -69,7 +69,7 @@ This is used to store maps from ids to objects #### Defined in -[API/API.ts:47](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/API/API.ts#L47) +[API/API.ts:47](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/API/API.ts#L47) --- @@ -90,7 +90,7 @@ This is used to store the raw_responses from the api calls #### Defined in -[API/API.ts:36](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/API/API.ts#L36) +[API/API.ts:36](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/API/API.ts#L36) --- @@ -102,7 +102,7 @@ Whether the [Edulink_API](Edulink_API.md) instance has been authenticated #### Defined in -[API/API.ts:21](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/API/API.ts#L21) +[API/API.ts:21](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/API/API.ts#L21) --- @@ -114,7 +114,7 @@ If this is true the server will be pinged every 5 minutes to keep the session al #### Defined in -[API/API.ts:26](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/API/API.ts#L26) +[API/API.ts:26](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/API/API.ts#L26) --- @@ -138,7 +138,7 @@ This is defined when [Edulink_API.Authenticate](Edulink_API.md#authenticate) is #### Defined in -[API/API.ts:89](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/API/API.ts#L89) +[API/API.ts:89](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/API/API.ts#L89) ## Methods @@ -164,7 +164,7 @@ A promise that resolves to an array of `[forename, surname, avatar]` #### Defined in -[API/API.ts:112](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/API/API.ts#L112) +[API/API.ts:112](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/API/API.ts#L112) --- @@ -189,7 +189,7 @@ An array of objects that represent a homework #### Defined in -[API/API.ts:344](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/API/API.ts#L344) +[API/API.ts:344](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/API/API.ts#L344) --- @@ -215,4 +215,4 @@ An array of objects that represent a date and its events #### Defined in -[API/API.ts:246](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/API/API.ts#L246) +[API/API.ts:246](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/API/API.ts#L246) diff --git a/docs/classes/Edulink_Raw.md b/docs/classes/Edulink_Raw.md index 3429f3b..fa907ea 100644 --- a/docs/classes/Edulink_Raw.md +++ b/docs/classes/Edulink_Raw.md @@ -68,7 +68,7 @@ This houses the authentication bearer #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:50](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L50) +[Raw_Edulink_Requests/Edulink_Raw.ts:50](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L50) --- @@ -80,7 +80,7 @@ The ID of the current signed in user #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:40](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L40) +[Raw_Edulink_Requests/Edulink_Raw.ts:40](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L40) --- @@ -92,7 +92,7 @@ The base server that requests are made to #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:45](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L45) +[Raw_Edulink_Requests/Edulink_Raw.ts:45](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L45) ## Accessors @@ -114,7 +114,7 @@ This returns some fields needed in the data section of the other requests #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:74](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L74) +[Raw_Edulink_Requests/Edulink_Raw.ts:74](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L74) ## Methods @@ -132,7 +132,7 @@ A promise that resolves to the [Edulink_Achievement](../modules/Edulink_Raw_Resp #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:250](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L250) +[Raw_Edulink_Requests/Edulink_Raw.ts:250](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L250) --- @@ -150,7 +150,7 @@ A promise that resolves to the [Edulink_AchievementBehaviourLookups](../modules/ #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:198](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L198) +[Raw_Edulink_Requests/Edulink_Raw.ts:198](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L198) --- @@ -168,7 +168,7 @@ A promise that resolves to the [Edulink_Attendance](../modules/Edulink_Raw_Respo #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:277](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L277) +[Raw_Edulink_Requests/Edulink_Raw.ts:277](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L277) --- @@ -186,7 +186,7 @@ A promise that resolves to the [Edulink_Behaviour](../modules/Edulink_Raw_Respon #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:170](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L170) +[Raw_Edulink_Requests/Edulink_Raw.ts:170](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L170) --- @@ -204,7 +204,7 @@ A promise that resolves to the [Edulink_Catering](../modules/Edulink_Raw_Respons #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:305](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L305) +[Raw_Edulink_Requests/Edulink_Raw.ts:305](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L305) --- @@ -228,7 +228,7 @@ A promise that resolves to the [Edulink_Clubs](../modules/Edulink_Raw_Response_T #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:460](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L460) +[Raw_Edulink_Requests/Edulink_Raw.ts:460](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L460) --- @@ -246,7 +246,7 @@ A promise that resolves to the [Edulink_Documents](../modules/Edulink_Raw_Respon #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:116](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L116) +[Raw_Edulink_Requests/Edulink_Raw.ts:116](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L116) --- @@ -264,7 +264,7 @@ A promise that resolves to the [Edulink_Exams](../modules/Edulink_Raw_Response_T #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:143](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L143) +[Raw_Edulink_Requests/Edulink_Raw.ts:143](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L143) --- @@ -282,7 +282,7 @@ A promise that resolves to the [Edulink_ExternalLinks](../modules/Edulink_Raw_Re #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:434](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L434) +[Raw_Edulink_Requests/Edulink_Raw.ts:434](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L434) --- @@ -300,7 +300,7 @@ A promise that resolves to the [Edulink_Homework](../modules/Edulink_Raw_Respons #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:332](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L332) +[Raw_Edulink_Requests/Edulink_Raw.ts:332](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L332) --- @@ -326,7 +326,7 @@ Change the completion status of a homework #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:361](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L361) +[Raw_Edulink_Requests/Edulink_Raw.ts:361](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L361) --- @@ -351,7 +351,7 @@ A promise that resolves to the [Edulink_HomeworkDetails](../modules/Edulink_Raw_ #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:400](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L400) +[Raw_Edulink_Requests/Edulink_Raw.ts:400](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L400) --- @@ -376,7 +376,7 @@ A promise that resolves to the [Edulink_Login](../modules/Edulink_Raw_Response_T #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:624](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L624) +[Raw_Edulink_Requests/Edulink_Raw.ts:624](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L624) --- @@ -394,7 +394,7 @@ A promise that resolves to the [Edulink_Logout](../modules/Edulink_Raw_Response_ #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:659](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L659) +[Raw_Edulink_Requests/Edulink_Raw.ts:659](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L659) --- @@ -412,7 +412,7 @@ A promise that resolves to the [Edulink_Personal](../modules/Edulink_Raw_Respons #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:488](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L488) +[Raw_Edulink_Requests/Edulink_Raw.ts:488](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L488) --- @@ -430,7 +430,7 @@ A promise that resolves to the [Edulink_Ping](../modules/Edulink_Raw_Response_Ty #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:684](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L684) +[Raw_Edulink_Requests/Edulink_Raw.ts:684](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L684) --- @@ -446,7 +446,7 @@ TODO: Can't remeber what this is #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:225](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L225) +[Raw_Edulink_Requests/Edulink_Raw.ts:225](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L225) --- @@ -470,7 +470,7 @@ information about the login options of the school as well as the school name and #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:569](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L569) +[Raw_Edulink_Requests/Edulink_Raw.ts:569](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L569) --- @@ -495,7 +495,7 @@ A promise that resolves to a response object that contains the school code and s #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:599](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L599) +[Raw_Edulink_Requests/Edulink_Raw.ts:599](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L599) --- @@ -513,7 +513,7 @@ A promise that resolves to the [Edulink_Status](../modules/Edulink_Raw_Response_ #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:515](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L515) +[Raw_Edulink_Requests/Edulink_Raw.ts:515](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L515) --- @@ -537,7 +537,7 @@ A promise that resolves to the [Edulink_Attendance](../modules/Edulink_Raw_Respo #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:88](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L88) +[Raw_Edulink_Requests/Edulink_Raw.ts:88](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L88) --- @@ -559,4 +559,4 @@ A promise that resolves to the [Edulink_Attendance](../modules/Edulink_Raw_Respo #### Defined in -[Raw_Edulink_Requests/Edulink_Raw.ts:58](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Requests/Edulink_Raw.ts#L58) +[Raw_Edulink_Requests/Edulink_Raw.ts:58](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Requests/Edulink_Raw.ts#L58) diff --git a/docs/modules/Edulink_Raw_Response_Types.md b/docs/modules/Edulink_Raw_Response_Types.md index 4cc6f91..6d0855b 100644 --- a/docs/modules/Edulink_Raw_Response_Types.md +++ b/docs/modules/Edulink_Raw_Response_Types.md @@ -69,7 +69,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Communicator_Inbox.ts:5](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Communicator_Inbox.ts#L5) +[Raw_Edulink_Response_Types/Communicator_Inbox.ts:5](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Communicator_Inbox.ts#L5) --- @@ -97,7 +97,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Communicator_Outbox.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Communicator_Outbox.ts#L1) +[Raw_Edulink_Response_Types/Communicator_Outbox.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Communicator_Outbox.ts#L1) --- @@ -119,7 +119,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Achievement.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Achievement.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Achievement.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Achievement.ts#L1) --- @@ -161,7 +161,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_AchievementBehaviourLookups.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_AchievementBehaviourLookups.ts#L1) +[Raw_Edulink_Response_Types/Edulink_AchievementBehaviourLookups.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_AchievementBehaviourLookups.ts#L1) --- @@ -183,7 +183,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_AssessmentGrids.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_AssessmentGrids.ts#L1) +[Raw_Edulink_Response_Types/Edulink_AssessmentGrids.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_AssessmentGrids.ts#L1) --- @@ -216,7 +216,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Attendance.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Attendance.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Attendance.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Attendance.ts#L1) --- @@ -247,7 +247,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Behaviour.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Behaviour.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Behaviour.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Behaviour.ts#L1) --- @@ -268,7 +268,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Calendar.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Calendar.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Calendar.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Calendar.ts#L1) --- @@ -290,7 +290,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Catering.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Catering.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Catering.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Catering.ts#L1) --- @@ -315,7 +315,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Clubs.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Clubs.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Clubs.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Clubs.ts#L1) --- @@ -365,7 +365,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_DataCollectionLookups.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_DataCollectionLookups.ts#L1) +[Raw_Edulink_Response_Types/Edulink_DataCollectionLookups.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_DataCollectionLookups.ts#L1) --- @@ -561,7 +561,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_DataCollectionValues.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_DataCollectionValues.ts#L1) +[Raw_Edulink_Response_Types/Edulink_DataCollectionValues.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_DataCollectionValues.ts#L1) --- @@ -582,7 +582,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Documents.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Documents.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Documents.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Documents.ts#L1) --- @@ -613,7 +613,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Exams.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Exams.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Exams.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Exams.ts#L1) --- @@ -638,7 +638,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_ExternalLinks.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_ExternalLinks.ts#L1) +[Raw_Edulink_Response_Types/Edulink_ExternalLinks.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_ExternalLinks.ts#L1) --- @@ -667,7 +667,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Homework.ts:19](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Homework.ts#L19) +[Raw_Edulink_Response_Types/Edulink_Homework.ts:19](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Homework.ts#L19) --- @@ -705,7 +705,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_HomeworkDetails.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_HomeworkDetails.ts#L1) +[Raw_Edulink_Response_Types/Edulink_HomeworkDetails.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_HomeworkDetails.ts#L1) --- @@ -732,7 +732,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_ICalendars.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_ICalendars.ts#L1) +[Raw_Edulink_Response_Types/Edulink_ICalendars.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_ICalendars.ts#L1) --- @@ -883,7 +883,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Login.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Login.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Login.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Login.ts#L1) --- @@ -903,7 +903,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Logout.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Logout.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Logout.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Logout.ts#L1) --- @@ -928,7 +928,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Noticeboard.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Noticeboard.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Noticeboard.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Noticeboard.ts#L1) --- @@ -995,7 +995,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Personal.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Personal.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Personal.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Personal.ts#L1) --- @@ -1021,7 +1021,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Ping.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Ping.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Ping.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Ping.ts#L1) --- @@ -1058,7 +1058,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_RegisterCodes.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_RegisterCodes.ts#L1) +[Raw_Edulink_Response_Types/Edulink_RegisterCodes.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_RegisterCodes.ts#L1) --- @@ -1093,7 +1093,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_SchoolDetails.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_SchoolDetails.ts#L1) +[Raw_Edulink_Response_Types/Edulink_SchoolDetails.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_SchoolDetails.ts#L1) --- @@ -1153,7 +1153,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Status.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Status.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Status.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Status.ts#L1) --- @@ -1179,7 +1179,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_TeacherPhotos.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_TeacherPhotos.ts#L1) +[Raw_Edulink_Response_Types/Edulink_TeacherPhotos.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_TeacherPhotos.ts#L1) --- @@ -1206,7 +1206,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Timetable.ts:40](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Timetable.ts#L40) +[Raw_Edulink_Response_Types/Edulink_Timetable.ts:42](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Timetable.ts#L42) --- @@ -1216,18 +1216,20 @@ Communicator Inbox #### Type declaration -| Name | Type | -| :----------- | :------------------------------------------------------------------------------------- | -| `date` | `string` | -| `id` | `number` | -| `is_current` | `boolean` | -| `lessons` | [`Edulink_Timetable_Lesson`](Edulink_Raw_Response_Types.md#edulink_timetable_lesson)[] | -| `name` | `string` | -| `periods` | [`Edulink_Timetable_Period`](Edulink_Raw_Response_Types.md#edulink_timetable_period)[] | +| Name | Type | +| :--------------- | :------------------------------------------------------------------------------------- | +| `cycle_day_id?` | `number` | +| `date` | `string` | +| `id` | `number` | +| `is_current` | `boolean` | +| `lessons` | [`Edulink_Timetable_Lesson`](Edulink_Raw_Response_Types.md#edulink_timetable_lesson)[] | +| `name` | `string` | +| `original_name?` | `string` | +| `periods` | [`Edulink_Timetable_Period`](Edulink_Raw_Response_Types.md#edulink_timetable_period)[] | #### Defined in -[Raw_Edulink_Response_Types/Edulink_Timetable.ts:31](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Timetable.ts#L31) +[Raw_Edulink_Response_Types/Edulink_Timetable.ts:31](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Timetable.ts#L31) --- @@ -1259,7 +1261,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Timetable.ts:8](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Timetable.ts#L8) +[Raw_Edulink_Response_Types/Edulink_Timetable.ts:8](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Timetable.ts#L8) --- @@ -1278,7 +1280,7 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/Edulink_Timetable.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/Edulink_Timetable.ts#L1) +[Raw_Edulink_Response_Types/Edulink_Timetable.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/Edulink_Timetable.ts#L1) --- @@ -1301,4 +1303,4 @@ Communicator Inbox #### Defined in -[Raw_Edulink_Response_Types/School_FromCode.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/4946bbe/src/Raw_Edulink_Response_Types/School_FromCode.ts#L1) +[Raw_Edulink_Response_Types/School_FromCode.ts:1](https://github.com/Ahmad-A0/Overnet-Edulink-API/blob/6099b76/src/Raw_Edulink_Response_Types/School_FromCode.ts#L1) diff --git a/package.json b/package.json index ba3f3d8..cd9fb32 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "Ahmad-A0", "name": "edulink-api", - "version": "0.3.4", + "version": "0.4.0", "description": "An unofficial API for interacting with OvernetData's Edulink service", "license": "MIT", "type": "module", diff --git a/src/Raw_Edulink_Response_Types/Edulink_Timetable.ts b/src/Raw_Edulink_Response_Types/Edulink_Timetable.ts index 97ca02c..c88d453 100644 --- a/src/Raw_Edulink_Response_Types/Edulink_Timetable.ts +++ b/src/Raw_Edulink_Response_Types/Edulink_Timetable.ts @@ -32,7 +32,8 @@ type Edulink_Timetable_Day = { id: number; date: string; name: string; - original_name: string; + cycle_day_id?: number; + original_name?: string; is_current: boolean; periods: Edulink_Timetable_Period[]; lessons: Edulink_Timetable_Lesson[];