@easyedu/js-lsm-api 1.110.0 → 1.111.0

package/.openapi-generator/FILES

@@ -98,12 +98,18 @@ docs/GetCourseVersionSection.md
 docs/GetCourseVersionSectionChild.md
 docs/GetCourseVersionSectionProgression.md
 docs/GetCourseVersionSectionReporting.md
+docs/GetEffectiveLearnerExperience.md
 docs/GetEmailAssetUpload.md
 docs/GetEmailDelivery.md
 docs/GetEmailDeliveryList.md
 docs/GetEmailTemplate.md
 docs/GetEmailTemplateList.md
 docs/GetEmailTemplatePreview.md
+docs/GetLearnerDashboard.md
+docs/GetLearnerDashboardCourseList.md
+docs/GetLearnerDashboardSummary.md
+docs/GetLearnerExperience.md
+docs/GetLearnerExperiencePreview.md
 docs/GetLibraryQuiz.md
 docs/GetLibraryQuizAnalytics.md
 docs/GetLibraryQuizCriteriaPreview.md
@@ -167,6 +173,8 @@ docs/GetUserCourseListItemCourse.md
 docs/GetUserCourseListItemEnrollment.md
 docs/GetUserCourseListItemProgress.md
 docs/GetUserRole.md
+docs/LearnerExperienceApi.md
+docs/LearnerExperienceVersion.md
 docs/LibraryQuizCriteriaPreviewQuestion.md
 docs/LibraryQuizCriterion.md
 docs/LibraryQuizCriterionPreview.md
@@ -226,6 +234,7 @@ docs/PostEmailAssetComplete.md
 docs/PostEmailAssetUpload.md
 docs/PostEmailTemplatePreview.md
 docs/PostEmailTemplateTestSend.md
+docs/PostLearnerExperiencePreview.md
 docs/PostLibraryQuiz.md
 docs/PostLibraryQuizSession.md
 docs/PostLibraryQuizVersion.md
@@ -273,6 +282,7 @@ docs/PutCourseVersionItem.md
 docs/PutCourseVersionOutlineEntryMove.md
 docs/PutCourseVersionSection.md
 docs/PutEmailTemplateDraft.md
+docs/PutLearnerExperienceDraft.md
 docs/PutLibraryQuiz.md
 docs/PutLibraryQuizCriteria.md
 docs/PutLibraryQuizQuestions.md
@@ -325,6 +335,7 @@ src/apis/CourseCatalogApi.ts
 src/apis/CourseShareApi.ts
 src/apis/DispatchApi.ts
 src/apis/EmailTemplateApi.ts
+src/apis/LearnerExperienceApi.ts
 src/apis/OtherApi.ts
 src/apis/PlayerApi.ts
 src/apis/PortalApi.ts
@@ -423,12 +434,18 @@ src/models/GetCourseVersionSection.ts
 src/models/GetCourseVersionSectionChild.ts
 src/models/GetCourseVersionSectionProgression.ts
 src/models/GetCourseVersionSectionReporting.ts
+src/models/GetEffectiveLearnerExperience.ts
 src/models/GetEmailAssetUpload.ts
 src/models/GetEmailDelivery.ts
 src/models/GetEmailDeliveryList.ts
 src/models/GetEmailTemplate.ts
 src/models/GetEmailTemplateList.ts
 src/models/GetEmailTemplatePreview.ts
+src/models/GetLearnerDashboard.ts
+src/models/GetLearnerDashboardCourseList.ts
+src/models/GetLearnerDashboardSummary.ts
+src/models/GetLearnerExperience.ts
+src/models/GetLearnerExperiencePreview.ts
 src/models/GetLibraryQuiz.ts
 src/models/GetLibraryQuizAnalytics.ts
 src/models/GetLibraryQuizCriteriaPreview.ts
@@ -492,6 +509,7 @@ src/models/GetUserCourseListItemCourse.ts
 src/models/GetUserCourseListItemEnrollment.ts
 src/models/GetUserCourseListItemProgress.ts
 src/models/GetUserRole.ts
+src/models/LearnerExperienceVersion.ts
 src/models/LibraryQuizCriteriaPreviewQuestion.ts
 src/models/LibraryQuizCriterion.ts
 src/models/LibraryQuizCriterionPreview.ts
@@ -547,6 +565,7 @@ src/models/PostEmailAssetComplete.ts
 src/models/PostEmailAssetUpload.ts
 src/models/PostEmailTemplatePreview.ts
 src/models/PostEmailTemplateTestSend.ts
+src/models/PostLearnerExperiencePreview.ts
 src/models/PostLibraryQuiz.ts
 src/models/PostLibraryQuizSession.ts
 src/models/PostLibraryQuizVersion.ts
@@ -594,6 +613,7 @@ src/models/PutCourseVersionItem.ts
 src/models/PutCourseVersionOutlineEntryMove.ts
 src/models/PutCourseVersionSection.ts
 src/models/PutEmailTemplateDraft.ts
+src/models/PutLearnerExperienceDraft.ts
 src/models/PutLibraryQuiz.ts
 src/models/PutLibraryQuizCriteria.ts
 src/models/PutLibraryQuizQuestions.ts

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.110.0
+# @easyedu/js-lsm-api@1.111.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -273,6 +273,16 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *EmailTemplateApi* | [**putSystemEmailAssetFile**](docs/EmailTemplateApi.md#putsystememailassetfile) | **PUT** /system/email-assets/{assetId}/file | Upload a pending platform email image
 *EmailTemplateApi* | [**putSystemEmailTemplateDraft**](docs/EmailTemplateApi.md#putsystememailtemplatedraft) | **PUT** /system/email-templates/{templateKey}/draft | Update a platform email template draft
 *EmailTemplateApi* | [**resendEmailDelivery**](docs/EmailTemplateApi.md#resendemaildelivery) | **POST** /email-deliveries/{deliveryId}/resend | Regenerate and queue a portal email from its current business source
+*LearnerExperienceApi* | [**deleteLearnerExperienceDraft**](docs/LearnerExperienceApi.md#deletelearnerexperiencedraft) | **DELETE** /learner-experience/draft | Discard the selected portal\'s learner experience draft
+*LearnerExperienceApi* | [**getCurrentLearnerDashboard**](docs/LearnerExperienceApi.md#getcurrentlearnerdashboard) | **GET** /users/current/dashboard | Get the authenticated learner\'s resolved dashboard and personalized data
+*LearnerExperienceApi* | [**getEffectiveLearnerExperience**](docs/LearnerExperienceApi.md#geteffectivelearnerexperience) | **GET** /learner-experience/effective | Get the effective published learner experience for the authenticated user
+*LearnerExperienceApi* | [**getLearnerExperience**](docs/LearnerExperienceApi.md#getlearnerexperience) | **GET** /learner-experience | Get the selected portal\'s effective learner experience and local history
+*LearnerExperienceApi* | [**postLearnerExperienceDraft**](docs/LearnerExperienceApi.md#postlearnerexperiencedraft) | **POST** /learner-experience/draft | Create a portal learner experience draft from the effective version
+*LearnerExperienceApi* | [**postLearnerExperienceInherit**](docs/LearnerExperienceApi.md#postlearnerexperienceinherit) | **POST** /learner-experience/inherit | Disable the local learner experience override and resume inheritance
+*LearnerExperienceApi* | [**postLearnerExperiencePreview**](docs/LearnerExperienceApi.md#postlearnerexperiencepreview) | **POST** /learner-experience/preview | Validate and preview an unsaved learner experience document
+*LearnerExperienceApi* | [**postLearnerExperiencePublish**](docs/LearnerExperienceApi.md#postlearnerexperiencepublish) | **POST** /learner-experience/publish | Publish the selected portal\'s learner experience draft
+*LearnerExperienceApi* | [**postLearnerExperienceVersionRestore**](docs/LearnerExperienceApi.md#postlearnerexperienceversionrestore) | **POST** /learner-experience/versions/{versionId}/restore | Create a new draft from a historical learner experience version
+*LearnerExperienceApi* | [**putLearnerExperienceDraft**](docs/LearnerExperienceApi.md#putlearnerexperiencedraft) | **PUT** /learner-experience/draft | Update the selected portal\'s learner experience draft
 *OtherApi* | [**getHealth**](docs/OtherApi.md#gethealth) | **GET** /healthcheck | Health check endpoint
 *PlayerApi* | [**commitResourceScormSession**](docs/PlayerApi.md#commitresourcescormsession) | **POST** /resource/sessions/{sessionId}/commit | Commit a reusable SCORM resource session
 *PlayerApi* | [**getCourseVersionResourceAsset**](docs/PlayerApi.md#getcourseversionresourceasset) | **GET** /resource/course-versions/{courseVersionId}/items/{itemId}/asset/{assetPath} | Stream an asset from an exact course and resource version
@@ -453,12 +463,18 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [GetCourseVersionSectionChild](docs/GetCourseVersionSectionChild.md)
 - [GetCourseVersionSectionProgression](docs/GetCourseVersionSectionProgression.md)
 - [GetCourseVersionSectionReporting](docs/GetCourseVersionSectionReporting.md)
+- [GetEffectiveLearnerExperience](docs/GetEffectiveLearnerExperience.md)
 - [GetEmailAssetUpload](docs/GetEmailAssetUpload.md)
 - [GetEmailDelivery](docs/GetEmailDelivery.md)
 - [GetEmailDeliveryList](docs/GetEmailDeliveryList.md)
 - [GetEmailTemplate](docs/GetEmailTemplate.md)
 - [GetEmailTemplateList](docs/GetEmailTemplateList.md)
 - [GetEmailTemplatePreview](docs/GetEmailTemplatePreview.md)
+- [GetLearnerDashboard](docs/GetLearnerDashboard.md)
+- [GetLearnerDashboardCourseList](docs/GetLearnerDashboardCourseList.md)
+- [GetLearnerDashboardSummary](docs/GetLearnerDashboardSummary.md)
+- [GetLearnerExperience](docs/GetLearnerExperience.md)
+- [GetLearnerExperiencePreview](docs/GetLearnerExperiencePreview.md)
 - [GetLibraryQuiz](docs/GetLibraryQuiz.md)
 - [GetLibraryQuizAnalytics](docs/GetLibraryQuizAnalytics.md)
 - [GetLibraryQuizCriteriaPreview](docs/GetLibraryQuizCriteriaPreview.md)
@@ -522,6 +538,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [GetUserCourseListItemEnrollment](docs/GetUserCourseListItemEnrollment.md)
 - [GetUserCourseListItemProgress](docs/GetUserCourseListItemProgress.md)
 - [GetUserRole](docs/GetUserRole.md)
+- [LearnerExperienceVersion](docs/LearnerExperienceVersion.md)
 - [LibraryQuizCriteriaPreviewQuestion](docs/LibraryQuizCriteriaPreviewQuestion.md)
 - [LibraryQuizCriterion](docs/LibraryQuizCriterion.md)
 - [LibraryQuizCriterionPreview](docs/LibraryQuizCriterionPreview.md)
@@ -577,6 +594,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [PostEmailAssetUpload](docs/PostEmailAssetUpload.md)
 - [PostEmailTemplatePreview](docs/PostEmailTemplatePreview.md)
 - [PostEmailTemplateTestSend](docs/PostEmailTemplateTestSend.md)
+- [PostLearnerExperiencePreview](docs/PostLearnerExperiencePreview.md)
 - [PostLibraryQuiz](docs/PostLibraryQuiz.md)
 - [PostLibraryQuizSession](docs/PostLibraryQuizSession.md)
 - [PostLibraryQuizVersion](docs/PostLibraryQuizVersion.md)
@@ -624,6 +642,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [PutCourseVersionOutlineEntryMove](docs/PutCourseVersionOutlineEntryMove.md)
 - [PutCourseVersionSection](docs/PutCourseVersionSection.md)
 - [PutEmailTemplateDraft](docs/PutEmailTemplateDraft.md)
+- [PutLearnerExperienceDraft](docs/PutLearnerExperienceDraft.md)
 - [PutLibraryQuiz](docs/PutLibraryQuiz.md)
 - [PutLibraryQuizCriteria](docs/PutLibraryQuizCriteria.md)
 - [PutLibraryQuizQuestions](docs/PutLibraryQuizQuestions.md)
@@ -670,7 +689,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.110.0`
+- Package version: `1.111.0`
 - Generator version: `7.22.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/LearnerExperienceApi.d.ts

@@ -0,0 +1,153 @@
+/**
+ * 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 GetEffectiveLearnerExperience } from '../models/GetEffectiveLearnerExperience';
+import { type GetLearnerDashboard } from '../models/GetLearnerDashboard';
+import { type GetLearnerExperience } from '../models/GetLearnerExperience';
+import { type GetLearnerExperiencePreview } from '../models/GetLearnerExperiencePreview';
+import { type LearnerExperienceVersion } from '../models/LearnerExperienceVersion';
+import { type PostLearnerExperiencePreview } from '../models/PostLearnerExperiencePreview';
+import { type PutLearnerExperienceDraft } from '../models/PutLearnerExperienceDraft';
+export interface PostLearnerExperiencePreviewRequest {
+    postLearnerExperiencePreview: PostLearnerExperiencePreview;
+}
+export interface PostLearnerExperienceVersionRestoreRequest {
+    versionId: string;
+}
+export interface PutLearnerExperienceDraftRequest {
+    putLearnerExperienceDraft: PutLearnerExperienceDraft;
+}
+/**
+ *
+ */
+export declare class LearnerExperienceApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteLearnerExperienceDraft without sending the request
+     */
+    deleteLearnerExperienceDraftRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Discard the selected portal\'s learner experience draft
+     */
+    deleteLearnerExperienceDraftRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Discard the selected portal\'s learner experience draft
+     */
+    deleteLearnerExperienceDraft(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCurrentLearnerDashboard without sending the request
+     */
+    getCurrentLearnerDashboardRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Get the authenticated learner\'s resolved dashboard and personalized data
+     */
+    getCurrentLearnerDashboardRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLearnerDashboard>>;
+    /**
+     * Get the authenticated learner\'s resolved dashboard and personalized data
+     */
+    getCurrentLearnerDashboard(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLearnerDashboard>;
+    /**
+     * Creates request options for getEffectiveLearnerExperience without sending the request
+     */
+    getEffectiveLearnerExperienceRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Get the effective published learner experience for the authenticated user
+     */
+    getEffectiveLearnerExperienceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEffectiveLearnerExperience>>;
+    /**
+     * Get the effective published learner experience for the authenticated user
+     */
+    getEffectiveLearnerExperience(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEffectiveLearnerExperience>;
+    /**
+     * Creates request options for getLearnerExperience without sending the request
+     */
+    getLearnerExperienceRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Get the selected portal\'s effective learner experience and local history
+     */
+    getLearnerExperienceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLearnerExperience>>;
+    /**
+     * Get the selected portal\'s effective learner experience and local history
+     */
+    getLearnerExperience(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLearnerExperience>;
+    /**
+     * Creates request options for postLearnerExperienceDraft without sending the request
+     */
+    postLearnerExperienceDraftRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Create a portal learner experience draft from the effective version
+     */
+    postLearnerExperienceDraftRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>>;
+    /**
+     * Create a portal learner experience draft from the effective version
+     */
+    postLearnerExperienceDraft(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion>;
+    /**
+     * Creates request options for postLearnerExperienceInherit without sending the request
+     */
+    postLearnerExperienceInheritRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Disable the local learner experience override and resume inheritance
+     */
+    postLearnerExperienceInheritRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Disable the local learner experience override and resume inheritance
+     */
+    postLearnerExperienceInherit(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for postLearnerExperiencePreview without sending the request
+     */
+    postLearnerExperiencePreviewRequestOpts(requestParameters: PostLearnerExperiencePreviewRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Validate and preview an unsaved learner experience document
+     */
+    postLearnerExperiencePreviewRaw(requestParameters: PostLearnerExperiencePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLearnerExperiencePreview>>;
+    /**
+     * Validate and preview an unsaved learner experience document
+     */
+    postLearnerExperiencePreview(requestParameters: PostLearnerExperiencePreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLearnerExperiencePreview>;
+    /**
+     * Creates request options for postLearnerExperiencePublish without sending the request
+     */
+    postLearnerExperiencePublishRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Publish the selected portal\'s learner experience draft
+     */
+    postLearnerExperiencePublishRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>>;
+    /**
+     * Publish the selected portal\'s learner experience draft
+     */
+    postLearnerExperiencePublish(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion>;
+    /**
+     * Creates request options for postLearnerExperienceVersionRestore without sending the request
+     */
+    postLearnerExperienceVersionRestoreRequestOpts(requestParameters: PostLearnerExperienceVersionRestoreRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a new draft from a historical learner experience version
+     */
+    postLearnerExperienceVersionRestoreRaw(requestParameters: PostLearnerExperienceVersionRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>>;
+    /**
+     * Create a new draft from a historical learner experience version
+     */
+    postLearnerExperienceVersionRestore(requestParameters: PostLearnerExperienceVersionRestoreRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion>;
+    /**
+     * Creates request options for putLearnerExperienceDraft without sending the request
+     */
+    putLearnerExperienceDraftRequestOpts(requestParameters: PutLearnerExperienceDraftRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update the selected portal\'s learner experience draft
+     */
+    putLearnerExperienceDraftRaw(requestParameters: PutLearnerExperienceDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearnerExperienceVersion>>;
+    /**
+     * Update the selected portal\'s learner experience draft
+     */
+    putLearnerExperienceDraft(requestParameters: PutLearnerExperienceDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearnerExperienceVersion>;
+}