@easyedu/js-lsm-api 1.66.0 → 1.68.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 +10 -2
- package/README.md +15 -3
- package/dist/apis/ContentApi.d.ts +74 -0
- package/dist/apis/ContentApi.js +172 -1
- package/dist/apis/CourseApi.d.ts +16 -0
- package/dist/apis/CourseApi.js +43 -0
- package/dist/apis/PortalApi.d.ts +58 -0
- package/dist/apis/PortalApi.js +152 -0
- package/dist/apis/SupportTicketApi.d.ts +2 -3
- package/dist/apis/SupportTicketApi.js +1 -2
- package/dist/esm/apis/ContentApi.d.ts +74 -0
- package/dist/esm/apis/ContentApi.js +171 -0
- package/dist/esm/apis/CourseApi.d.ts +16 -0
- package/dist/esm/apis/CourseApi.js +43 -0
- package/dist/esm/apis/PortalApi.d.ts +58 -0
- package/dist/esm/apis/PortalApi.js +152 -0
- package/dist/esm/apis/SupportTicketApi.d.ts +2 -3
- package/dist/esm/apis/SupportTicketApi.js +1 -2
- package/dist/esm/models/ContentAttemptItem.d.ts +69 -0
- package/dist/esm/models/ContentAttemptItem.js +68 -0
- package/dist/esm/models/ContentAttemptRollupScore.d.ts +38 -0
- package/dist/esm/models/ContentAttemptRollupScore.js +47 -0
- package/dist/esm/models/ContentAttemptScore.d.ts +50 -0
- package/dist/esm/models/ContentAttemptScore.js +47 -0
- package/dist/esm/models/ContentLaunchMode.d.ts +26 -0
- package/dist/esm/models/ContentLaunchMode.js +44 -0
- package/dist/esm/models/GetContent.d.ts +7 -0
- package/dist/esm/models/GetContent.js +5 -0
- package/dist/esm/models/GetContentAttempts.d.ts +90 -0
- package/dist/esm/models/GetContentAttempts.js +84 -0
- package/dist/esm/models/GetContentSession.d.ts +12 -0
- package/dist/esm/models/GetContentSession.js +8 -0
- package/dist/esm/models/GetContentSessionDetail.d.ts +12 -0
- package/dist/esm/models/GetContentSessionDetail.js +8 -0
- package/dist/esm/models/GetContentSessionListItem.d.ts +24 -0
- package/dist/esm/models/GetContentSessionListItem.js +16 -0
- package/dist/esm/models/GetPortal.d.ts +2 -2
- package/dist/esm/models/GetPortalFaviconUpload.d.ts +1 -1
- package/dist/esm/models/GetPortalLogoUpload.d.ts +1 -1
- package/dist/esm/models/GetPublicPortalBranding.d.ts +2 -2
- package/dist/esm/models/PostContentSession.d.ts +19 -0
- package/dist/esm/models/PostContentSession.js +13 -0
- package/dist/esm/models/PutContent.d.ts +7 -0
- package/dist/esm/models/PutContent.js +3 -0
- package/dist/esm/models/index.d.ts +5 -1
- package/dist/esm/models/index.js +5 -1
- package/dist/models/ContentAttemptItem.d.ts +69 -0
- package/dist/models/ContentAttemptItem.js +75 -0
- package/dist/models/ContentAttemptRollupScore.d.ts +38 -0
- package/dist/models/ContentAttemptRollupScore.js +54 -0
- package/dist/models/ContentAttemptScore.d.ts +50 -0
- package/dist/models/ContentAttemptScore.js +54 -0
- package/dist/models/ContentLaunchMode.d.ts +26 -0
- package/dist/models/ContentLaunchMode.js +52 -0
- package/dist/models/GetContent.d.ts +7 -0
- package/dist/models/GetContent.js +5 -0
- package/dist/models/GetContentAttempts.d.ts +90 -0
- package/dist/models/GetContentAttempts.js +92 -0
- package/dist/models/GetContentSession.d.ts +12 -0
- package/dist/models/GetContentSession.js +8 -0
- package/dist/models/GetContentSessionDetail.d.ts +12 -0
- package/dist/models/GetContentSessionDetail.js +8 -0
- package/dist/models/GetContentSessionListItem.d.ts +24 -0
- package/dist/models/GetContentSessionListItem.js +16 -0
- package/dist/models/GetPortal.d.ts +2 -2
- package/dist/models/GetPortalFaviconUpload.d.ts +1 -1
- package/dist/models/GetPortalLogoUpload.d.ts +1 -1
- package/dist/models/GetPublicPortalBranding.d.ts +2 -2
- package/dist/models/PostContentSession.d.ts +19 -0
- package/dist/models/PostContentSession.js +13 -0
- package/dist/models/PutContent.d.ts +7 -0
- package/dist/models/PutContent.js +3 -0
- package/dist/models/index.d.ts +5 -1
- package/dist/models/index.js +5 -1
- package/docs/ContentApi.md +238 -0
- package/docs/ContentAttemptItem.md +47 -0
- package/docs/ContentAttemptRollupScore.md +37 -0
- package/docs/ContentAttemptScore.md +41 -0
- package/docs/{DownloadSupportTicketAttachment200Response.md → ContentLaunchMode.md} +5 -6
- package/docs/CourseApi.md +72 -0
- package/docs/GetContent.md +2 -0
- package/docs/GetContentAttempts.md +51 -0
- package/docs/GetContentSession.md +4 -0
- package/docs/GetContentSessionDetail.md +4 -0
- package/docs/GetContentSessionListItem.md +8 -0
- package/docs/PortalApi.md +258 -0
- package/docs/PostContentSession.md +6 -0
- package/docs/PutContent.md +2 -0
- package/docs/SupportTicketApi.md +4 -4
- package/package.json +1 -1
- package/src/apis/ContentApi.ts +249 -0
- package/src/apis/CourseApi.ts +58 -0
- package/src/apis/PortalApi.ts +176 -0
- package/src/apis/SupportTicketApi.ts +3 -8
- package/src/models/ContentAttemptItem.ts +128 -0
- package/src/models/ContentAttemptRollupScore.ts +75 -0
- package/src/models/ContentAttemptScore.ts +89 -0
- package/src/models/ContentLaunchMode.ts +54 -0
- package/src/models/GetContent.ts +16 -0
- package/src/models/GetContentAttempts.ts +164 -0
- package/src/models/GetContentSession.ts +18 -0
- package/src/models/GetContentSessionDetail.ts +18 -0
- package/src/models/GetContentSessionListItem.ts +36 -0
- package/src/models/GetPortal.ts +2 -2
- package/src/models/GetPortalFaviconUpload.ts +1 -1
- package/src/models/GetPortalLogoUpload.ts +1 -1
- package/src/models/GetPublicPortalBranding.ts +2 -2
- package/src/models/PostContentSession.ts +37 -0
- package/src/models/PutContent.ts +18 -0
- package/src/models/index.ts +5 -1
- package/dist/esm/models/DownloadSupportTicketAttachment200Response.d.ts +0 -32
- package/dist/esm/models/DownloadSupportTicketAttachment200Response.js +0 -43
- package/dist/models/DownloadSupportTicketAttachment200Response.d.ts +0 -32
- package/dist/models/DownloadSupportTicketAttachment200Response.js +0 -50
- package/src/models/DownloadSupportTicketAttachment200Response.ts +0 -66
|
@@ -51,6 +51,18 @@ export interface GetContentSession {
|
|
|
51
51
|
* @memberof GetContentSession
|
|
52
52
|
*/
|
|
53
53
|
gradeStatus: string;
|
|
54
|
+
/**
|
|
55
|
+
* The learner attempt number for this content session
|
|
56
|
+
* @type {number}
|
|
57
|
+
* @memberof GetContentSession
|
|
58
|
+
*/
|
|
59
|
+
attemptNumber: number;
|
|
60
|
+
/**
|
|
61
|
+
* Whether this is the current attempt used for learner progress display
|
|
62
|
+
* @type {boolean}
|
|
63
|
+
* @memberof GetContentSession
|
|
64
|
+
*/
|
|
65
|
+
isCurrent: boolean;
|
|
54
66
|
}
|
|
55
67
|
/**
|
|
56
68
|
* Check if a given object implements the GetContentSession interface.
|
|
@@ -34,6 +34,10 @@ function instanceOfGetContentSession(value) {
|
|
|
34
34
|
return false;
|
|
35
35
|
if (!('gradeStatus' in value) || value['gradeStatus'] === undefined)
|
|
36
36
|
return false;
|
|
37
|
+
if (!('attemptNumber' in value) || value['attemptNumber'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('isCurrent' in value) || value['isCurrent'] === undefined)
|
|
40
|
+
return false;
|
|
37
41
|
return true;
|
|
38
42
|
}
|
|
39
43
|
function GetContentSessionFromJSON(json) {
|
|
@@ -50,6 +54,8 @@ function GetContentSessionFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
50
54
|
'updatedAt': json['updated_at'],
|
|
51
55
|
'completionStatus': json['completion_status'],
|
|
52
56
|
'gradeStatus': json['grade_status'],
|
|
57
|
+
'attemptNumber': json['attempt_number'],
|
|
58
|
+
'isCurrent': json['is_current'],
|
|
53
59
|
};
|
|
54
60
|
}
|
|
55
61
|
function GetContentSessionToJSON(json) {
|
|
@@ -66,5 +72,7 @@ function GetContentSessionToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
66
72
|
'updated_at': value['updatedAt'],
|
|
67
73
|
'completion_status': value['completionStatus'],
|
|
68
74
|
'grade_status': value['gradeStatus'],
|
|
75
|
+
'attempt_number': value['attemptNumber'],
|
|
76
|
+
'is_current': value['isCurrent'],
|
|
69
77
|
};
|
|
70
78
|
}
|
|
@@ -59,6 +59,18 @@ export interface GetContentSessionDetail {
|
|
|
59
59
|
* @memberof GetContentSessionDetail
|
|
60
60
|
*/
|
|
61
61
|
durationInSeconds: number;
|
|
62
|
+
/**
|
|
63
|
+
* The learner attempt number for this content session
|
|
64
|
+
* @type {number}
|
|
65
|
+
* @memberof GetContentSessionDetail
|
|
66
|
+
*/
|
|
67
|
+
attemptNumber: number;
|
|
68
|
+
/**
|
|
69
|
+
* Whether this is the current attempt used for learner progress display
|
|
70
|
+
* @type {boolean}
|
|
71
|
+
* @memberof GetContentSessionDetail
|
|
72
|
+
*/
|
|
73
|
+
isCurrent: boolean;
|
|
62
74
|
/**
|
|
63
75
|
*
|
|
64
76
|
* @type {GetContentSessionDetailUserData}
|
|
@@ -58,6 +58,10 @@ function instanceOfGetContentSessionDetail(value) {
|
|
|
58
58
|
return false;
|
|
59
59
|
if (!('durationInSeconds' in value) || value['durationInSeconds'] === undefined)
|
|
60
60
|
return false;
|
|
61
|
+
if (!('attemptNumber' in value) || value['attemptNumber'] === undefined)
|
|
62
|
+
return false;
|
|
63
|
+
if (!('isCurrent' in value) || value['isCurrent'] === undefined)
|
|
64
|
+
return false;
|
|
61
65
|
if (!('userData' in value) || value['userData'] === undefined)
|
|
62
66
|
return false;
|
|
63
67
|
if (!('scormSessionData' in value) || value['scormSessionData'] === undefined)
|
|
@@ -79,6 +83,8 @@ function GetContentSessionDetailFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
79
83
|
'completionStatus': json['completion_status'],
|
|
80
84
|
'gradeStatus': json['grade_status'],
|
|
81
85
|
'durationInSeconds': json['duration_in_seconds'],
|
|
86
|
+
'attemptNumber': json['attempt_number'],
|
|
87
|
+
'isCurrent': json['is_current'],
|
|
82
88
|
'userData': (0, GetContentSessionDetailUserData_1.GetContentSessionDetailUserDataFromJSON)(json['user_data']),
|
|
83
89
|
'scormSessionData': (json['scorm_session_data'] == null ? null : json['scorm_session_data'].map(GetContentSessionDetailScormSessionDataInner_1.GetContentSessionDetailScormSessionDataInnerFromJSON)),
|
|
84
90
|
};
|
|
@@ -98,6 +104,8 @@ function GetContentSessionDetailToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
98
104
|
'completion_status': value['completionStatus'],
|
|
99
105
|
'grade_status': value['gradeStatus'],
|
|
100
106
|
'duration_in_seconds': value['durationInSeconds'],
|
|
107
|
+
'attempt_number': value['attemptNumber'],
|
|
108
|
+
'is_current': value['isCurrent'],
|
|
101
109
|
'user_data': (0, GetContentSessionDetailUserData_1.GetContentSessionDetailUserDataToJSON)(value['userData']),
|
|
102
110
|
'scorm_session_data': (value['scormSessionData'] == null ? null : value['scormSessionData'].map(GetContentSessionDetailScormSessionDataInner_1.GetContentSessionDetailScormSessionDataInnerToJSON)),
|
|
103
111
|
};
|
|
@@ -41,6 +41,30 @@ export interface GetContentSessionListItem {
|
|
|
41
41
|
* @memberof GetContentSessionListItem
|
|
42
42
|
*/
|
|
43
43
|
contentId: string;
|
|
44
|
+
/**
|
|
45
|
+
* The completion status of the content session
|
|
46
|
+
* @type {string}
|
|
47
|
+
* @memberof GetContentSessionListItem
|
|
48
|
+
*/
|
|
49
|
+
completionStatus: string;
|
|
50
|
+
/**
|
|
51
|
+
* The grade status of the content session
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof GetContentSessionListItem
|
|
54
|
+
*/
|
|
55
|
+
gradeStatus: string;
|
|
56
|
+
/**
|
|
57
|
+
* The learner attempt number for this content session
|
|
58
|
+
* @type {number}
|
|
59
|
+
* @memberof GetContentSessionListItem
|
|
60
|
+
*/
|
|
61
|
+
attemptNumber: number;
|
|
62
|
+
/**
|
|
63
|
+
* Whether this is the current attempt used for learner progress display
|
|
64
|
+
* @type {boolean}
|
|
65
|
+
* @memberof GetContentSessionListItem
|
|
66
|
+
*/
|
|
67
|
+
isCurrent: boolean;
|
|
44
68
|
/**
|
|
45
69
|
*
|
|
46
70
|
* @type {GetContentSessionDetailUserData}
|
|
@@ -32,6 +32,14 @@ function instanceOfGetContentSessionListItem(value) {
|
|
|
32
32
|
return false;
|
|
33
33
|
if (!('contentId' in value) || value['contentId'] === undefined)
|
|
34
34
|
return false;
|
|
35
|
+
if (!('completionStatus' in value) || value['completionStatus'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('gradeStatus' in value) || value['gradeStatus'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('attemptNumber' in value) || value['attemptNumber'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('isCurrent' in value) || value['isCurrent'] === undefined)
|
|
42
|
+
return false;
|
|
35
43
|
if (!('userData' in value) || value['userData'] === undefined)
|
|
36
44
|
return false;
|
|
37
45
|
if (!('scormSessionData' in value) || value['scormSessionData'] === undefined)
|
|
@@ -50,6 +58,10 @@ function GetContentSessionListItemFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
50
58
|
'createdAt': json['created_at'],
|
|
51
59
|
'updatedAt': json['updated_at'],
|
|
52
60
|
'contentId': json['content_id'],
|
|
61
|
+
'completionStatus': json['completion_status'],
|
|
62
|
+
'gradeStatus': json['grade_status'],
|
|
63
|
+
'attemptNumber': json['attempt_number'],
|
|
64
|
+
'isCurrent': json['is_current'],
|
|
53
65
|
'userData': (0, GetContentSessionDetailUserData_1.GetContentSessionDetailUserDataFromJSON)(json['user_data']),
|
|
54
66
|
'scormSessionData': (0, GetContentSessionListItemScormSessionData_1.GetContentSessionListItemScormSessionDataFromJSON)(json['scorm_session_data']),
|
|
55
67
|
};
|
|
@@ -66,6 +78,10 @@ function GetContentSessionListItemToJSONTyped(value, ignoreDiscriminator = false
|
|
|
66
78
|
'created_at': value['createdAt'],
|
|
67
79
|
'updated_at': value['updatedAt'],
|
|
68
80
|
'content_id': value['contentId'],
|
|
81
|
+
'completion_status': value['completionStatus'],
|
|
82
|
+
'grade_status': value['gradeStatus'],
|
|
83
|
+
'attempt_number': value['attemptNumber'],
|
|
84
|
+
'is_current': value['isCurrent'],
|
|
69
85
|
'user_data': (0, GetContentSessionDetailUserData_1.GetContentSessionDetailUserDataToJSON)(value['userData']),
|
|
70
86
|
'scorm_session_data': (0, GetContentSessionListItemScormSessionData_1.GetContentSessionListItemScormSessionDataToJSON)(value['scormSessionData']),
|
|
71
87
|
};
|
|
@@ -46,13 +46,13 @@ export interface GetPortal {
|
|
|
46
46
|
*/
|
|
47
47
|
clientDomain?: string | null;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* API-proxied portal logo URL when a logo is configured.
|
|
50
50
|
* @type {string}
|
|
51
51
|
* @memberof GetPortal
|
|
52
52
|
*/
|
|
53
53
|
logoUrl?: string | null;
|
|
54
54
|
/**
|
|
55
|
-
*
|
|
55
|
+
* API-proxied portal favicon URL when a favicon is configured.
|
|
56
56
|
* @type {string}
|
|
57
57
|
* @memberof GetPortal
|
|
58
58
|
*/
|
|
@@ -34,13 +34,13 @@ export interface GetPublicPortalBranding {
|
|
|
34
34
|
*/
|
|
35
35
|
slug: string | null;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* API-proxied portal logo URL when a logo is configured.
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof GetPublicPortalBranding
|
|
40
40
|
*/
|
|
41
41
|
logoUrl: string | null;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* API-proxied portal favicon URL when a favicon is configured.
|
|
44
44
|
* @type {string}
|
|
45
45
|
* @memberof GetPublicPortalBranding
|
|
46
46
|
*/
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { ContentLaunchMode } from './ContentLaunchMode';
|
|
12
13
|
/**
|
|
13
14
|
* A content session
|
|
14
15
|
* @export
|
|
@@ -33,6 +34,12 @@ export interface PostContentSession {
|
|
|
33
34
|
* @memberof PostContentSession
|
|
34
35
|
*/
|
|
35
36
|
launchUrl: string;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {ContentLaunchMode}
|
|
40
|
+
* @memberof PostContentSession
|
|
41
|
+
*/
|
|
42
|
+
launchMode: ContentLaunchMode;
|
|
36
43
|
/**
|
|
37
44
|
* The date and time the content session was created
|
|
38
45
|
* @type {number}
|
|
@@ -45,6 +52,18 @@ export interface PostContentSession {
|
|
|
45
52
|
* @memberof PostContentSession
|
|
46
53
|
*/
|
|
47
54
|
playerSessionId?: string | null;
|
|
55
|
+
/**
|
|
56
|
+
* The learner attempt number for this content session
|
|
57
|
+
* @type {number}
|
|
58
|
+
* @memberof PostContentSession
|
|
59
|
+
*/
|
|
60
|
+
attemptNumber: number;
|
|
61
|
+
/**
|
|
62
|
+
* Whether this is the current attempt used for learner progress display
|
|
63
|
+
* @type {boolean}
|
|
64
|
+
* @memberof PostContentSession
|
|
65
|
+
*/
|
|
66
|
+
isCurrent: boolean;
|
|
48
67
|
}
|
|
49
68
|
/**
|
|
50
69
|
* Check if a given object implements the PostContentSession interface.
|
|
@@ -18,6 +18,7 @@ exports.PostContentSessionFromJSON = PostContentSessionFromJSON;
|
|
|
18
18
|
exports.PostContentSessionFromJSONTyped = PostContentSessionFromJSONTyped;
|
|
19
19
|
exports.PostContentSessionToJSON = PostContentSessionToJSON;
|
|
20
20
|
exports.PostContentSessionToJSONTyped = PostContentSessionToJSONTyped;
|
|
21
|
+
const ContentLaunchMode_1 = require("./ContentLaunchMode");
|
|
21
22
|
/**
|
|
22
23
|
* Check if a given object implements the PostContentSession interface.
|
|
23
24
|
*/
|
|
@@ -28,8 +29,14 @@ function instanceOfPostContentSession(value) {
|
|
|
28
29
|
return false;
|
|
29
30
|
if (!('launchUrl' in value) || value['launchUrl'] === undefined)
|
|
30
31
|
return false;
|
|
32
|
+
if (!('launchMode' in value) || value['launchMode'] === undefined)
|
|
33
|
+
return false;
|
|
31
34
|
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
32
35
|
return false;
|
|
36
|
+
if (!('attemptNumber' in value) || value['attemptNumber'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('isCurrent' in value) || value['isCurrent'] === undefined)
|
|
39
|
+
return false;
|
|
33
40
|
return true;
|
|
34
41
|
}
|
|
35
42
|
function PostContentSessionFromJSON(json) {
|
|
@@ -43,8 +50,11 @@ function PostContentSessionFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
43
50
|
'contentId': json['content_id'],
|
|
44
51
|
'userId': json['user_id'],
|
|
45
52
|
'launchUrl': json['launch_url'],
|
|
53
|
+
'launchMode': (0, ContentLaunchMode_1.ContentLaunchModeFromJSON)(json['launch_mode']),
|
|
46
54
|
'createdAt': json['created_at'],
|
|
47
55
|
'playerSessionId': json['player_session_id'] == null ? undefined : json['player_session_id'],
|
|
56
|
+
'attemptNumber': json['attempt_number'],
|
|
57
|
+
'isCurrent': json['is_current'],
|
|
48
58
|
};
|
|
49
59
|
}
|
|
50
60
|
function PostContentSessionToJSON(json) {
|
|
@@ -58,7 +68,10 @@ function PostContentSessionToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
58
68
|
'content_id': value['contentId'],
|
|
59
69
|
'user_id': value['userId'],
|
|
60
70
|
'launch_url': value['launchUrl'],
|
|
71
|
+
'launch_mode': (0, ContentLaunchMode_1.ContentLaunchModeToJSON)(value['launchMode']),
|
|
61
72
|
'created_at': value['createdAt'],
|
|
62
73
|
'player_session_id': value['playerSessionId'],
|
|
74
|
+
'attempt_number': value['attemptNumber'],
|
|
75
|
+
'is_current': value['isCurrent'],
|
|
63
76
|
};
|
|
64
77
|
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { ContentLaunchMode } from './ContentLaunchMode';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -27,6 +28,12 @@ export interface PutContent {
|
|
|
27
28
|
* @memberof PutContent
|
|
28
29
|
*/
|
|
29
30
|
published?: boolean;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {ContentLaunchMode}
|
|
34
|
+
* @memberof PutContent
|
|
35
|
+
*/
|
|
36
|
+
launchMode?: ContentLaunchMode;
|
|
30
37
|
}
|
|
31
38
|
/**
|
|
32
39
|
* Check if a given object implements the PutContent interface.
|
|
@@ -18,6 +18,7 @@ exports.PutContentFromJSON = PutContentFromJSON;
|
|
|
18
18
|
exports.PutContentFromJSONTyped = PutContentFromJSONTyped;
|
|
19
19
|
exports.PutContentToJSON = PutContentToJSON;
|
|
20
20
|
exports.PutContentToJSONTyped = PutContentToJSONTyped;
|
|
21
|
+
const ContentLaunchMode_1 = require("./ContentLaunchMode");
|
|
21
22
|
/**
|
|
22
23
|
* Check if a given object implements the PutContent interface.
|
|
23
24
|
*/
|
|
@@ -34,6 +35,7 @@ function PutContentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
34
35
|
return {
|
|
35
36
|
'name': json['name'] == null ? undefined : json['name'],
|
|
36
37
|
'published': json['published'] == null ? undefined : json['published'],
|
|
38
|
+
'launchMode': json['launch_mode'] == null ? undefined : (0, ContentLaunchMode_1.ContentLaunchModeFromJSON)(json['launch_mode']),
|
|
37
39
|
};
|
|
38
40
|
}
|
|
39
41
|
function PutContentToJSON(json) {
|
|
@@ -46,5 +48,6 @@ function PutContentToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
46
48
|
return {
|
|
47
49
|
'name': value['name'],
|
|
48
50
|
'published': value['published'],
|
|
51
|
+
'launch_mode': (0, ContentLaunchMode_1.ContentLaunchModeToJSON)(value['launchMode']),
|
|
49
52
|
};
|
|
50
53
|
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
export * from './Certificate';
|
|
2
2
|
export * from './CertificateConfig';
|
|
3
3
|
export * from './CertificatePublic';
|
|
4
|
+
export * from './ContentAttemptItem';
|
|
5
|
+
export * from './ContentAttemptRollupScore';
|
|
6
|
+
export * from './ContentAttemptScore';
|
|
7
|
+
export * from './ContentLaunchMode';
|
|
4
8
|
export * from './CourseCatalog';
|
|
5
9
|
export * from './CourseShare';
|
|
6
10
|
export * from './CriteriaBasedSelection';
|
|
7
11
|
export * from './CriteriaBasedSelectionCriteria';
|
|
8
12
|
export * from './CriteriaBasedSelectionDistribution';
|
|
9
|
-
export * from './DownloadSupportTicketAttachment200Response';
|
|
10
13
|
export * from './EffectiveCertificateConfig';
|
|
11
14
|
export * from './Essay';
|
|
12
15
|
export * from './Essay1';
|
|
@@ -16,6 +19,7 @@ export * from './GetCertificateConfigList';
|
|
|
16
19
|
export * from './GetCertificateList';
|
|
17
20
|
export * from './GetChatMessage';
|
|
18
21
|
export * from './GetContent';
|
|
22
|
+
export * from './GetContentAttempts';
|
|
19
23
|
export * from './GetContentContentData';
|
|
20
24
|
export * from './GetContentGradeDetail';
|
|
21
25
|
export * from './GetContentGrades';
|
package/dist/models/index.js
CHANGED
|
@@ -19,12 +19,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
19
19
|
__exportStar(require("./Certificate"), exports);
|
|
20
20
|
__exportStar(require("./CertificateConfig"), exports);
|
|
21
21
|
__exportStar(require("./CertificatePublic"), exports);
|
|
22
|
+
__exportStar(require("./ContentAttemptItem"), exports);
|
|
23
|
+
__exportStar(require("./ContentAttemptRollupScore"), exports);
|
|
24
|
+
__exportStar(require("./ContentAttemptScore"), exports);
|
|
25
|
+
__exportStar(require("./ContentLaunchMode"), exports);
|
|
22
26
|
__exportStar(require("./CourseCatalog"), exports);
|
|
23
27
|
__exportStar(require("./CourseShare"), exports);
|
|
24
28
|
__exportStar(require("./CriteriaBasedSelection"), exports);
|
|
25
29
|
__exportStar(require("./CriteriaBasedSelectionCriteria"), exports);
|
|
26
30
|
__exportStar(require("./CriteriaBasedSelectionDistribution"), exports);
|
|
27
|
-
__exportStar(require("./DownloadSupportTicketAttachment200Response"), exports);
|
|
28
31
|
__exportStar(require("./EffectiveCertificateConfig"), exports);
|
|
29
32
|
__exportStar(require("./Essay"), exports);
|
|
30
33
|
__exportStar(require("./Essay1"), exports);
|
|
@@ -34,6 +37,7 @@ __exportStar(require("./GetCertificateConfigList"), exports);
|
|
|
34
37
|
__exportStar(require("./GetCertificateList"), exports);
|
|
35
38
|
__exportStar(require("./GetChatMessage"), exports);
|
|
36
39
|
__exportStar(require("./GetContent"), exports);
|
|
40
|
+
__exportStar(require("./GetContentAttempts"), exports);
|
|
37
41
|
__exportStar(require("./GetContentContentData"), exports);
|
|
38
42
|
__exportStar(require("./GetContentGradeDetail"), exports);
|
|
39
43
|
__exportStar(require("./GetContentGrades"), exports);
|
package/docs/ContentApi.md
CHANGED
|
@@ -8,6 +8,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
8
8
|
| [**deleteContent**](ContentApi.md#deletecontent) | **DELETE** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Delete content by id |
|
|
9
9
|
| [**deleteContentVersion**](ContentApi.md#deletecontentversion) | **DELETE** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Delete an inactive content version |
|
|
10
10
|
| [**getContent**](ContentApi.md#getcontent) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | get content |
|
|
11
|
+
| [**getContentAttempts**](ContentApi.md#getcontentattempts) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/attempts | Get content attempts |
|
|
11
12
|
| [**getContentList**](ContentApi.md#getcontentlist) | **GET** /courses/{courseId}/modules/{moduleId}/contents | get content list |
|
|
12
13
|
| [**getContentSession**](ContentApi.md#getcontentsession) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | get content session |
|
|
13
14
|
| [**getContentSessionDetail**](ContentApi.md#getcontentsessiondetail) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions/{sessionId} | Get content session details (instructor only) |
|
|
@@ -23,9 +24,11 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
23
24
|
| [**postContentProcess**](ContentApi.md#postcontentprocess) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/process | Post a new content process |
|
|
24
25
|
| [**postContentQuiz**](ContentApi.md#postcontentquiz) | **POST** /courses/{courseId}/modules/{moduleId}/contents/quiz | Create a new quiz content |
|
|
25
26
|
| [**postContentSession**](ContentApi.md#postcontentsession) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | Post a new content session |
|
|
27
|
+
| [**postContentSessionRetake**](ContentApi.md#postcontentsessionretake) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session/retake | Create a new retake content session |
|
|
26
28
|
| [**postContentUpload**](ContentApi.md#postcontentupload) | **POST** /courses/{courseId}/modules/{moduleId}/contents/upload | Post a new content upload |
|
|
27
29
|
| [**putContent**](ContentApi.md#putcontent) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Update content by id |
|
|
28
30
|
| [**putContentReorder**](ContentApi.md#putcontentreorder) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/reorder | Reorder content in a module |
|
|
31
|
+
| [**putContentUploadFile**](ContentApi.md#putcontentuploadfile) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/uploads/{uploadId}/file | Upload content file through the API |
|
|
29
32
|
| [**putContentVersion**](ContentApi.md#putcontentversion) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Update a content version |
|
|
30
33
|
| [**setScormValue**](ContentApi.md#setscormvalue) | **POST** /scorm/sessions/{scormSessionId}/set-value | Set a SCORM CMI data element value |
|
|
31
34
|
| [**terminateScormSession**](ContentApi.md#terminatescormsession) | **POST** /scorm/sessions/{scormSessionId}/terminate | Terminate a SCORM session |
|
|
@@ -326,6 +329,88 @@ No authorization required
|
|
|
326
329
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
327
330
|
|
|
328
331
|
|
|
332
|
+
## getContentAttempts
|
|
333
|
+
|
|
334
|
+
> GetContentAttempts getContentAttempts(contentId, moduleId, courseId, userId, environment)
|
|
335
|
+
|
|
336
|
+
Get content attempts
|
|
337
|
+
|
|
338
|
+
Lists content attempts and score rollup for the current learner. Instructors may pass user_id to inspect another learner.
|
|
339
|
+
|
|
340
|
+
### Example
|
|
341
|
+
|
|
342
|
+
```ts
|
|
343
|
+
import {
|
|
344
|
+
Configuration,
|
|
345
|
+
ContentApi,
|
|
346
|
+
} from '@easyedu/js-lsm-api';
|
|
347
|
+
import type { GetContentAttemptsRequest } from '@easyedu/js-lsm-api';
|
|
348
|
+
|
|
349
|
+
async function example() {
|
|
350
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
351
|
+
const api = new ContentApi();
|
|
352
|
+
|
|
353
|
+
const body = {
|
|
354
|
+
// string
|
|
355
|
+
contentId: contentId_example,
|
|
356
|
+
// string
|
|
357
|
+
moduleId: moduleId_example,
|
|
358
|
+
// string
|
|
359
|
+
courseId: courseId_example,
|
|
360
|
+
// number | Internal user ID to inspect. Defaults to the authenticated user. (optional)
|
|
361
|
+
userId: 56,
|
|
362
|
+
// 'sandbox' | 'live' | Environment type for the attempts list (defaults to live) (optional)
|
|
363
|
+
environment: environment_example,
|
|
364
|
+
} satisfies GetContentAttemptsRequest;
|
|
365
|
+
|
|
366
|
+
try {
|
|
367
|
+
const data = await api.getContentAttempts(body);
|
|
368
|
+
console.log(data);
|
|
369
|
+
} catch (error) {
|
|
370
|
+
console.error(error);
|
|
371
|
+
}
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
// Run the test
|
|
375
|
+
example().catch(console.error);
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
### Parameters
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
| Name | Type | Description | Notes |
|
|
382
|
+
|------------- | ------------- | ------------- | -------------|
|
|
383
|
+
| **contentId** | `string` | | [Defaults to `undefined`] |
|
|
384
|
+
| **moduleId** | `string` | | [Defaults to `undefined`] |
|
|
385
|
+
| **courseId** | `string` | | [Defaults to `undefined`] |
|
|
386
|
+
| **userId** | `number` | Internal user ID to inspect. Defaults to the authenticated user. | [Optional] [Defaults to `undefined`] |
|
|
387
|
+
| **environment** | `sandbox`, `live` | Environment type for the attempts list (defaults to live) | [Optional] [Defaults to `'live'`] [Enum: sandbox, live] |
|
|
388
|
+
|
|
389
|
+
### Return type
|
|
390
|
+
|
|
391
|
+
[**GetContentAttempts**](GetContentAttempts.md)
|
|
392
|
+
|
|
393
|
+
### Authorization
|
|
394
|
+
|
|
395
|
+
No authorization required
|
|
396
|
+
|
|
397
|
+
### HTTP request headers
|
|
398
|
+
|
|
399
|
+
- **Content-Type**: Not defined
|
|
400
|
+
- **Accept**: `application/json`
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
### HTTP response details
|
|
404
|
+
| Status code | Description | Response headers |
|
|
405
|
+
|-------------|-------------|------------------|
|
|
406
|
+
| **200** | Content attempts response OK | - |
|
|
407
|
+
| **401** | Unauthorized | - |
|
|
408
|
+
| **403** | Forbidden | - |
|
|
409
|
+
| **404** | Content not found | - |
|
|
410
|
+
|
|
411
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
412
|
+
|
|
413
|
+
|
|
329
414
|
## getContentList
|
|
330
415
|
|
|
331
416
|
> GetContentList getContentList(moduleId, courseId)
|
|
@@ -1441,6 +1526,81 @@ No authorization required
|
|
|
1441
1526
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1442
1527
|
|
|
1443
1528
|
|
|
1529
|
+
## postContentSessionRetake
|
|
1530
|
+
|
|
1531
|
+
> PostContentSession postContentSessionRetake(contentId, moduleId, courseId, environment)
|
|
1532
|
+
|
|
1533
|
+
Create a new retake content session
|
|
1534
|
+
|
|
1535
|
+
### Example
|
|
1536
|
+
|
|
1537
|
+
```ts
|
|
1538
|
+
import {
|
|
1539
|
+
Configuration,
|
|
1540
|
+
ContentApi,
|
|
1541
|
+
} from '@easyedu/js-lsm-api';
|
|
1542
|
+
import type { PostContentSessionRetakeRequest } from '@easyedu/js-lsm-api';
|
|
1543
|
+
|
|
1544
|
+
async function example() {
|
|
1545
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1546
|
+
const api = new ContentApi();
|
|
1547
|
+
|
|
1548
|
+
const body = {
|
|
1549
|
+
// string
|
|
1550
|
+
contentId: contentId_example,
|
|
1551
|
+
// string
|
|
1552
|
+
moduleId: moduleId_example,
|
|
1553
|
+
// string
|
|
1554
|
+
courseId: courseId_example,
|
|
1555
|
+
// 'sandbox' | 'live' | Environment type for the session (defaults to live) (optional)
|
|
1556
|
+
environment: environment_example,
|
|
1557
|
+
} satisfies PostContentSessionRetakeRequest;
|
|
1558
|
+
|
|
1559
|
+
try {
|
|
1560
|
+
const data = await api.postContentSessionRetake(body);
|
|
1561
|
+
console.log(data);
|
|
1562
|
+
} catch (error) {
|
|
1563
|
+
console.error(error);
|
|
1564
|
+
}
|
|
1565
|
+
}
|
|
1566
|
+
|
|
1567
|
+
// Run the test
|
|
1568
|
+
example().catch(console.error);
|
|
1569
|
+
```
|
|
1570
|
+
|
|
1571
|
+
### Parameters
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
| Name | Type | Description | Notes |
|
|
1575
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1576
|
+
| **contentId** | `string` | | [Defaults to `undefined`] |
|
|
1577
|
+
| **moduleId** | `string` | | [Defaults to `undefined`] |
|
|
1578
|
+
| **courseId** | `string` | | [Defaults to `undefined`] |
|
|
1579
|
+
| **environment** | `sandbox`, `live` | Environment type for the session (defaults to live) | [Optional] [Defaults to `'live'`] [Enum: sandbox, live] |
|
|
1580
|
+
|
|
1581
|
+
### Return type
|
|
1582
|
+
|
|
1583
|
+
[**PostContentSession**](PostContentSession.md)
|
|
1584
|
+
|
|
1585
|
+
### Authorization
|
|
1586
|
+
|
|
1587
|
+
No authorization required
|
|
1588
|
+
|
|
1589
|
+
### HTTP request headers
|
|
1590
|
+
|
|
1591
|
+
- **Content-Type**: Not defined
|
|
1592
|
+
- **Accept**: `application/json`
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
### HTTP response details
|
|
1596
|
+
| Status code | Description | Response headers |
|
|
1597
|
+
|-------------|-------------|------------------|
|
|
1598
|
+
| **200** | post retake session response OK | - |
|
|
1599
|
+
| **409** | Maximum attempts reached for this content | - |
|
|
1600
|
+
|
|
1601
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1602
|
+
|
|
1603
|
+
|
|
1444
1604
|
## postContentUpload
|
|
1445
1605
|
|
|
1446
1606
|
> GetContentUpload postContentUpload(moduleId, courseId, postContentUpload)
|
|
@@ -1657,6 +1817,84 @@ No authorization required
|
|
|
1657
1817
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1658
1818
|
|
|
1659
1819
|
|
|
1820
|
+
## putContentUploadFile
|
|
1821
|
+
|
|
1822
|
+
> putContentUploadFile(courseId, moduleId, uploadId, body)
|
|
1823
|
+
|
|
1824
|
+
Upload content file through the API
|
|
1825
|
+
|
|
1826
|
+
### Example
|
|
1827
|
+
|
|
1828
|
+
```ts
|
|
1829
|
+
import {
|
|
1830
|
+
Configuration,
|
|
1831
|
+
ContentApi,
|
|
1832
|
+
} from '@easyedu/js-lsm-api';
|
|
1833
|
+
import type { PutContentUploadFileRequest } from '@easyedu/js-lsm-api';
|
|
1834
|
+
|
|
1835
|
+
async function example() {
|
|
1836
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1837
|
+
const api = new ContentApi();
|
|
1838
|
+
|
|
1839
|
+
const body = {
|
|
1840
|
+
// string
|
|
1841
|
+
courseId: courseId_example,
|
|
1842
|
+
// string
|
|
1843
|
+
moduleId: moduleId_example,
|
|
1844
|
+
// number
|
|
1845
|
+
uploadId: 56,
|
|
1846
|
+
// Blob
|
|
1847
|
+
body: BINARY_DATA_HERE,
|
|
1848
|
+
} satisfies PutContentUploadFileRequest;
|
|
1849
|
+
|
|
1850
|
+
try {
|
|
1851
|
+
const data = await api.putContentUploadFile(body);
|
|
1852
|
+
console.log(data);
|
|
1853
|
+
} catch (error) {
|
|
1854
|
+
console.error(error);
|
|
1855
|
+
}
|
|
1856
|
+
}
|
|
1857
|
+
|
|
1858
|
+
// Run the test
|
|
1859
|
+
example().catch(console.error);
|
|
1860
|
+
```
|
|
1861
|
+
|
|
1862
|
+
### Parameters
|
|
1863
|
+
|
|
1864
|
+
|
|
1865
|
+
| Name | Type | Description | Notes |
|
|
1866
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1867
|
+
| **courseId** | `string` | | [Defaults to `undefined`] |
|
|
1868
|
+
| **moduleId** | `string` | | [Defaults to `undefined`] |
|
|
1869
|
+
| **uploadId** | `number` | | [Defaults to `undefined`] |
|
|
1870
|
+
| **body** | `Blob` | | |
|
|
1871
|
+
|
|
1872
|
+
### Return type
|
|
1873
|
+
|
|
1874
|
+
`void` (Empty response body)
|
|
1875
|
+
|
|
1876
|
+
### Authorization
|
|
1877
|
+
|
|
1878
|
+
No authorization required
|
|
1879
|
+
|
|
1880
|
+
### HTTP request headers
|
|
1881
|
+
|
|
1882
|
+
- **Content-Type**: `application/octet-stream`
|
|
1883
|
+
- **Accept**: Not defined
|
|
1884
|
+
|
|
1885
|
+
|
|
1886
|
+
### HTTP response details
|
|
1887
|
+
| Status code | Description | Response headers |
|
|
1888
|
+
|-------------|-------------|------------------|
|
|
1889
|
+
| **204** | File uploaded successfully | - |
|
|
1890
|
+
| **401** | Unauthorized | - |
|
|
1891
|
+
| **403** | Forbidden | - |
|
|
1892
|
+
| **404** | Course, module, or content upload not found | - |
|
|
1893
|
+
| **413** | File too large | - |
|
|
1894
|
+
|
|
1895
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1896
|
+
|
|
1897
|
+
|
|
1660
1898
|
## putContentVersion
|
|
1661
1899
|
|
|
1662
1900
|
> GetContentVersion putContentVersion(contentId, moduleId, courseId, versionId, putContentVersion)
|