@easyedu/js-lsm-api 1.79.0 → 1.81.0

package/docs/GetRichTextAssetUpload.md

@@ -0,0 +1,40 @@
+
+# GetRichTextAssetUpload
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`assetId` | string
+`uploadUrl` | string
+`renderUrl` | string
+`expiresInSeconds` | number
+
+## Example
+
+```typescript
+import type { GetRichTextAssetUpload } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "assetId": null,
+  "uploadUrl": null,
+  "renderUrl": null,
+  "expiresInSeconds": null,
+} satisfies GetRichTextAssetUpload
+
+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 GetRichTextAssetUpload
+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/GetUserCourseList.md

@@ -0,0 +1,43 @@
+
+# GetUserCourseList
+
+A paginated list of courses the target user is enrolled in.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<GetUserCourseListItem>](GetUserCourseListItem.md)
+
+## Example
+
+```typescript
+import type { GetUserCourseList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+  "items": null,
+} satisfies GetUserCourseList
+
+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 GetUserCourseList
+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/GetUserCourseListItem.md

@@ -0,0 +1,41 @@
+
+# GetUserCourseListItem
+
+A course the target user is enrolled in, grouped by course and selected enrollment.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`course` | [GetUserCourseListItemCourse](GetUserCourseListItemCourse.md)
+`enrollment` | [GetUserCourseListItemEnrollment](GetUserCourseListItemEnrollment.md)
+`progress` | [GetUserCourseListItemProgress](GetUserCourseListItemProgress.md)
+`certificate` | [GetUserCourseListItemCertificate](GetUserCourseListItemCertificate.md)
+
+## Example
+
+```typescript
+import type { GetUserCourseListItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "course": null,
+  "enrollment": null,
+  "progress": null,
+  "certificate": null,
+} satisfies GetUserCourseListItem
+
+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 GetUserCourseListItem
+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/GetUserCourseListItemCertificate.md

@@ -0,0 +1,43 @@
+
+# GetUserCourseListItemCertificate
+
+Latest certificate for the learner and course, if one exists.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`issuedAt` | number
+`expiresAt` | number
+`issuanceReason` | string
+
+## Example
+
+```typescript
+import type { GetUserCourseListItemCertificate } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "issuedAt": null,
+  "expiresAt": null,
+  "issuanceReason": null,
+} satisfies GetUserCourseListItemCertificate
+
+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 GetUserCourseListItemCertificate
+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/GetUserCourseListItemCourse.md

@@ -0,0 +1,51 @@
+
+# GetUserCourseListItemCourse
+
+Course fields for an enrolled user\'s course list item.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`imageUrl` | string
+`published` | boolean
+`createdAt` | number
+`accessPolicyType` | string
+`accessDurationDays` | number
+`accessFixedEndAt` | number
+
+## Example
+
+```typescript
+import type { GetUserCourseListItemCourse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "imageUrl": null,
+  "published": null,
+  "createdAt": null,
+  "accessPolicyType": null,
+  "accessDurationDays": null,
+  "accessFixedEndAt": null,
+} satisfies GetUserCourseListItemCourse
+
+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 GetUserCourseListItemCourse
+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/GetUserCourseListItemEnrollment.md

@@ -0,0 +1,49 @@
+
+# GetUserCourseListItemEnrollment
+
+Selected enrollment fields for an enrolled user\'s course list item.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`accessState` | string
+`daysUntilExpiry` | number
+`userType` | string
+`enrollmentDateStart` | number
+`enrollmentDateEnd` | number
+`completionDate` | number
+
+## Example
+
+```typescript
+import type { GetUserCourseListItemEnrollment } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "accessState": null,
+  "daysUntilExpiry": null,
+  "userType": null,
+  "enrollmentDateStart": null,
+  "enrollmentDateEnd": null,
+  "completionDate": null,
+} satisfies GetUserCourseListItemEnrollment
+
+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 GetUserCourseListItemEnrollment
+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/GetUserCourseListItemProgress.md

@@ -0,0 +1,39 @@
+
+# GetUserCourseListItemProgress
+
+Learner progress for an enrolled user\'s course list item.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`completionPercentage` | number
+`completedContentCount` | number
+`totalContentCount` | number
+
+## Example
+
+```typescript
+import type { GetUserCourseListItemProgress } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "completionPercentage": null,
+  "completedContentCount": null,
+  "totalContentCount": null,
+} satisfies GetUserCourseListItemProgress
+
+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 GetUserCourseListItemProgress
+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/PostQuestion.md

@@ -6,11 +6,11 @@
 
 Name | Type
 ------------ | -------------
-`questionText` | string
+`questionText` | [RichTextInput](RichTextInput.md)
 `questionType` | string
 `answerChoices` | [Array<PostQuestionAnswerChoicesInner>](PostQuestionAnswerChoicesInner.md)
 `correctAnswer` | string
-`explanation` | string
+`explanation` | [RichTextInput](RichTextInput.md)
 `topic` | string
 `difficultyLevel` | string
 `tags` | Array<string>

package/docs/PostQuestionAnswerChoicesInner.md

@@ -6,7 +6,7 @@
 
 Name | Type
 ------------ | -------------
-`text` | string
+`text` | [RichTextInput](RichTextInput.md)
 `isCorrect` | boolean
 
 ## Example

package/docs/PostRichTextAssetComplete.md

@@ -0,0 +1,38 @@
+
+# PostRichTextAssetComplete
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`byteSize` | number
+`width` | number
+`height` | number
+
+## Example
+
+```typescript
+import type { PostRichTextAssetComplete } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "byteSize": null,
+  "width": null,
+  "height": null,
+} satisfies PostRichTextAssetComplete
+
+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 PostRichTextAssetComplete
+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/PostRichTextAssetUpload.md

@@ -0,0 +1,44 @@
+
+# PostRichTextAssetUpload
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`filename` | string
+`mimeType` | string
+`byteSize` | number
+`width` | number
+`height` | number
+`usageContext` | string
+
+## Example
+
+```typescript
+import type { PostRichTextAssetUpload } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "filename": null,
+  "mimeType": null,
+  "byteSize": null,
+  "width": null,
+  "height": null,
+  "usageContext": null,
+} satisfies PostRichTextAssetUpload
+
+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 PostRichTextAssetUpload
+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/PutQuestion.md

@@ -6,11 +6,11 @@
 
 Name | Type
 ------------ | -------------
-`questionText` | string
+`questionText` | [RichTextInput](RichTextInput.md)
 `questionType` | string
 `answerChoices` | [Array<PutQuestionAnswerChoicesInner>](PutQuestionAnswerChoicesInner.md)
 `correctAnswer` | string
-`explanation` | string
+`explanation` | [RichTextInput](RichTextInput.md)
 `topic` | string
 `difficultyLevel` | string
 `tags` | Array<string>

package/docs/PutQuestionAnswerChoicesInner.md

@@ -7,7 +7,7 @@
 Name | Type
 ------------ | -------------
 `id` | string
-`text` | string
+`text` | [RichTextInput](RichTextInput.md)
 `isCorrect` | boolean
 
 ## Example

package/docs/RichTextApi.md

@@ -0,0 +1,212 @@
+# RichTextApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getRichTextAsset**](RichTextApi.md#getrichtextasset) | **GET** /rich-text/assets/{assetId} | Redirect to a signed rich text asset URL |
+| [**postRichTextAssetComplete**](RichTextApi.md#postrichtextassetcomplete) | **POST** /rich-text/assets/{assetId}/complete | Complete a pending rich text asset upload |
+| [**postRichTextAssetUpload**](RichTextApi.md#postrichtextassetupload) | **POST** /rich-text/assets/uploads | Create a pending rich text asset upload |
+
+
+
+## getRichTextAsset
+
+> getRichTextAsset(assetId)
+
+Redirect to a signed rich text asset URL
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RichTextApi,
+} from '@easyedu/js-lsm-api';
+import type { GetRichTextAssetRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RichTextApi();
+
+  const body = {
+    // string
+    assetId: assetId_example,
+  } satisfies GetRichTextAssetRequest;
+
+  try {
+    const data = await api.getRichTextAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assetId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **302** | redirect to signed asset URL |  -  |
+| **404** | rich text asset 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)
+
+
+## postRichTextAssetComplete
+
+> RichTextAsset postRichTextAssetComplete(assetId, postRichTextAssetComplete)
+
+Complete a pending rich text asset upload
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RichTextApi,
+} from '@easyedu/js-lsm-api';
+import type { PostRichTextAssetCompleteRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RichTextApi();
+
+  const body = {
+    // string
+    assetId: assetId_example,
+    // PostRichTextAssetComplete
+    postRichTextAssetComplete: ...,
+  } satisfies PostRichTextAssetCompleteRequest;
+
+  try {
+    const data = await api.postRichTextAssetComplete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assetId** | `string` |  | [Defaults to `undefined`] |
+| **postRichTextAssetComplete** | [PostRichTextAssetComplete](PostRichTextAssetComplete.md) |  | |
+
+### Return type
+
+[**RichTextAsset**](RichTextAsset.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | rich text asset completed |  -  |
+| **404** | rich text asset 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)
+
+
+## postRichTextAssetUpload
+
+> GetRichTextAssetUpload postRichTextAssetUpload(postRichTextAssetUpload)
+
+Create a pending rich text asset upload
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RichTextApi,
+} from '@easyedu/js-lsm-api';
+import type { PostRichTextAssetUploadRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RichTextApi();
+
+  const body = {
+    // PostRichTextAssetUpload
+    postRichTextAssetUpload: ...,
+  } satisfies PostRichTextAssetUploadRequest;
+
+  try {
+    const data = await api.postRichTextAssetUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postRichTextAssetUpload** | [PostRichTextAssetUpload](PostRichTextAssetUpload.md) |  | |
+
+### Return type
+
+[**GetRichTextAssetUpload**](GetRichTextAssetUpload.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | rich text asset upload created |  -  |
+| **400** | invalid asset upload request |  -  |
+
+[[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/RichTextAsset.md

@@ -0,0 +1,44 @@
+
+# RichTextAsset
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`mimeType` | string
+`byteSize` | number
+`width` | number
+`height` | number
+`renderUrl` | string
+
+## Example
+
+```typescript
+import type { RichTextAsset } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "mimeType": null,
+  "byteSize": null,
+  "width": null,
+  "height": null,
+  "renderUrl": null,
+} satisfies RichTextAsset
+
+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 RichTextAsset
+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)
+
+