@easyedu/js-lsm-api 1.131.0 → 1.133.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 (122) hide show
  1. package/.openapi-generator/FILES +28 -0
  2. package/README.md +18 -2
  3. package/dist/apis/PortalApi.d.ts +9 -0
  4. package/dist/apis/PortalApi.js +11 -1
  5. package/dist/apis/QuestionApi.d.ts +19 -0
  6. package/dist/apis/QuestionApi.js +44 -0
  7. package/dist/apis/SystemApi.d.ts +16 -0
  8. package/dist/apis/SystemApi.js +40 -0
  9. package/dist/esm/apis/PortalApi.d.ts +9 -0
  10. package/dist/esm/apis/PortalApi.js +10 -0
  11. package/dist/esm/apis/QuestionApi.d.ts +19 -0
  12. package/dist/esm/apis/QuestionApi.js +44 -0
  13. package/dist/esm/apis/SystemApi.d.ts +16 -0
  14. package/dist/esm/apis/SystemApi.js +40 -0
  15. package/dist/esm/models/GetCourseEnrollmentListItem.d.ts +6 -0
  16. package/dist/esm/models/GetCourseEnrollmentListItem.js +2 -0
  17. package/dist/esm/models/GetResourceUsageCoursesInner.d.ts +6 -0
  18. package/dist/esm/models/GetResourceUsageCoursesInner.js +4 -0
  19. package/dist/esm/models/GetSystemPortalOverview.d.ts +121 -0
  20. package/dist/esm/models/GetSystemPortalOverview.js +106 -0
  21. package/dist/esm/models/PostQuestionTags.d.ts +38 -0
  22. package/dist/esm/models/PostQuestionTags.js +47 -0
  23. package/dist/esm/models/PostQuestionTagsResponse.d.ts +32 -0
  24. package/dist/esm/models/PostQuestionTagsResponse.js +43 -0
  25. package/dist/esm/models/SystemPortalActivityStats.d.ts +56 -0
  26. package/dist/esm/models/SystemPortalActivityStats.js +57 -0
  27. package/dist/esm/models/SystemPortalCertificateStats.d.ts +50 -0
  28. package/dist/esm/models/SystemPortalCertificateStats.js +55 -0
  29. package/dist/esm/models/SystemPortalContentStats.d.ts +56 -0
  30. package/dist/esm/models/SystemPortalContentStats.js +59 -0
  31. package/dist/esm/models/SystemPortalCourseStats.d.ts +62 -0
  32. package/dist/esm/models/SystemPortalCourseStats.js +63 -0
  33. package/dist/esm/models/SystemPortalEnrollmentStats.d.ts +56 -0
  34. package/dist/esm/models/SystemPortalEnrollmentStats.js +59 -0
  35. package/dist/esm/models/SystemPortalHierarchy.d.ts +44 -0
  36. package/dist/esm/models/SystemPortalHierarchy.js +47 -0
  37. package/dist/esm/models/SystemPortalLicense.d.ts +65 -0
  38. package/dist/esm/models/SystemPortalLicense.js +61 -0
  39. package/dist/esm/models/SystemPortalRoleCount.d.ts +51 -0
  40. package/dist/esm/models/SystemPortalRoleCount.js +59 -0
  41. package/dist/esm/models/SystemPortalStorageUsage.d.ts +74 -0
  42. package/dist/esm/models/SystemPortalStorageUsage.js +71 -0
  43. package/dist/esm/models/SystemPortalSupportStats.d.ts +50 -0
  44. package/dist/esm/models/SystemPortalSupportStats.js +55 -0
  45. package/dist/esm/models/SystemPortalUserStats.d.ts +81 -0
  46. package/dist/esm/models/SystemPortalUserStats.js +74 -0
  47. package/dist/esm/models/index.d.ts +14 -0
  48. package/dist/esm/models/index.js +14 -0
  49. package/dist/models/GetCourseEnrollmentListItem.d.ts +6 -0
  50. package/dist/models/GetCourseEnrollmentListItem.js +2 -0
  51. package/dist/models/GetResourceUsageCoursesInner.d.ts +6 -0
  52. package/dist/models/GetResourceUsageCoursesInner.js +4 -0
  53. package/dist/models/GetSystemPortalOverview.d.ts +121 -0
  54. package/dist/models/GetSystemPortalOverview.js +113 -0
  55. package/dist/models/PostQuestionTags.d.ts +38 -0
  56. package/dist/models/PostQuestionTags.js +54 -0
  57. package/dist/models/PostQuestionTagsResponse.d.ts +32 -0
  58. package/dist/models/PostQuestionTagsResponse.js +50 -0
  59. package/dist/models/SystemPortalActivityStats.d.ts +56 -0
  60. package/dist/models/SystemPortalActivityStats.js +64 -0
  61. package/dist/models/SystemPortalCertificateStats.d.ts +50 -0
  62. package/dist/models/SystemPortalCertificateStats.js +62 -0
  63. package/dist/models/SystemPortalContentStats.d.ts +56 -0
  64. package/dist/models/SystemPortalContentStats.js +66 -0
  65. package/dist/models/SystemPortalCourseStats.d.ts +62 -0
  66. package/dist/models/SystemPortalCourseStats.js +70 -0
  67. package/dist/models/SystemPortalEnrollmentStats.d.ts +56 -0
  68. package/dist/models/SystemPortalEnrollmentStats.js +66 -0
  69. package/dist/models/SystemPortalHierarchy.d.ts +44 -0
  70. package/dist/models/SystemPortalHierarchy.js +54 -0
  71. package/dist/models/SystemPortalLicense.d.ts +65 -0
  72. package/dist/models/SystemPortalLicense.js +69 -0
  73. package/dist/models/SystemPortalRoleCount.d.ts +51 -0
  74. package/dist/models/SystemPortalRoleCount.js +67 -0
  75. package/dist/models/SystemPortalStorageUsage.d.ts +74 -0
  76. package/dist/models/SystemPortalStorageUsage.js +78 -0
  77. package/dist/models/SystemPortalSupportStats.d.ts +50 -0
  78. package/dist/models/SystemPortalSupportStats.js +62 -0
  79. package/dist/models/SystemPortalUserStats.d.ts +81 -0
  80. package/dist/models/SystemPortalUserStats.js +81 -0
  81. package/dist/models/index.d.ts +14 -0
  82. package/dist/models/index.js +14 -0
  83. package/docs/GetCourseEnrollmentListItem.md +2 -0
  84. package/docs/GetResourceUsageCoursesInner.md +2 -0
  85. package/docs/GetSystemPortalOverview.md +61 -0
  86. package/docs/PortalApi.md +4 -1
  87. package/docs/PostQuestionTags.md +37 -0
  88. package/docs/PostQuestionTagsResponse.md +34 -0
  89. package/docs/QuestionApi.md +71 -0
  90. package/docs/SystemApi.md +68 -0
  91. package/docs/SystemPortalActivityStats.md +42 -0
  92. package/docs/SystemPortalCertificateStats.md +40 -0
  93. package/docs/SystemPortalContentStats.md +43 -0
  94. package/docs/SystemPortalCourseStats.md +44 -0
  95. package/docs/SystemPortalEnrollmentStats.md +43 -0
  96. package/docs/SystemPortalHierarchy.md +38 -0
  97. package/docs/SystemPortalLicense.md +42 -0
  98. package/docs/SystemPortalRoleCount.md +36 -0
  99. package/docs/SystemPortalStorageUsage.md +49 -0
  100. package/docs/SystemPortalSupportStats.md +40 -0
  101. package/docs/SystemPortalUserStats.md +50 -0
  102. package/package.json +1 -1
  103. package/src/apis/PortalApi.ts +13 -0
  104. package/src/apis/QuestionApi.ts +63 -0
  105. package/src/apis/SystemApi.ts +54 -0
  106. package/src/models/GetCourseEnrollmentListItem.ts +8 -0
  107. package/src/models/GetResourceUsageCoursesInner.ts +9 -0
  108. package/src/models/GetSystemPortalOverview.ts +261 -0
  109. package/src/models/PostQuestionTags.ts +75 -0
  110. package/src/models/PostQuestionTagsResponse.ts +66 -0
  111. package/src/models/SystemPortalActivityStats.ts +101 -0
  112. package/src/models/SystemPortalCertificateStats.ts +93 -0
  113. package/src/models/SystemPortalContentStats.ts +102 -0
  114. package/src/models/SystemPortalCourseStats.ts +111 -0
  115. package/src/models/SystemPortalEnrollmentStats.ts +102 -0
  116. package/src/models/SystemPortalHierarchy.ts +82 -0
  117. package/src/models/SystemPortalLicense.ts +111 -0
  118. package/src/models/SystemPortalRoleCount.ts +91 -0
  119. package/src/models/SystemPortalStorageUsage.ts +129 -0
  120. package/src/models/SystemPortalSupportStats.ts +93 -0
  121. package/src/models/SystemPortalUserStats.ts +145 -0
  122. package/src/models/index.ts +14 -0
@@ -0,0 +1,78 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfSystemPortalStorageUsage = instanceOfSystemPortalStorageUsage;
17
+ exports.SystemPortalStorageUsageFromJSON = SystemPortalStorageUsageFromJSON;
18
+ exports.SystemPortalStorageUsageFromJSONTyped = SystemPortalStorageUsageFromJSONTyped;
19
+ exports.SystemPortalStorageUsageToJSON = SystemPortalStorageUsageToJSON;
20
+ exports.SystemPortalStorageUsageToJSONTyped = SystemPortalStorageUsageToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the SystemPortalStorageUsage interface.
23
+ */
24
+ function instanceOfSystemPortalStorageUsage(value) {
25
+ if (!('totalBytes' in value) || value['totalBytes'] === undefined)
26
+ return false;
27
+ if (!('contentLibraryBytes' in value) || value['contentLibraryBytes'] === undefined)
28
+ return false;
29
+ if (!('richTextAssetBytes' in value) || value['richTextAssetBytes'] === undefined)
30
+ return false;
31
+ if (!('emailAssetBytes' in value) || value['emailAssetBytes'] === undefined)
32
+ return false;
33
+ if (!('certificateAssetBytes' in value) || value['certificateAssetBytes'] === undefined)
34
+ return false;
35
+ if (!('certificateArtifactBytes' in value) || value['certificateArtifactBytes'] === undefined)
36
+ return false;
37
+ if (!('supportAttachmentBytes' in value) || value['supportAttachmentBytes'] === undefined)
38
+ return false;
39
+ if (!('courseExportBytes' in value) || value['courseExportBytes'] === undefined)
40
+ return false;
41
+ return true;
42
+ }
43
+ function SystemPortalStorageUsageFromJSON(json) {
44
+ return SystemPortalStorageUsageFromJSONTyped(json, false);
45
+ }
46
+ function SystemPortalStorageUsageFromJSONTyped(json, ignoreDiscriminator) {
47
+ if (json == null) {
48
+ return json;
49
+ }
50
+ return {
51
+ 'totalBytes': json['total_bytes'],
52
+ 'contentLibraryBytes': json['content_library_bytes'],
53
+ 'richTextAssetBytes': json['rich_text_asset_bytes'],
54
+ 'emailAssetBytes': json['email_asset_bytes'],
55
+ 'certificateAssetBytes': json['certificate_asset_bytes'],
56
+ 'certificateArtifactBytes': json['certificate_artifact_bytes'],
57
+ 'supportAttachmentBytes': json['support_attachment_bytes'],
58
+ 'courseExportBytes': json['course_export_bytes'],
59
+ };
60
+ }
61
+ function SystemPortalStorageUsageToJSON(json) {
62
+ return SystemPortalStorageUsageToJSONTyped(json, false);
63
+ }
64
+ function SystemPortalStorageUsageToJSONTyped(value, ignoreDiscriminator = false) {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+ return {
69
+ 'total_bytes': value['totalBytes'],
70
+ 'content_library_bytes': value['contentLibraryBytes'],
71
+ 'rich_text_asset_bytes': value['richTextAssetBytes'],
72
+ 'email_asset_bytes': value['emailAssetBytes'],
73
+ 'certificate_asset_bytes': value['certificateAssetBytes'],
74
+ 'certificate_artifact_bytes': value['certificateArtifactBytes'],
75
+ 'support_attachment_bytes': value['supportAttachmentBytes'],
76
+ 'course_export_bytes': value['courseExportBytes'],
77
+ };
78
+ }
@@ -0,0 +1,50 @@
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 SystemPortalSupportStats
16
+ */
17
+ export interface SystemPortalSupportStats {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof SystemPortalSupportStats
22
+ */
23
+ open: number;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof SystemPortalSupportStats
28
+ */
29
+ inProgress: number;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof SystemPortalSupportStats
34
+ */
35
+ closed: number;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof SystemPortalSupportStats
40
+ */
41
+ total: number;
42
+ }
43
+ /**
44
+ * Check if a given object implements the SystemPortalSupportStats interface.
45
+ */
46
+ export declare function instanceOfSystemPortalSupportStats(value: object): value is SystemPortalSupportStats;
47
+ export declare function SystemPortalSupportStatsFromJSON(json: any): SystemPortalSupportStats;
48
+ export declare function SystemPortalSupportStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalSupportStats;
49
+ export declare function SystemPortalSupportStatsToJSON(json: any): SystemPortalSupportStats;
50
+ export declare function SystemPortalSupportStatsToJSONTyped(value?: SystemPortalSupportStats | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,62 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfSystemPortalSupportStats = instanceOfSystemPortalSupportStats;
17
+ exports.SystemPortalSupportStatsFromJSON = SystemPortalSupportStatsFromJSON;
18
+ exports.SystemPortalSupportStatsFromJSONTyped = SystemPortalSupportStatsFromJSONTyped;
19
+ exports.SystemPortalSupportStatsToJSON = SystemPortalSupportStatsToJSON;
20
+ exports.SystemPortalSupportStatsToJSONTyped = SystemPortalSupportStatsToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the SystemPortalSupportStats interface.
23
+ */
24
+ function instanceOfSystemPortalSupportStats(value) {
25
+ if (!('open' in value) || value['open'] === undefined)
26
+ return false;
27
+ if (!('inProgress' in value) || value['inProgress'] === undefined)
28
+ return false;
29
+ if (!('closed' in value) || value['closed'] === undefined)
30
+ return false;
31
+ if (!('total' in value) || value['total'] === undefined)
32
+ return false;
33
+ return true;
34
+ }
35
+ function SystemPortalSupportStatsFromJSON(json) {
36
+ return SystemPortalSupportStatsFromJSONTyped(json, false);
37
+ }
38
+ function SystemPortalSupportStatsFromJSONTyped(json, ignoreDiscriminator) {
39
+ if (json == null) {
40
+ return json;
41
+ }
42
+ return {
43
+ 'open': json['open'],
44
+ 'inProgress': json['in_progress'],
45
+ 'closed': json['closed'],
46
+ 'total': json['total'],
47
+ };
48
+ }
49
+ function SystemPortalSupportStatsToJSON(json) {
50
+ return SystemPortalSupportStatsToJSONTyped(json, false);
51
+ }
52
+ function SystemPortalSupportStatsToJSONTyped(value, ignoreDiscriminator = false) {
53
+ if (value == null) {
54
+ return value;
55
+ }
56
+ return {
57
+ 'open': value['open'],
58
+ 'in_progress': value['inProgress'],
59
+ 'closed': value['closed'],
60
+ 'total': value['total'],
61
+ };
62
+ }
@@ -0,0 +1,81 @@
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 { SystemPortalRoleCount } from './SystemPortalRoleCount';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface SystemPortalUserStats
17
+ */
18
+ export interface SystemPortalUserStats {
19
+ /**
20
+ * Distinct users holding at least one active role in the portal.
21
+ * @type {number}
22
+ * @memberof SystemPortalUserStats
23
+ */
24
+ total: number;
25
+ /**
26
+ *
27
+ * @type {number}
28
+ * @memberof SystemPortalUserStats
29
+ */
30
+ enabled: number;
31
+ /**
32
+ *
33
+ * @type {number}
34
+ * @memberof SystemPortalUserStats
35
+ */
36
+ disabled: number;
37
+ /**
38
+ * Users whose earliest active role in the portal was assigned in the last 30 days.
39
+ * @type {number}
40
+ * @memberof SystemPortalUserStats
41
+ */
42
+ newLast30Days: number;
43
+ /**
44
+ * Distinct users who logged in to the portal in the last 7 days.
45
+ * @type {number}
46
+ * @memberof SystemPortalUserStats
47
+ */
48
+ activeLast7Days: number;
49
+ /**
50
+ *
51
+ * @type {number}
52
+ * @memberof SystemPortalUserStats
53
+ */
54
+ activeLast30Days: number;
55
+ /**
56
+ *
57
+ * @type {number}
58
+ * @memberof SystemPortalUserStats
59
+ */
60
+ pendingInvitations: number;
61
+ /**
62
+ *
63
+ * @type {number}
64
+ * @memberof SystemPortalUserStats
65
+ */
66
+ lastLoginAt?: number | null;
67
+ /**
68
+ * Distinct users per role base type. A user with several roles is counted once per base type.
69
+ * @type {Array<SystemPortalRoleCount>}
70
+ * @memberof SystemPortalUserStats
71
+ */
72
+ byRole: Array<SystemPortalRoleCount>;
73
+ }
74
+ /**
75
+ * Check if a given object implements the SystemPortalUserStats interface.
76
+ */
77
+ export declare function instanceOfSystemPortalUserStats(value: object): value is SystemPortalUserStats;
78
+ export declare function SystemPortalUserStatsFromJSON(json: any): SystemPortalUserStats;
79
+ export declare function SystemPortalUserStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SystemPortalUserStats;
80
+ export declare function SystemPortalUserStatsToJSON(json: any): SystemPortalUserStats;
81
+ export declare function SystemPortalUserStatsToJSONTyped(value?: SystemPortalUserStats | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,81 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfSystemPortalUserStats = instanceOfSystemPortalUserStats;
17
+ exports.SystemPortalUserStatsFromJSON = SystemPortalUserStatsFromJSON;
18
+ exports.SystemPortalUserStatsFromJSONTyped = SystemPortalUserStatsFromJSONTyped;
19
+ exports.SystemPortalUserStatsToJSON = SystemPortalUserStatsToJSON;
20
+ exports.SystemPortalUserStatsToJSONTyped = SystemPortalUserStatsToJSONTyped;
21
+ const SystemPortalRoleCount_1 = require("./SystemPortalRoleCount");
22
+ /**
23
+ * Check if a given object implements the SystemPortalUserStats interface.
24
+ */
25
+ function instanceOfSystemPortalUserStats(value) {
26
+ if (!('total' in value) || value['total'] === undefined)
27
+ return false;
28
+ if (!('enabled' in value) || value['enabled'] === undefined)
29
+ return false;
30
+ if (!('disabled' in value) || value['disabled'] === undefined)
31
+ return false;
32
+ if (!('newLast30Days' in value) || value['newLast30Days'] === undefined)
33
+ return false;
34
+ if (!('activeLast7Days' in value) || value['activeLast7Days'] === undefined)
35
+ return false;
36
+ if (!('activeLast30Days' in value) || value['activeLast30Days'] === undefined)
37
+ return false;
38
+ if (!('pendingInvitations' in value) || value['pendingInvitations'] === undefined)
39
+ return false;
40
+ if (!('byRole' in value) || value['byRole'] === undefined)
41
+ return false;
42
+ return true;
43
+ }
44
+ function SystemPortalUserStatsFromJSON(json) {
45
+ return SystemPortalUserStatsFromJSONTyped(json, false);
46
+ }
47
+ function SystemPortalUserStatsFromJSONTyped(json, ignoreDiscriminator) {
48
+ if (json == null) {
49
+ return json;
50
+ }
51
+ return {
52
+ 'total': json['total'],
53
+ 'enabled': json['enabled'],
54
+ 'disabled': json['disabled'],
55
+ 'newLast30Days': json['new_last_30_days'],
56
+ 'activeLast7Days': json['active_last_7_days'],
57
+ 'activeLast30Days': json['active_last_30_days'],
58
+ 'pendingInvitations': json['pending_invitations'],
59
+ 'lastLoginAt': json['last_login_at'] == null ? undefined : json['last_login_at'],
60
+ 'byRole': (json['by_role'].map(SystemPortalRoleCount_1.SystemPortalRoleCountFromJSON)),
61
+ };
62
+ }
63
+ function SystemPortalUserStatsToJSON(json) {
64
+ return SystemPortalUserStatsToJSONTyped(json, false);
65
+ }
66
+ function SystemPortalUserStatsToJSONTyped(value, ignoreDiscriminator = false) {
67
+ if (value == null) {
68
+ return value;
69
+ }
70
+ return {
71
+ 'total': value['total'],
72
+ 'enabled': value['enabled'],
73
+ 'disabled': value['disabled'],
74
+ 'new_last_30_days': value['newLast30Days'],
75
+ 'active_last_7_days': value['activeLast7Days'],
76
+ 'active_last_30_days': value['activeLast30Days'],
77
+ 'pending_invitations': value['pendingInvitations'],
78
+ 'last_login_at': value['lastLoginAt'],
79
+ 'by_role': (value['byRole'].map(SystemPortalRoleCount_1.SystemPortalRoleCountToJSON)),
80
+ };
81
+ }
@@ -165,6 +165,7 @@ export * from './GetSupportTicketList';
165
165
  export * from './GetSystemBillingItem';
166
166
  export * from './GetSystemBillingList';
167
167
  export * from './GetSystemMetrics';
168
+ export * from './GetSystemPortalOverview';
168
169
  export * from './GetUser';
169
170
  export * from './GetUserAvatarUpload';
170
171
  export * from './GetUserCourseList';
@@ -276,6 +277,8 @@ export * from './PostQuestionImportCommit';
276
277
  export * from './PostQuestionImportCommitItem';
277
278
  export * from './PostQuestionImportCommitResponse';
278
279
  export * from './PostQuestionImportParseResponse';
280
+ export * from './PostQuestionTags';
281
+ export * from './PostQuestionTagsResponse';
279
282
  export * from './PostReportExport';
280
283
  export * from './PostReportQuery';
281
284
  export * from './PostResetPassword';
@@ -376,6 +379,17 @@ export * from './ScormSetValueRequest';
376
379
  export * from './ScormSetValueResponse';
377
380
  export * from './ScormTerminateResponse';
378
381
  export * from './SupportTicketUser';
382
+ export * from './SystemPortalActivityStats';
383
+ export * from './SystemPortalCertificateStats';
384
+ export * from './SystemPortalContentStats';
385
+ export * from './SystemPortalCourseStats';
386
+ export * from './SystemPortalEnrollmentStats';
387
+ export * from './SystemPortalHierarchy';
388
+ export * from './SystemPortalLicense';
389
+ export * from './SystemPortalRoleCount';
390
+ export * from './SystemPortalStorageUsage';
391
+ export * from './SystemPortalSupportStats';
392
+ export * from './SystemPortalUserStats';
379
393
  export * from './UpdateSelectedPortalResponse';
380
394
  export * from './UpdateSelectedPortalResponseHostPortal';
381
395
  export * from './UpdateSelectedPortalResponseSelectedPortal';
@@ -183,6 +183,7 @@ __exportStar(require("./GetSupportTicketList"), exports);
183
183
  __exportStar(require("./GetSystemBillingItem"), exports);
184
184
  __exportStar(require("./GetSystemBillingList"), exports);
185
185
  __exportStar(require("./GetSystemMetrics"), exports);
186
+ __exportStar(require("./GetSystemPortalOverview"), exports);
186
187
  __exportStar(require("./GetUser"), exports);
187
188
  __exportStar(require("./GetUserAvatarUpload"), exports);
188
189
  __exportStar(require("./GetUserCourseList"), exports);
@@ -294,6 +295,8 @@ __exportStar(require("./PostQuestionImportCommit"), exports);
294
295
  __exportStar(require("./PostQuestionImportCommitItem"), exports);
295
296
  __exportStar(require("./PostQuestionImportCommitResponse"), exports);
296
297
  __exportStar(require("./PostQuestionImportParseResponse"), exports);
298
+ __exportStar(require("./PostQuestionTags"), exports);
299
+ __exportStar(require("./PostQuestionTagsResponse"), exports);
297
300
  __exportStar(require("./PostReportExport"), exports);
298
301
  __exportStar(require("./PostReportQuery"), exports);
299
302
  __exportStar(require("./PostResetPassword"), exports);
@@ -394,6 +397,17 @@ __exportStar(require("./ScormSetValueRequest"), exports);
394
397
  __exportStar(require("./ScormSetValueResponse"), exports);
395
398
  __exportStar(require("./ScormTerminateResponse"), exports);
396
399
  __exportStar(require("./SupportTicketUser"), exports);
400
+ __exportStar(require("./SystemPortalActivityStats"), exports);
401
+ __exportStar(require("./SystemPortalCertificateStats"), exports);
402
+ __exportStar(require("./SystemPortalContentStats"), exports);
403
+ __exportStar(require("./SystemPortalCourseStats"), exports);
404
+ __exportStar(require("./SystemPortalEnrollmentStats"), exports);
405
+ __exportStar(require("./SystemPortalHierarchy"), exports);
406
+ __exportStar(require("./SystemPortalLicense"), exports);
407
+ __exportStar(require("./SystemPortalRoleCount"), exports);
408
+ __exportStar(require("./SystemPortalStorageUsage"), exports);
409
+ __exportStar(require("./SystemPortalSupportStats"), exports);
410
+ __exportStar(require("./SystemPortalUserStats"), exports);
397
411
  __exportStar(require("./UpdateSelectedPortalResponse"), exports);
398
412
  __exportStar(require("./UpdateSelectedPortalResponseHostPortal"), exports);
399
413
  __exportStar(require("./UpdateSelectedPortalResponseSelectedPortal"), exports);
@@ -14,6 +14,7 @@ Name | Type
14
14
  `courseVersionNumber` | number
15
15
  `firstName` | string
16
16
  `lastName` | string
17
+ `email` | string
17
18
  `enrollmentDateStart` | number
18
19
  `enrollmentDateEnd` | number
19
20
  `status` | string
@@ -36,6 +37,7 @@ const example = {
36
37
  "courseVersionNumber": null,
37
38
  "firstName": null,
38
39
  "lastName": null,
40
+ "email": null,
39
41
  "enrollmentDateStart": null,
40
42
  "enrollmentDateEnd": null,
41
43
  "status": null,
@@ -7,6 +7,7 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `courseId` | string
10
+ `courseName` | string
10
11
  `courseVersionId` | string
11
12
  `courseVersionNumber` | number
12
13
  `courseStatus` | [ContentLibraryVersionStatus](ContentLibraryVersionStatus.md)
@@ -21,6 +22,7 @@ import type { GetResourceUsageCoursesInner } from '@easyedu/js-lsm-api'
21
22
  // TODO: Update the object below with actual values
22
23
  const example = {
23
24
  "courseId": null,
25
+ "courseName": null,
24
26
  "courseVersionId": null,
25
27
  "courseVersionNumber": null,
26
28
  "courseStatus": null,
@@ -0,0 +1,61 @@
1
+
2
+ # GetSystemPortalOverview
3
+
4
+ Detailed read-only overview of a single portal for platform administrators. All counts are scoped to the portal itself and exclude child portals. Timestamps are Unix epoch seconds (UTC).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `portal` | [GetPortal](GetPortal.md)
11
+ `createdAt` | number
12
+ `updatedAt` | number
13
+ `generatedAt` | number
14
+ `hierarchy` | [SystemPortalHierarchy](SystemPortalHierarchy.md)
15
+ `license` | [SystemPortalLicense](SystemPortalLicense.md)
16
+ `users` | [SystemPortalUserStats](SystemPortalUserStats.md)
17
+ `courses` | [SystemPortalCourseStats](SystemPortalCourseStats.md)
18
+ `enrollments` | [SystemPortalEnrollmentStats](SystemPortalEnrollmentStats.md)
19
+ `content` | [SystemPortalContentStats](SystemPortalContentStats.md)
20
+ `certificates` | [SystemPortalCertificateStats](SystemPortalCertificateStats.md)
21
+ `storage` | [SystemPortalStorageUsage](SystemPortalStorageUsage.md)
22
+ `activity` | [SystemPortalActivityStats](SystemPortalActivityStats.md)
23
+ `support` | [SystemPortalSupportStats](SystemPortalSupportStats.md)
24
+
25
+ ## Example
26
+
27
+ ```typescript
28
+ import type { GetSystemPortalOverview } from '@easyedu/js-lsm-api'
29
+
30
+ // TODO: Update the object below with actual values
31
+ const example = {
32
+ "portal": null,
33
+ "createdAt": null,
34
+ "updatedAt": null,
35
+ "generatedAt": null,
36
+ "hierarchy": null,
37
+ "license": null,
38
+ "users": null,
39
+ "courses": null,
40
+ "enrollments": null,
41
+ "content": null,
42
+ "certificates": null,
43
+ "storage": null,
44
+ "activity": null,
45
+ "support": null,
46
+ } satisfies GetSystemPortalOverview
47
+
48
+ console.log(example)
49
+
50
+ // Convert the instance to a JSON string
51
+ const exampleJSON: string = JSON.stringify(example)
52
+ console.log(exampleJSON)
53
+
54
+ // Parse the JSON string back to an object
55
+ const exampleParsed = JSON.parse(exampleJSON) as GetSystemPortalOverview
56
+ console.log(exampleParsed)
57
+ ```
58
+
59
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
60
+
61
+
package/docs/PortalApi.md CHANGED
@@ -554,7 +554,7 @@ No authorization required
554
554
 
555
555
  ## getPortalUsers
556
556
 
557
- > GetPortalUserList getPortalUsers(portalId, type, roles, search, page, pageSize)
557
+ > GetPortalUserList getPortalUsers(portalId, type, roles, search, status, page, pageSize)
558
558
 
559
559
  Get all users for a portal with optional role filtering
560
560
 
@@ -580,6 +580,8 @@ async function example() {
580
580
  roles: ...,
581
581
  // string | Search users by first name, last name, or email (optional)
582
582
  search: Josh,
583
+ // 'active' | 'removed' | Which members to list. \"removed\" lists people removed from the portal, whose history is kept and who can be re-invited. (optional)
584
+ status: status_example,
583
585
  // number (optional)
584
586
  page: 56,
585
587
  // number (optional)
@@ -607,6 +609,7 @@ example().catch(console.error);
607
609
  | **type** | `student`, `instructor` | Filter users by type (student maps to Learner, instructor maps to Instructor) | [Optional] [Defaults to `undefined`] [Enum: student, instructor] |
608
610
  | **roles** | `Admin`, `Instructor`, `Learner` | Filter users by role (can specify multiple) | [Optional] [Enum: Admin, Instructor, Learner] |
609
611
  | **search** | `string` | Search users by first name, last name, or email | [Optional] [Defaults to `undefined`] |
612
+ | **status** | `active`, `removed` | Which members to list. \&quot;removed\&quot; lists people removed from the portal, whose history is kept and who can be re-invited. | [Optional] [Defaults to `&#39;active&#39;`] [Enum: active, removed] |
610
613
  | **page** | `number` | | [Optional] [Defaults to `1`] |
611
614
  | **pageSize** | `number` | | [Optional] [Defaults to `20`] |
612
615
 
@@ -0,0 +1,37 @@
1
+
2
+ # PostQuestionTags
3
+
4
+ Adds shared tags to several questions at once without creating new question versions.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `questionIds` | Array&lt;string&gt;
11
+ `tags` | Array&lt;string&gt;
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { PostQuestionTags } from '@easyedu/js-lsm-api'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "questionIds": null,
21
+ "tags": null,
22
+ } satisfies PostQuestionTags
23
+
24
+ console.log(example)
25
+
26
+ // Convert the instance to a JSON string
27
+ const exampleJSON: string = JSON.stringify(example)
28
+ console.log(exampleJSON)
29
+
30
+ // Parse the JSON string back to an object
31
+ const exampleParsed = JSON.parse(exampleJSON) as PostQuestionTags
32
+ console.log(exampleParsed)
33
+ ```
34
+
35
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
+
37
+
@@ -0,0 +1,34 @@
1
+
2
+ # PostQuestionTagsResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `updatedCount` | number
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { PostQuestionTagsResponse } from '@easyedu/js-lsm-api'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "updatedCount": null,
19
+ } satisfies PostQuestionTagsResponse
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as PostQuestionTagsResponse
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+