@heknon/node-webtop/dist/src/apiConfig.d.ts

A Backend for an unofficial WebTop (SmartSchool - Israel) API.

export declare const baseUrl: string;
export declare const baseApiUrl: Function;
export declare const apiAccessor: String;
export declare const defaultApiRoutes: {
    homework: string;
    todayTimetable: string;
    todayEvents: string;
    grades: (studentYear: number, firstHalf: boolean) => string;
    inbox: {
        search: (searchQuery?: string) => string;
        inbox: string;
        /**
         * POST REQUEST
         * FORM DATA
         * EXAMPLE:
         * ID=26312068 OR {ID: 26312068}
         */
        recipients: string;
        /**
         * POST REQUEST
         * FORM DATA
         * EXAMPLE:
         * IDs=25714320 OR {IDs: 25714320}
         * mass delete example: IDs: 25297630,25202096 OR IDs=25297630%2C25202096
         */
        deleteMessage: string;
        /**
         * POST REQUEST
         * FORM DATA
         * EXAMPLE:
         * IDs=25714320 OR {IDs: 25714320}
         * mass delete example: IDs: 25297630,25202096 OR IDs=25297630%2C25202096
         */
        markAsRead: string;
        /**
         * POST REQUEST
         * FORM DATA
         * EXAMPLE:
         * IDs=25714320 OR {IDs: 25714320}
         * mass delete example: IDs: 25297630,25202096 OR IDs=25297630%2C25202096
         */
        markAsUnread: string;
    };
    /**
     * POST REQUEST
     * FORM DATA
     * EXAMPLE:
     * type=teachers&value=pupilProTeachers OR {type: 'teachers', value: 'pupilProTeachers'}
     */
    users: string;
    /**
     * POST REQUEST
     * FORM DATA
     * EXAMPLE:
     * value=אורי OR {value: 'אורי'}
     */
    searchUsers: string;
    /**
     * POST REQUEST
     * FORM DATA
     * EXAMPLE:
     * newPassword=password OR {newPassword: 'password'}
     */
    changePassword: string;
    /**
     * POST REQUEST
     * FORM DATA
     * EXAMPLE:
     * currentPassword=password&newUsername=username OR {currentPassword: 'password', newUsername: 'username'}
     */
    changeUsername: string;
    /**
     * POST REQUEST
     * FORM DATA
     * EXAMPLE:
     * email=email&cellphone=number&emailUponUpdate=0&canReverifiedEmail=false&showMyCellphone=1&showMyEmail=1
     */
    changePersonalDetails: string;
    /**
     * POST REQUEST
     * FORM DATA
     * EXAMPLE:
     * pushNotification_messages=1&pushNotification_timetableChanges=1&pushNotification_timetableChangesEvents=1&pushNotification_timetableChangesTests=1&pushNotification_timetableChangesGeneralMessages=1&pushNotification_discipline=1&pushNotification_homework=1&pushNotification_grades=1&pushNotification_periodGrades=1&pushNotification_matriculationGrades=1
     */
    changePushNotifications: string;
};
export declare const routes: {
    timetable: string;
    eventCalendar: (month: number) => string;
    inbox: (page: number) => string;
    message: (id: number) => string;
    changesAndExams: string;
};