@easyedu/js-lsm-api 1.123.0 → 1.125.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.
Files changed (65) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/README.md +11 -4
  3. package/dist/apis/CourseApi.d.ts +4 -4
  4. package/dist/apis/CourseApi.js +4 -4
  5. package/dist/apis/ReportingApi.d.ts +16 -0
  6. package/dist/apis/ReportingApi.js +39 -0
  7. package/dist/esm/apis/CourseApi.d.ts +4 -4
  8. package/dist/esm/apis/CourseApi.js +4 -4
  9. package/dist/esm/apis/ReportingApi.d.ts +16 -0
  10. package/dist/esm/apis/ReportingApi.js +39 -0
  11. package/dist/esm/models/GetPortalManagementDashboard.d.ts +73 -0
  12. package/dist/esm/models/GetPortalManagementDashboard.js +72 -0
  13. package/dist/esm/models/GetPortalManagementDashboardActivityDay.d.ts +50 -0
  14. package/dist/esm/models/GetPortalManagementDashboardActivityDay.js +55 -0
  15. package/dist/esm/models/GetPortalManagementDashboardAttention.d.ts +56 -0
  16. package/dist/esm/models/GetPortalManagementDashboardAttention.js +59 -0
  17. package/dist/esm/models/GetPortalManagementDashboardEnrollmentStatus.d.ts +44 -0
  18. package/dist/esm/models/GetPortalManagementDashboardEnrollmentStatus.js +51 -0
  19. package/dist/esm/models/GetPortalManagementDashboardSummary.d.ts +74 -0
  20. package/dist/esm/models/GetPortalManagementDashboardSummary.js +71 -0
  21. package/dist/esm/models/GetPortalManagementDashboardTopCourse.d.ts +56 -0
  22. package/dist/esm/models/GetPortalManagementDashboardTopCourse.js +59 -0
  23. package/dist/esm/models/PostCourseEnrollment.d.ts +8 -4
  24. package/dist/esm/models/PutCourseEnrollment.d.ts +0 -14
  25. package/dist/esm/models/PutCourseEnrollment.js +0 -9
  26. package/dist/esm/models/index.d.ts +6 -0
  27. package/dist/esm/models/index.js +6 -0
  28. package/dist/models/GetPortalManagementDashboard.d.ts +73 -0
  29. package/dist/models/GetPortalManagementDashboard.js +79 -0
  30. package/dist/models/GetPortalManagementDashboardActivityDay.d.ts +50 -0
  31. package/dist/models/GetPortalManagementDashboardActivityDay.js +62 -0
  32. package/dist/models/GetPortalManagementDashboardAttention.d.ts +56 -0
  33. package/dist/models/GetPortalManagementDashboardAttention.js +66 -0
  34. package/dist/models/GetPortalManagementDashboardEnrollmentStatus.d.ts +44 -0
  35. package/dist/models/GetPortalManagementDashboardEnrollmentStatus.js +58 -0
  36. package/dist/models/GetPortalManagementDashboardSummary.d.ts +74 -0
  37. package/dist/models/GetPortalManagementDashboardSummary.js +78 -0
  38. package/dist/models/GetPortalManagementDashboardTopCourse.d.ts +56 -0
  39. package/dist/models/GetPortalManagementDashboardTopCourse.js +66 -0
  40. package/dist/models/PostCourseEnrollment.d.ts +8 -4
  41. package/dist/models/PutCourseEnrollment.d.ts +0 -14
  42. package/dist/models/PutCourseEnrollment.js +1 -10
  43. package/dist/models/index.d.ts +6 -0
  44. package/dist/models/index.js +6 -0
  45. package/docs/CourseApi.md +7 -5
  46. package/docs/GetPortalManagementDashboard.md +46 -0
  47. package/docs/GetPortalManagementDashboardActivityDay.md +40 -0
  48. package/docs/GetPortalManagementDashboardAttention.md +42 -0
  49. package/docs/GetPortalManagementDashboardEnrollmentStatus.md +38 -0
  50. package/docs/GetPortalManagementDashboardSummary.md +48 -0
  51. package/docs/GetPortalManagementDashboardTopCourse.md +42 -0
  52. package/docs/PutCourseEnrollment.md +0 -2
  53. package/docs/ReportingApi.md +67 -0
  54. package/package.json +1 -1
  55. package/src/apis/CourseApi.ts +4 -4
  56. package/src/apis/ReportingApi.ts +50 -0
  57. package/src/models/GetPortalManagementDashboard.ts +156 -0
  58. package/src/models/GetPortalManagementDashboardActivityDay.ts +93 -0
  59. package/src/models/GetPortalManagementDashboardAttention.ts +102 -0
  60. package/src/models/GetPortalManagementDashboardEnrollmentStatus.ts +84 -0
  61. package/src/models/GetPortalManagementDashboardSummary.ts +129 -0
  62. package/src/models/GetPortalManagementDashboardTopCourse.ts +102 -0
  63. package/src/models/PostCourseEnrollment.ts +8 -4
  64. package/src/models/PutCourseEnrollment.ts +0 -17
  65. package/src/models/index.ts +6 -0
@@ -0,0 +1,56 @@
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 GetPortalManagementDashboardAttention
16
+ */
17
+ export interface GetPortalManagementDashboardAttention {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof GetPortalManagementDashboardAttention
22
+ */
23
+ notStartedEnrollmentCount: number;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof GetPortalManagementDashboardAttention
28
+ */
29
+ inactiveLearnerCount: number;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof GetPortalManagementDashboardAttention
34
+ */
35
+ expiringEnrollmentCount: number;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof GetPortalManagementDashboardAttention
40
+ */
41
+ expiringCertificateCount: number;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof GetPortalManagementDashboardAttention
46
+ */
47
+ draftCourseCount: number;
48
+ }
49
+ /**
50
+ * Check if a given object implements the GetPortalManagementDashboardAttention interface.
51
+ */
52
+ export declare function instanceOfGetPortalManagementDashboardAttention(value: object): value is GetPortalManagementDashboardAttention;
53
+ export declare function GetPortalManagementDashboardAttentionFromJSON(json: any): GetPortalManagementDashboardAttention;
54
+ export declare function GetPortalManagementDashboardAttentionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboardAttention;
55
+ export declare function GetPortalManagementDashboardAttentionToJSON(json: any): GetPortalManagementDashboardAttention;
56
+ export declare function GetPortalManagementDashboardAttentionToJSONTyped(value?: GetPortalManagementDashboardAttention | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,59 @@
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
+ * Check if a given object implements the GetPortalManagementDashboardAttention interface.
16
+ */
17
+ export function instanceOfGetPortalManagementDashboardAttention(value) {
18
+ if (!('notStartedEnrollmentCount' in value) || value['notStartedEnrollmentCount'] === undefined)
19
+ return false;
20
+ if (!('inactiveLearnerCount' in value) || value['inactiveLearnerCount'] === undefined)
21
+ return false;
22
+ if (!('expiringEnrollmentCount' in value) || value['expiringEnrollmentCount'] === undefined)
23
+ return false;
24
+ if (!('expiringCertificateCount' in value) || value['expiringCertificateCount'] === undefined)
25
+ return false;
26
+ if (!('draftCourseCount' in value) || value['draftCourseCount'] === undefined)
27
+ return false;
28
+ return true;
29
+ }
30
+ export function GetPortalManagementDashboardAttentionFromJSON(json) {
31
+ return GetPortalManagementDashboardAttentionFromJSONTyped(json, false);
32
+ }
33
+ export function GetPortalManagementDashboardAttentionFromJSONTyped(json, ignoreDiscriminator) {
34
+ if (json == null) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'notStartedEnrollmentCount': json['not_started_enrollment_count'],
39
+ 'inactiveLearnerCount': json['inactive_learner_count'],
40
+ 'expiringEnrollmentCount': json['expiring_enrollment_count'],
41
+ 'expiringCertificateCount': json['expiring_certificate_count'],
42
+ 'draftCourseCount': json['draft_course_count'],
43
+ };
44
+ }
45
+ export function GetPortalManagementDashboardAttentionToJSON(json) {
46
+ return GetPortalManagementDashboardAttentionToJSONTyped(json, false);
47
+ }
48
+ export function GetPortalManagementDashboardAttentionToJSONTyped(value, ignoreDiscriminator = false) {
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'not_started_enrollment_count': value['notStartedEnrollmentCount'],
54
+ 'inactive_learner_count': value['inactiveLearnerCount'],
55
+ 'expiring_enrollment_count': value['expiringEnrollmentCount'],
56
+ 'expiring_certificate_count': value['expiringCertificateCount'],
57
+ 'draft_course_count': value['draftCourseCount'],
58
+ };
59
+ }
@@ -0,0 +1,44 @@
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 GetPortalManagementDashboardEnrollmentStatus
16
+ */
17
+ export interface GetPortalManagementDashboardEnrollmentStatus {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof GetPortalManagementDashboardEnrollmentStatus
22
+ */
23
+ notStartedCount: number;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof GetPortalManagementDashboardEnrollmentStatus
28
+ */
29
+ inProgressCount: number;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof GetPortalManagementDashboardEnrollmentStatus
34
+ */
35
+ completedCount: number;
36
+ }
37
+ /**
38
+ * Check if a given object implements the GetPortalManagementDashboardEnrollmentStatus interface.
39
+ */
40
+ export declare function instanceOfGetPortalManagementDashboardEnrollmentStatus(value: object): value is GetPortalManagementDashboardEnrollmentStatus;
41
+ export declare function GetPortalManagementDashboardEnrollmentStatusFromJSON(json: any): GetPortalManagementDashboardEnrollmentStatus;
42
+ export declare function GetPortalManagementDashboardEnrollmentStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboardEnrollmentStatus;
43
+ export declare function GetPortalManagementDashboardEnrollmentStatusToJSON(json: any): GetPortalManagementDashboardEnrollmentStatus;
44
+ export declare function GetPortalManagementDashboardEnrollmentStatusToJSONTyped(value?: GetPortalManagementDashboardEnrollmentStatus | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
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
+ * Check if a given object implements the GetPortalManagementDashboardEnrollmentStatus interface.
16
+ */
17
+ export function instanceOfGetPortalManagementDashboardEnrollmentStatus(value) {
18
+ if (!('notStartedCount' in value) || value['notStartedCount'] === undefined)
19
+ return false;
20
+ if (!('inProgressCount' in value) || value['inProgressCount'] === undefined)
21
+ return false;
22
+ if (!('completedCount' in value) || value['completedCount'] === undefined)
23
+ return false;
24
+ return true;
25
+ }
26
+ export function GetPortalManagementDashboardEnrollmentStatusFromJSON(json) {
27
+ return GetPortalManagementDashboardEnrollmentStatusFromJSONTyped(json, false);
28
+ }
29
+ export function GetPortalManagementDashboardEnrollmentStatusFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ 'notStartedCount': json['not_started_count'],
35
+ 'inProgressCount': json['in_progress_count'],
36
+ 'completedCount': json['completed_count'],
37
+ };
38
+ }
39
+ export function GetPortalManagementDashboardEnrollmentStatusToJSON(json) {
40
+ return GetPortalManagementDashboardEnrollmentStatusToJSONTyped(json, false);
41
+ }
42
+ export function GetPortalManagementDashboardEnrollmentStatusToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'not_started_count': value['notStartedCount'],
48
+ 'in_progress_count': value['inProgressCount'],
49
+ 'completed_count': value['completedCount'],
50
+ };
51
+ }
@@ -0,0 +1,74 @@
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 GetPortalManagementDashboardSummary
16
+ */
17
+ export interface GetPortalManagementDashboardSummary {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof GetPortalManagementDashboardSummary
22
+ */
23
+ learnerCount: number;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof GetPortalManagementDashboardSummary
28
+ */
29
+ activeLearnerCount: number;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof GetPortalManagementDashboardSummary
34
+ */
35
+ activeEnrollmentCount: number;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof GetPortalManagementDashboardSummary
40
+ */
41
+ completionRatePercentage: number | null;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof GetPortalManagementDashboardSummary
46
+ */
47
+ courseCount: number;
48
+ /**
49
+ *
50
+ * @type {number}
51
+ * @memberof GetPortalManagementDashboardSummary
52
+ */
53
+ publishedCourseCount: number;
54
+ /**
55
+ *
56
+ * @type {number}
57
+ * @memberof GetPortalManagementDashboardSummary
58
+ */
59
+ draftCourseCount: number;
60
+ /**
61
+ *
62
+ * @type {number}
63
+ * @memberof GetPortalManagementDashboardSummary
64
+ */
65
+ loginsToday: number;
66
+ }
67
+ /**
68
+ * Check if a given object implements the GetPortalManagementDashboardSummary interface.
69
+ */
70
+ export declare function instanceOfGetPortalManagementDashboardSummary(value: object): value is GetPortalManagementDashboardSummary;
71
+ export declare function GetPortalManagementDashboardSummaryFromJSON(json: any): GetPortalManagementDashboardSummary;
72
+ export declare function GetPortalManagementDashboardSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboardSummary;
73
+ export declare function GetPortalManagementDashboardSummaryToJSON(json: any): GetPortalManagementDashboardSummary;
74
+ export declare function GetPortalManagementDashboardSummaryToJSONTyped(value?: GetPortalManagementDashboardSummary | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,71 @@
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
+ * Check if a given object implements the GetPortalManagementDashboardSummary interface.
16
+ */
17
+ export function instanceOfGetPortalManagementDashboardSummary(value) {
18
+ if (!('learnerCount' in value) || value['learnerCount'] === undefined)
19
+ return false;
20
+ if (!('activeLearnerCount' in value) || value['activeLearnerCount'] === undefined)
21
+ return false;
22
+ if (!('activeEnrollmentCount' in value) || value['activeEnrollmentCount'] === undefined)
23
+ return false;
24
+ if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined)
25
+ return false;
26
+ if (!('courseCount' in value) || value['courseCount'] === undefined)
27
+ return false;
28
+ if (!('publishedCourseCount' in value) || value['publishedCourseCount'] === undefined)
29
+ return false;
30
+ if (!('draftCourseCount' in value) || value['draftCourseCount'] === undefined)
31
+ return false;
32
+ if (!('loginsToday' in value) || value['loginsToday'] === undefined)
33
+ return false;
34
+ return true;
35
+ }
36
+ export function GetPortalManagementDashboardSummaryFromJSON(json) {
37
+ return GetPortalManagementDashboardSummaryFromJSONTyped(json, false);
38
+ }
39
+ export function GetPortalManagementDashboardSummaryFromJSONTyped(json, ignoreDiscriminator) {
40
+ if (json == null) {
41
+ return json;
42
+ }
43
+ return {
44
+ 'learnerCount': json['learner_count'],
45
+ 'activeLearnerCount': json['active_learner_count'],
46
+ 'activeEnrollmentCount': json['active_enrollment_count'],
47
+ 'completionRatePercentage': json['completion_rate_percentage'],
48
+ 'courseCount': json['course_count'],
49
+ 'publishedCourseCount': json['published_course_count'],
50
+ 'draftCourseCount': json['draft_course_count'],
51
+ 'loginsToday': json['logins_today'],
52
+ };
53
+ }
54
+ export function GetPortalManagementDashboardSummaryToJSON(json) {
55
+ return GetPortalManagementDashboardSummaryToJSONTyped(json, false);
56
+ }
57
+ export function GetPortalManagementDashboardSummaryToJSONTyped(value, ignoreDiscriminator = false) {
58
+ if (value == null) {
59
+ return value;
60
+ }
61
+ return {
62
+ 'learner_count': value['learnerCount'],
63
+ 'active_learner_count': value['activeLearnerCount'],
64
+ 'active_enrollment_count': value['activeEnrollmentCount'],
65
+ 'completion_rate_percentage': value['completionRatePercentage'],
66
+ 'course_count': value['courseCount'],
67
+ 'published_course_count': value['publishedCourseCount'],
68
+ 'draft_course_count': value['draftCourseCount'],
69
+ 'logins_today': value['loginsToday'],
70
+ };
71
+ }
@@ -0,0 +1,56 @@
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 GetPortalManagementDashboardTopCourse
16
+ */
17
+ export interface GetPortalManagementDashboardTopCourse {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof GetPortalManagementDashboardTopCourse
22
+ */
23
+ courseId: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof GetPortalManagementDashboardTopCourse
28
+ */
29
+ courseName: string;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof GetPortalManagementDashboardTopCourse
34
+ */
35
+ enrollmentCount: number;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof GetPortalManagementDashboardTopCourse
40
+ */
41
+ activeLearnerCount: number;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof GetPortalManagementDashboardTopCourse
46
+ */
47
+ completionRatePercentage: number | null;
48
+ }
49
+ /**
50
+ * Check if a given object implements the GetPortalManagementDashboardTopCourse interface.
51
+ */
52
+ export declare function instanceOfGetPortalManagementDashboardTopCourse(value: object): value is GetPortalManagementDashboardTopCourse;
53
+ export declare function GetPortalManagementDashboardTopCourseFromJSON(json: any): GetPortalManagementDashboardTopCourse;
54
+ export declare function GetPortalManagementDashboardTopCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboardTopCourse;
55
+ export declare function GetPortalManagementDashboardTopCourseToJSON(json: any): GetPortalManagementDashboardTopCourse;
56
+ export declare function GetPortalManagementDashboardTopCourseToJSONTyped(value?: GetPortalManagementDashboardTopCourse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,59 @@
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
+ * Check if a given object implements the GetPortalManagementDashboardTopCourse interface.
16
+ */
17
+ export function instanceOfGetPortalManagementDashboardTopCourse(value) {
18
+ if (!('courseId' in value) || value['courseId'] === undefined)
19
+ return false;
20
+ if (!('courseName' in value) || value['courseName'] === undefined)
21
+ return false;
22
+ if (!('enrollmentCount' in value) || value['enrollmentCount'] === undefined)
23
+ return false;
24
+ if (!('activeLearnerCount' in value) || value['activeLearnerCount'] === undefined)
25
+ return false;
26
+ if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined)
27
+ return false;
28
+ return true;
29
+ }
30
+ export function GetPortalManagementDashboardTopCourseFromJSON(json) {
31
+ return GetPortalManagementDashboardTopCourseFromJSONTyped(json, false);
32
+ }
33
+ export function GetPortalManagementDashboardTopCourseFromJSONTyped(json, ignoreDiscriminator) {
34
+ if (json == null) {
35
+ return json;
36
+ }
37
+ return {
38
+ 'courseId': json['course_id'],
39
+ 'courseName': json['course_name'],
40
+ 'enrollmentCount': json['enrollment_count'],
41
+ 'activeLearnerCount': json['active_learner_count'],
42
+ 'completionRatePercentage': json['completion_rate_percentage'],
43
+ };
44
+ }
45
+ export function GetPortalManagementDashboardTopCourseToJSON(json) {
46
+ return GetPortalManagementDashboardTopCourseToJSONTyped(json, false);
47
+ }
48
+ export function GetPortalManagementDashboardTopCourseToJSONTyped(value, ignoreDiscriminator = false) {
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'course_id': value['courseId'],
54
+ 'course_name': value['courseName'],
55
+ 'enrollment_count': value['enrollmentCount'],
56
+ 'active_learner_count': value['activeLearnerCount'],
57
+ 'completion_rate_percentage': value['completionRatePercentage'],
58
+ };
59
+ }
@@ -40,15 +40,19 @@ export interface PostCourseEnrollment {
40
40
  */
41
41
  notes?: string | null;
42
42
  /**
43
- * The role/type of the user in this enrollment
43
+ * The role/type of this enrollment. A user may have one current Student and
44
+ * one current Instructor enrollment for the same course. Assign both roles
45
+ * with two requests, one for each user_type.
46
+ *
44
47
  * @type {PostCourseEnrollmentUserTypeEnum}
45
48
  * @memberof PostCourseEnrollment
46
49
  */
47
50
  userType?: PostCourseEnrollmentUserTypeEnum | null;
48
51
  /**
49
- * How to handle a learner with a prior terminal enrollment for this course.
50
- * restart creates a new enrollment period; resume reopens the latest terminal
51
- * enrollment. Active enrollments always conflict.
52
+ * How to handle a user with a prior terminal enrollment of the requested
53
+ * user_type for this course. restart creates a new enrollment period; resume
54
+ * reopens the latest terminal enrollment of that type. A current enrollment
55
+ * of the same type always conflicts.
52
56
  *
53
57
  * @type {PostCourseEnrollmentReEnrollmentModeEnum}
54
58
  * @memberof PostCourseEnrollment
@@ -24,12 +24,6 @@ export interface PutCourseEnrollment {
24
24
  * @memberof PutCourseEnrollment
25
25
  */
26
26
  status?: PutCourseEnrollmentStatusEnum;
27
- /**
28
- * The role/type of the user in this enrollment
29
- * @type {PutCourseEnrollmentUserTypeEnum}
30
- * @memberof PutCourseEnrollment
31
- */
32
- userType?: PutCourseEnrollmentUserTypeEnum;
33
27
  /**
34
28
  * End date of the enrollment (Unix timestamp)
35
29
  * @type {number}
@@ -71,14 +65,6 @@ export declare const PutCourseEnrollmentStatusEnum: {
71
65
  readonly Suspended: "Suspended";
72
66
  };
73
67
  export type PutCourseEnrollmentStatusEnum = typeof PutCourseEnrollmentStatusEnum[keyof typeof PutCourseEnrollmentStatusEnum];
74
- /**
75
- * @export
76
- */
77
- export declare const PutCourseEnrollmentUserTypeEnum: {
78
- readonly Student: "Student";
79
- readonly Instructor: "Instructor";
80
- };
81
- export type PutCourseEnrollmentUserTypeEnum = typeof PutCourseEnrollmentUserTypeEnum[keyof typeof PutCourseEnrollmentUserTypeEnum];
82
68
  /**
83
69
  * Check if a given object implements the PutCourseEnrollment interface.
84
70
  */
@@ -23,13 +23,6 @@ export const PutCourseEnrollmentStatusEnum = {
23
23
  Archived: 'Archived',
24
24
  Suspended: 'Suspended'
25
25
  };
26
- /**
27
- * @export
28
- */
29
- export const PutCourseEnrollmentUserTypeEnum = {
30
- Student: 'Student',
31
- Instructor: 'Instructor'
32
- };
33
26
  /**
34
27
  * Check if a given object implements the PutCourseEnrollment interface.
35
28
  */
@@ -45,7 +38,6 @@ export function PutCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
45
38
  }
46
39
  return {
47
40
  'status': json['status'] == null ? undefined : json['status'],
48
- 'userType': json['user_type'] == null ? undefined : json['user_type'],
49
41
  'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
50
42
  'extensionDays': json['extension_days'] == null ? undefined : json['extension_days'],
51
43
  'notes': json['notes'] == null ? undefined : json['notes'],
@@ -61,7 +53,6 @@ export function PutCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = fals
61
53
  }
62
54
  return {
63
55
  'status': value['status'],
64
- 'user_type': value['userType'],
65
56
  'enrollment_date_end': value['enrollmentDateEnd'],
66
57
  'extension_days': value['extensionDays'],
67
58
  'notes': value['notes'],
@@ -117,6 +117,12 @@ export * from './GetPortalFaviconUpload';
117
117
  export * from './GetPortalInvitationSummary';
118
118
  export * from './GetPortalList';
119
119
  export * from './GetPortalLogoUpload';
120
+ export * from './GetPortalManagementDashboard';
121
+ export * from './GetPortalManagementDashboardActivityDay';
122
+ export * from './GetPortalManagementDashboardAttention';
123
+ export * from './GetPortalManagementDashboardEnrollmentStatus';
124
+ export * from './GetPortalManagementDashboardSummary';
125
+ export * from './GetPortalManagementDashboardTopCourse';
120
126
  export * from './GetPortalUser';
121
127
  export * from './GetPortalUserFieldValues';
122
128
  export * from './GetPortalUserList';
@@ -119,6 +119,12 @@ export * from './GetPortalFaviconUpload';
119
119
  export * from './GetPortalInvitationSummary';
120
120
  export * from './GetPortalList';
121
121
  export * from './GetPortalLogoUpload';
122
+ export * from './GetPortalManagementDashboard';
123
+ export * from './GetPortalManagementDashboardActivityDay';
124
+ export * from './GetPortalManagementDashboardAttention';
125
+ export * from './GetPortalManagementDashboardEnrollmentStatus';
126
+ export * from './GetPortalManagementDashboardSummary';
127
+ export * from './GetPortalManagementDashboardTopCourse';
122
128
  export * from './GetPortalUser';
123
129
  export * from './GetPortalUserFieldValues';
124
130
  export * from './GetPortalUserList';
@@ -0,0 +1,73 @@
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
+ import type { GetPortalManagementDashboardTopCourse } from './GetPortalManagementDashboardTopCourse';
13
+ import type { GetPortalManagementDashboardEnrollmentStatus } from './GetPortalManagementDashboardEnrollmentStatus';
14
+ import type { GetPortalManagementDashboardSummary } from './GetPortalManagementDashboardSummary';
15
+ import type { GetPortalManagementDashboardActivityDay } from './GetPortalManagementDashboardActivityDay';
16
+ import type { GetPortalManagementDashboardAttention } from './GetPortalManagementDashboardAttention';
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface GetPortalManagementDashboard
21
+ */
22
+ export interface GetPortalManagementDashboard {
23
+ /**
24
+ *
25
+ * @type {number}
26
+ * @memberof GetPortalManagementDashboard
27
+ */
28
+ rangeDays: number;
29
+ /**
30
+ * Unix timestamp in seconds.
31
+ * @type {number}
32
+ * @memberof GetPortalManagementDashboard
33
+ */
34
+ generatedAt: number;
35
+ /**
36
+ *
37
+ * @type {GetPortalManagementDashboardSummary}
38
+ * @memberof GetPortalManagementDashboard
39
+ */
40
+ summary: GetPortalManagementDashboardSummary;
41
+ /**
42
+ *
43
+ * @type {GetPortalManagementDashboardEnrollmentStatus}
44
+ * @memberof GetPortalManagementDashboard
45
+ */
46
+ enrollmentStatus: GetPortalManagementDashboardEnrollmentStatus;
47
+ /**
48
+ *
49
+ * @type {Array<GetPortalManagementDashboardActivityDay>}
50
+ * @memberof GetPortalManagementDashboard
51
+ */
52
+ activity: Array<GetPortalManagementDashboardActivityDay>;
53
+ /**
54
+ *
55
+ * @type {Array<GetPortalManagementDashboardTopCourse>}
56
+ * @memberof GetPortalManagementDashboard
57
+ */
58
+ topCourses: Array<GetPortalManagementDashboardTopCourse>;
59
+ /**
60
+ *
61
+ * @type {GetPortalManagementDashboardAttention}
62
+ * @memberof GetPortalManagementDashboard
63
+ */
64
+ attention: GetPortalManagementDashboardAttention;
65
+ }
66
+ /**
67
+ * Check if a given object implements the GetPortalManagementDashboard interface.
68
+ */
69
+ export declare function instanceOfGetPortalManagementDashboard(value: object): value is GetPortalManagementDashboard;
70
+ export declare function GetPortalManagementDashboardFromJSON(json: any): GetPortalManagementDashboard;
71
+ export declare function GetPortalManagementDashboardFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboard;
72
+ export declare function GetPortalManagementDashboardToJSON(json: any): GetPortalManagementDashboard;
73
+ export declare function GetPortalManagementDashboardToJSONTyped(value?: GetPortalManagementDashboard | null, ignoreDiscriminator?: boolean): any;