@easyedu/js-lsm-api 1.130.0 → 1.132.0

package/docs/ReportingApi.md

@@ -4,12 +4,87 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**exportReport**](ReportingApi.md#exportreport) | **POST** /reporting/reports/{reportKey}/export | Export all rows of a report as CSV or XLSX |
 | [**getCourseVersionReporting**](ReportingApi.md#getcourseversionreporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/reporting | Get instructor reporting for one explicit course version |
 | [**getCourseVersionSectionReporting**](ReportingApi.md#getcourseversionsectionreporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/sections/{sectionId}/reporting | Get instructor reporting for one section and its descendants in an explicit course version |
 | [**getPortalManagementDashboard**](ReportingApi.md#getportalmanagementdashboard) | **GET** /reporting/portal/dashboard | Get the selected portal\'s management dashboard reporting |
+| [**getReportCatalog**](ReportingApi.md#getreportcatalog) | **GET** /reporting/reports | List the reports the caller can run in the selected portal |
+| [**queryReport**](ReportingApi.md#queryreport) | **POST** /reporting/reports/{reportKey}/query | Run a report and return one page of rows |
 
 
 
+## exportReport
+
+> Blob exportReport(reportKey, postReportExport)
+
+Export all rows of a report as CSV or XLSX
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { ExportReportRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    reportKey: reportKey_example,
+    // PostReportExport
+    postReportExport: ...,
+  } satisfies ExportReportRequest;
+
+  try {
+    const data = await api.exportReport(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **reportKey** | `string` |  | [Defaults to `undefined`] |
+| **postReportExport** | [PostReportExport](PostReportExport.md) |  | |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `text/csv`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Report file |  -  |
+| **400** | Unsupported filter, invalid filter value, or unknown sort column |  -  |
+| **403** | Missing the report\'s permission |  -  |
+| **404** | Unknown report |  -  |
+| **422** | The export exceeds the maximum row count; narrow the filters |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getCourseVersionReporting
 
 > GetCourseVersionReporting getCourseVersionReporting(courseId, courseVersionId)
@@ -216,3 +291,135 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## getReportCatalog
+
+> GetReportCatalog getReportCatalog()
+
+List the reports the caller can run in the selected portal
+
+Returns report definitions with columns, supported filters, select options resolved for the selected portal, and default sort. Reports whose permission the caller lacks are omitted. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { GetReportCatalogRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  try {
+    const data = await api.getReportCatalog();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetReportCatalog**](GetReportCatalog.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Report catalog |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## queryReport
+
+> GetReportQueryResult queryReport(reportKey, postReportQuery)
+
+Run a report and return one page of rows
+
+Read-only. POST is used because filters vary per report. Results are scoped to the selected portal and its team portals. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { QueryReportRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // string
+    reportKey: reportKey_example,
+    // PostReportQuery
+    postReportQuery: ...,
+  } satisfies QueryReportRequest;
+
+  try {
+    const data = await api.queryReport(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **reportKey** | `string` |  | [Defaults to `undefined`] |
+| **postReportQuery** | [PostReportQuery](PostReportQuery.md) |  | |
+
+### Return type
+
+[**GetReportQueryResult**](GetReportQueryResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | One page of report rows |  -  |
+| **400** | Unsupported filter, invalid filter value, or unknown sort column |  -  |
+| **403** | Missing the report\'s permission |  -  |
+| **404** | Unknown report |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/SystemApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getSystemBilling**](SystemApi.md#getsystembilling) | **GET** /system/billing | List mock platform billing information |
 | [**getSystemMetrics**](SystemApi.md#getsystemmetrics) | **GET** /system/metrics | Get platform-wide metrics |
 | [**getSystemPortal**](SystemApi.md#getsystemportal) | **GET** /system/portals/{portalId} | Get platform portal detail |
+| [**getSystemPortalOverview**](SystemApi.md#getsystemportaloverview) | **GET** /system/portals/{portalId}/overview | Get detailed platform portal overview and usage statistics |
 | [**getSystemPortals**](SystemApi.md#getsystemportals) | **GET** /system/portals | List all platform portals |
 | [**getSystemSupportTickets**](SystemApi.md#getsystemsupporttickets) | **GET** /system/support/tickets | List open support tickets across the platform |
 
@@ -206,6 +207,73 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getSystemPortalOverview
+
+> GetSystemPortalOverview getSystemPortalOverview(portalId)
+
+Get detailed platform portal overview and usage statistics
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SystemApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSystemPortalOverviewRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SystemApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+  } satisfies GetSystemPortalOverviewRequest;
+
+  try {
+    const data = await api.getSystemPortalOverview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetSystemPortalOverview**](GetSystemPortalOverview.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal overview with user, course, enrollment, content, certificate, storage, activity, and support statistics |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Portal not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getSystemPortals
 
 > GetPortalList getSystemPortals(page, pageSize)

package/docs/SystemPortalActivityStats.md

@@ -0,0 +1,42 @@
+
+# SystemPortalActivityStats
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`loginsLast30Days` | number
+`learningSecondsLast30Days` | number
+`chatRequestsLast30Days` | number
+`chatTokensLast30Days` | number
+`lastLearningActivityAt` | number
+
+## Example
+
+```typescript
+import type { SystemPortalActivityStats } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "loginsLast30Days": null,
+  "learningSecondsLast30Days": null,
+  "chatRequestsLast30Days": null,
+  "chatTokensLast30Days": null,
+  "lastLearningActivityAt": null,
+} satisfies SystemPortalActivityStats
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SystemPortalActivityStats
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SystemPortalCertificateStats.md

@@ -0,0 +1,40 @@
+
+# SystemPortalCertificateStats
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`active` | number
+`revoked` | number
+`issuedLast30Days` | number
+`expiringNext30Days` | number
+
+## Example
+
+```typescript
+import type { SystemPortalCertificateStats } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "active": null,
+  "revoked": null,
+  "issuedLast30Days": null,
+  "expiringNext30Days": null,
+} satisfies SystemPortalCertificateStats
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SystemPortalCertificateStats
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SystemPortalContentStats.md

@@ -0,0 +1,43 @@
+
+# SystemPortalContentStats
+
+Non-archived Content Library items and active question bank entries owned by the portal.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`libraryItems` | number
+`resources` | number
+`quizzes` | number
+`certificateTemplates` | number
+`questions` | number
+
+## Example
+
+```typescript
+import type { SystemPortalContentStats } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "libraryItems": null,
+  "resources": null,
+  "quizzes": null,
+  "certificateTemplates": null,
+  "questions": null,
+} satisfies SystemPortalContentStats
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SystemPortalContentStats
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SystemPortalCourseStats.md

@@ -0,0 +1,44 @@
+
+# SystemPortalCourseStats
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`published` | number
+`unpublished` | number
+`createdLast30Days` | number
+`sharedIn` | number
+`sharedOut` | number
+
+## Example
+
+```typescript
+import type { SystemPortalCourseStats } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": null,
+  "published": null,
+  "unpublished": null,
+  "createdLast30Days": null,
+  "sharedIn": null,
+  "sharedOut": null,
+} satisfies SystemPortalCourseStats
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SystemPortalCourseStats
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SystemPortalEnrollmentStats.md

@@ -0,0 +1,43 @@
+
+# SystemPortalEnrollmentStats
+
+Learner (Student) enrollments in the portal.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`active` | number
+`completed` | number
+`createdLast30Days` | number
+`completedLast30Days` | number
+
+## Example
+
+```typescript
+import type { SystemPortalEnrollmentStats } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": null,
+  "active": null,
+  "completed": null,
+  "createdLast30Days": null,
+  "completedLast30Days": null,
+} satisfies SystemPortalEnrollmentStats
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SystemPortalEnrollmentStats
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SystemPortalHierarchy.md

@@ -0,0 +1,38 @@
+
+# SystemPortalHierarchy
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`parentPortalId` | string
+`parentPortalName` | string
+`childPortalCount` | number
+
+## Example
+
+```typescript
+import type { SystemPortalHierarchy } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "parentPortalId": null,
+  "parentPortalName": null,
+  "childPortalCount": null,
+} satisfies SystemPortalHierarchy
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SystemPortalHierarchy
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SystemPortalLicense.md

@@ -0,0 +1,42 @@
+
+# SystemPortalLicense
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`state` | string
+`seatLimit` | number
+`seatsUsed` | number
+`licenseStartAt` | number
+`licenseEndAt` | number
+
+## Example
+
+```typescript
+import type { SystemPortalLicense } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "state": null,
+  "seatLimit": null,
+  "seatsUsed": null,
+  "licenseStartAt": null,
+  "licenseEndAt": null,
+} satisfies SystemPortalLicense
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SystemPortalLicense
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SystemPortalRoleCount.md

@@ -0,0 +1,36 @@
+
+# SystemPortalRoleCount
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`baseType` | string
+`userCount` | number
+
+## Example
+
+```typescript
+import type { SystemPortalRoleCount } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "baseType": null,
+  "userCount": null,
+} satisfies SystemPortalRoleCount
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SystemPortalRoleCount
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SystemPortalStorageUsage.md

@@ -0,0 +1,49 @@
+
+# SystemPortalStorageUsage
+
+Stored object sizes attributed to the portal, in bytes, as recorded in the database at upload time. Pending and deleted uploads are excluded.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalBytes` | number
+`contentLibraryBytes` | number
+`richTextAssetBytes` | number
+`emailAssetBytes` | number
+`certificateAssetBytes` | number
+`certificateArtifactBytes` | number
+`supportAttachmentBytes` | number
+`courseExportBytes` | number
+
+## Example
+
+```typescript
+import type { SystemPortalStorageUsage } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalBytes": null,
+  "contentLibraryBytes": null,
+  "richTextAssetBytes": null,
+  "emailAssetBytes": null,
+  "certificateAssetBytes": null,
+  "certificateArtifactBytes": null,
+  "supportAttachmentBytes": null,
+  "courseExportBytes": null,
+} satisfies SystemPortalStorageUsage
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SystemPortalStorageUsage
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+