docs: update documentation

SchoolUtils · Feb 16, 2024 · b546e88 · b546e88
1 parent c9fa544
commit b546e88
Show file tree

Hide file tree

Showing 44 changed files with 311 additions and 263 deletions.
diff --git a/dist/webuntis.d.ts b/dist/webuntis.d.ts
@@ -579,6 +579,12 @@ declare class Base {
      * @returns {Promise.<Array>}
      */
     getStatusData(validateSession?: boolean): Promise<StatusData>;
+    /**
+     * Get the current school year
+     * @param [validateSession=true]
+     * @returns {Promise.<SchoolYear>}
+     */
+    getCurrentSchoolyear(validateSession?: boolean): Promise<SchoolYear>;
     /**
      * Convert a JS Date Object to a WebUntis date string
      * @param {Date} date

diff --git a/dist/webuntis.js b/dist/webuntis.js
diff --git a/dist/webuntis.js.map b/dist/webuntis.js.map
diff --git a/dist/webuntis.mjs b/dist/webuntis.mjs
@@ -762,6 +762,22 @@ const _Base = class _Base {
   async getStatusData(validateSession = true) {
     return await this._request("getStatusData", {}, validateSession);
   }
+  /**
+   * Get the current school year
+   * @param [validateSession=true]
+   * @returns {Promise.<SchoolYear>}
+   */
+  async getCurrentSchoolyear(validateSession = true) {
+    const data = await this._request("getCurrentSchoolyear", {}, validateSession);
+    if (!data)
+      throw new Error("Failed to retrieve current school year");
+    return {
+      name: data.name,
+      id: data.id,
+      startDate: _Base.convertUntisDate(data.startDate),
+      endDate: _Base.convertUntisDate(data.endDate)
+    };
+  }
   /**
    * Convert a JS Date Object to a WebUntis date string
    * @param {Date} date

diff --git a/dist/webuntis.mjs.map b/dist/webuntis.mjs.map
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/InternalWebuntisSecretLogin.html b/docs/classes/InternalWebuntisSecretLogin.html
diff --git a/docs/classes/WebUntis.html b/docs/classes/WebUntis.html
diff --git a/docs/classes/WebUntisAnonymousAuth.html b/docs/classes/WebUntisAnonymousAuth.html
diff --git a/docs/classes/WebUntisQR.html b/docs/classes/WebUntisQR.html
diff --git a/docs/classes/WebUntisSecretAuth.html b/docs/classes/WebUntisSecretAuth.html
diff --git a/docs/enums/WebUntisDay.html b/docs/enums/WebUntisDay.html
diff --git a/docs/enums/WebUntisElementType.html b/docs/enums/WebUntisElementType.html
diff --git a/docs/interfaces/Absence.html b/docs/interfaces/Absence.html
diff --git a/docs/interfaces/Absences.html b/docs/interfaces/Absences.html
diff --git a/docs/interfaces/CodesEntity.html b/docs/interfaces/CodesEntity.html
diff --git a/docs/interfaces/ColorEntity.html b/docs/interfaces/ColorEntity.html
diff --git a/docs/interfaces/Department.html b/docs/interfaces/Department.html
diff --git a/docs/interfaces/Exam.html b/docs/interfaces/Exam.html
diff --git a/docs/interfaces/Excuse.html b/docs/interfaces/Excuse.html
diff --git a/docs/interfaces/Holiday.html b/docs/interfaces/Holiday.html
diff --git a/docs/interfaces/Homework.html b/docs/interfaces/Homework.html
diff --git a/docs/interfaces/Inbox.html b/docs/interfaces/Inbox.html
diff --git a/docs/interfaces/Inboxmessage.html b/docs/interfaces/Inboxmessage.html
diff --git a/docs/interfaces/Klasse.html b/docs/interfaces/Klasse.html
diff --git a/docs/interfaces/Lesson.html b/docs/interfaces/Lesson.html
diff --git a/docs/interfaces/LsEntity.html b/docs/interfaces/LsEntity.html
diff --git a/docs/interfaces/MessagesOfDay.html b/docs/interfaces/MessagesOfDay.html
diff --git a/docs/interfaces/Messagesender.html b/docs/interfaces/Messagesender.html
diff --git a/docs/interfaces/NewsWidget.html b/docs/interfaces/NewsWidget.html
diff --git a/docs/interfaces/Room.html b/docs/interfaces/Room.html
diff --git a/docs/interfaces/SchoolYear.html b/docs/interfaces/SchoolYear.html
diff --git a/docs/interfaces/ShortData.html b/docs/interfaces/ShortData.html
diff --git a/docs/interfaces/StatusData.html b/docs/interfaces/StatusData.html
diff --git a/docs/interfaces/Student.html b/docs/interfaces/Student.html
diff --git a/docs/interfaces/Subject.html b/docs/interfaces/Subject.html
diff --git a/docs/interfaces/Teacher.html b/docs/interfaces/Teacher.html
diff --git a/docs/interfaces/TimeUnit.html b/docs/interfaces/TimeUnit.html
diff --git a/docs/interfaces/Timegrid.html b/docs/interfaces/Timegrid.html
diff --git a/docs/interfaces/WebAPITimetable.html b/docs/interfaces/WebAPITimetable.html
diff --git a/docs/interfaces/WebElement.html b/docs/interfaces/WebElement.html
diff --git a/docs/interfaces/WebElementData.html b/docs/interfaces/WebElementData.html
diff --git a/docs/types/Authenticator.html b/docs/types/Authenticator.html
diff --git a/docs/types/URLClass.html b/docs/types/URLClass.html