@easyedu/js-lsm-api 1.36.0 → 1.37.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/GetCourseExport.d.ts +19 -7
- package/dist/esm/models/GetCourseExport.js +12 -4
- package/dist/esm/models/PostCourseExport.d.ts +12 -6
- package/dist/esm/models/PostCourseExport.js +8 -4
- package/dist/models/GetCourseExport.d.ts +19 -7
- package/dist/models/GetCourseExport.js +13 -5
- package/dist/models/PostCourseExport.d.ts +12 -6
- package/dist/models/PostCourseExport.js +9 -5
- package/docs/GetCourseExport.md +7 -3
- package/docs/PostCourseExport.md +5 -3
- package/package.json +1 -1
- package/src/models/GetCourseExport.ts +28 -10
- package/src/models/PostCourseExport.ts +18 -9
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.37.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -380,7 +380,7 @@ and is automatically generated by the
|
|
|
380
380
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
381
381
|
|
|
382
382
|
- API version: `1.0.0`
|
|
383
|
-
- Package version: `1.
|
|
383
|
+
- Package version: `1.37.0`
|
|
384
384
|
- Generator version: `7.21.0`
|
|
385
385
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
386
386
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* Details of a course
|
|
13
|
+
* Details of a course export
|
|
14
14
|
* @export
|
|
15
15
|
* @interface GetCourseExport
|
|
16
16
|
*/
|
|
@@ -28,11 +28,23 @@ export interface GetCourseExport {
|
|
|
28
28
|
*/
|
|
29
29
|
courseId: string;
|
|
30
30
|
/**
|
|
31
|
-
* The
|
|
32
|
-
* @type {
|
|
31
|
+
* The export format type
|
|
32
|
+
* @type {GetCourseExportExportTypeEnum}
|
|
33
33
|
* @memberof GetCourseExport
|
|
34
34
|
*/
|
|
35
|
-
|
|
35
|
+
exportType: GetCourseExportExportTypeEnum;
|
|
36
|
+
/**
|
|
37
|
+
* IDs of the modules included in the export
|
|
38
|
+
* @type {Array<string>}
|
|
39
|
+
* @memberof GetCourseExport
|
|
40
|
+
*/
|
|
41
|
+
moduleIds: Array<string>;
|
|
42
|
+
/**
|
|
43
|
+
* ID of the user who requested the export
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof GetCourseExport
|
|
46
|
+
*/
|
|
47
|
+
createdBy: number;
|
|
36
48
|
/**
|
|
37
49
|
* Current status of the export generation
|
|
38
50
|
* @type {GetCourseExportStatusEnum}
|
|
@@ -40,7 +52,7 @@ export interface GetCourseExport {
|
|
|
40
52
|
*/
|
|
41
53
|
status: GetCourseExportStatusEnum;
|
|
42
54
|
/**
|
|
43
|
-
* URL to download the export
|
|
55
|
+
* URL to download the export file (null if not yet completed)
|
|
44
56
|
* @type {string}
|
|
45
57
|
* @memberof GetCourseExport
|
|
46
58
|
*/
|
|
@@ -67,12 +79,12 @@ export interface GetCourseExport {
|
|
|
67
79
|
/**
|
|
68
80
|
* @export
|
|
69
81
|
*/
|
|
70
|
-
export declare const
|
|
82
|
+
export declare const GetCourseExportExportTypeEnum: {
|
|
71
83
|
readonly Scorm12: "SCORM_1_2";
|
|
72
84
|
readonly Scorm20043RdEdition: "SCORM_2004_3RD_EDITION";
|
|
73
85
|
readonly Scorm20044ThEdition: "SCORM_2004_4TH_EDITION";
|
|
74
86
|
};
|
|
75
|
-
export type
|
|
87
|
+
export type GetCourseExportExportTypeEnum = typeof GetCourseExportExportTypeEnum[keyof typeof GetCourseExportExportTypeEnum];
|
|
76
88
|
/**
|
|
77
89
|
* @export
|
|
78
90
|
*/
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
/**
|
|
15
15
|
* @export
|
|
16
16
|
*/
|
|
17
|
-
export const
|
|
17
|
+
export const GetCourseExportExportTypeEnum = {
|
|
18
18
|
Scorm12: 'SCORM_1_2',
|
|
19
19
|
Scorm20043RdEdition: 'SCORM_2004_3RD_EDITION',
|
|
20
20
|
Scorm20044ThEdition: 'SCORM_2004_4TH_EDITION'
|
|
@@ -36,7 +36,11 @@ export function instanceOfGetCourseExport(value) {
|
|
|
36
36
|
return false;
|
|
37
37
|
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
38
38
|
return false;
|
|
39
|
-
if (!('
|
|
39
|
+
if (!('exportType' in value) || value['exportType'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('moduleIds' in value) || value['moduleIds'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('createdBy' in value) || value['createdBy'] === undefined)
|
|
40
44
|
return false;
|
|
41
45
|
if (!('status' in value) || value['status'] === undefined)
|
|
42
46
|
return false;
|
|
@@ -54,7 +58,9 @@ export function GetCourseExportFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
54
58
|
return {
|
|
55
59
|
'id': json['id'],
|
|
56
60
|
'courseId': json['course_id'],
|
|
57
|
-
'
|
|
61
|
+
'exportType': json['export_type'],
|
|
62
|
+
'moduleIds': json['module_ids'],
|
|
63
|
+
'createdBy': json['created_by'],
|
|
58
64
|
'status': json['status'],
|
|
59
65
|
'downloadUrl': json['download_url'] == null ? undefined : json['download_url'],
|
|
60
66
|
'fileSize': json['file_size'] == null ? undefined : json['file_size'],
|
|
@@ -72,7 +78,9 @@ export function GetCourseExportToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
72
78
|
return {
|
|
73
79
|
'id': value['id'],
|
|
74
80
|
'course_id': value['courseId'],
|
|
75
|
-
'
|
|
81
|
+
'export_type': value['exportType'],
|
|
82
|
+
'module_ids': value['moduleIds'],
|
|
83
|
+
'created_by': value['createdBy'],
|
|
76
84
|
'status': value['status'],
|
|
77
85
|
'download_url': value['downloadUrl'],
|
|
78
86
|
'file_size': value['fileSize'],
|
|
@@ -10,27 +10,33 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* Request to create a new
|
|
13
|
+
* Request to create a new export for a course
|
|
14
14
|
* @export
|
|
15
15
|
* @interface PostCourseExport
|
|
16
16
|
*/
|
|
17
17
|
export interface PostCourseExport {
|
|
18
18
|
/**
|
|
19
|
-
* The
|
|
20
|
-
* @type {
|
|
19
|
+
* The export format type
|
|
20
|
+
* @type {PostCourseExportExportTypeEnum}
|
|
21
21
|
* @memberof PostCourseExport
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
exportType: PostCourseExportExportTypeEnum;
|
|
24
|
+
/**
|
|
25
|
+
* IDs of the modules to include in the export
|
|
26
|
+
* @type {Array<string>}
|
|
27
|
+
* @memberof PostCourseExport
|
|
28
|
+
*/
|
|
29
|
+
moduleIds: Array<string>;
|
|
24
30
|
}
|
|
25
31
|
/**
|
|
26
32
|
* @export
|
|
27
33
|
*/
|
|
28
|
-
export declare const
|
|
34
|
+
export declare const PostCourseExportExportTypeEnum: {
|
|
29
35
|
readonly Scorm12: "SCORM_1_2";
|
|
30
36
|
readonly Scorm20043RdEdition: "SCORM_2004_3RD_EDITION";
|
|
31
37
|
readonly Scorm20044ThEdition: "SCORM_2004_4TH_EDITION";
|
|
32
38
|
};
|
|
33
|
-
export type
|
|
39
|
+
export type PostCourseExportExportTypeEnum = typeof PostCourseExportExportTypeEnum[keyof typeof PostCourseExportExportTypeEnum];
|
|
34
40
|
/**
|
|
35
41
|
* Check if a given object implements the PostCourseExport interface.
|
|
36
42
|
*/
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
/**
|
|
15
15
|
* @export
|
|
16
16
|
*/
|
|
17
|
-
export const
|
|
17
|
+
export const PostCourseExportExportTypeEnum = {
|
|
18
18
|
Scorm12: 'SCORM_1_2',
|
|
19
19
|
Scorm20043RdEdition: 'SCORM_2004_3RD_EDITION',
|
|
20
20
|
Scorm20044ThEdition: 'SCORM_2004_4TH_EDITION'
|
|
@@ -23,7 +23,9 @@ export const PostCourseExportScormVersionEnum = {
|
|
|
23
23
|
* Check if a given object implements the PostCourseExport interface.
|
|
24
24
|
*/
|
|
25
25
|
export function instanceOfPostCourseExport(value) {
|
|
26
|
-
if (!('
|
|
26
|
+
if (!('exportType' in value) || value['exportType'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('moduleIds' in value) || value['moduleIds'] === undefined)
|
|
27
29
|
return false;
|
|
28
30
|
return true;
|
|
29
31
|
}
|
|
@@ -35,7 +37,8 @@ export function PostCourseExportFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
35
37
|
return json;
|
|
36
38
|
}
|
|
37
39
|
return {
|
|
38
|
-
'
|
|
40
|
+
'exportType': json['export_type'],
|
|
41
|
+
'moduleIds': json['module_ids'],
|
|
39
42
|
};
|
|
40
43
|
}
|
|
41
44
|
export function PostCourseExportToJSON(json) {
|
|
@@ -46,6 +49,7 @@ export function PostCourseExportToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
46
49
|
return value;
|
|
47
50
|
}
|
|
48
51
|
return {
|
|
49
|
-
'
|
|
52
|
+
'export_type': value['exportType'],
|
|
53
|
+
'module_ids': value['moduleIds'],
|
|
50
54
|
};
|
|
51
55
|
}
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* Details of a course
|
|
13
|
+
* Details of a course export
|
|
14
14
|
* @export
|
|
15
15
|
* @interface GetCourseExport
|
|
16
16
|
*/
|
|
@@ -28,11 +28,23 @@ export interface GetCourseExport {
|
|
|
28
28
|
*/
|
|
29
29
|
courseId: string;
|
|
30
30
|
/**
|
|
31
|
-
* The
|
|
32
|
-
* @type {
|
|
31
|
+
* The export format type
|
|
32
|
+
* @type {GetCourseExportExportTypeEnum}
|
|
33
33
|
* @memberof GetCourseExport
|
|
34
34
|
*/
|
|
35
|
-
|
|
35
|
+
exportType: GetCourseExportExportTypeEnum;
|
|
36
|
+
/**
|
|
37
|
+
* IDs of the modules included in the export
|
|
38
|
+
* @type {Array<string>}
|
|
39
|
+
* @memberof GetCourseExport
|
|
40
|
+
*/
|
|
41
|
+
moduleIds: Array<string>;
|
|
42
|
+
/**
|
|
43
|
+
* ID of the user who requested the export
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof GetCourseExport
|
|
46
|
+
*/
|
|
47
|
+
createdBy: number;
|
|
36
48
|
/**
|
|
37
49
|
* Current status of the export generation
|
|
38
50
|
* @type {GetCourseExportStatusEnum}
|
|
@@ -40,7 +52,7 @@ export interface GetCourseExport {
|
|
|
40
52
|
*/
|
|
41
53
|
status: GetCourseExportStatusEnum;
|
|
42
54
|
/**
|
|
43
|
-
* URL to download the export
|
|
55
|
+
* URL to download the export file (null if not yet completed)
|
|
44
56
|
* @type {string}
|
|
45
57
|
* @memberof GetCourseExport
|
|
46
58
|
*/
|
|
@@ -67,12 +79,12 @@ export interface GetCourseExport {
|
|
|
67
79
|
/**
|
|
68
80
|
* @export
|
|
69
81
|
*/
|
|
70
|
-
export declare const
|
|
82
|
+
export declare const GetCourseExportExportTypeEnum: {
|
|
71
83
|
readonly Scorm12: "SCORM_1_2";
|
|
72
84
|
readonly Scorm20043RdEdition: "SCORM_2004_3RD_EDITION";
|
|
73
85
|
readonly Scorm20044ThEdition: "SCORM_2004_4TH_EDITION";
|
|
74
86
|
};
|
|
75
|
-
export type
|
|
87
|
+
export type GetCourseExportExportTypeEnum = typeof GetCourseExportExportTypeEnum[keyof typeof GetCourseExportExportTypeEnum];
|
|
76
88
|
/**
|
|
77
89
|
* @export
|
|
78
90
|
*/
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.GetCourseExportStatusEnum = exports.
|
|
16
|
+
exports.GetCourseExportStatusEnum = exports.GetCourseExportExportTypeEnum = void 0;
|
|
17
17
|
exports.instanceOfGetCourseExport = instanceOfGetCourseExport;
|
|
18
18
|
exports.GetCourseExportFromJSON = GetCourseExportFromJSON;
|
|
19
19
|
exports.GetCourseExportFromJSONTyped = GetCourseExportFromJSONTyped;
|
|
@@ -22,7 +22,7 @@ exports.GetCourseExportToJSONTyped = GetCourseExportToJSONTyped;
|
|
|
22
22
|
/**
|
|
23
23
|
* @export
|
|
24
24
|
*/
|
|
25
|
-
exports.
|
|
25
|
+
exports.GetCourseExportExportTypeEnum = {
|
|
26
26
|
Scorm12: 'SCORM_1_2',
|
|
27
27
|
Scorm20043RdEdition: 'SCORM_2004_3RD_EDITION',
|
|
28
28
|
Scorm20044ThEdition: 'SCORM_2004_4TH_EDITION'
|
|
@@ -44,7 +44,11 @@ function instanceOfGetCourseExport(value) {
|
|
|
44
44
|
return false;
|
|
45
45
|
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
46
46
|
return false;
|
|
47
|
-
if (!('
|
|
47
|
+
if (!('exportType' in value) || value['exportType'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
if (!('moduleIds' in value) || value['moduleIds'] === undefined)
|
|
50
|
+
return false;
|
|
51
|
+
if (!('createdBy' in value) || value['createdBy'] === undefined)
|
|
48
52
|
return false;
|
|
49
53
|
if (!('status' in value) || value['status'] === undefined)
|
|
50
54
|
return false;
|
|
@@ -62,7 +66,9 @@ function GetCourseExportFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
62
66
|
return {
|
|
63
67
|
'id': json['id'],
|
|
64
68
|
'courseId': json['course_id'],
|
|
65
|
-
'
|
|
69
|
+
'exportType': json['export_type'],
|
|
70
|
+
'moduleIds': json['module_ids'],
|
|
71
|
+
'createdBy': json['created_by'],
|
|
66
72
|
'status': json['status'],
|
|
67
73
|
'downloadUrl': json['download_url'] == null ? undefined : json['download_url'],
|
|
68
74
|
'fileSize': json['file_size'] == null ? undefined : json['file_size'],
|
|
@@ -80,7 +86,9 @@ function GetCourseExportToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
80
86
|
return {
|
|
81
87
|
'id': value['id'],
|
|
82
88
|
'course_id': value['courseId'],
|
|
83
|
-
'
|
|
89
|
+
'export_type': value['exportType'],
|
|
90
|
+
'module_ids': value['moduleIds'],
|
|
91
|
+
'created_by': value['createdBy'],
|
|
84
92
|
'status': value['status'],
|
|
85
93
|
'download_url': value['downloadUrl'],
|
|
86
94
|
'file_size': value['fileSize'],
|
|
@@ -10,27 +10,33 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* Request to create a new
|
|
13
|
+
* Request to create a new export for a course
|
|
14
14
|
* @export
|
|
15
15
|
* @interface PostCourseExport
|
|
16
16
|
*/
|
|
17
17
|
export interface PostCourseExport {
|
|
18
18
|
/**
|
|
19
|
-
* The
|
|
20
|
-
* @type {
|
|
19
|
+
* The export format type
|
|
20
|
+
* @type {PostCourseExportExportTypeEnum}
|
|
21
21
|
* @memberof PostCourseExport
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
exportType: PostCourseExportExportTypeEnum;
|
|
24
|
+
/**
|
|
25
|
+
* IDs of the modules to include in the export
|
|
26
|
+
* @type {Array<string>}
|
|
27
|
+
* @memberof PostCourseExport
|
|
28
|
+
*/
|
|
29
|
+
moduleIds: Array<string>;
|
|
24
30
|
}
|
|
25
31
|
/**
|
|
26
32
|
* @export
|
|
27
33
|
*/
|
|
28
|
-
export declare const
|
|
34
|
+
export declare const PostCourseExportExportTypeEnum: {
|
|
29
35
|
readonly Scorm12: "SCORM_1_2";
|
|
30
36
|
readonly Scorm20043RdEdition: "SCORM_2004_3RD_EDITION";
|
|
31
37
|
readonly Scorm20044ThEdition: "SCORM_2004_4TH_EDITION";
|
|
32
38
|
};
|
|
33
|
-
export type
|
|
39
|
+
export type PostCourseExportExportTypeEnum = typeof PostCourseExportExportTypeEnum[keyof typeof PostCourseExportExportTypeEnum];
|
|
34
40
|
/**
|
|
35
41
|
* Check if a given object implements the PostCourseExport interface.
|
|
36
42
|
*/
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.
|
|
16
|
+
exports.PostCourseExportExportTypeEnum = void 0;
|
|
17
17
|
exports.instanceOfPostCourseExport = instanceOfPostCourseExport;
|
|
18
18
|
exports.PostCourseExportFromJSON = PostCourseExportFromJSON;
|
|
19
19
|
exports.PostCourseExportFromJSONTyped = PostCourseExportFromJSONTyped;
|
|
@@ -22,7 +22,7 @@ exports.PostCourseExportToJSONTyped = PostCourseExportToJSONTyped;
|
|
|
22
22
|
/**
|
|
23
23
|
* @export
|
|
24
24
|
*/
|
|
25
|
-
exports.
|
|
25
|
+
exports.PostCourseExportExportTypeEnum = {
|
|
26
26
|
Scorm12: 'SCORM_1_2',
|
|
27
27
|
Scorm20043RdEdition: 'SCORM_2004_3RD_EDITION',
|
|
28
28
|
Scorm20044ThEdition: 'SCORM_2004_4TH_EDITION'
|
|
@@ -31,7 +31,9 @@ exports.PostCourseExportScormVersionEnum = {
|
|
|
31
31
|
* Check if a given object implements the PostCourseExport interface.
|
|
32
32
|
*/
|
|
33
33
|
function instanceOfPostCourseExport(value) {
|
|
34
|
-
if (!('
|
|
34
|
+
if (!('exportType' in value) || value['exportType'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('moduleIds' in value) || value['moduleIds'] === undefined)
|
|
35
37
|
return false;
|
|
36
38
|
return true;
|
|
37
39
|
}
|
|
@@ -43,7 +45,8 @@ function PostCourseExportFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
43
45
|
return json;
|
|
44
46
|
}
|
|
45
47
|
return {
|
|
46
|
-
'
|
|
48
|
+
'exportType': json['export_type'],
|
|
49
|
+
'moduleIds': json['module_ids'],
|
|
47
50
|
};
|
|
48
51
|
}
|
|
49
52
|
function PostCourseExportToJSON(json) {
|
|
@@ -54,6 +57,7 @@ function PostCourseExportToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
54
57
|
return value;
|
|
55
58
|
}
|
|
56
59
|
return {
|
|
57
|
-
'
|
|
60
|
+
'export_type': value['exportType'],
|
|
61
|
+
'module_ids': value['moduleIds'],
|
|
58
62
|
};
|
|
59
63
|
}
|
package/docs/GetCourseExport.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# GetCourseExport
|
|
3
3
|
|
|
4
|
-
Details of a course
|
|
4
|
+
Details of a course export
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -9,7 +9,9 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`id` | string
|
|
11
11
|
`courseId` | string
|
|
12
|
-
`
|
|
12
|
+
`exportType` | string
|
|
13
|
+
`moduleIds` | Array<string>
|
|
14
|
+
`createdBy` | number
|
|
13
15
|
`status` | string
|
|
14
16
|
`downloadUrl` | string
|
|
15
17
|
`fileSize` | number
|
|
@@ -25,7 +27,9 @@ import type { GetCourseExport } from '@easyedu/js-lsm-api'
|
|
|
25
27
|
const example = {
|
|
26
28
|
"id": null,
|
|
27
29
|
"courseId": null,
|
|
28
|
-
"
|
|
30
|
+
"exportType": null,
|
|
31
|
+
"moduleIds": null,
|
|
32
|
+
"createdBy": null,
|
|
29
33
|
"status": null,
|
|
30
34
|
"downloadUrl": null,
|
|
31
35
|
"fileSize": null,
|
package/docs/PostCourseExport.md
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
|
|
2
2
|
# PostCourseExport
|
|
3
3
|
|
|
4
|
-
Request to create a new
|
|
4
|
+
Request to create a new export for a course
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
|
-
`
|
|
10
|
+
`exportType` | string
|
|
11
|
+
`moduleIds` | Array<string>
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -16,7 +17,8 @@ import type { PostCourseExport } from '@easyedu/js-lsm-api'
|
|
|
16
17
|
|
|
17
18
|
// TODO: Update the object below with actual values
|
|
18
19
|
const example = {
|
|
19
|
-
"
|
|
20
|
+
"exportType": null,
|
|
21
|
+
"moduleIds": null,
|
|
20
22
|
} satisfies PostCourseExport
|
|
21
23
|
|
|
22
24
|
console.log(example)
|
package/package.json
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
16
|
/**
|
|
17
|
-
* Details of a course
|
|
17
|
+
* Details of a course export
|
|
18
18
|
* @export
|
|
19
19
|
* @interface GetCourseExport
|
|
20
20
|
*/
|
|
@@ -32,11 +32,23 @@ export interface GetCourseExport {
|
|
|
32
32
|
*/
|
|
33
33
|
courseId: string;
|
|
34
34
|
/**
|
|
35
|
-
* The
|
|
36
|
-
* @type {
|
|
35
|
+
* The export format type
|
|
36
|
+
* @type {GetCourseExportExportTypeEnum}
|
|
37
37
|
* @memberof GetCourseExport
|
|
38
38
|
*/
|
|
39
|
-
|
|
39
|
+
exportType: GetCourseExportExportTypeEnum;
|
|
40
|
+
/**
|
|
41
|
+
* IDs of the modules included in the export
|
|
42
|
+
* @type {Array<string>}
|
|
43
|
+
* @memberof GetCourseExport
|
|
44
|
+
*/
|
|
45
|
+
moduleIds: Array<string>;
|
|
46
|
+
/**
|
|
47
|
+
* ID of the user who requested the export
|
|
48
|
+
* @type {number}
|
|
49
|
+
* @memberof GetCourseExport
|
|
50
|
+
*/
|
|
51
|
+
createdBy: number;
|
|
40
52
|
/**
|
|
41
53
|
* Current status of the export generation
|
|
42
54
|
* @type {GetCourseExportStatusEnum}
|
|
@@ -44,7 +56,7 @@ export interface GetCourseExport {
|
|
|
44
56
|
*/
|
|
45
57
|
status: GetCourseExportStatusEnum;
|
|
46
58
|
/**
|
|
47
|
-
* URL to download the export
|
|
59
|
+
* URL to download the export file (null if not yet completed)
|
|
48
60
|
* @type {string}
|
|
49
61
|
* @memberof GetCourseExport
|
|
50
62
|
*/
|
|
@@ -73,12 +85,12 @@ export interface GetCourseExport {
|
|
|
73
85
|
/**
|
|
74
86
|
* @export
|
|
75
87
|
*/
|
|
76
|
-
export const
|
|
88
|
+
export const GetCourseExportExportTypeEnum = {
|
|
77
89
|
Scorm12: 'SCORM_1_2',
|
|
78
90
|
Scorm20043RdEdition: 'SCORM_2004_3RD_EDITION',
|
|
79
91
|
Scorm20044ThEdition: 'SCORM_2004_4TH_EDITION'
|
|
80
92
|
} as const;
|
|
81
|
-
export type
|
|
93
|
+
export type GetCourseExportExportTypeEnum = typeof GetCourseExportExportTypeEnum[keyof typeof GetCourseExportExportTypeEnum];
|
|
82
94
|
|
|
83
95
|
/**
|
|
84
96
|
* @export
|
|
@@ -98,7 +110,9 @@ export type GetCourseExportStatusEnum = typeof GetCourseExportStatusEnum[keyof t
|
|
|
98
110
|
export function instanceOfGetCourseExport(value: object): value is GetCourseExport {
|
|
99
111
|
if (!('id' in value) || value['id'] === undefined) return false;
|
|
100
112
|
if (!('courseId' in value) || value['courseId'] === undefined) return false;
|
|
101
|
-
if (!('
|
|
113
|
+
if (!('exportType' in value) || value['exportType'] === undefined) return false;
|
|
114
|
+
if (!('moduleIds' in value) || value['moduleIds'] === undefined) return false;
|
|
115
|
+
if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
|
|
102
116
|
if (!('status' in value) || value['status'] === undefined) return false;
|
|
103
117
|
if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
|
|
104
118
|
return true;
|
|
@@ -116,7 +130,9 @@ export function GetCourseExportFromJSONTyped(json: any, ignoreDiscriminator: boo
|
|
|
116
130
|
|
|
117
131
|
'id': json['id'],
|
|
118
132
|
'courseId': json['course_id'],
|
|
119
|
-
'
|
|
133
|
+
'exportType': json['export_type'],
|
|
134
|
+
'moduleIds': json['module_ids'],
|
|
135
|
+
'createdBy': json['created_by'],
|
|
120
136
|
'status': json['status'],
|
|
121
137
|
'downloadUrl': json['download_url'] == null ? undefined : json['download_url'],
|
|
122
138
|
'fileSize': json['file_size'] == null ? undefined : json['file_size'],
|
|
@@ -138,7 +154,9 @@ export function GetCourseExportToJSONTyped(value?: GetCourseExport | null, ignor
|
|
|
138
154
|
|
|
139
155
|
'id': value['id'],
|
|
140
156
|
'course_id': value['courseId'],
|
|
141
|
-
'
|
|
157
|
+
'export_type': value['exportType'],
|
|
158
|
+
'module_ids': value['moduleIds'],
|
|
159
|
+
'created_by': value['createdBy'],
|
|
142
160
|
'status': value['status'],
|
|
143
161
|
'download_url': value['downloadUrl'],
|
|
144
162
|
'file_size': value['fileSize'],
|
|
@@ -14,36 +14,43 @@
|
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
16
|
/**
|
|
17
|
-
* Request to create a new
|
|
17
|
+
* Request to create a new export for a course
|
|
18
18
|
* @export
|
|
19
19
|
* @interface PostCourseExport
|
|
20
20
|
*/
|
|
21
21
|
export interface PostCourseExport {
|
|
22
22
|
/**
|
|
23
|
-
* The
|
|
24
|
-
* @type {
|
|
23
|
+
* The export format type
|
|
24
|
+
* @type {PostCourseExportExportTypeEnum}
|
|
25
25
|
* @memberof PostCourseExport
|
|
26
26
|
*/
|
|
27
|
-
|
|
27
|
+
exportType: PostCourseExportExportTypeEnum;
|
|
28
|
+
/**
|
|
29
|
+
* IDs of the modules to include in the export
|
|
30
|
+
* @type {Array<string>}
|
|
31
|
+
* @memberof PostCourseExport
|
|
32
|
+
*/
|
|
33
|
+
moduleIds: Array<string>;
|
|
28
34
|
}
|
|
29
35
|
|
|
30
36
|
|
|
31
37
|
/**
|
|
32
38
|
* @export
|
|
33
39
|
*/
|
|
34
|
-
export const
|
|
40
|
+
export const PostCourseExportExportTypeEnum = {
|
|
35
41
|
Scorm12: 'SCORM_1_2',
|
|
36
42
|
Scorm20043RdEdition: 'SCORM_2004_3RD_EDITION',
|
|
37
43
|
Scorm20044ThEdition: 'SCORM_2004_4TH_EDITION'
|
|
38
44
|
} as const;
|
|
39
|
-
export type
|
|
45
|
+
export type PostCourseExportExportTypeEnum = typeof PostCourseExportExportTypeEnum[keyof typeof PostCourseExportExportTypeEnum];
|
|
40
46
|
|
|
41
47
|
|
|
42
48
|
/**
|
|
43
49
|
* Check if a given object implements the PostCourseExport interface.
|
|
44
50
|
*/
|
|
45
51
|
export function instanceOfPostCourseExport(value: object): value is PostCourseExport {
|
|
46
|
-
if (!('
|
|
52
|
+
if (!('exportType' in value) || value['exportType'] === undefined) return false;
|
|
53
|
+
if (!('moduleIds' in value) || value['moduleIds'] === undefined) return false;
|
|
47
54
|
return true;
|
|
48
55
|
}
|
|
49
56
|
|
|
@@ -57,7 +64,8 @@ export function PostCourseExportFromJSONTyped(json: any, ignoreDiscriminator: bo
|
|
|
57
64
|
}
|
|
58
65
|
return {
|
|
59
66
|
|
|
60
|
-
'
|
|
67
|
+
'exportType': json['export_type'],
|
|
68
|
+
'moduleIds': json['module_ids'],
|
|
61
69
|
};
|
|
62
70
|
}
|
|
63
71
|
|
|
@@ -72,7 +80,8 @@ export function PostCourseExportToJSONTyped(value?: PostCourseExport | null, ign
|
|
|
72
80
|
|
|
73
81
|
return {
|
|
74
82
|
|
|
75
|
-
'
|
|
83
|
+
'export_type': value['exportType'],
|
|
84
|
+
'module_ids': value['moduleIds'],
|
|
76
85
|
};
|
|
77
86
|
}
|
|
78
87
|
|