@itutoring/itutoring_application_js_api 1.1.15 → 1.1.17

package/index.d.ts

@@ -19,6 +19,7 @@ import TeacherPortal from "./modules/TeacherPortal";
 import TeacherProfiles from "./modules/TeacherProfiles";
 import WebinarSystem from "./modules/WebinarsSystem";
 import GoogleReviews from "./modules/GoogleReviews";
+import CustomerEduPortal from "./modules/CustomerEduPortal";
 
 import Course from "./objects/Course";
 import CourseReservation from "./objects/CourseReservation";
@@ -27,6 +28,7 @@ import Reservation from "./objects/Reservation";
 import Subject from "./objects/Subject";
 import Teacher from "./objects/Teacher";
 import TeacherProfile from "./objects/TeacherProfile";
+import iEvent from "./objects/Event";
 
 import
     {
@@ -57,6 +59,7 @@ export
     TeacherProfiles,
     WebinarSystem,
     GoogleReviews,
+    CustomerEduPortal,
 
     Course,
     CourseReservation,
@@ -65,6 +68,7 @@ export
     Subject,
     Teacher,
     TeacherProfile,
+    iEvent,
 
     BookReturn,
     AuthResult,

package/index.js

@@ -17,6 +17,7 @@ import TeacherPortal from "./modules/TeacherPortal";
 import TeacherProfiles from "./modules/TeacherProfiles";
 import WebinarSystem from "./modules/WebinarsSystem";
 import GoogleReviews from "./modules/GoogleReviews";
+import CustomerEduPortal from "./modules/CustomerEduPortal";
 
 import Course from "./objects/Course";
 import CourseReservation from "./objects/CourseReservation";
@@ -25,6 +26,7 @@ import Reservation from "./objects/Reservation";
 import Subject from "./objects/Subject";
 import Teacher from "./objects/Teacher";
 import TeacherProfile from "./objects/TeacherProfile";
+import iEvent from "./objects/Event";
 
 import
     {
@@ -55,6 +57,7 @@ export
     TeacherProfiles,
     WebinarSystem,
     GoogleReviews,
+    CustomerEduPortal,
 
     Course,
     CourseReservation,
@@ -63,6 +66,7 @@ export
     Subject,
     Teacher,
     TeacherProfile,
+    iEvent,
 
     BookReturn,
     AuthResult,

package/modules/CustomerEduPortal.js

@@ -0,0 +1,202 @@
+import APIController from "../apiController";
+import iEvent from "../objects/Event";
+
+
+class CustomerEduPortal
+{
+    static #MODULE = "CustomerEduPortal";
+
+    static #GET_ALL_EVENTS = "GetAllEvents";
+    static #CREATE_EVENT = "CreateEvent";
+    static #ADD_GUESTS = "AddGuests";
+    static #OPEN_CONFERENCE = "OpenConference";
+    static #MAKE_CONFERENCE_PRIVATE = "MakeConferencePrivate";
+    static #UPDATE_PASSCODE = "UpdatePassCode";
+    static #REQUEST_ACCESS = "RequestAccess";
+    static #UPDATE_TYPE = "UpdateType";
+    static #UPDATE_NAME = "UpdateName";
+    static #UPDATE_DESCRIPTION = "UpdateDescription";
+    static #SET_SUBJECT = "SetSubject";
+    static #SET_ONE_TIME = "SetOneTime";
+    static #SET_RECURSIVE = "SetRecursive";
+    static #SET_DATE_AND_TIME = "SetDateAndTime";
+    static #SET_DAY = "SetDay";
+
+    static async GetAllEvents()
+    {
+        var events = await APIController.Get(this.#MODULE, this.#GET_ALL_EVENTS);
+
+        var eventObjs = [];
+
+        var eventsJson = JSON.parse(events)
+        for (const [key, value] of Object.entries(eventsJson))
+        {
+            eventObjs.push(((new iEvent()).CreateFromJSON(value)));
+        }
+
+        return eventObjs;
+    }
+
+    static async CreateEvent()
+    {
+        var event = await APIController.Post(this.#MODULE, this.#CREATE_EVENT);
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async AddGuests(eventId, guests)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#ADD_GUESTS, {
+            "eventId": eventId,
+            "guests": JSON.stringify(guests),
+        });
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async OpenConference(eventId)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#OPEN_CONFERENCE, {
+            "eventId": eventId,
+        });
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async MakeConferencePrivate(eventId, passCode)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#MAKE_CONFERENCE_PRIVATE, {
+            "eventId": eventId,
+            "passCode": passCode,
+        });
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async UpdatePassCode(eventId, passCode)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#UPDATE_PASSCODE, {
+            "eventId": eventId,
+            "passCode": passCode,
+        });
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async RequestAccess(eventId)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#REQUEST_ACCESS, {
+            "eventId": eventId,
+        })
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async UpdateType(eventId, type)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#UPDATE_TYPE, {
+            "eventId": eventId,
+            "type": type,
+        });
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async UpdateName(eventId, name)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#UPDATE_NAME, {
+            "eventId": eventId,
+            "name": name,
+        });
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async UpdateDescription(eventId, description)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#UPDATE_DESCRIPTION, {
+            'eventId': eventId,
+            'desc': description,
+        });
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async SetSubejct(eventId, subId)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#SET_SUBJECT, {
+            'eventId': eventId,
+            'subjectId': subId,
+        });
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async SetOneTime(eventId)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#SET_ONE_TIME, {
+            'eventId': eventId,
+        });
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async SetRecursive(eventId)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#SET_RECURSIVE, {
+            'eventId': eventId,
+        });
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async SetDateAndTime(eventId, timestamp)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#SET_DATE_AND_TIME, {
+            'eventId': eventId,
+            'timestamp': timestamp,
+        });
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+
+    static async SetDay(eventId, dayIndex)
+    {
+        var event = await APIController.Post(this.#MODULE, this.#SET_DAY, {
+            'eventId': eventId,
+            'day': dayIndex,
+        });
+
+        var eventObj = new iEvent();
+        eventObj.CreateFromJSON(event);
+        return eventObj;
+    }
+}
+
+export default CustomerEduPortal;

package/objects/Event.js

@@ -0,0 +1,107 @@
+
+class iEvent
+{
+    /**
+     * Event ID - cant be changed
+     */
+    ID;
+
+    /**
+     * In case of videoconference this code can be used for authentication to connect, when you are not on the guest list.
+     */
+    PassCode;
+
+    /**
+     * In case of video conference.
+     * 
+     * - !Must be positive eger!
+     */
+    RoomID = 0;
+    /** 
+     * Email / Name of user who is responsible for this event 
+     * 
+     * Can be teacher in case of leesons when the event is generated automaticly
+     */
+    Organizer;
+
+    /**
+     * Optional:  of invited people (their emails).
+     * 
+     * If someones not in this list, still can connect with PassCode.
+     */
+    Guests;
+
+    /**
+     * Anyone can join
+     */
+    Open;
+
+    /**
+     * If true organizer will have to manually allow the user when joining to be let in.
+     */
+    RequestAccess;
+
+    /**
+     * 0 - Lesson; 1 - General meeting
+     */
+    Type;
+
+    Name;
+    Description;
+
+    /**
+     * Optional: define which teached subject on this event.
+     */
+    Subject;
+
+    OneTime;
+    /**
+     * Date and time when this event takes place.
+     * 
+     * If is recursive, only time will be taken.
+     */
+    DateAndTime;
+    /**
+     * Day in week this event takes place. In case of recursive events
+     * 
+     * (starting with 1 up to 7)
+     */
+    DayInWeekIndex;
+
+    /**
+     * How many times this event should repeat. If left -1 it will be forever ... forever young I wanna be....
+     * 
+     * Just in case of recursive events
+     */
+    Recursivity;
+
+    IsVideoConference;
+
+    ReadOnly;
+
+
+    CreateFromJSON(json)
+    {
+        json = JSON.parse(json);
+
+        this.ID = json['ID'];
+        this.PassCode = json['PassCode'];
+        this.RoomID = json['RoomID'];
+        this.Organizer = json['Organizer'];
+        this.Guests = json['Guests'];
+        this.Open = json['Open'];
+        this.RequestAccess = json['RequestAccess'];
+        this.Type = json['Type'];
+        this.Name = json['Name'];
+        this.Description = json['Description'];
+        this.Subject = json['Subject'];
+        this.OneTime = json['OneTime'];
+        this.DateAndTime = json['DateAndTime'];
+        this.DayInWeekIndex = json['DayInWeekIndex'];
+        this.Recursivity = json['Recursivity'];
+        this.IsVideoConference = json['IsVideoConference'];
+        this.ReadOnly = json['ReadOnly'];
+    }
+}
+
+export default iEvent;

package/objects/TeacherProfile.js

@@ -3,7 +3,7 @@ class TeacherProfile
     Name;
     Bio;
     PhotoPath;
-    Subejcts;
+    Subjects;
 }
 
 export default TeacherProfile;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itutoring/itutoring_application_js_api",
-  "version": "1.1.15",
+  "version": "1.1.17",
   "description": "Javascript API for iTutoring Application",
   "main": "index.js",
   "types": "index.d.ts",