Skip to content

Commit

Permalink
prep release 0.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@Ahmad-A0
Ahmad-A0 committed Apr 9, 2022
1 parent 6099b76 commit 63289a7
Show file tree
Hide file tree
Showing 5 changed files with 81 additions and 78 deletions.
20 changes: 10 additions & 10 deletions docs/classes/Edulink_API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)
52 changes: 26 additions & 26 deletions docs/classes/Edulink_Raw.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)

---

Expand All @@ -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)
Loading

0 comments on commit 63289a7

Please sign in to comment.