@easyedu/js-lsm-api 1.32.0 → 1.33.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 (277) hide show
  1. package/.openapi-generator/FILES +14 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +20 -4
  4. package/dist/apis/ContentApi.d.ts +89 -0
  5. package/dist/apis/ContentApi.js +301 -102
  6. package/dist/apis/CourseApi.d.ts +48 -0
  7. package/dist/apis/CourseApi.js +157 -49
  8. package/dist/apis/ModuleApi.d.ts +16 -0
  9. package/dist/apis/ModuleApi.js +52 -16
  10. package/dist/apis/OtherApi.d.ts +4 -0
  11. package/dist/apis/OtherApi.js +13 -4
  12. package/dist/apis/PortalApi.d.ts +30 -3
  13. package/dist/apis/PortalApi.js +92 -32
  14. package/dist/apis/QuestionApi.d.ts +20 -0
  15. package/dist/apis/QuestionApi.js +65 -20
  16. package/dist/apis/QuizApi.d.ts +100 -0
  17. package/dist/apis/QuizApi.js +325 -100
  18. package/dist/apis/ReportingApi.d.ts +36 -0
  19. package/dist/apis/ReportingApi.js +117 -36
  20. package/dist/apis/RoleApi.d.ts +169 -0
  21. package/dist/apis/RoleApi.js +442 -0
  22. package/dist/apis/UserApi.d.ts +28 -0
  23. package/dist/apis/UserApi.js +91 -28
  24. package/dist/apis/index.d.ts +1 -0
  25. package/dist/apis/index.js +1 -0
  26. package/dist/esm/apis/ContentApi.d.ts +89 -0
  27. package/dist/esm/apis/ContentApi.js +301 -102
  28. package/dist/esm/apis/CourseApi.d.ts +48 -0
  29. package/dist/esm/apis/CourseApi.js +157 -49
  30. package/dist/esm/apis/ModuleApi.d.ts +16 -0
  31. package/dist/esm/apis/ModuleApi.js +52 -16
  32. package/dist/esm/apis/OtherApi.d.ts +4 -0
  33. package/dist/esm/apis/OtherApi.js +13 -4
  34. package/dist/esm/apis/PortalApi.d.ts +30 -3
  35. package/dist/esm/apis/PortalApi.js +92 -32
  36. package/dist/esm/apis/QuestionApi.d.ts +20 -0
  37. package/dist/esm/apis/QuestionApi.js +65 -20
  38. package/dist/esm/apis/QuizApi.d.ts +100 -0
  39. package/dist/esm/apis/QuizApi.js +325 -100
  40. package/dist/esm/apis/ReportingApi.d.ts +36 -0
  41. package/dist/esm/apis/ReportingApi.js +117 -36
  42. package/dist/esm/apis/RoleApi.d.ts +169 -0
  43. package/dist/esm/apis/RoleApi.js +438 -0
  44. package/dist/esm/apis/UserApi.d.ts +28 -0
  45. package/dist/esm/apis/UserApi.js +91 -28
  46. package/dist/esm/apis/index.d.ts +1 -0
  47. package/dist/esm/apis/index.js +1 -0
  48. package/dist/esm/models/CriteriaBasedSelection.d.ts +1 -1
  49. package/dist/esm/models/CriteriaBasedSelectionCriteria.d.ts +2 -2
  50. package/dist/esm/models/FillInBlank.d.ts +1 -1
  51. package/dist/esm/models/FillInBlank1.d.ts +1 -1
  52. package/dist/esm/models/GetContent.d.ts +1 -1
  53. package/dist/esm/models/GetContentGradeDetail.d.ts +3 -3
  54. package/dist/esm/models/GetContentGradesItemsInner.d.ts +2 -2
  55. package/dist/esm/models/GetContentInstructorBasicReportingContentInfo.d.ts +1 -1
  56. package/dist/esm/models/GetContentSessionDetail.d.ts +2 -2
  57. package/dist/esm/models/GetCourseEnrollment.d.ts +2 -2
  58. package/dist/esm/models/GetCourseEnrollmentListItem.d.ts +2 -2
  59. package/dist/esm/models/GetCourseExport.d.ts +2 -2
  60. package/dist/esm/models/GetPermission.d.ts +50 -0
  61. package/dist/esm/models/GetPermission.js +53 -0
  62. package/dist/esm/models/GetPortal.d.ts +23 -4
  63. package/dist/esm/models/GetPortal.js +14 -0
  64. package/dist/esm/models/GetPortalUser.d.ts +2 -11
  65. package/dist/esm/models/GetPortalUser.js +0 -8
  66. package/dist/esm/models/GetQuestion.d.ts +2 -2
  67. package/dist/esm/models/GetQuestionListFilters.d.ts +2 -2
  68. package/dist/esm/models/GetQuiz.d.ts +1 -1
  69. package/dist/esm/models/GetQuizAttemptAnalyticsBasicInfo.d.ts +1 -1
  70. package/dist/esm/models/GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner.d.ts +1 -1
  71. package/dist/esm/models/GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner.d.ts +1 -1
  72. package/dist/esm/models/GetQuizAttemptAnalyticsQuestionAnalysisInner.d.ts +2 -2
  73. package/dist/esm/models/GetQuizAttemptAttempt.d.ts +1 -1
  74. package/dist/esm/models/GetQuizAttemptListAllOfAttempts.d.ts +1 -1
  75. package/dist/esm/models/GetQuizAttemptListAllOfFilters.d.ts +1 -1
  76. package/dist/esm/models/GetQuizAttemptQuestionsInner.d.ts +1 -1
  77. package/dist/esm/models/GetQuizCriteriaItem.d.ts +2 -2
  78. package/dist/esm/models/GetQuizCriteriaListItemsInner.d.ts +2 -2
  79. package/dist/esm/models/GetQuizListAllOfFilters.d.ts +1 -1
  80. package/dist/esm/models/GetQuizListAllOfQuizzes.d.ts +1 -1
  81. package/dist/esm/models/GetQuizQuestions.d.ts +1 -1
  82. package/dist/esm/models/GetQuizQuestionsItemsInnerQuestionDetails.d.ts +2 -2
  83. package/dist/esm/models/GetQuizResults.d.ts +1 -1
  84. package/dist/esm/models/GetQuizResultsFeedbackDifficultyPerformanceInner.d.ts +1 -1
  85. package/dist/esm/models/GetQuizResultsQuestionsInner.d.ts +1 -1
  86. package/dist/esm/models/GetRole.d.ts +88 -0
  87. package/dist/esm/models/GetRole.js +80 -0
  88. package/dist/esm/models/GetScormApiLogItem.d.ts +1 -1
  89. package/dist/esm/models/GetUserQuizAttemptsAllOfAttempts.d.ts +1 -1
  90. package/dist/esm/models/GetUserQuizAttemptsAllOfFilters.d.ts +1 -1
  91. package/dist/esm/models/GetUserRole.d.ts +63 -0
  92. package/dist/esm/models/GetUserRole.js +67 -0
  93. package/dist/esm/models/ManualSelection.d.ts +1 -1
  94. package/dist/esm/models/MultipleAnswer.d.ts +1 -1
  95. package/dist/esm/models/MultipleAnswer1.d.ts +1 -1
  96. package/dist/esm/models/NoAnswer.d.ts +1 -1
  97. package/dist/esm/models/PostContentUpload.d.ts +1 -1
  98. package/dist/esm/models/PostCourseExport.d.ts +1 -1
  99. package/dist/esm/models/PostPortalInvite.d.ts +6 -2
  100. package/dist/esm/models/PostPortalInvite.js +5 -1
  101. package/dist/esm/models/PostQuestion.d.ts +2 -2
  102. package/dist/esm/models/PostQuiz.d.ts +1 -1
  103. package/dist/esm/models/PostQuizAttemptAttempt.d.ts +1 -1
  104. package/dist/esm/models/PostQuizAttemptQuestionsInner.d.ts +1 -1
  105. package/dist/esm/models/PostQuizAttemptSubmit.d.ts +1 -1
  106. package/dist/esm/models/PostQuizCriteriaCriteriaInner.d.ts +2 -2
  107. package/dist/esm/models/PostRole.d.ts +57 -0
  108. package/dist/esm/models/PostRole.js +61 -0
  109. package/dist/esm/models/PutCourseEnrollment.d.ts +2 -2
  110. package/dist/esm/models/PutQuestion.d.ts +2 -2
  111. package/dist/esm/models/PutQuiz.d.ts +1 -1
  112. package/dist/esm/models/PutRole.d.ts +38 -0
  113. package/dist/esm/models/PutRole.js +45 -0
  114. package/dist/esm/models/PutRolePermissions.d.ts +32 -0
  115. package/dist/esm/models/PutRolePermissions.js +43 -0
  116. package/dist/esm/models/QuizContent.d.ts +1 -1
  117. package/dist/esm/models/SingleAnswer.d.ts +1 -1
  118. package/dist/esm/models/index.d.ts +6 -0
  119. package/dist/esm/models/index.js +6 -0
  120. package/dist/esm/runtime.js +15 -0
  121. package/dist/models/CriteriaBasedSelection.d.ts +1 -1
  122. package/dist/models/CriteriaBasedSelectionCriteria.d.ts +2 -2
  123. package/dist/models/FillInBlank.d.ts +1 -1
  124. package/dist/models/FillInBlank1.d.ts +1 -1
  125. package/dist/models/GetContent.d.ts +1 -1
  126. package/dist/models/GetContentGradeDetail.d.ts +3 -3
  127. package/dist/models/GetContentGradesItemsInner.d.ts +2 -2
  128. package/dist/models/GetContentInstructorBasicReportingContentInfo.d.ts +1 -1
  129. package/dist/models/GetContentSessionDetail.d.ts +2 -2
  130. package/dist/models/GetCourseEnrollment.d.ts +2 -2
  131. package/dist/models/GetCourseEnrollmentListItem.d.ts +2 -2
  132. package/dist/models/GetCourseExport.d.ts +2 -2
  133. package/dist/models/GetPermission.d.ts +50 -0
  134. package/dist/models/GetPermission.js +60 -0
  135. package/dist/models/GetPortal.d.ts +23 -4
  136. package/dist/models/GetPortal.js +15 -1
  137. package/dist/models/GetPortalUser.d.ts +2 -11
  138. package/dist/models/GetPortalUser.js +0 -9
  139. package/dist/models/GetQuestion.d.ts +2 -2
  140. package/dist/models/GetQuestionListFilters.d.ts +2 -2
  141. package/dist/models/GetQuiz.d.ts +1 -1
  142. package/dist/models/GetQuizAttemptAnalyticsBasicInfo.d.ts +1 -1
  143. package/dist/models/GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner.d.ts +1 -1
  144. package/dist/models/GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner.d.ts +1 -1
  145. package/dist/models/GetQuizAttemptAnalyticsQuestionAnalysisInner.d.ts +2 -2
  146. package/dist/models/GetQuizAttemptAttempt.d.ts +1 -1
  147. package/dist/models/GetQuizAttemptListAllOfAttempts.d.ts +1 -1
  148. package/dist/models/GetQuizAttemptListAllOfFilters.d.ts +1 -1
  149. package/dist/models/GetQuizAttemptQuestionsInner.d.ts +1 -1
  150. package/dist/models/GetQuizCriteriaItem.d.ts +2 -2
  151. package/dist/models/GetQuizCriteriaListItemsInner.d.ts +2 -2
  152. package/dist/models/GetQuizListAllOfFilters.d.ts +1 -1
  153. package/dist/models/GetQuizListAllOfQuizzes.d.ts +1 -1
  154. package/dist/models/GetQuizQuestions.d.ts +1 -1
  155. package/dist/models/GetQuizQuestionsItemsInnerQuestionDetails.d.ts +2 -2
  156. package/dist/models/GetQuizResults.d.ts +1 -1
  157. package/dist/models/GetQuizResultsFeedbackDifficultyPerformanceInner.d.ts +1 -1
  158. package/dist/models/GetQuizResultsQuestionsInner.d.ts +1 -1
  159. package/dist/models/GetRole.d.ts +88 -0
  160. package/dist/models/GetRole.js +88 -0
  161. package/dist/models/GetScormApiLogItem.d.ts +1 -1
  162. package/dist/models/GetUserQuizAttemptsAllOfAttempts.d.ts +1 -1
  163. package/dist/models/GetUserQuizAttemptsAllOfFilters.d.ts +1 -1
  164. package/dist/models/GetUserRole.d.ts +63 -0
  165. package/dist/models/GetUserRole.js +75 -0
  166. package/dist/models/ManualSelection.d.ts +1 -1
  167. package/dist/models/MultipleAnswer.d.ts +1 -1
  168. package/dist/models/MultipleAnswer1.d.ts +1 -1
  169. package/dist/models/NoAnswer.d.ts +1 -1
  170. package/dist/models/PostContentUpload.d.ts +1 -1
  171. package/dist/models/PostCourseExport.d.ts +1 -1
  172. package/dist/models/PostPortalInvite.d.ts +6 -2
  173. package/dist/models/PostPortalInvite.js +5 -1
  174. package/dist/models/PostQuestion.d.ts +2 -2
  175. package/dist/models/PostQuiz.d.ts +1 -1
  176. package/dist/models/PostQuizAttemptAttempt.d.ts +1 -1
  177. package/dist/models/PostQuizAttemptQuestionsInner.d.ts +1 -1
  178. package/dist/models/PostQuizAttemptSubmit.d.ts +1 -1
  179. package/dist/models/PostQuizCriteriaCriteriaInner.d.ts +2 -2
  180. package/dist/models/PostRole.d.ts +57 -0
  181. package/dist/models/PostRole.js +69 -0
  182. package/dist/models/PutCourseEnrollment.d.ts +2 -2
  183. package/dist/models/PutQuestion.d.ts +2 -2
  184. package/dist/models/PutQuiz.d.ts +1 -1
  185. package/dist/models/PutRole.d.ts +38 -0
  186. package/dist/models/PutRole.js +52 -0
  187. package/dist/models/PutRolePermissions.d.ts +32 -0
  188. package/dist/models/PutRolePermissions.js +50 -0
  189. package/dist/models/QuizContent.d.ts +1 -1
  190. package/dist/models/SingleAnswer.d.ts +1 -1
  191. package/dist/models/index.d.ts +6 -0
  192. package/dist/models/index.js +6 -0
  193. package/dist/runtime.js +15 -0
  194. package/docs/GetPermission.md +41 -0
  195. package/docs/GetPortal.md +2 -0
  196. package/docs/GetRole.md +49 -0
  197. package/docs/GetUserRole.md +41 -0
  198. package/docs/PortalApi.md +3 -6
  199. package/docs/PostRole.md +39 -0
  200. package/docs/PutRole.md +37 -0
  201. package/docs/PutRolePermissions.md +35 -0
  202. package/docs/RoleApi.md +685 -0
  203. package/package.json +1 -1
  204. package/src/apis/ContentApi.ts +279 -102
  205. package/src/apis/CourseApi.ts +145 -49
  206. package/src/apis/ModuleApi.ts +48 -16
  207. package/src/apis/OtherApi.ts +12 -4
  208. package/src/apis/PortalApi.ts +85 -34
  209. package/src/apis/QuestionApi.ts +60 -20
  210. package/src/apis/QuizApi.ts +300 -100
  211. package/src/apis/ReportingApi.ts +108 -36
  212. package/src/apis/RoleApi.ts +576 -0
  213. package/src/apis/UserApi.ts +84 -28
  214. package/src/apis/index.ts +1 -0
  215. package/src/models/CriteriaBasedSelection.ts +1 -1
  216. package/src/models/CriteriaBasedSelectionCriteria.ts +2 -2
  217. package/src/models/FillInBlank.ts +1 -1
  218. package/src/models/FillInBlank1.ts +1 -1
  219. package/src/models/GetContent.ts +1 -1
  220. package/src/models/GetContentGradeDetail.ts +3 -3
  221. package/src/models/GetContentGradesItemsInner.ts +2 -2
  222. package/src/models/GetContentInstructorBasicReportingContentInfo.ts +1 -1
  223. package/src/models/GetContentSessionDetail.ts +2 -2
  224. package/src/models/GetCourseEnrollment.ts +2 -2
  225. package/src/models/GetCourseEnrollmentListItem.ts +2 -2
  226. package/src/models/GetCourseExport.ts +2 -2
  227. package/src/models/GetPermission.ts +92 -0
  228. package/src/models/GetPortal.ts +26 -4
  229. package/src/models/GetPortalUser.ts +2 -14
  230. package/src/models/GetQuestion.ts +2 -2
  231. package/src/models/GetQuestionListFilters.ts +2 -2
  232. package/src/models/GetQuiz.ts +1 -1
  233. package/src/models/GetQuizAttemptAnalyticsBasicInfo.ts +1 -1
  234. package/src/models/GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner.ts +1 -1
  235. package/src/models/GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner.ts +1 -1
  236. package/src/models/GetQuizAttemptAnalyticsQuestionAnalysisInner.ts +2 -2
  237. package/src/models/GetQuizAttemptAttempt.ts +1 -1
  238. package/src/models/GetQuizAttemptListAllOfAttempts.ts +1 -1
  239. package/src/models/GetQuizAttemptListAllOfFilters.ts +1 -1
  240. package/src/models/GetQuizAttemptQuestionsInner.ts +1 -1
  241. package/src/models/GetQuizCriteriaItem.ts +2 -2
  242. package/src/models/GetQuizCriteriaListItemsInner.ts +2 -2
  243. package/src/models/GetQuizListAllOfFilters.ts +1 -1
  244. package/src/models/GetQuizListAllOfQuizzes.ts +1 -1
  245. package/src/models/GetQuizQuestions.ts +1 -1
  246. package/src/models/GetQuizQuestionsItemsInnerQuestionDetails.ts +2 -2
  247. package/src/models/GetQuizResults.ts +1 -1
  248. package/src/models/GetQuizResultsFeedbackDifficultyPerformanceInner.ts +1 -1
  249. package/src/models/GetQuizResultsQuestionsInner.ts +1 -1
  250. package/src/models/GetRole.ts +151 -0
  251. package/src/models/GetScormApiLogItem.ts +1 -1
  252. package/src/models/GetUserQuizAttemptsAllOfAttempts.ts +1 -1
  253. package/src/models/GetUserQuizAttemptsAllOfFilters.ts +1 -1
  254. package/src/models/GetUserRole.ts +109 -0
  255. package/src/models/ManualSelection.ts +1 -1
  256. package/src/models/MultipleAnswer.ts +1 -1
  257. package/src/models/MultipleAnswer1.ts +1 -1
  258. package/src/models/NoAnswer.ts +1 -1
  259. package/src/models/PostContentUpload.ts +1 -1
  260. package/src/models/PostCourseExport.ts +1 -1
  261. package/src/models/PostPortalInvite.ts +7 -3
  262. package/src/models/PostQuestion.ts +2 -2
  263. package/src/models/PostQuiz.ts +1 -1
  264. package/src/models/PostQuizAttemptAttempt.ts +1 -1
  265. package/src/models/PostQuizAttemptQuestionsInner.ts +1 -1
  266. package/src/models/PostQuizAttemptSubmit.ts +1 -1
  267. package/src/models/PostQuizCriteriaCriteriaInner.ts +2 -2
  268. package/src/models/PostRole.ts +99 -0
  269. package/src/models/PutCourseEnrollment.ts +2 -2
  270. package/src/models/PutQuestion.ts +2 -2
  271. package/src/models/PutQuiz.ts +1 -1
  272. package/src/models/PutRole.ts +74 -0
  273. package/src/models/PutRolePermissions.ts +66 -0
  274. package/src/models/QuizContent.ts +1 -1
  275. package/src/models/SingleAnswer.ts +1 -1
  276. package/src/models/index.ts +6 -0
  277. package/src/runtime.ts +18 -0
@@ -43,13 +43,13 @@ export interface GetContentSessionDetail {
43
43
  contentId: string;
44
44
  /**
45
45
  * The completion status of the content session
46
- * @type {string}
46
+ * @type {GetContentSessionDetailCompletionStatusEnum}
47
47
  * @memberof GetContentSessionDetail
48
48
  */
49
49
  completionStatus: GetContentSessionDetailCompletionStatusEnum;
50
50
  /**
51
51
  * The grade status of the content session
52
- * @type {string}
52
+ * @type {GetContentSessionDetailGradeStatusEnum}
53
53
  * @memberof GetContentSessionDetail
54
54
  */
55
55
  gradeStatus: GetContentSessionDetailGradeStatusEnum;
@@ -53,13 +53,13 @@ export interface GetCourseEnrollment {
53
53
  notes: string | null;
54
54
  /**
55
55
  * Current status of the enrollment
56
- * @type {string}
56
+ * @type {GetCourseEnrollmentStatusEnum}
57
57
  * @memberof GetCourseEnrollment
58
58
  */
59
59
  status: GetCourseEnrollmentStatusEnum;
60
60
  /**
61
61
  * The role/type of the user in this enrollment
62
- * @type {string}
62
+ * @type {GetCourseEnrollmentUserTypeEnum}
63
63
  * @memberof GetCourseEnrollment
64
64
  */
65
65
  userType: GetCourseEnrollmentUserTypeEnum;
@@ -59,13 +59,13 @@ export interface GetCourseEnrollmentListItem {
59
59
  enrollmentDateEnd: number;
60
60
  /**
61
61
  * Current status of the enrollment
62
- * @type {string}
62
+ * @type {GetCourseEnrollmentListItemStatusEnum}
63
63
  * @memberof GetCourseEnrollmentListItem
64
64
  */
65
65
  status: GetCourseEnrollmentListItemStatusEnum;
66
66
  /**
67
67
  * The role/type of the user in this enrollment
68
- * @type {string}
68
+ * @type {GetCourseEnrollmentListItemUserTypeEnum}
69
69
  * @memberof GetCourseEnrollmentListItem
70
70
  */
71
71
  userType: GetCourseEnrollmentListItemUserTypeEnum;
@@ -29,13 +29,13 @@ export interface GetCourseExport {
29
29
  courseId: string;
30
30
  /**
31
31
  * The SCORM version to export
32
- * @type {string}
32
+ * @type {GetCourseExportScormVersionEnum}
33
33
  * @memberof GetCourseExport
34
34
  */
35
35
  scormVersion: GetCourseExportScormVersionEnum;
36
36
  /**
37
37
  * Current status of the export generation
38
- * @type {string}
38
+ * @type {GetCourseExportStatusEnum}
39
39
  * @memberof GetCourseExport
40
40
  */
41
41
  status: GetCourseExportStatusEnum;
@@ -0,0 +1,50 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * A permission that can be assigned to roles
14
+ * @export
15
+ * @interface GetPermission
16
+ */
17
+ export interface GetPermission {
18
+ /**
19
+ * External UUID of the permission
20
+ * @type {string}
21
+ * @memberof GetPermission
22
+ */
23
+ id: string;
24
+ /**
25
+ * Permission key in domain:action format (e.g. course:create)
26
+ * @type {string}
27
+ * @memberof GetPermission
28
+ */
29
+ key: string;
30
+ /**
31
+ * Human-readable description
32
+ * @type {string}
33
+ * @memberof GetPermission
34
+ */
35
+ description?: string | null;
36
+ /**
37
+ * Grouping domain (e.g. course, module, content)
38
+ * @type {string}
39
+ * @memberof GetPermission
40
+ */
41
+ domain: string;
42
+ }
43
+ /**
44
+ * Check if a given object implements the GetPermission interface.
45
+ */
46
+ export declare function instanceOfGetPermission(value: object): value is GetPermission;
47
+ export declare function GetPermissionFromJSON(json: any): GetPermission;
48
+ export declare function GetPermissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPermission;
49
+ export declare function GetPermissionToJSON(json: any): GetPermission;
50
+ export declare function GetPermissionToJSONTyped(value?: GetPermission | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,60 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfGetPermission = instanceOfGetPermission;
17
+ exports.GetPermissionFromJSON = GetPermissionFromJSON;
18
+ exports.GetPermissionFromJSONTyped = GetPermissionFromJSONTyped;
19
+ exports.GetPermissionToJSON = GetPermissionToJSON;
20
+ exports.GetPermissionToJSONTyped = GetPermissionToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the GetPermission interface.
23
+ */
24
+ function instanceOfGetPermission(value) {
25
+ if (!('id' in value) || value['id'] === undefined)
26
+ return false;
27
+ if (!('key' in value) || value['key'] === undefined)
28
+ return false;
29
+ if (!('domain' in value) || value['domain'] === undefined)
30
+ return false;
31
+ return true;
32
+ }
33
+ function GetPermissionFromJSON(json) {
34
+ return GetPermissionFromJSONTyped(json, false);
35
+ }
36
+ function GetPermissionFromJSONTyped(json, ignoreDiscriminator) {
37
+ if (json == null) {
38
+ return json;
39
+ }
40
+ return {
41
+ 'id': json['id'],
42
+ 'key': json['key'],
43
+ 'description': json['description'] == null ? undefined : json['description'],
44
+ 'domain': json['domain'],
45
+ };
46
+ }
47
+ function GetPermissionToJSON(json) {
48
+ return GetPermissionToJSONTyped(json, false);
49
+ }
50
+ function GetPermissionToJSONTyped(value, ignoreDiscriminator = false) {
51
+ if (value == null) {
52
+ return value;
53
+ }
54
+ return {
55
+ 'id': value['id'],
56
+ 'key': value['key'],
57
+ 'description': value['description'],
58
+ 'domain': value['domain'],
59
+ };
60
+ }
@@ -52,17 +52,23 @@ export interface GetPortal {
52
52
  */
53
53
  headerTextColor: string;
54
54
  /**
55
- *
56
- * @type {string}
55
+ * The user's current active role (mapped from base_type for backwards compatibility)
56
+ * @type {GetPortalSelectedUserRoleEnum}
57
57
  * @memberof GetPortal
58
58
  */
59
59
  selectedUserRole?: GetPortalSelectedUserRoleEnum;
60
60
  /**
61
- *
62
- * @type {string}
61
+ * The user's base role (mapped from base_type for backwards compatibility)
62
+ * @type {GetPortalBaseUserRoleEnum}
63
63
  * @memberof GetPortal
64
64
  */
65
65
  baseUserRole?: GetPortalBaseUserRoleEnum;
66
+ /**
67
+ * The user's highest-privilege role base type for this portal
68
+ * @type {GetPortalBaseTypeEnum}
69
+ * @memberof GetPortal
70
+ */
71
+ baseType?: GetPortalBaseTypeEnum;
66
72
  }
67
73
  /**
68
74
  * @export
@@ -82,6 +88,19 @@ export declare const GetPortalBaseUserRoleEnum: {
82
88
  readonly Learner: "Learner";
83
89
  };
84
90
  export type GetPortalBaseUserRoleEnum = typeof GetPortalBaseUserRoleEnum[keyof typeof GetPortalBaseUserRoleEnum];
91
+ /**
92
+ * @export
93
+ */
94
+ export declare const GetPortalBaseTypeEnum: {
95
+ readonly Owner: "Owner";
96
+ readonly Admin: "Admin";
97
+ readonly Instructor: "Instructor";
98
+ readonly Learner: "Learner";
99
+ readonly ClientSuperAdmin: "ClientSuperAdmin";
100
+ readonly ClientManager: "ClientManager";
101
+ readonly PortalClientAdministrator: "PortalClientAdministrator";
102
+ };
103
+ export type GetPortalBaseTypeEnum = typeof GetPortalBaseTypeEnum[keyof typeof GetPortalBaseTypeEnum];
85
104
  /**
86
105
  * Check if a given object implements the GetPortal interface.
87
106
  */
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.GetPortalBaseUserRoleEnum = exports.GetPortalSelectedUserRoleEnum = void 0;
16
+ exports.GetPortalBaseTypeEnum = exports.GetPortalBaseUserRoleEnum = exports.GetPortalSelectedUserRoleEnum = void 0;
17
17
  exports.instanceOfGetPortal = instanceOfGetPortal;
18
18
  exports.GetPortalFromJSON = GetPortalFromJSON;
19
19
  exports.GetPortalFromJSONTyped = GetPortalFromJSONTyped;
@@ -35,6 +35,18 @@ exports.GetPortalBaseUserRoleEnum = {
35
35
  Instructor: 'Instructor',
36
36
  Learner: 'Learner'
37
37
  };
38
+ /**
39
+ * @export
40
+ */
41
+ exports.GetPortalBaseTypeEnum = {
42
+ Owner: 'Owner',
43
+ Admin: 'Admin',
44
+ Instructor: 'Instructor',
45
+ Learner: 'Learner',
46
+ ClientSuperAdmin: 'ClientSuperAdmin',
47
+ ClientManager: 'ClientManager',
48
+ PortalClientAdministrator: 'PortalClientAdministrator'
49
+ };
38
50
  /**
39
51
  * Check if a given object implements the GetPortal interface.
40
52
  */
@@ -67,6 +79,7 @@ function GetPortalFromJSONTyped(json, ignoreDiscriminator) {
67
79
  'headerTextColor': json['header_text_color'],
68
80
  'selectedUserRole': json['selected_user_role'] == null ? undefined : json['selected_user_role'],
69
81
  'baseUserRole': json['base_user_role'] == null ? undefined : json['base_user_role'],
82
+ 'baseType': json['base_type'] == null ? undefined : json['base_type'],
70
83
  };
71
84
  }
72
85
  function GetPortalToJSON(json) {
@@ -85,5 +98,6 @@ function GetPortalToJSONTyped(value, ignoreDiscriminator = false) {
85
98
  'header_text_color': value['headerTextColor'],
86
99
  'selected_user_role': value['selectedUserRole'],
87
100
  'base_user_role': value['baseUserRole'],
101
+ 'base_type': value['baseType'],
88
102
  };
89
103
  }
@@ -40,11 +40,11 @@ export interface GetPortalUser {
40
40
  */
41
41
  lastName: string;
42
42
  /**
43
- * The user's role in the portal
43
+ * The user's role name in the portal (e.g. Admin, Instructor, Learner, or a custom role name)
44
44
  * @type {string}
45
45
  * @memberof GetPortalUser
46
46
  */
47
- role: GetPortalUserRoleEnum;
47
+ role: string;
48
48
  /**
49
49
  * Whether the user's portal access is active
50
50
  * @type {boolean}
@@ -52,15 +52,6 @@ export interface GetPortalUser {
52
52
  */
53
53
  isActive: boolean;
54
54
  }
55
- /**
56
- * @export
57
- */
58
- export declare const GetPortalUserRoleEnum: {
59
- readonly Admin: "Admin";
60
- readonly Instructor: "Instructor";
61
- readonly Learner: "Learner";
62
- };
63
- export type GetPortalUserRoleEnum = typeof GetPortalUserRoleEnum[keyof typeof GetPortalUserRoleEnum];
64
55
  /**
65
56
  * Check if a given object implements the GetPortalUser interface.
66
57
  */
@@ -13,20 +13,11 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.GetPortalUserRoleEnum = void 0;
17
16
  exports.instanceOfGetPortalUser = instanceOfGetPortalUser;
18
17
  exports.GetPortalUserFromJSON = GetPortalUserFromJSON;
19
18
  exports.GetPortalUserFromJSONTyped = GetPortalUserFromJSONTyped;
20
19
  exports.GetPortalUserToJSON = GetPortalUserToJSON;
21
20
  exports.GetPortalUserToJSONTyped = GetPortalUserToJSONTyped;
22
- /**
23
- * @export
24
- */
25
- exports.GetPortalUserRoleEnum = {
26
- Admin: 'Admin',
27
- Instructor: 'Instructor',
28
- Learner: 'Learner'
29
- };
30
21
  /**
31
22
  * Check if a given object implements the GetPortalUser interface.
32
23
  */
@@ -30,7 +30,7 @@ export interface GetQuestion {
30
30
  questionText: string;
31
31
  /**
32
32
  * Type of question: single answer (True/False, multiple choice), multiple answer, or fill in the blank
33
- * @type {string}
33
+ * @type {GetQuestionQuestionTypeEnum}
34
34
  * @memberof GetQuestion
35
35
  */
36
36
  questionType: GetQuestionQuestionTypeEnum;
@@ -66,7 +66,7 @@ export interface GetQuestion {
66
66
  course?: string;
67
67
  /**
68
68
  * Difficulty level of the question
69
- * @type {string}
69
+ * @type {GetQuestionDifficultyLevelEnum}
70
70
  * @memberof GetQuestion
71
71
  */
72
72
  difficultyLevel: GetQuestionDifficultyLevelEnum;
@@ -29,13 +29,13 @@ export interface GetQuestionListFilters {
29
29
  course?: string;
30
30
  /**
31
31
  * Filter by question type
32
- * @type {string}
32
+ * @type {GetQuestionListFiltersQuestionTypeEnum}
33
33
  * @memberof GetQuestionListFilters
34
34
  */
35
35
  questionType?: GetQuestionListFiltersQuestionTypeEnum;
36
36
  /**
37
37
  * Filter by difficulty level
38
- * @type {string}
38
+ * @type {GetQuestionListFiltersDifficultyLevelEnum}
39
39
  * @memberof GetQuestionListFilters
40
40
  */
41
41
  difficultyLevel?: GetQuestionListFiltersDifficultyLevelEnum;
@@ -36,7 +36,7 @@ export interface GetQuiz {
36
36
  contentId: string;
37
37
  /**
38
38
  * How questions are selected
39
- * @type {string}
39
+ * @type {GetQuizQuestionSelectionMethodEnum}
40
40
  * @memberof GetQuiz
41
41
  */
42
42
  questionSelectionMethod: GetQuizQuestionSelectionMethodEnum;
@@ -41,7 +41,7 @@ export interface GetQuizAttemptAnalyticsBasicInfo {
41
41
  attemptNumber: number;
42
42
  /**
43
43
  * Attempt status
44
- * @type {string}
44
+ * @type {GetQuizAttemptAnalyticsBasicInfoStatusEnum}
45
45
  * @memberof GetQuizAttemptAnalyticsBasicInfo
46
46
  */
47
47
  status: GetQuizAttemptAnalyticsBasicInfoStatusEnum;
@@ -17,7 +17,7 @@
17
17
  export interface GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner {
18
18
  /**
19
19
  * Difficulty level
20
- * @type {string}
20
+ * @type {GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInnerDifficultyLevelEnum}
21
21
  * @memberof GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner
22
22
  */
23
23
  difficultyLevel: GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInnerDifficultyLevelEnum;
@@ -17,7 +17,7 @@
17
17
  export interface GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner {
18
18
  /**
19
19
  * Question type
20
- * @type {string}
20
+ * @type {GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInnerQuestionTypeEnum}
21
21
  * @memberof GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner
22
22
  */
23
23
  questionType: GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInnerQuestionTypeEnum;
@@ -37,7 +37,7 @@ export interface GetQuizAttemptAnalyticsQuestionAnalysisInner {
37
37
  questionText: string;
38
38
  /**
39
39
  * Question type
40
- * @type {string}
40
+ * @type {GetQuizAttemptAnalyticsQuestionAnalysisInnerQuestionTypeEnum}
41
41
  * @memberof GetQuizAttemptAnalyticsQuestionAnalysisInner
42
42
  */
43
43
  questionType: GetQuizAttemptAnalyticsQuestionAnalysisInnerQuestionTypeEnum;
@@ -49,7 +49,7 @@ export interface GetQuizAttemptAnalyticsQuestionAnalysisInner {
49
49
  topic: string;
50
50
  /**
51
51
  * Question difficulty
52
- * @type {string}
52
+ * @type {GetQuizAttemptAnalyticsQuestionAnalysisInnerDifficultyLevelEnum}
53
53
  * @memberof GetQuizAttemptAnalyticsQuestionAnalysisInner
54
54
  */
55
55
  difficultyLevel: GetQuizAttemptAnalyticsQuestionAnalysisInnerDifficultyLevelEnum;
@@ -53,7 +53,7 @@ export interface GetQuizAttemptAttempt {
53
53
  attemptNumber: number;
54
54
  /**
55
55
  * Current attempt status
56
- * @type {string}
56
+ * @type {GetQuizAttemptAttemptStatusEnum}
57
57
  * @memberof GetQuizAttemptAttempt
58
58
  */
59
59
  status: GetQuizAttemptAttemptStatusEnum;
@@ -71,7 +71,7 @@ export interface GetQuizAttemptListAllOfAttempts {
71
71
  attemptNumber: number;
72
72
  /**
73
73
  * Attempt status
74
- * @type {string}
74
+ * @type {GetQuizAttemptListAllOfAttemptsStatusEnum}
75
75
  * @memberof GetQuizAttemptListAllOfAttempts
76
76
  */
77
77
  status: GetQuizAttemptListAllOfAttemptsStatusEnum;
@@ -30,7 +30,7 @@ export interface GetQuizAttemptListAllOfFilters {
30
30
  userId?: string;
31
31
  /**
32
32
  * Filter by attempt status
33
- * @type {string}
33
+ * @type {GetQuizAttemptListAllOfFiltersStatusEnum}
34
34
  * @memberof GetQuizAttemptListAllOfFilters
35
35
  */
36
36
  status?: GetQuizAttemptListAllOfFiltersStatusEnum;
@@ -49,7 +49,7 @@ export interface GetQuizAttemptQuestionsInner {
49
49
  questionText: string;
50
50
  /**
51
51
  * Question type
52
- * @type {string}
52
+ * @type {GetQuizAttemptQuestionsInnerQuestionTypeEnum}
53
53
  * @memberof GetQuizAttemptQuestionsInner
54
54
  */
55
55
  questionType: GetQuizAttemptQuestionsInnerQuestionTypeEnum;
@@ -35,13 +35,13 @@ export interface GetQuizCriteriaItem {
35
35
  topic?: string;
36
36
  /**
37
37
  * Difficulty filter (null for any difficulty)
38
- * @type {string}
38
+ * @type {GetQuizCriteriaItemDifficultyLevelEnum}
39
39
  * @memberof GetQuizCriteriaItem
40
40
  */
41
41
  difficultyLevel?: GetQuizCriteriaItemDifficultyLevelEnum;
42
42
  /**
43
43
  * Question type filter (null for any type)
44
- * @type {string}
44
+ * @type {GetQuizCriteriaItemQuestionTypeEnum}
45
45
  * @memberof GetQuizCriteriaItem
46
46
  */
47
47
  questionType?: GetQuizCriteriaItemQuestionTypeEnum;
@@ -35,13 +35,13 @@ export interface GetQuizCriteriaListItemsInner {
35
35
  topic?: string;
36
36
  /**
37
37
  * Difficulty filter (null for any difficulty)
38
- * @type {string}
38
+ * @type {GetQuizCriteriaListItemsInnerDifficultyLevelEnum}
39
39
  * @memberof GetQuizCriteriaListItemsInner
40
40
  */
41
41
  difficultyLevel?: GetQuizCriteriaListItemsInnerDifficultyLevelEnum;
42
42
  /**
43
43
  * Question type filter (null for any type)
44
- * @type {string}
44
+ * @type {GetQuizCriteriaListItemsInnerQuestionTypeEnum}
45
45
  * @memberof GetQuizCriteriaListItemsInner
46
46
  */
47
47
  questionType?: GetQuizCriteriaListItemsInnerQuestionTypeEnum;
@@ -29,7 +29,7 @@ export interface GetQuizListAllOfFilters {
29
29
  moduleId?: string;
30
30
  /**
31
31
  * Filter by question selection method
32
- * @type {string}
32
+ * @type {GetQuizListAllOfFiltersQuestionSelectionMethodEnum}
33
33
  * @memberof GetQuizListAllOfFilters
34
34
  */
35
35
  questionSelectionMethod?: GetQuizListAllOfFiltersQuestionSelectionMethodEnum;
@@ -72,7 +72,7 @@ export interface GetQuizListAllOfQuizzes {
72
72
  courseName?: string;
73
73
  /**
74
74
  * Question selection method
75
- * @type {string}
75
+ * @type {GetQuizListAllOfQuizzesQuestionSelectionMethodEnum}
76
76
  * @memberof GetQuizListAllOfQuizzes
77
77
  */
78
78
  questionSelectionMethod: GetQuizListAllOfQuizzesQuestionSelectionMethodEnum;
@@ -54,7 +54,7 @@ export interface GetQuizQuestions {
54
54
  totalPoints: number;
55
55
  /**
56
56
  * How questions were selected
57
- * @type {string}
57
+ * @type {GetQuizQuestionsSelectionMethodEnum}
58
58
  * @memberof GetQuizQuestions
59
59
  */
60
60
  selectionMethod: GetQuizQuestionsSelectionMethodEnum;
@@ -24,7 +24,7 @@ export interface GetQuizQuestionsItemsInnerQuestionDetails {
24
24
  questionText: string;
25
25
  /**
26
26
  * Type of question
27
- * @type {string}
27
+ * @type {GetQuizQuestionsItemsInnerQuestionDetailsQuestionTypeEnum}
28
28
  * @memberof GetQuizQuestionsItemsInnerQuestionDetails
29
29
  */
30
30
  questionType: GetQuizQuestionsItemsInnerQuestionDetailsQuestionTypeEnum;
@@ -36,7 +36,7 @@ export interface GetQuizQuestionsItemsInnerQuestionDetails {
36
36
  topic: string;
37
37
  /**
38
38
  * Question difficulty
39
- * @type {string}
39
+ * @type {GetQuizQuestionsItemsInnerQuestionDetailsDifficultyLevelEnum}
40
40
  * @memberof GetQuizQuestionsItemsInnerQuestionDetails
41
41
  */
42
42
  difficultyLevel: GetQuizQuestionsItemsInnerQuestionDetailsDifficultyLevelEnum;
@@ -51,7 +51,7 @@ export interface GetQuizResults {
51
51
  attemptNumber: number;
52
52
  /**
53
53
  * Status of the quiz attempt
54
- * @type {string}
54
+ * @type {GetQuizResultsStatusEnum}
55
55
  * @memberof GetQuizResults
56
56
  */
57
57
  status: GetQuizResultsStatusEnum;
@@ -17,7 +17,7 @@
17
17
  export interface GetQuizResultsFeedbackDifficultyPerformanceInner {
18
18
  /**
19
19
  *
20
- * @type {string}
20
+ * @type {GetQuizResultsFeedbackDifficultyPerformanceInnerDifficultyLevelEnum}
21
21
  * @memberof GetQuizResultsFeedbackDifficultyPerformanceInner
22
22
  */
23
23
  difficultyLevel: GetQuizResultsFeedbackDifficultyPerformanceInnerDifficultyLevelEnum;
@@ -37,7 +37,7 @@ export interface GetQuizResultsQuestionsInner {
37
37
  questionText: string;
38
38
  /**
39
39
  * Type of question
40
- * @type {string}
40
+ * @type {GetQuizResultsQuestionsInnerQuestionTypeEnum}
41
41
  * @memberof GetQuizResultsQuestionsInner
42
42
  */
43
43
  questionType: GetQuizResultsQuestionsInnerQuestionTypeEnum;
@@ -0,0 +1,88 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { GetPermission } from './GetPermission';
13
+ /**
14
+ * A role with its assigned permissions
15
+ * @export
16
+ * @interface GetRole
17
+ */
18
+ export interface GetRole {
19
+ /**
20
+ * External UUID of the role
21
+ * @type {string}
22
+ * @memberof GetRole
23
+ */
24
+ id: string;
25
+ /**
26
+ * Display name of the role
27
+ * @type {string}
28
+ * @memberof GetRole
29
+ */
30
+ name: string;
31
+ /**
32
+ * Optional description of the role
33
+ * @type {string}
34
+ * @memberof GetRole
35
+ */
36
+ description?: string | null;
37
+ /**
38
+ * The base role type this role derives from
39
+ * @type {GetRoleBaseTypeEnum}
40
+ * @memberof GetRole
41
+ */
42
+ baseType: GetRoleBaseTypeEnum;
43
+ /**
44
+ * Portal this role is scoped to (null for system roles)
45
+ * @type {string}
46
+ * @memberof GetRole
47
+ */
48
+ portalId?: string | null;
49
+ /**
50
+ * Whether this is a built-in system role (cannot be modified)
51
+ * @type {boolean}
52
+ * @memberof GetRole
53
+ */
54
+ isSystem: boolean;
55
+ /**
56
+ * Whether this role is active
57
+ * @type {boolean}
58
+ * @memberof GetRole
59
+ */
60
+ isActive: boolean;
61
+ /**
62
+ *
63
+ * @type {Array<GetPermission>}
64
+ * @memberof GetRole
65
+ */
66
+ permissions: Array<GetPermission>;
67
+ }
68
+ /**
69
+ * @export
70
+ */
71
+ export declare const GetRoleBaseTypeEnum: {
72
+ readonly Owner: "Owner";
73
+ readonly Admin: "Admin";
74
+ readonly Instructor: "Instructor";
75
+ readonly Learner: "Learner";
76
+ readonly ClientSuperAdmin: "ClientSuperAdmin";
77
+ readonly ClientManager: "ClientManager";
78
+ readonly PortalClientAdministrator: "PortalClientAdministrator";
79
+ };
80
+ export type GetRoleBaseTypeEnum = typeof GetRoleBaseTypeEnum[keyof typeof GetRoleBaseTypeEnum];
81
+ /**
82
+ * Check if a given object implements the GetRole interface.
83
+ */
84
+ export declare function instanceOfGetRole(value: object): value is GetRole;
85
+ export declare function GetRoleFromJSON(json: any): GetRole;
86
+ export declare function GetRoleFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetRole;
87
+ export declare function GetRoleToJSON(json: any): GetRole;
88
+ export declare function GetRoleToJSONTyped(value?: GetRole | null, ignoreDiscriminator?: boolean): any;