@insignia-education/api-sdk-js 0.22.0 → 0.24.0

package/package.json

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

package/src/api/v1/Admin.js

@@ -163,6 +163,13 @@ export default class Admin {
         });
     }
 
+    /** Organization-wide OpenAI completion usage, model breakdown and spend for a date range. Resolves `{ available: false }` when the API server has no valid OpenAI Admin API key. */
+    reportsOpenAiUsage({ fromDate, toDate } = {}) {
+        return this.#client.get('/admin/reports/openai-usage', {
+            from_date: fromDate, to_date: toDate,
+        });
+    }
+
     /** Direct link to a repo's CI-generated test-coverage HTML report ('api' | 'front' | 'api-sdk-js') — open with <a href>/<iframe src>, cookie-authenticated, not fetch. */
     coverageUrl(repo) {
         return `${this.#client.baseUrl}/admin/coverage/${repo}/`;

package/src/api/v1/Users.js

@@ -226,6 +226,24 @@ export default class Users {
         };
     }
 
+    /**
+     * Guided-tutorial status per user. Each tutorial is identified by a code
+     * (e.g. "dashboard-student") and is `pending` until the user finishes or skips
+     * it, then `viewed` — so the front can avoid showing the same tour twice.
+     */
+    tutorials(userId) {
+        const base = `/users/${userId}/tutorials`;
+        const client = this.#client;
+        return {
+            /** Every known tutorial code with its status: [{ code, status, viewed_at }]. */
+            get: () => client.get(base),
+            /** One tutorial's { code, status: 'pending'|'viewed', viewed_at }. Unknown code → 404. */
+            status: (code) => client.get(`${base}/${code}`),
+            /** Mark a tutorial as viewed (idempotent). Unknown code → 404. */
+            markViewed: (code) => client.post(`${base}/${code}/viewed`),
+        };
+    }
+
     experiences(userId) {
         const base = `/users/${userId}/experiences`;
         const client = this.#client;