@easyedu/js-lsm-api 1.98.0 → 1.100.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 (110) hide show
  1. package/.openapi-generator/FILES +22 -0
  2. package/README.md +21 -2
  3. package/dist/apis/ContentLibraryQuizApi.d.ts +17 -0
  4. package/dist/apis/ContentLibraryQuizApi.js +45 -0
  5. package/dist/apis/CourseApi.d.ts +60 -0
  6. package/dist/apis/CourseApi.js +167 -0
  7. package/dist/apis/PlayerApi.d.ts +74 -0
  8. package/dist/apis/PlayerApi.js +193 -0
  9. package/dist/esm/apis/ContentLibraryQuizApi.d.ts +17 -0
  10. package/dist/esm/apis/ContentLibraryQuizApi.js +45 -0
  11. package/dist/esm/apis/CourseApi.d.ts +60 -0
  12. package/dist/esm/apis/CourseApi.js +167 -0
  13. package/dist/esm/apis/PlayerApi.d.ts +74 -0
  14. package/dist/esm/apis/PlayerApi.js +193 -0
  15. package/dist/esm/models/GetAttemptAllowance.d.ts +80 -0
  16. package/dist/esm/models/GetAttemptAllowance.js +75 -0
  17. package/dist/esm/models/GetCourseVersionItemSession.d.ts +6 -0
  18. package/dist/esm/models/GetCourseVersionItemSession.js +4 -0
  19. package/dist/esm/models/GetLibraryQuizSession.d.ts +6 -0
  20. package/dist/esm/models/GetLibraryQuizSession.js +4 -0
  21. package/dist/esm/models/GetResourceSession.d.ts +6 -0
  22. package/dist/esm/models/GetResourceSession.js +4 -0
  23. package/dist/esm/models/GetResourceSessionActivity.d.ts +125 -0
  24. package/dist/esm/models/GetResourceSessionActivity.js +97 -0
  25. package/dist/esm/models/GetResourceSessionActivityEvent.d.ts +62 -0
  26. package/dist/esm/models/GetResourceSessionActivityEvent.js +61 -0
  27. package/dist/esm/models/GetResourceSessionActivityEventList.d.ts +33 -0
  28. package/dist/esm/models/GetResourceSessionActivityEventList.js +44 -0
  29. package/dist/esm/models/GetResourceSessionActivityList.d.ts +33 -0
  30. package/dist/esm/models/GetResourceSessionActivityList.js +44 -0
  31. package/dist/esm/models/PostClearSessions.d.ts +32 -0
  32. package/dist/esm/models/PostClearSessions.js +43 -0
  33. package/dist/esm/models/PostClearSessionsResponse.d.ts +44 -0
  34. package/dist/esm/models/PostClearSessionsResponse.js +51 -0
  35. package/dist/esm/models/PostResourceSessionActivityEvent.d.ts +62 -0
  36. package/dist/esm/models/PostResourceSessionActivityEvent.js +66 -0
  37. package/dist/esm/models/PutAttemptAllowance.d.ts +38 -0
  38. package/dist/esm/models/PutAttemptAllowance.js +47 -0
  39. package/dist/esm/models/PutLibraryQuizSessionOverride.d.ts +57 -0
  40. package/dist/esm/models/PutLibraryQuizSessionOverride.js +55 -0
  41. package/dist/esm/models/PutResourceSessionOverride.d.ts +69 -0
  42. package/dist/esm/models/PutResourceSessionOverride.js +66 -0
  43. package/dist/esm/models/index.d.ts +11 -0
  44. package/dist/esm/models/index.js +11 -0
  45. package/dist/models/GetAttemptAllowance.d.ts +80 -0
  46. package/dist/models/GetAttemptAllowance.js +82 -0
  47. package/dist/models/GetCourseVersionItemSession.d.ts +6 -0
  48. package/dist/models/GetCourseVersionItemSession.js +4 -0
  49. package/dist/models/GetLibraryQuizSession.d.ts +6 -0
  50. package/dist/models/GetLibraryQuizSession.js +4 -0
  51. package/dist/models/GetResourceSession.d.ts +6 -0
  52. package/dist/models/GetResourceSession.js +4 -0
  53. package/dist/models/GetResourceSessionActivity.d.ts +125 -0
  54. package/dist/models/GetResourceSessionActivity.js +105 -0
  55. package/dist/models/GetResourceSessionActivityEvent.d.ts +62 -0
  56. package/dist/models/GetResourceSessionActivityEvent.js +68 -0
  57. package/dist/models/GetResourceSessionActivityEventList.d.ts +33 -0
  58. package/dist/models/GetResourceSessionActivityEventList.js +51 -0
  59. package/dist/models/GetResourceSessionActivityList.d.ts +33 -0
  60. package/dist/models/GetResourceSessionActivityList.js +51 -0
  61. package/dist/models/PostClearSessions.d.ts +32 -0
  62. package/dist/models/PostClearSessions.js +50 -0
  63. package/dist/models/PostClearSessionsResponse.d.ts +44 -0
  64. package/dist/models/PostClearSessionsResponse.js +58 -0
  65. package/dist/models/PostResourceSessionActivityEvent.d.ts +62 -0
  66. package/dist/models/PostResourceSessionActivityEvent.js +74 -0
  67. package/dist/models/PutAttemptAllowance.d.ts +38 -0
  68. package/dist/models/PutAttemptAllowance.js +54 -0
  69. package/dist/models/PutLibraryQuizSessionOverride.d.ts +57 -0
  70. package/dist/models/PutLibraryQuizSessionOverride.js +63 -0
  71. package/dist/models/PutResourceSessionOverride.d.ts +69 -0
  72. package/dist/models/PutResourceSessionOverride.js +74 -0
  73. package/dist/models/index.d.ts +11 -0
  74. package/dist/models/index.js +11 -0
  75. package/docs/ContentLibraryQuizApi.md +73 -2
  76. package/docs/CourseApi.md +236 -0
  77. package/docs/GetAttemptAllowance.md +51 -0
  78. package/docs/GetCourseVersionItemSession.md +2 -0
  79. package/docs/GetLibraryQuizSession.md +2 -0
  80. package/docs/GetResourceSession.md +2 -0
  81. package/docs/GetResourceSessionActivity.md +63 -0
  82. package/docs/GetResourceSessionActivityEvent.md +45 -0
  83. package/docs/GetResourceSessionActivityEventList.md +35 -0
  84. package/docs/GetResourceSessionActivityList.md +35 -0
  85. package/docs/PlayerApi.md +302 -6
  86. package/docs/PostClearSessions.md +34 -0
  87. package/docs/PostClearSessionsResponse.md +38 -0
  88. package/docs/PostResourceSessionActivityEvent.md +39 -0
  89. package/docs/PutAttemptAllowance.md +36 -0
  90. package/docs/PutLibraryQuizSessionOverride.md +41 -0
  91. package/docs/PutResourceSessionOverride.md +41 -0
  92. package/package.json +1 -1
  93. package/src/apis/ContentLibraryQuizApi.ts +65 -0
  94. package/src/apis/CourseApi.ts +270 -0
  95. package/src/apis/PlayerApi.ts +282 -0
  96. package/src/models/GetAttemptAllowance.ts +138 -0
  97. package/src/models/GetCourseVersionItemSession.ts +9 -0
  98. package/src/models/GetLibraryQuizSession.ts +9 -0
  99. package/src/models/GetResourceSession.ts +9 -0
  100. package/src/models/GetResourceSessionActivity.ts +199 -0
  101. package/src/models/GetResourceSessionActivityEvent.ts +110 -0
  102. package/src/models/GetResourceSessionActivityEventList.ts +74 -0
  103. package/src/models/GetResourceSessionActivityList.ts +74 -0
  104. package/src/models/PostClearSessions.ts +66 -0
  105. package/src/models/PostClearSessionsResponse.ts +84 -0
  106. package/src/models/PostResourceSessionActivityEvent.ts +104 -0
  107. package/src/models/PutAttemptAllowance.ts +75 -0
  108. package/src/models/PutLibraryQuizSessionOverride.ts +100 -0
  109. package/src/models/PutResourceSessionOverride.ts +113 -0
  110. package/src/models/index.ts +11 -0
@@ -47,6 +47,7 @@ __exportStar(require("./EmailTemplateDefinition"), exports);
47
47
  __exportStar(require("./EmailTemplateScope"), exports);
48
48
  __exportStar(require("./EmailTemplateVariable"), exports);
49
49
  __exportStar(require("./EmailTemplateVersion"), exports);
50
+ __exportStar(require("./GetAttemptAllowance"), exports);
50
51
  __exportStar(require("./GetCertificateAssetUpload"), exports);
51
52
  __exportStar(require("./GetCertificateConfigList"), exports);
52
53
  __exportStar(require("./GetCertificateEventList"), exports);
@@ -107,6 +108,10 @@ __exportStar(require("./GetQuestionQuizzesInner"), exports);
107
108
  __exportStar(require("./GetResource"), exports);
108
109
  __exportStar(require("./GetResourceList"), exports);
109
110
  __exportStar(require("./GetResourceSession"), exports);
111
+ __exportStar(require("./GetResourceSessionActivity"), exports);
112
+ __exportStar(require("./GetResourceSessionActivityEvent"), exports);
113
+ __exportStar(require("./GetResourceSessionActivityEventList"), exports);
114
+ __exportStar(require("./GetResourceSessionActivityList"), exports);
110
115
  __exportStar(require("./GetResourceSessionDiagnostics"), exports);
111
116
  __exportStar(require("./GetResourceSessionDiagnosticsCourseContext"), exports);
112
117
  __exportStar(require("./GetResourceSessionDiagnosticsResource"), exports);
@@ -167,6 +172,8 @@ __exportStar(require("./PostCertificateLifecycleAction"), exports);
167
172
  __exportStar(require("./PostCertificateTemplate"), exports);
168
173
  __exportStar(require("./PostCertificateTemplateClone"), exports);
169
174
  __exportStar(require("./PostCertificateTemplatePreview"), exports);
175
+ __exportStar(require("./PostClearSessions"), exports);
176
+ __exportStar(require("./PostClearSessionsResponse"), exports);
170
177
  __exportStar(require("./PostConversation"), exports);
171
178
  __exportStar(require("./PostConversationResponse"), exports);
172
179
  __exportStar(require("./PostCourse"), exports);
@@ -202,6 +209,7 @@ __exportStar(require("./PostQuestion"), exports);
202
209
  __exportStar(require("./PostQuestionAnswerChoicesInner"), exports);
203
210
  __exportStar(require("./PostResetPassword"), exports);
204
211
  __exportStar(require("./PostResource"), exports);
212
+ __exportStar(require("./PostResourceSessionActivityEvent"), exports);
205
213
  __exportStar(require("./PostResourceVersion"), exports);
206
214
  __exportStar(require("./PostResourceVersionComplete"), exports);
207
215
  __exportStar(require("./PostResourceVersionSession"), exports);
@@ -215,6 +223,7 @@ __exportStar(require("./PostSignupRequest"), exports);
215
223
  __exportStar(require("./PostSignupRequestResponse"), exports);
216
224
  __exportStar(require("./PostSupportTicket"), exports);
217
225
  __exportStar(require("./PostSupportTicketComment"), exports);
226
+ __exportStar(require("./PutAttemptAllowance"), exports);
218
227
  __exportStar(require("./PutBadgeIssuer"), exports);
219
228
  __exportStar(require("./PutCertificateConfig"), exports);
220
229
  __exportStar(require("./PutCertificateTemplate"), exports);
@@ -231,6 +240,7 @@ __exportStar(require("./PutLibraryQuizCriteria"), exports);
231
240
  __exportStar(require("./PutLibraryQuizQuestions"), exports);
232
241
  __exportStar(require("./PutLibraryQuizSessionAnswer"), exports);
233
242
  __exportStar(require("./PutLibraryQuizSessionGrade"), exports);
243
+ __exportStar(require("./PutLibraryQuizSessionOverride"), exports);
234
244
  __exportStar(require("./PutLibraryQuizVersion"), exports);
235
245
  __exportStar(require("./PutPortalBranding"), exports);
236
246
  __exportStar(require("./PutPortalSublicense"), exports);
@@ -238,6 +248,7 @@ __exportStar(require("./PutPortalUserFieldValues"), exports);
238
248
  __exportStar(require("./PutQuestion"), exports);
239
249
  __exportStar(require("./PutQuestionAnswerChoicesInner"), exports);
240
250
  __exportStar(require("./PutResource"), exports);
251
+ __exportStar(require("./PutResourceSessionOverride"), exports);
241
252
  __exportStar(require("./PutResourceVersion"), exports);
242
253
  __exportStar(require("./PutRole"), exports);
243
254
  __exportStar(require("./PutRolePermissions"), exports);
@@ -29,6 +29,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
29
29
  | [**putLibraryQuizQuestions**](ContentLibraryQuizApi.md#putlibraryquizquestions) | **PUT** /content-library/quizzes/{quizId}/versions/{versionId}/questions | Replace manual questions on a draft quiz version |
30
30
  | [**putLibraryQuizSessionAnswer**](ContentLibraryQuizApi.md#putlibraryquizsessionanswer) | **PUT** /quiz/sessions/{sessionId}/answers/{sessionQuestionId} | Save an answer using version-snapshot identifiers |
31
31
  | [**putLibraryQuizSessionGrade**](ContentLibraryQuizApi.md#putlibraryquizsessiongrade) | **PUT** /quiz/sessions/{sessionId}/answers/{sessionQuestionId}/grade | Manually grade a reusable quiz session answer |
32
+ | [**putLibraryQuizSessionOverride**](ContentLibraryQuizApi.md#putlibraryquizsessionoverride) | **PUT** /quiz/sessions/{sessionId}/override | Override a learner\'s live quiz-session progress |
32
33
  | [**putLibraryQuizVersion**](ContentLibraryQuizApi.md#putlibraryquizversion) | **PUT** /content-library/quizzes/{quizId}/versions/{versionId} | Edit a draft reusable quiz version |
33
34
 
34
35
 
@@ -537,7 +538,7 @@ async function example() {
537
538
  const api = new ContentLibraryQuizApi();
538
539
 
539
540
  const body = {
540
- // string | Internal user ID, or `current` for the authenticated user. (optional)
541
+ // string | External user ID, legacy internal user ID, or `current` for the authenticated user. (optional)
541
542
  userId: userId_example,
542
543
  // string (optional)
543
544
  quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
@@ -576,7 +577,7 @@ example().catch(console.error);
576
577
 
577
578
  | Name | Type | Description | Notes |
578
579
  |------------- | ------------- | ------------- | -------------|
579
- | **userId** | `string` | Internal user ID, or `current` for the authenticated user. | [Optional] [Defaults to `undefined`] |
580
+ | **userId** | `string` | External user ID, legacy internal user ID, or `current` for the authenticated user. | [Optional] [Defaults to `undefined`] |
580
581
  | **quizId** | `string` | | [Optional] [Defaults to `undefined`] |
581
582
  | **quizVersionId** | `string` | | [Optional] [Defaults to `undefined`] |
582
583
  | **courseId** | `string` | | [Optional] [Defaults to `undefined`] |
@@ -1780,6 +1781,76 @@ No authorization required
1780
1781
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1781
1782
 
1782
1783
 
1784
+ ## putLibraryQuizSessionOverride
1785
+
1786
+ > GetLibraryQuizSession putLibraryQuizSessionOverride(sessionId, putLibraryQuizSessionOverride)
1787
+
1788
+ Override a learner\'s live quiz-session progress
1789
+
1790
+ ### Example
1791
+
1792
+ ```ts
1793
+ import {
1794
+ Configuration,
1795
+ ContentLibraryQuizApi,
1796
+ } from '@easyedu/js-lsm-api';
1797
+ import type { PutLibraryQuizSessionOverrideRequest } from '@easyedu/js-lsm-api';
1798
+
1799
+ async function example() {
1800
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1801
+ const api = new ContentLibraryQuizApi();
1802
+
1803
+ const body = {
1804
+ // string
1805
+ sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1806
+ // PutLibraryQuizSessionOverride
1807
+ putLibraryQuizSessionOverride: ...,
1808
+ } satisfies PutLibraryQuizSessionOverrideRequest;
1809
+
1810
+ try {
1811
+ const data = await api.putLibraryQuizSessionOverride(body);
1812
+ console.log(data);
1813
+ } catch (error) {
1814
+ console.error(error);
1815
+ }
1816
+ }
1817
+
1818
+ // Run the test
1819
+ example().catch(console.error);
1820
+ ```
1821
+
1822
+ ### Parameters
1823
+
1824
+
1825
+ | Name | Type | Description | Notes |
1826
+ |------------- | ------------- | ------------- | -------------|
1827
+ | **sessionId** | `string` | | [Defaults to `undefined`] |
1828
+ | **putLibraryQuizSessionOverride** | [PutLibraryQuizSessionOverride](PutLibraryQuizSessionOverride.md) | | |
1829
+
1830
+ ### Return type
1831
+
1832
+ [**GetLibraryQuizSession**](GetLibraryQuizSession.md)
1833
+
1834
+ ### Authorization
1835
+
1836
+ No authorization required
1837
+
1838
+ ### HTTP request headers
1839
+
1840
+ - **Content-Type**: `application/json`
1841
+ - **Accept**: `application/json`
1842
+
1843
+
1844
+ ### HTTP response details
1845
+ | Status code | Description | Response headers |
1846
+ |-------------|-------------|------------------|
1847
+ | **200** | Updated quiz session | - |
1848
+ | **400** | Invalid override values | - |
1849
+ | **404** | Quiz session not found | - |
1850
+
1851
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1852
+
1853
+
1783
1854
  ## putLibraryQuizVersion
1784
1855
 
1785
1856
  > GetLibraryQuizVersion putLibraryQuizVersion(quizId, versionId, putLibraryQuizVersion)
package/docs/CourseApi.md CHANGED
@@ -17,6 +17,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
17
17
  | [**getCourseEnrollments**](CourseApi.md#getcourseenrollments) | **GET** /courses/{courseId}/enrollments | Get course enrollments |
18
18
  | [**getCourseExport**](CourseApi.md#getcourseexport) | **GET** /courses/{courseId}/exports/{exportId} | Get details of a specific SCORM export |
19
19
  | [**getCourseExports**](CourseApi.md#getcourseexports) | **GET** /courses/{courseId}/exports | List all SCORM exports for a course |
20
+ | [**getCourseItemLearnerAttemptAllowance**](CourseApi.md#getcourseitemlearnerattemptallowance) | **GET** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance | Get a learner\'s effective attempt limit for a course item |
20
21
  | [**getCourseList**](CourseApi.md#getcourselist) | **GET** /courses | get course list |
21
22
  | [**getCourseVersion**](CourseApi.md#getcourseversion) | **GET** /courses/{courseId}/versions/{courseVersionId} | Get one immutable course version or preview the owned draft |
22
23
  | [**getCourseVersionItemLaunch**](CourseApi.md#getcourseversionitemlaunch) | **GET** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/launch | Resolve the exact immutable resource launch selected by a course version |
@@ -28,6 +29,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
28
29
  | [**postCourseEnrollment**](CourseApi.md#postcourseenrollment) | **POST** /courses/{courseId}/enrollments | Create a new course enrollment |
29
30
  | [**postCourseExport**](CourseApi.md#postcourseexport) | **POST** /courses/{courseId}/exports | Create a new SCORM export for a course |
30
31
  | [**postCourseImageUpload**](CourseApi.md#postcourseimageupload) | **POST** /courses/{courseId}/image | Upload a course image |
32
+ | [**postCourseItemLearnerSessionsClear**](CourseApi.md#postcourseitemlearnersessionsclear) | **POST** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/sessions/clear | Clear all live sessions for a learner and course item |
31
33
  | [**postCourseResume**](CourseApi.md#postcourseresume) | **POST** /courses/{courseId}/resume | Resume the current learner\'s progress in a course |
32
34
  | [**postCourseVersionItem**](CourseApi.md#postcourseversionitem) | **POST** /courses/{courseId}/draft/sections/{sectionId}/items | Add a pinned library resource or reusable quiz to a draft section |
33
35
  | [**postCourseVersionItemSession**](CourseApi.md#postcourseversionitemsession) | **POST** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/sessions | Start or resume a version-pinned resource attempt |
@@ -36,6 +38,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
36
38
  | [**postCourseVersionSectionDuplicate**](CourseApi.md#postcourseversionsectionduplicate) | **POST** /courses/{courseId}/draft/sections/{sectionId}/duplicate | Recursively duplicate a draft section and reuse its pinned library items |
37
39
  | [**putCourse**](CourseApi.md#putcourse) | **PUT** /courses/{courseId} | Update a course by id |
38
40
  | [**putCourseEnrollment**](CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment |
41
+ | [**putCourseItemLearnerAttemptAllowance**](CourseApi.md#putcourseitemlearnerattemptallowance) | **PUT** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance | Set extra attempts for a learner on a course item |
39
42
  | [**putCourseVersionItem**](CourseApi.md#putcourseversionitem) | **PUT** /courses/{courseId}/draft/sections/{sectionId}/items/{itemId} | Update a draft placement; use the outline move endpoint to change its parent or position |
40
43
  | [**putCourseVersionOutlineEntryMove**](CourseApi.md#putcourseversionoutlineentrymove) | **PUT** /courses/{courseId}/draft/outline/move | Move a section or item to a new parent and sibling position |
41
44
  | [**putCourseVersionSection**](CourseApi.md#putcourseversionsection) | **PUT** /courses/{courseId}/draft/sections/{sectionId} | Update a draft section |
@@ -948,6 +951,81 @@ No authorization required
948
951
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
949
952
 
950
953
 
954
+ ## getCourseItemLearnerAttemptAllowance
955
+
956
+ > GetAttemptAllowance getCourseItemLearnerAttemptAllowance(courseId, courseVersionId, itemId, userId)
957
+
958
+ Get a learner\'s effective attempt limit for a course item
959
+
960
+ ### Example
961
+
962
+ ```ts
963
+ import {
964
+ Configuration,
965
+ CourseApi,
966
+ } from '@easyedu/js-lsm-api';
967
+ import type { GetCourseItemLearnerAttemptAllowanceRequest } from '@easyedu/js-lsm-api';
968
+
969
+ async function example() {
970
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
971
+ const api = new CourseApi();
972
+
973
+ const body = {
974
+ // string
975
+ courseId: courseId_example,
976
+ // string
977
+ courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
978
+ // string
979
+ itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
980
+ // string | External learner ID.
981
+ userId: userId_example,
982
+ } satisfies GetCourseItemLearnerAttemptAllowanceRequest;
983
+
984
+ try {
985
+ const data = await api.getCourseItemLearnerAttemptAllowance(body);
986
+ console.log(data);
987
+ } catch (error) {
988
+ console.error(error);
989
+ }
990
+ }
991
+
992
+ // Run the test
993
+ example().catch(console.error);
994
+ ```
995
+
996
+ ### Parameters
997
+
998
+
999
+ | Name | Type | Description | Notes |
1000
+ |------------- | ------------- | ------------- | -------------|
1001
+ | **courseId** | `string` | | [Defaults to `undefined`] |
1002
+ | **courseVersionId** | `string` | | [Defaults to `undefined`] |
1003
+ | **itemId** | `string` | | [Defaults to `undefined`] |
1004
+ | **userId** | `string` | External learner ID. | [Defaults to `undefined`] |
1005
+
1006
+ ### Return type
1007
+
1008
+ [**GetAttemptAllowance**](GetAttemptAllowance.md)
1009
+
1010
+ ### Authorization
1011
+
1012
+ No authorization required
1013
+
1014
+ ### HTTP request headers
1015
+
1016
+ - **Content-Type**: Not defined
1017
+ - **Accept**: `application/json`
1018
+
1019
+
1020
+ ### HTTP response details
1021
+ | Status code | Description | Response headers |
1022
+ |-------------|-------------|------------------|
1023
+ | **200** | Effective attempt allowance | - |
1024
+ | **404** | Course version item or learner not found | - |
1025
+
1026
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1027
+
1028
+
951
1029
  ## getCourseList
952
1030
 
953
1031
  > GetCourseList getCourseList(page, pageSize, enrolled, search, recentActivitySince)
@@ -1711,6 +1789,85 @@ No authorization required
1711
1789
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1712
1790
 
1713
1791
 
1792
+ ## postCourseItemLearnerSessionsClear
1793
+
1794
+ > PostClearSessionsResponse postCourseItemLearnerSessionsClear(courseId, courseVersionId, itemId, userId, postClearSessions)
1795
+
1796
+ Clear all live sessions for a learner and course item
1797
+
1798
+ ### Example
1799
+
1800
+ ```ts
1801
+ import {
1802
+ Configuration,
1803
+ CourseApi,
1804
+ } from '@easyedu/js-lsm-api';
1805
+ import type { PostCourseItemLearnerSessionsClearRequest } from '@easyedu/js-lsm-api';
1806
+
1807
+ async function example() {
1808
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1809
+ const api = new CourseApi();
1810
+
1811
+ const body = {
1812
+ // string
1813
+ courseId: courseId_example,
1814
+ // string
1815
+ courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1816
+ // string
1817
+ itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1818
+ // string | External learner ID.
1819
+ userId: userId_example,
1820
+ // PostClearSessions
1821
+ postClearSessions: ...,
1822
+ } satisfies PostCourseItemLearnerSessionsClearRequest;
1823
+
1824
+ try {
1825
+ const data = await api.postCourseItemLearnerSessionsClear(body);
1826
+ console.log(data);
1827
+ } catch (error) {
1828
+ console.error(error);
1829
+ }
1830
+ }
1831
+
1832
+ // Run the test
1833
+ example().catch(console.error);
1834
+ ```
1835
+
1836
+ ### Parameters
1837
+
1838
+
1839
+ | Name | Type | Description | Notes |
1840
+ |------------- | ------------- | ------------- | -------------|
1841
+ | **courseId** | `string` | | [Defaults to `undefined`] |
1842
+ | **courseVersionId** | `string` | | [Defaults to `undefined`] |
1843
+ | **itemId** | `string` | | [Defaults to `undefined`] |
1844
+ | **userId** | `string` | External learner ID. | [Defaults to `undefined`] |
1845
+ | **postClearSessions** | [PostClearSessions](PostClearSessions.md) | | |
1846
+
1847
+ ### Return type
1848
+
1849
+ [**PostClearSessionsResponse**](PostClearSessionsResponse.md)
1850
+
1851
+ ### Authorization
1852
+
1853
+ No authorization required
1854
+
1855
+ ### HTTP request headers
1856
+
1857
+ - **Content-Type**: `application/json`
1858
+ - **Accept**: `application/json`
1859
+
1860
+
1861
+ ### HTTP response details
1862
+ | Status code | Description | Response headers |
1863
+ |-------------|-------------|------------------|
1864
+ | **200** | Deleted session counts | - |
1865
+ | **400** | Invalid reason | - |
1866
+ | **404** | Course version item or learner not found | - |
1867
+
1868
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1869
+
1870
+
1714
1871
  ## postCourseResume
1715
1872
 
1716
1873
  > PostCourseResume postCourseResume(courseId)
@@ -2279,6 +2436,85 @@ No authorization required
2279
2436
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2280
2437
 
2281
2438
 
2439
+ ## putCourseItemLearnerAttemptAllowance
2440
+
2441
+ > GetAttemptAllowance putCourseItemLearnerAttemptAllowance(courseId, courseVersionId, itemId, userId, putAttemptAllowance)
2442
+
2443
+ Set extra attempts for a learner on a course item
2444
+
2445
+ ### Example
2446
+
2447
+ ```ts
2448
+ import {
2449
+ Configuration,
2450
+ CourseApi,
2451
+ } from '@easyedu/js-lsm-api';
2452
+ import type { PutCourseItemLearnerAttemptAllowanceRequest } from '@easyedu/js-lsm-api';
2453
+
2454
+ async function example() {
2455
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
2456
+ const api = new CourseApi();
2457
+
2458
+ const body = {
2459
+ // string
2460
+ courseId: courseId_example,
2461
+ // string
2462
+ courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2463
+ // string
2464
+ itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2465
+ // string | External learner ID.
2466
+ userId: userId_example,
2467
+ // PutAttemptAllowance
2468
+ putAttemptAllowance: ...,
2469
+ } satisfies PutCourseItemLearnerAttemptAllowanceRequest;
2470
+
2471
+ try {
2472
+ const data = await api.putCourseItemLearnerAttemptAllowance(body);
2473
+ console.log(data);
2474
+ } catch (error) {
2475
+ console.error(error);
2476
+ }
2477
+ }
2478
+
2479
+ // Run the test
2480
+ example().catch(console.error);
2481
+ ```
2482
+
2483
+ ### Parameters
2484
+
2485
+
2486
+ | Name | Type | Description | Notes |
2487
+ |------------- | ------------- | ------------- | -------------|
2488
+ | **courseId** | `string` | | [Defaults to `undefined`] |
2489
+ | **courseVersionId** | `string` | | [Defaults to `undefined`] |
2490
+ | **itemId** | `string` | | [Defaults to `undefined`] |
2491
+ | **userId** | `string` | External learner ID. | [Defaults to `undefined`] |
2492
+ | **putAttemptAllowance** | [PutAttemptAllowance](PutAttemptAllowance.md) | | |
2493
+
2494
+ ### Return type
2495
+
2496
+ [**GetAttemptAllowance**](GetAttemptAllowance.md)
2497
+
2498
+ ### Authorization
2499
+
2500
+ No authorization required
2501
+
2502
+ ### HTTP request headers
2503
+
2504
+ - **Content-Type**: `application/json`
2505
+ - **Accept**: `application/json`
2506
+
2507
+
2508
+ ### HTTP response details
2509
+ | Status code | Description | Response headers |
2510
+ |-------------|-------------|------------------|
2511
+ | **200** | Updated effective attempt allowance | - |
2512
+ | **400** | Invalid allowance or reason | - |
2513
+ | **404** | Course version item or learner not found | - |
2514
+
2515
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2516
+
2517
+
2282
2518
  ## putCourseVersionItem
2283
2519
 
2284
2520
  > GetCourseVersionItem putCourseVersionItem(courseId, sectionId, itemId, putCourseVersionItem)
@@ -0,0 +1,51 @@
1
+
2
+ # GetAttemptAllowance
3
+
4
+ The effective attempt limit for one learner and course-version item.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `courseId` | string
11
+ `courseVersionId` | string
12
+ `itemId` | string
13
+ `userId` | string
14
+ `baseMaxAttempts` | number
15
+ `additionalAttempts` | number
16
+ `effectiveMaxAttempts` | number
17
+ `attemptsUsed` | number
18
+ `attemptsRemaining` | number
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import type { GetAttemptAllowance } from '@easyedu/js-lsm-api'
24
+
25
+ // TODO: Update the object below with actual values
26
+ const example = {
27
+ "courseId": null,
28
+ "courseVersionId": null,
29
+ "itemId": null,
30
+ "userId": null,
31
+ "baseMaxAttempts": null,
32
+ "additionalAttempts": null,
33
+ "effectiveMaxAttempts": null,
34
+ "attemptsUsed": null,
35
+ "attemptsRemaining": null,
36
+ } satisfies GetAttemptAllowance
37
+
38
+ console.log(example)
39
+
40
+ // Convert the instance to a JSON string
41
+ const exampleJSON: string = JSON.stringify(example)
42
+ console.log(exampleJSON)
43
+
44
+ // Parse the JSON string back to an object
45
+ const exampleParsed = JSON.parse(exampleJSON) as GetAttemptAllowance
46
+ console.log(exampleParsed)
47
+ ```
48
+
49
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
50
+
51
+
@@ -21,6 +21,7 @@ Name | Type
21
21
  `completionStatus` | string
22
22
  `gradeStatus` | string
23
23
  `scoreRaw` | number
24
+ `durationSeconds` | number
24
25
  `createdAt` | number
25
26
  `updatedAt` | number
26
27
  `completedAt` | number
@@ -46,6 +47,7 @@ const example = {
46
47
  "completionStatus": null,
47
48
  "gradeStatus": null,
48
49
  "scoreRaw": null,
50
+ "durationSeconds": null,
49
51
  "createdAt": null,
50
52
  "updatedAt": null,
51
53
  "completedAt": null,
@@ -29,6 +29,7 @@ Name | Type
29
29
  `createdAt` | number
30
30
  `updatedAt` | number
31
31
  `completedAt` | number
32
+ `durationSeconds` | number
32
33
 
33
34
  ## Example
34
35
 
@@ -60,6 +61,7 @@ const example = {
60
61
  "createdAt": null,
61
62
  "updatedAt": null,
62
63
  "completedAt": null,
64
+ "durationSeconds": null,
63
65
  } satisfies GetLibraryQuizSession
64
66
 
65
67
  console.log(example)
@@ -29,6 +29,7 @@ Name | Type
29
29
  `completionStatus` | string
30
30
  `gradeStatus` | string
31
31
  `scoreRaw` | number
32
+ `durationSeconds` | number
32
33
  `initializedAt` | number
33
34
  `terminatedAt` | number
34
35
  `createdAt` | number
@@ -64,6 +65,7 @@ const example = {
64
65
  "completionStatus": null,
65
66
  "gradeStatus": null,
66
67
  "scoreRaw": null,
68
+ "durationSeconds": null,
67
69
  "initializedAt": null,
68
70
  "terminatedAt": null,
69
71
  "createdAt": null,
@@ -0,0 +1,63 @@
1
+
2
+ # GetResourceSessionActivity
3
+
4
+ Per-activity learner state within a resource-session attempt.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `id` | string
11
+ `identifier` | string
12
+ `title` | string
13
+ `activityType` | string
14
+ `completionStatus` | string
15
+ `gradeStatus` | string
16
+ `scoreRaw` | number
17
+ `durationSeconds` | number
18
+ `isActive` | boolean
19
+ `initializedAt` | number
20
+ `terminatedAt` | number
21
+ `completedAt` | number
22
+ `lastSeenAt` | number
23
+ `createdAt` | number
24
+ `updatedAt` | number
25
+
26
+ ## Example
27
+
28
+ ```typescript
29
+ import type { GetResourceSessionActivity } from '@easyedu/js-lsm-api'
30
+
31
+ // TODO: Update the object below with actual values
32
+ const example = {
33
+ "id": null,
34
+ "identifier": null,
35
+ "title": null,
36
+ "activityType": null,
37
+ "completionStatus": null,
38
+ "gradeStatus": null,
39
+ "scoreRaw": null,
40
+ "durationSeconds": null,
41
+ "isActive": null,
42
+ "initializedAt": null,
43
+ "terminatedAt": null,
44
+ "completedAt": null,
45
+ "lastSeenAt": null,
46
+ "createdAt": null,
47
+ "updatedAt": null,
48
+ } satisfies GetResourceSessionActivity
49
+
50
+ console.log(example)
51
+
52
+ // Convert the instance to a JSON string
53
+ const exampleJSON: string = JSON.stringify(example)
54
+ console.log(exampleJSON)
55
+
56
+ // Parse the JSON string back to an object
57
+ const exampleParsed = JSON.parse(exampleJSON) as GetResourceSessionActivity
58
+ console.log(exampleParsed)
59
+ ```
60
+
61
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
62
+
63
+
@@ -0,0 +1,45 @@
1
+
2
+ # GetResourceSessionActivityEvent
3
+
4
+ A recorded learner activity event.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `id` | number
11
+ `eventId` | string
12
+ `activityId` | string
13
+ `eventType` | string
14
+ `positionSeconds` | number
15
+ `createdAt` | number
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import type { GetResourceSessionActivityEvent } from '@easyedu/js-lsm-api'
21
+
22
+ // TODO: Update the object below with actual values
23
+ const example = {
24
+ "id": null,
25
+ "eventId": null,
26
+ "activityId": null,
27
+ "eventType": null,
28
+ "positionSeconds": null,
29
+ "createdAt": null,
30
+ } satisfies GetResourceSessionActivityEvent
31
+
32
+ console.log(example)
33
+
34
+ // Convert the instance to a JSON string
35
+ const exampleJSON: string = JSON.stringify(example)
36
+ console.log(exampleJSON)
37
+
38
+ // Parse the JSON string back to an object
39
+ const exampleParsed = JSON.parse(exampleJSON) as GetResourceSessionActivityEvent
40
+ console.log(exampleParsed)
41
+ ```
42
+
43
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
44
+
45
+
@@ -0,0 +1,35 @@
1
+
2
+ # GetResourceSessionActivityEventList
3
+
4
+ Recorded learner activity events for one resource-session attempt.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `items` | [Array<GetResourceSessionActivityEvent>](GetResourceSessionActivityEvent.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { GetResourceSessionActivityEventList } from '@easyedu/js-lsm-api'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "items": null,
20
+ } satisfies GetResourceSessionActivityEventList
21
+
22
+ console.log(example)
23
+
24
+ // Convert the instance to a JSON string
25
+ const exampleJSON: string = JSON.stringify(example)
26
+ console.log(exampleJSON)
27
+
28
+ // Parse the JSON string back to an object
29
+ const exampleParsed = JSON.parse(exampleJSON) as GetResourceSessionActivityEventList
30
+ console.log(exampleParsed)
31
+ ```
32
+
33
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
34
+
35
+