@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
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { GetCourseEnrollmentListItem } from './GetCourseEnrollmentListItem';
|
|
13
13
|
/**
|
|
14
14
|
* A list of course enrollments with pagination information
|
|
15
15
|
* @export
|
|
@@ -42,10 +42,10 @@ export interface GetCourseEnrollmentList {
|
|
|
42
42
|
totalItems: number;
|
|
43
43
|
/**
|
|
44
44
|
*
|
|
45
|
-
* @type {Array<
|
|
45
|
+
* @type {Array<GetCourseEnrollmentListItem>}
|
|
46
46
|
* @memberof GetCourseEnrollmentList
|
|
47
47
|
*/
|
|
48
|
-
items: Array<
|
|
48
|
+
items: Array<GetCourseEnrollmentListItem>;
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
51
|
* Check if a given object implements the GetCourseEnrollmentList interface.
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
import {
|
|
14
|
+
import { GetCourseEnrollmentListItemFromJSON, GetCourseEnrollmentListItemToJSON, } from './GetCourseEnrollmentListItem';
|
|
15
15
|
/**
|
|
16
16
|
* Check if a given object implements the GetCourseEnrollmentList interface.
|
|
17
17
|
*/
|
|
@@ -40,7 +40,7 @@ export function GetCourseEnrollmentListFromJSONTyped(json, ignoreDiscriminator)
|
|
|
40
40
|
'pageSize': json['pageSize'],
|
|
41
41
|
'totalPages': json['totalPages'],
|
|
42
42
|
'totalItems': json['totalItems'],
|
|
43
|
-
'items': (json['items'].map(
|
|
43
|
+
'items': (json['items'].map(GetCourseEnrollmentListItemFromJSON)),
|
|
44
44
|
};
|
|
45
45
|
}
|
|
46
46
|
export function GetCourseEnrollmentListToJSON(json) {
|
|
@@ -55,6 +55,6 @@ export function GetCourseEnrollmentListToJSONTyped(value, ignoreDiscriminator =
|
|
|
55
55
|
'pageSize': value['pageSize'],
|
|
56
56
|
'totalPages': value['totalPages'],
|
|
57
57
|
'totalItems': value['totalItems'],
|
|
58
|
-
'items': (value['items'].map(
|
|
58
|
+
'items': (value['items'].map(GetCourseEnrollmentListItemToJSON)),
|
|
59
59
|
};
|
|
60
60
|
}
|
|
@@ -0,0 +1,89 @@
|
|
|
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
|
+
* A course enrollment in a list view
|
|
14
|
+
* @export
|
|
15
|
+
* @interface GetCourseEnrollmentListItem
|
|
16
|
+
*/
|
|
17
|
+
export interface GetCourseEnrollmentListItem {
|
|
18
|
+
/**
|
|
19
|
+
* The external ID of the enrollment
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof GetCourseEnrollmentListItem
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
* The external ID of the course
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof GetCourseEnrollmentListItem
|
|
28
|
+
*/
|
|
29
|
+
courseId: string;
|
|
30
|
+
/**
|
|
31
|
+
* The external ID of the enrolled user
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof GetCourseEnrollmentListItem
|
|
34
|
+
*/
|
|
35
|
+
userId: string;
|
|
36
|
+
/**
|
|
37
|
+
* The first name of the enrolled user
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof GetCourseEnrollmentListItem
|
|
40
|
+
*/
|
|
41
|
+
firstName: string;
|
|
42
|
+
/**
|
|
43
|
+
* The last name of the enrolled user
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof GetCourseEnrollmentListItem
|
|
46
|
+
*/
|
|
47
|
+
lastName: string;
|
|
48
|
+
/**
|
|
49
|
+
* Start date of the enrollment (Unix timestamp)
|
|
50
|
+
* @type {number}
|
|
51
|
+
* @memberof GetCourseEnrollmentListItem
|
|
52
|
+
*/
|
|
53
|
+
enrollmentDateStart: number;
|
|
54
|
+
/**
|
|
55
|
+
* End date of the enrollment (Unix timestamp)
|
|
56
|
+
* @type {number}
|
|
57
|
+
* @memberof GetCourseEnrollmentListItem
|
|
58
|
+
*/
|
|
59
|
+
enrollmentDateEnd: number;
|
|
60
|
+
/**
|
|
61
|
+
* Current status of the enrollment
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof GetCourseEnrollmentListItem
|
|
64
|
+
*/
|
|
65
|
+
status: GetCourseEnrollmentListItemStatusEnum;
|
|
66
|
+
/**
|
|
67
|
+
* Date the course was completed (Unix timestamp)
|
|
68
|
+
* @type {number}
|
|
69
|
+
* @memberof GetCourseEnrollmentListItem
|
|
70
|
+
*/
|
|
71
|
+
completionDate: number | null;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* @export
|
|
75
|
+
*/
|
|
76
|
+
export declare const GetCourseEnrollmentListItemStatusEnum: {
|
|
77
|
+
readonly Enrolled: "Enrolled";
|
|
78
|
+
readonly Completed: "Completed";
|
|
79
|
+
readonly Removed: "Removed";
|
|
80
|
+
};
|
|
81
|
+
export type GetCourseEnrollmentListItemStatusEnum = typeof GetCourseEnrollmentListItemStatusEnum[keyof typeof GetCourseEnrollmentListItemStatusEnum];
|
|
82
|
+
/**
|
|
83
|
+
* Check if a given object implements the GetCourseEnrollmentListItem interface.
|
|
84
|
+
*/
|
|
85
|
+
export declare function instanceOfGetCourseEnrollmentListItem(value: object): value is GetCourseEnrollmentListItem;
|
|
86
|
+
export declare function GetCourseEnrollmentListItemFromJSON(json: any): GetCourseEnrollmentListItem;
|
|
87
|
+
export declare function GetCourseEnrollmentListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseEnrollmentListItem;
|
|
88
|
+
export declare function GetCourseEnrollmentListItemToJSON(json: any): GetCourseEnrollmentListItem;
|
|
89
|
+
export declare function GetCourseEnrollmentListItemToJSONTyped(value?: GetCourseEnrollmentListItem | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,83 @@
|
|
|
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 GetCourseEnrollmentListItemStatusEnum = {
|
|
18
|
+
Enrolled: 'Enrolled',
|
|
19
|
+
Completed: 'Completed',
|
|
20
|
+
Removed: 'Removed'
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the GetCourseEnrollmentListItem interface.
|
|
24
|
+
*/
|
|
25
|
+
export function instanceOfGetCourseEnrollmentListItem(value) {
|
|
26
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('userId' in value) || value['userId'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
if (!('firstName' in value) || value['firstName'] === undefined)
|
|
33
|
+
return false;
|
|
34
|
+
if (!('lastName' in value) || value['lastName'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('completionDate' in value) || value['completionDate'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
return true;
|
|
45
|
+
}
|
|
46
|
+
export function GetCourseEnrollmentListItemFromJSON(json) {
|
|
47
|
+
return GetCourseEnrollmentListItemFromJSONTyped(json, false);
|
|
48
|
+
}
|
|
49
|
+
export function GetCourseEnrollmentListItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
50
|
+
if (json == null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
'id': json['id'],
|
|
55
|
+
'courseId': json['course_id'],
|
|
56
|
+
'userId': json['user_id'],
|
|
57
|
+
'firstName': json['first_name'],
|
|
58
|
+
'lastName': json['last_name'],
|
|
59
|
+
'enrollmentDateStart': json['enrollment_date_start'],
|
|
60
|
+
'enrollmentDateEnd': json['enrollment_date_end'],
|
|
61
|
+
'status': json['status'],
|
|
62
|
+
'completionDate': json['completion_date'],
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
export function GetCourseEnrollmentListItemToJSON(json) {
|
|
66
|
+
return GetCourseEnrollmentListItemToJSONTyped(json, false);
|
|
67
|
+
}
|
|
68
|
+
export function GetCourseEnrollmentListItemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
69
|
+
if (value == null) {
|
|
70
|
+
return value;
|
|
71
|
+
}
|
|
72
|
+
return {
|
|
73
|
+
'id': value['id'],
|
|
74
|
+
'course_id': value['courseId'],
|
|
75
|
+
'user_id': value['userId'],
|
|
76
|
+
'first_name': value['firstName'],
|
|
77
|
+
'last_name': value['lastName'],
|
|
78
|
+
'enrollment_date_start': value['enrollmentDateStart'],
|
|
79
|
+
'enrollment_date_end': value['enrollmentDateEnd'],
|
|
80
|
+
'status': value['status'],
|
|
81
|
+
'completion_date': value['completionDate'],
|
|
82
|
+
};
|
|
83
|
+
}
|
|
@@ -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
|
+
}
|
|
@@ -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/esm/models/index.js
CHANGED
|
@@ -13,6 +13,7 @@ export * from './GetContentUpload';
|
|
|
13
13
|
export * from './GetCourse';
|
|
14
14
|
export * from './GetCourseEnrollment';
|
|
15
15
|
export * from './GetCourseEnrollmentList';
|
|
16
|
+
export * from './GetCourseEnrollmentListItem';
|
|
16
17
|
export * from './GetCourseList';
|
|
17
18
|
export * from './GetModule';
|
|
18
19
|
export * from './GetModuleList';
|
|
@@ -114,6 +115,7 @@ export * from './PostResetPassword';
|
|
|
114
115
|
export * from './PostSendResetPassword';
|
|
115
116
|
export * from './PutContent';
|
|
116
117
|
export * from './PutCourse';
|
|
118
|
+
export * from './PutCourseEnrollment';
|
|
117
119
|
export * from './PutModule';
|
|
118
120
|
export * from './PutPortalBranding';
|
|
119
121
|
export * from './PutQuestion';
|
|
@@ -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
|
/**
|
|
@@ -24,15 +24,15 @@ exports.GetCourseEnrollmentToJSONTyped = GetCourseEnrollmentToJSONTyped;
|
|
|
24
24
|
*/
|
|
25
25
|
exports.GetCourseEnrollmentStatusEnum = {
|
|
26
26
|
Enrolled: 'Enrolled',
|
|
27
|
-
Dropped: 'Dropped',
|
|
28
27
|
Completed: 'Completed',
|
|
29
|
-
|
|
30
|
-
Unknown: 'Unknown'
|
|
28
|
+
Removed: 'Removed'
|
|
31
29
|
};
|
|
32
30
|
/**
|
|
33
31
|
* Check if a given object implements the GetCourseEnrollment interface.
|
|
34
32
|
*/
|
|
35
33
|
function instanceOfGetCourseEnrollment(value) {
|
|
34
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
35
|
+
return false;
|
|
36
36
|
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
37
37
|
return false;
|
|
38
38
|
if (!('userId' in value) || value['userId'] === undefined)
|
|
@@ -57,6 +57,7 @@ function GetCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
57
57
|
return json;
|
|
58
58
|
}
|
|
59
59
|
return {
|
|
60
|
+
'id': json['id'],
|
|
60
61
|
'courseId': json['course_id'],
|
|
61
62
|
'userId': json['user_id'],
|
|
62
63
|
'enrollmentDateStart': json['enrollment_date_start'],
|
|
@@ -74,6 +75,7 @@ function GetCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
74
75
|
return value;
|
|
75
76
|
}
|
|
76
77
|
return {
|
|
78
|
+
'id': value['id'],
|
|
77
79
|
'course_id': value['courseId'],
|
|
78
80
|
'user_id': value['userId'],
|
|
79
81
|
'enrollment_date_start': value['enrollmentDateStart'],
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { GetCourseEnrollmentListItem } from './GetCourseEnrollmentListItem';
|
|
13
13
|
/**
|
|
14
14
|
* A list of course enrollments with pagination information
|
|
15
15
|
* @export
|
|
@@ -42,10 +42,10 @@ export interface GetCourseEnrollmentList {
|
|
|
42
42
|
totalItems: number;
|
|
43
43
|
/**
|
|
44
44
|
*
|
|
45
|
-
* @type {Array<
|
|
45
|
+
* @type {Array<GetCourseEnrollmentListItem>}
|
|
46
46
|
* @memberof GetCourseEnrollmentList
|
|
47
47
|
*/
|
|
48
|
-
items: Array<
|
|
48
|
+
items: Array<GetCourseEnrollmentListItem>;
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
51
|
* Check if a given object implements the GetCourseEnrollmentList interface.
|
|
@@ -18,7 +18,7 @@ exports.GetCourseEnrollmentListFromJSON = GetCourseEnrollmentListFromJSON;
|
|
|
18
18
|
exports.GetCourseEnrollmentListFromJSONTyped = GetCourseEnrollmentListFromJSONTyped;
|
|
19
19
|
exports.GetCourseEnrollmentListToJSON = GetCourseEnrollmentListToJSON;
|
|
20
20
|
exports.GetCourseEnrollmentListToJSONTyped = GetCourseEnrollmentListToJSONTyped;
|
|
21
|
-
const
|
|
21
|
+
const GetCourseEnrollmentListItem_1 = require("./GetCourseEnrollmentListItem");
|
|
22
22
|
/**
|
|
23
23
|
* Check if a given object implements the GetCourseEnrollmentList interface.
|
|
24
24
|
*/
|
|
@@ -47,7 +47,7 @@ function GetCourseEnrollmentListFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
47
47
|
'pageSize': json['pageSize'],
|
|
48
48
|
'totalPages': json['totalPages'],
|
|
49
49
|
'totalItems': json['totalItems'],
|
|
50
|
-
'items': (json['items'].map(
|
|
50
|
+
'items': (json['items'].map(GetCourseEnrollmentListItem_1.GetCourseEnrollmentListItemFromJSON)),
|
|
51
51
|
};
|
|
52
52
|
}
|
|
53
53
|
function GetCourseEnrollmentListToJSON(json) {
|
|
@@ -62,6 +62,6 @@ function GetCourseEnrollmentListToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
62
62
|
'pageSize': value['pageSize'],
|
|
63
63
|
'totalPages': value['totalPages'],
|
|
64
64
|
'totalItems': value['totalItems'],
|
|
65
|
-
'items': (value['items'].map(
|
|
65
|
+
'items': (value['items'].map(GetCourseEnrollmentListItem_1.GetCourseEnrollmentListItemToJSON)),
|
|
66
66
|
};
|
|
67
67
|
}
|
|
@@ -0,0 +1,89 @@
|
|
|
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
|
+
* A course enrollment in a list view
|
|
14
|
+
* @export
|
|
15
|
+
* @interface GetCourseEnrollmentListItem
|
|
16
|
+
*/
|
|
17
|
+
export interface GetCourseEnrollmentListItem {
|
|
18
|
+
/**
|
|
19
|
+
* The external ID of the enrollment
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof GetCourseEnrollmentListItem
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
* The external ID of the course
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof GetCourseEnrollmentListItem
|
|
28
|
+
*/
|
|
29
|
+
courseId: string;
|
|
30
|
+
/**
|
|
31
|
+
* The external ID of the enrolled user
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof GetCourseEnrollmentListItem
|
|
34
|
+
*/
|
|
35
|
+
userId: string;
|
|
36
|
+
/**
|
|
37
|
+
* The first name of the enrolled user
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof GetCourseEnrollmentListItem
|
|
40
|
+
*/
|
|
41
|
+
firstName: string;
|
|
42
|
+
/**
|
|
43
|
+
* The last name of the enrolled user
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof GetCourseEnrollmentListItem
|
|
46
|
+
*/
|
|
47
|
+
lastName: string;
|
|
48
|
+
/**
|
|
49
|
+
* Start date of the enrollment (Unix timestamp)
|
|
50
|
+
* @type {number}
|
|
51
|
+
* @memberof GetCourseEnrollmentListItem
|
|
52
|
+
*/
|
|
53
|
+
enrollmentDateStart: number;
|
|
54
|
+
/**
|
|
55
|
+
* End date of the enrollment (Unix timestamp)
|
|
56
|
+
* @type {number}
|
|
57
|
+
* @memberof GetCourseEnrollmentListItem
|
|
58
|
+
*/
|
|
59
|
+
enrollmentDateEnd: number;
|
|
60
|
+
/**
|
|
61
|
+
* Current status of the enrollment
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof GetCourseEnrollmentListItem
|
|
64
|
+
*/
|
|
65
|
+
status: GetCourseEnrollmentListItemStatusEnum;
|
|
66
|
+
/**
|
|
67
|
+
* Date the course was completed (Unix timestamp)
|
|
68
|
+
* @type {number}
|
|
69
|
+
* @memberof GetCourseEnrollmentListItem
|
|
70
|
+
*/
|
|
71
|
+
completionDate: number | null;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* @export
|
|
75
|
+
*/
|
|
76
|
+
export declare const GetCourseEnrollmentListItemStatusEnum: {
|
|
77
|
+
readonly Enrolled: "Enrolled";
|
|
78
|
+
readonly Completed: "Completed";
|
|
79
|
+
readonly Removed: "Removed";
|
|
80
|
+
};
|
|
81
|
+
export type GetCourseEnrollmentListItemStatusEnum = typeof GetCourseEnrollmentListItemStatusEnum[keyof typeof GetCourseEnrollmentListItemStatusEnum];
|
|
82
|
+
/**
|
|
83
|
+
* Check if a given object implements the GetCourseEnrollmentListItem interface.
|
|
84
|
+
*/
|
|
85
|
+
export declare function instanceOfGetCourseEnrollmentListItem(value: object): value is GetCourseEnrollmentListItem;
|
|
86
|
+
export declare function GetCourseEnrollmentListItemFromJSON(json: any): GetCourseEnrollmentListItem;
|
|
87
|
+
export declare function GetCourseEnrollmentListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseEnrollmentListItem;
|
|
88
|
+
export declare function GetCourseEnrollmentListItemToJSON(json: any): GetCourseEnrollmentListItem;
|
|
89
|
+
export declare function GetCourseEnrollmentListItemToJSONTyped(value?: GetCourseEnrollmentListItem | null, ignoreDiscriminator?: boolean): any;
|