@easyedu/js-lsm-api 1.14.0 → 1.16.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 (158) hide show
  1. package/.openapi-generator/FILES +29 -0
  2. package/README.md +2 -2
  3. package/dist/apis/ReportingApi.d.ts +120 -0
  4. package/dist/apis/ReportingApi.js +299 -0
  5. package/dist/apis/index.d.ts +1 -0
  6. package/dist/apis/index.js +1 -0
  7. package/dist/esm/apis/ReportingApi.d.ts +120 -0
  8. package/dist/esm/apis/ReportingApi.js +295 -0
  9. package/dist/esm/apis/index.d.ts +1 -0
  10. package/dist/esm/apis/index.js +1 -0
  11. package/dist/esm/models/GetContentGradeDetail.d.ts +118 -0
  12. package/dist/esm/models/GetContentGradeDetail.js +104 -0
  13. package/dist/esm/models/GetContentGrades.d.ts +57 -0
  14. package/dist/esm/models/GetContentGrades.js +60 -0
  15. package/dist/esm/models/GetContentGradesItemsInner.d.ts +72 -0
  16. package/dist/esm/models/GetContentGradesItemsInner.js +73 -0
  17. package/dist/esm/models/GetContentGradesItemsInnerUser.d.ts +44 -0
  18. package/dist/esm/models/GetContentGradesItemsInnerUser.js +51 -0
  19. package/dist/esm/models/GetContentInstructorBasicReporting.d.ts +47 -0
  20. package/dist/esm/models/GetContentInstructorBasicReporting.js +54 -0
  21. package/dist/esm/models/GetContentInstructorBasicReportingContentInfo.d.ts +59 -0
  22. package/dist/esm/models/GetContentInstructorBasicReportingContentInfo.js +63 -0
  23. package/dist/esm/models/GetContentInstructorBasicReportingEngagement.d.ts +56 -0
  24. package/dist/esm/models/GetContentInstructorBasicReportingEngagement.js +59 -0
  25. package/dist/esm/models/GetContentInstructorBasicReportingPerformance.d.ts +38 -0
  26. package/dist/esm/models/GetContentInstructorBasicReportingPerformance.js +47 -0
  27. package/dist/esm/models/GetCourseStudentReporting.d.ts +47 -0
  28. package/dist/esm/models/GetCourseStudentReporting.js +54 -0
  29. package/dist/esm/models/GetCourseStudentReportingCourseInfo.d.ts +32 -0
  30. package/dist/esm/models/GetCourseStudentReportingCourseInfo.js +43 -0
  31. package/dist/esm/models/GetCourseStudentReportingEngagement.d.ts +38 -0
  32. package/dist/esm/models/GetCourseStudentReportingEngagement.js +47 -0
  33. package/dist/esm/models/GetCourseStudentReportingPerformance.d.ts +32 -0
  34. package/dist/esm/models/GetCourseStudentReportingPerformance.js +43 -0
  35. package/dist/esm/models/GetModuleInstructorBasicReporting.d.ts +47 -0
  36. package/dist/esm/models/GetModuleInstructorBasicReporting.js +54 -0
  37. package/dist/esm/models/GetModuleInstructorBasicReportingEngagement.d.ts +32 -0
  38. package/dist/esm/models/GetModuleInstructorBasicReportingEngagement.js +43 -0
  39. package/dist/esm/models/GetModuleInstructorBasicReportingModuleInfo.d.ts +32 -0
  40. package/dist/esm/models/GetModuleInstructorBasicReportingModuleInfo.js +43 -0
  41. package/dist/esm/models/GetModuleInstructorBasicReportingPerformance.d.ts +32 -0
  42. package/dist/esm/models/GetModuleInstructorBasicReportingPerformance.js +43 -0
  43. package/dist/esm/models/GetModuleStudentReporting.d.ts +47 -0
  44. package/dist/esm/models/GetModuleStudentReporting.js +54 -0
  45. package/dist/esm/models/GetModuleStudentReportingAccess.d.ts +38 -0
  46. package/dist/esm/models/GetModuleStudentReportingAccess.js +47 -0
  47. package/dist/esm/models/GetModuleStudentReportingProgress.d.ts +38 -0
  48. package/dist/esm/models/GetModuleStudentReportingProgress.js +47 -0
  49. package/dist/esm/models/GetPortalBasicReporting.d.ts +40 -0
  50. package/dist/esm/models/GetPortalBasicReporting.js +49 -0
  51. package/dist/esm/models/GetPortalBasicReportingCertificates.d.ts +32 -0
  52. package/dist/esm/models/GetPortalBasicReportingCertificates.js +43 -0
  53. package/dist/esm/models/GetPortalBasicReportingPortalInfo.d.ts +44 -0
  54. package/dist/esm/models/GetPortalBasicReportingPortalInfo.js +51 -0
  55. package/dist/esm/models/ScormSessionData.d.ts +61 -0
  56. package/dist/esm/models/ScormSessionData.js +54 -0
  57. package/dist/esm/models/ScormSessionDataProgress.d.ts +38 -0
  58. package/dist/esm/models/ScormSessionDataProgress.js +43 -0
  59. package/dist/esm/models/ScormSessionDataScore.d.ts +50 -0
  60. package/dist/esm/models/ScormSessionDataScore.js +47 -0
  61. package/dist/esm/models/ScormSessionDataSession.d.ts +32 -0
  62. package/dist/esm/models/ScormSessionDataSession.js +41 -0
  63. package/dist/esm/models/ScormSessionDataStatus.d.ts +50 -0
  64. package/dist/esm/models/ScormSessionDataStatus.js +47 -0
  65. package/dist/esm/models/ScormSessionDataTime.d.ts +50 -0
  66. package/dist/esm/models/ScormSessionDataTime.js +47 -0
  67. package/dist/esm/models/index.d.ts +28 -0
  68. package/dist/esm/models/index.js +28 -0
  69. package/dist/models/GetContentGradeDetail.d.ts +118 -0
  70. package/dist/models/GetContentGradeDetail.js +112 -0
  71. package/dist/models/GetContentGrades.d.ts +57 -0
  72. package/dist/models/GetContentGrades.js +67 -0
  73. package/dist/models/GetContentGradesItemsInner.d.ts +72 -0
  74. package/dist/models/GetContentGradesItemsInner.js +81 -0
  75. package/dist/models/GetContentGradesItemsInnerUser.d.ts +44 -0
  76. package/dist/models/GetContentGradesItemsInnerUser.js +58 -0
  77. package/dist/models/GetContentInstructorBasicReporting.d.ts +47 -0
  78. package/dist/models/GetContentInstructorBasicReporting.js +61 -0
  79. package/dist/models/GetContentInstructorBasicReportingContentInfo.d.ts +59 -0
  80. package/dist/models/GetContentInstructorBasicReportingContentInfo.js +71 -0
  81. package/dist/models/GetContentInstructorBasicReportingEngagement.d.ts +56 -0
  82. package/dist/models/GetContentInstructorBasicReportingEngagement.js +66 -0
  83. package/dist/models/GetContentInstructorBasicReportingPerformance.d.ts +38 -0
  84. package/dist/models/GetContentInstructorBasicReportingPerformance.js +54 -0
  85. package/dist/models/GetCourseStudentReporting.d.ts +47 -0
  86. package/dist/models/GetCourseStudentReporting.js +61 -0
  87. package/dist/models/GetCourseStudentReportingCourseInfo.d.ts +32 -0
  88. package/dist/models/GetCourseStudentReportingCourseInfo.js +50 -0
  89. package/dist/models/GetCourseStudentReportingEngagement.d.ts +38 -0
  90. package/dist/models/GetCourseStudentReportingEngagement.js +54 -0
  91. package/dist/models/GetCourseStudentReportingPerformance.d.ts +32 -0
  92. package/dist/models/GetCourseStudentReportingPerformance.js +50 -0
  93. package/dist/models/GetModuleInstructorBasicReporting.d.ts +47 -0
  94. package/dist/models/GetModuleInstructorBasicReporting.js +61 -0
  95. package/dist/models/GetModuleInstructorBasicReportingEngagement.d.ts +32 -0
  96. package/dist/models/GetModuleInstructorBasicReportingEngagement.js +50 -0
  97. package/dist/models/GetModuleInstructorBasicReportingModuleInfo.d.ts +32 -0
  98. package/dist/models/GetModuleInstructorBasicReportingModuleInfo.js +50 -0
  99. package/dist/models/GetModuleInstructorBasicReportingPerformance.d.ts +32 -0
  100. package/dist/models/GetModuleInstructorBasicReportingPerformance.js +50 -0
  101. package/dist/models/GetModuleStudentReporting.d.ts +47 -0
  102. package/dist/models/GetModuleStudentReporting.js +61 -0
  103. package/dist/models/GetModuleStudentReportingAccess.d.ts +38 -0
  104. package/dist/models/GetModuleStudentReportingAccess.js +54 -0
  105. package/dist/models/GetModuleStudentReportingProgress.d.ts +38 -0
  106. package/dist/models/GetModuleStudentReportingProgress.js +54 -0
  107. package/dist/models/GetPortalBasicReporting.d.ts +40 -0
  108. package/dist/models/GetPortalBasicReporting.js +56 -0
  109. package/dist/models/GetPortalBasicReportingCertificates.d.ts +32 -0
  110. package/dist/models/GetPortalBasicReportingCertificates.js +50 -0
  111. package/dist/models/GetPortalBasicReportingPortalInfo.d.ts +44 -0
  112. package/dist/models/GetPortalBasicReportingPortalInfo.js +58 -0
  113. package/dist/models/ScormSessionData.d.ts +61 -0
  114. package/dist/models/ScormSessionData.js +61 -0
  115. package/dist/models/ScormSessionDataProgress.d.ts +38 -0
  116. package/dist/models/ScormSessionDataProgress.js +50 -0
  117. package/dist/models/ScormSessionDataScore.d.ts +50 -0
  118. package/dist/models/ScormSessionDataScore.js +54 -0
  119. package/dist/models/ScormSessionDataSession.d.ts +32 -0
  120. package/dist/models/ScormSessionDataSession.js +48 -0
  121. package/dist/models/ScormSessionDataStatus.d.ts +50 -0
  122. package/dist/models/ScormSessionDataStatus.js +54 -0
  123. package/dist/models/ScormSessionDataTime.d.ts +50 -0
  124. package/dist/models/ScormSessionDataTime.js +54 -0
  125. package/dist/models/index.d.ts +28 -0
  126. package/dist/models/index.js +28 -0
  127. package/package.json +1 -1
  128. package/src/apis/ReportingApi.ts +450 -0
  129. package/src/apis/index.ts +1 -0
  130. package/src/models/GetContentGradeDetail.ts +191 -0
  131. package/src/models/GetContentGrades.ts +110 -0
  132. package/src/models/GetContentGradesItemsInner.ts +125 -0
  133. package/src/models/GetContentGradesItemsInnerUser.ts +84 -0
  134. package/src/models/GetContentInstructorBasicReporting.ts +106 -0
  135. package/src/models/GetContentInstructorBasicReportingContentInfo.ts +101 -0
  136. package/src/models/GetContentInstructorBasicReportingEngagement.ts +102 -0
  137. package/src/models/GetContentInstructorBasicReportingPerformance.ts +75 -0
  138. package/src/models/GetCourseStudentReporting.ts +106 -0
  139. package/src/models/GetCourseStudentReportingCourseInfo.ts +66 -0
  140. package/src/models/GetCourseStudentReportingEngagement.ts +75 -0
  141. package/src/models/GetCourseStudentReportingPerformance.ts +66 -0
  142. package/src/models/GetModuleInstructorBasicReporting.ts +106 -0
  143. package/src/models/GetModuleInstructorBasicReportingEngagement.ts +66 -0
  144. package/src/models/GetModuleInstructorBasicReportingModuleInfo.ts +66 -0
  145. package/src/models/GetModuleInstructorBasicReportingPerformance.ts +66 -0
  146. package/src/models/GetModuleStudentReporting.ts +106 -0
  147. package/src/models/GetModuleStudentReportingAccess.ts +75 -0
  148. package/src/models/GetModuleStudentReportingProgress.ts +75 -0
  149. package/src/models/GetPortalBasicReporting.ts +90 -0
  150. package/src/models/GetPortalBasicReportingCertificates.ts +66 -0
  151. package/src/models/GetPortalBasicReportingPortalInfo.ts +84 -0
  152. package/src/models/ScormSessionData.ts +133 -0
  153. package/src/models/ScormSessionDataProgress.ts +73 -0
  154. package/src/models/ScormSessionDataScore.ts +89 -0
  155. package/src/models/ScormSessionDataSession.ts +65 -0
  156. package/src/models/ScormSessionDataStatus.ts +89 -0
  157. package/src/models/ScormSessionDataTime.ts +89 -0
  158. package/src/models/index.ts +28 -0
@@ -0,0 +1,295 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import * as runtime from '../runtime';
24
+ import { GetContentGradeDetailFromJSON, GetContentGradesFromJSON, GetContentInstructorBasicReportingFromJSON, GetCourseReportingBasicFromJSON, GetCourseStudentReportingFromJSON, GetModuleInstructorBasicReportingFromJSON, GetModuleStudentReportingFromJSON, GetPortalBasicReportingFromJSON, } from '../models/index';
25
+ /**
26
+ *
27
+ */
28
+ export class ReportingApi extends runtime.BaseAPI {
29
+ /**
30
+ * Get detailed grade information for a specific student and content
31
+ */
32
+ getContentGradeDetailRaw(requestParameters, initOverrides) {
33
+ return __awaiter(this, void 0, void 0, function* () {
34
+ if (requestParameters['courseId'] == null) {
35
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentGradeDetail().');
36
+ }
37
+ if (requestParameters['moduleId'] == null) {
38
+ throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling getContentGradeDetail().');
39
+ }
40
+ if (requestParameters['contentId'] == null) {
41
+ throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling getContentGradeDetail().');
42
+ }
43
+ if (requestParameters['studentId'] == null) {
44
+ throw new runtime.RequiredError('studentId', 'Required parameter "studentId" was null or undefined when calling getContentGradeDetail().');
45
+ }
46
+ const queryParameters = {};
47
+ const headerParameters = {};
48
+ const response = yield this.request({
49
+ path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/grades/{studentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId']))),
50
+ method: 'GET',
51
+ headers: headerParameters,
52
+ query: queryParameters,
53
+ }, initOverrides);
54
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetContentGradeDetailFromJSON(jsonValue));
55
+ });
56
+ }
57
+ /**
58
+ * Get detailed grade information for a specific student and content
59
+ */
60
+ getContentGradeDetail(requestParameters, initOverrides) {
61
+ return __awaiter(this, void 0, void 0, function* () {
62
+ const response = yield this.getContentGradeDetailRaw(requestParameters, initOverrides);
63
+ return yield response.value();
64
+ });
65
+ }
66
+ /**
67
+ * Get grades for all students enrolled in course for specific content
68
+ */
69
+ getContentGradesRaw(requestParameters, initOverrides) {
70
+ return __awaiter(this, void 0, void 0, function* () {
71
+ if (requestParameters['courseId'] == null) {
72
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentGrades().');
73
+ }
74
+ if (requestParameters['moduleId'] == null) {
75
+ throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling getContentGrades().');
76
+ }
77
+ if (requestParameters['contentId'] == null) {
78
+ throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling getContentGrades().');
79
+ }
80
+ const queryParameters = {};
81
+ if (requestParameters['page'] != null) {
82
+ queryParameters['page'] = requestParameters['page'];
83
+ }
84
+ if (requestParameters['pageSize'] != null) {
85
+ queryParameters['pageSize'] = requestParameters['pageSize'];
86
+ }
87
+ if (requestParameters['search'] != null) {
88
+ queryParameters['search'] = requestParameters['search'];
89
+ }
90
+ const headerParameters = {};
91
+ const response = yield this.request({
92
+ path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/grades`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))),
93
+ method: 'GET',
94
+ headers: headerParameters,
95
+ query: queryParameters,
96
+ }, initOverrides);
97
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetContentGradesFromJSON(jsonValue));
98
+ });
99
+ }
100
+ /**
101
+ * Get grades for all students enrolled in course for specific content
102
+ */
103
+ getContentGrades(requestParameters, initOverrides) {
104
+ return __awaiter(this, void 0, void 0, function* () {
105
+ const response = yield this.getContentGradesRaw(requestParameters, initOverrides);
106
+ return yield response.value();
107
+ });
108
+ }
109
+ /**
110
+ * Get basic instructor reporting for content
111
+ */
112
+ getContentInstructorBasicReportingRaw(requestParameters, initOverrides) {
113
+ return __awaiter(this, void 0, void 0, function* () {
114
+ if (requestParameters['courseId'] == null) {
115
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getContentInstructorBasicReporting().');
116
+ }
117
+ if (requestParameters['moduleId'] == null) {
118
+ throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling getContentInstructorBasicReporting().');
119
+ }
120
+ if (requestParameters['contentId'] == null) {
121
+ throw new runtime.RequiredError('contentId', 'Required parameter "contentId" was null or undefined when calling getContentInstructorBasicReporting().');
122
+ }
123
+ const queryParameters = {};
124
+ const headerParameters = {};
125
+ const response = yield this.request({
126
+ path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/instructor/basic`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))),
127
+ method: 'GET',
128
+ headers: headerParameters,
129
+ query: queryParameters,
130
+ }, initOverrides);
131
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetContentInstructorBasicReportingFromJSON(jsonValue));
132
+ });
133
+ }
134
+ /**
135
+ * Get basic instructor reporting for content
136
+ */
137
+ getContentInstructorBasicReporting(requestParameters, initOverrides) {
138
+ return __awaiter(this, void 0, void 0, function* () {
139
+ const response = yield this.getContentInstructorBasicReportingRaw(requestParameters, initOverrides);
140
+ return yield response.value();
141
+ });
142
+ }
143
+ /**
144
+ * Get basic course reporting data for instructors
145
+ */
146
+ getCourseInstructorReportingBasicRaw(requestParameters, initOverrides) {
147
+ return __awaiter(this, void 0, void 0, function* () {
148
+ if (requestParameters['courseId'] == null) {
149
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseInstructorReportingBasic().');
150
+ }
151
+ const queryParameters = {};
152
+ const headerParameters = {};
153
+ const response = yield this.request({
154
+ path: `/courses/{courseId}/reporting/instructor/basic`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
155
+ method: 'GET',
156
+ headers: headerParameters,
157
+ query: queryParameters,
158
+ }, initOverrides);
159
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseReportingBasicFromJSON(jsonValue));
160
+ });
161
+ }
162
+ /**
163
+ * Get basic course reporting data for instructors
164
+ */
165
+ getCourseInstructorReportingBasic(requestParameters, initOverrides) {
166
+ return __awaiter(this, void 0, void 0, function* () {
167
+ const response = yield this.getCourseInstructorReportingBasicRaw(requestParameters, initOverrides);
168
+ return yield response.value();
169
+ });
170
+ }
171
+ /**
172
+ * Get student-specific reporting for a course
173
+ */
174
+ getCourseStudentReportingRaw(requestParameters, initOverrides) {
175
+ return __awaiter(this, void 0, void 0, function* () {
176
+ if (requestParameters['courseId'] == null) {
177
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseStudentReporting().');
178
+ }
179
+ if (requestParameters['studentId'] == null) {
180
+ throw new runtime.RequiredError('studentId', 'Required parameter "studentId" was null or undefined when calling getCourseStudentReporting().');
181
+ }
182
+ const queryParameters = {};
183
+ const headerParameters = {};
184
+ const response = yield this.request({
185
+ path: `/courses/{courseId}/reporting/students/{studentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId']))),
186
+ method: 'GET',
187
+ headers: headerParameters,
188
+ query: queryParameters,
189
+ }, initOverrides);
190
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseStudentReportingFromJSON(jsonValue));
191
+ });
192
+ }
193
+ /**
194
+ * Get student-specific reporting for a course
195
+ */
196
+ getCourseStudentReporting(requestParameters, initOverrides) {
197
+ return __awaiter(this, void 0, void 0, function* () {
198
+ const response = yield this.getCourseStudentReportingRaw(requestParameters, initOverrides);
199
+ return yield response.value();
200
+ });
201
+ }
202
+ /**
203
+ * Get basic instructor reporting for a module
204
+ */
205
+ getModuleInstructorBasicReportingRaw(requestParameters, initOverrides) {
206
+ return __awaiter(this, void 0, void 0, function* () {
207
+ if (requestParameters['courseId'] == null) {
208
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getModuleInstructorBasicReporting().');
209
+ }
210
+ if (requestParameters['moduleId'] == null) {
211
+ throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling getModuleInstructorBasicReporting().');
212
+ }
213
+ const queryParameters = {};
214
+ const headerParameters = {};
215
+ const response = yield this.request({
216
+ path: `/courses/{courseId}/modules/{moduleId}/reporting/instructor/basic`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))),
217
+ method: 'GET',
218
+ headers: headerParameters,
219
+ query: queryParameters,
220
+ }, initOverrides);
221
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetModuleInstructorBasicReportingFromJSON(jsonValue));
222
+ });
223
+ }
224
+ /**
225
+ * Get basic instructor reporting for a module
226
+ */
227
+ getModuleInstructorBasicReporting(requestParameters, initOverrides) {
228
+ return __awaiter(this, void 0, void 0, function* () {
229
+ const response = yield this.getModuleInstructorBasicReportingRaw(requestParameters, initOverrides);
230
+ return yield response.value();
231
+ });
232
+ }
233
+ /**
234
+ * Get student-specific reporting for a module
235
+ */
236
+ getModuleStudentReportingRaw(requestParameters, initOverrides) {
237
+ return __awaiter(this, void 0, void 0, function* () {
238
+ if (requestParameters['courseId'] == null) {
239
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getModuleStudentReporting().');
240
+ }
241
+ if (requestParameters['moduleId'] == null) {
242
+ throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling getModuleStudentReporting().');
243
+ }
244
+ if (requestParameters['studentId'] == null) {
245
+ throw new runtime.RequiredError('studentId', 'Required parameter "studentId" was null or undefined when calling getModuleStudentReporting().');
246
+ }
247
+ const queryParameters = {};
248
+ const headerParameters = {};
249
+ const response = yield this.request({
250
+ path: `/courses/{courseId}/modules/{moduleId}/reporting/students/{studentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId']))),
251
+ method: 'GET',
252
+ headers: headerParameters,
253
+ query: queryParameters,
254
+ }, initOverrides);
255
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetModuleStudentReportingFromJSON(jsonValue));
256
+ });
257
+ }
258
+ /**
259
+ * Get student-specific reporting for a module
260
+ */
261
+ getModuleStudentReporting(requestParameters, initOverrides) {
262
+ return __awaiter(this, void 0, void 0, function* () {
263
+ const response = yield this.getModuleStudentReportingRaw(requestParameters, initOverrides);
264
+ return yield response.value();
265
+ });
266
+ }
267
+ /**
268
+ * Get basic reporting for a portal
269
+ */
270
+ getPortalBasicReportingRaw(requestParameters, initOverrides) {
271
+ return __awaiter(this, void 0, void 0, function* () {
272
+ if (requestParameters['portalId'] == null) {
273
+ throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalBasicReporting().');
274
+ }
275
+ const queryParameters = {};
276
+ const headerParameters = {};
277
+ const response = yield this.request({
278
+ path: `/portals/{portalId}/reporting/basic`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
279
+ method: 'GET',
280
+ headers: headerParameters,
281
+ query: queryParameters,
282
+ }, initOverrides);
283
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalBasicReportingFromJSON(jsonValue));
284
+ });
285
+ }
286
+ /**
287
+ * Get basic reporting for a portal
288
+ */
289
+ getPortalBasicReporting(requestParameters, initOverrides) {
290
+ return __awaiter(this, void 0, void 0, function* () {
291
+ const response = yield this.getPortalBasicReportingRaw(requestParameters, initOverrides);
292
+ return yield response.value();
293
+ });
294
+ }
295
+ }
@@ -5,4 +5,5 @@ export * from './OtherApi';
5
5
  export * from './PortalApi';
6
6
  export * from './QuestionApi';
7
7
  export * from './QuizApi';
8
+ export * from './ReportingApi';
8
9
  export * from './UserApi';
@@ -7,4 +7,5 @@ export * from './OtherApi';
7
7
  export * from './PortalApi';
8
8
  export * from './QuestionApi';
9
9
  export * from './QuizApi';
10
+ export * from './ReportingApi';
10
11
  export * from './UserApi';
@@ -0,0 +1,118 @@
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 { ScormSessionData } from './ScormSessionData';
13
+ import type { GetContentGradesItemsInnerUser } from './GetContentGradesItemsInnerUser';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface GetContentGradeDetail
18
+ */
19
+ export interface GetContentGradeDetail {
20
+ /**
21
+ * Content session external ID
22
+ * @type {string}
23
+ * @memberof GetContentGradeDetail
24
+ */
25
+ id?: string | null;
26
+ /**
27
+ *
28
+ * @type {GetContentGradesItemsInnerUser}
29
+ * @memberof GetContentGradeDetail
30
+ */
31
+ user: GetContentGradesItemsInnerUser;
32
+ /**
33
+ * Content completion status
34
+ * @type {string}
35
+ * @memberof GetContentGradeDetail
36
+ */
37
+ completion: GetContentGradeDetailCompletionEnum;
38
+ /**
39
+ * Content grade status
40
+ * @type {string}
41
+ * @memberof GetContentGradeDetail
42
+ */
43
+ gradeStatus: GetContentGradeDetailGradeStatusEnum;
44
+ /**
45
+ * Content session creation timestamp (epoch seconds)
46
+ * @type {number}
47
+ * @memberof GetContentGradeDetail
48
+ */
49
+ createdAt: number | null;
50
+ /**
51
+ * Content session last update timestamp (epoch seconds)
52
+ * @type {number}
53
+ * @memberof GetContentGradeDetail
54
+ */
55
+ updatedAt: number | null;
56
+ /**
57
+ * Type of content
58
+ * @type {string}
59
+ * @memberof GetContentGradeDetail
60
+ */
61
+ contentType: GetContentGradeDetailContentTypeEnum;
62
+ /**
63
+ * Number of attempts for this content
64
+ * @type {number}
65
+ * @memberof GetContentGradeDetail
66
+ */
67
+ attemptCount?: number | null;
68
+ /**
69
+ *
70
+ * @type {ScormSessionData}
71
+ * @memberof GetContentGradeDetail
72
+ */
73
+ scormData?: ScormSessionData;
74
+ }
75
+ /**
76
+ * @export
77
+ */
78
+ export declare const GetContentGradeDetailCompletionEnum: {
79
+ readonly NotAttempted: "NotAttempted";
80
+ readonly InProgress: "InProgress";
81
+ readonly Completed: "Completed";
82
+ };
83
+ export type GetContentGradeDetailCompletionEnum = typeof GetContentGradeDetailCompletionEnum[keyof typeof GetContentGradeDetailCompletionEnum];
84
+ /**
85
+ * @export
86
+ */
87
+ export declare const GetContentGradeDetailGradeStatusEnum: {
88
+ readonly Ungraded: "Ungraded";
89
+ readonly Passed: "Passed";
90
+ readonly Failed: "Failed";
91
+ readonly PointsEarned: "PointsEarned";
92
+ readonly PercentageEarned: "PercentageEarned";
93
+ readonly NotApplicable: "NotApplicable";
94
+ };
95
+ export type GetContentGradeDetailGradeStatusEnum = typeof GetContentGradeDetailGradeStatusEnum[keyof typeof GetContentGradeDetailGradeStatusEnum];
96
+ /**
97
+ * @export
98
+ */
99
+ export declare const GetContentGradeDetailContentTypeEnum: {
100
+ readonly Scorm: "Scorm";
101
+ readonly Video: "Video";
102
+ readonly Audio: "Audio";
103
+ readonly Image: "Image";
104
+ readonly Text: "Text";
105
+ readonly Link: "Link";
106
+ readonly File: "File";
107
+ readonly Pdf: "Pdf";
108
+ readonly Quiz: "Quiz";
109
+ };
110
+ export type GetContentGradeDetailContentTypeEnum = typeof GetContentGradeDetailContentTypeEnum[keyof typeof GetContentGradeDetailContentTypeEnum];
111
+ /**
112
+ * Check if a given object implements the GetContentGradeDetail interface.
113
+ */
114
+ export declare function instanceOfGetContentGradeDetail(value: object): value is GetContentGradeDetail;
115
+ export declare function GetContentGradeDetailFromJSON(json: any): GetContentGradeDetail;
116
+ export declare function GetContentGradeDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentGradeDetail;
117
+ export declare function GetContentGradeDetailToJSON(json: any): GetContentGradeDetail;
118
+ export declare function GetContentGradeDetailToJSONTyped(value?: GetContentGradeDetail | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,104 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { ScormSessionDataFromJSON, ScormSessionDataToJSON, } from './ScormSessionData';
15
+ import { GetContentGradesItemsInnerUserFromJSON, GetContentGradesItemsInnerUserToJSON, } from './GetContentGradesItemsInnerUser';
16
+ /**
17
+ * @export
18
+ */
19
+ export const GetContentGradeDetailCompletionEnum = {
20
+ NotAttempted: 'NotAttempted',
21
+ InProgress: 'InProgress',
22
+ Completed: 'Completed'
23
+ };
24
+ /**
25
+ * @export
26
+ */
27
+ export const GetContentGradeDetailGradeStatusEnum = {
28
+ Ungraded: 'Ungraded',
29
+ Passed: 'Passed',
30
+ Failed: 'Failed',
31
+ PointsEarned: 'PointsEarned',
32
+ PercentageEarned: 'PercentageEarned',
33
+ NotApplicable: 'NotApplicable'
34
+ };
35
+ /**
36
+ * @export
37
+ */
38
+ export const GetContentGradeDetailContentTypeEnum = {
39
+ Scorm: 'Scorm',
40
+ Video: 'Video',
41
+ Audio: 'Audio',
42
+ Image: 'Image',
43
+ Text: 'Text',
44
+ Link: 'Link',
45
+ File: 'File',
46
+ Pdf: 'Pdf',
47
+ Quiz: 'Quiz'
48
+ };
49
+ /**
50
+ * Check if a given object implements the GetContentGradeDetail interface.
51
+ */
52
+ export function instanceOfGetContentGradeDetail(value) {
53
+ if (!('user' in value) || value['user'] === undefined)
54
+ return false;
55
+ if (!('completion' in value) || value['completion'] === undefined)
56
+ return false;
57
+ if (!('gradeStatus' in value) || value['gradeStatus'] === undefined)
58
+ return false;
59
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
60
+ return false;
61
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
62
+ return false;
63
+ if (!('contentType' in value) || value['contentType'] === undefined)
64
+ return false;
65
+ return true;
66
+ }
67
+ export function GetContentGradeDetailFromJSON(json) {
68
+ return GetContentGradeDetailFromJSONTyped(json, false);
69
+ }
70
+ export function GetContentGradeDetailFromJSONTyped(json, ignoreDiscriminator) {
71
+ if (json == null) {
72
+ return json;
73
+ }
74
+ return {
75
+ 'id': json['id'] == null ? undefined : json['id'],
76
+ 'user': GetContentGradesItemsInnerUserFromJSON(json['user']),
77
+ 'completion': json['completion'],
78
+ 'gradeStatus': json['grade_status'],
79
+ 'createdAt': json['created_at'],
80
+ 'updatedAt': json['updated_at'],
81
+ 'contentType': json['content_type'],
82
+ 'attemptCount': json['attempt_count'] == null ? undefined : json['attempt_count'],
83
+ 'scormData': json['scorm_data'] == null ? undefined : ScormSessionDataFromJSON(json['scorm_data']),
84
+ };
85
+ }
86
+ export function GetContentGradeDetailToJSON(json) {
87
+ return GetContentGradeDetailToJSONTyped(json, false);
88
+ }
89
+ export function GetContentGradeDetailToJSONTyped(value, ignoreDiscriminator = false) {
90
+ if (value == null) {
91
+ return value;
92
+ }
93
+ return {
94
+ 'id': value['id'],
95
+ 'user': GetContentGradesItemsInnerUserToJSON(value['user']),
96
+ 'completion': value['completion'],
97
+ 'grade_status': value['gradeStatus'],
98
+ 'created_at': value['createdAt'],
99
+ 'updated_at': value['updatedAt'],
100
+ 'content_type': value['contentType'],
101
+ 'attempt_count': value['attemptCount'],
102
+ 'scorm_data': ScormSessionDataToJSON(value['scormData']),
103
+ };
104
+ }
@@ -0,0 +1,57 @@
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 { GetContentGradesItemsInner } from './GetContentGradesItemsInner';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GetContentGrades
17
+ */
18
+ export interface GetContentGrades {
19
+ /**
20
+ * The current page number
21
+ * @type {number}
22
+ * @memberof GetContentGrades
23
+ */
24
+ page: number;
25
+ /**
26
+ * The number of items per page
27
+ * @type {number}
28
+ * @memberof GetContentGrades
29
+ */
30
+ pageSize: number;
31
+ /**
32
+ * The total number of pages
33
+ * @type {number}
34
+ * @memberof GetContentGrades
35
+ */
36
+ totalPages: number;
37
+ /**
38
+ * The total number of items
39
+ * @type {number}
40
+ * @memberof GetContentGrades
41
+ */
42
+ totalItems: number;
43
+ /**
44
+ *
45
+ * @type {Array<GetContentGradesItemsInner>}
46
+ * @memberof GetContentGrades
47
+ */
48
+ items: Array<GetContentGradesItemsInner>;
49
+ }
50
+ /**
51
+ * Check if a given object implements the GetContentGrades interface.
52
+ */
53
+ export declare function instanceOfGetContentGrades(value: object): value is GetContentGrades;
54
+ export declare function GetContentGradesFromJSON(json: any): GetContentGrades;
55
+ export declare function GetContentGradesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentGrades;
56
+ export declare function GetContentGradesToJSON(json: any): GetContentGrades;
57
+ export declare function GetContentGradesToJSONTyped(value?: GetContentGrades | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,60 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { GetContentGradesItemsInnerFromJSON, GetContentGradesItemsInnerToJSON, } from './GetContentGradesItemsInner';
15
+ /**
16
+ * Check if a given object implements the GetContentGrades interface.
17
+ */
18
+ export function instanceOfGetContentGrades(value) {
19
+ if (!('page' in value) || value['page'] === undefined)
20
+ return false;
21
+ if (!('pageSize' in value) || value['pageSize'] === undefined)
22
+ return false;
23
+ if (!('totalPages' in value) || value['totalPages'] === undefined)
24
+ return false;
25
+ if (!('totalItems' in value) || value['totalItems'] === undefined)
26
+ return false;
27
+ if (!('items' in value) || value['items'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ export function GetContentGradesFromJSON(json) {
32
+ return GetContentGradesFromJSONTyped(json, false);
33
+ }
34
+ export function GetContentGradesFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'page': json['page'],
40
+ 'pageSize': json['pageSize'],
41
+ 'totalPages': json['totalPages'],
42
+ 'totalItems': json['totalItems'],
43
+ 'items': (json['items'].map(GetContentGradesItemsInnerFromJSON)),
44
+ };
45
+ }
46
+ export function GetContentGradesToJSON(json) {
47
+ return GetContentGradesToJSONTyped(json, false);
48
+ }
49
+ export function GetContentGradesToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'page': value['page'],
55
+ 'pageSize': value['pageSize'],
56
+ 'totalPages': value['totalPages'],
57
+ 'totalItems': value['totalItems'],
58
+ 'items': (value['items'].map(GetContentGradesItemsInnerToJSON)),
59
+ };
60
+ }