@insignia-education/api-sdk-js 0.25.9 → 0.25.11

package/README.md

@@ -387,6 +387,8 @@ await v1.users.courses(1).get();
 await v1.users.courseNotes(1).get();
 await v1.users.quizzes(1).get();
 await v1.users.sessions(1).get();
+await v1.users.sessions(1).rate(10, { clarity_rating: 5, correction_rating: 4, motivation_rating: 5 });
+await v1.users.topRatedTeachers();
 await v1.users.surveys(1).get();
 await v1.users.cart(1).get();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@insignia-education/api-sdk-js",
-  "version": "0.25.9",
+  "version": "0.25.11",
   "description": "JavaScript SDK for the Insignia Education API",
   "main": "index.js",
   "type": "module",

package/src/api/v1/Admin.js

@@ -53,6 +53,11 @@ export default class Admin {
         return this.#client.get('/admin/statistics/course-ratings');
     }
 
+    /** Teachers ranked by average session rating (best first): `[{ teacher_id, name, teacher_average, clarity_average, correction_average, motivation_average, ratings }]` (`teacher_average` = mean of the three). `from`/`to` (`YYYY-MM-DD`, both optional) limit it to ratings made in that period; omit both for all time. Employee-only. */
+    statisticsTeacherRatings({ from, to } = {}) {
+        return this.#client.get('/admin/statistics/teacher-ratings', { from, to });
+    }
+
     /** Claude (Anthropic) token usage/spend for a date range, plus account balance. Each half resolves `{ available: false }` (not an error) when its required config (admin key / account balance) isn't set. */
     statisticsClaudeUsage({ fromDate, toDate } = {}) {
         return this.#client.get('/admin/statistics/claude-usage', { from_date: fromDate, to_date: toDate });

package/src/api/v1/Employee.js

@@ -18,6 +18,10 @@ export default class Employee {
             teacherCourses: (teacherId) => this.#client.get(`${base}/teachers/${teacherId}/courses`),
             /** All sessions for one course_date, any teacher. */
             courseDateSessions: (courseDateId) => this.#client.get(`${base}/course-dates/${courseDateId}/sessions`),
+            /** Ranked roster ({id, name, email, rank}) of any course_date. */
+            courseDateStudents: (courseDateId) => this.#client.get(`${base}/course-dates/${courseDateId}/students`),
+            /** Save the ranking of one course_date's students: `studentIds` in order, first = rank 1. Returns the re-ranked roster. Ids not enrolled → 422. */
+            rankCourseDateStudents: (courseDateId, studentIds) => this.#client.put(`${base}/course-dates/${courseDateId}/students/ranking`, { student_ids: studentIds }),
             /** Mark a student's attendance on any teacher's session. */
             markAttendance: (sessionId, studentId, present) =>
                 this.#client.patch(`${base}/sessions/${sessionId}/attendance`, { student_id: studentId, present }),

package/src/api/v1/Teacher.js

@@ -54,8 +54,10 @@ export default class Teacher {
             courseDates: () => this.#client.get(`${base}/course-dates`),
             /** All sessions for one CourseDate, each with a `students` roster ({id, name, present}). */
             courseDateSessions: (courseDateId) => this.#client.get(`${base}/course-dates/${courseDateId}/sessions`),
-            /** Enrolled roster ({id, name, email}) for one CourseDate, read straight off enrollment — shows up even before any session has been synced. Read-only: does not move students between dates. */
+            /** Enrolled roster ({id, name, email, rank}, ranked first — unranked last) for one CourseDate, read straight off enrollment — shows up even before any session has been synced. Read-only: does not move students between dates. */
             courseDateStudents: (courseDateId) => this.#client.get(`${base}/course-dates/${courseDateId}/students`),
+            /** Save the teacher's ranking of one CourseDate's students: `studentIds` in order, first = rank 1. Returns the re-ranked roster ({id, name, email, rank}). Ids not enrolled → 422. */
+            rankCourseDateStudents: (courseDateId, studentIds) => this.#client.put(`${base}/course-dates/${courseDateId}/students/ranking`, { student_ids: studentIds }),
             /** One student's quiz attempts in this CourseDate's course, every one of them - not just needs_teacher_correction=1 (auto-graded ones never show up in the "Quizzes por corregir" surfaces below). Each row carries `quiz.needs_teacher_correction`, `level`/`lesson`, `final_score_percentage`; filter by level/lesson client-side. */
             courseDateStudentQuizzes: (courseDateId, studentId) => this.#client.get(`${base}/course-dates/${courseDateId}/students/${studentId}/quizzes`),
             /** { url, pending } — the zip archive of this group's course materials, or pending:true while it's (re)building. */

package/src/api/v1/Users.js

@@ -160,9 +160,23 @@ export default class Users {
              * session starts; a seller-and-above may reset any time.
              */
             reset:  (id)        => client.post(`${base}/${id}/reset`),
+            /**
+             * Student rates a finished session they attended — one-time, locked afterwards.
+             * `{ clarity_rating, correction_rating, motivation_rating }` (clear explanations / helpful respectful
+             * corrections / motivates speaking English), each an integer 1-5. Only the student themself
+             * (not staff) can submit it. 422 if the session hasn't ended / has no teacher, 403 if the
+             * student wasn't marked present, 409 if already rated. The booking list rows carry the
+             * submitted rating as `my_rating` (or null).
+             */
+            rate:   (id, data)  => client.post(`${base}/${id}/rating`, data),
         };
     }
 
+    /** Top 3 teachers by overall average session rating (all time), visible to any authenticated user: `[{ teacher_id, name, teacher_average, ratings }]` (`teacher_average` = mean of the three questions). */
+    topRatedTeachers() {
+        return this.#client.get('/teachers/top-rated');
+    }
+
     surveys(userId)        { return this.#nested(userId, 'surveys'); }
     cart(userId)           { return this.#nested(userId, 'cart'); }