@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
@@ -132,6 +132,12 @@ docs/GetPortalFaviconUpload.md
132
132
  docs/GetPortalInvitationSummary.md
133
133
  docs/GetPortalList.md
134
134
  docs/GetPortalLogoUpload.md
135
+ docs/GetPortalManagementDashboard.md
136
+ docs/GetPortalManagementDashboardActivityDay.md
137
+ docs/GetPortalManagementDashboardAttention.md
138
+ docs/GetPortalManagementDashboardEnrollmentStatus.md
139
+ docs/GetPortalManagementDashboardSummary.md
140
+ docs/GetPortalManagementDashboardTopCourse.md
135
141
  docs/GetPortalUser.md
136
142
  docs/GetPortalUserFieldValues.md
137
143
  docs/GetPortalUserList.md
@@ -536,6 +542,12 @@ src/models/GetPortalFaviconUpload.ts
536
542
  src/models/GetPortalInvitationSummary.ts
537
543
  src/models/GetPortalList.ts
538
544
  src/models/GetPortalLogoUpload.ts
545
+ src/models/GetPortalManagementDashboard.ts
546
+ src/models/GetPortalManagementDashboardActivityDay.ts
547
+ src/models/GetPortalManagementDashboardAttention.ts
548
+ src/models/GetPortalManagementDashboardEnrollmentStatus.ts
549
+ src/models/GetPortalManagementDashboardSummary.ts
550
+ src/models/GetPortalManagementDashboardTopCourse.ts
539
551
  src/models/GetPortalUser.ts
540
552
  src/models/GetPortalUserFieldValues.ts
541
553
  src/models/GetPortalUserList.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.123.0
1
+ # @easyedu/js-lsm-api@1.125.0
2
2
 
3
3
  A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
4
4
 
@@ -206,7 +206,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
206
206
  *CourseApi* | [**postCourseDraft**](docs/CourseApi.md#postcoursedraft) | **POST** /courses/{courseId}/draft | Create or return the single editable course draft
207
207
  *CourseApi* | [**postCourseDraftResourceUpdateAll**](docs/CourseApi.md#postcoursedraftresourceupdateall) | **POST** /courses/{courseId}/draft/resources/update-all | Update all draft resource placements to their latest published versions
208
208
  *CourseApi* | [**postCourseDuplicate**](docs/CourseApi.md#postcourseduplicate) | **POST** /courses/{courseId}/duplicate | Duplicate a course
209
- *CourseApi* | [**postCourseEnrollment**](docs/CourseApi.md#postcourseenrollment) | **POST** /courses/{courseId}/enrollments | Create a new course enrollment
209
+ *CourseApi* | [**postCourseEnrollment**](docs/CourseApi.md#postcourseenrollment) | **POST** /courses/{courseId}/enrollments | Create a new single-role course enrollment
210
210
  *CourseApi* | [**postCourseExport**](docs/CourseApi.md#postcourseexport) | **POST** /courses/{courseId}/exports | Create a new SCORM export for a course
211
211
  *CourseApi* | [**postCourseImageUpload**](docs/CourseApi.md#postcourseimageupload) | **POST** /courses/{courseId}/image | Upload a course image
212
212
  *CourseApi* | [**postCourseItemLearnerSessionsClear**](docs/CourseApi.md#postcourseitemlearnersessionsclear) | **POST** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/sessions/clear | Clear all live sessions for a learner and course item
@@ -217,7 +217,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
217
217
  *CourseApi* | [**postCourseVersionSection**](docs/CourseApi.md#postcourseversionsection) | **POST** /courses/{courseId}/draft/sections | Add a root or nested section to the editable course draft
218
218
  *CourseApi* | [**postCourseVersionSectionDuplicate**](docs/CourseApi.md#postcourseversionsectionduplicate) | **POST** /courses/{courseId}/draft/sections/{sectionId}/duplicate | Recursively duplicate a draft section and reuse its pinned library items
219
219
  *CourseApi* | [**putCourse**](docs/CourseApi.md#putcourse) | **PUT** /courses/{courseId} | Update a course by id
220
- *CourseApi* | [**putCourseEnrollment**](docs/CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment
220
+ *CourseApi* | [**putCourseEnrollment**](docs/CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update an enrollment without changing its user type
221
221
  *CourseApi* | [**putCourseItemLearnerAttemptAllowance**](docs/CourseApi.md#putcourseitemlearnerattemptallowance) | **PUT** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance | Set extra attempts for a learner on a course item
222
222
  *CourseApi* | [**putCourseVersionDraft**](docs/CourseApi.md#putcourseversiondraft) | **PUT** /courses/{courseId}/draft | Update progression settings on the editable course draft
223
223
  *CourseApi* | [**putCourseVersionItem**](docs/CourseApi.md#putcourseversionitem) | **PUT** /courses/{courseId}/draft/sections/{sectionId}/items/{itemId} | Update a draft placement; use the outline move endpoint to change its parent or position
@@ -365,6 +365,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
365
365
  *QuestionImportApi* | [**postQuestionImportParse**](docs/QuestionImportApi.md#postquestionimportparse) | **POST** /question-imports/parse | Parse a question document into stateless review drafts
366
366
  *ReportingApi* | [**getCourseVersionReporting**](docs/ReportingApi.md#getcourseversionreporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/reporting | Get instructor reporting for one explicit course version
367
367
  *ReportingApi* | [**getCourseVersionSectionReporting**](docs/ReportingApi.md#getcourseversionsectionreporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/sections/{sectionId}/reporting | Get instructor reporting for one section and its descendants in an explicit course version
368
+ *ReportingApi* | [**getPortalManagementDashboard**](docs/ReportingApi.md#getportalmanagementdashboard) | **GET** /reporting/portal/dashboard | Get the selected portal\'s management dashboard reporting
368
369
  *RichTextApi* | [**getRichTextAsset**](docs/RichTextApi.md#getrichtextasset) | **GET** /rich-text/assets/{assetId} | Redirect to a signed rich text asset URL
369
370
  *RichTextApi* | [**postRichTextAssetComplete**](docs/RichTextApi.md#postrichtextassetcomplete) | **POST** /rich-text/assets/{assetId}/complete | Complete a pending rich text asset upload
370
371
  *RichTextApi* | [**postRichTextAssetUpload**](docs/RichTextApi.md#postrichtextassetupload) | **POST** /rich-text/assets/uploads | Create a pending rich text asset upload
@@ -530,6 +531,12 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
530
531
  - [GetPortalInvitationSummary](docs/GetPortalInvitationSummary.md)
531
532
  - [GetPortalList](docs/GetPortalList.md)
532
533
  - [GetPortalLogoUpload](docs/GetPortalLogoUpload.md)
534
+ - [GetPortalManagementDashboard](docs/GetPortalManagementDashboard.md)
535
+ - [GetPortalManagementDashboardActivityDay](docs/GetPortalManagementDashboardActivityDay.md)
536
+ - [GetPortalManagementDashboardAttention](docs/GetPortalManagementDashboardAttention.md)
537
+ - [GetPortalManagementDashboardEnrollmentStatus](docs/GetPortalManagementDashboardEnrollmentStatus.md)
538
+ - [GetPortalManagementDashboardSummary](docs/GetPortalManagementDashboardSummary.md)
539
+ - [GetPortalManagementDashboardTopCourse](docs/GetPortalManagementDashboardTopCourse.md)
533
540
  - [GetPortalUser](docs/GetPortalUser.md)
534
541
  - [GetPortalUserFieldValues](docs/GetPortalUserFieldValues.md)
535
542
  - [GetPortalUserList](docs/GetPortalUserList.md)
@@ -786,7 +793,7 @@ and is automatically generated by the
786
793
  [OpenAPI Generator](https://openapi-generator.tech) project:
787
794
 
788
795
  - API version: `1.0.0`
789
- - Package version: `1.123.0`
796
+ - Package version: `1.125.0`
790
797
  - Generator version: `7.22.0`
791
798
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
792
799
 
@@ -567,11 +567,11 @@ export declare class CourseApi extends runtime.BaseAPI {
567
567
  */
568
568
  postCourseEnrollmentRequestOpts(requestParameters: PostCourseEnrollmentRequest): Promise<runtime.RequestOpts>;
569
569
  /**
570
- * Create a new course enrollment
570
+ * Create a new single-role course enrollment
571
571
  */
572
572
  postCourseEnrollmentRaw(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
573
573
  /**
574
- * Create a new course enrollment
574
+ * Create a new single-role course enrollment
575
575
  */
576
576
  postCourseEnrollment(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
577
577
  /**
@@ -703,11 +703,11 @@ export declare class CourseApi extends runtime.BaseAPI {
703
703
  */
704
704
  putCourseEnrollmentRequestOpts(requestParameters: PutCourseEnrollmentRequest): Promise<runtime.RequestOpts>;
705
705
  /**
706
- * Update a course enrollment
706
+ * Update an enrollment without changing its user type
707
707
  */
708
708
  putCourseEnrollmentRaw(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
709
709
  /**
710
- * Update a course enrollment
710
+ * Update an enrollment without changing its user type
711
711
  */
712
712
  putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
713
713
  /**
@@ -1192,7 +1192,7 @@ class CourseApi extends runtime.BaseAPI {
1192
1192
  });
1193
1193
  }
1194
1194
  /**
1195
- * Create a new course enrollment
1195
+ * Create a new single-role course enrollment
1196
1196
  */
1197
1197
  postCourseEnrollmentRaw(requestParameters, initOverrides) {
1198
1198
  return __awaiter(this, void 0, void 0, function* () {
@@ -1202,7 +1202,7 @@ class CourseApi extends runtime.BaseAPI {
1202
1202
  });
1203
1203
  }
1204
1204
  /**
1205
- * Create a new course enrollment
1205
+ * Create a new single-role course enrollment
1206
1206
  */
1207
1207
  postCourseEnrollment(requestParameters, initOverrides) {
1208
1208
  return __awaiter(this, void 0, void 0, function* () {
@@ -1729,7 +1729,7 @@ class CourseApi extends runtime.BaseAPI {
1729
1729
  });
1730
1730
  }
1731
1731
  /**
1732
- * Update a course enrollment
1732
+ * Update an enrollment without changing its user type
1733
1733
  */
1734
1734
  putCourseEnrollmentRaw(requestParameters, initOverrides) {
1735
1735
  return __awaiter(this, void 0, void 0, function* () {
@@ -1739,7 +1739,7 @@ class CourseApi extends runtime.BaseAPI {
1739
1739
  });
1740
1740
  }
1741
1741
  /**
1742
- * Update a course enrollment
1742
+ * Update an enrollment without changing its user type
1743
1743
  */
1744
1744
  putCourseEnrollment(requestParameters, initOverrides) {
1745
1745
  return __awaiter(this, void 0, void 0, function* () {
@@ -12,6 +12,7 @@
12
12
  import * as runtime from '../runtime';
13
13
  import { type GetCourseVersionReporting } from '../models/GetCourseVersionReporting';
14
14
  import { type GetCourseVersionSectionReporting } from '../models/GetCourseVersionSectionReporting';
15
+ import { type GetPortalManagementDashboard } from '../models/GetPortalManagementDashboard';
15
16
  export interface GetCourseVersionReportingRequest {
16
17
  courseId: string;
17
18
  courseVersionId: string;
@@ -21,6 +22,9 @@ export interface GetCourseVersionSectionReportingRequest {
21
22
  courseVersionId: string;
22
23
  sectionId: string;
23
24
  }
25
+ export interface GetPortalManagementDashboardRequest {
26
+ days?: number;
27
+ }
24
28
  /**
25
29
  *
26
30
  */
@@ -49,4 +53,16 @@ export declare class ReportingApi extends runtime.BaseAPI {
49
53
  * Get instructor reporting for one section and its descendants in an explicit course version
50
54
  */
51
55
  getCourseVersionSectionReporting(requestParameters: GetCourseVersionSectionReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionSectionReporting>;
56
+ /**
57
+ * Creates request options for getPortalManagementDashboard without sending the request
58
+ */
59
+ getPortalManagementDashboardRequestOpts(requestParameters: GetPortalManagementDashboardRequest): Promise<runtime.RequestOpts>;
60
+ /**
61
+ * Get the selected portal\'s management dashboard reporting
62
+ */
63
+ getPortalManagementDashboardRaw(requestParameters: GetPortalManagementDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalManagementDashboard>>;
64
+ /**
65
+ * Get the selected portal\'s management dashboard reporting
66
+ */
67
+ getPortalManagementDashboard(requestParameters?: GetPortalManagementDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalManagementDashboard>;
52
68
  }
@@ -26,6 +26,7 @@ exports.ReportingApi = void 0;
26
26
  const runtime = require("../runtime");
27
27
  const GetCourseVersionReporting_1 = require("../models/GetCourseVersionReporting");
28
28
  const GetCourseVersionSectionReporting_1 = require("../models/GetCourseVersionSectionReporting");
29
+ const GetPortalManagementDashboard_1 = require("../models/GetPortalManagementDashboard");
29
30
  /**
30
31
  *
31
32
  */
@@ -120,5 +121,43 @@ class ReportingApi extends runtime.BaseAPI {
120
121
  return yield response.value();
121
122
  });
122
123
  }
124
+ /**
125
+ * Creates request options for getPortalManagementDashboard without sending the request
126
+ */
127
+ getPortalManagementDashboardRequestOpts(requestParameters) {
128
+ return __awaiter(this, void 0, void 0, function* () {
129
+ const queryParameters = {};
130
+ if (requestParameters['days'] != null) {
131
+ queryParameters['days'] = requestParameters['days'];
132
+ }
133
+ const headerParameters = {};
134
+ let urlPath = `/reporting/portal/dashboard`;
135
+ return {
136
+ path: urlPath,
137
+ method: 'GET',
138
+ headers: headerParameters,
139
+ query: queryParameters,
140
+ };
141
+ });
142
+ }
143
+ /**
144
+ * Get the selected portal\'s management dashboard reporting
145
+ */
146
+ getPortalManagementDashboardRaw(requestParameters, initOverrides) {
147
+ return __awaiter(this, void 0, void 0, function* () {
148
+ const requestOptions = yield this.getPortalManagementDashboardRequestOpts(requestParameters);
149
+ const response = yield this.request(requestOptions, initOverrides);
150
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetPortalManagementDashboard_1.GetPortalManagementDashboardFromJSON)(jsonValue));
151
+ });
152
+ }
153
+ /**
154
+ * Get the selected portal\'s management dashboard reporting
155
+ */
156
+ getPortalManagementDashboard() {
157
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
158
+ const response = yield this.getPortalManagementDashboardRaw(requestParameters, initOverrides);
159
+ return yield response.value();
160
+ });
161
+ }
123
162
  }
124
163
  exports.ReportingApi = ReportingApi;
@@ -567,11 +567,11 @@ export declare class CourseApi extends runtime.BaseAPI {
567
567
  */
568
568
  postCourseEnrollmentRequestOpts(requestParameters: PostCourseEnrollmentRequest): Promise<runtime.RequestOpts>;
569
569
  /**
570
- * Create a new course enrollment
570
+ * Create a new single-role course enrollment
571
571
  */
572
572
  postCourseEnrollmentRaw(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
573
573
  /**
574
- * Create a new course enrollment
574
+ * Create a new single-role course enrollment
575
575
  */
576
576
  postCourseEnrollment(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
577
577
  /**
@@ -703,11 +703,11 @@ export declare class CourseApi extends runtime.BaseAPI {
703
703
  */
704
704
  putCourseEnrollmentRequestOpts(requestParameters: PutCourseEnrollmentRequest): Promise<runtime.RequestOpts>;
705
705
  /**
706
- * Update a course enrollment
706
+ * Update an enrollment without changing its user type
707
707
  */
708
708
  putCourseEnrollmentRaw(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>>;
709
709
  /**
710
- * Update a course enrollment
710
+ * Update an enrollment without changing its user type
711
711
  */
712
712
  putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
713
713
  /**
@@ -1189,7 +1189,7 @@ export class CourseApi extends runtime.BaseAPI {
1189
1189
  });
1190
1190
  }
1191
1191
  /**
1192
- * Create a new course enrollment
1192
+ * Create a new single-role course enrollment
1193
1193
  */
1194
1194
  postCourseEnrollmentRaw(requestParameters, initOverrides) {
1195
1195
  return __awaiter(this, void 0, void 0, function* () {
@@ -1199,7 +1199,7 @@ export class CourseApi extends runtime.BaseAPI {
1199
1199
  });
1200
1200
  }
1201
1201
  /**
1202
- * Create a new course enrollment
1202
+ * Create a new single-role course enrollment
1203
1203
  */
1204
1204
  postCourseEnrollment(requestParameters, initOverrides) {
1205
1205
  return __awaiter(this, void 0, void 0, function* () {
@@ -1726,7 +1726,7 @@ export class CourseApi extends runtime.BaseAPI {
1726
1726
  });
1727
1727
  }
1728
1728
  /**
1729
- * Update a course enrollment
1729
+ * Update an enrollment without changing its user type
1730
1730
  */
1731
1731
  putCourseEnrollmentRaw(requestParameters, initOverrides) {
1732
1732
  return __awaiter(this, void 0, void 0, function* () {
@@ -1736,7 +1736,7 @@ export class CourseApi extends runtime.BaseAPI {
1736
1736
  });
1737
1737
  }
1738
1738
  /**
1739
- * Update a course enrollment
1739
+ * Update an enrollment without changing its user type
1740
1740
  */
1741
1741
  putCourseEnrollment(requestParameters, initOverrides) {
1742
1742
  return __awaiter(this, void 0, void 0, function* () {
@@ -12,6 +12,7 @@
12
12
  import * as runtime from '../runtime';
13
13
  import { type GetCourseVersionReporting } from '../models/GetCourseVersionReporting';
14
14
  import { type GetCourseVersionSectionReporting } from '../models/GetCourseVersionSectionReporting';
15
+ import { type GetPortalManagementDashboard } from '../models/GetPortalManagementDashboard';
15
16
  export interface GetCourseVersionReportingRequest {
16
17
  courseId: string;
17
18
  courseVersionId: string;
@@ -21,6 +22,9 @@ export interface GetCourseVersionSectionReportingRequest {
21
22
  courseVersionId: string;
22
23
  sectionId: string;
23
24
  }
25
+ export interface GetPortalManagementDashboardRequest {
26
+ days?: number;
27
+ }
24
28
  /**
25
29
  *
26
30
  */
@@ -49,4 +53,16 @@ export declare class ReportingApi extends runtime.BaseAPI {
49
53
  * Get instructor reporting for one section and its descendants in an explicit course version
50
54
  */
51
55
  getCourseVersionSectionReporting(requestParameters: GetCourseVersionSectionReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionSectionReporting>;
56
+ /**
57
+ * Creates request options for getPortalManagementDashboard without sending the request
58
+ */
59
+ getPortalManagementDashboardRequestOpts(requestParameters: GetPortalManagementDashboardRequest): Promise<runtime.RequestOpts>;
60
+ /**
61
+ * Get the selected portal\'s management dashboard reporting
62
+ */
63
+ getPortalManagementDashboardRaw(requestParameters: GetPortalManagementDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalManagementDashboard>>;
64
+ /**
65
+ * Get the selected portal\'s management dashboard reporting
66
+ */
67
+ getPortalManagementDashboard(requestParameters?: GetPortalManagementDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalManagementDashboard>;
52
68
  }
@@ -23,6 +23,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
23
23
  import * as runtime from '../runtime';
24
24
  import { GetCourseVersionReportingFromJSON, } from '../models/GetCourseVersionReporting';
25
25
  import { GetCourseVersionSectionReportingFromJSON, } from '../models/GetCourseVersionSectionReporting';
26
+ import { GetPortalManagementDashboardFromJSON, } from '../models/GetPortalManagementDashboard';
26
27
  /**
27
28
  *
28
29
  */
@@ -117,4 +118,42 @@ export class ReportingApi extends runtime.BaseAPI {
117
118
  return yield response.value();
118
119
  });
119
120
  }
121
+ /**
122
+ * Creates request options for getPortalManagementDashboard without sending the request
123
+ */
124
+ getPortalManagementDashboardRequestOpts(requestParameters) {
125
+ return __awaiter(this, void 0, void 0, function* () {
126
+ const queryParameters = {};
127
+ if (requestParameters['days'] != null) {
128
+ queryParameters['days'] = requestParameters['days'];
129
+ }
130
+ const headerParameters = {};
131
+ let urlPath = `/reporting/portal/dashboard`;
132
+ return {
133
+ path: urlPath,
134
+ method: 'GET',
135
+ headers: headerParameters,
136
+ query: queryParameters,
137
+ };
138
+ });
139
+ }
140
+ /**
141
+ * Get the selected portal\'s management dashboard reporting
142
+ */
143
+ getPortalManagementDashboardRaw(requestParameters, initOverrides) {
144
+ return __awaiter(this, void 0, void 0, function* () {
145
+ const requestOptions = yield this.getPortalManagementDashboardRequestOpts(requestParameters);
146
+ const response = yield this.request(requestOptions, initOverrides);
147
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalManagementDashboardFromJSON(jsonValue));
148
+ });
149
+ }
150
+ /**
151
+ * Get the selected portal\'s management dashboard reporting
152
+ */
153
+ getPortalManagementDashboard() {
154
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
155
+ const response = yield this.getPortalManagementDashboardRaw(requestParameters, initOverrides);
156
+ return yield response.value();
157
+ });
158
+ }
120
159
  }
@@ -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;
@@ -0,0 +1,72 @@
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
+ import { GetPortalManagementDashboardTopCourseFromJSON, GetPortalManagementDashboardTopCourseToJSON, } from './GetPortalManagementDashboardTopCourse';
15
+ import { GetPortalManagementDashboardEnrollmentStatusFromJSON, GetPortalManagementDashboardEnrollmentStatusToJSON, } from './GetPortalManagementDashboardEnrollmentStatus';
16
+ import { GetPortalManagementDashboardSummaryFromJSON, GetPortalManagementDashboardSummaryToJSON, } from './GetPortalManagementDashboardSummary';
17
+ import { GetPortalManagementDashboardActivityDayFromJSON, GetPortalManagementDashboardActivityDayToJSON, } from './GetPortalManagementDashboardActivityDay';
18
+ import { GetPortalManagementDashboardAttentionFromJSON, GetPortalManagementDashboardAttentionToJSON, } from './GetPortalManagementDashboardAttention';
19
+ /**
20
+ * Check if a given object implements the GetPortalManagementDashboard interface.
21
+ */
22
+ export function instanceOfGetPortalManagementDashboard(value) {
23
+ if (!('rangeDays' in value) || value['rangeDays'] === undefined)
24
+ return false;
25
+ if (!('generatedAt' in value) || value['generatedAt'] === undefined)
26
+ return false;
27
+ if (!('summary' in value) || value['summary'] === undefined)
28
+ return false;
29
+ if (!('enrollmentStatus' in value) || value['enrollmentStatus'] === undefined)
30
+ return false;
31
+ if (!('activity' in value) || value['activity'] === undefined)
32
+ return false;
33
+ if (!('topCourses' in value) || value['topCourses'] === undefined)
34
+ return false;
35
+ if (!('attention' in value) || value['attention'] === undefined)
36
+ return false;
37
+ return true;
38
+ }
39
+ export function GetPortalManagementDashboardFromJSON(json) {
40
+ return GetPortalManagementDashboardFromJSONTyped(json, false);
41
+ }
42
+ export function GetPortalManagementDashboardFromJSONTyped(json, ignoreDiscriminator) {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+ 'rangeDays': json['range_days'],
48
+ 'generatedAt': json['generated_at'],
49
+ 'summary': GetPortalManagementDashboardSummaryFromJSON(json['summary']),
50
+ 'enrollmentStatus': GetPortalManagementDashboardEnrollmentStatusFromJSON(json['enrollment_status']),
51
+ 'activity': (json['activity'].map(GetPortalManagementDashboardActivityDayFromJSON)),
52
+ 'topCourses': (json['top_courses'].map(GetPortalManagementDashboardTopCourseFromJSON)),
53
+ 'attention': GetPortalManagementDashboardAttentionFromJSON(json['attention']),
54
+ };
55
+ }
56
+ export function GetPortalManagementDashboardToJSON(json) {
57
+ return GetPortalManagementDashboardToJSONTyped(json, false);
58
+ }
59
+ export function GetPortalManagementDashboardToJSONTyped(value, ignoreDiscriminator = false) {
60
+ if (value == null) {
61
+ return value;
62
+ }
63
+ return {
64
+ 'range_days': value['rangeDays'],
65
+ 'generated_at': value['generatedAt'],
66
+ 'summary': GetPortalManagementDashboardSummaryToJSON(value['summary']),
67
+ 'enrollment_status': GetPortalManagementDashboardEnrollmentStatusToJSON(value['enrollmentStatus']),
68
+ 'activity': (value['activity'].map(GetPortalManagementDashboardActivityDayToJSON)),
69
+ 'top_courses': (value['topCourses'].map(GetPortalManagementDashboardTopCourseToJSON)),
70
+ 'attention': GetPortalManagementDashboardAttentionToJSON(value['attention']),
71
+ };
72
+ }
@@ -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 GetPortalManagementDashboardActivityDay
16
+ */
17
+ export interface GetPortalManagementDashboardActivityDay {
18
+ /**
19
+ *
20
+ * @type {Date}
21
+ * @memberof GetPortalManagementDashboardActivityDay
22
+ */
23
+ date: Date;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof GetPortalManagementDashboardActivityDay
28
+ */
29
+ activeLearnerCount: number;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof GetPortalManagementDashboardActivityDay
34
+ */
35
+ loginCount: number;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof GetPortalManagementDashboardActivityDay
40
+ */
41
+ completionCount: number;
42
+ }
43
+ /**
44
+ * Check if a given object implements the GetPortalManagementDashboardActivityDay interface.
45
+ */
46
+ export declare function instanceOfGetPortalManagementDashboardActivityDay(value: object): value is GetPortalManagementDashboardActivityDay;
47
+ export declare function GetPortalManagementDashboardActivityDayFromJSON(json: any): GetPortalManagementDashboardActivityDay;
48
+ export declare function GetPortalManagementDashboardActivityDayFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboardActivityDay;
49
+ export declare function GetPortalManagementDashboardActivityDayToJSON(json: any): GetPortalManagementDashboardActivityDay;
50
+ export declare function GetPortalManagementDashboardActivityDayToJSONTyped(value?: GetPortalManagementDashboardActivityDay | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,55 @@
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 GetPortalManagementDashboardActivityDay interface.
16
+ */
17
+ export function instanceOfGetPortalManagementDashboardActivityDay(value) {
18
+ if (!('date' in value) || value['date'] === undefined)
19
+ return false;
20
+ if (!('activeLearnerCount' in value) || value['activeLearnerCount'] === undefined)
21
+ return false;
22
+ if (!('loginCount' in value) || value['loginCount'] === undefined)
23
+ return false;
24
+ if (!('completionCount' in value) || value['completionCount'] === undefined)
25
+ return false;
26
+ return true;
27
+ }
28
+ export function GetPortalManagementDashboardActivityDayFromJSON(json) {
29
+ return GetPortalManagementDashboardActivityDayFromJSONTyped(json, false);
30
+ }
31
+ export function GetPortalManagementDashboardActivityDayFromJSONTyped(json, ignoreDiscriminator) {
32
+ if (json == null) {
33
+ return json;
34
+ }
35
+ return {
36
+ 'date': (new Date(json['date'])),
37
+ 'activeLearnerCount': json['active_learner_count'],
38
+ 'loginCount': json['login_count'],
39
+ 'completionCount': json['completion_count'],
40
+ };
41
+ }
42
+ export function GetPortalManagementDashboardActivityDayToJSON(json) {
43
+ return GetPortalManagementDashboardActivityDayToJSONTyped(json, false);
44
+ }
45
+ export function GetPortalManagementDashboardActivityDayToJSONTyped(value, ignoreDiscriminator = false) {
46
+ if (value == null) {
47
+ return value;
48
+ }
49
+ return {
50
+ 'date': value['date'].toISOString().substring(0, 10),
51
+ 'active_learner_count': value['activeLearnerCount'],
52
+ 'login_count': value['loginCount'],
53
+ 'completion_count': value['completionCount'],
54
+ };
55
+ }