@insignia-education/api-sdk-js 0.25.8 → 0.25.10

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.8",
+  "version": "0.25.10",
   "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/CompanyCelebrations.js

@@ -0,0 +1,16 @@
+export default class CompanyCelebrations {
+    #client;
+
+    constructor(client) {
+        this.#client = client;
+    }
+
+    /** Admin-only: a year of celebratory media, one entry per month (`{ month, media: { url, kind }[] }[]`, empty `media` where unset). */
+    get(year = new Date().getFullYear()) { return this.#client.get('/company-celebrations', { year }); }
+
+    /** Admin-only: replaces one month's media list (`kind` is `image` or `video`; `[]` clears it); resolves the full year. */
+    edit(year, month, media) { return this.#client.put('/company-celebrations', { year, month, media }); }
+
+    /** Sellers-and-above: the celebration to show right now — `{ active, year, month, media }`, `active` only in the month's first week. */
+    current() { return this.#client.get('/sales/celebration'); }
+}

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'); }
 

package/src/api/v1/index.js

@@ -6,6 +6,7 @@ import Accounts from './Accounts.js';
 import Certificates from './Certificates.js';
 import Changelogs from './Changelogs.js';
 import CompanySalesGoals from './CompanySalesGoals.js';
+import CompanyCelebrations from './CompanyCelebrations.js';
 import CompanySettings from './CompanySettings.js';
 import ContactForms from './ContactForms.js';
 import ContactTypes from './ContactTypes.js';
@@ -67,6 +68,7 @@ export default class InsigniaApiV1 extends InsigniaApi {
         this.certificates         = new Certificates(this);
         this.changelogs           = new Changelogs(this);
         this.companySalesGoals    = new CompanySalesGoals(this);
+        this.companyCelebrations  = new CompanyCelebrations(this);
         this.companySettings      = new CompanySettings(this);
         this.contactForms         = new ContactForms(this);
         this.contactTypes         = new ContactTypes(this);