@easyedu/js-lsm-api 1.8.0 → 1.9.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 +1 -0
- package/README.md +2 -2
- package/dist/apis/CourseApi.d.ts +21 -8
- package/dist/apis/CourseApi.js +46 -10
- package/dist/esm/apis/CourseApi.d.ts +21 -8
- package/dist/esm/apis/CourseApi.js +47 -11
- package/dist/esm/models/GetCourseEnrollment.d.ts +9 -5
- package/dist/esm/models/GetCourseEnrollment.js +5 -3
- 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 +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/models/GetCourseEnrollment.d.ts +9 -5
- package/dist/models/GetCourseEnrollment.js +5 -3
- 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 +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/CourseApi.ts +70 -11
- package/src/models/GetCourseEnrollment.ts +12 -5
- 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 +1 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -127,6 +127,7 @@ src/models/PostResetPassword.ts
|
|
|
127
127
|
src/models/PostSendResetPassword.ts
|
|
128
128
|
src/models/PutContent.ts
|
|
129
129
|
src/models/PutCourse.ts
|
|
130
|
+
src/models/PutCourseEnrollment.ts
|
|
130
131
|
src/models/PutModule.ts
|
|
131
132
|
src/models/PutPortalBranding.ts
|
|
132
133
|
src/models/PutQuestion.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @easyedu/js-lsm-api@1.
|
|
1
|
+
## @easyedu/js-lsm-api@1.9.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.9.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/dist/apis/CourseApi.d.ts
CHANGED
|
@@ -10,11 +10,11 @@
|
|
|
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
|
-
export interface
|
|
17
|
+
export interface GetCourseEnrollmentsRequest {
|
|
18
18
|
courseId: string;
|
|
19
19
|
}
|
|
20
20
|
export interface PostCourseRequest {
|
|
@@ -28,6 +28,11 @@ export interface PutCourseRequest {
|
|
|
28
28
|
courseId: string;
|
|
29
29
|
putCourse: Omit<PutCourse, 'id'>;
|
|
30
30
|
}
|
|
31
|
+
export interface PutCourseEnrollmentRequest {
|
|
32
|
+
courseId: string;
|
|
33
|
+
enrollmentId: string;
|
|
34
|
+
putCourseEnrollment: PutCourseEnrollment;
|
|
35
|
+
}
|
|
31
36
|
/**
|
|
32
37
|
*
|
|
33
38
|
*/
|
|
@@ -41,13 +46,13 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
41
46
|
*/
|
|
42
47
|
getCourse(requestParameters: GetCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
43
48
|
/**
|
|
44
|
-
*
|
|
49
|
+
* Get course enrollments
|
|
45
50
|
*/
|
|
46
|
-
|
|
51
|
+
getCourseEnrollmentsRaw(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollmentList>>;
|
|
47
52
|
/**
|
|
48
|
-
*
|
|
53
|
+
* Get course enrollments
|
|
49
54
|
*/
|
|
50
|
-
|
|
55
|
+
getCourseEnrollments(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollmentList>;
|
|
51
56
|
/**
|
|
52
57
|
* get course list
|
|
53
58
|
*/
|
|
@@ -65,11 +70,11 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
65
70
|
*/
|
|
66
71
|
postCourse(requestParameters: PostCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
67
72
|
/**
|
|
68
|
-
*
|
|
73
|
+
* Create a new course enrollment
|
|
69
74
|
*/
|
|
70
75
|
postCourseEnrollmentRaw(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
|
|
71
76
|
/**
|
|
72
|
-
*
|
|
77
|
+
* Create a new course enrollment
|
|
73
78
|
*/
|
|
74
79
|
postCourseEnrollment(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
75
80
|
/**
|
|
@@ -80,4 +85,12 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
80
85
|
* Update a course by id
|
|
81
86
|
*/
|
|
82
87
|
putCourse(requestParameters: PutCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
88
|
+
/**
|
|
89
|
+
* Update a course enrollment
|
|
90
|
+
*/
|
|
91
|
+
putCourseEnrollmentRaw(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
|
|
92
|
+
/**
|
|
93
|
+
* Update a course enrollment
|
|
94
|
+
*/
|
|
95
|
+
putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
83
96
|
}
|
package/dist/apis/CourseApi.js
CHANGED
|
@@ -58,17 +58,17 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
58
58
|
});
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* Get course enrollments
|
|
62
62
|
*/
|
|
63
|
-
|
|
63
|
+
getCourseEnrollmentsRaw(requestParameters, initOverrides) {
|
|
64
64
|
return __awaiter(this, void 0, void 0, function* () {
|
|
65
65
|
if (requestParameters['courseId'] == null) {
|
|
66
|
-
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling
|
|
66
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseEnrollments().');
|
|
67
67
|
}
|
|
68
68
|
const queryParameters = {};
|
|
69
69
|
const headerParameters = {};
|
|
70
70
|
const response = yield this.request({
|
|
71
|
-
path: `/courses/{courseId}/
|
|
71
|
+
path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
72
72
|
method: 'GET',
|
|
73
73
|
headers: headerParameters,
|
|
74
74
|
query: queryParameters,
|
|
@@ -77,11 +77,11 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
77
77
|
});
|
|
78
78
|
}
|
|
79
79
|
/**
|
|
80
|
-
*
|
|
80
|
+
* Get course enrollments
|
|
81
81
|
*/
|
|
82
|
-
|
|
82
|
+
getCourseEnrollments(requestParameters, initOverrides) {
|
|
83
83
|
return __awaiter(this, void 0, void 0, function* () {
|
|
84
|
-
const response = yield this.
|
|
84
|
+
const response = yield this.getCourseEnrollmentsRaw(requestParameters, initOverrides);
|
|
85
85
|
return yield response.value();
|
|
86
86
|
});
|
|
87
87
|
}
|
|
@@ -141,7 +141,7 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
141
141
|
});
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
144
|
-
*
|
|
144
|
+
* Create a new course enrollment
|
|
145
145
|
*/
|
|
146
146
|
postCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
147
147
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -155,7 +155,7 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
155
155
|
const headerParameters = {};
|
|
156
156
|
headerParameters['Content-Type'] = 'application/json';
|
|
157
157
|
const response = yield this.request({
|
|
158
|
-
path: `/courses/{courseId}/
|
|
158
|
+
path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
159
159
|
method: 'POST',
|
|
160
160
|
headers: headerParameters,
|
|
161
161
|
query: queryParameters,
|
|
@@ -165,7 +165,7 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
165
165
|
});
|
|
166
166
|
}
|
|
167
167
|
/**
|
|
168
|
-
*
|
|
168
|
+
* Create a new course enrollment
|
|
169
169
|
*/
|
|
170
170
|
postCourseEnrollment(requestParameters, initOverrides) {
|
|
171
171
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -206,5 +206,41 @@ class CourseApi extends runtime.BaseAPI {
|
|
|
206
206
|
return yield response.value();
|
|
207
207
|
});
|
|
208
208
|
}
|
|
209
|
+
/**
|
|
210
|
+
* Update a course enrollment
|
|
211
|
+
*/
|
|
212
|
+
putCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
213
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
214
|
+
if (requestParameters['courseId'] == null) {
|
|
215
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putCourseEnrollment().');
|
|
216
|
+
}
|
|
217
|
+
if (requestParameters['enrollmentId'] == null) {
|
|
218
|
+
throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling putCourseEnrollment().');
|
|
219
|
+
}
|
|
220
|
+
if (requestParameters['putCourseEnrollment'] == null) {
|
|
221
|
+
throw new runtime.RequiredError('putCourseEnrollment', 'Required parameter "putCourseEnrollment" was null or undefined when calling putCourseEnrollment().');
|
|
222
|
+
}
|
|
223
|
+
const queryParameters = {};
|
|
224
|
+
const headerParameters = {};
|
|
225
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
226
|
+
const response = yield this.request({
|
|
227
|
+
path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
|
|
228
|
+
method: 'PUT',
|
|
229
|
+
headers: headerParameters,
|
|
230
|
+
query: queryParameters,
|
|
231
|
+
body: (0, index_1.PutCourseEnrollmentToJSON)(requestParameters['putCourseEnrollment']),
|
|
232
|
+
}, initOverrides);
|
|
233
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetCourseEnrollmentFromJSON)(jsonValue));
|
|
234
|
+
});
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* Update a course enrollment
|
|
238
|
+
*/
|
|
239
|
+
putCourseEnrollment(requestParameters, initOverrides) {
|
|
240
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
241
|
+
const response = yield this.putCourseEnrollmentRaw(requestParameters, initOverrides);
|
|
242
|
+
return yield response.value();
|
|
243
|
+
});
|
|
244
|
+
}
|
|
209
245
|
}
|
|
210
246
|
exports.CourseApi = CourseApi;
|
|
@@ -10,11 +10,11 @@
|
|
|
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
|
-
export interface
|
|
17
|
+
export interface GetCourseEnrollmentsRequest {
|
|
18
18
|
courseId: string;
|
|
19
19
|
}
|
|
20
20
|
export interface PostCourseRequest {
|
|
@@ -28,6 +28,11 @@ export interface PutCourseRequest {
|
|
|
28
28
|
courseId: string;
|
|
29
29
|
putCourse: Omit<PutCourse, 'id'>;
|
|
30
30
|
}
|
|
31
|
+
export interface PutCourseEnrollmentRequest {
|
|
32
|
+
courseId: string;
|
|
33
|
+
enrollmentId: string;
|
|
34
|
+
putCourseEnrollment: PutCourseEnrollment;
|
|
35
|
+
}
|
|
31
36
|
/**
|
|
32
37
|
*
|
|
33
38
|
*/
|
|
@@ -41,13 +46,13 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
41
46
|
*/
|
|
42
47
|
getCourse(requestParameters: GetCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
43
48
|
/**
|
|
44
|
-
*
|
|
49
|
+
* Get course enrollments
|
|
45
50
|
*/
|
|
46
|
-
|
|
51
|
+
getCourseEnrollmentsRaw(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollmentList>>;
|
|
47
52
|
/**
|
|
48
|
-
*
|
|
53
|
+
* Get course enrollments
|
|
49
54
|
*/
|
|
50
|
-
|
|
55
|
+
getCourseEnrollments(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollmentList>;
|
|
51
56
|
/**
|
|
52
57
|
* get course list
|
|
53
58
|
*/
|
|
@@ -65,11 +70,11 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
65
70
|
*/
|
|
66
71
|
postCourse(requestParameters: PostCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
67
72
|
/**
|
|
68
|
-
*
|
|
73
|
+
* Create a new course enrollment
|
|
69
74
|
*/
|
|
70
75
|
postCourseEnrollmentRaw(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
|
|
71
76
|
/**
|
|
72
|
-
*
|
|
77
|
+
* Create a new course enrollment
|
|
73
78
|
*/
|
|
74
79
|
postCourseEnrollment(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
75
80
|
/**
|
|
@@ -80,4 +85,12 @@ export declare class CourseApi extends runtime.BaseAPI {
|
|
|
80
85
|
* Update a course by id
|
|
81
86
|
*/
|
|
82
87
|
putCourse(requestParameters: PutCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse>;
|
|
88
|
+
/**
|
|
89
|
+
* Update a course enrollment
|
|
90
|
+
*/
|
|
91
|
+
putCourseEnrollmentRaw(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
|
|
92
|
+
/**
|
|
93
|
+
* Update a course enrollment
|
|
94
|
+
*/
|
|
95
|
+
putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
|
|
83
96
|
}
|
|
@@ -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,17 +55,17 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
55
55
|
});
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
|
-
*
|
|
58
|
+
* Get course enrollments
|
|
59
59
|
*/
|
|
60
|
-
|
|
60
|
+
getCourseEnrollmentsRaw(requestParameters, initOverrides) {
|
|
61
61
|
return __awaiter(this, void 0, void 0, function* () {
|
|
62
62
|
if (requestParameters['courseId'] == null) {
|
|
63
|
-
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling
|
|
63
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseEnrollments().');
|
|
64
64
|
}
|
|
65
65
|
const queryParameters = {};
|
|
66
66
|
const headerParameters = {};
|
|
67
67
|
const response = yield this.request({
|
|
68
|
-
path: `/courses/{courseId}/
|
|
68
|
+
path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
69
69
|
method: 'GET',
|
|
70
70
|
headers: headerParameters,
|
|
71
71
|
query: queryParameters,
|
|
@@ -74,11 +74,11 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
74
74
|
});
|
|
75
75
|
}
|
|
76
76
|
/**
|
|
77
|
-
*
|
|
77
|
+
* Get course enrollments
|
|
78
78
|
*/
|
|
79
|
-
|
|
79
|
+
getCourseEnrollments(requestParameters, initOverrides) {
|
|
80
80
|
return __awaiter(this, void 0, void 0, function* () {
|
|
81
|
-
const response = yield this.
|
|
81
|
+
const response = yield this.getCourseEnrollmentsRaw(requestParameters, initOverrides);
|
|
82
82
|
return yield response.value();
|
|
83
83
|
});
|
|
84
84
|
}
|
|
@@ -138,7 +138,7 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
138
138
|
});
|
|
139
139
|
}
|
|
140
140
|
/**
|
|
141
|
-
*
|
|
141
|
+
* Create a new course enrollment
|
|
142
142
|
*/
|
|
143
143
|
postCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
144
144
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -152,7 +152,7 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
152
152
|
const headerParameters = {};
|
|
153
153
|
headerParameters['Content-Type'] = 'application/json';
|
|
154
154
|
const response = yield this.request({
|
|
155
|
-
path: `/courses/{courseId}/
|
|
155
|
+
path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
156
156
|
method: 'POST',
|
|
157
157
|
headers: headerParameters,
|
|
158
158
|
query: queryParameters,
|
|
@@ -162,7 +162,7 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
162
162
|
});
|
|
163
163
|
}
|
|
164
164
|
/**
|
|
165
|
-
*
|
|
165
|
+
* Create a new course enrollment
|
|
166
166
|
*/
|
|
167
167
|
postCourseEnrollment(requestParameters, initOverrides) {
|
|
168
168
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -203,4 +203,40 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
203
203
|
return yield response.value();
|
|
204
204
|
});
|
|
205
205
|
}
|
|
206
|
+
/**
|
|
207
|
+
* Update a course enrollment
|
|
208
|
+
*/
|
|
209
|
+
putCourseEnrollmentRaw(requestParameters, initOverrides) {
|
|
210
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
211
|
+
if (requestParameters['courseId'] == null) {
|
|
212
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putCourseEnrollment().');
|
|
213
|
+
}
|
|
214
|
+
if (requestParameters['enrollmentId'] == null) {
|
|
215
|
+
throw new runtime.RequiredError('enrollmentId', 'Required parameter "enrollmentId" was null or undefined when calling putCourseEnrollment().');
|
|
216
|
+
}
|
|
217
|
+
if (requestParameters['putCourseEnrollment'] == null) {
|
|
218
|
+
throw new runtime.RequiredError('putCourseEnrollment', 'Required parameter "putCourseEnrollment" was null or undefined when calling putCourseEnrollment().');
|
|
219
|
+
}
|
|
220
|
+
const queryParameters = {};
|
|
221
|
+
const headerParameters = {};
|
|
222
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
223
|
+
const response = yield this.request({
|
|
224
|
+
path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
|
|
225
|
+
method: 'PUT',
|
|
226
|
+
headers: headerParameters,
|
|
227
|
+
query: queryParameters,
|
|
228
|
+
body: PutCourseEnrollmentToJSON(requestParameters['putCourseEnrollment']),
|
|
229
|
+
}, initOverrides);
|
|
230
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseEnrollmentFromJSON(jsonValue));
|
|
231
|
+
});
|
|
232
|
+
}
|
|
233
|
+
/**
|
|
234
|
+
* Update a course enrollment
|
|
235
|
+
*/
|
|
236
|
+
putCourseEnrollment(requestParameters, initOverrides) {
|
|
237
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
238
|
+
const response = yield this.putCourseEnrollmentRaw(requestParameters, initOverrides);
|
|
239
|
+
return yield response.value();
|
|
240
|
+
});
|
|
241
|
+
}
|
|
206
242
|
}
|
|
@@ -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'],
|
|
@@ -39,6 +39,12 @@ export interface PostContentSession {
|
|
|
39
39
|
* @memberof PostContentSession
|
|
40
40
|
*/
|
|
41
41
|
createdAt: number;
|
|
42
|
+
/**
|
|
43
|
+
* The player session ID (used for SCORM, Quiz, and other interactive content). This is the external_id of the session that the player should use.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof PostContentSession
|
|
46
|
+
*/
|
|
47
|
+
playerSessionId?: string | null;
|
|
42
48
|
}
|
|
43
49
|
/**
|
|
44
50
|
* Check if a given object implements the PostContentSession interface.
|
|
@@ -37,6 +37,7 @@ export function PostContentSessionFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
37
37
|
'userId': json['user_id'],
|
|
38
38
|
'launchUrl': json['launch_url'],
|
|
39
39
|
'createdAt': json['created_at'],
|
|
40
|
+
'playerSessionId': json['player_session_id'] == null ? undefined : json['player_session_id'],
|
|
40
41
|
};
|
|
41
42
|
}
|
|
42
43
|
export function PostContentSessionToJSON(json) {
|
|
@@ -51,5 +52,6 @@ export function PostContentSessionToJSONTyped(value, ignoreDiscriminator = false
|
|
|
51
52
|
'user_id': value['userId'],
|
|
52
53
|
'launch_url': value['launchUrl'],
|
|
53
54
|
'created_at': value['createdAt'],
|
|
55
|
+
'player_session_id': value['playerSessionId'],
|
|
54
56
|
};
|
|
55
57
|
}
|
|
@@ -16,23 +16,29 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface PostCourseEnrollment {
|
|
18
18
|
/**
|
|
19
|
-
* The ID of the
|
|
19
|
+
* The external ID of the user to enroll
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof PostCourseEnrollment
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
userId: string;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
26
|
-
* @type {
|
|
25
|
+
* Start date of the enrollment (Unix timestamp)
|
|
26
|
+
* @type {number}
|
|
27
27
|
* @memberof PostCourseEnrollment
|
|
28
28
|
*/
|
|
29
|
-
|
|
29
|
+
enrollmentDateStart: number;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* End date of the enrollment (Unix timestamp)
|
|
32
32
|
* @type {number}
|
|
33
33
|
* @memberof PostCourseEnrollment
|
|
34
34
|
*/
|
|
35
|
-
|
|
35
|
+
enrollmentDateEnd?: number | null;
|
|
36
|
+
/**
|
|
37
|
+
* Optional notes about the enrollment
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof PostCourseEnrollment
|
|
40
|
+
*/
|
|
41
|
+
notes?: string | null;
|
|
36
42
|
}
|
|
37
43
|
/**
|
|
38
44
|
* Check if a given object implements the PostCourseEnrollment interface.
|
|
@@ -15,8 +15,6 @@
|
|
|
15
15
|
* Check if a given object implements the PostCourseEnrollment interface.
|
|
16
16
|
*/
|
|
17
17
|
export function instanceOfPostCourseEnrollment(value) {
|
|
18
|
-
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
19
|
-
return false;
|
|
20
18
|
if (!('userId' in value) || value['userId'] === undefined)
|
|
21
19
|
return false;
|
|
22
20
|
if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined)
|
|
@@ -31,9 +29,10 @@ export function PostCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
31
29
|
return json;
|
|
32
30
|
}
|
|
33
31
|
return {
|
|
34
|
-
'courseId': json['course_id'],
|
|
35
32
|
'userId': json['user_id'],
|
|
36
33
|
'enrollmentDateStart': json['enrollment_date_start'],
|
|
34
|
+
'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
|
|
35
|
+
'notes': json['notes'] == null ? undefined : json['notes'],
|
|
37
36
|
};
|
|
38
37
|
}
|
|
39
38
|
export function PostCourseEnrollmentToJSON(json) {
|
|
@@ -44,8 +43,9 @@ export function PostCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = fal
|
|
|
44
43
|
return value;
|
|
45
44
|
}
|
|
46
45
|
return {
|
|
47
|
-
'course_id': value['courseId'],
|
|
48
46
|
'user_id': value['userId'],
|
|
49
47
|
'enrollment_date_start': value['enrollmentDateStart'],
|
|
48
|
+
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
49
|
+
'notes': value['notes'],
|
|
50
50
|
};
|
|
51
51
|
}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LMS API
|
|
3
|
+
* LMS API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface PutCourseEnrollment
|
|
16
|
+
*/
|
|
17
|
+
export interface PutCourseEnrollment {
|
|
18
|
+
/**
|
|
19
|
+
* Current status of the enrollment
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof PutCourseEnrollment
|
|
22
|
+
*/
|
|
23
|
+
status?: PutCourseEnrollmentStatusEnum;
|
|
24
|
+
/**
|
|
25
|
+
* End date of the enrollment (Unix timestamp)
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof PutCourseEnrollment
|
|
28
|
+
*/
|
|
29
|
+
enrollmentDateEnd?: number;
|
|
30
|
+
/**
|
|
31
|
+
* Optional notes about the enrollment
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof PutCourseEnrollment
|
|
34
|
+
*/
|
|
35
|
+
notes?: string;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export declare const PutCourseEnrollmentStatusEnum: {
|
|
41
|
+
readonly Enrolled: "Enrolled";
|
|
42
|
+
readonly Completed: "Completed";
|
|
43
|
+
readonly Removed: "Removed";
|
|
44
|
+
};
|
|
45
|
+
export type PutCourseEnrollmentStatusEnum = typeof PutCourseEnrollmentStatusEnum[keyof typeof PutCourseEnrollmentStatusEnum];
|
|
46
|
+
/**
|
|
47
|
+
* Check if a given object implements the PutCourseEnrollment interface.
|
|
48
|
+
*/
|
|
49
|
+
export declare function instanceOfPutCourseEnrollment(value: object): value is PutCourseEnrollment;
|
|
50
|
+
export declare function PutCourseEnrollmentFromJSON(json: any): PutCourseEnrollment;
|
|
51
|
+
export declare function PutCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseEnrollment;
|
|
52
|
+
export declare function PutCourseEnrollmentToJSON(json: any): PutCourseEnrollment;
|
|
53
|
+
export declare function PutCourseEnrollmentToJSONTyped(value?: PutCourseEnrollment | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,53 @@
|
|
|
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
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const PutCourseEnrollmentStatusEnum = {
|
|
18
|
+
Enrolled: 'Enrolled',
|
|
19
|
+
Completed: 'Completed',
|
|
20
|
+
Removed: 'Removed'
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the PutCourseEnrollment interface.
|
|
24
|
+
*/
|
|
25
|
+
export function instanceOfPutCourseEnrollment(value) {
|
|
26
|
+
return true;
|
|
27
|
+
}
|
|
28
|
+
export function PutCourseEnrollmentFromJSON(json) {
|
|
29
|
+
return PutCourseEnrollmentFromJSONTyped(json, false);
|
|
30
|
+
}
|
|
31
|
+
export function PutCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
|
|
32
|
+
if (json == null) {
|
|
33
|
+
return json;
|
|
34
|
+
}
|
|
35
|
+
return {
|
|
36
|
+
'status': json['status'] == null ? undefined : json['status'],
|
|
37
|
+
'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
|
|
38
|
+
'notes': json['notes'] == null ? undefined : json['notes'],
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
export function PutCourseEnrollmentToJSON(json) {
|
|
42
|
+
return PutCourseEnrollmentToJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
export function PutCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
|
|
45
|
+
if (value == null) {
|
|
46
|
+
return value;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'status': value['status'],
|
|
50
|
+
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
51
|
+
'notes': value['notes'],
|
|
52
|
+
};
|
|
53
|
+
}
|