@easyedu/js-lsm-api 1.123.0 → 1.124.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 (50) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/README.md +9 -2
  3. package/dist/apis/ReportingApi.d.ts +16 -0
  4. package/dist/apis/ReportingApi.js +39 -0
  5. package/dist/esm/apis/ReportingApi.d.ts +16 -0
  6. package/dist/esm/apis/ReportingApi.js +39 -0
  7. package/dist/esm/models/GetPortalManagementDashboard.d.ts +73 -0
  8. package/dist/esm/models/GetPortalManagementDashboard.js +72 -0
  9. package/dist/esm/models/GetPortalManagementDashboardActivityDay.d.ts +50 -0
  10. package/dist/esm/models/GetPortalManagementDashboardActivityDay.js +55 -0
  11. package/dist/esm/models/GetPortalManagementDashboardAttention.d.ts +56 -0
  12. package/dist/esm/models/GetPortalManagementDashboardAttention.js +59 -0
  13. package/dist/esm/models/GetPortalManagementDashboardEnrollmentStatus.d.ts +44 -0
  14. package/dist/esm/models/GetPortalManagementDashboardEnrollmentStatus.js +51 -0
  15. package/dist/esm/models/GetPortalManagementDashboardSummary.d.ts +74 -0
  16. package/dist/esm/models/GetPortalManagementDashboardSummary.js +71 -0
  17. package/dist/esm/models/GetPortalManagementDashboardTopCourse.d.ts +56 -0
  18. package/dist/esm/models/GetPortalManagementDashboardTopCourse.js +59 -0
  19. package/dist/esm/models/index.d.ts +6 -0
  20. package/dist/esm/models/index.js +6 -0
  21. package/dist/models/GetPortalManagementDashboard.d.ts +73 -0
  22. package/dist/models/GetPortalManagementDashboard.js +79 -0
  23. package/dist/models/GetPortalManagementDashboardActivityDay.d.ts +50 -0
  24. package/dist/models/GetPortalManagementDashboardActivityDay.js +62 -0
  25. package/dist/models/GetPortalManagementDashboardAttention.d.ts +56 -0
  26. package/dist/models/GetPortalManagementDashboardAttention.js +66 -0
  27. package/dist/models/GetPortalManagementDashboardEnrollmentStatus.d.ts +44 -0
  28. package/dist/models/GetPortalManagementDashboardEnrollmentStatus.js +58 -0
  29. package/dist/models/GetPortalManagementDashboardSummary.d.ts +74 -0
  30. package/dist/models/GetPortalManagementDashboardSummary.js +78 -0
  31. package/dist/models/GetPortalManagementDashboardTopCourse.d.ts +56 -0
  32. package/dist/models/GetPortalManagementDashboardTopCourse.js +66 -0
  33. package/dist/models/index.d.ts +6 -0
  34. package/dist/models/index.js +6 -0
  35. package/docs/GetPortalManagementDashboard.md +46 -0
  36. package/docs/GetPortalManagementDashboardActivityDay.md +40 -0
  37. package/docs/GetPortalManagementDashboardAttention.md +42 -0
  38. package/docs/GetPortalManagementDashboardEnrollmentStatus.md +38 -0
  39. package/docs/GetPortalManagementDashboardSummary.md +48 -0
  40. package/docs/GetPortalManagementDashboardTopCourse.md +42 -0
  41. package/docs/ReportingApi.md +67 -0
  42. package/package.json +1 -1
  43. package/src/apis/ReportingApi.ts +50 -0
  44. package/src/models/GetPortalManagementDashboard.ts +156 -0
  45. package/src/models/GetPortalManagementDashboardActivityDay.ts +93 -0
  46. package/src/models/GetPortalManagementDashboardAttention.ts +102 -0
  47. package/src/models/GetPortalManagementDashboardEnrollmentStatus.ts +84 -0
  48. package/src/models/GetPortalManagementDashboardSummary.ts +129 -0
  49. package/src/models/GetPortalManagementDashboardTopCourse.ts +102 -0
  50. package/src/models/index.ts +6 -0
@@ -0,0 +1,129 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface GetPortalManagementDashboardSummary
20
+ */
21
+ export interface GetPortalManagementDashboardSummary {
22
+ /**
23
+ *
24
+ * @type {number}
25
+ * @memberof GetPortalManagementDashboardSummary
26
+ */
27
+ learnerCount: number;
28
+ /**
29
+ *
30
+ * @type {number}
31
+ * @memberof GetPortalManagementDashboardSummary
32
+ */
33
+ activeLearnerCount: number;
34
+ /**
35
+ *
36
+ * @type {number}
37
+ * @memberof GetPortalManagementDashboardSummary
38
+ */
39
+ activeEnrollmentCount: number;
40
+ /**
41
+ *
42
+ * @type {number}
43
+ * @memberof GetPortalManagementDashboardSummary
44
+ */
45
+ completionRatePercentage: number | null;
46
+ /**
47
+ *
48
+ * @type {number}
49
+ * @memberof GetPortalManagementDashboardSummary
50
+ */
51
+ courseCount: number;
52
+ /**
53
+ *
54
+ * @type {number}
55
+ * @memberof GetPortalManagementDashboardSummary
56
+ */
57
+ publishedCourseCount: number;
58
+ /**
59
+ *
60
+ * @type {number}
61
+ * @memberof GetPortalManagementDashboardSummary
62
+ */
63
+ draftCourseCount: number;
64
+ /**
65
+ *
66
+ * @type {number}
67
+ * @memberof GetPortalManagementDashboardSummary
68
+ */
69
+ loginsToday: number;
70
+ }
71
+
72
+ /**
73
+ * Check if a given object implements the GetPortalManagementDashboardSummary interface.
74
+ */
75
+ export function instanceOfGetPortalManagementDashboardSummary(value: object): value is GetPortalManagementDashboardSummary {
76
+ if (!('learnerCount' in value) || value['learnerCount'] === undefined) return false;
77
+ if (!('activeLearnerCount' in value) || value['activeLearnerCount'] === undefined) return false;
78
+ if (!('activeEnrollmentCount' in value) || value['activeEnrollmentCount'] === undefined) return false;
79
+ if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined) return false;
80
+ if (!('courseCount' in value) || value['courseCount'] === undefined) return false;
81
+ if (!('publishedCourseCount' in value) || value['publishedCourseCount'] === undefined) return false;
82
+ if (!('draftCourseCount' in value) || value['draftCourseCount'] === undefined) return false;
83
+ if (!('loginsToday' in value) || value['loginsToday'] === undefined) return false;
84
+ return true;
85
+ }
86
+
87
+ export function GetPortalManagementDashboardSummaryFromJSON(json: any): GetPortalManagementDashboardSummary {
88
+ return GetPortalManagementDashboardSummaryFromJSONTyped(json, false);
89
+ }
90
+
91
+ export function GetPortalManagementDashboardSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboardSummary {
92
+ if (json == null) {
93
+ return json;
94
+ }
95
+ return {
96
+
97
+ 'learnerCount': json['learner_count'],
98
+ 'activeLearnerCount': json['active_learner_count'],
99
+ 'activeEnrollmentCount': json['active_enrollment_count'],
100
+ 'completionRatePercentage': json['completion_rate_percentage'],
101
+ 'courseCount': json['course_count'],
102
+ 'publishedCourseCount': json['published_course_count'],
103
+ 'draftCourseCount': json['draft_course_count'],
104
+ 'loginsToday': json['logins_today'],
105
+ };
106
+ }
107
+
108
+ export function GetPortalManagementDashboardSummaryToJSON(json: any): GetPortalManagementDashboardSummary {
109
+ return GetPortalManagementDashboardSummaryToJSONTyped(json, false);
110
+ }
111
+
112
+ export function GetPortalManagementDashboardSummaryToJSONTyped(value?: GetPortalManagementDashboardSummary | null, ignoreDiscriminator: boolean = false): any {
113
+ if (value == null) {
114
+ return value;
115
+ }
116
+
117
+ return {
118
+
119
+ 'learner_count': value['learnerCount'],
120
+ 'active_learner_count': value['activeLearnerCount'],
121
+ 'active_enrollment_count': value['activeEnrollmentCount'],
122
+ 'completion_rate_percentage': value['completionRatePercentage'],
123
+ 'course_count': value['courseCount'],
124
+ 'published_course_count': value['publishedCourseCount'],
125
+ 'draft_course_count': value['draftCourseCount'],
126
+ 'logins_today': value['loginsToday'],
127
+ };
128
+ }
129
+
@@ -0,0 +1,102 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface GetPortalManagementDashboardTopCourse
20
+ */
21
+ export interface GetPortalManagementDashboardTopCourse {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof GetPortalManagementDashboardTopCourse
26
+ */
27
+ courseId: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof GetPortalManagementDashboardTopCourse
32
+ */
33
+ courseName: string;
34
+ /**
35
+ *
36
+ * @type {number}
37
+ * @memberof GetPortalManagementDashboardTopCourse
38
+ */
39
+ enrollmentCount: number;
40
+ /**
41
+ *
42
+ * @type {number}
43
+ * @memberof GetPortalManagementDashboardTopCourse
44
+ */
45
+ activeLearnerCount: number;
46
+ /**
47
+ *
48
+ * @type {number}
49
+ * @memberof GetPortalManagementDashboardTopCourse
50
+ */
51
+ completionRatePercentage: number | null;
52
+ }
53
+
54
+ /**
55
+ * Check if a given object implements the GetPortalManagementDashboardTopCourse interface.
56
+ */
57
+ export function instanceOfGetPortalManagementDashboardTopCourse(value: object): value is GetPortalManagementDashboardTopCourse {
58
+ if (!('courseId' in value) || value['courseId'] === undefined) return false;
59
+ if (!('courseName' in value) || value['courseName'] === undefined) return false;
60
+ if (!('enrollmentCount' in value) || value['enrollmentCount'] === undefined) return false;
61
+ if (!('activeLearnerCount' in value) || value['activeLearnerCount'] === undefined) return false;
62
+ if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined) return false;
63
+ return true;
64
+ }
65
+
66
+ export function GetPortalManagementDashboardTopCourseFromJSON(json: any): GetPortalManagementDashboardTopCourse {
67
+ return GetPortalManagementDashboardTopCourseFromJSONTyped(json, false);
68
+ }
69
+
70
+ export function GetPortalManagementDashboardTopCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboardTopCourse {
71
+ if (json == null) {
72
+ return json;
73
+ }
74
+ return {
75
+
76
+ 'courseId': json['course_id'],
77
+ 'courseName': json['course_name'],
78
+ 'enrollmentCount': json['enrollment_count'],
79
+ 'activeLearnerCount': json['active_learner_count'],
80
+ 'completionRatePercentage': json['completion_rate_percentage'],
81
+ };
82
+ }
83
+
84
+ export function GetPortalManagementDashboardTopCourseToJSON(json: any): GetPortalManagementDashboardTopCourse {
85
+ return GetPortalManagementDashboardTopCourseToJSONTyped(json, false);
86
+ }
87
+
88
+ export function GetPortalManagementDashboardTopCourseToJSONTyped(value?: GetPortalManagementDashboardTopCourse | null, ignoreDiscriminator: boolean = false): any {
89
+ if (value == null) {
90
+ return value;
91
+ }
92
+
93
+ return {
94
+
95
+ 'course_id': value['courseId'],
96
+ 'course_name': value['courseName'],
97
+ 'enrollment_count': value['enrollmentCount'],
98
+ 'active_learner_count': value['activeLearnerCount'],
99
+ 'completion_rate_percentage': value['completionRatePercentage'],
100
+ };
101
+ }
102
+
@@ -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';