@easyedu/js-lsm-api 1.30.0 → 1.32.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (357) hide show
  1. package/.openapi-generator/FILES +209 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +378 -28
  4. package/dist/apis/ContentApi.d.ts +94 -4
  5. package/dist/apis/ContentApi.js +292 -20
  6. package/dist/apis/CourseApi.js +37 -12
  7. package/dist/apis/ModuleApi.js +14 -4
  8. package/dist/apis/OtherApi.js +2 -1
  9. package/dist/apis/PortalApi.js +19 -7
  10. package/dist/apis/QuestionApi.js +13 -5
  11. package/dist/apis/QuizApi.js +79 -25
  12. package/dist/apis/ReportingApi.js +39 -9
  13. package/dist/apis/UserApi.js +16 -7
  14. package/dist/esm/apis/ContentApi.d.ts +94 -4
  15. package/dist/esm/apis/ContentApi.js +292 -20
  16. package/dist/esm/apis/CourseApi.js +37 -12
  17. package/dist/esm/apis/ModuleApi.js +14 -4
  18. package/dist/esm/apis/OtherApi.js +2 -1
  19. package/dist/esm/apis/PortalApi.js +19 -7
  20. package/dist/esm/apis/QuestionApi.js +13 -5
  21. package/dist/esm/apis/QuizApi.js +79 -25
  22. package/dist/esm/apis/ReportingApi.js +39 -9
  23. package/dist/esm/apis/UserApi.js +16 -7
  24. package/dist/esm/models/GetContentContentData.js +6 -0
  25. package/dist/esm/models/GetContentVersion.js +2 -2
  26. package/dist/esm/models/GetContentVersionListItemsInner.js +2 -2
  27. package/dist/esm/models/GetManualQuestionSelectionItem.js +1 -1
  28. package/dist/esm/models/GetQuestionListFilters.js +2 -2
  29. package/dist/esm/models/GetQuiz.js +2 -2
  30. package/dist/esm/models/GetQuizAttemptAnalyticsBasicInfo.js +2 -2
  31. package/dist/esm/models/GetQuizAttemptAnalyticsQuestionAnalysisInner.js +1 -1
  32. package/dist/esm/models/GetQuizAttemptAttempt.js +3 -3
  33. package/dist/esm/models/GetQuizAttemptListAllOfAttempts.js +2 -2
  34. package/dist/esm/models/GetQuizAttemptListAllOfFiltersDateRange.js +2 -2
  35. package/dist/esm/models/GetQuizAttemptQuestionsInner.js +1 -1
  36. package/dist/esm/models/GetQuizAttemptQuestionsInnerCurrentAnswer.js +1 -1
  37. package/dist/esm/models/GetQuizCriteriaItem.js +2 -2
  38. package/dist/esm/models/GetQuizCriteriaListItemsInner.js +2 -2
  39. package/dist/esm/models/GetQuizListAllOfQuizzes.js +2 -2
  40. package/dist/esm/models/GetQuizQuestionsItemsInner.js +1 -1
  41. package/dist/esm/models/GetQuizResultsTiming.js +2 -2
  42. package/dist/esm/models/GetScormPackagePackageInfo.js +2 -2
  43. package/dist/esm/models/GetUserQuizAttemptsAllOfAttempts.js +2 -2
  44. package/dist/esm/models/PostContentQuizAssignment.js +3 -3
  45. package/dist/esm/models/PostContentQuizQuestionSelection.js +6 -0
  46. package/dist/esm/models/PostQuizAttemptAttempt.js +2 -2
  47. package/dist/esm/models/PostQuizAttemptSubmit.js +1 -1
  48. package/dist/esm/models/PostQuizAttemptSubmitFinalAnswersInnerAnswer.js +6 -0
  49. package/dist/esm/models/PostVerifyManifest.d.ts +106 -0
  50. package/dist/esm/models/PostVerifyManifest.js +73 -0
  51. package/dist/esm/models/PostVerifyManifestItemsInner.d.ts +74 -0
  52. package/dist/esm/models/PostVerifyManifestItemsInner.js +55 -0
  53. package/dist/esm/models/PostVerifyManifestResourcesInner.d.ts +56 -0
  54. package/dist/esm/models/PostVerifyManifestResourcesInner.js +49 -0
  55. package/dist/esm/models/PutQuizAnswerAnswer.js +6 -0
  56. package/dist/esm/models/QuizContentAssignment.js +3 -3
  57. package/dist/esm/models/ScormGetValueResponse.d.ts +38 -0
  58. package/dist/esm/models/ScormGetValueResponse.js +47 -0
  59. package/dist/esm/models/ScormSetValueRequest.d.ts +38 -0
  60. package/dist/esm/models/ScormSetValueRequest.js +47 -0
  61. package/dist/esm/models/ScormSetValueResponse.d.ts +32 -0
  62. package/dist/esm/models/ScormSetValueResponse.js +43 -0
  63. package/dist/esm/models/index.d.ts +6 -0
  64. package/dist/esm/models/index.js +6 -0
  65. package/dist/esm/runtime.d.ts +3 -1
  66. package/dist/esm/runtime.js +5 -1
  67. package/dist/models/GetContentContentData.js +6 -0
  68. package/dist/models/GetContentVersion.js +2 -2
  69. package/dist/models/GetContentVersionListItemsInner.js +2 -2
  70. package/dist/models/GetManualQuestionSelectionItem.js +1 -1
  71. package/dist/models/GetQuestionListFilters.js +2 -2
  72. package/dist/models/GetQuiz.js +2 -2
  73. package/dist/models/GetQuizAttemptAnalyticsBasicInfo.js +2 -2
  74. package/dist/models/GetQuizAttemptAnalyticsQuestionAnalysisInner.js +1 -1
  75. package/dist/models/GetQuizAttemptAttempt.js +3 -3
  76. package/dist/models/GetQuizAttemptListAllOfAttempts.js +2 -2
  77. package/dist/models/GetQuizAttemptListAllOfFiltersDateRange.js +2 -2
  78. package/dist/models/GetQuizAttemptQuestionsInner.js +1 -1
  79. package/dist/models/GetQuizAttemptQuestionsInnerCurrentAnswer.js +1 -1
  80. package/dist/models/GetQuizCriteriaItem.js +2 -2
  81. package/dist/models/GetQuizCriteriaListItemsInner.js +2 -2
  82. package/dist/models/GetQuizListAllOfQuizzes.js +2 -2
  83. package/dist/models/GetQuizQuestionsItemsInner.js +1 -1
  84. package/dist/models/GetQuizResultsTiming.js +2 -2
  85. package/dist/models/GetScormPackagePackageInfo.js +2 -2
  86. package/dist/models/GetUserQuizAttemptsAllOfAttempts.js +2 -2
  87. package/dist/models/PostContentQuizAssignment.js +3 -3
  88. package/dist/models/PostContentQuizQuestionSelection.js +6 -0
  89. package/dist/models/PostQuizAttemptAttempt.js +2 -2
  90. package/dist/models/PostQuizAttemptSubmit.js +1 -1
  91. package/dist/models/PostQuizAttemptSubmitFinalAnswersInnerAnswer.js +6 -0
  92. package/dist/models/PostVerifyManifest.d.ts +106 -0
  93. package/dist/models/PostVerifyManifest.js +80 -0
  94. package/dist/models/PostVerifyManifestItemsInner.d.ts +74 -0
  95. package/dist/models/PostVerifyManifestItemsInner.js +62 -0
  96. package/dist/models/PostVerifyManifestResourcesInner.d.ts +56 -0
  97. package/dist/models/PostVerifyManifestResourcesInner.js +56 -0
  98. package/dist/models/PutQuizAnswerAnswer.js +6 -0
  99. package/dist/models/QuizContentAssignment.js +3 -3
  100. package/dist/models/ScormGetValueResponse.d.ts +38 -0
  101. package/dist/models/ScormGetValueResponse.js +54 -0
  102. package/dist/models/ScormSetValueRequest.d.ts +38 -0
  103. package/dist/models/ScormSetValueRequest.js +54 -0
  104. package/dist/models/ScormSetValueResponse.d.ts +32 -0
  105. package/dist/models/ScormSetValueResponse.js +50 -0
  106. package/dist/models/index.d.ts +6 -0
  107. package/dist/models/index.js +6 -0
  108. package/dist/runtime.d.ts +3 -1
  109. package/dist/runtime.js +5 -1
  110. package/docs/ContentApi.md +1645 -0
  111. package/docs/CourseApi.md +845 -0
  112. package/docs/CriteriaBasedSelection.md +40 -0
  113. package/docs/CriteriaBasedSelectionCriteria.md +42 -0
  114. package/docs/CriteriaBasedSelectionDistribution.md +37 -0
  115. package/docs/FillInBlank.md +36 -0
  116. package/docs/FillInBlank1.md +36 -0
  117. package/docs/GetContent.md +58 -0
  118. package/docs/GetContentContentData.md +53 -0
  119. package/docs/GetContentGradeDetail.md +50 -0
  120. package/docs/GetContentGrades.md +42 -0
  121. package/docs/GetContentGradesItemsInner.md +40 -0
  122. package/docs/GetContentGradesItemsInnerUser.md +38 -0
  123. package/docs/GetContentInstructorBasicReporting.md +38 -0
  124. package/docs/GetContentInstructorBasicReportingContentInfo.md +38 -0
  125. package/docs/GetContentInstructorBasicReportingEngagement.md +42 -0
  126. package/docs/GetContentInstructorBasicReportingPerformance.md +36 -0
  127. package/docs/GetContentList.md +43 -0
  128. package/docs/GetContentSession.md +45 -0
  129. package/docs/GetContentSessionDetail.md +51 -0
  130. package/docs/GetContentSessionDetailScormSessionDataInner.md +36 -0
  131. package/docs/GetContentSessionDetailUserData.md +36 -0
  132. package/docs/GetContentSessionList.md +43 -0
  133. package/docs/GetContentSessionListItem.md +45 -0
  134. package/docs/GetContentSessionListItemScormSessionData.md +35 -0
  135. package/docs/GetContentUpload.md +38 -0
  136. package/docs/GetContentVersion.md +49 -0
  137. package/docs/GetContentVersionList.md +43 -0
  138. package/docs/GetContentVersionListItemsInner.md +42 -0
  139. package/docs/GetContentVersionSandbox.md +35 -0
  140. package/docs/GetContentVersionScormData.md +35 -0
  141. package/docs/GetCourse.md +44 -0
  142. package/docs/GetCourseEnrollment.md +51 -0
  143. package/docs/GetCourseEnrollmentList.md +43 -0
  144. package/docs/GetCourseEnrollmentListItem.md +53 -0
  145. package/docs/GetCourseExport.md +49 -0
  146. package/docs/GetCourseExportList.md +43 -0
  147. package/docs/GetCourseList.md +43 -0
  148. package/docs/GetCourseReportingBasic.md +38 -0
  149. package/docs/GetCourseStudentReporting.md +38 -0
  150. package/docs/GetCourseStudentReportingCourseInfo.md +34 -0
  151. package/docs/GetCourseStudentReportingEngagement.md +36 -0
  152. package/docs/GetCourseStudentReportingPerformance.md +34 -0
  153. package/docs/GetManualQuestionSelectionItem.md +48 -0
  154. package/docs/GetManualQuestionSelectionList.md +44 -0
  155. package/docs/GetModule.md +44 -0
  156. package/docs/GetModuleInstructorBasicReporting.md +38 -0
  157. package/docs/GetModuleInstructorBasicReportingEngagement.md +34 -0
  158. package/docs/GetModuleInstructorBasicReportingModuleInfo.md +34 -0
  159. package/docs/GetModuleInstructorBasicReportingPerformance.md +34 -0
  160. package/docs/GetModuleList.md +43 -0
  161. package/docs/GetModuleStudentReporting.md +38 -0
  162. package/docs/GetModuleStudentReportingAccess.md +36 -0
  163. package/docs/GetModuleStudentReportingProgress.md +36 -0
  164. package/docs/GetPortal.md +48 -0
  165. package/docs/GetPortalBasicReporting.md +36 -0
  166. package/docs/GetPortalBasicReportingCertificates.md +34 -0
  167. package/docs/GetPortalBasicReportingPortalInfo.md +38 -0
  168. package/docs/GetPortalList.md +43 -0
  169. package/docs/GetPortalStudentReporting.md +36 -0
  170. package/docs/GetPortalStudentReportingCertificates.md +34 -0
  171. package/docs/GetPortalStudentReportingPortalInfo.md +38 -0
  172. package/docs/GetPortalUser.md +45 -0
  173. package/docs/GetPortalUserList.md +43 -0
  174. package/docs/GetQuestion.md +62 -0
  175. package/docs/GetQuestionAnswerChoicesInner.md +38 -0
  176. package/docs/GetQuestionList.md +44 -0
  177. package/docs/GetQuestionListFilters.md +48 -0
  178. package/docs/GetQuiz.md +68 -0
  179. package/docs/GetQuizAttempt.md +38 -0
  180. package/docs/GetQuizAttemptAnalytics.md +46 -0
  181. package/docs/GetQuizAttemptAnalyticsBasicInfo.md +49 -0
  182. package/docs/GetQuizAttemptAnalyticsPerformanceBreakdown.md +39 -0
  183. package/docs/GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner.md +44 -0
  184. package/docs/GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner.md +44 -0
  185. package/docs/GetQuizAttemptAnalyticsPerformanceBreakdownByTopicInner.md +44 -0
  186. package/docs/GetQuizAttemptAnalyticsQuestionAnalysisInner.md +58 -0
  187. package/docs/GetQuizAttemptAnalyticsQuestionAnalysisInnerCorrectAnswer.md +39 -0
  188. package/docs/GetQuizAttemptAnalyticsQuestionAnalysisInnerUserAnswer.md +39 -0
  189. package/docs/GetQuizAttemptAnalyticsScoring.md +49 -0
  190. package/docs/GetQuizAttemptAttempt.md +61 -0
  191. package/docs/GetQuizAttemptList.md +46 -0
  192. package/docs/GetQuizAttemptListAllOfAttempts.md +68 -0
  193. package/docs/GetQuizAttemptListAllOfFilters.md +45 -0
  194. package/docs/GetQuizAttemptListAllOfFiltersDateRange.md +37 -0
  195. package/docs/GetQuizAttemptListAllOfSummary.md +45 -0
  196. package/docs/GetQuizAttemptQuestionsInner.md +52 -0
  197. package/docs/GetQuizAttemptQuestionsInnerAnswerChoicesInner.md +38 -0
  198. package/docs/GetQuizAttemptQuestionsInnerCurrentAnswer.md +41 -0
  199. package/docs/GetQuizAttemptQuizSettings.md +45 -0
  200. package/docs/GetQuizCriteria.md +38 -0
  201. package/docs/GetQuizCriteriaEstimatedQuestions.md +39 -0
  202. package/docs/GetQuizCriteriaItem.md +58 -0
  203. package/docs/GetQuizCriteriaList.md +42 -0
  204. package/docs/GetQuizCriteriaListItemsInner.md +58 -0
  205. package/docs/GetQuizList.md +44 -0
  206. package/docs/GetQuizListAllOfFilters.md +43 -0
  207. package/docs/GetQuizListAllOfQuizzes.md +64 -0
  208. package/docs/GetQuizListAllOfStatistics.md +43 -0
  209. package/docs/GetQuizQuestions.md +48 -0
  210. package/docs/GetQuizQuestionsItemsInner.md +48 -0
  211. package/docs/GetQuizQuestionsItemsInnerQuestionDetails.md +53 -0
  212. package/docs/GetQuizQuestionsItemsInnerQuestionDetailsAnswerChoicesInner.md +42 -0
  213. package/docs/GetQuizResults.md +52 -0
  214. package/docs/GetQuizResultsFeedback.md +39 -0
  215. package/docs/GetQuizResultsFeedbackDifficultyPerformanceInner.md +40 -0
  216. package/docs/GetQuizResultsFeedbackTopicPerformanceInner.md +40 -0
  217. package/docs/GetQuizResultsQuestionsInner.md +50 -0
  218. package/docs/GetQuizResultsQuestionsInnerAnswerChoicesInner.md +40 -0
  219. package/docs/GetQuizResultsQuestionsInnerStudentAnswer.md +43 -0
  220. package/docs/GetQuizResultsScore.md +41 -0
  221. package/docs/GetQuizResultsTiming.md +43 -0
  222. package/docs/GetQuizStatistics.md +43 -0
  223. package/docs/GetScormApiLogItem.md +45 -0
  224. package/docs/GetScormApiLogs.md +43 -0
  225. package/docs/GetScormPackage.md +37 -0
  226. package/docs/GetScormPackagePackageInfo.md +59 -0
  227. package/docs/GetScormSessionData.md +43 -0
  228. package/docs/GetScormSessionDataActivity.md +36 -0
  229. package/docs/GetUser.md +42 -0
  230. package/docs/GetUserQuizAttempts.md +46 -0
  231. package/docs/GetUserQuizAttemptsAllOfAttempts.md +70 -0
  232. package/docs/GetUserQuizAttemptsAllOfFilters.md +47 -0
  233. package/docs/GetUserQuizAttemptsAllOfSummary.md +47 -0
  234. package/docs/LoginRes.md +36 -0
  235. package/docs/LoginResAuthData.md +36 -0
  236. package/docs/LoginResUserData.md +40 -0
  237. package/docs/LoginResUserDataSelectedPortal.md +36 -0
  238. package/docs/ManualSelection.md +36 -0
  239. package/docs/MediaContent.md +38 -0
  240. package/docs/ModuleApi.md +284 -0
  241. package/docs/MultipleAnswer.md +36 -0
  242. package/docs/MultipleAnswer1.md +36 -0
  243. package/docs/NoAnswer.md +34 -0
  244. package/docs/OtherApi.md +66 -0
  245. package/docs/Paginated.md +40 -0
  246. package/docs/PortalApi.md +493 -0
  247. package/docs/PostContentQuiz.md +42 -0
  248. package/docs/PostContentQuizAssignment.md +41 -0
  249. package/docs/PostContentQuizQuestionSelection.md +43 -0
  250. package/docs/PostContentQuizSettings.md +51 -0
  251. package/docs/PostContentSession.md +43 -0
  252. package/docs/PostContentUpload.md +36 -0
  253. package/docs/PostCourse.md +38 -0
  254. package/docs/PostCourseEnrollment.md +40 -0
  255. package/docs/PostCourseExport.md +35 -0
  256. package/docs/PostLogin.md +36 -0
  257. package/docs/PostManualQuestionSelection.md +40 -0
  258. package/docs/PostModule.md +38 -0
  259. package/docs/PostPortal.md +38 -0
  260. package/docs/PostPortalInvite.md +40 -0
  261. package/docs/PostQuestion.md +52 -0
  262. package/docs/PostQuestionAnswerChoicesInner.md +36 -0
  263. package/docs/PostQuiz.md +58 -0
  264. package/docs/PostQuizAttempt.md +38 -0
  265. package/docs/PostQuizAttemptAttempt.md +55 -0
  266. package/docs/PostQuizAttemptQuestionsInner.md +48 -0
  267. package/docs/PostQuizAttemptQuestionsInnerAnswerChoicesInner.md +38 -0
  268. package/docs/PostQuizAttemptQuizSettings.md +45 -0
  269. package/docs/PostQuizAttemptSubmit.md +38 -0
  270. package/docs/PostQuizAttemptSubmitFinalAnswersInner.md +36 -0
  271. package/docs/PostQuizAttemptSubmitFinalAnswersInnerAnswer.md +41 -0
  272. package/docs/PostQuizCriteria.md +36 -0
  273. package/docs/PostQuizCriteriaCriteriaInner.md +49 -0
  274. package/docs/PostQuizQuestions.md +36 -0
  275. package/docs/PostQuizQuestionsQuestionsInner.md +40 -0
  276. package/docs/PostQuizSettings.md +41 -0
  277. package/docs/PostResetPassword.md +36 -0
  278. package/docs/PostSendResetPassword.md +34 -0
  279. package/docs/PostVerifyManifest.md +59 -0
  280. package/docs/PostVerifyManifestItemsInner.md +48 -0
  281. package/docs/PostVerifyManifestResourcesInner.md +42 -0
  282. package/docs/PutContent.md +36 -0
  283. package/docs/PutContentVersion.md +35 -0
  284. package/docs/PutCourse.md +44 -0
  285. package/docs/PutCourseEnrollment.md +40 -0
  286. package/docs/PutModule.md +40 -0
  287. package/docs/PutPortalBranding.md +38 -0
  288. package/docs/PutQuestion.md +52 -0
  289. package/docs/PutQuestionAnswerChoicesInner.md +38 -0
  290. package/docs/PutQuiz.md +56 -0
  291. package/docs/PutQuizAnswer.md +36 -0
  292. package/docs/PutQuizAnswerAnswer.md +41 -0
  293. package/docs/PutQuizSettings.md +41 -0
  294. package/docs/PutUser.md +42 -0
  295. package/docs/QuestionApi.md +368 -0
  296. package/docs/QuizApi.md +1793 -0
  297. package/docs/QuizContent.md +40 -0
  298. package/docs/QuizContentAssignment.md +39 -0
  299. package/docs/QuizContentSettings.md +43 -0
  300. package/docs/ReportingApi.md +674 -0
  301. package/docs/SCORMContent.md +38 -0
  302. package/docs/ScormGetValueResponse.md +37 -0
  303. package/docs/ScormSessionData.md +43 -0
  304. package/docs/ScormSessionDataProgress.md +36 -0
  305. package/docs/ScormSessionDataScore.md +40 -0
  306. package/docs/ScormSessionDataSession.md +34 -0
  307. package/docs/ScormSessionDataStatus.md +40 -0
  308. package/docs/ScormSessionDataTime.md +40 -0
  309. package/docs/ScormSetValueRequest.md +37 -0
  310. package/docs/ScormSetValueResponse.md +35 -0
  311. package/docs/SingleAnswer.md +36 -0
  312. package/docs/UserApi.md +460 -0
  313. package/package.json +2 -2
  314. package/src/apis/ContentApi.ts +421 -21
  315. package/src/apis/CourseApi.ts +61 -12
  316. package/src/apis/ModuleApi.ts +22 -4
  317. package/src/apis/OtherApi.ts +4 -1
  318. package/src/apis/PortalApi.ts +33 -7
  319. package/src/apis/QuestionApi.ts +23 -5
  320. package/src/apis/QuizApi.ts +129 -25
  321. package/src/apis/ReportingApi.ts +57 -9
  322. package/src/apis/UserApi.ts +30 -7
  323. package/src/models/GetContentContentData.ts +6 -3
  324. package/src/models/GetContentVersion.ts +2 -2
  325. package/src/models/GetContentVersionListItemsInner.ts +2 -2
  326. package/src/models/GetManualQuestionSelectionItem.ts +1 -1
  327. package/src/models/GetQuestionListFilters.ts +2 -2
  328. package/src/models/GetQuiz.ts +2 -2
  329. package/src/models/GetQuizAttemptAnalyticsBasicInfo.ts +2 -2
  330. package/src/models/GetQuizAttemptAnalyticsQuestionAnalysisInner.ts +1 -1
  331. package/src/models/GetQuizAttemptAttempt.ts +3 -3
  332. package/src/models/GetQuizAttemptListAllOfAttempts.ts +2 -2
  333. package/src/models/GetQuizAttemptListAllOfFiltersDateRange.ts +2 -2
  334. package/src/models/GetQuizAttemptQuestionsInner.ts +1 -1
  335. package/src/models/GetQuizAttemptQuestionsInnerCurrentAnswer.ts +1 -1
  336. package/src/models/GetQuizCriteriaItem.ts +2 -2
  337. package/src/models/GetQuizCriteriaListItemsInner.ts +2 -2
  338. package/src/models/GetQuizListAllOfQuizzes.ts +2 -2
  339. package/src/models/GetQuizQuestionsItemsInner.ts +1 -1
  340. package/src/models/GetQuizResultsTiming.ts +2 -2
  341. package/src/models/GetScormPackagePackageInfo.ts +2 -2
  342. package/src/models/GetUserQuizAttemptsAllOfAttempts.ts +2 -2
  343. package/src/models/PostContentQuizAssignment.ts +3 -3
  344. package/src/models/PostContentQuizQuestionSelection.ts +6 -3
  345. package/src/models/PostQuizAttemptAttempt.ts +2 -2
  346. package/src/models/PostQuizAttemptSubmit.ts +1 -1
  347. package/src/models/PostQuizAttemptSubmitFinalAnswersInnerAnswer.ts +6 -3
  348. package/src/models/PostVerifyManifest.ts +179 -0
  349. package/src/models/PostVerifyManifestItemsInner.ts +121 -0
  350. package/src/models/PostVerifyManifestResourcesInner.ts +97 -0
  351. package/src/models/PutQuizAnswerAnswer.ts +6 -3
  352. package/src/models/QuizContentAssignment.ts +3 -3
  353. package/src/models/ScormGetValueResponse.ts +75 -0
  354. package/src/models/ScormSetValueRequest.ts +75 -0
  355. package/src/models/ScormSetValueResponse.ts +66 -0
  356. package/src/models/index.ts +6 -0
  357. package/src/runtime.ts +5 -4
@@ -0,0 +1,1793 @@
1
+ # QuizApi
2
+
3
+ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**addQuizCriteriaQuestionSelection**](QuizApi.md#addquizcriteriaquestionselection) | **POST** /quizzes/{quizId}/criteria-question-selection | Add question selection criteria |
8
+ | [**addQuizManualQuestionSelection**](QuizApi.md#addquizmanualquestionselection) | **POST** /quizzes/{quizId}/manual-question-selection | Add questions to quiz manually |
9
+ | [**addQuizQuestions**](QuizApi.md#addquizquestions) | **POST** /quizzes/{quizId}/questions | Add questions to quiz (manual selection) |
10
+ | [**createQuiz**](QuizApi.md#createquiz) | **POST** /quizzes | Create a new quiz configuration |
11
+ | [**deleteQuiz**](QuizApi.md#deletequiz) | **DELETE** /quizzes/{quizId} | Delete quiz configuration |
12
+ | [**deleteQuizCriteriaQuestionSelection**](QuizApi.md#deletequizcriteriaquestionselection) | **DELETE** /quizzes/{quizId}/criteria-question-selection/{criteriaId} | Delete question selection criteria |
13
+ | [**deleteQuizManualQuestionSelection**](QuizApi.md#deletequizmanualquestionselection) | **DELETE** /quizzes/{quizId}/manual-question-selection/{questionId} | Remove manually selected question from quiz |
14
+ | [**getQuiz**](QuizApi.md#getquiz) | **GET** /quizzes/{quizId} | Get quiz configuration by ID |
15
+ | [**getQuizAttempt**](QuizApi.md#getquizattempt) | **GET** /quiz-attempts/{attemptId} | Get current quiz attempt status and questions |
16
+ | [**getQuizAttemptAnalytics**](QuizApi.md#getquizattemptanalytics) | **GET** /quiz-attempts/{attemptId}/analytics | Get detailed analytics for quiz attempt (admin) |
17
+ | [**getQuizAttemptResults**](QuizApi.md#getquizattemptresults) | **GET** /quiz-attempts/{attemptId}/results | Get quiz attempt results |
18
+ | [**getQuizAttempts**](QuizApi.md#getquizattempts) | **GET** /quizzes/{quizId}/attempts | List attempts for this quiz (admin) |
19
+ | [**getQuizCriteriaQuestionSelection**](QuizApi.md#getquizcriteriaquestionselection) | **GET** /quizzes/{quizId}/criteria-question-selection/{criteriaId} | Get single question selection criteria |
20
+ | [**getQuizCriteriaQuestionSelectionList**](QuizApi.md#getquizcriteriaquestionselectionlist) | **GET** /quizzes/{quizId}/criteria-question-selection | Get quiz question selection criteria list |
21
+ | [**getQuizList**](QuizApi.md#getquizlist) | **GET** /quizzes | List quiz configurations |
22
+ | [**getQuizManualQuestionSelection**](QuizApi.md#getquizmanualquestionselection) | **GET** /quizzes/{quizId}/manual-question-selection/{questionId} | Get single manually selected question |
23
+ | [**getQuizManualQuestionSelectionList**](QuizApi.md#getquizmanualquestionselectionlist) | **GET** /quizzes/{quizId}/manual-question-selection | Get manually selected questions for quiz |
24
+ | [**getQuizQuestions**](QuizApi.md#getquizquestions) | **GET** /quizzes/{quizId}/questions | Get quiz questions (paginated) |
25
+ | [**getUserQuizAttempts**](QuizApi.md#getuserquizattempts) | **GET** /users/{userId}/quiz-attempts | Get user\'s quiz attempts across all quizzes |
26
+ | [**removeQuizQuestion**](QuizApi.md#removequizquestion) | **DELETE** /quizzes/{quizId}/questions/{questionId} | Remove question from quiz |
27
+ | [**saveQuizAnswer**](QuizApi.md#savequizanswer) | **PUT** /quiz-attempts/{attemptId}/answers/{questionId} | Save answer for a specific question |
28
+ | [**startQuizAttempt**](QuizApi.md#startquizattempt) | **POST** /quizzes/{quizId}/attempts | Start a new quiz attempt |
29
+ | [**submitQuizAttempt**](QuizApi.md#submitquizattempt) | **POST** /quiz-attempts/{attemptId}/submit | Submit quiz attempt for final scoring |
30
+ | [**updateQuiz**](QuizApi.md#updatequiz) | **PUT** /quizzes/{quizId} | Update quiz configuration |
31
+ | [**updateQuizQuestions**](QuizApi.md#updatequizquestions) | **PUT** /quizzes/{quizId}/questions | Update quiz question selection |
32
+
33
+
34
+
35
+ ## addQuizCriteriaQuestionSelection
36
+
37
+ > GetQuizCriteria addQuizCriteriaQuestionSelection(quizId, postQuizCriteria)
38
+
39
+ Add question selection criteria
40
+
41
+ ### Example
42
+
43
+ ```ts
44
+ import {
45
+ Configuration,
46
+ QuizApi,
47
+ } from '@easyedu/js-lsm-api';
48
+ import type { AddQuizCriteriaQuestionSelectionRequest } from '@easyedu/js-lsm-api';
49
+
50
+ async function example() {
51
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
52
+ const api = new QuizApi();
53
+
54
+ const body = {
55
+ // string
56
+ quizId: quizId_example,
57
+ // PostQuizCriteria
58
+ postQuizCriteria: ...,
59
+ } satisfies AddQuizCriteriaQuestionSelectionRequest;
60
+
61
+ try {
62
+ const data = await api.addQuizCriteriaQuestionSelection(body);
63
+ console.log(data);
64
+ } catch (error) {
65
+ console.error(error);
66
+ }
67
+ }
68
+
69
+ // Run the test
70
+ example().catch(console.error);
71
+ ```
72
+
73
+ ### Parameters
74
+
75
+
76
+ | Name | Type | Description | Notes |
77
+ |------------- | ------------- | ------------- | -------------|
78
+ | **quizId** | `string` | | [Defaults to `undefined`] |
79
+ | **postQuizCriteria** | [PostQuizCriteria](PostQuizCriteria.md) | | |
80
+
81
+ ### Return type
82
+
83
+ [**GetQuizCriteria**](GetQuizCriteria.md)
84
+
85
+ ### Authorization
86
+
87
+ No authorization required
88
+
89
+ ### HTTP request headers
90
+
91
+ - **Content-Type**: `application/json`
92
+ - **Accept**: `application/json`
93
+
94
+
95
+ ### HTTP response details
96
+ | Status code | Description | Response headers |
97
+ |-------------|-------------|------------------|
98
+ | **201** | Criteria added successfully | - |
99
+ | **400** | Invalid criteria | - |
100
+ | **404** | Quiz not found | - |
101
+
102
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
103
+
104
+
105
+ ## addQuizManualQuestionSelection
106
+
107
+ > GetManualQuestionSelectionItem addQuizManualQuestionSelection(quizId, postManualQuestionSelection)
108
+
109
+ Add questions to quiz manually
110
+
111
+ ### Example
112
+
113
+ ```ts
114
+ import {
115
+ Configuration,
116
+ QuizApi,
117
+ } from '@easyedu/js-lsm-api';
118
+ import type { AddQuizManualQuestionSelectionRequest } from '@easyedu/js-lsm-api';
119
+
120
+ async function example() {
121
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
122
+ const api = new QuizApi();
123
+
124
+ const body = {
125
+ // string
126
+ quizId: quizId_example,
127
+ // PostManualQuestionSelection
128
+ postManualQuestionSelection: ...,
129
+ } satisfies AddQuizManualQuestionSelectionRequest;
130
+
131
+ try {
132
+ const data = await api.addQuizManualQuestionSelection(body);
133
+ console.log(data);
134
+ } catch (error) {
135
+ console.error(error);
136
+ }
137
+ }
138
+
139
+ // Run the test
140
+ example().catch(console.error);
141
+ ```
142
+
143
+ ### Parameters
144
+
145
+
146
+ | Name | Type | Description | Notes |
147
+ |------------- | ------------- | ------------- | -------------|
148
+ | **quizId** | `string` | | [Defaults to `undefined`] |
149
+ | **postManualQuestionSelection** | [PostManualQuestionSelection](PostManualQuestionSelection.md) | | |
150
+
151
+ ### Return type
152
+
153
+ [**GetManualQuestionSelectionItem**](GetManualQuestionSelectionItem.md)
154
+
155
+ ### Authorization
156
+
157
+ No authorization required
158
+
159
+ ### HTTP request headers
160
+
161
+ - **Content-Type**: `application/json`
162
+ - **Accept**: `application/json`
163
+
164
+
165
+ ### HTTP response details
166
+ | Status code | Description | Response headers |
167
+ |-------------|-------------|------------------|
168
+ | **201** | Question added successfully | - |
169
+ | **400** | Invalid question data | - |
170
+ | **404** | Quiz or question not found | - |
171
+
172
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
173
+
174
+
175
+ ## addQuizQuestions
176
+
177
+ > GetQuizQuestions addQuizQuestions(quizId, postQuizQuestions)
178
+
179
+ Add questions to quiz (manual selection)
180
+
181
+ ### Example
182
+
183
+ ```ts
184
+ import {
185
+ Configuration,
186
+ QuizApi,
187
+ } from '@easyedu/js-lsm-api';
188
+ import type { AddQuizQuestionsRequest } from '@easyedu/js-lsm-api';
189
+
190
+ async function example() {
191
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
192
+ const api = new QuizApi();
193
+
194
+ const body = {
195
+ // string
196
+ quizId: quizId_example,
197
+ // PostQuizQuestions
198
+ postQuizQuestions: ...,
199
+ } satisfies AddQuizQuestionsRequest;
200
+
201
+ try {
202
+ const data = await api.addQuizQuestions(body);
203
+ console.log(data);
204
+ } catch (error) {
205
+ console.error(error);
206
+ }
207
+ }
208
+
209
+ // Run the test
210
+ example().catch(console.error);
211
+ ```
212
+
213
+ ### Parameters
214
+
215
+
216
+ | Name | Type | Description | Notes |
217
+ |------------- | ------------- | ------------- | -------------|
218
+ | **quizId** | `string` | | [Defaults to `undefined`] |
219
+ | **postQuizQuestions** | [PostQuizQuestions](PostQuizQuestions.md) | | |
220
+
221
+ ### Return type
222
+
223
+ [**GetQuizQuestions**](GetQuizQuestions.md)
224
+
225
+ ### Authorization
226
+
227
+ No authorization required
228
+
229
+ ### HTTP request headers
230
+
231
+ - **Content-Type**: `application/json`
232
+ - **Accept**: `application/json`
233
+
234
+
235
+ ### HTTP response details
236
+ | Status code | Description | Response headers |
237
+ |-------------|-------------|------------------|
238
+ | **201** | Questions added successfully | - |
239
+ | **400** | Invalid question selection | - |
240
+ | **404** | Quiz or questions not found | - |
241
+
242
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
243
+
244
+
245
+ ## createQuiz
246
+
247
+ > GetQuiz createQuiz(postQuiz)
248
+
249
+ Create a new quiz configuration
250
+
251
+ ### Example
252
+
253
+ ```ts
254
+ import {
255
+ Configuration,
256
+ QuizApi,
257
+ } from '@easyedu/js-lsm-api';
258
+ import type { CreateQuizRequest } from '@easyedu/js-lsm-api';
259
+
260
+ async function example() {
261
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
262
+ const api = new QuizApi();
263
+
264
+ const body = {
265
+ // PostQuiz
266
+ postQuiz: ...,
267
+ } satisfies CreateQuizRequest;
268
+
269
+ try {
270
+ const data = await api.createQuiz(body);
271
+ console.log(data);
272
+ } catch (error) {
273
+ console.error(error);
274
+ }
275
+ }
276
+
277
+ // Run the test
278
+ example().catch(console.error);
279
+ ```
280
+
281
+ ### Parameters
282
+
283
+
284
+ | Name | Type | Description | Notes |
285
+ |------------- | ------------- | ------------- | -------------|
286
+ | **postQuiz** | [PostQuiz](PostQuiz.md) | | |
287
+
288
+ ### Return type
289
+
290
+ [**GetQuiz**](GetQuiz.md)
291
+
292
+ ### Authorization
293
+
294
+ No authorization required
295
+
296
+ ### HTTP request headers
297
+
298
+ - **Content-Type**: `application/json`
299
+ - **Accept**: `application/json`
300
+
301
+
302
+ ### HTTP response details
303
+ | Status code | Description | Response headers |
304
+ |-------------|-------------|------------------|
305
+ | **201** | Quiz created successfully | - |
306
+ | **400** | Invalid quiz configuration | - |
307
+
308
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
309
+
310
+
311
+ ## deleteQuiz
312
+
313
+ > deleteQuiz(quizId)
314
+
315
+ Delete quiz configuration
316
+
317
+ ### Example
318
+
319
+ ```ts
320
+ import {
321
+ Configuration,
322
+ QuizApi,
323
+ } from '@easyedu/js-lsm-api';
324
+ import type { DeleteQuizRequest } from '@easyedu/js-lsm-api';
325
+
326
+ async function example() {
327
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
328
+ const api = new QuizApi();
329
+
330
+ const body = {
331
+ // string
332
+ quizId: quizId_example,
333
+ } satisfies DeleteQuizRequest;
334
+
335
+ try {
336
+ const data = await api.deleteQuiz(body);
337
+ console.log(data);
338
+ } catch (error) {
339
+ console.error(error);
340
+ }
341
+ }
342
+
343
+ // Run the test
344
+ example().catch(console.error);
345
+ ```
346
+
347
+ ### Parameters
348
+
349
+
350
+ | Name | Type | Description | Notes |
351
+ |------------- | ------------- | ------------- | -------------|
352
+ | **quizId** | `string` | | [Defaults to `undefined`] |
353
+
354
+ ### Return type
355
+
356
+ `void` (Empty response body)
357
+
358
+ ### Authorization
359
+
360
+ No authorization required
361
+
362
+ ### HTTP request headers
363
+
364
+ - **Content-Type**: Not defined
365
+ - **Accept**: Not defined
366
+
367
+
368
+ ### HTTP response details
369
+ | Status code | Description | Response headers |
370
+ |-------------|-------------|------------------|
371
+ | **200** | Quiz deleted successfully | - |
372
+ | **404** | Quiz not found | - |
373
+ | **409** | Quiz has attempts and cannot be deleted | - |
374
+
375
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
376
+
377
+
378
+ ## deleteQuizCriteriaQuestionSelection
379
+
380
+ > deleteQuizCriteriaQuestionSelection(quizId, criteriaId)
381
+
382
+ Delete question selection criteria
383
+
384
+ ### Example
385
+
386
+ ```ts
387
+ import {
388
+ Configuration,
389
+ QuizApi,
390
+ } from '@easyedu/js-lsm-api';
391
+ import type { DeleteQuizCriteriaQuestionSelectionRequest } from '@easyedu/js-lsm-api';
392
+
393
+ async function example() {
394
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
395
+ const api = new QuizApi();
396
+
397
+ const body = {
398
+ // string
399
+ quizId: quizId_example,
400
+ // string
401
+ criteriaId: criteriaId_example,
402
+ } satisfies DeleteQuizCriteriaQuestionSelectionRequest;
403
+
404
+ try {
405
+ const data = await api.deleteQuizCriteriaQuestionSelection(body);
406
+ console.log(data);
407
+ } catch (error) {
408
+ console.error(error);
409
+ }
410
+ }
411
+
412
+ // Run the test
413
+ example().catch(console.error);
414
+ ```
415
+
416
+ ### Parameters
417
+
418
+
419
+ | Name | Type | Description | Notes |
420
+ |------------- | ------------- | ------------- | -------------|
421
+ | **quizId** | `string` | | [Defaults to `undefined`] |
422
+ | **criteriaId** | `string` | | [Defaults to `undefined`] |
423
+
424
+ ### Return type
425
+
426
+ `void` (Empty response body)
427
+
428
+ ### Authorization
429
+
430
+ No authorization required
431
+
432
+ ### HTTP request headers
433
+
434
+ - **Content-Type**: Not defined
435
+ - **Accept**: Not defined
436
+
437
+
438
+ ### HTTP response details
439
+ | Status code | Description | Response headers |
440
+ |-------------|-------------|------------------|
441
+ | **200** | Criteria deleted successfully | - |
442
+ | **404** | Quiz or criteria not found | - |
443
+
444
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
445
+
446
+
447
+ ## deleteQuizManualQuestionSelection
448
+
449
+ > deleteQuizManualQuestionSelection(quizId, questionId)
450
+
451
+ Remove manually selected question from quiz
452
+
453
+ ### Example
454
+
455
+ ```ts
456
+ import {
457
+ Configuration,
458
+ QuizApi,
459
+ } from '@easyedu/js-lsm-api';
460
+ import type { DeleteQuizManualQuestionSelectionRequest } from '@easyedu/js-lsm-api';
461
+
462
+ async function example() {
463
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
464
+ const api = new QuizApi();
465
+
466
+ const body = {
467
+ // string
468
+ quizId: quizId_example,
469
+ // string
470
+ questionId: questionId_example,
471
+ } satisfies DeleteQuizManualQuestionSelectionRequest;
472
+
473
+ try {
474
+ const data = await api.deleteQuizManualQuestionSelection(body);
475
+ console.log(data);
476
+ } catch (error) {
477
+ console.error(error);
478
+ }
479
+ }
480
+
481
+ // Run the test
482
+ example().catch(console.error);
483
+ ```
484
+
485
+ ### Parameters
486
+
487
+
488
+ | Name | Type | Description | Notes |
489
+ |------------- | ------------- | ------------- | -------------|
490
+ | **quizId** | `string` | | [Defaults to `undefined`] |
491
+ | **questionId** | `string` | | [Defaults to `undefined`] |
492
+
493
+ ### Return type
494
+
495
+ `void` (Empty response body)
496
+
497
+ ### Authorization
498
+
499
+ No authorization required
500
+
501
+ ### HTTP request headers
502
+
503
+ - **Content-Type**: Not defined
504
+ - **Accept**: Not defined
505
+
506
+
507
+ ### HTTP response details
508
+ | Status code | Description | Response headers |
509
+ |-------------|-------------|------------------|
510
+ | **200** | Question removed successfully | - |
511
+ | **404** | Quiz or question not found | - |
512
+
513
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
514
+
515
+
516
+ ## getQuiz
517
+
518
+ > GetQuiz getQuiz(quizId)
519
+
520
+ Get quiz configuration by ID
521
+
522
+ ### Example
523
+
524
+ ```ts
525
+ import {
526
+ Configuration,
527
+ QuizApi,
528
+ } from '@easyedu/js-lsm-api';
529
+ import type { GetQuizRequest } from '@easyedu/js-lsm-api';
530
+
531
+ async function example() {
532
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
533
+ const api = new QuizApi();
534
+
535
+ const body = {
536
+ // string
537
+ quizId: quizId_example,
538
+ } satisfies GetQuizRequest;
539
+
540
+ try {
541
+ const data = await api.getQuiz(body);
542
+ console.log(data);
543
+ } catch (error) {
544
+ console.error(error);
545
+ }
546
+ }
547
+
548
+ // Run the test
549
+ example().catch(console.error);
550
+ ```
551
+
552
+ ### Parameters
553
+
554
+
555
+ | Name | Type | Description | Notes |
556
+ |------------- | ------------- | ------------- | -------------|
557
+ | **quizId** | `string` | | [Defaults to `undefined`] |
558
+
559
+ ### Return type
560
+
561
+ [**GetQuiz**](GetQuiz.md)
562
+
563
+ ### Authorization
564
+
565
+ No authorization required
566
+
567
+ ### HTTP request headers
568
+
569
+ - **Content-Type**: Not defined
570
+ - **Accept**: `application/json`
571
+
572
+
573
+ ### HTTP response details
574
+ | Status code | Description | Response headers |
575
+ |-------------|-------------|------------------|
576
+ | **200** | Quiz configuration retrieved successfully | - |
577
+ | **404** | Quiz not found | - |
578
+
579
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
580
+
581
+
582
+ ## getQuizAttempt
583
+
584
+ > GetQuizAttempt getQuizAttempt(attemptId)
585
+
586
+ Get current quiz attempt status and questions
587
+
588
+ ### Example
589
+
590
+ ```ts
591
+ import {
592
+ Configuration,
593
+ QuizApi,
594
+ } from '@easyedu/js-lsm-api';
595
+ import type { GetQuizAttemptRequest } from '@easyedu/js-lsm-api';
596
+
597
+ async function example() {
598
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
599
+ const api = new QuizApi();
600
+
601
+ const body = {
602
+ // string
603
+ attemptId: attemptId_example,
604
+ } satisfies GetQuizAttemptRequest;
605
+
606
+ try {
607
+ const data = await api.getQuizAttempt(body);
608
+ console.log(data);
609
+ } catch (error) {
610
+ console.error(error);
611
+ }
612
+ }
613
+
614
+ // Run the test
615
+ example().catch(console.error);
616
+ ```
617
+
618
+ ### Parameters
619
+
620
+
621
+ | Name | Type | Description | Notes |
622
+ |------------- | ------------- | ------------- | -------------|
623
+ | **attemptId** | `string` | | [Defaults to `undefined`] |
624
+
625
+ ### Return type
626
+
627
+ [**GetQuizAttempt**](GetQuizAttempt.md)
628
+
629
+ ### Authorization
630
+
631
+ No authorization required
632
+
633
+ ### HTTP request headers
634
+
635
+ - **Content-Type**: Not defined
636
+ - **Accept**: `application/json`
637
+
638
+
639
+ ### HTTP response details
640
+ | Status code | Description | Response headers |
641
+ |-------------|-------------|------------------|
642
+ | **200** | Quiz attempt retrieved successfully | - |
643
+ | **404** | Attempt not found | - |
644
+ | **403** | Not authorized to view this attempt | - |
645
+
646
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
647
+
648
+
649
+ ## getQuizAttemptAnalytics
650
+
651
+ > GetQuizAttemptAnalytics getQuizAttemptAnalytics(attemptId)
652
+
653
+ Get detailed analytics for quiz attempt (admin)
654
+
655
+ ### Example
656
+
657
+ ```ts
658
+ import {
659
+ Configuration,
660
+ QuizApi,
661
+ } from '@easyedu/js-lsm-api';
662
+ import type { GetQuizAttemptAnalyticsRequest } from '@easyedu/js-lsm-api';
663
+
664
+ async function example() {
665
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
666
+ const api = new QuizApi();
667
+
668
+ const body = {
669
+ // string
670
+ attemptId: attemptId_example,
671
+ } satisfies GetQuizAttemptAnalyticsRequest;
672
+
673
+ try {
674
+ const data = await api.getQuizAttemptAnalytics(body);
675
+ console.log(data);
676
+ } catch (error) {
677
+ console.error(error);
678
+ }
679
+ }
680
+
681
+ // Run the test
682
+ example().catch(console.error);
683
+ ```
684
+
685
+ ### Parameters
686
+
687
+
688
+ | Name | Type | Description | Notes |
689
+ |------------- | ------------- | ------------- | -------------|
690
+ | **attemptId** | `string` | | [Defaults to `undefined`] |
691
+
692
+ ### Return type
693
+
694
+ [**GetQuizAttemptAnalytics**](GetQuizAttemptAnalytics.md)
695
+
696
+ ### Authorization
697
+
698
+ No authorization required
699
+
700
+ ### HTTP request headers
701
+
702
+ - **Content-Type**: Not defined
703
+ - **Accept**: `application/json`
704
+
705
+
706
+ ### HTTP response details
707
+ | Status code | Description | Response headers |
708
+ |-------------|-------------|------------------|
709
+ | **200** | Analytics retrieved successfully | - |
710
+ | **404** | Attempt not found | - |
711
+ | **403** | Admin access required | - |
712
+
713
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
714
+
715
+
716
+ ## getQuizAttemptResults
717
+
718
+ > GetQuizResults getQuizAttemptResults(attemptId)
719
+
720
+ Get quiz attempt results
721
+
722
+ ### Example
723
+
724
+ ```ts
725
+ import {
726
+ Configuration,
727
+ QuizApi,
728
+ } from '@easyedu/js-lsm-api';
729
+ import type { GetQuizAttemptResultsRequest } from '@easyedu/js-lsm-api';
730
+
731
+ async function example() {
732
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
733
+ const api = new QuizApi();
734
+
735
+ const body = {
736
+ // string
737
+ attemptId: attemptId_example,
738
+ } satisfies GetQuizAttemptResultsRequest;
739
+
740
+ try {
741
+ const data = await api.getQuizAttemptResults(body);
742
+ console.log(data);
743
+ } catch (error) {
744
+ console.error(error);
745
+ }
746
+ }
747
+
748
+ // Run the test
749
+ example().catch(console.error);
750
+ ```
751
+
752
+ ### Parameters
753
+
754
+
755
+ | Name | Type | Description | Notes |
756
+ |------------- | ------------- | ------------- | -------------|
757
+ | **attemptId** | `string` | | [Defaults to `undefined`] |
758
+
759
+ ### Return type
760
+
761
+ [**GetQuizResults**](GetQuizResults.md)
762
+
763
+ ### Authorization
764
+
765
+ No authorization required
766
+
767
+ ### HTTP request headers
768
+
769
+ - **Content-Type**: Not defined
770
+ - **Accept**: `application/json`
771
+
772
+
773
+ ### HTTP response details
774
+ | Status code | Description | Response headers |
775
+ |-------------|-------------|------------------|
776
+ | **200** | Results retrieved successfully | - |
777
+ | **404** | Attempt not found | - |
778
+ | **403** | Not authorized to view results | - |
779
+ | **409** | Attempt not yet completed | - |
780
+
781
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
782
+
783
+
784
+ ## getQuizAttempts
785
+
786
+ > GetQuizAttemptList getQuizAttempts(quizId, page, pageSize, userId, status)
787
+
788
+ List attempts for this quiz (admin)
789
+
790
+ ### Example
791
+
792
+ ```ts
793
+ import {
794
+ Configuration,
795
+ QuizApi,
796
+ } from '@easyedu/js-lsm-api';
797
+ import type { GetQuizAttemptsRequest } from '@easyedu/js-lsm-api';
798
+
799
+ async function example() {
800
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
801
+ const api = new QuizApi();
802
+
803
+ const body = {
804
+ // string
805
+ quizId: quizId_example,
806
+ // number (optional)
807
+ page: 56,
808
+ // number (optional)
809
+ pageSize: 56,
810
+ // string (optional)
811
+ userId: userId_example,
812
+ // 'in_progress' | 'completed' | 'timed_out' | 'abandoned' (optional)
813
+ status: status_example,
814
+ } satisfies GetQuizAttemptsRequest;
815
+
816
+ try {
817
+ const data = await api.getQuizAttempts(body);
818
+ console.log(data);
819
+ } catch (error) {
820
+ console.error(error);
821
+ }
822
+ }
823
+
824
+ // Run the test
825
+ example().catch(console.error);
826
+ ```
827
+
828
+ ### Parameters
829
+
830
+
831
+ | Name | Type | Description | Notes |
832
+ |------------- | ------------- | ------------- | -------------|
833
+ | **quizId** | `string` | | [Defaults to `undefined`] |
834
+ | **page** | `number` | | [Optional] [Defaults to `1`] |
835
+ | **pageSize** | `number` | | [Optional] [Defaults to `20`] |
836
+ | **userId** | `string` | | [Optional] [Defaults to `undefined`] |
837
+ | **status** | `in_progress`, `completed`, `timed_out`, `abandoned` | | [Optional] [Defaults to `undefined`] [Enum: in_progress, completed, timed_out, abandoned] |
838
+
839
+ ### Return type
840
+
841
+ [**GetQuizAttemptList**](GetQuizAttemptList.md)
842
+
843
+ ### Authorization
844
+
845
+ No authorization required
846
+
847
+ ### HTTP request headers
848
+
849
+ - **Content-Type**: Not defined
850
+ - **Accept**: `application/json`
851
+
852
+
853
+ ### HTTP response details
854
+ | Status code | Description | Response headers |
855
+ |-------------|-------------|------------------|
856
+ | **200** | Quiz attempts retrieved successfully | - |
857
+ | **404** | Quiz not found | - |
858
+
859
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
860
+
861
+
862
+ ## getQuizCriteriaQuestionSelection
863
+
864
+ > GetQuizCriteriaItem getQuizCriteriaQuestionSelection(quizId, criteriaId)
865
+
866
+ Get single question selection criteria
867
+
868
+ ### Example
869
+
870
+ ```ts
871
+ import {
872
+ Configuration,
873
+ QuizApi,
874
+ } from '@easyedu/js-lsm-api';
875
+ import type { GetQuizCriteriaQuestionSelectionRequest } from '@easyedu/js-lsm-api';
876
+
877
+ async function example() {
878
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
879
+ const api = new QuizApi();
880
+
881
+ const body = {
882
+ // string
883
+ quizId: quizId_example,
884
+ // string
885
+ criteriaId: criteriaId_example,
886
+ } satisfies GetQuizCriteriaQuestionSelectionRequest;
887
+
888
+ try {
889
+ const data = await api.getQuizCriteriaQuestionSelection(body);
890
+ console.log(data);
891
+ } catch (error) {
892
+ console.error(error);
893
+ }
894
+ }
895
+
896
+ // Run the test
897
+ example().catch(console.error);
898
+ ```
899
+
900
+ ### Parameters
901
+
902
+
903
+ | Name | Type | Description | Notes |
904
+ |------------- | ------------- | ------------- | -------------|
905
+ | **quizId** | `string` | | [Defaults to `undefined`] |
906
+ | **criteriaId** | `string` | | [Defaults to `undefined`] |
907
+
908
+ ### Return type
909
+
910
+ [**GetQuizCriteriaItem**](GetQuizCriteriaItem.md)
911
+
912
+ ### Authorization
913
+
914
+ No authorization required
915
+
916
+ ### HTTP request headers
917
+
918
+ - **Content-Type**: Not defined
919
+ - **Accept**: `application/json`
920
+
921
+
922
+ ### HTTP response details
923
+ | Status code | Description | Response headers |
924
+ |-------------|-------------|------------------|
925
+ | **200** | Criteria retrieved successfully | - |
926
+ | **404** | Quiz or criteria not found | - |
927
+
928
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
929
+
930
+
931
+ ## getQuizCriteriaQuestionSelectionList
932
+
933
+ > GetQuizCriteriaList getQuizCriteriaQuestionSelectionList(quizId, page, pageSize)
934
+
935
+ Get quiz question selection criteria list
936
+
937
+ ### Example
938
+
939
+ ```ts
940
+ import {
941
+ Configuration,
942
+ QuizApi,
943
+ } from '@easyedu/js-lsm-api';
944
+ import type { GetQuizCriteriaQuestionSelectionListRequest } from '@easyedu/js-lsm-api';
945
+
946
+ async function example() {
947
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
948
+ const api = new QuizApi();
949
+
950
+ const body = {
951
+ // string
952
+ quizId: quizId_example,
953
+ // number (optional)
954
+ page: 56,
955
+ // number (optional)
956
+ pageSize: 56,
957
+ } satisfies GetQuizCriteriaQuestionSelectionListRequest;
958
+
959
+ try {
960
+ const data = await api.getQuizCriteriaQuestionSelectionList(body);
961
+ console.log(data);
962
+ } catch (error) {
963
+ console.error(error);
964
+ }
965
+ }
966
+
967
+ // Run the test
968
+ example().catch(console.error);
969
+ ```
970
+
971
+ ### Parameters
972
+
973
+
974
+ | Name | Type | Description | Notes |
975
+ |------------- | ------------- | ------------- | -------------|
976
+ | **quizId** | `string` | | [Defaults to `undefined`] |
977
+ | **page** | `number` | | [Optional] [Defaults to `1`] |
978
+ | **pageSize** | `number` | | [Optional] [Defaults to `20`] |
979
+
980
+ ### Return type
981
+
982
+ [**GetQuizCriteriaList**](GetQuizCriteriaList.md)
983
+
984
+ ### Authorization
985
+
986
+ No authorization required
987
+
988
+ ### HTTP request headers
989
+
990
+ - **Content-Type**: Not defined
991
+ - **Accept**: `application/json`
992
+
993
+
994
+ ### HTTP response details
995
+ | Status code | Description | Response headers |
996
+ |-------------|-------------|------------------|
997
+ | **200** | Criteria retrieved successfully | - |
998
+ | **404** | Quiz not found | - |
999
+
1000
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1001
+
1002
+
1003
+ ## getQuizList
1004
+
1005
+ > GetQuizList getQuizList(page, pageSize, courseId, quizType, search)
1006
+
1007
+ List quiz configurations
1008
+
1009
+ ### Example
1010
+
1011
+ ```ts
1012
+ import {
1013
+ Configuration,
1014
+ QuizApi,
1015
+ } from '@easyedu/js-lsm-api';
1016
+ import type { GetQuizListRequest } from '@easyedu/js-lsm-api';
1017
+
1018
+ async function example() {
1019
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1020
+ const api = new QuizApi();
1021
+
1022
+ const body = {
1023
+ // number (optional)
1024
+ page: 56,
1025
+ // number (optional)
1026
+ pageSize: 56,
1027
+ // string (optional)
1028
+ courseId: courseId_example,
1029
+ // 'fixed_quiz' | 'randomized_test' (optional)
1030
+ quizType: quizType_example,
1031
+ // string (optional)
1032
+ search: search_example,
1033
+ } satisfies GetQuizListRequest;
1034
+
1035
+ try {
1036
+ const data = await api.getQuizList(body);
1037
+ console.log(data);
1038
+ } catch (error) {
1039
+ console.error(error);
1040
+ }
1041
+ }
1042
+
1043
+ // Run the test
1044
+ example().catch(console.error);
1045
+ ```
1046
+
1047
+ ### Parameters
1048
+
1049
+
1050
+ | Name | Type | Description | Notes |
1051
+ |------------- | ------------- | ------------- | -------------|
1052
+ | **page** | `number` | | [Optional] [Defaults to `1`] |
1053
+ | **pageSize** | `number` | | [Optional] [Defaults to `20`] |
1054
+ | **courseId** | `string` | | [Optional] [Defaults to `undefined`] |
1055
+ | **quizType** | `fixed_quiz`, `randomized_test` | | [Optional] [Defaults to `undefined`] [Enum: fixed_quiz, randomized_test] |
1056
+ | **search** | `string` | | [Optional] [Defaults to `undefined`] |
1057
+
1058
+ ### Return type
1059
+
1060
+ [**GetQuizList**](GetQuizList.md)
1061
+
1062
+ ### Authorization
1063
+
1064
+ No authorization required
1065
+
1066
+ ### HTTP request headers
1067
+
1068
+ - **Content-Type**: Not defined
1069
+ - **Accept**: `application/json`
1070
+
1071
+
1072
+ ### HTTP response details
1073
+ | Status code | Description | Response headers |
1074
+ |-------------|-------------|------------------|
1075
+ | **200** | Quiz list retrieved successfully | - |
1076
+
1077
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1078
+
1079
+
1080
+ ## getQuizManualQuestionSelection
1081
+
1082
+ > GetManualQuestionSelectionItem getQuizManualQuestionSelection(quizId, questionId)
1083
+
1084
+ Get single manually selected question
1085
+
1086
+ ### Example
1087
+
1088
+ ```ts
1089
+ import {
1090
+ Configuration,
1091
+ QuizApi,
1092
+ } from '@easyedu/js-lsm-api';
1093
+ import type { GetQuizManualQuestionSelectionRequest } from '@easyedu/js-lsm-api';
1094
+
1095
+ async function example() {
1096
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1097
+ const api = new QuizApi();
1098
+
1099
+ const body = {
1100
+ // string
1101
+ quizId: quizId_example,
1102
+ // string
1103
+ questionId: questionId_example,
1104
+ } satisfies GetQuizManualQuestionSelectionRequest;
1105
+
1106
+ try {
1107
+ const data = await api.getQuizManualQuestionSelection(body);
1108
+ console.log(data);
1109
+ } catch (error) {
1110
+ console.error(error);
1111
+ }
1112
+ }
1113
+
1114
+ // Run the test
1115
+ example().catch(console.error);
1116
+ ```
1117
+
1118
+ ### Parameters
1119
+
1120
+
1121
+ | Name | Type | Description | Notes |
1122
+ |------------- | ------------- | ------------- | -------------|
1123
+ | **quizId** | `string` | | [Defaults to `undefined`] |
1124
+ | **questionId** | `string` | | [Defaults to `undefined`] |
1125
+
1126
+ ### Return type
1127
+
1128
+ [**GetManualQuestionSelectionItem**](GetManualQuestionSelectionItem.md)
1129
+
1130
+ ### Authorization
1131
+
1132
+ No authorization required
1133
+
1134
+ ### HTTP request headers
1135
+
1136
+ - **Content-Type**: Not defined
1137
+ - **Accept**: `application/json`
1138
+
1139
+
1140
+ ### HTTP response details
1141
+ | Status code | Description | Response headers |
1142
+ |-------------|-------------|------------------|
1143
+ | **200** | Question retrieved successfully | - |
1144
+ | **404** | Quiz or question not found | - |
1145
+
1146
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1147
+
1148
+
1149
+ ## getQuizManualQuestionSelectionList
1150
+
1151
+ > GetManualQuestionSelectionList getQuizManualQuestionSelectionList(quizId, page, pageSize)
1152
+
1153
+ Get manually selected questions for quiz
1154
+
1155
+ ### Example
1156
+
1157
+ ```ts
1158
+ import {
1159
+ Configuration,
1160
+ QuizApi,
1161
+ } from '@easyedu/js-lsm-api';
1162
+ import type { GetQuizManualQuestionSelectionListRequest } from '@easyedu/js-lsm-api';
1163
+
1164
+ async function example() {
1165
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1166
+ const api = new QuizApi();
1167
+
1168
+ const body = {
1169
+ // string
1170
+ quizId: quizId_example,
1171
+ // number (optional)
1172
+ page: 56,
1173
+ // number (optional)
1174
+ pageSize: 56,
1175
+ } satisfies GetQuizManualQuestionSelectionListRequest;
1176
+
1177
+ try {
1178
+ const data = await api.getQuizManualQuestionSelectionList(body);
1179
+ console.log(data);
1180
+ } catch (error) {
1181
+ console.error(error);
1182
+ }
1183
+ }
1184
+
1185
+ // Run the test
1186
+ example().catch(console.error);
1187
+ ```
1188
+
1189
+ ### Parameters
1190
+
1191
+
1192
+ | Name | Type | Description | Notes |
1193
+ |------------- | ------------- | ------------- | -------------|
1194
+ | **quizId** | `string` | | [Defaults to `undefined`] |
1195
+ | **page** | `number` | | [Optional] [Defaults to `1`] |
1196
+ | **pageSize** | `number` | | [Optional] [Defaults to `20`] |
1197
+
1198
+ ### Return type
1199
+
1200
+ [**GetManualQuestionSelectionList**](GetManualQuestionSelectionList.md)
1201
+
1202
+ ### Authorization
1203
+
1204
+ No authorization required
1205
+
1206
+ ### HTTP request headers
1207
+
1208
+ - **Content-Type**: Not defined
1209
+ - **Accept**: `application/json`
1210
+
1211
+
1212
+ ### HTTP response details
1213
+ | Status code | Description | Response headers |
1214
+ |-------------|-------------|------------------|
1215
+ | **200** | Questions retrieved successfully | - |
1216
+ | **404** | Quiz not found | - |
1217
+
1218
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1219
+
1220
+
1221
+ ## getQuizQuestions
1222
+
1223
+ > GetQuizQuestions getQuizQuestions(quizId, page, pageSize)
1224
+
1225
+ Get quiz questions (paginated)
1226
+
1227
+ ### Example
1228
+
1229
+ ```ts
1230
+ import {
1231
+ Configuration,
1232
+ QuizApi,
1233
+ } from '@easyedu/js-lsm-api';
1234
+ import type { GetQuizQuestionsRequest } from '@easyedu/js-lsm-api';
1235
+
1236
+ async function example() {
1237
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1238
+ const api = new QuizApi();
1239
+
1240
+ const body = {
1241
+ // string
1242
+ quizId: quizId_example,
1243
+ // number | Page number for pagination (optional)
1244
+ page: 56,
1245
+ // number | Number of items per page (optional)
1246
+ pageSize: 56,
1247
+ } satisfies GetQuizQuestionsRequest;
1248
+
1249
+ try {
1250
+ const data = await api.getQuizQuestions(body);
1251
+ console.log(data);
1252
+ } catch (error) {
1253
+ console.error(error);
1254
+ }
1255
+ }
1256
+
1257
+ // Run the test
1258
+ example().catch(console.error);
1259
+ ```
1260
+
1261
+ ### Parameters
1262
+
1263
+
1264
+ | Name | Type | Description | Notes |
1265
+ |------------- | ------------- | ------------- | -------------|
1266
+ | **quizId** | `string` | | [Defaults to `undefined`] |
1267
+ | **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
1268
+ | **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
1269
+
1270
+ ### Return type
1271
+
1272
+ [**GetQuizQuestions**](GetQuizQuestions.md)
1273
+
1274
+ ### Authorization
1275
+
1276
+ No authorization required
1277
+
1278
+ ### HTTP request headers
1279
+
1280
+ - **Content-Type**: Not defined
1281
+ - **Accept**: `application/json`
1282
+
1283
+
1284
+ ### HTTP response details
1285
+ | Status code | Description | Response headers |
1286
+ |-------------|-------------|------------------|
1287
+ | **200** | Quiz questions retrieved successfully | - |
1288
+ | **404** | Quiz not found | - |
1289
+
1290
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1291
+
1292
+
1293
+ ## getUserQuizAttempts
1294
+
1295
+ > GetUserQuizAttempts getUserQuizAttempts(userId, page, pageSize, courseId, status)
1296
+
1297
+ Get user\'s quiz attempts across all quizzes
1298
+
1299
+ ### Example
1300
+
1301
+ ```ts
1302
+ import {
1303
+ Configuration,
1304
+ QuizApi,
1305
+ } from '@easyedu/js-lsm-api';
1306
+ import type { GetUserQuizAttemptsRequest } from '@easyedu/js-lsm-api';
1307
+
1308
+ async function example() {
1309
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1310
+ const api = new QuizApi();
1311
+
1312
+ const body = {
1313
+ // string
1314
+ userId: userId_example,
1315
+ // number (optional)
1316
+ page: 56,
1317
+ // number (optional)
1318
+ pageSize: 56,
1319
+ // string (optional)
1320
+ courseId: courseId_example,
1321
+ // 'in_progress' | 'completed' | 'timed_out' | 'abandoned' (optional)
1322
+ status: status_example,
1323
+ } satisfies GetUserQuizAttemptsRequest;
1324
+
1325
+ try {
1326
+ const data = await api.getUserQuizAttempts(body);
1327
+ console.log(data);
1328
+ } catch (error) {
1329
+ console.error(error);
1330
+ }
1331
+ }
1332
+
1333
+ // Run the test
1334
+ example().catch(console.error);
1335
+ ```
1336
+
1337
+ ### Parameters
1338
+
1339
+
1340
+ | Name | Type | Description | Notes |
1341
+ |------------- | ------------- | ------------- | -------------|
1342
+ | **userId** | `string` | | [Defaults to `undefined`] |
1343
+ | **page** | `number` | | [Optional] [Defaults to `1`] |
1344
+ | **pageSize** | `number` | | [Optional] [Defaults to `20`] |
1345
+ | **courseId** | `string` | | [Optional] [Defaults to `undefined`] |
1346
+ | **status** | `in_progress`, `completed`, `timed_out`, `abandoned` | | [Optional] [Defaults to `undefined`] [Enum: in_progress, completed, timed_out, abandoned] |
1347
+
1348
+ ### Return type
1349
+
1350
+ [**GetUserQuizAttempts**](GetUserQuizAttempts.md)
1351
+
1352
+ ### Authorization
1353
+
1354
+ No authorization required
1355
+
1356
+ ### HTTP request headers
1357
+
1358
+ - **Content-Type**: Not defined
1359
+ - **Accept**: `application/json`
1360
+
1361
+
1362
+ ### HTTP response details
1363
+ | Status code | Description | Response headers |
1364
+ |-------------|-------------|------------------|
1365
+ | **200** | User quiz attempts retrieved successfully | - |
1366
+ | **404** | User not found | - |
1367
+ | **403** | Not authorized to view user attempts | - |
1368
+
1369
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1370
+
1371
+
1372
+ ## removeQuizQuestion
1373
+
1374
+ > removeQuizQuestion(quizId, questionId)
1375
+
1376
+ Remove question from quiz
1377
+
1378
+ ### Example
1379
+
1380
+ ```ts
1381
+ import {
1382
+ Configuration,
1383
+ QuizApi,
1384
+ } from '@easyedu/js-lsm-api';
1385
+ import type { RemoveQuizQuestionRequest } from '@easyedu/js-lsm-api';
1386
+
1387
+ async function example() {
1388
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1389
+ const api = new QuizApi();
1390
+
1391
+ const body = {
1392
+ // string
1393
+ quizId: quizId_example,
1394
+ // string
1395
+ questionId: questionId_example,
1396
+ } satisfies RemoveQuizQuestionRequest;
1397
+
1398
+ try {
1399
+ const data = await api.removeQuizQuestion(body);
1400
+ console.log(data);
1401
+ } catch (error) {
1402
+ console.error(error);
1403
+ }
1404
+ }
1405
+
1406
+ // Run the test
1407
+ example().catch(console.error);
1408
+ ```
1409
+
1410
+ ### Parameters
1411
+
1412
+
1413
+ | Name | Type | Description | Notes |
1414
+ |------------- | ------------- | ------------- | -------------|
1415
+ | **quizId** | `string` | | [Defaults to `undefined`] |
1416
+ | **questionId** | `string` | | [Defaults to `undefined`] |
1417
+
1418
+ ### Return type
1419
+
1420
+ `void` (Empty response body)
1421
+
1422
+ ### Authorization
1423
+
1424
+ No authorization required
1425
+
1426
+ ### HTTP request headers
1427
+
1428
+ - **Content-Type**: Not defined
1429
+ - **Accept**: Not defined
1430
+
1431
+
1432
+ ### HTTP response details
1433
+ | Status code | Description | Response headers |
1434
+ |-------------|-------------|------------------|
1435
+ | **200** | Question removed successfully | - |
1436
+ | **404** | Quiz or question not found | - |
1437
+
1438
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1439
+
1440
+
1441
+ ## saveQuizAnswer
1442
+
1443
+ > saveQuizAnswer(attemptId, questionId, putQuizAnswer)
1444
+
1445
+ Save answer for a specific question
1446
+
1447
+ ### Example
1448
+
1449
+ ```ts
1450
+ import {
1451
+ Configuration,
1452
+ QuizApi,
1453
+ } from '@easyedu/js-lsm-api';
1454
+ import type { SaveQuizAnswerRequest } from '@easyedu/js-lsm-api';
1455
+
1456
+ async function example() {
1457
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1458
+ const api = new QuizApi();
1459
+
1460
+ const body = {
1461
+ // string
1462
+ attemptId: attemptId_example,
1463
+ // string
1464
+ questionId: questionId_example,
1465
+ // PutQuizAnswer
1466
+ putQuizAnswer: ...,
1467
+ } satisfies SaveQuizAnswerRequest;
1468
+
1469
+ try {
1470
+ const data = await api.saveQuizAnswer(body);
1471
+ console.log(data);
1472
+ } catch (error) {
1473
+ console.error(error);
1474
+ }
1475
+ }
1476
+
1477
+ // Run the test
1478
+ example().catch(console.error);
1479
+ ```
1480
+
1481
+ ### Parameters
1482
+
1483
+
1484
+ | Name | Type | Description | Notes |
1485
+ |------------- | ------------- | ------------- | -------------|
1486
+ | **attemptId** | `string` | | [Defaults to `undefined`] |
1487
+ | **questionId** | `string` | | [Defaults to `undefined`] |
1488
+ | **putQuizAnswer** | [PutQuizAnswer](PutQuizAnswer.md) | | |
1489
+
1490
+ ### Return type
1491
+
1492
+ `void` (Empty response body)
1493
+
1494
+ ### Authorization
1495
+
1496
+ No authorization required
1497
+
1498
+ ### HTTP request headers
1499
+
1500
+ - **Content-Type**: `application/json`
1501
+ - **Accept**: Not defined
1502
+
1503
+
1504
+ ### HTTP response details
1505
+ | Status code | Description | Response headers |
1506
+ |-------------|-------------|------------------|
1507
+ | **200** | Answer saved successfully | - |
1508
+ | **400** | Invalid answer format | - |
1509
+ | **404** | Attempt or question not found | - |
1510
+ | **403** | Not authorized to answer this question | - |
1511
+ | **409** | Attempt is not in progress | - |
1512
+
1513
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1514
+
1515
+
1516
+ ## startQuizAttempt
1517
+
1518
+ > PostQuizAttempt startQuizAttempt(quizId)
1519
+
1520
+ Start a new quiz attempt
1521
+
1522
+ ### Example
1523
+
1524
+ ```ts
1525
+ import {
1526
+ Configuration,
1527
+ QuizApi,
1528
+ } from '@easyedu/js-lsm-api';
1529
+ import type { StartQuizAttemptRequest } from '@easyedu/js-lsm-api';
1530
+
1531
+ async function example() {
1532
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1533
+ const api = new QuizApi();
1534
+
1535
+ const body = {
1536
+ // string
1537
+ quizId: quizId_example,
1538
+ } satisfies StartQuizAttemptRequest;
1539
+
1540
+ try {
1541
+ const data = await api.startQuizAttempt(body);
1542
+ console.log(data);
1543
+ } catch (error) {
1544
+ console.error(error);
1545
+ }
1546
+ }
1547
+
1548
+ // Run the test
1549
+ example().catch(console.error);
1550
+ ```
1551
+
1552
+ ### Parameters
1553
+
1554
+
1555
+ | Name | Type | Description | Notes |
1556
+ |------------- | ------------- | ------------- | -------------|
1557
+ | **quizId** | `string` | | [Defaults to `undefined`] |
1558
+
1559
+ ### Return type
1560
+
1561
+ [**PostQuizAttempt**](PostQuizAttempt.md)
1562
+
1563
+ ### Authorization
1564
+
1565
+ No authorization required
1566
+
1567
+ ### HTTP request headers
1568
+
1569
+ - **Content-Type**: Not defined
1570
+ - **Accept**: `application/json`
1571
+
1572
+
1573
+ ### HTTP response details
1574
+ | Status code | Description | Response headers |
1575
+ |-------------|-------------|------------------|
1576
+ | **201** | Quiz attempt started successfully | - |
1577
+ | **400** | Cannot start attempt (max attempts reached, etc.) | - |
1578
+ | **404** | Quiz not found | - |
1579
+
1580
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1581
+
1582
+
1583
+ ## submitQuizAttempt
1584
+
1585
+ > GetQuizResults submitQuizAttempt(attemptId, postQuizAttemptSubmit)
1586
+
1587
+ Submit quiz attempt for final scoring
1588
+
1589
+ ### Example
1590
+
1591
+ ```ts
1592
+ import {
1593
+ Configuration,
1594
+ QuizApi,
1595
+ } from '@easyedu/js-lsm-api';
1596
+ import type { SubmitQuizAttemptRequest } from '@easyedu/js-lsm-api';
1597
+
1598
+ async function example() {
1599
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1600
+ const api = new QuizApi();
1601
+
1602
+ const body = {
1603
+ // string
1604
+ attemptId: attemptId_example,
1605
+ // PostQuizAttemptSubmit
1606
+ postQuizAttemptSubmit: ...,
1607
+ } satisfies SubmitQuizAttemptRequest;
1608
+
1609
+ try {
1610
+ const data = await api.submitQuizAttempt(body);
1611
+ console.log(data);
1612
+ } catch (error) {
1613
+ console.error(error);
1614
+ }
1615
+ }
1616
+
1617
+ // Run the test
1618
+ example().catch(console.error);
1619
+ ```
1620
+
1621
+ ### Parameters
1622
+
1623
+
1624
+ | Name | Type | Description | Notes |
1625
+ |------------- | ------------- | ------------- | -------------|
1626
+ | **attemptId** | `string` | | [Defaults to `undefined`] |
1627
+ | **postQuizAttemptSubmit** | [PostQuizAttemptSubmit](PostQuizAttemptSubmit.md) | | |
1628
+
1629
+ ### Return type
1630
+
1631
+ [**GetQuizResults**](GetQuizResults.md)
1632
+
1633
+ ### Authorization
1634
+
1635
+ No authorization required
1636
+
1637
+ ### HTTP request headers
1638
+
1639
+ - **Content-Type**: `application/json`
1640
+ - **Accept**: `application/json`
1641
+
1642
+
1643
+ ### HTTP response details
1644
+ | Status code | Description | Response headers |
1645
+ |-------------|-------------|------------------|
1646
+ | **200** | Quiz submitted successfully | - |
1647
+ | **400** | Cannot submit (missing required answers, etc.) | - |
1648
+ | **404** | Attempt not found | - |
1649
+ | **403** | Not authorized to submit this attempt | - |
1650
+ | **409** | Attempt already submitted | - |
1651
+
1652
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1653
+
1654
+
1655
+ ## updateQuiz
1656
+
1657
+ > GetQuiz updateQuiz(quizId, putQuiz)
1658
+
1659
+ Update quiz configuration
1660
+
1661
+ ### Example
1662
+
1663
+ ```ts
1664
+ import {
1665
+ Configuration,
1666
+ QuizApi,
1667
+ } from '@easyedu/js-lsm-api';
1668
+ import type { UpdateQuizRequest } from '@easyedu/js-lsm-api';
1669
+
1670
+ async function example() {
1671
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1672
+ const api = new QuizApi();
1673
+
1674
+ const body = {
1675
+ // string
1676
+ quizId: quizId_example,
1677
+ // PutQuiz
1678
+ putQuiz: ...,
1679
+ } satisfies UpdateQuizRequest;
1680
+
1681
+ try {
1682
+ const data = await api.updateQuiz(body);
1683
+ console.log(data);
1684
+ } catch (error) {
1685
+ console.error(error);
1686
+ }
1687
+ }
1688
+
1689
+ // Run the test
1690
+ example().catch(console.error);
1691
+ ```
1692
+
1693
+ ### Parameters
1694
+
1695
+
1696
+ | Name | Type | Description | Notes |
1697
+ |------------- | ------------- | ------------- | -------------|
1698
+ | **quizId** | `string` | | [Defaults to `undefined`] |
1699
+ | **putQuiz** | [PutQuiz](PutQuiz.md) | | |
1700
+
1701
+ ### Return type
1702
+
1703
+ [**GetQuiz**](GetQuiz.md)
1704
+
1705
+ ### Authorization
1706
+
1707
+ No authorization required
1708
+
1709
+ ### HTTP request headers
1710
+
1711
+ - **Content-Type**: `application/json`
1712
+ - **Accept**: `application/json`
1713
+
1714
+
1715
+ ### HTTP response details
1716
+ | Status code | Description | Response headers |
1717
+ |-------------|-------------|------------------|
1718
+ | **200** | Quiz updated successfully | - |
1719
+ | **400** | Invalid quiz configuration | - |
1720
+ | **404** | Quiz not found | - |
1721
+
1722
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1723
+
1724
+
1725
+ ## updateQuizQuestions
1726
+
1727
+ > GetQuizQuestions updateQuizQuestions(quizId, postQuizQuestions)
1728
+
1729
+ Update quiz question selection
1730
+
1731
+ ### Example
1732
+
1733
+ ```ts
1734
+ import {
1735
+ Configuration,
1736
+ QuizApi,
1737
+ } from '@easyedu/js-lsm-api';
1738
+ import type { UpdateQuizQuestionsRequest } from '@easyedu/js-lsm-api';
1739
+
1740
+ async function example() {
1741
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1742
+ const api = new QuizApi();
1743
+
1744
+ const body = {
1745
+ // string
1746
+ quizId: quizId_example,
1747
+ // PostQuizQuestions
1748
+ postQuizQuestions: ...,
1749
+ } satisfies UpdateQuizQuestionsRequest;
1750
+
1751
+ try {
1752
+ const data = await api.updateQuizQuestions(body);
1753
+ console.log(data);
1754
+ } catch (error) {
1755
+ console.error(error);
1756
+ }
1757
+ }
1758
+
1759
+ // Run the test
1760
+ example().catch(console.error);
1761
+ ```
1762
+
1763
+ ### Parameters
1764
+
1765
+
1766
+ | Name | Type | Description | Notes |
1767
+ |------------- | ------------- | ------------- | -------------|
1768
+ | **quizId** | `string` | | [Defaults to `undefined`] |
1769
+ | **postQuizQuestions** | [PostQuizQuestions](PostQuizQuestions.md) | | |
1770
+
1771
+ ### Return type
1772
+
1773
+ [**GetQuizQuestions**](GetQuizQuestions.md)
1774
+
1775
+ ### Authorization
1776
+
1777
+ No authorization required
1778
+
1779
+ ### HTTP request headers
1780
+
1781
+ - **Content-Type**: `application/json`
1782
+ - **Accept**: `application/json`
1783
+
1784
+
1785
+ ### HTTP response details
1786
+ | Status code | Description | Response headers |
1787
+ |-------------|-------------|------------------|
1788
+ | **200** | Questions updated successfully | - |
1789
+ | **400** | Invalid question selection | - |
1790
+ | **404** | Quiz not found | - |
1791
+
1792
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1793
+