@easyedu/js-lsm-api 1.79.0 → 1.81.0

package/docs/RichTextDocument.md

@@ -0,0 +1,40 @@
+
+# RichTextDocument
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`format` | string
+`document` | { [key: string]: any; }
+`plainText` | string
+`assets` | [Array<RichTextAsset>](RichTextAsset.md)
+
+## Example
+
+```typescript
+import type { RichTextDocument } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "format": null,
+  "document": null,
+  "plainText": null,
+  "assets": null,
+} satisfies RichTextDocument
+
+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 RichTextDocument
+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/RichTextInput.md

@@ -0,0 +1,36 @@
+
+# RichTextInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`format` | string
+`document` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { RichTextInput } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "format": null,
+  "document": null,
+} satisfies RichTextInput
+
+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 RichTextInput
+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/UserApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getAuthCheck**](UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in |
 | [**getCurrentUserPermissions**](UserApi.md#getcurrentuserpermissions) | **GET** /users/current/permissions | Get the current user\'s permissions |
 | [**getUser**](UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id |
+| [**getUserCourses**](UserApi.md#getusercourses) | **GET** /users/{userId}/courses | Get enrolled courses for a user |
 | [**getUserEnrollments**](UserApi.md#getuserenrollments) | **GET** /users/{userId}/enrollments | Get user enrollments |
 | [**postLogin**](UserApi.md#postlogin) | **POST** /auth/login | Post a new login |
 | [**postLogout**](UserApi.md#postlogout) | **POST** /auth/logout | Logout a user |
@@ -269,6 +270,95 @@ 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)
 
 
+## getUserCourses
+
+> GetUserCourseList getUserCourses(userId, page, pageSize, search, recentActivitySince, enrollmentStatus, orderBy, orderDirection)
+
+Get enrolled courses for a user
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserApi,
+} from '@easyedu/js-lsm-api';
+import type { GetUserCoursesRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new UserApi();
+
+  const body = {
+    // string | User external ID, or `current` for the authenticated user.
+    userId: userId_example,
+    // number | Page number for pagination. (optional)
+    page: 56,
+    // number | Number of items per page. (optional)
+    pageSize: 56,
+    // string | Case-insensitive match against course name or description. (optional)
+    search: search_example,
+    // number | Unix timestamp in seconds. Only courses with learner live content-session activity at or after this time are returned. (optional)
+    recentActivitySince: 789,
+    // string | Comma-separated list of selected enrollment statuses to include. Example: `enrollmentStatus=Enrolled,InProgress,Completed`. Unknown values are ignored.  (optional)
+    enrollmentStatus: enrollmentStatus_example,
+    // 'name' | 'created_at' | 'enrollment_date_start' | 'enrollment_status' | 'completion_percentage' | Field used to order the selected course list. (optional)
+    orderBy: orderBy_example,
+    // 'asc' | 'desc' | Sort direction. (optional)
+    orderDirection: orderDirection_example,
+  } satisfies GetUserCoursesRequest;
+
+  try {
+    const data = await api.getUserCourses(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `string` | User external ID, or `current` for the authenticated user. | [Defaults to `undefined`] |
+| **page** | `number` | Page number for pagination. | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Number of items per page. | [Optional] [Defaults to `20`] |
+| **search** | `string` | Case-insensitive match against course name or description. | [Optional] [Defaults to `undefined`] |
+| **recentActivitySince** | `number` | Unix timestamp in seconds. Only courses with learner live content-session activity at or after this time are returned. | [Optional] [Defaults to `undefined`] |
+| **enrollmentStatus** | `string` | Comma-separated list of selected enrollment statuses to include. Example: `enrollmentStatus=Enrolled,InProgress,Completed`. Unknown values are ignored.  | [Optional] [Defaults to `undefined`] |
+| **orderBy** | `name`, `created_at`, `enrollment_date_start`, `enrollment_status`, `completion_percentage` | Field used to order the selected course list. | [Optional] [Defaults to `'enrollment_date_start'`] [Enum: name, created_at, enrollment_date_start, enrollment_status, completion_percentage] |
+| **orderDirection** | `asc`, `desc` | Sort direction. | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
+
+### Return type
+
+[**GetUserCourseList**](GetUserCourseList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get user courses response OK |  -  |
+| **400** | Invalid query parameter |  -  |
+| **403** | Forbidden |  -  |
+| **404** | User 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)
+
+
 ## getUserEnrollments
 
 > GetCourseEnrollmentList getUserEnrollments(userId, type, status, page, pageSize)

package/package.json

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

package/src/apis/RichTextApi.ts

@@ -0,0 +1,201 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type GetRichTextAssetUpload,
+    GetRichTextAssetUploadFromJSON,
+    GetRichTextAssetUploadToJSON,
+} from '../models/GetRichTextAssetUpload';
+import {
+    type PostRichTextAssetComplete,
+    PostRichTextAssetCompleteFromJSON,
+    PostRichTextAssetCompleteToJSON,
+} from '../models/PostRichTextAssetComplete';
+import {
+    type PostRichTextAssetUpload,
+    PostRichTextAssetUploadFromJSON,
+    PostRichTextAssetUploadToJSON,
+} from '../models/PostRichTextAssetUpload';
+import {
+    type RichTextAsset,
+    RichTextAssetFromJSON,
+    RichTextAssetToJSON,
+} from '../models/RichTextAsset';
+
+export interface GetRichTextAssetRequest {
+    assetId: string;
+}
+
+export interface PostRichTextAssetCompleteRequest {
+    assetId: string;
+    postRichTextAssetComplete: PostRichTextAssetComplete;
+}
+
+export interface PostRichTextAssetUploadRequest {
+    postRichTextAssetUpload: PostRichTextAssetUpload;
+}
+
+/**
+ * 
+ */
+export class RichTextApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getRichTextAsset without sending the request
+     */
+    async getRichTextAssetRequestOpts(requestParameters: GetRichTextAssetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['assetId'] == null) {
+            throw new runtime.RequiredError(
+                'assetId',
+                'Required parameter "assetId" was null or undefined when calling getRichTextAsset().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/rich-text/assets/{assetId}`;
+        urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Redirect to a signed rich text asset URL
+     */
+    async getRichTextAssetRaw(requestParameters: GetRichTextAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getRichTextAssetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Redirect to a signed rich text asset URL
+     */
+    async getRichTextAsset(requestParameters: GetRichTextAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getRichTextAssetRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for postRichTextAssetComplete without sending the request
+     */
+    async postRichTextAssetCompleteRequestOpts(requestParameters: PostRichTextAssetCompleteRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['assetId'] == null) {
+            throw new runtime.RequiredError(
+                'assetId',
+                'Required parameter "assetId" was null or undefined when calling postRichTextAssetComplete().'
+            );
+        }
+
+        if (requestParameters['postRichTextAssetComplete'] == null) {
+            throw new runtime.RequiredError(
+                'postRichTextAssetComplete',
+                'Required parameter "postRichTextAssetComplete" was null or undefined when calling postRichTextAssetComplete().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/rich-text/assets/{assetId}/complete`;
+        urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostRichTextAssetCompleteToJSON(requestParameters['postRichTextAssetComplete']),
+        };
+    }
+
+    /**
+     * Complete a pending rich text asset upload
+     */
+    async postRichTextAssetCompleteRaw(requestParameters: PostRichTextAssetCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RichTextAsset>> {
+        const requestOptions = await this.postRichTextAssetCompleteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RichTextAssetFromJSON(jsonValue));
+    }
+
+    /**
+     * Complete a pending rich text asset upload
+     */
+    async postRichTextAssetComplete(requestParameters: PostRichTextAssetCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RichTextAsset> {
+        const response = await this.postRichTextAssetCompleteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postRichTextAssetUpload without sending the request
+     */
+    async postRichTextAssetUploadRequestOpts(requestParameters: PostRichTextAssetUploadRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postRichTextAssetUpload'] == null) {
+            throw new runtime.RequiredError(
+                'postRichTextAssetUpload',
+                'Required parameter "postRichTextAssetUpload" was null or undefined when calling postRichTextAssetUpload().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/rich-text/assets/uploads`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostRichTextAssetUploadToJSON(requestParameters['postRichTextAssetUpload']),
+        };
+    }
+
+    /**
+     * Create a pending rich text asset upload
+     */
+    async postRichTextAssetUploadRaw(requestParameters: PostRichTextAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRichTextAssetUpload>> {
+        const requestOptions = await this.postRichTextAssetUploadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetRichTextAssetUploadFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a pending rich text asset upload
+     */
+    async postRichTextAssetUpload(requestParameters: PostRichTextAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRichTextAssetUpload> {
+        const response = await this.postRichTextAssetUploadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/UserApi.ts

@@ -28,6 +28,11 @@ import {
     GetUserAvatarUploadFromJSON,
     GetUserAvatarUploadToJSON,
 } from '../models/GetUserAvatarUpload';
+import {
+    type GetUserCourseList,
+    GetUserCourseListFromJSON,
+    GetUserCourseListToJSON,
+} from '../models/GetUserCourseList';
 import {
     type LoginRes,
     LoginResFromJSON,
@@ -72,6 +77,17 @@ export interface GetUserRequest {
     userId: string;
 }
 
+export interface GetUserCoursesRequest {
+    userId: string;
+    page?: number;
+    pageSize?: number;
+    search?: string;
+    recentActivitySince?: number;
+    enrollmentStatus?: string;
+    orderBy?: GetUserCoursesOrderByEnum;
+    orderDirection?: GetUserCoursesOrderDirectionEnum;
+}
+
 export interface GetUserEnrollmentsRequest {
     userId: string;
     type?: GetUserEnrollmentsTypeEnum;
@@ -279,6 +295,79 @@ export class UserApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getUserCourses without sending the request
+     */
+    async getUserCoursesRequestOpts(requestParameters: GetUserCoursesRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling getUserCourses().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        if (requestParameters['search'] != null) {
+            queryParameters['search'] = requestParameters['search'];
+        }
+
+        if (requestParameters['recentActivitySince'] != null) {
+            queryParameters['recentActivitySince'] = requestParameters['recentActivitySince'];
+        }
+
+        if (requestParameters['enrollmentStatus'] != null) {
+            queryParameters['enrollmentStatus'] = requestParameters['enrollmentStatus'];
+        }
+
+        if (requestParameters['orderBy'] != null) {
+            queryParameters['orderBy'] = requestParameters['orderBy'];
+        }
+
+        if (requestParameters['orderDirection'] != null) {
+            queryParameters['orderDirection'] = requestParameters['orderDirection'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/users/{userId}/courses`;
+        urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get enrolled courses for a user
+     */
+    async getUserCoursesRaw(requestParameters: GetUserCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUserCourseList>> {
+        const requestOptions = await this.getUserCoursesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetUserCourseListFromJSON(jsonValue));
+    }
+
+    /**
+     * Get enrolled courses for a user
+     */
+    async getUserCourses(requestParameters: GetUserCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUserCourseList> {
+        const response = await this.getUserCoursesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getUserEnrollments without sending the request
      */
@@ -739,6 +828,25 @@ export class UserApi extends runtime.BaseAPI {
 
 }
 
+/**
+ * @export
+ */
+export const GetUserCoursesOrderByEnum = {
+    Name: 'name',
+    CreatedAt: 'created_at',
+    EnrollmentDateStart: 'enrollment_date_start',
+    EnrollmentStatus: 'enrollment_status',
+    CompletionPercentage: 'completion_percentage'
+} as const;
+export type GetUserCoursesOrderByEnum = typeof GetUserCoursesOrderByEnum[keyof typeof GetUserCoursesOrderByEnum];
+/**
+ * @export
+ */
+export const GetUserCoursesOrderDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type GetUserCoursesOrderDirectionEnum = typeof GetUserCoursesOrderDirectionEnum[keyof typeof GetUserCoursesOrderDirectionEnum];
 /**
  * @export
  */

package/src/apis/index.ts

@@ -15,6 +15,7 @@ export * from './PortalSublicenseApi';
 export * from './QuestionApi';
 export * from './QuizApi';
 export * from './ReportingApi';
+export * from './RichTextApi';
 export * from './RoleApi';
 export * from './SupportTicketApi';
 export * from './SystemApi';

package/src/models/GetQuestion.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
 import type { GetQuestionAnswerChoicesInner } from './GetQuestionAnswerChoicesInner';
 import {
     GetQuestionAnswerChoicesInnerFromJSON,
@@ -41,11 +48,11 @@ export interface GetQuestion {
      */
     readonly id: string;
     /**
-     * The main question text or prompt
-     * @type {string}
+     * 
+     * @type {RichTextDocument}
      * @memberof GetQuestion
      */
-    questionText: string;
+    questionText: RichTextDocument;
     /**
      * Type of question
      * @type {GetQuestionQuestionTypeEnum}
@@ -65,11 +72,11 @@ export interface GetQuestion {
      */
     correctAnswer?: string;
     /**
-     * Explanation of the correct answer
-     * @type {string}
+     * 
+     * @type {RichTextDocument}
      * @memberof GetQuestion
      */
-    explanation?: string;
+    explanation?: RichTextDocument;
     /**
      * Topic category (Fire Alarm, Fire Pump, Fire Sprinkler, etc.)
      * @type {string}
@@ -176,11 +183,11 @@ export function GetQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean
     return {
         
         'id': json['id'],
-        'questionText': json['question_text'],
+        'questionText': RichTextDocumentFromJSON(json['question_text']),
         'questionType': json['question_type'],
         'answerChoices': json['answer_choices'] == null ? undefined : ((json['answer_choices'] as Array<any>).map(GetQuestionAnswerChoicesInnerFromJSON)),
         'correctAnswer': json['correct_answer'] == null ? undefined : json['correct_answer'],
-        'explanation': json['explanation'] == null ? undefined : json['explanation'],
+        'explanation': json['explanation'] == null ? undefined : RichTextDocumentFromJSON(json['explanation']),
         'topic': json['topic'],
         'difficultyLevel': json['difficulty_level'],
         'tags': json['tags'] == null ? undefined : json['tags'],
@@ -204,11 +211,11 @@ export function GetQuestionToJSONTyped(value?: Omit<GetQuestion, 'id'|'created_d
 
     return {
         
-        'question_text': value['questionText'],
+        'question_text': RichTextDocumentToJSON(value['questionText']),
         'question_type': value['questionType'],
         'answer_choices': value['answerChoices'] == null ? undefined : ((value['answerChoices'] as Array<any>).map(GetQuestionAnswerChoicesInnerToJSON)),
         'correct_answer': value['correctAnswer'],
-        'explanation': value['explanation'],
+        'explanation': RichTextDocumentToJSON(value['explanation']),
         'topic': value['topic'],
         'difficulty_level': value['difficultyLevel'],
         'tags': value['tags'],

package/src/models/GetQuestionAnswerChoicesInner.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+
 /**
  * 
  * @export
@@ -27,10 +35,10 @@ export interface GetQuestionAnswerChoicesInner {
     id: string;
     /**
      * 
-     * @type {string}
+     * @type {RichTextDocument}
      * @memberof GetQuestionAnswerChoicesInner
      */
-    text: string;
+    text: RichTextDocument;
     /**
      * 
      * @type {boolean}
@@ -60,7 +68,7 @@ export function GetQuestionAnswerChoicesInnerFromJSONTyped(json: any, ignoreDisc
     return {
         
         'id': json['id'],
-        'text': json['text'],
+        'text': RichTextDocumentFromJSON(json['text']),
         'isCorrect': json['is_correct'],
     };
 }
@@ -77,7 +85,7 @@ export function GetQuestionAnswerChoicesInnerToJSONTyped(value?: GetQuestionAnsw
     return {
         
         'id': value['id'],
-        'text': value['text'],
+        'text': RichTextDocumentToJSON(value['text']),
         'is_correct': value['isCorrect'],
     };
 }