@easyedu/js-lsm-api 1.131.0 → 1.132.0

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)
+
+

package/docs/SystemPortalSupportStats.md

@@ -0,0 +1,40 @@
+
+# SystemPortalSupportStats
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`open` | number
+`inProgress` | number
+`closed` | number
+`total` | number
+
+## Example
+
+```typescript
+import type { SystemPortalSupportStats } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "open": null,
+  "inProgress": null,
+  "closed": null,
+  "total": null,
+} satisfies SystemPortalSupportStats
+
+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 SystemPortalSupportStats
+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/SystemPortalUserStats.md

@@ -0,0 +1,50 @@
+
+# SystemPortalUserStats
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`enabled` | number
+`disabled` | number
+`newLast30Days` | number
+`activeLast7Days` | number
+`activeLast30Days` | number
+`pendingInvitations` | number
+`lastLoginAt` | number
+`byRole` | [Array<SystemPortalRoleCount>](SystemPortalRoleCount.md)
+
+## Example
+
+```typescript
+import type { SystemPortalUserStats } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": null,
+  "enabled": null,
+  "disabled": null,
+  "newLast30Days": null,
+  "activeLast7Days": null,
+  "activeLast30Days": null,
+  "pendingInvitations": null,
+  "lastLoginAt": null,
+  "byRole": null,
+} satisfies SystemPortalUserStats
+
+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 SystemPortalUserStats
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.131.0",
+  "version": "1.132.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/SystemApi.ts

@@ -38,6 +38,11 @@ import {
     GetSystemMetricsFromJSON,
     GetSystemMetricsToJSON,
 } from '../models/GetSystemMetrics';
+import {
+    type GetSystemPortalOverview,
+    GetSystemPortalOverviewFromJSON,
+    GetSystemPortalOverviewToJSON,
+} from '../models/GetSystemPortalOverview';
 
 export interface GetSystemBillingRequest {
     page?: number;
@@ -48,6 +53,10 @@ export interface GetSystemPortalRequest {
     portalId: string;
 }
 
+export interface GetSystemPortalOverviewRequest {
+    portalId: string;
+}
+
 export interface GetSystemPortalsRequest {
     page?: number;
     pageSize?: number;
@@ -190,6 +199,51 @@ export class SystemApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getSystemPortalOverview without sending the request
+     */
+    async getSystemPortalOverviewRequestOpts(requestParameters: GetSystemPortalOverviewRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling getSystemPortalOverview().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/system/portals/{portalId}/overview`;
+        urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get detailed platform portal overview and usage statistics
+     */
+    async getSystemPortalOverviewRaw(requestParameters: GetSystemPortalOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSystemPortalOverview>> {
+        const requestOptions = await this.getSystemPortalOverviewRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSystemPortalOverviewFromJSON(jsonValue));
+    }
+
+    /**
+     * Get detailed platform portal overview and usage statistics
+     */
+    async getSystemPortalOverview(requestParameters: GetSystemPortalOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSystemPortalOverview> {
+        const response = await this.getSystemPortalOverviewRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getSystemPortals without sending the request
      */

package/src/models/GetSystemPortalOverview.ts

@@ -0,0 +1,261 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { SystemPortalCourseStats } from './SystemPortalCourseStats';
+import {
+    SystemPortalCourseStatsFromJSON,
+    SystemPortalCourseStatsFromJSONTyped,
+    SystemPortalCourseStatsToJSON,
+    SystemPortalCourseStatsToJSONTyped,
+} from './SystemPortalCourseStats';
+import type { SystemPortalLicense } from './SystemPortalLicense';
+import {
+    SystemPortalLicenseFromJSON,
+    SystemPortalLicenseFromJSONTyped,
+    SystemPortalLicenseToJSON,
+    SystemPortalLicenseToJSONTyped,
+} from './SystemPortalLicense';
+import type { SystemPortalCertificateStats } from './SystemPortalCertificateStats';
+import {
+    SystemPortalCertificateStatsFromJSON,
+    SystemPortalCertificateStatsFromJSONTyped,
+    SystemPortalCertificateStatsToJSON,
+    SystemPortalCertificateStatsToJSONTyped,
+} from './SystemPortalCertificateStats';
+import type { SystemPortalStorageUsage } from './SystemPortalStorageUsage';
+import {
+    SystemPortalStorageUsageFromJSON,
+    SystemPortalStorageUsageFromJSONTyped,
+    SystemPortalStorageUsageToJSON,
+    SystemPortalStorageUsageToJSONTyped,
+} from './SystemPortalStorageUsage';
+import type { SystemPortalSupportStats } from './SystemPortalSupportStats';
+import {
+    SystemPortalSupportStatsFromJSON,
+    SystemPortalSupportStatsFromJSONTyped,
+    SystemPortalSupportStatsToJSON,
+    SystemPortalSupportStatsToJSONTyped,
+} from './SystemPortalSupportStats';
+import type { GetPortal } from './GetPortal';
+import {
+    GetPortalFromJSON,
+    GetPortalFromJSONTyped,
+    GetPortalToJSON,
+    GetPortalToJSONTyped,
+} from './GetPortal';
+import type { SystemPortalEnrollmentStats } from './SystemPortalEnrollmentStats';
+import {
+    SystemPortalEnrollmentStatsFromJSON,
+    SystemPortalEnrollmentStatsFromJSONTyped,
+    SystemPortalEnrollmentStatsToJSON,
+    SystemPortalEnrollmentStatsToJSONTyped,
+} from './SystemPortalEnrollmentStats';
+import type { SystemPortalActivityStats } from './SystemPortalActivityStats';
+import {
+    SystemPortalActivityStatsFromJSON,
+    SystemPortalActivityStatsFromJSONTyped,
+    SystemPortalActivityStatsToJSON,
+    SystemPortalActivityStatsToJSONTyped,
+} from './SystemPortalActivityStats';
+import type { SystemPortalContentStats } from './SystemPortalContentStats';
+import {
+    SystemPortalContentStatsFromJSON,
+    SystemPortalContentStatsFromJSONTyped,
+    SystemPortalContentStatsToJSON,
+    SystemPortalContentStatsToJSONTyped,
+} from './SystemPortalContentStats';
+import type { SystemPortalHierarchy } from './SystemPortalHierarchy';
+import {
+    SystemPortalHierarchyFromJSON,
+    SystemPortalHierarchyFromJSONTyped,
+    SystemPortalHierarchyToJSON,
+    SystemPortalHierarchyToJSONTyped,
+} from './SystemPortalHierarchy';
+import type { SystemPortalUserStats } from './SystemPortalUserStats';
+import {
+    SystemPortalUserStatsFromJSON,
+    SystemPortalUserStatsFromJSONTyped,
+    SystemPortalUserStatsToJSON,
+    SystemPortalUserStatsToJSONTyped,
+} from './SystemPortalUserStats';
+
+/**
+ * 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).
+ * @export
+ * @interface GetSystemPortalOverview
+ */
+export interface GetSystemPortalOverview {
+    /**
+     * 
+     * @type {GetPortal}
+     * @memberof GetSystemPortalOverview
+     */
+    portal: GetPortal;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetSystemPortalOverview
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetSystemPortalOverview
+     */
+    updatedAt: number;
+    /**
+     * When these statistics were computed.
+     * @type {number}
+     * @memberof GetSystemPortalOverview
+     */
+    generatedAt: number;
+    /**
+     * 
+     * @type {SystemPortalHierarchy}
+     * @memberof GetSystemPortalOverview
+     */
+    hierarchy: SystemPortalHierarchy;
+    /**
+     * 
+     * @type {SystemPortalLicense}
+     * @memberof GetSystemPortalOverview
+     */
+    license: SystemPortalLicense;
+    /**
+     * 
+     * @type {SystemPortalUserStats}
+     * @memberof GetSystemPortalOverview
+     */
+    users: SystemPortalUserStats;
+    /**
+     * 
+     * @type {SystemPortalCourseStats}
+     * @memberof GetSystemPortalOverview
+     */
+    courses: SystemPortalCourseStats;
+    /**
+     * 
+     * @type {SystemPortalEnrollmentStats}
+     * @memberof GetSystemPortalOverview
+     */
+    enrollments: SystemPortalEnrollmentStats;
+    /**
+     * 
+     * @type {SystemPortalContentStats}
+     * @memberof GetSystemPortalOverview
+     */
+    content: SystemPortalContentStats;
+    /**
+     * 
+     * @type {SystemPortalCertificateStats}
+     * @memberof GetSystemPortalOverview
+     */
+    certificates: SystemPortalCertificateStats;
+    /**
+     * 
+     * @type {SystemPortalStorageUsage}
+     * @memberof GetSystemPortalOverview
+     */
+    storage: SystemPortalStorageUsage;
+    /**
+     * 
+     * @type {SystemPortalActivityStats}
+     * @memberof GetSystemPortalOverview
+     */
+    activity: SystemPortalActivityStats;
+    /**
+     * 
+     * @type {SystemPortalSupportStats}
+     * @memberof GetSystemPortalOverview
+     */
+    support: SystemPortalSupportStats;
+}
+
+/**
+ * Check if a given object implements the GetSystemPortalOverview interface.
+ */
+export function instanceOfGetSystemPortalOverview(value: object): value is GetSystemPortalOverview {
+    if (!('portal' in value) || value['portal'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('generatedAt' in value) || value['generatedAt'] === undefined) return false;
+    if (!('hierarchy' in value) || value['hierarchy'] === undefined) return false;
+    if (!('license' in value) || value['license'] === undefined) return false;
+    if (!('users' in value) || value['users'] === undefined) return false;
+    if (!('courses' in value) || value['courses'] === undefined) return false;
+    if (!('enrollments' in value) || value['enrollments'] === undefined) return false;
+    if (!('content' in value) || value['content'] === undefined) return false;
+    if (!('certificates' in value) || value['certificates'] === undefined) return false;
+    if (!('storage' in value) || value['storage'] === undefined) return false;
+    if (!('activity' in value) || value['activity'] === undefined) return false;
+    if (!('support' in value) || value['support'] === undefined) return false;
+    return true;
+}
+
+export function GetSystemPortalOverviewFromJSON(json: any): GetSystemPortalOverview {
+    return GetSystemPortalOverviewFromJSONTyped(json, false);
+}
+
+export function GetSystemPortalOverviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSystemPortalOverview {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'portal': GetPortalFromJSON(json['portal']),
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'generatedAt': json['generated_at'],
+        'hierarchy': SystemPortalHierarchyFromJSON(json['hierarchy']),
+        'license': SystemPortalLicenseFromJSON(json['license']),
+        'users': SystemPortalUserStatsFromJSON(json['users']),
+        'courses': SystemPortalCourseStatsFromJSON(json['courses']),
+        'enrollments': SystemPortalEnrollmentStatsFromJSON(json['enrollments']),
+        'content': SystemPortalContentStatsFromJSON(json['content']),
+        'certificates': SystemPortalCertificateStatsFromJSON(json['certificates']),
+        'storage': SystemPortalStorageUsageFromJSON(json['storage']),
+        'activity': SystemPortalActivityStatsFromJSON(json['activity']),
+        'support': SystemPortalSupportStatsFromJSON(json['support']),
+    };
+}
+
+export function GetSystemPortalOverviewToJSON(json: any): GetSystemPortalOverview {
+    return GetSystemPortalOverviewToJSONTyped(json, false);
+}
+
+export function GetSystemPortalOverviewToJSONTyped(value?: GetSystemPortalOverview | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'portal': GetPortalToJSON(value['portal']),
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'generated_at': value['generatedAt'],
+        'hierarchy': SystemPortalHierarchyToJSON(value['hierarchy']),
+        'license': SystemPortalLicenseToJSON(value['license']),
+        'users': SystemPortalUserStatsToJSON(value['users']),
+        'courses': SystemPortalCourseStatsToJSON(value['courses']),
+        'enrollments': SystemPortalEnrollmentStatsToJSON(value['enrollments']),
+        'content': SystemPortalContentStatsToJSON(value['content']),
+        'certificates': SystemPortalCertificateStatsToJSON(value['certificates']),
+        'storage': SystemPortalStorageUsageToJSON(value['storage']),
+        'activity': SystemPortalActivityStatsToJSON(value['activity']),
+        'support': SystemPortalSupportStatsToJSON(value['support']),
+    };
+}
+

package/src/models/SystemPortalActivityStats.ts

@@ -0,0 +1,101 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SystemPortalActivityStats
+ */
+export interface SystemPortalActivityStats {
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalActivityStats
+     */
+    loginsLast30Days: number;
+    /**
+     * Active learning time recorded in the portal over the last 30 days.
+     * @type {number}
+     * @memberof SystemPortalActivityStats
+     */
+    learningSecondsLast30Days: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalActivityStats
+     */
+    chatRequestsLast30Days: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalActivityStats
+     */
+    chatTokensLast30Days: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SystemPortalActivityStats
+     */
+    lastLearningActivityAt?: number | null;
+}
+
+/**
+ * Check if a given object implements the SystemPortalActivityStats interface.
+ */
+export function instanceOfSystemPortalActivityStats(value: object): value is SystemPortalActivityStats {
+    if (!('loginsLast30Days' in value) || value['loginsLast30Days'] === undefined) return false;
+    if (!('learningSecondsLast30Days' in value) || value['learningSecondsLast30Days'] === undefined) return false;
+    if (!('chatRequestsLast30Days' in value) || value['chatRequestsLast30Days'] === undefined) return false;
+    if (!('chatTokensLast30Days' in value) || value['chatTokensLast30Days'] === undefined) return false;
+    return true;
+}
+
+export function SystemPortalActivityStatsFromJSON(json: any): SystemPortalActivityStats {
+    return SystemPortalActivityStatsFromJSONTyped(json, false);
+}
+
+export function SystemPortalActivityStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalActivityStats {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'loginsLast30Days': json['logins_last_30_days'],
+        'learningSecondsLast30Days': json['learning_seconds_last_30_days'],
+        'chatRequestsLast30Days': json['chat_requests_last_30_days'],
+        'chatTokensLast30Days': json['chat_tokens_last_30_days'],
+        'lastLearningActivityAt': json['last_learning_activity_at'] == null ? undefined : json['last_learning_activity_at'],
+    };
+}
+
+export function SystemPortalActivityStatsToJSON(json: any): SystemPortalActivityStats {
+    return SystemPortalActivityStatsToJSONTyped(json, false);
+}
+
+export function SystemPortalActivityStatsToJSONTyped(value?: SystemPortalActivityStats | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'logins_last_30_days': value['loginsLast30Days'],
+        'learning_seconds_last_30_days': value['learningSecondsLast30Days'],
+        'chat_requests_last_30_days': value['chatRequestsLast30Days'],
+        'chat_tokens_last_30_days': value['chatTokensLast30Days'],
+        'last_learning_activity_at': value['lastLearningActivityAt'],
+    };
+}
+