@easyedu/js-lsm-api 1.8.0 → 1.10.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 +2 -0
- package/README.md +2 -2
- package/dist/apis/CourseApi.d.ts +37 -9
- package/dist/apis/CourseApi.js +81 -11
- package/dist/apis/PortalApi.d.ts +1 -0
- package/dist/apis/PortalApi.js +3 -0
- package/dist/esm/apis/CourseApi.d.ts +37 -9
- package/dist/esm/apis/CourseApi.js +82 -12
- package/dist/esm/apis/PortalApi.d.ts +1 -0
- package/dist/esm/apis/PortalApi.js +3 -0
- package/dist/esm/models/GetCourseEnrollment.d.ts +9 -5
- package/dist/esm/models/GetCourseEnrollment.js +5 -3
- package/dist/esm/models/GetCourseEnrollmentList.d.ts +3 -3
- package/dist/esm/models/GetCourseEnrollmentList.js +3 -3
- package/dist/esm/models/GetCourseEnrollmentListItem.d.ts +89 -0
- package/dist/esm/models/GetCourseEnrollmentListItem.js +83 -0
- package/dist/esm/models/PostContentSession.d.ts +6 -0
- package/dist/esm/models/PostContentSession.js +2 -0
- package/dist/esm/models/PostCourseEnrollment.d.ts +13 -7
- package/dist/esm/models/PostCourseEnrollment.js +4 -4
- package/dist/esm/models/PutCourseEnrollment.d.ts +53 -0
- package/dist/esm/models/PutCourseEnrollment.js +53 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/GetCourseEnrollment.d.ts +9 -5
- package/dist/models/GetCourseEnrollment.js +5 -3
- package/dist/models/GetCourseEnrollmentList.d.ts +3 -3
- package/dist/models/GetCourseEnrollmentList.js +3 -3
- package/dist/models/GetCourseEnrollmentListItem.d.ts +89 -0
- package/dist/models/GetCourseEnrollmentListItem.js +91 -0
- package/dist/models/PostContentSession.d.ts +6 -0
- package/dist/models/PostContentSession.js +2 -0
- package/dist/models/PostCourseEnrollment.d.ts +13 -7
- package/dist/models/PostCourseEnrollment.js +4 -4
- package/dist/models/PutCourseEnrollment.d.ts +53 -0
- package/dist/models/PutCourseEnrollment.js +61 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/package.json +1 -1
- package/src/apis/CourseApi.ts +124 -12
- package/src/apis/PortalApi.ts +5 -0
- package/src/models/GetCourseEnrollment.ts +12 -5
- package/src/models/GetCourseEnrollmentList.ts +10 -10
- package/src/models/GetCourseEnrollmentListItem.ts +150 -0
- package/src/models/PostContentSession.ts +8 -0
- package/src/models/PostCourseEnrollment.ts +17 -10
- package/src/models/PutCourseEnrollment.ts +93 -0
- package/src/models/index.ts +2 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -26,6 +26,7 @@ src/models/GetContentUpload.ts
|
|
|
26
26
|
src/models/GetCourse.ts
|
|
27
27
|
src/models/GetCourseEnrollment.ts
|
|
28
28
|
src/models/GetCourseEnrollmentList.ts
|
|
29
|
+
src/models/GetCourseEnrollmentListItem.ts
|
|
29
30
|
src/models/GetCourseList.ts
|
|
30
31
|
src/models/GetModule.ts
|
|
31
32
|
src/models/GetModuleList.ts
|
|
@@ -127,6 +128,7 @@ src/models/PostResetPassword.ts
|
|
|
127
128
|
src/models/PostSendResetPassword.ts
|
|
128
129
|
src/models/PutContent.ts
|
|
129
130
|
src/models/PutCourse.ts
|
|
131
|
+
src/models/PutCourseEnrollment.ts
|
|
130
132
|
src/models/PutModule.ts
|
|
131
133
|
src/models/PutPortalBranding.ts
|
|
132
134
|
src/models/PutQuestion.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @easyedu/js-lsm-api@1.
|
|
1
|
+
## @easyedu/js-lsm-api@1.10.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @easyedu/js-lsm-api@1.
|
|
39
|
+
npm install @easyedu/js-lsm-api@1.10.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/dist/apis/CourseApi.d.ts
CHANGED
|
@@ -10,12 +10,19 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { GetCourse, GetCourseEnrollment, GetCourseEnrollmentList, GetCourseList, PostCourse, PostCourseEnrollment, PutCourse } from '../models/index';
|
|
13
|
+
import type { GetCourse, GetCourseEnrollment, GetCourseEnrollmentList, GetCourseList, PostCourse, PostCourseEnrollment, PutCourse, PutCourseEnrollment } from '../models/index';
|
|
14
14
|
export interface GetCourseRequest {
|
|
15
15
|
courseId: string;
|
|
16
16
|
}
|
|
17
17
|
export interface GetCourseEnrollmentRequest {
|
|
18
18
|
courseId: string;
|
|
19
|
+
enrollmentId: string;
|
|
20
|
+
}
|
|
21
|
+
export interface GetCourseEnrollmentsRequest {
|
|
22
|
+
courseId: string;
|
|
23
|
+
}
|
|
24
|
+
export interface GetCourseListRequest {
|
|
25
|
+
enrolled?: boolean;
|
|
19
26
|
}
|
|
20
27
|
export interface PostCourseRequest {
|
|
21
28
|
postCourse: PostCourse;
|
|
@@ -28,6 +35,11 @@ export interface PutCourseRequest {
|
|
|
28
35
|
courseId: string;
|
|
29
36
|
putCourse: Omit<PutCourse, 'id'>;
|
|
30
37
|
}
|
|
38
|
+
export interface PutCourseEnrollmentRequest {
|
|
39
|
+
courseId: string;
|
|
40
|
+
enrollmentId: string;
|
|
41
|
+
putCourseEnrollment: PutCourseEnrollment;
|
|
42
|
+
}
|
|
31
43
|
/**
|
|
32
44
|
*
|
|
33
45
|
*/
|
|
@@ -41,21 +53,29 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
41
53
|
*/
|
|
42
54
|
getCourse(requestParameters: GetCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
43
55
|
/**
|
|
44
|
-
*
|
|
56
|
+
* Get a specific course enrollment
|
|
57
|
+
*/
|
|
58
|
+
getCourseEnrollmentRaw(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
|
|
59
|
+
/**
|
|
60
|
+
* Get a specific course enrollment
|
|
45
61
|
*/
|
|
46
|
-
|
|
62
|
+
getCourseEnrollment(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
47
63
|
/**
|
|
48
|
-
*
|
|
64
|
+
* Get course enrollments
|
|
49
65
|
*/
|
|
50
|
-
|
|
66
|
+
getCourseEnrollmentsRaw(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollmentList>>;
|
|
67
|
+
/**
|
|
68
|
+
* Get course enrollments
|
|
69
|
+
*/
|
|
70
|
+
getCourseEnrollments(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollmentList>;
|
|
51
71
|
/**
|
|
52
72
|
* get course list
|
|
53
73
|
*/
|
|
54
|
-
getCourseListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseList>>;
|
|
74
|
+
getCourseListRaw(requestParameters: GetCourseListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseList>>;
|
|
55
75
|
/**
|
|
56
76
|
* get course list
|
|
57
77
|
*/
|
|
58
|
-
getCourseList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseList>;
|
|
78
|
+
getCourseList(requestParameters?: GetCourseListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseList>;
|
|
59
79
|
/**
|
|
60
80
|
* Post a new course
|
|
61
81
|
*/
|
|
@@ -65,11 +85,11 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
65
85
|
*/
|
|
66
86
|
postCourse(requestParameters: PostCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
67
87
|
/**
|
|
68
|
-
*
|
|
88
|
+
* Create a new course enrollment
|
|
69
89
|
*/
|
|
70
90
|
postCourseEnrollmentRaw(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
|
|
71
91
|
/**
|
|
72
|
-
*
|
|
92
|
+
* Create a new course enrollment
|
|
73
93
|
*/
|
|
74
94
|
postCourseEnrollment(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
75
95
|
/**
|
|
@@ -80,4 +100,12 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
80
100
|
* Update a course by id
|
|
81
101
|
*/
|
|
82
102
|
putCourse(requestParameters: PutCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
103
|
+
/**
|
|
104
|
+
* Update a course enrollment
|
|
105
|
+
*/
|
|
106
|
+
putCourseEnrollmentRaw(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
|
|
107
|
+
/**
|
|
108
|
+
* Update a course enrollment
|
|
109
|
+
*/
|
|
110
|
+
putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
83
111
|
}
|
package/dist/apis/CourseApi.js
CHANGED
|
@@ -58,26 +58,29 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
58
58
|
});
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* Get a specific course enrollment
|
|
62
62
|
*/
|
|
63
63
|
getCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
64
64
|
return __awaiter(this, void 0, void 0, function* () {
|
|
65
65
|
if (requestParameters['courseId'] == null) {
|
|
66
66
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseEnrollment().');
|
|
67
67
|
}
|
|
68
|
+
if (requestParameters['enrollmentId'] == null) {
|
|
69
|
+
throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling getCourseEnrollment().');
|
|
70
|
+
}
|
|
68
71
|
const queryParameters = {};
|
|
69
72
|
const headerParameters = {};
|
|
70
73
|
const response = yield this.request({
|
|
71
|
-
path: `/courses/{courseId}/
|
|
74
|
+
path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
|
|
72
75
|
method: 'GET',
|
|
73
76
|
headers: headerParameters,
|
|
74
77
|
query: queryParameters,
|
|
75
78
|
}, initOverrides);
|
|
76
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.
|
|
79
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetCourseEnrollmentFromJSON)(jsonValue));
|
|
77
80
|
});
|
|
78
81
|
}
|
|
79
82
|
/**
|
|
80
|
-
*
|
|
83
|
+
* Get a specific course enrollment
|
|
81
84
|
*/
|
|
82
85
|
getCourseEnrollment(requestParameters, initOverrides) {
|
|
83
86
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -85,12 +88,43 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
85
88
|
return yield response.value();
|
|
86
89
|
});
|
|
87
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* Get course enrollments
|
|
93
|
+
*/
|
|
94
|
+
getCourseEnrollmentsRaw(requestParameters, initOverrides) {
|
|
95
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
96
|
+
if (requestParameters['courseId'] == null) {
|
|
97
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseEnrollments().');
|
|
98
|
+
}
|
|
99
|
+
const queryParameters = {};
|
|
100
|
+
const headerParameters = {};
|
|
101
|
+
const response = yield this.request({
|
|
102
|
+
path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
103
|
+
method: 'GET',
|
|
104
|
+
headers: headerParameters,
|
|
105
|
+
query: queryParameters,
|
|
106
|
+
}, initOverrides);
|
|
107
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetCourseEnrollmentListFromJSON)(jsonValue));
|
|
108
|
+
});
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Get course enrollments
|
|
112
|
+
*/
|
|
113
|
+
getCourseEnrollments(requestParameters, initOverrides) {
|
|
114
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
115
|
+
const response = yield this.getCourseEnrollmentsRaw(requestParameters, initOverrides);
|
|
116
|
+
return yield response.value();
|
|
117
|
+
});
|
|
118
|
+
}
|
|
88
119
|
/**
|
|
89
120
|
* get course list
|
|
90
121
|
*/
|
|
91
|
-
getCourseListRaw(initOverrides) {
|
|
122
|
+
getCourseListRaw(requestParameters, initOverrides) {
|
|
92
123
|
return __awaiter(this, void 0, void 0, function* () {
|
|
93
124
|
const queryParameters = {};
|
|
125
|
+
if (requestParameters['enrolled'] != null) {
|
|
126
|
+
queryParameters['enrolled'] = requestParameters['enrolled'];
|
|
127
|
+
}
|
|
94
128
|
const headerParameters = {};
|
|
95
129
|
const response = yield this.request({
|
|
96
130
|
path: `/courses`,
|
|
@@ -104,9 +138,9 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
104
138
|
/**
|
|
105
139
|
* get course list
|
|
106
140
|
*/
|
|
107
|
-
getCourseList(
|
|
108
|
-
return __awaiter(this,
|
|
109
|
-
const response = yield this.getCourseListRaw(initOverrides);
|
|
141
|
+
getCourseList() {
|
|
142
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
143
|
+
const response = yield this.getCourseListRaw(requestParameters, initOverrides);
|
|
110
144
|
return yield response.value();
|
|
111
145
|
});
|
|
112
146
|
}
|
|
@@ -141,7 +175,7 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
141
175
|
});
|
|
142
176
|
}
|
|
143
177
|
/**
|
|
144
|
-
*
|
|
178
|
+
* Create a new course enrollment
|
|
145
179
|
*/
|
|
146
180
|
postCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
147
181
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -155,7 +189,7 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
155
189
|
const headerParameters = {};
|
|
156
190
|
headerParameters['Content-Type'] = 'application/json';
|
|
157
191
|
const response = yield this.request({
|
|
158
|
-
path: `/courses/{courseId}/
|
|
192
|
+
path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
159
193
|
method: 'POST',
|
|
160
194
|
headers: headerParameters,
|
|
161
195
|
query: queryParameters,
|
|
@@ -165,7 +199,7 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
165
199
|
});
|
|
166
200
|
}
|
|
167
201
|
/**
|
|
168
|
-
*
|
|
202
|
+
* Create a new course enrollment
|
|
169
203
|
*/
|
|
170
204
|
postCourseEnrollment(requestParameters, initOverrides) {
|
|
171
205
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -206,5 +240,41 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
206
240
|
return yield response.value();
|
|
207
241
|
});
|
|
208
242
|
}
|
|
243
|
+
/**
|
|
244
|
+
* Update a course enrollment
|
|
245
|
+
*/
|
|
246
|
+
putCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
247
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
248
|
+
if (requestParameters['courseId'] == null) {
|
|
249
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putCourseEnrollment().');
|
|
250
|
+
}
|
|
251
|
+
if (requestParameters['enrollmentId'] == null) {
|
|
252
|
+
throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling putCourseEnrollment().');
|
|
253
|
+
}
|
|
254
|
+
if (requestParameters['putCourseEnrollment'] == null) {
|
|
255
|
+
throw new runtime.RequiredError('putCourseEnrollment', 'Required parameter "putCourseEnrollment" was null or undefined when calling putCourseEnrollment().');
|
|
256
|
+
}
|
|
257
|
+
const queryParameters = {};
|
|
258
|
+
const headerParameters = {};
|
|
259
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
260
|
+
const response = yield this.request({
|
|
261
|
+
path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
|
|
262
|
+
method: 'PUT',
|
|
263
|
+
headers: headerParameters,
|
|
264
|
+
query: queryParameters,
|
|
265
|
+
body: (0, index_1.PutCourseEnrollmentToJSON)(requestParameters['putCourseEnrollment']),
|
|
266
|
+
}, initOverrides);
|
|
267
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetCourseEnrollmentFromJSON)(jsonValue));
|
|
268
|
+
});
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* Update a course enrollment
|
|
272
|
+
*/
|
|
273
|
+
putCourseEnrollment(requestParameters, initOverrides) {
|
|
274
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
275
|
+
const response = yield this.putCourseEnrollmentRaw(requestParameters, initOverrides);
|
|
276
|
+
return yield response.value();
|
|
277
|
+
});
|
|
278
|
+
}
|
|
209
279
|
}
|
|
210
280
|
exports.CourseApi = CourseApi;
|
package/dist/apis/PortalApi.d.ts
CHANGED
package/dist/apis/PortalApi.js
CHANGED
|
@@ -94,6 +94,9 @@ class PortalApi extends runtime.BaseAPI {
|
|
|
94
94
|
if (requestParameters['roles'] != null) {
|
|
95
95
|
queryParameters['roles'] = requestParameters['roles'];
|
|
96
96
|
}
|
|
97
|
+
if (requestParameters['search'] != null) {
|
|
98
|
+
queryParameters['search'] = requestParameters['search'];
|
|
99
|
+
}
|
|
97
100
|
if (requestParameters['page'] != null) {
|
|
98
101
|
queryParameters['page'] = requestParameters['page'];
|
|
99
102
|
}
|
|
@@ -10,12 +10,19 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { GetCourse, GetCourseEnrollment, GetCourseEnrollmentList, GetCourseList, PostCourse, PostCourseEnrollment, PutCourse } from '../models/index';
|
|
13
|
+
import type { GetCourse, GetCourseEnrollment, GetCourseEnrollmentList, GetCourseList, PostCourse, PostCourseEnrollment, PutCourse, PutCourseEnrollment } from '../models/index';
|
|
14
14
|
export interface GetCourseRequest {
|
|
15
15
|
courseId: string;
|
|
16
16
|
}
|
|
17
17
|
export interface GetCourseEnrollmentRequest {
|
|
18
18
|
courseId: string;
|
|
19
|
+
enrollmentId: string;
|
|
20
|
+
}
|
|
21
|
+
export interface GetCourseEnrollmentsRequest {
|
|
22
|
+
courseId: string;
|
|
23
|
+
}
|
|
24
|
+
export interface GetCourseListRequest {
|
|
25
|
+
enrolled?: boolean;
|
|
19
26
|
}
|
|
20
27
|
export interface PostCourseRequest {
|
|
21
28
|
postCourse: PostCourse;
|
|
@@ -28,6 +35,11 @@ export interface PutCourseRequest {
|
|
|
28
35
|
courseId: string;
|
|
29
36
|
putCourse: Omit<PutCourse, 'id'>;
|
|
30
37
|
}
|
|
38
|
+
export interface PutCourseEnrollmentRequest {
|
|
39
|
+
courseId: string;
|
|
40
|
+
enrollmentId: string;
|
|
41
|
+
putCourseEnrollment: PutCourseEnrollment;
|
|
42
|
+
}
|
|
31
43
|
/**
|
|
32
44
|
*
|
|
33
45
|
*/
|
|
@@ -41,21 +53,29 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
41
53
|
*/
|
|
42
54
|
getCourse(requestParameters: GetCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
43
55
|
/**
|
|
44
|
-
*
|
|
56
|
+
* Get a specific course enrollment
|
|
57
|
+
*/
|
|
58
|
+
getCourseEnrollmentRaw(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
|
|
59
|
+
/**
|
|
60
|
+
* Get a specific course enrollment
|
|
45
61
|
*/
|
|
46
|
-
|
|
62
|
+
getCourseEnrollment(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
47
63
|
/**
|
|
48
|
-
*
|
|
64
|
+
* Get course enrollments
|
|
49
65
|
*/
|
|
50
|
-
|
|
66
|
+
getCourseEnrollmentsRaw(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollmentList>>;
|
|
67
|
+
/**
|
|
68
|
+
* Get course enrollments
|
|
69
|
+
*/
|
|
70
|
+
getCourseEnrollments(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollmentList>;
|
|
51
71
|
/**
|
|
52
72
|
* get course list
|
|
53
73
|
*/
|
|
54
|
-
getCourseListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseList>>;
|
|
74
|
+
getCourseListRaw(requestParameters: GetCourseListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseList>>;
|
|
55
75
|
/**
|
|
56
76
|
* get course list
|
|
57
77
|
*/
|
|
58
|
-
getCourseList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseList>;
|
|
78
|
+
getCourseList(requestParameters?: GetCourseListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseList>;
|
|
59
79
|
/**
|
|
60
80
|
* Post a new course
|
|
61
81
|
*/
|
|
@@ -65,11 +85,11 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
65
85
|
*/
|
|
66
86
|
postCourse(requestParameters: PostCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
67
87
|
/**
|
|
68
|
-
*
|
|
88
|
+
* Create a new course enrollment
|
|
69
89
|
*/
|
|
70
90
|
postCourseEnrollmentRaw(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
|
|
71
91
|
/**
|
|
72
|
-
*
|
|
92
|
+
* Create a new course enrollment
|
|
73
93
|
*/
|
|
74
94
|
postCourseEnrollment(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
75
95
|
/**
|
|
@@ -80,4 +100,12 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
80
100
|
* Update a course by id
|
|
81
101
|
*/
|
|
82
102
|
putCourse(requestParameters: PutCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
103
|
+
/**
|
|
104
|
+
* Update a course enrollment
|
|
105
|
+
*/
|
|
106
|
+
putCourseEnrollmentRaw(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
|
|
107
|
+
/**
|
|
108
|
+
* Update a course enrollment
|
|
109
|
+
*/
|
|
110
|
+
putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
83
111
|
}
|
|
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
-
import { GetCourseFromJSON, GetCourseEnrollmentFromJSON, GetCourseEnrollmentListFromJSON, GetCourseListFromJSON, PostCourseToJSON, PostCourseEnrollmentToJSON, PutCourseToJSON, } from '../models/index';
|
|
24
|
+
import { GetCourseFromJSON, GetCourseEnrollmentFromJSON, GetCourseEnrollmentListFromJSON, GetCourseListFromJSON, PostCourseToJSON, PostCourseEnrollmentToJSON, PutCourseToJSON, PutCourseEnrollmentToJSON, } from '../models/index';
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
@@ -55,26 +55,29 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
55
55
|
});
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
|
-
*
|
|
58
|
+
* Get a specific course enrollment
|
|
59
59
|
*/
|
|
60
60
|
getCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
61
61
|
return __awaiter(this, void 0, void 0, function* () {
|
|
62
62
|
if (requestParameters['courseId'] == null) {
|
|
63
63
|
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseEnrollment().');
|
|
64
64
|
}
|
|
65
|
+
if (requestParameters['enrollmentId'] == null) {
|
|
66
|
+
throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling getCourseEnrollment().');
|
|
67
|
+
}
|
|
65
68
|
const queryParameters = {};
|
|
66
69
|
const headerParameters = {};
|
|
67
70
|
const response = yield this.request({
|
|
68
|
-
path: `/courses/{courseId}/
|
|
71
|
+
path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
|
|
69
72
|
method: 'GET',
|
|
70
73
|
headers: headerParameters,
|
|
71
74
|
query: queryParameters,
|
|
72
75
|
}, initOverrides);
|
|
73
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
76
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseEnrollmentFromJSON(jsonValue));
|
|
74
77
|
});
|
|
75
78
|
}
|
|
76
79
|
/**
|
|
77
|
-
*
|
|
80
|
+
* Get a specific course enrollment
|
|
78
81
|
*/
|
|
79
82
|
getCourseEnrollment(requestParameters, initOverrides) {
|
|
80
83
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -82,12 +85,43 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
82
85
|
return yield response.value();
|
|
83
86
|
});
|
|
84
87
|
}
|
|
88
|
+
/**
|
|
89
|
+
* Get course enrollments
|
|
90
|
+
*/
|
|
91
|
+
getCourseEnrollmentsRaw(requestParameters, initOverrides) {
|
|
92
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
93
|
+
if (requestParameters['courseId'] == null) {
|
|
94
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseEnrollments().');
|
|
95
|
+
}
|
|
96
|
+
const queryParameters = {};
|
|
97
|
+
const headerParameters = {};
|
|
98
|
+
const response = yield this.request({
|
|
99
|
+
path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
100
|
+
method: 'GET',
|
|
101
|
+
headers: headerParameters,
|
|
102
|
+
query: queryParameters,
|
|
103
|
+
}, initOverrides);
|
|
104
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseEnrollmentListFromJSON(jsonValue));
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Get course enrollments
|
|
109
|
+
*/
|
|
110
|
+
getCourseEnrollments(requestParameters, initOverrides) {
|
|
111
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
112
|
+
const response = yield this.getCourseEnrollmentsRaw(requestParameters, initOverrides);
|
|
113
|
+
return yield response.value();
|
|
114
|
+
});
|
|
115
|
+
}
|
|
85
116
|
/**
|
|
86
117
|
* get course list
|
|
87
118
|
*/
|
|
88
|
-
getCourseListRaw(initOverrides) {
|
|
119
|
+
getCourseListRaw(requestParameters, initOverrides) {
|
|
89
120
|
return __awaiter(this, void 0, void 0, function* () {
|
|
90
121
|
const queryParameters = {};
|
|
122
|
+
if (requestParameters['enrolled'] != null) {
|
|
123
|
+
queryParameters['enrolled'] = requestParameters['enrolled'];
|
|
124
|
+
}
|
|
91
125
|
const headerParameters = {};
|
|
92
126
|
const response = yield this.request({
|
|
93
127
|
path: `/courses`,
|
|
@@ -101,9 +135,9 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
101
135
|
/**
|
|
102
136
|
* get course list
|
|
103
137
|
*/
|
|
104
|
-
getCourseList(
|
|
105
|
-
return __awaiter(this,
|
|
106
|
-
const response = yield this.getCourseListRaw(initOverrides);
|
|
138
|
+
getCourseList() {
|
|
139
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
140
|
+
const response = yield this.getCourseListRaw(requestParameters, initOverrides);
|
|
107
141
|
return yield response.value();
|
|
108
142
|
});
|
|
109
143
|
}
|
|
@@ -138,7 +172,7 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
138
172
|
});
|
|
139
173
|
}
|
|
140
174
|
/**
|
|
141
|
-
*
|
|
175
|
+
* Create a new course enrollment
|
|
142
176
|
*/
|
|
143
177
|
postCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
144
178
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -152,7 +186,7 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
152
186
|
const headerParameters = {};
|
|
153
187
|
headerParameters['Content-Type'] = 'application/json';
|
|
154
188
|
const response = yield this.request({
|
|
155
|
-
path: `/courses/{courseId}/
|
|
189
|
+
path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
156
190
|
method: 'POST',
|
|
157
191
|
headers: headerParameters,
|
|
158
192
|
query: queryParameters,
|
|
@@ -162,7 +196,7 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
162
196
|
});
|
|
163
197
|
}
|
|
164
198
|
/**
|
|
165
|
-
*
|
|
199
|
+
* Create a new course enrollment
|
|
166
200
|
*/
|
|
167
201
|
postCourseEnrollment(requestParameters, initOverrides) {
|
|
168
202
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -203,4 +237,40 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
203
237
|
return yield response.value();
|
|
204
238
|
});
|
|
205
239
|
}
|
|
240
|
+
/**
|
|
241
|
+
* Update a course enrollment
|
|
242
|
+
*/
|
|
243
|
+
putCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
244
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
245
|
+
if (requestParameters['courseId'] == null) {
|
|
246
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putCourseEnrollment().');
|
|
247
|
+
}
|
|
248
|
+
if (requestParameters['enrollmentId'] == null) {
|
|
249
|
+
throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling putCourseEnrollment().');
|
|
250
|
+
}
|
|
251
|
+
if (requestParameters['putCourseEnrollment'] == null) {
|
|
252
|
+
throw new runtime.RequiredError('putCourseEnrollment', 'Required parameter "putCourseEnrollment" was null or undefined when calling putCourseEnrollment().');
|
|
253
|
+
}
|
|
254
|
+
const queryParameters = {};
|
|
255
|
+
const headerParameters = {};
|
|
256
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
257
|
+
const response = yield this.request({
|
|
258
|
+
path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
|
|
259
|
+
method: 'PUT',
|
|
260
|
+
headers: headerParameters,
|
|
261
|
+
query: queryParameters,
|
|
262
|
+
body: PutCourseEnrollmentToJSON(requestParameters['putCourseEnrollment']),
|
|
263
|
+
}, initOverrides);
|
|
264
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseEnrollmentFromJSON(jsonValue));
|
|
265
|
+
});
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* Update a course enrollment
|
|
269
|
+
*/
|
|
270
|
+
putCourseEnrollment(requestParameters, initOverrides) {
|
|
271
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
272
|
+
const response = yield this.putCourseEnrollmentRaw(requestParameters, initOverrides);
|
|
273
|
+
return yield response.value();
|
|
274
|
+
});
|
|
275
|
+
}
|
|
206
276
|
}
|
|
@@ -91,6 +91,9 @@ export class PortalApi extends runtime.BaseAPI {
|
|
|
91
91
|
if (requestParameters['roles'] != null) {
|
|
92
92
|
queryParameters['roles'] = requestParameters['roles'];
|
|
93
93
|
}
|
|
94
|
+
if (requestParameters['search'] != null) {
|
|
95
|
+
queryParameters['search'] = requestParameters['search'];
|
|
96
|
+
}
|
|
94
97
|
if (requestParameters['page'] != null) {
|
|
95
98
|
queryParameters['page'] = requestParameters['page'];
|
|
96
99
|
}
|
|
@@ -16,13 +16,19 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface GetCourseEnrollment {
|
|
18
18
|
/**
|
|
19
|
-
* The ID of the
|
|
19
|
+
* The external ID of the enrollment
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof GetCourseEnrollment
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
* The external ID of the course
|
|
20
26
|
* @type {string}
|
|
21
27
|
* @memberof GetCourseEnrollment
|
|
22
28
|
*/
|
|
23
29
|
courseId: string;
|
|
24
30
|
/**
|
|
25
|
-
* The ID of the enrolled user
|
|
31
|
+
* The external ID of the enrolled user
|
|
26
32
|
* @type {string}
|
|
27
33
|
* @memberof GetCourseEnrollment
|
|
28
34
|
*/
|
|
@@ -63,10 +69,8 @@ export interface GetCourseEnrollment {
|
|
|
63
69
|
*/
|
|
64
70
|
export declare const GetCourseEnrollmentStatusEnum: {
|
|
65
71
|
readonly Enrolled: "Enrolled";
|
|
66
|
-
readonly Dropped: "Dropped";
|
|
67
72
|
readonly Completed: "Completed";
|
|
68
|
-
readonly
|
|
69
|
-
readonly Unknown: "Unknown";
|
|
73
|
+
readonly Removed: "Removed";
|
|
70
74
|
};
|
|
71
75
|
export type GetCourseEnrollmentStatusEnum = typeof GetCourseEnrollmentStatusEnum[keyof typeof GetCourseEnrollmentStatusEnum];
|
|
72
76
|
/**
|
|
@@ -16,15 +16,15 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export const GetCourseEnrollmentStatusEnum = {
|
|
18
18
|
Enrolled: 'Enrolled',
|
|
19
|
-
Dropped: 'Dropped',
|
|
20
19
|
Completed: 'Completed',
|
|
21
|
-
|
|
22
|
-
Unknown: 'Unknown'
|
|
20
|
+
Removed: 'Removed'
|
|
23
21
|
};
|
|
24
22
|
/**
|
|
25
23
|
* Check if a given object implements the GetCourseEnrollment interface.
|
|
26
24
|
*/
|
|
27
25
|
export function instanceOfGetCourseEnrollment(value) {
|
|
26
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
27
|
+
return false;
|
|
28
28
|
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
29
29
|
return false;
|
|
30
30
|
if (!('userId' in value) || value['userId'] === undefined)
|
|
@@ -49,6 +49,7 @@ export function GetCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
49
49
|
return json;
|
|
50
50
|
}
|
|
51
51
|
return {
|
|
52
|
+
'id': json['id'],
|
|
52
53
|
'courseId': json['course_id'],
|
|
53
54
|
'userId': json['user_id'],
|
|
54
55
|
'enrollmentDateStart': json['enrollment_date_start'],
|
|
@@ -66,6 +67,7 @@ export function GetCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = fals
|
|
|
66
67
|
return value;
|
|
67
68
|
}
|
|
68
69
|
return {
|
|
70
|
+
'id': value['id'],
|
|
69
71
|
'course_id': value['courseId'],
|
|
70
72
|
'user_id': value['userId'],
|
|
71
73
|
'enrollment_date_start': value['enrollmentDateStart'],
|