@easyedu/js-lsm-api 1.30.0 → 1.32.0

package/README.md

@@ -1,46 +1,396 @@
-## @easyedu/js-lsm-api@1.30.0
+# @easyedu/js-lsm-api@1.32.0
 
-This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
+A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
-Environment
-* Node.js
-* Webpack
-* Browserify
+## Usage
 
-Language level
-* ES5 - you must have a Promises/A+ library installed
-* ES6
+First, install the SDK from npm.
 
-Module system
-* CommonJS
-* ES6 module system
+```bash
+npm install @easyedu/js-lsm-api --save
+```
 
-It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
+Next, try it out.
 
-### Building
 
-To build and compile the typescript sources to javascript use:
-```
-npm install
-npm run build
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { CommitScormSessionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string | The external_id of the SCORM session
+    scormSessionId: scormSessionId_example,
+  } satisfies CommitScormSessionRequest;
+
+  try {
+    const data = await api.commitScormSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
 ```
 
-### Publishing
 
-First build the package then run `npm publish`
+## Documentation
 
-### Consuming
+### API Endpoints
 
-navigate to the folder of your consuming project and run one of the following commands.
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
 
-_published:_
+| Class | Method | HTTP request | Description
+| ----- | ------ | ------------ | -------------
+*ContentApi* | [**commitScormSession**](docs/ContentApi.md#commitscormsession) | **POST** /scorm/sessions/{scormSessionId}/commit | Commit SCORM session data
+*ContentApi* | [**getContent**](docs/ContentApi.md#getcontent) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | get content
+*ContentApi* | [**getContentList**](docs/ContentApi.md#getcontentlist) | **GET** /courses/{courseId}/modules/{moduleId}/contents | get content list
+*ContentApi* | [**getContentSession**](docs/ContentApi.md#getcontentsession) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | get content session
+*ContentApi* | [**getContentSessionDetail**](docs/ContentApi.md#getcontentsessiondetail) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions/{sessionId} | Get content session details (instructor only)
+*ContentApi* | [**getContentVersion**](docs/ContentApi.md#getcontentversion) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Get details of a specific content version
+*ContentApi* | [**getContentVersionList**](docs/ContentApi.md#getcontentversionlist) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions | Get all versions of a content
+*ContentApi* | [**getScormApiLogs**](docs/ContentApi.md#getscormapilogs) | **GET** /scorm/sessions/{sessionId}/api-logs | Get SCORM API call logs (instructor only)
+*ContentApi* | [**getScormPackage**](docs/ContentApi.md#getscormpackage) | **GET** /scorm/packages/{packageId} | Get details of a SCORM package
+*ContentApi* | [**getScormSessionData**](docs/ContentApi.md#getscormsessiondata) | **GET** /scorm/sessions/{scormSessionId}/session-data | Get SCORM session data (instructor only)
+*ContentApi* | [**getScormValue**](docs/ContentApi.md#getscormvalue) | **GET** /scorm/sessions/{scormSessionId}/get-value | Get a SCORM CMI data element value
+*ContentApi* | [**initializeScormSession**](docs/ContentApi.md#initializescormsession) | **POST** /scorm/sessions/{scormSessionId}/initialize | Initialize a SCORM session
+*ContentApi* | [**listContentSessions**](docs/ContentApi.md#listcontentsessions) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions | List content sessions (instructor only)
+*ContentApi* | [**postContentProcess**](docs/ContentApi.md#postcontentprocess) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/process | Post a new content process
+*ContentApi* | [**postContentQuiz**](docs/ContentApi.md#postcontentquiz) | **POST** /courses/{courseId}/modules/{moduleId}/contents/quiz | Create a new quiz content
+*ContentApi* | [**postContentSession**](docs/ContentApi.md#postcontentsession) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | Post a new content session
+*ContentApi* | [**postContentUpload**](docs/ContentApi.md#postcontentupload) | **POST** /courses/{courseId}/modules/{moduleId}/contents/upload | Post a new content upload
+*ContentApi* | [**putContent**](docs/ContentApi.md#putcontent) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Update content by id
+*ContentApi* | [**putContentVersion**](docs/ContentApi.md#putcontentversion) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Update a content version
+*ContentApi* | [**setScormValue**](docs/ContentApi.md#setscormvalue) | **POST** /scorm/sessions/{scormSessionId}/set-value | Set a SCORM CMI data element value
+*ContentApi* | [**terminateScormSession**](docs/ContentApi.md#terminatescormsession) | **POST** /scorm/sessions/{scormSessionId}/terminate | Terminate a SCORM session
+*ContentApi* | [**verifyScormManifest**](docs/ContentApi.md#verifyscormmanifest) | **POST** /scorm/tools/verify-manifest | Parse and verify a SCORM manifest
+*CourseApi* | [**getCourse**](docs/CourseApi.md#getcourse) | **GET** /courses/{courseId} | get course
+*CourseApi* | [**getCourseEnrollment**](docs/CourseApi.md#getcourseenrollment) | **GET** /courses/{courseId}/enrollments/{enrollmentId} | Get a specific course enrollment
+*CourseApi* | [**getCourseEnrollments**](docs/CourseApi.md#getcourseenrollments) | **GET** /courses/{courseId}/enrollments | Get course enrollments
+*CourseApi* | [**getCourseExport**](docs/CourseApi.md#getcourseexport) | **GET** /courses/{courseId}/exports/{exportId} | Get details of a specific SCORM export
+*CourseApi* | [**getCourseExports**](docs/CourseApi.md#getcourseexports) | **GET** /courses/{courseId}/exports | List all SCORM exports for a course
+*CourseApi* | [**getCourseList**](docs/CourseApi.md#getcourselist) | **GET** /courses | get course list
+*CourseApi* | [**getCourseReportingBasic**](docs/CourseApi.md#getcoursereportingbasic) | **GET** /courses/{courseId}/reporting/basic | Get basic course reporting data
+*CourseApi* | [**postCourse**](docs/CourseApi.md#postcourse) | **POST** /courses | Post a new course
+*CourseApi* | [**postCourseEnrollment**](docs/CourseApi.md#postcourseenrollment) | **POST** /courses/{courseId}/enrollments | Create a new course enrollment
+*CourseApi* | [**postCourseExport**](docs/CourseApi.md#postcourseexport) | **POST** /courses/{courseId}/exports | Create a new SCORM export for a course
+*CourseApi* | [**putCourse**](docs/CourseApi.md#putcourse) | **PUT** /courses/{courseId} | Update a course by id
+*CourseApi* | [**putCourseEnrollment**](docs/CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment
+*ModuleApi* | [**getModule**](docs/ModuleApi.md#getmodule) | **GET** /courses/{courseId}/modules/{moduleId} | get a course module
+*ModuleApi* | [**getModuleList**](docs/ModuleApi.md#getmodulelist) | **GET** /courses/{courseId}/modules | get module list
+*ModuleApi* | [**postModule**](docs/ModuleApi.md#postmodule) | **POST** /courses/{courseId}/modules | Post a new module
+*ModuleApi* | [**putModule**](docs/ModuleApi.md#putmodule) | **PUT** /courses/{courseId}/modules/{moduleId} | Update a module by id
+*OtherApi* | [**getHealth**](docs/OtherApi.md#gethealth) | **GET** /healthcheck | Health check endpoint
+*PortalApi* | [**getPortalById**](docs/PortalApi.md#getportalbyid) | **GET** /portals/{portalId} | Get a portal by id (can use \'current\' to get the current users selected portal)
+*PortalApi* | [**getPortalList**](docs/PortalApi.md#getportallist) | **GET** /portals | Get all portals a user has access to
+*PortalApi* | [**getPortalUsers**](docs/PortalApi.md#getportalusers) | **GET** /portals/{portalId}/users | Get all users for a portal with optional role filtering
+*PortalApi* | [**inviteUserToPortal**](docs/PortalApi.md#inviteusertoportal) | **POST** /portals/{portalId}/invite | Invite a new user to a portal
+*PortalApi* | [**postPortal**](docs/PortalApi.md#postportal) | **POST** /portals | Create a new portal as a child of the current selected portal
+*PortalApi* | [**putPortalBranding**](docs/PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding (name, background color, text color)
+*PortalApi* | [**updateSelectedPortal**](docs/PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal
+*QuestionApi* | [**deleteQuestion**](docs/QuestionApi.md#deletequestion) | **DELETE** /questions/{questionId} | Delete a question by ID
+*QuestionApi* | [**getQuestion**](docs/QuestionApi.md#getquestion) | **GET** /questions/{questionId} | Get a question by ID
+*QuestionApi* | [**getQuestionList**](docs/QuestionApi.md#getquestionlist) | **GET** /questions | Get list of questions with filtering and pagination
+*QuestionApi* | [**postQuestion**](docs/QuestionApi.md#postquestion) | **POST** /questions | Create a new question
+*QuestionApi* | [**putQuestion**](docs/QuestionApi.md#putquestion) | **PUT** /questions/{questionId} | Update a question by ID
+*QuizApi* | [**addQuizCriteriaQuestionSelection**](docs/QuizApi.md#addquizcriteriaquestionselection) | **POST** /quizzes/{quizId}/criteria-question-selection | Add question selection criteria
+*QuizApi* | [**addQuizManualQuestionSelection**](docs/QuizApi.md#addquizmanualquestionselection) | **POST** /quizzes/{quizId}/manual-question-selection | Add questions to quiz manually
+*QuizApi* | [**addQuizQuestions**](docs/QuizApi.md#addquizquestions) | **POST** /quizzes/{quizId}/questions | Add questions to quiz (manual selection)
+*QuizApi* | [**createQuiz**](docs/QuizApi.md#createquiz) | **POST** /quizzes | Create a new quiz configuration
+*QuizApi* | [**deleteQuiz**](docs/QuizApi.md#deletequiz) | **DELETE** /quizzes/{quizId} | Delete quiz configuration
+*QuizApi* | [**deleteQuizCriteriaQuestionSelection**](docs/QuizApi.md#deletequizcriteriaquestionselection) | **DELETE** /quizzes/{quizId}/criteria-question-selection/{criteriaId} | Delete question selection criteria
+*QuizApi* | [**deleteQuizManualQuestionSelection**](docs/QuizApi.md#deletequizmanualquestionselection) | **DELETE** /quizzes/{quizId}/manual-question-selection/{questionId} | Remove manually selected question from quiz
+*QuizApi* | [**getQuiz**](docs/QuizApi.md#getquiz) | **GET** /quizzes/{quizId} | Get quiz configuration by ID
+*QuizApi* | [**getQuizAttempt**](docs/QuizApi.md#getquizattempt) | **GET** /quiz-attempts/{attemptId} | Get current quiz attempt status and questions
+*QuizApi* | [**getQuizAttemptAnalytics**](docs/QuizApi.md#getquizattemptanalytics) | **GET** /quiz-attempts/{attemptId}/analytics | Get detailed analytics for quiz attempt (admin)
+*QuizApi* | [**getQuizAttemptResults**](docs/QuizApi.md#getquizattemptresults) | **GET** /quiz-attempts/{attemptId}/results | Get quiz attempt results
+*QuizApi* | [**getQuizAttempts**](docs/QuizApi.md#getquizattempts) | **GET** /quizzes/{quizId}/attempts | List attempts for this quiz (admin)
+*QuizApi* | [**getQuizCriteriaQuestionSelection**](docs/QuizApi.md#getquizcriteriaquestionselection) | **GET** /quizzes/{quizId}/criteria-question-selection/{criteriaId} | Get single question selection criteria
+*QuizApi* | [**getQuizCriteriaQuestionSelectionList**](docs/QuizApi.md#getquizcriteriaquestionselectionlist) | **GET** /quizzes/{quizId}/criteria-question-selection | Get quiz question selection criteria list
+*QuizApi* | [**getQuizList**](docs/QuizApi.md#getquizlist) | **GET** /quizzes | List quiz configurations
+*QuizApi* | [**getQuizManualQuestionSelection**](docs/QuizApi.md#getquizmanualquestionselection) | **GET** /quizzes/{quizId}/manual-question-selection/{questionId} | Get single manually selected question
+*QuizApi* | [**getQuizManualQuestionSelectionList**](docs/QuizApi.md#getquizmanualquestionselectionlist) | **GET** /quizzes/{quizId}/manual-question-selection | Get manually selected questions for quiz
+*QuizApi* | [**getQuizQuestions**](docs/QuizApi.md#getquizquestions) | **GET** /quizzes/{quizId}/questions | Get quiz questions (paginated)
+*QuizApi* | [**getUserQuizAttempts**](docs/QuizApi.md#getuserquizattempts) | **GET** /users/{userId}/quiz-attempts | Get user\'s quiz attempts across all quizzes
+*QuizApi* | [**removeQuizQuestion**](docs/QuizApi.md#removequizquestion) | **DELETE** /quizzes/{quizId}/questions/{questionId} | Remove question from quiz
+*QuizApi* | [**saveQuizAnswer**](docs/QuizApi.md#savequizanswer) | **PUT** /quiz-attempts/{attemptId}/answers/{questionId} | Save answer for a specific question
+*QuizApi* | [**startQuizAttempt**](docs/QuizApi.md#startquizattempt) | **POST** /quizzes/{quizId}/attempts | Start a new quiz attempt
+*QuizApi* | [**submitQuizAttempt**](docs/QuizApi.md#submitquizattempt) | **POST** /quiz-attempts/{attemptId}/submit | Submit quiz attempt for final scoring
+*QuizApi* | [**updateQuiz**](docs/QuizApi.md#updatequiz) | **PUT** /quizzes/{quizId} | Update quiz configuration
+*QuizApi* | [**updateQuizQuestions**](docs/QuizApi.md#updatequizquestions) | **PUT** /quizzes/{quizId}/questions | Update quiz question selection
+*ReportingApi* | [**getContentGradeDetail**](docs/ReportingApi.md#getcontentgradedetail) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/grades/{studentId} | Get detailed grade information for a specific student and content (can use \'current\' for studentId)
+*ReportingApi* | [**getContentGrades**](docs/ReportingApi.md#getcontentgrades) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/grades | Get grades for all students enrolled in course for specific content
+*ReportingApi* | [**getContentInstructorBasicReporting**](docs/ReportingApi.md#getcontentinstructorbasicreporting) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/instructor/basic | Get basic instructor reporting for content
+*ReportingApi* | [**getCourseInstructorReportingBasic**](docs/ReportingApi.md#getcourseinstructorreportingbasic) | **GET** /courses/{courseId}/reporting/instructor/basic | Get basic course reporting data for instructors
+*ReportingApi* | [**getCourseStudentReporting**](docs/ReportingApi.md#getcoursestudentreporting) | **GET** /courses/{courseId}/reporting/students/{studentId} | Get student-specific reporting for a course (can use \'current\' for studentId)
+*ReportingApi* | [**getModuleInstructorBasicReporting**](docs/ReportingApi.md#getmoduleinstructorbasicreporting) | **GET** /courses/{courseId}/modules/{moduleId}/reporting/instructor/basic | Get basic instructor reporting for a module
+*ReportingApi* | [**getModuleStudentReporting**](docs/ReportingApi.md#getmodulestudentreporting) | **GET** /courses/{courseId}/modules/{moduleId}/reporting/students/{studentId} | Get student-specific reporting for a module (can use \'current\' for studentId)
+*ReportingApi* | [**getPortalBasicReporting**](docs/ReportingApi.md#getportalbasicreporting) | **GET** /portals/{portalId}/reporting/basic | Get basic reporting for a portal (can use \'current\' for portalId)
+*ReportingApi* | [**getPortalStudentReporting**](docs/ReportingApi.md#getportalstudentreporting) | **GET** /portals/{portalId}/reporting/students/{studentId} | Get student reporting for a portal (can use \'current\' for portalId and studentId)
+*UserApi* | [**getAuthCheck**](docs/UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in
+*UserApi* | [**getUser**](docs/UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id
+*UserApi* | [**postLogin**](docs/UserApi.md#postlogin) | **POST** /auth/login | Post a new login
+*UserApi* | [**postLogout**](docs/UserApi.md#postlogout) | **POST** /auth/logout | Logout a user
+*UserApi* | [**putUser**](docs/UserApi.md#putuser) | **PUT** /users/{userId} | Update a user by id
+*UserApi* | [**resetPassword**](docs/UserApi.md#resetpassword) | **POST** /auth/reset-password | Reset a users password
+*UserApi* | [**sendResetPassword**](docs/UserApi.md#sendresetpassword) | **POST** /auth/send-reset-password | Send a reset password email
+
+
+### Models
+
+- [CriteriaBasedSelection](docs/CriteriaBasedSelection.md)
+- [CriteriaBasedSelectionCriteria](docs/CriteriaBasedSelectionCriteria.md)
+- [CriteriaBasedSelectionDistribution](docs/CriteriaBasedSelectionDistribution.md)
+- [FillInBlank](docs/FillInBlank.md)
+- [FillInBlank1](docs/FillInBlank1.md)
+- [GetContent](docs/GetContent.md)
+- [GetContentContentData](docs/GetContentContentData.md)
+- [GetContentGradeDetail](docs/GetContentGradeDetail.md)
+- [GetContentGrades](docs/GetContentGrades.md)
+- [GetContentGradesItemsInner](docs/GetContentGradesItemsInner.md)
+- [GetContentGradesItemsInnerUser](docs/GetContentGradesItemsInnerUser.md)
+- [GetContentInstructorBasicReporting](docs/GetContentInstructorBasicReporting.md)
+- [GetContentInstructorBasicReportingContentInfo](docs/GetContentInstructorBasicReportingContentInfo.md)
+- [GetContentInstructorBasicReportingEngagement](docs/GetContentInstructorBasicReportingEngagement.md)
+- [GetContentInstructorBasicReportingPerformance](docs/GetContentInstructorBasicReportingPerformance.md)
+- [GetContentList](docs/GetContentList.md)
+- [GetContentSession](docs/GetContentSession.md)
+- [GetContentSessionDetail](docs/GetContentSessionDetail.md)
+- [GetContentSessionDetailScormSessionDataInner](docs/GetContentSessionDetailScormSessionDataInner.md)
+- [GetContentSessionDetailUserData](docs/GetContentSessionDetailUserData.md)
+- [GetContentSessionList](docs/GetContentSessionList.md)
+- [GetContentSessionListItem](docs/GetContentSessionListItem.md)
+- [GetContentSessionListItemScormSessionData](docs/GetContentSessionListItemScormSessionData.md)
+- [GetContentUpload](docs/GetContentUpload.md)
+- [GetContentVersion](docs/GetContentVersion.md)
+- [GetContentVersionList](docs/GetContentVersionList.md)
+- [GetContentVersionListItemsInner](docs/GetContentVersionListItemsInner.md)
+- [GetContentVersionSandbox](docs/GetContentVersionSandbox.md)
+- [GetContentVersionScormData](docs/GetContentVersionScormData.md)
+- [GetCourse](docs/GetCourse.md)
+- [GetCourseEnrollment](docs/GetCourseEnrollment.md)
+- [GetCourseEnrollmentList](docs/GetCourseEnrollmentList.md)
+- [GetCourseEnrollmentListItem](docs/GetCourseEnrollmentListItem.md)
+- [GetCourseExport](docs/GetCourseExport.md)
+- [GetCourseExportList](docs/GetCourseExportList.md)
+- [GetCourseList](docs/GetCourseList.md)
+- [GetCourseReportingBasic](docs/GetCourseReportingBasic.md)
+- [GetCourseStudentReporting](docs/GetCourseStudentReporting.md)
+- [GetCourseStudentReportingCourseInfo](docs/GetCourseStudentReportingCourseInfo.md)
+- [GetCourseStudentReportingEngagement](docs/GetCourseStudentReportingEngagement.md)
+- [GetCourseStudentReportingPerformance](docs/GetCourseStudentReportingPerformance.md)
+- [GetManualQuestionSelectionItem](docs/GetManualQuestionSelectionItem.md)
+- [GetManualQuestionSelectionList](docs/GetManualQuestionSelectionList.md)
+- [GetModule](docs/GetModule.md)
+- [GetModuleInstructorBasicReporting](docs/GetModuleInstructorBasicReporting.md)
+- [GetModuleInstructorBasicReportingEngagement](docs/GetModuleInstructorBasicReportingEngagement.md)
+- [GetModuleInstructorBasicReportingModuleInfo](docs/GetModuleInstructorBasicReportingModuleInfo.md)
+- [GetModuleInstructorBasicReportingPerformance](docs/GetModuleInstructorBasicReportingPerformance.md)
+- [GetModuleList](docs/GetModuleList.md)
+- [GetModuleStudentReporting](docs/GetModuleStudentReporting.md)
+- [GetModuleStudentReportingAccess](docs/GetModuleStudentReportingAccess.md)
+- [GetModuleStudentReportingProgress](docs/GetModuleStudentReportingProgress.md)
+- [GetPortal](docs/GetPortal.md)
+- [GetPortalBasicReporting](docs/GetPortalBasicReporting.md)
+- [GetPortalBasicReportingCertificates](docs/GetPortalBasicReportingCertificates.md)
+- [GetPortalBasicReportingPortalInfo](docs/GetPortalBasicReportingPortalInfo.md)
+- [GetPortalList](docs/GetPortalList.md)
+- [GetPortalStudentReporting](docs/GetPortalStudentReporting.md)
+- [GetPortalStudentReportingCertificates](docs/GetPortalStudentReportingCertificates.md)
+- [GetPortalStudentReportingPortalInfo](docs/GetPortalStudentReportingPortalInfo.md)
+- [GetPortalUser](docs/GetPortalUser.md)
+- [GetPortalUserList](docs/GetPortalUserList.md)
+- [GetQuestion](docs/GetQuestion.md)
+- [GetQuestionAnswerChoicesInner](docs/GetQuestionAnswerChoicesInner.md)
+- [GetQuestionList](docs/GetQuestionList.md)
+- [GetQuestionListFilters](docs/GetQuestionListFilters.md)
+- [GetQuiz](docs/GetQuiz.md)
+- [GetQuizAttempt](docs/GetQuizAttempt.md)
+- [GetQuizAttemptAnalytics](docs/GetQuizAttemptAnalytics.md)
+- [GetQuizAttemptAnalyticsBasicInfo](docs/GetQuizAttemptAnalyticsBasicInfo.md)
+- [GetQuizAttemptAnalyticsPerformanceBreakdown](docs/GetQuizAttemptAnalyticsPerformanceBreakdown.md)
+- [GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner](docs/GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner.md)
+- [GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner](docs/GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner.md)
+- [GetQuizAttemptAnalyticsPerformanceBreakdownByTopicInner](docs/GetQuizAttemptAnalyticsPerformanceBreakdownByTopicInner.md)
+- [GetQuizAttemptAnalyticsQuestionAnalysisInner](docs/GetQuizAttemptAnalyticsQuestionAnalysisInner.md)
+- [GetQuizAttemptAnalyticsQuestionAnalysisInnerCorrectAnswer](docs/GetQuizAttemptAnalyticsQuestionAnalysisInnerCorrectAnswer.md)
+- [GetQuizAttemptAnalyticsQuestionAnalysisInnerUserAnswer](docs/GetQuizAttemptAnalyticsQuestionAnalysisInnerUserAnswer.md)
+- [GetQuizAttemptAnalyticsScoring](docs/GetQuizAttemptAnalyticsScoring.md)
+- [GetQuizAttemptAttempt](docs/GetQuizAttemptAttempt.md)
+- [GetQuizAttemptList](docs/GetQuizAttemptList.md)
+- [GetQuizAttemptListAllOfAttempts](docs/GetQuizAttemptListAllOfAttempts.md)
+- [GetQuizAttemptListAllOfFilters](docs/GetQuizAttemptListAllOfFilters.md)
+- [GetQuizAttemptListAllOfFiltersDateRange](docs/GetQuizAttemptListAllOfFiltersDateRange.md)
+- [GetQuizAttemptListAllOfSummary](docs/GetQuizAttemptListAllOfSummary.md)
+- [GetQuizAttemptQuestionsInner](docs/GetQuizAttemptQuestionsInner.md)
+- [GetQuizAttemptQuestionsInnerAnswerChoicesInner](docs/GetQuizAttemptQuestionsInnerAnswerChoicesInner.md)
+- [GetQuizAttemptQuestionsInnerCurrentAnswer](docs/GetQuizAttemptQuestionsInnerCurrentAnswer.md)
+- [GetQuizAttemptQuizSettings](docs/GetQuizAttemptQuizSettings.md)
+- [GetQuizCriteria](docs/GetQuizCriteria.md)
+- [GetQuizCriteriaEstimatedQuestions](docs/GetQuizCriteriaEstimatedQuestions.md)
+- [GetQuizCriteriaItem](docs/GetQuizCriteriaItem.md)
+- [GetQuizCriteriaList](docs/GetQuizCriteriaList.md)
+- [GetQuizCriteriaListItemsInner](docs/GetQuizCriteriaListItemsInner.md)
+- [GetQuizList](docs/GetQuizList.md)
+- [GetQuizListAllOfFilters](docs/GetQuizListAllOfFilters.md)
+- [GetQuizListAllOfQuizzes](docs/GetQuizListAllOfQuizzes.md)
+- [GetQuizListAllOfStatistics](docs/GetQuizListAllOfStatistics.md)
+- [GetQuizQuestions](docs/GetQuizQuestions.md)
+- [GetQuizQuestionsItemsInner](docs/GetQuizQuestionsItemsInner.md)
+- [GetQuizQuestionsItemsInnerQuestionDetails](docs/GetQuizQuestionsItemsInnerQuestionDetails.md)
+- [GetQuizQuestionsItemsInnerQuestionDetailsAnswerChoicesInner](docs/GetQuizQuestionsItemsInnerQuestionDetailsAnswerChoicesInner.md)
+- [GetQuizResults](docs/GetQuizResults.md)
+- [GetQuizResultsFeedback](docs/GetQuizResultsFeedback.md)
+- [GetQuizResultsFeedbackDifficultyPerformanceInner](docs/GetQuizResultsFeedbackDifficultyPerformanceInner.md)
+- [GetQuizResultsFeedbackTopicPerformanceInner](docs/GetQuizResultsFeedbackTopicPerformanceInner.md)
+- [GetQuizResultsQuestionsInner](docs/GetQuizResultsQuestionsInner.md)
+- [GetQuizResultsQuestionsInnerAnswerChoicesInner](docs/GetQuizResultsQuestionsInnerAnswerChoicesInner.md)
+- [GetQuizResultsQuestionsInnerStudentAnswer](docs/GetQuizResultsQuestionsInnerStudentAnswer.md)
+- [GetQuizResultsScore](docs/GetQuizResultsScore.md)
+- [GetQuizResultsTiming](docs/GetQuizResultsTiming.md)
+- [GetQuizStatistics](docs/GetQuizStatistics.md)
+- [GetScormApiLogItem](docs/GetScormApiLogItem.md)
+- [GetScormApiLogs](docs/GetScormApiLogs.md)
+- [GetScormPackage](docs/GetScormPackage.md)
+- [GetScormPackagePackageInfo](docs/GetScormPackagePackageInfo.md)
+- [GetScormSessionData](docs/GetScormSessionData.md)
+- [GetScormSessionDataActivity](docs/GetScormSessionDataActivity.md)
+- [GetUser](docs/GetUser.md)
+- [GetUserQuizAttempts](docs/GetUserQuizAttempts.md)
+- [GetUserQuizAttemptsAllOfAttempts](docs/GetUserQuizAttemptsAllOfAttempts.md)
+- [GetUserQuizAttemptsAllOfFilters](docs/GetUserQuizAttemptsAllOfFilters.md)
+- [GetUserQuizAttemptsAllOfSummary](docs/GetUserQuizAttemptsAllOfSummary.md)
+- [LoginRes](docs/LoginRes.md)
+- [LoginResAuthData](docs/LoginResAuthData.md)
+- [LoginResUserData](docs/LoginResUserData.md)
+- [LoginResUserDataSelectedPortal](docs/LoginResUserDataSelectedPortal.md)
+- [ManualSelection](docs/ManualSelection.md)
+- [MediaContent](docs/MediaContent.md)
+- [MultipleAnswer](docs/MultipleAnswer.md)
+- [MultipleAnswer1](docs/MultipleAnswer1.md)
+- [NoAnswer](docs/NoAnswer.md)
+- [Paginated](docs/Paginated.md)
+- [PostContentQuiz](docs/PostContentQuiz.md)
+- [PostContentQuizAssignment](docs/PostContentQuizAssignment.md)
+- [PostContentQuizQuestionSelection](docs/PostContentQuizQuestionSelection.md)
+- [PostContentQuizSettings](docs/PostContentQuizSettings.md)
+- [PostContentSession](docs/PostContentSession.md)
+- [PostContentUpload](docs/PostContentUpload.md)
+- [PostCourse](docs/PostCourse.md)
+- [PostCourseEnrollment](docs/PostCourseEnrollment.md)
+- [PostCourseExport](docs/PostCourseExport.md)
+- [PostLogin](docs/PostLogin.md)
+- [PostManualQuestionSelection](docs/PostManualQuestionSelection.md)
+- [PostModule](docs/PostModule.md)
+- [PostPortal](docs/PostPortal.md)
+- [PostPortalInvite](docs/PostPortalInvite.md)
+- [PostQuestion](docs/PostQuestion.md)
+- [PostQuestionAnswerChoicesInner](docs/PostQuestionAnswerChoicesInner.md)
+- [PostQuiz](docs/PostQuiz.md)
+- [PostQuizAttempt](docs/PostQuizAttempt.md)
+- [PostQuizAttemptAttempt](docs/PostQuizAttemptAttempt.md)
+- [PostQuizAttemptQuestionsInner](docs/PostQuizAttemptQuestionsInner.md)
+- [PostQuizAttemptQuestionsInnerAnswerChoicesInner](docs/PostQuizAttemptQuestionsInnerAnswerChoicesInner.md)
+- [PostQuizAttemptQuizSettings](docs/PostQuizAttemptQuizSettings.md)
+- [PostQuizAttemptSubmit](docs/PostQuizAttemptSubmit.md)
+- [PostQuizAttemptSubmitFinalAnswersInner](docs/PostQuizAttemptSubmitFinalAnswersInner.md)
+- [PostQuizAttemptSubmitFinalAnswersInnerAnswer](docs/PostQuizAttemptSubmitFinalAnswersInnerAnswer.md)
+- [PostQuizCriteria](docs/PostQuizCriteria.md)
+- [PostQuizCriteriaCriteriaInner](docs/PostQuizCriteriaCriteriaInner.md)
+- [PostQuizQuestions](docs/PostQuizQuestions.md)
+- [PostQuizQuestionsQuestionsInner](docs/PostQuizQuestionsQuestionsInner.md)
+- [PostQuizSettings](docs/PostQuizSettings.md)
+- [PostResetPassword](docs/PostResetPassword.md)
+- [PostSendResetPassword](docs/PostSendResetPassword.md)
+- [PostVerifyManifest](docs/PostVerifyManifest.md)
+- [PostVerifyManifestItemsInner](docs/PostVerifyManifestItemsInner.md)
+- [PostVerifyManifestResourcesInner](docs/PostVerifyManifestResourcesInner.md)
+- [PutContent](docs/PutContent.md)
+- [PutContentVersion](docs/PutContentVersion.md)
+- [PutCourse](docs/PutCourse.md)
+- [PutCourseEnrollment](docs/PutCourseEnrollment.md)
+- [PutModule](docs/PutModule.md)
+- [PutPortalBranding](docs/PutPortalBranding.md)
+- [PutQuestion](docs/PutQuestion.md)
+- [PutQuestionAnswerChoicesInner](docs/PutQuestionAnswerChoicesInner.md)
+- [PutQuiz](docs/PutQuiz.md)
+- [PutQuizAnswer](docs/PutQuizAnswer.md)
+- [PutQuizAnswerAnswer](docs/PutQuizAnswerAnswer.md)
+- [PutQuizSettings](docs/PutQuizSettings.md)
+- [PutUser](docs/PutUser.md)
+- [QuizContent](docs/QuizContent.md)
+- [QuizContentAssignment](docs/QuizContentAssignment.md)
+- [QuizContentSettings](docs/QuizContentSettings.md)
+- [SCORMContent](docs/SCORMContent.md)
+- [ScormGetValueResponse](docs/ScormGetValueResponse.md)
+- [ScormSessionData](docs/ScormSessionData.md)
+- [ScormSessionDataProgress](docs/ScormSessionDataProgress.md)
+- [ScormSessionDataScore](docs/ScormSessionDataScore.md)
+- [ScormSessionDataSession](docs/ScormSessionDataSession.md)
+- [ScormSessionDataStatus](docs/ScormSessionDataStatus.md)
+- [ScormSessionDataTime](docs/ScormSessionDataTime.md)
+- [ScormSetValueRequest](docs/ScormSetValueRequest.md)
+- [ScormSetValueResponse](docs/ScormSetValueResponse.md)
+- [SingleAnswer](docs/SingleAnswer.md)
+
+### Authorization
+
+Endpoints do not require authorization.
 
-```
-npm install @easyedu/js-lsm-api@1.30.0 --save
-```
 
-_unPublished (not recommended):_
+## About
 
+This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
+and is automatically generated by the
+[OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: `1.0.0`
+- Package version: `1.32.0`
+- Generator version: `7.17.0`
+- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
+
+The generated npm module supports the following:
+
+- Environments
+  * Node.js
+  * Webpack
+  * Browserify
+- Language levels
+  * ES5 - you must have a Promises/A+ library installed
+  * ES6
+- Module systems
+  * CommonJS
+  * ES6 module system
+
+
+## Development
+
+### Building
+
+To build the TypeScript source code, you need to have Node.js and npm installed.
+After cloning the repository, navigate to the project directory and run:
+
+```bash
+npm install
+npm run build
 ```
-npm install PATH_TO_GENERATED_PACKAGE --save
+
+### Publishing
+
+Once you've built the package, you can publish it to npm:
+
+```bash
+npm publish
 ```
+
+## License
+
+[]()

package/dist/apis/ContentApi.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { GetContent, GetContentList, GetContentSession, GetContentSessionDetail, GetContentSessionList, GetContentUpload, GetContentVersion, GetContentVersionList, GetScormApiLogs, GetScormPackage, GetScormSessionData, PostContentQuiz, PostContentSession, PostContentUpload, PutContent, PutContentVersion } from '../models/index';
+import type { GetContent, GetContentList, GetContentSession, GetContentSessionDetail, GetContentSessionList, GetContentUpload, GetContentVersion, GetContentVersionList, GetScormApiLogs, GetScormPackage, GetScormSessionData, PostContentQuiz, PostContentSession, PostContentUpload, PostVerifyManifest, PutContent, PutContentVersion, ScormGetValueResponse, ScormSetValueRequest, ScormSetValueResponse } from '../models/index';
+export interface CommitScormSessionRequest {
+    scormSessionId: string;
+}
 export interface GetContentRequest {
     contentId: string;
     moduleId: string;
@@ -55,11 +58,19 @@ export interface GetScormPackageRequest {
 export interface GetScormSessionDataRequest {
     scormSessionId: string;
 }
+export interface GetScormValueRequest {
+    scormSessionId: string;
+    key: string;
+}
+export interface InitializeScormSessionRequest {
+    scormSessionId: string;
+}
 export interface ListContentSessionsRequest {
     contentId: string;
     moduleId: string;
     courseId: string;
-    sessionType?: ListContentSessionsSessionTypeEnum;
+    environment?: ListContentSessionsEnvironmentEnum;
+    userId?: string;
     page?: number;
     pageSize?: number;
 }
@@ -77,6 +88,7 @@ export interface PostContentSessionRequest {
     contentId: string;
     moduleId: string;
     courseId: string;
+    environment?: PostContentSessionEnvironmentEnum;
 }
 export interface PostContentUploadRequest {
     moduleId: string;
@@ -96,10 +108,30 @@ export interface PutContentVersionRequest {
     versionId: string;
     putContentVersion: PutContentVersion;
 }
+export interface SetScormValueRequest {
+    scormSessionId: string;
+    scormSetValueRequest: ScormSetValueRequest;
+}
+export interface TerminateScormSessionRequest {
+    scormSessionId: string;
+}
+export interface VerifyScormManifestRequest {
+    body: string;
+}
 /**
  *
  */
 export declare class ContentApi extends runtime.BaseAPI {
+    /**
+     * Commit/persist SCORM CMI data changes to the database
+     * Commit SCORM session data
+     */
+    commitScormSessionRaw(requestParameters: CommitScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Commit/persist SCORM CMI data changes to the database
+     * Commit SCORM session data
+     */
+    commitScormSession(requestParameters: CommitScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * get content
      */
@@ -184,6 +216,26 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Get SCORM session data (instructor only)
      */
     getScormSessionData(requestParameters: GetScormSessionDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormSessionData>;
+    /**
+     * Retrieve the value of a specific SCORM CMI data element from the session
+     * Get a SCORM CMI data element value
+     */
+    getScormValueRaw(requestParameters: GetScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScormGetValueResponse>>;
+    /**
+     * Retrieve the value of a specific SCORM CMI data element from the session
+     * Get a SCORM CMI data element value
+     */
+    getScormValue(requestParameters: GetScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormGetValueResponse>;
+    /**
+     * Initialize a SCORM session for content playback
+     * Initialize a SCORM session
+     */
+    initializeScormSessionRaw(requestParameters: InitializeScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Initialize a SCORM session for content playback
+     * Initialize a SCORM session
+     */
+    initializeScormSession(requestParameters: InitializeScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Get a paginated list of all content sessions for a specific content item
      * List content sessions (instructor only)
@@ -246,12 +298,50 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Update a content version
      */
     putContentVersion(requestParameters: PutContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersion>;
+    /**
+     * Update the value of a specific SCORM CMI data element in the session
+     * Set a SCORM CMI data element value
+     */
+    setScormValueRaw(requestParameters: SetScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScormSetValueResponse>>;
+    /**
+     * Update the value of a specific SCORM CMI data element in the session
+     * Set a SCORM CMI data element value
+     */
+    setScormValue(requestParameters: SetScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormSetValueResponse>;
+    /**
+     * Terminate the SCORM session and finalize all data
+     * Terminate a SCORM session
+     */
+    terminateScormSessionRaw(requestParameters: TerminateScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Terminate the SCORM session and finalize all data
+     * Terminate a SCORM session
+     */
+    terminateScormSession(requestParameters: TerminateScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Takes raw imsmanifest.xml content and returns the parsed manifest structure with validation warnings
+     * Parse and verify a SCORM manifest
+     */
+    verifyScormManifestRaw(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostVerifyManifest>>;
+    /**
+     * Takes raw imsmanifest.xml content and returns the parsed manifest structure with validation warnings
+     * Parse and verify a SCORM manifest
+     */
+    verifyScormManifest(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostVerifyManifest>;
 }
 /**
  * @export
  */
-export declare const ListContentSessionsSessionTypeEnum: {
+export declare const ListContentSessionsEnvironmentEnum: {
     readonly Sandbox: "SANDBOX";
     readonly Live: "LIVE";
 };
-export type ListContentSessionsSessionTypeEnum = typeof ListContentSessionsSessionTypeEnum[keyof typeof ListContentSessionsSessionTypeEnum];
+export type ListContentSessionsEnvironmentEnum = typeof ListContentSessionsEnvironmentEnum[keyof typeof ListContentSessionsEnvironmentEnum];
+/**
+ * @export
+ */
+export declare const PostContentSessionEnvironmentEnum: {
+    readonly Sandbox: "sandbox";
+    readonly Live: "live";
+};
+export type PostContentSessionEnvironmentEnum = typeof PostContentSessionEnvironmentEnum[keyof typeof PostContentSessionEnvironmentEnum];