@easyedu/js-lsm-api 1.131.0 → 1.132.0

package/dist/models/SystemPortalUserStats.d.ts

@@ -0,0 +1,81 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { SystemPortalRoleCount } from './SystemPortalRoleCount';
+/**
+ *
+ * @export
+ * @interface SystemPortalUserStats
+ */
+export interface SystemPortalUserStats {
+    /**
+     * Distinct users holding at least one active role in the portal.
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    total: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    enabled: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    disabled: number;
+    /**
+     * Users whose earliest active role in the portal was assigned in the last 30 days.
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    newLast30Days: number;
+    /**
+     * Distinct users who logged in to the portal in the last 7 days.
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    activeLast7Days: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    activeLast30Days: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    pendingInvitations: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SystemPortalUserStats
+     */
+    lastLoginAt?: number | null;
+    /**
+     * Distinct users per role base type. A user with several roles is counted once per base type.
+     * @type {Array<SystemPortalRoleCount>}
+     * @memberof SystemPortalUserStats
+     */
+    byRole: Array<SystemPortalRoleCount>;
+}
+/**
+ * Check if a given object implements the SystemPortalUserStats interface.
+ */
+export declare function instanceOfSystemPortalUserStats(value: object): value is SystemPortalUserStats;
+export declare function SystemPortalUserStatsFromJSON(json: any): SystemPortalUserStats;
+export declare function SystemPortalUserStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalUserStats;
+export declare function SystemPortalUserStatsToJSON(json: any): SystemPortalUserStats;
+export declare function SystemPortalUserStatsToJSONTyped(value?: SystemPortalUserStats | null, ignoreDiscriminator?: boolean): any;

package/dist/models/SystemPortalUserStats.js

@@ -0,0 +1,81 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfSystemPortalUserStats = instanceOfSystemPortalUserStats;
+exports.SystemPortalUserStatsFromJSON = SystemPortalUserStatsFromJSON;
+exports.SystemPortalUserStatsFromJSONTyped = SystemPortalUserStatsFromJSONTyped;
+exports.SystemPortalUserStatsToJSON = SystemPortalUserStatsToJSON;
+exports.SystemPortalUserStatsToJSONTyped = SystemPortalUserStatsToJSONTyped;
+const SystemPortalRoleCount_1 = require("./SystemPortalRoleCount");
+/**
+ * Check if a given object implements the SystemPortalUserStats interface.
+ */
+function instanceOfSystemPortalUserStats(value) {
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    if (!('disabled' in value) || value['disabled'] === undefined)
+        return false;
+    if (!('newLast30Days' in value) || value['newLast30Days'] === undefined)
+        return false;
+    if (!('activeLast7Days' in value) || value['activeLast7Days'] === undefined)
+        return false;
+    if (!('activeLast30Days' in value) || value['activeLast30Days'] === undefined)
+        return false;
+    if (!('pendingInvitations' in value) || value['pendingInvitations'] === undefined)
+        return false;
+    if (!('byRole' in value) || value['byRole'] === undefined)
+        return false;
+    return true;
+}
+function SystemPortalUserStatsFromJSON(json) {
+    return SystemPortalUserStatsFromJSONTyped(json, false);
+}
+function SystemPortalUserStatsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'total': json['total'],
+        'enabled': json['enabled'],
+        'disabled': json['disabled'],
+        'newLast30Days': json['new_last_30_days'],
+        'activeLast7Days': json['active_last_7_days'],
+        'activeLast30Days': json['active_last_30_days'],
+        'pendingInvitations': json['pending_invitations'],
+        'lastLoginAt': json['last_login_at'] == null ? undefined : json['last_login_at'],
+        'byRole': (json['by_role'].map(SystemPortalRoleCount_1.SystemPortalRoleCountFromJSON)),
+    };
+}
+function SystemPortalUserStatsToJSON(json) {
+    return SystemPortalUserStatsToJSONTyped(json, false);
+}
+function SystemPortalUserStatsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'total': value['total'],
+        'enabled': value['enabled'],
+        'disabled': value['disabled'],
+        'new_last_30_days': value['newLast30Days'],
+        'active_last_7_days': value['activeLast7Days'],
+        'active_last_30_days': value['activeLast30Days'],
+        'pending_invitations': value['pendingInvitations'],
+        'last_login_at': value['lastLoginAt'],
+        'by_role': (value['byRole'].map(SystemPortalRoleCount_1.SystemPortalRoleCountToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -165,6 +165,7 @@ export * from './GetSupportTicketList';
 export * from './GetSystemBillingItem';
 export * from './GetSystemBillingList';
 export * from './GetSystemMetrics';
+export * from './GetSystemPortalOverview';
 export * from './GetUser';
 export * from './GetUserAvatarUpload';
 export * from './GetUserCourseList';
@@ -376,6 +377,17 @@ export * from './ScormSetValueRequest';
 export * from './ScormSetValueResponse';
 export * from './ScormTerminateResponse';
 export * from './SupportTicketUser';
+export * from './SystemPortalActivityStats';
+export * from './SystemPortalCertificateStats';
+export * from './SystemPortalContentStats';
+export * from './SystemPortalCourseStats';
+export * from './SystemPortalEnrollmentStats';
+export * from './SystemPortalHierarchy';
+export * from './SystemPortalLicense';
+export * from './SystemPortalRoleCount';
+export * from './SystemPortalStorageUsage';
+export * from './SystemPortalSupportStats';
+export * from './SystemPortalUserStats';
 export * from './UpdateSelectedPortalResponse';
 export * from './UpdateSelectedPortalResponseHostPortal';
 export * from './UpdateSelectedPortalResponseSelectedPortal';

package/dist/models/index.js

@@ -183,6 +183,7 @@ __exportStar(require("./GetSupportTicketList"), exports);
 __exportStar(require("./GetSystemBillingItem"), exports);
 __exportStar(require("./GetSystemBillingList"), exports);
 __exportStar(require("./GetSystemMetrics"), exports);
+__exportStar(require("./GetSystemPortalOverview"), exports);
 __exportStar(require("./GetUser"), exports);
 __exportStar(require("./GetUserAvatarUpload"), exports);
 __exportStar(require("./GetUserCourseList"), exports);
@@ -394,6 +395,17 @@ __exportStar(require("./ScormSetValueRequest"), exports);
 __exportStar(require("./ScormSetValueResponse"), exports);
 __exportStar(require("./ScormTerminateResponse"), exports);
 __exportStar(require("./SupportTicketUser"), exports);
+__exportStar(require("./SystemPortalActivityStats"), exports);
+__exportStar(require("./SystemPortalCertificateStats"), exports);
+__exportStar(require("./SystemPortalContentStats"), exports);
+__exportStar(require("./SystemPortalCourseStats"), exports);
+__exportStar(require("./SystemPortalEnrollmentStats"), exports);
+__exportStar(require("./SystemPortalHierarchy"), exports);
+__exportStar(require("./SystemPortalLicense"), exports);
+__exportStar(require("./SystemPortalRoleCount"), exports);
+__exportStar(require("./SystemPortalStorageUsage"), exports);
+__exportStar(require("./SystemPortalSupportStats"), exports);
+__exportStar(require("./SystemPortalUserStats"), exports);
 __exportStar(require("./UpdateSelectedPortalResponse"), exports);
 __exportStar(require("./UpdateSelectedPortalResponseHostPortal"), exports);
 __exportStar(require("./UpdateSelectedPortalResponseSelectedPortal"), exports);

package/docs/GetSystemPortalOverview.md

@@ -0,0 +1,61 @@
+
+# GetSystemPortalOverview
+
+Detailed read-only overview of a single portal for platform administrators. All counts are scoped to the portal itself and exclude child portals. Timestamps are Unix epoch seconds (UTC).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`portal` | [GetPortal](GetPortal.md)
+`createdAt` | number
+`updatedAt` | number
+`generatedAt` | number
+`hierarchy` | [SystemPortalHierarchy](SystemPortalHierarchy.md)
+`license` | [SystemPortalLicense](SystemPortalLicense.md)
+`users` | [SystemPortalUserStats](SystemPortalUserStats.md)
+`courses` | [SystemPortalCourseStats](SystemPortalCourseStats.md)
+`enrollments` | [SystemPortalEnrollmentStats](SystemPortalEnrollmentStats.md)
+`content` | [SystemPortalContentStats](SystemPortalContentStats.md)
+`certificates` | [SystemPortalCertificateStats](SystemPortalCertificateStats.md)
+`storage` | [SystemPortalStorageUsage](SystemPortalStorageUsage.md)
+`activity` | [SystemPortalActivityStats](SystemPortalActivityStats.md)
+`support` | [SystemPortalSupportStats](SystemPortalSupportStats.md)
+
+## Example
+
+```typescript
+import type { GetSystemPortalOverview } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "portal": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "generatedAt": null,
+  "hierarchy": null,
+  "license": null,
+  "users": null,
+  "courses": null,
+  "enrollments": null,
+  "content": null,
+  "certificates": null,
+  "storage": null,
+  "activity": null,
+  "support": null,
+} satisfies GetSystemPortalOverview
+
+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 GetSystemPortalOverview
+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/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)
+
+