@insignia-education/api-sdk-js 0.15.83 → 0.15.85

package/package.json

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

package/src/api/v1/Admin.js

@@ -14,4 +14,46 @@ export default class Admin {
     statisticsSales({ fromDate, toDate } = {}) {
         return this.#client.get('/admin/statistics/sales', { from_date: fromDate, to_date: toDate });
     }
+
+    /** Paginated sales-report rows for a date range, with optional course/seller/payment-method/currency filters. */
+    reportsSales({ fromDate, toDate, courseId, sellerId, paymentMethodId, currencyId, page, perPage } = {}) {
+        return this.#client.get('/admin/reports/sales', {
+            from_date: fromDate, to_date: toDate,
+            course_id: courseId, seller_id: sellerId, payment_method_id: paymentMethodId, currency_id: currencyId,
+            page, per_page: perPage,
+        });
+    }
+
+    /** Sellers with at least one attributed payment — options for the sales report's seller filter. */
+    reportsSalesSellers() { return this.#client.get('/admin/reports/sales/sellers'); }
+
+    /** Direct download link for the sales report (format: 'csv' | 'xlsx') — open with <a href>, not fetch (cookie-authenticated, same convention as Users.js's invoiceUrl). */
+    reportsSalesExportUrl({ fromDate, toDate, courseId, sellerId, paymentMethodId, currencyId, format = 'csv' } = {}) {
+        return Admin.#buildUrl(this.#client.baseUrl, '/admin/reports/sales/export', {
+            from_date: fromDate, to_date: toDate,
+            course_id: courseId, seller_id: sellerId, payment_method_id: paymentMethodId, currency_id: currencyId,
+            format,
+        });
+    }
+
+    /** Paginated completed-courses report rows for a date range, with an optional course filter. */
+    reportsCompletedCourses({ fromDate, toDate, courseId, page, perPage } = {}) {
+        return this.#client.get('/admin/reports/completed-courses', {
+            from_date: fromDate, to_date: toDate, course_id: courseId, page, per_page: perPage,
+        });
+    }
+
+    /** Direct download link for the completed-courses report (format: 'csv' | 'xlsx'). */
+    reportsCompletedCoursesExportUrl({ fromDate, toDate, courseId, format = 'csv' } = {}) {
+        return Admin.#buildUrl(this.#client.baseUrl, '/admin/reports/completed-courses/export', {
+            from_date: fromDate, to_date: toDate, course_id: courseId, format,
+        });
+    }
+
+    static #buildUrl(baseUrl, path, params) {
+        const qs = new URLSearchParams(
+            Object.entries(params).filter(([, v]) => v !== undefined && v !== null && v !== '')
+        ).toString();
+        return `${baseUrl}${path}${qs ? `?${qs}` : ''}`;
+    }
 }

package/src/api/v1/Users.js

@@ -89,7 +89,12 @@ export default class Users {
         };
     }
 
-    /** get() accepts an optional { courseId } filter to narrow to a single course. */
+    /**
+     * get() accepts an optional { courseId } filter to narrow to a single course.
+     * A row's recording_url_video/recording_url_audio are only populated once Zoom's
+     * recording is archived AND this user's UserCourse.recording_view allows it for that
+     * course (staff always see it) — null otherwise, even if a recording exists.
+     */
     sessions(userId) {
         const base = `/users/${userId}/sessions`;
         const client = this.#client;