@easyedu/js-lsm-api 1.97.0 → 1.98.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/README.md +2 -2
- package/dist/esm/models/GetCourseEnrollment.d.ts +12 -0
- package/dist/esm/models/GetCourseEnrollment.js +8 -0
- package/dist/esm/models/GetCourseEnrollmentListItem.d.ts +12 -0
- package/dist/esm/models/GetCourseEnrollmentListItem.js +8 -0
- package/dist/esm/models/PostCourseVersionPublish.d.ts +10 -0
- package/dist/esm/models/PostCourseVersionPublish.js +2 -0
- package/dist/esm/models/PutCourseEnrollment.d.ts +9 -0
- package/dist/esm/models/PutCourseEnrollment.js +2 -0
- package/dist/models/GetCourseEnrollment.d.ts +12 -0
- package/dist/models/GetCourseEnrollment.js +8 -0
- package/dist/models/GetCourseEnrollmentListItem.d.ts +12 -0
- package/dist/models/GetCourseEnrollmentListItem.js +8 -0
- package/dist/models/PostCourseVersionPublish.d.ts +10 -0
- package/dist/models/PostCourseVersionPublish.js +2 -0
- package/dist/models/PutCourseEnrollment.d.ts +9 -0
- package/dist/models/PutCourseEnrollment.js +2 -0
- package/docs/GetCourseEnrollment.md +4 -0
- package/docs/GetCourseEnrollmentListItem.md +4 -0
- package/docs/PostCourseVersionPublish.md +2 -0
- package/docs/PutCourseEnrollment.md +2 -0
- package/package.json +1 -1
- package/src/models/GetCourseEnrollment.ts +18 -0
- package/src/models/GetCourseEnrollmentListItem.ts +18 -0
- package/src/models/PostCourseVersionPublish.ts +12 -0
- package/src/models/PutCourseEnrollment.ts +11 -0
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.98.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -594,7 +594,7 @@ and is automatically generated by the
|
|
|
594
594
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
595
595
|
|
|
596
596
|
- API version: `1.0.0`
|
|
597
|
-
- Package version: `1.
|
|
597
|
+
- Package version: `1.98.0`
|
|
598
598
|
- Generator version: `7.22.0`
|
|
599
599
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
600
600
|
|
|
@@ -33,6 +33,18 @@ export interface GetCourseEnrollment {
|
|
|
33
33
|
* @memberof GetCourseEnrollment
|
|
34
34
|
*/
|
|
35
35
|
userId: string;
|
|
36
|
+
/**
|
|
37
|
+
* The published course version assigned to this enrollment. Null for unpinned instructor enrollments.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof GetCourseEnrollment
|
|
40
|
+
*/
|
|
41
|
+
courseVersionId: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* The display number of the assigned course version. Null for unpinned instructor enrollments.
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof GetCourseEnrollment
|
|
46
|
+
*/
|
|
47
|
+
courseVersionNumber: number | null;
|
|
36
48
|
/**
|
|
37
49
|
* Start date of the enrollment (Unix timestamp)
|
|
38
50
|
* @type {number}
|
|
@@ -55,6 +55,10 @@ export function instanceOfGetCourseEnrollment(value) {
|
|
|
55
55
|
return false;
|
|
56
56
|
if (!('userId' in value) || value['userId'] === undefined)
|
|
57
57
|
return false;
|
|
58
|
+
if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
|
|
59
|
+
return false;
|
|
60
|
+
if (!('courseVersionNumber' in value) || value['courseVersionNumber'] === undefined)
|
|
61
|
+
return false;
|
|
58
62
|
if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined)
|
|
59
63
|
return false;
|
|
60
64
|
if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined)
|
|
@@ -84,6 +88,8 @@ export function GetCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
84
88
|
'id': json['id'],
|
|
85
89
|
'courseId': json['course_id'],
|
|
86
90
|
'userId': json['user_id'],
|
|
91
|
+
'courseVersionId': json['course_version_id'],
|
|
92
|
+
'courseVersionNumber': json['course_version_number'],
|
|
87
93
|
'enrollmentDateStart': json['enrollment_date_start'],
|
|
88
94
|
'enrollmentDateEnd': json['enrollment_date_end'],
|
|
89
95
|
'notes': json['notes'],
|
|
@@ -105,6 +111,8 @@ export function GetCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = fals
|
|
|
105
111
|
'id': value['id'],
|
|
106
112
|
'course_id': value['courseId'],
|
|
107
113
|
'user_id': value['userId'],
|
|
114
|
+
'course_version_id': value['courseVersionId'],
|
|
115
|
+
'course_version_number': value['courseVersionNumber'],
|
|
108
116
|
'enrollment_date_start': value['enrollmentDateStart'],
|
|
109
117
|
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
110
118
|
'notes': value['notes'],
|
|
@@ -33,6 +33,18 @@ export interface GetCourseEnrollmentListItem {
|
|
|
33
33
|
* @memberof GetCourseEnrollmentListItem
|
|
34
34
|
*/
|
|
35
35
|
userId: string;
|
|
36
|
+
/**
|
|
37
|
+
* The published course version assigned to this enrollment. Null for unpinned instructor enrollments.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof GetCourseEnrollmentListItem
|
|
40
|
+
*/
|
|
41
|
+
courseVersionId: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* The display number of the assigned course version. Null for unpinned instructor enrollments.
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof GetCourseEnrollmentListItem
|
|
46
|
+
*/
|
|
47
|
+
courseVersionNumber: number | null;
|
|
36
48
|
/**
|
|
37
49
|
* The first name of the enrolled user
|
|
38
50
|
* @type {string}
|
|
@@ -55,6 +55,10 @@ export function instanceOfGetCourseEnrollmentListItem(value) {
|
|
|
55
55
|
return false;
|
|
56
56
|
if (!('userId' in value) || value['userId'] === undefined)
|
|
57
57
|
return false;
|
|
58
|
+
if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
|
|
59
|
+
return false;
|
|
60
|
+
if (!('courseVersionNumber' in value) || value['courseVersionNumber'] === undefined)
|
|
61
|
+
return false;
|
|
58
62
|
if (!('firstName' in value) || value['firstName'] === undefined)
|
|
59
63
|
return false;
|
|
60
64
|
if (!('lastName' in value) || value['lastName'] === undefined)
|
|
@@ -86,6 +90,8 @@ export function GetCourseEnrollmentListItemFromJSONTyped(json, ignoreDiscriminat
|
|
|
86
90
|
'id': json['id'],
|
|
87
91
|
'courseId': json['course_id'],
|
|
88
92
|
'userId': json['user_id'],
|
|
93
|
+
'courseVersionId': json['course_version_id'],
|
|
94
|
+
'courseVersionNumber': json['course_version_number'],
|
|
89
95
|
'firstName': json['first_name'],
|
|
90
96
|
'lastName': json['last_name'],
|
|
91
97
|
'enrollmentDateStart': json['enrollment_date_start'],
|
|
@@ -108,6 +114,8 @@ export function GetCourseEnrollmentListItemToJSONTyped(value, ignoreDiscriminato
|
|
|
108
114
|
'id': value['id'],
|
|
109
115
|
'course_id': value['courseId'],
|
|
110
116
|
'user_id': value['userId'],
|
|
117
|
+
'course_version_id': value['courseVersionId'],
|
|
118
|
+
'course_version_number': value['courseVersionNumber'],
|
|
111
119
|
'first_name': value['firstName'],
|
|
112
120
|
'last_name': value['lastName'],
|
|
113
121
|
'enrollment_date_start': value['enrollmentDateStart'],
|
|
@@ -21,6 +21,16 @@ export interface PostCourseVersionPublish {
|
|
|
21
21
|
* @memberof PostCourseVersionPublish
|
|
22
22
|
*/
|
|
23
23
|
changeNotes?: string;
|
|
24
|
+
/**
|
|
25
|
+
* When true, assign all Enrolled, InProgress, and Suspended Student enrollments
|
|
26
|
+
* for this course to the newly published version. Completed and other historical
|
|
27
|
+
* enrollments remain pinned to their original version. Existing progress and
|
|
28
|
+
* session history remain stored against the previous version and are not transferred.
|
|
29
|
+
*
|
|
30
|
+
* @type {boolean}
|
|
31
|
+
* @memberof PostCourseVersionPublish
|
|
32
|
+
*/
|
|
33
|
+
promoteActiveEnrollments?: boolean;
|
|
24
34
|
}
|
|
25
35
|
/**
|
|
26
36
|
* Check if a given object implements the PostCourseVersionPublish interface.
|
|
@@ -26,6 +26,7 @@ export function PostCourseVersionPublishFromJSONTyped(json, ignoreDiscriminator)
|
|
|
26
26
|
}
|
|
27
27
|
return {
|
|
28
28
|
'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
|
|
29
|
+
'promoteActiveEnrollments': json['promote_active_enrollments'] == null ? undefined : json['promote_active_enrollments'],
|
|
29
30
|
};
|
|
30
31
|
}
|
|
31
32
|
export function PostCourseVersionPublishToJSON(json) {
|
|
@@ -37,5 +38,6 @@ export function PostCourseVersionPublishToJSONTyped(value, ignoreDiscriminator =
|
|
|
37
38
|
}
|
|
38
39
|
return {
|
|
39
40
|
'change_notes': value['changeNotes'],
|
|
41
|
+
'promote_active_enrollments': value['promoteActiveEnrollments'],
|
|
40
42
|
};
|
|
41
43
|
}
|
|
@@ -48,6 +48,15 @@ export interface PutCourseEnrollment {
|
|
|
48
48
|
* @memberof PutCourseEnrollment
|
|
49
49
|
*/
|
|
50
50
|
notes?: string;
|
|
51
|
+
/**
|
|
52
|
+
* Reassign this learner enrollment to a published version of the same course.
|
|
53
|
+
* Only active or suspended Student enrollments can be reassigned. Progress and
|
|
54
|
+
* session history for the previous version are retained but are not transferred.
|
|
55
|
+
*
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof PutCourseEnrollment
|
|
58
|
+
*/
|
|
59
|
+
courseVersionId?: string;
|
|
51
60
|
}
|
|
52
61
|
/**
|
|
53
62
|
* @export
|
|
@@ -49,6 +49,7 @@ export function PutCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
49
49
|
'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
|
|
50
50
|
'extensionDays': json['extension_days'] == null ? undefined : json['extension_days'],
|
|
51
51
|
'notes': json['notes'] == null ? undefined : json['notes'],
|
|
52
|
+
'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
|
|
52
53
|
};
|
|
53
54
|
}
|
|
54
55
|
export function PutCourseEnrollmentToJSON(json) {
|
|
@@ -64,5 +65,6 @@ export function PutCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = fals
|
|
|
64
65
|
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
65
66
|
'extension_days': value['extensionDays'],
|
|
66
67
|
'notes': value['notes'],
|
|
68
|
+
'course_version_id': value['courseVersionId'],
|
|
67
69
|
};
|
|
68
70
|
}
|
|
@@ -33,6 +33,18 @@ export interface GetCourseEnrollment {
|
|
|
33
33
|
* @memberof GetCourseEnrollment
|
|
34
34
|
*/
|
|
35
35
|
userId: string;
|
|
36
|
+
/**
|
|
37
|
+
* The published course version assigned to this enrollment. Null for unpinned instructor enrollments.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof GetCourseEnrollment
|
|
40
|
+
*/
|
|
41
|
+
courseVersionId: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* The display number of the assigned course version. Null for unpinned instructor enrollments.
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof GetCourseEnrollment
|
|
46
|
+
*/
|
|
47
|
+
courseVersionNumber: number | null;
|
|
36
48
|
/**
|
|
37
49
|
* Start date of the enrollment (Unix timestamp)
|
|
38
50
|
* @type {number}
|
|
@@ -63,6 +63,10 @@ function instanceOfGetCourseEnrollment(value) {
|
|
|
63
63
|
return false;
|
|
64
64
|
if (!('userId' in value) || value['userId'] === undefined)
|
|
65
65
|
return false;
|
|
66
|
+
if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
|
|
67
|
+
return false;
|
|
68
|
+
if (!('courseVersionNumber' in value) || value['courseVersionNumber'] === undefined)
|
|
69
|
+
return false;
|
|
66
70
|
if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined)
|
|
67
71
|
return false;
|
|
68
72
|
if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined)
|
|
@@ -92,6 +96,8 @@ function GetCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
92
96
|
'id': json['id'],
|
|
93
97
|
'courseId': json['course_id'],
|
|
94
98
|
'userId': json['user_id'],
|
|
99
|
+
'courseVersionId': json['course_version_id'],
|
|
100
|
+
'courseVersionNumber': json['course_version_number'],
|
|
95
101
|
'enrollmentDateStart': json['enrollment_date_start'],
|
|
96
102
|
'enrollmentDateEnd': json['enrollment_date_end'],
|
|
97
103
|
'notes': json['notes'],
|
|
@@ -113,6 +119,8 @@ function GetCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
113
119
|
'id': value['id'],
|
|
114
120
|
'course_id': value['courseId'],
|
|
115
121
|
'user_id': value['userId'],
|
|
122
|
+
'course_version_id': value['courseVersionId'],
|
|
123
|
+
'course_version_number': value['courseVersionNumber'],
|
|
116
124
|
'enrollment_date_start': value['enrollmentDateStart'],
|
|
117
125
|
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
118
126
|
'notes': value['notes'],
|
|
@@ -33,6 +33,18 @@ export interface GetCourseEnrollmentListItem {
|
|
|
33
33
|
* @memberof GetCourseEnrollmentListItem
|
|
34
34
|
*/
|
|
35
35
|
userId: string;
|
|
36
|
+
/**
|
|
37
|
+
* The published course version assigned to this enrollment. Null for unpinned instructor enrollments.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof GetCourseEnrollmentListItem
|
|
40
|
+
*/
|
|
41
|
+
courseVersionId: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* The display number of the assigned course version. Null for unpinned instructor enrollments.
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof GetCourseEnrollmentListItem
|
|
46
|
+
*/
|
|
47
|
+
courseVersionNumber: number | null;
|
|
36
48
|
/**
|
|
37
49
|
* The first name of the enrolled user
|
|
38
50
|
* @type {string}
|
|
@@ -63,6 +63,10 @@ function instanceOfGetCourseEnrollmentListItem(value) {
|
|
|
63
63
|
return false;
|
|
64
64
|
if (!('userId' in value) || value['userId'] === undefined)
|
|
65
65
|
return false;
|
|
66
|
+
if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
|
|
67
|
+
return false;
|
|
68
|
+
if (!('courseVersionNumber' in value) || value['courseVersionNumber'] === undefined)
|
|
69
|
+
return false;
|
|
66
70
|
if (!('firstName' in value) || value['firstName'] === undefined)
|
|
67
71
|
return false;
|
|
68
72
|
if (!('lastName' in value) || value['lastName'] === undefined)
|
|
@@ -94,6 +98,8 @@ function GetCourseEnrollmentListItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
94
98
|
'id': json['id'],
|
|
95
99
|
'courseId': json['course_id'],
|
|
96
100
|
'userId': json['user_id'],
|
|
101
|
+
'courseVersionId': json['course_version_id'],
|
|
102
|
+
'courseVersionNumber': json['course_version_number'],
|
|
97
103
|
'firstName': json['first_name'],
|
|
98
104
|
'lastName': json['last_name'],
|
|
99
105
|
'enrollmentDateStart': json['enrollment_date_start'],
|
|
@@ -116,6 +122,8 @@ function GetCourseEnrollmentListItemToJSONTyped(value, ignoreDiscriminator = fal
|
|
|
116
122
|
'id': value['id'],
|
|
117
123
|
'course_id': value['courseId'],
|
|
118
124
|
'user_id': value['userId'],
|
|
125
|
+
'course_version_id': value['courseVersionId'],
|
|
126
|
+
'course_version_number': value['courseVersionNumber'],
|
|
119
127
|
'first_name': value['firstName'],
|
|
120
128
|
'last_name': value['lastName'],
|
|
121
129
|
'enrollment_date_start': value['enrollmentDateStart'],
|
|
@@ -21,6 +21,16 @@ export interface PostCourseVersionPublish {
|
|
|
21
21
|
* @memberof PostCourseVersionPublish
|
|
22
22
|
*/
|
|
23
23
|
changeNotes?: string;
|
|
24
|
+
/**
|
|
25
|
+
* When true, assign all Enrolled, InProgress, and Suspended Student enrollments
|
|
26
|
+
* for this course to the newly published version. Completed and other historical
|
|
27
|
+
* enrollments remain pinned to their original version. Existing progress and
|
|
28
|
+
* session history remain stored against the previous version and are not transferred.
|
|
29
|
+
*
|
|
30
|
+
* @type {boolean}
|
|
31
|
+
* @memberof PostCourseVersionPublish
|
|
32
|
+
*/
|
|
33
|
+
promoteActiveEnrollments?: boolean;
|
|
24
34
|
}
|
|
25
35
|
/**
|
|
26
36
|
* Check if a given object implements the PostCourseVersionPublish interface.
|
|
@@ -33,6 +33,7 @@ function PostCourseVersionPublishFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
33
33
|
}
|
|
34
34
|
return {
|
|
35
35
|
'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
|
|
36
|
+
'promoteActiveEnrollments': json['promote_active_enrollments'] == null ? undefined : json['promote_active_enrollments'],
|
|
36
37
|
};
|
|
37
38
|
}
|
|
38
39
|
function PostCourseVersionPublishToJSON(json) {
|
|
@@ -44,5 +45,6 @@ function PostCourseVersionPublishToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
44
45
|
}
|
|
45
46
|
return {
|
|
46
47
|
'change_notes': value['changeNotes'],
|
|
48
|
+
'promote_active_enrollments': value['promoteActiveEnrollments'],
|
|
47
49
|
};
|
|
48
50
|
}
|
|
@@ -48,6 +48,15 @@ export interface PutCourseEnrollment {
|
|
|
48
48
|
* @memberof PutCourseEnrollment
|
|
49
49
|
*/
|
|
50
50
|
notes?: string;
|
|
51
|
+
/**
|
|
52
|
+
* Reassign this learner enrollment to a published version of the same course.
|
|
53
|
+
* Only active or suspended Student enrollments can be reassigned. Progress and
|
|
54
|
+
* session history for the previous version are retained but are not transferred.
|
|
55
|
+
*
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof PutCourseEnrollment
|
|
58
|
+
*/
|
|
59
|
+
courseVersionId?: string;
|
|
51
60
|
}
|
|
52
61
|
/**
|
|
53
62
|
* @export
|
|
@@ -57,6 +57,7 @@ function PutCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
57
57
|
'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
|
|
58
58
|
'extensionDays': json['extension_days'] == null ? undefined : json['extension_days'],
|
|
59
59
|
'notes': json['notes'] == null ? undefined : json['notes'],
|
|
60
|
+
'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
|
|
60
61
|
};
|
|
61
62
|
}
|
|
62
63
|
function PutCourseEnrollmentToJSON(json) {
|
|
@@ -72,5 +73,6 @@ function PutCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
72
73
|
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
73
74
|
'extension_days': value['extensionDays'],
|
|
74
75
|
'notes': value['notes'],
|
|
76
|
+
'course_version_id': value['courseVersionId'],
|
|
75
77
|
};
|
|
76
78
|
}
|
|
@@ -10,6 +10,8 @@ Name | Type
|
|
|
10
10
|
`id` | string
|
|
11
11
|
`courseId` | string
|
|
12
12
|
`userId` | string
|
|
13
|
+
`courseVersionId` | string
|
|
14
|
+
`courseVersionNumber` | number
|
|
13
15
|
`enrollmentDateStart` | number
|
|
14
16
|
`enrollmentDateEnd` | number
|
|
15
17
|
`notes` | string
|
|
@@ -29,6 +31,8 @@ const example = {
|
|
|
29
31
|
"id": null,
|
|
30
32
|
"courseId": null,
|
|
31
33
|
"userId": null,
|
|
34
|
+
"courseVersionId": null,
|
|
35
|
+
"courseVersionNumber": null,
|
|
32
36
|
"enrollmentDateStart": null,
|
|
33
37
|
"enrollmentDateEnd": null,
|
|
34
38
|
"notes": null,
|
|
@@ -10,6 +10,8 @@ Name | Type
|
|
|
10
10
|
`id` | string
|
|
11
11
|
`courseId` | string
|
|
12
12
|
`userId` | string
|
|
13
|
+
`courseVersionId` | string
|
|
14
|
+
`courseVersionNumber` | number
|
|
13
15
|
`firstName` | string
|
|
14
16
|
`lastName` | string
|
|
15
17
|
`enrollmentDateStart` | number
|
|
@@ -30,6 +32,8 @@ const example = {
|
|
|
30
32
|
"id": null,
|
|
31
33
|
"courseId": null,
|
|
32
34
|
"userId": null,
|
|
35
|
+
"courseVersionId": null,
|
|
36
|
+
"courseVersionNumber": null,
|
|
33
37
|
"firstName": null,
|
|
34
38
|
"lastName": null,
|
|
35
39
|
"enrollmentDateStart": null,
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`changeNotes` | string
|
|
10
|
+
`promoteActiveEnrollments` | boolean
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ import type { PostCourseVersionPublish } from '@easyedu/js-lsm-api'
|
|
|
16
17
|
// TODO: Update the object below with actual values
|
|
17
18
|
const example = {
|
|
18
19
|
"changeNotes": null,
|
|
20
|
+
"promoteActiveEnrollments": null,
|
|
19
21
|
} satisfies PostCourseVersionPublish
|
|
20
22
|
|
|
21
23
|
console.log(example)
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`enrollmentDateEnd` | number
|
|
12
12
|
`extensionDays` | number
|
|
13
13
|
`notes` | string
|
|
14
|
+
`courseVersionId` | string
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -24,6 +25,7 @@ const example = {
|
|
|
24
25
|
"enrollmentDateEnd": null,
|
|
25
26
|
"extensionDays": null,
|
|
26
27
|
"notes": null,
|
|
28
|
+
"courseVersionId": null,
|
|
27
29
|
} satisfies PutCourseEnrollment
|
|
28
30
|
|
|
29
31
|
console.log(example)
|
package/package.json
CHANGED
|
@@ -37,6 +37,18 @@ export interface GetCourseEnrollment {
|
|
|
37
37
|
* @memberof GetCourseEnrollment
|
|
38
38
|
*/
|
|
39
39
|
userId: string;
|
|
40
|
+
/**
|
|
41
|
+
* The published course version assigned to this enrollment. Null for unpinned instructor enrollments.
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof GetCourseEnrollment
|
|
44
|
+
*/
|
|
45
|
+
courseVersionId: string | null;
|
|
46
|
+
/**
|
|
47
|
+
* The display number of the assigned course version. Null for unpinned instructor enrollments.
|
|
48
|
+
* @type {number}
|
|
49
|
+
* @memberof GetCourseEnrollment
|
|
50
|
+
*/
|
|
51
|
+
courseVersionNumber: number | null;
|
|
40
52
|
/**
|
|
41
53
|
* Start date of the enrollment (Unix timestamp)
|
|
42
54
|
* @type {number}
|
|
@@ -146,6 +158,8 @@ export function instanceOfGetCourseEnrollment(value: object): value is GetCourse
|
|
|
146
158
|
if (!('id' in value) || value['id'] === undefined) return false;
|
|
147
159
|
if (!('courseId' in value) || value['courseId'] === undefined) return false;
|
|
148
160
|
if (!('userId' in value) || value['userId'] === undefined) return false;
|
|
161
|
+
if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
|
|
162
|
+
if (!('courseVersionNumber' in value) || value['courseVersionNumber'] === undefined) return false;
|
|
149
163
|
if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
|
|
150
164
|
if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined) return false;
|
|
151
165
|
if (!('notes' in value) || value['notes'] === undefined) return false;
|
|
@@ -170,6 +184,8 @@ export function GetCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
170
184
|
'id': json['id'],
|
|
171
185
|
'courseId': json['course_id'],
|
|
172
186
|
'userId': json['user_id'],
|
|
187
|
+
'courseVersionId': json['course_version_id'],
|
|
188
|
+
'courseVersionNumber': json['course_version_number'],
|
|
173
189
|
'enrollmentDateStart': json['enrollment_date_start'],
|
|
174
190
|
'enrollmentDateEnd': json['enrollment_date_end'],
|
|
175
191
|
'notes': json['notes'],
|
|
@@ -195,6 +211,8 @@ export function GetCourseEnrollmentToJSONTyped(value?: GetCourseEnrollment | nul
|
|
|
195
211
|
'id': value['id'],
|
|
196
212
|
'course_id': value['courseId'],
|
|
197
213
|
'user_id': value['userId'],
|
|
214
|
+
'course_version_id': value['courseVersionId'],
|
|
215
|
+
'course_version_number': value['courseVersionNumber'],
|
|
198
216
|
'enrollment_date_start': value['enrollmentDateStart'],
|
|
199
217
|
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
200
218
|
'notes': value['notes'],
|
|
@@ -37,6 +37,18 @@ export interface GetCourseEnrollmentListItem {
|
|
|
37
37
|
* @memberof GetCourseEnrollmentListItem
|
|
38
38
|
*/
|
|
39
39
|
userId: string;
|
|
40
|
+
/**
|
|
41
|
+
* The published course version assigned to this enrollment. Null for unpinned instructor enrollments.
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof GetCourseEnrollmentListItem
|
|
44
|
+
*/
|
|
45
|
+
courseVersionId: string | null;
|
|
46
|
+
/**
|
|
47
|
+
* The display number of the assigned course version. Null for unpinned instructor enrollments.
|
|
48
|
+
* @type {number}
|
|
49
|
+
* @memberof GetCourseEnrollmentListItem
|
|
50
|
+
*/
|
|
51
|
+
courseVersionNumber: number | null;
|
|
40
52
|
/**
|
|
41
53
|
* The first name of the enrolled user
|
|
42
54
|
* @type {string}
|
|
@@ -142,6 +154,8 @@ export function instanceOfGetCourseEnrollmentListItem(value: object): value is G
|
|
|
142
154
|
if (!('id' in value) || value['id'] === undefined) return false;
|
|
143
155
|
if (!('courseId' in value) || value['courseId'] === undefined) return false;
|
|
144
156
|
if (!('userId' in value) || value['userId'] === undefined) return false;
|
|
157
|
+
if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
|
|
158
|
+
if (!('courseVersionNumber' in value) || value['courseVersionNumber'] === undefined) return false;
|
|
145
159
|
if (!('firstName' in value) || value['firstName'] === undefined) return false;
|
|
146
160
|
if (!('lastName' in value) || value['lastName'] === undefined) return false;
|
|
147
161
|
if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
|
|
@@ -167,6 +181,8 @@ export function GetCourseEnrollmentListItemFromJSONTyped(json: any, ignoreDiscri
|
|
|
167
181
|
'id': json['id'],
|
|
168
182
|
'courseId': json['course_id'],
|
|
169
183
|
'userId': json['user_id'],
|
|
184
|
+
'courseVersionId': json['course_version_id'],
|
|
185
|
+
'courseVersionNumber': json['course_version_number'],
|
|
170
186
|
'firstName': json['first_name'],
|
|
171
187
|
'lastName': json['last_name'],
|
|
172
188
|
'enrollmentDateStart': json['enrollment_date_start'],
|
|
@@ -193,6 +209,8 @@ export function GetCourseEnrollmentListItemToJSONTyped(value?: GetCourseEnrollme
|
|
|
193
209
|
'id': value['id'],
|
|
194
210
|
'course_id': value['courseId'],
|
|
195
211
|
'user_id': value['userId'],
|
|
212
|
+
'course_version_id': value['courseVersionId'],
|
|
213
|
+
'course_version_number': value['courseVersionNumber'],
|
|
196
214
|
'first_name': value['firstName'],
|
|
197
215
|
'last_name': value['lastName'],
|
|
198
216
|
'enrollment_date_start': value['enrollmentDateStart'],
|
|
@@ -25,6 +25,16 @@ export interface PostCourseVersionPublish {
|
|
|
25
25
|
* @memberof PostCourseVersionPublish
|
|
26
26
|
*/
|
|
27
27
|
changeNotes?: string;
|
|
28
|
+
/**
|
|
29
|
+
* When true, assign all Enrolled, InProgress, and Suspended Student enrollments
|
|
30
|
+
* for this course to the newly published version. Completed and other historical
|
|
31
|
+
* enrollments remain pinned to their original version. Existing progress and
|
|
32
|
+
* session history remain stored against the previous version and are not transferred.
|
|
33
|
+
*
|
|
34
|
+
* @type {boolean}
|
|
35
|
+
* @memberof PostCourseVersionPublish
|
|
36
|
+
*/
|
|
37
|
+
promoteActiveEnrollments?: boolean;
|
|
28
38
|
}
|
|
29
39
|
|
|
30
40
|
/**
|
|
@@ -45,6 +55,7 @@ export function PostCourseVersionPublishFromJSONTyped(json: any, ignoreDiscrimin
|
|
|
45
55
|
return {
|
|
46
56
|
|
|
47
57
|
'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
|
|
58
|
+
'promoteActiveEnrollments': json['promote_active_enrollments'] == null ? undefined : json['promote_active_enrollments'],
|
|
48
59
|
};
|
|
49
60
|
}
|
|
50
61
|
|
|
@@ -60,6 +71,7 @@ export function PostCourseVersionPublishToJSONTyped(value?: PostCourseVersionPub
|
|
|
60
71
|
return {
|
|
61
72
|
|
|
62
73
|
'change_notes': value['changeNotes'],
|
|
74
|
+
'promote_active_enrollments': value['promoteActiveEnrollments'],
|
|
63
75
|
};
|
|
64
76
|
}
|
|
65
77
|
|
|
@@ -52,6 +52,15 @@ export interface PutCourseEnrollment {
|
|
|
52
52
|
* @memberof PutCourseEnrollment
|
|
53
53
|
*/
|
|
54
54
|
notes?: string;
|
|
55
|
+
/**
|
|
56
|
+
* Reassign this learner enrollment to a published version of the same course.
|
|
57
|
+
* Only active or suspended Student enrollments can be reassigned. Progress and
|
|
58
|
+
* session history for the previous version are retained but are not transferred.
|
|
59
|
+
*
|
|
60
|
+
* @type {string}
|
|
61
|
+
* @memberof PutCourseEnrollment
|
|
62
|
+
*/
|
|
63
|
+
courseVersionId?: string;
|
|
55
64
|
}
|
|
56
65
|
|
|
57
66
|
|
|
@@ -101,6 +110,7 @@ export function PutCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
101
110
|
'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
|
|
102
111
|
'extensionDays': json['extension_days'] == null ? undefined : json['extension_days'],
|
|
103
112
|
'notes': json['notes'] == null ? undefined : json['notes'],
|
|
113
|
+
'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
|
|
104
114
|
};
|
|
105
115
|
}
|
|
106
116
|
|
|
@@ -120,6 +130,7 @@ export function PutCourseEnrollmentToJSONTyped(value?: PutCourseEnrollment | nul
|
|
|
120
130
|
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
121
131
|
'extension_days': value['extensionDays'],
|
|
122
132
|
'notes': value['notes'],
|
|
133
|
+
'course_version_id': value['courseVersionId'],
|
|
123
134
|
};
|
|
124
135
|
}
|
|
125
136
|
|