@easyedu/js-lsm-api 1.131.0 → 1.133.0

package/docs/QuestionApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getQuestionList**](QuestionApi.md#getquestionlist) | **GET** /questions | Get list of questions with filtering and pagination |
 | [**getQuestionVersions**](QuestionApi.md#getquestionversions) | **GET** /questions/{questionId}/versions | Get all versions of a question |
 | [**postQuestion**](QuestionApi.md#postquestion) | **POST** /questions | Create a new question |
+| [**postQuestionTags**](QuestionApi.md#postquestiontags) | **POST** /questions/tags | Add tags to several questions |
 | [**putQuestion**](QuestionApi.md#putquestion) | **PUT** /questions/{questionId} | Create the next version of a question |
 
 
@@ -355,6 +356,76 @@ 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)
 
 
+## postQuestionTags
+
+> PostQuestionTagsResponse postQuestionTags(postQuestionTags)
+
+Add tags to several questions
+
+Adds the given tags to every listed question, keeping existing tags. Tags are metadata, so no new question versions are created.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  QuestionApi,
+} from '@easyedu/js-lsm-api';
+import type { PostQuestionTagsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new QuestionApi();
+
+  const body = {
+    // PostQuestionTags
+    postQuestionTags: ...,
+  } satisfies PostQuestionTagsRequest;
+
+  try {
+    const data = await api.postQuestionTags(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postQuestionTags** | [PostQuestionTags](PostQuestionTags.md) |  | |
+
+### Return type
+
+[**PostQuestionTagsResponse**](PostQuestionTagsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Tags added |  -  |
+| **400** | Invalid question IDs or tags |  -  |
+| **403** | Missing permission |  -  |
+| **409** | A tag is archived |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## putQuestion
 
 > GetQuestion putQuestion(questionId, putQuestion)

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

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.133.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/PortalApi.ts

@@ -113,6 +113,7 @@ export interface GetPortalUsersRequest {
     type?: GetPortalUsersTypeEnum;
     roles?: Array<GetPortalUsersRolesEnum>;
     search?: string;
+    status?: GetPortalUsersStatusEnum;
     page?: number;
     pageSize?: number;
 }
@@ -549,6 +550,10 @@ export class PortalApi extends runtime.BaseAPI {
             queryParameters['search'] = requestParameters['search'];
         }
 
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
         if (requestParameters['page'] != null) {
             queryParameters['page'] = requestParameters['page'];
         }
@@ -1242,3 +1247,11 @@ export const GetPortalUsersRolesEnum = {
     Learner: 'Learner'
 } as const;
 export type GetPortalUsersRolesEnum = typeof GetPortalUsersRolesEnum[keyof typeof GetPortalUsersRolesEnum];
+/**
+ * @export
+ */
+export const GetPortalUsersStatusEnum = {
+    Active: 'active',
+    Removed: 'removed'
+} as const;
+export type GetPortalUsersStatusEnum = typeof GetPortalUsersStatusEnum[keyof typeof GetPortalUsersStatusEnum];