@easyedu/js-lsm-api 1.110.0 → 1.111.0

package/docs/LearnerExperienceApi.md

@@ -0,0 +1,622 @@
+# LearnerExperienceApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deleteLearnerExperienceDraft**](LearnerExperienceApi.md#deletelearnerexperiencedraft) | **DELETE** /learner-experience/draft | Discard the selected portal\'s learner experience draft |
+| [**getCurrentLearnerDashboard**](LearnerExperienceApi.md#getcurrentlearnerdashboard) | **GET** /users/current/dashboard | Get the authenticated learner\'s resolved dashboard and personalized data |
+| [**getEffectiveLearnerExperience**](LearnerExperienceApi.md#geteffectivelearnerexperience) | **GET** /learner-experience/effective | Get the effective published learner experience for the authenticated user |
+| [**getLearnerExperience**](LearnerExperienceApi.md#getlearnerexperience) | **GET** /learner-experience | Get the selected portal\'s effective learner experience and local history |
+| [**postLearnerExperienceDraft**](LearnerExperienceApi.md#postlearnerexperiencedraft) | **POST** /learner-experience/draft | Create a portal learner experience draft from the effective version |
+| [**postLearnerExperienceInherit**](LearnerExperienceApi.md#postlearnerexperienceinherit) | **POST** /learner-experience/inherit | Disable the local learner experience override and resume inheritance |
+| [**postLearnerExperiencePreview**](LearnerExperienceApi.md#postlearnerexperiencepreview) | **POST** /learner-experience/preview | Validate and preview an unsaved learner experience document |
+| [**postLearnerExperiencePublish**](LearnerExperienceApi.md#postlearnerexperiencepublish) | **POST** /learner-experience/publish | Publish the selected portal\'s learner experience draft |
+| [**postLearnerExperienceVersionRestore**](LearnerExperienceApi.md#postlearnerexperienceversionrestore) | **POST** /learner-experience/versions/{versionId}/restore | Create a new draft from a historical learner experience version |
+| [**putLearnerExperienceDraft**](LearnerExperienceApi.md#putlearnerexperiencedraft) | **PUT** /learner-experience/draft | Update the selected portal\'s learner experience draft |
+
+
+
+## deleteLearnerExperienceDraft
+
+> deleteLearnerExperienceDraft()
+
+Discard the selected portal\'s learner experience draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LearnerExperienceApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteLearnerExperienceDraftRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new LearnerExperienceApi();
+
+  try {
+    const data = await api.deleteLearnerExperienceDraft();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### 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 |
+|-------------|-------------|------------------|
+| **204** | Draft discarded |  -  |
+| **404** | Draft 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)
+
+
+## getCurrentLearnerDashboard
+
+> GetLearnerDashboard getCurrentLearnerDashboard()
+
+Get the authenticated learner\'s resolved dashboard and personalized data
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LearnerExperienceApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCurrentLearnerDashboardRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new LearnerExperienceApi();
+
+  try {
+    const data = await api.getCurrentLearnerDashboard();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetLearnerDashboard**](GetLearnerDashboard.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Personalized learner dashboard |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getEffectiveLearnerExperience
+
+> GetEffectiveLearnerExperience getEffectiveLearnerExperience()
+
+Get the effective published learner experience for the authenticated user
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LearnerExperienceApi,
+} from '@easyedu/js-lsm-api';
+import type { GetEffectiveLearnerExperienceRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new LearnerExperienceApi();
+
+  try {
+    const data = await api.getEffectiveLearnerExperience();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetEffectiveLearnerExperience**](GetEffectiveLearnerExperience.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Effective learner experience |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getLearnerExperience
+
+> GetLearnerExperience getLearnerExperience()
+
+Get the selected portal\'s effective learner experience and local history
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LearnerExperienceApi,
+} from '@easyedu/js-lsm-api';
+import type { GetLearnerExperienceRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new LearnerExperienceApi();
+
+  try {
+    const data = await api.getLearnerExperience();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetLearnerExperience**](GetLearnerExperience.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Effective learner experience, draft, and version history |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postLearnerExperienceDraft
+
+> LearnerExperienceVersion postLearnerExperienceDraft()
+
+Create a portal learner experience draft from the effective version
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LearnerExperienceApi,
+} from '@easyedu/js-lsm-api';
+import type { PostLearnerExperienceDraftRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new LearnerExperienceApi();
+
+  try {
+    const data = await api.postLearnerExperienceDraft();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**LearnerExperienceVersion**](LearnerExperienceVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Draft created |  -  |
+| **409** | A draft already exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postLearnerExperienceInherit
+
+> postLearnerExperienceInherit()
+
+Disable the local learner experience override and resume inheritance
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LearnerExperienceApi,
+} from '@easyedu/js-lsm-api';
+import type { PostLearnerExperienceInheritRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new LearnerExperienceApi();
+
+  try {
+    const data = await api.postLearnerExperienceInherit();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### 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 |
+|-------------|-------------|------------------|
+| **204** | Local override disabled |  -  |
+| **409** | Discard or publish the current draft first |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postLearnerExperiencePreview
+
+> GetLearnerExperiencePreview postLearnerExperiencePreview(postLearnerExperiencePreview)
+
+Validate and preview an unsaved learner experience document
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LearnerExperienceApi,
+} from '@easyedu/js-lsm-api';
+import type { PostLearnerExperiencePreviewRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new LearnerExperienceApi();
+
+  const body = {
+    // PostLearnerExperiencePreview
+    postLearnerExperiencePreview: ...,
+  } satisfies PostLearnerExperiencePreviewRequest;
+
+  try {
+    const data = await api.postLearnerExperiencePreview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postLearnerExperiencePreview** | [PostLearnerExperiencePreview](PostLearnerExperiencePreview.md) |  | |
+
+### Return type
+
+[**GetLearnerExperiencePreview**](GetLearnerExperiencePreview.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Normalized preview document with sample personalization |  -  |
+| **400** | Invalid learner experience document |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postLearnerExperiencePublish
+
+> LearnerExperienceVersion postLearnerExperiencePublish()
+
+Publish the selected portal\'s learner experience draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LearnerExperienceApi,
+} from '@easyedu/js-lsm-api';
+import type { PostLearnerExperiencePublishRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new LearnerExperienceApi();
+
+  try {
+    const data = await api.postLearnerExperiencePublish();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**LearnerExperienceVersion**](LearnerExperienceVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Published learner experience version |  -  |
+| **400** | Draft is not publishable |  -  |
+| **404** | Draft 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)
+
+
+## postLearnerExperienceVersionRestore
+
+> LearnerExperienceVersion postLearnerExperienceVersionRestore(versionId)
+
+Create a new draft from a historical learner experience version
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LearnerExperienceApi,
+} from '@easyedu/js-lsm-api';
+import type { PostLearnerExperienceVersionRestoreRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new LearnerExperienceApi();
+
+  const body = {
+    // string
+    versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies PostLearnerExperienceVersionRestoreRequest;
+
+  try {
+    const data = await api.postLearnerExperienceVersionRestore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **versionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**LearnerExperienceVersion**](LearnerExperienceVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Restored draft |  -  |
+| **404** | Version not found |  -  |
+| **409** | A draft already exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putLearnerExperienceDraft
+
+> LearnerExperienceVersion putLearnerExperienceDraft(putLearnerExperienceDraft)
+
+Update the selected portal\'s learner experience draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LearnerExperienceApi,
+} from '@easyedu/js-lsm-api';
+import type { PutLearnerExperienceDraftRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new LearnerExperienceApi();
+
+  const body = {
+    // PutLearnerExperienceDraft
+    putLearnerExperienceDraft: ...,
+  } satisfies PutLearnerExperienceDraftRequest;
+
+  try {
+    const data = await api.putLearnerExperienceDraft(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **putLearnerExperienceDraft** | [PutLearnerExperienceDraft](PutLearnerExperienceDraft.md) |  | |
+
+### Return type
+
+[**LearnerExperienceVersion**](LearnerExperienceVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Draft updated |  -  |
+| **400** | Invalid learner experience document |  -  |
+| **404** | Draft 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)
+

package/docs/LearnerExperienceVersion.md

@@ -0,0 +1,48 @@
+
+# LearnerExperienceVersion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`versionNumber` | number
+`status` | string
+`designDocument` | { [key: string]: any; }
+`changeNotes` | string
+`createdAt` | number
+`updatedAt` | number
+`publishedAt` | number
+
+## Example
+
+```typescript
+import type { LearnerExperienceVersion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "versionNumber": null,
+  "status": null,
+  "designDocument": null,
+  "changeNotes": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "publishedAt": null,
+} satisfies LearnerExperienceVersion
+
+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 LearnerExperienceVersion
+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/PostLearnerExperiencePreview.md

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