@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
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* LMS API
|
|
6
|
+
* LMS API
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.GetCourseEnrollmentListItemStatusEnum = void 0;
|
|
17
|
+
exports.instanceOfGetCourseEnrollmentListItem = instanceOfGetCourseEnrollmentListItem;
|
|
18
|
+
exports.GetCourseEnrollmentListItemFromJSON = GetCourseEnrollmentListItemFromJSON;
|
|
19
|
+
exports.GetCourseEnrollmentListItemFromJSONTyped = GetCourseEnrollmentListItemFromJSONTyped;
|
|
20
|
+
exports.GetCourseEnrollmentListItemToJSON = GetCourseEnrollmentListItemToJSON;
|
|
21
|
+
exports.GetCourseEnrollmentListItemToJSONTyped = GetCourseEnrollmentListItemToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.GetCourseEnrollmentListItemStatusEnum = {
|
|
26
|
+
Enrolled: 'Enrolled',
|
|
27
|
+
Completed: 'Completed',
|
|
28
|
+
Removed: 'Removed'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Check if a given object implements the GetCourseEnrollmentListItem interface.
|
|
32
|
+
*/
|
|
33
|
+
function instanceOfGetCourseEnrollmentListItem(value) {
|
|
34
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('userId' in value) || value['userId'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('firstName' in value) || value['firstName'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('lastName' in value) || value['lastName'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined)
|
|
45
|
+
return false;
|
|
46
|
+
if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined)
|
|
47
|
+
return false;
|
|
48
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
49
|
+
return false;
|
|
50
|
+
if (!('completionDate' in value) || value['completionDate'] === undefined)
|
|
51
|
+
return false;
|
|
52
|
+
return true;
|
|
53
|
+
}
|
|
54
|
+
function GetCourseEnrollmentListItemFromJSON(json) {
|
|
55
|
+
return GetCourseEnrollmentListItemFromJSONTyped(json, false);
|
|
56
|
+
}
|
|
57
|
+
function GetCourseEnrollmentListItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
58
|
+
if (json == null) {
|
|
59
|
+
return json;
|
|
60
|
+
}
|
|
61
|
+
return {
|
|
62
|
+
'id': json['id'],
|
|
63
|
+
'courseId': json['course_id'],
|
|
64
|
+
'userId': json['user_id'],
|
|
65
|
+
'firstName': json['first_name'],
|
|
66
|
+
'lastName': json['last_name'],
|
|
67
|
+
'enrollmentDateStart': json['enrollment_date_start'],
|
|
68
|
+
'enrollmentDateEnd': json['enrollment_date_end'],
|
|
69
|
+
'status': json['status'],
|
|
70
|
+
'completionDate': json['completion_date'],
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
function GetCourseEnrollmentListItemToJSON(json) {
|
|
74
|
+
return GetCourseEnrollmentListItemToJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
function GetCourseEnrollmentListItemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
77
|
+
if (value == null) {
|
|
78
|
+
return value;
|
|
79
|
+
}
|
|
80
|
+
return {
|
|
81
|
+
'id': value['id'],
|
|
82
|
+
'course_id': value['courseId'],
|
|
83
|
+
'user_id': value['userId'],
|
|
84
|
+
'first_name': value['firstName'],
|
|
85
|
+
'last_name': value['lastName'],
|
|
86
|
+
'enrollment_date_start': value['enrollmentDateStart'],
|
|
87
|
+
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
88
|
+
'status': value['status'],
|
|
89
|
+
'completion_date': value['completionDate'],
|
|
90
|
+
};
|
|
91
|
+
}
|
|
@@ -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.
|
|
@@ -44,6 +44,7 @@ function PostContentSessionFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
44
44
|
'userId': json['user_id'],
|
|
45
45
|
'launchUrl': json['launch_url'],
|
|
46
46
|
'createdAt': json['created_at'],
|
|
47
|
+
'playerSessionId': json['player_session_id'] == null ? undefined : json['player_session_id'],
|
|
47
48
|
};
|
|
48
49
|
}
|
|
49
50
|
function PostContentSessionToJSON(json) {
|
|
@@ -58,5 +59,6 @@ function PostContentSessionToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
58
59
|
'user_id': value['userId'],
|
|
59
60
|
'launch_url': value['launchUrl'],
|
|
60
61
|
'created_at': value['createdAt'],
|
|
62
|
+
'player_session_id': value['playerSessionId'],
|
|
61
63
|
};
|
|
62
64
|
}
|
|
@@ -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.
|
|
@@ -22,8 +22,6 @@ exports.PostCourseEnrollmentToJSONTyped = PostCourseEnrollmentToJSONTyped;
|
|
|
22
22
|
* Check if a given object implements the PostCourseEnrollment interface.
|
|
23
23
|
*/
|
|
24
24
|
function instanceOfPostCourseEnrollment(value) {
|
|
25
|
-
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
26
|
-
return false;
|
|
27
25
|
if (!('userId' in value) || value['userId'] === undefined)
|
|
28
26
|
return false;
|
|
29
27
|
if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined)
|
|
@@ -38,9 +36,10 @@ function PostCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
38
36
|
return json;
|
|
39
37
|
}
|
|
40
38
|
return {
|
|
41
|
-
'courseId': json['course_id'],
|
|
42
39
|
'userId': json['user_id'],
|
|
43
40
|
'enrollmentDateStart': json['enrollment_date_start'],
|
|
41
|
+
'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
|
|
42
|
+
'notes': json['notes'] == null ? undefined : json['notes'],
|
|
44
43
|
};
|
|
45
44
|
}
|
|
46
45
|
function PostCourseEnrollmentToJSON(json) {
|
|
@@ -51,8 +50,9 @@ function PostCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
51
50
|
return value;
|
|
52
51
|
}
|
|
53
52
|
return {
|
|
54
|
-
'course_id': value['courseId'],
|
|
55
53
|
'user_id': value['userId'],
|
|
56
54
|
'enrollment_date_start': value['enrollmentDateStart'],
|
|
55
|
+
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
56
|
+
'notes': value['notes'],
|
|
57
57
|
};
|
|
58
58
|
}
|
|
@@ -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,61 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* LMS API
|
|
6
|
+
* LMS API
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.PutCourseEnrollmentStatusEnum = void 0;
|
|
17
|
+
exports.instanceOfPutCourseEnrollment = instanceOfPutCourseEnrollment;
|
|
18
|
+
exports.PutCourseEnrollmentFromJSON = PutCourseEnrollmentFromJSON;
|
|
19
|
+
exports.PutCourseEnrollmentFromJSONTyped = PutCourseEnrollmentFromJSONTyped;
|
|
20
|
+
exports.PutCourseEnrollmentToJSON = PutCourseEnrollmentToJSON;
|
|
21
|
+
exports.PutCourseEnrollmentToJSONTyped = PutCourseEnrollmentToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.PutCourseEnrollmentStatusEnum = {
|
|
26
|
+
Enrolled: 'Enrolled',
|
|
27
|
+
Completed: 'Completed',
|
|
28
|
+
Removed: 'Removed'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Check if a given object implements the PutCourseEnrollment interface.
|
|
32
|
+
*/
|
|
33
|
+
function instanceOfPutCourseEnrollment(value) {
|
|
34
|
+
return true;
|
|
35
|
+
}
|
|
36
|
+
function PutCourseEnrollmentFromJSON(json) {
|
|
37
|
+
return PutCourseEnrollmentFromJSONTyped(json, false);
|
|
38
|
+
}
|
|
39
|
+
function PutCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
|
|
40
|
+
if (json == null) {
|
|
41
|
+
return json;
|
|
42
|
+
}
|
|
43
|
+
return {
|
|
44
|
+
'status': json['status'] == null ? undefined : json['status'],
|
|
45
|
+
'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
|
|
46
|
+
'notes': json['notes'] == null ? undefined : json['notes'],
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
function PutCourseEnrollmentToJSON(json) {
|
|
50
|
+
return PutCourseEnrollmentToJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
function PutCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
|
|
53
|
+
if (value == null) {
|
|
54
|
+
return value;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'status': value['status'],
|
|
58
|
+
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
59
|
+
'notes': value['notes'],
|
|
60
|
+
};
|
|
61
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -11,6 +11,7 @@ export * from './GetContentUpload';
|
|
|
11
11
|
export * from './GetCourse';
|
|
12
12
|
export * from './GetCourseEnrollment';
|
|
13
13
|
export * from './GetCourseEnrollmentList';
|
|
14
|
+
export * from './GetCourseEnrollmentListItem';
|
|
14
15
|
export * from './GetCourseList';
|
|
15
16
|
export * from './GetModule';
|
|
16
17
|
export * from './GetModuleList';
|
|
@@ -112,6 +113,7 @@ export * from './PostResetPassword';
|
|
|
112
113
|
export * from './PostSendResetPassword';
|
|
113
114
|
export * from './PutContent';
|
|
114
115
|
export * from './PutCourse';
|
|
116
|
+
export * from './PutCourseEnrollment';
|
|
115
117
|
export * from './PutModule';
|
|
116
118
|
export * from './PutPortalBranding';
|
|
117
119
|
export * from './PutQuestion';
|
package/dist/models/index.js
CHANGED
|
@@ -29,6 +29,7 @@ __exportStar(require("./GetContentUpload"), exports);
|
|
|
29
29
|
__exportStar(require("./GetCourse"), exports);
|
|
30
30
|
__exportStar(require("./GetCourseEnrollment"), exports);
|
|
31
31
|
__exportStar(require("./GetCourseEnrollmentList"), exports);
|
|
32
|
+
__exportStar(require("./GetCourseEnrollmentListItem"), exports);
|
|
32
33
|
__exportStar(require("./GetCourseList"), exports);
|
|
33
34
|
__exportStar(require("./GetModule"), exports);
|
|
34
35
|
__exportStar(require("./GetModuleList"), exports);
|
|
@@ -130,6 +131,7 @@ __exportStar(require("./PostResetPassword"), exports);
|
|
|
130
131
|
__exportStar(require("./PostSendResetPassword"), exports);
|
|
131
132
|
__exportStar(require("./PutContent"), exports);
|
|
132
133
|
__exportStar(require("./PutCourse"), exports);
|
|
134
|
+
__exportStar(require("./PutCourseEnrollment"), exports);
|
|
133
135
|
__exportStar(require("./PutModule"), exports);
|
|
134
136
|
__exportStar(require("./PutPortalBranding"), exports);
|
|
135
137
|
__exportStar(require("./PutQuestion"), exports);
|
package/package.json
CHANGED
package/src/apis/CourseApi.ts
CHANGED
|
@@ -22,6 +22,7 @@ import type {
|
|
|
22
22
|
PostCourse,
|
|
23
23
|
PostCourseEnrollment,
|
|
24
24
|
PutCourse,
|
|
25
|
+
PutCourseEnrollment,
|
|
25
26
|
} from '../models/index';
|
|
26
27
|
import {
|
|
27
28
|
GetCourseFromJSON,
|
|
@@ -38,6 +39,8 @@ import {
|
|
|
38
39
|
PostCourseEnrollmentToJSON,
|
|
39
40
|
PutCourseFromJSON,
|
|
40
41
|
PutCourseToJSON,
|
|
42
|
+
PutCourseEnrollmentFromJSON,
|
|
43
|
+
PutCourseEnrollmentToJSON,
|
|
41
44
|
} from '../models/index';
|
|
42
45
|
|
|
43
46
|
export interface GetCourseRequest {
|
|
@@ -46,6 +49,15 @@ export interface GetCourseRequest {
|
|
|
46
49
|
|
|
47
50
|
export interface GetCourseEnrollmentRequest {
|
|
48
51
|
courseId: string;
|
|
52
|
+
enrollmentId: string;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export interface GetCourseEnrollmentsRequest {
|
|
56
|
+
courseId: string;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export interface GetCourseListRequest {
|
|
60
|
+
enrolled?: boolean;
|
|
49
61
|
}
|
|
50
62
|
|
|
51
63
|
export interface PostCourseRequest {
|
|
@@ -62,6 +74,12 @@ export interface PutCourseRequest {
|
|
|
62
74
|
putCourse: Omit<PutCourse, 'id'>;
|
|
63
75
|
}
|
|
64
76
|
|
|
77
|
+
export interface PutCourseEnrollmentRequest {
|
|
78
|
+
courseId: string;
|
|
79
|
+
enrollmentId: string;
|
|
80
|
+
putCourseEnrollment: PutCourseEnrollment;
|
|
81
|
+
}
|
|
82
|
+
|
|
65
83
|
/**
|
|
66
84
|
*
|
|
67
85
|
*/
|
|
@@ -101,9 +119,9 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
101
119
|
}
|
|
102
120
|
|
|
103
121
|
/**
|
|
104
|
-
*
|
|
122
|
+
* Get a specific course enrollment
|
|
105
123
|
*/
|
|
106
|
-
async getCourseEnrollmentRaw(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
124
|
+
async getCourseEnrollmentRaw(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>> {
|
|
107
125
|
if (requestParameters['courseId'] == null) {
|
|
108
126
|
throw new runtime.RequiredError(
|
|
109
127
|
'courseId',
|
|
@@ -111,34 +129,78 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
111
129
|
);
|
|
112
130
|
}
|
|
113
131
|
|
|
132
|
+
if (requestParameters['enrollmentId'] == null) {
|
|
133
|
+
throw new runtime.RequiredError(
|
|
134
|
+
'enrollmentId',
|
|
135
|
+
'Required parameter "enrollmentId" was null or undefined when calling getCourseEnrollment().'
|
|
136
|
+
);
|
|
137
|
+
}
|
|
138
|
+
|
|
114
139
|
const queryParameters: any = {};
|
|
115
140
|
|
|
116
141
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
117
142
|
|
|
118
143
|
const response = await this.request({
|
|
119
|
-
path: `/courses/{courseId}/
|
|
144
|
+
path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
|
|
120
145
|
method: 'GET',
|
|
121
146
|
headers: headerParameters,
|
|
122
147
|
query: queryParameters,
|
|
123
148
|
}, initOverrides);
|
|
124
149
|
|
|
125
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
150
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseEnrollmentFromJSON(jsonValue));
|
|
126
151
|
}
|
|
127
152
|
|
|
128
153
|
/**
|
|
129
|
-
*
|
|
154
|
+
* Get a specific course enrollment
|
|
130
155
|
*/
|
|
131
|
-
async getCourseEnrollment(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
156
|
+
async getCourseEnrollment(requestParameters: GetCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment> {
|
|
132
157
|
const response = await this.getCourseEnrollmentRaw(requestParameters, initOverrides);
|
|
133
158
|
return await response.value();
|
|
134
159
|
}
|
|
135
160
|
|
|
161
|
+
/**
|
|
162
|
+
* Get course enrollments
|
|
163
|
+
*/
|
|
164
|
+
async getCourseEnrollmentsRaw(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollmentList>> {
|
|
165
|
+
if (requestParameters['courseId'] == null) {
|
|
166
|
+
throw new runtime.RequiredError(
|
|
167
|
+
'courseId',
|
|
168
|
+
'Required parameter "courseId" was null or undefined when calling getCourseEnrollments().'
|
|
169
|
+
);
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
const queryParameters: any = {};
|
|
173
|
+
|
|
174
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
175
|
+
|
|
176
|
+
const response = await this.request({
|
|
177
|
+
path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
178
|
+
method: 'GET',
|
|
179
|
+
headers: headerParameters,
|
|
180
|
+
query: queryParameters,
|
|
181
|
+
}, initOverrides);
|
|
182
|
+
|
|
183
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseEnrollmentListFromJSON(jsonValue));
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
/**
|
|
187
|
+
* Get course enrollments
|
|
188
|
+
*/
|
|
189
|
+
async getCourseEnrollments(requestParameters: GetCourseEnrollmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollmentList> {
|
|
190
|
+
const response = await this.getCourseEnrollmentsRaw(requestParameters, initOverrides);
|
|
191
|
+
return await response.value();
|
|
192
|
+
}
|
|
193
|
+
|
|
136
194
|
/**
|
|
137
195
|
* get course list
|
|
138
196
|
*/
|
|
139
|
-
async getCourseListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseList>> {
|
|
197
|
+
async getCourseListRaw(requestParameters: GetCourseListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseList>> {
|
|
140
198
|
const queryParameters: any = {};
|
|
141
199
|
|
|
200
|
+
if (requestParameters['enrolled'] != null) {
|
|
201
|
+
queryParameters['enrolled'] = requestParameters['enrolled'];
|
|
202
|
+
}
|
|
203
|
+
|
|
142
204
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
143
205
|
|
|
144
206
|
const response = await this.request({
|
|
@@ -154,8 +216,8 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
154
216
|
/**
|
|
155
217
|
* get course list
|
|
156
218
|
*/
|
|
157
|
-
async getCourseList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseList> {
|
|
158
|
-
const response = await this.getCourseListRaw(initOverrides);
|
|
219
|
+
async getCourseList(requestParameters: GetCourseListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseList> {
|
|
220
|
+
const response = await this.getCourseListRaw(requestParameters, initOverrides);
|
|
159
221
|
return await response.value();
|
|
160
222
|
}
|
|
161
223
|
|
|
@@ -196,7 +258,7 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
196
258
|
}
|
|
197
259
|
|
|
198
260
|
/**
|
|
199
|
-
*
|
|
261
|
+
* Create a new course enrollment
|
|
200
262
|
*/
|
|
201
263
|
async postCourseEnrollmentRaw(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>> {
|
|
202
264
|
if (requestParameters['courseId'] == null) {
|
|
@@ -220,7 +282,7 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
220
282
|
headerParameters['Content-Type'] = 'application/json';
|
|
221
283
|
|
|
222
284
|
const response = await this.request({
|
|
223
|
-
path: `/courses/{courseId}/
|
|
285
|
+
path: `/courses/{courseId}/enrollments`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
|
|
224
286
|
method: 'POST',
|
|
225
287
|
headers: headerParameters,
|
|
226
288
|
query: queryParameters,
|
|
@@ -231,7 +293,7 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
231
293
|
}
|
|
232
294
|
|
|
233
295
|
/**
|
|
234
|
-
*
|
|
296
|
+
* Create a new course enrollment
|
|
235
297
|
*/
|
|
236
298
|
async postCourseEnrollment(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment> {
|
|
237
299
|
const response = await this.postCourseEnrollmentRaw(requestParameters, initOverrides);
|
|
@@ -281,4 +343,54 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
281
343
|
return await response.value();
|
|
282
344
|
}
|
|
283
345
|
|
|
346
|
+
/**
|
|
347
|
+
* Update a course enrollment
|
|
348
|
+
*/
|
|
349
|
+
async putCourseEnrollmentRaw(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>> {
|
|
350
|
+
if (requestParameters['courseId'] == null) {
|
|
351
|
+
throw new runtime.RequiredError(
|
|
352
|
+
'courseId',
|
|
353
|
+
'Required parameter "courseId" was null or undefined when calling putCourseEnrollment().'
|
|
354
|
+
);
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
if (requestParameters['enrollmentId'] == null) {
|
|
358
|
+
throw new runtime.RequiredError(
|
|
359
|
+
'enrollmentId',
|
|
360
|
+
'Required parameter "enrollmentId" was null or undefined when calling putCourseEnrollment().'
|
|
361
|
+
);
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
if (requestParameters['putCourseEnrollment'] == null) {
|
|
365
|
+
throw new runtime.RequiredError(
|
|
366
|
+
'putCourseEnrollment',
|
|
367
|
+
'Required parameter "putCourseEnrollment" was null or undefined when calling putCourseEnrollment().'
|
|
368
|
+
);
|
|
369
|
+
}
|
|
370
|
+
|
|
371
|
+
const queryParameters: any = {};
|
|
372
|
+
|
|
373
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
374
|
+
|
|
375
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
376
|
+
|
|
377
|
+
const response = await this.request({
|
|
378
|
+
path: `/courses/{courseId}/enrollments/{enrollmentId}`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"enrollmentId"}}`, encodeURIComponent(String(requestParameters['enrollmentId']))),
|
|
379
|
+
method: 'PUT',
|
|
380
|
+
headers: headerParameters,
|
|
381
|
+
query: queryParameters,
|
|
382
|
+
body: PutCourseEnrollmentToJSON(requestParameters['putCourseEnrollment']),
|
|
383
|
+
}, initOverrides);
|
|
384
|
+
|
|
385
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseEnrollmentFromJSON(jsonValue));
|
|
386
|
+
}
|
|
387
|
+
|
|
388
|
+
/**
|
|
389
|
+
* Update a course enrollment
|
|
390
|
+
*/
|
|
391
|
+
async putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment> {
|
|
392
|
+
const response = await this.putCourseEnrollmentRaw(requestParameters, initOverrides);
|
|
393
|
+
return await response.value();
|
|
394
|
+
}
|
|
395
|
+
|
|
284
396
|
}
|
package/src/apis/PortalApi.ts
CHANGED
|
@@ -44,6 +44,7 @@ export interface GetPortalByIdRequest {
|
|
|
44
44
|
export interface GetPortalUsersRequest {
|
|
45
45
|
portalId: string;
|
|
46
46
|
roles?: Array<GetPortalUsersRolesEnum>;
|
|
47
|
+
search?: string;
|
|
47
48
|
page?: number;
|
|
48
49
|
pageSize?: number;
|
|
49
50
|
}
|
|
@@ -148,6 +149,10 @@ export class PortalApi extends runtime.BaseAPI {
|
|
|
148
149
|
queryParameters['roles'] = requestParameters['roles'];
|
|
149
150
|
}
|
|
150
151
|
|
|
152
|
+
if (requestParameters['search'] != null) {
|
|
153
|
+
queryParameters['search'] = requestParameters['search'];
|
|
154
|
+
}
|
|
155
|
+
|
|
151
156
|
if (requestParameters['page'] != null) {
|
|
152
157
|
queryParameters['page'] = requestParameters['page'];
|
|
153
158
|
}
|
|
@@ -20,13 +20,19 @@ import { mapValues } from '../runtime';
|
|
|
20
20
|
*/
|
|
21
21
|
export interface GetCourseEnrollment {
|
|
22
22
|
/**
|
|
23
|
-
* The ID of the
|
|
23
|
+
* The external ID of the enrollment
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof GetCourseEnrollment
|
|
26
|
+
*/
|
|
27
|
+
id: string;
|
|
28
|
+
/**
|
|
29
|
+
* The external ID of the course
|
|
24
30
|
* @type {string}
|
|
25
31
|
* @memberof GetCourseEnrollment
|
|
26
32
|
*/
|
|
27
33
|
courseId: string;
|
|
28
34
|
/**
|
|
29
|
-
* The ID of the enrolled user
|
|
35
|
+
* The external ID of the enrolled user
|
|
30
36
|
* @type {string}
|
|
31
37
|
* @memberof GetCourseEnrollment
|
|
32
38
|
*/
|
|
@@ -69,10 +75,8 @@ export interface GetCourseEnrollment {
|
|
|
69
75
|
*/
|
|
70
76
|
export const GetCourseEnrollmentStatusEnum = {
|
|
71
77
|
Enrolled: 'Enrolled',
|
|
72
|
-
Dropped: 'Dropped',
|
|
73
78
|
Completed: 'Completed',
|
|
74
|
-
|
|
75
|
-
Unknown: 'Unknown'
|
|
79
|
+
Removed: 'Removed'
|
|
76
80
|
} as const;
|
|
77
81
|
export type GetCourseEnrollmentStatusEnum = typeof GetCourseEnrollmentStatusEnum[keyof typeof GetCourseEnrollmentStatusEnum];
|
|
78
82
|
|
|
@@ -81,6 +85,7 @@ export type GetCourseEnrollmentStatusEnum = typeof GetCourseEnrollmentStatusEnum
|
|
|
81
85
|
* Check if a given object implements the GetCourseEnrollment interface.
|
|
82
86
|
*/
|
|
83
87
|
export function instanceOfGetCourseEnrollment(value: object): value is GetCourseEnrollment {
|
|
88
|
+
if (!('id' in value) || value['id'] === undefined) return false;
|
|
84
89
|
if (!('courseId' in value) || value['courseId'] === undefined) return false;
|
|
85
90
|
if (!('userId' in value) || value['userId'] === undefined) return false;
|
|
86
91
|
if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
|
|
@@ -101,6 +106,7 @@ export function GetCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
101
106
|
}
|
|
102
107
|
return {
|
|
103
108
|
|
|
109
|
+
'id': json['id'],
|
|
104
110
|
'courseId': json['course_id'],
|
|
105
111
|
'userId': json['user_id'],
|
|
106
112
|
'enrollmentDateStart': json['enrollment_date_start'],
|
|
@@ -122,6 +128,7 @@ export function GetCourseEnrollmentToJSONTyped(value?: GetCourseEnrollment | nul
|
|
|
122
128
|
|
|
123
129
|
return {
|
|
124
130
|
|
|
131
|
+
'id': value['id'],
|
|
125
132
|
'course_id': value['courseId'],
|
|
126
133
|
'user_id': value['userId'],
|
|
127
134
|
'enrollment_date_start': value['enrollmentDateStart'],
|