@easyedu/js-lsm-api 1.15.0 → 1.17.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.
- package/.openapi-generator/FILES +29 -0
- package/README.md +2 -2
- package/dist/apis/ReportingApi.d.ts +120 -0
- package/dist/apis/ReportingApi.js +299 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/ReportingApi.d.ts +120 -0
- package/dist/esm/apis/ReportingApi.js +295 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/GetContentGradeDetail.d.ts +118 -0
- package/dist/esm/models/GetContentGradeDetail.js +104 -0
- package/dist/esm/models/GetContentGrades.d.ts +57 -0
- package/dist/esm/models/GetContentGrades.js +60 -0
- package/dist/esm/models/GetContentGradesItemsInner.d.ts +72 -0
- package/dist/esm/models/GetContentGradesItemsInner.js +73 -0
- package/dist/esm/models/GetContentGradesItemsInnerUser.d.ts +44 -0
- package/dist/esm/models/GetContentGradesItemsInnerUser.js +51 -0
- package/dist/esm/models/GetContentInstructorBasicReporting.d.ts +47 -0
- package/dist/esm/models/GetContentInstructorBasicReporting.js +54 -0
- package/dist/esm/models/GetContentInstructorBasicReportingContentInfo.d.ts +59 -0
- package/dist/esm/models/GetContentInstructorBasicReportingContentInfo.js +63 -0
- package/dist/esm/models/GetContentInstructorBasicReportingEngagement.d.ts +56 -0
- package/dist/esm/models/GetContentInstructorBasicReportingEngagement.js +59 -0
- package/dist/esm/models/GetContentInstructorBasicReportingPerformance.d.ts +38 -0
- package/dist/esm/models/GetContentInstructorBasicReportingPerformance.js +47 -0
- package/dist/esm/models/GetCourseStudentReporting.d.ts +47 -0
- package/dist/esm/models/GetCourseStudentReporting.js +54 -0
- package/dist/esm/models/GetCourseStudentReportingCourseInfo.d.ts +32 -0
- package/dist/esm/models/GetCourseStudentReportingCourseInfo.js +43 -0
- package/dist/esm/models/GetCourseStudentReportingEngagement.d.ts +38 -0
- package/dist/esm/models/GetCourseStudentReportingEngagement.js +47 -0
- package/dist/esm/models/GetCourseStudentReportingPerformance.d.ts +32 -0
- package/dist/esm/models/GetCourseStudentReportingPerformance.js +43 -0
- package/dist/esm/models/GetModuleInstructorBasicReporting.d.ts +47 -0
- package/dist/esm/models/GetModuleInstructorBasicReporting.js +54 -0
- package/dist/esm/models/GetModuleInstructorBasicReportingEngagement.d.ts +32 -0
- package/dist/esm/models/GetModuleInstructorBasicReportingEngagement.js +43 -0
- package/dist/esm/models/GetModuleInstructorBasicReportingModuleInfo.d.ts +32 -0
- package/dist/esm/models/GetModuleInstructorBasicReportingModuleInfo.js +43 -0
- package/dist/esm/models/GetModuleInstructorBasicReportingPerformance.d.ts +32 -0
- package/dist/esm/models/GetModuleInstructorBasicReportingPerformance.js +43 -0
- package/dist/esm/models/GetModuleStudentReporting.d.ts +47 -0
- package/dist/esm/models/GetModuleStudentReporting.js +54 -0
- package/dist/esm/models/GetModuleStudentReportingAccess.d.ts +38 -0
- package/dist/esm/models/GetModuleStudentReportingAccess.js +47 -0
- package/dist/esm/models/GetModuleStudentReportingProgress.d.ts +38 -0
- package/dist/esm/models/GetModuleStudentReportingProgress.js +47 -0
- package/dist/esm/models/GetPortalBasicReporting.d.ts +40 -0
- package/dist/esm/models/GetPortalBasicReporting.js +49 -0
- package/dist/esm/models/GetPortalBasicReportingCertificates.d.ts +32 -0
- package/dist/esm/models/GetPortalBasicReportingCertificates.js +43 -0
- package/dist/esm/models/GetPortalBasicReportingPortalInfo.d.ts +44 -0
- package/dist/esm/models/GetPortalBasicReportingPortalInfo.js +51 -0
- package/dist/esm/models/ScormSessionData.d.ts +61 -0
- package/dist/esm/models/ScormSessionData.js +54 -0
- package/dist/esm/models/ScormSessionDataProgress.d.ts +38 -0
- package/dist/esm/models/ScormSessionDataProgress.js +43 -0
- package/dist/esm/models/ScormSessionDataScore.d.ts +50 -0
- package/dist/esm/models/ScormSessionDataScore.js +47 -0
- package/dist/esm/models/ScormSessionDataSession.d.ts +32 -0
- package/dist/esm/models/ScormSessionDataSession.js +41 -0
- package/dist/esm/models/ScormSessionDataStatus.d.ts +50 -0
- package/dist/esm/models/ScormSessionDataStatus.js +47 -0
- package/dist/esm/models/ScormSessionDataTime.d.ts +50 -0
- package/dist/esm/models/ScormSessionDataTime.js +47 -0
- package/dist/esm/models/index.d.ts +28 -0
- package/dist/esm/models/index.js +28 -0
- package/dist/models/GetContentGradeDetail.d.ts +118 -0
- package/dist/models/GetContentGradeDetail.js +112 -0
- package/dist/models/GetContentGrades.d.ts +57 -0
- package/dist/models/GetContentGrades.js +67 -0
- package/dist/models/GetContentGradesItemsInner.d.ts +72 -0
- package/dist/models/GetContentGradesItemsInner.js +81 -0
- package/dist/models/GetContentGradesItemsInnerUser.d.ts +44 -0
- package/dist/models/GetContentGradesItemsInnerUser.js +58 -0
- package/dist/models/GetContentInstructorBasicReporting.d.ts +47 -0
- package/dist/models/GetContentInstructorBasicReporting.js +61 -0
- package/dist/models/GetContentInstructorBasicReportingContentInfo.d.ts +59 -0
- package/dist/models/GetContentInstructorBasicReportingContentInfo.js +71 -0
- package/dist/models/GetContentInstructorBasicReportingEngagement.d.ts +56 -0
- package/dist/models/GetContentInstructorBasicReportingEngagement.js +66 -0
- package/dist/models/GetContentInstructorBasicReportingPerformance.d.ts +38 -0
- package/dist/models/GetContentInstructorBasicReportingPerformance.js +54 -0
- package/dist/models/GetCourseStudentReporting.d.ts +47 -0
- package/dist/models/GetCourseStudentReporting.js +61 -0
- package/dist/models/GetCourseStudentReportingCourseInfo.d.ts +32 -0
- package/dist/models/GetCourseStudentReportingCourseInfo.js +50 -0
- package/dist/models/GetCourseStudentReportingEngagement.d.ts +38 -0
- package/dist/models/GetCourseStudentReportingEngagement.js +54 -0
- package/dist/models/GetCourseStudentReportingPerformance.d.ts +32 -0
- package/dist/models/GetCourseStudentReportingPerformance.js +50 -0
- package/dist/models/GetModuleInstructorBasicReporting.d.ts +47 -0
- package/dist/models/GetModuleInstructorBasicReporting.js +61 -0
- package/dist/models/GetModuleInstructorBasicReportingEngagement.d.ts +32 -0
- package/dist/models/GetModuleInstructorBasicReportingEngagement.js +50 -0
- package/dist/models/GetModuleInstructorBasicReportingModuleInfo.d.ts +32 -0
- package/dist/models/GetModuleInstructorBasicReportingModuleInfo.js +50 -0
- package/dist/models/GetModuleInstructorBasicReportingPerformance.d.ts +32 -0
- package/dist/models/GetModuleInstructorBasicReportingPerformance.js +50 -0
- package/dist/models/GetModuleStudentReporting.d.ts +47 -0
- package/dist/models/GetModuleStudentReporting.js +61 -0
- package/dist/models/GetModuleStudentReportingAccess.d.ts +38 -0
- package/dist/models/GetModuleStudentReportingAccess.js +54 -0
- package/dist/models/GetModuleStudentReportingProgress.d.ts +38 -0
- package/dist/models/GetModuleStudentReportingProgress.js +54 -0
- package/dist/models/GetPortalBasicReporting.d.ts +40 -0
- package/dist/models/GetPortalBasicReporting.js +56 -0
- package/dist/models/GetPortalBasicReportingCertificates.d.ts +32 -0
- package/dist/models/GetPortalBasicReportingCertificates.js +50 -0
- package/dist/models/GetPortalBasicReportingPortalInfo.d.ts +44 -0
- package/dist/models/GetPortalBasicReportingPortalInfo.js +58 -0
- package/dist/models/ScormSessionData.d.ts +61 -0
- package/dist/models/ScormSessionData.js +61 -0
- package/dist/models/ScormSessionDataProgress.d.ts +38 -0
- package/dist/models/ScormSessionDataProgress.js +50 -0
- package/dist/models/ScormSessionDataScore.d.ts +50 -0
- package/dist/models/ScormSessionDataScore.js +54 -0
- package/dist/models/ScormSessionDataSession.d.ts +32 -0
- package/dist/models/ScormSessionDataSession.js +48 -0
- package/dist/models/ScormSessionDataStatus.d.ts +50 -0
- package/dist/models/ScormSessionDataStatus.js +54 -0
- package/dist/models/ScormSessionDataTime.d.ts +50 -0
- package/dist/models/ScormSessionDataTime.js +54 -0
- package/dist/models/index.d.ts +28 -0
- package/dist/models/index.js +28 -0
- package/package.json +1 -1
- package/src/apis/ReportingApi.ts +450 -0
- package/src/apis/index.ts +1 -0
- package/src/models/GetContentGradeDetail.ts +191 -0
- package/src/models/GetContentGrades.ts +110 -0
- package/src/models/GetContentGradesItemsInner.ts +125 -0
- package/src/models/GetContentGradesItemsInnerUser.ts +84 -0
- package/src/models/GetContentInstructorBasicReporting.ts +106 -0
- package/src/models/GetContentInstructorBasicReportingContentInfo.ts +101 -0
- package/src/models/GetContentInstructorBasicReportingEngagement.ts +102 -0
- package/src/models/GetContentInstructorBasicReportingPerformance.ts +75 -0
- package/src/models/GetCourseStudentReporting.ts +106 -0
- package/src/models/GetCourseStudentReportingCourseInfo.ts +66 -0
- package/src/models/GetCourseStudentReportingEngagement.ts +75 -0
- package/src/models/GetCourseStudentReportingPerformance.ts +66 -0
- package/src/models/GetModuleInstructorBasicReporting.ts +106 -0
- package/src/models/GetModuleInstructorBasicReportingEngagement.ts +66 -0
- package/src/models/GetModuleInstructorBasicReportingModuleInfo.ts +66 -0
- package/src/models/GetModuleInstructorBasicReportingPerformance.ts +66 -0
- package/src/models/GetModuleStudentReporting.ts +106 -0
- package/src/models/GetModuleStudentReportingAccess.ts +75 -0
- package/src/models/GetModuleStudentReportingProgress.ts +75 -0
- package/src/models/GetPortalBasicReporting.ts +90 -0
- package/src/models/GetPortalBasicReportingCertificates.ts +66 -0
- package/src/models/GetPortalBasicReportingPortalInfo.ts +84 -0
- package/src/models/ScormSessionData.ts +133 -0
- package/src/models/ScormSessionDataProgress.ts +73 -0
- package/src/models/ScormSessionDataScore.ts +89 -0
- package/src/models/ScormSessionDataSession.ts +65 -0
- package/src/models/ScormSessionDataStatus.ts +89 -0
- package/src/models/ScormSessionDataTime.ts +89 -0
- package/src/models/index.ts +28 -0
|
@@ -0,0 +1,450 @@
|
|
|
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
|
+
|
|
15
|
+
|
|
16
|
+
import * as runtime from '../runtime';
|
|
17
|
+
import type {
|
|
18
|
+
GetContentGradeDetail,
|
|
19
|
+
GetContentGrades,
|
|
20
|
+
GetContentInstructorBasicReporting,
|
|
21
|
+
GetCourseReportingBasic,
|
|
22
|
+
GetCourseStudentReporting,
|
|
23
|
+
GetModuleInstructorBasicReporting,
|
|
24
|
+
GetModuleStudentReporting,
|
|
25
|
+
GetPortalBasicReporting,
|
|
26
|
+
} from '../models/index';
|
|
27
|
+
import {
|
|
28
|
+
GetContentGradeDetailFromJSON,
|
|
29
|
+
GetContentGradeDetailToJSON,
|
|
30
|
+
GetContentGradesFromJSON,
|
|
31
|
+
GetContentGradesToJSON,
|
|
32
|
+
GetContentInstructorBasicReportingFromJSON,
|
|
33
|
+
GetContentInstructorBasicReportingToJSON,
|
|
34
|
+
GetCourseReportingBasicFromJSON,
|
|
35
|
+
GetCourseReportingBasicToJSON,
|
|
36
|
+
GetCourseStudentReportingFromJSON,
|
|
37
|
+
GetCourseStudentReportingToJSON,
|
|
38
|
+
GetModuleInstructorBasicReportingFromJSON,
|
|
39
|
+
GetModuleInstructorBasicReportingToJSON,
|
|
40
|
+
GetModuleStudentReportingFromJSON,
|
|
41
|
+
GetModuleStudentReportingToJSON,
|
|
42
|
+
GetPortalBasicReportingFromJSON,
|
|
43
|
+
GetPortalBasicReportingToJSON,
|
|
44
|
+
} from '../models/index';
|
|
45
|
+
|
|
46
|
+
export interface GetContentGradeDetailRequest {
|
|
47
|
+
courseId: string;
|
|
48
|
+
moduleId: string;
|
|
49
|
+
contentId: string;
|
|
50
|
+
studentId: string;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
export interface GetContentGradesRequest {
|
|
54
|
+
courseId: string;
|
|
55
|
+
moduleId: string;
|
|
56
|
+
contentId: string;
|
|
57
|
+
page?: number;
|
|
58
|
+
pageSize?: number;
|
|
59
|
+
search?: string;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export interface GetContentInstructorBasicReportingRequest {
|
|
63
|
+
courseId: string;
|
|
64
|
+
moduleId: string;
|
|
65
|
+
contentId: string;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export interface GetCourseInstructorReportingBasicRequest {
|
|
69
|
+
courseId: string;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export interface GetCourseStudentReportingRequest {
|
|
73
|
+
courseId: string;
|
|
74
|
+
studentId: string;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export interface GetModuleInstructorBasicReportingRequest {
|
|
78
|
+
courseId: string;
|
|
79
|
+
moduleId: string;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
export interface GetModuleStudentReportingRequest {
|
|
83
|
+
courseId: string;
|
|
84
|
+
moduleId: string;
|
|
85
|
+
studentId: string;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
export interface GetPortalBasicReportingRequest {
|
|
89
|
+
portalId: string;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
*
|
|
94
|
+
*/
|
|
95
|
+
export class ReportingApi extends runtime.BaseAPI {
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* Get detailed grade information for a specific student and content
|
|
99
|
+
*/
|
|
100
|
+
async getContentGradeDetailRaw(requestParameters: GetContentGradeDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentGradeDetail>> {
|
|
101
|
+
if (requestParameters['courseId'] == null) {
|
|
102
|
+
throw new runtime.RequiredError(
|
|
103
|
+
'courseId',
|
|
104
|
+
'Required parameter "courseId" was null or undefined when calling getContentGradeDetail().'
|
|
105
|
+
);
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
if (requestParameters['moduleId'] == null) {
|
|
109
|
+
throw new runtime.RequiredError(
|
|
110
|
+
'moduleId',
|
|
111
|
+
'Required parameter "moduleId" was null or undefined when calling getContentGradeDetail().'
|
|
112
|
+
);
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
if (requestParameters['contentId'] == null) {
|
|
116
|
+
throw new runtime.RequiredError(
|
|
117
|
+
'contentId',
|
|
118
|
+
'Required parameter "contentId" was null or undefined when calling getContentGradeDetail().'
|
|
119
|
+
);
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
if (requestParameters['studentId'] == null) {
|
|
123
|
+
throw new runtime.RequiredError(
|
|
124
|
+
'studentId',
|
|
125
|
+
'Required parameter "studentId" was null or undefined when calling getContentGradeDetail().'
|
|
126
|
+
);
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
const queryParameters: any = {};
|
|
130
|
+
|
|
131
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
132
|
+
|
|
133
|
+
const response = await this.request({
|
|
134
|
+
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']))),
|
|
135
|
+
method: 'GET',
|
|
136
|
+
headers: headerParameters,
|
|
137
|
+
query: queryParameters,
|
|
138
|
+
}, initOverrides);
|
|
139
|
+
|
|
140
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetContentGradeDetailFromJSON(jsonValue));
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* Get detailed grade information for a specific student and content
|
|
145
|
+
*/
|
|
146
|
+
async getContentGradeDetail(requestParameters: GetContentGradeDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentGradeDetail> {
|
|
147
|
+
const response = await this.getContentGradeDetailRaw(requestParameters, initOverrides);
|
|
148
|
+
return await response.value();
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* Get grades for all students enrolled in course for specific content
|
|
153
|
+
*/
|
|
154
|
+
async getContentGradesRaw(requestParameters: GetContentGradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentGrades>> {
|
|
155
|
+
if (requestParameters['courseId'] == null) {
|
|
156
|
+
throw new runtime.RequiredError(
|
|
157
|
+
'courseId',
|
|
158
|
+
'Required parameter "courseId" was null or undefined when calling getContentGrades().'
|
|
159
|
+
);
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
if (requestParameters['moduleId'] == null) {
|
|
163
|
+
throw new runtime.RequiredError(
|
|
164
|
+
'moduleId',
|
|
165
|
+
'Required parameter "moduleId" was null or undefined when calling getContentGrades().'
|
|
166
|
+
);
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
if (requestParameters['contentId'] == null) {
|
|
170
|
+
throw new runtime.RequiredError(
|
|
171
|
+
'contentId',
|
|
172
|
+
'Required parameter "contentId" was null or undefined when calling getContentGrades().'
|
|
173
|
+
);
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
const queryParameters: any = {};
|
|
177
|
+
|
|
178
|
+
if (requestParameters['page'] != null) {
|
|
179
|
+
queryParameters['page'] = requestParameters['page'];
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
if (requestParameters['pageSize'] != null) {
|
|
183
|
+
queryParameters['pageSize'] = requestParameters['pageSize'];
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
if (requestParameters['search'] != null) {
|
|
187
|
+
queryParameters['search'] = requestParameters['search'];
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
191
|
+
|
|
192
|
+
const response = await this.request({
|
|
193
|
+
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']))),
|
|
194
|
+
method: 'GET',
|
|
195
|
+
headers: headerParameters,
|
|
196
|
+
query: queryParameters,
|
|
197
|
+
}, initOverrides);
|
|
198
|
+
|
|
199
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetContentGradesFromJSON(jsonValue));
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* Get grades for all students enrolled in course for specific content
|
|
204
|
+
*/
|
|
205
|
+
async getContentGrades(requestParameters: GetContentGradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentGrades> {
|
|
206
|
+
const response = await this.getContentGradesRaw(requestParameters, initOverrides);
|
|
207
|
+
return await response.value();
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* Get basic instructor reporting for content
|
|
212
|
+
*/
|
|
213
|
+
async getContentInstructorBasicReportingRaw(requestParameters: GetContentInstructorBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentInstructorBasicReporting>> {
|
|
214
|
+
if (requestParameters['courseId'] == null) {
|
|
215
|
+
throw new runtime.RequiredError(
|
|
216
|
+
'courseId',
|
|
217
|
+
'Required parameter "courseId" was null or undefined when calling getContentInstructorBasicReporting().'
|
|
218
|
+
);
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
if (requestParameters['moduleId'] == null) {
|
|
222
|
+
throw new runtime.RequiredError(
|
|
223
|
+
'moduleId',
|
|
224
|
+
'Required parameter "moduleId" was null or undefined when calling getContentInstructorBasicReporting().'
|
|
225
|
+
);
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
if (requestParameters['contentId'] == null) {
|
|
229
|
+
throw new runtime.RequiredError(
|
|
230
|
+
'contentId',
|
|
231
|
+
'Required parameter "contentId" was null or undefined when calling getContentInstructorBasicReporting().'
|
|
232
|
+
);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
const queryParameters: any = {};
|
|
236
|
+
|
|
237
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
238
|
+
|
|
239
|
+
const response = await this.request({
|
|
240
|
+
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']))),
|
|
241
|
+
method: 'GET',
|
|
242
|
+
headers: headerParameters,
|
|
243
|
+
query: queryParameters,
|
|
244
|
+
}, initOverrides);
|
|
245
|
+
|
|
246
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetContentInstructorBasicReportingFromJSON(jsonValue));
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
/**
|
|
250
|
+
* Get basic instructor reporting for content
|
|
251
|
+
*/
|
|
252
|
+
async getContentInstructorBasicReporting(requestParameters: GetContentInstructorBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentInstructorBasicReporting> {
|
|
253
|
+
const response = await this.getContentInstructorBasicReportingRaw(requestParameters, initOverrides);
|
|
254
|
+
return await response.value();
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
/**
|
|
258
|
+
* Get basic course reporting data for instructors
|
|
259
|
+
*/
|
|
260
|
+
async getCourseInstructorReportingBasicRaw(requestParameters: GetCourseInstructorReportingBasicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseReportingBasic>> {
|
|
261
|
+
if (requestParameters['courseId'] == null) {
|
|
262
|
+
throw new runtime.RequiredError(
|
|
263
|
+
'courseId',
|
|
264
|
+
'Required parameter "courseId" was null or undefined when calling getCourseInstructorReportingBasic().'
|
|
265
|
+
);
|
|
266
|
+
}
|
|
267
|
+
|
|
268
|
+
const queryParameters: any = {};
|
|
269
|
+
|
|
270
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
271
|
+
|
|
272
|
+
const response = await this.request({
|
|
273
|
+
path: `/courses/{courseId}/reporting/instructor/basic`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
274
|
+
method: 'GET',
|
|
275
|
+
headers: headerParameters,
|
|
276
|
+
query: queryParameters,
|
|
277
|
+
}, initOverrides);
|
|
278
|
+
|
|
279
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseReportingBasicFromJSON(jsonValue));
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* Get basic course reporting data for instructors
|
|
284
|
+
*/
|
|
285
|
+
async getCourseInstructorReportingBasic(requestParameters: GetCourseInstructorReportingBasicRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseReportingBasic> {
|
|
286
|
+
const response = await this.getCourseInstructorReportingBasicRaw(requestParameters, initOverrides);
|
|
287
|
+
return await response.value();
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
/**
|
|
291
|
+
* Get student-specific reporting for a course
|
|
292
|
+
*/
|
|
293
|
+
async getCourseStudentReportingRaw(requestParameters: GetCourseStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseStudentReporting>> {
|
|
294
|
+
if (requestParameters['courseId'] == null) {
|
|
295
|
+
throw new runtime.RequiredError(
|
|
296
|
+
'courseId',
|
|
297
|
+
'Required parameter "courseId" was null or undefined when calling getCourseStudentReporting().'
|
|
298
|
+
);
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
if (requestParameters['studentId'] == null) {
|
|
302
|
+
throw new runtime.RequiredError(
|
|
303
|
+
'studentId',
|
|
304
|
+
'Required parameter "studentId" was null or undefined when calling getCourseStudentReporting().'
|
|
305
|
+
);
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
const queryParameters: any = {};
|
|
309
|
+
|
|
310
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
311
|
+
|
|
312
|
+
const response = await this.request({
|
|
313
|
+
path: `/courses/{courseId}/reporting/students/{studentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"studentId"}}`, encodeURIComponent(String(requestParameters['studentId']))),
|
|
314
|
+
method: 'GET',
|
|
315
|
+
headers: headerParameters,
|
|
316
|
+
query: queryParameters,
|
|
317
|
+
}, initOverrides);
|
|
318
|
+
|
|
319
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseStudentReportingFromJSON(jsonValue));
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
* Get student-specific reporting for a course
|
|
324
|
+
*/
|
|
325
|
+
async getCourseStudentReporting(requestParameters: GetCourseStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseStudentReporting> {
|
|
326
|
+
const response = await this.getCourseStudentReportingRaw(requestParameters, initOverrides);
|
|
327
|
+
return await response.value();
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
/**
|
|
331
|
+
* Get basic instructor reporting for a module
|
|
332
|
+
*/
|
|
333
|
+
async getModuleInstructorBasicReportingRaw(requestParameters: GetModuleInstructorBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetModuleInstructorBasicReporting>> {
|
|
334
|
+
if (requestParameters['courseId'] == null) {
|
|
335
|
+
throw new runtime.RequiredError(
|
|
336
|
+
'courseId',
|
|
337
|
+
'Required parameter "courseId" was null or undefined when calling getModuleInstructorBasicReporting().'
|
|
338
|
+
);
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
if (requestParameters['moduleId'] == null) {
|
|
342
|
+
throw new runtime.RequiredError(
|
|
343
|
+
'moduleId',
|
|
344
|
+
'Required parameter "moduleId" was null or undefined when calling getModuleInstructorBasicReporting().'
|
|
345
|
+
);
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
const queryParameters: any = {};
|
|
349
|
+
|
|
350
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
351
|
+
|
|
352
|
+
const response = await this.request({
|
|
353
|
+
path: `/courses/{courseId}/modules/{moduleId}/reporting/instructor/basic`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))),
|
|
354
|
+
method: 'GET',
|
|
355
|
+
headers: headerParameters,
|
|
356
|
+
query: queryParameters,
|
|
357
|
+
}, initOverrides);
|
|
358
|
+
|
|
359
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetModuleInstructorBasicReportingFromJSON(jsonValue));
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
/**
|
|
363
|
+
* Get basic instructor reporting for a module
|
|
364
|
+
*/
|
|
365
|
+
async getModuleInstructorBasicReporting(requestParameters: GetModuleInstructorBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetModuleInstructorBasicReporting> {
|
|
366
|
+
const response = await this.getModuleInstructorBasicReportingRaw(requestParameters, initOverrides);
|
|
367
|
+
return await response.value();
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
/**
|
|
371
|
+
* Get student-specific reporting for a module
|
|
372
|
+
*/
|
|
373
|
+
async getModuleStudentReportingRaw(requestParameters: GetModuleStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetModuleStudentReporting>> {
|
|
374
|
+
if (requestParameters['courseId'] == null) {
|
|
375
|
+
throw new runtime.RequiredError(
|
|
376
|
+
'courseId',
|
|
377
|
+
'Required parameter "courseId" was null or undefined when calling getModuleStudentReporting().'
|
|
378
|
+
);
|
|
379
|
+
}
|
|
380
|
+
|
|
381
|
+
if (requestParameters['moduleId'] == null) {
|
|
382
|
+
throw new runtime.RequiredError(
|
|
383
|
+
'moduleId',
|
|
384
|
+
'Required parameter "moduleId" was null or undefined when calling getModuleStudentReporting().'
|
|
385
|
+
);
|
|
386
|
+
}
|
|
387
|
+
|
|
388
|
+
if (requestParameters['studentId'] == null) {
|
|
389
|
+
throw new runtime.RequiredError(
|
|
390
|
+
'studentId',
|
|
391
|
+
'Required parameter "studentId" was null or undefined when calling getModuleStudentReporting().'
|
|
392
|
+
);
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
const queryParameters: any = {};
|
|
396
|
+
|
|
397
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
398
|
+
|
|
399
|
+
const response = await this.request({
|
|
400
|
+
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']))),
|
|
401
|
+
method: 'GET',
|
|
402
|
+
headers: headerParameters,
|
|
403
|
+
query: queryParameters,
|
|
404
|
+
}, initOverrides);
|
|
405
|
+
|
|
406
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetModuleStudentReportingFromJSON(jsonValue));
|
|
407
|
+
}
|
|
408
|
+
|
|
409
|
+
/**
|
|
410
|
+
* Get student-specific reporting for a module
|
|
411
|
+
*/
|
|
412
|
+
async getModuleStudentReporting(requestParameters: GetModuleStudentReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetModuleStudentReporting> {
|
|
413
|
+
const response = await this.getModuleStudentReportingRaw(requestParameters, initOverrides);
|
|
414
|
+
return await response.value();
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
/**
|
|
418
|
+
* Get basic reporting for a portal
|
|
419
|
+
*/
|
|
420
|
+
async getPortalBasicReportingRaw(requestParameters: GetPortalBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalBasicReporting>> {
|
|
421
|
+
if (requestParameters['portalId'] == null) {
|
|
422
|
+
throw new runtime.RequiredError(
|
|
423
|
+
'portalId',
|
|
424
|
+
'Required parameter "portalId" was null or undefined when calling getPortalBasicReporting().'
|
|
425
|
+
);
|
|
426
|
+
}
|
|
427
|
+
|
|
428
|
+
const queryParameters: any = {};
|
|
429
|
+
|
|
430
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
431
|
+
|
|
432
|
+
const response = await this.request({
|
|
433
|
+
path: `/portals/{portalId}/reporting/basic`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
|
|
434
|
+
method: 'GET',
|
|
435
|
+
headers: headerParameters,
|
|
436
|
+
query: queryParameters,
|
|
437
|
+
}, initOverrides);
|
|
438
|
+
|
|
439
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalBasicReportingFromJSON(jsonValue));
|
|
440
|
+
}
|
|
441
|
+
|
|
442
|
+
/**
|
|
443
|
+
* Get basic reporting for a portal
|
|
444
|
+
*/
|
|
445
|
+
async getPortalBasicReporting(requestParameters: GetPortalBasicReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalBasicReporting> {
|
|
446
|
+
const response = await this.getPortalBasicReportingRaw(requestParameters, initOverrides);
|
|
447
|
+
return await response.value();
|
|
448
|
+
}
|
|
449
|
+
|
|
450
|
+
}
|
package/src/apis/index.ts
CHANGED
|
@@ -0,0 +1,191 @@
|
|
|
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
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { ScormSessionData } from './ScormSessionData';
|
|
17
|
+
import {
|
|
18
|
+
ScormSessionDataFromJSON,
|
|
19
|
+
ScormSessionDataFromJSONTyped,
|
|
20
|
+
ScormSessionDataToJSON,
|
|
21
|
+
ScormSessionDataToJSONTyped,
|
|
22
|
+
} from './ScormSessionData';
|
|
23
|
+
import type { GetContentGradesItemsInnerUser } from './GetContentGradesItemsInnerUser';
|
|
24
|
+
import {
|
|
25
|
+
GetContentGradesItemsInnerUserFromJSON,
|
|
26
|
+
GetContentGradesItemsInnerUserFromJSONTyped,
|
|
27
|
+
GetContentGradesItemsInnerUserToJSON,
|
|
28
|
+
GetContentGradesItemsInnerUserToJSONTyped,
|
|
29
|
+
} from './GetContentGradesItemsInnerUser';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
* @interface GetContentGradeDetail
|
|
35
|
+
*/
|
|
36
|
+
export interface GetContentGradeDetail {
|
|
37
|
+
/**
|
|
38
|
+
* Content session external ID
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof GetContentGradeDetail
|
|
41
|
+
*/
|
|
42
|
+
id?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {GetContentGradesItemsInnerUser}
|
|
46
|
+
* @memberof GetContentGradeDetail
|
|
47
|
+
*/
|
|
48
|
+
user: GetContentGradesItemsInnerUser;
|
|
49
|
+
/**
|
|
50
|
+
* Content completion status
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof GetContentGradeDetail
|
|
53
|
+
*/
|
|
54
|
+
completion: GetContentGradeDetailCompletionEnum;
|
|
55
|
+
/**
|
|
56
|
+
* Content grade status
|
|
57
|
+
* @type {string}
|
|
58
|
+
* @memberof GetContentGradeDetail
|
|
59
|
+
*/
|
|
60
|
+
gradeStatus: GetContentGradeDetailGradeStatusEnum;
|
|
61
|
+
/**
|
|
62
|
+
* Content session creation timestamp (epoch seconds)
|
|
63
|
+
* @type {number}
|
|
64
|
+
* @memberof GetContentGradeDetail
|
|
65
|
+
*/
|
|
66
|
+
createdAt: number | null;
|
|
67
|
+
/**
|
|
68
|
+
* Content session last update timestamp (epoch seconds)
|
|
69
|
+
* @type {number}
|
|
70
|
+
* @memberof GetContentGradeDetail
|
|
71
|
+
*/
|
|
72
|
+
updatedAt: number | null;
|
|
73
|
+
/**
|
|
74
|
+
* Type of content
|
|
75
|
+
* @type {string}
|
|
76
|
+
* @memberof GetContentGradeDetail
|
|
77
|
+
*/
|
|
78
|
+
contentType: GetContentGradeDetailContentTypeEnum;
|
|
79
|
+
/**
|
|
80
|
+
* Number of attempts for this content
|
|
81
|
+
* @type {number}
|
|
82
|
+
* @memberof GetContentGradeDetail
|
|
83
|
+
*/
|
|
84
|
+
attemptCount?: number | null;
|
|
85
|
+
/**
|
|
86
|
+
*
|
|
87
|
+
* @type {ScormSessionData}
|
|
88
|
+
* @memberof GetContentGradeDetail
|
|
89
|
+
*/
|
|
90
|
+
scormData?: ScormSessionData;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* @export
|
|
96
|
+
*/
|
|
97
|
+
export const GetContentGradeDetailCompletionEnum = {
|
|
98
|
+
NotAttempted: 'NotAttempted',
|
|
99
|
+
InProgress: 'InProgress',
|
|
100
|
+
Completed: 'Completed'
|
|
101
|
+
} as const;
|
|
102
|
+
export type GetContentGradeDetailCompletionEnum = typeof GetContentGradeDetailCompletionEnum[keyof typeof GetContentGradeDetailCompletionEnum];
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* @export
|
|
106
|
+
*/
|
|
107
|
+
export const GetContentGradeDetailGradeStatusEnum = {
|
|
108
|
+
Ungraded: 'Ungraded',
|
|
109
|
+
Passed: 'Passed',
|
|
110
|
+
Failed: 'Failed',
|
|
111
|
+
PointsEarned: 'PointsEarned',
|
|
112
|
+
PercentageEarned: 'PercentageEarned',
|
|
113
|
+
NotApplicable: 'NotApplicable'
|
|
114
|
+
} as const;
|
|
115
|
+
export type GetContentGradeDetailGradeStatusEnum = typeof GetContentGradeDetailGradeStatusEnum[keyof typeof GetContentGradeDetailGradeStatusEnum];
|
|
116
|
+
|
|
117
|
+
/**
|
|
118
|
+
* @export
|
|
119
|
+
*/
|
|
120
|
+
export const GetContentGradeDetailContentTypeEnum = {
|
|
121
|
+
Scorm: 'Scorm',
|
|
122
|
+
Video: 'Video',
|
|
123
|
+
Audio: 'Audio',
|
|
124
|
+
Image: 'Image',
|
|
125
|
+
Text: 'Text',
|
|
126
|
+
Link: 'Link',
|
|
127
|
+
File: 'File',
|
|
128
|
+
Pdf: 'Pdf',
|
|
129
|
+
Quiz: 'Quiz'
|
|
130
|
+
} as const;
|
|
131
|
+
export type GetContentGradeDetailContentTypeEnum = typeof GetContentGradeDetailContentTypeEnum[keyof typeof GetContentGradeDetailContentTypeEnum];
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
/**
|
|
135
|
+
* Check if a given object implements the GetContentGradeDetail interface.
|
|
136
|
+
*/
|
|
137
|
+
export function instanceOfGetContentGradeDetail(value: object): value is GetContentGradeDetail {
|
|
138
|
+
if (!('user' in value) || value['user'] === undefined) return false;
|
|
139
|
+
if (!('completion' in value) || value['completion'] === undefined) return false;
|
|
140
|
+
if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
|
|
141
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
|
|
142
|
+
if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
|
|
143
|
+
if (!('contentType' in value) || value['contentType'] === undefined) return false;
|
|
144
|
+
return true;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
export function GetContentGradeDetailFromJSON(json: any): GetContentGradeDetail {
|
|
148
|
+
return GetContentGradeDetailFromJSONTyped(json, false);
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
export function GetContentGradeDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentGradeDetail {
|
|
152
|
+
if (json == null) {
|
|
153
|
+
return json;
|
|
154
|
+
}
|
|
155
|
+
return {
|
|
156
|
+
|
|
157
|
+
'id': json['id'] == null ? undefined : json['id'],
|
|
158
|
+
'user': GetContentGradesItemsInnerUserFromJSON(json['user']),
|
|
159
|
+
'completion': json['completion'],
|
|
160
|
+
'gradeStatus': json['grade_status'],
|
|
161
|
+
'createdAt': json['created_at'],
|
|
162
|
+
'updatedAt': json['updated_at'],
|
|
163
|
+
'contentType': json['content_type'],
|
|
164
|
+
'attemptCount': json['attempt_count'] == null ? undefined : json['attempt_count'],
|
|
165
|
+
'scormData': json['scorm_data'] == null ? undefined : ScormSessionDataFromJSON(json['scorm_data']),
|
|
166
|
+
};
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
export function GetContentGradeDetailToJSON(json: any): GetContentGradeDetail {
|
|
170
|
+
return GetContentGradeDetailToJSONTyped(json, false);
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
export function GetContentGradeDetailToJSONTyped(value?: GetContentGradeDetail | null, ignoreDiscriminator: boolean = false): any {
|
|
174
|
+
if (value == null) {
|
|
175
|
+
return value;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
return {
|
|
179
|
+
|
|
180
|
+
'id': value['id'],
|
|
181
|
+
'user': GetContentGradesItemsInnerUserToJSON(value['user']),
|
|
182
|
+
'completion': value['completion'],
|
|
183
|
+
'grade_status': value['gradeStatus'],
|
|
184
|
+
'created_at': value['createdAt'],
|
|
185
|
+
'updated_at': value['updatedAt'],
|
|
186
|
+
'content_type': value['contentType'],
|
|
187
|
+
'attempt_count': value['attemptCount'],
|
|
188
|
+
'scorm_data': ScormSessionDataToJSON(value['scormData']),
|
|
189
|
+
};
|
|
190
|
+
}
|
|
191
|
+
|